Source/cmFLTKWrapUICommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmFLTKWrapUICommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-01-23 15:27:59 $
   7   Version:   $Revision: 1.16 $
   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 cmFLTKWrapUICommand_h
  18 #define cmFLTKWrapUICommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmFLTKWrapUICommand
  23  * \brief Create .h and .cxx files rules for FLTK user interfaces files
  24  *
  25  * cmFLTKWrapUICommand is used to create wrappers for FLTK classes into
  26  * normal C++
  27  */
  28 class cmFLTKWrapUICommand : public cmCommand
  29 {
  30 public:
  31   cmTypeMacro(cmFLTKWrapUICommand, cmCommand);
  32
  33   /**
  34    * This is a virtual constructor for the command.
  35    */
  36   virtual cmCommand* Clone()
  37     {
  38     return new cmFLTKWrapUICommand;
  39     }
  40
  41   /**
  42    * This is called when the command is first encountered in
  43    * the CMakeLists.txt file.
  44    */
  45   virtual bool InitialPass(std::vector<std::string> const& args,
  46                            cmExecutionStatus &status);
  47
  48   /**
  49    * This is called at the end after all the information
  50    * specified by the command is accumulated. Most commands do
  51    * not implement this method.  At this point, reading and
  52    * writing to the cache can be done.
  53    */
  54   virtual void FinalPass();
  55
  56   /**
  57    * The name of the command as specified in CMakeList.txt.
  58    */
  59   virtual const char* GetName() { return "fltk_wrap_ui";}
  60
  61   /**
  62    * Succinct documentation.
  63    */
  64   virtual const char* GetTerseDocumentation()
  65     {
  66     return "Create FLTK user interfaces Wrappers.";
  67     }
  68
  69   /**
  70    * More documentation.
  71    */
  72   virtual const char* GetFullDocumentation()
  73     {
  74     return
  75       "  fltk_wrap_ui(resultingLibraryName source1\n"
  76       "               source2 ... sourceN )\n"
  77       "Produce .h and .cxx files for all the .fl and .fld files listed.  "
  78       "The resulting .h and .cxx files will be added to a variable named "
  79       "resultingLibraryName_FLTK_UI_SRCS which should be added to your "
  80       "library.";
  81     }
  82
  83 private:
  84   /**
  85    * List of produced files.
  86    */
  87   std::vector<cmSourceFile *> GeneratedSourcesClasses;
  88
  89   /**
  90    * List of Fluid files that provide the source
  91    * generating .cxx and .h files
  92    */
  93   std::string Target;
  94 };
  95
  96
  97
  98 #endif