… | |
… | |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Everytime a terminal object gets created, scripts specified via the |
22 | Everytime a terminal object gets created, extension scripts specified via |
23 | C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
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 |
… | |
… | |
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 |
42 | =item selection (enabled by default) |
43 | |
43 | |
44 | Intelligent selection. This extension tries to be more intelligent when |
44 | Intelligent selection. This extension tries to be more intelligent when |
45 | the user extends selections (double-click). Right now, it tries to select |
45 | the user extends selections (double-click). Right now, it tries to select |
46 | urls and complete shell-quoted arguments, which is very convenient, too, |
46 | urls and complete shell-quoted arguments, which is very convenient, too, |
47 | if your F<ls> supports C<--quoting-style=shell>. |
47 | if your F<ls> supports C<--quoting-style=shell>. |
… | |
… | |
56 | |
56 | |
57 | URxvt.keysym.C-M-r: perl:selection:rot13 |
57 | URxvt.keysym.C-M-r: perl:selection:rot13 |
58 | |
58 | |
59 | =back |
59 | =back |
60 | |
60 | |
|
|
61 | =item option-popup (enabled by default) |
|
|
62 | |
|
|
63 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
|
|
64 | runtime. |
|
|
65 | |
|
|
66 | =item selection-popup (enabled by default) |
|
|
67 | |
|
|
68 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
69 | text into various other formats/action. |
|
|
70 | |
61 | =item digital-clock |
71 | =item digital-clock |
62 | |
72 | |
63 | Displays a digital clock using the built-in overlay. |
73 | Displays a digital clock using the built-in overlay. |
|
|
74 | |
|
|
75 | =item mark-urls |
|
|
76 | |
|
|
77 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
|
|
78 | |
|
|
79 | =item block-graphics-to-ascii |
|
|
80 | |
|
|
81 | A not very useful example of filtering all text output to the terminal, |
|
|
82 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
83 | similar-looking ascii character. |
64 | |
84 | |
65 | =item example-refresh-hooks |
85 | =item example-refresh-hooks |
66 | |
86 | |
67 | Displays a very simple digital clock in the upper right corner of the |
87 | Displays a very simple digital clock in the upper right corner of the |
68 | window. Illustrates overwriting the refresh callbacks to create your own |
88 | window. Illustrates overwriting the refresh callbacks to create your own |
69 | overlays or changes. |
89 | overlays or changes. |
70 | |
|
|
71 | =item mark-urls |
|
|
72 | |
|
|
73 | A not very useful example of filtering all text output to the terminal, by |
|
|
74 | underlining all urls that matches a certain regex (i.e. some urls :). It |
|
|
75 | is not very useful because urls that are output in multiple steps (e.g. |
|
|
76 | when typing them) do not get marked. |
|
|
77 | |
90 | |
78 | =back |
91 | =back |
79 | |
92 | |
80 | =head2 General API Considerations |
93 | =head2 General API Considerations |
81 | |
94 | |
… | |
… | |
113 | |
126 | |
114 | =back |
127 | =back |
115 | |
128 | |
116 | =head2 Hooks |
129 | =head2 Hooks |
117 | |
130 | |
118 | The following subroutines can be declared in loaded scripts, and will be |
131 | The following subroutines can be declared in extension files, and will be |
119 | called whenever the relevant event happens. |
132 | called whenever the relevant event happens. |
120 | |
133 | |
121 | The first argument passed to them is an object private to each terminal |
134 | The first argument passed to them is an object private to each terminal |
122 | and extension package. You can call all C<urxvt::term> methods on it, but |
135 | and extension package. You can call all C<urxvt::term> methods on it, but |
123 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
136 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
124 | object that is shared between all packages is stored in the C<term> |
137 | object that is shared between all packages is stored in the C<term> |
125 | member. |
138 | member. It is, however, blessed intot he package of the extension script, |
|
|
139 | so for all practical purposes you can treat an extension script as a class. |
126 | |
140 | |
127 | All of them must return a boolean value. If it is true, then the event |
141 | All of them must return a boolean value. If it is true, then the event |
128 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
142 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
129 | and the relevant action might not be carried out by the C++ code. |
143 | and the relevant action might not be carried out by the C++ code. |
130 | |
144 | |
… | |
… | |
133 | =over 4 |
147 | =over 4 |
134 | |
148 | |
135 | =item on_init $term |
149 | =item on_init $term |
136 | |
150 | |
137 | Called after a new terminal object has been initialized, but before |
151 | Called after a new terminal object has been initialized, but before |
138 | windows are created or the command gets run. |
152 | windows are created or the command gets run. Most methods are unsafe to |
|
|
153 | call or deliver senseless data, as terminal size and other characteristics |
|
|
154 | have not yet been determined. You can safely query and change resources, |
|
|
155 | though. |
139 | |
156 | |
140 | =item on_reset $term |
157 | =item on_reset $term |
141 | |
158 | |
142 | Called after the screen is "reset" for any reason, such as resizing or |
159 | Called after the screen is "reset" for any reason, such as resizing or |
143 | control sequences. Here is where you can react on changes to size-related |
160 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
172 | should extend the selection itelf and return true to suppress the built-in |
189 | should extend the selection itelf and return true to suppress the built-in |
173 | processing. |
190 | processing. |
174 | |
191 | |
175 | See the F<selection> example extension. |
192 | See the F<selection> example extension. |
176 | |
193 | |
177 | =item on_focus_in $term |
|
|
178 | |
|
|
179 | Called whenever the window gets the keyboard focus, before urxvt does |
|
|
180 | focus in processing. |
|
|
181 | |
|
|
182 | =item on_focus_out $term |
|
|
183 | |
|
|
184 | Called wheneever the window loses keyboard focus, before urxvt does focus |
|
|
185 | out processing. |
|
|
186 | |
|
|
187 | =item on_view_change $term, $offset |
194 | =item on_view_change $term, $offset |
188 | |
195 | |
189 | Called whenever the view offset changes, i..e the user or program |
196 | Called whenever the view offset changes, i..e the user or program |
190 | scrolls. Offset C<0> means display the normal terminal, positive values |
197 | scrolls. Offset C<0> means display the normal terminal, positive values |
191 | show this many lines of scrollback. |
198 | show this many lines of scrollback. |
… | |
… | |
197 | than the scroll back buffer or the terminal. |
204 | than the scroll back buffer or the terminal. |
198 | |
205 | |
199 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
206 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
200 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
207 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
201 | number of lines that will be in the scrollback buffer. |
208 | number of lines that will be in the scrollback buffer. |
202 | |
|
|
203 | =item on_tty_activity $term *NYI* |
|
|
204 | |
|
|
205 | Called whenever the program(s) running in the urxvt window send output. |
|
|
206 | |
209 | |
207 | =item on_osc_seq $term, $string |
210 | =item on_osc_seq $term, $string |
208 | |
211 | |
209 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
212 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
210 | operating system command) is processed. Cursor position and other state |
213 | operating system command) is processed. Cursor position and other state |
… | |
… | |
223 | can filter/change and output the text yourself by returning a true value |
226 | can filter/change and output the text yourself by returning a true value |
224 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
227 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
225 | might be very slow, however, as your hook is called for B<all> text being |
228 | might be very slow, however, as your hook is called for B<all> text being |
226 | output. |
229 | output. |
227 | |
230 | |
|
|
231 | =item on_line_update $term, $row |
|
|
232 | |
|
|
233 | Called whenever a line was updated or changed. Can be used to filter |
|
|
234 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
235 | that are being shown will be filtered, and, due to performance reasons, |
|
|
236 | not always immediately. |
|
|
237 | |
|
|
238 | The row number is always the topmost row of the line if the line spans |
|
|
239 | multiple rows. |
|
|
240 | |
|
|
241 | Please note that, if you change the line, then the hook might get called |
|
|
242 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
243 | you cannot just toggle rendition bits, but only set them. |
|
|
244 | |
228 | =item on_refresh_begin $term |
245 | =item on_refresh_begin $term |
229 | |
246 | |
230 | Called just before the screen gets redrawn. Can be used for overlay |
247 | Called just before the screen gets redrawn. Can be used for overlay |
231 | or similar effects by modify terminal contents in refresh_begin, and |
248 | or similar effects by modify terminal contents in refresh_begin, and |
232 | restoring them in refresh_end. The built-in overlay and selection display |
249 | restoring them in refresh_end. The built-in overlay and selection display |
… | |
… | |
240 | |
257 | |
241 | Called whenever the user presses a key combination that has a |
258 | Called whenever the user presses a key combination that has a |
242 | C<perl:string> action bound to it (see description of the B<keysym> |
259 | C<perl:string> action bound to it (see description of the B<keysym> |
243 | resource in the @@RXVT_NAME@@(1) manpage). |
260 | resource in the @@RXVT_NAME@@(1) manpage). |
244 | |
261 | |
|
|
262 | =item on_focus_in $term |
|
|
263 | |
|
|
264 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
|
|
265 | does focus in processing. |
|
|
266 | |
|
|
267 | =item on_focus_out $term |
|
|
268 | |
|
|
269 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
|
|
270 | focus out processing. |
|
|
271 | |
|
|
272 | =item on_key_press $term, $event, $octets |
|
|
273 | |
|
|
274 | =item on_key_release $term, $event |
|
|
275 | |
|
|
276 | =item on_button_press $term, $event |
|
|
277 | |
|
|
278 | =item on_button_release $term, $event |
|
|
279 | |
|
|
280 | =item on_motion_notify $term, $event |
|
|
281 | |
|
|
282 | =item on_map_notify $term, $event |
|
|
283 | |
|
|
284 | =item on_unmap_notify $term, $event |
|
|
285 | |
|
|
286 | Called whenever the corresponding X event is received for the terminal If |
|
|
287 | the hook returns true, then the even will be ignored by rxvt-unicode. |
|
|
288 | |
|
|
289 | The event is a hash with most values as named by Xlib (see the XEvent |
|
|
290 | manpage), with the additional members C<row> and C<col>, which are the row |
|
|
291 | and column under the mouse cursor. |
|
|
292 | |
|
|
293 | C<on_key_press> additionally receives the string rxvt-unicode would |
|
|
294 | output, if any, in locale-specific encoding. |
|
|
295 | |
|
|
296 | subwindow. |
|
|
297 | |
245 | =back |
298 | =back |
246 | |
299 | |
247 | =head2 Variables in the C<urxvt> Package |
300 | =head2 Variables in the C<urxvt> Package |
248 | |
301 | |
249 | =over 4 |
302 | =over 4 |
250 | |
303 | |
251 | =item $urxvt::TERM |
304 | =item $urxvt::TERM |
252 | |
305 | |
253 | The current terminal. Whenever a callback/Hook is bein executed, this |
306 | The current terminal. This variable stores the current C<urxvt::term> |
254 | variable stores the current C<urxvt::term> object. |
307 | object, whenever a callback/hook is executing. |
255 | |
308 | |
256 | =back |
309 | =back |
257 | |
310 | |
258 | =head2 Functions in the C<urxvt> Package |
311 | =head2 Functions in the C<urxvt> Package |
259 | |
312 | |
260 | =over 4 |
313 | =over 4 |
|
|
314 | |
|
|
315 | =item $term = new urxvt [arg...] |
|
|
316 | |
|
|
317 | Creates a new terminal, very similar as if you had started it with |
|
|
318 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
319 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
320 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
321 | C<init> and C<start> hooks will be called during the call. |
261 | |
322 | |
262 | =item urxvt::fatal $errormessage |
323 | =item urxvt::fatal $errormessage |
263 | |
324 | |
264 | Fatally aborts execution with the given error message. Avoid at all |
325 | Fatally aborts execution with the given error message. Avoid at all |
265 | costs! The only time this is acceptable is when the terminal process |
326 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
272 | that calls this function. |
333 | that calls this function. |
273 | |
334 | |
274 | Using this function has the advantage that its output ends up in the |
335 | Using this function has the advantage that its output ends up in the |
275 | correct place, e.g. on stderr of the connecting urxvtc client. |
336 | correct place, e.g. on stderr of the connecting urxvtc client. |
276 | |
337 | |
|
|
338 | =item $is_safe = urxvt::safe |
|
|
339 | |
|
|
340 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
341 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
342 | started setuid or setgid. |
|
|
343 | |
277 | =item $time = urxvt::NOW |
344 | =item $time = urxvt::NOW |
278 | |
345 | |
279 | Returns the "current time" (as per the event loop). |
346 | Returns the "current time" (as per the event loop). |
|
|
347 | |
|
|
348 | =item urxvt::CurrentTime |
|
|
349 | |
|
|
350 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
351 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
352 | Button4Mask, Button5Mask, AnyModifier |
|
|
353 | |
|
|
354 | Various constants for use in X calls and event processing. |
280 | |
355 | |
281 | =back |
356 | =back |
282 | |
357 | |
283 | =head2 RENDITION |
358 | =head2 RENDITION |
284 | |
359 | |
… | |
… | |
334 | |
409 | |
335 | =cut |
410 | =cut |
336 | |
411 | |
337 | package urxvt; |
412 | package urxvt; |
338 | |
413 | |
|
|
414 | use utf8; |
339 | use strict; |
415 | use strict; |
340 | use Scalar::Util (); |
416 | use Scalar::Util (); |
|
|
417 | use List::Util (); |
341 | |
418 | |
|
|
419 | our $VERSION = 1; |
342 | our $TERM; |
420 | our $TERM; |
343 | our @HOOKNAME; |
421 | our @HOOKNAME; |
|
|
422 | our %OPTION; |
344 | our $LIBDIR; |
423 | our $LIBDIR; |
345 | |
424 | |
346 | BEGIN { |
425 | BEGIN { |
347 | urxvt->bootstrap; |
426 | urxvt->bootstrap; |
348 | |
427 | |
… | |
… | |
351 | my $msg = join "", @_; |
430 | my $msg = join "", @_; |
352 | $msg .= "\n" |
431 | $msg .= "\n" |
353 | unless $msg =~ /\n$/; |
432 | unless $msg =~ /\n$/; |
354 | urxvt::warn ($msg); |
433 | urxvt::warn ($msg); |
355 | }; |
434 | }; |
|
|
435 | |
|
|
436 | delete $ENV{IFS}; |
|
|
437 | delete $ENV{CDPATH}; |
|
|
438 | delete $ENV{BASH_ENV}; |
|
|
439 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
356 | } |
440 | } |
357 | |
441 | |
358 | my @hook_count; |
442 | my @hook_count; |
359 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
443 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
360 | |
444 | |
… | |
… | |
378 | $hook_count[$htype]++ |
462 | $hook_count[$htype]++ |
379 | or set_should_invoke $htype, 1; |
463 | or set_should_invoke $htype, 1; |
380 | } |
464 | } |
381 | } |
465 | } |
382 | |
466 | |
383 | my $script_pkg = "script0000"; |
467 | my $extension_pkg = "extension0000"; |
384 | my %script_pkg; |
468 | my %extension_pkg; |
385 | |
469 | |
386 | # load a single script into its own package, once only |
470 | # load a single script into its own package, once only |
387 | sub script_package($) { |
471 | sub extension_package($) { |
388 | my ($path) = @_; |
472 | my ($path) = @_; |
389 | |
473 | |
390 | $script_pkg{$path} ||= do { |
474 | $extension_pkg{$path} ||= do { |
391 | my $pkg = "urxvt::" . ($script_pkg++); |
475 | my $pkg = "urxvt::" . ($extension_pkg++); |
392 | |
476 | |
393 | verbose 3, "loading script '$path' into package '$pkg'"; |
477 | verbose 3, "loading extension '$path' into package '$pkg'"; |
394 | |
478 | |
395 | open my $fh, "<:raw", $path |
479 | open my $fh, "<:raw", $path |
396 | or die "$path: $!"; |
480 | or die "$path: $!"; |
397 | |
481 | |
398 | my $source = "package $pkg; use strict; use utf8;\n" |
482 | my $source = untaint "package $pkg; use strict; use utf8;\n" |
|
|
483 | . "use base urxvt::term::proxy::;\n" |
399 | . "#line 1 \"$path\"\n{\n" |
484 | . "#line 1 \"$path\"\n{\n" |
400 | . (do { local $/; <$fh> }) |
485 | . (do { local $/; <$fh> }) |
401 | . "\n};\n1"; |
486 | . "\n};\n1"; |
402 | |
487 | |
403 | eval $source or die "$path: $@"; |
488 | eval $source or die "$path: $@"; |
… | |
… | |
413 | local $TERM = shift; |
498 | local $TERM = shift; |
414 | my $htype = shift; |
499 | my $htype = shift; |
415 | |
500 | |
416 | if ($htype == 0) { # INIT |
501 | if ($htype == 0) { # INIT |
417 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
502 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
|
|
503 | |
|
|
504 | my %want_ext; |
418 | |
505 | |
419 | for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
506 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
|
|
507 | if ($_ eq "default") { |
|
|
508 | $want_ext{$_}++ for qw(selection option-popup selection-popup); |
|
|
509 | } elsif (/^-(.*)$/) { |
|
|
510 | delete $want_ext{$1}; |
|
|
511 | } else { |
|
|
512 | $want_ext{$_}++; |
|
|
513 | } |
|
|
514 | } |
|
|
515 | |
|
|
516 | for my $ext (keys %want_ext) { |
420 | my @files = grep -f $_, map "$_/$ext", @dirs; |
517 | my @files = grep -f $_, map "$_/$ext", @dirs; |
421 | |
518 | |
422 | if (@files) { |
519 | if (@files) { |
423 | register_package script_package $files[0]; |
520 | register_package extension_package $files[0]; |
424 | } else { |
521 | } else { |
425 | warn "perl extension '$ext' not found in perl library search path\n"; |
522 | warn "perl extension '$ext' not found in perl library search path\n"; |
426 | } |
523 | } |
427 | } |
524 | } |
|
|
525 | |
|
|
526 | eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); |
|
|
527 | warn $@ if $@; |
428 | } |
528 | } |
429 | |
529 | |
430 | $retval = undef; |
530 | $retval = undef; |
431 | |
531 | |
432 | if (my $cb = $TERM->{_hook}[$htype]) { |
532 | if (my $cb = $TERM->{_hook}[$htype]) { |
… | |
… | |
434 | if $verbosity >= 10; |
534 | if $verbosity >= 10; |
435 | |
535 | |
436 | keys %$cb; |
536 | keys %$cb; |
437 | |
537 | |
438 | while (my ($pkg, $cb) = each %$cb) { |
538 | while (my ($pkg, $cb) = each %$cb) { |
|
|
539 | eval { |
439 | $retval = $cb->( |
540 | $retval = $cb->( |
440 | $TERM->{_pkg}{$pkg} ||= do { |
541 | $TERM->{_pkg}{$pkg} ||= do { |
441 | my $proxy = bless { }, urxvt::term::proxy::; |
542 | my $proxy = bless { }, $pkg; |
442 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
543 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
443 | $proxy |
544 | $proxy |
444 | }, |
545 | }, |
445 | @_, |
546 | @_, |
446 | ) and last; |
547 | ) and last; |
|
|
548 | }; |
|
|
549 | if ($@) { |
|
|
550 | $TERM->ungrab; # better to lose the grab than the session |
|
|
551 | warn $@; |
|
|
552 | } |
447 | } |
553 | } |
448 | } |
554 | } |
449 | |
555 | |
450 | if ($htype == 1) { # DESTROY |
556 | if ($htype == 1) { # DESTROY |
451 | # remove hooks if unused |
557 | # remove hooks if unused |
… | |
… | |
464 | } |
570 | } |
465 | |
571 | |
466 | $retval |
572 | $retval |
467 | } |
573 | } |
468 | |
574 | |
|
|
575 | # urxvt::term::proxy |
|
|
576 | |
469 | sub urxvt::term::proxy::AUTOLOAD { |
577 | sub urxvt::term::proxy::AUTOLOAD { |
470 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
578 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
471 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
579 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
472 | |
580 | |
473 | eval qq{ |
581 | eval qq{ |
… | |
… | |
479 | } or die "FATAL: unable to compile method forwarder: $@"; |
587 | } or die "FATAL: unable to compile method forwarder: $@"; |
480 | |
588 | |
481 | goto &$urxvt::term::proxy::AUTOLOAD; |
589 | goto &$urxvt::term::proxy::AUTOLOAD; |
482 | } |
590 | } |
483 | |
591 | |
|
|
592 | sub urxvt::term::proxy::DESTROY { |
|
|
593 | # nop |
|
|
594 | } |
|
|
595 | |
|
|
596 | # urxvt::destroy_hook |
|
|
597 | |
|
|
598 | sub urxvt::destroy_hook::DESTROY { |
|
|
599 | ${$_[0]}->(); |
|
|
600 | } |
|
|
601 | |
|
|
602 | sub urxvt::destroy_hook(&) { |
|
|
603 | bless \shift, urxvt::destroy_hook:: |
|
|
604 | } |
|
|
605 | |
|
|
606 | package urxvt::anyevent; |
|
|
607 | |
|
|
608 | =head2 The C<urxvt::anyevent> Class |
|
|
609 | |
|
|
610 | The sole purpose of this class is to deliver an interface to the |
|
|
611 | C<AnyEvent> module - any module using it will work inside urxvt without |
|
|
612 | further work. The only exception is that you cannot wait on condition |
|
|
613 | variables, but non-blocking condvar use is ok. What this means is that you |
|
|
614 | cannot use blocking APIs, but the non-blocking variant should work. |
|
|
615 | |
|
|
616 | =cut |
|
|
617 | |
|
|
618 | our $VERSION = 1; |
|
|
619 | |
|
|
620 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
|
|
621 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
|
|
622 | |
|
|
623 | sub timer { |
|
|
624 | my ($class, %arg) = @_; |
|
|
625 | |
|
|
626 | my $cb = $arg{cb}; |
|
|
627 | |
|
|
628 | urxvt::timer |
|
|
629 | ->new |
|
|
630 | ->start (urxvt::NOW + $arg{after}) |
|
|
631 | ->cb (sub { |
|
|
632 | $_[0]->stop; # need to cancel manually |
|
|
633 | $cb->(); |
|
|
634 | }) |
|
|
635 | } |
|
|
636 | |
|
|
637 | sub io { |
|
|
638 | my ($class, %arg) = @_; |
|
|
639 | |
|
|
640 | my $cb = $arg{cb}; |
|
|
641 | |
|
|
642 | bless [$arg{fh}, urxvt::iow |
|
|
643 | ->new |
|
|
644 | ->fd (fileno $arg{fh}) |
|
|
645 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
|
|
646 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
|
|
647 | ->start |
|
|
648 | ->cb (sub { |
|
|
649 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
650 | . ($_[1] & 2 ? 'w' : '')); |
|
|
651 | })], |
|
|
652 | urxvt::anyevent:: |
|
|
653 | } |
|
|
654 | |
|
|
655 | sub DESTROY { |
|
|
656 | $_[0][1]->stop; |
|
|
657 | } |
|
|
658 | |
|
|
659 | sub condvar { |
|
|
660 | bless \my $flag, urxvt::anyevent::condvar:: |
|
|
661 | } |
|
|
662 | |
|
|
663 | sub urxvt::anyevent::condvar::broadcast { |
|
|
664 | ${$_[0]}++; |
|
|
665 | } |
|
|
666 | |
|
|
667 | sub urxvt::anyevent::condvar::wait { |
|
|
668 | unless (${$_[0]}) { |
|
|
669 | require Carp; |
|
|
670 | Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"); |
|
|
671 | } |
|
|
672 | } |
|
|
673 | |
|
|
674 | package urxvt::term; |
|
|
675 | |
484 | =head2 The C<urxvt::term> Class |
676 | =head2 The C<urxvt::term> Class |
485 | |
677 | |
486 | =over 4 |
678 | =over 4 |
|
|
679 | |
|
|
680 | =item $term->destroy |
|
|
681 | |
|
|
682 | Destroy the terminal object (close the window, free resources etc.). |
|
|
683 | |
|
|
684 | =item $isset = $term->option ($optval[, $set]) |
|
|
685 | |
|
|
686 | Returns true if the option specified by C<$optval> is enabled, and |
|
|
687 | optionally change it. All option values are stored by name in the hash |
|
|
688 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
|
|
689 | |
|
|
690 | Here is a a likely non-exhaustive list of option names, please see the |
|
|
691 | source file F</src/optinc.h> to see the actual list: |
|
|
692 | |
|
|
693 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
|
|
694 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
|
|
695 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
|
|
696 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
|
|
697 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
|
|
698 | tripleclickwords utmpInhibit visualBell |
487 | |
699 | |
488 | =item $value = $term->resource ($name[, $newval]) |
700 | =item $value = $term->resource ($name[, $newval]) |
489 | |
701 | |
490 | Returns the current resource value associated with a given name and |
702 | Returns the current resource value associated with a given name and |
491 | optionally sets a new value. Setting values is most useful in the C<init> |
703 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
501 | |
713 | |
502 | Please note that resource strings will currently only be freed when the |
714 | Please note that resource strings will currently only be freed when the |
503 | terminal is destroyed, so changing options frequently will eat memory. |
715 | terminal is destroyed, so changing options frequently will eat memory. |
504 | |
716 | |
505 | Here is a a likely non-exhaustive list of resource names, not all of which |
717 | Here is a a likely non-exhaustive list of resource names, not all of which |
506 | are supported in every build, please see the source to see the actual |
718 | are supported in every build, please see the source file F</src/rsinc.h> |
507 | list: |
719 | to see the actual list: |
508 | |
720 | |
509 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
721 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
510 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
722 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
511 | display_name embed ext_bwidth fade font geometry hold iconName |
723 | display_name embed ext_bwidth fade font geometry hold iconName |
512 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
724 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
… | |
… | |
519 | shade term_name title transparent transparent_all tripleclickwords |
731 | shade term_name title transparent transparent_all tripleclickwords |
520 | utmpInhibit visualBell |
732 | utmpInhibit visualBell |
521 | |
733 | |
522 | =cut |
734 | =cut |
523 | |
735 | |
524 | sub urxvt::term::resource($$;$) { |
736 | sub resource($$;$) { |
525 | my ($self, $name) = (shift, shift); |
737 | my ($self, $name) = (shift, shift); |
526 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
738 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
527 | goto &urxvt::term::_resource; |
739 | &urxvt::term::_resource |
528 | } |
740 | } |
529 | |
741 | |
530 | =item $rend = $term->rstyle ([$new_rstyle]) |
742 | =item $rend = $term->rstyle ([$new_rstyle]) |
531 | |
743 | |
532 | Return and optionally change the current rendition. Text that is output by |
744 | Return and optionally change the current rendition. Text that is output by |
… | |
… | |
608 | |
820 | |
609 | If hidden, display the overlay again. |
821 | If hidden, display the overlay again. |
610 | |
822 | |
611 | =back |
823 | =back |
612 | |
824 | |
|
|
825 | =item $popup = $term->popup ($event) |
|
|
826 | |
|
|
827 | Creates a new C<urxvt::popup> object that implements a popup menu. The |
|
|
828 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
|
|
829 | currently). |
|
|
830 | |
|
|
831 | =cut |
|
|
832 | |
|
|
833 | sub popup { |
|
|
834 | my ($self, $event) = @_; |
|
|
835 | |
|
|
836 | $self->grab ($event->{time}, 1) |
|
|
837 | or return; |
|
|
838 | |
|
|
839 | my $popup = bless { |
|
|
840 | term => $self, |
|
|
841 | event => $event, |
|
|
842 | }, urxvt::popup::; |
|
|
843 | |
|
|
844 | Scalar::Util::weaken $popup->{term}; |
|
|
845 | |
|
|
846 | $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy }; |
|
|
847 | Scalar::Util::weaken $self->{_destroy}{$popup}; |
|
|
848 | |
|
|
849 | $popup |
|
|
850 | } |
|
|
851 | |
613 | =item $cellwidth = $term->strwidth $string |
852 | =item $cellwidth = $term->strwidth ($string) |
614 | |
853 | |
615 | Returns the number of screen-cells this string would need. Correctly |
854 | Returns the number of screen-cells this string would need. Correctly |
616 | accounts for wide and combining characters. |
855 | accounts for wide and combining characters. |
617 | |
856 | |
618 | =item $octets = $term->locale_encode $string |
857 | =item $octets = $term->locale_encode ($string) |
619 | |
858 | |
620 | Convert the given text string into the corresponding locale encoding. |
859 | Convert the given text string into the corresponding locale encoding. |
621 | |
860 | |
622 | =item $string = $term->locale_decode $octets |
861 | =item $string = $term->locale_decode ($octets) |
623 | |
862 | |
624 | Convert the given locale-encoded octets into a perl string. |
863 | Convert the given locale-encoded octets into a perl string. |
625 | |
864 | |
626 | =item $term->scr_add_lines ($string) |
865 | =item $term->scr_add_lines ($string) |
627 | |
866 | |
… | |
… | |
632 | |
871 | |
633 | Normally its not a good idea to use this function, as programs might be |
872 | Normally its not a good idea to use this function, as programs might be |
634 | confused by changes in cursor position or scrolling. Its useful inside a |
873 | confused by changes in cursor position or scrolling. Its useful inside a |
635 | C<on_add_lines> hook, though. |
874 | C<on_add_lines> hook, though. |
636 | |
875 | |
|
|
876 | =item $term->cmd_parse ($octets) |
|
|
877 | |
|
|
878 | Similar to C<scr_add_lines>, but the argument must be in the |
|
|
879 | locale-specific encoding of the terminal and can contain command sequences |
|
|
880 | (escape codes) that will be interpreted. |
|
|
881 | |
637 | =item $term->tt_write ($octets) |
882 | =item $term->tt_write ($octets) |
638 | |
883 | |
639 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
884 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
640 | pass characters instead of octets, you should convert your strings first |
885 | pass characters instead of octets, you should convert your strings first |
641 | to the locale-specific encoding using C<< $term->locale_encode >>. |
886 | to the locale-specific encoding using C<< $term->locale_encode >>. |
642 | |
887 | |
|
|
888 | =item $windowid = $term->parent |
|
|
889 | |
|
|
890 | Return the window id of the toplevel window. |
|
|
891 | |
|
|
892 | =item $windowid = $term->vt |
|
|
893 | |
|
|
894 | Return the window id of the terminal window. |
|
|
895 | |
643 | =item $window_width = $term->width |
896 | =item $window_width = $term->width |
644 | |
897 | |
645 | =item $window_height = $term->height |
898 | =item $window_height = $term->height |
646 | |
899 | |
647 | =item $font_width = $term->fwidth |
900 | =item $font_width = $term->fwidth |
… | |
… | |
663 | =item $nrow_plus_saveLines = $term->total_rows |
916 | =item $nrow_plus_saveLines = $term->total_rows |
664 | |
917 | |
665 | =item $lines_in_scrollback = $term->nsaved |
918 | =item $lines_in_scrollback = $term->nsaved |
666 | |
919 | |
667 | Return various integers describing terminal characteristics. |
920 | Return various integers describing terminal characteristics. |
|
|
921 | |
|
|
922 | =item $modifiermask = $term->ModLevel3Mask |
|
|
923 | |
|
|
924 | =item $modifiermask = $term->ModMetaMask |
|
|
925 | |
|
|
926 | =item $modifiermask = $term->ModNumLockMask |
|
|
927 | |
|
|
928 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
|
|
929 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
668 | |
930 | |
669 | =item $view_start = $term->view_start ([$newvalue]) |
931 | =item $view_start = $term->view_start ([$newvalue]) |
670 | |
932 | |
671 | Returns the negative row number of the topmost line. Minimum value is |
933 | Returns the negative row number of the topmost line. Minimum value is |
672 | C<0>, which displays the normal terminal contents. Larger values scroll |
934 | C<0>, which displays the normal terminal contents. Larger values scroll |
… | |
… | |
735 | about the logical line that row C<$row_number> is part of. It supports the |
997 | about the logical line that row C<$row_number> is part of. It supports the |
736 | following methods: |
998 | following methods: |
737 | |
999 | |
738 | =over 4 |
1000 | =over 4 |
739 | |
1001 | |
740 | =item $text = $line->t |
1002 | =item $text = $line->t ([$new_text]) |
741 | |
1003 | |
742 | Returns the full text of the line, similar to C<ROW_t> |
1004 | Returns or replaces the full text of the line, similar to C<ROW_t> |
743 | |
1005 | |
744 | =item $rend = $line->r |
1006 | =item $rend = $line->r ([$new_rend]) |
745 | |
1007 | |
746 | Returns the full rendition array of the line, similar to C<ROW_r> |
1008 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
747 | |
1009 | |
748 | =item $length = $line->l |
1010 | =item $length = $line->l |
749 | |
1011 | |
750 | Returns the length of the line in cells, similar to C<ROW_l>. |
1012 | Returns the length of the line in cells, similar to C<ROW_l>. |
751 | |
1013 | |
… | |
… | |
766 | |
1028 | |
767 | =back |
1029 | =back |
768 | |
1030 | |
769 | =cut |
1031 | =cut |
770 | |
1032 | |
771 | sub urxvt::term::line { |
1033 | sub line { |
772 | my ($self, $row) = @_; |
1034 | my ($self, $row) = @_; |
773 | |
1035 | |
774 | my $maxrow = $self->nrow - 1; |
1036 | my $maxrow = $self->nrow - 1; |
775 | |
1037 | |
776 | my ($beg, $end) = ($row, $row); |
1038 | my ($beg, $end) = ($row, $row); |
… | |
… | |
840 | $offset / $self->{ncol} + $self->{beg}, |
1102 | $offset / $self->{ncol} + $self->{beg}, |
841 | $offset % $self->{ncol} |
1103 | $offset % $self->{ncol} |
842 | ) |
1104 | ) |
843 | } |
1105 | } |
844 | |
1106 | |
845 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
846 | =item $text = $term->special_encode $string |
1107 | =item $text = $term->special_encode $string |
847 | |
1108 | |
848 | Converts a perl string into the special encoding used by rxvt-unicode, |
1109 | Converts a perl string into the special encoding used by rxvt-unicode, |
849 | where one character corresponds to one screen cell. See |
1110 | where one character corresponds to one screen cell. See |
850 | C<< $term->ROW_t >> for details. |
1111 | C<< $term->ROW_t >> for details. |
… | |
… | |
852 | =item $string = $term->special_decode $text |
1113 | =item $string = $term->special_decode $text |
853 | |
1114 | |
854 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1115 | Converts rxvt-unicodes text reprsentation into a perl string. See |
855 | C<< $term->ROW_t >> for details. |
1116 | C<< $term->ROW_t >> for details. |
856 | |
1117 | |
|
|
1118 | =item $success = $term->grab_button ($button, $modifiermask) |
|
|
1119 | |
|
|
1120 | Registers a synchronous button grab. See XGrabButton. |
|
|
1121 | |
|
|
1122 | =item $success = $term->grab ($eventtime[, $sync]) |
|
|
1123 | |
|
|
1124 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1125 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
|
|
1126 | |
|
|
1127 | =item $term->allow_events_async |
|
|
1128 | |
|
|
1129 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1130 | |
|
|
1131 | =item $term->allow_events_sync |
|
|
1132 | |
|
|
1133 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1134 | |
|
|
1135 | =item $term->allow_events_replay |
|
|
1136 | |
|
|
1137 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1138 | recent grab. |
|
|
1139 | |
|
|
1140 | =item $term->ungrab |
|
|
1141 | |
|
|
1142 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1143 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1144 | the session. |
|
|
1145 | |
857 | =back |
1146 | =back |
|
|
1147 | |
|
|
1148 | =cut |
|
|
1149 | |
|
|
1150 | package urxvt::popup; |
|
|
1151 | |
|
|
1152 | =head2 The C<urxvt::popup> Class |
|
|
1153 | |
|
|
1154 | =over 4 |
|
|
1155 | |
|
|
1156 | =cut |
|
|
1157 | |
|
|
1158 | sub add_item { |
|
|
1159 | my ($self, $item) = @_; |
|
|
1160 | |
|
|
1161 | $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal}; |
|
|
1162 | $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover}; |
|
|
1163 | $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active}; |
|
|
1164 | |
|
|
1165 | $item->{render} ||= sub { $_[0]{text} }; |
|
|
1166 | |
|
|
1167 | push @{ $self->{item} }, $item; |
|
|
1168 | } |
|
|
1169 | |
|
|
1170 | sub add_separator { |
|
|
1171 | my ($self, $sep) = @_; |
|
|
1172 | |
|
|
1173 | $sep ||= "═"; |
|
|
1174 | |
|
|
1175 | $self->add_item ({ |
|
|
1176 | rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, |
|
|
1177 | text => "", |
|
|
1178 | render => sub { $sep x $urxvt::TERM->ncol }, |
|
|
1179 | activate => sub { }, |
|
|
1180 | }); |
|
|
1181 | } |
|
|
1182 | |
|
|
1183 | sub add_title { |
|
|
1184 | my ($self, $title) = @_; |
|
|
1185 | |
|
|
1186 | $self->add_item ({ |
|
|
1187 | rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, |
|
|
1188 | text => $title, |
|
|
1189 | activate => sub { }, |
|
|
1190 | }); |
|
|
1191 | } |
|
|
1192 | |
|
|
1193 | sub add_button { |
|
|
1194 | my ($self, $text, $cb) = @_; |
|
|
1195 | |
|
|
1196 | $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); |
|
|
1197 | } |
|
|
1198 | |
|
|
1199 | sub add_toggle { |
|
|
1200 | my ($self, $text, $cb, $value) = @_; |
|
|
1201 | |
|
|
1202 | my $item; $item = { |
|
|
1203 | type => "button", |
|
|
1204 | text => " $text", |
|
|
1205 | value => $value, |
|
|
1206 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
|
|
1207 | activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, |
|
|
1208 | }; |
|
|
1209 | |
|
|
1210 | $self->add_item ($item); |
|
|
1211 | } |
|
|
1212 | |
|
|
1213 | sub show { |
|
|
1214 | my ($self) = @_; |
|
|
1215 | |
|
|
1216 | local $urxvt::popup::self = $self; |
|
|
1217 | |
|
|
1218 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
|
|
1219 | "--transient-for" => $self->{term}->parent, |
|
|
1220 | "-pe" => "urxvt-popup") |
|
|
1221 | or die "unable to create popup window\n"; |
|
|
1222 | } |
|
|
1223 | |
|
|
1224 | sub DESTROY { |
|
|
1225 | my ($self) = @_; |
|
|
1226 | |
|
|
1227 | delete $self->{term}{_destroy}{$self}; |
|
|
1228 | $self->{term}->ungrab; |
|
|
1229 | } |
858 | |
1230 | |
859 | =head2 The C<urxvt::timer> Class |
1231 | =head2 The C<urxvt::timer> Class |
860 | |
1232 | |
861 | This class implements timer watchers/events. Time is represented as a |
1233 | This class implements timer watchers/events. Time is represented as a |
862 | fractional number of seconds since the epoch. Example: |
1234 | fractional number of seconds since the epoch. Example: |
… | |
… | |
964 | This variable controls the verbosity level of the perl extension. Higher |
1336 | This variable controls the verbosity level of the perl extension. Higher |
965 | numbers indicate more verbose output. |
1337 | numbers indicate more verbose output. |
966 | |
1338 | |
967 | =over 4 |
1339 | =over 4 |
968 | |
1340 | |
969 | =item =0 - only fatal messages |
1341 | =item == 0 - fatal messages |
970 | |
1342 | |
971 | =item =3 - script loading and management |
1343 | =item >= 3 - script loading and management |
972 | |
1344 | |
973 | =item =10 - all events received |
1345 | =item >=10 - all events received |
974 | |
1346 | |
975 | =back |
1347 | =back |
976 | |
1348 | |
977 | =head1 AUTHOR |
1349 | =head1 AUTHOR |
978 | |
1350 | |