[pygccxml-commit] SF.net SVN: pygccxml: [375] pyplusplus_dev/docs
Brought to you by:
mbaas,
roman_yakovenko
From: <rom...@us...> - 2006-08-01 15:13:23
|
Revision: 375 Author: roman_yakovenko Date: 2006-08-01 08:13:12 -0700 (Tue, 01 Aug 2006) ViewCVS: http://svn.sourceforge.net/pygccxml/?rev=375&view=rev Log Message: ----------- updating documentation Modified Paths: -------------- pyplusplus_dev/docs/history/history.rest pyplusplus_dev/docs/pyplusplus.rest Modified: pyplusplus_dev/docs/history/history.rest =================================================================== --- pyplusplus_dev/docs/history/history.rest 2006-08-01 13:25:55 UTC (rev 374) +++ pyplusplus_dev/docs/history/history.rest 2006-08-01 15:13:12 UTC (rev 375) @@ -24,7 +24,27 @@ 1. Georgiy Dernovoy contributed a patch, that allows `pyplusplus`_ GUI to save\load last used header file. - + +2. `pyplusplus`_ improved a lot functionality related to providing feedback to user: + + * every package has its own logger + + * only important user messages are written to ``stdout`` + + * user messages are clear + +3. Support for boost.python indexing suite version 2 was implemented. + +4. Every code creator class took ``parent`` argument in ``__init__`` method. + This argument was removed. ``adopt_creator`` and ``remove_creator`` will + set\unset reference to parent. + +5. Generated code for member and free functions was changed. This changed was + introduced to fix compilation errors on msvc 7.1 compiler. + +6. `pyplusplus`_ generates "stable" code. If header files were not changed, + `pyplusplus`_ will not change any file. + ------------- Version 0.8.0 ------------- Modified: pyplusplus_dev/docs/pyplusplus.rest =================================================================== --- pyplusplus_dev/docs/pyplusplus.rest 2006-08-01 13:25:55 UTC (rev 374) +++ pyplusplus_dev/docs/pyplusplus.rest 2006-08-01 15:13:12 UTC (rev 375) @@ -14,9 +14,9 @@ Preamble -------- -This introduction will describe code generation process using `pyplusplus`_. +This introduction will describe code generation process using pyplusplus. I hope, that after you finished to read it, you will understand how powerful -`pyplusplus`_ is. +pyplusplus is. ----------------------- Code generation process @@ -24,20 +24,20 @@ `boost.python`_ library allows you to expose C++ code to `Python`_ in quick and elegant way. Almost the whole process of exposing declarations can be automated -by use of `pyplusplus`_. Code generation process, using `pyplusplus`_ consists +by use of pyplusplus. Code generation process, using pyplusplus consists from few steps. Next paragraphs will tell you more about every step. *"read declarations"* --------------------- -`pyplusplus`_ does not reinvent the wheel. `pyplusplus`_ uses `GCC C++ compiler`_ +pyplusplus does not reinvent the wheel. pyplusplus uses `GCC C++ compiler`_ to parse C++ source files. To be more precision, the tool chain looks like this: 1. source code is passed to `GCC-XML`_ 2. `GCC-XML`_ passes it to `GCC C++ compiler`_ 3. `GCC-XML`_ generates an XML description of a C++ program from GCC's internal representation. -4. `pyplusplus`_ uses `pygccxml`_ package to read `GCC-XML`_ generated file. +4. pyplusplus uses `pygccxml`_ package to read `GCC-XML`_ generated file. The bottom line - you can be sure, that all your declarations are read correctly. @@ -55,10 +55,10 @@ a question, what code should be written in order I get access from Python to that functionality -Of course, `pyplusplus`_ can not answer those question, but it provides maximum +Of course, pyplusplus can not answer those question, but it provides maximum help to implement an user requirements. -How can `pyplusplus`_ help you with first question? `pyplusplus`_ provides very +How can pyplusplus help you with first question? pyplusplus provides very powerful and simple query interface. For example in one line of code you can select all free functions that have @@ -88,16 +88,16 @@ the rules, that will continue to work even after exported C++ code was changed. It means that you don't have to change code generator source code every time. -So far, so good what about second question? Well, by default `pyplusplus`_ -generates a code that will satisfy almost all developers. `pyplusplus`_ relevant +So far, so good what about second question? Well, by default pyplusplus +generates a code that will satisfy almost all developers. pyplusplus relevant classes could be configured in many ways to satisfy your needs. But sometimes this is still not enough. There are use cases when you need full control over generated code. One of the biggest problems, with code generators in general, is modifying generated code and preserving changes. How many code generators did you use or know, that allow you to put your code any where or to reorder generated -code as you wish? `pyplusplus`_ allows you to do that. +code as you wish? pyplusplus allows you to do that. -`pyplusplus`_ introduces new concept: code creator and code creator's tree. +pyplusplus introduces new concept: code creator and code creator's tree. You can think about code creator's tree as some kind of `AST`_. The only difference is that code creator's tree has higher interface. For example ``include_t`` code creator is responsible to create C++ ``include`` directive code. You have full @@ -112,11 +112,11 @@ *"write code to files"* ----------------------- -During this step `pyplusplus`_ reads code creators tree and writes code to the +During this step pyplusplus reads code creators tree and writes code to the disc.The result of code generation process should not be different from the one, that would be achieved by human. For small project writing all code into single file is good approach, for big ones code should be written into multiple files. -`pyplusplus`_ implements both strategies. +pyplusplus implements both strategies. ------------- Features list This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |