Source/cmFindFileCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmFindFileCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2007-10-10 15:47:43 $
   7   Version:   $Revision: 1.20 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #ifndef cmFindFileCommand_h
  18 #define cmFindFileCommand_h
  19
  20 #include "cmFindPathCommand.h"
  21
  22 /** \class cmFindFileCommand
  23  * \brief Define a command to search for an executable program.
  24  *
  25  * cmFindFileCommand is used to define a CMake variable
  26  * that specifies an executable program. The command searches
  27  * in the current path (e.g., PATH environment variable) for
  28  * an executable that matches one of the supplied names.
  29  */
  30 class cmFindFileCommand : public cmFindPathCommand
  31 {
  32 public:
  33   cmFindFileCommand();
  34   /**
  35    * This is a virtual constructor for the command.
  36    */
  37   virtual cmCommand* Clone()
  38     {
  39     return new cmFindFileCommand;
  40     }
  41   virtual const char* GetName() { return "find_file";}
  42
  43   /**
  44    * Succinct documentation.
  45    */
  46   virtual const char* GetTerseDocumentation()
  47     {
  48     return "Find the full path to a file.";
  49     }
  50
  51   cmTypeMacro(cmFindFileCommand, cmFindPathCommand);
  52 };
  53
  54
  55
  56 #endif