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.159 by root, Sun Nov 11 04:08:00 2007 UTC vs.
Revision 1.176 by root, Sat Jul 18 05:59:49 2009 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
379 372
380I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret 373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
381the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
382which works regardless of wether xrdb is used to parse the resource file 375which works regardless of wether xrdb is used to parse the resource file
383or not. 376or not.
377
378=item macosx-pastebin and macosx-pastebin-native
379
380These two modules implement an extended clipboard for Mac OS X. They are
381used like this:
382
383 URxvt.perl-ext-common: default,macosx-clipboard
384 URxvt.keysym.M-c: perl:macosx-clipboard:copy
385 URxvt.keysym.M-v: perl:macosx-clipboard:paste
386
387The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<maxosx-pastebin> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc.
384 391
385=item example-refresh-hooks 392=item example-refresh-hooks
386 393
387Displays a very simple digital clock in the upper right corner of the 394Displays a very simple digital clock in the upper right corner of the
388window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
554 561
555It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 562It 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 563$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
557number of lines that will be in the scrollback buffer. 564number of lines that will be in the scrollback buffer.
558 565
559=item on_osc_seq $term, $op, $args 566=item on_osc_seq $term, $op, $args, $resp
560 567
561Called on every OSC sequence and can be used to suppress it or modify its 568Called 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 569behaviour. The default should be to return an empty list. A true value
563suppresses execution of the request completely. Make sure you don't get 570suppresses execution of the request completely. Make sure you don't get
564confused by recursive invocations when you output an osc sequence within 571confused by recursive invocations when you output an OSC sequence within
565this callback. 572this callback.
566 573
567C<on_osc_seq_perl> should be used for new behaviour. 574C<on_osc_seq_perl> should be used for new behaviour.
568 575
569=item on_osc_seq_perl $term, $string 576=item on_osc_seq_perl $term, $args, $resp
570 577
571Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 578Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
572operating system command) is processed. Cursor position and other state 579operating system command) is processed. Cursor position and other state
573information is up-to-date when this happens. For interoperability, the 580information is up-to-date when this happens. For interoperability, the
574string should start with the extension name and a colon, to distinguish 581string should start with the extension name (sans -osc) and a semicolon,
575it from commands for other extensions, and this might be enforced in the 582to distinguish it from commands for other extensions, and this might be
576future. 583enforced in the future.
584
585For example, C<overlay-osc> uses this:
586
587 sub on_osc_seq_perl {
588 my ($self, $osc, $resp) = @_;
589
590 return unless $osc =~ s/^overlay;//;
591
592 ... process remaining $osc string
593 }
577 594
578Be careful not ever to trust (in a security sense) the data you receive, 595Be 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 596as its source can not easily be controlled (e-mail content, messages from
580other users on the same system etc.). 597other users on the same system etc.).
598
599For responses, C<$resp> contains the end-of-args separator used by the
600sender.
581 601
582=item on_add_lines $term, $string 602=item on_add_lines $term, $string
583 603
584Called whenever text is about to be output, with the text as argument. You 604Called 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 605can 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 626later with the already-modified line (e.g. if unrelated parts change), so
607you cannot just toggle rendition bits, but only set them. 627you cannot just toggle rendition bits, but only set them.
608 628
609=item on_refresh_begin $term 629=item on_refresh_begin $term
610 630
611Called just before the screen gets redrawn. Can be used for overlay 631Called just before the screen gets redrawn. Can be used for overlay or
612or similar effects by modify terminal contents in refresh_begin, and 632similar effects by modifying the terminal contents in refresh_begin, and
613restoring them in refresh_end. The built-in overlay and selection display 633restoring them in refresh_end. The built-in overlay and selection display
614code is run after this hook, and takes precedence. 634code is run after this hook, and takes precedence.
615 635
616=item on_refresh_end $term 636=item on_refresh_end $term
617 637
1104is that you cannot use blocking APIs, but the non-blocking variant should 1124is that you cannot use blocking APIs, but the non-blocking variant should
1105work. 1125work.
1106 1126
1107=cut 1127=cut
1108 1128
1109our $VERSION = 1; 1129our $VERSION = '3.4';
1110 1130
1111$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1131$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1132push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113 1133
1114sub timer { 1134sub timer {
1116 1136
1117 my $cb = $arg{cb}; 1137 my $cb = $arg{cb};
1118 1138
1119 urxvt::timer 1139 urxvt::timer
1120 ->new 1140 ->new
1121 ->start (urxvt::NOW + $arg{after}) 1141 ->after ($arg{after})
1142 ->interval ($arg{interval})
1143 ->start
1122 ->cb (sub { 1144 ->cb (sub {
1145 #TODO interval?
1123 $_[0]->stop; # need to cancel manually 1146 $_[0]->stop; # need to cancel manually
1124 $cb->(); 1147 $cb->();
1125 }) 1148 })
1126} 1149}
1127 1150
1128sub io { 1151sub io {
1129 my ($class, %arg) = @_; 1152 my ($class, %arg) = @_;
1130 1153
1131 my $cb = $arg{cb}; 1154 my $cb = $arg{cb};
1155 my $fd = fileno $arg{fh};
1156 defined $fd or $fd = $arg{fh};
1132 1157
1133 bless [$arg{fh}, urxvt::iow 1158 bless [$arg{fh}, urxvt::iow
1134 ->new 1159 ->new
1135 ->fd (fileno $arg{fh}) 1160 ->fd (defined fileno $arg{fh})
1136 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1161 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1137 | ($arg{poll} =~ /w/ ? 2 : 0)) 1162 | ($arg{poll} =~ /w/ ? 2 : 0))
1138 ->start 1163 ->start
1139 ->cb (sub { 1164 ->cb ($cb)
1140 $cb->(($_[1] & 1 ? 'r' : '')
1141 . ($_[1] & 2 ? 'w' : ''));
1142 })],
1143 urxvt::anyevent:: 1165 ], urxvt::anyevent::
1166}
1167
1168sub idle {
1169 my ($class, %arg) = @_;
1170
1171 my $cb = $arg{cb};
1172
1173 urxvt::iw
1174 ->new
1175 ->start
1176 ->cb (sub {
1177 #TODO really cancel?
1178 $_[0]->stop; # need to cancel manually
1179 $cb->();
1180 })
1181}
1182
1183sub child {
1184 my ($class, %arg) = @_;
1185
1186 my $cb = $arg{cb};
1187
1188 urxvt::pw
1189 ->new
1190 ->start ($arg{pid})
1191 ->cb (sub {
1192 #TODO really cancel?
1193 $_[0]->stop; # need to cancel manually
1194 $cb->($_[0]->rpid, $_[0]->rstatus);
1195 })
1144} 1196}
1145 1197
1146sub DESTROY { 1198sub DESTROY {
1147 $_[0][1]->stop; 1199 $_[0][1]->stop;
1148}
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} 1200}
1163 1201
1164sub one_event { 1202sub one_event {
1165 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1203 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1166} 1204}
1289Here is a likely non-exhaustive list of resource names, not all of which 1327Here 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> 1328are supported in every build, please see the source file F</src/rsinc.h>
1291to see the actual list: 1329to see the actual list:
1292 1330
1293 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1331 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1294 borderLess color cursorBlink cursorUnderline cutchars delete_key 1332 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1295 display_name embed ext_bwidth fade font geometry hold iconName 1333 display_name embed ext_bwidth fade font geometry hold iconName
1296 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1334 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1297 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1335 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1298 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1336 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1299 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1337 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1300 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1338 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1301 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1339 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1302 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1340 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1303 secondaryScreen secondaryScroll selectstyle shade term_name title 1341 secondaryScreen secondaryScroll shade term_name title
1304 transient_for transparent transparent_all tripleclickwords utmpInhibit 1342 transient_for transparent transparent_all tripleclickwords utmpInhibit
1305 visualBell 1343 visualBell
1306 1344
1307=cut 1345=cut
1308 1346
1309sub resource($$;$) { 1347sub resource($$;$) {
1310 my ($self, $name) = (shift, shift); 1348 my ($self, $name) = (shift, shift);
1311 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1349 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1312 &urxvt::term::_resource 1350 goto &urxvt::term::_resource
1313} 1351}
1314 1352
1315=item $value = $term->x_resource ($pattern) 1353=item $value = $term->x_resource ($pattern)
1316 1354
1317Returns the X-Resource for the given pattern, excluding the program or 1355Returns the X-Resource for the given pattern, excluding the program or
1400 1438
1401The methods currently supported on C<urxvt::overlay> objects are: 1439The methods currently supported on C<urxvt::overlay> objects are:
1402 1440
1403=over 4 1441=over 4
1404 1442
1405=item $overlay->set ($x, $y, $text, $rend) 1443=item $overlay->set ($x, $y, $text[, $rend])
1406 1444
1407Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1445Similar 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 1446text in rxvt-unicode's special encoding and an array of rendition values
1409at a specific position inside the overlay. 1447at a specific position inside the overlay.
1448
1449If C<$rend> is missing, then the rendition will not be changed.
1410 1450
1411=item $overlay->hide 1451=item $overlay->hide
1412 1452
1413If visible, hide the overlay, but do not destroy it. 1453If visible, hide the overlay, but do not destroy it.
1414 1454
1624 1664
1625Used after changing terminal contents to display them. 1665Used after changing terminal contents to display them.
1626 1666
1627=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1667=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1628 1668
1629Returns the text of the entire row with number C<$row_number>. Row C<0> 1669Returns 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 1670is 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 1671terminal line. Nothing will be returned if a nonexistent line
1633is requested. 1672is requested.
1634 1673
1635If C<$new_text> is specified, it will replace characters in the current 1674If 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 1675line, 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 1676to replace only parts of a line. The font index in the rendition will
1638automatically be updated. 1677automatically be updated.
1639 1678
1640C<$text> is in a special encoding: tabs and wide characters that use more 1679C<$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) 1680than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642characters. Characters with combining characters and other characters that 1681characters. Characters with combining characters and other characters that
1643do not fit into the normal tetx encoding will be replaced with characters 1682do not fit into the normal text encoding will be replaced with characters
1644in the private use area. 1683in the private use area.
1645 1684
1646You have to obey this encoding when changing text. The advantage is 1685You have to obey this encoding when changing text. The advantage is
1647that C<substr> and similar functions work on screen cells and not on 1686that C<substr> and similar functions work on screen cells and not on
1648characters. 1687characters.
1835 1874
1836=item @atoms = $term->XListProperties ($window) 1875=item @atoms = $term->XListProperties ($window)
1837 1876
1838=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1877=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1839 1878
1840=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1879=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1841 1880
1842=item $term->XDeleteProperty ($window, $property) 1881=item $term->XDeleteProperty ($window, $property)
1843 1882
1844=item $window = $term->DefaultRootWindow 1883=item $window = $term->DefaultRootWindow
1845 1884
1967 my $env = $self->{term}->env; 2006 my $env = $self->{term}->env;
1968 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2007 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1969 delete $env->{LC_ALL}; 2008 delete $env->{LC_ALL};
1970 $env->{LC_CTYPE} = $self->{term}->locale; 2009 $env->{LC_CTYPE} = $self->{term}->locale;
1971 2010
1972 urxvt::term->new ($env, "popup", 2011 my $term = urxvt::term->new (
2012 $env, "popup",
1973 "--perl-lib" => "", "--perl-ext-common" => "", 2013 "--perl-lib" => "", "--perl-ext-common" => "",
1974 "-pty-fd" => -1, "-sl" => 0, 2014 "-pty-fd" => -1, "-sl" => 0,
1975 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2015 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1976 "--transient-for" => $self->{term}->parent, 2016 "--transient-for" => $self->{term}->parent,
1977 "-display" => $self->{term}->display_id, 2017 "-display" => $self->{term}->display_id,
1978 "-pe" => "urxvt-popup") 2018 "-pe" => "urxvt-popup",
1979 or die "unable to create popup window\n"; 2019 ) or die "unable to create popup window\n";
2020
2021 unless (delete $term->{urxvt_popup_init_done}) {
2022 $term->ungrab;
2023 $term->destroy;
2024 die "unable to initialise popup window\n";
2025 }
1980} 2026}
1981 2027
1982sub DESTROY { 2028sub DESTROY {
1983 my ($self) = @_; 2029 my ($self) = @_;
1984 2030

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines