… | |
… | |
94 | =item option-popup (enabled by default) |
94 | =item option-popup (enabled by default) |
95 | |
95 | |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
97 | runtime. |
97 | runtime. |
98 | |
98 | |
|
|
99 | Other extensions can extend this popup menu by pushing a code reference |
|
|
100 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
101 | popup is being displayed. |
|
|
102 | |
|
|
103 | It's sole argument is the popup menu, which can be modified. It should |
|
|
104 | either return nothing or a string, the initial boolean value and a code |
|
|
105 | reference. The string will be used as button text and the code reference |
|
|
106 | will be called when the toggle changes, with the new boolean value as |
|
|
107 | first argument. |
|
|
108 | |
|
|
109 | The following will add an entry C<myoption> that changes |
|
|
110 | C<$self->{myoption}>: |
|
|
111 | |
|
|
112 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
113 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
114 | }; |
|
|
115 | |
99 | =item selection-popup (enabled by default) |
116 | =item selection-popup (enabled by default) |
100 | |
117 | |
101 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
102 | text into various other formats/action (such as uri unescaping, perl |
119 | text into various other formats/action (such as uri unescaping, perl |
103 | evaluation, web-browser starting etc.), depending on content. |
120 | evaluation, web-browser starting etc.), depending on content. |
104 | |
121 | |
105 | Other extensions can extend this popup menu by pushing a code reference |
122 | Other extensions can extend this popup menu by pushing a code reference |
106 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
107 | popup is displayed. |
124 | popup is being displayed. |
108 | |
125 | |
109 | It's sole argument is the popup menu, which can be modified. The selection |
126 | It's sole argument is the popup menu, which can be modified. The selection |
110 | is in C<$_>, which can be used to decide wether to add something or not. |
127 | is in C<$_>, which can be used to decide wether to add something or not. |
111 | It should either return nothing or a string and a code reference. The |
128 | It should either return nothing or a string and a code reference. The |
112 | string will be used as button text and the code reference will be called |
129 | string will be used as button text and the code reference will be called |
… | |
… | |
136 | additionally stores the first match in the current line into the primary |
153 | additionally stores the first match in the current line into the primary |
137 | selection. |
154 | selection. |
138 | |
155 | |
139 | =item readline (enabled by default) |
156 | =item readline (enabled by default) |
140 | |
157 | |
141 | A support package that tries to make editing with readline easier. At the |
158 | A support package that tries to make editing with readline easier. At |
142 | moment, it reacts to clicking with the left mouse button by trying to |
159 | the moment, it reacts to clicking shift-left mouse button by trying to |
143 | move the text cursor to this position. It does so by generating as many |
160 | move the text cursor to this position. It does so by generating as many |
144 | cursor-left or cursor-right keypresses as required (the this only works |
161 | cursor-left or cursor-right keypresses as required (the this only works |
145 | for programs that correctly support wide characters). |
162 | for programs that correctly support wide characters). |
146 | |
163 | |
147 | To avoid too many false positives, this is only done when: |
164 | To avoid too many false positives, this is only done when: |
… | |
… | |
205 | |
222 | |
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
223 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
207 | B<Shift-Right> will switch to the tab left or right of the current one, |
224 | B<Shift-Right> will switch to the tab left or right of the current one, |
208 | while B<Shift-Down> creates a new tab. |
225 | while B<Shift-Down> creates a new tab. |
209 | |
226 | |
|
|
227 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
228 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
229 | following four resources (shown with defaults): |
|
|
230 | |
|
|
231 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
232 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
233 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
234 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
235 | |
|
|
236 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
237 | indices. |
|
|
238 | |
210 | =item mark-urls |
239 | =item mark-urls |
211 | |
240 | |
212 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
241 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
213 | make them clickable. When middle-clicked, the program specified in the |
242 | make them clickable. When middle-clicked, the program specified in the |
214 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
243 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
… | |
… | |
226 | |
255 | |
227 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
256 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
228 | |
257 | |
229 | =item automove-background |
258 | =item automove-background |
230 | |
259 | |
231 | This is basically a one-line extension that dynamically changes the background pixmap offset |
260 | This is basically a very small extension that dynamically changes the |
232 | to the window position, in effect creating the same effect as pseudo transparency with |
261 | background pixmap offset to the window position, in effect creating the |
233 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
262 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
263 | supported in this mode. Exmaple: |
234 | |
264 | |
235 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
265 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
236 | |
266 | |
237 | =item block-graphics-to-ascii |
267 | =item block-graphics-to-ascii |
238 | |
268 | |
… | |
… | |
339 | |
369 | |
340 | =back |
370 | =back |
341 | |
371 | |
342 | =head2 Extension Objects |
372 | =head2 Extension Objects |
343 | |
373 | |
344 | Very perl extension is a perl class. A separate perl object is created |
374 | Every perl extension is a perl class. A separate perl object is created |
345 | for each terminal and each extension and passed as the first parameter to |
375 | for each terminal and each extension and passed as the first parameter to |
346 | hooks. So extensions can use their C<$self> object without having to think |
376 | hooks. So extensions can use their C<$self> object without having to think |
347 | about other extensions, with the exception of methods and members that |
377 | about other extensions, with the exception of methods and members that |
348 | begin with an underscore character C<_>: these are reserved for internal |
378 | begin with an underscore character C<_>: these are reserved for internal |
349 | use. |
379 | use. |
… | |
… | |
464 | |
494 | |
465 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
495 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
466 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
496 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
467 | number of lines that will be in the scrollback buffer. |
497 | number of lines that will be in the scrollback buffer. |
468 | |
498 | |
|
|
499 | =item on_osc_seq $term, $op, $args |
|
|
500 | |
|
|
501 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
502 | behaviour. The default should be to return an empty list. A true value |
|
|
503 | suppresses execution of the request completely. Make sure you don't get |
|
|
504 | confused by recursive invocations when you output an osc sequence within |
|
|
505 | this callback. |
|
|
506 | |
|
|
507 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
508 | |
469 | =item on_osc_seq $term, $string |
509 | =item on_osc_seq_perl $term, $string |
470 | |
510 | |
471 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
511 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
472 | operating system command) is processed. Cursor position and other state |
512 | operating system command) is processed. Cursor position and other state |
473 | information is up-to-date when this happens. For interoperability, the |
513 | information is up-to-date when this happens. For interoperability, the |
474 | string should start with the extension name and a colon, to distinguish |
514 | string should start with the extension name and a colon, to distinguish |
… | |
… | |
523 | a C<perl:string> action bound to a key, see description of the B<keysym> |
563 | a C<perl:string> action bound to a key, see description of the B<keysym> |
524 | resource in the @@RXVT_NAME@@(1) manpage). |
564 | resource in the @@RXVT_NAME@@(1) manpage). |
525 | |
565 | |
526 | The event is simply the action string. This interface is assumed to change |
566 | The event is simply the action string. This interface is assumed to change |
527 | slightly in the future. |
567 | slightly in the future. |
|
|
568 | |
|
|
569 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
570 | |
|
|
571 | Called just after the new window size has been calculcated, but before |
|
|
572 | windows are actually being resized or hints are being set. If this hook |
|
|
573 | returns TRUE, setting of the window hints is being skipped. |
528 | |
574 | |
529 | =item on_x_event $term, $event |
575 | =item on_x_event $term, $event |
530 | |
576 | |
531 | Called on every X event received on the vt window (and possibly other |
577 | Called on every X event received on the vt window (and possibly other |
532 | windows). Should only be used as a last resort. Most event structure |
578 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
667 | Using this function has the advantage that its output ends up in the |
713 | Using this function has the advantage that its output ends up in the |
668 | correct place, e.g. on stderr of the connecting urxvtc client. |
714 | correct place, e.g. on stderr of the connecting urxvtc client. |
669 | |
715 | |
670 | Messages have a size limit of 1023 bytes currently. |
716 | Messages have a size limit of 1023 bytes currently. |
671 | |
717 | |
|
|
718 | =item @terms = urxvt::termlist |
|
|
719 | |
|
|
720 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
721 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
722 | objects that have perl extensions attached will be returned (because there |
|
|
723 | is no urxvt::term objet associated with others). |
|
|
724 | |
672 | =item $time = urxvt::NOW |
725 | =item $time = urxvt::NOW |
673 | |
726 | |
674 | Returns the "current time" (as per the event loop). |
727 | Returns the "current time" (as per the event loop). |
675 | |
728 | |
676 | =item urxvt::CurrentTime |
729 | =item urxvt::CurrentTime |
… | |
… | |
733 | Return the foreground/background colour index, respectively. |
786 | Return the foreground/background colour index, respectively. |
734 | |
787 | |
735 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
788 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
736 | |
789 | |
737 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
790 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
791 | |
|
|
792 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
738 | |
793 | |
739 | Replace the foreground/background colour in the rendition mask with the |
794 | Replace the foreground/background colour in the rendition mask with the |
740 | specified one. |
795 | specified one. |
741 | |
796 | |
742 | =item $value = urxvt::GET_CUSTOM $rend |
797 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
833 | } else { |
888 | } else { |
834 | $ext_arg{$_} ||= []; |
889 | $ext_arg{$_} ||= []; |
835 | } |
890 | } |
836 | } |
891 | } |
837 | |
892 | |
838 | while (my ($ext, $argv) = each %ext_arg) { |
893 | for my $ext (sort keys %ext_arg) { |
839 | my @files = grep -f $_, map "$_/$ext", @dirs; |
894 | my @files = grep -f $_, map "$_/$ext", @dirs; |
840 | |
895 | |
841 | if (@files) { |
896 | if (@files) { |
842 | $TERM->register_package (extension_package $files[0], $argv); |
897 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
843 | } else { |
898 | } else { |
844 | warn "perl extension '$ext' not found in perl library search path\n"; |
899 | warn "perl extension '$ext' not found in perl library search path\n"; |
845 | } |
900 | } |
846 | } |
901 | } |
847 | |
902 | |
… | |
… | |
853 | |
908 | |
854 | if (my $cb = $TERM->{_hook}[$htype]) { |
909 | if (my $cb = $TERM->{_hook}[$htype]) { |
855 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
910 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
856 | if $verbosity >= 10; |
911 | if $verbosity >= 10; |
857 | |
912 | |
858 | keys %$cb; |
913 | for my $pkg (keys %$cb) { |
859 | |
|
|
860 | while (my ($pkg, $cb) = each %$cb) { |
|
|
861 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
914 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
862 | $retval ||= $retval_; |
915 | $retval ||= $retval_; |
863 | |
916 | |
864 | if ($@) { |
917 | if ($@) { |
865 | $TERM->ungrab; # better to lose the grab than the session |
918 | $TERM->ungrab; # better to lose the grab than the session |
866 | warn $@; |
919 | warn $@; |
… | |
… | |
878 | # clear package |
931 | # clear package |
879 | %$TERM = (); |
932 | %$TERM = (); |
880 | } |
933 | } |
881 | |
934 | |
882 | $retval |
935 | $retval |
|
|
936 | } |
|
|
937 | |
|
|
938 | sub SET_COLOR($$$) { |
|
|
939 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
883 | } |
940 | } |
884 | |
941 | |
885 | # urxvt::term::extension |
942 | # urxvt::term::extension |
886 | |
943 | |
887 | package urxvt::term::extension; |
944 | package urxvt::term::extension; |
… | |
… | |
1056 | hash which defines the environment of the new terminal. |
1113 | hash which defines the environment of the new terminal. |
1057 | |
1114 | |
1058 | Croaks (and probably outputs an error message) if the new instance |
1115 | Croaks (and probably outputs an error message) if the new instance |
1059 | couldn't be created. Returns C<undef> if the new instance didn't |
1116 | couldn't be created. Returns C<undef> if the new instance didn't |
1060 | initialise perl, and the terminal object otherwise. The C<init> and |
1117 | initialise perl, and the terminal object otherwise. The C<init> and |
1061 | C<start> hooks will be called during this call. |
1118 | C<start> hooks will be called before this call returns, and are free to |
|
|
1119 | refer to global data (which is race free). |
1062 | |
1120 | |
1063 | =cut |
1121 | =cut |
1064 | |
1122 | |
1065 | sub new { |
1123 | sub new { |
1066 | my ($class, $env, @args) = @_; |
1124 | my ($class, $env, @args) = @_; |
1067 | |
1125 | |
|
|
1126 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1127 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1128 | |
1068 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1129 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1069 | } |
1130 | } |
1070 | |
1131 | |
1071 | =item $term->destroy |
1132 | =item $term->destroy |
1072 | |
1133 | |
1073 | Destroy the terminal object (close the window, free resources |
1134 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1373 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1434 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1374 | to receive pointer events all the times: |
1435 | to receive pointer events all the times: |
1375 | |
1436 | |
1376 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1437 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1377 | |
1438 | |
|
|
1439 | =item $term->focus_in |
|
|
1440 | |
|
|
1441 | =item $term->focus_out |
|
|
1442 | |
|
|
1443 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1444 | |
|
|
1445 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1446 | |
|
|
1447 | Deliver various fake events to to terminal. |
|
|
1448 | |
1378 | =item $window_width = $term->width |
1449 | =item $window_width = $term->width |
1379 | |
1450 | |
1380 | =item $window_height = $term->height |
1451 | =item $window_height = $term->height |
1381 | |
1452 | |
1382 | =item $font_width = $term->fwidth |
1453 | =item $font_width = $term->fwidth |
… | |
… | |
1412 | =item $env = $term->env |
1483 | =item $env = $term->env |
1413 | |
1484 | |
1414 | Returns a copy of the environment in effect for the terminal as a hashref |
1485 | Returns a copy of the environment in effect for the terminal as a hashref |
1415 | similar to C<\%ENV>. |
1486 | similar to C<\%ENV>. |
1416 | |
1487 | |
|
|
1488 | =item @envv = $term->envv |
|
|
1489 | |
|
|
1490 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1491 | |
|
|
1492 | =item @argv = $term->argv |
|
|
1493 | |
|
|
1494 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1495 | includes the program name as first element. |
|
|
1496 | |
1417 | =cut |
1497 | =cut |
1418 | |
1498 | |
1419 | sub env { |
1499 | sub env { |
1420 | if (my $env = $_[0]->_env) { |
|
|
1421 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1500 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1422 | } else { |
|
|
1423 | +{ %ENV } |
|
|
1424 | } |
|
|
1425 | } |
1501 | } |
1426 | |
1502 | |
1427 | =item $modifiermask = $term->ModLevel3Mask |
1503 | =item $modifiermask = $term->ModLevel3Mask |
1428 | |
1504 | |
1429 | =item $modifiermask = $term->ModMetaMask |
1505 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1627 | =item $string = $term->special_decode $text |
1703 | =item $string = $term->special_decode $text |
1628 | |
1704 | |
1629 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1705 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1630 | C<< $term->ROW_t >> for details. |
1706 | C<< $term->ROW_t >> for details. |
1631 | |
1707 | |
1632 | =item $success = $term->grab_button ($button, $modifiermask) |
1708 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1633 | |
1709 | |
|
|
1710 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1711 | |
1634 | Registers a synchronous button grab. See the XGrabButton manpage. |
1712 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1713 | manpage. |
1635 | |
1714 | |
1636 | =item $success = $term->grab ($eventtime[, $sync]) |
1715 | =item $success = $term->grab ($eventtime[, $sync]) |
1637 | |
1716 | |
1638 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1717 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1639 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1718 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
… | |
… | |
1757 | my ($self, $text, $cb) = @_; |
1836 | my ($self, $text, $cb) = @_; |
1758 | |
1837 | |
1759 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1838 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1760 | } |
1839 | } |
1761 | |
1840 | |
1762 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1841 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1763 | |
1842 | |
1764 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1843 | Adds a toggle/checkbox item to the popup. The callback gets called |
1765 | whenever it gets toggled, with a boolean indicating its value as its first |
1844 | whenever it gets toggled, with a boolean indicating its new value as its |
1766 | argument. |
1845 | first argument. |
1767 | |
1846 | |
1768 | =cut |
1847 | =cut |
1769 | |
1848 | |
1770 | sub add_toggle { |
1849 | sub add_toggle { |
1771 | my ($self, $text, $cb, $value) = @_; |
1850 | my ($self, $text, $value, $cb) = @_; |
1772 | |
1851 | |
1773 | my $item; $item = { |
1852 | my $item; $item = { |
1774 | type => "button", |
1853 | type => "button", |
1775 | text => " $text", |
1854 | text => " $text", |
1776 | value => $value, |
1855 | value => $value, |