diff options
Diffstat (limited to 'data')
-rw-r--r-- | data/CMakeLists.txt | 25 | ||||
-rw-r--r-- | data/GeneratorRunnerConfig.cmake.in | 15 | ||||
-rw-r--r-- | data/GeneratorRunnerConfigVersion.cmake.in | 9 | ||||
l--------- | data/docgenerator.1 | 1 | ||||
-rw-r--r-- | data/generatorrunner.1 | 72 | ||||
-rw-r--r-- | data/generatorrunner.pc.in | 13 |
6 files changed, 135 insertions, 0 deletions
diff --git a/data/CMakeLists.txt b/data/CMakeLists.txt new file mode 100644 index 000000000..9b150f35a --- /dev/null +++ b/data/CMakeLists.txt @@ -0,0 +1,25 @@ +# create pkg-config file +configure_file("${CMAKE_CURRENT_SOURCE_DIR}/generatorrunner.pc.in" + "${CMAKE_CURRENT_BINARY_DIR}/generatorrunner${generator_SUFFIX}.pc" @ONLY) +configure_file("${CMAKE_CURRENT_SOURCE_DIR}/GeneratorRunnerConfig.cmake.in" + "${CMAKE_CURRENT_BINARY_DIR}/GeneratorRunnerConfig.cmake" @ONLY) +configure_file("${CMAKE_CURRENT_SOURCE_DIR}/GeneratorRunnerConfigVersion.cmake.in" + "${CMAKE_CURRENT_BINARY_DIR}/GeneratorRunnerConfigVersion.cmake" @ONLY) + +install(FILES "${CMAKE_CURRENT_BINARY_DIR}/generatorrunner${generator_SUFFIX}.pc" DESTINATION + "${LIB_INSTALL_DIR}/pkgconfig") +install(FILES "${CMAKE_CURRENT_BINARY_DIR}/GeneratorRunnerConfig.cmake" + DESTINATION "${LIB_INSTALL_DIR}/cmake/GeneratorRunner-${generator_VERSION}") +install(FILES "${CMAKE_CURRENT_BINARY_DIR}/GeneratorRunnerConfigVersion.cmake" + DESTINATION "${LIB_INSTALL_DIR}/cmake/GeneratorRunner-${generator_VERSION}") + +#FIXME: manpages should be installed only on Linux targets +execute_process(COMMAND ${CMAKE_COMMAND} -E copy_if_different "${CMAKE_CURRENT_SOURCE_DIR}/docgenerator.1" + "${CMAKE_CURRENT_BINARY_DIR}/docgenerator${generator_SUFFIX}.1") +execute_process(COMMAND ${CMAKE_COMMAND} -E copy_if_different "${CMAKE_CURRENT_SOURCE_DIR}/generatorrunner.1" + "${CMAKE_CURRENT_BINARY_DIR}/generatorrunner${generator_SUFFIX}.1") +configure_file("${CMAKE_CURRENT_SOURCE_DIR}/generatorrunner.pc.in" + "${CMAKE_CURRENT_BINARY_DIR}/generatorrunner${generator_SUFFIX}.pc" @ONLY) + +file(GLOB manpages "${CMAKE_CURRENT_BINARY_DIR}/*${generator_SUFFIX}.1") +install(FILES ${manpages} DESTINATION share/man/man1) diff --git a/data/GeneratorRunnerConfig.cmake.in b/data/GeneratorRunnerConfig.cmake.in new file mode 100644 index 000000000..6b7a06dc9 --- /dev/null +++ b/data/GeneratorRunnerConfig.cmake.in @@ -0,0 +1,15 @@ +# 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(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 generatorrunner@generator_SUFFIX@) diff --git a/data/GeneratorRunnerConfigVersion.cmake.in b/data/GeneratorRunnerConfigVersion.cmake.in new file mode 100644 index 000000000..fe0e36e59 --- /dev/null +++ b/data/GeneratorRunnerConfigVersion.cmake.in @@ -0,0 +1,9 @@ +set(PACKAGE_VERSION @generator_VERSION@) +if("${PACKAGE_FIND_VERSION_MAJOR}" EQUAL @generator_MAJOR_VERSION@) + if("${PACKAGE_FIND_VERSION_MINOR}" EQUAL @generator_MINOR_VERSION@) + set(PACKAGE_VERSION_COMPATIBLE 1) + if("${PACKAGE_FIND_VERSION_PATCH}" EQUAL @generator_MICRO_VERSION@) + set(PACKAGE_VERSION_EXACT 1) + endif() + endif() +endif() 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..60749d951 --- /dev/null +++ b/data/generatorrunner.1 @@ -0,0 +1,72 @@ +.TH GENERATORRUNNER 1 "SEPTEMBER 2009" Linux "User Manuals" +.SH NAME +generatorrunner - plugin-based binding source code generator +.SH SYNOPSIS +.B generatorrunner \-\-generatorSet=<plugin name> [options] header-file typesystem-file +.B ... +.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 \-\-generatorSet 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 \-\-generatorSet=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 \-\-debug-level=[sparse|medium|full] +The amount of messages displayed. +.IP \-\-documentation-only +Only generates the documentation. +.TP +.BI \-\-help \fR,\fP \-h \fR,\fP -? +Prints the usage message. +.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@ + |