CMake/Source/cmakemain.cxx
Ben Boeckel 594bafe527 cmake: add --trace-expand option
The --trace option is helpful, but sometimes, what you're looking for is
deep under many layers of function calls and figuring out what instance
of the function call you're looking at is tedious to determine (usually
involving patching and message()). Instead, add a --trace-expand option
to trace while expanding commands into what CMake actually sees.
2015-07-23 15:33:10 -04:00

463 lines
12 KiB
C++

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
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.
============================================================================*/
// include these first, otherwise there will be problems on Windows
// with GetCurrentDirectory() being redefined
#ifdef CMAKE_BUILD_WITH_CMAKE
#include "cmDynamicLoader.h"
#include "cmDocumentation.h"
#endif
#include "cmake.h"
#include "cmcmd.h"
#include "cmState.h"
#include "cmListFileCache.h"
#include "cmSourceFile.h"
#include "cmGlobalGenerator.h"
#include "cmLocalGenerator.h"
#include "cmMakefile.h"
#include "cmAlgorithms.h"
#include <cmsys/Encoding.hxx>
#ifdef CMAKE_BUILD_WITH_CMAKE
//----------------------------------------------------------------------------
static const char * cmDocumentationName[][2] =
{
{0,
" cmake - Cross-Platform Makefile Generator."},
{0,0}
};
//----------------------------------------------------------------------------
static const char * cmDocumentationUsage[][2] =
{
{0,
" cmake [options] <path-to-source>\n"
" cmake [options] <path-to-existing-build>"},
{0,
"Specify a source directory to (re-)generate a build system for "
"it in the current working directory. Specify an existing build "
"directory to re-generate its build system."},
{0,0}
};
//----------------------------------------------------------------------------
static const char * cmDocumentationUsageNote[][2] =
{
{0,
"Run 'cmake --help' for more information."},
{0,0}
};
#define CMAKE_BUILD_OPTIONS \
" <dir> = Project binary directory to be built.\n" \
" --target <tgt> = Build <tgt> instead of default targets.\n" \
" --config <cfg> = For multi-configuration tools, choose <cfg>.\n" \
" --clean-first = Build target 'clean' first, then build.\n" \
" (To clean only, use --target 'clean'.)\n" \
" --use-stderr = Ignored. Behavior is default in CMake >= 3.0.\n" \
" -- = Pass remaining options to the native tool.\n"
//----------------------------------------------------------------------------
static const char * cmDocumentationOptions[][2] =
{
CMAKE_STANDARD_OPTIONS_TABLE,
{"-E", "CMake command mode."},
{"-L[A][H]", "List non-advanced cached variables."},
{"--build <dir>", "Build a CMake-generated project binary tree."},
{"-N", "View mode only."},
{"-P <file>", "Process script mode."},
{"--find-package", "Run in pkg-config like mode."},
{"--graphviz=[file]", "Generate graphviz of dependencies, see "
"CMakeGraphVizOptions.cmake for more."},
{"--system-information [file]", "Dump information about this system."},
{"--debug-trycompile", "Do not delete the try_compile build tree. Only "
"useful on one try_compile at a time."},
{"--debug-output", "Put cmake in a debug mode."},
{"--trace", "Put cmake in trace mode."},
{"--trace-expand", "Put cmake in trace mode with variable expansion."},
{"--warn-uninitialized", "Warn about uninitialized values."},
{"--warn-unused-vars", "Warn about unused variables."},
{"--no-warn-unused-cli", "Don't warn about command line options."},
{"--check-system-vars", "Find problems with variable usage in system "
"files."},
{0,0}
};
#endif
static int do_command(int ac, char const* const* av)
{
std::vector<std::string> args;
args.reserve(ac - 1);
args.push_back(av[0]);
args.insert(args.end(), av + 2, av + ac);
return cmcmd::ExecuteCMakeCommand(args);
}
int do_cmake(int ac, char const* const* av);
static int do_build(int ac, char const* const* av);
static cmMakefile* cmakemainGetMakefile(void *clientdata)
{
cmake* cm = (cmake *)clientdata;
if(cm && cm->GetDebugOutput())
{
cmGlobalGenerator* gg=cm->GetGlobalGenerator();
if (gg)
{
return gg->GetCurrentMakefile();
}
}
return 0;
}
static std::string cmakemainGetStack(void *clientdata)
{
std::string msg;
cmMakefile* mf=cmakemainGetMakefile(clientdata);
if (mf)
{
msg = mf->FormatListFileStack();
if (!msg.empty())
{
msg = "\n Called from: " + msg;
}
}
return msg;
}
static void cmakemainMessageCallback(const char* m, const char*, bool&,
void *clientdata)
{
std::cerr << m << cmakemainGetStack(clientdata) << std::endl << std::flush;
}
static void cmakemainProgressCallback(const char *m, float prog,
void* clientdata)
{
cmMakefile* mf = cmakemainGetMakefile(clientdata);
std::string dir;
if ((mf) && (strstr(m, "Configuring")==m) && (prog<0))
{
dir = " ";
dir += mf->GetCurrentSourceDirectory();
}
else if ((mf) && (strstr(m, "Generating")==m))
{
dir = " ";
dir += mf->GetCurrentBinaryDirectory();
}
if ((prog < 0) || (!dir.empty()))
{
std::cout << "-- " << m << dir << cmakemainGetStack(clientdata)<<std::endl;
}
std::cout.flush();
}
int main(int ac, char const* const* av)
{
cmsys::Encoding::CommandLineArguments args =
cmsys::Encoding::CommandLineArguments::Main(ac, av);
ac = args.argc();
av = args.argv();
cmSystemTools::EnableMSVCDebugHook();
cmSystemTools::FindCMakeResources(av[0]);
if(ac > 1)
{
if(strcmp(av[1], "--build") == 0)
{
return do_build(ac, av);
}
else if(strcmp(av[1], "-E") == 0)
{
return do_command(ac, av);
}
}
int ret = do_cmake(ac, av);
#ifdef CMAKE_BUILD_WITH_CMAKE
cmDynamicLoader::FlushCache();
#endif
return ret;
}
int do_cmake(int ac, char const* const* av)
{
if (cmSystemTools::GetCurrentWorkingDirectory().empty())
{
std::cerr << "Current working directory cannot be established."
<< std::endl;
return 1;
}
#ifdef CMAKE_BUILD_WITH_CMAKE
cmDocumentation doc;
doc.addCMakeStandardDocSections();
if(doc.CheckOptions(ac, av))
{
// Construct and print requested documentation.
cmake hcm;
hcm.SetHomeDirectory("");
hcm.SetHomeOutputDirectory("");
hcm.AddCMakePaths();
// the command line args are processed here so that you can do
// -DCMAKE_MODULE_PATH=/some/path and have this value accessible here
std::vector<std::string> args(av, av + ac);
hcm.SetCacheArgs(args);
std::vector<cmDocumentationEntry> generators;
hcm.GetGeneratorDocumentation(generators);
doc.SetName("cmake");
doc.SetSection("Name",cmDocumentationName);
doc.SetSection("Usage",cmDocumentationUsage);
if ( ac == 1 )
{
doc.AppendSection("Usage",cmDocumentationUsageNote);
}
doc.AppendSection("Generators",generators);
doc.PrependSection("Options",cmDocumentationOptions);
return doc.PrintRequestedDocumentation(std::cout)? 0:1;
}
#else
if ( ac == 1 )
{
std::cout <<
"Bootstrap CMake should not be used outside CMake build process."
<< std::endl;
return 0;
}
#endif
bool sysinfo = false;
bool list_cached = false;
bool list_all_cached = false;
bool list_help = false;
bool view_only = false;
cmake::WorkingMode workingMode = cmake::NORMAL_MODE;
std::vector<std::string> args;
for(int i =0; i < ac; ++i)
{
if(strcmp(av[i], "-i") == 0)
{
std::cerr <<
"The \"cmake -i\" wizard mode is no longer supported.\n"
"Use the -D option to set cache values on the command line.\n"
"Use cmake-gui or ccmake for an interactive dialog.\n";
return 1;
}
else if(strcmp(av[i], "--system-information") == 0)
{
sysinfo = true;
}
else if (strcmp(av[i], "-N") == 0)
{
view_only = true;
}
else if (strcmp(av[i], "-L") == 0)
{
list_cached = true;
}
else if (strcmp(av[i], "-LA") == 0)
{
list_all_cached = true;
}
else if (strcmp(av[i], "-LH") == 0)
{
list_cached = true;
list_help = true;
}
else if (strcmp(av[i], "-LAH") == 0)
{
list_all_cached = true;
list_help = true;
}
else if (cmHasLiteralPrefix(av[i], "-P"))
{
if ( i == ac -1 )
{
cmSystemTools::Error("No script specified for argument -P");
}
else
{
workingMode = cmake::SCRIPT_MODE;
args.push_back(av[i]);
i++;
args.push_back(av[i]);
}
}
else if (cmHasLiteralPrefix(av[i], "--find-package"))
{
workingMode = cmake::FIND_PACKAGE_MODE;
args.push_back(av[i]);
}
else
{
args.push_back(av[i]);
}
}
if (sysinfo)
{
cmake cm;
cm.SetHomeDirectory("");
cm.SetHomeOutputDirectory("");
int ret = cm.GetSystemInformation(args);
return ret;
}
cmake cm;
cm.SetHomeDirectory("");
cm.SetHomeOutputDirectory("");
cmSystemTools::SetMessageCallback(cmakemainMessageCallback, (void *)&cm);
cm.SetProgressCallback(cmakemainProgressCallback, (void *)&cm);
cm.SetWorkingMode(workingMode);
int res = cm.Run(args, view_only);
if ( list_cached || list_all_cached )
{
std::cout << "-- Cache values" << std::endl;
std::vector<std::string> keys = cm.GetState()->GetCacheEntryKeys();
for (std::vector<std::string>::const_iterator it = keys.begin();
it != keys.end(); ++it)
{
cmState::CacheEntryType t = cm.GetState()->GetCacheEntryType(*it);
if (t != cmState::INTERNAL && t != cmState::STATIC &&
t != cmState::UNINITIALIZED)
{
const char* advancedProp =
cm.GetState()->GetCacheEntryProperty(*it, "ADVANCED");
if ( list_all_cached || !advancedProp)
{
if ( list_help )
{
std::cout << "// "
<< cm.GetState()->GetCacheEntryProperty(*it,
"HELPSTRING") << std::endl;
}
std::cout << *it << ":" <<
cmState::CacheEntryTypeToString(t)
<< "=" << cm.GetState()->GetCacheEntryValue(*it)
<< std::endl;
if ( list_help )
{
std::cout << std::endl;
}
}
}
}
}
// Always return a non-negative value. Windows tools do not always
// interpret negative return values as errors.
if(res != 0)
{
return 1;
}
else
{
return 0;
}
}
//----------------------------------------------------------------------------
static int do_build(int ac, char const* const* av)
{
#ifndef CMAKE_BUILD_WITH_CMAKE
std::cerr << "This cmake does not support --build\n";
return -1;
#else
std::string target;
std::string config = "Debug";
std::string dir;
std::vector<std::string> nativeOptions;
bool clean = false;
enum Doing { DoingNone, DoingDir, DoingTarget, DoingConfig, DoingNative};
Doing doing = DoingDir;
for(int i=2; i < ac; ++i)
{
if(doing == DoingNative)
{
nativeOptions.push_back(av[i]);
}
else if(strcmp(av[i], "--target") == 0)
{
doing = DoingTarget;
}
else if(strcmp(av[i], "--config") == 0)
{
doing = DoingConfig;
}
else if(strcmp(av[i], "--clean-first") == 0)
{
clean = true;
doing = DoingNone;
}
else if(strcmp(av[i], "--use-stderr") == 0)
{
/* tolerate legacy option */
}
else if(strcmp(av[i], "--") == 0)
{
doing = DoingNative;
}
else
{
switch (doing)
{
case DoingDir:
dir = cmSystemTools::CollapseFullPath(av[i]);
doing = DoingNone;
break;
case DoingTarget:
target = av[i];
doing = DoingNone;
break;
case DoingConfig:
config = av[i];
doing = DoingNone;
break;
default:
std::cerr << "Unknown argument " << av[i] << std::endl;
dir = "";
break;
}
}
}
if(dir.empty())
{
std::cerr <<
"Usage: cmake --build <dir> [options] [-- [native-options]]\n"
"Options:\n"
CMAKE_BUILD_OPTIONS
;
return 1;
}
// Hack for vs6 that passes ".\Debug" as "$(IntDir)" value:
//
if (cmSystemTools::StringStartsWith(config.c_str(), ".\\"))
{
config = config.substr(2);
}
cmake cm;
return cm.Build(dir, target, config, nativeOptions, clean);
#endif
}