… | |
… | |
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 |
… | |
… | |
134 | bottom. C<Escape> leaves search mode and returns to the point where search |
151 | bottom. C<Escape> leaves search mode and returns to the point where search |
135 | was started, while C<Enter> or C<Return> stay at the current position and |
152 | was started, while C<Enter> or C<Return> stay at the current position and |
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 | |
|
|
156 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
|
|
157 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
|
|
158 | or simply use an uppercase character which removes the "(?i)" prefix. |
|
|
159 | |
|
|
160 | See L<perlre> for more info about perl regular expression syntax. |
|
|
161 | |
139 | =item readline (enabled by default) |
162 | =item readline (enabled by default) |
140 | |
163 | |
141 | A support package that tries to make editing with readline easier. At the |
164 | 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 |
165 | 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 |
166 | 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 |
167 | cursor-left or cursor-right keypresses as required (the this only works |
145 | for programs that correctly support wide characters). |
168 | for programs that correctly support wide characters). |
146 | |
169 | |
147 | To avoid too many false positives, this is only done when: |
170 | To avoid too many false positives, this is only done when: |
… | |
… | |
205 | |
228 | |
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
229 | 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, |
230 | B<Shift-Right> will switch to the tab left or right of the current one, |
208 | while B<Shift-Down> creates a new tab. |
231 | while B<Shift-Down> creates a new tab. |
209 | |
232 | |
|
|
233 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
234 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
235 | following four resources (shown with defaults): |
|
|
236 | |
|
|
237 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
238 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
239 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
240 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
241 | |
|
|
242 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
243 | indices. |
|
|
244 | |
210 | =item mark-urls |
245 | =item mark-urls |
211 | |
246 | |
212 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
247 | 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 |
248 | make them clickable. When middle-clicked, the program specified in the |
214 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
249 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
… | |
… | |
226 | |
261 | |
227 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
262 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
228 | |
263 | |
229 | =item automove-background |
264 | =item automove-background |
230 | |
265 | |
231 | This is basically a one-line extension that dynamically changes the background pixmap offset |
266 | 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 |
267 | background pixmap offset to the window position, in effect creating the |
233 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
268 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
269 | supported in this mode. Exmaple: |
234 | |
270 | |
235 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
271 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
236 | |
272 | |
237 | =item block-graphics-to-ascii |
273 | =item block-graphics-to-ascii |
238 | |
274 | |
239 | A not very useful example of filtering all text output to the terminal, |
275 | A not very useful example of filtering all text output to the terminal |
240 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
276 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
241 | similar-looking ascii character. |
277 | similar-looking ascii character. |
242 | |
278 | |
243 | =item digital-clock |
279 | =item digital-clock |
244 | |
280 | |
245 | Displays a digital clock using the built-in overlay. |
281 | Displays a digital clock using the built-in overlay. |
246 | |
282 | |
247 | =item remote-selection |
283 | =item remote-clipboard |
248 | |
284 | |
249 | Somewhat of a misnomer, this extension adds two menu entries to the |
285 | Somewhat of a misnomer, this extension adds two menu entries to the |
250 | selection popup that allows one ti run external commands to store the |
286 | selection popup that allows one ti run external commands to store the |
251 | selection somewhere and fetch it again. |
287 | selection somewhere and fetch it again. |
252 | |
288 | |
… | |
… | |
339 | |
375 | |
340 | =back |
376 | =back |
341 | |
377 | |
342 | =head2 Extension Objects |
378 | =head2 Extension Objects |
343 | |
379 | |
344 | Very perl extension is a perl class. A separate perl object is created |
380 | 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 |
381 | 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 |
382 | 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 |
383 | about other extensions, with the exception of methods and members that |
348 | begin with an underscore character C<_>: these are reserved for internal |
384 | begin with an underscore character C<_>: these are reserved for internal |
349 | use. |
385 | use. |
… | |
… | |
464 | |
500 | |
465 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
501 | 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 |
502 | $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. |
503 | number of lines that will be in the scrollback buffer. |
468 | |
504 | |
|
|
505 | =item on_osc_seq $term, $op, $args |
|
|
506 | |
|
|
507 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
508 | behaviour. The default should be to return an empty list. A true value |
|
|
509 | suppresses execution of the request completely. Make sure you don't get |
|
|
510 | confused by recursive invocations when you output an osc sequence within |
|
|
511 | this callback. |
|
|
512 | |
|
|
513 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
514 | |
469 | =item on_osc_seq $term, $string |
515 | =item on_osc_seq_perl $term, $string |
470 | |
516 | |
471 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
517 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
472 | operating system command) is processed. Cursor position and other state |
518 | operating system command) is processed. Cursor position and other state |
473 | information is up-to-date when this happens. For interoperability, the |
519 | information is up-to-date when this happens. For interoperability, the |
474 | string should start with the extension name and a colon, to distinguish |
520 | string should start with the extension name and a colon, to distinguish |
… | |
… | |
515 | |
561 | |
516 | =item on_refresh_end $term |
562 | =item on_refresh_end $term |
517 | |
563 | |
518 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
564 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
519 | |
565 | |
520 | =item on_keyboard_command $term, $string |
566 | =item on_user_command $term, $string |
521 | |
567 | |
522 | Called whenever the user presses a key combination that has a |
568 | Called whenever the a user-configured event is being activated (e.g. via |
523 | C<perl:string> action bound to it (see description of the B<keysym> |
569 | a C<perl:string> action bound to a key, see description of the B<keysym> |
524 | resource in the @@RXVT_NAME@@(1) manpage). |
570 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
571 | |
|
|
572 | The event is simply the action string. This interface is assumed to change |
|
|
573 | slightly in the future. |
|
|
574 | |
|
|
575 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
576 | |
|
|
577 | Called just after the new window size has been calculcated, but before |
|
|
578 | windows are actually being resized or hints are being set. If this hook |
|
|
579 | returns TRUE, setting of the window hints is being skipped. |
525 | |
580 | |
526 | =item on_x_event $term, $event |
581 | =item on_x_event $term, $event |
527 | |
582 | |
528 | Called on every X event received on the vt window (and possibly other |
583 | Called on every X event received on the vt window (and possibly other |
529 | windows). Should only be used as a last resort. Most event structure |
584 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
664 | Using this function has the advantage that its output ends up in the |
719 | Using this function has the advantage that its output ends up in the |
665 | correct place, e.g. on stderr of the connecting urxvtc client. |
720 | correct place, e.g. on stderr of the connecting urxvtc client. |
666 | |
721 | |
667 | Messages have a size limit of 1023 bytes currently. |
722 | Messages have a size limit of 1023 bytes currently. |
668 | |
723 | |
|
|
724 | =item @terms = urxvt::termlist |
|
|
725 | |
|
|
726 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
727 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
728 | objects that have perl extensions attached will be returned (because there |
|
|
729 | is no urxvt::term objet associated with others). |
|
|
730 | |
669 | =item $time = urxvt::NOW |
731 | =item $time = urxvt::NOW |
670 | |
732 | |
671 | Returns the "current time" (as per the event loop). |
733 | Returns the "current time" (as per the event loop). |
672 | |
734 | |
673 | =item urxvt::CurrentTime |
735 | =item urxvt::CurrentTime |
… | |
… | |
730 | Return the foreground/background colour index, respectively. |
792 | Return the foreground/background colour index, respectively. |
731 | |
793 | |
732 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
794 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
733 | |
795 | |
734 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
796 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
797 | |
|
|
798 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
735 | |
799 | |
736 | Replace the foreground/background colour in the rendition mask with the |
800 | Replace the foreground/background colour in the rendition mask with the |
737 | specified one. |
801 | specified one. |
738 | |
802 | |
739 | =item $value = urxvt::GET_CUSTOM $rend |
803 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
830 | } else { |
894 | } else { |
831 | $ext_arg{$_} ||= []; |
895 | $ext_arg{$_} ||= []; |
832 | } |
896 | } |
833 | } |
897 | } |
834 | |
898 | |
835 | while (my ($ext, $argv) = each %ext_arg) { |
899 | for my $ext (sort keys %ext_arg) { |
836 | my @files = grep -f $_, map "$_/$ext", @dirs; |
900 | my @files = grep -f $_, map "$_/$ext", @dirs; |
837 | |
901 | |
838 | if (@files) { |
902 | if (@files) { |
839 | $TERM->register_package (extension_package $files[0], $argv); |
903 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
840 | } else { |
904 | } else { |
841 | warn "perl extension '$ext' not found in perl library search path\n"; |
905 | warn "perl extension '$ext' not found in perl library search path\n"; |
842 | } |
906 | } |
843 | } |
907 | } |
844 | |
908 | |
… | |
… | |
850 | |
914 | |
851 | if (my $cb = $TERM->{_hook}[$htype]) { |
915 | if (my $cb = $TERM->{_hook}[$htype]) { |
852 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
916 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
853 | if $verbosity >= 10; |
917 | if $verbosity >= 10; |
854 | |
918 | |
855 | keys %$cb; |
919 | for my $pkg (keys %$cb) { |
856 | |
|
|
857 | while (my ($pkg, $cb) = each %$cb) { |
|
|
858 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
920 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
859 | $retval ||= $retval_; |
921 | $retval ||= $retval_; |
860 | |
922 | |
861 | if ($@) { |
923 | if ($@) { |
862 | $TERM->ungrab; # better to lose the grab than the session |
924 | $TERM->ungrab; # better to lose the grab than the session |
863 | warn $@; |
925 | warn $@; |
… | |
… | |
875 | # clear package |
937 | # clear package |
876 | %$TERM = (); |
938 | %$TERM = (); |
877 | } |
939 | } |
878 | |
940 | |
879 | $retval |
941 | $retval |
|
|
942 | } |
|
|
943 | |
|
|
944 | sub SET_COLOR($$$) { |
|
|
945 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
880 | } |
946 | } |
881 | |
947 | |
882 | # urxvt::term::extension |
948 | # urxvt::term::extension |
883 | |
949 | |
884 | package urxvt::term::extension; |
950 | package urxvt::term::extension; |
… | |
… | |
1053 | hash which defines the environment of the new terminal. |
1119 | hash which defines the environment of the new terminal. |
1054 | |
1120 | |
1055 | Croaks (and probably outputs an error message) if the new instance |
1121 | Croaks (and probably outputs an error message) if the new instance |
1056 | couldn't be created. Returns C<undef> if the new instance didn't |
1122 | couldn't be created. Returns C<undef> if the new instance didn't |
1057 | initialise perl, and the terminal object otherwise. The C<init> and |
1123 | initialise perl, and the terminal object otherwise. The C<init> and |
1058 | C<start> hooks will be called during this call. |
1124 | C<start> hooks will be called before this call returns, and are free to |
|
|
1125 | refer to global data (which is race free). |
1059 | |
1126 | |
1060 | =cut |
1127 | =cut |
1061 | |
1128 | |
1062 | sub new { |
1129 | sub new { |
1063 | my ($class, $env, @args) = @_; |
1130 | my ($class, $env, @args) = @_; |
1064 | |
1131 | |
|
|
1132 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1133 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1134 | |
1065 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1135 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1066 | } |
1136 | } |
1067 | |
1137 | |
1068 | =item $term->destroy |
1138 | =item $term->destroy |
1069 | |
1139 | |
1070 | Destroy the terminal object (close the window, free resources |
1140 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1370 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1440 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1371 | to receive pointer events all the times: |
1441 | to receive pointer events all the times: |
1372 | |
1442 | |
1373 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1443 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1374 | |
1444 | |
|
|
1445 | =item $term->focus_in |
|
|
1446 | |
|
|
1447 | =item $term->focus_out |
|
|
1448 | |
|
|
1449 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1450 | |
|
|
1451 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1452 | |
|
|
1453 | Deliver various fake events to to terminal. |
|
|
1454 | |
1375 | =item $window_width = $term->width |
1455 | =item $window_width = $term->width |
1376 | |
1456 | |
1377 | =item $window_height = $term->height |
1457 | =item $window_height = $term->height |
1378 | |
1458 | |
1379 | =item $font_width = $term->fwidth |
1459 | =item $font_width = $term->fwidth |
… | |
… | |
1409 | =item $env = $term->env |
1489 | =item $env = $term->env |
1410 | |
1490 | |
1411 | Returns a copy of the environment in effect for the terminal as a hashref |
1491 | Returns a copy of the environment in effect for the terminal as a hashref |
1412 | similar to C<\%ENV>. |
1492 | similar to C<\%ENV>. |
1413 | |
1493 | |
|
|
1494 | =item @envv = $term->envv |
|
|
1495 | |
|
|
1496 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1497 | |
|
|
1498 | =item @argv = $term->argv |
|
|
1499 | |
|
|
1500 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1501 | includes the program name as first element. |
|
|
1502 | |
1414 | =cut |
1503 | =cut |
1415 | |
1504 | |
1416 | sub env { |
1505 | sub env { |
1417 | if (my $env = $_[0]->_env) { |
|
|
1418 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1506 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1419 | } else { |
|
|
1420 | +{ %ENV } |
|
|
1421 | } |
|
|
1422 | } |
1507 | } |
1423 | |
1508 | |
1424 | =item $modifiermask = $term->ModLevel3Mask |
1509 | =item $modifiermask = $term->ModLevel3Mask |
1425 | |
1510 | |
1426 | =item $modifiermask = $term->ModMetaMask |
1511 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1624 | =item $string = $term->special_decode $text |
1709 | =item $string = $term->special_decode $text |
1625 | |
1710 | |
1626 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1711 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1627 | C<< $term->ROW_t >> for details. |
1712 | C<< $term->ROW_t >> for details. |
1628 | |
1713 | |
1629 | =item $success = $term->grab_button ($button, $modifiermask) |
1714 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1630 | |
1715 | |
|
|
1716 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1717 | |
1631 | Registers a synchronous button grab. See the XGrabButton manpage. |
1718 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1719 | manpage. |
1632 | |
1720 | |
1633 | =item $success = $term->grab ($eventtime[, $sync]) |
1721 | =item $success = $term->grab ($eventtime[, $sync]) |
1634 | |
1722 | |
1635 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1723 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1636 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1724 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
… | |
… | |
1754 | my ($self, $text, $cb) = @_; |
1842 | my ($self, $text, $cb) = @_; |
1755 | |
1843 | |
1756 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1844 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1757 | } |
1845 | } |
1758 | |
1846 | |
1759 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1847 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1760 | |
1848 | |
1761 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1849 | Adds a toggle/checkbox item to the popup. The callback gets called |
1762 | whenever it gets toggled, with a boolean indicating its value as its first |
1850 | whenever it gets toggled, with a boolean indicating its new value as its |
1763 | argument. |
1851 | first argument. |
1764 | |
1852 | |
1765 | =cut |
1853 | =cut |
1766 | |
1854 | |
1767 | sub add_toggle { |
1855 | sub add_toggle { |
1768 | my ($self, $text, $cb, $value) = @_; |
1856 | my ($self, $text, $value, $cb) = @_; |
1769 | |
1857 | |
1770 | my $item; $item = { |
1858 | my $item; $item = { |
1771 | type => "button", |
1859 | type => "button", |
1772 | text => " $text", |
1860 | text => " $text", |
1773 | value => $value, |
1861 | value => $value, |