ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.157 by ayin, Wed Oct 31 09:55:24 2007 UTC vs.
Revision 1.170 by root, Tue Sep 23 07:03:13 2008 UTC

40 40
41 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
42 42
43Or by adding them to the resource for extensions loaded by default: 43Or 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
102Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed. 104popup is being displayed.
105 105
106It's sole argument is the popup menu, which can be modified. It should 106Its sole argument is the popup menu, which can be modified. It should
107either return nothing or a string, the initial boolean value and a code 107either return nothing or a string, the initial boolean value and a code
108reference. The string will be used as button text and the code reference 108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as 109will be called when the toggle changes, with the new boolean value as
110first argument. 110first argument.
111 111
112The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
113C<$self->{myoption}>: 113C<< $self->{myoption} >>:
114 114
115 push @{ $self->{term}{option_popup_hook} }, sub { 115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 }; 117 };
118 118
124 124
125Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed. 127popup is being displayed.
128 128
129It's sole argument is the popup menu, which can be modified. The selection 129Its sole argument is the popup menu, which can be modified. The selection
130is in C<$_>, which can be used to decide whether to add something or not. 130is in C<$_>, which can be used to decide whether to add something or not.
131It should either return nothing or a string and a code reference. The 131It should either return nothing or a string and a code reference. The
132string will be used as button text and the code reference will be called 132string will be used as button text and the code reference will be called
133when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
134 134
135The following will add an entry C<a to b> that transforms all C<a>s in 135The following will add an entry C<a to b> that transforms all C<a>s in
136the selection to C<b>s, but only if the selection currently contains any 136the selection to C<b>s, but only if the selection currently contains any
137C<a>s: 137C<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
167A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
168the moment, it reacts to clicking shift-left mouse button by trying to 168the moment, it reacts to clicking shift-left mouse button by trying to
169move the text cursor to this position. It does so by generating as many 169move the text cursor to this position. It does so by generating as many
170cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
171for programs that correctly support wide characters). 171for programs that correctly support wide characters).
172 172
173To avoid too many false positives, this is only done when: 173To 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
279This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
280not work perfectly, and some input methods don't seem to work well with 280not work perfectly, and some input methods don't seem to work well with
281OnTheSpot editing in general, but it seems to work at leats for SCIM and 281OnTheSpot editing in general, but it seems to work at least for SCIM and
282kinput2. 282kinput2.
283 283
284You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
285C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
286 286
294will show or hide itself. Another press of the accelerator key will hide 294will show or hide itself. Another press of the accelerator key will hide
295or show it again. 295or show it again.
296 296
297Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
298 298
299This is useful if you need a single terminal thats not using any desktop 299This is useful if you need a single terminal that is not using any desktop
300space most of the time but is quickly available at the press of a key. 300space most of the time but is quickly available at the press of a key.
301 301
302The accelerator key is grabbed regardless of any modifiers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
303extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
304 304
305If you want a quake-like animation, tell your window manager to do so 305If 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
310This is basically a very small extension that dynamically changes the
311background pixmap offset to the window position, in effect creating the
312same effect as pseudo transparency with a custom pixmap. No scaling is
313supported in this mode. Example:
314
315 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
316
317L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
318shows how this extension can be used to implement an automatically blurred
319transparent background.
320 307
321=item block-graphics-to-ascii 308=item block-graphics-to-ascii
322 309
323A not very useful example of filtering all text output to the terminal 310A not very useful example of filtering all text output to the terminal
324by replacing all line-drawing characters (U+2500 .. U+259F) by a 311by replacing all line-drawing characters (U+2500 .. U+259F) by a
329Displays a digital clock using the built-in overlay. 316Displays a digital clock using the built-in overlay.
330 317
331=item remote-clipboard 318=item remote-clipboard
332 319
333Somewhat of a misnomer, this extension adds two menu entries to the 320Somewhat of a misnomer, this extension adds two menu entries to the
334selection popup that allows one ti run external commands to store the 321selection popup that allows one to run external commands to store the
335selection somewhere and fetch it again. 322selection somewhere and fetch it again.
336 323
337We use it to implement a "distributed selection mechanism", which just 324We use it to implement a "distributed selection mechanism", which just
338means that one command uploads the file to a remote server, and another 325means that one command uploads the file to a remote server, and another
339reads it. 326reads it.
1104is that you cannot use blocking APIs, but the non-blocking variant should 1091is that you cannot use blocking APIs, but the non-blocking variant should
1105work. 1092work.
1106 1093
1107=cut 1094=cut
1108 1095
1109our $VERSION = 1; 1096our $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
1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1099push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113 1100
1114sub timer { 1101sub timer {
1145 1132
1146sub DESTROY { 1133sub DESTROY {
1147 $_[0][1]->stop; 1134 $_[0][1]->stop;
1148} 1135}
1149 1136
1150sub condvar {
1151 bless \my $flag, urxvt::anyevent::
1152}
1153
1154sub broadcast {
1155 ${$_[0]}++;
1156}
1157
1158sub wait {
1159 unless (${$_[0]}) {
1160 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1161 }
1162}
1163
1164sub one_event { 1137sub 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
1168package urxvt::term; 1141package urxvt::term;
1289Here is a likely non-exhaustive list of resource names, not all of which 1262Here is a likely non-exhaustive list of resource names, not all of which
1290are supported in every build, please see the source file F</src/rsinc.h> 1263are supported in every build, please see the source file F</src/rsinc.h>
1291to see the actual list: 1264to 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
1309sub resource($$;$) { 1282sub 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
1317Returns the X-Resource for the given pattern, excluding the program or 1290Returns the X-Resource for the given pattern, excluding the program or
1624 1597
1625Used after changing terminal contents to display them. 1598Used 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
1629Returns the text of the entire row with number C<$row_number>. Row C<0> 1602Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1630is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1603is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1631terminal line. The scrollback buffer starts at line C<-1> and extends to
1632line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1604terminal line. Nothing will be returned if a nonexistent line
1633is requested. 1605is requested.
1634 1606
1635If C<$new_text> is specified, it will replace characters in the current 1607If C<$new_text> is specified, it will replace characters in the current
1636line, starting at column C<$start_col> (default C<0>), which is useful 1608line, starting at column C<$start_col> (default C<0>), which is useful
1637to replace only parts of a line. The font index in the rendition will 1609to replace only parts of a line. The font index in the rendition will
1638automatically be updated. 1610automatically be updated.
1639 1611
1640C<$text> is in a special encoding: tabs and wide characters that use more 1612C<$text> is in a special encoding: tabs and wide characters that use more
1641than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1613than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642characters. Characters with combining characters and other characters that 1614characters. Characters with combining characters and other characters that
1643do not fit into the normal tetx encoding will be replaced with characters 1615do not fit into the normal text encoding will be replaced with characters
1644in the private use area. 1616in the private use area.
1645 1617
1646You have to obey this encoding when changing text. The advantage is 1618You have to obey this encoding when changing text. The advantage is
1647that C<substr> and similar functions work on screen cells and not on 1619that C<substr> and similar functions work on screen cells and not on
1648characters. 1620characters.
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
1982sub DESTROY { 1961sub 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
2083Set the file descriptor (not handle) to watch. 2062Set the file descriptor (not handle) to watch.
2084 2063
2085=item $iow = $iow->events ($eventmask) 2064=item $iow = $iow->events ($eventmask)
2086 2065
2087Set the event mask to watch. The only allowed values are 2066Set the event mask to watch. The only allowed values are
2088C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2067C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2089together, or C<urxvt::EVENT_NONE>. 2068together, or C<urxvt::EV_NONE>.
2090 2069
2091=item $iow = $iow->start 2070=item $iow = $iow->start
2092 2071
2093Start watching for requested events on the given handle. 2072Start watching for requested events on the given handle.
2094 2073

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines