CMake/Source/cmSourceFile.h
2001-04-24 16:49:12 -04:00

118 lines
3.3 KiB
C++

/*=========================================================================
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 cmSourceFile_h
#define cmSourceFile_h
#include "cmStandardIncludes.h"
/** \class cmSourceFile
* \brief Represent a class loaded from a makefile.
*
* cmSourceFile is represents a class loaded from
* a makefile.
*/
class cmSourceFile
{
public:
/**
* Construct instance as a concrete class with both a
* .h and .cxx file.
*/
cmSourceFile()
{
m_AbstractClass = false;
m_HeaderFileOnly = false;
m_WrapExclude = false;
}
/**
* Set the name of the file, given the directory
* the file should be in. Various extensions are tried on
* the name (e.g., .cxx, .cpp) in the directory to find the actual file.
*/
void SetName(const char* name, const char* dir);
/**
* Set the name of the file, given the directory the file should be in. IN
* this version the extesion is provided in the call. This is useful for
* generated files that do not exist prior to the build.
*/
void SetName(const char* name, const char* dir, const char *ext,
bool headerFileOnly);
/**
* Print the structure to std::cout.
*/
void Print() const;
/**
* Indicate whether the class is abstract (non-instantiable).
*/
bool IsAnAbstractClass() const { return m_AbstractClass; }
bool GetIsAnAbstractClass() const { return m_AbstractClass; }
void SetIsAnAbstractClass(bool f) { m_AbstractClass = f; }
/**
* Indicate whether the class should not be wrapped
*/
bool GetWrapExclude() const { return m_WrapExclude; }
void SetWrapExclude(bool f) { m_WrapExclude = f; }
/**
* Indicate whether this class is defined with only the header file.
*/
bool IsAHeaderFileOnly() const { return m_HeaderFileOnly; }
bool GetIsAHeaderFileOnly() const { return m_HeaderFileOnly; }
void SetIsAHeaderFileOnly(bool f) { m_HeaderFileOnly = f; }
/**
* The full path to the file.
*/
std::string GetFullPath() const {return m_FullPath;}
void SetFullPath(const char *name) {m_FullPath = name;}
/**
* The file name associated with stripped off directory and extension.
* (In most cases this is the name of the class.)
*/
std::string GetSourceName() const {return m_SourceName;}
void SetSourceName(const char *name) {m_SourceName = name;}
/**
* The file name associated with stripped off directory and extension.
* (In most cases this is the name of the class.)
*/
std::string GetSourceExtension() const {return m_SourceExtension;}
void SetSourceExtension(const char *name) {m_SourceExtension = name;}
/**
* Return the vector that holds the list of dependencies
*/
const std::vector<std::string> &GetDepends() const {return m_Depends;}
std::vector<std::string> &GetDepends() {return m_Depends;}
private:
bool m_AbstractClass;
bool m_WrapExclude;
bool m_HeaderFileOnly;
std::string m_FullPath;
std::string m_SourceName;
std::string m_SourceExtension;
std::vector<std::string> m_Depends;
};
#endif