… | |
… | |
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 | |
109 | The following will add an entry C<myoption> that changes |
112 | The following will add an entry C<myoption> that changes |
110 | C<$self->{myoption}>: |
113 | C<< $self->{myoption} >>: |
111 | |
114 | |
112 | push @{ $self->{term}{option_popup_hook} }, sub { |
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
113 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
114 | }; |
117 | }; |
115 | |
118 | |
… | |
… | |
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 one-line extension that dynamically changes the background pixmap offset |
291 | A very primitive quake-console-like extension. It was inspired by a |
261 | to the window position, in effect creating the same effect as pseudo transparency with |
292 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
262 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
293 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
294 | will show or hide itself. Another press of the accelerator key will hide |
|
|
295 | or show it again. |
263 | |
296 | |
264 | @@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). |
|
|
307 | |
|
|
308 | =item overlay-osc |
|
|
309 | |
|
|
310 | This extension implements some OSC commands to display timed popups on the |
|
|
311 | screen - useful for status displays from within scripts. You have to read |
|
|
312 | the sources for more info. |
265 | |
313 | |
266 | =item block-graphics-to-ascii |
314 | =item block-graphics-to-ascii |
267 | |
315 | |
268 | A not very useful example of filtering all text output to the terminal, |
316 | A not very useful example of filtering all text output to the terminal |
269 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
317 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
270 | similar-looking ascii character. |
318 | similar-looking ascii character. |
271 | |
319 | |
272 | =item digital-clock |
320 | =item digital-clock |
273 | |
321 | |
274 | Displays a digital clock using the built-in overlay. |
322 | Displays a digital clock using the built-in overlay. |
275 | |
323 | |
276 | =item remote-clipboard |
324 | =item remote-clipboard |
277 | |
325 | |
278 | Somewhat of a misnomer, this extension adds two menu entries to the |
326 | Somewhat of a misnomer, this extension adds two menu entries to the |
279 | selection popup that allows one ti run external commands to store the |
327 | selection popup that allows one to run external commands to store the |
280 | selection somewhere and fetch it again. |
328 | selection somewhere and fetch it again. |
281 | |
329 | |
282 | We use it to implement a "distributed selection mechanism", which just |
330 | We use it to implement a "distributed selection mechanism", which just |
283 | means that one command uploads the file to a remote server, and another |
331 | means that one command uploads the file to a remote server, and another |
284 | reads it. |
332 | reads it. |
… | |
… | |
319 | After a successful upload the selection will be replaced by the text given |
367 | After a successful upload the selection will be replaced by the text given |
320 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
368 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
321 | for the filename): |
369 | for the filename): |
322 | |
370 | |
323 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
371 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
372 | |
|
|
373 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
374 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
375 | which works regardless of wether xrdb is used to parse the resource file |
|
|
376 | or not. |
|
|
377 | |
|
|
378 | =item macosx-pastebin and macosx-pastebin-native |
|
|
379 | |
|
|
380 | These two modules implement an extended clipboard for Mac OS X. They are |
|
|
381 | used like this: |
|
|
382 | |
|
|
383 | URxvt.perl-ext-common: default,macosx-clipboard |
|
|
384 | URxvt.keysym.M-c: perl:macosx-clipboard:copy |
|
|
385 | URxvt.keysym.M-v: perl:macosx-clipboard:paste |
|
|
386 | |
|
|
387 | The difference between them is that the native variant requires a |
|
|
388 | perl from apple's devkit or so, and C<maxosx-pastebin> requires the |
|
|
389 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
|
|
390 | simpler etc. etc. |
324 | |
391 | |
325 | =item example-refresh-hooks |
392 | =item example-refresh-hooks |
326 | |
393 | |
327 | Displays a very simple digital clock in the upper right corner of the |
394 | Displays a very simple digital clock in the upper right corner of the |
328 | window. Illustrates overwriting the refresh callbacks to create your own |
395 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
369 | =back |
436 | =back |
370 | |
437 | |
371 | =head2 Extension Objects |
438 | =head2 Extension Objects |
372 | |
439 | |
373 | Every perl extension is a perl class. A separate perl object is created |
440 | Every perl extension is a perl class. A separate perl object is created |
374 | for each terminal and each extension and passed as the first parameter to |
441 | for each terminal, and each terminal has its own set of extenion objects, |
375 | hooks. So extensions can use their C<$self> object without having to think |
442 | which are passed as the first parameter to hooks. So extensions can use |
376 | about other extensions, with the exception of methods and members that |
443 | their C<$self> object without having to think about clashes with other |
|
|
444 | extensions or other terminals, with the exception of methods and members |
377 | begin with an underscore character C<_>: these are reserved for internal |
445 | that begin with an underscore character C<_>: these are reserved for |
378 | use. |
446 | internal use. |
379 | |
447 | |
380 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
448 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
381 | C<urxvt::term> class on this object. |
449 | C<urxvt::term> class on this object. |
382 | |
450 | |
383 | It has the following methods and data members: |
451 | It has the following methods and data members: |
… | |
… | |
404 | =head2 Hooks |
472 | =head2 Hooks |
405 | |
473 | |
406 | The following subroutines can be declared in extension files, and will be |
474 | The following subroutines can be declared in extension files, and will be |
407 | called whenever the relevant event happens. |
475 | called whenever the relevant event happens. |
408 | |
476 | |
409 | The first argument passed to them is an extension oject as described in |
477 | The first argument passed to them is an extension object as described in |
410 | the in the C<Extension Objects> section. |
478 | the in the C<Extension Objects> section. |
411 | |
479 | |
412 | B<All> of these hooks must return a boolean value. If any of the called |
480 | B<All> of these hooks must return a boolean value. If any of the called |
413 | hooks returns true, then the event counts as being I<consumed>, and the |
481 | hooks returns true, then the event counts as being I<consumed>, and the |
414 | relevant action might not be carried out by the C++ code. |
482 | relevant action might not be carried out by the C++ code. |
… | |
… | |
427 | place. |
495 | place. |
428 | |
496 | |
429 | =item on_start $term |
497 | =item on_start $term |
430 | |
498 | |
431 | Called at the very end of initialisation of a new terminal, just before |
499 | Called at the very end of initialisation of a new terminal, just before |
432 | trying to map (display) the toplevel and returning to the mainloop. |
500 | trying to map (display) the toplevel and returning to the main loop. |
433 | |
501 | |
434 | =item on_destroy $term |
502 | =item on_destroy $term |
435 | |
503 | |
436 | Called whenever something tries to destroy terminal, when the terminal is |
504 | Called whenever something tries to destroy terminal, when the terminal is |
437 | still fully functional (not for long, though). |
505 | still fully functional (not for long, though). |
… | |
… | |
464 | |
532 | |
465 | Called whenever a selection has been copied, but before the selection is |
533 | Called whenever a selection has been copied, but before the selection is |
466 | requested from the server. The selection text can be queried and changed |
534 | requested from the server. The selection text can be queried and changed |
467 | by calling C<< $term->selection >>. |
535 | by calling C<< $term->selection >>. |
468 | |
536 | |
469 | Returning a true value aborts selection grabbing. It will still be hilighted. |
537 | Returning a true value aborts selection grabbing. It will still be highlighted. |
470 | |
538 | |
471 | =item on_sel_extend $term |
539 | =item on_sel_extend $term |
472 | |
540 | |
473 | Called whenever the user tries to extend the selection (e.g. with a double |
541 | Called whenever the user tries to extend the selection (e.g. with a double |
474 | click) and is either supposed to return false (normal operation), or |
542 | click) and is either supposed to return false (normal operation), or |
475 | should extend the selection itelf and return true to suppress the built-in |
543 | should extend the selection itself and return true to suppress the built-in |
476 | processing. This can happen multiple times, as long as the callback |
544 | processing. This can happen multiple times, as long as the callback |
477 | returns true, it will be called on every further click by the user and is |
545 | returns true, it will be called on every further click by the user and is |
478 | supposed to enlarge the selection more and more, if possible. |
546 | supposed to enlarge the selection more and more, if possible. |
479 | |
547 | |
480 | See the F<selection> example extension. |
548 | See the F<selection> example extension. |
481 | |
549 | |
482 | =item on_view_change $term, $offset |
550 | =item on_view_change $term, $offset |
483 | |
551 | |
484 | Called whenever the view offset changes, i..e the user or program |
552 | Called whenever the view offset changes, i.e. the user or program |
485 | scrolls. Offset C<0> means display the normal terminal, positive values |
553 | scrolls. Offset C<0> means display the normal terminal, positive values |
486 | show this many lines of scrollback. |
554 | show this many lines of scrollback. |
487 | |
555 | |
488 | =item on_scroll_back $term, $lines, $saved |
556 | =item on_scroll_back $term, $lines, $saved |
489 | |
557 | |
… | |
… | |
493 | |
561 | |
494 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
562 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
495 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
563 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
496 | number of lines that will be in the scrollback buffer. |
564 | number of lines that will be in the scrollback buffer. |
497 | |
565 | |
498 | =item on_osc_seq $term, $op, $args |
566 | =item on_osc_seq $term, $op, $args, $resp |
499 | |
567 | |
500 | Called on every OSC sequence and can be used to suppress it or modify its |
568 | Called on every OSC sequence and can be used to suppress it or modify its |
501 | behaviour. The default should be to return an empty list. A true value |
569 | behaviour. The default should be to return an empty list. A true value |
502 | suppresses execution of the request completely. Make sure you don't get |
570 | suppresses execution of the request completely. Make sure you don't get |
503 | confused by recursive invocations when you output an osc sequence within |
571 | confused by recursive invocations when you output an OSC sequence within |
504 | this callback. |
572 | this callback. |
505 | |
573 | |
506 | C<on_osc_seq_perl> should be used for new behaviour. |
574 | C<on_osc_seq_perl> should be used for new behaviour. |
507 | |
575 | |
508 | =item on_osc_seq_perl $term, $string |
576 | =item on_osc_seq_perl $term, $args, $resp |
509 | |
577 | |
510 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
578 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
511 | operating system command) is processed. Cursor position and other state |
579 | operating system command) is processed. Cursor position and other state |
512 | information is up-to-date when this happens. For interoperability, the |
580 | information is up-to-date when this happens. For interoperability, the |
513 | string should start with the extension name and a colon, to distinguish |
581 | string should start with the extension name (sans -osc) and a semicolon, |
514 | it from commands for other extensions, and this might be enforced in the |
582 | to distinguish it from commands for other extensions, and this might be |
515 | future. |
583 | enforced in the future. |
|
|
584 | |
|
|
585 | For example, C<overlay-osc> uses this: |
|
|
586 | |
|
|
587 | sub on_osc_seq_perl { |
|
|
588 | my ($self, $osc, $resp) = @_; |
|
|
589 | |
|
|
590 | return unless $osc =~ s/^overlay;//; |
|
|
591 | |
|
|
592 | ... process remaining $osc string |
|
|
593 | } |
516 | |
594 | |
517 | Be careful not ever to trust (in a security sense) the data you receive, |
595 | Be careful not ever to trust (in a security sense) the data you receive, |
518 | as its source can not easily be controleld (e-mail content, messages from |
596 | as its source can not easily be controlled (e-mail content, messages from |
519 | other users on the same system etc.). |
597 | other users on the same system etc.). |
|
|
598 | |
|
|
599 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
600 | sender. |
520 | |
601 | |
521 | =item on_add_lines $term, $string |
602 | =item on_add_lines $term, $string |
522 | |
603 | |
523 | Called whenever text is about to be output, with the text as argument. You |
604 | Called whenever text is about to be output, with the text as argument. You |
524 | can filter/change and output the text yourself by returning a true value |
605 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
545 | later with the already-modified line (e.g. if unrelated parts change), so |
626 | later with the already-modified line (e.g. if unrelated parts change), so |
546 | you cannot just toggle rendition bits, but only set them. |
627 | you cannot just toggle rendition bits, but only set them. |
547 | |
628 | |
548 | =item on_refresh_begin $term |
629 | =item on_refresh_begin $term |
549 | |
630 | |
550 | Called just before the screen gets redrawn. Can be used for overlay |
631 | Called just before the screen gets redrawn. Can be used for overlay or |
551 | or similar effects by modify terminal contents in refresh_begin, and |
632 | similar effects by modifying the terminal contents in refresh_begin, and |
552 | restoring them in refresh_end. The built-in overlay and selection display |
633 | restoring them in refresh_end. The built-in overlay and selection display |
553 | code is run after this hook, and takes precedence. |
634 | code is run after this hook, and takes precedence. |
554 | |
635 | |
555 | =item on_refresh_end $term |
636 | =item on_refresh_end $term |
556 | |
637 | |
557 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
638 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
558 | |
639 | |
559 | =item on_user_command $term, $string |
640 | =item on_user_command $term, $string |
560 | |
641 | |
561 | Called whenever the a user-configured event is being activated (e.g. via |
642 | Called whenever a user-configured event is being activated (e.g. via |
562 | a C<perl:string> action bound to a key, see description of the B<keysym> |
643 | a C<perl:string> action bound to a key, see description of the B<keysym> |
563 | resource in the @@RXVT_NAME@@(1) manpage). |
644 | resource in the @@RXVT_NAME@@(1) manpage). |
564 | |
645 | |
565 | The event is simply the action string. This interface is assumed to change |
646 | The event is simply the action string. This interface is assumed to change |
566 | slightly in the future. |
647 | slightly in the future. |
567 | |
648 | |
568 | =item on_resize_all_windows $tern, $new_width, $new_height |
649 | =item on_resize_all_windows $tern, $new_width, $new_height |
569 | |
650 | |
570 | Called just after the new window size has been calculcated, but before |
651 | Called just after the new window size has been calculated, but before |
571 | windows are actually being resized or hints are being set. If this hook |
652 | windows are actually being resized or hints are being set. If this hook |
572 | returns TRUE, setting of the window hints is being skipped. |
653 | returns TRUE, setting of the window hints is being skipped. |
573 | |
654 | |
574 | =item on_x_event $term, $event |
655 | =item on_x_event $term, $event |
575 | |
656 | |
576 | Called on every X event received on the vt window (and possibly other |
657 | Called on every X event received on the vt window (and possibly other |
577 | windows). Should only be used as a last resort. Most event structure |
658 | windows). Should only be used as a last resort. Most event structure |
578 | members are not passed. |
659 | members are not passed. |
579 | |
660 | |
|
|
661 | =item on_root_event $term, $event |
|
|
662 | |
|
|
663 | Like C<on_x_event>, but is called for events on the root window. |
|
|
664 | |
580 | =item on_focus_in $term |
665 | =item on_focus_in $term |
581 | |
666 | |
582 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
667 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
583 | does focus in processing. |
668 | does focus in processing. |
584 | |
669 | |
585 | =item on_focus_out $term |
670 | =item on_focus_out $term |
586 | |
671 | |
587 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
672 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
588 | focus out processing. |
673 | focus out processing. |
589 | |
674 | |
590 | =item on_configure_notify $term, $event |
675 | =item on_configure_notify $term, $event |
591 | |
676 | |
592 | =item on_property_notify $term, $event |
677 | =item on_property_notify $term, $event |
… | |
… | |
675 | The current terminal. This variable stores the current C<urxvt::term> |
760 | The current terminal. This variable stores the current C<urxvt::term> |
676 | object, whenever a callback/hook is executing. |
761 | object, whenever a callback/hook is executing. |
677 | |
762 | |
678 | =item @urxvt::TERM_INIT |
763 | =item @urxvt::TERM_INIT |
679 | |
764 | |
680 | All coderefs in this array will be called as methods of the next newly |
765 | All code references in this array will be called as methods of the next newly |
681 | created C<urxvt::term> object (during the C<on_init> phase). The array |
766 | created C<urxvt::term> object (during the C<on_init> phase). The array |
682 | gets cleared before the codereferences that were in it are being executed, |
767 | gets cleared before the code references that were in it are being executed, |
683 | so coderefs can push themselves onto it again if they so desire. |
768 | so references can push themselves onto it again if they so desire. |
684 | |
769 | |
685 | This complements to the perl-eval commandline option, but gets executed |
770 | This complements to the perl-eval command line option, but gets executed |
686 | first. |
771 | first. |
687 | |
772 | |
688 | =item @urxvt::TERM_EXT |
773 | =item @urxvt::TERM_EXT |
689 | |
774 | |
690 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
775 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
715 | Messages have a size limit of 1023 bytes currently. |
800 | Messages have a size limit of 1023 bytes currently. |
716 | |
801 | |
717 | =item @terms = urxvt::termlist |
802 | =item @terms = urxvt::termlist |
718 | |
803 | |
719 | Returns all urxvt::term objects that exist in this process, regardless of |
804 | Returns all urxvt::term objects that exist in this process, regardless of |
720 | wether they are started, being destroyed etc., so be careful. Only term |
805 | whether they are started, being destroyed etc., so be careful. Only term |
721 | objects that have perl extensions attached will be returned (because there |
806 | objects that have perl extensions attached will be returned (because there |
722 | is no urxvt::term objet associated with others). |
807 | is no urxvt::term objet associated with others). |
723 | |
808 | |
724 | =item $time = urxvt::NOW |
809 | =item $time = urxvt::NOW |
725 | |
810 | |
… | |
… | |
863 | local $TERM = shift; |
948 | local $TERM = shift; |
864 | my $htype = shift; |
949 | my $htype = shift; |
865 | |
950 | |
866 | if ($htype == 0) { # INIT |
951 | if ($htype == 0) { # INIT |
867 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
952 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
868 | |
953 | |
869 | my %ext_arg; |
954 | my %ext_arg; |
870 | |
955 | |
871 | { |
956 | { |
872 | my @init = @TERM_INIT; |
957 | my @init = @TERM_INIT; |
873 | @TERM_INIT = (); |
958 | @TERM_INIT = (); |
… | |
… | |
936 | |
1021 | |
937 | sub SET_COLOR($$$) { |
1022 | sub SET_COLOR($$$) { |
938 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
1023 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
939 | } |
1024 | } |
940 | |
1025 | |
|
|
1026 | sub rend2mask { |
|
|
1027 | no strict 'refs'; |
|
|
1028 | my ($str, $mask) = (@_, 0); |
|
|
1029 | my %color = ( fg => undef, bg => undef ); |
|
|
1030 | my @failed; |
|
|
1031 | for my $spec ( split /\s+/, $str ) { |
|
|
1032 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1033 | $color{lc($1)} = $2; |
|
|
1034 | } else { |
|
|
1035 | my $neg = $spec =~ s/^[-^]//; |
|
|
1036 | unless ( exists &{"RS_$spec"} ) { |
|
|
1037 | push @failed, $spec; |
|
|
1038 | next; |
|
|
1039 | } |
|
|
1040 | my $cur = &{"RS_$spec"}; |
|
|
1041 | if ( $neg ) { |
|
|
1042 | $mask &= ~$cur; |
|
|
1043 | } else { |
|
|
1044 | $mask |= $cur; |
|
|
1045 | } |
|
|
1046 | } |
|
|
1047 | } |
|
|
1048 | ($mask, @color{qw(fg bg)}, \@failed) |
|
|
1049 | } |
|
|
1050 | |
941 | # urxvt::term::extension |
1051 | # urxvt::term::extension |
942 | |
1052 | |
943 | package urxvt::term::extension; |
1053 | package urxvt::term::extension; |
944 | |
1054 | |
945 | sub enable { |
1055 | sub enable { |
… | |
… | |
1014 | is that you cannot use blocking APIs, but the non-blocking variant should |
1124 | is that you cannot use blocking APIs, but the non-blocking variant should |
1015 | work. |
1125 | work. |
1016 | |
1126 | |
1017 | =cut |
1127 | =cut |
1018 | |
1128 | |
1019 | our $VERSION = 1; |
1129 | our $VERSION = '3.4'; |
1020 | |
1130 | |
1021 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1131 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1022 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1132 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1023 | |
1133 | |
1024 | sub timer { |
1134 | sub timer { |
… | |
… | |
1055 | |
1165 | |
1056 | sub DESTROY { |
1166 | sub DESTROY { |
1057 | $_[0][1]->stop; |
1167 | $_[0][1]->stop; |
1058 | } |
1168 | } |
1059 | |
1169 | |
1060 | sub condvar { |
1170 | sub one_event { |
1061 | bless \my $flag, urxvt::anyevent::condvar:: |
|
|
1062 | } |
|
|
1063 | |
|
|
1064 | sub urxvt::anyevent::condvar::broadcast { |
|
|
1065 | ${$_[0]}++; |
|
|
1066 | } |
|
|
1067 | |
|
|
1068 | sub urxvt::anyevent::condvar::wait { |
|
|
1069 | unless (${$_[0]}) { |
|
|
1070 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1171 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1071 | } |
|
|
1072 | } |
1172 | } |
1073 | |
1173 | |
1074 | package urxvt::term; |
1174 | package urxvt::term; |
1075 | |
1175 | |
1076 | =head2 The C<urxvt::term> Class |
1176 | =head2 The C<urxvt::term> Class |
… | |
… | |
1163 | |
1263 | |
1164 | Returns true if the option specified by C<$optval> is enabled, and |
1264 | Returns true if the option specified by C<$optval> is enabled, and |
1165 | optionally change it. All option values are stored by name in the hash |
1265 | optionally change it. All option values are stored by name in the hash |
1166 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1266 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1167 | |
1267 | |
1168 | Here is a a likely non-exhaustive list of option names, please see the |
1268 | Here is a likely non-exhaustive list of option names, please see the |
1169 | source file F</src/optinc.h> to see the actual list: |
1269 | source file F</src/optinc.h> to see the actual list: |
1170 | |
1270 | |
1171 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1271 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1172 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1272 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1173 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1273 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1190 | likely change). |
1290 | likely change). |
1191 | |
1291 | |
1192 | Please note that resource strings will currently only be freed when the |
1292 | Please note that resource strings will currently only be freed when the |
1193 | terminal is destroyed, so changing options frequently will eat memory. |
1293 | terminal is destroyed, so changing options frequently will eat memory. |
1194 | |
1294 | |
1195 | Here is a a likely non-exhaustive list of resource names, not all of which |
1295 | Here is a likely non-exhaustive list of resource names, not all of which |
1196 | are supported in every build, please see the source file F</src/rsinc.h> |
1296 | are supported in every build, please see the source file F</src/rsinc.h> |
1197 | to see the actual list: |
1297 | to see the actual list: |
1198 | |
1298 | |
1199 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1299 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1200 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1300 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1201 | display_name embed ext_bwidth fade font geometry hold iconName |
1301 | display_name embed ext_bwidth fade font geometry hold iconName |
1202 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1302 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1203 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1303 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1204 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1304 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1205 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1305 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1206 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1306 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1207 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1307 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1208 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1308 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1209 | secondaryScreen secondaryScroll selectstyle shade term_name title |
1309 | secondaryScreen secondaryScroll shade term_name title |
1210 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1310 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1211 | visualBell |
1311 | visualBell |
1212 | |
1312 | |
1213 | =cut |
1313 | =cut |
1214 | |
1314 | |
1215 | sub resource($$;$) { |
1315 | sub resource($$;$) { |
1216 | my ($self, $name) = (shift, shift); |
1316 | my ($self, $name) = (shift, shift); |
1217 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1317 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1218 | &urxvt::term::_resource |
1318 | goto &urxvt::term::_resource |
1219 | } |
1319 | } |
1220 | |
1320 | |
1221 | =item $value = $term->x_resource ($pattern) |
1321 | =item $value = $term->x_resource ($pattern) |
1222 | |
1322 | |
1223 | Returns the X-Resource for the given pattern, excluding the program or |
1323 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
1306 | |
1406 | |
1307 | The methods currently supported on C<urxvt::overlay> objects are: |
1407 | The methods currently supported on C<urxvt::overlay> objects are: |
1308 | |
1408 | |
1309 | =over 4 |
1409 | =over 4 |
1310 | |
1410 | |
1311 | =item $overlay->set ($x, $y, $text, $rend) |
1411 | =item $overlay->set ($x, $y, $text[, $rend]) |
1312 | |
1412 | |
1313 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1413 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1314 | text in rxvt-unicode's special encoding and an array of rendition values |
1414 | text in rxvt-unicode's special encoding and an array of rendition values |
1315 | at a specific position inside the overlay. |
1415 | at a specific position inside the overlay. |
|
|
1416 | |
|
|
1417 | If C<$rend> is missing, then the rendition will not be changed. |
1316 | |
1418 | |
1317 | =item $overlay->hide |
1419 | =item $overlay->hide |
1318 | |
1420 | |
1319 | If visible, hide the overlay, but do not destroy it. |
1421 | If visible, hide the overlay, but do not destroy it. |
1320 | |
1422 | |
… | |
… | |
1512 | |
1614 | |
1513 | Returns the currently displayed screen (0 primary, 1 secondary). |
1615 | Returns the currently displayed screen (0 primary, 1 secondary). |
1514 | |
1616 | |
1515 | =item $cursor_is_hidden = $term->hidden_cursor |
1617 | =item $cursor_is_hidden = $term->hidden_cursor |
1516 | |
1618 | |
1517 | Returns wether the cursor is currently hidden or not. |
1619 | Returns whether the cursor is currently hidden or not. |
1518 | |
1620 | |
1519 | =item $view_start = $term->view_start ([$newvalue]) |
1621 | =item $view_start = $term->view_start ([$newvalue]) |
1520 | |
1622 | |
1521 | Returns the row number of the topmost displayed line. Maximum value is |
1623 | Returns the row number of the topmost displayed line. Maximum value is |
1522 | C<0>, which displays the normal terminal contents. Lower values scroll |
1624 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1530 | |
1632 | |
1531 | Used after changing terminal contents to display them. |
1633 | Used after changing terminal contents to display them. |
1532 | |
1634 | |
1533 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1635 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1534 | |
1636 | |
1535 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1637 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1536 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1638 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1537 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1538 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1639 | terminal line. Nothing will be returned if a nonexistent line |
1539 | is requested. |
1640 | is requested. |
1540 | |
1641 | |
1541 | If C<$new_text> is specified, it will replace characters in the current |
1642 | If C<$new_text> is specified, it will replace characters in the current |
1542 | line, starting at column C<$start_col> (default C<0>), which is useful |
1643 | line, starting at column C<$start_col> (default C<0>), which is useful |
1543 | to replace only parts of a line. The font index in the rendition will |
1644 | to replace only parts of a line. The font index in the rendition will |
1544 | automatically be updated. |
1645 | automatically be updated. |
1545 | |
1646 | |
1546 | C<$text> is in a special encoding: tabs and wide characters that use more |
1647 | C<$text> is in a special encoding: tabs and wide characters that use more |
1547 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1648 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1548 | characters. Characters with combining characters and other characters that |
1649 | characters. Characters with combining characters and other characters that |
1549 | do not fit into the normal tetx encoding will be replaced with characters |
1650 | do not fit into the normal text encoding will be replaced with characters |
1550 | in the private use area. |
1651 | in the private use area. |
1551 | |
1652 | |
1552 | You have to obey this encoding when changing text. The advantage is |
1653 | You have to obey this encoding when changing text. The advantage is |
1553 | that C<substr> and similar functions work on screen cells and not on |
1654 | that C<substr> and similar functions work on screen cells and not on |
1554 | characters. |
1655 | characters. |
… | |
… | |
1699 | where one character corresponds to one screen cell. See |
1800 | where one character corresponds to one screen cell. See |
1700 | C<< $term->ROW_t >> for details. |
1801 | C<< $term->ROW_t >> for details. |
1701 | |
1802 | |
1702 | =item $string = $term->special_decode $text |
1803 | =item $string = $term->special_decode $text |
1703 | |
1804 | |
1704 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1805 | Converts rxvt-unicodes text representation into a perl string. See |
1705 | C<< $term->ROW_t >> for details. |
1806 | C<< $term->ROW_t >> for details. |
1706 | |
1807 | |
1707 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1808 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1708 | |
1809 | |
1709 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
1810 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1712 | manpage. |
1813 | manpage. |
1713 | |
1814 | |
1714 | =item $success = $term->grab ($eventtime[, $sync]) |
1815 | =item $success = $term->grab ($eventtime[, $sync]) |
1715 | |
1816 | |
1716 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1817 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1717 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1818 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1718 | |
1819 | |
1719 | =item $term->allow_events_async |
1820 | =item $term->allow_events_async |
1720 | |
1821 | |
1721 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1822 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1722 | |
1823 | |
… | |
… | |
1741 | |
1842 | |
1742 | =item @atoms = $term->XListProperties ($window) |
1843 | =item @atoms = $term->XListProperties ($window) |
1743 | |
1844 | |
1744 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1845 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1745 | |
1846 | |
1746 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
1847 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
1747 | |
1848 | |
1748 | =item $term->XDeleteProperty ($window, $property) |
1849 | =item $term->XDeleteProperty ($window, $property) |
1749 | |
1850 | |
1750 | =item $window = $term->DefaultRootWindow |
1851 | =item $window = $term->DefaultRootWindow |
1751 | |
1852 | |
… | |
… | |
1873 | my $env = $self->{term}->env; |
1974 | my $env = $self->{term}->env; |
1874 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1975 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1875 | delete $env->{LC_ALL}; |
1976 | delete $env->{LC_ALL}; |
1876 | $env->{LC_CTYPE} = $self->{term}->locale; |
1977 | $env->{LC_CTYPE} = $self->{term}->locale; |
1877 | |
1978 | |
1878 | urxvt::term->new ($env, "popup", |
1979 | my $term = urxvt::term->new ( |
|
|
1980 | $env, "popup", |
1879 | "--perl-lib" => "", "--perl-ext-common" => "", |
1981 | "--perl-lib" => "", "--perl-ext-common" => "", |
1880 | "-pty-fd" => -1, "-sl" => 0, |
1982 | "-pty-fd" => -1, "-sl" => 0, |
1881 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1983 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1882 | "--transient-for" => $self->{term}->parent, |
1984 | "--transient-for" => $self->{term}->parent, |
1883 | "-display" => $self->{term}->display_id, |
1985 | "-display" => $self->{term}->display_id, |
1884 | "-pe" => "urxvt-popup") |
1986 | "-pe" => "urxvt-popup", |
1885 | or die "unable to create popup window\n"; |
1987 | ) or die "unable to create popup window\n"; |
|
|
1988 | |
|
|
1989 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
1990 | $term->ungrab; |
|
|
1991 | $term->destroy; |
|
|
1992 | die "unable to initialise popup window\n"; |
|
|
1993 | } |
1886 | } |
1994 | } |
1887 | |
1995 | |
1888 | sub DESTROY { |
1996 | sub DESTROY { |
1889 | my ($self) = @_; |
1997 | my ($self) = @_; |
1890 | |
1998 | |
… | |
… | |
1895 | =back |
2003 | =back |
1896 | |
2004 | |
1897 | =cut |
2005 | =cut |
1898 | |
2006 | |
1899 | package urxvt::watcher; |
2007 | package urxvt::watcher; |
1900 | |
|
|
1901 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1902 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1903 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1904 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1905 | |
2008 | |
1906 | =head2 The C<urxvt::timer> Class |
2009 | =head2 The C<urxvt::timer> Class |
1907 | |
2010 | |
1908 | This class implements timer watchers/events. Time is represented as a |
2011 | This class implements timer watchers/events. Time is represented as a |
1909 | fractional number of seconds since the epoch. Example: |
2012 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1913 | ->new |
2016 | ->new |
1914 | ->interval (1) |
2017 | ->interval (1) |
1915 | ->cb (sub { |
2018 | ->cb (sub { |
1916 | $term->{overlay}->set (0, 0, |
2019 | $term->{overlay}->set (0, 0, |
1917 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2020 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1918 | }); |
2021 | }); |
1919 | |
2022 | |
1920 | =over 4 |
2023 | =over 4 |
1921 | |
2024 | |
1922 | =item $timer = new urxvt::timer |
2025 | =item $timer = new urxvt::timer |
1923 | |
2026 | |
… | |
… | |
1966 | |
2069 | |
1967 | $term->{socket} = ... |
2070 | $term->{socket} = ... |
1968 | $term->{iow} = urxvt::iow |
2071 | $term->{iow} = urxvt::iow |
1969 | ->new |
2072 | ->new |
1970 | ->fd (fileno $term->{socket}) |
2073 | ->fd (fileno $term->{socket}) |
1971 | ->events (urxvt::EVENT_READ) |
2074 | ->events (urxvt::EV_READ) |
1972 | ->start |
2075 | ->start |
1973 | ->cb (sub { |
2076 | ->cb (sub { |
1974 | my ($iow, $revents) = @_; |
2077 | my ($iow, $revents) = @_; |
1975 | # $revents must be 1 here, no need to check |
2078 | # $revents must be 1 here, no need to check |
1976 | sysread $term->{socket}, my $buf, 8192 |
2079 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1989 | Set the callback to be called when io events are triggered. C<$reventmask> |
2092 | Set the callback to be called when io events are triggered. C<$reventmask> |
1990 | is a bitset as described in the C<events> method. |
2093 | is a bitset as described in the C<events> method. |
1991 | |
2094 | |
1992 | =item $iow = $iow->fd ($fd) |
2095 | =item $iow = $iow->fd ($fd) |
1993 | |
2096 | |
1994 | Set the filedescriptor (not handle) to watch. |
2097 | Set the file descriptor (not handle) to watch. |
1995 | |
2098 | |
1996 | =item $iow = $iow->events ($eventmask) |
2099 | =item $iow = $iow->events ($eventmask) |
1997 | |
2100 | |
1998 | Set the event mask to watch. The only allowed values are |
2101 | Set the event mask to watch. The only allowed values are |
1999 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2102 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
2000 | together, or C<urxvt::EVENT_NONE>. |
2103 | together, or C<urxvt::EV_NONE>. |
2001 | |
2104 | |
2002 | =item $iow = $iow->start |
2105 | =item $iow = $iow->start |
2003 | |
2106 | |
2004 | Start watching for requested events on the given handle. |
2107 | Start watching for requested events on the given handle. |
2005 | |
2108 | |
2006 | =item $iow = $iow->stop |
2109 | =item $iow = $iow->stop |
2007 | |
2110 | |
2008 | Stop watching for events on the given filehandle. |
2111 | Stop watching for events on the given file handle. |
2009 | |
2112 | |
2010 | =back |
2113 | =back |
2011 | |
2114 | |
2012 | =head2 The C<urxvt::iw> Class |
2115 | =head2 The C<urxvt::iw> Class |
2013 | |
2116 | |
… | |
… | |
2046 | ->new |
2149 | ->new |
2047 | ->start ($pid) |
2150 | ->start ($pid) |
2048 | ->cb (sub { |
2151 | ->cb (sub { |
2049 | my ($pw, $exit_status) = @_; |
2152 | my ($pw, $exit_status) = @_; |
2050 | ... |
2153 | ... |
2051 | }); |
2154 | }); |
2052 | |
2155 | |
2053 | =over 4 |
2156 | =over 4 |
2054 | |
2157 | |
2055 | =item $pw = new urxvt::pw |
2158 | =item $pw = new urxvt::pw |
2056 | |
2159 | |
… | |
… | |
2060 | |
2163 | |
2061 | Set the callback to be called when the timer triggers. |
2164 | Set the callback to be called when the timer triggers. |
2062 | |
2165 | |
2063 | =item $pw = $timer->start ($pid) |
2166 | =item $pw = $timer->start ($pid) |
2064 | |
2167 | |
2065 | Tells the wqtcher to start watching for process C<$pid>. |
2168 | Tells the watcher to start watching for process C<$pid>. |
2066 | |
2169 | |
2067 | =item $pw = $pw->stop |
2170 | =item $pw = $pw->stop |
2068 | |
2171 | |
2069 | Stop the watcher. |
2172 | Stop the watcher. |
2070 | |
2173 | |
… | |
… | |
2083 | |
2186 | |
2084 | =item >= 3 - script loading and management |
2187 | =item >= 3 - script loading and management |
2085 | |
2188 | |
2086 | =item >=10 - all called hooks |
2189 | =item >=10 - all called hooks |
2087 | |
2190 | |
2088 | =item >=11 - hook reutrn values |
2191 | =item >=11 - hook return values |
2089 | |
2192 | |
2090 | =back |
2193 | =back |
2091 | |
2194 | |
2092 | =head1 AUTHOR |
2195 | =head1 AUTHOR |
2093 | |
2196 | |
… | |
… | |
2095 | http://software.schmorp.de/pkg/rxvt-unicode |
2198 | http://software.schmorp.de/pkg/rxvt-unicode |
2096 | |
2199 | |
2097 | =cut |
2200 | =cut |
2098 | |
2201 | |
2099 | 1 |
2202 | 1 |
|
|
2203 | |
|
|
2204 | # vim: sw=3: |