Source/cmMakeDepend.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmMakeDepend.h,v $
   5   Language:  C++
   6   Date:      $Date: 2006-05-12 16:29:09 $
   7   Version:   $Revision: 1.24 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #ifndef cmMakeDepend_h
  18 #define cmMakeDepend_h
  19
  20 #include "cmMakefile.h"
  21 #include "cmSourceFile.h"
  22
  23 #include <cmsys/RegularExpression.hxx>
  24
  25 /** \class cmDependInformation
  26  * \brief Store dependency information for a single source file.
  27  *
  28  * This structure stores the depend information for a single source file.
  29  */
  30 class cmDependInformation
  31 {
  32 public:
  33   /**
  34    * Construct with dependency generation marked not done; instance
  35    * not placed in cmMakefile's list.
  36    */
  37   cmDependInformation(): DependDone(false), SourceFile(0) {}
  38
  39   /**
  40    * The set of files on which this one depends.
  41    */
  42   typedef std::set<cmDependInformation*> DependencySetType;
  43   DependencySetType DependencySet;
  44
  45   /**
  46    * This flag indicates whether dependency checking has been
  47    * performed for this file.
  48    */
  49   bool DependDone;
  50
  51   /**
  52    * If this object corresponds to a cmSourceFile instance, this points
  53    * to it.
  54    */
  55   const cmSourceFile *SourceFile;
  56
  57   /**
  58    * Full path to this file.
  59    */
  60   std::string FullPath;
  61
  62   /**
  63    * Full path not including file name.
  64    */
  65   std::string PathOnly;
  66
  67   /**
  68    * Name used to #include this file.
  69    */
  70   std::string IncludeName;
  71
  72   /**
  73    * This method adds the dependencies of another file to this one.
  74    */
  75   void AddDependencies(cmDependInformation*);
  76 };
  77
  78
  79 // cmMakeDepend is used to generate dependancy information for
  80 // the classes in a makefile
  81 class cmMakeDepend
  82 {
  83 public:
  84   /**
  85    * Construct the object with verbose turned off.
  86    */
  87   cmMakeDepend();
  88
  89   /**
  90    * Destructor.
  91    */
  92   virtual ~cmMakeDepend();
  93
  94   /**
  95    * Set the makefile that is used as a source of classes.
  96    */
  97   virtual void SetMakefile(cmMakefile* makefile);
  98
  99   /**
 100    * Get the depend info struct for a source file
 101    */
 102   const cmDependInformation
 103   *GetDependInformationForSourceFile(const cmSourceFile &sf) const;
 104
 105   /**
 106    * Add a directory to the search path for include files.
 107    */
 108   virtual void AddSearchPath(const char*);
 109
 110   /**
 111    * Generate dependencies for all the sources of all the targets
 112    * in the makefile.
 113    */
 114   void GenerateMakefileDependencies();
 115
 116   /**
 117    * Generate dependencies for the file given.  Returns a pointer to
 118    * the cmDependInformation object for the file.
 119    */
 120   const cmDependInformation* FindDependencies(const char* file);
 121
 122 protected:
 123   /**
 124    * Add a source file to the search path.
 125    */
 126   void AddFileToSearchPath(const char* filepath);
 127
 128   /**
 129    * Compute the depend information for this class.
 130    */
 131   virtual void DependWalk(cmDependInformation* info);
 132
 133   /**
 134    * Add a dependency.  Possibly walk it for more dependencies.
 135    */
 136   virtual void AddDependency(cmDependInformation* info, const char* file);
 137
 138   /**
 139    * Fill in the given object with dependency information.  If the
 140    * information is already complete, nothing is done.
 141    */
 142   void GenerateDependInformation(cmDependInformation* info);
 143
 144   /**
 145    * Get an instance of cmDependInformation corresponding to the given file
 146    * name.
 147    */
 148   cmDependInformation* GetDependInformation(const char* file,
 149                                             const char *extraPath);
 150
 151   /**
 152    * Find the full path name for the given file name.
 153    * This uses the include directories.
 154    * TODO: Cache path conversions to reduce FileExists calls.
 155    */
 156   std::string FullPath(const char *filename, const char *extraPath);
 157
 158   cmMakefile* Makefile;
 159   bool Verbose;
 160   cmsys::RegularExpression IncludeFileRegularExpression;
 161   cmsys::RegularExpression ComplainFileRegularExpression;
 162   std::vector<std::string> IncludeDirectories;
 163   typedef std::map<cmStdString, cmStdString> FileToPathMapType;
 164   typedef std::map<cmStdString, FileToPathMapType>
 165   DirectoryToFileToPathMapType;
 166   typedef std::map<cmStdString, cmDependInformation*>
 167   DependInformationMapType;
 168   DependInformationMapType DependInformationMap;
 169   DirectoryToFileToPathMapType DirectoryToFileToPathMap;
 170 };
 171
 172 #endif