Source/cmVTKWrapPythonCommand.h

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