cmVTKWrapTclCommand.h
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef cmVTKWrapTclCommand_h
#define cmVTKWrapTclCommand_h
#include "cmCommand.h"
#include "cmSourceFile.h"
/** \class cmVTKWrapTclCommand
* \brief Create Tcl Wrappers for VTK classes.
*
* cmVTKWrapTclCommand is used to define a CMake variable include
* path location by specifying a file and list of directories.
*/
class cmVTKWrapTclCommand : public cmCommand
{
public:
cmTypeMacro(cmVTKWrapTclCommand, cmCommand);
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmVTKWrapTclCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args);
/**
* This is called at the end after all the information
* specified by the command is accumulated. Most commands do
* not implement this method. At this point, reading and
* writing to the cache can be done.
*/
virtual void FinalPass();
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "VTK_WRAP_TCL";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Deprecated. For use only in VTK 4.0.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" VTK_WRAP_TCL(resultingLibraryName [SOURCES]\n"
" SourceListName class1 class2 ...\n"
" [COMMANDS CommandName1 CommandName2 ...])\n"
"Create Tcl wrappers for VTK classes.";
}
/** This command is kept for compatibility with older CMake versions. */
virtual bool IsDiscouraged()
{
return true;
}
/**
* Helper methods
*/
virtual bool CreateInitFile(std::string &name);
virtual bool WriteInit(const char *kitName, std::string& outFileName,
std::vector<std::string>& classes);
private:
std::vector<cmSourceFile> WrapClasses;
std::vector<std::string> WrapHeaders;
std::string LibraryName;
std::string SourceList;
std::vector<std::string> Commands;
};
#endif