Source/cmVTKWrapTclCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmVTKWrapTclCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-01-21 20:30:38 $
   7   Version:   $Revision: 1.6 $
   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 cmVTKWrapTclCommand_h
  18 #define cmVTKWrapTclCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 /** \class cmVTKWrapTclCommand
  24  * \brief Create Tcl Wrappers for VTK classes.
  25  *
  26  * cmVTKWrapTclCommand is used to define a CMake variable include
  27  * path location by specifying a file and list of directories.
  28  */
  29 class cmVTKWrapTclCommand : public cmCommand
  30 {
  31 public:
  32   /**
  33    * This is a virtual constructor for the command.
  34    */
  35   virtual cmCommand* Clone()
  36     {
  37     return new cmVTKWrapTclCommand;
  38     }
  39
  40   /**
  41    * This is called when the command is first encountered in
  42    * the CMakeLists.txt file.
  43    */
  44   virtual bool InitialPass(std::vector<std::string> const& args);
  45
  46   /**
  47    * This is called at the end after all the information
  48    * specified by the command is accumulated. Most commands do
  49    * not implement this method.  At this point, reading and
  50    * writing to the cache can be done.
  51    */
  52   virtual void FinalPass();
  53
  54   /**
  55    * The name of the command as specified in CMakeList.txt.
  56    */
  57   virtual const char* GetName() { return "VTK_WRAP_TCL";}
  58
  59   /**
  60    * Succinct documentation.
  61    */
  62   virtual const char* GetTerseDocumentation()
  63     {
  64     return "Create Tcl Wrappers for VTK classes.";
  65     }
  66
  67   /**
  68    * More documentation.
  69    */
  70   virtual const char* GetFullDocumentation()
  71     {
  72     return
  73       "VTK_WRAP_TCL(resultingLibraryName [SOURCES] SourceListName SourceLists ... [COMMANDS CommandName1 CommandName2 ...])";
  74     }
  75
  76   /**
  77    * Helper methods
  78    */
  79   virtual bool CreateInitFile(std::string &name);
  80   virtual bool WriteInit(const char *kitName, std::string& outFileName,
  81                          std::vector<std::string>& classes);
  82
  83 private:
  84   std::vector<cmSourceFile> m_WrapClasses;
  85   std::vector<std::string> m_WrapHeaders;
  86   std::string m_LibraryName;
  87   std::string m_SourceList;
  88   std::vector<std::string> m_Commands;
  89 };
  90
  91
  92
  93 #endif