Synopsis Tutorial

Stefan Seefeld

Version 0.1


Table of Contents

1. Introduction
Inspecting code
The Abstract Syntax Tree
The synopsis processing pipeline
2. Using the synopsis tool
The synopsis executable
Parsing source code
Using comments for documentation
Miscellaneous
3. Scripting and extending synopsis
The AST
The Processor class
Composing a pipeline
Writing your own synopsis script
Importing all desired processors
Composing new processors
Defining new processors
Exposing the commands
4. Processor design
Python Parser
IDL Parser
Cpp Parser
C Parser
Cxx Parser
Linker
Comment Parsers
Dump Formatter
ASCII Formatter
Docbook Formatter
Dot Formatter
HTML Formatter
The Scope View
SourceCode Cross Referencing
SXR Formatter
5. Extending synopsis with the C++ API
A. Listing of all Processors and their parameters
Synopsis.Parsers.Python.Parser
Synopsis.Parsers.IDL.Parser
Synopsis.Parsers.Cpp.Parser
Synopsis.Parsers.C.Parser
Synopsis.Parsers.Cxx.Parser
Synopsis.Processors.Linker
Synopsis.Formatters.Dot.Formatter
Synopsis.Formatters.Dump.Formatter
Synopsis.Formatters.Docbook.Formatter
Synopsis.Formatters.Texinfo.Formatter
Synopsis.Formatters.HTML.Formatter
Synopsis.Formatters.SXR.Formatter