CMake/Source/cmAddExecutableCommand.h

119 lines
4.3 KiB
C
Raw Normal View History

/*=========================================================================
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.
2006-03-10 21:06:26 +03:00
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
2002-01-21 23:30:43 +03:00
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef cmExecutablesCommand_h
#define cmExecutablesCommand_h
#include "cmCommand.h"
/** \class cmExecutablesCommand
* \brief Defines a list of executables to build.
*
* cmExecutablesCommand defines a list of executable (i.e., test)
* programs to create.
*/
class cmAddExecutableCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
2006-03-10 21:06:26 +03:00
virtual cmCommand* Clone()
{
return new cmAddExecutableCommand;
}
/**
* 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 "add_executable";}
/**
* Succinct documentation.
*/
2006-03-10 21:06:26 +03:00
virtual const char* GetTerseDocumentation()
{
2006-03-10 21:06:26 +03:00
return
"Add an executable to the project using the specified source files.";
}
2006-03-10 21:06:26 +03:00
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" add_executable(exename [WIN32] [MACOSX_BUNDLE] [EXCLUDE_FROM_ALL]\n"
" source1 source2 ... sourceN)\n"
"This command adds an executable target to the current directory. "
2002-12-30 15:47:03 +03:00
"The executable will be built from the list of source files "
2004-04-09 01:13:42 +04:00
"specified.\n"
2004-04-23 18:03:01 +04:00
"After specifying the executable name, WIN32 and/or MACOSX_BUNDLE can "
2004-04-09 01:13:42 +04:00
"be specified. WIN32 indicates that the executable (when compiled on "
2006-03-10 21:06:26 +03:00
"windows) is a windows app (using WinMain) not a console app "
"(using main). The variable CMAKE_MFC_FLAG be used if the windows app "
"uses MFC. This variable can be set to the following values:\n"
" 0: Use Standard Windows Libraries\n"
2008-01-10 06:09:19 +03:00
" 1: Use MFC in a Static Library\n"
" 2: Use MFC in a Shared DLL\n"
2004-04-23 18:03:01 +04:00
"MACOSX_BUNDLE indicates that when build on Mac OSX, executable should "
2006-03-10 21:06:26 +03:00
"be in the bundle form. The MACOSX_BUNDLE also allows several "
"variables to be specified:\n"
2004-04-09 01:13:42 +04:00
" MACOSX_BUNDLE_INFO_STRING\n"
" MACOSX_BUNDLE_ICON_FILE\n"
" MACOSX_BUNDLE_GUI_IDENTIFIER\n"
" MACOSX_BUNDLE_LONG_VERSION_STRING\n"
" MACOSX_BUNDLE_BUNDLE_NAME\n"
" MACOSX_BUNDLE_SHORT_VERSION_STRING\n"
" MACOSX_BUNDLE_BUNDLE_VERSION\n"
" MACOSX_BUNDLE_COPYRIGHT\n"
"If EXCLUDE_FROM_ALL is given the target will not be built by default. "
"It will be built only if the user explicitly builds the target or "
"another target that requires the target depends on it."
"\n"
"The add_executable command can also create IMPORTED executable "
"targets using this signature:\n"
" add_executable(<name> IMPORTED)\n"
"An IMPORTED executable target references an executable file located "
"outside the project. "
"No rules are generated to build it. "
"The target name has scope in the directory in which it is created "
"and below. "
"It may be referenced like any target built within the project. "
"IMPORTED executables are useful for convenient reference from "
"commands like add_custom_command. "
"Details about the imported executable are specified by setting "
"properties whose names begin in \"IMPORTED_\". "
"The most important such property is IMPORTED_LOCATION "
"(and its per-configuration version IMPORTED_LOCATION_<CONFIG>) "
"which specifies the location of the main executable file on disk. "
"See documentation of the IMPORTED_* properties for more information."
2004-04-09 01:13:42 +04:00
;
}
2006-03-10 21:06:26 +03:00
cmTypeMacro(cmAddExecutableCommand, cmCommand);
};
#endif