… | |
… | |
67 | the match. For example, the followign adds a regex that matches everything |
67 | the match. For example, the followign adds a regex that matches everything |
68 | between two vertical bars: |
68 | between two vertical bars: |
69 | |
69 | |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
71 | |
71 | |
|
|
72 | Another example: Programs I use often output "absolute path: " at the |
|
|
73 | beginning of a line when they process multiple files. The following |
|
|
74 | pattern matches the filename (note, there is a single space at the very |
|
|
75 | end): |
|
|
76 | |
|
|
77 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
|
|
78 | |
72 | You can look at the source of the selection extension to see more |
79 | You can look at the source of the selection extension to see more |
73 | interesting uses, such as parsing a line from beginning to end. |
80 | interesting uses, such as parsing a line from beginning to end. |
74 | |
81 | |
75 | This extension also offers following bindable keyboard commands: |
82 | This extension also offers following bindable keyboard commands: |
76 | |
83 | |
… | |
… | |
91 | |
98 | |
92 | =item selection-popup (enabled by default) |
99 | =item selection-popup (enabled by default) |
93 | |
100 | |
94 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
101 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
95 | text into various other formats/action (such as uri unescaping, perl |
102 | text into various other formats/action (such as uri unescaping, perl |
96 | evalution, web-browser starting etc.), depending on content. |
103 | evaluation, web-browser starting etc.), depending on content. |
97 | |
104 | |
98 | Other extensions can extend this popup menu by pushing a code reference |
105 | Other extensions can extend this popup menu by pushing a code reference |
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
106 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
100 | popup is displayed. |
107 | popup is displayed. |
101 | |
108 | |
… | |
… | |
127 | bottom. C<Escape> leaves search mode and returns to the point where search |
134 | bottom. C<Escape> leaves search mode and returns to the point where search |
128 | was started, while C<Enter> or C<Return> stay at the current position and |
135 | was started, while C<Enter> or C<Return> stay at the current position and |
129 | additionally stores the first match in the current line into the primary |
136 | additionally stores the first match in the current line into the primary |
130 | selection. |
137 | selection. |
131 | |
138 | |
|
|
139 | =item readline (enabled by default) |
|
|
140 | |
|
|
141 | A support package that tries to make editing with readline easier. At the |
|
|
142 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
143 | move the text cursor to this position. It does so by generating as many |
|
|
144 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
145 | for programs that correctly support wide characters). |
|
|
146 | |
|
|
147 | To avoid too many false positives, this is only done when: |
|
|
148 | |
|
|
149 | =over 4 |
|
|
150 | |
|
|
151 | =item - the tty is in ICANON state. |
|
|
152 | |
|
|
153 | =item - the text cursor is visible. |
|
|
154 | |
|
|
155 | =item - the primary screen is currently being displayed. |
|
|
156 | |
|
|
157 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
158 | |
|
|
159 | =back |
|
|
160 | |
|
|
161 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
162 | might interfere with selection creation in harmless ways. |
|
|
163 | |
132 | =item selection-autotransform |
164 | =item selection-autotransform |
133 | |
165 | |
134 | This selection allows you to do automatic transforms on a selection |
166 | This selection allows you to do automatic transforms on a selection |
135 | whenever a selection is made. |
167 | whenever a selection is made. |
136 | |
168 | |
… | |
… | |
161 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
193 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
162 | |
194 | |
163 | The first line tells the selection code to treat the unchanging part of |
195 | The first line tells the selection code to treat the unchanging part of |
164 | every error message as a selection pattern, and the second line transforms |
196 | every error message as a selection pattern, and the second line transforms |
165 | the message into vi commands to load the file. |
197 | the message into vi commands to load the file. |
|
|
198 | |
|
|
199 | =item tabbed |
|
|
200 | |
|
|
201 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
202 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
|
|
203 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
204 | button per tab. |
|
|
205 | |
|
|
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
207 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
208 | while B<Shift-Down> creates a new tab. |
166 | |
209 | |
167 | =item mark-urls |
210 | =item mark-urls |
168 | |
211 | |
169 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
212 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
170 | make them clickable. When middle-clicked, the program specified in the |
213 | make them clickable. When middle-clicked, the program specified in the |
171 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
214 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
172 | the URL as first argument. |
215 | the URL as first argument. |
173 | |
216 | |
|
|
217 | =item xim-onthespot |
|
|
218 | |
|
|
219 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
220 | not work perfectly, and some input methods don't seem to work well with |
|
|
221 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
222 | kinput2. |
|
|
223 | |
|
|
224 | You enable it by specifying this extension and a preedit style of |
|
|
225 | C<OnTheSpot>, i.e.: |
|
|
226 | |
|
|
227 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
228 | |
174 | =item automove-background |
229 | =item automove-background |
175 | |
230 | |
176 | This is basically a one-line extension that dynamically changes the background pixmap offset |
231 | This is basically a one-line extension that dynamically changes the background pixmap offset |
177 | to the window position, in effect creating the same effect as pseudo transparency with |
232 | to the window position, in effect creating the same effect as pseudo transparency with |
178 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
233 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
… | |
… | |
187 | |
242 | |
188 | =item digital-clock |
243 | =item digital-clock |
189 | |
244 | |
190 | Displays a digital clock using the built-in overlay. |
245 | Displays a digital clock using the built-in overlay. |
191 | |
246 | |
192 | =item example-refresh-hooks |
247 | =item remote-selection |
193 | |
248 | |
194 | Displays a very simple digital clock in the upper right corner of the |
249 | Somewhat of a misnomer, this extension adds two menu entries to the |
195 | window. Illustrates overwriting the refresh callbacks to create your own |
250 | selection popup that allows one ti run external commands to store the |
196 | overlays or changes. |
251 | selection somewhere and fetch it again. |
|
|
252 | |
|
|
253 | We use it to implement a "distributed selection mechanism", which just |
|
|
254 | means that one command uploads the file to a remote server, and another |
|
|
255 | reads it. |
|
|
256 | |
|
|
257 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
258 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
259 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
260 | the selection data on STDOUT (also in UTF-8). |
|
|
261 | |
|
|
262 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
263 | |
|
|
264 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
265 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
197 | |
266 | |
198 | =item selection-pastebin |
267 | =item selection-pastebin |
199 | |
268 | |
200 | This is a little rarely useful extension that Uploads the selection as |
269 | This is a little rarely useful extension that Uploads the selection as |
201 | textfile to a remote site (or does other things). (The implementation is |
270 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
221 | After a successful upload the selection will be replaced by the text given |
290 | After a successful upload the selection will be replaced by the text given |
222 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
291 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
223 | for the filename): |
292 | for the filename): |
224 | |
293 | |
225 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
294 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
295 | |
|
|
296 | =item example-refresh-hooks |
|
|
297 | |
|
|
298 | Displays a very simple digital clock in the upper right corner of the |
|
|
299 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
300 | overlays or changes. |
226 | |
301 | |
227 | =back |
302 | =back |
228 | |
303 | |
229 | =head1 API DOCUMENTATION |
304 | =head1 API DOCUMENTATION |
230 | |
305 | |
… | |
… | |
303 | called whenever the relevant event happens. |
378 | called whenever the relevant event happens. |
304 | |
379 | |
305 | The first argument passed to them is an extension oject as described in |
380 | The first argument passed to them is an extension oject as described in |
306 | the in the C<Extension Objects> section. |
381 | the in the C<Extension Objects> section. |
307 | |
382 | |
308 | B<All> of these hooks must return a boolean value. If it is true, then the |
383 | B<All> of these hooks must return a boolean value. If any of the called |
309 | event counts as being I<consumed>, and the invocation of other hooks is |
384 | hooks returns true, then the event counts as being I<consumed>, and the |
310 | skipped, and the relevant action might not be carried out by the C++ code. |
385 | relevant action might not be carried out by the C++ code. |
311 | |
386 | |
312 | I<< When in doubt, return a false value (preferably C<()>). >> |
387 | I<< When in doubt, return a false value (preferably C<()>). >> |
313 | |
388 | |
314 | =over 4 |
389 | =over 4 |
315 | |
390 | |
316 | =item on_init $term |
391 | =item on_init $term |
317 | |
392 | |
318 | Called after a new terminal object has been initialized, but before |
393 | Called after a new terminal object has been initialized, but before |
319 | windows are created or the command gets run. Most methods are unsafe to |
394 | windows are created or the command gets run. Most methods are unsafe to |
320 | call or deliver senseless data, as terminal size and other characteristics |
395 | call or deliver senseless data, as terminal size and other characteristics |
321 | have not yet been determined. You can safely query and change resources, |
396 | have not yet been determined. You can safely query and change resources |
322 | though. |
397 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
398 | place. |
|
|
399 | |
|
|
400 | =item on_start $term |
|
|
401 | |
|
|
402 | Called at the very end of initialisation of a new terminal, just before |
|
|
403 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
404 | |
|
|
405 | =item on_destroy $term |
|
|
406 | |
|
|
407 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
408 | still fully functional (not for long, though). |
323 | |
409 | |
324 | =item on_reset $term |
410 | =item on_reset $term |
325 | |
411 | |
326 | Called after the screen is "reset" for any reason, such as resizing or |
412 | Called after the screen is "reset" for any reason, such as resizing or |
327 | control sequences. Here is where you can react on changes to size-related |
413 | control sequences. Here is where you can react on changes to size-related |
328 | variables. |
414 | variables. |
329 | |
|
|
330 | =item on_start $term |
|
|
331 | |
|
|
332 | Called at the very end of initialisation of a new terminal, just before |
|
|
333 | returning to the mainloop. |
|
|
334 | |
415 | |
335 | =item on_child_start $term, $pid |
416 | =item on_child_start $term, $pid |
336 | |
417 | |
337 | Called just after the child process has been C<fork>ed. |
418 | Called just after the child process has been C<fork>ed. |
338 | |
419 | |
… | |
… | |
458 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
539 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
459 | focus out processing. |
540 | focus out processing. |
460 | |
541 | |
461 | =item on_configure_notify $term, $event |
542 | =item on_configure_notify $term, $event |
462 | |
543 | |
|
|
544 | =item on_property_notify $term, $event |
|
|
545 | |
463 | =item on_key_press $term, $event, $keysym, $octets |
546 | =item on_key_press $term, $event, $keysym, $octets |
464 | |
547 | |
465 | =item on_key_release $term, $event, $keysym |
548 | =item on_key_release $term, $event, $keysym |
466 | |
549 | |
467 | =item on_button_press $term, $event |
550 | =item on_button_press $term, $event |
… | |
… | |
476 | |
559 | |
477 | Called whenever the corresponding X event is received for the terminal If |
560 | Called whenever the corresponding X event is received for the terminal If |
478 | the hook returns true, then the even will be ignored by rxvt-unicode. |
561 | the hook returns true, then the even will be ignored by rxvt-unicode. |
479 | |
562 | |
480 | The event is a hash with most values as named by Xlib (see the XEvent |
563 | The event is a hash with most values as named by Xlib (see the XEvent |
481 | manpage), with the additional members C<row> and C<col>, which are the row |
564 | manpage), with the additional members C<row> and C<col>, which are the |
482 | and column under the mouse cursor. |
565 | (real, not screen-based) row and column under the mouse cursor. |
483 | |
566 | |
484 | C<on_key_press> additionally receives the string rxvt-unicode would |
567 | C<on_key_press> additionally receives the string rxvt-unicode would |
485 | output, if any, in locale-specific encoding. |
568 | output, if any, in locale-specific encoding. |
486 | |
569 | |
487 | subwindow. |
570 | subwindow. |
|
|
571 | |
|
|
572 | =item on_client_message $term, $event |
|
|
573 | |
|
|
574 | =item on_wm_protocols $term, $event |
|
|
575 | |
|
|
576 | =item on_wm_delete_window $term, $event |
|
|
577 | |
|
|
578 | Called when various types of ClientMessage events are received (all with |
|
|
579 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
488 | |
580 | |
489 | =back |
581 | =back |
490 | |
582 | |
491 | =cut |
583 | =cut |
492 | |
584 | |
… | |
… | |
498 | use Scalar::Util (); |
590 | use Scalar::Util (); |
499 | use List::Util (); |
591 | use List::Util (); |
500 | |
592 | |
501 | our $VERSION = 1; |
593 | our $VERSION = 1; |
502 | our $TERM; |
594 | our $TERM; |
|
|
595 | our @TERM_INIT; |
|
|
596 | our @TERM_EXT; |
503 | our @HOOKNAME; |
597 | our @HOOKNAME; |
504 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
598 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
505 | our %OPTION; |
599 | our %OPTION; |
506 | |
600 | |
507 | our $LIBDIR; |
601 | our $LIBDIR; |
508 | our $RESNAME; |
602 | our $RESNAME; |
509 | our $RESCLASS; |
603 | our $RESCLASS; |
510 | our $RXVTNAME; |
604 | our $RXVTNAME; |
511 | |
605 | |
|
|
606 | our $NOCHAR = chr 0xffff; |
|
|
607 | |
512 | =head2 Variables in the C<urxvt> Package |
608 | =head2 Variables in the C<urxvt> Package |
513 | |
609 | |
514 | =over 4 |
610 | =over 4 |
515 | |
611 | |
516 | =item $urxvt::LIBDIR |
612 | =item $urxvt::LIBDIR |
… | |
… | |
528 | |
624 | |
529 | =item $urxvt::TERM |
625 | =item $urxvt::TERM |
530 | |
626 | |
531 | The current terminal. This variable stores the current C<urxvt::term> |
627 | The current terminal. This variable stores the current C<urxvt::term> |
532 | object, whenever a callback/hook is executing. |
628 | object, whenever a callback/hook is executing. |
|
|
629 | |
|
|
630 | =item @urxvt::TERM_INIT |
|
|
631 | |
|
|
632 | All coderefs in this array will be called as methods of the next newly |
|
|
633 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
634 | gets cleared before the codereferences that were in it are being executed, |
|
|
635 | so coderefs can push themselves onto it again if they so desire. |
|
|
636 | |
|
|
637 | This complements to the perl-eval commandline option, but gets executed |
|
|
638 | first. |
|
|
639 | |
|
|
640 | =item @urxvt::TERM_EXT |
|
|
641 | |
|
|
642 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
643 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
644 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
533 | |
645 | |
534 | =back |
646 | =back |
535 | |
647 | |
536 | =head2 Functions in the C<urxvt> Package |
648 | =head2 Functions in the C<urxvt> Package |
537 | |
649 | |
… | |
… | |
646 | unless $msg =~ /\n$/; |
758 | unless $msg =~ /\n$/; |
647 | urxvt::warn ($msg); |
759 | urxvt::warn ($msg); |
648 | }; |
760 | }; |
649 | } |
761 | } |
650 | |
762 | |
|
|
763 | no warnings 'utf8'; |
|
|
764 | |
651 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
765 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
652 | |
766 | |
653 | sub verbose { |
767 | sub verbose { |
654 | my ($level, $msg) = @_; |
768 | my ($level, $msg) = @_; |
655 | warn "$msg\n" if $level <= $verbosity; |
769 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
658 | my %extension_pkg; |
772 | my %extension_pkg; |
659 | |
773 | |
660 | # load a single script into its own package, once only |
774 | # load a single script into its own package, once only |
661 | sub extension_package($) { |
775 | sub extension_package($) { |
662 | my ($path) = @_; |
776 | my ($path) = @_; |
663 | |
|
|
664 | no strict 'refs'; |
|
|
665 | |
777 | |
666 | $extension_pkg{$path} ||= do { |
778 | $extension_pkg{$path} ||= do { |
667 | $path =~ /([^\/\\]+)$/; |
779 | $path =~ /([^\/\\]+)$/; |
668 | my $pkg = $1; |
780 | my $pkg = $1; |
669 | $pkg =~ s/[^[:word:]]/_/g; |
781 | $pkg =~ s/[^[:word:]]/_/g; |
… | |
… | |
672 | verbose 3, "loading extension '$path' into package '$pkg'"; |
784 | verbose 3, "loading extension '$path' into package '$pkg'"; |
673 | |
785 | |
674 | open my $fh, "<:raw", $path |
786 | open my $fh, "<:raw", $path |
675 | or die "$path: $!"; |
787 | or die "$path: $!"; |
676 | |
788 | |
677 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
678 | |
|
|
679 | my $source = |
789 | my $source = |
680 | "package $pkg; use strict; use utf8;\n" |
790 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
681 | . "#line 1 \"$path\"\n{\n" |
791 | . "#line 1 \"$path\"\n{\n" |
682 | . (do { local $/; <$fh> }) |
792 | . (do { local $/; <$fh> }) |
683 | . "\n};\n1"; |
793 | . "\n};\n1"; |
684 | |
794 | |
685 | eval $source |
795 | eval $source |
… | |
… | |
699 | if ($htype == 0) { # INIT |
809 | if ($htype == 0) { # INIT |
700 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
810 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
701 | |
811 | |
702 | my %ext_arg; |
812 | my %ext_arg; |
703 | |
813 | |
|
|
814 | { |
|
|
815 | my @init = @TERM_INIT; |
|
|
816 | @TERM_INIT = (); |
|
|
817 | $_->($TERM) for @init; |
|
|
818 | my @pkg = @TERM_EXT; |
|
|
819 | @TERM_EXT = (); |
|
|
820 | $TERM->register_package ($_) for @pkg; |
|
|
821 | } |
|
|
822 | |
704 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
823 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
705 | if ($_ eq "default") { |
824 | if ($_ eq "default") { |
706 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
825 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
707 | } elsif (/^-(.*)$/) { |
826 | } elsif (/^-(.*)$/) { |
708 | delete $ext_arg{$1}; |
827 | delete $ext_arg{$1}; |
709 | } elsif (/^([^<]+)<(.*)>$/) { |
828 | } elsif (/^([^<]+)<(.*)>$/) { |
710 | push @{ $ext_arg{$1} }, $2; |
829 | push @{ $ext_arg{$1} }, $2; |
711 | } else { |
830 | } else { |
… | |
… | |
734 | if $verbosity >= 10; |
853 | if $verbosity >= 10; |
735 | |
854 | |
736 | keys %$cb; |
855 | keys %$cb; |
737 | |
856 | |
738 | while (my ($pkg, $cb) = each %$cb) { |
857 | while (my ($pkg, $cb) = each %$cb) { |
739 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
858 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
740 | and last; |
859 | $retval ||= $retval_; |
741 | |
860 | |
742 | if ($@) { |
861 | if ($@) { |
743 | $TERM->ungrab; # better to lose the grab than the session |
862 | $TERM->ungrab; # better to lose the grab than the session |
744 | warn $@; |
863 | warn $@; |
745 | } |
864 | } |
… | |
… | |
903 | |
1022 | |
904 | # find on_xxx subs in the package and register them |
1023 | # find on_xxx subs in the package and register them |
905 | # as hooks |
1024 | # as hooks |
906 | sub register_package { |
1025 | sub register_package { |
907 | my ($self, $pkg, $argv) = @_; |
1026 | my ($self, $pkg, $argv) = @_; |
|
|
1027 | |
|
|
1028 | no strict 'refs'; |
|
|
1029 | |
|
|
1030 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
1031 | |
|
|
1032 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
908 | |
1033 | |
909 | my $proxy = bless { |
1034 | my $proxy = bless { |
910 | _pkg => $pkg, |
1035 | _pkg => $pkg, |
911 | argv => $argv, |
1036 | argv => $argv, |
912 | }, $pkg; |
1037 | }, $pkg; |
… | |
… | |
1202 | |
1327 | |
1203 | Normally its not a good idea to use this function, as programs might be |
1328 | Normally its not a good idea to use this function, as programs might be |
1204 | confused by changes in cursor position or scrolling. Its useful inside a |
1329 | confused by changes in cursor position or scrolling. Its useful inside a |
1205 | C<on_add_lines> hook, though. |
1330 | C<on_add_lines> hook, though. |
1206 | |
1331 | |
|
|
1332 | =item $term->scr_change_screen ($screen) |
|
|
1333 | |
|
|
1334 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1335 | |
1207 | =item $term->cmd_parse ($octets) |
1336 | =item $term->cmd_parse ($octets) |
1208 | |
1337 | |
1209 | Similar to C<scr_add_lines>, but the argument must be in the |
1338 | Similar to C<scr_add_lines>, but the argument must be in the |
1210 | locale-specific encoding of the terminal and can contain command sequences |
1339 | locale-specific encoding of the terminal and can contain command sequences |
1211 | (escape codes) that will be interpreted. |
1340 | (escape codes) that will be interpreted. |
… | |
… | |
1220 | |
1349 | |
1221 | Replaces the event mask of the pty watcher by the given event mask. Can |
1350 | Replaces the event mask of the pty watcher by the given event mask. Can |
1222 | be used to suppress input and output handling to the pty/tty. See the |
1351 | be used to suppress input and output handling to the pty/tty. See the |
1223 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1352 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1224 | the previous value. |
1353 | the previous value. |
|
|
1354 | |
|
|
1355 | =item $fd = $term->pty_fd |
|
|
1356 | |
|
|
1357 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1358 | is used. |
1225 | |
1359 | |
1226 | =item $windowid = $term->parent |
1360 | =item $windowid = $term->parent |
1227 | |
1361 | |
1228 | Return the window id of the toplevel window. |
1362 | Return the window id of the toplevel window. |
1229 | |
1363 | |
… | |
… | |
1294 | =item $modifiermask = $term->ModNumLockMask |
1428 | =item $modifiermask = $term->ModNumLockMask |
1295 | |
1429 | |
1296 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1430 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1297 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1431 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1298 | |
1432 | |
|
|
1433 | =item $screen = $term->current_screen |
|
|
1434 | |
|
|
1435 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1436 | |
|
|
1437 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1438 | |
|
|
1439 | Returns wether the cursor is currently hidden or not. |
|
|
1440 | |
1299 | =item $view_start = $term->view_start ([$newvalue]) |
1441 | =item $view_start = $term->view_start ([$newvalue]) |
1300 | |
1442 | |
1301 | Returns the row number of the topmost displayed line. Maximum value is |
1443 | Returns the row number of the topmost displayed line. Maximum value is |
1302 | C<0>, which displays the normal terminal contents. Lower values scroll |
1444 | C<0>, which displays the normal terminal contents. Lower values scroll |
1303 | this many lines into the scrollback buffer. |
1445 | this many lines into the scrollback buffer. |
… | |
… | |
1322 | line, starting at column C<$start_col> (default C<0>), which is useful |
1464 | line, starting at column C<$start_col> (default C<0>), which is useful |
1323 | to replace only parts of a line. The font index in the rendition will |
1465 | to replace only parts of a line. The font index in the rendition will |
1324 | automatically be updated. |
1466 | automatically be updated. |
1325 | |
1467 | |
1326 | C<$text> is in a special encoding: tabs and wide characters that use more |
1468 | C<$text> is in a special encoding: tabs and wide characters that use more |
1327 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1469 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1328 | (C<chr 65535>). Characters with combining characters and other characters |
1470 | characters. Characters with combining characters and other characters that |
1329 | that do not fit into the normal tetx encoding will be replaced with |
1471 | do not fit into the normal tetx encoding will be replaced with characters |
1330 | characters in the private use area. |
1472 | in the private use area. |
1331 | |
1473 | |
1332 | You have to obey this encoding when changing text. The advantage is |
1474 | You have to obey this encoding when changing text. The advantage is |
1333 | that C<substr> and similar functions work on screen cells and not on |
1475 | that C<substr> and similar functions work on screen cells and not on |
1334 | characters. |
1476 | characters. |
1335 | |
1477 | |
… | |
… | |
1509 | =item $term->ungrab |
1651 | =item $term->ungrab |
1510 | |
1652 | |
1511 | Calls XUngrab for the most recent grab. Is called automatically on |
1653 | Calls XUngrab for the most recent grab. Is called automatically on |
1512 | evaluation errors, as it is better to lose the grab in the error case as |
1654 | evaluation errors, as it is better to lose the grab in the error case as |
1513 | the session. |
1655 | the session. |
|
|
1656 | |
|
|
1657 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1658 | |
|
|
1659 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1660 | |
|
|
1661 | =item @atoms = $term->XListProperties ($window) |
|
|
1662 | |
|
|
1663 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1664 | |
|
|
1665 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1666 | |
|
|
1667 | =item $term->XDeleteProperty ($window, $property) |
|
|
1668 | |
|
|
1669 | =item $window = $term->DefaultRootWindow |
|
|
1670 | |
|
|
1671 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1672 | |
|
|
1673 | =item $term->XMapWindow ($window) |
|
|
1674 | |
|
|
1675 | =item $term->XUnmapWindow ($window) |
|
|
1676 | |
|
|
1677 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1678 | |
|
|
1679 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1680 | |
|
|
1681 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1682 | |
|
|
1683 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1684 | the source of the display, otherwise those functions map more-or-less |
|
|
1685 | directory onto the X functions of the same name. |
1514 | |
1686 | |
1515 | =back |
1687 | =back |
1516 | |
1688 | |
1517 | =cut |
1689 | =cut |
1518 | |
1690 | |
… | |
… | |
1638 | delete $self->{term}{_destroy}{$self}; |
1810 | delete $self->{term}{_destroy}{$self}; |
1639 | $self->{term}->ungrab; |
1811 | $self->{term}->ungrab; |
1640 | } |
1812 | } |
1641 | |
1813 | |
1642 | =back |
1814 | =back |
|
|
1815 | |
|
|
1816 | =cut |
|
|
1817 | |
|
|
1818 | package urxvt::watcher; |
|
|
1819 | |
|
|
1820 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1821 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1822 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1823 | @urxvt::iw::ISA = __PACKAGE__; |
1643 | |
1824 | |
1644 | =head2 The C<urxvt::timer> Class |
1825 | =head2 The C<urxvt::timer> Class |
1645 | |
1826 | |
1646 | This class implements timer watchers/events. Time is represented as a |
1827 | This class implements timer watchers/events. Time is represented as a |
1647 | fractional number of seconds since the epoch. Example: |
1828 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1745 | |
1926 | |
1746 | Stop watching for events on the given filehandle. |
1927 | Stop watching for events on the given filehandle. |
1747 | |
1928 | |
1748 | =back |
1929 | =back |
1749 | |
1930 | |
|
|
1931 | =head2 The C<urxvt::iw> Class |
|
|
1932 | |
|
|
1933 | This class implements idle watchers, that get called automatically when |
|
|
1934 | the process is idle. They should return as fast as possible, after doing |
|
|
1935 | some useful work. |
|
|
1936 | |
|
|
1937 | =over 4 |
|
|
1938 | |
|
|
1939 | =item $iw = new urxvt::iw |
|
|
1940 | |
|
|
1941 | Create a new idle watcher object in stopped state. |
|
|
1942 | |
|
|
1943 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1944 | |
|
|
1945 | Set the callback to be called when the watcher triggers. |
|
|
1946 | |
|
|
1947 | =item $timer = $timer->start |
|
|
1948 | |
|
|
1949 | Start the watcher. |
|
|
1950 | |
|
|
1951 | =item $timer = $timer->stop |
|
|
1952 | |
|
|
1953 | Stop the watcher. |
|
|
1954 | |
|
|
1955 | =back |
|
|
1956 | |
|
|
1957 | =head2 The C<urxvt::pw> Class |
|
|
1958 | |
|
|
1959 | This class implements process watchers. They create an event whenever a |
|
|
1960 | process exits, after which they stop automatically. |
|
|
1961 | |
|
|
1962 | my $pid = fork; |
|
|
1963 | ... |
|
|
1964 | $term->{pw} = urxvt::pw |
|
|
1965 | ->new |
|
|
1966 | ->start ($pid) |
|
|
1967 | ->cb (sub { |
|
|
1968 | my ($pw, $exit_status) = @_; |
|
|
1969 | ... |
|
|
1970 | }); |
|
|
1971 | |
|
|
1972 | =over 4 |
|
|
1973 | |
|
|
1974 | =item $pw = new urxvt::pw |
|
|
1975 | |
|
|
1976 | Create a new process watcher in stopped state. |
|
|
1977 | |
|
|
1978 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1979 | |
|
|
1980 | Set the callback to be called when the timer triggers. |
|
|
1981 | |
|
|
1982 | =item $pw = $timer->start ($pid) |
|
|
1983 | |
|
|
1984 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
1985 | |
|
|
1986 | =item $pw = $pw->stop |
|
|
1987 | |
|
|
1988 | Stop the watcher. |
|
|
1989 | |
|
|
1990 | =back |
|
|
1991 | |
1750 | =head1 ENVIRONMENT |
1992 | =head1 ENVIRONMENT |
1751 | |
1993 | |
1752 | =head2 URXVT_PERL_VERBOSITY |
1994 | =head2 URXVT_PERL_VERBOSITY |
1753 | |
1995 | |
1754 | This variable controls the verbosity level of the perl extension. Higher |
1996 | This variable controls the verbosity level of the perl extension. Higher |