… | |
… | |
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 and further clicks). Right |
46 | urls and complete shell-quoted arguments, which is very convenient, too, |
46 | now, it tries to select words, urls and complete shell-quoted |
47 | if your F<ls> supports C<--quoting-style=shell>. |
47 | arguments, which is very convenient, too, if your F<ls> supports |
|
|
48 | C<--quoting-style=shell>. |
48 | |
49 | |
|
|
50 | A double-click usually selects the word under the cursor, further clicks |
|
|
51 | will enlarge the selection. |
|
|
52 | |
49 | It also offers the following bindable event: |
53 | It also offers the following bindable keyboard command: |
50 | |
54 | |
51 | =over 4 |
55 | =over 4 |
52 | |
56 | |
53 | =item rot13 |
57 | =item rot13 |
54 | |
58 | |
… | |
… | |
64 | runtime. |
68 | runtime. |
65 | |
69 | |
66 | =item selection-popup (enabled by default) |
70 | =item selection-popup (enabled by default) |
67 | |
71 | |
68 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
72 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
69 | text into various other formats/action. |
73 | text into various other formats/action (such as uri unescaping, perl |
|
|
74 | evalution, web-browser starting etc.), depending on content. |
70 | |
75 | |
71 | =item searchable-scrollback<hotkey> (enabled by default) |
76 | =item searchable-scrollback<hotkey> (enabled by default) |
72 | |
77 | |
73 | Adds regex search functionality to the scrollback buffer, triggered |
78 | Adds regex search functionality to the scrollback buffer, triggered |
74 | by a hotkey (default: C<M-s>). When in search mode, normal terminal |
79 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
75 | input/output is suspended. |
80 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
81 | screen. |
76 | |
82 | |
77 | C</> starts an incremental regex search, C<n> searches further, C<p> or |
83 | Inputting characters appends them to the regex and continues incremental |
78 | C<N> jump to the previous match, C<G> jumps to the bottom and clears the |
84 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
79 | history, C<enter> leaves search mode at the current position and C<escape> |
85 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
80 | returns to the original position. |
86 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
87 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
88 | additionally stores the first match in the current line into the primary |
|
|
89 | selection. |
81 | |
90 | |
82 | =item digital-clock |
91 | =item digital-clock |
83 | |
92 | |
84 | Displays a digital clock using the built-in overlay. |
93 | Displays a digital clock using the built-in overlay. |
85 | |
94 | |
86 | =item mark-urls |
95 | =item mark-urls |
87 | |
96 | |
88 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
97 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
|
|
98 | make them clickable. When middle-clicked, the program specified in the |
|
|
99 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
|
|
100 | the URL as first argument. |
89 | |
101 | |
90 | =item block-graphics-to-ascii |
102 | =item block-graphics-to-ascii |
91 | |
103 | |
92 | A not very useful example of filtering all text output to the terminal, |
104 | A not very useful example of filtering all text output to the terminal, |
93 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
105 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
… | |
… | |
98 | Displays a very simple digital clock in the upper right corner of the |
110 | Displays a very simple digital clock in the upper right corner of the |
99 | window. Illustrates overwriting the refresh callbacks to create your own |
111 | window. Illustrates overwriting the refresh callbacks to create your own |
100 | overlays or changes. |
112 | overlays or changes. |
101 | |
113 | |
102 | =back |
114 | =back |
|
|
115 | |
|
|
116 | =head1 API DOCUMENTATION |
103 | |
117 | |
104 | =head2 General API Considerations |
118 | =head2 General API Considerations |
105 | |
119 | |
106 | All objects (such as terminals, time watchers etc.) are typical |
120 | All objects (such as terminals, time watchers etc.) are typical |
107 | reference-to-hash objects. The hash can be used to store anything you |
121 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
120 | =over 4 |
134 | =over 4 |
121 | |
135 | |
122 | =item $text |
136 | =item $text |
123 | |
137 | |
124 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
138 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
125 | always represents one screen cell. See L<row_t> for a discussion of this format. |
139 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
126 | |
140 | |
127 | =item $string |
141 | =item $string |
128 | |
142 | |
129 | A perl text string, with an emphasis on I<text>. It can store all unicode |
143 | A perl text string, with an emphasis on I<text>. It can store all unicode |
130 | characters and is to be distinguished with text encoded in a specific |
144 | characters and is to be distinguished with text encoded in a specific |
… | |
… | |
225 | =item on_sel_extend $term |
239 | =item on_sel_extend $term |
226 | |
240 | |
227 | Called whenever the user tries to extend the selection (e.g. with a double |
241 | Called whenever the user tries to extend the selection (e.g. with a double |
228 | click) and is either supposed to return false (normal operation), or |
242 | click) and is either supposed to return false (normal operation), or |
229 | should extend the selection itelf and return true to suppress the built-in |
243 | should extend the selection itelf and return true to suppress the built-in |
230 | processing. |
244 | processing. This can happen multiple times, as long as the callback |
|
|
245 | returns true, it will be called on every further click by the user and is |
|
|
246 | supposed to enlarge the selection more and more, if possible. |
231 | |
247 | |
232 | See the F<selection> example extension. |
248 | See the F<selection> example extension. |
233 | |
249 | |
234 | =item on_view_change $term, $offset |
250 | =item on_view_change $term, $offset |
235 | |
251 | |
… | |
… | |
340 | |
356 | |
341 | subwindow. |
357 | subwindow. |
342 | |
358 | |
343 | =back |
359 | =back |
344 | |
360 | |
345 | =head2 Variables in the C<urxvt> Package |
|
|
346 | |
|
|
347 | =over 4 |
|
|
348 | |
|
|
349 | =item $urxvt::TERM |
|
|
350 | |
|
|
351 | The current terminal. This variable stores the current C<urxvt::term> |
|
|
352 | object, whenever a callback/hook is executing. |
|
|
353 | |
|
|
354 | =back |
|
|
355 | |
|
|
356 | =head2 Functions in the C<urxvt> Package |
|
|
357 | |
|
|
358 | =over 4 |
|
|
359 | |
|
|
360 | =item $term = new urxvt [arg...] |
|
|
361 | |
|
|
362 | Creates a new terminal, very similar as if you had started it with |
|
|
363 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
364 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
365 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
366 | C<init> and C<start> hooks will be called during the call. |
|
|
367 | |
|
|
368 | =item urxvt::fatal $errormessage |
|
|
369 | |
|
|
370 | Fatally aborts execution with the given error message. Avoid at all |
|
|
371 | costs! The only time this is acceptable is when the terminal process |
|
|
372 | starts up. |
|
|
373 | |
|
|
374 | =item urxvt::warn $string |
|
|
375 | |
|
|
376 | Calls C<rxvt_warn> with the given string which should not include a |
|
|
377 | newline. The module also overwrites the C<warn> builtin with a function |
|
|
378 | that calls this function. |
|
|
379 | |
|
|
380 | Using this function has the advantage that its output ends up in the |
|
|
381 | correct place, e.g. on stderr of the connecting urxvtc client. |
|
|
382 | |
|
|
383 | =item $is_safe = urxvt::safe |
|
|
384 | |
|
|
385 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
386 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
387 | started setuid or setgid. |
|
|
388 | |
|
|
389 | =item $time = urxvt::NOW |
|
|
390 | |
|
|
391 | Returns the "current time" (as per the event loop). |
|
|
392 | |
|
|
393 | =item urxvt::CurrentTime |
|
|
394 | |
|
|
395 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
396 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
397 | Button4Mask, Button5Mask, AnyModifier |
|
|
398 | |
|
|
399 | Various constants for use in X calls and event processing. |
|
|
400 | |
|
|
401 | =back |
|
|
402 | |
|
|
403 | =head2 RENDITION |
|
|
404 | |
|
|
405 | Rendition bitsets contain information about colour, font, font styles and |
|
|
406 | similar information for each screen cell. |
|
|
407 | |
|
|
408 | The following "macros" deal with changes in rendition sets. You should |
|
|
409 | never just create a bitset, you should always modify an existing one, |
|
|
410 | as they contain important information required for correct operation of |
|
|
411 | rxvt-unicode. |
|
|
412 | |
|
|
413 | =over 4 |
|
|
414 | |
|
|
415 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
416 | |
|
|
417 | Returns the default rendition, as used when the terminal is starting up or |
|
|
418 | being reset. Useful as a base to start when creating renditions. |
|
|
419 | |
|
|
420 | =item $rend = urxvt::OVERLAY_RSTYLE |
|
|
421 | |
|
|
422 | Return the rendition mask used for overlays by default. |
|
|
423 | |
|
|
424 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
|
|
425 | |
|
|
426 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
427 | underline, respectively. To enable such a style, just logically OR it into |
|
|
428 | the bitset. |
|
|
429 | |
|
|
430 | =item $foreground = urxvt::GET_BASEFG $rend |
|
|
431 | |
|
|
432 | =item $background = urxvt::GET_BASEBG $rend |
|
|
433 | |
|
|
434 | Return the foreground/background colour index, respectively. |
|
|
435 | |
|
|
436 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
|
|
437 | |
|
|
438 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
|
|
439 | |
|
|
440 | Replace the foreground/background colour in the rendition mask with the |
|
|
441 | specified one. |
|
|
442 | |
|
|
443 | =item $value = urxvt::GET_CUSTOM ($rend) |
|
|
444 | |
|
|
445 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
446 | extensions. They can be set and changed as you like and are initially |
|
|
447 | zero. |
|
|
448 | |
|
|
449 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
|
|
450 | |
|
|
451 | Change the custom value. |
|
|
452 | |
|
|
453 | =back |
|
|
454 | |
|
|
455 | =cut |
361 | =cut |
456 | |
362 | |
457 | package urxvt; |
363 | package urxvt; |
458 | |
364 | |
459 | use utf8; |
365 | use utf8; |
… | |
… | |
470 | |
376 | |
471 | our $LIBDIR; |
377 | our $LIBDIR; |
472 | our $RESNAME; |
378 | our $RESNAME; |
473 | our $RESCLASS; |
379 | our $RESCLASS; |
474 | our $RXVTNAME; |
380 | our $RXVTNAME; |
|
|
381 | |
|
|
382 | =head2 Variables in the C<urxvt> Package |
|
|
383 | |
|
|
384 | =over 4 |
|
|
385 | |
|
|
386 | =item $urxvt::LIBDIR |
|
|
387 | |
|
|
388 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
389 | modules and scripts are stored. |
|
|
390 | |
|
|
391 | =item $urxvt::RESCLASS, $urxvt::RESCLASS |
|
|
392 | |
|
|
393 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
394 | |
|
|
395 | =item $urxvt::RXVTNAME |
|
|
396 | |
|
|
397 | The basename of the installed binaries, usually C<urxvt>. |
|
|
398 | |
|
|
399 | =item $urxvt::TERM |
|
|
400 | |
|
|
401 | The current terminal. This variable stores the current C<urxvt::term> |
|
|
402 | object, whenever a callback/hook is executing. |
|
|
403 | |
|
|
404 | =back |
|
|
405 | |
|
|
406 | =head2 Functions in the C<urxvt> Package |
|
|
407 | |
|
|
408 | =over 4 |
|
|
409 | |
|
|
410 | =item urxvt::fatal $errormessage |
|
|
411 | |
|
|
412 | Fatally aborts execution with the given error message. Avoid at all |
|
|
413 | costs! The only time this is acceptable is when the terminal process |
|
|
414 | starts up. |
|
|
415 | |
|
|
416 | =item urxvt::warn $string |
|
|
417 | |
|
|
418 | Calls C<rxvt_warn> with the given string which should not include a |
|
|
419 | newline. The module also overwrites the C<warn> builtin with a function |
|
|
420 | that calls this function. |
|
|
421 | |
|
|
422 | Using this function has the advantage that its output ends up in the |
|
|
423 | correct place, e.g. on stderr of the connecting urxvtc client. |
|
|
424 | |
|
|
425 | Messages have a size limit of 1023 bytes currently. |
|
|
426 | |
|
|
427 | =item $is_safe = urxvt::safe |
|
|
428 | |
|
|
429 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
430 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
431 | started setuid or setgid. |
|
|
432 | |
|
|
433 | =item $time = urxvt::NOW |
|
|
434 | |
|
|
435 | Returns the "current time" (as per the event loop). |
|
|
436 | |
|
|
437 | =item urxvt::CurrentTime |
|
|
438 | |
|
|
439 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
440 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
441 | Button4Mask, Button5Mask, AnyModifier |
|
|
442 | |
|
|
443 | Various constants for use in X calls and event processing. |
|
|
444 | |
|
|
445 | =back |
|
|
446 | |
|
|
447 | =head2 RENDITION |
|
|
448 | |
|
|
449 | Rendition bitsets contain information about colour, font, font styles and |
|
|
450 | similar information for each screen cell. |
|
|
451 | |
|
|
452 | The following "macros" deal with changes in rendition sets. You should |
|
|
453 | never just create a bitset, you should always modify an existing one, |
|
|
454 | as they contain important information required for correct operation of |
|
|
455 | rxvt-unicode. |
|
|
456 | |
|
|
457 | =over 4 |
|
|
458 | |
|
|
459 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
460 | |
|
|
461 | Returns the default rendition, as used when the terminal is starting up or |
|
|
462 | being reset. Useful as a base to start when creating renditions. |
|
|
463 | |
|
|
464 | =item $rend = urxvt::OVERLAY_RSTYLE |
|
|
465 | |
|
|
466 | Return the rendition mask used for overlays by default. |
|
|
467 | |
|
|
468 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
|
|
469 | |
|
|
470 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
471 | underline, respectively. To enable such a style, just logically OR it into |
|
|
472 | the bitset. |
|
|
473 | |
|
|
474 | =item $foreground = urxvt::GET_BASEFG $rend |
|
|
475 | |
|
|
476 | =item $background = urxvt::GET_BASEBG $rend |
|
|
477 | |
|
|
478 | Return the foreground/background colour index, respectively. |
|
|
479 | |
|
|
480 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
|
|
481 | |
|
|
482 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
483 | |
|
|
484 | Replace the foreground/background colour in the rendition mask with the |
|
|
485 | specified one. |
|
|
486 | |
|
|
487 | =item $value = urxvt::GET_CUSTOM $rend |
|
|
488 | |
|
|
489 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
490 | extensions. They can be set and changed as you like and are initially |
|
|
491 | zero. |
|
|
492 | |
|
|
493 | =item $rend = urxvt::SET_CUSTOM $rend, $new_value |
|
|
494 | |
|
|
495 | Change the custom value. |
|
|
496 | |
|
|
497 | =back |
|
|
498 | |
|
|
499 | =cut |
475 | |
500 | |
476 | BEGIN { |
501 | BEGIN { |
477 | urxvt->bootstrap; |
502 | urxvt->bootstrap; |
478 | |
503 | |
479 | # overwrite perl's warn |
504 | # overwrite perl's warn |
… | |
… | |
482 | $msg .= "\n" |
507 | $msg .= "\n" |
483 | unless $msg =~ /\n$/; |
508 | unless $msg =~ /\n$/; |
484 | urxvt::warn ($msg); |
509 | urxvt::warn ($msg); |
485 | }; |
510 | }; |
486 | |
511 | |
|
|
512 | # %ENV is the original startup environment |
487 | delete $ENV{IFS}; |
513 | delete $ENV{IFS}; |
488 | delete $ENV{CDPATH}; |
514 | delete $ENV{CDPATH}; |
489 | delete $ENV{BASH_ENV}; |
515 | delete $ENV{BASH_ENV}; |
490 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
516 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
491 | } |
517 | } |
… | |
… | |
580 | if ($@) { |
606 | if ($@) { |
581 | $TERM->ungrab; # better to lose the grab than the session |
607 | $TERM->ungrab; # better to lose the grab than the session |
582 | warn $@; |
608 | warn $@; |
583 | } |
609 | } |
584 | } |
610 | } |
|
|
611 | |
|
|
612 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
613 | if $verbosity >= 11; |
585 | } |
614 | } |
586 | |
615 | |
587 | if ($htype == 1) { # DESTROY |
616 | if ($htype == 1) { # DESTROY |
588 | if (my $hook = delete $TERM->{_hook}) { |
617 | if (my $hook = delete $TERM->{_hook}) { |
589 | for my $htype (0..$#$hook) { |
618 | for my $htype (0..$#$hook) { |
… | |
… | |
600 | } |
629 | } |
601 | |
630 | |
602 | $retval |
631 | $retval |
603 | } |
632 | } |
604 | |
633 | |
|
|
634 | sub exec_async(@) { |
|
|
635 | my $pid = fork; |
|
|
636 | |
|
|
637 | return |
|
|
638 | if !defined $pid or $pid; |
|
|
639 | |
|
|
640 | %ENV = %{ $TERM->env }; |
|
|
641 | |
|
|
642 | exec @_; |
|
|
643 | _exit 255; |
|
|
644 | } |
|
|
645 | |
605 | # urxvt::term::extension |
646 | # urxvt::term::extension |
606 | |
647 | |
607 | package urxvt::term::extension; |
648 | package urxvt::term::extension; |
608 | |
649 | |
609 | sub enable { |
650 | sub enable { |
… | |
… | |
675 | |
716 | |
676 | =head2 The C<urxvt::anyevent> Class |
717 | =head2 The C<urxvt::anyevent> Class |
677 | |
718 | |
678 | The sole purpose of this class is to deliver an interface to the |
719 | The sole purpose of this class is to deliver an interface to the |
679 | C<AnyEvent> module - any module using it will work inside urxvt without |
720 | C<AnyEvent> module - any module using it will work inside urxvt without |
680 | further work. The only exception is that you cannot wait on condition |
721 | further programming. The only exception is that you cannot wait on |
681 | variables, but non-blocking condvar use is ok. What this means is that you |
722 | condition variables, but non-blocking condvar use is ok. What this means |
682 | cannot use blocking APIs, but the non-blocking variant should work. |
723 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
724 | work. |
683 | |
725 | |
684 | =cut |
726 | =cut |
685 | |
727 | |
686 | our $VERSION = 1; |
728 | our $VERSION = 1; |
687 | |
729 | |
… | |
… | |
764 | $proxy->enable ($name => $ref); |
806 | $proxy->enable ($name => $ref); |
765 | } |
807 | } |
766 | } |
808 | } |
767 | } |
809 | } |
768 | |
810 | |
|
|
811 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
|
|
812 | |
|
|
813 | Creates a new terminal, very similar as if you had started it with system |
|
|
814 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
|
|
815 | hash which defines the environment of the new terminal. |
|
|
816 | |
|
|
817 | Croaks (and probably outputs an error message) if the new instance |
|
|
818 | couldn't be created. Returns C<undef> if the new instance didn't |
|
|
819 | initialise perl, and the terminal object otherwise. The C<init> and |
|
|
820 | C<start> hooks will be called during this call. |
|
|
821 | |
|
|
822 | =cut |
|
|
823 | |
|
|
824 | sub new { |
|
|
825 | my ($class, $env, @args) = @_; |
|
|
826 | |
|
|
827 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
|
|
828 | } |
|
|
829 | |
769 | =item $term->destroy |
830 | =item $term->destroy |
770 | |
831 | |
771 | Destroy the terminal object (close the window, free resources etc.). |
832 | Destroy the terminal object (close the window, free resources |
|
|
833 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
|
|
834 | watchers (timers, io watchers) are still active. |
772 | |
835 | |
773 | =item $isset = $term->option ($optval[, $set]) |
836 | =item $isset = $term->option ($optval[, $set]) |
774 | |
837 | |
775 | Returns true if the option specified by C<$optval> is enabled, and |
838 | Returns true if the option specified by C<$optval> is enabled, and |
776 | optionally change it. All option values are stored by name in the hash |
839 | optionally change it. All option values are stored by name in the hash |
… | |
… | |
826 | my ($self, $name) = (shift, shift); |
889 | my ($self, $name) = (shift, shift); |
827 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
890 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
828 | &urxvt::term::_resource |
891 | &urxvt::term::_resource |
829 | } |
892 | } |
830 | |
893 | |
|
|
894 | =item $value = $term->x_resource ($pattern) |
|
|
895 | |
|
|
896 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
897 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
|
|
898 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
|
|
899 | resource with that pattern exists. |
|
|
900 | |
|
|
901 | This method should only be called during the C<on_start> hook, as there is |
|
|
902 | only one resource database per display, and later invocations might return |
|
|
903 | the wrong resources. |
|
|
904 | |
831 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
905 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
832 | |
906 | |
833 | Adds a keymap translation exactly as specified via a resource. See the |
907 | Adds a keymap translation exactly as specified via a resource. See the |
834 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
908 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
835 | |
909 | |
… | |
… | |
850 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
924 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
851 | |
925 | |
852 | Return the current values of the selection mark, begin or end positions, |
926 | Return the current values of the selection mark, begin or end positions, |
853 | and optionally set them to new values. |
927 | and optionally set them to new values. |
854 | |
928 | |
|
|
929 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
930 | |
|
|
931 | Tries to make a selection as set by C<selection_beg> and |
|
|
932 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
933 | rectangular selection will be made. This is the prefered function to make |
|
|
934 | a selection. |
|
|
935 | |
855 | =item $success = $term->selection_grab ($eventtime) |
936 | =item $success = $term->selection_grab ($eventtime) |
856 | |
937 | |
857 | Try to request the primary selection from the server (for example, as set |
938 | Try to request the primary selection text from the server (for example, as |
858 | by the next method). |
939 | set by the next method). No visual feedback will be given. This function |
|
|
940 | is mostly useful from within C<on_sel_grab> hooks. |
859 | |
941 | |
860 | =item $oldtext = $term->selection ([$newtext]) |
942 | =item $oldtext = $term->selection ([$newtext]) |
861 | |
943 | |
862 | Return the current selection text and optionally replace it by C<$newtext>. |
944 | Return the current selection text and optionally replace it by C<$newtext>. |
863 | |
945 | |
… | |
… | |
956 | Convert the given locale-encoded octets into a perl string. |
1038 | Convert the given locale-encoded octets into a perl string. |
957 | |
1039 | |
958 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1040 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
959 | |
1041 | |
960 | XORs the rendition values in the given span with the provided value |
1042 | XORs the rendition values in the given span with the provided value |
961 | (default: C<RS_RVid>). Useful in refresh hooks to provide effects similar |
1043 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
962 | to the selection. |
1044 | refresh hooks to provide effects similar to the selection. |
963 | |
1045 | |
964 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1046 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
965 | |
1047 | |
966 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1048 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
967 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1049 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
968 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1050 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
969 | it instead. |
1051 | it instead. Both styles I<MUST NOT> contain font styles. |
970 | |
1052 | |
971 | =item $term->scr_bell |
1053 | =item $term->scr_bell |
972 | |
1054 | |
973 | Ring the bell! |
1055 | Ring the bell! |
974 | |
1056 | |
… | |
… | |
1034 | |
1116 | |
1035 | =item $lines_in_scrollback = $term->nsaved |
1117 | =item $lines_in_scrollback = $term->nsaved |
1036 | |
1118 | |
1037 | Return various integers describing terminal characteristics. |
1119 | Return various integers describing terminal characteristics. |
1038 | |
1120 | |
|
|
1121 | =item $x_display = $term->display_id |
|
|
1122 | |
|
|
1123 | Return the DISPLAY used by rxvt-unicode. |
|
|
1124 | |
1039 | =item $lc_ctype = $term->locale |
1125 | =item $lc_ctype = $term->locale |
1040 | |
1126 | |
1041 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1127 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1042 | |
1128 | |
1043 | =item $x_display = $term->display_id |
1129 | =item $env = $term->env |
1044 | |
1130 | |
1045 | Return the DISPLAY used by rxvt-unicode. |
1131 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1132 | similar to C<\%ENV>. |
|
|
1133 | |
|
|
1134 | =cut |
|
|
1135 | |
|
|
1136 | sub env { |
|
|
1137 | if (my $env = $_[0]->_env) { |
|
|
1138 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
|
|
1139 | } else { |
|
|
1140 | +{ %ENV } |
|
|
1141 | } |
|
|
1142 | } |
1046 | |
1143 | |
1047 | =item $modifiermask = $term->ModLevel3Mask |
1144 | =item $modifiermask = $term->ModLevel3Mask |
1048 | |
1145 | |
1049 | =item $modifiermask = $term->ModMetaMask |
1146 | =item $modifiermask = $term->ModMetaMask |
1050 | |
1147 | |
… | |
… | |
1143 | Return the row number of the first/last row of the line, respectively. |
1240 | Return the row number of the first/last row of the line, respectively. |
1144 | |
1241 | |
1145 | =item $offset = $line->offset_of ($row, $col) |
1242 | =item $offset = $line->offset_of ($row, $col) |
1146 | |
1243 | |
1147 | Returns the character offset of the given row|col pair within the logical |
1244 | Returns the character offset of the given row|col pair within the logical |
1148 | line. |
1245 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1246 | offsets outside the string. |
1149 | |
1247 | |
1150 | =item ($row, $col) = $line->coord_of ($offset) |
1248 | =item ($row, $col) = $line->coord_of ($offset) |
1151 | |
1249 | |
1152 | Translates a string offset into terminal coordinates again. |
1250 | Translates a string offset into terminal coordinates again. |
1153 | |
1251 | |
… | |
… | |
1290 | $item->{render} ||= sub { $_[0]{text} }; |
1388 | $item->{render} ||= sub { $_[0]{text} }; |
1291 | |
1389 | |
1292 | push @{ $self->{item} }, $item; |
1390 | push @{ $self->{item} }, $item; |
1293 | } |
1391 | } |
1294 | |
1392 | |
|
|
1393 | =item $popup->add_title ($title) |
|
|
1394 | |
|
|
1395 | Adds a non-clickable title to the popup. |
|
|
1396 | |
|
|
1397 | =cut |
|
|
1398 | |
|
|
1399 | sub add_title { |
|
|
1400 | my ($self, $title) = @_; |
|
|
1401 | |
|
|
1402 | $self->add_item ({ |
|
|
1403 | rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, |
|
|
1404 | text => $title, |
|
|
1405 | activate => sub { }, |
|
|
1406 | }); |
|
|
1407 | } |
|
|
1408 | |
|
|
1409 | =item $popup->add_separator ([$sepchr]) |
|
|
1410 | |
|
|
1411 | Creates a separator, optionally using the character given as C<$sepchr>. |
|
|
1412 | |
|
|
1413 | =cut |
|
|
1414 | |
1295 | sub add_separator { |
1415 | sub add_separator { |
1296 | my ($self, $sep) = @_; |
1416 | my ($self, $sep) = @_; |
1297 | |
1417 | |
1298 | $sep ||= "="; |
1418 | $sep ||= "="; |
1299 | |
1419 | |
… | |
… | |
1303 | render => sub { $sep x $self->{term}->ncol }, |
1423 | render => sub { $sep x $self->{term}->ncol }, |
1304 | activate => sub { }, |
1424 | activate => sub { }, |
1305 | }); |
1425 | }); |
1306 | } |
1426 | } |
1307 | |
1427 | |
1308 | sub add_title { |
1428 | =item $popup->add_button ($text, $cb) |
1309 | my ($self, $title) = @_; |
|
|
1310 | |
1429 | |
1311 | $self->add_item ({ |
1430 | Adds a clickable button to the popup. C<$cb> is called whenever it is |
1312 | rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, |
1431 | selected. |
1313 | text => $title, |
1432 | |
1314 | activate => sub { }, |
1433 | =cut |
1315 | }); |
|
|
1316 | } |
|
|
1317 | |
1434 | |
1318 | sub add_button { |
1435 | sub add_button { |
1319 | my ($self, $text, $cb) = @_; |
1436 | my ($self, $text, $cb) = @_; |
1320 | |
1437 | |
1321 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1438 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1322 | } |
1439 | } |
|
|
1440 | |
|
|
1441 | =item $popup->add_toggle ($text, $cb, $initial_value) |
|
|
1442 | |
|
|
1443 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1444 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1445 | argument. |
|
|
1446 | |
|
|
1447 | =cut |
1323 | |
1448 | |
1324 | sub add_toggle { |
1449 | sub add_toggle { |
1325 | my ($self, $text, $cb, $value) = @_; |
1450 | my ($self, $text, $cb, $value) = @_; |
1326 | |
1451 | |
1327 | my $item; $item = { |
1452 | my $item; $item = { |
1328 | type => "button", |
1453 | type => "button", |
1329 | text => " $text", |
1454 | text => " $text", |
1330 | value => $value, |
1455 | value => $value, |
1331 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1456 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1332 | activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, |
1457 | activate => sub { $cb->($_[1]{value} = !$_[1]{value}); }, |
1333 | }; |
1458 | }; |
1334 | |
1459 | |
1335 | $self->add_item ($item); |
1460 | $self->add_item ($item); |
1336 | } |
1461 | } |
|
|
1462 | |
|
|
1463 | =item $popup->show |
|
|
1464 | |
|
|
1465 | Displays the popup (which is initially hidden). |
|
|
1466 | |
|
|
1467 | =cut |
1337 | |
1468 | |
1338 | sub show { |
1469 | sub show { |
1339 | my ($self) = @_; |
1470 | my ($self) = @_; |
1340 | |
1471 | |
1341 | local $urxvt::popup::self = $self; |
1472 | local $urxvt::popup::self = $self; |
1342 | |
1473 | |
|
|
1474 | my $env = $self->{term}->env; |
|
|
1475 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
|
|
1476 | delete $env->{LC_ALL}; |
1343 | local $ENV{LC_ALL} = $self->{term}->locale; |
1477 | $env->{LC_CTYPE} = $self->{term}->locale; |
1344 | |
1478 | |
|
|
1479 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1345 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1480 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1346 | "--transient-for" => $self->{term}->parent, |
1481 | "--transient-for" => $self->{term}->parent, |
1347 | "-display" => $self->{term}->display_id, |
1482 | "-display" => $self->{term}->display_id, |
1348 | "-pe" => "urxvt-popup") |
1483 | "-pe" => "urxvt-popup") |
1349 | or die "unable to create popup window\n"; |
1484 | or die "unable to create popup window\n"; |
1350 | } |
1485 | } |
1351 | |
1486 | |
1352 | sub DESTROY { |
1487 | sub DESTROY { |
1353 | my ($self) = @_; |
1488 | my ($self) = @_; |
1354 | |
1489 | |
1355 | delete $self->{term}{_destroy}{$self}; |
1490 | delete $self->{term}{_destroy}{$self}; |
1356 | $self->{term}->ungrab; |
1491 | $self->{term}->ungrab; |
1357 | } |
1492 | } |
|
|
1493 | |
|
|
1494 | =back |
1358 | |
1495 | |
1359 | =head2 The C<urxvt::timer> Class |
1496 | =head2 The C<urxvt::timer> Class |
1360 | |
1497 | |
1361 | This class implements timer watchers/events. Time is represented as a |
1498 | This class implements timer watchers/events. Time is represented as a |
1362 | fractional number of seconds since the epoch. Example: |
1499 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1469 | |
1606 | |
1470 | =item == 0 - fatal messages |
1607 | =item == 0 - fatal messages |
1471 | |
1608 | |
1472 | =item >= 3 - script loading and management |
1609 | =item >= 3 - script loading and management |
1473 | |
1610 | |
1474 | =item >=10 - all events received |
1611 | =item >=10 - all called hooks |
|
|
1612 | |
|
|
1613 | =item >=11 - hook reutrn values |
1475 | |
1614 | |
1476 | =back |
1615 | =back |
1477 | |
1616 | |
1478 | =head1 AUTHOR |
1617 | =head1 AUTHOR |
1479 | |
1618 | |