174
178
old revision listed in the mainline revisions
176
180
The order for this parameter is oldest-first.
178
The result is a list of node names, such that all parents come before
181
:param generate_revno: Optional parameter controlling the generation of
182
revision number sequences in the output. See the output description of
183
the MergeSorter docstring for details.
184
:result: See the MergeSorter docstring for details.
181
185
node identifiers can be any hashable object, and are typically strings.
183
return MergeSorter(graph, branch_tip, mainline_revisions).sorted()
187
return MergeSorter(graph, branch_tip, mainline_revisions,
188
generate_revno).sorted()
186
191
class MergeSorter(object):
188
def __init__(self, graph, branch_tip, mainline_revisions=None):
193
__slots__ = ['_node_name_stack',
194
'_node_merge_depth_stack',
195
'_pending_parents_stack',
196
'_first_child_stack',
197
'_left_subtree_pushed_stack',
200
'_mainline_revisions',
204
'_revno_to_branch_count',
205
'_completed_node_names',
209
def __init__(self, graph, branch_tip, mainline_revisions=None,
210
generate_revno=False):
189
211
"""Merge-aware topological sorting of a graph.
191
213
:param graph: sequence of pairs of node_name->parent_names_list.
204
226
old revision listed in the mainline revisions
206
228
The order for this parameter is oldest-first.
229
:param generate_revno: Optional parameter controlling the generation of
230
revision number sequences in the output. See the output description
233
The result is a list sorted so that all parents come before
234
their children. Each element of the list is a tuple containing:
235
(sequence_number, node_name, merge_depth, end_of_merge)
236
* sequence_number: The sequence of this row in the output. Useful for
238
* node_name: The node name: opaque text to the merge routine.
239
* merge_depth: How many levels of merging deep this node has been
241
* revno_sequence: When requested this field provides a sequence of
242
revision numbers for all revisions. The format is:
243
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
244
branch that the revno is on. From left to right the REVNO numbers
245
are the sequence numbers within that branch of the revision.
246
For instance, the graph {A:[], B:['A'], C:['A', 'B']} will get
247
the following revno_sequences assigned: A:(1,), B:(1,1,1), C:(2,).
248
This should be read as 'A is the first commit in the trunk',
249
'B is the first commit on the first branch made from A', 'C is the
250
second commit in the trunk'.
251
* end_of_merge: When True the next node is part of a different merge.
209
254
node identifiers can be any hashable object, and are typically strings.
315
361
# which requires the parents to be accessible: its easier for now
316
362
# to just keep the original graph around.
317
363
self._original_graph = dict(self._graph.items())
364
# we need to know the revision numbers of revisions to determine
365
# the revision numbers of their descendants
366
# this is a graph from node to [revno_tuple, first_child]
367
# where first_child is True if no other children have seen this node
368
# and revno_tuple is the tuple that was assigned to the node.
369
# we dont know revnos to start with, so we start it seeded with
371
self._revnos = dict((revision, [None, True])
372
for revision in self._graph)
373
# Each mainline revision counts how many child branches have spawned from it.
374
self._revno_to_branch_count = {}
319
376
# this is a stack storing the depth first search into the graph.
320
377
self._node_name_stack = []
363
425
After finishing iteration the sorter is empty and you cannot continue
366
while self._node_name_stack:
428
# These are safe to offload to local variables, because they are used
429
# as a stack and modified in place, never assigned to.
430
node_name_stack = self._node_name_stack
431
node_merge_depth_stack = self._node_merge_depth_stack
432
pending_parents_stack = self._pending_parents_stack
433
left_subtree_pushed_stack = self._left_subtree_pushed_stack
434
completed_node_names = self._completed_node_names
435
scheduled_nodes = self._scheduled_nodes
437
graph_pop = self._graph.pop
439
def push_node(node_name, merge_depth, parents,
440
node_name_stack_append=node_name_stack.append,
441
node_merge_depth_stack_append=node_merge_depth_stack.append,
442
left_subtree_pushed_stack_append=left_subtree_pushed_stack.append,
443
pending_parents_stack_append=pending_parents_stack.append,
444
first_child_stack_append=self._first_child_stack.append,
447
"""Add node_name to the pending node stack.
449
Names in this stack will get emitted into the output as they are popped
452
This inlines a lot of self._variable.append functions as local
455
node_name_stack_append(node_name)
456
node_merge_depth_stack_append(merge_depth)
457
left_subtree_pushed_stack_append(False)
458
pending_parents_stack_append(list(parents))
459
# as we push it, check if it is the first child
461
# node has parents, assign from the left most parent.
462
parent_info = revnos[parents[0]]
463
first_child = parent_info[1]
464
parent_info[1] = False
466
# We don't use the same algorithm here, but we need to keep the
469
first_child_stack_append(first_child)
471
def pop_node(node_name_stack_pop=node_name_stack.pop,
472
node_merge_depth_stack_pop=node_merge_depth_stack.pop,
473
first_child_stack_pop=self._first_child_stack.pop,
474
left_subtree_pushed_stack_pop=left_subtree_pushed_stack.pop,
475
pending_parents_stack_pop=pending_parents_stack.pop,
476
original_graph=self._original_graph,
478
completed_node_names_add=self._completed_node_names.add,
479
scheduled_nodes_append=scheduled_nodes.append,
480
revno_to_branch_count=self._revno_to_branch_count,
482
"""Pop the top node off the stack
484
The node is appended to the sorted output.
486
# we are returning from the flattened call frame:
487
# pop off the local variables
488
node_name = node_name_stack_pop()
489
merge_depth = node_merge_depth_stack_pop()
490
first_child = first_child_stack_pop()
491
# remove this node from the pending lists:
492
left_subtree_pushed_stack_pop()
493
pending_parents_stack_pop()
495
parents = original_graph[node_name]
497
# node has parents, assign from the left most parent.
498
parent_revno = revnos[parents[0]][0]
500
# not the first child, make a new branch
501
base_revno = parent_revno[0]
502
branch_count = revno_to_branch_count.get(base_revno, 0)
504
revno_to_branch_count[base_revno] = branch_count
505
revno = (parent_revno[0], branch_count, 1)
506
# revno = (parent_revno[0], branch_count, parent_revno[-1]+1)
508
# as the first child, we just increase the final revision
510
revno = parent_revno[:-1] + (parent_revno[-1] + 1,)
512
# no parents, use the root sequence
513
root_count = revno_to_branch_count.get(0, 0)
515
revno = (0, root_count, 1)
519
revno_to_branch_count[0] = root_count
521
# store the revno for this node for future reference
522
revnos[node_name][0] = revno
523
completed_node_names_add(node_name)
524
scheduled_nodes_append((node_name, merge_depth, revno))
528
while node_name_stack:
367
529
# loop until this call completes.
368
parents_to_visit = self._pending_parents_stack[-1]
530
parents_to_visit = pending_parents_stack[-1]
369
531
# if all parents are done, the revision is done
370
532
if not parents_to_visit:
371
533
# append the revision to the topo sorted scheduled list:
372
534
# all the nodes parents have been scheduled added, now
373
535
# we can add it to the output.
376
while self._pending_parents_stack[-1]:
377
if not self._left_subtree_done_stack[-1]:
538
while pending_parents_stack[-1]:
539
if not left_subtree_pushed_stack[-1]:
378
540
# recurse depth first into the primary parent
379
next_node_name = self._pending_parents_stack[-1].pop(0)
541
next_node_name = pending_parents_stack[-1].pop(0)
381
543
# place any merges in right-to-left order for scheduling
382
544
# which gives us left-to-right order after we reverse
385
547
# subtree rather than the left most, which will
386
548
# display nicely (you get smaller trees at the top
387
549
# of the combined merge).
388
next_node_name = self._pending_parents_stack[-1].pop()
389
if next_node_name in self._completed_node_names:
550
next_node_name = pending_parents_stack[-1].pop()
551
if next_node_name in completed_node_names:
390
552
# this parent was completed by a child on the
391
553
# call stack. skip it.
393
555
# otherwise transfer it from the source graph into the
394
556
# top of the current depth first search stack.
396
parents = self._graph.pop(next_node_name)
558
parents = graph_pop(next_node_name)
398
560
# if the next node is not in the source graph it has
399
561
# already been popped from it and placed into the
400
562
# current search stack (but not completed or we would
401
563
# have hit the continue 4 lines up.
402
564
# this indicates a cycle.
403
raise errors.GraphCycleError(self._node_name_stack)
565
raise errors.GraphCycleError(node_name_stack)
404
566
next_merge_depth = 0
405
if self._left_subtree_done_stack[-1]:
567
if left_subtree_pushed_stack[-1]:
568
# a new child branch from name_stack[-1]
406
569
next_merge_depth = 1
408
571
next_merge_depth = 0
409
self._left_subtree_done_stack[-1] = True
572
left_subtree_pushed_stack[-1] = True
410
573
next_merge_depth = (
411
self._node_merge_depth_stack[-1] + next_merge_depth)
574
node_merge_depth_stack[-1] + next_merge_depth)
414
577
next_merge_depth,
416
579
# and do not continue processing parents until this 'call'
419
583
# We have scheduled the graph. Now deliver the ordered output:
420
584
sequence_number = 0
421
while self._scheduled_nodes:
422
node_name, merge_depth = self._scheduled_nodes.pop()
423
if node_name == self._stop_revision:
585
stop_revision = self._stop_revision
586
generate_revno = self._generate_revno
587
original_graph = self._original_graph
589
while scheduled_nodes:
590
node_name, merge_depth, revno = scheduled_nodes.pop()
591
if node_name == stop_revision:
425
if not len(self._scheduled_nodes):
593
if not len(scheduled_nodes):
594
# last revision is the end of a merge
426
595
end_of_merge = True
427
elif self._scheduled_nodes[-1][1] < merge_depth:
596
elif scheduled_nodes[-1][1] < merge_depth:
428
597
# the next node is to our left
429
598
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])):
599
elif (scheduled_nodes[-1][1] == merge_depth and
600
(scheduled_nodes[-1][0] not in
601
original_graph[node_name])):
433
602
# the next node was part of a multiple-merge.
434
603
end_of_merge = True
436
605
end_of_merge = False
437
yield (sequence_number, node_name, merge_depth, end_of_merge)
607
yield (sequence_number, node_name, merge_depth, revno, end_of_merge)
609
yield (sequence_number, node_name, merge_depth, end_of_merge)
438
610
sequence_number += 1
440
612
def _push_node(self, node_name, merge_depth, parents):
457
641
# pop off the local variables
458
642
node_name = self._node_name_stack.pop()
459
643
merge_depth = self._node_merge_depth_stack.pop()
460
self._left_subtree_done_stack.pop()
644
first_child = self._first_child_stack.pop()
645
# remove this node from the pending lists:
646
self._left_subtree_pushed_stack.pop()
461
647
self._pending_parents_stack.pop()
649
parents = self._original_graph[node_name]
651
# node has parents, assign from the left most parent.
652
parent_revno = self._revnos[parents[0]][0]
654
# not the first child, make a new branch
655
base_revno = parent_revno[0]
656
branch_count = self._revno_to_branch_count.get(base_revno, 0)
658
self._revno_to_branch_count[base_revno] = branch_count
659
revno = (parent_revno[0], branch_count, 1)
660
# revno = (parent_revno[0], branch_count, parent_revno[-1]+1)
662
# as the first child, we just increase the final revision
664
revno = parent_revno[:-1] + (parent_revno[-1] + 1,)
666
# no parents, use the root sequence
667
root_count = self._revno_to_branch_count.get(0, 0)
669
revno = (0, root_count, 1)
673
self._revno_to_branch_count[0] = root_count
675
# store the revno for this node for future reference
676
self._revnos[node_name][0] = revno
463
677
self._completed_node_names.add(node_name)
464
self._scheduled_nodes.append((node_name, merge_depth))
678
self._scheduled_nodes.append((node_name, merge_depth, self._revnos[node_name][0]))
added
removed
bzrlib/tsort.py
