Source/cmGetSourceFilePropertyCommand.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 cmGetSourceFilePropertyCommand_h
  13 #define cmGetSourceFilePropertyCommand_h
  14
  15 #include "cmCommand.h"
  16
  17 class cmGetSourceFilePropertyCommand : public cmCommand
  18 {
  19 public:
  20   virtual cmCommand* Clone()
  21     {
  22       return new cmGetSourceFilePropertyCommand;
  23     }
  24
  25   /**
  26    * This is called when the command is first encountered in
  27    * the input file.
  28    */
  29   virtual bool InitialPass(std::vector<std::string> const& args,
  30                            cmExecutionStatus &status);
  31
  32   /**
  33    * The name of the command as specified in CMakeList.txt.
  34    */
  35   virtual const char* GetName() const { return "get_source_file_property";}
  36
  37   /**
  38    * Succinct documentation.
  39    */
  40   virtual const char* GetTerseDocumentation() const
  41     {
  42     return "Get a property for a source file.";
  43     }
  44
  45   /**
  46    * Longer documentation.
  47    */
  48   virtual const char* GetFullDocumentation() const
  49     {
  50       return
  51         "  get_source_file_property(VAR file property)\n"
  52         "Get a property from a source file.  The value of the property is "
  53         "stored in the variable VAR.  If the property is not found, VAR "
  54         "will be set to \"NOTFOUND\". Use set_source_files_properties to set "
  55         "property values.  Source file properties usually control how the "
  56         "file is built. One property that is always there is LOCATION"
  57         "\n"
  58         "See also the more general get_property() command.";
  59     }
  60
  61   cmTypeMacro(cmGetSourceFilePropertyCommand, cmCommand);
  62 };
  63
  64
  65
  66 #endif