… | |
… | |
66 | contain at least one pair of capturing parentheses, which will be used for |
66 | contain at least one pair of capturing parentheses, which will be used for |
67 | the match. For example, the followign adds a regex that matches everything |
67 | the match. For example, the followign adds a regex that matches everything |
68 | between two vertical bars: |
68 | between two vertical bars: |
69 | |
69 | |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
71 | |
|
|
72 | Another example: Programs I use often output "absolute path: " at the |
|
|
73 | beginning of a line when they process multiple files. The following |
|
|
74 | pattern matches the filename (note, there is a single space at the very |
|
|
75 | end): |
|
|
76 | |
|
|
77 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
71 | |
78 | |
72 | You can look at the source of the selection extension to see more |
79 | You can look at the source of the selection extension to see more |
73 | interesting uses, such as parsing a line from beginning to end. |
80 | interesting uses, such as parsing a line from beginning to end. |
74 | |
81 | |
75 | This extension also offers following bindable keyboard commands: |
82 | This extension also offers following bindable keyboard commands: |
… | |
… | |
127 | bottom. C<Escape> leaves search mode and returns to the point where search |
134 | bottom. C<Escape> leaves search mode and returns to the point where search |
128 | was started, while C<Enter> or C<Return> stay at the current position and |
135 | was started, while C<Enter> or C<Return> stay at the current position and |
129 | additionally stores the first match in the current line into the primary |
136 | additionally stores the first match in the current line into the primary |
130 | selection. |
137 | selection. |
131 | |
138 | |
|
|
139 | =item readline (enabled by default) |
|
|
140 | |
|
|
141 | A support package that tries to make editing with readline easier. At the |
|
|
142 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
143 | move the text cursor to this position. It does so by generating as many |
|
|
144 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
145 | for programs that correctly support wide characters). |
|
|
146 | |
|
|
147 | To 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 | |
|
|
161 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
162 | might interfere with selection creation in harmless ways. |
|
|
163 | |
132 | =item selection-autotransform |
164 | =item selection-autotransform |
133 | |
165 | |
134 | This selection allows you to do automatic transforms on a selection |
166 | This selection allows you to do automatic transforms on a selection |
135 | whenever a selection is made. |
167 | whenever a selection is made. |
136 | |
168 | |
… | |
… | |
338 | Called at the very end of initialisation of a new terminal, just before |
370 | Called at the very end of initialisation of a new terminal, just before |
339 | trying to map (display) the toplevel and returning to the mainloop. |
371 | trying to map (display) the toplevel and returning to the mainloop. |
340 | |
372 | |
341 | =item on_destroy $term |
373 | =item on_destroy $term |
342 | |
374 | |
343 | Called whenever something tries to destroy terminal, before doing anything |
375 | Called whenever something tries to destroy terminal, when the terminal is |
344 | yet. If this hook returns true, then destruction is skipped, but this is |
376 | still fully functional (not for long, though). |
345 | rarely a good idea. |
|
|
346 | |
377 | |
347 | =item on_reset $term |
378 | =item on_reset $term |
348 | |
379 | |
349 | Called after the screen is "reset" for any reason, such as resizing or |
380 | Called after the screen is "reset" for any reason, such as resizing or |
350 | control sequences. Here is where you can react on changes to size-related |
381 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
496 | |
527 | |
497 | Called whenever the corresponding X event is received for the terminal If |
528 | Called whenever the corresponding X event is received for the terminal If |
498 | the hook returns true, then the even will be ignored by rxvt-unicode. |
529 | the hook returns true, then the even will be ignored by rxvt-unicode. |
499 | |
530 | |
500 | The event is a hash with most values as named by Xlib (see the XEvent |
531 | The event is a hash with most values as named by Xlib (see the XEvent |
501 | manpage), with the additional members C<row> and C<col>, which are the row |
532 | manpage), with the additional members C<row> and C<col>, which are the |
502 | and column under the mouse cursor. |
533 | (real, not screen-based) row and column under the mouse cursor. |
503 | |
534 | |
504 | C<on_key_press> additionally receives the string rxvt-unicode would |
535 | C<on_key_press> additionally receives the string rxvt-unicode would |
505 | output, if any, in locale-specific encoding. |
536 | output, if any, in locale-specific encoding. |
506 | |
537 | |
507 | subwindow. |
538 | subwindow. |
… | |
… | |
537 | |
568 | |
538 | our $LIBDIR; |
569 | our $LIBDIR; |
539 | our $RESNAME; |
570 | our $RESNAME; |
540 | our $RESCLASS; |
571 | our $RESCLASS; |
541 | our $RXVTNAME; |
572 | our $RXVTNAME; |
|
|
573 | |
|
|
574 | our $NOCHAR = chr 0xffff; |
542 | |
575 | |
543 | =head2 Variables in the C<urxvt> Package |
576 | =head2 Variables in the C<urxvt> Package |
544 | |
577 | |
545 | =over 4 |
578 | =over 4 |
546 | |
579 | |
… | |
… | |
693 | unless $msg =~ /\n$/; |
726 | unless $msg =~ /\n$/; |
694 | urxvt::warn ($msg); |
727 | urxvt::warn ($msg); |
695 | }; |
728 | }; |
696 | } |
729 | } |
697 | |
730 | |
|
|
731 | no warnings 'utf8'; |
|
|
732 | |
698 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
733 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
699 | |
734 | |
700 | sub verbose { |
735 | sub verbose { |
701 | my ($level, $msg) = @_; |
736 | my ($level, $msg) = @_; |
702 | warn "$msg\n" if $level <= $verbosity; |
737 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
718 | |
753 | |
719 | open my $fh, "<:raw", $path |
754 | open my $fh, "<:raw", $path |
720 | or die "$path: $!"; |
755 | or die "$path: $!"; |
721 | |
756 | |
722 | my $source = |
757 | my $source = |
723 | "package $pkg; use strict; use utf8;\n" |
758 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
724 | . "#line 1 \"$path\"\n{\n" |
759 | . "#line 1 \"$path\"\n{\n" |
725 | . (do { local $/; <$fh> }) |
760 | . (do { local $/; <$fh> }) |
726 | . "\n};\n1"; |
761 | . "\n};\n1"; |
727 | |
762 | |
728 | eval $source |
763 | eval $source |
… | |
… | |
753 | $TERM->register_package ($_) for @pkg; |
788 | $TERM->register_package ($_) for @pkg; |
754 | } |
789 | } |
755 | |
790 | |
756 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
791 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
757 | if ($_ eq "default") { |
792 | if ($_ eq "default") { |
758 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
793 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
759 | } elsif (/^-(.*)$/) { |
794 | } elsif (/^-(.*)$/) { |
760 | delete $ext_arg{$1}; |
795 | delete $ext_arg{$1}; |
761 | } elsif (/^([^<]+)<(.*)>$/) { |
796 | } elsif (/^([^<]+)<(.*)>$/) { |
762 | push @{ $ext_arg{$1} }, $2; |
797 | push @{ $ext_arg{$1} }, $2; |
763 | } else { |
798 | } else { |
… | |
… | |
1260 | |
1295 | |
1261 | Normally its not a good idea to use this function, as programs might be |
1296 | Normally its not a good idea to use this function, as programs might be |
1262 | confused by changes in cursor position or scrolling. Its useful inside a |
1297 | confused by changes in cursor position or scrolling. Its useful inside a |
1263 | C<on_add_lines> hook, though. |
1298 | C<on_add_lines> hook, though. |
1264 | |
1299 | |
|
|
1300 | =item $term->scr_change_screen ($screen) |
|
|
1301 | |
|
|
1302 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1303 | |
1265 | =item $term->cmd_parse ($octets) |
1304 | =item $term->cmd_parse ($octets) |
1266 | |
1305 | |
1267 | Similar to C<scr_add_lines>, but the argument must be in the |
1306 | Similar to C<scr_add_lines>, but the argument must be in the |
1268 | locale-specific encoding of the terminal and can contain command sequences |
1307 | locale-specific encoding of the terminal and can contain command sequences |
1269 | (escape codes) that will be interpreted. |
1308 | (escape codes) that will be interpreted. |
… | |
… | |
1278 | |
1317 | |
1279 | Replaces the event mask of the pty watcher by the given event mask. Can |
1318 | Replaces the event mask of the pty watcher by the given event mask. Can |
1280 | be used to suppress input and output handling to the pty/tty. See the |
1319 | be used to suppress input and output handling to the pty/tty. See the |
1281 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1320 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1282 | the previous value. |
1321 | the previous value. |
|
|
1322 | |
|
|
1323 | =item $fd = $term->pty_fd |
|
|
1324 | |
|
|
1325 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1326 | is used. |
1283 | |
1327 | |
1284 | =item $windowid = $term->parent |
1328 | =item $windowid = $term->parent |
1285 | |
1329 | |
1286 | Return the window id of the toplevel window. |
1330 | Return the window id of the toplevel window. |
1287 | |
1331 | |
… | |
… | |
1352 | =item $modifiermask = $term->ModNumLockMask |
1396 | =item $modifiermask = $term->ModNumLockMask |
1353 | |
1397 | |
1354 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1398 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1355 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1399 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1356 | |
1400 | |
|
|
1401 | =item $screen = $term->current_screen |
|
|
1402 | |
|
|
1403 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1404 | |
|
|
1405 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1406 | |
|
|
1407 | Returns wether the cursor is currently hidden or not. |
|
|
1408 | |
1357 | =item $view_start = $term->view_start ([$newvalue]) |
1409 | =item $view_start = $term->view_start ([$newvalue]) |
1358 | |
1410 | |
1359 | Returns the row number of the topmost displayed line. Maximum value is |
1411 | Returns the row number of the topmost displayed line. Maximum value is |
1360 | C<0>, which displays the normal terminal contents. Lower values scroll |
1412 | C<0>, which displays the normal terminal contents. Lower values scroll |
1361 | this many lines into the scrollback buffer. |
1413 | this many lines into the scrollback buffer. |
… | |
… | |
1380 | line, starting at column C<$start_col> (default C<0>), which is useful |
1432 | line, starting at column C<$start_col> (default C<0>), which is useful |
1381 | to replace only parts of a line. The font index in the rendition will |
1433 | to replace only parts of a line. The font index in the rendition will |
1382 | automatically be updated. |
1434 | automatically be updated. |
1383 | |
1435 | |
1384 | C<$text> is in a special encoding: tabs and wide characters that use more |
1436 | C<$text> is in a special encoding: tabs and wide characters that use more |
1385 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1437 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1386 | (C<chr 65535>). Characters with combining characters and other characters |
1438 | characters. Characters with combining characters and other characters that |
1387 | that do not fit into the normal tetx encoding will be replaced with |
1439 | do not fit into the normal tetx encoding will be replaced with characters |
1388 | characters in the private use area. |
1440 | in the private use area. |
1389 | |
1441 | |
1390 | You have to obey this encoding when changing text. The advantage is |
1442 | You have to obey this encoding when changing text. The advantage is |
1391 | that C<substr> and similar functions work on screen cells and not on |
1443 | that C<substr> and similar functions work on screen cells and not on |
1392 | characters. |
1444 | characters. |
1393 | |
1445 | |
… | |
… | |
1567 | =item $term->ungrab |
1619 | =item $term->ungrab |
1568 | |
1620 | |
1569 | Calls XUngrab for the most recent grab. Is called automatically on |
1621 | Calls XUngrab for the most recent grab. Is called automatically on |
1570 | evaluation errors, as it is better to lose the grab in the error case as |
1622 | evaluation errors, as it is better to lose the grab in the error case as |
1571 | the session. |
1623 | the session. |
|
|
1624 | |
|
|
1625 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1626 | |
|
|
1627 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1628 | |
|
|
1629 | =item @atoms = $term->XListProperties ($window) |
|
|
1630 | |
|
|
1631 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1632 | |
|
|
1633 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1634 | |
|
|
1635 | =item $term->XDeleteProperty ($window, $property) |
|
|
1636 | |
|
|
1637 | =item $window = $term->DefaultRootWindow |
|
|
1638 | |
|
|
1639 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1640 | |
|
|
1641 | =item $term->XMapWindow ($window) |
|
|
1642 | |
|
|
1643 | =item $term->XUnmapWindow ($window) |
|
|
1644 | |
|
|
1645 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1646 | |
|
|
1647 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1648 | |
|
|
1649 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1650 | |
|
|
1651 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1652 | the source of the display, otherwise those functions map more-or-less |
|
|
1653 | directory onto the X functions of the same name. |
1572 | |
1654 | |
1573 | =back |
1655 | =back |
1574 | |
1656 | |
1575 | =cut |
1657 | =cut |
1576 | |
1658 | |