CMakeLua/Source/cmGetDirectoryPropertyCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmGetDirectoryPropertyCommand.h,v $
   5   Language:  C++
   6 <<<<<<< cmGetDirectoryPropertyCommand.h
   7   Date:      $Date: 2008/01/23 15:27:59 $
   8   Version:   $Revision: 1.8 $
   9 =======
  10   Date:      $Date: 2008-06-26 14:58:44 $
  11   Version:   $Revision: 1.9 $
  12 >>>>>>> 1.9
  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 cmGetDirectoryPropertyCommand_h
  23 #define cmGetDirectoryPropertyCommand_h
  24
  25 #include "cmCommand.h"
  26
  27 class cmGetDirectoryPropertyCommand : public cmCommand
  28 {
  29 public:
  30   virtual cmCommand* Clone()
  31     {
  32       return new cmGetDirectoryPropertyCommand;
  33     }
  34
  35   /**
  36    * This is called when the command is first encountered in
  37    * the input file.
  38    */
  39   virtual bool InitialPass(std::vector<std::string> const& args,
  40                            cmExecutionStatus &status);
  41
  42   /**
  43    * This determines if the command is invoked when in script mode.
  44    */
  45   virtual bool IsScriptable() { return true; }
  46
  47   /**
  48    * The name of the command as specified in CMakeList.txt.
  49    */
  50   virtual const char* GetName() { return "get_directory_property";}
  51
  52   /**
  53    * Succinct documentation.
  54    */
  55   virtual const char* GetTerseDocumentation()
  56     {
  57     return "Get a property of DIRECTORY scope.";
  58     }
  59
  60   /**
  61    * Longer documentation.
  62    */
  63   virtual const char* GetFullDocumentation()
  64     {
  65       return
  66         "  get_directory_property(<variable> [DIRECTORY <dir>] <prop-name>)\n"
  67         "Store a property of directory scope in the named variable.  "
  68         "If the property is not defined the empty-string is returned.  "
  69         "The DIRECTORY argument specifies another directory from which "
  70         "to retrieve the property value.  "
  71         "The specified directory must have already been traversed by "
  72         "CMake."
  73         "\n"
  74         "  get_directory_property(<variable> [DIRECTORY <dir>]\n"
  75         "                         DEFINITION <var-name>)\n"
  76         "Get a variable definition from a directory.  "
  77         "This form is useful to get a variable definition from another "
  78         "directory."
  79         ;
  80     }
  81
  82   cmTypeMacro(cmGetDirectoryPropertyCommand, cmCommand);
  83 };
  84
  85
  86
  87 #endif