… | |
… | |
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 |
… | |
… | |
256 | The default pattern to match URLs can be overridden with the |
259 | The default pattern to match URLs can be overridden with the |
257 | C<matcher.pattern.0> resource, and additional patterns can be specified |
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
258 | with numbered patterns, in a manner similar to the "selection" extension. |
261 | with numbered patterns, in a manner similar to the "selection" extension. |
259 | The launcher can also be overridden on a per-pattern basis. |
262 | The launcher can also be overridden on a per-pattern basis. |
260 | |
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 | |
261 | Example configuration: |
267 | Example configuration: |
262 | |
268 | |
263 | URxvt.perl-ext: default,matcher |
269 | URxvt.perl-ext: default,matcher |
264 | URxvt.urlLauncher: sensible-browser |
270 | URxvt.urlLauncher: sensible-browser |
|
|
271 | URxvt.keysym.C-Delete: perl:matcher |
265 | URxvt.matcher.button: 1 |
272 | URxvt.matcher.button: 1 |
266 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
273 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
267 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
274 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
268 | URxvt.matcher.launcher.2: gvim +$2 $1 |
275 | URxvt.matcher.launcher.2: gvim +$2 $1 |
269 | |
276 | |
270 | =item xim-onthespot |
277 | =item xim-onthespot |
271 | |
278 | |
272 | This (experimental) perl extension implements OnTheSpot editing. It does |
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
273 | 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 |
274 | 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 |
275 | kinput2. |
282 | kinput2. |
276 | |
283 | |
277 | 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 |
278 | C<OnTheSpot>, i.e.: |
285 | C<OnTheSpot>, i.e.: |
279 | |
286 | |
… | |
… | |
287 | 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 |
288 | or show it again. |
295 | or show it again. |
289 | |
296 | |
290 | Initially, the window will not be shown when using this extension. |
297 | Initially, the window will not be shown when using this extension. |
291 | |
298 | |
292 | 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 |
293 | 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. |
294 | |
301 | |
295 | The accelerator key is grabbed regardless of any modifiers, so this |
302 | The accelerator key is grabbed regardless of any modifiers, so this |
296 | extension will actually grab a physical key just for this function. |
303 | extension will actually grab a physical key just for this function. |
297 | |
304 | |
298 | 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 |
299 | (fvwm can do it). |
306 | (fvwm can do it). |
300 | |
|
|
301 | =item automove-background |
|
|
302 | |
|
|
303 | This is basically a very small extension that dynamically changes the |
|
|
304 | background pixmap offset to the window position, in effect creating the |
|
|
305 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
306 | supported in this mode. Example: |
|
|
307 | |
|
|
308 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
309 | |
307 | |
310 | =item block-graphics-to-ascii |
308 | =item block-graphics-to-ascii |
311 | |
309 | |
312 | A not very useful example of filtering all text output to the terminal |
310 | A not very useful example of filtering all text output to the terminal |
313 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
311 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
… | |
… | |
318 | Displays a digital clock using the built-in overlay. |
316 | Displays a digital clock using the built-in overlay. |
319 | |
317 | |
320 | =item remote-clipboard |
318 | =item remote-clipboard |
321 | |
319 | |
322 | Somewhat of a misnomer, this extension adds two menu entries to the |
320 | Somewhat of a misnomer, this extension adds two menu entries to the |
323 | selection popup that allows one ti run external commands to store the |
321 | selection popup that allows one to run external commands to store the |
324 | selection somewhere and fetch it again. |
322 | selection somewhere and fetch it again. |
325 | |
323 | |
326 | We use it to implement a "distributed selection mechanism", which just |
324 | We use it to implement a "distributed selection mechanism", which just |
327 | means that one command uploads the file to a remote server, and another |
325 | means that one command uploads the file to a remote server, and another |
328 | reads it. |
326 | reads it. |
… | |
… | |
543 | |
541 | |
544 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
542 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
545 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
543 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
546 | number of lines that will be in the scrollback buffer. |
544 | number of lines that will be in the scrollback buffer. |
547 | |
545 | |
548 | =item on_osc_seq $term, $op, $args |
546 | =item on_osc_seq $term, $op, $args, $resp |
549 | |
547 | |
550 | Called on every OSC sequence and can be used to suppress it or modify its |
548 | Called on every OSC sequence and can be used to suppress it or modify its |
551 | behaviour. The default should be to return an empty list. A true value |
549 | behaviour. The default should be to return an empty list. A true value |
552 | suppresses execution of the request completely. Make sure you don't get |
550 | suppresses execution of the request completely. Make sure you don't get |
553 | confused by recursive invocations when you output an osc sequence within |
551 | confused by recursive invocations when you output an OSC sequence within |
554 | this callback. |
552 | this callback. |
555 | |
553 | |
556 | C<on_osc_seq_perl> should be used for new behaviour. |
554 | C<on_osc_seq_perl> should be used for new behaviour. |
557 | |
555 | |
558 | =item on_osc_seq_perl $term, $string |
556 | =item on_osc_seq_perl $term, $args, $resp |
559 | |
557 | |
560 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
558 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
561 | operating system command) is processed. Cursor position and other state |
559 | operating system command) is processed. Cursor position and other state |
562 | information is up-to-date when this happens. For interoperability, the |
560 | information is up-to-date when this happens. For interoperability, the |
563 | string should start with the extension name and a colon, to distinguish |
561 | string should start with the extension name (sans -osc) and a semicolon, |
564 | it from commands for other extensions, and this might be enforced in the |
562 | to distinguish it from commands for other extensions, and this might be |
565 | future. |
563 | enforced in the future. |
|
|
564 | |
|
|
565 | For example, C<overlay-osc> uses this: |
|
|
566 | |
|
|
567 | sub on_osc_seq_perl { |
|
|
568 | my ($self, $osc, $resp) = @_; |
|
|
569 | |
|
|
570 | return unless $osc =~ s/^overlay;//; |
|
|
571 | |
|
|
572 | ... process remaining $osc string |
|
|
573 | } |
566 | |
574 | |
567 | Be careful not ever to trust (in a security sense) the data you receive, |
575 | Be careful not ever to trust (in a security sense) the data you receive, |
568 | as its source can not easily be controlled (e-mail content, messages from |
576 | as its source can not easily be controlled (e-mail content, messages from |
569 | other users on the same system etc.). |
577 | other users on the same system etc.). |
|
|
578 | |
|
|
579 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
580 | sender. |
570 | |
581 | |
571 | =item on_add_lines $term, $string |
582 | =item on_add_lines $term, $string |
572 | |
583 | |
573 | Called whenever text is about to be output, with the text as argument. You |
584 | Called whenever text is about to be output, with the text as argument. You |
574 | can filter/change and output the text yourself by returning a true value |
585 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
595 | later with the already-modified line (e.g. if unrelated parts change), so |
606 | later with the already-modified line (e.g. if unrelated parts change), so |
596 | you cannot just toggle rendition bits, but only set them. |
607 | you cannot just toggle rendition bits, but only set them. |
597 | |
608 | |
598 | =item on_refresh_begin $term |
609 | =item on_refresh_begin $term |
599 | |
610 | |
600 | Called just before the screen gets redrawn. Can be used for overlay |
611 | Called just before the screen gets redrawn. Can be used for overlay or |
601 | or similar effects by modify terminal contents in refresh_begin, and |
612 | similar effects by modifying the terminal contents in refresh_begin, and |
602 | restoring them in refresh_end. The built-in overlay and selection display |
613 | restoring them in refresh_end. The built-in overlay and selection display |
603 | code is run after this hook, and takes precedence. |
614 | code is run after this hook, and takes precedence. |
604 | |
615 | |
605 | =item on_refresh_end $term |
616 | =item on_refresh_end $term |
606 | |
617 | |
… | |
… | |
917 | local $TERM = shift; |
928 | local $TERM = shift; |
918 | my $htype = shift; |
929 | my $htype = shift; |
919 | |
930 | |
920 | if ($htype == 0) { # INIT |
931 | if ($htype == 0) { # INIT |
921 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
932 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
922 | |
933 | |
923 | my %ext_arg; |
934 | my %ext_arg; |
924 | |
935 | |
925 | { |
936 | { |
926 | my @init = @TERM_INIT; |
937 | my @init = @TERM_INIT; |
927 | @TERM_INIT = (); |
938 | @TERM_INIT = (); |
… | |
… | |
990 | |
1001 | |
991 | sub SET_COLOR($$$) { |
1002 | sub SET_COLOR($$$) { |
992 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
1003 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
993 | } |
1004 | } |
994 | |
1005 | |
|
|
1006 | sub rend2mask { |
|
|
1007 | no strict 'refs'; |
|
|
1008 | my ($str, $mask) = (@_, 0); |
|
|
1009 | my %color = ( fg => undef, bg => undef ); |
|
|
1010 | my @failed; |
|
|
1011 | for my $spec ( split /\s+/, $str ) { |
|
|
1012 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1013 | $color{lc($1)} = $2; |
|
|
1014 | } else { |
|
|
1015 | my $neg = $spec =~ s/^[-^]//; |
|
|
1016 | unless ( exists &{"RS_$spec"} ) { |
|
|
1017 | push @failed, $spec; |
|
|
1018 | next; |
|
|
1019 | } |
|
|
1020 | my $cur = &{"RS_$spec"}; |
|
|
1021 | if ( $neg ) { |
|
|
1022 | $mask &= ~$cur; |
|
|
1023 | } else { |
|
|
1024 | $mask |= $cur; |
|
|
1025 | } |
|
|
1026 | } |
|
|
1027 | } |
|
|
1028 | ($mask, @color{qw(fg bg)}, \@failed) |
|
|
1029 | } |
|
|
1030 | |
995 | # urxvt::term::extension |
1031 | # urxvt::term::extension |
996 | |
1032 | |
997 | package urxvt::term::extension; |
1033 | package urxvt::term::extension; |
998 | |
1034 | |
999 | sub enable { |
1035 | sub enable { |
… | |
… | |
1068 | is that you cannot use blocking APIs, but the non-blocking variant should |
1104 | is that you cannot use blocking APIs, but the non-blocking variant should |
1069 | work. |
1105 | work. |
1070 | |
1106 | |
1071 | =cut |
1107 | =cut |
1072 | |
1108 | |
1073 | our $VERSION = 1; |
1109 | our $VERSION = '3.4'; |
1074 | |
1110 | |
1075 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1111 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1076 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1112 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1077 | |
1113 | |
1078 | sub timer { |
1114 | sub timer { |
… | |
… | |
1109 | |
1145 | |
1110 | sub DESTROY { |
1146 | sub DESTROY { |
1111 | $_[0][1]->stop; |
1147 | $_[0][1]->stop; |
1112 | } |
1148 | } |
1113 | |
1149 | |
1114 | sub condvar { |
|
|
1115 | bless \my $flag, urxvt::anyevent:: |
|
|
1116 | } |
|
|
1117 | |
|
|
1118 | sub broadcast { |
|
|
1119 | ${$_[0]}++; |
|
|
1120 | } |
|
|
1121 | |
|
|
1122 | sub wait { |
|
|
1123 | unless (${$_[0]}) { |
|
|
1124 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
|
|
1125 | } |
|
|
1126 | } |
|
|
1127 | |
|
|
1128 | sub one_event { |
1150 | sub one_event { |
1129 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1151 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1130 | } |
1152 | } |
1131 | |
1153 | |
1132 | package urxvt::term; |
1154 | package urxvt::term; |
… | |
… | |
1253 | Here is a likely non-exhaustive list of resource names, not all of which |
1275 | Here is a likely non-exhaustive list of resource names, not all of which |
1254 | are supported in every build, please see the source file F</src/rsinc.h> |
1276 | are supported in every build, please see the source file F</src/rsinc.h> |
1255 | to see the actual list: |
1277 | to see the actual list: |
1256 | |
1278 | |
1257 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1279 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1258 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1280 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1259 | display_name embed ext_bwidth fade font geometry hold iconName |
1281 | display_name embed ext_bwidth fade font geometry hold iconName |
1260 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1282 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1261 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1283 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1262 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1284 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1263 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1285 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1264 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1286 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1265 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1287 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1266 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1288 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1267 | secondaryScreen secondaryScroll selectstyle shade term_name title |
1289 | secondaryScreen secondaryScroll shade term_name title |
1268 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1290 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1269 | visualBell |
1291 | visualBell |
1270 | |
1292 | |
1271 | =cut |
1293 | =cut |
1272 | |
1294 | |
1273 | sub resource($$;$) { |
1295 | sub resource($$;$) { |
1274 | my ($self, $name) = (shift, shift); |
1296 | my ($self, $name) = (shift, shift); |
1275 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1297 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1276 | &urxvt::term::_resource |
1298 | goto &urxvt::term::_resource |
1277 | } |
1299 | } |
1278 | |
1300 | |
1279 | =item $value = $term->x_resource ($pattern) |
1301 | =item $value = $term->x_resource ($pattern) |
1280 | |
1302 | |
1281 | Returns the X-Resource for the given pattern, excluding the program or |
1303 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
1364 | |
1386 | |
1365 | The methods currently supported on C<urxvt::overlay> objects are: |
1387 | The methods currently supported on C<urxvt::overlay> objects are: |
1366 | |
1388 | |
1367 | =over 4 |
1389 | =over 4 |
1368 | |
1390 | |
1369 | =item $overlay->set ($x, $y, $text, $rend) |
1391 | =item $overlay->set ($x, $y, $text[, $rend]) |
1370 | |
1392 | |
1371 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1393 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1372 | text in rxvt-unicode's special encoding and an array of rendition values |
1394 | text in rxvt-unicode's special encoding and an array of rendition values |
1373 | at a specific position inside the overlay. |
1395 | at a specific position inside the overlay. |
|
|
1396 | |
|
|
1397 | If C<$rend> is missing, then the rendition will not be changed. |
1374 | |
1398 | |
1375 | =item $overlay->hide |
1399 | =item $overlay->hide |
1376 | |
1400 | |
1377 | If visible, hide the overlay, but do not destroy it. |
1401 | If visible, hide the overlay, but do not destroy it. |
1378 | |
1402 | |
… | |
… | |
1588 | |
1612 | |
1589 | Used after changing terminal contents to display them. |
1613 | Used after changing terminal contents to display them. |
1590 | |
1614 | |
1591 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1615 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1592 | |
1616 | |
1593 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1617 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1594 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1618 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1595 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1596 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1619 | terminal line. Nothing will be returned if a nonexistent line |
1597 | is requested. |
1620 | is requested. |
1598 | |
1621 | |
1599 | If C<$new_text> is specified, it will replace characters in the current |
1622 | If C<$new_text> is specified, it will replace characters in the current |
1600 | line, starting at column C<$start_col> (default C<0>), which is useful |
1623 | line, starting at column C<$start_col> (default C<0>), which is useful |
1601 | to replace only parts of a line. The font index in the rendition will |
1624 | to replace only parts of a line. The font index in the rendition will |
1602 | automatically be updated. |
1625 | automatically be updated. |
1603 | |
1626 | |
1604 | C<$text> is in a special encoding: tabs and wide characters that use more |
1627 | C<$text> is in a special encoding: tabs and wide characters that use more |
1605 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1628 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1606 | characters. Characters with combining characters and other characters that |
1629 | characters. Characters with combining characters and other characters that |
1607 | do not fit into the normal tetx encoding will be replaced with characters |
1630 | do not fit into the normal text encoding will be replaced with characters |
1608 | in the private use area. |
1631 | in the private use area. |
1609 | |
1632 | |
1610 | You have to obey this encoding when changing text. The advantage is |
1633 | You have to obey this encoding when changing text. The advantage is |
1611 | that C<substr> and similar functions work on screen cells and not on |
1634 | that C<substr> and similar functions work on screen cells and not on |
1612 | characters. |
1635 | characters. |
… | |
… | |
1799 | |
1822 | |
1800 | =item @atoms = $term->XListProperties ($window) |
1823 | =item @atoms = $term->XListProperties ($window) |
1801 | |
1824 | |
1802 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1825 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1803 | |
1826 | |
1804 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
1827 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
1805 | |
1828 | |
1806 | =item $term->XDeleteProperty ($window, $property) |
1829 | =item $term->XDeleteProperty ($window, $property) |
1807 | |
1830 | |
1808 | =item $window = $term->DefaultRootWindow |
1831 | =item $window = $term->DefaultRootWindow |
1809 | |
1832 | |
… | |
… | |
1931 | my $env = $self->{term}->env; |
1954 | my $env = $self->{term}->env; |
1932 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1955 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1933 | delete $env->{LC_ALL}; |
1956 | delete $env->{LC_ALL}; |
1934 | $env->{LC_CTYPE} = $self->{term}->locale; |
1957 | $env->{LC_CTYPE} = $self->{term}->locale; |
1935 | |
1958 | |
1936 | urxvt::term->new ($env, "popup", |
1959 | my $term = urxvt::term->new ( |
|
|
1960 | $env, "popup", |
1937 | "--perl-lib" => "", "--perl-ext-common" => "", |
1961 | "--perl-lib" => "", "--perl-ext-common" => "", |
1938 | "-pty-fd" => -1, "-sl" => 0, |
1962 | "-pty-fd" => -1, "-sl" => 0, |
1939 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1963 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1940 | "--transient-for" => $self->{term}->parent, |
1964 | "--transient-for" => $self->{term}->parent, |
1941 | "-display" => $self->{term}->display_id, |
1965 | "-display" => $self->{term}->display_id, |
1942 | "-pe" => "urxvt-popup") |
1966 | "-pe" => "urxvt-popup", |
1943 | or die "unable to create popup window\n"; |
1967 | ) or die "unable to create popup window\n"; |
|
|
1968 | |
|
|
1969 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
1970 | $term->ungrab; |
|
|
1971 | $term->destroy; |
|
|
1972 | die "unable to initialise popup window\n"; |
|
|
1973 | } |
1944 | } |
1974 | } |
1945 | |
1975 | |
1946 | sub DESTROY { |
1976 | sub DESTROY { |
1947 | my ($self) = @_; |
1977 | my ($self) = @_; |
1948 | |
1978 | |
… | |
… | |
1953 | =back |
1983 | =back |
1954 | |
1984 | |
1955 | =cut |
1985 | =cut |
1956 | |
1986 | |
1957 | package urxvt::watcher; |
1987 | package urxvt::watcher; |
1958 | |
|
|
1959 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1960 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1961 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1962 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1963 | |
1988 | |
1964 | =head2 The C<urxvt::timer> Class |
1989 | =head2 The C<urxvt::timer> Class |
1965 | |
1990 | |
1966 | This class implements timer watchers/events. Time is represented as a |
1991 | This class implements timer watchers/events. Time is represented as a |
1967 | fractional number of seconds since the epoch. Example: |
1992 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1971 | ->new |
1996 | ->new |
1972 | ->interval (1) |
1997 | ->interval (1) |
1973 | ->cb (sub { |
1998 | ->cb (sub { |
1974 | $term->{overlay}->set (0, 0, |
1999 | $term->{overlay}->set (0, 0, |
1975 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2000 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1976 | }); |
2001 | }); |
1977 | |
2002 | |
1978 | =over 4 |
2003 | =over 4 |
1979 | |
2004 | |
1980 | =item $timer = new urxvt::timer |
2005 | =item $timer = new urxvt::timer |
1981 | |
2006 | |
… | |
… | |
2024 | |
2049 | |
2025 | $term->{socket} = ... |
2050 | $term->{socket} = ... |
2026 | $term->{iow} = urxvt::iow |
2051 | $term->{iow} = urxvt::iow |
2027 | ->new |
2052 | ->new |
2028 | ->fd (fileno $term->{socket}) |
2053 | ->fd (fileno $term->{socket}) |
2029 | ->events (urxvt::EVENT_READ) |
2054 | ->events (urxvt::EV_READ) |
2030 | ->start |
2055 | ->start |
2031 | ->cb (sub { |
2056 | ->cb (sub { |
2032 | my ($iow, $revents) = @_; |
2057 | my ($iow, $revents) = @_; |
2033 | # $revents must be 1 here, no need to check |
2058 | # $revents must be 1 here, no need to check |
2034 | sysread $term->{socket}, my $buf, 8192 |
2059 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
2052 | Set the file descriptor (not handle) to watch. |
2077 | Set the file descriptor (not handle) to watch. |
2053 | |
2078 | |
2054 | =item $iow = $iow->events ($eventmask) |
2079 | =item $iow = $iow->events ($eventmask) |
2055 | |
2080 | |
2056 | Set the event mask to watch. The only allowed values are |
2081 | Set the event mask to watch. The only allowed values are |
2057 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2082 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
2058 | together, or C<urxvt::EVENT_NONE>. |
2083 | together, or C<urxvt::EV_NONE>. |
2059 | |
2084 | |
2060 | =item $iow = $iow->start |
2085 | =item $iow = $iow->start |
2061 | |
2086 | |
2062 | Start watching for requested events on the given handle. |
2087 | Start watching for requested events on the given handle. |
2063 | |
2088 | |
… | |
… | |
2104 | ->new |
2129 | ->new |
2105 | ->start ($pid) |
2130 | ->start ($pid) |
2106 | ->cb (sub { |
2131 | ->cb (sub { |
2107 | my ($pw, $exit_status) = @_; |
2132 | my ($pw, $exit_status) = @_; |
2108 | ... |
2133 | ... |
2109 | }); |
2134 | }); |
2110 | |
2135 | |
2111 | =over 4 |
2136 | =over 4 |
2112 | |
2137 | |
2113 | =item $pw = new urxvt::pw |
2138 | =item $pw = new urxvt::pw |
2114 | |
2139 | |
… | |
… | |
2153 | http://software.schmorp.de/pkg/rxvt-unicode |
2178 | http://software.schmorp.de/pkg/rxvt-unicode |
2154 | |
2179 | |
2155 | =cut |
2180 | =cut |
2156 | |
2181 | |
2157 | 1 |
2182 | 1 |
|
|
2183 | |
|
|
2184 | # vim: sw=3: |