CMake/Source/cmLocalUnixMakefileGenerato...

386 lines
14 KiB
C
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
2005-05-05 20:45:53 +04:00
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
2005-05-05 20:45:53 +04:00
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
2005-05-05 20:45:53 +04:00
#ifndef cmLocalUnixMakefileGenerator3_h
#define cmLocalUnixMakefileGenerator3_h
#include "cmLocalGenerator.h"
// for cmDepends::DependencyVector
#include "cmDepends.h"
2005-05-05 20:45:53 +04:00
class cmCustomCommand;
class cmCustomCommandGenerator;
2005-05-05 20:45:53 +04:00
class cmDependInformation;
class cmDepends;
class cmMakefileTargetGenerator;
2005-05-05 20:45:53 +04:00
class cmTarget;
class cmSourceFile;
/** \class cmLocalUnixMakefileGenerator3
* \brief Write a LocalUnix makefiles.
*
* cmLocalUnixMakefileGenerator3 produces a LocalUnix makefile from its
2006-03-15 19:02:08 +03:00
* member Makefile.
2005-05-05 20:45:53 +04:00
*/
class cmLocalUnixMakefileGenerator3 : public cmLocalGenerator
{
public:
cmLocalUnixMakefileGenerator3();
virtual ~cmLocalUnixMakefileGenerator3();
2005-06-01 21:37:49 +04:00
/**
* Process the CMakeLists files for this directory to fill in the
2011-10-13 21:51:18 +04:00
* Makefile ivar
2005-06-01 21:37:49 +04:00
*/
virtual void Configure();
/**
2011-10-13 21:51:18 +04:00
* Generate the makefile for this directory.
*/
virtual void Generate();
2005-05-06 22:49:38 +04:00
2011-10-13 21:51:18 +04:00
2005-05-06 22:49:38 +04:00
// this returns the relative path between the HomeOutputDirectory and this
// local generators StartOutputDirectory
2005-06-01 21:37:49 +04:00
const std::string &GetHomeRelativeOutputPath();
2005-05-06 22:49:38 +04:00
2011-10-13 21:51:18 +04:00
// Write out a make rule
2005-05-06 22:49:38 +04:00
void WriteMakeRule(std::ostream& os,
const char* comment,
2014-02-07 02:31:47 +04:00
const std::string& target,
2005-05-06 22:49:38 +04:00
const std::vector<std::string>& depends,
const std::vector<std::string>& commands,
bool symbolic,
bool in_help = false);
2011-10-13 21:51:18 +04:00
2005-05-06 22:49:38 +04:00
// write the main variables used by the makefiles
2005-08-06 01:07:07 +04:00
void WriteMakeVariables(std::ostream& makefileStream);
2005-05-06 22:49:38 +04:00
/**
* If true, then explicitly pass MAKEFLAGS on the make all target for makes
* that do not use environment variables.
*
*/
2006-03-15 19:02:08 +03:00
void SetPassMakeflags(bool s){this->PassMakeflags = s;}
bool GetPassMakeflags() { return this->PassMakeflags; }
2011-10-13 21:51:18 +04:00
2005-05-06 22:49:38 +04:00
/**
* Set the flag used to keep the make program silent.
*/
void SetMakeSilentFlag(const std::string& s) { this->MakeSilentFlag = s; }
2006-03-15 19:02:08 +03:00
std::string &GetMakeSilentFlag() { return this->MakeSilentFlag; }
2005-05-05 20:45:53 +04:00
/**
* Set to true if the shell being used is the windows shell.
* This controls if statements in the makefile and the SHELL variable.
* The default is false.
*/
2006-03-15 19:02:08 +03:00
void SetWindowsShell(bool v) {this->WindowsShell = v;}
2005-05-05 20:45:53 +04:00
/**
* Set to true if the make tool being used is Watcom WMake.
*/
void SetWatcomWMake(bool v) {this->WatcomWMake = v;}
/**
* Set to true if the make tool being used is MinGW Make.
*/
void SetMinGWMake(bool v) {this->MinGWMake = v;}
/**
* Set to true if the make tool being used is NMake.
*/
void SetNMake(bool v) {this->NMake = v;}
/**
* Set to true if the shell being used is the MSYS shell.
* This controls if statements in the makefile and the SHELL variable.
* The default is false.
*/
void SetMSYSShell(bool v) {this->MSYSShell = v;}
/**
* If set to true, then NULL is set to nil for non Windows_NT.
* This uses make syntax used by nmake and borland.
* The default is false.
*/
2006-03-15 19:02:08 +03:00
void SetDefineWindowsNULL(bool v) {this->DefineWindowsNULL = v;}
/**
2011-10-13 21:51:18 +04:00
* If set to true, cd dir && command is used to
* run commands in a different directory.
*/
2006-03-15 19:02:08 +03:00
void SetUnixCD(bool v) {this->UnixCD = v;}
2005-05-05 20:45:53 +04:00
/**
* Set the string used to include one makefile into another default
* is include.
*/
void SetIncludeDirective(const std::string& s)
{ this->IncludeDirective = s; }
const std::string& GetIncludeDirective() { return this->IncludeDirective; }
2005-05-05 20:45:53 +04:00
/**
* Set max makefile variable size, default is 0 which means unlimited.
*/
2006-03-15 19:02:08 +03:00
void SetMakefileVariableSize(int s) { this->MakefileVariableSize = s; }
2005-05-05 20:45:53 +04:00
/**
* If ignore lib prefix is true, then do not strip lib from the name
* of a library.
*/
2006-03-15 19:02:08 +03:00
void SetIgnoreLibPrefix(bool s) { this->IgnoreLibPrefix = s; }
2005-05-05 20:45:53 +04:00
/**
* Set whether passing a make target on a command line requires an
* extra level of escapes.
*/
void SetMakeCommandEscapeTargetTwice(bool b)
{ this->MakeCommandEscapeTargetTwice = b; }
/**
* Set whether the Borland curly brace command line hack should be
* applied.
*/
void SetBorlandMakeCurlyHack(bool b)
{ this->BorlandMakeCurlyHack = b; }
// used in writing out Cmake files such as WriteDirectoryInformation
static void WriteCMakeArgument(std::ostream& os, const char* s);
2011-03-19 13:41:00 +03:00
/** creates the common disclaimer text at the top of each makefile */
void WriteDisclaimer(std::ostream& os);
// write a comment line #====... in the stream
void WriteDivider(std::ostream& os);
/** used to create a recursive make call */
2014-02-07 02:31:47 +04:00
std::string GetRecursiveMakeCall(const char *makefile,
const std::string& tgt);
2011-10-13 21:51:18 +04:00
2007-05-10 22:43:55 +04:00
// append flags to a string
virtual void AppendFlags(std::string& flags, const std::string& newFlags);
2007-05-10 22:43:55 +04:00
virtual void AppendFlags(std::string& flags, const char* newFlags);
// append an echo command
enum EchoColor { EchoNormal, EchoDepend, EchoBuild, EchoLink,
EchoGenerate, EchoGlobal };
void AppendEcho(std::vector<std::string>& commands, const char* text,
EchoColor color = EchoNormal);
/** Get whether the makefile is to have color. */
bool GetColorMakefile() const { return this->ColorMakefile; }
virtual std::string GetTargetDirectory(cmTarget const& target) const;
// create a command that cds to the start dir then runs the commands
2011-10-13 21:51:18 +04:00
void CreateCDCommand(std::vector<std::string>& commands,
const char *targetDir,
cmLocalGenerator::RelativeRoot returnDir);
static std::string ConvertToQuotedOutputPath(const char* p,
bool useWatcomQuote);
std::string CreateMakeVariable(const std::string& sin,
const std::string& s2in);
/** Called from command-line hook to bring dependencies up to date
for a target. */
virtual bool UpdateDependencies(const char* tgtInfo,
bool verbose, bool color);
/** Called from command-line hook to clear dependencies. */
virtual void ClearDependencies(cmMakefile* mf, bool verbose);
2011-10-13 21:51:18 +04:00
/** write some extra rules such as make test etc */
2005-05-06 22:49:38 +04:00
void WriteSpecialTargetsTop(std::ostream& makefileStream);
2005-05-05 20:45:53 +04:00
void WriteSpecialTargetsBottom(std::ostream& makefileStream);
std::string GetRelativeTargetDirectory(cmTarget const& target);
2005-05-05 20:45:53 +04:00
// File pairs for implicit dependency scanning. The key of the map
// is the depender and the value is the explicit dependee.
struct ImplicitDependFileMap:
public std::map<std::string, cmDepends::DependencyVector> {};
struct ImplicitDependLanguageMap:
public std::map<std::string, ImplicitDependFileMap> {};
struct ImplicitDependTargetMap:
public std::map<std::string, ImplicitDependLanguageMap> {};
ImplicitDependLanguageMap const& GetImplicitDepends(cmTarget const& tgt);
void AddImplicitDepends(cmTarget const& tgt, const std::string& lang,
const char* obj, const char* src);
void AppendGlobalTargetDepends(std::vector<std::string>& depends,
cmTarget& target);
// write the target rules for the local Makefile into the stream
void WriteLocalAllRules(std::ostream& ruleFileStream);
2011-10-13 21:51:18 +04:00
std::vector<std::string> const& GetLocalHelp() { return this->LocalHelp; }
/** Get whether to create rules to generate preprocessed and
assembly sources. This could be converted to a variable lookup
later. */
bool GetCreatePreprocessedSourceRules()
{
return !this->SkipPreprocessedSourceRules;
}
bool GetCreateAssemblySourceRules()
{
return !this->SkipAssemblySourceRules;
}
2011-10-13 21:51:18 +04:00
// Fill the vector with the target names for the object files,
// preprocessed files and assembly files. Currently only used by the
// Eclipse generator.
void GetIndividualFileTargets(std::vector<std::string>& targets);
2011-10-13 21:51:18 +04:00
2005-05-05 20:45:53 +04:00
protected:
void WriteLocalMakefile();
2011-10-13 21:51:18 +04:00
2005-05-11 16:45:16 +04:00
// write the target rules for the local Makefile into the stream
void WriteLocalMakefileTargets(std::ostream& ruleFileStream,
std::set<std::string> &emitted);
// this method Writes the Directory information files
void WriteDirectoryInformationFile();
2011-10-13 21:51:18 +04:00
// write the depend info
void WriteDependLanguageInfo(std::ostream& cmakefileStream, cmTarget &tgt);
2011-10-13 21:51:18 +04:00
// write the local help rule
void WriteHelpRule(std::ostream& ruleFileStream);
2011-10-13 21:51:18 +04:00
// this converts a file name that is relative to the StartOuputDirectory
// into a full path
std::string ConvertToFullPath(const std::string& localPath);
2011-10-13 21:51:18 +04:00
2005-05-06 22:49:38 +04:00
void WriteConvenienceRule(std::ostream& ruleFileStream,
2014-02-07 02:31:47 +04:00
const std::string& realTarget,
const std::string& helpTarget);
2005-05-17 19:15:09 +04:00
void WriteTargetDependRule(std::ostream& ruleFileStream,
cmTarget& target);
void WriteTargetCleanRule(std::ostream& ruleFileStream,
cmTarget& target,
const std::vector<std::string>& files);
2005-05-11 16:45:16 +04:00
void WriteTargetRequiresRule(std::ostream& ruleFileStream,
cmTarget& target,
2005-05-17 19:15:09 +04:00
const std::vector<std::string>& objects);
2011-10-13 21:51:18 +04:00
2005-05-05 20:45:53 +04:00
void AppendRuleDepend(std::vector<std::string>& depends,
const char* ruleFileName);
void AppendRuleDepends(std::vector<std::string>& depends,
std::vector<std::string> const& ruleFiles);
2005-05-05 20:45:53 +04:00
void AppendCustomDepends(std::vector<std::string>& depends,
const std::vector<cmCustomCommand>& ccs);
void AppendCustomDepend(std::vector<std::string>& depends,
cmCustomCommandGenerator const& cc);
2005-05-05 20:45:53 +04:00
void AppendCustomCommands(std::vector<std::string>& commands,
const std::vector<cmCustomCommand>& ccs,
cmTarget* target,
cmLocalGenerator::RelativeRoot relative =
cmLocalGenerator::HOME_OUTPUT);
2005-05-05 20:45:53 +04:00
void AppendCustomCommand(std::vector<std::string>& commands,
cmCustomCommandGenerator const& ccg,
cmTarget* target,
bool echo_comment=false,
cmLocalGenerator::RelativeRoot relative =
cmLocalGenerator::HOME_OUTPUT,
std::ostream* content = 0);
2005-05-05 20:45:53 +04:00
void AppendCleanCommand(std::vector<std::string>& commands,
const std::vector<std::string>& files,
cmTarget& target, const char* filename =0);
2005-05-05 20:45:53 +04:00
// Helper methods for dependeny updates.
bool ScanDependencies(const char* targetDir,
std::map<std::string, cmDepends::DependencyVector>& validDeps);
void CheckMultipleOutputs(bool verbose);
2005-05-05 20:45:53 +04:00
private:
std::string ConvertShellCommand(std::string const& cmd, RelativeRoot root);
std::string MakeLauncher(cmCustomCommandGenerator const& ccg,
cmTarget* target, RelativeRoot relative);
virtual void ComputeObjectFilenames(
std::map<cmSourceFile const*, std::string>& mapping,
cmGeneratorTarget const* gt = 0);
friend class cmMakefileTargetGenerator;
friend class cmMakefileExecutableTargetGenerator;
friend class cmMakefileLibraryTargetGenerator;
friend class cmMakefileUtilityTargetGenerator;
2006-05-23 17:11:46 +04:00
friend class cmGlobalUnixMakefileGenerator3;
ImplicitDependTargetMap ImplicitDepends;
2005-05-05 20:45:53 +04:00
//==========================================================================
// Configuration settings.
2006-03-15 19:02:08 +03:00
int MakefileVariableSize;
std::string IncludeDirective;
std::string MakeSilentFlag;
std::string ConfigurationName;
bool DefineWindowsNULL;
bool UnixCD;
bool PassMakeflags;
bool MakeCommandEscapeTargetTwice;
bool BorlandMakeCurlyHack;
//==========================================================================
2005-05-05 20:45:53 +04:00
2006-03-15 19:02:08 +03:00
std::string HomeRelativeOutputPath;
/* Copy the setting of CMAKE_COLOR_MAKEFILE from the makefile at the
beginning of generation to avoid many duplicate lookups. */
bool ColorMakefile;
/* Copy the setting of CMAKE_SKIP_PREPROCESSED_SOURCE_RULES and
CMAKE_SKIP_ASSEMBLY_SOURCE_RULES at the beginning of generation to
avoid many duplicate lookups. */
bool SkipPreprocessedSourceRules;
bool SkipAssemblySourceRules;
struct LocalObjectEntry
{
cmTarget* Target;
std::string Language;
LocalObjectEntry(): Target(0), Language() {}
LocalObjectEntry(cmTarget* t, const std::string& lang):
Target(t), Language(lang) {}
};
struct LocalObjectInfo: public std::vector<LocalObjectEntry>
{
bool HasSourceExtension;
bool HasPreprocessRule;
bool HasAssembleRule;
LocalObjectInfo():HasSourceExtension(false), HasPreprocessRule(false),
HasAssembleRule(false) {}
};
void GetLocalObjectFiles(
std::map<std::string, LocalObjectInfo> &localObjectFiles);
void WriteObjectConvenienceRule(std::ostream& ruleFileStream,
const char* comment, const char* output,
LocalObjectInfo const& info);
std::vector<std::string> LocalHelp;
/* does the work for each target */
std::map<std::string, std::string> MakeVariableMap;
std::map<std::string, std::string> ShortMakeVariableMap;
2005-05-05 20:45:53 +04:00
};
#endif