← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tsort.py

  • Committer: John Arbash Meinel
  • Date: 2007-04-12 20:27:42 UTC
  • mto: (2399.1.15 doc-cleanup)
  • mto: This revision was merged to the branch mainline in revision 2431.
  • Revision ID: john@arbash-meinel.com-20070412202742-4cr2qmchdfe9mg7n
Cherrypick just the epydoc builder changes.
This is just the piece of change that makes 'make api-docs' work,
without any actual documentation changes.

Show diffs side-by-side

added added

removed removed

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