… | |
… | |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Everytime a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
30 | |
30 | |
|
|
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
|
|
32 | and "perl-ext-common" resources to the empty string. |
|
|
33 | |
31 | =head1 PREPACKAGED EXTENSIONS |
34 | =head1 PREPACKAGED EXTENSIONS |
32 | |
35 | |
33 | This section describes the extensions delivered with this release. You can |
36 | This section describes the extensions delivered with this release. You can |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
37 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
35 | |
38 | |
… | |
… | |
37 | |
40 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
41 | @@RXVT_NAME@@ -pe <extensionname> |
39 | |
42 | |
40 | Or by adding them to the resource for extensions loaded by default: |
43 | Or by adding them to the resource for extensions loaded by default: |
41 | |
44 | |
42 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
45 | URxvt.perl-ext-common: default,selection-autotransform |
43 | |
46 | |
44 | =over 4 |
47 | =over 4 |
45 | |
48 | |
46 | =item selection (enabled by default) |
49 | =item selection (enabled by default) |
47 | |
50 | |
… | |
… | |
62 | URxvt.selection.pattern-1: perl-regex |
65 | URxvt.selection.pattern-1: perl-regex |
63 | ... |
66 | ... |
64 | |
67 | |
65 | The index number (0, 1...) must not have any holes, and each regex must |
68 | The index number (0, 1...) must not have any holes, and each regex must |
66 | contain at least one pair of capturing parentheses, which will be used for |
69 | contain at least one pair of capturing parentheses, which will be used for |
67 | the match. For example, the followign adds a regex that matches everything |
70 | the match. For example, the following adds a regex that matches everything |
68 | between two vertical bars: |
71 | between two vertical bars: |
69 | |
72 | |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
73 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
71 | |
74 | |
72 | Another example: Programs I use often output "absolute path: " at the |
75 | Another example: Programs I use often output "absolute path: " at the |
… | |
… | |
94 | =item option-popup (enabled by default) |
97 | =item option-popup (enabled by default) |
95 | |
98 | |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
99 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
97 | runtime. |
100 | runtime. |
98 | |
101 | |
|
|
102 | Other extensions can extend this popup menu by pushing a code reference |
|
|
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
104 | popup is being displayed. |
|
|
105 | |
|
|
106 | Its sole argument is the popup menu, which can be modified. It should |
|
|
107 | either return nothing or a string, the initial boolean value and a code |
|
|
108 | reference. The string will be used as button text and the code reference |
|
|
109 | will be called when the toggle changes, with the new boolean value as |
|
|
110 | first argument. |
|
|
111 | |
|
|
112 | The following will add an entry C<myoption> that changes |
|
|
113 | C<< $self->{myoption} >>: |
|
|
114 | |
|
|
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
117 | }; |
|
|
118 | |
99 | =item selection-popup (enabled by default) |
119 | =item selection-popup (enabled by default) |
100 | |
120 | |
101 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
121 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
102 | text into various other formats/action (such as uri unescaping, perl |
122 | text into various other formats/action (such as uri unescaping, perl |
103 | evaluation, web-browser starting etc.), depending on content. |
123 | evaluation, web-browser starting etc.), depending on content. |
104 | |
124 | |
105 | Other extensions can extend this popup menu by pushing a code reference |
125 | Other extensions can extend this popup menu by pushing a code reference |
106 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
107 | popup is displayed. |
127 | popup is being displayed. |
108 | |
128 | |
109 | It's sole argument is the popup menu, which can be modified. The selection |
129 | Its sole argument is the popup menu, which can be modified. The selection |
110 | is in C<$_>, which can be used to decide wether to add something or not. |
130 | is in C<$_>, which can be used to decide whether to add something or not. |
111 | It should either return nothing or a string and a code reference. The |
131 | It should either return nothing or a string and a code reference. The |
112 | string will be used as button text and the code reference will be called |
132 | string will be used as button text and the code reference will be called |
113 | when the button gets activated and should transform C<$_>. |
133 | when the button gets activated and should transform C<$_>. |
114 | |
134 | |
115 | The following will add an entry C<a to b> that transforms all C<a>s in |
135 | The following will add an entry C<a to b> that transforms all C<a>s in |
116 | the selection to C<b>s, but only if the selection currently contains any |
136 | the selection to C<b>s, but only if the selection currently contains any |
117 | C<a>s: |
137 | C<a>s: |
118 | |
138 | |
119 | push @{ $self->{term}{selection_popup_hook} }, sub { |
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
120 | /a/ ? ("a to be" => sub { s/a/b/g } |
140 | /a/ ? ("a to b" => sub { s/a/b/g } |
121 | : () |
141 | : () |
122 | }; |
142 | }; |
123 | |
143 | |
124 | =item searchable-scrollback<hotkey> (enabled by default) |
144 | =item searchable-scrollback<hotkey> (enabled by default) |
125 | |
145 | |
… | |
… | |
132 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
152 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
133 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
153 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
134 | bottom. C<Escape> leaves search mode and returns to the point where search |
154 | bottom. C<Escape> leaves search mode and returns to the point where search |
135 | was started, while C<Enter> or C<Return> stay at the current position and |
155 | was started, while C<Enter> or C<Return> stay at the current position and |
136 | additionally stores the first match in the current line into the primary |
156 | additionally stores the first match in the current line into the primary |
137 | selection. |
157 | selection if the C<Shift> modifier is active. |
|
|
158 | |
|
|
159 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
|
|
160 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
|
|
161 | or simply use an uppercase character which removes the "(?i)" prefix. |
|
|
162 | |
|
|
163 | See L<perlre> for more info about perl regular expression syntax. |
138 | |
164 | |
139 | =item readline (enabled by default) |
165 | =item readline (enabled by default) |
140 | |
166 | |
141 | A support package that tries to make editing with readline easier. At the |
167 | A support package that tries to make editing with readline easier. At |
142 | moment, it reacts to clicking with the left mouse button by trying to |
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
143 | move the text cursor to this position. It does so by generating as many |
169 | move the text cursor to this position. It does so by generating as many |
144 | cursor-left or cursor-right keypresses as required (the this only works |
170 | cursor-left or cursor-right keypresses as required (this only works |
145 | for programs that correctly support wide characters). |
171 | for programs that correctly support wide characters). |
146 | |
172 | |
147 | To avoid too many false positives, this is only done when: |
173 | To avoid too many false positives, this is only done when: |
148 | |
174 | |
149 | =over 4 |
175 | =over 4 |
… | |
… | |
197 | the message into vi commands to load the file. |
223 | the message into vi commands to load the file. |
198 | |
224 | |
199 | =item tabbed |
225 | =item tabbed |
200 | |
226 | |
201 | This transforms the terminal into a tabbar with additional terminals, that |
227 | This transforms the terminal into a tabbar with additional terminals, that |
202 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
228 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
203 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
229 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
204 | button per tab. |
230 | button per tab. |
205 | |
231 | |
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
232 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
207 | B<Shift-Right> will switch to the tab left or right of the current one, |
233 | B<Shift-Right> will switch to the tab left or right of the current one, |
208 | while B<Shift-Down> creates a new tab. |
234 | while B<Shift-Down> creates a new tab. |
209 | |
235 | |
210 | =item mark-urls |
236 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
237 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
238 | following four resources (shown with defaults): |
211 | |
239 | |
|
|
240 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
241 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
242 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
243 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
244 | |
|
|
245 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
246 | indices. |
|
|
247 | |
|
|
248 | =item matcher |
|
|
249 | |
212 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
250 | Uses per-line display filtering (C<on_line_update>) to underline text |
213 | make them clickable. When middle-clicked, the program specified in the |
251 | matching a certain pattern and make it clickable. When clicked with the |
214 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
252 | mouse button specified in the C<matcher.button> resource (default 2, or |
215 | the URL as first argument. |
253 | middle), the program specified in the C<matcher.launcher> resource |
|
|
254 | (default, the C<urlLauncher> resource, C<sensible-browser>) will be started |
|
|
255 | with the matched text as first argument. The default configuration is |
|
|
256 | suitable for matching URLs and launching a web browser, like the |
|
|
257 | former "mark-urls" extension. |
|
|
258 | |
|
|
259 | The default pattern to match URLs can be overridden with the |
|
|
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
|
|
261 | with numbered patterns, in a manner similar to the "selection" extension. |
|
|
262 | The launcher can also be overridden on a per-pattern basis. |
|
|
263 | |
|
|
264 | It is possible to activate the most recently seen match or a list of matches |
|
|
265 | from the keyboard. Simply bind a keysym to "perl:matcher:last" or |
|
|
266 | "perl:matcher:list" as seen in the example below. |
|
|
267 | |
|
|
268 | Example configuration: |
|
|
269 | |
|
|
270 | URxvt.perl-ext: default,matcher |
|
|
271 | URxvt.urlLauncher: sensible-browser |
|
|
272 | URxvt.keysym.C-Delete: perl:matcher:last |
|
|
273 | URxvt.keysym.M-Delete: perl:matcher:list |
|
|
274 | URxvt.matcher.button: 1 |
|
|
275 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
276 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
277 | URxvt.matcher.launcher.2: gvim +$2 $1 |
216 | |
278 | |
217 | =item xim-onthespot |
279 | =item xim-onthespot |
218 | |
280 | |
219 | This (experimental) perl extension implements OnTheSpot editing. It does |
281 | This (experimental) perl extension implements OnTheSpot editing. It does |
220 | not work perfectly, and some input methods don't seem to work well with |
282 | not work perfectly, and some input methods don't seem to work well with |
221 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
283 | OnTheSpot editing in general, but it seems to work at least for SCIM and |
222 | kinput2. |
284 | kinput2. |
223 | |
285 | |
224 | You enable it by specifying this extension and a preedit style of |
286 | You enable it by specifying this extension and a preedit style of |
225 | C<OnTheSpot>, i.e.: |
287 | C<OnTheSpot>, i.e.: |
226 | |
288 | |
227 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
289 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
228 | |
290 | |
229 | =item automove-background |
291 | =item kuake<hotkey> |
230 | |
292 | |
231 | This is basically a one-line extension that dynamically changes the background pixmap offset |
293 | A very primitive quake-console-like extension. It was inspired by a |
232 | to the window position, in effect creating the same effect as pseudo transparency with |
294 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
233 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
295 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
296 | will show or hide itself. Another press of the accelerator key will hide |
|
|
297 | or show it again. |
234 | |
298 | |
235 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
299 | Initially, the window will not be shown when using this extension. |
|
|
300 | |
|
|
301 | This is useful if you need a single terminal that is not using any desktop |
|
|
302 | space most of the time but is quickly available at the press of a key. |
|
|
303 | |
|
|
304 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
305 | extension will actually grab a physical key just for this function. |
|
|
306 | |
|
|
307 | If you want a quake-like animation, tell your window manager to do so |
|
|
308 | (fvwm can do it). |
|
|
309 | |
|
|
310 | =item overlay-osc |
|
|
311 | |
|
|
312 | This extension implements some OSC commands to display timed popups on the |
|
|
313 | screen - useful for status displays from within scripts. You have to read |
|
|
314 | the sources for more info. |
236 | |
315 | |
237 | =item block-graphics-to-ascii |
316 | =item block-graphics-to-ascii |
238 | |
317 | |
239 | A not very useful example of filtering all text output to the terminal, |
318 | A not very useful example of filtering all text output to the terminal |
240 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
319 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
241 | similar-looking ascii character. |
320 | similar-looking ascii character. |
242 | |
321 | |
243 | =item digital-clock |
322 | =item digital-clock |
244 | |
323 | |
245 | Displays a digital clock using the built-in overlay. |
324 | Displays a digital clock using the built-in overlay. |
|
|
325 | |
|
|
326 | =item remote-clipboard |
|
|
327 | |
|
|
328 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
329 | selection popup that allows one to run external commands to store the |
|
|
330 | selection somewhere and fetch it again. |
|
|
331 | |
|
|
332 | We use it to implement a "distributed selection mechanism", which just |
|
|
333 | means that one command uploads the file to a remote server, and another |
|
|
334 | reads it. |
|
|
335 | |
|
|
336 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
337 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
338 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
339 | the selection data on STDOUT (also in UTF-8). |
|
|
340 | |
|
|
341 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
342 | |
|
|
343 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
344 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
|
|
345 | |
|
|
346 | =item selection-pastebin |
|
|
347 | |
|
|
348 | This is a little rarely useful extension that uploads the selection as |
|
|
349 | textfile to a remote site (or does other things). (The implementation is |
|
|
350 | not currently secure for use in a multiuser environment as it writes to |
|
|
351 | F</tmp> directly.). |
|
|
352 | |
|
|
353 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
354 | i.e. |
|
|
355 | |
|
|
356 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
357 | |
|
|
358 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
359 | the textfile. This command can be set via a resource: |
|
|
360 | |
|
|
361 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
362 | |
|
|
363 | And the default is likely not useful to anybody but the few people around |
|
|
364 | here :) |
|
|
365 | |
|
|
366 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
367 | the same content should lead to the same filename. |
|
|
368 | |
|
|
369 | After a successful upload the selection will be replaced by the text given |
|
|
370 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
371 | for the filename): |
|
|
372 | |
|
|
373 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
374 | |
|
|
375 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
376 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
377 | which works regardless of whether xrdb is used to parse the resource file |
|
|
378 | or not. |
|
|
379 | |
|
|
380 | =item macosx-clipboard and macosx-clipboard-native |
|
|
381 | |
|
|
382 | These two modules implement an extended clipboard for Mac OS X. They are |
|
|
383 | used like this: |
|
|
384 | |
|
|
385 | URxvt.perl-ext-common: default,macosx-clipboard |
|
|
386 | URxvt.keysym.M-c: perl:macosx-clipboard:copy |
|
|
387 | URxvt.keysym.M-v: perl:macosx-clipboard:paste |
|
|
388 | |
|
|
389 | The difference between them is that the native variant requires a |
|
|
390 | perl from apple's devkit or so, and C<macosx-clipboard> requires the |
|
|
391 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
|
|
392 | simpler etc. etc. |
246 | |
393 | |
247 | =item example-refresh-hooks |
394 | =item example-refresh-hooks |
248 | |
395 | |
249 | Displays a very simple digital clock in the upper right corner of the |
396 | Displays a very simple digital clock in the upper right corner of the |
250 | window. Illustrates overwriting the refresh callbacks to create your own |
397 | window. Illustrates overwriting the refresh callbacks to create your own |
251 | overlays or changes. |
398 | overlays or changes. |
252 | |
399 | |
253 | =item selection-pastebin |
400 | =item confirm-paste |
254 | |
401 | |
255 | This is a little rarely useful extension that Uploads the selection as |
402 | Displays a confirmation dialog when a paste containing at least a full |
256 | textfile to a remote site (or does other things). (The implementation is |
403 | line is detected. |
257 | not currently secure for use in a multiuser environment as it writes to |
|
|
258 | F</tmp> directly.). |
|
|
259 | |
404 | |
260 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
405 | =item bell-command |
261 | i.e. |
|
|
262 | |
406 | |
263 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
407 | Runs the command specified by the C<URxvt.bell-command> resource when |
|
|
408 | a bell event occurs. For example, the following pops up a notification |
|
|
409 | bubble with the text "Beep, Beep" using notify-send: |
264 | |
410 | |
265 | Pressing this combination runs a command with C<%> replaced by the name of |
411 | URxvt.bell-command: notify-send "Beep, Beep" |
266 | the textfile. This command can be set via a resource: |
|
|
267 | |
|
|
268 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
269 | |
|
|
270 | And the default is likely not useful to anybody but the few people around |
|
|
271 | here :) |
|
|
272 | |
|
|
273 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
274 | the same content should lead to the same filename. |
|
|
275 | |
|
|
276 | After a successful upload the selection will be replaced by the text given |
|
|
277 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
278 | for the filename): |
|
|
279 | |
|
|
280 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
281 | |
412 | |
282 | =back |
413 | =back |
283 | |
414 | |
284 | =head1 API DOCUMENTATION |
415 | =head1 API DOCUMENTATION |
285 | |
416 | |
… | |
… | |
301 | |
432 | |
302 | =over 4 |
433 | =over 4 |
303 | |
434 | |
304 | =item $text |
435 | =item $text |
305 | |
436 | |
306 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
437 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
307 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
438 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
308 | |
439 | |
309 | =item $string |
440 | =item $string |
310 | |
441 | |
311 | A perl text string, with an emphasis on I<text>. It can store all unicode |
442 | A perl text string, with an emphasis on I<text>. It can store all unicode |
… | |
… | |
315 | =item $octets |
446 | =item $octets |
316 | |
447 | |
317 | Either binary data or - more common - a text string encoded in a |
448 | Either binary data or - more common - a text string encoded in a |
318 | locale-specific way. |
449 | locale-specific way. |
319 | |
450 | |
|
|
451 | =item $keysym |
|
|
452 | |
|
|
453 | an integer that is a valid X11 keysym code. You can convert a string |
|
|
454 | into a keysym and viceversa by using C<XStringToKeysym> and |
|
|
455 | C<XKeysymToString>. |
|
|
456 | |
320 | =back |
457 | =back |
321 | |
458 | |
322 | =head2 Extension Objects |
459 | =head2 Extension Objects |
323 | |
460 | |
324 | Very perl extension is a perl class. A separate perl object is created |
461 | Every perl extension is a perl class. A separate perl object is created |
325 | for each terminal and each extension and passed as the first parameter to |
462 | for each terminal, and each terminal has its own set of extension objects, |
326 | hooks. So extensions can use their C<$self> object without having to think |
463 | which are passed as the first parameter to hooks. So extensions can use |
327 | about other extensions, with the exception of methods and members that |
464 | their C<$self> object without having to think about clashes with other |
|
|
465 | extensions or other terminals, with the exception of methods and members |
328 | begin with an underscore character C<_>: these are reserved for internal |
466 | that begin with an underscore character C<_>: these are reserved for |
329 | use. |
467 | internal use. |
330 | |
468 | |
331 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
469 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
332 | C<urxvt::term> class on this object. |
470 | C<urxvt::term> class on this object. |
333 | |
471 | |
334 | It has the following methods and data members: |
472 | It has the following methods and data members: |
… | |
… | |
355 | =head2 Hooks |
493 | =head2 Hooks |
356 | |
494 | |
357 | The following subroutines can be declared in extension files, and will be |
495 | The following subroutines can be declared in extension files, and will be |
358 | called whenever the relevant event happens. |
496 | called whenever the relevant event happens. |
359 | |
497 | |
360 | The first argument passed to them is an extension oject as described in |
498 | The first argument passed to them is an extension object as described in |
361 | the in the C<Extension Objects> section. |
499 | the in the C<Extension Objects> section. |
362 | |
500 | |
363 | B<All> of these hooks must return a boolean value. If any of the called |
501 | B<All> of these hooks must return a boolean value. If any of the called |
364 | hooks returns true, then the event counts as being I<consumed>, and the |
502 | hooks returns true, then the event counts as being I<consumed>, and the |
365 | relevant action might not be carried out by the C++ code. |
503 | relevant action might not be carried out by the C++ code. |
… | |
… | |
378 | place. |
516 | place. |
379 | |
517 | |
380 | =item on_start $term |
518 | =item on_start $term |
381 | |
519 | |
382 | Called at the very end of initialisation of a new terminal, just before |
520 | Called at the very end of initialisation of a new terminal, just before |
383 | trying to map (display) the toplevel and returning to the mainloop. |
521 | trying to map (display) the toplevel and returning to the main loop. |
384 | |
522 | |
385 | =item on_destroy $term |
523 | =item on_destroy $term |
386 | |
524 | |
387 | Called whenever something tries to destroy terminal, when the terminal is |
525 | Called whenever something tries to destroy terminal, when the terminal is |
388 | still fully functional (not for long, though). |
526 | still fully functional (not for long, though). |
… | |
… | |
415 | |
553 | |
416 | Called whenever a selection has been copied, but before the selection is |
554 | Called whenever a selection has been copied, but before the selection is |
417 | requested from the server. The selection text can be queried and changed |
555 | requested from the server. The selection text can be queried and changed |
418 | by calling C<< $term->selection >>. |
556 | by calling C<< $term->selection >>. |
419 | |
557 | |
420 | Returning a true value aborts selection grabbing. It will still be hilighted. |
558 | Returning a true value aborts selection grabbing. It will still be highlighted. |
421 | |
559 | |
422 | =item on_sel_extend $term |
560 | =item on_sel_extend $term |
423 | |
561 | |
424 | Called whenever the user tries to extend the selection (e.g. with a double |
562 | Called whenever the user tries to extend the selection (e.g. with a double |
425 | click) and is either supposed to return false (normal operation), or |
563 | click) and is either supposed to return false (normal operation), or |
426 | should extend the selection itelf and return true to suppress the built-in |
564 | should extend the selection itself and return true to suppress the built-in |
427 | processing. This can happen multiple times, as long as the callback |
565 | processing. This can happen multiple times, as long as the callback |
428 | returns true, it will be called on every further click by the user and is |
566 | returns true, it will be called on every further click by the user and is |
429 | supposed to enlarge the selection more and more, if possible. |
567 | supposed to enlarge the selection more and more, if possible. |
430 | |
568 | |
431 | See the F<selection> example extension. |
569 | See the F<selection> example extension. |
432 | |
570 | |
433 | =item on_view_change $term, $offset |
571 | =item on_view_change $term, $offset |
434 | |
572 | |
435 | Called whenever the view offset changes, i..e the user or program |
573 | Called whenever the view offset changes, i.e. the user or program |
436 | scrolls. Offset C<0> means display the normal terminal, positive values |
574 | scrolls. Offset C<0> means display the normal terminal, positive values |
437 | show this many lines of scrollback. |
575 | show this many lines of scrollback. |
438 | |
576 | |
439 | =item on_scroll_back $term, $lines, $saved |
577 | =item on_scroll_back $term, $lines, $saved |
440 | |
578 | |
… | |
… | |
444 | |
582 | |
445 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
583 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
446 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
584 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
447 | number of lines that will be in the scrollback buffer. |
585 | number of lines that will be in the scrollback buffer. |
448 | |
586 | |
449 | =item on_osc_seq $term, $string |
587 | =item on_osc_seq $term, $op, $args, $resp |
|
|
588 | |
|
|
589 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
590 | behaviour. The default should be to return an empty list. A true value |
|
|
591 | suppresses execution of the request completely. Make sure you don't get |
|
|
592 | confused by recursive invocations when you output an OSC sequence within |
|
|
593 | this callback. |
|
|
594 | |
|
|
595 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
596 | |
|
|
597 | =item on_osc_seq_perl $term, $args, $resp |
450 | |
598 | |
451 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
599 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
452 | operating system command) is processed. Cursor position and other state |
600 | operating system command) is processed. Cursor position and other state |
453 | information is up-to-date when this happens. For interoperability, the |
601 | information is up-to-date when this happens. For interoperability, the |
454 | string should start with the extension name and a colon, to distinguish |
602 | string should start with the extension name (sans -osc) and a semicolon, |
455 | it from commands for other extensions, and this might be enforced in the |
603 | to distinguish it from commands for other extensions, and this might be |
456 | future. |
604 | enforced in the future. |
|
|
605 | |
|
|
606 | For example, C<overlay-osc> uses this: |
|
|
607 | |
|
|
608 | sub on_osc_seq_perl { |
|
|
609 | my ($self, $osc, $resp) = @_; |
|
|
610 | |
|
|
611 | return unless $osc =~ s/^overlay;//; |
|
|
612 | |
|
|
613 | ... process remaining $osc string |
|
|
614 | } |
457 | |
615 | |
458 | Be careful not ever to trust (in a security sense) the data you receive, |
616 | Be careful not ever to trust (in a security sense) the data you receive, |
459 | as its source can not easily be controleld (e-mail content, messages from |
617 | as its source can not easily be controlled (e-mail content, messages from |
460 | other users on the same system etc.). |
618 | other users on the same system etc.). |
|
|
619 | |
|
|
620 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
621 | sender. |
461 | |
622 | |
462 | =item on_add_lines $term, $string |
623 | =item on_add_lines $term, $string |
463 | |
624 | |
464 | Called whenever text is about to be output, with the text as argument. You |
625 | Called whenever text is about to be output, with the text as argument. You |
465 | can filter/change and output the text yourself by returning a true value |
626 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
470 | =item on_tt_write $term, $octets |
631 | =item on_tt_write $term, $octets |
471 | |
632 | |
472 | Called whenever some data is written to the tty/pty and can be used to |
633 | Called whenever some data is written to the tty/pty and can be used to |
473 | suppress or filter tty input. |
634 | suppress or filter tty input. |
474 | |
635 | |
|
|
636 | =item on_tt_paste $term, $octets |
|
|
637 | |
|
|
638 | Called whenever text is about to be pasted, with the text as argument. You |
|
|
639 | can filter/change and paste the text yourself by returning a true value |
|
|
640 | and calling C<< $term->tt_paste >> yourself. C<$octets> is |
|
|
641 | locale-encoded. |
|
|
642 | |
475 | =item on_line_update $term, $row |
643 | =item on_line_update $term, $row |
476 | |
644 | |
477 | Called whenever a line was updated or changed. Can be used to filter |
645 | Called whenever a line was updated or changed. Can be used to filter |
478 | screen output (e.g. underline urls or other useless stuff). Only lines |
646 | screen output (e.g. underline urls or other useless stuff). Only lines |
479 | that are being shown will be filtered, and, due to performance reasons, |
647 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
486 | later with the already-modified line (e.g. if unrelated parts change), so |
654 | later with the already-modified line (e.g. if unrelated parts change), so |
487 | you cannot just toggle rendition bits, but only set them. |
655 | you cannot just toggle rendition bits, but only set them. |
488 | |
656 | |
489 | =item on_refresh_begin $term |
657 | =item on_refresh_begin $term |
490 | |
658 | |
491 | Called just before the screen gets redrawn. Can be used for overlay |
659 | Called just before the screen gets redrawn. Can be used for overlay or |
492 | or similar effects by modify terminal contents in refresh_begin, and |
660 | similar effects by modifying the terminal contents in refresh_begin, and |
493 | restoring them in refresh_end. The built-in overlay and selection display |
661 | restoring them in refresh_end. The built-in overlay and selection display |
494 | code is run after this hook, and takes precedence. |
662 | code is run after this hook, and takes precedence. |
495 | |
663 | |
496 | =item on_refresh_end $term |
664 | =item on_refresh_end $term |
497 | |
665 | |
498 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
666 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
499 | |
667 | |
500 | =item on_keyboard_command $term, $string |
668 | =item on_user_command $term, $string |
501 | |
669 | |
502 | Called whenever the user presses a key combination that has a |
670 | Called whenever a user-configured event is being activated (e.g. via |
503 | C<perl:string> action bound to it (see description of the B<keysym> |
671 | a C<perl:string> action bound to a key, see description of the B<keysym> |
504 | resource in the @@RXVT_NAME@@(1) manpage). |
672 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
673 | |
|
|
674 | The event is simply the action string. This interface is assumed to change |
|
|
675 | slightly in the future. |
|
|
676 | |
|
|
677 | =item on_register_command $term, $keysym, $modifiermask, $string |
|
|
678 | |
|
|
679 | Called after parsing a keysym resource but before registering the |
|
|
680 | associated binding. If this hook returns TRUE the binding is not |
|
|
681 | registered. It can be used to modify a binding by calling |
|
|
682 | C<register_command>. |
|
|
683 | |
|
|
684 | =item on_resize_all_windows $term, $new_width, $new_height |
|
|
685 | |
|
|
686 | Called just after the new window size has been calculated, but before |
|
|
687 | windows are actually being resized or hints are being set. If this hook |
|
|
688 | returns TRUE, setting of the window hints is being skipped. |
505 | |
689 | |
506 | =item on_x_event $term, $event |
690 | =item on_x_event $term, $event |
507 | |
691 | |
508 | Called on every X event received on the vt window (and possibly other |
692 | Called on every X event received on the vt window (and possibly other |
509 | windows). Should only be used as a last resort. Most event structure |
693 | windows). Should only be used as a last resort. Most event structure |
510 | members are not passed. |
694 | members are not passed. |
511 | |
695 | |
|
|
696 | =item on_root_event $term, $event |
|
|
697 | |
|
|
698 | Like C<on_x_event>, but is called for events on the root window. |
|
|
699 | |
512 | =item on_focus_in $term |
700 | =item on_focus_in $term |
513 | |
701 | |
514 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
702 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
515 | does focus in processing. |
703 | does focus in processing. |
516 | |
704 | |
517 | =item on_focus_out $term |
705 | =item on_focus_out $term |
518 | |
706 | |
519 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
707 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
520 | focus out processing. |
708 | focus out processing. |
521 | |
709 | |
522 | =item on_configure_notify $term, $event |
710 | =item on_configure_notify $term, $event |
523 | |
711 | |
524 | =item on_property_notify $term, $event |
712 | =item on_property_notify $term, $event |
… | |
… | |
535 | |
723 | |
536 | =item on_map_notify $term, $event |
724 | =item on_map_notify $term, $event |
537 | |
725 | |
538 | =item on_unmap_notify $term, $event |
726 | =item on_unmap_notify $term, $event |
539 | |
727 | |
540 | Called whenever the corresponding X event is received for the terminal If |
728 | Called whenever the corresponding X event is received for the terminal. If |
541 | the hook returns true, then the even will be ignored by rxvt-unicode. |
729 | the hook returns true, then the event will be ignored by rxvt-unicode. |
542 | |
730 | |
543 | The event is a hash with most values as named by Xlib (see the XEvent |
731 | The event is a hash with most values as named by Xlib (see the XEvent |
544 | manpage), with the additional members C<row> and C<col>, which are the |
732 | manpage), with the additional members C<row> and C<col>, which are the |
545 | (real, not screen-based) row and column under the mouse cursor. |
733 | (real, not screen-based) row and column under the mouse cursor. |
546 | |
734 | |
… | |
… | |
555 | |
743 | |
556 | =item on_wm_delete_window $term, $event |
744 | =item on_wm_delete_window $term, $event |
557 | |
745 | |
558 | Called when various types of ClientMessage events are received (all with |
746 | Called when various types of ClientMessage events are received (all with |
559 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
747 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
748 | |
|
|
749 | =item on_bell $term |
|
|
750 | |
|
|
751 | Called on receipt of a bell character. |
560 | |
752 | |
561 | =back |
753 | =back |
562 | |
754 | |
563 | =cut |
755 | =cut |
564 | |
756 | |
… | |
… | |
607 | The current terminal. This variable stores the current C<urxvt::term> |
799 | The current terminal. This variable stores the current C<urxvt::term> |
608 | object, whenever a callback/hook is executing. |
800 | object, whenever a callback/hook is executing. |
609 | |
801 | |
610 | =item @urxvt::TERM_INIT |
802 | =item @urxvt::TERM_INIT |
611 | |
803 | |
612 | All coderefs in this array will be called as methods of the next newly |
804 | All code references in this array will be called as methods of the next newly |
613 | created C<urxvt::term> object (during the C<on_init> phase). The array |
805 | created C<urxvt::term> object (during the C<on_init> phase). The array |
614 | gets cleared before the codereferences that were in it are being executed, |
806 | gets cleared before the code references that were in it are being executed, |
615 | so coderefs can push themselves onto it again if they so desire. |
807 | so references can push themselves onto it again if they so desire. |
616 | |
808 | |
617 | This complements to the perl-eval commandline option, but gets executed |
809 | This complements to the perl-eval command line option, but gets executed |
618 | first. |
810 | first. |
619 | |
811 | |
620 | =item @urxvt::TERM_EXT |
812 | =item @urxvt::TERM_EXT |
621 | |
813 | |
622 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
814 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
629 | |
821 | |
630 | =over 4 |
822 | =over 4 |
631 | |
823 | |
632 | =item urxvt::fatal $errormessage |
824 | =item urxvt::fatal $errormessage |
633 | |
825 | |
634 | Fatally aborts execution with the given error message. Avoid at all |
826 | Fatally aborts execution with the given error message (which should |
635 | costs! The only time this is acceptable is when the terminal process |
827 | include a trailing newline). Avoid at all costs! The only time this |
636 | starts up. |
828 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
829 | terminal from starting up. |
637 | |
830 | |
638 | =item urxvt::warn $string |
831 | =item urxvt::warn $string |
639 | |
832 | |
640 | Calls C<rxvt_warn> with the given string which should not include a |
833 | Calls C<rxvt_warn> with the given string which should include a trailing |
641 | newline. The module also overwrites the C<warn> builtin with a function |
834 | newline. The module also overwrites the C<warn> builtin with a function |
642 | that calls this function. |
835 | that calls this function. |
643 | |
836 | |
644 | Using this function has the advantage that its output ends up in the |
837 | Using this function has the advantage that its output ends up in the |
645 | correct place, e.g. on stderr of the connecting urxvtc client. |
838 | correct place, e.g. on stderr of the connecting urxvtc client. |
646 | |
839 | |
647 | Messages have a size limit of 1023 bytes currently. |
840 | Messages have a size limit of 1023 bytes currently. |
|
|
841 | |
|
|
842 | =item @terms = urxvt::termlist |
|
|
843 | |
|
|
844 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
845 | whether they are started, being destroyed etc., so be careful. Only term |
|
|
846 | objects that have perl extensions attached will be returned (because there |
|
|
847 | is no urxvt::term object associated with others). |
648 | |
848 | |
649 | =item $time = urxvt::NOW |
849 | =item $time = urxvt::NOW |
650 | |
850 | |
651 | Returns the "current time" (as per the event loop). |
851 | Returns the "current time" (as per the event loop). |
652 | |
852 | |
… | |
… | |
695 | |
895 | |
696 | =item $rend = urxvt::OVERLAY_RSTYLE |
896 | =item $rend = urxvt::OVERLAY_RSTYLE |
697 | |
897 | |
698 | Return the rendition mask used for overlays by default. |
898 | Return the rendition mask used for overlays by default. |
699 | |
899 | |
700 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
900 | =item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, |
|
|
901 | urxvt::RS_RVid, urxvt::RS_Uline |
701 | |
902 | |
702 | Return the bit that enabled bold, italic, blink, reverse-video and |
903 | Return the bit that enabled bold, italic, blink, reverse-video and |
703 | underline, respectively. To enable such a style, just logically OR it into |
904 | underline, respectively. To enable such a style, just logically OR it into |
704 | the bitset. |
905 | the bitset. |
705 | |
906 | |
… | |
… | |
710 | Return the foreground/background colour index, respectively. |
911 | Return the foreground/background colour index, respectively. |
711 | |
912 | |
712 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
913 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
713 | |
914 | |
714 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
915 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
916 | |
|
|
917 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
715 | |
918 | |
716 | Replace the foreground/background colour in the rendition mask with the |
919 | Replace the foreground/background colour in the rendition mask with the |
717 | specified one. |
920 | specified one. |
718 | |
921 | |
719 | =item $value = urxvt::GET_CUSTOM $rend |
922 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
740 | }; |
943 | }; |
741 | } |
944 | } |
742 | |
945 | |
743 | no warnings 'utf8'; |
946 | no warnings 'utf8'; |
744 | |
947 | |
|
|
948 | sub resource { |
|
|
949 | my ($term, $name, $isarg, $flag, $value) = @_; |
|
|
950 | |
|
|
951 | warn "resourece<@_>\n";#d# |
|
|
952 | |
|
|
953 | 0 |
|
|
954 | } |
|
|
955 | |
745 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
956 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
746 | |
957 | |
747 | sub verbose { |
958 | sub verbose { |
748 | my ($level, $msg) = @_; |
959 | my ($level, $msg) = @_; |
749 | warn "$msg\n" if $level <= $verbosity; |
960 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
785 | sub invoke { |
996 | sub invoke { |
786 | local $TERM = shift; |
997 | local $TERM = shift; |
787 | my $htype = shift; |
998 | my $htype = shift; |
788 | |
999 | |
789 | if ($htype == 0) { # INIT |
1000 | if ($htype == 0) { # INIT |
790 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
1001 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl"); |
791 | |
1002 | |
792 | my %ext_arg; |
1003 | my %ext_arg; |
793 | |
1004 | |
794 | { |
1005 | { |
795 | my @init = @TERM_INIT; |
1006 | my @init = @TERM_INIT; |
796 | @TERM_INIT = (); |
1007 | @TERM_INIT = (); |
… | |
… | |
810 | } else { |
1021 | } else { |
811 | $ext_arg{$_} ||= []; |
1022 | $ext_arg{$_} ||= []; |
812 | } |
1023 | } |
813 | } |
1024 | } |
814 | |
1025 | |
815 | while (my ($ext, $argv) = each %ext_arg) { |
1026 | for my $ext (sort keys %ext_arg) { |
816 | my @files = grep -f $_, map "$_/$ext", @dirs; |
1027 | my @files = grep -f $_, map "$_/$ext", @dirs; |
817 | |
1028 | |
818 | if (@files) { |
1029 | if (@files) { |
819 | $TERM->register_package (extension_package $files[0], $argv); |
1030 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
820 | } else { |
1031 | } else { |
821 | warn "perl extension '$ext' not found in perl library search path\n"; |
1032 | warn "perl extension '$ext' not found in perl library search path\n"; |
822 | } |
1033 | } |
823 | } |
1034 | } |
824 | |
1035 | |
… | |
… | |
830 | |
1041 | |
831 | if (my $cb = $TERM->{_hook}[$htype]) { |
1042 | if (my $cb = $TERM->{_hook}[$htype]) { |
832 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
1043 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
833 | if $verbosity >= 10; |
1044 | if $verbosity >= 10; |
834 | |
1045 | |
835 | keys %$cb; |
1046 | for my $pkg (keys %$cb) { |
836 | |
|
|
837 | while (my ($pkg, $cb) = each %$cb) { |
|
|
838 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
1047 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
839 | $retval ||= $retval_; |
1048 | $retval ||= $retval_; |
840 | |
1049 | |
841 | if ($@) { |
1050 | if ($@) { |
842 | $TERM->ungrab; # better to lose the grab than the session |
1051 | $TERM->ungrab; # better to lose the grab than the session |
843 | warn $@; |
1052 | warn $@; |
… | |
… | |
855 | # clear package |
1064 | # clear package |
856 | %$TERM = (); |
1065 | %$TERM = (); |
857 | } |
1066 | } |
858 | |
1067 | |
859 | $retval |
1068 | $retval |
|
|
1069 | } |
|
|
1070 | |
|
|
1071 | sub SET_COLOR($$$) { |
|
|
1072 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
1073 | } |
|
|
1074 | |
|
|
1075 | sub rend2mask { |
|
|
1076 | no strict 'refs'; |
|
|
1077 | my ($str, $mask) = (@_, 0); |
|
|
1078 | my %color = ( fg => undef, bg => undef ); |
|
|
1079 | my @failed; |
|
|
1080 | for my $spec ( split /\s+/, $str ) { |
|
|
1081 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1082 | $color{lc($1)} = $2; |
|
|
1083 | } else { |
|
|
1084 | my $neg = $spec =~ s/^[-^]//; |
|
|
1085 | unless ( exists &{"RS_$spec"} ) { |
|
|
1086 | push @failed, $spec; |
|
|
1087 | next; |
|
|
1088 | } |
|
|
1089 | my $cur = &{"RS_$spec"}; |
|
|
1090 | if ( $neg ) { |
|
|
1091 | $mask &= ~$cur; |
|
|
1092 | } else { |
|
|
1093 | $mask |= $cur; |
|
|
1094 | } |
|
|
1095 | } |
|
|
1096 | } |
|
|
1097 | ($mask, @color{qw(fg bg)}, \@failed) |
860 | } |
1098 | } |
861 | |
1099 | |
862 | # urxvt::term::extension |
1100 | # urxvt::term::extension |
863 | |
1101 | |
864 | package urxvt::term::extension; |
1102 | package urxvt::term::extension; |
… | |
… | |
935 | is that you cannot use blocking APIs, but the non-blocking variant should |
1173 | is that you cannot use blocking APIs, but the non-blocking variant should |
936 | work. |
1174 | work. |
937 | |
1175 | |
938 | =cut |
1176 | =cut |
939 | |
1177 | |
940 | our $VERSION = 1; |
1178 | our $VERSION = '5.23'; |
941 | |
1179 | |
942 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1180 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
943 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1181 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
944 | |
1182 | |
945 | sub timer { |
1183 | sub timer { |
… | |
… | |
947 | |
1185 | |
948 | my $cb = $arg{cb}; |
1186 | my $cb = $arg{cb}; |
949 | |
1187 | |
950 | urxvt::timer |
1188 | urxvt::timer |
951 | ->new |
1189 | ->new |
952 | ->start (urxvt::NOW + $arg{after}) |
1190 | ->after ($arg{after}, $arg{interval}) |
953 | ->cb (sub { |
1191 | ->cb ($arg{interval} ? $cb : sub { |
954 | $_[0]->stop; # need to cancel manually |
1192 | $_[0]->stop; # need to cancel manually |
955 | $cb->(); |
1193 | $cb->(); |
956 | }) |
1194 | }) |
957 | } |
1195 | } |
958 | |
1196 | |
959 | sub io { |
1197 | sub io { |
960 | my ($class, %arg) = @_; |
1198 | my ($class, %arg) = @_; |
961 | |
1199 | |
962 | my $cb = $arg{cb}; |
1200 | my $cb = $arg{cb}; |
|
|
1201 | my $fd = fileno $arg{fh}; |
|
|
1202 | defined $fd or $fd = $arg{fh}; |
963 | |
1203 | |
964 | bless [$arg{fh}, urxvt::iow |
1204 | bless [$arg{fh}, urxvt::iow |
965 | ->new |
1205 | ->new |
966 | ->fd (fileno $arg{fh}) |
1206 | ->fd ($fd) |
967 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1207 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
968 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1208 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
969 | ->start |
1209 | ->start |
970 | ->cb (sub { |
1210 | ->cb ($cb) |
971 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
972 | . ($_[1] & 2 ? 'w' : '')); |
|
|
973 | })], |
|
|
974 | urxvt::anyevent:: |
1211 | ], urxvt::anyevent:: |
|
|
1212 | } |
|
|
1213 | |
|
|
1214 | sub idle { |
|
|
1215 | my ($class, %arg) = @_; |
|
|
1216 | |
|
|
1217 | my $cb = $arg{cb}; |
|
|
1218 | |
|
|
1219 | urxvt::iw |
|
|
1220 | ->new |
|
|
1221 | ->start |
|
|
1222 | ->cb ($cb) |
|
|
1223 | } |
|
|
1224 | |
|
|
1225 | sub child { |
|
|
1226 | my ($class, %arg) = @_; |
|
|
1227 | |
|
|
1228 | my $cb = $arg{cb}; |
|
|
1229 | |
|
|
1230 | urxvt::pw |
|
|
1231 | ->new |
|
|
1232 | ->start ($arg{pid}) |
|
|
1233 | ->cb (sub { |
|
|
1234 | $_[0]->stop; # need to cancel manually |
|
|
1235 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1236 | }) |
975 | } |
1237 | } |
976 | |
1238 | |
977 | sub DESTROY { |
1239 | sub DESTROY { |
978 | $_[0][1]->stop; |
1240 | $_[0][1]->stop; |
979 | } |
1241 | } |
980 | |
1242 | |
981 | sub condvar { |
1243 | # only needed for AnyEvent < 6 compatibility |
982 | bless \my $flag, urxvt::anyevent::condvar:: |
1244 | sub one_event { |
983 | } |
|
|
984 | |
|
|
985 | sub urxvt::anyevent::condvar::broadcast { |
|
|
986 | ${$_[0]}++; |
|
|
987 | } |
|
|
988 | |
|
|
989 | sub urxvt::anyevent::condvar::wait { |
|
|
990 | unless (${$_[0]}) { |
|
|
991 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1245 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
992 | } |
|
|
993 | } |
1246 | } |
994 | |
1247 | |
995 | package urxvt::term; |
1248 | package urxvt::term; |
996 | |
1249 | |
997 | =head2 The C<urxvt::term> Class |
1250 | =head2 The C<urxvt::term> Class |
… | |
… | |
1033 | hash which defines the environment of the new terminal. |
1286 | hash which defines the environment of the new terminal. |
1034 | |
1287 | |
1035 | Croaks (and probably outputs an error message) if the new instance |
1288 | Croaks (and probably outputs an error message) if the new instance |
1036 | couldn't be created. Returns C<undef> if the new instance didn't |
1289 | couldn't be created. Returns C<undef> if the new instance didn't |
1037 | initialise perl, and the terminal object otherwise. The C<init> and |
1290 | initialise perl, and the terminal object otherwise. The C<init> and |
1038 | C<start> hooks will be called during this call. |
1291 | C<start> hooks will be called before this call returns, and are free to |
|
|
1292 | refer to global data (which is race free). |
1039 | |
1293 | |
1040 | =cut |
1294 | =cut |
1041 | |
1295 | |
1042 | sub new { |
1296 | sub new { |
1043 | my ($class, $env, @args) = @_; |
1297 | my ($class, $env, @args) = @_; |
1044 | |
1298 | |
|
|
1299 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1300 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1301 | |
1045 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1302 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1046 | } |
1303 | } |
1047 | |
1304 | |
1048 | =item $term->destroy |
1305 | =item $term->destroy |
1049 | |
1306 | |
1050 | Destroy the terminal object (close the window, free resources |
1307 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1080 | |
1337 | |
1081 | Returns true if the option specified by C<$optval> is enabled, and |
1338 | Returns true if the option specified by C<$optval> is enabled, and |
1082 | optionally change it. All option values are stored by name in the hash |
1339 | optionally change it. All option values are stored by name in the hash |
1083 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1340 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1084 | |
1341 | |
1085 | Here is a a likely non-exhaustive list of option names, please see the |
1342 | Here is a likely non-exhaustive list of option names, please see the |
1086 | source file F</src/optinc.h> to see the actual list: |
1343 | source file F</src/optinc.h> to see the actual list: |
1087 | |
1344 | |
1088 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1345 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
1089 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1346 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1090 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1347 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1091 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
1348 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1092 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
1349 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1093 | transparent tripleclickwords utmpInhibit visualBell |
1350 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
|
|
1351 | urgentOnBell utmpInhibit visualBell |
1094 | |
1352 | |
1095 | =item $value = $term->resource ($name[, $newval]) |
1353 | =item $value = $term->resource ($name[, $newval]) |
1096 | |
1354 | |
1097 | Returns the current resource value associated with a given name and |
1355 | Returns the current resource value associated with a given name and |
1098 | optionally sets a new value. Setting values is most useful in the C<init> |
1356 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
1107 | likely change). |
1365 | likely change). |
1108 | |
1366 | |
1109 | Please note that resource strings will currently only be freed when the |
1367 | Please note that resource strings will currently only be freed when the |
1110 | terminal is destroyed, so changing options frequently will eat memory. |
1368 | terminal is destroyed, so changing options frequently will eat memory. |
1111 | |
1369 | |
1112 | Here is a a likely non-exhaustive list of resource names, not all of which |
1370 | Here is a likely non-exhaustive list of resource names, not all of which |
1113 | are supported in every build, please see the source file F</src/rsinc.h> |
1371 | are supported in every build, please see the source file F</src/rsinc.h> |
1114 | to see the actual list: |
1372 | to see the actual list: |
1115 | |
1373 | |
1116 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1374 | answerbackstring backgroundPixmap backspace_key blendtype blurradius |
1117 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1375 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1118 | display_name embed ext_bwidth fade font geometry hold iconName |
1376 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1119 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1377 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
|
|
1378 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
1120 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1379 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1121 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1380 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1122 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1381 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1123 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1382 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1124 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1383 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1125 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1384 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1126 | secondaryScreen secondaryScroll selectstyle shade term_name title |
1385 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1127 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1386 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1128 | visualBell |
1387 | utmpInhibit visualBell |
1129 | |
1388 | |
1130 | =cut |
1389 | =cut |
1131 | |
1390 | |
1132 | sub resource($$;$) { |
1391 | sub resource($$;$) { |
1133 | my ($self, $name) = (shift, shift); |
1392 | my ($self, $name) = (shift, shift); |
1134 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1393 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1135 | &urxvt::term::_resource |
1394 | goto &urxvt::term::_resource |
1136 | } |
1395 | } |
1137 | |
1396 | |
1138 | =item $value = $term->x_resource ($pattern) |
1397 | =item $value = $term->x_resource ($pattern) |
1139 | |
1398 | |
1140 | Returns the X-Resource for the given pattern, excluding the program or |
1399 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
1144 | |
1403 | |
1145 | This method should only be called during the C<on_start> hook, as there is |
1404 | This method should only be called during the C<on_start> hook, as there is |
1146 | only one resource database per display, and later invocations might return |
1405 | only one resource database per display, and later invocations might return |
1147 | the wrong resources. |
1406 | the wrong resources. |
1148 | |
1407 | |
1149 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
1408 | =item $success = $term->parse_keysym ($key, $octets) |
1150 | |
1409 | |
1151 | Adds a keymap translation exactly as specified via a resource. See the |
1410 | Adds a key binding exactly as specified via a resource. See the |
1152 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1411 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
|
|
1412 | |
|
|
1413 | =item $term->register_command ($keysym, $modifiermask, $string) |
|
|
1414 | |
|
|
1415 | Adds a key binding. This is a lower level api compared to |
|
|
1416 | C<parse_keysym>, as it expects a parsed key description, and can be |
|
|
1417 | used only inside either the C<on_init> hook, to add a binding, or the |
|
|
1418 | C<on_register_command> hook, to modify a parsed binding. |
1153 | |
1419 | |
1154 | =item $rend = $term->rstyle ([$new_rstyle]) |
1420 | =item $rend = $term->rstyle ([$new_rstyle]) |
1155 | |
1421 | |
1156 | Return and optionally change the current rendition. Text that is output by |
1422 | Return and optionally change the current rendition. Text that is output by |
1157 | the terminal application will use this style. |
1423 | the terminal application will use this style. |
… | |
… | |
1165 | |
1431 | |
1166 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1432 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1167 | |
1433 | |
1168 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1434 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1169 | |
1435 | |
1170 | Return the current values of the selection mark, begin or end positions, |
1436 | Return the current values of the selection mark, begin or end positions. |
1171 | and optionally set them to new values. |
1437 | |
|
|
1438 | When arguments are given, then the selection coordinates are set to |
|
|
1439 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1440 | screen. |
|
|
1441 | |
|
|
1442 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1443 | |
|
|
1444 | Returns the current selection screen, and then optionally sets it. |
1172 | |
1445 | |
1173 | =item $term->selection_make ($eventtime[, $rectangular]) |
1446 | =item $term->selection_make ($eventtime[, $rectangular]) |
1174 | |
1447 | |
1175 | Tries to make a selection as set by C<selection_beg> and |
1448 | Tries to make a selection as set by C<selection_beg> and |
1176 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1449 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1177 | rectangular selection will be made. This is the prefered function to make |
1450 | rectangular selection will be made. This is the preferred function to make |
1178 | a selection. |
1451 | a selection. |
1179 | |
1452 | |
1180 | =item $success = $term->selection_grab ($eventtime) |
1453 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
1181 | |
1454 | |
1182 | Try to request the primary selection text from the server (for example, as |
1455 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1456 | true) selection from the server. The corresponding text can be set |
1183 | set by the next method). No visual feedback will be given. This function |
1457 | with the next method. No visual feedback will be given. This function |
1184 | is mostly useful from within C<on_sel_grab> hooks. |
1458 | is mostly useful from within C<on_sel_grab> hooks. |
1185 | |
1459 | |
1186 | =item $oldtext = $term->selection ([$newtext]) |
1460 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
1187 | |
1461 | |
1188 | Return the current selection text and optionally replace it by C<$newtext>. |
1462 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1463 | and optionally replace it by C<$newtext>. |
|
|
1464 | |
|
|
1465 | =item $term->selection_clear ([$clipboard]) |
|
|
1466 | |
|
|
1467 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
1189 | |
1468 | |
1190 | =item $term->overlay_simple ($x, $y, $text) |
1469 | =item $term->overlay_simple ($x, $y, $text) |
1191 | |
1470 | |
1192 | Create a simple multi-line overlay box. See the next method for details. |
1471 | Create a simple multi-line overlay box. See the next method for details. |
1193 | |
1472 | |
… | |
… | |
1223 | |
1502 | |
1224 | The methods currently supported on C<urxvt::overlay> objects are: |
1503 | The methods currently supported on C<urxvt::overlay> objects are: |
1225 | |
1504 | |
1226 | =over 4 |
1505 | =over 4 |
1227 | |
1506 | |
1228 | =item $overlay->set ($x, $y, $text, $rend) |
1507 | =item $overlay->set ($x, $y, $text[, $rend]) |
1229 | |
1508 | |
1230 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1509 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1231 | text in rxvt-unicode's special encoding and an array of rendition values |
1510 | text in rxvt-unicode's special encoding and an array of rendition values |
1232 | at a specific position inside the overlay. |
1511 | at a specific position inside the overlay. |
|
|
1512 | |
|
|
1513 | If C<$rend> is missing, then the rendition will not be changed. |
1233 | |
1514 | |
1234 | =item $overlay->hide |
1515 | =item $overlay->hide |
1235 | |
1516 | |
1236 | If visible, hide the overlay, but do not destroy it. |
1517 | If visible, hide the overlay, but do not destroy it. |
1237 | |
1518 | |
… | |
… | |
1319 | locale-specific encoding of the terminal and can contain command sequences |
1600 | locale-specific encoding of the terminal and can contain command sequences |
1320 | (escape codes) that will be interpreted. |
1601 | (escape codes) that will be interpreted. |
1321 | |
1602 | |
1322 | =item $term->tt_write ($octets) |
1603 | =item $term->tt_write ($octets) |
1323 | |
1604 | |
1324 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1605 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1325 | pass characters instead of octets, you should convert your strings first |
1606 | pass characters instead of octets, you should convert your strings first |
1326 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1607 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1608 | |
|
|
1609 | =item $term->tt_paste ($octets) |
|
|
1610 | |
|
|
1611 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1612 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1613 | is set. |
1327 | |
1614 | |
1328 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1615 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1329 | |
1616 | |
1330 | Replaces the event mask of the pty watcher by the given event mask. Can |
1617 | Replaces the event mask of the pty watcher by the given event mask. Can |
1331 | be used to suppress input and output handling to the pty/tty. See the |
1618 | be used to suppress input and output handling to the pty/tty. See the |
… | |
… | |
1350 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1637 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1351 | to receive pointer events all the times: |
1638 | to receive pointer events all the times: |
1352 | |
1639 | |
1353 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1640 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1354 | |
1641 | |
|
|
1642 | =item $term->set_urgency ($set) |
|
|
1643 | |
|
|
1644 | Enable/disable the urgency hint on the toplevel window. |
|
|
1645 | |
|
|
1646 | =item $term->focus_in |
|
|
1647 | |
|
|
1648 | =item $term->focus_out |
|
|
1649 | |
|
|
1650 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1651 | |
|
|
1652 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1653 | |
|
|
1654 | Deliver various fake events to to terminal. |
|
|
1655 | |
1355 | =item $window_width = $term->width |
1656 | =item $window_width = $term->width |
1356 | |
1657 | |
1357 | =item $window_height = $term->height |
1658 | =item $window_height = $term->height |
1358 | |
1659 | |
1359 | =item $font_width = $term->fwidth |
1660 | =item $font_width = $term->fwidth |
… | |
… | |
1389 | =item $env = $term->env |
1690 | =item $env = $term->env |
1390 | |
1691 | |
1391 | Returns a copy of the environment in effect for the terminal as a hashref |
1692 | Returns a copy of the environment in effect for the terminal as a hashref |
1392 | similar to C<\%ENV>. |
1693 | similar to C<\%ENV>. |
1393 | |
1694 | |
|
|
1695 | =item @envv = $term->envv |
|
|
1696 | |
|
|
1697 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1698 | |
|
|
1699 | =item @argv = $term->argv |
|
|
1700 | |
|
|
1701 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1702 | includes the program name as first element. |
|
|
1703 | |
1394 | =cut |
1704 | =cut |
1395 | |
1705 | |
1396 | sub env { |
1706 | sub env { |
1397 | if (my $env = $_[0]->_env) { |
|
|
1398 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1707 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1399 | } else { |
|
|
1400 | +{ %ENV } |
|
|
1401 | } |
|
|
1402 | } |
1708 | } |
1403 | |
1709 | |
1404 | =item $modifiermask = $term->ModLevel3Mask |
1710 | =item $modifiermask = $term->ModLevel3Mask |
1405 | |
1711 | |
1406 | =item $modifiermask = $term->ModMetaMask |
1712 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1414 | |
1720 | |
1415 | Returns the currently displayed screen (0 primary, 1 secondary). |
1721 | Returns the currently displayed screen (0 primary, 1 secondary). |
1416 | |
1722 | |
1417 | =item $cursor_is_hidden = $term->hidden_cursor |
1723 | =item $cursor_is_hidden = $term->hidden_cursor |
1418 | |
1724 | |
1419 | Returns wether the cursor is currently hidden or not. |
1725 | Returns whether the cursor is currently hidden or not. |
1420 | |
1726 | |
1421 | =item $view_start = $term->view_start ([$newvalue]) |
1727 | =item $view_start = $term->view_start ([$newvalue]) |
1422 | |
1728 | |
1423 | Returns the row number of the topmost displayed line. Maximum value is |
1729 | Returns the row number of the topmost displayed line. Maximum value is |
1424 | C<0>, which displays the normal terminal contents. Lower values scroll |
1730 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1432 | |
1738 | |
1433 | Used after changing terminal contents to display them. |
1739 | Used after changing terminal contents to display them. |
1434 | |
1740 | |
1435 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1741 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1436 | |
1742 | |
1437 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1743 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1438 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1744 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1439 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1440 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1745 | terminal line. Nothing will be returned if a nonexistent line |
1441 | is requested. |
1746 | is requested. |
1442 | |
1747 | |
1443 | If C<$new_text> is specified, it will replace characters in the current |
1748 | If C<$new_text> is specified, it will replace characters in the current |
1444 | line, starting at column C<$start_col> (default C<0>), which is useful |
1749 | line, starting at column C<$start_col> (default C<0>), which is useful |
1445 | to replace only parts of a line. The font index in the rendition will |
1750 | to replace only parts of a line. The font index in the rendition will |
1446 | automatically be updated. |
1751 | automatically be updated. |
1447 | |
1752 | |
1448 | C<$text> is in a special encoding: tabs and wide characters that use more |
1753 | C<$text> is in a special encoding: tabs and wide characters that use more |
1449 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1754 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1450 | characters. Characters with combining characters and other characters that |
1755 | characters. Characters with combining characters and other characters that |
1451 | do not fit into the normal tetx encoding will be replaced with characters |
1756 | do not fit into the normal text encoding will be replaced with characters |
1452 | in the private use area. |
1757 | in the private use area. |
1453 | |
1758 | |
1454 | You have to obey this encoding when changing text. The advantage is |
1759 | You have to obey this encoding when changing text. The advantage is |
1455 | that C<substr> and similar functions work on screen cells and not on |
1760 | that C<substr> and similar functions work on screen cells and not on |
1456 | characters. |
1761 | characters. |
… | |
… | |
1601 | where one character corresponds to one screen cell. See |
1906 | where one character corresponds to one screen cell. See |
1602 | C<< $term->ROW_t >> for details. |
1907 | C<< $term->ROW_t >> for details. |
1603 | |
1908 | |
1604 | =item $string = $term->special_decode $text |
1909 | =item $string = $term->special_decode $text |
1605 | |
1910 | |
1606 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1911 | Converts rxvt-unicodes text representation into a perl string. See |
1607 | C<< $term->ROW_t >> for details. |
1912 | C<< $term->ROW_t >> for details. |
1608 | |
1913 | |
1609 | =item $success = $term->grab_button ($button, $modifiermask) |
1914 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1610 | |
1915 | |
|
|
1916 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1917 | |
1611 | Registers a synchronous button grab. See the XGrabButton manpage. |
1918 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1919 | manpage. |
1612 | |
1920 | |
1613 | =item $success = $term->grab ($eventtime[, $sync]) |
1921 | =item $success = $term->grab ($eventtime[, $sync]) |
1614 | |
1922 | |
1615 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1923 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1616 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1924 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1617 | |
1925 | |
1618 | =item $term->allow_events_async |
1926 | =item $term->allow_events_async |
1619 | |
1927 | |
1620 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1928 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1621 | |
1929 | |
… | |
… | |
1628 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1936 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1629 | recent grab. |
1937 | recent grab. |
1630 | |
1938 | |
1631 | =item $term->ungrab |
1939 | =item $term->ungrab |
1632 | |
1940 | |
1633 | Calls XUngrab for the most recent grab. Is called automatically on |
1941 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
1634 | evaluation errors, as it is better to lose the grab in the error case as |
1942 | evaluation errors, as it is better to lose the grab in the error case as |
1635 | the session. |
1943 | the session. |
1636 | |
1944 | |
1637 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1945 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1638 | |
1946 | |
… | |
… | |
1640 | |
1948 | |
1641 | =item @atoms = $term->XListProperties ($window) |
1949 | =item @atoms = $term->XListProperties ($window) |
1642 | |
1950 | |
1643 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1951 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1644 | |
1952 | |
1645 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
1953 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
1646 | |
1954 | |
1647 | =item $term->XDeleteProperty ($window, $property) |
1955 | =item $term->XDeleteProperty ($window, $property) |
1648 | |
1956 | |
1649 | =item $window = $term->DefaultRootWindow |
1957 | =item $window = $term->DefaultRootWindow |
1650 | |
1958 | |
… | |
… | |
1657 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
1965 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
1658 | |
1966 | |
1659 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1967 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1660 | |
1968 | |
1661 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1969 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1970 | |
|
|
1971 | =item $keysym = $term->XStringToKeysym ($string) |
|
|
1972 | |
|
|
1973 | =item $string = $term->XKeysymToString ($keysym) |
1662 | |
1974 | |
1663 | Various X or X-related functions. The C<$term> object only serves as |
1975 | Various X or X-related functions. The C<$term> object only serves as |
1664 | the source of the display, otherwise those functions map more-or-less |
1976 | the source of the display, otherwise those functions map more-or-less |
1665 | directory onto the X functions of the same name. |
1977 | directly onto the X functions of the same name. |
1666 | |
1978 | |
1667 | =back |
1979 | =back |
1668 | |
1980 | |
1669 | =cut |
1981 | =cut |
1670 | |
1982 | |
… | |
… | |
1734 | my ($self, $text, $cb) = @_; |
2046 | my ($self, $text, $cb) = @_; |
1735 | |
2047 | |
1736 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
2048 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1737 | } |
2049 | } |
1738 | |
2050 | |
1739 | =item $popup->add_toggle ($text, $cb, $initial_value) |
2051 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1740 | |
2052 | |
1741 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
2053 | Adds a toggle/checkbox item to the popup. The callback gets called |
1742 | whenever it gets toggled, with a boolean indicating its value as its first |
2054 | whenever it gets toggled, with a boolean indicating its new value as its |
1743 | argument. |
2055 | first argument. |
1744 | |
2056 | |
1745 | =cut |
2057 | =cut |
1746 | |
2058 | |
1747 | sub add_toggle { |
2059 | sub add_toggle { |
1748 | my ($self, $text, $cb, $value) = @_; |
2060 | my ($self, $text, $value, $cb) = @_; |
1749 | |
2061 | |
1750 | my $item; $item = { |
2062 | my $item; $item = { |
1751 | type => "button", |
2063 | type => "button", |
1752 | text => " $text", |
2064 | text => " $text", |
1753 | value => $value, |
2065 | value => $value, |
… | |
… | |
1772 | my $env = $self->{term}->env; |
2084 | my $env = $self->{term}->env; |
1773 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
2085 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1774 | delete $env->{LC_ALL}; |
2086 | delete $env->{LC_ALL}; |
1775 | $env->{LC_CTYPE} = $self->{term}->locale; |
2087 | $env->{LC_CTYPE} = $self->{term}->locale; |
1776 | |
2088 | |
1777 | urxvt::term->new ($env, "popup", |
2089 | my $term = urxvt::term->new ( |
|
|
2090 | $env, "popup", |
1778 | "--perl-lib" => "", "--perl-ext-common" => "", |
2091 | "--perl-lib" => "", "--perl-ext-common" => "", |
1779 | "-pty-fd" => -1, "-sl" => 0, |
2092 | "-pty-fd" => -1, "-sl" => 0, |
1780 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
2093 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1781 | "--transient-for" => $self->{term}->parent, |
2094 | "--transient-for" => $self->{term}->parent, |
1782 | "-display" => $self->{term}->display_id, |
2095 | "-display" => $self->{term}->display_id, |
1783 | "-pe" => "urxvt-popup") |
2096 | "-pe" => "urxvt-popup", |
1784 | or die "unable to create popup window\n"; |
2097 | ) or die "unable to create popup window\n"; |
|
|
2098 | |
|
|
2099 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
2100 | $term->ungrab; |
|
|
2101 | $term->destroy; |
|
|
2102 | die "unable to initialise popup window\n"; |
|
|
2103 | } |
1785 | } |
2104 | } |
1786 | |
2105 | |
1787 | sub DESTROY { |
2106 | sub DESTROY { |
1788 | my ($self) = @_; |
2107 | my ($self) = @_; |
1789 | |
2108 | |
… | |
… | |
1794 | =back |
2113 | =back |
1795 | |
2114 | |
1796 | =cut |
2115 | =cut |
1797 | |
2116 | |
1798 | package urxvt::watcher; |
2117 | package urxvt::watcher; |
1799 | |
|
|
1800 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1801 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1802 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1803 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1804 | |
2118 | |
1805 | =head2 The C<urxvt::timer> Class |
2119 | =head2 The C<urxvt::timer> Class |
1806 | |
2120 | |
1807 | This class implements timer watchers/events. Time is represented as a |
2121 | This class implements timer watchers/events. Time is represented as a |
1808 | fractional number of seconds since the epoch. Example: |
2122 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1812 | ->new |
2126 | ->new |
1813 | ->interval (1) |
2127 | ->interval (1) |
1814 | ->cb (sub { |
2128 | ->cb (sub { |
1815 | $term->{overlay}->set (0, 0, |
2129 | $term->{overlay}->set (0, 0, |
1816 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2130 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1817 | }); |
2131 | }); |
1818 | |
2132 | |
1819 | =over 4 |
2133 | =over 4 |
1820 | |
2134 | |
1821 | =item $timer = new urxvt::timer |
2135 | =item $timer = new urxvt::timer |
1822 | |
2136 | |
… | |
… | |
1825 | |
2139 | |
1826 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2140 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
1827 | |
2141 | |
1828 | Set the callback to be called when the timer triggers. |
2142 | Set the callback to be called when the timer triggers. |
1829 | |
2143 | |
1830 | =item $tstamp = $timer->at |
|
|
1831 | |
|
|
1832 | Return the time this watcher will fire next. |
|
|
1833 | |
|
|
1834 | =item $timer = $timer->set ($tstamp) |
2144 | =item $timer = $timer->set ($tstamp[, $interval]) |
1835 | |
2145 | |
1836 | Set the time the event is generated to $tstamp. |
2146 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2147 | new $interval). |
1837 | |
2148 | |
1838 | =item $timer = $timer->interval ($interval) |
2149 | =item $timer = $timer->interval ($interval) |
1839 | |
2150 | |
1840 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2151 | By default (and when C<$interval> is C<0>), the timer will automatically |
1841 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2152 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
1842 | is automatically rescheduled at the given intervals. |
2153 | is automatically rescheduled at the given intervals. |
1843 | |
2154 | |
1844 | =item $timer = $timer->start |
2155 | =item $timer = $timer->start |
1845 | |
2156 | |
1846 | Start the timer. |
2157 | Start the timer. |
1847 | |
2158 | |
1848 | =item $timer = $timer->start ($tstamp) |
2159 | =item $timer = $timer->start ($tstamp[, $interval]) |
1849 | |
2160 | |
1850 | Set the event trigger time to C<$tstamp> and start the timer. |
2161 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2162 | also replaces the interval. |
1851 | |
2163 | |
1852 | =item $timer = $timer->after ($delay) |
2164 | =item $timer = $timer->after ($delay[, $interval]) |
1853 | |
2165 | |
1854 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2166 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1855 | |
2167 | |
1856 | =item $timer = $timer->stop |
2168 | =item $timer = $timer->stop |
1857 | |
2169 | |
… | |
… | |
1865 | |
2177 | |
1866 | $term->{socket} = ... |
2178 | $term->{socket} = ... |
1867 | $term->{iow} = urxvt::iow |
2179 | $term->{iow} = urxvt::iow |
1868 | ->new |
2180 | ->new |
1869 | ->fd (fileno $term->{socket}) |
2181 | ->fd (fileno $term->{socket}) |
1870 | ->events (urxvt::EVENT_READ) |
2182 | ->events (urxvt::EV_READ) |
1871 | ->start |
2183 | ->start |
1872 | ->cb (sub { |
2184 | ->cb (sub { |
1873 | my ($iow, $revents) = @_; |
2185 | my ($iow, $revents) = @_; |
1874 | # $revents must be 1 here, no need to check |
2186 | # $revents must be 1 here, no need to check |
1875 | sysread $term->{socket}, my $buf, 8192 |
2187 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1888 | Set the callback to be called when io events are triggered. C<$reventmask> |
2200 | Set the callback to be called when io events are triggered. C<$reventmask> |
1889 | is a bitset as described in the C<events> method. |
2201 | is a bitset as described in the C<events> method. |
1890 | |
2202 | |
1891 | =item $iow = $iow->fd ($fd) |
2203 | =item $iow = $iow->fd ($fd) |
1892 | |
2204 | |
1893 | Set the filedescriptor (not handle) to watch. |
2205 | Set the file descriptor (not handle) to watch. |
1894 | |
2206 | |
1895 | =item $iow = $iow->events ($eventmask) |
2207 | =item $iow = $iow->events ($eventmask) |
1896 | |
2208 | |
1897 | Set the event mask to watch. The only allowed values are |
2209 | Set the event mask to watch. The only allowed values are |
1898 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2210 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
1899 | together, or C<urxvt::EVENT_NONE>. |
2211 | together, or C<urxvt::EV_NONE>. |
1900 | |
2212 | |
1901 | =item $iow = $iow->start |
2213 | =item $iow = $iow->start |
1902 | |
2214 | |
1903 | Start watching for requested events on the given handle. |
2215 | Start watching for requested events on the given handle. |
1904 | |
2216 | |
1905 | =item $iow = $iow->stop |
2217 | =item $iow = $iow->stop |
1906 | |
2218 | |
1907 | Stop watching for events on the given filehandle. |
2219 | Stop watching for events on the given file handle. |
1908 | |
2220 | |
1909 | =back |
2221 | =back |
1910 | |
2222 | |
1911 | =head2 The C<urxvt::iw> Class |
2223 | =head2 The C<urxvt::iw> Class |
1912 | |
2224 | |
… | |
… | |
1945 | ->new |
2257 | ->new |
1946 | ->start ($pid) |
2258 | ->start ($pid) |
1947 | ->cb (sub { |
2259 | ->cb (sub { |
1948 | my ($pw, $exit_status) = @_; |
2260 | my ($pw, $exit_status) = @_; |
1949 | ... |
2261 | ... |
1950 | }); |
2262 | }); |
1951 | |
2263 | |
1952 | =over 4 |
2264 | =over 4 |
1953 | |
2265 | |
1954 | =item $pw = new urxvt::pw |
2266 | =item $pw = new urxvt::pw |
1955 | |
2267 | |
… | |
… | |
1959 | |
2271 | |
1960 | Set the callback to be called when the timer triggers. |
2272 | Set the callback to be called when the timer triggers. |
1961 | |
2273 | |
1962 | =item $pw = $timer->start ($pid) |
2274 | =item $pw = $timer->start ($pid) |
1963 | |
2275 | |
1964 | Tells the wqtcher to start watching for process C<$pid>. |
2276 | Tells the watcher to start watching for process C<$pid>. |
1965 | |
2277 | |
1966 | =item $pw = $pw->stop |
2278 | =item $pw = $pw->stop |
1967 | |
2279 | |
1968 | Stop the watcher. |
2280 | Stop the watcher. |
1969 | |
2281 | |
… | |
… | |
1982 | |
2294 | |
1983 | =item >= 3 - script loading and management |
2295 | =item >= 3 - script loading and management |
1984 | |
2296 | |
1985 | =item >=10 - all called hooks |
2297 | =item >=10 - all called hooks |
1986 | |
2298 | |
1987 | =item >=11 - hook reutrn values |
2299 | =item >=11 - hook return values |
1988 | |
2300 | |
1989 | =back |
2301 | =back |
1990 | |
2302 | |
1991 | =head1 AUTHOR |
2303 | =head1 AUTHOR |
1992 | |
2304 | |
1993 | Marc Lehmann <pcg@goof.com> |
2305 | Marc Lehmann <schmorp@schmorp.de> |
1994 | http://software.schmorp.de/pkg/rxvt-unicode |
2306 | http://software.schmorp.de/pkg/rxvt-unicode |
1995 | |
2307 | |
1996 | =cut |
2308 | =cut |
1997 | |
2309 | |
1998 | 1 |
2310 | 1 |
|
|
2311 | |
|
|
2312 | # vim: sw=3: |