Source/cmGetFilenameComponentCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmGetFilenameComponentCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-01-21 20:30:25 $
   7   Version:   $Revision: 1.5 $
   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 cmGetFilenameComponentCommand_h
  18 #define cmGetFilenameComponentCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmGetFilenameComponentCommand
  23  * \brief Get a specific component of a filename.
  24  *
  25  * cmGetFilenameComponentCommand is a utility command used to get the path,
  26  * name, extension or name without extension of a full filename.
  27  */
  28 class cmGetFilenameComponentCommand : public cmCommand
  29 {
  30 public:
  31   /**
  32    * This is a virtual constructor for the command.
  33    */
  34   virtual cmCommand* Clone()
  35     {
  36     return new cmGetFilenameComponentCommand;
  37     }
  38
  39   /**
  40    * This is called when the command is first encountered in
  41    * the CMakeLists.txt file.
  42    */
  43   virtual bool InitialPass(std::vector<std::string> const& args);
  44
  45   /**
  46    * This determines if the command gets propagated down
  47    * to makefiles located in subdirectories.
  48    */
  49   virtual bool IsInherited() { return true;  }
  50
  51   /**
  52    * The name of the command as specified in CMakeList.txt.
  53    */
  54   virtual const char* GetName() { return "GET_FILENAME_COMPONENT";}
  55
  56   /**
  57    * Succinct documentation.
  58    */
  59   virtual const char* GetTerseDocumentation()
  60     {
  61     return "Get a specific component of a full filename.";
  62     }
  63
  64   /**
  65    * More documentation.
  66    */
  67   virtual const char* GetFullDocumentation()
  68     {
  69     return
  70       "GET_FILENAME_COMPONENT(VarName FileName PATH|NAME|EXT|NAME_WE [CACHE])\n"
  71       "Set VarName to be the path (PATH), file name (NAME), file "
  72       "extension (EXT) or file name without extension (NAME_WE) of FileName.\n"
  73       "Note that the path is converted to Unix slashes format and has no "
  74       "trailing slashes. The longest file extension is always considered.\n"
  75       "Warning: as a utility command, the resulting value is not put in the "
  76       "cache but in the definition list, unless you add the optional CACHE "
  77       "parameter.";
  78     }
  79
  80   cmTypeMacro(cmGetFilenameComponentCommand, cmCommand);
  81 };
  82
  83
  84
  85 #endif