… | |
… | |
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 |
… | |
… | |
94 | =item option-popup (enabled by default) |
97 | =item option-popup (enabled by default) |
95 | |
98 | |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
99 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
97 | runtime. |
100 | runtime. |
98 | |
101 | |
|
|
102 | Other extensions can extend this popup menu by pushing a code reference |
|
|
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
104 | popup is being displayed. |
|
|
105 | |
|
|
106 | It's sole argument is the popup menu, which can be modified. It should |
|
|
107 | either return nothing or a string, the initial boolean value and a code |
|
|
108 | reference. The string will be used as button text and the code reference |
|
|
109 | will be called when the toggle changes, with the new boolean value as |
|
|
110 | first argument. |
|
|
111 | |
|
|
112 | The following will add an entry C<myoption> that changes |
|
|
113 | C<$self->{myoption}>: |
|
|
114 | |
|
|
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
117 | }; |
|
|
118 | |
99 | =item selection-popup (enabled by default) |
119 | =item selection-popup (enabled by default) |
100 | |
120 | |
101 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
121 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
102 | text into various other formats/action (such as uri unescaping, perl |
122 | text into various other formats/action (such as uri unescaping, perl |
103 | evaluation, web-browser starting etc.), depending on content. |
123 | evaluation, web-browser starting etc.), depending on content. |
104 | |
124 | |
105 | 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 |
106 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
107 | popup is displayed. |
127 | popup is being displayed. |
108 | |
128 | |
109 | It's sole argument is the popup menu, which can be modified. The selection |
129 | It's sole argument is the popup menu, which can be modified. The selection |
110 | 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. |
111 | 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 |
112 | 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 |
113 | when the button gets activated and should transform C<$_>. |
133 | when the button gets activated and should transform C<$_>. |
114 | |
134 | |
115 | 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 |
… | |
… | |
134 | 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 |
135 | 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 |
136 | 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 |
137 | selection. |
157 | selection. |
138 | |
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. |
|
|
164 | |
139 | =item readline (enabled by default) |
165 | =item readline (enabled by default) |
140 | |
166 | |
141 | A support package that tries to make editing with readline easier. At the |
167 | A support package that tries to make editing with readline easier. At |
142 | moment, it reacts to clicking with the left mouse button by trying to |
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
143 | 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 |
144 | cursor-left or cursor-right keypresses as required (the this only works |
170 | cursor-left or cursor-right keypresses as required (the this only works |
145 | for programs that correctly support wide characters). |
171 | for programs that correctly support wide characters). |
146 | |
172 | |
147 | To avoid too many false positives, this is only done when: |
173 | To avoid too many false positives, this is only done when: |
… | |
… | |
197 | the message into vi commands to load the file. |
223 | the message into vi commands to load the file. |
198 | |
224 | |
199 | =item tabbed |
225 | =item tabbed |
200 | |
226 | |
201 | This transforms the terminal into a tabbar with additional terminals, that |
227 | 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 |
228 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
203 | 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 |
204 | button per tab. |
230 | button per tab. |
205 | |
231 | |
206 | 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 |
207 | 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, |
… | |
… | |
217 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
243 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
218 | |
244 | |
219 | 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 |
220 | indices. |
246 | indices. |
221 | |
247 | |
222 | =item mark-urls |
248 | =item matcher |
223 | |
249 | |
224 | 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 |
225 | make them clickable. When middle-clicked, the program specified in the |
251 | matching a certain pattern and make it clickable. When clicked with the |
226 | 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 |
227 | 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 | Example configuration: |
|
|
265 | |
|
|
266 | URxvt.perl-ext: default,matcher |
|
|
267 | URxvt.urlLauncher: sensible-browser |
|
|
268 | URxvt.keysym.C-Delete: perl:matcher |
|
|
269 | URxvt.matcher.button: 1 |
|
|
270 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
271 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
272 | URxvt.matcher.launcher.2: gvim +$2 $1 |
228 | |
273 | |
229 | =item xim-onthespot |
274 | =item xim-onthespot |
230 | |
275 | |
231 | This (experimental) perl extension implements OnTheSpot editing. It does |
276 | This (experimental) perl extension implements OnTheSpot editing. It does |
232 | not work perfectly, and some input methods don't seem to work well with |
277 | not work perfectly, and some input methods don't seem to work well with |
… | |
… | |
236 | You enable it by specifying this extension and a preedit style of |
281 | You enable it by specifying this extension and a preedit style of |
237 | C<OnTheSpot>, i.e.: |
282 | C<OnTheSpot>, i.e.: |
238 | |
283 | |
239 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
284 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
240 | |
285 | |
|
|
286 | =item kuake<hotkey> |
|
|
287 | |
|
|
288 | A very primitive quake-console-like extension. It was inspired by a |
|
|
289 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
290 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
291 | will show or hide itself. Another press of the accelerator key will hide |
|
|
292 | or show it again. |
|
|
293 | |
|
|
294 | Initially, the window will not be shown when using this extension. |
|
|
295 | |
|
|
296 | This is useful if you need a single terminal thats not using any desktop |
|
|
297 | space most of the time but is quickly available at the press of a key. |
|
|
298 | |
|
|
299 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
300 | extension will actually grab a physical key just for this function. |
|
|
301 | |
|
|
302 | If you want a quake-like animation, tell your window manager to do so |
|
|
303 | (fvwm can do it). |
|
|
304 | |
241 | =item automove-background |
305 | =item automove-background |
242 | |
306 | |
243 | This is basically a one-line extension that dynamically changes the background pixmap offset |
307 | This is basically a very small extension that dynamically changes the |
244 | to the window position, in effect creating the same effect as pseudo transparency with |
308 | background pixmap offset to the window position, in effect creating the |
245 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
309 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
310 | supported in this mode. Example: |
246 | |
311 | |
247 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
312 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
248 | |
313 | |
|
|
314 | L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions> |
|
|
315 | shows how this extension can be used to implement an automatically blurred |
|
|
316 | transparent background. |
|
|
317 | |
249 | =item block-graphics-to-ascii |
318 | =item block-graphics-to-ascii |
250 | |
319 | |
251 | A not very useful example of filtering all text output to the terminal, |
320 | A not very useful example of filtering all text output to the terminal |
252 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
321 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
253 | similar-looking ascii character. |
322 | similar-looking ascii character. |
254 | |
323 | |
255 | =item digital-clock |
324 | =item digital-clock |
256 | |
325 | |
… | |
… | |
302 | After a successful upload the selection will be replaced by the text given |
371 | After a successful upload the selection will be replaced by the text given |
303 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
372 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
304 | for the filename): |
373 | for the filename): |
305 | |
374 | |
306 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
375 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
376 | |
|
|
377 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
378 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
379 | which works regardless of wether xrdb is used to parse the resource file |
|
|
380 | or not. |
307 | |
381 | |
308 | =item example-refresh-hooks |
382 | =item example-refresh-hooks |
309 | |
383 | |
310 | Displays a very simple digital clock in the upper right corner of the |
384 | Displays a very simple digital clock in the upper right corner of the |
311 | window. Illustrates overwriting the refresh callbacks to create your own |
385 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
351 | |
425 | |
352 | =back |
426 | =back |
353 | |
427 | |
354 | =head2 Extension Objects |
428 | =head2 Extension Objects |
355 | |
429 | |
356 | Very perl extension is a perl class. A separate perl object is created |
430 | Every perl extension is a perl class. A separate perl object is created |
357 | for each terminal and each extension and passed as the first parameter to |
431 | for each terminal, and each terminal has its own set of extenion objects, |
358 | hooks. So extensions can use their C<$self> object without having to think |
432 | which are passed as the first parameter to hooks. So extensions can use |
359 | about other extensions, with the exception of methods and members that |
433 | their C<$self> object without having to think about clashes with other |
|
|
434 | extensions or other terminals, with the exception of methods and members |
360 | begin with an underscore character C<_>: these are reserved for internal |
435 | that begin with an underscore character C<_>: these are reserved for |
361 | use. |
436 | internal use. |
362 | |
437 | |
363 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
438 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
364 | C<urxvt::term> class on this object. |
439 | C<urxvt::term> class on this object. |
365 | |
440 | |
366 | It has the following methods and data members: |
441 | It has the following methods and data members: |
… | |
… | |
387 | =head2 Hooks |
462 | =head2 Hooks |
388 | |
463 | |
389 | The following subroutines can be declared in extension files, and will be |
464 | The following subroutines can be declared in extension files, and will be |
390 | called whenever the relevant event happens. |
465 | called whenever the relevant event happens. |
391 | |
466 | |
392 | The first argument passed to them is an extension oject as described in |
467 | The first argument passed to them is an extension object as described in |
393 | the in the C<Extension Objects> section. |
468 | the in the C<Extension Objects> section. |
394 | |
469 | |
395 | B<All> of these hooks must return a boolean value. If any of the called |
470 | B<All> of these hooks must return a boolean value. If any of the called |
396 | hooks returns true, then the event counts as being I<consumed>, and the |
471 | hooks returns true, then the event counts as being I<consumed>, and the |
397 | relevant action might not be carried out by the C++ code. |
472 | relevant action might not be carried out by the C++ code. |
… | |
… | |
410 | place. |
485 | place. |
411 | |
486 | |
412 | =item on_start $term |
487 | =item on_start $term |
413 | |
488 | |
414 | Called at the very end of initialisation of a new terminal, just before |
489 | Called at the very end of initialisation of a new terminal, just before |
415 | trying to map (display) the toplevel and returning to the mainloop. |
490 | trying to map (display) the toplevel and returning to the main loop. |
416 | |
491 | |
417 | =item on_destroy $term |
492 | =item on_destroy $term |
418 | |
493 | |
419 | Called whenever something tries to destroy terminal, when the terminal is |
494 | Called whenever something tries to destroy terminal, when the terminal is |
420 | still fully functional (not for long, though). |
495 | still fully functional (not for long, though). |
… | |
… | |
447 | |
522 | |
448 | Called whenever a selection has been copied, but before the selection is |
523 | Called whenever a selection has been copied, but before the selection is |
449 | requested from the server. The selection text can be queried and changed |
524 | requested from the server. The selection text can be queried and changed |
450 | by calling C<< $term->selection >>. |
525 | by calling C<< $term->selection >>. |
451 | |
526 | |
452 | Returning a true value aborts selection grabbing. It will still be hilighted. |
527 | Returning a true value aborts selection grabbing. It will still be highlighted. |
453 | |
528 | |
454 | =item on_sel_extend $term |
529 | =item on_sel_extend $term |
455 | |
530 | |
456 | Called whenever the user tries to extend the selection (e.g. with a double |
531 | Called whenever the user tries to extend the selection (e.g. with a double |
457 | click) and is either supposed to return false (normal operation), or |
532 | click) and is either supposed to return false (normal operation), or |
458 | should extend the selection itelf and return true to suppress the built-in |
533 | should extend the selection itself and return true to suppress the built-in |
459 | processing. This can happen multiple times, as long as the callback |
534 | processing. This can happen multiple times, as long as the callback |
460 | returns true, it will be called on every further click by the user and is |
535 | returns true, it will be called on every further click by the user and is |
461 | supposed to enlarge the selection more and more, if possible. |
536 | supposed to enlarge the selection more and more, if possible. |
462 | |
537 | |
463 | See the F<selection> example extension. |
538 | See the F<selection> example extension. |
464 | |
539 | |
465 | =item on_view_change $term, $offset |
540 | =item on_view_change $term, $offset |
466 | |
541 | |
467 | Called whenever the view offset changes, i..e the user or program |
542 | Called whenever the view offset changes, i.e. the user or program |
468 | scrolls. Offset C<0> means display the normal terminal, positive values |
543 | scrolls. Offset C<0> means display the normal terminal, positive values |
469 | show this many lines of scrollback. |
544 | show this many lines of scrollback. |
470 | |
545 | |
471 | =item on_scroll_back $term, $lines, $saved |
546 | =item on_scroll_back $term, $lines, $saved |
472 | |
547 | |
… | |
… | |
476 | |
551 | |
477 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
552 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
478 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
553 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
479 | number of lines that will be in the scrollback buffer. |
554 | number of lines that will be in the scrollback buffer. |
480 | |
555 | |
|
|
556 | =item on_osc_seq $term, $op, $args |
|
|
557 | |
|
|
558 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
559 | behaviour. The default should be to return an empty list. A true value |
|
|
560 | suppresses execution of the request completely. Make sure you don't get |
|
|
561 | confused by recursive invocations when you output an osc sequence within |
|
|
562 | this callback. |
|
|
563 | |
|
|
564 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
565 | |
481 | =item on_osc_seq $term, $string |
566 | =item on_osc_seq_perl $term, $string |
482 | |
567 | |
483 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
568 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
484 | operating system command) is processed. Cursor position and other state |
569 | operating system command) is processed. Cursor position and other state |
485 | information is up-to-date when this happens. For interoperability, the |
570 | information is up-to-date when this happens. For interoperability, the |
486 | string should start with the extension name and a colon, to distinguish |
571 | string should start with the extension name and a colon, to distinguish |
487 | it from commands for other extensions, and this might be enforced in the |
572 | it from commands for other extensions, and this might be enforced in the |
488 | future. |
573 | future. |
489 | |
574 | |
490 | Be careful not ever to trust (in a security sense) the data you receive, |
575 | Be careful not ever to trust (in a security sense) the data you receive, |
491 | as its source can not easily be controleld (e-mail content, messages from |
576 | as its source can not easily be controlled (e-mail content, messages from |
492 | other users on the same system etc.). |
577 | other users on the same system etc.). |
493 | |
578 | |
494 | =item on_add_lines $term, $string |
579 | =item on_add_lines $term, $string |
495 | |
580 | |
496 | Called whenever text is about to be output, with the text as argument. You |
581 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
529 | |
614 | |
530 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
615 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
531 | |
616 | |
532 | =item on_user_command $term, $string |
617 | =item on_user_command $term, $string |
533 | |
618 | |
534 | Called whenever the a user-configured event is being activated (e.g. via |
619 | Called whenever a user-configured event is being activated (e.g. via |
535 | a C<perl:string> action bound to a key, see description of the B<keysym> |
620 | a C<perl:string> action bound to a key, see description of the B<keysym> |
536 | resource in the @@RXVT_NAME@@(1) manpage). |
621 | resource in the @@RXVT_NAME@@(1) manpage). |
537 | |
622 | |
538 | The event is simply the action string. This interface is assumed to change |
623 | The event is simply the action string. This interface is assumed to change |
539 | slightly in the future. |
624 | slightly in the future. |
|
|
625 | |
|
|
626 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
627 | |
|
|
628 | Called just after the new window size has been calculated, but before |
|
|
629 | windows are actually being resized or hints are being set. If this hook |
|
|
630 | returns TRUE, setting of the window hints is being skipped. |
540 | |
631 | |
541 | =item on_x_event $term, $event |
632 | =item on_x_event $term, $event |
542 | |
633 | |
543 | Called on every X event received on the vt window (and possibly other |
634 | Called on every X event received on the vt window (and possibly other |
544 | windows). Should only be used as a last resort. Most event structure |
635 | windows). Should only be used as a last resort. Most event structure |
545 | members are not passed. |
636 | members are not passed. |
546 | |
637 | |
|
|
638 | =item on_root_event $term, $event |
|
|
639 | |
|
|
640 | Like C<on_x_event>, but is called for events on the root window. |
|
|
641 | |
547 | =item on_focus_in $term |
642 | =item on_focus_in $term |
548 | |
643 | |
549 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
644 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
550 | does focus in processing. |
645 | does focus in processing. |
551 | |
646 | |
552 | =item on_focus_out $term |
647 | =item on_focus_out $term |
553 | |
648 | |
554 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
649 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
555 | focus out processing. |
650 | focus out processing. |
556 | |
651 | |
557 | =item on_configure_notify $term, $event |
652 | =item on_configure_notify $term, $event |
558 | |
653 | |
559 | =item on_property_notify $term, $event |
654 | =item on_property_notify $term, $event |
… | |
… | |
642 | The current terminal. This variable stores the current C<urxvt::term> |
737 | The current terminal. This variable stores the current C<urxvt::term> |
643 | object, whenever a callback/hook is executing. |
738 | object, whenever a callback/hook is executing. |
644 | |
739 | |
645 | =item @urxvt::TERM_INIT |
740 | =item @urxvt::TERM_INIT |
646 | |
741 | |
647 | All coderefs in this array will be called as methods of the next newly |
742 | All code references in this array will be called as methods of the next newly |
648 | created C<urxvt::term> object (during the C<on_init> phase). The array |
743 | created C<urxvt::term> object (during the C<on_init> phase). The array |
649 | gets cleared before the codereferences that were in it are being executed, |
744 | gets cleared before the code references that were in it are being executed, |
650 | so coderefs can push themselves onto it again if they so desire. |
745 | so references can push themselves onto it again if they so desire. |
651 | |
746 | |
652 | This complements to the perl-eval commandline option, but gets executed |
747 | This complements to the perl-eval command line option, but gets executed |
653 | first. |
748 | first. |
654 | |
749 | |
655 | =item @urxvt::TERM_EXT |
750 | =item @urxvt::TERM_EXT |
656 | |
751 | |
657 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
752 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
682 | Messages have a size limit of 1023 bytes currently. |
777 | Messages have a size limit of 1023 bytes currently. |
683 | |
778 | |
684 | =item @terms = urxvt::termlist |
779 | =item @terms = urxvt::termlist |
685 | |
780 | |
686 | Returns all urxvt::term objects that exist in this process, regardless of |
781 | Returns all urxvt::term objects that exist in this process, regardless of |
687 | wether they are started, being destroyed etc., so be careful. Only term |
782 | whether they are started, being destroyed etc., so be careful. Only term |
688 | objects that have perl extensions attached will be returned (because there |
783 | objects that have perl extensions attached will be returned (because there |
689 | is no urxvt::term objet associated with others). |
784 | is no urxvt::term objet associated with others). |
690 | |
785 | |
691 | =item $time = urxvt::NOW |
786 | =item $time = urxvt::NOW |
692 | |
787 | |
… | |
… | |
854 | } else { |
949 | } else { |
855 | $ext_arg{$_} ||= []; |
950 | $ext_arg{$_} ||= []; |
856 | } |
951 | } |
857 | } |
952 | } |
858 | |
953 | |
859 | while (my ($ext, $argv) = each %ext_arg) { |
954 | for my $ext (sort keys %ext_arg) { |
860 | my @files = grep -f $_, map "$_/$ext", @dirs; |
955 | my @files = grep -f $_, map "$_/$ext", @dirs; |
861 | |
956 | |
862 | if (@files) { |
957 | if (@files) { |
863 | $TERM->register_package (extension_package $files[0], $argv); |
958 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
864 | } else { |
959 | } else { |
865 | warn "perl extension '$ext' not found in perl library search path\n"; |
960 | warn "perl extension '$ext' not found in perl library search path\n"; |
866 | } |
961 | } |
867 | } |
962 | } |
868 | |
963 | |
… | |
… | |
874 | |
969 | |
875 | if (my $cb = $TERM->{_hook}[$htype]) { |
970 | if (my $cb = $TERM->{_hook}[$htype]) { |
876 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
971 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
877 | if $verbosity >= 10; |
972 | if $verbosity >= 10; |
878 | |
973 | |
879 | keys %$cb; |
974 | for my $pkg (keys %$cb) { |
880 | |
|
|
881 | while (my ($pkg, $cb) = each %$cb) { |
|
|
882 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
975 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
883 | $retval ||= $retval_; |
976 | $retval ||= $retval_; |
884 | |
977 | |
885 | if ($@) { |
978 | if ($@) { |
886 | $TERM->ungrab; # better to lose the grab than the session |
979 | $TERM->ungrab; # better to lose the grab than the session |
887 | warn $@; |
980 | warn $@; |
… | |
… | |
903 | $retval |
996 | $retval |
904 | } |
997 | } |
905 | |
998 | |
906 | sub SET_COLOR($$$) { |
999 | sub SET_COLOR($$$) { |
907 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
1000 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
1001 | } |
|
|
1002 | |
|
|
1003 | sub rend2mask { |
|
|
1004 | no strict 'refs'; |
|
|
1005 | my ($str, $mask) = (@_, 0); |
|
|
1006 | my %color = ( fg => undef, bg => undef ); |
|
|
1007 | my @failed; |
|
|
1008 | for my $spec ( split /\s+/, $str ) { |
|
|
1009 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1010 | $color{lc($1)} = $2; |
|
|
1011 | } else { |
|
|
1012 | my $neg = $spec =~ s/^[-^]//; |
|
|
1013 | unless ( exists &{"RS_$spec"} ) { |
|
|
1014 | push @failed, $spec; |
|
|
1015 | next; |
|
|
1016 | } |
|
|
1017 | my $cur = &{"RS_$spec"}; |
|
|
1018 | if ( $neg ) { |
|
|
1019 | $mask &= ~$cur; |
|
|
1020 | } else { |
|
|
1021 | $mask |= $cur; |
|
|
1022 | } |
|
|
1023 | } |
|
|
1024 | } |
|
|
1025 | ($mask, @color{qw(fg bg)}, \@failed) |
908 | } |
1026 | } |
909 | |
1027 | |
910 | # urxvt::term::extension |
1028 | # urxvt::term::extension |
911 | |
1029 | |
912 | package urxvt::term::extension; |
1030 | package urxvt::term::extension; |
… | |
… | |
1025 | sub DESTROY { |
1143 | sub DESTROY { |
1026 | $_[0][1]->stop; |
1144 | $_[0][1]->stop; |
1027 | } |
1145 | } |
1028 | |
1146 | |
1029 | sub condvar { |
1147 | sub condvar { |
1030 | bless \my $flag, urxvt::anyevent::condvar:: |
1148 | bless \my $flag, urxvt::anyevent:: |
1031 | } |
1149 | } |
1032 | |
1150 | |
1033 | sub urxvt::anyevent::condvar::broadcast { |
1151 | sub broadcast { |
1034 | ${$_[0]}++; |
1152 | ${$_[0]}++; |
1035 | } |
1153 | } |
1036 | |
1154 | |
1037 | sub urxvt::anyevent::condvar::wait { |
1155 | sub wait { |
1038 | unless (${$_[0]}) { |
1156 | unless (${$_[0]}) { |
1039 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1157 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1040 | } |
1158 | } |
|
|
1159 | } |
|
|
1160 | |
|
|
1161 | sub one_event { |
|
|
1162 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1041 | } |
1163 | } |
1042 | |
1164 | |
1043 | package urxvt::term; |
1165 | package urxvt::term; |
1044 | |
1166 | |
1045 | =head2 The C<urxvt::term> Class |
1167 | =head2 The C<urxvt::term> Class |
… | |
… | |
1132 | |
1254 | |
1133 | Returns true if the option specified by C<$optval> is enabled, and |
1255 | Returns true if the option specified by C<$optval> is enabled, and |
1134 | optionally change it. All option values are stored by name in the hash |
1256 | optionally change it. All option values are stored by name in the hash |
1135 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1257 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1136 | |
1258 | |
1137 | Here is a a likely non-exhaustive list of option names, please see the |
1259 | Here is a likely non-exhaustive list of option names, please see the |
1138 | source file F</src/optinc.h> to see the actual list: |
1260 | source file F</src/optinc.h> to see the actual list: |
1139 | |
1261 | |
1140 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1262 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1141 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1263 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1142 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1264 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1159 | likely change). |
1281 | likely change). |
1160 | |
1282 | |
1161 | Please note that resource strings will currently only be freed when the |
1283 | Please note that resource strings will currently only be freed when the |
1162 | terminal is destroyed, so changing options frequently will eat memory. |
1284 | terminal is destroyed, so changing options frequently will eat memory. |
1163 | |
1285 | |
1164 | Here is a a likely non-exhaustive list of resource names, not all of which |
1286 | Here is a likely non-exhaustive list of resource names, not all of which |
1165 | are supported in every build, please see the source file F</src/rsinc.h> |
1287 | are supported in every build, please see the source file F</src/rsinc.h> |
1166 | to see the actual list: |
1288 | to see the actual list: |
1167 | |
1289 | |
1168 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1290 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1169 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1291 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1451 | =item $env = $term->env |
1573 | =item $env = $term->env |
1452 | |
1574 | |
1453 | Returns a copy of the environment in effect for the terminal as a hashref |
1575 | Returns a copy of the environment in effect for the terminal as a hashref |
1454 | similar to C<\%ENV>. |
1576 | similar to C<\%ENV>. |
1455 | |
1577 | |
|
|
1578 | =item @envv = $term->envv |
|
|
1579 | |
|
|
1580 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1581 | |
|
|
1582 | =item @argv = $term->argv |
|
|
1583 | |
|
|
1584 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1585 | includes the program name as first element. |
|
|
1586 | |
1456 | =cut |
1587 | =cut |
1457 | |
1588 | |
1458 | sub env { |
1589 | sub env { |
1459 | if (my $env = $_[0]->_env) { |
|
|
1460 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1590 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1461 | } else { |
|
|
1462 | +{ %ENV } |
|
|
1463 | } |
|
|
1464 | } |
1591 | } |
1465 | |
1592 | |
1466 | =item $modifiermask = $term->ModLevel3Mask |
1593 | =item $modifiermask = $term->ModLevel3Mask |
1467 | |
1594 | |
1468 | =item $modifiermask = $term->ModMetaMask |
1595 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1476 | |
1603 | |
1477 | Returns the currently displayed screen (0 primary, 1 secondary). |
1604 | Returns the currently displayed screen (0 primary, 1 secondary). |
1478 | |
1605 | |
1479 | =item $cursor_is_hidden = $term->hidden_cursor |
1606 | =item $cursor_is_hidden = $term->hidden_cursor |
1480 | |
1607 | |
1481 | Returns wether the cursor is currently hidden or not. |
1608 | Returns whether the cursor is currently hidden or not. |
1482 | |
1609 | |
1483 | =item $view_start = $term->view_start ([$newvalue]) |
1610 | =item $view_start = $term->view_start ([$newvalue]) |
1484 | |
1611 | |
1485 | Returns the row number of the topmost displayed line. Maximum value is |
1612 | Returns the row number of the topmost displayed line. Maximum value is |
1486 | C<0>, which displays the normal terminal contents. Lower values scroll |
1613 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1663 | where one character corresponds to one screen cell. See |
1790 | where one character corresponds to one screen cell. See |
1664 | C<< $term->ROW_t >> for details. |
1791 | C<< $term->ROW_t >> for details. |
1665 | |
1792 | |
1666 | =item $string = $term->special_decode $text |
1793 | =item $string = $term->special_decode $text |
1667 | |
1794 | |
1668 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1795 | Converts rxvt-unicodes text representation into a perl string. See |
1669 | C<< $term->ROW_t >> for details. |
1796 | C<< $term->ROW_t >> for details. |
1670 | |
1797 | |
1671 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1798 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1672 | |
1799 | |
1673 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
1800 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1676 | manpage. |
1803 | manpage. |
1677 | |
1804 | |
1678 | =item $success = $term->grab ($eventtime[, $sync]) |
1805 | =item $success = $term->grab ($eventtime[, $sync]) |
1679 | |
1806 | |
1680 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1807 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1681 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1808 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1682 | |
1809 | |
1683 | =item $term->allow_events_async |
1810 | =item $term->allow_events_async |
1684 | |
1811 | |
1685 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1812 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1686 | |
1813 | |
… | |
… | |
1799 | my ($self, $text, $cb) = @_; |
1926 | my ($self, $text, $cb) = @_; |
1800 | |
1927 | |
1801 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1928 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1802 | } |
1929 | } |
1803 | |
1930 | |
1804 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1931 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1805 | |
1932 | |
1806 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1933 | Adds a toggle/checkbox item to the popup. The callback gets called |
1807 | whenever it gets toggled, with a boolean indicating its value as its first |
1934 | whenever it gets toggled, with a boolean indicating its new value as its |
1808 | argument. |
1935 | first argument. |
1809 | |
1936 | |
1810 | =cut |
1937 | =cut |
1811 | |
1938 | |
1812 | sub add_toggle { |
1939 | sub add_toggle { |
1813 | my ($self, $text, $cb, $value) = @_; |
1940 | my ($self, $text, $value, $cb) = @_; |
1814 | |
1941 | |
1815 | my $item; $item = { |
1942 | my $item; $item = { |
1816 | type => "button", |
1943 | type => "button", |
1817 | text => " $text", |
1944 | text => " $text", |
1818 | value => $value, |
1945 | value => $value, |
… | |
… | |
1859 | =back |
1986 | =back |
1860 | |
1987 | |
1861 | =cut |
1988 | =cut |
1862 | |
1989 | |
1863 | package urxvt::watcher; |
1990 | package urxvt::watcher; |
1864 | |
|
|
1865 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1866 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1867 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1868 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1869 | |
1991 | |
1870 | =head2 The C<urxvt::timer> Class |
1992 | =head2 The C<urxvt::timer> Class |
1871 | |
1993 | |
1872 | This class implements timer watchers/events. Time is represented as a |
1994 | This class implements timer watchers/events. Time is represented as a |
1873 | fractional number of seconds since the epoch. Example: |
1995 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1953 | Set the callback to be called when io events are triggered. C<$reventmask> |
2075 | Set the callback to be called when io events are triggered. C<$reventmask> |
1954 | is a bitset as described in the C<events> method. |
2076 | is a bitset as described in the C<events> method. |
1955 | |
2077 | |
1956 | =item $iow = $iow->fd ($fd) |
2078 | =item $iow = $iow->fd ($fd) |
1957 | |
2079 | |
1958 | Set the filedescriptor (not handle) to watch. |
2080 | Set the file descriptor (not handle) to watch. |
1959 | |
2081 | |
1960 | =item $iow = $iow->events ($eventmask) |
2082 | =item $iow = $iow->events ($eventmask) |
1961 | |
2083 | |
1962 | Set the event mask to watch. The only allowed values are |
2084 | Set the event mask to watch. The only allowed values are |
1963 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2085 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
… | |
… | |
1967 | |
2089 | |
1968 | Start watching for requested events on the given handle. |
2090 | Start watching for requested events on the given handle. |
1969 | |
2091 | |
1970 | =item $iow = $iow->stop |
2092 | =item $iow = $iow->stop |
1971 | |
2093 | |
1972 | Stop watching for events on the given filehandle. |
2094 | Stop watching for events on the given file handle. |
1973 | |
2095 | |
1974 | =back |
2096 | =back |
1975 | |
2097 | |
1976 | =head2 The C<urxvt::iw> Class |
2098 | =head2 The C<urxvt::iw> Class |
1977 | |
2099 | |
… | |
… | |
2024 | |
2146 | |
2025 | Set the callback to be called when the timer triggers. |
2147 | Set the callback to be called when the timer triggers. |
2026 | |
2148 | |
2027 | =item $pw = $timer->start ($pid) |
2149 | =item $pw = $timer->start ($pid) |
2028 | |
2150 | |
2029 | Tells the wqtcher to start watching for process C<$pid>. |
2151 | Tells the watcher to start watching for process C<$pid>. |
2030 | |
2152 | |
2031 | =item $pw = $pw->stop |
2153 | =item $pw = $pw->stop |
2032 | |
2154 | |
2033 | Stop the watcher. |
2155 | Stop the watcher. |
2034 | |
2156 | |
… | |
… | |
2047 | |
2169 | |
2048 | =item >= 3 - script loading and management |
2170 | =item >= 3 - script loading and management |
2049 | |
2171 | |
2050 | =item >=10 - all called hooks |
2172 | =item >=10 - all called hooks |
2051 | |
2173 | |
2052 | =item >=11 - hook reutrn values |
2174 | =item >=11 - hook return values |
2053 | |
2175 | |
2054 | =back |
2176 | =back |
2055 | |
2177 | |
2056 | =head1 AUTHOR |
2178 | =head1 AUTHOR |
2057 | |
2179 | |
… | |
… | |
2059 | http://software.schmorp.de/pkg/rxvt-unicode |
2181 | http://software.schmorp.de/pkg/rxvt-unicode |
2060 | |
2182 | |
2061 | =cut |
2183 | =cut |
2062 | |
2184 | |
2063 | 1 |
2185 | 1 |
|
|
2186 | |
|
|
2187 | # vim: sw=3: |