summaryrefslogtreecommitdiff
path: root/Source/cmFindFileCommand.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmFindFileCommand.h')
-rw-r--r--Source/cmFindFileCommand.h53
1 files changed, 53 insertions, 0 deletions
diff --git a/Source/cmFindFileCommand.h b/Source/cmFindFileCommand.h
new file mode 100644
index 000000000..7d349d33c
--- /dev/null
+++ b/Source/cmFindFileCommand.h
@@ -0,0 +1,53 @@
+/*============================================================================
+ 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 cmFindFileCommand_h
+#define cmFindFileCommand_h
+
+#include "cmFindPathCommand.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 cmFindPathCommand
+{
+public:
+ cmFindFileCommand();
+ /**
+ * This is a virtual constructor for the command.
+ */
+ virtual cmCommand* Clone()
+ {
+ return new cmFindFileCommand;
+ }
+ virtual const char* GetName() const { return "find_file";}
+
+ /**
+ * Succinct documentation.
+ */
+ virtual const char* GetTerseDocumentation() const
+ {
+ return "Find the full path to a file.";
+ }
+
+ cmTypeMacro(cmFindFileCommand, cmFindPathCommand);
+protected:
+ virtual void GenerateDocumentation();
+};
+
+
+
+#endif