|
|
1 | =encoding utf8 |
|
|
2 | |
1 | =head1 NAME |
3 | =head1 NAME |
2 | |
4 | |
3 | rxvtperl - rxvt-unicode's embedded perl interpreter |
5 | @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter |
4 | |
6 | |
5 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
6 | |
8 | |
7 | * Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, they will be loaded automatically. |
9 | # create a file grab_test in $HOME: |
8 | |
|
|
9 | * Each script will only be loaded once, even in urxvtd, and will be valid |
|
|
10 | globally. |
|
|
11 | |
|
|
12 | * Scripts are evaluated in a 'use strict' and 'use utf8' environment, and |
|
|
13 | thus must be encoded as UTF-8. |
|
|
14 | |
10 | |
15 | sub on_sel_grab { |
11 | sub on_sel_grab { |
16 | warn "you selected ", $_[0]->selection; |
12 | warn "you selected ", $_[0]->selection; |
17 | () |
13 | () |
18 | } |
14 | } |
19 | |
15 | |
20 | 1 |
16 | # start a @@RXVT_NAME@@ using it: |
|
|
17 | |
|
|
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
21 | |
19 | |
22 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
23 | |
21 | |
|
|
22 | Everytime a terminal object gets created, scripts specified via the |
|
|
23 | C<perl> resource are loaded and associated with it. |
|
|
24 | |
|
|
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
|
|
26 | thus must be encoded as UTF-8. |
|
|
27 | |
|
|
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. |
|
|
30 | |
|
|
31 | =head2 Prepackaged Extensions |
|
|
32 | |
|
|
33 | This section describes the extensiosn delivered with this version. You can |
|
|
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
|
|
35 | |
|
|
36 | You can activate them like this: |
|
|
37 | |
|
|
38 | @@RXVT_NAME@@ -pe <extensionname> |
|
|
39 | |
|
|
40 | =over 4 |
|
|
41 | |
|
|
42 | =item selection |
|
|
43 | |
|
|
44 | Intelligent selection. This extension tries to be more intelligent when |
|
|
45 | the user extends selections (double-click). Right now, it tries to select |
|
|
46 | urls and complete shell-quoted arguments, which is very convenient, too, |
|
|
47 | if your F<ls> supports C<--quoting-style=shell>. |
|
|
48 | |
|
|
49 | It also offers the following bindable event: |
|
|
50 | |
|
|
51 | =over 4 |
|
|
52 | |
|
|
53 | =item rot13 |
|
|
54 | |
|
|
55 | Rot-13 the selection when activated. Used via keyboard trigger: |
|
|
56 | |
|
|
57 | URxvt.keysym.C-M-r: perl:selection:rot13 |
|
|
58 | |
|
|
59 | =back |
|
|
60 | |
|
|
61 | =item digital-clock |
|
|
62 | |
|
|
63 | Displays a digital clock using the built-in overlay. |
|
|
64 | |
|
|
65 | =item mark-urls |
|
|
66 | |
|
|
67 | Uses per-line filtering (C<on_line_update>) to underline urls. |
|
|
68 | |
|
|
69 | =item example-refresh-hooks |
|
|
70 | |
|
|
71 | Displays a very simple digital clock in the upper right corner of the |
|
|
72 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
73 | overlays or changes. |
|
|
74 | |
|
|
75 | =item example-filter-input |
|
|
76 | |
|
|
77 | A not very useful example of filtering all text output to the terminal, by |
|
|
78 | underlining all urls that matches a certain regex (i.e. some urls :). It |
|
|
79 | is not very useful because urls that are output in multiple steps (e.g. |
|
|
80 | when typing them) do not get marked. |
|
|
81 | |
|
|
82 | =back |
|
|
83 | |
|
|
84 | =head2 General API Considerations |
|
|
85 | |
|
|
86 | All objects (such as terminals, time watchers etc.) are typical |
|
|
87 | reference-to-hash objects. The hash can be used to store anything you |
|
|
88 | like. All members starting with an underscore (such as C<_ptr> or |
|
|
89 | C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or |
|
|
90 | modified). |
|
|
91 | |
|
|
92 | When objects are destroyed on the C++ side, the perl object hashes are |
|
|
93 | emptied, so its best to store related objects such as time watchers and |
|
|
94 | the like inside the terminal object so they get destroyed as soon as the |
|
|
95 | terminal is destroyed. |
|
|
96 | |
|
|
97 | Argument names also often indicate the type of a parameter. Here are some |
|
|
98 | hints on what they mean: |
|
|
99 | |
|
|
100 | =over 4 |
|
|
101 | |
|
|
102 | =item $text |
|
|
103 | |
|
|
104 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
|
|
105 | always represents one screen cell. See L<row_t> for a discussion of this format. |
|
|
106 | |
|
|
107 | =item $string |
|
|
108 | |
|
|
109 | A perl text string, with an emphasis on I<text>. It can store all unicode |
|
|
110 | characters and is to be distinguished with text encoded in a specific |
|
|
111 | encoding (often locale-specific) and binary data. |
|
|
112 | |
|
|
113 | =item $octets |
|
|
114 | |
|
|
115 | Either binary data or - more common - a text string encoded in a |
|
|
116 | locale-specific way. |
|
|
117 | |
|
|
118 | =back |
|
|
119 | |
24 | =head2 Hooks |
120 | =head2 Hooks |
25 | |
121 | |
26 | The following subroutines can be declared in loaded scripts, and will be called |
122 | The following subroutines can be declared in loaded scripts, and will be |
27 | whenever the relevant event happens. |
123 | called whenever the relevant event happens. |
|
|
124 | |
|
|
125 | The first argument passed to them is an object private to each terminal |
|
|
126 | and extension package. You can call all C<urxvt::term> methods on it, but |
|
|
127 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
|
|
128 | object that is shared between all packages is stored in the C<term> |
|
|
129 | member. |
28 | |
130 | |
29 | All of them must return a boolean value. If it is true, then the event |
131 | All of them must return a boolean value. If it is true, then the event |
30 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
132 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
31 | and the relevant action might not be carried out by the C++ code. |
133 | and the relevant action might not be carried out by the C++ code. |
32 | |
134 | |
… | |
… | |
35 | =over 4 |
137 | =over 4 |
36 | |
138 | |
37 | =item on_init $term |
139 | =item on_init $term |
38 | |
140 | |
39 | Called after a new terminal object has been initialized, but before |
141 | Called after a new terminal object has been initialized, but before |
40 | windows are created or the command gets run. |
142 | windows are created or the command gets run. Most methods are unsafe to |
|
|
143 | call or deliver senseless data, as terminal size and other characteristics |
|
|
144 | have not yet been determined. You can safely query and change resources, |
|
|
145 | though. |
41 | |
146 | |
42 | =item on_reset $term |
147 | =item on_reset $term |
43 | |
148 | |
44 | Called after the screen is "reset" for any reason, such as resizing or |
149 | Called after the screen is "reset" for any reason, such as resizing or |
45 | control sequences. Here is where you can react on changes to size-related |
150 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
65 | requested from the server. The selection text can be queried and changed |
170 | requested from the server. The selection text can be queried and changed |
66 | by calling C<< $term->selection >>. |
171 | by calling C<< $term->selection >>. |
67 | |
172 | |
68 | Returning a true value aborts selection grabbing. It will still be hilighted. |
173 | Returning a true value aborts selection grabbing. It will still be hilighted. |
69 | |
174 | |
|
|
175 | =item on_sel_extend $term |
|
|
176 | |
|
|
177 | Called whenever the user tries to extend the selection (e.g. with a double |
|
|
178 | click) and is either supposed to return false (normal operation), or |
|
|
179 | should extend the selection itelf and return true to suppress the built-in |
|
|
180 | processing. |
|
|
181 | |
|
|
182 | See the F<selection> example extension. |
|
|
183 | |
70 | =item on_focus_in $term |
184 | =item on_focus_in $term |
71 | |
185 | |
72 | Called whenever the window gets the keyboard focus, before urxvt does |
186 | Called whenever the window gets the keyboard focus, before urxvt does |
73 | focus in processing. |
187 | focus in processing. |
74 | |
188 | |
… | |
… | |
94 | number of lines that will be in the scrollback buffer. |
208 | number of lines that will be in the scrollback buffer. |
95 | |
209 | |
96 | =item on_tty_activity $term *NYI* |
210 | =item on_tty_activity $term *NYI* |
97 | |
211 | |
98 | Called whenever the program(s) running in the urxvt window send output. |
212 | Called whenever the program(s) running in the urxvt window send output. |
|
|
213 | |
|
|
214 | =item on_osc_seq $term, $string |
|
|
215 | |
|
|
216 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
|
|
217 | operating system command) is processed. Cursor position and other state |
|
|
218 | information is up-to-date when this happens. For interoperability, the |
|
|
219 | string should start with the extension name and a colon, to distinguish |
|
|
220 | it from commands for other extensions, and this might be enforced in the |
|
|
221 | future. |
|
|
222 | |
|
|
223 | Be careful not ever to trust (in a security sense) the data you receive, |
|
|
224 | as its source can not easily be controleld (e-mail content, messages from |
|
|
225 | other users on the same system etc.). |
|
|
226 | |
|
|
227 | =item on_add_lines $term, $string |
|
|
228 | |
|
|
229 | Called whenever text is about to be output, with the text as argument. You |
|
|
230 | can filter/change and output the text yourself by returning a true value |
|
|
231 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
|
|
232 | might be very slow, however, as your hook is called for B<all> text being |
|
|
233 | output. |
|
|
234 | |
|
|
235 | =item on_line_update $term, $row |
|
|
236 | |
|
|
237 | Called whenever a line was updated or changed. Can be used to filter |
|
|
238 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
239 | that are being shown will be filtered, and, due to performance reasons, |
|
|
240 | not always immediately. |
|
|
241 | |
|
|
242 | The row number is always the topmost row of the line if the line spans |
|
|
243 | multiple rows. |
|
|
244 | |
|
|
245 | Please note that, if you change the line, then the hook might get called |
|
|
246 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
247 | you cannot just toggle rendition bits, but only set them. |
99 | |
248 | |
100 | =item on_refresh_begin $term |
249 | =item on_refresh_begin $term |
101 | |
250 | |
102 | Called just before the screen gets redrawn. Can be used for overlay |
251 | Called just before the screen gets redrawn. Can be used for overlay |
103 | or similar effects by modify terminal contents in refresh_begin, and |
252 | or similar effects by modify terminal contents in refresh_begin, and |
… | |
… | |
106 | |
255 | |
107 | =item on_refresh_end $term |
256 | =item on_refresh_end $term |
108 | |
257 | |
109 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
258 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
110 | |
259 | |
|
|
260 | =item on_keyboard_command $term, $string |
|
|
261 | |
|
|
262 | Called whenever the user presses a key combination that has a |
|
|
263 | C<perl:string> action bound to it (see description of the B<keysym> |
|
|
264 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
265 | |
|
|
266 | =item on_key_press $term, $event, $octets |
|
|
267 | |
|
|
268 | =item on_key_release $term, $event |
|
|
269 | |
|
|
270 | =item on_button_press $term, $event |
|
|
271 | |
|
|
272 | =item on_button_release $term, $event |
|
|
273 | |
|
|
274 | =item on_motion_notify $term, $event |
|
|
275 | |
|
|
276 | Called whenever the corresponding X event is received for the terminal If |
|
|
277 | the hook returns true, then the even will be ignored by rxvt-unicode. |
|
|
278 | |
|
|
279 | The event is a hash with most values as named by Xlib (see the XEvent |
|
|
280 | manpage), with the additional members C<row> and C<col>, which are the row |
|
|
281 | and column under the mouse cursor. |
|
|
282 | |
|
|
283 | C<on_key_press> additionally receives the string rxvt-unicode would |
|
|
284 | output, if any, in locale-specific encoding. |
|
|
285 | |
|
|
286 | subwindow. |
|
|
287 | |
|
|
288 | =back |
|
|
289 | |
|
|
290 | =head2 Variables in the C<urxvt> Package |
|
|
291 | |
|
|
292 | =over 4 |
|
|
293 | |
|
|
294 | =item $urxvt::TERM |
|
|
295 | |
|
|
296 | The current terminal. Whenever a callback/Hook is bein executed, this |
|
|
297 | variable stores the current C<urxvt::term> object. |
|
|
298 | |
111 | =back |
299 | =back |
112 | |
300 | |
113 | =head2 Functions in the C<urxvt> Package |
301 | =head2 Functions in the C<urxvt> Package |
114 | |
302 | |
115 | =over 4 |
303 | =over 4 |
|
|
304 | |
|
|
305 | =item $term = new urxvt [arg...] |
|
|
306 | |
|
|
307 | Creates a new terminal, very similar as if you had started it with |
|
|
308 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
309 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
310 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
311 | C<init> and C<start> hooks will be called during the call. |
116 | |
312 | |
117 | =item urxvt::fatal $errormessage |
313 | =item urxvt::fatal $errormessage |
118 | |
314 | |
119 | Fatally aborts execution with the given error message. Avoid at all |
315 | Fatally aborts execution with the given error message. Avoid at all |
120 | costs! The only time this is acceptable is when the terminal process |
316 | costs! The only time this is acceptable is when the terminal process |
121 | starts up. |
317 | starts up. |
122 | |
318 | |
123 | =item urxvt::warn $string |
319 | =item urxvt::warn $string |
124 | |
320 | |
125 | Calls C<rxvt_warn> witht eh given string which should not include a |
321 | Calls C<rxvt_warn> with the given string which should not include a |
126 | newline. The module also overwrites the C<warn> builtin with a function |
322 | newline. The module also overwrites the C<warn> builtin with a function |
127 | that calls this function. |
323 | that calls this function. |
128 | |
324 | |
129 | Using this function has the advantage that its output ends up in the |
325 | Using this function has the advantage that its output ends up in the |
130 | correct place, e.g. on stderr of the connecting urxvtc client. |
326 | correct place, e.g. on stderr of the connecting urxvtc client. |
131 | |
327 | |
132 | =item $cellwidth = urxvt::wcswidth $string |
|
|
133 | |
|
|
134 | Returns the number of screen-cells this string would need. Correctly |
|
|
135 | accounts for wide and combining characters. |
|
|
136 | |
|
|
137 | =item $time = urxvt::NOW |
328 | =item $time = urxvt::NOW |
138 | |
329 | |
139 | Returns the "current time" (as per the event loop). |
330 | Returns the "current time" (as per the event loop). |
140 | |
331 | |
|
|
332 | =back |
|
|
333 | |
|
|
334 | =head2 RENDITION |
|
|
335 | |
|
|
336 | Rendition bitsets contain information about colour, font, font styles and |
|
|
337 | similar information for each screen cell. |
|
|
338 | |
|
|
339 | The following "macros" deal with changes in rendition sets. You should |
|
|
340 | never just create a bitset, you should always modify an existing one, |
|
|
341 | as they contain important information required for correct operation of |
|
|
342 | rxvt-unicode. |
|
|
343 | |
|
|
344 | =over 4 |
|
|
345 | |
|
|
346 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
347 | |
|
|
348 | Returns the default rendition, as used when the terminal is starting up or |
|
|
349 | being reset. Useful as a base to start when creating renditions. |
|
|
350 | |
|
|
351 | =item $rend = urxvt::OVERLAY_RSTYLE |
|
|
352 | |
|
|
353 | Return the rendition mask used for overlays by default. |
|
|
354 | |
|
|
355 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
|
|
356 | |
|
|
357 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
358 | underline, respectively. To enable such a style, just logically OR it into |
|
|
359 | the bitset. |
|
|
360 | |
|
|
361 | =item $foreground = urxvt::GET_BASEFG $rend |
|
|
362 | |
|
|
363 | =item $background = urxvt::GET_BASEBG $rend |
|
|
364 | |
|
|
365 | Return the foreground/background colour index, respectively. |
|
|
366 | |
|
|
367 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
|
|
368 | |
|
|
369 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
|
|
370 | |
|
|
371 | Replace the foreground/background colour in the rendition mask with the |
|
|
372 | specified one. |
|
|
373 | |
|
|
374 | =item $value = urxvt::GET_CUSTOM ($rend) |
|
|
375 | |
|
|
376 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
377 | extensions. They can be set and changed as you like and are initially |
|
|
378 | zero. |
|
|
379 | |
|
|
380 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
|
|
381 | |
|
|
382 | Change the custom value. |
|
|
383 | |
|
|
384 | =back |
|
|
385 | |
141 | =cut |
386 | =cut |
142 | |
387 | |
143 | package urxvt; |
388 | package urxvt; |
144 | |
389 | |
145 | use strict; |
390 | use strict; |
|
|
391 | use Scalar::Util (); |
146 | |
392 | |
147 | our $term; |
393 | our $TERM; |
148 | our @HOOKNAME; |
394 | our @HOOKNAME; |
149 | our $LIBDIR; |
395 | our $LIBDIR; |
150 | |
396 | |
151 | BEGIN { |
397 | BEGIN { |
152 | urxvt->bootstrap; |
398 | urxvt->bootstrap; |
… | |
… | |
158 | unless $msg =~ /\n$/; |
404 | unless $msg =~ /\n$/; |
159 | urxvt::warn ($msg); |
405 | urxvt::warn ($msg); |
160 | }; |
406 | }; |
161 | } |
407 | } |
162 | |
408 | |
|
|
409 | my @hook_count; |
163 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY} || 10; |
410 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
164 | |
411 | |
165 | sub verbose { |
412 | sub verbose { |
166 | my ($level, $msg) = @_; |
413 | my ($level, $msg) = @_; |
167 | warn "$msg\n"; #d# |
414 | warn "$msg\n" if $level <= $verbosity; |
168 | } |
|
|
169 | |
|
|
170 | my @invoke_cb; |
|
|
171 | |
|
|
172 | # called by the rxvt core |
|
|
173 | sub invoke { |
|
|
174 | local $term = shift; |
|
|
175 | my $htype = shift; |
|
|
176 | |
|
|
177 | my $cb = $invoke_cb[$htype]; |
|
|
178 | |
|
|
179 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" |
|
|
180 | if $verbosity >= 10; |
|
|
181 | |
|
|
182 | while (my ($k, $v) = each %$cb) { |
|
|
183 | return 1 if $v->($term, @_); |
|
|
184 | } |
|
|
185 | |
|
|
186 | 0 |
|
|
187 | } |
415 | } |
188 | |
416 | |
189 | # find on_xxx subs in the package and register them |
417 | # find on_xxx subs in the package and register them |
190 | # as hooks |
418 | # as hooks |
191 | sub register_package($) { |
419 | sub register_package($) { |
192 | my ($pkg) = @_; |
420 | my ($pkg) = @_; |
193 | |
421 | |
194 | for my $hook (0.. $#HOOKNAME) { |
422 | for my $htype (0.. $#HOOKNAME) { |
195 | my $name = $HOOKNAME[$hook]; |
423 | my $name = $HOOKNAME[$htype]; |
196 | |
424 | |
197 | my $ref = $pkg->can ("on_" . lc $name) |
425 | my $ref = $pkg->can ("on_" . lc $name) |
198 | or next; |
426 | or next; |
199 | |
427 | |
200 | $invoke_cb[$hook]{$ref*1} = $ref; |
428 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
|
|
429 | $hook_count[$htype]++ |
201 | set_should_invoke $hook, 1; |
430 | or set_should_invoke $htype, 1; |
202 | } |
431 | } |
203 | } |
432 | } |
204 | |
433 | |
205 | my $script_pkg = "script0000"; |
434 | my $script_pkg = "script0000"; |
206 | my %script_pkg; |
435 | my %script_pkg; |
207 | |
436 | |
208 | # load a single script into its own package, once only |
437 | # load a single script into its own package, once only |
209 | sub load_script($) { |
438 | sub script_package($) { |
210 | my ($path) = @_; |
439 | my ($path) = @_; |
211 | |
440 | |
212 | $script_pkg{$path} ||= do { |
441 | $script_pkg{$path} ||= do { |
213 | my $pkg = $script_pkg++; |
442 | my $pkg = "urxvt::" . ($script_pkg++); |
|
|
443 | |
214 | verbose 3, "loading script '$path' into package '$pkg'"; |
444 | verbose 3, "loading script '$path' into package '$pkg'"; |
215 | |
445 | |
216 | open my $fh, "<:raw", $path |
446 | open my $fh, "<:raw", $path |
217 | or die "$path: $!"; |
447 | or die "$path: $!"; |
218 | |
448 | |
219 | eval "package $pkg; use strict; use utf8;\n" |
449 | my $source = "package $pkg; use strict; use utf8;\n" |
220 | . "#line 1 \"$path\"\n" |
450 | . "#line 1 \"$path\"\n{\n" |
221 | . do { local $/; <$fh> } |
451 | . (do { local $/; <$fh> }) |
|
|
452 | . "\n};\n1"; |
|
|
453 | |
222 | or die "$path: $@"; |
454 | eval $source or die "$path: $@"; |
223 | |
|
|
224 | register_package $pkg; |
|
|
225 | |
455 | |
226 | $pkg |
456 | $pkg |
227 | }; |
457 | } |
228 | } |
458 | } |
229 | |
459 | |
230 | load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>; |
460 | our $retval; # return value for urxvt |
231 | |
461 | |
232 | =back |
462 | # called by the rxvt core |
|
|
463 | sub invoke { |
|
|
464 | local $TERM = shift; |
|
|
465 | my $htype = shift; |
|
|
466 | |
|
|
467 | if ($htype == 0) { # INIT |
|
|
468 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
|
|
469 | |
|
|
470 | for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
|
|
471 | my @files = grep -f $_, map "$_/$ext", @dirs; |
|
|
472 | |
|
|
473 | if (@files) { |
|
|
474 | register_package script_package $files[0]; |
|
|
475 | } else { |
|
|
476 | warn "perl extension '$ext' not found in perl library search path\n"; |
|
|
477 | } |
|
|
478 | } |
|
|
479 | } |
|
|
480 | |
|
|
481 | $retval = undef; |
|
|
482 | |
|
|
483 | if (my $cb = $TERM->{_hook}[$htype]) { |
|
|
484 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
|
|
485 | if $verbosity >= 10; |
|
|
486 | |
|
|
487 | keys %$cb; |
|
|
488 | |
|
|
489 | while (my ($pkg, $cb) = each %$cb) { |
|
|
490 | $retval = $cb->( |
|
|
491 | $TERM->{_pkg}{$pkg} ||= do { |
|
|
492 | my $proxy = bless { }, urxvt::term::proxy::; |
|
|
493 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
494 | $proxy |
|
|
495 | }, |
|
|
496 | @_, |
|
|
497 | ) and last; |
|
|
498 | } |
|
|
499 | } |
|
|
500 | |
|
|
501 | if ($htype == 1) { # DESTROY |
|
|
502 | # remove hooks if unused |
|
|
503 | if (my $hook = $TERM->{_hook}) { |
|
|
504 | for my $htype (0..$#$hook) { |
|
|
505 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
506 | or set_should_invoke $htype, 0; |
|
|
507 | } |
|
|
508 | } |
|
|
509 | |
|
|
510 | # clear package objects |
|
|
511 | %$_ = () for values %{ $TERM->{_pkg} }; |
|
|
512 | |
|
|
513 | # clear package |
|
|
514 | %$TERM = (); |
|
|
515 | } |
|
|
516 | |
|
|
517 | $retval |
|
|
518 | } |
|
|
519 | |
|
|
520 | sub urxvt::term::proxy::AUTOLOAD { |
|
|
521 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
|
|
522 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
|
|
523 | |
|
|
524 | eval qq{ |
|
|
525 | sub $urxvt::term::proxy::AUTOLOAD { |
|
|
526 | my \$proxy = shift; |
|
|
527 | \$proxy->{term}->$1 (\@_) |
|
|
528 | } |
|
|
529 | 1 |
|
|
530 | } or die "FATAL: unable to compile method forwarder: $@"; |
|
|
531 | |
|
|
532 | goto &$urxvt::term::proxy::AUTOLOAD; |
|
|
533 | } |
233 | |
534 | |
234 | =head2 The C<urxvt::term> Class |
535 | =head2 The C<urxvt::term> Class |
235 | |
536 | |
236 | =over 4 |
537 | =over 4 |
|
|
538 | |
|
|
539 | =item $term->destroy |
|
|
540 | |
|
|
541 | Destroy the terminal object (close the window, free resources etc.). |
237 | |
542 | |
238 | =item $value = $term->resource ($name[, $newval]) |
543 | =item $value = $term->resource ($name[, $newval]) |
239 | |
544 | |
240 | Returns the current resource value associated with a given name and |
545 | Returns the current resource value associated with a given name and |
241 | optionally sets a new value. Setting values is most useful in the C<init> |
546 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
258 | |
563 | |
259 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
564 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
260 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
565 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
261 | display_name embed ext_bwidth fade font geometry hold iconName |
566 | display_name embed ext_bwidth fade font geometry hold iconName |
262 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
567 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
263 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 |
568 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
264 | modifier mouseWheelScrollPage name pastableTabs path pointerBlank |
569 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
265 | pointerBlankDelay preeditType print_pipe pty_fd reverseVideo saveLines |
570 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
266 | scrollBar scrollBar_align scrollBar_floating scrollBar_right |
571 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
267 | scrollBar_thickness scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
572 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
268 | scrollstyle secondaryScreen secondaryScroll selectstyle shade term_name |
573 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
269 | title transparent transparent_all tripleclickwords utmpInhibit |
574 | shade term_name title transparent transparent_all tripleclickwords |
270 | visualBell |
575 | utmpInhibit visualBell |
271 | |
576 | |
272 | =cut |
577 | =cut |
273 | |
578 | |
274 | sub urxvt::term::resource($$;$) { |
579 | sub urxvt::term::resource($$;$) { |
275 | my ($self, $name) = (shift, shift); |
580 | my ($self, $name) = (shift, shift); |
276 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
581 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
277 | goto &urxvt::term::_resource; |
582 | goto &urxvt::term::_resource; |
278 | } |
583 | } |
279 | |
584 | |
|
|
585 | =item $rend = $term->rstyle ([$new_rstyle]) |
|
|
586 | |
|
|
587 | Return and optionally change the current rendition. Text that is output by |
|
|
588 | the terminal application will use this style. |
|
|
589 | |
|
|
590 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
591 | |
|
|
592 | Return the current coordinates of the text cursor position and optionally |
|
|
593 | set it (which is usually bad as applications don't expect that). |
|
|
594 | |
280 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
595 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
281 | |
596 | |
282 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
597 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
283 | |
598 | |
284 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
599 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
… | |
… | |
293 | |
608 | |
294 | =item $oldtext = $term->selection ([$newtext]) |
609 | =item $oldtext = $term->selection ([$newtext]) |
295 | |
610 | |
296 | Return the current selection text and optionally replace it by C<$newtext>. |
611 | Return the current selection text and optionally replace it by C<$newtext>. |
297 | |
612 | |
298 | =item $term->scr_overlay ($x, $y, $text) |
613 | #=item $term->overlay ($x, $y, $text) |
299 | |
614 | # |
300 | Create a simple multi-line overlay box. See the next method for details. |
615 | #Create a simple multi-line overlay box. See the next method for details. |
|
|
616 | # |
|
|
617 | #=cut |
|
|
618 | # |
|
|
619 | #sub urxvt::term::scr_overlay { |
|
|
620 | # my ($self, $x, $y, $text) = @_; |
|
|
621 | # |
|
|
622 | # my @lines = split /\n/, $text; |
|
|
623 | # |
|
|
624 | # my $w = 0; |
|
|
625 | # for (map $self->strwidth ($_), @lines) { |
|
|
626 | # $w = $_ if $w < $_; |
|
|
627 | # } |
|
|
628 | # |
|
|
629 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
|
|
630 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
631 | #} |
|
|
632 | |
|
|
633 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
|
|
634 | |
|
|
635 | Create a new (empty) overlay at the given position with the given |
|
|
636 | width/height. C<$rstyle> defines the initial rendition style |
|
|
637 | (default: C<OVERLAY_RSTYLE>). |
|
|
638 | |
|
|
639 | If C<$border> is C<2> (default), then a decorative border will be put |
|
|
640 | around the box. |
|
|
641 | |
|
|
642 | If either C<$x> or C<$y> is negative, then this is counted from the |
|
|
643 | right/bottom side, respectively. |
|
|
644 | |
|
|
645 | This method returns an urxvt::overlay object. The overlay will be visible |
|
|
646 | as long as the perl object is referenced. |
|
|
647 | |
|
|
648 | The methods currently supported on C<urxvt::overlay> objects are: |
|
|
649 | |
|
|
650 | =over 4 |
|
|
651 | |
|
|
652 | =item $overlay->set ($x, $y, $text, $rend) |
|
|
653 | |
|
|
654 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
|
|
655 | text in rxvt-unicode's special encoding and an array of rendition values |
|
|
656 | at a specific position inside the overlay. |
|
|
657 | |
|
|
658 | =item $overlay->hide |
|
|
659 | |
|
|
660 | If visible, hide the overlay, but do not destroy it. |
|
|
661 | |
|
|
662 | =item $overlay->show |
|
|
663 | |
|
|
664 | If hidden, display the overlay again. |
|
|
665 | |
|
|
666 | =back |
|
|
667 | |
|
|
668 | =item $cellwidth = $term->strwidth $string |
|
|
669 | |
|
|
670 | Returns the number of screen-cells this string would need. Correctly |
|
|
671 | accounts for wide and combining characters. |
|
|
672 | |
|
|
673 | =item $octets = $term->locale_encode $string |
|
|
674 | |
|
|
675 | Convert the given text string into the corresponding locale encoding. |
|
|
676 | |
|
|
677 | =item $string = $term->locale_decode $octets |
|
|
678 | |
|
|
679 | Convert the given locale-encoded octets into a perl string. |
|
|
680 | |
|
|
681 | =item $term->scr_add_lines ($string) |
|
|
682 | |
|
|
683 | Write the given text string to the screen, as if output by the application |
|
|
684 | running inside the terminal. It may not contain command sequences (escape |
|
|
685 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
686 | string is a normal text string, not in locale-dependent encoding. |
|
|
687 | |
|
|
688 | Normally its not a good idea to use this function, as programs might be |
|
|
689 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
690 | C<on_add_lines> hook, though. |
|
|
691 | |
|
|
692 | =item $term->cmd_parse ($octets) |
|
|
693 | |
|
|
694 | Similar to C<scr_add_lines>, but the argument must be in the |
|
|
695 | locale-specific encoding of the terminal and can contain command sequences |
|
|
696 | (escape codes) that will be interpreted. |
|
|
697 | |
|
|
698 | =item $term->tt_write ($octets) |
|
|
699 | |
|
|
700 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
|
|
701 | pass characters instead of octets, you should convert your strings first |
|
|
702 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
703 | |
|
|
704 | =item $window_width = $term->width |
|
|
705 | |
|
|
706 | =item $window_height = $term->height |
|
|
707 | |
|
|
708 | =item $font_width = $term->fwidth |
|
|
709 | |
|
|
710 | =item $font_height = $term->fheight |
|
|
711 | |
|
|
712 | =item $font_ascent = $term->fbase |
|
|
713 | |
|
|
714 | =item $terminal_rows = $term->nrow |
|
|
715 | |
|
|
716 | =item $terminal_columns = $term->ncol |
|
|
717 | |
|
|
718 | =item $has_focus = $term->focus |
|
|
719 | |
|
|
720 | =item $is_mapped = $term->mapped |
|
|
721 | |
|
|
722 | =item $max_scrollback = $term->saveLines |
|
|
723 | |
|
|
724 | =item $nrow_plus_saveLines = $term->total_rows |
|
|
725 | |
|
|
726 | =item $lines_in_scrollback = $term->nsaved |
|
|
727 | |
|
|
728 | Return various integers describing terminal characteristics. |
|
|
729 | |
|
|
730 | =item $view_start = $term->view_start ([$newvalue]) |
|
|
731 | |
|
|
732 | Returns the negative row number of the topmost line. Minimum value is |
|
|
733 | C<0>, which displays the normal terminal contents. Larger values scroll |
|
|
734 | this many lines into the scrollback buffer. |
|
|
735 | |
|
|
736 | =item $term->want_refresh |
|
|
737 | |
|
|
738 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
|
|
739 | compare the on-screen display with its stored representation. If they |
|
|
740 | differ, it redraws the differences. |
|
|
741 | |
|
|
742 | Used after changing terminal contents to display them. |
|
|
743 | |
|
|
744 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
|
|
745 | |
|
|
746 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
|
|
747 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
|
|
748 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
749 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
|
|
750 | is requested. |
|
|
751 | |
|
|
752 | If C<$new_text> is specified, it will replace characters in the current |
|
|
753 | line, starting at column C<$start_col> (default C<0>), which is useful |
|
|
754 | to replace only parts of a line. The font index in the rendition will |
|
|
755 | automatically be updated. |
|
|
756 | |
|
|
757 | C<$text> is in a special encoding: tabs and wide characters that use more |
|
|
758 | than one cell when displayed are padded with urxvt::NOCHAR characters |
|
|
759 | (C<chr 65535>). Characters with combining characters and other characters |
|
|
760 | that do not fit into the normal tetx encoding will be replaced with |
|
|
761 | characters in the private use area. |
|
|
762 | |
|
|
763 | You have to obey this encoding when changing text. The advantage is |
|
|
764 | that C<substr> and similar functions work on screen cells and not on |
|
|
765 | characters. |
|
|
766 | |
|
|
767 | The methods C<< $term->special_encode >> and C<< $term->special_decode >> |
|
|
768 | can be used to convert normal strings into this encoding and vice versa. |
|
|
769 | |
|
|
770 | =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]]) |
|
|
771 | |
|
|
772 | Like C<< $term->ROW_t >>, but returns an arrayref with rendition |
|
|
773 | bitsets. Rendition bitsets contain information about colour, font, font |
|
|
774 | styles and similar information. See also C<< $term->ROW_t >>. |
|
|
775 | |
|
|
776 | When setting rendition, the font mask will be ignored. |
|
|
777 | |
|
|
778 | See the section on RENDITION, above. |
|
|
779 | |
|
|
780 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
|
|
781 | |
|
|
782 | Returns the number of screen cells that are in use ("the line |
|
|
783 | length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the |
|
|
784 | line is joined with the following one. |
|
|
785 | |
|
|
786 | =item $bool = $term->is_longer ($row_number) |
|
|
787 | |
|
|
788 | Returns true if the row is part of a multiple-row logical "line" (i.e. |
|
|
789 | joined with the following row), which means all characters are in use |
|
|
790 | and it is continued on the next row (and possibly a continuation of the |
|
|
791 | previous row(s)). |
|
|
792 | |
|
|
793 | =item $line = $term->line ($row_number) |
|
|
794 | |
|
|
795 | Create and return a new C<urxvt::line> object that stores information |
|
|
796 | about the logical line that row C<$row_number> is part of. It supports the |
|
|
797 | following methods: |
|
|
798 | |
|
|
799 | =over 4 |
|
|
800 | |
|
|
801 | =item $text = $line->t ([$new_text]) |
|
|
802 | |
|
|
803 | Returns or replaces the full text of the line, similar to C<ROW_t> |
|
|
804 | |
|
|
805 | =item $rend = $line->r ([$new_rend]) |
|
|
806 | |
|
|
807 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
|
|
808 | |
|
|
809 | =item $length = $line->l |
|
|
810 | |
|
|
811 | Returns the length of the line in cells, similar to C<ROW_l>. |
|
|
812 | |
|
|
813 | =item $rownum = $line->beg |
|
|
814 | |
|
|
815 | =item $rownum = $line->end |
|
|
816 | |
|
|
817 | Return the row number of the first/last row of the line, respectively. |
|
|
818 | |
|
|
819 | =item $offset = $line->offset_of ($row, $col) |
|
|
820 | |
|
|
821 | Returns the character offset of the given row|col pair within the logical |
|
|
822 | line. |
|
|
823 | |
|
|
824 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
825 | |
|
|
826 | Translates a string offset into terminal coordinates again. |
|
|
827 | |
|
|
828 | =back |
301 | |
829 | |
302 | =cut |
830 | =cut |
303 | |
831 | |
304 | sub urxvt::term::scr_overlay { |
832 | sub urxvt::term::line { |
305 | my ($self, $x, $y, $text) = @_; |
833 | my ($self, $row) = @_; |
306 | |
834 | |
307 | my @lines = split /\n/, $text; |
835 | my $maxrow = $self->nrow - 1; |
308 | |
836 | |
309 | my $w = 0; |
837 | my ($beg, $end) = ($row, $row); |
310 | for (map urxvt::wcswidth $_, @lines) { |
838 | |
311 | $w = $_ if $w < $_; |
839 | --$beg while $self->ROW_is_longer ($beg - 1); |
|
|
840 | ++$end while $self->ROW_is_longer ($end) && $end < $maxrow; |
|
|
841 | |
|
|
842 | bless { |
|
|
843 | term => $self, |
|
|
844 | beg => $beg, |
|
|
845 | end => $end, |
|
|
846 | ncol => $self->ncol, |
|
|
847 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
|
|
848 | }, urxvt::line:: |
|
|
849 | } |
|
|
850 | |
|
|
851 | sub urxvt::line::t { |
|
|
852 | my ($self) = @_; |
|
|
853 | |
|
|
854 | if (@_ > 1) |
|
|
855 | { |
|
|
856 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
857 | for $self->{beg} .. $self->{end}; |
|
|
858 | } |
|
|
859 | |
|
|
860 | defined wantarray && |
|
|
861 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
|
|
862 | 0, $self->{len} |
|
|
863 | } |
|
|
864 | |
|
|
865 | sub urxvt::line::r { |
|
|
866 | my ($self) = @_; |
|
|
867 | |
|
|
868 | if (@_ > 1) |
|
|
869 | { |
|
|
870 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
871 | for $self->{beg} .. $self->{end}; |
|
|
872 | } |
|
|
873 | |
|
|
874 | if (defined wantarray) { |
|
|
875 | my $rend = [ |
|
|
876 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
|
|
877 | ]; |
|
|
878 | $#$rend = $self->{len} - 1; |
|
|
879 | return $rend; |
312 | } |
880 | } |
313 | |
881 | |
314 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
882 | () |
315 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
316 | } |
883 | } |
317 | |
884 | |
318 | =item $term->scr_overlay_new ($x, $y, $width, $height) |
885 | sub urxvt::line::beg { $_[0]{beg} } |
|
|
886 | sub urxvt::line::end { $_[0]{end} } |
|
|
887 | sub urxvt::line::l { $_[0]{len} } |
319 | |
888 | |
320 | Create a new (empty) overlay at the given position with the given |
889 | sub urxvt::line::offset_of { |
321 | width/height. A border will be put around the box. If either C<$x> or |
890 | my ($self, $row, $col) = @_; |
322 | C<$y> is negative, then this is counted from the right/bottom side, |
|
|
323 | respectively. |
|
|
324 | |
891 | |
325 | =item $term->scr_overlay_off |
892 | ($row - $self->{beg}) * $self->{ncol} + $col |
|
|
893 | } |
326 | |
894 | |
327 | Switch the overlay off again. |
895 | sub urxvt::line::coord_of { |
|
|
896 | my ($self, $offset) = @_; |
328 | |
897 | |
329 | =item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) |
898 | use integer; |
330 | |
899 | |
331 | Put a single character (specified numerically) at the given overlay |
900 | ( |
332 | position. |
901 | $offset / $self->{ncol} + $self->{beg}, |
|
|
902 | $offset % $self->{ncol} |
|
|
903 | ) |
|
|
904 | } |
333 | |
905 | |
334 | =item $term->scr_overlay_set ($x, $y, $text) |
906 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
907 | =item $text = $term->special_encode $string |
335 | |
908 | |
336 | Write a string at the given position into the overlay. |
909 | Converts a perl string into the special encoding used by rxvt-unicode, |
|
|
910 | where one character corresponds to one screen cell. See |
|
|
911 | C<< $term->ROW_t >> for details. |
|
|
912 | |
|
|
913 | =item $string = $term->special_decode $text |
|
|
914 | |
|
|
915 | Converts rxvt-unicodes text reprsentation into a perl string. See |
|
|
916 | C<< $term->ROW_t >> for details. |
337 | |
917 | |
338 | =back |
918 | =back |
339 | |
919 | |
340 | =head2 The C<urxvt::timer> Class |
920 | =head2 The C<urxvt::timer> Class |
341 | |
921 | |
342 | This class implements timer watchers/events. Time is represented as a |
922 | This class implements timer watchers/events. Time is represented as a |
343 | fractional number of seconds since the epoch. Example: |
923 | fractional number of seconds since the epoch. Example: |
344 | |
924 | |
345 | # create a digital clock display in upper right corner |
925 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
346 | $term->{timer} = urxvt::timer |
926 | $term->{timer} = urxvt::timer |
347 | ->new |
927 | ->new |
348 | ->start (urxvt::NOW) |
928 | ->interval (1) |
349 | ->cb (sub { |
929 | ->cb (sub { |
350 | my ($timer) = @_; |
|
|
351 | my $time = $timer->at; |
|
|
352 | $timer->start ($time + 1); |
|
|
353 | $self->scr_overlay (-1, 0, |
930 | $term->{overlay}->set (0, 0, |
354 | POSIX::strftime "%H:%M:%S", localtime $time); |
931 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
355 | }); |
932 | }); |
356 | |
933 | |
357 | =over 4 |
934 | =over 4 |
358 | |
935 | |
359 | =item $timer = new urxvt::timer |
936 | =item $timer = new urxvt::timer |
360 | |
937 | |
361 | Create a new timer object in stopped state. |
938 | Create a new timer object in started state. It is scheduled to fire |
|
|
939 | immediately. |
362 | |
940 | |
363 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
941 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
364 | |
942 | |
365 | Set the callback to be called when the timer triggers. |
943 | Set the callback to be called when the timer triggers. |
366 | |
944 | |
… | |
… | |
369 | Return the time this watcher will fire next. |
947 | Return the time this watcher will fire next. |
370 | |
948 | |
371 | =item $timer = $timer->set ($tstamp) |
949 | =item $timer = $timer->set ($tstamp) |
372 | |
950 | |
373 | Set the time the event is generated to $tstamp. |
951 | Set the time the event is generated to $tstamp. |
|
|
952 | |
|
|
953 | =item $timer = $timer->interval ($interval) |
|
|
954 | |
|
|
955 | Normally (and when C<$interval> is C<0>), the timer will automatically |
|
|
956 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
|
|
957 | is automatically rescheduled at the given intervals. |
374 | |
958 | |
375 | =item $timer = $timer->start |
959 | =item $timer = $timer->start |
376 | |
960 | |
377 | Start the timer. |
961 | Start the timer. |
378 | |
962 | |
… | |
… | |
441 | This variable controls the verbosity level of the perl extension. Higher |
1025 | This variable controls the verbosity level of the perl extension. Higher |
442 | numbers indicate more verbose output. |
1026 | numbers indicate more verbose output. |
443 | |
1027 | |
444 | =over 4 |
1028 | =over 4 |
445 | |
1029 | |
446 | =item 0 - only fatal messages |
1030 | =item =0 - only fatal messages |
447 | |
1031 | |
448 | =item 3 - script loading and management |
1032 | =item =3 - script loading and management |
449 | |
1033 | |
450 | =item 10 - all events received |
1034 | =item =10 - all events received |
451 | |
1035 | |
452 | =back |
1036 | =back |
453 | |
1037 | |
454 | =head1 AUTHOR |
1038 | =head1 AUTHOR |
455 | |
1039 | |