|
|
1 | =encoding utf8 |
|
|
2 | |
1 | =head1 NAME |
3 | =head1 NAME |
2 | |
4 | |
3 | rxvtperl - rxvt-unicode's embedded perl interpreter |
5 | @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter |
4 | |
6 | |
5 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
6 | |
8 | |
7 | * Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, they will be loaded automatically. |
9 | # create a file grab_test in $HOME: |
8 | |
|
|
9 | * Scripts are evaluated in a 'use strict' and 'use utf8' environment, and |
|
|
10 | thus must be encoded as UTF-8. |
|
|
11 | |
10 | |
12 | sub on_sel_grab { |
11 | sub on_sel_grab { |
13 | warn "you selected ", $_[0]->selection; |
12 | warn "you selected ", $_[0]->selection; |
14 | () |
13 | () |
15 | } |
14 | } |
16 | |
15 | |
17 | 1 |
16 | # start a @@RXVT_NAME@@ using it: |
|
|
17 | |
|
|
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | |
19 | |
19 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
20 | |
21 | |
21 | Everytime a terminal object gets created, scripts specified via the |
22 | Everytime a terminal object gets created, scripts specified via the |
22 | C<perl> resource are associated with it. |
23 | C<perl> resource are loaded and associated with it. |
|
|
24 | |
|
|
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
|
|
26 | thus must be encoded as UTF-8. |
23 | |
27 | |
24 | 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 |
25 | scripts will be shared (But not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
|
|
30 | |
|
|
31 | =head2 Prepackaged Extensions |
|
|
32 | |
|
|
33 | This section describes the extensiosn delivered with this version. You can |
|
|
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
|
|
35 | |
|
|
36 | You can activate them like this: |
|
|
37 | |
|
|
38 | @@RXVT_NAME@@ -pe <extensionname> |
|
|
39 | |
|
|
40 | =over 4 |
|
|
41 | |
|
|
42 | =item selection |
|
|
43 | |
|
|
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: |
|
|
50 | |
|
|
51 | =over 4 |
|
|
52 | |
|
|
53 | =item rot13 |
|
|
54 | |
|
|
55 | Rot-13 the selection when activated. Used via keyboard trigger: |
|
|
56 | |
|
|
57 | URxvt.keysym.C-M-r: perl:selection:rot13 |
|
|
58 | |
|
|
59 | =back |
|
|
60 | |
|
|
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 filtering (C<on_line_update>) to underline urls. |
|
|
68 | |
|
|
69 | =item example-refresh-hooks |
|
|
70 | |
|
|
71 | Displays a very simple digital clock in the upper right corner of the |
|
|
72 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
73 | overlays or changes. |
|
|
74 | |
|
|
75 | =item example-filter-input |
|
|
76 | |
|
|
77 | A not very useful example of filtering all text output to the terminal, by |
|
|
78 | underlining all urls that matches a certain regex (i.e. some urls :). It |
|
|
79 | is not very useful because urls that are output in multiple steps (e.g. |
|
|
80 | when typing them) do not get marked. |
|
|
81 | |
|
|
82 | =back |
26 | |
83 | |
27 | =head2 General API Considerations |
84 | =head2 General API Considerations |
28 | |
85 | |
29 | All objects (such as terminals, time watchers etc.) are typical |
86 | All objects (such as terminals, time watchers etc.) are typical |
30 | reference-to-hash objects. The hash can be used to store anything you |
87 | reference-to-hash objects. The hash can be used to store anything you |
31 | like. All members starting with an underscore (such as C<_ptr> or |
88 | like. All members starting with an underscore (such as C<_ptr> or |
32 | C<_hook>) are reserved for internal uses and must not be accessed or |
89 | C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or |
33 | modified). |
90 | modified). |
34 | |
91 | |
35 | When objects are destroyed on the C++ side, the perl object hashes are |
92 | When objects are destroyed on the C++ side, the perl object hashes are |
36 | emptied, so its best to store related objects such as time watchers and |
93 | emptied, so its best to store related objects such as time watchers and |
37 | the like inside the terminal object so they get destroyed as soon as the |
94 | the like inside the terminal object so they get destroyed as soon as the |
38 | terminal is destroyed. |
95 | terminal is destroyed. |
39 | |
96 | |
|
|
97 | Argument names also often indicate the type of a parameter. Here are some |
|
|
98 | hints on what they mean: |
|
|
99 | |
|
|
100 | =over 4 |
|
|
101 | |
|
|
102 | =item $text |
|
|
103 | |
|
|
104 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
|
|
105 | always represents one screen cell. See L<row_t> for a discussion of this format. |
|
|
106 | |
|
|
107 | =item $string |
|
|
108 | |
|
|
109 | A perl text string, with an emphasis on I<text>. It can store all unicode |
|
|
110 | characters and is to be distinguished with text encoded in a specific |
|
|
111 | encoding (often locale-specific) and binary data. |
|
|
112 | |
|
|
113 | =item $octets |
|
|
114 | |
|
|
115 | Either binary data or - more common - a text string encoded in a |
|
|
116 | locale-specific way. |
|
|
117 | |
|
|
118 | =back |
|
|
119 | |
40 | =head2 Hooks |
120 | =head2 Hooks |
41 | |
121 | |
42 | The following subroutines can be declared in loaded scripts, and will be called |
122 | The following subroutines can be declared in loaded scripts, and will be |
43 | whenever the relevant event happens. |
123 | called whenever the relevant event happens. |
|
|
124 | |
|
|
125 | The first argument passed to them is an object private to each terminal |
|
|
126 | and extension package. You can call all C<urxvt::term> methods on it, but |
|
|
127 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
|
|
128 | object that is shared between all packages is stored in the C<term> |
|
|
129 | member. |
44 | |
130 | |
45 | 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 |
46 | 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, |
47 | 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. |
48 | |
134 | |
… | |
… | |
51 | =over 4 |
137 | =over 4 |
52 | |
138 | |
53 | =item on_init $term |
139 | =item on_init $term |
54 | |
140 | |
55 | Called after a new terminal object has been initialized, but before |
141 | Called after a new terminal object has been initialized, but before |
56 | 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. |
57 | |
146 | |
58 | =item on_reset $term |
147 | =item on_reset $term |
59 | |
148 | |
60 | 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 |
61 | 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 |
… | |
… | |
81 | 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 |
82 | by calling C<< $term->selection >>. |
171 | by calling C<< $term->selection >>. |
83 | |
172 | |
84 | 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. |
85 | |
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 | |
86 | =item on_focus_in $term |
184 | =item on_focus_in $term |
87 | |
185 | |
88 | Called whenever the window gets the keyboard focus, before urxvt does |
186 | Called whenever the window gets the keyboard focus, before urxvt does |
89 | focus in processing. |
187 | focus in processing. |
90 | |
188 | |
… | |
… | |
110 | number of lines that will be in the scrollback buffer. |
208 | number of lines that will be in the scrollback buffer. |
111 | |
209 | |
112 | =item on_tty_activity $term *NYI* |
210 | =item on_tty_activity $term *NYI* |
113 | |
211 | |
114 | 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. |
115 | |
248 | |
116 | =item on_refresh_begin $term |
249 | =item on_refresh_begin $term |
117 | |
250 | |
118 | 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 |
119 | or similar effects by modify terminal contents in refresh_begin, and |
252 | or similar effects by modify terminal contents in refresh_begin, and |
… | |
… | |
122 | |
255 | |
123 | =item on_refresh_end $term |
256 | =item on_refresh_end $term |
124 | |
257 | |
125 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
258 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
126 | |
259 | |
|
|
260 | =item on_keyboard_command $term, $string |
|
|
261 | |
|
|
262 | Called whenever the user presses a key combination that has a |
|
|
263 | C<perl:string> action bound to it (see description of the B<keysym> |
|
|
264 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
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 |
|
|
277 | (see the XEvent manpage) If the hook returns true, then the even will be |
|
|
278 | ignored by rxvt-unicode. |
|
|
279 | |
|
|
280 | C<on_key_press> additionally receives the string rxvt-unicode would |
|
|
281 | output, if any, in locale-specific encoding. |
|
|
282 | |
|
|
283 | subwindow. |
|
|
284 | |
|
|
285 | =back |
|
|
286 | |
|
|
287 | =head2 Variables in the C<urxvt> Package |
|
|
288 | |
|
|
289 | =over 4 |
|
|
290 | |
|
|
291 | =item $urxvt::TERM |
|
|
292 | |
|
|
293 | The current terminal. Whenever a callback/Hook is bein executed, this |
|
|
294 | variable stores the current C<urxvt::term> object. |
|
|
295 | |
127 | =back |
296 | =back |
128 | |
297 | |
129 | =head2 Functions in the C<urxvt> Package |
298 | =head2 Functions in the C<urxvt> Package |
130 | |
299 | |
131 | =over 4 |
300 | =over 4 |
|
|
301 | |
|
|
302 | =item $term = new urxvt [arg...] |
|
|
303 | |
|
|
304 | Creates a new terminal, very similar as if you had started it with |
|
|
305 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
306 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
307 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
308 | C<init> and C<start> hooks will be called during the call. |
132 | |
309 | |
133 | =item urxvt::fatal $errormessage |
310 | =item urxvt::fatal $errormessage |
134 | |
311 | |
135 | Fatally aborts execution with the given error message. Avoid at all |
312 | Fatally aborts execution with the given error message. Avoid at all |
136 | costs! The only time this is acceptable is when the terminal process |
313 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
147 | |
324 | |
148 | =item $time = urxvt::NOW |
325 | =item $time = urxvt::NOW |
149 | |
326 | |
150 | Returns the "current time" (as per the event loop). |
327 | Returns the "current time" (as per the event loop). |
151 | |
328 | |
|
|
329 | =back |
|
|
330 | |
|
|
331 | =head2 RENDITION |
|
|
332 | |
|
|
333 | Rendition bitsets contain information about colour, font, font styles and |
|
|
334 | similar information for each screen cell. |
|
|
335 | |
|
|
336 | The following "macros" deal with changes in rendition sets. You should |
|
|
337 | never just create a bitset, you should always modify an existing one, |
|
|
338 | as they contain important information required for correct operation of |
|
|
339 | rxvt-unicode. |
|
|
340 | |
|
|
341 | =over 4 |
|
|
342 | |
|
|
343 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
344 | |
|
|
345 | Returns the default rendition, as used when the terminal is starting up or |
|
|
346 | being reset. Useful as a base to start when creating renditions. |
|
|
347 | |
|
|
348 | =item $rend = urxvt::OVERLAY_RSTYLE |
|
|
349 | |
|
|
350 | Return the rendition mask used for overlays by default. |
|
|
351 | |
|
|
352 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
|
|
353 | |
|
|
354 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
355 | underline, respectively. To enable such a style, just logically OR it into |
|
|
356 | the bitset. |
|
|
357 | |
|
|
358 | =item $foreground = urxvt::GET_BASEFG $rend |
|
|
359 | |
|
|
360 | =item $background = urxvt::GET_BASEBG $rend |
|
|
361 | |
|
|
362 | Return the foreground/background colour index, respectively. |
|
|
363 | |
|
|
364 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
|
|
365 | |
|
|
366 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
|
|
367 | |
|
|
368 | Replace the foreground/background colour in the rendition mask with the |
|
|
369 | specified one. |
|
|
370 | |
|
|
371 | =item $value = urxvt::GET_CUSTOM ($rend) |
|
|
372 | |
|
|
373 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
374 | extensions. They can be set and changed as you like and are initially |
|
|
375 | zero. |
|
|
376 | |
|
|
377 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
|
|
378 | |
|
|
379 | Change the custom value. |
|
|
380 | |
|
|
381 | =back |
|
|
382 | |
152 | =cut |
383 | =cut |
153 | |
384 | |
154 | package urxvt; |
385 | package urxvt; |
155 | |
386 | |
156 | use strict; |
387 | use strict; |
|
|
388 | use Scalar::Util (); |
157 | |
389 | |
158 | our $term; |
390 | our $TERM; |
159 | our @HOOKNAME; |
391 | our @HOOKNAME; |
160 | our $LIBDIR; |
392 | our $LIBDIR; |
161 | |
393 | |
162 | BEGIN { |
394 | BEGIN { |
163 | urxvt->bootstrap; |
395 | urxvt->bootstrap; |
… | |
… | |
188 | my $name = $HOOKNAME[$htype]; |
420 | my $name = $HOOKNAME[$htype]; |
189 | |
421 | |
190 | my $ref = $pkg->can ("on_" . lc $name) |
422 | my $ref = $pkg->can ("on_" . lc $name) |
191 | or next; |
423 | or next; |
192 | |
424 | |
193 | $term->{_hook}[$htype]{$ref*1} = $ref; |
425 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
194 | $hook_count[$htype]++ |
426 | $hook_count[$htype]++ |
195 | or set_should_invoke $htype, 1; |
427 | or set_should_invoke $htype, 1; |
196 | } |
428 | } |
197 | } |
429 | } |
198 | |
430 | |
… | |
… | |
220 | |
452 | |
221 | $pkg |
453 | $pkg |
222 | } |
454 | } |
223 | } |
455 | } |
224 | |
456 | |
|
|
457 | our $retval; # return value for urxvt |
|
|
458 | |
225 | # called by the rxvt core |
459 | # called by the rxvt core |
226 | sub invoke { |
460 | sub invoke { |
227 | local $term = shift; |
461 | local $TERM = shift; |
228 | my $htype = shift; |
462 | my $htype = shift; |
229 | |
463 | |
230 | if ($htype == 0) { # INIT |
464 | if ($htype == 0) { # INIT |
231 | my @dirs = ((split /:/, $term->resource ("perl_lib")), $LIBDIR); |
465 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
232 | |
466 | |
233 | for my $ext (split /:/, $term->resource ("perl_ext")) { |
467 | for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
234 | my @files = grep -f $_, map "$_/$ext", @dirs; |
468 | my @files = grep -f $_, map "$_/$ext", @dirs; |
235 | |
469 | |
236 | if (@files) { |
470 | if (@files) { |
237 | register_package script_package $files[0]; |
471 | register_package script_package $files[0]; |
238 | } else { |
472 | } else { |
239 | warn "perl extension '$ext' not found in perl library search path\n"; |
473 | warn "perl extension '$ext' not found in perl library search path\n"; |
240 | } |
474 | } |
241 | } |
475 | } |
|
|
476 | } |
242 | |
477 | |
|
|
478 | $retval = undef; |
|
|
479 | |
|
|
480 | if (my $cb = $TERM->{_hook}[$htype]) { |
|
|
481 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
|
|
482 | if $verbosity >= 10; |
|
|
483 | |
|
|
484 | keys %$cb; |
|
|
485 | |
|
|
486 | while (my ($pkg, $cb) = each %$cb) { |
|
|
487 | $retval = $cb->( |
|
|
488 | $TERM->{_pkg}{$pkg} ||= do { |
|
|
489 | my $proxy = bless { }, urxvt::term::proxy::; |
|
|
490 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
491 | $proxy |
|
|
492 | }, |
|
|
493 | @_, |
|
|
494 | ) and last; |
|
|
495 | } |
|
|
496 | } |
|
|
497 | |
243 | } elsif ($htype == 1) { # DESTROY |
498 | if ($htype == 1) { # DESTROY |
|
|
499 | # remove hooks if unused |
244 | if (my $hook = $term->{_hook}) { |
500 | if (my $hook = $TERM->{_hook}) { |
245 | for my $htype (0..$#$hook) { |
501 | for my $htype (0..$#$hook) { |
246 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
502 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
247 | or set_should_invoke $htype, 0; |
503 | or set_should_invoke $htype, 0; |
248 | } |
504 | } |
249 | } |
505 | } |
|
|
506 | |
|
|
507 | # clear package objects |
|
|
508 | %$_ = () for values %{ $TERM->{_pkg} }; |
|
|
509 | |
|
|
510 | # clear package |
|
|
511 | %$TERM = (); |
250 | } |
512 | } |
251 | |
513 | |
252 | my $cb = $term->{_hook}[$htype] |
514 | $retval |
253 | or return; |
|
|
254 | |
|
|
255 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" |
|
|
256 | if $verbosity >= 10; |
|
|
257 | |
|
|
258 | while (my ($k, $v) = each %$cb) { |
|
|
259 | return 1 if $v->($term, @_); |
|
|
260 | } |
|
|
261 | |
|
|
262 | 0 |
|
|
263 | } |
515 | } |
264 | |
516 | |
265 | =back |
517 | sub urxvt::term::proxy::AUTOLOAD { |
|
|
518 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
|
|
519 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
|
|
520 | |
|
|
521 | eval qq{ |
|
|
522 | sub $urxvt::term::proxy::AUTOLOAD { |
|
|
523 | my \$proxy = shift; |
|
|
524 | \$proxy->{term}->$1 (\@_) |
|
|
525 | } |
|
|
526 | 1 |
|
|
527 | } or die "FATAL: unable to compile method forwarder: $@"; |
|
|
528 | |
|
|
529 | goto &$urxvt::term::proxy::AUTOLOAD; |
|
|
530 | } |
266 | |
531 | |
267 | =head2 The C<urxvt::term> Class |
532 | =head2 The C<urxvt::term> Class |
268 | |
533 | |
269 | =over 4 |
534 | =over 4 |
|
|
535 | |
|
|
536 | =item $term->destroy |
|
|
537 | |
|
|
538 | Destroy the terminal object (close the window, free resources etc.). |
270 | |
539 | |
271 | =item $value = $term->resource ($name[, $newval]) |
540 | =item $value = $term->resource ($name[, $newval]) |
272 | |
541 | |
273 | Returns the current resource value associated with a given name and |
542 | Returns the current resource value associated with a given name and |
274 | optionally sets a new value. Setting values is most useful in the C<init> |
543 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
292 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
561 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
293 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
562 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
294 | display_name embed ext_bwidth fade font geometry hold iconName |
563 | display_name embed ext_bwidth fade font geometry hold iconName |
295 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
564 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
296 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
565 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
297 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
566 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
298 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
567 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
299 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
568 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
300 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
569 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
301 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
570 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
302 | shade term_name title transparent transparent_all tripleclickwords |
571 | shade term_name title transparent transparent_all tripleclickwords |
… | |
… | |
308 | my ($self, $name) = (shift, shift); |
577 | my ($self, $name) = (shift, shift); |
309 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
578 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
310 | goto &urxvt::term::_resource; |
579 | goto &urxvt::term::_resource; |
311 | } |
580 | } |
312 | |
581 | |
|
|
582 | =item $rend = $term->rstyle ([$new_rstyle]) |
|
|
583 | |
|
|
584 | Return and optionally change the current rendition. Text that is output by |
|
|
585 | the terminal application will use this style. |
|
|
586 | |
|
|
587 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
588 | |
|
|
589 | Return the current coordinates of the text cursor position and optionally |
|
|
590 | set it (which is usually bad as applications don't expect that). |
|
|
591 | |
313 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
592 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
314 | |
593 | |
315 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
594 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
316 | |
595 | |
317 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
596 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
… | |
… | |
326 | |
605 | |
327 | =item $oldtext = $term->selection ([$newtext]) |
606 | =item $oldtext = $term->selection ([$newtext]) |
328 | |
607 | |
329 | Return the current selection text and optionally replace it by C<$newtext>. |
608 | Return the current selection text and optionally replace it by C<$newtext>. |
330 | |
609 | |
331 | =item $term->scr_overlay ($x, $y, $text) |
610 | #=item $term->overlay ($x, $y, $text) |
332 | |
611 | # |
333 | Create a simple multi-line overlay box. See the next method for details. |
612 | #Create a simple multi-line overlay box. See the next method for details. |
334 | |
613 | # |
335 | =cut |
614 | #=cut |
336 | |
615 | # |
337 | sub urxvt::term::scr_overlay { |
616 | #sub urxvt::term::scr_overlay { |
338 | my ($self, $x, $y, $text) = @_; |
617 | # my ($self, $x, $y, $text) = @_; |
339 | |
618 | # |
340 | my @lines = split /\n/, $text; |
619 | # my @lines = split /\n/, $text; |
341 | |
620 | # |
342 | my $w = 0; |
621 | # my $w = 0; |
343 | for (map $self->strwidth ($_), @lines) { |
622 | # for (map $self->strwidth ($_), @lines) { |
344 | $w = $_ if $w < $_; |
623 | # $w = $_ if $w < $_; |
345 | } |
624 | # } |
346 | |
625 | # |
347 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
626 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
348 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
627 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
349 | } |
628 | #} |
350 | |
629 | |
351 | =item $term->scr_overlay_new ($x, $y, $width, $height) |
630 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
352 | |
631 | |
353 | Create a new (empty) overlay at the given position with the given |
632 | Create a new (empty) overlay at the given position with the given |
354 | width/height. A border will be put around the box. If either C<$x> or |
633 | width/height. C<$rstyle> defines the initial rendition style |
355 | C<$y> is negative, then this is counted from the right/bottom side, |
634 | (default: C<OVERLAY_RSTYLE>). |
356 | respectively. |
|
|
357 | |
635 | |
358 | =item $term->scr_overlay_off |
636 | If C<$border> is C<2> (default), then a decorative border will be put |
|
|
637 | around the box. |
359 | |
638 | |
360 | Switch the overlay off again. |
639 | If either C<$x> or C<$y> is negative, then this is counted from the |
|
|
640 | right/bottom side, respectively. |
361 | |
641 | |
362 | =item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) |
642 | This method returns an urxvt::overlay object. The overlay will be visible |
|
|
643 | as long as the perl object is referenced. |
363 | |
644 | |
364 | Put a single character (specified numerically) at the given overlay |
645 | The methods currently supported on C<urxvt::overlay> objects are: |
365 | position. |
|
|
366 | |
646 | |
|
|
647 | =over 4 |
|
|
648 | |
367 | =item $term->scr_overlay_set ($x, $y, $text) |
649 | =item $overlay->set ($x, $y, $text, $rend) |
368 | |
650 | |
369 | Write a string at the given position into the overlay. |
651 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
|
|
652 | text in rxvt-unicode's special encoding and an array of rendition values |
|
|
653 | at a specific position inside the overlay. |
|
|
654 | |
|
|
655 | =item $overlay->hide |
|
|
656 | |
|
|
657 | If visible, hide the overlay, but do not destroy it. |
|
|
658 | |
|
|
659 | =item $overlay->show |
|
|
660 | |
|
|
661 | If hidden, display the overlay again. |
|
|
662 | |
|
|
663 | =back |
370 | |
664 | |
371 | =item $cellwidth = $term->strwidth $string |
665 | =item $cellwidth = $term->strwidth $string |
372 | |
666 | |
373 | Returns the number of screen-cells this string would need. Correctly |
667 | Returns the number of screen-cells this string would need. Correctly |
374 | accounts for wide and combining characters. |
668 | accounts for wide and combining characters. |
… | |
… | |
379 | |
673 | |
380 | =item $string = $term->locale_decode $octets |
674 | =item $string = $term->locale_decode $octets |
381 | |
675 | |
382 | Convert the given locale-encoded octets into a perl string. |
676 | Convert the given locale-encoded octets into a perl string. |
383 | |
677 | |
|
|
678 | =item $term->scr_add_lines ($string) |
|
|
679 | |
|
|
680 | Write the given text string to the screen, as if output by the application |
|
|
681 | running inside the terminal. It may not contain command sequences (escape |
|
|
682 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
683 | string is a normal text string, not in locale-dependent encoding. |
|
|
684 | |
|
|
685 | Normally its not a good idea to use this function, as programs might be |
|
|
686 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
687 | C<on_add_lines> hook, though. |
|
|
688 | |
|
|
689 | =item $term->cmd_parse ($octets) |
|
|
690 | |
|
|
691 | Similar to C<scr_add_lines>, but the argument must be in the |
|
|
692 | locale-specific encoding of the terminal and can contain command sequences |
|
|
693 | (escape codes) that will be interpreted. |
|
|
694 | |
384 | =item $term->tt_write ($octets) |
695 | =item $term->tt_write ($octets) |
385 | |
696 | |
386 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
697 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
387 | pass characters instead of octets, you should convetr you strings first to |
698 | pass characters instead of octets, you should convert your strings first |
388 | the locale-specific encoding using C<< $term->locale_encode >>. |
699 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
700 | |
|
|
701 | =item $window_width = $term->width |
|
|
702 | |
|
|
703 | =item $window_height = $term->height |
|
|
704 | |
|
|
705 | =item $font_width = $term->fwidth |
|
|
706 | |
|
|
707 | =item $font_height = $term->fheight |
|
|
708 | |
|
|
709 | =item $font_ascent = $term->fbase |
|
|
710 | |
|
|
711 | =item $terminal_rows = $term->nrow |
|
|
712 | |
|
|
713 | =item $terminal_columns = $term->ncol |
|
|
714 | |
|
|
715 | =item $has_focus = $term->focus |
|
|
716 | |
|
|
717 | =item $is_mapped = $term->mapped |
|
|
718 | |
|
|
719 | =item $max_scrollback = $term->saveLines |
|
|
720 | |
|
|
721 | =item $nrow_plus_saveLines = $term->total_rows |
|
|
722 | |
|
|
723 | =item $lines_in_scrollback = $term->nsaved |
|
|
724 | |
|
|
725 | Return various integers describing terminal characteristics. |
|
|
726 | |
|
|
727 | =item $view_start = $term->view_start ([$newvalue]) |
|
|
728 | |
|
|
729 | Returns the negative row number of the topmost line. Minimum value is |
|
|
730 | C<0>, which displays the normal terminal contents. Larger values scroll |
|
|
731 | this many lines into the scrollback buffer. |
|
|
732 | |
|
|
733 | =item $term->want_refresh |
|
|
734 | |
|
|
735 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
|
|
736 | compare the on-screen display with its stored representation. If they |
|
|
737 | differ, it redraws the differences. |
|
|
738 | |
|
|
739 | Used after changing terminal contents to display them. |
|
|
740 | |
|
|
741 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
|
|
742 | |
|
|
743 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
|
|
744 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
|
|
745 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
746 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
|
|
747 | is requested. |
|
|
748 | |
|
|
749 | If C<$new_text> is specified, it will replace characters in the current |
|
|
750 | line, starting at column C<$start_col> (default C<0>), which is useful |
|
|
751 | to replace only parts of a line. The font index in the rendition will |
|
|
752 | automatically be updated. |
|
|
753 | |
|
|
754 | C<$text> is in a special encoding: tabs and wide characters that use more |
|
|
755 | than one cell when displayed are padded with urxvt::NOCHAR characters |
|
|
756 | (C<chr 65535>). Characters with combining characters and other characters |
|
|
757 | that do not fit into the normal tetx encoding will be replaced with |
|
|
758 | characters in the private use area. |
|
|
759 | |
|
|
760 | You have to obey this encoding when changing text. The advantage is |
|
|
761 | that C<substr> and similar functions work on screen cells and not on |
|
|
762 | characters. |
|
|
763 | |
|
|
764 | The methods C<< $term->special_encode >> and C<< $term->special_decode >> |
|
|
765 | can be used to convert normal strings into this encoding and vice versa. |
|
|
766 | |
|
|
767 | =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]]) |
|
|
768 | |
|
|
769 | Like C<< $term->ROW_t >>, but returns an arrayref with rendition |
|
|
770 | bitsets. Rendition bitsets contain information about colour, font, font |
|
|
771 | styles and similar information. See also C<< $term->ROW_t >>. |
|
|
772 | |
|
|
773 | When setting rendition, the font mask will be ignored. |
|
|
774 | |
|
|
775 | See the section on RENDITION, above. |
|
|
776 | |
|
|
777 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
|
|
778 | |
|
|
779 | Returns the number of screen cells that are in use ("the line |
|
|
780 | length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the |
|
|
781 | line is joined with the following one. |
|
|
782 | |
|
|
783 | =item $bool = $term->is_longer ($row_number) |
|
|
784 | |
|
|
785 | Returns true if the row is part of a multiple-row logical "line" (i.e. |
|
|
786 | joined with the following row), which means all characters are in use |
|
|
787 | and it is continued on the next row (and possibly a continuation of the |
|
|
788 | previous row(s)). |
|
|
789 | |
|
|
790 | =item $line = $term->line ($row_number) |
|
|
791 | |
|
|
792 | Create and return a new C<urxvt::line> object that stores information |
|
|
793 | about the logical line that row C<$row_number> is part of. It supports the |
|
|
794 | following methods: |
|
|
795 | |
|
|
796 | =over 4 |
|
|
797 | |
|
|
798 | =item $text = $line->t ([$new_text]) |
|
|
799 | |
|
|
800 | Returns or replaces the full text of the line, similar to C<ROW_t> |
|
|
801 | |
|
|
802 | =item $rend = $line->r ([$new_rend]) |
|
|
803 | |
|
|
804 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
|
|
805 | |
|
|
806 | =item $length = $line->l |
|
|
807 | |
|
|
808 | Returns the length of the line in cells, similar to C<ROW_l>. |
|
|
809 | |
|
|
810 | =item $rownum = $line->beg |
|
|
811 | |
|
|
812 | =item $rownum = $line->end |
|
|
813 | |
|
|
814 | Return the row number of the first/last row of the line, respectively. |
|
|
815 | |
|
|
816 | =item $offset = $line->offset_of ($row, $col) |
|
|
817 | |
|
|
818 | Returns the character offset of the given row|col pair within the logical |
|
|
819 | line. |
|
|
820 | |
|
|
821 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
822 | |
|
|
823 | Translates a string offset into terminal coordinates again. |
|
|
824 | |
|
|
825 | =back |
|
|
826 | |
|
|
827 | =cut |
|
|
828 | |
|
|
829 | sub urxvt::term::line { |
|
|
830 | my ($self, $row) = @_; |
|
|
831 | |
|
|
832 | my $maxrow = $self->nrow - 1; |
|
|
833 | |
|
|
834 | my ($beg, $end) = ($row, $row); |
|
|
835 | |
|
|
836 | --$beg while $self->ROW_is_longer ($beg - 1); |
|
|
837 | ++$end while $self->ROW_is_longer ($end) && $end < $maxrow; |
|
|
838 | |
|
|
839 | bless { |
|
|
840 | term => $self, |
|
|
841 | beg => $beg, |
|
|
842 | end => $end, |
|
|
843 | ncol => $self->ncol, |
|
|
844 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
|
|
845 | }, urxvt::line:: |
|
|
846 | } |
|
|
847 | |
|
|
848 | sub urxvt::line::t { |
|
|
849 | my ($self) = @_; |
|
|
850 | |
|
|
851 | if (@_ > 1) |
|
|
852 | { |
|
|
853 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
854 | for $self->{beg} .. $self->{end}; |
|
|
855 | } |
|
|
856 | |
|
|
857 | defined wantarray && |
|
|
858 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
|
|
859 | 0, $self->{len} |
|
|
860 | } |
|
|
861 | |
|
|
862 | sub urxvt::line::r { |
|
|
863 | my ($self) = @_; |
|
|
864 | |
|
|
865 | if (@_ > 1) |
|
|
866 | { |
|
|
867 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
868 | for $self->{beg} .. $self->{end}; |
|
|
869 | } |
|
|
870 | |
|
|
871 | if (defined wantarray) { |
|
|
872 | my $rend = [ |
|
|
873 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
|
|
874 | ]; |
|
|
875 | $#$rend = $self->{len} - 1; |
|
|
876 | return $rend; |
|
|
877 | } |
|
|
878 | |
|
|
879 | () |
|
|
880 | } |
|
|
881 | |
|
|
882 | sub urxvt::line::beg { $_[0]{beg} } |
|
|
883 | sub urxvt::line::end { $_[0]{end} } |
|
|
884 | sub urxvt::line::l { $_[0]{len} } |
|
|
885 | |
|
|
886 | sub urxvt::line::offset_of { |
|
|
887 | my ($self, $row, $col) = @_; |
|
|
888 | |
|
|
889 | ($row - $self->{beg}) * $self->{ncol} + $col |
|
|
890 | } |
|
|
891 | |
|
|
892 | sub urxvt::line::coord_of { |
|
|
893 | my ($self, $offset) = @_; |
|
|
894 | |
|
|
895 | use integer; |
|
|
896 | |
|
|
897 | ( |
|
|
898 | $offset / $self->{ncol} + $self->{beg}, |
|
|
899 | $offset % $self->{ncol} |
|
|
900 | ) |
|
|
901 | } |
|
|
902 | |
|
|
903 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
904 | =item $text = $term->special_encode $string |
|
|
905 | |
|
|
906 | Converts a perl string into the special encoding used by rxvt-unicode, |
|
|
907 | where one character corresponds to one screen cell. See |
|
|
908 | C<< $term->ROW_t >> for details. |
|
|
909 | |
|
|
910 | =item $string = $term->special_decode $text |
|
|
911 | |
|
|
912 | Converts rxvt-unicodes text reprsentation into a perl string. See |
|
|
913 | C<< $term->ROW_t >> for details. |
389 | |
914 | |
390 | =back |
915 | =back |
391 | |
916 | |
392 | =head2 The C<urxvt::timer> Class |
917 | =head2 The C<urxvt::timer> Class |
393 | |
918 | |
394 | This class implements timer watchers/events. Time is represented as a |
919 | This class implements timer watchers/events. Time is represented as a |
395 | fractional number of seconds since the epoch. Example: |
920 | fractional number of seconds since the epoch. Example: |
396 | |
921 | |
397 | # create a digital clock display in upper right corner |
922 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
398 | $term->{timer} = urxvt::timer |
923 | $term->{timer} = urxvt::timer |
399 | ->new |
924 | ->new |
400 | ->start (urxvt::NOW) |
925 | ->interval (1) |
401 | ->cb (sub { |
926 | ->cb (sub { |
402 | my ($timer) = @_; |
|
|
403 | my $time = $timer->at; |
|
|
404 | $timer->start ($time + 1); |
|
|
405 | $self->scr_overlay (-1, 0, |
927 | $term->{overlay}->set (0, 0, |
406 | POSIX::strftime "%H:%M:%S", localtime $time); |
928 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
407 | }); |
929 | }); |
408 | |
930 | |
409 | =over 4 |
931 | =over 4 |
410 | |
932 | |
411 | =item $timer = new urxvt::timer |
933 | =item $timer = new urxvt::timer |
412 | |
934 | |
413 | Create a new timer object in stopped state. |
935 | Create a new timer object in started state. It is scheduled to fire |
|
|
936 | immediately. |
414 | |
937 | |
415 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
938 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
416 | |
939 | |
417 | Set the callback to be called when the timer triggers. |
940 | Set the callback to be called when the timer triggers. |
418 | |
941 | |
… | |
… | |
421 | Return the time this watcher will fire next. |
944 | Return the time this watcher will fire next. |
422 | |
945 | |
423 | =item $timer = $timer->set ($tstamp) |
946 | =item $timer = $timer->set ($tstamp) |
424 | |
947 | |
425 | Set the time the event is generated to $tstamp. |
948 | Set the time the event is generated to $tstamp. |
|
|
949 | |
|
|
950 | =item $timer = $timer->interval ($interval) |
|
|
951 | |
|
|
952 | Normally (and when C<$interval> is C<0>), the timer will automatically |
|
|
953 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
|
|
954 | is automatically rescheduled at the given intervals. |
426 | |
955 | |
427 | =item $timer = $timer->start |
956 | =item $timer = $timer->start |
428 | |
957 | |
429 | Start the timer. |
958 | Start the timer. |
430 | |
959 | |
… | |
… | |
493 | This variable controls the verbosity level of the perl extension. Higher |
1022 | This variable controls the verbosity level of the perl extension. Higher |
494 | numbers indicate more verbose output. |
1023 | numbers indicate more verbose output. |
495 | |
1024 | |
496 | =over 4 |
1025 | =over 4 |
497 | |
1026 | |
498 | =item 0 - only fatal messages |
1027 | =item =0 - only fatal messages |
499 | |
1028 | |
500 | =item 3 - script loading and management |
1029 | =item =3 - script loading and management |
501 | |
1030 | |
502 | =item 10 - all events received |
1031 | =item =10 - all events received |
503 | |
1032 | |
504 | =back |
1033 | =back |
505 | |
1034 | |
506 | =head1 AUTHOR |
1035 | =head1 AUTHOR |
507 | |
1036 | |