… | |
… | |
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: |
… | |
… | |
86 | |
93 | |
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. |
|
|
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 | }; |
91 | |
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 | evaluation, 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 | |
… | |
… | |
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. |
166 | |
221 | |
167 | =item readline |
|
|
168 | |
|
|
169 | A support package that tries to make editing with readline easier. At the |
|
|
170 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
171 | move the text cursor to this position. It does so by generating as many |
|
|
172 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
173 | for programs that correctly support wide characters). |
|
|
174 | |
|
|
175 | It only works when clicking into the same line (possibly extended over |
|
|
176 | multiple rows) as the text cursor and on the primary screen, to reduce the |
|
|
177 | risk of misinterpreting. The normal selection isn't disabled, so quick |
|
|
178 | successive clicks might interfere with selection creation in harmless |
|
|
179 | ways. |
|
|
180 | |
|
|
181 | =item tabbed |
222 | =item tabbed |
182 | |
223 | |
183 | This transforms the terminal into a tabbar with additional terminals, that |
224 | This transforms the terminal into a tabbar with additional terminals, that |
184 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
225 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
185 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
226 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
186 | button per tab. |
227 | button per tab. |
187 | |
228 | |
188 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
229 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
189 | B<Shift-Right> will switch to the tab left or right of the current one, |
230 | B<Shift-Right> will switch to the tab left or right of the current one, |
190 | while B<Shift-Down> creates a new tab. |
231 | while B<Shift-Down> creates a new tab. |
191 | |
232 | |
192 | =item mark-urls |
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): |
193 | |
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. |
|
|
244 | |
|
|
245 | =item matcher |
|
|
246 | |
194 | 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 text |
195 | make them clickable. When middle-clicked, the program specified in the |
248 | matching a certain pattern and make it clickable. When clicked with the |
196 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
249 | mouse button specified in the C<matcher.button> resource (default 2, or |
197 | the URL as first argument. |
250 | middle), the program specified in the C<matcher.launcher> resource |
|
|
251 | (default, the C<urlLauncher> resource, C<sensible-browser>) will be started |
|
|
252 | with the matched text as first argument. The default configuration is |
|
|
253 | suitable for matching URLs and launching a web browser, like the |
|
|
254 | former "mark-urls" extension. |
|
|
255 | |
|
|
256 | The default pattern to match URLs can be overridden with the |
|
|
257 | C<matcher.pattern.0> resource, and additional patterns can be specified |
|
|
258 | with numbered patterns, in a manner similar to the "selection" extension. |
|
|
259 | The launcher can also be overridden on a per-pattern basis. |
|
|
260 | |
|
|
261 | Example configuration: |
|
|
262 | |
|
|
263 | URxvt.perl-ext: default,matcher |
|
|
264 | URxvt.urlLauncher: sensible-browser |
|
|
265 | URxvt.keysym.C-Delete: perl:matcher |
|
|
266 | URxvt.matcher.button: 1 |
|
|
267 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
268 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
269 | URxvt.matcher.launcher.2: gvim +$2 $1 |
|
|
270 | |
|
|
271 | =item xim-onthespot |
|
|
272 | |
|
|
273 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
274 | not work perfectly, and some input methods don't seem to work well with |
|
|
275 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
276 | kinput2. |
|
|
277 | |
|
|
278 | You enable it by specifying this extension and a preedit style of |
|
|
279 | C<OnTheSpot>, i.e.: |
|
|
280 | |
|
|
281 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
282 | |
|
|
283 | =item kuake<hotkey> |
|
|
284 | |
|
|
285 | A very primitive quake-console-like extension. It was inspired by a |
|
|
286 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
287 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
288 | will show or hide itself. Another press of the accelerator key will hide |
|
|
289 | or show it again. |
|
|
290 | |
|
|
291 | Initially, the window will not be shown when using this extension. |
|
|
292 | |
|
|
293 | This is useful if you need a single terminal thats not using any desktop |
|
|
294 | space most of the time but is quickly available at the press of a key. |
|
|
295 | |
|
|
296 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
297 | extension will actually grab a physical key just for this function. |
|
|
298 | |
|
|
299 | If you want a quake-like animation, tell your window manager to do so |
|
|
300 | (fvwm can do it). |
198 | |
301 | |
199 | =item automove-background |
302 | =item automove-background |
200 | |
303 | |
201 | This is basically a one-line extension that dynamically changes the background pixmap offset |
304 | This is basically a very small extension that dynamically changes the |
202 | to the window position, in effect creating the same effect as pseudo transparency with |
305 | background pixmap offset to the window position, in effect creating the |
203 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
306 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
307 | supported in this mode. Example: |
204 | |
308 | |
205 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
309 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
206 | |
310 | |
207 | =item block-graphics-to-ascii |
311 | =item block-graphics-to-ascii |
208 | |
312 | |
209 | A not very useful example of filtering all text output to the terminal, |
313 | A not very useful example of filtering all text output to the terminal |
210 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
314 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
211 | similar-looking ascii character. |
315 | similar-looking ascii character. |
212 | |
316 | |
213 | =item digital-clock |
317 | =item digital-clock |
214 | |
318 | |
215 | Displays a digital clock using the built-in overlay. |
319 | Displays a digital clock using the built-in overlay. |
216 | |
320 | |
217 | =item example-refresh-hooks |
321 | =item remote-clipboard |
218 | |
322 | |
219 | Displays a very simple digital clock in the upper right corner of the |
323 | Somewhat of a misnomer, this extension adds two menu entries to the |
220 | window. Illustrates overwriting the refresh callbacks to create your own |
324 | selection popup that allows one ti run external commands to store the |
221 | overlays or changes. |
325 | selection somewhere and fetch it again. |
|
|
326 | |
|
|
327 | We use it to implement a "distributed selection mechanism", which just |
|
|
328 | means that one command uploads the file to a remote server, and another |
|
|
329 | reads it. |
|
|
330 | |
|
|
331 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
332 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
333 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
334 | the selection data on STDOUT (also in UTF-8). |
|
|
335 | |
|
|
336 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
337 | |
|
|
338 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
339 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
222 | |
340 | |
223 | =item selection-pastebin |
341 | =item selection-pastebin |
224 | |
342 | |
225 | This is a little rarely useful extension that Uploads the selection as |
343 | This is a little rarely useful extension that Uploads the selection as |
226 | textfile to a remote site (or does other things). (The implementation is |
344 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
246 | After a successful upload the selection will be replaced by the text given |
364 | After a successful upload the selection will be replaced by the text given |
247 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
365 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
248 | for the filename): |
366 | for the filename): |
249 | |
367 | |
250 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
368 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
369 | |
|
|
370 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
371 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
372 | which works regardless of wether xrdb is used to parse the resource file |
|
|
373 | or not. |
|
|
374 | |
|
|
375 | =item example-refresh-hooks |
|
|
376 | |
|
|
377 | Displays a very simple digital clock in the upper right corner of the |
|
|
378 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
379 | overlays or changes. |
251 | |
380 | |
252 | =back |
381 | =back |
253 | |
382 | |
254 | =head1 API DOCUMENTATION |
383 | =head1 API DOCUMENTATION |
255 | |
384 | |
… | |
… | |
289 | |
418 | |
290 | =back |
419 | =back |
291 | |
420 | |
292 | =head2 Extension Objects |
421 | =head2 Extension Objects |
293 | |
422 | |
294 | Very perl extension is a perl class. A separate perl object is created |
423 | Every perl extension is a perl class. A separate perl object is created |
295 | for each terminal and each extension and passed as the first parameter to |
424 | for each terminal, and each terminal has its own set of extenion objects, |
296 | hooks. So extensions can use their C<$self> object without having to think |
425 | which are passed as the first parameter to hooks. So extensions can use |
297 | about other extensions, with the exception of methods and members that |
426 | their C<$self> object without having to think about clashes with other |
|
|
427 | extensions or other terminals, with the exception of methods and members |
298 | begin with an underscore character C<_>: these are reserved for internal |
428 | that begin with an underscore character C<_>: these are reserved for |
299 | use. |
429 | internal use. |
300 | |
430 | |
301 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
431 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
302 | C<urxvt::term> class on this object. |
432 | C<urxvt::term> class on this object. |
303 | |
433 | |
304 | It has the following methods and data members: |
434 | It has the following methods and data members: |
… | |
… | |
325 | =head2 Hooks |
455 | =head2 Hooks |
326 | |
456 | |
327 | The following subroutines can be declared in extension files, and will be |
457 | The following subroutines can be declared in extension files, and will be |
328 | called whenever the relevant event happens. |
458 | called whenever the relevant event happens. |
329 | |
459 | |
330 | The first argument passed to them is an extension oject as described in |
460 | The first argument passed to them is an extension object as described in |
331 | the in the C<Extension Objects> section. |
461 | the in the C<Extension Objects> section. |
332 | |
462 | |
333 | B<All> of these hooks must return a boolean value. If any of the called |
463 | B<All> of these hooks must return a boolean value. If any of the called |
334 | hooks returns true, then the event counts as being I<consumed>, and the |
464 | hooks returns true, then the event counts as being I<consumed>, and the |
335 | relevant action might not be carried out by the C++ code. |
465 | relevant action might not be carried out by the C++ code. |
… | |
… | |
348 | place. |
478 | place. |
349 | |
479 | |
350 | =item on_start $term |
480 | =item on_start $term |
351 | |
481 | |
352 | Called at the very end of initialisation of a new terminal, just before |
482 | Called at the very end of initialisation of a new terminal, just before |
353 | trying to map (display) the toplevel and returning to the mainloop. |
483 | trying to map (display) the toplevel and returning to the main loop. |
354 | |
484 | |
355 | =item on_destroy $term |
485 | =item on_destroy $term |
356 | |
486 | |
357 | Called whenever something tries to destroy terminal, before doing anything |
487 | Called whenever something tries to destroy terminal, when the terminal is |
358 | yet. If this hook returns true, then destruction is skipped, but this is |
488 | still fully functional (not for long, though). |
359 | rarely a good idea. |
|
|
360 | |
489 | |
361 | =item on_reset $term |
490 | =item on_reset $term |
362 | |
491 | |
363 | Called after the screen is "reset" for any reason, such as resizing or |
492 | Called after the screen is "reset" for any reason, such as resizing or |
364 | control sequences. Here is where you can react on changes to size-related |
493 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
386 | |
515 | |
387 | Called whenever a selection has been copied, but before the selection is |
516 | Called whenever a selection has been copied, but before the selection is |
388 | requested from the server. The selection text can be queried and changed |
517 | requested from the server. The selection text can be queried and changed |
389 | by calling C<< $term->selection >>. |
518 | by calling C<< $term->selection >>. |
390 | |
519 | |
391 | Returning a true value aborts selection grabbing. It will still be hilighted. |
520 | Returning a true value aborts selection grabbing. It will still be highlighted. |
392 | |
521 | |
393 | =item on_sel_extend $term |
522 | =item on_sel_extend $term |
394 | |
523 | |
395 | Called whenever the user tries to extend the selection (e.g. with a double |
524 | Called whenever the user tries to extend the selection (e.g. with a double |
396 | click) and is either supposed to return false (normal operation), or |
525 | click) and is either supposed to return false (normal operation), or |
397 | should extend the selection itelf and return true to suppress the built-in |
526 | should extend the selection itself and return true to suppress the built-in |
398 | processing. This can happen multiple times, as long as the callback |
527 | processing. This can happen multiple times, as long as the callback |
399 | returns true, it will be called on every further click by the user and is |
528 | returns true, it will be called on every further click by the user and is |
400 | supposed to enlarge the selection more and more, if possible. |
529 | supposed to enlarge the selection more and more, if possible. |
401 | |
530 | |
402 | See the F<selection> example extension. |
531 | See the F<selection> example extension. |
403 | |
532 | |
404 | =item on_view_change $term, $offset |
533 | =item on_view_change $term, $offset |
405 | |
534 | |
406 | Called whenever the view offset changes, i..e the user or program |
535 | Called whenever the view offset changes, i.e. the user or program |
407 | scrolls. Offset C<0> means display the normal terminal, positive values |
536 | scrolls. Offset C<0> means display the normal terminal, positive values |
408 | show this many lines of scrollback. |
537 | show this many lines of scrollback. |
409 | |
538 | |
410 | =item on_scroll_back $term, $lines, $saved |
539 | =item on_scroll_back $term, $lines, $saved |
411 | |
540 | |
… | |
… | |
415 | |
544 | |
416 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
545 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
417 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
546 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
418 | number of lines that will be in the scrollback buffer. |
547 | number of lines that will be in the scrollback buffer. |
419 | |
548 | |
|
|
549 | =item on_osc_seq $term, $op, $args |
|
|
550 | |
|
|
551 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
552 | behaviour. The default should be to return an empty list. A true value |
|
|
553 | suppresses execution of the request completely. Make sure you don't get |
|
|
554 | confused by recursive invocations when you output an osc sequence within |
|
|
555 | this callback. |
|
|
556 | |
|
|
557 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
558 | |
420 | =item on_osc_seq $term, $string |
559 | =item on_osc_seq_perl $term, $string |
421 | |
560 | |
422 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
561 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
423 | operating system command) is processed. Cursor position and other state |
562 | operating system command) is processed. Cursor position and other state |
424 | information is up-to-date when this happens. For interoperability, the |
563 | information is up-to-date when this happens. For interoperability, the |
425 | string should start with the extension name and a colon, to distinguish |
564 | string should start with the extension name and a colon, to distinguish |
426 | it from commands for other extensions, and this might be enforced in the |
565 | it from commands for other extensions, and this might be enforced in the |
427 | future. |
566 | future. |
428 | |
567 | |
429 | Be careful not ever to trust (in a security sense) the data you receive, |
568 | Be careful not ever to trust (in a security sense) the data you receive, |
430 | as its source can not easily be controleld (e-mail content, messages from |
569 | as its source can not easily be controlled (e-mail content, messages from |
431 | other users on the same system etc.). |
570 | other users on the same system etc.). |
432 | |
571 | |
433 | =item on_add_lines $term, $string |
572 | =item on_add_lines $term, $string |
434 | |
573 | |
435 | Called whenever text is about to be output, with the text as argument. You |
574 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
466 | |
605 | |
467 | =item on_refresh_end $term |
606 | =item on_refresh_end $term |
468 | |
607 | |
469 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
608 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
470 | |
609 | |
471 | =item on_keyboard_command $term, $string |
610 | =item on_user_command $term, $string |
472 | |
611 | |
473 | Called whenever the user presses a key combination that has a |
612 | Called whenever a user-configured event is being activated (e.g. via |
474 | C<perl:string> action bound to it (see description of the B<keysym> |
613 | a C<perl:string> action bound to a key, see description of the B<keysym> |
475 | resource in the @@RXVT_NAME@@(1) manpage). |
614 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
615 | |
|
|
616 | The event is simply the action string. This interface is assumed to change |
|
|
617 | slightly in the future. |
|
|
618 | |
|
|
619 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
620 | |
|
|
621 | Called just after the new window size has been calculated, but before |
|
|
622 | windows are actually being resized or hints are being set. If this hook |
|
|
623 | returns TRUE, setting of the window hints is being skipped. |
476 | |
624 | |
477 | =item on_x_event $term, $event |
625 | =item on_x_event $term, $event |
478 | |
626 | |
479 | Called on every X event received on the vt window (and possibly other |
627 | Called on every X event received on the vt window (and possibly other |
480 | windows). Should only be used as a last resort. Most event structure |
628 | windows). Should only be used as a last resort. Most event structure |
481 | members are not passed. |
629 | members are not passed. |
482 | |
630 | |
|
|
631 | =item on_root_event $term, $event |
|
|
632 | |
|
|
633 | Like C<on_x_event>, but is called for events on the root window. |
|
|
634 | |
483 | =item on_focus_in $term |
635 | =item on_focus_in $term |
484 | |
636 | |
485 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
637 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
486 | does focus in processing. |
638 | does focus in processing. |
487 | |
639 | |
488 | =item on_focus_out $term |
640 | =item on_focus_out $term |
489 | |
641 | |
490 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
642 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
491 | focus out processing. |
643 | focus out processing. |
492 | |
644 | |
493 | =item on_configure_notify $term, $event |
645 | =item on_configure_notify $term, $event |
494 | |
646 | |
495 | =item on_property_notify $term, $event |
647 | =item on_property_notify $term, $event |
… | |
… | |
552 | our $LIBDIR; |
704 | our $LIBDIR; |
553 | our $RESNAME; |
705 | our $RESNAME; |
554 | our $RESCLASS; |
706 | our $RESCLASS; |
555 | our $RXVTNAME; |
707 | our $RXVTNAME; |
556 | |
708 | |
557 | our $NOCHAR = chr 0xfffe; |
709 | our $NOCHAR = chr 0xffff; |
558 | |
710 | |
559 | =head2 Variables in the C<urxvt> Package |
711 | =head2 Variables in the C<urxvt> Package |
560 | |
712 | |
561 | =over 4 |
713 | =over 4 |
562 | |
714 | |
… | |
… | |
578 | The current terminal. This variable stores the current C<urxvt::term> |
730 | The current terminal. This variable stores the current C<urxvt::term> |
579 | object, whenever a callback/hook is executing. |
731 | object, whenever a callback/hook is executing. |
580 | |
732 | |
581 | =item @urxvt::TERM_INIT |
733 | =item @urxvt::TERM_INIT |
582 | |
734 | |
583 | All coderefs in this array will be called as methods of the next newly |
735 | All code references in this array will be called as methods of the next newly |
584 | created C<urxvt::term> object (during the C<on_init> phase). The array |
736 | created C<urxvt::term> object (during the C<on_init> phase). The array |
585 | gets cleared before the codereferences that were in it are being executed, |
737 | gets cleared before the code references that were in it are being executed, |
586 | so coderefs can push themselves onto it again if they so desire. |
738 | so references can push themselves onto it again if they so desire. |
587 | |
739 | |
588 | This complements to the perl-eval commandline option, but gets executed |
740 | This complements to the perl-eval command line option, but gets executed |
589 | first. |
741 | first. |
590 | |
742 | |
591 | =item @urxvt::TERM_EXT |
743 | =item @urxvt::TERM_EXT |
592 | |
744 | |
593 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
745 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
614 | |
766 | |
615 | Using this function has the advantage that its output ends up in the |
767 | Using this function has the advantage that its output ends up in the |
616 | correct place, e.g. on stderr of the connecting urxvtc client. |
768 | correct place, e.g. on stderr of the connecting urxvtc client. |
617 | |
769 | |
618 | Messages have a size limit of 1023 bytes currently. |
770 | Messages have a size limit of 1023 bytes currently. |
|
|
771 | |
|
|
772 | =item @terms = urxvt::termlist |
|
|
773 | |
|
|
774 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
775 | whether they are started, being destroyed etc., so be careful. Only term |
|
|
776 | objects that have perl extensions attached will be returned (because there |
|
|
777 | is no urxvt::term objet associated with others). |
619 | |
778 | |
620 | =item $time = urxvt::NOW |
779 | =item $time = urxvt::NOW |
621 | |
780 | |
622 | Returns the "current time" (as per the event loop). |
781 | Returns the "current time" (as per the event loop). |
623 | |
782 | |
… | |
… | |
681 | Return the foreground/background colour index, respectively. |
840 | Return the foreground/background colour index, respectively. |
682 | |
841 | |
683 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
842 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
684 | |
843 | |
685 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
844 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
845 | |
|
|
846 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
686 | |
847 | |
687 | Replace the foreground/background colour in the rendition mask with the |
848 | Replace the foreground/background colour in the rendition mask with the |
688 | specified one. |
849 | specified one. |
689 | |
850 | |
690 | =item $value = urxvt::GET_CUSTOM $rend |
851 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
709 | unless $msg =~ /\n$/; |
870 | unless $msg =~ /\n$/; |
710 | urxvt::warn ($msg); |
871 | urxvt::warn ($msg); |
711 | }; |
872 | }; |
712 | } |
873 | } |
713 | |
874 | |
|
|
875 | no warnings 'utf8'; |
|
|
876 | |
714 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
877 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
715 | |
878 | |
716 | sub verbose { |
879 | sub verbose { |
717 | my ($level, $msg) = @_; |
880 | my ($level, $msg) = @_; |
718 | warn "$msg\n" if $level <= $verbosity; |
881 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
734 | |
897 | |
735 | open my $fh, "<:raw", $path |
898 | open my $fh, "<:raw", $path |
736 | or die "$path: $!"; |
899 | or die "$path: $!"; |
737 | |
900 | |
738 | my $source = |
901 | my $source = |
739 | "package $pkg; use strict; use utf8;\n" |
902 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
740 | . "#line 1 \"$path\"\n{\n" |
903 | . "#line 1 \"$path\"\n{\n" |
741 | . (do { local $/; <$fh> }) |
904 | . (do { local $/; <$fh> }) |
742 | . "\n};\n1"; |
905 | . "\n};\n1"; |
743 | |
906 | |
744 | eval $source |
907 | eval $source |
… | |
… | |
769 | $TERM->register_package ($_) for @pkg; |
932 | $TERM->register_package ($_) for @pkg; |
770 | } |
933 | } |
771 | |
934 | |
772 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
935 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
773 | if ($_ eq "default") { |
936 | if ($_ eq "default") { |
774 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
937 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
775 | } elsif (/^-(.*)$/) { |
938 | } elsif (/^-(.*)$/) { |
776 | delete $ext_arg{$1}; |
939 | delete $ext_arg{$1}; |
777 | } elsif (/^([^<]+)<(.*)>$/) { |
940 | } elsif (/^([^<]+)<(.*)>$/) { |
778 | push @{ $ext_arg{$1} }, $2; |
941 | push @{ $ext_arg{$1} }, $2; |
779 | } else { |
942 | } else { |
780 | $ext_arg{$_} ||= []; |
943 | $ext_arg{$_} ||= []; |
781 | } |
944 | } |
782 | } |
945 | } |
783 | |
946 | |
784 | while (my ($ext, $argv) = each %ext_arg) { |
947 | for my $ext (sort keys %ext_arg) { |
785 | my @files = grep -f $_, map "$_/$ext", @dirs; |
948 | my @files = grep -f $_, map "$_/$ext", @dirs; |
786 | |
949 | |
787 | if (@files) { |
950 | if (@files) { |
788 | $TERM->register_package (extension_package $files[0], $argv); |
951 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
789 | } else { |
952 | } else { |
790 | warn "perl extension '$ext' not found in perl library search path\n"; |
953 | warn "perl extension '$ext' not found in perl library search path\n"; |
791 | } |
954 | } |
792 | } |
955 | } |
793 | |
956 | |
… | |
… | |
799 | |
962 | |
800 | if (my $cb = $TERM->{_hook}[$htype]) { |
963 | if (my $cb = $TERM->{_hook}[$htype]) { |
801 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
964 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
802 | if $verbosity >= 10; |
965 | if $verbosity >= 10; |
803 | |
966 | |
804 | keys %$cb; |
967 | for my $pkg (keys %$cb) { |
805 | |
|
|
806 | while (my ($pkg, $cb) = each %$cb) { |
|
|
807 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
968 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
808 | $retval ||= $retval_; |
969 | $retval ||= $retval_; |
809 | |
970 | |
810 | if ($@) { |
971 | if ($@) { |
811 | $TERM->ungrab; # better to lose the grab than the session |
972 | $TERM->ungrab; # better to lose the grab than the session |
812 | warn $@; |
973 | warn $@; |
… | |
… | |
824 | # clear package |
985 | # clear package |
825 | %$TERM = (); |
986 | %$TERM = (); |
826 | } |
987 | } |
827 | |
988 | |
828 | $retval |
989 | $retval |
|
|
990 | } |
|
|
991 | |
|
|
992 | sub SET_COLOR($$$) { |
|
|
993 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
994 | } |
|
|
995 | |
|
|
996 | sub rend2mask { |
|
|
997 | no strict 'refs'; |
|
|
998 | my ($str, $mask) = (@_, 0); |
|
|
999 | my %color = ( fg => undef, bg => undef ); |
|
|
1000 | my @failed; |
|
|
1001 | for my $spec ( split /\s+/, $str ) { |
|
|
1002 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1003 | $color{lc($1)} = $2; |
|
|
1004 | } else { |
|
|
1005 | my $neg = $spec =~ s/^[-^]//; |
|
|
1006 | unless ( exists &{"RS_$spec"} ) { |
|
|
1007 | push @failed, $spec; |
|
|
1008 | next; |
|
|
1009 | } |
|
|
1010 | my $cur = &{"RS_$spec"}; |
|
|
1011 | if ( $neg ) { |
|
|
1012 | $mask &= ~$cur; |
|
|
1013 | } else { |
|
|
1014 | $mask |= $cur; |
|
|
1015 | } |
|
|
1016 | } |
|
|
1017 | } |
|
|
1018 | ($mask, @color{qw(fg bg)}, \@failed) |
829 | } |
1019 | } |
830 | |
1020 | |
831 | # urxvt::term::extension |
1021 | # urxvt::term::extension |
832 | |
1022 | |
833 | package urxvt::term::extension; |
1023 | package urxvt::term::extension; |
… | |
… | |
946 | sub DESTROY { |
1136 | sub DESTROY { |
947 | $_[0][1]->stop; |
1137 | $_[0][1]->stop; |
948 | } |
1138 | } |
949 | |
1139 | |
950 | sub condvar { |
1140 | sub condvar { |
951 | bless \my $flag, urxvt::anyevent::condvar:: |
1141 | bless \my $flag, urxvt::anyevent:: |
952 | } |
1142 | } |
953 | |
1143 | |
954 | sub urxvt::anyevent::condvar::broadcast { |
1144 | sub broadcast { |
955 | ${$_[0]}++; |
1145 | ${$_[0]}++; |
956 | } |
1146 | } |
957 | |
1147 | |
958 | sub urxvt::anyevent::condvar::wait { |
1148 | sub wait { |
959 | unless (${$_[0]}) { |
1149 | unless (${$_[0]}) { |
960 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1150 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
961 | } |
1151 | } |
|
|
1152 | } |
|
|
1153 | |
|
|
1154 | sub one_event { |
|
|
1155 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
962 | } |
1156 | } |
963 | |
1157 | |
964 | package urxvt::term; |
1158 | package urxvt::term; |
965 | |
1159 | |
966 | =head2 The C<urxvt::term> Class |
1160 | =head2 The C<urxvt::term> Class |
… | |
… | |
1002 | hash which defines the environment of the new terminal. |
1196 | hash which defines the environment of the new terminal. |
1003 | |
1197 | |
1004 | Croaks (and probably outputs an error message) if the new instance |
1198 | Croaks (and probably outputs an error message) if the new instance |
1005 | couldn't be created. Returns C<undef> if the new instance didn't |
1199 | couldn't be created. Returns C<undef> if the new instance didn't |
1006 | initialise perl, and the terminal object otherwise. The C<init> and |
1200 | initialise perl, and the terminal object otherwise. The C<init> and |
1007 | C<start> hooks will be called during this call. |
1201 | C<start> hooks will be called before this call returns, and are free to |
|
|
1202 | refer to global data (which is race free). |
1008 | |
1203 | |
1009 | =cut |
1204 | =cut |
1010 | |
1205 | |
1011 | sub new { |
1206 | sub new { |
1012 | my ($class, $env, @args) = @_; |
1207 | my ($class, $env, @args) = @_; |
1013 | |
1208 | |
|
|
1209 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1210 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1211 | |
1014 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1212 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1015 | } |
1213 | } |
1016 | |
1214 | |
1017 | =item $term->destroy |
1215 | =item $term->destroy |
1018 | |
1216 | |
1019 | Destroy the terminal object (close the window, free resources |
1217 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1049 | |
1247 | |
1050 | Returns true if the option specified by C<$optval> is enabled, and |
1248 | Returns true if the option specified by C<$optval> is enabled, and |
1051 | optionally change it. All option values are stored by name in the hash |
1249 | optionally change it. All option values are stored by name in the hash |
1052 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1250 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1053 | |
1251 | |
1054 | Here is a a likely non-exhaustive list of option names, please see the |
1252 | Here is a likely non-exhaustive list of option names, please see the |
1055 | source file F</src/optinc.h> to see the actual list: |
1253 | source file F</src/optinc.h> to see the actual list: |
1056 | |
1254 | |
1057 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1255 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1058 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1256 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1059 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1257 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1076 | likely change). |
1274 | likely change). |
1077 | |
1275 | |
1078 | Please note that resource strings will currently only be freed when the |
1276 | Please note that resource strings will currently only be freed when the |
1079 | terminal is destroyed, so changing options frequently will eat memory. |
1277 | terminal is destroyed, so changing options frequently will eat memory. |
1080 | |
1278 | |
1081 | Here is a a likely non-exhaustive list of resource names, not all of which |
1279 | Here is a likely non-exhaustive list of resource names, not all of which |
1082 | are supported in every build, please see the source file F</src/rsinc.h> |
1280 | are supported in every build, please see the source file F</src/rsinc.h> |
1083 | to see the actual list: |
1281 | to see the actual list: |
1084 | |
1282 | |
1085 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1283 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1086 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1284 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1299 | Replaces the event mask of the pty watcher by the given event mask. Can |
1497 | Replaces the event mask of the pty watcher by the given event mask. Can |
1300 | be used to suppress input and output handling to the pty/tty. See the |
1498 | be used to suppress input and output handling to the pty/tty. See the |
1301 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1499 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1302 | the previous value. |
1500 | the previous value. |
1303 | |
1501 | |
|
|
1502 | =item $fd = $term->pty_fd |
|
|
1503 | |
|
|
1504 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1505 | is used. |
|
|
1506 | |
1304 | =item $windowid = $term->parent |
1507 | =item $windowid = $term->parent |
1305 | |
1508 | |
1306 | Return the window id of the toplevel window. |
1509 | Return the window id of the toplevel window. |
1307 | |
1510 | |
1308 | =item $windowid = $term->vt |
1511 | =item $windowid = $term->vt |
… | |
… | |
1314 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1517 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1315 | to receive pointer events all the times: |
1518 | to receive pointer events all the times: |
1316 | |
1519 | |
1317 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1520 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1318 | |
1521 | |
|
|
1522 | =item $term->focus_in |
|
|
1523 | |
|
|
1524 | =item $term->focus_out |
|
|
1525 | |
|
|
1526 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1527 | |
|
|
1528 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1529 | |
|
|
1530 | Deliver various fake events to to terminal. |
|
|
1531 | |
1319 | =item $window_width = $term->width |
1532 | =item $window_width = $term->width |
1320 | |
1533 | |
1321 | =item $window_height = $term->height |
1534 | =item $window_height = $term->height |
1322 | |
1535 | |
1323 | =item $font_width = $term->fwidth |
1536 | =item $font_width = $term->fwidth |
… | |
… | |
1353 | =item $env = $term->env |
1566 | =item $env = $term->env |
1354 | |
1567 | |
1355 | Returns a copy of the environment in effect for the terminal as a hashref |
1568 | Returns a copy of the environment in effect for the terminal as a hashref |
1356 | similar to C<\%ENV>. |
1569 | similar to C<\%ENV>. |
1357 | |
1570 | |
|
|
1571 | =item @envv = $term->envv |
|
|
1572 | |
|
|
1573 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1574 | |
|
|
1575 | =item @argv = $term->argv |
|
|
1576 | |
|
|
1577 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1578 | includes the program name as first element. |
|
|
1579 | |
1358 | =cut |
1580 | =cut |
1359 | |
1581 | |
1360 | sub env { |
1582 | sub env { |
1361 | if (my $env = $_[0]->_env) { |
|
|
1362 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1583 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1363 | } else { |
|
|
1364 | +{ %ENV } |
|
|
1365 | } |
|
|
1366 | } |
1584 | } |
1367 | |
1585 | |
1368 | =item $modifiermask = $term->ModLevel3Mask |
1586 | =item $modifiermask = $term->ModLevel3Mask |
1369 | |
1587 | |
1370 | =item $modifiermask = $term->ModMetaMask |
1588 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1375 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1593 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1376 | |
1594 | |
1377 | =item $screen = $term->current_screen |
1595 | =item $screen = $term->current_screen |
1378 | |
1596 | |
1379 | Returns the currently displayed screen (0 primary, 1 secondary). |
1597 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1598 | |
|
|
1599 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1600 | |
|
|
1601 | Returns whether the cursor is currently hidden or not. |
1380 | |
1602 | |
1381 | =item $view_start = $term->view_start ([$newvalue]) |
1603 | =item $view_start = $term->view_start ([$newvalue]) |
1382 | |
1604 | |
1383 | Returns the row number of the topmost displayed line. Maximum value is |
1605 | Returns the row number of the topmost displayed line. Maximum value is |
1384 | C<0>, which displays the normal terminal contents. Lower values scroll |
1606 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1403 | If C<$new_text> is specified, it will replace characters in the current |
1625 | If C<$new_text> is specified, it will replace characters in the current |
1404 | line, starting at column C<$start_col> (default C<0>), which is useful |
1626 | line, starting at column C<$start_col> (default C<0>), which is useful |
1405 | to replace only parts of a line. The font index in the rendition will |
1627 | to replace only parts of a line. The font index in the rendition will |
1406 | automatically be updated. |
1628 | automatically be updated. |
1407 | |
1629 | |
1408 | C<$text> is in a special encoding: tabs and wide characters that use |
1630 | C<$text> is in a special encoding: tabs and wide characters that use more |
1409 | more than one cell when displayed are padded with C<$urxvt::NOCHAR> |
1631 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1410 | characters. Characters with combining characters and other characters that |
1632 | characters. Characters with combining characters and other characters that |
1411 | do not fit into the normal tetx encoding will be replaced with characters |
1633 | do not fit into the normal tetx encoding will be replaced with characters |
1412 | in the private use area. |
1634 | in the private use area. |
1413 | |
1635 | |
1414 | You have to obey this encoding when changing text. The advantage is |
1636 | You have to obey this encoding when changing text. The advantage is |
… | |
… | |
1561 | where one character corresponds to one screen cell. See |
1783 | where one character corresponds to one screen cell. See |
1562 | C<< $term->ROW_t >> for details. |
1784 | C<< $term->ROW_t >> for details. |
1563 | |
1785 | |
1564 | =item $string = $term->special_decode $text |
1786 | =item $string = $term->special_decode $text |
1565 | |
1787 | |
1566 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1788 | Converts rxvt-unicodes text representation into a perl string. See |
1567 | C<< $term->ROW_t >> for details. |
1789 | C<< $term->ROW_t >> for details. |
1568 | |
1790 | |
1569 | =item $success = $term->grab_button ($button, $modifiermask) |
1791 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1570 | |
1792 | |
|
|
1793 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1794 | |
1571 | Registers a synchronous button grab. See the XGrabButton manpage. |
1795 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1796 | manpage. |
1572 | |
1797 | |
1573 | =item $success = $term->grab ($eventtime[, $sync]) |
1798 | =item $success = $term->grab ($eventtime[, $sync]) |
1574 | |
1799 | |
1575 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1800 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1576 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1801 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1577 | |
1802 | |
1578 | =item $term->allow_events_async |
1803 | =item $term->allow_events_async |
1579 | |
1804 | |
1580 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1805 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1581 | |
1806 | |
… | |
… | |
1694 | my ($self, $text, $cb) = @_; |
1919 | my ($self, $text, $cb) = @_; |
1695 | |
1920 | |
1696 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1921 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1697 | } |
1922 | } |
1698 | |
1923 | |
1699 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1924 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1700 | |
1925 | |
1701 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1926 | Adds a toggle/checkbox item to the popup. The callback gets called |
1702 | whenever it gets toggled, with a boolean indicating its value as its first |
1927 | whenever it gets toggled, with a boolean indicating its new value as its |
1703 | argument. |
1928 | first argument. |
1704 | |
1929 | |
1705 | =cut |
1930 | =cut |
1706 | |
1931 | |
1707 | sub add_toggle { |
1932 | sub add_toggle { |
1708 | my ($self, $text, $cb, $value) = @_; |
1933 | my ($self, $text, $value, $cb) = @_; |
1709 | |
1934 | |
1710 | my $item; $item = { |
1935 | my $item; $item = { |
1711 | type => "button", |
1936 | type => "button", |
1712 | text => " $text", |
1937 | text => " $text", |
1713 | value => $value, |
1938 | value => $value, |
… | |
… | |
1754 | =back |
1979 | =back |
1755 | |
1980 | |
1756 | =cut |
1981 | =cut |
1757 | |
1982 | |
1758 | package urxvt::watcher; |
1983 | package urxvt::watcher; |
1759 | |
|
|
1760 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1761 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1762 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1763 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1764 | |
1984 | |
1765 | =head2 The C<urxvt::timer> Class |
1985 | =head2 The C<urxvt::timer> Class |
1766 | |
1986 | |
1767 | This class implements timer watchers/events. Time is represented as a |
1987 | This class implements timer watchers/events. Time is represented as a |
1768 | fractional number of seconds since the epoch. Example: |
1988 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1848 | Set the callback to be called when io events are triggered. C<$reventmask> |
2068 | Set the callback to be called when io events are triggered. C<$reventmask> |
1849 | is a bitset as described in the C<events> method. |
2069 | is a bitset as described in the C<events> method. |
1850 | |
2070 | |
1851 | =item $iow = $iow->fd ($fd) |
2071 | =item $iow = $iow->fd ($fd) |
1852 | |
2072 | |
1853 | Set the filedescriptor (not handle) to watch. |
2073 | Set the file descriptor (not handle) to watch. |
1854 | |
2074 | |
1855 | =item $iow = $iow->events ($eventmask) |
2075 | =item $iow = $iow->events ($eventmask) |
1856 | |
2076 | |
1857 | Set the event mask to watch. The only allowed values are |
2077 | Set the event mask to watch. The only allowed values are |
1858 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2078 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
… | |
… | |
1862 | |
2082 | |
1863 | Start watching for requested events on the given handle. |
2083 | Start watching for requested events on the given handle. |
1864 | |
2084 | |
1865 | =item $iow = $iow->stop |
2085 | =item $iow = $iow->stop |
1866 | |
2086 | |
1867 | Stop watching for events on the given filehandle. |
2087 | Stop watching for events on the given file handle. |
1868 | |
2088 | |
1869 | =back |
2089 | =back |
1870 | |
2090 | |
1871 | =head2 The C<urxvt::iw> Class |
2091 | =head2 The C<urxvt::iw> Class |
1872 | |
2092 | |
… | |
… | |
1919 | |
2139 | |
1920 | Set the callback to be called when the timer triggers. |
2140 | Set the callback to be called when the timer triggers. |
1921 | |
2141 | |
1922 | =item $pw = $timer->start ($pid) |
2142 | =item $pw = $timer->start ($pid) |
1923 | |
2143 | |
1924 | Tells the wqtcher to start watching for process C<$pid>. |
2144 | Tells the watcher to start watching for process C<$pid>. |
1925 | |
2145 | |
1926 | =item $pw = $pw->stop |
2146 | =item $pw = $pw->stop |
1927 | |
2147 | |
1928 | Stop the watcher. |
2148 | Stop the watcher. |
1929 | |
2149 | |
… | |
… | |
1942 | |
2162 | |
1943 | =item >= 3 - script loading and management |
2163 | =item >= 3 - script loading and management |
1944 | |
2164 | |
1945 | =item >=10 - all called hooks |
2165 | =item >=10 - all called hooks |
1946 | |
2166 | |
1947 | =item >=11 - hook reutrn values |
2167 | =item >=11 - hook return values |
1948 | |
2168 | |
1949 | =back |
2169 | =back |
1950 | |
2170 | |
1951 | =head1 AUTHOR |
2171 | =head1 AUTHOR |
1952 | |
2172 | |
… | |
… | |
1954 | http://software.schmorp.de/pkg/rxvt-unicode |
2174 | http://software.schmorp.de/pkg/rxvt-unicode |
1955 | |
2175 | |
1956 | =cut |
2176 | =cut |
1957 | |
2177 | |
1958 | 1 |
2178 | 1 |
|
|
2179 | |
|
|
2180 | # vim: sw=3: |