summaryrefslogtreecommitdiff
path: root/Source/cmFindFileCommand.h
diff options
context:
space:
mode:
authorKen Martin <ken.martin@kitware.com>2001-02-26 17:13:30 -0500
committerKen Martin <ken.martin@kitware.com>2001-02-26 17:13:30 -0500
commit3acd5951ba5c6e978a6da486825e8ad61320f4eb (patch)
tree9ca6597eedd5040ce2900efa74c51d5017ba7a96 /Source/cmFindFileCommand.h
parente6713c5604ae1b28cb85a9cae262b33d25914862 (diff)
downloadcmake-3acd5951ba5c6e978a6da486825e8ad61320f4eb.tar.gz
new command
Diffstat (limited to 'Source/cmFindFileCommand.h')
-rw-r--r--Source/cmFindFileCommand.h80
1 files changed, 80 insertions, 0 deletions
diff --git a/Source/cmFindFileCommand.h b/Source/cmFindFileCommand.h
new file mode 100644
index 0000000000..eaac19468a
--- /dev/null
+++ b/Source/cmFindFileCommand.h
@@ -0,0 +1,80 @@
+/*=========================================================================
+
+ Program: Insight Segmentation & Registration Toolkit
+ Module: $RCSfile$
+ Language: C++
+ Date: $Date$
+ Version: $Revision$
+
+
+ Copyright (c) 2000 National Library of Medicine
+ All rights reserved.
+
+ See COPYRIGHT.txt for copyright details.
+
+=========================================================================*/
+#ifndef cmFindFileCommand_h
+#define cmFindFileCommand_h
+
+#include "cmStandardIncludes.h"
+#include "cmCommand.h"
+
+/** \class cmFindFileCommand
+ * \brief Define a command to search for an executable program.
+ *
+ * cmFindFileCommand is used to define a CMake variable
+ * that specifies an executable program. The command searches
+ * in the current path (e.g., PATH environment variable) for
+ * an executable that matches one of the supplied names.
+ */
+class cmFindFileCommand : public cmCommand
+{
+public:
+ /**
+ * This is a virtual constructor for the command.
+ */
+ virtual cmCommand* Clone()
+ {
+ return new cmFindFileCommand;
+ }
+
+ /**
+ * This is called when the command is first encountered in
+ * the CMakeLists.txt file.
+ */
+ virtual bool Invoke(std::vector<std::string>& args);
+
+ /**
+ * This determines if the command gets propagated down
+ * to makefiles located in subdirectories.
+ */
+ virtual bool IsInherited() { return true; }
+
+ /**
+ * The name of the command as specified in CMakeList.txt.
+ */
+ virtual const char* GetName() { return "FIND_FILE";}
+
+ /**
+ * Succinct documentation.
+ */
+ virtual const char* GetTerseDocumentation()
+ {
+ return "Find a file.";
+ }
+
+ /**
+ * More documentation.
+ */
+ virtual const char* GetFullDocumentation()
+ {
+ return
+ "FIND_FILE(NAME file extrapath extrapath ...)";
+ }
+
+ cmTypeMacro(cmFindFileCommand, cmCommand);
+};
+
+
+
+#endif