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.156 by ayin, Wed Aug 1 17:55:37 2007 UTC vs.
Revision 1.171 by root, Fri Oct 10 00:11:44 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.
554 541
555It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 542It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
556$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
557number of lines that will be in the scrollback buffer. 544number of lines that will be in the scrollback buffer.
558 545
559=item on_osc_seq $term, $op, $args 546=item on_osc_seq $term, $op, $args, $resp
560 547
561Called on every OSC sequence and can be used to suppress it or modify its 548Called on every OSC sequence and can be used to suppress it or modify its
562behaviour. The default should be to return an empty list. A true value 549behaviour. The default should be to return an empty list. A true value
563suppresses execution of the request completely. Make sure you don't get 550suppresses execution of the request completely. Make sure you don't get
564confused by recursive invocations when you output an osc sequence within 551confused by recursive invocations when you output an OSC sequence within
565this callback. 552this callback.
566 553
567C<on_osc_seq_perl> should be used for new behaviour. 554C<on_osc_seq_perl> should be used for new behaviour.
568 555
569=item on_osc_seq_perl $term, $string 556=item on_osc_seq_perl $term, $args, $resp
570 557
571Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
572operating system command) is processed. Cursor position and other state 559operating system command) is processed. Cursor position and other state
573information is up-to-date when this happens. For interoperability, the 560information is up-to-date when this happens. For interoperability, the
574string should start with the extension name and a colon, to distinguish 561string should start with the extension name (sans -osc) and a semicolon,
575it from commands for other extensions, and this might be enforced in the 562to distinguish it from commands for other extensions, and this might be
576future. 563enforced in the future.
564
565For 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 }
577 574
578Be careful not ever to trust (in a security sense) the data you receive, 575Be careful not ever to trust (in a security sense) the data you receive,
579as its source can not easily be controlled (e-mail content, messages from 576as its source can not easily be controlled (e-mail content, messages from
580other users on the same system etc.). 577other users on the same system etc.).
578
579For responses, C<$resp> contains the end-of-args separator used by the
580sender.
581 581
582=item on_add_lines $term, $string 582=item on_add_lines $term, $string
583 583
584Called whenever text is about to be output, with the text as argument. You 584Called whenever text is about to be output, with the text as argument. You
585can filter/change and output the text yourself by returning a true value 585can filter/change and output the text yourself by returning a true value
606later with the already-modified line (e.g. if unrelated parts change), so 606later with the already-modified line (e.g. if unrelated parts change), so
607you cannot just toggle rendition bits, but only set them. 607you cannot just toggle rendition bits, but only set them.
608 608
609=item on_refresh_begin $term 609=item on_refresh_begin $term
610 610
611Called just before the screen gets redrawn. Can be used for overlay 611Called just before the screen gets redrawn. Can be used for overlay or
612or similar effects by modify terminal contents in refresh_begin, and 612similar effects by modifying the terminal contents in refresh_begin, and
613restoring them in refresh_end. The built-in overlay and selection display 613restoring them in refresh_end. The built-in overlay and selection display
614code is run after this hook, and takes precedence. 614code is run after this hook, and takes precedence.
615 615
616=item on_refresh_end $term 616=item on_refresh_end $term
617 617
928 local $TERM = shift; 928 local $TERM = shift;
929 my $htype = shift; 929 my $htype = shift;
930 930
931 if ($htype == 0) { # INIT 931 if ($htype == 0) { # INIT
932 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 932 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
933 933
934 my %ext_arg; 934 my %ext_arg;
935 935
936 { 936 {
937 my @init = @TERM_INIT; 937 my @init = @TERM_INIT;
938 @TERM_INIT = (); 938 @TERM_INIT = ();
1104is that you cannot use blocking APIs, but the non-blocking variant should 1104is that you cannot use blocking APIs, but the non-blocking variant should
1105work. 1105work.
1106 1106
1107=cut 1107=cut
1108 1108
1109our $VERSION = 1; 1109our $VERSION = '3.4';
1110 1110
1111$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1111$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113 1113
1114sub timer { 1114sub timer {
1145 1145
1146sub DESTROY { 1146sub DESTROY {
1147 $_[0][1]->stop; 1147 $_[0][1]->stop;
1148} 1148}
1149 1149
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 { 1150sub one_event {
1165 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";
1166} 1152}
1167 1153
1168package urxvt::term; 1154package urxvt::term;
1289Here is a likely non-exhaustive list of resource names, not all of which 1275Here 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> 1276are supported in every build, please see the source file F</src/rsinc.h>
1291to see the actual list: 1277to see the actual list:
1292 1278
1293 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1279 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1294 borderLess color cursorBlink cursorUnderline cutchars delete_key 1280 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1295 display_name embed ext_bwidth fade font geometry hold iconName 1281 display_name embed ext_bwidth fade font geometry hold iconName
1296 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1282 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1297 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1283 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
1298 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1284 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1299 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1285 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1300 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1286 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1301 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1287 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1302 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1288 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1303 secondaryScreen secondaryScroll selectstyle shade term_name title 1289 secondaryScreen secondaryScroll shade term_name title
1304 transient_for transparent transparent_all tripleclickwords utmpInhibit 1290 transient_for transparent transparent_all tripleclickwords utmpInhibit
1305 visualBell 1291 visualBell
1306 1292
1307=cut 1293=cut
1308 1294
1309sub resource($$;$) { 1295sub resource($$;$) {
1310 my ($self, $name) = (shift, shift); 1296 my ($self, $name) = (shift, shift);
1311 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1297 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1312 &urxvt::term::_resource 1298 goto &urxvt::term::_resource
1313} 1299}
1314 1300
1315=item $value = $term->x_resource ($pattern) 1301=item $value = $term->x_resource ($pattern)
1316 1302
1317Returns the X-Resource for the given pattern, excluding the program or 1303Returns the X-Resource for the given pattern, excluding the program or
1624 1610
1625Used after changing terminal contents to display them. 1611Used after changing terminal contents to display them.
1626 1612
1627=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1613=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1628 1614
1629Returns the text of the entire row with number C<$row_number>. Row C<0> 1615Returns 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 1616is 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 1617terminal line. Nothing will be returned if a nonexistent line
1633is requested. 1618is requested.
1634 1619
1635If C<$new_text> is specified, it will replace characters in the current 1620If 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 1621line, 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 1622to replace only parts of a line. The font index in the rendition will
1638automatically be updated. 1623automatically be updated.
1639 1624
1640C<$text> is in a special encoding: tabs and wide characters that use more 1625C<$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) 1626than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642characters. Characters with combining characters and other characters that 1627characters. Characters with combining characters and other characters that
1643do not fit into the normal tetx encoding will be replaced with characters 1628do not fit into the normal text encoding will be replaced with characters
1644in the private use area. 1629in the private use area.
1645 1630
1646You have to obey this encoding when changing text. The advantage is 1631You have to obey this encoding when changing text. The advantage is
1647that C<substr> and similar functions work on screen cells and not on 1632that C<substr> and similar functions work on screen cells and not on
1648characters. 1633characters.
1835 1820
1836=item @atoms = $term->XListProperties ($window) 1821=item @atoms = $term->XListProperties ($window)
1837 1822
1838=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1823=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1839 1824
1840=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1825=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1841 1826
1842=item $term->XDeleteProperty ($window, $property) 1827=item $term->XDeleteProperty ($window, $property)
1843 1828
1844=item $window = $term->DefaultRootWindow 1829=item $window = $term->DefaultRootWindow
1845 1830
1967 my $env = $self->{term}->env; 1952 my $env = $self->{term}->env;
1968 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1953 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1969 delete $env->{LC_ALL}; 1954 delete $env->{LC_ALL};
1970 $env->{LC_CTYPE} = $self->{term}->locale; 1955 $env->{LC_CTYPE} = $self->{term}->locale;
1971 1956
1972 urxvt::term->new ($env, "popup", 1957 my $term = urxvt::term->new (
1958 $env, "popup",
1973 "--perl-lib" => "", "--perl-ext-common" => "", 1959 "--perl-lib" => "", "--perl-ext-common" => "",
1974 "-pty-fd" => -1, "-sl" => 0, 1960 "-pty-fd" => -1, "-sl" => 0,
1975 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 1961 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1976 "--transient-for" => $self->{term}->parent, 1962 "--transient-for" => $self->{term}->parent,
1977 "-display" => $self->{term}->display_id, 1963 "-display" => $self->{term}->display_id,
1978 "-pe" => "urxvt-popup") 1964 "-pe" => "urxvt-popup",
1979 or die "unable to create popup window\n"; 1965 ) or die "unable to create popup window\n";
1966
1967 unless (delete $term->{urxvt_popup_init_done}) {
1968 $term->ungrab;
1969 $term->destroy;
1970 die "unable to initialise popup window\n";
1971 }
1980} 1972}
1981 1973
1982sub DESTROY { 1974sub DESTROY {
1983 my ($self) = @_; 1975 my ($self) = @_;
1984 1976
2002 ->new 1994 ->new
2003 ->interval (1) 1995 ->interval (1)
2004 ->cb (sub { 1996 ->cb (sub {
2005 $term->{overlay}->set (0, 0, 1997 $term->{overlay}->set (0, 0,
2006 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1998 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2007 }); 1999 });
2008 2000
2009=over 4 2001=over 4
2010 2002
2011=item $timer = new urxvt::timer 2003=item $timer = new urxvt::timer
2012 2004
2055 2047
2056 $term->{socket} = ... 2048 $term->{socket} = ...
2057 $term->{iow} = urxvt::iow 2049 $term->{iow} = urxvt::iow
2058 ->new 2050 ->new
2059 ->fd (fileno $term->{socket}) 2051 ->fd (fileno $term->{socket})
2060 ->events (urxvt::EVENT_READ) 2052 ->events (urxvt::EV_READ)
2061 ->start 2053 ->start
2062 ->cb (sub { 2054 ->cb (sub {
2063 my ($iow, $revents) = @_; 2055 my ($iow, $revents) = @_;
2064 # $revents must be 1 here, no need to check 2056 # $revents must be 1 here, no need to check
2065 sysread $term->{socket}, my $buf, 8192 2057 sysread $term->{socket}, my $buf, 8192
2083Set the file descriptor (not handle) to watch. 2075Set the file descriptor (not handle) to watch.
2084 2076
2085=item $iow = $iow->events ($eventmask) 2077=item $iow = $iow->events ($eventmask)
2086 2078
2087Set the event mask to watch. The only allowed values are 2079Set the event mask to watch. The only allowed values are
2088C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2080C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2089together, or C<urxvt::EVENT_NONE>. 2081together, or C<urxvt::EV_NONE>.
2090 2082
2091=item $iow = $iow->start 2083=item $iow = $iow->start
2092 2084
2093Start watching for requested events on the given handle. 2085Start watching for requested events on the given handle.
2094 2086
2135 ->new 2127 ->new
2136 ->start ($pid) 2128 ->start ($pid)
2137 ->cb (sub { 2129 ->cb (sub {
2138 my ($pw, $exit_status) = @_; 2130 my ($pw, $exit_status) = @_;
2139 ... 2131 ...
2140 }); 2132 });
2141 2133
2142=over 4 2134=over 4
2143 2135
2144=item $pw = new urxvt::pw 2136=item $pw = new urxvt::pw
2145 2137

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines