CMake/Source/cmSourceFile.h

120 lines
3.4 KiB
C++

/*=========================================================================
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.
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.
=========================================================================*/
#ifndef cmSourceFile_h
#define cmSourceFile_h
#include "cmSourceFileLocation.h"
#include "cmCustomCommand.h"
#include "cmPropertyMap.h"
class cmake;
/** \class cmSourceFile
* \brief Represent a class loaded from a makefile.
*
* cmSourceFile is represents a class loaded from
* a makefile.
*/
class cmSourceFile
{
public:
/**
* Construct with the makefile storing the source and the initial
* name referencing it.
*/
cmSourceFile(cmMakefile* mf, const char* name);
~cmSourceFile();
/**
* Get the list of the custom commands for this source file
*/
cmCustomCommand* GetCustomCommand();
cmCustomCommand const* GetCustomCommand() const;
void SetCustomCommand(cmCustomCommand *cc);
///! Set/Get a property of this source file
void SetProperty(const char *prop, const char *value);
void AppendProperty(const char* prop, const char* value);
const char *GetProperty(const char *prop) const;
bool GetPropertyAsBool(const char *prop) const;
/**
* The full path to the file. The non-const version of this method
* may attempt to locate the file on disk and finalize its location.
* The const version of this method may return an empty string if
* the non-const version has not yet been called (yes this is a
* horrible interface, but is necessary for backwards
* compatibility).
*/
std::string const& GetFullPath();
std::string const& GetFullPath() const;
/**
* Get the information currently known about the source file
* location without attempting to locate the file as GetFullPath
* would. See cmSourceFileLocation documentation.
*/
cmSourceFileLocation const& GetLocation() const;
/**
* Get the file extension of this source file.
*/
std::string const& GetExtension() const;
/**
* Get the language of the compiler to use for this source file.
*/
const char* GetLanguage();
const char* GetLanguage() const;
/**
* Return the vector that holds the list of dependencies
*/
const std::vector<std::string> &GetDepends() const {return this->Depends;}
void AddDepend(const char* d) { this->Depends.push_back(d); }
// Get the properties
cmPropertyMap &GetProperties() { return this->Properties; };
// Define the properties
static void DefineProperties(cmake *cm);
/**
* Check whether the given source file location could refer to this
* source.
*/
bool Matches(cmSourceFileLocation const&);
private:
cmSourceFileLocation Location;
cmPropertyMap Properties;
cmCustomCommand* CustomCommand;
std::string Extension;
std::string Language;
std::string FullPath;
bool FindFullPathFailed;
bool FindFullPath();
bool TryFullPath(const char* tryPath, const char* ext);
void CheckExtension();
std::vector<std::string> Depends;
};
#endif