… | |
… | |
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 | |
30 | |
|
|
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
|
|
32 | and "perl-ext-common" resources to the empty string. |
|
|
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/>. |
35 | |
38 | |
… | |
… | |
37 | |
40 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
41 | @@RXVT_NAME@@ -pe <extensionname> |
39 | |
42 | |
40 | Or by adding them to the resource for extensions loaded by default: |
43 | Or by adding them to the resource for extensions loaded by default: |
41 | |
44 | |
42 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
45 | URxvt.perl-ext-common: default,selection-autotransform |
43 | |
46 | |
44 | =over 4 |
47 | =over 4 |
45 | |
48 | |
46 | =item selection (enabled by default) |
49 | =item selection (enabled by default) |
47 | |
50 | |
… | |
… | |
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. |
155 | |
158 | |
156 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
159 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
157 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
160 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
158 | or simply use an uppercase character which removes the "(?i)" prefix. |
161 | or simply use an uppercase character which removes the "(?i)" prefix. |
159 | |
162 | |
… | |
… | |
162 | =item readline (enabled by default) |
165 | =item readline (enabled by default) |
163 | |
166 | |
164 | 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 |
165 | 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 |
166 | move the text cursor to this position. It does so by generating as many |
169 | move the text cursor to this position. It does so by generating as many |
167 | cursor-left or cursor-right keypresses as required (the this only works |
170 | cursor-left or cursor-right keypresses as required (this only works |
168 | for programs that correctly support wide characters). |
171 | for programs that correctly support wide characters). |
169 | |
172 | |
170 | To avoid too many false positives, this is only done when: |
173 | To avoid too many false positives, this is only done when: |
171 | |
174 | |
172 | =over 4 |
175 | =over 4 |
… | |
… | |
220 | the message into vi commands to load the file. |
223 | the message into vi commands to load the file. |
221 | |
224 | |
222 | =item tabbed |
225 | =item tabbed |
223 | |
226 | |
224 | This transforms the terminal into a tabbar with additional terminals, that |
227 | This transforms the terminal into a tabbar with additional terminals, that |
225 | 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 |
226 | 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 |
227 | button per tab. |
230 | button per tab. |
228 | |
231 | |
229 | 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 |
230 | 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, |
… | |
… | |
240 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
243 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
241 | |
244 | |
242 | 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 |
243 | indices. |
246 | indices. |
244 | |
247 | |
245 | =item mark-urls |
248 | =item matcher |
246 | |
249 | |
247 | 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 |
248 | make them clickable. When middle-clicked, the program specified in the |
251 | matching a certain pattern and make it clickable. When clicked with the |
249 | 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 |
250 | 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 |
251 | |
276 | |
252 | =item xim-onthespot |
277 | =item xim-onthespot |
253 | |
278 | |
254 | This (experimental) perl extension implements OnTheSpot editing. It does |
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
255 | 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 |
256 | 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 |
257 | kinput2. |
282 | kinput2. |
258 | |
283 | |
259 | 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 |
260 | C<OnTheSpot>, i.e.: |
285 | C<OnTheSpot>, i.e.: |
261 | |
286 | |
… | |
… | |
269 | will show or hide itself. Another press of the accelerator key will hide |
294 | will show or hide itself. Another press of the accelerator key will hide |
270 | or show it again. |
295 | or show it again. |
271 | |
296 | |
272 | Initially, the window will not be shown when using this extension. |
297 | Initially, the window will not be shown when using this extension. |
273 | |
298 | |
274 | This is useful if you need a single terminal thats not using any desktop |
299 | This is useful if you need a single terminal that is not using any desktop |
275 | space most of the time but is quickly available at the press of a key. |
300 | space most of the time but is quickly available at the press of a key. |
276 | |
301 | |
277 | The accelerator key is grabbed regardless of any modifers, so this |
302 | The accelerator key is grabbed regardless of any modifiers, so this |
278 | extension will actually grab a physical key just for this function. |
303 | extension will actually grab a physical key just for this function. |
279 | |
304 | |
280 | If you want a quake-like animation, tell your window manager to do so |
305 | If you want a quake-like animation, tell your window manager to do so |
281 | (fvwm can do it). |
306 | (fvwm can do it). |
282 | |
|
|
283 | =item automove-background |
|
|
284 | |
|
|
285 | This is basically a very small extension that dynamically changes the |
|
|
286 | background pixmap offset to the window position, in effect creating the |
|
|
287 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
288 | supported in this mode. Exmaple: |
|
|
289 | |
|
|
290 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
291 | |
307 | |
292 | =item block-graphics-to-ascii |
308 | =item block-graphics-to-ascii |
293 | |
309 | |
294 | A not very useful example of filtering all text output to the terminal |
310 | A not very useful example of filtering all text output to the terminal |
295 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
311 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
… | |
… | |
300 | Displays a digital clock using the built-in overlay. |
316 | Displays a digital clock using the built-in overlay. |
301 | |
317 | |
302 | =item remote-clipboard |
318 | =item remote-clipboard |
303 | |
319 | |
304 | Somewhat of a misnomer, this extension adds two menu entries to the |
320 | Somewhat of a misnomer, this extension adds two menu entries to the |
305 | selection popup that allows one ti run external commands to store the |
321 | selection popup that allows one to run external commands to store the |
306 | selection somewhere and fetch it again. |
322 | selection somewhere and fetch it again. |
307 | |
323 | |
308 | We use it to implement a "distributed selection mechanism", which just |
324 | We use it to implement a "distributed selection mechanism", which just |
309 | means that one command uploads the file to a remote server, and another |
325 | means that one command uploads the file to a remote server, and another |
310 | reads it. |
326 | reads it. |
… | |
… | |
345 | After a successful upload the selection will be replaced by the text given |
361 | After a successful upload the selection will be replaced by the text given |
346 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
362 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
347 | for the filename): |
363 | for the filename): |
348 | |
364 | |
349 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
365 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
366 | |
|
|
367 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
368 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
369 | which works regardless of wether xrdb is used to parse the resource file |
|
|
370 | or not. |
350 | |
371 | |
351 | =item example-refresh-hooks |
372 | =item example-refresh-hooks |
352 | |
373 | |
353 | Displays a very simple digital clock in the upper right corner of the |
374 | Displays a very simple digital clock in the upper right corner of the |
354 | window. Illustrates overwriting the refresh callbacks to create your own |
375 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
395 | =back |
416 | =back |
396 | |
417 | |
397 | =head2 Extension Objects |
418 | =head2 Extension Objects |
398 | |
419 | |
399 | Every perl extension is a perl class. A separate perl object is created |
420 | Every perl extension is a perl class. A separate perl object is created |
400 | for each terminal and each extension and passed as the first parameter to |
421 | for each terminal, and each terminal has its own set of extenion objects, |
401 | hooks. So extensions can use their C<$self> object without having to think |
422 | which are passed as the first parameter to hooks. So extensions can use |
402 | about other extensions, with the exception of methods and members that |
423 | their C<$self> object without having to think about clashes with other |
|
|
424 | extensions or other terminals, with the exception of methods and members |
403 | begin with an underscore character C<_>: these are reserved for internal |
425 | that begin with an underscore character C<_>: these are reserved for |
404 | use. |
426 | internal use. |
405 | |
427 | |
406 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
428 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
407 | C<urxvt::term> class on this object. |
429 | C<urxvt::term> class on this object. |
408 | |
430 | |
409 | It has the following methods and data members: |
431 | It has the following methods and data members: |
… | |
… | |
430 | =head2 Hooks |
452 | =head2 Hooks |
431 | |
453 | |
432 | The following subroutines can be declared in extension files, and will be |
454 | The following subroutines can be declared in extension files, and will be |
433 | called whenever the relevant event happens. |
455 | called whenever the relevant event happens. |
434 | |
456 | |
435 | The first argument passed to them is an extension oject as described in |
457 | The first argument passed to them is an extension object as described in |
436 | the in the C<Extension Objects> section. |
458 | the in the C<Extension Objects> section. |
437 | |
459 | |
438 | B<All> of these hooks must return a boolean value. If any of the called |
460 | B<All> of these hooks must return a boolean value. If any of the called |
439 | hooks returns true, then the event counts as being I<consumed>, and the |
461 | hooks returns true, then the event counts as being I<consumed>, and the |
440 | relevant action might not be carried out by the C++ code. |
462 | relevant action might not be carried out by the C++ code. |
… | |
… | |
453 | place. |
475 | place. |
454 | |
476 | |
455 | =item on_start $term |
477 | =item on_start $term |
456 | |
478 | |
457 | Called at the very end of initialisation of a new terminal, just before |
479 | Called at the very end of initialisation of a new terminal, just before |
458 | trying to map (display) the toplevel and returning to the mainloop. |
480 | trying to map (display) the toplevel and returning to the main loop. |
459 | |
481 | |
460 | =item on_destroy $term |
482 | =item on_destroy $term |
461 | |
483 | |
462 | Called whenever something tries to destroy terminal, when the terminal is |
484 | Called whenever something tries to destroy terminal, when the terminal is |
463 | still fully functional (not for long, though). |
485 | still fully functional (not for long, though). |
… | |
… | |
490 | |
512 | |
491 | Called whenever a selection has been copied, but before the selection is |
513 | Called whenever a selection has been copied, but before the selection is |
492 | requested from the server. The selection text can be queried and changed |
514 | requested from the server. The selection text can be queried and changed |
493 | by calling C<< $term->selection >>. |
515 | by calling C<< $term->selection >>. |
494 | |
516 | |
495 | Returning a true value aborts selection grabbing. It will still be hilighted. |
517 | Returning a true value aborts selection grabbing. It will still be highlighted. |
496 | |
518 | |
497 | =item on_sel_extend $term |
519 | =item on_sel_extend $term |
498 | |
520 | |
499 | Called whenever the user tries to extend the selection (e.g. with a double |
521 | Called whenever the user tries to extend the selection (e.g. with a double |
500 | click) and is either supposed to return false (normal operation), or |
522 | click) and is either supposed to return false (normal operation), or |
501 | should extend the selection itelf and return true to suppress the built-in |
523 | should extend the selection itself and return true to suppress the built-in |
502 | processing. This can happen multiple times, as long as the callback |
524 | processing. This can happen multiple times, as long as the callback |
503 | returns true, it will be called on every further click by the user and is |
525 | returns true, it will be called on every further click by the user and is |
504 | supposed to enlarge the selection more and more, if possible. |
526 | supposed to enlarge the selection more and more, if possible. |
505 | |
527 | |
506 | See the F<selection> example extension. |
528 | See the F<selection> example extension. |
507 | |
529 | |
508 | =item on_view_change $term, $offset |
530 | =item on_view_change $term, $offset |
509 | |
531 | |
510 | Called whenever the view offset changes, i..e the user or program |
532 | Called whenever the view offset changes, i.e. the user or program |
511 | scrolls. Offset C<0> means display the normal terminal, positive values |
533 | scrolls. Offset C<0> means display the normal terminal, positive values |
512 | show this many lines of scrollback. |
534 | show this many lines of scrollback. |
513 | |
535 | |
514 | =item on_scroll_back $term, $lines, $saved |
536 | =item on_scroll_back $term, $lines, $saved |
515 | |
537 | |
… | |
… | |
539 | string should start with the extension name and a colon, to distinguish |
561 | string should start with the extension name and a colon, to distinguish |
540 | it from commands for other extensions, and this might be enforced in the |
562 | it from commands for other extensions, and this might be enforced in the |
541 | future. |
563 | future. |
542 | |
564 | |
543 | Be careful not ever to trust (in a security sense) the data you receive, |
565 | Be careful not ever to trust (in a security sense) the data you receive, |
544 | as its source can not easily be controleld (e-mail content, messages from |
566 | as its source can not easily be controlled (e-mail content, messages from |
545 | other users on the same system etc.). |
567 | other users on the same system etc.). |
546 | |
568 | |
547 | =item on_add_lines $term, $string |
569 | =item on_add_lines $term, $string |
548 | |
570 | |
549 | Called whenever text is about to be output, with the text as argument. You |
571 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
582 | |
604 | |
583 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
605 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
584 | |
606 | |
585 | =item on_user_command $term, $string |
607 | =item on_user_command $term, $string |
586 | |
608 | |
587 | Called whenever the a user-configured event is being activated (e.g. via |
609 | Called whenever a user-configured event is being activated (e.g. via |
588 | a C<perl:string> action bound to a key, see description of the B<keysym> |
610 | a C<perl:string> action bound to a key, see description of the B<keysym> |
589 | resource in the @@RXVT_NAME@@(1) manpage). |
611 | resource in the @@RXVT_NAME@@(1) manpage). |
590 | |
612 | |
591 | The event is simply the action string. This interface is assumed to change |
613 | The event is simply the action string. This interface is assumed to change |
592 | slightly in the future. |
614 | slightly in the future. |
593 | |
615 | |
594 | =item on_resize_all_windows $tern, $new_width, $new_height |
616 | =item on_resize_all_windows $tern, $new_width, $new_height |
595 | |
617 | |
596 | Called just after the new window size has been calculcated, but before |
618 | Called just after the new window size has been calculated, but before |
597 | windows are actually being resized or hints are being set. If this hook |
619 | windows are actually being resized or hints are being set. If this hook |
598 | returns TRUE, setting of the window hints is being skipped. |
620 | returns TRUE, setting of the window hints is being skipped. |
599 | |
621 | |
600 | =item on_x_event $term, $event |
622 | =item on_x_event $term, $event |
601 | |
623 | |
… | |
… | |
612 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
634 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
613 | does focus in processing. |
635 | does focus in processing. |
614 | |
636 | |
615 | =item on_focus_out $term |
637 | =item on_focus_out $term |
616 | |
638 | |
617 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
639 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
618 | focus out processing. |
640 | focus out processing. |
619 | |
641 | |
620 | =item on_configure_notify $term, $event |
642 | =item on_configure_notify $term, $event |
621 | |
643 | |
622 | =item on_property_notify $term, $event |
644 | =item on_property_notify $term, $event |
… | |
… | |
705 | The current terminal. This variable stores the current C<urxvt::term> |
727 | The current terminal. This variable stores the current C<urxvt::term> |
706 | object, whenever a callback/hook is executing. |
728 | object, whenever a callback/hook is executing. |
707 | |
729 | |
708 | =item @urxvt::TERM_INIT |
730 | =item @urxvt::TERM_INIT |
709 | |
731 | |
710 | All coderefs in this array will be called as methods of the next newly |
732 | All code references in this array will be called as methods of the next newly |
711 | created C<urxvt::term> object (during the C<on_init> phase). The array |
733 | created C<urxvt::term> object (during the C<on_init> phase). The array |
712 | gets cleared before the codereferences that were in it are being executed, |
734 | gets cleared before the code references that were in it are being executed, |
713 | so coderefs can push themselves onto it again if they so desire. |
735 | so references can push themselves onto it again if they so desire. |
714 | |
736 | |
715 | This complements to the perl-eval commandline option, but gets executed |
737 | This complements to the perl-eval command line option, but gets executed |
716 | first. |
738 | first. |
717 | |
739 | |
718 | =item @urxvt::TERM_EXT |
740 | =item @urxvt::TERM_EXT |
719 | |
741 | |
720 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
742 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
745 | Messages have a size limit of 1023 bytes currently. |
767 | Messages have a size limit of 1023 bytes currently. |
746 | |
768 | |
747 | =item @terms = urxvt::termlist |
769 | =item @terms = urxvt::termlist |
748 | |
770 | |
749 | Returns all urxvt::term objects that exist in this process, regardless of |
771 | Returns all urxvt::term objects that exist in this process, regardless of |
750 | wether they are started, being destroyed etc., so be careful. Only term |
772 | whether they are started, being destroyed etc., so be careful. Only term |
751 | objects that have perl extensions attached will be returned (because there |
773 | objects that have perl extensions attached will be returned (because there |
752 | is no urxvt::term objet associated with others). |
774 | is no urxvt::term objet associated with others). |
753 | |
775 | |
754 | =item $time = urxvt::NOW |
776 | =item $time = urxvt::NOW |
755 | |
777 | |
… | |
… | |
893 | local $TERM = shift; |
915 | local $TERM = shift; |
894 | my $htype = shift; |
916 | my $htype = shift; |
895 | |
917 | |
896 | if ($htype == 0) { # INIT |
918 | if ($htype == 0) { # INIT |
897 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
919 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
898 | |
920 | |
899 | my %ext_arg; |
921 | my %ext_arg; |
900 | |
922 | |
901 | { |
923 | { |
902 | my @init = @TERM_INIT; |
924 | my @init = @TERM_INIT; |
903 | @TERM_INIT = (); |
925 | @TERM_INIT = (); |
… | |
… | |
966 | |
988 | |
967 | sub SET_COLOR($$$) { |
989 | sub SET_COLOR($$$) { |
968 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
990 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
969 | } |
991 | } |
970 | |
992 | |
|
|
993 | sub rend2mask { |
|
|
994 | no strict 'refs'; |
|
|
995 | my ($str, $mask) = (@_, 0); |
|
|
996 | my %color = ( fg => undef, bg => undef ); |
|
|
997 | my @failed; |
|
|
998 | for my $spec ( split /\s+/, $str ) { |
|
|
999 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1000 | $color{lc($1)} = $2; |
|
|
1001 | } else { |
|
|
1002 | my $neg = $spec =~ s/^[-^]//; |
|
|
1003 | unless ( exists &{"RS_$spec"} ) { |
|
|
1004 | push @failed, $spec; |
|
|
1005 | next; |
|
|
1006 | } |
|
|
1007 | my $cur = &{"RS_$spec"}; |
|
|
1008 | if ( $neg ) { |
|
|
1009 | $mask &= ~$cur; |
|
|
1010 | } else { |
|
|
1011 | $mask |= $cur; |
|
|
1012 | } |
|
|
1013 | } |
|
|
1014 | } |
|
|
1015 | ($mask, @color{qw(fg bg)}, \@failed) |
|
|
1016 | } |
|
|
1017 | |
971 | # urxvt::term::extension |
1018 | # urxvt::term::extension |
972 | |
1019 | |
973 | package urxvt::term::extension; |
1020 | package urxvt::term::extension; |
974 | |
1021 | |
975 | sub enable { |
1022 | sub enable { |
… | |
… | |
1086 | sub DESTROY { |
1133 | sub DESTROY { |
1087 | $_[0][1]->stop; |
1134 | $_[0][1]->stop; |
1088 | } |
1135 | } |
1089 | |
1136 | |
1090 | sub condvar { |
1137 | sub condvar { |
1091 | bless \my $flag, urxvt::anyevent::condvar:: |
1138 | bless \my $flag, urxvt::anyevent:: |
1092 | } |
1139 | } |
1093 | |
1140 | |
1094 | sub urxvt::anyevent::condvar::broadcast { |
1141 | sub broadcast { |
1095 | ${$_[0]}++; |
1142 | ${$_[0]}++; |
1096 | } |
1143 | } |
1097 | |
1144 | |
1098 | sub urxvt::anyevent::condvar::wait { |
1145 | sub wait { |
1099 | unless (${$_[0]}) { |
1146 | unless (${$_[0]}) { |
1100 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1147 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1101 | } |
1148 | } |
|
|
1149 | } |
|
|
1150 | |
|
|
1151 | sub one_event { |
|
|
1152 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1102 | } |
1153 | } |
1103 | |
1154 | |
1104 | package urxvt::term; |
1155 | package urxvt::term; |
1105 | |
1156 | |
1106 | =head2 The C<urxvt::term> Class |
1157 | =head2 The C<urxvt::term> Class |
… | |
… | |
1193 | |
1244 | |
1194 | Returns true if the option specified by C<$optval> is enabled, and |
1245 | Returns true if the option specified by C<$optval> is enabled, and |
1195 | optionally change it. All option values are stored by name in the hash |
1246 | optionally change it. All option values are stored by name in the hash |
1196 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1247 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1197 | |
1248 | |
1198 | Here is a a likely non-exhaustive list of option names, please see the |
1249 | Here is a likely non-exhaustive list of option names, please see the |
1199 | source file F</src/optinc.h> to see the actual list: |
1250 | source file F</src/optinc.h> to see the actual list: |
1200 | |
1251 | |
1201 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1252 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1202 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1253 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1203 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1254 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1220 | likely change). |
1271 | likely change). |
1221 | |
1272 | |
1222 | Please note that resource strings will currently only be freed when the |
1273 | Please note that resource strings will currently only be freed when the |
1223 | terminal is destroyed, so changing options frequently will eat memory. |
1274 | terminal is destroyed, so changing options frequently will eat memory. |
1224 | |
1275 | |
1225 | Here is a a likely non-exhaustive list of resource names, not all of which |
1276 | Here is a likely non-exhaustive list of resource names, not all of which |
1226 | are supported in every build, please see the source file F</src/rsinc.h> |
1277 | are supported in every build, please see the source file F</src/rsinc.h> |
1227 | to see the actual list: |
1278 | to see the actual list: |
1228 | |
1279 | |
1229 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1280 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1230 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1281 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1234 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1285 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1235 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1286 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1236 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1287 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1237 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1288 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1238 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1289 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1239 | secondaryScreen secondaryScroll selectstyle shade term_name title |
1290 | secondaryScreen secondaryScroll shade term_name title |
1240 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1291 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1241 | visualBell |
1292 | visualBell |
1242 | |
1293 | |
1243 | =cut |
1294 | =cut |
1244 | |
1295 | |
… | |
… | |
1542 | |
1593 | |
1543 | Returns the currently displayed screen (0 primary, 1 secondary). |
1594 | Returns the currently displayed screen (0 primary, 1 secondary). |
1544 | |
1595 | |
1545 | =item $cursor_is_hidden = $term->hidden_cursor |
1596 | =item $cursor_is_hidden = $term->hidden_cursor |
1546 | |
1597 | |
1547 | Returns wether the cursor is currently hidden or not. |
1598 | Returns whether the cursor is currently hidden or not. |
1548 | |
1599 | |
1549 | =item $view_start = $term->view_start ([$newvalue]) |
1600 | =item $view_start = $term->view_start ([$newvalue]) |
1550 | |
1601 | |
1551 | Returns the row number of the topmost displayed line. Maximum value is |
1602 | Returns the row number of the topmost displayed line. Maximum value is |
1552 | C<0>, which displays the normal terminal contents. Lower values scroll |
1603 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1574 | automatically be updated. |
1625 | automatically be updated. |
1575 | |
1626 | |
1576 | C<$text> is in a special encoding: tabs and wide characters that use more |
1627 | C<$text> is in a special encoding: tabs and wide characters that use more |
1577 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1628 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1578 | characters. Characters with combining characters and other characters that |
1629 | characters. Characters with combining characters and other characters that |
1579 | do not fit into the normal tetx encoding will be replaced with characters |
1630 | do not fit into the normal text encoding will be replaced with characters |
1580 | in the private use area. |
1631 | in the private use area. |
1581 | |
1632 | |
1582 | You have to obey this encoding when changing text. The advantage is |
1633 | You have to obey this encoding when changing text. The advantage is |
1583 | that C<substr> and similar functions work on screen cells and not on |
1634 | that C<substr> and similar functions work on screen cells and not on |
1584 | characters. |
1635 | characters. |
… | |
… | |
1729 | where one character corresponds to one screen cell. See |
1780 | where one character corresponds to one screen cell. See |
1730 | C<< $term->ROW_t >> for details. |
1781 | C<< $term->ROW_t >> for details. |
1731 | |
1782 | |
1732 | =item $string = $term->special_decode $text |
1783 | =item $string = $term->special_decode $text |
1733 | |
1784 | |
1734 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1785 | Converts rxvt-unicodes text representation into a perl string. See |
1735 | C<< $term->ROW_t >> for details. |
1786 | C<< $term->ROW_t >> for details. |
1736 | |
1787 | |
1737 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1788 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1738 | |
1789 | |
1739 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
1790 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1742 | manpage. |
1793 | manpage. |
1743 | |
1794 | |
1744 | =item $success = $term->grab ($eventtime[, $sync]) |
1795 | =item $success = $term->grab ($eventtime[, $sync]) |
1745 | |
1796 | |
1746 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1797 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1747 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1798 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1748 | |
1799 | |
1749 | =item $term->allow_events_async |
1800 | =item $term->allow_events_async |
1750 | |
1801 | |
1751 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1802 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1752 | |
1803 | |
… | |
… | |
1903 | my $env = $self->{term}->env; |
1954 | my $env = $self->{term}->env; |
1904 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1955 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1905 | delete $env->{LC_ALL}; |
1956 | delete $env->{LC_ALL}; |
1906 | $env->{LC_CTYPE} = $self->{term}->locale; |
1957 | $env->{LC_CTYPE} = $self->{term}->locale; |
1907 | |
1958 | |
1908 | urxvt::term->new ($env, "popup", |
1959 | my $term = urxvt::term->new ( |
|
|
1960 | $env, "popup", |
1909 | "--perl-lib" => "", "--perl-ext-common" => "", |
1961 | "--perl-lib" => "", "--perl-ext-common" => "", |
1910 | "-pty-fd" => -1, "-sl" => 0, |
1962 | "-pty-fd" => -1, "-sl" => 0, |
1911 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1963 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1912 | "--transient-for" => $self->{term}->parent, |
1964 | "--transient-for" => $self->{term}->parent, |
1913 | "-display" => $self->{term}->display_id, |
1965 | "-display" => $self->{term}->display_id, |
1914 | "-pe" => "urxvt-popup") |
1966 | "-pe" => "urxvt-popup", |
1915 | or die "unable to create popup window\n"; |
1967 | ) or die "unable to create popup window\n"; |
|
|
1968 | |
|
|
1969 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
1970 | $term->ungrab; |
|
|
1971 | $term->destroy; |
|
|
1972 | die "unable to initialise popup window\n"; |
|
|
1973 | } |
1916 | } |
1974 | } |
1917 | |
1975 | |
1918 | sub DESTROY { |
1976 | sub DESTROY { |
1919 | my ($self) = @_; |
1977 | my ($self) = @_; |
1920 | |
1978 | |
… | |
… | |
1925 | =back |
1983 | =back |
1926 | |
1984 | |
1927 | =cut |
1985 | =cut |
1928 | |
1986 | |
1929 | package urxvt::watcher; |
1987 | package urxvt::watcher; |
1930 | |
|
|
1931 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1932 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1933 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1934 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1935 | |
1988 | |
1936 | =head2 The C<urxvt::timer> Class |
1989 | =head2 The C<urxvt::timer> Class |
1937 | |
1990 | |
1938 | This class implements timer watchers/events. Time is represented as a |
1991 | This class implements timer watchers/events. Time is represented as a |
1939 | fractional number of seconds since the epoch. Example: |
1992 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1943 | ->new |
1996 | ->new |
1944 | ->interval (1) |
1997 | ->interval (1) |
1945 | ->cb (sub { |
1998 | ->cb (sub { |
1946 | $term->{overlay}->set (0, 0, |
1999 | $term->{overlay}->set (0, 0, |
1947 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2000 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1948 | }); |
2001 | }); |
1949 | |
2002 | |
1950 | =over 4 |
2003 | =over 4 |
1951 | |
2004 | |
1952 | =item $timer = new urxvt::timer |
2005 | =item $timer = new urxvt::timer |
1953 | |
2006 | |
… | |
… | |
1996 | |
2049 | |
1997 | $term->{socket} = ... |
2050 | $term->{socket} = ... |
1998 | $term->{iow} = urxvt::iow |
2051 | $term->{iow} = urxvt::iow |
1999 | ->new |
2052 | ->new |
2000 | ->fd (fileno $term->{socket}) |
2053 | ->fd (fileno $term->{socket}) |
2001 | ->events (urxvt::EVENT_READ) |
2054 | ->events (urxvt::EV_READ) |
2002 | ->start |
2055 | ->start |
2003 | ->cb (sub { |
2056 | ->cb (sub { |
2004 | my ($iow, $revents) = @_; |
2057 | my ($iow, $revents) = @_; |
2005 | # $revents must be 1 here, no need to check |
2058 | # $revents must be 1 here, no need to check |
2006 | sysread $term->{socket}, my $buf, 8192 |
2059 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
2019 | Set the callback to be called when io events are triggered. C<$reventmask> |
2072 | Set the callback to be called when io events are triggered. C<$reventmask> |
2020 | is a bitset as described in the C<events> method. |
2073 | is a bitset as described in the C<events> method. |
2021 | |
2074 | |
2022 | =item $iow = $iow->fd ($fd) |
2075 | =item $iow = $iow->fd ($fd) |
2023 | |
2076 | |
2024 | Set the filedescriptor (not handle) to watch. |
2077 | Set the file descriptor (not handle) to watch. |
2025 | |
2078 | |
2026 | =item $iow = $iow->events ($eventmask) |
2079 | =item $iow = $iow->events ($eventmask) |
2027 | |
2080 | |
2028 | Set the event mask to watch. The only allowed values are |
2081 | Set the event mask to watch. The only allowed values are |
2029 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2082 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
2030 | together, or C<urxvt::EVENT_NONE>. |
2083 | together, or C<urxvt::EV_NONE>. |
2031 | |
2084 | |
2032 | =item $iow = $iow->start |
2085 | =item $iow = $iow->start |
2033 | |
2086 | |
2034 | Start watching for requested events on the given handle. |
2087 | Start watching for requested events on the given handle. |
2035 | |
2088 | |
2036 | =item $iow = $iow->stop |
2089 | =item $iow = $iow->stop |
2037 | |
2090 | |
2038 | Stop watching for events on the given filehandle. |
2091 | Stop watching for events on the given file handle. |
2039 | |
2092 | |
2040 | =back |
2093 | =back |
2041 | |
2094 | |
2042 | =head2 The C<urxvt::iw> Class |
2095 | =head2 The C<urxvt::iw> Class |
2043 | |
2096 | |
… | |
… | |
2076 | ->new |
2129 | ->new |
2077 | ->start ($pid) |
2130 | ->start ($pid) |
2078 | ->cb (sub { |
2131 | ->cb (sub { |
2079 | my ($pw, $exit_status) = @_; |
2132 | my ($pw, $exit_status) = @_; |
2080 | ... |
2133 | ... |
2081 | }); |
2134 | }); |
2082 | |
2135 | |
2083 | =over 4 |
2136 | =over 4 |
2084 | |
2137 | |
2085 | =item $pw = new urxvt::pw |
2138 | =item $pw = new urxvt::pw |
2086 | |
2139 | |
… | |
… | |
2090 | |
2143 | |
2091 | Set the callback to be called when the timer triggers. |
2144 | Set the callback to be called when the timer triggers. |
2092 | |
2145 | |
2093 | =item $pw = $timer->start ($pid) |
2146 | =item $pw = $timer->start ($pid) |
2094 | |
2147 | |
2095 | Tells the wqtcher to start watching for process C<$pid>. |
2148 | Tells the watcher to start watching for process C<$pid>. |
2096 | |
2149 | |
2097 | =item $pw = $pw->stop |
2150 | =item $pw = $pw->stop |
2098 | |
2151 | |
2099 | Stop the watcher. |
2152 | Stop the watcher. |
2100 | |
2153 | |
… | |
… | |
2113 | |
2166 | |
2114 | =item >= 3 - script loading and management |
2167 | =item >= 3 - script loading and management |
2115 | |
2168 | |
2116 | =item >=10 - all called hooks |
2169 | =item >=10 - all called hooks |
2117 | |
2170 | |
2118 | =item >=11 - hook reutrn values |
2171 | =item >=11 - hook return values |
2119 | |
2172 | |
2120 | =back |
2173 | =back |
2121 | |
2174 | |
2122 | =head1 AUTHOR |
2175 | =head1 AUTHOR |
2123 | |
2176 | |
… | |
… | |
2125 | http://software.schmorp.de/pkg/rxvt-unicode |
2178 | http://software.schmorp.de/pkg/rxvt-unicode |
2126 | |
2179 | |
2127 | =cut |
2180 | =cut |
2128 | |
2181 | |
2129 | 1 |
2182 | 1 |
|
|
2183 | |
|
|
2184 | # vim: sw=3: |