Source/cmSetDirectoryPropertiesCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmSetDirectoryPropertiesCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-01-23 15:27:59 $
   7   Version:   $Revision: 1.7 $
   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 cmSetDirectoryPropertiesCommand_h
  18 #define cmSetDirectoryPropertiesCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 class cmSetDirectoryPropertiesCommand : public cmCommand
  23 {
  24 public:
  25   virtual cmCommand* Clone()
  26     {
  27       return new cmSetDirectoryPropertiesCommand;
  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 "set_directory_properties";}
  46
  47   /**
  48    * Succinct documentation.
  49    */
  50   virtual const char* GetTerseDocumentation()
  51     {
  52     return "Set a property of the directory.";
  53     }
  54
  55   /**
  56    * Static entry point for use by other commands
  57    */
  58   static bool RunCommand(cmMakefile *mf,
  59                          std::vector<std::string>::const_iterator ait,
  60                          std::vector<std::string>::const_iterator aitend,
  61                          std::string &errors);
  62
  63   /**
  64    * Longer documentation.
  65    */
  66   virtual const char* GetFullDocumentation()
  67     {
  68       return
  69         "  set_directory_properties(PROPERTIES prop1 value1 prop2 value2)\n"
  70         "Set a property for the current directory and subdirectories. If the "
  71         "property is not found, CMake will report an error. The properties "
  72         "include: INCLUDE_DIRECTORIES, LINK_DIRECTORIES, "
  73         "INCLUDE_REGULAR_EXPRESSION, and ADDITIONAL_MAKE_CLEAN_FILES.\n"
  74         "ADDITIONAL_MAKE_CLEAN_FILES is a list of files that will be cleaned "
  75         "as a part of \"make clean\" stage.";
  76     }
  77
  78   cmTypeMacro(cmSetDirectoryPropertiesCommand, cmCommand);
  79 };
  80
  81
  82
  83 #endif