Source/cmFindFileCommand.h

   1 /*============================================================================
   2   CMake - Cross Platform Makefile Generator
   3   Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
   4
   5   Distributed under the OSI-approved BSD License (the "License");
   6   see accompanying file Copyright.txt for details.
   7
   8   This software is distributed WITHOUT ANY WARRANTY; without even the
   9   implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10   See the License for more information.
  11 ============================================================================*/
  12 #ifndef cmFindFileCommand_h
  13 #define cmFindFileCommand_h
  14
  15 #include "cmFindPathCommand.h"
  16
  17 /** \class cmFindFileCommand
  18  * \brief Define a command to search for an executable program.
  19  *
  20  * cmFindFileCommand is used to define a CMake variable
  21  * that specifies an executable program. The command searches
  22  * in the current path (e.g., PATH environment variable) for
  23  * an executable that matches one of the supplied names.
  24  */
  25 class cmFindFileCommand : public cmFindPathCommand
  26 {
  27 public:
  28   cmFindFileCommand();
  29   /**
  30    * This is a virtual constructor for the command.
  31    */
  32   virtual cmCommand* Clone()
  33     {
  34     return new cmFindFileCommand;
  35     }
  36   virtual const char* GetName() const { return "find_file";}
  37
  38   /**
  39    * Succinct documentation.
  40    */
  41   virtual const char* GetTerseDocumentation() const
  42     {
  43     return "Find the full path to a file.";
  44     }
  45
  46   cmTypeMacro(cmFindFileCommand, cmFindPathCommand);
  47 protected:
  48   virtual void GenerateDocumentation();
  49 };
  50
  51
  52
  53 #endif