Metadata-Version: 2.1
Name: robotpy-cppheaderparser
Version: 5.1.2
Summary: Parse C++ header files and generate a data structure representing the class
Home-page: https://github.com/robotpy/robotpy-cppheaderparser
Author: Jashua Cloutier
Author-email: jashuac@bellsouth.net
Maintainer: RobotPy Development Team
Maintainer-email: robotpy@googlegroups.com
License: BSD
Keywords: c++ header parser ply
Platform: Platform Independent
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: C++
Classifier: License :: OSI Approved :: BSD License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Software Development :: Compilers
Classifier: Topic :: Software Development :: Disassemblers
Requires: ply
Requires-Dist: ply

robotpy-cppheaderparser
=======================

**robotpy-cppheaderparser is DEPRECATED, and we are no longer updating it**.
We will accept pull requests that have fixes and appropriate tests, but we
will no longer be making any fixes ourselves.

We highly recommend all current and future users to migrate to cxxheaderparser,
which supports all the syntax that CppHeaderParser does and much much more. The
parser output is very different, but it is strictly typed and hopefully easier
to work with. You can find it at https://github.com/robotpy/cxxheaderparser,
or try the live interactive demo at https://robotpy.github.io/cxxheaderparser/

---------

CppHeaderParser is a pure python C++ header parser that parses C++
headers and creates a data structure that you can use to do many types
of things. We’ve found it particularly useful for creating programs that
generate python wrappers around existing C++ programs.

robotpy-cppheaderparser is a fork of the `CppHeaderParser`_ library
originally created by @senex. CppHeaderParser is an excellent library
and critical to some of the stuff we do in the RobotPy project.
Unfortunately, the maintainer seems to be busy, so
robotpy-cppheaderparser was born.

We aim to maintain (some) compatibility with the existing code and make
improvements and bugfixes as we need them -- though some decisions made
early on in this code's development means some compatibility may be broken
as things get fixed.

If you find an bug, we encourage you to submit a pull request! New
changes will only be accepted if there are tests to cover the change you
made (and if they don’t break existing tests).

.. note:: CppHeaderParser only does some very minimal interpretation of
          preprocessor directives -- and we're looking at removing some
          of that from this library. If you need anything complex, you
          should preprocess the code yourself. You can use the excellent
          pure python preprocessor `pcpp`_, or the preprocessing facilities
          provided by your favorite compiler.

Documentation
-------------

Documentation can be found at https://cppheaderparser.readthedocs.io

Install
-------

::

   pip install robotpy-cppheaderparser

License
-------

BSD License

Authors
-------

Originally developed by Jashua Cloutier, this fork is maintained by the
RobotPy project.

Past contributors include:

* Jashua Cloutier
* Chris Love
* HartsAntler

.. _CppHeaderParser: https://bitbucket.org/senex/cppheaderparser

.. _pcpp: https://github.com/ned14/pcpp


