Source/cmSetSourceFilesPropertiesCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmSetSourceFilesPropertiesCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-08-16 15:17:23 $
   7   Version:   $Revision: 1.4 $
   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 cmSetSourceFilesPropertiesCommand_h
  18 #define cmSetSourceFilesPropertiesCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 class cmSetSourceFilesPropertiesCommand : public cmCommand
  24 {
  25 public:
  26   virtual cmCommand* Clone()
  27     {
  28       return new cmSetSourceFilesPropertiesCommand;
  29     }
  30
  31   /**
  32    * This is called when the command is first encountered in
  33    * the input file.
  34    */
  35   virtual bool InitialPass(std::vector<std::string> const& args);
  36
  37   /**
  38    * The name of the command as specified in CMakeList.txt.
  39    */
  40   virtual const char* GetName() { return "SET_SOURCE_FILES_PROPERTIES";}
  41
  42   /**
  43    * Succinct documentation.
  44    */
  45   virtual const char* GetTerseDocumentation()
  46     {
  47     return "Set attributes for a specific list of files.";
  48     }
  49
  50   /**
  51    * Longer documentation.
  52    */
  53   virtual const char* GetFullDocumentation()
  54     {
  55       return
  56         "SET_SOURCE_FILES_PROPERTIES(file1 file2 .. filen PROPERTIES prop1 value1 prop2 value2 ... prop2 valuen)"
  57         "Set properties on a file. The syntax for the command is to list all the files you want "
  58         "to change, and then provide the values you want to set next. Common boolean properties ABSTRACT, WRAP_EXCLUDE, GENERATED and COMPILE_FLAGS. The first three are boolean properties (use a 1 or 0, TRUE or FALSE) while the COMPILE_FLAGS accepts any string. You can make up your own properties as well.";
  59     }
  60
  61   cmTypeMacro(cmSetSourceFilesPropertiesCommand, cmCommand);
  62 };
  63
  64
  65
  66 #endif