… | |
… | |
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) |
… | |
… | |
122 | bottom. C<Escape> leaves search mode and returns to the point where search |
127 | bottom. C<Escape> leaves search mode and returns to the point where search |
123 | was started, while C<Enter> or C<Return> stay at the current position and |
128 | was started, while C<Enter> or C<Return> stay at the current position and |
124 | additionally stores the first match in the current line into the primary |
129 | additionally stores the first match in the current line into the primary |
125 | selection. |
130 | selection. |
126 | |
131 | |
|
|
132 | =item readline (enabled by default) |
|
|
133 | |
|
|
134 | A support package that tries to make editing with readline easier. At the |
|
|
135 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
136 | move the text cursor to this position. It does so by generating as many |
|
|
137 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
138 | for programs that correctly support wide characters). |
|
|
139 | |
|
|
140 | To avoid too many false positives, this is only done when: |
|
|
141 | |
|
|
142 | =over 4 |
|
|
143 | |
|
|
144 | =item - the tty is in ICANON state. |
|
|
145 | |
|
|
146 | =item - the text cursor is visible. |
|
|
147 | |
|
|
148 | =item - the primary screen is currently being displayed. |
|
|
149 | |
|
|
150 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
151 | |
|
|
152 | =back |
|
|
153 | |
|
|
154 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
155 | might interfere with selection creation in harmless ways. |
|
|
156 | |
127 | =item selection-autotransform |
157 | =item selection-autotransform |
128 | |
158 | |
129 | This selection allows you to do automatic transforms on a selection |
159 | This selection allows you to do automatic transforms on a selection |
130 | whenever a selection is made. |
160 | whenever a selection is made. |
131 | |
161 | |
… | |
… | |
143 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
173 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
144 | |
174 | |
145 | And this example matches the same,but replaces it with vi-commands you can |
175 | And this example matches the same,but replaces it with vi-commands you can |
146 | paste directly into your (vi :) editor: |
176 | paste directly into your (vi :) editor: |
147 | |
177 | |
148 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
178 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
149 | |
179 | |
150 | Of course, this can be modified to suit your needs and your editor :) |
180 | Of course, this can be modified to suit your needs and your editor :) |
151 | |
181 | |
152 | To expand the example above to typical perl error messages ("XXX at |
182 | To expand the example above to typical perl error messages ("XXX at |
153 | FILENAME line YYY."), you need a slightly more elaborate solution: |
183 | FILENAME line YYY."), you need a slightly more elaborate solution: |
154 | |
184 | |
155 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
185 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
156 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
186 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
157 | |
187 | |
158 | The first line tells the selection code to treat the unchanging part of |
188 | 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 |
189 | every error message as a selection pattern, and the second line transforms |
160 | the message into vi commands to load the file. |
190 | the message into vi commands to load the file. |
|
|
191 | |
|
|
192 | =item tabbed |
|
|
193 | |
|
|
194 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
195 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
|
|
196 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
197 | button per tab. |
|
|
198 | |
|
|
199 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
200 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
201 | while B<Shift-Down> creates a new tab. |
161 | |
202 | |
162 | =item mark-urls |
203 | =item mark-urls |
163 | |
204 | |
164 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
205 | 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 |
206 | make them clickable. When middle-clicked, the program specified in the |
… | |
… | |
298 | called whenever the relevant event happens. |
339 | called whenever the relevant event happens. |
299 | |
340 | |
300 | The first argument passed to them is an extension oject as described in |
341 | The first argument passed to them is an extension oject as described in |
301 | the in the C<Extension Objects> section. |
342 | the in the C<Extension Objects> section. |
302 | |
343 | |
303 | B<All> of these hooks must return a boolean value. If it is true, then the |
344 | B<All> of these hooks must return a boolean value. If any of the called |
304 | event counts as being I<consumed>, and the invocation of other hooks is |
345 | hooks returns true, then the event counts as being I<consumed>, and the |
305 | skipped, and the relevant action might not be carried out by the C++ code. |
346 | relevant action might not be carried out by the C++ code. |
306 | |
347 | |
307 | I<< When in doubt, return a false value (preferably C<()>). >> |
348 | I<< When in doubt, return a false value (preferably C<()>). >> |
308 | |
349 | |
309 | =over 4 |
350 | =over 4 |
310 | |
351 | |
311 | =item on_init $term |
352 | =item on_init $term |
312 | |
353 | |
313 | Called after a new terminal object has been initialized, but before |
354 | Called after a new terminal object has been initialized, but before |
314 | windows are created or the command gets run. Most methods are unsafe to |
355 | windows are created or the command gets run. Most methods are unsafe to |
315 | call or deliver senseless data, as terminal size and other characteristics |
356 | call or deliver senseless data, as terminal size and other characteristics |
316 | have not yet been determined. You can safely query and change resources, |
357 | have not yet been determined. You can safely query and change resources |
317 | though. |
358 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
359 | place. |
|
|
360 | |
|
|
361 | =item on_start $term |
|
|
362 | |
|
|
363 | Called at the very end of initialisation of a new terminal, just before |
|
|
364 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
365 | |
|
|
366 | =item on_destroy $term |
|
|
367 | |
|
|
368 | Called whenever something tries to destroy terminal, before doing anything |
|
|
369 | yet. If this hook returns true, then destruction is skipped, but this is |
|
|
370 | rarely a good idea. |
318 | |
371 | |
319 | =item on_reset $term |
372 | =item on_reset $term |
320 | |
373 | |
321 | Called after the screen is "reset" for any reason, such as resizing or |
374 | Called after the screen is "reset" for any reason, such as resizing or |
322 | control sequences. Here is where you can react on changes to size-related |
375 | control sequences. Here is where you can react on changes to size-related |
323 | variables. |
376 | variables. |
324 | |
377 | |
325 | =item on_start $term |
378 | =item on_child_start $term, $pid |
326 | |
379 | |
327 | Called at the very end of initialisation of a new terminal, just before |
380 | Called just after the child process has been C<fork>ed. |
328 | returning to the mainloop. |
381 | |
|
|
382 | =item on_child_exit $term, $status |
|
|
383 | |
|
|
384 | Called just after the child process has exited. C<$status> is the status |
|
|
385 | from C<waitpid>. |
329 | |
386 | |
330 | =item on_sel_make $term, $eventtime |
387 | =item on_sel_make $term, $eventtime |
331 | |
388 | |
332 | Called whenever a selection has been made by the user, but before the |
389 | Called whenever a selection has been made by the user, but before the |
333 | selection text is copied, so changes to the beginning, end or type of the |
390 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
444 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
501 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
445 | focus out processing. |
502 | focus out processing. |
446 | |
503 | |
447 | =item on_configure_notify $term, $event |
504 | =item on_configure_notify $term, $event |
448 | |
505 | |
|
|
506 | =item on_property_notify $term, $event |
|
|
507 | |
449 | =item on_key_press $term, $event, $keysym, $octets |
508 | =item on_key_press $term, $event, $keysym, $octets |
450 | |
509 | |
451 | =item on_key_release $term, $event, $keysym |
510 | =item on_key_release $term, $event, $keysym |
452 | |
511 | |
453 | =item on_button_press $term, $event |
512 | =item on_button_press $term, $event |
… | |
… | |
462 | |
521 | |
463 | Called whenever the corresponding X event is received for the terminal If |
522 | Called whenever the corresponding X event is received for the terminal If |
464 | the hook returns true, then the even will be ignored by rxvt-unicode. |
523 | the hook returns true, then the even will be ignored by rxvt-unicode. |
465 | |
524 | |
466 | The event is a hash with most values as named by Xlib (see the XEvent |
525 | The event is a hash with most values as named by Xlib (see the XEvent |
467 | manpage), with the additional members C<row> and C<col>, which are the row |
526 | manpage), with the additional members C<row> and C<col>, which are the |
468 | and column under the mouse cursor. |
527 | (real, not screen-based) row and column under the mouse cursor. |
469 | |
528 | |
470 | C<on_key_press> additionally receives the string rxvt-unicode would |
529 | C<on_key_press> additionally receives the string rxvt-unicode would |
471 | output, if any, in locale-specific encoding. |
530 | output, if any, in locale-specific encoding. |
472 | |
531 | |
473 | subwindow. |
532 | subwindow. |
|
|
533 | |
|
|
534 | =item on_client_message $term, $event |
|
|
535 | |
|
|
536 | =item on_wm_protocols $term, $event |
|
|
537 | |
|
|
538 | =item on_wm_delete_window $term, $event |
|
|
539 | |
|
|
540 | Called when various types of ClientMessage events are received (all with |
|
|
541 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
474 | |
542 | |
475 | =back |
543 | =back |
476 | |
544 | |
477 | =cut |
545 | =cut |
478 | |
546 | |
… | |
… | |
484 | use Scalar::Util (); |
552 | use Scalar::Util (); |
485 | use List::Util (); |
553 | use List::Util (); |
486 | |
554 | |
487 | our $VERSION = 1; |
555 | our $VERSION = 1; |
488 | our $TERM; |
556 | our $TERM; |
|
|
557 | our @TERM_INIT; |
|
|
558 | our @TERM_EXT; |
489 | our @HOOKNAME; |
559 | our @HOOKNAME; |
490 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
560 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
491 | our %OPTION; |
561 | our %OPTION; |
492 | |
562 | |
493 | our $LIBDIR; |
563 | our $LIBDIR; |
494 | our $RESNAME; |
564 | our $RESNAME; |
495 | our $RESCLASS; |
565 | our $RESCLASS; |
496 | our $RXVTNAME; |
566 | our $RXVTNAME; |
497 | |
567 | |
|
|
568 | our $NOCHAR = chr 0xffff; |
|
|
569 | |
498 | =head2 Variables in the C<urxvt> Package |
570 | =head2 Variables in the C<urxvt> Package |
499 | |
571 | |
500 | =over 4 |
572 | =over 4 |
501 | |
573 | |
502 | =item $urxvt::LIBDIR |
574 | =item $urxvt::LIBDIR |
… | |
… | |
514 | |
586 | |
515 | =item $urxvt::TERM |
587 | =item $urxvt::TERM |
516 | |
588 | |
517 | The current terminal. This variable stores the current C<urxvt::term> |
589 | The current terminal. This variable stores the current C<urxvt::term> |
518 | object, whenever a callback/hook is executing. |
590 | object, whenever a callback/hook is executing. |
|
|
591 | |
|
|
592 | =item @urxvt::TERM_INIT |
|
|
593 | |
|
|
594 | All coderefs in this array will be called as methods of the next newly |
|
|
595 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
596 | gets cleared before the codereferences that were in it are being executed, |
|
|
597 | so coderefs can push themselves onto it again if they so desire. |
|
|
598 | |
|
|
599 | This complements to the perl-eval commandline option, but gets executed |
|
|
600 | first. |
|
|
601 | |
|
|
602 | =item @urxvt::TERM_EXT |
|
|
603 | |
|
|
604 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
605 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
606 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
519 | |
607 | |
520 | =back |
608 | =back |
521 | |
609 | |
522 | =head2 Functions in the C<urxvt> Package |
610 | =head2 Functions in the C<urxvt> Package |
523 | |
611 | |
… | |
… | |
632 | unless $msg =~ /\n$/; |
720 | unless $msg =~ /\n$/; |
633 | urxvt::warn ($msg); |
721 | urxvt::warn ($msg); |
634 | }; |
722 | }; |
635 | } |
723 | } |
636 | |
724 | |
|
|
725 | no warnings 'utf8'; |
|
|
726 | |
637 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
727 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
638 | |
728 | |
639 | sub verbose { |
729 | sub verbose { |
640 | my ($level, $msg) = @_; |
730 | my ($level, $msg) = @_; |
641 | warn "$msg\n" if $level <= $verbosity; |
731 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
644 | my %extension_pkg; |
734 | my %extension_pkg; |
645 | |
735 | |
646 | # load a single script into its own package, once only |
736 | # load a single script into its own package, once only |
647 | sub extension_package($) { |
737 | sub extension_package($) { |
648 | my ($path) = @_; |
738 | my ($path) = @_; |
649 | |
|
|
650 | no strict 'refs'; |
|
|
651 | |
739 | |
652 | $extension_pkg{$path} ||= do { |
740 | $extension_pkg{$path} ||= do { |
653 | $path =~ /([^\/\\]+)$/; |
741 | $path =~ /([^\/\\]+)$/; |
654 | my $pkg = $1; |
742 | my $pkg = $1; |
655 | $pkg =~ s/[^[:word:]]/_/g; |
743 | $pkg =~ s/[^[:word:]]/_/g; |
… | |
… | |
658 | verbose 3, "loading extension '$path' into package '$pkg'"; |
746 | verbose 3, "loading extension '$path' into package '$pkg'"; |
659 | |
747 | |
660 | open my $fh, "<:raw", $path |
748 | open my $fh, "<:raw", $path |
661 | or die "$path: $!"; |
749 | or die "$path: $!"; |
662 | |
750 | |
663 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
664 | |
|
|
665 | my $source = |
751 | my $source = |
666 | "package $pkg; use strict; use utf8;\n" |
752 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
667 | . "#line 1 \"$path\"\n{\n" |
753 | . "#line 1 \"$path\"\n{\n" |
668 | . (do { local $/; <$fh> }) |
754 | . (do { local $/; <$fh> }) |
669 | . "\n};\n1"; |
755 | . "\n};\n1"; |
670 | |
756 | |
671 | eval $source |
757 | eval $source |
… | |
… | |
685 | if ($htype == 0) { # INIT |
771 | if ($htype == 0) { # INIT |
686 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
772 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
687 | |
773 | |
688 | my %ext_arg; |
774 | my %ext_arg; |
689 | |
775 | |
|
|
776 | { |
|
|
777 | my @init = @TERM_INIT; |
|
|
778 | @TERM_INIT = (); |
|
|
779 | $_->($TERM) for @init; |
|
|
780 | my @pkg = @TERM_EXT; |
|
|
781 | @TERM_EXT = (); |
|
|
782 | $TERM->register_package ($_) for @pkg; |
|
|
783 | } |
|
|
784 | |
690 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
785 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
691 | if ($_ eq "default") { |
786 | if ($_ eq "default") { |
692 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
787 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
693 | } elsif (/^-(.*)$/) { |
788 | } elsif (/^-(.*)$/) { |
694 | delete $ext_arg{$1}; |
789 | delete $ext_arg{$1}; |
695 | } elsif (/^([^<]+)<(.*)>$/) { |
790 | } elsif (/^([^<]+)<(.*)>$/) { |
696 | push @{ $ext_arg{$1} }, $2; |
791 | push @{ $ext_arg{$1} }, $2; |
697 | } else { |
792 | } else { |
… | |
… | |
720 | if $verbosity >= 10; |
815 | if $verbosity >= 10; |
721 | |
816 | |
722 | keys %$cb; |
817 | keys %$cb; |
723 | |
818 | |
724 | while (my ($pkg, $cb) = each %$cb) { |
819 | while (my ($pkg, $cb) = each %$cb) { |
725 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
820 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
726 | and last; |
821 | $retval ||= $retval_; |
727 | |
822 | |
728 | if ($@) { |
823 | if ($@) { |
729 | $TERM->ungrab; # better to lose the grab than the session |
824 | $TERM->ungrab; # better to lose the grab than the session |
730 | warn $@; |
825 | warn $@; |
731 | } |
826 | } |
… | |
… | |
742 | # clear package |
837 | # clear package |
743 | %$TERM = (); |
838 | %$TERM = (); |
744 | } |
839 | } |
745 | |
840 | |
746 | $retval |
841 | $retval |
747 | } |
|
|
748 | |
|
|
749 | sub exec_async(@) { |
|
|
750 | my $pid = fork; |
|
|
751 | |
|
|
752 | return |
|
|
753 | if !defined $pid or $pid; |
|
|
754 | |
|
|
755 | %ENV = %{ $TERM->env }; |
|
|
756 | |
|
|
757 | exec @_; |
|
|
758 | _exit 255; |
|
|
759 | } |
842 | } |
760 | |
843 | |
761 | # urxvt::term::extension |
844 | # urxvt::term::extension |
762 | |
845 | |
763 | package urxvt::term::extension; |
846 | package urxvt::term::extension; |
… | |
… | |
902 | # find on_xxx subs in the package and register them |
985 | # find on_xxx subs in the package and register them |
903 | # as hooks |
986 | # as hooks |
904 | sub register_package { |
987 | sub register_package { |
905 | my ($self, $pkg, $argv) = @_; |
988 | my ($self, $pkg, $argv) = @_; |
906 | |
989 | |
|
|
990 | no strict 'refs'; |
|
|
991 | |
|
|
992 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
993 | |
|
|
994 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
995 | |
907 | my $proxy = bless { |
996 | my $proxy = bless { |
908 | _pkg => $pkg, |
997 | _pkg => $pkg, |
909 | argv => $argv, |
998 | argv => $argv, |
910 | }, $pkg; |
999 | }, $pkg; |
911 | Scalar::Util::weaken ($proxy->{term} = $self); |
1000 | Scalar::Util::weaken ($proxy->{term} = $self); |
… | |
… | |
941 | =item $term->destroy |
1030 | =item $term->destroy |
942 | |
1031 | |
943 | Destroy the terminal object (close the window, free resources |
1032 | Destroy the terminal object (close the window, free resources |
944 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1033 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
945 | watchers (timers, io watchers) are still active. |
1034 | watchers (timers, io watchers) are still active. |
|
|
1035 | |
|
|
1036 | =item $term->exec_async ($cmd[, @args]) |
|
|
1037 | |
|
|
1038 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
1039 | ("starts") programs in the background. This function takes care of setting |
|
|
1040 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
1041 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
1042 | |
|
|
1043 | Returns the pid of the subprocess or C<undef> on error. |
|
|
1044 | |
|
|
1045 | =cut |
|
|
1046 | |
|
|
1047 | sub exec_async { |
|
|
1048 | my $self = shift; |
|
|
1049 | |
|
|
1050 | my $pid = fork; |
|
|
1051 | |
|
|
1052 | return $pid |
|
|
1053 | if !defined $pid or $pid; |
|
|
1054 | |
|
|
1055 | %ENV = %{ $self->env }; |
|
|
1056 | |
|
|
1057 | exec @_; |
|
|
1058 | urxvt::_exit 255; |
|
|
1059 | } |
946 | |
1060 | |
947 | =item $isset = $term->option ($optval[, $set]) |
1061 | =item $isset = $term->option ($optval[, $set]) |
948 | |
1062 | |
949 | Returns true if the option specified by C<$optval> is enabled, and |
1063 | Returns true if the option specified by C<$optval> is enabled, and |
950 | optionally change it. All option values are stored by name in the hash |
1064 | optionally change it. All option values are stored by name in the hash |
… | |
… | |
1175 | |
1289 | |
1176 | Normally its not a good idea to use this function, as programs might be |
1290 | Normally its not a good idea to use this function, as programs might be |
1177 | confused by changes in cursor position or scrolling. Its useful inside a |
1291 | confused by changes in cursor position or scrolling. Its useful inside a |
1178 | C<on_add_lines> hook, though. |
1292 | C<on_add_lines> hook, though. |
1179 | |
1293 | |
|
|
1294 | =item $term->scr_change_screen ($screen) |
|
|
1295 | |
|
|
1296 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1297 | |
1180 | =item $term->cmd_parse ($octets) |
1298 | =item $term->cmd_parse ($octets) |
1181 | |
1299 | |
1182 | Similar to C<scr_add_lines>, but the argument must be in the |
1300 | Similar to C<scr_add_lines>, but the argument must be in the |
1183 | locale-specific encoding of the terminal and can contain command sequences |
1301 | locale-specific encoding of the terminal and can contain command sequences |
1184 | (escape codes) that will be interpreted. |
1302 | (escape codes) that will be interpreted. |
… | |
… | |
1193 | |
1311 | |
1194 | Replaces the event mask of the pty watcher by the given event mask. Can |
1312 | Replaces the event mask of the pty watcher by the given event mask. Can |
1195 | be used to suppress input and output handling to the pty/tty. See the |
1313 | be used to suppress input and output handling to the pty/tty. See the |
1196 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1314 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1197 | the previous value. |
1315 | the previous value. |
|
|
1316 | |
|
|
1317 | =item $fd = $term->pty_fd |
|
|
1318 | |
|
|
1319 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1320 | is used. |
1198 | |
1321 | |
1199 | =item $windowid = $term->parent |
1322 | =item $windowid = $term->parent |
1200 | |
1323 | |
1201 | Return the window id of the toplevel window. |
1324 | Return the window id of the toplevel window. |
1202 | |
1325 | |
… | |
… | |
1267 | =item $modifiermask = $term->ModNumLockMask |
1390 | =item $modifiermask = $term->ModNumLockMask |
1268 | |
1391 | |
1269 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1392 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1270 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1393 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1271 | |
1394 | |
|
|
1395 | =item $screen = $term->current_screen |
|
|
1396 | |
|
|
1397 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1398 | |
|
|
1399 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1400 | |
|
|
1401 | Returns wether the cursor is currently hidden or not. |
|
|
1402 | |
1272 | =item $view_start = $term->view_start ([$newvalue]) |
1403 | =item $view_start = $term->view_start ([$newvalue]) |
1273 | |
1404 | |
1274 | Returns the row number of the topmost displayed line. Maximum value is |
1405 | Returns the row number of the topmost displayed line. Maximum value is |
1275 | C<0>, which displays the normal terminal contents. Lower values scroll |
1406 | C<0>, which displays the normal terminal contents. Lower values scroll |
1276 | this many lines into the scrollback buffer. |
1407 | this many lines into the scrollback buffer. |
… | |
… | |
1295 | line, starting at column C<$start_col> (default C<0>), which is useful |
1426 | line, starting at column C<$start_col> (default C<0>), which is useful |
1296 | to replace only parts of a line. The font index in the rendition will |
1427 | to replace only parts of a line. The font index in the rendition will |
1297 | automatically be updated. |
1428 | automatically be updated. |
1298 | |
1429 | |
1299 | C<$text> is in a special encoding: tabs and wide characters that use more |
1430 | C<$text> is in a special encoding: tabs and wide characters that use more |
1300 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1431 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1301 | (C<chr 65535>). Characters with combining characters and other characters |
1432 | characters. Characters with combining characters and other characters that |
1302 | that do not fit into the normal tetx encoding will be replaced with |
1433 | do not fit into the normal tetx encoding will be replaced with characters |
1303 | characters in the private use area. |
1434 | in the private use area. |
1304 | |
1435 | |
1305 | You have to obey this encoding when changing text. The advantage is |
1436 | You have to obey this encoding when changing text. The advantage is |
1306 | that C<substr> and similar functions work on screen cells and not on |
1437 | that C<substr> and similar functions work on screen cells and not on |
1307 | characters. |
1438 | characters. |
1308 | |
1439 | |
… | |
… | |
1482 | =item $term->ungrab |
1613 | =item $term->ungrab |
1483 | |
1614 | |
1484 | Calls XUngrab for the most recent grab. Is called automatically on |
1615 | Calls XUngrab for the most recent grab. Is called automatically on |
1485 | evaluation errors, as it is better to lose the grab in the error case as |
1616 | evaluation errors, as it is better to lose the grab in the error case as |
1486 | the session. |
1617 | the session. |
|
|
1618 | |
|
|
1619 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1620 | |
|
|
1621 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1622 | |
|
|
1623 | =item @atoms = $term->XListProperties ($window) |
|
|
1624 | |
|
|
1625 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1626 | |
|
|
1627 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1628 | |
|
|
1629 | =item $term->XDeleteProperty ($window, $property) |
|
|
1630 | |
|
|
1631 | =item $window = $term->DefaultRootWindow |
|
|
1632 | |
|
|
1633 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1634 | |
|
|
1635 | =item $term->XMapWindow ($window) |
|
|
1636 | |
|
|
1637 | =item $term->XUnmapWindow ($window) |
|
|
1638 | |
|
|
1639 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1640 | |
|
|
1641 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1642 | |
|
|
1643 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1644 | |
|
|
1645 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1646 | the source of the display, otherwise those functions map more-or-less |
|
|
1647 | directory onto the X functions of the same name. |
1487 | |
1648 | |
1488 | =back |
1649 | =back |
1489 | |
1650 | |
1490 | =cut |
1651 | =cut |
1491 | |
1652 | |
… | |
… | |
1611 | delete $self->{term}{_destroy}{$self}; |
1772 | delete $self->{term}{_destroy}{$self}; |
1612 | $self->{term}->ungrab; |
1773 | $self->{term}->ungrab; |
1613 | } |
1774 | } |
1614 | |
1775 | |
1615 | =back |
1776 | =back |
|
|
1777 | |
|
|
1778 | =cut |
|
|
1779 | |
|
|
1780 | package urxvt::watcher; |
|
|
1781 | |
|
|
1782 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1783 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1784 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1785 | @urxvt::iw::ISA = __PACKAGE__; |
1616 | |
1786 | |
1617 | =head2 The C<urxvt::timer> Class |
1787 | =head2 The C<urxvt::timer> Class |
1618 | |
1788 | |
1619 | This class implements timer watchers/events. Time is represented as a |
1789 | This class implements timer watchers/events. Time is represented as a |
1620 | fractional number of seconds since the epoch. Example: |
1790 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1718 | |
1888 | |
1719 | Stop watching for events on the given filehandle. |
1889 | Stop watching for events on the given filehandle. |
1720 | |
1890 | |
1721 | =back |
1891 | =back |
1722 | |
1892 | |
|
|
1893 | =head2 The C<urxvt::iw> Class |
|
|
1894 | |
|
|
1895 | This class implements idle watchers, that get called automatically when |
|
|
1896 | the process is idle. They should return as fast as possible, after doing |
|
|
1897 | some useful work. |
|
|
1898 | |
|
|
1899 | =over 4 |
|
|
1900 | |
|
|
1901 | =item $iw = new urxvt::iw |
|
|
1902 | |
|
|
1903 | Create a new idle watcher object in stopped state. |
|
|
1904 | |
|
|
1905 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1906 | |
|
|
1907 | Set the callback to be called when the watcher triggers. |
|
|
1908 | |
|
|
1909 | =item $timer = $timer->start |
|
|
1910 | |
|
|
1911 | Start the watcher. |
|
|
1912 | |
|
|
1913 | =item $timer = $timer->stop |
|
|
1914 | |
|
|
1915 | Stop the watcher. |
|
|
1916 | |
|
|
1917 | =back |
|
|
1918 | |
|
|
1919 | =head2 The C<urxvt::pw> Class |
|
|
1920 | |
|
|
1921 | This class implements process watchers. They create an event whenever a |
|
|
1922 | process exits, after which they stop automatically. |
|
|
1923 | |
|
|
1924 | my $pid = fork; |
|
|
1925 | ... |
|
|
1926 | $term->{pw} = urxvt::pw |
|
|
1927 | ->new |
|
|
1928 | ->start ($pid) |
|
|
1929 | ->cb (sub { |
|
|
1930 | my ($pw, $exit_status) = @_; |
|
|
1931 | ... |
|
|
1932 | }); |
|
|
1933 | |
|
|
1934 | =over 4 |
|
|
1935 | |
|
|
1936 | =item $pw = new urxvt::pw |
|
|
1937 | |
|
|
1938 | Create a new process watcher in stopped state. |
|
|
1939 | |
|
|
1940 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1941 | |
|
|
1942 | Set the callback to be called when the timer triggers. |
|
|
1943 | |
|
|
1944 | =item $pw = $timer->start ($pid) |
|
|
1945 | |
|
|
1946 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
1947 | |
|
|
1948 | =item $pw = $pw->stop |
|
|
1949 | |
|
|
1950 | Stop the watcher. |
|
|
1951 | |
|
|
1952 | =back |
|
|
1953 | |
1723 | =head1 ENVIRONMENT |
1954 | =head1 ENVIRONMENT |
1724 | |
1955 | |
1725 | =head2 URXVT_PERL_VERBOSITY |
1956 | =head2 URXVT_PERL_VERBOSITY |
1726 | |
1957 | |
1727 | This variable controls the verbosity level of the perl extension. Higher |
1958 | This variable controls the verbosity level of the perl extension. Higher |