Synopsis - Synopsis.Formatters.Dot

# Module Synopsis.Formatters.Dot

Protected Functions Summary:
_rel(frm, to)
_convert_map(input, output, base_url)
convert map generated from Dot to a html region map.
_format(input, output, format)
_format_png(input, output)
_format_html(input, output, base_url)
generate (active) image for html.
Classes Summary:
class SystemError
Error thrown by the system() function.
class DotFileGenerator
class InheritanceGenerator
A Formatter that generates an inheritance graph.
class SingleInheritanceGenerator
A Formatter that generates an inheritance graph for a specific class.
class FileDependencyGenerator
class Formatter
Functions Summary:
system(command)
Run the command.
normalize(color)
Generate a color triplet from a color string.
light(color)
Attributes Summary:
verbose
debug
Protected Functions Details:
_rel(frm, to)
Find link to to relative to frm
_convert_map(input, output, base_url)
convert map generated from Dot to a html region map. input and output are (open) streams
_format_html(input, output, base_url)
generate (active) image for html. input and output are file names. If output ends in '.html', its stem is used with an '.png' suffix for the actual image.
Classes Details:
class SystemError
Error thrown by the system() function. Attributes are 'retval', encoded as per os.wait(): low-byte is killing signal number, high-byte is return value of command.
class DotFileGenerator
A class that encapsulates the dot file generation
class InheritanceGenerator
A Formatter that generates an inheritance graph. If the 'toc' argument is not None, it is used to generate URLs. If no reference could be found in the toc, the node will be grayed out.
class SingleInheritanceGenerator
A Formatter that generates an inheritance graph for a specific class. This Visitor visits the ASG upwards, i.e. following the inheritance links, instead of the declarations contained in a given scope.
class FileDependencyGenerator
A Formatter that generates a file dependency graph
class Formatter
The Formatter class acts merely as a frontend to the various InheritanceGenerators
Functions Details:
system(command)
Run the command. If the command fails, an exception SystemError is thrown.
normalize(color)
Generate a color triplet from a color string.
Generated on Thu Apr 16 16:26:55 2009 by
synopsis (version devel)