Otawa  0.10
otawa::display Namespace Reference

Classes

class  AbstractDrawer
 Provides facilities to draw a graph. More...
 
class  CFGAdapter
 This adapter implements the otawa::concept::DiGraphWithNodeMap and allows to use apply the GenDrawer to a CFG. More...
 
class  CFGDrawer
 
class  CFGOutput
 
class  Color
 A color description. More...
 
class  Decorator
 A decorator is a concept that provides static functions used to display a graph. More...
 
class  DefaultDecorator
 Default decorator that just output the given edges and vertices. More...
 
class  DisplayException
 This exception is thrown during the display of a graph if there is an error. More...
 
class  Driver
 A driver provides facilities to display a graph. More...
 
class  Edge
 
class  Exception
 
class  FillStyle
 The style of a filled area. More...
 
class  GenDrawer
 A simple engine to draw graphs. More...
 
class  GenGraphAdapter
 
class  Graph
 A graph provides facilities to display a graph. More...
 
class  GraphVizDriver
 
class  GraphVizEdge
 
class  GraphVizGraph
 
class  GraphVizGraphElement
 
class  GraphVizItem
 
class  GraphVizNode
 
class  ILPSystemAddon
 This class is an interface for ILPSystemDisplayer to add to its output specialized information about ILP variables and constraints generators. More...
 
class  ILPSystemDisplayer
 This processor may be used to generate an HTML output of an ILP system used to compute the WCET of a task. More...
 
class  Item
 This class is the base of Graph, Node and Edge. More...
 
class  LineStyle
 
class  Node
 
class  Plugin
 A plugin to provide driver to display graphs. More...
 
class  ShapeStyle
 Shape style. More...
 
class  TextStyle
 Description of the style of text. More...
 

Typedefs

typedef enum otawa::display::kind_t kind_t
 
typedef enum
otawa::display::style_t 
style_t
 
typedef enum
otawa::display::graphviz_layout_t 
graphviz_layout_t
 

Enumerations

enum  kind_t {
  OUTPUT_ANY = 0, OUTPUT_PS, OUTPUT_PDF, OUTPUT_PNG,
  OUTPUT_GIF, OUTPUT_JPG, OUTPUT_SVG, OUTPUT_DOT,
  OUTPUT_RAW_DOT
}
 
enum  style_t {
  STYLE_NONE = 0, STYLE_FILLED, STYLE_PLAIN, STYLE_DASHED,
  STYLE_DOTTED, STYLE_BOLD
}
 
enum  graphviz_layout_t {
  LAYOUT_DOT, LAYOUT_RADIAL, LAYOUT_CIRCULAR, LAYOUT_UNDIRECTED_NEATO,
  LAYOUT_UNDIRECTED_FDP
}
 

Functions

io::IntFormat hex2 (int v)
 
Identifier< AbstractIdentifier * > INCLUDE ("otawa::display::include")
 Tells that the properties with the given identifier have to be printed. More...
 
Identifier< AbstractIdentifier * > EXCLUDE ("otawa::display::exclude")
 Tells that the properties with the given identifier mustn't be printed. More...
 
Identifier< AbstractIdentifier * > DEFAULT ("otawa::display::default")
 The value of the property must be either INCLUDE or EXCLUDE. More...
 
Identifier< elm::CStringBACKGROUND ("otawa::display::background")
 Identifier of the background color. More...
 
Identifier< elm::CStringCOLOR ("otawa::display::color")
 Identifier of the drawing color (boxes, edges) More...
 
Identifier< int > STYLE ("otawa::display::style")
 Identifier of the drawing style. More...
 
Identifier< elm::CStringFONT_COLOR ("otawa::display::text_color")
 Identifier of the text color. More...
 
Identifier< int > FONT_SIZE ("otawa::display::text_size")
 Identifier of the text size. More...
 
Identifier< elm::CStringFONT ("otawa::display::font_name")
 Identifier of the font name. More...
 
Identifier< elm::CStringHREF ("otawa::display::href")
 Identifier of the url of the link the object is pointing to. More...
 
Identifier< elm::StringTITLE ("otawa::display::title")
 Identifier of the title of a node. More...
 
Identifier< elm::StringBODY ("otawa::display::body")
 Identifier of the body of a node. More...
 
Identifier< int > SHAPE ("otawa::display::shape")
 Identifier of a shape of a node. More...
 
Identifier< elm::StringLABEL ("otawa::display::label")
 Identifier of a label of an edge. More...
 
Identifier< int > WEIGHT ("otawa::display::weight")
 Identifier of a weight of an edge. More...
 
Driverfind (kind_t kind)
 Find a driver by its output kind. More...
 
Identifier< kind_tOUTPUT_KIND ("otawa::display::output_kind", OUTPUT_ANY)
 Passed to the graph style of the Driver::newGraph() method, selects the kind of output. More...
 
Identifier< stringOUTPUT_PATH ("otawa::display::output_path","")
 Passed to the graph style of the Driver::newGraph() method, selects the file to output to when the driver display in a file. More...
 
Identifier< int > GRAPHVIZ_LAYOUT ("otawa::display::graphviz_layout", LAYOUT_DOT)
 Identifier for the dot layout. More...
 
String quoteSpecials (String str)
 This function escapes all the special characters, and replaces the newlines by \l (left-align in dot) More...
 
String quoteNewlines (String str)
 This function escapes the newlines in order to avoid giving the newline to DOT input. More...
 

Variables

Identifier< kind_tOUTPUT_KIND
 Passed to the graph style of the Driver::newGraph() method, selects the kind of output. More...
 
Identifier< stringOUTPUT_PATH
 Passed to the graph style of the Driver::newGraph() method, selects the file to output to when the driver display in a file. More...
 
Identifier< AbstractIdentifier * > INCLUDE
 Tells that the properties with the given identifier have to be printed. More...
 
Identifier< AbstractIdentifier * > EXCLUDE
 Tells that the properties with the given identifier mustn't be printed. More...
 
Identifier< AbstractIdentifier * > DEFAULT
 The value of the property must be either INCLUDE or EXCLUDE. More...
 
Identifier< elm::CStringBACKGROUND
 Identifier of the background color. More...
 
Identifier< elm::CStringCOLOR
 Identifier of the drawing color (boxes, edges) More...
 
Identifier< int > STYLE
 Identifier of the drawing style. More...
 
Identifier< elm::CStringFONT_COLOR
 Identifier of the text color. More...
 
Identifier< elm::CString > & TEXT_COLOR = FONT_COLOR
 Identifier of the text color. More...
 
Identifier< int > FONT_SIZE
 Identifier of the text size. More...
 
Identifier< int > & TEXT_SIZE = FONT_SIZE
 Identifier of the text size. More...
 
Identifier< elm::CStringFONT
 Identifier of the font name. More...
 
Identifier< elm::CStringHREF
 Identifier of the url of the link the object is pointing to. More...
 
Identifier< elm::StringTITLE
 Identifier of the title of a node. More...
 
Identifier< elm::StringBODY
 Identifier of the body of a node. More...
 
Identifier< int > SHAPE
 Identifier of a shape of a node. More...
 
Identifier< int > WEIGHT
 Identifier of a weight of an edge. More...
 
Identifier< elm::StringLABEL
 Identifier of a label of an edge. More...
 
Drivergraphviz_driver = driver
 The graphviz driver. More...
 
Identifier< int > GRAPHVIZ_LAYOUT
 Identifier for the dot layout. More...
 
cstring exts []
 

Typedef Documentation

Enumeration Type Documentation

Enumerator
LAYOUT_DOT 
LAYOUT_RADIAL 
LAYOUT_CIRCULAR 
LAYOUT_UNDIRECTED_NEATO 
LAYOUT_UNDIRECTED_FDP 
Enumerator
OUTPUT_ANY 
OUTPUT_PS 
OUTPUT_PDF 
OUTPUT_PNG 
OUTPUT_GIF 
OUTPUT_JPG 
OUTPUT_SVG 
OUTPUT_DOT 
OUTPUT_RAW_DOT 
Enumerator
STYLE_NONE 
STYLE_FILLED 
STYLE_PLAIN 
STYLE_DASHED 
STYLE_DOTTED 
STYLE_BOLD 

Function Documentation

Driver* otawa::display::find ( kind_t  kind)

Find a driver by its output kind.

Parameters
kindKind of the output to produce.
Returns
Found driver.

References graphviz_driver.

Referenced by otawa::Property::getID(), and otawa::ContextualPath::Ref< T >::print().

Identifier<int> otawa::display::GRAPHVIZ_LAYOUT ( "otawa::display::graphviz_layout"  ,
LAYOUT_DOT   
)

Identifier for the dot layout.

Must be one of layout_t. Default is LAYOUT_DOT (standard directional graph, from up to down)

io::IntFormat otawa::display::hex2 ( int  v)
inline
String otawa::display::quoteNewlines ( String  str)

This function escapes the newlines in order to avoid giving the newline to DOT input.

References buf, elm::String::length(), and elm::StringBuffer::toString().

Referenced by otawa::display::GraphVizItem::attributes().

Variable Documentation

cstring otawa::display::exts[]
Initial value:
= {
"",
"ps",
"pdf",
"png",
"gif",
"jpg",
"svg",
"dot"
}

Referenced by otawa::display::CFGOutput::processCFG().

Driver & otawa::display::graphviz_driver = driver

The graphviz driver.

Referenced by otawa::display::Driver::find(), and find().

Identifier<int> otawa::display::GRAPHVIZ_LAYOUT("otawa::display::graphviz_layout", LAYOUT_DOT)

Identifier for the dot layout.

Must be one of layout_t. Default is LAYOUT_DOT (standard directional graph, from up to down)

Referenced by otawa::display::GraphVizGraph::display().