← Back to branch summary

~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to dotgraph.py

  • Committer: Aaron Bentley
  • Date: 2008-02-20 14:28:36 UTC
  • Revision ID: aaron@aaronbentley.com-20080220142836-jqsca0avvl2p3bar
Remove ImportReplacer hack

Show diffs side-by-side

added added

removed removed

Lines of Context:
dotgraph.py
 
1
# Copyright (C) 2004, 2005 Aaron Bentley
 
2
# <aaron@aaronbentley.com>
 
3
#
 
4
#    This program is free software; you can redistribute it and/or modify
 
5
#    it under the terms of the GNU General Public License as published by
 
6
#    the Free Software Foundation; either version 2 of the License, or
 
7
#    (at your option) any later version.
 
8
#
 
9
#    This program is distributed in the hope that it will be useful,
 
10
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
#    GNU General Public License for more details.
 
13
#
 
14
#    You should have received a copy of the GNU General Public License
 
15
#    along with this program; if not, write to the Free Software
 
16
#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
17
 
 
18
from subprocess import Popen, PIPE
 
19
import os.path
 
20
import errno
 
21
import tempfile
 
22
import shutil
 
23
 
 
24
RSVG_OUTPUT_TYPES = ('png', 'jpg')
 
25
DOT_OUTPUT_TYPES = ('svg', 'svgz', 'gif', 'jpg', 'ps', 'fig', 'mif', 'png',
 
26
                    'cmapx')
 
27
 
 
28
class NoDot(Exception):
 
29
    def __init__(self):
 
30
        Exception.__init__(self, "Can't find dot!")
 
31
 
 
32
class NoRsvg(Exception):
 
33
    def __init__(self):
 
34
        Exception.__init__(self, "Can't find rsvg!")
 
35
 
 
36
class Node(object):
 
37
    def __init__(self, name, color=None, label=None, rev_id=None,
 
38
                 cluster=None, node_style=None, date=None, message=None):
 
39
        self.name = name
 
40
        self.color = color
 
41
        self.label = label
 
42
        self.committer = None
 
43
        self.rev_id = rev_id
 
44
        if node_style is None:
 
45
            self.node_style = []
 
46
        self.cluster = cluster
 
47
        self.rank = None
 
48
        self.date = date
 
49
        self.message = message
 
50
        self.href = None
 
51
 
 
52
    def define(self):
 
53
        attributes = []
 
54
        style = []
 
55
        if self.color is not None:
 
56
            attributes.append('fillcolor="%s"' % self.color)
 
57
            style.append('filled')
 
58
        style.extend(self.node_style)
 
59
        if len(style) > 0:
 
60
            attributes.append('style="%s"' % ",".join(style))
 
61
        label = self.label
 
62
        if label is not None:
 
63
            attributes.append('label="%s"' % label)
 
64
        attributes.append('shape="box"')
 
65
        tooltip = ''
 
66
        if self.message is not None:
 
67
            tooltip += self.message.replace('"', '\\"')
 
68
        if tooltip:
 
69
            attributes.append('tooltip="%s"' % tooltip)
 
70
        if self.href is not None:
 
71
            attributes.append('href="%s"' % self.href)
 
72
        elif tooltip:
 
73
            attributes.append('href="#"')
 
74
        if len(attributes) > 0:
 
75
            return '%s[%s]' % (self.name, " ".join(attributes))
 
76
 
 
77
    def __str__(self):
 
78
        return self.name
 
79
 
 
80
class Edge(object):
 
81
    def __init__(self, start, end, label=None):
 
82
        object.__init__(self)
 
83
        self.start = start
 
84
        self.end = end
 
85
        self.label = label
 
86
 
 
87
    def dot(self, do_weight=False):
 
88
        attributes = []
 
89
        if self.label is not None:
 
90
            attributes.append(('label', self.label))
 
91
        if do_weight:
 
92
            weight = '0'
 
93
            if self.start.cluster == self.end.cluster:
 
94
                weight = '1'
 
95
            elif self.start.rank is None:
 
96
                weight = '1'
 
97
            elif self.end.rank is None:
 
98
                weight = '1'
 
99
            attributes.append(('weight', weight))
 
100
        if len(attributes) > 0:
 
101
            atlist = []
 
102
            for key, value in attributes:
 
103
                atlist.append("%s=\"%s\"" % (key, value))
 
104
            pq = ' '.join(atlist)
 
105
            op = "[%s]" % pq
 
106
        else:
 
107
            op = ""
 
108
        return "%s->%s%s;" % (self.start.name, self.end.name, op)
 
109
 
 
110
def make_edge(relation):
 
111
    if hasattr(relation, 'start') and hasattr(relation, 'end'):
 
112
        return relation
 
113
    return Edge(relation[0], relation[1])
 
114
 
 
115
def dot_output(relations, ranking="forced"):
 
116
    defined = {}
 
117
    yield "digraph G\n"
 
118
    yield "{\n"
 
119
    clusters = set()
 
120
    edges = [make_edge(f) for f in relations]
 
121
    def rel_appropriate(start, end, cluster):
 
122
        if cluster is None:
 
123
            return (start.cluster is None and end.cluster is None) or \
 
124
                start.cluster != end.cluster
 
125
        else:
 
126
            return start.cluster==cluster and end.cluster==cluster
 
127
 
 
128
    for edge in edges:
 
129
        if edge.start.cluster is not None:
 
130
            clusters.add(edge.start.cluster)
 
131
        if edge.end.cluster is not None:
 
132
            clusters.add(edge.end.cluster)
 
133
    clusters = list(clusters)
 
134
    clusters.append(None)
 
135
    for index, cluster in enumerate(clusters):
 
136
        if cluster is not None and ranking == "cluster":
 
137
            yield "subgraph cluster_%s\n" % index
 
138
            yield "{\n"
 
139
            yield '    label="%s"\n' % cluster
 
140
        for edge in edges:
 
141
            if edge.start.name not in defined and edge.start.cluster == cluster:
 
142
                defined[edge.start.name] = edge.start
 
143
                my_def = edge.start.define()
 
144
                if my_def is not None:
 
145
                    yield "    %s\n" % my_def
 
146
            if edge.end.name not in defined and edge.end.cluster == cluster:
 
147
                defined[edge.end.name] = edge.end
 
148
                my_def = edge.end.define()
 
149
                if my_def is not None:
 
150
                    yield "    %s;\n" % my_def
 
151
            if rel_appropriate(edge.start, edge.end, cluster):
 
152
                yield "    %s\n" % edge.dot(do_weight=ranking=="forced")
 
153
        if cluster is not None and ranking == "cluster":
 
154
            yield "}\n"
 
155
 
 
156
    if ranking == "forced":
 
157
        ranks = {}
 
158
        for node in defined.itervalues():
 
159
            if node.rank not in ranks:
 
160
                ranks[node.rank] = set()
 
161
            ranks[node.rank].add(node.name)
 
162
        sorted_ranks = [n for n in ranks.iteritems()]
 
163
        sorted_ranks.sort()
 
164
        last_rank = None
 
165
        for rank, nodes in sorted_ranks:
 
166
            if rank is None:
 
167
                continue
 
168
            yield 'rank%d[style="invis"];\n' % rank
 
169
            if last_rank is not None:
 
170
                yield 'rank%d -> rank%d[style="invis"];\n' % (last_rank, rank)
 
171
            last_rank = rank
 
172
        for rank, nodes in ranks.iteritems():
 
173
            if rank is None:
 
174
                continue
 
175
            node_text = "; ".join('"%s"' % n for n in nodes)
 
176
            yield ' {rank = same; "rank%d"; %s}\n' % (rank, node_text)
 
177
    yield "}\n"
 
178
 
 
179
def invoke_dot_aa(input, out_file, file_type='png'):
 
180
    """\
 
181
    Produce antialiased Dot output, invoking rsvg on an intermediate file.
 
182
    rsvg only supports png, jpeg and .ico files."""
 
183
    tempdir = tempfile.mkdtemp()
 
184
    try:
 
185
        temp_file = os.path.join(tempdir, 'temp.svg')
 
186
        invoke_dot(input, temp_file, 'svg')
 
187
        cmdline = ['rsvg', temp_file, out_file]
 
188
        try:
 
189
            rsvg_proc = Popen(cmdline)
 
190
        except OSError, e:
 
191
            if e.errno == errno.ENOENT:
 
192
                raise NoRsvg()
 
193
        status = rsvg_proc.wait()
 
194
    finally:
 
195
        shutil.rmtree(tempdir)
 
196
    return status
 
197
 
 
198
def invoke_dot(input, out_file=None, file_type='svg', antialias=None,
 
199
               fontname="Helvetica", fontsize=11):
 
200
    cmdline = ['dot', '-T%s' % file_type, '-Nfontname=%s' % fontname,
 
201
               '-Efontname=%s' % fontname, '-Nfontsize=%d' % fontsize,
 
202
               '-Efontsize=%d' % fontsize]
 
203
    if out_file is not None:
 
204
        cmdline.extend(('-o', out_file))
 
205
    try:
 
206
        dot_proc = Popen(cmdline, stdin=PIPE)
 
207
    except OSError, e:
 
208
        if e.errno == errno.ENOENT:
 
209
            raise NoDot()
 
210
        else:
 
211
            raise
 
212
    for line in input:
 
213
        dot_proc.stdin.write(line.encode('utf-8'))
 
214
    dot_proc.stdin.close()
 
215
    return dot_proc.wait()
 
216
 
 
217
def invoke_dot_html(input, out_file):
 
218
    """\
 
219
    Produce an html file, which uses a .png file, and a cmap to provide
 
220
    annotated revisions.
 
221
    """
 
222
    tempdir = tempfile.mkdtemp()
 
223
    try:
 
224
        temp_dot = os.path.join(tempdir, 'temp.dot')
 
225
        status = invoke_dot(input, temp_dot, file_type='dot')
 
226
 
 
227
        dot = open(temp_dot)
 
228
        temp_file = os.path.join(tempdir, 'temp.cmapx')
 
229
        status = invoke_dot(dot, temp_file, 'cmapx')
 
230
 
 
231
        png_file = '.'.join(out_file.split('.')[:-1] + ['png'])
 
232
        dot.seek(0)
 
233
        status = invoke_dot(dot, png_file, 'png')
 
234
 
 
235
        png_relative = png_file.split('/')[-1]
 
236
        html = open(out_file, 'wb')
 
237
        w = html.write
 
238
        w('<html><head><title></title></head>\n')
 
239
        w('<body>\n')
 
240
        w('<img src="%s" usemap="#G" border=0/>' % png_relative)
 
241
        w(open(temp_file).read())
 
242
        w('</body></html>\n')
 
243
    finally:
 
244
        shutil.rmtree(tempdir)
 
245
    return status
 
246