… | |
… | |
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 |
… | |
… | |
242 | |
271 | |
243 | =item digital-clock |
272 | =item digital-clock |
244 | |
273 | |
245 | Displays a digital clock using the built-in overlay. |
274 | Displays a digital clock using the built-in overlay. |
246 | |
275 | |
247 | =item example-refresh-hooks |
276 | =item remote-clipboard |
248 | |
277 | |
249 | Displays a very simple digital clock in the upper right corner of the |
278 | Somewhat of a misnomer, this extension adds two menu entries to the |
250 | window. Illustrates overwriting the refresh callbacks to create your own |
279 | selection popup that allows one ti run external commands to store the |
251 | overlays or changes. |
280 | selection somewhere and fetch it again. |
|
|
281 | |
|
|
282 | We use it to implement a "distributed selection mechanism", which just |
|
|
283 | means that one command uploads the file to a remote server, and another |
|
|
284 | reads it. |
|
|
285 | |
|
|
286 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
287 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
288 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
289 | the selection data on STDOUT (also in UTF-8). |
|
|
290 | |
|
|
291 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
292 | |
|
|
293 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
294 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
252 | |
295 | |
253 | =item selection-pastebin |
296 | =item selection-pastebin |
254 | |
297 | |
255 | This is a little rarely useful extension that Uploads the selection as |
298 | This is a little rarely useful extension that Uploads the selection as |
256 | textfile to a remote site (or does other things). (The implementation is |
299 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
276 | After a successful upload the selection will be replaced by the text given |
319 | After a successful upload the selection will be replaced by the text given |
277 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
320 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
278 | for the filename): |
321 | for the filename): |
279 | |
322 | |
280 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
323 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
324 | |
|
|
325 | =item example-refresh-hooks |
|
|
326 | |
|
|
327 | Displays a very simple digital clock in the upper right corner of the |
|
|
328 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
329 | overlays or changes. |
281 | |
330 | |
282 | =back |
331 | =back |
283 | |
332 | |
284 | =head1 API DOCUMENTATION |
333 | =head1 API DOCUMENTATION |
285 | |
334 | |
… | |
… | |
444 | |
493 | |
445 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
494 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
446 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
495 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
447 | number of lines that will be in the scrollback buffer. |
496 | number of lines that will be in the scrollback buffer. |
448 | |
497 | |
|
|
498 | =item on_osc_seq $term, $op, $args |
|
|
499 | |
|
|
500 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
501 | behaviour. The default should be to return an empty list. A true value |
|
|
502 | suppresses execution of the request completely. Make sure you don't get |
|
|
503 | confused by recursive invocations when you output an osc sequence within |
|
|
504 | this callback. |
|
|
505 | |
|
|
506 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
507 | |
449 | =item on_osc_seq $term, $string |
508 | =item on_osc_seq_perl $term, $string |
450 | |
509 | |
451 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
510 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
452 | operating system command) is processed. Cursor position and other state |
511 | operating system command) is processed. Cursor position and other state |
453 | information is up-to-date when this happens. For interoperability, the |
512 | information is up-to-date when this happens. For interoperability, the |
454 | string should start with the extension name and a colon, to distinguish |
513 | string should start with the extension name and a colon, to distinguish |
… | |
… | |
495 | |
554 | |
496 | =item on_refresh_end $term |
555 | =item on_refresh_end $term |
497 | |
556 | |
498 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
557 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
499 | |
558 | |
500 | =item on_keyboard_command $term, $string |
559 | =item on_user_command $term, $string |
501 | |
560 | |
502 | Called whenever the user presses a key combination that has a |
561 | Called whenever the a user-configured event is being activated (e.g. via |
503 | C<perl:string> action bound to it (see description of the B<keysym> |
562 | a C<perl:string> action bound to a key, see description of the B<keysym> |
504 | resource in the @@RXVT_NAME@@(1) manpage). |
563 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
564 | |
|
|
565 | The event is simply the action string. This interface is assumed to change |
|
|
566 | slightly in the future. |
|
|
567 | |
|
|
568 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
569 | |
|
|
570 | Called just after the new window size has been calculcated, but before |
|
|
571 | windows are actually being resized or hints are being set. If this hook |
|
|
572 | returns TRUE, setting of the window hints is being skipped. |
505 | |
573 | |
506 | =item on_x_event $term, $event |
574 | =item on_x_event $term, $event |
507 | |
575 | |
508 | Called on every X event received on the vt window (and possibly other |
576 | Called on every X event received on the vt window (and possibly other |
509 | windows). Should only be used as a last resort. Most event structure |
577 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
644 | Using this function has the advantage that its output ends up in the |
712 | Using this function has the advantage that its output ends up in the |
645 | correct place, e.g. on stderr of the connecting urxvtc client. |
713 | correct place, e.g. on stderr of the connecting urxvtc client. |
646 | |
714 | |
647 | Messages have a size limit of 1023 bytes currently. |
715 | Messages have a size limit of 1023 bytes currently. |
648 | |
716 | |
|
|
717 | =item @terms = urxvt::termlist |
|
|
718 | |
|
|
719 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
720 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
721 | objects that have perl extensions attached will be returned (because there |
|
|
722 | is no urxvt::term objet associated with others). |
|
|
723 | |
649 | =item $time = urxvt::NOW |
724 | =item $time = urxvt::NOW |
650 | |
725 | |
651 | Returns the "current time" (as per the event loop). |
726 | Returns the "current time" (as per the event loop). |
652 | |
727 | |
653 | =item urxvt::CurrentTime |
728 | =item urxvt::CurrentTime |
… | |
… | |
710 | Return the foreground/background colour index, respectively. |
785 | Return the foreground/background colour index, respectively. |
711 | |
786 | |
712 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
787 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
713 | |
788 | |
714 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
789 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
790 | |
|
|
791 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
715 | |
792 | |
716 | Replace the foreground/background colour in the rendition mask with the |
793 | Replace the foreground/background colour in the rendition mask with the |
717 | specified one. |
794 | specified one. |
718 | |
795 | |
719 | =item $value = urxvt::GET_CUSTOM $rend |
796 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
810 | } else { |
887 | } else { |
811 | $ext_arg{$_} ||= []; |
888 | $ext_arg{$_} ||= []; |
812 | } |
889 | } |
813 | } |
890 | } |
814 | |
891 | |
815 | while (my ($ext, $argv) = each %ext_arg) { |
892 | for my $ext (sort keys %ext_arg) { |
816 | my @files = grep -f $_, map "$_/$ext", @dirs; |
893 | my @files = grep -f $_, map "$_/$ext", @dirs; |
817 | |
894 | |
818 | if (@files) { |
895 | if (@files) { |
819 | $TERM->register_package (extension_package $files[0], $argv); |
896 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
820 | } else { |
897 | } else { |
821 | warn "perl extension '$ext' not found in perl library search path\n"; |
898 | warn "perl extension '$ext' not found in perl library search path\n"; |
822 | } |
899 | } |
823 | } |
900 | } |
824 | |
901 | |
… | |
… | |
855 | # clear package |
932 | # clear package |
856 | %$TERM = (); |
933 | %$TERM = (); |
857 | } |
934 | } |
858 | |
935 | |
859 | $retval |
936 | $retval |
|
|
937 | } |
|
|
938 | |
|
|
939 | sub SET_COLOR($$$) { |
|
|
940 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
860 | } |
941 | } |
861 | |
942 | |
862 | # urxvt::term::extension |
943 | # urxvt::term::extension |
863 | |
944 | |
864 | package urxvt::term::extension; |
945 | package urxvt::term::extension; |
… | |
… | |
1033 | hash which defines the environment of the new terminal. |
1114 | hash which defines the environment of the new terminal. |
1034 | |
1115 | |
1035 | Croaks (and probably outputs an error message) if the new instance |
1116 | Croaks (and probably outputs an error message) if the new instance |
1036 | couldn't be created. Returns C<undef> if the new instance didn't |
1117 | couldn't be created. Returns C<undef> if the new instance didn't |
1037 | initialise perl, and the terminal object otherwise. The C<init> and |
1118 | initialise perl, and the terminal object otherwise. The C<init> and |
1038 | C<start> hooks will be called during this call. |
1119 | C<start> hooks will be called before this call returns, and are free to |
|
|
1120 | refer to global data (which is race free). |
1039 | |
1121 | |
1040 | =cut |
1122 | =cut |
1041 | |
1123 | |
1042 | sub new { |
1124 | sub new { |
1043 | my ($class, $env, @args) = @_; |
1125 | my ($class, $env, @args) = @_; |
1044 | |
1126 | |
|
|
1127 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1128 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1129 | |
1045 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1130 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1046 | } |
1131 | } |
1047 | |
1132 | |
1048 | =item $term->destroy |
1133 | =item $term->destroy |
1049 | |
1134 | |
1050 | Destroy the terminal object (close the window, free resources |
1135 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1350 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1435 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1351 | to receive pointer events all the times: |
1436 | to receive pointer events all the times: |
1352 | |
1437 | |
1353 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1438 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1354 | |
1439 | |
|
|
1440 | =item $term->focus_in |
|
|
1441 | |
|
|
1442 | =item $term->focus_out |
|
|
1443 | |
|
|
1444 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1445 | |
|
|
1446 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1447 | |
|
|
1448 | Deliver various fake events to to terminal. |
|
|
1449 | |
1355 | =item $window_width = $term->width |
1450 | =item $window_width = $term->width |
1356 | |
1451 | |
1357 | =item $window_height = $term->height |
1452 | =item $window_height = $term->height |
1358 | |
1453 | |
1359 | =item $font_width = $term->fwidth |
1454 | =item $font_width = $term->fwidth |
… | |
… | |
1389 | =item $env = $term->env |
1484 | =item $env = $term->env |
1390 | |
1485 | |
1391 | Returns a copy of the environment in effect for the terminal as a hashref |
1486 | Returns a copy of the environment in effect for the terminal as a hashref |
1392 | similar to C<\%ENV>. |
1487 | similar to C<\%ENV>. |
1393 | |
1488 | |
|
|
1489 | =item @envv = $term->envv |
|
|
1490 | |
|
|
1491 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1492 | |
|
|
1493 | =item @argv = $term->argv |
|
|
1494 | |
|
|
1495 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1496 | includes the program name as first element. |
|
|
1497 | |
1394 | =cut |
1498 | =cut |
1395 | |
1499 | |
1396 | sub env { |
1500 | sub env { |
1397 | if (my $env = $_[0]->_env) { |
|
|
1398 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1501 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1399 | } else { |
|
|
1400 | +{ %ENV } |
|
|
1401 | } |
|
|
1402 | } |
1502 | } |
1403 | |
1503 | |
1404 | =item $modifiermask = $term->ModLevel3Mask |
1504 | =item $modifiermask = $term->ModLevel3Mask |
1405 | |
1505 | |
1406 | =item $modifiermask = $term->ModMetaMask |
1506 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1604 | =item $string = $term->special_decode $text |
1704 | =item $string = $term->special_decode $text |
1605 | |
1705 | |
1606 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1706 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1607 | C<< $term->ROW_t >> for details. |
1707 | C<< $term->ROW_t >> for details. |
1608 | |
1708 | |
1609 | =item $success = $term->grab_button ($button, $modifiermask) |
1709 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1610 | |
1710 | |
|
|
1711 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1712 | |
1611 | Registers a synchronous button grab. See the XGrabButton manpage. |
1713 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1714 | manpage. |
1612 | |
1715 | |
1613 | =item $success = $term->grab ($eventtime[, $sync]) |
1716 | =item $success = $term->grab ($eventtime[, $sync]) |
1614 | |
1717 | |
1615 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1718 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1616 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1719 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
… | |
… | |
1734 | my ($self, $text, $cb) = @_; |
1837 | my ($self, $text, $cb) = @_; |
1735 | |
1838 | |
1736 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1839 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1737 | } |
1840 | } |
1738 | |
1841 | |
1739 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1842 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1740 | |
1843 | |
1741 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1844 | Adds a toggle/checkbox item to the popup. The callback gets called |
1742 | whenever it gets toggled, with a boolean indicating its value as its first |
1845 | whenever it gets toggled, with a boolean indicating its new value as its |
1743 | argument. |
1846 | first argument. |
1744 | |
1847 | |
1745 | =cut |
1848 | =cut |
1746 | |
1849 | |
1747 | sub add_toggle { |
1850 | sub add_toggle { |
1748 | my ($self, $text, $cb, $value) = @_; |
1851 | my ($self, $text, $value, $cb) = @_; |
1749 | |
1852 | |
1750 | my $item; $item = { |
1853 | my $item; $item = { |
1751 | type => "button", |
1854 | type => "button", |
1752 | text => " $text", |
1855 | text => " $text", |
1753 | value => $value, |
1856 | value => $value, |