… | |
… | |
108 | reference. The string will be used as button text and the code reference |
108 | reference. The string will be used as button text and the code reference |
109 | will be called when the toggle changes, with the new boolean value as |
109 | will be called when the toggle changes, with the new boolean value as |
110 | first argument. |
110 | first argument. |
111 | |
111 | |
112 | The following will add an entry C<myoption> that changes |
112 | The following will add an entry C<myoption> that changes |
113 | C<$self->{myoption}>: |
113 | C<< $self->{myoption} >>: |
114 | |
114 | |
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
117 | }; |
117 | }; |
118 | |
118 | |
… | |
… | |
165 | =item readline (enabled by default) |
165 | =item readline (enabled by default) |
166 | |
166 | |
167 | A support package that tries to make editing with readline easier. At |
167 | A support package that tries to make editing with readline easier. At |
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
169 | move the text cursor to this position. It does so by generating as many |
169 | move the text cursor to this position. It does so by generating as many |
170 | cursor-left or cursor-right keypresses as required (the this only works |
170 | cursor-left or cursor-right keypresses as required (this only works |
171 | for programs that correctly support wide characters). |
171 | for programs that correctly support wide characters). |
172 | |
172 | |
173 | To avoid too many false positives, this is only done when: |
173 | To avoid too many false positives, this is only done when: |
174 | |
174 | |
175 | =over 4 |
175 | =over 4 |
… | |
… | |
303 | extension will actually grab a physical key just for this function. |
303 | extension will actually grab a physical key just for this function. |
304 | |
304 | |
305 | If you want a quake-like animation, tell your window manager to do so |
305 | If you want a quake-like animation, tell your window manager to do so |
306 | (fvwm can do it). |
306 | (fvwm can do it). |
307 | |
307 | |
|
|
308 | =item overlay-osc |
|
|
309 | |
|
|
310 | This extension implements some OSC commands to display timed popups on the |
|
|
311 | screen - useful for status displays from within scripts. You have to read |
|
|
312 | the sources for more info. |
|
|
313 | |
308 | =item block-graphics-to-ascii |
314 | =item block-graphics-to-ascii |
309 | |
315 | |
310 | A not very useful example of filtering all text output to the terminal |
316 | A not very useful example of filtering all text output to the terminal |
311 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
317 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
312 | similar-looking ascii character. |
318 | similar-looking ascii character. |
… | |
… | |
366 | |
372 | |
367 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
373 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
368 | the double C</> characters as comment start. Use C<\057\057> instead, |
374 | the double C</> characters as comment start. Use C<\057\057> instead, |
369 | which works regardless of wether xrdb is used to parse the resource file |
375 | which works regardless of wether xrdb is used to parse the resource file |
370 | or not. |
376 | or not. |
|
|
377 | |
|
|
378 | =item macosx-pastebin and macosx-pastebin-native |
|
|
379 | |
|
|
380 | These two modules implement an extended clipboard for Mac OS X. They are |
|
|
381 | used 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 | |
|
|
387 | The difference between them is that the native variant requires a |
|
|
388 | perl from apple's devkit or so, and C<maxosx-pastebin> requires the |
|
|
389 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
|
|
390 | simpler etc. etc. |
371 | |
391 | |
372 | =item example-refresh-hooks |
392 | =item example-refresh-hooks |
373 | |
393 | |
374 | Displays a very simple digital clock in the upper right corner of the |
394 | Displays a very simple digital clock in the upper right corner of the |
375 | window. Illustrates overwriting the refresh callbacks to create your own |
395 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
541 | |
561 | |
542 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
562 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
543 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
563 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
544 | number of lines that will be in the scrollback buffer. |
564 | number of lines that will be in the scrollback buffer. |
545 | |
565 | |
546 | =item on_osc_seq $term, $op, $args |
566 | =item on_osc_seq $term, $op, $args, $resp |
547 | |
567 | |
548 | Called on every OSC sequence and can be used to suppress it or modify its |
568 | Called on every OSC sequence and can be used to suppress it or modify its |
549 | behaviour. The default should be to return an empty list. A true value |
569 | behaviour. The default should be to return an empty list. A true value |
550 | suppresses execution of the request completely. Make sure you don't get |
570 | suppresses execution of the request completely. Make sure you don't get |
551 | confused by recursive invocations when you output an osc sequence within |
571 | confused by recursive invocations when you output an OSC sequence within |
552 | this callback. |
572 | this callback. |
553 | |
573 | |
554 | C<on_osc_seq_perl> should be used for new behaviour. |
574 | C<on_osc_seq_perl> should be used for new behaviour. |
555 | |
575 | |
556 | =item on_osc_seq_perl $term, $string |
576 | =item on_osc_seq_perl $term, $args, $resp |
557 | |
577 | |
558 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
578 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
559 | operating system command) is processed. Cursor position and other state |
579 | operating system command) is processed. Cursor position and other state |
560 | information is up-to-date when this happens. For interoperability, the |
580 | information is up-to-date when this happens. For interoperability, the |
561 | string should start with the extension name and a colon, to distinguish |
581 | string should start with the extension name (sans -osc) and a semicolon, |
562 | it from commands for other extensions, and this might be enforced in the |
582 | to distinguish it from commands for other extensions, and this might be |
563 | future. |
583 | enforced in the future. |
|
|
584 | |
|
|
585 | For example, C<overlay-osc> uses this: |
|
|
586 | |
|
|
587 | sub on_osc_seq_perl { |
|
|
588 | my ($self, $osc, $resp) = @_; |
|
|
589 | |
|
|
590 | return unless $osc =~ s/^overlay;//; |
|
|
591 | |
|
|
592 | ... process remaining $osc string |
|
|
593 | } |
564 | |
594 | |
565 | Be careful not ever to trust (in a security sense) the data you receive, |
595 | Be careful not ever to trust (in a security sense) the data you receive, |
566 | as its source can not easily be controlled (e-mail content, messages from |
596 | as its source can not easily be controlled (e-mail content, messages from |
567 | other users on the same system etc.). |
597 | other users on the same system etc.). |
|
|
598 | |
|
|
599 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
600 | sender. |
568 | |
601 | |
569 | =item on_add_lines $term, $string |
602 | =item on_add_lines $term, $string |
570 | |
603 | |
571 | Called whenever text is about to be output, with the text as argument. You |
604 | Called whenever text is about to be output, with the text as argument. You |
572 | can filter/change and output the text yourself by returning a true value |
605 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
593 | later with the already-modified line (e.g. if unrelated parts change), so |
626 | later with the already-modified line (e.g. if unrelated parts change), so |
594 | you cannot just toggle rendition bits, but only set them. |
627 | you cannot just toggle rendition bits, but only set them. |
595 | |
628 | |
596 | =item on_refresh_begin $term |
629 | =item on_refresh_begin $term |
597 | |
630 | |
598 | Called just before the screen gets redrawn. Can be used for overlay |
631 | Called just before the screen gets redrawn. Can be used for overlay or |
599 | or similar effects by modify terminal contents in refresh_begin, and |
632 | similar effects by modifying the terminal contents in refresh_begin, and |
600 | restoring them in refresh_end. The built-in overlay and selection display |
633 | restoring them in refresh_end. The built-in overlay and selection display |
601 | code is run after this hook, and takes precedence. |
634 | code is run after this hook, and takes precedence. |
602 | |
635 | |
603 | =item on_refresh_end $term |
636 | =item on_refresh_end $term |
604 | |
637 | |
… | |
… | |
1091 | is that you cannot use blocking APIs, but the non-blocking variant should |
1124 | is that you cannot use blocking APIs, but the non-blocking variant should |
1092 | work. |
1125 | work. |
1093 | |
1126 | |
1094 | =cut |
1127 | =cut |
1095 | |
1128 | |
1096 | our $VERSION = 1; |
1129 | our $VERSION = '5.23'; |
1097 | |
1130 | |
1098 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1131 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1099 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1132 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1100 | |
1133 | |
1101 | sub timer { |
1134 | sub timer { |
… | |
… | |
1103 | |
1136 | |
1104 | my $cb = $arg{cb}; |
1137 | my $cb = $arg{cb}; |
1105 | |
1138 | |
1106 | urxvt::timer |
1139 | urxvt::timer |
1107 | ->new |
1140 | ->new |
1108 | ->start (urxvt::NOW + $arg{after}) |
1141 | ->after ($arg{after}) |
1109 | ->cb (sub { |
1142 | ->interval ($arg{interval}) |
|
|
1143 | ->start |
|
|
1144 | ->cb ($argv{interval} ? $cb : sub { |
1110 | $_[0]->stop; # need to cancel manually |
1145 | $_[0]->stop; # need to cancel manually |
1111 | $cb->(); |
1146 | $cb->(); |
1112 | }) |
1147 | }) |
1113 | } |
1148 | } |
1114 | |
1149 | |
1115 | sub io { |
1150 | sub io { |
1116 | my ($class, %arg) = @_; |
1151 | my ($class, %arg) = @_; |
1117 | |
1152 | |
1118 | my $cb = $arg{cb}; |
1153 | my $cb = $arg{cb}; |
|
|
1154 | my $fd = fileno $arg{fh}; |
|
|
1155 | defined $fd or $fd = $arg{fh}; |
1119 | |
1156 | |
1120 | bless [$arg{fh}, urxvt::iow |
1157 | bless [$arg{fh}, urxvt::iow |
1121 | ->new |
1158 | ->new |
1122 | ->fd (fileno $arg{fh}) |
1159 | ->fd ($fd) |
1123 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1160 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1124 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1161 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1125 | ->start |
1162 | ->start |
1126 | ->cb (sub { |
1163 | ->cb ($cb) |
1127 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
1128 | . ($_[1] & 2 ? 'w' : '')); |
|
|
1129 | })], |
|
|
1130 | urxvt::anyevent:: |
1164 | ], urxvt::anyevent:: |
|
|
1165 | } |
|
|
1166 | |
|
|
1167 | sub idle { |
|
|
1168 | my ($class, %arg) = @_; |
|
|
1169 | |
|
|
1170 | my $cb = $arg{cb}; |
|
|
1171 | |
|
|
1172 | urxvt::iw |
|
|
1173 | ->new |
|
|
1174 | ->start |
|
|
1175 | ->cb ($cb) |
|
|
1176 | } |
|
|
1177 | |
|
|
1178 | sub child { |
|
|
1179 | my ($class, %arg) = @_; |
|
|
1180 | |
|
|
1181 | my $cb = $arg{cb}; |
|
|
1182 | |
|
|
1183 | urxvt::pw |
|
|
1184 | ->new |
|
|
1185 | ->start ($arg{pid}) |
|
|
1186 | ->cb (sub { |
|
|
1187 | $_[0]->stop; # need to cancel manually |
|
|
1188 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1189 | }) |
1131 | } |
1190 | } |
1132 | |
1191 | |
1133 | sub DESTROY { |
1192 | sub DESTROY { |
1134 | $_[0][1]->stop; |
1193 | $_[0][1]->stop; |
1135 | } |
|
|
1136 | |
|
|
1137 | sub condvar { |
|
|
1138 | bless \my $flag, urxvt::anyevent:: |
|
|
1139 | } |
|
|
1140 | |
|
|
1141 | sub broadcast { |
|
|
1142 | ${$_[0]}++; |
|
|
1143 | } |
|
|
1144 | |
|
|
1145 | sub wait { |
|
|
1146 | unless (${$_[0]}) { |
|
|
1147 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
|
|
1148 | } |
|
|
1149 | } |
1194 | } |
1150 | |
1195 | |
1151 | sub one_event { |
1196 | sub one_event { |
1152 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1197 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1153 | } |
1198 | } |
… | |
… | |
1276 | Here is a likely non-exhaustive list of resource names, not all of which |
1321 | Here is a likely non-exhaustive list of resource names, not all of which |
1277 | are supported in every build, please see the source file F</src/rsinc.h> |
1322 | are supported in every build, please see the source file F</src/rsinc.h> |
1278 | to see the actual list: |
1323 | to see the actual list: |
1279 | |
1324 | |
1280 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1325 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1281 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1326 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1282 | display_name embed ext_bwidth fade font geometry hold iconName |
1327 | display_name embed ext_bwidth fade font geometry hold iconName |
1283 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1328 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1284 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1329 | italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 |
1285 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1330 | modifier mouseWheelScrollPage name override_redirect pastableTabs path |
1286 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1331 | perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1287 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1332 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1288 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1333 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1289 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1334 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1290 | secondaryScreen secondaryScroll selectstyle shade term_name title |
1335 | secondaryScreen secondaryScroll shade term_name title |
1291 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1336 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1292 | visualBell |
1337 | visualBell |
1293 | |
1338 | |
1294 | =cut |
1339 | =cut |
1295 | |
1340 | |
1296 | sub resource($$;$) { |
1341 | sub resource($$;$) { |
1297 | my ($self, $name) = (shift, shift); |
1342 | my ($self, $name) = (shift, shift); |
1298 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1343 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1299 | &urxvt::term::_resource |
1344 | goto &urxvt::term::_resource |
1300 | } |
1345 | } |
1301 | |
1346 | |
1302 | =item $value = $term->x_resource ($pattern) |
1347 | =item $value = $term->x_resource ($pattern) |
1303 | |
1348 | |
1304 | Returns the X-Resource for the given pattern, excluding the program or |
1349 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
1387 | |
1432 | |
1388 | The methods currently supported on C<urxvt::overlay> objects are: |
1433 | The methods currently supported on C<urxvt::overlay> objects are: |
1389 | |
1434 | |
1390 | =over 4 |
1435 | =over 4 |
1391 | |
1436 | |
1392 | =item $overlay->set ($x, $y, $text, $rend) |
1437 | =item $overlay->set ($x, $y, $text[, $rend]) |
1393 | |
1438 | |
1394 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1439 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1395 | text in rxvt-unicode's special encoding and an array of rendition values |
1440 | text in rxvt-unicode's special encoding and an array of rendition values |
1396 | at a specific position inside the overlay. |
1441 | at a specific position inside the overlay. |
|
|
1442 | |
|
|
1443 | If C<$rend> is missing, then the rendition will not be changed. |
1397 | |
1444 | |
1398 | =item $overlay->hide |
1445 | =item $overlay->hide |
1399 | |
1446 | |
1400 | If visible, hide the overlay, but do not destroy it. |
1447 | If visible, hide the overlay, but do not destroy it. |
1401 | |
1448 | |
… | |
… | |
1611 | |
1658 | |
1612 | Used after changing terminal contents to display them. |
1659 | Used after changing terminal contents to display them. |
1613 | |
1660 | |
1614 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1661 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1615 | |
1662 | |
1616 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1663 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1617 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1664 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1618 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1619 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1665 | terminal line. Nothing will be returned if a nonexistent line |
1620 | is requested. |
1666 | is requested. |
1621 | |
1667 | |
1622 | If C<$new_text> is specified, it will replace characters in the current |
1668 | If C<$new_text> is specified, it will replace characters in the current |
1623 | line, starting at column C<$start_col> (default C<0>), which is useful |
1669 | line, starting at column C<$start_col> (default C<0>), which is useful |
1624 | to replace only parts of a line. The font index in the rendition will |
1670 | to replace only parts of a line. The font index in the rendition will |
1625 | automatically be updated. |
1671 | automatically be updated. |
1626 | |
1672 | |
1627 | C<$text> is in a special encoding: tabs and wide characters that use more |
1673 | C<$text> is in a special encoding: tabs and wide characters that use more |
1628 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1674 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1629 | characters. Characters with combining characters and other characters that |
1675 | characters. Characters with combining characters and other characters that |
1630 | do not fit into the normal tetx encoding will be replaced with characters |
1676 | do not fit into the normal text encoding will be replaced with characters |
1631 | in the private use area. |
1677 | in the private use area. |
1632 | |
1678 | |
1633 | You have to obey this encoding when changing text. The advantage is |
1679 | You have to obey this encoding when changing text. The advantage is |
1634 | that C<substr> and similar functions work on screen cells and not on |
1680 | that C<substr> and similar functions work on screen cells and not on |
1635 | characters. |
1681 | characters. |
… | |
… | |
1822 | |
1868 | |
1823 | =item @atoms = $term->XListProperties ($window) |
1869 | =item @atoms = $term->XListProperties ($window) |
1824 | |
1870 | |
1825 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1871 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1826 | |
1872 | |
1827 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
1873 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
1828 | |
1874 | |
1829 | =item $term->XDeleteProperty ($window, $property) |
1875 | =item $term->XDeleteProperty ($window, $property) |
1830 | |
1876 | |
1831 | =item $window = $term->DefaultRootWindow |
1877 | =item $window = $term->DefaultRootWindow |
1832 | |
1878 | |
… | |
… | |
1954 | my $env = $self->{term}->env; |
2000 | my $env = $self->{term}->env; |
1955 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
2001 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1956 | delete $env->{LC_ALL}; |
2002 | delete $env->{LC_ALL}; |
1957 | $env->{LC_CTYPE} = $self->{term}->locale; |
2003 | $env->{LC_CTYPE} = $self->{term}->locale; |
1958 | |
2004 | |
1959 | urxvt::term->new ($env, "popup", |
2005 | my $term = urxvt::term->new ( |
|
|
2006 | $env, "popup", |
1960 | "--perl-lib" => "", "--perl-ext-common" => "", |
2007 | "--perl-lib" => "", "--perl-ext-common" => "", |
1961 | "-pty-fd" => -1, "-sl" => 0, |
2008 | "-pty-fd" => -1, "-sl" => 0, |
1962 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
2009 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1963 | "--transient-for" => $self->{term}->parent, |
2010 | "--transient-for" => $self->{term}->parent, |
1964 | "-display" => $self->{term}->display_id, |
2011 | "-display" => $self->{term}->display_id, |
1965 | "-pe" => "urxvt-popup") |
2012 | "-pe" => "urxvt-popup", |
1966 | or die "unable to create popup window\n"; |
2013 | ) or die "unable to create popup window\n"; |
|
|
2014 | |
|
|
2015 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
2016 | $term->ungrab; |
|
|
2017 | $term->destroy; |
|
|
2018 | die "unable to initialise popup window\n"; |
|
|
2019 | } |
1967 | } |
2020 | } |
1968 | |
2021 | |
1969 | sub DESTROY { |
2022 | sub DESTROY { |
1970 | my ($self) = @_; |
2023 | my ($self) = @_; |
1971 | |
2024 | |