… | |
… | |
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 | |
… | |
… | |
63 | the match. For example, the followign adds a regex that matches everything |
67 | the match. For example, the followign adds a regex that matches everything |
64 | between two vertical bars: |
68 | between two vertical bars: |
65 | |
69 | |
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
67 | |
71 | |
|
|
72 | Another example: Programs I use often output "absolute path: " at the |
|
|
73 | beginning of a line when they process multiple files. The following |
|
|
74 | pattern matches the filename (note, there is a single space at the very |
|
|
75 | end): |
|
|
76 | |
|
|
77 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
|
|
78 | |
68 | You can look at the source of the selection extension to see more |
79 | 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. |
80 | interesting uses, such as parsing a line from beginning to end. |
70 | |
81 | |
71 | This extension also offers following bindable keyboard commands: |
82 | This extension also offers following bindable keyboard commands: |
72 | |
83 | |
… | |
… | |
87 | |
98 | |
88 | =item selection-popup (enabled by default) |
99 | =item selection-popup (enabled by default) |
89 | |
100 | |
90 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
101 | 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 |
102 | text into various other formats/action (such as uri unescaping, perl |
92 | evalution, web-browser starting etc.), depending on content. |
103 | evaluation, web-browser starting etc.), depending on content. |
93 | |
104 | |
94 | Other extensions can extend this popup menu by pushing a code reference onto |
105 | Other extensions can extend this popup menu by pushing a code reference |
95 | C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed. |
106 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
|
|
107 | popup is displayed. |
96 | |
108 | |
97 | It's sole argument is the popup menu, which can be modified. The selection |
109 | It's sole argument is the popup menu, which can be modified. The selection |
98 | is in C<$_>, which can be used to decide wether to add something or not. |
110 | is in C<$_>, which can be used to decide wether to add something or not. |
99 | It should either return nothing or a string and a code reference. The |
111 | It should either return nothing or a string and a code reference. The |
100 | string will be used as button text and the code reference will be called |
112 | string will be used as button text and the code reference will be called |
… | |
… | |
102 | |
114 | |
103 | The following will add an entry C<a to b> that transforms all C<a>s in |
115 | The following will add an entry C<a to b> that transforms all C<a>s in |
104 | the selection to C<b>s, but only if the selection currently contains any |
116 | the selection to C<b>s, but only if the selection currently contains any |
105 | C<a>s: |
117 | C<a>s: |
106 | |
118 | |
107 | push urxvt::ext::selection_popup::hook, sub { |
119 | push @{ $self->{term}{selection_popup_hook} }, sub { |
108 | /a/ ? ("a to be" => sub { s/a/b/g } |
120 | /a/ ? ("a to be" => sub { s/a/b/g } |
109 | : () |
121 | : () |
110 | }; |
122 | }; |
111 | |
123 | |
112 | =item searchable-scrollback<hotkey> (enabled by default) |
124 | =item searchable-scrollback<hotkey> (enabled by default) |
… | |
… | |
122 | bottom. C<Escape> leaves search mode and returns to the point where search |
134 | bottom. C<Escape> leaves search mode and returns to the point where search |
123 | was started, while C<Enter> or C<Return> stay at the current position and |
135 | was started, while C<Enter> or C<Return> stay at the current position and |
124 | additionally stores the first match in the current line into the primary |
136 | additionally stores the first match in the current line into the primary |
125 | selection. |
137 | selection. |
126 | |
138 | |
|
|
139 | =item readline (enabled by default) |
|
|
140 | |
|
|
141 | A support package that tries to make editing with readline easier. At the |
|
|
142 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
143 | move the text cursor to this position. It does so by generating as many |
|
|
144 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
145 | for programs that correctly support wide characters). |
|
|
146 | |
|
|
147 | To avoid too many false positives, this is only done when: |
|
|
148 | |
|
|
149 | =over 4 |
|
|
150 | |
|
|
151 | =item - the tty is in ICANON state. |
|
|
152 | |
|
|
153 | =item - the text cursor is visible. |
|
|
154 | |
|
|
155 | =item - the primary screen is currently being displayed. |
|
|
156 | |
|
|
157 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
158 | |
|
|
159 | =back |
|
|
160 | |
|
|
161 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
162 | might interfere with selection creation in harmless ways. |
|
|
163 | |
127 | =item selection-autotransform |
164 | =item selection-autotransform |
128 | |
165 | |
129 | This selection allows you to do automatic transforms on a selection |
166 | This selection allows you to do automatic transforms on a selection |
130 | whenever a selection is made. |
167 | whenever a selection is made. |
131 | |
168 | |
… | |
… | |
143 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
180 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
144 | |
181 | |
145 | And this example matches the same,but replaces it with vi-commands you can |
182 | And this example matches the same,but replaces it with vi-commands you can |
146 | paste directly into your (vi :) editor: |
183 | paste directly into your (vi :) editor: |
147 | |
184 | |
148 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
185 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
149 | |
186 | |
150 | Of course, this can be modified to suit your needs and your editor :) |
187 | Of course, this can be modified to suit your needs and your editor :) |
151 | |
188 | |
152 | To expand the example above to typical perl error messages ("XXX at |
189 | To expand the example above to typical perl error messages ("XXX at |
153 | FILENAME line YYY."), you need a slightly more elaborate solution: |
190 | FILENAME line YYY."), you need a slightly more elaborate solution: |
154 | |
191 | |
155 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
192 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
156 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
193 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
157 | |
194 | |
158 | The first line tells the selection code to treat the unchanging part of |
195 | The first line tells the selection code to treat the unchanging part of |
159 | every error message as a selection pattern, and the second line transforms |
196 | every error message as a selection pattern, and the second line transforms |
160 | the message into vi commands to load the file. |
197 | the message into vi commands to load the file. |
|
|
198 | |
|
|
199 | =item tabbed |
|
|
200 | |
|
|
201 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
202 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
|
|
203 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
204 | button per tab. |
|
|
205 | |
|
|
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
207 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
208 | while B<Shift-Down> creates a new tab. |
161 | |
209 | |
162 | =item mark-urls |
210 | =item mark-urls |
163 | |
211 | |
164 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
212 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
165 | make them clickable. When middle-clicked, the program specified in the |
213 | make them clickable. When middle-clicked, the program specified in the |
166 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
214 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
167 | the URL as first argument. |
215 | the URL as first argument. |
168 | |
216 | |
|
|
217 | =item xim-onthespot |
|
|
218 | |
|
|
219 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
220 | not work perfectly, and some input methods don't seem to work well with |
|
|
221 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
222 | kinput2. |
|
|
223 | |
|
|
224 | You enable it by specifying this extension and a preedit style of |
|
|
225 | C<OnTheSpot>, i.e.: |
|
|
226 | |
|
|
227 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
228 | |
169 | =item automove-background |
229 | =item automove-background |
170 | |
230 | |
171 | This is basically a one-line extension that dynamically changes the background pixmap offset |
231 | This is basically a one-line extension that dynamically changes the background pixmap offset |
172 | to the window position, in effect creating the same effect as pseudo transparency with |
232 | to the window position, in effect creating the same effect as pseudo transparency with |
173 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
233 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
… | |
… | |
182 | |
242 | |
183 | =item digital-clock |
243 | =item digital-clock |
184 | |
244 | |
185 | Displays a digital clock using the built-in overlay. |
245 | Displays a digital clock using the built-in overlay. |
186 | |
246 | |
187 | =item example-refresh-hooks |
247 | =item remote-clipboard |
188 | |
248 | |
189 | Displays a very simple digital clock in the upper right corner of the |
249 | Somewhat of a misnomer, this extension adds two menu entries to the |
190 | window. Illustrates overwriting the refresh callbacks to create your own |
250 | selection popup that allows one ti run external commands to store the |
191 | overlays or changes. |
251 | selection somewhere and fetch it again. |
|
|
252 | |
|
|
253 | We use it to implement a "distributed selection mechanism", which just |
|
|
254 | means that one command uploads the file to a remote server, and another |
|
|
255 | reads it. |
|
|
256 | |
|
|
257 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
258 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
259 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
260 | the selection data on STDOUT (also in UTF-8). |
|
|
261 | |
|
|
262 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
263 | |
|
|
264 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
265 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
192 | |
266 | |
193 | =item selection-pastebin |
267 | =item selection-pastebin |
194 | |
268 | |
195 | This is a little rarely useful extension that Uploads the selection as |
269 | This is a little rarely useful extension that Uploads the selection as |
196 | textfile to a remote site (or does other things). (The implementation is |
270 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
216 | After a successful upload the selection will be replaced by the text given |
290 | After a successful upload the selection will be replaced by the text given |
217 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
291 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
218 | for the filename): |
292 | for the filename): |
219 | |
293 | |
220 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
294 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
295 | |
|
|
296 | =item example-refresh-hooks |
|
|
297 | |
|
|
298 | Displays a very simple digital clock in the upper right corner of the |
|
|
299 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
300 | overlays or changes. |
221 | |
301 | |
222 | =back |
302 | =back |
223 | |
303 | |
224 | =head1 API DOCUMENTATION |
304 | =head1 API DOCUMENTATION |
225 | |
305 | |
… | |
… | |
298 | called whenever the relevant event happens. |
378 | called whenever the relevant event happens. |
299 | |
379 | |
300 | The first argument passed to them is an extension oject as described in |
380 | The first argument passed to them is an extension oject as described in |
301 | the in the C<Extension Objects> section. |
381 | the in the C<Extension Objects> section. |
302 | |
382 | |
303 | B<All> of these hooks must return a boolean value. If it is true, then the |
383 | B<All> of these hooks must return a boolean value. If any of the called |
304 | event counts as being I<consumed>, and the invocation of other hooks is |
384 | hooks returns true, then the event counts as being I<consumed>, and the |
305 | skipped, and the relevant action might not be carried out by the C++ code. |
385 | relevant action might not be carried out by the C++ code. |
306 | |
386 | |
307 | I<< When in doubt, return a false value (preferably C<()>). >> |
387 | I<< When in doubt, return a false value (preferably C<()>). >> |
308 | |
388 | |
309 | =over 4 |
389 | =over 4 |
310 | |
390 | |
311 | =item on_init $term |
391 | =item on_init $term |
312 | |
392 | |
313 | Called after a new terminal object has been initialized, but before |
393 | Called after a new terminal object has been initialized, but before |
314 | windows are created or the command gets run. Most methods are unsafe to |
394 | windows are created or the command gets run. Most methods are unsafe to |
315 | call or deliver senseless data, as terminal size and other characteristics |
395 | call or deliver senseless data, as terminal size and other characteristics |
316 | have not yet been determined. You can safely query and change resources, |
396 | have not yet been determined. You can safely query and change resources |
317 | though. |
397 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
398 | place. |
|
|
399 | |
|
|
400 | =item on_start $term |
|
|
401 | |
|
|
402 | Called at the very end of initialisation of a new terminal, just before |
|
|
403 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
404 | |
|
|
405 | =item on_destroy $term |
|
|
406 | |
|
|
407 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
408 | still fully functional (not for long, though). |
318 | |
409 | |
319 | =item on_reset $term |
410 | =item on_reset $term |
320 | |
411 | |
321 | Called after the screen is "reset" for any reason, such as resizing or |
412 | Called after the screen is "reset" for any reason, such as resizing or |
322 | control sequences. Here is where you can react on changes to size-related |
413 | control sequences. Here is where you can react on changes to size-related |
323 | variables. |
414 | variables. |
324 | |
415 | |
325 | =item on_start $term |
416 | =item on_child_start $term, $pid |
326 | |
417 | |
327 | Called at the very end of initialisation of a new terminal, just before |
418 | Called just after the child process has been C<fork>ed. |
328 | returning to the mainloop. |
419 | |
|
|
420 | =item on_child_exit $term, $status |
|
|
421 | |
|
|
422 | Called just after the child process has exited. C<$status> is the status |
|
|
423 | from C<waitpid>. |
329 | |
424 | |
330 | =item on_sel_make $term, $eventtime |
425 | =item on_sel_make $term, $eventtime |
331 | |
426 | |
332 | Called whenever a selection has been made by the user, but before the |
427 | Called whenever a selection has been made by the user, but before the |
333 | selection text is copied, so changes to the beginning, end or type of the |
428 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
420 | |
515 | |
421 | =item on_refresh_end $term |
516 | =item on_refresh_end $term |
422 | |
517 | |
423 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
518 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
424 | |
519 | |
425 | =item on_keyboard_command $term, $string |
520 | =item on_user_command $term, $string |
426 | |
521 | |
427 | Called whenever the user presses a key combination that has a |
522 | Called whenever the a user-configured event is being activated (e.g. via |
428 | C<perl:string> action bound to it (see description of the B<keysym> |
523 | a C<perl:string> action bound to a key, see description of the B<keysym> |
429 | resource in the @@RXVT_NAME@@(1) manpage). |
524 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
525 | |
|
|
526 | The event is simply the action string. This interface is assumed to change |
|
|
527 | slightly in the future. |
430 | |
528 | |
431 | =item on_x_event $term, $event |
529 | =item on_x_event $term, $event |
432 | |
530 | |
433 | Called on every X event received on the vt window (and possibly other |
531 | Called on every X event received on the vt window (and possibly other |
434 | windows). Should only be used as a last resort. Most event structure |
532 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
444 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
542 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
445 | focus out processing. |
543 | focus out processing. |
446 | |
544 | |
447 | =item on_configure_notify $term, $event |
545 | =item on_configure_notify $term, $event |
448 | |
546 | |
|
|
547 | =item on_property_notify $term, $event |
|
|
548 | |
449 | =item on_key_press $term, $event, $keysym, $octets |
549 | =item on_key_press $term, $event, $keysym, $octets |
450 | |
550 | |
451 | =item on_key_release $term, $event, $keysym |
551 | =item on_key_release $term, $event, $keysym |
452 | |
552 | |
453 | =item on_button_press $term, $event |
553 | =item on_button_press $term, $event |
… | |
… | |
462 | |
562 | |
463 | Called whenever the corresponding X event is received for the terminal If |
563 | Called whenever the corresponding X event is received for the terminal If |
464 | the hook returns true, then the even will be ignored by rxvt-unicode. |
564 | the hook returns true, then the even will be ignored by rxvt-unicode. |
465 | |
565 | |
466 | The event is a hash with most values as named by Xlib (see the XEvent |
566 | The event is a hash with most values as named by Xlib (see the XEvent |
467 | manpage), with the additional members C<row> and C<col>, which are the row |
567 | manpage), with the additional members C<row> and C<col>, which are the |
468 | and column under the mouse cursor. |
568 | (real, not screen-based) row and column under the mouse cursor. |
469 | |
569 | |
470 | C<on_key_press> additionally receives the string rxvt-unicode would |
570 | C<on_key_press> additionally receives the string rxvt-unicode would |
471 | output, if any, in locale-specific encoding. |
571 | output, if any, in locale-specific encoding. |
472 | |
572 | |
473 | subwindow. |
573 | subwindow. |
|
|
574 | |
|
|
575 | =item on_client_message $term, $event |
|
|
576 | |
|
|
577 | =item on_wm_protocols $term, $event |
|
|
578 | |
|
|
579 | =item on_wm_delete_window $term, $event |
|
|
580 | |
|
|
581 | Called when various types of ClientMessage events are received (all with |
|
|
582 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
474 | |
583 | |
475 | =back |
584 | =back |
476 | |
585 | |
477 | =cut |
586 | =cut |
478 | |
587 | |
… | |
… | |
484 | use Scalar::Util (); |
593 | use Scalar::Util (); |
485 | use List::Util (); |
594 | use List::Util (); |
486 | |
595 | |
487 | our $VERSION = 1; |
596 | our $VERSION = 1; |
488 | our $TERM; |
597 | our $TERM; |
|
|
598 | our @TERM_INIT; |
|
|
599 | our @TERM_EXT; |
489 | our @HOOKNAME; |
600 | our @HOOKNAME; |
490 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
601 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
491 | our %OPTION; |
602 | our %OPTION; |
492 | |
603 | |
493 | our $LIBDIR; |
604 | our $LIBDIR; |
494 | our $RESNAME; |
605 | our $RESNAME; |
495 | our $RESCLASS; |
606 | our $RESCLASS; |
496 | our $RXVTNAME; |
607 | our $RXVTNAME; |
497 | |
608 | |
|
|
609 | our $NOCHAR = chr 0xffff; |
|
|
610 | |
498 | =head2 Variables in the C<urxvt> Package |
611 | =head2 Variables in the C<urxvt> Package |
499 | |
612 | |
500 | =over 4 |
613 | =over 4 |
501 | |
614 | |
502 | =item $urxvt::LIBDIR |
615 | =item $urxvt::LIBDIR |
… | |
… | |
514 | |
627 | |
515 | =item $urxvt::TERM |
628 | =item $urxvt::TERM |
516 | |
629 | |
517 | The current terminal. This variable stores the current C<urxvt::term> |
630 | The current terminal. This variable stores the current C<urxvt::term> |
518 | object, whenever a callback/hook is executing. |
631 | object, whenever a callback/hook is executing. |
|
|
632 | |
|
|
633 | =item @urxvt::TERM_INIT |
|
|
634 | |
|
|
635 | All coderefs in this array will be called as methods of the next newly |
|
|
636 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
637 | gets cleared before the codereferences that were in it are being executed, |
|
|
638 | so coderefs can push themselves onto it again if they so desire. |
|
|
639 | |
|
|
640 | This complements to the perl-eval commandline option, but gets executed |
|
|
641 | first. |
|
|
642 | |
|
|
643 | =item @urxvt::TERM_EXT |
|
|
644 | |
|
|
645 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
646 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
647 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
519 | |
648 | |
520 | =back |
649 | =back |
521 | |
650 | |
522 | =head2 Functions in the C<urxvt> Package |
651 | =head2 Functions in the C<urxvt> Package |
523 | |
652 | |
… | |
… | |
630 | my $msg = join "", @_; |
759 | my $msg = join "", @_; |
631 | $msg .= "\n" |
760 | $msg .= "\n" |
632 | unless $msg =~ /\n$/; |
761 | unless $msg =~ /\n$/; |
633 | urxvt::warn ($msg); |
762 | urxvt::warn ($msg); |
634 | }; |
763 | }; |
635 | |
|
|
636 | # %ENV is the original startup environment |
|
|
637 | delete $ENV{IFS}; |
|
|
638 | delete $ENV{CDPATH}; |
|
|
639 | delete $ENV{BASH_ENV}; |
|
|
640 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
641 | } |
764 | } |
|
|
765 | |
|
|
766 | no warnings 'utf8'; |
642 | |
767 | |
643 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
768 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
644 | |
769 | |
645 | sub verbose { |
770 | sub verbose { |
646 | my ($level, $msg) = @_; |
771 | my ($level, $msg) = @_; |
… | |
… | |
650 | my %extension_pkg; |
775 | my %extension_pkg; |
651 | |
776 | |
652 | # load a single script into its own package, once only |
777 | # load a single script into its own package, once only |
653 | sub extension_package($) { |
778 | sub extension_package($) { |
654 | my ($path) = @_; |
779 | my ($path) = @_; |
655 | |
|
|
656 | no strict 'refs'; |
|
|
657 | |
780 | |
658 | $extension_pkg{$path} ||= do { |
781 | $extension_pkg{$path} ||= do { |
659 | $path =~ /([^\/\\]+)$/; |
782 | $path =~ /([^\/\\]+)$/; |
660 | my $pkg = $1; |
783 | my $pkg = $1; |
661 | $pkg =~ s/[^[:word:]]/_/g; |
784 | $pkg =~ s/[^[:word:]]/_/g; |
… | |
… | |
664 | verbose 3, "loading extension '$path' into package '$pkg'"; |
787 | verbose 3, "loading extension '$path' into package '$pkg'"; |
665 | |
788 | |
666 | open my $fh, "<:raw", $path |
789 | open my $fh, "<:raw", $path |
667 | or die "$path: $!"; |
790 | or die "$path: $!"; |
668 | |
791 | |
669 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
670 | |
|
|
671 | my $source = |
792 | my $source = |
672 | "package $pkg; use strict; use utf8;\n" |
793 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
673 | . "#line 1 \"$path\"\n{\n" |
794 | . "#line 1 \"$path\"\n{\n" |
674 | . (do { local $/; <$fh> }) |
795 | . (do { local $/; <$fh> }) |
675 | . "\n};\n1"; |
796 | . "\n};\n1"; |
676 | |
797 | |
677 | eval $source |
798 | eval $source |
… | |
… | |
691 | if ($htype == 0) { # INIT |
812 | if ($htype == 0) { # INIT |
692 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
813 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
693 | |
814 | |
694 | my %ext_arg; |
815 | my %ext_arg; |
695 | |
816 | |
|
|
817 | { |
|
|
818 | my @init = @TERM_INIT; |
|
|
819 | @TERM_INIT = (); |
|
|
820 | $_->($TERM) for @init; |
|
|
821 | my @pkg = @TERM_EXT; |
|
|
822 | @TERM_EXT = (); |
|
|
823 | $TERM->register_package ($_) for @pkg; |
|
|
824 | } |
|
|
825 | |
696 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
826 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
697 | if ($_ eq "default") { |
827 | if ($_ eq "default") { |
698 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
828 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
699 | } elsif (/^-(.*)$/) { |
829 | } elsif (/^-(.*)$/) { |
700 | delete $ext_arg{$1}; |
830 | delete $ext_arg{$1}; |
701 | } elsif (/^([^<]+)<(.*)>$/) { |
831 | } elsif (/^([^<]+)<(.*)>$/) { |
702 | push @{ $ext_arg{$1} }, $2; |
832 | push @{ $ext_arg{$1} }, $2; |
703 | } else { |
833 | } else { |
… | |
… | |
726 | if $verbosity >= 10; |
856 | if $verbosity >= 10; |
727 | |
857 | |
728 | keys %$cb; |
858 | keys %$cb; |
729 | |
859 | |
730 | while (my ($pkg, $cb) = each %$cb) { |
860 | while (my ($pkg, $cb) = each %$cb) { |
731 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
861 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
732 | and last; |
862 | $retval ||= $retval_; |
733 | |
863 | |
734 | if ($@) { |
864 | if ($@) { |
735 | $TERM->ungrab; # better to lose the grab than the session |
865 | $TERM->ungrab; # better to lose the grab than the session |
736 | warn $@; |
866 | warn $@; |
737 | } |
867 | } |
… | |
… | |
748 | # clear package |
878 | # clear package |
749 | %$TERM = (); |
879 | %$TERM = (); |
750 | } |
880 | } |
751 | |
881 | |
752 | $retval |
882 | $retval |
753 | } |
|
|
754 | |
|
|
755 | sub exec_async(@) { |
|
|
756 | my $pid = fork; |
|
|
757 | |
|
|
758 | return |
|
|
759 | if !defined $pid or $pid; |
|
|
760 | |
|
|
761 | %ENV = %{ $TERM->env }; |
|
|
762 | |
|
|
763 | exec @_; |
|
|
764 | _exit 255; |
|
|
765 | } |
883 | } |
766 | |
884 | |
767 | # urxvt::term::extension |
885 | # urxvt::term::extension |
768 | |
886 | |
769 | package urxvt::term::extension; |
887 | package urxvt::term::extension; |
… | |
… | |
908 | # find on_xxx subs in the package and register them |
1026 | # find on_xxx subs in the package and register them |
909 | # as hooks |
1027 | # as hooks |
910 | sub register_package { |
1028 | sub register_package { |
911 | my ($self, $pkg, $argv) = @_; |
1029 | my ($self, $pkg, $argv) = @_; |
912 | |
1030 | |
|
|
1031 | no strict 'refs'; |
|
|
1032 | |
|
|
1033 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
1034 | |
|
|
1035 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
1036 | |
913 | my $proxy = bless { |
1037 | my $proxy = bless { |
914 | _pkg => $pkg, |
1038 | _pkg => $pkg, |
915 | argv => $argv, |
1039 | argv => $argv, |
916 | }, $pkg; |
1040 | }, $pkg; |
917 | Scalar::Util::weaken ($proxy->{term} = $self); |
1041 | Scalar::Util::weaken ($proxy->{term} = $self); |
… | |
… | |
947 | =item $term->destroy |
1071 | =item $term->destroy |
948 | |
1072 | |
949 | Destroy the terminal object (close the window, free resources |
1073 | Destroy the terminal object (close the window, free resources |
950 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1074 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
951 | watchers (timers, io watchers) are still active. |
1075 | watchers (timers, io watchers) are still active. |
|
|
1076 | |
|
|
1077 | =item $term->exec_async ($cmd[, @args]) |
|
|
1078 | |
|
|
1079 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
1080 | ("starts") programs in the background. This function takes care of setting |
|
|
1081 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
1082 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
1083 | |
|
|
1084 | Returns the pid of the subprocess or C<undef> on error. |
|
|
1085 | |
|
|
1086 | =cut |
|
|
1087 | |
|
|
1088 | sub exec_async { |
|
|
1089 | my $self = shift; |
|
|
1090 | |
|
|
1091 | my $pid = fork; |
|
|
1092 | |
|
|
1093 | return $pid |
|
|
1094 | if !defined $pid or $pid; |
|
|
1095 | |
|
|
1096 | %ENV = %{ $self->env }; |
|
|
1097 | |
|
|
1098 | exec @_; |
|
|
1099 | urxvt::_exit 255; |
|
|
1100 | } |
952 | |
1101 | |
953 | =item $isset = $term->option ($optval[, $set]) |
1102 | =item $isset = $term->option ($optval[, $set]) |
954 | |
1103 | |
955 | Returns true if the option specified by C<$optval> is enabled, and |
1104 | Returns true if the option specified by C<$optval> is enabled, and |
956 | optionally change it. All option values are stored by name in the hash |
1105 | optionally change it. All option values are stored by name in the hash |
… | |
… | |
1181 | |
1330 | |
1182 | Normally its not a good idea to use this function, as programs might be |
1331 | Normally its not a good idea to use this function, as programs might be |
1183 | confused by changes in cursor position or scrolling. Its useful inside a |
1332 | confused by changes in cursor position or scrolling. Its useful inside a |
1184 | C<on_add_lines> hook, though. |
1333 | C<on_add_lines> hook, though. |
1185 | |
1334 | |
|
|
1335 | =item $term->scr_change_screen ($screen) |
|
|
1336 | |
|
|
1337 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1338 | |
1186 | =item $term->cmd_parse ($octets) |
1339 | =item $term->cmd_parse ($octets) |
1187 | |
1340 | |
1188 | Similar to C<scr_add_lines>, but the argument must be in the |
1341 | Similar to C<scr_add_lines>, but the argument must be in the |
1189 | locale-specific encoding of the terminal and can contain command sequences |
1342 | locale-specific encoding of the terminal and can contain command sequences |
1190 | (escape codes) that will be interpreted. |
1343 | (escape codes) that will be interpreted. |
… | |
… | |
1199 | |
1352 | |
1200 | Replaces the event mask of the pty watcher by the given event mask. Can |
1353 | Replaces the event mask of the pty watcher by the given event mask. Can |
1201 | be used to suppress input and output handling to the pty/tty. See the |
1354 | be used to suppress input and output handling to the pty/tty. See the |
1202 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1355 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1203 | the previous value. |
1356 | the previous value. |
|
|
1357 | |
|
|
1358 | =item $fd = $term->pty_fd |
|
|
1359 | |
|
|
1360 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1361 | is used. |
1204 | |
1362 | |
1205 | =item $windowid = $term->parent |
1363 | =item $windowid = $term->parent |
1206 | |
1364 | |
1207 | Return the window id of the toplevel window. |
1365 | Return the window id of the toplevel window. |
1208 | |
1366 | |
… | |
… | |
1273 | =item $modifiermask = $term->ModNumLockMask |
1431 | =item $modifiermask = $term->ModNumLockMask |
1274 | |
1432 | |
1275 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1433 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1276 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1434 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1277 | |
1435 | |
|
|
1436 | =item $screen = $term->current_screen |
|
|
1437 | |
|
|
1438 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1439 | |
|
|
1440 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1441 | |
|
|
1442 | Returns wether the cursor is currently hidden or not. |
|
|
1443 | |
1278 | =item $view_start = $term->view_start ([$newvalue]) |
1444 | =item $view_start = $term->view_start ([$newvalue]) |
1279 | |
1445 | |
1280 | Returns the row number of the topmost displayed line. Maximum value is |
1446 | Returns the row number of the topmost displayed line. Maximum value is |
1281 | C<0>, which displays the normal terminal contents. Lower values scroll |
1447 | C<0>, which displays the normal terminal contents. Lower values scroll |
1282 | this many lines into the scrollback buffer. |
1448 | this many lines into the scrollback buffer. |
… | |
… | |
1301 | line, starting at column C<$start_col> (default C<0>), which is useful |
1467 | line, starting at column C<$start_col> (default C<0>), which is useful |
1302 | to replace only parts of a line. The font index in the rendition will |
1468 | to replace only parts of a line. The font index in the rendition will |
1303 | automatically be updated. |
1469 | automatically be updated. |
1304 | |
1470 | |
1305 | C<$text> is in a special encoding: tabs and wide characters that use more |
1471 | C<$text> is in a special encoding: tabs and wide characters that use more |
1306 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1472 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1307 | (C<chr 65535>). Characters with combining characters and other characters |
1473 | characters. Characters with combining characters and other characters that |
1308 | that do not fit into the normal tetx encoding will be replaced with |
1474 | do not fit into the normal tetx encoding will be replaced with characters |
1309 | characters in the private use area. |
1475 | in the private use area. |
1310 | |
1476 | |
1311 | You have to obey this encoding when changing text. The advantage is |
1477 | You have to obey this encoding when changing text. The advantage is |
1312 | that C<substr> and similar functions work on screen cells and not on |
1478 | that C<substr> and similar functions work on screen cells and not on |
1313 | characters. |
1479 | characters. |
1314 | |
1480 | |
… | |
… | |
1489 | |
1655 | |
1490 | Calls XUngrab for the most recent grab. Is called automatically on |
1656 | Calls XUngrab for the most recent grab. Is called automatically on |
1491 | evaluation errors, as it is better to lose the grab in the error case as |
1657 | evaluation errors, as it is better to lose the grab in the error case as |
1492 | the session. |
1658 | the session. |
1493 | |
1659 | |
|
|
1660 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1661 | |
|
|
1662 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1663 | |
|
|
1664 | =item @atoms = $term->XListProperties ($window) |
|
|
1665 | |
|
|
1666 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1667 | |
|
|
1668 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1669 | |
|
|
1670 | =item $term->XDeleteProperty ($window, $property) |
|
|
1671 | |
|
|
1672 | =item $window = $term->DefaultRootWindow |
|
|
1673 | |
|
|
1674 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1675 | |
|
|
1676 | =item $term->XMapWindow ($window) |
|
|
1677 | |
|
|
1678 | =item $term->XUnmapWindow ($window) |
|
|
1679 | |
|
|
1680 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1681 | |
|
|
1682 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1683 | |
|
|
1684 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1685 | |
|
|
1686 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1687 | the source of the display, otherwise those functions map more-or-less |
|
|
1688 | directory onto the X functions of the same name. |
|
|
1689 | |
1494 | =back |
1690 | =back |
1495 | |
1691 | |
1496 | =cut |
1692 | =cut |
1497 | |
1693 | |
1498 | package urxvt::popup; |
1694 | package urxvt::popup; |
… | |
… | |
1601 | delete $env->{LC_ALL}; |
1797 | delete $env->{LC_ALL}; |
1602 | $env->{LC_CTYPE} = $self->{term}->locale; |
1798 | $env->{LC_CTYPE} = $self->{term}->locale; |
1603 | |
1799 | |
1604 | urxvt::term->new ($env, "popup", |
1800 | urxvt::term->new ($env, "popup", |
1605 | "--perl-lib" => "", "--perl-ext-common" => "", |
1801 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
1802 | "-pty-fd" => -1, "-sl" => 0, |
1606 | "-pty-fd" => -1, "-sl" => 0, "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1803 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1607 | "--transient-for" => $self->{term}->parent, |
1804 | "--transient-for" => $self->{term}->parent, |
1608 | "-display" => $self->{term}->display_id, |
1805 | "-display" => $self->{term}->display_id, |
1609 | "-pe" => "urxvt-popup") |
1806 | "-pe" => "urxvt-popup") |
1610 | or die "unable to create popup window\n"; |
1807 | or die "unable to create popup window\n"; |
1611 | } |
1808 | } |
… | |
… | |
1616 | delete $self->{term}{_destroy}{$self}; |
1813 | delete $self->{term}{_destroy}{$self}; |
1617 | $self->{term}->ungrab; |
1814 | $self->{term}->ungrab; |
1618 | } |
1815 | } |
1619 | |
1816 | |
1620 | =back |
1817 | =back |
|
|
1818 | |
|
|
1819 | =cut |
|
|
1820 | |
|
|
1821 | package urxvt::watcher; |
|
|
1822 | |
|
|
1823 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1824 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1825 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1826 | @urxvt::iw::ISA = __PACKAGE__; |
1621 | |
1827 | |
1622 | =head2 The C<urxvt::timer> Class |
1828 | =head2 The C<urxvt::timer> Class |
1623 | |
1829 | |
1624 | This class implements timer watchers/events. Time is represented as a |
1830 | This class implements timer watchers/events. Time is represented as a |
1625 | fractional number of seconds since the epoch. Example: |
1831 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1723 | |
1929 | |
1724 | Stop watching for events on the given filehandle. |
1930 | Stop watching for events on the given filehandle. |
1725 | |
1931 | |
1726 | =back |
1932 | =back |
1727 | |
1933 | |
|
|
1934 | =head2 The C<urxvt::iw> Class |
|
|
1935 | |
|
|
1936 | This class implements idle watchers, that get called automatically when |
|
|
1937 | the process is idle. They should return as fast as possible, after doing |
|
|
1938 | some useful work. |
|
|
1939 | |
|
|
1940 | =over 4 |
|
|
1941 | |
|
|
1942 | =item $iw = new urxvt::iw |
|
|
1943 | |
|
|
1944 | Create a new idle watcher object in stopped state. |
|
|
1945 | |
|
|
1946 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1947 | |
|
|
1948 | Set the callback to be called when the watcher triggers. |
|
|
1949 | |
|
|
1950 | =item $timer = $timer->start |
|
|
1951 | |
|
|
1952 | Start the watcher. |
|
|
1953 | |
|
|
1954 | =item $timer = $timer->stop |
|
|
1955 | |
|
|
1956 | Stop the watcher. |
|
|
1957 | |
|
|
1958 | =back |
|
|
1959 | |
|
|
1960 | =head2 The C<urxvt::pw> Class |
|
|
1961 | |
|
|
1962 | This class implements process watchers. They create an event whenever a |
|
|
1963 | process exits, after which they stop automatically. |
|
|
1964 | |
|
|
1965 | my $pid = fork; |
|
|
1966 | ... |
|
|
1967 | $term->{pw} = urxvt::pw |
|
|
1968 | ->new |
|
|
1969 | ->start ($pid) |
|
|
1970 | ->cb (sub { |
|
|
1971 | my ($pw, $exit_status) = @_; |
|
|
1972 | ... |
|
|
1973 | }); |
|
|
1974 | |
|
|
1975 | =over 4 |
|
|
1976 | |
|
|
1977 | =item $pw = new urxvt::pw |
|
|
1978 | |
|
|
1979 | Create a new process watcher in stopped state. |
|
|
1980 | |
|
|
1981 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1982 | |
|
|
1983 | Set the callback to be called when the timer triggers. |
|
|
1984 | |
|
|
1985 | =item $pw = $timer->start ($pid) |
|
|
1986 | |
|
|
1987 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
1988 | |
|
|
1989 | =item $pw = $pw->stop |
|
|
1990 | |
|
|
1991 | Stop the watcher. |
|
|
1992 | |
|
|
1993 | =back |
|
|
1994 | |
1728 | =head1 ENVIRONMENT |
1995 | =head1 ENVIRONMENT |
1729 | |
1996 | |
1730 | =head2 URXVT_PERL_VERBOSITY |
1997 | =head2 URXVT_PERL_VERBOSITY |
1731 | |
1998 | |
1732 | This variable controls the verbosity level of the perl extension. Higher |
1999 | This variable controls the verbosity level of the perl extension. Higher |