[pygccxml-commit] SF.net SVN: pygccxml: [153] pygccxml_dev/docs/query_api.rest
Brought to you by:
mbaas,
roman_yakovenko
|
From: <rom...@us...> - 2006-05-23 14:37:56
|
Revision: 153 Author: roman_yakovenko Date: 2006-05-23 07:37:46 -0700 (Tue, 23 May 2006) ViewCVS: http://svn.sourceforge.net/pygccxml/?rev=153&view=rev Log Message: ----------- updating docs Modified Paths: -------------- pygccxml_dev/docs/query_api.rest Modified: pygccxml_dev/docs/query_api.rest =================================================================== --- pygccxml_dev/docs/query_api.rest 2006-05-23 06:55:34 UTC (rev 152) +++ pygccxml_dev/docs/query_api.rest 2006-05-23 14:37:46 UTC (rev 153) @@ -23,19 +23,19 @@ query = query & ~declarations.access_type_matcher_t( 'public' ) global_ns.member_functions( function=query, arg_types=[None, 'int &'] ) -As for me the example I gave was too complex. In many cases you will find your +As for me, the example I gave was too complex. In many cases you will find your self looking for one or many declarations using one or two properties of that declaration(s). For example: :: global_ns.namespaces( 'details' ) -This call will return all namespaces that have 'details' namespace. +This call will return all namespaces with name 'details'. ------------------- -How does it works? ------------------- - +-------------- +User interface +-------------- + As you already know, ``pygccxml.declarations`` packages defines next classes: * ``scopedef_t`` - base class for all classes, that can contain other declarations @@ -44,12 +44,36 @@ * ``class_t`` - derives from ``scopedef_t`` class, represents C++ class/struct. -``scopedef_t`` class defines query interface. Basicaly you can ask it about any -declaration it contains, even about some sub declarations. +So, the query methods defined on ``scopedef_t`` class could be used on instances +of ``class_t`` and ``namespace_t`` classes. + +I will explain the usage of ``member_function`` and ``member_functions`` methods. +The usage of other methods is very similar to them. Here is definition of those +methods: +:: + + def member_function( self, + name=None, + function=None, + return_type=None, + arg_types=None, + header_dir=None, + header_file=None, + recursive=None ) + + def member_functions( self, + name=None, + function=None, + return_type=None, + arg_types=None, + header_dir=None, + header_file=None, + recursive=None, + allow_empty=None ) + + + - - - .. _`pygccxml`: ./pygccxml.html .. _`SourceForge`: http://sourceforge.net/index.php .. _`Python`: http://www.python.org This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |