← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tsort.py

  • Committer: Jelmer Vernooij
  • Date: 2011-08-19 22:34:02 UTC
  • mto: This revision was merged to the branch mainline in revision 6089.
  • Revision ID: jelmer@samba.org-20110819223402-wjywqb0fa1xxx522
Use get_transport_from_{url,path} in more places.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tsort.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
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
 
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))
160
159
 
161
160
 
162
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
178
177
        revision number sequences in the output. See the output description of
179
178
        the MergeSorter docstring for details.
180
179
    :result: See the MergeSorter docstring for details.
181
 
    node identifiers can be any hashable object, and are typically strings.
 
180
 
 
181
    Node identifiers can be any hashable object, and are typically strings.
182
182
    """
183
183
    return MergeSorter(graph, branch_tip, mainline_revisions,
184
184
        generate_revno).sorted()
186
186
 
187
187
class MergeSorter(object):
188
188
 
 
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
 
189
205
    def __init__(self, graph, branch_tip, mainline_revisions=None,
190
206
        generate_revno=False):
191
207
        """Merge-aware topological sorting of a graph.
192
 
    
 
208
 
193
209
        :param graph: sequence of pairs of node_name->parent_names_list.
194
210
                      i.e. [('C', ['B']), ('B', ['A']), ('A', [])]
195
211
                      For this input the output from the sort or
196
212
                      iter_topo_order routines will be:
197
213
                      'A', 'B', 'C'
198
 
        :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
199
215
                       reachable from branch_tip are not included in the
200
216
                       output.
201
217
        :param mainline_revisions: If not None this forces a mainline to be
213
229
        The result is a list sorted so that all parents come before
214
230
        their children. Each element of the list is a tuple containing:
215
231
        (sequence_number, node_name, merge_depth, end_of_merge)
216
 
         * sequence_number: The sequence of this row in the output. Useful for 
 
232
         * sequence_number: The sequence of this row in the output. Useful for
217
233
           GUIs.
218
234
         * node_name: The node name: opaque text to the merge routine.
219
235
         * merge_depth: How many levels of merging deep this node has been
220
236
           found.
221
237
         * revno_sequence: When requested this field provides a sequence of
222
238
             revision numbers for all revisions. The format is:
223
 
             REVNO[[.BRANCHREVNO.REVNO] ...]. BRANCHREVNO is the number of the
 
239
             (REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
224
240
             branch that the revno is on. From left to right the REVNO numbers
225
241
             are the sequence numbers within that branch of the revision.
226
242
             For instance, the graph {A:[], B:['A'], C:['A', 'B']} will get
230
246
             second commit in the trunk'.
231
247
         * end_of_merge: When True the next node is part of a different merge.
232
248
 
233
 
        
 
249
 
234
250
        node identifiers can be any hashable object, and are typically strings.
235
251
 
236
252
        If you have a graph like [('a', ['b']), ('a', ['c'])] this will only use
239
255
        The graph is sorted lazily: until you iterate or sort the input is
240
256
        not processed other than to create an internal representation.
241
257
 
242
 
        iteration or sorting may raise GraphCycleError if a cycle is present 
 
258
        iteration or sorting may raise GraphCycleError if a cycle is present
243
259
        in the graph.
244
260
 
245
261
        Background information on the design:
264
280
              E  1   [F]
265
281
              F 0
266
282
              C is the end of a cluster due to rule 1.
267
 
              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
268
284
                is not its left most ancestor
269
285
              E is the end of a cluster due to rule 1
270
286
              F might be but we need more data.
271
 
              
 
287
 
272
288
        we show connecting lines to a parent when:
273
289
         - The parent is the start of a merge within this cluster.
274
 
           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
275
291
           was merged to the mainline.
276
292
           This can be detected thus:
277
 
            * 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
278
294
              the list.
279
 
          
 
295
 
280
296
          The next revision in the list constraint is needed for this case:
281
 
          A 0   [D, B]   
282
 
          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
283
299
                           but not a merge
284
 
          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
285
301
                           ancestor - see the end of merge rules.
286
302
          D 0   [G, E]
287
303
          E  1  [G, F]
322
338
        else:
323
339
            self._mainline_revisions = list(mainline_revisions)
324
340
            self._stop_revision = self._mainline_revisions[0]
325
 
        # 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
326
342
        # therefore irrelevant
327
343
        for index, revision in enumerate(self._mainline_revisions[1:]):
328
344
            # NB: index 0 means self._mainline_revisions[1]
331
347
            if parent is None:
332
348
                # end of mainline_revisions history
333
349
                continue
334
 
            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:
335
357
                continue
336
358
            # remove it from its prior spot
337
359
            self._graph[revision].remove(parent)
343
365
        self._original_graph = dict(self._graph.items())
344
366
        # we need to know the revision numbers of revisions to determine
345
367
        # the revision numbers of their descendants
346
 
        # this is a graph from node to [revno_tuple, sequence_number]
347
 
        # where sequence is the number of branches made from the node,
 
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
348
370
        # and revno_tuple is the tuple that was assigned to the node.
349
371
        # we dont know revnos to start with, so we start it seeded with
350
 
        # [None, 0]
351
 
        self._revnos = dict((revision, [None, 0]) for revision in self._graph)
352
 
        # the global implicit root node has revno 0, but we need to know
353
 
        # the sequence number for it too:
354
 
        self._root_sequence = 0
355
 
        
 
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
 
356
378
        # this is a stack storing the depth first search into the graph.
357
379
        self._node_name_stack = []
358
380
        # at each level of recursion we need the merge depth this node is at:
359
381
        self._node_merge_depth_stack = []
360
382
        # at each level of 'recursion' we have to check each parent. This
361
 
        # 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
362
384
        # matching depth in _node_name_stack
363
385
        self._pending_parents_stack = []
364
386
        # When we first look at a node we assign it a seqence number from its
365
387
        # leftmost parent.
366
 
        self._assigned_sequence_stack = []
 
388
        self._first_child_stack = []
367
389
        # this is a set of the nodes who have been completely analysed for fast
368
390
        # membership checking
369
391
        self._completed_node_names = set()
376
398
        # D 0  [F, E]
377
399
        # E  1 [F]
378
400
        # F 0
379
 
        # the scheduling order is: F, E, D, C, B, A 
 
401
        # the scheduling order is: F, E, D, C, B, A
380
402
        # that is - 'left subtree, right subtree, node'
381
403
        # which would mean that when we schedule A we can emit the entire tree.
382
404
        self._scheduled_nodes = []
383
 
        # 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
384
406
        # unmerged subtree. After this subtree is scheduled, all other subtrees
385
407
        # have their merge depth increased by one from this nodes merge depth.
386
408
        # it contains tuples - name, merge_depth
387
409
        self._left_subtree_pushed_stack = []
388
410
 
389
411
        # seed the search with the tip of the branch
390
 
        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,)):
391
415
            parents = self._graph.pop(branch_tip)
392
416
            self._push_node(branch_tip, 0, parents)
393
417
 
394
418
    def sorted(self):
395
419
        """Sort the graph and return as a list.
396
 
        
 
420
 
397
421
        After calling this the sorter is empty and you must create a new one.
398
422
        """
399
423
        return list(self.iter_topo_order())
400
424
 
401
425
    def iter_topo_order(self):
402
426
        """Yield the nodes of the graph in a topological order.
403
 
        
 
427
 
404
428
        After finishing iteration the sorter is empty and you cannot continue
405
429
        iteration.
406
430
        """
407
 
        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:
408
544
            # loop until this call completes.
409
 
            parents_to_visit = self._pending_parents_stack[-1]
 
545
            parents_to_visit = pending_parents_stack[-1]
410
546
            # if all parents are done, the revision is done
411
547
            if not parents_to_visit:
412
548
                # append the revision to the topo sorted scheduled list:
413
549
                # all the nodes parents have been scheduled added, now
414
550
                # we can add it to the output.
415
 
                self._pop_node()
 
551
                pop_node()
416
552
            else:
417
 
                while self._pending_parents_stack[-1]:
418
 
                    if not self._left_subtree_pushed_stack[-1]:
 
553
                while pending_parents_stack[-1]:
 
554
                    if not left_subtree_pushed_stack[-1]:
419
555
                        # recurse depth first into the primary parent
420
 
                        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
421
559
                    else:
422
560
                        # place any merges in right-to-left order for scheduling
423
561
                        # which gives us left-to-right order after we reverse
424
 
                        # the scheduled queue. XXX: This has the effect of 
 
562
                        # the scheduled queue. XXX: This has the effect of
425
563
                        # allocating common-new revisions to the right-most
426
 
                        # subtree rather than the left most, which will 
 
564
                        # subtree rather than the left most, which will
427
565
                        # display nicely (you get smaller trees at the top
428
566
                        # of the combined merge).
429
 
                        next_node_name = self._pending_parents_stack[-1].pop()
430
 
                    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:
431
570
                        # this parent was completed by a child on the
432
571
                        # call stack. skip it.
433
572
                        continue
434
573
                    # otherwise transfer it from the source graph into the
435
574
                    # top of the current depth first search stack.
436
575
                    try:
437
 
                        parents = self._graph.pop(next_node_name)
 
576
                        parents = graph_pop(next_node_name)
438
577
                    except KeyError:
439
578
                        # if the next node is not in the source graph it has
440
579
                        # already been popped from it and placed into the
441
580
                        # current search stack (but not completed or we would
442
581
                        # have hit the continue 4 lines up.
443
582
                        # this indicates a cycle.
444
 
                        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
445
588
                    next_merge_depth = 0
446
 
                    if self._left_subtree_pushed_stack[-1]:
 
589
                    if is_left_subtree:
447
590
                        # a new child branch from name_stack[-1]
 
591
                        next_merge_depth = 0
 
592
                    else:
448
593
                        next_merge_depth = 1
449
 
                    else:
450
 
                        next_merge_depth = 0
451
 
                        self._left_subtree_pushed_stack[-1] = True
452
594
                    next_merge_depth = (
453
 
                        self._node_merge_depth_stack[-1] + next_merge_depth)
454
 
                    self._push_node(
 
595
                        node_merge_depth_stack[-1] + next_merge_depth)
 
596
                    push_node(
455
597
                        next_node_name,
456
598
                        next_merge_depth,
457
599
                        parents)
458
 
                    # and do not continue processing parents until this 'call' 
 
600
                    # and do not continue processing parents until this 'call'
459
601
                    # has recursed.
460
602
                    break
 
603
 
461
604
        # We have scheduled the graph. Now deliver the ordered output:
462
605
        sequence_number = 0
463
 
        while self._scheduled_nodes:
464
 
            node_name, merge_depth, revno = self._scheduled_nodes.pop()
465
 
            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:
466
613
                return
467
 
            if not len(self._scheduled_nodes):
 
614
            if not len(scheduled_nodes):
468
615
                # last revision is the end of a merge
469
616
                end_of_merge = True
470
 
            elif self._scheduled_nodes[-1][1] < merge_depth:
 
617
            elif scheduled_nodes[-1][1] < merge_depth:
471
618
                # the next node is to our left
472
619
                end_of_merge = True
473
 
            elif (self._scheduled_nodes[-1][1] == merge_depth and
474
 
                  (self._scheduled_nodes[-1][0] not in
475
 
                   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])):
476
623
                # the next node was part of a multiple-merge.
477
624
                end_of_merge = True
478
625
            else:
479
626
                end_of_merge = False
480
 
            if self._generate_revno:
 
627
            if generate_revno:
481
628
                yield (sequence_number, node_name, merge_depth, revno, end_of_merge)
482
629
            else:
483
630
                yield (sequence_number, node_name, merge_depth, end_of_merge)
485
632
 
486
633
    def _push_node(self, node_name, merge_depth, parents):
487
634
        """Add node_name to the pending node stack.
488
 
        
 
635
 
489
636
        Names in this stack will get emitted into the output as they are popped
490
637
        off the stack.
491
638
        """
493
640
        self._node_merge_depth_stack.append(merge_depth)
494
641
        self._left_subtree_pushed_stack.append(False)
495
642
        self._pending_parents_stack.append(list(parents))
496
 
        # as we push it, assign it a sequence number against its parent:
497
 
        parents = self._original_graph[node_name]
 
643
        # as we push it, figure out if this is the first child
 
644
        parent_info = None
498
645
        if parents:
499
646
            # node has parents, assign from the left most parent.
500
 
            parent_revno = self._revnos[parents[0]]
501
 
            sequence = parent_revno[1]
502
 
            parent_revno[1] += 1
 
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
503
655
        else:
504
 
            # no parents, use the root sequence
505
 
            sequence = self._root_sequence
506
 
            self._root_sequence +=1
507
 
        self._assigned_sequence_stack.append(sequence)
 
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)
508
660
 
509
661
    def _pop_node(self):
510
 
        """Pop the top node off the stack 
 
662
        """Pop the top node off the stack
511
663
 
512
664
        The node is appended to the sorted output.
513
665
        """
515
667
        # pop off the local variables
516
668
        node_name = self._node_name_stack.pop()
517
669
        merge_depth = self._node_merge_depth_stack.pop()
518
 
        sequence = self._assigned_sequence_stack.pop()
 
670
        first_child = self._first_child_stack.pop()
519
671
        # remove this node from the pending lists:
520
672
        self._left_subtree_pushed_stack.pop()
521
673
        self._pending_parents_stack.pop()
522
674
 
523
675
        parents = self._original_graph[node_name]
 
676
        parent_revno = None
524
677
        if parents:
525
678
            # node has parents, assign from the left most parent.
526
 
            parent_revno = self._revnos[parents[0]]
527
 
            if sequence:
 
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:
528
686
                # not the first child, make a new branch
529
 
                revno = parent_revno[0] + (sequence, 1)
 
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)
530
693
            else:
531
 
                # increment the sequence number within the branch
532
 
                revno = parent_revno[0][:-1] + (parent_revno[0][-1] + 1,)
 
694
                # as the first child, we just increase the final revision
 
695
                # number
 
696
                revno = parent_revno[:-1] + (parent_revno[-1] + 1,)
533
697
        else:
534
698
            # no parents, use the root sequence
535
 
            if sequence:
536
 
                # make a parallel import revision number
537
 
                revno = (0, sequence, 1)
 
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)
538
704
            else:
539
705
                revno = (1,)
 
706
            self._revno_to_branch_count[0] = root_count
540
707
 
541
708
        # store the revno for this node for future reference
542
709
        self._revnos[node_name][0] = revno