diff options
author | Hugo Parente Lima <hugo.pl@gmail.com> | 2012-03-09 19:01:39 -0300 |
---|---|---|
committer | Hugo Parente Lima <hugo.pl@gmail.com> | 2012-03-09 19:01:39 -0300 |
commit | 00a27e8d6c410c980e7deb8603d4f765b0758500 (patch) | |
tree | 0c722151dd51846798e9cee75cd11d8caaf9dd5e /data | |
parent | 43c3b4e7e876ebc7a38f76b948337166bb6eb985 (diff) | |
parent | bbb7d417e75043dec53c84ceafec5c07cc282a81 (diff) |
Merge GeneratorRunner inside Shiboken.
Conflicts:
CMakeLists.txt
data/CMakeLists.txt
doc/CMakeLists.txt
doc/_templates/index.html
doc/_templates/layout.html
doc/_themes/pysidedocs/static/pysidedocs.css
doc/commandlineoptions.rst
doc/conf.py.in
doc/contents.rst
doc/images/bindinggen-development.png
doc/images/boostqtarch.png
tests/CMakeLists.txt
Diffstat (limited to 'data')
-rw-r--r-- | data/GeneratorRunnerConfig.cmake.in | 17 | ||||
-rw-r--r-- | data/GeneratorRunnerConfigVersion.cmake.in | 10 | ||||
l--------- | data/docgenerator.1 | 1 | ||||
-rw-r--r-- | data/generatorrunner.1 | 76 | ||||
-rw-r--r-- | data/generatorrunner.pc.in | 13 |
5 files changed, 117 insertions, 0 deletions
diff --git a/data/GeneratorRunnerConfig.cmake.in b/data/GeneratorRunnerConfig.cmake.in new file mode 100644 index 000000000..cf973e2a6 --- /dev/null +++ b/data/GeneratorRunnerConfig.cmake.in @@ -0,0 +1,17 @@ +# GENERATORRUNNER_INCLUDE_DIR - Directories to include to use GENERATORRUNNER +# GENERATORRUNNER_LIBRARIES - Files to link against to use GENERATORRUNNER +# GENERATORRUNNER_PLUGIN_DIR - Where to find/put plugins for generator runner +# GENERATORRUNNER_BINARY - Executable name + +SET(GENERATORRUNNER_INCLUDE_DIR "@CMAKE_INSTALL_PREFIX@/include/generatorrunner@generator_SUFFIX@") +if(MSVC) + SET(GENERATORRUNNER_LIBRARY "@LIB_INSTALL_DIR@/@CMAKE_SHARED_LIBRARY_PREFIX@genrunner@generator_SUFFIX@.lib") +elseif(CYGWIN) + SET(GENERATORRUNNER_LIBRARY "@LIB_INSTALL_DIR@/@CMAKE_IMPORT_LIBRARY_PREFIX@genrunner@generator_SUFFIX@@CMAKE_IMPORT_LIBRARY_SUFFIX@") +elseif(WIN32) + SET(GENERATORRUNNER_LIBRARY "@CMAKE_INSTALL_PREFIX@/bin/@CMAKE_SHARED_LIBRARY_PREFIX@genrunner@generator_SUFFIX@@CMAKE_SHARED_LIBRARY_SUFFIX@") +else() + SET(GENERATORRUNNER_LIBRARY "@LIB_INSTALL_DIR@/@CMAKE_SHARED_LIBRARY_PREFIX@genrunner@generator_SUFFIX@@CMAKE_SHARED_LIBRARY_SUFFIX@") +endif() +SET(GENERATORRUNNER_PLUGIN_DIR "@generator_plugin_DIR@") +SET(GENERATORRUNNER_BINARY "@CMAKE_INSTALL_PREFIX@/bin/generatorrunner@generator_SUFFIX@") diff --git a/data/GeneratorRunnerConfigVersion.cmake.in b/data/GeneratorRunnerConfigVersion.cmake.in new file mode 100644 index 000000000..8eb5ba479 --- /dev/null +++ b/data/GeneratorRunnerConfigVersion.cmake.in @@ -0,0 +1,10 @@ +set(PACKAGE_VERSION @generator_VERSION@) + +if("${PACKAGE_VERSION}" VERSION_LESS "${PACKAGE_FIND_VERSION}" ) + set(PACKAGE_VERSION_COMPATIBLE FALSE) +else("${PACKAGE_VERSION}" VERSION_LESS "${PACKAGE_FIND_VERSION}" ) + set(PACKAGE_VERSION_COMPATIBLE TRUE) + if( "${PACKAGE_FIND_VERSION}" STREQUAL "${PACKAGE_VERSION}") + set(PACKAGE_VERSION_EXACT TRUE) + endif( "${PACKAGE_FIND_VERSION}" STREQUAL "${PACKAGE_VERSION}") +endif("${PACKAGE_VERSION}" VERSION_LESS "${PACKAGE_FIND_VERSION}" ) diff --git a/data/docgenerator.1 b/data/docgenerator.1 new file mode 120000 index 000000000..c65282f98 --- /dev/null +++ b/data/docgenerator.1 @@ -0,0 +1 @@ +generatorrunner.1
\ No newline at end of file diff --git a/data/generatorrunner.1 b/data/generatorrunner.1 new file mode 100644 index 000000000..045b55ad4 --- /dev/null +++ b/data/generatorrunner.1 @@ -0,0 +1,76 @@ +.TH GENERATORRUNNER 1 "SEPTEMBER 2009" Linux "User Manuals" +.SH NAME +generatorrunner - plugin-based binding source code generator +.SH SYNOPSIS +.B generatorrunner \-\-generator-set=<plugin name> [options] header-file typesystem-file +.SH DESCRIPTION +.B generatorrunner +is a utility that uses the information taken from APIExtractor +related to the provided C++ headers and typesystem files and execute +generators using this information. Generators are plugins and you need +to specify one using the \-\-generator-set parameter. At the moment there +are two generators available: + +.B qtdoc +\- Generates Sphinx-based documentation for C++ libraries documented using +.B qdoc3 +documentation syntax, using the XML files created by the documentation tool +.B (qdoc3). +Can be called supplying +.B \-\-generator-set=qtdoc +to +.B generatorrunner +or by calling the convenience executable +.B docgenerator. + +Other plugins can be used with +.B generatorrunner, +provided that they follow the generator front-end specifications, +and can be written to generate code or documentation for any target +languague you desire. For more information about the generator front-end +architecture and current limitations, refer to http://www.pyside.org/home-binding. + +.SH OPTIONS +.SS "General options" +.IP \-\-api-version=<version> +Specify the supported api version used to generate the bindings. +.IP \-\-debug-level=[sparse|medium|full] +The amount of messages displayed. +.IP \-\-documentation-only +Only generates the documentation. +.IP \-\-drop-type-entries="<TypeEntry0>[;TypeEntry1;...]" +Semicolon separated list of type system entries (classes, namespaces, global functions and enums) to be dropped from generation. +.IP \-\-help \fR,\fP \-h \fR,\fP -? +Prints the usage message. +.IP \-\-project-file=<file> +Text file containing a description of the binding project. Replaces and overrides command line arguments. +.IP \-\-include\-paths=\fI<path>[:path:..]\fR +The directories where the generator will search for the +headers. Works like gcc's \-I flag. +.IP \-\-license\-file=\fI[licensefile]\fR +Template for copyright headers of generated files. +.IP \-\-no\-supress\-warnings +Show all warnings. +.IP \-\-output\-directory=\fI[dir]\fR +The directory where the generated files will be written. +.IP \-\-silent +Avoid printing any messages. +.IP \-\-typesytem\-paths=\fI<path>[:path:..]\fR +The directories where the generator will search for the +external typesystems referred by the main one. +.IP \-\-version +Displays the current version. +Drops support for named args. +.SS "Specific to qtdoc plugin" +.IP \-\-documentation\-code\-snippets\-dir +Directory used to search code snippets used by the documentation +.IP \-\-documentation\-data\-dir +Directory with XML files generated by documentation tool (qdoc3 or Doxygen) +.IP \-\-documentation\-out\-dir +The directory where the generated documentation files will be written +.IP \-\-library\-source\-dir +Directory where library source code is located + +.SH AUTHORS +Lauro Moura <lauro.neto at openbossa dot org>, Bruno Araujo <bruno.araujo at openbossa dot org>, Hugo Lima <hugo.lima at openbossa dot org> + diff --git a/data/generatorrunner.pc.in b/data/generatorrunner.pc.in new file mode 100644 index 000000000..a566f4356 --- /dev/null +++ b/data/generatorrunner.pc.in @@ -0,0 +1,13 @@ +prefix=@CMAKE_INSTALL_PREFIX@ +exec_prefix=@CMAKE_INSTALL_PREFIX@ +libdir=@LIB_INSTALL_DIR@ +includedir=@CMAKE_INSTALL_PREFIX@/include + + +Name: generatorrunner@generator_SUFFIX@ +Description: Generator Runner loads and calls binding generator front-ends. +Requires: apiextractor +Version: @generatorrunner_VERSION@ +Libs: -L${libdir} -lgenrunner@generator_SUFFIX@ +Cflags: -I${includedir}@generator_SUFFIX@ + |