… | |
… | |
40 | |
40 | |
41 | @@RXVT_NAME@@ -pe <extensionname> |
41 | @@RXVT_NAME@@ -pe <extensionname> |
42 | |
42 | |
43 | 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: |
44 | |
44 | |
45 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
45 | URxvt.perl-ext-common: default,selection-autotransform |
46 | |
46 | |
47 | =over 4 |
47 | =over 4 |
48 | |
48 | |
49 | =item selection (enabled by default) |
49 | =item selection (enabled by default) |
50 | |
50 | |
… | |
… | |
101 | |
101 | |
102 | 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 |
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
104 | popup is being displayed. |
104 | popup is being displayed. |
105 | |
105 | |
106 | 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 |
107 | 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 |
108 | 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 |
109 | 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 |
110 | first argument. |
110 | first argument. |
111 | |
111 | |
… | |
… | |
124 | |
124 | |
125 | 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 |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
127 | popup is being displayed. |
127 | popup is being displayed. |
128 | |
128 | |
129 | 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 |
130 | 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. |
131 | 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 |
132 | 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 |
133 | when the button gets activated and should transform C<$_>. |
133 | when the button gets activated and should transform C<$_>. |
134 | |
134 | |
135 | 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 |
136 | 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 |
137 | C<a>s: |
137 | C<a>s: |
138 | |
138 | |
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
140 | /a/ ? ("a to be" => sub { s/a/b/g } |
140 | /a/ ? ("a to b" => sub { s/a/b/g } |
141 | : () |
141 | : () |
142 | }; |
142 | }; |
143 | |
143 | |
144 | =item searchable-scrollback<hotkey> (enabled by default) |
144 | =item searchable-scrollback<hotkey> (enabled by default) |
145 | |
145 | |
… | |
… | |
165 | =item readline (enabled by default) |
165 | =item readline (enabled by default) |
166 | |
166 | |
167 | 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 |
168 | 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 |
169 | 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 |
170 | cursor-left or cursor-right keypresses as required (the this only works |
170 | cursor-left or cursor-right keypresses as required (this only works |
171 | for programs that correctly support wide characters). |
171 | for programs that correctly support wide characters). |
172 | |
172 | |
173 | To avoid too many false positives, this is only done when: |
173 | To avoid too many false positives, this is only done when: |
174 | |
174 | |
175 | =over 4 |
175 | =over 4 |
… | |
… | |
276 | |
276 | |
277 | =item xim-onthespot |
277 | =item xim-onthespot |
278 | |
278 | |
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
280 | 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 |
281 | 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 |
282 | kinput2. |
282 | kinput2. |
283 | |
283 | |
284 | 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 |
285 | C<OnTheSpot>, i.e.: |
285 | C<OnTheSpot>, i.e.: |
286 | |
286 | |
… | |
… | |
294 | 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 |
295 | or show it again. |
295 | or show it again. |
296 | |
296 | |
297 | Initially, the window will not be shown when using this extension. |
297 | Initially, the window will not be shown when using this extension. |
298 | |
298 | |
299 | 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 |
300 | 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. |
301 | |
301 | |
302 | The accelerator key is grabbed regardless of any modifiers, so this |
302 | The accelerator key is grabbed regardless of any modifiers, so this |
303 | extension will actually grab a physical key just for this function. |
303 | extension will actually grab a physical key just for this function. |
304 | |
304 | |
305 | 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 |
306 | (fvwm can do it). |
306 | (fvwm can do it). |
307 | |
|
|
308 | =item automove-background |
|
|
309 | |
|
|
310 | This is basically a very small extension that dynamically changes the |
|
|
311 | background pixmap offset to the window position, in effect creating the |
|
|
312 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
313 | supported in this mode. Example: |
|
|
314 | |
|
|
315 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
316 | |
|
|
317 | L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions> |
|
|
318 | shows how this extension can be used to implement an automatically blurred |
|
|
319 | transparent background. |
|
|
320 | |
307 | |
321 | =item block-graphics-to-ascii |
308 | =item block-graphics-to-ascii |
322 | |
309 | |
323 | 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 |
324 | 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 |
… | |
… | |
329 | Displays a digital clock using the built-in overlay. |
316 | Displays a digital clock using the built-in overlay. |
330 | |
317 | |
331 | =item remote-clipboard |
318 | =item remote-clipboard |
332 | |
319 | |
333 | 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 |
334 | 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 |
335 | selection somewhere and fetch it again. |
322 | selection somewhere and fetch it again. |
336 | |
323 | |
337 | We use it to implement a "distributed selection mechanism", which just |
324 | We use it to implement a "distributed selection mechanism", which just |
338 | 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 |
339 | reads it. |
326 | reads it. |
… | |
… | |
1104 | is that you cannot use blocking APIs, but the non-blocking variant should |
1091 | is that you cannot use blocking APIs, but the non-blocking variant should |
1105 | work. |
1092 | work. |
1106 | |
1093 | |
1107 | =cut |
1094 | =cut |
1108 | |
1095 | |
1109 | our $VERSION = 1; |
1096 | our $VERSION = '3.4'; |
1110 | |
1097 | |
1111 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1098 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1112 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1099 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1113 | |
1100 | |
1114 | sub timer { |
1101 | sub timer { |
… | |
… | |
1145 | |
1132 | |
1146 | sub DESTROY { |
1133 | sub DESTROY { |
1147 | $_[0][1]->stop; |
1134 | $_[0][1]->stop; |
1148 | } |
1135 | } |
1149 | |
1136 | |
1150 | sub condvar { |
|
|
1151 | bless \my $flag, urxvt::anyevent:: |
|
|
1152 | } |
|
|
1153 | |
|
|
1154 | sub broadcast { |
|
|
1155 | ${$_[0]}++; |
|
|
1156 | } |
|
|
1157 | |
|
|
1158 | sub wait { |
|
|
1159 | unless (${$_[0]}) { |
|
|
1160 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
|
|
1161 | } |
|
|
1162 | } |
|
|
1163 | |
|
|
1164 | sub one_event { |
1137 | sub one_event { |
1165 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1138 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1166 | } |
1139 | } |
1167 | |
1140 | |
1168 | package urxvt::term; |
1141 | package urxvt::term; |
… | |
… | |
1289 | Here is a likely non-exhaustive list of resource names, not all of which |
1262 | Here is a likely non-exhaustive list of resource names, not all of which |
1290 | are supported in every build, please see the source file F</src/rsinc.h> |
1263 | are supported in every build, please see the source file F</src/rsinc.h> |
1291 | to see the actual list: |
1264 | to see the actual list: |
1292 | |
1265 | |
1293 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1266 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1294 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1267 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1295 | display_name embed ext_bwidth fade font geometry hold iconName |
1268 | display_name embed ext_bwidth fade font geometry hold iconName |
1296 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1269 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1297 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1270 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1298 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1271 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1299 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1272 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1300 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1273 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1301 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1274 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1302 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1275 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1303 | secondaryScreen secondaryScroll selectstyle shade term_name title |
1276 | secondaryScreen secondaryScroll shade term_name title |
1304 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1277 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1305 | visualBell |
1278 | visualBell |
1306 | |
1279 | |
1307 | =cut |
1280 | =cut |
1308 | |
1281 | |
1309 | sub resource($$;$) { |
1282 | sub resource($$;$) { |
1310 | my ($self, $name) = (shift, shift); |
1283 | my ($self, $name) = (shift, shift); |
1311 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1284 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1312 | &urxvt::term::_resource |
1285 | goto &urxvt::term::_resource |
1313 | } |
1286 | } |
1314 | |
1287 | |
1315 | =item $value = $term->x_resource ($pattern) |
1288 | =item $value = $term->x_resource ($pattern) |
1316 | |
1289 | |
1317 | Returns the X-Resource for the given pattern, excluding the program or |
1290 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
1624 | |
1597 | |
1625 | Used after changing terminal contents to display them. |
1598 | Used after changing terminal contents to display them. |
1626 | |
1599 | |
1627 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1600 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1628 | |
1601 | |
1629 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1602 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1630 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1603 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1631 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1632 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1604 | terminal line. Nothing will be returned if a nonexistent line |
1633 | is requested. |
1605 | is requested. |
1634 | |
1606 | |
1635 | If C<$new_text> is specified, it will replace characters in the current |
1607 | If C<$new_text> is specified, it will replace characters in the current |
1636 | line, starting at column C<$start_col> (default C<0>), which is useful |
1608 | line, starting at column C<$start_col> (default C<0>), which is useful |
1637 | to replace only parts of a line. The font index in the rendition will |
1609 | to replace only parts of a line. The font index in the rendition will |
1638 | automatically be updated. |
1610 | automatically be updated. |
1639 | |
1611 | |
1640 | C<$text> is in a special encoding: tabs and wide characters that use more |
1612 | C<$text> is in a special encoding: tabs and wide characters that use more |
1641 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1613 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1642 | characters. Characters with combining characters and other characters that |
1614 | characters. Characters with combining characters and other characters that |
1643 | do not fit into the normal tetx encoding will be replaced with characters |
1615 | do not fit into the normal text encoding will be replaced with characters |
1644 | in the private use area. |
1616 | in the private use area. |
1645 | |
1617 | |
1646 | You have to obey this encoding when changing text. The advantage is |
1618 | You have to obey this encoding when changing text. The advantage is |
1647 | that C<substr> and similar functions work on screen cells and not on |
1619 | that C<substr> and similar functions work on screen cells and not on |
1648 | characters. |
1620 | characters. |
… | |
… | |
1835 | |
1807 | |
1836 | =item @atoms = $term->XListProperties ($window) |
1808 | =item @atoms = $term->XListProperties ($window) |
1837 | |
1809 | |
1838 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1810 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1839 | |
1811 | |
1840 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
1812 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
1841 | |
1813 | |
1842 | =item $term->XDeleteProperty ($window, $property) |
1814 | =item $term->XDeleteProperty ($window, $property) |
1843 | |
1815 | |
1844 | =item $window = $term->DefaultRootWindow |
1816 | =item $window = $term->DefaultRootWindow |
1845 | |
1817 | |
… | |
… | |
1967 | my $env = $self->{term}->env; |
1939 | my $env = $self->{term}->env; |
1968 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1940 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1969 | delete $env->{LC_ALL}; |
1941 | delete $env->{LC_ALL}; |
1970 | $env->{LC_CTYPE} = $self->{term}->locale; |
1942 | $env->{LC_CTYPE} = $self->{term}->locale; |
1971 | |
1943 | |
1972 | urxvt::term->new ($env, "popup", |
1944 | my $term = urxvt::term->new ( |
|
|
1945 | $env, "popup", |
1973 | "--perl-lib" => "", "--perl-ext-common" => "", |
1946 | "--perl-lib" => "", "--perl-ext-common" => "", |
1974 | "-pty-fd" => -1, "-sl" => 0, |
1947 | "-pty-fd" => -1, "-sl" => 0, |
1975 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1948 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1976 | "--transient-for" => $self->{term}->parent, |
1949 | "--transient-for" => $self->{term}->parent, |
1977 | "-display" => $self->{term}->display_id, |
1950 | "-display" => $self->{term}->display_id, |
1978 | "-pe" => "urxvt-popup") |
1951 | "-pe" => "urxvt-popup", |
1979 | or die "unable to create popup window\n"; |
1952 | ) or die "unable to create popup window\n"; |
|
|
1953 | |
|
|
1954 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
1955 | $term->ungrab; |
|
|
1956 | $term->destroy; |
|
|
1957 | die "unable to initialise popup window\n"; |
|
|
1958 | } |
1980 | } |
1959 | } |
1981 | |
1960 | |
1982 | sub DESTROY { |
1961 | sub DESTROY { |
1983 | my ($self) = @_; |
1962 | my ($self) = @_; |
1984 | |
1963 | |
… | |
… | |
2055 | |
2034 | |
2056 | $term->{socket} = ... |
2035 | $term->{socket} = ... |
2057 | $term->{iow} = urxvt::iow |
2036 | $term->{iow} = urxvt::iow |
2058 | ->new |
2037 | ->new |
2059 | ->fd (fileno $term->{socket}) |
2038 | ->fd (fileno $term->{socket}) |
2060 | ->events (urxvt::EVENT_READ) |
2039 | ->events (urxvt::EV_READ) |
2061 | ->start |
2040 | ->start |
2062 | ->cb (sub { |
2041 | ->cb (sub { |
2063 | my ($iow, $revents) = @_; |
2042 | my ($iow, $revents) = @_; |
2064 | # $revents must be 1 here, no need to check |
2043 | # $revents must be 1 here, no need to check |
2065 | sysread $term->{socket}, my $buf, 8192 |
2044 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
2083 | Set the file descriptor (not handle) to watch. |
2062 | Set the file descriptor (not handle) to watch. |
2084 | |
2063 | |
2085 | =item $iow = $iow->events ($eventmask) |
2064 | =item $iow = $iow->events ($eventmask) |
2086 | |
2065 | |
2087 | Set the event mask to watch. The only allowed values are |
2066 | Set the event mask to watch. The only allowed values are |
2088 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2067 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
2089 | together, or C<urxvt::EVENT_NONE>. |
2068 | together, or C<urxvt::EV_NONE>. |
2090 | |
2069 | |
2091 | =item $iow = $iow->start |
2070 | =item $iow = $iow->start |
2092 | |
2071 | |
2093 | Start watching for requested events on the given handle. |
2072 | Start watching for requested events on the given handle. |
2094 | |
2073 | |