… | |
… | |
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 | |
… | |
… | |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
35 | |
35 | |
36 | You can activate them like this: |
36 | You can activate them like this: |
37 | |
37 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
38 | @@RXVT_NAME@@ -pe <extensionname> |
|
|
39 | |
|
|
40 | Or by adding them to the resource for extensions loaded by default: |
|
|
41 | |
|
|
42 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
39 | |
43 | |
40 | =over 4 |
44 | =over 4 |
41 | |
45 | |
42 | =item selection (enabled by default) |
46 | =item selection (enabled by default) |
43 | |
47 | |
… | |
… | |
58 | URxvt.selection.pattern-1: perl-regex |
62 | URxvt.selection.pattern-1: perl-regex |
59 | ... |
63 | ... |
60 | |
64 | |
61 | The index number (0, 1...) must not have any holes, and each regex must |
65 | The index number (0, 1...) must not have any holes, and each regex must |
62 | contain at least one pair of capturing parentheses, which will be used for |
66 | contain at least one pair of capturing parentheses, which will be used for |
63 | the match. For example, the followign adds a regex that matches everything |
67 | the match. For example, the following adds a regex that matches everything |
64 | between two vertical bars: |
68 | between two vertical bars: |
65 | |
69 | |
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
71 | |
|
|
72 | Another example: Programs I use often output "absolute path: " at the |
|
|
73 | beginning of a line when they process multiple files. The following |
|
|
74 | pattern matches the filename (note, there is a single space at the very |
|
|
75 | end): |
|
|
76 | |
|
|
77 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
67 | |
78 | |
68 | You can look at the source of the selection extension to see more |
79 | You can look at the source of the selection extension to see more |
69 | interesting uses, such as parsing a line from beginning to end. |
80 | interesting uses, such as parsing a line from beginning to end. |
70 | |
81 | |
71 | This extension also offers following bindable keyboard commands: |
82 | This extension also offers following bindable keyboard commands: |
… | |
… | |
83 | =item option-popup (enabled by default) |
94 | =item option-popup (enabled by default) |
84 | |
95 | |
85 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
86 | runtime. |
97 | runtime. |
87 | |
98 | |
|
|
99 | Other extensions can extend this popup menu by pushing a code reference |
|
|
100 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
101 | popup is being displayed. |
|
|
102 | |
|
|
103 | It's sole argument is the popup menu, which can be modified. It should |
|
|
104 | either return nothing or a string, the initial boolean value and a code |
|
|
105 | reference. The string will be used as button text and the code reference |
|
|
106 | will be called when the toggle changes, with the new boolean value as |
|
|
107 | first argument. |
|
|
108 | |
|
|
109 | The following will add an entry C<myoption> that changes |
|
|
110 | C<$self->{myoption}>: |
|
|
111 | |
|
|
112 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
113 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
114 | }; |
|
|
115 | |
88 | =item selection-popup (enabled by default) |
116 | =item selection-popup (enabled by default) |
89 | |
117 | |
90 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
91 | text into various other formats/action (such as uri unescaping, perl |
119 | text into various other formats/action (such as uri unescaping, perl |
92 | evalution, web-browser starting etc.), depending on content. |
120 | evaluation, web-browser starting etc.), depending on content. |
93 | |
121 | |
94 | Other extensions can extend this popup menu by pushing a code reference onto |
122 | Other extensions can extend this popup menu by pushing a code reference |
95 | C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed. |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
|
|
124 | popup is being displayed. |
96 | |
125 | |
97 | It's sole argument is the popup menu, which can be modified. The selection |
126 | It's sole argument is the popup menu, which can be modified. The selection |
98 | is in C<$_>, which can be used to decide wether to add something or not. |
127 | is in C<$_>, which can be used to decide whether to add something or not. |
99 | It should either return nothing or a string and a code reference. The |
128 | It should either return nothing or a string and a code reference. The |
100 | string will be used as button text and the code reference will be called |
129 | string will be used as button text and the code reference will be called |
101 | when the button gets activated and should transform C<$_>. |
130 | when the button gets activated and should transform C<$_>. |
102 | |
131 | |
103 | The following will add an entry C<a to b> that transforms all C<a>s in |
132 | The following will add an entry C<a to b> that transforms all C<a>s in |
104 | the selection to C<b>s, but only if the selection currently contains any |
133 | the selection to C<b>s, but only if the selection currently contains any |
105 | C<a>s: |
134 | C<a>s: |
106 | |
135 | |
107 | push urxvt::ext::selection_popup::hook, sub { |
136 | push @{ $self->{term}{selection_popup_hook} }, sub { |
108 | /a/ ? ("a to be" => sub { s/a/b/g } |
137 | /a/ ? ("a to be" => sub { s/a/b/g } |
109 | : () |
138 | : () |
110 | }; |
139 | }; |
111 | |
140 | |
112 | =item searchable-scrollback<hotkey> (enabled by default) |
141 | =item searchable-scrollback<hotkey> (enabled by default) |
… | |
… | |
122 | bottom. C<Escape> leaves search mode and returns to the point where search |
151 | bottom. C<Escape> leaves search mode and returns to the point where search |
123 | was started, while C<Enter> or C<Return> stay at the current position and |
152 | was started, while C<Enter> or C<Return> stay at the current position and |
124 | additionally stores the first match in the current line into the primary |
153 | additionally stores the first match in the current line into the primary |
125 | selection. |
154 | selection. |
126 | |
155 | |
|
|
156 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
|
|
157 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
|
|
158 | or simply use an uppercase character which removes the "(?i)" prefix. |
|
|
159 | |
|
|
160 | See L<perlre> for more info about perl regular expression syntax. |
|
|
161 | |
|
|
162 | =item readline (enabled by default) |
|
|
163 | |
|
|
164 | A support package that tries to make editing with readline easier. At |
|
|
165 | the moment, it reacts to clicking shift-left mouse button by trying to |
|
|
166 | move the text cursor to this position. It does so by generating as many |
|
|
167 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
168 | for programs that correctly support wide characters). |
|
|
169 | |
|
|
170 | To avoid too many false positives, this is only done when: |
|
|
171 | |
|
|
172 | =over 4 |
|
|
173 | |
|
|
174 | =item - the tty is in ICANON state. |
|
|
175 | |
|
|
176 | =item - the text cursor is visible. |
|
|
177 | |
|
|
178 | =item - the primary screen is currently being displayed. |
|
|
179 | |
|
|
180 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
181 | |
|
|
182 | =back |
|
|
183 | |
|
|
184 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
185 | might interfere with selection creation in harmless ways. |
|
|
186 | |
127 | =item selection-autotransform |
187 | =item selection-autotransform |
128 | |
188 | |
129 | This selection allows you to do automatic transforms on a selection |
189 | This selection allows you to do automatic transforms on a selection |
130 | whenever a selection is made. |
190 | whenever a selection is made. |
131 | |
191 | |
… | |
… | |
156 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
216 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
157 | |
217 | |
158 | The first line tells the selection code to treat the unchanging part of |
218 | The first line tells the selection code to treat the unchanging part of |
159 | every error message as a selection pattern, and the second line transforms |
219 | every error message as a selection pattern, and the second line transforms |
160 | the message into vi commands to load the file. |
220 | the message into vi commands to load the file. |
|
|
221 | |
|
|
222 | =item tabbed |
|
|
223 | |
|
|
224 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
225 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
|
|
226 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
227 | button per tab. |
|
|
228 | |
|
|
229 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
230 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
231 | while B<Shift-Down> creates a new tab. |
|
|
232 | |
|
|
233 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
234 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
235 | following four resources (shown with defaults): |
|
|
236 | |
|
|
237 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
238 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
239 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
240 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
241 | |
|
|
242 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
243 | indices. |
161 | |
244 | |
162 | =item mark-urls |
245 | =item mark-urls |
163 | |
246 | |
164 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
247 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
165 | make them clickable. When middle-clicked, the program specified in the |
248 | make them clickable. When middle-clicked, the program specified in the |
166 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
249 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
167 | the URL as first argument. |
250 | the URL as first argument. |
168 | |
251 | |
|
|
252 | =item xim-onthespot |
|
|
253 | |
|
|
254 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
255 | not work perfectly, and some input methods don't seem to work well with |
|
|
256 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
257 | kinput2. |
|
|
258 | |
|
|
259 | You enable it by specifying this extension and a preedit style of |
|
|
260 | C<OnTheSpot>, i.e.: |
|
|
261 | |
|
|
262 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
263 | |
|
|
264 | =item kuake<hotkey> |
|
|
265 | |
|
|
266 | A very primitive quake-console-like extension. It was inspired by a |
|
|
267 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
268 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
269 | will show or hide itself. Another press of the accelerator key will hide |
|
|
270 | or show it again. |
|
|
271 | |
|
|
272 | Initially, the window will not be shown when using this extension. |
|
|
273 | |
|
|
274 | This is useful if you need a single terminal thats not using any desktop |
|
|
275 | space most of the time but is quickly available at the press of a key. |
|
|
276 | |
|
|
277 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
278 | extension will actually grab a physical key just for this function. |
|
|
279 | |
|
|
280 | If you want a quake-like animation, tell your window manager to do so |
|
|
281 | (fvwm can do it). |
|
|
282 | |
169 | =item automove-background |
283 | =item automove-background |
170 | |
284 | |
171 | This is basically a one-line extension that dynamically changes the background pixmap offset |
285 | This is basically a very small extension that dynamically changes the |
172 | to the window position, in effect creating the same effect as pseudo transparency with |
286 | background pixmap offset to the window position, in effect creating the |
173 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
287 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
288 | supported in this mode. Example: |
174 | |
289 | |
175 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
290 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
176 | |
291 | |
177 | =item block-graphics-to-ascii |
292 | =item block-graphics-to-ascii |
178 | |
293 | |
179 | A not very useful example of filtering all text output to the terminal, |
294 | A not very useful example of filtering all text output to the terminal |
180 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
295 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
181 | similar-looking ascii character. |
296 | similar-looking ascii character. |
182 | |
297 | |
183 | =item digital-clock |
298 | =item digital-clock |
184 | |
299 | |
185 | Displays a digital clock using the built-in overlay. |
300 | Displays a digital clock using the built-in overlay. |
186 | |
301 | |
187 | =item example-refresh-hooks |
302 | =item remote-clipboard |
188 | |
303 | |
189 | Displays a very simple digital clock in the upper right corner of the |
304 | Somewhat of a misnomer, this extension adds two menu entries to the |
190 | window. Illustrates overwriting the refresh callbacks to create your own |
305 | selection popup that allows one ti run external commands to store the |
191 | overlays or changes. |
306 | selection somewhere and fetch it again. |
|
|
307 | |
|
|
308 | We use it to implement a "distributed selection mechanism", which just |
|
|
309 | means that one command uploads the file to a remote server, and another |
|
|
310 | reads it. |
|
|
311 | |
|
|
312 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
313 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
314 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
315 | the selection data on STDOUT (also in UTF-8). |
|
|
316 | |
|
|
317 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
318 | |
|
|
319 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
320 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
192 | |
321 | |
193 | =item selection-pastebin |
322 | =item selection-pastebin |
194 | |
323 | |
195 | This is a little rarely useful extension that Uploads the selection as |
324 | This is a little rarely useful extension that Uploads the selection as |
196 | textfile to a remote site (or does other things). (The implementation is |
325 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
216 | After a successful upload the selection will be replaced by the text given |
345 | After a successful upload the selection will be replaced by the text given |
217 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
346 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
218 | for the filename): |
347 | for the filename): |
219 | |
348 | |
220 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
349 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
350 | |
|
|
351 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
352 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
353 | which works regardless of wether xrdb is used to parse the resource file |
|
|
354 | or not. |
|
|
355 | |
|
|
356 | =item example-refresh-hooks |
|
|
357 | |
|
|
358 | Displays a very simple digital clock in the upper right corner of the |
|
|
359 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
360 | overlays or changes. |
221 | |
361 | |
222 | =back |
362 | =back |
223 | |
363 | |
224 | =head1 API DOCUMENTATION |
364 | =head1 API DOCUMENTATION |
225 | |
365 | |
… | |
… | |
259 | |
399 | |
260 | =back |
400 | =back |
261 | |
401 | |
262 | =head2 Extension Objects |
402 | =head2 Extension Objects |
263 | |
403 | |
264 | Very perl extension is a perl class. A separate perl object is created |
404 | Every perl extension is a perl class. A separate perl object is created |
265 | for each terminal and each extension and passed as the first parameter to |
405 | for each terminal, and each terminal has its own set of extenion objects, |
266 | hooks. So extensions can use their C<$self> object without having to think |
406 | which are passed as the first parameter to hooks. So extensions can use |
267 | about other extensions, with the exception of methods and members that |
407 | their C<$self> object without having to think about clashes with other |
|
|
408 | extensions or other terminals, with the exception of methods and members |
268 | begin with an underscore character C<_>: these are reserved for internal |
409 | that begin with an underscore character C<_>: these are reserved for |
269 | use. |
410 | internal use. |
270 | |
411 | |
271 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
412 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
272 | C<urxvt::term> class on this object. |
413 | C<urxvt::term> class on this object. |
273 | |
414 | |
274 | It has the following methods and data members: |
415 | It has the following methods and data members: |
… | |
… | |
295 | =head2 Hooks |
436 | =head2 Hooks |
296 | |
437 | |
297 | The following subroutines can be declared in extension files, and will be |
438 | The following subroutines can be declared in extension files, and will be |
298 | called whenever the relevant event happens. |
439 | called whenever the relevant event happens. |
299 | |
440 | |
300 | The first argument passed to them is an extension oject as described in |
441 | The first argument passed to them is an extension object as described in |
301 | the in the C<Extension Objects> section. |
442 | the in the C<Extension Objects> section. |
302 | |
443 | |
303 | B<All> of these hooks must return a boolean value. If it is true, then the |
444 | B<All> of these hooks must return a boolean value. If any of the called |
304 | event counts as being I<consumed>, and the invocation of other hooks is |
445 | hooks returns true, then the event counts as being I<consumed>, and the |
305 | skipped, and the relevant action might not be carried out by the C++ code. |
446 | relevant action might not be carried out by the C++ code. |
306 | |
447 | |
307 | I<< When in doubt, return a false value (preferably C<()>). >> |
448 | I<< When in doubt, return a false value (preferably C<()>). >> |
308 | |
449 | |
309 | =over 4 |
450 | =over 4 |
310 | |
451 | |
311 | =item on_init $term |
452 | =item on_init $term |
312 | |
453 | |
313 | Called after a new terminal object has been initialized, but before |
454 | Called after a new terminal object has been initialized, but before |
314 | windows are created or the command gets run. Most methods are unsafe to |
455 | windows are created or the command gets run. Most methods are unsafe to |
315 | call or deliver senseless data, as terminal size and other characteristics |
456 | call or deliver senseless data, as terminal size and other characteristics |
316 | have not yet been determined. You can safely query and change resources, |
457 | have not yet been determined. You can safely query and change resources |
317 | though. |
458 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
459 | place. |
|
|
460 | |
|
|
461 | =item on_start $term |
|
|
462 | |
|
|
463 | Called at the very end of initialisation of a new terminal, just before |
|
|
464 | trying to map (display) the toplevel and returning to the main loop. |
|
|
465 | |
|
|
466 | =item on_destroy $term |
|
|
467 | |
|
|
468 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
469 | still fully functional (not for long, though). |
318 | |
470 | |
319 | =item on_reset $term |
471 | =item on_reset $term |
320 | |
472 | |
321 | Called after the screen is "reset" for any reason, such as resizing or |
473 | Called after the screen is "reset" for any reason, such as resizing or |
322 | control sequences. Here is where you can react on changes to size-related |
474 | control sequences. Here is where you can react on changes to size-related |
323 | variables. |
475 | variables. |
324 | |
476 | |
325 | =item on_start $term |
|
|
326 | |
|
|
327 | Called at the very end of initialisation of a new terminal, just before |
|
|
328 | returning to the mainloop. |
|
|
329 | |
|
|
330 | =item on_child_start $term, $pid |
477 | =item on_child_start $term, $pid |
331 | |
478 | |
332 | Called just after the child process has been C<fork>ed. |
479 | Called just after the child process has been C<fork>ed. |
333 | |
480 | |
334 | =item on_child_exit $term, $status |
481 | =item on_child_exit $term, $status |
… | |
… | |
349 | |
496 | |
350 | Called whenever a selection has been copied, but before the selection is |
497 | Called whenever a selection has been copied, but before the selection is |
351 | requested from the server. The selection text can be queried and changed |
498 | requested from the server. The selection text can be queried and changed |
352 | by calling C<< $term->selection >>. |
499 | by calling C<< $term->selection >>. |
353 | |
500 | |
354 | Returning a true value aborts selection grabbing. It will still be hilighted. |
501 | Returning a true value aborts selection grabbing. It will still be highlighted. |
355 | |
502 | |
356 | =item on_sel_extend $term |
503 | =item on_sel_extend $term |
357 | |
504 | |
358 | Called whenever the user tries to extend the selection (e.g. with a double |
505 | Called whenever the user tries to extend the selection (e.g. with a double |
359 | click) and is either supposed to return false (normal operation), or |
506 | click) and is either supposed to return false (normal operation), or |
360 | should extend the selection itelf and return true to suppress the built-in |
507 | should extend the selection itself and return true to suppress the built-in |
361 | processing. This can happen multiple times, as long as the callback |
508 | processing. This can happen multiple times, as long as the callback |
362 | returns true, it will be called on every further click by the user and is |
509 | returns true, it will be called on every further click by the user and is |
363 | supposed to enlarge the selection more and more, if possible. |
510 | supposed to enlarge the selection more and more, if possible. |
364 | |
511 | |
365 | See the F<selection> example extension. |
512 | See the F<selection> example extension. |
366 | |
513 | |
367 | =item on_view_change $term, $offset |
514 | =item on_view_change $term, $offset |
368 | |
515 | |
369 | Called whenever the view offset changes, i..e the user or program |
516 | Called whenever the view offset changes, i.e. the user or program |
370 | scrolls. Offset C<0> means display the normal terminal, positive values |
517 | scrolls. Offset C<0> means display the normal terminal, positive values |
371 | show this many lines of scrollback. |
518 | show this many lines of scrollback. |
372 | |
519 | |
373 | =item on_scroll_back $term, $lines, $saved |
520 | =item on_scroll_back $term, $lines, $saved |
374 | |
521 | |
… | |
… | |
378 | |
525 | |
379 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
526 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
380 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
527 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
381 | number of lines that will be in the scrollback buffer. |
528 | number of lines that will be in the scrollback buffer. |
382 | |
529 | |
|
|
530 | =item on_osc_seq $term, $op, $args |
|
|
531 | |
|
|
532 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
533 | behaviour. The default should be to return an empty list. A true value |
|
|
534 | suppresses execution of the request completely. Make sure you don't get |
|
|
535 | confused by recursive invocations when you output an osc sequence within |
|
|
536 | this callback. |
|
|
537 | |
|
|
538 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
539 | |
383 | =item on_osc_seq $term, $string |
540 | =item on_osc_seq_perl $term, $string |
384 | |
541 | |
385 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
542 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
386 | operating system command) is processed. Cursor position and other state |
543 | operating system command) is processed. Cursor position and other state |
387 | information is up-to-date when this happens. For interoperability, the |
544 | information is up-to-date when this happens. For interoperability, the |
388 | string should start with the extension name and a colon, to distinguish |
545 | string should start with the extension name and a colon, to distinguish |
389 | it from commands for other extensions, and this might be enforced in the |
546 | it from commands for other extensions, and this might be enforced in the |
390 | future. |
547 | future. |
391 | |
548 | |
392 | Be careful not ever to trust (in a security sense) the data you receive, |
549 | Be careful not ever to trust (in a security sense) the data you receive, |
393 | as its source can not easily be controleld (e-mail content, messages from |
550 | as its source can not easily be controlled (e-mail content, messages from |
394 | other users on the same system etc.). |
551 | other users on the same system etc.). |
395 | |
552 | |
396 | =item on_add_lines $term, $string |
553 | =item on_add_lines $term, $string |
397 | |
554 | |
398 | Called whenever text is about to be output, with the text as argument. You |
555 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
429 | |
586 | |
430 | =item on_refresh_end $term |
587 | =item on_refresh_end $term |
431 | |
588 | |
432 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
589 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
433 | |
590 | |
434 | =item on_keyboard_command $term, $string |
591 | =item on_user_command $term, $string |
435 | |
592 | |
436 | Called whenever the user presses a key combination that has a |
593 | Called whenever a user-configured event is being activated (e.g. via |
437 | C<perl:string> action bound to it (see description of the B<keysym> |
594 | a C<perl:string> action bound to a key, see description of the B<keysym> |
438 | resource in the @@RXVT_NAME@@(1) manpage). |
595 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
596 | |
|
|
597 | The event is simply the action string. This interface is assumed to change |
|
|
598 | slightly in the future. |
|
|
599 | |
|
|
600 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
601 | |
|
|
602 | Called just after the new window size has been calculated, but before |
|
|
603 | windows are actually being resized or hints are being set. If this hook |
|
|
604 | returns TRUE, setting of the window hints is being skipped. |
439 | |
605 | |
440 | =item on_x_event $term, $event |
606 | =item on_x_event $term, $event |
441 | |
607 | |
442 | Called on every X event received on the vt window (and possibly other |
608 | Called on every X event received on the vt window (and possibly other |
443 | windows). Should only be used as a last resort. Most event structure |
609 | windows). Should only be used as a last resort. Most event structure |
444 | members are not passed. |
610 | members are not passed. |
445 | |
611 | |
|
|
612 | =item on_root_event $term, $event |
|
|
613 | |
|
|
614 | Like C<on_x_event>, but is called for events on the root window. |
|
|
615 | |
446 | =item on_focus_in $term |
616 | =item on_focus_in $term |
447 | |
617 | |
448 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
618 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
449 | does focus in processing. |
619 | does focus in processing. |
450 | |
620 | |
451 | =item on_focus_out $term |
621 | =item on_focus_out $term |
452 | |
622 | |
453 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
623 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
454 | focus out processing. |
624 | focus out processing. |
455 | |
625 | |
456 | =item on_configure_notify $term, $event |
626 | =item on_configure_notify $term, $event |
|
|
627 | |
|
|
628 | =item on_property_notify $term, $event |
457 | |
629 | |
458 | =item on_key_press $term, $event, $keysym, $octets |
630 | =item on_key_press $term, $event, $keysym, $octets |
459 | |
631 | |
460 | =item on_key_release $term, $event, $keysym |
632 | =item on_key_release $term, $event, $keysym |
461 | |
633 | |
… | |
… | |
471 | |
643 | |
472 | Called whenever the corresponding X event is received for the terminal If |
644 | Called whenever the corresponding X event is received for the terminal If |
473 | the hook returns true, then the even will be ignored by rxvt-unicode. |
645 | the hook returns true, then the even will be ignored by rxvt-unicode. |
474 | |
646 | |
475 | The event is a hash with most values as named by Xlib (see the XEvent |
647 | The event is a hash with most values as named by Xlib (see the XEvent |
476 | manpage), with the additional members C<row> and C<col>, which are the row |
648 | manpage), with the additional members C<row> and C<col>, which are the |
477 | and column under the mouse cursor. |
649 | (real, not screen-based) row and column under the mouse cursor. |
478 | |
650 | |
479 | C<on_key_press> additionally receives the string rxvt-unicode would |
651 | C<on_key_press> additionally receives the string rxvt-unicode would |
480 | output, if any, in locale-specific encoding. |
652 | output, if any, in locale-specific encoding. |
481 | |
653 | |
482 | subwindow. |
654 | subwindow. |
|
|
655 | |
|
|
656 | =item on_client_message $term, $event |
|
|
657 | |
|
|
658 | =item on_wm_protocols $term, $event |
|
|
659 | |
|
|
660 | =item on_wm_delete_window $term, $event |
|
|
661 | |
|
|
662 | Called when various types of ClientMessage events are received (all with |
|
|
663 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
483 | |
664 | |
484 | =back |
665 | =back |
485 | |
666 | |
486 | =cut |
667 | =cut |
487 | |
668 | |
… | |
… | |
493 | use Scalar::Util (); |
674 | use Scalar::Util (); |
494 | use List::Util (); |
675 | use List::Util (); |
495 | |
676 | |
496 | our $VERSION = 1; |
677 | our $VERSION = 1; |
497 | our $TERM; |
678 | our $TERM; |
|
|
679 | our @TERM_INIT; |
|
|
680 | our @TERM_EXT; |
498 | our @HOOKNAME; |
681 | our @HOOKNAME; |
499 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
682 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
500 | our %OPTION; |
683 | our %OPTION; |
501 | |
684 | |
502 | our $LIBDIR; |
685 | our $LIBDIR; |
503 | our $RESNAME; |
686 | our $RESNAME; |
504 | our $RESCLASS; |
687 | our $RESCLASS; |
505 | our $RXVTNAME; |
688 | our $RXVTNAME; |
506 | |
689 | |
|
|
690 | our $NOCHAR = chr 0xffff; |
|
|
691 | |
507 | =head2 Variables in the C<urxvt> Package |
692 | =head2 Variables in the C<urxvt> Package |
508 | |
693 | |
509 | =over 4 |
694 | =over 4 |
510 | |
695 | |
511 | =item $urxvt::LIBDIR |
696 | =item $urxvt::LIBDIR |
… | |
… | |
523 | |
708 | |
524 | =item $urxvt::TERM |
709 | =item $urxvt::TERM |
525 | |
710 | |
526 | The current terminal. This variable stores the current C<urxvt::term> |
711 | The current terminal. This variable stores the current C<urxvt::term> |
527 | object, whenever a callback/hook is executing. |
712 | object, whenever a callback/hook is executing. |
|
|
713 | |
|
|
714 | =item @urxvt::TERM_INIT |
|
|
715 | |
|
|
716 | All code references in this array will be called as methods of the next newly |
|
|
717 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
718 | gets cleared before the code references that were in it are being executed, |
|
|
719 | so references can push themselves onto it again if they so desire. |
|
|
720 | |
|
|
721 | This complements to the perl-eval command line option, but gets executed |
|
|
722 | first. |
|
|
723 | |
|
|
724 | =item @urxvt::TERM_EXT |
|
|
725 | |
|
|
726 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
727 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
728 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
528 | |
729 | |
529 | =back |
730 | =back |
530 | |
731 | |
531 | =head2 Functions in the C<urxvt> Package |
732 | =head2 Functions in the C<urxvt> Package |
532 | |
733 | |
… | |
… | |
546 | |
747 | |
547 | Using this function has the advantage that its output ends up in the |
748 | Using this function has the advantage that its output ends up in the |
548 | correct place, e.g. on stderr of the connecting urxvtc client. |
749 | correct place, e.g. on stderr of the connecting urxvtc client. |
549 | |
750 | |
550 | Messages have a size limit of 1023 bytes currently. |
751 | Messages have a size limit of 1023 bytes currently. |
|
|
752 | |
|
|
753 | =item @terms = urxvt::termlist |
|
|
754 | |
|
|
755 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
756 | whether they are started, being destroyed etc., so be careful. Only term |
|
|
757 | objects that have perl extensions attached will be returned (because there |
|
|
758 | is no urxvt::term objet associated with others). |
551 | |
759 | |
552 | =item $time = urxvt::NOW |
760 | =item $time = urxvt::NOW |
553 | |
761 | |
554 | Returns the "current time" (as per the event loop). |
762 | Returns the "current time" (as per the event loop). |
555 | |
763 | |
… | |
… | |
613 | Return the foreground/background colour index, respectively. |
821 | Return the foreground/background colour index, respectively. |
614 | |
822 | |
615 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
823 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
616 | |
824 | |
617 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
825 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
826 | |
|
|
827 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
618 | |
828 | |
619 | Replace the foreground/background colour in the rendition mask with the |
829 | Replace the foreground/background colour in the rendition mask with the |
620 | specified one. |
830 | specified one. |
621 | |
831 | |
622 | =item $value = urxvt::GET_CUSTOM $rend |
832 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
641 | unless $msg =~ /\n$/; |
851 | unless $msg =~ /\n$/; |
642 | urxvt::warn ($msg); |
852 | urxvt::warn ($msg); |
643 | }; |
853 | }; |
644 | } |
854 | } |
645 | |
855 | |
|
|
856 | no warnings 'utf8'; |
|
|
857 | |
646 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
858 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
647 | |
859 | |
648 | sub verbose { |
860 | sub verbose { |
649 | my ($level, $msg) = @_; |
861 | my ($level, $msg) = @_; |
650 | warn "$msg\n" if $level <= $verbosity; |
862 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
653 | my %extension_pkg; |
865 | my %extension_pkg; |
654 | |
866 | |
655 | # load a single script into its own package, once only |
867 | # load a single script into its own package, once only |
656 | sub extension_package($) { |
868 | sub extension_package($) { |
657 | my ($path) = @_; |
869 | my ($path) = @_; |
658 | |
|
|
659 | no strict 'refs'; |
|
|
660 | |
870 | |
661 | $extension_pkg{$path} ||= do { |
871 | $extension_pkg{$path} ||= do { |
662 | $path =~ /([^\/\\]+)$/; |
872 | $path =~ /([^\/\\]+)$/; |
663 | my $pkg = $1; |
873 | my $pkg = $1; |
664 | $pkg =~ s/[^[:word:]]/_/g; |
874 | $pkg =~ s/[^[:word:]]/_/g; |
… | |
… | |
667 | verbose 3, "loading extension '$path' into package '$pkg'"; |
877 | verbose 3, "loading extension '$path' into package '$pkg'"; |
668 | |
878 | |
669 | open my $fh, "<:raw", $path |
879 | open my $fh, "<:raw", $path |
670 | or die "$path: $!"; |
880 | or die "$path: $!"; |
671 | |
881 | |
672 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
673 | |
|
|
674 | my $source = |
882 | my $source = |
675 | "package $pkg; use strict; use utf8;\n" |
883 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
676 | . "#line 1 \"$path\"\n{\n" |
884 | . "#line 1 \"$path\"\n{\n" |
677 | . (do { local $/; <$fh> }) |
885 | . (do { local $/; <$fh> }) |
678 | . "\n};\n1"; |
886 | . "\n};\n1"; |
679 | |
887 | |
680 | eval $source |
888 | eval $source |
… | |
… | |
694 | if ($htype == 0) { # INIT |
902 | if ($htype == 0) { # INIT |
695 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
903 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
696 | |
904 | |
697 | my %ext_arg; |
905 | my %ext_arg; |
698 | |
906 | |
|
|
907 | { |
|
|
908 | my @init = @TERM_INIT; |
|
|
909 | @TERM_INIT = (); |
|
|
910 | $_->($TERM) for @init; |
|
|
911 | my @pkg = @TERM_EXT; |
|
|
912 | @TERM_EXT = (); |
|
|
913 | $TERM->register_package ($_) for @pkg; |
|
|
914 | } |
|
|
915 | |
699 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
916 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
700 | if ($_ eq "default") { |
917 | if ($_ eq "default") { |
701 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
918 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
702 | } elsif (/^-(.*)$/) { |
919 | } elsif (/^-(.*)$/) { |
703 | delete $ext_arg{$1}; |
920 | delete $ext_arg{$1}; |
704 | } elsif (/^([^<]+)<(.*)>$/) { |
921 | } elsif (/^([^<]+)<(.*)>$/) { |
705 | push @{ $ext_arg{$1} }, $2; |
922 | push @{ $ext_arg{$1} }, $2; |
706 | } else { |
923 | } else { |
707 | $ext_arg{$_} ||= []; |
924 | $ext_arg{$_} ||= []; |
708 | } |
925 | } |
709 | } |
926 | } |
710 | |
927 | |
711 | while (my ($ext, $argv) = each %ext_arg) { |
928 | for my $ext (sort keys %ext_arg) { |
712 | my @files = grep -f $_, map "$_/$ext", @dirs; |
929 | my @files = grep -f $_, map "$_/$ext", @dirs; |
713 | |
930 | |
714 | if (@files) { |
931 | if (@files) { |
715 | $TERM->register_package (extension_package $files[0], $argv); |
932 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
716 | } else { |
933 | } else { |
717 | warn "perl extension '$ext' not found in perl library search path\n"; |
934 | warn "perl extension '$ext' not found in perl library search path\n"; |
718 | } |
935 | } |
719 | } |
936 | } |
720 | |
937 | |
… | |
… | |
726 | |
943 | |
727 | if (my $cb = $TERM->{_hook}[$htype]) { |
944 | if (my $cb = $TERM->{_hook}[$htype]) { |
728 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
945 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
729 | if $verbosity >= 10; |
946 | if $verbosity >= 10; |
730 | |
947 | |
731 | keys %$cb; |
948 | for my $pkg (keys %$cb) { |
732 | |
|
|
733 | while (my ($pkg, $cb) = each %$cb) { |
|
|
734 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
949 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
735 | and last; |
950 | $retval ||= $retval_; |
736 | |
951 | |
737 | if ($@) { |
952 | if ($@) { |
738 | $TERM->ungrab; # better to lose the grab than the session |
953 | $TERM->ungrab; # better to lose the grab than the session |
739 | warn $@; |
954 | warn $@; |
740 | } |
955 | } |
… | |
… | |
751 | # clear package |
966 | # clear package |
752 | %$TERM = (); |
967 | %$TERM = (); |
753 | } |
968 | } |
754 | |
969 | |
755 | $retval |
970 | $retval |
|
|
971 | } |
|
|
972 | |
|
|
973 | sub SET_COLOR($$$) { |
|
|
974 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
756 | } |
975 | } |
757 | |
976 | |
758 | # urxvt::term::extension |
977 | # urxvt::term::extension |
759 | |
978 | |
760 | package urxvt::term::extension; |
979 | package urxvt::term::extension; |
… | |
… | |
899 | # find on_xxx subs in the package and register them |
1118 | # find on_xxx subs in the package and register them |
900 | # as hooks |
1119 | # as hooks |
901 | sub register_package { |
1120 | sub register_package { |
902 | my ($self, $pkg, $argv) = @_; |
1121 | my ($self, $pkg, $argv) = @_; |
903 | |
1122 | |
|
|
1123 | no strict 'refs'; |
|
|
1124 | |
|
|
1125 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
1126 | |
|
|
1127 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
1128 | |
904 | my $proxy = bless { |
1129 | my $proxy = bless { |
905 | _pkg => $pkg, |
1130 | _pkg => $pkg, |
906 | argv => $argv, |
1131 | argv => $argv, |
907 | }, $pkg; |
1132 | }, $pkg; |
908 | Scalar::Util::weaken ($proxy->{term} = $self); |
1133 | Scalar::Util::weaken ($proxy->{term} = $self); |
… | |
… | |
923 | hash which defines the environment of the new terminal. |
1148 | hash which defines the environment of the new terminal. |
924 | |
1149 | |
925 | Croaks (and probably outputs an error message) if the new instance |
1150 | Croaks (and probably outputs an error message) if the new instance |
926 | couldn't be created. Returns C<undef> if the new instance didn't |
1151 | couldn't be created. Returns C<undef> if the new instance didn't |
927 | initialise perl, and the terminal object otherwise. The C<init> and |
1152 | initialise perl, and the terminal object otherwise. The C<init> and |
928 | C<start> hooks will be called during this call. |
1153 | C<start> hooks will be called before this call returns, and are free to |
|
|
1154 | refer to global data (which is race free). |
929 | |
1155 | |
930 | =cut |
1156 | =cut |
931 | |
1157 | |
932 | sub new { |
1158 | sub new { |
933 | my ($class, $env, @args) = @_; |
1159 | my ($class, $env, @args) = @_; |
934 | |
1160 | |
|
|
1161 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1162 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1163 | |
935 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1164 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
936 | } |
1165 | } |
937 | |
1166 | |
938 | =item $term->destroy |
1167 | =item $term->destroy |
939 | |
1168 | |
940 | Destroy the terminal object (close the window, free resources |
1169 | Destroy the terminal object (close the window, free resources |
… | |
… | |
970 | |
1199 | |
971 | Returns true if the option specified by C<$optval> is enabled, and |
1200 | Returns true if the option specified by C<$optval> is enabled, and |
972 | optionally change it. All option values are stored by name in the hash |
1201 | optionally change it. All option values are stored by name in the hash |
973 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1202 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
974 | |
1203 | |
975 | Here is a a likely non-exhaustive list of option names, please see the |
1204 | Here is a likely non-exhaustive list of option names, please see the |
976 | source file F</src/optinc.h> to see the actual list: |
1205 | source file F</src/optinc.h> to see the actual list: |
977 | |
1206 | |
978 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1207 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
979 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1208 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
980 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1209 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
997 | likely change). |
1226 | likely change). |
998 | |
1227 | |
999 | Please note that resource strings will currently only be freed when the |
1228 | Please note that resource strings will currently only be freed when the |
1000 | terminal is destroyed, so changing options frequently will eat memory. |
1229 | terminal is destroyed, so changing options frequently will eat memory. |
1001 | |
1230 | |
1002 | Here is a a likely non-exhaustive list of resource names, not all of which |
1231 | Here is a likely non-exhaustive list of resource names, not all of which |
1003 | are supported in every build, please see the source file F</src/rsinc.h> |
1232 | are supported in every build, please see the source file F</src/rsinc.h> |
1004 | to see the actual list: |
1233 | to see the actual list: |
1005 | |
1234 | |
1006 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1235 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1007 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1236 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1197 | |
1426 | |
1198 | Normally its not a good idea to use this function, as programs might be |
1427 | Normally its not a good idea to use this function, as programs might be |
1199 | confused by changes in cursor position or scrolling. Its useful inside a |
1428 | confused by changes in cursor position or scrolling. Its useful inside a |
1200 | C<on_add_lines> hook, though. |
1429 | C<on_add_lines> hook, though. |
1201 | |
1430 | |
|
|
1431 | =item $term->scr_change_screen ($screen) |
|
|
1432 | |
|
|
1433 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1434 | |
1202 | =item $term->cmd_parse ($octets) |
1435 | =item $term->cmd_parse ($octets) |
1203 | |
1436 | |
1204 | Similar to C<scr_add_lines>, but the argument must be in the |
1437 | Similar to C<scr_add_lines>, but the argument must be in the |
1205 | locale-specific encoding of the terminal and can contain command sequences |
1438 | locale-specific encoding of the terminal and can contain command sequences |
1206 | (escape codes) that will be interpreted. |
1439 | (escape codes) that will be interpreted. |
… | |
… | |
1216 | Replaces the event mask of the pty watcher by the given event mask. Can |
1449 | Replaces the event mask of the pty watcher by the given event mask. Can |
1217 | be used to suppress input and output handling to the pty/tty. See the |
1450 | be used to suppress input and output handling to the pty/tty. See the |
1218 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1451 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1219 | the previous value. |
1452 | the previous value. |
1220 | |
1453 | |
|
|
1454 | =item $fd = $term->pty_fd |
|
|
1455 | |
|
|
1456 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1457 | is used. |
|
|
1458 | |
1221 | =item $windowid = $term->parent |
1459 | =item $windowid = $term->parent |
1222 | |
1460 | |
1223 | Return the window id of the toplevel window. |
1461 | Return the window id of the toplevel window. |
1224 | |
1462 | |
1225 | =item $windowid = $term->vt |
1463 | =item $windowid = $term->vt |
… | |
… | |
1231 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1469 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1232 | to receive pointer events all the times: |
1470 | to receive pointer events all the times: |
1233 | |
1471 | |
1234 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1472 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1235 | |
1473 | |
|
|
1474 | =item $term->focus_in |
|
|
1475 | |
|
|
1476 | =item $term->focus_out |
|
|
1477 | |
|
|
1478 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1479 | |
|
|
1480 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1481 | |
|
|
1482 | Deliver various fake events to to terminal. |
|
|
1483 | |
1236 | =item $window_width = $term->width |
1484 | =item $window_width = $term->width |
1237 | |
1485 | |
1238 | =item $window_height = $term->height |
1486 | =item $window_height = $term->height |
1239 | |
1487 | |
1240 | =item $font_width = $term->fwidth |
1488 | =item $font_width = $term->fwidth |
… | |
… | |
1270 | =item $env = $term->env |
1518 | =item $env = $term->env |
1271 | |
1519 | |
1272 | Returns a copy of the environment in effect for the terminal as a hashref |
1520 | Returns a copy of the environment in effect for the terminal as a hashref |
1273 | similar to C<\%ENV>. |
1521 | similar to C<\%ENV>. |
1274 | |
1522 | |
|
|
1523 | =item @envv = $term->envv |
|
|
1524 | |
|
|
1525 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1526 | |
|
|
1527 | =item @argv = $term->argv |
|
|
1528 | |
|
|
1529 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1530 | includes the program name as first element. |
|
|
1531 | |
1275 | =cut |
1532 | =cut |
1276 | |
1533 | |
1277 | sub env { |
1534 | sub env { |
1278 | if (my $env = $_[0]->_env) { |
|
|
1279 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1535 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1280 | } else { |
|
|
1281 | +{ %ENV } |
|
|
1282 | } |
|
|
1283 | } |
1536 | } |
1284 | |
1537 | |
1285 | =item $modifiermask = $term->ModLevel3Mask |
1538 | =item $modifiermask = $term->ModLevel3Mask |
1286 | |
1539 | |
1287 | =item $modifiermask = $term->ModMetaMask |
1540 | =item $modifiermask = $term->ModMetaMask |
1288 | |
1541 | |
1289 | =item $modifiermask = $term->ModNumLockMask |
1542 | =item $modifiermask = $term->ModNumLockMask |
1290 | |
1543 | |
1291 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1544 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1292 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1545 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1546 | |
|
|
1547 | =item $screen = $term->current_screen |
|
|
1548 | |
|
|
1549 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1550 | |
|
|
1551 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1552 | |
|
|
1553 | Returns whether the cursor is currently hidden or not. |
1293 | |
1554 | |
1294 | =item $view_start = $term->view_start ([$newvalue]) |
1555 | =item $view_start = $term->view_start ([$newvalue]) |
1295 | |
1556 | |
1296 | Returns the row number of the topmost displayed line. Maximum value is |
1557 | Returns the row number of the topmost displayed line. Maximum value is |
1297 | C<0>, which displays the normal terminal contents. Lower values scroll |
1558 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1317 | line, starting at column C<$start_col> (default C<0>), which is useful |
1578 | line, starting at column C<$start_col> (default C<0>), which is useful |
1318 | to replace only parts of a line. The font index in the rendition will |
1579 | to replace only parts of a line. The font index in the rendition will |
1319 | automatically be updated. |
1580 | automatically be updated. |
1320 | |
1581 | |
1321 | C<$text> is in a special encoding: tabs and wide characters that use more |
1582 | C<$text> is in a special encoding: tabs and wide characters that use more |
1322 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1583 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1323 | (C<chr 65535>). Characters with combining characters and other characters |
1584 | characters. Characters with combining characters and other characters that |
1324 | that do not fit into the normal tetx encoding will be replaced with |
1585 | do not fit into the normal tetx encoding will be replaced with characters |
1325 | characters in the private use area. |
1586 | in the private use area. |
1326 | |
1587 | |
1327 | You have to obey this encoding when changing text. The advantage is |
1588 | You have to obey this encoding when changing text. The advantage is |
1328 | that C<substr> and similar functions work on screen cells and not on |
1589 | that C<substr> and similar functions work on screen cells and not on |
1329 | characters. |
1590 | characters. |
1330 | |
1591 | |
… | |
… | |
1474 | where one character corresponds to one screen cell. See |
1735 | where one character corresponds to one screen cell. See |
1475 | C<< $term->ROW_t >> for details. |
1736 | C<< $term->ROW_t >> for details. |
1476 | |
1737 | |
1477 | =item $string = $term->special_decode $text |
1738 | =item $string = $term->special_decode $text |
1478 | |
1739 | |
1479 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1740 | Converts rxvt-unicodes text representation into a perl string. See |
1480 | C<< $term->ROW_t >> for details. |
1741 | C<< $term->ROW_t >> for details. |
1481 | |
1742 | |
1482 | =item $success = $term->grab_button ($button, $modifiermask) |
1743 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1483 | |
1744 | |
|
|
1745 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1746 | |
1484 | Registers a synchronous button grab. See the XGrabButton manpage. |
1747 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1748 | manpage. |
1485 | |
1749 | |
1486 | =item $success = $term->grab ($eventtime[, $sync]) |
1750 | =item $success = $term->grab ($eventtime[, $sync]) |
1487 | |
1751 | |
1488 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1752 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1489 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1753 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1490 | |
1754 | |
1491 | =item $term->allow_events_async |
1755 | =item $term->allow_events_async |
1492 | |
1756 | |
1493 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1757 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1494 | |
1758 | |
… | |
… | |
1504 | =item $term->ungrab |
1768 | =item $term->ungrab |
1505 | |
1769 | |
1506 | Calls XUngrab for the most recent grab. Is called automatically on |
1770 | Calls XUngrab for the most recent grab. Is called automatically on |
1507 | evaluation errors, as it is better to lose the grab in the error case as |
1771 | evaluation errors, as it is better to lose the grab in the error case as |
1508 | the session. |
1772 | the session. |
|
|
1773 | |
|
|
1774 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1775 | |
|
|
1776 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1777 | |
|
|
1778 | =item @atoms = $term->XListProperties ($window) |
|
|
1779 | |
|
|
1780 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1781 | |
|
|
1782 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1783 | |
|
|
1784 | =item $term->XDeleteProperty ($window, $property) |
|
|
1785 | |
|
|
1786 | =item $window = $term->DefaultRootWindow |
|
|
1787 | |
|
|
1788 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1789 | |
|
|
1790 | =item $term->XMapWindow ($window) |
|
|
1791 | |
|
|
1792 | =item $term->XUnmapWindow ($window) |
|
|
1793 | |
|
|
1794 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1795 | |
|
|
1796 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1797 | |
|
|
1798 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1799 | |
|
|
1800 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1801 | the source of the display, otherwise those functions map more-or-less |
|
|
1802 | directory onto the X functions of the same name. |
1509 | |
1803 | |
1510 | =back |
1804 | =back |
1511 | |
1805 | |
1512 | =cut |
1806 | =cut |
1513 | |
1807 | |
… | |
… | |
1577 | my ($self, $text, $cb) = @_; |
1871 | my ($self, $text, $cb) = @_; |
1578 | |
1872 | |
1579 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1873 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1580 | } |
1874 | } |
1581 | |
1875 | |
1582 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1876 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1583 | |
1877 | |
1584 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1878 | Adds a toggle/checkbox item to the popup. The callback gets called |
1585 | whenever it gets toggled, with a boolean indicating its value as its first |
1879 | whenever it gets toggled, with a boolean indicating its new value as its |
1586 | argument. |
1880 | first argument. |
1587 | |
1881 | |
1588 | =cut |
1882 | =cut |
1589 | |
1883 | |
1590 | sub add_toggle { |
1884 | sub add_toggle { |
1591 | my ($self, $text, $cb, $value) = @_; |
1885 | my ($self, $text, $value, $cb) = @_; |
1592 | |
1886 | |
1593 | my $item; $item = { |
1887 | my $item; $item = { |
1594 | type => "button", |
1888 | type => "button", |
1595 | text => " $text", |
1889 | text => " $text", |
1596 | value => $value, |
1890 | value => $value, |
… | |
… | |
1633 | delete $self->{term}{_destroy}{$self}; |
1927 | delete $self->{term}{_destroy}{$self}; |
1634 | $self->{term}->ungrab; |
1928 | $self->{term}->ungrab; |
1635 | } |
1929 | } |
1636 | |
1930 | |
1637 | =back |
1931 | =back |
|
|
1932 | |
|
|
1933 | =cut |
|
|
1934 | |
|
|
1935 | package urxvt::watcher; |
|
|
1936 | |
|
|
1937 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1938 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1939 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1940 | @urxvt::iw::ISA = __PACKAGE__; |
1638 | |
1941 | |
1639 | =head2 The C<urxvt::timer> Class |
1942 | =head2 The C<urxvt::timer> Class |
1640 | |
1943 | |
1641 | This class implements timer watchers/events. Time is represented as a |
1944 | This class implements timer watchers/events. Time is represented as a |
1642 | fractional number of seconds since the epoch. Example: |
1945 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1722 | Set the callback to be called when io events are triggered. C<$reventmask> |
2025 | Set the callback to be called when io events are triggered. C<$reventmask> |
1723 | is a bitset as described in the C<events> method. |
2026 | is a bitset as described in the C<events> method. |
1724 | |
2027 | |
1725 | =item $iow = $iow->fd ($fd) |
2028 | =item $iow = $iow->fd ($fd) |
1726 | |
2029 | |
1727 | Set the filedescriptor (not handle) to watch. |
2030 | Set the file descriptor (not handle) to watch. |
1728 | |
2031 | |
1729 | =item $iow = $iow->events ($eventmask) |
2032 | =item $iow = $iow->events ($eventmask) |
1730 | |
2033 | |
1731 | Set the event mask to watch. The only allowed values are |
2034 | Set the event mask to watch. The only allowed values are |
1732 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2035 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
… | |
… | |
1736 | |
2039 | |
1737 | Start watching for requested events on the given handle. |
2040 | Start watching for requested events on the given handle. |
1738 | |
2041 | |
1739 | =item $iow = $iow->stop |
2042 | =item $iow = $iow->stop |
1740 | |
2043 | |
1741 | Stop watching for events on the given filehandle. |
2044 | Stop watching for events on the given file handle. |
|
|
2045 | |
|
|
2046 | =back |
|
|
2047 | |
|
|
2048 | =head2 The C<urxvt::iw> Class |
|
|
2049 | |
|
|
2050 | This class implements idle watchers, that get called automatically when |
|
|
2051 | the process is idle. They should return as fast as possible, after doing |
|
|
2052 | some useful work. |
|
|
2053 | |
|
|
2054 | =over 4 |
|
|
2055 | |
|
|
2056 | =item $iw = new urxvt::iw |
|
|
2057 | |
|
|
2058 | Create a new idle watcher object in stopped state. |
|
|
2059 | |
|
|
2060 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
2061 | |
|
|
2062 | Set the callback to be called when the watcher triggers. |
|
|
2063 | |
|
|
2064 | =item $timer = $timer->start |
|
|
2065 | |
|
|
2066 | Start the watcher. |
|
|
2067 | |
|
|
2068 | =item $timer = $timer->stop |
|
|
2069 | |
|
|
2070 | Stop the watcher. |
|
|
2071 | |
|
|
2072 | =back |
|
|
2073 | |
|
|
2074 | =head2 The C<urxvt::pw> Class |
|
|
2075 | |
|
|
2076 | This class implements process watchers. They create an event whenever a |
|
|
2077 | process exits, after which they stop automatically. |
|
|
2078 | |
|
|
2079 | my $pid = fork; |
|
|
2080 | ... |
|
|
2081 | $term->{pw} = urxvt::pw |
|
|
2082 | ->new |
|
|
2083 | ->start ($pid) |
|
|
2084 | ->cb (sub { |
|
|
2085 | my ($pw, $exit_status) = @_; |
|
|
2086 | ... |
|
|
2087 | }); |
|
|
2088 | |
|
|
2089 | =over 4 |
|
|
2090 | |
|
|
2091 | =item $pw = new urxvt::pw |
|
|
2092 | |
|
|
2093 | Create a new process watcher in stopped state. |
|
|
2094 | |
|
|
2095 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
2096 | |
|
|
2097 | Set the callback to be called when the timer triggers. |
|
|
2098 | |
|
|
2099 | =item $pw = $timer->start ($pid) |
|
|
2100 | |
|
|
2101 | Tells the watcher to start watching for process C<$pid>. |
|
|
2102 | |
|
|
2103 | =item $pw = $pw->stop |
|
|
2104 | |
|
|
2105 | Stop the watcher. |
1742 | |
2106 | |
1743 | =back |
2107 | =back |
1744 | |
2108 | |
1745 | =head1 ENVIRONMENT |
2109 | =head1 ENVIRONMENT |
1746 | |
2110 | |
… | |
… | |
1755 | |
2119 | |
1756 | =item >= 3 - script loading and management |
2120 | =item >= 3 - script loading and management |
1757 | |
2121 | |
1758 | =item >=10 - all called hooks |
2122 | =item >=10 - all called hooks |
1759 | |
2123 | |
1760 | =item >=11 - hook reutrn values |
2124 | =item >=11 - hook return values |
1761 | |
2125 | |
1762 | =back |
2126 | =back |
1763 | |
2127 | |
1764 | =head1 AUTHOR |
2128 | =head1 AUTHOR |
1765 | |
2129 | |