← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tsort.py

  • Committer: Vincent Ladeuil
  • Date: 2010-02-05 10:27:33 UTC
  • mto: (5008.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5009.
  • Revision ID: v.ladeuil+lp@free.fr-20100205102733-8wpjnqz6g4nvrbfu
All Conflict action method names start with 'action_' to avoid potential namespace collisions

Show diffs side-by-side

added added

removed removed

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