Source/cmSeparateArgumentsCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmSeparateArgumentsCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2009-07-14 14:15:44 $
   7   Version:   $Revision: 1.10 $
   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 cmSeparateArgumentsCommand_h
  18 #define cmSeparateArgumentsCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmSeparateArgumentsCommand
  23  * \brief SeparateArguments a CMAKE variable
  24  *
  25  * cmSeparateArgumentsCommand sets a variable to a value with expansion.
  26  */
  27 class cmSeparateArgumentsCommand : public cmCommand
  28 {
  29 public:
  30   /**
  31    * This is a virtual constructor for the command.
  32    */
  33   virtual cmCommand* Clone()
  34     {
  35     return new cmSeparateArgumentsCommand;
  36     }
  37
  38   /**
  39    * This is called when the command is first encountered in
  40    * the CMakeLists.txt file.
  41    */
  42   virtual bool InitialPass(std::vector<std::string> const& args,
  43                            cmExecutionStatus &status);
  44
  45   /**
  46    * This determines if the command is invoked when in script mode.
  47    */
  48   virtual bool IsScriptable() { return true; }
  49
  50   /**
  51    * The name of the command as specified in CMakeList.txt.
  52    */
  53   virtual const char* GetName() {return "separate_arguments";}
  54
  55   /**
  56    * Succinct documentation.
  57    */
  58   virtual const char* GetTerseDocumentation()
  59     {
  60     return
  61       "Parse space-separated arguments into a semicolon-separated list.";
  62     }
  63
  64   /**
  65    * More documentation.
  66    */
  67   virtual const char* GetFullDocumentation()
  68     {
  69     return
  70       "  separate_arguments(<var> <UNIX|WINDOWS>_COMMAND \"<args>\")\n"
  71       "Parses a unix- or windows-style command-line string \"<args>\" and "
  72       "stores a semicolon-separated list of the arguments in <var>.  "
  73       "The entire command line must be given in one \"<args>\" argument."
  74       "\n"
  75       "The UNIX_COMMAND mode separates arguments by unquoted whitespace.  "
  76       "It recognizes both single-quote and double-quote pairs.  "
  77       "A backslash escapes the next literal character (\\\" is \"); "
  78       "there are no special escapes (\\n is just n)."
  79       "\n"
  80       "The WINDOWS_COMMAND mode parses a windows command-line using the "
  81       "same syntax the runtime library uses to construct argv at startup.  "
  82       "It separates arguments by whitespace that is not double-quoted.  "
  83       "Backslashes are literal unless they precede double-quotes.  "
  84       "See the MSDN article \"Parsing C Command-Line Arguments\" for details."
  85       "\n"
  86       "  separate_arguments(VARIABLE)\n"
  87       "Convert the value of VARIABLE to a semi-colon separated list.  "
  88       "All spaces are replaced with ';'.  This helps with generating "
  89       "command lines.";
  90     }
  91
  92   cmTypeMacro(cmSeparateArgumentsCommand, cmCommand);
  93 };
  94
  95
  96
  97 #endif