mirror of
https://github.com/reactos/CMake.git
synced 2024-11-24 20:19:53 +00:00
86578eccf2
Per-source copyright/license notice headers that spell out copyright holder names and years are hard to maintain and often out-of-date or plain wrong. Precise contributor information is already maintained automatically by the version control tool. Ultimately it is the receiver of a file who is responsible for determining its licensing status, and per-source notices are merely a convenience. Therefore it is simpler and more accurate for each source to have a generic notice of the license name and references to more detailed information on copyright holders and full license terms. Our `Copyright.txt` file now contains a list of Contributors whose names appeared source-level copyright notices. It also references version control history for more precise information. Therefore we no longer need to spell out the list of Contributors in each source file notice. Replace CMake per-source copyright/license notice headers with a short description of the license and links to `Copyright.txt` and online information available from "https://cmake.org/licensing". The online URL also handles cases of modules being copied out of our source into other projects, so we can drop our notices about replacing links with full license text. Run the `Utilities/Scripts/filter-notices.bash` script to perform the majority of the replacements mechanically. Manually fix up shebang lines and trailing newlines in a few files. Manually update the notices in a few files that the script does not handle.
123 lines
3.5 KiB
C++
123 lines
3.5 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#ifndef cmSourceFile_h
|
|
#define cmSourceFile_h
|
|
|
|
#include <cmConfigure.h>
|
|
|
|
#include "cmPropertyMap.h"
|
|
#include "cmSourceFileLocation.h"
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
class cmCustomCommand;
|
|
class cmMakefile;
|
|
|
|
/** \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 std::string& 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 std::string& prop, const char* value);
|
|
void AppendProperty(const std::string& prop, const char* value,
|
|
bool asString = false);
|
|
const char* GetProperty(const std::string& prop) const;
|
|
bool GetPropertyAsBool(const std::string& prop) const;
|
|
|
|
/** Implement getting a property when called from a CMake language
|
|
command like get_property or get_source_file_property. */
|
|
const char* GetPropertyForUser(const std::string& prop);
|
|
|
|
/**
|
|
* 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* error = CM_NULLPTR);
|
|
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.
|
|
*/
|
|
std::string GetLanguage();
|
|
std::string GetLanguage() const;
|
|
|
|
/**
|
|
* Return the vector that holds the list of dependencies
|
|
*/
|
|
const std::vector<std::string>& GetDepends() const { return this->Depends; }
|
|
void AddDepend(const std::string& d) { this->Depends.push_back(d); }
|
|
|
|
// Get the properties
|
|
cmPropertyMap& GetProperties() { return this->Properties; }
|
|
|
|
/**
|
|
* Check whether the given source file location could refer to this
|
|
* source.
|
|
*/
|
|
bool Matches(cmSourceFileLocation const&);
|
|
|
|
void SetObjectLibrary(std::string const& objlib);
|
|
std::string GetObjectLibrary() const;
|
|
|
|
private:
|
|
cmSourceFileLocation Location;
|
|
cmPropertyMap Properties;
|
|
cmCustomCommand* CustomCommand;
|
|
std::string Extension;
|
|
std::string Language;
|
|
std::string FullPath;
|
|
std::string ObjectLibrary;
|
|
std::vector<std::string> Depends;
|
|
bool FindFullPathFailed;
|
|
bool IsUiFile;
|
|
|
|
bool FindFullPath(std::string* error);
|
|
bool TryFullPath(const std::string& path, const std::string& ext);
|
|
void CheckExtension();
|
|
void CheckLanguage(std::string const& ext);
|
|
|
|
static const std::string propLANGUAGE;
|
|
};
|
|
|
|
// TODO: Factor out into platform information modules.
|
|
#define CM_HEADER_REGEX "\\.(h|hh|h\\+\\+|hm|hpp|hxx|in|txx|inl)$"
|
|
|
|
#endif
|