… | |
… | |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
30 | |
30 | |
31 | =head2 Prepackaged Extensions |
31 | =head1 PREPACKAGED EXTENSIONS |
32 | |
32 | |
33 | This section describes the extensiosn delivered with this version. You can |
33 | This section describes the extensions delivered with this release. You can |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
35 | |
35 | |
36 | You can activate them like this: |
36 | You can activate them like this: |
37 | |
37 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
38 | @@RXVT_NAME@@ -pe <extensionname> |
39 | |
39 | |
40 | =over 4 |
40 | =over 4 |
41 | |
41 | |
42 | =item selection (enabled by default) |
42 | =item selection (enabled by default) |
43 | |
43 | |
44 | Intelligent selection. This extension tries to be more intelligent when |
44 | (More) intelligent selection. This extension tries to be more intelligent |
45 | the user extends selections (double-click). Right now, it tries to select |
45 | when the user extends selections (double-click). Right now, it tries to |
46 | urls and complete shell-quoted arguments, which is very convenient, too, |
46 | select urls and complete shell-quoted arguments, which is very convenient, |
47 | if your F<ls> supports C<--quoting-style=shell>. |
47 | too, if your F<ls> supports C<--quoting-style=shell>. |
48 | |
48 | |
49 | It also offers the following bindable event: |
49 | It also offers the following bindable keyboard command: |
50 | |
50 | |
51 | =over 4 |
51 | =over 4 |
52 | |
52 | |
53 | =item rot13 |
53 | =item rot13 |
54 | |
54 | |
… | |
… | |
64 | runtime. |
64 | runtime. |
65 | |
65 | |
66 | =item selection-popup (enabled by default) |
66 | =item selection-popup (enabled by default) |
67 | |
67 | |
68 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
68 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
69 | text into various other formats/action. |
69 | text into various other formats/action (such as uri unescaping, perl |
|
|
70 | evalution, web-browser starting etc.), depending on content. |
70 | |
71 | |
71 | =item searchable-scrollback (enabled by default) |
72 | =item searchable-scrollback<hotkey> (enabled by default) |
72 | |
73 | |
73 | Adds regex search functionality to the scrollback buffer, triggered by a |
74 | Adds regex search functionality to the scrollback buffer, triggered |
74 | hotkey (default: C<M-s>). When in search mode, terminal input/output is |
75 | by a hotkey (default: C<M-s>). When in search mode, normal terminal |
|
|
76 | input/output is suspended. |
|
|
77 | |
75 | suspended, C</> starts an incremental regex search, C<n> searches further, |
78 | C</> starts an incremental regex search, C<n> searches further, C<p> or |
76 | C<p> jumps to the previous match. C<enter> leaves search mode at the |
79 | C<N> jump to the previous match, C<G> jumps to the bottom and clears the |
77 | current position and C<escape> returns to the original position. |
80 | history, C<enter> leaves search mode at the current position and C<escape> |
|
|
81 | returns to the original position. |
78 | |
82 | |
79 | =item digital-clock |
83 | =item digital-clock |
80 | |
84 | |
81 | Displays a digital clock using the built-in overlay. |
85 | Displays a digital clock using the built-in overlay. |
82 | |
86 | |
83 | =item mark-urls |
87 | =item mark-urls |
84 | |
88 | |
85 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
89 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
|
|
90 | make them clickable. When clicked, the program specified in the resource |
|
|
91 | C<urlLauncher> (default C<x-www-browser>) will be started. |
86 | |
92 | |
87 | =item block-graphics-to-ascii |
93 | =item block-graphics-to-ascii |
88 | |
94 | |
89 | A not very useful example of filtering all text output to the terminal, |
95 | A not very useful example of filtering all text output to the terminal, |
90 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
96 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
… | |
… | |
95 | Displays a very simple digital clock in the upper right corner of the |
101 | Displays a very simple digital clock in the upper right corner of the |
96 | window. Illustrates overwriting the refresh callbacks to create your own |
102 | window. Illustrates overwriting the refresh callbacks to create your own |
97 | overlays or changes. |
103 | overlays or changes. |
98 | |
104 | |
99 | =back |
105 | =back |
|
|
106 | |
|
|
107 | =head1 API DOCUMENTATION |
100 | |
108 | |
101 | =head2 General API Considerations |
109 | =head2 General API Considerations |
102 | |
110 | |
103 | All objects (such as terminals, time watchers etc.) are typical |
111 | All objects (such as terminals, time watchers etc.) are typical |
104 | reference-to-hash objects. The hash can be used to store anything you |
112 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
117 | =over 4 |
125 | =over 4 |
118 | |
126 | |
119 | =item $text |
127 | =item $text |
120 | |
128 | |
121 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
129 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
122 | always represents one screen cell. See L<row_t> for a discussion of this format. |
130 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
123 | |
131 | |
124 | =item $string |
132 | =item $string |
125 | |
133 | |
126 | A perl text string, with an emphasis on I<text>. It can store all unicode |
134 | A perl text string, with an emphasis on I<text>. It can store all unicode |
127 | characters and is to be distinguished with text encoded in a specific |
135 | characters and is to be distinguished with text encoded in a specific |
… | |
… | |
263 | can filter/change and output the text yourself by returning a true value |
271 | can filter/change and output the text yourself by returning a true value |
264 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
272 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
265 | might be very slow, however, as your hook is called for B<all> text being |
273 | might be very slow, however, as your hook is called for B<all> text being |
266 | output. |
274 | output. |
267 | |
275 | |
|
|
276 | =item on_tt_write $term, $octets |
|
|
277 | |
|
|
278 | Called whenever some data is written to the tty/pty and can be used to |
|
|
279 | suppress or filter tty input. |
|
|
280 | |
268 | =item on_line_update $term, $row |
281 | =item on_line_update $term, $row |
269 | |
282 | |
270 | Called whenever a line was updated or changed. Can be used to filter |
283 | Called whenever a line was updated or changed. Can be used to filter |
271 | screen output (e.g. underline urls or other useless stuff). Only lines |
284 | screen output (e.g. underline urls or other useless stuff). Only lines |
272 | that are being shown will be filtered, and, due to performance reasons, |
285 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
329 | |
342 | |
330 | C<on_key_press> additionally receives the string rxvt-unicode would |
343 | C<on_key_press> additionally receives the string rxvt-unicode would |
331 | output, if any, in locale-specific encoding. |
344 | output, if any, in locale-specific encoding. |
332 | |
345 | |
333 | subwindow. |
346 | subwindow. |
334 | |
|
|
335 | =back |
|
|
336 | |
|
|
337 | =head2 Variables in the C<urxvt> Package |
|
|
338 | |
|
|
339 | =over 4 |
|
|
340 | |
|
|
341 | =item $urxvt::TERM |
|
|
342 | |
|
|
343 | The current terminal. This variable stores the current C<urxvt::term> |
|
|
344 | object, whenever a callback/hook is executing. |
|
|
345 | |
|
|
346 | =back |
|
|
347 | |
|
|
348 | =head2 Functions in the C<urxvt> Package |
|
|
349 | |
|
|
350 | =over 4 |
|
|
351 | |
|
|
352 | =item $term = new urxvt [arg...] |
|
|
353 | |
|
|
354 | Creates a new terminal, very similar as if you had started it with |
|
|
355 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
356 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
357 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
358 | C<init> and C<start> hooks will be called during the call. |
|
|
359 | |
|
|
360 | =item urxvt::fatal $errormessage |
|
|
361 | |
|
|
362 | Fatally aborts execution with the given error message. Avoid at all |
|
|
363 | costs! The only time this is acceptable is when the terminal process |
|
|
364 | starts up. |
|
|
365 | |
|
|
366 | =item urxvt::warn $string |
|
|
367 | |
|
|
368 | Calls C<rxvt_warn> with the given string which should not include a |
|
|
369 | newline. The module also overwrites the C<warn> builtin with a function |
|
|
370 | that calls this function. |
|
|
371 | |
|
|
372 | Using this function has the advantage that its output ends up in the |
|
|
373 | correct place, e.g. on stderr of the connecting urxvtc client. |
|
|
374 | |
|
|
375 | =item $is_safe = urxvt::safe |
|
|
376 | |
|
|
377 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
378 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
379 | started setuid or setgid. |
|
|
380 | |
|
|
381 | =item $time = urxvt::NOW |
|
|
382 | |
|
|
383 | Returns the "current time" (as per the event loop). |
|
|
384 | |
|
|
385 | =item urxvt::CurrentTime |
|
|
386 | |
|
|
387 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
388 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
389 | Button4Mask, Button5Mask, AnyModifier |
|
|
390 | |
|
|
391 | Various constants for use in X calls and event processing. |
|
|
392 | |
|
|
393 | =back |
|
|
394 | |
|
|
395 | =head2 RENDITION |
|
|
396 | |
|
|
397 | Rendition bitsets contain information about colour, font, font styles and |
|
|
398 | similar information for each screen cell. |
|
|
399 | |
|
|
400 | The following "macros" deal with changes in rendition sets. You should |
|
|
401 | never just create a bitset, you should always modify an existing one, |
|
|
402 | as they contain important information required for correct operation of |
|
|
403 | rxvt-unicode. |
|
|
404 | |
|
|
405 | =over 4 |
|
|
406 | |
|
|
407 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
408 | |
|
|
409 | Returns the default rendition, as used when the terminal is starting up or |
|
|
410 | being reset. Useful as a base to start when creating renditions. |
|
|
411 | |
|
|
412 | =item $rend = urxvt::OVERLAY_RSTYLE |
|
|
413 | |
|
|
414 | Return the rendition mask used for overlays by default. |
|
|
415 | |
|
|
416 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
|
|
417 | |
|
|
418 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
419 | underline, respectively. To enable such a style, just logically OR it into |
|
|
420 | the bitset. |
|
|
421 | |
|
|
422 | =item $foreground = urxvt::GET_BASEFG $rend |
|
|
423 | |
|
|
424 | =item $background = urxvt::GET_BASEBG $rend |
|
|
425 | |
|
|
426 | Return the foreground/background colour index, respectively. |
|
|
427 | |
|
|
428 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
|
|
429 | |
|
|
430 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
|
|
431 | |
|
|
432 | Replace the foreground/background colour in the rendition mask with the |
|
|
433 | specified one. |
|
|
434 | |
|
|
435 | =item $value = urxvt::GET_CUSTOM ($rend) |
|
|
436 | |
|
|
437 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
438 | extensions. They can be set and changed as you like and are initially |
|
|
439 | zero. |
|
|
440 | |
|
|
441 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
|
|
442 | |
|
|
443 | Change the custom value. |
|
|
444 | |
347 | |
445 | =back |
348 | =back |
446 | |
349 | |
447 | =cut |
350 | =cut |
448 | |
351 | |
… | |
… | |
457 | our $VERSION = 1; |
360 | our $VERSION = 1; |
458 | our $TERM; |
361 | our $TERM; |
459 | our @HOOKNAME; |
362 | our @HOOKNAME; |
460 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
363 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
461 | our %OPTION; |
364 | our %OPTION; |
|
|
365 | |
462 | our $LIBDIR; |
366 | our $LIBDIR; |
|
|
367 | our $RESNAME; |
|
|
368 | our $RESCLASS; |
|
|
369 | our $RXVTNAME; |
|
|
370 | |
|
|
371 | =head2 Variables in the C<urxvt> Package |
|
|
372 | |
|
|
373 | =over 4 |
|
|
374 | |
|
|
375 | =item $urxvt::LIBDIR |
|
|
376 | |
|
|
377 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
378 | modules and scripts are stored. |
|
|
379 | |
|
|
380 | =item $urxvt::RESCLASS, $urxvt::RESCLASS |
|
|
381 | |
|
|
382 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
383 | |
|
|
384 | =item $urxvt::RXVTNAME |
|
|
385 | |
|
|
386 | The basename of the installed binaries, usually C<urxvt>. |
|
|
387 | |
|
|
388 | =item $urxvt::TERM |
|
|
389 | |
|
|
390 | The current terminal. This variable stores the current C<urxvt::term> |
|
|
391 | object, whenever a callback/hook is executing. |
|
|
392 | |
|
|
393 | =back |
|
|
394 | |
|
|
395 | =head2 Functions in the C<urxvt> Package |
|
|
396 | |
|
|
397 | =over 4 |
|
|
398 | |
|
|
399 | =item urxvt::fatal $errormessage |
|
|
400 | |
|
|
401 | Fatally aborts execution with the given error message. Avoid at all |
|
|
402 | costs! The only time this is acceptable is when the terminal process |
|
|
403 | starts up. |
|
|
404 | |
|
|
405 | =item urxvt::warn $string |
|
|
406 | |
|
|
407 | Calls C<rxvt_warn> with the given string which should not include a |
|
|
408 | newline. The module also overwrites the C<warn> builtin with a function |
|
|
409 | that calls this function. |
|
|
410 | |
|
|
411 | Using this function has the advantage that its output ends up in the |
|
|
412 | correct place, e.g. on stderr of the connecting urxvtc client. |
|
|
413 | |
|
|
414 | Messages have a size limit of 1023 bytes currently. |
|
|
415 | |
|
|
416 | =item $is_safe = urxvt::safe |
|
|
417 | |
|
|
418 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
419 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
420 | started setuid or setgid. |
|
|
421 | |
|
|
422 | =item $time = urxvt::NOW |
|
|
423 | |
|
|
424 | Returns the "current time" (as per the event loop). |
|
|
425 | |
|
|
426 | =item urxvt::CurrentTime |
|
|
427 | |
|
|
428 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
429 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
430 | Button4Mask, Button5Mask, AnyModifier |
|
|
431 | |
|
|
432 | Various constants for use in X calls and event processing. |
|
|
433 | |
|
|
434 | =back |
|
|
435 | |
|
|
436 | =head2 RENDITION |
|
|
437 | |
|
|
438 | Rendition bitsets contain information about colour, font, font styles and |
|
|
439 | similar information for each screen cell. |
|
|
440 | |
|
|
441 | The following "macros" deal with changes in rendition sets. You should |
|
|
442 | never just create a bitset, you should always modify an existing one, |
|
|
443 | as they contain important information required for correct operation of |
|
|
444 | rxvt-unicode. |
|
|
445 | |
|
|
446 | =over 4 |
|
|
447 | |
|
|
448 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
449 | |
|
|
450 | Returns the default rendition, as used when the terminal is starting up or |
|
|
451 | being reset. Useful as a base to start when creating renditions. |
|
|
452 | |
|
|
453 | =item $rend = urxvt::OVERLAY_RSTYLE |
|
|
454 | |
|
|
455 | Return the rendition mask used for overlays by default. |
|
|
456 | |
|
|
457 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
|
|
458 | |
|
|
459 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
460 | underline, respectively. To enable such a style, just logically OR it into |
|
|
461 | the bitset. |
|
|
462 | |
|
|
463 | =item $foreground = urxvt::GET_BASEFG $rend |
|
|
464 | |
|
|
465 | =item $background = urxvt::GET_BASEBG $rend |
|
|
466 | |
|
|
467 | Return the foreground/background colour index, respectively. |
|
|
468 | |
|
|
469 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
|
|
470 | |
|
|
471 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
472 | |
|
|
473 | Replace the foreground/background colour in the rendition mask with the |
|
|
474 | specified one. |
|
|
475 | |
|
|
476 | =item $value = urxvt::GET_CUSTOM $rend |
|
|
477 | |
|
|
478 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
479 | extensions. They can be set and changed as you like and are initially |
|
|
480 | zero. |
|
|
481 | |
|
|
482 | =item $rend = urxvt::SET_CUSTOM $rend, $new_value |
|
|
483 | |
|
|
484 | Change the custom value. |
|
|
485 | |
|
|
486 | =back |
|
|
487 | |
|
|
488 | =cut |
463 | |
489 | |
464 | BEGIN { |
490 | BEGIN { |
465 | urxvt->bootstrap; |
491 | urxvt->bootstrap; |
466 | |
492 | |
467 | # overwrite perl's warn |
493 | # overwrite perl's warn |
… | |
… | |
470 | $msg .= "\n" |
496 | $msg .= "\n" |
471 | unless $msg =~ /\n$/; |
497 | unless $msg =~ /\n$/; |
472 | urxvt::warn ($msg); |
498 | urxvt::warn ($msg); |
473 | }; |
499 | }; |
474 | |
500 | |
475 | delete $ENV{IFS}; |
501 | # delete $ENV{IFS}; |
476 | delete $ENV{CDPATH}; |
502 | # delete $ENV{CDPATH}; |
477 | delete $ENV{BASH_ENV}; |
503 | # delete $ENV{BASH_ENV}; |
478 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
504 | # $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
479 | } |
505 | } |
480 | |
506 | |
481 | my @hook_count; |
507 | my @hook_count; |
482 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
508 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
483 | |
509 | |
… | |
… | |
501 | open my $fh, "<:raw", $path |
527 | open my $fh, "<:raw", $path |
502 | or die "$path: $!"; |
528 | or die "$path: $!"; |
503 | |
529 | |
504 | my $source = untaint |
530 | my $source = untaint |
505 | "package $pkg; use strict; use utf8;\n" |
531 | "package $pkg; use strict; use utf8;\n" |
506 | . "use base urxvt::term::proxy::;\n" |
532 | . "use base urxvt::term::extension::;\n" |
507 | . "#line 1 \"$path\"\n{\n" |
533 | . "#line 1 \"$path\"\n{\n" |
508 | . (do { local $/; <$fh> }) |
534 | . (do { local $/; <$fh> }) |
509 | . "\n};\n1"; |
535 | . "\n};\n1"; |
510 | |
536 | |
511 | eval $source |
537 | eval $source |
… | |
… | |
588 | } |
614 | } |
589 | |
615 | |
590 | $retval |
616 | $retval |
591 | } |
617 | } |
592 | |
618 | |
593 | # urxvt::term::proxy |
619 | # urxvt::term::extension |
594 | |
620 | |
595 | package urxvt::term::proxy; |
621 | package urxvt::term::extension; |
596 | |
622 | |
597 | sub enable { |
623 | sub enable { |
598 | my ($self, %hook) = @_; |
624 | my ($self, %hook) = @_; |
599 | my $pkg = $self->{_pkg}; |
625 | my $pkg = $self->{_pkg}; |
600 | |
626 | |
… | |
… | |
663 | |
689 | |
664 | =head2 The C<urxvt::anyevent> Class |
690 | =head2 The C<urxvt::anyevent> Class |
665 | |
691 | |
666 | The sole purpose of this class is to deliver an interface to the |
692 | The sole purpose of this class is to deliver an interface to the |
667 | C<AnyEvent> module - any module using it will work inside urxvt without |
693 | C<AnyEvent> module - any module using it will work inside urxvt without |
668 | further work. The only exception is that you cannot wait on condition |
694 | further programming. The only exception is that you cannot wait on |
669 | variables, but non-blocking condvar use is ok. What this means is that you |
695 | condition variables, but non-blocking condvar use is ok. What this means |
670 | cannot use blocking APIs, but the non-blocking variant should work. |
696 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
697 | work. |
671 | |
698 | |
672 | =cut |
699 | =cut |
673 | |
700 | |
674 | our $VERSION = 1; |
701 | our $VERSION = 1; |
675 | |
702 | |
… | |
… | |
752 | $proxy->enable ($name => $ref); |
779 | $proxy->enable ($name => $ref); |
753 | } |
780 | } |
754 | } |
781 | } |
755 | } |
782 | } |
756 | |
783 | |
|
|
784 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
|
|
785 | |
|
|
786 | Creates a new terminal, very similar as if you had started it with system |
|
|
787 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
|
|
788 | hash which defines the environment of the new terminal. |
|
|
789 | |
|
|
790 | Croaks (and probably outputs an error message) if the new instance |
|
|
791 | couldn't be created. Returns C<undef> if the new instance didn't |
|
|
792 | initialise perl, and the terminal object otherwise. The C<init> and |
|
|
793 | C<start> hooks will be called during this call. |
|
|
794 | |
|
|
795 | =cut |
|
|
796 | |
|
|
797 | sub new { |
|
|
798 | my ($class, $env, @args) = @_; |
|
|
799 | |
|
|
800 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
|
|
801 | } |
|
|
802 | |
757 | =item $term->destroy |
803 | =item $term->destroy |
758 | |
804 | |
759 | Destroy the terminal object (close the window, free resources etc.). |
805 | Destroy the terminal object (close the window, free resources |
|
|
806 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
|
|
807 | watchers (timers, io watchers) are still active. |
760 | |
808 | |
761 | =item $isset = $term->option ($optval[, $set]) |
809 | =item $isset = $term->option ($optval[, $set]) |
762 | |
810 | |
763 | Returns true if the option specified by C<$optval> is enabled, and |
811 | Returns true if the option specified by C<$optval> is enabled, and |
764 | optionally change it. All option values are stored by name in the hash |
812 | optionally change it. All option values are stored by name in the hash |
… | |
… | |
814 | my ($self, $name) = (shift, shift); |
862 | my ($self, $name) = (shift, shift); |
815 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
863 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
816 | &urxvt::term::_resource |
864 | &urxvt::term::_resource |
817 | } |
865 | } |
818 | |
866 | |
|
|
867 | =item $value = $term->x_resource ($pattern) |
|
|
868 | |
|
|
869 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
870 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
|
|
871 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
|
|
872 | resource with that pattern exists. |
|
|
873 | |
|
|
874 | This method should only be called during the C<on_start> hook, as there is |
|
|
875 | only one resource database per display, and later invocations might return |
|
|
876 | the wrong resources. |
|
|
877 | |
819 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
878 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
820 | |
879 | |
821 | Adds a keymap translation exactly as specified via a resource. See the |
880 | Adds a keymap translation exactly as specified via a resource. See the |
822 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
881 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
823 | |
882 | |
… | |
… | |
941 | |
1000 | |
942 | =item $string = $term->locale_decode ($octets) |
1001 | =item $string = $term->locale_decode ($octets) |
943 | |
1002 | |
944 | Convert the given locale-encoded octets into a perl string. |
1003 | Convert the given locale-encoded octets into a perl string. |
945 | |
1004 | |
|
|
1005 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
|
|
1006 | |
|
|
1007 | XORs the rendition values in the given span with the provided value |
|
|
1008 | (default: C<RS_RVid>). Useful in refresh hooks to provide effects similar |
|
|
1009 | to the selection. |
|
|
1010 | |
|
|
1011 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
|
|
1012 | |
|
|
1013 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
|
|
1014 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
|
|
1015 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
|
|
1016 | it instead. |
|
|
1017 | |
946 | =item $term->scr_bell |
1018 | =item $term->scr_bell |
947 | |
1019 | |
948 | Ring the bell! |
1020 | Ring the bell! |
949 | |
1021 | |
950 | =item $term->scr_add_lines ($string) |
1022 | =item $term->scr_add_lines ($string) |
… | |
… | |
1009 | |
1081 | |
1010 | =item $lines_in_scrollback = $term->nsaved |
1082 | =item $lines_in_scrollback = $term->nsaved |
1011 | |
1083 | |
1012 | Return various integers describing terminal characteristics. |
1084 | Return various integers describing terminal characteristics. |
1013 | |
1085 | |
|
|
1086 | =item $x_display = $term->display_id |
|
|
1087 | |
|
|
1088 | Return the DISPLAY used by rxvt-unicode. |
|
|
1089 | |
1014 | =item $lc_ctype = $term->locale |
1090 | =item $lc_ctype = $term->locale |
1015 | |
1091 | |
1016 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1092 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1017 | |
1093 | |
1018 | =item $x_display = $term->display_id |
1094 | =item $env = $term->env |
1019 | |
1095 | |
1020 | Return the DISPLAY used by rxvt-unicode. |
1096 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1097 | similar to C<\%ENV>. |
|
|
1098 | |
|
|
1099 | =cut |
|
|
1100 | |
|
|
1101 | sub env { |
|
|
1102 | if (my $env = $_[0]->_env) { |
|
|
1103 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
|
|
1104 | } else { |
|
|
1105 | +{ %ENV } |
|
|
1106 | } |
|
|
1107 | } |
1021 | |
1108 | |
1022 | =item $modifiermask = $term->ModLevel3Mask |
1109 | =item $modifiermask = $term->ModLevel3Mask |
1023 | |
1110 | |
1024 | =item $modifiermask = $term->ModMetaMask |
1111 | =item $modifiermask = $term->ModMetaMask |
1025 | |
1112 | |
… | |
… | |
1265 | $item->{render} ||= sub { $_[0]{text} }; |
1352 | $item->{render} ||= sub { $_[0]{text} }; |
1266 | |
1353 | |
1267 | push @{ $self->{item} }, $item; |
1354 | push @{ $self->{item} }, $item; |
1268 | } |
1355 | } |
1269 | |
1356 | |
|
|
1357 | =item $popup->add_title ($title) |
|
|
1358 | |
|
|
1359 | Adds a non-clickable title to the popup. |
|
|
1360 | |
|
|
1361 | =cut |
|
|
1362 | |
|
|
1363 | sub add_title { |
|
|
1364 | my ($self, $title) = @_; |
|
|
1365 | |
|
|
1366 | $self->add_item ({ |
|
|
1367 | rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, |
|
|
1368 | text => $title, |
|
|
1369 | activate => sub { }, |
|
|
1370 | }); |
|
|
1371 | } |
|
|
1372 | |
|
|
1373 | =item $popup->add_separator ([$sepchr]) |
|
|
1374 | |
|
|
1375 | Creates a separator, optionally using the character given as C<$sepchr>. |
|
|
1376 | |
|
|
1377 | =cut |
|
|
1378 | |
1270 | sub add_separator { |
1379 | sub add_separator { |
1271 | my ($self, $sep) = @_; |
1380 | my ($self, $sep) = @_; |
1272 | |
1381 | |
1273 | $sep ||= "="; |
1382 | $sep ||= "="; |
1274 | |
1383 | |
… | |
… | |
1278 | render => sub { $sep x $self->{term}->ncol }, |
1387 | render => sub { $sep x $self->{term}->ncol }, |
1279 | activate => sub { }, |
1388 | activate => sub { }, |
1280 | }); |
1389 | }); |
1281 | } |
1390 | } |
1282 | |
1391 | |
1283 | sub add_title { |
1392 | =item $popup->add_button ($text, $cb) |
1284 | my ($self, $title) = @_; |
|
|
1285 | |
1393 | |
1286 | $self->add_item ({ |
1394 | Adds a clickable button to the popup. C<$cb> is called whenever it is |
1287 | rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, |
1395 | selected. |
1288 | text => $title, |
1396 | |
1289 | activate => sub { }, |
1397 | =cut |
1290 | }); |
|
|
1291 | } |
|
|
1292 | |
1398 | |
1293 | sub add_button { |
1399 | sub add_button { |
1294 | my ($self, $text, $cb) = @_; |
1400 | my ($self, $text, $cb) = @_; |
1295 | |
1401 | |
1296 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1402 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1297 | } |
1403 | } |
|
|
1404 | |
|
|
1405 | =item $popup->add_toggle ($text, $cb, $initial_value) |
|
|
1406 | |
|
|
1407 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1408 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1409 | argument. |
|
|
1410 | |
|
|
1411 | =cut |
1298 | |
1412 | |
1299 | sub add_toggle { |
1413 | sub add_toggle { |
1300 | my ($self, $text, $cb, $value) = @_; |
1414 | my ($self, $text, $cb, $value) = @_; |
1301 | |
1415 | |
1302 | my $item; $item = { |
1416 | my $item; $item = { |
1303 | type => "button", |
1417 | type => "button", |
1304 | text => " $text", |
1418 | text => " $text", |
1305 | value => $value, |
1419 | value => $value, |
1306 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1420 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1307 | activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, |
1421 | activate => sub { $cb->($_[1]{value} = !$_[1]{value}); }, |
1308 | }; |
1422 | }; |
1309 | |
1423 | |
1310 | $self->add_item ($item); |
1424 | $self->add_item ($item); |
1311 | } |
1425 | } |
|
|
1426 | |
|
|
1427 | =item $popup->show |
|
|
1428 | |
|
|
1429 | Displays the popup (which is initially hidden). |
|
|
1430 | |
|
|
1431 | =cut |
1312 | |
1432 | |
1313 | sub show { |
1433 | sub show { |
1314 | my ($self) = @_; |
1434 | my ($self) = @_; |
1315 | |
1435 | |
1316 | local $urxvt::popup::self = $self; |
1436 | local $urxvt::popup::self = $self; |
1317 | |
1437 | |
|
|
1438 | my $env = $self->{term}->env; |
|
|
1439 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
|
|
1440 | delete $env->{LC_ALL}; |
1318 | local $ENV{LC_ALL} = $self->{term}->locale; |
1441 | $env->{LC_CTYPE} = $self->{term}->locale; |
1319 | |
1442 | |
|
|
1443 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1320 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1444 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1321 | "--transient-for" => $self->{term}->parent, |
1445 | "--transient-for" => $self->{term}->parent, |
1322 | "-display" => $self->{term}->display_id, |
1446 | "-display" => $self->{term}->display_id, |
1323 | "-pe" => "urxvt-popup") |
1447 | "-pe" => "urxvt-popup") |
1324 | or die "unable to create popup window\n"; |
1448 | or die "unable to create popup window\n"; |
1325 | } |
1449 | } |
1326 | |
1450 | |
1327 | sub DESTROY { |
1451 | sub DESTROY { |
1328 | my ($self) = @_; |
1452 | my ($self) = @_; |
1329 | |
1453 | |
1330 | delete $self->{term}{_destroy}{$self}; |
1454 | delete $self->{term}{_destroy}{$self}; |
1331 | $self->{term}->ungrab; |
1455 | $self->{term}->ungrab; |
1332 | } |
1456 | } |
|
|
1457 | |
|
|
1458 | =back |
1333 | |
1459 | |
1334 | =head2 The C<urxvt::timer> Class |
1460 | =head2 The C<urxvt::timer> Class |
1335 | |
1461 | |
1336 | This class implements timer watchers/events. Time is represented as a |
1462 | This class implements timer watchers/events. Time is represented as a |
1337 | fractional number of seconds since the epoch. Example: |
1463 | fractional number of seconds since the epoch. Example: |