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.
126 lines
4.1 KiB
C++
126 lines
4.1 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#ifndef cmDepends_h
|
|
#define cmDepends_h
|
|
|
|
#include <cmConfigure.h>
|
|
|
|
#include <iosfwd>
|
|
#include <map>
|
|
#include <set>
|
|
#include <stddef.h>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
class cmFileTimeComparison;
|
|
class cmLocalGenerator;
|
|
|
|
/** \class cmDepends
|
|
* \brief Dependency scanner superclass.
|
|
*
|
|
* This class is responsible for maintaining a .depends.make file in
|
|
* the build tree corresponding to an object file. Subclasses help it
|
|
* maintain dependencies for particular languages.
|
|
*/
|
|
class cmDepends
|
|
{
|
|
public:
|
|
/** Instances need to know the build directory name and the relative
|
|
path from the build directory to the target file. */
|
|
cmDepends(cmLocalGenerator* lg = CM_NULLPTR, const char* targetDir = "");
|
|
|
|
/** at what level will the compile be done from */
|
|
void SetCompileDirectory(const char* dir) { this->CompileDirectory = dir; }
|
|
|
|
/** Set the local generator for the directory in which we are
|
|
scanning dependencies. This is not a full local generator; it
|
|
has been setup to do relative path conversions for the current
|
|
directory. */
|
|
void SetLocalGenerator(cmLocalGenerator* lg) { this->LocalGenerator = lg; }
|
|
|
|
/** Set the specific language to be scanned. */
|
|
void SetLanguage(const std::string& lang) { this->Language = lang; }
|
|
|
|
/** Set the target build directory. */
|
|
void SetTargetDirectory(const char* dir) { this->TargetDirectory = dir; }
|
|
|
|
/** should this be verbose in its output */
|
|
void SetVerbose(bool verb) { this->Verbose = verb; }
|
|
|
|
/** Virtual destructor to cleanup subclasses properly. */
|
|
virtual ~cmDepends();
|
|
|
|
/** Write dependencies for the target file. */
|
|
bool Write(std::ostream& makeDepends, std::ostream& internalDepends);
|
|
|
|
class DependencyVector : public std::vector<std::string>
|
|
{
|
|
};
|
|
|
|
/** Check dependencies for the target file. Returns true if
|
|
dependencies are okay and false if they must be generated. If
|
|
they must be generated Clear has already been called to wipe out
|
|
the old dependencies.
|
|
Dependencies which are still valid will be stored in validDeps. */
|
|
bool Check(const char* makeFile, const char* internalFile,
|
|
std::map<std::string, DependencyVector>& validDeps);
|
|
|
|
/** Clear dependencies for the target file so they will be regenerated. */
|
|
void Clear(const char* file);
|
|
|
|
/** Set the file comparison object */
|
|
void SetFileComparison(cmFileTimeComparison* fc)
|
|
{
|
|
this->FileComparison = fc;
|
|
}
|
|
|
|
protected:
|
|
// Write dependencies for the target file to the given stream.
|
|
// Return true for success and false for failure.
|
|
virtual bool WriteDependencies(const std::set<std::string>& sources,
|
|
const std::string& obj,
|
|
std::ostream& makeDepends,
|
|
std::ostream& internalDepends);
|
|
|
|
// Check dependencies for the target file in the given stream.
|
|
// Return false if dependencies must be regenerated and true
|
|
// otherwise.
|
|
virtual bool CheckDependencies(
|
|
std::istream& internalDepends, const char* internalDependsFileName,
|
|
std::map<std::string, DependencyVector>& validDeps);
|
|
|
|
// Finalize the dependency information for the target.
|
|
virtual bool Finalize(std::ostream& makeDepends,
|
|
std::ostream& internalDepends);
|
|
|
|
// The directory in which the build rule for the target file is executed.
|
|
std::string CompileDirectory;
|
|
|
|
// The local generator.
|
|
cmLocalGenerator* LocalGenerator;
|
|
|
|
// Flag for verbose output.
|
|
bool Verbose;
|
|
cmFileTimeComparison* FileComparison;
|
|
|
|
std::string Language;
|
|
|
|
// The full path to the target's build directory.
|
|
std::string TargetDirectory;
|
|
|
|
size_t MaxPath;
|
|
char* Dependee;
|
|
char* Depender;
|
|
|
|
// The include file search path.
|
|
std::vector<std::string> IncludePath;
|
|
|
|
void SetIncludePathFromLanguage(const std::string& lang);
|
|
|
|
private:
|
|
cmDepends(cmDepends const&); // Purposely not implemented.
|
|
void operator=(cmDepends const&); // Purposely not implemented.
|
|
};
|
|
|
|
#endif
|