Source/cmGetSourceFilePropertyCommand.h

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