cpip 0.9.9

CPIP is a C/C++ Preprocessor implemented in Python.

CPIP

CPIP is a C/C++ Preprocessor implemented in Python. It faithfully records all aspects of preprocessing and can produce visualisations that make debugging preprocessing far easier.

Features

• Conformant C/C++ preprocessor.

• Gives programatic access to every preprocessing token and the state of the preprocessor at any point during preprocessing.

• Top level tools such as CPIPMain.py can generate preprocessor visualisations from the command line.

• Requires only Python 3.6+

• Fully documented: https://cpip.readthedocs.io.

• Free software: GNU General Public License v2

Installation

Install cpip from PyPi:

(CPIP) $ pip install cpip

This will give you access to the command line entry point cpipmain, to check this:

(CPIP) $ cpipmain --help
...

You can check CPIP on some demonstration C code, for example, from the CPIP directory there is a demo directory. You can process this thus:

(CPIP) $ cpipmain -l20 -j1 -o demo/output -J demo/sys/ -I demo/usr/ demo/src/main.cpp
2017-11-17 10:29:16,370 INFO     preprocessFileToOutput(): demo/src/main.cpp
2017-11-17 10:29:16,371 INFO     TU in HTML:
2017-11-17 10:29:16,372 INFO       tmp/output_normal_02/main.cpp.html
2017-11-17 10:29:16,391 INFO     preprocessFileToOutput(): Processing TU done.
2017-11-17 10:29:16,391 INFO     Macro history to:
2017-11-17 10:29:16,391 INFO       tmp/output_normal_02
2017-11-17 10:29:16,400 INFO     Include graph (SVG) to:
2017-11-17 10:29:16,401 INFO       tmp/output_normal_02/main.cpp.include.svg
2017-11-17 10:29:16,423 INFO     Writing include graph (TEXT) to:
2017-11-17 10:29:16,423 INFO       tmp/output_normal_02/main.cpp.include.svg
2017-11-17 10:29:16,424 INFO     Conditional compilation graph in HTML:
2017-11-17 10:29:16,424 INFO       tmp/output_normal_02/main.cpp.ccg.html
2017-11-17 10:29:16,431 INFO     Done: demo/src/main.cpp
2017-11-17 10:29:16,432 INFO     ITU in HTML: .../main.cpp
2017-11-17 10:29:16,448 INFO     ITU in HTML: .../system.h
2017-11-17 10:29:16,453 INFO     ITU in HTML: .../user.h
2017-11-17 10:29:16,462 INFO     preprocessFileToOutput(): demo/src/main.cpp DONE
CPU time =    0.087 (S)
Bye, bye!

The result will be in demo/output/index.html.

There are other installation methods including directly from source.

Visualising Preprocessing

The top level entry point cpipmain (the script CPIPMain.py) acts like a preprocessor that generates HTML and SVG output for a source code file or directory. This output makes it easy to understand what the preprocessor is doing to your source.

Here is some of that output when preprocessing a single Linux kernel file cpu.c (complete output). The index.html page shows how CPIPMain.py was invoked [1], this has a link to to preprocessing pages for that file:

This page has a single link that takes you to the landing page for the file cpu.c, at the top this links to other pages that visualise source code, #include dependencies, conditional compilation and macros:

Lower down this page is a table of files that were involved in preprocessing:

Visualising the Source Code

From the cpu.c landing page the link “Original Source” takes you to a syntax highlighted page of the original source of cpu.c.

The cpu.c landing page link “Translation Unit” takes you to a page that shows the complete translation unit of cpu.c (i.e. incorporating all the #include files). This page is annotated so that you can understand what part of the translation unit comes from which file.

Visualising the #include Dependencies

The cpu.c landing page link “Normal [SVG]” takes you to a page that shows the dependencies created by #include directives. This is a very rich page that represents a tree with the root at center left. #include’s are in order from top to bottom. Each block represents a file, the size is proportional to the number of preprocessing tokens.

Zooming in with the controls at the top gives more detail. If the box is coloured cyan it is because the file does not add any content to the translation unit, usually because of conditional compilation:

The page is dynamic and hovering over various areas provides more information:

How and Why the File was Included

Hovering just to the left of the file box produces a popup that explains how the file inclusion process worked for this file, it has the following fields:

• Inc: The filename and line number of the #include directive.

• As: The conditional compilation state at the point of the #include directive.

• How: The text of the #include directive followed by the directory that this file was found in, this directory is prefixed by sys= for a system include and usr= for a user include.

Hovering over the filename above the file box shows the file stack (children are below parents).

This plot can also tell you what types of preprocessor tokens were processed for each file. The coloured bars on the left of the file box indicate the proportion of preprocessing token types, the left is the file on its own, the right is the file and its child files. To understand the legend hover over those bars:

To see the actual count of preprocessing tokens hover over the file box:

Visualising Conditional Compilation

The preprocessor is also responsible for handling conditional compilation which becomes very complicated for large projects. CPIPMain.py produces a succinct representation showing only the conditional directives. The links in each comment takes you to the syntax highlighted page for that file.

Understanding Macros

CPIP tracks every macro definition and usage and CPIPMain.py produces a page that describes all the macros encountered:

Each link on the page takes you to a description of the macro containing:

• The macro name, how many times it was referenced and whether it is still defined at the end of preprocessing.

• The verbatim macro definition (rewritten over several lines for long macros).

• File name and line number of definition, linked.

• Places that the macro was used, directly or indirectly. This is a table of file paths with links to the use point.

• Dependencies, two way:

  • Macros that this macro invokes.

  • Macros that invoke this macro.

Status

Licence

CPIP is a C/C++ Preprocessor implemented in Python. Copyright (C) 2008-2017 Paul Ross

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Also many thanks to SourceForge that hosted this project for many years.

Footnotes

[1]

This was invoked by:

$ python3 CPIPMain.py -kp -l20 -o ../../output/linux/cpu -S __STDC__=1 -D __KERNEL__ -D __EXPORTED_HEADERS__ -D BITS_PER_LONG=64 -D CONFIG_HZ=100 -D __x86_64__ -D __GNUC__=4 -D __has_feature(x)=0 -D __has_extension=__has_feature -D __has_attribute=__has_feature -D __has_include=__has_feature -P ~/dev/linux/linux-3.13/include/linux/kconfig.h -J /usr/include/ -J /usr/include/c++/4.2.1/ -J /usr/include/c++/4.2.1/tr1/ -J /Users/paulross/dev/linux/linux-3.13/include/ -J /Users/paulross/dev/linux/linux-3.13/include/uapi/ -J ~/dev/linux/linux-3.13/arch/x86/include/uapi/ -J ~/dev/linux/linux-3.13/arch/x86/include/ -J ~/dev/linux/linux-3.13/arch/x86/include/generated/ ~/dev/linux/linux-3.13/kernel/cpu.c

History

0.9.9 Beta Release (2022-12-16)

• Add strip_comments.py

• Add support for Python3 versions. Supported versions 3.6, 3.7, 3.8, 3.9, 3.10, 3.11.

• Remove support for Python 2.7 (although it might still work).

0.9.8 Beta Release (2021-01-28)

• Minor fixes.

0.9.7 Beta Release (2017-10-04)

• Minor fixes.

• Performance optimisations.

• Builds the CPython source tree in 5 hours with 2 CPUs.

• Documentation improvements.

0.9.5 Beta Release (2017-10-03)

• Migrate from sourceforge to GitHub.

0.9.1 (2014-09-03)

Version 0.9.1, various minor fixes. Tested on Python 2.7 and 3.3.

Alpha Plus Release (2014-09-04)

Fairly thorough refactor. CPIP now tested on Python 2.7, 3.3. Version 0.9.1. Updated documentation.

Alpha Release (2012-03-25)

Very little functional change. CPIP now tested on Python 2.6, 2.7, 3.2. Added loads of documentation.

Alpha Release (2011-07-14)

This is a pre-release of CPIP. It is tested on BSD/Linux, it will probably work on Windows (although some unit tests will fail on that platform).

Project started in 2008.