… | |
… | |
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 example-refresh-hooks |
57 | |
66 | |
58 | Displays a very simple digital clock in the upper right corner of the |
67 | Displays a very simple digital clock in the upper right corner of the |
59 | window. Illustrates overwriting the refresh callbacks to create your own |
68 | window. Illustrates overwriting the refresh callbacks to create your own |
60 | overlays or changes. |
69 | overlays or changes. |
61 | |
70 | |
62 | =item simple-overlay-clock |
71 | =item mark-urls |
63 | |
72 | |
64 | Displays a digital clock using the built-in overlay (colorful, useless). |
73 | A not very useful example of filtering all text output to the terminal, by |
|
|
74 | underlining all urls that matches a certain regex (i.e. some urls :). It |
|
|
75 | is not very useful because urls that are output in multiple steps (e.g. |
|
|
76 | when typing them) do not get marked. |
65 | |
77 | |
66 | =back |
78 | =back |
67 | |
79 | |
68 | =head2 General API Considerations |
80 | =head2 General API Considerations |
69 | |
81 | |
70 | All objects (such as terminals, time watchers etc.) are typical |
82 | All objects (such as terminals, time watchers etc.) are typical |
71 | reference-to-hash objects. The hash can be used to store anything you |
83 | 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 |
84 | 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 |
85 | C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or |
74 | modified). |
86 | modified). |
75 | |
87 | |
76 | When objects are destroyed on the C++ side, the perl object hashes are |
88 | 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 |
89 | 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 |
90 | the like inside the terminal object so they get destroyed as soon as the |
79 | terminal is destroyed. |
91 | terminal is destroyed. |
80 | |
92 | |
|
|
93 | Argument names also often indicate the type of a parameter. Here are some |
|
|
94 | hints on what they mean: |
|
|
95 | |
|
|
96 | =over 4 |
|
|
97 | |
|
|
98 | =item $text |
|
|
99 | |
|
|
100 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
|
|
101 | always represents one screen cell. See L<row_t> for a discussion of this format. |
|
|
102 | |
|
|
103 | =item $string |
|
|
104 | |
|
|
105 | A perl text string, with an emphasis on I<text>. It can store all unicode |
|
|
106 | characters and is to be distinguished with text encoded in a specific |
|
|
107 | encoding (often locale-specific) and binary data. |
|
|
108 | |
|
|
109 | =item $octets |
|
|
110 | |
|
|
111 | Either binary data or - more common - a text string encoded in a |
|
|
112 | locale-specific way. |
|
|
113 | |
|
|
114 | =back |
|
|
115 | |
81 | =head2 Hooks |
116 | =head2 Hooks |
82 | |
117 | |
83 | The following subroutines can be declared in loaded scripts, and will be called |
118 | The following subroutines can be declared in loaded scripts, and will be |
84 | whenever the relevant event happens. |
119 | called whenever the relevant event happens. |
|
|
120 | |
|
|
121 | The first argument passed to them is an object private to each terminal |
|
|
122 | and extension package. You can call all C<urxvt::term> methods on it, but |
|
|
123 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
|
|
124 | object that is shared between all packages is stored in the C<term> |
|
|
125 | member. |
85 | |
126 | |
86 | All of them must return a boolean value. If it is true, then the event |
127 | 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, |
128 | 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. |
129 | and the relevant action might not be carried out by the C++ code. |
89 | |
130 | |
… | |
… | |
122 | requested from the server. The selection text can be queried and changed |
163 | requested from the server. The selection text can be queried and changed |
123 | by calling C<< $term->selection >>. |
164 | by calling C<< $term->selection >>. |
124 | |
165 | |
125 | Returning a true value aborts selection grabbing. It will still be hilighted. |
166 | Returning a true value aborts selection grabbing. It will still be hilighted. |
126 | |
167 | |
|
|
168 | =item on_sel_extend $term |
|
|
169 | |
|
|
170 | Called whenever the user tries to extend the selection (e.g. with a double |
|
|
171 | click) and is either supposed to return false (normal operation), or |
|
|
172 | should extend the selection itelf and return true to suppress the built-in |
|
|
173 | processing. |
|
|
174 | |
|
|
175 | See the F<selection> example extension. |
|
|
176 | |
127 | =item on_focus_in $term |
177 | =item on_focus_in $term |
128 | |
178 | |
129 | Called whenever the window gets the keyboard focus, before urxvt does |
179 | Called whenever the window gets the keyboard focus, before urxvt does |
130 | focus in processing. |
180 | focus in processing. |
131 | |
181 | |
… | |
… | |
151 | number of lines that will be in the scrollback buffer. |
201 | number of lines that will be in the scrollback buffer. |
152 | |
202 | |
153 | =item on_tty_activity $term *NYI* |
203 | =item on_tty_activity $term *NYI* |
154 | |
204 | |
155 | Called whenever the program(s) running in the urxvt window send output. |
205 | Called whenever the program(s) running in the urxvt window send output. |
|
|
206 | |
|
|
207 | =item on_osc_seq $term, $string |
|
|
208 | |
|
|
209 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
|
|
210 | operating system command) is processed. Cursor position and other state |
|
|
211 | information is up-to-date when this happens. For interoperability, the |
|
|
212 | string should start with the extension name and a colon, to distinguish |
|
|
213 | it from commands for other extensions, and this might be enforced in the |
|
|
214 | future. |
|
|
215 | |
|
|
216 | Be careful not ever to trust (in a security sense) the data you receive, |
|
|
217 | as its source can not easily be controleld (e-mail content, messages from |
|
|
218 | other users on the same system etc.). |
|
|
219 | |
|
|
220 | =item on_add_lines $term, $string |
|
|
221 | |
|
|
222 | Called whenever text is about to be output, with the text as argument. You |
|
|
223 | can filter/change and output the text yourself by returning a true value |
|
|
224 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
|
|
225 | might be very slow, however, as your hook is called for B<all> text being |
|
|
226 | output. |
156 | |
227 | |
157 | =item on_refresh_begin $term |
228 | =item on_refresh_begin $term |
158 | |
229 | |
159 | Called just before the screen gets redrawn. Can be used for overlay |
230 | Called just before the screen gets redrawn. Can be used for overlay |
160 | or similar effects by modify terminal contents in refresh_begin, and |
231 | or similar effects by modify terminal contents in refresh_begin, and |
… | |
… | |
171 | C<perl:string> action bound to it (see description of the B<keysym> |
242 | C<perl:string> action bound to it (see description of the B<keysym> |
172 | resource in the @@RXVT_NAME@@(1) manpage). |
243 | resource in the @@RXVT_NAME@@(1) manpage). |
173 | |
244 | |
174 | =back |
245 | =back |
175 | |
246 | |
|
|
247 | =head2 Variables in the C<urxvt> Package |
|
|
248 | |
|
|
249 | =over 4 |
|
|
250 | |
|
|
251 | =item $urxvt::TERM |
|
|
252 | |
|
|
253 | The current terminal. Whenever a callback/Hook is bein executed, this |
|
|
254 | variable stores the current C<urxvt::term> object. |
|
|
255 | |
|
|
256 | =back |
|
|
257 | |
176 | =head2 Functions in the C<urxvt> Package |
258 | =head2 Functions in the C<urxvt> Package |
177 | |
259 | |
178 | =over 4 |
260 | =over 4 |
179 | |
261 | |
180 | =item urxvt::fatal $errormessage |
262 | =item urxvt::fatal $errormessage |
… | |
… | |
194 | |
276 | |
195 | =item $time = urxvt::NOW |
277 | =item $time = urxvt::NOW |
196 | |
278 | |
197 | Returns the "current time" (as per the event loop). |
279 | Returns the "current time" (as per the event loop). |
198 | |
280 | |
|
|
281 | =back |
|
|
282 | |
|
|
283 | =head2 RENDITION |
|
|
284 | |
|
|
285 | Rendition bitsets contain information about colour, font, font styles and |
|
|
286 | similar information for each screen cell. |
|
|
287 | |
|
|
288 | The following "macros" deal with changes in rendition sets. You should |
|
|
289 | never just create a bitset, you should always modify an existing one, |
|
|
290 | as they contain important information required for correct operation of |
|
|
291 | rxvt-unicode. |
|
|
292 | |
|
|
293 | =over 4 |
|
|
294 | |
|
|
295 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
296 | |
|
|
297 | Returns the default rendition, as used when the terminal is starting up or |
|
|
298 | being reset. Useful as a base to start when creating renditions. |
|
|
299 | |
|
|
300 | =item $rend = urxvt::OVERLAY_RSTYLE |
|
|
301 | |
|
|
302 | Return the rendition mask used for overlays by default. |
|
|
303 | |
|
|
304 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
|
|
305 | |
|
|
306 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
307 | underline, respectively. To enable such a style, just logically OR it into |
|
|
308 | the bitset. |
|
|
309 | |
|
|
310 | =item $foreground = urxvt::GET_BASEFG $rend |
|
|
311 | |
|
|
312 | =item $background = urxvt::GET_BASEBG $rend |
|
|
313 | |
|
|
314 | Return the foreground/background colour index, respectively. |
|
|
315 | |
|
|
316 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
|
|
317 | |
|
|
318 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
|
|
319 | |
|
|
320 | Replace the foreground/background colour in the rendition mask with the |
|
|
321 | specified one. |
|
|
322 | |
|
|
323 | =item $value = urxvt::GET_CUSTOM ($rend) |
|
|
324 | |
|
|
325 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
326 | extensions. They can be set and changed as you like and are initially |
|
|
327 | zero. |
|
|
328 | |
|
|
329 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
|
|
330 | |
|
|
331 | Change the custom value. |
|
|
332 | |
|
|
333 | =back |
|
|
334 | |
199 | =cut |
335 | =cut |
200 | |
336 | |
201 | package urxvt; |
337 | package urxvt; |
202 | |
338 | |
203 | use strict; |
339 | use strict; |
|
|
340 | use Scalar::Util (); |
204 | |
341 | |
205 | our $term; |
342 | our $TERM; |
206 | our @HOOKNAME; |
343 | our @HOOKNAME; |
207 | our $LIBDIR; |
344 | our $LIBDIR; |
208 | |
345 | |
209 | BEGIN { |
346 | BEGIN { |
210 | urxvt->bootstrap; |
347 | urxvt->bootstrap; |
… | |
… | |
235 | my $name = $HOOKNAME[$htype]; |
372 | my $name = $HOOKNAME[$htype]; |
236 | |
373 | |
237 | my $ref = $pkg->can ("on_" . lc $name) |
374 | my $ref = $pkg->can ("on_" . lc $name) |
238 | or next; |
375 | or next; |
239 | |
376 | |
240 | $term->{_hook}[$htype]{$ref*1} = $ref; |
377 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
241 | $hook_count[$htype]++ |
378 | $hook_count[$htype]++ |
242 | or set_should_invoke $htype, 1; |
379 | or set_should_invoke $htype, 1; |
243 | } |
380 | } |
244 | } |
381 | } |
245 | |
382 | |
… | |
… | |
267 | |
404 | |
268 | $pkg |
405 | $pkg |
269 | } |
406 | } |
270 | } |
407 | } |
271 | |
408 | |
|
|
409 | our $retval; # return value for urxvt |
|
|
410 | |
272 | # called by the rxvt core |
411 | # called by the rxvt core |
273 | sub invoke { |
412 | sub invoke { |
274 | local $term = shift; |
413 | local $TERM = shift; |
275 | my $htype = shift; |
414 | my $htype = shift; |
276 | |
415 | |
277 | if ($htype == 0) { # INIT |
416 | if ($htype == 0) { # INIT |
278 | my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); |
417 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
279 | |
418 | |
280 | for my $ext (split /:/, $term->resource ("perl_ext")) { |
419 | for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
281 | my @files = grep -f $_, map "$_/$ext", @dirs; |
420 | my @files = grep -f $_, map "$_/$ext", @dirs; |
282 | |
421 | |
283 | if (@files) { |
422 | if (@files) { |
284 | register_package script_package $files[0]; |
423 | register_package script_package $files[0]; |
285 | } else { |
424 | } else { |
286 | warn "perl extension '$ext' not found in perl library search path\n"; |
425 | warn "perl extension '$ext' not found in perl library search path\n"; |
287 | } |
426 | } |
288 | } |
427 | } |
|
|
428 | } |
289 | |
429 | |
|
|
430 | $retval = undef; |
|
|
431 | |
|
|
432 | if (my $cb = $TERM->{_hook}[$htype]) { |
|
|
433 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
|
|
434 | if $verbosity >= 10; |
|
|
435 | |
|
|
436 | keys %$cb; |
|
|
437 | |
|
|
438 | while (my ($pkg, $cb) = each %$cb) { |
|
|
439 | $retval = $cb->( |
|
|
440 | $TERM->{_pkg}{$pkg} ||= do { |
|
|
441 | my $proxy = bless { }, urxvt::term::proxy::; |
|
|
442 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
443 | $proxy |
|
|
444 | }, |
|
|
445 | @_, |
|
|
446 | ) and last; |
|
|
447 | } |
|
|
448 | } |
|
|
449 | |
290 | } elsif ($htype == 1) { # DESTROY |
450 | if ($htype == 1) { # DESTROY |
|
|
451 | # remove hooks if unused |
291 | if (my $hook = $term->{_hook}) { |
452 | if (my $hook = $TERM->{_hook}) { |
292 | for my $htype (0..$#$hook) { |
453 | for my $htype (0..$#$hook) { |
293 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
454 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
294 | or set_should_invoke $htype, 0; |
455 | or set_should_invoke $htype, 0; |
295 | } |
456 | } |
296 | } |
457 | } |
|
|
458 | |
|
|
459 | # clear package objects |
|
|
460 | %$_ = () for values %{ $TERM->{_pkg} }; |
|
|
461 | |
|
|
462 | # clear package |
|
|
463 | %$TERM = (); |
297 | } |
464 | } |
298 | |
465 | |
299 | my $cb = $term->{_hook}[$htype] |
466 | $retval |
300 | or return; |
|
|
301 | |
|
|
302 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" |
|
|
303 | if $verbosity >= 10; |
|
|
304 | |
|
|
305 | while (my ($k, $v) = each %$cb) { |
|
|
306 | return 1 if $v->($term, @_); |
|
|
307 | } |
|
|
308 | |
|
|
309 | 0 |
|
|
310 | } |
467 | } |
311 | |
468 | |
312 | =back |
469 | sub urxvt::term::proxy::AUTOLOAD { |
|
|
470 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
|
|
471 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
|
|
472 | |
|
|
473 | eval qq{ |
|
|
474 | sub $urxvt::term::proxy::AUTOLOAD { |
|
|
475 | my \$proxy = shift; |
|
|
476 | \$proxy->{term}->$1 (\@_) |
|
|
477 | } |
|
|
478 | 1 |
|
|
479 | } or die "FATAL: unable to compile method forwarder: $@"; |
|
|
480 | |
|
|
481 | goto &$urxvt::term::proxy::AUTOLOAD; |
|
|
482 | } |
313 | |
483 | |
314 | =head2 The C<urxvt::term> Class |
484 | =head2 The C<urxvt::term> Class |
315 | |
485 | |
316 | =over 4 |
486 | =over 4 |
317 | |
487 | |
… | |
… | |
339 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
509 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
340 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
510 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
341 | display_name embed ext_bwidth fade font geometry hold iconName |
511 | display_name embed ext_bwidth fade font geometry hold iconName |
342 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
512 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
343 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
513 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
344 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
514 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
345 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
515 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
346 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
516 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
347 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
517 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
348 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
518 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
349 | shade term_name title transparent transparent_all tripleclickwords |
519 | shade term_name title transparent transparent_all tripleclickwords |
… | |
… | |
355 | my ($self, $name) = (shift, shift); |
525 | my ($self, $name) = (shift, shift); |
356 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
526 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
357 | goto &urxvt::term::_resource; |
527 | goto &urxvt::term::_resource; |
358 | } |
528 | } |
359 | |
529 | |
|
|
530 | =item $rend = $term->rstyle ([$new_rstyle]) |
|
|
531 | |
|
|
532 | Return and optionally change the current rendition. Text that is output by |
|
|
533 | the terminal application will use this style. |
|
|
534 | |
|
|
535 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
536 | |
|
|
537 | Return the current coordinates of the text cursor position and optionally |
|
|
538 | set it (which is usually bad as applications don't expect that). |
|
|
539 | |
360 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
540 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
361 | |
541 | |
362 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
542 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
363 | |
543 | |
364 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
544 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
… | |
… | |
373 | |
553 | |
374 | =item $oldtext = $term->selection ([$newtext]) |
554 | =item $oldtext = $term->selection ([$newtext]) |
375 | |
555 | |
376 | Return the current selection text and optionally replace it by C<$newtext>. |
556 | Return the current selection text and optionally replace it by C<$newtext>. |
377 | |
557 | |
378 | =item $term->scr_overlay ($x, $y, $text) |
558 | #=item $term->overlay ($x, $y, $text) |
379 | |
559 | # |
380 | Create a simple multi-line overlay box. See the next method for details. |
560 | #Create a simple multi-line overlay box. See the next method for details. |
381 | |
561 | # |
382 | =cut |
562 | #=cut |
383 | |
563 | # |
384 | sub urxvt::term::scr_overlay { |
564 | #sub urxvt::term::scr_overlay { |
385 | my ($self, $x, $y, $text) = @_; |
565 | # my ($self, $x, $y, $text) = @_; |
386 | |
566 | # |
387 | my @lines = split /\n/, $text; |
567 | # my @lines = split /\n/, $text; |
388 | |
568 | # |
389 | my $w = 0; |
569 | # my $w = 0; |
390 | for (map $self->strwidth ($_), @lines) { |
570 | # for (map $self->strwidth ($_), @lines) { |
391 | $w = $_ if $w < $_; |
571 | # $w = $_ if $w < $_; |
392 | } |
572 | # } |
393 | |
573 | # |
394 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
574 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
395 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
575 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
396 | } |
576 | #} |
397 | |
577 | |
398 | =item $term->scr_overlay_new ($x, $y, $width, $height) |
578 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
399 | |
579 | |
400 | Create a new (empty) overlay at the given position with the given |
580 | Create a new (empty) overlay at the given position with the given |
401 | width/height. A border will be put around the box. If either C<$x> or |
581 | width/height. C<$rstyle> defines the initial rendition style |
402 | C<$y> is negative, then this is counted from the right/bottom side, |
582 | (default: C<OVERLAY_RSTYLE>). |
403 | respectively. |
|
|
404 | |
583 | |
405 | =item $term->scr_overlay_off |
584 | If C<$border> is C<2> (default), then a decorative border will be put |
|
|
585 | around the box. |
406 | |
586 | |
407 | Switch the overlay off again. |
587 | If either C<$x> or C<$y> is negative, then this is counted from the |
|
|
588 | right/bottom side, respectively. |
408 | |
589 | |
409 | =item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) |
590 | This method returns an urxvt::overlay object. The overlay will be visible |
|
|
591 | as long as the perl object is referenced. |
410 | |
592 | |
411 | Put a single character (specified numerically) at the given overlay |
593 | The methods currently supported on C<urxvt::overlay> objects are: |
412 | position. |
|
|
413 | |
594 | |
|
|
595 | =over 4 |
|
|
596 | |
414 | =item $term->scr_overlay_set ($x, $y, $text) |
597 | =item $overlay->set ($x, $y, $text, $rend) |
415 | |
598 | |
416 | Write a string at the given position into the overlay. |
599 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
|
|
600 | text in rxvt-unicode's special encoding and an array of rendition values |
|
|
601 | at a specific position inside the overlay. |
|
|
602 | |
|
|
603 | =item $overlay->hide |
|
|
604 | |
|
|
605 | If visible, hide the overlay, but do not destroy it. |
|
|
606 | |
|
|
607 | =item $overlay->show |
|
|
608 | |
|
|
609 | If hidden, display the overlay again. |
|
|
610 | |
|
|
611 | =back |
417 | |
612 | |
418 | =item $cellwidth = $term->strwidth $string |
613 | =item $cellwidth = $term->strwidth $string |
419 | |
614 | |
420 | Returns the number of screen-cells this string would need. Correctly |
615 | Returns the number of screen-cells this string would need. Correctly |
421 | accounts for wide and combining characters. |
616 | accounts for wide and combining characters. |
… | |
… | |
425 | Convert the given text string into the corresponding locale encoding. |
620 | Convert the given text string into the corresponding locale encoding. |
426 | |
621 | |
427 | =item $string = $term->locale_decode $octets |
622 | =item $string = $term->locale_decode $octets |
428 | |
623 | |
429 | Convert the given locale-encoded octets into a perl string. |
624 | Convert the given locale-encoded octets into a perl string. |
|
|
625 | |
|
|
626 | =item $term->scr_add_lines ($string) |
|
|
627 | |
|
|
628 | Write the given text string to the screen, as if output by the application |
|
|
629 | running inside the terminal. It may not contain command sequences (escape |
|
|
630 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
631 | string is a normal text string, not in locale-dependent encoding. |
|
|
632 | |
|
|
633 | Normally its not a good idea to use this function, as programs might be |
|
|
634 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
635 | C<on_add_lines> hook, though. |
430 | |
636 | |
431 | =item $term->tt_write ($octets) |
637 | =item $term->tt_write ($octets) |
432 | |
638 | |
433 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
639 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
434 | pass characters instead of octets, you should convert your strings first |
640 | pass characters instead of octets, you should convert your strings first |
435 | to the locale-specific encoding using C<< $term->locale_encode >>. |
641 | to the locale-specific encoding using C<< $term->locale_encode >>. |
436 | |
642 | |
|
|
643 | =item $window_width = $term->width |
|
|
644 | |
|
|
645 | =item $window_height = $term->height |
|
|
646 | |
|
|
647 | =item $font_width = $term->fwidth |
|
|
648 | |
|
|
649 | =item $font_height = $term->fheight |
|
|
650 | |
|
|
651 | =item $font_ascent = $term->fbase |
|
|
652 | |
437 | =item $nrow = $term->nrow |
653 | =item $terminal_rows = $term->nrow |
438 | |
654 | |
439 | =item $ncol = $term->ncol |
655 | =item $terminal_columns = $term->ncol |
440 | |
656 | |
441 | Return the number of rows/columns of the terminal window (i.e. as |
657 | =item $has_focus = $term->focus |
442 | specified by C<-geometry>, excluding any scrollback). |
|
|
443 | |
658 | |
444 | =item $nsaved = $term->nsaved |
659 | =item $is_mapped = $term->mapped |
445 | |
660 | |
446 | Returns the number of lines in the scrollback buffer. |
661 | =item $max_scrollback = $term->saveLines |
|
|
662 | |
|
|
663 | =item $nrow_plus_saveLines = $term->total_rows |
|
|
664 | |
|
|
665 | =item $lines_in_scrollback = $term->nsaved |
|
|
666 | |
|
|
667 | Return various integers describing terminal characteristics. |
447 | |
668 | |
448 | =item $view_start = $term->view_start ([$newvalue]) |
669 | =item $view_start = $term->view_start ([$newvalue]) |
449 | |
670 | |
450 | Returns the negative row number of the topmost line. Minimum value is |
671 | Returns the negative row number of the topmost line. Minimum value is |
451 | C<0>, which displays the normal terminal contents. Larger values scroll |
672 | C<0>, which displays the normal terminal contents. Larger values scroll |
… | |
… | |
462 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
683 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
463 | |
684 | |
464 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
685 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
465 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
686 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
466 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
687 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
467 | line C<< -$term->nsaved >>. |
688 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
|
|
689 | is requested. |
468 | |
690 | |
469 | If C<$new_text> is specified, it will replace characters in the current |
691 | If C<$new_text> is specified, it will replace characters in the current |
470 | line, starting at column C<$start_col> (default C<0>), which is useful |
692 | line, starting at column C<$start_col> (default C<0>), which is useful |
471 | to replace only parts of a line. The font iindex in the rendition will |
693 | to replace only parts of a line. The font index in the rendition will |
472 | automatically be updated. |
694 | automatically be updated. |
473 | |
695 | |
474 | C<$text> is in a special encoding: tabs and wide characters that use more |
696 | C<$text> is in a special encoding: tabs and wide characters that use more |
475 | than one cell when displayed are padded with urxvt::NOCHAR characters |
697 | than one cell when displayed are padded with urxvt::NOCHAR characters |
476 | (C<chr 65535>). Characters with combining characters and other characters |
698 | (C<chr 65535>). Characters with combining characters and other characters |
… | |
… | |
490 | bitsets. Rendition bitsets contain information about colour, font, font |
712 | bitsets. Rendition bitsets contain information about colour, font, font |
491 | styles and similar information. See also C<< $term->ROW_t >>. |
713 | styles and similar information. See also C<< $term->ROW_t >>. |
492 | |
714 | |
493 | When setting rendition, the font mask will be ignored. |
715 | When setting rendition, the font mask will be ignored. |
494 | |
716 | |
495 | See the section on RENDITION, below. |
717 | See the section on RENDITION, above. |
496 | |
718 | |
497 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
719 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
498 | |
720 | |
499 | Returns the number of screen cells that are in use ("the line length"). If |
721 | Returns the number of screen cells that are in use ("the line |
500 | it is C<-1>, then the line is part of a multiple-row logical "line", which |
722 | length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the |
501 | means all characters are in use and it is continued on the next row. |
723 | line is joined with the following one. |
502 | |
724 | |
|
|
725 | =item $bool = $term->is_longer ($row_number) |
|
|
726 | |
|
|
727 | Returns true if the row is part of a multiple-row logical "line" (i.e. |
|
|
728 | joined with the following row), which means all characters are in use |
|
|
729 | and it is continued on the next row (and possibly a continuation of the |
|
|
730 | previous row(s)). |
|
|
731 | |
|
|
732 | =item $line = $term->line ($row_number) |
|
|
733 | |
|
|
734 | Create and return a new C<urxvt::line> object that stores information |
|
|
735 | about the logical line that row C<$row_number> is part of. It supports the |
|
|
736 | following methods: |
|
|
737 | |
|
|
738 | =over 4 |
|
|
739 | |
|
|
740 | =item $text = $line->t |
|
|
741 | |
|
|
742 | Returns the full text of the line, similar to C<ROW_t> |
|
|
743 | |
|
|
744 | =item $rend = $line->r |
|
|
745 | |
|
|
746 | Returns the full rendition array of the line, similar to C<ROW_r> |
|
|
747 | |
|
|
748 | =item $length = $line->l |
|
|
749 | |
|
|
750 | Returns the length of the line in cells, similar to C<ROW_l>. |
|
|
751 | |
|
|
752 | =item $rownum = $line->beg |
|
|
753 | |
|
|
754 | =item $rownum = $line->end |
|
|
755 | |
|
|
756 | Return the row number of the first/last row of the line, respectively. |
|
|
757 | |
|
|
758 | =item $offset = $line->offset_of ($row, $col) |
|
|
759 | |
|
|
760 | Returns the character offset of the given row|col pair within the logical |
|
|
761 | line. |
|
|
762 | |
|
|
763 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
764 | |
|
|
765 | Translates a string offset into terminal coordinates again. |
|
|
766 | |
|
|
767 | =back |
|
|
768 | |
|
|
769 | =cut |
|
|
770 | |
|
|
771 | sub urxvt::term::line { |
|
|
772 | my ($self, $row) = @_; |
|
|
773 | |
|
|
774 | my $maxrow = $self->nrow - 1; |
|
|
775 | |
|
|
776 | my ($beg, $end) = ($row, $row); |
|
|
777 | |
|
|
778 | --$beg while $self->ROW_is_longer ($beg - 1); |
|
|
779 | ++$end while $self->ROW_is_longer ($end) && $end < $maxrow; |
|
|
780 | |
|
|
781 | bless { |
|
|
782 | term => $self, |
|
|
783 | beg => $beg, |
|
|
784 | end => $end, |
|
|
785 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
|
|
786 | }, urxvt::line:: |
|
|
787 | } |
|
|
788 | |
|
|
789 | sub urxvt::line::t { |
|
|
790 | my ($self) = @_; |
|
|
791 | |
|
|
792 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
|
|
793 | 0, $self->{len} |
|
|
794 | } |
|
|
795 | |
|
|
796 | sub urxvt::line::r { |
|
|
797 | my ($self) = @_; |
|
|
798 | |
|
|
799 | my $rend = [ |
|
|
800 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
|
|
801 | ]; |
|
|
802 | $#$rend = $self->{len} - 1; |
|
|
803 | $rend |
|
|
804 | } |
|
|
805 | |
|
|
806 | sub urxvt::line::beg { $_[0]{beg} } |
|
|
807 | sub urxvt::line::end { $_[0]{end} } |
|
|
808 | sub urxvt::line::l { $_[0]{len} } |
|
|
809 | |
|
|
810 | sub urxvt::line::offset_of { |
|
|
811 | my ($self, $row, $col) = @_; |
|
|
812 | |
|
|
813 | ($row - $self->{beg}) * $self->{term}->ncol + $col |
|
|
814 | } |
|
|
815 | |
|
|
816 | sub urxvt::line::coord_of { |
|
|
817 | my ($self, $offset) = @_; |
|
|
818 | |
|
|
819 | use integer; |
|
|
820 | |
|
|
821 | ( |
|
|
822 | $offset / $self->{term}->ncol + $self->{beg}, |
|
|
823 | $offset % $self->{term}->ncol |
|
|
824 | ) |
|
|
825 | } |
|
|
826 | |
|
|
827 | =item ($row, $col) = $line->coord_of ($offset) |
503 | =item $text = $term->special_encode $string |
828 | =item $text = $term->special_encode $string |
504 | |
829 | |
505 | Converts a perl string into the special encoding used by rxvt-unicode, |
830 | Converts a perl string into the special encoding used by rxvt-unicode, |
506 | where one character corresponds to one screen cell. See |
831 | where one character corresponds to one screen cell. See |
507 | C<< $term->ROW_t >> for details. |
832 | C<< $term->ROW_t >> for details. |
… | |
… | |
511 | Converts rxvt-unicodes text reprsentation into a perl string. See |
836 | Converts rxvt-unicodes text reprsentation into a perl string. See |
512 | C<< $term->ROW_t >> for details. |
837 | C<< $term->ROW_t >> for details. |
513 | |
838 | |
514 | =back |
839 | =back |
515 | |
840 | |
516 | =head2 RENDITION |
|
|
517 | |
|
|
518 | Rendition bitsets contain information about colour, font, font styles and |
|
|
519 | similar information for each screen cell. |
|
|
520 | |
|
|
521 | The following "macros" deal with changes in rendition sets. You should |
|
|
522 | never just create a bitset, you should always modify an existing one, |
|
|
523 | as they contain important information required for correct operation of |
|
|
524 | rxvt-unicode. |
|
|
525 | |
|
|
526 | =over 4 |
|
|
527 | |
|
|
528 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
529 | |
|
|
530 | Returns the default rendition, as used when the terminal is starting up or |
|
|
531 | being reset. Useful as a base |
|
|
532 | |
|
|
533 | =back |
|
|
534 | |
|
|
535 | =cut |
|
|
536 | |
|
|
537 | =head2 The C<urxvt::timer> Class |
841 | =head2 The C<urxvt::timer> Class |
538 | |
842 | |
539 | This class implements timer watchers/events. Time is represented as a |
843 | This class implements timer watchers/events. Time is represented as a |
540 | fractional number of seconds since the epoch. Example: |
844 | fractional number of seconds since the epoch. Example: |
541 | |
845 | |
542 | # create a digital clock display in upper right corner |
846 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
543 | $term->{timer} = urxvt::timer |
847 | $term->{timer} = urxvt::timer |
544 | ->new |
848 | ->new |
545 | ->start (urxvt::NOW) |
849 | ->interval (1) |
546 | ->cb (sub { |
850 | ->cb (sub { |
547 | my ($timer) = @_; |
|
|
548 | my $time = $timer->at; |
|
|
549 | $timer->start ($time + 1); |
|
|
550 | $self->scr_overlay (-1, 0, |
851 | $term->{overlay}->set (0, 0, |
551 | POSIX::strftime "%H:%M:%S", localtime $time); |
852 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
552 | }); |
853 | }); |
553 | |
854 | |
554 | =over 4 |
855 | =over 4 |
555 | |
856 | |
556 | =item $timer = new urxvt::timer |
857 | =item $timer = new urxvt::timer |
557 | |
858 | |
558 | Create a new timer object in stopped state. |
859 | Create a new timer object in started state. It is scheduled to fire |
|
|
860 | immediately. |
559 | |
861 | |
560 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
862 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
561 | |
863 | |
562 | Set the callback to be called when the timer triggers. |
864 | Set the callback to be called when the timer triggers. |
563 | |
865 | |
… | |
… | |
566 | Return the time this watcher will fire next. |
868 | Return the time this watcher will fire next. |
567 | |
869 | |
568 | =item $timer = $timer->set ($tstamp) |
870 | =item $timer = $timer->set ($tstamp) |
569 | |
871 | |
570 | Set the time the event is generated to $tstamp. |
872 | Set the time the event is generated to $tstamp. |
|
|
873 | |
|
|
874 | =item $timer = $timer->interval ($interval) |
|
|
875 | |
|
|
876 | Normally (and when C<$interval> is C<0>), the timer will automatically |
|
|
877 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
|
|
878 | is automatically rescheduled at the given intervals. |
571 | |
879 | |
572 | =item $timer = $timer->start |
880 | =item $timer = $timer->start |
573 | |
881 | |
574 | Start the timer. |
882 | Start the timer. |
575 | |
883 | |
… | |
… | |
638 | This variable controls the verbosity level of the perl extension. Higher |
946 | This variable controls the verbosity level of the perl extension. Higher |
639 | numbers indicate more verbose output. |
947 | numbers indicate more verbose output. |
640 | |
948 | |
641 | =over 4 |
949 | =over 4 |
642 | |
950 | |
643 | =item 0 - only fatal messages |
951 | =item =0 - only fatal messages |
644 | |
952 | |
645 | =item 3 - script loading and management |
953 | =item =3 - script loading and management |
646 | |
954 | |
647 | =item 10 - all events received |
955 | =item =10 - all events received |
648 | |
956 | |
649 | =back |
957 | =back |
650 | |
958 | |
651 | =head1 AUTHOR |
959 | =head1 AUTHOR |
652 | |
960 | |