forked boostpythongenerator project to separate the generatorrunner

so that it could be used independently; the qtdoc generator module
remained part of generatorrunner

CMakeLists.txt

@@ -76,4 +76,4 @@ install(FILES ${manpages} DESTINATION share/man/man1)
 enable_testing()
 
 add_subdirectory(generators)
-add_subdirectory(tests)
+

ChangeLog

@@ -1,9 +1,14 @@
+2009-10-26  Marcelo Lira <[email protected]>
+
+  * moved BoostPythonGenerator out of GeneratorRunner and created
+    a separated project for the latter.
+
 2009-09-28  Hugo Lima <[email protected]>
 
   * main.cpp: reinterpert_cast replaced by a C-style cast, to avoid compiler
   errors on some plataforms.  Cast an object pointer to a function pointer is
   an undefinied behaviour in some exotic platforms, so some compiler raise a
-  flag against it. However if we use a C-style cast the compiler ignores it. 
+  flag against it. However if we use a C-style cast the compiler ignores it.
   This problem is related to the QLibrary API returning a void* instead of a
   generic function pointer.
 

Doxyfile

@@ -4,7 +4,7 @@
 # Project related configuration options
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
-PROJECT_NAME           = "Boost Python Generator Backend"
+PROJECT_NAME           = "Generator Runner"
 PROJECT_NUMBER         = 0.1
 OUTPUT_DIRECTORY       = doc
 CREATE_SUBDIRS         = NO
@@ -25,7 +25,7 @@ ABBREVIATE_BRIEF       = "The $name class" \
 ALWAYS_DETAILED_SEC    = NO
 INLINE_INHERITED_MEMB  = NO
 FULL_PATH_NAMES        = YES
-STRIP_FROM_PATH        = /tmp/src/boostbackend/
+STRIP_FROM_PATH        = /tmp/src/generatorrunner/
 STRIP_FROM_INC_PATH    =
 SHORT_NAMES            = NO
 JAVADOC_AUTOBRIEF      = YES
@@ -94,7 +94,7 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = /tmp/src/boostbackend
+INPUT                  = /tmp/src/generatorrunner
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.c \
                          *.cc \
@@ -270,8 +270,8 @@ SKIP_FUNCTION_MACROS   = YES
 #---------------------------------------------------------------------------
 # Configuration::additions related to external references
 #---------------------------------------------------------------------------
-TAGFILES               = ../libgenerator/libgenerator.tag=../libgenerator
-GENERATE_TAGFILE       = boostbackend.tag
+TAGFILES               = ../libgenrunner/libgenrunner.tag=../libgenrunner
+GENERATE_TAGFILE       = generatorrunner.tag
 ALLEXTERNALS           = NO
 EXTERNAL_GROUPS        = YES
 PERL_PATH              = /usr/bin/perl

doc/Makefile

@@ -60,9 +60,9 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in _build/qthelp, like this:"
-	@echo "# qcollectiongenerator _build/qthelp/BoostPythonGenerator.qhcp"
+	@echo "# qcollectiongenerator _build/qthelp/GeneratorRunner.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile _build/qthelp/BoostPythonGenerator.qhc"
+	@echo "# assistant -collectionFile _build/qthelp/GeneratorRunner.qhc"
 
 latex:
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex

doc/_templates/index.html

@@ -2,16 +2,14 @@
 {% set title = 'Overview' %}
 {% block body %}
 <div class="section">
-  <h1>BoostPythonGenerator {{ version }}</h1>
+  <h1>GeneratorRunner {{ version }}</h1>
 
-    <p>BoostPythonGenerator is a tool that eases the development of Python bindings for Qt-based
-    libraries by automating most of the process. It relies heavily on the ApiExtractor library
-    to parse the header files and manipulate the classes information while generating the code.
-    This generated code uses the
-    <a href="http://www.boost.org/doc/libs/1_39_0/libs/python/doc/index.html">Boost::Python library</a>
-    in order to bridge the C++ library and Python.</p>
+    <p>GeneratorRunner is a tool that eases the development of binding generators for C++ and Qt-based
+    libraries by providing a framework to help automating most of the process. It uses the
+    ApiExtractor library to parse the header files and manipulate the classes information while
+    generating the binding code using front-end modules provided by the user.
 
-    <p>BoostPythonGenerator is based on the
+    <p>GeneratorRunner is based on the
     <a href="http://labs.trolltech.com/page/Projects/QtScript/Generator">QtScriptGenerator</a> project.</p>
 
   <h2>Documentation</h2>
@@ -24,7 +22,7 @@ <h2>Documentation</h2>
     </td>
     <td width="50%">
       <p class="biglink"><a class="biglink" href="{{ pathto("compiling/compiling") }}">Compiling/Installing</a><br/>
-         <span class="linkdescr">how to compile and install BoostPythonGenerator</span></p>
+         <span class="linkdescr">how to compile and install GeneratorRunner</span></p>
       <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Contents</a><br/>
          <span class="linkdescr">for a complete overview</span></p>
     </td></tr>

doc/compiling/cmake-primer.rst

@@ -6,7 +6,7 @@ CMake primer
 ************
 
 This chapter is a basic introduction to CMake, the build system used by PySide
-and the boost binding generator.
+and the binding generator runner.
 
 The practical steps will focus on how to use cmake on a Unix-like (GNU/Linux)
 environment.

doc/compiling/setup-generator.rst

@@ -1,17 +1,18 @@
 
-.. _boost-python-generator:
+.. _generatorrunner:
 
-***********************
-Boost::Python Generator
-***********************
+****************
+Generator Runner
+****************
 
 Overview
 =========================================
 
-The **Boost::Python Generator** (A.K.A. :program:`boostpythongenerator`) is
-the program that creates the bindings source files from Qt headers and
-auxiliary files  (typesystems, ``global.h`` and glue files). It makes
-heavy use of the :ref:`api-extractor` library.
+The **GeneratorRunner** (A.K.A. :program:`generatorrunner`) is
+the program that collects relevant data from C++ headers (paying
+special attention to Qt provided information, like signals and
+properties) and auxiliary files (typesystems, ``global.h`` and
+glue files). For this it relies on the :ref:`api-extractor` library.
 
 
 Getting the sources

doc/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# BoostPythonGenerator documentation build configuration file, created by
+# GeneratorRunner documentation build configuration file, created by
 # sphinx-quickstart on Wed Apr 22 15:04:20 2009.
 #
 # This file is execfile()d with the current directory set to its containing dir.
@@ -25,7 +25,7 @@
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.ifconfig', 'sphinx.ext.refcounting', 'sphinx.ext.coverage']
 
 rst_epilog = """
-.. |project| replace:: BoostPythonGenerator
+.. |project| replace:: GeneratorRunner
 """
 
 # Add any paths that contain templates here, relative to this directory.
@@ -41,7 +41,7 @@
 #master_doc = 'contents'
 
 # General information about the project.
-project = u'BoostPythonGenerator'
+project = u'GeneratorRunner'
 copyright = u'2009, Nokia Corporation'
 
 # The version info for the project you're documenting, acts as replacement for

doc/overview.rst

@@ -20,7 +20,7 @@ Each module of the generator system has an specific role.
 
 1. Provide enough data about the classes and functions.
 2. Generate valid code, with modifications from typesystems and injected codes.
-3. Modify the API to expose the objects in a Python-friendly way.
+3. Modify the API to expose the objects in a way that fits you target language best.
 4. Insert customizations where handwritten code is needed.
 
 .. figure:: images/boostqtarch.png