… | |
… | |
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, |
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 |
216 | |
276 | |
217 | =item xim-onthespot |
277 | =item xim-onthespot |
218 | |
278 | |
219 | This (experimental) perl extension implements OnTheSpot editing. It does |
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
220 | 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 |
221 | 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 |
222 | kinput2. |
282 | kinput2. |
223 | |
283 | |
224 | 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 |
225 | C<OnTheSpot>, i.e.: |
285 | C<OnTheSpot>, i.e.: |
226 | |
286 | |
227 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
287 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
228 | |
288 | |
229 | =item automove-background |
289 | =item kuake<hotkey> |
230 | |
290 | |
231 | 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 |
232 | 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 |
233 | 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. |
234 | |
296 | |
235 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
297 | Initially, the window will not be shown when using this extension. |
|
|
298 | |
|
|
299 | This is useful if you need a single terminal that is not using any desktop |
|
|
300 | space most of the time but is quickly available at the press of a key. |
|
|
301 | |
|
|
302 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
303 | extension will actually grab a physical key just for this function. |
|
|
304 | |
|
|
305 | If you want a quake-like animation, tell your window manager to do so |
|
|
306 | (fvwm can do it). |
|
|
307 | |
|
|
308 | =item overlay-osc |
|
|
309 | |
|
|
310 | This extension implements some OSC commands to display timed popups on the |
|
|
311 | screen - useful for status displays from within scripts. You have to read |
|
|
312 | the sources for more info. |
236 | |
313 | |
237 | =item block-graphics-to-ascii |
314 | =item block-graphics-to-ascii |
238 | |
315 | |
239 | A not very useful example of filtering all text output to the terminal, |
316 | A not very useful example of filtering all text output to the terminal |
240 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
317 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
241 | similar-looking ascii character. |
318 | similar-looking ascii character. |
242 | |
319 | |
243 | =item digital-clock |
320 | =item digital-clock |
244 | |
321 | |
245 | Displays a digital clock using the built-in overlay. |
322 | Displays a digital clock using the built-in overlay. |
246 | |
323 | |
247 | =item remote-selection |
324 | =item remote-clipboard |
248 | |
325 | |
249 | Somewhat of a misnomer, this extension adds two menu entries to the |
326 | Somewhat of a misnomer, this extension adds two menu entries to the |
250 | selection popup that allows one ti run external commands to store the |
327 | selection popup that allows one to run external commands to store the |
251 | selection somewhere and fetch it again. |
328 | selection somewhere and fetch it again. |
252 | |
329 | |
253 | We use it to implement a "distributed selection mechanism", which just |
330 | We use it to implement a "distributed selection mechanism", which just |
254 | means that one command uploads the file to a remote server, and another |
331 | means that one command uploads the file to a remote server, and another |
255 | reads it. |
332 | reads it. |
… | |
… | |
290 | After a successful upload the selection will be replaced by the text given |
367 | After a successful upload the selection will be replaced by the text given |
291 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
368 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
292 | for the filename): |
369 | for the filename): |
293 | |
370 | |
294 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
371 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
372 | |
|
|
373 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
374 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
375 | which works regardless of wether xrdb is used to parse the resource file |
|
|
376 | or not. |
295 | |
377 | |
296 | =item example-refresh-hooks |
378 | =item example-refresh-hooks |
297 | |
379 | |
298 | Displays a very simple digital clock in the upper right corner of the |
380 | Displays a very simple digital clock in the upper right corner of the |
299 | window. Illustrates overwriting the refresh callbacks to create your own |
381 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
339 | |
421 | |
340 | =back |
422 | =back |
341 | |
423 | |
342 | =head2 Extension Objects |
424 | =head2 Extension Objects |
343 | |
425 | |
344 | Very perl extension is a perl class. A separate perl object is created |
426 | Every perl extension is a perl class. A separate perl object is created |
345 | for each terminal and each extension and passed as the first parameter to |
427 | for each terminal, and each terminal has its own set of extenion objects, |
346 | hooks. So extensions can use their C<$self> object without having to think |
428 | which are passed as the first parameter to hooks. So extensions can use |
347 | about other extensions, with the exception of methods and members that |
429 | their C<$self> object without having to think about clashes with other |
|
|
430 | extensions or other terminals, with the exception of methods and members |
348 | begin with an underscore character C<_>: these are reserved for internal |
431 | that begin with an underscore character C<_>: these are reserved for |
349 | use. |
432 | internal use. |
350 | |
433 | |
351 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
434 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
352 | C<urxvt::term> class on this object. |
435 | C<urxvt::term> class on this object. |
353 | |
436 | |
354 | It has the following methods and data members: |
437 | It has the following methods and data members: |
… | |
… | |
375 | =head2 Hooks |
458 | =head2 Hooks |
376 | |
459 | |
377 | The following subroutines can be declared in extension files, and will be |
460 | The following subroutines can be declared in extension files, and will be |
378 | called whenever the relevant event happens. |
461 | called whenever the relevant event happens. |
379 | |
462 | |
380 | The first argument passed to them is an extension oject as described in |
463 | The first argument passed to them is an extension object as described in |
381 | the in the C<Extension Objects> section. |
464 | the in the C<Extension Objects> section. |
382 | |
465 | |
383 | B<All> of these hooks must return a boolean value. If any of the called |
466 | B<All> of these hooks must return a boolean value. If any of the called |
384 | hooks returns true, then the event counts as being I<consumed>, and the |
467 | hooks returns true, then the event counts as being I<consumed>, and the |
385 | relevant action might not be carried out by the C++ code. |
468 | relevant action might not be carried out by the C++ code. |
… | |
… | |
398 | place. |
481 | place. |
399 | |
482 | |
400 | =item on_start $term |
483 | =item on_start $term |
401 | |
484 | |
402 | Called at the very end of initialisation of a new terminal, just before |
485 | Called at the very end of initialisation of a new terminal, just before |
403 | trying to map (display) the toplevel and returning to the mainloop. |
486 | trying to map (display) the toplevel and returning to the main loop. |
404 | |
487 | |
405 | =item on_destroy $term |
488 | =item on_destroy $term |
406 | |
489 | |
407 | Called whenever something tries to destroy terminal, when the terminal is |
490 | Called whenever something tries to destroy terminal, when the terminal is |
408 | still fully functional (not for long, though). |
491 | still fully functional (not for long, though). |
… | |
… | |
435 | |
518 | |
436 | Called whenever a selection has been copied, but before the selection is |
519 | Called whenever a selection has been copied, but before the selection is |
437 | requested from the server. The selection text can be queried and changed |
520 | requested from the server. The selection text can be queried and changed |
438 | by calling C<< $term->selection >>. |
521 | by calling C<< $term->selection >>. |
439 | |
522 | |
440 | Returning a true value aborts selection grabbing. It will still be hilighted. |
523 | Returning a true value aborts selection grabbing. It will still be highlighted. |
441 | |
524 | |
442 | =item on_sel_extend $term |
525 | =item on_sel_extend $term |
443 | |
526 | |
444 | Called whenever the user tries to extend the selection (e.g. with a double |
527 | Called whenever the user tries to extend the selection (e.g. with a double |
445 | click) and is either supposed to return false (normal operation), or |
528 | click) and is either supposed to return false (normal operation), or |
446 | should extend the selection itelf and return true to suppress the built-in |
529 | should extend the selection itself and return true to suppress the built-in |
447 | processing. This can happen multiple times, as long as the callback |
530 | processing. This can happen multiple times, as long as the callback |
448 | returns true, it will be called on every further click by the user and is |
531 | returns true, it will be called on every further click by the user and is |
449 | supposed to enlarge the selection more and more, if possible. |
532 | supposed to enlarge the selection more and more, if possible. |
450 | |
533 | |
451 | See the F<selection> example extension. |
534 | See the F<selection> example extension. |
452 | |
535 | |
453 | =item on_view_change $term, $offset |
536 | =item on_view_change $term, $offset |
454 | |
537 | |
455 | Called whenever the view offset changes, i..e the user or program |
538 | Called whenever the view offset changes, i.e. the user or program |
456 | scrolls. Offset C<0> means display the normal terminal, positive values |
539 | scrolls. Offset C<0> means display the normal terminal, positive values |
457 | show this many lines of scrollback. |
540 | show this many lines of scrollback. |
458 | |
541 | |
459 | =item on_scroll_back $term, $lines, $saved |
542 | =item on_scroll_back $term, $lines, $saved |
460 | |
543 | |
… | |
… | |
464 | |
547 | |
465 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
548 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
466 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
549 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
467 | number of lines that will be in the scrollback buffer. |
550 | number of lines that will be in the scrollback buffer. |
468 | |
551 | |
469 | =item on_osc_seq $term, $string |
552 | =item on_osc_seq $term, $op, $args, $resp |
|
|
553 | |
|
|
554 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
555 | behaviour. The default should be to return an empty list. A true value |
|
|
556 | suppresses execution of the request completely. Make sure you don't get |
|
|
557 | confused by recursive invocations when you output an OSC sequence within |
|
|
558 | this callback. |
|
|
559 | |
|
|
560 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
561 | |
|
|
562 | =item on_osc_seq_perl $term, $args, $resp |
470 | |
563 | |
471 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
564 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
472 | operating system command) is processed. Cursor position and other state |
565 | operating system command) is processed. Cursor position and other state |
473 | information is up-to-date when this happens. For interoperability, the |
566 | information is up-to-date when this happens. For interoperability, the |
474 | string should start with the extension name and a colon, to distinguish |
567 | string should start with the extension name (sans -osc) and a semicolon, |
475 | it from commands for other extensions, and this might be enforced in the |
568 | to distinguish it from commands for other extensions, and this might be |
476 | future. |
569 | enforced in the future. |
|
|
570 | |
|
|
571 | For example, C<overlay-osc> uses this: |
|
|
572 | |
|
|
573 | sub on_osc_seq_perl { |
|
|
574 | my ($self, $osc, $resp) = @_; |
|
|
575 | |
|
|
576 | return unless $osc =~ s/^overlay;//; |
|
|
577 | |
|
|
578 | ... process remaining $osc string |
|
|
579 | } |
477 | |
580 | |
478 | Be careful not ever to trust (in a security sense) the data you receive, |
581 | Be careful not ever to trust (in a security sense) the data you receive, |
479 | as its source can not easily be controleld (e-mail content, messages from |
582 | as its source can not easily be controlled (e-mail content, messages from |
480 | other users on the same system etc.). |
583 | other users on the same system etc.). |
|
|
584 | |
|
|
585 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
586 | sender. |
481 | |
587 | |
482 | =item on_add_lines $term, $string |
588 | =item on_add_lines $term, $string |
483 | |
589 | |
484 | Called whenever text is about to be output, with the text as argument. You |
590 | Called whenever text is about to be output, with the text as argument. You |
485 | can filter/change and output the text yourself by returning a true value |
591 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
506 | later with the already-modified line (e.g. if unrelated parts change), so |
612 | later with the already-modified line (e.g. if unrelated parts change), so |
507 | you cannot just toggle rendition bits, but only set them. |
613 | you cannot just toggle rendition bits, but only set them. |
508 | |
614 | |
509 | =item on_refresh_begin $term |
615 | =item on_refresh_begin $term |
510 | |
616 | |
511 | Called just before the screen gets redrawn. Can be used for overlay |
617 | Called just before the screen gets redrawn. Can be used for overlay or |
512 | or similar effects by modify terminal contents in refresh_begin, and |
618 | similar effects by modifying the terminal contents in refresh_begin, and |
513 | restoring them in refresh_end. The built-in overlay and selection display |
619 | restoring them in refresh_end. The built-in overlay and selection display |
514 | code is run after this hook, and takes precedence. |
620 | code is run after this hook, and takes precedence. |
515 | |
621 | |
516 | =item on_refresh_end $term |
622 | =item on_refresh_end $term |
517 | |
623 | |
518 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
624 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
519 | |
625 | |
520 | =item on_keyboard_command $term, $string |
626 | =item on_user_command $term, $string |
521 | |
627 | |
522 | Called whenever the user presses a key combination that has a |
628 | Called whenever a user-configured event is being activated (e.g. via |
523 | C<perl:string> action bound to it (see description of the B<keysym> |
629 | a C<perl:string> action bound to a key, see description of the B<keysym> |
524 | resource in the @@RXVT_NAME@@(1) manpage). |
630 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
631 | |
|
|
632 | The event is simply the action string. This interface is assumed to change |
|
|
633 | slightly in the future. |
|
|
634 | |
|
|
635 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
636 | |
|
|
637 | Called just after the new window size has been calculated, but before |
|
|
638 | windows are actually being resized or hints are being set. If this hook |
|
|
639 | returns TRUE, setting of the window hints is being skipped. |
525 | |
640 | |
526 | =item on_x_event $term, $event |
641 | =item on_x_event $term, $event |
527 | |
642 | |
528 | Called on every X event received on the vt window (and possibly other |
643 | Called on every X event received on the vt window (and possibly other |
529 | windows). Should only be used as a last resort. Most event structure |
644 | windows). Should only be used as a last resort. Most event structure |
530 | members are not passed. |
645 | members are not passed. |
531 | |
646 | |
|
|
647 | =item on_root_event $term, $event |
|
|
648 | |
|
|
649 | Like C<on_x_event>, but is called for events on the root window. |
|
|
650 | |
532 | =item on_focus_in $term |
651 | =item on_focus_in $term |
533 | |
652 | |
534 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
653 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
535 | does focus in processing. |
654 | does focus in processing. |
536 | |
655 | |
537 | =item on_focus_out $term |
656 | =item on_focus_out $term |
538 | |
657 | |
539 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
658 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
540 | focus out processing. |
659 | focus out processing. |
541 | |
660 | |
542 | =item on_configure_notify $term, $event |
661 | =item on_configure_notify $term, $event |
543 | |
662 | |
544 | =item on_property_notify $term, $event |
663 | =item on_property_notify $term, $event |
… | |
… | |
627 | The current terminal. This variable stores the current C<urxvt::term> |
746 | The current terminal. This variable stores the current C<urxvt::term> |
628 | object, whenever a callback/hook is executing. |
747 | object, whenever a callback/hook is executing. |
629 | |
748 | |
630 | =item @urxvt::TERM_INIT |
749 | =item @urxvt::TERM_INIT |
631 | |
750 | |
632 | All coderefs in this array will be called as methods of the next newly |
751 | All code references in this array will be called as methods of the next newly |
633 | created C<urxvt::term> object (during the C<on_init> phase). The array |
752 | created C<urxvt::term> object (during the C<on_init> phase). The array |
634 | gets cleared before the codereferences that were in it are being executed, |
753 | gets cleared before the code references that were in it are being executed, |
635 | so coderefs can push themselves onto it again if they so desire. |
754 | so references can push themselves onto it again if they so desire. |
636 | |
755 | |
637 | This complements to the perl-eval commandline option, but gets executed |
756 | This complements to the perl-eval command line option, but gets executed |
638 | first. |
757 | first. |
639 | |
758 | |
640 | =item @urxvt::TERM_EXT |
759 | =item @urxvt::TERM_EXT |
641 | |
760 | |
642 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
761 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
663 | |
782 | |
664 | Using this function has the advantage that its output ends up in the |
783 | Using this function has the advantage that its output ends up in the |
665 | correct place, e.g. on stderr of the connecting urxvtc client. |
784 | correct place, e.g. on stderr of the connecting urxvtc client. |
666 | |
785 | |
667 | Messages have a size limit of 1023 bytes currently. |
786 | Messages have a size limit of 1023 bytes currently. |
|
|
787 | |
|
|
788 | =item @terms = urxvt::termlist |
|
|
789 | |
|
|
790 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
791 | whether they are started, being destroyed etc., so be careful. Only term |
|
|
792 | objects that have perl extensions attached will be returned (because there |
|
|
793 | is no urxvt::term objet associated with others). |
668 | |
794 | |
669 | =item $time = urxvt::NOW |
795 | =item $time = urxvt::NOW |
670 | |
796 | |
671 | Returns the "current time" (as per the event loop). |
797 | Returns the "current time" (as per the event loop). |
672 | |
798 | |
… | |
… | |
730 | Return the foreground/background colour index, respectively. |
856 | Return the foreground/background colour index, respectively. |
731 | |
857 | |
732 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
858 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
733 | |
859 | |
734 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
860 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
861 | |
|
|
862 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
735 | |
863 | |
736 | Replace the foreground/background colour in the rendition mask with the |
864 | Replace the foreground/background colour in the rendition mask with the |
737 | specified one. |
865 | specified one. |
738 | |
866 | |
739 | =item $value = urxvt::GET_CUSTOM $rend |
867 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
806 | local $TERM = shift; |
934 | local $TERM = shift; |
807 | my $htype = shift; |
935 | my $htype = shift; |
808 | |
936 | |
809 | if ($htype == 0) { # INIT |
937 | if ($htype == 0) { # INIT |
810 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
938 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
811 | |
939 | |
812 | my %ext_arg; |
940 | my %ext_arg; |
813 | |
941 | |
814 | { |
942 | { |
815 | my @init = @TERM_INIT; |
943 | my @init = @TERM_INIT; |
816 | @TERM_INIT = (); |
944 | @TERM_INIT = (); |
… | |
… | |
830 | } else { |
958 | } else { |
831 | $ext_arg{$_} ||= []; |
959 | $ext_arg{$_} ||= []; |
832 | } |
960 | } |
833 | } |
961 | } |
834 | |
962 | |
835 | while (my ($ext, $argv) = each %ext_arg) { |
963 | for my $ext (sort keys %ext_arg) { |
836 | my @files = grep -f $_, map "$_/$ext", @dirs; |
964 | my @files = grep -f $_, map "$_/$ext", @dirs; |
837 | |
965 | |
838 | if (@files) { |
966 | if (@files) { |
839 | $TERM->register_package (extension_package $files[0], $argv); |
967 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
840 | } else { |
968 | } else { |
841 | warn "perl extension '$ext' not found in perl library search path\n"; |
969 | warn "perl extension '$ext' not found in perl library search path\n"; |
842 | } |
970 | } |
843 | } |
971 | } |
844 | |
972 | |
… | |
… | |
850 | |
978 | |
851 | if (my $cb = $TERM->{_hook}[$htype]) { |
979 | if (my $cb = $TERM->{_hook}[$htype]) { |
852 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
980 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
853 | if $verbosity >= 10; |
981 | if $verbosity >= 10; |
854 | |
982 | |
855 | keys %$cb; |
983 | for my $pkg (keys %$cb) { |
856 | |
|
|
857 | while (my ($pkg, $cb) = each %$cb) { |
|
|
858 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
984 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
859 | $retval ||= $retval_; |
985 | $retval ||= $retval_; |
860 | |
986 | |
861 | if ($@) { |
987 | if ($@) { |
862 | $TERM->ungrab; # better to lose the grab than the session |
988 | $TERM->ungrab; # better to lose the grab than the session |
863 | warn $@; |
989 | warn $@; |
… | |
… | |
875 | # clear package |
1001 | # clear package |
876 | %$TERM = (); |
1002 | %$TERM = (); |
877 | } |
1003 | } |
878 | |
1004 | |
879 | $retval |
1005 | $retval |
|
|
1006 | } |
|
|
1007 | |
|
|
1008 | sub SET_COLOR($$$) { |
|
|
1009 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
1010 | } |
|
|
1011 | |
|
|
1012 | sub rend2mask { |
|
|
1013 | no strict 'refs'; |
|
|
1014 | my ($str, $mask) = (@_, 0); |
|
|
1015 | my %color = ( fg => undef, bg => undef ); |
|
|
1016 | my @failed; |
|
|
1017 | for my $spec ( split /\s+/, $str ) { |
|
|
1018 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1019 | $color{lc($1)} = $2; |
|
|
1020 | } else { |
|
|
1021 | my $neg = $spec =~ s/^[-^]//; |
|
|
1022 | unless ( exists &{"RS_$spec"} ) { |
|
|
1023 | push @failed, $spec; |
|
|
1024 | next; |
|
|
1025 | } |
|
|
1026 | my $cur = &{"RS_$spec"}; |
|
|
1027 | if ( $neg ) { |
|
|
1028 | $mask &= ~$cur; |
|
|
1029 | } else { |
|
|
1030 | $mask |= $cur; |
|
|
1031 | } |
|
|
1032 | } |
|
|
1033 | } |
|
|
1034 | ($mask, @color{qw(fg bg)}, \@failed) |
880 | } |
1035 | } |
881 | |
1036 | |
882 | # urxvt::term::extension |
1037 | # urxvt::term::extension |
883 | |
1038 | |
884 | package urxvt::term::extension; |
1039 | package urxvt::term::extension; |
… | |
… | |
955 | is that you cannot use blocking APIs, but the non-blocking variant should |
1110 | is that you cannot use blocking APIs, but the non-blocking variant should |
956 | work. |
1111 | work. |
957 | |
1112 | |
958 | =cut |
1113 | =cut |
959 | |
1114 | |
960 | our $VERSION = 1; |
1115 | our $VERSION = '3.4'; |
961 | |
1116 | |
962 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1117 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
963 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1118 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
964 | |
1119 | |
965 | sub timer { |
1120 | sub timer { |
… | |
… | |
996 | |
1151 | |
997 | sub DESTROY { |
1152 | sub DESTROY { |
998 | $_[0][1]->stop; |
1153 | $_[0][1]->stop; |
999 | } |
1154 | } |
1000 | |
1155 | |
1001 | sub condvar { |
1156 | sub one_event { |
1002 | bless \my $flag, urxvt::anyevent::condvar:: |
|
|
1003 | } |
|
|
1004 | |
|
|
1005 | sub urxvt::anyevent::condvar::broadcast { |
|
|
1006 | ${$_[0]}++; |
|
|
1007 | } |
|
|
1008 | |
|
|
1009 | sub urxvt::anyevent::condvar::wait { |
|
|
1010 | unless (${$_[0]}) { |
|
|
1011 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1157 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1012 | } |
|
|
1013 | } |
1158 | } |
1014 | |
1159 | |
1015 | package urxvt::term; |
1160 | package urxvt::term; |
1016 | |
1161 | |
1017 | =head2 The C<urxvt::term> Class |
1162 | =head2 The C<urxvt::term> Class |
… | |
… | |
1053 | hash which defines the environment of the new terminal. |
1198 | hash which defines the environment of the new terminal. |
1054 | |
1199 | |
1055 | Croaks (and probably outputs an error message) if the new instance |
1200 | Croaks (and probably outputs an error message) if the new instance |
1056 | couldn't be created. Returns C<undef> if the new instance didn't |
1201 | couldn't be created. Returns C<undef> if the new instance didn't |
1057 | initialise perl, and the terminal object otherwise. The C<init> and |
1202 | initialise perl, and the terminal object otherwise. The C<init> and |
1058 | C<start> hooks will be called during this call. |
1203 | C<start> hooks will be called before this call returns, and are free to |
|
|
1204 | refer to global data (which is race free). |
1059 | |
1205 | |
1060 | =cut |
1206 | =cut |
1061 | |
1207 | |
1062 | sub new { |
1208 | sub new { |
1063 | my ($class, $env, @args) = @_; |
1209 | my ($class, $env, @args) = @_; |
1064 | |
1210 | |
|
|
1211 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1212 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1213 | |
1065 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1214 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1066 | } |
1215 | } |
1067 | |
1216 | |
1068 | =item $term->destroy |
1217 | =item $term->destroy |
1069 | |
1218 | |
1070 | Destroy the terminal object (close the window, free resources |
1219 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1100 | |
1249 | |
1101 | Returns true if the option specified by C<$optval> is enabled, and |
1250 | Returns true if the option specified by C<$optval> is enabled, and |
1102 | optionally change it. All option values are stored by name in the hash |
1251 | optionally change it. All option values are stored by name in the hash |
1103 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1252 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1104 | |
1253 | |
1105 | Here is a a likely non-exhaustive list of option names, please see the |
1254 | Here is a likely non-exhaustive list of option names, please see the |
1106 | source file F</src/optinc.h> to see the actual list: |
1255 | source file F</src/optinc.h> to see the actual list: |
1107 | |
1256 | |
1108 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1257 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1109 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1258 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1110 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1259 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1127 | likely change). |
1276 | likely change). |
1128 | |
1277 | |
1129 | Please note that resource strings will currently only be freed when the |
1278 | Please note that resource strings will currently only be freed when the |
1130 | terminal is destroyed, so changing options frequently will eat memory. |
1279 | terminal is destroyed, so changing options frequently will eat memory. |
1131 | |
1280 | |
1132 | Here is a a likely non-exhaustive list of resource names, not all of which |
1281 | Here is a likely non-exhaustive list of resource names, not all of which |
1133 | are supported in every build, please see the source file F</src/rsinc.h> |
1282 | are supported in every build, please see the source file F</src/rsinc.h> |
1134 | to see the actual list: |
1283 | to see the actual list: |
1135 | |
1284 | |
1136 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1285 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1137 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1286 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1138 | display_name embed ext_bwidth fade font geometry hold iconName |
1287 | display_name embed ext_bwidth fade font geometry hold iconName |
1139 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1288 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1140 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1289 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1141 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1290 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1142 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1291 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1143 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1292 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1144 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1293 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1145 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1294 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1146 | secondaryScreen secondaryScroll selectstyle shade term_name title |
1295 | secondaryScreen secondaryScroll shade term_name title |
1147 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1296 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1148 | visualBell |
1297 | visualBell |
1149 | |
1298 | |
1150 | =cut |
1299 | =cut |
1151 | |
1300 | |
1152 | sub resource($$;$) { |
1301 | sub resource($$;$) { |
1153 | my ($self, $name) = (shift, shift); |
1302 | my ($self, $name) = (shift, shift); |
1154 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1303 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1155 | &urxvt::term::_resource |
1304 | goto &urxvt::term::_resource |
1156 | } |
1305 | } |
1157 | |
1306 | |
1158 | =item $value = $term->x_resource ($pattern) |
1307 | =item $value = $term->x_resource ($pattern) |
1159 | |
1308 | |
1160 | Returns the X-Resource for the given pattern, excluding the program or |
1309 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
1243 | |
1392 | |
1244 | The methods currently supported on C<urxvt::overlay> objects are: |
1393 | The methods currently supported on C<urxvt::overlay> objects are: |
1245 | |
1394 | |
1246 | =over 4 |
1395 | =over 4 |
1247 | |
1396 | |
1248 | =item $overlay->set ($x, $y, $text, $rend) |
1397 | =item $overlay->set ($x, $y, $text[, $rend]) |
1249 | |
1398 | |
1250 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1399 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1251 | text in rxvt-unicode's special encoding and an array of rendition values |
1400 | text in rxvt-unicode's special encoding and an array of rendition values |
1252 | at a specific position inside the overlay. |
1401 | at a specific position inside the overlay. |
|
|
1402 | |
|
|
1403 | If C<$rend> is missing, then the rendition will not be changed. |
1253 | |
1404 | |
1254 | =item $overlay->hide |
1405 | =item $overlay->hide |
1255 | |
1406 | |
1256 | If visible, hide the overlay, but do not destroy it. |
1407 | If visible, hide the overlay, but do not destroy it. |
1257 | |
1408 | |
… | |
… | |
1370 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1521 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1371 | to receive pointer events all the times: |
1522 | to receive pointer events all the times: |
1372 | |
1523 | |
1373 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1524 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1374 | |
1525 | |
|
|
1526 | =item $term->focus_in |
|
|
1527 | |
|
|
1528 | =item $term->focus_out |
|
|
1529 | |
|
|
1530 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1531 | |
|
|
1532 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1533 | |
|
|
1534 | Deliver various fake events to to terminal. |
|
|
1535 | |
1375 | =item $window_width = $term->width |
1536 | =item $window_width = $term->width |
1376 | |
1537 | |
1377 | =item $window_height = $term->height |
1538 | =item $window_height = $term->height |
1378 | |
1539 | |
1379 | =item $font_width = $term->fwidth |
1540 | =item $font_width = $term->fwidth |
… | |
… | |
1409 | =item $env = $term->env |
1570 | =item $env = $term->env |
1410 | |
1571 | |
1411 | Returns a copy of the environment in effect for the terminal as a hashref |
1572 | Returns a copy of the environment in effect for the terminal as a hashref |
1412 | similar to C<\%ENV>. |
1573 | similar to C<\%ENV>. |
1413 | |
1574 | |
|
|
1575 | =item @envv = $term->envv |
|
|
1576 | |
|
|
1577 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1578 | |
|
|
1579 | =item @argv = $term->argv |
|
|
1580 | |
|
|
1581 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1582 | includes the program name as first element. |
|
|
1583 | |
1414 | =cut |
1584 | =cut |
1415 | |
1585 | |
1416 | sub env { |
1586 | sub env { |
1417 | if (my $env = $_[0]->_env) { |
|
|
1418 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1587 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1419 | } else { |
|
|
1420 | +{ %ENV } |
|
|
1421 | } |
|
|
1422 | } |
1588 | } |
1423 | |
1589 | |
1424 | =item $modifiermask = $term->ModLevel3Mask |
1590 | =item $modifiermask = $term->ModLevel3Mask |
1425 | |
1591 | |
1426 | =item $modifiermask = $term->ModMetaMask |
1592 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1434 | |
1600 | |
1435 | Returns the currently displayed screen (0 primary, 1 secondary). |
1601 | Returns the currently displayed screen (0 primary, 1 secondary). |
1436 | |
1602 | |
1437 | =item $cursor_is_hidden = $term->hidden_cursor |
1603 | =item $cursor_is_hidden = $term->hidden_cursor |
1438 | |
1604 | |
1439 | Returns wether the cursor is currently hidden or not. |
1605 | Returns whether the cursor is currently hidden or not. |
1440 | |
1606 | |
1441 | =item $view_start = $term->view_start ([$newvalue]) |
1607 | =item $view_start = $term->view_start ([$newvalue]) |
1442 | |
1608 | |
1443 | Returns the row number of the topmost displayed line. Maximum value is |
1609 | Returns the row number of the topmost displayed line. Maximum value is |
1444 | C<0>, which displays the normal terminal contents. Lower values scroll |
1610 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1452 | |
1618 | |
1453 | Used after changing terminal contents to display them. |
1619 | Used after changing terminal contents to display them. |
1454 | |
1620 | |
1455 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1621 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1456 | |
1622 | |
1457 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1623 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1458 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1624 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1459 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1460 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1625 | terminal line. Nothing will be returned if a nonexistent line |
1461 | is requested. |
1626 | is requested. |
1462 | |
1627 | |
1463 | If C<$new_text> is specified, it will replace characters in the current |
1628 | If C<$new_text> is specified, it will replace characters in the current |
1464 | line, starting at column C<$start_col> (default C<0>), which is useful |
1629 | line, starting at column C<$start_col> (default C<0>), which is useful |
1465 | to replace only parts of a line. The font index in the rendition will |
1630 | to replace only parts of a line. The font index in the rendition will |
1466 | automatically be updated. |
1631 | automatically be updated. |
1467 | |
1632 | |
1468 | C<$text> is in a special encoding: tabs and wide characters that use more |
1633 | C<$text> is in a special encoding: tabs and wide characters that use more |
1469 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1634 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1470 | characters. Characters with combining characters and other characters that |
1635 | characters. Characters with combining characters and other characters that |
1471 | do not fit into the normal tetx encoding will be replaced with characters |
1636 | do not fit into the normal text encoding will be replaced with characters |
1472 | in the private use area. |
1637 | in the private use area. |
1473 | |
1638 | |
1474 | You have to obey this encoding when changing text. The advantage is |
1639 | You have to obey this encoding when changing text. The advantage is |
1475 | that C<substr> and similar functions work on screen cells and not on |
1640 | that C<substr> and similar functions work on screen cells and not on |
1476 | characters. |
1641 | characters. |
… | |
… | |
1621 | where one character corresponds to one screen cell. See |
1786 | where one character corresponds to one screen cell. See |
1622 | C<< $term->ROW_t >> for details. |
1787 | C<< $term->ROW_t >> for details. |
1623 | |
1788 | |
1624 | =item $string = $term->special_decode $text |
1789 | =item $string = $term->special_decode $text |
1625 | |
1790 | |
1626 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1791 | Converts rxvt-unicodes text representation into a perl string. See |
1627 | C<< $term->ROW_t >> for details. |
1792 | C<< $term->ROW_t >> for details. |
1628 | |
1793 | |
1629 | =item $success = $term->grab_button ($button, $modifiermask) |
1794 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1630 | |
1795 | |
|
|
1796 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1797 | |
1631 | Registers a synchronous button grab. See the XGrabButton manpage. |
1798 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1799 | manpage. |
1632 | |
1800 | |
1633 | =item $success = $term->grab ($eventtime[, $sync]) |
1801 | =item $success = $term->grab ($eventtime[, $sync]) |
1634 | |
1802 | |
1635 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1803 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1636 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1804 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1637 | |
1805 | |
1638 | =item $term->allow_events_async |
1806 | =item $term->allow_events_async |
1639 | |
1807 | |
1640 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1808 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1641 | |
1809 | |
… | |
… | |
1660 | |
1828 | |
1661 | =item @atoms = $term->XListProperties ($window) |
1829 | =item @atoms = $term->XListProperties ($window) |
1662 | |
1830 | |
1663 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1831 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1664 | |
1832 | |
1665 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
1833 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
1666 | |
1834 | |
1667 | =item $term->XDeleteProperty ($window, $property) |
1835 | =item $term->XDeleteProperty ($window, $property) |
1668 | |
1836 | |
1669 | =item $window = $term->DefaultRootWindow |
1837 | =item $window = $term->DefaultRootWindow |
1670 | |
1838 | |
… | |
… | |
1754 | my ($self, $text, $cb) = @_; |
1922 | my ($self, $text, $cb) = @_; |
1755 | |
1923 | |
1756 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1924 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1757 | } |
1925 | } |
1758 | |
1926 | |
1759 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1927 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1760 | |
1928 | |
1761 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1929 | Adds a toggle/checkbox item to the popup. The callback gets called |
1762 | whenever it gets toggled, with a boolean indicating its value as its first |
1930 | whenever it gets toggled, with a boolean indicating its new value as its |
1763 | argument. |
1931 | first argument. |
1764 | |
1932 | |
1765 | =cut |
1933 | =cut |
1766 | |
1934 | |
1767 | sub add_toggle { |
1935 | sub add_toggle { |
1768 | my ($self, $text, $cb, $value) = @_; |
1936 | my ($self, $text, $value, $cb) = @_; |
1769 | |
1937 | |
1770 | my $item; $item = { |
1938 | my $item; $item = { |
1771 | type => "button", |
1939 | type => "button", |
1772 | text => " $text", |
1940 | text => " $text", |
1773 | value => $value, |
1941 | value => $value, |
… | |
… | |
1792 | my $env = $self->{term}->env; |
1960 | my $env = $self->{term}->env; |
1793 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1961 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1794 | delete $env->{LC_ALL}; |
1962 | delete $env->{LC_ALL}; |
1795 | $env->{LC_CTYPE} = $self->{term}->locale; |
1963 | $env->{LC_CTYPE} = $self->{term}->locale; |
1796 | |
1964 | |
1797 | urxvt::term->new ($env, "popup", |
1965 | my $term = urxvt::term->new ( |
|
|
1966 | $env, "popup", |
1798 | "--perl-lib" => "", "--perl-ext-common" => "", |
1967 | "--perl-lib" => "", "--perl-ext-common" => "", |
1799 | "-pty-fd" => -1, "-sl" => 0, |
1968 | "-pty-fd" => -1, "-sl" => 0, |
1800 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1969 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1801 | "--transient-for" => $self->{term}->parent, |
1970 | "--transient-for" => $self->{term}->parent, |
1802 | "-display" => $self->{term}->display_id, |
1971 | "-display" => $self->{term}->display_id, |
1803 | "-pe" => "urxvt-popup") |
1972 | "-pe" => "urxvt-popup", |
1804 | or die "unable to create popup window\n"; |
1973 | ) or die "unable to create popup window\n"; |
|
|
1974 | |
|
|
1975 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
1976 | $term->ungrab; |
|
|
1977 | $term->destroy; |
|
|
1978 | die "unable to initialise popup window\n"; |
|
|
1979 | } |
1805 | } |
1980 | } |
1806 | |
1981 | |
1807 | sub DESTROY { |
1982 | sub DESTROY { |
1808 | my ($self) = @_; |
1983 | my ($self) = @_; |
1809 | |
1984 | |
… | |
… | |
1814 | =back |
1989 | =back |
1815 | |
1990 | |
1816 | =cut |
1991 | =cut |
1817 | |
1992 | |
1818 | package urxvt::watcher; |
1993 | package urxvt::watcher; |
1819 | |
|
|
1820 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1821 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1822 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1823 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1824 | |
1994 | |
1825 | =head2 The C<urxvt::timer> Class |
1995 | =head2 The C<urxvt::timer> Class |
1826 | |
1996 | |
1827 | This class implements timer watchers/events. Time is represented as a |
1997 | This class implements timer watchers/events. Time is represented as a |
1828 | fractional number of seconds since the epoch. Example: |
1998 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1832 | ->new |
2002 | ->new |
1833 | ->interval (1) |
2003 | ->interval (1) |
1834 | ->cb (sub { |
2004 | ->cb (sub { |
1835 | $term->{overlay}->set (0, 0, |
2005 | $term->{overlay}->set (0, 0, |
1836 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2006 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1837 | }); |
2007 | }); |
1838 | |
2008 | |
1839 | =over 4 |
2009 | =over 4 |
1840 | |
2010 | |
1841 | =item $timer = new urxvt::timer |
2011 | =item $timer = new urxvt::timer |
1842 | |
2012 | |
… | |
… | |
1885 | |
2055 | |
1886 | $term->{socket} = ... |
2056 | $term->{socket} = ... |
1887 | $term->{iow} = urxvt::iow |
2057 | $term->{iow} = urxvt::iow |
1888 | ->new |
2058 | ->new |
1889 | ->fd (fileno $term->{socket}) |
2059 | ->fd (fileno $term->{socket}) |
1890 | ->events (urxvt::EVENT_READ) |
2060 | ->events (urxvt::EV_READ) |
1891 | ->start |
2061 | ->start |
1892 | ->cb (sub { |
2062 | ->cb (sub { |
1893 | my ($iow, $revents) = @_; |
2063 | my ($iow, $revents) = @_; |
1894 | # $revents must be 1 here, no need to check |
2064 | # $revents must be 1 here, no need to check |
1895 | sysread $term->{socket}, my $buf, 8192 |
2065 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1908 | 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> |
1909 | is a bitset as described in the C<events> method. |
2079 | is a bitset as described in the C<events> method. |
1910 | |
2080 | |
1911 | =item $iow = $iow->fd ($fd) |
2081 | =item $iow = $iow->fd ($fd) |
1912 | |
2082 | |
1913 | Set the filedescriptor (not handle) to watch. |
2083 | Set the file descriptor (not handle) to watch. |
1914 | |
2084 | |
1915 | =item $iow = $iow->events ($eventmask) |
2085 | =item $iow = $iow->events ($eventmask) |
1916 | |
2086 | |
1917 | Set the event mask to watch. The only allowed values are |
2087 | Set the event mask to watch. The only allowed values are |
1918 | 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 |
1919 | together, or C<urxvt::EVENT_NONE>. |
2089 | together, or C<urxvt::EV_NONE>. |
1920 | |
2090 | |
1921 | =item $iow = $iow->start |
2091 | =item $iow = $iow->start |
1922 | |
2092 | |
1923 | Start watching for requested events on the given handle. |
2093 | Start watching for requested events on the given handle. |
1924 | |
2094 | |
1925 | =item $iow = $iow->stop |
2095 | =item $iow = $iow->stop |
1926 | |
2096 | |
1927 | Stop watching for events on the given filehandle. |
2097 | Stop watching for events on the given file handle. |
1928 | |
2098 | |
1929 | =back |
2099 | =back |
1930 | |
2100 | |
1931 | =head2 The C<urxvt::iw> Class |
2101 | =head2 The C<urxvt::iw> Class |
1932 | |
2102 | |
… | |
… | |
1965 | ->new |
2135 | ->new |
1966 | ->start ($pid) |
2136 | ->start ($pid) |
1967 | ->cb (sub { |
2137 | ->cb (sub { |
1968 | my ($pw, $exit_status) = @_; |
2138 | my ($pw, $exit_status) = @_; |
1969 | ... |
2139 | ... |
1970 | }); |
2140 | }); |
1971 | |
2141 | |
1972 | =over 4 |
2142 | =over 4 |
1973 | |
2143 | |
1974 | =item $pw = new urxvt::pw |
2144 | =item $pw = new urxvt::pw |
1975 | |
2145 | |
… | |
… | |
1979 | |
2149 | |
1980 | Set the callback to be called when the timer triggers. |
2150 | Set the callback to be called when the timer triggers. |
1981 | |
2151 | |
1982 | =item $pw = $timer->start ($pid) |
2152 | =item $pw = $timer->start ($pid) |
1983 | |
2153 | |
1984 | Tells the wqtcher to start watching for process C<$pid>. |
2154 | Tells the watcher to start watching for process C<$pid>. |
1985 | |
2155 | |
1986 | =item $pw = $pw->stop |
2156 | =item $pw = $pw->stop |
1987 | |
2157 | |
1988 | Stop the watcher. |
2158 | Stop the watcher. |
1989 | |
2159 | |
… | |
… | |
2002 | |
2172 | |
2003 | =item >= 3 - script loading and management |
2173 | =item >= 3 - script loading and management |
2004 | |
2174 | |
2005 | =item >=10 - all called hooks |
2175 | =item >=10 - all called hooks |
2006 | |
2176 | |
2007 | =item >=11 - hook reutrn values |
2177 | =item >=11 - hook return values |
2008 | |
2178 | |
2009 | =back |
2179 | =back |
2010 | |
2180 | |
2011 | =head1 AUTHOR |
2181 | =head1 AUTHOR |
2012 | |
2182 | |
… | |
… | |
2014 | http://software.schmorp.de/pkg/rxvt-unicode |
2184 | http://software.schmorp.de/pkg/rxvt-unicode |
2015 | |
2185 | |
2016 | =cut |
2186 | =cut |
2017 | |
2187 | |
2018 | 1 |
2188 | 1 |
|
|
2189 | |
|
|
2190 | # vim: sw=3: |