CMakeLua/Source/cmGetDirectoryPropertyCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmGetDirectoryPropertyCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008/01/23 15:27:59 $
   7   Version:   $Revision: 1.8 $
   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 cmGetDirectoryPropertyCommand_h
  18 #define cmGetDirectoryPropertyCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 class cmGetDirectoryPropertyCommand : public cmCommand
  23 {
  24 public:
  25   virtual cmCommand* Clone()
  26     {
  27       return new cmGetDirectoryPropertyCommand;
  28     }
  29
  30   /**
  31    * This is called when the command is first encountered in
  32    * the input file.
  33    */
  34   virtual bool InitialPass(std::vector<std::string> const& args,
  35                            cmExecutionStatus &status);
  36
  37   /**
  38    * This determines if the command is invoked when in script mode.
  39    */
  40   virtual bool IsScriptable() { return true; }
  41
  42   /**
  43    * The name of the command as specified in CMakeList.txt.
  44    */
  45   virtual const char* GetName() { return "get_directory_property";}
  46
  47   /**
  48    * Succinct documentation.
  49    */
  50   virtual const char* GetTerseDocumentation()
  51     {
  52     return "Get a property of the directory.";
  53     }
  54
  55   /**
  56    * Longer documentation.
  57    */
  58   virtual const char* GetFullDocumentation()
  59     {
  60       return
  61         "  get_directory_property(VAR [DIRECTORY dir] property)\n"
  62         "Get a property from the Directory.  The value of the property is "
  63         "stored in the variable VAR. If the property is not found, "
  64         "CMake will report an error. The properties include: VARIABLES, "
  65         "CACHE_VARIABLES, COMMANDS, MACROS, INCLUDE_DIRECTORIES, "
  66         "LINK_DIRECTORIES, DEFINITIONS, INCLUDE_REGULAR_EXPRESSION, "
  67         "LISTFILE_STACK, PARENT_DIRECTORY, and "
  68         "DEFINITION varname.  If the DIRECTORY argument is provided then "
  69         "the property of the provided directory will be retrieved "
  70         "instead of the current directory. You can only get properties "
  71         "of a directory during or after it has been traversed by cmake.";
  72     }
  73
  74   cmTypeMacro(cmGetDirectoryPropertyCommand, cmCommand);
  75 };
  76
  77
  78
  79 #endif