… | |
… | |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Everytime a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
30 | |
30 | |
|
|
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
|
|
32 | and "perl-ext-common" resources to the empty string. |
|
|
33 | |
31 | =head1 PREPACKAGED EXTENSIONS |
34 | =head1 PREPACKAGED EXTENSIONS |
32 | |
35 | |
33 | This section describes the extensions delivered with this release. You can |
36 | This section describes the extensions delivered with this release. You can |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
37 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
35 | |
38 | |
… | |
… | |
37 | |
40 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
41 | @@RXVT_NAME@@ -pe <extensionname> |
39 | |
42 | |
40 | Or by adding them to the resource for extensions loaded by default: |
43 | Or by adding them to the resource for extensions loaded by default: |
41 | |
44 | |
42 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
45 | URxvt.perl-ext-common: default,selection-autotransform |
43 | |
46 | |
44 | =over 4 |
47 | =over 4 |
45 | |
48 | |
46 | =item selection (enabled by default) |
49 | =item selection (enabled by default) |
47 | |
50 | |
… | |
… | |
62 | URxvt.selection.pattern-1: perl-regex |
65 | URxvt.selection.pattern-1: perl-regex |
63 | ... |
66 | ... |
64 | |
67 | |
65 | The index number (0, 1...) must not have any holes, and each regex must |
68 | The index number (0, 1...) must not have any holes, and each regex must |
66 | contain at least one pair of capturing parentheses, which will be used for |
69 | contain at least one pair of capturing parentheses, which will be used for |
67 | the match. For example, the followign adds a regex that matches everything |
70 | the match. For example, the following adds a regex that matches everything |
68 | between two vertical bars: |
71 | between two vertical bars: |
69 | |
72 | |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
73 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
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: ^(/[^:]+):\ |
71 | |
81 | |
72 | 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 |
73 | interesting uses, such as parsing a line from beginning to end. |
83 | interesting uses, such as parsing a line from beginning to end. |
74 | |
84 | |
75 | This extension also offers following bindable keyboard commands: |
85 | This extension also offers following bindable keyboard commands: |
… | |
… | |
86 | |
96 | |
87 | =item option-popup (enabled by default) |
97 | =item option-popup (enabled by default) |
88 | |
98 | |
89 | 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 |
90 | runtime. |
100 | runtime. |
|
|
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 | }; |
91 | |
118 | |
92 | =item selection-popup (enabled by default) |
119 | =item selection-popup (enabled by default) |
93 | |
120 | |
94 | 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 |
95 | text into various other formats/action (such as uri unescaping, perl |
122 | text into various other formats/action (such as uri unescaping, perl |
96 | evaluation, web-browser starting etc.), depending on content. |
123 | evaluation, web-browser starting etc.), depending on content. |
97 | |
124 | |
98 | Other extensions can extend this popup menu by pushing a code reference |
125 | Other extensions can extend this popup menu by pushing a code reference |
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
100 | popup is displayed. |
127 | popup is being displayed. |
101 | |
128 | |
102 | It's sole argument is the popup menu, which can be modified. The selection |
129 | Its sole argument is the popup menu, which can be modified. The selection |
103 | is in C<$_>, which can be used to decide wether to add something or not. |
130 | is in C<$_>, which can be used to decide whether to add something or not. |
104 | It should either return nothing or a string and a code reference. The |
131 | It should either return nothing or a string and a code reference. The |
105 | string will be used as button text and the code reference will be called |
132 | string will be used as button text and the code reference will be called |
106 | when the button gets activated and should transform C<$_>. |
133 | when the button gets activated and should transform C<$_>. |
107 | |
134 | |
108 | The following will add an entry C<a to b> that transforms all C<a>s in |
135 | The following will add an entry C<a to b> that transforms all C<a>s in |
109 | the selection to C<b>s, but only if the selection currently contains any |
136 | the selection to C<b>s, but only if the selection currently contains any |
110 | C<a>s: |
137 | C<a>s: |
111 | |
138 | |
112 | push @{ $self->{term}{selection_popup_hook} }, sub { |
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
113 | /a/ ? ("a to be" => sub { s/a/b/g } |
140 | /a/ ? ("a to b" => sub { s/a/b/g } |
114 | : () |
141 | : () |
115 | }; |
142 | }; |
116 | |
143 | |
117 | =item searchable-scrollback<hotkey> (enabled by default) |
144 | =item searchable-scrollback<hotkey> (enabled by default) |
118 | |
145 | |
… | |
… | |
125 | 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> |
126 | 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 |
127 | 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 |
128 | 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 |
129 | 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 |
130 | 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. |
131 | |
189 | |
132 | =item selection-autotransform |
190 | =item selection-autotransform |
133 | |
191 | |
134 | This selection allows you to do automatic transforms on a selection |
192 | This selection allows you to do automatic transforms on a selection |
135 | whenever a selection is made. |
193 | whenever a selection is made. |
… | |
… | |
162 | |
220 | |
163 | 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 |
164 | 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 |
165 | the message into vi commands to load the file. |
223 | the message into vi commands to load the file. |
166 | |
224 | |
167 | =item readline |
|
|
168 | |
|
|
169 | A support package that tries to make editing with readline easier. At the |
|
|
170 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
171 | move the text cursor to this position. It does so by generating as many |
|
|
172 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
173 | for programs that correctly support wide characters). |
|
|
174 | |
|
|
175 | It only works when clicking into the same line (possibly extended over |
|
|
176 | multiple rows) as the text cursor and on the primary screen, to reduce the |
|
|
177 | risk of misinterpreting. The normal selection isn't disabled, so quick |
|
|
178 | successive clicks might interfere with selection creation in harmless |
|
|
179 | ways. |
|
|
180 | |
|
|
181 | =item tabbed |
225 | =item tabbed |
182 | |
226 | |
183 | This transforms the terminal into a tabbar with additional terminals, that |
227 | This transforms the terminal into a tabbar with additional terminals, that |
184 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
228 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
185 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
229 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
186 | button per tab. |
230 | button per tab. |
187 | |
231 | |
188 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
232 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
189 | B<Shift-Right> will switch to the tab left or right of the current one, |
233 | B<Shift-Right> will switch to the tab left or right of the current one, |
190 | while B<Shift-Down> creates a new tab. |
234 | while B<Shift-Down> creates a new tab. |
191 | |
235 | |
192 | =item mark-urls |
236 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
237 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
238 | following four resources (shown with defaults): |
193 | |
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 | |
194 | 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 |
195 | make them clickable. When middle-clicked, the program specified in the |
251 | matching a certain pattern and make it clickable. When clicked with the |
196 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
252 | mouse button specified in the C<matcher.button> resource (default 2, or |
197 | 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. |
198 | |
258 | |
199 | =item automove-background |
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. |
200 | |
263 | |
201 | This is basically a one-line extension that dynamically changes the background pixmap offset |
264 | It is possible to activate the most recently seen match from the keyboard. |
202 | to the window position, in effect creating the same effect as pseudo transparency with |
265 | Simply bind a keysym to "perl:matcher" as seen in the example below. |
203 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
204 | |
266 | |
205 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
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. |
206 | |
313 | |
207 | =item block-graphics-to-ascii |
314 | =item block-graphics-to-ascii |
208 | |
315 | |
209 | 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 |
210 | 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 |
211 | similar-looking ascii character. |
318 | similar-looking ascii character. |
212 | |
319 | |
213 | =item digital-clock |
320 | =item digital-clock |
214 | |
321 | |
215 | Displays a digital clock using the built-in overlay. |
322 | Displays a digital clock using the built-in overlay. |
216 | |
323 | |
217 | =item example-refresh-hooks |
324 | =item remote-clipboard |
218 | |
325 | |
219 | Displays a very simple digital clock in the upper right corner of the |
326 | Somewhat of a misnomer, this extension adds two menu entries to the |
220 | window. Illustrates overwriting the refresh callbacks to create your own |
327 | selection popup that allows one to run external commands to store the |
221 | overlays or changes. |
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' |
222 | |
343 | |
223 | =item selection-pastebin |
344 | =item selection-pastebin |
224 | |
345 | |
225 | This is a little rarely useful extension that Uploads the selection as |
346 | This is a little rarely useful extension that Uploads the selection as |
226 | textfile to a remote site (or does other things). (The implementation is |
347 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
246 | After a successful upload the selection will be replaced by the text given |
367 | After a successful upload the selection will be replaced by the text given |
247 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
368 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
248 | for the filename): |
369 | for the filename): |
249 | |
370 | |
250 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
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. |
|
|
391 | |
|
|
392 | =item example-refresh-hooks |
|
|
393 | |
|
|
394 | Displays a very simple digital clock in the upper right corner of the |
|
|
395 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
396 | overlays or changes. |
251 | |
397 | |
252 | =back |
398 | =back |
253 | |
399 | |
254 | =head1 API DOCUMENTATION |
400 | =head1 API DOCUMENTATION |
255 | |
401 | |
… | |
… | |
289 | |
435 | |
290 | =back |
436 | =back |
291 | |
437 | |
292 | =head2 Extension Objects |
438 | =head2 Extension Objects |
293 | |
439 | |
294 | 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 |
295 | 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, |
296 | 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 |
297 | 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 |
298 | begin with an underscore character C<_>: these are reserved for internal |
445 | that begin with an underscore character C<_>: these are reserved for |
299 | use. |
446 | internal use. |
300 | |
447 | |
301 | 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 |
302 | C<urxvt::term> class on this object. |
449 | C<urxvt::term> class on this object. |
303 | |
450 | |
304 | It has the following methods and data members: |
451 | It has the following methods and data members: |
… | |
… | |
325 | =head2 Hooks |
472 | =head2 Hooks |
326 | |
473 | |
327 | 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 |
328 | called whenever the relevant event happens. |
475 | called whenever the relevant event happens. |
329 | |
476 | |
330 | 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 |
331 | the in the C<Extension Objects> section. |
478 | the in the C<Extension Objects> section. |
332 | |
479 | |
333 | B<All> of these hooks must return a boolean value. If any of the called |
480 | B<All> of these hooks must return a boolean value. If any of the called |
334 | hooks returns true, then the event counts as being I<consumed>, and the |
481 | hooks returns true, then the event counts as being I<consumed>, and the |
335 | relevant action might not be carried out by the C++ code. |
482 | relevant action might not be carried out by the C++ code. |
… | |
… | |
348 | place. |
495 | place. |
349 | |
496 | |
350 | =item on_start $term |
497 | =item on_start $term |
351 | |
498 | |
352 | Called at the very end of initialisation of a new terminal, just before |
499 | Called at the very end of initialisation of a new terminal, just before |
353 | trying to map (display) the toplevel and returning to the mainloop. |
500 | trying to map (display) the toplevel and returning to the main loop. |
354 | |
501 | |
355 | =item on_destroy $term |
502 | =item on_destroy $term |
356 | |
503 | |
357 | Called whenever something tries to destroy terminal, before doing anything |
504 | Called whenever something tries to destroy terminal, when the terminal is |
358 | yet. If this hook returns true, then destruction is skipped, but this is |
505 | still fully functional (not for long, though). |
359 | rarely a good idea. |
|
|
360 | |
506 | |
361 | =item on_reset $term |
507 | =item on_reset $term |
362 | |
508 | |
363 | 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 |
364 | 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 |
… | |
… | |
386 | |
532 | |
387 | 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 |
388 | 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 |
389 | by calling C<< $term->selection >>. |
535 | by calling C<< $term->selection >>. |
390 | |
536 | |
391 | 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. |
392 | |
538 | |
393 | =item on_sel_extend $term |
539 | =item on_sel_extend $term |
394 | |
540 | |
395 | 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 |
396 | click) and is either supposed to return false (normal operation), or |
542 | click) and is either supposed to return false (normal operation), or |
397 | should extend the selection itelf and return true to suppress the built-in |
543 | should extend the selection itself and return true to suppress the built-in |
398 | processing. This can happen multiple times, as long as the callback |
544 | processing. This can happen multiple times, as long as the callback |
399 | returns true, it will be called on every further click by the user and is |
545 | returns true, it will be called on every further click by the user and is |
400 | supposed to enlarge the selection more and more, if possible. |
546 | supposed to enlarge the selection more and more, if possible. |
401 | |
547 | |
402 | See the F<selection> example extension. |
548 | See the F<selection> example extension. |
403 | |
549 | |
404 | =item on_view_change $term, $offset |
550 | =item on_view_change $term, $offset |
405 | |
551 | |
406 | 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 |
407 | scrolls. Offset C<0> means display the normal terminal, positive values |
553 | scrolls. Offset C<0> means display the normal terminal, positive values |
408 | show this many lines of scrollback. |
554 | show this many lines of scrollback. |
409 | |
555 | |
410 | =item on_scroll_back $term, $lines, $saved |
556 | =item on_scroll_back $term, $lines, $saved |
411 | |
557 | |
… | |
… | |
415 | |
561 | |
416 | 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, |
417 | $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 |
418 | number of lines that will be in the scrollback buffer. |
564 | number of lines that will be in the scrollback buffer. |
419 | |
565 | |
420 | =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 |
421 | |
577 | |
422 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
578 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
423 | operating system command) is processed. Cursor position and other state |
579 | operating system command) is processed. Cursor position and other state |
424 | information is up-to-date when this happens. For interoperability, the |
580 | information is up-to-date when this happens. For interoperability, the |
425 | 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, |
426 | 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 |
427 | 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 | } |
428 | |
594 | |
429 | 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, |
430 | 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 |
431 | 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. |
432 | |
601 | |
433 | =item on_add_lines $term, $string |
602 | =item on_add_lines $term, $string |
434 | |
603 | |
435 | 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 |
436 | 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 |
… | |
… | |
457 | 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 |
458 | you cannot just toggle rendition bits, but only set them. |
627 | you cannot just toggle rendition bits, but only set them. |
459 | |
628 | |
460 | =item on_refresh_begin $term |
629 | =item on_refresh_begin $term |
461 | |
630 | |
462 | 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 |
463 | or similar effects by modify terminal contents in refresh_begin, and |
632 | similar effects by modifying the terminal contents in refresh_begin, and |
464 | 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 |
465 | code is run after this hook, and takes precedence. |
634 | code is run after this hook, and takes precedence. |
466 | |
635 | |
467 | =item on_refresh_end $term |
636 | =item on_refresh_end $term |
468 | |
637 | |
469 | 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>. |
470 | |
639 | |
471 | =item on_keyboard_command $term, $string |
640 | =item on_user_command $term, $string |
472 | |
641 | |
473 | Called whenever the user presses a key combination that has a |
642 | Called whenever a user-configured event is being activated (e.g. via |
474 | C<perl:string> action bound to it (see description of the B<keysym> |
643 | a C<perl:string> action bound to a key, see description of the B<keysym> |
475 | 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. |
476 | |
654 | |
477 | =item on_x_event $term, $event |
655 | =item on_x_event $term, $event |
478 | |
656 | |
479 | 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 |
480 | 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 |
481 | members are not passed. |
659 | members are not passed. |
482 | |
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 | |
483 | =item on_focus_in $term |
665 | =item on_focus_in $term |
484 | |
666 | |
485 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
667 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
486 | does focus in processing. |
668 | does focus in processing. |
487 | |
669 | |
488 | =item on_focus_out $term |
670 | =item on_focus_out $term |
489 | |
671 | |
490 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
672 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
491 | focus out processing. |
673 | focus out processing. |
492 | |
674 | |
493 | =item on_configure_notify $term, $event |
675 | =item on_configure_notify $term, $event |
494 | |
676 | |
495 | =item on_property_notify $term, $event |
677 | =item on_property_notify $term, $event |
… | |
… | |
552 | our $LIBDIR; |
734 | our $LIBDIR; |
553 | our $RESNAME; |
735 | our $RESNAME; |
554 | our $RESCLASS; |
736 | our $RESCLASS; |
555 | our $RXVTNAME; |
737 | our $RXVTNAME; |
556 | |
738 | |
557 | our $NOCHAR = chr 0xfffe; |
739 | our $NOCHAR = chr 0xffff; |
558 | |
740 | |
559 | =head2 Variables in the C<urxvt> Package |
741 | =head2 Variables in the C<urxvt> Package |
560 | |
742 | |
561 | =over 4 |
743 | =over 4 |
562 | |
744 | |
… | |
… | |
578 | The current terminal. This variable stores the current C<urxvt::term> |
760 | The current terminal. This variable stores the current C<urxvt::term> |
579 | object, whenever a callback/hook is executing. |
761 | object, whenever a callback/hook is executing. |
580 | |
762 | |
581 | =item @urxvt::TERM_INIT |
763 | =item @urxvt::TERM_INIT |
582 | |
764 | |
583 | All coderefs in this array will be called as methods of the next newly |
765 | All code references in this array will be called as methods of the next newly |
584 | created C<urxvt::term> object (during the C<on_init> phase). The array |
766 | created C<urxvt::term> object (during the C<on_init> phase). The array |
585 | gets cleared before the codereferences that were in it are being executed, |
767 | gets cleared before the code references that were in it are being executed, |
586 | so coderefs can push themselves onto it again if they so desire. |
768 | so references can push themselves onto it again if they so desire. |
587 | |
769 | |
588 | This complements to the perl-eval commandline option, but gets executed |
770 | This complements to the perl-eval command line option, but gets executed |
589 | first. |
771 | first. |
590 | |
772 | |
591 | =item @urxvt::TERM_EXT |
773 | =item @urxvt::TERM_EXT |
592 | |
774 | |
593 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
775 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
614 | |
796 | |
615 | 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 |
616 | correct place, e.g. on stderr of the connecting urxvtc client. |
798 | correct place, e.g. on stderr of the connecting urxvtc client. |
617 | |
799 | |
618 | Messages have a size limit of 1023 bytes currently. |
800 | Messages have a size limit of 1023 bytes currently. |
|
|
801 | |
|
|
802 | =item @terms = urxvt::termlist |
|
|
803 | |
|
|
804 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
805 | whether they are started, being destroyed etc., so be careful. Only term |
|
|
806 | objects that have perl extensions attached will be returned (because there |
|
|
807 | is no urxvt::term objet associated with others). |
619 | |
808 | |
620 | =item $time = urxvt::NOW |
809 | =item $time = urxvt::NOW |
621 | |
810 | |
622 | Returns the "current time" (as per the event loop). |
811 | Returns the "current time" (as per the event loop). |
623 | |
812 | |
… | |
… | |
681 | Return the foreground/background colour index, respectively. |
870 | Return the foreground/background colour index, respectively. |
682 | |
871 | |
683 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
872 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
684 | |
873 | |
685 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
874 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
875 | |
|
|
876 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
686 | |
877 | |
687 | Replace the foreground/background colour in the rendition mask with the |
878 | Replace the foreground/background colour in the rendition mask with the |
688 | specified one. |
879 | specified one. |
689 | |
880 | |
690 | =item $value = urxvt::GET_CUSTOM $rend |
881 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
709 | unless $msg =~ /\n$/; |
900 | unless $msg =~ /\n$/; |
710 | urxvt::warn ($msg); |
901 | urxvt::warn ($msg); |
711 | }; |
902 | }; |
712 | } |
903 | } |
713 | |
904 | |
|
|
905 | no warnings 'utf8'; |
|
|
906 | |
714 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
907 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
715 | |
908 | |
716 | sub verbose { |
909 | sub verbose { |
717 | my ($level, $msg) = @_; |
910 | my ($level, $msg) = @_; |
718 | warn "$msg\n" if $level <= $verbosity; |
911 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
734 | |
927 | |
735 | open my $fh, "<:raw", $path |
928 | open my $fh, "<:raw", $path |
736 | or die "$path: $!"; |
929 | or die "$path: $!"; |
737 | |
930 | |
738 | my $source = |
931 | my $source = |
739 | "package $pkg; use strict; use utf8;\n" |
932 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
740 | . "#line 1 \"$path\"\n{\n" |
933 | . "#line 1 \"$path\"\n{\n" |
741 | . (do { local $/; <$fh> }) |
934 | . (do { local $/; <$fh> }) |
742 | . "\n};\n1"; |
935 | . "\n};\n1"; |
743 | |
936 | |
744 | eval $source |
937 | eval $source |
… | |
… | |
755 | local $TERM = shift; |
948 | local $TERM = shift; |
756 | my $htype = shift; |
949 | my $htype = shift; |
757 | |
950 | |
758 | if ($htype == 0) { # INIT |
951 | if ($htype == 0) { # INIT |
759 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
952 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
760 | |
953 | |
761 | my %ext_arg; |
954 | my %ext_arg; |
762 | |
955 | |
763 | { |
956 | { |
764 | my @init = @TERM_INIT; |
957 | my @init = @TERM_INIT; |
765 | @TERM_INIT = (); |
958 | @TERM_INIT = (); |
… | |
… | |
769 | $TERM->register_package ($_) for @pkg; |
962 | $TERM->register_package ($_) for @pkg; |
770 | } |
963 | } |
771 | |
964 | |
772 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
965 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
773 | if ($_ eq "default") { |
966 | if ($_ eq "default") { |
774 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
967 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
775 | } elsif (/^-(.*)$/) { |
968 | } elsif (/^-(.*)$/) { |
776 | delete $ext_arg{$1}; |
969 | delete $ext_arg{$1}; |
777 | } elsif (/^([^<]+)<(.*)>$/) { |
970 | } elsif (/^([^<]+)<(.*)>$/) { |
778 | push @{ $ext_arg{$1} }, $2; |
971 | push @{ $ext_arg{$1} }, $2; |
779 | } else { |
972 | } else { |
780 | $ext_arg{$_} ||= []; |
973 | $ext_arg{$_} ||= []; |
781 | } |
974 | } |
782 | } |
975 | } |
783 | |
976 | |
784 | while (my ($ext, $argv) = each %ext_arg) { |
977 | for my $ext (sort keys %ext_arg) { |
785 | my @files = grep -f $_, map "$_/$ext", @dirs; |
978 | my @files = grep -f $_, map "$_/$ext", @dirs; |
786 | |
979 | |
787 | if (@files) { |
980 | if (@files) { |
788 | $TERM->register_package (extension_package $files[0], $argv); |
981 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
789 | } else { |
982 | } else { |
790 | 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"; |
791 | } |
984 | } |
792 | } |
985 | } |
793 | |
986 | |
… | |
… | |
799 | |
992 | |
800 | if (my $cb = $TERM->{_hook}[$htype]) { |
993 | if (my $cb = $TERM->{_hook}[$htype]) { |
801 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
994 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
802 | if $verbosity >= 10; |
995 | if $verbosity >= 10; |
803 | |
996 | |
804 | keys %$cb; |
997 | for my $pkg (keys %$cb) { |
805 | |
|
|
806 | while (my ($pkg, $cb) = each %$cb) { |
|
|
807 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
998 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
808 | $retval ||= $retval_; |
999 | $retval ||= $retval_; |
809 | |
1000 | |
810 | if ($@) { |
1001 | if ($@) { |
811 | $TERM->ungrab; # better to lose the grab than the session |
1002 | $TERM->ungrab; # better to lose the grab than the session |
812 | warn $@; |
1003 | warn $@; |
… | |
… | |
824 | # clear package |
1015 | # clear package |
825 | %$TERM = (); |
1016 | %$TERM = (); |
826 | } |
1017 | } |
827 | |
1018 | |
828 | $retval |
1019 | $retval |
|
|
1020 | } |
|
|
1021 | |
|
|
1022 | sub SET_COLOR($$$) { |
|
|
1023 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
1024 | } |
|
|
1025 | |
|
|
1026 | sub rend2mask { |
|
|
1027 | no strict 'refs'; |
|
|
1028 | my ($str, $mask) = (@_, 0); |
|
|
1029 | my %color = ( fg => undef, bg => undef ); |
|
|
1030 | my @failed; |
|
|
1031 | for my $spec ( split /\s+/, $str ) { |
|
|
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) |
829 | } |
1049 | } |
830 | |
1050 | |
831 | # urxvt::term::extension |
1051 | # urxvt::term::extension |
832 | |
1052 | |
833 | package urxvt::term::extension; |
1053 | package urxvt::term::extension; |
… | |
… | |
904 | 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 |
905 | work. |
1125 | work. |
906 | |
1126 | |
907 | =cut |
1127 | =cut |
908 | |
1128 | |
909 | our $VERSION = 1; |
1129 | our $VERSION = '5.23'; |
910 | |
1130 | |
911 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1131 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
912 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1132 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
913 | |
1133 | |
914 | sub timer { |
1134 | sub timer { |
… | |
… | |
916 | |
1136 | |
917 | my $cb = $arg{cb}; |
1137 | my $cb = $arg{cb}; |
918 | |
1138 | |
919 | urxvt::timer |
1139 | urxvt::timer |
920 | ->new |
1140 | ->new |
921 | ->start (urxvt::NOW + $arg{after}) |
1141 | ->after ($arg{after}, $arg{interval}) |
922 | ->cb (sub { |
1142 | ->cb ($arg{interval} ? $cb : sub { |
923 | $_[0]->stop; # need to cancel manually |
1143 | $_[0]->stop; # need to cancel manually |
924 | $cb->(); |
1144 | $cb->(); |
925 | }) |
1145 | }) |
926 | } |
1146 | } |
927 | |
1147 | |
928 | sub io { |
1148 | sub io { |
929 | my ($class, %arg) = @_; |
1149 | my ($class, %arg) = @_; |
930 | |
1150 | |
931 | my $cb = $arg{cb}; |
1151 | my $cb = $arg{cb}; |
|
|
1152 | my $fd = fileno $arg{fh}; |
|
|
1153 | defined $fd or $fd = $arg{fh}; |
932 | |
1154 | |
933 | bless [$arg{fh}, urxvt::iow |
1155 | bless [$arg{fh}, urxvt::iow |
934 | ->new |
1156 | ->new |
935 | ->fd (fileno $arg{fh}) |
1157 | ->fd ($fd) |
936 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1158 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
937 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1159 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
938 | ->start |
1160 | ->start |
939 | ->cb (sub { |
1161 | ->cb ($cb) |
940 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
941 | . ($_[1] & 2 ? 'w' : '')); |
|
|
942 | })], |
|
|
943 | urxvt::anyevent:: |
1162 | ], urxvt::anyevent:: |
|
|
1163 | } |
|
|
1164 | |
|
|
1165 | sub idle { |
|
|
1166 | my ($class, %arg) = @_; |
|
|
1167 | |
|
|
1168 | my $cb = $arg{cb}; |
|
|
1169 | |
|
|
1170 | urxvt::iw |
|
|
1171 | ->new |
|
|
1172 | ->start |
|
|
1173 | ->cb ($cb) |
|
|
1174 | } |
|
|
1175 | |
|
|
1176 | sub child { |
|
|
1177 | my ($class, %arg) = @_; |
|
|
1178 | |
|
|
1179 | my $cb = $arg{cb}; |
|
|
1180 | |
|
|
1181 | urxvt::pw |
|
|
1182 | ->new |
|
|
1183 | ->start ($arg{pid}) |
|
|
1184 | ->cb (sub { |
|
|
1185 | $_[0]->stop; # need to cancel manually |
|
|
1186 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1187 | }) |
944 | } |
1188 | } |
945 | |
1189 | |
946 | sub DESTROY { |
1190 | sub DESTROY { |
947 | $_[0][1]->stop; |
1191 | $_[0][1]->stop; |
948 | } |
1192 | } |
949 | |
1193 | |
950 | sub condvar { |
1194 | sub one_event { |
951 | bless \my $flag, urxvt::anyevent::condvar:: |
|
|
952 | } |
|
|
953 | |
|
|
954 | sub urxvt::anyevent::condvar::broadcast { |
|
|
955 | ${$_[0]}++; |
|
|
956 | } |
|
|
957 | |
|
|
958 | sub urxvt::anyevent::condvar::wait { |
|
|
959 | unless (${$_[0]}) { |
|
|
960 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1195 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
961 | } |
|
|
962 | } |
1196 | } |
963 | |
1197 | |
964 | package urxvt::term; |
1198 | package urxvt::term; |
965 | |
1199 | |
966 | =head2 The C<urxvt::term> Class |
1200 | =head2 The C<urxvt::term> Class |
… | |
… | |
1002 | hash which defines the environment of the new terminal. |
1236 | hash which defines the environment of the new terminal. |
1003 | |
1237 | |
1004 | Croaks (and probably outputs an error message) if the new instance |
1238 | Croaks (and probably outputs an error message) if the new instance |
1005 | couldn't be created. Returns C<undef> if the new instance didn't |
1239 | couldn't be created. Returns C<undef> if the new instance didn't |
1006 | initialise perl, and the terminal object otherwise. The C<init> and |
1240 | initialise perl, and the terminal object otherwise. The C<init> and |
1007 | C<start> hooks will be called during this call. |
1241 | C<start> hooks will be called before this call returns, and are free to |
|
|
1242 | refer to global data (which is race free). |
1008 | |
1243 | |
1009 | =cut |
1244 | =cut |
1010 | |
1245 | |
1011 | sub new { |
1246 | sub new { |
1012 | my ($class, $env, @args) = @_; |
1247 | my ($class, $env, @args) = @_; |
1013 | |
1248 | |
|
|
1249 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1250 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1251 | |
1014 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1252 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1015 | } |
1253 | } |
1016 | |
1254 | |
1017 | =item $term->destroy |
1255 | =item $term->destroy |
1018 | |
1256 | |
1019 | Destroy the terminal object (close the window, free resources |
1257 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1049 | |
1287 | |
1050 | Returns true if the option specified by C<$optval> is enabled, and |
1288 | Returns true if the option specified by C<$optval> is enabled, and |
1051 | optionally change it. All option values are stored by name in the hash |
1289 | optionally change it. All option values are stored by name in the hash |
1052 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1290 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1053 | |
1291 | |
1054 | Here is a a likely non-exhaustive list of option names, please see the |
1292 | Here is a likely non-exhaustive list of option names, please see the |
1055 | source file F</src/optinc.h> to see the actual list: |
1293 | source file F</src/optinc.h> to see the actual list: |
1056 | |
1294 | |
1057 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1295 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1058 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1296 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1059 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1297 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1076 | likely change). |
1314 | likely change). |
1077 | |
1315 | |
1078 | Please note that resource strings will currently only be freed when the |
1316 | Please note that resource strings will currently only be freed when the |
1079 | terminal is destroyed, so changing options frequently will eat memory. |
1317 | terminal is destroyed, so changing options frequently will eat memory. |
1080 | |
1318 | |
1081 | Here is a a likely non-exhaustive list of resource names, not all of which |
1319 | Here is a likely non-exhaustive list of resource names, not all of which |
1082 | are supported in every build, please see the source file F</src/rsinc.h> |
1320 | are supported in every build, please see the source file F</src/rsinc.h> |
1083 | to see the actual list: |
1321 | to see the actual list: |
1084 | |
1322 | |
1085 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1323 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1086 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1324 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1087 | display_name embed ext_bwidth fade font geometry hold iconName |
1325 | display_name embed ext_bwidth fade font geometry hold iconName |
1088 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1326 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1089 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1327 | italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 |
1090 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1328 | modifier mouseWheelScrollPage name override_redirect pastableTabs path |
1091 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1329 | perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1092 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1330 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1093 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1331 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1094 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1332 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1095 | secondaryScreen secondaryScroll selectstyle shade term_name title |
1333 | secondaryScreen secondaryScroll shade term_name title |
1096 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1334 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1097 | visualBell |
1335 | visualBell |
1098 | |
1336 | |
1099 | =cut |
1337 | =cut |
1100 | |
1338 | |
1101 | sub resource($$;$) { |
1339 | sub resource($$;$) { |
1102 | my ($self, $name) = (shift, shift); |
1340 | my ($self, $name) = (shift, shift); |
1103 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1341 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1104 | &urxvt::term::_resource |
1342 | goto &urxvt::term::_resource |
1105 | } |
1343 | } |
1106 | |
1344 | |
1107 | =item $value = $term->x_resource ($pattern) |
1345 | =item $value = $term->x_resource ($pattern) |
1108 | |
1346 | |
1109 | Returns the X-Resource for the given pattern, excluding the program or |
1347 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
1134 | |
1372 | |
1135 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1373 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1136 | |
1374 | |
1137 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1375 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1138 | |
1376 | |
1139 | Return the current values of the selection mark, begin or end positions, |
1377 | Return the current values of the selection mark, begin or end positions. |
1140 | and optionally set them to new values. |
1378 | |
|
|
1379 | When arguments are given, then the selection coordinates are set to |
|
|
1380 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1381 | screen. |
|
|
1382 | |
|
|
1383 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1384 | |
|
|
1385 | Returns the current selection screen, and then optionally sets it. |
1141 | |
1386 | |
1142 | =item $term->selection_make ($eventtime[, $rectangular]) |
1387 | =item $term->selection_make ($eventtime[, $rectangular]) |
1143 | |
1388 | |
1144 | Tries to make a selection as set by C<selection_beg> and |
1389 | Tries to make a selection as set by C<selection_beg> and |
1145 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1390 | C<selection_end>. If C<$rectangular> is true (default: false), a |
… | |
… | |
1192 | |
1437 | |
1193 | The methods currently supported on C<urxvt::overlay> objects are: |
1438 | The methods currently supported on C<urxvt::overlay> objects are: |
1194 | |
1439 | |
1195 | =over 4 |
1440 | =over 4 |
1196 | |
1441 | |
1197 | =item $overlay->set ($x, $y, $text, $rend) |
1442 | =item $overlay->set ($x, $y, $text[, $rend]) |
1198 | |
1443 | |
1199 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1444 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1200 | text in rxvt-unicode's special encoding and an array of rendition values |
1445 | text in rxvt-unicode's special encoding and an array of rendition values |
1201 | at a specific position inside the overlay. |
1446 | at a specific position inside the overlay. |
|
|
1447 | |
|
|
1448 | If C<$rend> is missing, then the rendition will not be changed. |
1202 | |
1449 | |
1203 | =item $overlay->hide |
1450 | =item $overlay->hide |
1204 | |
1451 | |
1205 | If visible, hide the overlay, but do not destroy it. |
1452 | If visible, hide the overlay, but do not destroy it. |
1206 | |
1453 | |
… | |
… | |
1299 | Replaces the event mask of the pty watcher by the given event mask. Can |
1546 | Replaces the event mask of the pty watcher by the given event mask. Can |
1300 | be used to suppress input and output handling to the pty/tty. See the |
1547 | be used to suppress input and output handling to the pty/tty. See the |
1301 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1548 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1302 | the previous value. |
1549 | the previous value. |
1303 | |
1550 | |
|
|
1551 | =item $fd = $term->pty_fd |
|
|
1552 | |
|
|
1553 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1554 | is used. |
|
|
1555 | |
1304 | =item $windowid = $term->parent |
1556 | =item $windowid = $term->parent |
1305 | |
1557 | |
1306 | Return the window id of the toplevel window. |
1558 | Return the window id of the toplevel window. |
1307 | |
1559 | |
1308 | =item $windowid = $term->vt |
1560 | =item $windowid = $term->vt |
… | |
… | |
1314 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1566 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1315 | to receive pointer events all the times: |
1567 | to receive pointer events all the times: |
1316 | |
1568 | |
1317 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1569 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1318 | |
1570 | |
|
|
1571 | =item $term->focus_in |
|
|
1572 | |
|
|
1573 | =item $term->focus_out |
|
|
1574 | |
|
|
1575 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1576 | |
|
|
1577 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1578 | |
|
|
1579 | Deliver various fake events to to terminal. |
|
|
1580 | |
1319 | =item $window_width = $term->width |
1581 | =item $window_width = $term->width |
1320 | |
1582 | |
1321 | =item $window_height = $term->height |
1583 | =item $window_height = $term->height |
1322 | |
1584 | |
1323 | =item $font_width = $term->fwidth |
1585 | =item $font_width = $term->fwidth |
… | |
… | |
1353 | =item $env = $term->env |
1615 | =item $env = $term->env |
1354 | |
1616 | |
1355 | Returns a copy of the environment in effect for the terminal as a hashref |
1617 | Returns a copy of the environment in effect for the terminal as a hashref |
1356 | similar to C<\%ENV>. |
1618 | similar to C<\%ENV>. |
1357 | |
1619 | |
|
|
1620 | =item @envv = $term->envv |
|
|
1621 | |
|
|
1622 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1623 | |
|
|
1624 | =item @argv = $term->argv |
|
|
1625 | |
|
|
1626 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1627 | includes the program name as first element. |
|
|
1628 | |
1358 | =cut |
1629 | =cut |
1359 | |
1630 | |
1360 | sub env { |
1631 | sub env { |
1361 | if (my $env = $_[0]->_env) { |
|
|
1362 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1632 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1363 | } else { |
|
|
1364 | +{ %ENV } |
|
|
1365 | } |
|
|
1366 | } |
1633 | } |
1367 | |
1634 | |
1368 | =item $modifiermask = $term->ModLevel3Mask |
1635 | =item $modifiermask = $term->ModLevel3Mask |
1369 | |
1636 | |
1370 | =item $modifiermask = $term->ModMetaMask |
1637 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1375 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1642 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1376 | |
1643 | |
1377 | =item $screen = $term->current_screen |
1644 | =item $screen = $term->current_screen |
1378 | |
1645 | |
1379 | Returns the currently displayed screen (0 primary, 1 secondary). |
1646 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1647 | |
|
|
1648 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1649 | |
|
|
1650 | Returns whether the cursor is currently hidden or not. |
1380 | |
1651 | |
1381 | =item $view_start = $term->view_start ([$newvalue]) |
1652 | =item $view_start = $term->view_start ([$newvalue]) |
1382 | |
1653 | |
1383 | Returns the row number of the topmost displayed line. Maximum value is |
1654 | Returns the row number of the topmost displayed line. Maximum value is |
1384 | C<0>, which displays the normal terminal contents. Lower values scroll |
1655 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1392 | |
1663 | |
1393 | Used after changing terminal contents to display them. |
1664 | Used after changing terminal contents to display them. |
1394 | |
1665 | |
1395 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1666 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1396 | |
1667 | |
1397 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1668 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1398 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1669 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1399 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1400 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1670 | terminal line. Nothing will be returned if a nonexistent line |
1401 | is requested. |
1671 | is requested. |
1402 | |
1672 | |
1403 | If C<$new_text> is specified, it will replace characters in the current |
1673 | If C<$new_text> is specified, it will replace characters in the current |
1404 | line, starting at column C<$start_col> (default C<0>), which is useful |
1674 | line, starting at column C<$start_col> (default C<0>), which is useful |
1405 | to replace only parts of a line. The font index in the rendition will |
1675 | to replace only parts of a line. The font index in the rendition will |
1406 | automatically be updated. |
1676 | automatically be updated. |
1407 | |
1677 | |
1408 | C<$text> is in a special encoding: tabs and wide characters that use |
1678 | C<$text> is in a special encoding: tabs and wide characters that use more |
1409 | more than one cell when displayed are padded with C<$urxvt::NOCHAR> |
1679 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1410 | characters. Characters with combining characters and other characters that |
1680 | characters. Characters with combining characters and other characters that |
1411 | do not fit into the normal tetx encoding will be replaced with characters |
1681 | do not fit into the normal text encoding will be replaced with characters |
1412 | in the private use area. |
1682 | in the private use area. |
1413 | |
1683 | |
1414 | You have to obey this encoding when changing text. The advantage is |
1684 | You have to obey this encoding when changing text. The advantage is |
1415 | that C<substr> and similar functions work on screen cells and not on |
1685 | that C<substr> and similar functions work on screen cells and not on |
1416 | characters. |
1686 | characters. |
… | |
… | |
1561 | where one character corresponds to one screen cell. See |
1831 | where one character corresponds to one screen cell. See |
1562 | C<< $term->ROW_t >> for details. |
1832 | C<< $term->ROW_t >> for details. |
1563 | |
1833 | |
1564 | =item $string = $term->special_decode $text |
1834 | =item $string = $term->special_decode $text |
1565 | |
1835 | |
1566 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1836 | Converts rxvt-unicodes text representation into a perl string. See |
1567 | C<< $term->ROW_t >> for details. |
1837 | C<< $term->ROW_t >> for details. |
1568 | |
1838 | |
1569 | =item $success = $term->grab_button ($button, $modifiermask) |
1839 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1570 | |
1840 | |
|
|
1841 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1842 | |
1571 | Registers a synchronous button grab. See the XGrabButton manpage. |
1843 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1844 | manpage. |
1572 | |
1845 | |
1573 | =item $success = $term->grab ($eventtime[, $sync]) |
1846 | =item $success = $term->grab ($eventtime[, $sync]) |
1574 | |
1847 | |
1575 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1848 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1576 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1849 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1577 | |
1850 | |
1578 | =item $term->allow_events_async |
1851 | =item $term->allow_events_async |
1579 | |
1852 | |
1580 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1853 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1581 | |
1854 | |
… | |
… | |
1600 | |
1873 | |
1601 | =item @atoms = $term->XListProperties ($window) |
1874 | =item @atoms = $term->XListProperties ($window) |
1602 | |
1875 | |
1603 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1876 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1604 | |
1877 | |
1605 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
1878 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
1606 | |
1879 | |
1607 | =item $term->XDeleteProperty ($window, $property) |
1880 | =item $term->XDeleteProperty ($window, $property) |
1608 | |
1881 | |
1609 | =item $window = $term->DefaultRootWindow |
1882 | =item $window = $term->DefaultRootWindow |
1610 | |
1883 | |
… | |
… | |
1694 | my ($self, $text, $cb) = @_; |
1967 | my ($self, $text, $cb) = @_; |
1695 | |
1968 | |
1696 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1969 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1697 | } |
1970 | } |
1698 | |
1971 | |
1699 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1972 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1700 | |
1973 | |
1701 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1974 | Adds a toggle/checkbox item to the popup. The callback gets called |
1702 | whenever it gets toggled, with a boolean indicating its value as its first |
1975 | whenever it gets toggled, with a boolean indicating its new value as its |
1703 | argument. |
1976 | first argument. |
1704 | |
1977 | |
1705 | =cut |
1978 | =cut |
1706 | |
1979 | |
1707 | sub add_toggle { |
1980 | sub add_toggle { |
1708 | my ($self, $text, $cb, $value) = @_; |
1981 | my ($self, $text, $value, $cb) = @_; |
1709 | |
1982 | |
1710 | my $item; $item = { |
1983 | my $item; $item = { |
1711 | type => "button", |
1984 | type => "button", |
1712 | text => " $text", |
1985 | text => " $text", |
1713 | value => $value, |
1986 | value => $value, |
… | |
… | |
1732 | my $env = $self->{term}->env; |
2005 | my $env = $self->{term}->env; |
1733 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
2006 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1734 | delete $env->{LC_ALL}; |
2007 | delete $env->{LC_ALL}; |
1735 | $env->{LC_CTYPE} = $self->{term}->locale; |
2008 | $env->{LC_CTYPE} = $self->{term}->locale; |
1736 | |
2009 | |
1737 | urxvt::term->new ($env, "popup", |
2010 | my $term = urxvt::term->new ( |
|
|
2011 | $env, "popup", |
1738 | "--perl-lib" => "", "--perl-ext-common" => "", |
2012 | "--perl-lib" => "", "--perl-ext-common" => "", |
1739 | "-pty-fd" => -1, "-sl" => 0, |
2013 | "-pty-fd" => -1, "-sl" => 0, |
1740 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
2014 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1741 | "--transient-for" => $self->{term}->parent, |
2015 | "--transient-for" => $self->{term}->parent, |
1742 | "-display" => $self->{term}->display_id, |
2016 | "-display" => $self->{term}->display_id, |
1743 | "-pe" => "urxvt-popup") |
2017 | "-pe" => "urxvt-popup", |
1744 | or die "unable to create popup window\n"; |
2018 | ) or die "unable to create popup window\n"; |
|
|
2019 | |
|
|
2020 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
2021 | $term->ungrab; |
|
|
2022 | $term->destroy; |
|
|
2023 | die "unable to initialise popup window\n"; |
|
|
2024 | } |
1745 | } |
2025 | } |
1746 | |
2026 | |
1747 | sub DESTROY { |
2027 | sub DESTROY { |
1748 | my ($self) = @_; |
2028 | my ($self) = @_; |
1749 | |
2029 | |
… | |
… | |
1754 | =back |
2034 | =back |
1755 | |
2035 | |
1756 | =cut |
2036 | =cut |
1757 | |
2037 | |
1758 | package urxvt::watcher; |
2038 | package urxvt::watcher; |
1759 | |
|
|
1760 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1761 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1762 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1763 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1764 | |
2039 | |
1765 | =head2 The C<urxvt::timer> Class |
2040 | =head2 The C<urxvt::timer> Class |
1766 | |
2041 | |
1767 | This class implements timer watchers/events. Time is represented as a |
2042 | This class implements timer watchers/events. Time is represented as a |
1768 | fractional number of seconds since the epoch. Example: |
2043 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1772 | ->new |
2047 | ->new |
1773 | ->interval (1) |
2048 | ->interval (1) |
1774 | ->cb (sub { |
2049 | ->cb (sub { |
1775 | $term->{overlay}->set (0, 0, |
2050 | $term->{overlay}->set (0, 0, |
1776 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2051 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1777 | }); |
2052 | }); |
1778 | |
2053 | |
1779 | =over 4 |
2054 | =over 4 |
1780 | |
2055 | |
1781 | =item $timer = new urxvt::timer |
2056 | =item $timer = new urxvt::timer |
1782 | |
2057 | |
… | |
… | |
1785 | |
2060 | |
1786 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2061 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
1787 | |
2062 | |
1788 | Set the callback to be called when the timer triggers. |
2063 | Set the callback to be called when the timer triggers. |
1789 | |
2064 | |
1790 | =item $tstamp = $timer->at |
|
|
1791 | |
|
|
1792 | Return the time this watcher will fire next. |
|
|
1793 | |
|
|
1794 | =item $timer = $timer->set ($tstamp) |
2065 | =item $timer = $timer->set ($tstamp[, $interval]) |
1795 | |
2066 | |
1796 | Set the time the event is generated to $tstamp. |
2067 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2068 | new $interval). |
1797 | |
2069 | |
1798 | =item $timer = $timer->interval ($interval) |
2070 | =item $timer = $timer->interval ($interval) |
1799 | |
2071 | |
1800 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2072 | By default (and when C<$interval> is C<0>), the timer will automatically |
1801 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2073 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
1802 | is automatically rescheduled at the given intervals. |
2074 | is automatically rescheduled at the given intervals. |
1803 | |
2075 | |
1804 | =item $timer = $timer->start |
2076 | =item $timer = $timer->start |
1805 | |
2077 | |
1806 | Start the timer. |
2078 | Start the timer. |
1807 | |
2079 | |
1808 | =item $timer = $timer->start ($tstamp) |
2080 | =item $timer = $timer->start ($tstamp[, $interval]) |
1809 | |
2081 | |
1810 | Set the event trigger time to C<$tstamp> and start the timer. |
2082 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2083 | also replaces the interval. |
1811 | |
2084 | |
1812 | =item $timer = $timer->after ($delay) |
2085 | =item $timer = $timer->after ($delay[, $interval]) |
1813 | |
2086 | |
1814 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2087 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1815 | |
2088 | |
1816 | =item $timer = $timer->stop |
2089 | =item $timer = $timer->stop |
1817 | |
2090 | |
… | |
… | |
1825 | |
2098 | |
1826 | $term->{socket} = ... |
2099 | $term->{socket} = ... |
1827 | $term->{iow} = urxvt::iow |
2100 | $term->{iow} = urxvt::iow |
1828 | ->new |
2101 | ->new |
1829 | ->fd (fileno $term->{socket}) |
2102 | ->fd (fileno $term->{socket}) |
1830 | ->events (urxvt::EVENT_READ) |
2103 | ->events (urxvt::EV_READ) |
1831 | ->start |
2104 | ->start |
1832 | ->cb (sub { |
2105 | ->cb (sub { |
1833 | my ($iow, $revents) = @_; |
2106 | my ($iow, $revents) = @_; |
1834 | # $revents must be 1 here, no need to check |
2107 | # $revents must be 1 here, no need to check |
1835 | sysread $term->{socket}, my $buf, 8192 |
2108 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1848 | Set the callback to be called when io events are triggered. C<$reventmask> |
2121 | Set the callback to be called when io events are triggered. C<$reventmask> |
1849 | is a bitset as described in the C<events> method. |
2122 | is a bitset as described in the C<events> method. |
1850 | |
2123 | |
1851 | =item $iow = $iow->fd ($fd) |
2124 | =item $iow = $iow->fd ($fd) |
1852 | |
2125 | |
1853 | Set the filedescriptor (not handle) to watch. |
2126 | Set the file descriptor (not handle) to watch. |
1854 | |
2127 | |
1855 | =item $iow = $iow->events ($eventmask) |
2128 | =item $iow = $iow->events ($eventmask) |
1856 | |
2129 | |
1857 | Set the event mask to watch. The only allowed values are |
2130 | Set the event mask to watch. The only allowed values are |
1858 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2131 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
1859 | together, or C<urxvt::EVENT_NONE>. |
2132 | together, or C<urxvt::EV_NONE>. |
1860 | |
2133 | |
1861 | =item $iow = $iow->start |
2134 | =item $iow = $iow->start |
1862 | |
2135 | |
1863 | Start watching for requested events on the given handle. |
2136 | Start watching for requested events on the given handle. |
1864 | |
2137 | |
1865 | =item $iow = $iow->stop |
2138 | =item $iow = $iow->stop |
1866 | |
2139 | |
1867 | Stop watching for events on the given filehandle. |
2140 | Stop watching for events on the given file handle. |
1868 | |
2141 | |
1869 | =back |
2142 | =back |
1870 | |
2143 | |
1871 | =head2 The C<urxvt::iw> Class |
2144 | =head2 The C<urxvt::iw> Class |
1872 | |
2145 | |
… | |
… | |
1905 | ->new |
2178 | ->new |
1906 | ->start ($pid) |
2179 | ->start ($pid) |
1907 | ->cb (sub { |
2180 | ->cb (sub { |
1908 | my ($pw, $exit_status) = @_; |
2181 | my ($pw, $exit_status) = @_; |
1909 | ... |
2182 | ... |
1910 | }); |
2183 | }); |
1911 | |
2184 | |
1912 | =over 4 |
2185 | =over 4 |
1913 | |
2186 | |
1914 | =item $pw = new urxvt::pw |
2187 | =item $pw = new urxvt::pw |
1915 | |
2188 | |
… | |
… | |
1919 | |
2192 | |
1920 | Set the callback to be called when the timer triggers. |
2193 | Set the callback to be called when the timer triggers. |
1921 | |
2194 | |
1922 | =item $pw = $timer->start ($pid) |
2195 | =item $pw = $timer->start ($pid) |
1923 | |
2196 | |
1924 | Tells the wqtcher to start watching for process C<$pid>. |
2197 | Tells the watcher to start watching for process C<$pid>. |
1925 | |
2198 | |
1926 | =item $pw = $pw->stop |
2199 | =item $pw = $pw->stop |
1927 | |
2200 | |
1928 | Stop the watcher. |
2201 | Stop the watcher. |
1929 | |
2202 | |
… | |
… | |
1942 | |
2215 | |
1943 | =item >= 3 - script loading and management |
2216 | =item >= 3 - script loading and management |
1944 | |
2217 | |
1945 | =item >=10 - all called hooks |
2218 | =item >=10 - all called hooks |
1946 | |
2219 | |
1947 | =item >=11 - hook reutrn values |
2220 | =item >=11 - hook return values |
1948 | |
2221 | |
1949 | =back |
2222 | =back |
1950 | |
2223 | |
1951 | =head1 AUTHOR |
2224 | =head1 AUTHOR |
1952 | |
2225 | |
… | |
… | |
1954 | http://software.schmorp.de/pkg/rxvt-unicode |
2227 | http://software.schmorp.de/pkg/rxvt-unicode |
1955 | |
2228 | |
1956 | =cut |
2229 | =cut |
1957 | |
2230 | |
1958 | 1 |
2231 | 1 |
|
|
2232 | |
|
|
2233 | # vim: sw=3: |