… | |
… | |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Everytime a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
|
|
30 | |
|
|
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
|
|
32 | and "perl-ext-common" resources to the empty string. |
30 | |
33 | |
31 | =head1 PREPACKAGED EXTENSIONS |
34 | =head1 PREPACKAGED EXTENSIONS |
32 | |
35 | |
33 | This section describes the extensions delivered with this release. You can |
36 | This section describes the extensions delivered with this release. You can |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
37 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
… | |
… | |
62 | URxvt.selection.pattern-1: perl-regex |
65 | URxvt.selection.pattern-1: perl-regex |
63 | ... |
66 | ... |
64 | |
67 | |
65 | The index number (0, 1...) must not have any holes, and each regex must |
68 | The index number (0, 1...) must not have any holes, and each regex must |
66 | contain at least one pair of capturing parentheses, which will be used for |
69 | contain at least one pair of capturing parentheses, which will be used for |
67 | the match. For example, the followign adds a regex that matches everything |
70 | the match. For example, the following adds a regex that matches everything |
68 | between two vertical bars: |
71 | between two vertical bars: |
69 | |
72 | |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
73 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
71 | |
74 | |
72 | Another example: Programs I use often output "absolute path: " at the |
75 | Another example: Programs I use often output "absolute path: " at the |
… | |
… | |
94 | =item option-popup (enabled by default) |
97 | =item option-popup (enabled by default) |
95 | |
98 | |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
99 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
97 | runtime. |
100 | runtime. |
98 | |
101 | |
|
|
102 | Other extensions can extend this popup menu by pushing a code reference |
|
|
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
104 | popup is being displayed. |
|
|
105 | |
|
|
106 | Its sole argument is the popup menu, which can be modified. It should |
|
|
107 | either return nothing or a string, the initial boolean value and a code |
|
|
108 | reference. The string will be used as button text and the code reference |
|
|
109 | will be called when the toggle changes, with the new boolean value as |
|
|
110 | first argument. |
|
|
111 | |
|
|
112 | The following will add an entry C<myoption> that changes |
|
|
113 | C<$self->{myoption}>: |
|
|
114 | |
|
|
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
117 | }; |
|
|
118 | |
99 | =item selection-popup (enabled by default) |
119 | =item selection-popup (enabled by default) |
100 | |
120 | |
101 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
121 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
102 | text into various other formats/action (such as uri unescaping, perl |
122 | text into various other formats/action (such as uri unescaping, perl |
103 | evaluation, web-browser starting etc.), depending on content. |
123 | evaluation, web-browser starting etc.), depending on content. |
104 | |
124 | |
105 | Other extensions can extend this popup menu by pushing a code reference |
125 | Other extensions can extend this popup menu by pushing a code reference |
106 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
107 | popup is displayed. |
127 | popup is being displayed. |
108 | |
128 | |
109 | It's sole argument is the popup menu, which can be modified. The selection |
129 | Its sole argument is the popup menu, which can be modified. The selection |
110 | is in C<$_>, which can be used to decide wether to add something or not. |
130 | is in C<$_>, which can be used to decide whether to add something or not. |
111 | It should either return nothing or a string and a code reference. The |
131 | It should either return nothing or a string and a code reference. The |
112 | string will be used as button text and the code reference will be called |
132 | string will be used as button text and the code reference will be called |
113 | when the button gets activated and should transform C<$_>. |
133 | when the button gets activated and should transform C<$_>. |
114 | |
134 | |
115 | The following will add an entry C<a to b> that transforms all C<a>s in |
135 | The following will add an entry C<a to b> that transforms all C<a>s in |
116 | 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 |
117 | C<a>s: |
137 | C<a>s: |
118 | |
138 | |
119 | push @{ $self->{term}{selection_popup_hook} }, sub { |
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
120 | /a/ ? ("a to be" => sub { s/a/b/g } |
140 | /a/ ? ("a to b" => sub { s/a/b/g } |
121 | : () |
141 | : () |
122 | }; |
142 | }; |
123 | |
143 | |
124 | =item searchable-scrollback<hotkey> (enabled by default) |
144 | =item searchable-scrollback<hotkey> (enabled by default) |
125 | |
145 | |
… | |
… | |
132 | 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> |
133 | 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 |
134 | bottom. C<Escape> leaves search mode and returns to the point where search |
154 | bottom. C<Escape> leaves search mode and returns to the point where search |
135 | was started, while C<Enter> or C<Return> stay at the current position and |
155 | was started, while C<Enter> or C<Return> stay at the current position and |
136 | additionally stores the first match in the current line into the primary |
156 | additionally stores the first match in the current line into the primary |
137 | selection. |
157 | selection 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. |
138 | |
164 | |
139 | =item readline (enabled by default) |
165 | =item readline (enabled by default) |
140 | |
166 | |
141 | A support package that tries to make editing with readline easier. At the |
167 | A support package that tries to make editing with readline easier. At |
142 | moment, it reacts to clicking with the left mouse button by trying to |
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
143 | move the text cursor to this position. It does so by generating as many |
169 | move the text cursor to this position. It does so by generating as many |
144 | cursor-left or cursor-right keypresses as required (the this only works |
170 | cursor-left or cursor-right keypresses as required (the this only works |
145 | for programs that correctly support wide characters). |
171 | for programs that correctly support wide characters). |
146 | |
172 | |
147 | To avoid too many false positives, this is only done when: |
173 | To avoid too many false positives, this is only done when: |
… | |
… | |
197 | the message into vi commands to load the file. |
223 | the message into vi commands to load the file. |
198 | |
224 | |
199 | =item tabbed |
225 | =item tabbed |
200 | |
226 | |
201 | This transforms the terminal into a tabbar with additional terminals, that |
227 | This transforms the terminal into a tabbar with additional terminals, that |
202 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
228 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
203 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
229 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
204 | button per tab. |
230 | button per tab. |
205 | |
231 | |
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
232 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
207 | B<Shift-Right> will switch to the tab left or right of the current one, |
233 | B<Shift-Right> will switch to the tab left or right of the current one, |
208 | while B<Shift-Down> creates a new tab. |
234 | while B<Shift-Down> creates a new tab. |
209 | |
235 | |
210 | =item mark-urls |
236 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
237 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
238 | following four resources (shown with defaults): |
211 | |
239 | |
|
|
240 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
241 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
242 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
243 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
244 | |
|
|
245 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
246 | indices. |
|
|
247 | |
|
|
248 | =item matcher |
|
|
249 | |
212 | 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 |
213 | make them clickable. When middle-clicked, the program specified in the |
251 | matching a certain pattern and make it clickable. When clicked with the |
214 | 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 |
215 | 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 |
|
|
276 | |
|
|
277 | =item xim-onthespot |
|
|
278 | |
|
|
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
280 | not work perfectly, and some input methods don't seem to work well with |
|
|
281 | OnTheSpot editing in general, but it seems to work at least for SCIM and |
|
|
282 | kinput2. |
|
|
283 | |
|
|
284 | You enable it by specifying this extension and a preedit style of |
|
|
285 | C<OnTheSpot>, i.e.: |
|
|
286 | |
|
|
287 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
288 | |
|
|
289 | =item kuake<hotkey> |
|
|
290 | |
|
|
291 | A very primitive quake-console-like extension. It was inspired by a |
|
|
292 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
293 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
294 | will show or hide itself. Another press of the accelerator key will hide |
|
|
295 | or show it again. |
|
|
296 | |
|
|
297 | Initially, the window will not be shown when using this extension. |
|
|
298 | |
|
|
299 | This is useful if you need a single terminal that is not using any desktop |
|
|
300 | space most of the time but is quickly available at the press of a key. |
|
|
301 | |
|
|
302 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
303 | extension will actually grab a physical key just for this function. |
|
|
304 | |
|
|
305 | If you want a quake-like animation, tell your window manager to do so |
|
|
306 | (fvwm can do it). |
216 | |
307 | |
217 | =item automove-background |
308 | =item automove-background |
218 | |
309 | |
219 | This is basically a one-line extension that dynamically changes the background pixmap offset |
310 | This is basically a very small extension that dynamically changes the |
220 | to the window position, in effect creating the same effect as pseudo transparency with |
311 | background pixmap offset to the window position, in effect creating the |
221 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
312 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
313 | supported in this mode. Example: |
222 | |
314 | |
223 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
315 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
224 | |
316 | |
|
|
317 | L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions> |
|
|
318 | shows how this extension can be used to implement an automatically blurred |
|
|
319 | transparent background. |
|
|
320 | |
225 | =item block-graphics-to-ascii |
321 | =item block-graphics-to-ascii |
226 | |
322 | |
227 | A not very useful example of filtering all text output to the terminal, |
323 | A not very useful example of filtering all text output to the terminal |
228 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
324 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
229 | similar-looking ascii character. |
325 | similar-looking ascii character. |
230 | |
326 | |
231 | =item digital-clock |
327 | =item digital-clock |
232 | |
328 | |
233 | Displays a digital clock using the built-in overlay. |
329 | Displays a digital clock using the built-in overlay. |
234 | |
330 | |
235 | =item example-refresh-hooks |
331 | =item remote-clipboard |
236 | |
332 | |
237 | Displays a very simple digital clock in the upper right corner of the |
333 | Somewhat of a misnomer, this extension adds two menu entries to the |
238 | window. Illustrates overwriting the refresh callbacks to create your own |
334 | selection popup that allows one to run external commands to store the |
239 | overlays or changes. |
335 | selection somewhere and fetch it again. |
|
|
336 | |
|
|
337 | We use it to implement a "distributed selection mechanism", which just |
|
|
338 | means that one command uploads the file to a remote server, and another |
|
|
339 | reads it. |
|
|
340 | |
|
|
341 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
342 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
343 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
344 | the selection data on STDOUT (also in UTF-8). |
|
|
345 | |
|
|
346 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
347 | |
|
|
348 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
349 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
240 | |
350 | |
241 | =item selection-pastebin |
351 | =item selection-pastebin |
242 | |
352 | |
243 | This is a little rarely useful extension that Uploads the selection as |
353 | This is a little rarely useful extension that Uploads the selection as |
244 | textfile to a remote site (or does other things). (The implementation is |
354 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
264 | After a successful upload the selection will be replaced by the text given |
374 | After a successful upload the selection will be replaced by the text given |
265 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
375 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
266 | for the filename): |
376 | for the filename): |
267 | |
377 | |
268 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
378 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
379 | |
|
|
380 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
381 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
382 | which works regardless of wether xrdb is used to parse the resource file |
|
|
383 | or not. |
|
|
384 | |
|
|
385 | =item example-refresh-hooks |
|
|
386 | |
|
|
387 | Displays a very simple digital clock in the upper right corner of the |
|
|
388 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
389 | overlays or changes. |
269 | |
390 | |
270 | =back |
391 | =back |
271 | |
392 | |
272 | =head1 API DOCUMENTATION |
393 | =head1 API DOCUMENTATION |
273 | |
394 | |
… | |
… | |
307 | |
428 | |
308 | =back |
429 | =back |
309 | |
430 | |
310 | =head2 Extension Objects |
431 | =head2 Extension Objects |
311 | |
432 | |
312 | Very perl extension is a perl class. A separate perl object is created |
433 | Every perl extension is a perl class. A separate perl object is created |
313 | for each terminal and each extension and passed as the first parameter to |
434 | for each terminal, and each terminal has its own set of extenion objects, |
314 | hooks. So extensions can use their C<$self> object without having to think |
435 | which are passed as the first parameter to hooks. So extensions can use |
315 | about other extensions, with the exception of methods and members that |
436 | their C<$self> object without having to think about clashes with other |
|
|
437 | extensions or other terminals, with the exception of methods and members |
316 | begin with an underscore character C<_>: these are reserved for internal |
438 | that begin with an underscore character C<_>: these are reserved for |
317 | use. |
439 | internal use. |
318 | |
440 | |
319 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
441 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
320 | C<urxvt::term> class on this object. |
442 | C<urxvt::term> class on this object. |
321 | |
443 | |
322 | It has the following methods and data members: |
444 | It has the following methods and data members: |
… | |
… | |
343 | =head2 Hooks |
465 | =head2 Hooks |
344 | |
466 | |
345 | The following subroutines can be declared in extension files, and will be |
467 | The following subroutines can be declared in extension files, and will be |
346 | called whenever the relevant event happens. |
468 | called whenever the relevant event happens. |
347 | |
469 | |
348 | The first argument passed to them is an extension oject as described in |
470 | The first argument passed to them is an extension object as described in |
349 | the in the C<Extension Objects> section. |
471 | the in the C<Extension Objects> section. |
350 | |
472 | |
351 | B<All> of these hooks must return a boolean value. If any of the called |
473 | B<All> of these hooks must return a boolean value. If any of the called |
352 | hooks returns true, then the event counts as being I<consumed>, and the |
474 | hooks returns true, then the event counts as being I<consumed>, and the |
353 | relevant action might not be carried out by the C++ code. |
475 | relevant action might not be carried out by the C++ code. |
… | |
… | |
366 | place. |
488 | place. |
367 | |
489 | |
368 | =item on_start $term |
490 | =item on_start $term |
369 | |
491 | |
370 | Called at the very end of initialisation of a new terminal, just before |
492 | Called at the very end of initialisation of a new terminal, just before |
371 | trying to map (display) the toplevel and returning to the mainloop. |
493 | trying to map (display) the toplevel and returning to the main loop. |
372 | |
494 | |
373 | =item on_destroy $term |
495 | =item on_destroy $term |
374 | |
496 | |
375 | Called whenever something tries to destroy terminal, when the terminal is |
497 | Called whenever something tries to destroy terminal, when the terminal is |
376 | still fully functional (not for long, though). |
498 | still fully functional (not for long, though). |
… | |
… | |
403 | |
525 | |
404 | Called whenever a selection has been copied, but before the selection is |
526 | Called whenever a selection has been copied, but before the selection is |
405 | requested from the server. The selection text can be queried and changed |
527 | requested from the server. The selection text can be queried and changed |
406 | by calling C<< $term->selection >>. |
528 | by calling C<< $term->selection >>. |
407 | |
529 | |
408 | Returning a true value aborts selection grabbing. It will still be hilighted. |
530 | Returning a true value aborts selection grabbing. It will still be highlighted. |
409 | |
531 | |
410 | =item on_sel_extend $term |
532 | =item on_sel_extend $term |
411 | |
533 | |
412 | Called whenever the user tries to extend the selection (e.g. with a double |
534 | Called whenever the user tries to extend the selection (e.g. with a double |
413 | click) and is either supposed to return false (normal operation), or |
535 | click) and is either supposed to return false (normal operation), or |
414 | should extend the selection itelf and return true to suppress the built-in |
536 | should extend the selection itself and return true to suppress the built-in |
415 | processing. This can happen multiple times, as long as the callback |
537 | processing. This can happen multiple times, as long as the callback |
416 | returns true, it will be called on every further click by the user and is |
538 | returns true, it will be called on every further click by the user and is |
417 | supposed to enlarge the selection more and more, if possible. |
539 | supposed to enlarge the selection more and more, if possible. |
418 | |
540 | |
419 | See the F<selection> example extension. |
541 | See the F<selection> example extension. |
420 | |
542 | |
421 | =item on_view_change $term, $offset |
543 | =item on_view_change $term, $offset |
422 | |
544 | |
423 | Called whenever the view offset changes, i..e the user or program |
545 | Called whenever the view offset changes, i.e. the user or program |
424 | scrolls. Offset C<0> means display the normal terminal, positive values |
546 | scrolls. Offset C<0> means display the normal terminal, positive values |
425 | show this many lines of scrollback. |
547 | show this many lines of scrollback. |
426 | |
548 | |
427 | =item on_scroll_back $term, $lines, $saved |
549 | =item on_scroll_back $term, $lines, $saved |
428 | |
550 | |
… | |
… | |
432 | |
554 | |
433 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
555 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
434 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
556 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
435 | number of lines that will be in the scrollback buffer. |
557 | number of lines that will be in the scrollback buffer. |
436 | |
558 | |
|
|
559 | =item on_osc_seq $term, $op, $args |
|
|
560 | |
|
|
561 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
562 | behaviour. The default should be to return an empty list. A true value |
|
|
563 | suppresses execution of the request completely. Make sure you don't get |
|
|
564 | confused by recursive invocations when you output an osc sequence within |
|
|
565 | this callback. |
|
|
566 | |
|
|
567 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
568 | |
437 | =item on_osc_seq $term, $string |
569 | =item on_osc_seq_perl $term, $string |
438 | |
570 | |
439 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
571 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
440 | operating system command) is processed. Cursor position and other state |
572 | operating system command) is processed. Cursor position and other state |
441 | information is up-to-date when this happens. For interoperability, the |
573 | information is up-to-date when this happens. For interoperability, the |
442 | string should start with the extension name and a colon, to distinguish |
574 | string should start with the extension name and a colon, to distinguish |
443 | it from commands for other extensions, and this might be enforced in the |
575 | it from commands for other extensions, and this might be enforced in the |
444 | future. |
576 | future. |
445 | |
577 | |
446 | Be careful not ever to trust (in a security sense) the data you receive, |
578 | Be careful not ever to trust (in a security sense) the data you receive, |
447 | as its source can not easily be controleld (e-mail content, messages from |
579 | as its source can not easily be controlled (e-mail content, messages from |
448 | other users on the same system etc.). |
580 | other users on the same system etc.). |
449 | |
581 | |
450 | =item on_add_lines $term, $string |
582 | =item on_add_lines $term, $string |
451 | |
583 | |
452 | Called whenever text is about to be output, with the text as argument. You |
584 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
483 | |
615 | |
484 | =item on_refresh_end $term |
616 | =item on_refresh_end $term |
485 | |
617 | |
486 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
618 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
487 | |
619 | |
488 | =item on_keyboard_command $term, $string |
620 | =item on_user_command $term, $string |
489 | |
621 | |
490 | Called whenever the user presses a key combination that has a |
622 | Called whenever a user-configured event is being activated (e.g. via |
491 | C<perl:string> action bound to it (see description of the B<keysym> |
623 | a C<perl:string> action bound to a key, see description of the B<keysym> |
492 | resource in the @@RXVT_NAME@@(1) manpage). |
624 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
625 | |
|
|
626 | The event is simply the action string. This interface is assumed to change |
|
|
627 | slightly in the future. |
|
|
628 | |
|
|
629 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
630 | |
|
|
631 | Called just after the new window size has been calculated, but before |
|
|
632 | windows are actually being resized or hints are being set. If this hook |
|
|
633 | returns TRUE, setting of the window hints is being skipped. |
493 | |
634 | |
494 | =item on_x_event $term, $event |
635 | =item on_x_event $term, $event |
495 | |
636 | |
496 | Called on every X event received on the vt window (and possibly other |
637 | Called on every X event received on the vt window (and possibly other |
497 | windows). Should only be used as a last resort. Most event structure |
638 | windows). Should only be used as a last resort. Most event structure |
498 | members are not passed. |
639 | members are not passed. |
499 | |
640 | |
|
|
641 | =item on_root_event $term, $event |
|
|
642 | |
|
|
643 | Like C<on_x_event>, but is called for events on the root window. |
|
|
644 | |
500 | =item on_focus_in $term |
645 | =item on_focus_in $term |
501 | |
646 | |
502 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
647 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
503 | does focus in processing. |
648 | does focus in processing. |
504 | |
649 | |
505 | =item on_focus_out $term |
650 | =item on_focus_out $term |
506 | |
651 | |
507 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
652 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
508 | focus out processing. |
653 | focus out processing. |
509 | |
654 | |
510 | =item on_configure_notify $term, $event |
655 | =item on_configure_notify $term, $event |
511 | |
656 | |
512 | =item on_property_notify $term, $event |
657 | =item on_property_notify $term, $event |
… | |
… | |
595 | The current terminal. This variable stores the current C<urxvt::term> |
740 | The current terminal. This variable stores the current C<urxvt::term> |
596 | object, whenever a callback/hook is executing. |
741 | object, whenever a callback/hook is executing. |
597 | |
742 | |
598 | =item @urxvt::TERM_INIT |
743 | =item @urxvt::TERM_INIT |
599 | |
744 | |
600 | All coderefs in this array will be called as methods of the next newly |
745 | All code references in this array will be called as methods of the next newly |
601 | created C<urxvt::term> object (during the C<on_init> phase). The array |
746 | created C<urxvt::term> object (during the C<on_init> phase). The array |
602 | gets cleared before the codereferences that were in it are being executed, |
747 | gets cleared before the code references that were in it are being executed, |
603 | so coderefs can push themselves onto it again if they so desire. |
748 | so references can push themselves onto it again if they so desire. |
604 | |
749 | |
605 | This complements to the perl-eval commandline option, but gets executed |
750 | This complements to the perl-eval command line option, but gets executed |
606 | first. |
751 | first. |
607 | |
752 | |
608 | =item @urxvt::TERM_EXT |
753 | =item @urxvt::TERM_EXT |
609 | |
754 | |
610 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
755 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
631 | |
776 | |
632 | Using this function has the advantage that its output ends up in the |
777 | Using this function has the advantage that its output ends up in the |
633 | correct place, e.g. on stderr of the connecting urxvtc client. |
778 | correct place, e.g. on stderr of the connecting urxvtc client. |
634 | |
779 | |
635 | Messages have a size limit of 1023 bytes currently. |
780 | Messages have a size limit of 1023 bytes currently. |
|
|
781 | |
|
|
782 | =item @terms = urxvt::termlist |
|
|
783 | |
|
|
784 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
785 | whether they are started, being destroyed etc., so be careful. Only term |
|
|
786 | objects that have perl extensions attached will be returned (because there |
|
|
787 | is no urxvt::term objet associated with others). |
636 | |
788 | |
637 | =item $time = urxvt::NOW |
789 | =item $time = urxvt::NOW |
638 | |
790 | |
639 | Returns the "current time" (as per the event loop). |
791 | Returns the "current time" (as per the event loop). |
640 | |
792 | |
… | |
… | |
698 | Return the foreground/background colour index, respectively. |
850 | Return the foreground/background colour index, respectively. |
699 | |
851 | |
700 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
852 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
701 | |
853 | |
702 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
854 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
855 | |
|
|
856 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
703 | |
857 | |
704 | Replace the foreground/background colour in the rendition mask with the |
858 | Replace the foreground/background colour in the rendition mask with the |
705 | specified one. |
859 | specified one. |
706 | |
860 | |
707 | =item $value = urxvt::GET_CUSTOM $rend |
861 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
774 | local $TERM = shift; |
928 | local $TERM = shift; |
775 | my $htype = shift; |
929 | my $htype = shift; |
776 | |
930 | |
777 | if ($htype == 0) { # INIT |
931 | if ($htype == 0) { # INIT |
778 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
932 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
779 | |
933 | |
780 | my %ext_arg; |
934 | my %ext_arg; |
781 | |
935 | |
782 | { |
936 | { |
783 | my @init = @TERM_INIT; |
937 | my @init = @TERM_INIT; |
784 | @TERM_INIT = (); |
938 | @TERM_INIT = (); |
… | |
… | |
798 | } else { |
952 | } else { |
799 | $ext_arg{$_} ||= []; |
953 | $ext_arg{$_} ||= []; |
800 | } |
954 | } |
801 | } |
955 | } |
802 | |
956 | |
803 | while (my ($ext, $argv) = each %ext_arg) { |
957 | for my $ext (sort keys %ext_arg) { |
804 | my @files = grep -f $_, map "$_/$ext", @dirs; |
958 | my @files = grep -f $_, map "$_/$ext", @dirs; |
805 | |
959 | |
806 | if (@files) { |
960 | if (@files) { |
807 | $TERM->register_package (extension_package $files[0], $argv); |
961 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
808 | } else { |
962 | } else { |
809 | warn "perl extension '$ext' not found in perl library search path\n"; |
963 | warn "perl extension '$ext' not found in perl library search path\n"; |
810 | } |
964 | } |
811 | } |
965 | } |
812 | |
966 | |
… | |
… | |
818 | |
972 | |
819 | if (my $cb = $TERM->{_hook}[$htype]) { |
973 | if (my $cb = $TERM->{_hook}[$htype]) { |
820 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
974 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
821 | if $verbosity >= 10; |
975 | if $verbosity >= 10; |
822 | |
976 | |
823 | keys %$cb; |
977 | for my $pkg (keys %$cb) { |
824 | |
|
|
825 | while (my ($pkg, $cb) = each %$cb) { |
|
|
826 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
978 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
827 | $retval ||= $retval_; |
979 | $retval ||= $retval_; |
828 | |
980 | |
829 | if ($@) { |
981 | if ($@) { |
830 | $TERM->ungrab; # better to lose the grab than the session |
982 | $TERM->ungrab; # better to lose the grab than the session |
831 | warn $@; |
983 | warn $@; |
… | |
… | |
843 | # clear package |
995 | # clear package |
844 | %$TERM = (); |
996 | %$TERM = (); |
845 | } |
997 | } |
846 | |
998 | |
847 | $retval |
999 | $retval |
|
|
1000 | } |
|
|
1001 | |
|
|
1002 | sub SET_COLOR($$$) { |
|
|
1003 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
1004 | } |
|
|
1005 | |
|
|
1006 | sub rend2mask { |
|
|
1007 | no strict 'refs'; |
|
|
1008 | my ($str, $mask) = (@_, 0); |
|
|
1009 | my %color = ( fg => undef, bg => undef ); |
|
|
1010 | my @failed; |
|
|
1011 | for my $spec ( split /\s+/, $str ) { |
|
|
1012 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1013 | $color{lc($1)} = $2; |
|
|
1014 | } else { |
|
|
1015 | my $neg = $spec =~ s/^[-^]//; |
|
|
1016 | unless ( exists &{"RS_$spec"} ) { |
|
|
1017 | push @failed, $spec; |
|
|
1018 | next; |
|
|
1019 | } |
|
|
1020 | my $cur = &{"RS_$spec"}; |
|
|
1021 | if ( $neg ) { |
|
|
1022 | $mask &= ~$cur; |
|
|
1023 | } else { |
|
|
1024 | $mask |= $cur; |
|
|
1025 | } |
|
|
1026 | } |
|
|
1027 | } |
|
|
1028 | ($mask, @color{qw(fg bg)}, \@failed) |
848 | } |
1029 | } |
849 | |
1030 | |
850 | # urxvt::term::extension |
1031 | # urxvt::term::extension |
851 | |
1032 | |
852 | package urxvt::term::extension; |
1033 | package urxvt::term::extension; |
… | |
… | |
965 | sub DESTROY { |
1146 | sub DESTROY { |
966 | $_[0][1]->stop; |
1147 | $_[0][1]->stop; |
967 | } |
1148 | } |
968 | |
1149 | |
969 | sub condvar { |
1150 | sub condvar { |
970 | bless \my $flag, urxvt::anyevent::condvar:: |
1151 | bless \my $flag, urxvt::anyevent:: |
971 | } |
1152 | } |
972 | |
1153 | |
973 | sub urxvt::anyevent::condvar::broadcast { |
1154 | sub broadcast { |
974 | ${$_[0]}++; |
1155 | ${$_[0]}++; |
975 | } |
1156 | } |
976 | |
1157 | |
977 | sub urxvt::anyevent::condvar::wait { |
1158 | sub wait { |
978 | unless (${$_[0]}) { |
1159 | unless (${$_[0]}) { |
979 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1160 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
980 | } |
1161 | } |
|
|
1162 | } |
|
|
1163 | |
|
|
1164 | sub one_event { |
|
|
1165 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
981 | } |
1166 | } |
982 | |
1167 | |
983 | package urxvt::term; |
1168 | package urxvt::term; |
984 | |
1169 | |
985 | =head2 The C<urxvt::term> Class |
1170 | =head2 The C<urxvt::term> Class |
… | |
… | |
1021 | hash which defines the environment of the new terminal. |
1206 | hash which defines the environment of the new terminal. |
1022 | |
1207 | |
1023 | Croaks (and probably outputs an error message) if the new instance |
1208 | Croaks (and probably outputs an error message) if the new instance |
1024 | couldn't be created. Returns C<undef> if the new instance didn't |
1209 | couldn't be created. Returns C<undef> if the new instance didn't |
1025 | initialise perl, and the terminal object otherwise. The C<init> and |
1210 | initialise perl, and the terminal object otherwise. The C<init> and |
1026 | C<start> hooks will be called during this call. |
1211 | C<start> hooks will be called before this call returns, and are free to |
|
|
1212 | refer to global data (which is race free). |
1027 | |
1213 | |
1028 | =cut |
1214 | =cut |
1029 | |
1215 | |
1030 | sub new { |
1216 | sub new { |
1031 | my ($class, $env, @args) = @_; |
1217 | my ($class, $env, @args) = @_; |
1032 | |
1218 | |
|
|
1219 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1220 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1221 | |
1033 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1222 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1034 | } |
1223 | } |
1035 | |
1224 | |
1036 | =item $term->destroy |
1225 | =item $term->destroy |
1037 | |
1226 | |
1038 | Destroy the terminal object (close the window, free resources |
1227 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1068 | |
1257 | |
1069 | Returns true if the option specified by C<$optval> is enabled, and |
1258 | Returns true if the option specified by C<$optval> is enabled, and |
1070 | optionally change it. All option values are stored by name in the hash |
1259 | optionally change it. All option values are stored by name in the hash |
1071 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1260 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1072 | |
1261 | |
1073 | Here is a a likely non-exhaustive list of option names, please see the |
1262 | Here is a likely non-exhaustive list of option names, please see the |
1074 | source file F</src/optinc.h> to see the actual list: |
1263 | source file F</src/optinc.h> to see the actual list: |
1075 | |
1264 | |
1076 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1265 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1077 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1266 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1078 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1267 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1095 | likely change). |
1284 | likely change). |
1096 | |
1285 | |
1097 | Please note that resource strings will currently only be freed when the |
1286 | Please note that resource strings will currently only be freed when the |
1098 | terminal is destroyed, so changing options frequently will eat memory. |
1287 | terminal is destroyed, so changing options frequently will eat memory. |
1099 | |
1288 | |
1100 | Here is a a likely non-exhaustive list of resource names, not all of which |
1289 | Here is a likely non-exhaustive list of resource names, not all of which |
1101 | are supported in every build, please see the source file F</src/rsinc.h> |
1290 | are supported in every build, please see the source file F</src/rsinc.h> |
1102 | to see the actual list: |
1291 | to see the actual list: |
1103 | |
1292 | |
1104 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1293 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1105 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1294 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1338 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1527 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1339 | to receive pointer events all the times: |
1528 | to receive pointer events all the times: |
1340 | |
1529 | |
1341 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1530 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1342 | |
1531 | |
|
|
1532 | =item $term->focus_in |
|
|
1533 | |
|
|
1534 | =item $term->focus_out |
|
|
1535 | |
|
|
1536 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1537 | |
|
|
1538 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1539 | |
|
|
1540 | Deliver various fake events to to terminal. |
|
|
1541 | |
1343 | =item $window_width = $term->width |
1542 | =item $window_width = $term->width |
1344 | |
1543 | |
1345 | =item $window_height = $term->height |
1544 | =item $window_height = $term->height |
1346 | |
1545 | |
1347 | =item $font_width = $term->fwidth |
1546 | =item $font_width = $term->fwidth |
… | |
… | |
1377 | =item $env = $term->env |
1576 | =item $env = $term->env |
1378 | |
1577 | |
1379 | Returns a copy of the environment in effect for the terminal as a hashref |
1578 | Returns a copy of the environment in effect for the terminal as a hashref |
1380 | similar to C<\%ENV>. |
1579 | similar to C<\%ENV>. |
1381 | |
1580 | |
|
|
1581 | =item @envv = $term->envv |
|
|
1582 | |
|
|
1583 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1584 | |
|
|
1585 | =item @argv = $term->argv |
|
|
1586 | |
|
|
1587 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1588 | includes the program name as first element. |
|
|
1589 | |
1382 | =cut |
1590 | =cut |
1383 | |
1591 | |
1384 | sub env { |
1592 | sub env { |
1385 | if (my $env = $_[0]->_env) { |
|
|
1386 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1593 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1387 | } else { |
|
|
1388 | +{ %ENV } |
|
|
1389 | } |
|
|
1390 | } |
1594 | } |
1391 | |
1595 | |
1392 | =item $modifiermask = $term->ModLevel3Mask |
1596 | =item $modifiermask = $term->ModLevel3Mask |
1393 | |
1597 | |
1394 | =item $modifiermask = $term->ModMetaMask |
1598 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1402 | |
1606 | |
1403 | Returns the currently displayed screen (0 primary, 1 secondary). |
1607 | Returns the currently displayed screen (0 primary, 1 secondary). |
1404 | |
1608 | |
1405 | =item $cursor_is_hidden = $term->hidden_cursor |
1609 | =item $cursor_is_hidden = $term->hidden_cursor |
1406 | |
1610 | |
1407 | Returns wether the cursor is currently hidden or not. |
1611 | Returns whether the cursor is currently hidden or not. |
1408 | |
1612 | |
1409 | =item $view_start = $term->view_start ([$newvalue]) |
1613 | =item $view_start = $term->view_start ([$newvalue]) |
1410 | |
1614 | |
1411 | Returns the row number of the topmost displayed line. Maximum value is |
1615 | Returns the row number of the topmost displayed line. Maximum value is |
1412 | C<0>, which displays the normal terminal contents. Lower values scroll |
1616 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1589 | where one character corresponds to one screen cell. See |
1793 | where one character corresponds to one screen cell. See |
1590 | C<< $term->ROW_t >> for details. |
1794 | C<< $term->ROW_t >> for details. |
1591 | |
1795 | |
1592 | =item $string = $term->special_decode $text |
1796 | =item $string = $term->special_decode $text |
1593 | |
1797 | |
1594 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1798 | Converts rxvt-unicodes text representation into a perl string. See |
1595 | C<< $term->ROW_t >> for details. |
1799 | C<< $term->ROW_t >> for details. |
1596 | |
1800 | |
1597 | =item $success = $term->grab_button ($button, $modifiermask) |
1801 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1598 | |
1802 | |
|
|
1803 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1804 | |
1599 | Registers a synchronous button grab. See the XGrabButton manpage. |
1805 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1806 | manpage. |
1600 | |
1807 | |
1601 | =item $success = $term->grab ($eventtime[, $sync]) |
1808 | =item $success = $term->grab ($eventtime[, $sync]) |
1602 | |
1809 | |
1603 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1810 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1604 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1811 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1605 | |
1812 | |
1606 | =item $term->allow_events_async |
1813 | =item $term->allow_events_async |
1607 | |
1814 | |
1608 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1815 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1609 | |
1816 | |
… | |
… | |
1722 | my ($self, $text, $cb) = @_; |
1929 | my ($self, $text, $cb) = @_; |
1723 | |
1930 | |
1724 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1931 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1725 | } |
1932 | } |
1726 | |
1933 | |
1727 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1934 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1728 | |
1935 | |
1729 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1936 | Adds a toggle/checkbox item to the popup. The callback gets called |
1730 | whenever it gets toggled, with a boolean indicating its value as its first |
1937 | whenever it gets toggled, with a boolean indicating its new value as its |
1731 | argument. |
1938 | first argument. |
1732 | |
1939 | |
1733 | =cut |
1940 | =cut |
1734 | |
1941 | |
1735 | sub add_toggle { |
1942 | sub add_toggle { |
1736 | my ($self, $text, $cb, $value) = @_; |
1943 | my ($self, $text, $value, $cb) = @_; |
1737 | |
1944 | |
1738 | my $item; $item = { |
1945 | my $item; $item = { |
1739 | type => "button", |
1946 | type => "button", |
1740 | text => " $text", |
1947 | text => " $text", |
1741 | value => $value, |
1948 | value => $value, |
… | |
… | |
1783 | |
1990 | |
1784 | =cut |
1991 | =cut |
1785 | |
1992 | |
1786 | package urxvt::watcher; |
1993 | package urxvt::watcher; |
1787 | |
1994 | |
1788 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1789 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1790 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1791 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1792 | |
|
|
1793 | =head2 The C<urxvt::timer> Class |
1995 | =head2 The C<urxvt::timer> Class |
1794 | |
1996 | |
1795 | This class implements timer watchers/events. Time is represented as a |
1997 | This class implements timer watchers/events. Time is represented as a |
1796 | fractional number of seconds since the epoch. Example: |
1998 | fractional number of seconds since the epoch. Example: |
1797 | |
1999 | |
… | |
… | |
1800 | ->new |
2002 | ->new |
1801 | ->interval (1) |
2003 | ->interval (1) |
1802 | ->cb (sub { |
2004 | ->cb (sub { |
1803 | $term->{overlay}->set (0, 0, |
2005 | $term->{overlay}->set (0, 0, |
1804 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2006 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1805 | }); |
2007 | }); |
1806 | |
2008 | |
1807 | =over 4 |
2009 | =over 4 |
1808 | |
2010 | |
1809 | =item $timer = new urxvt::timer |
2011 | =item $timer = new urxvt::timer |
1810 | |
2012 | |
… | |
… | |
1853 | |
2055 | |
1854 | $term->{socket} = ... |
2056 | $term->{socket} = ... |
1855 | $term->{iow} = urxvt::iow |
2057 | $term->{iow} = urxvt::iow |
1856 | ->new |
2058 | ->new |
1857 | ->fd (fileno $term->{socket}) |
2059 | ->fd (fileno $term->{socket}) |
1858 | ->events (urxvt::EVENT_READ) |
2060 | ->events (urxvt::EV_READ) |
1859 | ->start |
2061 | ->start |
1860 | ->cb (sub { |
2062 | ->cb (sub { |
1861 | my ($iow, $revents) = @_; |
2063 | my ($iow, $revents) = @_; |
1862 | # $revents must be 1 here, no need to check |
2064 | # $revents must be 1 here, no need to check |
1863 | sysread $term->{socket}, my $buf, 8192 |
2065 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1876 | Set the callback to be called when io events are triggered. C<$reventmask> |
2078 | Set the callback to be called when io events are triggered. C<$reventmask> |
1877 | is a bitset as described in the C<events> method. |
2079 | is a bitset as described in the C<events> method. |
1878 | |
2080 | |
1879 | =item $iow = $iow->fd ($fd) |
2081 | =item $iow = $iow->fd ($fd) |
1880 | |
2082 | |
1881 | Set the filedescriptor (not handle) to watch. |
2083 | Set the file descriptor (not handle) to watch. |
1882 | |
2084 | |
1883 | =item $iow = $iow->events ($eventmask) |
2085 | =item $iow = $iow->events ($eventmask) |
1884 | |
2086 | |
1885 | Set the event mask to watch. The only allowed values are |
2087 | Set the event mask to watch. The only allowed values are |
1886 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2088 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
1887 | together, or C<urxvt::EVENT_NONE>. |
2089 | together, or C<urxvt::EV_NONE>. |
1888 | |
2090 | |
1889 | =item $iow = $iow->start |
2091 | =item $iow = $iow->start |
1890 | |
2092 | |
1891 | Start watching for requested events on the given handle. |
2093 | Start watching for requested events on the given handle. |
1892 | |
2094 | |
1893 | =item $iow = $iow->stop |
2095 | =item $iow = $iow->stop |
1894 | |
2096 | |
1895 | Stop watching for events on the given filehandle. |
2097 | Stop watching for events on the given file handle. |
1896 | |
2098 | |
1897 | =back |
2099 | =back |
1898 | |
2100 | |
1899 | =head2 The C<urxvt::iw> Class |
2101 | =head2 The C<urxvt::iw> Class |
1900 | |
2102 | |
… | |
… | |
1933 | ->new |
2135 | ->new |
1934 | ->start ($pid) |
2136 | ->start ($pid) |
1935 | ->cb (sub { |
2137 | ->cb (sub { |
1936 | my ($pw, $exit_status) = @_; |
2138 | my ($pw, $exit_status) = @_; |
1937 | ... |
2139 | ... |
1938 | }); |
2140 | }); |
1939 | |
2141 | |
1940 | =over 4 |
2142 | =over 4 |
1941 | |
2143 | |
1942 | =item $pw = new urxvt::pw |
2144 | =item $pw = new urxvt::pw |
1943 | |
2145 | |
… | |
… | |
1947 | |
2149 | |
1948 | Set the callback to be called when the timer triggers. |
2150 | Set the callback to be called when the timer triggers. |
1949 | |
2151 | |
1950 | =item $pw = $timer->start ($pid) |
2152 | =item $pw = $timer->start ($pid) |
1951 | |
2153 | |
1952 | Tells the wqtcher to start watching for process C<$pid>. |
2154 | Tells the watcher to start watching for process C<$pid>. |
1953 | |
2155 | |
1954 | =item $pw = $pw->stop |
2156 | =item $pw = $pw->stop |
1955 | |
2157 | |
1956 | Stop the watcher. |
2158 | Stop the watcher. |
1957 | |
2159 | |
… | |
… | |
1970 | |
2172 | |
1971 | =item >= 3 - script loading and management |
2173 | =item >= 3 - script loading and management |
1972 | |
2174 | |
1973 | =item >=10 - all called hooks |
2175 | =item >=10 - all called hooks |
1974 | |
2176 | |
1975 | =item >=11 - hook reutrn values |
2177 | =item >=11 - hook return values |
1976 | |
2178 | |
1977 | =back |
2179 | =back |
1978 | |
2180 | |
1979 | =head1 AUTHOR |
2181 | =head1 AUTHOR |
1980 | |
2182 | |
… | |
… | |
1982 | http://software.schmorp.de/pkg/rxvt-unicode |
2184 | http://software.schmorp.de/pkg/rxvt-unicode |
1983 | |
2185 | |
1984 | =cut |
2186 | =cut |
1985 | |
2187 | |
1986 | 1 |
2188 | 1 |
|
|
2189 | |
|
|
2190 | # vim: sw=3: |