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.44 by root, Sat Jan 7 19:29:17 2006 UTC vs.
Revision 1.109 by root, Thu Jan 19 16:07:09 2006 UTC

26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31=head2 Prepackaged Extensions 31=head1 PREPACKAGED EXTENSIONS
32 32
33This section describes the extensiosn delivered with this version. You can 33This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39 39
40=over 4 40=over 4
41 41
42=item selection 42=item selection (enabled by default)
43 43
44Intelligent selection. This extension tries to be more intelligent when 44(More) intelligent selection. This extension tries to be more intelligent
45the user extends selections (double-click). Right now, it tries to select 45when the user extends selections (double-click and further clicks). Right
46urls and complete shell-quoted arguments, which is very convenient, too, 46now, it tries to select words, urls and complete shell-quoted
47if your F<ls> supports C<--quoting-style=shell>. 47arguments, which is very convenient, too, if your F<ls> supports
48C<--quoting-style=shell>.
48 49
49It also offers the following bindable event: 50A double-click usually selects the word under the cursor, further clicks
51will enlarge the selection.
52
53The selection works by trying to match a number of regexes and displaying
54them in increasing order of length. You can add your own regexes by
55specifying resources of the form:
56
57 URxvt.selection.pattern-0: perl-regex
58 URxvt.selection.pattern-1: perl-regex
59 ...
60
61The index number (0, 1...) must not have any holes, and each regex must
62contain at least one pair of capturing parentheses, which will be used for
63the match. For example, the followign adds a regex that matches everything
64between two vertical bars:
65
66 URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end.
70
71This extension also offers following bindable keyboard commands:
50 72
51=over 4 73=over 4
52 74
53=item rot13 75=item rot13
54 76
56 78
57 URxvt.keysym.C-M-r: perl:selection:rot13 79 URxvt.keysym.C-M-r: perl:selection:rot13
58 80
59=back 81=back
60 82
61=item digital-clock 83=item option-popup (enabled by default)
62 84
63Displays a digital clock using the built-in overlay. 85Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86runtime.
87
88=item selection-popup (enabled by default)
89
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content.
93
94Other extensions can extend this popup menu by pushing a code reference onto
95C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
96
97It's sole argument is the popup menu, which can be modified. The selection
98is in C<$_>, which can be used to decide wether to add something or not.
99It should either return nothing or a string and a code reference. The
100string will be used as button text and the code reference will be called
101when the button gets activated and should transform C<$_>.
102
103The following will add an entry C<a to b> that transforms all C<a>s in
104the selection to C<b>s, but only if the selection currently contains any
105C<a>s:
106
107 push urxvt::ext::selection_popup::hook, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g }
109 : ()
110 };
111
112Don't run it in a hook, otherwise the menu will grow and grow. Instead put
113it at the toplevel of your extension.
114
115=item searchable-scrollback<hotkey> (enabled by default)
116
117Adds regex search functionality to the scrollback buffer, triggered
118by a hotkey (default: C<M-s>). While in search mode, normal terminal
119input/output is suspended and a regex is displayed at the bottom of the
120screen.
121
122Inputting characters appends them to the regex and continues incremental
123search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
124search upwards/downwards in the scrollback buffer, C<End> jumps to the
125bottom. C<Escape> leaves search mode and returns to the point where search
126was started, while C<Enter> or C<Return> stay at the current position and
127additionally stores the first match in the current line into the primary
128selection.
129
130=item selection-autotransform
131
132This selection allows you to do automatic transforms on a selection
133whenever a selection is made.
134
135It works by specifying perl snippets (most useful is a single C<s///>
136operator) that modify C<$_> as resources:
137
138 URxvt.selection-autotransform.0: transform
139 URxvt.selection-autotransform.1: transform
140 ...
141
142For example, the following will transform selections of the form
143C<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
148And this example matches the same,but replaces it with vi-commands you can
149paste directly into your (vi :) editor:
150
151 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
152
153Of course, this can be modified to suit your needs and your editor :)
154
155To expand the example above to typical perl error messages ("XXX at
156FILENAME 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
161The first line tells the selection code to treat the unchanging part of
162every error message as a selection pattern, and the second line transforms
163the message into vi commands to load the file.
64 164
65=item mark-urls 165=item mark-urls
66 166
67Uses per-line display filtering (C<on_line_update>) to underline urls. 167Uses per-line display filtering (C<on_line_update>) to underline urls and
168make them clickable. When middle-clicked, the program specified in the
169resource C<urlLauncher> (default C<x-www-browser>) will be started with
170the URL as first argument.
171
172=item automove-background
173
174This is basically a one-line extension that dynamically changes the background pixmap offset
175to the window position, in effect creating the same effect as pseudo transparency with
176a custom pixmap. No scaling is supported in this mode. Exmaple:
177
178 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
68 179
69=item block-graphics-to-ascii 180=item block-graphics-to-ascii
70 181
71A not very useful example of filtering all text output to the terminal, 182A not very useful example of filtering all text output to the terminal,
72by replacing all line-drawing characters (U+2500 .. U+259F) by a 183by replacing all line-drawing characters (U+2500 .. U+259F) by a
73similar-looking ascii character. 184similar-looking ascii character.
74 185
186=item digital-clock
187
188Displays a digital clock using the built-in overlay.
189
75=item example-refresh-hooks 190=item example-refresh-hooks
76 191
77Displays a very simple digital clock in the upper right corner of the 192Displays a very simple digital clock in the upper right corner of the
78window. Illustrates overwriting the refresh callbacks to create your own 193window. Illustrates overwriting the refresh callbacks to create your own
79overlays or changes. 194overlays or changes.
80 195
196=item selection-pastebin
197
198This is a little rarely useful extension that Uploads the selection as
199textfile to a remote site (or does other things). (The implementation is
200not currently secure for use in a multiuser environment as it writes to
201F</tmp> directly.).
202
203It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
204i.e.
205
206 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
207
208Pressing this combination runs a command with C<%> replaced by the name of
209the 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
213And the default is likely not useful to anybody but the few people around
214here :)
215
216The name of the textfile is the hex encoded md5 sum of the selection, so
217the same content should lead to the same filename.
218
219After a successful upload the selection will be replaced by the text given
220in the C<selection-pastebin-url> resource (again, the % is the placeholder
221for the filename):
222
223 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
224
81=back 225=back
226
227=head1 API DOCUMENTATION
82 228
83=head2 General API Considerations 229=head2 General API Considerations
84 230
85All objects (such as terminals, time watchers etc.) are typical 231All objects (such as terminals, time watchers etc.) are typical
86reference-to-hash objects. The hash can be used to store anything you 232reference-to-hash objects. The hash can be used to store anything you
99=over 4 245=over 4
100 246
101=item $text 247=item $text
102 248
103Rxvt-unicodes special way of encoding text, where one "unicode" character 249Rxvt-unicodes special way of encoding text, where one "unicode" character
104always represents one screen cell. See L<row_t> for a discussion of this format. 250always represents one screen cell. See L<ROW_t> for a discussion of this format.
105 251
106=item $string 252=item $string
107 253
108A perl text string, with an emphasis on I<text>. It can store all unicode 254A perl text string, with an emphasis on I<text>. It can store all unicode
109characters and is to be distinguished with text encoded in a specific 255characters and is to be distinguished with text encoded in a specific
114Either binary data or - more common - a text string encoded in a 260Either binary data or - more common - a text string encoded in a
115locale-specific way. 261locale-specific way.
116 262
117=back 263=back
118 264
265=head2 Extension Objects
266
267Very perl extension is a perl class. A separate perl object is created
268for each terminal and each extension and passed as the first parameter to
269hooks. So extensions can use their C<$self> object without having to think
270about other extensions, with the exception of methods and members that
271begin with an underscore character C<_>: these are reserved for internal
272use.
273
274Although it isn't a C<urxvt::term> object, you can call all methods of the
275C<urxvt::term> class on this object.
276
277It has the following methods and data members:
278
279=over 4
280
281=item $urxvt_term = $self->{term}
282
283Returns the C<urxvt::term> object associated with this instance of the
284extension. This member I<must not> be changed in any way.
285
286=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
287
288Dynamically enable the given hooks (named without the C<on_> prefix) for
289this extension, replacing any previous hook. This is useful when you want
290to overwrite time-critical hooks only temporarily.
291
292=item $self->disable ($hook_name[, $hook_name..])
293
294Dynamically disable the given hooks.
295
296=back
297
119=head2 Hooks 298=head2 Hooks
120 299
121The following subroutines can be declared in extension files, and will be 300The following subroutines can be declared in extension files, and will be
122called whenever the relevant event happens. 301called whenever the relevant event happens.
123 302
124The first argument passed to them is an object private to each terminal 303The first argument passed to them is an extension oject as described in
125and extension package. You can call all C<urxvt::term> methods on it, but 304the in the C<Extension Objects> section.
126its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127object that is shared between all packages is stored in the C<term>
128member. It is, however, blessed intot he package of the extension script,
129so for all practical purposes you can treat an extension script as a class.
130 305
131All of them must return a boolean value. If it is true, then the event 306B<All> of these hooks must return a boolean value. If it is true, then the
132counts as being I<consumed>, and the invocation of other hooks is skipped, 307event counts as being I<consumed>, and the invocation of other hooks is
133and the relevant action might not be carried out by the C++ code. 308skipped, and the relevant action might not be carried out by the C++ code.
134 309
135When in doubt, return a false value (preferably C<()>). 310I<< When in doubt, return a false value (preferably C<()>). >>
136 311
137=over 4 312=over 4
138 313
139=item on_init $term 314=item on_init $term
140 315
153=item on_start $term 328=item on_start $term
154 329
155Called at the very end of initialisation of a new terminal, just before 330Called at the very end of initialisation of a new terminal, just before
156returning to the mainloop. 331returning to the mainloop.
157 332
333=item on_child_start $term, $pid
334
335Called just after the child process has been C<fork>ed.
336
337=item on_child_exit $term, $status
338
339Called just after the child process has exited. C<$status> is the status
340from C<waitpid>.
341
158=item on_sel_make $term, $eventtime 342=item on_sel_make $term, $eventtime
159 343
160Called whenever a selection has been made by the user, but before the 344Called whenever a selection has been made by the user, but before the
161selection text is copied, so changes to the beginning, end or type of the 345selection text is copied, so changes to the beginning, end or type of the
162selection will be honored. 346selection will be honored.
175=item on_sel_extend $term 359=item on_sel_extend $term
176 360
177Called whenever the user tries to extend the selection (e.g. with a double 361Called whenever the user tries to extend the selection (e.g. with a double
178click) and is either supposed to return false (normal operation), or 362click) and is either supposed to return false (normal operation), or
179should extend the selection itelf and return true to suppress the built-in 363should extend the selection itelf and return true to suppress the built-in
180processing. 364processing. This can happen multiple times, as long as the callback
365returns true, it will be called on every further click by the user and is
366supposed to enlarge the selection more and more, if possible.
181 367
182See the F<selection> example extension. 368See the F<selection> example extension.
183
184=item on_focus_in $term
185
186Called whenever the window gets the keyboard focus, before urxvt does
187focus in processing.
188
189=item on_focus_out $term
190
191Called wheneever the window loses keyboard focus, before urxvt does focus
192out processing.
193 369
194=item on_view_change $term, $offset 370=item on_view_change $term, $offset
195 371
196Called whenever the view offset changes, i..e the user or program 372Called whenever the view offset changes, i..e the user or program
197scrolls. Offset C<0> means display the normal terminal, positive values 373scrolls. Offset C<0> means display the normal terminal, positive values
204than the scroll back buffer or the terminal. 380than the scroll back buffer or the terminal.
205 381
206It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 382It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
207$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 383$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
208number of lines that will be in the scrollback buffer. 384number of lines that will be in the scrollback buffer.
209
210=item on_tty_activity $term *NYI*
211
212Called whenever the program(s) running in the urxvt window send output.
213 385
214=item on_osc_seq $term, $string 386=item on_osc_seq $term, $string
215 387
216Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 388Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217operating system command) is processed. Cursor position and other state 389operating system command) is processed. Cursor position and other state
230can filter/change and output the text yourself by returning a true value 402can filter/change and output the text yourself by returning a true value
231and calling C<< $term->scr_add_lines >> yourself. Please note that this 403and calling C<< $term->scr_add_lines >> yourself. Please note that this
232might be very slow, however, as your hook is called for B<all> text being 404might be very slow, however, as your hook is called for B<all> text being
233output. 405output.
234 406
407=item on_tt_write $term, $octets
408
409Called whenever some data is written to the tty/pty and can be used to
410suppress or filter tty input.
411
235=item on_line_update $term, $row 412=item on_line_update $term, $row
236 413
237Called whenever a line was updated or changed. Can be used to filter 414Called whenever a line was updated or changed. Can be used to filter
238screen output (e.g. underline urls or other useless stuff). Only lines 415screen output (e.g. underline urls or other useless stuff). Only lines
239that are being shown will be filtered, and, due to performance reasons, 416that are being shown will be filtered, and, due to performance reasons,
261 438
262Called whenever the user presses a key combination that has a 439Called whenever the user presses a key combination that has a
263C<perl:string> action bound to it (see description of the B<keysym> 440C<perl:string> action bound to it (see description of the B<keysym>
264resource in the @@RXVT_NAME@@(1) manpage). 441resource in the @@RXVT_NAME@@(1) manpage).
265 442
443=item on_x_event $term, $event
444
445Called on every X event received on the vt window (and possibly other
446windows). Should only be used as a last resort. Most event structure
447members are not passed.
448
449=item on_focus_in $term
450
451Called whenever the window gets the keyboard focus, before rxvt-unicode
452does focus in processing.
453
454=item on_focus_out $term
455
456Called wheneever the window loses keyboard focus, before rxvt-unicode does
457focus out processing.
458
459=item on_configure_notify $term, $event
460
266=item on_key_press $term, $event, $octets 461=item on_key_press $term, $event, $keysym, $octets
267 462
268=item on_key_release $term, $event 463=item on_key_release $term, $event, $keysym
269 464
270=item on_button_press $term, $event 465=item on_button_press $term, $event
271 466
272=item on_button_release $term, $event 467=item on_button_release $term, $event
273 468
274=item on_motion_notify $term, $event 469=item on_motion_notify $term, $event
470
471=item on_map_notify $term, $event
472
473=item on_unmap_notify $term, $event
275 474
276Called whenever the corresponding X event is received for the terminal If 475Called whenever the corresponding X event is received for the terminal If
277the hook returns true, then the even will be ignored by rxvt-unicode. 476the hook returns true, then the even will be ignored by rxvt-unicode.
278 477
279The event is a hash with most values as named by Xlib (see the XEvent 478The event is a hash with most values as named by Xlib (see the XEvent
285 484
286subwindow. 485subwindow.
287 486
288=back 487=back
289 488
489=cut
490
491package urxvt;
492
493use utf8;
494use strict;
495use Carp ();
496use Scalar::Util ();
497use List::Util ();
498
499our $VERSION = 1;
500our $TERM;
501our @HOOKNAME;
502our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
503our %OPTION;
504
505our $LIBDIR;
506our $RESNAME;
507our $RESCLASS;
508our $RXVTNAME;
509
290=head2 Variables in the C<urxvt> Package 510=head2 Variables in the C<urxvt> Package
291 511
292=over 4 512=over 4
513
514=item $urxvt::LIBDIR
515
516The rxvt-unicode library directory, where, among other things, the perl
517modules and scripts are stored.
518
519=item $urxvt::RESCLASS, $urxvt::RESCLASS
520
521The resource class and name rxvt-unicode uses to look up X resources.
522
523=item $urxvt::RXVTNAME
524
525The basename of the installed binaries, usually C<urxvt>.
293 526
294=item $urxvt::TERM 527=item $urxvt::TERM
295 528
296The current terminal. This variable stores the current C<urxvt::term> 529The current terminal. This variable stores the current C<urxvt::term>
297object, whenever a callback/hook is executing. 530object, whenever a callback/hook is executing.
299=back 532=back
300 533
301=head2 Functions in the C<urxvt> Package 534=head2 Functions in the C<urxvt> Package
302 535
303=over 4 536=over 4
304
305=item $term = new urxvt [arg...]
306
307Creates a new terminal, very similar as if you had started it with
308C<system $binfile, arg...>. Croaks (and probably outputs an error message)
309if the new instance couldn't be created. Returns C<undef> if the new
310instance didn't initialise perl, and the terminal object otherwise. The
311C<init> and C<start> hooks will be called during the call.
312 537
313=item urxvt::fatal $errormessage 538=item urxvt::fatal $errormessage
314 539
315Fatally aborts execution with the given error message. Avoid at all 540Fatally aborts execution with the given error message. Avoid at all
316costs! The only time this is acceptable is when the terminal process 541costs! The only time this is acceptable is when the terminal process
323that calls this function. 548that calls this function.
324 549
325Using this function has the advantage that its output ends up in the 550Using this function has the advantage that its output ends up in the
326correct place, e.g. on stderr of the connecting urxvtc client. 551correct place, e.g. on stderr of the connecting urxvtc client.
327 552
553Messages have a size limit of 1023 bytes currently.
554
328=item $time = urxvt::NOW 555=item $time = urxvt::NOW
329 556
330Returns the "current time" (as per the event loop). 557Returns the "current time" (as per the event loop).
558
559=item urxvt::CurrentTime
560
561=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
562Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
563Button4Mask, Button5Mask, AnyModifier
564
565=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
566ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
567PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
568Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
569KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
570ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
571FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
572
573=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
574EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
575GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
576UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
577ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
578CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
579SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
580
581Various constants for use in X calls and event processing.
331 582
332=back 583=back
333 584
334=head2 RENDITION 585=head2 RENDITION
335 586
362 613
363=item $background = urxvt::GET_BASEBG $rend 614=item $background = urxvt::GET_BASEBG $rend
364 615
365Return the foreground/background colour index, respectively. 616Return the foreground/background colour index, respectively.
366 617
367=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 618=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
368 619
369=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 620=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
370 621
371Replace the foreground/background colour in the rendition mask with the 622Replace the foreground/background colour in the rendition mask with the
372specified one. 623specified one.
373 624
374=item $value = urxvt::GET_CUSTOM ($rend) 625=item $value = urxvt::GET_CUSTOM $rend
375 626
376Return the "custom" value: Every rendition has 5 bits for use by 627Return the "custom" value: Every rendition has 5 bits for use by
377extensions. They can be set and changed as you like and are initially 628extensions. They can be set and changed as you like and are initially
378zero. 629zero.
379 630
380=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 631=item $rend = urxvt::SET_CUSTOM $rend, $new_value
381 632
382Change the custom value. 633Change the custom value.
383 634
384=back 635=back
385 636
386=cut 637=cut
387 638
388package urxvt;
389
390use strict;
391use Scalar::Util ();
392
393our $TERM;
394our @HOOKNAME;
395our $LIBDIR;
396
397BEGIN { 639BEGIN {
398 urxvt->bootstrap;
399
400 # overwrite perl's warn 640 # overwrite perl's warn
401 *CORE::GLOBAL::warn = sub { 641 *CORE::GLOBAL::warn = sub {
402 my $msg = join "", @_; 642 my $msg = join "", @_;
403 $msg .= "\n" 643 $msg .= "\n"
404 unless $msg =~ /\n$/; 644 unless $msg =~ /\n$/;
405 urxvt::warn ($msg); 645 urxvt::warn ($msg);
406 }; 646 };
407} 647}
408 648
409my @hook_count;
410my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 649my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
411 650
412sub verbose { 651sub verbose {
413 my ($level, $msg) = @_; 652 my ($level, $msg) = @_;
414 warn "$msg\n" if $level <= $verbosity; 653 warn "$msg\n" if $level <= $verbosity;
415} 654}
416 655
417# find on_xxx subs in the package and register them
418# as hooks
419sub register_package($) {
420 my ($pkg) = @_;
421
422 for my $htype (0.. $#HOOKNAME) {
423 my $name = $HOOKNAME[$htype];
424
425 my $ref = $pkg->can ("on_" . lc $name)
426 or next;
427
428 $TERM->{_hook}[$htype]{$pkg} = $ref;
429 $hook_count[$htype]++
430 or set_should_invoke $htype, 1;
431 }
432}
433
434my $extension_pkg = "extension0000";
435my %extension_pkg; 656my %extension_pkg;
436 657
437# load a single script into its own package, once only 658# load a single script into its own package, once only
438sub extension_package($) { 659sub extension_package($) {
439 my ($path) = @_; 660 my ($path) = @_;
440 661
662 no strict 'refs';
663
441 $extension_pkg{$path} ||= do { 664 $extension_pkg{$path} ||= do {
442 my $pkg = "urxvt::" . ($extension_pkg++); 665 $path =~ /([^\/\\]+)$/;
666 my $pkg = $1;
667 $pkg =~ s/[^[:word:]]/_/g;
668 $pkg = "urxvt::ext::$pkg";
443 669
444 verbose 3, "loading extension '$path' into package '$pkg'"; 670 verbose 3, "loading extension '$path' into package '$pkg'";
445 671
446 open my $fh, "<:raw", $path 672 open my $fh, "<:raw", $path
447 or die "$path: $!"; 673 or die "$path: $!";
448 674
675 @{"$pkg\::ISA"} = urxvt::term::extension::;
676
677 my $source =
449 my $source = "package $pkg; use strict; use utf8;\n" 678 "package $pkg; use strict; use utf8;\n"
450 . "use base urxvt::term::proxy::;\n"
451 . "#line 1 \"$path\"\n{\n" 679 . "#line 1 \"$path\"\n{\n"
452 . (do { local $/; <$fh> }) 680 . (do { local $/; <$fh> })
453 . "\n};\n1"; 681 . "\n};\n1";
454 682
683 eval $source
455 eval $source or die "$path: $@"; 684 or die "$path: $@";
456 685
457 $pkg 686 $pkg
458 } 687 }
459} 688}
460 689
465 local $TERM = shift; 694 local $TERM = shift;
466 my $htype = shift; 695 my $htype = shift;
467 696
468 if ($htype == 0) { # INIT 697 if ($htype == 0) { # INIT
469 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 698 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
699
700 my %ext_arg;
470 701
471 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 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) {
472 my @files = grep -f $_, map "$_/$ext", @dirs; 715 my @files = grep -f $_, map "$_/$ext", @dirs;
473 716
474 if (@files) { 717 if (@files) {
475 register_package extension_package $files[0]; 718 $TERM->register_package (extension_package $files[0], $argv);
476 } else { 719 } else {
477 warn "perl extension '$ext' not found in perl library search path\n"; 720 warn "perl extension '$ext' not found in perl library search path\n";
478 } 721 }
479 } 722 }
723
724 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
725 warn $@ if $@;
480 } 726 }
481 727
482 $retval = undef; 728 $retval = undef;
483 729
484 if (my $cb = $TERM->{_hook}[$htype]) { 730 if (my $cb = $TERM->{_hook}[$htype]) {
486 if $verbosity >= 10; 732 if $verbosity >= 10;
487 733
488 keys %$cb; 734 keys %$cb;
489 735
490 while (my ($pkg, $cb) = each %$cb) { 736 while (my ($pkg, $cb) = each %$cb) {
491 eval { 737 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
492 $retval = $cb->(
493 $TERM->{_pkg}{$pkg} ||= do {
494 my $proxy = bless { }, $pkg;
495 Scalar::Util::weaken ($proxy->{term} = $TERM);
496 $proxy
497 },
498 @_,
499 ) and last; 738 and last;
500 };
501 warn $@ if $@;#d#
502 }
503 }
504 739
505 if ($htype == 1) { # DESTROY 740 if ($@) {
506 # remove hooks if unused 741 $TERM->ungrab; # better to lose the grab than the session
507 if (my $hook = $TERM->{_hook}) { 742 warn $@;
508 for my $htype (0..$#$hook) {
509 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
510 or set_should_invoke $htype, 0;
511 } 743 }
512 } 744 }
513 745
746 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
747 if $verbosity >= 11;
748 }
749
750 if ($htype == 1) { # DESTROY
514 # clear package objects 751 # clear package objects
515 %$_ = () for values %{ $TERM->{_pkg} }; 752 %$_ = () for values %{ $TERM->{_pkg} };
516 753
517 # clear package 754 # clear package
518 %$TERM = (); 755 %$TERM = ();
519 } 756 }
520 757
521 $retval 758 $retval
522} 759}
523 760
524sub urxvt::term::proxy::AUTOLOAD { 761# urxvt::term::extension
525 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 762
763package urxvt::term::extension;
764
765sub 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
781sub 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
795our $AUTOLOAD;
796
797sub AUTOLOAD {
798 $AUTOLOAD =~ /:([^:]+)$/
526 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 799 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
527 800
528 eval qq{ 801 eval qq{
529 sub $urxvt::term::proxy::AUTOLOAD { 802 sub $AUTOLOAD {
530 my \$proxy = shift; 803 my \$proxy = shift;
531 \$proxy->{term}->$1 (\@_) 804 \$proxy->{term}->$1 (\@_)
532 } 805 }
533 1 806 1
534 } or die "FATAL: unable to compile method forwarder: $@"; 807 } or die "FATAL: unable to compile method forwarder: $@";
535 808
536 goto &$urxvt::term::proxy::AUTOLOAD; 809 goto &$AUTOLOAD;
537} 810}
811
812sub DESTROY {
813 # nop
814}
815
816# urxvt::destroy_hook
817
818sub urxvt::destroy_hook::DESTROY {
819 ${$_[0]}->();
820}
821
822sub urxvt::destroy_hook(&) {
823 bless \shift, urxvt::destroy_hook::
824}
825
826package urxvt::anyevent;
827
828=head2 The C<urxvt::anyevent> Class
829
830The sole purpose of this class is to deliver an interface to the
831C<AnyEvent> module - any module using it will work inside urxvt without
832further programming. The only exception is that you cannot wait on
833condition variables, but non-blocking condvar use is ok. What this means
834is that you cannot use blocking APIs, but the non-blocking variant should
835work.
836
837=cut
838
839our $VERSION = 1;
840
841$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
842push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
843
844sub 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
858sub 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
876sub DESTROY {
877 $_[0][1]->stop;
878}
879
880sub condvar {
881 bless \my $flag, urxvt::anyevent::condvar::
882}
883
884sub urxvt::anyevent::condvar::broadcast {
885 ${$_[0]}++;
886}
887
888sub 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
894package urxvt::term;
538 895
539=head2 The C<urxvt::term> Class 896=head2 The C<urxvt::term> Class
540 897
541=over 4 898=over 4
542 899
900=cut
901
902# find on_xxx subs in the package and register them
903# as hooks
904sub 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
924Creates a new terminal, very similar as if you had started it with system
925C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
926hash which defines the environment of the new terminal.
927
928Croaks (and probably outputs an error message) if the new instance
929couldn't be created. Returns C<undef> if the new instance didn't
930initialise perl, and the terminal object otherwise. The C<init> and
931C<start> hooks will be called during this call.
932
933=cut
934
935sub new {
936 my ($class, $env, @args) = @_;
937
938 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
939}
940
543=item $term->destroy 941=item $term->destroy
544 942
545Destroy the terminal object (close the window, free resources etc.). 943Destroy the terminal object (close the window, free resources
944etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
945watchers (timers, io watchers) are still active.
946
947=item $term->exec_async ($cmd[, @args])
948
949Works like the combination of the C<fork>/C<exec> builtins, which executes
950("starts") programs in the background. This function takes care of setting
951the user environment before exec'ing the command (e.g. C<PATH>) and should
952be preferred over explicit calls to C<exec> or C<system>.
953
954Returns the pid of the subprocess or C<undef> on error.
955
956=cut
957
958sub 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
974Returns true if the option specified by C<$optval> is enabled, and
975optionally change it. All option values are stored by name in the hash
976C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
977
978Here is a a likely non-exhaustive list of option names, please see the
979source 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
546 987
547=item $value = $term->resource ($name[, $newval]) 988=item $value = $term->resource ($name[, $newval])
548 989
549Returns the current resource value associated with a given name and 990Returns the current resource value associated with a given name and
550optionally sets a new value. Setting values is most useful in the C<init> 991optionally sets a new value. Setting values is most useful in the C<init>
560 1001
561Please note that resource strings will currently only be freed when the 1002Please note that resource strings will currently only be freed when the
562terminal is destroyed, so changing options frequently will eat memory. 1003terminal is destroyed, so changing options frequently will eat memory.
563 1004
564Here is a a likely non-exhaustive list of resource names, not all of which 1005Here is a a likely non-exhaustive list of resource names, not all of which
565are supported in every build, please see the source to see the actual 1006are supported in every build, please see the source file F</src/rsinc.h>
566list: 1007to see the actual list:
567 1008
568 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1009 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
569 borderLess color cursorBlink cursorUnderline cutchars delete_key 1010 borderLess color cursorBlink cursorUnderline cutchars delete_key
570 display_name embed ext_bwidth fade font geometry hold iconName 1011 display_name embed ext_bwidth fade font geometry hold iconName
571 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1012 imFont imLocale inputMethod insecure int_bwidth intensityStyles
572 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1013 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
573 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1014 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
574 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1015 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
575 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1016 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
576 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1017 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
577 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1018 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
578 shade term_name title transparent transparent_all tripleclickwords 1019 secondaryScreen secondaryScroll selectstyle shade term_name title
579 utmpInhibit visualBell 1020 transient_for transparent transparent_all tripleclickwords utmpInhibit
1021 visualBell
580 1022
581=cut 1023=cut
582 1024
583sub urxvt::term::resource($$;$) { 1025sub resource($$;$) {
584 my ($self, $name) = (shift, shift); 1026 my ($self, $name) = (shift, shift);
585 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1027 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
586 goto &urxvt::term::_resource; 1028 &urxvt::term::_resource
587} 1029}
1030
1031=item $value = $term->x_resource ($pattern)
1032
1033Returns the X-Resource for the given pattern, excluding the program or
1034class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1035same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1036resource with that pattern exists.
1037
1038This method should only be called during the C<on_start> hook, as there is
1039only one resource database per display, and later invocations might return
1040the wrong resources.
1041
1042=item $success = $term->parse_keysym ($keysym_spec, $command_string)
1043
1044Adds a keymap translation exactly as specified via a resource. See the
1045C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
588 1046
589=item $rend = $term->rstyle ([$new_rstyle]) 1047=item $rend = $term->rstyle ([$new_rstyle])
590 1048
591Return and optionally change the current rendition. Text that is output by 1049Return and optionally change the current rendition. Text that is output by
592the terminal application will use this style. 1050the terminal application will use this style.
603=item ($row, $col) = $term->selection_end ([$row, $col]) 1061=item ($row, $col) = $term->selection_end ([$row, $col])
604 1062
605Return the current values of the selection mark, begin or end positions, 1063Return the current values of the selection mark, begin or end positions,
606and optionally set them to new values. 1064and optionally set them to new values.
607 1065
1066=item $term->selection_make ($eventtime[, $rectangular])
1067
1068Tries to make a selection as set by C<selection_beg> and
1069C<selection_end>. If C<$rectangular> is true (default: false), a
1070rectangular selection will be made. This is the prefered function to make
1071a selection.
1072
608=item $success = $term->selection_grab ($eventtime) 1073=item $success = $term->selection_grab ($eventtime)
609 1074
610Try to request the primary selection from the server (for example, as set 1075Try to request the primary selection text from the server (for example, as
611by the next method). 1076set by the next method). No visual feedback will be given. This function
1077is mostly useful from within C<on_sel_grab> hooks.
612 1078
613=item $oldtext = $term->selection ([$newtext]) 1079=item $oldtext = $term->selection ([$newtext])
614 1080
615Return the current selection text and optionally replace it by C<$newtext>. 1081Return the current selection text and optionally replace it by C<$newtext>.
616 1082
617#=item $term->overlay ($x, $y, $text) 1083=item $term->overlay_simple ($x, $y, $text)
618# 1084
619#Create a simple multi-line overlay box. See the next method for details. 1085Create a simple multi-line overlay box. See the next method for details.
620# 1086
621#=cut 1087=cut
622# 1088
623#sub urxvt::term::scr_overlay { 1089sub overlay_simple {
624# my ($self, $x, $y, $text) = @_; 1090 my ($self, $x, $y, $text) = @_;
625# 1091
626# my @lines = split /\n/, $text; 1092 my @lines = split /\n/, $text;
627# 1093
628# my $w = 0; 1094 my $w = List::Util::max map $self->strwidth ($_), @lines;
629# for (map $self->strwidth ($_), @lines) { 1095
630# $w = $_ if $w < $_;
631# }
632#
633# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 1096 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
634# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 1097 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
635#} 1098
1099 $overlay
1100}
636 1101
637=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 1102=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
638 1103
639Create a new (empty) overlay at the given position with the given 1104Create a new (empty) overlay at the given position with the given
640width/height. C<$rstyle> defines the initial rendition style 1105width/height. C<$rstyle> defines the initial rendition style
667 1132
668If hidden, display the overlay again. 1133If hidden, display the overlay again.
669 1134
670=back 1135=back
671 1136
1137=item $popup = $term->popup ($event)
1138
1139Creates a new C<urxvt::popup> object that implements a popup menu. The
1140C<$event> I<must> be the event causing the menu to pop up (a button event,
1141currently).
1142
1143=cut
1144
1145sub 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
672=item $cellwidth = $term->strwidth ($string) 1164=item $cellwidth = $term->strwidth ($string)
673 1165
674Returns the number of screen-cells this string would need. Correctly 1166Returns the number of screen-cells this string would need. Correctly
675accounts for wide and combining characters. 1167accounts for wide and combining characters.
676 1168
679Convert the given text string into the corresponding locale encoding. 1171Convert the given text string into the corresponding locale encoding.
680 1172
681=item $string = $term->locale_decode ($octets) 1173=item $string = $term->locale_decode ($octets)
682 1174
683Convert the given locale-encoded octets into a perl string. 1175Convert 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
1179XORs 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
1181refresh 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
1185Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1186whitespace will additionally be xored with the C<$rstyle2>, which defaults
1187to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1188it instead. Both styles I<MUST NOT> contain font styles.
1189
1190=item $term->scr_bell
1191
1192Ring the bell!
684 1193
685=item $term->scr_add_lines ($string) 1194=item $term->scr_add_lines ($string)
686 1195
687Write the given text string to the screen, as if output by the application 1196Write the given text string to the screen, as if output by the application
688running inside the terminal. It may not contain command sequences (escape 1197running inside the terminal. It may not contain command sequences (escape
703 1212
704Write the octets given in C<$data> to the tty (i.e. as program input). To 1213Write the octets given in C<$data> to the tty (i.e. as program input). To
705pass characters instead of octets, you should convert your strings first 1214pass characters instead of octets, you should convert your strings first
706to the locale-specific encoding using C<< $term->locale_encode >>. 1215to the locale-specific encoding using C<< $term->locale_encode >>.
707 1216
1217=item $old_events = $term->pty_ev_events ([$new_events])
1218
1219Replaces the event mask of the pty watcher by the given event mask. Can
1220be used to suppress input and output handling to the pty/tty. See the
1221description of C<< urxvt::timer->events >>. Make sure to always restore
1222the previous value.
1223
708=item $windowid = $term->parent 1224=item $windowid = $term->parent
709 1225
710Return the window id of the toplevel window. 1226Return the window id of the toplevel window.
711 1227
712=item $windowid = $term->vt 1228=item $windowid = $term->vt
713 1229
714Return the window id of the terminal window. 1230Return the window id of the terminal window.
715 1231
1232=item $term->vt_emask_add ($x_event_mask)
1233
1234Adds the specified events to the vt event mask. Useful e.g. when you want
1235to receive pointer events all the times:
1236
1237 $term->vt_emask_add (urxvt::PointerMotionMask);
1238
716=item $window_width = $term->width 1239=item $window_width = $term->width
717 1240
718=item $window_height = $term->height 1241=item $window_height = $term->height
719 1242
720=item $font_width = $term->fwidth 1243=item $font_width = $term->fwidth
733 1256
734=item $max_scrollback = $term->saveLines 1257=item $max_scrollback = $term->saveLines
735 1258
736=item $nrow_plus_saveLines = $term->total_rows 1259=item $nrow_plus_saveLines = $term->total_rows
737 1260
738=item $lines_in_scrollback = $term->nsaved 1261=item $topmost_scrollback_row = $term->top_row
739 1262
740Return various integers describing terminal characteristics. 1263Return various integers describing terminal characteristics.
741 1264
1265=item $x_display = $term->display_id
1266
1267Return the DISPLAY used by rxvt-unicode.
1268
1269=item $lc_ctype = $term->locale
1270
1271Returns the LC_CTYPE category string used by this rxvt-unicode.
1272
1273=item $env = $term->env
1274
1275Returns a copy of the environment in effect for the terminal as a hashref
1276similar to C<\%ENV>.
1277
1278=cut
1279
1280sub 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
1294Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1295AltGr), the meta key (often Alt) and the num lock key, if applicable.
1296
742=item $view_start = $term->view_start ([$newvalue]) 1297=item $view_start = $term->view_start ([$newvalue])
743 1298
744Returns the negative row number of the topmost line. Minimum value is 1299Returns the row number of the topmost displayed line. Maximum value is
745C<0>, which displays the normal terminal contents. Larger values scroll 1300C<0>, which displays the normal terminal contents. Lower values scroll
746this many lines into the scrollback buffer. 1301this many lines into the scrollback buffer.
747 1302
748=item $term->want_refresh 1303=item $term->want_refresh
749 1304
750Requests a screen refresh. At the next opportunity, rxvt-unicode will 1305Requests a screen refresh. At the next opportunity, rxvt-unicode will
829Return the row number of the first/last row of the line, respectively. 1384Return the row number of the first/last row of the line, respectively.
830 1385
831=item $offset = $line->offset_of ($row, $col) 1386=item $offset = $line->offset_of ($row, $col)
832 1387
833Returns the character offset of the given row|col pair within the logical 1388Returns the character offset of the given row|col pair within the logical
834line. 1389line. Works for rows outside the line, too, and returns corresponding
1390offsets outside the string.
835 1391
836=item ($row, $col) = $line->coord_of ($offset) 1392=item ($row, $col) = $line->coord_of ($offset)
837 1393
838Translates a string offset into terminal coordinates again. 1394Translates a string offset into terminal coordinates again.
839 1395
840=back 1396=back
841 1397
842=cut 1398=cut
843 1399
844sub urxvt::term::line { 1400sub line {
845 my ($self, $row) = @_; 1401 my ($self, $row) = @_;
846 1402
847 my $maxrow = $self->nrow - 1; 1403 my $maxrow = $self->nrow - 1;
848 1404
849 my ($beg, $end) = ($row, $row); 1405 my ($beg, $end) = ($row, $row);
913 $offset / $self->{ncol} + $self->{beg}, 1469 $offset / $self->{ncol} + $self->{beg},
914 $offset % $self->{ncol} 1470 $offset % $self->{ncol}
915 ) 1471 )
916} 1472}
917 1473
918=item ($row, $col) = $line->coord_of ($offset)
919=item $text = $term->special_encode $string 1474=item $text = $term->special_encode $string
920 1475
921Converts a perl string into the special encoding used by rxvt-unicode, 1476Converts a perl string into the special encoding used by rxvt-unicode,
922where one character corresponds to one screen cell. See 1477where one character corresponds to one screen cell. See
923C<< $term->ROW_t >> for details. 1478C<< $term->ROW_t >> for details.
924 1479
925=item $string = $term->special_decode $text 1480=item $string = $term->special_decode $text
926 1481
927Converts rxvt-unicodes text reprsentation into a perl string. See 1482Converts rxvt-unicodes text reprsentation into a perl string. See
928C<< $term->ROW_t >> for details. 1483C<< $term->ROW_t >> for details.
1484
1485=item $success = $term->grab_button ($button, $modifiermask)
1486
1487Registers a synchronous button grab. See the XGrabButton manpage.
1488
1489=item $success = $term->grab ($eventtime[, $sync])
1490
1491Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1492synchronous (C<$sync> is true). Also remembers the grab timestampe.
1493
1494=item $term->allow_events_async
1495
1496Calls XAllowEvents with AsyncBoth for the most recent grab.
1497
1498=item $term->allow_events_sync
1499
1500Calls XAllowEvents with SyncBoth for the most recent grab.
1501
1502=item $term->allow_events_replay
1503
1504Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1505recent grab.
1506
1507=item $term->ungrab
1508
1509Calls XUngrab for the most recent grab. Is called automatically on
1510evaluation errors, as it is better to lose the grab in the error case as
1511the session.
1512
1513=back
1514
1515=cut
1516
1517package urxvt::popup;
1518
1519=head2 The C<urxvt::popup> Class
1520
1521=over 4
1522
1523=cut
1524
1525sub 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
1539Adds a non-clickable title to the popup.
1540
1541=cut
1542
1543sub 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
1555Creates a separator, optionally using the character given as C<$sepchr>.
1556
1557=cut
1558
1559sub 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
1574Adds a clickable button to the popup. C<$cb> is called whenever it is
1575selected.
1576
1577=cut
1578
1579sub 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
1587Adds a toggle/checkbox item to the popup. Teh callback gets called
1588whenever it gets toggled, with a boolean indicating its value as its first
1589argument.
1590
1591=cut
1592
1593sub 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
1609Displays the popup (which is initially hidden).
1610
1611=cut
1612
1613sub 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
1633sub DESTROY {
1634 my ($self) = @_;
1635
1636 delete $self->{term}{_destroy}{$self};
1637 $self->{term}->ungrab;
1638}
929 1639
930=back 1640=back
931 1641
932=head2 The C<urxvt::timer> Class 1642=head2 The C<urxvt::timer> Class
933 1643
974 1684
975=item $timer = $timer->start ($tstamp) 1685=item $timer = $timer->start ($tstamp)
976 1686
977Set the event trigger time to C<$tstamp> and start the timer. 1687Set the event trigger time to C<$tstamp> and start the timer.
978 1688
1689=item $timer = $timer->after ($delay)
1690
1691Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1692
979=item $timer = $timer->stop 1693=item $timer = $timer->stop
980 1694
981Stop the timer. 1695Stop the timer.
982 1696
983=back 1697=back
988 1702
989 $term->{socket} = ... 1703 $term->{socket} = ...
990 $term->{iow} = urxvt::iow 1704 $term->{iow} = urxvt::iow
991 ->new 1705 ->new
992 ->fd (fileno $term->{socket}) 1706 ->fd (fileno $term->{socket})
993 ->events (1) # wait for read data 1707 ->events (urxvt::EVENT_READ)
994 ->start 1708 ->start
995 ->cb (sub { 1709 ->cb (sub {
996 my ($iow, $revents) = @_; 1710 my ($iow, $revents) = @_;
997 # $revents must be 1 here, no need to check 1711 # $revents must be 1 here, no need to check
998 sysread $term->{socket}, my $buf, 8192 1712 sysread $term->{socket}, my $buf, 8192
1015 1729
1016Set the filedescriptor (not handle) to watch. 1730Set the filedescriptor (not handle) to watch.
1017 1731
1018=item $iow = $iow->events ($eventmask) 1732=item $iow = $iow->events ($eventmask)
1019 1733
1020Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 1734Set the event mask to watch. The only allowed values are
1021data, Bit #1 (value C<2>) enables watching for write data. 1735C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1736together, or C<urxvt::EVENT_NONE>.
1022 1737
1023=item $iow = $iow->start 1738=item $iow = $iow->start
1024 1739
1025Start watching for requested events on the given handle. 1740Start watching for requested events on the given handle.
1026 1741
1037This variable controls the verbosity level of the perl extension. Higher 1752This variable controls the verbosity level of the perl extension. Higher
1038numbers indicate more verbose output. 1753numbers indicate more verbose output.
1039 1754
1040=over 4 1755=over 4
1041 1756
1042=item =0 - only fatal messages 1757=item == 0 - fatal messages
1043 1758
1044=item =3 - script loading and management 1759=item >= 3 - script loading and management
1045 1760
1046=item =10 - all events received 1761=item >=10 - all called hooks
1762
1763=item >=11 - hook reutrn values
1047 1764
1048=back 1765=back
1049 1766
1050=head1 AUTHOR 1767=head1 AUTHOR
1051 1768

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines