… | |
… | |
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: |
… | |
… | |
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. |
91 | |
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 | }; |
|
|
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 | evalution, 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 | |
… | |
… | |
162 | |
220 | |
163 | The first line tells the selection code to treat the unchanging part of |
221 | The first line tells the selection code to treat the unchanging part of |
164 | every error message as a selection pattern, and the second line transforms |
222 | every error message as a selection pattern, and the second line transforms |
165 | the message into vi commands to load the file. |
223 | the message into vi commands to load the file. |
166 | |
224 | |
167 | =item mark-urls |
225 | =item tabbed |
168 | |
226 | |
|
|
227 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
228 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
|
|
229 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
230 | button per tab. |
|
|
231 | |
|
|
232 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
233 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
234 | while B<Shift-Down> creates a new tab. |
|
|
235 | |
|
|
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): |
|
|
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 | |
169 | 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 |
170 | make them clickable. When middle-clicked, the program specified in the |
251 | matching a certain pattern and make it clickable. When clicked with the |
171 | 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 |
172 | 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 | Example configuration: |
|
|
265 | |
|
|
266 | URxvt.perl-ext: default,matcher |
|
|
267 | URxvt.urlLauncher: sensible-browser |
|
|
268 | URxvt.keysym.C-Delete: perl:matcher |
|
|
269 | URxvt.matcher.button: 1 |
|
|
270 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
271 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
272 | URxvt.matcher.launcher.2: gvim +$2 $1 |
|
|
273 | |
|
|
274 | =item xim-onthespot |
|
|
275 | |
|
|
276 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
277 | not work perfectly, and some input methods don't seem to work well with |
|
|
278 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
279 | kinput2. |
|
|
280 | |
|
|
281 | You enable it by specifying this extension and a preedit style of |
|
|
282 | C<OnTheSpot>, i.e.: |
|
|
283 | |
|
|
284 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
285 | |
|
|
286 | =item kuake<hotkey> |
|
|
287 | |
|
|
288 | A very primitive quake-console-like extension. It was inspired by a |
|
|
289 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
290 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
291 | will show or hide itself. Another press of the accelerator key will hide |
|
|
292 | or show it again. |
|
|
293 | |
|
|
294 | Initially, the window will not be shown when using this extension. |
|
|
295 | |
|
|
296 | This is useful if you need a single terminal thats not using any desktop |
|
|
297 | space most of the time but is quickly available at the press of a key. |
|
|
298 | |
|
|
299 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
300 | extension will actually grab a physical key just for this function. |
|
|
301 | |
|
|
302 | If you want a quake-like animation, tell your window manager to do so |
|
|
303 | (fvwm can do it). |
173 | |
304 | |
174 | =item automove-background |
305 | =item automove-background |
175 | |
306 | |
176 | This is basically a one-line extension that dynamically changes the background pixmap offset |
307 | This is basically a very small extension that dynamically changes the |
177 | to the window position, in effect creating the same effect as pseudo transparency with |
308 | background pixmap offset to the window position, in effect creating the |
178 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
309 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
310 | supported in this mode. Example: |
179 | |
311 | |
180 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
312 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
181 | |
313 | |
|
|
314 | L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions> |
|
|
315 | shows how this extension can be used to implement an automatically blurred |
|
|
316 | transparent background. |
|
|
317 | |
182 | =item block-graphics-to-ascii |
318 | =item block-graphics-to-ascii |
183 | |
319 | |
184 | A not very useful example of filtering all text output to the terminal, |
320 | A not very useful example of filtering all text output to the terminal |
185 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
321 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
186 | similar-looking ascii character. |
322 | similar-looking ascii character. |
187 | |
323 | |
188 | =item digital-clock |
324 | =item digital-clock |
189 | |
325 | |
190 | Displays a digital clock using the built-in overlay. |
326 | Displays a digital clock using the built-in overlay. |
191 | |
327 | |
192 | =item example-refresh-hooks |
328 | =item remote-clipboard |
193 | |
329 | |
194 | Displays a very simple digital clock in the upper right corner of the |
330 | Somewhat of a misnomer, this extension adds two menu entries to the |
195 | window. Illustrates overwriting the refresh callbacks to create your own |
331 | selection popup that allows one ti run external commands to store the |
196 | overlays or changes. |
332 | selection somewhere and fetch it again. |
|
|
333 | |
|
|
334 | We use it to implement a "distributed selection mechanism", which just |
|
|
335 | means that one command uploads the file to a remote server, and another |
|
|
336 | reads it. |
|
|
337 | |
|
|
338 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
339 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
340 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
341 | the selection data on STDOUT (also in UTF-8). |
|
|
342 | |
|
|
343 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
344 | |
|
|
345 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
346 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
197 | |
347 | |
198 | =item selection-pastebin |
348 | =item selection-pastebin |
199 | |
349 | |
200 | This is a little rarely useful extension that Uploads the selection as |
350 | This is a little rarely useful extension that Uploads the selection as |
201 | textfile to a remote site (or does other things). (The implementation is |
351 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
221 | After a successful upload the selection will be replaced by the text given |
371 | After a successful upload the selection will be replaced by the text given |
222 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
372 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
223 | for the filename): |
373 | for the filename): |
224 | |
374 | |
225 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
375 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
376 | |
|
|
377 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
378 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
379 | which works regardless of wether xrdb is used to parse the resource file |
|
|
380 | or not. |
|
|
381 | |
|
|
382 | =item example-refresh-hooks |
|
|
383 | |
|
|
384 | Displays a very simple digital clock in the upper right corner of the |
|
|
385 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
386 | overlays or changes. |
226 | |
387 | |
227 | =back |
388 | =back |
228 | |
389 | |
229 | =head1 API DOCUMENTATION |
390 | =head1 API DOCUMENTATION |
230 | |
391 | |
… | |
… | |
264 | |
425 | |
265 | =back |
426 | =back |
266 | |
427 | |
267 | =head2 Extension Objects |
428 | =head2 Extension Objects |
268 | |
429 | |
269 | Very perl extension is a perl class. A separate perl object is created |
430 | Every perl extension is a perl class. A separate perl object is created |
270 | for each terminal and each extension and passed as the first parameter to |
431 | for each terminal, and each terminal has its own set of extenion objects, |
271 | hooks. So extensions can use their C<$self> object without having to think |
432 | which are passed as the first parameter to hooks. So extensions can use |
272 | about other extensions, with the exception of methods and members that |
433 | their C<$self> object without having to think about clashes with other |
|
|
434 | extensions or other terminals, with the exception of methods and members |
273 | begin with an underscore character C<_>: these are reserved for internal |
435 | that begin with an underscore character C<_>: these are reserved for |
274 | use. |
436 | internal use. |
275 | |
437 | |
276 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
438 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
277 | C<urxvt::term> class on this object. |
439 | C<urxvt::term> class on this object. |
278 | |
440 | |
279 | It has the following methods and data members: |
441 | It has the following methods and data members: |
… | |
… | |
300 | =head2 Hooks |
462 | =head2 Hooks |
301 | |
463 | |
302 | The following subroutines can be declared in extension files, and will be |
464 | The following subroutines can be declared in extension files, and will be |
303 | called whenever the relevant event happens. |
465 | called whenever the relevant event happens. |
304 | |
466 | |
305 | The first argument passed to them is an extension oject as described in |
467 | The first argument passed to them is an extension object as described in |
306 | the in the C<Extension Objects> section. |
468 | the in the C<Extension Objects> section. |
307 | |
469 | |
308 | B<All> of these hooks must return a boolean value. If any of the called |
470 | B<All> of these hooks must return a boolean value. If any of the called |
309 | hooks returns true, then the event counts as being I<consumed>, and the |
471 | hooks returns true, then the event counts as being I<consumed>, and the |
310 | relevant action might not be carried out by the C++ code. |
472 | relevant action might not be carried out by the C++ code. |
… | |
… | |
323 | place. |
485 | place. |
324 | |
486 | |
325 | =item on_start $term |
487 | =item on_start $term |
326 | |
488 | |
327 | Called at the very end of initialisation of a new terminal, just before |
489 | Called at the very end of initialisation of a new terminal, just before |
328 | trying to map (display) the toplevel and returning to the mainloop. |
490 | trying to map (display) the toplevel and returning to the main loop. |
329 | |
491 | |
330 | =item on_destroy $term |
492 | =item on_destroy $term |
331 | |
493 | |
332 | Called whenever something tries to destroy terminal, before doing anything |
494 | Called whenever something tries to destroy terminal, when the terminal is |
333 | yet. If this hook returns true, then destruction is skipped, but this is |
495 | still fully functional (not for long, though). |
334 | rarely a good idea. |
|
|
335 | |
496 | |
336 | =item on_reset $term |
497 | =item on_reset $term |
337 | |
498 | |
338 | Called after the screen is "reset" for any reason, such as resizing or |
499 | Called after the screen is "reset" for any reason, such as resizing or |
339 | control sequences. Here is where you can react on changes to size-related |
500 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
361 | |
522 | |
362 | Called whenever a selection has been copied, but before the selection is |
523 | Called whenever a selection has been copied, but before the selection is |
363 | requested from the server. The selection text can be queried and changed |
524 | requested from the server. The selection text can be queried and changed |
364 | by calling C<< $term->selection >>. |
525 | by calling C<< $term->selection >>. |
365 | |
526 | |
366 | Returning a true value aborts selection grabbing. It will still be hilighted. |
527 | Returning a true value aborts selection grabbing. It will still be highlighted. |
367 | |
528 | |
368 | =item on_sel_extend $term |
529 | =item on_sel_extend $term |
369 | |
530 | |
370 | Called whenever the user tries to extend the selection (e.g. with a double |
531 | Called whenever the user tries to extend the selection (e.g. with a double |
371 | click) and is either supposed to return false (normal operation), or |
532 | click) and is either supposed to return false (normal operation), or |
372 | should extend the selection itelf and return true to suppress the built-in |
533 | should extend the selection itself and return true to suppress the built-in |
373 | processing. This can happen multiple times, as long as the callback |
534 | processing. This can happen multiple times, as long as the callback |
374 | returns true, it will be called on every further click by the user and is |
535 | returns true, it will be called on every further click by the user and is |
375 | supposed to enlarge the selection more and more, if possible. |
536 | supposed to enlarge the selection more and more, if possible. |
376 | |
537 | |
377 | See the F<selection> example extension. |
538 | See the F<selection> example extension. |
378 | |
539 | |
379 | =item on_view_change $term, $offset |
540 | =item on_view_change $term, $offset |
380 | |
541 | |
381 | Called whenever the view offset changes, i..e the user or program |
542 | Called whenever the view offset changes, i.e. the user or program |
382 | scrolls. Offset C<0> means display the normal terminal, positive values |
543 | scrolls. Offset C<0> means display the normal terminal, positive values |
383 | show this many lines of scrollback. |
544 | show this many lines of scrollback. |
384 | |
545 | |
385 | =item on_scroll_back $term, $lines, $saved |
546 | =item on_scroll_back $term, $lines, $saved |
386 | |
547 | |
… | |
… | |
390 | |
551 | |
391 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
552 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
392 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
553 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
393 | number of lines that will be in the scrollback buffer. |
554 | number of lines that will be in the scrollback buffer. |
394 | |
555 | |
|
|
556 | =item on_osc_seq $term, $op, $args |
|
|
557 | |
|
|
558 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
559 | behaviour. The default should be to return an empty list. A true value |
|
|
560 | suppresses execution of the request completely. Make sure you don't get |
|
|
561 | confused by recursive invocations when you output an osc sequence within |
|
|
562 | this callback. |
|
|
563 | |
|
|
564 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
565 | |
395 | =item on_osc_seq $term, $string |
566 | =item on_osc_seq_perl $term, $string |
396 | |
567 | |
397 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
568 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
398 | operating system command) is processed. Cursor position and other state |
569 | operating system command) is processed. Cursor position and other state |
399 | information is up-to-date when this happens. For interoperability, the |
570 | information is up-to-date when this happens. For interoperability, the |
400 | string should start with the extension name and a colon, to distinguish |
571 | string should start with the extension name and a colon, to distinguish |
401 | it from commands for other extensions, and this might be enforced in the |
572 | it from commands for other extensions, and this might be enforced in the |
402 | future. |
573 | future. |
403 | |
574 | |
404 | Be careful not ever to trust (in a security sense) the data you receive, |
575 | Be careful not ever to trust (in a security sense) the data you receive, |
405 | as its source can not easily be controleld (e-mail content, messages from |
576 | as its source can not easily be controlled (e-mail content, messages from |
406 | other users on the same system etc.). |
577 | other users on the same system etc.). |
407 | |
578 | |
408 | =item on_add_lines $term, $string |
579 | =item on_add_lines $term, $string |
409 | |
580 | |
410 | Called whenever text is about to be output, with the text as argument. You |
581 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
441 | |
612 | |
442 | =item on_refresh_end $term |
613 | =item on_refresh_end $term |
443 | |
614 | |
444 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
615 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
445 | |
616 | |
446 | =item on_keyboard_command $term, $string |
617 | =item on_user_command $term, $string |
447 | |
618 | |
448 | Called whenever the user presses a key combination that has a |
619 | Called whenever a user-configured event is being activated (e.g. via |
449 | C<perl:string> action bound to it (see description of the B<keysym> |
620 | a C<perl:string> action bound to a key, see description of the B<keysym> |
450 | resource in the @@RXVT_NAME@@(1) manpage). |
621 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
622 | |
|
|
623 | The event is simply the action string. This interface is assumed to change |
|
|
624 | slightly in the future. |
|
|
625 | |
|
|
626 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
627 | |
|
|
628 | Called just after the new window size has been calculated, but before |
|
|
629 | windows are actually being resized or hints are being set. If this hook |
|
|
630 | returns TRUE, setting of the window hints is being skipped. |
451 | |
631 | |
452 | =item on_x_event $term, $event |
632 | =item on_x_event $term, $event |
453 | |
633 | |
454 | Called on every X event received on the vt window (and possibly other |
634 | Called on every X event received on the vt window (and possibly other |
455 | windows). Should only be used as a last resort. Most event structure |
635 | windows). Should only be used as a last resort. Most event structure |
456 | members are not passed. |
636 | members are not passed. |
457 | |
637 | |
|
|
638 | =item on_root_event $term, $event |
|
|
639 | |
|
|
640 | Like C<on_x_event>, but is called for events on the root window. |
|
|
641 | |
458 | =item on_focus_in $term |
642 | =item on_focus_in $term |
459 | |
643 | |
460 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
644 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
461 | does focus in processing. |
645 | does focus in processing. |
462 | |
646 | |
463 | =item on_focus_out $term |
647 | =item on_focus_out $term |
464 | |
648 | |
465 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
649 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
466 | focus out processing. |
650 | focus out processing. |
467 | |
651 | |
468 | =item on_configure_notify $term, $event |
652 | =item on_configure_notify $term, $event |
|
|
653 | |
|
|
654 | =item on_property_notify $term, $event |
469 | |
655 | |
470 | =item on_key_press $term, $event, $keysym, $octets |
656 | =item on_key_press $term, $event, $keysym, $octets |
471 | |
657 | |
472 | =item on_key_release $term, $event, $keysym |
658 | =item on_key_release $term, $event, $keysym |
473 | |
659 | |
… | |
… | |
483 | |
669 | |
484 | Called whenever the corresponding X event is received for the terminal If |
670 | Called whenever the corresponding X event is received for the terminal If |
485 | the hook returns true, then the even will be ignored by rxvt-unicode. |
671 | the hook returns true, then the even will be ignored by rxvt-unicode. |
486 | |
672 | |
487 | The event is a hash with most values as named by Xlib (see the XEvent |
673 | The event is a hash with most values as named by Xlib (see the XEvent |
488 | manpage), with the additional members C<row> and C<col>, which are the row |
674 | manpage), with the additional members C<row> and C<col>, which are the |
489 | and column under the mouse cursor. |
675 | (real, not screen-based) row and column under the mouse cursor. |
490 | |
676 | |
491 | C<on_key_press> additionally receives the string rxvt-unicode would |
677 | C<on_key_press> additionally receives the string rxvt-unicode would |
492 | output, if any, in locale-specific encoding. |
678 | output, if any, in locale-specific encoding. |
493 | |
679 | |
494 | subwindow. |
680 | subwindow. |
… | |
… | |
525 | our $LIBDIR; |
711 | our $LIBDIR; |
526 | our $RESNAME; |
712 | our $RESNAME; |
527 | our $RESCLASS; |
713 | our $RESCLASS; |
528 | our $RXVTNAME; |
714 | our $RXVTNAME; |
529 | |
715 | |
|
|
716 | our $NOCHAR = chr 0xffff; |
|
|
717 | |
530 | =head2 Variables in the C<urxvt> Package |
718 | =head2 Variables in the C<urxvt> Package |
531 | |
719 | |
532 | =over 4 |
720 | =over 4 |
533 | |
721 | |
534 | =item $urxvt::LIBDIR |
722 | =item $urxvt::LIBDIR |
… | |
… | |
549 | The current terminal. This variable stores the current C<urxvt::term> |
737 | The current terminal. This variable stores the current C<urxvt::term> |
550 | object, whenever a callback/hook is executing. |
738 | object, whenever a callback/hook is executing. |
551 | |
739 | |
552 | =item @urxvt::TERM_INIT |
740 | =item @urxvt::TERM_INIT |
553 | |
741 | |
554 | All coderefs in this array will be called as methods of the next newly |
742 | All code references in this array will be called as methods of the next newly |
555 | created C<urxvt::term> object (during the C<on_init> phase). The array |
743 | created C<urxvt::term> object (during the C<on_init> phase). The array |
556 | gets cleared before the codereferences that were in it are being executed, |
744 | gets cleared before the code references that were in it are being executed, |
557 | so coderefs can push themselves onto it again if they so desire. |
745 | so references can push themselves onto it again if they so desire. |
558 | |
746 | |
559 | This complements to the perl-eval commandline option, but gets executed |
747 | This complements to the perl-eval command line option, but gets executed |
560 | first. |
748 | first. |
561 | |
749 | |
562 | =item @urxvt::TERM_EXT |
750 | =item @urxvt::TERM_EXT |
563 | |
751 | |
564 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
752 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
585 | |
773 | |
586 | Using this function has the advantage that its output ends up in the |
774 | Using this function has the advantage that its output ends up in the |
587 | correct place, e.g. on stderr of the connecting urxvtc client. |
775 | correct place, e.g. on stderr of the connecting urxvtc client. |
588 | |
776 | |
589 | Messages have a size limit of 1023 bytes currently. |
777 | Messages have a size limit of 1023 bytes currently. |
|
|
778 | |
|
|
779 | =item @terms = urxvt::termlist |
|
|
780 | |
|
|
781 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
782 | whether they are started, being destroyed etc., so be careful. Only term |
|
|
783 | objects that have perl extensions attached will be returned (because there |
|
|
784 | is no urxvt::term objet associated with others). |
590 | |
785 | |
591 | =item $time = urxvt::NOW |
786 | =item $time = urxvt::NOW |
592 | |
787 | |
593 | Returns the "current time" (as per the event loop). |
788 | Returns the "current time" (as per the event loop). |
594 | |
789 | |
… | |
… | |
652 | Return the foreground/background colour index, respectively. |
847 | Return the foreground/background colour index, respectively. |
653 | |
848 | |
654 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
849 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
655 | |
850 | |
656 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
851 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
852 | |
|
|
853 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
657 | |
854 | |
658 | Replace the foreground/background colour in the rendition mask with the |
855 | Replace the foreground/background colour in the rendition mask with the |
659 | specified one. |
856 | specified one. |
660 | |
857 | |
661 | =item $value = urxvt::GET_CUSTOM $rend |
858 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
680 | unless $msg =~ /\n$/; |
877 | unless $msg =~ /\n$/; |
681 | urxvt::warn ($msg); |
878 | urxvt::warn ($msg); |
682 | }; |
879 | }; |
683 | } |
880 | } |
684 | |
881 | |
|
|
882 | no warnings 'utf8'; |
|
|
883 | |
685 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
884 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
686 | |
885 | |
687 | sub verbose { |
886 | sub verbose { |
688 | my ($level, $msg) = @_; |
887 | my ($level, $msg) = @_; |
689 | warn "$msg\n" if $level <= $verbosity; |
888 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
705 | |
904 | |
706 | open my $fh, "<:raw", $path |
905 | open my $fh, "<:raw", $path |
707 | or die "$path: $!"; |
906 | or die "$path: $!"; |
708 | |
907 | |
709 | my $source = |
908 | my $source = |
710 | "package $pkg; use strict; use utf8;\n" |
909 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
711 | . "#line 1 \"$path\"\n{\n" |
910 | . "#line 1 \"$path\"\n{\n" |
712 | . (do { local $/; <$fh> }) |
911 | . (do { local $/; <$fh> }) |
713 | . "\n};\n1"; |
912 | . "\n};\n1"; |
714 | |
913 | |
715 | eval $source |
914 | eval $source |
… | |
… | |
740 | $TERM->register_package ($_) for @pkg; |
939 | $TERM->register_package ($_) for @pkg; |
741 | } |
940 | } |
742 | |
941 | |
743 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
942 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
744 | if ($_ eq "default") { |
943 | if ($_ eq "default") { |
745 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
944 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
746 | } elsif (/^-(.*)$/) { |
945 | } elsif (/^-(.*)$/) { |
747 | delete $ext_arg{$1}; |
946 | delete $ext_arg{$1}; |
748 | } elsif (/^([^<]+)<(.*)>$/) { |
947 | } elsif (/^([^<]+)<(.*)>$/) { |
749 | push @{ $ext_arg{$1} }, $2; |
948 | push @{ $ext_arg{$1} }, $2; |
750 | } else { |
949 | } else { |
751 | $ext_arg{$_} ||= []; |
950 | $ext_arg{$_} ||= []; |
752 | } |
951 | } |
753 | } |
952 | } |
754 | |
953 | |
755 | while (my ($ext, $argv) = each %ext_arg) { |
954 | for my $ext (sort keys %ext_arg) { |
756 | my @files = grep -f $_, map "$_/$ext", @dirs; |
955 | my @files = grep -f $_, map "$_/$ext", @dirs; |
757 | |
956 | |
758 | if (@files) { |
957 | if (@files) { |
759 | $TERM->register_package (extension_package $files[0], $argv); |
958 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
760 | } else { |
959 | } else { |
761 | warn "perl extension '$ext' not found in perl library search path\n"; |
960 | warn "perl extension '$ext' not found in perl library search path\n"; |
762 | } |
961 | } |
763 | } |
962 | } |
764 | |
963 | |
… | |
… | |
770 | |
969 | |
771 | if (my $cb = $TERM->{_hook}[$htype]) { |
970 | if (my $cb = $TERM->{_hook}[$htype]) { |
772 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
971 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
773 | if $verbosity >= 10; |
972 | if $verbosity >= 10; |
774 | |
973 | |
775 | keys %$cb; |
974 | for my $pkg (keys %$cb) { |
776 | |
|
|
777 | while (my ($pkg, $cb) = each %$cb) { |
|
|
778 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
975 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
779 | $retval ||= $retval_; |
976 | $retval ||= $retval_; |
780 | |
977 | |
781 | if ($@) { |
978 | if ($@) { |
782 | $TERM->ungrab; # better to lose the grab than the session |
979 | $TERM->ungrab; # better to lose the grab than the session |
783 | warn $@; |
980 | warn $@; |
… | |
… | |
795 | # clear package |
992 | # clear package |
796 | %$TERM = (); |
993 | %$TERM = (); |
797 | } |
994 | } |
798 | |
995 | |
799 | $retval |
996 | $retval |
|
|
997 | } |
|
|
998 | |
|
|
999 | sub SET_COLOR($$$) { |
|
|
1000 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
1001 | } |
|
|
1002 | |
|
|
1003 | sub rend2mask { |
|
|
1004 | no strict 'refs'; |
|
|
1005 | my ($str, $mask) = (@_, 0); |
|
|
1006 | my %color = ( fg => undef, bg => undef ); |
|
|
1007 | my @failed; |
|
|
1008 | for my $spec ( split /\s+/, $str ) { |
|
|
1009 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1010 | $color{lc($1)} = $2; |
|
|
1011 | } else { |
|
|
1012 | my $neg = $spec =~ s/^[-^]//; |
|
|
1013 | unless ( exists &{"RS_$spec"} ) { |
|
|
1014 | push @failed, $spec; |
|
|
1015 | next; |
|
|
1016 | } |
|
|
1017 | my $cur = &{"RS_$spec"}; |
|
|
1018 | if ( $neg ) { |
|
|
1019 | $mask &= ~$cur; |
|
|
1020 | } else { |
|
|
1021 | $mask |= $cur; |
|
|
1022 | } |
|
|
1023 | } |
|
|
1024 | } |
|
|
1025 | ($mask, @color{qw(fg bg)}, \@failed) |
800 | } |
1026 | } |
801 | |
1027 | |
802 | # urxvt::term::extension |
1028 | # urxvt::term::extension |
803 | |
1029 | |
804 | package urxvt::term::extension; |
1030 | package urxvt::term::extension; |
… | |
… | |
917 | sub DESTROY { |
1143 | sub DESTROY { |
918 | $_[0][1]->stop; |
1144 | $_[0][1]->stop; |
919 | } |
1145 | } |
920 | |
1146 | |
921 | sub condvar { |
1147 | sub condvar { |
922 | bless \my $flag, urxvt::anyevent::condvar:: |
1148 | bless \my $flag, urxvt::anyevent:: |
923 | } |
1149 | } |
924 | |
1150 | |
925 | sub urxvt::anyevent::condvar::broadcast { |
1151 | sub broadcast { |
926 | ${$_[0]}++; |
1152 | ${$_[0]}++; |
927 | } |
1153 | } |
928 | |
1154 | |
929 | sub urxvt::anyevent::condvar::wait { |
1155 | sub wait { |
930 | unless (${$_[0]}) { |
1156 | unless (${$_[0]}) { |
931 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1157 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
932 | } |
1158 | } |
|
|
1159 | } |
|
|
1160 | |
|
|
1161 | sub one_event { |
|
|
1162 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
933 | } |
1163 | } |
934 | |
1164 | |
935 | package urxvt::term; |
1165 | package urxvt::term; |
936 | |
1166 | |
937 | =head2 The C<urxvt::term> Class |
1167 | =head2 The C<urxvt::term> Class |
… | |
… | |
973 | hash which defines the environment of the new terminal. |
1203 | hash which defines the environment of the new terminal. |
974 | |
1204 | |
975 | Croaks (and probably outputs an error message) if the new instance |
1205 | Croaks (and probably outputs an error message) if the new instance |
976 | couldn't be created. Returns C<undef> if the new instance didn't |
1206 | couldn't be created. Returns C<undef> if the new instance didn't |
977 | initialise perl, and the terminal object otherwise. The C<init> and |
1207 | initialise perl, and the terminal object otherwise. The C<init> and |
978 | C<start> hooks will be called during this call. |
1208 | C<start> hooks will be called before this call returns, and are free to |
|
|
1209 | refer to global data (which is race free). |
979 | |
1210 | |
980 | =cut |
1211 | =cut |
981 | |
1212 | |
982 | sub new { |
1213 | sub new { |
983 | my ($class, $env, @args) = @_; |
1214 | my ($class, $env, @args) = @_; |
984 | |
1215 | |
|
|
1216 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1217 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1218 | |
985 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1219 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
986 | } |
1220 | } |
987 | |
1221 | |
988 | =item $term->destroy |
1222 | =item $term->destroy |
989 | |
1223 | |
990 | Destroy the terminal object (close the window, free resources |
1224 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1020 | |
1254 | |
1021 | Returns true if the option specified by C<$optval> is enabled, and |
1255 | Returns true if the option specified by C<$optval> is enabled, and |
1022 | optionally change it. All option values are stored by name in the hash |
1256 | optionally change it. All option values are stored by name in the hash |
1023 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1257 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1024 | |
1258 | |
1025 | Here is a a likely non-exhaustive list of option names, please see the |
1259 | Here is a likely non-exhaustive list of option names, please see the |
1026 | source file F</src/optinc.h> to see the actual list: |
1260 | source file F</src/optinc.h> to see the actual list: |
1027 | |
1261 | |
1028 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1262 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1029 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1263 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1030 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1264 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1047 | likely change). |
1281 | likely change). |
1048 | |
1282 | |
1049 | Please note that resource strings will currently only be freed when the |
1283 | Please note that resource strings will currently only be freed when the |
1050 | terminal is destroyed, so changing options frequently will eat memory. |
1284 | terminal is destroyed, so changing options frequently will eat memory. |
1051 | |
1285 | |
1052 | Here is a a likely non-exhaustive list of resource names, not all of which |
1286 | Here is a likely non-exhaustive list of resource names, not all of which |
1053 | are supported in every build, please see the source file F</src/rsinc.h> |
1287 | are supported in every build, please see the source file F</src/rsinc.h> |
1054 | to see the actual list: |
1288 | to see the actual list: |
1055 | |
1289 | |
1056 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1290 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1057 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1291 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1247 | |
1481 | |
1248 | Normally its not a good idea to use this function, as programs might be |
1482 | Normally its not a good idea to use this function, as programs might be |
1249 | confused by changes in cursor position or scrolling. Its useful inside a |
1483 | confused by changes in cursor position or scrolling. Its useful inside a |
1250 | C<on_add_lines> hook, though. |
1484 | C<on_add_lines> hook, though. |
1251 | |
1485 | |
|
|
1486 | =item $term->scr_change_screen ($screen) |
|
|
1487 | |
|
|
1488 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1489 | |
1252 | =item $term->cmd_parse ($octets) |
1490 | =item $term->cmd_parse ($octets) |
1253 | |
1491 | |
1254 | Similar to C<scr_add_lines>, but the argument must be in the |
1492 | Similar to C<scr_add_lines>, but the argument must be in the |
1255 | locale-specific encoding of the terminal and can contain command sequences |
1493 | locale-specific encoding of the terminal and can contain command sequences |
1256 | (escape codes) that will be interpreted. |
1494 | (escape codes) that will be interpreted. |
… | |
… | |
1266 | Replaces the event mask of the pty watcher by the given event mask. Can |
1504 | Replaces the event mask of the pty watcher by the given event mask. Can |
1267 | be used to suppress input and output handling to the pty/tty. See the |
1505 | be used to suppress input and output handling to the pty/tty. See the |
1268 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1506 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1269 | the previous value. |
1507 | the previous value. |
1270 | |
1508 | |
|
|
1509 | =item $fd = $term->pty_fd |
|
|
1510 | |
|
|
1511 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1512 | is used. |
|
|
1513 | |
1271 | =item $windowid = $term->parent |
1514 | =item $windowid = $term->parent |
1272 | |
1515 | |
1273 | Return the window id of the toplevel window. |
1516 | Return the window id of the toplevel window. |
1274 | |
1517 | |
1275 | =item $windowid = $term->vt |
1518 | =item $windowid = $term->vt |
… | |
… | |
1281 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1524 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1282 | to receive pointer events all the times: |
1525 | to receive pointer events all the times: |
1283 | |
1526 | |
1284 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1527 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1285 | |
1528 | |
|
|
1529 | =item $term->focus_in |
|
|
1530 | |
|
|
1531 | =item $term->focus_out |
|
|
1532 | |
|
|
1533 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1534 | |
|
|
1535 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1536 | |
|
|
1537 | Deliver various fake events to to terminal. |
|
|
1538 | |
1286 | =item $window_width = $term->width |
1539 | =item $window_width = $term->width |
1287 | |
1540 | |
1288 | =item $window_height = $term->height |
1541 | =item $window_height = $term->height |
1289 | |
1542 | |
1290 | =item $font_width = $term->fwidth |
1543 | =item $font_width = $term->fwidth |
… | |
… | |
1320 | =item $env = $term->env |
1573 | =item $env = $term->env |
1321 | |
1574 | |
1322 | Returns a copy of the environment in effect for the terminal as a hashref |
1575 | Returns a copy of the environment in effect for the terminal as a hashref |
1323 | similar to C<\%ENV>. |
1576 | similar to C<\%ENV>. |
1324 | |
1577 | |
|
|
1578 | =item @envv = $term->envv |
|
|
1579 | |
|
|
1580 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1581 | |
|
|
1582 | =item @argv = $term->argv |
|
|
1583 | |
|
|
1584 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1585 | includes the program name as first element. |
|
|
1586 | |
1325 | =cut |
1587 | =cut |
1326 | |
1588 | |
1327 | sub env { |
1589 | sub env { |
1328 | if (my $env = $_[0]->_env) { |
|
|
1329 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1590 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1330 | } else { |
|
|
1331 | +{ %ENV } |
|
|
1332 | } |
|
|
1333 | } |
1591 | } |
1334 | |
1592 | |
1335 | =item $modifiermask = $term->ModLevel3Mask |
1593 | =item $modifiermask = $term->ModLevel3Mask |
1336 | |
1594 | |
1337 | =item $modifiermask = $term->ModMetaMask |
1595 | =item $modifiermask = $term->ModMetaMask |
1338 | |
1596 | |
1339 | =item $modifiermask = $term->ModNumLockMask |
1597 | =item $modifiermask = $term->ModNumLockMask |
1340 | |
1598 | |
1341 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1599 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1342 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1600 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1601 | |
|
|
1602 | =item $screen = $term->current_screen |
|
|
1603 | |
|
|
1604 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1605 | |
|
|
1606 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1607 | |
|
|
1608 | Returns whether the cursor is currently hidden or not. |
1343 | |
1609 | |
1344 | =item $view_start = $term->view_start ([$newvalue]) |
1610 | =item $view_start = $term->view_start ([$newvalue]) |
1345 | |
1611 | |
1346 | Returns the row number of the topmost displayed line. Maximum value is |
1612 | Returns the row number of the topmost displayed line. Maximum value is |
1347 | C<0>, which displays the normal terminal contents. Lower values scroll |
1613 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1367 | line, starting at column C<$start_col> (default C<0>), which is useful |
1633 | line, starting at column C<$start_col> (default C<0>), which is useful |
1368 | to replace only parts of a line. The font index in the rendition will |
1634 | to replace only parts of a line. The font index in the rendition will |
1369 | automatically be updated. |
1635 | automatically be updated. |
1370 | |
1636 | |
1371 | C<$text> is in a special encoding: tabs and wide characters that use more |
1637 | C<$text> is in a special encoding: tabs and wide characters that use more |
1372 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1638 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1373 | (C<chr 65535>). Characters with combining characters and other characters |
1639 | characters. Characters with combining characters and other characters that |
1374 | that do not fit into the normal tetx encoding will be replaced with |
1640 | do not fit into the normal tetx encoding will be replaced with characters |
1375 | characters in the private use area. |
1641 | in the private use area. |
1376 | |
1642 | |
1377 | You have to obey this encoding when changing text. The advantage is |
1643 | You have to obey this encoding when changing text. The advantage is |
1378 | that C<substr> and similar functions work on screen cells and not on |
1644 | that C<substr> and similar functions work on screen cells and not on |
1379 | characters. |
1645 | characters. |
1380 | |
1646 | |
… | |
… | |
1524 | where one character corresponds to one screen cell. See |
1790 | where one character corresponds to one screen cell. See |
1525 | C<< $term->ROW_t >> for details. |
1791 | C<< $term->ROW_t >> for details. |
1526 | |
1792 | |
1527 | =item $string = $term->special_decode $text |
1793 | =item $string = $term->special_decode $text |
1528 | |
1794 | |
1529 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1795 | Converts rxvt-unicodes text representation into a perl string. See |
1530 | C<< $term->ROW_t >> for details. |
1796 | C<< $term->ROW_t >> for details. |
1531 | |
1797 | |
1532 | =item $success = $term->grab_button ($button, $modifiermask) |
1798 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1533 | |
1799 | |
|
|
1800 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1801 | |
1534 | Registers a synchronous button grab. See the XGrabButton manpage. |
1802 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1803 | manpage. |
1535 | |
1804 | |
1536 | =item $success = $term->grab ($eventtime[, $sync]) |
1805 | =item $success = $term->grab ($eventtime[, $sync]) |
1537 | |
1806 | |
1538 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1807 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1539 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1808 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1540 | |
1809 | |
1541 | =item $term->allow_events_async |
1810 | =item $term->allow_events_async |
1542 | |
1811 | |
1543 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1812 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1544 | |
1813 | |
… | |
… | |
1554 | =item $term->ungrab |
1823 | =item $term->ungrab |
1555 | |
1824 | |
1556 | Calls XUngrab for the most recent grab. Is called automatically on |
1825 | Calls XUngrab for the most recent grab. Is called automatically on |
1557 | evaluation errors, as it is better to lose the grab in the error case as |
1826 | evaluation errors, as it is better to lose the grab in the error case as |
1558 | the session. |
1827 | the session. |
|
|
1828 | |
|
|
1829 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1830 | |
|
|
1831 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1832 | |
|
|
1833 | =item @atoms = $term->XListProperties ($window) |
|
|
1834 | |
|
|
1835 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1836 | |
|
|
1837 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1838 | |
|
|
1839 | =item $term->XDeleteProperty ($window, $property) |
|
|
1840 | |
|
|
1841 | =item $window = $term->DefaultRootWindow |
|
|
1842 | |
|
|
1843 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1844 | |
|
|
1845 | =item $term->XMapWindow ($window) |
|
|
1846 | |
|
|
1847 | =item $term->XUnmapWindow ($window) |
|
|
1848 | |
|
|
1849 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1850 | |
|
|
1851 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1852 | |
|
|
1853 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1854 | |
|
|
1855 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1856 | the source of the display, otherwise those functions map more-or-less |
|
|
1857 | directory onto the X functions of the same name. |
1559 | |
1858 | |
1560 | =back |
1859 | =back |
1561 | |
1860 | |
1562 | =cut |
1861 | =cut |
1563 | |
1862 | |
… | |
… | |
1627 | my ($self, $text, $cb) = @_; |
1926 | my ($self, $text, $cb) = @_; |
1628 | |
1927 | |
1629 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1928 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1630 | } |
1929 | } |
1631 | |
1930 | |
1632 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1931 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1633 | |
1932 | |
1634 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1933 | Adds a toggle/checkbox item to the popup. The callback gets called |
1635 | whenever it gets toggled, with a boolean indicating its value as its first |
1934 | whenever it gets toggled, with a boolean indicating its new value as its |
1636 | argument. |
1935 | first argument. |
1637 | |
1936 | |
1638 | =cut |
1937 | =cut |
1639 | |
1938 | |
1640 | sub add_toggle { |
1939 | sub add_toggle { |
1641 | my ($self, $text, $cb, $value) = @_; |
1940 | my ($self, $text, $value, $cb) = @_; |
1642 | |
1941 | |
1643 | my $item; $item = { |
1942 | my $item; $item = { |
1644 | type => "button", |
1943 | type => "button", |
1645 | text => " $text", |
1944 | text => " $text", |
1646 | value => $value, |
1945 | value => $value, |
… | |
… | |
1687 | =back |
1986 | =back |
1688 | |
1987 | |
1689 | =cut |
1988 | =cut |
1690 | |
1989 | |
1691 | package urxvt::watcher; |
1990 | package urxvt::watcher; |
1692 | |
|
|
1693 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1694 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1695 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1696 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1697 | |
1991 | |
1698 | =head2 The C<urxvt::timer> Class |
1992 | =head2 The C<urxvt::timer> Class |
1699 | |
1993 | |
1700 | This class implements timer watchers/events. Time is represented as a |
1994 | This class implements timer watchers/events. Time is represented as a |
1701 | fractional number of seconds since the epoch. Example: |
1995 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1781 | Set the callback to be called when io events are triggered. C<$reventmask> |
2075 | Set the callback to be called when io events are triggered. C<$reventmask> |
1782 | is a bitset as described in the C<events> method. |
2076 | is a bitset as described in the C<events> method. |
1783 | |
2077 | |
1784 | =item $iow = $iow->fd ($fd) |
2078 | =item $iow = $iow->fd ($fd) |
1785 | |
2079 | |
1786 | Set the filedescriptor (not handle) to watch. |
2080 | Set the file descriptor (not handle) to watch. |
1787 | |
2081 | |
1788 | =item $iow = $iow->events ($eventmask) |
2082 | =item $iow = $iow->events ($eventmask) |
1789 | |
2083 | |
1790 | Set the event mask to watch. The only allowed values are |
2084 | Set the event mask to watch. The only allowed values are |
1791 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2085 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
… | |
… | |
1795 | |
2089 | |
1796 | Start watching for requested events on the given handle. |
2090 | Start watching for requested events on the given handle. |
1797 | |
2091 | |
1798 | =item $iow = $iow->stop |
2092 | =item $iow = $iow->stop |
1799 | |
2093 | |
1800 | Stop watching for events on the given filehandle. |
2094 | Stop watching for events on the given file handle. |
1801 | |
2095 | |
1802 | =back |
2096 | =back |
1803 | |
2097 | |
1804 | =head2 The C<urxvt::iw> Class |
2098 | =head2 The C<urxvt::iw> Class |
1805 | |
2099 | |
… | |
… | |
1852 | |
2146 | |
1853 | Set the callback to be called when the timer triggers. |
2147 | Set the callback to be called when the timer triggers. |
1854 | |
2148 | |
1855 | =item $pw = $timer->start ($pid) |
2149 | =item $pw = $timer->start ($pid) |
1856 | |
2150 | |
1857 | Tells the wqtcher to start watching for process C<$pid>. |
2151 | Tells the watcher to start watching for process C<$pid>. |
1858 | |
2152 | |
1859 | =item $pw = $pw->stop |
2153 | =item $pw = $pw->stop |
1860 | |
2154 | |
1861 | Stop the watcher. |
2155 | Stop the watcher. |
1862 | |
2156 | |
… | |
… | |
1875 | |
2169 | |
1876 | =item >= 3 - script loading and management |
2170 | =item >= 3 - script loading and management |
1877 | |
2171 | |
1878 | =item >=10 - all called hooks |
2172 | =item >=10 - all called hooks |
1879 | |
2173 | |
1880 | =item >=11 - hook reutrn values |
2174 | =item >=11 - hook return values |
1881 | |
2175 | |
1882 | =back |
2176 | =back |
1883 | |
2177 | |
1884 | =head1 AUTHOR |
2178 | =head1 AUTHOR |
1885 | |
2179 | |
… | |
… | |
1887 | http://software.schmorp.de/pkg/rxvt-unicode |
2181 | http://software.schmorp.de/pkg/rxvt-unicode |
1888 | |
2182 | |
1889 | =cut |
2183 | =cut |
1890 | |
2184 | |
1891 | 1 |
2185 | 1 |
|
|
2186 | |
|
|
2187 | # vim: sw=3: |