… | |
… | |
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. |
|
|
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 |
160 | 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 |
161 | cursor-left or cursor-right keypresses as required (the this only works |
170 | cursor-left or cursor-right keypresses as required (this only works |
162 | for programs that correctly support wide characters). |
171 | for programs that correctly support wide characters). |
163 | |
172 | |
164 | To avoid too many false positives, this is only done when: |
173 | To avoid too many false positives, this is only done when: |
165 | |
174 | |
166 | =over 4 |
175 | =over 4 |
… | |
… | |
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 | |
258 | =item automove-background |
289 | =item kuake<hotkey> |
259 | |
290 | |
260 | This is basically a very small extension that dynamically changes the |
291 | A very primitive quake-console-like extension. It was inspired by a |
261 | background pixmap offset to the window position, in effect creating the |
292 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
262 | same effect as pseudo transparency with a custom pixmap. No scaling is |
293 | user presses a global accelerator key (by default C<F10>), the terminal |
263 | supported in this mode. Exmaple: |
294 | will show or hide itself. Another press of the accelerator key will hide |
|
|
295 | or show it again. |
264 | |
296 | |
265 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
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). |
266 | |
307 | |
267 | =item block-graphics-to-ascii |
308 | =item block-graphics-to-ascii |
268 | |
309 | |
269 | 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 |
270 | 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 |
… | |
… | |
275 | Displays a digital clock using the built-in overlay. |
316 | Displays a digital clock using the built-in overlay. |
276 | |
317 | |
277 | =item remote-clipboard |
318 | =item remote-clipboard |
278 | |
319 | |
279 | 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 |
280 | 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 |
281 | selection somewhere and fetch it again. |
322 | selection somewhere and fetch it again. |
282 | |
323 | |
283 | We use it to implement a "distributed selection mechanism", which just |
324 | We use it to implement a "distributed selection mechanism", which just |
284 | 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 |
285 | reads it. |
326 | reads it. |
… | |
… | |
320 | 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 |
321 | 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 |
322 | for the filename): |
363 | for the filename): |
323 | |
364 | |
324 | 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. |
325 | |
371 | |
326 | =item example-refresh-hooks |
372 | =item example-refresh-hooks |
327 | |
373 | |
328 | 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 |
329 | window. Illustrates overwriting the refresh callbacks to create your own |
375 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
370 | =back |
416 | =back |
371 | |
417 | |
372 | =head2 Extension Objects |
418 | =head2 Extension Objects |
373 | |
419 | |
374 | 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 |
375 | 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, |
376 | 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 |
377 | 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 |
378 | begin with an underscore character C<_>: these are reserved for internal |
425 | that begin with an underscore character C<_>: these are reserved for |
379 | use. |
426 | internal use. |
380 | |
427 | |
381 | 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 |
382 | C<urxvt::term> class on this object. |
429 | C<urxvt::term> class on this object. |
383 | |
430 | |
384 | It has the following methods and data members: |
431 | It has the following methods and data members: |
… | |
… | |
405 | =head2 Hooks |
452 | =head2 Hooks |
406 | |
453 | |
407 | 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 |
408 | called whenever the relevant event happens. |
455 | called whenever the relevant event happens. |
409 | |
456 | |
410 | 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 |
411 | the in the C<Extension Objects> section. |
458 | the in the C<Extension Objects> section. |
412 | |
459 | |
413 | 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 |
414 | 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 |
415 | relevant action might not be carried out by the C++ code. |
462 | relevant action might not be carried out by the C++ code. |
… | |
… | |
428 | place. |
475 | place. |
429 | |
476 | |
430 | =item on_start $term |
477 | =item on_start $term |
431 | |
478 | |
432 | 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 |
433 | trying to map (display) the toplevel and returning to the mainloop. |
480 | trying to map (display) the toplevel and returning to the main loop. |
434 | |
481 | |
435 | =item on_destroy $term |
482 | =item on_destroy $term |
436 | |
483 | |
437 | Called whenever something tries to destroy terminal, when the terminal is |
484 | Called whenever something tries to destroy terminal, when the terminal is |
438 | still fully functional (not for long, though). |
485 | still fully functional (not for long, though). |
… | |
… | |
465 | |
512 | |
466 | 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 |
467 | 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 |
468 | by calling C<< $term->selection >>. |
515 | by calling C<< $term->selection >>. |
469 | |
516 | |
470 | 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. |
471 | |
518 | |
472 | =item on_sel_extend $term |
519 | =item on_sel_extend $term |
473 | |
520 | |
474 | 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 |
475 | click) and is either supposed to return false (normal operation), or |
522 | click) and is either supposed to return false (normal operation), or |
476 | 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 |
477 | processing. This can happen multiple times, as long as the callback |
524 | processing. This can happen multiple times, as long as the callback |
478 | 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 |
479 | supposed to enlarge the selection more and more, if possible. |
526 | supposed to enlarge the selection more and more, if possible. |
480 | |
527 | |
481 | See the F<selection> example extension. |
528 | See the F<selection> example extension. |
482 | |
529 | |
483 | =item on_view_change $term, $offset |
530 | =item on_view_change $term, $offset |
484 | |
531 | |
485 | 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 |
486 | scrolls. Offset C<0> means display the normal terminal, positive values |
533 | scrolls. Offset C<0> means display the normal terminal, positive values |
487 | show this many lines of scrollback. |
534 | show this many lines of scrollback. |
488 | |
535 | |
489 | =item on_scroll_back $term, $lines, $saved |
536 | =item on_scroll_back $term, $lines, $saved |
490 | |
537 | |
… | |
… | |
514 | 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 |
515 | 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 |
516 | future. |
563 | future. |
517 | |
564 | |
518 | 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, |
519 | 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 |
520 | other users on the same system etc.). |
567 | other users on the same system etc.). |
521 | |
568 | |
522 | =item on_add_lines $term, $string |
569 | =item on_add_lines $term, $string |
523 | |
570 | |
524 | 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 |
… | |
… | |
557 | |
604 | |
558 | 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>. |
559 | |
606 | |
560 | =item on_user_command $term, $string |
607 | =item on_user_command $term, $string |
561 | |
608 | |
562 | 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 |
563 | 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> |
564 | resource in the @@RXVT_NAME@@(1) manpage). |
611 | resource in the @@RXVT_NAME@@(1) manpage). |
565 | |
612 | |
566 | 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 |
567 | slightly in the future. |
614 | slightly in the future. |
568 | |
615 | |
569 | =item on_resize_all_windows $tern, $new_width, $new_height |
616 | =item on_resize_all_windows $tern, $new_width, $new_height |
570 | |
617 | |
571 | 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 |
572 | 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 |
573 | returns TRUE, setting of the window hints is being skipped. |
620 | returns TRUE, setting of the window hints is being skipped. |
574 | |
621 | |
575 | =item on_x_event $term, $event |
622 | =item on_x_event $term, $event |
576 | |
623 | |
577 | Called on every X event received on the vt window (and possibly other |
624 | Called on every X event received on the vt window (and possibly other |
578 | windows). Should only be used as a last resort. Most event structure |
625 | windows). Should only be used as a last resort. Most event structure |
579 | members are not passed. |
626 | members are not passed. |
580 | |
627 | |
|
|
628 | =item on_root_event $term, $event |
|
|
629 | |
|
|
630 | Like C<on_x_event>, but is called for events on the root window. |
|
|
631 | |
581 | =item on_focus_in $term |
632 | =item on_focus_in $term |
582 | |
633 | |
583 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
634 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
584 | does focus in processing. |
635 | does focus in processing. |
585 | |
636 | |
586 | =item on_focus_out $term |
637 | =item on_focus_out $term |
587 | |
638 | |
588 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
639 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
589 | focus out processing. |
640 | focus out processing. |
590 | |
641 | |
591 | =item on_configure_notify $term, $event |
642 | =item on_configure_notify $term, $event |
592 | |
643 | |
593 | =item on_property_notify $term, $event |
644 | =item on_property_notify $term, $event |
… | |
… | |
676 | The current terminal. This variable stores the current C<urxvt::term> |
727 | The current terminal. This variable stores the current C<urxvt::term> |
677 | object, whenever a callback/hook is executing. |
728 | object, whenever a callback/hook is executing. |
678 | |
729 | |
679 | =item @urxvt::TERM_INIT |
730 | =item @urxvt::TERM_INIT |
680 | |
731 | |
681 | 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 |
682 | 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 |
683 | 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, |
684 | 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. |
685 | |
736 | |
686 | This complements to the perl-eval commandline option, but gets executed |
737 | This complements to the perl-eval command line option, but gets executed |
687 | first. |
738 | first. |
688 | |
739 | |
689 | =item @urxvt::TERM_EXT |
740 | =item @urxvt::TERM_EXT |
690 | |
741 | |
691 | 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 |
… | |
… | |
716 | Messages have a size limit of 1023 bytes currently. |
767 | Messages have a size limit of 1023 bytes currently. |
717 | |
768 | |
718 | =item @terms = urxvt::termlist |
769 | =item @terms = urxvt::termlist |
719 | |
770 | |
720 | 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 |
721 | 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 |
722 | objects that have perl extensions attached will be returned (because there |
773 | objects that have perl extensions attached will be returned (because there |
723 | is no urxvt::term objet associated with others). |
774 | is no urxvt::term objet associated with others). |
724 | |
775 | |
725 | =item $time = urxvt::NOW |
776 | =item $time = urxvt::NOW |
726 | |
777 | |
… | |
… | |
864 | local $TERM = shift; |
915 | local $TERM = shift; |
865 | my $htype = shift; |
916 | my $htype = shift; |
866 | |
917 | |
867 | if ($htype == 0) { # INIT |
918 | if ($htype == 0) { # INIT |
868 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
919 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
869 | |
920 | |
870 | my %ext_arg; |
921 | my %ext_arg; |
871 | |
922 | |
872 | { |
923 | { |
873 | my @init = @TERM_INIT; |
924 | my @init = @TERM_INIT; |
874 | @TERM_INIT = (); |
925 | @TERM_INIT = (); |
… | |
… | |
937 | |
988 | |
938 | sub SET_COLOR($$$) { |
989 | sub SET_COLOR($$$) { |
939 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
990 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
940 | } |
991 | } |
941 | |
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 | |
942 | # urxvt::term::extension |
1018 | # urxvt::term::extension |
943 | |
1019 | |
944 | package urxvt::term::extension; |
1020 | package urxvt::term::extension; |
945 | |
1021 | |
946 | sub enable { |
1022 | sub enable { |
… | |
… | |
1057 | sub DESTROY { |
1133 | sub DESTROY { |
1058 | $_[0][1]->stop; |
1134 | $_[0][1]->stop; |
1059 | } |
1135 | } |
1060 | |
1136 | |
1061 | sub condvar { |
1137 | sub condvar { |
1062 | bless \my $flag, urxvt::anyevent::condvar:: |
1138 | bless \my $flag, urxvt::anyevent:: |
1063 | } |
1139 | } |
1064 | |
1140 | |
1065 | sub urxvt::anyevent::condvar::broadcast { |
1141 | sub broadcast { |
1066 | ${$_[0]}++; |
1142 | ${$_[0]}++; |
1067 | } |
1143 | } |
1068 | |
1144 | |
1069 | sub urxvt::anyevent::condvar::wait { |
1145 | sub wait { |
1070 | unless (${$_[0]}) { |
1146 | unless (${$_[0]}) { |
1071 | 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"; |
1072 | } |
1148 | } |
|
|
1149 | } |
|
|
1150 | |
|
|
1151 | sub one_event { |
|
|
1152 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1073 | } |
1153 | } |
1074 | |
1154 | |
1075 | package urxvt::term; |
1155 | package urxvt::term; |
1076 | |
1156 | |
1077 | =head2 The C<urxvt::term> Class |
1157 | =head2 The C<urxvt::term> Class |
… | |
… | |
1164 | |
1244 | |
1165 | 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 |
1166 | 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 |
1167 | 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. |
1168 | |
1248 | |
1169 | 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 |
1170 | source file F</src/optinc.h> to see the actual list: |
1250 | source file F</src/optinc.h> to see the actual list: |
1171 | |
1251 | |
1172 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1252 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1173 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1253 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1174 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1254 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1191 | likely change). |
1271 | likely change). |
1192 | |
1272 | |
1193 | 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 |
1194 | terminal is destroyed, so changing options frequently will eat memory. |
1274 | terminal is destroyed, so changing options frequently will eat memory. |
1195 | |
1275 | |
1196 | 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 |
1197 | 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> |
1198 | to see the actual list: |
1278 | to see the actual list: |
1199 | |
1279 | |
1200 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1280 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1201 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1281 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1513 | |
1593 | |
1514 | Returns the currently displayed screen (0 primary, 1 secondary). |
1594 | Returns the currently displayed screen (0 primary, 1 secondary). |
1515 | |
1595 | |
1516 | =item $cursor_is_hidden = $term->hidden_cursor |
1596 | =item $cursor_is_hidden = $term->hidden_cursor |
1517 | |
1597 | |
1518 | Returns wether the cursor is currently hidden or not. |
1598 | Returns whether the cursor is currently hidden or not. |
1519 | |
1599 | |
1520 | =item $view_start = $term->view_start ([$newvalue]) |
1600 | =item $view_start = $term->view_start ([$newvalue]) |
1521 | |
1601 | |
1522 | 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 |
1523 | C<0>, which displays the normal terminal contents. Lower values scroll |
1603 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1545 | automatically be updated. |
1625 | automatically be updated. |
1546 | |
1626 | |
1547 | 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 |
1548 | 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) |
1549 | characters. Characters with combining characters and other characters that |
1629 | characters. Characters with combining characters and other characters that |
1550 | 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 |
1551 | in the private use area. |
1631 | in the private use area. |
1552 | |
1632 | |
1553 | 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 |
1554 | 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 |
1555 | characters. |
1635 | characters. |
… | |
… | |
1700 | where one character corresponds to one screen cell. See |
1780 | where one character corresponds to one screen cell. See |
1701 | C<< $term->ROW_t >> for details. |
1781 | C<< $term->ROW_t >> for details. |
1702 | |
1782 | |
1703 | =item $string = $term->special_decode $text |
1783 | =item $string = $term->special_decode $text |
1704 | |
1784 | |
1705 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1785 | Converts rxvt-unicodes text representation into a perl string. See |
1706 | C<< $term->ROW_t >> for details. |
1786 | C<< $term->ROW_t >> for details. |
1707 | |
1787 | |
1708 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1788 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1709 | |
1789 | |
1710 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
1790 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1713 | manpage. |
1793 | manpage. |
1714 | |
1794 | |
1715 | =item $success = $term->grab ($eventtime[, $sync]) |
1795 | =item $success = $term->grab ($eventtime[, $sync]) |
1716 | |
1796 | |
1717 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1797 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1718 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1798 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1719 | |
1799 | |
1720 | =item $term->allow_events_async |
1800 | =item $term->allow_events_async |
1721 | |
1801 | |
1722 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1802 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1723 | |
1803 | |
… | |
… | |
1897 | |
1977 | |
1898 | =cut |
1978 | =cut |
1899 | |
1979 | |
1900 | package urxvt::watcher; |
1980 | package urxvt::watcher; |
1901 | |
1981 | |
1902 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1903 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1904 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1905 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1906 | |
|
|
1907 | =head2 The C<urxvt::timer> Class |
1982 | =head2 The C<urxvt::timer> Class |
1908 | |
1983 | |
1909 | This class implements timer watchers/events. Time is represented as a |
1984 | This class implements timer watchers/events. Time is represented as a |
1910 | fractional number of seconds since the epoch. Example: |
1985 | fractional number of seconds since the epoch. Example: |
1911 | |
1986 | |
… | |
… | |
1914 | ->new |
1989 | ->new |
1915 | ->interval (1) |
1990 | ->interval (1) |
1916 | ->cb (sub { |
1991 | ->cb (sub { |
1917 | $term->{overlay}->set (0, 0, |
1992 | $term->{overlay}->set (0, 0, |
1918 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1993 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1919 | }); |
1994 | }); |
1920 | |
1995 | |
1921 | =over 4 |
1996 | =over 4 |
1922 | |
1997 | |
1923 | =item $timer = new urxvt::timer |
1998 | =item $timer = new urxvt::timer |
1924 | |
1999 | |
… | |
… | |
1967 | |
2042 | |
1968 | $term->{socket} = ... |
2043 | $term->{socket} = ... |
1969 | $term->{iow} = urxvt::iow |
2044 | $term->{iow} = urxvt::iow |
1970 | ->new |
2045 | ->new |
1971 | ->fd (fileno $term->{socket}) |
2046 | ->fd (fileno $term->{socket}) |
1972 | ->events (urxvt::EVENT_READ) |
2047 | ->events (urxvt::EV_READ) |
1973 | ->start |
2048 | ->start |
1974 | ->cb (sub { |
2049 | ->cb (sub { |
1975 | my ($iow, $revents) = @_; |
2050 | my ($iow, $revents) = @_; |
1976 | # $revents must be 1 here, no need to check |
2051 | # $revents must be 1 here, no need to check |
1977 | sysread $term->{socket}, my $buf, 8192 |
2052 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1990 | Set the callback to be called when io events are triggered. C<$reventmask> |
2065 | Set the callback to be called when io events are triggered. C<$reventmask> |
1991 | is a bitset as described in the C<events> method. |
2066 | is a bitset as described in the C<events> method. |
1992 | |
2067 | |
1993 | =item $iow = $iow->fd ($fd) |
2068 | =item $iow = $iow->fd ($fd) |
1994 | |
2069 | |
1995 | Set the filedescriptor (not handle) to watch. |
2070 | Set the file descriptor (not handle) to watch. |
1996 | |
2071 | |
1997 | =item $iow = $iow->events ($eventmask) |
2072 | =item $iow = $iow->events ($eventmask) |
1998 | |
2073 | |
1999 | Set the event mask to watch. The only allowed values are |
2074 | Set the event mask to watch. The only allowed values are |
2000 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2075 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
2001 | together, or C<urxvt::EVENT_NONE>. |
2076 | together, or C<urxvt::EV_NONE>. |
2002 | |
2077 | |
2003 | =item $iow = $iow->start |
2078 | =item $iow = $iow->start |
2004 | |
2079 | |
2005 | Start watching for requested events on the given handle. |
2080 | Start watching for requested events on the given handle. |
2006 | |
2081 | |
2007 | =item $iow = $iow->stop |
2082 | =item $iow = $iow->stop |
2008 | |
2083 | |
2009 | Stop watching for events on the given filehandle. |
2084 | Stop watching for events on the given file handle. |
2010 | |
2085 | |
2011 | =back |
2086 | =back |
2012 | |
2087 | |
2013 | =head2 The C<urxvt::iw> Class |
2088 | =head2 The C<urxvt::iw> Class |
2014 | |
2089 | |
… | |
… | |
2047 | ->new |
2122 | ->new |
2048 | ->start ($pid) |
2123 | ->start ($pid) |
2049 | ->cb (sub { |
2124 | ->cb (sub { |
2050 | my ($pw, $exit_status) = @_; |
2125 | my ($pw, $exit_status) = @_; |
2051 | ... |
2126 | ... |
2052 | }); |
2127 | }); |
2053 | |
2128 | |
2054 | =over 4 |
2129 | =over 4 |
2055 | |
2130 | |
2056 | =item $pw = new urxvt::pw |
2131 | =item $pw = new urxvt::pw |
2057 | |
2132 | |
… | |
… | |
2061 | |
2136 | |
2062 | Set the callback to be called when the timer triggers. |
2137 | Set the callback to be called when the timer triggers. |
2063 | |
2138 | |
2064 | =item $pw = $timer->start ($pid) |
2139 | =item $pw = $timer->start ($pid) |
2065 | |
2140 | |
2066 | Tells the wqtcher to start watching for process C<$pid>. |
2141 | Tells the watcher to start watching for process C<$pid>. |
2067 | |
2142 | |
2068 | =item $pw = $pw->stop |
2143 | =item $pw = $pw->stop |
2069 | |
2144 | |
2070 | Stop the watcher. |
2145 | Stop the watcher. |
2071 | |
2146 | |
… | |
… | |
2084 | |
2159 | |
2085 | =item >= 3 - script loading and management |
2160 | =item >= 3 - script loading and management |
2086 | |
2161 | |
2087 | =item >=10 - all called hooks |
2162 | =item >=10 - all called hooks |
2088 | |
2163 | |
2089 | =item >=11 - hook reutrn values |
2164 | =item >=11 - hook return values |
2090 | |
2165 | |
2091 | =back |
2166 | =back |
2092 | |
2167 | |
2093 | =head1 AUTHOR |
2168 | =head1 AUTHOR |
2094 | |
2169 | |
… | |
… | |
2096 | http://software.schmorp.de/pkg/rxvt-unicode |
2171 | http://software.schmorp.de/pkg/rxvt-unicode |
2097 | |
2172 | |
2098 | =cut |
2173 | =cut |
2099 | |
2174 | |
2100 | 1 |
2175 | 1 |
|
|
2176 | |
|
|
2177 | # vim: sw=3: |