Source/cmMakeDirectoryCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmMakeDirectoryCommand.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 cmMakeDirectoryCommand_h
  18 #define cmMakeDirectoryCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmMakeDirectoryCommand
  23  * \brief Specify auxiliary source code directories.
  24  *
  25  * cmMakeDirectoryCommand specifies source code directories
  26  * that must be built as part of this build process. This directories
  27  * are not recursively processed like the SUBDIR command (cmSubdirCommand).
  28  * A side effect of this command is to create a subdirectory in the build
  29  * directory structure.
  30  */
  31 class cmMakeDirectoryCommand : public cmCommand
  32 {
  33 public:
  34   /**
  35    * This is a virtual constructor for the command.
  36    */
  37   virtual cmCommand* Clone()
  38     {
  39     return new cmMakeDirectoryCommand;
  40     }
  41
  42   /**
  43    * This is called when the command is first encountered in
  44    * the CMakeLists.txt file.
  45    */
  46   virtual bool InitialPass(std::vector<std::string> const& args,
  47                            cmExecutionStatus &status);
  48
  49   /**
  50    * The name of the command as specified in CMakeList.txt.
  51    */
  52   virtual const char* GetName() { return "make_directory";}
  53
  54   /**
  55    * This determines if the command is invoked when in script mode.
  56    */
  57   virtual bool IsScriptable() { return true; }
  58
  59   /**
  60    * Succinct documentation.
  61    */
  62   virtual const char* GetTerseDocumentation()
  63     {
  64     return "Deprecated. Use the file(MAKE_DIRECTORY ) command instead.";
  65     }
  66
  67   /**
  68    * More documentation.
  69    */
  70   virtual const char* GetFullDocumentation()
  71     {
  72     return
  73       "  make_directory(directory)\n"
  74       "Creates the specified directory.  Full paths should be given.  Any "
  75       "parent directories that do not exist will also be created.  Use with "
  76       "care.";
  77     }
  78
  79   /** This command is kept for compatibility with older CMake versions. */
  80   virtual bool IsDiscouraged()
  81     {
  82     return true;
  83     }
  84
  85   cmTypeMacro(cmMakeDirectoryCommand, cmCommand);
  86 };
  87
  88
  89
  90 #endif