Source/cmUseMangledMesaCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmUseMangledMesaCommand.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 cmUseMangledMesaCommand_h
  18 #define cmUseMangledMesaCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 #include "cmSourceFile.h"
  23
  24 /** \class cmUseMangledMesaCommand
  25  * \brief Create Tcl Wrappers for VTK classes.
  26  *
  27  * cmUseMangledMesaCommand is used to define a CMake variable include
  28  * path location by specifying a file and list of directories.
  29  */
  30 class cmUseMangledMesaCommand : public cmCommand
  31 {
  32 public:
  33   cmTypeMacro(cmUseMangledMesaCommand, cmCommand);
  34
  35   /**
  36    * This is a virtual constructor for the command.
  37    */
  38   virtual cmCommand* Clone()
  39     {
  40     return new cmUseMangledMesaCommand;
  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                            cmExecutionStatus &status);
  49
  50   /**
  51    * The name of the command as specified in CMakeList.txt.
  52    */
  53   virtual const char* GetName() { return "use_mangled_mesa";}
  54
  55   /**
  56    * Succinct documentation.
  57    */
  58   virtual const char* GetTerseDocumentation()
  59     {
  60     return "Copy mesa headers for use in combination with system GL.";
  61     }
  62
  63   /**
  64    * More documentation.
  65    */
  66   virtual const char* GetFullDocumentation()
  67     {
  68     return
  69       "  use_mangled_mesa(PATH_TO_MESA OUTPUT_DIRECTORY)\n"
  70       "The path to mesa includes, should contain gl_mangle.h.  "
  71       "The mesa headers are copied to the specified output directory.  "
  72       "This allows mangled mesa headers to override other GL headers by "
  73       "being added to the include directory path earlier.";
  74     }
  75
  76   /** This command is kept for compatibility with older CMake versions. */
  77   virtual bool IsDiscouraged()
  78     {
  79     return true;
  80     }
  81
  82 protected:
  83   void CopyAndFullPathMesaHeader(const char* source,
  84                                  const char* outdir);
  85 };
  86
  87
  88
  89 #endif