… | |
… | |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
35 | |
35 | |
36 | You can activate them like this: |
36 | You can activate them like this: |
37 | |
37 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
38 | @@RXVT_NAME@@ -pe <extensionname> |
|
|
39 | |
|
|
40 | Or by adding them to the resource for extensions loaded by default: |
|
|
41 | |
|
|
42 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
39 | |
43 | |
40 | =over 4 |
44 | =over 4 |
41 | |
45 | |
42 | =item selection (enabled by default) |
46 | =item selection (enabled by default) |
43 | |
47 | |
… | |
… | |
76 | |
80 | |
77 | Rot-13 the selection when activated. Used via keyboard trigger: |
81 | Rot-13 the selection when activated. Used via keyboard trigger: |
78 | |
82 | |
79 | URxvt.keysym.C-M-r: perl:selection:rot13 |
83 | URxvt.keysym.C-M-r: perl:selection:rot13 |
80 | |
84 | |
81 | =item remote-pastebin |
|
|
82 | |
|
|
83 | Upload the selection as textfile to a remote site. |
|
|
84 | |
|
|
85 | URxvt.keysym.C-M-e: perl:selection:remote-pastebin |
|
|
86 | |
|
|
87 | To set the command to upload the file set this resource: |
|
|
88 | |
|
|
89 | URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
90 | |
|
|
91 | The % is the placeholder for the textfile. The name of the textfile is the hex encoded |
|
|
92 | md5 sum of the selection. |
|
|
93 | After an successful upload the selection will be replaced by the following url |
|
|
94 | (the % is the placeholder for the filename): |
|
|
95 | |
|
|
96 | URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/% |
|
|
97 | |
|
|
98 | =back |
85 | =back |
99 | |
86 | |
100 | =item option-popup (enabled by default) |
87 | =item option-popup (enabled by default) |
101 | |
88 | |
102 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
89 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
… | |
… | |
104 | |
91 | |
105 | =item selection-popup (enabled by default) |
92 | =item selection-popup (enabled by default) |
106 | |
93 | |
107 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
94 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
108 | text into various other formats/action (such as uri unescaping, perl |
95 | text into various other formats/action (such as uri unescaping, perl |
109 | evalution, web-browser starting etc.), depending on content. |
96 | evaluation, web-browser starting etc.), depending on content. |
|
|
97 | |
|
|
98 | Other extensions can extend this popup menu by pushing a code reference |
|
|
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
|
|
100 | popup is displayed. |
|
|
101 | |
|
|
102 | It's sole argument is the popup menu, which can be modified. The selection |
|
|
103 | is in C<$_>, which can be used to decide wether to add something or not. |
|
|
104 | It should either return nothing or a string and a code reference. The |
|
|
105 | string will be used as button text and the code reference will be called |
|
|
106 | when the button gets activated and should transform C<$_>. |
|
|
107 | |
|
|
108 | The following will add an entry C<a to b> that transforms all C<a>s in |
|
|
109 | the selection to C<b>s, but only if the selection currently contains any |
|
|
110 | C<a>s: |
|
|
111 | |
|
|
112 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
113 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
114 | : () |
|
|
115 | }; |
110 | |
116 | |
111 | =item searchable-scrollback<hotkey> (enabled by default) |
117 | =item searchable-scrollback<hotkey> (enabled by default) |
112 | |
118 | |
113 | Adds regex search functionality to the scrollback buffer, triggered |
119 | Adds regex search functionality to the scrollback buffer, triggered |
114 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
120 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
… | |
… | |
142 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
148 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
143 | |
149 | |
144 | And this example matches the same,but replaces it with vi-commands you can |
150 | And this example matches the same,but replaces it with vi-commands you can |
145 | paste directly into your (vi :) editor: |
151 | paste directly into your (vi :) editor: |
146 | |
152 | |
147 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
153 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
148 | |
154 | |
149 | Of course, this can be modified to suit your needs and your editor :) |
155 | Of course, this can be modified to suit your needs and your editor :) |
150 | |
156 | |
151 | To expand the example above to typical perl error messages ("XXX at |
157 | To expand the example above to typical perl error messages ("XXX at |
152 | FILENAME line YYY."), you need a slightly more elaborate solution: |
158 | FILENAME line YYY."), you need a slightly more elaborate solution: |
153 | |
159 | |
154 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
160 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
155 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
161 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
156 | |
162 | |
157 | The first line tells the selection code to treat the unchanging part of |
163 | The first line tells the selection code to treat the unchanging part of |
158 | every error message as a selection pattern, and the second line transforms |
164 | every error message as a selection pattern, and the second line transforms |
159 | the message into vi commands to load the file. |
165 | the message into vi commands to load the file. |
|
|
166 | |
|
|
167 | =item tabbed |
|
|
168 | |
|
|
169 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
170 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
|
|
171 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
172 | button per tab. |
|
|
173 | |
|
|
174 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
175 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
176 | while B<Shift-Down> creates a new tab. |
160 | |
177 | |
161 | =item mark-urls |
178 | =item mark-urls |
162 | |
179 | |
163 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
180 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
164 | make them clickable. When middle-clicked, the program specified in the |
181 | make them clickable. When middle-clicked, the program specified in the |
165 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
182 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
166 | the URL as first argument. |
183 | the URL as first argument. |
167 | |
184 | |
|
|
185 | =item automove-background |
|
|
186 | |
|
|
187 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
188 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
189 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
190 | |
|
|
191 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
192 | |
168 | =item block-graphics-to-ascii |
193 | =item block-graphics-to-ascii |
169 | |
194 | |
170 | A not very useful example of filtering all text output to the terminal, |
195 | A not very useful example of filtering all text output to the terminal, |
171 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
196 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
172 | similar-looking ascii character. |
197 | similar-looking ascii character. |
… | |
… | |
178 | =item example-refresh-hooks |
203 | =item example-refresh-hooks |
179 | |
204 | |
180 | Displays a very simple digital clock in the upper right corner of the |
205 | Displays a very simple digital clock in the upper right corner of the |
181 | window. Illustrates overwriting the refresh callbacks to create your own |
206 | window. Illustrates overwriting the refresh callbacks to create your own |
182 | overlays or changes. |
207 | overlays or changes. |
|
|
208 | |
|
|
209 | =item selection-pastebin |
|
|
210 | |
|
|
211 | This is a little rarely useful extension that Uploads the selection as |
|
|
212 | textfile to a remote site (or does other things). (The implementation is |
|
|
213 | not currently secure for use in a multiuser environment as it writes to |
|
|
214 | F</tmp> directly.). |
|
|
215 | |
|
|
216 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
217 | i.e. |
|
|
218 | |
|
|
219 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
220 | |
|
|
221 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
222 | the textfile. This command can be set via a resource: |
|
|
223 | |
|
|
224 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
225 | |
|
|
226 | And the default is likely not useful to anybody but the few people around |
|
|
227 | here :) |
|
|
228 | |
|
|
229 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
230 | the same content should lead to the same filename. |
|
|
231 | |
|
|
232 | After a successful upload the selection will be replaced by the text given |
|
|
233 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
234 | for the filename): |
|
|
235 | |
|
|
236 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
183 | |
237 | |
184 | =back |
238 | =back |
185 | |
239 | |
186 | =head1 API DOCUMENTATION |
240 | =head1 API DOCUMENTATION |
187 | |
241 | |
… | |
… | |
260 | called whenever the relevant event happens. |
314 | called whenever the relevant event happens. |
261 | |
315 | |
262 | The first argument passed to them is an extension oject as described in |
316 | The first argument passed to them is an extension oject as described in |
263 | the in the C<Extension Objects> section. |
317 | the in the C<Extension Objects> section. |
264 | |
318 | |
265 | B<All> of these hooks must return a boolean value. If it is true, then the |
319 | B<All> of these hooks must return a boolean value. If any of the called |
266 | event counts as being I<consumed>, and the invocation of other hooks is |
320 | hooks returns true, then the event counts as being I<consumed>, and the |
267 | skipped, and the relevant action might not be carried out by the C++ code. |
321 | relevant action might not be carried out by the C++ code. |
268 | |
322 | |
269 | I<< When in doubt, return a false value (preferably C<()>). >> |
323 | I<< When in doubt, return a false value (preferably C<()>). >> |
270 | |
324 | |
271 | =over 4 |
325 | =over 4 |
272 | |
326 | |
273 | =item on_init $term |
327 | =item on_init $term |
274 | |
328 | |
275 | Called after a new terminal object has been initialized, but before |
329 | Called after a new terminal object has been initialized, but before |
276 | windows are created or the command gets run. Most methods are unsafe to |
330 | windows are created or the command gets run. Most methods are unsafe to |
277 | call or deliver senseless data, as terminal size and other characteristics |
331 | call or deliver senseless data, as terminal size and other characteristics |
278 | have not yet been determined. You can safely query and change resources, |
332 | have not yet been determined. You can safely query and change resources |
279 | though. |
333 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
334 | place. |
|
|
335 | |
|
|
336 | =item on_start $term |
|
|
337 | |
|
|
338 | Called at the very end of initialisation of a new terminal, just before |
|
|
339 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
340 | |
|
|
341 | =item on_destroy $term |
|
|
342 | |
|
|
343 | Called whenever something tries to destroy terminal, before doing anything |
|
|
344 | yet. If this hook returns true, then destruction is skipped, but this is |
|
|
345 | rarely a good idea. |
280 | |
346 | |
281 | =item on_reset $term |
347 | =item on_reset $term |
282 | |
348 | |
283 | Called after the screen is "reset" for any reason, such as resizing or |
349 | Called after the screen is "reset" for any reason, such as resizing or |
284 | control sequences. Here is where you can react on changes to size-related |
350 | control sequences. Here is where you can react on changes to size-related |
285 | variables. |
351 | variables. |
286 | |
352 | |
287 | =item on_start $term |
353 | =item on_child_start $term, $pid |
288 | |
354 | |
289 | Called at the very end of initialisation of a new terminal, just before |
355 | Called just after the child process has been C<fork>ed. |
290 | returning to the mainloop. |
356 | |
|
|
357 | =item on_child_exit $term, $status |
|
|
358 | |
|
|
359 | Called just after the child process has exited. C<$status> is the status |
|
|
360 | from C<waitpid>. |
291 | |
361 | |
292 | =item on_sel_make $term, $eventtime |
362 | =item on_sel_make $term, $eventtime |
293 | |
363 | |
294 | Called whenever a selection has been made by the user, but before the |
364 | Called whenever a selection has been made by the user, but before the |
295 | selection text is copied, so changes to the beginning, end or type of the |
365 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
404 | =item on_focus_out $term |
474 | =item on_focus_out $term |
405 | |
475 | |
406 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
476 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
407 | focus out processing. |
477 | focus out processing. |
408 | |
478 | |
|
|
479 | =item on_configure_notify $term, $event |
|
|
480 | |
|
|
481 | =item on_property_notify $term, $event |
|
|
482 | |
409 | =item on_key_press $term, $event, $keysym, $octets |
483 | =item on_key_press $term, $event, $keysym, $octets |
410 | |
484 | |
411 | =item on_key_release $term, $event, $keysym |
485 | =item on_key_release $term, $event, $keysym |
412 | |
486 | |
413 | =item on_button_press $term, $event |
487 | =item on_button_press $term, $event |
… | |
… | |
422 | |
496 | |
423 | Called whenever the corresponding X event is received for the terminal If |
497 | Called whenever the corresponding X event is received for the terminal If |
424 | the hook returns true, then the even will be ignored by rxvt-unicode. |
498 | the hook returns true, then the even will be ignored by rxvt-unicode. |
425 | |
499 | |
426 | The event is a hash with most values as named by Xlib (see the XEvent |
500 | The event is a hash with most values as named by Xlib (see the XEvent |
427 | manpage), with the additional members C<row> and C<col>, which are the row |
501 | manpage), with the additional members C<row> and C<col>, which are the |
428 | and column under the mouse cursor. |
502 | (real, not screen-based) row and column under the mouse cursor. |
429 | |
503 | |
430 | C<on_key_press> additionally receives the string rxvt-unicode would |
504 | C<on_key_press> additionally receives the string rxvt-unicode would |
431 | output, if any, in locale-specific encoding. |
505 | output, if any, in locale-specific encoding. |
432 | |
506 | |
433 | subwindow. |
507 | subwindow. |
|
|
508 | |
|
|
509 | =item on_client_message $term, $event |
|
|
510 | |
|
|
511 | =item on_wm_protocols $term, $event |
|
|
512 | |
|
|
513 | =item on_wm_delete_window $term, $event |
|
|
514 | |
|
|
515 | Called when various types of ClientMessage events are received (all with |
|
|
516 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
434 | |
517 | |
435 | =back |
518 | =back |
436 | |
519 | |
437 | =cut |
520 | =cut |
438 | |
521 | |
… | |
… | |
444 | use Scalar::Util (); |
527 | use Scalar::Util (); |
445 | use List::Util (); |
528 | use List::Util (); |
446 | |
529 | |
447 | our $VERSION = 1; |
530 | our $VERSION = 1; |
448 | our $TERM; |
531 | our $TERM; |
|
|
532 | our @TERM_INIT; |
|
|
533 | our @TERM_EXT; |
449 | our @HOOKNAME; |
534 | our @HOOKNAME; |
450 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
535 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
451 | our %OPTION; |
536 | our %OPTION; |
452 | |
537 | |
453 | our $LIBDIR; |
538 | our $LIBDIR; |
… | |
… | |
475 | =item $urxvt::TERM |
560 | =item $urxvt::TERM |
476 | |
561 | |
477 | The current terminal. This variable stores the current C<urxvt::term> |
562 | The current terminal. This variable stores the current C<urxvt::term> |
478 | object, whenever a callback/hook is executing. |
563 | object, whenever a callback/hook is executing. |
479 | |
564 | |
|
|
565 | =item @urxvt::TERM_INIT |
|
|
566 | |
|
|
567 | All coderefs in this array will be called as methods of the next newly |
|
|
568 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
569 | gets cleared before the codereferences that were in it are being executed, |
|
|
570 | so coderefs can push themselves onto it again if they so desire. |
|
|
571 | |
|
|
572 | This complements to the perl-eval commandline option, but gets executed |
|
|
573 | first. |
|
|
574 | |
|
|
575 | =item @urxvt::TERM_EXT |
|
|
576 | |
|
|
577 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
578 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
579 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
|
|
580 | |
480 | =back |
581 | =back |
481 | |
582 | |
482 | =head2 Functions in the C<urxvt> Package |
583 | =head2 Functions in the C<urxvt> Package |
483 | |
584 | |
484 | =over 4 |
585 | =over 4 |
… | |
… | |
497 | |
598 | |
498 | Using this function has the advantage that its output ends up in the |
599 | Using this function has the advantage that its output ends up in the |
499 | correct place, e.g. on stderr of the connecting urxvtc client. |
600 | correct place, e.g. on stderr of the connecting urxvtc client. |
500 | |
601 | |
501 | Messages have a size limit of 1023 bytes currently. |
602 | Messages have a size limit of 1023 bytes currently. |
502 | |
|
|
503 | =item $is_safe = urxvt::safe |
|
|
504 | |
|
|
505 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
506 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
507 | started setuid or setgid. |
|
|
508 | |
603 | |
509 | =item $time = urxvt::NOW |
604 | =item $time = urxvt::NOW |
510 | |
605 | |
511 | Returns the "current time" (as per the event loop). |
606 | Returns the "current time" (as per the event loop). |
512 | |
607 | |
… | |
… | |
589 | =back |
684 | =back |
590 | |
685 | |
591 | =cut |
686 | =cut |
592 | |
687 | |
593 | BEGIN { |
688 | BEGIN { |
594 | urxvt->bootstrap; |
|
|
595 | |
|
|
596 | # overwrite perl's warn |
689 | # overwrite perl's warn |
597 | *CORE::GLOBAL::warn = sub { |
690 | *CORE::GLOBAL::warn = sub { |
598 | my $msg = join "", @_; |
691 | my $msg = join "", @_; |
599 | $msg .= "\n" |
692 | $msg .= "\n" |
600 | unless $msg =~ /\n$/; |
693 | unless $msg =~ /\n$/; |
601 | urxvt::warn ($msg); |
694 | urxvt::warn ($msg); |
602 | }; |
695 | }; |
603 | |
|
|
604 | # %ENV is the original startup environment |
|
|
605 | delete $ENV{IFS}; |
|
|
606 | delete $ENV{CDPATH}; |
|
|
607 | delete $ENV{BASH_ENV}; |
|
|
608 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
609 | } |
696 | } |
610 | |
697 | |
611 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
698 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
612 | |
699 | |
613 | sub verbose { |
700 | sub verbose { |
614 | my ($level, $msg) = @_; |
701 | my ($level, $msg) = @_; |
615 | warn "$msg\n" if $level <= $verbosity; |
702 | warn "$msg\n" if $level <= $verbosity; |
616 | } |
703 | } |
617 | |
704 | |
618 | my $extension_pkg = "extension0000"; |
|
|
619 | my %extension_pkg; |
705 | my %extension_pkg; |
620 | |
706 | |
621 | # load a single script into its own package, once only |
707 | # load a single script into its own package, once only |
622 | sub extension_package($) { |
708 | sub extension_package($) { |
623 | my ($path) = @_; |
709 | my ($path) = @_; |
624 | |
710 | |
625 | $extension_pkg{$path} ||= do { |
711 | $extension_pkg{$path} ||= do { |
626 | my $pkg = "urxvt::" . ($extension_pkg++); |
712 | $path =~ /([^\/\\]+)$/; |
|
|
713 | my $pkg = $1; |
|
|
714 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
715 | $pkg = "urxvt::ext::$pkg"; |
627 | |
716 | |
628 | verbose 3, "loading extension '$path' into package '$pkg'"; |
717 | verbose 3, "loading extension '$path' into package '$pkg'"; |
629 | |
718 | |
630 | open my $fh, "<:raw", $path |
719 | open my $fh, "<:raw", $path |
631 | or die "$path: $!"; |
720 | or die "$path: $!"; |
632 | |
721 | |
633 | my $source = untaint |
722 | my $source = |
634 | "package $pkg; use strict; use utf8;\n" |
723 | "package $pkg; use strict; use utf8;\n" |
635 | . "use base urxvt::term::extension::;\n" |
|
|
636 | . "#line 1 \"$path\"\n{\n" |
724 | . "#line 1 \"$path\"\n{\n" |
637 | . (do { local $/; <$fh> }) |
725 | . (do { local $/; <$fh> }) |
638 | . "\n};\n1"; |
726 | . "\n};\n1"; |
639 | |
727 | |
640 | eval $source |
728 | eval $source |
… | |
… | |
654 | if ($htype == 0) { # INIT |
742 | if ($htype == 0) { # INIT |
655 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
743 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
656 | |
744 | |
657 | my %ext_arg; |
745 | my %ext_arg; |
658 | |
746 | |
|
|
747 | { |
|
|
748 | my @init = @TERM_INIT; |
|
|
749 | @TERM_INIT = (); |
|
|
750 | $_->($TERM) for @init; |
|
|
751 | my @pkg = @TERM_EXT; |
|
|
752 | @TERM_EXT = (); |
|
|
753 | $TERM->register_package ($_) for @pkg; |
|
|
754 | } |
|
|
755 | |
659 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
756 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
660 | if ($_ eq "default") { |
757 | if ($_ eq "default") { |
661 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
758 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
662 | } elsif (/^-(.*)$/) { |
759 | } elsif (/^-(.*)$/) { |
663 | delete $ext_arg{$1}; |
760 | delete $ext_arg{$1}; |
664 | } elsif (/^([^<]+)<(.*)>$/) { |
761 | } elsif (/^([^<]+)<(.*)>$/) { |
… | |
… | |
689 | if $verbosity >= 10; |
786 | if $verbosity >= 10; |
690 | |
787 | |
691 | keys %$cb; |
788 | keys %$cb; |
692 | |
789 | |
693 | while (my ($pkg, $cb) = each %$cb) { |
790 | while (my ($pkg, $cb) = each %$cb) { |
694 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
791 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
695 | and last; |
792 | $retval ||= $retval_; |
696 | |
793 | |
697 | if ($@) { |
794 | if ($@) { |
698 | $TERM->ungrab; # better to lose the grab than the session |
795 | $TERM->ungrab; # better to lose the grab than the session |
699 | warn $@; |
796 | warn $@; |
700 | } |
797 | } |
… | |
… | |
711 | # clear package |
808 | # clear package |
712 | %$TERM = (); |
809 | %$TERM = (); |
713 | } |
810 | } |
714 | |
811 | |
715 | $retval |
812 | $retval |
716 | } |
|
|
717 | |
|
|
718 | sub exec_async(@) { |
|
|
719 | my $pid = fork; |
|
|
720 | |
|
|
721 | return |
|
|
722 | if !defined $pid or $pid; |
|
|
723 | |
|
|
724 | %ENV = %{ $TERM->env }; |
|
|
725 | |
|
|
726 | exec @_; |
|
|
727 | _exit 255; |
|
|
728 | } |
813 | } |
729 | |
814 | |
730 | # urxvt::term::extension |
815 | # urxvt::term::extension |
731 | |
816 | |
732 | package urxvt::term::extension; |
817 | package urxvt::term::extension; |
… | |
… | |
871 | # find on_xxx subs in the package and register them |
956 | # find on_xxx subs in the package and register them |
872 | # as hooks |
957 | # as hooks |
873 | sub register_package { |
958 | sub register_package { |
874 | my ($self, $pkg, $argv) = @_; |
959 | my ($self, $pkg, $argv) = @_; |
875 | |
960 | |
|
|
961 | no strict 'refs'; |
|
|
962 | |
|
|
963 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
964 | |
|
|
965 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
966 | |
876 | my $proxy = bless { |
967 | my $proxy = bless { |
877 | _pkg => $pkg, |
968 | _pkg => $pkg, |
878 | argv => $argv, |
969 | argv => $argv, |
879 | }, $pkg; |
970 | }, $pkg; |
880 | Scalar::Util::weaken ($proxy->{term} = $self); |
971 | Scalar::Util::weaken ($proxy->{term} = $self); |
… | |
… | |
911 | |
1002 | |
912 | Destroy the terminal object (close the window, free resources |
1003 | Destroy the terminal object (close the window, free resources |
913 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1004 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
914 | watchers (timers, io watchers) are still active. |
1005 | watchers (timers, io watchers) are still active. |
915 | |
1006 | |
|
|
1007 | =item $term->exec_async ($cmd[, @args]) |
|
|
1008 | |
|
|
1009 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
1010 | ("starts") programs in the background. This function takes care of setting |
|
|
1011 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
1012 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
1013 | |
|
|
1014 | Returns the pid of the subprocess or C<undef> on error. |
|
|
1015 | |
|
|
1016 | =cut |
|
|
1017 | |
|
|
1018 | sub exec_async { |
|
|
1019 | my $self = shift; |
|
|
1020 | |
|
|
1021 | my $pid = fork; |
|
|
1022 | |
|
|
1023 | return $pid |
|
|
1024 | if !defined $pid or $pid; |
|
|
1025 | |
|
|
1026 | %ENV = %{ $self->env }; |
|
|
1027 | |
|
|
1028 | exec @_; |
|
|
1029 | urxvt::_exit 255; |
|
|
1030 | } |
|
|
1031 | |
916 | =item $isset = $term->option ($optval[, $set]) |
1032 | =item $isset = $term->option ($optval[, $set]) |
917 | |
1033 | |
918 | Returns true if the option specified by C<$optval> is enabled, and |
1034 | Returns true if the option specified by C<$optval> is enabled, and |
919 | optionally change it. All option values are stored by name in the hash |
1035 | optionally change it. All option values are stored by name in the hash |
920 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1036 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
… | |
… | |
922 | Here is a a likely non-exhaustive list of option names, please see the |
1038 | Here is a a likely non-exhaustive list of option names, please see the |
923 | source file F</src/optinc.h> to see the actual list: |
1039 | source file F</src/optinc.h> to see the actual list: |
924 | |
1040 | |
925 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1041 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
926 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1042 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
927 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1043 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
928 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1044 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
929 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1045 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
930 | tripleclickwords utmpInhibit visualBell |
1046 | transparent tripleclickwords utmpInhibit visualBell |
931 | |
1047 | |
932 | =item $value = $term->resource ($name[, $newval]) |
1048 | =item $value = $term->resource ($name[, $newval]) |
933 | |
1049 | |
934 | Returns the current resource value associated with a given name and |
1050 | Returns the current resource value associated with a given name and |
935 | optionally sets a new value. Setting values is most useful in the C<init> |
1051 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
952 | |
1068 | |
953 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1069 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
954 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1070 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
955 | display_name embed ext_bwidth fade font geometry hold iconName |
1071 | display_name embed ext_bwidth fade font geometry hold iconName |
956 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1072 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
957 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1073 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
958 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1074 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
959 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1075 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
960 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1076 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
961 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1077 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
962 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1078 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
963 | shade term_name title transparent transparent_all tripleclickwords |
1079 | secondaryScreen secondaryScroll selectstyle shade term_name title |
964 | utmpInhibit visualBell |
1080 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
|
|
1081 | visualBell |
965 | |
1082 | |
966 | =cut |
1083 | =cut |
967 | |
1084 | |
968 | sub resource($$;$) { |
1085 | sub resource($$;$) { |
969 | my ($self, $name) = (shift, shift); |
1086 | my ($self, $name) = (shift, shift); |
… | |
… | |
1451 | |
1568 | |
1452 | Calls XUngrab for the most recent grab. Is called automatically on |
1569 | Calls XUngrab for the most recent grab. Is called automatically on |
1453 | evaluation errors, as it is better to lose the grab in the error case as |
1570 | evaluation errors, as it is better to lose the grab in the error case as |
1454 | the session. |
1571 | the session. |
1455 | |
1572 | |
|
|
1573 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1574 | |
|
|
1575 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1576 | |
|
|
1577 | =item @atoms = $term->XListProperties ($window) |
|
|
1578 | |
|
|
1579 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1580 | |
|
|
1581 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1582 | |
|
|
1583 | =item $term->XDeleteProperty ($window, $property) |
|
|
1584 | |
|
|
1585 | =item $window = $term->DefaultRootWindow |
|
|
1586 | |
|
|
1587 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1588 | |
|
|
1589 | =item $term->XMapWindow ($window) |
|
|
1590 | |
|
|
1591 | =item $term->XUnmapWindow ($window) |
|
|
1592 | |
|
|
1593 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1594 | |
|
|
1595 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1596 | |
|
|
1597 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1598 | |
|
|
1599 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1600 | the source of the display, otherwise those functions map more-or-less |
|
|
1601 | directory onto the X functions of the same name. |
|
|
1602 | |
1456 | =back |
1603 | =back |
1457 | |
1604 | |
1458 | =cut |
1605 | =cut |
1459 | |
1606 | |
1460 | package urxvt::popup; |
1607 | package urxvt::popup; |
… | |
… | |
1561 | my $env = $self->{term}->env; |
1708 | my $env = $self->{term}->env; |
1562 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1709 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1563 | delete $env->{LC_ALL}; |
1710 | delete $env->{LC_ALL}; |
1564 | $env->{LC_CTYPE} = $self->{term}->locale; |
1711 | $env->{LC_CTYPE} = $self->{term}->locale; |
1565 | |
1712 | |
1566 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1713 | urxvt::term->new ($env, "popup", |
1567 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1714 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
1715 | "-pty-fd" => -1, "-sl" => 0, |
|
|
1716 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1568 | "--transient-for" => $self->{term}->parent, |
1717 | "--transient-for" => $self->{term}->parent, |
1569 | "-display" => $self->{term}->display_id, |
1718 | "-display" => $self->{term}->display_id, |
1570 | "-pe" => "urxvt-popup") |
1719 | "-pe" => "urxvt-popup") |
1571 | or die "unable to create popup window\n"; |
1720 | or die "unable to create popup window\n"; |
1572 | } |
1721 | } |
… | |
… | |
1577 | delete $self->{term}{_destroy}{$self}; |
1726 | delete $self->{term}{_destroy}{$self}; |
1578 | $self->{term}->ungrab; |
1727 | $self->{term}->ungrab; |
1579 | } |
1728 | } |
1580 | |
1729 | |
1581 | =back |
1730 | =back |
|
|
1731 | |
|
|
1732 | =cut |
|
|
1733 | |
|
|
1734 | package urxvt::watcher; |
|
|
1735 | |
|
|
1736 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1737 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1738 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1739 | @urxvt::iw::ISA = __PACKAGE__; |
1582 | |
1740 | |
1583 | =head2 The C<urxvt::timer> Class |
1741 | =head2 The C<urxvt::timer> Class |
1584 | |
1742 | |
1585 | This class implements timer watchers/events. Time is represented as a |
1743 | This class implements timer watchers/events. Time is represented as a |
1586 | fractional number of seconds since the epoch. Example: |
1744 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1624 | Start the timer. |
1782 | Start the timer. |
1625 | |
1783 | |
1626 | =item $timer = $timer->start ($tstamp) |
1784 | =item $timer = $timer->start ($tstamp) |
1627 | |
1785 | |
1628 | Set the event trigger time to C<$tstamp> and start the timer. |
1786 | Set the event trigger time to C<$tstamp> and start the timer. |
|
|
1787 | |
|
|
1788 | =item $timer = $timer->after ($delay) |
|
|
1789 | |
|
|
1790 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1629 | |
1791 | |
1630 | =item $timer = $timer->stop |
1792 | =item $timer = $timer->stop |
1631 | |
1793 | |
1632 | Stop the timer. |
1794 | Stop the timer. |
1633 | |
1795 | |
… | |
… | |
1680 | |
1842 | |
1681 | Stop watching for events on the given filehandle. |
1843 | Stop watching for events on the given filehandle. |
1682 | |
1844 | |
1683 | =back |
1845 | =back |
1684 | |
1846 | |
|
|
1847 | =head2 The C<urxvt::iw> Class |
|
|
1848 | |
|
|
1849 | This class implements idle watchers, that get called automatically when |
|
|
1850 | the process is idle. They should return as fast as possible, after doing |
|
|
1851 | some useful work. |
|
|
1852 | |
|
|
1853 | =over 4 |
|
|
1854 | |
|
|
1855 | =item $iw = new urxvt::iw |
|
|
1856 | |
|
|
1857 | Create a new idle watcher object in stopped state. |
|
|
1858 | |
|
|
1859 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1860 | |
|
|
1861 | Set the callback to be called when the watcher triggers. |
|
|
1862 | |
|
|
1863 | =item $timer = $timer->start |
|
|
1864 | |
|
|
1865 | Start the watcher. |
|
|
1866 | |
|
|
1867 | =item $timer = $timer->stop |
|
|
1868 | |
|
|
1869 | Stop the watcher. |
|
|
1870 | |
|
|
1871 | =back |
|
|
1872 | |
|
|
1873 | =head2 The C<urxvt::pw> Class |
|
|
1874 | |
|
|
1875 | This class implements process watchers. They create an event whenever a |
|
|
1876 | process exits, after which they stop automatically. |
|
|
1877 | |
|
|
1878 | my $pid = fork; |
|
|
1879 | ... |
|
|
1880 | $term->{pw} = urxvt::pw |
|
|
1881 | ->new |
|
|
1882 | ->start ($pid) |
|
|
1883 | ->cb (sub { |
|
|
1884 | my ($pw, $exit_status) = @_; |
|
|
1885 | ... |
|
|
1886 | }); |
|
|
1887 | |
|
|
1888 | =over 4 |
|
|
1889 | |
|
|
1890 | =item $pw = new urxvt::pw |
|
|
1891 | |
|
|
1892 | Create a new process watcher in stopped state. |
|
|
1893 | |
|
|
1894 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1895 | |
|
|
1896 | Set the callback to be called when the timer triggers. |
|
|
1897 | |
|
|
1898 | =item $pw = $timer->start ($pid) |
|
|
1899 | |
|
|
1900 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
1901 | |
|
|
1902 | =item $pw = $pw->stop |
|
|
1903 | |
|
|
1904 | Stop the watcher. |
|
|
1905 | |
|
|
1906 | =back |
|
|
1907 | |
1685 | =head1 ENVIRONMENT |
1908 | =head1 ENVIRONMENT |
1686 | |
1909 | |
1687 | =head2 URXVT_PERL_VERBOSITY |
1910 | =head2 URXVT_PERL_VERBOSITY |
1688 | |
1911 | |
1689 | This variable controls the verbosity level of the perl extension. Higher |
1912 | This variable controls the verbosity level of the perl extension. Higher |