Changes¶
Introduction¶
The original author and maintainer for pygccxml was Roman Yakovenko (2004-2011). Holger Frydrych forked the project to work on python 3 support. Finally, Mark Moll forked the project a second time to carry on the work of porting the code to python 3 (keeping it compatible with python 2). In Mai 2014, Michka Popoff and the Insight Software Consortium revived pygccxml by setting up a git repositery on github, hosted along with gccxml.
Version 1.7.4¶
- CV-qualified arrays were not being handled correctly by type traits manipulations functions. For instance, ‘int const[N]’ would not be detected as ‘const’. Similar problems existed for volatile qualified arrays too. See #35 for more details. A newer version of CastXML is recommended (xml output version >= 1.138)
- Close subprocess stdout stream once value has been read. Fixes some warnings under python3.
- Since this release, pyggcxml’s version numbers do not contain the
v
prefix anymore. This was breaking distribution on PyPI (pypi.python.org). - The documentation is now at http://pygccxml.readthedocs.io/
Thanks to the following people for their contribution to this release: Ashish Sadanandan
Version 1.7.3¶
- Addition of an is_union() method in the type_traits module.
- type_traits.smart_pointer_traits will now classify std::shared_ptr as a smart pointer (only boost::shared_ptr was recognized before)
- Fix a regression in undname_creator_t.format_argtypes
- C++xx flags are now correctly passed to CastXML. Allowed flags are: “-std=c++98”, “-std=c++03”, “-std=c++11”, “-std=c++14”, “-std=c++1z” Thanks to Mark Moll for the fix.
- Add better support for “typedef (class|struct) {} foo;” syntax when using CastXML. GCCXML did not recognize the typedef. Fetching these declarations can now be done with: .typedef(“foo”) or .class_(“foo”).
- Add support for the future llvm 3.9. As in release v1.7.1, new structs and
typedefs are now exposed by llvm, which broke pyplusplus.
In this case these are
`__NSConstantString_tag`
and`__NSConstantString`
. The two declarations are now hidden from the declarations tree, but can still be generated by using theconfig.flags = ["f1"]
option. - Multiple fixes to adapt default arguments in functions for py++. Using the latest version of CastXML is recommended. This makes sure default arguments for function parameters are correctly defined, so that py++ can process them.
- Fix for exception when using castxml + gcc5 + std=c++11 and maps.
- Removed unittest2 dependency for testing with python 2.6
- Testing: test with std::tr1 unordered containers for gcc >= 4.4.7 and castxml
- Cosmetic fix for generator name printed to stdout when launching unit tests
- Fix simple typo in example.py comment
Thanks to the following people for their contribution to this release: Mark Moll, Ashish Sadanandan, Mark Oates
Version 1.7.2¶
- Fix exception in is_copy_constructor when the constructor’s argument was a typedef. is_copy_constructor will now return False instead of failing. See issue #27.
- Fix bug with utils.xml_generator being unset when reading cached file. This could for example happen when reading a cached file from a second python interpreter (e.g. in a subprocess or by calling pygccxml multiple times from a script). See issue #27.
- SafeConfigParser is throwing a deprecation warning in python 3.2 and newer. Use ConfigParser instead. Thanks to Mark Moll for the patch.
- Add support for cflags property in config files. Thanks to Mark Moll for the patch.
Version 1.7.1¶
Remove the __va_list_tag declaration from the tree when parsing with CastXML
The __va_list_tag declarations are internal declarations, which are often not needed. They are for example polluting the declarations tree when running pyplusplus.
This is optional but on by default. To still load the __va_list_tag declarations in the tree, a config flag can be set like this:
config.flags = ["f1"]
, or by passing theflags=["f1"]
argument the config setup.Some code cleanup
Build new package for pypi. The
1.7.0
upload has gone wrong ...
Version 1.7.0¶
Added support for CastXML (https://github.com/CastXML/CastXML)
GCCXML is deprecated and does no more work with modern compilers. CastXML should be used instead.
pygccxml 1.7.0
is still compatible with GCCXML and no changes are needed for people working with GCCXML.[CastXML] A new function was introduced to help find which XML generator you are using.
If the generator (GCCXML or CastXML) is in your path, it will be detected.
generator_path, generator_name = pygccxml.utils.find_xml_generator()
[CastXML] When using the configuration, you will need to tell pygccxml which xml generator you are using.
xml_generator_config = parser.xml_generator_configuration_t( xml_generator_path=generator_path, xml_generator=generator_name, )
gccxml_configuration_t
is an alias ofxml_generator_configuration_t
.
load_gccxml_configuration
is an alias ofload_xml_generator_configuration
.Both can still be used but will be deprecated.
[CastXML] The compiler path can be passed to castxml.
This is done by using the
compiler_path
attribute in the configuration. Note that this may be important because the resulting xml file is slightly different depending on the compiler.[CastXML] Added support for some fields which have no location.
These fields are:
gp_offset
,fp_offset
,overflow_arg_area
,reg_save_area
[CastXML] Mangled names are only available for functions and variables with CastXML.
Getting the mangled attribute on adeclaration
will fail.
- [CastXML] Demangled names are not available.
Getting a demangled name will fail.
- [CastXML] Add new container traits:
unordered maps
,unordered sets
,multimaps
,multisets
- [CastXML] Annotations:
Instead of using the__attribute((gccxml("string")))
c++ syntax (see version 0.9.5), the__attribute__ ((annotate ("out")))
can now be used to annotate code with CastXML.
[CastXML] Disabled relinking of:
rebind<std::__tree_node<std::basic_string<char>, void *> >
This made thefind_container_traits_tester
unit tests fail withCastXML
. This class defintion is present in the clang AST tree, but I don’t know why it is usefull. Please tell me if you need it so we can re-enable that featur in pygccxml.
- [Misc] Deprecated the
compiler
attribute and replaced it with a globalutils.xml_generator
variable.
The
compiler
attribute was misleading; it was sometimes confused with the name and version of the xml generator.This change also fixes some internal problems with the algorithms cache.
- [Misc]
declarations.has_trivial_copy
was defintevely removed.
Please use
declarations.has_copy_constructor
.This was deprecated since version 0.9.5.
- [Misc] Remove
gccxml
logger from logger class (was deprecated).
Please usecxx_parser
instead.
- [Misc] Removed
gccxml_runtime_error_t
class. This was only used internally.
Please use a normalRuntimeError
instead.
- [Misc] Documentation was moved to readthedocs.org
- [Misc] Add quantifiedcode check
- [Misc] Add option to keep xml files after errors, which is useful for debugging purposes.
- [Misc] Fix new pep8 warnings, clean up and simplify some code and comments
- [Misc] The compiler version debugging message is now hidden (closes #12)
- [Misc] Print less line separations in
decl_printer
; this makes the output more compact. - [Tests] Add new test for the
contains_parent_dir
function. - [Tests] Add test for non copyable class with const class
- [Tests] Add test case for non copyable class due to const array
- [Doc] Small documentation update, moved people list to credits page, added new examples.
- [Misc] Add Travis unit tests for Python 3.5
Version 1.6.2¶
- Use setuptools instead of distutils for the packaging
- Change rights of declarations_cache.py and templates_tester.py from -rwxr-xr-x+ to -rw-r–r–+, so that all the files have the same execution rights.
Version 1.6.1¶
- Fix a regression introduced by previous changes. Syntax errors were introduced in the part were you can check if a class is copyable or not (see #13). These have been fixed now.
Version 1.6¶
Moved the repository from mercurial to git
Changed the documentation from epydoc to sphinx doc
Setup the documentation as gh-page and add script to update the documentation Just call “make gh-pages” on the root folder to create a commit with the new documentation, which you may then push to the github repository. The url for the documentation is now http://gccxml.github.io/pygccxml/
Add Travis unit tests for Python 2.6, 2.7, 3.2, 3.3 and 3.4 The tests are run after each commit (see .travis.yml file in root folder) https://travis-ci.org/gccxml/pygccxml
Add automatic code coverage. The code coverage is run during each travis run and the results are uploaded to https://coveralls.io/r/gccxml/pygccxml
Fix copy_constructor unit test
Deprecate parser.config_t (replaced by parser.gccxml_configuration_t)
Fix for string comparison with future unicode literals When using from __future__ import unicode_literals in python 2.7, the call to the namespace() method would fail due to the isinstance/str check.
A is_str() function was added to the utils module, allowing for a python 2 and python 3 compatible string check. A unit test for this case was added.
All the code is now pep8 compliant and is tested for this in an unit test
Most of unused imports and variables were removed using the pyflakes tool
Use new style python decorators (@property) everywhere
Add new unit test for the example.py file
Update the licence headers to reflect the change in maintainers
Version 1.5.2¶
Make python 3.x compatible. Still works with python 2.6 and python 2.7.
Add .dylib parser for Darwin
Fix some unit tests
workaround for problem with boost >=1.54
Simpler way of checksumming files in a python 2 and 3 compatible way
Prevent warnings to be treated as fatal errors in py++
“has_inline” property was added to
declarations.calldef_t
class.Thanks to Aron Xu, for pointing out that it is better to use “os.name”, instead of “sys.platform” for platform specific logic.
- “__int128_t” and “__uint128_t” types were introduced. Many thanks to Gustavo Carneiro
for providing the patch.
Version 1.5.1¶
- adding problematic use case, contributed by Zbigniew Mandziejewicz
- Adding “explicit” attribute to constructor_t class
- “List symbols” (nm) utility invocation was improved and now handles right relative paths and paths with spaces. Many thanks to Alejandro Dubrovsky for providing the patch.
- Fix for “get dependencies” functionality
- Allow the process to continue, even in case the binary parser can not find the relevant declaration
- Fix bug related to merging free functions
- Improve decl_printer - sort declarations before printing
- Added new tests and ported tests to x86_64 architecture
Version 1.5.0¶
- Fix small bug in matcher - don’t match namespaces by their location
- Documentation update and cleanup. (using sphinx-doc now).
- Fixing small bug on Windows, related to parsing configuration file
- Update setup.py
- fix 2779781 bug( pygccxml reverses array dimensions )
Note about version numbers before 1.5.0¶
When the project moved from svn to git, versions were tagged from 1.0.0 on. Note that there was no 1.2, 1.3 nor 1.4 version (this is maybe due to the many forks and the slow down of the maintenance effort).
Version 1.1.0¶
- bsc and mspdb packages were deprecated
- Adding new functionality and improving initial environment handling
- Adding ability to dump exported classes
- Added more tests
- Add handling for “C” functions
- Fix bug “pygccxml parses const volatile variable args as just const”
- Rename bparser to binary_parsers
- Adding .so file parser
- Replace md5 with hashlib module (removes deprecation warnings)
Version 1.0¶
Support for ellipsis was added.
Warning: this feature introduce backward compatibility problem!
Description:
void do_smth( int, ... )
Before this change, pygccxml would report that the function
do_smth
has only one argument.After this change, pygccxml will report that the function has two arguments. The second argument type will be
declarations.ellipsis_t
. All classes, which describe callables, have new propertyhas_ellipsis
. It the value of the property isTrue
, than the function has ellipsis in its definition.New experimental back-end, based on
.pdb
(progam database file), was added.New high-level API wrapper for
.bsc
(browse source code file) was added.The recomended GCC_XML version to use with this release is CVS revision 123. This revision introduces small, but very important feature. GCC_XML started to dump artificial declarations (constructor, destructor, operator=).
pygccxml.declarations.type_traits
functions were updated to use the new information.declarations.decl_printer_t
class dumps almost all available information about a declaration.declarations.is_same_function
was fixed and now it treats “covariant returns” right.Search algorithm was improved for template instantiated classes. From now, a spaces within the class name doesn’t matter.
pygccxml unit tests functionality was improved. Many thanks to Gustavo Carneiro.
Version 0.9.5¶
- Class
free_operator_t
is now able to provide references to the class declarations instances it works on. - Support for GCC-XML attributes was added. Many thanks to Miguel Lobo for the implementation.
- A bug in parsing a function exception specification was fixed. Many thanks to Jeremy Sanders.
- Support for a type/class “align”, “offset” and “size” was added. Many thanks to Ben Schleimer for the implementation.
- Support for GCC-XML 0.9 was added.
- Support for
__restrict__
was added. declarations.has_trivial_copy
was renamed todeclarations.has_copy_constructor
. The old name is still available, but will be removed soon.declarations.priority_queue
was renamed todeclarations.priority_queue_traits
.declarations.find_container_traits
function was added.- Support for “partial name” was added. “Partial name” is the class name, without template default arguments. The functionality was added to std containers classes.
declarations.class_t
anddeclarations.class_declaration_t
has new property -container_traits
. This property describes std container element class.- All logging is now done to
stderr
instead ofstdout
.
Version 0.9.0¶
- Performance was improved. pygccxml is now 30-50% faster. The improvement
was achieved by using cElementTree package,
iterparse
functionality, instead of standard XML SAX API. If cElementTree package is not available, the built-in XML SAX package is used.
is_base_and_derived
function was changed. The second argument could be a tuple, which contains classes. The function returnsTrue
if at least one class derives from the base one.
- Class
calldef_t
has property -does_throw
. It describes whether the function throws any exception or not.
- Bug fixes: small bug was fixed in functionality that corrects GCC-XML reported function default arguments. Reference to “enum” declaration extracted properly. Many thanks to Martin Preisler for reporting the bug.
- New type traits have been added:
is_std_ostream
is_std_wostream
- C++ does not define implicit conversion between an integral type and
void*
.declarations.is_convertible
type traits was fixed.
declarations.is_noncopyable
type traits implementation was slightly changed. Now it checks explicitly that class has:- default constructor
- copy constructor
operator=
- destructor
If all listed functions exist, than the algorithm returns
False
, otherwise it will continue to execute previous logic.
declarations.class_declaration_t
has new property -aliases
. This is a list of all aliases to the class declaration.
- The message of the exception, which is raised from
declarations.mdecl_wrapper_t
class was improved and now clearly explains what the problem is.
Version 0.8.5¶
Added new functionality: “I depend on them”. Every declaration can report types and declarations it depends on.
signed char
andchar
are two different types. This bug was fixed and now pygccxml treats them right. Many thanks to Gaetan Lehmann for reporting the bug.Declarations, read from GCC-XML generated file, could be saved in cache.
New type traits have been added:
is_bool
Small improvement to algorithm, which extracts
value_type
(mapped_type
) from “std” containers.Few aliases to long method name were introduced:
Name Alias scopedef_t.variable
scopedef_t.var
scopedef_t.variables
scopedef_t.vars
scopedef_t.member_function
scopedef_t.mem_fun
scopedef_t.member_functions
scopedef_t.mem_funs
scopedef_t.free_function
scopedef_t.free_fun
scopedef_t.free_functions
scopedef_t.free_funs
Fixing bug related to array size and cache.
Version 0.8.2¶
- Few small bug fix and unit tests have been introduced on 64 Bit platforms.
Many thanks to Gottfried Ganssauge! He also help me to discover and fix
some important bug in
type_traits.__remove_alias
function, by introducing small example that reproduced the error. - Huge speed improvement has been achieved (x10). Allen Bierbaum suggested to
save and reuse results of different pygccxml algorithms:
declarations.remove_alias
declarations.full_name
declarations.access_type
declarations.demangled_name
declarations.declaration_path
- Interface changes:
declarations.class_t
:
set_members
method was removedadopt_declaration
method was introduced, instead ofset_members
declarations.array_t
class “set” accessor for size property was added.declarations.namespace_t.adopt_declaration
method was added.declarations.variable_t.access_type
property was added.
- New type traits have been added:
is_same_function
- Few bug were fixed.
- Documentation was improved.
Version 0.8.1¶
pygccxml has been ported to MacOS X. Many thanks to Darren Garnier!
New type traits have been added:
enum_traits
class_traits
class_declaration_traits
is_std_string
is_std_wstring
remove_declarated
has_public_less
has_public_equal
has_public_binary_operator
smart_pointer_traits
list_traits
deque_traits
queue_traits
priority_queue
vector_traits
stack_traits
map_traits
multimap_traits
hash_map_traits
hash_multimap_traits
set_traits
hash_set_traits
multiset_traits
hash_multiset_traits
enumeration_t
class interface was changed. Enumeration values are kept in a list, instead of a dictionary.get_name2value_dict
will build for you dictionary, where key is an enumeration name, and value is an enumeration value.This has been done in order to provide stable order of enumeration values.
Now you can pass operator symbol, as a name to query functions:
cls = global_namespace.class_( 'my_class' ) op = cls.operator( '<' ) #instead of op = cls.operator( symbol='<' )
pygccxml 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
Support to Java native types has been added.
It is possible to pass an arbitrary string as a parameter to GCC_XML.
Native java types has been added to fundamental types.
Cache classes implementation was improved.
Few bug were fixed.
Documentation was improved.
mdecl_wrapper_t.decls
property was renamed todeclarations
. The reason is that the current name (decls
) conflicts with the method of the same name in the decl interface fromdeclarations.scopedef_t
class.So for example:
classes = ns.decls("class") classes.decls("method")
This will fail because it finds the attribute decls which is not a callable.
Version 0.8¶
- pygccxml now has power “select” interface. Read more about this cool feature in tutorials.
- Improved support for template instantiations. pygccxml now take into account demangled name of declarations. Please refer to documentation for more explanantion.
dummy_type_t
- new type in types hierarchy. This is a very useful class for code generation projects.- New function -
get_global_namespace
. As you can guess, it will find and return reference to global namespace. - New functionality in
type_traits
-has_public_assign
. This function will return True, if class has public assign operator. declarations.class_t
has new property -aliases
. This is a list of all class aliases.- Bug fixes.
- Documentation has been updated/written/improved.
Version 0.7.1¶
Attention - this going to be last version that is tested with Python 2.3
New fundamental types has been added
- complex float
- complex double
- complex long double
Attention - non backward compatible change
declarations.filtering.user_defined
anddeclarations.filtering.by_location
implementation has been changed. In previous version of those functions,decls
list has been changed in place. This was wrong behavior. Now, those functions will return new list, which contains all desired declarations.Few new type traits has been added
- type_traits.has_destructor
- type_traits.has_public_destructor
- type_traits.has_public_constructor
- type_traits.is_noncopyable
decl_printer_t
class andprint_declarations
function have been added. Now you can print in a nice way your declaration tree or part of it. Thanks to Allen Bierbaum!New class
declarations.decl_factory_t
has been added. This is a default factory for all declarations. From now all relevant parser classes takes as input instance of this class orNull
. In case ofNull
instance ofdeclarations.decl_factory_t
will be created. Using this class you can easily extend functionality provided by built-in declarations.Sometimes, there is a need to find a declaration that match some criteria. The was such functionality in pygccxml, but it was too limited. This release fix the situation. pygccxml adds a set of classes that will help you to deal with this problem.
New cache -
parser.directory_cache_t
has been implemented.parser.directory_cache_t
uses individual files stored in a dedicated cache directory to store the cached contents. Thanks to Matthias Baas!parser.file_cache_t
has been improved a lot. Thanks to Allen Bierbaum!New file configuration is available: “cached source file”.
parser.project_reader_t
class will check for existence of GCC_XML generated file. If it does not exist it will create one. If it do exist, then the parser will use that file.Few helper functions has been added in order to make construction of configuration file to be as easy as possible:
parser.create_text_fc
- creates file configuration, that contains textparser.create_source_fc
- creates file configuration, that contains reference to regular source fileparser.create_gccxml_fc
- creates file configuration, that contains reference to GCC_XML generated fileparser.create_cached_source_fc
- creates file configuration, that contains reference to 2 files: GCC_XML generated file and regular source file
Small bug fixes.
Documentation. Allen Bierbaum and Matthias Baas contributed so much in this area. Almost every public function/class has now documentation string.
Logging functionality has been added. pygccxml creates new logger “pygccxml”. Now it is possible to see what pygccxml is doing right now.
I am sure I forgot something.
Version 0.6.9¶
- New functions:
- type_traits.is_void_pointer
- type_traits.array_size
- type_traits.array_item_type
- Class declarations.variable_t has new property - bit_fields
- Now it is possible to specify “undefined” directives using parser.config_t class.
- patch functionality has been introduced. GCC_XML generates wrong default values for function arguments. patch functionality tries to fix this.
- Small bug fixes
Version 0.6.8¶
- Small bug has been fixed.
Version 0.6.7¶
New functions:
- type_traits.remove_pointer
- type_traits.base_type
- type_traits.is_convertible
A lot of small bug fixes.
Few English mistakes have been fixed.
Attention
There are 2 none backward compatible changes:
- class with name compaund_t has been renamed to compound_t
- word pathes has been replaced with paths
There are new properties on
- declarations.declaration_t.top_parent
- declarations.class_t.recursive_bases returns all base classes of the class
- declarations.class_t.recursive_derived returns all derived classes of the class
- member_calldef_t.access_type
New type has been introduced: unknown_t. There are use cases when GCC_XML does not returns function return type.
New implementation of make_flatten algorithm using generators. By default old implementation will be used.
parser.file_configuration_t interface has been changed. Now it is able to keep: source file, text or GCC_XML generated file. If you are doing something with code that is not changing you’d better use GCC_XML generated file as content of the parser.file_configuration_t. Save your time.
There are some cases when GCC_XML reports “restricted”. In this case pygccxml replaces “restricted” with “volatile”.