… | |
… | |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Everytime a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
|
|
30 | |
|
|
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
|
|
32 | and "perl-ext-common" resources to the empty string. |
30 | |
33 | |
31 | =head1 PREPACKAGED EXTENSIONS |
34 | =head1 PREPACKAGED EXTENSIONS |
32 | |
35 | |
33 | This section describes the extensions delivered with this release. You can |
36 | This section describes the extensions delivered with this release. You can |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
37 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
… | |
… | |
62 | URxvt.selection.pattern-1: perl-regex |
65 | URxvt.selection.pattern-1: perl-regex |
63 | ... |
66 | ... |
64 | |
67 | |
65 | The index number (0, 1...) must not have any holes, and each regex must |
68 | The index number (0, 1...) must not have any holes, and each regex must |
66 | contain at least one pair of capturing parentheses, which will be used for |
69 | contain at least one pair of capturing parentheses, which will be used for |
67 | the match. For example, the followign adds a regex that matches everything |
70 | the match. For example, the following adds a regex that matches everything |
68 | between two vertical bars: |
71 | between two vertical bars: |
69 | |
72 | |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
73 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
71 | |
74 | |
72 | Another example: Programs I use often output "absolute path: " at the |
75 | Another example: Programs I use often output "absolute path: " at the |
… | |
… | |
98 | |
101 | |
99 | Other extensions can extend this popup menu by pushing a code reference |
102 | Other extensions can extend this popup menu by pushing a code reference |
100 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
101 | popup is being displayed. |
104 | popup is being displayed. |
102 | |
105 | |
103 | It's sole argument is the popup menu, which can be modified. It should |
106 | Its sole argument is the popup menu, which can be modified. It should |
104 | either return nothing or a string, the initial boolean value and a code |
107 | either return nothing or a string, the initial boolean value and a code |
105 | reference. The string will be used as button text and the code reference |
108 | reference. The string will be used as button text and the code reference |
106 | will be called when the toggle changes, with the new boolean value as |
109 | will be called when the toggle changes, with the new boolean value as |
107 | first argument. |
110 | first argument. |
108 | |
111 | |
… | |
… | |
121 | |
124 | |
122 | Other extensions can extend this popup menu by pushing a code reference |
125 | Other extensions can extend this popup menu by pushing a code reference |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
124 | popup is being displayed. |
127 | popup is being displayed. |
125 | |
128 | |
126 | It's sole argument is the popup menu, which can be modified. The selection |
129 | Its sole argument is the popup menu, which can be modified. The selection |
127 | is in C<$_>, which can be used to decide wether to add something or not. |
130 | is in C<$_>, which can be used to decide whether to add something or not. |
128 | It should either return nothing or a string and a code reference. The |
131 | It should either return nothing or a string and a code reference. The |
129 | string will be used as button text and the code reference will be called |
132 | string will be used as button text and the code reference will be called |
130 | when the button gets activated and should transform C<$_>. |
133 | when the button gets activated and should transform C<$_>. |
131 | |
134 | |
132 | The following will add an entry C<a to b> that transforms all C<a>s in |
135 | The following will add an entry C<a to b> that transforms all C<a>s in |
133 | the selection to C<b>s, but only if the selection currently contains any |
136 | the selection to C<b>s, but only if the selection currently contains any |
134 | C<a>s: |
137 | C<a>s: |
135 | |
138 | |
136 | push @{ $self->{term}{selection_popup_hook} }, sub { |
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
137 | /a/ ? ("a to be" => sub { s/a/b/g } |
140 | /a/ ? ("a to b" => sub { s/a/b/g } |
138 | : () |
141 | : () |
139 | }; |
142 | }; |
140 | |
143 | |
141 | =item searchable-scrollback<hotkey> (enabled by default) |
144 | =item searchable-scrollback<hotkey> (enabled by default) |
142 | |
145 | |
… | |
… | |
149 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
152 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
150 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
153 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
151 | bottom. C<Escape> leaves search mode and returns to the point where search |
154 | bottom. C<Escape> leaves search mode and returns to the point where search |
152 | was started, while C<Enter> or C<Return> stay at the current position and |
155 | was started, while C<Enter> or C<Return> stay at the current position and |
153 | additionally stores the first match in the current line into the primary |
156 | additionally stores the first match in the current line into the primary |
154 | selection. |
157 | selection if the C<Shift> modifier is active. |
|
|
158 | |
|
|
159 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
|
|
160 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
|
|
161 | or simply use an uppercase character which removes the "(?i)" prefix. |
|
|
162 | |
|
|
163 | See L<perlre> for more info about perl regular expression syntax. |
155 | |
164 | |
156 | =item readline (enabled by default) |
165 | =item readline (enabled by default) |
157 | |
166 | |
158 | A support package that tries to make editing with readline easier. At |
167 | A support package that tries to make editing with readline easier. At |
159 | the moment, it reacts to clicking shift-left mouse button by trying to |
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
… | |
… | |
214 | the message into vi commands to load the file. |
223 | the message into vi commands to load the file. |
215 | |
224 | |
216 | =item tabbed |
225 | =item tabbed |
217 | |
226 | |
218 | This transforms the terminal into a tabbar with additional terminals, that |
227 | This transforms the terminal into a tabbar with additional terminals, that |
219 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
228 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
220 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
229 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
221 | button per tab. |
230 | button per tab. |
222 | |
231 | |
223 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
232 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
224 | B<Shift-Right> will switch to the tab left or right of the current one, |
233 | B<Shift-Right> will switch to the tab left or right of the current one, |
… | |
… | |
234 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
243 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
235 | |
244 | |
236 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
245 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
237 | indices. |
246 | indices. |
238 | |
247 | |
239 | =item mark-urls |
248 | =item matcher |
240 | |
249 | |
241 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
250 | Uses per-line display filtering (C<on_line_update>) to underline text |
242 | make them clickable. When middle-clicked, the program specified in the |
251 | matching a certain pattern and make it clickable. When clicked with the |
243 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
252 | mouse button specified in the C<matcher.button> resource (default 2, or |
244 | the URL as first argument. |
253 | middle), the program specified in the C<matcher.launcher> resource |
|
|
254 | (default, the C<urlLauncher> resource, C<sensible-browser>) will be started |
|
|
255 | with the matched text as first argument. The default configuration is |
|
|
256 | suitable for matching URLs and launching a web browser, like the |
|
|
257 | former "mark-urls" extension. |
|
|
258 | |
|
|
259 | The default pattern to match URLs can be overridden with the |
|
|
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
|
|
261 | with numbered patterns, in a manner similar to the "selection" extension. |
|
|
262 | The launcher can also be overridden on a per-pattern basis. |
|
|
263 | |
|
|
264 | It is possible to activate the most recently seen match from the keyboard. |
|
|
265 | Simply bind a keysym to "perl:matcher" as seen in the example below. |
|
|
266 | |
|
|
267 | Example configuration: |
|
|
268 | |
|
|
269 | URxvt.perl-ext: default,matcher |
|
|
270 | URxvt.urlLauncher: sensible-browser |
|
|
271 | URxvt.keysym.C-Delete: perl:matcher |
|
|
272 | URxvt.matcher.button: 1 |
|
|
273 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
274 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
275 | URxvt.matcher.launcher.2: gvim +$2 $1 |
245 | |
276 | |
246 | =item xim-onthespot |
277 | =item xim-onthespot |
247 | |
278 | |
248 | This (experimental) perl extension implements OnTheSpot editing. It does |
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
249 | not work perfectly, and some input methods don't seem to work well with |
280 | not work perfectly, and some input methods don't seem to work well with |
250 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
281 | OnTheSpot editing in general, but it seems to work at least for SCIM and |
251 | kinput2. |
282 | kinput2. |
252 | |
283 | |
253 | You enable it by specifying this extension and a preedit style of |
284 | You enable it by specifying this extension and a preedit style of |
254 | C<OnTheSpot>, i.e.: |
285 | C<OnTheSpot>, i.e.: |
255 | |
286 | |
256 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
287 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
257 | |
288 | |
|
|
289 | =item kuake<hotkey> |
|
|
290 | |
|
|
291 | A very primitive quake-console-like extension. It was inspired by a |
|
|
292 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
293 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
294 | will show or hide itself. Another press of the accelerator key will hide |
|
|
295 | or show it again. |
|
|
296 | |
|
|
297 | Initially, the window will not be shown when using this extension. |
|
|
298 | |
|
|
299 | This is useful if you need a single terminal that is not using any desktop |
|
|
300 | space most of the time but is quickly available at the press of a key. |
|
|
301 | |
|
|
302 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
303 | extension will actually grab a physical key just for this function. |
|
|
304 | |
|
|
305 | If you want a quake-like animation, tell your window manager to do so |
|
|
306 | (fvwm can do it). |
|
|
307 | |
258 | =item automove-background |
308 | =item automove-background |
259 | |
309 | |
260 | This is basically a one-line extension that dynamically changes the background pixmap offset |
310 | This is basically a very small extension that dynamically changes the |
261 | to the window position, in effect creating the same effect as pseudo transparency with |
311 | background pixmap offset to the window position, in effect creating the |
262 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
312 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
313 | supported in this mode. Example: |
263 | |
314 | |
264 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
315 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
265 | |
316 | |
|
|
317 | L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions> |
|
|
318 | shows how this extension can be used to implement an automatically blurred |
|
|
319 | transparent background. |
|
|
320 | |
266 | =item block-graphics-to-ascii |
321 | =item block-graphics-to-ascii |
267 | |
322 | |
268 | A not very useful example of filtering all text output to the terminal, |
323 | A not very useful example of filtering all text output to the terminal |
269 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
324 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
270 | similar-looking ascii character. |
325 | similar-looking ascii character. |
271 | |
326 | |
272 | =item digital-clock |
327 | =item digital-clock |
273 | |
328 | |
274 | Displays a digital clock using the built-in overlay. |
329 | Displays a digital clock using the built-in overlay. |
275 | |
330 | |
276 | =item remote-clipboard |
331 | =item remote-clipboard |
277 | |
332 | |
278 | Somewhat of a misnomer, this extension adds two menu entries to the |
333 | Somewhat of a misnomer, this extension adds two menu entries to the |
279 | selection popup that allows one ti run external commands to store the |
334 | selection popup that allows one to run external commands to store the |
280 | selection somewhere and fetch it again. |
335 | selection somewhere and fetch it again. |
281 | |
336 | |
282 | We use it to implement a "distributed selection mechanism", which just |
337 | We use it to implement a "distributed selection mechanism", which just |
283 | means that one command uploads the file to a remote server, and another |
338 | means that one command uploads the file to a remote server, and another |
284 | reads it. |
339 | reads it. |
… | |
… | |
319 | After a successful upload the selection will be replaced by the text given |
374 | After a successful upload the selection will be replaced by the text given |
320 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
375 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
321 | for the filename): |
376 | for the filename): |
322 | |
377 | |
323 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
378 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
379 | |
|
|
380 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
381 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
382 | which works regardless of wether xrdb is used to parse the resource file |
|
|
383 | or not. |
324 | |
384 | |
325 | =item example-refresh-hooks |
385 | =item example-refresh-hooks |
326 | |
386 | |
327 | Displays a very simple digital clock in the upper right corner of the |
387 | Displays a very simple digital clock in the upper right corner of the |
328 | window. Illustrates overwriting the refresh callbacks to create your own |
388 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
368 | |
428 | |
369 | =back |
429 | =back |
370 | |
430 | |
371 | =head2 Extension Objects |
431 | =head2 Extension Objects |
372 | |
432 | |
373 | Very perl extension is a perl class. A separate perl object is created |
433 | Every perl extension is a perl class. A separate perl object is created |
374 | for each terminal and each extension and passed as the first parameter to |
434 | for each terminal, and each terminal has its own set of extenion objects, |
375 | hooks. So extensions can use their C<$self> object without having to think |
435 | which are passed as the first parameter to hooks. So extensions can use |
376 | about other extensions, with the exception of methods and members that |
436 | their C<$self> object without having to think about clashes with other |
|
|
437 | extensions or other terminals, with the exception of methods and members |
377 | begin with an underscore character C<_>: these are reserved for internal |
438 | that begin with an underscore character C<_>: these are reserved for |
378 | use. |
439 | internal use. |
379 | |
440 | |
380 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
441 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
381 | C<urxvt::term> class on this object. |
442 | C<urxvt::term> class on this object. |
382 | |
443 | |
383 | It has the following methods and data members: |
444 | It has the following methods and data members: |
… | |
… | |
404 | =head2 Hooks |
465 | =head2 Hooks |
405 | |
466 | |
406 | The following subroutines can be declared in extension files, and will be |
467 | The following subroutines can be declared in extension files, and will be |
407 | called whenever the relevant event happens. |
468 | called whenever the relevant event happens. |
408 | |
469 | |
409 | The first argument passed to them is an extension oject as described in |
470 | The first argument passed to them is an extension object as described in |
410 | the in the C<Extension Objects> section. |
471 | the in the C<Extension Objects> section. |
411 | |
472 | |
412 | B<All> of these hooks must return a boolean value. If any of the called |
473 | B<All> of these hooks must return a boolean value. If any of the called |
413 | hooks returns true, then the event counts as being I<consumed>, and the |
474 | hooks returns true, then the event counts as being I<consumed>, and the |
414 | relevant action might not be carried out by the C++ code. |
475 | relevant action might not be carried out by the C++ code. |
… | |
… | |
427 | place. |
488 | place. |
428 | |
489 | |
429 | =item on_start $term |
490 | =item on_start $term |
430 | |
491 | |
431 | Called at the very end of initialisation of a new terminal, just before |
492 | Called at the very end of initialisation of a new terminal, just before |
432 | trying to map (display) the toplevel and returning to the mainloop. |
493 | trying to map (display) the toplevel and returning to the main loop. |
433 | |
494 | |
434 | =item on_destroy $term |
495 | =item on_destroy $term |
435 | |
496 | |
436 | Called whenever something tries to destroy terminal, when the terminal is |
497 | Called whenever something tries to destroy terminal, when the terminal is |
437 | still fully functional (not for long, though). |
498 | still fully functional (not for long, though). |
… | |
… | |
464 | |
525 | |
465 | Called whenever a selection has been copied, but before the selection is |
526 | Called whenever a selection has been copied, but before the selection is |
466 | requested from the server. The selection text can be queried and changed |
527 | requested from the server. The selection text can be queried and changed |
467 | by calling C<< $term->selection >>. |
528 | by calling C<< $term->selection >>. |
468 | |
529 | |
469 | Returning a true value aborts selection grabbing. It will still be hilighted. |
530 | Returning a true value aborts selection grabbing. It will still be highlighted. |
470 | |
531 | |
471 | =item on_sel_extend $term |
532 | =item on_sel_extend $term |
472 | |
533 | |
473 | Called whenever the user tries to extend the selection (e.g. with a double |
534 | Called whenever the user tries to extend the selection (e.g. with a double |
474 | click) and is either supposed to return false (normal operation), or |
535 | click) and is either supposed to return false (normal operation), or |
475 | should extend the selection itelf and return true to suppress the built-in |
536 | should extend the selection itself and return true to suppress the built-in |
476 | processing. This can happen multiple times, as long as the callback |
537 | processing. This can happen multiple times, as long as the callback |
477 | returns true, it will be called on every further click by the user and is |
538 | returns true, it will be called on every further click by the user and is |
478 | supposed to enlarge the selection more and more, if possible. |
539 | supposed to enlarge the selection more and more, if possible. |
479 | |
540 | |
480 | See the F<selection> example extension. |
541 | See the F<selection> example extension. |
481 | |
542 | |
482 | =item on_view_change $term, $offset |
543 | =item on_view_change $term, $offset |
483 | |
544 | |
484 | Called whenever the view offset changes, i..e the user or program |
545 | Called whenever the view offset changes, i.e. the user or program |
485 | scrolls. Offset C<0> means display the normal terminal, positive values |
546 | scrolls. Offset C<0> means display the normal terminal, positive values |
486 | show this many lines of scrollback. |
547 | show this many lines of scrollback. |
487 | |
548 | |
488 | =item on_scroll_back $term, $lines, $saved |
549 | =item on_scroll_back $term, $lines, $saved |
489 | |
550 | |
… | |
… | |
513 | string should start with the extension name and a colon, to distinguish |
574 | string should start with the extension name and a colon, to distinguish |
514 | it from commands for other extensions, and this might be enforced in the |
575 | it from commands for other extensions, and this might be enforced in the |
515 | future. |
576 | future. |
516 | |
577 | |
517 | Be careful not ever to trust (in a security sense) the data you receive, |
578 | Be careful not ever to trust (in a security sense) the data you receive, |
518 | as its source can not easily be controleld (e-mail content, messages from |
579 | as its source can not easily be controlled (e-mail content, messages from |
519 | other users on the same system etc.). |
580 | other users on the same system etc.). |
520 | |
581 | |
521 | =item on_add_lines $term, $string |
582 | =item on_add_lines $term, $string |
522 | |
583 | |
523 | Called whenever text is about to be output, with the text as argument. You |
584 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
556 | |
617 | |
557 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
618 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
558 | |
619 | |
559 | =item on_user_command $term, $string |
620 | =item on_user_command $term, $string |
560 | |
621 | |
561 | Called whenever the a user-configured event is being activated (e.g. via |
622 | Called whenever a user-configured event is being activated (e.g. via |
562 | a C<perl:string> action bound to a key, see description of the B<keysym> |
623 | a C<perl:string> action bound to a key, see description of the B<keysym> |
563 | resource in the @@RXVT_NAME@@(1) manpage). |
624 | resource in the @@RXVT_NAME@@(1) manpage). |
564 | |
625 | |
565 | The event is simply the action string. This interface is assumed to change |
626 | The event is simply the action string. This interface is assumed to change |
566 | slightly in the future. |
627 | slightly in the future. |
567 | |
628 | |
568 | =item on_resize_all_windows $tern, $new_width, $new_height |
629 | =item on_resize_all_windows $tern, $new_width, $new_height |
569 | |
630 | |
570 | Called just after the new window size has been calculcated, but before |
631 | Called just after the new window size has been calculated, but before |
571 | windows are actually being resized or hints are being set. If this hook |
632 | windows are actually being resized or hints are being set. If this hook |
572 | returns TRUE, setting of the window hints is being skipped. |
633 | returns TRUE, setting of the window hints is being skipped. |
573 | |
634 | |
574 | =item on_x_event $term, $event |
635 | =item on_x_event $term, $event |
575 | |
636 | |
576 | Called on every X event received on the vt window (and possibly other |
637 | Called on every X event received on the vt window (and possibly other |
577 | windows). Should only be used as a last resort. Most event structure |
638 | windows). Should only be used as a last resort. Most event structure |
578 | members are not passed. |
639 | members are not passed. |
579 | |
640 | |
|
|
641 | =item on_root_event $term, $event |
|
|
642 | |
|
|
643 | Like C<on_x_event>, but is called for events on the root window. |
|
|
644 | |
580 | =item on_focus_in $term |
645 | =item on_focus_in $term |
581 | |
646 | |
582 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
647 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
583 | does focus in processing. |
648 | does focus in processing. |
584 | |
649 | |
585 | =item on_focus_out $term |
650 | =item on_focus_out $term |
586 | |
651 | |
587 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
652 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
588 | focus out processing. |
653 | focus out processing. |
589 | |
654 | |
590 | =item on_configure_notify $term, $event |
655 | =item on_configure_notify $term, $event |
591 | |
656 | |
592 | =item on_property_notify $term, $event |
657 | =item on_property_notify $term, $event |
… | |
… | |
675 | The current terminal. This variable stores the current C<urxvt::term> |
740 | The current terminal. This variable stores the current C<urxvt::term> |
676 | object, whenever a callback/hook is executing. |
741 | object, whenever a callback/hook is executing. |
677 | |
742 | |
678 | =item @urxvt::TERM_INIT |
743 | =item @urxvt::TERM_INIT |
679 | |
744 | |
680 | All coderefs in this array will be called as methods of the next newly |
745 | All code references in this array will be called as methods of the next newly |
681 | created C<urxvt::term> object (during the C<on_init> phase). The array |
746 | created C<urxvt::term> object (during the C<on_init> phase). The array |
682 | gets cleared before the codereferences that were in it are being executed, |
747 | gets cleared before the code references that were in it are being executed, |
683 | so coderefs can push themselves onto it again if they so desire. |
748 | so references can push themselves onto it again if they so desire. |
684 | |
749 | |
685 | This complements to the perl-eval commandline option, but gets executed |
750 | This complements to the perl-eval command line option, but gets executed |
686 | first. |
751 | first. |
687 | |
752 | |
688 | =item @urxvt::TERM_EXT |
753 | =item @urxvt::TERM_EXT |
689 | |
754 | |
690 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
755 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
715 | Messages have a size limit of 1023 bytes currently. |
780 | Messages have a size limit of 1023 bytes currently. |
716 | |
781 | |
717 | =item @terms = urxvt::termlist |
782 | =item @terms = urxvt::termlist |
718 | |
783 | |
719 | Returns all urxvt::term objects that exist in this process, regardless of |
784 | Returns all urxvt::term objects that exist in this process, regardless of |
720 | wether they are started, being destroyed etc., so be careful. Only term |
785 | whether they are started, being destroyed etc., so be careful. Only term |
721 | objects that have perl extensions attached will be returned (because there |
786 | objects that have perl extensions attached will be returned (because there |
722 | is no urxvt::term objet associated with others). |
787 | is no urxvt::term objet associated with others). |
723 | |
788 | |
724 | =item $time = urxvt::NOW |
789 | =item $time = urxvt::NOW |
725 | |
790 | |
… | |
… | |
863 | local $TERM = shift; |
928 | local $TERM = shift; |
864 | my $htype = shift; |
929 | my $htype = shift; |
865 | |
930 | |
866 | if ($htype == 0) { # INIT |
931 | if ($htype == 0) { # INIT |
867 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
932 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
868 | |
933 | |
869 | my %ext_arg; |
934 | my %ext_arg; |
870 | |
935 | |
871 | { |
936 | { |
872 | my @init = @TERM_INIT; |
937 | my @init = @TERM_INIT; |
873 | @TERM_INIT = (); |
938 | @TERM_INIT = (); |
… | |
… | |
907 | |
972 | |
908 | if (my $cb = $TERM->{_hook}[$htype]) { |
973 | if (my $cb = $TERM->{_hook}[$htype]) { |
909 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
974 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
910 | if $verbosity >= 10; |
975 | if $verbosity >= 10; |
911 | |
976 | |
912 | keys %$cb; |
977 | for my $pkg (keys %$cb) { |
913 | |
|
|
914 | while (my ($pkg, $cb) = each %$cb) { |
|
|
915 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
978 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
916 | $retval ||= $retval_; |
979 | $retval ||= $retval_; |
917 | |
980 | |
918 | if ($@) { |
981 | if ($@) { |
919 | $TERM->ungrab; # better to lose the grab than the session |
982 | $TERM->ungrab; # better to lose the grab than the session |
920 | warn $@; |
983 | warn $@; |
… | |
… | |
936 | $retval |
999 | $retval |
937 | } |
1000 | } |
938 | |
1001 | |
939 | sub SET_COLOR($$$) { |
1002 | sub SET_COLOR($$$) { |
940 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
1003 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
1004 | } |
|
|
1005 | |
|
|
1006 | sub rend2mask { |
|
|
1007 | no strict 'refs'; |
|
|
1008 | my ($str, $mask) = (@_, 0); |
|
|
1009 | my %color = ( fg => undef, bg => undef ); |
|
|
1010 | my @failed; |
|
|
1011 | for my $spec ( split /\s+/, $str ) { |
|
|
1012 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1013 | $color{lc($1)} = $2; |
|
|
1014 | } else { |
|
|
1015 | my $neg = $spec =~ s/^[-^]//; |
|
|
1016 | unless ( exists &{"RS_$spec"} ) { |
|
|
1017 | push @failed, $spec; |
|
|
1018 | next; |
|
|
1019 | } |
|
|
1020 | my $cur = &{"RS_$spec"}; |
|
|
1021 | if ( $neg ) { |
|
|
1022 | $mask &= ~$cur; |
|
|
1023 | } else { |
|
|
1024 | $mask |= $cur; |
|
|
1025 | } |
|
|
1026 | } |
|
|
1027 | } |
|
|
1028 | ($mask, @color{qw(fg bg)}, \@failed) |
941 | } |
1029 | } |
942 | |
1030 | |
943 | # urxvt::term::extension |
1031 | # urxvt::term::extension |
944 | |
1032 | |
945 | package urxvt::term::extension; |
1033 | package urxvt::term::extension; |
… | |
… | |
1058 | sub DESTROY { |
1146 | sub DESTROY { |
1059 | $_[0][1]->stop; |
1147 | $_[0][1]->stop; |
1060 | } |
1148 | } |
1061 | |
1149 | |
1062 | sub condvar { |
1150 | sub condvar { |
1063 | bless \my $flag, urxvt::anyevent::condvar:: |
1151 | bless \my $flag, urxvt::anyevent:: |
1064 | } |
1152 | } |
1065 | |
1153 | |
1066 | sub urxvt::anyevent::condvar::broadcast { |
1154 | sub broadcast { |
1067 | ${$_[0]}++; |
1155 | ${$_[0]}++; |
1068 | } |
1156 | } |
1069 | |
1157 | |
1070 | sub urxvt::anyevent::condvar::wait { |
1158 | sub wait { |
1071 | unless (${$_[0]}) { |
1159 | unless (${$_[0]}) { |
1072 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1160 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1073 | } |
1161 | } |
|
|
1162 | } |
|
|
1163 | |
|
|
1164 | sub one_event { |
|
|
1165 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1074 | } |
1166 | } |
1075 | |
1167 | |
1076 | package urxvt::term; |
1168 | package urxvt::term; |
1077 | |
1169 | |
1078 | =head2 The C<urxvt::term> Class |
1170 | =head2 The C<urxvt::term> Class |
… | |
… | |
1165 | |
1257 | |
1166 | Returns true if the option specified by C<$optval> is enabled, and |
1258 | Returns true if the option specified by C<$optval> is enabled, and |
1167 | optionally change it. All option values are stored by name in the hash |
1259 | optionally change it. All option values are stored by name in the hash |
1168 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1260 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1169 | |
1261 | |
1170 | Here is a a likely non-exhaustive list of option names, please see the |
1262 | Here is a likely non-exhaustive list of option names, please see the |
1171 | source file F</src/optinc.h> to see the actual list: |
1263 | source file F</src/optinc.h> to see the actual list: |
1172 | |
1264 | |
1173 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1265 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1174 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1266 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1175 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1267 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1192 | likely change). |
1284 | likely change). |
1193 | |
1285 | |
1194 | Please note that resource strings will currently only be freed when the |
1286 | Please note that resource strings will currently only be freed when the |
1195 | terminal is destroyed, so changing options frequently will eat memory. |
1287 | terminal is destroyed, so changing options frequently will eat memory. |
1196 | |
1288 | |
1197 | Here is a a likely non-exhaustive list of resource names, not all of which |
1289 | Here is a likely non-exhaustive list of resource names, not all of which |
1198 | are supported in every build, please see the source file F</src/rsinc.h> |
1290 | are supported in every build, please see the source file F</src/rsinc.h> |
1199 | to see the actual list: |
1291 | to see the actual list: |
1200 | |
1292 | |
1201 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1293 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1202 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1294 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1514 | |
1606 | |
1515 | Returns the currently displayed screen (0 primary, 1 secondary). |
1607 | Returns the currently displayed screen (0 primary, 1 secondary). |
1516 | |
1608 | |
1517 | =item $cursor_is_hidden = $term->hidden_cursor |
1609 | =item $cursor_is_hidden = $term->hidden_cursor |
1518 | |
1610 | |
1519 | Returns wether the cursor is currently hidden or not. |
1611 | Returns whether the cursor is currently hidden or not. |
1520 | |
1612 | |
1521 | =item $view_start = $term->view_start ([$newvalue]) |
1613 | =item $view_start = $term->view_start ([$newvalue]) |
1522 | |
1614 | |
1523 | Returns the row number of the topmost displayed line. Maximum value is |
1615 | Returns the row number of the topmost displayed line. Maximum value is |
1524 | C<0>, which displays the normal terminal contents. Lower values scroll |
1616 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1701 | where one character corresponds to one screen cell. See |
1793 | where one character corresponds to one screen cell. See |
1702 | C<< $term->ROW_t >> for details. |
1794 | C<< $term->ROW_t >> for details. |
1703 | |
1795 | |
1704 | =item $string = $term->special_decode $text |
1796 | =item $string = $term->special_decode $text |
1705 | |
1797 | |
1706 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1798 | Converts rxvt-unicodes text representation into a perl string. See |
1707 | C<< $term->ROW_t >> for details. |
1799 | C<< $term->ROW_t >> for details. |
1708 | |
1800 | |
1709 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1801 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1710 | |
1802 | |
1711 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
1803 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1714 | manpage. |
1806 | manpage. |
1715 | |
1807 | |
1716 | =item $success = $term->grab ($eventtime[, $sync]) |
1808 | =item $success = $term->grab ($eventtime[, $sync]) |
1717 | |
1809 | |
1718 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1810 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1719 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1811 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1720 | |
1812 | |
1721 | =item $term->allow_events_async |
1813 | =item $term->allow_events_async |
1722 | |
1814 | |
1723 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1815 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1724 | |
1816 | |
… | |
… | |
1898 | |
1990 | |
1899 | =cut |
1991 | =cut |
1900 | |
1992 | |
1901 | package urxvt::watcher; |
1993 | package urxvt::watcher; |
1902 | |
1994 | |
1903 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1904 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1905 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1906 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1907 | |
|
|
1908 | =head2 The C<urxvt::timer> Class |
1995 | =head2 The C<urxvt::timer> Class |
1909 | |
1996 | |
1910 | This class implements timer watchers/events. Time is represented as a |
1997 | This class implements timer watchers/events. Time is represented as a |
1911 | fractional number of seconds since the epoch. Example: |
1998 | fractional number of seconds since the epoch. Example: |
1912 | |
1999 | |
… | |
… | |
1915 | ->new |
2002 | ->new |
1916 | ->interval (1) |
2003 | ->interval (1) |
1917 | ->cb (sub { |
2004 | ->cb (sub { |
1918 | $term->{overlay}->set (0, 0, |
2005 | $term->{overlay}->set (0, 0, |
1919 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2006 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1920 | }); |
2007 | }); |
1921 | |
2008 | |
1922 | =over 4 |
2009 | =over 4 |
1923 | |
2010 | |
1924 | =item $timer = new urxvt::timer |
2011 | =item $timer = new urxvt::timer |
1925 | |
2012 | |
… | |
… | |
1991 | Set the callback to be called when io events are triggered. C<$reventmask> |
2078 | Set the callback to be called when io events are triggered. C<$reventmask> |
1992 | is a bitset as described in the C<events> method. |
2079 | is a bitset as described in the C<events> method. |
1993 | |
2080 | |
1994 | =item $iow = $iow->fd ($fd) |
2081 | =item $iow = $iow->fd ($fd) |
1995 | |
2082 | |
1996 | Set the filedescriptor (not handle) to watch. |
2083 | Set the file descriptor (not handle) to watch. |
1997 | |
2084 | |
1998 | =item $iow = $iow->events ($eventmask) |
2085 | =item $iow = $iow->events ($eventmask) |
1999 | |
2086 | |
2000 | Set the event mask to watch. The only allowed values are |
2087 | Set the event mask to watch. The only allowed values are |
2001 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2088 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
… | |
… | |
2005 | |
2092 | |
2006 | Start watching for requested events on the given handle. |
2093 | Start watching for requested events on the given handle. |
2007 | |
2094 | |
2008 | =item $iow = $iow->stop |
2095 | =item $iow = $iow->stop |
2009 | |
2096 | |
2010 | Stop watching for events on the given filehandle. |
2097 | Stop watching for events on the given file handle. |
2011 | |
2098 | |
2012 | =back |
2099 | =back |
2013 | |
2100 | |
2014 | =head2 The C<urxvt::iw> Class |
2101 | =head2 The C<urxvt::iw> Class |
2015 | |
2102 | |
… | |
… | |
2048 | ->new |
2135 | ->new |
2049 | ->start ($pid) |
2136 | ->start ($pid) |
2050 | ->cb (sub { |
2137 | ->cb (sub { |
2051 | my ($pw, $exit_status) = @_; |
2138 | my ($pw, $exit_status) = @_; |
2052 | ... |
2139 | ... |
2053 | }); |
2140 | }); |
2054 | |
2141 | |
2055 | =over 4 |
2142 | =over 4 |
2056 | |
2143 | |
2057 | =item $pw = new urxvt::pw |
2144 | =item $pw = new urxvt::pw |
2058 | |
2145 | |
… | |
… | |
2062 | |
2149 | |
2063 | Set the callback to be called when the timer triggers. |
2150 | Set the callback to be called when the timer triggers. |
2064 | |
2151 | |
2065 | =item $pw = $timer->start ($pid) |
2152 | =item $pw = $timer->start ($pid) |
2066 | |
2153 | |
2067 | Tells the wqtcher to start watching for process C<$pid>. |
2154 | Tells the watcher to start watching for process C<$pid>. |
2068 | |
2155 | |
2069 | =item $pw = $pw->stop |
2156 | =item $pw = $pw->stop |
2070 | |
2157 | |
2071 | Stop the watcher. |
2158 | Stop the watcher. |
2072 | |
2159 | |
… | |
… | |
2085 | |
2172 | |
2086 | =item >= 3 - script loading and management |
2173 | =item >= 3 - script loading and management |
2087 | |
2174 | |
2088 | =item >=10 - all called hooks |
2175 | =item >=10 - all called hooks |
2089 | |
2176 | |
2090 | =item >=11 - hook reutrn values |
2177 | =item >=11 - hook return values |
2091 | |
2178 | |
2092 | =back |
2179 | =back |
2093 | |
2180 | |
2094 | =head1 AUTHOR |
2181 | =head1 AUTHOR |
2095 | |
2182 | |
… | |
… | |
2097 | http://software.schmorp.de/pkg/rxvt-unicode |
2184 | http://software.schmorp.de/pkg/rxvt-unicode |
2098 | |
2185 | |
2099 | =cut |
2186 | =cut |
2100 | |
2187 | |
2101 | 1 |
2188 | 1 |
|
|
2189 | |
|
|
2190 | # vim: sw=3: |