… | |
… | |
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 | |
… | |
… | |
87 | |
91 | |
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 | 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 | }; |
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 |
… | |
… | |
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<filename:number>, often seen in compiler messages, into C<vi +$filename |
145 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
123 | $word>: |
146 | $word>: |
124 | |
147 | |
125 | URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
148 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
126 | |
149 | |
127 | 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 |
128 | paste directly into your (vi :) editor: |
151 | paste directly into your (vi :) editor: |
129 | |
152 | |
130 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\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. |
|
|
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. |
131 | |
177 | |
132 | =item mark-urls |
178 | =item mark-urls |
133 | |
179 | |
134 | 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 |
135 | make them clickable. When middle-clicked, the program specified in the |
181 | make them clickable. When middle-clicked, the program specified in the |
136 | 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 |
137 | the URL as first argument. |
183 | the URL as first argument. |
138 | |
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 | |
139 | =item block-graphics-to-ascii |
193 | =item block-graphics-to-ascii |
140 | |
194 | |
141 | 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, |
142 | 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 |
143 | similar-looking ascii character. |
197 | similar-looking ascii character. |
… | |
… | |
149 | =item example-refresh-hooks |
203 | =item example-refresh-hooks |
150 | |
204 | |
151 | 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 |
152 | window. Illustrates overwriting the refresh callbacks to create your own |
206 | window. Illustrates overwriting the refresh callbacks to create your own |
153 | 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/% |
154 | |
237 | |
155 | =back |
238 | =back |
156 | |
239 | |
157 | =head1 API DOCUMENTATION |
240 | =head1 API DOCUMENTATION |
158 | |
241 | |
… | |
… | |
231 | called whenever the relevant event happens. |
314 | called whenever the relevant event happens. |
232 | |
315 | |
233 | 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 |
234 | the in the C<Extension Objects> section. |
317 | the in the C<Extension Objects> section. |
235 | |
318 | |
236 | 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 |
237 | 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 |
238 | 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. |
239 | |
322 | |
240 | I<< When in doubt, return a false value (preferably C<()>). >> |
323 | I<< When in doubt, return a false value (preferably C<()>). >> |
241 | |
324 | |
242 | =over 4 |
325 | =over 4 |
243 | |
326 | |
244 | =item on_init $term |
327 | =item on_init $term |
245 | |
328 | |
246 | Called after a new terminal object has been initialized, but before |
329 | Called after a new terminal object has been initialized, but before |
247 | 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 |
248 | call or deliver senseless data, as terminal size and other characteristics |
331 | call or deliver senseless data, as terminal size and other characteristics |
249 | 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 |
250 | 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. |
251 | |
346 | |
252 | =item on_reset $term |
347 | =item on_reset $term |
253 | |
348 | |
254 | 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 |
255 | 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 |
256 | variables. |
351 | variables. |
257 | |
352 | |
258 | =item on_start $term |
353 | =item on_child_start $term, $pid |
259 | |
354 | |
260 | 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. |
261 | 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>. |
262 | |
361 | |
263 | =item on_sel_make $term, $eventtime |
362 | =item on_sel_make $term, $eventtime |
264 | |
363 | |
265 | 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 |
266 | 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 |
… | |
… | |
359 | |
458 | |
360 | Called whenever the user presses a key combination that has a |
459 | Called whenever the user presses a key combination that has a |
361 | C<perl:string> action bound to it (see description of the B<keysym> |
460 | C<perl:string> action bound to it (see description of the B<keysym> |
362 | resource in the @@RXVT_NAME@@(1) manpage). |
461 | resource in the @@RXVT_NAME@@(1) manpage). |
363 | |
462 | |
|
|
463 | =item on_x_event $term, $event |
|
|
464 | |
|
|
465 | Called on every X event received on the vt window (and possibly other |
|
|
466 | windows). Should only be used as a last resort. Most event structure |
|
|
467 | members are not passed. |
|
|
468 | |
364 | =item on_focus_in $term |
469 | =item on_focus_in $term |
365 | |
470 | |
366 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
471 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
367 | does focus in processing. |
472 | does focus in processing. |
368 | |
473 | |
369 | =item on_focus_out $term |
474 | =item on_focus_out $term |
370 | |
475 | |
371 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
476 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
372 | focus out processing. |
477 | focus out processing. |
|
|
478 | |
|
|
479 | =item on_configure_notify $term, $event |
|
|
480 | |
|
|
481 | =item on_property_notify $term, $event |
373 | |
482 | |
374 | =item on_key_press $term, $event, $keysym, $octets |
483 | =item on_key_press $term, $event, $keysym, $octets |
375 | |
484 | |
376 | =item on_key_release $term, $event, $keysym |
485 | =item on_key_release $term, $event, $keysym |
377 | |
486 | |
… | |
… | |
394 | |
503 | |
395 | C<on_key_press> additionally receives the string rxvt-unicode would |
504 | C<on_key_press> additionally receives the string rxvt-unicode would |
396 | output, if any, in locale-specific encoding. |
505 | output, if any, in locale-specific encoding. |
397 | |
506 | |
398 | 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). |
399 | |
517 | |
400 | =back |
518 | =back |
401 | |
519 | |
402 | =cut |
520 | =cut |
403 | |
521 | |
… | |
… | |
409 | use Scalar::Util (); |
527 | use Scalar::Util (); |
410 | use List::Util (); |
528 | use List::Util (); |
411 | |
529 | |
412 | our $VERSION = 1; |
530 | our $VERSION = 1; |
413 | our $TERM; |
531 | our $TERM; |
|
|
532 | our @TERM_INIT; |
|
|
533 | our @TERM_EXT; |
414 | our @HOOKNAME; |
534 | our @HOOKNAME; |
415 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
535 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
416 | our %OPTION; |
536 | our %OPTION; |
417 | |
537 | |
418 | our $LIBDIR; |
538 | our $LIBDIR; |
… | |
… | |
440 | =item $urxvt::TERM |
560 | =item $urxvt::TERM |
441 | |
561 | |
442 | The current terminal. This variable stores the current C<urxvt::term> |
562 | The current terminal. This variable stores the current C<urxvt::term> |
443 | object, whenever a callback/hook is executing. |
563 | object, whenever a callback/hook is executing. |
444 | |
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 | |
445 | =back |
581 | =back |
446 | |
582 | |
447 | =head2 Functions in the C<urxvt> Package |
583 | =head2 Functions in the C<urxvt> Package |
448 | |
584 | |
449 | =over 4 |
585 | =over 4 |
… | |
… | |
463 | 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 |
464 | correct place, e.g. on stderr of the connecting urxvtc client. |
600 | correct place, e.g. on stderr of the connecting urxvtc client. |
465 | |
601 | |
466 | Messages have a size limit of 1023 bytes currently. |
602 | Messages have a size limit of 1023 bytes currently. |
467 | |
603 | |
468 | =item $is_safe = urxvt::safe |
|
|
469 | |
|
|
470 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
471 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
472 | started setuid or setgid. |
|
|
473 | |
|
|
474 | =item $time = urxvt::NOW |
604 | =item $time = urxvt::NOW |
475 | |
605 | |
476 | Returns the "current time" (as per the event loop). |
606 | Returns the "current time" (as per the event loop). |
477 | |
607 | |
478 | =item urxvt::CurrentTime |
608 | =item urxvt::CurrentTime |
479 | |
609 | |
480 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
610 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
481 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
611 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
482 | Button4Mask, Button5Mask, AnyModifier |
612 | Button4Mask, Button5Mask, AnyModifier |
|
|
613 | |
|
|
614 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
615 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
616 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
617 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
618 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
619 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
620 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
621 | |
|
|
622 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
623 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
624 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
625 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
626 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
627 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
628 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
483 | |
629 | |
484 | Various constants for use in X calls and event processing. |
630 | Various constants for use in X calls and event processing. |
485 | |
631 | |
486 | =back |
632 | =back |
487 | |
633 | |
… | |
… | |
538 | =back |
684 | =back |
539 | |
685 | |
540 | =cut |
686 | =cut |
541 | |
687 | |
542 | BEGIN { |
688 | BEGIN { |
543 | urxvt->bootstrap; |
|
|
544 | |
|
|
545 | # overwrite perl's warn |
689 | # overwrite perl's warn |
546 | *CORE::GLOBAL::warn = sub { |
690 | *CORE::GLOBAL::warn = sub { |
547 | my $msg = join "", @_; |
691 | my $msg = join "", @_; |
548 | $msg .= "\n" |
692 | $msg .= "\n" |
549 | unless $msg =~ /\n$/; |
693 | unless $msg =~ /\n$/; |
550 | urxvt::warn ($msg); |
694 | urxvt::warn ($msg); |
551 | }; |
695 | }; |
552 | |
|
|
553 | # %ENV is the original startup environment |
|
|
554 | delete $ENV{IFS}; |
|
|
555 | delete $ENV{CDPATH}; |
|
|
556 | delete $ENV{BASH_ENV}; |
|
|
557 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
558 | } |
696 | } |
559 | |
697 | |
560 | my @hook_count; |
|
|
561 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
698 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
562 | |
699 | |
563 | sub verbose { |
700 | sub verbose { |
564 | my ($level, $msg) = @_; |
701 | my ($level, $msg) = @_; |
565 | warn "$msg\n" if $level <= $verbosity; |
702 | warn "$msg\n" if $level <= $verbosity; |
566 | } |
703 | } |
567 | |
704 | |
568 | my $extension_pkg = "extension0000"; |
|
|
569 | my %extension_pkg; |
705 | my %extension_pkg; |
570 | |
706 | |
571 | # load a single script into its own package, once only |
707 | # load a single script into its own package, once only |
572 | sub extension_package($) { |
708 | sub extension_package($) { |
573 | my ($path) = @_; |
709 | my ($path) = @_; |
574 | |
710 | |
575 | $extension_pkg{$path} ||= do { |
711 | $extension_pkg{$path} ||= do { |
576 | my $pkg = "urxvt::" . ($extension_pkg++); |
712 | $path =~ /([^\/\\]+)$/; |
|
|
713 | my $pkg = $1; |
|
|
714 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
715 | $pkg = "urxvt::ext::$pkg"; |
577 | |
716 | |
578 | verbose 3, "loading extension '$path' into package '$pkg'"; |
717 | verbose 3, "loading extension '$path' into package '$pkg'"; |
579 | |
718 | |
580 | open my $fh, "<:raw", $path |
719 | open my $fh, "<:raw", $path |
581 | or die "$path: $!"; |
720 | or die "$path: $!"; |
582 | |
721 | |
583 | my $source = untaint |
722 | my $source = |
584 | "package $pkg; use strict; use utf8;\n" |
723 | "package $pkg; use strict; use utf8;\n" |
585 | . "use base urxvt::term::extension::;\n" |
|
|
586 | . "#line 1 \"$path\"\n{\n" |
724 | . "#line 1 \"$path\"\n{\n" |
587 | . (do { local $/; <$fh> }) |
725 | . (do { local $/; <$fh> }) |
588 | . "\n};\n1"; |
726 | . "\n};\n1"; |
589 | |
727 | |
590 | eval $source |
728 | eval $source |
… | |
… | |
604 | if ($htype == 0) { # INIT |
742 | if ($htype == 0) { # INIT |
605 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
743 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
606 | |
744 | |
607 | my %ext_arg; |
745 | my %ext_arg; |
608 | |
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 | |
609 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
756 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
610 | if ($_ eq "default") { |
757 | if ($_ eq "default") { |
611 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
758 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
612 | } elsif (/^-(.*)$/) { |
759 | } elsif (/^-(.*)$/) { |
613 | delete $ext_arg{$1}; |
760 | delete $ext_arg{$1}; |
614 | } elsif (/^([^<]+)<(.*)>$/) { |
761 | } elsif (/^([^<]+)<(.*)>$/) { |
… | |
… | |
639 | if $verbosity >= 10; |
786 | if $verbosity >= 10; |
640 | |
787 | |
641 | keys %$cb; |
788 | keys %$cb; |
642 | |
789 | |
643 | while (my ($pkg, $cb) = each %$cb) { |
790 | while (my ($pkg, $cb) = each %$cb) { |
644 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
791 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
645 | and last; |
792 | $retval ||= $retval_; |
646 | |
793 | |
647 | if ($@) { |
794 | if ($@) { |
648 | $TERM->ungrab; # better to lose the grab than the session |
795 | $TERM->ungrab; # better to lose the grab than the session |
649 | warn $@; |
796 | warn $@; |
650 | } |
797 | } |
… | |
… | |
653 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
800 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
654 | if $verbosity >= 11; |
801 | if $verbosity >= 11; |
655 | } |
802 | } |
656 | |
803 | |
657 | if ($htype == 1) { # DESTROY |
804 | if ($htype == 1) { # DESTROY |
658 | if (my $hook = delete $TERM->{_hook}) { |
|
|
659 | for my $htype (0..$#$hook) { |
|
|
660 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
661 | or set_should_invoke $htype, 0; |
|
|
662 | } |
|
|
663 | } |
|
|
664 | |
|
|
665 | # clear package objects |
805 | # clear package objects |
666 | %$_ = () for values %{ $TERM->{_pkg} }; |
806 | %$_ = () for values %{ $TERM->{_pkg} }; |
667 | |
807 | |
668 | # clear package |
808 | # clear package |
669 | %$TERM = (); |
809 | %$TERM = (); |
670 | } |
810 | } |
671 | |
811 | |
672 | $retval |
812 | $retval |
673 | } |
|
|
674 | |
|
|
675 | sub exec_async(@) { |
|
|
676 | my $pid = fork; |
|
|
677 | |
|
|
678 | return |
|
|
679 | if !defined $pid or $pid; |
|
|
680 | |
|
|
681 | %ENV = %{ $TERM->env }; |
|
|
682 | |
|
|
683 | exec @_; |
|
|
684 | _exit 255; |
|
|
685 | } |
813 | } |
686 | |
814 | |
687 | # urxvt::term::extension |
815 | # urxvt::term::extension |
688 | |
816 | |
689 | package urxvt::term::extension; |
817 | package urxvt::term::extension; |
… | |
… | |
695 | while (my ($name, $cb) = each %hook) { |
823 | while (my ($name, $cb) = each %hook) { |
696 | my $htype = $HOOKTYPE{uc $name}; |
824 | my $htype = $HOOKTYPE{uc $name}; |
697 | defined $htype |
825 | defined $htype |
698 | or Carp::croak "unsupported hook type '$name'"; |
826 | or Carp::croak "unsupported hook type '$name'"; |
699 | |
827 | |
|
|
828 | $self->set_should_invoke ($htype, +1) |
700 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
829 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
701 | $hook_count[$htype]++ |
|
|
702 | or urxvt::set_should_invoke $htype, 1; |
|
|
703 | } |
|
|
704 | |
830 | |
705 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
831 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
706 | } |
832 | } |
707 | } |
833 | } |
708 | |
834 | |
… | |
… | |
713 | for my $name (@hook) { |
839 | for my $name (@hook) { |
714 | my $htype = $HOOKTYPE{uc $name}; |
840 | my $htype = $HOOKTYPE{uc $name}; |
715 | defined $htype |
841 | defined $htype |
716 | or Carp::croak "unsupported hook type '$name'"; |
842 | or Carp::croak "unsupported hook type '$name'"; |
717 | |
843 | |
|
|
844 | $self->set_should_invoke ($htype, -1) |
718 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
845 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
719 | --$hook_count[$htype] |
|
|
720 | or urxvt::set_should_invoke $htype, 0; |
|
|
721 | } |
|
|
722 | } |
846 | } |
723 | } |
847 | } |
724 | |
848 | |
725 | our $AUTOLOAD; |
849 | our $AUTOLOAD; |
726 | |
850 | |
… | |
… | |
832 | # find on_xxx subs in the package and register them |
956 | # find on_xxx subs in the package and register them |
833 | # as hooks |
957 | # as hooks |
834 | sub register_package { |
958 | sub register_package { |
835 | my ($self, $pkg, $argv) = @_; |
959 | my ($self, $pkg, $argv) = @_; |
836 | |
960 | |
|
|
961 | no strict 'refs'; |
|
|
962 | |
|
|
963 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
964 | |
|
|
965 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
966 | |
837 | my $proxy = bless { |
967 | my $proxy = bless { |
838 | _pkg => $pkg, |
968 | _pkg => $pkg, |
839 | argv => $argv, |
969 | argv => $argv, |
840 | }, $pkg; |
970 | }, $pkg; |
841 | Scalar::Util::weaken ($proxy->{term} = $self); |
971 | Scalar::Util::weaken ($proxy->{term} = $self); |
… | |
… | |
872 | |
1002 | |
873 | Destroy the terminal object (close the window, free resources |
1003 | Destroy the terminal object (close the window, free resources |
874 | 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 |
875 | watchers (timers, io watchers) are still active. |
1005 | watchers (timers, io watchers) are still active. |
876 | |
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 | |
877 | =item $isset = $term->option ($optval[, $set]) |
1032 | =item $isset = $term->option ($optval[, $set]) |
878 | |
1033 | |
879 | 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 |
880 | 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 |
881 | 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. |
… | |
… | |
883 | 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 |
884 | source file F</src/optinc.h> to see the actual list: |
1039 | source file F</src/optinc.h> to see the actual list: |
885 | |
1040 | |
886 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1041 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
887 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1042 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
888 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1043 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
889 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1044 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
890 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1045 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
891 | tripleclickwords utmpInhibit visualBell |
1046 | transparent tripleclickwords utmpInhibit visualBell |
892 | |
1047 | |
893 | =item $value = $term->resource ($name[, $newval]) |
1048 | =item $value = $term->resource ($name[, $newval]) |
894 | |
1049 | |
895 | Returns the current resource value associated with a given name and |
1050 | Returns the current resource value associated with a given name and |
896 | 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> |
… | |
… | |
913 | |
1068 | |
914 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1069 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
915 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1070 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
916 | display_name embed ext_bwidth fade font geometry hold iconName |
1071 | display_name embed ext_bwidth fade font geometry hold iconName |
917 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1072 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
918 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1073 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
919 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1074 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
920 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1075 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
921 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1076 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
922 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1077 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
923 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1078 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
924 | shade term_name title transparent transparent_all tripleclickwords |
1079 | secondaryScreen secondaryScroll selectstyle shade term_name title |
925 | utmpInhibit visualBell |
1080 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
|
|
1081 | visualBell |
926 | |
1082 | |
927 | =cut |
1083 | =cut |
928 | |
1084 | |
929 | sub resource($$;$) { |
1085 | sub resource($$;$) { |
930 | my ($self, $name) = (shift, shift); |
1086 | my ($self, $name) = (shift, shift); |
… | |
… | |
1131 | |
1287 | |
1132 | =item $windowid = $term->vt |
1288 | =item $windowid = $term->vt |
1133 | |
1289 | |
1134 | Return the window id of the terminal window. |
1290 | Return the window id of the terminal window. |
1135 | |
1291 | |
|
|
1292 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1293 | |
|
|
1294 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1295 | to receive pointer events all the times: |
|
|
1296 | |
|
|
1297 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1298 | |
1136 | =item $window_width = $term->width |
1299 | =item $window_width = $term->width |
1137 | |
1300 | |
1138 | =item $window_height = $term->height |
1301 | =item $window_height = $term->height |
1139 | |
1302 | |
1140 | =item $font_width = $term->fwidth |
1303 | =item $font_width = $term->fwidth |
… | |
… | |
1153 | |
1316 | |
1154 | =item $max_scrollback = $term->saveLines |
1317 | =item $max_scrollback = $term->saveLines |
1155 | |
1318 | |
1156 | =item $nrow_plus_saveLines = $term->total_rows |
1319 | =item $nrow_plus_saveLines = $term->total_rows |
1157 | |
1320 | |
1158 | =item $lines_in_scrollback = $term->nsaved |
1321 | =item $topmost_scrollback_row = $term->top_row |
1159 | |
1322 | |
1160 | Return various integers describing terminal characteristics. |
1323 | Return various integers describing terminal characteristics. |
1161 | |
1324 | |
1162 | =item $x_display = $term->display_id |
1325 | =item $x_display = $term->display_id |
1163 | |
1326 | |
… | |
… | |
1191 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1354 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1192 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1355 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1193 | |
1356 | |
1194 | =item $view_start = $term->view_start ([$newvalue]) |
1357 | =item $view_start = $term->view_start ([$newvalue]) |
1195 | |
1358 | |
1196 | Returns the negative row number of the topmost line. Minimum value is |
1359 | Returns the row number of the topmost displayed line. Maximum value is |
1197 | C<0>, which displays the normal terminal contents. Larger values scroll |
1360 | C<0>, which displays the normal terminal contents. Lower values scroll |
1198 | this many lines into the scrollback buffer. |
1361 | this many lines into the scrollback buffer. |
1199 | |
1362 | |
1200 | =item $term->want_refresh |
1363 | =item $term->want_refresh |
1201 | |
1364 | |
1202 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1365 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1515 | my $env = $self->{term}->env; |
1678 | my $env = $self->{term}->env; |
1516 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1679 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1517 | delete $env->{LC_ALL}; |
1680 | delete $env->{LC_ALL}; |
1518 | $env->{LC_CTYPE} = $self->{term}->locale; |
1681 | $env->{LC_CTYPE} = $self->{term}->locale; |
1519 | |
1682 | |
1520 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1683 | urxvt::term->new ($env, "popup", |
1521 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1684 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
1685 | "-pty-fd" => -1, "-sl" => 0, |
|
|
1686 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1522 | "--transient-for" => $self->{term}->parent, |
1687 | "--transient-for" => $self->{term}->parent, |
1523 | "-display" => $self->{term}->display_id, |
1688 | "-display" => $self->{term}->display_id, |
1524 | "-pe" => "urxvt-popup") |
1689 | "-pe" => "urxvt-popup") |
1525 | or die "unable to create popup window\n"; |
1690 | or die "unable to create popup window\n"; |
1526 | } |
1691 | } |
… | |
… | |
1531 | delete $self->{term}{_destroy}{$self}; |
1696 | delete $self->{term}{_destroy}{$self}; |
1532 | $self->{term}->ungrab; |
1697 | $self->{term}->ungrab; |
1533 | } |
1698 | } |
1534 | |
1699 | |
1535 | =back |
1700 | =back |
|
|
1701 | |
|
|
1702 | =cut |
|
|
1703 | |
|
|
1704 | package urxvt::watcher; |
|
|
1705 | |
|
|
1706 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1707 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1708 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1709 | @urxvt::iw::ISA = __PACKAGE__; |
1536 | |
1710 | |
1537 | =head2 The C<urxvt::timer> Class |
1711 | =head2 The C<urxvt::timer> Class |
1538 | |
1712 | |
1539 | This class implements timer watchers/events. Time is represented as a |
1713 | This class implements timer watchers/events. Time is represented as a |
1540 | fractional number of seconds since the epoch. Example: |
1714 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1578 | Start the timer. |
1752 | Start the timer. |
1579 | |
1753 | |
1580 | =item $timer = $timer->start ($tstamp) |
1754 | =item $timer = $timer->start ($tstamp) |
1581 | |
1755 | |
1582 | Set the event trigger time to C<$tstamp> and start the timer. |
1756 | Set the event trigger time to C<$tstamp> and start the timer. |
|
|
1757 | |
|
|
1758 | =item $timer = $timer->after ($delay) |
|
|
1759 | |
|
|
1760 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1583 | |
1761 | |
1584 | =item $timer = $timer->stop |
1762 | =item $timer = $timer->stop |
1585 | |
1763 | |
1586 | Stop the timer. |
1764 | Stop the timer. |
1587 | |
1765 | |
… | |
… | |
1634 | |
1812 | |
1635 | Stop watching for events on the given filehandle. |
1813 | Stop watching for events on the given filehandle. |
1636 | |
1814 | |
1637 | =back |
1815 | =back |
1638 | |
1816 | |
|
|
1817 | =head2 The C<urxvt::iw> Class |
|
|
1818 | |
|
|
1819 | This class implements idle watchers, that get called automatically when |
|
|
1820 | the process is idle. They should return as fast as possible, after doing |
|
|
1821 | some useful work. |
|
|
1822 | |
|
|
1823 | =over 4 |
|
|
1824 | |
|
|
1825 | =item $iw = new urxvt::iw |
|
|
1826 | |
|
|
1827 | Create a new idle watcher object in stopped state. |
|
|
1828 | |
|
|
1829 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1830 | |
|
|
1831 | Set the callback to be called when the watcher triggers. |
|
|
1832 | |
|
|
1833 | =item $timer = $timer->start |
|
|
1834 | |
|
|
1835 | Start the watcher. |
|
|
1836 | |
|
|
1837 | =item $timer = $timer->stop |
|
|
1838 | |
|
|
1839 | Stop the watcher. |
|
|
1840 | |
|
|
1841 | =back |
|
|
1842 | |
|
|
1843 | =head2 The C<urxvt::pw> Class |
|
|
1844 | |
|
|
1845 | This class implements process watchers. They create an event whenever a |
|
|
1846 | process exits, after which they stop automatically. |
|
|
1847 | |
|
|
1848 | my $pid = fork; |
|
|
1849 | ... |
|
|
1850 | $term->{pw} = urxvt::pw |
|
|
1851 | ->new |
|
|
1852 | ->start ($pid) |
|
|
1853 | ->cb (sub { |
|
|
1854 | my ($pw, $exit_status) = @_; |
|
|
1855 | ... |
|
|
1856 | }); |
|
|
1857 | |
|
|
1858 | =over 4 |
|
|
1859 | |
|
|
1860 | =item $pw = new urxvt::pw |
|
|
1861 | |
|
|
1862 | Create a new process watcher in stopped state. |
|
|
1863 | |
|
|
1864 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1865 | |
|
|
1866 | Set the callback to be called when the timer triggers. |
|
|
1867 | |
|
|
1868 | =item $pw = $timer->start ($pid) |
|
|
1869 | |
|
|
1870 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
1871 | |
|
|
1872 | =item $pw = $pw->stop |
|
|
1873 | |
|
|
1874 | Stop the watcher. |
|
|
1875 | |
|
|
1876 | =back |
|
|
1877 | |
1639 | =head1 ENVIRONMENT |
1878 | =head1 ENVIRONMENT |
1640 | |
1879 | |
1641 | =head2 URXVT_PERL_VERBOSITY |
1880 | =head2 URXVT_PERL_VERBOSITY |
1642 | |
1881 | |
1643 | This variable controls the verbosity level of the perl extension. Higher |
1882 | This variable controls the verbosity level of the perl extension. Higher |