… | |
… | |
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 | |
… | |
… | |
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
67 | |
71 | |
68 | You can look at the source of the selection extension to see more |
72 | You can look at the source of the selection extension to see more |
69 | interesting uses, such as parsing a line from beginning to end. |
73 | interesting uses, such as parsing a line from beginning to end. |
70 | |
74 | |
71 | This extension also offers the following bindable keyboard command: |
75 | This extension also offers following bindable keyboard commands: |
72 | |
76 | |
73 | =over 4 |
77 | =over 4 |
74 | |
78 | |
75 | =item rot13 |
79 | =item rot13 |
76 | |
80 | |
… | |
… | |
88 | =item selection-popup (enabled by default) |
92 | =item selection-popup (enabled by default) |
89 | |
93 | |
90 | 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 |
91 | text into various other formats/action (such as uri unescaping, perl |
95 | text into various other formats/action (such as uri unescaping, perl |
92 | evalution, web-browser starting etc.), depending on content. |
96 | evalution, 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 | }; |
93 | |
116 | |
94 | =item searchable-scrollback<hotkey> (enabled by default) |
117 | =item searchable-scrollback<hotkey> (enabled by default) |
95 | |
118 | |
96 | Adds regex search functionality to the scrollback buffer, triggered |
119 | Adds regex search functionality to the scrollback buffer, triggered |
97 | 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 |
… | |
… | |
117 | URxvt.selection-autotransform.0: transform |
140 | URxvt.selection-autotransform.0: transform |
118 | URxvt.selection-autotransform.1: transform |
141 | URxvt.selection-autotransform.1: transform |
119 | ... |
142 | ... |
120 | |
143 | |
121 | For example, the following will transform selections of the form |
144 | For example, the following will transform selections of the form |
122 | C<word:number> into C<vi +$number $word>: |
145 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
146 | $word>: |
123 | |
147 | |
124 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/ |
148 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
125 | |
149 | |
126 | 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 |
127 | paste directory into your (vi :) editor: |
151 | paste directly into your (vi :) editor: |
128 | |
152 | |
129 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\x0d:$2\\x0d/ |
153 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
154 | |
|
|
155 | Of course, this can be modified to suit your needs and your editor :) |
|
|
156 | |
|
|
157 | To expand the example above to typical perl error messages ("XXX at |
|
|
158 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
159 | |
|
|
160 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
161 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
162 | |
|
|
163 | The first line tells the selection code to treat the unchanging part of |
|
|
164 | every error message as a selection pattern, and the second line transforms |
|
|
165 | the message into vi commands to load the file. |
130 | |
166 | |
131 | =item mark-urls |
167 | =item mark-urls |
132 | |
168 | |
133 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
169 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
134 | make them clickable. When middle-clicked, the program specified in the |
170 | make them clickable. When middle-clicked, the program specified in the |
135 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
171 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
136 | the URL as first argument. |
172 | the URL as first argument. |
137 | |
173 | |
|
|
174 | =item automove-background |
|
|
175 | |
|
|
176 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
177 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
178 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
179 | |
|
|
180 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
181 | |
138 | =item block-graphics-to-ascii |
182 | =item block-graphics-to-ascii |
139 | |
183 | |
140 | A not very useful example of filtering all text output to the terminal, |
184 | A not very useful example of filtering all text output to the terminal, |
141 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
185 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
142 | similar-looking ascii character. |
186 | similar-looking ascii character. |
… | |
… | |
148 | =item example-refresh-hooks |
192 | =item example-refresh-hooks |
149 | |
193 | |
150 | Displays a very simple digital clock in the upper right corner of the |
194 | Displays a very simple digital clock in the upper right corner of the |
151 | window. Illustrates overwriting the refresh callbacks to create your own |
195 | window. Illustrates overwriting the refresh callbacks to create your own |
152 | overlays or changes. |
196 | overlays or changes. |
|
|
197 | |
|
|
198 | =item selection-pastebin |
|
|
199 | |
|
|
200 | This is a little rarely useful extension that Uploads the selection as |
|
|
201 | textfile to a remote site (or does other things). (The implementation is |
|
|
202 | not currently secure for use in a multiuser environment as it writes to |
|
|
203 | F</tmp> directly.). |
|
|
204 | |
|
|
205 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
206 | i.e. |
|
|
207 | |
|
|
208 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
209 | |
|
|
210 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
211 | the textfile. This command can be set via a resource: |
|
|
212 | |
|
|
213 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
214 | |
|
|
215 | And the default is likely not useful to anybody but the few people around |
|
|
216 | here :) |
|
|
217 | |
|
|
218 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
219 | the same content should lead to the same filename. |
|
|
220 | |
|
|
221 | After a successful upload the selection will be replaced by the text given |
|
|
222 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
223 | for the filename): |
|
|
224 | |
|
|
225 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
153 | |
226 | |
154 | =back |
227 | =back |
155 | |
228 | |
156 | =head1 API DOCUMENTATION |
229 | =head1 API DOCUMENTATION |
157 | |
230 | |
… | |
… | |
230 | called whenever the relevant event happens. |
303 | called whenever the relevant event happens. |
231 | |
304 | |
232 | The first argument passed to them is an extension oject as described in |
305 | The first argument passed to them is an extension oject as described in |
233 | the in the C<Extension Objects> section. |
306 | the in the C<Extension Objects> section. |
234 | |
307 | |
235 | B<All> of these hooks must return a boolean value. If it is true, then the |
308 | B<All> of these hooks must return a boolean value. If any of the called |
236 | event counts as being I<consumed>, and the invocation of other hooks is |
309 | hooks returns true, then the event counts as being I<consumed>, and the |
237 | skipped, and the relevant action might not be carried out by the C++ code. |
310 | relevant action might not be carried out by the C++ code. |
238 | |
311 | |
239 | I<< When in doubt, return a false value (preferably C<()>). >> |
312 | I<< When in doubt, return a false value (preferably C<()>). >> |
240 | |
313 | |
241 | =over 4 |
314 | =over 4 |
242 | |
315 | |
243 | =item on_init $term |
316 | =item on_init $term |
244 | |
317 | |
245 | Called after a new terminal object has been initialized, but before |
318 | Called after a new terminal object has been initialized, but before |
246 | windows are created or the command gets run. Most methods are unsafe to |
319 | windows are created or the command gets run. Most methods are unsafe to |
247 | call or deliver senseless data, as terminal size and other characteristics |
320 | call or deliver senseless data, as terminal size and other characteristics |
248 | have not yet been determined. You can safely query and change resources, |
321 | have not yet been determined. You can safely query and change resources |
249 | though. |
322 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
323 | place. |
|
|
324 | |
|
|
325 | =item on_start $term |
|
|
326 | |
|
|
327 | Called at the very end of initialisation of a new terminal, just before |
|
|
328 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
329 | |
|
|
330 | =item on_destroy $term |
|
|
331 | |
|
|
332 | Called whenever something tries to destroy terminal, before doing anything |
|
|
333 | yet. If this hook returns true, then destruction is skipped, but this is |
|
|
334 | rarely a good idea. |
250 | |
335 | |
251 | =item on_reset $term |
336 | =item on_reset $term |
252 | |
337 | |
253 | Called after the screen is "reset" for any reason, such as resizing or |
338 | Called after the screen is "reset" for any reason, such as resizing or |
254 | control sequences. Here is where you can react on changes to size-related |
339 | control sequences. Here is where you can react on changes to size-related |
255 | variables. |
340 | variables. |
256 | |
341 | |
257 | =item on_start $term |
342 | =item on_child_start $term, $pid |
258 | |
343 | |
259 | Called at the very end of initialisation of a new terminal, just before |
344 | Called just after the child process has been C<fork>ed. |
260 | returning to the mainloop. |
345 | |
|
|
346 | =item on_child_exit $term, $status |
|
|
347 | |
|
|
348 | Called just after the child process has exited. C<$status> is the status |
|
|
349 | from C<waitpid>. |
261 | |
350 | |
262 | =item on_sel_make $term, $eventtime |
351 | =item on_sel_make $term, $eventtime |
263 | |
352 | |
264 | Called whenever a selection has been made by the user, but before the |
353 | Called whenever a selection has been made by the user, but before the |
265 | selection text is copied, so changes to the beginning, end or type of the |
354 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
358 | |
447 | |
359 | Called whenever the user presses a key combination that has a |
448 | Called whenever the user presses a key combination that has a |
360 | C<perl:string> action bound to it (see description of the B<keysym> |
449 | C<perl:string> action bound to it (see description of the B<keysym> |
361 | resource in the @@RXVT_NAME@@(1) manpage). |
450 | resource in the @@RXVT_NAME@@(1) manpage). |
362 | |
451 | |
|
|
452 | =item on_x_event $term, $event |
|
|
453 | |
|
|
454 | Called on every X event received on the vt window (and possibly other |
|
|
455 | windows). Should only be used as a last resort. Most event structure |
|
|
456 | members are not passed. |
|
|
457 | |
363 | =item on_focus_in $term |
458 | =item on_focus_in $term |
364 | |
459 | |
365 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
460 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
366 | does focus in processing. |
461 | does focus in processing. |
367 | |
462 | |
368 | =item on_focus_out $term |
463 | =item on_focus_out $term |
369 | |
464 | |
370 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
465 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
371 | focus out processing. |
466 | focus out processing. |
|
|
467 | |
|
|
468 | =item on_configure_notify $term, $event |
372 | |
469 | |
373 | =item on_key_press $term, $event, $keysym, $octets |
470 | =item on_key_press $term, $event, $keysym, $octets |
374 | |
471 | |
375 | =item on_key_release $term, $event, $keysym |
472 | =item on_key_release $term, $event, $keysym |
376 | |
473 | |
… | |
… | |
393 | |
490 | |
394 | C<on_key_press> additionally receives the string rxvt-unicode would |
491 | C<on_key_press> additionally receives the string rxvt-unicode would |
395 | output, if any, in locale-specific encoding. |
492 | output, if any, in locale-specific encoding. |
396 | |
493 | |
397 | subwindow. |
494 | subwindow. |
|
|
495 | |
|
|
496 | =item on_client_message $term, $event |
|
|
497 | |
|
|
498 | =item on_wm_protocols $term, $event |
|
|
499 | |
|
|
500 | =item on_wm_delete_window $term, $event |
|
|
501 | |
|
|
502 | Called when various types of ClientMessage events are received (all with |
|
|
503 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
398 | |
504 | |
399 | =back |
505 | =back |
400 | |
506 | |
401 | =cut |
507 | =cut |
402 | |
508 | |
… | |
… | |
408 | use Scalar::Util (); |
514 | use Scalar::Util (); |
409 | use List::Util (); |
515 | use List::Util (); |
410 | |
516 | |
411 | our $VERSION = 1; |
517 | our $VERSION = 1; |
412 | our $TERM; |
518 | our $TERM; |
|
|
519 | our @TERM_INIT; |
|
|
520 | our @TERM_EXT; |
413 | our @HOOKNAME; |
521 | our @HOOKNAME; |
414 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
522 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
415 | our %OPTION; |
523 | our %OPTION; |
416 | |
524 | |
417 | our $LIBDIR; |
525 | our $LIBDIR; |
… | |
… | |
439 | =item $urxvt::TERM |
547 | =item $urxvt::TERM |
440 | |
548 | |
441 | The current terminal. This variable stores the current C<urxvt::term> |
549 | The current terminal. This variable stores the current C<urxvt::term> |
442 | object, whenever a callback/hook is executing. |
550 | object, whenever a callback/hook is executing. |
443 | |
551 | |
|
|
552 | =item @urxvt::TERM_INIT |
|
|
553 | |
|
|
554 | All coderefs in this array will be called as methods of the next newly |
|
|
555 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
556 | gets cleared before the codereferences that were in it are being executed, |
|
|
557 | so coderefs can push themselves onto it again if they so desire. |
|
|
558 | |
|
|
559 | This complements to the perl-eval commandline option, but gets executed |
|
|
560 | first. |
|
|
561 | |
|
|
562 | =item @urxvt::TERM_EXT |
|
|
563 | |
|
|
564 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
565 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
566 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
|
|
567 | |
444 | =back |
568 | =back |
445 | |
569 | |
446 | =head2 Functions in the C<urxvt> Package |
570 | =head2 Functions in the C<urxvt> Package |
447 | |
571 | |
448 | =over 4 |
572 | =over 4 |
… | |
… | |
462 | Using this function has the advantage that its output ends up in the |
586 | Using this function has the advantage that its output ends up in the |
463 | correct place, e.g. on stderr of the connecting urxvtc client. |
587 | correct place, e.g. on stderr of the connecting urxvtc client. |
464 | |
588 | |
465 | Messages have a size limit of 1023 bytes currently. |
589 | Messages have a size limit of 1023 bytes currently. |
466 | |
590 | |
467 | =item $is_safe = urxvt::safe |
|
|
468 | |
|
|
469 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
470 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
471 | started setuid or setgid. |
|
|
472 | |
|
|
473 | =item $time = urxvt::NOW |
591 | =item $time = urxvt::NOW |
474 | |
592 | |
475 | Returns the "current time" (as per the event loop). |
593 | Returns the "current time" (as per the event loop). |
476 | |
594 | |
477 | =item urxvt::CurrentTime |
595 | =item urxvt::CurrentTime |
478 | |
596 | |
479 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
597 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
480 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
598 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
481 | Button4Mask, Button5Mask, AnyModifier |
599 | Button4Mask, Button5Mask, AnyModifier |
|
|
600 | |
|
|
601 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
602 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
603 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
604 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
605 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
606 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
607 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
608 | |
|
|
609 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
610 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
611 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
612 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
613 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
614 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
615 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
482 | |
616 | |
483 | Various constants for use in X calls and event processing. |
617 | Various constants for use in X calls and event processing. |
484 | |
618 | |
485 | =back |
619 | =back |
486 | |
620 | |
… | |
… | |
537 | =back |
671 | =back |
538 | |
672 | |
539 | =cut |
673 | =cut |
540 | |
674 | |
541 | BEGIN { |
675 | BEGIN { |
542 | urxvt->bootstrap; |
|
|
543 | |
|
|
544 | # overwrite perl's warn |
676 | # overwrite perl's warn |
545 | *CORE::GLOBAL::warn = sub { |
677 | *CORE::GLOBAL::warn = sub { |
546 | my $msg = join "", @_; |
678 | my $msg = join "", @_; |
547 | $msg .= "\n" |
679 | $msg .= "\n" |
548 | unless $msg =~ /\n$/; |
680 | unless $msg =~ /\n$/; |
549 | urxvt::warn ($msg); |
681 | urxvt::warn ($msg); |
550 | }; |
682 | }; |
551 | |
|
|
552 | # %ENV is the original startup environment |
|
|
553 | delete $ENV{IFS}; |
|
|
554 | delete $ENV{CDPATH}; |
|
|
555 | delete $ENV{BASH_ENV}; |
|
|
556 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
557 | } |
683 | } |
558 | |
684 | |
559 | my @hook_count; |
|
|
560 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
685 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
561 | |
686 | |
562 | sub verbose { |
687 | sub verbose { |
563 | my ($level, $msg) = @_; |
688 | my ($level, $msg) = @_; |
564 | warn "$msg\n" if $level <= $verbosity; |
689 | warn "$msg\n" if $level <= $verbosity; |
565 | } |
690 | } |
566 | |
691 | |
567 | my $extension_pkg = "extension0000"; |
|
|
568 | my %extension_pkg; |
692 | my %extension_pkg; |
569 | |
693 | |
570 | # load a single script into its own package, once only |
694 | # load a single script into its own package, once only |
571 | sub extension_package($) { |
695 | sub extension_package($) { |
572 | my ($path) = @_; |
696 | my ($path) = @_; |
573 | |
697 | |
574 | $extension_pkg{$path} ||= do { |
698 | $extension_pkg{$path} ||= do { |
575 | my $pkg = "urxvt::" . ($extension_pkg++); |
699 | $path =~ /([^\/\\]+)$/; |
|
|
700 | my $pkg = $1; |
|
|
701 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
702 | $pkg = "urxvt::ext::$pkg"; |
576 | |
703 | |
577 | verbose 3, "loading extension '$path' into package '$pkg'"; |
704 | verbose 3, "loading extension '$path' into package '$pkg'"; |
578 | |
705 | |
579 | open my $fh, "<:raw", $path |
706 | open my $fh, "<:raw", $path |
580 | or die "$path: $!"; |
707 | or die "$path: $!"; |
581 | |
708 | |
582 | my $source = untaint |
709 | my $source = |
583 | "package $pkg; use strict; use utf8;\n" |
710 | "package $pkg; use strict; use utf8;\n" |
584 | . "use base urxvt::term::extension::;\n" |
|
|
585 | . "#line 1 \"$path\"\n{\n" |
711 | . "#line 1 \"$path\"\n{\n" |
586 | . (do { local $/; <$fh> }) |
712 | . (do { local $/; <$fh> }) |
587 | . "\n};\n1"; |
713 | . "\n};\n1"; |
588 | |
714 | |
589 | eval $source |
715 | eval $source |
… | |
… | |
603 | if ($htype == 0) { # INIT |
729 | if ($htype == 0) { # INIT |
604 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
730 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
605 | |
731 | |
606 | my %ext_arg; |
732 | my %ext_arg; |
607 | |
733 | |
|
|
734 | { |
|
|
735 | my @init = @TERM_INIT; |
|
|
736 | @TERM_INIT = (); |
|
|
737 | $_->($TERM) for @init; |
|
|
738 | my @pkg = @TERM_EXT; |
|
|
739 | @TERM_EXT = (); |
|
|
740 | $TERM->register_package ($_) for @pkg; |
|
|
741 | } |
|
|
742 | |
608 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
743 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
609 | if ($_ eq "default") { |
744 | if ($_ eq "default") { |
610 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
745 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
611 | } elsif (/^-(.*)$/) { |
746 | } elsif (/^-(.*)$/) { |
612 | delete $ext_arg{$1}; |
747 | delete $ext_arg{$1}; |
613 | } elsif (/^([^<]+)<(.*)>$/) { |
748 | } elsif (/^([^<]+)<(.*)>$/) { |
… | |
… | |
638 | if $verbosity >= 10; |
773 | if $verbosity >= 10; |
639 | |
774 | |
640 | keys %$cb; |
775 | keys %$cb; |
641 | |
776 | |
642 | while (my ($pkg, $cb) = each %$cb) { |
777 | while (my ($pkg, $cb) = each %$cb) { |
643 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
778 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
644 | and last; |
779 | $retval ||= $retval_; |
645 | |
780 | |
646 | if ($@) { |
781 | if ($@) { |
647 | $TERM->ungrab; # better to lose the grab than the session |
782 | $TERM->ungrab; # better to lose the grab than the session |
648 | warn $@; |
783 | warn $@; |
649 | } |
784 | } |
… | |
… | |
652 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
787 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
653 | if $verbosity >= 11; |
788 | if $verbosity >= 11; |
654 | } |
789 | } |
655 | |
790 | |
656 | if ($htype == 1) { # DESTROY |
791 | if ($htype == 1) { # DESTROY |
657 | if (my $hook = delete $TERM->{_hook}) { |
|
|
658 | for my $htype (0..$#$hook) { |
|
|
659 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
660 | or set_should_invoke $htype, 0; |
|
|
661 | } |
|
|
662 | } |
|
|
663 | |
|
|
664 | # clear package objects |
792 | # clear package objects |
665 | %$_ = () for values %{ $TERM->{_pkg} }; |
793 | %$_ = () for values %{ $TERM->{_pkg} }; |
666 | |
794 | |
667 | # clear package |
795 | # clear package |
668 | %$TERM = (); |
796 | %$TERM = (); |
669 | } |
797 | } |
670 | |
798 | |
671 | $retval |
799 | $retval |
672 | } |
|
|
673 | |
|
|
674 | sub exec_async(@) { |
|
|
675 | my $pid = fork; |
|
|
676 | |
|
|
677 | return |
|
|
678 | if !defined $pid or $pid; |
|
|
679 | |
|
|
680 | %ENV = %{ $TERM->env }; |
|
|
681 | |
|
|
682 | exec @_; |
|
|
683 | _exit 255; |
|
|
684 | } |
800 | } |
685 | |
801 | |
686 | # urxvt::term::extension |
802 | # urxvt::term::extension |
687 | |
803 | |
688 | package urxvt::term::extension; |
804 | package urxvt::term::extension; |
… | |
… | |
694 | while (my ($name, $cb) = each %hook) { |
810 | while (my ($name, $cb) = each %hook) { |
695 | my $htype = $HOOKTYPE{uc $name}; |
811 | my $htype = $HOOKTYPE{uc $name}; |
696 | defined $htype |
812 | defined $htype |
697 | or Carp::croak "unsupported hook type '$name'"; |
813 | or Carp::croak "unsupported hook type '$name'"; |
698 | |
814 | |
|
|
815 | $self->set_should_invoke ($htype, +1) |
699 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
816 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
700 | $hook_count[$htype]++ |
|
|
701 | or urxvt::set_should_invoke $htype, 1; |
|
|
702 | } |
|
|
703 | |
817 | |
704 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
818 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
705 | } |
819 | } |
706 | } |
820 | } |
707 | |
821 | |
… | |
… | |
712 | for my $name (@hook) { |
826 | for my $name (@hook) { |
713 | my $htype = $HOOKTYPE{uc $name}; |
827 | my $htype = $HOOKTYPE{uc $name}; |
714 | defined $htype |
828 | defined $htype |
715 | or Carp::croak "unsupported hook type '$name'"; |
829 | or Carp::croak "unsupported hook type '$name'"; |
716 | |
830 | |
|
|
831 | $self->set_should_invoke ($htype, -1) |
717 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
832 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
718 | --$hook_count[$htype] |
|
|
719 | or urxvt::set_should_invoke $htype, 0; |
|
|
720 | } |
|
|
721 | } |
833 | } |
722 | } |
834 | } |
723 | |
835 | |
724 | our $AUTOLOAD; |
836 | our $AUTOLOAD; |
725 | |
837 | |
… | |
… | |
831 | # find on_xxx subs in the package and register them |
943 | # find on_xxx subs in the package and register them |
832 | # as hooks |
944 | # as hooks |
833 | sub register_package { |
945 | sub register_package { |
834 | my ($self, $pkg, $argv) = @_; |
946 | my ($self, $pkg, $argv) = @_; |
835 | |
947 | |
|
|
948 | no strict 'refs'; |
|
|
949 | |
|
|
950 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
951 | |
|
|
952 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
953 | |
836 | my $proxy = bless { |
954 | my $proxy = bless { |
837 | _pkg => $pkg, |
955 | _pkg => $pkg, |
838 | argv => $argv, |
956 | argv => $argv, |
839 | }, $pkg; |
957 | }, $pkg; |
840 | Scalar::Util::weaken ($proxy->{term} = $self); |
958 | Scalar::Util::weaken ($proxy->{term} = $self); |
… | |
… | |
871 | |
989 | |
872 | Destroy the terminal object (close the window, free resources |
990 | Destroy the terminal object (close the window, free resources |
873 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
991 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
874 | watchers (timers, io watchers) are still active. |
992 | watchers (timers, io watchers) are still active. |
875 | |
993 | |
|
|
994 | =item $term->exec_async ($cmd[, @args]) |
|
|
995 | |
|
|
996 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
997 | ("starts") programs in the background. This function takes care of setting |
|
|
998 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
999 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
1000 | |
|
|
1001 | Returns the pid of the subprocess or C<undef> on error. |
|
|
1002 | |
|
|
1003 | =cut |
|
|
1004 | |
|
|
1005 | sub exec_async { |
|
|
1006 | my $self = shift; |
|
|
1007 | |
|
|
1008 | my $pid = fork; |
|
|
1009 | |
|
|
1010 | return $pid |
|
|
1011 | if !defined $pid or $pid; |
|
|
1012 | |
|
|
1013 | %ENV = %{ $self->env }; |
|
|
1014 | |
|
|
1015 | exec @_; |
|
|
1016 | urxvt::_exit 255; |
|
|
1017 | } |
|
|
1018 | |
876 | =item $isset = $term->option ($optval[, $set]) |
1019 | =item $isset = $term->option ($optval[, $set]) |
877 | |
1020 | |
878 | Returns true if the option specified by C<$optval> is enabled, and |
1021 | Returns true if the option specified by C<$optval> is enabled, and |
879 | optionally change it. All option values are stored by name in the hash |
1022 | optionally change it. All option values are stored by name in the hash |
880 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1023 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
… | |
… | |
882 | Here is a a likely non-exhaustive list of option names, please see the |
1025 | Here is a a likely non-exhaustive list of option names, please see the |
883 | source file F</src/optinc.h> to see the actual list: |
1026 | source file F</src/optinc.h> to see the actual list: |
884 | |
1027 | |
885 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1028 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
886 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1029 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
887 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1030 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
888 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1031 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
889 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1032 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
890 | tripleclickwords utmpInhibit visualBell |
1033 | transparent tripleclickwords utmpInhibit visualBell |
891 | |
1034 | |
892 | =item $value = $term->resource ($name[, $newval]) |
1035 | =item $value = $term->resource ($name[, $newval]) |
893 | |
1036 | |
894 | Returns the current resource value associated with a given name and |
1037 | Returns the current resource value associated with a given name and |
895 | optionally sets a new value. Setting values is most useful in the C<init> |
1038 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
912 | |
1055 | |
913 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1056 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
914 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1057 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
915 | display_name embed ext_bwidth fade font geometry hold iconName |
1058 | display_name embed ext_bwidth fade font geometry hold iconName |
916 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1059 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
917 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1060 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
918 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1061 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
919 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1062 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
920 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1063 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
921 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1064 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
922 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1065 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
923 | shade term_name title transparent transparent_all tripleclickwords |
1066 | secondaryScreen secondaryScroll selectstyle shade term_name title |
924 | utmpInhibit visualBell |
1067 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
|
|
1068 | visualBell |
925 | |
1069 | |
926 | =cut |
1070 | =cut |
927 | |
1071 | |
928 | sub resource($$;$) { |
1072 | sub resource($$;$) { |
929 | my ($self, $name) = (shift, shift); |
1073 | my ($self, $name) = (shift, shift); |
… | |
… | |
1130 | |
1274 | |
1131 | =item $windowid = $term->vt |
1275 | =item $windowid = $term->vt |
1132 | |
1276 | |
1133 | Return the window id of the terminal window. |
1277 | Return the window id of the terminal window. |
1134 | |
1278 | |
|
|
1279 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1280 | |
|
|
1281 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1282 | to receive pointer events all the times: |
|
|
1283 | |
|
|
1284 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1285 | |
1135 | =item $window_width = $term->width |
1286 | =item $window_width = $term->width |
1136 | |
1287 | |
1137 | =item $window_height = $term->height |
1288 | =item $window_height = $term->height |
1138 | |
1289 | |
1139 | =item $font_width = $term->fwidth |
1290 | =item $font_width = $term->fwidth |
… | |
… | |
1152 | |
1303 | |
1153 | =item $max_scrollback = $term->saveLines |
1304 | =item $max_scrollback = $term->saveLines |
1154 | |
1305 | |
1155 | =item $nrow_plus_saveLines = $term->total_rows |
1306 | =item $nrow_plus_saveLines = $term->total_rows |
1156 | |
1307 | |
1157 | =item $lines_in_scrollback = $term->nsaved |
1308 | =item $topmost_scrollback_row = $term->top_row |
1158 | |
1309 | |
1159 | Return various integers describing terminal characteristics. |
1310 | Return various integers describing terminal characteristics. |
1160 | |
1311 | |
1161 | =item $x_display = $term->display_id |
1312 | =item $x_display = $term->display_id |
1162 | |
1313 | |
… | |
… | |
1190 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1341 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1191 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1342 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1192 | |
1343 | |
1193 | =item $view_start = $term->view_start ([$newvalue]) |
1344 | =item $view_start = $term->view_start ([$newvalue]) |
1194 | |
1345 | |
1195 | Returns the negative row number of the topmost line. Minimum value is |
1346 | Returns the row number of the topmost displayed line. Maximum value is |
1196 | C<0>, which displays the normal terminal contents. Larger values scroll |
1347 | C<0>, which displays the normal terminal contents. Lower values scroll |
1197 | this many lines into the scrollback buffer. |
1348 | this many lines into the scrollback buffer. |
1198 | |
1349 | |
1199 | =item $term->want_refresh |
1350 | =item $term->want_refresh |
1200 | |
1351 | |
1201 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1352 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1514 | my $env = $self->{term}->env; |
1665 | my $env = $self->{term}->env; |
1515 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1666 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1516 | delete $env->{LC_ALL}; |
1667 | delete $env->{LC_ALL}; |
1517 | $env->{LC_CTYPE} = $self->{term}->locale; |
1668 | $env->{LC_CTYPE} = $self->{term}->locale; |
1518 | |
1669 | |
1519 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1670 | urxvt::term->new ($env, "popup", |
1520 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1671 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
1672 | "-pty-fd" => -1, "-sl" => 0, |
|
|
1673 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1521 | "--transient-for" => $self->{term}->parent, |
1674 | "--transient-for" => $self->{term}->parent, |
1522 | "-display" => $self->{term}->display_id, |
1675 | "-display" => $self->{term}->display_id, |
1523 | "-pe" => "urxvt-popup") |
1676 | "-pe" => "urxvt-popup") |
1524 | or die "unable to create popup window\n"; |
1677 | or die "unable to create popup window\n"; |
1525 | } |
1678 | } |
… | |
… | |
1530 | delete $self->{term}{_destroy}{$self}; |
1683 | delete $self->{term}{_destroy}{$self}; |
1531 | $self->{term}->ungrab; |
1684 | $self->{term}->ungrab; |
1532 | } |
1685 | } |
1533 | |
1686 | |
1534 | =back |
1687 | =back |
|
|
1688 | |
|
|
1689 | =cut |
|
|
1690 | |
|
|
1691 | package urxvt::watcher; |
|
|
1692 | |
|
|
1693 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1694 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1695 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1696 | @urxvt::iw::ISA = __PACKAGE__; |
1535 | |
1697 | |
1536 | =head2 The C<urxvt::timer> Class |
1698 | =head2 The C<urxvt::timer> Class |
1537 | |
1699 | |
1538 | This class implements timer watchers/events. Time is represented as a |
1700 | This class implements timer watchers/events. Time is represented as a |
1539 | fractional number of seconds since the epoch. Example: |
1701 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1577 | Start the timer. |
1739 | Start the timer. |
1578 | |
1740 | |
1579 | =item $timer = $timer->start ($tstamp) |
1741 | =item $timer = $timer->start ($tstamp) |
1580 | |
1742 | |
1581 | Set the event trigger time to C<$tstamp> and start the timer. |
1743 | Set the event trigger time to C<$tstamp> and start the timer. |
|
|
1744 | |
|
|
1745 | =item $timer = $timer->after ($delay) |
|
|
1746 | |
|
|
1747 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1582 | |
1748 | |
1583 | =item $timer = $timer->stop |
1749 | =item $timer = $timer->stop |
1584 | |
1750 | |
1585 | Stop the timer. |
1751 | Stop the timer. |
1586 | |
1752 | |
… | |
… | |
1633 | |
1799 | |
1634 | Stop watching for events on the given filehandle. |
1800 | Stop watching for events on the given filehandle. |
1635 | |
1801 | |
1636 | =back |
1802 | =back |
1637 | |
1803 | |
|
|
1804 | =head2 The C<urxvt::iw> Class |
|
|
1805 | |
|
|
1806 | This class implements idle watchers, that get called automatically when |
|
|
1807 | the process is idle. They should return as fast as possible, after doing |
|
|
1808 | some useful work. |
|
|
1809 | |
|
|
1810 | =over 4 |
|
|
1811 | |
|
|
1812 | =item $iw = new urxvt::iw |
|
|
1813 | |
|
|
1814 | Create a new idle watcher object in stopped state. |
|
|
1815 | |
|
|
1816 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1817 | |
|
|
1818 | Set the callback to be called when the watcher triggers. |
|
|
1819 | |
|
|
1820 | =item $timer = $timer->start |
|
|
1821 | |
|
|
1822 | Start the watcher. |
|
|
1823 | |
|
|
1824 | =item $timer = $timer->stop |
|
|
1825 | |
|
|
1826 | Stop the watcher. |
|
|
1827 | |
|
|
1828 | =back |
|
|
1829 | |
|
|
1830 | =head2 The C<urxvt::pw> Class |
|
|
1831 | |
|
|
1832 | This class implements process watchers. They create an event whenever a |
|
|
1833 | process exits, after which they stop automatically. |
|
|
1834 | |
|
|
1835 | my $pid = fork; |
|
|
1836 | ... |
|
|
1837 | $term->{pw} = urxvt::pw |
|
|
1838 | ->new |
|
|
1839 | ->start ($pid) |
|
|
1840 | ->cb (sub { |
|
|
1841 | my ($pw, $exit_status) = @_; |
|
|
1842 | ... |
|
|
1843 | }); |
|
|
1844 | |
|
|
1845 | =over 4 |
|
|
1846 | |
|
|
1847 | =item $pw = new urxvt::pw |
|
|
1848 | |
|
|
1849 | Create a new process watcher in stopped state. |
|
|
1850 | |
|
|
1851 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1852 | |
|
|
1853 | Set the callback to be called when the timer triggers. |
|
|
1854 | |
|
|
1855 | =item $pw = $timer->start ($pid) |
|
|
1856 | |
|
|
1857 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
1858 | |
|
|
1859 | =item $pw = $pw->stop |
|
|
1860 | |
|
|
1861 | Stop the watcher. |
|
|
1862 | |
|
|
1863 | =back |
|
|
1864 | |
1638 | =head1 ENVIRONMENT |
1865 | =head1 ENVIRONMENT |
1639 | |
1866 | |
1640 | =head2 URXVT_PERL_VERBOSITY |
1867 | =head2 URXVT_PERL_VERBOSITY |
1641 | |
1868 | |
1642 | This variable controls the verbosity level of the perl extension. Higher |
1869 | This variable controls the verbosity level of the perl extension. Higher |