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.
121 lines
3.8 KiB
C++
121 lines
3.8 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#ifndef cmLocalNinjaGenerator_h
|
|
#define cmLocalNinjaGenerator_h
|
|
|
|
#include <cmConfigure.h>
|
|
|
|
#include "cmLocalCommonGenerator.h"
|
|
#include "cmLocalGenerator.h"
|
|
#include "cmNinjaTypes.h"
|
|
#include "cmOutputConverter.h"
|
|
|
|
#include <iosfwd>
|
|
#include <map>
|
|
#include <set>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
class cmCustomCommand;
|
|
class cmCustomCommandGenerator;
|
|
class cmGeneratedFileStream;
|
|
class cmGeneratorTarget;
|
|
class cmGlobalGenerator;
|
|
class cmGlobalNinjaGenerator;
|
|
class cmMakefile;
|
|
class cmSourceFile;
|
|
class cmake;
|
|
|
|
/**
|
|
* \class cmLocalNinjaGenerator
|
|
* \brief Write a local build.ninja file.
|
|
*
|
|
* cmLocalNinjaGenerator produces a local build.ninja file from its
|
|
* member Makefile.
|
|
*/
|
|
class cmLocalNinjaGenerator : public cmLocalCommonGenerator
|
|
{
|
|
public:
|
|
cmLocalNinjaGenerator(cmGlobalGenerator* gg, cmMakefile* mf);
|
|
|
|
~cmLocalNinjaGenerator() CM_OVERRIDE;
|
|
|
|
void Generate() CM_OVERRIDE;
|
|
|
|
std::string GetTargetDirectory(cmGeneratorTarget const* target) const
|
|
CM_OVERRIDE;
|
|
|
|
const cmGlobalNinjaGenerator* GetGlobalNinjaGenerator() const;
|
|
cmGlobalNinjaGenerator* GetGlobalNinjaGenerator();
|
|
|
|
const cmake* GetCMakeInstance() const;
|
|
cmake* GetCMakeInstance();
|
|
|
|
/// @returns the relative path between the HomeOutputDirectory and this
|
|
/// local generators StartOutputDirectory.
|
|
std::string GetHomeRelativeOutputPath() const
|
|
{
|
|
return this->HomeRelativeOutputPath;
|
|
}
|
|
|
|
void ExpandRuleVariables(std::string& string,
|
|
const RuleVariables& replaceValues)
|
|
{
|
|
cmLocalGenerator::ExpandRuleVariables(string, replaceValues);
|
|
}
|
|
|
|
std::string BuildCommandLine(const std::vector<std::string>& cmdLines);
|
|
|
|
void AppendTargetOutputs(cmGeneratorTarget* target, cmNinjaDeps& outputs);
|
|
void AppendTargetDepends(cmGeneratorTarget* target, cmNinjaDeps& outputs);
|
|
|
|
void AddCustomCommandTarget(cmCustomCommand const* cc,
|
|
cmGeneratorTarget* target);
|
|
void AppendCustomCommandLines(cmCustomCommandGenerator const& ccg,
|
|
std::vector<std::string>& cmdLines);
|
|
void AppendCustomCommandDeps(cmCustomCommandGenerator const& ccg,
|
|
cmNinjaDeps& ninjaDeps);
|
|
|
|
std::string ConvertToLinkReference(std::string const& lib,
|
|
cmOutputConverter::OutputFormat format =
|
|
cmOutputConverter::SHELL) CM_OVERRIDE;
|
|
|
|
void ComputeObjectFilenames(
|
|
std::map<cmSourceFile const*, std::string>& mapping,
|
|
cmGeneratorTarget const* gt = CM_NULLPTR) CM_OVERRIDE;
|
|
|
|
protected:
|
|
std::string ConvertToIncludeReference(
|
|
std::string const& path,
|
|
cmOutputConverter::OutputFormat format = cmOutputConverter::SHELL,
|
|
bool forceFullPaths = false) CM_OVERRIDE;
|
|
|
|
private:
|
|
cmGeneratedFileStream& GetBuildFileStream() const;
|
|
cmGeneratedFileStream& GetRulesFileStream() const;
|
|
|
|
void WriteBuildFileTop();
|
|
void WriteProjectHeader(std::ostream& os);
|
|
void WriteNinjaRequiredVersion(std::ostream& os);
|
|
void WriteNinjaFilesInclusion(std::ostream& os);
|
|
void WriteProcessedMakefile(std::ostream& os);
|
|
void WritePools(std::ostream& os);
|
|
|
|
void WriteCustomCommandRule();
|
|
void WriteCustomCommandBuildStatement(cmCustomCommand const* cc,
|
|
const cmNinjaDeps& orderOnlyDeps);
|
|
|
|
void WriteCustomCommandBuildStatements();
|
|
|
|
std::string MakeCustomLauncher(cmCustomCommandGenerator const& ccg);
|
|
|
|
std::string HomeRelativeOutputPath;
|
|
|
|
typedef std::map<cmCustomCommand const*, std::set<cmGeneratorTarget*> >
|
|
CustomCommandTargetMap;
|
|
CustomCommandTargetMap CustomCommandTargets;
|
|
std::vector<cmCustomCommand const*> CustomCommands;
|
|
};
|
|
|
|
#endif // ! cmLocalNinjaGenerator_h
|