CMake/Source/cmSourceFile.h

128 lines
3.8 KiB
C
Raw Normal View History

/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
2002-01-21 23:30:43 +03:00
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
2001-04-25 00:49:12 +04:00
#ifndef cmSourceFile_h
#define cmSourceFile_h
2003-06-03 18:30:23 +04:00
#include "cmCustomCommand.h"
#include "cmPropertyMap.h"
class cmake;
2001-04-25 00:49:12 +04:00
/** \class cmSourceFile
2001-01-11 22:47:38 +03:00
* \brief Represent a class loaded from a makefile.
*
2001-04-25 00:49:12 +04:00
* cmSourceFile is represents a class loaded from
2001-01-11 22:47:38 +03:00
* a makefile.
*/
2001-04-25 00:49:12 +04:00
class cmSourceFile
{
2001-01-11 22:47:38 +03:00
public:
/**
* Construct instance as a concrete class with both a
* .h and .cxx file.
*/
cmSourceFile();
2003-06-03 18:30:23 +04:00
~cmSourceFile()
{
this->SetCustomCommand(0);
}
/**
* Set the name of the file, given the directory the file should be
* in. The various extensions provided are tried on the name
* (e.g., cxx, cpp) in the directory to find the actual file.
*/
bool SetName(const char* name, const char* dir,
const std::vector<std::string>& sourceExts,
const std::vector<std::string>& headerExts,
const char* target = 0);
2001-01-11 22:47:38 +03:00
2003-06-03 18:30:23 +04:00
/**
* Get the list of the custom commands for this source file
*/
const cmCustomCommand *GetCustomCommand() const
2006-03-15 19:02:08 +03:00
{return this->CustomCommand;}
cmCustomCommand *GetCustomCommand() {return this->CustomCommand;}
void SetCustomCommand(cmCustomCommand *cc);
2003-06-03 18:30:23 +04:00
/**
* Set the name of the file, given the directory the file should be in. IN
* this version the extension 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);
/**
2001-01-11 22:47:38 +03:00
* Print the structure to std::cout.
*/
void Print() const;
///! Set/Get a property of this source file
void SetProperty(const char *prop, const char *value);
const char *GetProperty(const char *prop) const;
bool GetPropertyAsBool(const char *prop) const;
2001-01-11 22:47:38 +03:00
/**
* The full path to the file.
*/
2006-03-15 19:02:08 +03:00
const std::string &GetFullPath() const {return this->FullPath;}
void SetFullPath(const char *name) {this->FullPath = name;}
2001-01-11 22:47:38 +03:00
/**
* The file name associated with stripped off directory and extension.
* (In most cases this is the name of the class.)
*/
2006-03-15 19:02:08 +03:00
const std::string &GetSourceName() const {return this->SourceName;}
void SetSourceName(const char *name) {this->SourceName = name;}
2001-01-11 22:47:38 +03:00
/**
2003-06-03 18:30:23 +04:00
* The file extension associated with source file
*/
2006-05-12 21:53:21 +04:00
const std::string &GetSourceExtension() const {
return this->SourceExtension;}
2006-03-15 19:02:08 +03:00
void SetSourceExtension(const char *name) {this->SourceExtension = name;}
2001-01-11 22:47:38 +03:00
/**
2001-04-25 00:49:12 +04:00
* Return the vector that holds the list of dependencies
2001-01-11 22:47:38 +03:00
*/
2006-03-15 19:02:08 +03:00
const std::vector<std::string> &GetDepends() const {return this->Depends;}
std::vector<std::string> &GetDepends() {return this->Depends;}
2001-04-25 00:49:12 +04:00
/**
* Get the source name without last extension
*/
const std::string& GetSourceNameWithoutLastExtension();
// Get the properties
cmPropertyMap &GetProperties() { return this->Properties; };
// Define the properties
static void DefineProperties(cmake *cm);
2001-04-25 00:49:12 +04:00
private:
cmPropertyMap Properties;
2006-03-15 19:02:08 +03:00
cmCustomCommand *CustomCommand;
std::string FullPath;
std::string SourceName;
std::string SourceExtension;
std::vector<std::string> Depends;
std::string SourceNameWithoutLastExtension;
};
#endif