Source/cmRemoveDefinitionsCommand.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 cmRemoveDefinitionsCommand_h
  13 #define cmRemoveDefinitionsCommand_h
  14
  15 #include "cmCommand.h"
  16
  17 /** \class cmRemoveDefinitionsCommand
  18  * \brief Specify a list of compiler defines
  19  *
  20  * cmRemoveDefinitionsCommand specifies a list of compiler defines.
  21  * These defines will
  22  * be removed from the compile command.
  23  */
  24 class cmRemoveDefinitionsCommand : public cmCommand
  25 {
  26 public:
  27   /**
  28    * This is a virtual constructor for the command.
  29    */
  30   virtual cmCommand* Clone()
  31     {
  32     return new cmRemoveDefinitionsCommand;
  33     }
  34
  35   /**
  36    * This is called when the command is first encountered in
  37    * the CMakeLists.txt file.
  38    */
  39   virtual bool InitialPass(std::vector<std::string> const& args,
  40                            cmExecutionStatus &status);
  41
  42   /**
  43    * The name of the command as specified in CMakeList.txt.
  44    */
  45   virtual const char* GetName() const {return "remove_definitions";}
  46
  47   /**
  48    * Succinct documentation.
  49    */
  50   virtual const char* GetTerseDocumentation() const
  51     {
  52     return "Removes -D define flags added by add_definitions.";
  53     }
  54
  55   /**
  56    * More documentation.
  57    */
  58   virtual const char* GetFullDocumentation() const
  59     {
  60     return
  61       "  remove_definitions(-DFOO -DBAR ...)\n"
  62       "Removes flags (added by add_definitions) from the compiler command "
  63       "line for sources in the current directory and below.";
  64     }
  65
  66   cmTypeMacro(cmRemoveDefinitionsCommand, cmCommand);
  67 };
  68
  69
  70
  71 #endif