CMake/Source/cmMakeDepend.h

159 lines
3.6 KiB
C
Raw Normal View History

/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2000 National Library of Medicine
All rights reserved.
See COPYRIGHT.txt for copyright details.
=========================================================================*/
#ifndef cmMakeDepend_h
#define cmMakeDepend_h
#include "cmMakefile.h"
#include "cmClassFile.h"
#include "cmRegularExpression.h"
#include "cmStandardIncludes.h"
2001-01-11 22:47:38 +03:00
/** \class cmDependInformation
* \brief Store dependency information for a single source file.
*
* This structure stores the depend information for a single source file.
*/
struct cmDependInformation
{
2001-01-11 22:47:38 +03:00
/**
* Construct with dependency generation marked not done; instance
* not placed in cmMakefile's list.
*/
cmDependInformation()
{
2001-01-11 22:47:38 +03:00
m_DependDone = false;
m_ClassFileIndex = -1;
}
2001-01-11 22:47:38 +03:00
/**
* A list of indices into the m_DependInformation array of cmMakeDepend.
* The index represents the files that this file depends on.
*/
std::vector<int> m_Indices;
2001-01-11 22:47:38 +03:00
/**
* Full path to this file.
*/
std::string m_FullPath;
2001-01-11 22:47:38 +03:00
/**
* Name that the include directive uses.
*/
std::string m_IncludeName;
2001-01-11 22:47:38 +03:00
/**
* The index into the cmMakefile::m_Classes list.
* The index value of -1 indicates that it is not in the list.
*/
int m_ClassFileIndex;
2001-01-11 22:47:38 +03:00
/**
* This flag indicates whether dependency checking has been
* performed for this file.
*/
bool m_DependDone;
2001-01-11 22:47:38 +03:00
/**
* This method adds the dependencies of another file to this one.
*/
void MergeInfo(cmDependInformation*);
2001-01-11 22:47:38 +03:00
/**
* This method removes duplicate depends from the index list.
*/
void RemoveDuplicateIndices();
};
// cmMakeDepend is used to generate dependancy information for
// the classes in a makefile
class cmMakeDepend
{
public:
2001-01-11 22:47:38 +03:00
/**
* Construct the object with verbose turned off.
*/
cmMakeDepend();
2001-01-11 22:47:38 +03:00
/**
* Destructor.
*/
~cmMakeDepend();
/**
* Set the makefile that is used as a source of classes.
*/
void SetMakefile(cmMakefile* makefile);
2001-01-11 22:47:38 +03:00
/**
* Generate the depend information
*/
void DoDepends();
2001-01-11 22:47:38 +03:00
/**
* Set a regular expression that include files must match
2001-01-11 22:47:38 +03:00
* in order to be considered as part of the depend information.
*/
void SetIncludeRegularExpression(const char* regex);
2001-01-11 22:47:38 +03:00
/**
2001-01-11 22:47:38 +03:00
* Add a directory to the search path for include files.
*/
void AddSearchPath(const char*);
2001-01-11 22:47:38 +03:00
private:
2001-01-11 22:47:38 +03:00
/**
* Add a source file to the search path.
*/
void AddFileToSearchPath(const char* filepath);
2001-01-11 22:47:38 +03:00
/**
* Find the index into the m_DependInformation array
2001-01-11 22:47:38 +03:00
* that matches the given m_IncludeName.
*/
int FindInformation(const char* includeName);
2001-01-11 22:47:38 +03:00
/**
2001-01-11 22:47:38 +03:00
* Compute the depend information for this class.
*/
void Depend(cmDependInformation* info);
2001-01-11 22:47:38 +03:00
/**
* Compute the depend information for this class.
*/
void DependWalk(cmDependInformation* info, const char* file);
/**
* Add a dependency. Possibly walk it for more dependencies.
*/
void AddDependency(cmDependInformation* info, const char* file);
/**
* Find the full path name for the given file name.
2001-01-11 22:47:38 +03:00
* This uses the include directories.
*/
std::string FullPath(const char*);
2001-01-11 22:47:38 +03:00
cmMakefile* m_Makefile;
bool m_Verbose;
cmRegularExpression m_IncludeFileRegularExpression;
typedef std::vector<cmDependInformation*> DependArray;
DependArray m_DependInformation;
std::vector<std::string> m_IncludeDirectories;
};
#endif