pygccxml-development

[pygccxml-development] C++ wiki like editor using pygccxml

[rodrigo b. <rod...@gm...>]

Hi there,
I'm wondering if it is possible to do the link between the parsed C++
code and the original source code file when using pygccxml.

The idea would be to create a wikiwiki like editor for C++ code documentation.
Using a python C++ parser I could transform the source code into an
HTML representation, to render the documentation web page.

Then using the web interface the user could edit the comments in the
C++ source code to enhance the documentation (using a doxygen like
syntax).

Of course a database could be created and maintained on the flight to
provide cross references to different definitions in the source code.

The most difficult aspect of the idea seems to actually be able to
parse the C++ files and make the link between the definitions, the
comments and they actual position in the source code.

Do you thing it is possible to create such documentation system with
the existing tools ?

Regards,
rodrigob.
http://www-rocq.inria.fr/~benenson/

Re: [pygccxml-development] C++ wiki like editor using pygccxml

[Roman Y. <rom...@gm...>]

On 8/21/06, rodrigo benenson <rod...@gm...> wrote:
> Hi there,
> I'm wondering if it is possible to do the link between the parsed C++
> code and the original source code file when using pygccxml.

Yes of course, see next documents:
http://svn.sourceforge.net/viewvc/pygccxml/pyplusplus_dev/docs/documentation/doc_string.rest?view=markup

And some source code:
http://svn.sourceforge.net/viewvc/pygccxml/pygccxml_dev/pygccxml/declarations/declaration.py?view=markup

For every declaration, except namespace, pygccxml provides via
"location" property: full file name and line number

> The idea would be to create a wikiwiki like editor for C++ code documentation.
> Using a python C++ parser I could transform the source code into an
> HTML representation, to render the documentation web page.
>
> Then using the web interface the user could edit the comments in the
> C++ source code to enhance the documentation (using a doxygen like
> syntax).
>
> Of course a database could be created and maintained on the flight to
> provide cross references to different definitions in the source code.
>
> The most difficult aspect of the idea seems to actually be able to
> parse the C++ files and make the link between the definitions, the
> comments and they actual position in the source code.

There are few other: macros and templates

> Do you thing it is possible to create such documentation system with
> the existing tools ?

Decide yourself. GCC-XML does not provide information about function
bodies and expression,
only about declarations. May be this is enough may be not. May be the
better way to go is:
doxygen. It parsers C++ source files and dumps the information to xml
files. So users will be able
to comment implementation too.


-- 
Roman Yakovenko
C++ Python language binding
http://www.language-binding.net/

Re: [pygccxml-development] C++ wiki like editor using pygccxml

[rodrigo b. <rod...@gm...>]

VGhhbmtzIGZvciB5b3VyIHJlcGx5ICEKSXQgbG9va3MgZ3JlYXQuIFVzaW5nIHB5Z2NjeG1sKyBk
b2NfZXh0cmFjdG9yIEkgY2FuIG9idGFpbiwgZm9yIGV2ZXJ5CmZpbGUgaW4gdGhlIGNvZGU6Ci0g
QWxsIHRoZSBkZWNsYXJhdGlvbnMKLSBUaGV5IGV4YWN0IGxvY2F0aW9uIGluIHRoZSBzb3VyY2Ug
Y29kZQotIFRoZSBkb2N1bWVudGF0aW9uIGFzc29jaWF0ZWQgdG8gdGhlbQoKPlRoZXJlIGFyZSBm
ZXcgb3RoZXI6IG1hY3JvcyBhbmQgdGVtcGxhdGVzCgpXaGF0IGRvIHlvdSBtZWFuID8gSSBwcmVz
dW1lIHRoYXQgR2NjWG1sIHByb3ZpZGVzIHlvdXIgdGhlIGluZm9ybWF0aW9uIHBvc3QKTWFjcm8g
cGFyc2luZywgc28gcHJvYmFibHkgdGhleSBhcmUgbm90IGluY2x1ZGVkIGluIHRoZSBkZXNjcmlw
dGlvbgooI2RlZmluZSBQaSB3b3VsZCBub3QgYXBwZWFyKS4KCkJ1dCB0ZW1wbGF0ZXMgPyBTaW5j
ZSB5b3UgaGF2ZSB0aGUgZGVjbGFyYXRpb24gb2YgdGhlIHRlbXBsYXRlIGNsYXNzCm9mIGZ1bmN0
aW9uLCB3aGljaCBpcyB0aGUgYWN0dWFsIHByb2JsZW3vvJ8KClRoYW5rcyBmb3IgcG9pbnRpbmcg
b3V0LCBkb3h5Z2VuLiBXZSBhcmUgaW4gZGlzY3Vzc2lvbnMgd2l0aCBEb3h5cyAoYQpkb3h5Z2Vu
IGZvcmspIGd1eXMgdG8gZXZhbHVhdGUgYSAibGVzcyBvbi10aGUtZmxpZ2h0IiBhcHByb2FjaC4K
ClJlZ2FyZHMsCnJvZHJpZ29iLgoKT24gOC8yMS8wNiwgUm9tYW4gWWFrb3ZlbmtvIDxyb21hbi55
YWtvdmVua29AZ21haWwuY29tPiB3cm90ZToKPiBPbiA4LzIxLzA2LCByb2RyaWdvIGJlbmVuc29u
IDxyb2RyaWdvLmJlbmVuc29uQGdtYWlsLmNvbT4gd3JvdGU6Cj4gPiBIaSB0aGVyZSwKPiA+IEkn
bSB3b25kZXJpbmcgaWYgaXQgaXMgcG9zc2libGUgdG8gZG8gdGhlIGxpbmsgYmV0d2VlbiB0aGUg
cGFyc2VkIEMrKwo+ID4gY29kZSBhbmQgdGhlIG9yaWdpbmFsIHNvdXJjZSBjb2RlIGZpbGUgd2hl
biB1c2luZyBweWdjY3htbC4KPgo+IFllcyBvZiBjb3Vyc2UsIHNlZSBuZXh0IGRvY3VtZW50czoK
PiBodHRwOi8vc3ZuLnNvdXJjZWZvcmdlLm5ldC92aWV3dmMvcHlnY2N4bWwvcHlwbHVzcGx1c19k
ZXYvZG9jcy9kb2N1bWVudGF0aW9uL2RvY19zdHJpbmcucmVzdD92aWV3PW1hcmt1cAo+Cj4gQW5k
IHNvbWUgc291cmNlIGNvZGU6Cj4gaHR0cDovL3N2bi5zb3VyY2Vmb3JnZS5uZXQvdmlld3ZjL3B5
Z2NjeG1sL3B5Z2NjeG1sX2Rldi9weWdjY3htbC9kZWNsYXJhdGlvbnMvZGVjbGFyYXRpb24ucHk/
dmlldz1tYXJrdXAKPgo+IEZvciBldmVyeSBkZWNsYXJhdGlvbiwgZXhjZXB0IG5hbWVzcGFjZSwg
cHlnY2N4bWwgcHJvdmlkZXMgdmlhCj4gImxvY2F0aW9uIiBwcm9wZXJ0eTogZnVsbCBmaWxlIG5h
bWUgYW5kIGxpbmUgbnVtYmVyCj4KPiA+IFRoZSBpZGVhIHdvdWxkIGJlIHRvIGNyZWF0ZSBhIHdp
a2l3aWtpIGxpa2UgZWRpdG9yIGZvciBDKysgY29kZSBkb2N1bWVudGF0aW9uLgo+ID4gVXNpbmcg
YSBweXRob24gQysrIHBhcnNlciBJIGNvdWxkIHRyYW5zZm9ybSB0aGUgc291cmNlIGNvZGUgaW50
byBhbgo+ID4gSFRNTCByZXByZXNlbnRhdGlvbiwgdG8gcmVuZGVyIHRoZSBkb2N1bWVudGF0aW9u
IHdlYiBwYWdlLgo+ID4KPiA+IFRoZW4gdXNpbmcgdGhlIHdlYiBpbnRlcmZhY2UgdGhlIHVzZXIg
Y291bGQgZWRpdCB0aGUgY29tbWVudHMgaW4gdGhlCj4gPiBDKysgc291cmNlIGNvZGUgdG8gZW5o
YW5jZSB0aGUgZG9jdW1lbnRhdGlvbiAodXNpbmcgYSBkb3h5Z2VuIGxpa2UKPiA+IHN5bnRheCku
Cj4gPgo+ID4gT2YgY291cnNlIGEgZGF0YWJhc2UgY291bGQgYmUgY3JlYXRlZCBhbmQgbWFpbnRh
aW5lZCBvbiB0aGUgZmxpZ2h0IHRvCj4gPiBwcm92aWRlIGNyb3NzIHJlZmVyZW5jZXMgdG8gZGlm
ZmVyZW50IGRlZmluaXRpb25zIGluIHRoZSBzb3VyY2UgY29kZS4KPiA+Cj4gPiBUaGUgbW9zdCBk
aWZmaWN1bHQgYXNwZWN0IG9mIHRoZSBpZGVhIHNlZW1zIHRvIGFjdHVhbGx5IGJlIGFibGUgdG8K
PiA+IHBhcnNlIHRoZSBDKysgZmlsZXMgYW5kIG1ha2UgdGhlIGxpbmsgYmV0d2VlbiB0aGUgZGVm
aW5pdGlvbnMsIHRoZQo+ID4gY29tbWVudHMgYW5kIHRoZXkgYWN0dWFsIHBvc2l0aW9uIGluIHRo
ZSBzb3VyY2UgY29kZS4KPgo+IFRoZXJlIGFyZSBmZXcgb3RoZXI6IG1hY3JvcyBhbmQgdGVtcGxh
dGVzCj4KPiA+IERvIHlvdSB0aGluZyBpdCBpcyBwb3NzaWJsZSB0byBjcmVhdGUgc3VjaCBkb2N1
bWVudGF0aW9uIHN5c3RlbSB3aXRoCj4gPiB0aGUgZXhpc3RpbmcgdG9vbHMgPwo+Cj4gRGVjaWRl
IHlvdXJzZWxmLiBHQ0MtWE1MIGRvZXMgbm90IHByb3ZpZGUgaW5mb3JtYXRpb24gYWJvdXQgZnVu
Y3Rpb24KPiBib2RpZXMgYW5kIGV4cHJlc3Npb24sCj4gb25seSBhYm91dCBkZWNsYXJhdGlvbnMu
IE1heSBiZSB0aGlzIGlzIGVub3VnaCBtYXkgYmUgbm90LiBNYXkgYmUgdGhlCj4gYmV0dGVyIHdh
eSB0byBnbyBpczoKPiBkb3h5Z2VuLiBJdCBwYXJzZXJzIEMrKyBzb3VyY2UgZmlsZXMgYW5kIGR1
bXBzIHRoZSBpbmZvcm1hdGlvbiB0byB4bWwKPiBmaWxlcy4gU28gdXNlcnMgd2lsbCBiZSBhYmxl
Cj4gdG8gY29tbWVudCBpbXBsZW1lbnRhdGlvbiB0b28uCj4KPgo+IC0tCj4gUm9tYW4gWWFrb3Zl
bmtvCj4gQysrIFB5dGhvbiBsYW5ndWFnZSBiaW5kaW5nCj4gaHR0cDovL3d3dy5sYW5ndWFnZS1i
aW5kaW5nLm5ldC8KPgo=

Re: [pygccxml-development] C++ wiki like editor using pygccxml

[Roman Y. <rom...@gm...>]

On 8/21/06, rodrigo benenson <rod...@gm...> wrote:
> Thanks for your reply !
> It looks great. Using pygccxml+ doc_extractor I can obtain, for every
> file in the code:
> - All the declarations
> - They exact location in the source code
> - The documentation associated to them
>
> >There are few other: macros and templates
>
> What do you mean ? I presume that GccXml provides your the information post
> Macro parsing, so probably they are not included in the description
> (#define Pi would not appear).

You should ask you self what do your users expects? For example if macro
is used to hide platform differences or to introduce different code in
debug and release
mode. I think, users will prefer to see macro and not the code
generated by macro.
Optionally, you can provide "go down" functionality.

> But templates ? Since you have the declaration of the template class
> of function, which is the actual problem？

GCCXML only dumps template instantiations :-(. The problem with
templates is almost
same as with macros.

> Thanks for pointing out, doxygen. We are in discussions with Doxys (a
> doxygen fork) guys to evaluate a "less on-the-flight" approach.

Good luck

-- 
Roman Yakovenko
C++ Python language binding
http://www.language-binding.net/