Source/cmLoadCacheCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmLoadCacheCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-01-21 20:30:28 $
   7   Version:   $Revision: 1.6 $
   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 cmLoadCacheCommand_h
  18 #define cmLoadCacheCommand_h
  19
  20 /** \class cmLoadCacheCommand
  21  * \brief load a cache file
  22  *
  23  * cmLoadCacheCommand loads the non internal values of a cache file
  24  */
  25 class cmLoadCacheCommand : public cmCommand
  26 {
  27 public:
  28   /**
  29    * This is a virtual constructor for the command.
  30    */
  31   virtual cmCommand* Clone()
  32     {
  33     return new cmLoadCacheCommand;
  34     }
  35
  36   /**
  37    * This is called when the command is first encountered in
  38    * the CMakeLists.txt file.
  39    */
  40   virtual bool InitialPass(std::vector<std::string> const& args);
  41
  42   /**
  43    * This determines if the command gets propagated down
  44    * to makefiles located in subdirectories.
  45    */
  46   virtual bool IsInherited() {return true;}
  47
  48   /**
  49    * The name of the command as specified in CMakeList.txt.
  50    */
  51   virtual const char* GetName() { return "LOAD_CACHE";}
  52
  53   /**
  54    * Succinct documentation.
  55    */
  56   virtual const char* GetTerseDocumentation()
  57     {
  58     return "load in the values from another cache.";
  59     }
  60
  61   /**
  62    * More documentation.
  63    */
  64   virtual const char* GetFullDocumentation()
  65     {
  66     return
  67       "LOAD_CACHE(pathToCacheFile [EXCLUDE entry1...] [INCLUDE_INTERNALS entry1...])\n"
  68       "Load in the values from another cache. This is useful for a project "
  69       "that depends on another project built in a different tree."
  70       "EXCLUDE option can be used to provide a list of entries to be excluded."
  71       "INCLUDE_INTERNALS can be used to provide a list of internal entries"
  72       "to be included. Normally, no internal entries are brougt in.";
  73     }
  74
  75   cmTypeMacro(cmLoadCacheCommand, cmCommand);
  76 };
  77
  78
  79 #endif