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.116 by root, Fri Jan 20 16:18:07 2006 UTC vs.
Revision 1.128 by root, Wed Jan 25 00:57:57 2006 UTC

67the match. For example, the followign adds a regex that matches everything 67the match. For example, the followign adds a regex that matches everything
68between two vertical bars: 68between two vertical bars:
69 69
70 URxvt.selection.pattern-0: \\|([^|]+)\\| 70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71 71
72Another example: Programs I use often output "absolute path: " at the
73beginning of a line when they process multiple files. The following
74pattern matches the filename (note, there is a single space at the very
75end):
76
77 URxvt.selection.pattern-0: ^(/[^:]+):\
78
72You can look at the source of the selection extension to see more 79You can look at the source of the selection extension to see more
73interesting uses, such as parsing a line from beginning to end. 80interesting uses, such as parsing a line from beginning to end.
74 81
75This extension also offers following bindable keyboard commands: 82This extension also offers following bindable keyboard commands:
76 83
91 98
92=item selection-popup (enabled by default) 99=item selection-popup (enabled by default)
93 100
94Binds a popup menu to Ctrl-Button3 that lets you convert the selection 101Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95text into various other formats/action (such as uri unescaping, perl 102text into various other formats/action (such as uri unescaping, perl
96evalution, web-browser starting etc.), depending on content. 103evaluation, web-browser starting etc.), depending on content.
97 104
98Other extensions can extend this popup menu by pushing a code reference 105Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 106onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed. 107popup is displayed.
101 108
127bottom. C<Escape> leaves search mode and returns to the point where search 134bottom. C<Escape> leaves search mode and returns to the point where search
128was started, while C<Enter> or C<Return> stay at the current position and 135was started, while C<Enter> or C<Return> stay at the current position and
129additionally stores the first match in the current line into the primary 136additionally stores the first match in the current line into the primary
130selection. 137selection.
131 138
139=item readline (enabled by default)
140
141A support package that tries to make editing with readline easier. At the
142moment, it reacts to clicking with the left mouse button by trying to
143move the text cursor to this position. It does so by generating as many
144cursor-left or cursor-right keypresses as required (the this only works
145for programs that correctly support wide characters).
146
147To avoid too many false positives, this is only done when:
148
149=over 4
150
151=item - the tty is in ICANON state.
152
153=item - the text cursor is visible.
154
155=item - the primary screen is currently being displayed.
156
157=item - the mouse is on the same (multi-row-) line as the text cursor.
158
159=back
160
161The normal selection mechanism isn't disabled, so quick successive clicks
162might interfere with selection creation in harmless ways.
163
132=item selection-autotransform 164=item selection-autotransform
133 165
134This selection allows you to do automatic transforms on a selection 166This selection allows you to do automatic transforms on a selection
135whenever a selection is made. 167whenever a selection is made.
136 168
179 211
180Uses per-line display filtering (C<on_line_update>) to underline urls and 212Uses per-line display filtering (C<on_line_update>) to underline urls and
181make them clickable. When middle-clicked, the program specified in the 213make them clickable. When middle-clicked, the program specified in the
182resource C<urlLauncher> (default C<x-www-browser>) will be started with 214resource C<urlLauncher> (default C<x-www-browser>) will be started with
183the URL as first argument. 215the URL as first argument.
216
217=item xim-onthespot
218
219This (experimental) perl extension implements OnTheSpot editing. It does
220not work perfectly, and some input methods don't seem to work well with
221OnTheSpot editing in general, but it seems to work at leats for SCIM and
222kinput2.
223
224You enable it by specifying this extension and a preedit style of
225C<OnTheSpot>, i.e.:
226
227 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
184 228
185=item automove-background 229=item automove-background
186 230
187This is basically a one-line extension that dynamically changes the background pixmap offset 231This is basically a one-line extension that dynamically changes the background pixmap offset
188to the window position, in effect creating the same effect as pseudo transparency with 232to the window position, in effect creating the same effect as pseudo transparency with
338Called at the very end of initialisation of a new terminal, just before 382Called at the very end of initialisation of a new terminal, just before
339trying to map (display) the toplevel and returning to the mainloop. 383trying to map (display) the toplevel and returning to the mainloop.
340 384
341=item on_destroy $term 385=item on_destroy $term
342 386
343Called whenever something tries to destroy terminal, before doing anything 387Called whenever something tries to destroy terminal, when the terminal is
344yet. If this hook returns true, then destruction is skipped, but this is 388still fully functional (not for long, though).
345rarely a good idea.
346 389
347=item on_reset $term 390=item on_reset $term
348 391
349Called after the screen is "reset" for any reason, such as resizing or 392Called after the screen is "reset" for any reason, such as resizing or
350control sequences. Here is where you can react on changes to size-related 393control sequences. Here is where you can react on changes to size-related
476Called wheneever the window loses keyboard focus, before rxvt-unicode does 519Called wheneever the window loses keyboard focus, before rxvt-unicode does
477focus out processing. 520focus out processing.
478 521
479=item on_configure_notify $term, $event 522=item on_configure_notify $term, $event
480 523
524=item on_property_notify $term, $event
525
481=item on_key_press $term, $event, $keysym, $octets 526=item on_key_press $term, $event, $keysym, $octets
482 527
483=item on_key_release $term, $event, $keysym 528=item on_key_release $term, $event, $keysym
484 529
485=item on_button_press $term, $event 530=item on_button_press $term, $event
494 539
495Called whenever the corresponding X event is received for the terminal If 540Called whenever the corresponding X event is received for the terminal If
496the hook returns true, then the even will be ignored by rxvt-unicode. 541the hook returns true, then the even will be ignored by rxvt-unicode.
497 542
498The event is a hash with most values as named by Xlib (see the XEvent 543The event is a hash with most values as named by Xlib (see the XEvent
499manpage), with the additional members C<row> and C<col>, which are the row 544manpage), with the additional members C<row> and C<col>, which are the
500and column under the mouse cursor. 545(real, not screen-based) row and column under the mouse cursor.
501 546
502C<on_key_press> additionally receives the string rxvt-unicode would 547C<on_key_press> additionally receives the string rxvt-unicode would
503output, if any, in locale-specific encoding. 548output, if any, in locale-specific encoding.
504 549
505subwindow. 550subwindow.
535 580
536our $LIBDIR; 581our $LIBDIR;
537our $RESNAME; 582our $RESNAME;
538our $RESCLASS; 583our $RESCLASS;
539our $RXVTNAME; 584our $RXVTNAME;
585
586our $NOCHAR = chr 0xffff;
540 587
541=head2 Variables in the C<urxvt> Package 588=head2 Variables in the C<urxvt> Package
542 589
543=over 4 590=over 4
544 591
691 unless $msg =~ /\n$/; 738 unless $msg =~ /\n$/;
692 urxvt::warn ($msg); 739 urxvt::warn ($msg);
693 }; 740 };
694} 741}
695 742
743no warnings 'utf8';
744
696my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 745my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
697 746
698sub verbose { 747sub verbose {
699 my ($level, $msg) = @_; 748 my ($level, $msg) = @_;
700 warn "$msg\n" if $level <= $verbosity; 749 warn "$msg\n" if $level <= $verbosity;
716 765
717 open my $fh, "<:raw", $path 766 open my $fh, "<:raw", $path
718 or die "$path: $!"; 767 or die "$path: $!";
719 768
720 my $source = 769 my $source =
721 "package $pkg; use strict; use utf8;\n" 770 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
722 . "#line 1 \"$path\"\n{\n" 771 . "#line 1 \"$path\"\n{\n"
723 . (do { local $/; <$fh> }) 772 . (do { local $/; <$fh> })
724 . "\n};\n1"; 773 . "\n};\n1";
725 774
726 eval $source 775 eval $source
751 $TERM->register_package ($_) for @pkg; 800 $TERM->register_package ($_) for @pkg;
752 } 801 }
753 802
754 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 803 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
755 if ($_ eq "default") { 804 if ($_ eq "default") {
756 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 805 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
757 } elsif (/^-(.*)$/) { 806 } elsif (/^-(.*)$/) {
758 delete $ext_arg{$1}; 807 delete $ext_arg{$1};
759 } elsif (/^([^<]+)<(.*)>$/) { 808 } elsif (/^([^<]+)<(.*)>$/) {
760 push @{ $ext_arg{$1} }, $2; 809 push @{ $ext_arg{$1} }, $2;
761 } else { 810 } else {
1258 1307
1259Normally its not a good idea to use this function, as programs might be 1308Normally its not a good idea to use this function, as programs might be
1260confused by changes in cursor position or scrolling. Its useful inside a 1309confused by changes in cursor position or scrolling. Its useful inside a
1261C<on_add_lines> hook, though. 1310C<on_add_lines> hook, though.
1262 1311
1312=item $term->scr_change_screen ($screen)
1313
1314Switch to given screen - 0 primary, 1 secondary.
1315
1263=item $term->cmd_parse ($octets) 1316=item $term->cmd_parse ($octets)
1264 1317
1265Similar to C<scr_add_lines>, but the argument must be in the 1318Similar to C<scr_add_lines>, but the argument must be in the
1266locale-specific encoding of the terminal and can contain command sequences 1319locale-specific encoding of the terminal and can contain command sequences
1267(escape codes) that will be interpreted. 1320(escape codes) that will be interpreted.
1276 1329
1277Replaces the event mask of the pty watcher by the given event mask. Can 1330Replaces the event mask of the pty watcher by the given event mask. Can
1278be used to suppress input and output handling to the pty/tty. See the 1331be used to suppress input and output handling to the pty/tty. See the
1279description of C<< urxvt::timer->events >>. Make sure to always restore 1332description of C<< urxvt::timer->events >>. Make sure to always restore
1280the previous value. 1333the previous value.
1334
1335=item $fd = $term->pty_fd
1336
1337Returns the master file descriptor for the pty in use, or C<-1> if no pty
1338is used.
1281 1339
1282=item $windowid = $term->parent 1340=item $windowid = $term->parent
1283 1341
1284Return the window id of the toplevel window. 1342Return the window id of the toplevel window.
1285 1343
1350=item $modifiermask = $term->ModNumLockMask 1408=item $modifiermask = $term->ModNumLockMask
1351 1409
1352Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1410Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1353AltGr), the meta key (often Alt) and the num lock key, if applicable. 1411AltGr), the meta key (often Alt) and the num lock key, if applicable.
1354 1412
1413=item $screen = $term->current_screen
1414
1415Returns the currently displayed screen (0 primary, 1 secondary).
1416
1417=item $cursor_is_hidden = $term->hidden_cursor
1418
1419Returns wether the cursor is currently hidden or not.
1420
1355=item $view_start = $term->view_start ([$newvalue]) 1421=item $view_start = $term->view_start ([$newvalue])
1356 1422
1357Returns the row number of the topmost displayed line. Maximum value is 1423Returns the row number of the topmost displayed line. Maximum value is
1358C<0>, which displays the normal terminal contents. Lower values scroll 1424C<0>, which displays the normal terminal contents. Lower values scroll
1359this many lines into the scrollback buffer. 1425this many lines into the scrollback buffer.
1378line, starting at column C<$start_col> (default C<0>), which is useful 1444line, starting at column C<$start_col> (default C<0>), which is useful
1379to replace only parts of a line. The font index in the rendition will 1445to replace only parts of a line. The font index in the rendition will
1380automatically be updated. 1446automatically be updated.
1381 1447
1382C<$text> is in a special encoding: tabs and wide characters that use more 1448C<$text> is in a special encoding: tabs and wide characters that use more
1383than one cell when displayed are padded with urxvt::NOCHAR characters 1449than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1384(C<chr 65535>). Characters with combining characters and other characters 1450characters. Characters with combining characters and other characters that
1385that do not fit into the normal tetx encoding will be replaced with 1451do not fit into the normal tetx encoding will be replaced with characters
1386characters in the private use area. 1452in the private use area.
1387 1453
1388You have to obey this encoding when changing text. The advantage is 1454You have to obey this encoding when changing text. The advantage is
1389that C<substr> and similar functions work on screen cells and not on 1455that C<substr> and similar functions work on screen cells and not on
1390characters. 1456characters.
1391 1457
1565=item $term->ungrab 1631=item $term->ungrab
1566 1632
1567Calls XUngrab for the most recent grab. Is called automatically on 1633Calls XUngrab for the most recent grab. Is called automatically on
1568evaluation errors, as it is better to lose the grab in the error case as 1634evaluation errors, as it is better to lose the grab in the error case as
1569the session. 1635the session.
1636
1637=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1638
1639=item $atom_name = $term->XGetAtomName ($atom)
1640
1641=item @atoms = $term->XListProperties ($window)
1642
1643=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1644
1645=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1646
1647=item $term->XDeleteProperty ($window, $property)
1648
1649=item $window = $term->DefaultRootWindow
1650
1651=item $term->XReparentWindow ($window, $parent, [$x, $y])
1652
1653=item $term->XMapWindow ($window)
1654
1655=item $term->XUnmapWindow ($window)
1656
1657=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1658
1659=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1660
1661=item $term->XChangeInput ($window, $add_events[, $del_events])
1662
1663Various X or X-related functions. The C<$term> object only serves as
1664the source of the display, otherwise those functions map more-or-less
1665directory onto the X functions of the same name.
1570 1666
1571=back 1667=back
1572 1668
1573=cut 1669=cut
1574 1670

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines