Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 1.49 KB

README.rst

File metadata and controls

61 lines (38 loc) · 1.49 KB
Raw

Ixcode

A. About

This utility parses source files and constructs diagrams for each interesting function found. This diagram shows the basic blocks of that function making it easier to understand what the code is doing. Also, this can help in refactoring.

It is written in Python and requires PLY to be installed. On Ubuntu, the python-ply package is enough. the diagrams are created using DOT, thus graphviz has to be installed too.

B. Usage

Running ixcode without arguments a short usage will be given. Full usage is given by passing -h.

A run needs at least the name of the file to be parsed. The user can supply a list of interesting functions, only them would be graphed later.

Example:

./ixcode.py test/simple.c -o outdir

Use the -d argument only when writing a new grammar.

C. Bugs

  1. Some diagrams are hard to understand without using colors. It is a DOT limitation though.
  2. This tool assumes that the code compiles successfully. It uses a more permissive grammar than C's and may give wrong results if the code is not legal.
  3. C grammar is incomplete

D. TODO

  1. Parse enums, structs and unions, finish C grammar
  2. Parse and graph switch, case, continue and break.
  3. Add a config file for colors
  4. Add support for Python too.
  1. Add regexp support for function matching
  1. Create a more interesting presentation for the tool.
  1. Prepare for ROSEdu CDL
  1. Make this list into a GitHub issues series.