Added wrapper build target for generating the osgWrappers

This commit is contained in:
Robert Osfield
2008-08-26 12:05:24 +00:00
parent 86d2eb1e4a
commit 6af69a3615
3 changed files with 247 additions and 0 deletions

View File

@@ -0,0 +1,235 @@
# Doxyfile 1.4.1
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
PROJECT_NAME = "OSG Introspection Wrappers"
PROJECT_NUMBER =
OUTPUT_DIRECTORY = "$(OUTPUT_DIR)"
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
USE_WINDOWS_ENCODING = YES
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
STRIP_FROM_PATH = "$(INPUT_DIR)"
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
DISTRIBUTE_GROUP_DOC = NO
TAB_SIZE = 8
ALIASES =
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
SUBGROUPING = YES
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = NO
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = NO
GENERATE_TESTLIST = NO
GENERATE_BUGLIST = NO
GENERATE_DEPRECATEDLIST= NO
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
SHOW_DIRECTORIES = YES
FILE_VERSION_FILTER =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = "$(INPUT_DIR)include"
FILE_PATTERNS = */include/*
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS = "*/include/osgIntrospection/*" "*/include/CVS/*" "*/include/osg*/CVS/*" "*.#*" "*/.svn/*"
EXAMPLE_PATH =
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = NO
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = NO
REFERENCES_RELATION = NO
VERBATIM_HEADERS = NO
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = NO
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = NO
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = NO
USE_PDFLATEX = NO
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = YES
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
SEARCH_INCLUDES = YES
INCLUDE_PATH = "$(INPUT_DIR)include"
INCLUDE_FILE_PATTERNS =
EXPAND_AS_DEFINED = META_Object \
META_StateAttribute \
META_Node \
META_Shape \
META_Technique \
META_Effect
PREDEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = NO
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = NO
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
MAX_DOT_GRAPH_WIDTH = 1024
MAX_DOT_GRAPH_HEIGHT = 1024
MAX_DOT_GRAPH_DEPTH = 1000
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO

View File

@@ -0,0 +1,453 @@
#############################################################################
# #
# GenWrapper Configuration File #
# #
#############################################################################
configure library "osgFX"
dependency unix "-losgUtil -losgDB"
end
configure library "osgParticle"
dependency unix "-losgUtil -losgDB"
end
configure library "osgGA"
dependency unix "-losgUtil"
end
configure library "osgSim"
dependency unix "-losgUtil -losgText -losgDB"
end
configure library "osgTerrain"
dependency win32-debug "gdal_iD.lib"
dependency win32-release "gdal_i.lib"
dependency unix "-losgDB -losgUtil -losgFX"
end
configure library "osgText"
dependency unix "-losgDB"
end
configure library "osgViewer"
dependency unix "-losgUtil -losgDB -losgGA -losgText"
end
#############################################################################
ignore file "osgUtil/OperationArrayFunctor"
ignore file "osgViewer/api/X11/GraphicsWindowX11"
ignore file "osgViewer/api/Win32/GraphicsWindowWin32"
ignore file "osgViewer/api/Cocoa/GraphicsWindowCocoa"
suppress reflector "osgUtil::AddRangeFunctor"
suppress reflector "osgUtil::MultiplyRangeFunctor"
suppress reflector "CPluginFunction"
suppress reflector "PluginFunctionProxy"
#############################################################################
configure file /osg\/GraphicsContext/
emit before "#include <osg/Camera>
"
end
configure file /osgViewer\/ViewerBase/
emit before "#include <osgViewer/View>
"
end
#############################################################################
# add <io_utils> header to Plane, Quat and Vec* files
configure file /osg\/(Plane|Quat|(Vec(2|3|4)(f|d|b|ub)))/
emit before "#include <osg/io_utils>
"
end
# add ReaderWriter and Comparator objects to Vec*, Quat and Plane classes
configure reflector /osg::(Plane|Quat|(Vec(2|3|4)(f|d|b|ub)))/
readerwriter "osgIntrospection::StdReaderWriter<reflected_type>"
comparator "osgIntrospection::PartialOrderComparator<reflected_type>"
end
# add StateGraph includes in RenderLeaf.cpp
configure file /osgUtil\/RenderLeaf/
emit before "#include <osgUtil/StateGraph>
"
end
#############################################################################
# Doxygen fails to detect that std::vector<T> is a base class for
# osg::Vector*, so we need to specify that manually
configure reflector "osgText::VectorUInt"
add base "std::vector<unsigned int>"
end
#############################################################################
# Doxygen/genwrapper is not coping with the new MixinVector so disable associated wrappers
suppress reflector /osg::TemplateIndexArray< GLbyte.*/
suppress reflector /osg::TemplateIndexArray< GLubyte.*/
suppress reflector /osg::TemplateIndexArray< GLshort.*/
suppress reflector /osg::TemplateIndexArray< GLushort.*/
suppress reflector /osg::TemplateIndexArray< GLint.*/
suppress reflector /osg::TemplateIndexArray< GLuint.*/
suppress reflector /osg::TemplateArray< GLfloat.*/
suppress reflector /osg::TemplateArray< GLdouble.*/
suppress reflector /osg::TemplateArray< osg::Vec2\s*\,.*/
suppress reflector /osg::TemplateArray< osg::Vec3\s*\,.*/
suppress reflector /osg::TemplateArray< osg::Vec4\s*\,.*/
suppress reflector /osg::TemplateArray< osg::Vec2d\s*\,.*/
suppress reflector /osg::TemplateArray< osg::Vec3d\s*\,.*/
suppress reflector /osg::TemplateArray< osg::Vec4d\s*\,.*/
suppress reflector /osg::TemplateArray< osg::Vec2b\s*\,.*/
suppress reflector /osg::TemplateArray< osg::Vec3b\s*\,.*/
suppress reflector /osg::TemplateArray< osg::Vec4b\s*\,.*/
suppress reflector /osg::TemplateArray< osg::Vec2s\s*\,.*/
suppress reflector /osg::TemplateArray< osg::Vec3s\s*\,.*/
suppress reflector /osg::TemplateArray< osg::Vec4s\s*\,.*/
suppress reflector /osg::TemplateArray< osg::Vec4ub\s*\,.*/
suppress reflector "osg::DrawArrayLengths"
suppress reflector "osg::DrawElementsUByte"
suppress reflector "osg::DrawElementsUShort"
suppress reflector "osg::DrawElementsUInt"
suppress reflector "osg::VectorGLsizei"
suppress reflector "osg::VectorGLubyte"
suppress reflector "osg::VectorGLushort"
suppress reflector "osg::VectorGLuint"
suppress reflector "osg::MixinVector< GLsizei >"
suppress reflector "osg::MixinVector< GLubyte >"
suppress reflector "osg::MixinVector< GLushort >"
suppress reflector "osg::MixinVector< GLuint >"
suppress reflector "OpenThreads::Atomic"
suppress reflector "OpenThreads::AtomicPtr"
#############################################################################
# StateSet and related types need some advanced tweaking
configure reflector "std::map< osg::StateAttribute::GLMode, osg::StateAttribute::GLModeValue >"
replace with "STD_MAP_REFLECTOR_WITH_TYPES(std::map< osg::StateAttribute::GLMode COMMA osg::StateAttribute::GLModeValue >, osg::StateAttribute::GLMode, osg::StateAttribute::Values)"
end
configure reflector "osg::StateSet"
# remove indexed property "Mode" because its index would not belong to a
# finite set of values
configure property "Mode"
replace with ""
end
end
configure reflector "osg::Geometry"
# define the count method for some Property
configure property "TexCoordData"
count_method "__unsigned_int__getNumTexCoordArrays"
end
configure property "TexCoordIndices"
count_method "__unsigned_int__getNumTexCoordArrays"
end
configure property "VertexAttribBinding"
count_method "__unsigned_int__getNumVertexAttribArrays"
end
configure property "VertexAttribData"
count_method "__unsigned_int__getNumVertexAttribArrays"
end
configure property "VertexAttribIndices"
count_method "__unsigned_int__getNumVertexAttribArrays"
end
configure property "VertexAttribNormalize"
count_method "__unsigned_int__getNumVertexAttribArrays"
end
end
#############################################################################
# Doxygen fails to detect that /osg::Texture(1D|2D|3D|Rectangle)/ and
# osgText::Font::GlyphTexture are not-abstract class, so we need
# to specify that manually
configure reflector /osg::Texture(1D|2D|3D|Rectangle)/
object-type
end
configure reflector "osgText::Font::GlyphTexture"
object-type
end
#############################################################################
# must suppress reflector for osgDB::Output because some of its methods
# are not supported by osgIntrospection (they return non-const references)
suppress reflector "osgDB::Output"
#############################################################################
# some types are incorrectly detected as value type or object type. Here we
# specify the type kind explicitly
configure reflector "OpenThreads::Mutex"
object-type
end
configure reflector "OpenThreads::Condition"
object-type
end
configure reflector "OpenThreads::Block"
object-type
end
configure reflector "OpenThreads::BlockCount"
object-type
end
configure reflector "OpenThreads::Barrier"
object-type
end
configure reflector "OpenThreads::ReentrantMutex"
object-type
end
configure reflector "OpenThreads::ReadWriteMutex"
object-type
end
configure reflector "osg::DeleteHandler"
object-type
end
configure reflector "osg::GraphicsContext"
abstract-object-type
end
#############################################################################
# Suppress nested nested class method
configure reflector "osgShadow::OccluderGeometry"
configure method /.*_Edge_.*/
replace with ""
end
end
#############################################################################
# Doxygen doesn't parse ReadFunc and WriteFunc correctly...
configure reflector "osgDB::DotOsgWrapper::ReadFunc"
replace with "TYPE_NAME_ALIAS(bool (*)(osg::Object&,osgDB::Input&), osgDB::DotOsgWrapper::ReadFunc)
"
end
configure reflector "osgDB::DotOsgWrapper::WriteFunc"
replace with "TYPE_NAME_ALIAS(bool (*)(const osg::Object&,osgDB::Output&), osgDB::DotOsgWrapper::WriteFunc)
"
end
#############################################################################
# temporary workaround for problems related to ambiguous name resolution
suppress reflector "osg::ref_ptr< const osg::StateAttribute >"
suppress reflector "osg::ref_ptr< const osgFX::Effect >"
#############################################################################
# Doxygen incorrectly parses function typedefs as methods
configure reflector "osg::BufferObject::Extensions"
configure method "__typedef__void__APIENTRY_P1"
replace with ""
end
configure method "__typedef__GLboolean__APIENTRY_P1"
replace with ""
end
end
configure reflector "osg::Drawable::Extensions"
configure method "__typedef__void__APIENTRY_P1"
replace with ""
end
configure method "__typedef__GLboolean__APIENTRY_P1"
replace with ""
end
end
configure reflector "osg::BlendColor::Extensions"
configure method "__typedef__void__APIENTRY_P1"
replace with ""
end
configure method "__typedef__GLboolean__APIENTRY_P1"
replace with ""
end
end
configure reflector "osg::BlendEquation::Extensions"
configure method "__typedef__void__APIENTRY_P1"
replace with ""
end
configure method "__typedef__GLboolean__APIENTRY_P1"
replace with ""
end
end
configure reflector "osg::BlendFunc::Extensions"
configure method "__typedef__void__APIENTRY_P1"
replace with ""
end
configure method "__typedef__GLboolean__APIENTRY_P1"
replace with ""
end
end
configure reflector "osg::FragmentProgram::Extensions"
configure method "__typedef__void__APIENTRY_P1"
replace with ""
end
configure method "__typedef__GLboolean__APIENTRY_P1"
replace with ""
end
end
configure reflector "osg::Multisample::Extensions"
configure method "__typedef__void__APIENTRY_P1"
replace with ""
end
configure method "__typedef__GLboolean__APIENTRY_P1"
replace with ""
end
end
configure reflector "osg::Point::Extensions"
configure method "__typedef__void__APIENTRY_P1"
replace with ""
end
configure method "__typedef__GLboolean__APIENTRY_P1"
replace with ""
end
end
configure reflector "osg::ClampColor::Extensions"
configure method "__typedef__void__APIENTRY_P1"
replace with ""
end
configure method "__typedef__GLboolean__APIENTRY_P1"
replace with ""
end
end
configure reflector "osg::Texture::Extensions"
configure method "__typedef__void__APIENTRY_P1"
replace with ""
end
configure method "__typedef__GLboolean__APIENTRY_P1"
replace with ""
end
end
configure reflector "osg::Texture2DArray::Extensions"
configure method "__typedef__void__APIENTRY_P1"
replace with ""
end
configure method "__typedef__GLboolean__APIENTRY_P1"
replace with ""
end
end
configure reflector "osg::State"
configure method "__typedef__void__APIENTRY_P1"
replace with ""
end
end
#############################################################################
# avoid functions that use protected types, since those are not handled
# currently
configure reflector "osgSim::OverlayNode"
configure method /.*getOverlayData.*/
replace with ""
end
end
configure reflector "osg::Shader"
configure method /.*_PerContextShader_.*/
replace with ""
end
end
configure reflector "osg::State"
configure method /.*_(ModeStack|AttributeStack|ModeMap|AttributeMap|UniformMap)_.*/
replace with ""
end
end
configure reflector "osgUtil::Optimizer::TextureAtlasBuilder"
configure method /.*_Source_.*/
replace with ""
end
end
configure reflector "osgUtil::Tessellator"
configure method /.*_VertexPtrToIndexMap_.*/
replace with ""
end
end
configure reflector "osgDB::Registry"
configure method /.*_(DynamicLibraryList_iterator|DotOsgWrapperMap)_.*/
replace with ""
end
end
configure reflector "osgText::FadeText"
configure method /.*_ViewBlendColou?rMap_.*/
replace with ""
end
end
configure reflector "osgParticle::PrecipitationEffect"
configure method /.*_PrecipitationDrawableSet_.*/
replace with ""
end
end
configure reflector "osgManipulator::MotionCommand"
configure method /.*_SelectionList_.*/
replace with ""
end
end