… | |
… | |
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 |
… | |
… | |
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 (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: |
148 | |
174 | |
149 | =over 4 |
175 | =over 4 |
… | |
… | |
197 | the message into vi commands to load the file. |
223 | the message into vi commands to load the file. |
198 | |
224 | |
199 | =item tabbed |
225 | =item tabbed |
200 | |
226 | |
201 | This transforms the terminal into a tabbar with additional terminals, that |
227 | This transforms the terminal into a tabbar with additional terminals, that |
202 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
228 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
203 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
229 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
204 | button per tab. |
230 | button per tab. |
205 | |
231 | |
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
232 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
207 | B<Shift-Right> will switch to the tab left or right of the current one, |
233 | B<Shift-Right> will switch to the tab left or right of the current one, |
… | |
… | |
217 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
243 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
218 | |
244 | |
219 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
245 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
220 | indices. |
246 | indices. |
221 | |
247 | |
222 | =item mark-urls |
248 | =item matcher |
223 | |
249 | |
224 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
250 | Uses per-line display filtering (C<on_line_update>) to underline text |
225 | make them clickable. When middle-clicked, the program specified in the |
251 | matching a certain pattern and make it clickable. When clicked with the |
226 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
252 | mouse button specified in the C<matcher.button> resource (default 2, or |
227 | the URL as first argument. |
253 | middle), the program specified in the C<matcher.launcher> resource |
|
|
254 | (default, the C<urlLauncher> resource, C<sensible-browser>) will be started |
|
|
255 | with the matched text as first argument. The default configuration is |
|
|
256 | suitable for matching URLs and launching a web browser, like the |
|
|
257 | former "mark-urls" extension. |
|
|
258 | |
|
|
259 | The default pattern to match URLs can be overridden with the |
|
|
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
|
|
261 | with numbered patterns, in a manner similar to the "selection" extension. |
|
|
262 | The launcher can also be overridden on a per-pattern basis. |
|
|
263 | |
|
|
264 | 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 |
228 | |
276 | |
229 | =item xim-onthespot |
277 | =item xim-onthespot |
230 | |
278 | |
231 | This (experimental) perl extension implements OnTheSpot editing. It does |
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
232 | 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 |
233 | 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 |
234 | kinput2. |
282 | kinput2. |
235 | |
283 | |
236 | 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 |
237 | C<OnTheSpot>, i.e.: |
285 | C<OnTheSpot>, i.e.: |
238 | |
286 | |
239 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
287 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
240 | |
288 | |
241 | =item automove-background |
289 | =item kuake<hotkey> |
242 | |
290 | |
243 | 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 |
244 | 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 |
245 | 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. |
246 | |
296 | |
247 | @@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). |
248 | |
307 | |
249 | =item block-graphics-to-ascii |
308 | =item block-graphics-to-ascii |
250 | |
309 | |
251 | A not very useful example of filtering all text output to the terminal, |
310 | A not very useful example of filtering all text output to the terminal |
252 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
311 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
253 | similar-looking ascii character. |
312 | similar-looking ascii character. |
254 | |
313 | |
255 | =item digital-clock |
314 | =item digital-clock |
256 | |
315 | |
257 | Displays a digital clock using the built-in overlay. |
316 | Displays a digital clock using the built-in overlay. |
258 | |
317 | |
259 | =item remote-clipboard |
318 | =item remote-clipboard |
260 | |
319 | |
261 | Somewhat of a misnomer, this extension adds two menu entries to the |
320 | Somewhat of a misnomer, this extension adds two menu entries to the |
262 | selection popup that allows one ti run external commands to store the |
321 | selection popup that allows one to run external commands to store the |
263 | selection somewhere and fetch it again. |
322 | selection somewhere and fetch it again. |
264 | |
323 | |
265 | We use it to implement a "distributed selection mechanism", which just |
324 | We use it to implement a "distributed selection mechanism", which just |
266 | means that one command uploads the file to a remote server, and another |
325 | means that one command uploads the file to a remote server, and another |
267 | reads it. |
326 | reads it. |
… | |
… | |
302 | After a successful upload the selection will be replaced by the text given |
361 | After a successful upload the selection will be replaced by the text given |
303 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
362 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
304 | for the filename): |
363 | for the filename): |
305 | |
364 | |
306 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
365 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
366 | |
|
|
367 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
368 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
369 | which works regardless of wether xrdb is used to parse the resource file |
|
|
370 | or not. |
307 | |
371 | |
308 | =item example-refresh-hooks |
372 | =item example-refresh-hooks |
309 | |
373 | |
310 | Displays a very simple digital clock in the upper right corner of the |
374 | Displays a very simple digital clock in the upper right corner of the |
311 | window. Illustrates overwriting the refresh callbacks to create your own |
375 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
351 | |
415 | |
352 | =back |
416 | =back |
353 | |
417 | |
354 | =head2 Extension Objects |
418 | =head2 Extension Objects |
355 | |
419 | |
356 | Very perl extension is a perl class. A separate perl object is created |
420 | Every perl extension is a perl class. A separate perl object is created |
357 | for each terminal and each extension and passed as the first parameter to |
421 | for each terminal, and each terminal has its own set of extenion objects, |
358 | hooks. So extensions can use their C<$self> object without having to think |
422 | which are passed as the first parameter to hooks. So extensions can use |
359 | about other extensions, with the exception of methods and members that |
423 | their C<$self> object without having to think about clashes with other |
|
|
424 | extensions or other terminals, with the exception of methods and members |
360 | begin with an underscore character C<_>: these are reserved for internal |
425 | that begin with an underscore character C<_>: these are reserved for |
361 | use. |
426 | internal use. |
362 | |
427 | |
363 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
428 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
364 | C<urxvt::term> class on this object. |
429 | C<urxvt::term> class on this object. |
365 | |
430 | |
366 | It has the following methods and data members: |
431 | It has the following methods and data members: |
… | |
… | |
387 | =head2 Hooks |
452 | =head2 Hooks |
388 | |
453 | |
389 | The following subroutines can be declared in extension files, and will be |
454 | The following subroutines can be declared in extension files, and will be |
390 | called whenever the relevant event happens. |
455 | called whenever the relevant event happens. |
391 | |
456 | |
392 | The first argument passed to them is an extension oject as described in |
457 | The first argument passed to them is an extension object as described in |
393 | the in the C<Extension Objects> section. |
458 | the in the C<Extension Objects> section. |
394 | |
459 | |
395 | B<All> of these hooks must return a boolean value. If any of the called |
460 | B<All> of these hooks must return a boolean value. If any of the called |
396 | hooks returns true, then the event counts as being I<consumed>, and the |
461 | hooks returns true, then the event counts as being I<consumed>, and the |
397 | relevant action might not be carried out by the C++ code. |
462 | relevant action might not be carried out by the C++ code. |
… | |
… | |
410 | place. |
475 | place. |
411 | |
476 | |
412 | =item on_start $term |
477 | =item on_start $term |
413 | |
478 | |
414 | Called at the very end of initialisation of a new terminal, just before |
479 | Called at the very end of initialisation of a new terminal, just before |
415 | trying to map (display) the toplevel and returning to the mainloop. |
480 | trying to map (display) the toplevel and returning to the main loop. |
416 | |
481 | |
417 | =item on_destroy $term |
482 | =item on_destroy $term |
418 | |
483 | |
419 | Called whenever something tries to destroy terminal, when the terminal is |
484 | Called whenever something tries to destroy terminal, when the terminal is |
420 | still fully functional (not for long, though). |
485 | still fully functional (not for long, though). |
… | |
… | |
447 | |
512 | |
448 | Called whenever a selection has been copied, but before the selection is |
513 | Called whenever a selection has been copied, but before the selection is |
449 | requested from the server. The selection text can be queried and changed |
514 | requested from the server. The selection text can be queried and changed |
450 | by calling C<< $term->selection >>. |
515 | by calling C<< $term->selection >>. |
451 | |
516 | |
452 | Returning a true value aborts selection grabbing. It will still be hilighted. |
517 | Returning a true value aborts selection grabbing. It will still be highlighted. |
453 | |
518 | |
454 | =item on_sel_extend $term |
519 | =item on_sel_extend $term |
455 | |
520 | |
456 | Called whenever the user tries to extend the selection (e.g. with a double |
521 | Called whenever the user tries to extend the selection (e.g. with a double |
457 | click) and is either supposed to return false (normal operation), or |
522 | click) and is either supposed to return false (normal operation), or |
458 | should extend the selection itelf and return true to suppress the built-in |
523 | should extend the selection itself and return true to suppress the built-in |
459 | processing. This can happen multiple times, as long as the callback |
524 | processing. This can happen multiple times, as long as the callback |
460 | returns true, it will be called on every further click by the user and is |
525 | returns true, it will be called on every further click by the user and is |
461 | supposed to enlarge the selection more and more, if possible. |
526 | supposed to enlarge the selection more and more, if possible. |
462 | |
527 | |
463 | See the F<selection> example extension. |
528 | See the F<selection> example extension. |
464 | |
529 | |
465 | =item on_view_change $term, $offset |
530 | =item on_view_change $term, $offset |
466 | |
531 | |
467 | Called whenever the view offset changes, i..e the user or program |
532 | Called whenever the view offset changes, i.e. the user or program |
468 | scrolls. Offset C<0> means display the normal terminal, positive values |
533 | scrolls. Offset C<0> means display the normal terminal, positive values |
469 | show this many lines of scrollback. |
534 | show this many lines of scrollback. |
470 | |
535 | |
471 | =item on_scroll_back $term, $lines, $saved |
536 | =item on_scroll_back $term, $lines, $saved |
472 | |
537 | |
… | |
… | |
476 | |
541 | |
477 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
542 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
478 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
543 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
479 | number of lines that will be in the scrollback buffer. |
544 | number of lines that will be in the scrollback buffer. |
480 | |
545 | |
|
|
546 | =item on_osc_seq $term, $op, $args |
|
|
547 | |
|
|
548 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
549 | behaviour. The default should be to return an empty list. A true value |
|
|
550 | suppresses execution of the request completely. Make sure you don't get |
|
|
551 | confused by recursive invocations when you output an osc sequence within |
|
|
552 | this callback. |
|
|
553 | |
|
|
554 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
555 | |
481 | =item on_osc_seq $term, $string |
556 | =item on_osc_seq_perl $term, $string |
482 | |
557 | |
483 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
558 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
484 | operating system command) is processed. Cursor position and other state |
559 | operating system command) is processed. Cursor position and other state |
485 | information is up-to-date when this happens. For interoperability, the |
560 | information is up-to-date when this happens. For interoperability, the |
486 | string should start with the extension name and a colon, to distinguish |
561 | string should start with the extension name and a colon, to distinguish |
487 | it from commands for other extensions, and this might be enforced in the |
562 | it from commands for other extensions, and this might be enforced in the |
488 | future. |
563 | future. |
489 | |
564 | |
490 | Be careful not ever to trust (in a security sense) the data you receive, |
565 | Be careful not ever to trust (in a security sense) the data you receive, |
491 | as its source can not easily be controleld (e-mail content, messages from |
566 | as its source can not easily be controlled (e-mail content, messages from |
492 | other users on the same system etc.). |
567 | other users on the same system etc.). |
493 | |
568 | |
494 | =item on_add_lines $term, $string |
569 | =item on_add_lines $term, $string |
495 | |
570 | |
496 | Called whenever text is about to be output, with the text as argument. You |
571 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
529 | |
604 | |
530 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
605 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
531 | |
606 | |
532 | =item on_user_command $term, $string |
607 | =item on_user_command $term, $string |
533 | |
608 | |
534 | Called whenever the a user-configured event is being activated (e.g. via |
609 | Called whenever a user-configured event is being activated (e.g. via |
535 | a C<perl:string> action bound to a key, see description of the B<keysym> |
610 | a C<perl:string> action bound to a key, see description of the B<keysym> |
536 | resource in the @@RXVT_NAME@@(1) manpage). |
611 | resource in the @@RXVT_NAME@@(1) manpage). |
537 | |
612 | |
538 | The event is simply the action string. This interface is assumed to change |
613 | The event is simply the action string. This interface is assumed to change |
539 | slightly in the future. |
614 | slightly in the future. |
|
|
615 | |
|
|
616 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
617 | |
|
|
618 | Called just after the new window size has been calculated, but before |
|
|
619 | windows are actually being resized or hints are being set. If this hook |
|
|
620 | returns TRUE, setting of the window hints is being skipped. |
540 | |
621 | |
541 | =item on_x_event $term, $event |
622 | =item on_x_event $term, $event |
542 | |
623 | |
543 | Called on every X event received on the vt window (and possibly other |
624 | Called on every X event received on the vt window (and possibly other |
544 | windows). Should only be used as a last resort. Most event structure |
625 | windows). Should only be used as a last resort. Most event structure |
545 | members are not passed. |
626 | members are not passed. |
546 | |
627 | |
|
|
628 | =item on_root_event $term, $event |
|
|
629 | |
|
|
630 | Like C<on_x_event>, but is called for events on the root window. |
|
|
631 | |
547 | =item on_focus_in $term |
632 | =item on_focus_in $term |
548 | |
633 | |
549 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
634 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
550 | does focus in processing. |
635 | does focus in processing. |
551 | |
636 | |
552 | =item on_focus_out $term |
637 | =item on_focus_out $term |
553 | |
638 | |
554 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
639 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
555 | focus out processing. |
640 | focus out processing. |
556 | |
641 | |
557 | =item on_configure_notify $term, $event |
642 | =item on_configure_notify $term, $event |
558 | |
643 | |
559 | =item on_property_notify $term, $event |
644 | =item on_property_notify $term, $event |
… | |
… | |
642 | The current terminal. This variable stores the current C<urxvt::term> |
727 | The current terminal. This variable stores the current C<urxvt::term> |
643 | object, whenever a callback/hook is executing. |
728 | object, whenever a callback/hook is executing. |
644 | |
729 | |
645 | =item @urxvt::TERM_INIT |
730 | =item @urxvt::TERM_INIT |
646 | |
731 | |
647 | All coderefs in this array will be called as methods of the next newly |
732 | All code references in this array will be called as methods of the next newly |
648 | created C<urxvt::term> object (during the C<on_init> phase). The array |
733 | created C<urxvt::term> object (during the C<on_init> phase). The array |
649 | gets cleared before the codereferences that were in it are being executed, |
734 | gets cleared before the code references that were in it are being executed, |
650 | so coderefs can push themselves onto it again if they so desire. |
735 | so references can push themselves onto it again if they so desire. |
651 | |
736 | |
652 | This complements to the perl-eval commandline option, but gets executed |
737 | This complements to the perl-eval command line option, but gets executed |
653 | first. |
738 | first. |
654 | |
739 | |
655 | =item @urxvt::TERM_EXT |
740 | =item @urxvt::TERM_EXT |
656 | |
741 | |
657 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
742 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
682 | Messages have a size limit of 1023 bytes currently. |
767 | Messages have a size limit of 1023 bytes currently. |
683 | |
768 | |
684 | =item @terms = urxvt::termlist |
769 | =item @terms = urxvt::termlist |
685 | |
770 | |
686 | Returns all urxvt::term objects that exist in this process, regardless of |
771 | Returns all urxvt::term objects that exist in this process, regardless of |
687 | wether they are started, being destroyed etc., so be careful. Only term |
772 | whether they are started, being destroyed etc., so be careful. Only term |
688 | objects that have perl extensions attached will be returned (because there |
773 | objects that have perl extensions attached will be returned (because there |
689 | is no urxvt::term objet associated with others). |
774 | is no urxvt::term objet associated with others). |
690 | |
775 | |
691 | =item $time = urxvt::NOW |
776 | =item $time = urxvt::NOW |
692 | |
777 | |
… | |
… | |
830 | local $TERM = shift; |
915 | local $TERM = shift; |
831 | my $htype = shift; |
916 | my $htype = shift; |
832 | |
917 | |
833 | if ($htype == 0) { # INIT |
918 | if ($htype == 0) { # INIT |
834 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
919 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
835 | |
920 | |
836 | my %ext_arg; |
921 | my %ext_arg; |
837 | |
922 | |
838 | { |
923 | { |
839 | my @init = @TERM_INIT; |
924 | my @init = @TERM_INIT; |
840 | @TERM_INIT = (); |
925 | @TERM_INIT = (); |
… | |
… | |
854 | } else { |
939 | } else { |
855 | $ext_arg{$_} ||= []; |
940 | $ext_arg{$_} ||= []; |
856 | } |
941 | } |
857 | } |
942 | } |
858 | |
943 | |
859 | while (my ($ext, $argv) = each %ext_arg) { |
944 | for my $ext (sort keys %ext_arg) { |
860 | my @files = grep -f $_, map "$_/$ext", @dirs; |
945 | my @files = grep -f $_, map "$_/$ext", @dirs; |
861 | |
946 | |
862 | if (@files) { |
947 | if (@files) { |
863 | $TERM->register_package (extension_package $files[0], $argv); |
948 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
864 | } else { |
949 | } else { |
865 | warn "perl extension '$ext' not found in perl library search path\n"; |
950 | warn "perl extension '$ext' not found in perl library search path\n"; |
866 | } |
951 | } |
867 | } |
952 | } |
868 | |
953 | |
… | |
… | |
874 | |
959 | |
875 | if (my $cb = $TERM->{_hook}[$htype]) { |
960 | if (my $cb = $TERM->{_hook}[$htype]) { |
876 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
961 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
877 | if $verbosity >= 10; |
962 | if $verbosity >= 10; |
878 | |
963 | |
879 | keys %$cb; |
964 | for my $pkg (keys %$cb) { |
880 | |
|
|
881 | while (my ($pkg, $cb) = each %$cb) { |
|
|
882 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
965 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
883 | $retval ||= $retval_; |
966 | $retval ||= $retval_; |
884 | |
967 | |
885 | if ($@) { |
968 | if ($@) { |
886 | $TERM->ungrab; # better to lose the grab than the session |
969 | $TERM->ungrab; # better to lose the grab than the session |
887 | warn $@; |
970 | warn $@; |
… | |
… | |
903 | $retval |
986 | $retval |
904 | } |
987 | } |
905 | |
988 | |
906 | sub SET_COLOR($$$) { |
989 | sub SET_COLOR($$$) { |
907 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
990 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
991 | } |
|
|
992 | |
|
|
993 | sub rend2mask { |
|
|
994 | no strict 'refs'; |
|
|
995 | my ($str, $mask) = (@_, 0); |
|
|
996 | my %color = ( fg => undef, bg => undef ); |
|
|
997 | my @failed; |
|
|
998 | for my $spec ( split /\s+/, $str ) { |
|
|
999 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1000 | $color{lc($1)} = $2; |
|
|
1001 | } else { |
|
|
1002 | my $neg = $spec =~ s/^[-^]//; |
|
|
1003 | unless ( exists &{"RS_$spec"} ) { |
|
|
1004 | push @failed, $spec; |
|
|
1005 | next; |
|
|
1006 | } |
|
|
1007 | my $cur = &{"RS_$spec"}; |
|
|
1008 | if ( $neg ) { |
|
|
1009 | $mask &= ~$cur; |
|
|
1010 | } else { |
|
|
1011 | $mask |= $cur; |
|
|
1012 | } |
|
|
1013 | } |
|
|
1014 | } |
|
|
1015 | ($mask, @color{qw(fg bg)}, \@failed) |
908 | } |
1016 | } |
909 | |
1017 | |
910 | # urxvt::term::extension |
1018 | # urxvt::term::extension |
911 | |
1019 | |
912 | package urxvt::term::extension; |
1020 | package urxvt::term::extension; |
… | |
… | |
983 | is that you cannot use blocking APIs, but the non-blocking variant should |
1091 | is that you cannot use blocking APIs, but the non-blocking variant should |
984 | work. |
1092 | work. |
985 | |
1093 | |
986 | =cut |
1094 | =cut |
987 | |
1095 | |
988 | our $VERSION = 1; |
1096 | our $VERSION = '3.4'; |
989 | |
1097 | |
990 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1098 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
991 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1099 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
992 | |
1100 | |
993 | sub timer { |
1101 | sub timer { |
… | |
… | |
1024 | |
1132 | |
1025 | sub DESTROY { |
1133 | sub DESTROY { |
1026 | $_[0][1]->stop; |
1134 | $_[0][1]->stop; |
1027 | } |
1135 | } |
1028 | |
1136 | |
1029 | sub condvar { |
1137 | sub one_event { |
1030 | bless \my $flag, urxvt::anyevent::condvar:: |
|
|
1031 | } |
|
|
1032 | |
|
|
1033 | sub urxvt::anyevent::condvar::broadcast { |
|
|
1034 | ${$_[0]}++; |
|
|
1035 | } |
|
|
1036 | |
|
|
1037 | sub urxvt::anyevent::condvar::wait { |
|
|
1038 | unless (${$_[0]}) { |
|
|
1039 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1138 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1040 | } |
|
|
1041 | } |
1139 | } |
1042 | |
1140 | |
1043 | package urxvt::term; |
1141 | package urxvt::term; |
1044 | |
1142 | |
1045 | =head2 The C<urxvt::term> Class |
1143 | =head2 The C<urxvt::term> Class |
… | |
… | |
1132 | |
1230 | |
1133 | Returns true if the option specified by C<$optval> is enabled, and |
1231 | Returns true if the option specified by C<$optval> is enabled, and |
1134 | optionally change it. All option values are stored by name in the hash |
1232 | optionally change it. All option values are stored by name in the hash |
1135 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1233 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1136 | |
1234 | |
1137 | Here is a a likely non-exhaustive list of option names, please see the |
1235 | Here is a likely non-exhaustive list of option names, please see the |
1138 | source file F</src/optinc.h> to see the actual list: |
1236 | source file F</src/optinc.h> to see the actual list: |
1139 | |
1237 | |
1140 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1238 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1141 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1239 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1142 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1240 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1159 | likely change). |
1257 | likely change). |
1160 | |
1258 | |
1161 | Please note that resource strings will currently only be freed when the |
1259 | Please note that resource strings will currently only be freed when the |
1162 | terminal is destroyed, so changing options frequently will eat memory. |
1260 | terminal is destroyed, so changing options frequently will eat memory. |
1163 | |
1261 | |
1164 | Here is a a likely non-exhaustive list of resource names, not all of which |
1262 | Here is a likely non-exhaustive list of resource names, not all of which |
1165 | are supported in every build, please see the source file F</src/rsinc.h> |
1263 | are supported in every build, please see the source file F</src/rsinc.h> |
1166 | to see the actual list: |
1264 | to see the actual list: |
1167 | |
1265 | |
1168 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1266 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1169 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1267 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1170 | display_name embed ext_bwidth fade font geometry hold iconName |
1268 | display_name embed ext_bwidth fade font geometry hold iconName |
1171 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1269 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1172 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1270 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1173 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1271 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1174 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1272 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1175 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1273 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1176 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1274 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1177 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1275 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1178 | secondaryScreen secondaryScroll selectstyle shade term_name title |
1276 | secondaryScreen secondaryScroll shade term_name title |
1179 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1277 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1180 | visualBell |
1278 | visualBell |
1181 | |
1279 | |
1182 | =cut |
1280 | =cut |
1183 | |
1281 | |
… | |
… | |
1451 | =item $env = $term->env |
1549 | =item $env = $term->env |
1452 | |
1550 | |
1453 | Returns a copy of the environment in effect for the terminal as a hashref |
1551 | Returns a copy of the environment in effect for the terminal as a hashref |
1454 | similar to C<\%ENV>. |
1552 | similar to C<\%ENV>. |
1455 | |
1553 | |
|
|
1554 | =item @envv = $term->envv |
|
|
1555 | |
|
|
1556 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1557 | |
|
|
1558 | =item @argv = $term->argv |
|
|
1559 | |
|
|
1560 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1561 | includes the program name as first element. |
|
|
1562 | |
1456 | =cut |
1563 | =cut |
1457 | |
1564 | |
1458 | sub env { |
1565 | sub env { |
1459 | if (my $env = $_[0]->_env) { |
|
|
1460 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1566 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1461 | } else { |
|
|
1462 | +{ %ENV } |
|
|
1463 | } |
|
|
1464 | } |
1567 | } |
1465 | |
1568 | |
1466 | =item $modifiermask = $term->ModLevel3Mask |
1569 | =item $modifiermask = $term->ModLevel3Mask |
1467 | |
1570 | |
1468 | =item $modifiermask = $term->ModMetaMask |
1571 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1476 | |
1579 | |
1477 | Returns the currently displayed screen (0 primary, 1 secondary). |
1580 | Returns the currently displayed screen (0 primary, 1 secondary). |
1478 | |
1581 | |
1479 | =item $cursor_is_hidden = $term->hidden_cursor |
1582 | =item $cursor_is_hidden = $term->hidden_cursor |
1480 | |
1583 | |
1481 | Returns wether the cursor is currently hidden or not. |
1584 | Returns whether the cursor is currently hidden or not. |
1482 | |
1585 | |
1483 | =item $view_start = $term->view_start ([$newvalue]) |
1586 | =item $view_start = $term->view_start ([$newvalue]) |
1484 | |
1587 | |
1485 | Returns the row number of the topmost displayed line. Maximum value is |
1588 | Returns the row number of the topmost displayed line. Maximum value is |
1486 | C<0>, which displays the normal terminal contents. Lower values scroll |
1589 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1494 | |
1597 | |
1495 | Used after changing terminal contents to display them. |
1598 | Used after changing terminal contents to display them. |
1496 | |
1599 | |
1497 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1600 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1498 | |
1601 | |
1499 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1602 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1500 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1603 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1501 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1502 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1604 | terminal line. Nothing will be returned if a nonexistent line |
1503 | is requested. |
1605 | is requested. |
1504 | |
1606 | |
1505 | If C<$new_text> is specified, it will replace characters in the current |
1607 | If C<$new_text> is specified, it will replace characters in the current |
1506 | line, starting at column C<$start_col> (default C<0>), which is useful |
1608 | line, starting at column C<$start_col> (default C<0>), which is useful |
1507 | to replace only parts of a line. The font index in the rendition will |
1609 | to replace only parts of a line. The font index in the rendition will |
1508 | automatically be updated. |
1610 | automatically be updated. |
1509 | |
1611 | |
1510 | C<$text> is in a special encoding: tabs and wide characters that use more |
1612 | C<$text> is in a special encoding: tabs and wide characters that use more |
1511 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1613 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1512 | characters. Characters with combining characters and other characters that |
1614 | characters. Characters with combining characters and other characters that |
1513 | do not fit into the normal tetx encoding will be replaced with characters |
1615 | do not fit into the normal text encoding will be replaced with characters |
1514 | in the private use area. |
1616 | in the private use area. |
1515 | |
1617 | |
1516 | You have to obey this encoding when changing text. The advantage is |
1618 | You have to obey this encoding when changing text. The advantage is |
1517 | that C<substr> and similar functions work on screen cells and not on |
1619 | that C<substr> and similar functions work on screen cells and not on |
1518 | characters. |
1620 | characters. |
… | |
… | |
1663 | where one character corresponds to one screen cell. See |
1765 | where one character corresponds to one screen cell. See |
1664 | C<< $term->ROW_t >> for details. |
1766 | C<< $term->ROW_t >> for details. |
1665 | |
1767 | |
1666 | =item $string = $term->special_decode $text |
1768 | =item $string = $term->special_decode $text |
1667 | |
1769 | |
1668 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1770 | Converts rxvt-unicodes text representation into a perl string. See |
1669 | C<< $term->ROW_t >> for details. |
1771 | C<< $term->ROW_t >> for details. |
1670 | |
1772 | |
1671 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1773 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1672 | |
1774 | |
1673 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
1775 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1676 | manpage. |
1778 | manpage. |
1677 | |
1779 | |
1678 | =item $success = $term->grab ($eventtime[, $sync]) |
1780 | =item $success = $term->grab ($eventtime[, $sync]) |
1679 | |
1781 | |
1680 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1782 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1681 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1783 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1682 | |
1784 | |
1683 | =item $term->allow_events_async |
1785 | =item $term->allow_events_async |
1684 | |
1786 | |
1685 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1787 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1686 | |
1788 | |
… | |
… | |
1799 | my ($self, $text, $cb) = @_; |
1901 | my ($self, $text, $cb) = @_; |
1800 | |
1902 | |
1801 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1903 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1802 | } |
1904 | } |
1803 | |
1905 | |
1804 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1906 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1805 | |
1907 | |
1806 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1908 | Adds a toggle/checkbox item to the popup. The callback gets called |
1807 | whenever it gets toggled, with a boolean indicating its value as its first |
1909 | whenever it gets toggled, with a boolean indicating its new value as its |
1808 | argument. |
1910 | first argument. |
1809 | |
1911 | |
1810 | =cut |
1912 | =cut |
1811 | |
1913 | |
1812 | sub add_toggle { |
1914 | sub add_toggle { |
1813 | my ($self, $text, $cb, $value) = @_; |
1915 | my ($self, $text, $value, $cb) = @_; |
1814 | |
1916 | |
1815 | my $item; $item = { |
1917 | my $item; $item = { |
1816 | type => "button", |
1918 | type => "button", |
1817 | text => " $text", |
1919 | text => " $text", |
1818 | value => $value, |
1920 | value => $value, |
… | |
… | |
1837 | my $env = $self->{term}->env; |
1939 | my $env = $self->{term}->env; |
1838 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1940 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1839 | delete $env->{LC_ALL}; |
1941 | delete $env->{LC_ALL}; |
1840 | $env->{LC_CTYPE} = $self->{term}->locale; |
1942 | $env->{LC_CTYPE} = $self->{term}->locale; |
1841 | |
1943 | |
1842 | urxvt::term->new ($env, "popup", |
1944 | my $term = urxvt::term->new ( |
|
|
1945 | $env, "popup", |
1843 | "--perl-lib" => "", "--perl-ext-common" => "", |
1946 | "--perl-lib" => "", "--perl-ext-common" => "", |
1844 | "-pty-fd" => -1, "-sl" => 0, |
1947 | "-pty-fd" => -1, "-sl" => 0, |
1845 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1948 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1846 | "--transient-for" => $self->{term}->parent, |
1949 | "--transient-for" => $self->{term}->parent, |
1847 | "-display" => $self->{term}->display_id, |
1950 | "-display" => $self->{term}->display_id, |
1848 | "-pe" => "urxvt-popup") |
1951 | "-pe" => "urxvt-popup", |
1849 | or die "unable to create popup window\n"; |
1952 | ) or die "unable to create popup window\n"; |
|
|
1953 | |
|
|
1954 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
1955 | $term->ungrab; |
|
|
1956 | $term->destroy; |
|
|
1957 | die "unable to initialise popup window\n"; |
|
|
1958 | } |
1850 | } |
1959 | } |
1851 | |
1960 | |
1852 | sub DESTROY { |
1961 | sub DESTROY { |
1853 | my ($self) = @_; |
1962 | my ($self) = @_; |
1854 | |
1963 | |
… | |
… | |
1859 | =back |
1968 | =back |
1860 | |
1969 | |
1861 | =cut |
1970 | =cut |
1862 | |
1971 | |
1863 | package urxvt::watcher; |
1972 | package urxvt::watcher; |
1864 | |
|
|
1865 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1866 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1867 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1868 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1869 | |
1973 | |
1870 | =head2 The C<urxvt::timer> Class |
1974 | =head2 The C<urxvt::timer> Class |
1871 | |
1975 | |
1872 | This class implements timer watchers/events. Time is represented as a |
1976 | This class implements timer watchers/events. Time is represented as a |
1873 | fractional number of seconds since the epoch. Example: |
1977 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1877 | ->new |
1981 | ->new |
1878 | ->interval (1) |
1982 | ->interval (1) |
1879 | ->cb (sub { |
1983 | ->cb (sub { |
1880 | $term->{overlay}->set (0, 0, |
1984 | $term->{overlay}->set (0, 0, |
1881 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1985 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1882 | }); |
1986 | }); |
1883 | |
1987 | |
1884 | =over 4 |
1988 | =over 4 |
1885 | |
1989 | |
1886 | =item $timer = new urxvt::timer |
1990 | =item $timer = new urxvt::timer |
1887 | |
1991 | |
… | |
… | |
1930 | |
2034 | |
1931 | $term->{socket} = ... |
2035 | $term->{socket} = ... |
1932 | $term->{iow} = urxvt::iow |
2036 | $term->{iow} = urxvt::iow |
1933 | ->new |
2037 | ->new |
1934 | ->fd (fileno $term->{socket}) |
2038 | ->fd (fileno $term->{socket}) |
1935 | ->events (urxvt::EVENT_READ) |
2039 | ->events (urxvt::EV_READ) |
1936 | ->start |
2040 | ->start |
1937 | ->cb (sub { |
2041 | ->cb (sub { |
1938 | my ($iow, $revents) = @_; |
2042 | my ($iow, $revents) = @_; |
1939 | # $revents must be 1 here, no need to check |
2043 | # $revents must be 1 here, no need to check |
1940 | sysread $term->{socket}, my $buf, 8192 |
2044 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1953 | Set the callback to be called when io events are triggered. C<$reventmask> |
2057 | Set the callback to be called when io events are triggered. C<$reventmask> |
1954 | is a bitset as described in the C<events> method. |
2058 | is a bitset as described in the C<events> method. |
1955 | |
2059 | |
1956 | =item $iow = $iow->fd ($fd) |
2060 | =item $iow = $iow->fd ($fd) |
1957 | |
2061 | |
1958 | Set the filedescriptor (not handle) to watch. |
2062 | Set the file descriptor (not handle) to watch. |
1959 | |
2063 | |
1960 | =item $iow = $iow->events ($eventmask) |
2064 | =item $iow = $iow->events ($eventmask) |
1961 | |
2065 | |
1962 | Set the event mask to watch. The only allowed values are |
2066 | Set the event mask to watch. The only allowed values are |
1963 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2067 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
1964 | together, or C<urxvt::EVENT_NONE>. |
2068 | together, or C<urxvt::EV_NONE>. |
1965 | |
2069 | |
1966 | =item $iow = $iow->start |
2070 | =item $iow = $iow->start |
1967 | |
2071 | |
1968 | Start watching for requested events on the given handle. |
2072 | Start watching for requested events on the given handle. |
1969 | |
2073 | |
1970 | =item $iow = $iow->stop |
2074 | =item $iow = $iow->stop |
1971 | |
2075 | |
1972 | Stop watching for events on the given filehandle. |
2076 | Stop watching for events on the given file handle. |
1973 | |
2077 | |
1974 | =back |
2078 | =back |
1975 | |
2079 | |
1976 | =head2 The C<urxvt::iw> Class |
2080 | =head2 The C<urxvt::iw> Class |
1977 | |
2081 | |
… | |
… | |
2010 | ->new |
2114 | ->new |
2011 | ->start ($pid) |
2115 | ->start ($pid) |
2012 | ->cb (sub { |
2116 | ->cb (sub { |
2013 | my ($pw, $exit_status) = @_; |
2117 | my ($pw, $exit_status) = @_; |
2014 | ... |
2118 | ... |
2015 | }); |
2119 | }); |
2016 | |
2120 | |
2017 | =over 4 |
2121 | =over 4 |
2018 | |
2122 | |
2019 | =item $pw = new urxvt::pw |
2123 | =item $pw = new urxvt::pw |
2020 | |
2124 | |
… | |
… | |
2024 | |
2128 | |
2025 | Set the callback to be called when the timer triggers. |
2129 | Set the callback to be called when the timer triggers. |
2026 | |
2130 | |
2027 | =item $pw = $timer->start ($pid) |
2131 | =item $pw = $timer->start ($pid) |
2028 | |
2132 | |
2029 | Tells the wqtcher to start watching for process C<$pid>. |
2133 | Tells the watcher to start watching for process C<$pid>. |
2030 | |
2134 | |
2031 | =item $pw = $pw->stop |
2135 | =item $pw = $pw->stop |
2032 | |
2136 | |
2033 | Stop the watcher. |
2137 | Stop the watcher. |
2034 | |
2138 | |
… | |
… | |
2047 | |
2151 | |
2048 | =item >= 3 - script loading and management |
2152 | =item >= 3 - script loading and management |
2049 | |
2153 | |
2050 | =item >=10 - all called hooks |
2154 | =item >=10 - all called hooks |
2051 | |
2155 | |
2052 | =item >=11 - hook reutrn values |
2156 | =item >=11 - hook return values |
2053 | |
2157 | |
2054 | =back |
2158 | =back |
2055 | |
2159 | |
2056 | =head1 AUTHOR |
2160 | =head1 AUTHOR |
2057 | |
2161 | |
… | |
… | |
2059 | http://software.schmorp.de/pkg/rxvt-unicode |
2163 | http://software.schmorp.de/pkg/rxvt-unicode |
2060 | |
2164 | |
2061 | =cut |
2165 | =cut |
2062 | |
2166 | |
2063 | 1 |
2167 | 1 |
|
|
2168 | |
|
|
2169 | # vim: sw=3: |