… | |
… | |
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 | |
… | |
… | |
54 | =back |
59 | =back |
55 | |
60 | |
56 | =item digital-clock |
61 | =item digital-clock |
57 | |
62 | |
58 | Displays a digital clock using the built-in overlay. |
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. |
59 | |
68 | |
60 | =item example-refresh-hooks |
69 | =item example-refresh-hooks |
61 | |
70 | |
62 | Displays a very simple digital clock in the upper right corner of the |
71 | Displays a very simple digital clock in the upper right corner of the |
63 | window. Illustrates overwriting the refresh callbacks to create your own |
72 | window. Illustrates overwriting the refresh callbacks to create your own |
64 | overlays or changes. |
73 | overlays or changes. |
65 | |
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 | |
66 | =back |
82 | =back |
67 | |
83 | |
68 | =head2 General API Considerations |
84 | =head2 General API Considerations |
69 | |
85 | |
70 | All objects (such as terminals, time watchers etc.) are typical |
86 | All objects (such as terminals, time watchers etc.) are typical |
71 | 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 |
72 | 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 |
73 | 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 |
74 | modified). |
90 | modified). |
75 | |
91 | |
76 | 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 |
77 | 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 |
78 | 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 |
79 | terminal is destroyed. |
95 | terminal is destroyed. |
80 | |
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 | |
81 | =head2 Hooks |
120 | =head2 Hooks |
82 | |
121 | |
83 | 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 |
84 | 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. |
85 | |
130 | |
86 | All of them must return a boolean value. If it is true, then the event |
131 | All of them must return a boolean value. If it is true, then the event |
87 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
132 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
88 | and the relevant action might not be carried out by the C++ code. |
133 | and the relevant action might not be carried out by the C++ code. |
89 | |
134 | |
… | |
… | |
92 | =over 4 |
137 | =over 4 |
93 | |
138 | |
94 | =item on_init $term |
139 | =item on_init $term |
95 | |
140 | |
96 | Called after a new terminal object has been initialized, but before |
141 | Called after a new terminal object has been initialized, but before |
97 | windows are created or the command gets run. |
142 | windows are created or the command gets run. Most methods are unsafe to |
|
|
143 | call or deliver senseless data, as terminal size and other characteristics |
|
|
144 | have not yet been determined. You can safely query and change resources, |
|
|
145 | though. |
98 | |
146 | |
99 | =item on_reset $term |
147 | =item on_reset $term |
100 | |
148 | |
101 | Called after the screen is "reset" for any reason, such as resizing or |
149 | Called after the screen is "reset" for any reason, such as resizing or |
102 | control sequences. Here is where you can react on changes to size-related |
150 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
122 | requested from the server. The selection text can be queried and changed |
170 | requested from the server. The selection text can be queried and changed |
123 | by calling C<< $term->selection >>. |
171 | by calling C<< $term->selection >>. |
124 | |
172 | |
125 | Returning a true value aborts selection grabbing. It will still be hilighted. |
173 | Returning a true value aborts selection grabbing. It will still be hilighted. |
126 | |
174 | |
|
|
175 | =item on_sel_extend $term |
|
|
176 | |
|
|
177 | Called whenever the user tries to extend the selection (e.g. with a double |
|
|
178 | click) and is either supposed to return false (normal operation), or |
|
|
179 | should extend the selection itelf and return true to suppress the built-in |
|
|
180 | processing. |
|
|
181 | |
|
|
182 | See the F<selection> example extension. |
|
|
183 | |
127 | =item on_focus_in $term |
184 | =item on_focus_in $term |
128 | |
185 | |
129 | Called whenever the window gets the keyboard focus, before urxvt does |
186 | Called whenever the window gets the keyboard focus, before urxvt does |
130 | focus in processing. |
187 | focus in processing. |
131 | |
188 | |
… | |
… | |
151 | number of lines that will be in the scrollback buffer. |
208 | number of lines that will be in the scrollback buffer. |
152 | |
209 | |
153 | =item on_tty_activity $term *NYI* |
210 | =item on_tty_activity $term *NYI* |
154 | |
211 | |
155 | Called whenever the program(s) running in the urxvt window send output. |
212 | Called whenever the program(s) running in the urxvt window send output. |
|
|
213 | |
|
|
214 | =item on_osc_seq $term, $string |
|
|
215 | |
|
|
216 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
|
|
217 | operating system command) is processed. Cursor position and other state |
|
|
218 | information is up-to-date when this happens. For interoperability, the |
|
|
219 | string should start with the extension name and a colon, to distinguish |
|
|
220 | it from commands for other extensions, and this might be enforced in the |
|
|
221 | future. |
|
|
222 | |
|
|
223 | Be careful not ever to trust (in a security sense) the data you receive, |
|
|
224 | as its source can not easily be controleld (e-mail content, messages from |
|
|
225 | other users on the same system etc.). |
|
|
226 | |
|
|
227 | =item on_add_lines $term, $string |
|
|
228 | |
|
|
229 | Called whenever text is about to be output, with the text as argument. You |
|
|
230 | can filter/change and output the text yourself by returning a true value |
|
|
231 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
|
|
232 | might be very slow, however, as your hook is called for B<all> text being |
|
|
233 | output. |
|
|
234 | |
|
|
235 | =item on_line_update $term, $row |
|
|
236 | |
|
|
237 | Called whenever a line was updated or changed. Can be used to filter |
|
|
238 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
239 | that are being shown will be filtered, and, due to performance reasons, |
|
|
240 | not always immediately. |
|
|
241 | |
|
|
242 | The row number is always the topmost row of the line if the line spans |
|
|
243 | multiple rows. |
|
|
244 | |
|
|
245 | Please note that, if you change the line, then the hook might get called |
|
|
246 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
247 | you cannot just toggle rendition bits, but only set them. |
156 | |
248 | |
157 | =item on_refresh_begin $term |
249 | =item on_refresh_begin $term |
158 | |
250 | |
159 | Called just before the screen gets redrawn. Can be used for overlay |
251 | Called just before the screen gets redrawn. Can be used for overlay |
160 | or similar effects by modify terminal contents in refresh_begin, and |
252 | or similar effects by modify terminal contents in refresh_begin, and |
… | |
… | |
169 | |
261 | |
170 | Called whenever the user presses a key combination that has a |
262 | Called whenever the user presses a key combination that has a |
171 | C<perl:string> action bound to it (see description of the B<keysym> |
263 | C<perl:string> action bound to it (see description of the B<keysym> |
172 | resource in the @@RXVT_NAME@@(1) manpage). |
264 | resource in the @@RXVT_NAME@@(1) manpage). |
173 | |
265 | |
|
|
266 | =item on_key_press $term, $event |
|
|
267 | |
|
|
268 | =item on_key_release $term, $event |
|
|
269 | |
|
|
270 | =item on_button_press $term, $event |
|
|
271 | |
|
|
272 | =item on_button_release $term, $event |
|
|
273 | |
|
|
274 | =item on_motion_notify $term, $event |
|
|
275 | |
|
|
276 | Called whenever the corresponding X event is received for the terminal. If |
|
|
277 | the hook returns true, then the even will be ignored by rxvt-unicode. |
|
|
278 | |
|
|
279 | subwindow. |
|
|
280 | |
|
|
281 | =back |
|
|
282 | |
|
|
283 | =head2 Variables in the C<urxvt> Package |
|
|
284 | |
|
|
285 | =over 4 |
|
|
286 | |
|
|
287 | =item $urxvt::TERM |
|
|
288 | |
|
|
289 | The current terminal. Whenever a callback/Hook is bein executed, this |
|
|
290 | variable stores the current C<urxvt::term> object. |
|
|
291 | |
174 | =back |
292 | =back |
175 | |
293 | |
176 | =head2 Functions in the C<urxvt> Package |
294 | =head2 Functions in the C<urxvt> Package |
177 | |
295 | |
178 | =over 4 |
296 | =over 4 |
|
|
297 | |
|
|
298 | =item $term = new urxvt [arg...] |
|
|
299 | |
|
|
300 | Creates a new terminal, very similar as if you had started it with |
|
|
301 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
302 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
303 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
304 | C<init> and C<start> hooks will be called during the call. |
179 | |
305 | |
180 | =item urxvt::fatal $errormessage |
306 | =item urxvt::fatal $errormessage |
181 | |
307 | |
182 | Fatally aborts execution with the given error message. Avoid at all |
308 | Fatally aborts execution with the given error message. Avoid at all |
183 | costs! The only time this is acceptable is when the terminal process |
309 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
253 | =cut |
379 | =cut |
254 | |
380 | |
255 | package urxvt; |
381 | package urxvt; |
256 | |
382 | |
257 | use strict; |
383 | use strict; |
|
|
384 | use Scalar::Util (); |
258 | |
385 | |
259 | our $term; |
386 | our $TERM; |
260 | our @HOOKNAME; |
387 | our @HOOKNAME; |
261 | our $LIBDIR; |
388 | our $LIBDIR; |
262 | |
389 | |
263 | BEGIN { |
390 | BEGIN { |
264 | urxvt->bootstrap; |
391 | urxvt->bootstrap; |
… | |
… | |
289 | my $name = $HOOKNAME[$htype]; |
416 | my $name = $HOOKNAME[$htype]; |
290 | |
417 | |
291 | my $ref = $pkg->can ("on_" . lc $name) |
418 | my $ref = $pkg->can ("on_" . lc $name) |
292 | or next; |
419 | or next; |
293 | |
420 | |
294 | $term->{_hook}[$htype]{$ref*1} = $ref; |
421 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
295 | $hook_count[$htype]++ |
422 | $hook_count[$htype]++ |
296 | or set_should_invoke $htype, 1; |
423 | or set_should_invoke $htype, 1; |
297 | } |
424 | } |
298 | } |
425 | } |
299 | |
426 | |
… | |
… | |
321 | |
448 | |
322 | $pkg |
449 | $pkg |
323 | } |
450 | } |
324 | } |
451 | } |
325 | |
452 | |
|
|
453 | our $retval; # return value for urxvt |
|
|
454 | |
326 | # called by the rxvt core |
455 | # called by the rxvt core |
327 | sub invoke { |
456 | sub invoke { |
328 | local $term = shift; |
457 | local $TERM = shift; |
329 | my $htype = shift; |
458 | my $htype = shift; |
330 | |
459 | |
331 | if ($htype == 0) { # INIT |
460 | if ($htype == 0) { # INIT |
332 | my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); |
461 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
333 | |
462 | |
334 | for my $ext (split /:/, $term->resource ("perl_ext")) { |
463 | for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
335 | my @files = grep -f $_, map "$_/$ext", @dirs; |
464 | my @files = grep -f $_, map "$_/$ext", @dirs; |
336 | |
465 | |
337 | if (@files) { |
466 | if (@files) { |
338 | register_package script_package $files[0]; |
467 | register_package script_package $files[0]; |
339 | } else { |
468 | } else { |
340 | warn "perl extension '$ext' not found in perl library search path\n"; |
469 | warn "perl extension '$ext' not found in perl library search path\n"; |
341 | } |
470 | } |
342 | } |
471 | } |
|
|
472 | } |
343 | |
473 | |
|
|
474 | $retval = undef; |
|
|
475 | |
|
|
476 | if (my $cb = $TERM->{_hook}[$htype]) { |
|
|
477 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
|
|
478 | if $verbosity >= 10; |
|
|
479 | |
|
|
480 | keys %$cb; |
|
|
481 | |
|
|
482 | while (my ($pkg, $cb) = each %$cb) { |
|
|
483 | $retval = $cb->( |
|
|
484 | $TERM->{_pkg}{$pkg} ||= do { |
|
|
485 | my $proxy = bless { }, urxvt::term::proxy::; |
|
|
486 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
487 | $proxy |
|
|
488 | }, |
|
|
489 | @_, |
|
|
490 | ) and last; |
|
|
491 | } |
|
|
492 | } |
|
|
493 | |
344 | } elsif ($htype == 1) { # DESTROY |
494 | if ($htype == 1) { # DESTROY |
|
|
495 | # remove hooks if unused |
345 | if (my $hook = $term->{_hook}) { |
496 | if (my $hook = $TERM->{_hook}) { |
346 | for my $htype (0..$#$hook) { |
497 | for my $htype (0..$#$hook) { |
347 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
498 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
348 | or set_should_invoke $htype, 0; |
499 | or set_should_invoke $htype, 0; |
349 | } |
500 | } |
350 | } |
501 | } |
|
|
502 | |
|
|
503 | # clear package objects |
|
|
504 | %$_ = () for values %{ $TERM->{_pkg} }; |
|
|
505 | |
|
|
506 | # clear package |
|
|
507 | %$TERM = (); |
351 | } |
508 | } |
352 | |
509 | |
353 | my $cb = $term->{_hook}[$htype] |
510 | $retval |
354 | or return; |
511 | } |
355 | |
512 | |
356 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" |
513 | sub urxvt::term::proxy::AUTOLOAD { |
357 | if $verbosity >= 10; |
514 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
|
|
515 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
358 | |
516 | |
359 | while (my ($k, $v) = each %$cb) { |
517 | eval qq{ |
360 | return 1 if $v->($term, @_); |
518 | sub $urxvt::term::proxy::AUTOLOAD { |
361 | } |
519 | my \$proxy = shift; |
|
|
520 | \$proxy->{term}->$1 (\@_) |
|
|
521 | } |
|
|
522 | 1 |
|
|
523 | } or die "FATAL: unable to compile method forwarder: $@"; |
362 | |
524 | |
363 | 0 |
525 | goto &$urxvt::term::proxy::AUTOLOAD; |
364 | } |
526 | } |
365 | |
527 | |
366 | =head2 The C<urxvt::term> Class |
528 | =head2 The C<urxvt::term> Class |
367 | |
529 | |
368 | =over 4 |
530 | =over 4 |
|
|
531 | |
|
|
532 | =item $term->destroy |
|
|
533 | |
|
|
534 | Destroy the terminal object (close the window, free resources etc.). |
369 | |
535 | |
370 | =item $value = $term->resource ($name[, $newval]) |
536 | =item $value = $term->resource ($name[, $newval]) |
371 | |
537 | |
372 | Returns the current resource value associated with a given name and |
538 | Returns the current resource value associated with a given name and |
373 | optionally sets a new value. Setting values is most useful in the C<init> |
539 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
391 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
557 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
392 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
558 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
393 | display_name embed ext_bwidth fade font geometry hold iconName |
559 | display_name embed ext_bwidth fade font geometry hold iconName |
394 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
560 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
395 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
561 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
396 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
562 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
397 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
563 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
398 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
564 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
399 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
565 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
400 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
566 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
401 | shade term_name title transparent transparent_all tripleclickwords |
567 | shade term_name title transparent transparent_all tripleclickwords |
… | |
… | |
407 | my ($self, $name) = (shift, shift); |
573 | my ($self, $name) = (shift, shift); |
408 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
574 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
409 | goto &urxvt::term::_resource; |
575 | goto &urxvt::term::_resource; |
410 | } |
576 | } |
411 | |
577 | |
|
|
578 | =item $rend = $term->rstyle ([$new_rstyle]) |
|
|
579 | |
|
|
580 | Return and optionally change the current rendition. Text that is output by |
|
|
581 | the terminal application will use this style. |
|
|
582 | |
|
|
583 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
584 | |
|
|
585 | Return the current coordinates of the text cursor position and optionally |
|
|
586 | set it (which is usually bad as applications don't expect that). |
|
|
587 | |
412 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
588 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
413 | |
589 | |
414 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
590 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
415 | |
591 | |
416 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
592 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
… | |
… | |
430 | #=item $term->overlay ($x, $y, $text) |
606 | #=item $term->overlay ($x, $y, $text) |
431 | # |
607 | # |
432 | #Create a simple multi-line overlay box. See the next method for details. |
608 | #Create a simple multi-line overlay box. See the next method for details. |
433 | # |
609 | # |
434 | #=cut |
610 | #=cut |
435 | |
611 | # |
436 | sub urxvt::term::scr_overlay { |
612 | #sub urxvt::term::scr_overlay { |
437 | die; |
|
|
438 | my ($self, $x, $y, $text) = @_; |
613 | # my ($self, $x, $y, $text) = @_; |
439 | |
614 | # |
440 | my @lines = split /\n/, $text; |
615 | # my @lines = split /\n/, $text; |
441 | |
616 | # |
442 | my $w = 0; |
617 | # my $w = 0; |
443 | for (map $self->strwidth ($_), @lines) { |
618 | # for (map $self->strwidth ($_), @lines) { |
444 | $w = $_ if $w < $_; |
619 | # $w = $_ if $w < $_; |
445 | } |
620 | # } |
446 | |
621 | # |
447 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
622 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
448 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
623 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
449 | } |
624 | #} |
450 | |
625 | |
451 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
626 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
452 | |
627 | |
453 | Create a new (empty) overlay at the given position with the given |
628 | Create a new (empty) overlay at the given position with the given |
454 | width/height. C<$rstyle> defines the initial rendition style |
629 | width/height. C<$rstyle> defines the initial rendition style |
… | |
… | |
461 | right/bottom side, respectively. |
636 | right/bottom side, respectively. |
462 | |
637 | |
463 | This method returns an urxvt::overlay object. The overlay will be visible |
638 | This method returns an urxvt::overlay object. The overlay will be visible |
464 | as long as the perl object is referenced. |
639 | as long as the perl object is referenced. |
465 | |
640 | |
466 | Currently, the only method on the C<urxvt::overlay> object is C<set>: |
641 | The methods currently supported on C<urxvt::overlay> objects are: |
|
|
642 | |
|
|
643 | =over 4 |
467 | |
644 | |
468 | =item $overlay->set ($x, $y, $text, $rend) |
645 | =item $overlay->set ($x, $y, $text, $rend) |
469 | |
646 | |
470 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
647 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
471 | text in rxvt-unicode's special encoding and an array of rendition values |
648 | text in rxvt-unicode's special encoding and an array of rendition values |
472 | at a specific position inside the overlay. |
649 | at a specific position inside the overlay. |
473 | |
650 | |
|
|
651 | =item $overlay->hide |
|
|
652 | |
|
|
653 | If visible, hide the overlay, but do not destroy it. |
|
|
654 | |
|
|
655 | =item $overlay->show |
|
|
656 | |
|
|
657 | If hidden, display the overlay again. |
|
|
658 | |
|
|
659 | =back |
|
|
660 | |
474 | =item $cellwidth = $term->strwidth $string |
661 | =item $cellwidth = $term->strwidth $string |
475 | |
662 | |
476 | Returns the number of screen-cells this string would need. Correctly |
663 | Returns the number of screen-cells this string would need. Correctly |
477 | accounts for wide and combining characters. |
664 | accounts for wide and combining characters. |
478 | |
665 | |
… | |
… | |
481 | Convert the given text string into the corresponding locale encoding. |
668 | Convert the given text string into the corresponding locale encoding. |
482 | |
669 | |
483 | =item $string = $term->locale_decode $octets |
670 | =item $string = $term->locale_decode $octets |
484 | |
671 | |
485 | Convert the given locale-encoded octets into a perl string. |
672 | Convert the given locale-encoded octets into a perl string. |
|
|
673 | |
|
|
674 | =item $term->scr_add_lines ($string) |
|
|
675 | |
|
|
676 | Write the given text string to the screen, as if output by the application |
|
|
677 | running inside the terminal. It may not contain command sequences (escape |
|
|
678 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
679 | string is a normal text string, not in locale-dependent encoding. |
|
|
680 | |
|
|
681 | Normally its not a good idea to use this function, as programs might be |
|
|
682 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
683 | C<on_add_lines> hook, though. |
|
|
684 | |
|
|
685 | =item $term->cmd_parse ($octets) |
|
|
686 | |
|
|
687 | Similar to C<scr_add_lines>, but the argument must be in the |
|
|
688 | locale-specific encoding of the terminal and can contain command sequences |
|
|
689 | (escape codes) that will be interpreted. |
486 | |
690 | |
487 | =item $term->tt_write ($octets) |
691 | =item $term->tt_write ($octets) |
488 | |
692 | |
489 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
693 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
490 | pass characters instead of octets, you should convert your strings first |
694 | pass characters instead of octets, you should convert your strings first |
491 | to the locale-specific encoding using C<< $term->locale_encode >>. |
695 | to the locale-specific encoding using C<< $term->locale_encode >>. |
492 | |
696 | |
|
|
697 | =item $window_width = $term->width |
|
|
698 | |
|
|
699 | =item $window_height = $term->height |
|
|
700 | |
|
|
701 | =item $font_width = $term->fwidth |
|
|
702 | |
|
|
703 | =item $font_height = $term->fheight |
|
|
704 | |
|
|
705 | =item $font_ascent = $term->fbase |
|
|
706 | |
493 | =item $nrow = $term->nrow |
707 | =item $terminal_rows = $term->nrow |
494 | |
708 | |
495 | =item $ncol = $term->ncol |
709 | =item $terminal_columns = $term->ncol |
496 | |
710 | |
497 | Return the number of rows/columns of the terminal window (i.e. as |
711 | =item $has_focus = $term->focus |
498 | specified by C<-geometry>, excluding any scrollback). |
|
|
499 | |
712 | |
500 | =item $nsaved = $term->nsaved |
713 | =item $is_mapped = $term->mapped |
501 | |
714 | |
502 | Returns the number of lines in the scrollback buffer. |
715 | =item $max_scrollback = $term->saveLines |
|
|
716 | |
|
|
717 | =item $nrow_plus_saveLines = $term->total_rows |
|
|
718 | |
|
|
719 | =item $lines_in_scrollback = $term->nsaved |
|
|
720 | |
|
|
721 | Return various integers describing terminal characteristics. |
503 | |
722 | |
504 | =item $view_start = $term->view_start ([$newvalue]) |
723 | =item $view_start = $term->view_start ([$newvalue]) |
505 | |
724 | |
506 | Returns the negative row number of the topmost line. Minimum value is |
725 | Returns the negative row number of the topmost line. Minimum value is |
507 | C<0>, which displays the normal terminal contents. Larger values scroll |
726 | C<0>, which displays the normal terminal contents. Larger values scroll |
… | |
… | |
518 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
737 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
519 | |
738 | |
520 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
739 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
521 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
740 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
522 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
741 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
523 | line C<< -$term->nsaved >>. |
742 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
|
|
743 | is requested. |
524 | |
744 | |
525 | If C<$new_text> is specified, it will replace characters in the current |
745 | If C<$new_text> is specified, it will replace characters in the current |
526 | line, starting at column C<$start_col> (default C<0>), which is useful |
746 | line, starting at column C<$start_col> (default C<0>), which is useful |
527 | to replace only parts of a line. The font index in the rendition will |
747 | to replace only parts of a line. The font index in the rendition will |
528 | automatically be updated. |
748 | automatically be updated. |
… | |
… | |
550 | |
770 | |
551 | See the section on RENDITION, above. |
771 | See the section on RENDITION, above. |
552 | |
772 | |
553 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
773 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
554 | |
774 | |
555 | Returns the number of screen cells that are in use ("the line length"). If |
775 | Returns the number of screen cells that are in use ("the line |
556 | it is C<-1>, then the line is part of a multiple-row logical "line", which |
776 | length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the |
557 | means all characters are in use and it is continued on the next row. |
777 | line is joined with the following one. |
558 | |
778 | |
|
|
779 | =item $bool = $term->is_longer ($row_number) |
|
|
780 | |
|
|
781 | Returns true if the row is part of a multiple-row logical "line" (i.e. |
|
|
782 | joined with the following row), which means all characters are in use |
|
|
783 | and it is continued on the next row (and possibly a continuation of the |
|
|
784 | previous row(s)). |
|
|
785 | |
|
|
786 | =item $line = $term->line ($row_number) |
|
|
787 | |
|
|
788 | Create and return a new C<urxvt::line> object that stores information |
|
|
789 | about the logical line that row C<$row_number> is part of. It supports the |
|
|
790 | following methods: |
|
|
791 | |
|
|
792 | =over 4 |
|
|
793 | |
|
|
794 | =item $text = $line->t ([$new_text]) |
|
|
795 | |
|
|
796 | Returns or replaces the full text of the line, similar to C<ROW_t> |
|
|
797 | |
|
|
798 | =item $rend = $line->r ([$new_rend]) |
|
|
799 | |
|
|
800 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
|
|
801 | |
|
|
802 | =item $length = $line->l |
|
|
803 | |
|
|
804 | Returns the length of the line in cells, similar to C<ROW_l>. |
|
|
805 | |
|
|
806 | =item $rownum = $line->beg |
|
|
807 | |
|
|
808 | =item $rownum = $line->end |
|
|
809 | |
|
|
810 | Return the row number of the first/last row of the line, respectively. |
|
|
811 | |
|
|
812 | =item $offset = $line->offset_of ($row, $col) |
|
|
813 | |
|
|
814 | Returns the character offset of the given row|col pair within the logical |
|
|
815 | line. |
|
|
816 | |
|
|
817 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
818 | |
|
|
819 | Translates a string offset into terminal coordinates again. |
|
|
820 | |
|
|
821 | =back |
|
|
822 | |
|
|
823 | =cut |
|
|
824 | |
|
|
825 | sub urxvt::term::line { |
|
|
826 | my ($self, $row) = @_; |
|
|
827 | |
|
|
828 | my $maxrow = $self->nrow - 1; |
|
|
829 | |
|
|
830 | my ($beg, $end) = ($row, $row); |
|
|
831 | |
|
|
832 | --$beg while $self->ROW_is_longer ($beg - 1); |
|
|
833 | ++$end while $self->ROW_is_longer ($end) && $end < $maxrow; |
|
|
834 | |
|
|
835 | bless { |
|
|
836 | term => $self, |
|
|
837 | beg => $beg, |
|
|
838 | end => $end, |
|
|
839 | ncol => $self->ncol, |
|
|
840 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
|
|
841 | }, urxvt::line:: |
|
|
842 | } |
|
|
843 | |
|
|
844 | sub urxvt::line::t { |
|
|
845 | my ($self) = @_; |
|
|
846 | |
|
|
847 | if (@_ > 1) |
|
|
848 | { |
|
|
849 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
850 | for $self->{beg} .. $self->{end}; |
|
|
851 | } |
|
|
852 | |
|
|
853 | defined wantarray && |
|
|
854 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
|
|
855 | 0, $self->{len} |
|
|
856 | } |
|
|
857 | |
|
|
858 | sub urxvt::line::r { |
|
|
859 | my ($self) = @_; |
|
|
860 | |
|
|
861 | if (@_ > 1) |
|
|
862 | { |
|
|
863 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
864 | for $self->{beg} .. $self->{end}; |
|
|
865 | } |
|
|
866 | |
|
|
867 | if (defined wantarray) { |
|
|
868 | my $rend = [ |
|
|
869 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
|
|
870 | ]; |
|
|
871 | $#$rend = $self->{len} - 1; |
|
|
872 | return $rend; |
|
|
873 | } |
|
|
874 | |
|
|
875 | () |
|
|
876 | } |
|
|
877 | |
|
|
878 | sub urxvt::line::beg { $_[0]{beg} } |
|
|
879 | sub urxvt::line::end { $_[0]{end} } |
|
|
880 | sub urxvt::line::l { $_[0]{len} } |
|
|
881 | |
|
|
882 | sub urxvt::line::offset_of { |
|
|
883 | my ($self, $row, $col) = @_; |
|
|
884 | |
|
|
885 | ($row - $self->{beg}) * $self->{ncol} + $col |
|
|
886 | } |
|
|
887 | |
|
|
888 | sub urxvt::line::coord_of { |
|
|
889 | my ($self, $offset) = @_; |
|
|
890 | |
|
|
891 | use integer; |
|
|
892 | |
|
|
893 | ( |
|
|
894 | $offset / $self->{ncol} + $self->{beg}, |
|
|
895 | $offset % $self->{ncol} |
|
|
896 | ) |
|
|
897 | } |
|
|
898 | |
|
|
899 | =item ($row, $col) = $line->coord_of ($offset) |
559 | =item $text = $term->special_encode $string |
900 | =item $text = $term->special_encode $string |
560 | |
901 | |
561 | Converts a perl string into the special encoding used by rxvt-unicode, |
902 | Converts a perl string into the special encoding used by rxvt-unicode, |
562 | where one character corresponds to one screen cell. See |
903 | where one character corresponds to one screen cell. See |
563 | C<< $term->ROW_t >> for details. |
904 | C<< $term->ROW_t >> for details. |
… | |
… | |
677 | This variable controls the verbosity level of the perl extension. Higher |
1018 | This variable controls the verbosity level of the perl extension. Higher |
678 | numbers indicate more verbose output. |
1019 | numbers indicate more verbose output. |
679 | |
1020 | |
680 | =over 4 |
1021 | =over 4 |
681 | |
1022 | |
682 | =item 0 - only fatal messages |
1023 | =item =0 - only fatal messages |
683 | |
1024 | |
684 | =item 3 - script loading and management |
1025 | =item =3 - script loading and management |
685 | |
1026 | |
686 | =item 10 - all events received |
1027 | =item =10 - all events received |
687 | |
1028 | |
688 | =back |
1029 | =back |
689 | |
1030 | |
690 | =head1 AUTHOR |
1031 | =head1 AUTHOR |
691 | |
1032 | |