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.126 by root, Tue Jan 24 19:14:36 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
465Called wheneever the window loses keyboard focus, before rxvt-unicode does 508Called wheneever the window loses keyboard focus, before rxvt-unicode does
466focus out processing. 509focus out processing.
467 510
468=item on_configure_notify $term, $event 511=item on_configure_notify $term, $event
469 512
513=item on_property_notify $term, $event
514
470=item on_key_press $term, $event, $keysym, $octets 515=item on_key_press $term, $event, $keysym, $octets
471 516
472=item on_key_release $term, $event, $keysym 517=item on_key_release $term, $event, $keysym
473 518
474=item on_button_press $term, $event 519=item on_button_press $term, $event
483 528
484Called whenever the corresponding X event is received for the terminal If 529Called whenever the corresponding X event is received for the terminal If
485the hook returns true, then the even will be ignored by rxvt-unicode. 530the hook returns true, then the even will be ignored by rxvt-unicode.
486 531
487The event is a hash with most values as named by Xlib (see the XEvent 532The 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 533manpage), with the additional members C<row> and C<col>, which are the
489and column under the mouse cursor. 534(real, not screen-based) row and column under the mouse cursor.
490 535
491C<on_key_press> additionally receives the string rxvt-unicode would 536C<on_key_press> additionally receives the string rxvt-unicode would
492output, if any, in locale-specific encoding. 537output, if any, in locale-specific encoding.
493 538
494subwindow. 539subwindow.
524 569
525our $LIBDIR; 570our $LIBDIR;
526our $RESNAME; 571our $RESNAME;
527our $RESCLASS; 572our $RESCLASS;
528our $RXVTNAME; 573our $RXVTNAME;
574
575our $NOCHAR = chr 0xffff;
529 576
530=head2 Variables in the C<urxvt> Package 577=head2 Variables in the C<urxvt> Package
531 578
532=over 4 579=over 4
533 580
680 unless $msg =~ /\n$/; 727 unless $msg =~ /\n$/;
681 urxvt::warn ($msg); 728 urxvt::warn ($msg);
682 }; 729 };
683} 730}
684 731
732no warnings 'utf8';
733
685my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 734my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
686 735
687sub verbose { 736sub verbose {
688 my ($level, $msg) = @_; 737 my ($level, $msg) = @_;
689 warn "$msg\n" if $level <= $verbosity; 738 warn "$msg\n" if $level <= $verbosity;
705 754
706 open my $fh, "<:raw", $path 755 open my $fh, "<:raw", $path
707 or die "$path: $!"; 756 or die "$path: $!";
708 757
709 my $source = 758 my $source =
710 "package $pkg; use strict; use utf8;\n" 759 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
711 . "#line 1 \"$path\"\n{\n" 760 . "#line 1 \"$path\"\n{\n"
712 . (do { local $/; <$fh> }) 761 . (do { local $/; <$fh> })
713 . "\n};\n1"; 762 . "\n};\n1";
714 763
715 eval $source 764 eval $source
740 $TERM->register_package ($_) for @pkg; 789 $TERM->register_package ($_) for @pkg;
741 } 790 }
742 791
743 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 792 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
744 if ($_ eq "default") { 793 if ($_ eq "default") {
745 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 794 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
746 } elsif (/^-(.*)$/) { 795 } elsif (/^-(.*)$/) {
747 delete $ext_arg{$1}; 796 delete $ext_arg{$1};
748 } elsif (/^([^<]+)<(.*)>$/) { 797 } elsif (/^([^<]+)<(.*)>$/) {
749 push @{ $ext_arg{$1} }, $2; 798 push @{ $ext_arg{$1} }, $2;
750 } else { 799 } else {
1247 1296
1248Normally its not a good idea to use this function, as programs might be 1297Normally 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 1298confused by changes in cursor position or scrolling. Its useful inside a
1250C<on_add_lines> hook, though. 1299C<on_add_lines> hook, though.
1251 1300
1301=item $term->scr_change_screen ($screen)
1302
1303Switch to given screen - 0 primary, 1 secondary.
1304
1252=item $term->cmd_parse ($octets) 1305=item $term->cmd_parse ($octets)
1253 1306
1254Similar to C<scr_add_lines>, but the argument must be in the 1307Similar to C<scr_add_lines>, but the argument must be in the
1255locale-specific encoding of the terminal and can contain command sequences 1308locale-specific encoding of the terminal and can contain command sequences
1256(escape codes) that will be interpreted. 1309(escape codes) that will be interpreted.
1265 1318
1266Replaces the event mask of the pty watcher by the given event mask. Can 1319Replaces 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 1320be used to suppress input and output handling to the pty/tty. See the
1268description of C<< urxvt::timer->events >>. Make sure to always restore 1321description of C<< urxvt::timer->events >>. Make sure to always restore
1269the previous value. 1322the previous value.
1323
1324=item $fd = $term->pty_fd
1325
1326Returns the master file descriptor for the pty in use, or C<-1> if no pty
1327is used.
1270 1328
1271=item $windowid = $term->parent 1329=item $windowid = $term->parent
1272 1330
1273Return the window id of the toplevel window. 1331Return the window id of the toplevel window.
1274 1332
1339=item $modifiermask = $term->ModNumLockMask 1397=item $modifiermask = $term->ModNumLockMask
1340 1398
1341Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1399Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1342AltGr), the meta key (often Alt) and the num lock key, if applicable. 1400AltGr), the meta key (often Alt) and the num lock key, if applicable.
1343 1401
1402=item $screen = $term->current_screen
1403
1404Returns the currently displayed screen (0 primary, 1 secondary).
1405
1406=item $cursor_is_hidden = $term->hidden_cursor
1407
1408Returns wether the cursor is currently hidden or not.
1409
1344=item $view_start = $term->view_start ([$newvalue]) 1410=item $view_start = $term->view_start ([$newvalue])
1345 1411
1346Returns the row number of the topmost displayed line. Maximum value is 1412Returns the row number of the topmost displayed line. Maximum value is
1347C<0>, which displays the normal terminal contents. Lower values scroll 1413C<0>, which displays the normal terminal contents. Lower values scroll
1348this many lines into the scrollback buffer. 1414this many lines into the scrollback buffer.
1367line, starting at column C<$start_col> (default C<0>), which is useful 1433line, 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 1434to replace only parts of a line. The font index in the rendition will
1369automatically be updated. 1435automatically be updated.
1370 1436
1371C<$text> is in a special encoding: tabs and wide characters that use more 1437C<$text> is in a special encoding: tabs and wide characters that use more
1372than one cell when displayed are padded with urxvt::NOCHAR characters 1438than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1373(C<chr 65535>). Characters with combining characters and other characters 1439characters. Characters with combining characters and other characters that
1374that do not fit into the normal tetx encoding will be replaced with 1440do not fit into the normal tetx encoding will be replaced with characters
1375characters in the private use area. 1441in the private use area.
1376 1442
1377You have to obey this encoding when changing text. The advantage is 1443You have to obey this encoding when changing text. The advantage is
1378that C<substr> and similar functions work on screen cells and not on 1444that C<substr> and similar functions work on screen cells and not on
1379characters. 1445characters.
1380 1446
1554=item $term->ungrab 1620=item $term->ungrab
1555 1621
1556Calls XUngrab for the most recent grab. Is called automatically on 1622Calls 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 1623evaluation errors, as it is better to lose the grab in the error case as
1558the session. 1624the session.
1625
1626=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1627
1628=item $atom_name = $term->XGetAtomName ($atom)
1629
1630=item @atoms = $term->XListProperties ($window)
1631
1632=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1633
1634=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1635
1636=item $term->XDeleteProperty ($window, $property)
1637
1638=item $window = $term->DefaultRootWindow
1639
1640=item $term->XReparentWindow ($window, $parent, [$x, $y])
1641
1642=item $term->XMapWindow ($window)
1643
1644=item $term->XUnmapWindow ($window)
1645
1646=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1647
1648=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1649
1650=item $term->XChangeInput ($window, $add_events[, $del_events])
1651
1652Various X or X-related functions. The C<$term> object only serves as
1653the source of the display, otherwise those functions map more-or-less
1654directory onto the X functions of the same name.
1559 1655
1560=back 1656=back
1561 1657
1562=cut 1658=cut
1563 1659

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines