… | |
… | |
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 | =head2 Prepackaged Extensions |
31 | =head1 PREPACKAGED EXTENSIONS |
32 | |
32 | |
33 | This section describes the extensiosn delivered with this version. You can |
33 | This section describes the extensions delivered with this release. You can |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
35 | |
35 | |
36 | You can activate them like this: |
36 | You can activate them like this: |
37 | |
37 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
38 | @@RXVT_NAME@@ -pe <extensionname> |
39 | |
39 | |
40 | =over 4 |
40 | =over 4 |
41 | |
41 | |
42 | =item selection |
42 | =item selection (enabled by default) |
43 | |
43 | |
44 | Intelligent selection. This extension tries to be more intelligent when |
44 | (More) intelligent selection. This extension tries to be more intelligent |
45 | the user extends selections (double-click). Right now, it tries to select |
45 | when the user extends selections (double-click). Right now, it tries to |
46 | urls and complete shell-quoted arguments, which is very convenient, too, |
46 | select urls and complete shell-quoted arguments, which is very convenient, |
47 | if your F<ls> supports C<--quoting-style=shell>. |
47 | too, if your F<ls> supports C<--quoting-style=shell>. |
48 | |
48 | |
49 | It also offers the following bindable event: |
49 | It also offers the following bindable keyboard command: |
50 | |
50 | |
51 | =over 4 |
51 | =over 4 |
52 | |
52 | |
53 | =item rot13 |
53 | =item rot13 |
54 | |
54 | |
55 | Rot-13 the selection when activated. Used via keyboard trigger: |
55 | Rot-13 the selection when activated. Used via keyboard trigger: |
56 | |
56 | |
57 | URxvt.keysym.C-M-r: perl:selection:rot13 |
57 | URxvt.keysym.C-M-r: perl:selection:rot13 |
58 | |
58 | |
59 | =back |
59 | =back |
|
|
60 | |
|
|
61 | =item option-popup (enabled by default) |
|
|
62 | |
|
|
63 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
|
|
64 | runtime. |
|
|
65 | |
|
|
66 | =item selection-popup (enabled by default) |
|
|
67 | |
|
|
68 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
69 | text into various other formats/action (such as uri unescaping, perl |
|
|
70 | evalution, web-browser starting etc.), depending on content. |
|
|
71 | |
|
|
72 | =item searchable-scrollback<hotkey> (enabled by default) |
|
|
73 | |
|
|
74 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
75 | by a hotkey (default: C<M-s>). When in search mode, normal terminal |
|
|
76 | input/output is suspended. |
|
|
77 | |
|
|
78 | C</> starts an incremental regex search, C<n> searches further, C<p> or |
|
|
79 | C<N> jump to the previous match, C<G> jumps to the bottom and clears the |
|
|
80 | history, C<enter> leaves search mode at the current position and C<escape> |
|
|
81 | returns to the original position. |
60 | |
82 | |
61 | =item digital-clock |
83 | =item digital-clock |
62 | |
84 | |
63 | Displays a digital clock using the built-in overlay. |
85 | Displays a digital clock using the built-in overlay. |
64 | |
86 | |
… | |
… | |
77 | Displays a very simple digital clock in the upper right corner of the |
99 | Displays a very simple digital clock in the upper right corner of the |
78 | window. Illustrates overwriting the refresh callbacks to create your own |
100 | window. Illustrates overwriting the refresh callbacks to create your own |
79 | overlays or changes. |
101 | overlays or changes. |
80 | |
102 | |
81 | =back |
103 | =back |
|
|
104 | |
|
|
105 | =head1 API DOCUMENTATION |
82 | |
106 | |
83 | =head2 General API Considerations |
107 | =head2 General API Considerations |
84 | |
108 | |
85 | All objects (such as terminals, time watchers etc.) are typical |
109 | All objects (such as terminals, time watchers etc.) are typical |
86 | reference-to-hash objects. The hash can be used to store anything you |
110 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
99 | =over 4 |
123 | =over 4 |
100 | |
124 | |
101 | =item $text |
125 | =item $text |
102 | |
126 | |
103 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
127 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
104 | always represents one screen cell. See L<row_t> for a discussion of this format. |
128 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
105 | |
129 | |
106 | =item $string |
130 | =item $string |
107 | |
131 | |
108 | A perl text string, with an emphasis on I<text>. It can store all unicode |
132 | A perl text string, with an emphasis on I<text>. It can store all unicode |
109 | characters and is to be distinguished with text encoded in a specific |
133 | characters and is to be distinguished with text encoded in a specific |
… | |
… | |
114 | Either binary data or - more common - a text string encoded in a |
138 | Either binary data or - more common - a text string encoded in a |
115 | locale-specific way. |
139 | locale-specific way. |
116 | |
140 | |
117 | =back |
141 | =back |
118 | |
142 | |
|
|
143 | =head2 Extension Objects |
|
|
144 | |
|
|
145 | Very perl extension is a perl class. A separate perl object is created |
|
|
146 | for each terminal and each extension and passed as the first parameter to |
|
|
147 | hooks. So extensions can use their C<$self> object without having to think |
|
|
148 | about other extensions, with the exception of methods and members that |
|
|
149 | begin with an underscore character C<_>: these are reserved for internal |
|
|
150 | use. |
|
|
151 | |
|
|
152 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
|
|
153 | C<urxvt::term> class on this object. |
|
|
154 | |
|
|
155 | It has the following methods and data members: |
|
|
156 | |
|
|
157 | =over 4 |
|
|
158 | |
|
|
159 | =item $urxvt_term = $self->{term} |
|
|
160 | |
|
|
161 | Returns the C<urxvt::term> object associated with this instance of the |
|
|
162 | extension. This member I<must not> be changed in any way. |
|
|
163 | |
|
|
164 | =item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
165 | |
|
|
166 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
167 | this extension, replacing any previous hook. This is useful when you want |
|
|
168 | to overwrite time-critical hooks only temporarily. |
|
|
169 | |
|
|
170 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
171 | |
|
|
172 | Dynamically disable the given hooks. |
|
|
173 | |
|
|
174 | =back |
|
|
175 | |
119 | =head2 Hooks |
176 | =head2 Hooks |
120 | |
177 | |
121 | The following subroutines can be declared in extension files, and will be |
178 | The following subroutines can be declared in extension files, and will be |
122 | called whenever the relevant event happens. |
179 | called whenever the relevant event happens. |
123 | |
180 | |
124 | The first argument passed to them is an object private to each terminal |
181 | The first argument passed to them is an extension oject as described in |
125 | and extension package. You can call all C<urxvt::term> methods on it, but |
182 | the in the C<Extension Objects> section. |
126 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
|
|
127 | object that is shared between all packages is stored in the C<term> |
|
|
128 | member. It is, however, blessed intot he package of the extension script, |
|
|
129 | so for all practical purposes you can treat an extension script as a class. |
|
|
130 | |
183 | |
131 | All of them must return a boolean value. If it is true, then the event |
184 | B<All> of these hooks must return a boolean value. If it is true, then the |
132 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
185 | event counts as being I<consumed>, and the invocation of other hooks is |
133 | and the relevant action might not be carried out by the C++ code. |
186 | skipped, and the relevant action might not be carried out by the C++ code. |
134 | |
187 | |
135 | When in doubt, return a false value (preferably C<()>). |
188 | I<< When in doubt, return a false value (preferably C<()>). >> |
136 | |
189 | |
137 | =over 4 |
190 | =over 4 |
138 | |
191 | |
139 | =item on_init $term |
192 | =item on_init $term |
140 | |
193 | |
… | |
… | |
194 | than the scroll back buffer or the terminal. |
247 | than the scroll back buffer or the terminal. |
195 | |
248 | |
196 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
249 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
197 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
250 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
198 | number of lines that will be in the scrollback buffer. |
251 | number of lines that will be in the scrollback buffer. |
199 | |
|
|
200 | =item on_tty_activity $term *NYI* |
|
|
201 | |
|
|
202 | Called whenever the program(s) running in the urxvt window send output. |
|
|
203 | |
252 | |
204 | =item on_osc_seq $term, $string |
253 | =item on_osc_seq $term, $string |
205 | |
254 | |
206 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
255 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
207 | operating system command) is processed. Cursor position and other state |
256 | operating system command) is processed. Cursor position and other state |
… | |
… | |
220 | can filter/change and output the text yourself by returning a true value |
269 | can filter/change and output the text yourself by returning a true value |
221 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
270 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
222 | might be very slow, however, as your hook is called for B<all> text being |
271 | might be very slow, however, as your hook is called for B<all> text being |
223 | output. |
272 | output. |
224 | |
273 | |
|
|
274 | =item on_tt_write $term, $octets |
|
|
275 | |
|
|
276 | Called whenever some data is written to the tty/pty and can be used to |
|
|
277 | suppress or filter tty input. |
|
|
278 | |
225 | =item on_line_update $term, $row |
279 | =item on_line_update $term, $row |
226 | |
280 | |
227 | Called whenever a line was updated or changed. Can be used to filter |
281 | Called whenever a line was updated or changed. Can be used to filter |
228 | screen output (e.g. underline urls or other useless stuff). Only lines |
282 | screen output (e.g. underline urls or other useless stuff). Only lines |
229 | that are being shown will be filtered, and, due to performance reasons, |
283 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
261 | =item on_focus_out $term |
315 | =item on_focus_out $term |
262 | |
316 | |
263 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
317 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
264 | focus out processing. |
318 | focus out processing. |
265 | |
319 | |
266 | =item on_key_press $term, $event, $octets |
320 | =item on_key_press $term, $event, $keysym, $octets |
267 | |
321 | |
268 | =item on_key_release $term, $event |
322 | =item on_key_release $term, $event, $keysym |
269 | |
323 | |
270 | =item on_button_press $term, $event |
324 | =item on_button_press $term, $event |
271 | |
325 | |
272 | =item on_button_release $term, $event |
326 | =item on_button_release $term, $event |
273 | |
327 | |
… | |
… | |
289 | |
343 | |
290 | subwindow. |
344 | subwindow. |
291 | |
345 | |
292 | =back |
346 | =back |
293 | |
347 | |
|
|
348 | =cut |
|
|
349 | |
|
|
350 | package urxvt; |
|
|
351 | |
|
|
352 | use utf8; |
|
|
353 | use strict; |
|
|
354 | use Carp (); |
|
|
355 | use Scalar::Util (); |
|
|
356 | use List::Util (); |
|
|
357 | |
|
|
358 | our $VERSION = 1; |
|
|
359 | our $TERM; |
|
|
360 | our @HOOKNAME; |
|
|
361 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
|
|
362 | our %OPTION; |
|
|
363 | |
|
|
364 | our $LIBDIR; |
|
|
365 | our $RESNAME; |
|
|
366 | our $RESCLASS; |
|
|
367 | our $RXVTNAME; |
|
|
368 | |
294 | =head2 Variables in the C<urxvt> Package |
369 | =head2 Variables in the C<urxvt> Package |
295 | |
370 | |
296 | =over 4 |
371 | =over 4 |
|
|
372 | |
|
|
373 | =item $urxvt::LIBDIR |
|
|
374 | |
|
|
375 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
376 | modules and scripts are stored. |
|
|
377 | |
|
|
378 | =item $urxvt::RESCLASS, $urxvt::RESCLASS |
|
|
379 | |
|
|
380 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
381 | |
|
|
382 | =item $urxvt::RXVTNAME |
|
|
383 | |
|
|
384 | The basename of the installed binaries, usually C<urxvt>. |
297 | |
385 | |
298 | =item $urxvt::TERM |
386 | =item $urxvt::TERM |
299 | |
387 | |
300 | The current terminal. This variable stores the current C<urxvt::term> |
388 | The current terminal. This variable stores the current C<urxvt::term> |
301 | object, whenever a callback/hook is executing. |
389 | object, whenever a callback/hook is executing. |
… | |
… | |
303 | =back |
391 | =back |
304 | |
392 | |
305 | =head2 Functions in the C<urxvt> Package |
393 | =head2 Functions in the C<urxvt> Package |
306 | |
394 | |
307 | =over 4 |
395 | =over 4 |
308 | |
|
|
309 | =item $term = new urxvt [arg...] |
|
|
310 | |
|
|
311 | Creates a new terminal, very similar as if you had started it with |
|
|
312 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
313 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
314 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
315 | C<init> and C<start> hooks will be called during the call. |
|
|
316 | |
396 | |
317 | =item urxvt::fatal $errormessage |
397 | =item urxvt::fatal $errormessage |
318 | |
398 | |
319 | Fatally aborts execution with the given error message. Avoid at all |
399 | Fatally aborts execution with the given error message. Avoid at all |
320 | costs! The only time this is acceptable is when the terminal process |
400 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
327 | that calls this function. |
407 | that calls this function. |
328 | |
408 | |
329 | Using this function has the advantage that its output ends up in the |
409 | Using this function has the advantage that its output ends up in the |
330 | correct place, e.g. on stderr of the connecting urxvtc client. |
410 | correct place, e.g. on stderr of the connecting urxvtc client. |
331 | |
411 | |
|
|
412 | Messages have a size limit of 1023 bytes currently. |
|
|
413 | |
|
|
414 | =item $is_safe = urxvt::safe |
|
|
415 | |
|
|
416 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
417 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
418 | started setuid or setgid. |
|
|
419 | |
332 | =item $time = urxvt::NOW |
420 | =item $time = urxvt::NOW |
333 | |
421 | |
334 | Returns the "current time" (as per the event loop). |
422 | Returns the "current time" (as per the event loop). |
335 | |
423 | |
336 | =item urxvt::CurrentTime |
424 | =item urxvt::CurrentTime |
337 | |
425 | |
338 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
426 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
339 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
427 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
340 | Button4Mask, Button5Mask, AnyModifier |
428 | Button4Mask, Button5Mask, AnyModifier |
341 | |
429 | |
342 | Various constants for use in X events. |
430 | Various constants for use in X calls and event processing. |
343 | |
431 | |
344 | =back |
432 | =back |
345 | |
433 | |
346 | =head2 RENDITION |
434 | =head2 RENDITION |
347 | |
435 | |
… | |
… | |
374 | |
462 | |
375 | =item $background = urxvt::GET_BASEBG $rend |
463 | =item $background = urxvt::GET_BASEBG $rend |
376 | |
464 | |
377 | Return the foreground/background colour index, respectively. |
465 | Return the foreground/background colour index, respectively. |
378 | |
466 | |
379 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
467 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
380 | |
468 | |
381 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
469 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
382 | |
470 | |
383 | Replace the foreground/background colour in the rendition mask with the |
471 | Replace the foreground/background colour in the rendition mask with the |
384 | specified one. |
472 | specified one. |
385 | |
473 | |
386 | =item $value = urxvt::GET_CUSTOM ($rend) |
474 | =item $value = urxvt::GET_CUSTOM $rend |
387 | |
475 | |
388 | Return the "custom" value: Every rendition has 5 bits for use by |
476 | Return the "custom" value: Every rendition has 5 bits for use by |
389 | extensions. They can be set and changed as you like and are initially |
477 | extensions. They can be set and changed as you like and are initially |
390 | zero. |
478 | zero. |
391 | |
479 | |
392 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
480 | =item $rend = urxvt::SET_CUSTOM $rend, $new_value |
393 | |
481 | |
394 | Change the custom value. |
482 | Change the custom value. |
395 | |
483 | |
396 | =back |
484 | =back |
397 | |
485 | |
398 | =cut |
486 | =cut |
399 | |
|
|
400 | package urxvt; |
|
|
401 | |
|
|
402 | use utf8; |
|
|
403 | use strict; |
|
|
404 | use Scalar::Util (); |
|
|
405 | use List::Util (); |
|
|
406 | |
|
|
407 | our $TERM; |
|
|
408 | our @HOOKNAME; |
|
|
409 | our $LIBDIR; |
|
|
410 | |
487 | |
411 | BEGIN { |
488 | BEGIN { |
412 | urxvt->bootstrap; |
489 | urxvt->bootstrap; |
413 | |
490 | |
414 | # overwrite perl's warn |
491 | # overwrite perl's warn |
… | |
… | |
416 | my $msg = join "", @_; |
493 | my $msg = join "", @_; |
417 | $msg .= "\n" |
494 | $msg .= "\n" |
418 | unless $msg =~ /\n$/; |
495 | unless $msg =~ /\n$/; |
419 | urxvt::warn ($msg); |
496 | urxvt::warn ($msg); |
420 | }; |
497 | }; |
|
|
498 | |
|
|
499 | delete $ENV{IFS}; |
|
|
500 | delete $ENV{CDPATH}; |
|
|
501 | delete $ENV{BASH_ENV}; |
|
|
502 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
421 | } |
503 | } |
422 | |
504 | |
423 | my @hook_count; |
505 | my @hook_count; |
424 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
506 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
425 | |
507 | |
426 | sub verbose { |
508 | sub verbose { |
427 | my ($level, $msg) = @_; |
509 | my ($level, $msg) = @_; |
428 | warn "$msg\n" if $level <= $verbosity; |
510 | warn "$msg\n" if $level <= $verbosity; |
429 | } |
511 | } |
430 | |
512 | |
431 | # find on_xxx subs in the package and register them |
|
|
432 | # as hooks |
|
|
433 | sub register_package($) { |
|
|
434 | my ($pkg) = @_; |
|
|
435 | |
|
|
436 | for my $htype (0.. $#HOOKNAME) { |
|
|
437 | my $name = $HOOKNAME[$htype]; |
|
|
438 | |
|
|
439 | my $ref = $pkg->can ("on_" . lc $name) |
|
|
440 | or next; |
|
|
441 | |
|
|
442 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
|
|
443 | $hook_count[$htype]++ |
|
|
444 | or set_should_invoke $htype, 1; |
|
|
445 | } |
|
|
446 | } |
|
|
447 | |
|
|
448 | my $extension_pkg = "extension0000"; |
513 | my $extension_pkg = "extension0000"; |
449 | my %extension_pkg; |
514 | my %extension_pkg; |
450 | |
515 | |
451 | # load a single script into its own package, once only |
516 | # load a single script into its own package, once only |
452 | sub extension_package($) { |
517 | sub extension_package($) { |
… | |
… | |
458 | verbose 3, "loading extension '$path' into package '$pkg'"; |
523 | verbose 3, "loading extension '$path' into package '$pkg'"; |
459 | |
524 | |
460 | open my $fh, "<:raw", $path |
525 | open my $fh, "<:raw", $path |
461 | or die "$path: $!"; |
526 | or die "$path: $!"; |
462 | |
527 | |
|
|
528 | my $source = untaint |
463 | my $source = "package $pkg; use strict; use utf8;\n" |
529 | "package $pkg; use strict; use utf8;\n" |
464 | . "use base urxvt::term::proxy::;\n" |
530 | . "use base urxvt::term::extension::;\n" |
465 | . "#line 1 \"$path\"\n{\n" |
531 | . "#line 1 \"$path\"\n{\n" |
466 | . (do { local $/; <$fh> }) |
532 | . (do { local $/; <$fh> }) |
467 | . "\n};\n1"; |
533 | . "\n};\n1"; |
468 | |
534 | |
|
|
535 | eval $source |
469 | eval $source or die "$path: $@"; |
536 | or die "$path: $@"; |
470 | |
537 | |
471 | $pkg |
538 | $pkg |
472 | } |
539 | } |
473 | } |
540 | } |
474 | |
541 | |
… | |
… | |
479 | local $TERM = shift; |
546 | local $TERM = shift; |
480 | my $htype = shift; |
547 | my $htype = shift; |
481 | |
548 | |
482 | if ($htype == 0) { # INIT |
549 | if ($htype == 0) { # INIT |
483 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
550 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
|
|
551 | |
|
|
552 | my %ext_arg; |
484 | |
553 | |
485 | for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
554 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
|
|
555 | if ($_ eq "default") { |
|
|
556 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
|
|
557 | } elsif (/^-(.*)$/) { |
|
|
558 | delete $ext_arg{$1}; |
|
|
559 | } elsif (/^([^<]+)<(.*)>$/) { |
|
|
560 | push @{ $ext_arg{$1} }, $2; |
|
|
561 | } else { |
|
|
562 | $ext_arg{$_} ||= []; |
|
|
563 | } |
|
|
564 | } |
|
|
565 | |
|
|
566 | while (my ($ext, $argv) = each %ext_arg) { |
486 | my @files = grep -f $_, map "$_/$ext", @dirs; |
567 | my @files = grep -f $_, map "$_/$ext", @dirs; |
487 | |
568 | |
488 | if (@files) { |
569 | if (@files) { |
489 | register_package extension_package $files[0]; |
570 | $TERM->register_package (extension_package $files[0], $argv); |
490 | } else { |
571 | } else { |
491 | warn "perl extension '$ext' not found in perl library search path\n"; |
572 | warn "perl extension '$ext' not found in perl library search path\n"; |
492 | } |
573 | } |
493 | } |
574 | } |
|
|
575 | |
|
|
576 | eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); |
|
|
577 | warn $@ if $@; |
494 | } |
578 | } |
495 | |
579 | |
496 | $retval = undef; |
580 | $retval = undef; |
497 | |
581 | |
498 | if (my $cb = $TERM->{_hook}[$htype]) { |
582 | if (my $cb = $TERM->{_hook}[$htype]) { |
… | |
… | |
500 | if $verbosity >= 10; |
584 | if $verbosity >= 10; |
501 | |
585 | |
502 | keys %$cb; |
586 | keys %$cb; |
503 | |
587 | |
504 | while (my ($pkg, $cb) = each %$cb) { |
588 | while (my ($pkg, $cb) = each %$cb) { |
505 | eval { |
589 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
506 | $retval = $cb->( |
|
|
507 | $TERM->{_pkg}{$pkg} ||= do { |
|
|
508 | my $proxy = bless { }, $pkg; |
|
|
509 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
510 | $proxy |
|
|
511 | }, |
|
|
512 | @_, |
|
|
513 | ) and last; |
590 | and last; |
|
|
591 | |
|
|
592 | if ($@) { |
|
|
593 | $TERM->ungrab; # better to lose the grab than the session |
|
|
594 | warn $@; |
514 | }; |
595 | } |
515 | warn $@ if $@;#d# |
|
|
516 | } |
596 | } |
517 | } |
597 | } |
518 | |
598 | |
519 | if ($htype == 1) { # DESTROY |
599 | if ($htype == 1) { # DESTROY |
520 | # remove hooks if unused |
|
|
521 | if (my $hook = $TERM->{_hook}) { |
600 | if (my $hook = delete $TERM->{_hook}) { |
522 | for my $htype (0..$#$hook) { |
601 | for my $htype (0..$#$hook) { |
523 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
602 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
524 | or set_should_invoke $htype, 0; |
603 | or set_should_invoke $htype, 0; |
525 | } |
604 | } |
526 | } |
605 | } |
… | |
… | |
533 | } |
612 | } |
534 | |
613 | |
535 | $retval |
614 | $retval |
536 | } |
615 | } |
537 | |
616 | |
538 | sub urxvt::term::proxy::AUTOLOAD { |
617 | # urxvt::term::extension |
539 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
618 | |
|
|
619 | package urxvt::term::extension; |
|
|
620 | |
|
|
621 | sub enable { |
|
|
622 | my ($self, %hook) = @_; |
|
|
623 | my $pkg = $self->{_pkg}; |
|
|
624 | |
|
|
625 | while (my ($name, $cb) = each %hook) { |
|
|
626 | my $htype = $HOOKTYPE{uc $name}; |
|
|
627 | defined $htype |
|
|
628 | or Carp::croak "unsupported hook type '$name'"; |
|
|
629 | |
|
|
630 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
|
|
631 | $hook_count[$htype]++ |
|
|
632 | or urxvt::set_should_invoke $htype, 1; |
|
|
633 | } |
|
|
634 | |
|
|
635 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
636 | } |
|
|
637 | } |
|
|
638 | |
|
|
639 | sub disable { |
|
|
640 | my ($self, @hook) = @_; |
|
|
641 | my $pkg = $self->{_pkg}; |
|
|
642 | |
|
|
643 | for my $name (@hook) { |
|
|
644 | my $htype = $HOOKTYPE{uc $name}; |
|
|
645 | defined $htype |
|
|
646 | or Carp::croak "unsupported hook type '$name'"; |
|
|
647 | |
|
|
648 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
|
|
649 | --$hook_count[$htype] |
|
|
650 | or urxvt::set_should_invoke $htype, 0; |
|
|
651 | } |
|
|
652 | } |
|
|
653 | } |
|
|
654 | |
|
|
655 | our $AUTOLOAD; |
|
|
656 | |
|
|
657 | sub AUTOLOAD { |
|
|
658 | $AUTOLOAD =~ /:([^:]+)$/ |
540 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
659 | or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable"; |
541 | |
660 | |
542 | eval qq{ |
661 | eval qq{ |
543 | sub $urxvt::term::proxy::AUTOLOAD { |
662 | sub $AUTOLOAD { |
544 | my \$proxy = shift; |
663 | my \$proxy = shift; |
545 | \$proxy->{term}->$1 (\@_) |
664 | \$proxy->{term}->$1 (\@_) |
546 | } |
665 | } |
547 | 1 |
666 | 1 |
548 | } or die "FATAL: unable to compile method forwarder: $@"; |
667 | } or die "FATAL: unable to compile method forwarder: $@"; |
549 | |
668 | |
550 | goto &$urxvt::term::proxy::AUTOLOAD; |
669 | goto &$AUTOLOAD; |
551 | } |
670 | } |
|
|
671 | |
|
|
672 | sub DESTROY { |
|
|
673 | # nop |
|
|
674 | } |
|
|
675 | |
|
|
676 | # urxvt::destroy_hook |
552 | |
677 | |
553 | sub urxvt::destroy_hook::DESTROY { |
678 | sub urxvt::destroy_hook::DESTROY { |
554 | ${$_[0]}->(); |
679 | ${$_[0]}->(); |
555 | } |
680 | } |
556 | |
681 | |
557 | sub urxvt::destroy_hook(&) { |
682 | sub urxvt::destroy_hook(&) { |
558 | bless \shift, urxvt::destroy_hook:: |
683 | bless \shift, urxvt::destroy_hook:: |
559 | } |
684 | } |
560 | |
685 | |
|
|
686 | package urxvt::anyevent; |
|
|
687 | |
|
|
688 | =head2 The C<urxvt::anyevent> Class |
|
|
689 | |
|
|
690 | The sole purpose of this class is to deliver an interface to the |
|
|
691 | C<AnyEvent> module - any module using it will work inside urxvt without |
|
|
692 | further programming. The only exception is that you cannot wait on |
|
|
693 | condition variables, but non-blocking condvar use is ok. What this means |
|
|
694 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
695 | work. |
|
|
696 | |
|
|
697 | =cut |
|
|
698 | |
|
|
699 | our $VERSION = 1; |
|
|
700 | |
|
|
701 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
|
|
702 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
|
|
703 | |
|
|
704 | sub timer { |
|
|
705 | my ($class, %arg) = @_; |
|
|
706 | |
|
|
707 | my $cb = $arg{cb}; |
|
|
708 | |
|
|
709 | urxvt::timer |
|
|
710 | ->new |
|
|
711 | ->start (urxvt::NOW + $arg{after}) |
|
|
712 | ->cb (sub { |
|
|
713 | $_[0]->stop; # need to cancel manually |
|
|
714 | $cb->(); |
|
|
715 | }) |
|
|
716 | } |
|
|
717 | |
|
|
718 | sub io { |
|
|
719 | my ($class, %arg) = @_; |
|
|
720 | |
|
|
721 | my $cb = $arg{cb}; |
|
|
722 | |
|
|
723 | bless [$arg{fh}, urxvt::iow |
|
|
724 | ->new |
|
|
725 | ->fd (fileno $arg{fh}) |
|
|
726 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
|
|
727 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
|
|
728 | ->start |
|
|
729 | ->cb (sub { |
|
|
730 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
731 | . ($_[1] & 2 ? 'w' : '')); |
|
|
732 | })], |
|
|
733 | urxvt::anyevent:: |
|
|
734 | } |
|
|
735 | |
|
|
736 | sub DESTROY { |
|
|
737 | $_[0][1]->stop; |
|
|
738 | } |
|
|
739 | |
|
|
740 | sub condvar { |
|
|
741 | bless \my $flag, urxvt::anyevent::condvar:: |
|
|
742 | } |
|
|
743 | |
|
|
744 | sub urxvt::anyevent::condvar::broadcast { |
|
|
745 | ${$_[0]}++; |
|
|
746 | } |
|
|
747 | |
|
|
748 | sub urxvt::anyevent::condvar::wait { |
|
|
749 | unless (${$_[0]}) { |
|
|
750 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
|
|
751 | } |
|
|
752 | } |
|
|
753 | |
|
|
754 | package urxvt::term; |
|
|
755 | |
561 | =head2 The C<urxvt::term> Class |
756 | =head2 The C<urxvt::term> Class |
562 | |
757 | |
563 | =over 4 |
758 | =over 4 |
564 | |
759 | |
|
|
760 | =cut |
|
|
761 | |
|
|
762 | # find on_xxx subs in the package and register them |
|
|
763 | # as hooks |
|
|
764 | sub register_package { |
|
|
765 | my ($self, $pkg, $argv) = @_; |
|
|
766 | |
|
|
767 | my $proxy = bless { |
|
|
768 | _pkg => $pkg, |
|
|
769 | argv => $argv, |
|
|
770 | }, $pkg; |
|
|
771 | Scalar::Util::weaken ($proxy->{term} = $self); |
|
|
772 | |
|
|
773 | $self->{_pkg}{$pkg} = $proxy; |
|
|
774 | |
|
|
775 | for my $name (@HOOKNAME) { |
|
|
776 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
|
|
777 | $proxy->enable ($name => $ref); |
|
|
778 | } |
|
|
779 | } |
|
|
780 | } |
|
|
781 | |
|
|
782 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
|
|
783 | |
|
|
784 | Creates a new terminal, very similar as if you had started it with system |
|
|
785 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
|
|
786 | hash which defines the environment of the new terminal. |
|
|
787 | |
|
|
788 | Croaks (and probably outputs an error message) if the new instance |
|
|
789 | couldn't be created. Returns C<undef> if the new instance didn't |
|
|
790 | initialise perl, and the terminal object otherwise. The C<init> and |
|
|
791 | C<start> hooks will be called during this call. |
|
|
792 | |
|
|
793 | =cut |
|
|
794 | |
|
|
795 | sub new { |
|
|
796 | my ($class, $env, @args) = @_; |
|
|
797 | |
|
|
798 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
|
|
799 | } |
|
|
800 | |
565 | =item $term->destroy |
801 | =item $term->destroy |
566 | |
802 | |
567 | Destroy the terminal object (close the window, free resources etc.). |
803 | Destroy the terminal object (close the window, free resources |
|
|
804 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
|
|
805 | watchers (timers, io watchers) are still active. |
|
|
806 | |
|
|
807 | =item $isset = $term->option ($optval[, $set]) |
|
|
808 | |
|
|
809 | Returns true if the option specified by C<$optval> is enabled, and |
|
|
810 | optionally change it. All option values are stored by name in the hash |
|
|
811 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
|
|
812 | |
|
|
813 | Here is a a likely non-exhaustive list of option names, please see the |
|
|
814 | source file F</src/optinc.h> to see the actual list: |
|
|
815 | |
|
|
816 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
|
|
817 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
|
|
818 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
|
|
819 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
|
|
820 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
|
|
821 | tripleclickwords utmpInhibit visualBell |
568 | |
822 | |
569 | =item $value = $term->resource ($name[, $newval]) |
823 | =item $value = $term->resource ($name[, $newval]) |
570 | |
824 | |
571 | Returns the current resource value associated with a given name and |
825 | Returns the current resource value associated with a given name and |
572 | optionally sets a new value. Setting values is most useful in the C<init> |
826 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
582 | |
836 | |
583 | Please note that resource strings will currently only be freed when the |
837 | Please note that resource strings will currently only be freed when the |
584 | terminal is destroyed, so changing options frequently will eat memory. |
838 | terminal is destroyed, so changing options frequently will eat memory. |
585 | |
839 | |
586 | Here is a a likely non-exhaustive list of resource names, not all of which |
840 | Here is a a likely non-exhaustive list of resource names, not all of which |
587 | are supported in every build, please see the source to see the actual |
841 | are supported in every build, please see the source file F</src/rsinc.h> |
588 | list: |
842 | to see the actual list: |
589 | |
843 | |
590 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
844 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
591 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
845 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
592 | display_name embed ext_bwidth fade font geometry hold iconName |
846 | display_name embed ext_bwidth fade font geometry hold iconName |
593 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
847 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
… | |
… | |
600 | shade term_name title transparent transparent_all tripleclickwords |
854 | shade term_name title transparent transparent_all tripleclickwords |
601 | utmpInhibit visualBell |
855 | utmpInhibit visualBell |
602 | |
856 | |
603 | =cut |
857 | =cut |
604 | |
858 | |
605 | sub urxvt::term::resource($$;$) { |
859 | sub resource($$;$) { |
606 | my ($self, $name) = (shift, shift); |
860 | my ($self, $name) = (shift, shift); |
607 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
861 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
608 | &urxvt::term::_resource |
862 | &urxvt::term::_resource |
609 | } |
863 | } |
610 | |
864 | |
|
|
865 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
|
|
866 | |
|
|
867 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
868 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
|
|
869 | |
611 | =item $rend = $term->rstyle ([$new_rstyle]) |
870 | =item $rend = $term->rstyle ([$new_rstyle]) |
612 | |
871 | |
613 | Return and optionally change the current rendition. Text that is output by |
872 | Return and optionally change the current rendition. Text that is output by |
614 | the terminal application will use this style. |
873 | the terminal application will use this style. |
615 | |
874 | |
… | |
… | |
634 | |
893 | |
635 | =item $oldtext = $term->selection ([$newtext]) |
894 | =item $oldtext = $term->selection ([$newtext]) |
636 | |
895 | |
637 | Return the current selection text and optionally replace it by C<$newtext>. |
896 | Return the current selection text and optionally replace it by C<$newtext>. |
638 | |
897 | |
639 | #=item $term->overlay ($x, $y, $text) |
898 | =item $term->overlay_simple ($x, $y, $text) |
640 | # |
899 | |
641 | #Create a simple multi-line overlay box. See the next method for details. |
900 | Create a simple multi-line overlay box. See the next method for details. |
642 | # |
901 | |
643 | #=cut |
902 | =cut |
644 | # |
903 | |
645 | #sub urxvt::term::scr_overlay { |
904 | sub overlay_simple { |
646 | # my ($self, $x, $y, $text) = @_; |
905 | my ($self, $x, $y, $text) = @_; |
647 | # |
906 | |
648 | # my @lines = split /\n/, $text; |
907 | my @lines = split /\n/, $text; |
649 | # |
908 | |
650 | # my $w = 0; |
909 | my $w = List::Util::max map $self->strwidth ($_), @lines; |
651 | # for (map $self->strwidth ($_), @lines) { |
910 | |
652 | # $w = $_ if $w < $_; |
|
|
653 | # } |
|
|
654 | # |
|
|
655 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
911 | my $overlay = $self->overlay ($x, $y, $w, scalar @lines); |
656 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
912 | $overlay->set (0, $_, $lines[$_]) for 0.. $#lines; |
657 | #} |
913 | |
|
|
914 | $overlay |
|
|
915 | } |
658 | |
916 | |
659 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
917 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
660 | |
918 | |
661 | Create a new (empty) overlay at the given position with the given |
919 | Create a new (empty) overlay at the given position with the given |
662 | width/height. C<$rstyle> defines the initial rendition style |
920 | width/height. C<$rstyle> defines the initial rendition style |
… | |
… | |
697 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
955 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
698 | currently). |
956 | currently). |
699 | |
957 | |
700 | =cut |
958 | =cut |
701 | |
959 | |
702 | sub urxvt::term::popup { |
960 | sub popup { |
703 | my ($self, $event) = @_; |
961 | my ($self, $event) = @_; |
704 | |
962 | |
705 | $self->grab ($event->{time}, 1) |
963 | $self->grab ($event->{time}, 1) |
706 | or return; |
964 | or return; |
707 | |
965 | |
… | |
… | |
729 | |
987 | |
730 | =item $string = $term->locale_decode ($octets) |
988 | =item $string = $term->locale_decode ($octets) |
731 | |
989 | |
732 | Convert the given locale-encoded octets into a perl string. |
990 | Convert the given locale-encoded octets into a perl string. |
733 | |
991 | |
|
|
992 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
|
|
993 | |
|
|
994 | XORs the rendition values in the given span with the provided value |
|
|
995 | (default: C<RS_RVid>). Useful in refresh hooks to provide effects similar |
|
|
996 | to the selection. |
|
|
997 | |
|
|
998 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
|
|
999 | |
|
|
1000 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
|
|
1001 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
|
|
1002 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
|
|
1003 | it instead. |
|
|
1004 | |
|
|
1005 | =item $term->scr_bell |
|
|
1006 | |
|
|
1007 | Ring the bell! |
|
|
1008 | |
734 | =item $term->scr_add_lines ($string) |
1009 | =item $term->scr_add_lines ($string) |
735 | |
1010 | |
736 | Write the given text string to the screen, as if output by the application |
1011 | Write the given text string to the screen, as if output by the application |
737 | running inside the terminal. It may not contain command sequences (escape |
1012 | running inside the terminal. It may not contain command sequences (escape |
738 | codes), but is free to use line feeds, carriage returns and tabs. The |
1013 | codes), but is free to use line feeds, carriage returns and tabs. The |
… | |
… | |
752 | |
1027 | |
753 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1028 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
754 | pass characters instead of octets, you should convert your strings first |
1029 | pass characters instead of octets, you should convert your strings first |
755 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1030 | to the locale-specific encoding using C<< $term->locale_encode >>. |
756 | |
1031 | |
|
|
1032 | =item $old_events = $term->pty_ev_events ([$new_events]) |
|
|
1033 | |
|
|
1034 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
1035 | be used to suppress input and output handling to the pty/tty. See the |
|
|
1036 | description of C<< urxvt::timer->events >>. Make sure to always restore |
|
|
1037 | the previous value. |
|
|
1038 | |
757 | =item $windowid = $term->parent |
1039 | =item $windowid = $term->parent |
758 | |
1040 | |
759 | Return the window id of the toplevel window. |
1041 | Return the window id of the toplevel window. |
760 | |
1042 | |
761 | =item $windowid = $term->vt |
1043 | =item $windowid = $term->vt |
… | |
… | |
785 | =item $nrow_plus_saveLines = $term->total_rows |
1067 | =item $nrow_plus_saveLines = $term->total_rows |
786 | |
1068 | |
787 | =item $lines_in_scrollback = $term->nsaved |
1069 | =item $lines_in_scrollback = $term->nsaved |
788 | |
1070 | |
789 | Return various integers describing terminal characteristics. |
1071 | Return various integers describing terminal characteristics. |
|
|
1072 | |
|
|
1073 | =item $x_display = $term->display_id |
|
|
1074 | |
|
|
1075 | Return the DISPLAY used by rxvt-unicode. |
|
|
1076 | |
|
|
1077 | =item $lc_ctype = $term->locale |
|
|
1078 | |
|
|
1079 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
1080 | |
|
|
1081 | =item $env = $term->env |
|
|
1082 | |
|
|
1083 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1084 | similar to C<\%ENV>. |
|
|
1085 | |
|
|
1086 | =cut |
|
|
1087 | |
|
|
1088 | sub env { |
|
|
1089 | if (my $env = $_[0]->_env) { |
|
|
1090 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
|
|
1091 | } else { |
|
|
1092 | +{ %ENV } |
|
|
1093 | } |
|
|
1094 | } |
790 | |
1095 | |
791 | =item $modifiermask = $term->ModLevel3Mask |
1096 | =item $modifiermask = $term->ModLevel3Mask |
792 | |
1097 | |
793 | =item $modifiermask = $term->ModMetaMask |
1098 | =item $modifiermask = $term->ModMetaMask |
794 | |
1099 | |
… | |
… | |
897 | |
1202 | |
898 | =back |
1203 | =back |
899 | |
1204 | |
900 | =cut |
1205 | =cut |
901 | |
1206 | |
902 | sub urxvt::term::line { |
1207 | sub line { |
903 | my ($self, $row) = @_; |
1208 | my ($self, $row) = @_; |
904 | |
1209 | |
905 | my $maxrow = $self->nrow - 1; |
1210 | my $maxrow = $self->nrow - 1; |
906 | |
1211 | |
907 | my ($beg, $end) = ($row, $row); |
1212 | my ($beg, $end) = ($row, $row); |
… | |
… | |
971 | $offset / $self->{ncol} + $self->{beg}, |
1276 | $offset / $self->{ncol} + $self->{beg}, |
972 | $offset % $self->{ncol} |
1277 | $offset % $self->{ncol} |
973 | ) |
1278 | ) |
974 | } |
1279 | } |
975 | |
1280 | |
976 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
977 | =item $text = $term->special_encode $string |
1281 | =item $text = $term->special_encode $string |
978 | |
1282 | |
979 | Converts a perl string into the special encoding used by rxvt-unicode, |
1283 | Converts a perl string into the special encoding used by rxvt-unicode, |
980 | where one character corresponds to one screen cell. See |
1284 | where one character corresponds to one screen cell. See |
981 | C<< $term->ROW_t >> for details. |
1285 | C<< $term->ROW_t >> for details. |
… | |
… | |
983 | =item $string = $term->special_decode $text |
1287 | =item $string = $term->special_decode $text |
984 | |
1288 | |
985 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1289 | Converts rxvt-unicodes text reprsentation into a perl string. See |
986 | C<< $term->ROW_t >> for details. |
1290 | C<< $term->ROW_t >> for details. |
987 | |
1291 | |
|
|
1292 | =item $success = $term->grab_button ($button, $modifiermask) |
|
|
1293 | |
|
|
1294 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
1295 | |
|
|
1296 | =item $success = $term->grab ($eventtime[, $sync]) |
|
|
1297 | |
|
|
1298 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1299 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
|
|
1300 | |
|
|
1301 | =item $term->allow_events_async |
|
|
1302 | |
|
|
1303 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1304 | |
|
|
1305 | =item $term->allow_events_sync |
|
|
1306 | |
|
|
1307 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1308 | |
|
|
1309 | =item $term->allow_events_replay |
|
|
1310 | |
|
|
1311 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1312 | recent grab. |
|
|
1313 | |
|
|
1314 | =item $term->ungrab |
|
|
1315 | |
|
|
1316 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1317 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1318 | the session. |
|
|
1319 | |
988 | =back |
1320 | =back |
989 | |
1321 | |
|
|
1322 | =cut |
|
|
1323 | |
|
|
1324 | package urxvt::popup; |
|
|
1325 | |
990 | =head2 The C<urxvt::popup> Class |
1326 | =head2 The C<urxvt::popup> Class |
991 | |
1327 | |
992 | =over 4 |
1328 | =over 4 |
993 | |
1329 | |
994 | =cut |
1330 | =cut |
995 | |
|
|
996 | package urxvt::popup; |
|
|
997 | |
1331 | |
998 | sub add_item { |
1332 | sub add_item { |
999 | my ($self, $item) = @_; |
1333 | my ($self, $item) = @_; |
1000 | |
1334 | |
|
|
1335 | $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal}; |
|
|
1336 | $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover}; |
|
|
1337 | $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active}; |
|
|
1338 | |
|
|
1339 | $item->{render} ||= sub { $_[0]{text} }; |
|
|
1340 | |
1001 | push @{ $self->{item} }, $item; |
1341 | push @{ $self->{item} }, $item; |
1002 | } |
1342 | } |
|
|
1343 | |
|
|
1344 | =item $popup->add_title ($title) |
|
|
1345 | |
|
|
1346 | Adds a non-clickable title to the popup. |
|
|
1347 | |
|
|
1348 | =cut |
|
|
1349 | |
|
|
1350 | sub add_title { |
|
|
1351 | my ($self, $title) = @_; |
|
|
1352 | |
|
|
1353 | $self->add_item ({ |
|
|
1354 | rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, |
|
|
1355 | text => $title, |
|
|
1356 | activate => sub { }, |
|
|
1357 | }); |
|
|
1358 | } |
|
|
1359 | |
|
|
1360 | =item $popup->add_separator ([$sepchr]) |
|
|
1361 | |
|
|
1362 | Creates a separator, optionally using the character given as C<$sepchr>. |
|
|
1363 | |
|
|
1364 | =cut |
|
|
1365 | |
|
|
1366 | sub add_separator { |
|
|
1367 | my ($self, $sep) = @_; |
|
|
1368 | |
|
|
1369 | $sep ||= "="; |
|
|
1370 | |
|
|
1371 | $self->add_item ({ |
|
|
1372 | rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, |
|
|
1373 | text => "", |
|
|
1374 | render => sub { $sep x $self->{term}->ncol }, |
|
|
1375 | activate => sub { }, |
|
|
1376 | }); |
|
|
1377 | } |
|
|
1378 | |
|
|
1379 | =item $popup->add_button ($text, $cb) |
|
|
1380 | |
|
|
1381 | Adds a clickable button to the popup. C<$cb> is called whenever it is |
|
|
1382 | selected. |
|
|
1383 | |
|
|
1384 | =cut |
1003 | |
1385 | |
1004 | sub add_button { |
1386 | sub add_button { |
1005 | my ($self, $text, $cb) = @_; |
1387 | my ($self, $text, $cb) = @_; |
1006 | |
1388 | |
1007 | $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb, |
1389 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1008 | render => sub { $_[0]{text} }, |
|
|
1009 | }); |
|
|
1010 | } |
1390 | } |
|
|
1391 | |
|
|
1392 | =item $popup->add_toggle ($text, $cb, $initial_value) |
|
|
1393 | |
|
|
1394 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1395 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1396 | argument. |
|
|
1397 | |
|
|
1398 | =cut |
1011 | |
1399 | |
1012 | sub add_toggle { |
1400 | sub add_toggle { |
1013 | my ($self, $text, $cb, $value) = @_; |
1401 | my ($self, $text, $cb, $value) = @_; |
1014 | |
1402 | |
1015 | $self->add_item ({ type => "button", text => " $text", value => $value, |
1403 | my $item; $item = { |
|
|
1404 | type => "button", |
|
|
1405 | text => " $text", |
|
|
1406 | value => $value, |
1016 | render => sub { ($_[0]{value} ? "✔" : " ") . substr $_[0]{text}, 1 }, |
1407 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1017 | activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, |
1408 | activate => sub { $cb->($_[1]{value} = !$_[1]{value}); }, |
1018 | }); |
1409 | }; |
|
|
1410 | |
|
|
1411 | $self->add_item ($item); |
1019 | } |
1412 | } |
|
|
1413 | |
|
|
1414 | =item $popup->show |
|
|
1415 | |
|
|
1416 | Displays the popup (which is initially hidden). |
|
|
1417 | |
|
|
1418 | =cut |
1020 | |
1419 | |
1021 | sub show { |
1420 | sub show { |
1022 | my ($self) = @_; |
1421 | my ($self) = @_; |
1023 | |
1422 | |
1024 | local $urxvt::popup::self = $self; |
1423 | local $urxvt::popup::self = $self; |
1025 | |
1424 | |
|
|
1425 | my $env = $self->{term}->env; |
|
|
1426 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
|
|
1427 | delete $env->{LC_ALL}; |
|
|
1428 | $env->{LC_CTYPE} = $self->{term}->locale; |
|
|
1429 | |
|
|
1430 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1026 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1431 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1027 | "--transient-for" => $self->{term}->parent, |
1432 | "--transient-for" => $self->{term}->parent, |
|
|
1433 | "-display" => $self->{term}->display_id, |
1028 | "-pe" => "urxvt-popup") |
1434 | "-pe" => "urxvt-popup") |
1029 | or die "unable to create popup window\n"; |
1435 | or die "unable to create popup window\n"; |
1030 | } |
1436 | } |
1031 | |
1437 | |
1032 | sub DESTROY { |
1438 | sub DESTROY { |
1033 | my ($self) = @_; |
1439 | my ($self) = @_; |
1034 | |
1440 | |
|
|
1441 | delete $self->{term}{_destroy}{$self}; |
1035 | $self->{term}->ungrab; |
1442 | $self->{term}->ungrab; |
1036 | } |
1443 | } |
|
|
1444 | |
|
|
1445 | =back |
1037 | |
1446 | |
1038 | =head2 The C<urxvt::timer> Class |
1447 | =head2 The C<urxvt::timer> Class |
1039 | |
1448 | |
1040 | This class implements timer watchers/events. Time is represented as a |
1449 | This class implements timer watchers/events. Time is represented as a |
1041 | fractional number of seconds since the epoch. Example: |
1450 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1094 | |
1503 | |
1095 | $term->{socket} = ... |
1504 | $term->{socket} = ... |
1096 | $term->{iow} = urxvt::iow |
1505 | $term->{iow} = urxvt::iow |
1097 | ->new |
1506 | ->new |
1098 | ->fd (fileno $term->{socket}) |
1507 | ->fd (fileno $term->{socket}) |
1099 | ->events (1) # wait for read data |
1508 | ->events (urxvt::EVENT_READ) |
1100 | ->start |
1509 | ->start |
1101 | ->cb (sub { |
1510 | ->cb (sub { |
1102 | my ($iow, $revents) = @_; |
1511 | my ($iow, $revents) = @_; |
1103 | # $revents must be 1 here, no need to check |
1512 | # $revents must be 1 here, no need to check |
1104 | sysread $term->{socket}, my $buf, 8192 |
1513 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1121 | |
1530 | |
1122 | Set the filedescriptor (not handle) to watch. |
1531 | Set the filedescriptor (not handle) to watch. |
1123 | |
1532 | |
1124 | =item $iow = $iow->events ($eventmask) |
1533 | =item $iow = $iow->events ($eventmask) |
1125 | |
1534 | |
1126 | Set the event mask to watch. Bit #0 (value C<1>) enables watching for read |
1535 | Set the event mask to watch. The only allowed values are |
1127 | data, Bit #1 (value C<2>) enables watching for write data. |
1536 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
|
|
1537 | together, or C<urxvt::EVENT_NONE>. |
1128 | |
1538 | |
1129 | =item $iow = $iow->start |
1539 | =item $iow = $iow->start |
1130 | |
1540 | |
1131 | Start watching for requested events on the given handle. |
1541 | Start watching for requested events on the given handle. |
1132 | |
1542 | |
… | |
… | |
1143 | This variable controls the verbosity level of the perl extension. Higher |
1553 | This variable controls the verbosity level of the perl extension. Higher |
1144 | numbers indicate more verbose output. |
1554 | numbers indicate more verbose output. |
1145 | |
1555 | |
1146 | =over 4 |
1556 | =over 4 |
1147 | |
1557 | |
1148 | =item =0 - only fatal messages |
1558 | =item == 0 - fatal messages |
1149 | |
1559 | |
1150 | =item =3 - script loading and management |
1560 | =item >= 3 - script loading and management |
1151 | |
1561 | |
1152 | =item =10 - all events received |
1562 | =item >=10 - all events received |
1153 | |
1563 | |
1154 | =back |
1564 | =back |
1155 | |
1565 | |
1156 | =head1 AUTHOR |
1566 | =head1 AUTHOR |
1157 | |
1567 | |