… | |
… | |
40 | |
40 | |
41 | @@RXVT_NAME@@ -pe <extensionname> |
41 | @@RXVT_NAME@@ -pe <extensionname> |
42 | |
42 | |
43 | Or by adding them to the resource for extensions loaded by default: |
43 | Or by adding them to the resource for extensions loaded by default: |
44 | |
44 | |
45 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
45 | URxvt.perl-ext-common: default,selection-autotransform |
46 | |
46 | |
47 | =over 4 |
47 | =over 4 |
48 | |
48 | |
49 | =item selection (enabled by default) |
49 | =item selection (enabled by default) |
50 | |
50 | |
… | |
… | |
108 | reference. The string will be used as button text and the code reference |
108 | reference. The string will be used as button text and the code reference |
109 | will be called when the toggle changes, with the new boolean value as |
109 | will be called when the toggle changes, with the new boolean value as |
110 | first argument. |
110 | first argument. |
111 | |
111 | |
112 | The following will add an entry C<myoption> that changes |
112 | The following will add an entry C<myoption> that changes |
113 | C<$self->{myoption}>: |
113 | C<< $self->{myoption} >>: |
114 | |
114 | |
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
117 | }; |
117 | }; |
118 | |
118 | |
… | |
… | |
165 | =item readline (enabled by default) |
165 | =item readline (enabled by default) |
166 | |
166 | |
167 | A support package that tries to make editing with readline easier. At |
167 | A support package that tries to make editing with readline easier. At |
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
169 | move the text cursor to this position. It does so by generating as many |
169 | move the text cursor to this position. It does so by generating as many |
170 | cursor-left or cursor-right keypresses as required (the this only works |
170 | cursor-left or cursor-right keypresses as required (this only works |
171 | for programs that correctly support wide characters). |
171 | for programs that correctly support wide characters). |
172 | |
172 | |
173 | To avoid too many false positives, this is only done when: |
173 | To avoid too many false positives, this is only done when: |
174 | |
174 | |
175 | =over 4 |
175 | =over 4 |
… | |
… | |
303 | extension will actually grab a physical key just for this function. |
303 | extension will actually grab a physical key just for this function. |
304 | |
304 | |
305 | If you want a quake-like animation, tell your window manager to do so |
305 | If you want a quake-like animation, tell your window manager to do so |
306 | (fvwm can do it). |
306 | (fvwm can do it). |
307 | |
307 | |
308 | =item automove-background |
308 | =item overlay-osc |
309 | |
309 | |
310 | This is basically a very small extension that dynamically changes the |
310 | This extension implements some OSC commands to display timed popups on the |
311 | background pixmap offset to the window position, in effect creating the |
311 | screen - useful for status displays from within scripts. You have to read |
312 | same effect as pseudo transparency with a custom pixmap. No scaling is |
312 | the sources for more info. |
313 | supported in this mode. Example: |
|
|
314 | |
|
|
315 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
316 | |
|
|
317 | L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions> |
|
|
318 | shows how this extension can be used to implement an automatically blurred |
|
|
319 | transparent background. |
|
|
320 | |
313 | |
321 | =item block-graphics-to-ascii |
314 | =item block-graphics-to-ascii |
322 | |
315 | |
323 | A not very useful example of filtering all text output to the terminal |
316 | A not very useful example of filtering all text output to the terminal |
324 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
317 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
… | |
… | |
379 | |
372 | |
380 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
373 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
381 | the double C</> characters as comment start. Use C<\057\057> instead, |
374 | the double C</> characters as comment start. Use C<\057\057> instead, |
382 | which works regardless of wether xrdb is used to parse the resource file |
375 | which works regardless of wether xrdb is used to parse the resource file |
383 | or not. |
376 | or not. |
|
|
377 | |
|
|
378 | =item macosx-pastebin and macosx-pastebin-native |
|
|
379 | |
|
|
380 | These two modules implement an extended clipboard for Mac OS X. They are |
|
|
381 | used like this: |
|
|
382 | |
|
|
383 | URxvt.perl-ext-common: default,macosx-clipboard |
|
|
384 | URxvt.keysym.M-c: perl:macosx-clipboard:copy |
|
|
385 | URxvt.keysym.M-v: perl:macosx-clipboard:paste |
|
|
386 | |
|
|
387 | The difference between them is that the native variant requires a |
|
|
388 | perl from apple's devkit or so, and C<maxosx-pastebin> requires the |
|
|
389 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
|
|
390 | simpler etc. etc. |
384 | |
391 | |
385 | =item example-refresh-hooks |
392 | =item example-refresh-hooks |
386 | |
393 | |
387 | Displays a very simple digital clock in the upper right corner of the |
394 | Displays a very simple digital clock in the upper right corner of the |
388 | window. Illustrates overwriting the refresh callbacks to create your own |
395 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
554 | |
561 | |
555 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
562 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
556 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
563 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
557 | number of lines that will be in the scrollback buffer. |
564 | number of lines that will be in the scrollback buffer. |
558 | |
565 | |
559 | =item on_osc_seq $term, $op, $args |
566 | =item on_osc_seq $term, $op, $args, $resp |
560 | |
567 | |
561 | Called on every OSC sequence and can be used to suppress it or modify its |
568 | Called on every OSC sequence and can be used to suppress it or modify its |
562 | behaviour. The default should be to return an empty list. A true value |
569 | behaviour. The default should be to return an empty list. A true value |
563 | suppresses execution of the request completely. Make sure you don't get |
570 | suppresses execution of the request completely. Make sure you don't get |
564 | confused by recursive invocations when you output an osc sequence within |
571 | confused by recursive invocations when you output an OSC sequence within |
565 | this callback. |
572 | this callback. |
566 | |
573 | |
567 | C<on_osc_seq_perl> should be used for new behaviour. |
574 | C<on_osc_seq_perl> should be used for new behaviour. |
568 | |
575 | |
569 | =item on_osc_seq_perl $term, $string |
576 | =item on_osc_seq_perl $term, $args, $resp |
570 | |
577 | |
571 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
578 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
572 | operating system command) is processed. Cursor position and other state |
579 | operating system command) is processed. Cursor position and other state |
573 | information is up-to-date when this happens. For interoperability, the |
580 | information is up-to-date when this happens. For interoperability, the |
574 | string should start with the extension name and a colon, to distinguish |
581 | string should start with the extension name (sans -osc) and a semicolon, |
575 | it from commands for other extensions, and this might be enforced in the |
582 | to distinguish it from commands for other extensions, and this might be |
576 | future. |
583 | enforced in the future. |
|
|
584 | |
|
|
585 | For example, C<overlay-osc> uses this: |
|
|
586 | |
|
|
587 | sub on_osc_seq_perl { |
|
|
588 | my ($self, $osc, $resp) = @_; |
|
|
589 | |
|
|
590 | return unless $osc =~ s/^overlay;//; |
|
|
591 | |
|
|
592 | ... process remaining $osc string |
|
|
593 | } |
577 | |
594 | |
578 | Be careful not ever to trust (in a security sense) the data you receive, |
595 | Be careful not ever to trust (in a security sense) the data you receive, |
579 | as its source can not easily be controlled (e-mail content, messages from |
596 | as its source can not easily be controlled (e-mail content, messages from |
580 | other users on the same system etc.). |
597 | other users on the same system etc.). |
|
|
598 | |
|
|
599 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
600 | sender. |
581 | |
601 | |
582 | =item on_add_lines $term, $string |
602 | =item on_add_lines $term, $string |
583 | |
603 | |
584 | Called whenever text is about to be output, with the text as argument. You |
604 | Called whenever text is about to be output, with the text as argument. You |
585 | can filter/change and output the text yourself by returning a true value |
605 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
606 | later with the already-modified line (e.g. if unrelated parts change), so |
626 | later with the already-modified line (e.g. if unrelated parts change), so |
607 | you cannot just toggle rendition bits, but only set them. |
627 | you cannot just toggle rendition bits, but only set them. |
608 | |
628 | |
609 | =item on_refresh_begin $term |
629 | =item on_refresh_begin $term |
610 | |
630 | |
611 | Called just before the screen gets redrawn. Can be used for overlay |
631 | Called just before the screen gets redrawn. Can be used for overlay or |
612 | or similar effects by modify terminal contents in refresh_begin, and |
632 | similar effects by modifying the terminal contents in refresh_begin, and |
613 | restoring them in refresh_end. The built-in overlay and selection display |
633 | restoring them in refresh_end. The built-in overlay and selection display |
614 | code is run after this hook, and takes precedence. |
634 | code is run after this hook, and takes precedence. |
615 | |
635 | |
616 | =item on_refresh_end $term |
636 | =item on_refresh_end $term |
617 | |
637 | |
… | |
… | |
1104 | is that you cannot use blocking APIs, but the non-blocking variant should |
1124 | is that you cannot use blocking APIs, but the non-blocking variant should |
1105 | work. |
1125 | work. |
1106 | |
1126 | |
1107 | =cut |
1127 | =cut |
1108 | |
1128 | |
1109 | our $VERSION = 1; |
1129 | our $VERSION = '3.4'; |
1110 | |
1130 | |
1111 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1131 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1112 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1132 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1113 | |
1133 | |
1114 | sub timer { |
1134 | sub timer { |
… | |
… | |
1145 | |
1165 | |
1146 | sub DESTROY { |
1166 | sub DESTROY { |
1147 | $_[0][1]->stop; |
1167 | $_[0][1]->stop; |
1148 | } |
1168 | } |
1149 | |
1169 | |
1150 | sub condvar { |
|
|
1151 | bless \my $flag, urxvt::anyevent:: |
|
|
1152 | } |
|
|
1153 | |
|
|
1154 | sub broadcast { |
|
|
1155 | ${$_[0]}++; |
|
|
1156 | } |
|
|
1157 | |
|
|
1158 | sub wait { |
|
|
1159 | unless (${$_[0]}) { |
|
|
1160 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
|
|
1161 | } |
|
|
1162 | } |
|
|
1163 | |
|
|
1164 | sub one_event { |
1170 | sub one_event { |
1165 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1171 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1166 | } |
1172 | } |
1167 | |
1173 | |
1168 | package urxvt::term; |
1174 | package urxvt::term; |
… | |
… | |
1289 | Here is a likely non-exhaustive list of resource names, not all of which |
1295 | Here is a likely non-exhaustive list of resource names, not all of which |
1290 | are supported in every build, please see the source file F</src/rsinc.h> |
1296 | are supported in every build, please see the source file F</src/rsinc.h> |
1291 | to see the actual list: |
1297 | to see the actual list: |
1292 | |
1298 | |
1293 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1299 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1294 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1300 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1295 | display_name embed ext_bwidth fade font geometry hold iconName |
1301 | display_name embed ext_bwidth fade font geometry hold iconName |
1296 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1302 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1297 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1303 | italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 |
1298 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1304 | modifier mouseWheelScrollPage name override_redirect pastableTabs path |
1299 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1305 | perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1300 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1306 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1301 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1307 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1302 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1308 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1303 | secondaryScreen secondaryScroll selectstyle shade term_name title |
1309 | secondaryScreen secondaryScroll shade term_name title |
1304 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1310 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1305 | visualBell |
1311 | visualBell |
1306 | |
1312 | |
1307 | =cut |
1313 | =cut |
1308 | |
1314 | |
1309 | sub resource($$;$) { |
1315 | sub resource($$;$) { |
1310 | my ($self, $name) = (shift, shift); |
1316 | my ($self, $name) = (shift, shift); |
1311 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1317 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1312 | &urxvt::term::_resource |
1318 | goto &urxvt::term::_resource |
1313 | } |
1319 | } |
1314 | |
1320 | |
1315 | =item $value = $term->x_resource ($pattern) |
1321 | =item $value = $term->x_resource ($pattern) |
1316 | |
1322 | |
1317 | Returns the X-Resource for the given pattern, excluding the program or |
1323 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
1400 | |
1406 | |
1401 | The methods currently supported on C<urxvt::overlay> objects are: |
1407 | The methods currently supported on C<urxvt::overlay> objects are: |
1402 | |
1408 | |
1403 | =over 4 |
1409 | =over 4 |
1404 | |
1410 | |
1405 | =item $overlay->set ($x, $y, $text, $rend) |
1411 | =item $overlay->set ($x, $y, $text[, $rend]) |
1406 | |
1412 | |
1407 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1413 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1408 | text in rxvt-unicode's special encoding and an array of rendition values |
1414 | text in rxvt-unicode's special encoding and an array of rendition values |
1409 | at a specific position inside the overlay. |
1415 | at a specific position inside the overlay. |
|
|
1416 | |
|
|
1417 | If C<$rend> is missing, then the rendition will not be changed. |
1410 | |
1418 | |
1411 | =item $overlay->hide |
1419 | =item $overlay->hide |
1412 | |
1420 | |
1413 | If visible, hide the overlay, but do not destroy it. |
1421 | If visible, hide the overlay, but do not destroy it. |
1414 | |
1422 | |
… | |
… | |
1624 | |
1632 | |
1625 | Used after changing terminal contents to display them. |
1633 | Used after changing terminal contents to display them. |
1626 | |
1634 | |
1627 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1635 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1628 | |
1636 | |
1629 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1637 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1630 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1638 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1631 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1632 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1639 | terminal line. Nothing will be returned if a nonexistent line |
1633 | is requested. |
1640 | is requested. |
1634 | |
1641 | |
1635 | If C<$new_text> is specified, it will replace characters in the current |
1642 | If C<$new_text> is specified, it will replace characters in the current |
1636 | line, starting at column C<$start_col> (default C<0>), which is useful |
1643 | line, starting at column C<$start_col> (default C<0>), which is useful |
1637 | to replace only parts of a line. The font index in the rendition will |
1644 | to replace only parts of a line. The font index in the rendition will |
1638 | automatically be updated. |
1645 | automatically be updated. |
1639 | |
1646 | |
1640 | C<$text> is in a special encoding: tabs and wide characters that use more |
1647 | C<$text> is in a special encoding: tabs and wide characters that use more |
1641 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1648 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1642 | characters. Characters with combining characters and other characters that |
1649 | characters. Characters with combining characters and other characters that |
1643 | do not fit into the normal tetx encoding will be replaced with characters |
1650 | do not fit into the normal text encoding will be replaced with characters |
1644 | in the private use area. |
1651 | in the private use area. |
1645 | |
1652 | |
1646 | You have to obey this encoding when changing text. The advantage is |
1653 | You have to obey this encoding when changing text. The advantage is |
1647 | that C<substr> and similar functions work on screen cells and not on |
1654 | that C<substr> and similar functions work on screen cells and not on |
1648 | characters. |
1655 | characters. |
… | |
… | |
1835 | |
1842 | |
1836 | =item @atoms = $term->XListProperties ($window) |
1843 | =item @atoms = $term->XListProperties ($window) |
1837 | |
1844 | |
1838 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1845 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1839 | |
1846 | |
1840 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
1847 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
1841 | |
1848 | |
1842 | =item $term->XDeleteProperty ($window, $property) |
1849 | =item $term->XDeleteProperty ($window, $property) |
1843 | |
1850 | |
1844 | =item $window = $term->DefaultRootWindow |
1851 | =item $window = $term->DefaultRootWindow |
1845 | |
1852 | |
… | |
… | |
1967 | my $env = $self->{term}->env; |
1974 | my $env = $self->{term}->env; |
1968 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1975 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1969 | delete $env->{LC_ALL}; |
1976 | delete $env->{LC_ALL}; |
1970 | $env->{LC_CTYPE} = $self->{term}->locale; |
1977 | $env->{LC_CTYPE} = $self->{term}->locale; |
1971 | |
1978 | |
1972 | urxvt::term->new ($env, "popup", |
1979 | my $term = urxvt::term->new ( |
|
|
1980 | $env, "popup", |
1973 | "--perl-lib" => "", "--perl-ext-common" => "", |
1981 | "--perl-lib" => "", "--perl-ext-common" => "", |
1974 | "-pty-fd" => -1, "-sl" => 0, |
1982 | "-pty-fd" => -1, "-sl" => 0, |
1975 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1983 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1976 | "--transient-for" => $self->{term}->parent, |
1984 | "--transient-for" => $self->{term}->parent, |
1977 | "-display" => $self->{term}->display_id, |
1985 | "-display" => $self->{term}->display_id, |
1978 | "-pe" => "urxvt-popup") |
1986 | "-pe" => "urxvt-popup", |
1979 | or die "unable to create popup window\n"; |
1987 | ) or die "unable to create popup window\n"; |
|
|
1988 | |
|
|
1989 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
1990 | $term->ungrab; |
|
|
1991 | $term->destroy; |
|
|
1992 | die "unable to initialise popup window\n"; |
|
|
1993 | } |
1980 | } |
1994 | } |
1981 | |
1995 | |
1982 | sub DESTROY { |
1996 | sub DESTROY { |
1983 | my ($self) = @_; |
1997 | my ($self) = @_; |
1984 | |
1998 | |