Source/cmMakeDirectoryCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmMakeDirectoryCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-01-21 20:30:29 $
   7   Version:   $Revision: 1.4 $
   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 cmMakeDirectoryCommand_h
  18 #define cmMakeDirectoryCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 /** \class cmMakeDirectoryCommand
  24  * \brief Specify auxiliary source code directories.
  25  *
  26  * cmMakeDirectoryCommand specifies source code directories
  27  * that must be built as part of this build process. This directories
  28  * are not recursively processed like the SUBDIR command (cmSubdirCommand).
  29  * A side effect of this command is to create a subdirectory in the build
  30  * directory structure.
  31  */
  32 class cmMakeDirectoryCommand : public cmCommand
  33 {
  34 public:
  35   /**
  36    * This is a virtual constructor for the command.
  37    */
  38   virtual cmCommand* Clone()
  39     {
  40     return new cmMakeDirectoryCommand;
  41     }
  42
  43   /**
  44    * This is called when the command is first encountered in
  45    * the CMakeLists.txt file.
  46    */
  47   virtual bool InitialPass(std::vector<std::string> const& args);
  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    * Succinct documentation.
  56    */
  57   virtual const char* GetTerseDocumentation()
  58     {
  59     return "Create a directory in the build tree if it does not exist.\n"
  60            "Parent directories will be created if the do not exist..";
  61     }
  62
  63   /**
  64    * More documentation.
  65    */
  66   virtual const char* GetFullDocumentation()
  67     {
  68     return
  69       "MAKE_DIRECTORY(directory)";
  70     }
  71
  72   cmTypeMacro(cmMakeDirectoryCommand, cmCommand);
  73 };
  74
  75
  76
  77 #endif