Source/cmGetFilenameComponentCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmGetFilenameComponentCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-01-23 15:27:59 $
   7   Version:   $Revision: 1.14 $
   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 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                            cmExecutionStatus &status);
  45
  46   /**
  47    * This determines if the command is invoked when in script mode.
  48    */
  49   virtual bool IsScriptable() { 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\n"
  71       "                         PATH|ABSOLUTE|NAME|EXT|NAME_WE\n"
  72       "                         [CACHE])\n"
  73       "Set VarName to be the path (PATH), file name (NAME), file "
  74       "extension (EXT), file name without extension (NAME_WE) of FileName, "
  75       "or the full absolute (ABSOLUTE) file name without symlinks.  "
  76       "Note that the path is converted to Unix slashes format and has no "
  77       "trailing slashes. The longest file extension is always considered. "
  78       "If the optional CACHE argument is specified, the result variable is "
  79       "added to the cache.\n"
  80       "  get_filename_component(VarName FileName\n"
  81       "                         PROGRAM [PROGRAM_ARGS ArgVar]\n"
  82       "                         [CACHE])\n"
  83       "The program in FileName will be found in the system search path or "
  84       "left as a full path.  If PROGRAM_ARGS is present with PROGRAM, then "
  85       "any command-line arguments present in the FileName string are split "
  86       "from the program name and stored in ArgVar.  This is used to separate "
  87       "a program name from its arguments in a command line string.";
  88     }
  89
  90   cmTypeMacro(cmGetFilenameComponentCommand, cmCommand);
  91 };
  92
  93
  94
  95 #endif