Source/cmSetDirectoryPropertiesCommand.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 cmSetDirectoryPropertiesCommand_h
  13 #define cmSetDirectoryPropertiesCommand_h
  14
  15 #include "cmCommand.h"
  16
  17 class cmSetDirectoryPropertiesCommand : public cmCommand
  18 {
  19 public:
  20   virtual cmCommand* Clone()
  21     {
  22       return new cmSetDirectoryPropertiesCommand;
  23     }
  24
  25   /**
  26    * This is called when the command is first encountered in
  27    * the input file.
  28    */
  29   virtual bool InitialPass(std::vector<std::string> const& args,
  30                            cmExecutionStatus &status);
  31
  32   /**
  33    * This determines if the command is invoked when in script mode.
  34    */
  35   virtual bool IsScriptable() const { return true; }
  36
  37   /**
  38    * The name of the command as specified in CMakeList.txt.
  39    */
  40   virtual const char* GetName() const { return "set_directory_properties";}
  41
  42   /**
  43    * Succinct documentation.
  44    */
  45   virtual const char* GetTerseDocumentation() const
  46     {
  47     return "Set a property of the directory.";
  48     }
  49
  50   /**
  51    * Static entry point for use by other commands
  52    */
  53   static bool RunCommand(cmMakefile *mf,
  54                          std::vector<std::string>::const_iterator ait,
  55                          std::vector<std::string>::const_iterator aitend,
  56                          std::string &errors);
  57
  58   /**
  59    * Longer documentation.
  60    */
  61   virtual const char* GetFullDocumentation() const
  62     {
  63       return
  64         "  set_directory_properties(PROPERTIES prop1 value1 prop2 value2)\n"
  65         "Set a property for the current directory and subdirectories. If the "
  66         "property is not found, CMake will report an error. The properties "
  67         "include: INCLUDE_DIRECTORIES, LINK_DIRECTORIES, "
  68         "INCLUDE_REGULAR_EXPRESSION, and ADDITIONAL_MAKE_CLEAN_FILES. "
  69         "ADDITIONAL_MAKE_CLEAN_FILES is a list of files that will be cleaned "
  70         "as a part of \"make clean\" stage.";
  71     }
  72
  73   cmTypeMacro(cmSetDirectoryPropertiesCommand, cmCommand);
  74 };
  75
  76
  77
  78 #endif