… | |
… | |
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 | |
… | |
… | |
62 | URxvt.selection.pattern-1: perl-regex |
62 | URxvt.selection.pattern-1: perl-regex |
63 | ... |
63 | ... |
64 | |
64 | |
65 | 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 |
66 | 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 |
67 | 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 |
68 | between two vertical bars: |
68 | between two vertical bars: |
69 | |
69 | |
70 | 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: ^(/[^:]+):\ |
71 | |
78 | |
72 | 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 |
73 | interesting uses, such as parsing a line from beginning to end. |
80 | interesting uses, such as parsing a line from beginning to end. |
74 | |
81 | |
75 | This extension also offers following bindable keyboard commands: |
82 | This extension also offers following bindable keyboard commands: |
… | |
… | |
87 | =item option-popup (enabled by default) |
94 | =item option-popup (enabled by default) |
88 | |
95 | |
89 | 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 |
90 | runtime. |
97 | runtime. |
91 | |
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 | |
92 | =item selection-popup (enabled by default) |
116 | =item selection-popup (enabled by default) |
93 | |
117 | |
94 | 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 |
95 | text into various other formats/action (such as uri unescaping, perl |
119 | text into various other formats/action (such as uri unescaping, perl |
96 | evalution, web-browser starting etc.), depending on content. |
120 | evaluation, web-browser starting etc.), depending on content. |
97 | |
121 | |
98 | Other extensions can extend this popup menu by pushing a code reference |
122 | Other extensions can extend this popup menu by pushing a code reference |
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
100 | popup is displayed. |
124 | popup is being displayed. |
101 | |
125 | |
102 | 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 |
103 | 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. |
104 | 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 |
105 | 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 |
106 | when the button gets activated and should transform C<$_>. |
130 | when the button gets activated and should transform C<$_>. |
107 | |
131 | |
108 | 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 |
… | |
… | |
127 | 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 |
128 | 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 |
129 | 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 |
130 | selection. |
154 | selection. |
131 | |
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 | |
132 | =item selection-autotransform |
187 | =item selection-autotransform |
133 | |
188 | |
134 | This selection allows you to do automatic transforms on a selection |
189 | This selection allows you to do automatic transforms on a selection |
135 | whenever a selection is made. |
190 | whenever a selection is made. |
136 | |
191 | |
… | |
… | |
161 | 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/ |
162 | |
217 | |
163 | 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 |
164 | 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 |
165 | 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. |
166 | |
244 | |
167 | =item mark-urls |
245 | =item mark-urls |
168 | |
246 | |
169 | 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 |
170 | make them clickable. When middle-clicked, the program specified in the |
248 | make them clickable. When middle-clicked, the program specified in the |
171 | 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 |
172 | the URL as first argument. |
250 | the URL as first argument. |
173 | |
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 | |
174 | =item automove-background |
283 | =item automove-background |
175 | |
284 | |
176 | 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 |
177 | 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 |
178 | 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: |
179 | |
289 | |
180 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
290 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
181 | |
291 | |
182 | =item block-graphics-to-ascii |
292 | =item block-graphics-to-ascii |
183 | |
293 | |
184 | 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 |
185 | 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 |
186 | similar-looking ascii character. |
296 | similar-looking ascii character. |
187 | |
297 | |
188 | =item digital-clock |
298 | =item digital-clock |
189 | |
299 | |
190 | Displays a digital clock using the built-in overlay. |
300 | Displays a digital clock using the built-in overlay. |
191 | |
301 | |
192 | =item example-refresh-hooks |
302 | =item remote-clipboard |
193 | |
303 | |
194 | 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 |
195 | window. Illustrates overwriting the refresh callbacks to create your own |
305 | selection popup that allows one ti run external commands to store the |
196 | 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' |
197 | |
321 | |
198 | =item selection-pastebin |
322 | =item selection-pastebin |
199 | |
323 | |
200 | 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 |
201 | 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 |
… | |
… | |
221 | 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 |
222 | 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 |
223 | for the filename): |
347 | for the filename): |
224 | |
348 | |
225 | 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 | =item example-refresh-hooks |
|
|
352 | |
|
|
353 | Displays a very simple digital clock in the upper right corner of the |
|
|
354 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
355 | overlays or changes. |
226 | |
356 | |
227 | =back |
357 | =back |
228 | |
358 | |
229 | =head1 API DOCUMENTATION |
359 | =head1 API DOCUMENTATION |
230 | |
360 | |
… | |
… | |
264 | |
394 | |
265 | =back |
395 | =back |
266 | |
396 | |
267 | =head2 Extension Objects |
397 | =head2 Extension Objects |
268 | |
398 | |
269 | Very perl extension is a perl class. A separate perl object is created |
399 | 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 |
400 | 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 |
401 | 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 |
402 | their C<$self> object without having to think about clashes with other |
|
|
403 | extensions or other terminals, with the exception of methods and members |
273 | begin with an underscore character C<_>: these are reserved for internal |
404 | that begin with an underscore character C<_>: these are reserved for |
274 | use. |
405 | internal use. |
275 | |
406 | |
276 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
407 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
277 | C<urxvt::term> class on this object. |
408 | C<urxvt::term> class on this object. |
278 | |
409 | |
279 | It has the following methods and data members: |
410 | It has the following methods and data members: |
… | |
… | |
300 | =head2 Hooks |
431 | =head2 Hooks |
301 | |
432 | |
302 | The following subroutines can be declared in extension files, and will be |
433 | The following subroutines can be declared in extension files, and will be |
303 | called whenever the relevant event happens. |
434 | called whenever the relevant event happens. |
304 | |
435 | |
305 | The first argument passed to them is an extension oject as described in |
436 | The first argument passed to them is an extension object as described in |
306 | the in the C<Extension Objects> section. |
437 | the in the C<Extension Objects> section. |
307 | |
438 | |
308 | B<All> of these hooks must return a boolean value. If any of the called |
439 | B<All> of these hooks must return a boolean value. If any of the called |
309 | hooks returns true, then the event counts as being I<consumed>, and the |
440 | hooks returns true, then the event counts as being I<consumed>, and the |
310 | relevant action might not be carried out by the C++ code. |
441 | relevant action might not be carried out by the C++ code. |
… | |
… | |
323 | place. |
454 | place. |
324 | |
455 | |
325 | =item on_start $term |
456 | =item on_start $term |
326 | |
457 | |
327 | Called at the very end of initialisation of a new terminal, just before |
458 | Called at the very end of initialisation of a new terminal, just before |
328 | trying to map (display) the toplevel and returning to the mainloop. |
459 | trying to map (display) the toplevel and returning to the main loop. |
329 | |
460 | |
330 | =item on_destroy $term |
461 | =item on_destroy $term |
331 | |
462 | |
332 | Called whenever something tries to destroy terminal, before doing anything |
463 | Called whenever something tries to destroy terminal, when the terminal is |
333 | yet. If this hook returns true, then destruction is skipped, but this is |
464 | still fully functional (not for long, though). |
334 | rarely a good idea. |
|
|
335 | |
465 | |
336 | =item on_reset $term |
466 | =item on_reset $term |
337 | |
467 | |
338 | Called after the screen is "reset" for any reason, such as resizing or |
468 | Called after the screen is "reset" for any reason, such as resizing or |
339 | control sequences. Here is where you can react on changes to size-related |
469 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
361 | |
491 | |
362 | Called whenever a selection has been copied, but before the selection is |
492 | Called whenever a selection has been copied, but before the selection is |
363 | requested from the server. The selection text can be queried and changed |
493 | requested from the server. The selection text can be queried and changed |
364 | by calling C<< $term->selection >>. |
494 | by calling C<< $term->selection >>. |
365 | |
495 | |
366 | Returning a true value aborts selection grabbing. It will still be hilighted. |
496 | Returning a true value aborts selection grabbing. It will still be highlighted. |
367 | |
497 | |
368 | =item on_sel_extend $term |
498 | =item on_sel_extend $term |
369 | |
499 | |
370 | Called whenever the user tries to extend the selection (e.g. with a double |
500 | Called whenever the user tries to extend the selection (e.g. with a double |
371 | click) and is either supposed to return false (normal operation), or |
501 | click) and is either supposed to return false (normal operation), or |
372 | should extend the selection itelf and return true to suppress the built-in |
502 | should extend the selection itself and return true to suppress the built-in |
373 | processing. This can happen multiple times, as long as the callback |
503 | processing. This can happen multiple times, as long as the callback |
374 | returns true, it will be called on every further click by the user and is |
504 | returns true, it will be called on every further click by the user and is |
375 | supposed to enlarge the selection more and more, if possible. |
505 | supposed to enlarge the selection more and more, if possible. |
376 | |
506 | |
377 | See the F<selection> example extension. |
507 | See the F<selection> example extension. |
378 | |
508 | |
379 | =item on_view_change $term, $offset |
509 | =item on_view_change $term, $offset |
380 | |
510 | |
381 | Called whenever the view offset changes, i..e the user or program |
511 | Called whenever the view offset changes, i.e. the user or program |
382 | scrolls. Offset C<0> means display the normal terminal, positive values |
512 | scrolls. Offset C<0> means display the normal terminal, positive values |
383 | show this many lines of scrollback. |
513 | show this many lines of scrollback. |
384 | |
514 | |
385 | =item on_scroll_back $term, $lines, $saved |
515 | =item on_scroll_back $term, $lines, $saved |
386 | |
516 | |
… | |
… | |
390 | |
520 | |
391 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
521 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
392 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
522 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
393 | number of lines that will be in the scrollback buffer. |
523 | number of lines that will be in the scrollback buffer. |
394 | |
524 | |
|
|
525 | =item on_osc_seq $term, $op, $args |
|
|
526 | |
|
|
527 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
528 | behaviour. The default should be to return an empty list. A true value |
|
|
529 | suppresses execution of the request completely. Make sure you don't get |
|
|
530 | confused by recursive invocations when you output an osc sequence within |
|
|
531 | this callback. |
|
|
532 | |
|
|
533 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
534 | |
395 | =item on_osc_seq $term, $string |
535 | =item on_osc_seq_perl $term, $string |
396 | |
536 | |
397 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
537 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
398 | operating system command) is processed. Cursor position and other state |
538 | operating system command) is processed. Cursor position and other state |
399 | information is up-to-date when this happens. For interoperability, the |
539 | information is up-to-date when this happens. For interoperability, the |
400 | string should start with the extension name and a colon, to distinguish |
540 | string should start with the extension name and a colon, to distinguish |
401 | it from commands for other extensions, and this might be enforced in the |
541 | it from commands for other extensions, and this might be enforced in the |
402 | future. |
542 | future. |
403 | |
543 | |
404 | Be careful not ever to trust (in a security sense) the data you receive, |
544 | Be careful not ever to trust (in a security sense) the data you receive, |
405 | as its source can not easily be controleld (e-mail content, messages from |
545 | as its source can not easily be controlled (e-mail content, messages from |
406 | other users on the same system etc.). |
546 | other users on the same system etc.). |
407 | |
547 | |
408 | =item on_add_lines $term, $string |
548 | =item on_add_lines $term, $string |
409 | |
549 | |
410 | Called whenever text is about to be output, with the text as argument. You |
550 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
441 | |
581 | |
442 | =item on_refresh_end $term |
582 | =item on_refresh_end $term |
443 | |
583 | |
444 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
584 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
445 | |
585 | |
446 | =item on_keyboard_command $term, $string |
586 | =item on_user_command $term, $string |
447 | |
587 | |
448 | Called whenever the user presses a key combination that has a |
588 | Called whenever a user-configured event is being activated (e.g. via |
449 | C<perl:string> action bound to it (see description of the B<keysym> |
589 | a C<perl:string> action bound to a key, see description of the B<keysym> |
450 | resource in the @@RXVT_NAME@@(1) manpage). |
590 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
591 | |
|
|
592 | The event is simply the action string. This interface is assumed to change |
|
|
593 | slightly in the future. |
|
|
594 | |
|
|
595 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
596 | |
|
|
597 | Called just after the new window size has been calculated, but before |
|
|
598 | windows are actually being resized or hints are being set. If this hook |
|
|
599 | returns TRUE, setting of the window hints is being skipped. |
451 | |
600 | |
452 | =item on_x_event $term, $event |
601 | =item on_x_event $term, $event |
453 | |
602 | |
454 | Called on every X event received on the vt window (and possibly other |
603 | Called on every X event received on the vt window (and possibly other |
455 | windows). Should only be used as a last resort. Most event structure |
604 | windows). Should only be used as a last resort. Most event structure |
456 | members are not passed. |
605 | members are not passed. |
457 | |
606 | |
|
|
607 | =item on_root_event $term, $event |
|
|
608 | |
|
|
609 | Like C<on_x_event>, but is called for events on the root window. |
|
|
610 | |
458 | =item on_focus_in $term |
611 | =item on_focus_in $term |
459 | |
612 | |
460 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
613 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
461 | does focus in processing. |
614 | does focus in processing. |
462 | |
615 | |
463 | =item on_focus_out $term |
616 | =item on_focus_out $term |
464 | |
617 | |
465 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
618 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
466 | focus out processing. |
619 | focus out processing. |
467 | |
620 | |
468 | =item on_configure_notify $term, $event |
621 | =item on_configure_notify $term, $event |
|
|
622 | |
|
|
623 | =item on_property_notify $term, $event |
469 | |
624 | |
470 | =item on_key_press $term, $event, $keysym, $octets |
625 | =item on_key_press $term, $event, $keysym, $octets |
471 | |
626 | |
472 | =item on_key_release $term, $event, $keysym |
627 | =item on_key_release $term, $event, $keysym |
473 | |
628 | |
… | |
… | |
483 | |
638 | |
484 | Called whenever the corresponding X event is received for the terminal If |
639 | Called whenever the corresponding X event is received for the terminal If |
485 | the hook returns true, then the even will be ignored by rxvt-unicode. |
640 | the hook returns true, then the even will be ignored by rxvt-unicode. |
486 | |
641 | |
487 | The event is a hash with most values as named by Xlib (see the XEvent |
642 | The event is a hash with most values as named by Xlib (see the XEvent |
488 | manpage), with the additional members C<row> and C<col>, which are the row |
643 | manpage), with the additional members C<row> and C<col>, which are the |
489 | and column under the mouse cursor. |
644 | (real, not screen-based) row and column under the mouse cursor. |
490 | |
645 | |
491 | C<on_key_press> additionally receives the string rxvt-unicode would |
646 | C<on_key_press> additionally receives the string rxvt-unicode would |
492 | output, if any, in locale-specific encoding. |
647 | output, if any, in locale-specific encoding. |
493 | |
648 | |
494 | subwindow. |
649 | subwindow. |
|
|
650 | |
|
|
651 | =item on_client_message $term, $event |
|
|
652 | |
|
|
653 | =item on_wm_protocols $term, $event |
|
|
654 | |
|
|
655 | =item on_wm_delete_window $term, $event |
|
|
656 | |
|
|
657 | Called when various types of ClientMessage events are received (all with |
|
|
658 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
495 | |
659 | |
496 | =back |
660 | =back |
497 | |
661 | |
498 | =cut |
662 | =cut |
499 | |
663 | |
… | |
… | |
516 | our $LIBDIR; |
680 | our $LIBDIR; |
517 | our $RESNAME; |
681 | our $RESNAME; |
518 | our $RESCLASS; |
682 | our $RESCLASS; |
519 | our $RXVTNAME; |
683 | our $RXVTNAME; |
520 | |
684 | |
|
|
685 | our $NOCHAR = chr 0xffff; |
|
|
686 | |
521 | =head2 Variables in the C<urxvt> Package |
687 | =head2 Variables in the C<urxvt> Package |
522 | |
688 | |
523 | =over 4 |
689 | =over 4 |
524 | |
690 | |
525 | =item $urxvt::LIBDIR |
691 | =item $urxvt::LIBDIR |
… | |
… | |
540 | The current terminal. This variable stores the current C<urxvt::term> |
706 | The current terminal. This variable stores the current C<urxvt::term> |
541 | object, whenever a callback/hook is executing. |
707 | object, whenever a callback/hook is executing. |
542 | |
708 | |
543 | =item @urxvt::TERM_INIT |
709 | =item @urxvt::TERM_INIT |
544 | |
710 | |
545 | All coderefs in this array will be called as methods of the next newly |
711 | All code references in this array will be called as methods of the next newly |
546 | created C<urxvt::term> object (during the C<on_init> phase). The array |
712 | created C<urxvt::term> object (during the C<on_init> phase). The array |
547 | gets cleared before the codereferences that were in it are being executed, |
713 | gets cleared before the code references that were in it are being executed, |
548 | so coderefs can push themselves onto it again if they so desire. |
714 | so references can push themselves onto it again if they so desire. |
549 | |
715 | |
550 | This complements to the perl-eval commandline option, but gets executed |
716 | This complements to the perl-eval command line option, but gets executed |
551 | first. |
717 | first. |
552 | |
718 | |
553 | =item @urxvt::TERM_EXT |
719 | =item @urxvt::TERM_EXT |
554 | |
720 | |
555 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
721 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
576 | |
742 | |
577 | Using this function has the advantage that its output ends up in the |
743 | Using this function has the advantage that its output ends up in the |
578 | correct place, e.g. on stderr of the connecting urxvtc client. |
744 | correct place, e.g. on stderr of the connecting urxvtc client. |
579 | |
745 | |
580 | Messages have a size limit of 1023 bytes currently. |
746 | Messages have a size limit of 1023 bytes currently. |
|
|
747 | |
|
|
748 | =item @terms = urxvt::termlist |
|
|
749 | |
|
|
750 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
751 | whether they are started, being destroyed etc., so be careful. Only term |
|
|
752 | objects that have perl extensions attached will be returned (because there |
|
|
753 | is no urxvt::term objet associated with others). |
581 | |
754 | |
582 | =item $time = urxvt::NOW |
755 | =item $time = urxvt::NOW |
583 | |
756 | |
584 | Returns the "current time" (as per the event loop). |
757 | Returns the "current time" (as per the event loop). |
585 | |
758 | |
… | |
… | |
643 | Return the foreground/background colour index, respectively. |
816 | Return the foreground/background colour index, respectively. |
644 | |
817 | |
645 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
818 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
646 | |
819 | |
647 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
820 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
821 | |
|
|
822 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
648 | |
823 | |
649 | Replace the foreground/background colour in the rendition mask with the |
824 | Replace the foreground/background colour in the rendition mask with the |
650 | specified one. |
825 | specified one. |
651 | |
826 | |
652 | =item $value = urxvt::GET_CUSTOM $rend |
827 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
671 | unless $msg =~ /\n$/; |
846 | unless $msg =~ /\n$/; |
672 | urxvt::warn ($msg); |
847 | urxvt::warn ($msg); |
673 | }; |
848 | }; |
674 | } |
849 | } |
675 | |
850 | |
|
|
851 | no warnings 'utf8'; |
|
|
852 | |
676 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
853 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
677 | |
854 | |
678 | sub verbose { |
855 | sub verbose { |
679 | my ($level, $msg) = @_; |
856 | my ($level, $msg) = @_; |
680 | warn "$msg\n" if $level <= $verbosity; |
857 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
696 | |
873 | |
697 | open my $fh, "<:raw", $path |
874 | open my $fh, "<:raw", $path |
698 | or die "$path: $!"; |
875 | or die "$path: $!"; |
699 | |
876 | |
700 | my $source = |
877 | my $source = |
701 | "package $pkg; use strict; use utf8;\n" |
878 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
702 | . "#line 1 \"$path\"\n{\n" |
879 | . "#line 1 \"$path\"\n{\n" |
703 | . (do { local $/; <$fh> }) |
880 | . (do { local $/; <$fh> }) |
704 | . "\n};\n1"; |
881 | . "\n};\n1"; |
705 | |
882 | |
706 | eval $source |
883 | eval $source |
… | |
… | |
731 | $TERM->register_package ($_) for @pkg; |
908 | $TERM->register_package ($_) for @pkg; |
732 | } |
909 | } |
733 | |
910 | |
734 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
911 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
735 | if ($_ eq "default") { |
912 | if ($_ eq "default") { |
736 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
913 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
737 | } elsif (/^-(.*)$/) { |
914 | } elsif (/^-(.*)$/) { |
738 | delete $ext_arg{$1}; |
915 | delete $ext_arg{$1}; |
739 | } elsif (/^([^<]+)<(.*)>$/) { |
916 | } elsif (/^([^<]+)<(.*)>$/) { |
740 | push @{ $ext_arg{$1} }, $2; |
917 | push @{ $ext_arg{$1} }, $2; |
741 | } else { |
918 | } else { |
742 | $ext_arg{$_} ||= []; |
919 | $ext_arg{$_} ||= []; |
743 | } |
920 | } |
744 | } |
921 | } |
745 | |
922 | |
746 | while (my ($ext, $argv) = each %ext_arg) { |
923 | for my $ext (sort keys %ext_arg) { |
747 | my @files = grep -f $_, map "$_/$ext", @dirs; |
924 | my @files = grep -f $_, map "$_/$ext", @dirs; |
748 | |
925 | |
749 | if (@files) { |
926 | if (@files) { |
750 | $TERM->register_package (extension_package $files[0], $argv); |
927 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
751 | } else { |
928 | } else { |
752 | warn "perl extension '$ext' not found in perl library search path\n"; |
929 | warn "perl extension '$ext' not found in perl library search path\n"; |
753 | } |
930 | } |
754 | } |
931 | } |
755 | |
932 | |
… | |
… | |
761 | |
938 | |
762 | if (my $cb = $TERM->{_hook}[$htype]) { |
939 | if (my $cb = $TERM->{_hook}[$htype]) { |
763 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
940 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
764 | if $verbosity >= 10; |
941 | if $verbosity >= 10; |
765 | |
942 | |
766 | keys %$cb; |
943 | for my $pkg (keys %$cb) { |
767 | |
|
|
768 | while (my ($pkg, $cb) = each %$cb) { |
|
|
769 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
944 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
770 | $retval ||= $retval_; |
945 | $retval ||= $retval_; |
771 | |
946 | |
772 | if ($@) { |
947 | if ($@) { |
773 | $TERM->ungrab; # better to lose the grab than the session |
948 | $TERM->ungrab; # better to lose the grab than the session |
774 | warn $@; |
949 | warn $@; |
… | |
… | |
786 | # clear package |
961 | # clear package |
787 | %$TERM = (); |
962 | %$TERM = (); |
788 | } |
963 | } |
789 | |
964 | |
790 | $retval |
965 | $retval |
|
|
966 | } |
|
|
967 | |
|
|
968 | sub SET_COLOR($$$) { |
|
|
969 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
791 | } |
970 | } |
792 | |
971 | |
793 | # urxvt::term::extension |
972 | # urxvt::term::extension |
794 | |
973 | |
795 | package urxvt::term::extension; |
974 | package urxvt::term::extension; |
… | |
… | |
964 | hash which defines the environment of the new terminal. |
1143 | hash which defines the environment of the new terminal. |
965 | |
1144 | |
966 | Croaks (and probably outputs an error message) if the new instance |
1145 | Croaks (and probably outputs an error message) if the new instance |
967 | couldn't be created. Returns C<undef> if the new instance didn't |
1146 | couldn't be created. Returns C<undef> if the new instance didn't |
968 | initialise perl, and the terminal object otherwise. The C<init> and |
1147 | initialise perl, and the terminal object otherwise. The C<init> and |
969 | C<start> hooks will be called during this call. |
1148 | C<start> hooks will be called before this call returns, and are free to |
|
|
1149 | refer to global data (which is race free). |
970 | |
1150 | |
971 | =cut |
1151 | =cut |
972 | |
1152 | |
973 | sub new { |
1153 | sub new { |
974 | my ($class, $env, @args) = @_; |
1154 | my ($class, $env, @args) = @_; |
975 | |
1155 | |
|
|
1156 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1157 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1158 | |
976 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1159 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
977 | } |
1160 | } |
978 | |
1161 | |
979 | =item $term->destroy |
1162 | =item $term->destroy |
980 | |
1163 | |
981 | Destroy the terminal object (close the window, free resources |
1164 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1011 | |
1194 | |
1012 | Returns true if the option specified by C<$optval> is enabled, and |
1195 | Returns true if the option specified by C<$optval> is enabled, and |
1013 | optionally change it. All option values are stored by name in the hash |
1196 | optionally change it. All option values are stored by name in the hash |
1014 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1197 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1015 | |
1198 | |
1016 | Here is a a likely non-exhaustive list of option names, please see the |
1199 | Here is a likely non-exhaustive list of option names, please see the |
1017 | source file F</src/optinc.h> to see the actual list: |
1200 | source file F</src/optinc.h> to see the actual list: |
1018 | |
1201 | |
1019 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1202 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1020 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1203 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1021 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1204 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1038 | likely change). |
1221 | likely change). |
1039 | |
1222 | |
1040 | Please note that resource strings will currently only be freed when the |
1223 | Please note that resource strings will currently only be freed when the |
1041 | terminal is destroyed, so changing options frequently will eat memory. |
1224 | terminal is destroyed, so changing options frequently will eat memory. |
1042 | |
1225 | |
1043 | Here is a a likely non-exhaustive list of resource names, not all of which |
1226 | Here is a likely non-exhaustive list of resource names, not all of which |
1044 | are supported in every build, please see the source file F</src/rsinc.h> |
1227 | are supported in every build, please see the source file F</src/rsinc.h> |
1045 | to see the actual list: |
1228 | to see the actual list: |
1046 | |
1229 | |
1047 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1230 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1048 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1231 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1238 | |
1421 | |
1239 | Normally its not a good idea to use this function, as programs might be |
1422 | Normally its not a good idea to use this function, as programs might be |
1240 | confused by changes in cursor position or scrolling. Its useful inside a |
1423 | confused by changes in cursor position or scrolling. Its useful inside a |
1241 | C<on_add_lines> hook, though. |
1424 | C<on_add_lines> hook, though. |
1242 | |
1425 | |
|
|
1426 | =item $term->scr_change_screen ($screen) |
|
|
1427 | |
|
|
1428 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1429 | |
1243 | =item $term->cmd_parse ($octets) |
1430 | =item $term->cmd_parse ($octets) |
1244 | |
1431 | |
1245 | Similar to C<scr_add_lines>, but the argument must be in the |
1432 | Similar to C<scr_add_lines>, but the argument must be in the |
1246 | locale-specific encoding of the terminal and can contain command sequences |
1433 | locale-specific encoding of the terminal and can contain command sequences |
1247 | (escape codes) that will be interpreted. |
1434 | (escape codes) that will be interpreted. |
… | |
… | |
1257 | Replaces the event mask of the pty watcher by the given event mask. Can |
1444 | Replaces the event mask of the pty watcher by the given event mask. Can |
1258 | be used to suppress input and output handling to the pty/tty. See the |
1445 | be used to suppress input and output handling to the pty/tty. See the |
1259 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1446 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1260 | the previous value. |
1447 | the previous value. |
1261 | |
1448 | |
|
|
1449 | =item $fd = $term->pty_fd |
|
|
1450 | |
|
|
1451 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1452 | is used. |
|
|
1453 | |
1262 | =item $windowid = $term->parent |
1454 | =item $windowid = $term->parent |
1263 | |
1455 | |
1264 | Return the window id of the toplevel window. |
1456 | Return the window id of the toplevel window. |
1265 | |
1457 | |
1266 | =item $windowid = $term->vt |
1458 | =item $windowid = $term->vt |
… | |
… | |
1272 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1464 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1273 | to receive pointer events all the times: |
1465 | to receive pointer events all the times: |
1274 | |
1466 | |
1275 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1467 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1276 | |
1468 | |
|
|
1469 | =item $term->focus_in |
|
|
1470 | |
|
|
1471 | =item $term->focus_out |
|
|
1472 | |
|
|
1473 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1474 | |
|
|
1475 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1476 | |
|
|
1477 | Deliver various fake events to to terminal. |
|
|
1478 | |
1277 | =item $window_width = $term->width |
1479 | =item $window_width = $term->width |
1278 | |
1480 | |
1279 | =item $window_height = $term->height |
1481 | =item $window_height = $term->height |
1280 | |
1482 | |
1281 | =item $font_width = $term->fwidth |
1483 | =item $font_width = $term->fwidth |
… | |
… | |
1311 | =item $env = $term->env |
1513 | =item $env = $term->env |
1312 | |
1514 | |
1313 | Returns a copy of the environment in effect for the terminal as a hashref |
1515 | Returns a copy of the environment in effect for the terminal as a hashref |
1314 | similar to C<\%ENV>. |
1516 | similar to C<\%ENV>. |
1315 | |
1517 | |
|
|
1518 | =item @envv = $term->envv |
|
|
1519 | |
|
|
1520 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1521 | |
|
|
1522 | =item @argv = $term->argv |
|
|
1523 | |
|
|
1524 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1525 | includes the program name as first element. |
|
|
1526 | |
1316 | =cut |
1527 | =cut |
1317 | |
1528 | |
1318 | sub env { |
1529 | sub env { |
1319 | if (my $env = $_[0]->_env) { |
|
|
1320 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1530 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1321 | } else { |
|
|
1322 | +{ %ENV } |
|
|
1323 | } |
|
|
1324 | } |
1531 | } |
1325 | |
1532 | |
1326 | =item $modifiermask = $term->ModLevel3Mask |
1533 | =item $modifiermask = $term->ModLevel3Mask |
1327 | |
1534 | |
1328 | =item $modifiermask = $term->ModMetaMask |
1535 | =item $modifiermask = $term->ModMetaMask |
1329 | |
1536 | |
1330 | =item $modifiermask = $term->ModNumLockMask |
1537 | =item $modifiermask = $term->ModNumLockMask |
1331 | |
1538 | |
1332 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1539 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1333 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1540 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1541 | |
|
|
1542 | =item $screen = $term->current_screen |
|
|
1543 | |
|
|
1544 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1545 | |
|
|
1546 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1547 | |
|
|
1548 | Returns whether the cursor is currently hidden or not. |
1334 | |
1549 | |
1335 | =item $view_start = $term->view_start ([$newvalue]) |
1550 | =item $view_start = $term->view_start ([$newvalue]) |
1336 | |
1551 | |
1337 | Returns the row number of the topmost displayed line. Maximum value is |
1552 | Returns the row number of the topmost displayed line. Maximum value is |
1338 | C<0>, which displays the normal terminal contents. Lower values scroll |
1553 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1358 | line, starting at column C<$start_col> (default C<0>), which is useful |
1573 | line, starting at column C<$start_col> (default C<0>), which is useful |
1359 | to replace only parts of a line. The font index in the rendition will |
1574 | to replace only parts of a line. The font index in the rendition will |
1360 | automatically be updated. |
1575 | automatically be updated. |
1361 | |
1576 | |
1362 | C<$text> is in a special encoding: tabs and wide characters that use more |
1577 | C<$text> is in a special encoding: tabs and wide characters that use more |
1363 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1578 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1364 | (C<chr 65535>). Characters with combining characters and other characters |
1579 | characters. Characters with combining characters and other characters that |
1365 | that do not fit into the normal tetx encoding will be replaced with |
1580 | do not fit into the normal tetx encoding will be replaced with characters |
1366 | characters in the private use area. |
1581 | in the private use area. |
1367 | |
1582 | |
1368 | You have to obey this encoding when changing text. The advantage is |
1583 | You have to obey this encoding when changing text. The advantage is |
1369 | that C<substr> and similar functions work on screen cells and not on |
1584 | that C<substr> and similar functions work on screen cells and not on |
1370 | characters. |
1585 | characters. |
1371 | |
1586 | |
… | |
… | |
1515 | where one character corresponds to one screen cell. See |
1730 | where one character corresponds to one screen cell. See |
1516 | C<< $term->ROW_t >> for details. |
1731 | C<< $term->ROW_t >> for details. |
1517 | |
1732 | |
1518 | =item $string = $term->special_decode $text |
1733 | =item $string = $term->special_decode $text |
1519 | |
1734 | |
1520 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1735 | Converts rxvt-unicodes text representation into a perl string. See |
1521 | C<< $term->ROW_t >> for details. |
1736 | C<< $term->ROW_t >> for details. |
1522 | |
1737 | |
1523 | =item $success = $term->grab_button ($button, $modifiermask) |
1738 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1524 | |
1739 | |
|
|
1740 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1741 | |
1525 | Registers a synchronous button grab. See the XGrabButton manpage. |
1742 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1743 | manpage. |
1526 | |
1744 | |
1527 | =item $success = $term->grab ($eventtime[, $sync]) |
1745 | =item $success = $term->grab ($eventtime[, $sync]) |
1528 | |
1746 | |
1529 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1747 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1530 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1748 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1531 | |
1749 | |
1532 | =item $term->allow_events_async |
1750 | =item $term->allow_events_async |
1533 | |
1751 | |
1534 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1752 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1535 | |
1753 | |
… | |
… | |
1545 | =item $term->ungrab |
1763 | =item $term->ungrab |
1546 | |
1764 | |
1547 | Calls XUngrab for the most recent grab. Is called automatically on |
1765 | Calls XUngrab for the most recent grab. Is called automatically on |
1548 | evaluation errors, as it is better to lose the grab in the error case as |
1766 | evaluation errors, as it is better to lose the grab in the error case as |
1549 | the session. |
1767 | the session. |
|
|
1768 | |
|
|
1769 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1770 | |
|
|
1771 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1772 | |
|
|
1773 | =item @atoms = $term->XListProperties ($window) |
|
|
1774 | |
|
|
1775 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1776 | |
|
|
1777 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1778 | |
|
|
1779 | =item $term->XDeleteProperty ($window, $property) |
|
|
1780 | |
|
|
1781 | =item $window = $term->DefaultRootWindow |
|
|
1782 | |
|
|
1783 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1784 | |
|
|
1785 | =item $term->XMapWindow ($window) |
|
|
1786 | |
|
|
1787 | =item $term->XUnmapWindow ($window) |
|
|
1788 | |
|
|
1789 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1790 | |
|
|
1791 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1792 | |
|
|
1793 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1794 | |
|
|
1795 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1796 | the source of the display, otherwise those functions map more-or-less |
|
|
1797 | directory onto the X functions of the same name. |
1550 | |
1798 | |
1551 | =back |
1799 | =back |
1552 | |
1800 | |
1553 | =cut |
1801 | =cut |
1554 | |
1802 | |
… | |
… | |
1618 | my ($self, $text, $cb) = @_; |
1866 | my ($self, $text, $cb) = @_; |
1619 | |
1867 | |
1620 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1868 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1621 | } |
1869 | } |
1622 | |
1870 | |
1623 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1871 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1624 | |
1872 | |
1625 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1873 | Adds a toggle/checkbox item to the popup. The callback gets called |
1626 | whenever it gets toggled, with a boolean indicating its value as its first |
1874 | whenever it gets toggled, with a boolean indicating its new value as its |
1627 | argument. |
1875 | first argument. |
1628 | |
1876 | |
1629 | =cut |
1877 | =cut |
1630 | |
1878 | |
1631 | sub add_toggle { |
1879 | sub add_toggle { |
1632 | my ($self, $text, $cb, $value) = @_; |
1880 | my ($self, $text, $value, $cb) = @_; |
1633 | |
1881 | |
1634 | my $item; $item = { |
1882 | my $item; $item = { |
1635 | type => "button", |
1883 | type => "button", |
1636 | text => " $text", |
1884 | text => " $text", |
1637 | value => $value, |
1885 | value => $value, |
… | |
… | |
1772 | Set the callback to be called when io events are triggered. C<$reventmask> |
2020 | Set the callback to be called when io events are triggered. C<$reventmask> |
1773 | is a bitset as described in the C<events> method. |
2021 | is a bitset as described in the C<events> method. |
1774 | |
2022 | |
1775 | =item $iow = $iow->fd ($fd) |
2023 | =item $iow = $iow->fd ($fd) |
1776 | |
2024 | |
1777 | Set the filedescriptor (not handle) to watch. |
2025 | Set the file descriptor (not handle) to watch. |
1778 | |
2026 | |
1779 | =item $iow = $iow->events ($eventmask) |
2027 | =item $iow = $iow->events ($eventmask) |
1780 | |
2028 | |
1781 | Set the event mask to watch. The only allowed values are |
2029 | Set the event mask to watch. The only allowed values are |
1782 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2030 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
… | |
… | |
1786 | |
2034 | |
1787 | Start watching for requested events on the given handle. |
2035 | Start watching for requested events on the given handle. |
1788 | |
2036 | |
1789 | =item $iow = $iow->stop |
2037 | =item $iow = $iow->stop |
1790 | |
2038 | |
1791 | Stop watching for events on the given filehandle. |
2039 | Stop watching for events on the given file handle. |
|
|
2040 | |
|
|
2041 | =back |
|
|
2042 | |
|
|
2043 | =head2 The C<urxvt::iw> Class |
|
|
2044 | |
|
|
2045 | This class implements idle watchers, that get called automatically when |
|
|
2046 | the process is idle. They should return as fast as possible, after doing |
|
|
2047 | some useful work. |
|
|
2048 | |
|
|
2049 | =over 4 |
|
|
2050 | |
|
|
2051 | =item $iw = new urxvt::iw |
|
|
2052 | |
|
|
2053 | Create a new idle watcher object in stopped state. |
|
|
2054 | |
|
|
2055 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
2056 | |
|
|
2057 | Set the callback to be called when the watcher triggers. |
|
|
2058 | |
|
|
2059 | =item $timer = $timer->start |
|
|
2060 | |
|
|
2061 | Start the watcher. |
|
|
2062 | |
|
|
2063 | =item $timer = $timer->stop |
|
|
2064 | |
|
|
2065 | Stop the watcher. |
|
|
2066 | |
|
|
2067 | =back |
|
|
2068 | |
|
|
2069 | =head2 The C<urxvt::pw> Class |
|
|
2070 | |
|
|
2071 | This class implements process watchers. They create an event whenever a |
|
|
2072 | process exits, after which they stop automatically. |
|
|
2073 | |
|
|
2074 | my $pid = fork; |
|
|
2075 | ... |
|
|
2076 | $term->{pw} = urxvt::pw |
|
|
2077 | ->new |
|
|
2078 | ->start ($pid) |
|
|
2079 | ->cb (sub { |
|
|
2080 | my ($pw, $exit_status) = @_; |
|
|
2081 | ... |
|
|
2082 | }); |
|
|
2083 | |
|
|
2084 | =over 4 |
|
|
2085 | |
|
|
2086 | =item $pw = new urxvt::pw |
|
|
2087 | |
|
|
2088 | Create a new process watcher in stopped state. |
|
|
2089 | |
|
|
2090 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
2091 | |
|
|
2092 | Set the callback to be called when the timer triggers. |
|
|
2093 | |
|
|
2094 | =item $pw = $timer->start ($pid) |
|
|
2095 | |
|
|
2096 | Tells the watcher to start watching for process C<$pid>. |
|
|
2097 | |
|
|
2098 | =item $pw = $pw->stop |
|
|
2099 | |
|
|
2100 | Stop the watcher. |
1792 | |
2101 | |
1793 | =back |
2102 | =back |
1794 | |
2103 | |
1795 | =head1 ENVIRONMENT |
2104 | =head1 ENVIRONMENT |
1796 | |
2105 | |
… | |
… | |
1805 | |
2114 | |
1806 | =item >= 3 - script loading and management |
2115 | =item >= 3 - script loading and management |
1807 | |
2116 | |
1808 | =item >=10 - all called hooks |
2117 | =item >=10 - all called hooks |
1809 | |
2118 | |
1810 | =item >=11 - hook reutrn values |
2119 | =item >=11 - hook return values |
1811 | |
2120 | |
1812 | =back |
2121 | =back |
1813 | |
2122 | |
1814 | =head1 AUTHOR |
2123 | =head1 AUTHOR |
1815 | |
2124 | |