作図ソフト dia の改良版
Revision | 98b5344f59b6a9467d94685a84fe4820b480e94d (tree) |
---|---|
Zeit | 2012-09-09 20:05:25 |
Autor | Hans Breuer <hans@breu...> |
Commiter | Hans Breuer |
[dox] Some documentation for plug-ins/(layout|python|shape|svg)
Using the same names e.g. \extends _DiaRenderer allows to couple
some PyDia 'inheritance' with the core objects.
@@ -28,6 +28,10 @@ | ||
28 | 28 | #include <stdio.h> |
29 | 29 | #include <vector> |
30 | 30 | |
31 | +/*! | |
32 | + * \brief A simple x,y coodinate | |
33 | + * \ingroup LayoutPlugin | |
34 | + */ | |
31 | 35 | struct Point |
32 | 36 | { |
33 | 37 | double x; |
@@ -35,6 +39,10 @@ struct Point | ||
35 | 39 | Point (double _x, double _y) : x(_x), y(_y) {} |
36 | 40 | }; |
37 | 41 | |
42 | +/*! | |
43 | + * \brief Another node representation | |
44 | + * \ingroup LayoutPlugin | |
45 | + */ | |
38 | 46 | struct Node |
39 | 47 | { |
40 | 48 | Point center; |
@@ -44,9 +52,18 @@ struct Node | ||
44 | 52 | }; |
45 | 53 | |
46 | 54 | typedef std::vector<Node> Nodes; |
55 | +/*! | |
56 | + * \brief The Edge object is just stroing bends here | |
57 | + * \ingroup LayoutPlugin | |
58 | + */ | |
47 | 59 | typedef std::vector<Point> Edge; |
48 | 60 | typedef std::vector<Edge> Edges; |
49 | 61 | |
62 | +/*! | |
63 | + * \brief Implementing the IGraph interface for simple layout algorithms | |
64 | + * | |
65 | + * \ingroup LayoutPlugin | |
66 | + */ | |
50 | 67 | class DiaGraph : public IGraph |
51 | 68 | { |
52 | 69 | public : |
@@ -93,6 +110,11 @@ DiaGraph::AddEdge (int srcNode, int destNode, double* points, int len) | ||
93 | 110 | return pos; |
94 | 111 | } |
95 | 112 | |
113 | +/*! | |
114 | + * \brief Invoke the given layout algoritm | |
115 | + * | |
116 | + * \ingroup LayoutPlugin | |
117 | + */ | |
96 | 118 | IGraph::eResult |
97 | 119 | DiaGraph::Layout (const char *module) |
98 | 120 | { |
@@ -18,6 +18,14 @@ | ||
18 | 18 | * along with this program; if not, write to the Free Software |
19 | 19 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
20 | 20 | */ |
21 | + | |
22 | +/*! | |
23 | + * \file layout.cpp - plugin for automatic diagram layout | |
24 | + */ | |
25 | +/*! | |
26 | + * \defgroup LayoutPlugin | |
27 | + * \ingroup Plugins | |
28 | + */ | |
21 | 29 | #include <config.h> |
22 | 30 | |
23 | 31 | #include "intl.h" |
@@ -188,6 +196,10 @@ _obj_set_bends (DiaObject *obj, std::vector<double>& coords) | ||
188 | 196 | |
189 | 197 | typedef IGraph *(*GraphCreateFunc)(); |
190 | 198 | |
199 | +/*! | |
200 | + * \brief Calback function invoking layout algorithms from Dia's menu | |
201 | + * \ingroup LayoutPlugin | |
202 | + */ | |
191 | 203 | static ObjectChange * |
192 | 204 | layout_callback (DiagramData *data, |
193 | 205 | const gchar *filename, |
@@ -25,7 +25,7 @@ | ||
25 | 25 | * \brief Abstract graph interface to be fed by Dia |
26 | 26 | * |
27 | 27 | * This interface must not expose any allocation/deallocations and it shall |
28 | - * not let pass any exceptions, because the consumer probaly can't catch them. | |
28 | + * not let pass any exceptions, because the consumer probaly can't catch them. | |
29 | 29 | */ |
30 | 30 | class IGraph |
31 | 31 | { |
@@ -41,6 +41,10 @@ class Klass : | ||
41 | 41 | def SetInheritance_type(self, inheritance_type): |
42 | 42 | self.inheritance_type = inheritance_type |
43 | 43 | |
44 | +## | |
45 | +# \brief Base class of all the code generators | |
46 | +# \extends _DiaPyRenderer | |
47 | +# \ingroup PyDia | |
44 | 48 | class ObjRenderer : |
45 | 49 | "Implements the Object Renderer Interface and transforms diagram into its internal representation" |
46 | 50 | def __init__ (self) : |
@@ -115,6 +119,8 @@ class ObjRenderer : | ||
115 | 119 | self.attributes = [] |
116 | 120 | self.operations = [] |
117 | 121 | |
122 | +## | |
123 | +# \brief Generate a Python source file from an UML class diagram | |
118 | 124 | class PyRenderer(ObjRenderer) : |
119 | 125 | def __init__(self) : |
120 | 126 | ObjRenderer.__init__(self) |
@@ -147,6 +153,8 @@ class PyRenderer(ObjRenderer) : | ||
147 | 153 | f.close() |
148 | 154 | ObjRenderer.end_render(self) |
149 | 155 | |
156 | +## | |
157 | +# \brief Generate C++ source files from an UML class diagram | |
150 | 158 | class CxxRenderer(ObjRenderer) : |
151 | 159 | def __init__(self) : |
152 | 160 | ObjRenderer.__init__(self) |
@@ -210,7 +218,7 @@ class CxxRenderer(ObjRenderer) : | ||
210 | 218 | f.close() |
211 | 219 | ObjRenderer.end_render(self) |
212 | 220 | |
213 | -# ############################################################################# | |
221 | +## | |
214 | 222 | # JsRenderer: export Dia UML diagram to Object style ECMA5 javascript code. |
215 | 223 | # |
216 | 224 | # Features: |
@@ -279,7 +287,7 @@ class JsRenderer(ObjRenderer) : | ||
279 | 287 | f.close() |
280 | 288 | ObjRenderer.end_render(self) |
281 | 289 | |
282 | -# ############################################################################# | |
290 | +## | |
283 | 291 | # PascalRenderer: export Dia UML diagram to Object Pascal (Free Pascal, Delphi) |
284 | 292 | # |
285 | 293 | # Please follow some "drawing guidelines" and "naming conventions" so that the |
@@ -337,7 +345,6 @@ class JsRenderer(ObjRenderer) : | ||
337 | 345 | # - no "Attributes" for interface definitions, but properties are |
338 | 346 | # allowed |
339 | 347 | # - default values for method parameters must be the last parameters |
340 | - | |
341 | 348 | class PascalRenderer(ObjRenderer) : |
342 | 349 | def __init__(self) : |
343 | 350 | ObjRenderer.__init__(self) |
@@ -456,28 +463,28 @@ class PascalRenderer(ObjRenderer) : | ||
456 | 463 | f.close() |
457 | 464 | ObjRenderer.end_render(self) |
458 | 465 | |
459 | -# ###################################################################### | |
466 | +## | |
460 | 467 | # JavaRenderer: export Dia UML diagram to Java |
468 | +# | |
461 | 469 | # improved by: Manuel Arguelles |
462 | 470 | # |
463 | 471 | # Features: |
464 | 472 | # * Comments for classes, attributes, methods and methods parameters are |
465 | 473 | # supported. Uses a comment style javaDoc-like. The comments are |
466 | -# divided into lines if they exceed 79 characters. | |
474 | +# divided into lines if they exceed 79 characters. | |
467 | 475 | # * Splits the classes in separate files. Creates a file that contains |
468 | 476 | # the dia/codegen.py firm :) |
469 | 477 | # |
470 | 478 | # Fixes: |
471 | 479 | # * Visibilities "private" and "protected" were reversed. |
472 | -# * Comments for classes, attributes, methods and methods parameters. | |
480 | +# * Comments for classes, attributes, methods and methods parameters. | |
473 | 481 | # * Comments are divided into lines if they exceed 79 characters. |
474 | 482 | # * Splits the classes in separate files. |
475 | 483 | # * Not write "NULL" in empty comments. |
476 | 484 | # * Writes the default values of the arguments of the methods. |
477 | 485 | # * Makes public all the classes and interfaces. |
478 | 486 | # * Not write "static" in all the methods. |
479 | -# ###################################################################### | |
480 | - | |
487 | +# | |
481 | 488 | class JavaRenderer(ObjRenderer) : |
482 | 489 | def __init__(self) : |
483 | 490 | ObjRenderer.__init__(self) |
@@ -487,7 +494,6 @@ class JavaRenderer(ObjRenderer) : | ||
487 | 494 | |
488 | 495 | mainfile = open(self.filename, "w") |
489 | 496 | mainfile.write("/* Generated by dia/codegen.py\n *\n * Generated files:\n") |
490 | - #mainfile.close() | |
491 | 497 | for name, klass in self.klasses.iteritems() : |
492 | 498 | # splits the classes in separate files |
493 | 499 | classfile = self.filename[:self.filename.rfind("/")+1] + name.capitalize() + ".java" |
@@ -585,8 +591,11 @@ class JavaRenderer(ObjRenderer) : | ||
585 | 591 | mainfile.close() |
586 | 592 | ObjRenderer.end_render(self) |
587 | 593 | |
594 | +## | |
588 | 595 | # PhpRenderer: export Dia UML diagram to PHP |
596 | +# | |
589 | 597 | # Added by: Steven Garcia |
598 | +# | |
590 | 599 | # This is similar to the Java renderer except for PHP |
591 | 600 | # Added class scope (static) support |
592 | 601 | class PhpRenderer(ObjRenderer) : |
@@ -1,8 +1,6 @@ | ||
1 | 1 | # PyDia SVG Renderer |
2 | 2 | # Copyright (c) 2003, 2004 Hans Breuer <hans@breuer.org> |
3 | 3 | # |
4 | -# A full blown SVG(Z) renderer. As of this writing less bugs in the output | |
5 | -# than the Dia SVG renderer written in C | |
6 | 4 | |
7 | 5 | # This program is free software; you can redistribute it and/or modify |
8 | 6 | # it under the terms of the GNU General Public License as published by |
@@ -20,6 +18,15 @@ | ||
20 | 18 | |
21 | 19 | import sys, string, dia |
22 | 20 | |
21 | +## | |
22 | +# \brief The second SvgRenderer implemntation for Dia | |
23 | +# | |
24 | +# A full blown SVG(Z) renderer. As of the initial writing less bugs in the output | |
25 | +# than the Dia SVG renderer written in C. Nowadays the _SvgRenderer is on par, | |
26 | +# but this one is still easier to extend and experiment with. | |
27 | +# | |
28 | +# \extends _DiaPyRenderer | |
29 | +# \ingroup ExportFilters | |
23 | 30 | class SvgRenderer : |
24 | 31 | def __init__ (self) : |
25 | 32 | self.f = None |
@@ -15,7 +15,10 @@ | ||
15 | 15 | # along with this program; if not, write to the Free Software |
16 | 16 | # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
17 | 17 | |
18 | -# translate dot ( http://www.graphviz.org/ ) to Dia format | |
18 | +## | |
19 | +# \file dot2dia.py \brief translate dot ( http://www.graphviz.org/ ) to Dia format | |
20 | +# \ingroup ImportFilters | |
21 | + | |
19 | 22 | import re, string, sys |
20 | 23 | |
21 | 24 | # FIXME: keywords are case indepentend |
@@ -47,6 +50,8 @@ def DictFromString (s) : | ||
47 | 50 | d[m.group ("key")] = StripQuotes(m.group ("val")) |
48 | 51 | return d |
49 | 52 | |
53 | +## | |
54 | +# \brief Accumulating information with _DiaObject | |
50 | 55 | class Object : |
51 | 56 | """ will end as a Dia Object """ |
52 | 57 | def __init__ (self, typename, parms) : |
@@ -57,7 +62,8 @@ class Object : | ||
57 | 62 | return float(self.parms['fontsize']) * cmPoints |
58 | 63 | except : |
59 | 64 | return 0.6 |
60 | - | |
65 | +## | |
66 | +# \brief The nodes of the graph - finally represented as _Ellipse | |
61 | 67 | class Node(Object) : |
62 | 68 | def __init__ (self, name, parms) : |
63 | 69 | Object.__init__(self, "Standard - Ellipse", parms) |
@@ -82,6 +88,8 @@ class Node(Object) : | ||
82 | 88 | print "No size on '%s'" % (self.name,) |
83 | 89 | return w,h |
84 | 90 | |
91 | +## | |
92 | +# \brief The edges of the graph - finally represented as _Bezierline | |
85 | 93 | class Edge(Object) : |
86 | 94 | def __init__ (self, src, dest, parms) : |
87 | 95 | Object.__init__(self, "Standard - BezierLine", parms) |
@@ -140,6 +148,8 @@ def MergeParms (d, extra) : | ||
140 | 148 | if not d.has_key(k) : |
141 | 149 | d[k] = extra[k] |
142 | 150 | |
151 | +## | |
152 | +# \brief Parsing the given dot file | |
143 | 153 | def Parse(sFile) : |
144 | 154 | f = open(sFile, 'r') |
145 | 155 | s = f.read() |
@@ -179,6 +189,13 @@ def Parse(sFile) : | ||
179 | 189 | edges.append(Edge(StripQuotes(m.group("n1")), StripQuotes(m.group("n2")), DictFromString(m.group("dict")))) |
180 | 190 | return [nodes, edges] |
181 | 191 | |
192 | +## | |
193 | +# \brief Adding a label for the edges | |
194 | +# | |
195 | +# This function could be improved if Dia would allow to | |
196 | +# attach labels to arbitrary objects. For the time being | |
197 | +# only the initial postion does match, but relayouting the | |
198 | +# graph in Dia will loose the position | |
182 | 199 | def AddLabel (layer, pos, label, fontsize, center=0) : |
183 | 200 | """ create a Text object an put it into the layer """ |
184 | 201 | textType = dia.get_object_type("Standard - Text") |
@@ -191,6 +208,8 @@ def AddLabel (layer, pos, label, fontsize, center=0) : | ||
191 | 208 | obj.properties["text_vert_alignment"] = 2 |
192 | 209 | layer.add_object(obj) |
193 | 210 | |
211 | +## | |
212 | +# \brief Callback registered for the ImportFilter | |
194 | 213 | def ImportFile (sFile, diagramData) : |
195 | 214 | """ read the dot file and create diagram objects """ |
196 | 215 | nodes, edges = Parse(sFile) |
@@ -2,9 +2,19 @@ import sys, dia | ||
2 | 2 | |
3 | 3 | # sys.path.insert(0, 'd:/graph/dia/dia') |
4 | 4 | |
5 | +## | |
6 | +# \brief A simple example renderer implemented in Python | |
7 | +# \extends _DiaPyRenderer | |
8 | +# \ingroup PyDia | |
5 | 9 | class DumpRenderer : |
10 | + ## \brief Constructor | |
6 | 11 | def __init__ (self) : |
7 | 12 | pass |
13 | + ## \brief Start rendering | |
14 | + # For non-interactive renderers it is guaranteed that this function is | |
15 | + # called before every drawing function. It should be used to clear the | |
16 | + # state from previous use, because the renderer class gets only created | |
17 | + # once per Dia session | |
8 | 18 | def begin_render (self, data, filename) : |
9 | 19 | # DiagramData |
10 | 20 | self.f = open(filename, "w") |
@@ -15,70 +25,104 @@ class DumpRenderer : | ||
15 | 25 | #self.f.write("grid .width: " + str(data.grid.width) \ |
16 | 26 | # + " .height" + str(data.grid.height) \ |
17 | 27 | # + "visible: " + str(data.visible) + "\n") |
28 | + ## \brief End rendering | |
29 | + # For non-interactive renderers it is guaranteed that all drawing | |
30 | + # is finished with this call | |
18 | 31 | def end_render (self) : |
19 | 32 | self.f.close() |
33 | + ## \brief Remember the line width | |
20 | 34 | def set_linewidth (self, width) : |
21 | 35 | self.line_width = width |
36 | + ## \brief Remember the line caps | |
22 | 37 | def set_linecaps (self, mode) : |
23 | 38 | self.line_caps = mode |
39 | + ## \brief Remember the line join | |
24 | 40 | def set_linejoin (self, mode) : |
25 | 41 | self.line_join = mode |
42 | + ## \brief Remember the line style | |
26 | 43 | def set_linestyle (self, style) : |
27 | 44 | self.line_style = style |
45 | + ## \brief Remember the dash length | |
28 | 46 | def set_dashlength (self, length) : |
29 | 47 | self.dash_length = length |
48 | + ## \brief Remember the fill style | |
30 | 49 | def set_fillstyle (self, style) : |
31 | 50 | self.fill_style = style |
51 | + ## \brief Remember the font | |
32 | 52 | def set_font (self, font, size) : |
33 | 53 | self.font = font |
54 | + ## \brief Draw a straight line from start to end with color | |
55 | + # @param start A point in diagram coordinate system | |
56 | + # @param end A point in diagram coordinate system | |
57 | + # @param color The color to use for the line | |
58 | + # The addtional paramters needed for the drawing are given | |
59 | + # by one of the set_*() function above | |
34 | 60 | def draw_line (self, start, end, color) : |
35 | 61 | self.f.write("draw_line:" + str(start) + str(end) + str(color) + "\n") |
62 | + ## \brief Draw a polyline | |
63 | + # @param points An array of points in the diagram coordinate system | |
64 | + # @param color The color to use for the line | |
36 | 65 | def draw_polyline (self, points, color) : |
37 | 66 | self.f.write("draw_polyline: " + str(color) + "\n") |
38 | 67 | for pt in points : |
39 | 68 | self.f.write ("\t" + str(pt) + "\n") |
69 | + ## \brief Draw a polygon | |
70 | + # @param points An array of points in the diagram coordinate system | |
71 | + # @param color The color to use for the line | |
40 | 72 | def draw_polygon (self, points, color) : |
41 | 73 | self.f.write("draw_polygon: " + str(color) + "\n") |
42 | 74 | for pt in points : |
43 | 75 | self.f.write ("\t" + str(pt) + "\n") |
76 | + ## \brief Fill a polygon | |
44 | 77 | def fill_polygon (self, points, color) : |
45 | 78 | self.f.write("fill_polygon: " + str(color) + "\n") |
46 | 79 | for pt in points : |
47 | 80 | self.f.write ("\t" + str(pt) + "\n") |
81 | + ## \brief Draw a rectangle | |
48 | 82 | def draw_rect (self, rect, color) : |
49 | 83 | self.f.write("draw_rect: " + str(rect) + str(color) + "\n") |
84 | + ## \brief Fill a rectangle | |
50 | 85 | def fill_rect (self, rect, color) : |
51 | 86 | self.f.write("fill_rect: " + str(rect) + str(color) + "\n") |
87 | + ## \brief Draw an arc | |
52 | 88 | def draw_arc (self, center, width, height, angle1, angle2, color) : |
53 | 89 | self.f.write("draw_arc: " + str(center) + ";" \ |
54 | 90 | + str(width) + "x" + str(height) + ";" \ |
55 | 91 | + str(angle1) + "," + str(angle2) + ";" + str(color) + "\n") |
92 | + ## \brief Fill an arc | |
56 | 93 | def fill_arc (self, center, width, height, angle1, angle2, color) : |
57 | 94 | self.f.write("fill_arc: " + str(center) + ";" \ |
58 | 95 | + str(width) + "x" + str(height) + ";" \ |
59 | 96 | + str(angle1) + "," + str(angle2) + ";" + str(color) + "\n") |
97 | + ## \brief Draw an ellipse | |
60 | 98 | def draw_ellipse (self, center, width, height, color) : |
61 | 99 | self.f.write("draw_ellipse: " + str(center) \ |
62 | 100 | + str(width) + "x" +str(height) + ";" + str(color) + "\n") |
101 | + ## \brief Fill an ellipse | |
63 | 102 | def fill_ellipse (self, center, width, height, color) : |
64 | 103 | self.f.write("fill_ellipse: " + str(center) \ |
65 | 104 | + str(width) + "x" +str(height) + ";" + str(color) + "\n") |
105 | + ## \brief Draw a bezier line | |
66 | 106 | def draw_bezier (self, bezpoints, color) : |
67 | 107 | self.f.write("draw_bezier: " + str(color) + "\n") |
68 | 108 | for pt in bezpoints : |
69 | 109 | self.f.write ("\t" + str(pt) + "\n") |
110 | + ## \brief Fill a bezier shape | |
70 | 111 | def fill_bezier (self, bezpoints, color) : |
71 | 112 | self.f.write("fill_bezier: " + str(color) + "\n") |
72 | 113 | for pt in bezpoints : |
73 | 114 | self.f.write ("\t" + str(pt) + "\n") |
115 | + ## \brief Draw a string | |
74 | 116 | def draw_string (self, text, pos, alignment, color) : |
75 | 117 | self.f.write("draw_string: [" + text + "]; " + str(pos) \ |
76 | 118 | + str(alignment) + "; " +str(color)) |
119 | + ## \brief Draw an image | |
77 | 120 | def draw_image (self, point, width, height, image) : |
78 | 121 | self.f.write("draw_image: " + str(point) + str(width) + "x" +str(height) \ |
79 | 122 | + " " + image.filename + "\n") |
80 | 123 | self.f.write("<rgb_data>" + image.rgb_data + "</rgb_data>") |
81 | 124 | self.f.write("<mask_data>" + image.mask_data + "</mask_data>") |
82 | 125 | |
126 | +## \brief Register the renderer with Dia's export system | |
83 | 127 | # dia-python keeps a reference to the renderer class and uses it on demand |
84 | 128 | dia.register_export ("PyDia Render Export", "diapyr", DumpRenderer()) |
@@ -17,6 +17,16 @@ | ||
17 | 17 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
18 | 18 | */ |
19 | 19 | |
20 | +/*! | |
21 | + * \file pydia-render.c Wrapper to implement _DiaRenderer in Python | |
22 | + * | |
23 | + * The PyDiaRenderer is currently defined in Python only. The | |
24 | + * DiaPyRenderer is using it's interface to map the gobject | |
25 | + * DiaRenderer to it. A next step could be to let Python code | |
26 | + * directly inherit from DiaPyRenderer. | |
27 | + * To do that probably some code from pygtk.gobject needs to | |
28 | + * be borrowed/shared | |
29 | + */ | |
20 | 30 | #include <config.h> |
21 | 31 | |
22 | 32 | #include <Python.h> |
@@ -38,14 +48,6 @@ | ||
38 | 48 | #include "pydia-error.h" |
39 | 49 | #include "pydia-render.h" |
40 | 50 | |
41 | -/* | |
42 | - * The PyDiaRenderer is currently defined in Python only. The | |
43 | - * DiaPyRenderer is using it's interface to map the gobject | |
44 | - * DiaRenderer to it. A next step could be to let Python code | |
45 | - * directly inherit from DiaPyRenderer. | |
46 | - * To do that probably some code from pygtk.gobject needs to | |
47 | - * be borrowed/shared | |
48 | - */ | |
49 | 51 | #include "diarenderer.h" |
50 | 52 | |
51 | 53 | #define DIA_TYPE_PY_RENDERER (dia_py_renderer_get_type ()) |
@@ -54,11 +56,23 @@ | ||
54 | 56 | #define DIA_IS_PY_RENDERER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), DIA_TYPE_PY_RENDERER)) |
55 | 57 | #define DIA_PY_RENDERER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), DIA_TYPE_PY_RENDERER, DiaPyRendererClass)) |
56 | 58 | |
57 | -GType dia_py_renderer_get_type (void) G_GNUC_CONST; | |
58 | - | |
59 | 59 | typedef struct _DiaPyRenderer DiaPyRenderer; |
60 | 60 | typedef struct _DiaPyRendererClass DiaPyRendererClass; |
61 | 61 | |
62 | +/*! | |
63 | + * \brief Wrapper class to allow renderer implementation in Python | |
64 | + * | |
65 | + * The DiaPyRenderer class serves basically two use cases. | |
66 | + * - the assumed to be obvious one is to implement a drawing exporter | |
67 | + * in Python. See diasvg.SvgRenderer for an example. | |
68 | + * - the other use case is implemented with codegen.ObjRenderer | |
69 | + * which does not deal with graphical information at all, but instead | |
70 | + * takes the _DiagramData object given in begin_render() and iterates | |
71 | + * over layers and objects to extract textual information. | |
72 | + * | |
73 | + * \extends _DiaRenderer | |
74 | + * \ingroup PyDia | |
75 | + */ | |
62 | 76 | struct _DiaPyRenderer |
63 | 77 | { |
64 | 78 | DiaRenderer parent_instance; |
@@ -77,8 +91,20 @@ struct _DiaPyRendererClass | ||
77 | 91 | #define PYDIA_RENDERER(renderer) \ |
78 | 92 | (DIA_PY_RENDERER(renderer)->self) |
79 | 93 | |
80 | -/* | |
81 | - * Members overwritable by Python scripts | |
94 | +/* Moved here to avoid Doxygen picking up the wrong definitions */ | |
95 | +GType dia_py_renderer_get_type (void) G_GNUC_CONST; | |
96 | + | |
97 | +/*! | |
98 | + * \brief Begin rendering with Python | |
99 | + * | |
100 | + * @param renderer Explicit this pointer | |
101 | + * @param update The rectangle to update or NULL for everything | |
102 | + * | |
103 | + * The Python side of the begin_render() method has a different signature. | |
104 | + * It gets passed in a PyDia wrapped _DiagramData object and a filename | |
105 | + * to store to. | |
106 | + * | |
107 | + * \memberof _DiaPyRenderer | |
82 | 108 | */ |
83 | 109 | static void |
84 | 110 | begin_render(DiaRenderer *renderer, const Rectangle *update) |
@@ -104,6 +130,11 @@ begin_render(DiaRenderer *renderer, const Rectangle *update) | ||
104 | 130 | } |
105 | 131 | } |
106 | 132 | |
133 | +/*! | |
134 | + * \brief Finalize drawing/exporting | |
135 | + * | |
136 | + * \memberof _DiaPyRenderer | |
137 | + */ | |
107 | 138 | static void |
108 | 139 | end_render(DiaRenderer *renderer) |
109 | 140 | { |
@@ -126,6 +157,13 @@ end_render(DiaRenderer *renderer) | ||
126 | 157 | setlocale(LC_NUMERIC, DIA_PY_RENDERER(renderer)->old_locale); |
127 | 158 | } |
128 | 159 | |
160 | +/*! | |
161 | + * \brief Set linewidth for later use | |
162 | + * | |
163 | + * Optional on the PyDia side. | |
164 | + * | |
165 | + * \memberof _DiaPyRenderer | |
166 | + */ | |
129 | 167 | static void |
130 | 168 | set_linewidth(DiaRenderer *renderer, real linewidth) |
131 | 169 | { |
@@ -148,6 +186,13 @@ set_linewidth(DiaRenderer *renderer, real linewidth) | ||
148 | 186 | PyErr_Clear(); |
149 | 187 | } |
150 | 188 | |
189 | +/*! | |
190 | + * \brief Set linecaps for later use | |
191 | + * | |
192 | + * Optional on the PyDia side. | |
193 | + * | |
194 | + * \memberof _DiaPyRenderer | |
195 | + */ | |
151 | 196 | static void |
152 | 197 | set_linecaps(DiaRenderer *renderer, LineCaps mode) |
153 | 198 | { |
@@ -181,6 +226,13 @@ set_linecaps(DiaRenderer *renderer, LineCaps mode) | ||
181 | 226 | PyErr_Clear(); |
182 | 227 | } |
183 | 228 | |
229 | +/*! | |
230 | + * \brief Set linejoin for later use | |
231 | + * | |
232 | + * Optional on the PyDia side. | |
233 | + * | |
234 | + * \memberof _DiaPyRenderer | |
235 | + */ | |
184 | 236 | static void |
185 | 237 | set_linejoin(DiaRenderer *renderer, LineJoin mode) |
186 | 238 | { |
@@ -214,6 +266,13 @@ set_linejoin(DiaRenderer *renderer, LineJoin mode) | ||
214 | 266 | PyErr_Clear(); |
215 | 267 | } |
216 | 268 | |
269 | +/*! | |
270 | + * \brief Set linestyle for later use | |
271 | + * | |
272 | + * Optional on the PyDia side. | |
273 | + * | |
274 | + * \memberof _DiaPyRenderer | |
275 | + */ | |
217 | 276 | static void |
218 | 277 | set_linestyle(DiaRenderer *renderer, LineStyle mode) |
219 | 278 | { |
@@ -252,6 +311,13 @@ set_linestyle(DiaRenderer *renderer, LineStyle mode) | ||
252 | 311 | PyErr_Clear(); |
253 | 312 | } |
254 | 313 | |
314 | +/*! | |
315 | + * \brief Set dash length for later use | |
316 | + * | |
317 | + * Optional on the PyDia side. | |
318 | + * | |
319 | + * \memberof _DiaPyRenderer | |
320 | + */ | |
255 | 321 | static void |
256 | 322 | set_dashlength(DiaRenderer *renderer, real length) |
257 | 323 | { |
@@ -274,6 +340,13 @@ set_dashlength(DiaRenderer *renderer, real length) | ||
274 | 340 | PyErr_Clear(); |
275 | 341 | } |
276 | 342 | |
343 | +/*! | |
344 | + * \brief Set fillstyle for later use | |
345 | + * | |
346 | + * Optional on the PyDia side. | |
347 | + * | |
348 | + * \memberof _DiaPyRenderer | |
349 | + */ | |
277 | 350 | static void |
278 | 351 | set_fillstyle(DiaRenderer *renderer, FillStyle mode) |
279 | 352 | { |
@@ -303,6 +376,13 @@ set_fillstyle(DiaRenderer *renderer, FillStyle mode) | ||
303 | 376 | PyErr_Clear(); |
304 | 377 | } |
305 | 378 | |
379 | +/*! | |
380 | + * \brief Set font for later use | |
381 | + * | |
382 | + * Optional on the PyDia side. | |
383 | + * | |
384 | + * \memberof _DiaPyRenderer | |
385 | + */ | |
306 | 386 | static void |
307 | 387 | set_font(DiaRenderer *renderer, DiaFont *font, real height) |
308 | 388 | { |
@@ -330,6 +410,34 @@ set_font(DiaRenderer *renderer, DiaFont *font, real height) | ||
330 | 410 | |
331 | 411 | static gpointer parent_class = NULL; |
332 | 412 | |
413 | +/*! | |
414 | + * \brief Draw object | |
415 | + * | |
416 | + * Optional on the PyDia side. If not implemented the base class method | |
417 | + * will be called. | |
418 | + * | |
419 | + * Intercepting this method on the Python side allows to create per | |
420 | + * object information in the drawing. It is also necessary if the PyDia | |
421 | + * renderer should support transformations. | |
422 | + * | |
423 | + * If implementing a drawing exposrt filter and overwriting draw_object() | |
424 | + * the following code shall be used. Otherwise no draw/fill method will | |
425 | + * be called at all. | |
426 | + * | |
427 | + * \code | |
428 | + # don't forget to render the object | |
429 | + object.draw (self) | |
430 | + * \endcode | |
431 | + * | |
432 | + * Not calling the object draw method is only usefull when a non-drawing | |
433 | + * export - e.g. code generation \sa codegen.py - is implemented. | |
434 | + * | |
435 | + * @param renderer Self | |
436 | + * @param object The object to draw | |
437 | + * @param matrix The transformation matrix to use or NULL for no transformation | |
438 | + * | |
439 | + * \memberof _DiaPyRenderer | |
440 | + */ | |
333 | 441 | static void |
334 | 442 | draw_object (DiaRenderer *renderer, DiaObject *object, DiaMatrix *matrix) |
335 | 443 | { |
@@ -365,6 +473,14 @@ draw_object (DiaRenderer *renderer, DiaObject *object, DiaMatrix *matrix) | ||
365 | 473 | } |
366 | 474 | } |
367 | 475 | |
476 | +/*! | |
477 | + * \brief Draw line | |
478 | + * | |
479 | + * Not optional on the PyDia side. If not implemented a runtime warning | |
480 | + * will be generated when called. | |
481 | + * | |
482 | + * \memberof _DiaPyRenderer | |
483 | + */ | |
368 | 484 | static void |
369 | 485 | draw_line(DiaRenderer *renderer, |
370 | 486 | Point *start, Point *end, |
@@ -401,6 +517,13 @@ draw_line(DiaRenderer *renderer, | ||
401 | 517 | } |
402 | 518 | } |
403 | 519 | |
520 | +/*! | |
521 | + * \brief Draw polyline | |
522 | + * | |
523 | + * Optional on the PyDia side. If not implemented fallback to base class member. | |
524 | + * | |
525 | + * \memberof _DiaPyRenderer | |
526 | + */ | |
404 | 527 | static void |
405 | 528 | draw_polyline(DiaRenderer *renderer, |
406 | 529 | Point *points, int num_points, |
@@ -433,6 +556,13 @@ draw_polyline(DiaRenderer *renderer, | ||
433 | 556 | } |
434 | 557 | } |
435 | 558 | |
559 | +/*! | |
560 | + * \brief Draw polygon | |
561 | + * | |
562 | + * Optional on the PyDia side. If not implemented fallback to base class member. | |
563 | + * | |
564 | + * \memberof _DiaPyRenderer | |
565 | + */ | |
436 | 566 | static void |
437 | 567 | draw_polygon(DiaRenderer *renderer, |
438 | 568 | Point *points, int num_points, |
@@ -465,6 +595,14 @@ draw_polygon(DiaRenderer *renderer, | ||
465 | 595 | } |
466 | 596 | } |
467 | 597 | |
598 | +/*! | |
599 | + * \brief Fill polygon | |
600 | + * | |
601 | + * Not optional on the PyDia side. If not implemented a runtime warning | |
602 | + * will be generated when called. | |
603 | + * | |
604 | + * \memberof _DiaPyRenderer | |
605 | + */ | |
468 | 606 | static void |
469 | 607 | fill_polygon(DiaRenderer *renderer, |
470 | 608 | Point *points, int num_points, |
@@ -563,6 +701,14 @@ draw_rounded_rect(DiaRenderer *renderer, | ||
563 | 701 | } |
564 | 702 | |
565 | 703 | |
704 | +/*! | |
705 | + * \brief Fill rectangle | |
706 | + * | |
707 | + * Not optional on the PyDia side. If not implemented a runtime warning | |
708 | + * will be generated when called. | |
709 | + * | |
710 | + * \memberof _DiaPyRenderer | |
711 | + */ | |
566 | 712 | static void |
567 | 713 | fill_rect(DiaRenderer *renderer, |
568 | 714 | Point *ul_corner, Point *lr_corner, |
@@ -667,6 +813,14 @@ draw_arc(DiaRenderer *renderer, | ||
667 | 813 | } |
668 | 814 | } |
669 | 815 | |
816 | +/*! | |
817 | + * \brief Fill arc | |
818 | + * | |
819 | + * Not optional on the PyDia side. If not implemented a runtime warning | |
820 | + * will be generated when called. | |
821 | + * | |
822 | + * \memberof _DiaPyRenderer | |
823 | + */ | |
670 | 824 | static void |
671 | 825 | fill_arc(DiaRenderer *renderer, |
672 | 826 | Point *center, |
@@ -705,6 +859,14 @@ fill_arc(DiaRenderer *renderer, | ||
705 | 859 | } |
706 | 860 | } |
707 | 861 | |
862 | +/*! | |
863 | + * \brief Draw ellipse | |
864 | + * | |
865 | + * Not optional on the PyDia side. If not implemented a runtime warning | |
866 | + * will be generated when called. | |
867 | + * | |
868 | + * \memberof _DiaPyRenderer | |
869 | + */ | |
708 | 870 | static void |
709 | 871 | draw_ellipse(DiaRenderer *renderer, |
710 | 872 | Point *center, |
@@ -740,6 +902,14 @@ draw_ellipse(DiaRenderer *renderer, | ||
740 | 902 | } |
741 | 903 | } |
742 | 904 | |
905 | +/*! | |
906 | + * \brief Fill ellipse | |
907 | + * | |
908 | + * Not optional on the PyDia side. If not implemented a runtime warning | |
909 | + * will be generated when called. | |
910 | + * | |
911 | + * \memberof _DiaPyRenderer | |
912 | + */ | |
743 | 913 | static void |
744 | 914 | fill_ellipse(DiaRenderer *renderer, |
745 | 915 | Point *center, |
@@ -838,6 +1008,14 @@ fill_bezier(DiaRenderer *renderer, | ||
838 | 1008 | } |
839 | 1009 | } |
840 | 1010 | |
1011 | +/*! | |
1012 | + * \brief Draw string | |
1013 | + * | |
1014 | + * Not optional on the PyDia side. If not implemented a runtime warning | |
1015 | + * will be generated when called. | |
1016 | + * | |
1017 | + * \memberof _DiaPyRenderer | |
1018 | + */ | |
841 | 1019 | static void |
842 | 1020 | draw_string(DiaRenderer *renderer, |
843 | 1021 | const char *text, |
@@ -884,6 +1062,14 @@ draw_string(DiaRenderer *renderer, | ||
884 | 1062 | } |
885 | 1063 | } |
886 | 1064 | |
1065 | +/*! | |
1066 | + * \brief Draw image | |
1067 | + * | |
1068 | + * Not optional on the PyDia side. If not implemented a runtime warning | |
1069 | + * will be generated when called. | |
1070 | + * | |
1071 | + * \memberof _DiaPyRenderer | |
1072 | + */ | |
887 | 1073 | static void |
888 | 1074 | draw_image(DiaRenderer *renderer, |
889 | 1075 | Point *point, |
@@ -71,11 +71,14 @@ G_BEGIN_DECLS | ||
71 | 71 | #define SHAPE_IS_RENDERER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), SHAPE_TYPE_RENDERER)) |
72 | 72 | #define SHAPE_RENDERER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), SHAPE_TYPE_RENDERER, ShapeRendererClass)) |
73 | 73 | |
74 | -GType shape_renderer_get_type (void) G_GNUC_CONST; | |
75 | - | |
76 | 74 | typedef struct _ShapeRenderer ShapeRenderer; |
77 | 75 | typedef struct _ShapeRendererClass ShapeRendererClass; |
78 | 76 | |
77 | +/*! | |
78 | + * \brief Shape export for use as \ref Shapes | |
79 | + * | |
80 | + * \extends _DiaSvgRenderer | |
81 | + */ | |
79 | 82 | struct _ShapeRenderer |
80 | 83 | { |
81 | 84 | DiaSvgRenderer parent_instance; |
@@ -102,8 +105,8 @@ static void draw_line(DiaRenderer *self, | ||
102 | 105 | Color *line_colour); |
103 | 106 | static void |
104 | 107 | draw_object(DiaRenderer *self, |
105 | - DiaObject *object, | |
106 | - DiaMatrix *matrix); | |
108 | + DiaObject *object, | |
109 | + DiaMatrix *matrix); | |
107 | 110 | static void draw_polyline(DiaRenderer *self, |
108 | 111 | Point *points, int num_points, |
109 | 112 | Color *line_colour); |
@@ -128,6 +131,9 @@ static void add_ellipse_connection_points(ShapeRenderer *renderer, | ||
128 | 131 | Point *center, |
129 | 132 | real width, real height); |
130 | 133 | |
134 | +/* Moved to reduce confusion of Doxygen */ | |
135 | +GType shape_renderer_get_type (void) G_GNUC_CONST; | |
136 | + | |
131 | 137 | static DiaSvgRenderer * |
132 | 138 | new_shape_renderer(DiagramData *data, const char *filename) |
133 | 139 | { |
@@ -55,16 +55,20 @@ G_BEGIN_DECLS | ||
55 | 55 | #define SVG_IS_RENDERER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), SVG_TYPE_RENDERER)) |
56 | 56 | #define SVG_RENDERER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), SVG_TYPE_RENDERER, SvgRendererClass)) |
57 | 57 | |
58 | -GType svg_renderer_get_type (void) G_GNUC_CONST; | |
59 | - | |
60 | 58 | typedef struct _SvgRenderer SvgRenderer; |
61 | 59 | typedef struct _SvgRendererClass SvgRendererClass; |
62 | 60 | |
61 | +/*! | |
62 | + * \brief Svg renderer written in C | |
63 | + * | |
64 | + * \extends _DiaSvgRenderer | |
65 | + * \bug Doxygen chokes on this file and simply ignores dox after parents | |
66 | + */ | |
63 | 67 | struct _SvgRenderer |
64 | 68 | { |
65 | 69 | DiaSvgRenderer parent_instance; |
66 | 70 | |
67 | - /* track the parents while grouping in draw_object() */ | |
71 | + /*! track the parents while grouping in draw_object() */ | |
68 | 72 | GQueue *parents; |
69 | 73 | }; |
70 | 74 |
@@ -75,6 +79,9 @@ struct _SvgRendererClass | ||
75 | 79 | |
76 | 80 | G_END_DECLS |
77 | 81 | |
82 | +/* Moved because it disturbs Doxygen */ | |
83 | +GType svg_renderer_get_type (void) G_GNUC_CONST; | |
84 | + | |
78 | 85 | static DiaSvgRenderer *new_svg_renderer(DiagramData *data, const char *filename); |
79 | 86 | |
80 | 87 | static void draw_object (DiaRenderer *renderer, |
@@ -182,7 +189,15 @@ svg_renderer_class_init (SvgRendererClass *klass) | ||
182 | 189 | renderer_class->draw_text_line = draw_text_line; |
183 | 190 | } |
184 | 191 | |
185 | - | |
192 | +/*! | |
193 | + * \brief Cration and intialization of the SvgRenderer | |
194 | + * | |
195 | + * Using the same base class as the Shape renderer, but with slightly | |
196 | + * different parameters. Here we want to be as compatible as feasible | |
197 | + * with the SVG specification to support proper diagram exchage. | |
198 | + * | |
199 | + * \memberof SvgRenderer | |
200 | + */ | |
186 | 201 | static DiaSvgRenderer * |
187 | 202 | new_svg_renderer(DiagramData *data, const char *filename) |
188 | 203 | { |
@@ -234,15 +249,19 @@ new_svg_renderer(DiagramData *data, const char *filename) | ||
234 | 249 | return renderer; |
235 | 250 | } |
236 | 251 | |
252 | +/*! | |
253 | + * \brief Wrap every object in \<g\>\</g\> and apply transformation | |
254 | + * | |
255 | + * We could try to be smart and count the objects we using for the object. | |
256 | + * If it is only one the grouping is superfluous and should be removed. | |
257 | + * | |
258 | + * \memberof ScgRenderer | |
259 | + */ | |
237 | 260 | static void |
238 | 261 | draw_object(DiaRenderer *self, |
239 | 262 | DiaObject *object, |
240 | 263 | DiaMatrix *matrix) |
241 | 264 | { |
242 | - /* wrap in <g></g> | |
243 | - * We could try to be smart and count the objects we using for the object. | |
244 | - * If it is only one the grouping is superfluous and should be removed. | |
245 | - */ | |
246 | 265 | DiaSvgRenderer *renderer = DIA_SVG_RENDERER (self); |
247 | 266 | SvgRenderer *svg_renderer = SVG_RENDERER (self); |
248 | 267 | int n_children = 0; |
@@ -278,6 +297,10 @@ draw_object(DiaRenderer *self, | ||
278 | 297 | } |
279 | 298 | } |
280 | 299 | |
300 | +/*! | |
301 | + * \brief creation of rectangles with corner radius | |
302 | + * \memberof SvgRenderer | |
303 | + */ | |
281 | 304 | static void |
282 | 305 | draw_rounded_rect(DiaRenderer *self, |
283 | 306 | Point *ul_corner, Point *lr_corner, |
@@ -305,6 +328,10 @@ draw_rounded_rect(DiaRenderer *self, | ||
305 | 328 | xmlSetProp(node, (const xmlChar *)"ry", (xmlChar *) buf); |
306 | 329 | } |
307 | 330 | |
331 | +/*! | |
332 | + * \brief creation of filled rectangles with corner radius | |
333 | + * \memberof SvgRenderer | |
334 | + */ | |
308 | 335 | static void |
309 | 336 | fill_rounded_rect(DiaRenderer *self, |
310 | 337 | Point *ul_corner, Point *lr_corner, |
@@ -401,6 +428,14 @@ node_set_text_style (xmlNodePtr node, | ||
401 | 428 | g_free(style); |
402 | 429 | } |
403 | 430 | |
431 | +/*! | |
432 | + * \brief Support rendering of raw text | |
433 | + * | |
434 | + * This is the only function in the renderer interface using the | |
435 | + * font passed in by set_font() method. | |
436 | + * | |
437 | + * \memberof SvgRenderer | |
438 | + */ | |
404 | 439 | static void |
405 | 440 | draw_string(DiaRenderer *self, |
406 | 441 | const char *text, |
@@ -421,6 +456,10 @@ draw_string(DiaRenderer *self, | ||
421 | 456 | xmlSetProp(node, (xmlChar *)"y", (xmlChar *)d_buf); |
422 | 457 | } |
423 | 458 | |
459 | +/*! | |
460 | + * \brief Support rendering of the _TextLine object | |
461 | + * \memberof SvgRenderer | |
462 | + */ | |
424 | 463 | static void |
425 | 464 | draw_text_line(DiaRenderer *self, TextLine *text_line, |
426 | 465 | Point *pos, Alignment alignment, Color *colour) |
@@ -445,6 +484,15 @@ draw_text_line(DiaRenderer *self, TextLine *text_line, | ||
445 | 484 | xmlSetProp(node, (const xmlChar*)"textLength", (xmlChar *) d_buf); |
446 | 485 | } |
447 | 486 | |
487 | +/*! | |
488 | + * \brief multi-line text creation | |
489 | + * | |
490 | + * The most high-level member function for text support. Still the | |
491 | + * others have to be implemented because some _DiaObject dimplementations | |
492 | + * use the more low-level variants. | |
493 | + * | |
494 | + * \memberof SvgRenderer | |
495 | + */ | |
448 | 496 | static void |
449 | 497 | draw_text (DiaRenderer *self, Text *text) |
450 | 498 | { |
@@ -477,6 +525,10 @@ draw_text (DiaRenderer *self, Text *text) | ||
477 | 525 | } |
478 | 526 | } |
479 | 527 | |
528 | +/*! | |
529 | + * \brief Callback function registered for export | |
530 | + * \ingroup ExportFilters | |
531 | + */ | |
480 | 532 | static gboolean |
481 | 533 | export_svg(DiagramData *data, DiaContext *ctx, |
482 | 534 | const gchar *filename, const gchar *diafilename, |