https://github.com/CastXML/CastXML

C-family Abstract Syntax Tree XML Output
https://github.com/CastXML/CastXML

Last synced: 17 days ago
JSON representation

C-family Abstract Syntax Tree XML Output

• Host: GitHub
• URL: https://github.com/CastXML/CastXML
• Owner: CastXML
• License: apache-2.0
• Created: 2014-04-16T14:13:13.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-08-12T18:50:58.000Z (3 months ago)
• Last Synced: 2024-09-29T14:07:46.748Z (about 1 month ago)
• Language: C++
• Size: 1.51 MB
• Stars: 472
• Watchers: 33
• Forks: 89
• Open Issues: 13
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
CastXML

*******

Introduction

============

CastXML is a C-family abstract syntax tree XML output tool.

This project is maintained by `Kitware`_ in support of `ITK`_,

the Insight Segmentation and Registration Toolkit.

.. _`Kitware`: https://www.kitware.com/

.. _`ITK`: https://itk.org/

Manual

======

See the `castxml(1)`_ manual page for instructions to run the tool.

.. _`castxml(1)`: doc/manual/castxml.1.rst

License

=======

CastXML is licensed under the `Apache License, Version 2.0`_.

See the ``__ and ``__ files for details.

.. _`Apache License, Version 2.0`: https://www.apache.org/licenses/LICENSE-2.0

Superbuild

==========

If you are looking for pre-built binaries, or a compact way to build this

project, please see `CastXMLSuperbuild`_.

.. _`CastXMLSuperbuild`: https://github.com/CastXML/CastXMLSuperbuild

Build

=====

To build CastXML from source, first obtain the prerequisites:

* A C++ compiler supporting the ``c++11`` standard language level.

* `CMake`_ cross-platform build system generator.

* `LLVM/Clang`_ compiler SDK install tree built using the C++ compiler.

  This version of CastXML has been tested with LLVM/Clang

  - Git ``main`` as of 2024-03-06 (``f7d354af57``)

  - Release ``18.1``

  - Release ``17.0``

  - Release ``16.0``

  - Release ``15.0``

  - Release ``14.0``

  - Release ``13.0``

  - Release ``12.0``

  - Release ``11.0``

  - Release ``10.0``

  - Release ``9.0``

  - Release ``8.0``

  - Release ``7.0``

  - Release ``6.0``

  - Release ``5.0``

  - Release ``4.0``

  - Release ``3.9``

  - Release ``3.8``

  - Release ``3.7``

  - Release ``3.6``

* Optionally, the `Sphinx`_ documentation generator to build documentation.

Run CMake on the CastXML source tree to generate a build tree using

a C++ compiler compatible with that used to build the LLVM/Clang SDK.

CMake options include:

``Clang_DIR``

  Location of the LLVM/Clang SDK.  Set to ``/lib/cmake/clang``,

  where ```` is the top of the LLVM/Clang SDK install tree.

  Alternatively, ``LLVM_DIR`` may be set to ``/lib/cmake/llvm``.

``SPHINX_EXECUTABLE``

  Location of the ``sphinx-build`` executable.

  Required only if building documentation.

``SPHINX_HTML``

  Build documentation in ``html`` format.

``SPHINX_MAN``

  Build documentation in ``man`` format.

Run the corresponding native build tool (e.g. ``make``) in the CastXML

build tree, and optionally build the ``install`` target.  The ``castxml``

command-line tool may be used either from the build tree or the install tree.

The install tree is relocatable.

.. _`CMake`: https://cmake.org/

.. _`LLVM/Clang`: https://clang.llvm.org/

.. _`Sphinx`: https://www.sphinx-doc.org/