mirror of
https://github.com/reactos/CMake.git
synced 2024-12-14 07:09:22 +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.
96 lines
3.0 KiB
C++
96 lines
3.0 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#ifndef cmSourceFileLocation_h
|
|
#define cmSourceFileLocation_h
|
|
|
|
#include <cmConfigure.h> // IWYU pragma: keep
|
|
|
|
#include <string>
|
|
|
|
class cmMakefile;
|
|
|
|
/** \class cmSourceFileLocation
|
|
* \brief cmSourceFileLocation tracks knowledge about a source file location
|
|
*
|
|
* Source files can be referenced by a variety of names. The
|
|
* directory and/or extension may be omitted leading to a certain
|
|
* level of ambiguity about the source file location. This class is
|
|
* used by cmSourceFile to keep track of what is known about the
|
|
* source file location. Each reference may add some information
|
|
* about the directory or extension of the file.
|
|
*/
|
|
class cmSourceFileLocation
|
|
{
|
|
public:
|
|
/**
|
|
* Construct for a source file created in a given cmMakefile
|
|
* instance with an initial name.
|
|
*/
|
|
cmSourceFileLocation(cmMakefile const* mf, const std::string& name);
|
|
cmSourceFileLocation();
|
|
cmSourceFileLocation(const cmSourceFileLocation& loc);
|
|
cmSourceFileLocation& operator=(const cmSourceFileLocation& loc);
|
|
|
|
/**
|
|
* Return whether the given source file location could refers to the
|
|
* same source file as this location given the level of ambiguity in
|
|
* each location.
|
|
*/
|
|
bool Matches(cmSourceFileLocation const& loc);
|
|
|
|
/**
|
|
* Explicity state that the source file is located in the source tree.
|
|
*/
|
|
void DirectoryUseSource();
|
|
|
|
/**
|
|
* Explicity state that the source file is located in the build tree.
|
|
*/
|
|
void DirectoryUseBinary();
|
|
|
|
/**
|
|
* Return whether the directory containing the source is ambiguous.
|
|
*/
|
|
bool DirectoryIsAmbiguous() const { return this->AmbiguousDirectory; }
|
|
|
|
/**
|
|
* Return whether the extension of the source name is ambiguous.
|
|
*/
|
|
bool ExtensionIsAmbiguous() const { return this->AmbiguousExtension; }
|
|
|
|
/**
|
|
* Get the directory containing the file as best is currently known.
|
|
* If DirectoryIsAmbiguous() returns false this will be a full path.
|
|
* Otherwise it will be a relative path (possibly empty) that is
|
|
* either with respect to the source or build tree.
|
|
*/
|
|
const std::string& GetDirectory() const { return this->Directory; }
|
|
|
|
/**
|
|
* Get the file name as best is currently known. If
|
|
* ExtensionIsAmbiguous() returns true this name may not be the
|
|
* final name (but could be). Otherwise the returned name is the
|
|
* final name.
|
|
*/
|
|
const std::string& GetName() const { return this->Name; }
|
|
|
|
/**
|
|
* Get the cmMakefile instance for which the source file was created.
|
|
*/
|
|
cmMakefile const* GetMakefile() const { return this->Makefile; }
|
|
private:
|
|
cmMakefile const* Makefile;
|
|
bool AmbiguousDirectory;
|
|
bool AmbiguousExtension;
|
|
std::string Directory;
|
|
std::string Name;
|
|
|
|
bool MatchesAmbiguousExtension(cmSourceFileLocation const& loc) const;
|
|
|
|
// Update the location with additional knowledge.
|
|
void Update(cmSourceFileLocation const& loc);
|
|
void UpdateExtension(const std::string& name);
|
|
};
|
|
|
|
#endif
|