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.163 by ayin, Mon Dec 17 23:52:45 2007 UTC vs.
Revision 1.180 by root, Sat Dec 26 09:42:16 2009 UTC

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
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 = 1; 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}, $arg{interval})
1109 ->cb (sub { 1142 ->cb ($arg{interval} ? $cb : sub {
1110 $_[0]->stop; # need to cancel manually 1143 $_[0]->stop; # need to cancel manually
1111 $cb->(); 1144 $cb->();
1112 }) 1145 })
1113} 1146}
1114 1147
1115sub io { 1148sub io {
1116 my ($class, %arg) = @_; 1149 my ($class, %arg) = @_;
1117 1150
1118 my $cb = $arg{cb}; 1151 my $cb = $arg{cb};
1152 my $fd = fileno $arg{fh};
1153 defined $fd or $fd = $arg{fh};
1119 1154
1120 bless [$arg{fh}, urxvt::iow 1155 bless [$arg{fh}, urxvt::iow
1121 ->new 1156 ->new
1122 ->fd (fileno $arg{fh}) 1157 ->fd ($fd)
1123 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1158 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1124 | ($arg{poll} =~ /w/ ? 2 : 0)) 1159 | ($arg{poll} =~ /w/ ? 2 : 0))
1125 ->start 1160 ->start
1126 ->cb (sub { 1161 ->cb ($cb)
1127 $cb->(($_[1] & 1 ? 'r' : '')
1128 . ($_[1] & 2 ? 'w' : ''));
1129 })],
1130 urxvt::anyevent:: 1162 ], urxvt::anyevent::
1163}
1164
1165sub idle {
1166 my ($class, %arg) = @_;
1167
1168 my $cb = $arg{cb};
1169
1170 urxvt::iw
1171 ->new
1172 ->start
1173 ->cb ($cb)
1174}
1175
1176sub child {
1177 my ($class, %arg) = @_;
1178
1179 my $cb = $arg{cb};
1180
1181 urxvt::pw
1182 ->new
1183 ->start ($arg{pid})
1184 ->cb (sub {
1185 $_[0]->stop; # need to cancel manually
1186 $cb->($_[0]->rpid, $_[0]->rstatus);
1187 })
1131} 1188}
1132 1189
1133sub DESTROY { 1190sub DESTROY {
1134 $_[0][1]->stop; 1191 $_[0][1]->stop;
1135}
1136
1137sub condvar {
1138 bless \my $flag, urxvt::anyevent::
1139}
1140
1141sub broadcast {
1142 ${$_[0]}++;
1143}
1144
1145sub wait {
1146 unless (${$_[0]}) {
1147 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1148 }
1149} 1192}
1150 1193
1151sub one_event { 1194sub one_event {
1152 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1195 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1153} 1196}
1276Here is a likely non-exhaustive list of resource names, not all of which 1319Here is a likely non-exhaustive list of resource names, not all of which
1277are supported in every build, please see the source file F</src/rsinc.h> 1320are supported in every build, please see the source file F</src/rsinc.h>
1278to see the actual list: 1321to see the actual list:
1279 1322
1280 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1323 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1281 borderLess color cursorBlink cursorUnderline cutchars delete_key 1324 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1282 display_name embed ext_bwidth fade font geometry hold iconName 1325 display_name embed ext_bwidth fade font geometry hold iconName
1283 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1326 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1284 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1327 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1285 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1328 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1286 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1329 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1287 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1330 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1288 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1331 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1289 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1332 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1290 secondaryScreen secondaryScroll shade term_name title 1333 secondaryScreen secondaryScroll shade term_name title
1291 transient_for transparent transparent_all tripleclickwords utmpInhibit 1334 transient_for transparent transparent_all tripleclickwords utmpInhibit
1294=cut 1337=cut
1295 1338
1296sub resource($$;$) { 1339sub resource($$;$) {
1297 my ($self, $name) = (shift, shift); 1340 my ($self, $name) = (shift, shift);
1298 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1341 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1299 &urxvt::term::_resource 1342 goto &urxvt::term::_resource
1300} 1343}
1301 1344
1302=item $value = $term->x_resource ($pattern) 1345=item $value = $term->x_resource ($pattern)
1303 1346
1304Returns the X-Resource for the given pattern, excluding the program or 1347Returns the X-Resource for the given pattern, excluding the program or
1329 1372
1330=item ($row, $col) = $term->selection_beg ([$row, $col]) 1373=item ($row, $col) = $term->selection_beg ([$row, $col])
1331 1374
1332=item ($row, $col) = $term->selection_end ([$row, $col]) 1375=item ($row, $col) = $term->selection_end ([$row, $col])
1333 1376
1334Return the current values of the selection mark, begin or end positions, 1377Return the current values of the selection mark, begin or end positions.
1335and optionally set them to new values. 1378
1379When arguments are given, then the selection coordinates are set to
1380C<$row> and C<$col>, and the selection screen is set to the current
1381screen.
1382
1383=item $screen = $term->selection_screen ([$screen])
1384
1385Returns the current selection screen, and then optionally sets it.
1336 1386
1337=item $term->selection_make ($eventtime[, $rectangular]) 1387=item $term->selection_make ($eventtime[, $rectangular])
1338 1388
1339Tries to make a selection as set by C<selection_beg> and 1389Tries to make a selection as set by C<selection_beg> and
1340C<selection_end>. If C<$rectangular> is true (default: false), a 1390C<selection_end>. If C<$rectangular> is true (default: false), a
1387 1437
1388The methods currently supported on C<urxvt::overlay> objects are: 1438The methods currently supported on C<urxvt::overlay> objects are:
1389 1439
1390=over 4 1440=over 4
1391 1441
1392=item $overlay->set ($x, $y, $text, $rend) 1442=item $overlay->set ($x, $y, $text[, $rend])
1393 1443
1394Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1444Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1395text in rxvt-unicode's special encoding and an array of rendition values 1445text in rxvt-unicode's special encoding and an array of rendition values
1396at a specific position inside the overlay. 1446at a specific position inside the overlay.
1447
1448If C<$rend> is missing, then the rendition will not be changed.
1397 1449
1398=item $overlay->hide 1450=item $overlay->hide
1399 1451
1400If visible, hide the overlay, but do not destroy it. 1452If visible, hide the overlay, but do not destroy it.
1401 1453
1611 1663
1612Used after changing terminal contents to display them. 1664Used after changing terminal contents to display them.
1613 1665
1614=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1666=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1615 1667
1616Returns the text of the entire row with number C<$row_number>. Row C<0> 1668Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1617is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1669is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1618terminal line. The scrollback buffer starts at line C<-1> and extends to
1619line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1670terminal line. Nothing will be returned if a nonexistent line
1620is requested. 1671is requested.
1621 1672
1622If C<$new_text> is specified, it will replace characters in the current 1673If C<$new_text> is specified, it will replace characters in the current
1623line, starting at column C<$start_col> (default C<0>), which is useful 1674line, starting at column C<$start_col> (default C<0>), which is useful
1624to replace only parts of a line. The font index in the rendition will 1675to replace only parts of a line. The font index in the rendition will
1822 1873
1823=item @atoms = $term->XListProperties ($window) 1874=item @atoms = $term->XListProperties ($window)
1824 1875
1825=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1876=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1826 1877
1827=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1878=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1828 1879
1829=item $term->XDeleteProperty ($window, $property) 1880=item $term->XDeleteProperty ($window, $property)
1830 1881
1831=item $window = $term->DefaultRootWindow 1882=item $window = $term->DefaultRootWindow
1832 1883
1954 my $env = $self->{term}->env; 2005 my $env = $self->{term}->env;
1955 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2006 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1956 delete $env->{LC_ALL}; 2007 delete $env->{LC_ALL};
1957 $env->{LC_CTYPE} = $self->{term}->locale; 2008 $env->{LC_CTYPE} = $self->{term}->locale;
1958 2009
1959 urxvt::term->new ($env, "popup", 2010 my $term = urxvt::term->new (
2011 $env, "popup",
1960 "--perl-lib" => "", "--perl-ext-common" => "", 2012 "--perl-lib" => "", "--perl-ext-common" => "",
1961 "-pty-fd" => -1, "-sl" => 0, 2013 "-pty-fd" => -1, "-sl" => 0,
1962 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2014 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1963 "--transient-for" => $self->{term}->parent, 2015 "--transient-for" => $self->{term}->parent,
1964 "-display" => $self->{term}->display_id, 2016 "-display" => $self->{term}->display_id,
1965 "-pe" => "urxvt-popup") 2017 "-pe" => "urxvt-popup",
1966 or die "unable to create popup window\n"; 2018 ) or die "unable to create popup window\n";
2019
2020 unless (delete $term->{urxvt_popup_init_done}) {
2021 $term->ungrab;
2022 $term->destroy;
2023 die "unable to initialise popup window\n";
2024 }
1967} 2025}
1968 2026
1969sub DESTROY { 2027sub DESTROY {
1970 my ($self) = @_; 2028 my ($self) = @_;
1971 2029
2002 2060
2003=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2061=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2004 2062
2005Set the callback to be called when the timer triggers. 2063Set the callback to be called when the timer triggers.
2006 2064
2007=item $tstamp = $timer->at
2008
2009Return the time this watcher will fire next.
2010
2011=item $timer = $timer->set ($tstamp) 2065=item $timer = $timer->set ($tstamp[, $interval])
2012 2066
2013Set the time the event is generated to $tstamp. 2067Set the time the event is generated to $tstamp (and optionally specifies a
2068new $interval).
2014 2069
2015=item $timer = $timer->interval ($interval) 2070=item $timer = $timer->interval ($interval)
2016 2071
2017Normally (and when C<$interval> is C<0>), the timer will automatically 2072By default (and when C<$interval> is C<0>), the timer will automatically
2018stop after it has fired once. If C<$interval> is non-zero, then the timer 2073stop after it has fired once. If C<$interval> is non-zero, then the timer
2019is automatically rescheduled at the given intervals. 2074is automatically rescheduled at the given intervals.
2020 2075
2021=item $timer = $timer->start 2076=item $timer = $timer->start
2022 2077
2023Start the timer. 2078Start the timer.
2024 2079
2025=item $timer = $timer->start ($tstamp) 2080=item $timer = $timer->start ($tstamp[, $interval])
2026 2081
2027Set the event trigger time to C<$tstamp> and start the timer. 2082Set the event trigger time to C<$tstamp> and start the timer. Optionally
2083also replaces the interval.
2028 2084
2029=item $timer = $timer->after ($delay) 2085=item $timer = $timer->after ($delay[, $interval])
2030 2086
2031Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2087Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2032 2088
2033=item $timer = $timer->stop 2089=item $timer = $timer->stop
2034 2090

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines