Source/cmSourceFilesRemoveCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmSourceFilesRemoveCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-01-21 20:30:34 $
   7   Version:   $Revision: 1.3 $
   8
   9   Copyright (c) 2002 Insight Consortium. All rights reserved.
  10   See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm 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 cmSourceFilesRemoveCommand_h
  18 #define cmSourceFilesRemoveCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 /** \class cmSourceFilesRemoveCommand
  24  * \brief Remove source files from the build.
  25  *
  26  * cmSourceFilesRemoveCommand removes source files from the build.
  27  * The sourcefiles will be removed from the current library (if defined by the
  28  * LIBRARY(library) command. This command is primarily designed to allow
  29  * customization of builds where (for example) a certain source file is
  30  * failing to compile and the user wishes to edit it out conditionally.
  31  *
  32  * \sa cmSourceFilesRequireCommand
  33  */
  34 class cmSourceFilesRemoveCommand : public cmCommand
  35 {
  36 public:
  37   /**
  38    * This is a virtual constructor for the command.
  39    */
  40   virtual cmCommand* Clone()
  41     {
  42     return new cmSourceFilesRemoveCommand;
  43     }
  44
  45   /**
  46    * This is called when the command is first encountered in
  47    * the CMakeLists.txt file.
  48    */
  49   virtual bool InitialPass(std::vector<std::string> const& args);
  50
  51   /**
  52    * The name of the command as specified in CMakeList.txt.
  53    */
  54   virtual const char* GetName() { return "SOURCE_FILES_REMOVE";}
  55
  56   /**
  57    * Succinct documentation.
  58    */
  59   virtual const char* GetTerseDocumentation()
  60     {
  61     return "Remove a list of source files - associated with NAME.";
  62     }
  63
  64   /**
  65    * Remove (conditionally if desired) a list of source files from a group.
  66    * This is most likely when the user has problems compiling certain files
  67    * in a library and wants to remove them (perhaps in an optional INCLUDE)
  68    */
  69   virtual const char* GetFullDocumentation()
  70     {
  71     return
  72       "SOURCE_FILES_REMOVE(NAME file1 file2 ...)";
  73     }
  74
  75   cmTypeMacro(cmSourceFilesRemoveCommand, cmCommand);
  76 };
  77
  78
  79
  80 #endif