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.187 by sf-exg, Sat Jul 24 10:20:26 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
403 417
404=over 4 418=over 4
405 419
406=item $text 420=item $text
407 421
408Rxvt-unicodes special way of encoding text, where one "unicode" character 422Rxvt-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. 423always represents one screen cell. See L<ROW_t> for a discussion of this format.
410 424
411=item $string 425=item $string
412 426
413A perl text string, with an emphasis on I<text>. It can store all unicode 427A perl text string, with an emphasis on I<text>. It can store all unicode
596=item on_tt_write $term, $octets 610=item on_tt_write $term, $octets
597 611
598Called whenever some data is written to the tty/pty and can be used to 612Called whenever some data is written to the tty/pty and can be used to
599suppress or filter tty input. 613suppress or filter tty input.
600 614
615=item on_tt_paste $term, $octets
616
617Called whenever text is about to be pasted, with the text as argument. You
618can filter/change and paste the text yourself by returning a true value
619and calling C<< $term->tt_paste >> yourself. C<$octets> is
620locale-encoded.
621
601=item on_line_update $term, $row 622=item on_line_update $term, $row
602 623
603Called whenever a line was updated or changed. Can be used to filter 624Called whenever a line was updated or changed. Can be used to filter
604screen output (e.g. underline urls or other useless stuff). Only lines 625screen output (e.g. underline urls or other useless stuff). Only lines
605that are being shown will be filtered, and, due to performance reasons, 626that are being shown will be filtered, and, due to performance reasons,
630resource in the @@RXVT_NAME@@(1) manpage). 651resource in the @@RXVT_NAME@@(1) manpage).
631 652
632The event is simply the action string. This interface is assumed to change 653The event is simply the action string. This interface is assumed to change
633slightly in the future. 654slightly in the future.
634 655
635=item on_resize_all_windows $tern, $new_width, $new_height 656=item on_resize_all_windows $term, $new_width, $new_height
636 657
637Called just after the new window size has been calculated, but before 658Called just after the new window size has been calculated, but before
638windows are actually being resized or hints are being set. If this hook 659windows are actually being resized or hints are being set. If this hook
639returns TRUE, setting of the window hints is being skipped. 660returns TRUE, setting of the window hints is being skipped.
640 661
674 695
675=item on_map_notify $term, $event 696=item on_map_notify $term, $event
676 697
677=item on_unmap_notify $term, $event 698=item on_unmap_notify $term, $event
678 699
679Called whenever the corresponding X event is received for the terminal If 700Called whenever the corresponding X event is received for the terminal. If
680the hook returns true, then the even will be ignored by rxvt-unicode. 701the hook returns true, then the event will be ignored by rxvt-unicode.
681 702
682The event is a hash with most values as named by Xlib (see the XEvent 703The 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 704manpage), with the additional members C<row> and C<col>, which are the
684(real, not screen-based) row and column under the mouse cursor. 705(real, not screen-based) row and column under the mouse cursor.
685 706
694 715
695=item on_wm_delete_window $term, $event 716=item on_wm_delete_window $term, $event
696 717
697Called when various types of ClientMessage events are received (all with 718Called when various types of ClientMessage events are received (all with
698format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 719format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
720
721=item on_bell $term
722
723Called on receipt of a bell character.
699 724
700=back 725=back
701 726
702=cut 727=cut
703 728
1110is that you cannot use blocking APIs, but the non-blocking variant should 1135is that you cannot use blocking APIs, but the non-blocking variant should
1111work. 1136work.
1112 1137
1113=cut 1138=cut
1114 1139
1115our $VERSION = '3.4'; 1140our $VERSION = '5.23';
1116 1141
1117$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1142$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1118push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1143push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1119 1144
1120sub timer { 1145sub timer {
1122 1147
1123 my $cb = $arg{cb}; 1148 my $cb = $arg{cb};
1124 1149
1125 urxvt::timer 1150 urxvt::timer
1126 ->new 1151 ->new
1127 ->start (urxvt::NOW + $arg{after}) 1152 ->after ($arg{after}, $arg{interval})
1128 ->cb (sub { 1153 ->cb ($arg{interval} ? $cb : sub {
1129 $_[0]->stop; # need to cancel manually 1154 $_[0]->stop; # need to cancel manually
1130 $cb->(); 1155 $cb->();
1131 }) 1156 })
1132} 1157}
1133 1158
1134sub io { 1159sub io {
1135 my ($class, %arg) = @_; 1160 my ($class, %arg) = @_;
1136 1161
1137 my $cb = $arg{cb}; 1162 my $cb = $arg{cb};
1163 my $fd = fileno $arg{fh};
1164 defined $fd or $fd = $arg{fh};
1138 1165
1139 bless [$arg{fh}, urxvt::iow 1166 bless [$arg{fh}, urxvt::iow
1140 ->new 1167 ->new
1141 ->fd (fileno $arg{fh}) 1168 ->fd ($fd)
1142 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1169 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1143 | ($arg{poll} =~ /w/ ? 2 : 0)) 1170 | ($arg{poll} =~ /w/ ? 2 : 0))
1144 ->start 1171 ->start
1145 ->cb (sub { 1172 ->cb ($cb)
1146 $cb->(($_[1] & 1 ? 'r' : '')
1147 . ($_[1] & 2 ? 'w' : ''));
1148 })],
1149 urxvt::anyevent:: 1173 ], urxvt::anyevent::
1174}
1175
1176sub idle {
1177 my ($class, %arg) = @_;
1178
1179 my $cb = $arg{cb};
1180
1181 urxvt::iw
1182 ->new
1183 ->start
1184 ->cb ($cb)
1185}
1186
1187sub child {
1188 my ($class, %arg) = @_;
1189
1190 my $cb = $arg{cb};
1191
1192 urxvt::pw
1193 ->new
1194 ->start ($arg{pid})
1195 ->cb (sub {
1196 $_[0]->stop; # need to cancel manually
1197 $cb->($_[0]->rpid, $_[0]->rstatus);
1198 })
1150} 1199}
1151 1200
1152sub DESTROY { 1201sub DESTROY {
1153 $_[0][1]->stop; 1202 $_[0][1]->stop;
1154} 1203}
1284 1333
1285 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1334 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1286 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1335 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1287 display_name embed ext_bwidth fade font geometry hold iconName 1336 display_name embed ext_bwidth fade font geometry hold iconName
1288 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1337 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1289 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1338 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1290 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1339 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1291 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1340 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1292 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1341 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1293 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1342 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1294 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1343 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1295 secondaryScreen secondaryScroll shade term_name title 1344 secondaryScreen secondaryScroll shade term_name title
1296 transient_for transparent transparent_all tripleclickwords utmpInhibit 1345 transient_for transparent transparent_all tripleclickwords utmpInhibit
1334 1383
1335=item ($row, $col) = $term->selection_beg ([$row, $col]) 1384=item ($row, $col) = $term->selection_beg ([$row, $col])
1336 1385
1337=item ($row, $col) = $term->selection_end ([$row, $col]) 1386=item ($row, $col) = $term->selection_end ([$row, $col])
1338 1387
1339Return the current values of the selection mark, begin or end positions, 1388Return the current values of the selection mark, begin or end positions.
1340and optionally set them to new values. 1389
1390When arguments are given, then the selection coordinates are set to
1391C<$row> and C<$col>, and the selection screen is set to the current
1392screen.
1393
1394=item $screen = $term->selection_screen ([$screen])
1395
1396Returns the current selection screen, and then optionally sets it.
1341 1397
1342=item $term->selection_make ($eventtime[, $rectangular]) 1398=item $term->selection_make ($eventtime[, $rectangular])
1343 1399
1344Tries to make a selection as set by C<selection_beg> and 1400Tries to make a selection as set by C<selection_beg> and
1345C<selection_end>. If C<$rectangular> is true (default: false), a 1401C<selection_end>. If C<$rectangular> is true (default: false), a
1346rectangular selection will be made. This is the prefered function to make 1402rectangular selection will be made. This is the preferred function to make
1347a selection. 1403a selection.
1348 1404
1349=item $success = $term->selection_grab ($eventtime) 1405=item $success = $term->selection_grab ($eventtime[, $clipboard])
1350 1406
1351Try to request the primary selection text from the server (for example, as 1407Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1408true) selection from the server. The corresponding text can be set
1352set by the next method). No visual feedback will be given. This function 1409with the next method. No visual feedback will be given. This function
1353is mostly useful from within C<on_sel_grab> hooks. 1410is mostly useful from within C<on_sel_grab> hooks.
1354 1411
1355=item $oldtext = $term->selection ([$newtext]) 1412=item $oldtext = $term->selection ([$newtext, $clipboard])
1356 1413
1357Return the current selection text and optionally replace it by C<$newtext>. 1414Return the current selection (clipboard if C<$clipboard> is true) text
1415and optionally replace it by C<$newtext>.
1416
1417=item $term->selection_clear ([$clipboard])
1418
1419Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1358 1420
1359=item $term->overlay_simple ($x, $y, $text) 1421=item $term->overlay_simple ($x, $y, $text)
1360 1422
1361Create a simple multi-line overlay box. See the next method for details. 1423Create a simple multi-line overlay box. See the next method for details.
1362 1424
1490locale-specific encoding of the terminal and can contain command sequences 1552locale-specific encoding of the terminal and can contain command sequences
1491(escape codes) that will be interpreted. 1553(escape codes) that will be interpreted.
1492 1554
1493=item $term->tt_write ($octets) 1555=item $term->tt_write ($octets)
1494 1556
1495Write the octets given in C<$data> to the tty (i.e. as program input). To 1557Write 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 1558pass characters instead of octets, you should convert your strings first
1497to the locale-specific encoding using C<< $term->locale_encode >>. 1559to the locale-specific encoding using C<< $term->locale_encode >>.
1560
1561=item $term->tt_paste ($octets)
1562
1563Write the octets given in C<$octets> to the tty as a paste, converting NL to
1564CR and bracketing the data with control sequences if bracketed paste mode
1565is set.
1498 1566
1499=item $old_events = $term->pty_ev_events ([$new_events]) 1567=item $old_events = $term->pty_ev_events ([$new_events])
1500 1568
1501Replaces the event mask of the pty watcher by the given event mask. Can 1569Replaces 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 1570be used to suppress input and output handling to the pty/tty. See the
1816Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1884Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1817recent grab. 1885recent grab.
1818 1886
1819=item $term->ungrab 1887=item $term->ungrab
1820 1888
1821Calls XUngrab for the most recent grab. Is called automatically on 1889Calls 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 1890evaluation errors, as it is better to lose the grab in the error case as
1823the session. 1891the session.
1824 1892
1825=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1893=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1826 1894
1848 1916
1849=item $term->XChangeInput ($window, $add_events[, $del_events]) 1917=item $term->XChangeInput ($window, $add_events[, $del_events])
1850 1918
1851Various X or X-related functions. The C<$term> object only serves as 1919Various X or X-related functions. The C<$term> object only serves as
1852the source of the display, otherwise those functions map more-or-less 1920the source of the display, otherwise those functions map more-or-less
1853directory onto the X functions of the same name. 1921directly onto the X functions of the same name.
1854 1922
1855=back 1923=back
1856 1924
1857=cut 1925=cut
1858 1926
2015 2083
2016=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2084=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017 2085
2018Set the callback to be called when the timer triggers. 2086Set the callback to be called when the timer triggers.
2019 2087
2020=item $tstamp = $timer->at
2021
2022Return the time this watcher will fire next.
2023
2024=item $timer = $timer->set ($tstamp) 2088=item $timer = $timer->set ($tstamp[, $interval])
2025 2089
2026Set the time the event is generated to $tstamp. 2090Set the time the event is generated to $tstamp (and optionally specifies a
2091new $interval).
2027 2092
2028=item $timer = $timer->interval ($interval) 2093=item $timer = $timer->interval ($interval)
2029 2094
2030Normally (and when C<$interval> is C<0>), the timer will automatically 2095By 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 2096stop after it has fired once. If C<$interval> is non-zero, then the timer
2032is automatically rescheduled at the given intervals. 2097is automatically rescheduled at the given intervals.
2033 2098
2034=item $timer = $timer->start 2099=item $timer = $timer->start
2035 2100
2036Start the timer. 2101Start the timer.
2037 2102
2038=item $timer = $timer->start ($tstamp) 2103=item $timer = $timer->start ($tstamp[, $interval])
2039 2104
2040Set the event trigger time to C<$tstamp> and start the timer. 2105Set the event trigger time to C<$tstamp> and start the timer. Optionally
2106also replaces the interval.
2041 2107
2042=item $timer = $timer->after ($delay) 2108=item $timer = $timer->after ($delay[, $interval])
2043 2109
2044Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2110Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045 2111
2046=item $timer = $timer->stop 2112=item $timer = $timer->stop
2047 2113

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines