ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC

40=over 4 40=over 4
41 41
42=item selection (enabled by default) 42=item selection (enabled by default)
43 43
44(More) intelligent selection. This extension tries to be more intelligent 44(More) intelligent selection. This extension tries to be more intelligent
45when the user extends selections (double-click). Right now, it tries to 45when the user extends selections (double-click and further clicks). Right
46select urls and complete shell-quoted arguments, which is very convenient, 46now, it tries to select words, urls and complete shell-quoted
47too, if your F<ls> supports C<--quoting-style=shell>. 47arguments, which is very convenient, too, if your F<ls> supports
48C<--quoting-style=shell>.
48 49
50A double-click usually selects the word under the cursor, further clicks
51will enlarge the selection.
52
53The selection works by trying to match a number of regexes and displaying
54them in increasing order of length. You can add your own regexes by
55specifying resources of the form:
56
57 URxvt.selection.pattern-0: perl-regex
58 URxvt.selection.pattern-1: perl-regex
59 ...
60
61The index number (0, 1...) must not have any holes, and each regex must
62contain at least one pair of capturing parentheses, which will be used for
63the match. For example, the followign adds a regex that matches everything
64between two vertical bars:
65
66 URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end.
70
49It also offers the following bindable keyboard command: 71This extension also offers the following bindable keyboard command:
50 72
51=over 4 73=over 4
52 74
53=item rot13 75=item rot13
54 76
70evalution, web-browser starting etc.), depending on content. 92evalution, web-browser starting etc.), depending on content.
71 93
72=item searchable-scrollback<hotkey> (enabled by default) 94=item searchable-scrollback<hotkey> (enabled by default)
73 95
74Adds regex search functionality to the scrollback buffer, triggered 96Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 97by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 98input/output is suspended and a regex is displayed at the bottom of the
99screen.
77 100
78C</> starts an incremental regex search, C<n> searches further, C<p> or 101Inputting characters appends them to the regex and continues incremental
79C<N> jump to the previous match, C<G> jumps to the bottom and clears the 102search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80history, C<enter> leaves search mode at the current position and C<escape> 103search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 104bottom. C<Escape> leaves search mode and returns to the point where search
105was started, while C<Enter> or C<Return> stay at the current position and
106additionally stores the first match in the current line into the primary
107selection.
82 108
83=item digital-clock 109=item selection-autotransform
84 110
85Displays a digital clock using the built-in overlay. 111This selection allows you to do automatic transforms on a selection
112whenever a selection is made.
113
114It works by specifying perl snippets (most useful is a single C<s///>
115operator) that modify C<$_> as resources:
116
117 URxvt.selection-autotransform.0: transform
118 URxvt.selection-autotransform.1: transform
119 ...
120
121For example, the following will transform selections of the form
122C<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>:
124
125 URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126
127And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor:
129
130 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131
132Of course, this can be modified to suit your needs and your editor :)
133
134To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution:
136
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
138 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
139
140The first line tells the selection code to treat the unchanging part of
141every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file.
86 143
87=item mark-urls 144=item mark-urls
88 145
89Uses per-line display filtering (C<on_line_update>) to underline urls. 146Uses per-line display filtering (C<on_line_update>) to underline urls and
147make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument.
90 150
91=item block-graphics-to-ascii 151=item block-graphics-to-ascii
92 152
93A not very useful example of filtering all text output to the terminal, 153A not very useful example of filtering all text output to the terminal,
94by replacing all line-drawing characters (U+2500 .. U+259F) by a 154by replacing all line-drawing characters (U+2500 .. U+259F) by a
95similar-looking ascii character. 155similar-looking ascii character.
156
157=item digital-clock
158
159Displays a digital clock using the built-in overlay.
96 160
97=item example-refresh-hooks 161=item example-refresh-hooks
98 162
99Displays a very simple digital clock in the upper right corner of the 163Displays a very simple digital clock in the upper right corner of the
100window. Illustrates overwriting the refresh callbacks to create your own 164window. Illustrates overwriting the refresh callbacks to create your own
123=over 4 187=over 4
124 188
125=item $text 189=item $text
126 190
127Rxvt-unicodes special way of encoding text, where one "unicode" character 191Rxvt-unicodes special way of encoding text, where one "unicode" character
128always represents one screen cell. See L<row_t> for a discussion of this format. 192always represents one screen cell. See L<ROW_t> for a discussion of this format.
129 193
130=item $string 194=item $string
131 195
132A perl text string, with an emphasis on I<text>. It can store all unicode 196A perl text string, with an emphasis on I<text>. It can store all unicode
133characters and is to be distinguished with text encoded in a specific 197characters and is to be distinguished with text encoded in a specific
228=item on_sel_extend $term 292=item on_sel_extend $term
229 293
230Called whenever the user tries to extend the selection (e.g. with a double 294Called whenever the user tries to extend the selection (e.g. with a double
231click) and is either supposed to return false (normal operation), or 295click) and is either supposed to return false (normal operation), or
232should extend the selection itelf and return true to suppress the built-in 296should extend the selection itelf and return true to suppress the built-in
233processing. 297processing. This can happen multiple times, as long as the callback
298returns true, it will be called on every further click by the user and is
299supposed to enlarge the selection more and more, if possible.
234 300
235See the F<selection> example extension. 301See the F<selection> example extension.
236 302
237=item on_view_change $term, $offset 303=item on_view_change $term, $offset
238 304
343 409
344subwindow. 410subwindow.
345 411
346=back 412=back
347 413
348=head2 Variables in the C<urxvt> Package
349
350=over 4
351
352=item $urxvt::LIBDIR
353
354The rxvt-unicode library directory, where, among other things, the perl
355modules and scripts are stored.
356
357=item $urxvt::RESCLASS, $urxvt::RESCLASS
358
359The resource class and name rxvt-unicode uses to look up X resources.
360
361=item $urxvt::RXVTNAME
362
363The basename of the installed binaries, usually C<urxvt>.
364
365=item $urxvt::TERM
366
367The current terminal. This variable stores the current C<urxvt::term>
368object, whenever a callback/hook is executing.
369
370=item
371
372=back
373
374=head2 Functions in the C<urxvt> Package
375
376=over 4
377
378=item $term = new urxvt [arg...]
379
380Creates a new terminal, very similar as if you had started it with
381C<system $binfile, arg...>. Croaks (and probably outputs an error message)
382if the new instance couldn't be created. Returns C<undef> if the new
383instance didn't initialise perl, and the terminal object otherwise. The
384C<init> and C<start> hooks will be called during the call.
385
386=item urxvt::fatal $errormessage
387
388Fatally aborts execution with the given error message. Avoid at all
389costs! The only time this is acceptable is when the terminal process
390starts up.
391
392=item urxvt::warn $string
393
394Calls C<rxvt_warn> with the given string which should not include a
395newline. The module also overwrites the C<warn> builtin with a function
396that calls this function.
397
398Using this function has the advantage that its output ends up in the
399correct place, e.g. on stderr of the connecting urxvtc client.
400
401=item $is_safe = urxvt::safe
402
403Returns true when it is safe to do potentially unsafe things, such as
404evaluating perl code specified by the user. This is true when urxvt was
405started setuid or setgid.
406
407=item $time = urxvt::NOW
408
409Returns the "current time" (as per the event loop).
410
411=item urxvt::CurrentTime
412
413=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
414Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
415Button4Mask, Button5Mask, AnyModifier
416
417Various constants for use in X calls and event processing.
418
419=back
420
421=head2 RENDITION
422
423Rendition bitsets contain information about colour, font, font styles and
424similar information for each screen cell.
425
426The following "macros" deal with changes in rendition sets. You should
427never just create a bitset, you should always modify an existing one,
428as they contain important information required for correct operation of
429rxvt-unicode.
430
431=over 4
432
433=item $rend = urxvt::DEFAULT_RSTYLE
434
435Returns the default rendition, as used when the terminal is starting up or
436being reset. Useful as a base to start when creating renditions.
437
438=item $rend = urxvt::OVERLAY_RSTYLE
439
440Return the rendition mask used for overlays by default.
441
442=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
443
444Return the bit that enabled bold, italic, blink, reverse-video and
445underline, respectively. To enable such a style, just logically OR it into
446the bitset.
447
448=item $foreground = urxvt::GET_BASEFG $rend
449
450=item $background = urxvt::GET_BASEBG $rend
451
452Return the foreground/background colour index, respectively.
453
454=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
455
456=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
457
458Replace the foreground/background colour in the rendition mask with the
459specified one.
460
461=item $value = urxvt::GET_CUSTOM $rend
462
463Return the "custom" value: Every rendition has 5 bits for use by
464extensions. They can be set and changed as you like and are initially
465zero.
466
467=item $rend = urxvt::SET_CUSTOM $rend, $new_value
468
469Change the custom value.
470
471=back
472
473=cut 414=cut
474 415
475package urxvt; 416package urxvt;
476 417
477use utf8; 418use utf8;
488 429
489our $LIBDIR; 430our $LIBDIR;
490our $RESNAME; 431our $RESNAME;
491our $RESCLASS; 432our $RESCLASS;
492our $RXVTNAME; 433our $RXVTNAME;
434
435=head2 Variables in the C<urxvt> Package
436
437=over 4
438
439=item $urxvt::LIBDIR
440
441The rxvt-unicode library directory, where, among other things, the perl
442modules and scripts are stored.
443
444=item $urxvt::RESCLASS, $urxvt::RESCLASS
445
446The resource class and name rxvt-unicode uses to look up X resources.
447
448=item $urxvt::RXVTNAME
449
450The basename of the installed binaries, usually C<urxvt>.
451
452=item $urxvt::TERM
453
454The current terminal. This variable stores the current C<urxvt::term>
455object, whenever a callback/hook is executing.
456
457=back
458
459=head2 Functions in the C<urxvt> Package
460
461=over 4
462
463=item urxvt::fatal $errormessage
464
465Fatally aborts execution with the given error message. Avoid at all
466costs! The only time this is acceptable is when the terminal process
467starts up.
468
469=item urxvt::warn $string
470
471Calls C<rxvt_warn> with the given string which should not include a
472newline. The module also overwrites the C<warn> builtin with a function
473that calls this function.
474
475Using this function has the advantage that its output ends up in the
476correct place, e.g. on stderr of the connecting urxvtc client.
477
478Messages have a size limit of 1023 bytes currently.
479
480=item $is_safe = urxvt::safe
481
482Returns true when it is safe to do potentially unsafe things, such as
483evaluating perl code specified by the user. This is true when urxvt was
484started setuid or setgid.
485
486=item $time = urxvt::NOW
487
488Returns the "current time" (as per the event loop).
489
490=item urxvt::CurrentTime
491
492=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
493Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
494Button4Mask, Button5Mask, AnyModifier
495
496Various constants for use in X calls and event processing.
497
498=back
499
500=head2 RENDITION
501
502Rendition bitsets contain information about colour, font, font styles and
503similar information for each screen cell.
504
505The following "macros" deal with changes in rendition sets. You should
506never just create a bitset, you should always modify an existing one,
507as they contain important information required for correct operation of
508rxvt-unicode.
509
510=over 4
511
512=item $rend = urxvt::DEFAULT_RSTYLE
513
514Returns the default rendition, as used when the terminal is starting up or
515being reset. Useful as a base to start when creating renditions.
516
517=item $rend = urxvt::OVERLAY_RSTYLE
518
519Return the rendition mask used for overlays by default.
520
521=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
522
523Return the bit that enabled bold, italic, blink, reverse-video and
524underline, respectively. To enable such a style, just logically OR it into
525the bitset.
526
527=item $foreground = urxvt::GET_BASEFG $rend
528
529=item $background = urxvt::GET_BASEBG $rend
530
531Return the foreground/background colour index, respectively.
532
533=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
534
535=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
536
537Replace the foreground/background colour in the rendition mask with the
538specified one.
539
540=item $value = urxvt::GET_CUSTOM $rend
541
542Return the "custom" value: Every rendition has 5 bits for use by
543extensions. They can be set and changed as you like and are initially
544zero.
545
546=item $rend = urxvt::SET_CUSTOM $rend, $new_value
547
548Change the custom value.
549
550=back
551
552=cut
493 553
494BEGIN { 554BEGIN {
495 urxvt->bootstrap; 555 urxvt->bootstrap;
496 556
497 # overwrite perl's warn 557 # overwrite perl's warn
500 $msg .= "\n" 560 $msg .= "\n"
501 unless $msg =~ /\n$/; 561 unless $msg =~ /\n$/;
502 urxvt::warn ($msg); 562 urxvt::warn ($msg);
503 }; 563 };
504 564
565 # %ENV is the original startup environment
505 delete $ENV{IFS}; 566 delete $ENV{IFS};
506 delete $ENV{CDPATH}; 567 delete $ENV{CDPATH};
507 delete $ENV{BASH_ENV}; 568 delete $ENV{BASH_ENV};
508 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 569 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509} 570}
598 if ($@) { 659 if ($@) {
599 $TERM->ungrab; # better to lose the grab than the session 660 $TERM->ungrab; # better to lose the grab than the session
600 warn $@; 661 warn $@;
601 } 662 }
602 } 663 }
664
665 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
666 if $verbosity >= 11;
603 } 667 }
604 668
605 if ($htype == 1) { # DESTROY 669 if ($htype == 1) { # DESTROY
606 if (my $hook = delete $TERM->{_hook}) { 670 if (my $hook = delete $TERM->{_hook}) {
607 for my $htype (0..$#$hook) { 671 for my $htype (0..$#$hook) {
616 # clear package 680 # clear package
617 %$TERM = (); 681 %$TERM = ();
618 } 682 }
619 683
620 $retval 684 $retval
685}
686
687sub exec_async(@) {
688 my $pid = fork;
689
690 return
691 if !defined $pid or $pid;
692
693 %ENV = %{ $TERM->env };
694
695 exec @_;
696 _exit 255;
621} 697}
622 698
623# urxvt::term::extension 699# urxvt::term::extension
624 700
625package urxvt::term::extension; 701package urxvt::term::extension;
781 for my $name (@HOOKNAME) { 857 for my $name (@HOOKNAME) {
782 if (my $ref = $pkg->can ("on_" . lc $name)) { 858 if (my $ref = $pkg->can ("on_" . lc $name)) {
783 $proxy->enable ($name => $ref); 859 $proxy->enable ($name => $ref);
784 } 860 }
785 } 861 }
862}
863
864=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
865
866Creates a new terminal, very similar as if you had started it with system
867C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
868hash which defines the environment of the new terminal.
869
870Croaks (and probably outputs an error message) if the new instance
871couldn't be created. Returns C<undef> if the new instance didn't
872initialise perl, and the terminal object otherwise. The C<init> and
873C<start> hooks will be called during this call.
874
875=cut
876
877sub new {
878 my ($class, $env, @args) = @_;
879
880 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
786} 881}
787 882
788=item $term->destroy 883=item $term->destroy
789 884
790Destroy the terminal object (close the window, free resources 885Destroy the terminal object (close the window, free resources
847 my ($self, $name) = (shift, shift); 942 my ($self, $name) = (shift, shift);
848 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 943 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
849 &urxvt::term::_resource 944 &urxvt::term::_resource
850} 945}
851 946
947=item $value = $term->x_resource ($pattern)
948
949Returns the X-Resource for the given pattern, excluding the program or
950class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
951same value as used by this instance of rxvt-unicode. Returns C<undef> if no
952resource with that pattern exists.
953
954This method should only be called during the C<on_start> hook, as there is
955only one resource database per display, and later invocations might return
956the wrong resources.
957
852=item $success = $term->parse_keysym ($keysym_spec, $command_string) 958=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853 959
854Adds a keymap translation exactly as specified via a resource. See the 960Adds a keymap translation exactly as specified via a resource. See the
855C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 961C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856 962
871=item ($row, $col) = $term->selection_end ([$row, $col]) 977=item ($row, $col) = $term->selection_end ([$row, $col])
872 978
873Return the current values of the selection mark, begin or end positions, 979Return the current values of the selection mark, begin or end positions,
874and optionally set them to new values. 980and optionally set them to new values.
875 981
982=item $term->selection_make ($eventtime[, $rectangular])
983
984Tries to make a selection as set by C<selection_beg> and
985C<selection_end>. If C<$rectangular> is true (default: false), a
986rectangular selection will be made. This is the prefered function to make
987a selection.
988
876=item $success = $term->selection_grab ($eventtime) 989=item $success = $term->selection_grab ($eventtime)
877 990
878Try to request the primary selection from the server (for example, as set 991Try to request the primary selection text from the server (for example, as
879by the next method). 992set by the next method). No visual feedback will be given. This function
993is mostly useful from within C<on_sel_grab> hooks.
880 994
881=item $oldtext = $term->selection ([$newtext]) 995=item $oldtext = $term->selection ([$newtext])
882 996
883Return the current selection text and optionally replace it by C<$newtext>. 997Return the current selection text and optionally replace it by C<$newtext>.
884 998
977Convert the given locale-encoded octets into a perl string. 1091Convert the given locale-encoded octets into a perl string.
978 1092
979=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1093=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980 1094
981XORs the rendition values in the given span with the provided value 1095XORs the rendition values in the given span with the provided value
982(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1096(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983to the selection. 1097refresh hooks to provide effects similar to the selection.
984 1098
985=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1099=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986 1100
987Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1101Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988whitespace will additionally be xored with the C<$rstyle2>, which defaults 1102whitespace will additionally be xored with the C<$rstyle2>, which defaults
989to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1103to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
990it instead. 1104it instead. Both styles I<MUST NOT> contain font styles.
991 1105
992=item $term->scr_bell 1106=item $term->scr_bell
993 1107
994Ring the bell! 1108Ring the bell!
995 1109
1055 1169
1056=item $lines_in_scrollback = $term->nsaved 1170=item $lines_in_scrollback = $term->nsaved
1057 1171
1058Return various integers describing terminal characteristics. 1172Return various integers describing terminal characteristics.
1059 1173
1174=item $x_display = $term->display_id
1175
1176Return the DISPLAY used by rxvt-unicode.
1177
1060=item $lc_ctype = $term->locale 1178=item $lc_ctype = $term->locale
1061 1179
1062Returns the LC_CTYPE category string used by this rxvt-unicode. 1180Returns the LC_CTYPE category string used by this rxvt-unicode.
1063 1181
1064=item $x_display = $term->display_id 1182=item $env = $term->env
1065 1183
1066Return the DISPLAY used by rxvt-unicode. 1184Returns a copy of the environment in effect for the terminal as a hashref
1185similar to C<\%ENV>.
1186
1187=cut
1188
1189sub env {
1190 if (my $env = $_[0]->_env) {
1191 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1192 } else {
1193 +{ %ENV }
1194 }
1195}
1067 1196
1068=item $modifiermask = $term->ModLevel3Mask 1197=item $modifiermask = $term->ModLevel3Mask
1069 1198
1070=item $modifiermask = $term->ModMetaMask 1199=item $modifiermask = $term->ModMetaMask
1071 1200
1164Return the row number of the first/last row of the line, respectively. 1293Return the row number of the first/last row of the line, respectively.
1165 1294
1166=item $offset = $line->offset_of ($row, $col) 1295=item $offset = $line->offset_of ($row, $col)
1167 1296
1168Returns the character offset of the given row|col pair within the logical 1297Returns the character offset of the given row|col pair within the logical
1169line. 1298line. Works for rows outside the line, too, and returns corresponding
1299offsets outside the string.
1170 1300
1171=item ($row, $col) = $line->coord_of ($offset) 1301=item ($row, $col) = $line->coord_of ($offset)
1172 1302
1173Translates a string offset into terminal coordinates again. 1303Translates a string offset into terminal coordinates again.
1174 1304
1311 $item->{render} ||= sub { $_[0]{text} }; 1441 $item->{render} ||= sub { $_[0]{text} };
1312 1442
1313 push @{ $self->{item} }, $item; 1443 push @{ $self->{item} }, $item;
1314} 1444}
1315 1445
1446=item $popup->add_title ($title)
1447
1448Adds a non-clickable title to the popup.
1449
1450=cut
1451
1452sub add_title {
1453 my ($self, $title) = @_;
1454
1455 $self->add_item ({
1456 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1457 text => $title,
1458 activate => sub { },
1459 });
1460}
1461
1462=item $popup->add_separator ([$sepchr])
1463
1464Creates a separator, optionally using the character given as C<$sepchr>.
1465
1466=cut
1467
1316sub add_separator { 1468sub add_separator {
1317 my ($self, $sep) = @_; 1469 my ($self, $sep) = @_;
1318 1470
1319 $sep ||= "="; 1471 $sep ||= "=";
1320 1472
1324 render => sub { $sep x $self->{term}->ncol }, 1476 render => sub { $sep x $self->{term}->ncol },
1325 activate => sub { }, 1477 activate => sub { },
1326 }); 1478 });
1327} 1479}
1328 1480
1329sub add_title { 1481=item $popup->add_button ($text, $cb)
1330 my ($self, $title) = @_;
1331 1482
1332 $self->add_item ({ 1483Adds a clickable button to the popup. C<$cb> is called whenever it is
1333 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, 1484selected.
1334 text => $title, 1485
1335 activate => sub { }, 1486=cut
1336 });
1337}
1338 1487
1339sub add_button { 1488sub add_button {
1340 my ($self, $text, $cb) = @_; 1489 my ($self, $text, $cb) = @_;
1341 1490
1342 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1491 $self->add_item ({ type => "button", text => $text, activate => $cb});
1343} 1492}
1493
1494=item $popup->add_toggle ($text, $cb, $initial_value)
1495
1496Adds a toggle/checkbox item to the popup. Teh callback gets called
1497whenever it gets toggled, with a boolean indicating its value as its first
1498argument.
1499
1500=cut
1344 1501
1345sub add_toggle { 1502sub add_toggle {
1346 my ($self, $text, $cb, $value) = @_; 1503 my ($self, $text, $cb, $value) = @_;
1347 1504
1348 my $item; $item = { 1505 my $item; $item = {
1349 type => "button", 1506 type => "button",
1350 text => " $text", 1507 text => " $text",
1351 value => $value, 1508 value => $value,
1352 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1509 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1510 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354 }; 1511 };
1355 1512
1356 $self->add_item ($item); 1513 $self->add_item ($item);
1357} 1514}
1515
1516=item $popup->show
1517
1518Displays the popup (which is initially hidden).
1519
1520=cut
1358 1521
1359sub show { 1522sub show {
1360 my ($self) = @_; 1523 my ($self) = @_;
1361 1524
1362 local $urxvt::popup::self = $self; 1525 local $urxvt::popup::self = $self;
1363 1526
1527 my $env = $self->{term}->env;
1528 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1529 delete $env->{LC_ALL};
1364 local $ENV{LC_ALL} = $self->{term}->locale; 1530 $env->{LC_CTYPE} = $self->{term}->locale;
1365 1531
1532 urxvt::term->new ($env, $self->{term}->resource ("name"),
1366 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1533 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1367 "--transient-for" => $self->{term}->parent, 1534 "--transient-for" => $self->{term}->parent,
1368 "-display" => $self->{term}->display_id, 1535 "-display" => $self->{term}->display_id,
1369 "-pe" => "urxvt-popup") 1536 "-pe" => "urxvt-popup")
1370 or die "unable to create popup window\n"; 1537 or die "unable to create popup window\n";
1371} 1538}
1372 1539
1373sub DESTROY { 1540sub DESTROY {
1374 my ($self) = @_; 1541 my ($self) = @_;
1375 1542
1376 delete $self->{term}{_destroy}{$self}; 1543 delete $self->{term}{_destroy}{$self};
1377 $self->{term}->ungrab; 1544 $self->{term}->ungrab;
1378} 1545}
1546
1547=back
1379 1548
1380=head2 The C<urxvt::timer> Class 1549=head2 The C<urxvt::timer> Class
1381 1550
1382This class implements timer watchers/events. Time is represented as a 1551This class implements timer watchers/events. Time is represented as a
1383fractional number of seconds since the epoch. Example: 1552fractional number of seconds since the epoch. Example:
1490 1659
1491=item == 0 - fatal messages 1660=item == 0 - fatal messages
1492 1661
1493=item >= 3 - script loading and management 1662=item >= 3 - script loading and management
1494 1663
1495=item >=10 - all events received 1664=item >=10 - all called hooks
1665
1666=item >=11 - hook reutrn values
1496 1667
1497=back 1668=back
1498 1669
1499=head1 AUTHOR 1670=head1 AUTHOR
1500 1671

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines