|
|
1 | =encoding utf8 |
|
|
2 | |
1 | =head1 NAME |
3 | =head1 NAME |
2 | |
4 | |
3 | @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter |
5 | @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter |
4 | |
6 | |
5 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
… | |
… | |
22 | |
24 | |
23 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
24 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
25 | |
27 | |
26 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
27 | scripts will be shared (But not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
28 | |
30 | |
29 | =head1 PACKAGED EXTENSIONS |
31 | =head2 Prepackaged Extensions |
30 | |
32 | |
31 | This section describes the extensiosn delivered with this version. You can |
33 | This section describes the extensiosn delivered with this version. You can |
32 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
33 | |
35 | |
34 | You can activate them like this: |
36 | You can activate them like this: |
… | |
… | |
50 | URxvt.keysym.C-M-r: perl:selection:rot13 |
52 | URxvt.keysym.C-M-r: perl:selection:rot13 |
51 | |
53 | |
52 | =back |
54 | =back |
53 | |
55 | |
54 | =item digital-clock |
56 | =item digital-clock |
|
|
57 | |
|
|
58 | Displays a digital clock using the built-in overlay. |
|
|
59 | |
|
|
60 | =item example-refresh-hooks |
55 | |
61 | |
56 | Displays a very simple digital clock in the upper right corner of the |
62 | Displays a very simple digital clock in the upper right corner of the |
57 | window. Illustrates overwriting the refresh callbacks to create your own |
63 | window. Illustrates overwriting the refresh callbacks to create your own |
58 | overlays or changes. |
64 | overlays or changes. |
59 | |
|
|
60 | =item simple-overlay-clock |
|
|
61 | |
|
|
62 | Displays a digital clock using the built-in overlay (colorful, useless). |
|
|
63 | |
65 | |
64 | =back |
66 | =back |
65 | |
67 | |
66 | =head2 General API Considerations |
68 | =head2 General API Considerations |
67 | |
69 | |
… | |
… | |
191 | correct place, e.g. on stderr of the connecting urxvtc client. |
193 | correct place, e.g. on stderr of the connecting urxvtc client. |
192 | |
194 | |
193 | =item $time = urxvt::NOW |
195 | =item $time = urxvt::NOW |
194 | |
196 | |
195 | Returns the "current time" (as per the event loop). |
197 | Returns the "current time" (as per the event loop). |
|
|
198 | |
|
|
199 | =head2 RENDITION |
|
|
200 | |
|
|
201 | Rendition bitsets contain information about colour, font, font styles and |
|
|
202 | similar information for each screen cell. |
|
|
203 | |
|
|
204 | The following "macros" deal with changes in rendition sets. You should |
|
|
205 | never just create a bitset, you should always modify an existing one, |
|
|
206 | as they contain important information required for correct operation of |
|
|
207 | rxvt-unicode. |
|
|
208 | |
|
|
209 | =over 4 |
|
|
210 | |
|
|
211 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
212 | |
|
|
213 | Returns the default rendition, as used when the terminal is starting up or |
|
|
214 | being reset. Useful as a base to start when creating renditions. |
|
|
215 | |
|
|
216 | =item $rend = urxvt::OVERLAY_RSTYLE |
|
|
217 | |
|
|
218 | Return the rendition mask used for overlays by default. |
|
|
219 | |
|
|
220 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
|
|
221 | |
|
|
222 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
223 | underline, respectively. To enable such a style, just logically OR it into |
|
|
224 | the bitset. |
|
|
225 | |
|
|
226 | =item $foreground = urxvt::GET_BASEFG $rend |
|
|
227 | |
|
|
228 | =item $background = urxvt::GET_BASEBG $rend |
|
|
229 | |
|
|
230 | Return the foreground/background colour index, respectively. |
|
|
231 | |
|
|
232 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
|
|
233 | |
|
|
234 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
|
|
235 | |
|
|
236 | Replace the foreground/background colour in the rendition mask with the |
|
|
237 | specified one. |
|
|
238 | |
|
|
239 | =item $value = urxvt::GET_CUSTOM ($rend) |
|
|
240 | |
|
|
241 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
242 | extensions. They can be set and changed as you like and are initially |
|
|
243 | zero. |
|
|
244 | |
|
|
245 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
|
|
246 | |
|
|
247 | Change the custom value. |
|
|
248 | |
|
|
249 | =back |
196 | |
250 | |
197 | =cut |
251 | =cut |
198 | |
252 | |
199 | package urxvt; |
253 | package urxvt; |
200 | |
254 | |
… | |
… | |
371 | |
425 | |
372 | =item $oldtext = $term->selection ([$newtext]) |
426 | =item $oldtext = $term->selection ([$newtext]) |
373 | |
427 | |
374 | Return the current selection text and optionally replace it by C<$newtext>. |
428 | Return the current selection text and optionally replace it by C<$newtext>. |
375 | |
429 | |
376 | =item $term->scr_overlay ($x, $y, $text) |
430 | #=item $term->overlay ($x, $y, $text) |
377 | |
431 | # |
378 | Create a simple multi-line overlay box. See the next method for details. |
432 | #Create a simple multi-line overlay box. See the next method for details. |
379 | |
433 | # |
380 | =cut |
434 | #=cut |
381 | |
435 | |
382 | sub urxvt::term::scr_overlay { |
436 | sub urxvt::term::scr_overlay { |
|
|
437 | die; |
383 | my ($self, $x, $y, $text) = @_; |
438 | my ($self, $x, $y, $text) = @_; |
384 | |
439 | |
385 | my @lines = split /\n/, $text; |
440 | my @lines = split /\n/, $text; |
386 | |
441 | |
387 | my $w = 0; |
442 | my $w = 0; |
… | |
… | |
391 | |
446 | |
392 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
447 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
393 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
448 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
394 | } |
449 | } |
395 | |
450 | |
396 | =item $term->scr_overlay_new ($x, $y, $width, $height) |
451 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
397 | |
452 | |
398 | Create a new (empty) overlay at the given position with the given |
453 | Create a new (empty) overlay at the given position with the given |
399 | width/height. A border will be put around the box. If either C<$x> or |
454 | width/height. C<$rstyle> defines the initial rendition style |
400 | C<$y> is negative, then this is counted from the right/bottom side, |
455 | (default: C<OVERLAY_RSTYLE>). |
401 | respectively. |
|
|
402 | |
456 | |
403 | =item $term->scr_overlay_off |
457 | If C<$border> is C<2> (default), then a decorative border will be put |
|
|
458 | around the box. |
404 | |
459 | |
405 | Switch the overlay off again. |
460 | If either C<$x> or C<$y> is negative, then this is counted from the |
|
|
461 | right/bottom side, respectively. |
406 | |
462 | |
407 | =item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) |
463 | This method returns an urxvt::overlay object. The overlay will be visible |
|
|
464 | as long as the perl object is referenced. |
408 | |
465 | |
409 | Put a single character (specified numerically) at the given overlay |
466 | Currently, the only method on the C<urxvt::overlay> object is C<set>: |
410 | position. |
|
|
411 | |
467 | |
412 | =item $term->scr_overlay_set ($x, $y, $text) |
468 | =item $overlay->set ($x, $y, $text, $rend) |
413 | |
469 | |
414 | Write a string at the given position into the overlay. |
470 | 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 |
|
|
472 | at a specific position inside the overlay. |
415 | |
473 | |
416 | =item $cellwidth = $term->strwidth $string |
474 | =item $cellwidth = $term->strwidth $string |
417 | |
475 | |
418 | Returns the number of screen-cells this string would need. Correctly |
476 | Returns the number of screen-cells this string would need. Correctly |
419 | accounts for wide and combining characters. |
477 | accounts for wide and combining characters. |
… | |
… | |
464 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
522 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
465 | line C<< -$term->nsaved >>. |
523 | line C<< -$term->nsaved >>. |
466 | |
524 | |
467 | If C<$new_text> is specified, it will replace characters in the current |
525 | If C<$new_text> is specified, it will replace characters in the current |
468 | line, starting at column C<$start_col> (default C<0>), which is useful |
526 | line, starting at column C<$start_col> (default C<0>), which is useful |
469 | to replace only parts of a line. The font iindex in the rendition will |
527 | to replace only parts of a line. The font index in the rendition will |
470 | automatically be updated. |
528 | automatically be updated. |
471 | |
529 | |
472 | C<$text> is in a special encoding: tabs and wide characters that use more |
530 | C<$text> is in a special encoding: tabs and wide characters that use more |
473 | than one cell when displayed are padded with urxvt::NOCHAR characters |
531 | than one cell when displayed are padded with urxvt::NOCHAR characters |
474 | (C<chr 65535>). Characters with combining characters and other characters |
532 | (C<chr 65535>). Characters with combining characters and other characters |
… | |
… | |
488 | bitsets. Rendition bitsets contain information about colour, font, font |
546 | bitsets. Rendition bitsets contain information about colour, font, font |
489 | styles and similar information. See also C<< $term->ROW_t >>. |
547 | styles and similar information. See also C<< $term->ROW_t >>. |
490 | |
548 | |
491 | When setting rendition, the font mask will be ignored. |
549 | When setting rendition, the font mask will be ignored. |
492 | |
550 | |
493 | See the section on RENDITION, below. |
551 | See the section on RENDITION, above. |
494 | |
552 | |
495 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
553 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
496 | |
554 | |
497 | Returns the number of screen cells that are in use ("the line length"). If |
555 | Returns the number of screen cells that are in use ("the line length"). If |
498 | it is C<-1>, then the line is part of a multiple-row logical "line", which |
556 | it is C<-1>, then the line is part of a multiple-row logical "line", which |
… | |
… | |
509 | Converts rxvt-unicodes text reprsentation into a perl string. See |
567 | Converts rxvt-unicodes text reprsentation into a perl string. See |
510 | C<< $term->ROW_t >> for details. |
568 | C<< $term->ROW_t >> for details. |
511 | |
569 | |
512 | =back |
570 | =back |
513 | |
571 | |
514 | =head2 RENDITION |
|
|
515 | |
|
|
516 | Rendition bitsets contain information about colour, font, font styles and |
|
|
517 | similar information for each screen cell. |
|
|
518 | |
|
|
519 | The following "macros" deal with changes in rendition sets. You should |
|
|
520 | never just create a bitset, you should always modify an existing one, |
|
|
521 | as they contain important information required for correct operation of |
|
|
522 | rxvt-unicode. |
|
|
523 | |
|
|
524 | =over 4 |
|
|
525 | |
|
|
526 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
527 | |
|
|
528 | Returns the default rendition, as used when the terminal is starting up or |
|
|
529 | being reset. Useful as a base |
|
|
530 | |
|
|
531 | =back |
|
|
532 | |
|
|
533 | =cut |
|
|
534 | |
|
|
535 | =head2 The C<urxvt::timer> Class |
572 | =head2 The C<urxvt::timer> Class |
536 | |
573 | |
537 | This class implements timer watchers/events. Time is represented as a |
574 | This class implements timer watchers/events. Time is represented as a |
538 | fractional number of seconds since the epoch. Example: |
575 | fractional number of seconds since the epoch. Example: |
539 | |
576 | |
540 | # create a digital clock display in upper right corner |
577 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
541 | $term->{timer} = urxvt::timer |
578 | $term->{timer} = urxvt::timer |
542 | ->new |
579 | ->new |
543 | ->start (urxvt::NOW) |
580 | ->interval (1) |
544 | ->cb (sub { |
581 | ->cb (sub { |
545 | my ($timer) = @_; |
|
|
546 | my $time = $timer->at; |
|
|
547 | $timer->start ($time + 1); |
|
|
548 | $self->scr_overlay (-1, 0, |
582 | $term->{overlay}->set (0, 0, |
549 | POSIX::strftime "%H:%M:%S", localtime $time); |
583 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
550 | }); |
584 | }); |
551 | |
585 | |
552 | =over 4 |
586 | =over 4 |
553 | |
587 | |
554 | =item $timer = new urxvt::timer |
588 | =item $timer = new urxvt::timer |
555 | |
589 | |
556 | Create a new timer object in stopped state. |
590 | Create a new timer object in started state. It is scheduled to fire |
|
|
591 | immediately. |
557 | |
592 | |
558 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
593 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
559 | |
594 | |
560 | Set the callback to be called when the timer triggers. |
595 | Set the callback to be called when the timer triggers. |
561 | |
596 | |
… | |
… | |
564 | Return the time this watcher will fire next. |
599 | Return the time this watcher will fire next. |
565 | |
600 | |
566 | =item $timer = $timer->set ($tstamp) |
601 | =item $timer = $timer->set ($tstamp) |
567 | |
602 | |
568 | Set the time the event is generated to $tstamp. |
603 | Set the time the event is generated to $tstamp. |
|
|
604 | |
|
|
605 | =item $timer = $timer->interval ($interval) |
|
|
606 | |
|
|
607 | Normally (and when C<$interval> is C<0>), the timer will automatically |
|
|
608 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
|
|
609 | is automatically rescheduled at the given intervals. |
569 | |
610 | |
570 | =item $timer = $timer->start |
611 | =item $timer = $timer->start |
571 | |
612 | |
572 | Start the timer. |
613 | Start the timer. |
573 | |
614 | |