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
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
|
from __future__ import unicode_literals
from gettext import gettext as _
from . import util
from . import encoding
code = encoding.encoding
import os
import re
import sys
import fcntl
import struct
import termios
import signal
from .crpatch import PatchRoot, Header, Hunk, HunkLine
try:
import curses
import fcntl
import termios
curses.error
fcntl.ioctl
termios.TIOCGWINSZ
except ImportError:
# I have no idea if wcurses works with crecord...
try:
import wcurses as curses
curses.error
except ImportError:
# wcurses is not shipped on Windows by default
pass
try:
curses
except NameError:
raise util.Abort(
_('the python curses/wcurses module is not available/installed'))
_origstdout = sys.__stdout__ # used by gethw()
def gethw():
"""
Magically get the current height and width of the window (without initscr)
This is a rip-off of a rip-off - taken from the bpython code. It is
useful / necessary because otherwise curses.initscr() must be called,
which can leave the terminal in a nasty state after exiting.
"""
h, w = struct.unpack(
"hhhh", fcntl.ioctl(_origstdout, termios.TIOCGWINSZ, "\000"*8))[0:2]
return h, w
def chunkselector(opts, headerlist, ui):
"""
Curses interface to get selection of chunks, and mark the applied flags
of the chosen chunks.
"""
chunkselector = CursesChunkSelector(headerlist, ui)
# This is required for ncurses to display non-ASCII characters in default user
# locale encoding correctly. --immerrr
import locale
locale.setlocale(locale.LC_ALL, '')
class dummystdscr:
def clear(self):
pass
def refresh(self):
pass
chunkselector.stdscr = dummystdscr()
f = signal.getsignal(signal.SIGTSTP)
curses.wrapper(chunkselector.main, opts)
if chunkselector.initerr is not None:
raise util.Abort(chunkselector.initerr)
# ncurses does not restore signal handler for SIGTSTP
signal.signal(signal.SIGTSTP, f)
_headermessages = { # {operation: text}
'crecord': _('Select hunks to commit'),
'cstage': _('Select hunks to stage'),
'cunstage': _('Select hunks to keep'),
}
_confirmmessages = {
'crecord': _('Are you sure you want to commit the selected changes [Yn]?'),
'cstage': _('Are you sure you want to stage the selected changes [Yn]?'),
'cunstage': _('Are you sure you want to unstage the unselected changes [Yn]?'),
}
class CursesChunkSelector:
def __init__(self, headerlist, ui):
# put the headers into a patch object
self.headerlist = PatchRoot(headerlist)
self.ui = ui
self.errorstr = None
# list of all chunks
self.chunklist = []
for h in headerlist:
self.chunklist.append(h)
self.chunklist.extend(h.hunks)
# dictionary mapping (fgcolor, bgcolor) pairs to the
# corresponding curses color-pair value.
self.colorpairs = {}
# maps custom nicknames of color-pairs to curses color-pair values
self.colorpairnames = {}
self.usecolor = True
# the currently selected header, hunk, or hunk-line
self.currentselecteditem = self.headerlist[0]
# updated when printing out patch-display -- the 'lines' here are the
# line positions *in the pad*, not on the screen.
self.selecteditemstartline = 0
self.selecteditemendline = None
# define indentation levels
self.headerindentnumchars = 0
self.hunkindentnumchars = 3
self.hunklineindentnumchars = 6
# the first line of the pad to print to the screen
self.firstlineofpadtoprint = 0
# keeps track of the number of lines in the pad
self.numpadlines = None
self.numstatuslines = 1
# keep a running count of the number of lines printed to the pad
# (used for determining when the selected item begins/ends)
self.linesprintedtopadsofar = 0
# the first line of the pad which is visible on the screen
self.firstlineofpadtoprint = 0
# if the last 'toggle all' command caused all changes to be applied
self.waslasttoggleallapplied = True
def handlefirstlineevent(self):
"""
Handle 'g' to navigate to the top most file in the ncurses window.
"""
self.currentselecteditem = self.headerlist[0]
currentitem = self.currentselecteditem
# select the parent item recursively until we're at a header
while True:
nextitem = currentitem.parentitem()
if nextitem is None:
break
else:
currentitem = nextitem
self.currentselecteditem = currentitem
def handlelastlineevent(self):
"""
Handle 'G' to navigate to the bottom most file/hunk/line depending
on the whether the fold is active or not.
If the bottom most file is folded, it navigates to that file and stops there.
If the bottom most file is unfolded, it navigates to the bottom most hunk in
that file and stops there. If the bottom most hunk is unfolded, it navigates to
the bottom most line in that hunk.
"""
currentitem = self.currentselecteditem
nextitem = currentitem.nextitem()
# select the child item recursively until we're at a footer
while nextitem is not None:
nextitem = currentitem.nextitem()
if nextitem is None:
break
else:
currentitem = nextitem
self.currentselecteditem = currentitem
self.recenterdisplayedarea()
def uparrowevent(self):
"""
Try to select the previous item to the current item that has the
most-indented level. For example, if a hunk is selected, try to select
the last HunkLine of the hunk prior to the selected hunk. Or, if
the first HunkLine of a hunk is currently selected, then select the
hunk itself.
"""
currentitem = self.currentselecteditem
nextitem = currentitem.previtem()
if nextitem is None:
# if no parent item (i.e. currentitem is the first header), then
# no change...
nextitem = currentitem
self.currentselecteditem = nextitem
self.recenterdisplayedarea()
def uparrowshiftevent(self):
"""
Select (if possible) the previous item on the same level as the
currently selected item. Otherwise, select (if possible) the
parent-item of the currently selected item.
"""
currentitem = self.currentselecteditem
nextitem = currentitem.prevsibling()
# if there's no previous sibling, try choosing the parent
if nextitem is None:
nextitem = currentitem.parentitem()
if nextitem is None:
# if no parent item (i.e. currentitem is the first header), then
# no change...
nextitem = currentitem
self.currentselecteditem = nextitem
self.recenterdisplayedarea()
def downarrowevent(self):
"""
Try to select the next item to the current item that has the
most-indented level. For example, if a hunk is selected, select
the first HunkLine of the selected hunk. Or, if the last HunkLine of
a hunk is currently selected, then select the next hunk, if one exists,
or if not, the next header if one exists.
"""
#self.startprintline += 1 #debug
currentitem = self.currentselecteditem
nextitem = currentitem.nextitem()
# if there's no next item, keep the selection as-is
if nextitem is None:
nextitem = currentitem
self.currentselecteditem = nextitem
self.recenterdisplayedarea()
def downarrowshiftevent(self):
"""
Select (if possible) the next item on the same level as the currently
selected item. Otherwise, select (if possible) the next item on the
same level as the parent item of the currently selected item.
"""
currentitem = self.currentselecteditem
nextitem = currentitem.nextsibling()
# if there's no next sibling, try choosing the parent's nextsibling
if nextitem is None:
try:
nextitem = currentitem.parentitem().nextsibling()
except AttributeError:
# parentitem returned None, so nextsibling() can't be called
nextitem = None
if nextitem is None:
# if parent has no next sibling, then no change...
nextitem = currentitem
self.currentselecteditem = nextitem
self.recenterdisplayedarea()
def rightarrowevent(self):
"""
Select (if possible) the first of this item's child-items.
"""
currentitem = self.currentselecteditem
nextitem = currentitem.firstchild()
# turn off folding if we want to show a child-item
if currentitem.folded:
self.togglefolded(currentitem)
if nextitem is None:
# if no next item on parent-level, then no change...
nextitem = currentitem
self.currentselecteditem = nextitem
self.recenterdisplayedarea()
def leftarrowevent(self):
"""
If the current item can be folded (i.e. it is an unfolded header or
hunk), then fold it. Otherwise try select (if possible) the parent
of this item.
"""
currentitem = self.currentselecteditem
# try to fold the item
if not isinstance(currentitem, HunkLine):
if not currentitem.folded:
self.togglefolded(item=currentitem)
return
# if it can't be folded, try to select the parent item
nextitem = currentitem.parentitem()
if nextitem is None:
# if no item on parent-level, then no change...
nextitem = currentitem
if not nextitem.folded:
self.togglefolded(item=nextitem)
self.currentselecteditem = nextitem
self.recenterdisplayedarea()
def leftarrowshiftevent(self):
"""
Select the header of the current item (or fold current item if the
current item is already a header).
"""
currentitem = self.currentselecteditem
if isinstance(currentitem, Header):
if not currentitem.folded:
self.togglefolded(item=currentitem)
return
# select the parent item recursively until we're at a header
while True:
nextitem = currentitem.parentitem()
if nextitem is None:
break
else:
currentitem = nextitem
self.currentselecteditem = currentitem
self.recenterdisplayedarea()
def updatescroll(self):
"Scroll the screen to fully show the currently-selected"
selstart = self.selecteditemstartline
selend = self.selecteditemendline
#selnumlines = selend - selstart
padstart = self.firstlineofpadtoprint
padend = padstart + self.yscreensize - self.numstatuslines - 1
# 'buffered' pad start/end values which scroll with a certain
# top/bottom context margin
padstartbuffered = padstart + 3
padendbuffered = padend - 3
if selend > padendbuffered:
self.scrolllines(selend - padendbuffered)
elif selstart < padstartbuffered:
# negative values scroll in pgup direction
self.scrolllines(selstart - padstartbuffered)
def scrolllines(self, numlines):
"Scroll the screen up (down) by numlines when numlines >0 (<0)."
self.firstlineofpadtoprint += numlines
if self.firstlineofpadtoprint < 0:
self.firstlineofpadtoprint = 0
if self.firstlineofpadtoprint > self.numpadlines - 1:
self.firstlineofpadtoprint = self.numpadlines - 1
def toggleapply(self, item=None):
"""
Toggle the applied flag of the specified item. If no item is specified,
toggle the flag of the currently selected item.
"""
if item is None:
item = self.currentselecteditem
item.applied = not item.applied
if isinstance(item, Header):
item.partial = False
if item.applied:
# apply all its hunks
for hnk in item.hunks:
hnk.applied = True
# apply all their hunklines
for hunkline in hnk.changedlines:
hunkline.applied = True
else:
# un-apply all its hunks
for hnk in item.hunks:
hnk.applied = False
hnk.partial = False
# un-apply all their hunklines
for hunkline in hnk.changedlines:
hunkline.applied = False
elif isinstance(item, Hunk):
item.partial = False
# apply all it's hunklines
for hunkline in item.changedlines:
hunkline.applied = item.applied
siblingappliedstatus = [hnk.applied for hnk in item.header.hunks]
allsiblingsapplied = not (False in siblingappliedstatus)
nosiblingsapplied = not (True in siblingappliedstatus)
siblingspartialstatus = [hnk.partial for hnk in item.header.hunks]
somesiblingspartial = (True in siblingspartialstatus)
#cases where applied or partial should be removed from header
# if no 'sibling' hunks are applied (including this hunk)
if nosiblingsapplied:
if not item.header.special():
item.header.applied = False
item.header.partial = False
else: # some/all parent siblings are applied
item.header.applied = True
item.header.partial = (somesiblingspartial or
not allsiblingsapplied)
elif isinstance(item, HunkLine):
siblingappliedstatus = [ln.applied for ln in item.hunk.changedlines]
allsiblingsapplied = not (False in siblingappliedstatus)
nosiblingsapplied = not (True in siblingappliedstatus)
# if no 'sibling' lines are applied
if nosiblingsapplied:
item.hunk.applied = False
item.hunk.partial = False
elif allsiblingsapplied:
item.hunk.applied = True
item.hunk.partial = False
else: # some siblings applied
item.hunk.applied = True
item.hunk.partial = True
parentsiblingsapplied = [hnk.applied for hnk
in item.hunk.header.hunks]
noparentsiblingsapplied = not (True in parentsiblingsapplied)
allparentsiblingsapplied = not (False in parentsiblingsapplied)
parentsiblingspartial = [hnk.partial for hnk
in item.hunk.header.hunks]
someparentsiblingspartial = (True in parentsiblingspartial)
# if all parent hunks are not applied, un-apply header
if noparentsiblingsapplied:
if not item.hunk.header.special():
item.hunk.header.applied = False
item.hunk.header.partial = False
# set the applied and partial status of the header if needed
else: # some/all parent siblings are applied
item.hunk.header.applied = True
item.hunk.header.partial = (someparentsiblingspartial or
not allparentsiblingsapplied)
def toggleall(self):
"Toggle the applied flag of all items."
if self.waslasttoggleallapplied: # then unapply them this time
for item in self.headerlist:
if item.applied:
self.toggleapply(item)
else:
for item in self.headerlist:
if not item.applied:
self.toggleapply(item)
self.waslasttoggleallapplied = not self.waslasttoggleallapplied
def togglefolded(self, item=None, foldparent=False):
"Toggle folded flag of specified item (defaults to currently selected)"
if item is None:
item = self.currentselecteditem
if foldparent or (isinstance(item, Header) and item.neverunfolded):
if not isinstance(item, Header):
# we need to select the parent item in this case
self.currentselecteditem = item = item.parentitem()
elif item.neverunfolded:
item.neverunfolded = False
# also fold any foldable children of the parent/current item
if isinstance(item, Header): # the original OR 'new' item
for child in item.allchildren():
child.folded = not item.folded
if isinstance(item, (Header, Hunk)):
item.folded = not item.folded
def alignstring(self, instr, window):
"""
Add whitespace to the end of a string in order to make it fill
the screen in the x direction. The current cursor position is
taken into account when making this calculation. The string can span
multiple lines.
"""
y, xstart = window.getyx()
width = self.xscreensize
# turn tabs into spaces
instr = instr.expandtabs(4)
strwidth = encoding.ucolwidth(instr)
numspaces = width - ((strwidth + xstart) % width)
return instr + " " * numspaces
def printstring(self, window, text, fgcolor=None, bgcolor=None, pair=None,
pairname=None, attrlist=None, towin=True, align=True, showwhtspc=False):
"""
Print the string, text, with the specified colors and attributes, to
the specified curses window object.
The foreground and background colors are of the form
curses.COLOR_XXXX, where XXXX is one of: [BLACK, BLUE, CYAN, GREEN,
MAGENTA, RED, WHITE, YELLOW]. If pairname is provided, a color
pair will be looked up in the self.colorpairnames dictionary.
attrlist is a list containing text attributes in the form of
curses.A_XXXX, where XXXX can be: [BOLD, DIM, NORMAL, STANDOUT,
UNDERLINE].
If align == True, whitespace is added to the printed string such that
the string stretches to the right border of the window.
If showwhtspc == True, trailing whitespace of a string is highlighted.
"""
# preprocess the text, converting tabs to spaces
text = text.expandtabs(4)
# Strip \n, and convert control characters to ^[char] representation
text = re.sub(r'[\x00-\x08\x0a-\x1f]',
lambda m:'^' + chr(ord(m.group()) + 64), text.strip('\n'))
if pair is not None:
colorpair = pair
elif pairname is not None:
colorpair = self.colorpairnames[pairname]
else:
if fgcolor is None:
fgcolor = -1
if bgcolor is None:
bgcolor = -1
if (fgcolor, bgcolor) in self.colorpairs:
colorpair = self.colorpairs[(fgcolor, bgcolor)]
else:
colorpair = self.getcolorpair(fgcolor, bgcolor)
# add attributes if possible
if attrlist is None:
attrlist = []
if colorpair < 256:
# then it is safe to apply all attributes
for textattr in attrlist:
colorpair |= textattr
else:
# just apply a select few (safe?) attributes
for textattr in (curses.A_UNDERLINE, curses.A_BOLD):
if textattr in attrlist:
colorpair |= textattr
y, xstart = self.chunkpad.getyx()
t = "" # variable for counting lines printed
# if requested, show trailing whitespace
if showwhtspc:
origlen = len(text)
text = text.rstrip(' \n') # tabs have already been expanded
strippedlen = len(text)
numtrailingspaces = origlen - strippedlen
if towin:
window.addstr(text, colorpair)
t += text
if showwhtspc:
wscolorpair = colorpair | curses.A_REVERSE
if towin:
for i in range(numtrailingspaces):
window.addch(curses.ACS_CKBOARD, wscolorpair)
t += " " * numtrailingspaces
if align:
if towin:
extrawhitespace = self.alignstring("", window)
window.addstr(extrawhitespace, colorpair)
else:
# need to use t, since the x position hasn't incremented
extrawhitespace = self.alignstring(t, window)
t += extrawhitespace
# is reset to 0 at the beginning of printitem()
linesprinted = (xstart + len(t)) // self.xscreensize
self.linesprintedtopadsofar += linesprinted
return t
def _getstatuslinesegments(self):
"""-> [str]. return segments"""
selected = self.currentselecteditem.applied
segments = [
_headermessages[self.opts['operation']],
'-',
_('[x]=selected **=collapsed'),
_('c: confirm'),
_('q: abort'),
_('arrow keys: move/expand/collapse'),
_('space: deselect') if selected else _('space: select'),
_('?: help'),
]
return segments
def _getstatuslines(self):
"""() -> [str]. return short help used in the top status window"""
if self.errorstr is not None:
lines = [self.errorstr, _('Press any key to continue')]
else:
# wrap segments to lines
segments = self._getstatuslinesegments()
width = self.xscreensize
lines = []
lastwidth = width
for s in segments:
w = encoding.ucolwidth(s)
sep = ' ' * (1 + (s and s[0] not in '-['))
if lastwidth + w + len(sep) >= width:
lines.append(s)
lastwidth = w
else:
lines[-1] += sep + s
lastwidth += w + len(sep)
if len(lines) != self.numstatuslines:
self.numstatuslines = len(lines)
self.statuswin.resize(self.numstatuslines, self.xscreensize)
return [util.ellipsis(l, self.xscreensize - 1) for l in lines]
def updatescreen(self):
self.statuswin.erase()
self.chunkpad.erase()
printstring = self.printstring
# print out the status lines at the top
try:
for line in self._getstatuslines():
printstring(self.statuswin, line, pairname="legend")
self.statuswin.refresh()
except curses.error:
pass
if self.errorstr is not None:
return
# print out the patch in the remaining part of the window
try:
self.printitem()
self.updatescroll()
self.chunkpad.refresh(self.firstlineofpadtoprint, 0,
self.numstatuslines, 0,
self.yscreensize - self.numstatuslines,
self.xscreensize)
except curses.error:
pass
def getstatusprefixstring(self, item):
"""
Create a string to prefix a line with which indicates whether 'item'
is applied and/or folded.
"""
# create checkbox string
if item.applied:
if not isinstance(item, HunkLine) and item.partial:
checkbox = "[~]"
else:
checkbox = "[x]"
else:
checkbox = "[ ]"
try:
if item.folded:
checkbox += "**"
if isinstance(item, Header):
# one of "M", "A", or "D" (modified, added, deleted)
filestatus = item.changetype
checkbox += filestatus + " "
else:
checkbox += " "
if isinstance(item, Header):
# add two more spaces for headers
checkbox += " "
except AttributeError: # not foldable
checkbox += " "
return checkbox
def printheader(self, header, selected=False, towin=True,
ignorefolding=False):
"""
Print the header to the pad. If countLines is True, don't print
anything, but just count the number of lines which would be printed.
"""
outstr = ""
text = header.prettystr()
chunkindex = self.chunklist.index(header)
if chunkindex != 0 and not header.folded:
# add separating line before headers
outstr += self.printstring(self.chunkpad, '_' * self.xscreensize,
towin=towin, align=False)
# select color-pair based on if the header is selected
colorpair = self.getcolorpair(name=selected and "selected" or "normal",
attrlist=[curses.A_BOLD])
# print out each line of the chunk, expanding it to screen width
# number of characters to indent lines on this level by
indentnumchars = 0
checkbox = self.getstatusprefixstring(header)
if not header.folded or ignorefolding:
textlist = text.split("\n")
linestr = checkbox + textlist[0]
else:
linestr = checkbox + header.filename()
outstr += self.printstring(self.chunkpad, linestr, pair=colorpair,
towin=towin)
if not header.folded or ignorefolding:
if len(textlist) > 1:
for line in textlist[1:]:
linestr = " "*(indentnumchars + len(checkbox)) + line
outstr += self.printstring(self.chunkpad, linestr,
pair=colorpair, towin=towin)
return outstr
def printhunklinesbefore(self, hunk, selected=False, towin=True,
ignorefolding=False):
"includes start/end line indicator"
outstr = ""
# where hunk is in list of siblings
hunkindex = hunk.header.hunks.index(hunk)
if hunkindex != 0:
# add separating line before headers
outstr += self.printstring(self.chunkpad, ' '*self.xscreensize,
towin=towin, align=False)
colorpair = self.getcolorpair(name=selected and "selected" or "normal",
attrlist=[curses.A_BOLD])
# print out from-to line with checkbox
checkbox = self.getstatusprefixstring(hunk)
lineprefix = " "*self.hunkindentnumchars + checkbox
frtoline = " " + hunk.getfromtoline().strip("\n")
outstr += self.printstring(self.chunkpad, lineprefix, towin=towin,
align=False) # add uncolored checkbox/indent
outstr += self.printstring(self.chunkpad, frtoline, pair=colorpair,
towin=towin)
if hunk.folded and not ignorefolding:
# skip remainder of output
return outstr
# print out lines of the chunk preceding changed-lines
for line in hunk.before:
linestr = " "*(self.hunklineindentnumchars + len(checkbox)) + line
outstr += self.printstring(self.chunkpad, linestr, towin=towin)
return outstr
def printhunklinesafter(self, hunk, towin=True, ignorefolding=False):
outstr = ""
if hunk.folded and not ignorefolding:
return outstr
# a bit superfluous, but to avoid hard-coding indent amount
checkbox = self.getstatusprefixstring(hunk)
for line in hunk.after:
linestr = " "*(self.hunklineindentnumchars + len(checkbox)) + line
outstr += self.printstring(self.chunkpad, linestr, towin=towin)
return outstr
def printhunkchangedline(self, hunkline, selected=False, towin=True):
outstr = ""
checkbox = self.getstatusprefixstring(hunkline)
linestr = hunkline.prettystr().strip("\n")
# select color-pair based on whether line is an addition/removal
if selected:
colorpair = self.getcolorpair(name="selected")
elif linestr.startswith("+"):
colorpair = self.getcolorpair(name="addition")
elif linestr.startswith("-"):
colorpair = self.getcolorpair(name="deletion")
elif linestr.startswith("\\"):
colorpair = self.getcolorpair(name="normal")
lineprefix = " "*self.hunklineindentnumchars + checkbox
outstr += self.printstring(self.chunkpad, lineprefix, towin=towin,
align=False) # add uncolored checkbox/indent
outstr += self.printstring(self.chunkpad, linestr, pair=colorpair,
towin=towin, showwhtspc=True)
return outstr
def printitem(self, item=None, ignorefolding=False, recursechildren=True,
towin=True):
"""
Use __printitem() to print the the specified item.applied.
If item is not specified, then print the entire patch.
(hiding folded elements, etc. -- see __printitem() docstring)
"""
if item is None:
item = self.headerlist
if recursechildren:
self.linesprintedtopadsofar = 0
outstr = []
self.__printitem(item, ignorefolding, recursechildren, outstr,
towin=towin)
return ''.join(outstr)
def outofdisplayedarea(self):
y, _ = self.chunkpad.getyx() # cursor location
# * 2 here works but an optimization would be the max number of
# consecutive non selectable lines
# i.e the max number of context line for any hunk in the patch
miny = min(0, self.firstlineofpadtoprint - self.yscreensize)
maxy = self.firstlineofpadtoprint + self.yscreensize * 2
return y < miny or y > maxy
def handleselection(self, item, recursechildren):
selected = (item is self.currentselecteditem)
if selected and recursechildren:
# assumes line numbering starting from line 0
self.selecteditemstartline = self.linesprintedtopadsofar
selecteditemlines = self.getnumlinesdisplayed(item,
recursechildren=False)
self.selecteditemendline = (self.selecteditemstartline +
selecteditemlines - 1)
return selected
def __printitem(self, item, ignorefolding, recursechildren, outstr,
towin=True):
"""
Recursive method for printing out patch/header/hunk/hunk-line data to
screen. Also returns a string with all of the content of the displayed
patch (not including coloring, etc.).
If ignorefolding is True, then folded items are printed out.
If recursechildren is False, then only print the item without its
child items.
"""
if towin and self.outofdisplayedarea():
return
selected = self.handleselection(item, recursechildren)
# Patch object is a list of headers
if isinstance(item, PatchRoot):
if recursechildren:
for hdr in item:
self.__printitem(hdr, ignorefolding,
recursechildren, outstr, towin)
# TODO: eliminate all isinstance() calls
if isinstance(item, Header):
outstr.append(self.printheader(item, selected, towin=towin,
ignorefolding=ignorefolding))
if recursechildren:
for hnk in item.hunks:
self.__printitem(hnk, ignorefolding,
recursechildren, outstr, towin)
elif (isinstance(item, Hunk) and
((not item.header.folded) or ignorefolding)):
# print the hunk data which comes before the changed-lines
outstr.append(self.printhunklinesbefore(item, selected, towin=towin,
ignorefolding=ignorefolding))
if recursechildren:
for l in item.changedlines:
self.__printitem(l, ignorefolding,
recursechildren, outstr, towin)
outstr.append(self.printhunklinesafter(item, towin=towin,
ignorefolding=ignorefolding))
elif (isinstance(item, HunkLine) and
((not item.hunk.folded) or ignorefolding)):
outstr.append(self.printhunkchangedline(item, selected,
towin=towin))
return outstr
def getnumlinesdisplayed(self, item=None, ignorefolding=False,
recursechildren=True):
"""
Return the number of lines which would be displayed if the item were
to be printed to the display. The item will NOT be printed to the
display (pad).
If no item is given, assume the entire patch.
If ignorefolding is True, folded items will be unfolded when counting
the number of lines.
"""
# temporarily disable printing to windows by printstring
patchdisplaystring = self.printitem(item, ignorefolding,
recursechildren, towin=False)
numlines = len(patchdisplaystring) // self.xscreensize
return numlines
def sigwinchhandler(self, n, frame):
"Handle window resizing"
try:
curses.endwin()
self.yscreensize, self.xscreensize = gethw()
self.statuswin.resize(self.numstatuslines, self.xscreensize)
self.numpadlines = self.getnumlinesdisplayed(ignorefolding=True) + 1
self.chunkpad = curses.newpad(self.numpadlines, self.xscreensize)
except curses.error:
pass
def getcolorpair(self, fgcolor=None, bgcolor=None, name=None,
attrlist=None):
"""
Get a curses color pair, adding it to self.colorPairs if it is not
already defined. An optional string, name, can be passed as a shortcut
for referring to the color-pair. By default, if no arguments are
specified, the white foreground / black background color-pair is
returned.
It is expected that this function will be used exclusively for
initializing color pairs, and NOT curses.init_pair().
attrlist is used to 'flavor' the returned color-pair. This information
is not stored in self.colorpairs. It contains attribute values like
curses.A_BOLD.
"""
if (name is not None) and name in self.colorpairnames:
# then get the associated color pair and return it
colorpair = self.colorpairnames[name]
else:
if fgcolor is None:
fgcolor = -1
if bgcolor is None:
bgcolor = -1
if (fgcolor, bgcolor) in self.colorpairs:
colorpair = self.colorpairs[(fgcolor, bgcolor)]
else:
pairindex = len(self.colorpairs) + 1
if self.usecolor:
curses.init_pair(pairindex, fgcolor, bgcolor)
colorpair = self.colorpairs[(fgcolor, bgcolor)] = (
curses.color_pair(pairindex))
if name is not None:
self.colorpairnames[name] = curses.color_pair(pairindex)
else:
cval = 0
if name is not None:
if name == 'selected':
cval = curses.A_REVERSE
self.colorpairnames[name] = cval
colorpair = self.colorpairs[(fgcolor, bgcolor)] = cval
# add attributes if possible
if attrlist is None:
attrlist = []
if colorpair < 256:
# then it is safe to apply all attributes
for textattr in attrlist:
colorpair |= textattr
else:
# just apply a select few (safe?) attributes
for textattrib in (curses.A_UNDERLINE, curses.A_BOLD):
if textattrib in attrlist:
colorpair |= textattrib
return colorpair
def initcolorpair(self, *args, **kwargs):
"Same as getcolorpair."
self.getcolorpair(*args, **kwargs)
def helpwindow(self):
"Print a help window to the screen. Exit after any keypress."
helptext = """ [press any key to return to the patch-display]
crecord allows you to interactively choose among the changes you have made,
and confirm only those changes you select for further processing by the command
you are running (commit/stage/unstage), after confirming the selected
changes, the unselected changes are still present in your working copy, so you
can use crecord multiple times to split large changes into smaller changesets.
The following are valid keystrokes:
[SPACE] : (un-)select item ([~]/[X] = partly/fully applied)
A : (un-)select all items
Up/Down-arrow [k/j] : go to previous/next unfolded item
PgUp/PgDn [K/J] : go to previous/next item of same type
Right/Left-arrow [l/h] : go to child item / parent item
Shift-Left-arrow [H] : go to parent header / fold selected header
g : go to the top
G : go to the bottom
f : fold / unfold item, hiding/revealing its children
F : fold / unfold parent item and all of its ancestors
ctrl-l : scroll the selected line to the top of the screen
a : toggle amend mode
c : commit selected changes
s : stage selected changes
r : review/edit and commit selected changes
q : quit without committing (no changes will be made)
? : help (what you're currently reading)"""
helpwin = curses.newwin(self.yscreensize, 0, 0, 0)
helplines = helptext.split("\n")
helplines = helplines + [" "]*(
self.yscreensize - self.numstatuslines - len(helplines) - 1)
try:
self.printstring(helpwin, helplines[0], pairname="legend")
for line in helplines[1:]:
self.printstring(helpwin, line, pairname="normal")
except curses.error:
pass
helpwin.refresh()
try:
helpwin.getkey()
except curses.error:
pass
def commitmessagewindow(self, commenttext):
"Create a temporary commit message editing window on the screen."
curses.raw()
curses.def_prog_mode()
curses.endwin()
commenttext = self.ui.edit(commenttext, self.ui.username(),
name=os.path.join(self.ui.repo.controldir(),
'COMMIT_EDITMSG'))
curses.cbreak()
self.stdscr.refresh()
self.stdscr.keypad(1) # allow arrow-keys to continue to function
return commenttext
def confirmationwindow(self, windowtext):
"Display an informational window, then wait for and return a keypress."
lines = windowtext.split("\n")
confirmwin = curses.newwin(len(lines), 0, 0, 0)
try:
for line in lines:
self.printstring(confirmwin, line, pairname="selected")
except curses.error:
pass
try:
response = chr(confirmwin.getch())
except ValueError:
response = None
return response
def confirmcommit(self, review=False):
"""Ask for 'Y' to be pressed to confirm selected. Return True if
confirmed."""
if not self.opts['confirm']:
return True
if review:
confirmtext = (
"""If you answer yes to the following, the your currently chosen patch chunks
will be loaded into an editor. You may modify the patch from the editor, and
save the changes if you wish to change the patch. Otherwise, you can just
close the editor without saving to accept the current patch as-is.
NOTE: don't add/remove lines unless you also modify the range information.
Failing to follow this rule will result in the commit aborting.
Are you sure you want to review/edit and confirm the selected changes [Yn]?
""")
else:
confirmtext = _confirmmessages[self.opts['operation']]
response = self.confirmationwindow(confirmtext)
if response is None or len(response) == 0 or response == "\n":
response = "y"
if response.lower().startswith("y"):
return True
else:
return False
def recenterdisplayedarea(self):
"""
once we scrolled with pg up pg down we can be pointing outside of the
display zone. we print the patch with towin=False to compute the
location of the selected item even though it is outside of the displayed
zone and then update the scroll.
"""
self.printitem(towin=False)
self.updatescroll()
def toggleamend(self):
"""Toggle the amend flag.
When the amend flag is set, a commit will modify the most recently
committed changeset, instead of creating a new changeset. Otherwise, a
new changeset will be created (the normal commit behavior).
"""
if self.opts.get('amend') is False:
self.opts['amend'] = True
msg = ("Amend option is turned on -- committing the currently "
"selected changes will not create a new changeset, but "
"instead update the most recently committed changeset.\n\n"
"Press any key to continue.")
elif self.opts.get('amend') is True:
self.opts['amend'] = False
msg = ("Amend option is turned off -- committing the currently "
"selected changes will create a new changeset.\n\n"
"Press any key to continue.")
self.confirmationwindow(msg)
def emptypatch(self):
item = self.headerlist
if not item:
return True
for header in item:
if header.hunks:
return False
return True
def handlekeypressed(self, keypressed):
"""
Perform actions based on pressed keys.
Return true to exit the main loop.
"""
if keypressed in ["k", "KEY_UP"]:
self.uparrowevent()
elif keypressed in ["K", "KEY_PPAGE"]:
self.uparrowshiftevent()
elif keypressed in ["j", "KEY_DOWN"]:
self.downarrowevent()
elif keypressed in ["J", "KEY_NPAGE"]:
self.downarrowshiftevent()
elif keypressed in ["l", "KEY_RIGHT"]:
self.rightarrowevent()
elif keypressed in ["h", "KEY_LEFT"]:
self.leftarrowevent()
elif keypressed in ["H", "KEY_SLEFT"]:
self.leftarrowshiftevent()
elif keypressed in ["q"]:
raise util.Abort(_('user quit'))
elif keypressed in ['a']:
self.toggleamend()
elif keypressed in ["c"]:
if self.confirmcommit():
self.opts['commit'] = True
return True
elif keypressed in ["s"]:
self.opts['commit'] = False
if self.confirmcommit():
self.opts['commit'] = False
return True
elif keypressed in ["r"]:
if self.confirmcommit(review=True):
self.opts['commit'] = True
self.opts['crecord_reviewpatch'] = True
return True
elif keypressed in [' ']:
self.toggleapply()
elif keypressed in ['A']:
self.toggleall()
elif keypressed in ["f"]:
self.togglefolded()
elif keypressed in ["F"]:
self.togglefolded(foldparent=True)
elif keypressed in ["?"]:
self.helpwindow()
self.stdscr.clear()
self.stdscr.refresh()
elif len(keypressed) == 1 and curses.unctrl(keypressed) in [b"^L"]:
# scroll the current line to the top of the screen, and redraw
# everything
self.scrolllines(self.selecteditemstartline)
self.stdscr.clear()
self.stdscr.refresh()
elif keypressed in ["g", "KEY_HOME"]:
self.handlefirstlineevent()
elif keypressed in ["G", "KEY_END"]:
self.handlelastlineevent()
return False
def main(self, stdscr, opts):
"""
Method to be wrapped by curses.wrapper() for selecting chunks.
"""
self.opts = opts
origsigwinch = sentinel = object()
if util.safehasattr(signal, 'SIGWINCH'):
origsigwinch = signal.signal(signal.SIGWINCH,
self.sigwinchhandler)
try:
return self._main(stdscr)
finally:
if origsigwinch is not sentinel:
signal.signal(signal.SIGWINCH, origsigwinch)
def _main(self, stdscr):
self.stdscr = stdscr
# error during initialization, cannot be printed in the curses
# interface, it should be printed by the calling code
self.initerr = None
self.yscreensize, self.xscreensize = self.stdscr.getmaxyx()
curses.start_color()
try:
curses.use_default_colors()
except curses.error:
self.usecolor = False
# In some situations we may have some cruft left on the "alternate
# screen" from another program (or previous iterations of ourself), and
# we won't clear it if the scroll region is small enough to comfortably
# fit on the terminal.
self.stdscr.clear()
# don't display the cursor
try:
curses.curs_set(0)
except curses.error:
pass
# available colors: black, blue, cyan, green, magenta, white, yellow
# init_pair(color_id, foreground_color, background_color)
self.initcolorpair(None, None, name="normal")
self.initcolorpair(curses.COLOR_WHITE, curses.COLOR_MAGENTA,
name="selected")
self.initcolorpair(curses.COLOR_RED, None, name="deletion")
self.initcolorpair(curses.COLOR_GREEN, None, name="addition")
self.initcolorpair(curses.COLOR_WHITE, curses.COLOR_BLUE, name="legend")
# newwin([height, width,] begin_y, begin_x)
self.statuswin = curses.newwin(self.numstatuslines, 0, 0, 0)
self.statuswin.keypad(1) # interpret arrow-key, etc. ESC sequences
# figure out how much space to allocate for the chunk-pad which is
# used for displaying the patch
# stupid hack to prevent getnumlinesdisplayed from failing
self.chunkpad = curses.newpad(1, self.xscreensize)
# add 1 so to account for last line text reaching end of line
self.numpadlines = self.getnumlinesdisplayed(ignorefolding=True) + 1
try:
self.chunkpad = curses.newpad(self.numpadlines, self.xscreensize)
except curses.error:
self.initerr = _('this diff is too large to be displayed')
return
# initialize selecteditemendline (initial start-line is 0)
self.selecteditemendline = self.getnumlinesdisplayed(
self.currentselecteditem, recursechildren=False)
# option which enables/disables patch-review (in editor) step
self.opts['crecord_reviewpatch'] = False
if self.opts['author'] is not None:
# make it accessible by self.ui.username()
self.ui.setusername(self.opts['author'])
while True:
self.updatescreen()
try:
keypressed = self.statuswin.getkey()
if self.errorstr is not None:
self.errorstr = None
continue
except curses.error:
keypressed = "FOOBAR"
if self.handlekeypressed(keypressed):
break
|