105 lines
3.1 KiB
C++
105 lines
3.1 KiB
C++
/*=========================================================================
|
|
|
|
Program: CMake - Cross-Platform Makefile Generator
|
|
Module: $RCSfile$
|
|
Language: C++
|
|
Date: $Date$
|
|
Version: $Revision$
|
|
|
|
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
|
|
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even
|
|
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
PURPOSE. See the above copyright notices for more information.
|
|
|
|
=========================================================================*/
|
|
#ifndef cmExportCommand_h
|
|
#define cmExportCommand_h
|
|
|
|
#include "cmCommand.h"
|
|
|
|
class cmExportBuildFileGenerator;
|
|
|
|
/** \class cmExportLibraryDependenciesCommand
|
|
* \brief Add a test to the lists of tests to run.
|
|
*
|
|
* cmExportLibraryDependenciesCommand adds a test to the list of tests to run
|
|
*
|
|
*/
|
|
class cmExportCommand : public cmCommand
|
|
{
|
|
public:
|
|
cmExportCommand();
|
|
/**
|
|
* This is a virtual constructor for the command.
|
|
*/
|
|
virtual cmCommand* Clone()
|
|
{
|
|
return new cmExportCommand;
|
|
}
|
|
|
|
/**
|
|
* This is called when the command is first encountered in
|
|
* the CMakeLists.txt file.
|
|
*/
|
|
virtual bool InitialPass(std::vector<std::string> const& args,
|
|
cmExecutionStatus &status);
|
|
|
|
/**
|
|
* The name of the command as specified in CMakeList.txt.
|
|
*/
|
|
virtual const char* GetName() { return "export";}
|
|
|
|
/**
|
|
* Succinct documentation.
|
|
*/
|
|
virtual const char* GetTerseDocumentation()
|
|
{
|
|
return
|
|
"Export targets from the build tree for use by outside projects.";
|
|
}
|
|
|
|
/**
|
|
* More documentation.
|
|
*/
|
|
virtual const char* GetFullDocumentation()
|
|
{
|
|
return
|
|
" export(TARGETS [target1 [target2 [...]]] [NAMESPACE <namespace>]\n"
|
|
" [APPEND] FILE <filename>)\n"
|
|
"Create a file <filename> that may be included by outside projects to "
|
|
"import targets from the current project's build tree. "
|
|
"This is useful during cross-compiling to build utility executables "
|
|
"that can run on the host platform in one project and then import "
|
|
"them into another project being compiled for the target platform. "
|
|
"If the NAMESPACE option is given the <namespace> string will be "
|
|
"prepended to all target names written to the file. "
|
|
"If the APPEND option is given the generated code will be appended "
|
|
"to the file instead of overwriting it. "
|
|
"If a library target is included in the export but "
|
|
"a target to which it links is not included the behavior is "
|
|
"unspecified."
|
|
"\n"
|
|
"The file created by this command is specific to the build tree and "
|
|
"should never be installed. "
|
|
"See the install(EXPORT) command to export targets from an "
|
|
"installation tree.";
|
|
}
|
|
|
|
cmTypeMacro(cmExportCommand, cmCommand);
|
|
|
|
private:
|
|
cmCommandArgumentGroup ArgumentGroup;
|
|
cmCAStringVector Targets;
|
|
cmCAEnabler Append;
|
|
cmCAString Namespace;
|
|
cmCAString Filename;
|
|
|
|
friend class cmExportBuildFileGenerator;
|
|
std::string ErrorMessage;
|
|
};
|
|
|
|
|
|
#endif
|