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.173 by root, Wed Nov 5 12:45:36 2008 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC

… …
341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343 343
344=item selection-pastebin 344=item selection-pastebin
345 345
346This is a little rarely useful extension that Uploads the selection as 346This is a little rarely useful extension that uploads the selection as
347textfile to a remote site (or does other things). (The implementation is 347textfile to a remote site (or does other things). (The implementation is
348not currently secure for use in a multiuser environment as it writes to 348not currently secure for use in a multiuser environment as it writes to
349F</tmp> directly.). 349F</tmp> directly.).
350 350
351It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
… …
370 370
371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372 372
373I<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
374the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of wether xrdb is used to parse the resource file 375which works regardless of whether xrdb is used to parse the resource file
376or not. 376or not.
377
378=item macosx-clipboard and macosx-clipboard-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<macosx-clipboard> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc.
377 391
378=item example-refresh-hooks 392=item example-refresh-hooks
379 393
380Displays 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
381window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
382overlays or changes. 396overlays or changes.
397
398=item confirm-paste
399
400Displays a confirmation dialog when a paste containing at least a full
401line is detected.
383 402
384=back 403=back
385 404
386=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
387 406
… …
403 422
404=over 4 423=over 4
405 424
406=item $text 425=item $text
407 426
408Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-unicode's special way of encoding text, where one "unicode" character
409always represents one screen cell. See L<ROW_t> for a discussion of this format. 428always represents one screen cell. See L<ROW_t> for a discussion of this format.
410 429
411=item $string 430=item $string
412 431
413A perl text string, with an emphasis on I<text>. It can store all unicode 432A perl text string, with an emphasis on I<text>. It can store all unicode
… …
596=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
597 616
598Called whenever some data is written to the tty/pty and can be used to 617Called whenever some data is written to the tty/pty and can be used to
599suppress or filter tty input. 618suppress or filter tty input.
600 619
620=item on_tt_paste $term, $octets
621
622Called whenever text is about to be pasted, with the text as argument. You
623can filter/change and paste the text yourself by returning a true value
624and calling C<< $term->tt_paste >> yourself. C<$octets> is
625locale-encoded.
626
601=item on_line_update $term, $row 627=item on_line_update $term, $row
602 628
603Called whenever a line was updated or changed. Can be used to filter 629Called whenever a line was updated or changed. Can be used to filter
604screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
605that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
… …
630resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
631 657
632The event is simply the action string. This interface is assumed to change 658The event is simply the action string. This interface is assumed to change
633slightly in the future. 659slightly in the future.
634 660
635=item on_resize_all_windows $tern, $new_width, $new_height 661=item on_resize_all_windows $term, $new_width, $new_height
636 662
637Called just after the new window size has been calculated, but before 663Called just after the new window size has been calculated, but before
638windows are actually being resized or hints are being set. If this hook 664windows are actually being resized or hints are being set. If this hook
639returns TRUE, setting of the window hints is being skipped. 665returns TRUE, setting of the window hints is being skipped.
640 666
… …
674 700
675=item on_map_notify $term, $event 701=item on_map_notify $term, $event
676 702
677=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
678 704
679Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
680the hook returns true, then the even will be ignored by rxvt-unicode. 706the hook returns true, then the event will be ignored by rxvt-unicode.
681 707
682The event is a hash with most values as named by Xlib (see the XEvent 708The event is a hash with most values as named by Xlib (see the XEvent
683manpage), with the additional members C<row> and C<col>, which are the 709manpage), with the additional members C<row> and C<col>, which are the
684(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
685 711
… …
694 720
695=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
696 722
697Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
698format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 724format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
725
726=item on_bell $term
727
728Called on receipt of a bell character.
699 729
700=back 730=back
701 731
702=cut 732=cut
703 733
… …
841 871
842=item $rend = urxvt::OVERLAY_RSTYLE 872=item $rend = urxvt::OVERLAY_RSTYLE
843 873
844Return the rendition mask used for overlays by default. 874Return the rendition mask used for overlays by default.
845 875
846=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 876=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
877urxvt::RS_RVid, urxvt::RS_Uline
847 878
848Return the bit that enabled bold, italic, blink, reverse-video and 879Return the bit that enabled bold, italic, blink, reverse-video and
849underline, respectively. To enable such a style, just logically OR it into 880underline, respectively. To enable such a style, just logically OR it into
850the bitset. 881the bitset.
851 882
… …
1110is that you cannot use blocking APIs, but the non-blocking variant should 1141is that you cannot use blocking APIs, but the non-blocking variant should
1111work. 1142work.
1112 1143
1113=cut 1144=cut
1114 1145
1115our $VERSION = '3.4'; 1146our $VERSION = '5.23';
1116 1147
1117$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1148$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1118push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1149push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1119 1150
1120sub timer { 1151sub timer {
… …
1122 1153
1123 my $cb = $arg{cb}; 1154 my $cb = $arg{cb};
1124 1155
1125 urxvt::timer 1156 urxvt::timer
1126 ->new 1157 ->new
1127 ->start (urxvt::NOW + $arg{after}) 1158 ->after ($arg{after}, $arg{interval})
1128 ->cb (sub { 1159 ->cb ($arg{interval} ? $cb : sub {
1129 $_[0]->stop; # need to cancel manually 1160 $_[0]->stop; # need to cancel manually
1130 $cb->(); 1161 $cb->();
1131 }) 1162 })
1132} 1163}
1133 1164
1134sub io { 1165sub io {
1135 my ($class, %arg) = @_; 1166 my ($class, %arg) = @_;
1136 1167
1137 my $cb = $arg{cb}; 1168 my $cb = $arg{cb};
1169 my $fd = fileno $arg{fh};
1170 defined $fd or $fd = $arg{fh};
1138 1171
1139 bless [$arg{fh}, urxvt::iow 1172 bless [$arg{fh}, urxvt::iow
1140 ->new 1173 ->new
1141 ->fd (fileno $arg{fh}) 1174 ->fd ($fd)
1142 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1175 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1143 | ($arg{poll} =~ /w/ ? 2 : 0)) 1176 | ($arg{poll} =~ /w/ ? 2 : 0))
1144 ->start 1177 ->start
1145 ->cb (sub { 1178 ->cb ($cb)
1146 $cb->(($_[1] & 1 ? 'r' : '')
1147 . ($_[1] & 2 ? 'w' : ''));
1148 })],
1149 urxvt::anyevent:: 1179 ], urxvt::anyevent::
1180}
1181
1182sub idle {
1183 my ($class, %arg) = @_;
1184
1185 my $cb = $arg{cb};
1186
1187 urxvt::iw
1188 ->new
1189 ->start
1190 ->cb ($cb)
1191}
1192
1193sub child {
1194 my ($class, %arg) = @_;
1195
1196 my $cb = $arg{cb};
1197
1198 urxvt::pw
1199 ->new
1200 ->start ($arg{pid})
1201 ->cb (sub {
1202 $_[0]->stop; # need to cancel manually
1203 $cb->($_[0]->rpid, $_[0]->rstatus);
1204 })
1150} 1205}
1151 1206
1152sub DESTROY { 1207sub DESTROY {
1153 $_[0][1]->stop; 1208 $_[0][1]->stop;
1154} 1209}
… …
1284 1339
1285 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1340 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1286 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1341 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1287 display_name embed ext_bwidth fade font geometry hold iconName 1342 display_name embed ext_bwidth fade font geometry hold iconName
1288 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1343 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1289 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1344 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1290 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1345 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1291 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1346 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1292 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1347 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1293 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1348 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1294 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1349 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1295 secondaryScreen secondaryScroll shade term_name title 1350 secondaryScreen secondaryScroll shade term_name title
1296 transient_for transparent transparent_all tripleclickwords utmpInhibit 1351 transient_for transparent transparent_all tripleclickwords utmpInhibit
… …
1334 1389
1335=item ($row, $col) = $term->selection_beg ([$row, $col]) 1390=item ($row, $col) = $term->selection_beg ([$row, $col])
1336 1391
1337=item ($row, $col) = $term->selection_end ([$row, $col]) 1392=item ($row, $col) = $term->selection_end ([$row, $col])
1338 1393
1339Return the current values of the selection mark, begin or end positions, 1394Return the current values of the selection mark, begin or end positions.
1340and optionally set them to new values. 1395
1396When arguments are given, then the selection coordinates are set to
1397C<$row> and C<$col>, and the selection screen is set to the current
1398screen.
1399
1400=item $screen = $term->selection_screen ([$screen])
1401
1402Returns the current selection screen, and then optionally sets it.
1341 1403
1342=item $term->selection_make ($eventtime[, $rectangular]) 1404=item $term->selection_make ($eventtime[, $rectangular])
1343 1405
1344Tries to make a selection as set by C<selection_beg> and 1406Tries to make a selection as set by C<selection_beg> and
1345C<selection_end>. If C<$rectangular> is true (default: false), a 1407C<selection_end>. If C<$rectangular> is true (default: false), a
1346rectangular selection will be made. This is the prefered function to make 1408rectangular selection will be made. This is the preferred function to make
1347a selection. 1409a selection.
1348 1410
1349=item $success = $term->selection_grab ($eventtime) 1411=item $success = $term->selection_grab ($eventtime[, $clipboard])
1350 1412
1351Try to request the primary selection text from the server (for example, as 1413Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1414true) selection from the server. The corresponding text can be set
1352set by the next method). No visual feedback will be given. This function 1415with the next method. No visual feedback will be given. This function
1353is mostly useful from within C<on_sel_grab> hooks. 1416is mostly useful from within C<on_sel_grab> hooks.
1354 1417
1355=item $oldtext = $term->selection ([$newtext]) 1418=item $oldtext = $term->selection ([$newtext, $clipboard])
1356 1419
1357Return the current selection text and optionally replace it by C<$newtext>. 1420Return the current selection (clipboard if C<$clipboard> is true) text
1421and optionally replace it by C<$newtext>.
1422
1423=item $term->selection_clear ([$clipboard])
1424
1425Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1358 1426
1359=item $term->overlay_simple ($x, $y, $text) 1427=item $term->overlay_simple ($x, $y, $text)
1360 1428
1361Create a simple multi-line overlay box. See the next method for details. 1429Create a simple multi-line overlay box. See the next method for details.
1362 1430
… …
1490locale-specific encoding of the terminal and can contain command sequences 1558locale-specific encoding of the terminal and can contain command sequences
1491(escape codes) that will be interpreted. 1559(escape codes) that will be interpreted.
1492 1560
1493=item $term->tt_write ($octets) 1561=item $term->tt_write ($octets)
1494 1562
1495Write the octets given in C<$data> to the tty (i.e. as program input). To 1563Write the octets given in C<$octets> to the tty (i.e. as program input). To
1496pass characters instead of octets, you should convert your strings first 1564pass characters instead of octets, you should convert your strings first
1497to the locale-specific encoding using C<< $term->locale_encode >>. 1565to the locale-specific encoding using C<< $term->locale_encode >>.
1566
1567=item $term->tt_paste ($octets)
1568
1569Write the octets given in C<$octets> to the tty as a paste, converting NL to
1570CR and bracketing the data with control sequences if bracketed paste mode
1571is set.
1498 1572
1499=item $old_events = $term->pty_ev_events ([$new_events]) 1573=item $old_events = $term->pty_ev_events ([$new_events])
1500 1574
1501Replaces the event mask of the pty watcher by the given event mask. Can 1575Replaces the event mask of the pty watcher by the given event mask. Can
1502be used to suppress input and output handling to the pty/tty. See the 1576be used to suppress input and output handling to the pty/tty. See the
… …
1816Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1890Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1817recent grab. 1891recent grab.
1818 1892
1819=item $term->ungrab 1893=item $term->ungrab
1820 1894
1821Calls XUngrab for the most recent grab. Is called automatically on 1895Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1822evaluation errors, as it is better to lose the grab in the error case as 1896evaluation errors, as it is better to lose the grab in the error case as
1823the session. 1897the session.
1824 1898
1825=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1899=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1826 1900
… …
1848 1922
1849=item $term->XChangeInput ($window, $add_events[, $del_events]) 1923=item $term->XChangeInput ($window, $add_events[, $del_events])
1850 1924
1851Various X or X-related functions. The C<$term> object only serves as 1925Various X or X-related functions. The C<$term> object only serves as
1852the source of the display, otherwise those functions map more-or-less 1926the source of the display, otherwise those functions map more-or-less
1853directory onto the X functions of the same name. 1927directly onto the X functions of the same name.
1854 1928
1855=back 1929=back
1856 1930
1857=cut 1931=cut
1858 1932
… …
2015 2089
2016=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2090=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017 2091
2018Set the callback to be called when the timer triggers. 2092Set the callback to be called when the timer triggers.
2019 2093
2020=item $tstamp = $timer->at
2021
2022Return the time this watcher will fire next.
2023
2024=item $timer = $timer->set ($tstamp) 2094=item $timer = $timer->set ($tstamp[, $interval])
2025 2095
2026Set the time the event is generated to $tstamp. 2096Set the time the event is generated to $tstamp (and optionally specifies a
2097new $interval).
2027 2098
2028=item $timer = $timer->interval ($interval) 2099=item $timer = $timer->interval ($interval)
2029 2100
2030Normally (and when C<$interval> is C<0>), the timer will automatically 2101By default (and when C<$interval> is C<0>), the timer will automatically
2031stop after it has fired once. If C<$interval> is non-zero, then the timer 2102stop after it has fired once. If C<$interval> is non-zero, then the timer
2032is automatically rescheduled at the given intervals. 2103is automatically rescheduled at the given intervals.
2033 2104
2034=item $timer = $timer->start 2105=item $timer = $timer->start
2035 2106
2036Start the timer. 2107Start the timer.
2037 2108
2038=item $timer = $timer->start ($tstamp) 2109=item $timer = $timer->start ($tstamp[, $interval])
2039 2110
2040Set the event trigger time to C<$tstamp> and start the timer. 2111Set the event trigger time to C<$tstamp> and start the timer. Optionally
2112also replaces the interval.
2041 2113
2042=item $timer = $timer->after ($delay) 2114=item $timer = $timer->after ($delay[, $interval])
2043 2115
2044Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2116Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045 2117
2046=item $timer = $timer->stop 2118=item $timer = $timer->stop
2047 2119

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines