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