1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972
|
import sys
import re
from argparse import ArgumentParser
from functools import partial
from cola import app # prints a message if Qt cannot be found
from qtpy import QtGui
from qtpy import QtWidgets
from qtpy.QtCore import Qt
from qtpy.QtCore import Signal
from cola import core
from cola import difftool
from cola import gitcmds
from cola import hotkeys
from cola import icons
from cola import qtutils
from cola import utils
from cola.i18n import N_
from cola.models import dag
from cola.models import prefs
from cola.widgets import defs
from cola.widgets import filelist
from cola.widgets import diff
from cola.widgets import standard
from cola.widgets import text
BREAK = 'break'
DROP = 'drop'
EDIT = 'edit'
EXEC = 'exec'
FIXUP = 'fixup'
LABEL = 'label'
MERGE = 'merge'
PICK = 'pick'
RESET = 'reset'
REWORD = 'reword'
SQUASH = 'squash'
UPDATE_REF = 'update-ref'
COMMANDS = (
EDIT,
DROP,
FIXUP,
PICK,
REWORD,
SQUASH,
)
COMMAND_IDX = {cmd_: idx_ for idx_, cmd_ in enumerate(COMMANDS)}
ABBREV = {
'b': BREAK,
'd': DROP,
'e': EDIT,
'f': FIXUP,
'p': PICK,
'r': REWORD,
's': SQUASH,
'u': UPDATE_REF,
'x': EXEC,
}
def main():
"""Start a git-cola-sequence-editor session"""
args = parse_args()
context = app.application_init(args)
view = new_window(context, args.filename)
app.application_run(context, view, start=view.start, stop=stop)
return view.status
def stop(context, _view):
"""All done, cleanup"""
context.view.stop()
context.runtask.wait()
def parse_args():
parser = ArgumentParser()
parser.add_argument(
'filename', metavar='<filename>', help='git-rebase-todo file to edit'
)
app.add_common_arguments(parser)
return parser.parse_args()
def new_window(context, filename):
window = MainWindow(context)
editor = Editor(context, filename, parent=window)
window.set_editor(editor)
return window
def unabbrev(cmd):
"""Expand shorthand commands into their full name"""
return ABBREV.get(cmd, cmd)
class MainWindow(standard.MainWindow):
"""The main git-cola application window"""
def __init__(self, context, parent=None):
super().__init__(parent)
self.context = context
self.status = 1
# If the user closes the window without confirmation it's considered cancelled.
self.cancelled = True
self.editor = None
default_title = '%s - git cola sequence editor' % core.getcwd()
title = core.getenv('GIT_COLA_SEQ_EDITOR_TITLE', default_title)
self.setWindowTitle(title)
self.show_help_action = qtutils.add_action(
self, N_('Show Help'), partial(show_help, context), hotkeys.QUESTION
)
self.menubar = QtWidgets.QMenuBar(self)
self.help_menu = self.menubar.addMenu(N_('Help'))
self.help_menu.addAction(self.show_help_action)
self.setMenuBar(self.menubar)
qtutils.add_close_action(self)
self.init_state(context.settings, self.init_window_size)
def init_window_size(self):
"""Set the window size on the first initial view"""
if utils.is_darwin():
width, height = qtutils.desktop_size()
self.resize(width, height)
else:
self.showMaximized()
def set_editor(self, editor):
self.editor = editor
self.setCentralWidget(editor)
editor.cancel.connect(self.close)
editor.rebase.connect(self.rebase)
editor.setFocus()
def start(self, _context, _view):
"""Start background tasks"""
self.editor.start()
def stop(self):
"""Stop background tasks"""
self.editor.stop()
def rebase(self):
"""Exit the editor and initiate a rebase"""
self.status = self.editor.save()
self.close()
class Editor(QtWidgets.QWidget):
cancel = Signal()
rebase = Signal()
def __init__(self, context, filename, parent=None):
super().__init__(parent)
self.widget_version = 1
self.context = context
self.filename = filename
self.comment_char = comment_char = prefs.comment_char(context)
self.diff = diff.DiffWidget(context, self)
self.tree = RebaseTreeWidget(context, comment_char, self)
self.filewidget = filelist.FileWidget(context, self, remarks=True)
self.setFocusProxy(self.tree)
self.rebase_button = qtutils.create_button(
text=core.getenv('GIT_COLA_SEQ_EDITOR_ACTION', N_('Rebase')),
tooltip=N_('Accept changes and rebase\nShortcut: Ctrl+Enter'),
icon=icons.ok(),
default=True,
)
self.extdiff_button = qtutils.create_button(
text=N_('Launch Diff Tool'),
tooltip=N_('Launch external diff tool\nShortcut: Ctrl+D'),
)
self.extdiff_button.setEnabled(False)
self.help_button = qtutils.create_button(
text=N_('Help'), tooltip=N_('Show help\nShortcut: ?'), icon=icons.question()
)
self.cancel_button = qtutils.create_button(
text=N_('Cancel'),
tooltip=N_('Cancel rebase\nShortcut: Ctrl+Q'),
icon=icons.close(),
)
top = qtutils.splitter(Qt.Horizontal, self.tree, self.filewidget)
top.setSizes([75, 25])
main_split = qtutils.splitter(Qt.Vertical, top, self.diff)
main_split.setSizes([25, 75])
controls_layout = qtutils.hbox(
defs.no_margin,
defs.button_spacing,
self.cancel_button,
qtutils.STRETCH,
self.help_button,
self.extdiff_button,
self.rebase_button,
)
layout = qtutils.vbox(defs.no_margin, defs.spacing, main_split, controls_layout)
self.setLayout(layout)
self.action_rebase = qtutils.add_action(
self,
N_('Rebase'),
self.rebase.emit,
hotkeys.CTRL_RETURN,
hotkeys.CTRL_ENTER,
)
self.tree.commits_selected.connect(self.commits_selected)
self.tree.commits_selected.connect(self.filewidget.commits_selected)
self.tree.commits_selected.connect(self.diff.commits_selected)
self.tree.external_diff.connect(self.external_diff)
self.filewidget.files_selected.connect(self.diff.files_selected)
self.filewidget.remark_toggled.connect(self.remark_toggled_for_files)
# `git` calls are expensive. When user toggles a remark of all commits touching
# selected paths the GUI freezes for a while on a big enough sequence. This
# cache is used (commit ID to paths tuple) to minimize calls to git.
self.oid_to_paths = {}
self.task = None # A task fills the cache in the background.
self.running = False # This flag stops it.
qtutils.connect_button(self.rebase_button, self.rebase.emit)
qtutils.connect_button(self.extdiff_button, self.external_diff)
qtutils.connect_button(self.help_button, partial(show_help, context))
qtutils.connect_button(self.cancel_button, self.cancel.emit)
def start(self):
insns = core.read(self.filename)
self.parse_sequencer_instructions(insns)
# Assume that the tree is filled at this point.
self.running = True
self.task = qtutils.SimpleTask(self.calculate_oid_to_paths)
self.context.runtask.start(self.task)
def stop(self):
self.running = False
# signal callbacks
def commits_selected(self, commits):
self.extdiff_button.setEnabled(bool(commits))
def remark_toggled_for_files(self, remark, filenames):
filenames = set(filenames)
items = self.tree.items()
touching_items = []
for item in items:
if not item.is_commit():
continue
oid = item.oid
paths = self.paths_touched_by_oid(oid)
if filenames.intersection(paths):
touching_items.append(item)
self.tree.toggle_remark_of_items(remark, touching_items)
def external_diff(self):
items = self.tree.selected_items()
if not items:
return
item = items[0]
difftool.diff_expression(self.context, self, item.oid + '^!', hide_expr=True)
# helpers
def paths_touched_by_oid(self, oid):
try:
return self.oid_to_paths[oid]
except KeyError:
pass
paths = gitcmds.changed_files(self.context, oid)
self.oid_to_paths[oid] = paths
return paths
def calculate_oid_to_paths(self):
"""Fills the oid_to_paths cache in the background"""
for item in self.tree.items():
if not self.running:
return
self.paths_touched_by_oid(item.oid)
def parse_sequencer_instructions(self, insns):
idx = 1
re_comment_char = re.escape(self.comment_char)
break_rgx = re.compile(r'^\s*(%s)?\s*(b|break)$' % re_comment_char)
exec_rgx = re.compile(r'^\s*(%s)?\s*(x|exec)\s+(.+)$' % re_comment_char)
update_ref_rgx = re.compile(
r'^\s*(%s)?\s*(u|update-ref)\s+(.+)$' % re_comment_char
)
# The upper bound of 40 below must match git.OID_LENGTH.
# We'll have to update this to the new hash length when that happens.
pick_rgx = re.compile(
(
r'^\s*(%s)?\s*'
+ r'(d|drop|e|edit|f|fixup|p|pick|r|reword|s|squash)'
+ r'\s+([0-9a-f]{7,40})'
+ r'\s+(.+)$'
)
% re_comment_char
)
label_rgx = re.compile(
r'^\s*(%s)?\s*(l|label|m|merge|t|reset)\s+(.+)$' % re_comment_char
)
for line in insns.splitlines():
match = pick_rgx.match(line)
if match:
enabled = match.group(1) is None
command = unabbrev(match.group(2))
oid = match.group(3)
summary = match.group(4)
self.tree.add_item(idx, enabled, command, oid=oid, summary=summary)
idx += 1
continue
match = exec_rgx.match(line)
if match:
enabled = match.group(1) is None
command = unabbrev(match.group(2))
cmdexec = match.group(3)
self.tree.add_item(idx, enabled, command, cmdexec=cmdexec)
idx += 1
continue
match = update_ref_rgx.match(line)
if match:
enabled = match.group(1) is None
command = unabbrev(match.group(2))
branch = match.group(3)
self.tree.add_item(idx, enabled, command, branch=branch)
idx += 1
continue
match = label_rgx.match(line)
if match:
enabled = match.group(1) is None
command = unabbrev(match.group(2))
label = match.group(3)
self.tree.add_item(idx, enabled, command, label=label)
idx += 1
continue
match = break_rgx.match(line)
if match:
enabled = match.group(1) is None
command = unabbrev(match.group(2))
self.tree.add_item(idx, enabled, command)
idx += 1
continue
self.tree.decorate(self.tree.items())
self.tree.refit()
self.tree.select_first()
def save(self, string=None):
"""Save the instruction sheet"""
if string is None:
lines = [item.value() for item in self.tree.items()]
# sequencer instructions
string = '\n'.join(lines) + '\n'
try:
core.write(self.filename, string)
status = 0
except (OSError, ValueError) as exc:
msg, details = utils.format_exception(exc)
sys.stderr.write(msg + '\n\n' + details)
status = 128
return status
class RebaseTreeWidget(standard.DraggableTreeWidget):
commits_selected = Signal(object)
external_diff = Signal()
move_rows = Signal(object, object)
def __init__(self, context, comment_char, parent):
super().__init__(parent=parent)
self.context = context
self.comment_char = comment_char
# header
self.setHeaderLabels([
N_('#'),
N_('Enabled'),
N_('Command'),
N_('Commit@@noun'),
N_('Remarks'),
N_('Summary'),
])
self.header().setStretchLastSection(True)
self.setColumnCount(6)
self.setSelectionMode(QtWidgets.QAbstractItemView.ExtendedSelection)
# actions
self.copy_oid_action = qtutils.add_action(
self, N_('Copy Commit'), self.copy_oid, QtGui.QKeySequence.Copy
)
self.external_diff_action = qtutils.add_action(
self, N_('Launch Diff Tool'), self.external_diff.emit, hotkeys.DIFF
)
self.toggle_enabled_action = qtutils.add_action(
self, N_('Toggle Enabled'), self.toggle_enabled, hotkeys.PRIMARY_ACTION
)
self.action_pick = qtutils.add_action(
self, N_('Pick'), lambda: self.set_selected_to(PICK), *hotkeys.REBASE_PICK
)
self.action_reword = qtutils.add_action(
self,
N_('Reword'),
lambda: self.set_selected_to(REWORD),
*hotkeys.REBASE_REWORD,
)
self.action_edit = qtutils.add_action(
self, N_('Edit'), lambda: self.set_selected_to(EDIT), *hotkeys.REBASE_EDIT
)
self.action_fixup = qtutils.add_action(
self,
N_('Fixup'),
lambda: self.set_selected_to(FIXUP),
*hotkeys.REBASE_FIXUP,
)
self.action_squash = qtutils.add_action(
self,
N_('Squash'),
lambda: self.set_selected_to(SQUASH),
*hotkeys.REBASE_SQUASH,
)
self.action_drop = qtutils.add_action(
self,
N_('Drop'),
lambda: self.set_selected_to(DROP),
*hotkeys.REBASE_DROP,
)
self.action_shift_down = qtutils.add_action(
self, N_('Shift Down'), self.shift_down, hotkeys.MOVE_DOWN_TERTIARY
)
self.action_shift_up = qtutils.add_action(
self, N_('Shift Up'), self.shift_up, hotkeys.MOVE_UP_TERTIARY
)
self.toggle_remark_actions = tuple(
qtutils.add_action(
self,
r,
lambda remark=r: self.toggle_remark(remark),
hotkeys.hotkey(Qt.CTRL | getattr(Qt, 'Key_' + r)),
)
for r in map(str, range(10))
)
self.itemChanged.connect(self.item_changed)
self.itemSelectionChanged.connect(self.selection_changed)
self.move_rows.connect(self.move)
self.items_moved.connect(self.decorate)
def add_item(
self, idx, enabled, command, oid='', summary='', cmdexec='', branch='', label=''
):
comment_char = self.comment_char
item = RebaseTreeWidgetItem(
idx,
enabled,
command,
oid=oid,
summary=summary,
cmdexec=cmdexec,
branch=branch,
comment_char=comment_char,
label=label,
parent=self,
)
self.invisibleRootItem().addChild(item)
def decorate(self, items):
for item in items:
item.decorate(self)
def refit(self):
"""Resize columns to fit content"""
for i in range(RebaseTreeWidgetItem.COLUMN_COUNT - 1):
self.resizeColumnToContents(i)
def item_changed(self, item, column):
"""Validate item ordering when toggling their enabled state"""
if column == item.ENABLED_COLUMN:
self.validate()
def validate(self):
invalid_first_choice = {FIXUP, SQUASH}
for item in self.items():
if item.is_enabled() and item.is_commit():
if item.command in invalid_first_choice:
item.reset_command(PICK)
break
def set_selected_to(self, command):
for i in self.selected_items():
i.reset_command(command)
self.validate()
def set_command(self, item, command):
item.reset_command(command)
self.validate()
def copy_oid(self):
item = self.selected_item()
if item is None:
return
clipboard = item.oid or item.cmdexec
qtutils.set_clipboard(clipboard)
def selection_changed(self):
item = self.selected_item()
if item is None or not item.is_commit():
return
context = self.context
oid = item.oid
params = dag.DAG(oid, 2)
repo = dag.RepoReader(context, params, allow_git_init=False)
commits = []
for commit in repo.get():
commits.append(commit)
if commits:
commits = commits[-1:]
self.commits_selected.emit(commits)
def toggle_enabled(self):
"""Toggle the enabled state of each selected item"""
items = self.selected_items()
enable = should_enable(items, lambda item: item.is_enabled())
for item in items:
if enable:
needs_update = not item.is_enabled()
else:
needs_update = item.is_enabled()
if needs_update:
item.set_enabled(enable)
def select_first(self):
items = self.items()
if not items:
return
idx = self.model().index(0, 0)
if idx.isValid():
self.setCurrentIndex(idx)
def shift_down(self):
sel_items = self.selected_items()
all_items = self.items()
sel_idx = sorted([all_items.index(item) for item in sel_items])
if not sel_idx:
return
idx = sel_idx[0] + 1
if not (
idx > len(all_items) - len(sel_items)
or all_items[sel_idx[-1]] is all_items[-1]
):
self.move_rows.emit(sel_idx, idx)
def shift_up(self):
sel_items = self.selected_items()
all_items = self.items()
sel_idx = sorted([all_items.index(item) for item in sel_items])
if not sel_idx:
return
idx = sel_idx[0] - 1
if idx >= 0:
self.move_rows.emit(sel_idx, idx)
def toggle_remark(self, remark):
"""Toggle remarks for all selected items"""
items = self.selected_items()
self.toggle_remark_of_items(remark, items)
def toggle_remark_of_items(self, remark, items):
"""Toggle remarks for the selected items"""
enable = should_enable(items, lambda item: remark in item.remarks)
for item in items:
needs_update = enable ^ (remark in item.remarks)
if needs_update:
if enable:
item.add_remark(remark)
else:
item.remove_remark(remark)
def move(self, src_idxs, dst_idx):
moved_items = []
src_base = sorted(src_idxs)[0]
for idx in reversed(sorted(src_idxs)):
item = self.invisibleRootItem().takeChild(idx)
moved_items.insert(0, [dst_idx + (idx - src_base), item])
for item in moved_items:
self.invisibleRootItem().insertChild(item[0], item[1])
self.setCurrentItem(item[1])
if moved_items:
moved_items = [item[1] for item in moved_items]
# If we've moved to the top then we need to re-decorate all items.
# Otherwise, we can decorate just the new items.
if dst_idx == 0:
self.decorate(self.items())
else:
self.decorate(moved_items)
for item in moved_items:
item.setSelected(True)
self.validate()
# Qt events
def dropEvent(self, event):
super().dropEvent(event)
self.validate()
def contextMenuEvent(self, event):
items = self.selected_items()
menu = qtutils.create_menu(N_('Actions'), self)
menu.addAction(self.action_pick)
menu.addAction(self.action_reword)
menu.addAction(self.action_edit)
menu.addAction(self.action_fixup)
menu.addAction(self.action_squash)
menu.addAction(self.action_drop)
menu.addSeparator()
menu.addAction(self.toggle_enabled_action)
menu.addSeparator()
menu.addAction(self.copy_oid_action)
self.copy_oid_action.setDisabled(len(items) > 1)
menu.addAction(self.external_diff_action)
self.external_diff_action.setDisabled(len(items) > 1)
menu.addSeparator()
menu_toggle_remark = menu.addMenu(N_('Toggle Remark'))
for action in self.toggle_remark_actions:
menu_toggle_remark.addAction(action)
menu.exec_(self.mapToGlobal(event.pos()))
def should_enable(items, predicate):
"""Calculate whether items should be toggled on or off.
If all items are enabled then return False.
If all items are disabled then return True.
If more items are enabled then return True, otherwise return False.
"""
count = len(items)
enabled = sum(predicate(item) for item in items)
disabled = len(items) - enabled
enable = count > enabled >= disabled or disabled == count
return enable
class ComboBox(QtWidgets.QComboBox):
validate = Signal()
class RebaseTreeWidgetItem(QtWidgets.QTreeWidgetItem):
"""A single data row in the rebase tree widget"""
NUMBER_COLUMN = 0
ENABLED_COLUMN = 1
COMMAND_COLUMN = 2
COMMIT_COLUMN = 3
REMARKS_COLUMN = 4
SUMMARY_COLUMN = 5
COLUMN_COUNT = 6
OID_LENGTH = 7
COLORS = {
'0': ('white', 'darkred'),
'1': ('black', 'salmon'),
'2': ('black', 'sandybrown'),
'3': ('black', 'yellow'),
'4': ('black', 'yellowgreen'),
'5': ('white', 'forestgreen'),
'6': ('white', 'dodgerblue'),
'7': ('white', 'royalblue'),
'8': ('white', 'slateblue'),
'9': ('black', 'rosybrown'),
}
def __init__(
self,
idx,
enabled,
command,
oid='',
summary='',
cmdexec='',
branch='',
label='',
comment_char='#',
remarks=(),
parent=None,
):
QtWidgets.QTreeWidgetItem.__init__(self, parent)
self.combo = None
self.command = command
self.idx = idx
self.oid = oid
self.summary = summary
self.cmdexec = cmdexec
self.branch = branch
self.label = label
self.comment_char = comment_char
self.remarks = remarks
self.remarks_label = None
self._parent = parent
# if core.abbrev is set to a higher value then we will notice by
# simply tracking the longest oid we've seen
oid_len = self.OID_LENGTH
self.__class__.OID_LENGTH = max(len(oid), oid_len)
self.setText(self.NUMBER_COLUMN, '%02d' % idx)
self.set_enabled(enabled)
# checkbox on 1
# combo box on 2
if self.is_exec():
self.setText(self.COMMIT_COLUMN, '')
self.setText(self.SUMMARY_COLUMN, cmdexec)
elif self.is_update_ref():
self.setText(self.COMMIT_COLUMN, '')
self.setText(self.SUMMARY_COLUMN, branch)
elif self.is_label() or self.is_reset() or self.is_merge():
self.setText(self.COMMIT_COLUMN, '')
self.setText(self.SUMMARY_COLUMN, label)
elif self.is_break():
self.setText(self.COMMIT_COLUMN, '')
self.setText(self.SUMMARY_COLUMN, '')
else:
self.setText(self.COMMIT_COLUMN, oid)
self.setText(self.SUMMARY_COLUMN, summary)
self.set_remarks(remarks)
flags = self.flags() | Qt.ItemIsUserCheckable
flags = flags | Qt.ItemIsDragEnabled
flags = flags & ~Qt.ItemIsDropEnabled
self.setFlags(flags)
def __eq__(self, other):
return self is other
def __hash__(self):
return self.oid
def copy(self):
return self.__class__(
self.idx,
self.is_enabled(),
self.command,
oid=self.oid,
summary=self.summary,
cmdexec=self.cmdexec,
branch=self.branch,
comment_char=self.comment_char,
remarks=self.remarks,
)
def decorate(self, parent):
if self.is_exec():
items = [EXEC]
idx = 0
elif self.is_update_ref():
items = [UPDATE_REF]
idx = 0
elif self.is_label():
items = [LABEL]
idx = 0
elif self.is_merge():
items = [MERGE]
idx = 0
elif self.is_reset():
items = [RESET]
idx = 0
elif self.is_break():
items = [BREAK]
idx = 0
else:
items = COMMANDS
idx = COMMAND_IDX[self.command]
combo = self.combo = ComboBox()
combo.setEditable(False)
combo.addItems(items)
combo.setCurrentIndex(idx)
combo.setEnabled(self.is_commit())
signal = combo.currentIndexChanged
signal.connect(lambda x: self.set_command_and_validate(combo))
combo.validate.connect(parent.validate)
parent.setItemWidget(self, self.COMMAND_COLUMN, combo)
self.remarks_label = remarks_label = QtWidgets.QLabel()
parent.setItemWidget(self, self.REMARKS_COLUMN, remarks_label)
self.update_remarks()
def is_break(self):
return self.command == BREAK
def is_exec(self):
return self.command == EXEC
def is_update_ref(self):
return self.command == UPDATE_REF
def is_label(self):
return self.command == LABEL
def is_reset(self):
return self.command == RESET
def is_merge(self):
return self.command == MERGE
def is_commit(self):
return bool(
not (self.is_exec() or self.is_update_ref()) and self.oid and self.summary
)
def value(self):
"""Return the serialized representation of an item"""
if self.is_enabled():
comment = ''
else:
comment = self.comment_char + ' '
if self.is_exec():
return f'{comment}{self.command} {self.cmdexec}'
if self.is_update_ref():
return f'{comment}{self.command} {self.branch}'
if self.is_label() or self.is_merge() or self.is_reset():
return f'{comment}{self.command} {self.label}'
if self.is_break():
return f'{comment}{self.command}'
return f'{comment}{self.command} {self.oid} {self.summary}'
def is_enabled(self):
"""Is the item enabled?"""
return self.checkState(self.ENABLED_COLUMN) == Qt.Checked
def set_enabled(self, enabled):
"""Enable the item by checking its enabled checkbox"""
self.setCheckState(self.ENABLED_COLUMN, enabled and Qt.Checked or Qt.Unchecked)
def toggle_enabled(self):
"""Toggle the enabled state of the item"""
self.set_enabled(not self.is_enabled())
def add_remark(self, remark):
"""Add a remark to the item"""
self.set_remarks(tuple(sorted(set(self.remarks + (remark,)))))
def remove_remark(self, remark):
"""Remove a remark from the item"""
self.set_remarks(tuple(r for r in self.remarks if r != remark))
def set_remarks(self, remarks):
"""Set the remarks and update the remark display"""
if remarks == self.remarks:
return
self.remarks = remarks
self.update_remarks()
self._parent.resizeColumnToContents(self.REMARKS_COLUMN)
def update_remarks(self):
"""Update the remarks label display to match the current remarks"""
label = self.remarks_label
if label is None:
return
label_text = ''
for remark in self.remarks:
fg_color, bg_color = self.COLORS[remark]
label_text += f"""
<span style="
color: {fg_color};
background-color: {bg_color};
"> {remark} </span>
"""
label.setText(label_text)
def set_command(self, command):
"""Set the item to a different command, no-op for exec items"""
if self.is_exec():
return
self.command = command
def refresh(self):
"""Update the view to match the updated state"""
if self.is_commit():
command = self.command
self.combo.setCurrentIndex(COMMAND_IDX[command])
def reset_command(self, command):
"""Set and refresh the item in one shot"""
self.set_command(command)
self.refresh()
def set_command_and_validate(self, combo):
"""Set the command and validate the command order"""
command = COMMANDS[combo.currentIndex()]
self.set_command(command)
self.combo.validate.emit()
def show_help(context):
help_text = N_(
"""
Commands
--------
pick = use commit
reword = use commit, but edit the commit message
edit = use commit, but stop for amending
squash = use commit, but meld into previous commit
fixup = like "squash", but discard this commit's log message
exec = run command (the rest of the line) using shell
break = stop here (continue rebase later)
drop = remove commit
label = label current HEAD with a name
reset = reset HEAD to a label
merge = create a merge commit
update-ref = update branches that point to commits
These lines can be re-ordered; they are executed from top to bottom.
If you disable a line here THAT COMMIT WILL BE LOST.
However, if you disable everything, the rebase will be aborted.
Keyboard Shortcuts
------------------
? = show help
j = move down
k = move up
J = shift row down
K = shift row up
1, p = pick
2, r = reword
3, e = edit
4, f = fixup
5, s = squash
6, d = drop
spacebar = toggle enabled
ctrl+enter = accept changes and rebase
ctrl+q = cancel and abort the rebase
ctrl+d = launch difftool
"""
)
title = N_('Help - git-cola-sequence-editor')
return text.text_dialog(context, help_text, title)
|