… | |
… | |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
30 | |
30 | |
|
|
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
|
|
32 | and "perl-ext-common" resources to the empty string. |
|
|
33 | |
31 | =head1 PREPACKAGED EXTENSIONS |
34 | =head1 PREPACKAGED EXTENSIONS |
32 | |
35 | |
33 | This section describes the extensions delivered with this release. You can |
36 | This section describes the extensions delivered with this release. You can |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
37 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
35 | |
38 | |
… | |
… | |
37 | |
40 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
41 | @@RXVT_NAME@@ -pe <extensionname> |
39 | |
42 | |
40 | Or by adding them to the resource for extensions loaded by default: |
43 | Or by adding them to the resource for extensions loaded by default: |
41 | |
44 | |
42 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
45 | URxvt.perl-ext-common: default,selection-autotransform |
43 | |
46 | |
44 | =over 4 |
47 | =over 4 |
45 | |
48 | |
46 | =item selection (enabled by default) |
49 | =item selection (enabled by default) |
47 | |
50 | |
… | |
… | |
98 | |
101 | |
99 | Other extensions can extend this popup menu by pushing a code reference |
102 | Other extensions can extend this popup menu by pushing a code reference |
100 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
101 | popup is being displayed. |
104 | popup is being displayed. |
102 | |
105 | |
103 | It's sole argument is the popup menu, which can be modified. It should |
106 | Its sole argument is the popup menu, which can be modified. It should |
104 | either return nothing or a string, the initial boolean value and a code |
107 | either return nothing or a string, the initial boolean value and a code |
105 | reference. The string will be used as button text and the code reference |
108 | reference. The string will be used as button text and the code reference |
106 | will be called when the toggle changes, with the new boolean value as |
109 | will be called when the toggle changes, with the new boolean value as |
107 | first argument. |
110 | first argument. |
108 | |
111 | |
109 | The following will add an entry C<myoption> that changes |
112 | The following will add an entry C<myoption> that changes |
110 | C<$self->{myoption}>: |
113 | C<< $self->{myoption} >>: |
111 | |
114 | |
112 | push @{ $self->{term}{option_popup_hook} }, sub { |
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
113 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
114 | }; |
117 | }; |
115 | |
118 | |
… | |
… | |
121 | |
124 | |
122 | Other extensions can extend this popup menu by pushing a code reference |
125 | Other extensions can extend this popup menu by pushing a code reference |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
124 | popup is being displayed. |
127 | popup is being displayed. |
125 | |
128 | |
126 | It's sole argument is the popup menu, which can be modified. The selection |
129 | Its sole argument is the popup menu, which can be modified. The selection |
127 | is in C<$_>, which can be used to decide whether to add something or not. |
130 | is in C<$_>, which can be used to decide whether to add something or not. |
128 | It should either return nothing or a string and a code reference. The |
131 | It should either return nothing or a string and a code reference. The |
129 | string will be used as button text and the code reference will be called |
132 | string will be used as button text and the code reference will be called |
130 | when the button gets activated and should transform C<$_>. |
133 | when the button gets activated and should transform C<$_>. |
131 | |
134 | |
132 | The following will add an entry C<a to b> that transforms all C<a>s in |
135 | The following will add an entry C<a to b> that transforms all C<a>s in |
133 | the selection to C<b>s, but only if the selection currently contains any |
136 | the selection to C<b>s, but only if the selection currently contains any |
134 | C<a>s: |
137 | C<a>s: |
135 | |
138 | |
136 | push @{ $self->{term}{selection_popup_hook} }, sub { |
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
137 | /a/ ? ("a to be" => sub { s/a/b/g } |
140 | /a/ ? ("a to b" => sub { s/a/b/g } |
138 | : () |
141 | : () |
139 | }; |
142 | }; |
140 | |
143 | |
141 | =item searchable-scrollback<hotkey> (enabled by default) |
144 | =item searchable-scrollback<hotkey> (enabled by default) |
142 | |
145 | |
… | |
… | |
149 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
152 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
150 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
153 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
151 | bottom. C<Escape> leaves search mode and returns to the point where search |
154 | bottom. C<Escape> leaves search mode and returns to the point where search |
152 | was started, while C<Enter> or C<Return> stay at the current position and |
155 | was started, while C<Enter> or C<Return> stay at the current position and |
153 | additionally stores the first match in the current line into the primary |
156 | additionally stores the first match in the current line into the primary |
154 | selection. |
157 | selection if the C<Shift> modifier is active. |
155 | |
158 | |
156 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
159 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
157 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
160 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
158 | or simply use an uppercase character which removes the "(?i)" prefix. |
161 | or simply use an uppercase character which removes the "(?i)" prefix. |
159 | |
162 | |
… | |
… | |
162 | =item readline (enabled by default) |
165 | =item readline (enabled by default) |
163 | |
166 | |
164 | A support package that tries to make editing with readline easier. At |
167 | A support package that tries to make editing with readline easier. At |
165 | the moment, it reacts to clicking shift-left mouse button by trying to |
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
166 | move the text cursor to this position. It does so by generating as many |
169 | move the text cursor to this position. It does so by generating as many |
167 | cursor-left or cursor-right keypresses as required (the this only works |
170 | cursor-left or cursor-right keypresses as required (this only works |
168 | for programs that correctly support wide characters). |
171 | for programs that correctly support wide characters). |
169 | |
172 | |
170 | To avoid too many false positives, this is only done when: |
173 | To avoid too many false positives, this is only done when: |
171 | |
174 | |
172 | =over 4 |
175 | =over 4 |
… | |
… | |
240 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
243 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
241 | |
244 | |
242 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
245 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
243 | indices. |
246 | indices. |
244 | |
247 | |
245 | =item mark-urls |
248 | =item matcher |
246 | |
249 | |
247 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
250 | Uses per-line display filtering (C<on_line_update>) to underline text |
248 | make them clickable. When middle-clicked, the program specified in the |
251 | matching a certain pattern and make it clickable. When clicked with the |
249 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
252 | mouse button specified in the C<matcher.button> resource (default 2, or |
250 | the URL as first argument. |
253 | middle), the program specified in the C<matcher.launcher> resource |
|
|
254 | (default, the C<urlLauncher> resource, C<sensible-browser>) will be started |
|
|
255 | with the matched text as first argument. The default configuration is |
|
|
256 | suitable for matching URLs and launching a web browser, like the |
|
|
257 | former "mark-urls" extension. |
|
|
258 | |
|
|
259 | The default pattern to match URLs can be overridden with the |
|
|
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
|
|
261 | with numbered patterns, in a manner similar to the "selection" extension. |
|
|
262 | The launcher can also be overridden on a per-pattern basis. |
|
|
263 | |
|
|
264 | It is possible to activate the most recently seen match from the keyboard. |
|
|
265 | Simply bind a keysym to "perl:matcher" as seen in the example below. |
|
|
266 | |
|
|
267 | Example configuration: |
|
|
268 | |
|
|
269 | URxvt.perl-ext: default,matcher |
|
|
270 | URxvt.urlLauncher: sensible-browser |
|
|
271 | URxvt.keysym.C-Delete: perl:matcher |
|
|
272 | URxvt.matcher.button: 1 |
|
|
273 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
274 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
275 | URxvt.matcher.launcher.2: gvim +$2 $1 |
251 | |
276 | |
252 | =item xim-onthespot |
277 | =item xim-onthespot |
253 | |
278 | |
254 | This (experimental) perl extension implements OnTheSpot editing. It does |
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
255 | not work perfectly, and some input methods don't seem to work well with |
280 | not work perfectly, and some input methods don't seem to work well with |
256 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
281 | OnTheSpot editing in general, but it seems to work at least for SCIM and |
257 | kinput2. |
282 | kinput2. |
258 | |
283 | |
259 | You enable it by specifying this extension and a preedit style of |
284 | You enable it by specifying this extension and a preedit style of |
260 | C<OnTheSpot>, i.e.: |
285 | C<OnTheSpot>, i.e.: |
261 | |
286 | |
… | |
… | |
269 | will show or hide itself. Another press of the accelerator key will hide |
294 | will show or hide itself. Another press of the accelerator key will hide |
270 | or show it again. |
295 | or show it again. |
271 | |
296 | |
272 | Initially, the window will not be shown when using this extension. |
297 | Initially, the window will not be shown when using this extension. |
273 | |
298 | |
274 | This is useful if you need a single terminal thats not using any desktop |
299 | This is useful if you need a single terminal that is not using any desktop |
275 | space most of the time but is quickly available at the press of a key. |
300 | space most of the time but is quickly available at the press of a key. |
276 | |
301 | |
277 | The accelerator key is grabbed regardless of any modifiers, so this |
302 | The accelerator key is grabbed regardless of any modifiers, so this |
278 | extension will actually grab a physical key just for this function. |
303 | extension will actually grab a physical key just for this function. |
279 | |
304 | |
280 | If you want a quake-like animation, tell your window manager to do so |
305 | If you want a quake-like animation, tell your window manager to do so |
281 | (fvwm can do it). |
306 | (fvwm can do it). |
282 | |
307 | |
283 | =item automove-background |
308 | =item overlay-osc |
284 | |
309 | |
285 | This is basically a very small extension that dynamically changes the |
310 | This extension implements some OSC commands to display timed popups on the |
286 | background pixmap offset to the window position, in effect creating the |
311 | screen - useful for status displays from within scripts. You have to read |
287 | same effect as pseudo transparency with a custom pixmap. No scaling is |
312 | the sources for more info. |
288 | supported in this mode. Example: |
|
|
289 | |
|
|
290 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
291 | |
313 | |
292 | =item block-graphics-to-ascii |
314 | =item block-graphics-to-ascii |
293 | |
315 | |
294 | A not very useful example of filtering all text output to the terminal |
316 | A not very useful example of filtering all text output to the terminal |
295 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
317 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
… | |
… | |
300 | Displays a digital clock using the built-in overlay. |
322 | Displays a digital clock using the built-in overlay. |
301 | |
323 | |
302 | =item remote-clipboard |
324 | =item remote-clipboard |
303 | |
325 | |
304 | Somewhat of a misnomer, this extension adds two menu entries to the |
326 | Somewhat of a misnomer, this extension adds two menu entries to the |
305 | selection popup that allows one ti run external commands to store the |
327 | selection popup that allows one to run external commands to store the |
306 | selection somewhere and fetch it again. |
328 | selection somewhere and fetch it again. |
307 | |
329 | |
308 | We use it to implement a "distributed selection mechanism", which just |
330 | We use it to implement a "distributed selection mechanism", which just |
309 | means that one command uploads the file to a remote server, and another |
331 | means that one command uploads the file to a remote server, and another |
310 | reads it. |
332 | reads it. |
… | |
… | |
350 | |
372 | |
351 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
373 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
352 | the double C</> characters as comment start. Use C<\057\057> instead, |
374 | the double C</> characters as comment start. Use C<\057\057> instead, |
353 | which works regardless of wether xrdb is used to parse the resource file |
375 | which works regardless of wether xrdb is used to parse the resource file |
354 | or not. |
376 | or not. |
|
|
377 | |
|
|
378 | =item macosx-pastebin and macosx-pastebin-native |
|
|
379 | |
|
|
380 | These two modules implement an extended clipboard for Mac OS X. They are |
|
|
381 | used like this: |
|
|
382 | |
|
|
383 | URxvt.perl-ext-common: default,macosx-clipboard |
|
|
384 | URxvt.keysym.M-c: perl:macosx-clipboard:copy |
|
|
385 | URxvt.keysym.M-v: perl:macosx-clipboard:paste |
|
|
386 | |
|
|
387 | The difference between them is that the native variant requires a |
|
|
388 | perl from apple's devkit or so, and C<maxosx-pastebin> requires the |
|
|
389 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
|
|
390 | simpler etc. etc. |
355 | |
391 | |
356 | =item example-refresh-hooks |
392 | =item example-refresh-hooks |
357 | |
393 | |
358 | Displays a very simple digital clock in the upper right corner of the |
394 | Displays a very simple digital clock in the upper right corner of the |
359 | window. Illustrates overwriting the refresh callbacks to create your own |
395 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
525 | |
561 | |
526 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
562 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
527 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
563 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
528 | number of lines that will be in the scrollback buffer. |
564 | number of lines that will be in the scrollback buffer. |
529 | |
565 | |
530 | =item on_osc_seq $term, $op, $args |
566 | =item on_osc_seq $term, $op, $args, $resp |
531 | |
567 | |
532 | Called on every OSC sequence and can be used to suppress it or modify its |
568 | Called on every OSC sequence and can be used to suppress it or modify its |
533 | behaviour. The default should be to return an empty list. A true value |
569 | behaviour. The default should be to return an empty list. A true value |
534 | suppresses execution of the request completely. Make sure you don't get |
570 | suppresses execution of the request completely. Make sure you don't get |
535 | confused by recursive invocations when you output an osc sequence within |
571 | confused by recursive invocations when you output an OSC sequence within |
536 | this callback. |
572 | this callback. |
537 | |
573 | |
538 | C<on_osc_seq_perl> should be used for new behaviour. |
574 | C<on_osc_seq_perl> should be used for new behaviour. |
539 | |
575 | |
540 | =item on_osc_seq_perl $term, $string |
576 | =item on_osc_seq_perl $term, $args, $resp |
541 | |
577 | |
542 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
578 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
543 | operating system command) is processed. Cursor position and other state |
579 | operating system command) is processed. Cursor position and other state |
544 | information is up-to-date when this happens. For interoperability, the |
580 | information is up-to-date when this happens. For interoperability, the |
545 | string should start with the extension name and a colon, to distinguish |
581 | string should start with the extension name (sans -osc) and a semicolon, |
546 | it from commands for other extensions, and this might be enforced in the |
582 | to distinguish it from commands for other extensions, and this might be |
547 | future. |
583 | enforced in the future. |
|
|
584 | |
|
|
585 | For example, C<overlay-osc> uses this: |
|
|
586 | |
|
|
587 | sub on_osc_seq_perl { |
|
|
588 | my ($self, $osc, $resp) = @_; |
|
|
589 | |
|
|
590 | return unless $osc =~ s/^overlay;//; |
|
|
591 | |
|
|
592 | ... process remaining $osc string |
|
|
593 | } |
548 | |
594 | |
549 | Be careful not ever to trust (in a security sense) the data you receive, |
595 | Be careful not ever to trust (in a security sense) the data you receive, |
550 | as its source can not easily be controlled (e-mail content, messages from |
596 | as its source can not easily be controlled (e-mail content, messages from |
551 | other users on the same system etc.). |
597 | other users on the same system etc.). |
|
|
598 | |
|
|
599 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
600 | sender. |
552 | |
601 | |
553 | =item on_add_lines $term, $string |
602 | =item on_add_lines $term, $string |
554 | |
603 | |
555 | Called whenever text is about to be output, with the text as argument. You |
604 | Called whenever text is about to be output, with the text as argument. You |
556 | can filter/change and output the text yourself by returning a true value |
605 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
577 | later with the already-modified line (e.g. if unrelated parts change), so |
626 | later with the already-modified line (e.g. if unrelated parts change), so |
578 | you cannot just toggle rendition bits, but only set them. |
627 | you cannot just toggle rendition bits, but only set them. |
579 | |
628 | |
580 | =item on_refresh_begin $term |
629 | =item on_refresh_begin $term |
581 | |
630 | |
582 | Called just before the screen gets redrawn. Can be used for overlay |
631 | Called just before the screen gets redrawn. Can be used for overlay or |
583 | or similar effects by modify terminal contents in refresh_begin, and |
632 | similar effects by modifying the terminal contents in refresh_begin, and |
584 | restoring them in refresh_end. The built-in overlay and selection display |
633 | restoring them in refresh_end. The built-in overlay and selection display |
585 | code is run after this hook, and takes precedence. |
634 | code is run after this hook, and takes precedence. |
586 | |
635 | |
587 | =item on_refresh_end $term |
636 | =item on_refresh_end $term |
588 | |
637 | |
… | |
… | |
899 | local $TERM = shift; |
948 | local $TERM = shift; |
900 | my $htype = shift; |
949 | my $htype = shift; |
901 | |
950 | |
902 | if ($htype == 0) { # INIT |
951 | if ($htype == 0) { # INIT |
903 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
952 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
904 | |
953 | |
905 | my %ext_arg; |
954 | my %ext_arg; |
906 | |
955 | |
907 | { |
956 | { |
908 | my @init = @TERM_INIT; |
957 | my @init = @TERM_INIT; |
909 | @TERM_INIT = (); |
958 | @TERM_INIT = (); |
… | |
… | |
972 | |
1021 | |
973 | sub SET_COLOR($$$) { |
1022 | sub SET_COLOR($$$) { |
974 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
1023 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
975 | } |
1024 | } |
976 | |
1025 | |
|
|
1026 | sub rend2mask { |
|
|
1027 | no strict 'refs'; |
|
|
1028 | my ($str, $mask) = (@_, 0); |
|
|
1029 | my %color = ( fg => undef, bg => undef ); |
|
|
1030 | my @failed; |
|
|
1031 | for my $spec ( split /\s+/, $str ) { |
|
|
1032 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1033 | $color{lc($1)} = $2; |
|
|
1034 | } else { |
|
|
1035 | my $neg = $spec =~ s/^[-^]//; |
|
|
1036 | unless ( exists &{"RS_$spec"} ) { |
|
|
1037 | push @failed, $spec; |
|
|
1038 | next; |
|
|
1039 | } |
|
|
1040 | my $cur = &{"RS_$spec"}; |
|
|
1041 | if ( $neg ) { |
|
|
1042 | $mask &= ~$cur; |
|
|
1043 | } else { |
|
|
1044 | $mask |= $cur; |
|
|
1045 | } |
|
|
1046 | } |
|
|
1047 | } |
|
|
1048 | ($mask, @color{qw(fg bg)}, \@failed) |
|
|
1049 | } |
|
|
1050 | |
977 | # urxvt::term::extension |
1051 | # urxvt::term::extension |
978 | |
1052 | |
979 | package urxvt::term::extension; |
1053 | package urxvt::term::extension; |
980 | |
1054 | |
981 | sub enable { |
1055 | sub enable { |
… | |
… | |
1050 | is that you cannot use blocking APIs, but the non-blocking variant should |
1124 | is that you cannot use blocking APIs, but the non-blocking variant should |
1051 | work. |
1125 | work. |
1052 | |
1126 | |
1053 | =cut |
1127 | =cut |
1054 | |
1128 | |
1055 | our $VERSION = 1; |
1129 | our $VERSION = '5.23'; |
1056 | |
1130 | |
1057 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1131 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1058 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1132 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1059 | |
1133 | |
1060 | sub timer { |
1134 | sub timer { |
… | |
… | |
1062 | |
1136 | |
1063 | my $cb = $arg{cb}; |
1137 | my $cb = $arg{cb}; |
1064 | |
1138 | |
1065 | urxvt::timer |
1139 | urxvt::timer |
1066 | ->new |
1140 | ->new |
1067 | ->start (urxvt::NOW + $arg{after}) |
1141 | ->after ($arg{after}) |
1068 | ->cb (sub { |
1142 | ->interval ($arg{interval}) |
|
|
1143 | ->start |
|
|
1144 | ->cb ($argv{interval} ? $cb : sub { |
1069 | $_[0]->stop; # need to cancel manually |
1145 | $_[0]->stop; # need to cancel manually |
1070 | $cb->(); |
1146 | $cb->(); |
1071 | }) |
1147 | }) |
1072 | } |
1148 | } |
1073 | |
1149 | |
1074 | sub io { |
1150 | sub io { |
1075 | my ($class, %arg) = @_; |
1151 | my ($class, %arg) = @_; |
1076 | |
1152 | |
1077 | my $cb = $arg{cb}; |
1153 | my $cb = $arg{cb}; |
|
|
1154 | my $fd = fileno $arg{fh}; |
|
|
1155 | defined $fd or $fd = $arg{fh}; |
1078 | |
1156 | |
1079 | bless [$arg{fh}, urxvt::iow |
1157 | bless [$arg{fh}, urxvt::iow |
1080 | ->new |
1158 | ->new |
1081 | ->fd (fileno $arg{fh}) |
1159 | ->fd ($fd) |
1082 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1160 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1083 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1161 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1084 | ->start |
1162 | ->start |
1085 | ->cb (sub { |
1163 | ->cb ($cb) |
1086 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
1087 | . ($_[1] & 2 ? 'w' : '')); |
|
|
1088 | })], |
|
|
1089 | urxvt::anyevent:: |
1164 | ], urxvt::anyevent:: |
|
|
1165 | } |
|
|
1166 | |
|
|
1167 | sub idle { |
|
|
1168 | my ($class, %arg) = @_; |
|
|
1169 | |
|
|
1170 | my $cb = $arg{cb}; |
|
|
1171 | |
|
|
1172 | urxvt::iw |
|
|
1173 | ->new |
|
|
1174 | ->start |
|
|
1175 | ->cb ($cb) |
|
|
1176 | } |
|
|
1177 | |
|
|
1178 | sub child { |
|
|
1179 | my ($class, %arg) = @_; |
|
|
1180 | |
|
|
1181 | my $cb = $arg{cb}; |
|
|
1182 | |
|
|
1183 | urxvt::pw |
|
|
1184 | ->new |
|
|
1185 | ->start ($arg{pid}) |
|
|
1186 | ->cb (sub { |
|
|
1187 | $_[0]->stop; # need to cancel manually |
|
|
1188 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1189 | }) |
1090 | } |
1190 | } |
1091 | |
1191 | |
1092 | sub DESTROY { |
1192 | sub DESTROY { |
1093 | $_[0][1]->stop; |
1193 | $_[0][1]->stop; |
1094 | } |
1194 | } |
1095 | |
1195 | |
1096 | sub condvar { |
1196 | sub one_event { |
1097 | bless \my $flag, urxvt::anyevent::condvar:: |
|
|
1098 | } |
|
|
1099 | |
|
|
1100 | sub urxvt::anyevent::condvar::broadcast { |
|
|
1101 | ${$_[0]}++; |
|
|
1102 | } |
|
|
1103 | |
|
|
1104 | sub urxvt::anyevent::condvar::wait { |
|
|
1105 | unless (${$_[0]}) { |
|
|
1106 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1197 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1107 | } |
|
|
1108 | } |
1198 | } |
1109 | |
1199 | |
1110 | package urxvt::term; |
1200 | package urxvt::term; |
1111 | |
1201 | |
1112 | =head2 The C<urxvt::term> Class |
1202 | =head2 The C<urxvt::term> Class |
… | |
… | |
1231 | Here is a likely non-exhaustive list of resource names, not all of which |
1321 | Here is a likely non-exhaustive list of resource names, not all of which |
1232 | are supported in every build, please see the source file F</src/rsinc.h> |
1322 | are supported in every build, please see the source file F</src/rsinc.h> |
1233 | to see the actual list: |
1323 | to see the actual list: |
1234 | |
1324 | |
1235 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1325 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1236 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1326 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1237 | display_name embed ext_bwidth fade font geometry hold iconName |
1327 | display_name embed ext_bwidth fade font geometry hold iconName |
1238 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1328 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1239 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1329 | italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 |
1240 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1330 | modifier mouseWheelScrollPage name override_redirect pastableTabs path |
1241 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1331 | perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1242 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1332 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1243 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1333 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1244 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1334 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1245 | secondaryScreen secondaryScroll selectstyle shade term_name title |
1335 | secondaryScreen secondaryScroll shade term_name title |
1246 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1336 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1247 | visualBell |
1337 | visualBell |
1248 | |
1338 | |
1249 | =cut |
1339 | =cut |
1250 | |
1340 | |
1251 | sub resource($$;$) { |
1341 | sub resource($$;$) { |
1252 | my ($self, $name) = (shift, shift); |
1342 | my ($self, $name) = (shift, shift); |
1253 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1343 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1254 | &urxvt::term::_resource |
1344 | goto &urxvt::term::_resource |
1255 | } |
1345 | } |
1256 | |
1346 | |
1257 | =item $value = $term->x_resource ($pattern) |
1347 | =item $value = $term->x_resource ($pattern) |
1258 | |
1348 | |
1259 | Returns the X-Resource for the given pattern, excluding the program or |
1349 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
1342 | |
1432 | |
1343 | The methods currently supported on C<urxvt::overlay> objects are: |
1433 | The methods currently supported on C<urxvt::overlay> objects are: |
1344 | |
1434 | |
1345 | =over 4 |
1435 | =over 4 |
1346 | |
1436 | |
1347 | =item $overlay->set ($x, $y, $text, $rend) |
1437 | =item $overlay->set ($x, $y, $text[, $rend]) |
1348 | |
1438 | |
1349 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1439 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1350 | text in rxvt-unicode's special encoding and an array of rendition values |
1440 | text in rxvt-unicode's special encoding and an array of rendition values |
1351 | at a specific position inside the overlay. |
1441 | at a specific position inside the overlay. |
|
|
1442 | |
|
|
1443 | If C<$rend> is missing, then the rendition will not be changed. |
1352 | |
1444 | |
1353 | =item $overlay->hide |
1445 | =item $overlay->hide |
1354 | |
1446 | |
1355 | If visible, hide the overlay, but do not destroy it. |
1447 | If visible, hide the overlay, but do not destroy it. |
1356 | |
1448 | |
… | |
… | |
1566 | |
1658 | |
1567 | Used after changing terminal contents to display them. |
1659 | Used after changing terminal contents to display them. |
1568 | |
1660 | |
1569 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1661 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1570 | |
1662 | |
1571 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1663 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1572 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1664 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1573 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1574 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1665 | terminal line. Nothing will be returned if a nonexistent line |
1575 | is requested. |
1666 | is requested. |
1576 | |
1667 | |
1577 | If C<$new_text> is specified, it will replace characters in the current |
1668 | If C<$new_text> is specified, it will replace characters in the current |
1578 | line, starting at column C<$start_col> (default C<0>), which is useful |
1669 | line, starting at column C<$start_col> (default C<0>), which is useful |
1579 | to replace only parts of a line. The font index in the rendition will |
1670 | to replace only parts of a line. The font index in the rendition will |
1580 | automatically be updated. |
1671 | automatically be updated. |
1581 | |
1672 | |
1582 | C<$text> is in a special encoding: tabs and wide characters that use more |
1673 | C<$text> is in a special encoding: tabs and wide characters that use more |
1583 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1674 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1584 | characters. Characters with combining characters and other characters that |
1675 | characters. Characters with combining characters and other characters that |
1585 | do not fit into the normal tetx encoding will be replaced with characters |
1676 | do not fit into the normal text encoding will be replaced with characters |
1586 | in the private use area. |
1677 | in the private use area. |
1587 | |
1678 | |
1588 | You have to obey this encoding when changing text. The advantage is |
1679 | You have to obey this encoding when changing text. The advantage is |
1589 | that C<substr> and similar functions work on screen cells and not on |
1680 | that C<substr> and similar functions work on screen cells and not on |
1590 | characters. |
1681 | characters. |
… | |
… | |
1777 | |
1868 | |
1778 | =item @atoms = $term->XListProperties ($window) |
1869 | =item @atoms = $term->XListProperties ($window) |
1779 | |
1870 | |
1780 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1871 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1781 | |
1872 | |
1782 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
1873 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
1783 | |
1874 | |
1784 | =item $term->XDeleteProperty ($window, $property) |
1875 | =item $term->XDeleteProperty ($window, $property) |
1785 | |
1876 | |
1786 | =item $window = $term->DefaultRootWindow |
1877 | =item $window = $term->DefaultRootWindow |
1787 | |
1878 | |
… | |
… | |
1909 | my $env = $self->{term}->env; |
2000 | my $env = $self->{term}->env; |
1910 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
2001 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1911 | delete $env->{LC_ALL}; |
2002 | delete $env->{LC_ALL}; |
1912 | $env->{LC_CTYPE} = $self->{term}->locale; |
2003 | $env->{LC_CTYPE} = $self->{term}->locale; |
1913 | |
2004 | |
1914 | urxvt::term->new ($env, "popup", |
2005 | my $term = urxvt::term->new ( |
|
|
2006 | $env, "popup", |
1915 | "--perl-lib" => "", "--perl-ext-common" => "", |
2007 | "--perl-lib" => "", "--perl-ext-common" => "", |
1916 | "-pty-fd" => -1, "-sl" => 0, |
2008 | "-pty-fd" => -1, "-sl" => 0, |
1917 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
2009 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1918 | "--transient-for" => $self->{term}->parent, |
2010 | "--transient-for" => $self->{term}->parent, |
1919 | "-display" => $self->{term}->display_id, |
2011 | "-display" => $self->{term}->display_id, |
1920 | "-pe" => "urxvt-popup") |
2012 | "-pe" => "urxvt-popup", |
1921 | or die "unable to create popup window\n"; |
2013 | ) or die "unable to create popup window\n"; |
|
|
2014 | |
|
|
2015 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
2016 | $term->ungrab; |
|
|
2017 | $term->destroy; |
|
|
2018 | die "unable to initialise popup window\n"; |
|
|
2019 | } |
1922 | } |
2020 | } |
1923 | |
2021 | |
1924 | sub DESTROY { |
2022 | sub DESTROY { |
1925 | my ($self) = @_; |
2023 | my ($self) = @_; |
1926 | |
2024 | |
… | |
… | |
1931 | =back |
2029 | =back |
1932 | |
2030 | |
1933 | =cut |
2031 | =cut |
1934 | |
2032 | |
1935 | package urxvt::watcher; |
2033 | package urxvt::watcher; |
1936 | |
|
|
1937 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1938 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1939 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1940 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1941 | |
2034 | |
1942 | =head2 The C<urxvt::timer> Class |
2035 | =head2 The C<urxvt::timer> Class |
1943 | |
2036 | |
1944 | This class implements timer watchers/events. Time is represented as a |
2037 | This class implements timer watchers/events. Time is represented as a |
1945 | fractional number of seconds since the epoch. Example: |
2038 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1949 | ->new |
2042 | ->new |
1950 | ->interval (1) |
2043 | ->interval (1) |
1951 | ->cb (sub { |
2044 | ->cb (sub { |
1952 | $term->{overlay}->set (0, 0, |
2045 | $term->{overlay}->set (0, 0, |
1953 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2046 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1954 | }); |
2047 | }); |
1955 | |
2048 | |
1956 | =over 4 |
2049 | =over 4 |
1957 | |
2050 | |
1958 | =item $timer = new urxvt::timer |
2051 | =item $timer = new urxvt::timer |
1959 | |
2052 | |
… | |
… | |
2002 | |
2095 | |
2003 | $term->{socket} = ... |
2096 | $term->{socket} = ... |
2004 | $term->{iow} = urxvt::iow |
2097 | $term->{iow} = urxvt::iow |
2005 | ->new |
2098 | ->new |
2006 | ->fd (fileno $term->{socket}) |
2099 | ->fd (fileno $term->{socket}) |
2007 | ->events (urxvt::EVENT_READ) |
2100 | ->events (urxvt::EV_READ) |
2008 | ->start |
2101 | ->start |
2009 | ->cb (sub { |
2102 | ->cb (sub { |
2010 | my ($iow, $revents) = @_; |
2103 | my ($iow, $revents) = @_; |
2011 | # $revents must be 1 here, no need to check |
2104 | # $revents must be 1 here, no need to check |
2012 | sysread $term->{socket}, my $buf, 8192 |
2105 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
2030 | Set the file descriptor (not handle) to watch. |
2123 | Set the file descriptor (not handle) to watch. |
2031 | |
2124 | |
2032 | =item $iow = $iow->events ($eventmask) |
2125 | =item $iow = $iow->events ($eventmask) |
2033 | |
2126 | |
2034 | Set the event mask to watch. The only allowed values are |
2127 | Set the event mask to watch. The only allowed values are |
2035 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2128 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
2036 | together, or C<urxvt::EVENT_NONE>. |
2129 | together, or C<urxvt::EV_NONE>. |
2037 | |
2130 | |
2038 | =item $iow = $iow->start |
2131 | =item $iow = $iow->start |
2039 | |
2132 | |
2040 | Start watching for requested events on the given handle. |
2133 | Start watching for requested events on the given handle. |
2041 | |
2134 | |
… | |
… | |
2082 | ->new |
2175 | ->new |
2083 | ->start ($pid) |
2176 | ->start ($pid) |
2084 | ->cb (sub { |
2177 | ->cb (sub { |
2085 | my ($pw, $exit_status) = @_; |
2178 | my ($pw, $exit_status) = @_; |
2086 | ... |
2179 | ... |
2087 | }); |
2180 | }); |
2088 | |
2181 | |
2089 | =over 4 |
2182 | =over 4 |
2090 | |
2183 | |
2091 | =item $pw = new urxvt::pw |
2184 | =item $pw = new urxvt::pw |
2092 | |
2185 | |
… | |
… | |
2131 | http://software.schmorp.de/pkg/rxvt-unicode |
2224 | http://software.schmorp.de/pkg/rxvt-unicode |
2132 | |
2225 | |
2133 | =cut |
2226 | =cut |
2134 | |
2227 | |
2135 | 1 |
2228 | 1 |
|
|
2229 | |
|
|
2230 | # vim: sw=3: |