Content-type: text/html Manpage of flatten

flatten

Section: Misc. Reference Manual Pages (l)
Updated: January 12, 2021
Index Return to Main Contents

NAME

flatten - Script to combine multiple source files for RISC compiler

SYNOPSIS

flatten [ options ]

DESCRIPTION

flatten is a tool designed to generate a single compilable file for the Recoding Infrastructure for SystemC (RISC) compiler. flatten takes multiple source files from the user based on the include preprocessor directives in each file, and outputs a single combined source file with the included files inserted in correct order. flatten also supports displaying the graph of the file inclusion as well as auto-detecting the main file.

For example, to flatten and view the inclusion structure of multiple source files of a given design, use the following command:

flatten -i main.cc -o output.cc -g

flatten displays the inclusion tree as text in the terminal with each included filename and their parents.

ARGUMENTS

If no argument is provided, the flatten script will scan for a "main" file; if not found or multiple files that contain "main" are found, the script will terminate and ask for manual input.

OPTIONS

-h: use this argument to print a brief message on the usage of the tool and quit
-v: use this argument to print a list of included files
-g: use this argument to print a graph (tree) of the dependencies
-x: use this argument to auto-compile the flattened file using RISC
-i [input]: use this argument to indicate the main file, no need to input multiple files
-o [output]: use this argument to change the name of the output file; if omitted, this defaults to "Main_flat.cpp"
-d: use this argument to turn on debug mode, display important internal data

VERSION

flatten is release version 0.6.3.

AUTHORS

Yutong (Tom) Wang <yutongw5@uci.edu>

COPYRIGHT

LICENSE

Open source BSD license terms apply.

BUGS, LIMITATIONS

This is an academic proof-of-concept prototype implementation, not commercial-quality software.

This document was created by man2html, using the manual pages.
Time: 02:47:04 GMT, August 19, 2021