File: Perl.pm

package info (click to toggle)
libio-pager-perl 2.10-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 284 kB
  • sloc: perl: 1,416; makefile: 14
file content (1522 lines) | stat: -rwxr-xr-x 41,335 bytes parent folder | download
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
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
package IO::Pager::Perl;
our $VERSION = '2.10'; #Untouched since 2.10

use strict;
use warnings;
use Term::Cap;

#Signal handling, only needs to be set once, and does not have access to object
my($SP, $RT) = $|;
local $SIG{INT} = local $SIG{QUIT} = \&close; 

#Stubs for ReadKey functions that we fill in with code refs if it's not loaded
sub ReadMode;
sub ReadKey;

sub new {
  my $class = shift;
  my %param = @_;
  $ENV{TERM} = $ENV{TERM} || '';
  $ENV{TERMCAP} = $ENV{TERMCAP} || '';

  my %dims = get_size(cols =>$param{cols} ||80,
		      rows =>$param{rows} ||25,
		      speed=>$param{speed}||38400);
  $dims{rows}--;

  #screen is vt100 compatible but does not list sf?!
  #No matter, it's only used for workaround mode.
  $ENV{TERM} = 'vt100' if( $ENV{TERM} eq 'screen' && $ENV{TERMCAP} !~ /sf/ );

  #Hack together Windows support. We could use Term::Screen(::Uni),
  #but that uses many layers of tie-ing, some of which could be inheritiance.
  #This way also reduces dependencies
  if( $^O =~ /MSWin/ ){
    eval "use Win32::Console::ANSI;";
    if( $@ ){
      warn "Could not load Win32::Console::ANSI, falling back to dumb mode - $@"; }
    else{
      $ENV{TERM} = 'WINANSI';
      #Windows lacks vb as does the fallback Term::Cap vt220 entry, add our own
      #https://www.ibiblio.org/oswg/oswg-nightly/oswg/en_US.ISO_8859-1/articles/alessandro-rubini/visual-bell/visual-bell-howto.html#VISIBLEBELL
      $ENV{TERMCAP} = do{ undef $/; $_=<DATA>; y/\n//d; $_ };
    }
  }
  else{
    #Try to enable mouse support
    print "\e[?1000;1006;1015h";
  }
  #Speed is mostly useless except Term::Cap demands it
  my $t = Term::Cap->Tgetent({ OSPEED => $param{speed} });
  my $dumb = eval{ $t->Trequire(qw/cm ce cl sf sr/) } ? 1 : 0;

  #CORE:  cm=>cup,  ce=>el,   cl=>clear, sf=>ind,  sr=>ri
  #EXTRA: md=>bold, me=>sgr0, mr=>rev,   us=>smul, vb=>flash
  my %primitives = (# if the entries don't exist, nothing bad will happen
		    BLD   => $t->Tputs('md'), # Bold
		    ULN   => $t->Tputs('us'), # Underscore
		    REV   => $t->Tputs('mr'), # Reverse
		    NOR   => $t->Tputs('me'), # Normal
		   );
  my $text;
  if( defined( $param{text} ) ){
    my $ref = ref( $param{text} );
    if( $ref eq 'ARRAY' ){
      die "Invalid text, must be string, code ref, or [string, code ref]"
	unless (scalar( @{$param{text}} ) ==2) and
	  ref( $param{text}->[0] ) eq '' and
	  ref( $param{text}->[1] ) eq 'CODE';

      $text = $param{text}->[0];
      $param{text} = $param{text}->[1]      
    }
    elsif( $ref eq '' ){
      $text = delete( $param{text} );
    }
  }

  $param{visualBell} = delete($param{visualBeep}) if
      defined($param{visualBeep}) and not defined($param{visualBell});

  my $me = bless {
		  # default values
		  _cursor => 0,		_end => 0,	   _left => 0,
		  _term  => $t,		_dumb => $dumb,    _txtN => 0,
		  _search => '',	_statCols => 0,    _lineNo=>[0],
		  lineNo => 0,		pause => '',	   #pause=>"\cL" #more
		  raw => 0,		statusCol => 0,	   squeeze=>0,
		  visualBell => 0,	fold => 0,         _fileN => 1,
		  _mark => {1=>0},      scrollBar => 0,
		  %dims,

		  # if the termcap entries don't exist, nothing bad will happen
		  %primitives,
		  #UI Composites
		  MENU    => $primitives{BLD}.$primitives{REV},	# popup menus
		  HILT    => $primitives{BLD}.$primitives{ULN},	# search entry
		  SRCH    => $primitives{BLD}.$primitives{ULN},	# search entry

		  # user supplied values override
		  %param,
		 }, $class;

  $me->add_text($text) if defined $text;

  $me->{_I18N}={
		prompt=>	'',
		404=>		'Not Found',
		top=>		'Top',
		bottom=>	'Bottom',
		minihelp=>	"<h>=help \000<space>=down <b>=back <q>=quit",
		continue=>	'press any key to continue',
		searchwrap=>    'No more matches, next search will wrap',
		nowrap=>        'Text::Wrap unavailable, disabling folding',
		help=>		<<EOH
 q           quit             \000 h       help
 r C-l       refresh          \000 R       flush buffers
 /           search           \000 ?       search backwards
 n P         next match       \000 p N     previous match
 space C-v   page down        \000 b M-v   page up
 enter down  line down        \000 y up    line up
 d           half page down   \000 u       half page up
 g <         goto top         \000 G >     goto bottom
   left      scroll left 1 tab\000   right scroll right 1 tab
 S-left      scroll left 1/2  \000 S-right scroll right 1/2
 m           mark position    \000 '       return to mark
 #           line numbering   \000 \\d+\\n   jump to line \\d+
:n           next file        \000 :p      previous file
 C           toogle raw       \000 S       toggle folding
EOH
	       };

  our %config;
  add_keys(\&help,      'h', 'H');
  add_keys(\&close,     'q', 'Q', ':q', ':Q');
  add_keys(\&refresh,   'r', "\cL", "\cR");
  add_keys(\&next_match,'n', 'P');
  add_keys(\&prev_match,'p', 'N');
  add_keys(\&to_bott,   '>', 'G', '$', "\e>", "\e[F", "\e0E", "\e0W", "\e[4~");
                                     #M->      ?     End     End     End
  add_keys(\&downpage,  ' ', 'z', "\cV", , 'f', "\cF", "\e ", "\e[6~"); #M-  PgDn
  add_keys(\&downpage,  "\eOs") if $ENV{TERM} eq 'WINANSI';
  add_keys(\&downhalf,  'd', "\cD");
  add_keys(\&downline,  'e', 'j', 'J', "\cE", "\cN", "\e[B"); #down
  add_keys(\&downline_raw, "\n", "\r");
  add_keys(\&upline,    'y', 'k', "\cY", "\cK", 'K', 'Y', "\cP", "\e[A"); #up
  add_keys(\&uphalf,    'u', "\cU");
  add_keys(\&uppage,    'w', 'b', "\cB", "\ev", "\e[5~"); #M-v PgUp
  add_keys(\&uppage,  "\eOy") if $ENV{TERM} eq 'WINANSI';
  add_keys(\&to_top,    '<', 'g',      "\e<", "\e[H", "\e0",          "\e[1~");
                                        #M-<    Home    Home            Home
  add_keys(\&next_file, ':n', "\e[1;4C");
  add_keys(\&prev_file, ':p', "\e[1;4D");
  add_keys(\&save_mark, 'm', "\e[2~"); #Ins
  add_keys(\&shift_left, "\e\[1;2D", "\e("); #S-left  S-M-9
  #Cannot have M-[ for left, \e[ conflicts with other codes
  add_keys(\&shift_right,"\e\[1;2C", "\e)"); #S-right S-M-0

  #          Home  PgUp  PgDn  End   Ins
  # terminfo khome kpp   knp   kend  kich1
  # eterm          \E0y  \E0q  \E0s
  # rxvt     \E[7~ \E[5~ \E[6~ \E[8~ \e[2~ #
  # xterm    \EOH  \E[5~ \E6~  \EOF  \e[2~ #
  #nxterm    \e[\C-@           \e[e
  #"\e\[1;3C"=> #M-left
  #"\e\[1;3D"=> #M-right

  $me->add_func(%config,
		"\e[<" => \&mouse,
		'/(\d+)/' => 1,         #jump to line
		"\e[D" => \&tab_left,   #left
		"\e[C" => \&tab_right,  #right, 
		'&' => \&grep,
		'/' => \&search,
		'?' => \&hcraes,
		"'" => \&goto_mark,
		'#' => \&toggle_num,    #XXX Change toggle* to '-' initiated
		'C' => \&toggle_raw,    #input mode like : to mimic less?
		'S' => \&toggle_fold,
		'R' => \&flush_buffer,
		':w'=> \&write_buffer,
		':e'=> \&open_file,
	       );
  
  #Mise-en-place; prepare to cook some characters
  #\000-\010\013-\037/@A-HK-Z[\\]^_/
  $me->{_raw}->{chr($_)} = chr(64+$_) foreach (0..8, 11..31);

  $me->{_end} = $me->{rows} - 1;

  $SIG{WINCH} = sub{ $me->resize() } unless $ENV{TERM} eq 'WINANSI';
  $me->{cols}-- if $me->{scrollBar};

  #Can we fold?
  eval "use Text::Wrap";
  if( $@ ){
    sub wrap{ join '', @_ }
    $me->{fold} = 0;
  }

  $me;
}

sub resize {
  my $me = shift;
  my %dims = get_size();
  $dims{rows}--;
  $dims{cols}-- if $me->{scrollBar};
  $me->{$_} = $dims{$_} foreach keys %dims;

  $me->{_end} = $me->{rows} - 1;

  if( $me->{fold} ){
    $me->reflow();
    #XXX Crude attempt to mintain position,
    #XXX only works if all rows folded same amount
    #$me->jump( int($me->{_cursor} * $me->{cols) / $dims{cols})-1 );
    #XXX need to somehow use _lineNo instead?
  }
  else{
    $me->refresh();
  }
  $me->status();

  $me->{WINCH}->() if ref($me->{WINCH}) eq 'CODE';
}

sub get_size {
  my %dims = @_;

  if( defined($Term::ReadKey::VERSION) ){
    Term::ReadKey->import();
    local $SIG{__WARN__} = sub{};
    my @Tsize = Term::ReadKey::GetTerminalSize(*STDOUT);
    @dims{'rows','cols'} = @Tsize[1,0];
    $dims{speed} ||= (Term::ReadKey::GetSpeed())[1];
  }
  else{
    *ReadMode = sub{
      if( $_[0] == 3 ){
	system('stty -icanon -echo min 1'); }
      elsif( $_[0] == 0 ){
	system('stty icanon echo'); }
    };
    *ReadKey = sub{ getc() };

    #Can we get better defaults?
    if( $ENV{TERM} eq 'WINANSI' ){
	eval{ @dims{'rows','cols'} = Win32::Console::ANSI::Cursor() };
    }
    elsif( `stty` =~ /speed/ ){
	@dims{'rows','cols'} = ($1-1,$2-1) if `stty size` =~ /^(\d+)\s+(\d+)$/;
	$dims{speed} = $1 if `stty speed` =~ /^(\d+)$/;
    }
    else{
	$dims{rows} = `tput lines`  || $dims{rows};
	$dims{cols} = `tput cols`   || $dims{cols};
    }
  }
  return %dims;
}


sub add_text {
  return unless defined($_[1]);
  my $me = shift;

  #Stringify
  local $_ = join('', @_);

  #Terminated?
  my $LF = do{ chomp(local $_=$_) };

  #Squeeze #XXX handle with logical lines display?
  s/\n{2,}/\n\n/g if $me->{squeeze};

  #Split on new lines, preserving internal blanks
  my @F = split(/\n/, $_, -1);

  if( $me->{fold} ){
    #Two expressions to avoid lame single-use warning
    local $Text::Wrap::columns;
    $Text::Wrap::columns = $me->{cols} -
      ( $me->{_statCols} = ($me->{lineNo} ? 9 : $me->{statusCol} ? 1 : 0) );

    my $lines = scalar(@F);
    my $extraSum=0;
    for( my $i=0; $i<$lines; $i++ ){
      $me->{_lineNo}->[$i+$me->{_txtN}] = $me->{_txtN}+$i+1-$extraSum;

      #Automark multi-file
      $me->{_mark}->{$1} = $i+$me->{_txtN} if
	defined($F[$i]) && $F[$i] =~ m%\cF\c]\cL\cE \[(\d+)/%;

      if( defined($F[$i]) && length($F[$i]) > $me->{cols} ){
	my @G = split/\n/, wrap('', '', $F[$i]);
	my $extras = scalar(@G);
	splice(@F, $i, 1, @G);
	#Repeat real line number for logical folded lines
	$me->{_lineNo}->[$i+$me->{_txtN}+$_] =
	  $me->{_txtN}+$i+1-$extraSum foreach 1..$extras-1;

	$i += $extras-1;
	$lines += $extras;
	$extraSum += $extras-1;
      }
    }
  }
  #Remove the extra record from the trailing new line
  pop @F if $LF;

  #Handle partial lines in case sysread is used further up the stack
  push(@F, undef) unless $LF;
  if( $me->{_txtN} && !defined($me->{_text}->[-1]) ){
    pop @{$me->{_text}};
    $me->{_text}->[-1] .= shift @F;
  }

  #Store text, and refresh screen if content would fit in window
  my $shown = $me->{_txtN};
  push @{$me->{_text}}, @F;
  $me->{_txtN} = @{ $me->{_text} }; #-1;

  $me->refresh(); #XXX if $shown <= $me->{rows}; # + $me->{_cursor};
}

sub reflow {
  my $me = shift;
  my($prevLine, @text) = 0;
  while( scalar @{$me->{_text}} ){
    my $curLine = shift @{$me->{_lineNo}};
    if( $curLine == $prevLine ){
      $text[-1] .= ' ' . (shift @{$me->{_text}}||''); }
    else{
      push @text, shift @{$me->{_text}}; }
    $prevLine = $curLine;
  }
  $me->{_lineNo}=[];
  $me->{_txtN}=0;
  $me->add_text( join($/, @text) );
}

#Capture errant method calls
sub AUTOLOAD{
  eval "use Carp";
  my $me = shift;
  our $AUTOLOAD =~ s/.*:://;
  return if $AUTOLOAD eq 'DESTROY';

  local $Text::Wrap::columns=int(.75*$me->{cols});
  my $msg = wrap('', '', "$AUTOLOAD\n\n". Carp::longmess());
  $me->beep();
  $me->dialog("Unknown method $msg", 1);
}

#$input is pulled outside the subroutine to allow for Esc+x entry of M-x
#after the deferring to host loop instead of using a TIGHT input loop
my $input;
sub more {
  my $me = shift;
  my %param = @_;
  $RT = $me->{RT} = $param{RT};
  
  ReadMode 3; #cbreak
  $| = 1;

  if( $me->{_dumb} ){
    $me->dumb_mode();
  }
  else{
    print $me->{NOR};


    #INPUT LOOP, revised with inspiration from Term::Screen::getch()
    #my $input=''; #TIGHT
    while( 1 ){
      $me->status();					# status line
      my $exit = undef;

      my $char = ReadKey($param{RT});
      #Defer to host loop, obviating need for callbacks to implement tail
      #functionality and for cleaner startup (no preload on piped input)
      #next unless defined($char); #TIGHT
      return 1 unless defined($char);
      $me->{_I18N}{prompt} = $input .= $char;
      $me->status();
     
      unless( ($input=~ /^\e/ and index($me->{_fncRE}, $input)>0 )
	      || $input =~ /^\d+/
	      || $input =~ /:+/
	      || defined($me->{_fnc}->{$input}) ){
	$me->beep($input);
	$input ='';
	next;
      }

      if( $me->{_fnc}->{$input} ){
	#Get mapped sub name
#	use B 'svref_2object';
#	my $n = $me->{_fnc}->{$input};
#	$n = svref_2object($n)->GV->NAME;

	$exit = $me->{_fnc}->{$input}->($me);
	$me->{_I18N}{prompt} = $input = '';
      }
      #vi-style input
      elsif( $input =~ /^:/ ){
	if( ($char eq "\cG") or ($input eq '::') ){
	  $me->{_I18N}{prompt} = $input = '';
	  $me->status();
	  return 1; }
      }
      #Line-number input; would love to use getln, but does not mix w/ status
      elsif( $me->{_fnc}->{'/(\d+)/'} and $input =~ /^\d+/ ){
	if( $char eq "\cH" or ord($char)==127 ){
	  $input = substr($input, 0, -2, ''); }
	elsif( $char eq "\cG" ){
	  $input = '';
	  $exit = 1; }
	elsif( $char eq "\n" || $char eq "\r" ){
	  #Remove extraneous characters that could cause infinite error loop
	  #XXX this prevents goofy RPN-like repeated commands
	  $input =~ y/0-9//cd;#	  chomp($input);
	  $exit = $input < $me->{_txtN} ? $me->jump($input) : $me->to_bott();
	  $input = ''; }

	$me->{_I18N}{prompt} = $input;
	$me->status();
      }

      return 1 if $param{RT} && defined($exit);
    }
  }
  $me->close();
}
*less = \&more; *page = \&more;
#Avoid lame single-use warning
my $foo = \&less; $foo = \&page;


#ACCESSORS
sub I18N {
  my($me, $msg, $text) = @_;
  $me->{_I18N}{$msg} = $text if defined($text);
  $me->{_I18N}{$msg};
}

BEGIN{
  #Install generic accessors
  no strict 'refs';
  foreach my $method ( qw(eof lineNo pause raw statusCol visualBell) ){
    *{$method} = sub{ $_[0]->{$method}=$_[1] if defined($_[1]);
		      $_[0]->{$method} }
  }
  foreach my $method ( qw(rows cols speed fold squeeze) ){
    *{$method} = sub{ $_[0]->{$method}}
  }
}

#HELPERS
sub add_keys{
  our %config;
  my $sub = shift;
 $config{$_} = $sub foreach @_;
}

sub add_func{
  my $me = shift;
  my %param = @_;
  while( my($k, $v) = each %param ){
    $me->{_fnc}{$k} = $v;
  }
  #XXX RegExp::Trie, List::RegExp? #quotemeta?
  $me->{_fncRE} = join '|', sort keys %{ $me->{_fnc} };
  #$me->{_fncRE} = qr/^($me->{_fncRE})$/;
}

sub beep{
  print "\a";
  print $_[0]->{_term}->Tputs('vb') if $_[0]->{visualBell};

  if( defined($_[1]) ){
    $_[1] =~ s/\e/^[/;
    $_[1] =~ s/([^[:print:]])/sprintf("\\%03o", ord($1))/ge; #Cook
    $_[0]->dialog("Unrecognized command: $_[1]", 1);

    $_[0]->{_I18N}{prompt} = '';
    $_[0]->status();
  }
}

sub getln{
  my $input;
  while(1){
    my $l = ReadKey();
    last if $l eq "\n" || $l eq "\r";

    if( !defined($l)| $l eq "\e" || $l eq "\cG" ){
      $input = '';
      last; }
    elsif( $l eq "\b" || $l eq "\177" ){
      print "\b \b" if $input ne '';
      substr($input, -1, 1, '');
      next;
    }

    print $l;
    $input .= $l;
  }
  return $input;
}


# display a minihelp, etc
sub status{
  my $me = shift;
  $me->{_txtN} ||= 0;

  my $end= $me->{_cursor} + $me->{rows};

  my $pct = $me->{_txtN} > $end ? $end/($me->{_txtN}) : 1;
  #XXX unify with scrollbar: consistency and as private property
  my $pos = $me->{_cursor} ?
    ($pct==1 ? $me->{_I18N}{bottom} : 'L'.$me->{_cursor}) :
	       $me->{_I18N}{top};
  $pos .= 'C'.$me->{_left} if $me->{_left};
  my $p = sprintf "[tp] %d%% %s %s", 100*$pct, $pos, $me->{_I18N}{prompt};

  print $me->{_term}->Tgoto('cm', 0, $me->{rows});	# bottom left
  print $me->{_term}->Tputs('ce');			# clear line
  my $minihelp = $me->{_I18N}{minihelp};
  (my $pSansCodes = $p) =~ s/\e\[[\d;]*[a-zA-Z]//g;
  my $pN = $me->{cols} -1 -length($pSansCodes) -length($me->{_I18N}{minihelp});
  $p .= ' ' x ($pN > 1 ? $pN : 1);
  $minihelp = $pN>2 ? $minihelp : do {$minihelp =~ s/\000.+//; $minihelp };
  print $me->{REV};					# reverse video
  print $p,"  ", $minihelp;  				# status line
  print $me->{NOR};					# normal video
}

sub close{
  ReadMode 0;
  print "\n\e[?1000l";
  $| = $SP || 0;
  #Did we exit via signal or user?
  $RT ? die : return \"foo";
}

{
  no warnings 'once';
  *done = \&close;
}


# provide help to user
sub help{
  my $me = shift;
  my $help = $me->{_I18N}{help};
  my $cont = $me->{_I18N}{continue};

  if( $me->max_width( split/\n/, $help ) > $me->{cols} ){
    #Split help in half horizontally for narrow dispays
    my $help2 = $help;
    $help2 =~ s/\000.*//mg;
    $help  =~ s/.*\000//mg;
    my $padding = $me->max_width($cont) / 2;  
    $me->dialog( $help2 . "\n" . (' 'x$padding) . $cont );
  }
  else{
    $help =~ y/\000//d;
  }
  my $padding = $me->max_width($cont) / 2;  
  $me->dialog( $help . "\n" . (' 'x$padding) . $cont );
}

sub max_width{
  my $me = shift;
  my $width = 0;
  foreach (@_){ $width = length($_) if length($_) > $width };
  return $width;
}

sub dialog{
  my($me, $msg, $timeout) = @_;
  my @txt = defined($msg) ? split(/\n/, $msg) : ();
  my $w = $me->max_width(@txt);

  #Prepare dialog
  my $h = '+' . '='x($w+2) . '+';
  my $d = join('', map { sprintf("%s| %- @{[$w+4]}s |\n",
				 $me->{_term}->Tgoto('RI',0,4),
				 $_) } $h, @txt, $h); 

  print $me->{_term}->Tgoto('cm',0, 2),	# move
        $me->{MENU},		        # set color
        $d,				# dialog
        $me->{NOR};			# normal color

  defined($timeout) ? sleep($timeout) : getc();

  #Allow wipe of incomplete/paused output.
  local($me->{pause});

  #XXX Use full refresh if _grep for simple accurate solution?
  # Fractional restoration instead of full refresh
  foreach my $n (2 .. scalar(@txt)+3){
    print $me->{_term}->Tgoto('cm', 0, $n);		# move
    print $me->{_term}->Tputs('ce');			# clear line
    $me->line($n);
  }
}

sub flush_buffer{
  my $me = shift;
  $me->{_text} = [];
  $me->{_txtN} = 0;
  $me->{_lineNo}=[];
  $me->refresh();
}

# refresh screen
sub refresh{
  my $me = shift;

  print $me->{_term}->Tputs('cl');			# home, clear
  for my $n (0 .. $me->{rows} -1){
    print $me->{_term}->Tgoto('cm', 0, $n);		# move
    print $me->{_term}->Tputs('ce');			# clear line

    #Skip cursor ahead to matching line if in grep mode
    if( $me->{_grep} && defined($me->{_text}->[$me->{_cursor}+$n]) ){
      until( $me->{_text}->[$me->{_cursor}+$n] =~
	     m%$me->{_search}|\cF\c]\cL\cE \[\d+/% ){
        $me->{_cursor}++;
        last if $me->{_cursor}+$me->{rows}+$n >= $me->{_txtN};
      }
    }

    $me->line($n+$me->{_cursor}) if			# XXX w/o cursor messy
      $me->{_cursor}+$me->{rows}+$n <= $me->{_txtN}     # after menu & refresh
  }
  $me->scrollBar() if $me->{scrollBar};
}

sub scrollBar{
  my $me = shift;
  $me->{_pages}  = $me->{_txtN}/$me->{rows};
  $me->{_thumbW} = $me->{rows}/$me->{_pages};
  $me->{_thumbT} = sprintf("%i", ($me->{_cursor} / $me->{_pages}) )+($me->{_cursor}>$me->{_txtN}/2);
  $me->{_thumbB} =   sprintf("%i",  $me->{_thumbT}+$me->{_thumbW});

#$me->dialog("cursor $me->{_cursor} top $me->{_thumbT} + width $me->{_thumbW}");

  for my $n (0 .. $me->{rows} -1){
    print $me->{_term}->Tgoto('cm', $me->{cols}+1, $n);
    print $n>=$me->{_thumbT} && $n<$me->{_thumbB} ? ' ' : "$me->{REV} $me->{NOR}";
  }
}

sub mouse{
  my $me = shift;
  my $input ='';
  $input .= ReadKey(0) until $input =~ /M$/i;

  my @args = split /;/, $input;

  if( $args[0] == 65 ){
    $me->downhalf(); }
  elsif( $args[0] == 64 ){
    $me->uphalf(); }
  elsif( $me->{scrollBar} && $args[1] == $me->{cols}+1 ){
    if( chop $args[2] eq 'm'){ #mouse-up
      if( $me->{_thumbDrag} ){
	$me->{_thumbDrag} = 0;
	my $pos;
	if( $args[2]==1 ){
	    $pos=0 }
	elsif( $args[2]==$me->{rows} ){
	    $pos= $me->{_txtN} - 2*$me->{rows}-1 }
	else{
	    $pos = sprintf("%i", $args[2] / $me->{rows} * $me->{_txtN}) }
	$me->jump($pos);
      }
      $me->uppage() if $args[2] < $me->{_thumbT};
      $me->downpage() if $args[2] > $me->{_thumbB};
    }
    elsif( $args[2]>=$me->{_thumbT} &&
	   $args[2]<=$me->{_thumbB} ){ #automagically M (mouse-down)
      $me->{_thumbDrag}=1;
    }
  }
}


sub line{
  my $me = shift;
  my $n  = shift;
  local $_ = $me->{_text}[$n]||'';
#  my $prev = $me->{_text}[$n-1]||'';

  #!! ORDER OF OPERATIONS ON OUTPUT PROCESSING AND DECORATION MATTERS

#  #Squeeze... this identifies lines, but just gives a blank line, still
#              code elsewhere iterates over rows and advances down screen...
#              we need to intervene in each of those instances and:
#              not progress another line of display then add another iteration
#  return if $me->{squeeze} && $_ eq '' && $prev eq '';

  $me->{_curFile} = $1 if m%\cF\c]\cL\cE \[(\d+)/%;

  #Breaks?
  my $pausey = 1 if length($me->{pause}) && defined && /$me->{pause}/;

  #Crop if no folding
  my $len = length();
  unless( $me->{fold} ){
    $_ = ($len-$me->{_statCols}) < $me->{_left} ? '' :
      substr($_, $me->{_left}, $me->{cols}-$me->{_statCols});
    if( $len - $me->{_left} > $me->{cols} ){
      substr($_, -1, 1, "\$");
    }
  }

  #Cook control characters
  unless( $me->{raw} ){
    s/([\000-\010\013-\037])/$me->{REV}^$me->{_raw}->{$1}$me->{NOR}/g;
  }

  #Search
  my $matched = (s/($me->{_search})/$me->{SRCH}$1$me->{NOR}/g) if
    $me->{_search} ne '';

  #Line numbering & search status
  my $info = $me->{statusCol} && !$me->{lineNo} ? ($matched ? '*' : ' ') : ''; 
  $info = sprintf("% 8s", 
		  $me->{fold} ? ($me->{_lineNo}->[$n]||-1) : 
				(defined($me->{_text}[$n]) ? $n+1 : '')
		 ) if $me->{lineNo};
  $_ = ($me->{Statuscol} && $matched ? $me->{REV} : ''). $info.
       ($me->{statusCol} && $matched ? $me->{NOR} : '').
       ($me->{lineNo} ? ' ' : ''). $_;
  print;

  if( $pausey ){
    $me->{_end} = $n;					#Advance past pause
    no warnings 'exiting'; last;
  }
}

sub down_lines{
  my $me = shift;
  my $n  = shift;
  my $t  = $me->{_term};

  LINE: for(1..$n){
    if( $me->{_end} >= $me->{_txtN}-1 ){
      $me->close() if $me->{eof} && ref($me->{text}) ne 'CODE';
      if( ref($me->{text}) eq 'CODE' ){
	$me->add_text( $me->{text}->() ); }
      else{
	&beep; last; }
    }
    #Two blocks instead of an else to allow input callback
    if( $me->{_end} < $me->{_txtN}-1 ){
      if( length($me->{pause}) && $me->{_end} < $me->{rows}-1 ){
	print $t->Tgoto('cm',  0, $me->{_end}+1 ); }	# move
      else{
	# why? because some terminals have bugs...
	print $t->Tgoto('cm', 0, $me->{rows} );		# move
	print $t->Tputs('sf');				# scroll
	print $t->Tgoto('cm', 0, $me->{rows} - 1);	# move
      }
      print $t->Tputs('ce');				# clear line

      #Skip cursor ahead to matching line if in grep mode
      if( $me->{_grep} && $me->{_end} < $me->{_txtN} ){
	until( $me->{_text}->[$me->{_end}] =~
	       m%$me->{_search}|\cF\c]\cL\cE \[\d+/% ){
	  $me->dialog(#"$me->{_end} >= $me->{_txtN} #$me->{_cursor}\n".
		      'Pagination in grep mode does not work at this time.', 1);
	  last LINE;
#	  $me->{_end}++;
	  $me->{_cursor}++;
	  if( $me->{_end} >= $me->{_txtN} ){
	    $me->{cursor} = $me->{_end} = $me->{_txtN};
	    last;
	  }
	}
      }
      $me->line( ++$me->{_end} ) if $me->{_end} <= $me->{_txtN};
      $me->{_cursor}++;
    }
  }
  $me->refresh() if $ENV{TERM} eq 'WINANSI'; #XXX Windows scroll is lame
  $me->scrollBar() if $me->{scrollBar};
}
sub downhalf {  $_[0]->down_lines( $_[0]->{rows} / 2 ); }
sub downpage {  $_[0]->down_lines( $_[0]->{rows} );
		#WTF?! add_text in tp's while-loop cannot be reached if there's
		#no delay here until something other than downpage is called?!
		select(undef, undef, undef, .1); #XXX WTF?!
}
sub downline {  $_[0]->down_lines( 1 ); }
#Term::ReadKey doesn't offer sufficiently fine control; we want CS8 but -OCRNL
sub downline_raw { $_[0]->down_lines( 1 ); $_[0]->refresh(); }

sub up_lines{
  my $me = shift;
  my $n  = shift;

  for (1 .. $n){
    if( $me->{_cursor} <= 0 ){
      &beep; last; }
    else{
      print $me->{_term}->Tgoto('cm',0,0);	# move
      print $me->{_term}->Tputs('sr');		# scroll back

      #XXX Skip cursor back to matching line if in grep mode
      #Skip cursor back to matching line if in grep mode
#      if( $me->{_grep} && $me->{_cursor} > 0 ){
#	until( $me->{_text}->[$me->{_end}] =~
#	       m%$me->{_search}|\cF\c]\cL\cE \[\d+/% ){
#	  $me->{_cursor}--;
#	  if( $me->{_cursor} <= 0 ){
#	    $me->{cursor} = 0;
#	    last;
#	  }
#	}
#      }

      $me->line( --$me->{_cursor} );
      $me->{_end}--;
    }
  }

  $me->refresh() if $ENV{TERM} eq 'WINANSI'; #XXX Windows scroll is lame
  print $me->{_term}->Tgoto('cm',0,$me->{rows});		# goto bottom
  $me->scrollBar() if $me->{scrollBar};
}
sub uppage {  $_[0]->up_lines( $_[0]->{rows} ); }
sub upline {  $_[0]->up_lines( 1 ); }
sub uphalf {  $_[0]->up_lines( $_[0]->{rows} / 2 ); }

sub to_top {  $_[0]->jump(0); }

sub to_bott{
  my $me = shift;
  if( $me->{rows}>$me->{_txtN} ){
    $me->jump( 0 ) }
  else{
    $me->jump( $me->{_txtN}-1 );
    $me->uppage() }
}

sub save_mark{
  my $me = shift;

  $me->I18N('status', $me->{BLD}.'*Mark name?*'.$me->{NOR}.$me->{REV});
  $me->status();
  $me->{_term}->Tgoto('cm',
		      #XXX I18N
		      length('[tp] 100% Bottom Mark name?')+1,
		      $me->{rows});
  my $mark = ReadKey();
  return if $mark eq "\cG";
  next if $mark eq "'";
  $me->{_mark}->{$mark} = $me->{_cursor};
  $me->I18N('status', '');
  $me->status();
}

sub goto_mark{
  my $me = shift;

  my $mark = ReadKey();
  return if $mark eq "\cG" or not exists($me->{_mark}->{$mark});

  my $jump = $me->{_mark}->{$mark};
  if( $mark eq '^' ){
    $jump = 0;
  }
  elsif( $mark eq '$' ){
    $jump = $me->{_txtN} - $me->{rows};
  }
  elsif( $mark eq '"' ){
    my $marks = join("\n", map {"$_ = $me->{_mark}->{$_}"}
		     sort keys %{ $me->{_mark} } );
    $me->dialog($marks);
    return;
  }
  $me->{_mark}->{"'"} = $me->{_cursor};
  $me->jump( $jump );
}

sub prev_file{ $_[0]->next_file('anti') }
sub next_file{
  my $me = shift;
  my $mode = shift || '';
  my $mark = $me->{_curFile} + ( $mode eq 'anti' ? -1 : 1 );
  if( exists($me->{_mark}->{$mark}) ){
    $me->{_mark}->{"'"} = $me->{_cursor};
    $me->jump( $me->{_mark}->{$mark} ); }
  else{
    $me->beep()
  }
}

sub jump{
  my $me = shift;
  $me->{_cursor} = shift;
  $me->{_end}   = $me->{_cursor} + $me->{rows}; # - 1;
  $me->refresh();
}

sub tab_right{
  my $me = shift;
  $me->{_left} += 8;
  $me->refresh();
}

sub tab_left{
  my $me = shift;
  $me->{_left} = 0 if ($me->{_left} -= 8) < 0;
  $me->refresh();
}

sub shift_right{
  my $me = shift;
  $me->{_left} += int($me->{cols}/2);
  $me->refresh();
}

sub shift_left{
  my $me = shift;
  $me->{_left} = 0 if ( $me->{_left} -= int($me->{cols}/2) ) < 0;
  $me->refresh();
}


sub grep{  $_[0]->search(-1); }
sub hcraes{  $_[0]->search(1); }
sub search{
  my $me = shift;
  my $mode = shift || 0;
  $me->{_hcraes} = $mode == 1;
  $me->{_grep} =   $mode == -1;
  $me->{_searchWrap} = 0 unless $me->{_grep};

  # get pattern
  (my($prev), $me->{_search}) = ($me->{_search}, '');

  print $me->{_term}->Tgoto('cm', 0, $me->{rows});	# move bottom
  print $me->{_term}->Tputs('ce');			# clear line
  print $me->{HILT};					# set color
  print $mode ? ( $mode > 0 ? '?' : '&' ) : '/';

  $me->{_search} = $me->getln() || '';
  print $me->{NOR};					# normal color
  print $me->{_term}->Tgoto('cm', 0, $me->{rows});	# move bottom
  print $me->{_term}->Tputs('ce');			# clear line
  if( $me->{_search} eq '' ){
    $me->refresh();
    return;
  }

  $me->{_search} = '(?i)'.$me->{_search} unless
    $me->{_search} ne lc($me->{_search});

  $me->{_search} = $prev if $me->{_search} eq '/' && $prev;

  #Jump to first match
  for my $n ( $me->{_cursor} .. $me->{_txtN} -1){	#XXX why offset needed?
    next unless $me->{_text}[$n] =~ /$me->{_search}/i;
 
    $me->{_cursor} = $n;
    $me->{_cursor} = 0 if $me->{_txtN} < $me->{rows}; # - 1;
    $me->{_end}    = $me->{_cursor} + $me->{rows}; # - 1;

    #Special jump if match is on last screen
    if( $me->{_cursor} + $me->{rows} > $me->{_txtN} - 1 && $me->{_cursor} ){
      my $x = $me->{_cursor} + $me->{rows} - $me->{_txtN};
      $x = $me->{_cursor} if $x > $me->{_cursor};
      $me->{_cursor} -= $x;
      $me->{_end}   -= $x;
    }

    $me->refresh();
    return;
  }

  # not found
  &beep;
  $me->dialog($me->{_I18N}{404}, 1);
  return;
}

sub prev_match{  $_[0]->next_match('anti'); }
sub next_match{
  my $me = shift;
  return unless defined($me->{_txtN}) and defined($me->{_search});

  my $mode=shift;
  if( defined($mode) and $mode ='anti' ){
    $mode = not $me->{_hcraes}; }
  else{
    $mode = $me->{_hcraes};
  }

  if( $me->{_searchWrap} ){
    $me->{_searchWrap} = 0;
    $me->jump( $mode ? $me->{_txtN} : 0 );
  }


  my $i = $mode ? ($me->{_cursor}||0)-1 : ($me->{_cursor})+1;
  my $matched=0;
  for( ;
       $mode ? $i>0 : $i< $me->{_txtN};
       $mode ? $i-- : $i++ ){
    $matched = $me->{_text}[$i] =~ /$me->{_search}/;
    last if $matched;
  }
  if( ($i == ($mode ? 0 : $me->{_txtN} )) && ($me->{_searchWrap} == 0) ){
    $me->dialog($me->I18N('searchwrap'), 1);
    $me->{_searchWrap} = 1;
    return;
  }
  $matched ? $me->jump($i) : &beep;
}

sub toggle_num{
  my $me = shift;
  $me->{lineNo} = not $me->{lineNo};
#  $me->reflow();
  $me->refresh();
}

sub toggle_raw{
  my $me = shift;
  $me->{raw} = not $me->{raw};
  $me->reflow();
}

sub toggle_fold{
  my $me = shift;
  $me->{fold} = not $me->{fold};
  $me->{_lineNo} = [1 .. $me->{_txtN}] if $me->{fold};
  $me->reflow();
}


sub write_buffer{
  my $me = shift;

  print $me->{_term}->Tgoto('cm', 0, $me->{rows});	# move bottom
  print $me->{_term}->Tputs('ce');			# clear line
  print "Save to: ";

  my $out = $me->{_search} = $me->getln();
  if( ! -e $out && open(OUT, '>', $out) ){
    print OUT join($/, @{$me->{_text}});
    CORE::close(OUT);
  }
  else{
    $me->dialog("ERROR: " . -e $out ? "File exists" : $!)
  }
}

sub open_file{
  my $me = shift;

  print $me->{_term}->Tgoto('cm', 0, $me->{rows});	# move bottom
  print $me->{_term}->Tputs('ce');			# clear line
  print "Examine: ";

  my $file = $me->getln();
  unless( -e $file ){
    $me->dialog( sprintf("%s: $file", $me->{_I18N}{404}) );
    return;
  }
  unless( open(IN, '<', $file) ){
    $me->dialog($!);
    return;
  }
  my $N = $me->get_fileN();
  $me->set_fileN($N+1);
  $me->add_text(sprintf("======== \cF\c]\cL\cE [%i/..] %s ========\n",
			$N, $file), <IN>);
}

sub get_fileN{ $_[0]->{_fileN} }
sub set_fileN{ $_[0]->{_fileN} = $_[1] }


sub dumb_mode{
  my $me = shift;
  my $end = 0;

  while(1){
    for my $i (1 .. $me->{rows} ){
      last if $end >= $me->{_txtN};
      print $me->{_text}[$end++], "\n";
    }
 
    print "--more [dumb]-- <q> quit";
    my $a = getc();
    print "\b \b"x15;

    return if $a eq 'q';
    return if $end >= $me->{_txtN};
  }
}

1;
__DATA__
WINANSI|vt220|Win32 Console based on DEC VT220 in vt100 emulation mode:
am:mi:xn:xo:
co#80:li#24:
RA=\E[?7l:SA=\E[?7h:
ac=kkllmmjjnnwwqquuttvvxx:ae=\E(B:al=\E[L:as=\E(0:
bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:
cr=^M:cs=\E[%i%d;%dr:dc=\E[P:dl=\E[M:do=\E[B:
ei=\E[4l:ho=\E[H:im=\E[4h:
is=\E[1;24r\E[24;1H:
nd=\E[C:
kd=\E[B::kl=\E[D:kr=\E[C:ku=\E[A:le=^H:
mb=\E[5m:md=\E[1m:me=\E[m:mr=\E[7m:
kb=\0177:
r2=\E>\E[24;1H\E[?3l\E[?4l\E[?5l\E[?7h\E[?8h\E=:rc=\E8:
sc=\E7:se=\E[27m:sf=\ED:so=\E[7m:sr=\EM:ta=^I:
ue=\E[24m:up=\E[A:us=\E[4m:ve=\E[?25h:vi=\E[?25l:
vb=\E7\E[?5h\E[?5l\E[?5h\E[?5l\E[?5h\E[?5l\E[?5h\E[?5l\E8:
__END__
=pod

=head1 NAME

IO::Pager::Perl - Page text a screenful at a time, like more or less

=head1 SYNOPSIS

    use Term:ReadKey; #Optional, but recommended
    use IO::Pager::Perl;

    my $t = IO::Pager::Perl->new( rows => 25, cols => 80 );
    $t->add_text( $text );
    $t->more();

=head1 DESCRIPTION

This is a module for paging through text one screenful at a time.
It supports the features you expect using the shortcuts you expect.

IO::Pager::Perl is an enhanced fork of L<Term::Pager>.

=head1 USAGE

=head2 Create the Pager

    $t = IO::Pager::Perl->new( option => value, ... );

If no options are specified, sensible default values will be used.
The following options are recognized, and shown with the default value:

=over 4

=item I<rows> =E<gt>25?

The number of rows on your terminal.  The terminal is queried directly
with L<Term::ReadKey> if loaded or C<stty> or C<tput>, and if these fail
it defaults to 25.

=item I<cols> =E<gt>80?

The number of columns on your terminal. The terminal is queried directly
with L<Term::ReadKey> if loaded or C<stty> or C<tput>, and if these fail it
defaults to 80.

=item I<speed> =E<gt>38400?

The speed (baud rate) of your terminal. The terminal is queried directly
with Term::ReadKey if loaded or C<stty>, and if these fail it defaults to
a sensible value.

=item I<eof> =E<gt>0

Exit at end of file.

=item I<fold> =E<gt>1

Fold long lines with L<Text::Wrap>.

=item I<lineNo> =E<gt>0

If true, line numbering is added to the output.

=item I<pause> =E<gt>0

If defined, the pager will pause when the this character sequence is
encountered in the input text. Set to ^L i.e; "\cL" to mimic traditional
behavior of L<more/1>.

=item I<raw> =E<gt>0

Pass control characters from input unadulterated to the terminal.
By default, chracters other than tab and newline will be converted
to caret notation e.g; ^@ for null or ^L for form feed.

=item I<scrollBar> =E<gt>0

=item B<--scrollbar>

Display an interactive scrollbar in the right-most column.

=item I<squeeze> =E<gt>0

Collapse multiple blank lines into one.

=item I<statusCol> =E<gt>0

Add a column with markers indicating which row match a search expression.

=item I<visualBell> =E<gt>0

Flash the screen when beeping.

=back

=head3 Accessors

There are accessors for all of the above properties, however those for
rows, cols, speed, fold and squeeze are read only.

  #Is visualBell set?
  $t->visualBell();

  #Enable line numbering
  $t->lineNo(1);

=head2 Adding Text

You will need some text to page through. You can specify text as
as a parameter to the constructor:

    text => $text

Or even add text later:

    $t->add_text( $text );

If you wish to continuously add text to the pager, you must setup your own
event loop, and indicate to C<more> that it should relinquish control e.g;

    eval{
        while( $t->more(RT=>.05) ){
          ...
          $t->add_text("More text to page");
        }
    };

The eval block captures the exception thrown upon termination of the pager
so that your own program may continue. The I<RT> parameter indicates that
you wish to provide content in real time. This value is also passed to
L<Term::ReadKey/ReadKey> as the maximum blocking time per keypress and
should be between 0 and 1, with larger values trading greater interface
responsiveness for slight delays in output. A value of -1 may also be used
to request non-blocking polls, but likely will not behave as you would hope.

NOTE: If Term::ReadKey is not loaded but RT is true, screen updates will only
occur on keypress.

=head3 Callback

You can also pass a code reference to the I<text> attribute of the constructor
which will be called when reaching the "end of file"; consequently, it is not
possible to set the I<eof> flag to exit at end of file if doing so.

    $t->new( text=>sub{ } ); #eof=>0 is implied

Alternatively, you may supply a reference to a two element array. The first is
an initial chunk of text to load, and the second the callback.

    #Fibonacci
    my($m, $n)=(1,1);
    $t->new( text=> ["1\n", sub{ ($m,$n)=($n,$m+$n); return "$n\n"} ] );

=head2 User Interface

There are multiple special bookmarks (marks) that can be used in navigation.

=over 4

=item ^ Beginning of file

=item $ End of file

=item ' Previous location

=item " List user-created marks

=back

C<add_text> will automatically create special numeric marks when it encounters
a special character sequence, allowing the user to jump to predetermined
points in the buffer. Sequence that match the following regular expression

     /\cF\c]\cL\cE \[(\d+)\// #e.g; ^F^]^L^E [3/4]

will have marks matching $1 created that point at the line of the buffer the
sequence occurs on.

=head1 CUSTOMIZATION

=head2 add_func

It is possible to extend the features of IO::Pager::Perl by supplying the
C<add_func> method with a hash of character keys and callback values to be
invoked upon matching keypress; where \c? represents Control-? and \e?
represents Alt-? The existing mappings are listed below, and lengthier
descriptions are available in L<tp>.

=head3 General

=over

=item &help - C<h> or C<H>

=item &close - C<q> or C<Q> or C<:q> or C<:Q>

=item &refresh - C<r> or C<C-l> or C<C-R>

=item &flush_buffer - C<R>

=item &write_buffer - C<:w>

=item &open_file - C<:e>

=back

=head3 Navigation

=over

=item &downline - C<ENTER> or C<e> or C<j> or C<J> or C<C-e> or C<C-n> or C<down arrow>

=item &downhalf - C<d> or C<C-d>

=item &downpage - C<SPACE> C<f> or C<z> or C<C-f> or C<C-v> or C<M-space> or C<PgDn>

=item &uppage - C<b> or C<w> or C<C-b> or C<M-v> or C<PgUp>

=item &uphalf - C<u> or C<C-u>

=item &upline - C<k> or C<y> or C<K> or C<Y> or C<C-K> or C<C-P> or C<C-Y> or C<up arrow>

=item &to_bott - C<G> or C<$> or C<E<gt>> or C<M-E<gt>> or C<End>

=item &to_top - C<g> or C<E<lt>> or C<M-E<lt>>

=item &tab_left - C<left arrow>

=item &shift_left - C<S-left arrow>

=item &tab_right - C<right arrow>

=item &shift_right - C<S-right arrow>

=item &next_file - C<:n> or C<S-M-right arrow>

=item &prev_file - C<:p> or C<S-M-left arrow>

=back

And a special sequence of a number followed by enter analogous to:

	'/(\d+)/'   => \&jump(\1)        

if the value for that key is true.

=head3 Bookmarks

=over

=item &save_mark - C<m> or C<Ins>

=item &goto_mark - C<'>

=back

=head3 Search

=over

=item &search - /

=item &hcraes - ? 

=item &next_match - n or P

=item &prev_match - p or N 

=item &grep - &

=back

=head3 Options

=over

=item &toggle_num - #

=item &toggle_fold - S

=item &toggle_raw - C

=back

=head2 I18N

The C<dialog> method may be particularly useful when enhancing the pager.
It accepts a string to display, and an optional timeout to sleep for
before the dialog is cleared. If the timeout is missing or 0, the dialog
remains until a key is pressed.

    my $t = IO::Pager::Perl->new();
    $t->add_text("Text to display");
    $t->add_func('!'=>\&boo);
    $t->more();

    sub boo{ my $self = shift; $self->dialog("BOO!", 1); }

Should you add additional functionality to your pager, you will likely want
to change the contents of the help dialog or possibly the status line. Use the
C<I18N> method to replace the default text or save text for your own interface.

    #Get the default help text
    my $help = $t->I18N('help');

    #Minimal status line
    $t->I18N('minihelp', "<h> help");

Current text elements available for customization are:

    404        - search text not found dialog
    continue   - text to display at the bottom of the help dialog
    help       - help dialog text, a list of keys and their functions
    minihelp   - basic instructions displayed at the bottom of the screen
    status     - brief message to include in the status line
    top        - start of file prompt
    bottom     - end of file prompt
    searchwrap - message that pager is about to loop for more matches

I<prompt> is intended for sharing short messages not worthy of a dialog
e.g; when debugging. You will need to call the C<status> method after
setting it to refresh the status line of the display, then void I<prompt>
and call C<status> again to clear the message.

=head3 Scalability

The help text will be split in two horizontally on a null character if
the text is wider than the display, and shown in two sequential dialogs.

Similarly, the status text will be cropped at a null character for narrow
displays.

=head1 CAVEATS

=head2 UN*X

This modules currently only works in a UN*X-like environment.

=head2 Performance

For simplicity, the current implementation loads the entire message to view
at once; thus not requiring a distinction between piped contents and files.
This may require significant memory for large files.

=head2 Termcap

This module uses Termcap, which has been deprecated the Open Group,
and may not be supported by your operating system for much longer.

If the termcap entry for your ancient esoteric terminal is wrong or
incomplete, this module may either fill your screen with unintelligible
gibberish, or drop back to a feature-free mode.

Eventually, support for Terminfo may also be added.

=head2 Signals

IO::Pager::Perl sets a global signal handler for I<SIGWINCH>, this is the
only way it can effectively detect and accommodate changes in terminal size.
If you also need notification of this signal, the handler will trigger any
callback assigned to the I<WINCH> attribute of the C<new> method.

I<WINCH> is not available on Windows. You will need to manually refresh your
screen B<^L> if you resize the terminal in Windows to clean up the text
however, this will not change the size of the pager itself.

=head1 ENVIRONMENT

IO::Pager::Perl checks the I<TERM> and I<TERMCAP> variables.

=head1 SEE ALSO

L<IO::Pager>, L<Term::Cap>, L<Term::ReadKey>,
L<termcap(5)>, L<stty(1)>, L<tput(1)>, L<less(1)>

=head1 AUTHORS

    Jerrad Pierce jpierce@cpan.org

    Jeff Weisberg - http://www.tcp4me.com

=head1 LICENSE

This software may be copied and distributed under the terms
found in the Perl "Artistic License".

A copy of the "Artistic License" may be found in the standard
Perl distribution.
 
=cut