… | |
… | |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Everytime a terminal object gets created, scripts specified via the |
22 | Everytime a terminal object gets created, extension scripts specified via |
23 | C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
… | |
… | |
39 | |
39 | |
40 | =over 4 |
40 | =over 4 |
41 | |
41 | |
42 | =item selection |
42 | =item selection |
43 | |
43 | |
44 | Miscellaneous selection modifications. |
44 | Intelligent selection. This extension tries to be more intelligent when |
|
|
45 | the user extends selections (double-click). Right now, it tries to select |
|
|
46 | urls and complete shell-quoted arguments, which is very convenient, too, |
|
|
47 | if your F<ls> supports C<--quoting-style=shell>. |
|
|
48 | |
|
|
49 | It also offers the following bindable event: |
45 | |
50 | |
46 | =over 4 |
51 | =over 4 |
47 | |
52 | |
48 | =item rot13 |
53 | =item rot13 |
49 | |
54 | |
… | |
… | |
52 | URxvt.keysym.C-M-r: perl:selection:rot13 |
57 | URxvt.keysym.C-M-r: perl:selection:rot13 |
53 | |
58 | |
54 | =back |
59 | =back |
55 | |
60 | |
56 | =item digital-clock |
61 | =item digital-clock |
|
|
62 | |
|
|
63 | Displays a digital clock using the built-in overlay. |
|
|
64 | |
|
|
65 | =item mark-urls |
|
|
66 | |
|
|
67 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
|
|
68 | |
|
|
69 | =item block-graphics-to-ascii |
|
|
70 | |
|
|
71 | A not very useful example of filtering all text output to the terminal, |
|
|
72 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
73 | similar-looking ascii character. |
|
|
74 | |
|
|
75 | =item example-refresh-hooks |
57 | |
76 | |
58 | Displays a very simple digital clock in the upper right corner of the |
77 | Displays a very simple digital clock in the upper right corner of the |
59 | window. Illustrates overwriting the refresh callbacks to create your own |
78 | window. Illustrates overwriting the refresh callbacks to create your own |
60 | overlays or changes. |
79 | overlays or changes. |
61 | |
80 | |
62 | =item simple-overlay-clock |
|
|
63 | |
|
|
64 | Displays a digital clock using the built-in overlay (colourful, useless). |
|
|
65 | |
|
|
66 | =back |
81 | =back |
67 | |
82 | |
68 | =head2 General API Considerations |
83 | =head2 General API Considerations |
69 | |
84 | |
70 | All objects (such as terminals, time watchers etc.) are typical |
85 | All objects (such as terminals, time watchers etc.) are typical |
71 | reference-to-hash objects. The hash can be used to store anything you |
86 | reference-to-hash objects. The hash can be used to store anything you |
72 | like. All members starting with an underscore (such as C<_ptr> or |
87 | like. All members starting with an underscore (such as C<_ptr> or |
73 | C<_hook>) are reserved for internal uses and must not be accessed or |
88 | C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or |
74 | modified). |
89 | modified). |
75 | |
90 | |
76 | When objects are destroyed on the C++ side, the perl object hashes are |
91 | When objects are destroyed on the C++ side, the perl object hashes are |
77 | emptied, so its best to store related objects such as time watchers and |
92 | emptied, so its best to store related objects such as time watchers and |
78 | the like inside the terminal object so they get destroyed as soon as the |
93 | the like inside the terminal object so they get destroyed as soon as the |
79 | terminal is destroyed. |
94 | terminal is destroyed. |
80 | |
95 | |
|
|
96 | Argument names also often indicate the type of a parameter. Here are some |
|
|
97 | hints on what they mean: |
|
|
98 | |
|
|
99 | =over 4 |
|
|
100 | |
|
|
101 | =item $text |
|
|
102 | |
|
|
103 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
|
|
104 | always represents one screen cell. See L<row_t> for a discussion of this format. |
|
|
105 | |
|
|
106 | =item $string |
|
|
107 | |
|
|
108 | A perl text string, with an emphasis on I<text>. It can store all unicode |
|
|
109 | characters and is to be distinguished with text encoded in a specific |
|
|
110 | encoding (often locale-specific) and binary data. |
|
|
111 | |
|
|
112 | =item $octets |
|
|
113 | |
|
|
114 | Either binary data or - more common - a text string encoded in a |
|
|
115 | locale-specific way. |
|
|
116 | |
|
|
117 | =back |
|
|
118 | |
81 | =head2 Hooks |
119 | =head2 Hooks |
82 | |
120 | |
83 | The following subroutines can be declared in loaded scripts, and will be called |
121 | The following subroutines can be declared in extension files, and will be |
84 | whenever the relevant event happens. |
122 | called whenever the relevant event happens. |
|
|
123 | |
|
|
124 | The first argument passed to them is an object private to each terminal |
|
|
125 | and extension package. You can call all C<urxvt::term> methods on it, but |
|
|
126 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
|
|
127 | object that is shared between all packages is stored in the C<term> |
|
|
128 | member. It is, however, blessed intot he package of the extension script, |
|
|
129 | so for all practical purposes you can treat an extension script as a class. |
85 | |
130 | |
86 | All of them must return a boolean value. If it is true, then the event |
131 | All of them must return a boolean value. If it is true, then the event |
87 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
132 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
88 | and the relevant action might not be carried out by the C++ code. |
133 | and the relevant action might not be carried out by the C++ code. |
89 | |
134 | |
… | |
… | |
92 | =over 4 |
137 | =over 4 |
93 | |
138 | |
94 | =item on_init $term |
139 | =item on_init $term |
95 | |
140 | |
96 | Called after a new terminal object has been initialized, but before |
141 | Called after a new terminal object has been initialized, but before |
97 | windows are created or the command gets run. |
142 | windows are created or the command gets run. Most methods are unsafe to |
|
|
143 | call or deliver senseless data, as terminal size and other characteristics |
|
|
144 | have not yet been determined. You can safely query and change resources, |
|
|
145 | though. |
98 | |
146 | |
99 | =item on_reset $term |
147 | =item on_reset $term |
100 | |
148 | |
101 | Called after the screen is "reset" for any reason, such as resizing or |
149 | Called after the screen is "reset" for any reason, such as resizing or |
102 | control sequences. Here is where you can react on changes to size-related |
150 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
122 | requested from the server. The selection text can be queried and changed |
170 | requested from the server. The selection text can be queried and changed |
123 | by calling C<< $term->selection >>. |
171 | by calling C<< $term->selection >>. |
124 | |
172 | |
125 | Returning a true value aborts selection grabbing. It will still be hilighted. |
173 | Returning a true value aborts selection grabbing. It will still be hilighted. |
126 | |
174 | |
|
|
175 | =item on_sel_extend $term |
|
|
176 | |
|
|
177 | Called whenever the user tries to extend the selection (e.g. with a double |
|
|
178 | click) and is either supposed to return false (normal operation), or |
|
|
179 | should extend the selection itelf and return true to suppress the built-in |
|
|
180 | processing. |
|
|
181 | |
|
|
182 | See the F<selection> example extension. |
|
|
183 | |
127 | =item on_focus_in $term |
184 | =item on_focus_in $term |
128 | |
185 | |
129 | Called whenever the window gets the keyboard focus, before urxvt does |
186 | Called whenever the window gets the keyboard focus, before urxvt does |
130 | focus in processing. |
187 | focus in processing. |
131 | |
188 | |
… | |
… | |
151 | number of lines that will be in the scrollback buffer. |
208 | number of lines that will be in the scrollback buffer. |
152 | |
209 | |
153 | =item on_tty_activity $term *NYI* |
210 | =item on_tty_activity $term *NYI* |
154 | |
211 | |
155 | Called whenever the program(s) running in the urxvt window send output. |
212 | Called whenever the program(s) running in the urxvt window send output. |
|
|
213 | |
|
|
214 | =item on_osc_seq $term, $string |
|
|
215 | |
|
|
216 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
|
|
217 | operating system command) is processed. Cursor position and other state |
|
|
218 | information is up-to-date when this happens. For interoperability, the |
|
|
219 | string should start with the extension name and a colon, to distinguish |
|
|
220 | it from commands for other extensions, and this might be enforced in the |
|
|
221 | future. |
|
|
222 | |
|
|
223 | Be careful not ever to trust (in a security sense) the data you receive, |
|
|
224 | as its source can not easily be controleld (e-mail content, messages from |
|
|
225 | other users on the same system etc.). |
|
|
226 | |
|
|
227 | =item on_add_lines $term, $string |
|
|
228 | |
|
|
229 | Called whenever text is about to be output, with the text as argument. You |
|
|
230 | can filter/change and output the text yourself by returning a true value |
|
|
231 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
|
|
232 | might be very slow, however, as your hook is called for B<all> text being |
|
|
233 | output. |
|
|
234 | |
|
|
235 | =item on_line_update $term, $row |
|
|
236 | |
|
|
237 | Called whenever a line was updated or changed. Can be used to filter |
|
|
238 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
239 | that are being shown will be filtered, and, due to performance reasons, |
|
|
240 | not always immediately. |
|
|
241 | |
|
|
242 | The row number is always the topmost row of the line if the line spans |
|
|
243 | multiple rows. |
|
|
244 | |
|
|
245 | Please note that, if you change the line, then the hook might get called |
|
|
246 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
247 | you cannot just toggle rendition bits, but only set them. |
156 | |
248 | |
157 | =item on_refresh_begin $term |
249 | =item on_refresh_begin $term |
158 | |
250 | |
159 | Called just before the screen gets redrawn. Can be used for overlay |
251 | Called just before the screen gets redrawn. Can be used for overlay |
160 | or similar effects by modify terminal contents in refresh_begin, and |
252 | or similar effects by modify terminal contents in refresh_begin, and |
… | |
… | |
169 | |
261 | |
170 | Called whenever the user presses a key combination that has a |
262 | Called whenever the user presses a key combination that has a |
171 | C<perl:string> action bound to it (see description of the B<keysym> |
263 | C<perl:string> action bound to it (see description of the B<keysym> |
172 | resource in the @@RXVT_NAME@@(1) manpage). |
264 | resource in the @@RXVT_NAME@@(1) manpage). |
173 | |
265 | |
|
|
266 | =item on_key_press $term, $event, $octets |
|
|
267 | |
|
|
268 | =item on_key_release $term, $event |
|
|
269 | |
|
|
270 | =item on_button_press $term, $event |
|
|
271 | |
|
|
272 | =item on_button_release $term, $event |
|
|
273 | |
|
|
274 | =item on_motion_notify $term, $event |
|
|
275 | |
|
|
276 | Called whenever the corresponding X event is received for the terminal If |
|
|
277 | the hook returns true, then the even will be ignored by rxvt-unicode. |
|
|
278 | |
|
|
279 | The event is a hash with most values as named by Xlib (see the XEvent |
|
|
280 | manpage), with the additional members C<row> and C<col>, which are the row |
|
|
281 | and column under the mouse cursor. |
|
|
282 | |
|
|
283 | C<on_key_press> additionally receives the string rxvt-unicode would |
|
|
284 | output, if any, in locale-specific encoding. |
|
|
285 | |
|
|
286 | subwindow. |
|
|
287 | |
|
|
288 | =back |
|
|
289 | |
|
|
290 | =head2 Variables in the C<urxvt> Package |
|
|
291 | |
|
|
292 | =over 4 |
|
|
293 | |
|
|
294 | =item $urxvt::TERM |
|
|
295 | |
|
|
296 | The current terminal. This variable stores the current C<urxvt::term> |
|
|
297 | object, whenever a callback/hook is executing. |
|
|
298 | |
174 | =back |
299 | =back |
175 | |
300 | |
176 | =head2 Functions in the C<urxvt> Package |
301 | =head2 Functions in the C<urxvt> Package |
177 | |
302 | |
178 | =over 4 |
303 | =over 4 |
|
|
304 | |
|
|
305 | =item $term = new urxvt [arg...] |
|
|
306 | |
|
|
307 | Creates a new terminal, very similar as if you had started it with |
|
|
308 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
309 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
310 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
311 | C<init> and C<start> hooks will be called during the call. |
179 | |
312 | |
180 | =item urxvt::fatal $errormessage |
313 | =item urxvt::fatal $errormessage |
181 | |
314 | |
182 | Fatally aborts execution with the given error message. Avoid at all |
315 | Fatally aborts execution with the given error message. Avoid at all |
183 | costs! The only time this is acceptable is when the terminal process |
316 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
193 | correct place, e.g. on stderr of the connecting urxvtc client. |
326 | correct place, e.g. on stderr of the connecting urxvtc client. |
194 | |
327 | |
195 | =item $time = urxvt::NOW |
328 | =item $time = urxvt::NOW |
196 | |
329 | |
197 | Returns the "current time" (as per the event loop). |
330 | Returns the "current time" (as per the event loop). |
|
|
331 | |
|
|
332 | =back |
198 | |
333 | |
199 | =head2 RENDITION |
334 | =head2 RENDITION |
200 | |
335 | |
201 | Rendition bitsets contain information about colour, font, font styles and |
336 | Rendition bitsets contain information about colour, font, font styles and |
202 | similar information for each screen cell. |
337 | similar information for each screen cell. |
… | |
… | |
218 | Return the rendition mask used for overlays by default. |
353 | Return the rendition mask used for overlays by default. |
219 | |
354 | |
220 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
355 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
221 | |
356 | |
222 | Return the bit that enabled bold, italic, blink, reverse-video and |
357 | Return the bit that enabled bold, italic, blink, reverse-video and |
223 | underline, respectively. To enable such a style, just or it onto the |
358 | underline, respectively. To enable such a style, just logically OR it into |
224 | bitset. |
359 | the bitset. |
225 | |
360 | |
226 | =item $foreground = urxvt::GET_BASEFG $rend |
361 | =item $foreground = urxvt::GET_BASEFG $rend |
227 | |
362 | |
228 | =item $background = urxvt::GET_BASEBG $rend |
363 | =item $background = urxvt::GET_BASEBG $rend |
229 | |
364 | |
… | |
… | |
234 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
369 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
235 | |
370 | |
236 | Replace the foreground/background colour in the rendition mask with the |
371 | Replace the foreground/background colour in the rendition mask with the |
237 | specified one. |
372 | specified one. |
238 | |
373 | |
|
|
374 | =item $value = urxvt::GET_CUSTOM ($rend) |
|
|
375 | |
|
|
376 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
377 | extensions. They can be set and changed as you like and are initially |
|
|
378 | zero. |
|
|
379 | |
|
|
380 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
|
|
381 | |
|
|
382 | Change the custom value. |
|
|
383 | |
239 | =back |
384 | =back |
240 | |
385 | |
241 | =cut |
386 | =cut |
242 | |
387 | |
243 | package urxvt; |
388 | package urxvt; |
244 | |
389 | |
245 | use strict; |
390 | use strict; |
|
|
391 | use Scalar::Util (); |
246 | |
392 | |
247 | our $term; |
393 | our $TERM; |
248 | our @HOOKNAME; |
394 | our @HOOKNAME; |
249 | our $LIBDIR; |
395 | our $LIBDIR; |
250 | |
396 | |
251 | BEGIN { |
397 | BEGIN { |
252 | urxvt->bootstrap; |
398 | urxvt->bootstrap; |
… | |
… | |
277 | my $name = $HOOKNAME[$htype]; |
423 | my $name = $HOOKNAME[$htype]; |
278 | |
424 | |
279 | my $ref = $pkg->can ("on_" . lc $name) |
425 | my $ref = $pkg->can ("on_" . lc $name) |
280 | or next; |
426 | or next; |
281 | |
427 | |
282 | $term->{_hook}[$htype]{$ref*1} = $ref; |
428 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
283 | $hook_count[$htype]++ |
429 | $hook_count[$htype]++ |
284 | or set_should_invoke $htype, 1; |
430 | or set_should_invoke $htype, 1; |
285 | } |
431 | } |
286 | } |
432 | } |
287 | |
433 | |
288 | my $script_pkg = "script0000"; |
434 | my $extension_pkg = "extension0000"; |
289 | my %script_pkg; |
435 | my %extension_pkg; |
290 | |
436 | |
291 | # load a single script into its own package, once only |
437 | # load a single script into its own package, once only |
292 | sub script_package($) { |
438 | sub extension_package($) { |
293 | my ($path) = @_; |
439 | my ($path) = @_; |
294 | |
440 | |
295 | $script_pkg{$path} ||= do { |
441 | $extension_pkg{$path} ||= do { |
296 | my $pkg = "urxvt::" . ($script_pkg++); |
442 | my $pkg = "urxvt::" . ($extension_pkg++); |
297 | |
443 | |
298 | verbose 3, "loading script '$path' into package '$pkg'"; |
444 | verbose 3, "loading extension '$path' into package '$pkg'"; |
299 | |
445 | |
300 | open my $fh, "<:raw", $path |
446 | open my $fh, "<:raw", $path |
301 | or die "$path: $!"; |
447 | or die "$path: $!"; |
302 | |
448 | |
303 | my $source = "package $pkg; use strict; use utf8;\n" |
449 | my $source = "package $pkg; use strict; use utf8;\n" |
|
|
450 | . "use base urxvt::term::proxy::;\n" |
304 | . "#line 1 \"$path\"\n{\n" |
451 | . "#line 1 \"$path\"\n{\n" |
305 | . (do { local $/; <$fh> }) |
452 | . (do { local $/; <$fh> }) |
306 | . "\n};\n1"; |
453 | . "\n};\n1"; |
307 | |
454 | |
308 | eval $source or die "$path: $@"; |
455 | eval $source or die "$path: $@"; |
309 | |
456 | |
310 | $pkg |
457 | $pkg |
311 | } |
458 | } |
312 | } |
459 | } |
313 | |
460 | |
|
|
461 | our $retval; # return value for urxvt |
|
|
462 | |
314 | # called by the rxvt core |
463 | # called by the rxvt core |
315 | sub invoke { |
464 | sub invoke { |
316 | local $term = shift; |
465 | local $TERM = shift; |
317 | my $htype = shift; |
466 | my $htype = shift; |
318 | |
467 | |
319 | if ($htype == 0) { # INIT |
468 | if ($htype == 0) { # INIT |
320 | my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); |
469 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
321 | |
470 | |
322 | for my $ext (split /:/, $term->resource ("perl_ext")) { |
471 | for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
323 | my @files = grep -f $_, map "$_/$ext", @dirs; |
472 | my @files = grep -f $_, map "$_/$ext", @dirs; |
324 | |
473 | |
325 | if (@files) { |
474 | if (@files) { |
326 | register_package script_package $files[0]; |
475 | register_package extension_package $files[0]; |
327 | } else { |
476 | } else { |
328 | warn "perl extension '$ext' not found in perl library search path\n"; |
477 | warn "perl extension '$ext' not found in perl library search path\n"; |
329 | } |
478 | } |
330 | } |
479 | } |
|
|
480 | } |
331 | |
481 | |
|
|
482 | $retval = undef; |
|
|
483 | |
|
|
484 | if (my $cb = $TERM->{_hook}[$htype]) { |
|
|
485 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
|
|
486 | if $verbosity >= 10; |
|
|
487 | |
|
|
488 | keys %$cb; |
|
|
489 | |
|
|
490 | while (my ($pkg, $cb) = each %$cb) { |
|
|
491 | eval { |
|
|
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; |
|
|
500 | }; |
|
|
501 | warn $@ if $@;#d# |
|
|
502 | } |
|
|
503 | } |
|
|
504 | |
332 | } elsif ($htype == 1) { # DESTROY |
505 | if ($htype == 1) { # DESTROY |
|
|
506 | # remove hooks if unused |
333 | if (my $hook = $term->{_hook}) { |
507 | if (my $hook = $TERM->{_hook}) { |
334 | for my $htype (0..$#$hook) { |
508 | for my $htype (0..$#$hook) { |
335 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
509 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
336 | or set_should_invoke $htype, 0; |
510 | or set_should_invoke $htype, 0; |
337 | } |
511 | } |
338 | } |
512 | } |
|
|
513 | |
|
|
514 | # clear package objects |
|
|
515 | %$_ = () for values %{ $TERM->{_pkg} }; |
|
|
516 | |
|
|
517 | # clear package |
|
|
518 | %$TERM = (); |
339 | } |
519 | } |
340 | |
520 | |
341 | my $cb = $term->{_hook}[$htype] |
521 | $retval |
342 | or return; |
|
|
343 | |
|
|
344 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" |
|
|
345 | if $verbosity >= 10; |
|
|
346 | |
|
|
347 | while (my ($k, $v) = each %$cb) { |
|
|
348 | return 1 if $v->($term, @_); |
|
|
349 | } |
|
|
350 | |
|
|
351 | 0 |
|
|
352 | } |
522 | } |
353 | |
523 | |
354 | =back |
524 | sub urxvt::term::proxy::AUTOLOAD { |
|
|
525 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
|
|
526 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
|
|
527 | |
|
|
528 | eval qq{ |
|
|
529 | sub $urxvt::term::proxy::AUTOLOAD { |
|
|
530 | my \$proxy = shift; |
|
|
531 | \$proxy->{term}->$1 (\@_) |
|
|
532 | } |
|
|
533 | 1 |
|
|
534 | } or die "FATAL: unable to compile method forwarder: $@"; |
|
|
535 | |
|
|
536 | goto &$urxvt::term::proxy::AUTOLOAD; |
|
|
537 | } |
355 | |
538 | |
356 | =head2 The C<urxvt::term> Class |
539 | =head2 The C<urxvt::term> Class |
357 | |
540 | |
358 | =over 4 |
541 | =over 4 |
|
|
542 | |
|
|
543 | =item $term->destroy |
|
|
544 | |
|
|
545 | Destroy the terminal object (close the window, free resources etc.). |
359 | |
546 | |
360 | =item $value = $term->resource ($name[, $newval]) |
547 | =item $value = $term->resource ($name[, $newval]) |
361 | |
548 | |
362 | Returns the current resource value associated with a given name and |
549 | Returns the current resource value associated with a given name and |
363 | optionally sets a new value. Setting values is most useful in the C<init> |
550 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
381 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
568 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
382 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
569 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
383 | display_name embed ext_bwidth fade font geometry hold iconName |
570 | display_name embed ext_bwidth fade font geometry hold iconName |
384 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
571 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
385 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
572 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
386 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
573 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
387 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
574 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
388 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
575 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
389 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
576 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
390 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
577 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
391 | shade term_name title transparent transparent_all tripleclickwords |
578 | shade term_name title transparent transparent_all tripleclickwords |
… | |
… | |
397 | my ($self, $name) = (shift, shift); |
584 | my ($self, $name) = (shift, shift); |
398 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
585 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
399 | goto &urxvt::term::_resource; |
586 | goto &urxvt::term::_resource; |
400 | } |
587 | } |
401 | |
588 | |
|
|
589 | =item $rend = $term->rstyle ([$new_rstyle]) |
|
|
590 | |
|
|
591 | Return and optionally change the current rendition. Text that is output by |
|
|
592 | the terminal application will use this style. |
|
|
593 | |
|
|
594 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
595 | |
|
|
596 | Return the current coordinates of the text cursor position and optionally |
|
|
597 | set it (which is usually bad as applications don't expect that). |
|
|
598 | |
402 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
599 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
403 | |
600 | |
404 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
601 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
405 | |
602 | |
406 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
603 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
… | |
… | |
415 | |
612 | |
416 | =item $oldtext = $term->selection ([$newtext]) |
613 | =item $oldtext = $term->selection ([$newtext]) |
417 | |
614 | |
418 | Return the current selection text and optionally replace it by C<$newtext>. |
615 | Return the current selection text and optionally replace it by C<$newtext>. |
419 | |
616 | |
420 | =item $term->scr_overlay ($x, $y, $text) |
617 | #=item $term->overlay ($x, $y, $text) |
421 | |
618 | # |
422 | Create a simple multi-line overlay box. See the next method for details. |
619 | #Create a simple multi-line overlay box. See the next method for details. |
423 | |
620 | # |
424 | =cut |
621 | #=cut |
425 | |
622 | # |
426 | sub urxvt::term::scr_overlay { |
623 | #sub urxvt::term::scr_overlay { |
427 | my ($self, $x, $y, $text) = @_; |
624 | # my ($self, $x, $y, $text) = @_; |
428 | |
625 | # |
429 | my @lines = split /\n/, $text; |
626 | # my @lines = split /\n/, $text; |
430 | |
627 | # |
431 | my $w = 0; |
628 | # my $w = 0; |
432 | for (map $self->strwidth ($_), @lines) { |
629 | # for (map $self->strwidth ($_), @lines) { |
433 | $w = $_ if $w < $_; |
630 | # $w = $_ if $w < $_; |
434 | } |
631 | # } |
435 | |
632 | # |
436 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
633 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
437 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
634 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
438 | } |
635 | #} |
439 | |
636 | |
440 | =item $term->scr_overlay_new ($x, $y, $width, $height) |
637 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
441 | |
638 | |
442 | Create a new (empty) overlay at the given position with the given |
639 | Create a new (empty) overlay at the given position with the given |
443 | width/height. A border will be put around the box. If either C<$x> or |
640 | width/height. C<$rstyle> defines the initial rendition style |
444 | C<$y> is negative, then this is counted from the right/bottom side, |
641 | (default: C<OVERLAY_RSTYLE>). |
445 | respectively. |
|
|
446 | |
642 | |
447 | =item $term->scr_overlay_off |
643 | If C<$border> is C<2> (default), then a decorative border will be put |
|
|
644 | around the box. |
448 | |
645 | |
449 | Switch the overlay off again. |
646 | If either C<$x> or C<$y> is negative, then this is counted from the |
|
|
647 | right/bottom side, respectively. |
450 | |
648 | |
451 | =item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) |
649 | This method returns an urxvt::overlay object. The overlay will be visible |
|
|
650 | as long as the perl object is referenced. |
452 | |
651 | |
453 | Put a single character (specified numerically) at the given overlay |
652 | The methods currently supported on C<urxvt::overlay> objects are: |
454 | position. |
|
|
455 | |
653 | |
|
|
654 | =over 4 |
|
|
655 | |
456 | =item $term->scr_overlay_set ($x, $y, $text) |
656 | =item $overlay->set ($x, $y, $text, $rend) |
457 | |
657 | |
458 | Write a string at the given position into the overlay. |
658 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
|
|
659 | text in rxvt-unicode's special encoding and an array of rendition values |
|
|
660 | at a specific position inside the overlay. |
459 | |
661 | |
|
|
662 | =item $overlay->hide |
|
|
663 | |
|
|
664 | If visible, hide the overlay, but do not destroy it. |
|
|
665 | |
|
|
666 | =item $overlay->show |
|
|
667 | |
|
|
668 | If hidden, display the overlay again. |
|
|
669 | |
|
|
670 | =back |
|
|
671 | |
460 | =item $cellwidth = $term->strwidth $string |
672 | =item $cellwidth = $term->strwidth ($string) |
461 | |
673 | |
462 | Returns the number of screen-cells this string would need. Correctly |
674 | Returns the number of screen-cells this string would need. Correctly |
463 | accounts for wide and combining characters. |
675 | accounts for wide and combining characters. |
464 | |
676 | |
465 | =item $octets = $term->locale_encode $string |
677 | =item $octets = $term->locale_encode ($string) |
466 | |
678 | |
467 | Convert the given text string into the corresponding locale encoding. |
679 | Convert the given text string into the corresponding locale encoding. |
468 | |
680 | |
469 | =item $string = $term->locale_decode $octets |
681 | =item $string = $term->locale_decode ($octets) |
470 | |
682 | |
471 | Convert the given locale-encoded octets into a perl string. |
683 | Convert the given locale-encoded octets into a perl string. |
|
|
684 | |
|
|
685 | =item $term->scr_add_lines ($string) |
|
|
686 | |
|
|
687 | Write the given text string to the screen, as if output by the application |
|
|
688 | running inside the terminal. It may not contain command sequences (escape |
|
|
689 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
690 | string is a normal text string, not in locale-dependent encoding. |
|
|
691 | |
|
|
692 | Normally its not a good idea to use this function, as programs might be |
|
|
693 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
694 | C<on_add_lines> hook, though. |
|
|
695 | |
|
|
696 | =item $term->cmd_parse ($octets) |
|
|
697 | |
|
|
698 | Similar to C<scr_add_lines>, but the argument must be in the |
|
|
699 | locale-specific encoding of the terminal and can contain command sequences |
|
|
700 | (escape codes) that will be interpreted. |
472 | |
701 | |
473 | =item $term->tt_write ($octets) |
702 | =item $term->tt_write ($octets) |
474 | |
703 | |
475 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
704 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
476 | pass characters instead of octets, you should convert your strings first |
705 | pass characters instead of octets, you should convert your strings first |
477 | to the locale-specific encoding using C<< $term->locale_encode >>. |
706 | to the locale-specific encoding using C<< $term->locale_encode >>. |
478 | |
707 | |
|
|
708 | =item $windowid = $term->parent |
|
|
709 | |
|
|
710 | Return the window id of the toplevel window. |
|
|
711 | |
|
|
712 | =item $windowid = $term->vt |
|
|
713 | |
|
|
714 | Return the window id of the terminal window. |
|
|
715 | |
|
|
716 | =item $window_width = $term->width |
|
|
717 | |
|
|
718 | =item $window_height = $term->height |
|
|
719 | |
|
|
720 | =item $font_width = $term->fwidth |
|
|
721 | |
|
|
722 | =item $font_height = $term->fheight |
|
|
723 | |
|
|
724 | =item $font_ascent = $term->fbase |
|
|
725 | |
479 | =item $nrow = $term->nrow |
726 | =item $terminal_rows = $term->nrow |
480 | |
727 | |
481 | =item $ncol = $term->ncol |
728 | =item $terminal_columns = $term->ncol |
482 | |
729 | |
483 | Return the number of rows/columns of the terminal window (i.e. as |
730 | =item $has_focus = $term->focus |
484 | specified by C<-geometry>, excluding any scrollback). |
|
|
485 | |
731 | |
486 | =item $nsaved = $term->nsaved |
732 | =item $is_mapped = $term->mapped |
487 | |
733 | |
488 | Returns the number of lines in the scrollback buffer. |
734 | =item $max_scrollback = $term->saveLines |
|
|
735 | |
|
|
736 | =item $nrow_plus_saveLines = $term->total_rows |
|
|
737 | |
|
|
738 | =item $lines_in_scrollback = $term->nsaved |
|
|
739 | |
|
|
740 | Return various integers describing terminal characteristics. |
489 | |
741 | |
490 | =item $view_start = $term->view_start ([$newvalue]) |
742 | =item $view_start = $term->view_start ([$newvalue]) |
491 | |
743 | |
492 | Returns the negative row number of the topmost line. Minimum value is |
744 | Returns the negative row number of the topmost line. Minimum value is |
493 | C<0>, which displays the normal terminal contents. Larger values scroll |
745 | C<0>, which displays the normal terminal contents. Larger values scroll |
… | |
… | |
504 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
756 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
505 | |
757 | |
506 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
758 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
507 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
759 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
508 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
760 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
509 | line C<< -$term->nsaved >>. |
761 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
|
|
762 | is requested. |
510 | |
763 | |
511 | If C<$new_text> is specified, it will replace characters in the current |
764 | If C<$new_text> is specified, it will replace characters in the current |
512 | line, starting at column C<$start_col> (default C<0>), which is useful |
765 | line, starting at column C<$start_col> (default C<0>), which is useful |
513 | to replace only parts of a line. The font index in the rendition will |
766 | to replace only parts of a line. The font index in the rendition will |
514 | automatically be updated. |
767 | automatically be updated. |
… | |
… | |
536 | |
789 | |
537 | See the section on RENDITION, above. |
790 | See the section on RENDITION, above. |
538 | |
791 | |
539 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
792 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
540 | |
793 | |
541 | Returns the number of screen cells that are in use ("the line length"). If |
794 | Returns the number of screen cells that are in use ("the line |
542 | it is C<-1>, then the line is part of a multiple-row logical "line", which |
795 | length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the |
543 | means all characters are in use and it is continued on the next row. |
796 | line is joined with the following one. |
544 | |
797 | |
|
|
798 | =item $bool = $term->is_longer ($row_number) |
|
|
799 | |
|
|
800 | Returns true if the row is part of a multiple-row logical "line" (i.e. |
|
|
801 | joined with the following row), which means all characters are in use |
|
|
802 | and it is continued on the next row (and possibly a continuation of the |
|
|
803 | previous row(s)). |
|
|
804 | |
|
|
805 | =item $line = $term->line ($row_number) |
|
|
806 | |
|
|
807 | Create and return a new C<urxvt::line> object that stores information |
|
|
808 | about the logical line that row C<$row_number> is part of. It supports the |
|
|
809 | following methods: |
|
|
810 | |
|
|
811 | =over 4 |
|
|
812 | |
|
|
813 | =item $text = $line->t ([$new_text]) |
|
|
814 | |
|
|
815 | Returns or replaces the full text of the line, similar to C<ROW_t> |
|
|
816 | |
|
|
817 | =item $rend = $line->r ([$new_rend]) |
|
|
818 | |
|
|
819 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
|
|
820 | |
|
|
821 | =item $length = $line->l |
|
|
822 | |
|
|
823 | Returns the length of the line in cells, similar to C<ROW_l>. |
|
|
824 | |
|
|
825 | =item $rownum = $line->beg |
|
|
826 | |
|
|
827 | =item $rownum = $line->end |
|
|
828 | |
|
|
829 | Return the row number of the first/last row of the line, respectively. |
|
|
830 | |
|
|
831 | =item $offset = $line->offset_of ($row, $col) |
|
|
832 | |
|
|
833 | Returns the character offset of the given row|col pair within the logical |
|
|
834 | line. |
|
|
835 | |
|
|
836 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
837 | |
|
|
838 | Translates a string offset into terminal coordinates again. |
|
|
839 | |
|
|
840 | =back |
|
|
841 | |
|
|
842 | =cut |
|
|
843 | |
|
|
844 | sub urxvt::term::line { |
|
|
845 | my ($self, $row) = @_; |
|
|
846 | |
|
|
847 | my $maxrow = $self->nrow - 1; |
|
|
848 | |
|
|
849 | my ($beg, $end) = ($row, $row); |
|
|
850 | |
|
|
851 | --$beg while $self->ROW_is_longer ($beg - 1); |
|
|
852 | ++$end while $self->ROW_is_longer ($end) && $end < $maxrow; |
|
|
853 | |
|
|
854 | bless { |
|
|
855 | term => $self, |
|
|
856 | beg => $beg, |
|
|
857 | end => $end, |
|
|
858 | ncol => $self->ncol, |
|
|
859 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
|
|
860 | }, urxvt::line:: |
|
|
861 | } |
|
|
862 | |
|
|
863 | sub urxvt::line::t { |
|
|
864 | my ($self) = @_; |
|
|
865 | |
|
|
866 | if (@_ > 1) |
|
|
867 | { |
|
|
868 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
869 | for $self->{beg} .. $self->{end}; |
|
|
870 | } |
|
|
871 | |
|
|
872 | defined wantarray && |
|
|
873 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
|
|
874 | 0, $self->{len} |
|
|
875 | } |
|
|
876 | |
|
|
877 | sub urxvt::line::r { |
|
|
878 | my ($self) = @_; |
|
|
879 | |
|
|
880 | if (@_ > 1) |
|
|
881 | { |
|
|
882 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
883 | for $self->{beg} .. $self->{end}; |
|
|
884 | } |
|
|
885 | |
|
|
886 | if (defined wantarray) { |
|
|
887 | my $rend = [ |
|
|
888 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
|
|
889 | ]; |
|
|
890 | $#$rend = $self->{len} - 1; |
|
|
891 | return $rend; |
|
|
892 | } |
|
|
893 | |
|
|
894 | () |
|
|
895 | } |
|
|
896 | |
|
|
897 | sub urxvt::line::beg { $_[0]{beg} } |
|
|
898 | sub urxvt::line::end { $_[0]{end} } |
|
|
899 | sub urxvt::line::l { $_[0]{len} } |
|
|
900 | |
|
|
901 | sub urxvt::line::offset_of { |
|
|
902 | my ($self, $row, $col) = @_; |
|
|
903 | |
|
|
904 | ($row - $self->{beg}) * $self->{ncol} + $col |
|
|
905 | } |
|
|
906 | |
|
|
907 | sub urxvt::line::coord_of { |
|
|
908 | my ($self, $offset) = @_; |
|
|
909 | |
|
|
910 | use integer; |
|
|
911 | |
|
|
912 | ( |
|
|
913 | $offset / $self->{ncol} + $self->{beg}, |
|
|
914 | $offset % $self->{ncol} |
|
|
915 | ) |
|
|
916 | } |
|
|
917 | |
|
|
918 | =item ($row, $col) = $line->coord_of ($offset) |
545 | =item $text = $term->special_encode $string |
919 | =item $text = $term->special_encode $string |
546 | |
920 | |
547 | Converts a perl string into the special encoding used by rxvt-unicode, |
921 | Converts a perl string into the special encoding used by rxvt-unicode, |
548 | where one character corresponds to one screen cell. See |
922 | where one character corresponds to one screen cell. See |
549 | C<< $term->ROW_t >> for details. |
923 | C<< $term->ROW_t >> for details. |
… | |
… | |
558 | =head2 The C<urxvt::timer> Class |
932 | =head2 The C<urxvt::timer> Class |
559 | |
933 | |
560 | This class implements timer watchers/events. Time is represented as a |
934 | This class implements timer watchers/events. Time is represented as a |
561 | fractional number of seconds since the epoch. Example: |
935 | fractional number of seconds since the epoch. Example: |
562 | |
936 | |
563 | # create a digital clock display in upper right corner |
937 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
564 | $term->{timer} = urxvt::timer |
938 | $term->{timer} = urxvt::timer |
565 | ->new |
939 | ->new |
566 | ->start (urxvt::NOW) |
940 | ->interval (1) |
567 | ->cb (sub { |
941 | ->cb (sub { |
568 | my ($timer) = @_; |
|
|
569 | my $time = $timer->at; |
|
|
570 | $timer->start ($time + 1); |
|
|
571 | $self->scr_overlay (-1, 0, |
942 | $term->{overlay}->set (0, 0, |
572 | POSIX::strftime "%H:%M:%S", localtime $time); |
943 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
573 | }); |
944 | }); |
574 | |
945 | |
575 | =over 4 |
946 | =over 4 |
576 | |
947 | |
577 | =item $timer = new urxvt::timer |
948 | =item $timer = new urxvt::timer |
578 | |
949 | |
579 | Create a new timer object in stopped state. |
950 | Create a new timer object in started state. It is scheduled to fire |
|
|
951 | immediately. |
580 | |
952 | |
581 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
953 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
582 | |
954 | |
583 | Set the callback to be called when the timer triggers. |
955 | Set the callback to be called when the timer triggers. |
584 | |
956 | |
… | |
… | |
587 | Return the time this watcher will fire next. |
959 | Return the time this watcher will fire next. |
588 | |
960 | |
589 | =item $timer = $timer->set ($tstamp) |
961 | =item $timer = $timer->set ($tstamp) |
590 | |
962 | |
591 | Set the time the event is generated to $tstamp. |
963 | Set the time the event is generated to $tstamp. |
|
|
964 | |
|
|
965 | =item $timer = $timer->interval ($interval) |
|
|
966 | |
|
|
967 | Normally (and when C<$interval> is C<0>), the timer will automatically |
|
|
968 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
|
|
969 | is automatically rescheduled at the given intervals. |
592 | |
970 | |
593 | =item $timer = $timer->start |
971 | =item $timer = $timer->start |
594 | |
972 | |
595 | Start the timer. |
973 | Start the timer. |
596 | |
974 | |
… | |
… | |
659 | This variable controls the verbosity level of the perl extension. Higher |
1037 | This variable controls the verbosity level of the perl extension. Higher |
660 | numbers indicate more verbose output. |
1038 | numbers indicate more verbose output. |
661 | |
1039 | |
662 | =over 4 |
1040 | =over 4 |
663 | |
1041 | |
664 | =item 0 - only fatal messages |
1042 | =item =0 - only fatal messages |
665 | |
1043 | |
666 | =item 3 - script loading and management |
1044 | =item =3 - script loading and management |
667 | |
1045 | |
668 | =item 10 - all events received |
1046 | =item =10 - all events received |
669 | |
1047 | |
670 | =back |
1048 | =back |
671 | |
1049 | |
672 | =head1 AUTHOR |
1050 | =head1 AUTHOR |
673 | |
1051 | |