← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tsort.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tsort.py
1
 
# (C) 2005, 2006 Canonical Limited.
 
1
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
18
"""Topological sorting routines."""
19
19
 
20
20
 
21
 
import bzrlib.errors as errors
 
21
from bzrlib import (
 
22
    errors,
 
23
    graph as _mod_graph,
 
24
    revision as _mod_revision,
 
25
    )
22
26
 
23
27
 
24
28
__all__ = ["topo_sort", "TopoSorter", "merge_sort", "MergeSorter"]
29
33
 
30
34
    graph -- sequence of pairs of node->parents_list.
31
35
 
32
 
    The result is a list of node names, such that all parents come before
33
 
    their children.
 
36
    The result is a list of node names, such that all parents come before their
 
37
    children.
34
38
 
35
39
    node identifiers can be any hashable object, and are typically strings.
 
40
 
 
41
    This function has the same purpose as the TopoSorter class, but uses a
 
42
    different algorithm to sort the graph. That means that while both return a
 
43
    list with parents before their child nodes, the exact ordering can be
 
44
    different.
 
45
 
 
46
    topo_sort is faster when the whole list is needed, while when iterating
 
47
    over a part of the list, TopoSorter.iter_topo_order should be used.
36
48
    """
37
 
    return TopoSorter(graph).sorted()
 
49
    kg = _mod_graph.KnownGraph(dict(graph))
 
50
    return kg.topo_sort()
38
51
 
39
52
 
40
53
class TopoSorter(object):
41
54
 
42
55
    def __init__(self, graph):
43
56
        """Topological sorting of a graph.
44
 
    
 
57
 
45
58
        :param graph: sequence of pairs of node_name->parent_names_list.
46
59
                      i.e. [('C', ['B']), ('B', ['A']), ('A', [])]
47
60
                      For this input the output from the sort or
48
61
                      iter_topo_order routines will be:
49
62
                      'A', 'B', 'C'
50
 
        
 
63
 
51
64
        node identifiers can be any hashable object, and are typically strings.
52
65
 
53
66
        If you have a graph like [('a', ['b']), ('a', ['c'])] this will only use
56
69
        The graph is sorted lazily: until you iterate or sort the input is
57
70
        not processed other than to create an internal representation.
58
71
 
59
 
        iteration or sorting may raise GraphCycleError if a cycle is present 
 
72
        iteration or sorting may raise GraphCycleError if a cycle is present
60
73
        in the graph.
61
74
        """
62
 
        # a dict of the graph.
 
75
        # store a dict of the graph.
63
76
        self._graph = dict(graph)
64
 
        ### if debugging:
65
 
        # self._original_graph = dict(graph)
66
 
        
67
 
        # this is a stack storing the depth first search into the graph.
68
 
        self._node_name_stack = []
69
 
        # at each level of 'recursion' we have to check each parent. This
70
 
        # stack stores the parents we have not yet checked for the node at the 
71
 
        # matching depth in _node_name_stack
72
 
        self._pending_parents_stack = []
73
 
        # this is a set of the completed nodes for fast checking whether a
74
 
        # parent in a node we are processing on the stack has already been
75
 
        # emitted and thus can be skipped.
76
 
        self._completed_node_names = set()
77
77
 
78
78
    def sorted(self):
79
79
        """Sort the graph and return as a list.
80
 
        
 
80
 
81
81
        After calling this the sorter is empty and you must create a new one.
82
82
        """
83
83
        return list(self.iter_topo_order())
94
94
 
95
95
    def iter_topo_order(self):
96
96
        """Yield the nodes of the graph in a topological order.
97
 
        
 
97
 
98
98
        After finishing iteration the sorter is empty and you cannot continue
99
99
        iteration.
100
100
        """
101
 
        while self._graph:
 
101
        graph = self._graph
 
102
        visitable = set(graph)
 
103
 
 
104
        # this is a stack storing the depth first search into the graph.
 
105
        pending_node_stack = []
 
106
        # at each level of 'recursion' we have to check each parent. This
 
107
        # stack stores the parents we have not yet checked for the node at the
 
108
        # matching depth in pending_node_stack
 
109
        pending_parents_stack = []
 
110
 
 
111
        # this is a set of the completed nodes for fast checking whether a
 
112
        # parent in a node we are processing on the stack has already been
 
113
        # emitted and thus can be skipped.
 
114
        completed_node_names = set()
 
115
 
 
116
        while graph:
102
117
            # now pick a random node in the source graph, and transfer it to the
103
 
            # top of the depth first search stack.
104
 
            node_name, parents = self._graph.popitem()
105
 
            self._push_node(node_name, parents)
106
 
            while self._node_name_stack:
107
 
                # loop until this call completes.
108
 
                parents_to_visit = self._pending_parents_stack[-1]
109
 
                # if all parents are done, the revision is done
 
118
            # top of the depth first search stack of pending nodes.
 
119
            node_name, parents = graph.popitem()
 
120
            pending_node_stack.append(node_name)
 
121
            pending_parents_stack.append(list(parents))
 
122
 
 
123
            # loop until pending_node_stack is empty
 
124
            while pending_node_stack:
 
125
                parents_to_visit = pending_parents_stack[-1]
 
126
                # if there are no parents left, the revision is done
110
127
                if not parents_to_visit:
111
128
                    # append the revision to the topo sorted list
112
 
                    # all the nodes parents have been added to the output, now
113
 
                    # we can add it to the output.
114
 
                    yield self._pop_node()
 
129
                    # all the nodes parents have been added to the output,
 
130
                    # now we can add it to the output.
 
131
                    popped_node = pending_node_stack.pop()
 
132
                    pending_parents_stack.pop()
 
133
                    completed_node_names.add(popped_node)
 
134
                    yield popped_node
115
135
                else:
116
 
                    while self._pending_parents_stack[-1]:
117
 
                        # recurse depth first into a single parent 
118
 
                        next_node_name = self._pending_parents_stack[-1].pop()
119
 
                        if next_node_name in self._completed_node_names:
120
 
                            # this parent was completed by a child on the
121
 
                            # call stack. skip it.
122
 
                            continue
123
 
                        # otherwise transfer it from the source graph into the
124
 
                        # top of the current depth first search stack.
125
 
                        try:
126
 
                            parents = self._graph.pop(next_node_name)
127
 
                        except KeyError:
128
 
                            # if the next node is not in the source graph it has
129
 
                            # already been popped from it and placed into the
130
 
                            # current search stack (but not completed or we would
131
 
                            # have hit the continue 4 lines up.
132
 
                            # this indicates a cycle.
133
 
                            raise errors.GraphCycleError(self._node_name_stack)
134
 
                        self._push_node(next_node_name, parents)
135
 
                        # and do not continue processing parents until this 'call' 
136
 
                        # has recursed.
137
 
                        break
138
 
 
139
 
    def _push_node(self, node_name, parents):
140
 
        """Add node_name to the pending node stack.
141
 
        
142
 
        Names in this stack will get emitted into the output as they are popped
143
 
        off the stack.
144
 
        """
145
 
        self._node_name_stack.append(node_name)
146
 
        self._pending_parents_stack.append(list(parents))
147
 
 
148
 
    def _pop_node(self):
149
 
        """Pop the top node off the stack 
150
 
 
151
 
        The node is appended to the sorted output.
152
 
        """
153
 
        # we are returning from the flattened call frame:
154
 
        # pop off the local variables
155
 
        node_name = self._node_name_stack.pop()
156
 
        self._pending_parents_stack.pop()
157
 
 
158
 
        self._completed_node_names.add(node_name)
159
 
        return node_name
160
 
 
161
 
 
162
 
def merge_sort(graph, branch_tip, mainline_revisions=None):
 
136
                    # recurse depth first into a single parent
 
137
                    next_node_name = parents_to_visit.pop()
 
138
 
 
139
                    if next_node_name in completed_node_names:
 
140
                        # parent was already completed by a child, skip it.
 
141
                        continue
 
142
                    if next_node_name not in visitable:
 
143
                        # parent is not a node in the original graph, skip it.
 
144
                        continue
 
145
 
 
146
                    # transfer it along with its parents from the source graph
 
147
                    # into the top of the current depth first search stack.
 
148
                    try:
 
149
                        parents = graph.pop(next_node_name)
 
150
                    except KeyError:
 
151
                        # if the next node is not in the source graph it has
 
152
                        # already been popped from it and placed into the
 
153
                        # current search stack (but not completed or we would
 
154
                        # have hit the continue 6 lines up).  this indicates a
 
155
                        # cycle.
 
156
                        raise errors.GraphCycleError(pending_node_stack)
 
157
                    pending_node_stack.append(next_node_name)
 
158
                    pending_parents_stack.append(list(parents))
 
159
 
 
160
 
 
161
def merge_sort(graph, branch_tip, mainline_revisions=None, generate_revno=False):
163
162
    """Topological sort a graph which groups merges.
164
163
 
165
164
    :param graph: sequence of pairs of node->parents_list.
166
 
    :param branch_tip: the tip of the branch to graph. Revisions not 
 
165
    :param branch_tip: the tip of the branch to graph. Revisions not
167
166
                       reachable from branch_tip are not included in the
168
167
                       output.
169
168
    :param mainline_revisions: If not None this forces a mainline to be
174
173
                               old revision listed in the mainline revisions
175
174
                               list.
176
175
                               The order for this parameter is oldest-first.
177
 
 
178
 
    The result is a list of node names, such that all parents come before
179
 
    their children.
180
 
 
181
 
    node identifiers can be any hashable object, and are typically strings.
 
176
    :param generate_revno: Optional parameter controlling the generation of
 
177
        revision number sequences in the output. See the output description of
 
178
        the MergeSorter docstring for details.
 
179
    :result: See the MergeSorter docstring for details.
 
180
 
 
181
    Node identifiers can be any hashable object, and are typically strings.
182
182
    """
183
 
    return MergeSorter(graph, branch_tip, mainline_revisions).sorted()
 
183
    return MergeSorter(graph, branch_tip, mainline_revisions,
 
184
        generate_revno).sorted()
184
185
 
185
186
 
186
187
class MergeSorter(object):
187
188
 
188
 
    def __init__(self, graph, branch_tip, mainline_revisions=None):
 
189
    __slots__ = ['_node_name_stack',
 
190
                 '_node_merge_depth_stack',
 
191
                 '_pending_parents_stack',
 
192
                 '_first_child_stack',
 
193
                 '_left_subtree_pushed_stack',
 
194
                 '_generate_revno',
 
195
                 '_graph',
 
196
                 '_mainline_revisions',
 
197
                 '_stop_revision',
 
198
                 '_original_graph',
 
199
                 '_revnos',
 
200
                 '_revno_to_branch_count',
 
201
                 '_completed_node_names',
 
202
                 '_scheduled_nodes',
 
203
                ]
 
204
 
 
205
    def __init__(self, graph, branch_tip, mainline_revisions=None,
 
206
        generate_revno=False):
189
207
        """Merge-aware topological sorting of a graph.
190
 
    
 
208
 
191
209
        :param graph: sequence of pairs of node_name->parent_names_list.
192
210
                      i.e. [('C', ['B']), ('B', ['A']), ('A', [])]
193
211
                      For this input the output from the sort or
194
212
                      iter_topo_order routines will be:
195
213
                      'A', 'B', 'C'
196
 
        :param branch_tip: the tip of the branch to graph. Revisions not 
 
214
        :param branch_tip: the tip of the branch to graph. Revisions not
197
215
                       reachable from branch_tip are not included in the
198
216
                       output.
199
217
        :param mainline_revisions: If not None this forces a mainline to be
204
222
                               old revision listed in the mainline revisions
205
223
                               list.
206
224
                               The order for this parameter is oldest-first.
207
 
 
208
 
        
 
225
        :param generate_revno: Optional parameter controlling the generation of
 
226
            revision number sequences in the output. See the output description
 
227
            for more details.
 
228
 
 
229
        The result is a list sorted so that all parents come before
 
230
        their children. Each element of the list is a tuple containing:
 
231
        (sequence_number, node_name, merge_depth, end_of_merge)
 
232
         * sequence_number: The sequence of this row in the output. Useful for
 
233
           GUIs.
 
234
         * node_name: The node name: opaque text to the merge routine.
 
235
         * merge_depth: How many levels of merging deep this node has been
 
236
           found.
 
237
         * revno_sequence: When requested this field provides a sequence of
 
238
             revision numbers for all revisions. The format is:
 
239
             (REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
 
240
             branch that the revno is on. From left to right the REVNO numbers
 
241
             are the sequence numbers within that branch of the revision.
 
242
             For instance, the graph {A:[], B:['A'], C:['A', 'B']} will get
 
243
             the following revno_sequences assigned: A:(1,), B:(1,1,1), C:(2,).
 
244
             This should be read as 'A is the first commit in the trunk',
 
245
             'B is the first commit on the first branch made from A', 'C is the
 
246
             second commit in the trunk'.
 
247
         * end_of_merge: When True the next node is part of a different merge.
 
248
 
 
249
 
209
250
        node identifiers can be any hashable object, and are typically strings.
210
251
 
211
252
        If you have a graph like [('a', ['b']), ('a', ['c'])] this will only use
214
255
        The graph is sorted lazily: until you iterate or sort the input is
215
256
        not processed other than to create an internal representation.
216
257
 
217
 
        iteration or sorting may raise GraphCycleError if a cycle is present 
 
258
        iteration or sorting may raise GraphCycleError if a cycle is present
218
259
        in the graph.
219
260
 
220
261
        Background information on the design:
239
280
              E  1   [F]
240
281
              F 0
241
282
              C is the end of a cluster due to rule 1.
242
 
              D is not the end of a cluster from rule 1, but is from rule 2: E 
 
283
              D is not the end of a cluster from rule 1, but is from rule 2: E
243
284
                is not its left most ancestor
244
285
              E is the end of a cluster due to rule 1
245
286
              F might be but we need more data.
246
 
              
 
287
 
247
288
        we show connecting lines to a parent when:
248
289
         - The parent is the start of a merge within this cluster.
249
 
           That is, the merge was not done to the mainline before this cluster 
 
290
           That is, the merge was not done to the mainline before this cluster
250
291
           was merged to the mainline.
251
292
           This can be detected thus:
252
 
            * The parent has a higher merge depth and is the next revision in 
 
293
            * The parent has a higher merge depth and is the next revision in
253
294
              the list.
254
 
          
 
295
 
255
296
          The next revision in the list constraint is needed for this case:
256
 
          A 0   [D, B]   
257
 
          B  1  [C, F]   # we do not want to show a line to F which is depth 2 
 
297
          A 0   [D, B]
 
298
          B  1  [C, F]   # we do not want to show a line to F which is depth 2
258
299
                           but not a merge
259
 
          C  1  [H]      # note that this is a long line to show back to the 
 
300
          C  1  [H]      # note that this is a long line to show back to the
260
301
                           ancestor - see the end of merge rules.
261
302
          D 0   [G, E]
262
303
          E  1  [G, F]
285
326
             XXXX revisit when awake. ddaa asks about the relevance of each one
286
327
             - maybe more than one parent is relevant
287
328
        """
 
329
        self._generate_revno = generate_revno
288
330
        # a dict of the graph.
289
331
        self._graph = dict(graph)
290
332
        # if there is an explicit mainline, alter the graph to match. This is
296
338
        else:
297
339
            self._mainline_revisions = list(mainline_revisions)
298
340
            self._stop_revision = self._mainline_revisions[0]
299
 
        # skip the first revision, its what we reach and its parents are 
 
341
        # skip the first revision, its what we reach and its parents are
300
342
        # therefore irrelevant
301
343
        for index, revision in enumerate(self._mainline_revisions[1:]):
302
344
            # NB: index 0 means self._mainline_revisions[1]
305
347
            if parent is None:
306
348
                # end of mainline_revisions history
307
349
                continue
308
 
            if self._graph[revision][0] == parent:
 
350
            graph_parent_ids = self._graph[revision]
 
351
            if not graph_parent_ids:
 
352
                # We ran into a ghost, skip over it, this is a workaround for
 
353
                # bug #243536, the _graph has had ghosts stripped, but the
 
354
                # mainline_revisions have not
 
355
                continue
 
356
            if graph_parent_ids[0] == parent:
309
357
                continue
310
358
            # remove it from its prior spot
311
359
            self._graph[revision].remove(parent)
315
363
        # which requires the parents to be accessible: its easier for now
316
364
        # to just keep the original graph around.
317
365
        self._original_graph = dict(self._graph.items())
318
 
        
 
366
        # we need to know the revision numbers of revisions to determine
 
367
        # the revision numbers of their descendants
 
368
        # this is a graph from node to [revno_tuple, first_child]
 
369
        # where first_child is True if no other children have seen this node
 
370
        # and revno_tuple is the tuple that was assigned to the node.
 
371
        # we dont know revnos to start with, so we start it seeded with
 
372
        # [None, True]
 
373
        self._revnos = dict((revision, [None, True])
 
374
                            for revision in self._graph)
 
375
        # Each mainline revision counts how many child branches have spawned from it.
 
376
        self._revno_to_branch_count = {}
 
377
 
319
378
        # this is a stack storing the depth first search into the graph.
320
379
        self._node_name_stack = []
321
380
        # at each level of recursion we need the merge depth this node is at:
322
381
        self._node_merge_depth_stack = []
323
382
        # at each level of 'recursion' we have to check each parent. This
324
 
        # stack stores the parents we have not yet checked for the node at the 
 
383
        # stack stores the parents we have not yet checked for the node at the
325
384
        # matching depth in _node_name_stack
326
385
        self._pending_parents_stack = []
 
386
        # When we first look at a node we assign it a seqence number from its
 
387
        # leftmost parent.
 
388
        self._first_child_stack = []
327
389
        # this is a set of the nodes who have been completely analysed for fast
328
390
        # membership checking
329
391
        self._completed_node_names = set()
336
398
        # D 0  [F, E]
337
399
        # E  1 [F]
338
400
        # F 0
339
 
        # the scheduling order is: F, E, D, C, B, A 
 
401
        # the scheduling order is: F, E, D, C, B, A
340
402
        # that is - 'left subtree, right subtree, node'
341
403
        # which would mean that when we schedule A we can emit the entire tree.
342
404
        self._scheduled_nodes = []
343
 
        # This records for each node when we have processed its left most 
 
405
        # This records for each node when we have processed its left most
344
406
        # unmerged subtree. After this subtree is scheduled, all other subtrees
345
407
        # have their merge depth increased by one from this nodes merge depth.
346
 
        self._left_subtree_done_stack = []
 
408
        # it contains tuples - name, merge_depth
 
409
        self._left_subtree_pushed_stack = []
347
410
 
348
411
        # seed the search with the tip of the branch
349
 
        if branch_tip is not None:
 
412
        if (branch_tip is not None and
 
413
            branch_tip != _mod_revision.NULL_REVISION and
 
414
            branch_tip != (_mod_revision.NULL_REVISION,)):
350
415
            parents = self._graph.pop(branch_tip)
351
416
            self._push_node(branch_tip, 0, parents)
352
417
 
353
418
    def sorted(self):
354
419
        """Sort the graph and return as a list.
355
 
        
 
420
 
356
421
        After calling this the sorter is empty and you must create a new one.
357
422
        """
358
423
        return list(self.iter_topo_order())
359
424
 
360
425
    def iter_topo_order(self):
361
426
        """Yield the nodes of the graph in a topological order.
362
 
        
 
427
 
363
428
        After finishing iteration the sorter is empty and you cannot continue
364
429
        iteration.
365
430
        """
366
 
        while self._node_name_stack:
 
431
        # These are safe to offload to local variables, because they are used
 
432
        # as a stack and modified in place, never assigned to.
 
433
        node_name_stack = self._node_name_stack
 
434
        node_merge_depth_stack = self._node_merge_depth_stack
 
435
        pending_parents_stack = self._pending_parents_stack
 
436
        left_subtree_pushed_stack = self._left_subtree_pushed_stack
 
437
        completed_node_names = self._completed_node_names
 
438
        scheduled_nodes = self._scheduled_nodes
 
439
 
 
440
        graph_pop = self._graph.pop
 
441
 
 
442
        def push_node(node_name, merge_depth, parents,
 
443
                      node_name_stack_append=node_name_stack.append,
 
444
                      node_merge_depth_stack_append=node_merge_depth_stack.append,
 
445
                      left_subtree_pushed_stack_append=left_subtree_pushed_stack.append,
 
446
                      pending_parents_stack_append=pending_parents_stack.append,
 
447
                      first_child_stack_append=self._first_child_stack.append,
 
448
                      revnos=self._revnos,
 
449
                      ):
 
450
            """Add node_name to the pending node stack.
 
451
 
 
452
            Names in this stack will get emitted into the output as they are popped
 
453
            off the stack.
 
454
 
 
455
            This inlines a lot of self._variable.append functions as local
 
456
            variables.
 
457
            """
 
458
            node_name_stack_append(node_name)
 
459
            node_merge_depth_stack_append(merge_depth)
 
460
            left_subtree_pushed_stack_append(False)
 
461
            pending_parents_stack_append(list(parents))
 
462
            # as we push it, check if it is the first child
 
463
            parent_info = None
 
464
            if parents:
 
465
                # node has parents, assign from the left most parent.
 
466
                try:
 
467
                    parent_info = revnos[parents[0]]
 
468
                except KeyError:
 
469
                    # Left-hand parent is a ghost, consider it not to exist
 
470
                    pass
 
471
            if parent_info is not None:
 
472
                first_child = parent_info[1]
 
473
                parent_info[1] = False
 
474
            else:
 
475
                # We don't use the same algorithm here, but we need to keep the
 
476
                # stack in line
 
477
                first_child = None
 
478
            first_child_stack_append(first_child)
 
479
 
 
480
        def pop_node(node_name_stack_pop=node_name_stack.pop,
 
481
                     node_merge_depth_stack_pop=node_merge_depth_stack.pop,
 
482
                     first_child_stack_pop=self._first_child_stack.pop,
 
483
                     left_subtree_pushed_stack_pop=left_subtree_pushed_stack.pop,
 
484
                     pending_parents_stack_pop=pending_parents_stack.pop,
 
485
                     original_graph=self._original_graph,
 
486
                     revnos=self._revnos,
 
487
                     completed_node_names_add=self._completed_node_names.add,
 
488
                     scheduled_nodes_append=scheduled_nodes.append,
 
489
                     revno_to_branch_count=self._revno_to_branch_count,
 
490
                    ):
 
491
            """Pop the top node off the stack
 
492
 
 
493
            The node is appended to the sorted output.
 
494
            """
 
495
            # we are returning from the flattened call frame:
 
496
            # pop off the local variables
 
497
            node_name = node_name_stack_pop()
 
498
            merge_depth = node_merge_depth_stack_pop()
 
499
            first_child = first_child_stack_pop()
 
500
            # remove this node from the pending lists:
 
501
            left_subtree_pushed_stack_pop()
 
502
            pending_parents_stack_pop()
 
503
 
 
504
            parents = original_graph[node_name]
 
505
            parent_revno = None
 
506
            if parents:
 
507
                # node has parents, assign from the left most parent.
 
508
                try:
 
509
                    parent_revno = revnos[parents[0]][0]
 
510
                except KeyError:
 
511
                    # left-hand parent is a ghost, treat it as not existing
 
512
                    pass
 
513
            if parent_revno is not None:
 
514
                if not first_child:
 
515
                    # not the first child, make a new branch
 
516
                    base_revno = parent_revno[0]
 
517
                    branch_count = revno_to_branch_count.get(base_revno, 0)
 
518
                    branch_count += 1
 
519
                    revno_to_branch_count[base_revno] = branch_count
 
520
                    revno = (parent_revno[0], branch_count, 1)
 
521
                    # revno = (parent_revno[0], branch_count, parent_revno[-1]+1)
 
522
                else:
 
523
                    # as the first child, we just increase the final revision
 
524
                    # number
 
525
                    revno = parent_revno[:-1] + (parent_revno[-1] + 1,)
 
526
            else:
 
527
                # no parents, use the root sequence
 
528
                root_count = revno_to_branch_count.get(0, -1)
 
529
                root_count += 1
 
530
                if root_count:
 
531
                    revno = (0, root_count, 1)
 
532
                else:
 
533
                    revno = (1,)
 
534
                revno_to_branch_count[0] = root_count
 
535
 
 
536
            # store the revno for this node for future reference
 
537
            revnos[node_name][0] = revno
 
538
            completed_node_names_add(node_name)
 
539
            scheduled_nodes_append((node_name, merge_depth, revno))
 
540
            return node_name
 
541
 
 
542
 
 
543
        while node_name_stack:
367
544
            # loop until this call completes.
368
 
            parents_to_visit = self._pending_parents_stack[-1]
 
545
            parents_to_visit = pending_parents_stack[-1]
369
546
            # if all parents are done, the revision is done
370
547
            if not parents_to_visit:
371
548
                # append the revision to the topo sorted scheduled list:
372
549
                # all the nodes parents have been scheduled added, now
373
550
                # we can add it to the output.
374
 
                self._pop_node()
 
551
                pop_node()
375
552
            else:
376
 
                while self._pending_parents_stack[-1]:
377
 
                    if not self._left_subtree_done_stack[-1]:
 
553
                while pending_parents_stack[-1]:
 
554
                    if not left_subtree_pushed_stack[-1]:
378
555
                        # recurse depth first into the primary parent
379
 
                        next_node_name = self._pending_parents_stack[-1].pop(0)
 
556
                        next_node_name = pending_parents_stack[-1].pop(0)
 
557
                        is_left_subtree = True
 
558
                        left_subtree_pushed_stack[-1] = True
380
559
                    else:
381
560
                        # place any merges in right-to-left order for scheduling
382
561
                        # which gives us left-to-right order after we reverse
383
 
                        # the scheduled queue. XXX: This has the effect of 
 
562
                        # the scheduled queue. XXX: This has the effect of
384
563
                        # allocating common-new revisions to the right-most
385
 
                        # subtree rather than the left most, which will 
 
564
                        # subtree rather than the left most, which will
386
565
                        # display nicely (you get smaller trees at the top
387
566
                        # of the combined merge).
388
 
                        next_node_name = self._pending_parents_stack[-1].pop()
389
 
                    if next_node_name in self._completed_node_names:
 
567
                        next_node_name = pending_parents_stack[-1].pop()
 
568
                        is_left_subtree = False
 
569
                    if next_node_name in completed_node_names:
390
570
                        # this parent was completed by a child on the
391
571
                        # call stack. skip it.
392
572
                        continue
393
573
                    # otherwise transfer it from the source graph into the
394
574
                    # top of the current depth first search stack.
395
575
                    try:
396
 
                        parents = self._graph.pop(next_node_name)
 
576
                        parents = graph_pop(next_node_name)
397
577
                    except KeyError:
398
578
                        # if the next node is not in the source graph it has
399
579
                        # already been popped from it and placed into the
400
580
                        # current search stack (but not completed or we would
401
581
                        # have hit the continue 4 lines up.
402
582
                        # this indicates a cycle.
403
 
                        raise errors.GraphCycleError(self._node_name_stack)
 
583
                        if next_node_name in self._original_graph:
 
584
                            raise errors.GraphCycleError(node_name_stack)
 
585
                        else:
 
586
                            # This is just a ghost parent, ignore it
 
587
                            continue
404
588
                    next_merge_depth = 0
405
 
                    if self._left_subtree_done_stack[-1]:
 
589
                    if is_left_subtree:
 
590
                        # a new child branch from name_stack[-1]
 
591
                        next_merge_depth = 0
 
592
                    else:
406
593
                        next_merge_depth = 1
407
 
                    else:
408
 
                        next_merge_depth = 0
409
 
                        self._left_subtree_done_stack[-1] = True
410
594
                    next_merge_depth = (
411
 
                        self._node_merge_depth_stack[-1] + next_merge_depth)
412
 
                    self._push_node(
 
595
                        node_merge_depth_stack[-1] + next_merge_depth)
 
596
                    push_node(
413
597
                        next_node_name,
414
598
                        next_merge_depth,
415
599
                        parents)
416
 
                    # and do not continue processing parents until this 'call' 
 
600
                    # and do not continue processing parents until this 'call'
417
601
                    # has recursed.
418
602
                    break
 
603
 
419
604
        # We have scheduled the graph. Now deliver the ordered output:
420
605
        sequence_number = 0
421
 
        while self._scheduled_nodes:
422
 
            node_name, merge_depth = self._scheduled_nodes.pop()
423
 
            if node_name == self._stop_revision:
 
606
        stop_revision = self._stop_revision
 
607
        generate_revno = self._generate_revno
 
608
        original_graph = self._original_graph
 
609
 
 
610
        while scheduled_nodes:
 
611
            node_name, merge_depth, revno = scheduled_nodes.pop()
 
612
            if node_name == stop_revision:
424
613
                return
425
 
            if not len(self._scheduled_nodes):
 
614
            if not len(scheduled_nodes):
 
615
                # last revision is the end of a merge
426
616
                end_of_merge = True
427
 
            elif self._scheduled_nodes[-1][1] < merge_depth:
 
617
            elif scheduled_nodes[-1][1] < merge_depth:
428
618
                # the next node is to our left
429
619
                end_of_merge = True
430
 
            elif (self._scheduled_nodes[-1][1] == merge_depth and
431
 
                  (self._scheduled_nodes[-1][0] not in
432
 
                   self._original_graph[node_name])):
 
620
            elif (scheduled_nodes[-1][1] == merge_depth and
 
621
                  (scheduled_nodes[-1][0] not in
 
622
                   original_graph[node_name])):
433
623
                # the next node was part of a multiple-merge.
434
624
                end_of_merge = True
435
625
            else:
436
626
                end_of_merge = False
437
 
            yield (sequence_number, node_name, merge_depth, end_of_merge)
 
627
            if generate_revno:
 
628
                yield (sequence_number, node_name, merge_depth, revno, end_of_merge)
 
629
            else:
 
630
                yield (sequence_number, node_name, merge_depth, end_of_merge)
438
631
            sequence_number += 1
439
632
 
440
633
    def _push_node(self, node_name, merge_depth, parents):
441
634
        """Add node_name to the pending node stack.
442
 
        
 
635
 
443
636
        Names in this stack will get emitted into the output as they are popped
444
637
        off the stack.
445
638
        """
446
639
        self._node_name_stack.append(node_name)
447
640
        self._node_merge_depth_stack.append(merge_depth)
448
 
        self._left_subtree_done_stack.append(False)
 
641
        self._left_subtree_pushed_stack.append(False)
449
642
        self._pending_parents_stack.append(list(parents))
 
643
        # as we push it, figure out if this is the first child
 
644
        parent_info = None
 
645
        if parents:
 
646
            # node has parents, assign from the left most parent.
 
647
            try:
 
648
                parent_info = self._revnos[parents[0]]
 
649
            except KeyError:
 
650
                # Left-hand parent is a ghost, consider it not to exist
 
651
                pass
 
652
        if parent_info is not None:
 
653
            first_child = parent_info[1]
 
654
            parent_info[1] = False
 
655
        else:
 
656
            # We don't use the same algorithm here, but we need to keep the
 
657
            # stack in line
 
658
            first_child = None
 
659
        self._first_child_stack.append(first_child)
450
660
 
451
661
    def _pop_node(self):
452
 
        """Pop the top node off the stack 
 
662
        """Pop the top node off the stack
453
663
 
454
664
        The node is appended to the sorted output.
455
665
        """
457
667
        # pop off the local variables
458
668
        node_name = self._node_name_stack.pop()
459
669
        merge_depth = self._node_merge_depth_stack.pop()
460
 
        self._left_subtree_done_stack.pop()
 
670
        first_child = self._first_child_stack.pop()
 
671
        # remove this node from the pending lists:
 
672
        self._left_subtree_pushed_stack.pop()
461
673
        self._pending_parents_stack.pop()
462
674
 
 
675
        parents = self._original_graph[node_name]
 
676
        parent_revno = None
 
677
        if parents:
 
678
            # node has parents, assign from the left most parent.
 
679
            try:
 
680
                parent_revno = self._revnos[parents[0]][0]
 
681
            except KeyError:
 
682
                # left-hand parent is a ghost, treat it as not existing
 
683
                pass
 
684
        if parent_revno is not None:
 
685
            if not first_child:
 
686
                # not the first child, make a new branch
 
687
                base_revno = parent_revno[0]
 
688
                branch_count = self._revno_to_branch_count.get(base_revno, 0)
 
689
                branch_count += 1
 
690
                self._revno_to_branch_count[base_revno] = branch_count
 
691
                revno = (parent_revno[0], branch_count, 1)
 
692
                # revno = (parent_revno[0], branch_count, parent_revno[-1]+1)
 
693
            else:
 
694
                # as the first child, we just increase the final revision
 
695
                # number
 
696
                revno = parent_revno[:-1] + (parent_revno[-1] + 1,)
 
697
        else:
 
698
            # no parents, use the root sequence
 
699
            root_count = self._revno_to_branch_count.get(0, 0)
 
700
            root_count = self._revno_to_branch_count.get(0, -1)
 
701
            root_count += 1
 
702
            if root_count:
 
703
                revno = (0, root_count, 1)
 
704
            else:
 
705
                revno = (1,)
 
706
            self._revno_to_branch_count[0] = root_count
 
707
 
 
708
        # store the revno for this node for future reference
 
709
        self._revnos[node_name][0] = revno
463
710
        self._completed_node_names.add(node_name)
464
 
        self._scheduled_nodes.append((node_name, merge_depth))
 
711
        self._scheduled_nodes.append((node_name, merge_depth, self._revnos[node_name][0]))
465
712
        return node_name