CMake/Source/cmFLTKWrapUICommand.h
Brad King 96afb12087 Convert CMake to OSI-approved BSD License
This converts the CMake license to a pure 3-clause OSI-approved BSD
License.  We drop the previous license clause requiring modified
versions to be plainly marked.  We also update the CMake copyright to
cover the full development time range.
2009-09-28 11:43:28 -04:00

95 lines
2.5 KiB
C++

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#ifndef cmFLTKWrapUICommand_h
#define cmFLTKWrapUICommand_h
#include "cmCommand.h"
/** \class cmFLTKWrapUICommand
* \brief Create .h and .cxx files rules for FLTK user interfaces files
*
* cmFLTKWrapUICommand is used to create wrappers for FLTK classes into
* normal C++
*/
class cmFLTKWrapUICommand : public cmCommand
{
public:
cmTypeMacro(cmFLTKWrapUICommand, cmCommand);
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmFLTKWrapUICommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status);
/**
* 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();
virtual bool HasFinalPass() const { return true; }
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "fltk_wrap_ui";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Create FLTK user interfaces Wrappers.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" fltk_wrap_ui(resultingLibraryName source1\n"
" source2 ... sourceN )\n"
"Produce .h and .cxx files for all the .fl and .fld files listed. "
"The resulting .h and .cxx files will be added to a variable named "
"resultingLibraryName_FLTK_UI_SRCS which should be added to your "
"library.";
}
private:
/**
* List of produced files.
*/
std::vector<cmSourceFile *> GeneratedSourcesClasses;
/**
* List of Fluid files that provide the source
* generating .cxx and .h files
*/
std::string Target;
};
#endif