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.158 by ayin, Wed Oct 31 15:17:51 2007 UTC vs.
Revision 1.173 by root, Wed Nov 5 12:45:36 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
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
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
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 307
308=item automove-background 308=item overlay-osc
309 309
310This is basically a very small extension that dynamically changes the 310This extension implements some OSC commands to display timed popups on the
311background pixmap offset to the window position, in effect creating the 311screen - useful for status displays from within scripts. You have to read
312same effect as pseudo transparency with a custom pixmap. No scaling is 312the sources for more info.
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 313
321=item block-graphics-to-ascii 314=item block-graphics-to-ascii
322 315
323A not very useful example of filtering all text output to the terminal 316A not very useful example of filtering all text output to the terminal
324by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
554 547
555It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 548It 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 549$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
557number of lines that will be in the scrollback buffer. 550number of lines that will be in the scrollback buffer.
558 551
559=item on_osc_seq $term, $op, $args 552=item on_osc_seq $term, $op, $args, $resp
560 553
561Called on every OSC sequence and can be used to suppress it or modify its 554Called 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 555behaviour. The default should be to return an empty list. A true value
563suppresses execution of the request completely. Make sure you don't get 556suppresses execution of the request completely. Make sure you don't get
564confused by recursive invocations when you output an osc sequence within 557confused by recursive invocations when you output an OSC sequence within
565this callback. 558this callback.
566 559
567C<on_osc_seq_perl> should be used for new behaviour. 560C<on_osc_seq_perl> should be used for new behaviour.
568 561
569=item on_osc_seq_perl $term, $string 562=item on_osc_seq_perl $term, $args, $resp
570 563
571Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 564Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
572operating system command) is processed. Cursor position and other state 565operating system command) is processed. Cursor position and other state
573information is up-to-date when this happens. For interoperability, the 566information is up-to-date when this happens. For interoperability, the
574string should start with the extension name and a colon, to distinguish 567string should start with the extension name (sans -osc) and a semicolon,
575it from commands for other extensions, and this might be enforced in the 568to distinguish it from commands for other extensions, and this might be
576future. 569enforced in the future.
570
571For example, C<overlay-osc> uses this:
572
573 sub on_osc_seq_perl {
574 my ($self, $osc, $resp) = @_;
575
576 return unless $osc =~ s/^overlay;//;
577
578 ... process remaining $osc string
579 }
577 580
578Be careful not ever to trust (in a security sense) the data you receive, 581Be 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 582as its source can not easily be controlled (e-mail content, messages from
580other users on the same system etc.). 583other users on the same system etc.).
584
585For responses, C<$resp> contains the end-of-args separator used by the
586sender.
581 587
582=item on_add_lines $term, $string 588=item on_add_lines $term, $string
583 589
584Called whenever text is about to be output, with the text as argument. You 590Called 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 591can 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 612later with the already-modified line (e.g. if unrelated parts change), so
607you cannot just toggle rendition bits, but only set them. 613you cannot just toggle rendition bits, but only set them.
608 614
609=item on_refresh_begin $term 615=item on_refresh_begin $term
610 616
611Called just before the screen gets redrawn. Can be used for overlay 617Called just before the screen gets redrawn. Can be used for overlay or
612or similar effects by modify terminal contents in refresh_begin, and 618similar effects by modifying the terminal contents in refresh_begin, and
613restoring them in refresh_end. The built-in overlay and selection display 619restoring them in refresh_end. The built-in overlay and selection display
614code is run after this hook, and takes precedence. 620code is run after this hook, and takes precedence.
615 621
616=item on_refresh_end $term 622=item on_refresh_end $term
617 623
1104is that you cannot use blocking APIs, but the non-blocking variant should 1110is that you cannot use blocking APIs, but the non-blocking variant should
1105work. 1111work.
1106 1112
1107=cut 1113=cut
1108 1114
1109our $VERSION = 1; 1115our $VERSION = '3.4';
1110 1116
1111$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1117$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1118push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113 1119
1114sub timer { 1120sub timer {
1145 1151
1146sub DESTROY { 1152sub DESTROY {
1147 $_[0][1]->stop; 1153 $_[0][1]->stop;
1148} 1154}
1149 1155
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 { 1156sub one_event {
1165 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1157 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1166} 1158}
1167 1159
1168package urxvt::term; 1160package urxvt::term;
1289Here is a likely non-exhaustive list of resource names, not all of which 1281Here 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> 1282are supported in every build, please see the source file F</src/rsinc.h>
1291to see the actual list: 1283to see the actual list:
1292 1284
1293 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1285 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1294 borderLess color cursorBlink cursorUnderline cutchars delete_key 1286 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1295 display_name embed ext_bwidth fade font geometry hold iconName 1287 display_name embed ext_bwidth fade font geometry hold iconName
1296 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1288 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1297 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1289 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
1298 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1290 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1299 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1291 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1300 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1292 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1301 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1293 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1302 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1294 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1303 secondaryScreen secondaryScroll selectstyle shade term_name title 1295 secondaryScreen secondaryScroll shade term_name title
1304 transient_for transparent transparent_all tripleclickwords utmpInhibit 1296 transient_for transparent transparent_all tripleclickwords utmpInhibit
1305 visualBell 1297 visualBell
1306 1298
1307=cut 1299=cut
1308 1300
1309sub resource($$;$) { 1301sub resource($$;$) {
1310 my ($self, $name) = (shift, shift); 1302 my ($self, $name) = (shift, shift);
1311 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1303 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1312 &urxvt::term::_resource 1304 goto &urxvt::term::_resource
1313} 1305}
1314 1306
1315=item $value = $term->x_resource ($pattern) 1307=item $value = $term->x_resource ($pattern)
1316 1308
1317Returns the X-Resource for the given pattern, excluding the program or 1309Returns the X-Resource for the given pattern, excluding the program or
1400 1392
1401The methods currently supported on C<urxvt::overlay> objects are: 1393The methods currently supported on C<urxvt::overlay> objects are:
1402 1394
1403=over 4 1395=over 4
1404 1396
1405=item $overlay->set ($x, $y, $text, $rend) 1397=item $overlay->set ($x, $y, $text[, $rend])
1406 1398
1407Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1399Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1408text in rxvt-unicode's special encoding and an array of rendition values 1400text in rxvt-unicode's special encoding and an array of rendition values
1409at a specific position inside the overlay. 1401at a specific position inside the overlay.
1402
1403If C<$rend> is missing, then the rendition will not be changed.
1410 1404
1411=item $overlay->hide 1405=item $overlay->hide
1412 1406
1413If visible, hide the overlay, but do not destroy it. 1407If visible, hide the overlay, but do not destroy it.
1414 1408
1624 1618
1625Used after changing terminal contents to display them. 1619Used after changing terminal contents to display them.
1626 1620
1627=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1621=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1628 1622
1629Returns the text of the entire row with number C<$row_number>. Row C<0> 1623Returns 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 1624is 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 1625terminal line. Nothing will be returned if a nonexistent line
1633is requested. 1626is requested.
1634 1627
1635If C<$new_text> is specified, it will replace characters in the current 1628If 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 1629line, 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 1630to replace only parts of a line. The font index in the rendition will
1638automatically be updated. 1631automatically be updated.
1639 1632
1640C<$text> is in a special encoding: tabs and wide characters that use more 1633C<$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) 1634than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642characters. Characters with combining characters and other characters that 1635characters. Characters with combining characters and other characters that
1643do not fit into the normal tetx encoding will be replaced with characters 1636do not fit into the normal text encoding will be replaced with characters
1644in the private use area. 1637in the private use area.
1645 1638
1646You have to obey this encoding when changing text. The advantage is 1639You have to obey this encoding when changing text. The advantage is
1647that C<substr> and similar functions work on screen cells and not on 1640that C<substr> and similar functions work on screen cells and not on
1648characters. 1641characters.
1835 1828
1836=item @atoms = $term->XListProperties ($window) 1829=item @atoms = $term->XListProperties ($window)
1837 1830
1838=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1831=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1839 1832
1840=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1833=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1841 1834
1842=item $term->XDeleteProperty ($window, $property) 1835=item $term->XDeleteProperty ($window, $property)
1843 1836
1844=item $window = $term->DefaultRootWindow 1837=item $window = $term->DefaultRootWindow
1845 1838
1967 my $env = $self->{term}->env; 1960 my $env = $self->{term}->env;
1968 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1961 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1969 delete $env->{LC_ALL}; 1962 delete $env->{LC_ALL};
1970 $env->{LC_CTYPE} = $self->{term}->locale; 1963 $env->{LC_CTYPE} = $self->{term}->locale;
1971 1964
1972 urxvt::term->new ($env, "popup", 1965 my $term = urxvt::term->new (
1966 $env, "popup",
1973 "--perl-lib" => "", "--perl-ext-common" => "", 1967 "--perl-lib" => "", "--perl-ext-common" => "",
1974 "-pty-fd" => -1, "-sl" => 0, 1968 "-pty-fd" => -1, "-sl" => 0,
1975 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 1969 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1976 "--transient-for" => $self->{term}->parent, 1970 "--transient-for" => $self->{term}->parent,
1977 "-display" => $self->{term}->display_id, 1971 "-display" => $self->{term}->display_id,
1978 "-pe" => "urxvt-popup") 1972 "-pe" => "urxvt-popup",
1979 or die "unable to create popup window\n"; 1973 ) or die "unable to create popup window\n";
1974
1975 unless (delete $term->{urxvt_popup_init_done}) {
1976 $term->ungrab;
1977 $term->destroy;
1978 die "unable to initialise popup window\n";
1979 }
1980} 1980}
1981 1981
1982sub DESTROY { 1982sub DESTROY {
1983 my ($self) = @_; 1983 my ($self) = @_;
1984 1984
2055 2055
2056 $term->{socket} = ... 2056 $term->{socket} = ...
2057 $term->{iow} = urxvt::iow 2057 $term->{iow} = urxvt::iow
2058 ->new 2058 ->new
2059 ->fd (fileno $term->{socket}) 2059 ->fd (fileno $term->{socket})
2060 ->events (urxvt::EVENT_READ) 2060 ->events (urxvt::EV_READ)
2061 ->start 2061 ->start
2062 ->cb (sub { 2062 ->cb (sub {
2063 my ($iow, $revents) = @_; 2063 my ($iow, $revents) = @_;
2064 # $revents must be 1 here, no need to check 2064 # $revents must be 1 here, no need to check
2065 sysread $term->{socket}, my $buf, 8192 2065 sysread $term->{socket}, my $buf, 8192
2083Set the file descriptor (not handle) to watch. 2083Set the file descriptor (not handle) to watch.
2084 2084
2085=item $iow = $iow->events ($eventmask) 2085=item $iow = $iow->events ($eventmask)
2086 2086
2087Set the event mask to watch. The only allowed values are 2087Set the event mask to watch. The only allowed values are
2088C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2088C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2089together, or C<urxvt::EVENT_NONE>. 2089together, or C<urxvt::EV_NONE>.
2090 2090
2091=item $iow = $iow->start 2091=item $iow = $iow->start
2092 2092
2093Start watching for requested events on the given handle. 2093Start watching for requested events on the given handle.
2094 2094

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines