summaryrefslogtreecommitdiff
path: root/Source/cmUtilitySourceCommand.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmUtilitySourceCommand.h')
-rw-r--r--Source/cmUtilitySourceCommand.h90
1 files changed, 90 insertions, 0 deletions
diff --git a/Source/cmUtilitySourceCommand.h b/Source/cmUtilitySourceCommand.h
new file mode 100644
index 000000000..32afddadc
--- /dev/null
+++ b/Source/cmUtilitySourceCommand.h
@@ -0,0 +1,90 @@
+/*============================================================================
+ 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.
+============================================================================*/
+#ifndef cmUtilitySourceCommand_h
+#define cmUtilitySourceCommand_h
+
+#include "cmCommand.h"
+
+/** \class cmUtilitySourceCommand
+ * \brief A command to setup a cache entry with the location of a third-party
+ * utility's source.
+ *
+ * cmUtilitySourceCommand is used when a third-party utility's source is
+ * included in the project's source tree. It specifies the location of
+ * the executable's source, and any files that may be needed to confirm the
+ * identity of the source.
+ */
+class cmUtilitySourceCommand : public cmCommand
+{
+public:
+ /**
+ * This is a virtual constructor for the command.
+ */
+ virtual cmCommand* Clone()
+ {
+ return new cmUtilitySourceCommand;
+ }
+
+ /**
+ * 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() const { return "utility_source";}
+
+ /**
+ * Succinct documentation.
+ */
+ virtual const char* GetTerseDocumentation() const
+ {
+ return "Specify the source tree of a third-party utility.";
+ }
+
+ /**
+ * More documentation.
+ */
+ virtual const char* GetFullDocumentation() const
+ {
+ return
+ " utility_source(cache_entry executable_name\n"
+ " path_to_source [file1 file2 ...])\n"
+ "When a third-party utility's source is included in the distribution, "
+ "this command specifies its location and name. The cache entry will "
+ "not be set unless the path_to_source and all listed files exist. It "
+ "is assumed that the source tree of the utility will have been built "
+ "before it is needed.\n"
+ "When cross compiling CMake will print a warning if a utility_source() "
+ "command is executed, because in many cases it is used to build an "
+ "executable which is executed later on. This doesn't work when "
+ "cross compiling, since the executable can run only on their target "
+ "platform. So in this case the cache entry has to be adjusted manually "
+ "so it points to an executable which is runnable on the build host.";
+ }
+
+ /** This command is kept for compatibility with older CMake versions. */
+ virtual bool IsDiscouraged() const
+ {
+ return true;
+ }
+
+
+ cmTypeMacro(cmUtilitySourceCommand, cmCommand);
+};
+
+
+
+#endif