cmAddExecutableCommand.h 4.34 KB
Newer Older
1
2
/*=========================================================================

3
  Program:   CMake - Cross-Platform Makefile Generator
4
5
6
7
8
  Module:    $RCSfile$
  Language:  C++
  Date:      $Date$
  Version:   $Revision$

9
10
  Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
11

Andy Cedilnik's avatar
Andy Cedilnik committed
12
13
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
Will Schroeder's avatar
Will Schroeder committed
14
     PURPOSE.  See the above copyright notices for more information.
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

=========================================================================*/
#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.
   */
Andy Cedilnik's avatar
Andy Cedilnik committed
34
  virtual cmCommand* Clone()
35
36
37
38
39
40
41
42
    {
    return new cmAddExecutableCommand;
    }

  /**
   * This is called when the command is first encountered in
   * the CMakeLists.txt file.
   */
43
44
  virtual bool InitialPass(std::vector<std::string> const& args,
                           cmExecutionStatus &status);
45
46
47
48

  /**
   * The name of the command as specified in CMakeList.txt.
   */
49
  virtual const char* GetName() { return "add_executable";}
50
51
52
53

  /**
   * Succinct documentation.
   */
Andy Cedilnik's avatar
Andy Cedilnik committed
54
  virtual const char* GetTerseDocumentation()
55
    {
Andy Cedilnik's avatar
Andy Cedilnik committed
56
57
    return
      "Add an executable to the project using the specified source files.";
58
    }
Andy Cedilnik's avatar
Andy Cedilnik committed
59

60
61
62
63
64
65
  /**
   * More documentation.
   */
  virtual const char* GetFullDocumentation()
    {
    return
66
67
      "  add_executable(<name> [WIN32] [MACOSX_BUNDLE]\n"
      "                 [EXCLUDE_FROM_ALL]\n"
68
      "                 source1 source2 ... sourceN)\n"
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
      "Adds an executable target called <name> to be built from the "
      "source files listed in the command invocation.  "
      "The <name> corresponds to the logical target name and must be "
      "globally unique within a project.  "
      "The actual file name of the executable built is constructed based on "
      "conventions of the native platform "
      "(such as <name>.exe or just <name>).  "
      "\n"
      "By default the executable file will be created in the build tree "
      "directory corresponding to the source tree directory in which "
      "the command was invoked.  "
      "See documentation of the RUNTIME_OUTPUT_DIRECTORY "
      "target property to change this location.  "
      "See documentation of the OUTPUT_NAME target property to change "
      "the <name> part of the final file name.  "
      "\n"
      "If WIN32 is given the property WIN32_EXECUTABLE will be set on the "
      "target created.  "
      "See documentation of that target property for details."
      "\n"
      "If MACOSX_BUNDLE is given the corresponding property will be "
      "set on the created target.  "
      "See documentation of the MACOSX_BUNDLE target property for details."
      "\n"
      "If EXCLUDE_FROM_ALL is given the corresponding property will be "
      "set on the created target.  "
      "See documentation of the EXCLUDE_FROM_ALL target property for "
      "details."
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
      "\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."
115
      ;
116
    }
Andy Cedilnik's avatar
Andy Cedilnik committed
117

118
119
120
121
122
  cmTypeMacro(cmAddExecutableCommand, cmCommand);
};


#endif