… | |
… | |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Everytime a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
|
|
30 | |
|
|
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
|
|
32 | and "perl-ext-common" resources to the empty string. |
30 | |
33 | |
31 | =head1 PREPACKAGED EXTENSIONS |
34 | =head1 PREPACKAGED EXTENSIONS |
32 | |
35 | |
33 | This section describes the extensions delivered with this release. You can |
36 | This section describes the extensions delivered with this release. You can |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
37 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
… | |
… | |
62 | URxvt.selection.pattern-1: perl-regex |
65 | URxvt.selection.pattern-1: perl-regex |
63 | ... |
66 | ... |
64 | |
67 | |
65 | The index number (0, 1...) must not have any holes, and each regex must |
68 | The index number (0, 1...) must not have any holes, and each regex must |
66 | contain at least one pair of capturing parentheses, which will be used for |
69 | contain at least one pair of capturing parentheses, which will be used for |
67 | the match. For example, the followign adds a regex that matches everything |
70 | the match. For example, the following adds a regex that matches everything |
68 | between two vertical bars: |
71 | between two vertical bars: |
69 | |
72 | |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
73 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
74 | |
|
|
75 | Another example: Programs I use often output "absolute path: " at the |
|
|
76 | beginning of a line when they process multiple files. The following |
|
|
77 | pattern matches the filename (note, there is a single space at the very |
|
|
78 | end): |
|
|
79 | |
|
|
80 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
71 | |
81 | |
72 | You can look at the source of the selection extension to see more |
82 | You can look at the source of the selection extension to see more |
73 | interesting uses, such as parsing a line from beginning to end. |
83 | interesting uses, such as parsing a line from beginning to end. |
74 | |
84 | |
75 | This extension also offers following bindable keyboard commands: |
85 | This extension also offers following bindable keyboard commands: |
… | |
… | |
86 | |
96 | |
87 | =item option-popup (enabled by default) |
97 | =item option-popup (enabled by default) |
88 | |
98 | |
89 | 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 |
90 | runtime. |
100 | runtime. |
|
|
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 | It's 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 | }; |
91 | |
118 | |
92 | =item selection-popup (enabled by default) |
119 | =item selection-popup (enabled by default) |
93 | |
120 | |
94 | 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 |
95 | text into various other formats/action (such as uri unescaping, perl |
122 | text into various other formats/action (such as uri unescaping, perl |
96 | evaluation, web-browser starting etc.), depending on content. |
123 | evaluation, web-browser starting etc.), depending on content. |
97 | |
124 | |
98 | 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 |
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
100 | popup is displayed. |
127 | popup is being displayed. |
101 | |
128 | |
102 | It's sole argument is the popup menu, which can be modified. The selection |
129 | It's sole argument is the popup menu, which can be modified. The selection |
103 | 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. |
104 | 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 |
105 | 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 |
106 | when the button gets activated and should transform C<$_>. |
133 | when the button gets activated and should transform C<$_>. |
107 | |
134 | |
108 | 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 |
… | |
… | |
127 | 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 |
128 | 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 |
129 | 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 |
130 | selection. |
157 | selection. |
131 | |
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. |
|
|
164 | |
|
|
165 | =item readline (enabled by default) |
|
|
166 | |
|
|
167 | A support package that tries to make editing with readline easier. At |
|
|
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
|
|
169 | move the text cursor to this position. It does so by generating as many |
|
|
170 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
171 | for programs that correctly support wide characters). |
|
|
172 | |
|
|
173 | To avoid too many false positives, this is only done when: |
|
|
174 | |
|
|
175 | =over 4 |
|
|
176 | |
|
|
177 | =item - the tty is in ICANON state. |
|
|
178 | |
|
|
179 | =item - the text cursor is visible. |
|
|
180 | |
|
|
181 | =item - the primary screen is currently being displayed. |
|
|
182 | |
|
|
183 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
184 | |
|
|
185 | =back |
|
|
186 | |
|
|
187 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
188 | might interfere with selection creation in harmless ways. |
|
|
189 | |
132 | =item selection-autotransform |
190 | =item selection-autotransform |
133 | |
191 | |
134 | This selection allows you to do automatic transforms on a selection |
192 | This selection allows you to do automatic transforms on a selection |
135 | whenever a selection is made. |
193 | whenever a selection is made. |
136 | |
194 | |
… | |
… | |
165 | the message into vi commands to load the file. |
223 | the message into vi commands to load the file. |
166 | |
224 | |
167 | =item tabbed |
225 | =item tabbed |
168 | |
226 | |
169 | This transforms the terminal into a tabbar with additional terminals, that |
227 | This transforms the terminal into a tabbar with additional terminals, that |
170 | 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 |
171 | 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 |
172 | button per tab. |
230 | button per tab. |
173 | |
231 | |
174 | 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 |
175 | 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, |
176 | while B<Shift-Down> creates a new tab. |
234 | while B<Shift-Down> creates a new tab. |
177 | |
235 | |
178 | =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): |
179 | |
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 | |
180 | 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 |
181 | make them clickable. When middle-clicked, the program specified in the |
251 | matching a certain pattern and make it clickable. When clicked with the |
182 | 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 |
183 | the URL as first argument. |
253 | middle), the program specified in the C<matcher.launcher> resource |
|
|
254 | (default, the C<urlLauncher> resource, C<sensible-browser>) will be started |
|
|
255 | with the matched text as first argument. The default configuration is |
|
|
256 | suitable for matching URLs and launching a web browser, like the |
|
|
257 | former "mark-urls" extension. |
|
|
258 | |
|
|
259 | The default pattern to match URLs can be overridden with the |
|
|
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
|
|
261 | with numbered patterns, in a manner similar to the "selection" extension. |
|
|
262 | The launcher can also be overridden on a per-pattern basis. |
|
|
263 | |
|
|
264 | It is possible to activate the most recently seen match from the keyboard. |
|
|
265 | Simply bind a keysym to "perl:matcher" as seen in the example below. |
|
|
266 | |
|
|
267 | Example configuration: |
|
|
268 | |
|
|
269 | URxvt.perl-ext: default,matcher |
|
|
270 | URxvt.urlLauncher: sensible-browser |
|
|
271 | URxvt.keysym.C-Delete: perl:matcher |
|
|
272 | URxvt.matcher.button: 1 |
|
|
273 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
274 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
275 | URxvt.matcher.launcher.2: gvim +$2 $1 |
|
|
276 | |
|
|
277 | =item xim-onthespot |
|
|
278 | |
|
|
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
280 | not work perfectly, and some input methods don't seem to work well with |
|
|
281 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
282 | kinput2. |
|
|
283 | |
|
|
284 | You enable it by specifying this extension and a preedit style of |
|
|
285 | C<OnTheSpot>, i.e.: |
|
|
286 | |
|
|
287 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
288 | |
|
|
289 | =item kuake<hotkey> |
|
|
290 | |
|
|
291 | A very primitive quake-console-like extension. It was inspired by a |
|
|
292 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
293 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
294 | will show or hide itself. Another press of the accelerator key will hide |
|
|
295 | or show it again. |
|
|
296 | |
|
|
297 | Initially, the window will not be shown when using this extension. |
|
|
298 | |
|
|
299 | This is useful if you need a single terminal thats 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). |
184 | |
307 | |
185 | =item automove-background |
308 | =item automove-background |
186 | |
309 | |
187 | This is basically a one-line extension that dynamically changes the background pixmap offset |
310 | This is basically a very small extension that dynamically changes the |
188 | to the window position, in effect creating the same effect as pseudo transparency with |
311 | background pixmap offset to the window position, in effect creating the |
189 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
312 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
313 | supported in this mode. Example: |
190 | |
314 | |
191 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
315 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
192 | |
316 | |
|
|
317 | L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions> |
|
|
318 | shows how this extension can be used to implement an automatically blurred |
|
|
319 | transparent background. |
|
|
320 | |
193 | =item block-graphics-to-ascii |
321 | =item block-graphics-to-ascii |
194 | |
322 | |
195 | A not very useful example of filtering all text output to the terminal, |
323 | A not very useful example of filtering all text output to the terminal |
196 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
324 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
197 | similar-looking ascii character. |
325 | similar-looking ascii character. |
198 | |
326 | |
199 | =item digital-clock |
327 | =item digital-clock |
200 | |
328 | |
201 | Displays a digital clock using the built-in overlay. |
329 | Displays a digital clock using the built-in overlay. |
202 | |
330 | |
203 | =item example-refresh-hooks |
331 | =item remote-clipboard |
204 | |
332 | |
205 | Displays a very simple digital clock in the upper right corner of the |
333 | Somewhat of a misnomer, this extension adds two menu entries to the |
206 | window. Illustrates overwriting the refresh callbacks to create your own |
334 | selection popup that allows one ti run external commands to store the |
207 | overlays or changes. |
335 | selection somewhere and fetch it again. |
|
|
336 | |
|
|
337 | We use it to implement a "distributed selection mechanism", which just |
|
|
338 | means that one command uploads the file to a remote server, and another |
|
|
339 | reads it. |
|
|
340 | |
|
|
341 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
342 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
343 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
344 | the selection data on STDOUT (also in UTF-8). |
|
|
345 | |
|
|
346 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
347 | |
|
|
348 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
349 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
208 | |
350 | |
209 | =item selection-pastebin |
351 | =item selection-pastebin |
210 | |
352 | |
211 | This is a little rarely useful extension that Uploads the selection as |
353 | This is a little rarely useful extension that Uploads the selection as |
212 | textfile to a remote site (or does other things). (The implementation is |
354 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
232 | After a successful upload the selection will be replaced by the text given |
374 | After a successful upload the selection will be replaced by the text given |
233 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
375 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
234 | for the filename): |
376 | for the filename): |
235 | |
377 | |
236 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
378 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
379 | |
|
|
380 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
381 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
382 | which works regardless of wether xrdb is used to parse the resource file |
|
|
383 | or not. |
|
|
384 | |
|
|
385 | =item example-refresh-hooks |
|
|
386 | |
|
|
387 | Displays a very simple digital clock in the upper right corner of the |
|
|
388 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
389 | overlays or changes. |
237 | |
390 | |
238 | =back |
391 | =back |
239 | |
392 | |
240 | =head1 API DOCUMENTATION |
393 | =head1 API DOCUMENTATION |
241 | |
394 | |
… | |
… | |
275 | |
428 | |
276 | =back |
429 | =back |
277 | |
430 | |
278 | =head2 Extension Objects |
431 | =head2 Extension Objects |
279 | |
432 | |
280 | Very perl extension is a perl class. A separate perl object is created |
433 | Every perl extension is a perl class. A separate perl object is created |
281 | for each terminal and each extension and passed as the first parameter to |
434 | for each terminal, and each terminal has its own set of extenion objects, |
282 | hooks. So extensions can use their C<$self> object without having to think |
435 | which are passed as the first parameter to hooks. So extensions can use |
283 | about other extensions, with the exception of methods and members that |
436 | their C<$self> object without having to think about clashes with other |
|
|
437 | extensions or other terminals, with the exception of methods and members |
284 | begin with an underscore character C<_>: these are reserved for internal |
438 | that begin with an underscore character C<_>: these are reserved for |
285 | use. |
439 | internal use. |
286 | |
440 | |
287 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
441 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
288 | C<urxvt::term> class on this object. |
442 | C<urxvt::term> class on this object. |
289 | |
443 | |
290 | It has the following methods and data members: |
444 | It has the following methods and data members: |
… | |
… | |
311 | =head2 Hooks |
465 | =head2 Hooks |
312 | |
466 | |
313 | The following subroutines can be declared in extension files, and will be |
467 | The following subroutines can be declared in extension files, and will be |
314 | called whenever the relevant event happens. |
468 | called whenever the relevant event happens. |
315 | |
469 | |
316 | The first argument passed to them is an extension oject as described in |
470 | The first argument passed to them is an extension object as described in |
317 | the in the C<Extension Objects> section. |
471 | the in the C<Extension Objects> section. |
318 | |
472 | |
319 | B<All> of these hooks must return a boolean value. If any of the called |
473 | B<All> of these hooks must return a boolean value. If any of the called |
320 | hooks returns true, then the event counts as being I<consumed>, and the |
474 | hooks returns true, then the event counts as being I<consumed>, and the |
321 | relevant action might not be carried out by the C++ code. |
475 | relevant action might not be carried out by the C++ code. |
… | |
… | |
334 | place. |
488 | place. |
335 | |
489 | |
336 | =item on_start $term |
490 | =item on_start $term |
337 | |
491 | |
338 | Called at the very end of initialisation of a new terminal, just before |
492 | Called at the very end of initialisation of a new terminal, just before |
339 | trying to map (display) the toplevel and returning to the mainloop. |
493 | trying to map (display) the toplevel and returning to the main loop. |
340 | |
494 | |
341 | =item on_destroy $term |
495 | =item on_destroy $term |
342 | |
496 | |
343 | Called whenever something tries to destroy terminal, before doing anything |
497 | Called whenever something tries to destroy terminal, when the terminal is |
344 | yet. If this hook returns true, then destruction is skipped, but this is |
498 | still fully functional (not for long, though). |
345 | rarely a good idea. |
|
|
346 | |
499 | |
347 | =item on_reset $term |
500 | =item on_reset $term |
348 | |
501 | |
349 | Called after the screen is "reset" for any reason, such as resizing or |
502 | Called after the screen is "reset" for any reason, such as resizing or |
350 | control sequences. Here is where you can react on changes to size-related |
503 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
372 | |
525 | |
373 | Called whenever a selection has been copied, but before the selection is |
526 | Called whenever a selection has been copied, but before the selection is |
374 | requested from the server. The selection text can be queried and changed |
527 | requested from the server. The selection text can be queried and changed |
375 | by calling C<< $term->selection >>. |
528 | by calling C<< $term->selection >>. |
376 | |
529 | |
377 | Returning a true value aborts selection grabbing. It will still be hilighted. |
530 | Returning a true value aborts selection grabbing. It will still be highlighted. |
378 | |
531 | |
379 | =item on_sel_extend $term |
532 | =item on_sel_extend $term |
380 | |
533 | |
381 | Called whenever the user tries to extend the selection (e.g. with a double |
534 | Called whenever the user tries to extend the selection (e.g. with a double |
382 | click) and is either supposed to return false (normal operation), or |
535 | click) and is either supposed to return false (normal operation), or |
383 | should extend the selection itelf and return true to suppress the built-in |
536 | should extend the selection itself and return true to suppress the built-in |
384 | processing. This can happen multiple times, as long as the callback |
537 | processing. This can happen multiple times, as long as the callback |
385 | returns true, it will be called on every further click by the user and is |
538 | returns true, it will be called on every further click by the user and is |
386 | supposed to enlarge the selection more and more, if possible. |
539 | supposed to enlarge the selection more and more, if possible. |
387 | |
540 | |
388 | See the F<selection> example extension. |
541 | See the F<selection> example extension. |
389 | |
542 | |
390 | =item on_view_change $term, $offset |
543 | =item on_view_change $term, $offset |
391 | |
544 | |
392 | Called whenever the view offset changes, i..e the user or program |
545 | Called whenever the view offset changes, i.e. the user or program |
393 | scrolls. Offset C<0> means display the normal terminal, positive values |
546 | scrolls. Offset C<0> means display the normal terminal, positive values |
394 | show this many lines of scrollback. |
547 | show this many lines of scrollback. |
395 | |
548 | |
396 | =item on_scroll_back $term, $lines, $saved |
549 | =item on_scroll_back $term, $lines, $saved |
397 | |
550 | |
… | |
… | |
401 | |
554 | |
402 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
555 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
403 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
556 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
404 | number of lines that will be in the scrollback buffer. |
557 | number of lines that will be in the scrollback buffer. |
405 | |
558 | |
|
|
559 | =item on_osc_seq $term, $op, $args |
|
|
560 | |
|
|
561 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
562 | behaviour. The default should be to return an empty list. A true value |
|
|
563 | suppresses execution of the request completely. Make sure you don't get |
|
|
564 | confused by recursive invocations when you output an osc sequence within |
|
|
565 | this callback. |
|
|
566 | |
|
|
567 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
568 | |
406 | =item on_osc_seq $term, $string |
569 | =item on_osc_seq_perl $term, $string |
407 | |
570 | |
408 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
571 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
409 | operating system command) is processed. Cursor position and other state |
572 | operating system command) is processed. Cursor position and other state |
410 | information is up-to-date when this happens. For interoperability, the |
573 | information is up-to-date when this happens. For interoperability, the |
411 | string should start with the extension name and a colon, to distinguish |
574 | string should start with the extension name and a colon, to distinguish |
412 | it from commands for other extensions, and this might be enforced in the |
575 | it from commands for other extensions, and this might be enforced in the |
413 | future. |
576 | future. |
414 | |
577 | |
415 | Be careful not ever to trust (in a security sense) the data you receive, |
578 | Be careful not ever to trust (in a security sense) the data you receive, |
416 | as its source can not easily be controleld (e-mail content, messages from |
579 | as its source can not easily be controlled (e-mail content, messages from |
417 | other users on the same system etc.). |
580 | other users on the same system etc.). |
418 | |
581 | |
419 | =item on_add_lines $term, $string |
582 | =item on_add_lines $term, $string |
420 | |
583 | |
421 | Called whenever text is about to be output, with the text as argument. You |
584 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
452 | |
615 | |
453 | =item on_refresh_end $term |
616 | =item on_refresh_end $term |
454 | |
617 | |
455 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
618 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
456 | |
619 | |
457 | =item on_keyboard_command $term, $string |
620 | =item on_user_command $term, $string |
458 | |
621 | |
459 | Called whenever the user presses a key combination that has a |
622 | Called whenever a user-configured event is being activated (e.g. via |
460 | C<perl:string> action bound to it (see description of the B<keysym> |
623 | a C<perl:string> action bound to a key, see description of the B<keysym> |
461 | resource in the @@RXVT_NAME@@(1) manpage). |
624 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
625 | |
|
|
626 | The event is simply the action string. This interface is assumed to change |
|
|
627 | slightly in the future. |
|
|
628 | |
|
|
629 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
630 | |
|
|
631 | Called just after the new window size has been calculated, but before |
|
|
632 | windows are actually being resized or hints are being set. If this hook |
|
|
633 | returns TRUE, setting of the window hints is being skipped. |
462 | |
634 | |
463 | =item on_x_event $term, $event |
635 | =item on_x_event $term, $event |
464 | |
636 | |
465 | Called on every X event received on the vt window (and possibly other |
637 | Called on every X event received on the vt window (and possibly other |
466 | windows). Should only be used as a last resort. Most event structure |
638 | windows). Should only be used as a last resort. Most event structure |
467 | members are not passed. |
639 | members are not passed. |
468 | |
640 | |
|
|
641 | =item on_root_event $term, $event |
|
|
642 | |
|
|
643 | Like C<on_x_event>, but is called for events on the root window. |
|
|
644 | |
469 | =item on_focus_in $term |
645 | =item on_focus_in $term |
470 | |
646 | |
471 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
647 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
472 | does focus in processing. |
648 | does focus in processing. |
473 | |
649 | |
474 | =item on_focus_out $term |
650 | =item on_focus_out $term |
475 | |
651 | |
476 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
652 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
477 | focus out processing. |
653 | focus out processing. |
478 | |
654 | |
479 | =item on_configure_notify $term, $event |
655 | =item on_configure_notify $term, $event |
480 | |
656 | |
481 | =item on_property_notify $term, $event |
657 | =item on_property_notify $term, $event |
… | |
… | |
496 | |
672 | |
497 | Called whenever the corresponding X event is received for the terminal If |
673 | Called whenever the corresponding X event is received for the terminal If |
498 | the hook returns true, then the even will be ignored by rxvt-unicode. |
674 | the hook returns true, then the even will be ignored by rxvt-unicode. |
499 | |
675 | |
500 | The event is a hash with most values as named by Xlib (see the XEvent |
676 | The event is a hash with most values as named by Xlib (see the XEvent |
501 | manpage), with the additional members C<row> and C<col>, which are the row |
677 | manpage), with the additional members C<row> and C<col>, which are the |
502 | and column under the mouse cursor. |
678 | (real, not screen-based) row and column under the mouse cursor. |
503 | |
679 | |
504 | C<on_key_press> additionally receives the string rxvt-unicode would |
680 | C<on_key_press> additionally receives the string rxvt-unicode would |
505 | output, if any, in locale-specific encoding. |
681 | output, if any, in locale-specific encoding. |
506 | |
682 | |
507 | subwindow. |
683 | subwindow. |
… | |
… | |
538 | our $LIBDIR; |
714 | our $LIBDIR; |
539 | our $RESNAME; |
715 | our $RESNAME; |
540 | our $RESCLASS; |
716 | our $RESCLASS; |
541 | our $RXVTNAME; |
717 | our $RXVTNAME; |
542 | |
718 | |
|
|
719 | our $NOCHAR = chr 0xffff; |
|
|
720 | |
543 | =head2 Variables in the C<urxvt> Package |
721 | =head2 Variables in the C<urxvt> Package |
544 | |
722 | |
545 | =over 4 |
723 | =over 4 |
546 | |
724 | |
547 | =item $urxvt::LIBDIR |
725 | =item $urxvt::LIBDIR |
… | |
… | |
562 | The current terminal. This variable stores the current C<urxvt::term> |
740 | The current terminal. This variable stores the current C<urxvt::term> |
563 | object, whenever a callback/hook is executing. |
741 | object, whenever a callback/hook is executing. |
564 | |
742 | |
565 | =item @urxvt::TERM_INIT |
743 | =item @urxvt::TERM_INIT |
566 | |
744 | |
567 | All coderefs in this array will be called as methods of the next newly |
745 | All code references in this array will be called as methods of the next newly |
568 | created C<urxvt::term> object (during the C<on_init> phase). The array |
746 | created C<urxvt::term> object (during the C<on_init> phase). The array |
569 | gets cleared before the codereferences that were in it are being executed, |
747 | gets cleared before the code references that were in it are being executed, |
570 | so coderefs can push themselves onto it again if they so desire. |
748 | so references can push themselves onto it again if they so desire. |
571 | |
749 | |
572 | This complements to the perl-eval commandline option, but gets executed |
750 | This complements to the perl-eval command line option, but gets executed |
573 | first. |
751 | first. |
574 | |
752 | |
575 | =item @urxvt::TERM_EXT |
753 | =item @urxvt::TERM_EXT |
576 | |
754 | |
577 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
755 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
598 | |
776 | |
599 | Using this function has the advantage that its output ends up in the |
777 | Using this function has the advantage that its output ends up in the |
600 | correct place, e.g. on stderr of the connecting urxvtc client. |
778 | correct place, e.g. on stderr of the connecting urxvtc client. |
601 | |
779 | |
602 | Messages have a size limit of 1023 bytes currently. |
780 | Messages have a size limit of 1023 bytes currently. |
|
|
781 | |
|
|
782 | =item @terms = urxvt::termlist |
|
|
783 | |
|
|
784 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
785 | whether they are started, being destroyed etc., so be careful. Only term |
|
|
786 | objects that have perl extensions attached will be returned (because there |
|
|
787 | is no urxvt::term objet associated with others). |
603 | |
788 | |
604 | =item $time = urxvt::NOW |
789 | =item $time = urxvt::NOW |
605 | |
790 | |
606 | Returns the "current time" (as per the event loop). |
791 | Returns the "current time" (as per the event loop). |
607 | |
792 | |
… | |
… | |
665 | Return the foreground/background colour index, respectively. |
850 | Return the foreground/background colour index, respectively. |
666 | |
851 | |
667 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
852 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
668 | |
853 | |
669 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
854 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
855 | |
|
|
856 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
670 | |
857 | |
671 | Replace the foreground/background colour in the rendition mask with the |
858 | Replace the foreground/background colour in the rendition mask with the |
672 | specified one. |
859 | specified one. |
673 | |
860 | |
674 | =item $value = urxvt::GET_CUSTOM $rend |
861 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
693 | unless $msg =~ /\n$/; |
880 | unless $msg =~ /\n$/; |
694 | urxvt::warn ($msg); |
881 | urxvt::warn ($msg); |
695 | }; |
882 | }; |
696 | } |
883 | } |
697 | |
884 | |
|
|
885 | no warnings 'utf8'; |
|
|
886 | |
698 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
887 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
699 | |
888 | |
700 | sub verbose { |
889 | sub verbose { |
701 | my ($level, $msg) = @_; |
890 | my ($level, $msg) = @_; |
702 | warn "$msg\n" if $level <= $verbosity; |
891 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
718 | |
907 | |
719 | open my $fh, "<:raw", $path |
908 | open my $fh, "<:raw", $path |
720 | or die "$path: $!"; |
909 | or die "$path: $!"; |
721 | |
910 | |
722 | my $source = |
911 | my $source = |
723 | "package $pkg; use strict; use utf8;\n" |
912 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
724 | . "#line 1 \"$path\"\n{\n" |
913 | . "#line 1 \"$path\"\n{\n" |
725 | . (do { local $/; <$fh> }) |
914 | . (do { local $/; <$fh> }) |
726 | . "\n};\n1"; |
915 | . "\n};\n1"; |
727 | |
916 | |
728 | eval $source |
917 | eval $source |
… | |
… | |
753 | $TERM->register_package ($_) for @pkg; |
942 | $TERM->register_package ($_) for @pkg; |
754 | } |
943 | } |
755 | |
944 | |
756 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
945 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
757 | if ($_ eq "default") { |
946 | if ($_ eq "default") { |
758 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
947 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
759 | } elsif (/^-(.*)$/) { |
948 | } elsif (/^-(.*)$/) { |
760 | delete $ext_arg{$1}; |
949 | delete $ext_arg{$1}; |
761 | } elsif (/^([^<]+)<(.*)>$/) { |
950 | } elsif (/^([^<]+)<(.*)>$/) { |
762 | push @{ $ext_arg{$1} }, $2; |
951 | push @{ $ext_arg{$1} }, $2; |
763 | } else { |
952 | } else { |
764 | $ext_arg{$_} ||= []; |
953 | $ext_arg{$_} ||= []; |
765 | } |
954 | } |
766 | } |
955 | } |
767 | |
956 | |
768 | while (my ($ext, $argv) = each %ext_arg) { |
957 | for my $ext (sort keys %ext_arg) { |
769 | my @files = grep -f $_, map "$_/$ext", @dirs; |
958 | my @files = grep -f $_, map "$_/$ext", @dirs; |
770 | |
959 | |
771 | if (@files) { |
960 | if (@files) { |
772 | $TERM->register_package (extension_package $files[0], $argv); |
961 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
773 | } else { |
962 | } else { |
774 | warn "perl extension '$ext' not found in perl library search path\n"; |
963 | warn "perl extension '$ext' not found in perl library search path\n"; |
775 | } |
964 | } |
776 | } |
965 | } |
777 | |
966 | |
… | |
… | |
783 | |
972 | |
784 | if (my $cb = $TERM->{_hook}[$htype]) { |
973 | if (my $cb = $TERM->{_hook}[$htype]) { |
785 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
974 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
786 | if $verbosity >= 10; |
975 | if $verbosity >= 10; |
787 | |
976 | |
788 | keys %$cb; |
977 | for my $pkg (keys %$cb) { |
789 | |
|
|
790 | while (my ($pkg, $cb) = each %$cb) { |
|
|
791 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
978 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
792 | $retval ||= $retval_; |
979 | $retval ||= $retval_; |
793 | |
980 | |
794 | if ($@) { |
981 | if ($@) { |
795 | $TERM->ungrab; # better to lose the grab than the session |
982 | $TERM->ungrab; # better to lose the grab than the session |
796 | warn $@; |
983 | warn $@; |
… | |
… | |
808 | # clear package |
995 | # clear package |
809 | %$TERM = (); |
996 | %$TERM = (); |
810 | } |
997 | } |
811 | |
998 | |
812 | $retval |
999 | $retval |
|
|
1000 | } |
|
|
1001 | |
|
|
1002 | sub SET_COLOR($$$) { |
|
|
1003 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
1004 | } |
|
|
1005 | |
|
|
1006 | sub rend2mask { |
|
|
1007 | no strict 'refs'; |
|
|
1008 | my ($str, $mask) = (@_, 0); |
|
|
1009 | my %color = ( fg => undef, bg => undef ); |
|
|
1010 | my @failed; |
|
|
1011 | for my $spec ( split /\s+/, $str ) { |
|
|
1012 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1013 | $color{lc($1)} = $2; |
|
|
1014 | } else { |
|
|
1015 | my $neg = $spec =~ s/^[-^]//; |
|
|
1016 | unless ( exists &{"RS_$spec"} ) { |
|
|
1017 | push @failed, $spec; |
|
|
1018 | next; |
|
|
1019 | } |
|
|
1020 | my $cur = &{"RS_$spec"}; |
|
|
1021 | if ( $neg ) { |
|
|
1022 | $mask &= ~$cur; |
|
|
1023 | } else { |
|
|
1024 | $mask |= $cur; |
|
|
1025 | } |
|
|
1026 | } |
|
|
1027 | } |
|
|
1028 | ($mask, @color{qw(fg bg)}, \@failed) |
813 | } |
1029 | } |
814 | |
1030 | |
815 | # urxvt::term::extension |
1031 | # urxvt::term::extension |
816 | |
1032 | |
817 | package urxvt::term::extension; |
1033 | package urxvt::term::extension; |
… | |
… | |
930 | sub DESTROY { |
1146 | sub DESTROY { |
931 | $_[0][1]->stop; |
1147 | $_[0][1]->stop; |
932 | } |
1148 | } |
933 | |
1149 | |
934 | sub condvar { |
1150 | sub condvar { |
935 | bless \my $flag, urxvt::anyevent::condvar:: |
1151 | bless \my $flag, urxvt::anyevent:: |
936 | } |
1152 | } |
937 | |
1153 | |
938 | sub urxvt::anyevent::condvar::broadcast { |
1154 | sub broadcast { |
939 | ${$_[0]}++; |
1155 | ${$_[0]}++; |
940 | } |
1156 | } |
941 | |
1157 | |
942 | sub urxvt::anyevent::condvar::wait { |
1158 | sub wait { |
943 | unless (${$_[0]}) { |
1159 | unless (${$_[0]}) { |
944 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1160 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
945 | } |
1161 | } |
|
|
1162 | } |
|
|
1163 | |
|
|
1164 | sub one_event { |
|
|
1165 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
946 | } |
1166 | } |
947 | |
1167 | |
948 | package urxvt::term; |
1168 | package urxvt::term; |
949 | |
1169 | |
950 | =head2 The C<urxvt::term> Class |
1170 | =head2 The C<urxvt::term> Class |
… | |
… | |
986 | hash which defines the environment of the new terminal. |
1206 | hash which defines the environment of the new terminal. |
987 | |
1207 | |
988 | Croaks (and probably outputs an error message) if the new instance |
1208 | Croaks (and probably outputs an error message) if the new instance |
989 | couldn't be created. Returns C<undef> if the new instance didn't |
1209 | couldn't be created. Returns C<undef> if the new instance didn't |
990 | initialise perl, and the terminal object otherwise. The C<init> and |
1210 | initialise perl, and the terminal object otherwise. The C<init> and |
991 | C<start> hooks will be called during this call. |
1211 | C<start> hooks will be called before this call returns, and are free to |
|
|
1212 | refer to global data (which is race free). |
992 | |
1213 | |
993 | =cut |
1214 | =cut |
994 | |
1215 | |
995 | sub new { |
1216 | sub new { |
996 | my ($class, $env, @args) = @_; |
1217 | my ($class, $env, @args) = @_; |
997 | |
1218 | |
|
|
1219 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1220 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1221 | |
998 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1222 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
999 | } |
1223 | } |
1000 | |
1224 | |
1001 | =item $term->destroy |
1225 | =item $term->destroy |
1002 | |
1226 | |
1003 | Destroy the terminal object (close the window, free resources |
1227 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1033 | |
1257 | |
1034 | Returns true if the option specified by C<$optval> is enabled, and |
1258 | Returns true if the option specified by C<$optval> is enabled, and |
1035 | optionally change it. All option values are stored by name in the hash |
1259 | optionally change it. All option values are stored by name in the hash |
1036 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1260 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1037 | |
1261 | |
1038 | Here is a a likely non-exhaustive list of option names, please see the |
1262 | Here is a likely non-exhaustive list of option names, please see the |
1039 | source file F</src/optinc.h> to see the actual list: |
1263 | source file F</src/optinc.h> to see the actual list: |
1040 | |
1264 | |
1041 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1265 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1042 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1266 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1043 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1267 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1060 | likely change). |
1284 | likely change). |
1061 | |
1285 | |
1062 | Please note that resource strings will currently only be freed when the |
1286 | Please note that resource strings will currently only be freed when the |
1063 | terminal is destroyed, so changing options frequently will eat memory. |
1287 | terminal is destroyed, so changing options frequently will eat memory. |
1064 | |
1288 | |
1065 | Here is a a likely non-exhaustive list of resource names, not all of which |
1289 | Here is a likely non-exhaustive list of resource names, not all of which |
1066 | are supported in every build, please see the source file F</src/rsinc.h> |
1290 | are supported in every build, please see the source file F</src/rsinc.h> |
1067 | to see the actual list: |
1291 | to see the actual list: |
1068 | |
1292 | |
1069 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1293 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1070 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1294 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1260 | |
1484 | |
1261 | Normally its not a good idea to use this function, as programs might be |
1485 | Normally its not a good idea to use this function, as programs might be |
1262 | confused by changes in cursor position or scrolling. Its useful inside a |
1486 | confused by changes in cursor position or scrolling. Its useful inside a |
1263 | C<on_add_lines> hook, though. |
1487 | C<on_add_lines> hook, though. |
1264 | |
1488 | |
|
|
1489 | =item $term->scr_change_screen ($screen) |
|
|
1490 | |
|
|
1491 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1492 | |
1265 | =item $term->cmd_parse ($octets) |
1493 | =item $term->cmd_parse ($octets) |
1266 | |
1494 | |
1267 | Similar to C<scr_add_lines>, but the argument must be in the |
1495 | Similar to C<scr_add_lines>, but the argument must be in the |
1268 | locale-specific encoding of the terminal and can contain command sequences |
1496 | locale-specific encoding of the terminal and can contain command sequences |
1269 | (escape codes) that will be interpreted. |
1497 | (escape codes) that will be interpreted. |
… | |
… | |
1279 | Replaces the event mask of the pty watcher by the given event mask. Can |
1507 | Replaces the event mask of the pty watcher by the given event mask. Can |
1280 | be used to suppress input and output handling to the pty/tty. See the |
1508 | be used to suppress input and output handling to the pty/tty. See the |
1281 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1509 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1282 | the previous value. |
1510 | the previous value. |
1283 | |
1511 | |
|
|
1512 | =item $fd = $term->pty_fd |
|
|
1513 | |
|
|
1514 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1515 | is used. |
|
|
1516 | |
1284 | =item $windowid = $term->parent |
1517 | =item $windowid = $term->parent |
1285 | |
1518 | |
1286 | Return the window id of the toplevel window. |
1519 | Return the window id of the toplevel window. |
1287 | |
1520 | |
1288 | =item $windowid = $term->vt |
1521 | =item $windowid = $term->vt |
… | |
… | |
1294 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1527 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1295 | to receive pointer events all the times: |
1528 | to receive pointer events all the times: |
1296 | |
1529 | |
1297 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1530 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1298 | |
1531 | |
|
|
1532 | =item $term->focus_in |
|
|
1533 | |
|
|
1534 | =item $term->focus_out |
|
|
1535 | |
|
|
1536 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1537 | |
|
|
1538 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1539 | |
|
|
1540 | Deliver various fake events to to terminal. |
|
|
1541 | |
1299 | =item $window_width = $term->width |
1542 | =item $window_width = $term->width |
1300 | |
1543 | |
1301 | =item $window_height = $term->height |
1544 | =item $window_height = $term->height |
1302 | |
1545 | |
1303 | =item $font_width = $term->fwidth |
1546 | =item $font_width = $term->fwidth |
… | |
… | |
1333 | =item $env = $term->env |
1576 | =item $env = $term->env |
1334 | |
1577 | |
1335 | Returns a copy of the environment in effect for the terminal as a hashref |
1578 | Returns a copy of the environment in effect for the terminal as a hashref |
1336 | similar to C<\%ENV>. |
1579 | similar to C<\%ENV>. |
1337 | |
1580 | |
|
|
1581 | =item @envv = $term->envv |
|
|
1582 | |
|
|
1583 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1584 | |
|
|
1585 | =item @argv = $term->argv |
|
|
1586 | |
|
|
1587 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1588 | includes the program name as first element. |
|
|
1589 | |
1338 | =cut |
1590 | =cut |
1339 | |
1591 | |
1340 | sub env { |
1592 | sub env { |
1341 | if (my $env = $_[0]->_env) { |
|
|
1342 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1593 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1343 | } else { |
|
|
1344 | +{ %ENV } |
|
|
1345 | } |
|
|
1346 | } |
1594 | } |
1347 | |
1595 | |
1348 | =item $modifiermask = $term->ModLevel3Mask |
1596 | =item $modifiermask = $term->ModLevel3Mask |
1349 | |
1597 | |
1350 | =item $modifiermask = $term->ModMetaMask |
1598 | =item $modifiermask = $term->ModMetaMask |
1351 | |
1599 | |
1352 | =item $modifiermask = $term->ModNumLockMask |
1600 | =item $modifiermask = $term->ModNumLockMask |
1353 | |
1601 | |
1354 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1602 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1355 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1603 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1604 | |
|
|
1605 | =item $screen = $term->current_screen |
|
|
1606 | |
|
|
1607 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1608 | |
|
|
1609 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1610 | |
|
|
1611 | Returns whether the cursor is currently hidden or not. |
1356 | |
1612 | |
1357 | =item $view_start = $term->view_start ([$newvalue]) |
1613 | =item $view_start = $term->view_start ([$newvalue]) |
1358 | |
1614 | |
1359 | Returns the row number of the topmost displayed line. Maximum value is |
1615 | Returns the row number of the topmost displayed line. Maximum value is |
1360 | C<0>, which displays the normal terminal contents. Lower values scroll |
1616 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1380 | line, starting at column C<$start_col> (default C<0>), which is useful |
1636 | line, starting at column C<$start_col> (default C<0>), which is useful |
1381 | to replace only parts of a line. The font index in the rendition will |
1637 | to replace only parts of a line. The font index in the rendition will |
1382 | automatically be updated. |
1638 | automatically be updated. |
1383 | |
1639 | |
1384 | C<$text> is in a special encoding: tabs and wide characters that use more |
1640 | C<$text> is in a special encoding: tabs and wide characters that use more |
1385 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1641 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1386 | (C<chr 65535>). Characters with combining characters and other characters |
1642 | characters. Characters with combining characters and other characters that |
1387 | that do not fit into the normal tetx encoding will be replaced with |
1643 | do not fit into the normal tetx encoding will be replaced with characters |
1388 | characters in the private use area. |
1644 | in the private use area. |
1389 | |
1645 | |
1390 | You have to obey this encoding when changing text. The advantage is |
1646 | You have to obey this encoding when changing text. The advantage is |
1391 | that C<substr> and similar functions work on screen cells and not on |
1647 | that C<substr> and similar functions work on screen cells and not on |
1392 | characters. |
1648 | characters. |
1393 | |
1649 | |
… | |
… | |
1537 | where one character corresponds to one screen cell. See |
1793 | where one character corresponds to one screen cell. See |
1538 | C<< $term->ROW_t >> for details. |
1794 | C<< $term->ROW_t >> for details. |
1539 | |
1795 | |
1540 | =item $string = $term->special_decode $text |
1796 | =item $string = $term->special_decode $text |
1541 | |
1797 | |
1542 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1798 | Converts rxvt-unicodes text representation into a perl string. See |
1543 | C<< $term->ROW_t >> for details. |
1799 | C<< $term->ROW_t >> for details. |
1544 | |
1800 | |
1545 | =item $success = $term->grab_button ($button, $modifiermask) |
1801 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1546 | |
1802 | |
|
|
1803 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1804 | |
1547 | Registers a synchronous button grab. See the XGrabButton manpage. |
1805 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1806 | manpage. |
1548 | |
1807 | |
1549 | =item $success = $term->grab ($eventtime[, $sync]) |
1808 | =item $success = $term->grab ($eventtime[, $sync]) |
1550 | |
1809 | |
1551 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1810 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1552 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1811 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1553 | |
1812 | |
1554 | =item $term->allow_events_async |
1813 | =item $term->allow_events_async |
1555 | |
1814 | |
1556 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1815 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1557 | |
1816 | |
… | |
… | |
1567 | =item $term->ungrab |
1826 | =item $term->ungrab |
1568 | |
1827 | |
1569 | Calls XUngrab for the most recent grab. Is called automatically on |
1828 | Calls XUngrab for the most recent grab. Is called automatically on |
1570 | evaluation errors, as it is better to lose the grab in the error case as |
1829 | evaluation errors, as it is better to lose the grab in the error case as |
1571 | the session. |
1830 | the session. |
|
|
1831 | |
|
|
1832 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1833 | |
|
|
1834 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1835 | |
|
|
1836 | =item @atoms = $term->XListProperties ($window) |
|
|
1837 | |
|
|
1838 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1839 | |
|
|
1840 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1841 | |
|
|
1842 | =item $term->XDeleteProperty ($window, $property) |
|
|
1843 | |
|
|
1844 | =item $window = $term->DefaultRootWindow |
|
|
1845 | |
|
|
1846 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1847 | |
|
|
1848 | =item $term->XMapWindow ($window) |
|
|
1849 | |
|
|
1850 | =item $term->XUnmapWindow ($window) |
|
|
1851 | |
|
|
1852 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1853 | |
|
|
1854 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1855 | |
|
|
1856 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1857 | |
|
|
1858 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1859 | the source of the display, otherwise those functions map more-or-less |
|
|
1860 | directory onto the X functions of the same name. |
1572 | |
1861 | |
1573 | =back |
1862 | =back |
1574 | |
1863 | |
1575 | =cut |
1864 | =cut |
1576 | |
1865 | |
… | |
… | |
1640 | my ($self, $text, $cb) = @_; |
1929 | my ($self, $text, $cb) = @_; |
1641 | |
1930 | |
1642 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1931 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1643 | } |
1932 | } |
1644 | |
1933 | |
1645 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1934 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1646 | |
1935 | |
1647 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1936 | Adds a toggle/checkbox item to the popup. The callback gets called |
1648 | whenever it gets toggled, with a boolean indicating its value as its first |
1937 | whenever it gets toggled, with a boolean indicating its new value as its |
1649 | argument. |
1938 | first argument. |
1650 | |
1939 | |
1651 | =cut |
1940 | =cut |
1652 | |
1941 | |
1653 | sub add_toggle { |
1942 | sub add_toggle { |
1654 | my ($self, $text, $cb, $value) = @_; |
1943 | my ($self, $text, $value, $cb) = @_; |
1655 | |
1944 | |
1656 | my $item; $item = { |
1945 | my $item; $item = { |
1657 | type => "button", |
1946 | type => "button", |
1658 | text => " $text", |
1947 | text => " $text", |
1659 | value => $value, |
1948 | value => $value, |
… | |
… | |
1700 | =back |
1989 | =back |
1701 | |
1990 | |
1702 | =cut |
1991 | =cut |
1703 | |
1992 | |
1704 | package urxvt::watcher; |
1993 | package urxvt::watcher; |
1705 | |
|
|
1706 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1707 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1708 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1709 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1710 | |
1994 | |
1711 | =head2 The C<urxvt::timer> Class |
1995 | =head2 The C<urxvt::timer> Class |
1712 | |
1996 | |
1713 | This class implements timer watchers/events. Time is represented as a |
1997 | This class implements timer watchers/events. Time is represented as a |
1714 | fractional number of seconds since the epoch. Example: |
1998 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1794 | 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> |
1795 | is a bitset as described in the C<events> method. |
2079 | is a bitset as described in the C<events> method. |
1796 | |
2080 | |
1797 | =item $iow = $iow->fd ($fd) |
2081 | =item $iow = $iow->fd ($fd) |
1798 | |
2082 | |
1799 | Set the filedescriptor (not handle) to watch. |
2083 | Set the file descriptor (not handle) to watch. |
1800 | |
2084 | |
1801 | =item $iow = $iow->events ($eventmask) |
2085 | =item $iow = $iow->events ($eventmask) |
1802 | |
2086 | |
1803 | Set the event mask to watch. The only allowed values are |
2087 | Set the event mask to watch. The only allowed values are |
1804 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2088 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
… | |
… | |
1808 | |
2092 | |
1809 | Start watching for requested events on the given handle. |
2093 | Start watching for requested events on the given handle. |
1810 | |
2094 | |
1811 | =item $iow = $iow->stop |
2095 | =item $iow = $iow->stop |
1812 | |
2096 | |
1813 | Stop watching for events on the given filehandle. |
2097 | Stop watching for events on the given file handle. |
1814 | |
2098 | |
1815 | =back |
2099 | =back |
1816 | |
2100 | |
1817 | =head2 The C<urxvt::iw> Class |
2101 | =head2 The C<urxvt::iw> Class |
1818 | |
2102 | |
… | |
… | |
1865 | |
2149 | |
1866 | Set the callback to be called when the timer triggers. |
2150 | Set the callback to be called when the timer triggers. |
1867 | |
2151 | |
1868 | =item $pw = $timer->start ($pid) |
2152 | =item $pw = $timer->start ($pid) |
1869 | |
2153 | |
1870 | Tells the wqtcher to start watching for process C<$pid>. |
2154 | Tells the watcher to start watching for process C<$pid>. |
1871 | |
2155 | |
1872 | =item $pw = $pw->stop |
2156 | =item $pw = $pw->stop |
1873 | |
2157 | |
1874 | Stop the watcher. |
2158 | Stop the watcher. |
1875 | |
2159 | |
… | |
… | |
1888 | |
2172 | |
1889 | =item >= 3 - script loading and management |
2173 | =item >= 3 - script loading and management |
1890 | |
2174 | |
1891 | =item >=10 - all called hooks |
2175 | =item >=10 - all called hooks |
1892 | |
2176 | |
1893 | =item >=11 - hook reutrn values |
2177 | =item >=11 - hook return values |
1894 | |
2178 | |
1895 | =back |
2179 | =back |
1896 | |
2180 | |
1897 | =head1 AUTHOR |
2181 | =head1 AUTHOR |
1898 | |
2182 | |
… | |
… | |
1900 | http://software.schmorp.de/pkg/rxvt-unicode |
2184 | http://software.schmorp.de/pkg/rxvt-unicode |
1901 | |
2185 | |
1902 | =cut |
2186 | =cut |
1903 | |
2187 | |
1904 | 1 |
2188 | 1 |
|
|
2189 | |
|
|
2190 | # vim: sw=3: |