← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tsort.py

  • Committer: Aaron Bentley
  • Date: 2006-07-11 15:04:57 UTC
  • mto: This revision was merged to the branch mainline in revision 1858.
  • Revision ID: abentley@panoramicfeedback.com-20060711150457-d4c96e9c60843973
Ensure commit respects file spec when committing removals

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tsort.py
1
 
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
 
1
# (C) 2005, 2006 Canonical Limited.
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
18
"""Topological sorting routines."""
19
19
 
20
20
 
21
 
from bzrlib import (
22
 
    errors,
23
 
    graph as _mod_graph,
24
 
    revision as _mod_revision,
25
 
    )
 
21
import bzrlib.errors as errors
26
22
 
27
23
 
28
24
__all__ = ["topo_sort", "TopoSorter", "merge_sort", "MergeSorter"]
33
29
 
34
30
    graph -- sequence of pairs of node->parents_list.
35
31
 
36
 
    The result is a list of node names, such that all parents come before their
37
 
    children.
 
32
    The result is a list of node names, such that all parents come before
 
33
    their children.
38
34
 
39
35
    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.
48
36
    """
49
 
    kg = _mod_graph.KnownGraph(dict(graph))
50
 
    return kg.topo_sort()
 
37
    return TopoSorter(graph).sorted()
51
38
 
52
39
 
53
40
class TopoSorter(object):
54
41
 
55
42
    def __init__(self, graph):
56
43
        """Topological sorting of a graph.
57
 
 
 
44
    
58
45
        :param graph: sequence of pairs of node_name->parent_names_list.
59
46
                      i.e. [('C', ['B']), ('B', ['A']), ('A', [])]
60
47
                      For this input the output from the sort or
61
48
                      iter_topo_order routines will be:
62
49
                      'A', 'B', 'C'
63
 
 
 
50
        
64
51
        node identifiers can be any hashable object, and are typically strings.
65
52
 
66
53
        If you have a graph like [('a', ['b']), ('a', ['c'])] this will only use
69
56
        The graph is sorted lazily: until you iterate or sort the input is
70
57
        not processed other than to create an internal representation.
71
58
 
72
 
        iteration or sorting may raise GraphCycleError if a cycle is present
 
59
        iteration or sorting may raise GraphCycleError if a cycle is present 
73
60
        in the graph.
74
61
        """
75
 
        # store a dict of the graph.
 
62
        # a dict of the graph.
76
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()
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
 
        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:
 
101
        while self._graph:
117
102
            # now pick a random node in the source graph, and transfer it to the
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
 
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
127
110
                if not parents_to_visit:
128
111
                    # append the revision to the topo sorted list
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
 
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()
135
115
                else:
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):
 
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):
162
163
    """Topological sort a graph which groups merges.
163
164
 
164
165
    :param graph: sequence of pairs of node->parents_list.
165
 
    :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 
166
167
                       reachable from branch_tip are not included in the
167
168
                       output.
168
169
    :param mainline_revisions: If not None this forces a mainline to be
173
174
                               old revision listed in the mainline revisions
174
175
                               list.
175
176
                               The order for this parameter is oldest-first.
176
 
    :param generate_revno: Optional parameter controlling the generation of
177
 
        revision number sequences in the output. See the output description of
178
 
        the MergeSorter docstring for details.
179
 
    :result: See the MergeSorter docstring for details.
180
 
 
181
 
    Node identifiers can be any hashable object, and are typically strings.
 
177
 
 
178
    The result is a list of node names, such that all parents come before
 
179
    their children.
 
180
 
 
181
    node identifiers can be any hashable object, and are typically strings.
182
182
    """
183
 
    return MergeSorter(graph, branch_tip, mainline_revisions,
184
 
        generate_revno).sorted()
 
183
    return MergeSorter(graph, branch_tip, mainline_revisions).sorted()
185
184
 
186
185
 
187
186
class MergeSorter(object):
188
187
 
189
 
    __slots__ = ['_node_name_stack',
190
 
                 '_node_merge_depth_stack',
191
 
                 '_pending_parents_stack',
192
 
                 '_first_child_stack',
193
 
                 '_left_subtree_pushed_stack',
194
 
                 '_generate_revno',
195
 
                 '_graph',
196
 
                 '_mainline_revisions',
197
 
                 '_stop_revision',
198
 
                 '_original_graph',
199
 
                 '_revnos',
200
 
                 '_revno_to_branch_count',
201
 
                 '_completed_node_names',
202
 
                 '_scheduled_nodes',
203
 
                ]
204
 
 
205
 
    def __init__(self, graph, branch_tip, mainline_revisions=None,
206
 
        generate_revno=False):
 
188
    def __init__(self, graph, branch_tip, mainline_revisions=None):
207
189
        """Merge-aware topological sorting of a graph.
208
 
 
 
190
    
209
191
        :param graph: sequence of pairs of node_name->parent_names_list.
210
192
                      i.e. [('C', ['B']), ('B', ['A']), ('A', [])]
211
193
                      For this input the output from the sort or
212
194
                      iter_topo_order routines will be:
213
195
                      'A', 'B', 'C'
214
 
        :param branch_tip: the tip of the branch to graph. Revisions not
 
196
        :param branch_tip: the tip of the branch to graph. Revisions not 
215
197
                       reachable from branch_tip are not included in the
216
198
                       output.
217
199
        :param mainline_revisions: If not None this forces a mainline to be
222
204
                               old revision listed in the mainline revisions
223
205
                               list.
224
206
                               The order for this parameter is oldest-first.
225
 
        :param generate_revno: Optional parameter controlling the generation of
226
 
            revision number sequences in the output. See the output description
227
 
            for more details.
228
 
 
229
 
        The result is a list sorted so that all parents come before
230
 
        their children. Each element of the list is a tuple containing:
231
 
        (sequence_number, node_name, merge_depth, end_of_merge)
232
 
         * sequence_number: The sequence of this row in the output. Useful for
233
 
           GUIs.
234
 
         * node_name: The node name: opaque text to the merge routine.
235
 
         * merge_depth: How many levels of merging deep this node has been
236
 
           found.
237
 
         * revno_sequence: When requested this field provides a sequence of
238
 
             revision numbers for all revisions. The format is:
239
 
             (REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
240
 
             branch that the revno is on. From left to right the REVNO numbers
241
 
             are the sequence numbers within that branch of the revision.
242
 
             For instance, the graph {A:[], B:['A'], C:['A', 'B']} will get
243
 
             the following revno_sequences assigned: A:(1,), B:(1,1,1), C:(2,).
244
 
             This should be read as 'A is the first commit in the trunk',
245
 
             'B is the first commit on the first branch made from A', 'C is the
246
 
             second commit in the trunk'.
247
 
         * end_of_merge: When True the next node is part of a different merge.
248
 
 
249
 
 
 
207
 
 
208
        
250
209
        node identifiers can be any hashable object, and are typically strings.
251
210
 
252
211
        If you have a graph like [('a', ['b']), ('a', ['c'])] this will only use
255
214
        The graph is sorted lazily: until you iterate or sort the input is
256
215
        not processed other than to create an internal representation.
257
216
 
258
 
        iteration or sorting may raise GraphCycleError if a cycle is present
 
217
        iteration or sorting may raise GraphCycleError if a cycle is present 
259
218
        in the graph.
260
219
 
261
220
        Background information on the design:
280
239
              E  1   [F]
281
240
              F 0
282
241
              C is the end of a cluster due to rule 1.
283
 
              D is not the end of a cluster from rule 1, but is from rule 2: E
 
242
              D is not the end of a cluster from rule 1, but is from rule 2: E 
284
243
                is not its left most ancestor
285
244
              E is the end of a cluster due to rule 1
286
245
              F might be but we need more data.
287
 
 
 
246
              
288
247
        we show connecting lines to a parent when:
289
248
         - The parent is the start of a merge within this cluster.
290
 
           That is, the merge was not done to the mainline before this cluster
 
249
           That is, the merge was not done to the mainline before this cluster 
291
250
           was merged to the mainline.
292
251
           This can be detected thus:
293
 
            * The parent has a higher merge depth and is the next revision in
 
252
            * The parent has a higher merge depth and is the next revision in 
294
253
              the list.
295
 
 
 
254
          
296
255
          The next revision in the list constraint is needed for this case:
297
 
          A 0   [D, B]
298
 
          B  1  [C, F]   # we do not want to show a line to F which is depth 2
 
256
          A 0   [D, B]   
 
257
          B  1  [C, F]   # we do not want to show a line to F which is depth 2 
299
258
                           but not a merge
300
 
          C  1  [H]      # note that this is a long line to show back to the
 
259
          C  1  [H]      # note that this is a long line to show back to the 
301
260
                           ancestor - see the end of merge rules.
302
261
          D 0   [G, E]
303
262
          E  1  [G, F]
326
285
             XXXX revisit when awake. ddaa asks about the relevance of each one
327
286
             - maybe more than one parent is relevant
328
287
        """
329
 
        self._generate_revno = generate_revno
330
288
        # a dict of the graph.
331
289
        self._graph = dict(graph)
332
290
        # if there is an explicit mainline, alter the graph to match. This is
338
296
        else:
339
297
            self._mainline_revisions = list(mainline_revisions)
340
298
            self._stop_revision = self._mainline_revisions[0]
341
 
        # skip the first revision, its what we reach and its parents are
 
299
        # skip the first revision, its what we reach and its parents are 
342
300
        # therefore irrelevant
343
301
        for index, revision in enumerate(self._mainline_revisions[1:]):
344
302
            # NB: index 0 means self._mainline_revisions[1]
347
305
            if parent is None:
348
306
                # end of mainline_revisions history
349
307
                continue
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:
 
308
            if self._graph[revision][0] == parent:
357
309
                continue
358
310
            # remove it from its prior spot
359
311
            self._graph[revision].remove(parent)
363
315
        # which requires the parents to be accessible: its easier for now
364
316
        # to just keep the original graph around.
365
317
        self._original_graph = dict(self._graph.items())
366
 
        # we need to know the revision numbers of revisions to determine
367
 
        # the revision numbers of their descendants
368
 
        # this is a graph from node to [revno_tuple, first_child]
369
 
        # where first_child is True if no other children have seen this node
370
 
        # and revno_tuple is the tuple that was assigned to the node.
371
 
        # we dont know revnos to start with, so we start it seeded with
372
 
        # [None, True]
373
 
        self._revnos = dict((revision, [None, True])
374
 
                            for revision in self._graph)
375
 
        # Each mainline revision counts how many child branches have spawned from it.
376
 
        self._revno_to_branch_count = {}
377
 
 
 
318
        
378
319
        # this is a stack storing the depth first search into the graph.
379
320
        self._node_name_stack = []
380
321
        # at each level of recursion we need the merge depth this node is at:
381
322
        self._node_merge_depth_stack = []
382
323
        # at each level of 'recursion' we have to check each parent. This
383
 
        # stack stores the parents we have not yet checked for the node at the
 
324
        # stack stores the parents we have not yet checked for the node at the 
384
325
        # matching depth in _node_name_stack
385
326
        self._pending_parents_stack = []
386
 
        # When we first look at a node we assign it a seqence number from its
387
 
        # leftmost parent.
388
 
        self._first_child_stack = []
389
327
        # this is a set of the nodes who have been completely analysed for fast
390
328
        # membership checking
391
329
        self._completed_node_names = set()
398
336
        # D 0  [F, E]
399
337
        # E  1 [F]
400
338
        # F 0
401
 
        # the scheduling order is: F, E, D, C, B, A
 
339
        # the scheduling order is: F, E, D, C, B, A 
402
340
        # that is - 'left subtree, right subtree, node'
403
341
        # which would mean that when we schedule A we can emit the entire tree.
404
342
        self._scheduled_nodes = []
405
 
        # This records for each node when we have processed its left most
 
343
        # This records for each node when we have processed its left most 
406
344
        # unmerged subtree. After this subtree is scheduled, all other subtrees
407
345
        # have their merge depth increased by one from this nodes merge depth.
408
 
        # it contains tuples - name, merge_depth
409
 
        self._left_subtree_pushed_stack = []
 
346
        self._left_subtree_done_stack = []
410
347
 
411
348
        # seed the search with the tip of the branch
412
 
        if (branch_tip is not None and
413
 
            branch_tip != _mod_revision.NULL_REVISION and
414
 
            branch_tip != (_mod_revision.NULL_REVISION,)):
 
349
        if branch_tip is not None:
415
350
            parents = self._graph.pop(branch_tip)
416
351
            self._push_node(branch_tip, 0, parents)
417
352
 
418
353
    def sorted(self):
419
354
        """Sort the graph and return as a list.
420
 
 
 
355
        
421
356
        After calling this the sorter is empty and you must create a new one.
422
357
        """
423
358
        return list(self.iter_topo_order())
424
359
 
425
360
    def iter_topo_order(self):
426
361
        """Yield the nodes of the graph in a topological order.
427
 
 
 
362
        
428
363
        After finishing iteration the sorter is empty and you cannot continue
429
364
        iteration.
430
365
        """
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:
 
366
        while self._node_name_stack:
544
367
            # loop until this call completes.
545
 
            parents_to_visit = pending_parents_stack[-1]
 
368
            parents_to_visit = self._pending_parents_stack[-1]
546
369
            # if all parents are done, the revision is done
547
370
            if not parents_to_visit:
548
371
                # append the revision to the topo sorted scheduled list:
549
372
                # all the nodes parents have been scheduled added, now
550
373
                # we can add it to the output.
551
 
                pop_node()
 
374
                self._pop_node()
552
375
            else:
553
 
                while pending_parents_stack[-1]:
554
 
                    if not left_subtree_pushed_stack[-1]:
 
376
                while self._pending_parents_stack[-1]:
 
377
                    if not self._left_subtree_done_stack[-1]:
555
378
                        # recurse depth first into the primary parent
556
 
                        next_node_name = pending_parents_stack[-1].pop(0)
557
 
                        is_left_subtree = True
558
 
                        left_subtree_pushed_stack[-1] = True
 
379
                        next_node_name = self._pending_parents_stack[-1].pop(0)
559
380
                    else:
560
381
                        # place any merges in right-to-left order for scheduling
561
382
                        # which gives us left-to-right order after we reverse
562
 
                        # the scheduled queue. XXX: This has the effect of
 
383
                        # the scheduled queue. XXX: This has the effect of 
563
384
                        # allocating common-new revisions to the right-most
564
 
                        # subtree rather than the left most, which will
 
385
                        # subtree rather than the left most, which will 
565
386
                        # display nicely (you get smaller trees at the top
566
387
                        # of the combined merge).
567
 
                        next_node_name = pending_parents_stack[-1].pop()
568
 
                        is_left_subtree = False
569
 
                    if next_node_name in completed_node_names:
 
388
                        next_node_name = self._pending_parents_stack[-1].pop()
 
389
                    if next_node_name in self._completed_node_names:
570
390
                        # this parent was completed by a child on the
571
391
                        # call stack. skip it.
572
392
                        continue
573
393
                    # otherwise transfer it from the source graph into the
574
394
                    # top of the current depth first search stack.
575
395
                    try:
576
 
                        parents = graph_pop(next_node_name)
 
396
                        parents = self._graph.pop(next_node_name)
577
397
                    except KeyError:
578
398
                        # if the next node is not in the source graph it has
579
399
                        # already been popped from it and placed into the
580
400
                        # current search stack (but not completed or we would
581
401
                        # have hit the continue 4 lines up.
582
402
                        # this indicates a cycle.
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
 
403
                        raise errors.GraphCycleError(self._node_name_stack)
588
404
                    next_merge_depth = 0
589
 
                    if is_left_subtree:
590
 
                        # a new child branch from name_stack[-1]
 
405
                    if self._left_subtree_done_stack[-1]:
 
406
                        next_merge_depth = 1
 
407
                    else:
591
408
                        next_merge_depth = 0
592
 
                    else:
593
 
                        next_merge_depth = 1
 
409
                        self._left_subtree_done_stack[-1] = True
594
410
                    next_merge_depth = (
595
 
                        node_merge_depth_stack[-1] + next_merge_depth)
596
 
                    push_node(
 
411
                        self._node_merge_depth_stack[-1] + next_merge_depth)
 
412
                    self._push_node(
597
413
                        next_node_name,
598
414
                        next_merge_depth,
599
415
                        parents)
600
 
                    # and do not continue processing parents until this 'call'
 
416
                    # and do not continue processing parents until this 'call' 
601
417
                    # has recursed.
602
418
                    break
603
 
 
604
419
        # We have scheduled the graph. Now deliver the ordered output:
605
420
        sequence_number = 0
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:
 
421
        while self._scheduled_nodes:
 
422
            node_name, merge_depth = self._scheduled_nodes.pop()
 
423
            if node_name == self._stop_revision:
613
424
                return
614
 
            if not len(scheduled_nodes):
615
 
                # last revision is the end of a merge
 
425
            if not len(self._scheduled_nodes):
616
426
                end_of_merge = True
617
 
            elif scheduled_nodes[-1][1] < merge_depth:
 
427
            elif self._scheduled_nodes[-1][1] < merge_depth:
618
428
                # the next node is to our left
619
429
                end_of_merge = True
620
 
            elif (scheduled_nodes[-1][1] == merge_depth and
621
 
                  (scheduled_nodes[-1][0] not in
622
 
                   original_graph[node_name])):
 
430
            elif (self._scheduled_nodes[-1][1] == merge_depth and
 
431
                  (self._scheduled_nodes[-1][0] not in
 
432
                   self._original_graph[node_name])):
623
433
                # the next node was part of a multiple-merge.
624
434
                end_of_merge = True
625
435
            else:
626
436
                end_of_merge = False
627
 
            if generate_revno:
628
 
                yield (sequence_number, node_name, merge_depth, revno, end_of_merge)
629
 
            else:
630
 
                yield (sequence_number, node_name, merge_depth, end_of_merge)
 
437
            yield (sequence_number, node_name, merge_depth, end_of_merge)
631
438
            sequence_number += 1
632
439
 
633
440
    def _push_node(self, node_name, merge_depth, parents):
634
441
        """Add node_name to the pending node stack.
635
 
 
 
442
        
636
443
        Names in this stack will get emitted into the output as they are popped
637
444
        off the stack.
638
445
        """
639
446
        self._node_name_stack.append(node_name)
640
447
        self._node_merge_depth_stack.append(merge_depth)
641
 
        self._left_subtree_pushed_stack.append(False)
 
448
        self._left_subtree_done_stack.append(False)
642
449
        self._pending_parents_stack.append(list(parents))
643
 
        # as we push it, figure out if this is the first child
644
 
        parent_info = None
645
 
        if parents:
646
 
            # node has parents, assign from the left most parent.
647
 
            try:
648
 
                parent_info = self._revnos[parents[0]]
649
 
            except KeyError:
650
 
                # Left-hand parent is a ghost, consider it not to exist
651
 
                pass
652
 
        if parent_info is not None:
653
 
            first_child = parent_info[1]
654
 
            parent_info[1] = False
655
 
        else:
656
 
            # We don't use the same algorithm here, but we need to keep the
657
 
            # stack in line
658
 
            first_child = None
659
 
        self._first_child_stack.append(first_child)
660
450
 
661
451
    def _pop_node(self):
662
 
        """Pop the top node off the stack
 
452
        """Pop the top node off the stack 
663
453
 
664
454
        The node is appended to the sorted output.
665
455
        """
667
457
        # pop off the local variables
668
458
        node_name = self._node_name_stack.pop()
669
459
        merge_depth = self._node_merge_depth_stack.pop()
670
 
        first_child = self._first_child_stack.pop()
671
 
        # remove this node from the pending lists:
672
 
        self._left_subtree_pushed_stack.pop()
 
460
        self._left_subtree_done_stack.pop()
673
461
        self._pending_parents_stack.pop()
674
462
 
675
 
        parents = self._original_graph[node_name]
676
 
        parent_revno = None
677
 
        if parents:
678
 
            # node has parents, assign from the left most parent.
679
 
            try:
680
 
                parent_revno = self._revnos[parents[0]][0]
681
 
            except KeyError:
682
 
                # left-hand parent is a ghost, treat it as not existing
683
 
                pass
684
 
        if parent_revno is not None:
685
 
            if not first_child:
686
 
                # not the first child, make a new branch
687
 
                base_revno = parent_revno[0]
688
 
                branch_count = self._revno_to_branch_count.get(base_revno, 0)
689
 
                branch_count += 1
690
 
                self._revno_to_branch_count[base_revno] = branch_count
691
 
                revno = (parent_revno[0], branch_count, 1)
692
 
                # revno = (parent_revno[0], branch_count, parent_revno[-1]+1)
693
 
            else:
694
 
                # as the first child, we just increase the final revision
695
 
                # number
696
 
                revno = parent_revno[:-1] + (parent_revno[-1] + 1,)
697
 
        else:
698
 
            # no parents, use the root sequence
699
 
            root_count = self._revno_to_branch_count.get(0, 0)
700
 
            root_count = self._revno_to_branch_count.get(0, -1)
701
 
            root_count += 1
702
 
            if root_count:
703
 
                revno = (0, root_count, 1)
704
 
            else:
705
 
                revno = (1,)
706
 
            self._revno_to_branch_count[0] = root_count
707
 
 
708
 
        # store the revno for this node for future reference
709
 
        self._revnos[node_name][0] = revno
710
463
        self._completed_node_names.add(node_name)
711
 
        self._scheduled_nodes.append((node_name, merge_depth, self._revnos[node_name][0]))
 
464
        self._scheduled_nodes.append((node_name, merge_depth))
712
465
        return node_name