Source/cmRemoveDefinitionsCommand.h

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