};
/* Layout Algorithms which can be found in VCG.
- Details about each algoithm can be found below. */
+ Details about each algoithm can be found below. */
enum layoutalgorithm_e
{
normal,
struct node_s
{
- /* Title the unique string identifying the node. This attribute is
+ /* Title the unique string identifying the node. This attribute is
mandatory. */
char *title;
-
- /* Label the text displayed inside the node. If no label is specified
- then the title of the node will be used. Note that this text may
- contain control characters like NEWLINE that influences the size of
+
+ /* Label the text displayed inside the node. If no label is specified
+ then the title of the node will be used. Note that this text may
+ contain control characters like NEWLINE that influences the size of
the node. */
char *label;
-
- /* loc is the location as x, y position relatively to the system of
- coordinates of the graph. Locations are specified in the form
- loc: - x: xpos y: ypos "". The locations of nodes are only valid,
- if the whole graph is fully specified with locations and no part is
- folded. The layout algorithm of the tool calculates appropriate x, y
- positions, if at least one node that must be drawn (i.e., is not
- hidden by folding or edge classes) does not have fixed specified
- locations.
+
+ /* loc is the location as x, y position relatively to the system of
+ coordinates of the graph. Locations are specified in the form
+ loc: - x: xpos y: ypos "". The locations of nodes are only valid,
+ if the whole graph is fully specified with locations and no part is
+ folded. The layout algorithm of the tool calculates appropriate x, y
+ positions, if at least one node that must be drawn (i.e., is not
+ hidden by folding or edge classes) does not have fixed specified
+ locations.
Default is none. */
int locx;
int locy;
- /* vertical order is the level position (rank) of the node. We can also
- specify level: int. Level specifications are only valid, if the
- layout is calculated, i.e. if at least one node does not have a
- fixed location specification. The layout algorithm partitioned all
- nodes into levels 0...maxlevel. Nodes at the level 0 are on the
- upper corner. The algorithm is able to calculate appropriate levels
- for the nodes automatically, if no fixed levels are given.
- Specifications of levels are additional constraints, that may be
+ /* vertical order is the level position (rank) of the node. We can also
+ specify level: int. Level specifications are only valid, if the
+ layout is calculated, i.e. if at least one node does not have a
+ fixed location specification. The layout algorithm partitioned all
+ nodes into levels 0...maxlevel. Nodes at the level 0 are on the
+ upper corner. The algorithm is able to calculate appropriate levels
+ for the nodes automatically, if no fixed levels are given.
+ Specifications of levels are additional constraints, that may be
ignored, if they are in conflict with near edge specifications.
Default values are unspecified. */
int vertical_order;
- /* horizontal order is the horizontal position of the node within a
- level. The nodes which are specified with horizontal positions are
- ordered according to these positions within the levels. The nodes
- which do not have this attribute are inserted into this ordering by
- the crossing reduction mechanism. Note that connected components are
- handled separately, thus it is not possible to intermix such
- components by specifying a horizontal order. If the algorithm for
- downward laid out trees is used, the horizontal order influences
- only the order of the child nodes at a node, but not the order of
- the whole level.
+ /* horizontal order is the horizontal position of the node within a
+ level. The nodes which are specified with horizontal positions are
+ ordered according to these positions within the levels. The nodes
+ which do not have this attribute are inserted into this ordering by
+ the crossing reduction mechanism. Note that connected components are
+ handled separately, thus it is not possible to intermix such
+ components by specifying a horizontal order. If the algorithm for
+ downward laid out trees is used, the horizontal order influences
+ only the order of the child nodes at a node, but not the order of
+ the whole level.
Default is unspecified. */
int horizontal_order;
/* width, height is the width and height of a node including the border.
- If no value (in pixels) is given then width and height are
+ If no value (in pixels) is given then width and height are
calculated from the size of the label.
Default are width and height of the label. */
int width;
int height;
- /* shrink, stretch gives the shrinking and stretching factor of the
- node. The values of the attributes width, height, borderwidth and
- the size of the label text is scaled by ((stretch=shrink) \Lambda
- 100) percent. Note that the actual scale value is determined by the
- scale value of a node relatively to a scale value of the graph,
- i.e. if (stretch,shrink) = (2,1) for the graph and (stretch,shrink)
- = (2,1) for the node of the graph, then the node is scaled by the
- factor 4 compared to the normal size. The scale value can also be
+ /* shrink, stretch gives the shrinking and stretching factor of the
+ node. The values of the attributes width, height, borderwidth and
+ the size of the label text is scaled by ((stretch=shrink) \Lambda
+ 100) percent. Note that the actual scale value is determined by the
+ scale value of a node relatively to a scale value of the graph,
+ i.e. if (stretch,shrink) = (2,1) for the graph and (stretch,shrink)
+ = (2,1) for the node of the graph, then the node is scaled by the
+ factor 4 compared to the normal size. The scale value can also be
specified by scaling: float.
Default are 1,1. */
int shrink;
int stretch;
- /* folding specifies the default folding of the nodes. The folding k
- (with k ? 0) means that the graph part that is reachable via edges
- of a class less or equal to k is folded and displayed as one node.
- There are commands to unfold such summary nodes, see section 5. If
- no folding is specified for a node, then the node may be folded if
- it is in the region of another node that starts the folding. If
- folding 0 is specified, then the node is never folded. In this case
- the folding stops at the predecessors of this node, if it is
- reachable from another folding node. The summary node inherits some
- attributes from the original node which starts the folding (all
- color attributes, textmode and label, but not the location). A
- folded region may contain folded regions with smaller folding class
- values (nested foldings). If there is more than one node that start
- the folding of the same region (this implies that the folding class
- values are equal) then the attributes are inherited by one of these
- nodes nondeterministically. If foldnode attributes are specified,
+ /* folding specifies the default folding of the nodes. The folding k
+ (with k ? 0) means that the graph part that is reachable via edges
+ of a class less or equal to k is folded and displayed as one node.
+ There are commands to unfold such summary nodes, see section 5. If
+ no folding is specified for a node, then the node may be folded if
+ it is in the region of another node that starts the folding. If
+ folding 0 is specified, then the node is never folded. In this case
+ the folding stops at the predecessors of this node, if it is
+ reachable from another folding node. The summary node inherits some
+ attributes from the original node which starts the folding (all
+ color attributes, textmode and label, but not the location). A
+ folded region may contain folded regions with smaller folding class
+ values (nested foldings). If there is more than one node that start
+ the folding of the same region (this implies that the folding class
+ values are equal) then the attributes are inherited by one of these
+ nodes nondeterministically. If foldnode attributes are specified,
then the summary node attributes are inherited from these attributes.
Default is none. */
int folding;
-
- /* shape specifies the visual appearance of a node: box, rhomb, ellipse,
- and triangle. The drawing of ellipses is much slower than the drawing
+
+ /* shape specifies the visual appearance of a node: box, rhomb, ellipse,
+ and triangle. The drawing of ellipses is much slower than the drawing
of the other shapes.
Default is box. */
enum shape_e shape;
-
- /* textmode specifies the adjustment of the text within the border of a
+
+ /* textmode specifies the adjustment of the text within the border of a
node. The possibilities are center, left.justify and right.justify.
Default is center. */
enum textmode_e textmode;
-
- /* borderwidth specifies the thickness of the node's border in pixels.
- color is the background color of the node. If none is given, the
- node is white. For the possibilities, see the attribute color for
+
+ /* borderwidth specifies the thickness of the node's border in pixels.
+ color is the background color of the node. If none is given, the
+ node is white. For the possibilities, see the attribute color for
graphs.
Default is 2. */
int borderwidth;
-
+
/* node color.
Default is white or transparent, */
enum color_e color;
-
- /* textcolor is the color for the label text. bordercolor is the color
- of the border. Default color is the textcolor. info1, info2, info3
+
+ /* textcolor is the color for the label text. bordercolor is the color
+ of the border. Default color is the textcolor. info1, info2, info3
combines additional text labels with a node or a folded graph. info1,
Default is black. */
enum color_e textcolor;
-
- /* info2, info3 can be selected from the menu. The corresponding text
+
+ /* info2, info3 can be selected from the menu. The corresponding text
labels can be shown by mouse clicks on nodes.\f
Default are null strings. */
char *infos[3];
-
+
/* Node border color.
Default is textcolor. */
enum color_e bordercolor;
-
+
/* Next node node... */
struct node_s *next;
};
/* The struct edge_s itself. */
struct edge_s
{
-
+
/* Edge type.
Default is normal edge. */
enum edge_type type;
/* Sourcename is the title of the source node of the edge.
Default: none. */
- char *sourcename; /* Mandatory. */
-
+ const char *sourcename; /* Mandatory. */
+
/* Targetname is the title of the target node of the edge.
Default: none. */
- char *targetname; /* Mandatory. */
-
- /* Label specifies the label of the edge. It is drawn if
+ const char *targetname; /* Mandatory. */
+
+ /* Label specifies the label of the edge. It is drawn if
display.edge.labels is set to yes.
Default: no label. */
- char *label;
+ const char *label;
/* Linestyle specifies the style the edge is drawn. Possibilities are:
- ffl continuous a solid line is drawn ( -- ) ffl dashed the edge
- consists of single dashes ( - - - ) ffl dotted the edge is made of
- single dots ( \Delta \Delta \Delta ) ffl invisible the edge is not
+ ffl continuous a solid line is drawn ( -- ) ffl dashed the edge
+ consists of single dashes ( - - - ) ffl dotted the edge is made of
+ single dots ( \Delta \Delta \Delta ) ffl invisible the edge is not
drawn. The attributes of its shape (color, thickness) are ignored.
To draw a dashed or dotted line needs more time than solid lines.
Default is continuous. */
enum linestyle_e linestyle;
-
+
/* Thickness is the thickness of an edge.
Default is 2. */
int thickness;
- /* Class specifies the folding class of the edge. Nodes reachable by
- edges of a class less or equal to a constant k specify folding
+ /* Class specifies the folding class of the edge. Nodes reachable by
+ edges of a class less or equal to a constant k specify folding
regions of k. See the node attribute folding and the folding commands.
Default is 1. */
int class;
-
- /* color is the color of the edge.
+
+ /* color is the color of the edge.
Default is black. */
enum color_e color;
-
- /* textcolor is the color of the label of the edge. arrowcolor,
- backarrowcolor is the color of the arrow head and of the backarrow
- head. priority The positions of the nodes are mainly determined by
- the incoming and outgoing edges. One can think of rubberbands instead
- of edges that pull a node into its position. The priority of an edges
+
+ /* textcolor is the color of the label of the edge. arrowcolor,
+ backarrowcolor is the color of the arrow head and of the backarrow
+ head. priority The positions of the nodes are mainly determined by
+ the incoming and outgoing edges. One can think of rubberbands instead
+ of edges that pull a node into its position. The priority of an edges
corresponds to the strength of the rubberband.
Default is color. */
enum color_e textcolor;
-
+
/* Arrow color.
Default is color. */
enum color_e arrowcolor;
-
+
/* BackArrow color.
Default is color. */
enum color_e backarrowcolor;
-
- /* arrowsize, backarrowsize The arrow head is a right-angled, isosceles
+
+ /* arrowsize, backarrowsize The arrow head is a right-angled, isosceles
triangle and the cathetuses have length arrowsize.
Default is 10. */
int arrowsize;
-
+
/* Backarrow size
Default is 0. */
int backarrowsize;
-
- /* arrowstyle, backarrowstyle Each edge has two arrow heads: the one
- appears at the target node (the normal arrow head), the other appears
- at the source node (the backarrow head). Normal edges only have the
- normal solid arrow head, while the backarrow head is not drawn, i.e.
- it is none. Arrowstyle is the style of the normal arrow head, and
- backarrowstyle is the style of the backarrow head. Styles are none,
+
+ /* arrowstyle, backarrowstyle Each edge has two arrow heads: the one
+ appears at the target node (the normal arrow head), the other appears
+ at the source node (the backarrow head). Normal edges only have the
+ normal solid arrow head, while the backarrow head is not drawn, i.e.
+ it is none. Arrowstyle is the style of the normal arrow head, and
+ backarrowstyle is the style of the backarrow head. Styles are none,
i.e. no arrow head, solid, and line.
Default is solid. */
enum arrowstyle_e arrowstyle;
-
+
/* Default is none. */
enum arrowstyle_e backarrowstyle;
-
+
/* Default is 1. */
int priority;
-
- /* Anchor. An anchor point describes the vertical position in a node
- where an edge goes out. This is useful, if node labels are several
- lines long, and outgoing edges are related to label lines. (E.g.,
- this allows a nice visualization of structs containing pointers as
+
+ /* Anchor. An anchor point describes the vertical position in a node
+ where an edge goes out. This is useful, if node labels are several
+ lines long, and outgoing edges are related to label lines. (E.g.,
+ this allows a nice visualization of structs containing pointers as
fields.).
Default is none. */
int anchor;
-
- /* Horizontal order is the horizontal position the edge. This is of
- interest only if the edge crosses several levels because it specifies
- the point where the edge crosses the level. within a level. The nodes
- which are specified with horizontal positions are ordered according
- to these positions within a level. The horizontal position of a long
- edge that crosses the level specifies between which two node of that
- level the edge has to be drawn. Other edges which do not have this
- attribute are inserted into this ordering by the crossing reduction
- mechanism. Note that connected components are handled separately,
- thus it is not possible to intermix such components by specifying a
+
+ /* Horizontal order is the horizontal position the edge. This is of
+ interest only if the edge crosses several levels because it specifies
+ the point where the edge crosses the level. within a level. The nodes
+ which are specified with horizontal positions are ordered according
+ to these positions within a level. The horizontal position of a long
+ edge that crosses the level specifies between which two node of that
+ level the edge has to be drawn. Other edges which do not have this
+ attribute are inserted into this ordering by the crossing reduction
+ mechanism. Note that connected components are handled separately,
+ thus it is not possible to intermix such components by specifying a
horizontal order.
Default is unspcified. */
int horizontal_order;
-
+
/*
** Next edge node...
*/
};
/*
-** typedef alias.
+** typedef alias.
*/
typedef struct edge_s edge_t;
/***************************************************************.
- **
+ **
****************************************************************/
/*--------------------------------------------------------.
struct graph_s
{
/* Graph title or name.
- Title specifies the name (a string) associated with the graph. The
- default name of a subgraph is the name of the outer graph, and the
- name of the outmost graph is the name of the specification input
- file. The name of a graph is used to identify this graph, e.g., if
- we want to express that an edge points to a subgraph. Such edges
- point to the root of the graph, i.e. the first node of the graph or
- the root of the first subgraph in the graph, if the subgraph is
+ Title specifies the name (a string) associated with the graph. The
+ default name of a subgraph is the name of the outer graph, and the
+ name of the outmost graph is the name of the specification input
+ file. The name of a graph is used to identify this graph, e.g., if
+ we want to express that an edge points to a subgraph. Such edges
+ point to the root of the graph, i.e. the first node of the graph or
+ the root of the first subgraph in the graph, if the subgraph is
visualized explicitly.
By default, it's the name of the vcg graph file description. */
- char *title;
-
+ const char *title;
+
/* Graph label.
- Label the text displayed inside the node, when the graph is folded
- to a node. If no label is specified then the title of the graph will
- be used. Note that this text may contain control characters like
+ Label the text displayed inside the node, when the graph is folded
+ to a node. If no label is specified then the title of the graph will
+ be used. Note that this text may contain control characters like
NEWLINE that influences the size of the node.
By default, it takes the title value */
- char *label;
-
+ const char *label;
+
/* Any informations.
- Info1, info2, info3 combines additional text labels with a node or a
- folded graph. info1, info2, info3 can be selected from the menu
- interactively. The corresponding text labels can be shown by mouse
+ Info1, info2, info3 combines additional text labels with a node or a
+ folded graph. info1, info2, info3 can be selected from the menu
+ interactively. The corresponding text labels can be shown by mouse
clicks on nodes.
Defalut values are empty strings (here NULL pointers) */
- char *infos[3];
-
- /* Background color and summary node colors
- Color specifies the background color for the outermost graph, or the
+ const char *infos[3];
+
+ /* Background color and summary node colors
+ Color specifies the background color for the outermost graph, or the
color of the summary node for subgraphs. Colors are given in the enum
- declared above. If more than these default colors are needed, a
- color map with maximal 256 entries can be used. The first 32 entries
- correspond to the colors just listed. A color of the color map can
- selected by the color map index, an integer, for instance red has
+ declared above. If more than these default colors are needed, a
+ color map with maximal 256 entries can be used. The first 32 entries
+ correspond to the colors just listed. A color of the color map can
+ selected by the color map index, an integer, for instance red has
index 2, green has index 3, etc.
Default is white for background and white or transparent for summary
nodes. */
unsigned char color;
- /* Textcolor.
- need explainations ???
+ /* Textcolor.
+ need explainations ???
defalut is black for summary nodes. */
unsigned char textcolor;
- /* Bordercolor is the color of the summary node's border. Default color
- is the textcolor. width, height are width and height of the
- displayed part of the window of the outermost graph in pixels, or
+ /* Bordercolor is the color of the summary node's border. Default color
+ is the textcolor. width, height are width and height of the
+ displayed part of the window of the outermost graph in pixels, or
width and height of the summary node of inner subgraphs.
Default is the defalut of the textcolor. */
unsigned char bordercolor;
-
- /* Width, height are width and height of the displayed part of the
- window of the outermost graph in pixels, or width and height of the
+
+ /* Width, height are width and height of the displayed part of the
+ window of the outermost graph in pixels, or width and height of the
summary node of inner subgraphs.
Defalut value is 100. */
int width;
int height;
-
+
/* Specify the thickness if summary node's border in pixels.
defalut value is 2. */
int borderwidth;
- /* x, y are the x-position and y-position of the graph's window in
- pixels, relatively to the root screen, if it is the outermost graph.
- The origin of the window is upper, left hand. For inner subgraphs,
- it is the position of the folded summary node. The position can also
+ /* x, y are the x-position and y-position of the graph's window in
+ pixels, relatively to the root screen, if it is the outermost graph.
+ The origin of the window is upper, left hand. For inner subgraphs,
+ it is the position of the folded summary node. The position can also
be specified in the form loc: fx:int y:intg.
The default value is 0. */
int x;
int y;
-
- /* folding of a subgraph is 1, if the subgraph is fused, and 0, if the
- subgraph is visualized explicitly. There are commands to unfold such
+
+ /* folding of a subgraph is 1, if the subgraph is fused, and 0, if the
+ subgraph is visualized explicitly. There are commands to unfold such
summary nodes.
Defalut value is 0 */
int folding;
-
- /* Shrink, stretch gives the shrinking and stretching factor for the
- graph's representation (default is 1, 1). ((stretch=shrink) \Lambda
- 100) is the scaling of the graph in percentage, e.g.,
- (stretch,shrink) = (1,1) or (2,2) or (3,3) : : : is normal size,
- (stretch,shrink) = (1,2) is half size, (stretch,shrink) = (2,1) is
- double size. For subgraphs, it is also the scaling factor of the
- summary node. The scaling factor can also be specified by scaling:
+
+ /* Shrink, stretch gives the shrinking and stretching factor for the
+ graph's representation (default is 1, 1). ((stretch=shrink) \Lambda
+ 100) is the scaling of the graph in percentage, e.g.,
+ (stretch,shrink) = (1,1) or (2,2) or (3,3) : : : is normal size,
+ (stretch,shrink) = (1,2) is half size, (stretch,shrink) = (2,1) is
+ double size. For subgraphs, it is also the scaling factor of the
+ summary node. The scaling factor can also be specified by scaling:
float (here, scaling 1.0 means normal size). */
int shrink;
int stretch;
- /* textmode specifies the adjustment of the text within the border of a
- summary node. The possibilities are center, left.justify and
+ /* textmode specifies the adjustment of the text within the border of a
+ summary node. The possibilities are center, left.justify and
right.justify.
Default value is center.*/
enum textmode_e textmode;
-
- /* Shape can be specified for subgraphs only. It is the shape of the
- subgraph summary node that appears if the subgraph is folded: box,
- rhomb, ellipse, and triangle. vertical order is the level position
- (rank) of the summary node of an inner subgraph, if this subgraph is
- folded. We can also specify level: int. The level is only
- recognized, if an automatical layout is calculated. horizontal order
- is the horizontal position of the summary node within a level. The
- nodes which are specified with horizontal positions are ordered
- according to these positions within the levels. The nodes which do
- not have this attribute are inserted into this ordering by the
- crossing reduction mechanism. Note that connected
- components are handled separately, thus it is not possible to
- intermix such components by specifying a horizontal order. If the
- algorithm for downward laid out trees is used, the horizontal order
- influences only the order of the child nodes at a node, but not the
+
+ /* Shape can be specified for subgraphs only. It is the shape of the
+ subgraph summary node that appears if the subgraph is folded: box,
+ rhomb, ellipse, and triangle. vertical order is the level position
+ (rank) of the summary node of an inner subgraph, if this subgraph is
+ folded. We can also specify level: int. The level is only
+ recognized, if an automatical layout is calculated. horizontal order
+ is the horizontal position of the summary node within a level. The
+ nodes which are specified with horizontal positions are ordered
+ according to these positions within the levels. The nodes which do
+ not have this attribute are inserted into this ordering by the
+ crossing reduction mechanism. Note that connected
+ components are handled separately, thus it is not possible to
+ intermix such components by specifying a horizontal order. If the
+ algorithm for downward laid out trees is used, the horizontal order
+ influences only the order of the child nodes at a node, but not the
order of the whole level.
Defalut is box, other: rhomb, ellipse, triangle. */
enum shape_e shape;
-
+
/* FIXME {vertival,horizontal}_order */
-
- /* xmax, ymax specify the maximal size of the virtual window that is
- used to display the graph. This is usually larger than the displayed
- part, thus the width and height of the displayed part cannot be
- greater than xmax and ymax. Only those parts of the graph are drawn
- that are inside the virtual window. The virtual window can be moved
- over the potential infinite system of coordinates by special
+
+ /* xmax, ymax specify the maximal size of the virtual window that is
+ used to display the graph. This is usually larger than the displayed
+ part, thus the width and height of the displayed part cannot be
+ greater than xmax and ymax. Only those parts of the graph are drawn
+ that are inside the virtual window. The virtual window can be moved
+ over the potential infinite system of coordinates by special
positioning commands.
Defaults are 90 and 90. */
int xmax;
int ymax;
-
+
/* xy-base: specify the upper left corner coordonates of the graph
relatively to the root window.
Defaults are 5, 5. */
int xbase;
int ybase;
-
- /* xspace, yspace the minimum horizontal and vertical distance between
- nodes. xlspace is the horizontal distance between lines at the
- points where they cross the levels. (At these points, dummy nodes
- are used. In fact, this is the horizontal distance between dummy
- nodes.) It is recommended to set xlspace to a larger value, if
+
+ /* xspace, yspace the minimum horizontal and vertical distance between
+ nodes. xlspace is the horizontal distance between lines at the
+ points where they cross the levels. (At these points, dummy nodes
+ are used. In fact, this is the horizontal distance between dummy
+ nodes.) It is recommended to set xlspace to a larger value, if
splines are used to draw edges, to prevent sharp bendings.
Default are 20 and 70. */
int xspace;
defaults value is 1/2 xspace (polygone) and 4/5 xspace (splines)*/
int xlspace;
- /* xraster, yraster specifies the raster distance for the position of
- the nodes. The center of a node is aligned to this raster. xlraster
- is the horizontal raster for the positions of the line control
+ /* xraster, yraster specifies the raster distance for the position of
+ the nodes. The center of a node is aligned to this raster. xlraster
+ is the horizontal raster for the positions of the line control
points (the dummy nodes). It should be a divisor of xraster.
defaluts are 1,1. */
int xraster;
int yraster;
- /* xlraster is the horizontal raster for the positions of the line
+ /* xlraster is the horizontal raster for the positions of the line
control points (the dummy nodes). It should be a divisor of xraster.
defaults is 1. */
int xlraster;
-
- /* hidden specifies the classes of edges that are hidden.
- Edges that are within such a class are not laid out nor drawn.
- Nodes that are only reachable (forward or backward) by edges of an
- hidden class are not drawn. However, nodes that are not reachable
- at all are drawn. (But see attribute ignore.singles.) Specification
- of classes of hidden edges allows to hide parts of a graph, e.g.,
- annotations of a syntax tree. This attribute is only allowed at the
- outermost level. More than one settings are possible to specify
- exactly the set of classes that are hidden. Note the important
+
+ /* hidden specifies the classes of edges that are hidden.
+ Edges that are within such a class are not laid out nor drawn.
+ Nodes that are only reachable (forward or backward) by edges of an
+ hidden class are not drawn. However, nodes that are not reachable
+ at all are drawn. (But see attribute ignore.singles.) Specification
+ of classes of hidden edges allows to hide parts of a graph, e.g.,
+ annotations of a syntax tree. This attribute is only allowed at the
+ outermost level. More than one settings are possible to specify
+ exactly the set of classes that are hidden. Note the important
difference between hiding of edges and the edge line style invisible.
- Hidden edges are not existent in the layout. Edges with line style
- invisible are existent in the layout; they need space and may
- produce crossings and influence the layout, but you cannot see
- them.
+ Hidden edges are not existent in the layout. Edges with line style
+ invisible are existent in the layout; they need space and may
+ produce crossings and influence the layout, but you cannot see
+ them.
No default value. */
int hidden;
- /* Classname allows to introduce names for the edge classes. The names
- are used in the menus. infoname allows to introduce names for the
+ /* Classname allows to introduce names for the edge classes. The names
+ are used in the menus. infoname allows to introduce names for the
additional text labels. The names are used in the menus.
- defaults are 1,2,3...
- By default, no class names. */
+ defaults are 1,2,3...
+ By default, no class names. */
struct classname_s *classname;
/* FIXME : infoname. */
/* FIXME : colorentry. */
-
- /* layoutalgorithm chooses different graph layout algorithms
- Possibilities are maxdepth, mindepth, maxdepthslow, mindepthslow,
- maxdegree, mindegree, maxindegree, minindegree, maxoutdegree,
- minoutdegree, minbackward, dfs and tree. The default algorithm tries
- to give all edges the same orientation and is based on the
- calculation of strongly connected components. The algorithms that
- are based on depth first search are faster. While the simple dfs
- does not enforce additionally constraints, the algorithm maxdepth
- tries to increase the depth of the layout and the algorithm mindepth
- tries to increase the wide of the layout. These algorithms are fast
- heuristics. If they are not appropriate, the algorithms maxdepthslow
- or mindepthslow also increase the depth or wide, but they are very
- slow. The algorithm maxindegree lays out the nodes by scheduling the
- nodes with the maximum of incoming edges first, and minindegree lays
- out the nodes by scheduling the nodes with the minimum of incoming
- edges first. In the same manner work the algorithms maxoutdegree and
- minoutdegree for outgoing edges, and maxdegree and mindegree for the
+
+ /* layoutalgorithm chooses different graph layout algorithms
+ Possibilities are maxdepth, mindepth, maxdepthslow, mindepthslow,
+ maxdegree, mindegree, maxindegree, minindegree, maxoutdegree,
+ minoutdegree, minbackward, dfs and tree. The default algorithm tries
+ to give all edges the same orientation and is based on the
+ calculation of strongly connected components. The algorithms that
+ are based on depth first search are faster. While the simple dfs
+ does not enforce additionally constraints, the algorithm maxdepth
+ tries to increase the depth of the layout and the algorithm mindepth
+ tries to increase the wide of the layout. These algorithms are fast
+ heuristics. If they are not appropriate, the algorithms maxdepthslow
+ or mindepthslow also increase the depth or wide, but they are very
+ slow. The algorithm maxindegree lays out the nodes by scheduling the
+ nodes with the maximum of incoming edges first, and minindegree lays
+ out the nodes by scheduling the nodes with the minimum of incoming
+ edges first. In the same manner work the algorithms maxoutdegree and
+ minoutdegree for outgoing edges, and maxdegree and mindegree for the
sum of incoming and outgoing edges. These algorithms may have various
- effects, and can sometimes be used as replacements of maxdepthslow
+ effects, and can sometimes be used as replacements of maxdepthslow
or mindepthslow.
-
+
The algorithm minbackward can be used if the graph is acyclic.
- The algorithm tree is a specialized method for downward laid out
- trees. It is much faster on such tree-like graphs and results in a
+ The algorithm tree is a specialized method for downward laid out
+ trees. It is much faster on such tree-like graphs and results in a
balanced layout.
Default is normal. */
enum layoutalgorithm_e layoutalgorithm;
-
- /* Layout downfactor, layout upfactor, layout nearfactor The layout
- algorithm partitions the set of edges into edges pointing upward,
- edges pointing downward, and edges pointing sidewards. The last type
- of edges is also called near edges. If the layout.downfactor is
- large compared to the layout.upfactor and the layout.nearfactor,
- then the positions of the nodes is mainly determined by the edges
- pointing downwards. If the layout.upfactor is large compared to the
- layout.downfactor and the layout.nearfactor, then the positions of
- the nodes is mainly determined by the edges pointing upwards. If the
- layout.nearfactor is large, then the positions of the nodes is
- mainly determined by the edges pointing sidewards. These attributes
+
+ /* Layout downfactor, layout upfactor, layout nearfactor The layout
+ algorithm partitions the set of edges into edges pointing upward,
+ edges pointing downward, and edges pointing sidewards. The last type
+ of edges is also called near edges. If the layout.downfactor is
+ large compared to the layout.upfactor and the layout.nearfactor,
+ then the positions of the nodes is mainly determined by the edges
+ pointing downwards. If the layout.upfactor is large compared to the
+ layout.downfactor and the layout.nearfactor, then the positions of
+ the nodes is mainly determined by the edges pointing upwards. If the
+ layout.nearfactor is large, then the positions of the nodes is
+ mainly determined by the edges pointing sidewards. These attributes
have no effect, if the method for downward laid out trees is used.
Defalut is normal. */
int layout_downfactor;
int layout_upfactor;
int layout_nearfactor;
- /* Layout splinefactor determines the bending at splines. The factor
+ /* Layout splinefactor determines the bending at splines. The factor
100 indicates a very sharp bending, a factor 1 indicates a very flat
bending. Useful values are 30 : : : 80. */
int layout_splinefactor;
-
- /* Late edge labels yes means that the graph is first partitioned and
- then, labels are introduced. The default algorithm first creates
- labels and then partitions the graph, which yield a more compact
+
+ /* Late edge labels yes means that the graph is first partitioned and
+ then, labels are introduced. The default algorithm first creates
+ labels and then partitions the graph, which yield a more compact
layout, but may have more crossings.
Default is no. */
enum decision_e late_edge_labels;
-
- /* Display edge labels yes means display labels and no means don't
+
+ /* Display edge labels yes means display labels and no means don't
display edge labels.
Default vaule is no. */
enum decision_e display_edge_labels;
-
- /* Dirty edge labels yes enforces a fast layout of edge labels, which
- may very ugly because several labels may be drawn at the same place.
+
+ /* Dirty edge labels yes enforces a fast layout of edge labels, which
+ may very ugly because several labels may be drawn at the same place.
Dirty edge labels cannot be used if splines are used.
Default is no.
*/
enum decision_e dirty_edge_labels;
-
- /* Finetuning no switches the fine tuning phase of the graph layout
- algorithm off, while it is on as default. The fine tuning phase
+
+ /* Finetuning no switches the fine tuning phase of the graph layout
+ algorithm off, while it is on as default. The fine tuning phase
tries to give all edges the same length.
Default is yes. */
enum decision_e finetuning;
-
- /* Ignore singles yes hides all nodes which would appear single and
- unconnected from the remaining graph. Such nodes have no edge at all
+
+ /* Ignore singles yes hides all nodes which would appear single and
+ unconnected from the remaining graph. Such nodes have no edge at all
and are sometimes very ugly. Default is to show all nodes.
Default is no. */
enum decision_e ignore_singles;
-
- /* Straight phase yes initiates an additional phase that tries to avoid
+
+ /* Straight phase yes initiates an additional phase that tries to avoid
bendings in long edges.
- Long edges are laid out by long straight vertical lines with
- gradient 90 degree. Thus, this phase is not very appropriate for
- normal layout, but it is recommended, if an orthogonal layout is
+ Long edges are laid out by long straight vertical lines with
+ gradient 90 degree. Thus, this phase is not very appropriate for
+ normal layout, but it is recommended, if an orthogonal layout is
selected (see manhattan.edges).
Default is no. */
enum decision_e straight_phase;
- /* priority phase yes replaces the normal pendulum method by a
- specialized method: It forces straight long edges with 90 degree,
- just as the straight phase. In fact, the straight phase is a fine
- tune phase of the priority method. This phase is also recommended,
- if an orthogonal layout is selected (see manhattan.edges).
+ /* priority phase yes replaces the normal pendulum method by a
+ specialized method: It forces straight long edges with 90 degree,
+ just as the straight phase. In fact, the straight phase is a fine
+ tune phase of the priority method. This phase is also recommended,
+ if an orthogonal layout is selected (see manhattan.edges).
Default is no. */
enum decision_e priority_phase;
- /* manhattan edges yes switches the orthogonal layout on. Orthogonal
- layout (or manhattan layout) means that all edges consist of line
- segments with gradient 0 or 90 degree. Vertical edge segments might
- by shared by several edges, while horizontal edge segments are never
+ /* manhattan edges yes switches the orthogonal layout on. Orthogonal
+ layout (or manhattan layout) means that all edges consist of line
+ segments with gradient 0 or 90 degree. Vertical edge segments might
+ by shared by several edges, while horizontal edge segments are never
shared. This results in very aesthetical layouts just for flowcharts.
- If the orthogonal layout is used, then the priority phase and
- straight phase should be used. Thus, these both phases are switched
- on, too, unless priority layout and straight line tuning are
+ If the orthogonal layout is used, then the priority phase and
+ straight phase should be used. Thus, these both phases are switched
+ on, too, unless priority layout and straight line tuning are
switched off explicitly.
Default is no. */
enum decision_e manhattan_edges;
- /* Smanhattan edges yes switches a specialized orthogonal layout on:
- Here, all horizontal edge segments between two levels share the same
- horizontal line, i.e. not only vertical edge segments are shared,
- but horizontal edge segments are shared by several edges, too. This
- looks nice for trees but might be too confusing in general, because
+ /* Smanhattan edges yes switches a specialized orthogonal layout on:
+ Here, all horizontal edge segments between two levels share the same
+ horizontal line, i.e. not only vertical edge segments are shared,
+ but horizontal edge segments are shared by several edges, too. This
+ looks nice for trees but might be too confusing in general, because
the location of an edge might be ambiguously.
Default is no. */
enum decision_e smanhattan_edges;
-
- /* Near edges no suppresses near edges and bent near edges in the
+
+ /* Near edges no suppresses near edges and bent near edges in the
graph layout.
Default is yes. */
enum decision_e near_edges;
-
- /* Orientation specifies the orientation of the graph: top.to.bottom,
- bottom.to.top, left.to.right or right.to.left. Note: the normal
- orientation is top.to.bottom. All explanations here are given
- relatively to the normal orientation, i.e., e.g., if the orientation
- is left to right, the attribute xlspace is not the horizontal but
+
+ /* Orientation specifies the orientation of the graph: top.to.bottom,
+ bottom.to.top, left.to.right or right.to.left. Note: the normal
+ orientation is top.to.bottom. All explanations here are given
+ relatively to the normal orientation, i.e., e.g., if the orientation
+ is left to right, the attribute xlspace is not the horizontal but
the vertical distance between lines, etc.
Default is to_to_bottom. */
enum orientation_e orientation;
- /* Node alignment specified the vertical alignment of nodes at the
- horizontal reference line of the levels. If top is specified, the
- tops of all nodes of a level have the same y-coordinate; on bottom,
- the bottoms have the same y-coordinate, on center the nodes are
+ /* Node alignment specified the vertical alignment of nodes at the
+ horizontal reference line of the levels. If top is specified, the
+ tops of all nodes of a level have the same y-coordinate; on bottom,
+ the bottoms have the same y-coordinate, on center the nodes are
centered at the levels.
Default is center. */
enum alignement_e node_alignement;
- /* Port sharing no suppresses the sharing of ports of edges at the
- nodes. Normally, if multiple edges are adjacent to the same node,
- and the arrow head of all these edges has the same visual appearance
- (color, size, etc.), then these edges may share a port at a node,
- i.e. only one arrow head is draw, and all edges are incoming into
- this arrow head. This allows to have many edges adjacent to one node
- without getting confused by too many arrow heads. If no port sharing
- is used, each edge has its own port, i.e. its own place where it is
+ /* Port sharing no suppresses the sharing of ports of edges at the
+ nodes. Normally, if multiple edges are adjacent to the same node,
+ and the arrow head of all these edges has the same visual appearance
+ (color, size, etc.), then these edges may share a port at a node,
+ i.e. only one arrow head is draw, and all edges are incoming into
+ this arrow head. This allows to have many edges adjacent to one node
+ without getting confused by too many arrow heads. If no port sharing
+ is used, each edge has its own port, i.e. its own place where it is
adjacent to the node.
Default is yes. */
enum decision_e port_sharing;
- /* Arrow mode fixed (default) should be used, if port sharing is used,
- because then, only a fixed set of rotations for the arrow heads are
- used. If the arrow mode is free, then each arrow head is rotated
- individually to each edge. But this can yield to a black spot, where
- nothing is recognizable, if port sharing is used, since all these
- qdifferently rotated arrow heads are drawn at the same place. If the
- arrow mode is fixed, then the arrow head is rotated only in steps of
+ /* Arrow mode fixed (default) should be used, if port sharing is used,
+ because then, only a fixed set of rotations for the arrow heads are
+ used. If the arrow mode is free, then each arrow head is rotated
+ individually to each edge. But this can yield to a black spot, where
+ nothing is recognizable, if port sharing is used, since all these
+ qdifferently rotated arrow heads are drawn at the same place. If the
+ arrow mode is fixed, then the arrow head is rotated only in steps of
45 degree, and only one arrow head occurs at each port.
- Default is fixed. */
+ Default is fixed. */
enum arrow_mode_e arrow_mode;
- /* Treefactor The algorithm tree for downward laid out trees tries to
- produce a medium dense, balanced tree-like layout. If the tree
- factor is greater than 0.5, the tree edges are spread, i.e. they
- get a larger gradient. This may improve the readability of the tree.
- Note: it is not obvious whether spreading results in a more dense or
- wide layout. For a tree, there is a tree factor such that the whole
+ /* Treefactor The algorithm tree for downward laid out trees tries to
+ produce a medium dense, balanced tree-like layout. If the tree
+ factor is greater than 0.5, the tree edges are spread, i.e. they
+ get a larger gradient. This may improve the readability of the tree.
+ Note: it is not obvious whether spreading results in a more dense or
+ wide layout. For a tree, there is a tree factor such that the whole
tree is minimal wide.
Default is 0.5. */
float treefactor;
- /* Spreadlevel This parameter only influences the algorithm tree, too.
- For large, balanced trees, spreading of the uppermost nodes would
- enlarge the width of the tree too much, such that the tree does not
- fit anymore in a window. Thus, the spreadlevel specifies the minimal
- level (rank) where nodes are spread. Nodes of levels upper than
+ /* Spreadlevel This parameter only influences the algorithm tree, too.
+ For large, balanced trees, spreading of the uppermost nodes would
+ enlarge the width of the tree too much, such that the tree does not
+ fit anymore in a window. Thus, the spreadlevel specifies the minimal
+ level (rank) where nodes are spread. Nodes of levels upper than
spreadlevel are not spread.
Default is 1. */
int spreadlevel;
- /* Crossing weight specifies the weight that is used for the crossing
- reduction: bary (default), median, barymedian or medianbary. We
- cannot give a general recommendation, which is the best method. For
- graphs with very large average degree of edges (number of incoming
- and outgoing edges at a node), the weight bary is the fastest
- method. With the weights barymedian and medianbary, equal weights of
- different nodes are not very probable, thus the crossing reduction
+ /* Crossing weight specifies the weight that is used for the crossing
+ reduction: bary (default), median, barymedian or medianbary. We
+ cannot give a general recommendation, which is the best method. For
+ graphs with very large average degree of edges (number of incoming
+ and outgoing edges at a node), the weight bary is the fastest
+ method. With the weights barymedian and medianbary, equal weights of
+ different nodes are not very probable, thus the crossing reduction
phase 2 might be very fast.
Default is bary. */
enum crossing_type_e crossing_weight;
- /* Crossing phase2 is the most time consuming phase of the crossing
- reduction. In this phase, the nodes that happen to have equal
- crossing weights are permuted. By specifying no, this phase is
+ /* Crossing phase2 is the most time consuming phase of the crossing
+ reduction. In this phase, the nodes that happen to have equal
+ crossing weights are permuted. By specifying no, this phase is
suppressed.
Default is yes. */
enum decision_e crossing_phase2;
- /* Crossing optimization is a postprocessing phase after the normal
- crossing reduction: we try to optimize locally, by exchanging pairs
- of nodes to reduce the crossings. Although this phase is not very
+ /* Crossing optimization is a postprocessing phase after the normal
+ crossing reduction: we try to optimize locally, by exchanging pairs
+ of nodes to reduce the crossings. Although this phase is not very
time consuming, it can be suppressed by specifying no.
Default is yes. */
enum decision_e crossing_optimization;
- /* View allows to select the fisheye views. Because
- of the fixed size of the window that shows the graph, we normally
- can only see a small amount of a large graph. If we shrink the graph
- such that it fits into the window, we cannot recognize any detail
- anymore. Fisheye views are coordinate transformations: the view onto
- the graph is distort, to overcome this usage deficiency. The polar
- fisheye is easy to explain: assume a projection of the plane that
- contains the graph picture onto a spheric ball. If we now look onto
- this ball in 3 D, we have a polar fisheye view. There is a focus
- point which is magnified such that we see all details. Parts of the
- plane that are far away from the focus point are demagnified very
- much. Cartesian fisheye have a similar effect; only the formula for
- the coordinate transformation is different. Selecting cfish means
- the cartesian fisheye is used which demagnifies such that the whole
- graph is visible (self adaptable cartesian fisheye). With fcfish,
- the cartesian fisheye shows the region of a fixed radius around the
- focus point (fixed radius cartesian fisheye). This region might be
- smaller than the whole graph, but the demagnification needed to show
- this region in the window is also not so large, thus more details
- are recognizable. With pfish the self adaptable polar fisheye is
- selected that shows the whole graph, and with fpfish the fixed
+ /* View allows to select the fisheye views. Because
+ of the fixed size of the window that shows the graph, we normally
+ can only see a small amount of a large graph. If we shrink the graph
+ such that it fits into the window, we cannot recognize any detail
+ anymore. Fisheye views are coordinate transformations: the view onto
+ the graph is distort, to overcome this usage deficiency. The polar
+ fisheye is easy to explain: assume a projection of the plane that
+ contains the graph picture onto a spheric ball. If we now look onto
+ this ball in 3 D, we have a polar fisheye view. There is a focus
+ point which is magnified such that we see all details. Parts of the
+ plane that are far away from the focus point are demagnified very
+ much. Cartesian fisheye have a similar effect; only the formula for
+ the coordinate transformation is different. Selecting cfish means
+ the cartesian fisheye is used which demagnifies such that the whole
+ graph is visible (self adaptable cartesian fisheye). With fcfish,
+ the cartesian fisheye shows the region of a fixed radius around the
+ focus point (fixed radius cartesian fisheye). This region might be
+ smaller than the whole graph, but the demagnification needed to show
+ this region in the window is also not so large, thus more details
+ are recognizable. With pfish the self adaptable polar fisheye is
+ selected that shows the whole graph, and with fpfish the fixed
radius polar fisheye is selected.
Defalut is normal view. */
enum view_e view;
/* Edges no suppresses the drawing of edges.
Default is yes. */
enum decision_e edges;
-
+
/* Nodes no suppresses the drawing of nodes.
Default is yes. */
enum decision_e nodes;
/* Splines specifies whether splines are used to draw edges (yes or no).
- As default, polygon segments are used to draw edges, because this is
- much faster. Note that the spline drawing routine is not fully
- validated, and is very slow. Its use is mainly to prepare high
- quality PostScript output for very small graphs.
+ As default, polygon segments are used to draw edges, because this is
+ much faster. Note that the spline drawing routine is not fully
+ validated, and is very slow. Its use is mainly to prepare high
+ quality PostScript output for very small graphs.
Default is no. */
enum decision_e splines;
- /* Bmax set the maximal number of iterations that are done for the
+ /* Bmax set the maximal number of iterations that are done for the
reduction of edge bendings.
Default is 100. */
int bmax;
- /* Cmin set the minimal number of iterations that are done for the
- crossing reduction with the crossing weights. The normal method
- stops if two consecutive checks does not reduce the number of
- crossings anymore. However, this increasing of the number of
- crossings might be locally, such that after some more iterations,
+ /* Cmin set the minimal number of iterations that are done for the
+ crossing reduction with the crossing weights. The normal method
+ stops if two consecutive checks does not reduce the number of
+ crossings anymore. However, this increasing of the number of
+ crossings might be locally, such that after some more iterations,
the crossing number might decrease much more.
Default is 0. */
int cmin;
-
- /* Cmax set the maximal number of interactions for crossing reduction.
+
+ /* Cmax set the maximal number of interactions for crossing reduction.
This is helpful for speedup the layout process.
Default is infinite. */
int cmax;
-
- /* Pmin set the minimal number of iterations that is done with the
- pendulum method. Similar to the crossing reduction, this method
- stops if the `imbalancement weight' does not decreases anymore.
+
+ /* Pmin set the minimal number of iterations that is done with the
+ pendulum method. Similar to the crossing reduction, this method
+ stops if the `imbalancement weight' does not decreases anymore.
However, the increasing of the imbalancement weight might be locally,
- such that after some more iterations, the imbalancement weight might
+ such that after some more iterations, the imbalancement weight might
decrease much more.
Default is 0. */
int pmin;
-
- /* Pmax set the maximal number of iterations of the pendulum method.
+
+ /* Pmax set the maximal number of iterations of the pendulum method.
This is helpful for speedup the layout process.
Default is 100. */
int pmax;
-
- /* Rmin set the minimal number of iterations that is done with the
+
+ /* Rmin set the minimal number of iterations that is done with the
rubberband method. This is similar as for the pendulum method.
Default is 0. */
int rmin;
-
- /* Rmax set the maximal number of iterations of the rubberband method.
+
+ /* Rmax set the maximal number of iterations of the rubberband method.
This is helpful for speedup the layout process.
Default is 100. */
int rmax;
- /* Smax set the maximal number of iterations of the straight line
- recognition phase (useful only, if the straight line recognition
+ /* Smax set the maximal number of iterations of the straight line
+ recognition phase (useful only, if the straight line recognition
phase is switched on, see attribute straight.phase).
Default is 100. */
int smax;
/* List of nodes declared.
Pointer. */
node_t *node_list;
-
+
/* List of edges declared.
Pointer. */
edge_t *edge_list;
-
+
};
/* Graph typedefs. */
void close_graph PARAMS ((graph_t *graph, struct obstack *os));
#endif /* VCG_H_ */
-
projects / bison.git / commitdiff
