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.54 by root, Sun Jan 8 01:59:29 2006 UTC vs.
Revision 1.95 by elmex, Tue Jan 17 13:19:45 2006 UTC

26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31=head2 Prepackaged Extensions 31=head1 PREPACKAGED EXTENSIONS
32 32
33This section describes the extensiosn delivered with this version. You can 33This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39 39
40=over 4 40=over 4
41 41
42=item selection (enabled by default) 42=item selection (enabled by default)
43 43
44Intelligent selection. This extension tries to be more intelligent when 44(More) intelligent selection. This extension tries to be more intelligent
45the user extends selections (double-click). Right now, it tries to select 45when the user extends selections (double-click and further clicks). Right
46urls and complete shell-quoted arguments, which is very convenient, too, 46now, it tries to select words, urls and complete shell-quoted
47if 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
49It also offers the following bindable event: 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
71This extension also offers following bindable keyboard commands:
50 72
51=over 4 73=over 4
52 74
53=item rot13 75=item rot13
54 76
55Rot-13 the selection when activated. Used via keyboard trigger: 77Rot-13 the selection when activated. Used via keyboard trigger:
56 78
57 URxvt.keysym.C-M-r: perl:selection:rot13 79 URxvt.keysym.C-M-r: perl:selection:rot13
58 80
81=item remote-pastebin
82
83Upload the selection as textfile to a remote site.
84
85 URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87To set the command to upload the file set this resource:
88
89 URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92md5 sum of the selection.
93After an successful upload the selection will be replaced by the following url
94(the % is the placeholder for the filename):
95
96 URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
97
59=back 98=back
60 99
61=item option-popup (enabled by default) 100=item option-popup (enabled by default)
62 101
63Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at 102Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64runtime. 103runtime.
65 104
66=item digital-clock 105=item selection-popup (enabled by default)
67 106
68Displays a digital clock using the built-in overlay. 107Binds a popup menu to Ctrl-Button3 that lets you convert the selection
108text into various other formats/action (such as uri unescaping, perl
109evalution, web-browser starting etc.), depending on content.
110
111=item searchable-scrollback<hotkey> (enabled by default)
112
113Adds regex search functionality to the scrollback buffer, triggered
114by a hotkey (default: C<M-s>). While in search mode, normal terminal
115input/output is suspended and a regex is displayed at the bottom of the
116screen.
117
118Inputting characters appends them to the regex and continues incremental
119search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
120search upwards/downwards in the scrollback buffer, C<End> jumps to the
121bottom. C<Escape> leaves search mode and returns to the point where search
122was started, while C<Enter> or C<Return> stay at the current position and
123additionally stores the first match in the current line into the primary
124selection.
125
126=item selection-autotransform
127
128This selection allows you to do automatic transforms on a selection
129whenever a selection is made.
130
131It works by specifying perl snippets (most useful is a single C<s///>
132operator) that modify C<$_> as resources:
133
134 URxvt.selection-autotransform.0: transform
135 URxvt.selection-autotransform.1: transform
136 ...
137
138For example, the following will transform selections of the form
139C<filename:number>, often seen in compiler messages, into C<vi +$filename
140$word>:
141
142 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
143
144And this example matches the same,but replaces it with vi-commands you can
145paste directly into your (vi :) editor:
146
147 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
148
149Of course, this can be modified to suit your needs and your editor :)
150
151To expand the example above to typical perl error messages ("XXX at
152FILENAME line YYY."), you need a slightly more elaborate solution:
153
154 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
155 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
156
157The first line tells the selection code to treat the unchanging part of
158every error message as a selection pattern, and the second line transforms
159the message into vi commands to load the file.
69 160
70=item mark-urls 161=item mark-urls
71 162
72Uses per-line display filtering (C<on_line_update>) to underline urls. 163Uses per-line display filtering (C<on_line_update>) to underline urls and
164make them clickable. When middle-clicked, the program specified in the
165resource C<urlLauncher> (default C<x-www-browser>) will be started with
166the URL as first argument.
73 167
74=item block-graphics-to-ascii 168=item block-graphics-to-ascii
75 169
76A not very useful example of filtering all text output to the terminal, 170A not very useful example of filtering all text output to the terminal,
77by replacing all line-drawing characters (U+2500 .. U+259F) by a 171by replacing all line-drawing characters (U+2500 .. U+259F) by a
78similar-looking ascii character. 172similar-looking ascii character.
79 173
174=item digital-clock
175
176Displays a digital clock using the built-in overlay.
177
80=item example-refresh-hooks 178=item example-refresh-hooks
81 179
82Displays a very simple digital clock in the upper right corner of the 180Displays a very simple digital clock in the upper right corner of the
83window. Illustrates overwriting the refresh callbacks to create your own 181window. Illustrates overwriting the refresh callbacks to create your own
84overlays or changes. 182overlays or changes.
85 183
86=back 184=back
185
186=head1 API DOCUMENTATION
87 187
88=head2 General API Considerations 188=head2 General API Considerations
89 189
90All objects (such as terminals, time watchers etc.) are typical 190All objects (such as terminals, time watchers etc.) are typical
91reference-to-hash objects. The hash can be used to store anything you 191reference-to-hash objects. The hash can be used to store anything you
104=over 4 204=over 4
105 205
106=item $text 206=item $text
107 207
108Rxvt-unicodes special way of encoding text, where one "unicode" character 208Rxvt-unicodes special way of encoding text, where one "unicode" character
109always represents one screen cell. See L<row_t> for a discussion of this format. 209always represents one screen cell. See L<ROW_t> for a discussion of this format.
110 210
111=item $string 211=item $string
112 212
113A perl text string, with an emphasis on I<text>. It can store all unicode 213A perl text string, with an emphasis on I<text>. It can store all unicode
114characters and is to be distinguished with text encoded in a specific 214characters and is to be distinguished with text encoded in a specific
119Either binary data or - more common - a text string encoded in a 219Either binary data or - more common - a text string encoded in a
120locale-specific way. 220locale-specific way.
121 221
122=back 222=back
123 223
224=head2 Extension Objects
225
226Very perl extension is a perl class. A separate perl object is created
227for each terminal and each extension and passed as the first parameter to
228hooks. So extensions can use their C<$self> object without having to think
229about other extensions, with the exception of methods and members that
230begin with an underscore character C<_>: these are reserved for internal
231use.
232
233Although it isn't a C<urxvt::term> object, you can call all methods of the
234C<urxvt::term> class on this object.
235
236It has the following methods and data members:
237
238=over 4
239
240=item $urxvt_term = $self->{term}
241
242Returns the C<urxvt::term> object associated with this instance of the
243extension. This member I<must not> be changed in any way.
244
245=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
246
247Dynamically enable the given hooks (named without the C<on_> prefix) for
248this extension, replacing any previous hook. This is useful when you want
249to overwrite time-critical hooks only temporarily.
250
251=item $self->disable ($hook_name[, $hook_name..])
252
253Dynamically disable the given hooks.
254
255=back
256
124=head2 Hooks 257=head2 Hooks
125 258
126The following subroutines can be declared in extension files, and will be 259The following subroutines can be declared in extension files, and will be
127called whenever the relevant event happens. 260called whenever the relevant event happens.
128 261
129The first argument passed to them is an object private to each terminal 262The first argument passed to them is an extension oject as described in
130and extension package. You can call all C<urxvt::term> methods on it, but 263the in the C<Extension Objects> section.
131its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
132object that is shared between all packages is stored in the C<term>
133member. It is, however, blessed intot he package of the extension script,
134so for all practical purposes you can treat an extension script as a class.
135 264
136All of them must return a boolean value. If it is true, then the event 265B<All> of these hooks must return a boolean value. If it is true, then the
137counts as being I<consumed>, and the invocation of other hooks is skipped, 266event counts as being I<consumed>, and the invocation of other hooks is
138and the relevant action might not be carried out by the C++ code. 267skipped, and the relevant action might not be carried out by the C++ code.
139 268
140When in doubt, return a false value (preferably C<()>). 269I<< When in doubt, return a false value (preferably C<()>). >>
141 270
142=over 4 271=over 4
143 272
144=item on_init $term 273=item on_init $term
145 274
180=item on_sel_extend $term 309=item on_sel_extend $term
181 310
182Called whenever the user tries to extend the selection (e.g. with a double 311Called whenever the user tries to extend the selection (e.g. with a double
183click) and is either supposed to return false (normal operation), or 312click) and is either supposed to return false (normal operation), or
184should extend the selection itelf and return true to suppress the built-in 313should extend the selection itelf and return true to suppress the built-in
185processing. 314processing. This can happen multiple times, as long as the callback
315returns true, it will be called on every further click by the user and is
316supposed to enlarge the selection more and more, if possible.
186 317
187See the F<selection> example extension. 318See the F<selection> example extension.
188 319
189=item on_view_change $term, $offset 320=item on_view_change $term, $offset
190 321
199than the scroll back buffer or the terminal. 330than the scroll back buffer or the terminal.
200 331
201It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 332It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
202$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 333$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
203number of lines that will be in the scrollback buffer. 334number of lines that will be in the scrollback buffer.
204
205=item on_tty_activity $term *NYI*
206
207Called whenever the program(s) running in the urxvt window send output.
208 335
209=item on_osc_seq $term, $string 336=item on_osc_seq $term, $string
210 337
211Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 338Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212operating system command) is processed. Cursor position and other state 339operating system command) is processed. Cursor position and other state
225can filter/change and output the text yourself by returning a true value 352can filter/change and output the text yourself by returning a true value
226and calling C<< $term->scr_add_lines >> yourself. Please note that this 353and calling C<< $term->scr_add_lines >> yourself. Please note that this
227might be very slow, however, as your hook is called for B<all> text being 354might be very slow, however, as your hook is called for B<all> text being
228output. 355output.
229 356
357=item on_tt_write $term, $octets
358
359Called whenever some data is written to the tty/pty and can be used to
360suppress or filter tty input.
361
230=item on_line_update $term, $row 362=item on_line_update $term, $row
231 363
232Called whenever a line was updated or changed. Can be used to filter 364Called whenever a line was updated or changed. Can be used to filter
233screen output (e.g. underline urls or other useless stuff). Only lines 365screen output (e.g. underline urls or other useless stuff). Only lines
234that are being shown will be filtered, and, due to performance reasons, 366that are being shown will be filtered, and, due to performance reasons,
256 388
257Called whenever the user presses a key combination that has a 389Called whenever the user presses a key combination that has a
258C<perl:string> action bound to it (see description of the B<keysym> 390C<perl:string> action bound to it (see description of the B<keysym>
259resource in the @@RXVT_NAME@@(1) manpage). 391resource in the @@RXVT_NAME@@(1) manpage).
260 392
393=item on_x_event $term, $event
394
395Called on every X event received on the vt window (and possibly other
396windows). Should only be used as a last resort. Most event structure
397members are not passed.
398
261=item on_focus_in $term 399=item on_focus_in $term
262 400
263Called whenever the window gets the keyboard focus, before rxvt-unicode 401Called whenever the window gets the keyboard focus, before rxvt-unicode
264does focus in processing. 402does focus in processing.
265 403
266=item on_focus_out $term 404=item on_focus_out $term
267 405
268Called wheneever the window loses keyboard focus, before rxvt-unicode does 406Called wheneever the window loses keyboard focus, before rxvt-unicode does
269focus out processing. 407focus out processing.
270 408
271=item on_key_press $term, $event, $octets 409=item on_key_press $term, $event, $keysym, $octets
272 410
273=item on_key_release $term, $event 411=item on_key_release $term, $event, $keysym
274 412
275=item on_button_press $term, $event 413=item on_button_press $term, $event
276 414
277=item on_button_release $term, $event 415=item on_button_release $term, $event
278 416
294 432
295subwindow. 433subwindow.
296 434
297=back 435=back
298 436
437=cut
438
439package urxvt;
440
441use utf8;
442use strict;
443use Carp ();
444use Scalar::Util ();
445use List::Util ();
446
447our $VERSION = 1;
448our $TERM;
449our @HOOKNAME;
450our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451our %OPTION;
452
453our $LIBDIR;
454our $RESNAME;
455our $RESCLASS;
456our $RXVTNAME;
457
299=head2 Variables in the C<urxvt> Package 458=head2 Variables in the C<urxvt> Package
300 459
301=over 4 460=over 4
461
462=item $urxvt::LIBDIR
463
464The rxvt-unicode library directory, where, among other things, the perl
465modules and scripts are stored.
466
467=item $urxvt::RESCLASS, $urxvt::RESCLASS
468
469The resource class and name rxvt-unicode uses to look up X resources.
470
471=item $urxvt::RXVTNAME
472
473The basename of the installed binaries, usually C<urxvt>.
302 474
303=item $urxvt::TERM 475=item $urxvt::TERM
304 476
305The current terminal. This variable stores the current C<urxvt::term> 477The current terminal. This variable stores the current C<urxvt::term>
306object, whenever a callback/hook is executing. 478object, whenever a callback/hook is executing.
308=back 480=back
309 481
310=head2 Functions in the C<urxvt> Package 482=head2 Functions in the C<urxvt> Package
311 483
312=over 4 484=over 4
313
314=item $term = new urxvt [arg...]
315
316Creates a new terminal, very similar as if you had started it with
317C<system $binfile, arg...>. Croaks (and probably outputs an error message)
318if the new instance couldn't be created. Returns C<undef> if the new
319instance didn't initialise perl, and the terminal object otherwise. The
320C<init> and C<start> hooks will be called during the call.
321 485
322=item urxvt::fatal $errormessage 486=item urxvt::fatal $errormessage
323 487
324Fatally aborts execution with the given error message. Avoid at all 488Fatally aborts execution with the given error message. Avoid at all
325costs! The only time this is acceptable is when the terminal process 489costs! The only time this is acceptable is when the terminal process
332that calls this function. 496that calls this function.
333 497
334Using this function has the advantage that its output ends up in the 498Using this function has the advantage that its output ends up in the
335correct place, e.g. on stderr of the connecting urxvtc client. 499correct place, e.g. on stderr of the connecting urxvtc client.
336 500
501Messages have a size limit of 1023 bytes currently.
502
503=item $is_safe = urxvt::safe
504
505Returns true when it is safe to do potentially unsafe things, such as
506evaluating perl code specified by the user. This is true when urxvt was
507started setuid or setgid.
508
337=item $time = urxvt::NOW 509=item $time = urxvt::NOW
338 510
339Returns the "current time" (as per the event loop). 511Returns the "current time" (as per the event loop).
340 512
341=item urxvt::CurrentTime 513=item urxvt::CurrentTime
342 514
343=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 515=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
344Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 516Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
345Button4Mask, Button5Mask, AnyModifier 517Button4Mask, Button5Mask, AnyModifier
346 518
519=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
520ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
521PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
522Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
523KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
524ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
525FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
526
527=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
528EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
529GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
530UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
531ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
532CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
533SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
534
347Various constants for use in X events. 535Various constants for use in X calls and event processing.
348 536
349=back 537=back
350 538
351=head2 RENDITION 539=head2 RENDITION
352 540
379 567
380=item $background = urxvt::GET_BASEBG $rend 568=item $background = urxvt::GET_BASEBG $rend
381 569
382Return the foreground/background colour index, respectively. 570Return the foreground/background colour index, respectively.
383 571
384=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 572=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
385 573
386=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 574=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
387 575
388Replace the foreground/background colour in the rendition mask with the 576Replace the foreground/background colour in the rendition mask with the
389specified one. 577specified one.
390 578
391=item $value = urxvt::GET_CUSTOM ($rend) 579=item $value = urxvt::GET_CUSTOM $rend
392 580
393Return the "custom" value: Every rendition has 5 bits for use by 581Return the "custom" value: Every rendition has 5 bits for use by
394extensions. They can be set and changed as you like and are initially 582extensions. They can be set and changed as you like and are initially
395zero. 583zero.
396 584
397=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 585=item $rend = urxvt::SET_CUSTOM $rend, $new_value
398 586
399Change the custom value. 587Change the custom value.
400 588
401=back 589=back
402 590
403=cut 591=cut
404
405package urxvt;
406
407use utf8;
408use strict;
409use Scalar::Util ();
410use List::Util ();
411
412our $TERM;
413our @HOOKNAME;
414our %OPTION;
415our $LIBDIR;
416 592
417BEGIN { 593BEGIN {
418 urxvt->bootstrap; 594 urxvt->bootstrap;
419 595
420 # overwrite perl's warn 596 # overwrite perl's warn
422 my $msg = join "", @_; 598 my $msg = join "", @_;
423 $msg .= "\n" 599 $msg .= "\n"
424 unless $msg =~ /\n$/; 600 unless $msg =~ /\n$/;
425 urxvt::warn ($msg); 601 urxvt::warn ($msg);
426 }; 602 };
427}
428 603
429my @hook_count; 604 # %ENV is the original startup environment
605 delete $ENV{IFS};
606 delete $ENV{CDPATH};
607 delete $ENV{BASH_ENV};
608 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
609}
610
430my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 611my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
431 612
432sub verbose { 613sub verbose {
433 my ($level, $msg) = @_; 614 my ($level, $msg) = @_;
434 warn "$msg\n" if $level <= $verbosity; 615 warn "$msg\n" if $level <= $verbosity;
435} 616}
436 617
437# find on_xxx subs in the package and register them
438# as hooks
439sub register_package($) {
440 my ($pkg) = @_;
441
442 for my $htype (0.. $#HOOKNAME) {
443 my $name = $HOOKNAME[$htype];
444
445 my $ref = $pkg->can ("on_" . lc $name)
446 or next;
447
448 $TERM->{_hook}[$htype]{$pkg} = $ref;
449 $hook_count[$htype]++
450 or set_should_invoke $htype, 1;
451 }
452}
453
454my $extension_pkg = "extension0000"; 618my $extension_pkg = "extension0000";
455my %extension_pkg; 619my %extension_pkg;
456 620
457# load a single script into its own package, once only 621# load a single script into its own package, once only
458sub extension_package($) { 622sub extension_package($) {
464 verbose 3, "loading extension '$path' into package '$pkg'"; 628 verbose 3, "loading extension '$path' into package '$pkg'";
465 629
466 open my $fh, "<:raw", $path 630 open my $fh, "<:raw", $path
467 or die "$path: $!"; 631 or die "$path: $!";
468 632
633 my $source = untaint
469 my $source = "package $pkg; use strict; use utf8;\n" 634 "package $pkg; use strict; use utf8;\n"
470 . "use base urxvt::term::proxy::;\n" 635 . "use base urxvt::term::extension::;\n"
471 . "#line 1 \"$path\"\n{\n" 636 . "#line 1 \"$path\"\n{\n"
472 . (do { local $/; <$fh> }) 637 . (do { local $/; <$fh> })
473 . "\n};\n1"; 638 . "\n};\n1";
474 639
640 eval $source
475 eval $source or die "$path: $@"; 641 or die "$path: $@";
476 642
477 $pkg 643 $pkg
478 } 644 }
479} 645}
480 646
486 my $htype = shift; 652 my $htype = shift;
487 653
488 if ($htype == 0) { # INIT 654 if ($htype == 0) { # INIT
489 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 655 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
490 656
491 my %want_ext; 657 my %ext_arg;
492 658
493 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 659 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
494 if ($_ eq "default") { 660 if ($_ eq "default") {
495 $want_ext{$_}++ for qw(selection option-popup); 661 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
496 } elsif (/^-(.*)$/) { 662 } elsif (/^-(.*)$/) {
497 delete $want_ext{$1}; 663 delete $ext_arg{$1};
664 } elsif (/^([^<]+)<(.*)>$/) {
665 push @{ $ext_arg{$1} }, $2;
498 } else { 666 } else {
499 $want_ext{$_}++; 667 $ext_arg{$_} ||= [];
500 } 668 }
501 } 669 }
502 670
503 for my $ext (keys %want_ext) { 671 while (my ($ext, $argv) = each %ext_arg) {
504 my @files = grep -f $_, map "$_/$ext", @dirs; 672 my @files = grep -f $_, map "$_/$ext", @dirs;
505 673
506 if (@files) { 674 if (@files) {
507 register_package extension_package $files[0]; 675 $TERM->register_package (extension_package $files[0], $argv);
508 } else { 676 } else {
509 warn "perl extension '$ext' not found in perl library search path\n"; 677 warn "perl extension '$ext' not found in perl library search path\n";
510 } 678 }
511 } 679 }
680
681 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
682 warn $@ if $@;
512 } 683 }
513 684
514 $retval = undef; 685 $retval = undef;
515 686
516 if (my $cb = $TERM->{_hook}[$htype]) { 687 if (my $cb = $TERM->{_hook}[$htype]) {
518 if $verbosity >= 10; 689 if $verbosity >= 10;
519 690
520 keys %$cb; 691 keys %$cb;
521 692
522 while (my ($pkg, $cb) = each %$cb) { 693 while (my ($pkg, $cb) = each %$cb) {
523 eval { 694 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
524 $retval = $cb->(
525 $TERM->{_pkg}{$pkg} ||= do {
526 my $proxy = bless { }, $pkg;
527 Scalar::Util::weaken ($proxy->{term} = $TERM);
528 $proxy
529 },
530 @_,
531 ) and last; 695 and last;
532 };
533 warn $@ if $@;#d#
534 }
535 }
536 696
537 if ($htype == 1) { # DESTROY 697 if ($@) {
538 # remove hooks if unused 698 $TERM->ungrab; # better to lose the grab than the session
539 if (my $hook = $TERM->{_hook}) { 699 warn $@;
540 for my $htype (0..$#$hook) {
541 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
542 or set_should_invoke $htype, 0;
543 } 700 }
544 } 701 }
545 702
703 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
704 if $verbosity >= 11;
705 }
706
707 if ($htype == 1) { # DESTROY
546 # clear package objects 708 # clear package objects
547 %$_ = () for values %{ $TERM->{_pkg} }; 709 %$_ = () for values %{ $TERM->{_pkg} };
548 710
549 # clear package 711 # clear package
550 %$TERM = (); 712 %$TERM = ();
551 } 713 }
552 714
553 $retval 715 $retval
554} 716}
555 717
556sub urxvt::term::proxy::AUTOLOAD { 718sub exec_async(@) {
557 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 719 my $pid = fork;
720
721 return
722 if !defined $pid or $pid;
723
724 %ENV = %{ $TERM->env };
725
726 exec @_;
727 _exit 255;
728}
729
730# urxvt::term::extension
731
732package urxvt::term::extension;
733
734sub enable {
735 my ($self, %hook) = @_;
736 my $pkg = $self->{_pkg};
737
738 while (my ($name, $cb) = each %hook) {
739 my $htype = $HOOKTYPE{uc $name};
740 defined $htype
741 or Carp::croak "unsupported hook type '$name'";
742
743 $self->set_should_invoke ($htype, +1)
744 unless exists $self->{term}{_hook}[$htype]{$pkg};
745
746 $self->{term}{_hook}[$htype]{$pkg} = $cb;
747 }
748}
749
750sub disable {
751 my ($self, @hook) = @_;
752 my $pkg = $self->{_pkg};
753
754 for my $name (@hook) {
755 my $htype = $HOOKTYPE{uc $name};
756 defined $htype
757 or Carp::croak "unsupported hook type '$name'";
758
759 $self->set_should_invoke ($htype, -1)
760 if delete $self->{term}{_hook}[$htype]{$pkg};
761 }
762}
763
764our $AUTOLOAD;
765
766sub AUTOLOAD {
767 $AUTOLOAD =~ /:([^:]+)$/
558 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 768 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
559 769
560 eval qq{ 770 eval qq{
561 sub $urxvt::term::proxy::AUTOLOAD { 771 sub $AUTOLOAD {
562 my \$proxy = shift; 772 my \$proxy = shift;
563 \$proxy->{term}->$1 (\@_) 773 \$proxy->{term}->$1 (\@_)
564 } 774 }
565 1 775 1
566 } or die "FATAL: unable to compile method forwarder: $@"; 776 } or die "FATAL: unable to compile method forwarder: $@";
567 777
568 goto &$urxvt::term::proxy::AUTOLOAD; 778 goto &$AUTOLOAD;
569} 779}
780
781sub DESTROY {
782 # nop
783}
784
785# urxvt::destroy_hook
570 786
571sub urxvt::destroy_hook::DESTROY { 787sub urxvt::destroy_hook::DESTROY {
572 ${$_[0]}->(); 788 ${$_[0]}->();
573} 789}
574 790
575sub urxvt::destroy_hook(&) { 791sub urxvt::destroy_hook(&) {
576 bless \shift, urxvt::destroy_hook:: 792 bless \shift, urxvt::destroy_hook::
577} 793}
578 794
795package urxvt::anyevent;
796
797=head2 The C<urxvt::anyevent> Class
798
799The sole purpose of this class is to deliver an interface to the
800C<AnyEvent> module - any module using it will work inside urxvt without
801further programming. The only exception is that you cannot wait on
802condition variables, but non-blocking condvar use is ok. What this means
803is that you cannot use blocking APIs, but the non-blocking variant should
804work.
805
806=cut
807
808our $VERSION = 1;
809
810$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
811push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
812
813sub timer {
814 my ($class, %arg) = @_;
815
816 my $cb = $arg{cb};
817
818 urxvt::timer
819 ->new
820 ->start (urxvt::NOW + $arg{after})
821 ->cb (sub {
822 $_[0]->stop; # need to cancel manually
823 $cb->();
824 })
825}
826
827sub io {
828 my ($class, %arg) = @_;
829
830 my $cb = $arg{cb};
831
832 bless [$arg{fh}, urxvt::iow
833 ->new
834 ->fd (fileno $arg{fh})
835 ->events (($arg{poll} =~ /r/ ? 1 : 0)
836 | ($arg{poll} =~ /w/ ? 2 : 0))
837 ->start
838 ->cb (sub {
839 $cb->(($_[1] & 1 ? 'r' : '')
840 . ($_[1] & 2 ? 'w' : ''));
841 })],
842 urxvt::anyevent::
843}
844
845sub DESTROY {
846 $_[0][1]->stop;
847}
848
849sub condvar {
850 bless \my $flag, urxvt::anyevent::condvar::
851}
852
853sub urxvt::anyevent::condvar::broadcast {
854 ${$_[0]}++;
855}
856
857sub urxvt::anyevent::condvar::wait {
858 unless (${$_[0]}) {
859 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
860 }
861}
862
863package urxvt::term;
864
579=head2 The C<urxvt::term> Class 865=head2 The C<urxvt::term> Class
580 866
581=over 4 867=over 4
582 868
869=cut
870
871# find on_xxx subs in the package and register them
872# as hooks
873sub register_package {
874 my ($self, $pkg, $argv) = @_;
875
876 my $proxy = bless {
877 _pkg => $pkg,
878 argv => $argv,
879 }, $pkg;
880 Scalar::Util::weaken ($proxy->{term} = $self);
881
882 $self->{_pkg}{$pkg} = $proxy;
883
884 for my $name (@HOOKNAME) {
885 if (my $ref = $pkg->can ("on_" . lc $name)) {
886 $proxy->enable ($name => $ref);
887 }
888 }
889}
890
891=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
892
893Creates a new terminal, very similar as if you had started it with system
894C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
895hash which defines the environment of the new terminal.
896
897Croaks (and probably outputs an error message) if the new instance
898couldn't be created. Returns C<undef> if the new instance didn't
899initialise perl, and the terminal object otherwise. The C<init> and
900C<start> hooks will be called during this call.
901
902=cut
903
904sub new {
905 my ($class, $env, @args) = @_;
906
907 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
908}
909
583=item $term->destroy 910=item $term->destroy
584 911
585Destroy the terminal object (close the window, free resources etc.). 912Destroy the terminal object (close the window, free resources
913etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
914watchers (timers, io watchers) are still active.
586 915
587=item $isset = $term->option ($optval[, $set]) 916=item $isset = $term->option ($optval[, $set])
588 917
589Returns true if the option specified by C<$optval> is enabled, and 918Returns true if the option specified by C<$optval> is enabled, and
590optionally change it. All option values are stored by name in the hash 919optionally change it. All option values are stored by name in the hash
634 shade term_name title transparent transparent_all tripleclickwords 963 shade term_name title transparent transparent_all tripleclickwords
635 utmpInhibit visualBell 964 utmpInhibit visualBell
636 965
637=cut 966=cut
638 967
639sub urxvt::term::resource($$;$) { 968sub resource($$;$) {
640 my ($self, $name) = (shift, shift); 969 my ($self, $name) = (shift, shift);
641 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 970 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
642 &urxvt::term::_resource 971 &urxvt::term::_resource
643} 972}
644 973
974=item $value = $term->x_resource ($pattern)
975
976Returns the X-Resource for the given pattern, excluding the program or
977class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
978same value as used by this instance of rxvt-unicode. Returns C<undef> if no
979resource with that pattern exists.
980
981This method should only be called during the C<on_start> hook, as there is
982only one resource database per display, and later invocations might return
983the wrong resources.
984
985=item $success = $term->parse_keysym ($keysym_spec, $command_string)
986
987Adds a keymap translation exactly as specified via a resource. See the
988C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
989
645=item $rend = $term->rstyle ([$new_rstyle]) 990=item $rend = $term->rstyle ([$new_rstyle])
646 991
647Return and optionally change the current rendition. Text that is output by 992Return and optionally change the current rendition. Text that is output by
648the terminal application will use this style. 993the terminal application will use this style.
649 994
659=item ($row, $col) = $term->selection_end ([$row, $col]) 1004=item ($row, $col) = $term->selection_end ([$row, $col])
660 1005
661Return the current values of the selection mark, begin or end positions, 1006Return the current values of the selection mark, begin or end positions,
662and optionally set them to new values. 1007and optionally set them to new values.
663 1008
1009=item $term->selection_make ($eventtime[, $rectangular])
1010
1011Tries to make a selection as set by C<selection_beg> and
1012C<selection_end>. If C<$rectangular> is true (default: false), a
1013rectangular selection will be made. This is the prefered function to make
1014a selection.
1015
664=item $success = $term->selection_grab ($eventtime) 1016=item $success = $term->selection_grab ($eventtime)
665 1017
666Try to request the primary selection from the server (for example, as set 1018Try to request the primary selection text from the server (for example, as
667by the next method). 1019set by the next method). No visual feedback will be given. This function
1020is mostly useful from within C<on_sel_grab> hooks.
668 1021
669=item $oldtext = $term->selection ([$newtext]) 1022=item $oldtext = $term->selection ([$newtext])
670 1023
671Return the current selection text and optionally replace it by C<$newtext>. 1024Return the current selection text and optionally replace it by C<$newtext>.
672 1025
673#=item $term->overlay ($x, $y, $text) 1026=item $term->overlay_simple ($x, $y, $text)
674# 1027
675#Create a simple multi-line overlay box. See the next method for details. 1028Create a simple multi-line overlay box. See the next method for details.
676# 1029
677#=cut 1030=cut
678# 1031
679#sub urxvt::term::scr_overlay { 1032sub overlay_simple {
680# my ($self, $x, $y, $text) = @_; 1033 my ($self, $x, $y, $text) = @_;
681# 1034
682# my @lines = split /\n/, $text; 1035 my @lines = split /\n/, $text;
683# 1036
684# my $w = 0; 1037 my $w = List::Util::max map $self->strwidth ($_), @lines;
685# for (map $self->strwidth ($_), @lines) { 1038
686# $w = $_ if $w < $_;
687# }
688#
689# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 1039 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
690# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 1040 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
691#} 1041
1042 $overlay
1043}
692 1044
693=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 1045=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
694 1046
695Create a new (empty) overlay at the given position with the given 1047Create a new (empty) overlay at the given position with the given
696width/height. C<$rstyle> defines the initial rendition style 1048width/height. C<$rstyle> defines the initial rendition style
731C<$event> I<must> be the event causing the menu to pop up (a button event, 1083C<$event> I<must> be the event causing the menu to pop up (a button event,
732currently). 1084currently).
733 1085
734=cut 1086=cut
735 1087
736sub urxvt::term::popup { 1088sub popup {
737 my ($self, $event) = @_; 1089 my ($self, $event) = @_;
738 1090
739 $self->grab ($event->{time}, 1) 1091 $self->grab ($event->{time}, 1)
740 or return; 1092 or return;
741 1093
763 1115
764=item $string = $term->locale_decode ($octets) 1116=item $string = $term->locale_decode ($octets)
765 1117
766Convert the given locale-encoded octets into a perl string. 1118Convert the given locale-encoded octets into a perl string.
767 1119
1120=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1121
1122XORs the rendition values in the given span with the provided value
1123(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1124refresh hooks to provide effects similar to the selection.
1125
1126=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1127
1128Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1129whitespace will additionally be xored with the C<$rstyle2>, which defaults
1130to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1131it instead. Both styles I<MUST NOT> contain font styles.
1132
1133=item $term->scr_bell
1134
1135Ring the bell!
1136
768=item $term->scr_add_lines ($string) 1137=item $term->scr_add_lines ($string)
769 1138
770Write the given text string to the screen, as if output by the application 1139Write the given text string to the screen, as if output by the application
771running inside the terminal. It may not contain command sequences (escape 1140running inside the terminal. It may not contain command sequences (escape
772codes), but is free to use line feeds, carriage returns and tabs. The 1141codes), but is free to use line feeds, carriage returns and tabs. The
786 1155
787Write the octets given in C<$data> to the tty (i.e. as program input). To 1156Write the octets given in C<$data> to the tty (i.e. as program input). To
788pass characters instead of octets, you should convert your strings first 1157pass characters instead of octets, you should convert your strings first
789to the locale-specific encoding using C<< $term->locale_encode >>. 1158to the locale-specific encoding using C<< $term->locale_encode >>.
790 1159
1160=item $old_events = $term->pty_ev_events ([$new_events])
1161
1162Replaces the event mask of the pty watcher by the given event mask. Can
1163be used to suppress input and output handling to the pty/tty. See the
1164description of C<< urxvt::timer->events >>. Make sure to always restore
1165the previous value.
1166
791=item $windowid = $term->parent 1167=item $windowid = $term->parent
792 1168
793Return the window id of the toplevel window. 1169Return the window id of the toplevel window.
794 1170
795=item $windowid = $term->vt 1171=item $windowid = $term->vt
796 1172
797Return the window id of the terminal window. 1173Return the window id of the terminal window.
798 1174
1175=item $term->vt_emask_add ($x_event_mask)
1176
1177Adds the specified events to the vt event mask. Useful e.g. when you want
1178to receive pointer events all the times:
1179
1180 $term->vt_emask_add (urxvt::PointerMotionMask);
1181
799=item $window_width = $term->width 1182=item $window_width = $term->width
800 1183
801=item $window_height = $term->height 1184=item $window_height = $term->height
802 1185
803=item $font_width = $term->fwidth 1186=item $font_width = $term->fwidth
816 1199
817=item $max_scrollback = $term->saveLines 1200=item $max_scrollback = $term->saveLines
818 1201
819=item $nrow_plus_saveLines = $term->total_rows 1202=item $nrow_plus_saveLines = $term->total_rows
820 1203
821=item $lines_in_scrollback = $term->nsaved 1204=item $topmost_scrollback_row = $term->top_row
822 1205
823Return various integers describing terminal characteristics. 1206Return various integers describing terminal characteristics.
1207
1208=item $x_display = $term->display_id
1209
1210Return the DISPLAY used by rxvt-unicode.
1211
1212=item $lc_ctype = $term->locale
1213
1214Returns the LC_CTYPE category string used by this rxvt-unicode.
1215
1216=item $env = $term->env
1217
1218Returns a copy of the environment in effect for the terminal as a hashref
1219similar to C<\%ENV>.
1220
1221=cut
1222
1223sub env {
1224 if (my $env = $_[0]->_env) {
1225 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1226 } else {
1227 +{ %ENV }
1228 }
1229}
824 1230
825=item $modifiermask = $term->ModLevel3Mask 1231=item $modifiermask = $term->ModLevel3Mask
826 1232
827=item $modifiermask = $term->ModMetaMask 1233=item $modifiermask = $term->ModMetaMask
828 1234
831Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1237Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
832AltGr), the meta key (often Alt) and the num lock key, if applicable. 1238AltGr), the meta key (often Alt) and the num lock key, if applicable.
833 1239
834=item $view_start = $term->view_start ([$newvalue]) 1240=item $view_start = $term->view_start ([$newvalue])
835 1241
836Returns the negative row number of the topmost line. Minimum value is 1242Returns the row number of the topmost displayed line. Maximum value is
837C<0>, which displays the normal terminal contents. Larger values scroll 1243C<0>, which displays the normal terminal contents. Lower values scroll
838this many lines into the scrollback buffer. 1244this many lines into the scrollback buffer.
839 1245
840=item $term->want_refresh 1246=item $term->want_refresh
841 1247
842Requests a screen refresh. At the next opportunity, rxvt-unicode will 1248Requests a screen refresh. At the next opportunity, rxvt-unicode will
921Return the row number of the first/last row of the line, respectively. 1327Return the row number of the first/last row of the line, respectively.
922 1328
923=item $offset = $line->offset_of ($row, $col) 1329=item $offset = $line->offset_of ($row, $col)
924 1330
925Returns the character offset of the given row|col pair within the logical 1331Returns the character offset of the given row|col pair within the logical
926line. 1332line. Works for rows outside the line, too, and returns corresponding
1333offsets outside the string.
927 1334
928=item ($row, $col) = $line->coord_of ($offset) 1335=item ($row, $col) = $line->coord_of ($offset)
929 1336
930Translates a string offset into terminal coordinates again. 1337Translates a string offset into terminal coordinates again.
931 1338
932=back 1339=back
933 1340
934=cut 1341=cut
935 1342
936sub urxvt::term::line { 1343sub line {
937 my ($self, $row) = @_; 1344 my ($self, $row) = @_;
938 1345
939 my $maxrow = $self->nrow - 1; 1346 my $maxrow = $self->nrow - 1;
940 1347
941 my ($beg, $end) = ($row, $row); 1348 my ($beg, $end) = ($row, $row);
1005 $offset / $self->{ncol} + $self->{beg}, 1412 $offset / $self->{ncol} + $self->{beg},
1006 $offset % $self->{ncol} 1413 $offset % $self->{ncol}
1007 ) 1414 )
1008} 1415}
1009 1416
1010=item ($row, $col) = $line->coord_of ($offset)
1011=item $text = $term->special_encode $string 1417=item $text = $term->special_encode $string
1012 1418
1013Converts a perl string into the special encoding used by rxvt-unicode, 1419Converts a perl string into the special encoding used by rxvt-unicode,
1014where one character corresponds to one screen cell. See 1420where one character corresponds to one screen cell. See
1015C<< $term->ROW_t >> for details. 1421C<< $term->ROW_t >> for details.
1017=item $string = $term->special_decode $text 1423=item $string = $term->special_decode $text
1018 1424
1019Converts rxvt-unicodes text reprsentation into a perl string. See 1425Converts rxvt-unicodes text reprsentation into a perl string. See
1020C<< $term->ROW_t >> for details. 1426C<< $term->ROW_t >> for details.
1021 1427
1428=item $success = $term->grab_button ($button, $modifiermask)
1429
1430Registers a synchronous button grab. See the XGrabButton manpage.
1431
1432=item $success = $term->grab ($eventtime[, $sync])
1433
1434Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1435synchronous (C<$sync> is true). Also remembers the grab timestampe.
1436
1437=item $term->allow_events_async
1438
1439Calls XAllowEvents with AsyncBoth for the most recent grab.
1440
1441=item $term->allow_events_sync
1442
1443Calls XAllowEvents with SyncBoth for the most recent grab.
1444
1445=item $term->allow_events_replay
1446
1447Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1448recent grab.
1449
1450=item $term->ungrab
1451
1452Calls XUngrab for the most recent grab. Is called automatically on
1453evaluation errors, as it is better to lose the grab in the error case as
1454the session.
1455
1022=back 1456=back
1023 1457
1458=cut
1459
1460package urxvt::popup;
1461
1024=head2 The C<urxvt::popup> Class 1462=head2 The C<urxvt::popup> Class
1025 1463
1026=over 4 1464=over 4
1027 1465
1028=cut 1466=cut
1029
1030package urxvt::popup;
1031 1467
1032sub add_item { 1468sub add_item {
1033 my ($self, $item) = @_; 1469 my ($self, $item) = @_;
1034 1470
1035 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal}; 1471 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1039 $item->{render} ||= sub { $_[0]{text} }; 1475 $item->{render} ||= sub { $_[0]{text} };
1040 1476
1041 push @{ $self->{item} }, $item; 1477 push @{ $self->{item} }, $item;
1042} 1478}
1043 1479
1044sub add_separator { 1480=item $popup->add_title ($title)
1045 my ($self, $sep) = @_;
1046 1481
1047 $sep ||= "═"; 1482Adds a non-clickable title to the popup.
1048 1483
1049 $self->add_item ({ 1484=cut
1050 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1051 text => "",
1052 render => sub { $sep x $urxvt::TERM->ncol },
1053 activate => sub { },
1054 });
1055}
1056 1485
1057sub add_title { 1486sub add_title {
1058 my ($self, $title) = @_; 1487 my ($self, $title) = @_;
1059 1488
1060 $self->add_item ({ 1489 $self->add_item ({
1062 text => $title, 1491 text => $title,
1063 activate => sub { }, 1492 activate => sub { },
1064 }); 1493 });
1065} 1494}
1066 1495
1496=item $popup->add_separator ([$sepchr])
1497
1498Creates a separator, optionally using the character given as C<$sepchr>.
1499
1500=cut
1501
1502sub add_separator {
1503 my ($self, $sep) = @_;
1504
1505 $sep ||= "=";
1506
1507 $self->add_item ({
1508 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1509 text => "",
1510 render => sub { $sep x $self->{term}->ncol },
1511 activate => sub { },
1512 });
1513}
1514
1515=item $popup->add_button ($text, $cb)
1516
1517Adds a clickable button to the popup. C<$cb> is called whenever it is
1518selected.
1519
1520=cut
1521
1067sub add_button { 1522sub add_button {
1068 my ($self, $text, $cb) = @_; 1523 my ($self, $text, $cb) = @_;
1069 1524
1070 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); 1525 $self->add_item ({ type => "button", text => $text, activate => $cb});
1071} 1526}
1527
1528=item $popup->add_toggle ($text, $cb, $initial_value)
1529
1530Adds a toggle/checkbox item to the popup. Teh callback gets called
1531whenever it gets toggled, with a boolean indicating its value as its first
1532argument.
1533
1534=cut
1072 1535
1073sub add_toggle { 1536sub add_toggle {
1074 my ($self, $text, $cb, $value) = @_; 1537 my ($self, $text, $cb, $value) = @_;
1075 1538
1076 my $item; $item = { 1539 my $item; $item = {
1077 type => "button", 1540 type => "button",
1078 text => " $text", 1541 text => " $text",
1079 value => $value, 1542 value => $value,
1080 render => sub { ($item->{value} ? "* " : " ") . $text }, 1543 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1081 activate => sub { $cb->($item->{value} = !$item->{value}); }, 1544 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1082 }; 1545 };
1083 1546
1084 $self->add_item ($item); 1547 $self->add_item ($item);
1085} 1548}
1549
1550=item $popup->show
1551
1552Displays the popup (which is initially hidden).
1553
1554=cut
1086 1555
1087sub show { 1556sub show {
1088 my ($self) = @_; 1557 my ($self) = @_;
1089 1558
1090 local $urxvt::popup::self = $self; 1559 local $urxvt::popup::self = $self;
1091 1560
1561 my $env = $self->{term}->env;
1562 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1563 delete $env->{LC_ALL};
1564 $env->{LC_CTYPE} = $self->{term}->locale;
1565
1566 urxvt::term->new ($env, $self->{term}->resource ("name"),
1092 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1567 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1093 "--transient-for" => $self->{term}->parent, 1568 "--transient-for" => $self->{term}->parent,
1569 "-display" => $self->{term}->display_id,
1094 "-pe" => "urxvt-popup") 1570 "-pe" => "urxvt-popup")
1095 or die "unable to create popup window\n"; 1571 or die "unable to create popup window\n";
1096} 1572}
1097 1573
1098sub DESTROY { 1574sub DESTROY {
1099 my ($self) = @_; 1575 my ($self) = @_;
1100 1576
1577 delete $self->{term}{_destroy}{$self};
1101 $self->{term}->ungrab; 1578 $self->{term}->ungrab;
1102} 1579}
1580
1581=back
1103 1582
1104=head2 The C<urxvt::timer> Class 1583=head2 The C<urxvt::timer> Class
1105 1584
1106This class implements timer watchers/events. Time is represented as a 1585This class implements timer watchers/events. Time is represented as a
1107fractional number of seconds since the epoch. Example: 1586fractional number of seconds since the epoch. Example:
1160 1639
1161 $term->{socket} = ... 1640 $term->{socket} = ...
1162 $term->{iow} = urxvt::iow 1641 $term->{iow} = urxvt::iow
1163 ->new 1642 ->new
1164 ->fd (fileno $term->{socket}) 1643 ->fd (fileno $term->{socket})
1165 ->events (1) # wait for read data 1644 ->events (urxvt::EVENT_READ)
1166 ->start 1645 ->start
1167 ->cb (sub { 1646 ->cb (sub {
1168 my ($iow, $revents) = @_; 1647 my ($iow, $revents) = @_;
1169 # $revents must be 1 here, no need to check 1648 # $revents must be 1 here, no need to check
1170 sysread $term->{socket}, my $buf, 8192 1649 sysread $term->{socket}, my $buf, 8192
1187 1666
1188Set the filedescriptor (not handle) to watch. 1667Set the filedescriptor (not handle) to watch.
1189 1668
1190=item $iow = $iow->events ($eventmask) 1669=item $iow = $iow->events ($eventmask)
1191 1670
1192Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 1671Set the event mask to watch. The only allowed values are
1193data, Bit #1 (value C<2>) enables watching for write data. 1672C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1673together, or C<urxvt::EVENT_NONE>.
1194 1674
1195=item $iow = $iow->start 1675=item $iow = $iow->start
1196 1676
1197Start watching for requested events on the given handle. 1677Start watching for requested events on the given handle.
1198 1678
1209This variable controls the verbosity level of the perl extension. Higher 1689This variable controls the verbosity level of the perl extension. Higher
1210numbers indicate more verbose output. 1690numbers indicate more verbose output.
1211 1691
1212=over 4 1692=over 4
1213 1693
1214=item =0 - only fatal messages 1694=item == 0 - fatal messages
1215 1695
1216=item =3 - script loading and management 1696=item >= 3 - script loading and management
1217 1697
1218=item =10 - all events received 1698=item >=10 - all called hooks
1699
1700=item >=11 - hook reutrn values
1219 1701
1220=back 1702=back
1221 1703
1222=head1 AUTHOR 1704=head1 AUTHOR
1223 1705

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines