… | |
… | |
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 | |
|
|
40 | Or by adding them to the resource for extensions loaded by default: |
|
|
41 | |
|
|
42 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
39 | |
43 | |
40 | =over 4 |
44 | =over 4 |
41 | |
45 | |
42 | =item selection (enabled by default) |
46 | =item selection (enabled by default) |
43 | |
47 | |
… | |
… | |
87 | |
91 | |
88 | =item selection-popup (enabled by default) |
92 | =item selection-popup (enabled by default) |
89 | |
93 | |
90 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
94 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
91 | text into various other formats/action (such as uri unescaping, perl |
95 | text into various other formats/action (such as uri unescaping, perl |
92 | evalution, web-browser starting etc.), depending on content. |
96 | evaluation, web-browser starting etc.), depending on content. |
93 | |
97 | |
94 | Other extensions can extend this popup menu by pushing a code reference onto |
98 | Other extensions can extend this popup menu by pushing a code reference |
95 | C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed. |
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
|
|
100 | popup is displayed. |
96 | |
101 | |
97 | It's sole argument is the popup menu, which can be modified. The selection |
102 | It's sole argument is the popup menu, which can be modified. The selection |
98 | is in C<$_>, which can be used to decide wether to add something or not. |
103 | is in C<$_>, which can be used to decide wether to add something or not. |
99 | It should either return nothing or a string and a code reference. The |
104 | It should either return nothing or a string and a code reference. The |
100 | string will be used as button text and the code reference will be called |
105 | string will be used as button text and the code reference will be called |
… | |
… | |
102 | |
107 | |
103 | The following will add an entry C<a to b> that transforms all C<a>s in |
108 | The following will add an entry C<a to b> that transforms all C<a>s in |
104 | the selection to C<b>s, but only if the selection currently contains any |
109 | the selection to C<b>s, but only if the selection currently contains any |
105 | C<a>s: |
110 | C<a>s: |
106 | |
111 | |
107 | push urxvt::ext::selection_popup::hook, sub { |
112 | push @{ $self->{term}{selection_popup_hook} }, sub { |
108 | /a/ ? ("a to be" => sub { s/a/b/g } |
113 | /a/ ? ("a to be" => sub { s/a/b/g } |
109 | : () |
114 | : () |
110 | }; |
115 | }; |
111 | |
116 | |
112 | =item searchable-scrollback<hotkey> (enabled by default) |
117 | =item searchable-scrollback<hotkey> (enabled by default) |
… | |
… | |
143 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
148 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
144 | |
149 | |
145 | And this example matches the same,but replaces it with vi-commands you can |
150 | And this example matches the same,but replaces it with vi-commands you can |
146 | paste directly into your (vi :) editor: |
151 | paste directly into your (vi :) editor: |
147 | |
152 | |
148 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
153 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
149 | |
154 | |
150 | Of course, this can be modified to suit your needs and your editor :) |
155 | Of course, this can be modified to suit your needs and your editor :) |
151 | |
156 | |
152 | To expand the example above to typical perl error messages ("XXX at |
157 | To expand the example above to typical perl error messages ("XXX at |
153 | FILENAME line YYY."), you need a slightly more elaborate solution: |
158 | FILENAME line YYY."), you need a slightly more elaborate solution: |
154 | |
159 | |
155 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
160 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
156 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
161 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
157 | |
162 | |
158 | The first line tells the selection code to treat the unchanging part of |
163 | The first line tells the selection code to treat the unchanging part of |
159 | every error message as a selection pattern, and the second line transforms |
164 | every error message as a selection pattern, and the second line transforms |
160 | the message into vi commands to load the file. |
165 | the message into vi commands to load the file. |
|
|
166 | |
|
|
167 | =item tabbed |
|
|
168 | |
|
|
169 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
170 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
|
|
171 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
172 | button per tab. |
|
|
173 | |
|
|
174 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
175 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
176 | while B<Shift-Down> creates a new tab. |
161 | |
177 | |
162 | =item mark-urls |
178 | =item mark-urls |
163 | |
179 | |
164 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
180 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
165 | make them clickable. When middle-clicked, the program specified in the |
181 | make them clickable. When middle-clicked, the program specified in the |
166 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
182 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
167 | the URL as first argument. |
183 | the URL as first argument. |
|
|
184 | |
|
|
185 | =item automove-background |
|
|
186 | |
|
|
187 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
188 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
189 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
190 | |
|
|
191 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
168 | |
192 | |
169 | =item block-graphics-to-ascii |
193 | =item block-graphics-to-ascii |
170 | |
194 | |
171 | A not very useful example of filtering all text output to the terminal, |
195 | A not very useful example of filtering all text output to the terminal, |
172 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
196 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
… | |
… | |
290 | called whenever the relevant event happens. |
314 | called whenever the relevant event happens. |
291 | |
315 | |
292 | The first argument passed to them is an extension oject as described in |
316 | The first argument passed to them is an extension oject as described in |
293 | the in the C<Extension Objects> section. |
317 | the in the C<Extension Objects> section. |
294 | |
318 | |
295 | B<All> of these hooks must return a boolean value. If it is true, then the |
319 | B<All> of these hooks must return a boolean value. If any of the called |
296 | event counts as being I<consumed>, and the invocation of other hooks is |
320 | hooks returns true, then the event counts as being I<consumed>, and the |
297 | skipped, and the relevant action might not be carried out by the C++ code. |
321 | relevant action might not be carried out by the C++ code. |
298 | |
322 | |
299 | I<< When in doubt, return a false value (preferably C<()>). >> |
323 | I<< When in doubt, return a false value (preferably C<()>). >> |
300 | |
324 | |
301 | =over 4 |
325 | =over 4 |
302 | |
326 | |
303 | =item on_init $term |
327 | =item on_init $term |
304 | |
328 | |
305 | Called after a new terminal object has been initialized, but before |
329 | Called after a new terminal object has been initialized, but before |
306 | windows are created or the command gets run. Most methods are unsafe to |
330 | windows are created or the command gets run. Most methods are unsafe to |
307 | call or deliver senseless data, as terminal size and other characteristics |
331 | call or deliver senseless data, as terminal size and other characteristics |
308 | have not yet been determined. You can safely query and change resources, |
332 | have not yet been determined. You can safely query and change resources |
309 | though. |
333 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
334 | place. |
|
|
335 | |
|
|
336 | =item on_start $term |
|
|
337 | |
|
|
338 | Called at the very end of initialisation of a new terminal, just before |
|
|
339 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
340 | |
|
|
341 | =item on_destroy $term |
|
|
342 | |
|
|
343 | Called whenever something tries to destroy terminal, before doing anything |
|
|
344 | yet. If this hook returns true, then destruction is skipped, but this is |
|
|
345 | rarely a good idea. |
310 | |
346 | |
311 | =item on_reset $term |
347 | =item on_reset $term |
312 | |
348 | |
313 | Called after the screen is "reset" for any reason, such as resizing or |
349 | Called after the screen is "reset" for any reason, such as resizing or |
314 | control sequences. Here is where you can react on changes to size-related |
350 | control sequences. Here is where you can react on changes to size-related |
315 | variables. |
351 | variables. |
316 | |
352 | |
317 | =item on_start $term |
353 | =item on_child_start $term, $pid |
318 | |
354 | |
319 | Called at the very end of initialisation of a new terminal, just before |
355 | Called just after the child process has been C<fork>ed. |
320 | returning to the mainloop. |
356 | |
|
|
357 | =item on_child_exit $term, $status |
|
|
358 | |
|
|
359 | Called just after the child process has exited. C<$status> is the status |
|
|
360 | from C<waitpid>. |
321 | |
361 | |
322 | =item on_sel_make $term, $eventtime |
362 | =item on_sel_make $term, $eventtime |
323 | |
363 | |
324 | Called whenever a selection has been made by the user, but before the |
364 | Called whenever a selection has been made by the user, but before the |
325 | selection text is copied, so changes to the beginning, end or type of the |
365 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
434 | =item on_focus_out $term |
474 | =item on_focus_out $term |
435 | |
475 | |
436 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
476 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
437 | focus out processing. |
477 | focus out processing. |
438 | |
478 | |
|
|
479 | =item on_configure_notify $term, $event |
|
|
480 | |
|
|
481 | =item on_property_notify $term, $event |
|
|
482 | |
439 | =item on_key_press $term, $event, $keysym, $octets |
483 | =item on_key_press $term, $event, $keysym, $octets |
440 | |
484 | |
441 | =item on_key_release $term, $event, $keysym |
485 | =item on_key_release $term, $event, $keysym |
442 | |
486 | |
443 | =item on_button_press $term, $event |
487 | =item on_button_press $term, $event |
… | |
… | |
459 | |
503 | |
460 | C<on_key_press> additionally receives the string rxvt-unicode would |
504 | C<on_key_press> additionally receives the string rxvt-unicode would |
461 | output, if any, in locale-specific encoding. |
505 | output, if any, in locale-specific encoding. |
462 | |
506 | |
463 | subwindow. |
507 | subwindow. |
|
|
508 | |
|
|
509 | =item on_client_message $term, $event |
|
|
510 | |
|
|
511 | =item on_wm_protocols $term, $event |
|
|
512 | |
|
|
513 | =item on_wm_delete_window $term, $event |
|
|
514 | |
|
|
515 | Called when various types of ClientMessage events are received (all with |
|
|
516 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
464 | |
517 | |
465 | =back |
518 | =back |
466 | |
519 | |
467 | =cut |
520 | =cut |
468 | |
521 | |
… | |
… | |
474 | use Scalar::Util (); |
527 | use Scalar::Util (); |
475 | use List::Util (); |
528 | use List::Util (); |
476 | |
529 | |
477 | our $VERSION = 1; |
530 | our $VERSION = 1; |
478 | our $TERM; |
531 | our $TERM; |
|
|
532 | our @TERM_INIT; |
|
|
533 | our @TERM_EXT; |
479 | our @HOOKNAME; |
534 | our @HOOKNAME; |
480 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
535 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
481 | our %OPTION; |
536 | our %OPTION; |
482 | |
537 | |
483 | our $LIBDIR; |
538 | our $LIBDIR; |
… | |
… | |
504 | |
559 | |
505 | =item $urxvt::TERM |
560 | =item $urxvt::TERM |
506 | |
561 | |
507 | The current terminal. This variable stores the current C<urxvt::term> |
562 | The current terminal. This variable stores the current C<urxvt::term> |
508 | object, whenever a callback/hook is executing. |
563 | object, whenever a callback/hook is executing. |
|
|
564 | |
|
|
565 | =item @urxvt::TERM_INIT |
|
|
566 | |
|
|
567 | All coderefs in this array will be called as methods of the next newly |
|
|
568 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
569 | gets cleared before the codereferences that were in it are being executed, |
|
|
570 | so coderefs can push themselves onto it again if they so desire. |
|
|
571 | |
|
|
572 | This complements to the perl-eval commandline option, but gets executed |
|
|
573 | first. |
|
|
574 | |
|
|
575 | =item @urxvt::TERM_EXT |
|
|
576 | |
|
|
577 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
578 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
579 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
509 | |
580 | |
510 | =back |
581 | =back |
511 | |
582 | |
512 | =head2 Functions in the C<urxvt> Package |
583 | =head2 Functions in the C<urxvt> Package |
513 | |
584 | |
… | |
… | |
620 | my $msg = join "", @_; |
691 | my $msg = join "", @_; |
621 | $msg .= "\n" |
692 | $msg .= "\n" |
622 | unless $msg =~ /\n$/; |
693 | unless $msg =~ /\n$/; |
623 | urxvt::warn ($msg); |
694 | urxvt::warn ($msg); |
624 | }; |
695 | }; |
625 | |
|
|
626 | # %ENV is the original startup environment |
|
|
627 | delete $ENV{IFS}; |
|
|
628 | delete $ENV{CDPATH}; |
|
|
629 | delete $ENV{BASH_ENV}; |
|
|
630 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
631 | } |
696 | } |
632 | |
697 | |
633 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
698 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
634 | |
699 | |
635 | sub verbose { |
700 | sub verbose { |
… | |
… | |
640 | my %extension_pkg; |
705 | my %extension_pkg; |
641 | |
706 | |
642 | # load a single script into its own package, once only |
707 | # load a single script into its own package, once only |
643 | sub extension_package($) { |
708 | sub extension_package($) { |
644 | my ($path) = @_; |
709 | my ($path) = @_; |
645 | |
|
|
646 | no strict 'refs'; |
|
|
647 | |
710 | |
648 | $extension_pkg{$path} ||= do { |
711 | $extension_pkg{$path} ||= do { |
649 | $path =~ /([^\/\\]+)$/; |
712 | $path =~ /([^\/\\]+)$/; |
650 | my $pkg = $1; |
713 | my $pkg = $1; |
651 | $pkg =~ s/[^[:word:]]/_/g; |
714 | $pkg =~ s/[^[:word:]]/_/g; |
… | |
… | |
654 | verbose 3, "loading extension '$path' into package '$pkg'"; |
717 | verbose 3, "loading extension '$path' into package '$pkg'"; |
655 | |
718 | |
656 | open my $fh, "<:raw", $path |
719 | open my $fh, "<:raw", $path |
657 | or die "$path: $!"; |
720 | or die "$path: $!"; |
658 | |
721 | |
659 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
660 | |
|
|
661 | my $source = |
722 | my $source = |
662 | "package $pkg; use strict; use utf8;\n" |
723 | "package $pkg; use strict; use utf8;\n" |
663 | . "#line 1 \"$path\"\n{\n" |
724 | . "#line 1 \"$path\"\n{\n" |
664 | . (do { local $/; <$fh> }) |
725 | . (do { local $/; <$fh> }) |
665 | . "\n};\n1"; |
726 | . "\n};\n1"; |
… | |
… | |
681 | if ($htype == 0) { # INIT |
742 | if ($htype == 0) { # INIT |
682 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
743 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
683 | |
744 | |
684 | my %ext_arg; |
745 | my %ext_arg; |
685 | |
746 | |
|
|
747 | { |
|
|
748 | my @init = @TERM_INIT; |
|
|
749 | @TERM_INIT = (); |
|
|
750 | $_->($TERM) for @init; |
|
|
751 | my @pkg = @TERM_EXT; |
|
|
752 | @TERM_EXT = (); |
|
|
753 | $TERM->register_package ($_) for @pkg; |
|
|
754 | } |
|
|
755 | |
686 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
756 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
687 | if ($_ eq "default") { |
757 | if ($_ eq "default") { |
688 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
758 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
689 | } elsif (/^-(.*)$/) { |
759 | } elsif (/^-(.*)$/) { |
690 | delete $ext_arg{$1}; |
760 | delete $ext_arg{$1}; |
691 | } elsif (/^([^<]+)<(.*)>$/) { |
761 | } elsif (/^([^<]+)<(.*)>$/) { |
… | |
… | |
716 | if $verbosity >= 10; |
786 | if $verbosity >= 10; |
717 | |
787 | |
718 | keys %$cb; |
788 | keys %$cb; |
719 | |
789 | |
720 | while (my ($pkg, $cb) = each %$cb) { |
790 | while (my ($pkg, $cb) = each %$cb) { |
721 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
791 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
722 | and last; |
792 | $retval ||= $retval_; |
723 | |
793 | |
724 | if ($@) { |
794 | if ($@) { |
725 | $TERM->ungrab; # better to lose the grab than the session |
795 | $TERM->ungrab; # better to lose the grab than the session |
726 | warn $@; |
796 | warn $@; |
727 | } |
797 | } |
… | |
… | |
738 | # clear package |
808 | # clear package |
739 | %$TERM = (); |
809 | %$TERM = (); |
740 | } |
810 | } |
741 | |
811 | |
742 | $retval |
812 | $retval |
743 | } |
|
|
744 | |
|
|
745 | sub exec_async(@) { |
|
|
746 | my $pid = fork; |
|
|
747 | |
|
|
748 | return |
|
|
749 | if !defined $pid or $pid; |
|
|
750 | |
|
|
751 | %ENV = %{ $TERM->env }; |
|
|
752 | |
|
|
753 | exec @_; |
|
|
754 | _exit 255; |
|
|
755 | } |
813 | } |
756 | |
814 | |
757 | # urxvt::term::extension |
815 | # urxvt::term::extension |
758 | |
816 | |
759 | package urxvt::term::extension; |
817 | package urxvt::term::extension; |
… | |
… | |
898 | # find on_xxx subs in the package and register them |
956 | # find on_xxx subs in the package and register them |
899 | # as hooks |
957 | # as hooks |
900 | sub register_package { |
958 | sub register_package { |
901 | my ($self, $pkg, $argv) = @_; |
959 | my ($self, $pkg, $argv) = @_; |
902 | |
960 | |
|
|
961 | no strict 'refs'; |
|
|
962 | |
|
|
963 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
964 | |
|
|
965 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
966 | |
903 | my $proxy = bless { |
967 | my $proxy = bless { |
904 | _pkg => $pkg, |
968 | _pkg => $pkg, |
905 | argv => $argv, |
969 | argv => $argv, |
906 | }, $pkg; |
970 | }, $pkg; |
907 | Scalar::Util::weaken ($proxy->{term} = $self); |
971 | Scalar::Util::weaken ($proxy->{term} = $self); |
… | |
… | |
938 | |
1002 | |
939 | Destroy the terminal object (close the window, free resources |
1003 | Destroy the terminal object (close the window, free resources |
940 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1004 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
941 | watchers (timers, io watchers) are still active. |
1005 | watchers (timers, io watchers) are still active. |
942 | |
1006 | |
|
|
1007 | =item $term->exec_async ($cmd[, @args]) |
|
|
1008 | |
|
|
1009 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
1010 | ("starts") programs in the background. This function takes care of setting |
|
|
1011 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
1012 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
1013 | |
|
|
1014 | Returns the pid of the subprocess or C<undef> on error. |
|
|
1015 | |
|
|
1016 | =cut |
|
|
1017 | |
|
|
1018 | sub exec_async { |
|
|
1019 | my $self = shift; |
|
|
1020 | |
|
|
1021 | my $pid = fork; |
|
|
1022 | |
|
|
1023 | return $pid |
|
|
1024 | if !defined $pid or $pid; |
|
|
1025 | |
|
|
1026 | %ENV = %{ $self->env }; |
|
|
1027 | |
|
|
1028 | exec @_; |
|
|
1029 | urxvt::_exit 255; |
|
|
1030 | } |
|
|
1031 | |
943 | =item $isset = $term->option ($optval[, $set]) |
1032 | =item $isset = $term->option ($optval[, $set]) |
944 | |
1033 | |
945 | Returns true if the option specified by C<$optval> is enabled, and |
1034 | Returns true if the option specified by C<$optval> is enabled, and |
946 | optionally change it. All option values are stored by name in the hash |
1035 | optionally change it. All option values are stored by name in the hash |
947 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1036 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
… | |
… | |
949 | Here is a a likely non-exhaustive list of option names, please see the |
1038 | Here is a a likely non-exhaustive list of option names, please see the |
950 | source file F</src/optinc.h> to see the actual list: |
1039 | source file F</src/optinc.h> to see the actual list: |
951 | |
1040 | |
952 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1041 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
953 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1042 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
954 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1043 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
955 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1044 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
956 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1045 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
957 | tripleclickwords utmpInhibit visualBell |
1046 | transparent tripleclickwords utmpInhibit visualBell |
958 | |
1047 | |
959 | =item $value = $term->resource ($name[, $newval]) |
1048 | =item $value = $term->resource ($name[, $newval]) |
960 | |
1049 | |
961 | Returns the current resource value associated with a given name and |
1050 | Returns the current resource value associated with a given name and |
962 | optionally sets a new value. Setting values is most useful in the C<init> |
1051 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
979 | |
1068 | |
980 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1069 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
981 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1070 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
982 | display_name embed ext_bwidth fade font geometry hold iconName |
1071 | display_name embed ext_bwidth fade font geometry hold iconName |
983 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1072 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
984 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1073 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
985 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1074 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
986 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1075 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
987 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1076 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
988 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1077 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
989 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1078 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
990 | shade term_name title transparent transparent_all tripleclickwords |
1079 | secondaryScreen secondaryScroll selectstyle shade term_name title |
991 | utmpInhibit visualBell |
1080 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
|
|
1081 | visualBell |
992 | |
1082 | |
993 | =cut |
1083 | =cut |
994 | |
1084 | |
995 | sub resource($$;$) { |
1085 | sub resource($$;$) { |
996 | my ($self, $name) = (shift, shift); |
1086 | my ($self, $name) = (shift, shift); |
… | |
… | |
1588 | my $env = $self->{term}->env; |
1678 | my $env = $self->{term}->env; |
1589 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1679 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1590 | delete $env->{LC_ALL}; |
1680 | delete $env->{LC_ALL}; |
1591 | $env->{LC_CTYPE} = $self->{term}->locale; |
1681 | $env->{LC_CTYPE} = $self->{term}->locale; |
1592 | |
1682 | |
1593 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1683 | urxvt::term->new ($env, "popup", |
1594 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1684 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
1685 | "-pty-fd" => -1, "-sl" => 0, |
|
|
1686 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1595 | "--transient-for" => $self->{term}->parent, |
1687 | "--transient-for" => $self->{term}->parent, |
1596 | "-display" => $self->{term}->display_id, |
1688 | "-display" => $self->{term}->display_id, |
1597 | "-pe" => "urxvt-popup") |
1689 | "-pe" => "urxvt-popup") |
1598 | or die "unable to create popup window\n"; |
1690 | or die "unable to create popup window\n"; |
1599 | } |
1691 | } |
… | |
… | |
1604 | delete $self->{term}{_destroy}{$self}; |
1696 | delete $self->{term}{_destroy}{$self}; |
1605 | $self->{term}->ungrab; |
1697 | $self->{term}->ungrab; |
1606 | } |
1698 | } |
1607 | |
1699 | |
1608 | =back |
1700 | =back |
|
|
1701 | |
|
|
1702 | =cut |
|
|
1703 | |
|
|
1704 | package urxvt::watcher; |
|
|
1705 | |
|
|
1706 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1707 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1708 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1709 | @urxvt::iw::ISA = __PACKAGE__; |
1609 | |
1710 | |
1610 | =head2 The C<urxvt::timer> Class |
1711 | =head2 The C<urxvt::timer> Class |
1611 | |
1712 | |
1612 | This class implements timer watchers/events. Time is represented as a |
1713 | This class implements timer watchers/events. Time is represented as a |
1613 | fractional number of seconds since the epoch. Example: |
1714 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1651 | Start the timer. |
1752 | Start the timer. |
1652 | |
1753 | |
1653 | =item $timer = $timer->start ($tstamp) |
1754 | =item $timer = $timer->start ($tstamp) |
1654 | |
1755 | |
1655 | Set the event trigger time to C<$tstamp> and start the timer. |
1756 | Set the event trigger time to C<$tstamp> and start the timer. |
|
|
1757 | |
|
|
1758 | =item $timer = $timer->after ($delay) |
|
|
1759 | |
|
|
1760 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1656 | |
1761 | |
1657 | =item $timer = $timer->stop |
1762 | =item $timer = $timer->stop |
1658 | |
1763 | |
1659 | Stop the timer. |
1764 | Stop the timer. |
1660 | |
1765 | |
… | |
… | |
1707 | |
1812 | |
1708 | Stop watching for events on the given filehandle. |
1813 | Stop watching for events on the given filehandle. |
1709 | |
1814 | |
1710 | =back |
1815 | =back |
1711 | |
1816 | |
|
|
1817 | =head2 The C<urxvt::iw> Class |
|
|
1818 | |
|
|
1819 | This class implements idle watchers, that get called automatically when |
|
|
1820 | the process is idle. They should return as fast as possible, after doing |
|
|
1821 | some useful work. |
|
|
1822 | |
|
|
1823 | =over 4 |
|
|
1824 | |
|
|
1825 | =item $iw = new urxvt::iw |
|
|
1826 | |
|
|
1827 | Create a new idle watcher object in stopped state. |
|
|
1828 | |
|
|
1829 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1830 | |
|
|
1831 | Set the callback to be called when the watcher triggers. |
|
|
1832 | |
|
|
1833 | =item $timer = $timer->start |
|
|
1834 | |
|
|
1835 | Start the watcher. |
|
|
1836 | |
|
|
1837 | =item $timer = $timer->stop |
|
|
1838 | |
|
|
1839 | Stop the watcher. |
|
|
1840 | |
|
|
1841 | =back |
|
|
1842 | |
|
|
1843 | =head2 The C<urxvt::pw> Class |
|
|
1844 | |
|
|
1845 | This class implements process watchers. They create an event whenever a |
|
|
1846 | process exits, after which they stop automatically. |
|
|
1847 | |
|
|
1848 | my $pid = fork; |
|
|
1849 | ... |
|
|
1850 | $term->{pw} = urxvt::pw |
|
|
1851 | ->new |
|
|
1852 | ->start ($pid) |
|
|
1853 | ->cb (sub { |
|
|
1854 | my ($pw, $exit_status) = @_; |
|
|
1855 | ... |
|
|
1856 | }); |
|
|
1857 | |
|
|
1858 | =over 4 |
|
|
1859 | |
|
|
1860 | =item $pw = new urxvt::pw |
|
|
1861 | |
|
|
1862 | Create a new process watcher in stopped state. |
|
|
1863 | |
|
|
1864 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1865 | |
|
|
1866 | Set the callback to be called when the timer triggers. |
|
|
1867 | |
|
|
1868 | =item $pw = $timer->start ($pid) |
|
|
1869 | |
|
|
1870 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
1871 | |
|
|
1872 | =item $pw = $pw->stop |
|
|
1873 | |
|
|
1874 | Stop the watcher. |
|
|
1875 | |
|
|
1876 | =back |
|
|
1877 | |
1712 | =head1 ENVIRONMENT |
1878 | =head1 ENVIRONMENT |
1713 | |
1879 | |
1714 | =head2 URXVT_PERL_VERBOSITY |
1880 | =head2 URXVT_PERL_VERBOSITY |
1715 | |
1881 | |
1716 | This variable controls the verbosity level of the perl extension. Higher |
1882 | This variable controls the verbosity level of the perl extension. Higher |