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.112 by root, Thu Jan 19 21:02:06 2006 UTC

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
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
44(More) intelligent selection. This extension tries to be more intelligent 48(More) intelligent selection. This extension tries to be more intelligent
45when the user extends selections (double-click). Right now, it tries to 49when the user extends selections (double-click and further clicks). Right
46select urls and complete shell-quoted arguments, which is very convenient, 50now, it tries to select words, urls and complete shell-quoted
47too, if your F<ls> supports C<--quoting-style=shell>. 51arguments, which is very convenient, too, if your F<ls> supports
52C<--quoting-style=shell>.
48 53
54A double-click usually selects the word under the cursor, further clicks
55will enlarge the selection.
56
57The selection works by trying to match a number of regexes and displaying
58them in increasing order of length. You can add your own regexes by
59specifying resources of the form:
60
61 URxvt.selection.pattern-0: perl-regex
62 URxvt.selection.pattern-1: perl-regex
63 ...
64
65The index number (0, 1...) must not have any holes, and each regex must
66contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything
68between two vertical bars:
69
70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72You can look at the source of the selection extension to see more
73interesting uses, such as parsing a line from beginning to end.
74
49It also offers the following bindable keyboard command: 75This extension also offers following bindable keyboard commands:
50 76
51=over 4 77=over 4
52 78
53=item rot13 79=item rot13
54 80
67 93
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection 94Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
70evalution, web-browser starting etc.), depending on content. 96evalution, web-browser starting etc.), depending on content.
71 97
98Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed.
101
102It's sole argument is the popup menu, which can be modified. The selection
103is in C<$_>, which can be used to decide wether to add something or not.
104It should either return nothing or a string and a code reference. The
105string will be used as button text and the code reference will be called
106when the button gets activated and should transform C<$_>.
107
108The following will add an entry C<a to b> that transforms all C<a>s in
109the selection to C<b>s, but only if the selection currently contains any
110C<a>s:
111
112 push @{ $self->{term}{selection_popup_hook} }, sub {
113 /a/ ? ("a to be" => sub { s/a/b/g }
114 : ()
115 };
116
72=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
73 118
74Adds regex search functionality to the scrollback buffer, triggered 119Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 120by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 121input/output is suspended and a regex is displayed at the bottom of the
122screen.
77 123
78C</> starts an incremental regex search, C<n> searches further, C<p> or 124Inputting 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 125search. 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> 126search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 127bottom. C<Escape> leaves search mode and returns to the point where search
128was started, while C<Enter> or C<Return> stay at the current position and
129additionally stores the first match in the current line into the primary
130selection.
82 131
83=item digital-clock 132=item selection-autotransform
84 133
85Displays a digital clock using the built-in overlay. 134This selection allows you to do automatic transforms on a selection
135whenever a selection is made.
136
137It works by specifying perl snippets (most useful is a single C<s///>
138operator) that modify C<$_> as resources:
139
140 URxvt.selection-autotransform.0: transform
141 URxvt.selection-autotransform.1: transform
142 ...
143
144For example, the following will transform selections of the form
145C<filename:number>, often seen in compiler messages, into C<vi +$filename
146$word>:
147
148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149
150And this example matches the same,but replaces it with vi-commands you can
151paste directly into your (vi :) editor:
152
153 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154
155Of course, this can be modified to suit your needs and your editor :)
156
157To expand the example above to typical perl error messages ("XXX at
158FILENAME line YYY."), you need a slightly more elaborate solution:
159
160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file.
86 166
87=item mark-urls 167=item mark-urls
88 168
89Uses per-line display filtering (C<on_line_update>) to underline urls. 169Uses per-line display filtering (C<on_line_update>) to underline urls and
170make them clickable. When middle-clicked, the program specified in the
171resource C<urlLauncher> (default C<x-www-browser>) will be started with
172the URL as first argument.
173
174=item automove-background
175
176This is basically a one-line extension that dynamically changes the background pixmap offset
177to the window position, in effect creating the same effect as pseudo transparency with
178a custom pixmap. No scaling is supported in this mode. Exmaple:
179
180 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
90 181
91=item block-graphics-to-ascii 182=item block-graphics-to-ascii
92 183
93A not very useful example of filtering all text output to the terminal, 184A not very useful example of filtering all text output to the terminal,
94by replacing all line-drawing characters (U+2500 .. U+259F) by a 185by replacing all line-drawing characters (U+2500 .. U+259F) by a
95similar-looking ascii character. 186similar-looking ascii character.
96 187
188=item digital-clock
189
190Displays a digital clock using the built-in overlay.
191
97=item example-refresh-hooks 192=item example-refresh-hooks
98 193
99Displays a very simple digital clock in the upper right corner of the 194Displays a very simple digital clock in the upper right corner of the
100window. Illustrates overwriting the refresh callbacks to create your own 195window. Illustrates overwriting the refresh callbacks to create your own
101overlays or changes. 196overlays or changes.
197
198=item selection-pastebin
199
200This is a little rarely useful extension that Uploads the selection as
201textfile to a remote site (or does other things). (The implementation is
202not currently secure for use in a multiuser environment as it writes to
203F</tmp> directly.).
204
205It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
206i.e.
207
208 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
209
210Pressing this combination runs a command with C<%> replaced by the name of
211the textfile. This command can be set via a resource:
212
213 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
214
215And the default is likely not useful to anybody but the few people around
216here :)
217
218The name of the textfile is the hex encoded md5 sum of the selection, so
219the same content should lead to the same filename.
220
221After a successful upload the selection will be replaced by the text given
222in the C<selection-pastebin-url> resource (again, the % is the placeholder
223for the filename):
224
225 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
102 226
103=back 227=back
104 228
105=head1 API DOCUMENTATION 229=head1 API DOCUMENTATION
106 230
123=over 4 247=over 4
124 248
125=item $text 249=item $text
126 250
127Rxvt-unicodes special way of encoding text, where one "unicode" character 251Rxvt-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. 252always represents one screen cell. See L<ROW_t> for a discussion of this format.
129 253
130=item $string 254=item $string
131 255
132A perl text string, with an emphasis on I<text>. It can store all unicode 256A 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 257characters and is to be distinguished with text encoded in a specific
179called whenever the relevant event happens. 303called whenever the relevant event happens.
180 304
181The first argument passed to them is an extension oject as described in 305The first argument passed to them is an extension oject as described in
182the in the C<Extension Objects> section. 306the in the C<Extension Objects> section.
183 307
184B<All> of these hooks must return a boolean value. If it is true, then the 308B<All> of these hooks must return a boolean value. If any of the called
185event counts as being I<consumed>, and the invocation of other hooks is 309hooks returns true, then the event counts as being I<consumed>, and the
186skipped, and the relevant action might not be carried out by the C++ code. 310relevant action might not be carried out by the C++ code.
187 311
188I<< When in doubt, return a false value (preferably C<()>). >> 312I<< When in doubt, return a false value (preferably C<()>). >>
189 313
190=over 4 314=over 4
191 315
192=item on_init $term 316=item on_init $term
193 317
194Called after a new terminal object has been initialized, but before 318Called after a new terminal object has been initialized, but before
195windows are created or the command gets run. Most methods are unsafe to 319windows are created or the command gets run. Most methods are unsafe to
196call or deliver senseless data, as terminal size and other characteristics 320call or deliver senseless data, as terminal size and other characteristics
197have not yet been determined. You can safely query and change resources, 321have not yet been determined. You can safely query and change resources
198though. 322and options, though. For many purposes the C<on_start> hook is a better
323place.
324
325=item on_start $term
326
327Called at the very end of initialisation of a new terminal, just before
328returning to the mainloop.
199 329
200=item on_reset $term 330=item on_reset $term
201 331
202Called after the screen is "reset" for any reason, such as resizing or 332Called after the screen is "reset" for any reason, such as resizing or
203control sequences. Here is where you can react on changes to size-related 333control sequences. Here is where you can react on changes to size-related
204variables. 334variables.
205 335
206=item on_start $term 336=item on_child_start $term, $pid
207 337
208Called at the very end of initialisation of a new terminal, just before 338Called just after the child process has been C<fork>ed.
209returning to the mainloop. 339
340=item on_child_exit $term, $status
341
342Called just after the child process has exited. C<$status> is the status
343from C<waitpid>.
210 344
211=item on_sel_make $term, $eventtime 345=item on_sel_make $term, $eventtime
212 346
213Called whenever a selection has been made by the user, but before the 347Called whenever a selection has been made by the user, but before the
214selection text is copied, so changes to the beginning, end or type of the 348selection text is copied, so changes to the beginning, end or type of the
228=item on_sel_extend $term 362=item on_sel_extend $term
229 363
230Called whenever the user tries to extend the selection (e.g. with a double 364Called whenever the user tries to extend the selection (e.g. with a double
231click) and is either supposed to return false (normal operation), or 365click) and is either supposed to return false (normal operation), or
232should extend the selection itelf and return true to suppress the built-in 366should extend the selection itelf and return true to suppress the built-in
233processing. 367processing. This can happen multiple times, as long as the callback
368returns true, it will be called on every further click by the user and is
369supposed to enlarge the selection more and more, if possible.
234 370
235See the F<selection> example extension. 371See the F<selection> example extension.
236 372
237=item on_view_change $term, $offset 373=item on_view_change $term, $offset
238 374
305 441
306Called whenever the user presses a key combination that has a 442Called whenever the user presses a key combination that has a
307C<perl:string> action bound to it (see description of the B<keysym> 443C<perl:string> action bound to it (see description of the B<keysym>
308resource in the @@RXVT_NAME@@(1) manpage). 444resource in the @@RXVT_NAME@@(1) manpage).
309 445
446=item on_x_event $term, $event
447
448Called on every X event received on the vt window (and possibly other
449windows). Should only be used as a last resort. Most event structure
450members are not passed.
451
310=item on_focus_in $term 452=item on_focus_in $term
311 453
312Called whenever the window gets the keyboard focus, before rxvt-unicode 454Called whenever the window gets the keyboard focus, before rxvt-unicode
313does focus in processing. 455does focus in processing.
314 456
315=item on_focus_out $term 457=item on_focus_out $term
316 458
317Called wheneever the window loses keyboard focus, before rxvt-unicode does 459Called wheneever the window loses keyboard focus, before rxvt-unicode does
318focus out processing. 460focus out processing.
461
462=item on_configure_notify $term, $event
319 463
320=item on_key_press $term, $event, $keysym, $octets 464=item on_key_press $term, $event, $keysym, $octets
321 465
322=item on_key_release $term, $event, $keysym 466=item on_key_release $term, $event, $keysym
323 467
340 484
341C<on_key_press> additionally receives the string rxvt-unicode would 485C<on_key_press> additionally receives the string rxvt-unicode would
342output, if any, in locale-specific encoding. 486output, if any, in locale-specific encoding.
343 487
344subwindow. 488subwindow.
345
346=back
347
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 489
471=back 490=back
472 491
473=cut 492=cut
474 493
489our $LIBDIR; 508our $LIBDIR;
490our $RESNAME; 509our $RESNAME;
491our $RESCLASS; 510our $RESCLASS;
492our $RXVTNAME; 511our $RXVTNAME;
493 512
513=head2 Variables in the C<urxvt> Package
514
515=over 4
516
517=item $urxvt::LIBDIR
518
519The rxvt-unicode library directory, where, among other things, the perl
520modules and scripts are stored.
521
522=item $urxvt::RESCLASS, $urxvt::RESCLASS
523
524The resource class and name rxvt-unicode uses to look up X resources.
525
526=item $urxvt::RXVTNAME
527
528The basename of the installed binaries, usually C<urxvt>.
529
530=item $urxvt::TERM
531
532The current terminal. This variable stores the current C<urxvt::term>
533object, whenever a callback/hook is executing.
534
535=back
536
537=head2 Functions in the C<urxvt> Package
538
539=over 4
540
541=item urxvt::fatal $errormessage
542
543Fatally aborts execution with the given error message. Avoid at all
544costs! The only time this is acceptable is when the terminal process
545starts up.
546
547=item urxvt::warn $string
548
549Calls C<rxvt_warn> with the given string which should not include a
550newline. The module also overwrites the C<warn> builtin with a function
551that calls this function.
552
553Using this function has the advantage that its output ends up in the
554correct place, e.g. on stderr of the connecting urxvtc client.
555
556Messages have a size limit of 1023 bytes currently.
557
558=item $time = urxvt::NOW
559
560Returns the "current time" (as per the event loop).
561
562=item urxvt::CurrentTime
563
564=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
565Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
566Button4Mask, Button5Mask, AnyModifier
567
568=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
569ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
570PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
571Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
572KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
573ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
574FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
575
576=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
577EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
578GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
579UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
580ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
581CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
582SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
583
584Various constants for use in X calls and event processing.
585
586=back
587
588=head2 RENDITION
589
590Rendition bitsets contain information about colour, font, font styles and
591similar information for each screen cell.
592
593The following "macros" deal with changes in rendition sets. You should
594never just create a bitset, you should always modify an existing one,
595as they contain important information required for correct operation of
596rxvt-unicode.
597
598=over 4
599
600=item $rend = urxvt::DEFAULT_RSTYLE
601
602Returns the default rendition, as used when the terminal is starting up or
603being reset. Useful as a base to start when creating renditions.
604
605=item $rend = urxvt::OVERLAY_RSTYLE
606
607Return the rendition mask used for overlays by default.
608
609=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
610
611Return the bit that enabled bold, italic, blink, reverse-video and
612underline, respectively. To enable such a style, just logically OR it into
613the bitset.
614
615=item $foreground = urxvt::GET_BASEFG $rend
616
617=item $background = urxvt::GET_BASEBG $rend
618
619Return the foreground/background colour index, respectively.
620
621=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
622
623=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
624
625Replace the foreground/background colour in the rendition mask with the
626specified one.
627
628=item $value = urxvt::GET_CUSTOM $rend
629
630Return the "custom" value: Every rendition has 5 bits for use by
631extensions. They can be set and changed as you like and are initially
632zero.
633
634=item $rend = urxvt::SET_CUSTOM $rend, $new_value
635
636Change the custom value.
637
638=back
639
640=cut
641
494BEGIN { 642BEGIN {
495 urxvt->bootstrap;
496
497 # overwrite perl's warn 643 # overwrite perl's warn
498 *CORE::GLOBAL::warn = sub { 644 *CORE::GLOBAL::warn = sub {
499 my $msg = join "", @_; 645 my $msg = join "", @_;
500 $msg .= "\n" 646 $msg .= "\n"
501 unless $msg =~ /\n$/; 647 unless $msg =~ /\n$/;
502 urxvt::warn ($msg); 648 urxvt::warn ($msg);
503 }; 649 };
504
505 delete $ENV{IFS};
506 delete $ENV{CDPATH};
507 delete $ENV{BASH_ENV};
508 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509} 650}
510 651
511my @hook_count;
512my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 652my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513 653
514sub verbose { 654sub verbose {
515 my ($level, $msg) = @_; 655 my ($level, $msg) = @_;
516 warn "$msg\n" if $level <= $verbosity; 656 warn "$msg\n" if $level <= $verbosity;
517} 657}
518 658
519my $extension_pkg = "extension0000";
520my %extension_pkg; 659my %extension_pkg;
521 660
522# load a single script into its own package, once only 661# load a single script into its own package, once only
523sub extension_package($) { 662sub extension_package($) {
524 my ($path) = @_; 663 my ($path) = @_;
525 664
665 no strict 'refs';
666
526 $extension_pkg{$path} ||= do { 667 $extension_pkg{$path} ||= do {
527 my $pkg = "urxvt::" . ($extension_pkg++); 668 $path =~ /([^\/\\]+)$/;
669 my $pkg = $1;
670 $pkg =~ s/[^[:word:]]/_/g;
671 $pkg = "urxvt::ext::$pkg";
528 672
529 verbose 3, "loading extension '$path' into package '$pkg'"; 673 verbose 3, "loading extension '$path' into package '$pkg'";
530 674
531 open my $fh, "<:raw", $path 675 open my $fh, "<:raw", $path
532 or die "$path: $!"; 676 or die "$path: $!";
533 677
678 @{"$pkg\::ISA"} = urxvt::term::extension::;
679
534 my $source = untaint 680 my $source =
535 "package $pkg; use strict; use utf8;\n" 681 "package $pkg; use strict; use utf8;\n"
536 . "use base urxvt::term::extension::;\n"
537 . "#line 1 \"$path\"\n{\n" 682 . "#line 1 \"$path\"\n{\n"
538 . (do { local $/; <$fh> }) 683 . (do { local $/; <$fh> })
539 . "\n};\n1"; 684 . "\n};\n1";
540 685
541 eval $source 686 eval $source
590 if $verbosity >= 10; 735 if $verbosity >= 10;
591 736
592 keys %$cb; 737 keys %$cb;
593 738
594 while (my ($pkg, $cb) = each %$cb) { 739 while (my ($pkg, $cb) = each %$cb) {
595 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 740 $retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
596 and last;
597 741
598 if ($@) { 742 if ($@) {
599 $TERM->ungrab; # better to lose the grab than the session 743 $TERM->ungrab; # better to lose the grab than the session
600 warn $@; 744 warn $@;
601 } 745 }
602 } 746 }
747
748 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
749 if $verbosity >= 11;
603 } 750 }
604 751
605 if ($htype == 1) { # DESTROY 752 if ($htype == 1) { # DESTROY
606 if (my $hook = delete $TERM->{_hook}) {
607 for my $htype (0..$#$hook) {
608 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
609 or set_should_invoke $htype, 0;
610 }
611 }
612
613 # clear package objects 753 # clear package objects
614 %$_ = () for values %{ $TERM->{_pkg} }; 754 %$_ = () for values %{ $TERM->{_pkg} };
615 755
616 # clear package 756 # clear package
617 %$TERM = (); 757 %$TERM = ();
631 while (my ($name, $cb) = each %hook) { 771 while (my ($name, $cb) = each %hook) {
632 my $htype = $HOOKTYPE{uc $name}; 772 my $htype = $HOOKTYPE{uc $name};
633 defined $htype 773 defined $htype
634 or Carp::croak "unsupported hook type '$name'"; 774 or Carp::croak "unsupported hook type '$name'";
635 775
776 $self->set_should_invoke ($htype, +1)
636 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 777 unless exists $self->{term}{_hook}[$htype]{$pkg};
637 $hook_count[$htype]++
638 or urxvt::set_should_invoke $htype, 1;
639 }
640 778
641 $self->{term}{_hook}[$htype]{$pkg} = $cb; 779 $self->{term}{_hook}[$htype]{$pkg} = $cb;
642 } 780 }
643} 781}
644 782
649 for my $name (@hook) { 787 for my $name (@hook) {
650 my $htype = $HOOKTYPE{uc $name}; 788 my $htype = $HOOKTYPE{uc $name};
651 defined $htype 789 defined $htype
652 or Carp::croak "unsupported hook type '$name'"; 790 or Carp::croak "unsupported hook type '$name'";
653 791
792 $self->set_should_invoke ($htype, -1)
654 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 793 if delete $self->{term}{_hook}[$htype]{$pkg};
655 --$hook_count[$htype]
656 or urxvt::set_should_invoke $htype, 0;
657 }
658 } 794 }
659} 795}
660 796
661our $AUTOLOAD; 797our $AUTOLOAD;
662 798
783 $proxy->enable ($name => $ref); 919 $proxy->enable ($name => $ref);
784 } 920 }
785 } 921 }
786} 922}
787 923
924=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
925
926Creates a new terminal, very similar as if you had started it with system
927C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
928hash which defines the environment of the new terminal.
929
930Croaks (and probably outputs an error message) if the new instance
931couldn't be created. Returns C<undef> if the new instance didn't
932initialise perl, and the terminal object otherwise. The C<init> and
933C<start> hooks will be called during this call.
934
935=cut
936
937sub new {
938 my ($class, $env, @args) = @_;
939
940 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
941}
942
788=item $term->destroy 943=item $term->destroy
789 944
790Destroy the terminal object (close the window, free resources 945Destroy the terminal object (close the window, free resources
791etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 946etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792watchers (timers, io watchers) are still active. 947watchers (timers, io watchers) are still active.
793 948
949=item $term->exec_async ($cmd[, @args])
950
951Works like the combination of the C<fork>/C<exec> builtins, which executes
952("starts") programs in the background. This function takes care of setting
953the user environment before exec'ing the command (e.g. C<PATH>) and should
954be preferred over explicit calls to C<exec> or C<system>.
955
956Returns the pid of the subprocess or C<undef> on error.
957
958=cut
959
960sub exec_async {
961 my $self = shift;
962
963 my $pid = fork;
964
965 return $pid
966 if !defined $pid or $pid;
967
968 %ENV = %{ $self->env };
969
970 exec @_;
971 urxvt::_exit 255;
972}
973
794=item $isset = $term->option ($optval[, $set]) 974=item $isset = $term->option ($optval[, $set])
795 975
796Returns true if the option specified by C<$optval> is enabled, and 976Returns true if the option specified by C<$optval> is enabled, and
797optionally change it. All option values are stored by name in the hash 977optionally change it. All option values are stored by name in the hash
798C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 978C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
800Here is a a likely non-exhaustive list of option names, please see the 980Here is a a likely non-exhaustive list of option names, please see the
801source file F</src/optinc.h> to see the actual list: 981source file F</src/optinc.h> to see the actual list:
802 982
803 borderLess console cursorBlink cursorUnderline hold iconic insecure 983 borderLess console cursorBlink cursorUnderline hold iconic insecure
804 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 984 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
805 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 985 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
806 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 986 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
807 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 987 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
808 tripleclickwords utmpInhibit visualBell 988 transparent tripleclickwords utmpInhibit visualBell
809 989
810=item $value = $term->resource ($name[, $newval]) 990=item $value = $term->resource ($name[, $newval])
811 991
812Returns the current resource value associated with a given name and 992Returns the current resource value associated with a given name and
813optionally sets a new value. Setting values is most useful in the C<init> 993optionally sets a new value. Setting values is most useful in the C<init>
830 1010
831 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1011 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
832 borderLess color cursorBlink cursorUnderline cutchars delete_key 1012 borderLess color cursorBlink cursorUnderline cutchars delete_key
833 display_name embed ext_bwidth fade font geometry hold iconName 1013 display_name embed ext_bwidth fade font geometry hold iconName
834 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1014 imFont imLocale inputMethod insecure int_bwidth intensityStyles
835 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1015 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
836 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1016 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1017 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1018 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1019 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1020 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841 shade term_name title transparent transparent_all tripleclickwords 1021 secondaryScreen secondaryScroll selectstyle shade term_name title
842 utmpInhibit visualBell 1022 transient_for transparent transparent_all tripleclickwords utmpInhibit
1023 visualBell
843 1024
844=cut 1025=cut
845 1026
846sub resource($$;$) { 1027sub resource($$;$) {
847 my ($self, $name) = (shift, shift); 1028 my ($self, $name) = (shift, shift);
848 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1029 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
849 &urxvt::term::_resource 1030 &urxvt::term::_resource
850} 1031}
851 1032
1033=item $value = $term->x_resource ($pattern)
1034
1035Returns the X-Resource for the given pattern, excluding the program or
1036class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1037same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1038resource with that pattern exists.
1039
1040This method should only be called during the C<on_start> hook, as there is
1041only one resource database per display, and later invocations might return
1042the wrong resources.
1043
852=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1044=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853 1045
854Adds a keymap translation exactly as specified via a resource. See the 1046Adds a keymap translation exactly as specified via a resource. See the
855C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1047C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856 1048
871=item ($row, $col) = $term->selection_end ([$row, $col]) 1063=item ($row, $col) = $term->selection_end ([$row, $col])
872 1064
873Return the current values of the selection mark, begin or end positions, 1065Return the current values of the selection mark, begin or end positions,
874and optionally set them to new values. 1066and optionally set them to new values.
875 1067
1068=item $term->selection_make ($eventtime[, $rectangular])
1069
1070Tries to make a selection as set by C<selection_beg> and
1071C<selection_end>. If C<$rectangular> is true (default: false), a
1072rectangular selection will be made. This is the prefered function to make
1073a selection.
1074
876=item $success = $term->selection_grab ($eventtime) 1075=item $success = $term->selection_grab ($eventtime)
877 1076
878Try to request the primary selection from the server (for example, as set 1077Try to request the primary selection text from the server (for example, as
879by the next method). 1078set by the next method). No visual feedback will be given. This function
1079is mostly useful from within C<on_sel_grab> hooks.
880 1080
881=item $oldtext = $term->selection ([$newtext]) 1081=item $oldtext = $term->selection ([$newtext])
882 1082
883Return the current selection text and optionally replace it by C<$newtext>. 1083Return the current selection text and optionally replace it by C<$newtext>.
884 1084
977Convert the given locale-encoded octets into a perl string. 1177Convert the given locale-encoded octets into a perl string.
978 1178
979=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1179=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980 1180
981XORs the rendition values in the given span with the provided value 1181XORs the rendition values in the given span with the provided value
982(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1182(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983to the selection. 1183refresh hooks to provide effects similar to the selection.
984 1184
985=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1185=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986 1186
987Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1187Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988whitespace will additionally be xored with the C<$rstyle2>, which defaults 1188whitespace will additionally be xored with the C<$rstyle2>, which defaults
989to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1189to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
990it instead. 1190it instead. Both styles I<MUST NOT> contain font styles.
991 1191
992=item $term->scr_bell 1192=item $term->scr_bell
993 1193
994Ring the bell! 1194Ring the bell!
995 1195
1029 1229
1030=item $windowid = $term->vt 1230=item $windowid = $term->vt
1031 1231
1032Return the window id of the terminal window. 1232Return the window id of the terminal window.
1033 1233
1234=item $term->vt_emask_add ($x_event_mask)
1235
1236Adds the specified events to the vt event mask. Useful e.g. when you want
1237to receive pointer events all the times:
1238
1239 $term->vt_emask_add (urxvt::PointerMotionMask);
1240
1034=item $window_width = $term->width 1241=item $window_width = $term->width
1035 1242
1036=item $window_height = $term->height 1243=item $window_height = $term->height
1037 1244
1038=item $font_width = $term->fwidth 1245=item $font_width = $term->fwidth
1051 1258
1052=item $max_scrollback = $term->saveLines 1259=item $max_scrollback = $term->saveLines
1053 1260
1054=item $nrow_plus_saveLines = $term->total_rows 1261=item $nrow_plus_saveLines = $term->total_rows
1055 1262
1056=item $lines_in_scrollback = $term->nsaved 1263=item $topmost_scrollback_row = $term->top_row
1057 1264
1058Return various integers describing terminal characteristics. 1265Return various integers describing terminal characteristics.
1059 1266
1267=item $x_display = $term->display_id
1268
1269Return the DISPLAY used by rxvt-unicode.
1270
1060=item $lc_ctype = $term->locale 1271=item $lc_ctype = $term->locale
1061 1272
1062Returns the LC_CTYPE category string used by this rxvt-unicode. 1273Returns the LC_CTYPE category string used by this rxvt-unicode.
1063 1274
1064=item $x_display = $term->display_id 1275=item $env = $term->env
1065 1276
1066Return the DISPLAY used by rxvt-unicode. 1277Returns a copy of the environment in effect for the terminal as a hashref
1278similar to C<\%ENV>.
1279
1280=cut
1281
1282sub env {
1283 if (my $env = $_[0]->_env) {
1284 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1285 } else {
1286 +{ %ENV }
1287 }
1288}
1067 1289
1068=item $modifiermask = $term->ModLevel3Mask 1290=item $modifiermask = $term->ModLevel3Mask
1069 1291
1070=item $modifiermask = $term->ModMetaMask 1292=item $modifiermask = $term->ModMetaMask
1071 1293
1074Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1296Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1075AltGr), the meta key (often Alt) and the num lock key, if applicable. 1297AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076 1298
1077=item $view_start = $term->view_start ([$newvalue]) 1299=item $view_start = $term->view_start ([$newvalue])
1078 1300
1079Returns the negative row number of the topmost line. Minimum value is 1301Returns the row number of the topmost displayed line. Maximum value is
1080C<0>, which displays the normal terminal contents. Larger values scroll 1302C<0>, which displays the normal terminal contents. Lower values scroll
1081this many lines into the scrollback buffer. 1303this many lines into the scrollback buffer.
1082 1304
1083=item $term->want_refresh 1305=item $term->want_refresh
1084 1306
1085Requests a screen refresh. At the next opportunity, rxvt-unicode will 1307Requests a screen refresh. At the next opportunity, rxvt-unicode will
1164Return the row number of the first/last row of the line, respectively. 1386Return the row number of the first/last row of the line, respectively.
1165 1387
1166=item $offset = $line->offset_of ($row, $col) 1388=item $offset = $line->offset_of ($row, $col)
1167 1389
1168Returns the character offset of the given row|col pair within the logical 1390Returns the character offset of the given row|col pair within the logical
1169line. 1391line. Works for rows outside the line, too, and returns corresponding
1392offsets outside the string.
1170 1393
1171=item ($row, $col) = $line->coord_of ($offset) 1394=item ($row, $col) = $line->coord_of ($offset)
1172 1395
1173Translates a string offset into terminal coordinates again. 1396Translates a string offset into terminal coordinates again.
1174 1397
1311 $item->{render} ||= sub { $_[0]{text} }; 1534 $item->{render} ||= sub { $_[0]{text} };
1312 1535
1313 push @{ $self->{item} }, $item; 1536 push @{ $self->{item} }, $item;
1314} 1537}
1315 1538
1539=item $popup->add_title ($title)
1540
1541Adds a non-clickable title to the popup.
1542
1543=cut
1544
1545sub add_title {
1546 my ($self, $title) = @_;
1547
1548 $self->add_item ({
1549 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1550 text => $title,
1551 activate => sub { },
1552 });
1553}
1554
1555=item $popup->add_separator ([$sepchr])
1556
1557Creates a separator, optionally using the character given as C<$sepchr>.
1558
1559=cut
1560
1316sub add_separator { 1561sub add_separator {
1317 my ($self, $sep) = @_; 1562 my ($self, $sep) = @_;
1318 1563
1319 $sep ||= "="; 1564 $sep ||= "=";
1320 1565
1324 render => sub { $sep x $self->{term}->ncol }, 1569 render => sub { $sep x $self->{term}->ncol },
1325 activate => sub { }, 1570 activate => sub { },
1326 }); 1571 });
1327} 1572}
1328 1573
1329sub add_title { 1574=item $popup->add_button ($text, $cb)
1330 my ($self, $title) = @_;
1331 1575
1332 $self->add_item ({ 1576Adds 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" }, 1577selected.
1334 text => $title, 1578
1335 activate => sub { }, 1579=cut
1336 });
1337}
1338 1580
1339sub add_button { 1581sub add_button {
1340 my ($self, $text, $cb) = @_; 1582 my ($self, $text, $cb) = @_;
1341 1583
1342 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1584 $self->add_item ({ type => "button", text => $text, activate => $cb});
1343} 1585}
1586
1587=item $popup->add_toggle ($text, $cb, $initial_value)
1588
1589Adds a toggle/checkbox item to the popup. Teh callback gets called
1590whenever it gets toggled, with a boolean indicating its value as its first
1591argument.
1592
1593=cut
1344 1594
1345sub add_toggle { 1595sub add_toggle {
1346 my ($self, $text, $cb, $value) = @_; 1596 my ($self, $text, $cb, $value) = @_;
1347 1597
1348 my $item; $item = { 1598 my $item; $item = {
1349 type => "button", 1599 type => "button",
1350 text => " $text", 1600 text => " $text",
1351 value => $value, 1601 value => $value,
1352 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1602 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1603 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354 }; 1604 };
1355 1605
1356 $self->add_item ($item); 1606 $self->add_item ($item);
1357} 1607}
1608
1609=item $popup->show
1610
1611Displays the popup (which is initially hidden).
1612
1613=cut
1358 1614
1359sub show { 1615sub show {
1360 my ($self) = @_; 1616 my ($self) = @_;
1361 1617
1362 local $urxvt::popup::self = $self; 1618 local $urxvt::popup::self = $self;
1363 1619
1620 my $env = $self->{term}->env;
1621 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1622 delete $env->{LC_ALL};
1364 local $ENV{LC_ALL} = $self->{term}->locale; 1623 $env->{LC_CTYPE} = $self->{term}->locale;
1365 1624
1366 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1625 urxvt::term->new ($env, "popup",
1626 "--perl-lib" => "", "--perl-ext-common" => "",
1627 "-pty-fd" => -1, "-sl" => 0,
1628 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1367 "--transient-for" => $self->{term}->parent, 1629 "--transient-for" => $self->{term}->parent,
1368 "-display" => $self->{term}->display_id, 1630 "-display" => $self->{term}->display_id,
1369 "-pe" => "urxvt-popup") 1631 "-pe" => "urxvt-popup")
1370 or die "unable to create popup window\n"; 1632 or die "unable to create popup window\n";
1371} 1633}
1372 1634
1373sub DESTROY { 1635sub DESTROY {
1374 my ($self) = @_; 1636 my ($self) = @_;
1375 1637
1376 delete $self->{term}{_destroy}{$self}; 1638 delete $self->{term}{_destroy}{$self};
1377 $self->{term}->ungrab; 1639 $self->{term}->ungrab;
1378} 1640}
1641
1642=back
1379 1643
1380=head2 The C<urxvt::timer> Class 1644=head2 The C<urxvt::timer> Class
1381 1645
1382This class implements timer watchers/events. Time is represented as a 1646This class implements timer watchers/events. Time is represented as a
1383fractional number of seconds since the epoch. Example: 1647fractional number of seconds since the epoch. Example:
1421Start the timer. 1685Start the timer.
1422 1686
1423=item $timer = $timer->start ($tstamp) 1687=item $timer = $timer->start ($tstamp)
1424 1688
1425Set the event trigger time to C<$tstamp> and start the timer. 1689Set the event trigger time to C<$tstamp> and start the timer.
1690
1691=item $timer = $timer->after ($delay)
1692
1693Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1426 1694
1427=item $timer = $timer->stop 1695=item $timer = $timer->stop
1428 1696
1429Stop the timer. 1697Stop the timer.
1430 1698
1490 1758
1491=item == 0 - fatal messages 1759=item == 0 - fatal messages
1492 1760
1493=item >= 3 - script loading and management 1761=item >= 3 - script loading and management
1494 1762
1495=item >=10 - all events received 1763=item >=10 - all called hooks
1764
1765=item >=11 - hook reutrn values
1496 1766
1497=back 1767=back
1498 1768
1499=head1 AUTHOR 1769=head1 AUTHOR
1500 1770

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines