… | |
… | |
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 |
|
|
63 | |
|
|
64 | Displays a digital clock using the built-in overlay (colorful, useless). |
|
|
65 | |
|
|
66 | =back |
71 | =back |
67 | |
72 | |
68 | =head2 General API Considerations |
73 | =head2 General API Considerations |
69 | |
74 | |
70 | All objects (such as terminals, time watchers etc.) are typical |
75 | All objects (such as terminals, time watchers etc.) are typical |
71 | reference-to-hash objects. The hash can be used to store anything you |
76 | 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 |
77 | 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 |
78 | C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or |
74 | modified). |
79 | modified). |
75 | |
80 | |
76 | When objects are destroyed on the C++ side, the perl object hashes are |
81 | 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 |
82 | 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 |
83 | the like inside the terminal object so they get destroyed as soon as the |
79 | terminal is destroyed. |
84 | terminal is destroyed. |
80 | |
85 | |
81 | =head2 Hooks |
86 | =head2 Hooks |
82 | |
87 | |
83 | The following subroutines can be declared in loaded scripts, and will be called |
88 | The following subroutines can be declared in loaded scripts, and will be |
84 | whenever the relevant event happens. |
89 | called whenever the relevant event happens. |
|
|
90 | |
|
|
91 | The first argument passed to them is an object private to each terminal |
|
|
92 | and extension package. You can call all C<urxvt::term> methods on it, but |
|
|
93 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
|
|
94 | object that is shared between all packages is stored in the C<term> |
|
|
95 | member. |
85 | |
96 | |
86 | All of them must return a boolean value. If it is true, then the event |
97 | 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, |
98 | 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. |
99 | and the relevant action might not be carried out by the C++ code. |
89 | |
100 | |
… | |
… | |
122 | requested from the server. The selection text can be queried and changed |
133 | requested from the server. The selection text can be queried and changed |
123 | by calling C<< $term->selection >>. |
134 | by calling C<< $term->selection >>. |
124 | |
135 | |
125 | Returning a true value aborts selection grabbing. It will still be hilighted. |
136 | Returning a true value aborts selection grabbing. It will still be hilighted. |
126 | |
137 | |
|
|
138 | =item on_sel_extend $term |
|
|
139 | |
|
|
140 | Called whenever the user tries to extend the selection (e.g. with a double |
|
|
141 | click) and is either supposed to return false (normal operation), or |
|
|
142 | should extend the selection itelf and return true to suppress the built-in |
|
|
143 | processing. |
|
|
144 | |
|
|
145 | See the F<selection> example extension. |
|
|
146 | |
127 | =item on_focus_in $term |
147 | =item on_focus_in $term |
128 | |
148 | |
129 | Called whenever the window gets the keyboard focus, before urxvt does |
149 | Called whenever the window gets the keyboard focus, before urxvt does |
130 | focus in processing. |
150 | focus in processing. |
131 | |
151 | |
… | |
… | |
151 | number of lines that will be in the scrollback buffer. |
171 | number of lines that will be in the scrollback buffer. |
152 | |
172 | |
153 | =item on_tty_activity $term *NYI* |
173 | =item on_tty_activity $term *NYI* |
154 | |
174 | |
155 | Called whenever the program(s) running in the urxvt window send output. |
175 | Called whenever the program(s) running in the urxvt window send output. |
|
|
176 | |
|
|
177 | =item on_osc_seq $term, $string |
|
|
178 | |
|
|
179 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
|
|
180 | operating system command) is processed. Cursor position and other state |
|
|
181 | information is up-to-date when this happens. For interoperability, the |
|
|
182 | string should start with the extension name and a colon, to distinguish |
|
|
183 | it from commands for other extensions, and this might be enforced in the |
|
|
184 | future. |
|
|
185 | |
|
|
186 | Be careful not ever to trust (in a security sense) the data you receive, |
|
|
187 | as its source can not easily be controleld (e-mail content, messages from |
|
|
188 | other users on the same system etc.). |
156 | |
189 | |
157 | =item on_refresh_begin $term |
190 | =item on_refresh_begin $term |
158 | |
191 | |
159 | Called just before the screen gets redrawn. Can be used for overlay |
192 | Called just before the screen gets redrawn. Can be used for overlay |
160 | or similar effects by modify terminal contents in refresh_begin, and |
193 | 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> |
204 | C<perl:string> action bound to it (see description of the B<keysym> |
172 | resource in the @@RXVT_NAME@@(1) manpage). |
205 | resource in the @@RXVT_NAME@@(1) manpage). |
173 | |
206 | |
174 | =back |
207 | =back |
175 | |
208 | |
|
|
209 | =head2 Variables in the C<urxvt> Package |
|
|
210 | |
|
|
211 | =over 4 |
|
|
212 | |
|
|
213 | =item $urxvt::TERM |
|
|
214 | |
|
|
215 | The current terminal. Whenever a callback/Hook is bein executed, this |
|
|
216 | variable stores the current C<urxvt::term> object. |
|
|
217 | |
|
|
218 | =back |
|
|
219 | |
176 | =head2 Functions in the C<urxvt> Package |
220 | =head2 Functions in the C<urxvt> Package |
177 | |
221 | |
178 | =over 4 |
222 | =over 4 |
179 | |
223 | |
180 | =item urxvt::fatal $errormessage |
224 | =item urxvt::fatal $errormessage |
… | |
… | |
194 | |
238 | |
195 | =item $time = urxvt::NOW |
239 | =item $time = urxvt::NOW |
196 | |
240 | |
197 | Returns the "current time" (as per the event loop). |
241 | Returns the "current time" (as per the event loop). |
198 | |
242 | |
|
|
243 | =back |
|
|
244 | |
|
|
245 | =head2 RENDITION |
|
|
246 | |
|
|
247 | Rendition bitsets contain information about colour, font, font styles and |
|
|
248 | similar information for each screen cell. |
|
|
249 | |
|
|
250 | The following "macros" deal with changes in rendition sets. You should |
|
|
251 | never just create a bitset, you should always modify an existing one, |
|
|
252 | as they contain important information required for correct operation of |
|
|
253 | rxvt-unicode. |
|
|
254 | |
|
|
255 | =over 4 |
|
|
256 | |
|
|
257 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
258 | |
|
|
259 | Returns the default rendition, as used when the terminal is starting up or |
|
|
260 | being reset. Useful as a base to start when creating renditions. |
|
|
261 | |
|
|
262 | =item $rend = urxvt::OVERLAY_RSTYLE |
|
|
263 | |
|
|
264 | Return the rendition mask used for overlays by default. |
|
|
265 | |
|
|
266 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
|
|
267 | |
|
|
268 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
269 | underline, respectively. To enable such a style, just logically OR it into |
|
|
270 | the bitset. |
|
|
271 | |
|
|
272 | =item $foreground = urxvt::GET_BASEFG $rend |
|
|
273 | |
|
|
274 | =item $background = urxvt::GET_BASEBG $rend |
|
|
275 | |
|
|
276 | Return the foreground/background colour index, respectively. |
|
|
277 | |
|
|
278 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
|
|
279 | |
|
|
280 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
|
|
281 | |
|
|
282 | Replace the foreground/background colour in the rendition mask with the |
|
|
283 | specified one. |
|
|
284 | |
|
|
285 | =item $value = urxvt::GET_CUSTOM ($rend) |
|
|
286 | |
|
|
287 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
288 | extensions. They can be set and changed as you like and are initially |
|
|
289 | zero. |
|
|
290 | |
|
|
291 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
|
|
292 | |
|
|
293 | Change the custom value. |
|
|
294 | |
|
|
295 | =back |
|
|
296 | |
199 | =cut |
297 | =cut |
200 | |
298 | |
201 | package urxvt; |
299 | package urxvt; |
202 | |
300 | |
203 | use strict; |
301 | use strict; |
|
|
302 | use Scalar::Util (); |
204 | |
303 | |
205 | our $term; |
304 | our $TERM; |
206 | our @HOOKNAME; |
305 | our @HOOKNAME; |
207 | our $LIBDIR; |
306 | our $LIBDIR; |
208 | |
307 | |
209 | BEGIN { |
308 | BEGIN { |
210 | urxvt->bootstrap; |
309 | urxvt->bootstrap; |
… | |
… | |
235 | my $name = $HOOKNAME[$htype]; |
334 | my $name = $HOOKNAME[$htype]; |
236 | |
335 | |
237 | my $ref = $pkg->can ("on_" . lc $name) |
336 | my $ref = $pkg->can ("on_" . lc $name) |
238 | or next; |
337 | or next; |
239 | |
338 | |
240 | $term->{_hook}[$htype]{$ref*1} = $ref; |
339 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
241 | $hook_count[$htype]++ |
340 | $hook_count[$htype]++ |
242 | or set_should_invoke $htype, 1; |
341 | or set_should_invoke $htype, 1; |
243 | } |
342 | } |
244 | } |
343 | } |
245 | |
344 | |
… | |
… | |
267 | |
366 | |
268 | $pkg |
367 | $pkg |
269 | } |
368 | } |
270 | } |
369 | } |
271 | |
370 | |
|
|
371 | our $retval; # return value for urxvt |
|
|
372 | |
272 | # called by the rxvt core |
373 | # called by the rxvt core |
273 | sub invoke { |
374 | sub invoke { |
274 | local $term = shift; |
375 | local $TERM = shift; |
275 | my $htype = shift; |
376 | my $htype = shift; |
276 | |
377 | |
277 | if ($htype == 0) { # INIT |
378 | if ($htype == 0) { # INIT |
278 | my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); |
379 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
279 | |
380 | |
280 | for my $ext (split /:/, $term->resource ("perl_ext")) { |
381 | for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
281 | my @files = grep -f $_, map "$_/$ext", @dirs; |
382 | my @files = grep -f $_, map "$_/$ext", @dirs; |
282 | |
383 | |
283 | if (@files) { |
384 | if (@files) { |
284 | register_package script_package $files[0]; |
385 | register_package script_package $files[0]; |
285 | } else { |
386 | } else { |
286 | warn "perl extension '$ext' not found in perl library search path\n"; |
387 | warn "perl extension '$ext' not found in perl library search path\n"; |
287 | } |
388 | } |
288 | } |
389 | } |
|
|
390 | } |
289 | |
391 | |
|
|
392 | $retval = undef; |
|
|
393 | |
|
|
394 | if (my $cb = $TERM->{_hook}[$htype]) { |
|
|
395 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
|
|
396 | if $verbosity >= 10; |
|
|
397 | |
|
|
398 | keys %$cb; |
|
|
399 | |
|
|
400 | while (my ($pkg, $cb) = each %$cb) { |
|
|
401 | $retval = $cb->( |
|
|
402 | $TERM->{_pkg}{$pkg} ||= do { |
|
|
403 | my $proxy = bless { }, urxvt::term::proxy::; |
|
|
404 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
405 | $proxy |
|
|
406 | }, |
|
|
407 | @_, |
|
|
408 | ) and last; |
|
|
409 | } |
|
|
410 | } |
|
|
411 | |
290 | } elsif ($htype == 1) { # DESTROY |
412 | if ($htype == 1) { # DESTROY |
|
|
413 | # remove hooks if unused |
291 | if (my $hook = $term->{_hook}) { |
414 | if (my $hook = $TERM->{_hook}) { |
292 | for my $htype (0..$#$hook) { |
415 | for my $htype (0..$#$hook) { |
293 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
416 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
294 | or set_should_invoke $htype, 0; |
417 | or set_should_invoke $htype, 0; |
295 | } |
418 | } |
296 | } |
419 | } |
|
|
420 | |
|
|
421 | # clear package objects |
|
|
422 | %$_ = () for values %{ $TERM->{_pkg} }; |
|
|
423 | |
|
|
424 | # clear package |
|
|
425 | %$TERM = (); |
297 | } |
426 | } |
298 | |
427 | |
299 | my $cb = $term->{_hook}[$htype] |
428 | $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 | } |
429 | } |
311 | |
430 | |
312 | =back |
431 | sub urxvt::term::proxy::AUTOLOAD { |
|
|
432 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
|
|
433 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
|
|
434 | |
|
|
435 | eval qq{ |
|
|
436 | sub $urxvt::term::proxy::AUTOLOAD { |
|
|
437 | my \$proxy = shift; |
|
|
438 | \$proxy->{term}->$1 (\@_) |
|
|
439 | } |
|
|
440 | 1 |
|
|
441 | } or die "FATAL: unable to compile method forwarder: $@"; |
|
|
442 | |
|
|
443 | goto &$urxvt::term::proxy::AUTOLOAD; |
|
|
444 | } |
313 | |
445 | |
314 | =head2 The C<urxvt::term> Class |
446 | =head2 The C<urxvt::term> Class |
315 | |
447 | |
316 | =over 4 |
448 | =over 4 |
317 | |
449 | |
… | |
… | |
339 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
471 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
340 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
472 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
341 | display_name embed ext_bwidth fade font geometry hold iconName |
473 | display_name embed ext_bwidth fade font geometry hold iconName |
342 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
474 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
343 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
475 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
344 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
476 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
345 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
477 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
346 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
478 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
347 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
479 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
348 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
480 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
349 | shade term_name title transparent transparent_all tripleclickwords |
481 | shade term_name title transparent transparent_all tripleclickwords |
… | |
… | |
355 | my ($self, $name) = (shift, shift); |
487 | my ($self, $name) = (shift, shift); |
356 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
488 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
357 | goto &urxvt::term::_resource; |
489 | goto &urxvt::term::_resource; |
358 | } |
490 | } |
359 | |
491 | |
|
|
492 | =item $rend = $term->screen_rstyle ([$new_rstyle]) |
|
|
493 | |
|
|
494 | Return and optionally change the current rendition. Text thta is output by |
|
|
495 | the temrianl application will use this style. |
|
|
496 | |
|
|
497 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
498 | |
|
|
499 | Return the current coordinates of the text cursor position and optionally |
|
|
500 | set it (which is usually bad as applications don't expect that). |
|
|
501 | |
360 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
502 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
361 | |
503 | |
362 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
504 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
363 | |
505 | |
364 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
506 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
… | |
… | |
373 | |
515 | |
374 | =item $oldtext = $term->selection ([$newtext]) |
516 | =item $oldtext = $term->selection ([$newtext]) |
375 | |
517 | |
376 | Return the current selection text and optionally replace it by C<$newtext>. |
518 | Return the current selection text and optionally replace it by C<$newtext>. |
377 | |
519 | |
378 | =item $term->scr_overlay ($x, $y, $text) |
520 | #=item $term->overlay ($x, $y, $text) |
379 | |
521 | # |
380 | Create a simple multi-line overlay box. See the next method for details. |
522 | #Create a simple multi-line overlay box. See the next method for details. |
381 | |
523 | # |
382 | =cut |
524 | #=cut |
383 | |
525 | |
384 | sub urxvt::term::scr_overlay { |
526 | sub urxvt::term::scr_overlay { |
|
|
527 | die; |
385 | my ($self, $x, $y, $text) = @_; |
528 | my ($self, $x, $y, $text) = @_; |
386 | |
529 | |
387 | my @lines = split /\n/, $text; |
530 | my @lines = split /\n/, $text; |
388 | |
531 | |
389 | my $w = 0; |
532 | my $w = 0; |
… | |
… | |
393 | |
536 | |
394 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
537 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
395 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
538 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
396 | } |
539 | } |
397 | |
540 | |
398 | =item $term->scr_overlay_new ($x, $y, $width, $height) |
541 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
399 | |
542 | |
400 | Create a new (empty) overlay at the given position with the given |
543 | 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 |
544 | width/height. C<$rstyle> defines the initial rendition style |
402 | C<$y> is negative, then this is counted from the right/bottom side, |
545 | (default: C<OVERLAY_RSTYLE>). |
403 | respectively. |
|
|
404 | |
546 | |
405 | =item $term->scr_overlay_off |
547 | If C<$border> is C<2> (default), then a decorative border will be put |
|
|
548 | around the box. |
406 | |
549 | |
407 | Switch the overlay off again. |
550 | If either C<$x> or C<$y> is negative, then this is counted from the |
|
|
551 | right/bottom side, respectively. |
408 | |
552 | |
409 | =item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) |
553 | This method returns an urxvt::overlay object. The overlay will be visible |
|
|
554 | as long as the perl object is referenced. |
410 | |
555 | |
411 | Put a single character (specified numerically) at the given overlay |
556 | The methods currently supported on C<urxvt::overlay> objects are: |
412 | position. |
|
|
413 | |
557 | |
|
|
558 | =over 4 |
|
|
559 | |
414 | =item $term->scr_overlay_set ($x, $y, $text) |
560 | =item $overlay->set ($x, $y, $text, $rend) |
415 | |
561 | |
416 | Write a string at the given position into the overlay. |
562 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
|
|
563 | text in rxvt-unicode's special encoding and an array of rendition values |
|
|
564 | at a specific position inside the overlay. |
|
|
565 | |
|
|
566 | =item $overlay->hide |
|
|
567 | |
|
|
568 | If visible, hide the overlay, but do not destroy it. |
|
|
569 | |
|
|
570 | =item $overlay->show |
|
|
571 | |
|
|
572 | If hidden, display the overlay again. |
|
|
573 | |
|
|
574 | =back |
417 | |
575 | |
418 | =item $cellwidth = $term->strwidth $string |
576 | =item $cellwidth = $term->strwidth $string |
419 | |
577 | |
420 | Returns the number of screen-cells this string would need. Correctly |
578 | Returns the number of screen-cells this string would need. Correctly |
421 | accounts for wide and combining characters. |
579 | accounts for wide and combining characters. |
… | |
… | |
432 | |
590 | |
433 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
591 | 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 |
592 | pass characters instead of octets, you should convert your strings first |
435 | to the locale-specific encoding using C<< $term->locale_encode >>. |
593 | to the locale-specific encoding using C<< $term->locale_encode >>. |
436 | |
594 | |
|
|
595 | =item $window_width = $term->width |
|
|
596 | |
|
|
597 | =item $window_height = $term->height |
|
|
598 | |
|
|
599 | =item $font_width = $term->fwidth |
|
|
600 | |
|
|
601 | =item $font_height = $term->fheight |
|
|
602 | |
|
|
603 | =item $font_ascent = $term->fbase |
|
|
604 | |
437 | =item $nrow = $term->nrow |
605 | =item $terminal_rows = $term->nrow |
438 | |
606 | |
439 | =item $ncol = $term->ncol |
607 | =item $terminal_columns = $term->ncol |
440 | |
608 | |
441 | Return the number of rows/columns of the terminal window (i.e. as |
609 | =item $has_focus = $term->focus |
442 | specified by C<-geometry>, excluding any scrollback). |
|
|
443 | |
610 | |
444 | =item $nsaved = $term->nsaved |
611 | =item $is_mapped = $term->mapped |
445 | |
612 | |
446 | Returns the number of lines in the scrollback buffer. |
613 | =item $max_scrollback = $term->saveLines |
|
|
614 | |
|
|
615 | =item $nrow_plus_saveLines = $term->total_rows |
|
|
616 | |
|
|
617 | =item $lines_in_scrollback = $term->nsaved |
|
|
618 | |
|
|
619 | Return various integers describing terminal characteristics. |
447 | |
620 | |
448 | =item $view_start = $term->view_start ([$newvalue]) |
621 | =item $view_start = $term->view_start ([$newvalue]) |
449 | |
622 | |
450 | Returns the negative row number of the topmost line. Minimum value is |
623 | Returns the negative row number of the topmost line. Minimum value is |
451 | C<0>, which displays the normal terminal contents. Larger values scroll |
624 | C<0>, which displays the normal terminal contents. Larger values scroll |
… | |
… | |
462 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
635 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
463 | |
636 | |
464 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
637 | 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 |
638 | 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 |
639 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
467 | line C<< -$term->nsaved >>. |
640 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
|
|
641 | is requested. |
468 | |
642 | |
469 | If C<$new_text> is specified, it will replace characters in the current |
643 | 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 |
644 | 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 |
645 | to replace only parts of a line. The font index in the rendition will |
472 | automatically be updated. |
646 | automatically be updated. |
473 | |
647 | |
474 | C<$text> is in a special encoding: tabs and wide characters that use more |
648 | 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 |
649 | than one cell when displayed are padded with urxvt::NOCHAR characters |
476 | (C<chr 65535>). Characters with combining characters and other characters |
650 | (C<chr 65535>). Characters with combining characters and other characters |
… | |
… | |
490 | bitsets. Rendition bitsets contain information about colour, font, font |
664 | bitsets. Rendition bitsets contain information about colour, font, font |
491 | styles and similar information. See also C<< $term->ROW_t >>. |
665 | styles and similar information. See also C<< $term->ROW_t >>. |
492 | |
666 | |
493 | When setting rendition, the font mask will be ignored. |
667 | When setting rendition, the font mask will be ignored. |
494 | |
668 | |
495 | See the section on RENDITION, below. |
669 | See the section on RENDITION, above. |
496 | |
670 | |
497 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
671 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
498 | |
672 | |
499 | Returns the number of screen cells that are in use ("the line length"). If |
673 | 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 |
674 | 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. |
675 | line is joined with the following one. |
502 | |
676 | |
|
|
677 | =item $bool = $term->is_longer ($row_number) |
|
|
678 | |
|
|
679 | Returns true if the row is part of a multiple-row logical "line" (i.e. |
|
|
680 | joined with the following row), which means all characters are in use |
|
|
681 | and it is continued on the next row (and possibly a continuation of the |
|
|
682 | previous row(s)). |
|
|
683 | |
|
|
684 | =item $line = $term->line ($row_number) |
|
|
685 | |
|
|
686 | Create and return a new C<urxvt::line> object that stores information |
|
|
687 | about the logical line that row C<$row_number> is part of. It supports the |
|
|
688 | following methods: |
|
|
689 | |
|
|
690 | =over 4 |
|
|
691 | |
|
|
692 | =item $text = $line->t |
|
|
693 | |
|
|
694 | Returns the full text of the line, similar to C<ROW_t> |
|
|
695 | |
|
|
696 | =item $rend = $line->r |
|
|
697 | |
|
|
698 | Returns the full rendition array of the line, similar to C<ROW_r> |
|
|
699 | |
|
|
700 | =item $length = $line->l |
|
|
701 | |
|
|
702 | Returns the length of the line in cells, similar to C<ROW_l>. |
|
|
703 | |
|
|
704 | =item $rownum = $line->beg |
|
|
705 | |
|
|
706 | =item $rownum = $line->end |
|
|
707 | |
|
|
708 | Return the row number of the first/last row of the line, respectively. |
|
|
709 | |
|
|
710 | =item $offset = $line->offset_of ($row, $col) |
|
|
711 | |
|
|
712 | Returns the character offset of the given row|col pair within the logical |
|
|
713 | line. |
|
|
714 | |
|
|
715 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
716 | |
|
|
717 | Translates a string offset into terminal coordinates again. |
|
|
718 | |
|
|
719 | =back |
|
|
720 | |
|
|
721 | =cut |
|
|
722 | |
|
|
723 | sub urxvt::term::line { |
|
|
724 | my ($self, $row) = @_; |
|
|
725 | |
|
|
726 | my $maxrow = $self->nrow - 1; |
|
|
727 | |
|
|
728 | my ($beg, $end) = ($row, $row); |
|
|
729 | |
|
|
730 | --$beg while $self->ROW_is_longer ($beg - 1); |
|
|
731 | ++$end while $self->ROW_is_longer ($end) && $end < $maxrow; |
|
|
732 | |
|
|
733 | bless { |
|
|
734 | term => $self, |
|
|
735 | beg => $beg, |
|
|
736 | end => $end, |
|
|
737 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
|
|
738 | }, urxvt::line:: |
|
|
739 | } |
|
|
740 | |
|
|
741 | sub urxvt::line::t { |
|
|
742 | my ($self) = @_; |
|
|
743 | |
|
|
744 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
|
|
745 | 0, $self->{len} |
|
|
746 | } |
|
|
747 | |
|
|
748 | sub urxvt::line::r { |
|
|
749 | my ($self) = @_; |
|
|
750 | |
|
|
751 | my $rend = [ |
|
|
752 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
|
|
753 | ]; |
|
|
754 | $#$rend = $self->{len} - 1; |
|
|
755 | $rend |
|
|
756 | } |
|
|
757 | |
|
|
758 | sub urxvt::line::beg { $_[0]{beg} } |
|
|
759 | sub urxvt::line::end { $_[0]{end} } |
|
|
760 | sub urxvt::line::l { $_[0]{len} } |
|
|
761 | |
|
|
762 | sub urxvt::line::offset_of { |
|
|
763 | my ($self, $row, $col) = @_; |
|
|
764 | |
|
|
765 | ($row - $self->{beg}) * $self->{term}->ncol + $col |
|
|
766 | } |
|
|
767 | |
|
|
768 | sub urxvt::line::coord_of { |
|
|
769 | my ($self, $offset) = @_; |
|
|
770 | |
|
|
771 | use integer; |
|
|
772 | |
|
|
773 | ( |
|
|
774 | $offset / $self->{term}->ncol + $self->{beg}, |
|
|
775 | $offset % $self->{term}->ncol |
|
|
776 | ) |
|
|
777 | } |
|
|
778 | |
|
|
779 | =item ($row, $col) = $line->coord_of ($offset) |
503 | =item $text = $term->special_encode $string |
780 | =item $text = $term->special_encode $string |
504 | |
781 | |
505 | Converts a perl string into the special encoding used by rxvt-unicode, |
782 | Converts a perl string into the special encoding used by rxvt-unicode, |
506 | where one character corresponds to one screen cell. See |
783 | where one character corresponds to one screen cell. See |
507 | C<< $term->ROW_t >> for details. |
784 | C<< $term->ROW_t >> for details. |
… | |
… | |
511 | Converts rxvt-unicodes text reprsentation into a perl string. See |
788 | Converts rxvt-unicodes text reprsentation into a perl string. See |
512 | C<< $term->ROW_t >> for details. |
789 | C<< $term->ROW_t >> for details. |
513 | |
790 | |
514 | =back |
791 | =back |
515 | |
792 | |
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 |
793 | =head2 The C<urxvt::timer> Class |
538 | |
794 | |
539 | This class implements timer watchers/events. Time is represented as a |
795 | This class implements timer watchers/events. Time is represented as a |
540 | fractional number of seconds since the epoch. Example: |
796 | fractional number of seconds since the epoch. Example: |
541 | |
797 | |
542 | # create a digital clock display in upper right corner |
798 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
543 | $term->{timer} = urxvt::timer |
799 | $term->{timer} = urxvt::timer |
544 | ->new |
800 | ->new |
545 | ->start (urxvt::NOW) |
801 | ->interval (1) |
546 | ->cb (sub { |
802 | ->cb (sub { |
547 | my ($timer) = @_; |
|
|
548 | my $time = $timer->at; |
|
|
549 | $timer->start ($time + 1); |
|
|
550 | $self->scr_overlay (-1, 0, |
803 | $term->{overlay}->set (0, 0, |
551 | POSIX::strftime "%H:%M:%S", localtime $time); |
804 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
552 | }); |
805 | }); |
553 | |
806 | |
554 | =over 4 |
807 | =over 4 |
555 | |
808 | |
556 | =item $timer = new urxvt::timer |
809 | =item $timer = new urxvt::timer |
557 | |
810 | |
558 | Create a new timer object in stopped state. |
811 | Create a new timer object in started state. It is scheduled to fire |
|
|
812 | immediately. |
559 | |
813 | |
560 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
814 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
561 | |
815 | |
562 | Set the callback to be called when the timer triggers. |
816 | Set the callback to be called when the timer triggers. |
563 | |
817 | |
… | |
… | |
566 | Return the time this watcher will fire next. |
820 | Return the time this watcher will fire next. |
567 | |
821 | |
568 | =item $timer = $timer->set ($tstamp) |
822 | =item $timer = $timer->set ($tstamp) |
569 | |
823 | |
570 | Set the time the event is generated to $tstamp. |
824 | Set the time the event is generated to $tstamp. |
|
|
825 | |
|
|
826 | =item $timer = $timer->interval ($interval) |
|
|
827 | |
|
|
828 | Normally (and when C<$interval> is C<0>), the timer will automatically |
|
|
829 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
|
|
830 | is automatically rescheduled at the given intervals. |
571 | |
831 | |
572 | =item $timer = $timer->start |
832 | =item $timer = $timer->start |
573 | |
833 | |
574 | Start the timer. |
834 | Start the timer. |
575 | |
835 | |
… | |
… | |
638 | This variable controls the verbosity level of the perl extension. Higher |
898 | This variable controls the verbosity level of the perl extension. Higher |
639 | numbers indicate more verbose output. |
899 | numbers indicate more verbose output. |
640 | |
900 | |
641 | =over 4 |
901 | =over 4 |
642 | |
902 | |
643 | =item 0 - only fatal messages |
903 | =item =0 - only fatal messages |
644 | |
904 | |
645 | =item 3 - script loading and management |
905 | =item =3 - script loading and management |
646 | |
906 | |
647 | =item 10 - all events received |
907 | =item =10 - all events received |
648 | |
908 | |
649 | =back |
909 | =back |
650 | |
910 | |
651 | =head1 AUTHOR |
911 | =head1 AUTHOR |
652 | |
912 | |