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.170 by root, Tue Sep 23 07:03:13 2008 UTC vs.
Revision 1.178 by root, Sat Dec 26 09:02:42 2009 UTC

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 overlay-osc
309
310This extension implements some OSC commands to display timed popups on the
311screen - useful for status displays from within scripts. You have to read
312the sources for more info.
313
308=item block-graphics-to-ascii 314=item block-graphics-to-ascii
309 315
310A 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
311by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
312similar-looking ascii character. 318similar-looking ascii character.
366 372
367I<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
368the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
369which 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
370or 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.
371 391
372=item example-refresh-hooks 392=item example-refresh-hooks
373 393
374Displays 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
375window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
541 561
542It 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,
543$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
544number of lines that will be in the scrollback buffer. 564number of lines that will be in the scrollback buffer.
545 565
546=item on_osc_seq $term, $op, $args 566=item on_osc_seq $term, $op, $args, $resp
547 567
548Called 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
549behaviour. 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
550suppresses execution of the request completely. Make sure you don't get 570suppresses execution of the request completely. Make sure you don't get
551confused by recursive invocations when you output an osc sequence within 571confused by recursive invocations when you output an OSC sequence within
552this callback. 572this callback.
553 573
554C<on_osc_seq_perl> should be used for new behaviour. 574C<on_osc_seq_perl> should be used for new behaviour.
555 575
556=item on_osc_seq_perl $term, $string 576=item on_osc_seq_perl $term, $args, $resp
557 577
558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 578Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559operating system command) is processed. Cursor position and other state 579operating system command) is processed. Cursor position and other state
560information is up-to-date when this happens. For interoperability, the 580information is up-to-date when this happens. For interoperability, the
561string should start with the extension name and a colon, to distinguish 581string should start with the extension name (sans -osc) and a semicolon,
562it from commands for other extensions, and this might be enforced in the 582to distinguish it from commands for other extensions, and this might be
563future. 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 }
564 594
565Be 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,
566as 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
567other 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.
568 601
569=item on_add_lines $term, $string 602=item on_add_lines $term, $string
570 603
571Called 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
572can 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
593later 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
594you cannot just toggle rendition bits, but only set them. 627you cannot just toggle rendition bits, but only set them.
595 628
596=item on_refresh_begin $term 629=item on_refresh_begin $term
597 630
598Called just before the screen gets redrawn. Can be used for overlay 631Called just before the screen gets redrawn. Can be used for overlay or
599or similar effects by modify terminal contents in refresh_begin, and 632similar effects by modifying the terminal contents in refresh_begin, and
600restoring them in refresh_end. The built-in overlay and selection display 633restoring them in refresh_end. The built-in overlay and selection display
601code is run after this hook, and takes precedence. 634code is run after this hook, and takes precedence.
602 635
603=item on_refresh_end $term 636=item on_refresh_end $term
604 637
1091is 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
1092work. 1125work.
1093 1126
1094=cut 1127=cut
1095 1128
1096our $VERSION = '3.4'; 1129our $VERSION = '5.23';
1097 1130
1098$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1131$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1132push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100 1133
1101sub timer { 1134sub timer {
1103 1136
1104 my $cb = $arg{cb}; 1137 my $cb = $arg{cb};
1105 1138
1106 urxvt::timer 1139 urxvt::timer
1107 ->new 1140 ->new
1108 ->start (urxvt::NOW + $arg{after}) 1141 ->after ($arg{after})
1109 ->cb (sub { 1142 ->interval ($arg{interval})
1143 ->start
1144 ->cb ($argv{interval} ? $cb : sub {
1110 $_[0]->stop; # need to cancel manually 1145 $_[0]->stop; # need to cancel manually
1111 $cb->(); 1146 $cb->();
1112 }) 1147 })
1113} 1148}
1114 1149
1115sub io { 1150sub io {
1116 my ($class, %arg) = @_; 1151 my ($class, %arg) = @_;
1117 1152
1118 my $cb = $arg{cb}; 1153 my $cb = $arg{cb};
1154 my $fd = fileno $arg{fh};
1155 defined $fd or $fd = $arg{fh};
1119 1156
1120 bless [$arg{fh}, urxvt::iow 1157 bless [$arg{fh}, urxvt::iow
1121 ->new 1158 ->new
1122 ->fd (fileno $arg{fh}) 1159 ->fd ($fd)
1123 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1160 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1124 | ($arg{poll} =~ /w/ ? 2 : 0)) 1161 | ($arg{poll} =~ /w/ ? 2 : 0))
1125 ->start 1162 ->start
1126 ->cb (sub { 1163 ->cb ($cb)
1127 $cb->(($_[1] & 1 ? 'r' : '')
1128 . ($_[1] & 2 ? 'w' : ''));
1129 })],
1130 urxvt::anyevent:: 1164 ], urxvt::anyevent::
1165}
1166
1167sub idle {
1168 my ($class, %arg) = @_;
1169
1170 my $cb = $arg{cb};
1171
1172 urxvt::iw
1173 ->new
1174 ->start
1175 ->cb ($cb)
1176}
1177
1178sub child {
1179 my ($class, %arg) = @_;
1180
1181 my $cb = $arg{cb};
1182
1183 urxvt::pw
1184 ->new
1185 ->start ($arg{pid})
1186 ->cb (sub {
1187 $_[0]->stop; # need to cancel manually
1188 $cb->($_[0]->rpid, $_[0]->rstatus);
1189 })
1131} 1190}
1132 1191
1133sub DESTROY { 1192sub DESTROY {
1134 $_[0][1]->stop; 1193 $_[0][1]->stop;
1135} 1194}
1265 1324
1266 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1325 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1267 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1326 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1268 display_name embed ext_bwidth fade font geometry hold iconName 1327 display_name embed ext_bwidth fade font geometry hold iconName
1269 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1328 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1270 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1329 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1271 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1330 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1272 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1331 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1273 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1332 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1274 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1333 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1275 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1334 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1276 secondaryScreen secondaryScroll shade term_name title 1335 secondaryScreen secondaryScroll shade term_name title
1277 transient_for transparent transparent_all tripleclickwords utmpInhibit 1336 transient_for transparent transparent_all tripleclickwords utmpInhibit
1373 1432
1374The methods currently supported on C<urxvt::overlay> objects are: 1433The methods currently supported on C<urxvt::overlay> objects are:
1375 1434
1376=over 4 1435=over 4
1377 1436
1378=item $overlay->set ($x, $y, $text, $rend) 1437=item $overlay->set ($x, $y, $text[, $rend])
1379 1438
1380Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1439Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1381text in rxvt-unicode's special encoding and an array of rendition values 1440text in rxvt-unicode's special encoding and an array of rendition values
1382at a specific position inside the overlay. 1441at a specific position inside the overlay.
1442
1443If C<$rend> is missing, then the rendition will not be changed.
1383 1444
1384=item $overlay->hide 1445=item $overlay->hide
1385 1446
1386If visible, hide the overlay, but do not destroy it. 1447If visible, hide the overlay, but do not destroy it.
1387 1448

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines