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.114 by root, Fri Jan 20 12:16:28 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
161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ 193 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162 194
163The first line tells the selection code to treat the unchanging part of 195The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms 196every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file. 197the message into vi commands to load the file.
198
199=item tabbed
200
201This transforms the terminal into a tabbar with additional terminals, that
202is, it implements what is commonly refered to as "tabbed terminal". The topmost line
203displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204button per tab.
205
206Clicking a button will activate that tab. Pressing B<Shift-Left> and
207B<Shift-Right> will switch to the tab left or right of the current one,
208while B<Shift-Down> creates a new tab.
166 209
167=item mark-urls 210=item mark-urls
168 211
169Uses 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
170make them clickable. When middle-clicked, the program specified in the 213make them clickable. When middle-clicked, the program specified in the
171resource C<urlLauncher> (default C<x-www-browser>) will be started with 214resource C<urlLauncher> (default C<x-www-browser>) will be started with
172the 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
173 228
174=item automove-background 229=item automove-background
175 230
176This 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
177to 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
327Called 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
328trying to map (display) the toplevel and returning to the mainloop. 383trying to map (display) the toplevel and returning to the mainloop.
329 384
330=item on_destroy $term 385=item on_destroy $term
331 386
332Called whenever something tries to destroy terminal, before doing anything 387Called whenever something tries to destroy terminal, when the terminal is
333yet. If this hook returns true, then destruction is skipped, but this is 388still fully functional (not for long, though).
334rarely a good idea.
335 389
336=item on_reset $term 390=item on_reset $term
337 391
338Called 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
339control 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
465Called wheneever the window loses keyboard focus, before rxvt-unicode does 519Called wheneever the window loses keyboard focus, before rxvt-unicode does
466focus out processing. 520focus out processing.
467 521
468=item on_configure_notify $term, $event 522=item on_configure_notify $term, $event
469 523
524=item on_property_notify $term, $event
525
470=item on_key_press $term, $event, $keysym, $octets 526=item on_key_press $term, $event, $keysym, $octets
471 527
472=item on_key_release $term, $event, $keysym 528=item on_key_release $term, $event, $keysym
473 529
474=item on_button_press $term, $event 530=item on_button_press $term, $event
483 539
484Called whenever the corresponding X event is received for the terminal If 540Called whenever the corresponding X event is received for the terminal If
485the 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.
486 542
487The 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
488manpage), 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
489and column under the mouse cursor. 545(real, not screen-based) row and column under the mouse cursor.
490 546
491C<on_key_press> additionally receives the string rxvt-unicode would 547C<on_key_press> additionally receives the string rxvt-unicode would
492output, if any, in locale-specific encoding. 548output, if any, in locale-specific encoding.
493 549
494subwindow. 550subwindow.
524 580
525our $LIBDIR; 581our $LIBDIR;
526our $RESNAME; 582our $RESNAME;
527our $RESCLASS; 583our $RESCLASS;
528our $RXVTNAME; 584our $RXVTNAME;
585
586our $NOCHAR = chr 0xffff;
529 587
530=head2 Variables in the C<urxvt> Package 588=head2 Variables in the C<urxvt> Package
531 589
532=over 4 590=over 4
533 591
680 unless $msg =~ /\n$/; 738 unless $msg =~ /\n$/;
681 urxvt::warn ($msg); 739 urxvt::warn ($msg);
682 }; 740 };
683} 741}
684 742
743no warnings 'utf8';
744
685my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 745my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
686 746
687sub verbose { 747sub verbose {
688 my ($level, $msg) = @_; 748 my ($level, $msg) = @_;
689 warn "$msg\n" if $level <= $verbosity; 749 warn "$msg\n" if $level <= $verbosity;
705 765
706 open my $fh, "<:raw", $path 766 open my $fh, "<:raw", $path
707 or die "$path: $!"; 767 or die "$path: $!";
708 768
709 my $source = 769 my $source =
710 "package $pkg; use strict; use utf8;\n" 770 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
711 . "#line 1 \"$path\"\n{\n" 771 . "#line 1 \"$path\"\n{\n"
712 . (do { local $/; <$fh> }) 772 . (do { local $/; <$fh> })
713 . "\n};\n1"; 773 . "\n};\n1";
714 774
715 eval $source 775 eval $source
740 $TERM->register_package ($_) for @pkg; 800 $TERM->register_package ($_) for @pkg;
741 } 801 }
742 802
743 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 803 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
744 if ($_ eq "default") { 804 if ($_ eq "default") {
745 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 805 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
746 } elsif (/^-(.*)$/) { 806 } elsif (/^-(.*)$/) {
747 delete $ext_arg{$1}; 807 delete $ext_arg{$1};
748 } elsif (/^([^<]+)<(.*)>$/) { 808 } elsif (/^([^<]+)<(.*)>$/) {
749 push @{ $ext_arg{$1} }, $2; 809 push @{ $ext_arg{$1} }, $2;
750 } else { 810 } else {
1247 1307
1248Normally 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
1249confused by changes in cursor position or scrolling. Its useful inside a 1309confused by changes in cursor position or scrolling. Its useful inside a
1250C<on_add_lines> hook, though. 1310C<on_add_lines> hook, though.
1251 1311
1312=item $term->scr_change_screen ($screen)
1313
1314Switch to given screen - 0 primary, 1 secondary.
1315
1252=item $term->cmd_parse ($octets) 1316=item $term->cmd_parse ($octets)
1253 1317
1254Similar 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
1255locale-specific encoding of the terminal and can contain command sequences 1319locale-specific encoding of the terminal and can contain command sequences
1256(escape codes) that will be interpreted. 1320(escape codes) that will be interpreted.
1265 1329
1266Replaces 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
1267be 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
1268description of C<< urxvt::timer->events >>. Make sure to always restore 1332description of C<< urxvt::timer->events >>. Make sure to always restore
1269the 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.
1270 1339
1271=item $windowid = $term->parent 1340=item $windowid = $term->parent
1272 1341
1273Return the window id of the toplevel window. 1342Return the window id of the toplevel window.
1274 1343
1339=item $modifiermask = $term->ModNumLockMask 1408=item $modifiermask = $term->ModNumLockMask
1340 1409
1341Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1410Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1342AltGr), 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.
1343 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
1344=item $view_start = $term->view_start ([$newvalue]) 1421=item $view_start = $term->view_start ([$newvalue])
1345 1422
1346Returns the row number of the topmost displayed line. Maximum value is 1423Returns the row number of the topmost displayed line. Maximum value is
1347C<0>, which displays the normal terminal contents. Lower values scroll 1424C<0>, which displays the normal terminal contents. Lower values scroll
1348this many lines into the scrollback buffer. 1425this many lines into the scrollback buffer.
1367line, 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
1368to 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
1369automatically be updated. 1446automatically be updated.
1370 1447
1371C<$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
1372than one cell when displayed are padded with urxvt::NOCHAR characters 1449than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1373(C<chr 65535>). Characters with combining characters and other characters 1450characters. Characters with combining characters and other characters that
1374that 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
1375characters in the private use area. 1452in the private use area.
1376 1453
1377You have to obey this encoding when changing text. The advantage is 1454You have to obey this encoding when changing text. The advantage is
1378that 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
1379characters. 1456characters.
1380 1457
1554=item $term->ungrab 1631=item $term->ungrab
1555 1632
1556Calls XUngrab for the most recent grab. Is called automatically on 1633Calls XUngrab for the most recent grab. Is called automatically on
1557evaluation 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
1558the 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.
1559 1666
1560=back 1667=back
1561 1668
1562=cut 1669=cut
1563 1670

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines