ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
Revision: 1.109
Committed: Thu Jan 19 16:07:09 2006 UTC (18 years, 4 months ago) by root
Branch: MAIN
Changes since 1.108: +3 -0 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 =encoding utf8
2
3 =head1 NAME
4
5 @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
6
7 =head1 SYNOPSIS
8
9 # create a file grab_test in $HOME:
10
11 sub on_sel_grab {
12 warn "you selected ", $_[0]->selection;
13 ()
14 }
15
16 # start a @@RXVT_NAME@@ using it:
17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19
20 =head1 DESCRIPTION
21
22 Everytime a terminal object gets created, extension scripts specified via
23 the C<perl> resource are loaded and associated with it.
24
25 Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26 thus must be encoded as UTF-8.
27
28 Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29 scripts will be shared (but not enabled) for all terminals.
30
31 =head1 PREPACKAGED EXTENSIONS
32
33 This section describes the extensions delivered with this release. You can
34 find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35
36 You can activate them like this:
37
38 @@RXVT_NAME@@ -pe <extensionname>
39
40 =over 4
41
42 =item selection (enabled by default)
43
44 (More) intelligent selection. This extension tries to be more intelligent
45 when the user extends selections (double-click and further clicks). Right
46 now, it tries to select words, urls and complete shell-quoted
47 arguments, which is very convenient, too, if your F<ls> supports
48 C<--quoting-style=shell>.
49
50 A double-click usually selects the word under the cursor, further clicks
51 will enlarge the selection.
52
53 The selection works by trying to match a number of regexes and displaying
54 them in increasing order of length. You can add your own regexes by
55 specifying resources of the form:
56
57 URxvt.selection.pattern-0: perl-regex
58 URxvt.selection.pattern-1: perl-regex
59 ...
60
61 The index number (0, 1...) must not have any holes, and each regex must
62 contain at least one pair of capturing parentheses, which will be used for
63 the match. For example, the followign adds a regex that matches everything
64 between two vertical bars:
65
66 URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68 You can look at the source of the selection extension to see more
69 interesting uses, such as parsing a line from beginning to end.
70
71 This extension also offers following bindable keyboard commands:
72
73 =over 4
74
75 =item rot13
76
77 Rot-13 the selection when activated. Used via keyboard trigger:
78
79 URxvt.keysym.C-M-r: perl:selection:rot13
80
81 =back
82
83 =item option-popup (enabled by default)
84
85 Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86 runtime.
87
88 =item selection-popup (enabled by default)
89
90 Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91 text into various other formats/action (such as uri unescaping, perl
92 evalution, web-browser starting etc.), depending on content.
93
94 Other extensions can extend this popup menu by pushing a code reference onto
95 C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
96
97 It's sole argument is the popup menu, which can be modified. The selection
98 is in C<$_>, which can be used to decide wether to add something or not.
99 It should either return nothing or a string and a code reference. The
100 string will be used as button text and the code reference will be called
101 when the button gets activated and should transform C<$_>.
102
103 The following will add an entry C<a to b> that transforms all C<a>s in
104 the selection to C<b>s, but only if the selection currently contains any
105 C<a>s:
106
107 push urxvt::ext::selection_popup::hook, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g }
109 : ()
110 };
111
112 Don't run it in a hook, otherwise the menu will grow and grow. Instead put
113 it at the toplevel of your extension.
114
115 =item searchable-scrollback<hotkey> (enabled by default)
116
117 Adds regex search functionality to the scrollback buffer, triggered
118 by a hotkey (default: C<M-s>). While in search mode, normal terminal
119 input/output is suspended and a regex is displayed at the bottom of the
120 screen.
121
122 Inputting characters appends them to the regex and continues incremental
123 search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
124 search upwards/downwards in the scrollback buffer, C<End> jumps to the
125 bottom. C<Escape> leaves search mode and returns to the point where search
126 was started, while C<Enter> or C<Return> stay at the current position and
127 additionally stores the first match in the current line into the primary
128 selection.
129
130 =item selection-autotransform
131
132 This selection allows you to do automatic transforms on a selection
133 whenever a selection is made.
134
135 It works by specifying perl snippets (most useful is a single C<s///>
136 operator) that modify C<$_> as resources:
137
138 URxvt.selection-autotransform.0: transform
139 URxvt.selection-autotransform.1: transform
140 ...
141
142 For example, the following will transform selections of the form
143 C<filename:number>, often seen in compiler messages, into C<vi +$filename
144 $word>:
145
146 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
147
148 And this example matches the same,but replaces it with vi-commands you can
149 paste directly into your (vi :) editor:
150
151 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
152
153 Of course, this can be modified to suit your needs and your editor :)
154
155 To expand the example above to typical perl error messages ("XXX at
156 FILENAME line YYY."), you need a slightly more elaborate solution:
157
158 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
159 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
160
161 The first line tells the selection code to treat the unchanging part of
162 every error message as a selection pattern, and the second line transforms
163 the message into vi commands to load the file.
164
165 =item mark-urls
166
167 Uses per-line display filtering (C<on_line_update>) to underline urls and
168 make them clickable. When middle-clicked, the program specified in the
169 resource C<urlLauncher> (default C<x-www-browser>) will be started with
170 the URL as first argument.
171
172 =item automove-background
173
174 This is basically a one-line extension that dynamically changes the background pixmap offset
175 to the window position, in effect creating the same effect as pseudo transparency with
176 a custom pixmap. No scaling is supported in this mode. Exmaple:
177
178 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
179
180 =item block-graphics-to-ascii
181
182 A not very useful example of filtering all text output to the terminal,
183 by replacing all line-drawing characters (U+2500 .. U+259F) by a
184 similar-looking ascii character.
185
186 =item digital-clock
187
188 Displays a digital clock using the built-in overlay.
189
190 =item example-refresh-hooks
191
192 Displays a very simple digital clock in the upper right corner of the
193 window. Illustrates overwriting the refresh callbacks to create your own
194 overlays or changes.
195
196 =item selection-pastebin
197
198 This is a little rarely useful extension that Uploads the selection as
199 textfile to a remote site (or does other things). (The implementation is
200 not currently secure for use in a multiuser environment as it writes to
201 F</tmp> directly.).
202
203 It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
204 i.e.
205
206 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
207
208 Pressing this combination runs a command with C<%> replaced by the name of
209 the textfile. This command can be set via a resource:
210
211 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
212
213 And the default is likely not useful to anybody but the few people around
214 here :)
215
216 The name of the textfile is the hex encoded md5 sum of the selection, so
217 the same content should lead to the same filename.
218
219 After a successful upload the selection will be replaced by the text given
220 in the C<selection-pastebin-url> resource (again, the % is the placeholder
221 for the filename):
222
223 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
224
225 =back
226
227 =head1 API DOCUMENTATION
228
229 =head2 General API Considerations
230
231 All objects (such as terminals, time watchers etc.) are typical
232 reference-to-hash objects. The hash can be used to store anything you
233 like. All members starting with an underscore (such as C<_ptr> or
234 C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
235 modified).
236
237 When objects are destroyed on the C++ side, the perl object hashes are
238 emptied, so its best to store related objects such as time watchers and
239 the like inside the terminal object so they get destroyed as soon as the
240 terminal is destroyed.
241
242 Argument names also often indicate the type of a parameter. Here are some
243 hints on what they mean:
244
245 =over 4
246
247 =item $text
248
249 Rxvt-unicodes special way of encoding text, where one "unicode" character
250 always represents one screen cell. See L<ROW_t> for a discussion of this format.
251
252 =item $string
253
254 A perl text string, with an emphasis on I<text>. It can store all unicode
255 characters and is to be distinguished with text encoded in a specific
256 encoding (often locale-specific) and binary data.
257
258 =item $octets
259
260 Either binary data or - more common - a text string encoded in a
261 locale-specific way.
262
263 =back
264
265 =head2 Extension Objects
266
267 Very perl extension is a perl class. A separate perl object is created
268 for each terminal and each extension and passed as the first parameter to
269 hooks. So extensions can use their C<$self> object without having to think
270 about other extensions, with the exception of methods and members that
271 begin with an underscore character C<_>: these are reserved for internal
272 use.
273
274 Although it isn't a C<urxvt::term> object, you can call all methods of the
275 C<urxvt::term> class on this object.
276
277 It has the following methods and data members:
278
279 =over 4
280
281 =item $urxvt_term = $self->{term}
282
283 Returns the C<urxvt::term> object associated with this instance of the
284 extension. This member I<must not> be changed in any way.
285
286 =item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
287
288 Dynamically enable the given hooks (named without the C<on_> prefix) for
289 this extension, replacing any previous hook. This is useful when you want
290 to overwrite time-critical hooks only temporarily.
291
292 =item $self->disable ($hook_name[, $hook_name..])
293
294 Dynamically disable the given hooks.
295
296 =back
297
298 =head2 Hooks
299
300 The following subroutines can be declared in extension files, and will be
301 called whenever the relevant event happens.
302
303 The first argument passed to them is an extension oject as described in
304 the in the C<Extension Objects> section.
305
306 B<All> of these hooks must return a boolean value. If it is true, then the
307 event counts as being I<consumed>, and the invocation of other hooks is
308 skipped, and the relevant action might not be carried out by the C++ code.
309
310 I<< When in doubt, return a false value (preferably C<()>). >>
311
312 =over 4
313
314 =item on_init $term
315
316 Called after a new terminal object has been initialized, but before
317 windows are created or the command gets run. Most methods are unsafe to
318 call or deliver senseless data, as terminal size and other characteristics
319 have not yet been determined. You can safely query and change resources,
320 though.
321
322 =item on_reset $term
323
324 Called after the screen is "reset" for any reason, such as resizing or
325 control sequences. Here is where you can react on changes to size-related
326 variables.
327
328 =item on_start $term
329
330 Called at the very end of initialisation of a new terminal, just before
331 returning to the mainloop.
332
333 =item on_child_start $term, $pid
334
335 Called just after the child process has been C<fork>ed.
336
337 =item on_child_exit $term, $status
338
339 Called just after the child process has exited. C<$status> is the status
340 from C<waitpid>.
341
342 =item on_sel_make $term, $eventtime
343
344 Called whenever a selection has been made by the user, but before the
345 selection text is copied, so changes to the beginning, end or type of the
346 selection will be honored.
347
348 Returning a true value aborts selection making by urxvt, in which case you
349 have to make a selection yourself by calling C<< $term->selection_grab >>.
350
351 =item on_sel_grab $term, $eventtime
352
353 Called whenever a selection has been copied, but before the selection is
354 requested from the server. The selection text can be queried and changed
355 by calling C<< $term->selection >>.
356
357 Returning a true value aborts selection grabbing. It will still be hilighted.
358
359 =item on_sel_extend $term
360
361 Called whenever the user tries to extend the selection (e.g. with a double
362 click) and is either supposed to return false (normal operation), or
363 should extend the selection itelf and return true to suppress the built-in
364 processing. This can happen multiple times, as long as the callback
365 returns true, it will be called on every further click by the user and is
366 supposed to enlarge the selection more and more, if possible.
367
368 See the F<selection> example extension.
369
370 =item on_view_change $term, $offset
371
372 Called whenever the view offset changes, i..e the user or program
373 scrolls. Offset C<0> means display the normal terminal, positive values
374 show this many lines of scrollback.
375
376 =item on_scroll_back $term, $lines, $saved
377
378 Called whenever lines scroll out of the terminal area into the scrollback
379 buffer. C<$lines> is the number of lines scrolled out and may be larger
380 than the scroll back buffer or the terminal.
381
382 It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
383 $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
384 number of lines that will be in the scrollback buffer.
385
386 =item on_osc_seq $term, $string
387
388 Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
389 operating system command) is processed. Cursor position and other state
390 information is up-to-date when this happens. For interoperability, the
391 string should start with the extension name and a colon, to distinguish
392 it from commands for other extensions, and this might be enforced in the
393 future.
394
395 Be careful not ever to trust (in a security sense) the data you receive,
396 as its source can not easily be controleld (e-mail content, messages from
397 other users on the same system etc.).
398
399 =item on_add_lines $term, $string
400
401 Called whenever text is about to be output, with the text as argument. You
402 can filter/change and output the text yourself by returning a true value
403 and calling C<< $term->scr_add_lines >> yourself. Please note that this
404 might be very slow, however, as your hook is called for B<all> text being
405 output.
406
407 =item on_tt_write $term, $octets
408
409 Called whenever some data is written to the tty/pty and can be used to
410 suppress or filter tty input.
411
412 =item on_line_update $term, $row
413
414 Called whenever a line was updated or changed. Can be used to filter
415 screen output (e.g. underline urls or other useless stuff). Only lines
416 that are being shown will be filtered, and, due to performance reasons,
417 not always immediately.
418
419 The row number is always the topmost row of the line if the line spans
420 multiple rows.
421
422 Please note that, if you change the line, then the hook might get called
423 later with the already-modified line (e.g. if unrelated parts change), so
424 you cannot just toggle rendition bits, but only set them.
425
426 =item on_refresh_begin $term
427
428 Called just before the screen gets redrawn. Can be used for overlay
429 or similar effects by modify terminal contents in refresh_begin, and
430 restoring them in refresh_end. The built-in overlay and selection display
431 code is run after this hook, and takes precedence.
432
433 =item on_refresh_end $term
434
435 Called just after the screen gets redrawn. See C<on_refresh_begin>.
436
437 =item on_keyboard_command $term, $string
438
439 Called whenever the user presses a key combination that has a
440 C<perl:string> action bound to it (see description of the B<keysym>
441 resource in the @@RXVT_NAME@@(1) manpage).
442
443 =item on_x_event $term, $event
444
445 Called on every X event received on the vt window (and possibly other
446 windows). Should only be used as a last resort. Most event structure
447 members are not passed.
448
449 =item on_focus_in $term
450
451 Called whenever the window gets the keyboard focus, before rxvt-unicode
452 does focus in processing.
453
454 =item on_focus_out $term
455
456 Called wheneever the window loses keyboard focus, before rxvt-unicode does
457 focus out processing.
458
459 =item on_configure_notify $term, $event
460
461 =item on_key_press $term, $event, $keysym, $octets
462
463 =item on_key_release $term, $event, $keysym
464
465 =item on_button_press $term, $event
466
467 =item on_button_release $term, $event
468
469 =item on_motion_notify $term, $event
470
471 =item on_map_notify $term, $event
472
473 =item on_unmap_notify $term, $event
474
475 Called whenever the corresponding X event is received for the terminal If
476 the hook returns true, then the even will be ignored by rxvt-unicode.
477
478 The event is a hash with most values as named by Xlib (see the XEvent
479 manpage), with the additional members C<row> and C<col>, which are the row
480 and column under the mouse cursor.
481
482 C<on_key_press> additionally receives the string rxvt-unicode would
483 output, if any, in locale-specific encoding.
484
485 subwindow.
486
487 =back
488
489 =cut
490
491 package urxvt;
492
493 use utf8;
494 use strict;
495 use Carp ();
496 use Scalar::Util ();
497 use List::Util ();
498
499 our $VERSION = 1;
500 our $TERM;
501 our @HOOKNAME;
502 our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
503 our %OPTION;
504
505 our $LIBDIR;
506 our $RESNAME;
507 our $RESCLASS;
508 our $RXVTNAME;
509
510 =head2 Variables in the C<urxvt> Package
511
512 =over 4
513
514 =item $urxvt::LIBDIR
515
516 The rxvt-unicode library directory, where, among other things, the perl
517 modules and scripts are stored.
518
519 =item $urxvt::RESCLASS, $urxvt::RESCLASS
520
521 The resource class and name rxvt-unicode uses to look up X resources.
522
523 =item $urxvt::RXVTNAME
524
525 The basename of the installed binaries, usually C<urxvt>.
526
527 =item $urxvt::TERM
528
529 The current terminal. This variable stores the current C<urxvt::term>
530 object, whenever a callback/hook is executing.
531
532 =back
533
534 =head2 Functions in the C<urxvt> Package
535
536 =over 4
537
538 =item urxvt::fatal $errormessage
539
540 Fatally aborts execution with the given error message. Avoid at all
541 costs! The only time this is acceptable is when the terminal process
542 starts up.
543
544 =item urxvt::warn $string
545
546 Calls C<rxvt_warn> with the given string which should not include a
547 newline. The module also overwrites the C<warn> builtin with a function
548 that calls this function.
549
550 Using this function has the advantage that its output ends up in the
551 correct place, e.g. on stderr of the connecting urxvtc client.
552
553 Messages have a size limit of 1023 bytes currently.
554
555 =item $time = urxvt::NOW
556
557 Returns the "current time" (as per the event loop).
558
559 =item urxvt::CurrentTime
560
561 =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
562 Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
563 Button4Mask, Button5Mask, AnyModifier
564
565 =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
566 ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
567 PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
568 Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
569 KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
570 ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
571 FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
572
573 =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
574 EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
575 GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
576 UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
577 ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
578 CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
579 SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
580
581 Various constants for use in X calls and event processing.
582
583 =back
584
585 =head2 RENDITION
586
587 Rendition bitsets contain information about colour, font, font styles and
588 similar information for each screen cell.
589
590 The following "macros" deal with changes in rendition sets. You should
591 never just create a bitset, you should always modify an existing one,
592 as they contain important information required for correct operation of
593 rxvt-unicode.
594
595 =over 4
596
597 =item $rend = urxvt::DEFAULT_RSTYLE
598
599 Returns the default rendition, as used when the terminal is starting up or
600 being reset. Useful as a base to start when creating renditions.
601
602 =item $rend = urxvt::OVERLAY_RSTYLE
603
604 Return the rendition mask used for overlays by default.
605
606 =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
607
608 Return the bit that enabled bold, italic, blink, reverse-video and
609 underline, respectively. To enable such a style, just logically OR it into
610 the bitset.
611
612 =item $foreground = urxvt::GET_BASEFG $rend
613
614 =item $background = urxvt::GET_BASEBG $rend
615
616 Return the foreground/background colour index, respectively.
617
618 =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
619
620 =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
621
622 Replace the foreground/background colour in the rendition mask with the
623 specified one.
624
625 =item $value = urxvt::GET_CUSTOM $rend
626
627 Return the "custom" value: Every rendition has 5 bits for use by
628 extensions. They can be set and changed as you like and are initially
629 zero.
630
631 =item $rend = urxvt::SET_CUSTOM $rend, $new_value
632
633 Change the custom value.
634
635 =back
636
637 =cut
638
639 BEGIN {
640 # overwrite perl's warn
641 *CORE::GLOBAL::warn = sub {
642 my $msg = join "", @_;
643 $msg .= "\n"
644 unless $msg =~ /\n$/;
645 urxvt::warn ($msg);
646 };
647 }
648
649 my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
650
651 sub verbose {
652 my ($level, $msg) = @_;
653 warn "$msg\n" if $level <= $verbosity;
654 }
655
656 my %extension_pkg;
657
658 # load a single script into its own package, once only
659 sub extension_package($) {
660 my ($path) = @_;
661
662 no strict 'refs';
663
664 $extension_pkg{$path} ||= do {
665 $path =~ /([^\/\\]+)$/;
666 my $pkg = $1;
667 $pkg =~ s/[^[:word:]]/_/g;
668 $pkg = "urxvt::ext::$pkg";
669
670 verbose 3, "loading extension '$path' into package '$pkg'";
671
672 open my $fh, "<:raw", $path
673 or die "$path: $!";
674
675 @{"$pkg\::ISA"} = urxvt::term::extension::;
676
677 my $source =
678 "package $pkg; use strict; use utf8;\n"
679 . "#line 1 \"$path\"\n{\n"
680 . (do { local $/; <$fh> })
681 . "\n};\n1";
682
683 eval $source
684 or die "$path: $@";
685
686 $pkg
687 }
688 }
689
690 our $retval; # return value for urxvt
691
692 # called by the rxvt core
693 sub invoke {
694 local $TERM = shift;
695 my $htype = shift;
696
697 if ($htype == 0) { # INIT
698 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
699
700 my %ext_arg;
701
702 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
703 if ($_ eq "default") {
704 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
705 } elsif (/^-(.*)$/) {
706 delete $ext_arg{$1};
707 } elsif (/^([^<]+)<(.*)>$/) {
708 push @{ $ext_arg{$1} }, $2;
709 } else {
710 $ext_arg{$_} ||= [];
711 }
712 }
713
714 while (my ($ext, $argv) = each %ext_arg) {
715 my @files = grep -f $_, map "$_/$ext", @dirs;
716
717 if (@files) {
718 $TERM->register_package (extension_package $files[0], $argv);
719 } else {
720 warn "perl extension '$ext' not found in perl library search path\n";
721 }
722 }
723
724 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
725 warn $@ if $@;
726 }
727
728 $retval = undef;
729
730 if (my $cb = $TERM->{_hook}[$htype]) {
731 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
732 if $verbosity >= 10;
733
734 keys %$cb;
735
736 while (my ($pkg, $cb) = each %$cb) {
737 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
738 and last;
739
740 if ($@) {
741 $TERM->ungrab; # better to lose the grab than the session
742 warn $@;
743 }
744 }
745
746 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
747 if $verbosity >= 11;
748 }
749
750 if ($htype == 1) { # DESTROY
751 # clear package objects
752 %$_ = () for values %{ $TERM->{_pkg} };
753
754 # clear package
755 %$TERM = ();
756 }
757
758 $retval
759 }
760
761 # urxvt::term::extension
762
763 package urxvt::term::extension;
764
765 sub enable {
766 my ($self, %hook) = @_;
767 my $pkg = $self->{_pkg};
768
769 while (my ($name, $cb) = each %hook) {
770 my $htype = $HOOKTYPE{uc $name};
771 defined $htype
772 or Carp::croak "unsupported hook type '$name'";
773
774 $self->set_should_invoke ($htype, +1)
775 unless exists $self->{term}{_hook}[$htype]{$pkg};
776
777 $self->{term}{_hook}[$htype]{$pkg} = $cb;
778 }
779 }
780
781 sub disable {
782 my ($self, @hook) = @_;
783 my $pkg = $self->{_pkg};
784
785 for my $name (@hook) {
786 my $htype = $HOOKTYPE{uc $name};
787 defined $htype
788 or Carp::croak "unsupported hook type '$name'";
789
790 $self->set_should_invoke ($htype, -1)
791 if delete $self->{term}{_hook}[$htype]{$pkg};
792 }
793 }
794
795 our $AUTOLOAD;
796
797 sub AUTOLOAD {
798 $AUTOLOAD =~ /:([^:]+)$/
799 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
800
801 eval qq{
802 sub $AUTOLOAD {
803 my \$proxy = shift;
804 \$proxy->{term}->$1 (\@_)
805 }
806 1
807 } or die "FATAL: unable to compile method forwarder: $@";
808
809 goto &$AUTOLOAD;
810 }
811
812 sub DESTROY {
813 # nop
814 }
815
816 # urxvt::destroy_hook
817
818 sub urxvt::destroy_hook::DESTROY {
819 ${$_[0]}->();
820 }
821
822 sub urxvt::destroy_hook(&) {
823 bless \shift, urxvt::destroy_hook::
824 }
825
826 package urxvt::anyevent;
827
828 =head2 The C<urxvt::anyevent> Class
829
830 The sole purpose of this class is to deliver an interface to the
831 C<AnyEvent> module - any module using it will work inside urxvt without
832 further programming. The only exception is that you cannot wait on
833 condition variables, but non-blocking condvar use is ok. What this means
834 is that you cannot use blocking APIs, but the non-blocking variant should
835 work.
836
837 =cut
838
839 our $VERSION = 1;
840
841 $INC{"urxvt/anyevent.pm"} = 1; # mark us as there
842 push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
843
844 sub timer {
845 my ($class, %arg) = @_;
846
847 my $cb = $arg{cb};
848
849 urxvt::timer
850 ->new
851 ->start (urxvt::NOW + $arg{after})
852 ->cb (sub {
853 $_[0]->stop; # need to cancel manually
854 $cb->();
855 })
856 }
857
858 sub io {
859 my ($class, %arg) = @_;
860
861 my $cb = $arg{cb};
862
863 bless [$arg{fh}, urxvt::iow
864 ->new
865 ->fd (fileno $arg{fh})
866 ->events (($arg{poll} =~ /r/ ? 1 : 0)
867 | ($arg{poll} =~ /w/ ? 2 : 0))
868 ->start
869 ->cb (sub {
870 $cb->(($_[1] & 1 ? 'r' : '')
871 . ($_[1] & 2 ? 'w' : ''));
872 })],
873 urxvt::anyevent::
874 }
875
876 sub DESTROY {
877 $_[0][1]->stop;
878 }
879
880 sub condvar {
881 bless \my $flag, urxvt::anyevent::condvar::
882 }
883
884 sub urxvt::anyevent::condvar::broadcast {
885 ${$_[0]}++;
886 }
887
888 sub urxvt::anyevent::condvar::wait {
889 unless (${$_[0]}) {
890 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
891 }
892 }
893
894 package urxvt::term;
895
896 =head2 The C<urxvt::term> Class
897
898 =over 4
899
900 =cut
901
902 # find on_xxx subs in the package and register them
903 # as hooks
904 sub register_package {
905 my ($self, $pkg, $argv) = @_;
906
907 my $proxy = bless {
908 _pkg => $pkg,
909 argv => $argv,
910 }, $pkg;
911 Scalar::Util::weaken ($proxy->{term} = $self);
912
913 $self->{_pkg}{$pkg} = $proxy;
914
915 for my $name (@HOOKNAME) {
916 if (my $ref = $pkg->can ("on_" . lc $name)) {
917 $proxy->enable ($name => $ref);
918 }
919 }
920 }
921
922 =item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
923
924 Creates a new terminal, very similar as if you had started it with system
925 C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
926 hash which defines the environment of the new terminal.
927
928 Croaks (and probably outputs an error message) if the new instance
929 couldn't be created. Returns C<undef> if the new instance didn't
930 initialise perl, and the terminal object otherwise. The C<init> and
931 C<start> hooks will be called during this call.
932
933 =cut
934
935 sub new {
936 my ($class, $env, @args) = @_;
937
938 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
939 }
940
941 =item $term->destroy
942
943 Destroy the terminal object (close the window, free resources
944 etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
945 watchers (timers, io watchers) are still active.
946
947 =item $term->exec_async ($cmd[, @args])
948
949 Works like the combination of the C<fork>/C<exec> builtins, which executes
950 ("starts") programs in the background. This function takes care of setting
951 the user environment before exec'ing the command (e.g. C<PATH>) and should
952 be preferred over explicit calls to C<exec> or C<system>.
953
954 Returns the pid of the subprocess or C<undef> on error.
955
956 =cut
957
958 sub exec_async {
959 my $self = shift;
960
961 my $pid = fork;
962
963 return $pid
964 if !defined $pid or $pid;
965
966 %ENV = %{ $self->env };
967
968 exec @_;
969 urxvt::_exit 255;
970 }
971
972 =item $isset = $term->option ($optval[, $set])
973
974 Returns true if the option specified by C<$optval> is enabled, and
975 optionally change it. All option values are stored by name in the hash
976 C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
977
978 Here is a a likely non-exhaustive list of option names, please see the
979 source file F</src/optinc.h> to see the actual list:
980
981 borderLess console cursorBlink cursorUnderline hold iconic insecure
982 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
983 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
984 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
985 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
986 transparent tripleclickwords utmpInhibit visualBell
987
988 =item $value = $term->resource ($name[, $newval])
989
990 Returns the current resource value associated with a given name and
991 optionally sets a new value. Setting values is most useful in the C<init>
992 hook. Unset resources are returned and accepted as C<undef>.
993
994 The new value must be properly encoded to a suitable character encoding
995 before passing it to this method. Similarly, the returned value may need
996 to be converted from the used encoding to text.
997
998 Resource names are as defined in F<src/rsinc.h>. Colours can be specified
999 as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
1000 likely change).
1001
1002 Please note that resource strings will currently only be freed when the
1003 terminal is destroyed, so changing options frequently will eat memory.
1004
1005 Here is a a likely non-exhaustive list of resource names, not all of which
1006 are supported in every build, please see the source file F</src/rsinc.h>
1007 to see the actual list:
1008
1009 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1010 borderLess color cursorBlink cursorUnderline cutchars delete_key
1011 display_name embed ext_bwidth fade font geometry hold iconName
1012 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1013 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
1014 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1015 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1016 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1017 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1018 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1019 secondaryScreen secondaryScroll selectstyle shade term_name title
1020 transient_for transparent transparent_all tripleclickwords utmpInhibit
1021 visualBell
1022
1023 =cut
1024
1025 sub resource($$;$) {
1026 my ($self, $name) = (shift, shift);
1027 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1028 &urxvt::term::_resource
1029 }
1030
1031 =item $value = $term->x_resource ($pattern)
1032
1033 Returns the X-Resource for the given pattern, excluding the program or
1034 class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1035 same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1036 resource with that pattern exists.
1037
1038 This method should only be called during the C<on_start> hook, as there is
1039 only one resource database per display, and later invocations might return
1040 the wrong resources.
1041
1042 =item $success = $term->parse_keysym ($keysym_spec, $command_string)
1043
1044 Adds a keymap translation exactly as specified via a resource. See the
1045 C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1046
1047 =item $rend = $term->rstyle ([$new_rstyle])
1048
1049 Return and optionally change the current rendition. Text that is output by
1050 the terminal application will use this style.
1051
1052 =item ($row, $col) = $term->screen_cur ([$row, $col])
1053
1054 Return the current coordinates of the text cursor position and optionally
1055 set it (which is usually bad as applications don't expect that).
1056
1057 =item ($row, $col) = $term->selection_mark ([$row, $col])
1058
1059 =item ($row, $col) = $term->selection_beg ([$row, $col])
1060
1061 =item ($row, $col) = $term->selection_end ([$row, $col])
1062
1063 Return the current values of the selection mark, begin or end positions,
1064 and optionally set them to new values.
1065
1066 =item $term->selection_make ($eventtime[, $rectangular])
1067
1068 Tries to make a selection as set by C<selection_beg> and
1069 C<selection_end>. If C<$rectangular> is true (default: false), a
1070 rectangular selection will be made. This is the prefered function to make
1071 a selection.
1072
1073 =item $success = $term->selection_grab ($eventtime)
1074
1075 Try to request the primary selection text from the server (for example, as
1076 set by the next method). No visual feedback will be given. This function
1077 is mostly useful from within C<on_sel_grab> hooks.
1078
1079 =item $oldtext = $term->selection ([$newtext])
1080
1081 Return the current selection text and optionally replace it by C<$newtext>.
1082
1083 =item $term->overlay_simple ($x, $y, $text)
1084
1085 Create a simple multi-line overlay box. See the next method for details.
1086
1087 =cut
1088
1089 sub overlay_simple {
1090 my ($self, $x, $y, $text) = @_;
1091
1092 my @lines = split /\n/, $text;
1093
1094 my $w = List::Util::max map $self->strwidth ($_), @lines;
1095
1096 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
1097 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
1098
1099 $overlay
1100 }
1101
1102 =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
1103
1104 Create a new (empty) overlay at the given position with the given
1105 width/height. C<$rstyle> defines the initial rendition style
1106 (default: C<OVERLAY_RSTYLE>).
1107
1108 If C<$border> is C<2> (default), then a decorative border will be put
1109 around the box.
1110
1111 If either C<$x> or C<$y> is negative, then this is counted from the
1112 right/bottom side, respectively.
1113
1114 This method returns an urxvt::overlay object. The overlay will be visible
1115 as long as the perl object is referenced.
1116
1117 The methods currently supported on C<urxvt::overlay> objects are:
1118
1119 =over 4
1120
1121 =item $overlay->set ($x, $y, $text, $rend)
1122
1123 Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1124 text in rxvt-unicode's special encoding and an array of rendition values
1125 at a specific position inside the overlay.
1126
1127 =item $overlay->hide
1128
1129 If visible, hide the overlay, but do not destroy it.
1130
1131 =item $overlay->show
1132
1133 If hidden, display the overlay again.
1134
1135 =back
1136
1137 =item $popup = $term->popup ($event)
1138
1139 Creates a new C<urxvt::popup> object that implements a popup menu. The
1140 C<$event> I<must> be the event causing the menu to pop up (a button event,
1141 currently).
1142
1143 =cut
1144
1145 sub popup {
1146 my ($self, $event) = @_;
1147
1148 $self->grab ($event->{time}, 1)
1149 or return;
1150
1151 my $popup = bless {
1152 term => $self,
1153 event => $event,
1154 }, urxvt::popup::;
1155
1156 Scalar::Util::weaken $popup->{term};
1157
1158 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
1159 Scalar::Util::weaken $self->{_destroy}{$popup};
1160
1161 $popup
1162 }
1163
1164 =item $cellwidth = $term->strwidth ($string)
1165
1166 Returns the number of screen-cells this string would need. Correctly
1167 accounts for wide and combining characters.
1168
1169 =item $octets = $term->locale_encode ($string)
1170
1171 Convert the given text string into the corresponding locale encoding.
1172
1173 =item $string = $term->locale_decode ($octets)
1174
1175 Convert the given locale-encoded octets into a perl string.
1176
1177 =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1178
1179 XORs the rendition values in the given span with the provided value
1180 (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1181 refresh hooks to provide effects similar to the selection.
1182
1183 =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1184
1185 Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1186 whitespace will additionally be xored with the C<$rstyle2>, which defaults
1187 to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1188 it instead. Both styles I<MUST NOT> contain font styles.
1189
1190 =item $term->scr_bell
1191
1192 Ring the bell!
1193
1194 =item $term->scr_add_lines ($string)
1195
1196 Write the given text string to the screen, as if output by the application
1197 running inside the terminal. It may not contain command sequences (escape
1198 codes), but is free to use line feeds, carriage returns and tabs. The
1199 string is a normal text string, not in locale-dependent encoding.
1200
1201 Normally its not a good idea to use this function, as programs might be
1202 confused by changes in cursor position or scrolling. Its useful inside a
1203 C<on_add_lines> hook, though.
1204
1205 =item $term->cmd_parse ($octets)
1206
1207 Similar to C<scr_add_lines>, but the argument must be in the
1208 locale-specific encoding of the terminal and can contain command sequences
1209 (escape codes) that will be interpreted.
1210
1211 =item $term->tt_write ($octets)
1212
1213 Write the octets given in C<$data> to the tty (i.e. as program input). To
1214 pass characters instead of octets, you should convert your strings first
1215 to the locale-specific encoding using C<< $term->locale_encode >>.
1216
1217 =item $old_events = $term->pty_ev_events ([$new_events])
1218
1219 Replaces the event mask of the pty watcher by the given event mask. Can
1220 be used to suppress input and output handling to the pty/tty. See the
1221 description of C<< urxvt::timer->events >>. Make sure to always restore
1222 the previous value.
1223
1224 =item $windowid = $term->parent
1225
1226 Return the window id of the toplevel window.
1227
1228 =item $windowid = $term->vt
1229
1230 Return the window id of the terminal window.
1231
1232 =item $term->vt_emask_add ($x_event_mask)
1233
1234 Adds the specified events to the vt event mask. Useful e.g. when you want
1235 to receive pointer events all the times:
1236
1237 $term->vt_emask_add (urxvt::PointerMotionMask);
1238
1239 =item $window_width = $term->width
1240
1241 =item $window_height = $term->height
1242
1243 =item $font_width = $term->fwidth
1244
1245 =item $font_height = $term->fheight
1246
1247 =item $font_ascent = $term->fbase
1248
1249 =item $terminal_rows = $term->nrow
1250
1251 =item $terminal_columns = $term->ncol
1252
1253 =item $has_focus = $term->focus
1254
1255 =item $is_mapped = $term->mapped
1256
1257 =item $max_scrollback = $term->saveLines
1258
1259 =item $nrow_plus_saveLines = $term->total_rows
1260
1261 =item $topmost_scrollback_row = $term->top_row
1262
1263 Return various integers describing terminal characteristics.
1264
1265 =item $x_display = $term->display_id
1266
1267 Return the DISPLAY used by rxvt-unicode.
1268
1269 =item $lc_ctype = $term->locale
1270
1271 Returns the LC_CTYPE category string used by this rxvt-unicode.
1272
1273 =item $env = $term->env
1274
1275 Returns a copy of the environment in effect for the terminal as a hashref
1276 similar to C<\%ENV>.
1277
1278 =cut
1279
1280 sub env {
1281 if (my $env = $_[0]->_env) {
1282 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1283 } else {
1284 +{ %ENV }
1285 }
1286 }
1287
1288 =item $modifiermask = $term->ModLevel3Mask
1289
1290 =item $modifiermask = $term->ModMetaMask
1291
1292 =item $modifiermask = $term->ModNumLockMask
1293
1294 Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1295 AltGr), the meta key (often Alt) and the num lock key, if applicable.
1296
1297 =item $view_start = $term->view_start ([$newvalue])
1298
1299 Returns the row number of the topmost displayed line. Maximum value is
1300 C<0>, which displays the normal terminal contents. Lower values scroll
1301 this many lines into the scrollback buffer.
1302
1303 =item $term->want_refresh
1304
1305 Requests a screen refresh. At the next opportunity, rxvt-unicode will
1306 compare the on-screen display with its stored representation. If they
1307 differ, it redraws the differences.
1308
1309 Used after changing terminal contents to display them.
1310
1311 =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1312
1313 Returns the text of the entire row with number C<$row_number>. Row C<0>
1314 is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
1315 terminal line. The scrollback buffer starts at line C<-1> and extends to
1316 line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
1317 is requested.
1318
1319 If C<$new_text> is specified, it will replace characters in the current
1320 line, starting at column C<$start_col> (default C<0>), which is useful
1321 to replace only parts of a line. The font index in the rendition will
1322 automatically be updated.
1323
1324 C<$text> is in a special encoding: tabs and wide characters that use more
1325 than one cell when displayed are padded with urxvt::NOCHAR characters
1326 (C<chr 65535>). Characters with combining characters and other characters
1327 that do not fit into the normal tetx encoding will be replaced with
1328 characters in the private use area.
1329
1330 You have to obey this encoding when changing text. The advantage is
1331 that C<substr> and similar functions work on screen cells and not on
1332 characters.
1333
1334 The methods C<< $term->special_encode >> and C<< $term->special_decode >>
1335 can be used to convert normal strings into this encoding and vice versa.
1336
1337 =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
1338
1339 Like C<< $term->ROW_t >>, but returns an arrayref with rendition
1340 bitsets. Rendition bitsets contain information about colour, font, font
1341 styles and similar information. See also C<< $term->ROW_t >>.
1342
1343 When setting rendition, the font mask will be ignored.
1344
1345 See the section on RENDITION, above.
1346
1347 =item $length = $term->ROW_l ($row_number[, $new_length])
1348
1349 Returns the number of screen cells that are in use ("the line
1350 length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
1351 line is joined with the following one.
1352
1353 =item $bool = $term->is_longer ($row_number)
1354
1355 Returns true if the row is part of a multiple-row logical "line" (i.e.
1356 joined with the following row), which means all characters are in use
1357 and it is continued on the next row (and possibly a continuation of the
1358 previous row(s)).
1359
1360 =item $line = $term->line ($row_number)
1361
1362 Create and return a new C<urxvt::line> object that stores information
1363 about the logical line that row C<$row_number> is part of. It supports the
1364 following methods:
1365
1366 =over 4
1367
1368 =item $text = $line->t ([$new_text])
1369
1370 Returns or replaces the full text of the line, similar to C<ROW_t>
1371
1372 =item $rend = $line->r ([$new_rend])
1373
1374 Returns or replaces the full rendition array of the line, similar to C<ROW_r>
1375
1376 =item $length = $line->l
1377
1378 Returns the length of the line in cells, similar to C<ROW_l>.
1379
1380 =item $rownum = $line->beg
1381
1382 =item $rownum = $line->end
1383
1384 Return the row number of the first/last row of the line, respectively.
1385
1386 =item $offset = $line->offset_of ($row, $col)
1387
1388 Returns the character offset of the given row|col pair within the logical
1389 line. Works for rows outside the line, too, and returns corresponding
1390 offsets outside the string.
1391
1392 =item ($row, $col) = $line->coord_of ($offset)
1393
1394 Translates a string offset into terminal coordinates again.
1395
1396 =back
1397
1398 =cut
1399
1400 sub line {
1401 my ($self, $row) = @_;
1402
1403 my $maxrow = $self->nrow - 1;
1404
1405 my ($beg, $end) = ($row, $row);
1406
1407 --$beg while $self->ROW_is_longer ($beg - 1);
1408 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
1409
1410 bless {
1411 term => $self,
1412 beg => $beg,
1413 end => $end,
1414 ncol => $self->ncol,
1415 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
1416 }, urxvt::line::
1417 }
1418
1419 sub urxvt::line::t {
1420 my ($self) = @_;
1421
1422 if (@_ > 1)
1423 {
1424 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1425 for $self->{beg} .. $self->{end};
1426 }
1427
1428 defined wantarray &&
1429 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1430 0, $self->{len}
1431 }
1432
1433 sub urxvt::line::r {
1434 my ($self) = @_;
1435
1436 if (@_ > 1)
1437 {
1438 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1439 for $self->{beg} .. $self->{end};
1440 }
1441
1442 if (defined wantarray) {
1443 my $rend = [
1444 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1445 ];
1446 $#$rend = $self->{len} - 1;
1447 return $rend;
1448 }
1449
1450 ()
1451 }
1452
1453 sub urxvt::line::beg { $_[0]{beg} }
1454 sub urxvt::line::end { $_[0]{end} }
1455 sub urxvt::line::l { $_[0]{len} }
1456
1457 sub urxvt::line::offset_of {
1458 my ($self, $row, $col) = @_;
1459
1460 ($row - $self->{beg}) * $self->{ncol} + $col
1461 }
1462
1463 sub urxvt::line::coord_of {
1464 my ($self, $offset) = @_;
1465
1466 use integer;
1467
1468 (
1469 $offset / $self->{ncol} + $self->{beg},
1470 $offset % $self->{ncol}
1471 )
1472 }
1473
1474 =item $text = $term->special_encode $string
1475
1476 Converts a perl string into the special encoding used by rxvt-unicode,
1477 where one character corresponds to one screen cell. See
1478 C<< $term->ROW_t >> for details.
1479
1480 =item $string = $term->special_decode $text
1481
1482 Converts rxvt-unicodes text reprsentation into a perl string. See
1483 C<< $term->ROW_t >> for details.
1484
1485 =item $success = $term->grab_button ($button, $modifiermask)
1486
1487 Registers a synchronous button grab. See the XGrabButton manpage.
1488
1489 =item $success = $term->grab ($eventtime[, $sync])
1490
1491 Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1492 synchronous (C<$sync> is true). Also remembers the grab timestampe.
1493
1494 =item $term->allow_events_async
1495
1496 Calls XAllowEvents with AsyncBoth for the most recent grab.
1497
1498 =item $term->allow_events_sync
1499
1500 Calls XAllowEvents with SyncBoth for the most recent grab.
1501
1502 =item $term->allow_events_replay
1503
1504 Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1505 recent grab.
1506
1507 =item $term->ungrab
1508
1509 Calls XUngrab for the most recent grab. Is called automatically on
1510 evaluation errors, as it is better to lose the grab in the error case as
1511 the session.
1512
1513 =back
1514
1515 =cut
1516
1517 package urxvt::popup;
1518
1519 =head2 The C<urxvt::popup> Class
1520
1521 =over 4
1522
1523 =cut
1524
1525 sub add_item {
1526 my ($self, $item) = @_;
1527
1528 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1529 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1530 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1531
1532 $item->{render} ||= sub { $_[0]{text} };
1533
1534 push @{ $self->{item} }, $item;
1535 }
1536
1537 =item $popup->add_title ($title)
1538
1539 Adds a non-clickable title to the popup.
1540
1541 =cut
1542
1543 sub add_title {
1544 my ($self, $title) = @_;
1545
1546 $self->add_item ({
1547 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1548 text => $title,
1549 activate => sub { },
1550 });
1551 }
1552
1553 =item $popup->add_separator ([$sepchr])
1554
1555 Creates a separator, optionally using the character given as C<$sepchr>.
1556
1557 =cut
1558
1559 sub add_separator {
1560 my ($self, $sep) = @_;
1561
1562 $sep ||= "=";
1563
1564 $self->add_item ({
1565 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1566 text => "",
1567 render => sub { $sep x $self->{term}->ncol },
1568 activate => sub { },
1569 });
1570 }
1571
1572 =item $popup->add_button ($text, $cb)
1573
1574 Adds a clickable button to the popup. C<$cb> is called whenever it is
1575 selected.
1576
1577 =cut
1578
1579 sub add_button {
1580 my ($self, $text, $cb) = @_;
1581
1582 $self->add_item ({ type => "button", text => $text, activate => $cb});
1583 }
1584
1585 =item $popup->add_toggle ($text, $cb, $initial_value)
1586
1587 Adds a toggle/checkbox item to the popup. Teh callback gets called
1588 whenever it gets toggled, with a boolean indicating its value as its first
1589 argument.
1590
1591 =cut
1592
1593 sub add_toggle {
1594 my ($self, $text, $cb, $value) = @_;
1595
1596 my $item; $item = {
1597 type => "button",
1598 text => " $text",
1599 value => $value,
1600 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1601 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1602 };
1603
1604 $self->add_item ($item);
1605 }
1606
1607 =item $popup->show
1608
1609 Displays the popup (which is initially hidden).
1610
1611 =cut
1612
1613 sub show {
1614 my ($self) = @_;
1615
1616 local $urxvt::popup::self = $self;
1617
1618 my $env = $self->{term}->env;
1619 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1620 delete $env->{LC_ALL};
1621 $env->{LC_CTYPE} = $self->{term}->locale;
1622
1623 urxvt::term->new ($env, "popup",
1624 "--perl-lib" => "", "--perl-ext-common" => "",
1625 "-pty-fd" => -1, "-sl" => 0,
1626 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1627 "--transient-for" => $self->{term}->parent,
1628 "-display" => $self->{term}->display_id,
1629 "-pe" => "urxvt-popup")
1630 or die "unable to create popup window\n";
1631 }
1632
1633 sub DESTROY {
1634 my ($self) = @_;
1635
1636 delete $self->{term}{_destroy}{$self};
1637 $self->{term}->ungrab;
1638 }
1639
1640 =back
1641
1642 =head2 The C<urxvt::timer> Class
1643
1644 This class implements timer watchers/events. Time is represented as a
1645 fractional number of seconds since the epoch. Example:
1646
1647 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
1648 $term->{timer} = urxvt::timer
1649 ->new
1650 ->interval (1)
1651 ->cb (sub {
1652 $term->{overlay}->set (0, 0,
1653 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1654 });
1655
1656 =over 4
1657
1658 =item $timer = new urxvt::timer
1659
1660 Create a new timer object in started state. It is scheduled to fire
1661 immediately.
1662
1663 =item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1664
1665 Set the callback to be called when the timer triggers.
1666
1667 =item $tstamp = $timer->at
1668
1669 Return the time this watcher will fire next.
1670
1671 =item $timer = $timer->set ($tstamp)
1672
1673 Set the time the event is generated to $tstamp.
1674
1675 =item $timer = $timer->interval ($interval)
1676
1677 Normally (and when C<$interval> is C<0>), the timer will automatically
1678 stop after it has fired once. If C<$interval> is non-zero, then the timer
1679 is automatically rescheduled at the given intervals.
1680
1681 =item $timer = $timer->start
1682
1683 Start the timer.
1684
1685 =item $timer = $timer->start ($tstamp)
1686
1687 Set the event trigger time to C<$tstamp> and start the timer.
1688
1689 =item $timer = $timer->after ($delay)
1690
1691 Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1692
1693 =item $timer = $timer->stop
1694
1695 Stop the timer.
1696
1697 =back
1698
1699 =head2 The C<urxvt::iow> Class
1700
1701 This class implements io watchers/events. Example:
1702
1703 $term->{socket} = ...
1704 $term->{iow} = urxvt::iow
1705 ->new
1706 ->fd (fileno $term->{socket})
1707 ->events (urxvt::EVENT_READ)
1708 ->start
1709 ->cb (sub {
1710 my ($iow, $revents) = @_;
1711 # $revents must be 1 here, no need to check
1712 sysread $term->{socket}, my $buf, 8192
1713 or end-of-file;
1714 });
1715
1716
1717 =over 4
1718
1719 =item $iow = new urxvt::iow
1720
1721 Create a new io watcher object in stopped state.
1722
1723 =item $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
1724
1725 Set the callback to be called when io events are triggered. C<$reventmask>
1726 is a bitset as described in the C<events> method.
1727
1728 =item $iow = $iow->fd ($fd)
1729
1730 Set the filedescriptor (not handle) to watch.
1731
1732 =item $iow = $iow->events ($eventmask)
1733
1734 Set the event mask to watch. The only allowed values are
1735 C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1736 together, or C<urxvt::EVENT_NONE>.
1737
1738 =item $iow = $iow->start
1739
1740 Start watching for requested events on the given handle.
1741
1742 =item $iow = $iow->stop
1743
1744 Stop watching for events on the given filehandle.
1745
1746 =back
1747
1748 =head1 ENVIRONMENT
1749
1750 =head2 URXVT_PERL_VERBOSITY
1751
1752 This variable controls the verbosity level of the perl extension. Higher
1753 numbers indicate more verbose output.
1754
1755 =over 4
1756
1757 =item == 0 - fatal messages
1758
1759 =item >= 3 - script loading and management
1760
1761 =item >=10 - all called hooks
1762
1763 =item >=11 - hook reutrn values
1764
1765 =back
1766
1767 =head1 AUTHOR
1768
1769 Marc Lehmann <pcg@goof.com>
1770 http://software.schmorp.de/pkg/rxvt-unicode
1771
1772 =cut
1773
1774 1