… | |
… | |
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. |
… | |
… | |
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<filename:number>, often seen in compiler messages, into C<vi +$filename |
203 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
123 | $word>: |
204 | $word>: |
124 | |
205 | |
125 | URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
206 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
126 | |
207 | |
127 | 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 |
128 | paste directly into your (vi :) editor: |
209 | paste directly into your (vi :) editor: |
129 | |
210 | |
130 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
211 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
131 | |
212 | |
132 | Of course, this can be modified to suit your needs and your editor :) |
213 | Of course, this can be modified to suit your needs and your editor :) |
133 | |
214 | |
134 | To expand the example above to typical perl error messages ("XXX at |
215 | To expand the example above to typical perl error messages ("XXX at |
135 | FILENAME line YYY."), you need a slightly more elaborate solution: |
216 | FILENAME line YYY."), you need a slightly more elaborate solution: |
136 | |
217 | |
137 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
218 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
138 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
219 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
139 | |
220 | |
140 | The first line tells the selection code to treat the unchanging part of |
221 | The first line tells the selection code to treat the unchanging part of |
141 | every error message as a selection pattern, and the second line transforms |
222 | every error message as a selection pattern, and the second line transforms |
142 | the message into vi commands to load the file. |
223 | the message into vi commands to load the file. |
143 | |
224 | |
144 | =item mark-urls |
225 | =item tabbed |
145 | |
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 | |
146 | 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 |
147 | make them clickable. When middle-clicked, the program specified in the |
251 | matching a certain pattern and make it clickable. When clicked with the |
148 | 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 |
149 | 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 from the keyboard. |
|
|
265 | Simply bind a keysym to "perl:matcher" as seen in the example below. |
|
|
266 | |
|
|
267 | Example configuration: |
|
|
268 | |
|
|
269 | URxvt.perl-ext: default,matcher |
|
|
270 | URxvt.urlLauncher: sensible-browser |
|
|
271 | URxvt.keysym.C-Delete: perl:matcher |
|
|
272 | URxvt.matcher.button: 1 |
|
|
273 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
274 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
275 | URxvt.matcher.launcher.2: gvim +$2 $1 |
|
|
276 | |
|
|
277 | =item xim-onthespot |
|
|
278 | |
|
|
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
280 | not work perfectly, and some input methods don't seem to work well with |
|
|
281 | OnTheSpot editing in general, but it seems to work at least for SCIM and |
|
|
282 | kinput2. |
|
|
283 | |
|
|
284 | You enable it by specifying this extension and a preedit style of |
|
|
285 | C<OnTheSpot>, i.e.: |
|
|
286 | |
|
|
287 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
288 | |
|
|
289 | =item kuake<hotkey> |
|
|
290 | |
|
|
291 | A very primitive quake-console-like extension. It was inspired by a |
|
|
292 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
293 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
294 | will show or hide itself. Another press of the accelerator key will hide |
|
|
295 | or show it again. |
|
|
296 | |
|
|
297 | Initially, the window will not be shown when using this extension. |
|
|
298 | |
|
|
299 | This is useful if you need a single terminal that is not using any desktop |
|
|
300 | space most of the time but is quickly available at the press of a key. |
|
|
301 | |
|
|
302 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
303 | extension will actually grab a physical key just for this function. |
|
|
304 | |
|
|
305 | If you want a quake-like animation, tell your window manager to do so |
|
|
306 | (fvwm can do it). |
|
|
307 | |
|
|
308 | =item overlay-osc |
|
|
309 | |
|
|
310 | This extension implements some OSC commands to display timed popups on the |
|
|
311 | screen - useful for status displays from within scripts. You have to read |
|
|
312 | the sources for more info. |
150 | |
313 | |
151 | =item block-graphics-to-ascii |
314 | =item block-graphics-to-ascii |
152 | |
315 | |
153 | A not very useful example of filtering all text output to the terminal, |
316 | A not very useful example of filtering all text output to the terminal |
154 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
317 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
155 | similar-looking ascii character. |
318 | similar-looking ascii character. |
156 | |
319 | |
157 | =item digital-clock |
320 | =item digital-clock |
158 | |
321 | |
159 | Displays a digital clock using the built-in overlay. |
322 | Displays a digital clock using the built-in overlay. |
|
|
323 | |
|
|
324 | =item remote-clipboard |
|
|
325 | |
|
|
326 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
327 | selection popup that allows one to run external commands to store the |
|
|
328 | selection somewhere and fetch it again. |
|
|
329 | |
|
|
330 | We use it to implement a "distributed selection mechanism", which just |
|
|
331 | means that one command uploads the file to a remote server, and another |
|
|
332 | reads it. |
|
|
333 | |
|
|
334 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
335 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
336 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
337 | the selection data on STDOUT (also in UTF-8). |
|
|
338 | |
|
|
339 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
340 | |
|
|
341 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
342 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
|
|
343 | |
|
|
344 | =item selection-pastebin |
|
|
345 | |
|
|
346 | This is a little rarely useful extension that Uploads the selection as |
|
|
347 | textfile to a remote site (or does other things). (The implementation is |
|
|
348 | not currently secure for use in a multiuser environment as it writes to |
|
|
349 | F</tmp> directly.). |
|
|
350 | |
|
|
351 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
352 | i.e. |
|
|
353 | |
|
|
354 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
355 | |
|
|
356 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
357 | the textfile. This command can be set via a resource: |
|
|
358 | |
|
|
359 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
360 | |
|
|
361 | And the default is likely not useful to anybody but the few people around |
|
|
362 | here :) |
|
|
363 | |
|
|
364 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
365 | the same content should lead to the same filename. |
|
|
366 | |
|
|
367 | After a successful upload the selection will be replaced by the text given |
|
|
368 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
369 | for the filename): |
|
|
370 | |
|
|
371 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
372 | |
|
|
373 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
374 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
375 | which works regardless of wether xrdb is used to parse the resource file |
|
|
376 | or not. |
|
|
377 | |
|
|
378 | =item macosx-pastebin and macosx-pastebin-native |
|
|
379 | |
|
|
380 | These two modules implement an extended clipboard for Mac OS X. They are |
|
|
381 | used like this: |
|
|
382 | |
|
|
383 | URxvt.perl-ext-common: default,macosx-clipboard |
|
|
384 | URxvt.keysym.M-c: perl:macosx-clipboard:copy |
|
|
385 | URxvt.keysym.M-v: perl:macosx-clipboard:paste |
|
|
386 | |
|
|
387 | The difference between them is that the native variant requires a |
|
|
388 | perl from apple's devkit or so, and C<maxosx-pastebin> requires the |
|
|
389 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
|
|
390 | simpler etc. etc. |
160 | |
391 | |
161 | =item example-refresh-hooks |
392 | =item example-refresh-hooks |
162 | |
393 | |
163 | Displays a very simple digital clock in the upper right corner of the |
394 | Displays a very simple digital clock in the upper right corner of the |
164 | window. Illustrates overwriting the refresh callbacks to create your own |
395 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
204 | |
435 | |
205 | =back |
436 | =back |
206 | |
437 | |
207 | =head2 Extension Objects |
438 | =head2 Extension Objects |
208 | |
439 | |
209 | Very perl extension is a perl class. A separate perl object is created |
440 | Every perl extension is a perl class. A separate perl object is created |
210 | for each terminal and each extension and passed as the first parameter to |
441 | for each terminal, and each terminal has its own set of extenion objects, |
211 | hooks. So extensions can use their C<$self> object without having to think |
442 | which are passed as the first parameter to hooks. So extensions can use |
212 | about other extensions, with the exception of methods and members that |
443 | their C<$self> object without having to think about clashes with other |
|
|
444 | extensions or other terminals, with the exception of methods and members |
213 | begin with an underscore character C<_>: these are reserved for internal |
445 | that begin with an underscore character C<_>: these are reserved for |
214 | use. |
446 | internal use. |
215 | |
447 | |
216 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
448 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
217 | C<urxvt::term> class on this object. |
449 | C<urxvt::term> class on this object. |
218 | |
450 | |
219 | It has the following methods and data members: |
451 | It has the following methods and data members: |
… | |
… | |
240 | =head2 Hooks |
472 | =head2 Hooks |
241 | |
473 | |
242 | The following subroutines can be declared in extension files, and will be |
474 | The following subroutines can be declared in extension files, and will be |
243 | called whenever the relevant event happens. |
475 | called whenever the relevant event happens. |
244 | |
476 | |
245 | The first argument passed to them is an extension oject as described in |
477 | The first argument passed to them is an extension object as described in |
246 | the in the C<Extension Objects> section. |
478 | the in the C<Extension Objects> section. |
247 | |
479 | |
248 | B<All> of these hooks must return a boolean value. If it is true, then the |
480 | B<All> of these hooks must return a boolean value. If any of the called |
249 | event counts as being I<consumed>, and the invocation of other hooks is |
481 | hooks returns true, then the event counts as being I<consumed>, and the |
250 | skipped, and the relevant action might not be carried out by the C++ code. |
482 | relevant action might not be carried out by the C++ code. |
251 | |
483 | |
252 | I<< When in doubt, return a false value (preferably C<()>). >> |
484 | I<< When in doubt, return a false value (preferably C<()>). >> |
253 | |
485 | |
254 | =over 4 |
486 | =over 4 |
255 | |
487 | |
256 | =item on_init $term |
488 | =item on_init $term |
257 | |
489 | |
258 | Called after a new terminal object has been initialized, but before |
490 | Called after a new terminal object has been initialized, but before |
259 | windows are created or the command gets run. Most methods are unsafe to |
491 | windows are created or the command gets run. Most methods are unsafe to |
260 | call or deliver senseless data, as terminal size and other characteristics |
492 | call or deliver senseless data, as terminal size and other characteristics |
261 | have not yet been determined. You can safely query and change resources, |
493 | have not yet been determined. You can safely query and change resources |
262 | though. |
494 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
495 | place. |
|
|
496 | |
|
|
497 | =item on_start $term |
|
|
498 | |
|
|
499 | Called at the very end of initialisation of a new terminal, just before |
|
|
500 | trying to map (display) the toplevel and returning to the main loop. |
|
|
501 | |
|
|
502 | =item on_destroy $term |
|
|
503 | |
|
|
504 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
505 | still fully functional (not for long, though). |
263 | |
506 | |
264 | =item on_reset $term |
507 | =item on_reset $term |
265 | |
508 | |
266 | Called after the screen is "reset" for any reason, such as resizing or |
509 | Called after the screen is "reset" for any reason, such as resizing or |
267 | control sequences. Here is where you can react on changes to size-related |
510 | control sequences. Here is where you can react on changes to size-related |
268 | variables. |
511 | variables. |
269 | |
512 | |
270 | =item on_start $term |
513 | =item on_child_start $term, $pid |
271 | |
514 | |
272 | Called at the very end of initialisation of a new terminal, just before |
515 | Called just after the child process has been C<fork>ed. |
273 | returning to the mainloop. |
516 | |
|
|
517 | =item on_child_exit $term, $status |
|
|
518 | |
|
|
519 | Called just after the child process has exited. C<$status> is the status |
|
|
520 | from C<waitpid>. |
274 | |
521 | |
275 | =item on_sel_make $term, $eventtime |
522 | =item on_sel_make $term, $eventtime |
276 | |
523 | |
277 | Called whenever a selection has been made by the user, but before the |
524 | Called whenever a selection has been made by the user, but before the |
278 | selection text is copied, so changes to the beginning, end or type of the |
525 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
285 | |
532 | |
286 | Called whenever a selection has been copied, but before the selection is |
533 | Called whenever a selection has been copied, but before the selection is |
287 | requested from the server. The selection text can be queried and changed |
534 | requested from the server. The selection text can be queried and changed |
288 | by calling C<< $term->selection >>. |
535 | by calling C<< $term->selection >>. |
289 | |
536 | |
290 | Returning a true value aborts selection grabbing. It will still be hilighted. |
537 | Returning a true value aborts selection grabbing. It will still be highlighted. |
291 | |
538 | |
292 | =item on_sel_extend $term |
539 | =item on_sel_extend $term |
293 | |
540 | |
294 | Called whenever the user tries to extend the selection (e.g. with a double |
541 | Called whenever the user tries to extend the selection (e.g. with a double |
295 | click) and is either supposed to return false (normal operation), or |
542 | click) and is either supposed to return false (normal operation), or |
296 | should extend the selection itelf and return true to suppress the built-in |
543 | should extend the selection itself and return true to suppress the built-in |
297 | processing. This can happen multiple times, as long as the callback |
544 | processing. This can happen multiple times, as long as the callback |
298 | returns true, it will be called on every further click by the user and is |
545 | returns true, it will be called on every further click by the user and is |
299 | supposed to enlarge the selection more and more, if possible. |
546 | supposed to enlarge the selection more and more, if possible. |
300 | |
547 | |
301 | See the F<selection> example extension. |
548 | See the F<selection> example extension. |
302 | |
549 | |
303 | =item on_view_change $term, $offset |
550 | =item on_view_change $term, $offset |
304 | |
551 | |
305 | Called whenever the view offset changes, i..e the user or program |
552 | Called whenever the view offset changes, i.e. the user or program |
306 | scrolls. Offset C<0> means display the normal terminal, positive values |
553 | scrolls. Offset C<0> means display the normal terminal, positive values |
307 | show this many lines of scrollback. |
554 | show this many lines of scrollback. |
308 | |
555 | |
309 | =item on_scroll_back $term, $lines, $saved |
556 | =item on_scroll_back $term, $lines, $saved |
310 | |
557 | |
… | |
… | |
314 | |
561 | |
315 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
562 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
316 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
563 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
317 | number of lines that will be in the scrollback buffer. |
564 | number of lines that will be in the scrollback buffer. |
318 | |
565 | |
319 | =item on_osc_seq $term, $string |
566 | =item on_osc_seq $term, $op, $args, $resp |
|
|
567 | |
|
|
568 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
569 | behaviour. The default should be to return an empty list. A true value |
|
|
570 | suppresses execution of the request completely. Make sure you don't get |
|
|
571 | confused by recursive invocations when you output an OSC sequence within |
|
|
572 | this callback. |
|
|
573 | |
|
|
574 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
575 | |
|
|
576 | =item on_osc_seq_perl $term, $args, $resp |
320 | |
577 | |
321 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
578 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
322 | operating system command) is processed. Cursor position and other state |
579 | operating system command) is processed. Cursor position and other state |
323 | information is up-to-date when this happens. For interoperability, the |
580 | information is up-to-date when this happens. For interoperability, the |
324 | string should start with the extension name and a colon, to distinguish |
581 | string should start with the extension name (sans -osc) and a semicolon, |
325 | it from commands for other extensions, and this might be enforced in the |
582 | to distinguish it from commands for other extensions, and this might be |
326 | future. |
583 | enforced in the future. |
|
|
584 | |
|
|
585 | For example, C<overlay-osc> uses this: |
|
|
586 | |
|
|
587 | sub on_osc_seq_perl { |
|
|
588 | my ($self, $osc, $resp) = @_; |
|
|
589 | |
|
|
590 | return unless $osc =~ s/^overlay;//; |
|
|
591 | |
|
|
592 | ... process remaining $osc string |
|
|
593 | } |
327 | |
594 | |
328 | Be careful not ever to trust (in a security sense) the data you receive, |
595 | Be careful not ever to trust (in a security sense) the data you receive, |
329 | as its source can not easily be controleld (e-mail content, messages from |
596 | as its source can not easily be controlled (e-mail content, messages from |
330 | other users on the same system etc.). |
597 | other users on the same system etc.). |
|
|
598 | |
|
|
599 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
600 | sender. |
331 | |
601 | |
332 | =item on_add_lines $term, $string |
602 | =item on_add_lines $term, $string |
333 | |
603 | |
334 | Called whenever text is about to be output, with the text as argument. You |
604 | Called whenever text is about to be output, with the text as argument. You |
335 | can filter/change and output the text yourself by returning a true value |
605 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
356 | later with the already-modified line (e.g. if unrelated parts change), so |
626 | later with the already-modified line (e.g. if unrelated parts change), so |
357 | you cannot just toggle rendition bits, but only set them. |
627 | you cannot just toggle rendition bits, but only set them. |
358 | |
628 | |
359 | =item on_refresh_begin $term |
629 | =item on_refresh_begin $term |
360 | |
630 | |
361 | Called just before the screen gets redrawn. Can be used for overlay |
631 | Called just before the screen gets redrawn. Can be used for overlay or |
362 | or similar effects by modify terminal contents in refresh_begin, and |
632 | similar effects by modifying the terminal contents in refresh_begin, and |
363 | restoring them in refresh_end. The built-in overlay and selection display |
633 | restoring them in refresh_end. The built-in overlay and selection display |
364 | code is run after this hook, and takes precedence. |
634 | code is run after this hook, and takes precedence. |
365 | |
635 | |
366 | =item on_refresh_end $term |
636 | =item on_refresh_end $term |
367 | |
637 | |
368 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
638 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
369 | |
639 | |
370 | =item on_keyboard_command $term, $string |
640 | =item on_user_command $term, $string |
371 | |
641 | |
372 | Called whenever the user presses a key combination that has a |
642 | Called whenever a user-configured event is being activated (e.g. via |
373 | C<perl:string> action bound to it (see description of the B<keysym> |
643 | a C<perl:string> action bound to a key, see description of the B<keysym> |
374 | resource in the @@RXVT_NAME@@(1) manpage). |
644 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
645 | |
|
|
646 | The event is simply the action string. This interface is assumed to change |
|
|
647 | slightly in the future. |
|
|
648 | |
|
|
649 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
650 | |
|
|
651 | Called just after the new window size has been calculated, but before |
|
|
652 | windows are actually being resized or hints are being set. If this hook |
|
|
653 | returns TRUE, setting of the window hints is being skipped. |
375 | |
654 | |
376 | =item on_x_event $term, $event |
655 | =item on_x_event $term, $event |
377 | |
656 | |
378 | Called on every X event received on the vt window (and possibly other |
657 | Called on every X event received on the vt window (and possibly other |
379 | windows). Should only be used as a last resort. Most event structure |
658 | windows). Should only be used as a last resort. Most event structure |
380 | members are not passed. |
659 | members are not passed. |
381 | |
660 | |
|
|
661 | =item on_root_event $term, $event |
|
|
662 | |
|
|
663 | Like C<on_x_event>, but is called for events on the root window. |
|
|
664 | |
382 | =item on_focus_in $term |
665 | =item on_focus_in $term |
383 | |
666 | |
384 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
667 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
385 | does focus in processing. |
668 | does focus in processing. |
386 | |
669 | |
387 | =item on_focus_out $term |
670 | =item on_focus_out $term |
388 | |
671 | |
389 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
672 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
390 | focus out processing. |
673 | focus out processing. |
|
|
674 | |
|
|
675 | =item on_configure_notify $term, $event |
|
|
676 | |
|
|
677 | =item on_property_notify $term, $event |
391 | |
678 | |
392 | =item on_key_press $term, $event, $keysym, $octets |
679 | =item on_key_press $term, $event, $keysym, $octets |
393 | |
680 | |
394 | =item on_key_release $term, $event, $keysym |
681 | =item on_key_release $term, $event, $keysym |
395 | |
682 | |
… | |
… | |
405 | |
692 | |
406 | Called whenever the corresponding X event is received for the terminal If |
693 | Called whenever the corresponding X event is received for the terminal If |
407 | the hook returns true, then the even will be ignored by rxvt-unicode. |
694 | the hook returns true, then the even will be ignored by rxvt-unicode. |
408 | |
695 | |
409 | The event is a hash with most values as named by Xlib (see the XEvent |
696 | The event is a hash with most values as named by Xlib (see the XEvent |
410 | manpage), with the additional members C<row> and C<col>, which are the row |
697 | manpage), with the additional members C<row> and C<col>, which are the |
411 | and column under the mouse cursor. |
698 | (real, not screen-based) row and column under the mouse cursor. |
412 | |
699 | |
413 | C<on_key_press> additionally receives the string rxvt-unicode would |
700 | C<on_key_press> additionally receives the string rxvt-unicode would |
414 | output, if any, in locale-specific encoding. |
701 | output, if any, in locale-specific encoding. |
415 | |
702 | |
416 | subwindow. |
703 | subwindow. |
|
|
704 | |
|
|
705 | =item on_client_message $term, $event |
|
|
706 | |
|
|
707 | =item on_wm_protocols $term, $event |
|
|
708 | |
|
|
709 | =item on_wm_delete_window $term, $event |
|
|
710 | |
|
|
711 | Called when various types of ClientMessage events are received (all with |
|
|
712 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
417 | |
713 | |
418 | =back |
714 | =back |
419 | |
715 | |
420 | =cut |
716 | =cut |
421 | |
717 | |
… | |
… | |
427 | use Scalar::Util (); |
723 | use Scalar::Util (); |
428 | use List::Util (); |
724 | use List::Util (); |
429 | |
725 | |
430 | our $VERSION = 1; |
726 | our $VERSION = 1; |
431 | our $TERM; |
727 | our $TERM; |
|
|
728 | our @TERM_INIT; |
|
|
729 | our @TERM_EXT; |
432 | our @HOOKNAME; |
730 | our @HOOKNAME; |
433 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
731 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
434 | our %OPTION; |
732 | our %OPTION; |
435 | |
733 | |
436 | our $LIBDIR; |
734 | our $LIBDIR; |
437 | our $RESNAME; |
735 | our $RESNAME; |
438 | our $RESCLASS; |
736 | our $RESCLASS; |
439 | our $RXVTNAME; |
737 | our $RXVTNAME; |
440 | |
738 | |
|
|
739 | our $NOCHAR = chr 0xffff; |
|
|
740 | |
441 | =head2 Variables in the C<urxvt> Package |
741 | =head2 Variables in the C<urxvt> Package |
442 | |
742 | |
443 | =over 4 |
743 | =over 4 |
444 | |
744 | |
445 | =item $urxvt::LIBDIR |
745 | =item $urxvt::LIBDIR |
… | |
… | |
457 | |
757 | |
458 | =item $urxvt::TERM |
758 | =item $urxvt::TERM |
459 | |
759 | |
460 | The current terminal. This variable stores the current C<urxvt::term> |
760 | The current terminal. This variable stores the current C<urxvt::term> |
461 | object, whenever a callback/hook is executing. |
761 | object, whenever a callback/hook is executing. |
|
|
762 | |
|
|
763 | =item @urxvt::TERM_INIT |
|
|
764 | |
|
|
765 | All code references in this array will be called as methods of the next newly |
|
|
766 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
767 | gets cleared before the code references that were in it are being executed, |
|
|
768 | so references can push themselves onto it again if they so desire. |
|
|
769 | |
|
|
770 | This complements to the perl-eval command line option, but gets executed |
|
|
771 | first. |
|
|
772 | |
|
|
773 | =item @urxvt::TERM_EXT |
|
|
774 | |
|
|
775 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
776 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
777 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
462 | |
778 | |
463 | =back |
779 | =back |
464 | |
780 | |
465 | =head2 Functions in the C<urxvt> Package |
781 | =head2 Functions in the C<urxvt> Package |
466 | |
782 | |
… | |
… | |
481 | Using this function has the advantage that its output ends up in the |
797 | Using this function has the advantage that its output ends up in the |
482 | correct place, e.g. on stderr of the connecting urxvtc client. |
798 | correct place, e.g. on stderr of the connecting urxvtc client. |
483 | |
799 | |
484 | Messages have a size limit of 1023 bytes currently. |
800 | Messages have a size limit of 1023 bytes currently. |
485 | |
801 | |
486 | =item $is_safe = urxvt::safe |
802 | =item @terms = urxvt::termlist |
487 | |
803 | |
488 | Returns true when it is safe to do potentially unsafe things, such as |
804 | Returns all urxvt::term objects that exist in this process, regardless of |
489 | evaluating perl code specified by the user. This is true when urxvt was |
805 | whether they are started, being destroyed etc., so be careful. Only term |
490 | started setuid or setgid. |
806 | objects that have perl extensions attached will be returned (because there |
|
|
807 | is no urxvt::term objet associated with others). |
491 | |
808 | |
492 | =item $time = urxvt::NOW |
809 | =item $time = urxvt::NOW |
493 | |
810 | |
494 | Returns the "current time" (as per the event loop). |
811 | Returns the "current time" (as per the event loop). |
495 | |
812 | |
… | |
… | |
554 | |
871 | |
555 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
872 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
556 | |
873 | |
557 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
874 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
558 | |
875 | |
|
|
876 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
|
|
877 | |
559 | Replace the foreground/background colour in the rendition mask with the |
878 | Replace the foreground/background colour in the rendition mask with the |
560 | specified one. |
879 | specified one. |
561 | |
880 | |
562 | =item $value = urxvt::GET_CUSTOM $rend |
881 | =item $value = urxvt::GET_CUSTOM $rend |
563 | |
882 | |
… | |
… | |
572 | =back |
891 | =back |
573 | |
892 | |
574 | =cut |
893 | =cut |
575 | |
894 | |
576 | BEGIN { |
895 | BEGIN { |
577 | urxvt->bootstrap; |
|
|
578 | |
|
|
579 | # overwrite perl's warn |
896 | # overwrite perl's warn |
580 | *CORE::GLOBAL::warn = sub { |
897 | *CORE::GLOBAL::warn = sub { |
581 | my $msg = join "", @_; |
898 | my $msg = join "", @_; |
582 | $msg .= "\n" |
899 | $msg .= "\n" |
583 | unless $msg =~ /\n$/; |
900 | unless $msg =~ /\n$/; |
584 | urxvt::warn ($msg); |
901 | urxvt::warn ($msg); |
585 | }; |
902 | }; |
586 | |
|
|
587 | # %ENV is the original startup environment |
|
|
588 | delete $ENV{IFS}; |
|
|
589 | delete $ENV{CDPATH}; |
|
|
590 | delete $ENV{BASH_ENV}; |
|
|
591 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
592 | } |
903 | } |
|
|
904 | |
|
|
905 | no warnings 'utf8'; |
593 | |
906 | |
594 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
907 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
595 | |
908 | |
596 | sub verbose { |
909 | sub verbose { |
597 | my ($level, $msg) = @_; |
910 | my ($level, $msg) = @_; |
598 | warn "$msg\n" if $level <= $verbosity; |
911 | warn "$msg\n" if $level <= $verbosity; |
599 | } |
912 | } |
600 | |
913 | |
601 | my $extension_pkg = "extension0000"; |
|
|
602 | my %extension_pkg; |
914 | my %extension_pkg; |
603 | |
915 | |
604 | # load a single script into its own package, once only |
916 | # load a single script into its own package, once only |
605 | sub extension_package($) { |
917 | sub extension_package($) { |
606 | my ($path) = @_; |
918 | my ($path) = @_; |
607 | |
919 | |
608 | $extension_pkg{$path} ||= do { |
920 | $extension_pkg{$path} ||= do { |
609 | my $pkg = "urxvt::" . ($extension_pkg++); |
921 | $path =~ /([^\/\\]+)$/; |
|
|
922 | my $pkg = $1; |
|
|
923 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
924 | $pkg = "urxvt::ext::$pkg"; |
610 | |
925 | |
611 | verbose 3, "loading extension '$path' into package '$pkg'"; |
926 | verbose 3, "loading extension '$path' into package '$pkg'"; |
612 | |
927 | |
613 | open my $fh, "<:raw", $path |
928 | open my $fh, "<:raw", $path |
614 | or die "$path: $!"; |
929 | or die "$path: $!"; |
615 | |
930 | |
616 | my $source = untaint |
931 | my $source = |
617 | "package $pkg; use strict; use utf8;\n" |
932 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
618 | . "use base urxvt::term::extension::;\n" |
|
|
619 | . "#line 1 \"$path\"\n{\n" |
933 | . "#line 1 \"$path\"\n{\n" |
620 | . (do { local $/; <$fh> }) |
934 | . (do { local $/; <$fh> }) |
621 | . "\n};\n1"; |
935 | . "\n};\n1"; |
622 | |
936 | |
623 | eval $source |
937 | eval $source |
… | |
… | |
634 | local $TERM = shift; |
948 | local $TERM = shift; |
635 | my $htype = shift; |
949 | my $htype = shift; |
636 | |
950 | |
637 | if ($htype == 0) { # INIT |
951 | if ($htype == 0) { # INIT |
638 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
952 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
639 | |
953 | |
640 | my %ext_arg; |
954 | my %ext_arg; |
641 | |
955 | |
|
|
956 | { |
|
|
957 | my @init = @TERM_INIT; |
|
|
958 | @TERM_INIT = (); |
|
|
959 | $_->($TERM) for @init; |
|
|
960 | my @pkg = @TERM_EXT; |
|
|
961 | @TERM_EXT = (); |
|
|
962 | $TERM->register_package ($_) for @pkg; |
|
|
963 | } |
|
|
964 | |
642 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
965 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
643 | if ($_ eq "default") { |
966 | if ($_ eq "default") { |
644 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
967 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
645 | } elsif (/^-(.*)$/) { |
968 | } elsif (/^-(.*)$/) { |
646 | delete $ext_arg{$1}; |
969 | delete $ext_arg{$1}; |
647 | } elsif (/^([^<]+)<(.*)>$/) { |
970 | } elsif (/^([^<]+)<(.*)>$/) { |
648 | push @{ $ext_arg{$1} }, $2; |
971 | push @{ $ext_arg{$1} }, $2; |
649 | } else { |
972 | } else { |
650 | $ext_arg{$_} ||= []; |
973 | $ext_arg{$_} ||= []; |
651 | } |
974 | } |
652 | } |
975 | } |
653 | |
976 | |
654 | while (my ($ext, $argv) = each %ext_arg) { |
977 | for my $ext (sort keys %ext_arg) { |
655 | my @files = grep -f $_, map "$_/$ext", @dirs; |
978 | my @files = grep -f $_, map "$_/$ext", @dirs; |
656 | |
979 | |
657 | if (@files) { |
980 | if (@files) { |
658 | $TERM->register_package (extension_package $files[0], $argv); |
981 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
659 | } else { |
982 | } else { |
660 | warn "perl extension '$ext' not found in perl library search path\n"; |
983 | warn "perl extension '$ext' not found in perl library search path\n"; |
661 | } |
984 | } |
662 | } |
985 | } |
663 | |
986 | |
… | |
… | |
669 | |
992 | |
670 | if (my $cb = $TERM->{_hook}[$htype]) { |
993 | if (my $cb = $TERM->{_hook}[$htype]) { |
671 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
994 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
672 | if $verbosity >= 10; |
995 | if $verbosity >= 10; |
673 | |
996 | |
674 | keys %$cb; |
997 | for my $pkg (keys %$cb) { |
675 | |
|
|
676 | while (my ($pkg, $cb) = each %$cb) { |
|
|
677 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
998 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
678 | and last; |
999 | $retval ||= $retval_; |
679 | |
1000 | |
680 | if ($@) { |
1001 | if ($@) { |
681 | $TERM->ungrab; # better to lose the grab than the session |
1002 | $TERM->ungrab; # better to lose the grab than the session |
682 | warn $@; |
1003 | warn $@; |
683 | } |
1004 | } |
… | |
… | |
696 | } |
1017 | } |
697 | |
1018 | |
698 | $retval |
1019 | $retval |
699 | } |
1020 | } |
700 | |
1021 | |
701 | sub exec_async(@) { |
1022 | sub SET_COLOR($$$) { |
702 | my $pid = fork; |
1023 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
1024 | } |
703 | |
1025 | |
704 | return |
1026 | sub rend2mask { |
705 | if !defined $pid or $pid; |
1027 | no strict 'refs'; |
706 | |
1028 | my ($str, $mask) = (@_, 0); |
707 | %ENV = %{ $TERM->env }; |
1029 | my %color = ( fg => undef, bg => undef ); |
708 | |
1030 | my @failed; |
709 | exec @_; |
1031 | for my $spec ( split /\s+/, $str ) { |
710 | _exit 255; |
1032 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1033 | $color{lc($1)} = $2; |
|
|
1034 | } else { |
|
|
1035 | my $neg = $spec =~ s/^[-^]//; |
|
|
1036 | unless ( exists &{"RS_$spec"} ) { |
|
|
1037 | push @failed, $spec; |
|
|
1038 | next; |
|
|
1039 | } |
|
|
1040 | my $cur = &{"RS_$spec"}; |
|
|
1041 | if ( $neg ) { |
|
|
1042 | $mask &= ~$cur; |
|
|
1043 | } else { |
|
|
1044 | $mask |= $cur; |
|
|
1045 | } |
|
|
1046 | } |
|
|
1047 | } |
|
|
1048 | ($mask, @color{qw(fg bg)}, \@failed) |
711 | } |
1049 | } |
712 | |
1050 | |
713 | # urxvt::term::extension |
1051 | # urxvt::term::extension |
714 | |
1052 | |
715 | package urxvt::term::extension; |
1053 | package urxvt::term::extension; |
… | |
… | |
786 | is that you cannot use blocking APIs, but the non-blocking variant should |
1124 | is that you cannot use blocking APIs, but the non-blocking variant should |
787 | work. |
1125 | work. |
788 | |
1126 | |
789 | =cut |
1127 | =cut |
790 | |
1128 | |
791 | our $VERSION = 1; |
1129 | our $VERSION = '3.4'; |
792 | |
1130 | |
793 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1131 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
794 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1132 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
795 | |
1133 | |
796 | sub timer { |
1134 | sub timer { |
… | |
… | |
798 | |
1136 | |
799 | my $cb = $arg{cb}; |
1137 | my $cb = $arg{cb}; |
800 | |
1138 | |
801 | urxvt::timer |
1139 | urxvt::timer |
802 | ->new |
1140 | ->new |
803 | ->start (urxvt::NOW + $arg{after}) |
1141 | ->after ($arg{after}) |
|
|
1142 | ->interval ($arg{interval}) |
|
|
1143 | ->start |
804 | ->cb (sub { |
1144 | ->cb (sub { |
|
|
1145 | #TODO interval? |
805 | $_[0]->stop; # need to cancel manually |
1146 | $_[0]->stop; # need to cancel manually |
806 | $cb->(); |
1147 | $cb->(); |
807 | }) |
1148 | }) |
808 | } |
1149 | } |
809 | |
1150 | |
810 | sub io { |
1151 | sub io { |
811 | my ($class, %arg) = @_; |
1152 | my ($class, %arg) = @_; |
812 | |
1153 | |
813 | my $cb = $arg{cb}; |
1154 | my $cb = $arg{cb}; |
|
|
1155 | my $fd = fileno $arg{fh}; |
|
|
1156 | defined $fd or $fd = $arg{fh}; |
814 | |
1157 | |
815 | bless [$arg{fh}, urxvt::iow |
1158 | bless [$arg{fh}, urxvt::iow |
816 | ->new |
1159 | ->new |
817 | ->fd (fileno $arg{fh}) |
1160 | ->fd (defined fileno $arg{fh}) |
818 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1161 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
819 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1162 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
820 | ->start |
1163 | ->start |
821 | ->cb (sub { |
1164 | ->cb ($cb) |
822 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
823 | . ($_[1] & 2 ? 'w' : '')); |
|
|
824 | })], |
|
|
825 | urxvt::anyevent:: |
1165 | ], urxvt::anyevent:: |
|
|
1166 | } |
|
|
1167 | |
|
|
1168 | sub idle { |
|
|
1169 | my ($class, %arg) = @_; |
|
|
1170 | |
|
|
1171 | my $cb = $arg{cb}; |
|
|
1172 | |
|
|
1173 | urxvt::iw |
|
|
1174 | ->new |
|
|
1175 | ->start |
|
|
1176 | ->cb (sub { |
|
|
1177 | #TODO really cancel? |
|
|
1178 | $_[0]->stop; # need to cancel manually |
|
|
1179 | $cb->(); |
|
|
1180 | }) |
|
|
1181 | } |
|
|
1182 | |
|
|
1183 | sub child { |
|
|
1184 | my ($class, %arg) = @_; |
|
|
1185 | |
|
|
1186 | my $cb = $arg{cb}; |
|
|
1187 | |
|
|
1188 | urxvt::pw |
|
|
1189 | ->new |
|
|
1190 | ->start ($arg{pid}) |
|
|
1191 | ->cb (sub { |
|
|
1192 | #TODO really cancel? |
|
|
1193 | $_[0]->stop; # need to cancel manually |
|
|
1194 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1195 | }) |
826 | } |
1196 | } |
827 | |
1197 | |
828 | sub DESTROY { |
1198 | sub DESTROY { |
829 | $_[0][1]->stop; |
1199 | $_[0][1]->stop; |
830 | } |
1200 | } |
831 | |
1201 | |
832 | sub condvar { |
1202 | sub one_event { |
833 | bless \my $flag, urxvt::anyevent::condvar:: |
|
|
834 | } |
|
|
835 | |
|
|
836 | sub urxvt::anyevent::condvar::broadcast { |
|
|
837 | ${$_[0]}++; |
|
|
838 | } |
|
|
839 | |
|
|
840 | sub urxvt::anyevent::condvar::wait { |
|
|
841 | unless (${$_[0]}) { |
|
|
842 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1203 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
843 | } |
|
|
844 | } |
1204 | } |
845 | |
1205 | |
846 | package urxvt::term; |
1206 | package urxvt::term; |
847 | |
1207 | |
848 | =head2 The C<urxvt::term> Class |
1208 | =head2 The C<urxvt::term> Class |
… | |
… | |
853 | |
1213 | |
854 | # find on_xxx subs in the package and register them |
1214 | # find on_xxx subs in the package and register them |
855 | # as hooks |
1215 | # as hooks |
856 | sub register_package { |
1216 | sub register_package { |
857 | my ($self, $pkg, $argv) = @_; |
1217 | my ($self, $pkg, $argv) = @_; |
|
|
1218 | |
|
|
1219 | no strict 'refs'; |
|
|
1220 | |
|
|
1221 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
1222 | |
|
|
1223 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
858 | |
1224 | |
859 | my $proxy = bless { |
1225 | my $proxy = bless { |
860 | _pkg => $pkg, |
1226 | _pkg => $pkg, |
861 | argv => $argv, |
1227 | argv => $argv, |
862 | }, $pkg; |
1228 | }, $pkg; |
… | |
… | |
878 | hash which defines the environment of the new terminal. |
1244 | hash which defines the environment of the new terminal. |
879 | |
1245 | |
880 | Croaks (and probably outputs an error message) if the new instance |
1246 | Croaks (and probably outputs an error message) if the new instance |
881 | couldn't be created. Returns C<undef> if the new instance didn't |
1247 | couldn't be created. Returns C<undef> if the new instance didn't |
882 | initialise perl, and the terminal object otherwise. The C<init> and |
1248 | initialise perl, and the terminal object otherwise. The C<init> and |
883 | C<start> hooks will be called during this call. |
1249 | C<start> hooks will be called before this call returns, and are free to |
|
|
1250 | refer to global data (which is race free). |
884 | |
1251 | |
885 | =cut |
1252 | =cut |
886 | |
1253 | |
887 | sub new { |
1254 | sub new { |
888 | my ($class, $env, @args) = @_; |
1255 | my ($class, $env, @args) = @_; |
889 | |
1256 | |
|
|
1257 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1258 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1259 | |
890 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1260 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
891 | } |
1261 | } |
892 | |
1262 | |
893 | =item $term->destroy |
1263 | =item $term->destroy |
894 | |
1264 | |
895 | Destroy the terminal object (close the window, free resources |
1265 | Destroy the terminal object (close the window, free resources |
896 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1266 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
897 | watchers (timers, io watchers) are still active. |
1267 | watchers (timers, io watchers) are still active. |
898 | |
1268 | |
|
|
1269 | =item $term->exec_async ($cmd[, @args]) |
|
|
1270 | |
|
|
1271 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
1272 | ("starts") programs in the background. This function takes care of setting |
|
|
1273 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
1274 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
1275 | |
|
|
1276 | Returns the pid of the subprocess or C<undef> on error. |
|
|
1277 | |
|
|
1278 | =cut |
|
|
1279 | |
|
|
1280 | sub exec_async { |
|
|
1281 | my $self = shift; |
|
|
1282 | |
|
|
1283 | my $pid = fork; |
|
|
1284 | |
|
|
1285 | return $pid |
|
|
1286 | if !defined $pid or $pid; |
|
|
1287 | |
|
|
1288 | %ENV = %{ $self->env }; |
|
|
1289 | |
|
|
1290 | exec @_; |
|
|
1291 | urxvt::_exit 255; |
|
|
1292 | } |
|
|
1293 | |
899 | =item $isset = $term->option ($optval[, $set]) |
1294 | =item $isset = $term->option ($optval[, $set]) |
900 | |
1295 | |
901 | Returns true if the option specified by C<$optval> is enabled, and |
1296 | Returns true if the option specified by C<$optval> is enabled, and |
902 | optionally change it. All option values are stored by name in the hash |
1297 | optionally change it. All option values are stored by name in the hash |
903 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1298 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
904 | |
1299 | |
905 | Here is a a likely non-exhaustive list of option names, please see the |
1300 | Here is a likely non-exhaustive list of option names, please see the |
906 | source file F</src/optinc.h> to see the actual list: |
1301 | source file F</src/optinc.h> to see the actual list: |
907 | |
1302 | |
908 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1303 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
909 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1304 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
910 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1305 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
911 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1306 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
912 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1307 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
913 | tripleclickwords utmpInhibit visualBell |
1308 | transparent tripleclickwords utmpInhibit visualBell |
914 | |
1309 | |
915 | =item $value = $term->resource ($name[, $newval]) |
1310 | =item $value = $term->resource ($name[, $newval]) |
916 | |
1311 | |
917 | Returns the current resource value associated with a given name and |
1312 | Returns the current resource value associated with a given name and |
918 | optionally sets a new value. Setting values is most useful in the C<init> |
1313 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
927 | likely change). |
1322 | likely change). |
928 | |
1323 | |
929 | Please note that resource strings will currently only be freed when the |
1324 | Please note that resource strings will currently only be freed when the |
930 | terminal is destroyed, so changing options frequently will eat memory. |
1325 | terminal is destroyed, so changing options frequently will eat memory. |
931 | |
1326 | |
932 | Here is a a likely non-exhaustive list of resource names, not all of which |
1327 | Here is a likely non-exhaustive list of resource names, not all of which |
933 | are supported in every build, please see the source file F</src/rsinc.h> |
1328 | are supported in every build, please see the source file F</src/rsinc.h> |
934 | to see the actual list: |
1329 | to see the actual list: |
935 | |
1330 | |
936 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1331 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
937 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1332 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
938 | display_name embed ext_bwidth fade font geometry hold iconName |
1333 | display_name embed ext_bwidth fade font geometry hold iconName |
939 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1334 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
940 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1335 | italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 |
941 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1336 | modifier mouseWheelScrollPage name override_redirect pastableTabs path |
942 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1337 | perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
943 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1338 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
944 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1339 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
945 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1340 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
946 | shade term_name title transparent transparent_all tripleclickwords |
1341 | secondaryScreen secondaryScroll shade term_name title |
947 | utmpInhibit visualBell |
1342 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
|
|
1343 | visualBell |
948 | |
1344 | |
949 | =cut |
1345 | =cut |
950 | |
1346 | |
951 | sub resource($$;$) { |
1347 | sub resource($$;$) { |
952 | my ($self, $name) = (shift, shift); |
1348 | my ($self, $name) = (shift, shift); |
953 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1349 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
954 | &urxvt::term::_resource |
1350 | goto &urxvt::term::_resource |
955 | } |
1351 | } |
956 | |
1352 | |
957 | =item $value = $term->x_resource ($pattern) |
1353 | =item $value = $term->x_resource ($pattern) |
958 | |
1354 | |
959 | Returns the X-Resource for the given pattern, excluding the program or |
1355 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
1042 | |
1438 | |
1043 | The methods currently supported on C<urxvt::overlay> objects are: |
1439 | The methods currently supported on C<urxvt::overlay> objects are: |
1044 | |
1440 | |
1045 | =over 4 |
1441 | =over 4 |
1046 | |
1442 | |
1047 | =item $overlay->set ($x, $y, $text, $rend) |
1443 | =item $overlay->set ($x, $y, $text[, $rend]) |
1048 | |
1444 | |
1049 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1445 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1050 | text in rxvt-unicode's special encoding and an array of rendition values |
1446 | text in rxvt-unicode's special encoding and an array of rendition values |
1051 | at a specific position inside the overlay. |
1447 | at a specific position inside the overlay. |
|
|
1448 | |
|
|
1449 | If C<$rend> is missing, then the rendition will not be changed. |
1052 | |
1450 | |
1053 | =item $overlay->hide |
1451 | =item $overlay->hide |
1054 | |
1452 | |
1055 | If visible, hide the overlay, but do not destroy it. |
1453 | If visible, hide the overlay, but do not destroy it. |
1056 | |
1454 | |
… | |
… | |
1126 | |
1524 | |
1127 | Normally its not a good idea to use this function, as programs might be |
1525 | Normally its not a good idea to use this function, as programs might be |
1128 | confused by changes in cursor position or scrolling. Its useful inside a |
1526 | confused by changes in cursor position or scrolling. Its useful inside a |
1129 | C<on_add_lines> hook, though. |
1527 | C<on_add_lines> hook, though. |
1130 | |
1528 | |
|
|
1529 | =item $term->scr_change_screen ($screen) |
|
|
1530 | |
|
|
1531 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1532 | |
1131 | =item $term->cmd_parse ($octets) |
1533 | =item $term->cmd_parse ($octets) |
1132 | |
1534 | |
1133 | Similar to C<scr_add_lines>, but the argument must be in the |
1535 | Similar to C<scr_add_lines>, but the argument must be in the |
1134 | locale-specific encoding of the terminal and can contain command sequences |
1536 | locale-specific encoding of the terminal and can contain command sequences |
1135 | (escape codes) that will be interpreted. |
1537 | (escape codes) that will be interpreted. |
… | |
… | |
1145 | Replaces the event mask of the pty watcher by the given event mask. Can |
1547 | Replaces the event mask of the pty watcher by the given event mask. Can |
1146 | be used to suppress input and output handling to the pty/tty. See the |
1548 | be used to suppress input and output handling to the pty/tty. See the |
1147 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1549 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1148 | the previous value. |
1550 | the previous value. |
1149 | |
1551 | |
|
|
1552 | =item $fd = $term->pty_fd |
|
|
1553 | |
|
|
1554 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1555 | is used. |
|
|
1556 | |
1150 | =item $windowid = $term->parent |
1557 | =item $windowid = $term->parent |
1151 | |
1558 | |
1152 | Return the window id of the toplevel window. |
1559 | Return the window id of the toplevel window. |
1153 | |
1560 | |
1154 | =item $windowid = $term->vt |
1561 | =item $windowid = $term->vt |
… | |
… | |
1160 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1567 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1161 | to receive pointer events all the times: |
1568 | to receive pointer events all the times: |
1162 | |
1569 | |
1163 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1570 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1164 | |
1571 | |
|
|
1572 | =item $term->focus_in |
|
|
1573 | |
|
|
1574 | =item $term->focus_out |
|
|
1575 | |
|
|
1576 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1577 | |
|
|
1578 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1579 | |
|
|
1580 | Deliver various fake events to to terminal. |
|
|
1581 | |
1165 | =item $window_width = $term->width |
1582 | =item $window_width = $term->width |
1166 | |
1583 | |
1167 | =item $window_height = $term->height |
1584 | =item $window_height = $term->height |
1168 | |
1585 | |
1169 | =item $font_width = $term->fwidth |
1586 | =item $font_width = $term->fwidth |
… | |
… | |
1182 | |
1599 | |
1183 | =item $max_scrollback = $term->saveLines |
1600 | =item $max_scrollback = $term->saveLines |
1184 | |
1601 | |
1185 | =item $nrow_plus_saveLines = $term->total_rows |
1602 | =item $nrow_plus_saveLines = $term->total_rows |
1186 | |
1603 | |
1187 | =item $lines_in_scrollback = $term->nsaved |
1604 | =item $topmost_scrollback_row = $term->top_row |
1188 | |
1605 | |
1189 | Return various integers describing terminal characteristics. |
1606 | Return various integers describing terminal characteristics. |
1190 | |
1607 | |
1191 | =item $x_display = $term->display_id |
1608 | =item $x_display = $term->display_id |
1192 | |
1609 | |
… | |
… | |
1199 | =item $env = $term->env |
1616 | =item $env = $term->env |
1200 | |
1617 | |
1201 | Returns a copy of the environment in effect for the terminal as a hashref |
1618 | Returns a copy of the environment in effect for the terminal as a hashref |
1202 | similar to C<\%ENV>. |
1619 | similar to C<\%ENV>. |
1203 | |
1620 | |
|
|
1621 | =item @envv = $term->envv |
|
|
1622 | |
|
|
1623 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1624 | |
|
|
1625 | =item @argv = $term->argv |
|
|
1626 | |
|
|
1627 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1628 | includes the program name as first element. |
|
|
1629 | |
1204 | =cut |
1630 | =cut |
1205 | |
1631 | |
1206 | sub env { |
1632 | sub env { |
1207 | if (my $env = $_[0]->_env) { |
|
|
1208 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1633 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1209 | } else { |
|
|
1210 | +{ %ENV } |
|
|
1211 | } |
|
|
1212 | } |
1634 | } |
1213 | |
1635 | |
1214 | =item $modifiermask = $term->ModLevel3Mask |
1636 | =item $modifiermask = $term->ModLevel3Mask |
1215 | |
1637 | |
1216 | =item $modifiermask = $term->ModMetaMask |
1638 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1218 | =item $modifiermask = $term->ModNumLockMask |
1640 | =item $modifiermask = $term->ModNumLockMask |
1219 | |
1641 | |
1220 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1642 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1221 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1643 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1222 | |
1644 | |
|
|
1645 | =item $screen = $term->current_screen |
|
|
1646 | |
|
|
1647 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1648 | |
|
|
1649 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1650 | |
|
|
1651 | Returns whether the cursor is currently hidden or not. |
|
|
1652 | |
1223 | =item $view_start = $term->view_start ([$newvalue]) |
1653 | =item $view_start = $term->view_start ([$newvalue]) |
1224 | |
1654 | |
1225 | Returns the negative row number of the topmost line. Minimum value is |
1655 | Returns the row number of the topmost displayed line. Maximum value is |
1226 | C<0>, which displays the normal terminal contents. Larger values scroll |
1656 | C<0>, which displays the normal terminal contents. Lower values scroll |
1227 | this many lines into the scrollback buffer. |
1657 | this many lines into the scrollback buffer. |
1228 | |
1658 | |
1229 | =item $term->want_refresh |
1659 | =item $term->want_refresh |
1230 | |
1660 | |
1231 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1661 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1234 | |
1664 | |
1235 | Used after changing terminal contents to display them. |
1665 | Used after changing terminal contents to display them. |
1236 | |
1666 | |
1237 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1667 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1238 | |
1668 | |
1239 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1669 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1240 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1670 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1241 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1242 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1671 | terminal line. Nothing will be returned if a nonexistent line |
1243 | is requested. |
1672 | is requested. |
1244 | |
1673 | |
1245 | If C<$new_text> is specified, it will replace characters in the current |
1674 | If C<$new_text> is specified, it will replace characters in the current |
1246 | line, starting at column C<$start_col> (default C<0>), which is useful |
1675 | line, starting at column C<$start_col> (default C<0>), which is useful |
1247 | to replace only parts of a line. The font index in the rendition will |
1676 | to replace only parts of a line. The font index in the rendition will |
1248 | automatically be updated. |
1677 | automatically be updated. |
1249 | |
1678 | |
1250 | C<$text> is in a special encoding: tabs and wide characters that use more |
1679 | C<$text> is in a special encoding: tabs and wide characters that use more |
1251 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1680 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1252 | (C<chr 65535>). Characters with combining characters and other characters |
1681 | characters. Characters with combining characters and other characters that |
1253 | that do not fit into the normal tetx encoding will be replaced with |
1682 | do not fit into the normal text encoding will be replaced with characters |
1254 | characters in the private use area. |
1683 | in the private use area. |
1255 | |
1684 | |
1256 | You have to obey this encoding when changing text. The advantage is |
1685 | You have to obey this encoding when changing text. The advantage is |
1257 | that C<substr> and similar functions work on screen cells and not on |
1686 | that C<substr> and similar functions work on screen cells and not on |
1258 | characters. |
1687 | characters. |
1259 | |
1688 | |
… | |
… | |
1403 | where one character corresponds to one screen cell. See |
1832 | where one character corresponds to one screen cell. See |
1404 | C<< $term->ROW_t >> for details. |
1833 | C<< $term->ROW_t >> for details. |
1405 | |
1834 | |
1406 | =item $string = $term->special_decode $text |
1835 | =item $string = $term->special_decode $text |
1407 | |
1836 | |
1408 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1837 | Converts rxvt-unicodes text representation into a perl string. See |
1409 | C<< $term->ROW_t >> for details. |
1838 | C<< $term->ROW_t >> for details. |
1410 | |
1839 | |
1411 | =item $success = $term->grab_button ($button, $modifiermask) |
1840 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1412 | |
1841 | |
|
|
1842 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1843 | |
1413 | Registers a synchronous button grab. See the XGrabButton manpage. |
1844 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1845 | manpage. |
1414 | |
1846 | |
1415 | =item $success = $term->grab ($eventtime[, $sync]) |
1847 | =item $success = $term->grab ($eventtime[, $sync]) |
1416 | |
1848 | |
1417 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1849 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1418 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1850 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1419 | |
1851 | |
1420 | =item $term->allow_events_async |
1852 | =item $term->allow_events_async |
1421 | |
1853 | |
1422 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1854 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1423 | |
1855 | |
… | |
… | |
1433 | =item $term->ungrab |
1865 | =item $term->ungrab |
1434 | |
1866 | |
1435 | Calls XUngrab for the most recent grab. Is called automatically on |
1867 | Calls XUngrab for the most recent grab. Is called automatically on |
1436 | evaluation errors, as it is better to lose the grab in the error case as |
1868 | evaluation errors, as it is better to lose the grab in the error case as |
1437 | the session. |
1869 | the session. |
|
|
1870 | |
|
|
1871 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1872 | |
|
|
1873 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1874 | |
|
|
1875 | =item @atoms = $term->XListProperties ($window) |
|
|
1876 | |
|
|
1877 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1878 | |
|
|
1879 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
|
|
1880 | |
|
|
1881 | =item $term->XDeleteProperty ($window, $property) |
|
|
1882 | |
|
|
1883 | =item $window = $term->DefaultRootWindow |
|
|
1884 | |
|
|
1885 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1886 | |
|
|
1887 | =item $term->XMapWindow ($window) |
|
|
1888 | |
|
|
1889 | =item $term->XUnmapWindow ($window) |
|
|
1890 | |
|
|
1891 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1892 | |
|
|
1893 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1894 | |
|
|
1895 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1896 | |
|
|
1897 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1898 | the source of the display, otherwise those functions map more-or-less |
|
|
1899 | directory onto the X functions of the same name. |
1438 | |
1900 | |
1439 | =back |
1901 | =back |
1440 | |
1902 | |
1441 | =cut |
1903 | =cut |
1442 | |
1904 | |
… | |
… | |
1506 | my ($self, $text, $cb) = @_; |
1968 | my ($self, $text, $cb) = @_; |
1507 | |
1969 | |
1508 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1970 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1509 | } |
1971 | } |
1510 | |
1972 | |
1511 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1973 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1512 | |
1974 | |
1513 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1975 | Adds a toggle/checkbox item to the popup. The callback gets called |
1514 | whenever it gets toggled, with a boolean indicating its value as its first |
1976 | whenever it gets toggled, with a boolean indicating its new value as its |
1515 | argument. |
1977 | first argument. |
1516 | |
1978 | |
1517 | =cut |
1979 | =cut |
1518 | |
1980 | |
1519 | sub add_toggle { |
1981 | sub add_toggle { |
1520 | my ($self, $text, $cb, $value) = @_; |
1982 | my ($self, $text, $value, $cb) = @_; |
1521 | |
1983 | |
1522 | my $item; $item = { |
1984 | my $item; $item = { |
1523 | type => "button", |
1985 | type => "button", |
1524 | text => " $text", |
1986 | text => " $text", |
1525 | value => $value, |
1987 | value => $value, |
… | |
… | |
1544 | my $env = $self->{term}->env; |
2006 | my $env = $self->{term}->env; |
1545 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
2007 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1546 | delete $env->{LC_ALL}; |
2008 | delete $env->{LC_ALL}; |
1547 | $env->{LC_CTYPE} = $self->{term}->locale; |
2009 | $env->{LC_CTYPE} = $self->{term}->locale; |
1548 | |
2010 | |
1549 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
2011 | my $term = urxvt::term->new ( |
1550 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
2012 | $env, "popup", |
|
|
2013 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
2014 | "-pty-fd" => -1, "-sl" => 0, |
|
|
2015 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1551 | "--transient-for" => $self->{term}->parent, |
2016 | "--transient-for" => $self->{term}->parent, |
1552 | "-display" => $self->{term}->display_id, |
2017 | "-display" => $self->{term}->display_id, |
1553 | "-pe" => "urxvt-popup") |
2018 | "-pe" => "urxvt-popup", |
1554 | or die "unable to create popup window\n"; |
2019 | ) or die "unable to create popup window\n"; |
|
|
2020 | |
|
|
2021 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
2022 | $term->ungrab; |
|
|
2023 | $term->destroy; |
|
|
2024 | die "unable to initialise popup window\n"; |
|
|
2025 | } |
1555 | } |
2026 | } |
1556 | |
2027 | |
1557 | sub DESTROY { |
2028 | sub DESTROY { |
1558 | my ($self) = @_; |
2029 | my ($self) = @_; |
1559 | |
2030 | |
1560 | delete $self->{term}{_destroy}{$self}; |
2031 | delete $self->{term}{_destroy}{$self}; |
1561 | $self->{term}->ungrab; |
2032 | $self->{term}->ungrab; |
1562 | } |
2033 | } |
1563 | |
2034 | |
1564 | =back |
2035 | =back |
|
|
2036 | |
|
|
2037 | =cut |
|
|
2038 | |
|
|
2039 | package urxvt::watcher; |
1565 | |
2040 | |
1566 | =head2 The C<urxvt::timer> Class |
2041 | =head2 The C<urxvt::timer> Class |
1567 | |
2042 | |
1568 | This class implements timer watchers/events. Time is represented as a |
2043 | This class implements timer watchers/events. Time is represented as a |
1569 | fractional number of seconds since the epoch. Example: |
2044 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1573 | ->new |
2048 | ->new |
1574 | ->interval (1) |
2049 | ->interval (1) |
1575 | ->cb (sub { |
2050 | ->cb (sub { |
1576 | $term->{overlay}->set (0, 0, |
2051 | $term->{overlay}->set (0, 0, |
1577 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2052 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1578 | }); |
2053 | }); |
1579 | |
2054 | |
1580 | =over 4 |
2055 | =over 4 |
1581 | |
2056 | |
1582 | =item $timer = new urxvt::timer |
2057 | =item $timer = new urxvt::timer |
1583 | |
2058 | |
… | |
… | |
1607 | Start the timer. |
2082 | Start the timer. |
1608 | |
2083 | |
1609 | =item $timer = $timer->start ($tstamp) |
2084 | =item $timer = $timer->start ($tstamp) |
1610 | |
2085 | |
1611 | Set the event trigger time to C<$tstamp> and start the timer. |
2086 | Set the event trigger time to C<$tstamp> and start the timer. |
|
|
2087 | |
|
|
2088 | =item $timer = $timer->after ($delay) |
|
|
2089 | |
|
|
2090 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1612 | |
2091 | |
1613 | =item $timer = $timer->stop |
2092 | =item $timer = $timer->stop |
1614 | |
2093 | |
1615 | Stop the timer. |
2094 | Stop the timer. |
1616 | |
2095 | |
… | |
… | |
1622 | |
2101 | |
1623 | $term->{socket} = ... |
2102 | $term->{socket} = ... |
1624 | $term->{iow} = urxvt::iow |
2103 | $term->{iow} = urxvt::iow |
1625 | ->new |
2104 | ->new |
1626 | ->fd (fileno $term->{socket}) |
2105 | ->fd (fileno $term->{socket}) |
1627 | ->events (urxvt::EVENT_READ) |
2106 | ->events (urxvt::EV_READ) |
1628 | ->start |
2107 | ->start |
1629 | ->cb (sub { |
2108 | ->cb (sub { |
1630 | my ($iow, $revents) = @_; |
2109 | my ($iow, $revents) = @_; |
1631 | # $revents must be 1 here, no need to check |
2110 | # $revents must be 1 here, no need to check |
1632 | sysread $term->{socket}, my $buf, 8192 |
2111 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1645 | Set the callback to be called when io events are triggered. C<$reventmask> |
2124 | Set the callback to be called when io events are triggered. C<$reventmask> |
1646 | is a bitset as described in the C<events> method. |
2125 | is a bitset as described in the C<events> method. |
1647 | |
2126 | |
1648 | =item $iow = $iow->fd ($fd) |
2127 | =item $iow = $iow->fd ($fd) |
1649 | |
2128 | |
1650 | Set the filedescriptor (not handle) to watch. |
2129 | Set the file descriptor (not handle) to watch. |
1651 | |
2130 | |
1652 | =item $iow = $iow->events ($eventmask) |
2131 | =item $iow = $iow->events ($eventmask) |
1653 | |
2132 | |
1654 | Set the event mask to watch. The only allowed values are |
2133 | Set the event mask to watch. The only allowed values are |
1655 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2134 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
1656 | together, or C<urxvt::EVENT_NONE>. |
2135 | together, or C<urxvt::EV_NONE>. |
1657 | |
2136 | |
1658 | =item $iow = $iow->start |
2137 | =item $iow = $iow->start |
1659 | |
2138 | |
1660 | Start watching for requested events on the given handle. |
2139 | Start watching for requested events on the given handle. |
1661 | |
2140 | |
1662 | =item $iow = $iow->stop |
2141 | =item $iow = $iow->stop |
1663 | |
2142 | |
1664 | Stop watching for events on the given filehandle. |
2143 | Stop watching for events on the given file handle. |
|
|
2144 | |
|
|
2145 | =back |
|
|
2146 | |
|
|
2147 | =head2 The C<urxvt::iw> Class |
|
|
2148 | |
|
|
2149 | This class implements idle watchers, that get called automatically when |
|
|
2150 | the process is idle. They should return as fast as possible, after doing |
|
|
2151 | some useful work. |
|
|
2152 | |
|
|
2153 | =over 4 |
|
|
2154 | |
|
|
2155 | =item $iw = new urxvt::iw |
|
|
2156 | |
|
|
2157 | Create a new idle watcher object in stopped state. |
|
|
2158 | |
|
|
2159 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
2160 | |
|
|
2161 | Set the callback to be called when the watcher triggers. |
|
|
2162 | |
|
|
2163 | =item $timer = $timer->start |
|
|
2164 | |
|
|
2165 | Start the watcher. |
|
|
2166 | |
|
|
2167 | =item $timer = $timer->stop |
|
|
2168 | |
|
|
2169 | Stop the watcher. |
|
|
2170 | |
|
|
2171 | =back |
|
|
2172 | |
|
|
2173 | =head2 The C<urxvt::pw> Class |
|
|
2174 | |
|
|
2175 | This class implements process watchers. They create an event whenever a |
|
|
2176 | process exits, after which they stop automatically. |
|
|
2177 | |
|
|
2178 | my $pid = fork; |
|
|
2179 | ... |
|
|
2180 | $term->{pw} = urxvt::pw |
|
|
2181 | ->new |
|
|
2182 | ->start ($pid) |
|
|
2183 | ->cb (sub { |
|
|
2184 | my ($pw, $exit_status) = @_; |
|
|
2185 | ... |
|
|
2186 | }); |
|
|
2187 | |
|
|
2188 | =over 4 |
|
|
2189 | |
|
|
2190 | =item $pw = new urxvt::pw |
|
|
2191 | |
|
|
2192 | Create a new process watcher in stopped state. |
|
|
2193 | |
|
|
2194 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
2195 | |
|
|
2196 | Set the callback to be called when the timer triggers. |
|
|
2197 | |
|
|
2198 | =item $pw = $timer->start ($pid) |
|
|
2199 | |
|
|
2200 | Tells the watcher to start watching for process C<$pid>. |
|
|
2201 | |
|
|
2202 | =item $pw = $pw->stop |
|
|
2203 | |
|
|
2204 | Stop the watcher. |
1665 | |
2205 | |
1666 | =back |
2206 | =back |
1667 | |
2207 | |
1668 | =head1 ENVIRONMENT |
2208 | =head1 ENVIRONMENT |
1669 | |
2209 | |
… | |
… | |
1678 | |
2218 | |
1679 | =item >= 3 - script loading and management |
2219 | =item >= 3 - script loading and management |
1680 | |
2220 | |
1681 | =item >=10 - all called hooks |
2221 | =item >=10 - all called hooks |
1682 | |
2222 | |
1683 | =item >=11 - hook reutrn values |
2223 | =item >=11 - hook return values |
1684 | |
2224 | |
1685 | =back |
2225 | =back |
1686 | |
2226 | |
1687 | =head1 AUTHOR |
2227 | =head1 AUTHOR |
1688 | |
2228 | |
… | |
… | |
1690 | http://software.schmorp.de/pkg/rxvt-unicode |
2230 | http://software.schmorp.de/pkg/rxvt-unicode |
1691 | |
2231 | |
1692 | =cut |
2232 | =cut |
1693 | |
2233 | |
1694 | 1 |
2234 | 1 |
|
|
2235 | |
|
|
2236 | # vim: sw=3: |