… | |
… | |
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 | Or by adding them to the resource for extensions loaded by default: |
|
|
41 | |
|
|
42 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
|
|
43 | |
40 | =over 4 |
44 | =over 4 |
41 | |
45 | |
42 | =item selection (enabled by default) |
46 | =item selection (enabled by default) |
43 | |
47 | |
44 | (More) intelligent selection. This extension tries to be more intelligent |
48 | (More) intelligent selection. This extension tries to be more intelligent |
45 | when the user extends selections (double-click). Right now, it tries to |
49 | when the user extends selections (double-click and further clicks). Right |
46 | select urls and complete shell-quoted arguments, which is very convenient, |
50 | now, it tries to select words, urls and complete shell-quoted |
47 | too, if your F<ls> supports C<--quoting-style=shell>. |
51 | arguments, which is very convenient, too, if your F<ls> supports |
|
|
52 | C<--quoting-style=shell>. |
48 | |
53 | |
|
|
54 | A double-click usually selects the word under the cursor, further clicks |
|
|
55 | will enlarge the selection. |
|
|
56 | |
|
|
57 | The selection works by trying to match a number of regexes and displaying |
|
|
58 | them in increasing order of length. You can add your own regexes by |
|
|
59 | specifying resources of the form: |
|
|
60 | |
|
|
61 | URxvt.selection.pattern-0: perl-regex |
|
|
62 | URxvt.selection.pattern-1: perl-regex |
|
|
63 | ... |
|
|
64 | |
|
|
65 | The index number (0, 1...) must not have any holes, and each regex must |
|
|
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 |
|
|
68 | between two vertical bars: |
|
|
69 | |
|
|
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
71 | |
|
|
72 | 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. |
|
|
74 | |
49 | It also offers the following bindable keyboard command: |
75 | This extension also offers following bindable keyboard commands: |
50 | |
76 | |
51 | =over 4 |
77 | =over 4 |
52 | |
78 | |
53 | =item rot13 |
79 | =item rot13 |
54 | |
80 | |
… | |
… | |
67 | |
93 | |
68 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
94 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
69 | text into various other formats/action (such as uri unescaping, perl |
95 | text into various other formats/action (such as uri unescaping, perl |
70 | evalution, web-browser starting etc.), depending on content. |
96 | evalution, web-browser starting etc.), depending on content. |
71 | |
97 | |
|
|
98 | Other extensions can extend this popup menu by pushing a code reference |
|
|
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
|
|
100 | popup is displayed. |
|
|
101 | |
|
|
102 | It's sole argument is the popup menu, which can be modified. The selection |
|
|
103 | is in C<$_>, which can be used to decide wether to add something or not. |
|
|
104 | It should either return nothing or a string and a code reference. The |
|
|
105 | string will be used as button text and the code reference will be called |
|
|
106 | when the button gets activated and should transform C<$_>. |
|
|
107 | |
|
|
108 | The following will add an entry C<a to b> that transforms all C<a>s in |
|
|
109 | the selection to C<b>s, but only if the selection currently contains any |
|
|
110 | C<a>s: |
|
|
111 | |
|
|
112 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
113 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
114 | : () |
|
|
115 | }; |
|
|
116 | |
72 | =item searchable-scrollback<hotkey> (enabled by default) |
117 | =item searchable-scrollback<hotkey> (enabled by default) |
73 | |
118 | |
74 | Adds regex search functionality to the scrollback buffer, triggered |
119 | Adds regex search functionality to the scrollback buffer, triggered |
75 | by a hotkey (default: C<M-s>). When in search mode, normal terminal |
120 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
76 | input/output is suspended. |
121 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
122 | screen. |
77 | |
123 | |
78 | C</> starts an incremental regex search, C<n> searches further, C<p> or |
124 | Inputting characters appends them to the regex and continues incremental |
79 | C<N> jump to the previous match, C<G> jumps to the bottom and clears the |
125 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
80 | history, C<enter> leaves search mode at the current position and C<escape> |
126 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
81 | returns to the original position. |
127 | 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 |
|
|
129 | additionally stores the first match in the current line into the primary |
|
|
130 | selection. |
82 | |
131 | |
83 | =item digital-clock |
132 | =item selection-autotransform |
84 | |
133 | |
85 | Displays a digital clock using the built-in overlay. |
134 | This selection allows you to do automatic transforms on a selection |
|
|
135 | whenever a selection is made. |
|
|
136 | |
|
|
137 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
138 | operator) that modify C<$_> as resources: |
|
|
139 | |
|
|
140 | URxvt.selection-autotransform.0: transform |
|
|
141 | URxvt.selection-autotransform.1: transform |
|
|
142 | ... |
|
|
143 | |
|
|
144 | For example, the following will transform selections of the form |
|
|
145 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
146 | $word>: |
|
|
147 | |
|
|
148 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
149 | |
|
|
150 | And this example matches the same,but replaces it with vi-commands you can |
|
|
151 | paste directly into your (vi :) editor: |
|
|
152 | |
|
|
153 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
154 | |
|
|
155 | Of course, this can be modified to suit your needs and your editor :) |
|
|
156 | |
|
|
157 | To expand the example above to typical perl error messages ("XXX at |
|
|
158 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
159 | |
|
|
160 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
161 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
162 | |
|
|
163 | The first line tells the selection code to treat the unchanging part of |
|
|
164 | every error message as a selection pattern, and the second line transforms |
|
|
165 | the message into vi commands to load the file. |
86 | |
166 | |
87 | =item mark-urls |
167 | =item mark-urls |
88 | |
168 | |
89 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
169 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
90 | make them clickable. When middle-clicked, the program specified in the |
170 | make them clickable. When middle-clicked, the program specified in the |
91 | resource C<urlLauncher> (default C<x-www-browser>) will be started. |
171 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
|
|
172 | the URL as first argument. |
|
|
173 | |
|
|
174 | =item automove-background |
|
|
175 | |
|
|
176 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
177 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
178 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
179 | |
|
|
180 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
92 | |
181 | |
93 | =item block-graphics-to-ascii |
182 | =item block-graphics-to-ascii |
94 | |
183 | |
95 | A not very useful example of filtering all text output to the terminal, |
184 | A not very useful example of filtering all text output to the terminal, |
96 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
185 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
97 | similar-looking ascii character. |
186 | similar-looking ascii character. |
98 | |
187 | |
|
|
188 | =item digital-clock |
|
|
189 | |
|
|
190 | Displays a digital clock using the built-in overlay. |
|
|
191 | |
99 | =item example-refresh-hooks |
192 | =item example-refresh-hooks |
100 | |
193 | |
101 | Displays a very simple digital clock in the upper right corner of the |
194 | Displays a very simple digital clock in the upper right corner of the |
102 | window. Illustrates overwriting the refresh callbacks to create your own |
195 | window. Illustrates overwriting the refresh callbacks to create your own |
103 | overlays or changes. |
196 | overlays or changes. |
|
|
197 | |
|
|
198 | =item selection-pastebin |
|
|
199 | |
|
|
200 | This is a little rarely useful extension that Uploads the selection as |
|
|
201 | textfile to a remote site (or does other things). (The implementation is |
|
|
202 | not currently secure for use in a multiuser environment as it writes to |
|
|
203 | F</tmp> directly.). |
|
|
204 | |
|
|
205 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
206 | i.e. |
|
|
207 | |
|
|
208 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
209 | |
|
|
210 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
211 | the textfile. This command can be set via a resource: |
|
|
212 | |
|
|
213 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
214 | |
|
|
215 | And the default is likely not useful to anybody but the few people around |
|
|
216 | here :) |
|
|
217 | |
|
|
218 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
219 | the same content should lead to the same filename. |
|
|
220 | |
|
|
221 | After a successful upload the selection will be replaced by the text given |
|
|
222 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
223 | for the filename): |
|
|
224 | |
|
|
225 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
104 | |
226 | |
105 | =back |
227 | =back |
106 | |
228 | |
107 | =head1 API DOCUMENTATION |
229 | =head1 API DOCUMENTATION |
108 | |
230 | |
… | |
… | |
208 | =item on_start $term |
330 | =item on_start $term |
209 | |
331 | |
210 | Called at the very end of initialisation of a new terminal, just before |
332 | Called at the very end of initialisation of a new terminal, just before |
211 | returning to the mainloop. |
333 | returning to the mainloop. |
212 | |
334 | |
|
|
335 | =item on_child_start $term, $pid |
|
|
336 | |
|
|
337 | Called just after the child process has been C<fork>ed. |
|
|
338 | |
|
|
339 | =item on_child_exit $term, $status |
|
|
340 | |
|
|
341 | Called just after the child process has exited. C<$status> is the status |
|
|
342 | from C<waitpid>. |
|
|
343 | |
213 | =item on_sel_make $term, $eventtime |
344 | =item on_sel_make $term, $eventtime |
214 | |
345 | |
215 | Called whenever a selection has been made by the user, but before the |
346 | Called whenever a selection has been made by the user, but before the |
216 | selection text is copied, so changes to the beginning, end or type of the |
347 | selection text is copied, so changes to the beginning, end or type of the |
217 | selection will be honored. |
348 | selection will be honored. |
… | |
… | |
230 | =item on_sel_extend $term |
361 | =item on_sel_extend $term |
231 | |
362 | |
232 | Called whenever the user tries to extend the selection (e.g. with a double |
363 | Called whenever the user tries to extend the selection (e.g. with a double |
233 | click) and is either supposed to return false (normal operation), or |
364 | click) and is either supposed to return false (normal operation), or |
234 | should extend the selection itelf and return true to suppress the built-in |
365 | should extend the selection itelf and return true to suppress the built-in |
235 | processing. |
366 | processing. This can happen multiple times, as long as the callback |
|
|
367 | returns true, it will be called on every further click by the user and is |
|
|
368 | supposed to enlarge the selection more and more, if possible. |
236 | |
369 | |
237 | See the F<selection> example extension. |
370 | See the F<selection> example extension. |
238 | |
371 | |
239 | =item on_view_change $term, $offset |
372 | =item on_view_change $term, $offset |
240 | |
373 | |
… | |
… | |
307 | |
440 | |
308 | Called whenever the user presses a key combination that has a |
441 | Called whenever the user presses a key combination that has a |
309 | C<perl:string> action bound to it (see description of the B<keysym> |
442 | C<perl:string> action bound to it (see description of the B<keysym> |
310 | resource in the @@RXVT_NAME@@(1) manpage). |
443 | resource in the @@RXVT_NAME@@(1) manpage). |
311 | |
444 | |
|
|
445 | =item on_x_event $term, $event |
|
|
446 | |
|
|
447 | Called on every X event received on the vt window (and possibly other |
|
|
448 | windows). Should only be used as a last resort. Most event structure |
|
|
449 | members are not passed. |
|
|
450 | |
312 | =item on_focus_in $term |
451 | =item on_focus_in $term |
313 | |
452 | |
314 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
453 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
315 | does focus in processing. |
454 | does focus in processing. |
316 | |
455 | |
317 | =item on_focus_out $term |
456 | =item on_focus_out $term |
318 | |
457 | |
319 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
458 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
320 | focus out processing. |
459 | focus out processing. |
|
|
460 | |
|
|
461 | =item on_configure_notify $term, $event |
321 | |
462 | |
322 | =item on_key_press $term, $event, $keysym, $octets |
463 | =item on_key_press $term, $event, $keysym, $octets |
323 | |
464 | |
324 | =item on_key_release $term, $event, $keysym |
465 | =item on_key_release $term, $event, $keysym |
325 | |
466 | |
… | |
… | |
411 | Using this function has the advantage that its output ends up in the |
552 | 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. |
553 | correct place, e.g. on stderr of the connecting urxvtc client. |
413 | |
554 | |
414 | Messages have a size limit of 1023 bytes currently. |
555 | Messages have a size limit of 1023 bytes currently. |
415 | |
556 | |
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 |
557 | =item $time = urxvt::NOW |
423 | |
558 | |
424 | Returns the "current time" (as per the event loop). |
559 | Returns the "current time" (as per the event loop). |
425 | |
560 | |
426 | =item urxvt::CurrentTime |
561 | =item urxvt::CurrentTime |
427 | |
562 | |
428 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
563 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
429 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
564 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
430 | Button4Mask, Button5Mask, AnyModifier |
565 | Button4Mask, Button5Mask, AnyModifier |
|
|
566 | |
|
|
567 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
568 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
569 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
570 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
571 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
572 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
573 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
574 | |
|
|
575 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
576 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
577 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
578 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
579 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
580 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
581 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
431 | |
582 | |
432 | Various constants for use in X calls and event processing. |
583 | Various constants for use in X calls and event processing. |
433 | |
584 | |
434 | =back |
585 | =back |
435 | |
586 | |
… | |
… | |
486 | =back |
637 | =back |
487 | |
638 | |
488 | =cut |
639 | =cut |
489 | |
640 | |
490 | BEGIN { |
641 | BEGIN { |
491 | urxvt->bootstrap; |
|
|
492 | |
|
|
493 | # overwrite perl's warn |
642 | # overwrite perl's warn |
494 | *CORE::GLOBAL::warn = sub { |
643 | *CORE::GLOBAL::warn = sub { |
495 | my $msg = join "", @_; |
644 | my $msg = join "", @_; |
496 | $msg .= "\n" |
645 | $msg .= "\n" |
497 | unless $msg =~ /\n$/; |
646 | unless $msg =~ /\n$/; |
498 | urxvt::warn ($msg); |
647 | urxvt::warn ($msg); |
499 | }; |
648 | }; |
500 | |
|
|
501 | # %ENV is the original startup environment |
|
|
502 | delete $ENV{IFS}; |
|
|
503 | delete $ENV{CDPATH}; |
|
|
504 | delete $ENV{BASH_ENV}; |
|
|
505 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
506 | } |
649 | } |
507 | |
650 | |
508 | my @hook_count; |
|
|
509 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
651 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
510 | |
652 | |
511 | sub verbose { |
653 | sub verbose { |
512 | my ($level, $msg) = @_; |
654 | my ($level, $msg) = @_; |
513 | warn "$msg\n" if $level <= $verbosity; |
655 | warn "$msg\n" if $level <= $verbosity; |
514 | } |
656 | } |
515 | |
657 | |
516 | my $extension_pkg = "extension0000"; |
|
|
517 | my %extension_pkg; |
658 | my %extension_pkg; |
518 | |
659 | |
519 | # load a single script into its own package, once only |
660 | # load a single script into its own package, once only |
520 | sub extension_package($) { |
661 | sub extension_package($) { |
521 | my ($path) = @_; |
662 | my ($path) = @_; |
522 | |
663 | |
|
|
664 | no strict 'refs'; |
|
|
665 | |
523 | $extension_pkg{$path} ||= do { |
666 | $extension_pkg{$path} ||= do { |
524 | my $pkg = "urxvt::" . ($extension_pkg++); |
667 | $path =~ /([^\/\\]+)$/; |
|
|
668 | my $pkg = $1; |
|
|
669 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
670 | $pkg = "urxvt::ext::$pkg"; |
525 | |
671 | |
526 | verbose 3, "loading extension '$path' into package '$pkg'"; |
672 | verbose 3, "loading extension '$path' into package '$pkg'"; |
527 | |
673 | |
528 | open my $fh, "<:raw", $path |
674 | open my $fh, "<:raw", $path |
529 | or die "$path: $!"; |
675 | or die "$path: $!"; |
530 | |
676 | |
|
|
677 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
678 | |
531 | my $source = untaint |
679 | my $source = |
532 | "package $pkg; use strict; use utf8;\n" |
680 | "package $pkg; use strict; use utf8;\n" |
533 | . "use base urxvt::term::extension::;\n" |
|
|
534 | . "#line 1 \"$path\"\n{\n" |
681 | . "#line 1 \"$path\"\n{\n" |
535 | . (do { local $/; <$fh> }) |
682 | . (do { local $/; <$fh> }) |
536 | . "\n};\n1"; |
683 | . "\n};\n1"; |
537 | |
684 | |
538 | eval $source |
685 | eval $source |
… | |
… | |
595 | if ($@) { |
742 | if ($@) { |
596 | $TERM->ungrab; # better to lose the grab than the session |
743 | $TERM->ungrab; # better to lose the grab than the session |
597 | warn $@; |
744 | warn $@; |
598 | } |
745 | } |
599 | } |
746 | } |
|
|
747 | |
|
|
748 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
749 | if $verbosity >= 11; |
600 | } |
750 | } |
601 | |
751 | |
602 | if ($htype == 1) { # DESTROY |
752 | if ($htype == 1) { # DESTROY |
603 | if (my $hook = delete $TERM->{_hook}) { |
|
|
604 | for my $htype (0..$#$hook) { |
|
|
605 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
606 | or set_should_invoke $htype, 0; |
|
|
607 | } |
|
|
608 | } |
|
|
609 | |
|
|
610 | # clear package objects |
753 | # clear package objects |
611 | %$_ = () for values %{ $TERM->{_pkg} }; |
754 | %$_ = () for values %{ $TERM->{_pkg} }; |
612 | |
755 | |
613 | # clear package |
756 | # clear package |
614 | %$TERM = (); |
757 | %$TERM = (); |
… | |
… | |
628 | while (my ($name, $cb) = each %hook) { |
771 | while (my ($name, $cb) = each %hook) { |
629 | my $htype = $HOOKTYPE{uc $name}; |
772 | my $htype = $HOOKTYPE{uc $name}; |
630 | defined $htype |
773 | defined $htype |
631 | or Carp::croak "unsupported hook type '$name'"; |
774 | or Carp::croak "unsupported hook type '$name'"; |
632 | |
775 | |
|
|
776 | $self->set_should_invoke ($htype, +1) |
633 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
777 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
634 | $hook_count[$htype]++ |
|
|
635 | or urxvt::set_should_invoke $htype, 1; |
|
|
636 | } |
|
|
637 | |
778 | |
638 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
779 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
639 | } |
780 | } |
640 | } |
781 | } |
641 | |
782 | |
… | |
… | |
646 | for my $name (@hook) { |
787 | for my $name (@hook) { |
647 | my $htype = $HOOKTYPE{uc $name}; |
788 | my $htype = $HOOKTYPE{uc $name}; |
648 | defined $htype |
789 | defined $htype |
649 | or Carp::croak "unsupported hook type '$name'"; |
790 | or Carp::croak "unsupported hook type '$name'"; |
650 | |
791 | |
|
|
792 | $self->set_should_invoke ($htype, -1) |
651 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
793 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
652 | --$hook_count[$htype] |
|
|
653 | or urxvt::set_should_invoke $htype, 0; |
|
|
654 | } |
|
|
655 | } |
794 | } |
656 | } |
795 | } |
657 | |
796 | |
658 | our $AUTOLOAD; |
797 | our $AUTOLOAD; |
659 | |
798 | |
… | |
… | |
805 | |
944 | |
806 | Destroy the terminal object (close the window, free resources |
945 | Destroy the terminal object (close the window, free resources |
807 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
946 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
808 | watchers (timers, io watchers) are still active. |
947 | watchers (timers, io watchers) are still active. |
809 | |
948 | |
|
|
949 | =item $term->exec_async ($cmd[, @args]) |
|
|
950 | |
|
|
951 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
952 | ("starts") programs in the background. This function takes care of setting |
|
|
953 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
954 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
955 | |
|
|
956 | Returns the pid of the subprocess or C<undef> on error. |
|
|
957 | |
|
|
958 | =cut |
|
|
959 | |
|
|
960 | sub exec_async { |
|
|
961 | my $self = shift; |
|
|
962 | |
|
|
963 | my $pid = fork; |
|
|
964 | |
|
|
965 | return $pid |
|
|
966 | if !defined $pid or $pid; |
|
|
967 | |
|
|
968 | %ENV = %{ $self->env }; |
|
|
969 | |
|
|
970 | exec @_; |
|
|
971 | urxvt::_exit 255; |
|
|
972 | } |
|
|
973 | |
810 | =item $isset = $term->option ($optval[, $set]) |
974 | =item $isset = $term->option ($optval[, $set]) |
811 | |
975 | |
812 | Returns true if the option specified by C<$optval> is enabled, and |
976 | Returns true if the option specified by C<$optval> is enabled, and |
813 | optionally change it. All option values are stored by name in the hash |
977 | optionally change it. All option values are stored by name in the hash |
814 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
978 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
… | |
… | |
816 | Here is a a likely non-exhaustive list of option names, please see the |
980 | Here is a a likely non-exhaustive list of option names, please see the |
817 | source file F</src/optinc.h> to see the actual list: |
981 | source file F</src/optinc.h> to see the actual list: |
818 | |
982 | |
819 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
983 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
820 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
984 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
821 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
985 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
822 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
986 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
823 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
987 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
824 | tripleclickwords utmpInhibit visualBell |
988 | transparent tripleclickwords utmpInhibit visualBell |
825 | |
989 | |
826 | =item $value = $term->resource ($name[, $newval]) |
990 | =item $value = $term->resource ($name[, $newval]) |
827 | |
991 | |
828 | Returns the current resource value associated with a given name and |
992 | Returns the current resource value associated with a given name and |
829 | optionally sets a new value. Setting values is most useful in the C<init> |
993 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
846 | |
1010 | |
847 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1011 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
848 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1012 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
849 | display_name embed ext_bwidth fade font geometry hold iconName |
1013 | display_name embed ext_bwidth fade font geometry hold iconName |
850 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1014 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
851 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1015 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
852 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1016 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
853 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1017 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
854 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1018 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
855 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1019 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
856 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1020 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
857 | shade term_name title transparent transparent_all tripleclickwords |
1021 | secondaryScreen secondaryScroll selectstyle shade term_name title |
858 | utmpInhibit visualBell |
1022 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
|
|
1023 | visualBell |
859 | |
1024 | |
860 | =cut |
1025 | =cut |
861 | |
1026 | |
862 | sub resource($$;$) { |
1027 | sub resource($$;$) { |
863 | my ($self, $name) = (shift, shift); |
1028 | my ($self, $name) = (shift, shift); |
… | |
… | |
898 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1063 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
899 | |
1064 | |
900 | Return the current values of the selection mark, begin or end positions, |
1065 | Return the current values of the selection mark, begin or end positions, |
901 | and optionally set them to new values. |
1066 | and optionally set them to new values. |
902 | |
1067 | |
|
|
1068 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
1069 | |
|
|
1070 | Tries to make a selection as set by C<selection_beg> and |
|
|
1071 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
1072 | rectangular selection will be made. This is the prefered function to make |
|
|
1073 | a selection. |
|
|
1074 | |
903 | =item $success = $term->selection_grab ($eventtime) |
1075 | =item $success = $term->selection_grab ($eventtime) |
904 | |
1076 | |
905 | Try to request the primary selection from the server (for example, as set |
1077 | Try to request the primary selection text from the server (for example, as |
906 | by the next method). |
1078 | set by the next method). No visual feedback will be given. This function |
|
|
1079 | is mostly useful from within C<on_sel_grab> hooks. |
907 | |
1080 | |
908 | =item $oldtext = $term->selection ([$newtext]) |
1081 | =item $oldtext = $term->selection ([$newtext]) |
909 | |
1082 | |
910 | Return the current selection text and optionally replace it by C<$newtext>. |
1083 | Return the current selection text and optionally replace it by C<$newtext>. |
911 | |
1084 | |
… | |
… | |
1004 | Convert the given locale-encoded octets into a perl string. |
1177 | Convert the given locale-encoded octets into a perl string. |
1005 | |
1178 | |
1006 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1179 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1007 | |
1180 | |
1008 | XORs the rendition values in the given span with the provided value |
1181 | XORs the rendition values in the given span with the provided value |
1009 | (default: C<RS_RVid>). Useful in refresh hooks to provide effects similar |
1182 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
1010 | to the selection. |
1183 | refresh hooks to provide effects similar to the selection. |
1011 | |
1184 | |
1012 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1185 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1013 | |
1186 | |
1014 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1187 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1015 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1188 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1016 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1189 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1017 | it instead. |
1190 | it instead. Both styles I<MUST NOT> contain font styles. |
1018 | |
1191 | |
1019 | =item $term->scr_bell |
1192 | =item $term->scr_bell |
1020 | |
1193 | |
1021 | Ring the bell! |
1194 | Ring the bell! |
1022 | |
1195 | |
… | |
… | |
1056 | |
1229 | |
1057 | =item $windowid = $term->vt |
1230 | =item $windowid = $term->vt |
1058 | |
1231 | |
1059 | Return the window id of the terminal window. |
1232 | Return the window id of the terminal window. |
1060 | |
1233 | |
|
|
1234 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1235 | |
|
|
1236 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1237 | to receive pointer events all the times: |
|
|
1238 | |
|
|
1239 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1240 | |
1061 | =item $window_width = $term->width |
1241 | =item $window_width = $term->width |
1062 | |
1242 | |
1063 | =item $window_height = $term->height |
1243 | =item $window_height = $term->height |
1064 | |
1244 | |
1065 | =item $font_width = $term->fwidth |
1245 | =item $font_width = $term->fwidth |
… | |
… | |
1078 | |
1258 | |
1079 | =item $max_scrollback = $term->saveLines |
1259 | =item $max_scrollback = $term->saveLines |
1080 | |
1260 | |
1081 | =item $nrow_plus_saveLines = $term->total_rows |
1261 | =item $nrow_plus_saveLines = $term->total_rows |
1082 | |
1262 | |
1083 | =item $lines_in_scrollback = $term->nsaved |
1263 | =item $topmost_scrollback_row = $term->top_row |
1084 | |
1264 | |
1085 | Return various integers describing terminal characteristics. |
1265 | Return various integers describing terminal characteristics. |
1086 | |
1266 | |
1087 | =item $x_display = $term->display_id |
1267 | =item $x_display = $term->display_id |
1088 | |
1268 | |
… | |
… | |
1116 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1296 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1117 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1297 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1118 | |
1298 | |
1119 | =item $view_start = $term->view_start ([$newvalue]) |
1299 | =item $view_start = $term->view_start ([$newvalue]) |
1120 | |
1300 | |
1121 | Returns the negative row number of the topmost line. Minimum value is |
1301 | Returns the row number of the topmost displayed line. Maximum value is |
1122 | C<0>, which displays the normal terminal contents. Larger values scroll |
1302 | C<0>, which displays the normal terminal contents. Lower values scroll |
1123 | this many lines into the scrollback buffer. |
1303 | this many lines into the scrollback buffer. |
1124 | |
1304 | |
1125 | =item $term->want_refresh |
1305 | =item $term->want_refresh |
1126 | |
1306 | |
1127 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1307 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1206 | Return the row number of the first/last row of the line, respectively. |
1386 | Return the row number of the first/last row of the line, respectively. |
1207 | |
1387 | |
1208 | =item $offset = $line->offset_of ($row, $col) |
1388 | =item $offset = $line->offset_of ($row, $col) |
1209 | |
1389 | |
1210 | Returns the character offset of the given row|col pair within the logical |
1390 | Returns the character offset of the given row|col pair within the logical |
1211 | line. |
1391 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1392 | offsets outside the string. |
1212 | |
1393 | |
1213 | =item ($row, $col) = $line->coord_of ($offset) |
1394 | =item ($row, $col) = $line->coord_of ($offset) |
1214 | |
1395 | |
1215 | Translates a string offset into terminal coordinates again. |
1396 | Translates a string offset into terminal coordinates again. |
1216 | |
1397 | |
… | |
… | |
1439 | my $env = $self->{term}->env; |
1620 | my $env = $self->{term}->env; |
1440 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1621 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1441 | delete $env->{LC_ALL}; |
1622 | delete $env->{LC_ALL}; |
1442 | $env->{LC_CTYPE} = $self->{term}->locale; |
1623 | $env->{LC_CTYPE} = $self->{term}->locale; |
1443 | |
1624 | |
1444 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1625 | urxvt::term->new ($env, "popup", |
1445 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1626 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
1627 | "-pty-fd" => -1, "-sl" => 0, |
|
|
1628 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1446 | "--transient-for" => $self->{term}->parent, |
1629 | "--transient-for" => $self->{term}->parent, |
1447 | "-display" => $self->{term}->display_id, |
1630 | "-display" => $self->{term}->display_id, |
1448 | "-pe" => "urxvt-popup") |
1631 | "-pe" => "urxvt-popup") |
1449 | or die "unable to create popup window\n"; |
1632 | or die "unable to create popup window\n"; |
1450 | } |
1633 | } |
… | |
… | |
1502 | Start the timer. |
1685 | Start the timer. |
1503 | |
1686 | |
1504 | =item $timer = $timer->start ($tstamp) |
1687 | =item $timer = $timer->start ($tstamp) |
1505 | |
1688 | |
1506 | Set the event trigger time to C<$tstamp> and start the timer. |
1689 | Set the event trigger time to C<$tstamp> and start the timer. |
|
|
1690 | |
|
|
1691 | =item $timer = $timer->after ($delay) |
|
|
1692 | |
|
|
1693 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1507 | |
1694 | |
1508 | =item $timer = $timer->stop |
1695 | =item $timer = $timer->stop |
1509 | |
1696 | |
1510 | Stop the timer. |
1697 | Stop the timer. |
1511 | |
1698 | |
… | |
… | |
1571 | |
1758 | |
1572 | =item == 0 - fatal messages |
1759 | =item == 0 - fatal messages |
1573 | |
1760 | |
1574 | =item >= 3 - script loading and management |
1761 | =item >= 3 - script loading and management |
1575 | |
1762 | |
1576 | =item >=10 - all events received |
1763 | =item >=10 - all called hooks |
|
|
1764 | |
|
|
1765 | =item >=11 - hook reutrn values |
1577 | |
1766 | |
1578 | =back |
1767 | =back |
1579 | |
1768 | |
1580 | =head1 AUTHOR |
1769 | =head1 AUTHOR |
1581 | |
1770 | |