CMakeLua/Source/cmFindPathCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmFindPathCommand.h,v $
   5   Language:  C++
   6 <<<<<<< cmFindPathCommand.h
   7   Date:      $Date: 2008/01/23 15:27:59 $
   8   Version:   $Revision: 1.18 $
   9 =======
  10   Date:      $Date: 2008-06-09 15:58:29 $
  11   Version:   $Revision: 1.19 $
  12 >>>>>>> 1.19
  13
  14   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  15   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  16
  17      This software is distributed WITHOUT ANY WARRANTY; without even
  18      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  19      PURPOSE.  See the above copyright notices for more information.
  20
  21 =========================================================================*/
  22 #ifndef cmFindPathCommand_h
  23 #define cmFindPathCommand_h
  24
  25 #include "cmFindBase.h"
  26
  27
  28 /** \class cmFindPathCommand
  29  * \brief Define a command to search for a library.
  30  *
  31  * cmFindPathCommand is used to define a CMake variable
  32  * that specifies a library. The command searches for a given
  33  * file in a list of directories.
  34  */
  35 class cmFindPathCommand : public cmFindBase
  36 {
  37 public:
  38   cmFindPathCommand();
  39   /**
  40    * This is a virtual constructor for the command.
  41    */
  42   virtual cmCommand* Clone()
  43     {
  44     return new cmFindPathCommand;
  45     }
  46
  47   /**
  48    * This is called when the command is first encountered in
  49    * the CMakeLists.txt file.
  50    */
  51   virtual bool InitialPass(std::vector<std::string> const& args,
  52                            cmExecutionStatus &status);
  53
  54   /**
  55    * This determines if the command is invoked when in script mode.
  56    */
  57   virtual bool IsScriptable() { return true; }
  58
  59   /**
  60    * The name of the command as specified in CMakeList.txt.
  61    */
  62   virtual const char* GetName() {return "find_path";}
  63
  64   /**
  65    * Succinct documentation.
  66    */
  67   virtual const char* GetTerseDocumentation()
  68     {
  69     return "Find the directory containing a file.";
  70     }
  71
  72   virtual const char* GetFullDocumentation();
  73   cmTypeMacro(cmFindPathCommand, cmFindBase);
  74   bool IncludeFileInPath;
  75   bool ExtraDocAdded;
  76 private:
  77   std::string FindHeaderInFramework(std::string const& file,
  78                                     std::string const& dir);
  79   std::string FindHeader();
  80   std::string FindNormalHeader();
  81   std::string FindFrameworkHeader();
  82 };
  83
  84
  85
  86 #endif