… | |
… | |
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 | |
36 | You can activate them like this: |
39 | You can activate them like this: |
37 | |
40 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
41 | @@RXVT_NAME@@ -pe <extensionname> |
|
|
42 | |
|
|
43 | Or by adding them to the resource for extensions loaded by default: |
|
|
44 | |
|
|
45 | URxvt.perl-ext-common: default,selection-autotransform |
39 | |
46 | |
40 | =over 4 |
47 | =over 4 |
41 | |
48 | |
42 | =item selection (enabled by default) |
49 | =item selection (enabled by default) |
43 | |
50 | |
… | |
… | |
58 | URxvt.selection.pattern-1: perl-regex |
65 | URxvt.selection.pattern-1: perl-regex |
59 | ... |
66 | ... |
60 | |
67 | |
61 | 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 |
62 | 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 |
63 | 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 |
64 | between two vertical bars: |
71 | between two vertical bars: |
65 | |
72 | |
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
73 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
74 | |
|
|
75 | Another example: Programs I use often output "absolute path: " at the |
|
|
76 | beginning of a line when they process multiple files. The following |
|
|
77 | pattern matches the filename (note, there is a single space at the very |
|
|
78 | end): |
|
|
79 | |
|
|
80 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
67 | |
81 | |
68 | You can look at the source of the selection extension to see more |
82 | You can look at the source of the selection extension to see more |
69 | interesting uses, such as parsing a line from beginning to end. |
83 | interesting uses, such as parsing a line from beginning to end. |
70 | |
84 | |
71 | This extension also offers the following bindable keyboard command: |
85 | This extension also offers following bindable keyboard commands: |
72 | |
86 | |
73 | =over 4 |
87 | =over 4 |
74 | |
88 | |
75 | =item rot13 |
89 | =item rot13 |
76 | |
90 | |
… | |
… | |
83 | =item option-popup (enabled by default) |
97 | =item option-popup (enabled by default) |
84 | |
98 | |
85 | 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 |
86 | runtime. |
100 | runtime. |
87 | |
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 | |
88 | =item selection-popup (enabled by default) |
119 | =item selection-popup (enabled by default) |
89 | |
120 | |
90 | 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 |
91 | text into various other formats/action (such as uri unescaping, perl |
122 | text into various other formats/action (such as uri unescaping, perl |
92 | evalution, web-browser starting etc.), depending on content. |
123 | evaluation, web-browser starting etc.), depending on content. |
|
|
124 | |
|
|
125 | Other extensions can extend this popup menu by pushing a code reference |
|
|
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
|
|
127 | popup is being displayed. |
|
|
128 | |
|
|
129 | Its sole argument is the popup menu, which can be modified. The selection |
|
|
130 | is in C<$_>, which can be used to decide whether to add something or not. |
|
|
131 | It should either return nothing or a string and a code reference. The |
|
|
132 | string will be used as button text and the code reference will be called |
|
|
133 | when the button gets activated and should transform C<$_>. |
|
|
134 | |
|
|
135 | The following will add an entry C<a to b> that transforms all C<a>s in |
|
|
136 | the selection to C<b>s, but only if the selection currently contains any |
|
|
137 | C<a>s: |
|
|
138 | |
|
|
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
140 | /a/ ? ("a to b" => sub { s/a/b/g } |
|
|
141 | : () |
|
|
142 | }; |
93 | |
143 | |
94 | =item searchable-scrollback<hotkey> (enabled by default) |
144 | =item searchable-scrollback<hotkey> (enabled by default) |
95 | |
145 | |
96 | Adds regex search functionality to the scrollback buffer, triggered |
146 | Adds regex search functionality to the scrollback buffer, triggered |
97 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
147 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
… | |
… | |
102 | 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> |
103 | 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 |
104 | 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 |
105 | 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 |
106 | 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 |
107 | 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. |
|
|
164 | |
|
|
165 | =item readline (enabled by default) |
|
|
166 | |
|
|
167 | A support package that tries to make editing with readline easier. At |
|
|
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
|
|
169 | move the text cursor to this position. It does so by generating as many |
|
|
170 | cursor-left or cursor-right keypresses as required (this only works |
|
|
171 | for programs that correctly support wide characters). |
|
|
172 | |
|
|
173 | To avoid too many false positives, this is only done when: |
|
|
174 | |
|
|
175 | =over 4 |
|
|
176 | |
|
|
177 | =item - the tty is in ICANON state. |
|
|
178 | |
|
|
179 | =item - the text cursor is visible. |
|
|
180 | |
|
|
181 | =item - the primary screen is currently being displayed. |
|
|
182 | |
|
|
183 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
184 | |
|
|
185 | =back |
|
|
186 | |
|
|
187 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
188 | might interfere with selection creation in harmless ways. |
108 | |
189 | |
109 | =item selection-autotransform |
190 | =item selection-autotransform |
110 | |
191 | |
111 | This selection allows you to do automatic transforms on a selection |
192 | This selection allows you to do automatic transforms on a selection |
112 | whenever a selection is made. |
193 | whenever a selection is made. |
… | |
… | |
117 | URxvt.selection-autotransform.0: transform |
198 | URxvt.selection-autotransform.0: transform |
118 | URxvt.selection-autotransform.1: transform |
199 | URxvt.selection-autotransform.1: transform |
119 | ... |
200 | ... |
120 | |
201 | |
121 | For example, the following will transform selections of the form |
202 | For example, the following will transform selections of the form |
122 | C<word:number> into C<vi +$number $word>: |
203 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
204 | $word>: |
123 | |
205 | |
124 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/ |
206 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
125 | |
207 | |
126 | And this example matches the same,but replaces it with vi-commands you can |
208 | And this example matches the same,but replaces it with vi-commands you can |
127 | paste directory into your (vi :) editor: |
209 | paste directly into your (vi :) editor: |
128 | |
210 | |
129 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\x0d:$2\\x0d/ |
211 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
130 | |
212 | |
131 | =item mark-urls |
213 | Of course, this can be modified to suit your needs and your editor :) |
132 | |
214 | |
|
|
215 | To expand the example above to typical perl error messages ("XXX at |
|
|
216 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
217 | |
|
|
218 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
219 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
220 | |
|
|
221 | The first line tells the selection code to treat the unchanging part of |
|
|
222 | every error message as a selection pattern, and the second line transforms |
|
|
223 | the message into vi commands to load the file. |
|
|
224 | |
|
|
225 | =item tabbed |
|
|
226 | |
|
|
227 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
228 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
|
|
229 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
230 | button per tab. |
|
|
231 | |
|
|
232 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
233 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
234 | while B<Shift-Down> creates a new tab. |
|
|
235 | |
|
|
236 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
237 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
238 | following four resources (shown with defaults): |
|
|
239 | |
|
|
240 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
241 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
242 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
243 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
244 | |
|
|
245 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
246 | indices. |
|
|
247 | |
|
|
248 | =item matcher |
|
|
249 | |
133 | 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 |
134 | make them clickable. When middle-clicked, the program specified in the |
251 | matching a certain pattern and make it clickable. When clicked with the |
135 | 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 |
136 | 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 |
|
|
278 | |
|
|
279 | =item xim-onthespot |
|
|
280 | |
|
|
281 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
282 | not work perfectly, and some input methods don't seem to work well with |
|
|
283 | OnTheSpot editing in general, but it seems to work at least for SCIM and |
|
|
284 | kinput2. |
|
|
285 | |
|
|
286 | You enable it by specifying this extension and a preedit style of |
|
|
287 | C<OnTheSpot>, i.e.: |
|
|
288 | |
|
|
289 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
290 | |
|
|
291 | =item kuake<hotkey> |
|
|
292 | |
|
|
293 | A very primitive quake-console-like extension. It was inspired by a |
|
|
294 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
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. |
|
|
298 | |
|
|
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. |
137 | |
315 | |
138 | =item block-graphics-to-ascii |
316 | =item block-graphics-to-ascii |
139 | |
317 | |
140 | 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 |
141 | 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 |
142 | similar-looking ascii character. |
320 | similar-looking ascii character. |
143 | |
321 | |
144 | =item digital-clock |
322 | =item digital-clock |
145 | |
323 | |
146 | 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. |
147 | |
393 | |
148 | =item example-refresh-hooks |
394 | =item example-refresh-hooks |
149 | |
395 | |
150 | 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 |
151 | window. Illustrates overwriting the refresh callbacks to create your own |
397 | window. Illustrates overwriting the refresh callbacks to create your own |
152 | overlays or changes. |
398 | overlays or changes. |
|
|
399 | |
|
|
400 | =item confirm-paste |
|
|
401 | |
|
|
402 | Displays a confirmation dialog when a paste containing at least a full |
|
|
403 | line is detected. |
|
|
404 | |
|
|
405 | =item bell-command |
|
|
406 | |
|
|
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: |
|
|
410 | |
|
|
411 | URxvt.bell-command: notify-send "Beep, Beep" |
153 | |
412 | |
154 | =back |
413 | =back |
155 | |
414 | |
156 | =head1 API DOCUMENTATION |
415 | =head1 API DOCUMENTATION |
157 | |
416 | |
… | |
… | |
173 | |
432 | |
174 | =over 4 |
433 | =over 4 |
175 | |
434 | |
176 | =item $text |
435 | =item $text |
177 | |
436 | |
178 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
437 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
179 | 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. |
180 | |
439 | |
181 | =item $string |
440 | =item $string |
182 | |
441 | |
183 | 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 |
… | |
… | |
187 | =item $octets |
446 | =item $octets |
188 | |
447 | |
189 | 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 |
190 | locale-specific way. |
449 | locale-specific way. |
191 | |
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 | |
192 | =back |
457 | =back |
193 | |
458 | |
194 | =head2 Extension Objects |
459 | =head2 Extension Objects |
195 | |
460 | |
196 | 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 |
197 | 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, |
198 | 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 |
199 | 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 |
200 | begin with an underscore character C<_>: these are reserved for internal |
466 | that begin with an underscore character C<_>: these are reserved for |
201 | use. |
467 | internal use. |
202 | |
468 | |
203 | 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 |
204 | C<urxvt::term> class on this object. |
470 | C<urxvt::term> class on this object. |
205 | |
471 | |
206 | It has the following methods and data members: |
472 | It has the following methods and data members: |
… | |
… | |
227 | =head2 Hooks |
493 | =head2 Hooks |
228 | |
494 | |
229 | 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 |
230 | called whenever the relevant event happens. |
496 | called whenever the relevant event happens. |
231 | |
497 | |
232 | 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 |
233 | the in the C<Extension Objects> section. |
499 | the in the C<Extension Objects> section. |
234 | |
500 | |
235 | B<All> of these hooks must return a boolean value. If it is true, then the |
501 | B<All> of these hooks must return a boolean value. If any of the called |
236 | event counts as being I<consumed>, and the invocation of other hooks is |
502 | hooks returns true, then the event counts as being I<consumed>, and the |
237 | skipped, and the relevant action might not be carried out by the C++ code. |
503 | relevant action might not be carried out by the C++ code. |
238 | |
504 | |
239 | I<< When in doubt, return a false value (preferably C<()>). >> |
505 | I<< When in doubt, return a false value (preferably C<()>). >> |
240 | |
506 | |
241 | =over 4 |
507 | =over 4 |
242 | |
508 | |
243 | =item on_init $term |
509 | =item on_init $term |
244 | |
510 | |
245 | Called after a new terminal object has been initialized, but before |
511 | Called after a new terminal object has been initialized, but before |
246 | windows are created or the command gets run. Most methods are unsafe to |
512 | windows are created or the command gets run. Most methods are unsafe to |
247 | call or deliver senseless data, as terminal size and other characteristics |
513 | call or deliver senseless data, as terminal size and other characteristics |
248 | have not yet been determined. You can safely query and change resources, |
514 | have not yet been determined. You can safely query and change resources |
249 | though. |
515 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
516 | place. |
|
|
517 | |
|
|
518 | =item on_start $term |
|
|
519 | |
|
|
520 | Called at the very end of initialisation of a new terminal, just before |
|
|
521 | trying to map (display) the toplevel and returning to the main loop. |
|
|
522 | |
|
|
523 | =item on_destroy $term |
|
|
524 | |
|
|
525 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
526 | still fully functional (not for long, though). |
250 | |
527 | |
251 | =item on_reset $term |
528 | =item on_reset $term |
252 | |
529 | |
253 | Called after the screen is "reset" for any reason, such as resizing or |
530 | Called after the screen is "reset" for any reason, such as resizing or |
254 | control sequences. Here is where you can react on changes to size-related |
531 | control sequences. Here is where you can react on changes to size-related |
255 | variables. |
532 | variables. |
256 | |
533 | |
257 | =item on_start $term |
534 | =item on_child_start $term, $pid |
258 | |
535 | |
259 | Called at the very end of initialisation of a new terminal, just before |
536 | Called just after the child process has been C<fork>ed. |
260 | returning to the mainloop. |
537 | |
|
|
538 | =item on_child_exit $term, $status |
|
|
539 | |
|
|
540 | Called just after the child process has exited. C<$status> is the status |
|
|
541 | from C<waitpid>. |
261 | |
542 | |
262 | =item on_sel_make $term, $eventtime |
543 | =item on_sel_make $term, $eventtime |
263 | |
544 | |
264 | Called whenever a selection has been made by the user, but before the |
545 | Called whenever a selection has been made by the user, but before the |
265 | selection text is copied, so changes to the beginning, end or type of the |
546 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
272 | |
553 | |
273 | 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 |
274 | 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 |
275 | by calling C<< $term->selection >>. |
556 | by calling C<< $term->selection >>. |
276 | |
557 | |
277 | 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. |
278 | |
559 | |
279 | =item on_sel_extend $term |
560 | =item on_sel_extend $term |
280 | |
561 | |
281 | 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 |
282 | click) and is either supposed to return false (normal operation), or |
563 | click) and is either supposed to return false (normal operation), or |
283 | 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 |
284 | processing. This can happen multiple times, as long as the callback |
565 | processing. This can happen multiple times, as long as the callback |
285 | 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 |
286 | supposed to enlarge the selection more and more, if possible. |
567 | supposed to enlarge the selection more and more, if possible. |
287 | |
568 | |
288 | See the F<selection> example extension. |
569 | See the F<selection> example extension. |
289 | |
570 | |
290 | =item on_view_change $term, $offset |
571 | =item on_view_change $term, $offset |
291 | |
572 | |
292 | 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 |
293 | scrolls. Offset C<0> means display the normal terminal, positive values |
574 | scrolls. Offset C<0> means display the normal terminal, positive values |
294 | show this many lines of scrollback. |
575 | show this many lines of scrollback. |
295 | |
576 | |
296 | =item on_scroll_back $term, $lines, $saved |
577 | =item on_scroll_back $term, $lines, $saved |
297 | |
578 | |
… | |
… | |
301 | |
582 | |
302 | 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, |
303 | $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 |
304 | number of lines that will be in the scrollback buffer. |
585 | number of lines that will be in the scrollback buffer. |
305 | |
586 | |
306 | =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 |
307 | |
598 | |
308 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
599 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
309 | operating system command) is processed. Cursor position and other state |
600 | operating system command) is processed. Cursor position and other state |
310 | information is up-to-date when this happens. For interoperability, the |
601 | information is up-to-date when this happens. For interoperability, the |
311 | 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, |
312 | 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 |
313 | 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 | } |
314 | |
615 | |
315 | 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, |
316 | 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 |
317 | 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. |
318 | |
622 | |
319 | =item on_add_lines $term, $string |
623 | =item on_add_lines $term, $string |
320 | |
624 | |
321 | 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 |
322 | 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 |
… | |
… | |
327 | =item on_tt_write $term, $octets |
631 | =item on_tt_write $term, $octets |
328 | |
632 | |
329 | 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 |
330 | suppress or filter tty input. |
634 | suppress or filter tty input. |
331 | |
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 | |
332 | =item on_line_update $term, $row |
643 | =item on_line_update $term, $row |
333 | |
644 | |
334 | 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 |
335 | 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 |
336 | 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, |
… | |
… | |
343 | 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 |
344 | you cannot just toggle rendition bits, but only set them. |
655 | you cannot just toggle rendition bits, but only set them. |
345 | |
656 | |
346 | =item on_refresh_begin $term |
657 | =item on_refresh_begin $term |
347 | |
658 | |
348 | 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 |
349 | or similar effects by modify terminal contents in refresh_begin, and |
660 | similar effects by modifying the terminal contents in refresh_begin, and |
350 | 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 |
351 | code is run after this hook, and takes precedence. |
662 | code is run after this hook, and takes precedence. |
352 | |
663 | |
353 | =item on_refresh_end $term |
664 | =item on_refresh_end $term |
354 | |
665 | |
355 | 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>. |
356 | |
667 | |
357 | =item on_keyboard_command $term, $string |
668 | =item on_user_command $term, $string |
358 | |
669 | |
359 | Called whenever the user presses a key combination that has a |
670 | Called whenever a user-configured event is being activated (e.g. via |
360 | 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> |
361 | 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. |
|
|
689 | |
|
|
690 | =item on_x_event $term, $event |
|
|
691 | |
|
|
692 | Called on every X event received on the vt window (and possibly other |
|
|
693 | windows). Should only be used as a last resort. Most event structure |
|
|
694 | members are not passed. |
|
|
695 | |
|
|
696 | =item on_root_event $term, $event |
|
|
697 | |
|
|
698 | Like C<on_x_event>, but is called for events on the root window. |
362 | |
699 | |
363 | =item on_focus_in $term |
700 | =item on_focus_in $term |
364 | |
701 | |
365 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
702 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
366 | does focus in processing. |
703 | does focus in processing. |
367 | |
704 | |
368 | =item on_focus_out $term |
705 | =item on_focus_out $term |
369 | |
706 | |
370 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
707 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
371 | focus out processing. |
708 | focus out processing. |
372 | |
709 | |
|
|
710 | =item on_configure_notify $term, $event |
|
|
711 | |
|
|
712 | =item on_property_notify $term, $event |
|
|
713 | |
373 | =item on_key_press $term, $event, $keysym, $octets |
714 | =item on_key_press $term, $event, $keysym, $octets |
374 | |
715 | |
375 | =item on_key_release $term, $event, $keysym |
716 | =item on_key_release $term, $event, $keysym |
376 | |
717 | |
377 | =item on_button_press $term, $event |
718 | =item on_button_press $term, $event |
… | |
… | |
382 | |
723 | |
383 | =item on_map_notify $term, $event |
724 | =item on_map_notify $term, $event |
384 | |
725 | |
385 | =item on_unmap_notify $term, $event |
726 | =item on_unmap_notify $term, $event |
386 | |
727 | |
387 | 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 |
388 | 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. |
389 | |
730 | |
390 | 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 |
391 | manpage), with the additional members C<row> and C<col>, which are the row |
732 | manpage), with the additional members C<row> and C<col>, which are the |
392 | and column under the mouse cursor. |
733 | (real, not screen-based) row and column under the mouse cursor. |
393 | |
734 | |
394 | C<on_key_press> additionally receives the string rxvt-unicode would |
735 | C<on_key_press> additionally receives the string rxvt-unicode would |
395 | output, if any, in locale-specific encoding. |
736 | output, if any, in locale-specific encoding. |
396 | |
737 | |
397 | subwindow. |
738 | subwindow. |
|
|
739 | |
|
|
740 | =item on_client_message $term, $event |
|
|
741 | |
|
|
742 | =item on_wm_protocols $term, $event |
|
|
743 | |
|
|
744 | =item on_wm_delete_window $term, $event |
|
|
745 | |
|
|
746 | Called when various types of ClientMessage events are received (all with |
|
|
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. |
398 | |
752 | |
399 | =back |
753 | =back |
400 | |
754 | |
401 | =cut |
755 | =cut |
402 | |
756 | |
… | |
… | |
408 | use Scalar::Util (); |
762 | use Scalar::Util (); |
409 | use List::Util (); |
763 | use List::Util (); |
410 | |
764 | |
411 | our $VERSION = 1; |
765 | our $VERSION = 1; |
412 | our $TERM; |
766 | our $TERM; |
|
|
767 | our @TERM_INIT; |
|
|
768 | our @TERM_EXT; |
413 | our @HOOKNAME; |
769 | our @HOOKNAME; |
414 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
770 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
415 | our %OPTION; |
771 | our %OPTION; |
416 | |
772 | |
417 | our $LIBDIR; |
773 | our $LIBDIR; |
418 | our $RESNAME; |
774 | our $RESNAME; |
419 | our $RESCLASS; |
775 | our $RESCLASS; |
420 | our $RXVTNAME; |
776 | our $RXVTNAME; |
421 | |
777 | |
|
|
778 | our $NOCHAR = chr 0xffff; |
|
|
779 | |
422 | =head2 Variables in the C<urxvt> Package |
780 | =head2 Variables in the C<urxvt> Package |
423 | |
781 | |
424 | =over 4 |
782 | =over 4 |
425 | |
783 | |
426 | =item $urxvt::LIBDIR |
784 | =item $urxvt::LIBDIR |
… | |
… | |
439 | =item $urxvt::TERM |
797 | =item $urxvt::TERM |
440 | |
798 | |
441 | The current terminal. This variable stores the current C<urxvt::term> |
799 | The current terminal. This variable stores the current C<urxvt::term> |
442 | object, whenever a callback/hook is executing. |
800 | object, whenever a callback/hook is executing. |
443 | |
801 | |
|
|
802 | =item @urxvt::TERM_INIT |
|
|
803 | |
|
|
804 | All code references in this array will be called as methods of the next newly |
|
|
805 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
806 | gets cleared before the code references that were in it are being executed, |
|
|
807 | so references can push themselves onto it again if they so desire. |
|
|
808 | |
|
|
809 | This complements to the perl-eval command line option, but gets executed |
|
|
810 | first. |
|
|
811 | |
|
|
812 | =item @urxvt::TERM_EXT |
|
|
813 | |
|
|
814 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
815 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
816 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
|
|
817 | |
444 | =back |
818 | =back |
445 | |
819 | |
446 | =head2 Functions in the C<urxvt> Package |
820 | =head2 Functions in the C<urxvt> Package |
447 | |
821 | |
448 | =over 4 |
822 | =over 4 |
449 | |
823 | |
450 | =item urxvt::fatal $errormessage |
824 | =item urxvt::fatal $errormessage |
451 | |
825 | |
452 | Fatally aborts execution with the given error message. Avoid at all |
826 | Fatally aborts execution with the given error message (which should |
453 | 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 |
454 | starts up. |
828 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
829 | terminal from starting up. |
455 | |
830 | |
456 | =item urxvt::warn $string |
831 | =item urxvt::warn $string |
457 | |
832 | |
458 | 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 |
459 | 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 |
460 | that calls this function. |
835 | that calls this function. |
461 | |
836 | |
462 | 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 |
463 | correct place, e.g. on stderr of the connecting urxvtc client. |
838 | correct place, e.g. on stderr of the connecting urxvtc client. |
464 | |
839 | |
465 | Messages have a size limit of 1023 bytes currently. |
840 | Messages have a size limit of 1023 bytes currently. |
466 | |
841 | |
467 | =item $is_safe = urxvt::safe |
842 | =item @terms = urxvt::termlist |
468 | |
843 | |
469 | Returns true when it is safe to do potentially unsafe things, such as |
844 | Returns all urxvt::term objects that exist in this process, regardless of |
470 | evaluating perl code specified by the user. This is true when urxvt was |
845 | whether they are started, being destroyed etc., so be careful. Only term |
471 | started setuid or setgid. |
846 | objects that have perl extensions attached will be returned (because there |
|
|
847 | is no urxvt::term object associated with others). |
472 | |
848 | |
473 | =item $time = urxvt::NOW |
849 | =item $time = urxvt::NOW |
474 | |
850 | |
475 | Returns the "current time" (as per the event loop). |
851 | Returns the "current time" (as per the event loop). |
476 | |
852 | |
477 | =item urxvt::CurrentTime |
853 | =item urxvt::CurrentTime |
478 | |
854 | |
479 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
855 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
480 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
856 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
481 | Button4Mask, Button5Mask, AnyModifier |
857 | Button4Mask, Button5Mask, AnyModifier |
|
|
858 | |
|
|
859 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
860 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
861 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
862 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
863 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
864 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
865 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
866 | |
|
|
867 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
868 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
869 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
870 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
871 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
872 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
873 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
482 | |
874 | |
483 | Various constants for use in X calls and event processing. |
875 | Various constants for use in X calls and event processing. |
484 | |
876 | |
485 | =back |
877 | =back |
486 | |
878 | |
… | |
… | |
503 | |
895 | |
504 | =item $rend = urxvt::OVERLAY_RSTYLE |
896 | =item $rend = urxvt::OVERLAY_RSTYLE |
505 | |
897 | |
506 | Return the rendition mask used for overlays by default. |
898 | Return the rendition mask used for overlays by default. |
507 | |
899 | |
508 | =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 |
509 | |
902 | |
510 | Return the bit that enabled bold, italic, blink, reverse-video and |
903 | Return the bit that enabled bold, italic, blink, reverse-video and |
511 | 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 |
512 | the bitset. |
905 | the bitset. |
513 | |
906 | |
… | |
… | |
519 | |
912 | |
520 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
913 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
521 | |
914 | |
522 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
915 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
523 | |
916 | |
|
|
917 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
|
|
918 | |
524 | Replace the foreground/background colour in the rendition mask with the |
919 | Replace the foreground/background colour in the rendition mask with the |
525 | specified one. |
920 | specified one. |
526 | |
921 | |
527 | =item $value = urxvt::GET_CUSTOM $rend |
922 | =item $value = urxvt::GET_CUSTOM $rend |
528 | |
923 | |
… | |
… | |
537 | =back |
932 | =back |
538 | |
933 | |
539 | =cut |
934 | =cut |
540 | |
935 | |
541 | BEGIN { |
936 | BEGIN { |
542 | urxvt->bootstrap; |
|
|
543 | |
|
|
544 | # overwrite perl's warn |
937 | # overwrite perl's warn |
545 | *CORE::GLOBAL::warn = sub { |
938 | *CORE::GLOBAL::warn = sub { |
546 | my $msg = join "", @_; |
939 | my $msg = join "", @_; |
547 | $msg .= "\n" |
940 | $msg .= "\n" |
548 | unless $msg =~ /\n$/; |
941 | unless $msg =~ /\n$/; |
549 | urxvt::warn ($msg); |
942 | urxvt::warn ($msg); |
550 | }; |
943 | }; |
551 | |
|
|
552 | # %ENV is the original startup environment |
|
|
553 | delete $ENV{IFS}; |
|
|
554 | delete $ENV{CDPATH}; |
|
|
555 | delete $ENV{BASH_ENV}; |
|
|
556 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
557 | } |
944 | } |
558 | |
945 | |
559 | my @hook_count; |
946 | no warnings 'utf8'; |
|
|
947 | |
560 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
948 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
561 | |
949 | |
562 | sub verbose { |
950 | sub verbose { |
563 | my ($level, $msg) = @_; |
951 | my ($level, $msg) = @_; |
564 | warn "$msg\n" if $level <= $verbosity; |
952 | warn "$msg\n" if $level <= $verbosity; |
565 | } |
953 | } |
566 | |
954 | |
567 | my $extension_pkg = "extension0000"; |
|
|
568 | my %extension_pkg; |
955 | my %extension_pkg; |
569 | |
956 | |
570 | # load a single script into its own package, once only |
957 | # load a single script into its own package, once only |
571 | sub extension_package($) { |
958 | sub extension_package($) { |
572 | my ($path) = @_; |
959 | my ($path) = @_; |
573 | |
960 | |
574 | $extension_pkg{$path} ||= do { |
961 | $extension_pkg{$path} ||= do { |
575 | my $pkg = "urxvt::" . ($extension_pkg++); |
962 | $path =~ /([^\/\\]+)$/; |
|
|
963 | my $pkg = $1; |
|
|
964 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
965 | $pkg = "urxvt::ext::$pkg"; |
576 | |
966 | |
577 | verbose 3, "loading extension '$path' into package '$pkg'"; |
967 | verbose 3, "loading extension '$path' into package '$pkg'"; |
578 | |
968 | |
579 | open my $fh, "<:raw", $path |
969 | open my $fh, "<:raw", $path |
580 | or die "$path: $!"; |
970 | or die "$path: $!"; |
581 | |
971 | |
582 | my $source = untaint |
972 | my $source = |
583 | "package $pkg; use strict; use utf8;\n" |
973 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
584 | . "use base urxvt::term::extension::;\n" |
|
|
585 | . "#line 1 \"$path\"\n{\n" |
974 | . "#line 1 \"$path\"\n{\n" |
586 | . (do { local $/; <$fh> }) |
975 | . (do { local $/; <$fh> }) |
587 | . "\n};\n1"; |
976 | . "\n};\n1"; |
588 | |
977 | |
589 | eval $source |
978 | eval $source |
… | |
… | |
599 | sub invoke { |
988 | sub invoke { |
600 | local $TERM = shift; |
989 | local $TERM = shift; |
601 | my $htype = shift; |
990 | my $htype = shift; |
602 | |
991 | |
603 | if ($htype == 0) { # INIT |
992 | if ($htype == 0) { # INIT |
604 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
993 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl"); |
605 | |
994 | |
606 | my %ext_arg; |
995 | my %ext_arg; |
607 | |
996 | |
|
|
997 | { |
|
|
998 | my @init = @TERM_INIT; |
|
|
999 | @TERM_INIT = (); |
|
|
1000 | $_->($TERM) for @init; |
|
|
1001 | my @pkg = @TERM_EXT; |
|
|
1002 | @TERM_EXT = (); |
|
|
1003 | $TERM->register_package ($_) for @pkg; |
|
|
1004 | } |
|
|
1005 | |
608 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
1006 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
609 | if ($_ eq "default") { |
1007 | if ($_ eq "default") { |
610 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
1008 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
611 | } elsif (/^-(.*)$/) { |
1009 | } elsif (/^-(.*)$/) { |
612 | delete $ext_arg{$1}; |
1010 | delete $ext_arg{$1}; |
613 | } elsif (/^([^<]+)<(.*)>$/) { |
1011 | } elsif (/^([^<]+)<(.*)>$/) { |
614 | push @{ $ext_arg{$1} }, $2; |
1012 | push @{ $ext_arg{$1} }, $2; |
615 | } else { |
1013 | } else { |
616 | $ext_arg{$_} ||= []; |
1014 | $ext_arg{$_} ||= []; |
617 | } |
1015 | } |
618 | } |
1016 | } |
619 | |
1017 | |
620 | while (my ($ext, $argv) = each %ext_arg) { |
1018 | for my $ext (sort keys %ext_arg) { |
621 | my @files = grep -f $_, map "$_/$ext", @dirs; |
1019 | my @files = grep -f $_, map "$_/$ext", @dirs; |
622 | |
1020 | |
623 | if (@files) { |
1021 | if (@files) { |
624 | $TERM->register_package (extension_package $files[0], $argv); |
1022 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
625 | } else { |
1023 | } else { |
626 | warn "perl extension '$ext' not found in perl library search path\n"; |
1024 | warn "perl extension '$ext' not found in perl library search path\n"; |
627 | } |
1025 | } |
628 | } |
1026 | } |
629 | |
1027 | |
… | |
… | |
635 | |
1033 | |
636 | if (my $cb = $TERM->{_hook}[$htype]) { |
1034 | if (my $cb = $TERM->{_hook}[$htype]) { |
637 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
1035 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
638 | if $verbosity >= 10; |
1036 | if $verbosity >= 10; |
639 | |
1037 | |
640 | keys %$cb; |
1038 | for my $pkg (keys %$cb) { |
641 | |
|
|
642 | while (my ($pkg, $cb) = each %$cb) { |
|
|
643 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
1039 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
644 | and last; |
1040 | $retval ||= $retval_; |
645 | |
1041 | |
646 | if ($@) { |
1042 | if ($@) { |
647 | $TERM->ungrab; # better to lose the grab than the session |
1043 | $TERM->ungrab; # better to lose the grab than the session |
648 | warn $@; |
1044 | warn $@; |
649 | } |
1045 | } |
… | |
… | |
652 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
1048 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
653 | if $verbosity >= 11; |
1049 | if $verbosity >= 11; |
654 | } |
1050 | } |
655 | |
1051 | |
656 | if ($htype == 1) { # DESTROY |
1052 | if ($htype == 1) { # DESTROY |
657 | if (my $hook = delete $TERM->{_hook}) { |
|
|
658 | for my $htype (0..$#$hook) { |
|
|
659 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
660 | or set_should_invoke $htype, 0; |
|
|
661 | } |
|
|
662 | } |
|
|
663 | |
|
|
664 | # clear package objects |
1053 | # clear package objects |
665 | %$_ = () for values %{ $TERM->{_pkg} }; |
1054 | %$_ = () for values %{ $TERM->{_pkg} }; |
666 | |
1055 | |
667 | # clear package |
1056 | # clear package |
668 | %$TERM = (); |
1057 | %$TERM = (); |
669 | } |
1058 | } |
670 | |
1059 | |
671 | $retval |
1060 | $retval |
672 | } |
1061 | } |
673 | |
1062 | |
674 | sub exec_async(@) { |
1063 | sub SET_COLOR($$$) { |
675 | my $pid = fork; |
1064 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
1065 | } |
676 | |
1066 | |
677 | return |
1067 | sub rend2mask { |
678 | if !defined $pid or $pid; |
1068 | no strict 'refs'; |
679 | |
1069 | my ($str, $mask) = (@_, 0); |
680 | %ENV = %{ $TERM->env }; |
1070 | my %color = ( fg => undef, bg => undef ); |
681 | |
1071 | my @failed; |
682 | exec @_; |
1072 | for my $spec ( split /\s+/, $str ) { |
683 | _exit 255; |
1073 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1074 | $color{lc($1)} = $2; |
|
|
1075 | } else { |
|
|
1076 | my $neg = $spec =~ s/^[-^]//; |
|
|
1077 | unless ( exists &{"RS_$spec"} ) { |
|
|
1078 | push @failed, $spec; |
|
|
1079 | next; |
|
|
1080 | } |
|
|
1081 | my $cur = &{"RS_$spec"}; |
|
|
1082 | if ( $neg ) { |
|
|
1083 | $mask &= ~$cur; |
|
|
1084 | } else { |
|
|
1085 | $mask |= $cur; |
|
|
1086 | } |
|
|
1087 | } |
|
|
1088 | } |
|
|
1089 | ($mask, @color{qw(fg bg)}, \@failed) |
684 | } |
1090 | } |
685 | |
1091 | |
686 | # urxvt::term::extension |
1092 | # urxvt::term::extension |
687 | |
1093 | |
688 | package urxvt::term::extension; |
1094 | package urxvt::term::extension; |
… | |
… | |
694 | while (my ($name, $cb) = each %hook) { |
1100 | while (my ($name, $cb) = each %hook) { |
695 | my $htype = $HOOKTYPE{uc $name}; |
1101 | my $htype = $HOOKTYPE{uc $name}; |
696 | defined $htype |
1102 | defined $htype |
697 | or Carp::croak "unsupported hook type '$name'"; |
1103 | or Carp::croak "unsupported hook type '$name'"; |
698 | |
1104 | |
|
|
1105 | $self->set_should_invoke ($htype, +1) |
699 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
1106 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
700 | $hook_count[$htype]++ |
|
|
701 | or urxvt::set_should_invoke $htype, 1; |
|
|
702 | } |
|
|
703 | |
1107 | |
704 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
1108 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
705 | } |
1109 | } |
706 | } |
1110 | } |
707 | |
1111 | |
… | |
… | |
712 | for my $name (@hook) { |
1116 | for my $name (@hook) { |
713 | my $htype = $HOOKTYPE{uc $name}; |
1117 | my $htype = $HOOKTYPE{uc $name}; |
714 | defined $htype |
1118 | defined $htype |
715 | or Carp::croak "unsupported hook type '$name'"; |
1119 | or Carp::croak "unsupported hook type '$name'"; |
716 | |
1120 | |
|
|
1121 | $self->set_should_invoke ($htype, -1) |
717 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
1122 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
718 | --$hook_count[$htype] |
|
|
719 | or urxvt::set_should_invoke $htype, 0; |
|
|
720 | } |
|
|
721 | } |
1123 | } |
722 | } |
1124 | } |
723 | |
1125 | |
724 | our $AUTOLOAD; |
1126 | our $AUTOLOAD; |
725 | |
1127 | |
… | |
… | |
763 | is that you cannot use blocking APIs, but the non-blocking variant should |
1165 | is that you cannot use blocking APIs, but the non-blocking variant should |
764 | work. |
1166 | work. |
765 | |
1167 | |
766 | =cut |
1168 | =cut |
767 | |
1169 | |
768 | our $VERSION = 1; |
1170 | our $VERSION = '5.23'; |
769 | |
1171 | |
770 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1172 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
771 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1173 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
772 | |
1174 | |
773 | sub timer { |
1175 | sub timer { |
… | |
… | |
775 | |
1177 | |
776 | my $cb = $arg{cb}; |
1178 | my $cb = $arg{cb}; |
777 | |
1179 | |
778 | urxvt::timer |
1180 | urxvt::timer |
779 | ->new |
1181 | ->new |
780 | ->start (urxvt::NOW + $arg{after}) |
1182 | ->after ($arg{after}, $arg{interval}) |
781 | ->cb (sub { |
1183 | ->cb ($arg{interval} ? $cb : sub { |
782 | $_[0]->stop; # need to cancel manually |
1184 | $_[0]->stop; # need to cancel manually |
783 | $cb->(); |
1185 | $cb->(); |
784 | }) |
1186 | }) |
785 | } |
1187 | } |
786 | |
1188 | |
787 | sub io { |
1189 | sub io { |
788 | my ($class, %arg) = @_; |
1190 | my ($class, %arg) = @_; |
789 | |
1191 | |
790 | my $cb = $arg{cb}; |
1192 | my $cb = $arg{cb}; |
|
|
1193 | my $fd = fileno $arg{fh}; |
|
|
1194 | defined $fd or $fd = $arg{fh}; |
791 | |
1195 | |
792 | bless [$arg{fh}, urxvt::iow |
1196 | bless [$arg{fh}, urxvt::iow |
793 | ->new |
1197 | ->new |
794 | ->fd (fileno $arg{fh}) |
1198 | ->fd ($fd) |
795 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1199 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
796 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1200 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
797 | ->start |
1201 | ->start |
798 | ->cb (sub { |
1202 | ->cb ($cb) |
799 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
800 | . ($_[1] & 2 ? 'w' : '')); |
|
|
801 | })], |
|
|
802 | urxvt::anyevent:: |
1203 | ], urxvt::anyevent:: |
|
|
1204 | } |
|
|
1205 | |
|
|
1206 | sub idle { |
|
|
1207 | my ($class, %arg) = @_; |
|
|
1208 | |
|
|
1209 | my $cb = $arg{cb}; |
|
|
1210 | |
|
|
1211 | urxvt::iw |
|
|
1212 | ->new |
|
|
1213 | ->start |
|
|
1214 | ->cb ($cb) |
|
|
1215 | } |
|
|
1216 | |
|
|
1217 | sub child { |
|
|
1218 | my ($class, %arg) = @_; |
|
|
1219 | |
|
|
1220 | my $cb = $arg{cb}; |
|
|
1221 | |
|
|
1222 | urxvt::pw |
|
|
1223 | ->new |
|
|
1224 | ->start ($arg{pid}) |
|
|
1225 | ->cb (sub { |
|
|
1226 | $_[0]->stop; # need to cancel manually |
|
|
1227 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1228 | }) |
803 | } |
1229 | } |
804 | |
1230 | |
805 | sub DESTROY { |
1231 | sub DESTROY { |
806 | $_[0][1]->stop; |
1232 | $_[0][1]->stop; |
807 | } |
1233 | } |
808 | |
1234 | |
809 | sub condvar { |
1235 | # only needed for AnyEvent < 6 compatibility |
810 | bless \my $flag, urxvt::anyevent::condvar:: |
1236 | sub one_event { |
811 | } |
|
|
812 | |
|
|
813 | sub urxvt::anyevent::condvar::broadcast { |
|
|
814 | ${$_[0]}++; |
|
|
815 | } |
|
|
816 | |
|
|
817 | sub urxvt::anyevent::condvar::wait { |
|
|
818 | unless (${$_[0]}) { |
|
|
819 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1237 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
820 | } |
|
|
821 | } |
1238 | } |
822 | |
1239 | |
823 | package urxvt::term; |
1240 | package urxvt::term; |
824 | |
1241 | |
825 | =head2 The C<urxvt::term> Class |
1242 | =head2 The C<urxvt::term> Class |
… | |
… | |
830 | |
1247 | |
831 | # find on_xxx subs in the package and register them |
1248 | # find on_xxx subs in the package and register them |
832 | # as hooks |
1249 | # as hooks |
833 | sub register_package { |
1250 | sub register_package { |
834 | my ($self, $pkg, $argv) = @_; |
1251 | my ($self, $pkg, $argv) = @_; |
|
|
1252 | |
|
|
1253 | no strict 'refs'; |
|
|
1254 | |
|
|
1255 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
1256 | |
|
|
1257 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
835 | |
1258 | |
836 | my $proxy = bless { |
1259 | my $proxy = bless { |
837 | _pkg => $pkg, |
1260 | _pkg => $pkg, |
838 | argv => $argv, |
1261 | argv => $argv, |
839 | }, $pkg; |
1262 | }, $pkg; |
… | |
… | |
855 | hash which defines the environment of the new terminal. |
1278 | hash which defines the environment of the new terminal. |
856 | |
1279 | |
857 | Croaks (and probably outputs an error message) if the new instance |
1280 | Croaks (and probably outputs an error message) if the new instance |
858 | couldn't be created. Returns C<undef> if the new instance didn't |
1281 | couldn't be created. Returns C<undef> if the new instance didn't |
859 | initialise perl, and the terminal object otherwise. The C<init> and |
1282 | initialise perl, and the terminal object otherwise. The C<init> and |
860 | C<start> hooks will be called during this call. |
1283 | C<start> hooks will be called before this call returns, and are free to |
|
|
1284 | refer to global data (which is race free). |
861 | |
1285 | |
862 | =cut |
1286 | =cut |
863 | |
1287 | |
864 | sub new { |
1288 | sub new { |
865 | my ($class, $env, @args) = @_; |
1289 | my ($class, $env, @args) = @_; |
866 | |
1290 | |
|
|
1291 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1292 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1293 | |
867 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1294 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
868 | } |
1295 | } |
869 | |
1296 | |
870 | =item $term->destroy |
1297 | =item $term->destroy |
871 | |
1298 | |
872 | Destroy the terminal object (close the window, free resources |
1299 | Destroy the terminal object (close the window, free resources |
873 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1300 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
874 | watchers (timers, io watchers) are still active. |
1301 | watchers (timers, io watchers) are still active. |
875 | |
1302 | |
|
|
1303 | =item $term->exec_async ($cmd[, @args]) |
|
|
1304 | |
|
|
1305 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
1306 | ("starts") programs in the background. This function takes care of setting |
|
|
1307 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
1308 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
1309 | |
|
|
1310 | Returns the pid of the subprocess or C<undef> on error. |
|
|
1311 | |
|
|
1312 | =cut |
|
|
1313 | |
|
|
1314 | sub exec_async { |
|
|
1315 | my $self = shift; |
|
|
1316 | |
|
|
1317 | my $pid = fork; |
|
|
1318 | |
|
|
1319 | return $pid |
|
|
1320 | if !defined $pid or $pid; |
|
|
1321 | |
|
|
1322 | %ENV = %{ $self->env }; |
|
|
1323 | |
|
|
1324 | exec @_; |
|
|
1325 | urxvt::_exit 255; |
|
|
1326 | } |
|
|
1327 | |
876 | =item $isset = $term->option ($optval[, $set]) |
1328 | =item $isset = $term->option ($optval[, $set]) |
877 | |
1329 | |
878 | Returns true if the option specified by C<$optval> is enabled, and |
1330 | Returns true if the option specified by C<$optval> is enabled, and |
879 | optionally change it. All option values are stored by name in the hash |
1331 | optionally change it. All option values are stored by name in the hash |
880 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1332 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
881 | |
1333 | |
882 | Here is a a likely non-exhaustive list of option names, please see the |
1334 | Here is a likely non-exhaustive list of option names, please see the |
883 | source file F</src/optinc.h> to see the actual list: |
1335 | source file F</src/optinc.h> to see the actual list: |
884 | |
1336 | |
885 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1337 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
886 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1338 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
|
|
1339 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
887 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1340 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
888 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1341 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
889 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1342 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
890 | tripleclickwords utmpInhibit visualBell |
1343 | urgentOnBell utmpInhibit visualBell |
891 | |
1344 | |
892 | =item $value = $term->resource ($name[, $newval]) |
1345 | =item $value = $term->resource ($name[, $newval]) |
893 | |
1346 | |
894 | Returns the current resource value associated with a given name and |
1347 | Returns the current resource value associated with a given name and |
895 | optionally sets a new value. Setting values is most useful in the C<init> |
1348 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
904 | likely change). |
1357 | likely change). |
905 | |
1358 | |
906 | Please note that resource strings will currently only be freed when the |
1359 | Please note that resource strings will currently only be freed when the |
907 | terminal is destroyed, so changing options frequently will eat memory. |
1360 | terminal is destroyed, so changing options frequently will eat memory. |
908 | |
1361 | |
909 | Here is a a likely non-exhaustive list of resource names, not all of which |
1362 | Here is a likely non-exhaustive list of resource names, not all of which |
910 | are supported in every build, please see the source file F</src/rsinc.h> |
1363 | are supported in every build, please see the source file F</src/rsinc.h> |
911 | to see the actual list: |
1364 | to see the actual list: |
912 | |
1365 | |
913 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1366 | answerbackstring backgroundPixmap backspace_key blendtype blurradius |
914 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1367 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
915 | display_name embed ext_bwidth fade font geometry hold iconName |
1368 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
916 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1369 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
|
|
1370 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
917 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1371 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
918 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1372 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
919 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1373 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
920 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1374 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
921 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1375 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
922 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1376 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
923 | shade term_name title transparent transparent_all tripleclickwords |
1377 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
|
|
1378 | term_name title transient_for transparent tripleclickwords urgentOnBell |
924 | utmpInhibit visualBell |
1379 | utmpInhibit visualBell |
925 | |
1380 | |
926 | =cut |
1381 | =cut |
927 | |
1382 | |
928 | sub resource($$;$) { |
1383 | sub resource($$;$) { |
929 | my ($self, $name) = (shift, shift); |
1384 | my ($self, $name) = (shift, shift); |
930 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1385 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
931 | &urxvt::term::_resource |
1386 | goto &urxvt::term::_resource |
932 | } |
1387 | } |
933 | |
1388 | |
934 | =item $value = $term->x_resource ($pattern) |
1389 | =item $value = $term->x_resource ($pattern) |
935 | |
1390 | |
936 | Returns the X-Resource for the given pattern, excluding the program or |
1391 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
940 | |
1395 | |
941 | This method should only be called during the C<on_start> hook, as there is |
1396 | This method should only be called during the C<on_start> hook, as there is |
942 | only one resource database per display, and later invocations might return |
1397 | only one resource database per display, and later invocations might return |
943 | the wrong resources. |
1398 | the wrong resources. |
944 | |
1399 | |
945 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
1400 | =item $success = $term->parse_keysym ($key, $octets) |
946 | |
1401 | |
947 | Adds a keymap translation exactly as specified via a resource. See the |
1402 | Adds a key binding exactly as specified via a resource. See the |
948 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1403 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
|
|
1404 | |
|
|
1405 | =item $term->register_command ($keysym, $modifiermask, $string) |
|
|
1406 | |
|
|
1407 | Adds a key binding. This is a lower level api compared to |
|
|
1408 | C<parse_keysym>, as it expects a parsed key description, and can be |
|
|
1409 | used only inside either the C<on_init> hook, to add a binding, or the |
|
|
1410 | C<on_register_command> hook, to modify a parsed binding. |
949 | |
1411 | |
950 | =item $rend = $term->rstyle ([$new_rstyle]) |
1412 | =item $rend = $term->rstyle ([$new_rstyle]) |
951 | |
1413 | |
952 | Return and optionally change the current rendition. Text that is output by |
1414 | Return and optionally change the current rendition. Text that is output by |
953 | the terminal application will use this style. |
1415 | the terminal application will use this style. |
… | |
… | |
961 | |
1423 | |
962 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1424 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
963 | |
1425 | |
964 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1426 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
965 | |
1427 | |
966 | Return the current values of the selection mark, begin or end positions, |
1428 | Return the current values of the selection mark, begin or end positions. |
967 | and optionally set them to new values. |
1429 | |
|
|
1430 | When arguments are given, then the selection coordinates are set to |
|
|
1431 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1432 | screen. |
|
|
1433 | |
|
|
1434 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1435 | |
|
|
1436 | Returns the current selection screen, and then optionally sets it. |
968 | |
1437 | |
969 | =item $term->selection_make ($eventtime[, $rectangular]) |
1438 | =item $term->selection_make ($eventtime[, $rectangular]) |
970 | |
1439 | |
971 | Tries to make a selection as set by C<selection_beg> and |
1440 | Tries to make a selection as set by C<selection_beg> and |
972 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1441 | C<selection_end>. If C<$rectangular> is true (default: false), a |
973 | rectangular selection will be made. This is the prefered function to make |
1442 | rectangular selection will be made. This is the preferred function to make |
974 | a selection. |
1443 | a selection. |
975 | |
1444 | |
976 | =item $success = $term->selection_grab ($eventtime) |
1445 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
977 | |
1446 | |
978 | Try to request the primary selection text from the server (for example, as |
1447 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1448 | true) selection from the server. The corresponding text can be set |
979 | set by the next method). No visual feedback will be given. This function |
1449 | with the next method. No visual feedback will be given. This function |
980 | is mostly useful from within C<on_sel_grab> hooks. |
1450 | is mostly useful from within C<on_sel_grab> hooks. |
981 | |
1451 | |
982 | =item $oldtext = $term->selection ([$newtext]) |
1452 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
983 | |
1453 | |
984 | Return the current selection text and optionally replace it by C<$newtext>. |
1454 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1455 | and optionally replace it by C<$newtext>. |
|
|
1456 | |
|
|
1457 | =item $term->selection_clear ([$clipboard]) |
|
|
1458 | |
|
|
1459 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
985 | |
1460 | |
986 | =item $term->overlay_simple ($x, $y, $text) |
1461 | =item $term->overlay_simple ($x, $y, $text) |
987 | |
1462 | |
988 | Create a simple multi-line overlay box. See the next method for details. |
1463 | Create a simple multi-line overlay box. See the next method for details. |
989 | |
1464 | |
… | |
… | |
1019 | |
1494 | |
1020 | The methods currently supported on C<urxvt::overlay> objects are: |
1495 | The methods currently supported on C<urxvt::overlay> objects are: |
1021 | |
1496 | |
1022 | =over 4 |
1497 | =over 4 |
1023 | |
1498 | |
1024 | =item $overlay->set ($x, $y, $text, $rend) |
1499 | =item $overlay->set ($x, $y, $text[, $rend]) |
1025 | |
1500 | |
1026 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1501 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1027 | text in rxvt-unicode's special encoding and an array of rendition values |
1502 | text in rxvt-unicode's special encoding and an array of rendition values |
1028 | at a specific position inside the overlay. |
1503 | at a specific position inside the overlay. |
|
|
1504 | |
|
|
1505 | If C<$rend> is missing, then the rendition will not be changed. |
1029 | |
1506 | |
1030 | =item $overlay->hide |
1507 | =item $overlay->hide |
1031 | |
1508 | |
1032 | If visible, hide the overlay, but do not destroy it. |
1509 | If visible, hide the overlay, but do not destroy it. |
1033 | |
1510 | |
… | |
… | |
1103 | |
1580 | |
1104 | Normally its not a good idea to use this function, as programs might be |
1581 | Normally its not a good idea to use this function, as programs might be |
1105 | confused by changes in cursor position or scrolling. Its useful inside a |
1582 | confused by changes in cursor position or scrolling. Its useful inside a |
1106 | C<on_add_lines> hook, though. |
1583 | C<on_add_lines> hook, though. |
1107 | |
1584 | |
|
|
1585 | =item $term->scr_change_screen ($screen) |
|
|
1586 | |
|
|
1587 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1588 | |
1108 | =item $term->cmd_parse ($octets) |
1589 | =item $term->cmd_parse ($octets) |
1109 | |
1590 | |
1110 | Similar to C<scr_add_lines>, but the argument must be in the |
1591 | Similar to C<scr_add_lines>, but the argument must be in the |
1111 | locale-specific encoding of the terminal and can contain command sequences |
1592 | locale-specific encoding of the terminal and can contain command sequences |
1112 | (escape codes) that will be interpreted. |
1593 | (escape codes) that will be interpreted. |
1113 | |
1594 | |
1114 | =item $term->tt_write ($octets) |
1595 | =item $term->tt_write ($octets) |
1115 | |
1596 | |
1116 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1597 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1117 | pass characters instead of octets, you should convert your strings first |
1598 | pass characters instead of octets, you should convert your strings first |
1118 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1599 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1600 | |
|
|
1601 | =item $term->tt_paste ($octets) |
|
|
1602 | |
|
|
1603 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1604 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1605 | is set. |
1119 | |
1606 | |
1120 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1607 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1121 | |
1608 | |
1122 | Replaces the event mask of the pty watcher by the given event mask. Can |
1609 | Replaces the event mask of the pty watcher by the given event mask. Can |
1123 | be used to suppress input and output handling to the pty/tty. See the |
1610 | be used to suppress input and output handling to the pty/tty. See the |
1124 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1611 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1125 | the previous value. |
1612 | the previous value. |
1126 | |
1613 | |
|
|
1614 | =item $fd = $term->pty_fd |
|
|
1615 | |
|
|
1616 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1617 | is used. |
|
|
1618 | |
1127 | =item $windowid = $term->parent |
1619 | =item $windowid = $term->parent |
1128 | |
1620 | |
1129 | Return the window id of the toplevel window. |
1621 | Return the window id of the toplevel window. |
1130 | |
1622 | |
1131 | =item $windowid = $term->vt |
1623 | =item $windowid = $term->vt |
1132 | |
1624 | |
1133 | Return the window id of the terminal window. |
1625 | Return the window id of the terminal window. |
1134 | |
1626 | |
|
|
1627 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1628 | |
|
|
1629 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1630 | to receive pointer events all the times: |
|
|
1631 | |
|
|
1632 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1633 | |
|
|
1634 | =item $term->set_urgency ($set) |
|
|
1635 | |
|
|
1636 | Enable/disable the urgency hint on the toplevel window. |
|
|
1637 | |
|
|
1638 | =item $term->focus_in |
|
|
1639 | |
|
|
1640 | =item $term->focus_out |
|
|
1641 | |
|
|
1642 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1643 | |
|
|
1644 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1645 | |
|
|
1646 | Deliver various fake events to to terminal. |
|
|
1647 | |
1135 | =item $window_width = $term->width |
1648 | =item $window_width = $term->width |
1136 | |
1649 | |
1137 | =item $window_height = $term->height |
1650 | =item $window_height = $term->height |
1138 | |
1651 | |
1139 | =item $font_width = $term->fwidth |
1652 | =item $font_width = $term->fwidth |
… | |
… | |
1152 | |
1665 | |
1153 | =item $max_scrollback = $term->saveLines |
1666 | =item $max_scrollback = $term->saveLines |
1154 | |
1667 | |
1155 | =item $nrow_plus_saveLines = $term->total_rows |
1668 | =item $nrow_plus_saveLines = $term->total_rows |
1156 | |
1669 | |
1157 | =item $lines_in_scrollback = $term->nsaved |
1670 | =item $topmost_scrollback_row = $term->top_row |
1158 | |
1671 | |
1159 | Return various integers describing terminal characteristics. |
1672 | Return various integers describing terminal characteristics. |
1160 | |
1673 | |
1161 | =item $x_display = $term->display_id |
1674 | =item $x_display = $term->display_id |
1162 | |
1675 | |
… | |
… | |
1169 | =item $env = $term->env |
1682 | =item $env = $term->env |
1170 | |
1683 | |
1171 | Returns a copy of the environment in effect for the terminal as a hashref |
1684 | Returns a copy of the environment in effect for the terminal as a hashref |
1172 | similar to C<\%ENV>. |
1685 | similar to C<\%ENV>. |
1173 | |
1686 | |
|
|
1687 | =item @envv = $term->envv |
|
|
1688 | |
|
|
1689 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1690 | |
|
|
1691 | =item @argv = $term->argv |
|
|
1692 | |
|
|
1693 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1694 | includes the program name as first element. |
|
|
1695 | |
1174 | =cut |
1696 | =cut |
1175 | |
1697 | |
1176 | sub env { |
1698 | sub env { |
1177 | if (my $env = $_[0]->_env) { |
|
|
1178 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1699 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1179 | } else { |
|
|
1180 | +{ %ENV } |
|
|
1181 | } |
|
|
1182 | } |
1700 | } |
1183 | |
1701 | |
1184 | =item $modifiermask = $term->ModLevel3Mask |
1702 | =item $modifiermask = $term->ModLevel3Mask |
1185 | |
1703 | |
1186 | =item $modifiermask = $term->ModMetaMask |
1704 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1188 | =item $modifiermask = $term->ModNumLockMask |
1706 | =item $modifiermask = $term->ModNumLockMask |
1189 | |
1707 | |
1190 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1708 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1191 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1709 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1192 | |
1710 | |
|
|
1711 | =item $screen = $term->current_screen |
|
|
1712 | |
|
|
1713 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1714 | |
|
|
1715 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1716 | |
|
|
1717 | Returns whether the cursor is currently hidden or not. |
|
|
1718 | |
1193 | =item $view_start = $term->view_start ([$newvalue]) |
1719 | =item $view_start = $term->view_start ([$newvalue]) |
1194 | |
1720 | |
1195 | Returns the negative row number of the topmost line. Minimum value is |
1721 | Returns the row number of the topmost displayed line. Maximum value is |
1196 | C<0>, which displays the normal terminal contents. Larger values scroll |
1722 | C<0>, which displays the normal terminal contents. Lower values scroll |
1197 | this many lines into the scrollback buffer. |
1723 | this many lines into the scrollback buffer. |
1198 | |
1724 | |
1199 | =item $term->want_refresh |
1725 | =item $term->want_refresh |
1200 | |
1726 | |
1201 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1727 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1204 | |
1730 | |
1205 | Used after changing terminal contents to display them. |
1731 | Used after changing terminal contents to display them. |
1206 | |
1732 | |
1207 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1733 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1208 | |
1734 | |
1209 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1735 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1210 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1736 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1211 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1212 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1737 | terminal line. Nothing will be returned if a nonexistent line |
1213 | is requested. |
1738 | is requested. |
1214 | |
1739 | |
1215 | If C<$new_text> is specified, it will replace characters in the current |
1740 | If C<$new_text> is specified, it will replace characters in the current |
1216 | line, starting at column C<$start_col> (default C<0>), which is useful |
1741 | line, starting at column C<$start_col> (default C<0>), which is useful |
1217 | to replace only parts of a line. The font index in the rendition will |
1742 | to replace only parts of a line. The font index in the rendition will |
1218 | automatically be updated. |
1743 | automatically be updated. |
1219 | |
1744 | |
1220 | C<$text> is in a special encoding: tabs and wide characters that use more |
1745 | C<$text> is in a special encoding: tabs and wide characters that use more |
1221 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1746 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1222 | (C<chr 65535>). Characters with combining characters and other characters |
1747 | characters. Characters with combining characters and other characters that |
1223 | that do not fit into the normal tetx encoding will be replaced with |
1748 | do not fit into the normal text encoding will be replaced with characters |
1224 | characters in the private use area. |
1749 | in the private use area. |
1225 | |
1750 | |
1226 | You have to obey this encoding when changing text. The advantage is |
1751 | You have to obey this encoding when changing text. The advantage is |
1227 | that C<substr> and similar functions work on screen cells and not on |
1752 | that C<substr> and similar functions work on screen cells and not on |
1228 | characters. |
1753 | characters. |
1229 | |
1754 | |
… | |
… | |
1373 | where one character corresponds to one screen cell. See |
1898 | where one character corresponds to one screen cell. See |
1374 | C<< $term->ROW_t >> for details. |
1899 | C<< $term->ROW_t >> for details. |
1375 | |
1900 | |
1376 | =item $string = $term->special_decode $text |
1901 | =item $string = $term->special_decode $text |
1377 | |
1902 | |
1378 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1903 | Converts rxvt-unicodes text representation into a perl string. See |
1379 | C<< $term->ROW_t >> for details. |
1904 | C<< $term->ROW_t >> for details. |
1380 | |
1905 | |
1381 | =item $success = $term->grab_button ($button, $modifiermask) |
1906 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1382 | |
1907 | |
|
|
1908 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1909 | |
1383 | Registers a synchronous button grab. See the XGrabButton manpage. |
1910 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1911 | manpage. |
1384 | |
1912 | |
1385 | =item $success = $term->grab ($eventtime[, $sync]) |
1913 | =item $success = $term->grab ($eventtime[, $sync]) |
1386 | |
1914 | |
1387 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1915 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1388 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1916 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1389 | |
1917 | |
1390 | =item $term->allow_events_async |
1918 | =item $term->allow_events_async |
1391 | |
1919 | |
1392 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1920 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1393 | |
1921 | |
… | |
… | |
1400 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1928 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1401 | recent grab. |
1929 | recent grab. |
1402 | |
1930 | |
1403 | =item $term->ungrab |
1931 | =item $term->ungrab |
1404 | |
1932 | |
1405 | Calls XUngrab for the most recent grab. Is called automatically on |
1933 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
1406 | evaluation errors, as it is better to lose the grab in the error case as |
1934 | evaluation errors, as it is better to lose the grab in the error case as |
1407 | the session. |
1935 | the session. |
|
|
1936 | |
|
|
1937 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1938 | |
|
|
1939 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1940 | |
|
|
1941 | =item @atoms = $term->XListProperties ($window) |
|
|
1942 | |
|
|
1943 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1944 | |
|
|
1945 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
|
|
1946 | |
|
|
1947 | =item $term->XDeleteProperty ($window, $property) |
|
|
1948 | |
|
|
1949 | =item $window = $term->DefaultRootWindow |
|
|
1950 | |
|
|
1951 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1952 | |
|
|
1953 | =item $term->XMapWindow ($window) |
|
|
1954 | |
|
|
1955 | =item $term->XUnmapWindow ($window) |
|
|
1956 | |
|
|
1957 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1958 | |
|
|
1959 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1960 | |
|
|
1961 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1962 | |
|
|
1963 | =item $keysym = $term->XStringToKeysym ($string) |
|
|
1964 | |
|
|
1965 | =item $string = $term->XKeysymToString ($keysym) |
|
|
1966 | |
|
|
1967 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1968 | the source of the display, otherwise those functions map more-or-less |
|
|
1969 | directly onto the X functions of the same name. |
1408 | |
1970 | |
1409 | =back |
1971 | =back |
1410 | |
1972 | |
1411 | =cut |
1973 | =cut |
1412 | |
1974 | |
… | |
… | |
1476 | my ($self, $text, $cb) = @_; |
2038 | my ($self, $text, $cb) = @_; |
1477 | |
2039 | |
1478 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
2040 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1479 | } |
2041 | } |
1480 | |
2042 | |
1481 | =item $popup->add_toggle ($text, $cb, $initial_value) |
2043 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1482 | |
2044 | |
1483 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
2045 | Adds a toggle/checkbox item to the popup. The callback gets called |
1484 | whenever it gets toggled, with a boolean indicating its value as its first |
2046 | whenever it gets toggled, with a boolean indicating its new value as its |
1485 | argument. |
2047 | first argument. |
1486 | |
2048 | |
1487 | =cut |
2049 | =cut |
1488 | |
2050 | |
1489 | sub add_toggle { |
2051 | sub add_toggle { |
1490 | my ($self, $text, $cb, $value) = @_; |
2052 | my ($self, $text, $value, $cb) = @_; |
1491 | |
2053 | |
1492 | my $item; $item = { |
2054 | my $item; $item = { |
1493 | type => "button", |
2055 | type => "button", |
1494 | text => " $text", |
2056 | text => " $text", |
1495 | value => $value, |
2057 | value => $value, |
… | |
… | |
1514 | my $env = $self->{term}->env; |
2076 | my $env = $self->{term}->env; |
1515 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
2077 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1516 | delete $env->{LC_ALL}; |
2078 | delete $env->{LC_ALL}; |
1517 | $env->{LC_CTYPE} = $self->{term}->locale; |
2079 | $env->{LC_CTYPE} = $self->{term}->locale; |
1518 | |
2080 | |
1519 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
2081 | my $term = urxvt::term->new ( |
1520 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
2082 | $env, "popup", |
|
|
2083 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
2084 | "-pty-fd" => -1, "-sl" => 0, |
|
|
2085 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1521 | "--transient-for" => $self->{term}->parent, |
2086 | "--transient-for" => $self->{term}->parent, |
1522 | "-display" => $self->{term}->display_id, |
2087 | "-display" => $self->{term}->display_id, |
1523 | "-pe" => "urxvt-popup") |
2088 | "-pe" => "urxvt-popup", |
1524 | or die "unable to create popup window\n"; |
2089 | ) or die "unable to create popup window\n"; |
|
|
2090 | |
|
|
2091 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
2092 | $term->ungrab; |
|
|
2093 | $term->destroy; |
|
|
2094 | die "unable to initialise popup window\n"; |
|
|
2095 | } |
1525 | } |
2096 | } |
1526 | |
2097 | |
1527 | sub DESTROY { |
2098 | sub DESTROY { |
1528 | my ($self) = @_; |
2099 | my ($self) = @_; |
1529 | |
2100 | |
1530 | delete $self->{term}{_destroy}{$self}; |
2101 | delete $self->{term}{_destroy}{$self}; |
1531 | $self->{term}->ungrab; |
2102 | $self->{term}->ungrab; |
1532 | } |
2103 | } |
1533 | |
2104 | |
1534 | =back |
2105 | =back |
|
|
2106 | |
|
|
2107 | =cut |
|
|
2108 | |
|
|
2109 | package urxvt::watcher; |
1535 | |
2110 | |
1536 | =head2 The C<urxvt::timer> Class |
2111 | =head2 The C<urxvt::timer> Class |
1537 | |
2112 | |
1538 | This class implements timer watchers/events. Time is represented as a |
2113 | This class implements timer watchers/events. Time is represented as a |
1539 | fractional number of seconds since the epoch. Example: |
2114 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1543 | ->new |
2118 | ->new |
1544 | ->interval (1) |
2119 | ->interval (1) |
1545 | ->cb (sub { |
2120 | ->cb (sub { |
1546 | $term->{overlay}->set (0, 0, |
2121 | $term->{overlay}->set (0, 0, |
1547 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2122 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1548 | }); |
2123 | }); |
1549 | |
2124 | |
1550 | =over 4 |
2125 | =over 4 |
1551 | |
2126 | |
1552 | =item $timer = new urxvt::timer |
2127 | =item $timer = new urxvt::timer |
1553 | |
2128 | |
… | |
… | |
1556 | |
2131 | |
1557 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2132 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
1558 | |
2133 | |
1559 | Set the callback to be called when the timer triggers. |
2134 | Set the callback to be called when the timer triggers. |
1560 | |
2135 | |
1561 | =item $tstamp = $timer->at |
|
|
1562 | |
|
|
1563 | Return the time this watcher will fire next. |
|
|
1564 | |
|
|
1565 | =item $timer = $timer->set ($tstamp) |
2136 | =item $timer = $timer->set ($tstamp[, $interval]) |
1566 | |
2137 | |
1567 | Set the time the event is generated to $tstamp. |
2138 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2139 | new $interval). |
1568 | |
2140 | |
1569 | =item $timer = $timer->interval ($interval) |
2141 | =item $timer = $timer->interval ($interval) |
1570 | |
2142 | |
1571 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2143 | By default (and when C<$interval> is C<0>), the timer will automatically |
1572 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2144 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
1573 | is automatically rescheduled at the given intervals. |
2145 | is automatically rescheduled at the given intervals. |
1574 | |
2146 | |
1575 | =item $timer = $timer->start |
2147 | =item $timer = $timer->start |
1576 | |
2148 | |
1577 | Start the timer. |
2149 | Start the timer. |
1578 | |
2150 | |
1579 | =item $timer = $timer->start ($tstamp) |
2151 | =item $timer = $timer->start ($tstamp[, $interval]) |
1580 | |
2152 | |
1581 | Set the event trigger time to C<$tstamp> and start the timer. |
2153 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2154 | also replaces the interval. |
|
|
2155 | |
|
|
2156 | =item $timer = $timer->after ($delay[, $interval]) |
|
|
2157 | |
|
|
2158 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1582 | |
2159 | |
1583 | =item $timer = $timer->stop |
2160 | =item $timer = $timer->stop |
1584 | |
2161 | |
1585 | Stop the timer. |
2162 | Stop the timer. |
1586 | |
2163 | |
… | |
… | |
1592 | |
2169 | |
1593 | $term->{socket} = ... |
2170 | $term->{socket} = ... |
1594 | $term->{iow} = urxvt::iow |
2171 | $term->{iow} = urxvt::iow |
1595 | ->new |
2172 | ->new |
1596 | ->fd (fileno $term->{socket}) |
2173 | ->fd (fileno $term->{socket}) |
1597 | ->events (urxvt::EVENT_READ) |
2174 | ->events (urxvt::EV_READ) |
1598 | ->start |
2175 | ->start |
1599 | ->cb (sub { |
2176 | ->cb (sub { |
1600 | my ($iow, $revents) = @_; |
2177 | my ($iow, $revents) = @_; |
1601 | # $revents must be 1 here, no need to check |
2178 | # $revents must be 1 here, no need to check |
1602 | sysread $term->{socket}, my $buf, 8192 |
2179 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1615 | Set the callback to be called when io events are triggered. C<$reventmask> |
2192 | Set the callback to be called when io events are triggered. C<$reventmask> |
1616 | is a bitset as described in the C<events> method. |
2193 | is a bitset as described in the C<events> method. |
1617 | |
2194 | |
1618 | =item $iow = $iow->fd ($fd) |
2195 | =item $iow = $iow->fd ($fd) |
1619 | |
2196 | |
1620 | Set the filedescriptor (not handle) to watch. |
2197 | Set the file descriptor (not handle) to watch. |
1621 | |
2198 | |
1622 | =item $iow = $iow->events ($eventmask) |
2199 | =item $iow = $iow->events ($eventmask) |
1623 | |
2200 | |
1624 | Set the event mask to watch. The only allowed values are |
2201 | Set the event mask to watch. The only allowed values are |
1625 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2202 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
1626 | together, or C<urxvt::EVENT_NONE>. |
2203 | together, or C<urxvt::EV_NONE>. |
1627 | |
2204 | |
1628 | =item $iow = $iow->start |
2205 | =item $iow = $iow->start |
1629 | |
2206 | |
1630 | Start watching for requested events on the given handle. |
2207 | Start watching for requested events on the given handle. |
1631 | |
2208 | |
1632 | =item $iow = $iow->stop |
2209 | =item $iow = $iow->stop |
1633 | |
2210 | |
1634 | Stop watching for events on the given filehandle. |
2211 | Stop watching for events on the given file handle. |
|
|
2212 | |
|
|
2213 | =back |
|
|
2214 | |
|
|
2215 | =head2 The C<urxvt::iw> Class |
|
|
2216 | |
|
|
2217 | This class implements idle watchers, that get called automatically when |
|
|
2218 | the process is idle. They should return as fast as possible, after doing |
|
|
2219 | some useful work. |
|
|
2220 | |
|
|
2221 | =over 4 |
|
|
2222 | |
|
|
2223 | =item $iw = new urxvt::iw |
|
|
2224 | |
|
|
2225 | Create a new idle watcher object in stopped state. |
|
|
2226 | |
|
|
2227 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
2228 | |
|
|
2229 | Set the callback to be called when the watcher triggers. |
|
|
2230 | |
|
|
2231 | =item $timer = $timer->start |
|
|
2232 | |
|
|
2233 | Start the watcher. |
|
|
2234 | |
|
|
2235 | =item $timer = $timer->stop |
|
|
2236 | |
|
|
2237 | Stop the watcher. |
|
|
2238 | |
|
|
2239 | =back |
|
|
2240 | |
|
|
2241 | =head2 The C<urxvt::pw> Class |
|
|
2242 | |
|
|
2243 | This class implements process watchers. They create an event whenever a |
|
|
2244 | process exits, after which they stop automatically. |
|
|
2245 | |
|
|
2246 | my $pid = fork; |
|
|
2247 | ... |
|
|
2248 | $term->{pw} = urxvt::pw |
|
|
2249 | ->new |
|
|
2250 | ->start ($pid) |
|
|
2251 | ->cb (sub { |
|
|
2252 | my ($pw, $exit_status) = @_; |
|
|
2253 | ... |
|
|
2254 | }); |
|
|
2255 | |
|
|
2256 | =over 4 |
|
|
2257 | |
|
|
2258 | =item $pw = new urxvt::pw |
|
|
2259 | |
|
|
2260 | Create a new process watcher in stopped state. |
|
|
2261 | |
|
|
2262 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
2263 | |
|
|
2264 | Set the callback to be called when the timer triggers. |
|
|
2265 | |
|
|
2266 | =item $pw = $timer->start ($pid) |
|
|
2267 | |
|
|
2268 | Tells the watcher to start watching for process C<$pid>. |
|
|
2269 | |
|
|
2270 | =item $pw = $pw->stop |
|
|
2271 | |
|
|
2272 | Stop the watcher. |
1635 | |
2273 | |
1636 | =back |
2274 | =back |
1637 | |
2275 | |
1638 | =head1 ENVIRONMENT |
2276 | =head1 ENVIRONMENT |
1639 | |
2277 | |
… | |
… | |
1648 | |
2286 | |
1649 | =item >= 3 - script loading and management |
2287 | =item >= 3 - script loading and management |
1650 | |
2288 | |
1651 | =item >=10 - all called hooks |
2289 | =item >=10 - all called hooks |
1652 | |
2290 | |
1653 | =item >=11 - hook reutrn values |
2291 | =item >=11 - hook return values |
1654 | |
2292 | |
1655 | =back |
2293 | =back |
1656 | |
2294 | |
1657 | =head1 AUTHOR |
2295 | =head1 AUTHOR |
1658 | |
2296 | |
1659 | Marc Lehmann <pcg@goof.com> |
2297 | Marc Lehmann <schmorp@schmorp.de> |
1660 | http://software.schmorp.de/pkg/rxvt-unicode |
2298 | http://software.schmorp.de/pkg/rxvt-unicode |
1661 | |
2299 | |
1662 | =cut |
2300 | =cut |
1663 | |
2301 | |
1664 | 1 |
2302 | 1 |
|
|
2303 | |
|
|
2304 | # vim: sw=3: |