… | |
… | |
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 (enabled by default) |
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 | |
… | |
… | |
64 | runtime. |
64 | runtime. |
65 | |
65 | |
66 | =item selection-popup (enabled by default) |
66 | =item selection-popup (enabled by default) |
67 | |
67 | |
68 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
68 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
69 | text into various other formats/action. |
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. |
70 | |
82 | |
71 | =item digital-clock |
83 | =item digital-clock |
72 | |
84 | |
73 | Displays a digital clock using the built-in overlay. |
85 | Displays a digital clock using the built-in overlay. |
74 | |
86 | |
… | |
… | |
87 | 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 |
88 | window. Illustrates overwriting the refresh callbacks to create your own |
100 | window. Illustrates overwriting the refresh callbacks to create your own |
89 | overlays or changes. |
101 | overlays or changes. |
90 | |
102 | |
91 | =back |
103 | =back |
|
|
104 | |
|
|
105 | =head1 API DOCUMENTATION |
92 | |
106 | |
93 | =head2 General API Considerations |
107 | =head2 General API Considerations |
94 | |
108 | |
95 | All objects (such as terminals, time watchers etc.) are typical |
109 | All objects (such as terminals, time watchers etc.) are typical |
96 | 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 |
… | |
… | |
109 | =over 4 |
123 | =over 4 |
110 | |
124 | |
111 | =item $text |
125 | =item $text |
112 | |
126 | |
113 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
127 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
114 | 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. |
115 | |
129 | |
116 | =item $string |
130 | =item $string |
117 | |
131 | |
118 | 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 |
119 | 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 |
… | |
… | |
124 | 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 |
125 | locale-specific way. |
139 | locale-specific way. |
126 | |
140 | |
127 | =back |
141 | =back |
128 | |
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 | |
129 | =head2 Hooks |
176 | =head2 Hooks |
130 | |
177 | |
131 | 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 |
132 | called whenever the relevant event happens. |
179 | called whenever the relevant event happens. |
133 | |
180 | |
134 | 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 |
135 | and extension package. You can call all C<urxvt::term> methods on it, but |
182 | the in the C<Extension Objects> section. |
136 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
|
|
137 | object that is shared between all packages is stored in the C<term> |
|
|
138 | member. It is, however, blessed intot he package of the extension script, |
|
|
139 | so for all practical purposes you can treat an extension script as a class. |
|
|
140 | |
183 | |
141 | 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 |
142 | 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 |
143 | 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. |
144 | |
187 | |
145 | When in doubt, return a false value (preferably C<()>). |
188 | I<< When in doubt, return a false value (preferably C<()>). >> |
146 | |
189 | |
147 | =over 4 |
190 | =over 4 |
148 | |
191 | |
149 | =item on_init $term |
192 | =item on_init $term |
150 | |
193 | |
… | |
… | |
226 | 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 |
227 | 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 |
228 | 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 |
229 | output. |
272 | output. |
230 | |
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 | |
231 | =item on_line_update $term, $row |
279 | =item on_line_update $term, $row |
232 | |
280 | |
233 | 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 |
234 | 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 |
235 | 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, |
… | |
… | |
267 | =item on_focus_out $term |
315 | =item on_focus_out $term |
268 | |
316 | |
269 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
317 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
270 | focus out processing. |
318 | focus out processing. |
271 | |
319 | |
272 | =item on_key_press $term, $event, $octets |
320 | =item on_key_press $term, $event, $keysym, $octets |
273 | |
321 | |
274 | =item on_key_release $term, $event |
322 | =item on_key_release $term, $event, $keysym |
275 | |
323 | |
276 | =item on_button_press $term, $event |
324 | =item on_button_press $term, $event |
277 | |
325 | |
278 | =item on_button_release $term, $event |
326 | =item on_button_release $term, $event |
279 | |
327 | |
… | |
… | |
295 | |
343 | |
296 | subwindow. |
344 | subwindow. |
297 | |
345 | |
298 | =back |
346 | =back |
299 | |
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 | |
300 | =head2 Variables in the C<urxvt> Package |
369 | =head2 Variables in the C<urxvt> Package |
301 | |
370 | |
302 | =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>. |
303 | |
385 | |
304 | =item $urxvt::TERM |
386 | =item $urxvt::TERM |
305 | |
387 | |
306 | The current terminal. This variable stores the current C<urxvt::term> |
388 | The current terminal. This variable stores the current C<urxvt::term> |
307 | object, whenever a callback/hook is executing. |
389 | object, whenever a callback/hook is executing. |
… | |
… | |
309 | =back |
391 | =back |
310 | |
392 | |
311 | =head2 Functions in the C<urxvt> Package |
393 | =head2 Functions in the C<urxvt> Package |
312 | |
394 | |
313 | =over 4 |
395 | =over 4 |
314 | |
|
|
315 | =item $term = new urxvt [arg...] |
|
|
316 | |
|
|
317 | Creates a new terminal, very similar as if you had started it with |
|
|
318 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
319 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
320 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
321 | C<init> and C<start> hooks will be called during the call. |
|
|
322 | |
396 | |
323 | =item urxvt::fatal $errormessage |
397 | =item urxvt::fatal $errormessage |
324 | |
398 | |
325 | Fatally aborts execution with the given error message. Avoid at all |
399 | Fatally aborts execution with the given error message. Avoid at all |
326 | 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 |
… | |
… | |
332 | newline. The module also overwrites the C<warn> builtin with a function |
406 | newline. The module also overwrites the C<warn> builtin with a function |
333 | that calls this function. |
407 | that calls this function. |
334 | |
408 | |
335 | 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 |
336 | correct place, e.g. on stderr of the connecting urxvtc client. |
410 | correct place, e.g. on stderr of the connecting urxvtc client. |
|
|
411 | |
|
|
412 | Messages have a size limit of 1023 bytes currently. |
337 | |
413 | |
338 | =item $is_safe = urxvt::safe |
414 | =item $is_safe = urxvt::safe |
339 | |
415 | |
340 | Returns true when it is safe to do potentially unsafe things, such as |
416 | Returns true when it is safe to do potentially unsafe things, such as |
341 | evaluating perl code specified by the user. This is true when urxvt was |
417 | evaluating perl code specified by the user. This is true when urxvt was |
… | |
… | |
386 | |
462 | |
387 | =item $background = urxvt::GET_BASEBG $rend |
463 | =item $background = urxvt::GET_BASEBG $rend |
388 | |
464 | |
389 | Return the foreground/background colour index, respectively. |
465 | Return the foreground/background colour index, respectively. |
390 | |
466 | |
391 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
467 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
392 | |
468 | |
393 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
469 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
394 | |
470 | |
395 | Replace the foreground/background colour in the rendition mask with the |
471 | Replace the foreground/background colour in the rendition mask with the |
396 | specified one. |
472 | specified one. |
397 | |
473 | |
398 | =item $value = urxvt::GET_CUSTOM ($rend) |
474 | =item $value = urxvt::GET_CUSTOM $rend |
399 | |
475 | |
400 | 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 |
401 | 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 |
402 | zero. |
478 | zero. |
403 | |
479 | |
404 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
480 | =item $rend = urxvt::SET_CUSTOM $rend, $new_value |
405 | |
481 | |
406 | Change the custom value. |
482 | Change the custom value. |
407 | |
483 | |
408 | =back |
484 | =back |
409 | |
485 | |
410 | =cut |
486 | =cut |
411 | |
|
|
412 | package urxvt; |
|
|
413 | |
|
|
414 | use utf8; |
|
|
415 | use strict; |
|
|
416 | use Scalar::Util (); |
|
|
417 | use List::Util (); |
|
|
418 | |
|
|
419 | our $VERSION = 1; |
|
|
420 | our $TERM; |
|
|
421 | our @HOOKNAME; |
|
|
422 | our %OPTION; |
|
|
423 | our $LIBDIR; |
|
|
424 | |
487 | |
425 | BEGIN { |
488 | BEGIN { |
426 | urxvt->bootstrap; |
489 | urxvt->bootstrap; |
427 | |
490 | |
428 | # overwrite perl's warn |
491 | # overwrite perl's warn |
… | |
… | |
460 | verbose 3, "loading extension '$path' into package '$pkg'"; |
523 | verbose 3, "loading extension '$path' into package '$pkg'"; |
461 | |
524 | |
462 | open my $fh, "<:raw", $path |
525 | open my $fh, "<:raw", $path |
463 | or die "$path: $!"; |
526 | or die "$path: $!"; |
464 | |
527 | |
|
|
528 | my $source = untaint |
465 | my $source = untaint "package $pkg; use strict; use utf8;\n" |
529 | "package $pkg; use strict; use utf8;\n" |
466 | . "use base urxvt::term::proxy::;\n" |
530 | . "use base urxvt::term::extension::;\n" |
467 | . "#line 1 \"$path\"\n{\n" |
531 | . "#line 1 \"$path\"\n{\n" |
468 | . (do { local $/; <$fh> }) |
532 | . (do { local $/; <$fh> }) |
469 | . "\n};\n1"; |
533 | . "\n};\n1"; |
470 | |
534 | |
|
|
535 | eval $source |
471 | eval $source or die "$path: $@"; |
536 | or die "$path: $@"; |
472 | |
537 | |
473 | $pkg |
538 | $pkg |
474 | } |
539 | } |
475 | } |
540 | } |
476 | |
541 | |
… | |
… | |
486 | |
551 | |
487 | my %ext_arg; |
552 | my %ext_arg; |
488 | |
553 | |
489 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
554 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
490 | if ($_ eq "default") { |
555 | if ($_ eq "default") { |
491 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup); |
556 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
492 | } elsif (/^-(.*)$/) { |
557 | } elsif (/^-(.*)$/) { |
493 | delete $ext_arg{$1}; |
558 | delete $ext_arg{$1}; |
494 | } elsif (/^([^<]+)<(.*)>$/) { |
559 | } elsif (/^([^<]+)<(.*)>$/) { |
495 | push @{ $ext_arg{$1} }, $2; |
560 | push @{ $ext_arg{$1} }, $2; |
496 | } else { |
561 | } else { |
… | |
… | |
530 | } |
595 | } |
531 | } |
596 | } |
532 | } |
597 | } |
533 | |
598 | |
534 | if ($htype == 1) { # DESTROY |
599 | if ($htype == 1) { # DESTROY |
535 | # remove hooks if unused |
|
|
536 | if (my $hook = $TERM->{_hook}) { |
600 | if (my $hook = delete $TERM->{_hook}) { |
537 | for my $htype (0..$#$hook) { |
601 | for my $htype (0..$#$hook) { |
538 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
602 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
539 | or set_should_invoke $htype, 0; |
603 | or set_should_invoke $htype, 0; |
540 | } |
604 | } |
541 | } |
605 | } |
… | |
… | |
548 | } |
612 | } |
549 | |
613 | |
550 | $retval |
614 | $retval |
551 | } |
615 | } |
552 | |
616 | |
553 | # urxvt::term::proxy |
617 | # urxvt::term::extension |
554 | |
618 | |
555 | sub urxvt::term::proxy::AUTOLOAD { |
619 | package urxvt::term::extension; |
556 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
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 =~ /:([^:]+)$/ |
557 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
659 | or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable"; |
558 | |
660 | |
559 | eval qq{ |
661 | eval qq{ |
560 | sub $urxvt::term::proxy::AUTOLOAD { |
662 | sub $AUTOLOAD { |
561 | my \$proxy = shift; |
663 | my \$proxy = shift; |
562 | \$proxy->{term}->$1 (\@_) |
664 | \$proxy->{term}->$1 (\@_) |
563 | } |
665 | } |
564 | 1 |
666 | 1 |
565 | } or die "FATAL: unable to compile method forwarder: $@"; |
667 | } or die "FATAL: unable to compile method forwarder: $@"; |
566 | |
668 | |
567 | goto &$urxvt::term::proxy::AUTOLOAD; |
669 | goto &$AUTOLOAD; |
568 | } |
670 | } |
569 | |
671 | |
570 | sub urxvt::term::proxy::DESTROY { |
672 | sub DESTROY { |
571 | # nop |
673 | # nop |
572 | } |
674 | } |
573 | |
675 | |
574 | # urxvt::destroy_hook |
676 | # urxvt::destroy_hook |
575 | |
677 | |
… | |
… | |
585 | |
687 | |
586 | =head2 The C<urxvt::anyevent> Class |
688 | =head2 The C<urxvt::anyevent> Class |
587 | |
689 | |
588 | The sole purpose of this class is to deliver an interface to the |
690 | The sole purpose of this class is to deliver an interface to the |
589 | C<AnyEvent> module - any module using it will work inside urxvt without |
691 | C<AnyEvent> module - any module using it will work inside urxvt without |
590 | further work. The only exception is that you cannot wait on condition |
692 | further programming. The only exception is that you cannot wait on |
591 | variables, but non-blocking condvar use is ok. What this means is that you |
693 | condition variables, but non-blocking condvar use is ok. What this means |
592 | cannot use blocking APIs, but the non-blocking variant should work. |
694 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
695 | work. |
593 | |
696 | |
594 | =cut |
697 | =cut |
595 | |
698 | |
596 | our $VERSION = 1; |
699 | our $VERSION = 1; |
597 | |
700 | |
… | |
… | |
642 | ${$_[0]}++; |
745 | ${$_[0]}++; |
643 | } |
746 | } |
644 | |
747 | |
645 | sub urxvt::anyevent::condvar::wait { |
748 | sub urxvt::anyevent::condvar::wait { |
646 | unless (${$_[0]}) { |
749 | unless (${$_[0]}) { |
647 | require Carp; |
|
|
648 | Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"); |
750 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
649 | } |
751 | } |
650 | } |
752 | } |
651 | |
753 | |
652 | package urxvt::term; |
754 | package urxvt::term; |
653 | |
755 | |
… | |
… | |
660 | # find on_xxx subs in the package and register them |
762 | # find on_xxx subs in the package and register them |
661 | # as hooks |
763 | # as hooks |
662 | sub register_package { |
764 | sub register_package { |
663 | my ($self, $pkg, $argv) = @_; |
765 | my ($self, $pkg, $argv) = @_; |
664 | |
766 | |
665 | my $proxy = bless { argv => $argv }, $pkg; |
767 | my $proxy = bless { |
|
|
768 | _pkg => $pkg, |
|
|
769 | argv => $argv, |
|
|
770 | }, $pkg; |
666 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
771 | Scalar::Util::weaken ($proxy->{term} = $self); |
667 | |
772 | |
668 | $self->{_pkg}{$pkg} = $proxy; |
773 | $self->{_pkg}{$pkg} = $proxy; |
669 | |
774 | |
670 | for my $htype (0.. $#HOOKNAME) { |
775 | for my $name (@HOOKNAME) { |
671 | my $name = $HOOKNAME[$htype]; |
|
|
672 | |
|
|
673 | my $ref = $pkg->can ("on_" . lc $name) |
776 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
674 | or next; |
777 | $proxy->enable ($name => $ref); |
675 | |
778 | } |
676 | $self->{_hook}[$htype]{$pkg} = $ref; |
|
|
677 | $hook_count[$htype]++ |
|
|
678 | or urxvt::set_should_invoke $htype, 1; |
|
|
679 | } |
779 | } |
680 | } |
780 | } |
681 | |
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 | |
682 | =item $term->destroy |
801 | =item $term->destroy |
683 | |
802 | |
684 | 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. |
685 | |
806 | |
686 | =item $isset = $term->option ($optval[, $set]) |
807 | =item $isset = $term->option ($optval[, $set]) |
687 | |
808 | |
688 | Returns true if the option specified by C<$optval> is enabled, and |
809 | Returns true if the option specified by C<$optval> is enabled, and |
689 | optionally change it. All option values are stored by name in the hash |
810 | optionally change it. All option values are stored by name in the hash |
… | |
… | |
739 | my ($self, $name) = (shift, shift); |
860 | my ($self, $name) = (shift, shift); |
740 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
861 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
741 | &urxvt::term::_resource |
862 | &urxvt::term::_resource |
742 | } |
863 | } |
743 | |
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 | |
744 | =item $rend = $term->rstyle ([$new_rstyle]) |
870 | =item $rend = $term->rstyle ([$new_rstyle]) |
745 | |
871 | |
746 | 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 |
747 | the terminal application will use this style. |
873 | the terminal application will use this style. |
748 | |
874 | |
… | |
… | |
767 | |
893 | |
768 | =item $oldtext = $term->selection ([$newtext]) |
894 | =item $oldtext = $term->selection ([$newtext]) |
769 | |
895 | |
770 | 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>. |
771 | |
897 | |
772 | #=item $term->overlay ($x, $y, $text) |
898 | =item $term->overlay_simple ($x, $y, $text) |
773 | # |
899 | |
774 | #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. |
775 | # |
901 | |
776 | #=cut |
902 | =cut |
777 | # |
903 | |
778 | #sub urxvt::term::scr_overlay { |
904 | sub overlay_simple { |
779 | # my ($self, $x, $y, $text) = @_; |
905 | my ($self, $x, $y, $text) = @_; |
780 | # |
906 | |
781 | # my @lines = split /\n/, $text; |
907 | my @lines = split /\n/, $text; |
782 | # |
908 | |
783 | # my $w = 0; |
909 | my $w = List::Util::max map $self->strwidth ($_), @lines; |
784 | # for (map $self->strwidth ($_), @lines) { |
910 | |
785 | # $w = $_ if $w < $_; |
|
|
786 | # } |
|
|
787 | # |
|
|
788 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
911 | my $overlay = $self->overlay ($x, $y, $w, scalar @lines); |
789 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
912 | $overlay->set (0, $_, $lines[$_]) for 0.. $#lines; |
790 | #} |
913 | |
|
|
914 | $overlay |
|
|
915 | } |
791 | |
916 | |
792 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
917 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
793 | |
918 | |
794 | 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 |
795 | width/height. C<$rstyle> defines the initial rendition style |
920 | width/height. C<$rstyle> defines the initial rendition style |
… | |
… | |
862 | |
987 | |
863 | =item $string = $term->locale_decode ($octets) |
988 | =item $string = $term->locale_decode ($octets) |
864 | |
989 | |
865 | Convert the given locale-encoded octets into a perl string. |
990 | Convert the given locale-encoded octets into a perl string. |
866 | |
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 | |
867 | =item $term->scr_add_lines ($string) |
1009 | =item $term->scr_add_lines ($string) |
868 | |
1010 | |
869 | 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 |
870 | running inside the terminal. It may not contain command sequences (escape |
1012 | running inside the terminal. It may not contain command sequences (escape |
871 | 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 |
… | |
… | |
885 | |
1027 | |
886 | 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 |
887 | pass characters instead of octets, you should convert your strings first |
1029 | pass characters instead of octets, you should convert your strings first |
888 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1030 | to the locale-specific encoding using C<< $term->locale_encode >>. |
889 | |
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 | |
890 | =item $windowid = $term->parent |
1039 | =item $windowid = $term->parent |
891 | |
1040 | |
892 | Return the window id of the toplevel window. |
1041 | Return the window id of the toplevel window. |
893 | |
1042 | |
894 | =item $windowid = $term->vt |
1043 | =item $windowid = $term->vt |
… | |
… | |
919 | |
1068 | |
920 | =item $lines_in_scrollback = $term->nsaved |
1069 | =item $lines_in_scrollback = $term->nsaved |
921 | |
1070 | |
922 | Return various integers describing terminal characteristics. |
1071 | Return various integers describing terminal characteristics. |
923 | |
1072 | |
|
|
1073 | =item $x_display = $term->display_id |
|
|
1074 | |
|
|
1075 | Return the DISPLAY used by rxvt-unicode. |
|
|
1076 | |
924 | =item $lc_ctype = $term->locale |
1077 | =item $lc_ctype = $term->locale |
925 | |
1078 | |
926 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1079 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
927 | |
1080 | |
928 | =item $x_display = $term->display_id |
1081 | =item $env = $term->env |
929 | |
1082 | |
930 | Return the DISPLAY used by rxvt-unicode. |
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 | } |
931 | |
1095 | |
932 | =item $modifiermask = $term->ModLevel3Mask |
1096 | =item $modifiermask = $term->ModLevel3Mask |
933 | |
1097 | |
934 | =item $modifiermask = $term->ModMetaMask |
1098 | =item $modifiermask = $term->ModMetaMask |
935 | |
1099 | |
… | |
… | |
1175 | $item->{render} ||= sub { $_[0]{text} }; |
1339 | $item->{render} ||= sub { $_[0]{text} }; |
1176 | |
1340 | |
1177 | push @{ $self->{item} }, $item; |
1341 | push @{ $self->{item} }, $item; |
1178 | } |
1342 | } |
1179 | |
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 | |
1180 | sub add_separator { |
1366 | sub add_separator { |
1181 | my ($self, $sep) = @_; |
1367 | my ($self, $sep) = @_; |
1182 | |
1368 | |
1183 | $sep ||= "="; |
1369 | $sep ||= "="; |
1184 | |
1370 | |
… | |
… | |
1188 | render => sub { $sep x $self->{term}->ncol }, |
1374 | render => sub { $sep x $self->{term}->ncol }, |
1189 | activate => sub { }, |
1375 | activate => sub { }, |
1190 | }); |
1376 | }); |
1191 | } |
1377 | } |
1192 | |
1378 | |
1193 | sub add_title { |
1379 | =item $popup->add_button ($text, $cb) |
1194 | my ($self, $title) = @_; |
|
|
1195 | |
1380 | |
1196 | $self->add_item ({ |
1381 | Adds a clickable button to the popup. C<$cb> is called whenever it is |
1197 | rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, |
1382 | selected. |
1198 | text => $title, |
1383 | |
1199 | activate => sub { }, |
1384 | =cut |
1200 | }); |
|
|
1201 | } |
|
|
1202 | |
1385 | |
1203 | sub add_button { |
1386 | sub add_button { |
1204 | my ($self, $text, $cb) = @_; |
1387 | my ($self, $text, $cb) = @_; |
1205 | |
1388 | |
1206 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1389 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1207 | } |
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 |
1208 | |
1399 | |
1209 | sub add_toggle { |
1400 | sub add_toggle { |
1210 | my ($self, $text, $cb, $value) = @_; |
1401 | my ($self, $text, $cb, $value) = @_; |
1211 | |
1402 | |
1212 | my $item; $item = { |
1403 | my $item; $item = { |
1213 | type => "button", |
1404 | type => "button", |
1214 | text => " $text", |
1405 | text => " $text", |
1215 | value => $value, |
1406 | value => $value, |
1216 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1407 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1217 | activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, |
1408 | activate => sub { $cb->($_[1]{value} = !$_[1]{value}); }, |
1218 | }; |
1409 | }; |
1219 | |
1410 | |
1220 | $self->add_item ($item); |
1411 | $self->add_item ($item); |
1221 | } |
1412 | } |
|
|
1413 | |
|
|
1414 | =item $popup->show |
|
|
1415 | |
|
|
1416 | Displays the popup (which is initially hidden). |
|
|
1417 | |
|
|
1418 | =cut |
1222 | |
1419 | |
1223 | sub show { |
1420 | sub show { |
1224 | my ($self) = @_; |
1421 | my ($self) = @_; |
1225 | |
1422 | |
1226 | local $urxvt::popup::self = $self; |
1423 | local $urxvt::popup::self = $self; |
1227 | |
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}; |
1228 | local $ENV{LC_ALL} = $self->{term}->locale; |
1428 | $env->{LC_CTYPE} = $self->{term}->locale; |
1229 | |
1429 | |
|
|
1430 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1230 | 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, |
1231 | "--transient-for" => $self->{term}->parent, |
1432 | "--transient-for" => $self->{term}->parent, |
1232 | "-display" => $self->{term}->display_id, |
1433 | "-display" => $self->{term}->display_id, |
1233 | "-pe" => "urxvt-popup") |
1434 | "-pe" => "urxvt-popup") |
1234 | or die "unable to create popup window\n"; |
1435 | or die "unable to create popup window\n"; |
1235 | } |
1436 | } |
1236 | |
1437 | |
1237 | sub DESTROY { |
1438 | sub DESTROY { |
1238 | my ($self) = @_; |
1439 | my ($self) = @_; |
1239 | |
1440 | |
1240 | delete $self->{term}{_destroy}{$self}; |
1441 | delete $self->{term}{_destroy}{$self}; |
1241 | $self->{term}->ungrab; |
1442 | $self->{term}->ungrab; |
1242 | } |
1443 | } |
|
|
1444 | |
|
|
1445 | =back |
1243 | |
1446 | |
1244 | =head2 The C<urxvt::timer> Class |
1447 | =head2 The C<urxvt::timer> Class |
1245 | |
1448 | |
1246 | This class implements timer watchers/events. Time is represented as a |
1449 | This class implements timer watchers/events. Time is represented as a |
1247 | fractional number of seconds since the epoch. Example: |
1450 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1300 | |
1503 | |
1301 | $term->{socket} = ... |
1504 | $term->{socket} = ... |
1302 | $term->{iow} = urxvt::iow |
1505 | $term->{iow} = urxvt::iow |
1303 | ->new |
1506 | ->new |
1304 | ->fd (fileno $term->{socket}) |
1507 | ->fd (fileno $term->{socket}) |
1305 | ->events (1) # wait for read data |
1508 | ->events (urxvt::EVENT_READ) |
1306 | ->start |
1509 | ->start |
1307 | ->cb (sub { |
1510 | ->cb (sub { |
1308 | my ($iow, $revents) = @_; |
1511 | my ($iow, $revents) = @_; |
1309 | # $revents must be 1 here, no need to check |
1512 | # $revents must be 1 here, no need to check |
1310 | sysread $term->{socket}, my $buf, 8192 |
1513 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1327 | |
1530 | |
1328 | Set the filedescriptor (not handle) to watch. |
1531 | Set the filedescriptor (not handle) to watch. |
1329 | |
1532 | |
1330 | =item $iow = $iow->events ($eventmask) |
1533 | =item $iow = $iow->events ($eventmask) |
1331 | |
1534 | |
1332 | 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 |
1333 | 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>. |
1334 | |
1538 | |
1335 | =item $iow = $iow->start |
1539 | =item $iow = $iow->start |
1336 | |
1540 | |
1337 | Start watching for requested events on the given handle. |
1541 | Start watching for requested events on the given handle. |
1338 | |
1542 | |