… | |
… | |
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 it is true, then the |
470 | B<All> of these hooks must return a boolean value. If any of the called |
309 | event counts as being I<consumed>, and the invocation of other hooks is |
471 | hooks returns true, then the event counts as being I<consumed>, and the |
310 | skipped, and the relevant action might not be carried out by the C++ code. |
472 | relevant action might not be carried out by the C++ code. |
311 | |
473 | |
312 | I<< When in doubt, return a false value (preferably C<()>). >> |
474 | I<< When in doubt, return a false value (preferably C<()>). >> |
313 | |
475 | |
314 | =over 4 |
476 | =over 4 |
315 | |
477 | |
316 | =item on_init $term |
478 | =item on_init $term |
317 | |
479 | |
318 | Called after a new terminal object has been initialized, but before |
480 | Called after a new terminal object has been initialized, but before |
319 | windows are created or the command gets run. Most methods are unsafe to |
481 | windows are created or the command gets run. Most methods are unsafe to |
320 | call or deliver senseless data, as terminal size and other characteristics |
482 | call or deliver senseless data, as terminal size and other characteristics |
321 | have not yet been determined. You can safely query and change resources, |
483 | have not yet been determined. You can safely query and change resources |
322 | though. |
484 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
485 | place. |
|
|
486 | |
|
|
487 | =item on_start $term |
|
|
488 | |
|
|
489 | Called at the very end of initialisation of a new terminal, just before |
|
|
490 | trying to map (display) the toplevel and returning to the main loop. |
|
|
491 | |
|
|
492 | =item on_destroy $term |
|
|
493 | |
|
|
494 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
495 | still fully functional (not for long, though). |
323 | |
496 | |
324 | =item on_reset $term |
497 | =item on_reset $term |
325 | |
498 | |
326 | 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 |
327 | 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 |
328 | variables. |
501 | variables. |
329 | |
502 | |
330 | =item on_start $term |
|
|
331 | |
|
|
332 | Called at the very end of initialisation of a new terminal, just before |
|
|
333 | returning to the mainloop. |
|
|
334 | |
|
|
335 | =item on_child_start $term, $pid |
503 | =item on_child_start $term, $pid |
336 | |
504 | |
337 | Called just after the child process has been C<fork>ed. |
505 | Called just after the child process has been C<fork>ed. |
338 | |
506 | |
339 | =item on_child_exit $term, $status |
507 | =item on_child_exit $term, $status |
… | |
… | |
354 | |
522 | |
355 | 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 |
356 | 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 |
357 | by calling C<< $term->selection >>. |
525 | by calling C<< $term->selection >>. |
358 | |
526 | |
359 | 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. |
360 | |
528 | |
361 | =item on_sel_extend $term |
529 | =item on_sel_extend $term |
362 | |
530 | |
363 | 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 |
364 | click) and is either supposed to return false (normal operation), or |
532 | click) and is either supposed to return false (normal operation), or |
365 | 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 |
366 | processing. This can happen multiple times, as long as the callback |
534 | processing. This can happen multiple times, as long as the callback |
367 | 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 |
368 | supposed to enlarge the selection more and more, if possible. |
536 | supposed to enlarge the selection more and more, if possible. |
369 | |
537 | |
370 | See the F<selection> example extension. |
538 | See the F<selection> example extension. |
371 | |
539 | |
372 | =item on_view_change $term, $offset |
540 | =item on_view_change $term, $offset |
373 | |
541 | |
374 | 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 |
375 | scrolls. Offset C<0> means display the normal terminal, positive values |
543 | scrolls. Offset C<0> means display the normal terminal, positive values |
376 | show this many lines of scrollback. |
544 | show this many lines of scrollback. |
377 | |
545 | |
378 | =item on_scroll_back $term, $lines, $saved |
546 | =item on_scroll_back $term, $lines, $saved |
379 | |
547 | |
… | |
… | |
383 | |
551 | |
384 | 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, |
385 | $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 |
386 | number of lines that will be in the scrollback buffer. |
554 | number of lines that will be in the scrollback buffer. |
387 | |
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 | |
388 | =item on_osc_seq $term, $string |
566 | =item on_osc_seq_perl $term, $string |
389 | |
567 | |
390 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
568 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
391 | operating system command) is processed. Cursor position and other state |
569 | operating system command) is processed. Cursor position and other state |
392 | information is up-to-date when this happens. For interoperability, the |
570 | information is up-to-date when this happens. For interoperability, the |
393 | 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 |
394 | 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 |
395 | future. |
573 | future. |
396 | |
574 | |
397 | 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, |
398 | 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 |
399 | other users on the same system etc.). |
577 | other users on the same system etc.). |
400 | |
578 | |
401 | =item on_add_lines $term, $string |
579 | =item on_add_lines $term, $string |
402 | |
580 | |
403 | 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 |
… | |
… | |
434 | |
612 | |
435 | =item on_refresh_end $term |
613 | =item on_refresh_end $term |
436 | |
614 | |
437 | 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>. |
438 | |
616 | |
439 | =item on_keyboard_command $term, $string |
617 | =item on_user_command $term, $string |
440 | |
618 | |
441 | Called whenever the user presses a key combination that has a |
619 | Called whenever a user-configured event is being activated (e.g. via |
442 | 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> |
443 | 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. |
444 | |
631 | |
445 | =item on_x_event $term, $event |
632 | =item on_x_event $term, $event |
446 | |
633 | |
447 | 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 |
448 | 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 |
449 | members are not passed. |
636 | members are not passed. |
450 | |
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 | |
451 | =item on_focus_in $term |
642 | =item on_focus_in $term |
452 | |
643 | |
453 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
644 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
454 | does focus in processing. |
645 | does focus in processing. |
455 | |
646 | |
456 | =item on_focus_out $term |
647 | =item on_focus_out $term |
457 | |
648 | |
458 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
649 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
459 | focus out processing. |
650 | focus out processing. |
460 | |
651 | |
461 | =item on_configure_notify $term, $event |
652 | =item on_configure_notify $term, $event |
|
|
653 | |
|
|
654 | =item on_property_notify $term, $event |
462 | |
655 | |
463 | =item on_key_press $term, $event, $keysym, $octets |
656 | =item on_key_press $term, $event, $keysym, $octets |
464 | |
657 | |
465 | =item on_key_release $term, $event, $keysym |
658 | =item on_key_release $term, $event, $keysym |
466 | |
659 | |
… | |
… | |
476 | |
669 | |
477 | 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 |
478 | 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. |
479 | |
672 | |
480 | 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 |
481 | 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 |
482 | and column under the mouse cursor. |
675 | (real, not screen-based) row and column under the mouse cursor. |
483 | |
676 | |
484 | C<on_key_press> additionally receives the string rxvt-unicode would |
677 | C<on_key_press> additionally receives the string rxvt-unicode would |
485 | output, if any, in locale-specific encoding. |
678 | output, if any, in locale-specific encoding. |
486 | |
679 | |
487 | subwindow. |
680 | subwindow. |
|
|
681 | |
|
|
682 | =item on_client_message $term, $event |
|
|
683 | |
|
|
684 | =item on_wm_protocols $term, $event |
|
|
685 | |
|
|
686 | =item on_wm_delete_window $term, $event |
|
|
687 | |
|
|
688 | Called when various types of ClientMessage events are received (all with |
|
|
689 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
488 | |
690 | |
489 | =back |
691 | =back |
490 | |
692 | |
491 | =cut |
693 | =cut |
492 | |
694 | |
… | |
… | |
498 | use Scalar::Util (); |
700 | use Scalar::Util (); |
499 | use List::Util (); |
701 | use List::Util (); |
500 | |
702 | |
501 | our $VERSION = 1; |
703 | our $VERSION = 1; |
502 | our $TERM; |
704 | our $TERM; |
|
|
705 | our @TERM_INIT; |
|
|
706 | our @TERM_EXT; |
503 | our @HOOKNAME; |
707 | our @HOOKNAME; |
504 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
708 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
505 | our %OPTION; |
709 | our %OPTION; |
506 | |
710 | |
507 | our $LIBDIR; |
711 | our $LIBDIR; |
508 | our $RESNAME; |
712 | our $RESNAME; |
509 | our $RESCLASS; |
713 | our $RESCLASS; |
510 | our $RXVTNAME; |
714 | our $RXVTNAME; |
511 | |
715 | |
|
|
716 | our $NOCHAR = chr 0xffff; |
|
|
717 | |
512 | =head2 Variables in the C<urxvt> Package |
718 | =head2 Variables in the C<urxvt> Package |
513 | |
719 | |
514 | =over 4 |
720 | =over 4 |
515 | |
721 | |
516 | =item $urxvt::LIBDIR |
722 | =item $urxvt::LIBDIR |
… | |
… | |
528 | |
734 | |
529 | =item $urxvt::TERM |
735 | =item $urxvt::TERM |
530 | |
736 | |
531 | The current terminal. This variable stores the current C<urxvt::term> |
737 | The current terminal. This variable stores the current C<urxvt::term> |
532 | object, whenever a callback/hook is executing. |
738 | object, whenever a callback/hook is executing. |
|
|
739 | |
|
|
740 | =item @urxvt::TERM_INIT |
|
|
741 | |
|
|
742 | All code references in this array will be called as methods of the next newly |
|
|
743 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
744 | gets cleared before the code references that were in it are being executed, |
|
|
745 | so references can push themselves onto it again if they so desire. |
|
|
746 | |
|
|
747 | This complements to the perl-eval command line option, but gets executed |
|
|
748 | first. |
|
|
749 | |
|
|
750 | =item @urxvt::TERM_EXT |
|
|
751 | |
|
|
752 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
753 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
754 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
533 | |
755 | |
534 | =back |
756 | =back |
535 | |
757 | |
536 | =head2 Functions in the C<urxvt> Package |
758 | =head2 Functions in the C<urxvt> Package |
537 | |
759 | |
… | |
… | |
551 | |
773 | |
552 | 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 |
553 | correct place, e.g. on stderr of the connecting urxvtc client. |
775 | correct place, e.g. on stderr of the connecting urxvtc client. |
554 | |
776 | |
555 | 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). |
556 | |
785 | |
557 | =item $time = urxvt::NOW |
786 | =item $time = urxvt::NOW |
558 | |
787 | |
559 | Returns the "current time" (as per the event loop). |
788 | Returns the "current time" (as per the event loop). |
560 | |
789 | |
… | |
… | |
618 | Return the foreground/background colour index, respectively. |
847 | Return the foreground/background colour index, respectively. |
619 | |
848 | |
620 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
849 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
621 | |
850 | |
622 | =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 |
623 | |
854 | |
624 | Replace the foreground/background colour in the rendition mask with the |
855 | Replace the foreground/background colour in the rendition mask with the |
625 | specified one. |
856 | specified one. |
626 | |
857 | |
627 | =item $value = urxvt::GET_CUSTOM $rend |
858 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
646 | unless $msg =~ /\n$/; |
877 | unless $msg =~ /\n$/; |
647 | urxvt::warn ($msg); |
878 | urxvt::warn ($msg); |
648 | }; |
879 | }; |
649 | } |
880 | } |
650 | |
881 | |
|
|
882 | no warnings 'utf8'; |
|
|
883 | |
651 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
884 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
652 | |
885 | |
653 | sub verbose { |
886 | sub verbose { |
654 | my ($level, $msg) = @_; |
887 | my ($level, $msg) = @_; |
655 | warn "$msg\n" if $level <= $verbosity; |
888 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
658 | my %extension_pkg; |
891 | my %extension_pkg; |
659 | |
892 | |
660 | # load a single script into its own package, once only |
893 | # load a single script into its own package, once only |
661 | sub extension_package($) { |
894 | sub extension_package($) { |
662 | my ($path) = @_; |
895 | my ($path) = @_; |
663 | |
|
|
664 | no strict 'refs'; |
|
|
665 | |
896 | |
666 | $extension_pkg{$path} ||= do { |
897 | $extension_pkg{$path} ||= do { |
667 | $path =~ /([^\/\\]+)$/; |
898 | $path =~ /([^\/\\]+)$/; |
668 | my $pkg = $1; |
899 | my $pkg = $1; |
669 | $pkg =~ s/[^[:word:]]/_/g; |
900 | $pkg =~ s/[^[:word:]]/_/g; |
… | |
… | |
672 | verbose 3, "loading extension '$path' into package '$pkg'"; |
903 | verbose 3, "loading extension '$path' into package '$pkg'"; |
673 | |
904 | |
674 | open my $fh, "<:raw", $path |
905 | open my $fh, "<:raw", $path |
675 | or die "$path: $!"; |
906 | or die "$path: $!"; |
676 | |
907 | |
677 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
678 | |
|
|
679 | my $source = |
908 | my $source = |
680 | "package $pkg; use strict; use utf8;\n" |
909 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
681 | . "#line 1 \"$path\"\n{\n" |
910 | . "#line 1 \"$path\"\n{\n" |
682 | . (do { local $/; <$fh> }) |
911 | . (do { local $/; <$fh> }) |
683 | . "\n};\n1"; |
912 | . "\n};\n1"; |
684 | |
913 | |
685 | eval $source |
914 | eval $source |
… | |
… | |
699 | if ($htype == 0) { # INIT |
928 | if ($htype == 0) { # INIT |
700 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
929 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
701 | |
930 | |
702 | my %ext_arg; |
931 | my %ext_arg; |
703 | |
932 | |
|
|
933 | { |
|
|
934 | my @init = @TERM_INIT; |
|
|
935 | @TERM_INIT = (); |
|
|
936 | $_->($TERM) for @init; |
|
|
937 | my @pkg = @TERM_EXT; |
|
|
938 | @TERM_EXT = (); |
|
|
939 | $TERM->register_package ($_) for @pkg; |
|
|
940 | } |
|
|
941 | |
704 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
942 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
705 | if ($_ eq "default") { |
943 | if ($_ eq "default") { |
706 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
944 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
707 | } elsif (/^-(.*)$/) { |
945 | } elsif (/^-(.*)$/) { |
708 | delete $ext_arg{$1}; |
946 | delete $ext_arg{$1}; |
709 | } elsif (/^([^<]+)<(.*)>$/) { |
947 | } elsif (/^([^<]+)<(.*)>$/) { |
710 | push @{ $ext_arg{$1} }, $2; |
948 | push @{ $ext_arg{$1} }, $2; |
711 | } else { |
949 | } else { |
712 | $ext_arg{$_} ||= []; |
950 | $ext_arg{$_} ||= []; |
713 | } |
951 | } |
714 | } |
952 | } |
715 | |
953 | |
716 | while (my ($ext, $argv) = each %ext_arg) { |
954 | for my $ext (sort keys %ext_arg) { |
717 | my @files = grep -f $_, map "$_/$ext", @dirs; |
955 | my @files = grep -f $_, map "$_/$ext", @dirs; |
718 | |
956 | |
719 | if (@files) { |
957 | if (@files) { |
720 | $TERM->register_package (extension_package $files[0], $argv); |
958 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
721 | } else { |
959 | } else { |
722 | 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"; |
723 | } |
961 | } |
724 | } |
962 | } |
725 | |
963 | |
… | |
… | |
731 | |
969 | |
732 | if (my $cb = $TERM->{_hook}[$htype]) { |
970 | if (my $cb = $TERM->{_hook}[$htype]) { |
733 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
971 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
734 | if $verbosity >= 10; |
972 | if $verbosity >= 10; |
735 | |
973 | |
736 | keys %$cb; |
974 | for my $pkg (keys %$cb) { |
737 | |
|
|
738 | while (my ($pkg, $cb) = each %$cb) { |
|
|
739 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
975 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
740 | and last; |
976 | $retval ||= $retval_; |
741 | |
977 | |
742 | if ($@) { |
978 | if ($@) { |
743 | $TERM->ungrab; # better to lose the grab than the session |
979 | $TERM->ungrab; # better to lose the grab than the session |
744 | warn $@; |
980 | warn $@; |
745 | } |
981 | } |
… | |
… | |
756 | # clear package |
992 | # clear package |
757 | %$TERM = (); |
993 | %$TERM = (); |
758 | } |
994 | } |
759 | |
995 | |
760 | $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) |
761 | } |
1026 | } |
762 | |
1027 | |
763 | # urxvt::term::extension |
1028 | # urxvt::term::extension |
764 | |
1029 | |
765 | package urxvt::term::extension; |
1030 | package urxvt::term::extension; |
… | |
… | |
878 | sub DESTROY { |
1143 | sub DESTROY { |
879 | $_[0][1]->stop; |
1144 | $_[0][1]->stop; |
880 | } |
1145 | } |
881 | |
1146 | |
882 | sub condvar { |
1147 | sub condvar { |
883 | bless \my $flag, urxvt::anyevent::condvar:: |
1148 | bless \my $flag, urxvt::anyevent:: |
884 | } |
1149 | } |
885 | |
1150 | |
886 | sub urxvt::anyevent::condvar::broadcast { |
1151 | sub broadcast { |
887 | ${$_[0]}++; |
1152 | ${$_[0]}++; |
888 | } |
1153 | } |
889 | |
1154 | |
890 | sub urxvt::anyevent::condvar::wait { |
1155 | sub wait { |
891 | unless (${$_[0]}) { |
1156 | unless (${$_[0]}) { |
892 | 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"; |
893 | } |
1158 | } |
|
|
1159 | } |
|
|
1160 | |
|
|
1161 | sub one_event { |
|
|
1162 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
894 | } |
1163 | } |
895 | |
1164 | |
896 | package urxvt::term; |
1165 | package urxvt::term; |
897 | |
1166 | |
898 | =head2 The C<urxvt::term> Class |
1167 | =head2 The C<urxvt::term> Class |
… | |
… | |
903 | |
1172 | |
904 | # find on_xxx subs in the package and register them |
1173 | # find on_xxx subs in the package and register them |
905 | # as hooks |
1174 | # as hooks |
906 | sub register_package { |
1175 | sub register_package { |
907 | my ($self, $pkg, $argv) = @_; |
1176 | my ($self, $pkg, $argv) = @_; |
|
|
1177 | |
|
|
1178 | no strict 'refs'; |
|
|
1179 | |
|
|
1180 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
1181 | |
|
|
1182 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
908 | |
1183 | |
909 | my $proxy = bless { |
1184 | my $proxy = bless { |
910 | _pkg => $pkg, |
1185 | _pkg => $pkg, |
911 | argv => $argv, |
1186 | argv => $argv, |
912 | }, $pkg; |
1187 | }, $pkg; |
… | |
… | |
928 | hash which defines the environment of the new terminal. |
1203 | hash which defines the environment of the new terminal. |
929 | |
1204 | |
930 | Croaks (and probably outputs an error message) if the new instance |
1205 | Croaks (and probably outputs an error message) if the new instance |
931 | 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 |
932 | initialise perl, and the terminal object otherwise. The C<init> and |
1207 | initialise perl, and the terminal object otherwise. The C<init> and |
933 | 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). |
934 | |
1210 | |
935 | =cut |
1211 | =cut |
936 | |
1212 | |
937 | sub new { |
1213 | sub new { |
938 | my ($class, $env, @args) = @_; |
1214 | my ($class, $env, @args) = @_; |
939 | |
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 | |
940 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1219 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
941 | } |
1220 | } |
942 | |
1221 | |
943 | =item $term->destroy |
1222 | =item $term->destroy |
944 | |
1223 | |
945 | Destroy the terminal object (close the window, free resources |
1224 | Destroy the terminal object (close the window, free resources |
… | |
… | |
975 | |
1254 | |
976 | 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 |
977 | 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 |
978 | 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. |
979 | |
1258 | |
980 | 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 |
981 | source file F</src/optinc.h> to see the actual list: |
1260 | source file F</src/optinc.h> to see the actual list: |
982 | |
1261 | |
983 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1262 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
984 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1263 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
985 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1264 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1002 | likely change). |
1281 | likely change). |
1003 | |
1282 | |
1004 | 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 |
1005 | terminal is destroyed, so changing options frequently will eat memory. |
1284 | terminal is destroyed, so changing options frequently will eat memory. |
1006 | |
1285 | |
1007 | 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 |
1008 | 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> |
1009 | to see the actual list: |
1288 | to see the actual list: |
1010 | |
1289 | |
1011 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1290 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1012 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1291 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1202 | |
1481 | |
1203 | 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 |
1204 | 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 |
1205 | C<on_add_lines> hook, though. |
1484 | C<on_add_lines> hook, though. |
1206 | |
1485 | |
|
|
1486 | =item $term->scr_change_screen ($screen) |
|
|
1487 | |
|
|
1488 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1489 | |
1207 | =item $term->cmd_parse ($octets) |
1490 | =item $term->cmd_parse ($octets) |
1208 | |
1491 | |
1209 | 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 |
1210 | locale-specific encoding of the terminal and can contain command sequences |
1493 | locale-specific encoding of the terminal and can contain command sequences |
1211 | (escape codes) that will be interpreted. |
1494 | (escape codes) that will be interpreted. |
… | |
… | |
1221 | 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 |
1222 | 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 |
1223 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1506 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1224 | the previous value. |
1507 | the previous value. |
1225 | |
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 | |
1226 | =item $windowid = $term->parent |
1514 | =item $windowid = $term->parent |
1227 | |
1515 | |
1228 | Return the window id of the toplevel window. |
1516 | Return the window id of the toplevel window. |
1229 | |
1517 | |
1230 | =item $windowid = $term->vt |
1518 | =item $windowid = $term->vt |
… | |
… | |
1236 | 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 |
1237 | to receive pointer events all the times: |
1525 | to receive pointer events all the times: |
1238 | |
1526 | |
1239 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1527 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1240 | |
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 | |
1241 | =item $window_width = $term->width |
1539 | =item $window_width = $term->width |
1242 | |
1540 | |
1243 | =item $window_height = $term->height |
1541 | =item $window_height = $term->height |
1244 | |
1542 | |
1245 | =item $font_width = $term->fwidth |
1543 | =item $font_width = $term->fwidth |
… | |
… | |
1275 | =item $env = $term->env |
1573 | =item $env = $term->env |
1276 | |
1574 | |
1277 | 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 |
1278 | similar to C<\%ENV>. |
1576 | similar to C<\%ENV>. |
1279 | |
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 | |
1280 | =cut |
1587 | =cut |
1281 | |
1588 | |
1282 | sub env { |
1589 | sub env { |
1283 | if (my $env = $_[0]->_env) { |
|
|
1284 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1590 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1285 | } else { |
|
|
1286 | +{ %ENV } |
|
|
1287 | } |
|
|
1288 | } |
1591 | } |
1289 | |
1592 | |
1290 | =item $modifiermask = $term->ModLevel3Mask |
1593 | =item $modifiermask = $term->ModLevel3Mask |
1291 | |
1594 | |
1292 | =item $modifiermask = $term->ModMetaMask |
1595 | =item $modifiermask = $term->ModMetaMask |
1293 | |
1596 | |
1294 | =item $modifiermask = $term->ModNumLockMask |
1597 | =item $modifiermask = $term->ModNumLockMask |
1295 | |
1598 | |
1296 | 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 |
1297 | 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. |
1298 | |
1609 | |
1299 | =item $view_start = $term->view_start ([$newvalue]) |
1610 | =item $view_start = $term->view_start ([$newvalue]) |
1300 | |
1611 | |
1301 | 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 |
1302 | C<0>, which displays the normal terminal contents. Lower values scroll |
1613 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1322 | 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 |
1323 | 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 |
1324 | automatically be updated. |
1635 | automatically be updated. |
1325 | |
1636 | |
1326 | 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 |
1327 | 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) |
1328 | (C<chr 65535>). Characters with combining characters and other characters |
1639 | characters. Characters with combining characters and other characters that |
1329 | 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 |
1330 | characters in the private use area. |
1641 | in the private use area. |
1331 | |
1642 | |
1332 | 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 |
1333 | 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 |
1334 | characters. |
1645 | characters. |
1335 | |
1646 | |
… | |
… | |
1479 | where one character corresponds to one screen cell. See |
1790 | where one character corresponds to one screen cell. See |
1480 | C<< $term->ROW_t >> for details. |
1791 | C<< $term->ROW_t >> for details. |
1481 | |
1792 | |
1482 | =item $string = $term->special_decode $text |
1793 | =item $string = $term->special_decode $text |
1483 | |
1794 | |
1484 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1795 | Converts rxvt-unicodes text representation into a perl string. See |
1485 | C<< $term->ROW_t >> for details. |
1796 | C<< $term->ROW_t >> for details. |
1486 | |
1797 | |
1487 | =item $success = $term->grab_button ($button, $modifiermask) |
1798 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1488 | |
1799 | |
|
|
1800 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1801 | |
1489 | Registers a synchronous button grab. See the XGrabButton manpage. |
1802 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1803 | manpage. |
1490 | |
1804 | |
1491 | =item $success = $term->grab ($eventtime[, $sync]) |
1805 | =item $success = $term->grab ($eventtime[, $sync]) |
1492 | |
1806 | |
1493 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1807 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1494 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1808 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1495 | |
1809 | |
1496 | =item $term->allow_events_async |
1810 | =item $term->allow_events_async |
1497 | |
1811 | |
1498 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1812 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1499 | |
1813 | |
… | |
… | |
1509 | =item $term->ungrab |
1823 | =item $term->ungrab |
1510 | |
1824 | |
1511 | Calls XUngrab for the most recent grab. Is called automatically on |
1825 | Calls XUngrab for the most recent grab. Is called automatically on |
1512 | 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 |
1513 | 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. |
1514 | |
1858 | |
1515 | =back |
1859 | =back |
1516 | |
1860 | |
1517 | =cut |
1861 | =cut |
1518 | |
1862 | |
… | |
… | |
1582 | my ($self, $text, $cb) = @_; |
1926 | my ($self, $text, $cb) = @_; |
1583 | |
1927 | |
1584 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1928 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1585 | } |
1929 | } |
1586 | |
1930 | |
1587 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1931 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1588 | |
1932 | |
1589 | 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 |
1590 | 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 |
1591 | argument. |
1935 | first argument. |
1592 | |
1936 | |
1593 | =cut |
1937 | =cut |
1594 | |
1938 | |
1595 | sub add_toggle { |
1939 | sub add_toggle { |
1596 | my ($self, $text, $cb, $value) = @_; |
1940 | my ($self, $text, $value, $cb) = @_; |
1597 | |
1941 | |
1598 | my $item; $item = { |
1942 | my $item; $item = { |
1599 | type => "button", |
1943 | type => "button", |
1600 | text => " $text", |
1944 | text => " $text", |
1601 | value => $value, |
1945 | value => $value, |
… | |
… | |
1638 | delete $self->{term}{_destroy}{$self}; |
1982 | delete $self->{term}{_destroy}{$self}; |
1639 | $self->{term}->ungrab; |
1983 | $self->{term}->ungrab; |
1640 | } |
1984 | } |
1641 | |
1985 | |
1642 | =back |
1986 | =back |
|
|
1987 | |
|
|
1988 | =cut |
|
|
1989 | |
|
|
1990 | package urxvt::watcher; |
1643 | |
1991 | |
1644 | =head2 The C<urxvt::timer> Class |
1992 | =head2 The C<urxvt::timer> Class |
1645 | |
1993 | |
1646 | This class implements timer watchers/events. Time is represented as a |
1994 | This class implements timer watchers/events. Time is represented as a |
1647 | fractional number of seconds since the epoch. Example: |
1995 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1727 | 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> |
1728 | is a bitset as described in the C<events> method. |
2076 | is a bitset as described in the C<events> method. |
1729 | |
2077 | |
1730 | =item $iow = $iow->fd ($fd) |
2078 | =item $iow = $iow->fd ($fd) |
1731 | |
2079 | |
1732 | Set the filedescriptor (not handle) to watch. |
2080 | Set the file descriptor (not handle) to watch. |
1733 | |
2081 | |
1734 | =item $iow = $iow->events ($eventmask) |
2082 | =item $iow = $iow->events ($eventmask) |
1735 | |
2083 | |
1736 | Set the event mask to watch. The only allowed values are |
2084 | Set the event mask to watch. The only allowed values are |
1737 | 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 |
… | |
… | |
1741 | |
2089 | |
1742 | Start watching for requested events on the given handle. |
2090 | Start watching for requested events on the given handle. |
1743 | |
2091 | |
1744 | =item $iow = $iow->stop |
2092 | =item $iow = $iow->stop |
1745 | |
2093 | |
1746 | Stop watching for events on the given filehandle. |
2094 | Stop watching for events on the given file handle. |
|
|
2095 | |
|
|
2096 | =back |
|
|
2097 | |
|
|
2098 | =head2 The C<urxvt::iw> Class |
|
|
2099 | |
|
|
2100 | This class implements idle watchers, that get called automatically when |
|
|
2101 | the process is idle. They should return as fast as possible, after doing |
|
|
2102 | some useful work. |
|
|
2103 | |
|
|
2104 | =over 4 |
|
|
2105 | |
|
|
2106 | =item $iw = new urxvt::iw |
|
|
2107 | |
|
|
2108 | Create a new idle watcher object in stopped state. |
|
|
2109 | |
|
|
2110 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
2111 | |
|
|
2112 | Set the callback to be called when the watcher triggers. |
|
|
2113 | |
|
|
2114 | =item $timer = $timer->start |
|
|
2115 | |
|
|
2116 | Start the watcher. |
|
|
2117 | |
|
|
2118 | =item $timer = $timer->stop |
|
|
2119 | |
|
|
2120 | Stop the watcher. |
|
|
2121 | |
|
|
2122 | =back |
|
|
2123 | |
|
|
2124 | =head2 The C<urxvt::pw> Class |
|
|
2125 | |
|
|
2126 | This class implements process watchers. They create an event whenever a |
|
|
2127 | process exits, after which they stop automatically. |
|
|
2128 | |
|
|
2129 | my $pid = fork; |
|
|
2130 | ... |
|
|
2131 | $term->{pw} = urxvt::pw |
|
|
2132 | ->new |
|
|
2133 | ->start ($pid) |
|
|
2134 | ->cb (sub { |
|
|
2135 | my ($pw, $exit_status) = @_; |
|
|
2136 | ... |
|
|
2137 | }); |
|
|
2138 | |
|
|
2139 | =over 4 |
|
|
2140 | |
|
|
2141 | =item $pw = new urxvt::pw |
|
|
2142 | |
|
|
2143 | Create a new process watcher in stopped state. |
|
|
2144 | |
|
|
2145 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
2146 | |
|
|
2147 | Set the callback to be called when the timer triggers. |
|
|
2148 | |
|
|
2149 | =item $pw = $timer->start ($pid) |
|
|
2150 | |
|
|
2151 | Tells the watcher to start watching for process C<$pid>. |
|
|
2152 | |
|
|
2153 | =item $pw = $pw->stop |
|
|
2154 | |
|
|
2155 | Stop the watcher. |
1747 | |
2156 | |
1748 | =back |
2157 | =back |
1749 | |
2158 | |
1750 | =head1 ENVIRONMENT |
2159 | =head1 ENVIRONMENT |
1751 | |
2160 | |
… | |
… | |
1760 | |
2169 | |
1761 | =item >= 3 - script loading and management |
2170 | =item >= 3 - script loading and management |
1762 | |
2171 | |
1763 | =item >=10 - all called hooks |
2172 | =item >=10 - all called hooks |
1764 | |
2173 | |
1765 | =item >=11 - hook reutrn values |
2174 | =item >=11 - hook return values |
1766 | |
2175 | |
1767 | =back |
2176 | =back |
1768 | |
2177 | |
1769 | =head1 AUTHOR |
2178 | =head1 AUTHOR |
1770 | |
2179 | |
… | |
… | |
1772 | http://software.schmorp.de/pkg/rxvt-unicode |
2181 | http://software.schmorp.de/pkg/rxvt-unicode |
1773 | |
2182 | |
1774 | =cut |
2183 | =cut |
1775 | |
2184 | |
1776 | 1 |
2185 | 1 |
|
|
2186 | |
|
|
2187 | # vim: sw=3: |