… | |
… | |
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 | Miscellaneous selection modifications. |
44 | Intelligent selection. This extension tries to be more intelligent when |
|
|
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, |
|
|
47 | if your F<ls> supports C<--quoting-style=shell>. |
|
|
48 | |
|
|
49 | It also offers the following bindable event: |
45 | |
50 | |
46 | =over 4 |
51 | =over 4 |
47 | |
52 | |
48 | =item rot13 |
53 | =item rot13 |
49 | |
54 | |
… | |
… | |
51 | |
56 | |
52 | URxvt.keysym.C-M-r: perl:selection:rot13 |
57 | URxvt.keysym.C-M-r: perl:selection:rot13 |
53 | |
58 | |
54 | =back |
59 | =back |
55 | |
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 | |
|
|
71 | =item searchable-scrollback (enabled by default) |
|
|
72 | |
|
|
73 | Adds regex search functionality to the scrollback buffer, triggered by a |
|
|
74 | hotkey (default: C<M-s>). When in search mode, terminal input/output is |
|
|
75 | suspended, C</> starts an incremental regex search, C<n> searches further, |
|
|
76 | C<p> jumps to the previous match. C<enter> leaves search mode at the |
|
|
77 | current position and C<escape> returns to the original position. |
|
|
78 | |
56 | =item digital-clock |
79 | =item digital-clock |
|
|
80 | |
|
|
81 | Displays a digital clock using the built-in overlay. |
|
|
82 | |
|
|
83 | =item mark-urls |
|
|
84 | |
|
|
85 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
|
|
86 | |
|
|
87 | =item block-graphics-to-ascii |
|
|
88 | |
|
|
89 | A not very useful example of filtering all text output to the terminal, |
|
|
90 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
91 | similar-looking ascii character. |
|
|
92 | |
|
|
93 | =item example-refresh-hooks |
57 | |
94 | |
58 | Displays a very simple digital clock in the upper right corner of the |
95 | Displays a very simple digital clock in the upper right corner of the |
59 | window. Illustrates overwriting the refresh callbacks to create your own |
96 | window. Illustrates overwriting the refresh callbacks to create your own |
60 | overlays or changes. |
97 | overlays or changes. |
61 | |
98 | |
62 | =item simple-overlay-clock |
|
|
63 | |
|
|
64 | Displays a digital clock using the built-in overlay (colourful, useless). |
|
|
65 | |
|
|
66 | =back |
99 | =back |
67 | |
100 | |
68 | =head2 General API Considerations |
101 | =head2 General API Considerations |
69 | |
102 | |
70 | All objects (such as terminals, time watchers etc.) are typical |
103 | All objects (such as terminals, time watchers etc.) are typical |
71 | reference-to-hash objects. The hash can be used to store anything you |
104 | reference-to-hash objects. The hash can be used to store anything you |
72 | like. All members starting with an underscore (such as C<_ptr> or |
105 | like. All members starting with an underscore (such as C<_ptr> or |
73 | C<_hook>) are reserved for internal uses and must not be accessed or |
106 | C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or |
74 | modified). |
107 | modified). |
75 | |
108 | |
76 | When objects are destroyed on the C++ side, the perl object hashes are |
109 | When objects are destroyed on the C++ side, the perl object hashes are |
77 | emptied, so its best to store related objects such as time watchers and |
110 | emptied, so its best to store related objects such as time watchers and |
78 | the like inside the terminal object so they get destroyed as soon as the |
111 | the like inside the terminal object so they get destroyed as soon as the |
79 | terminal is destroyed. |
112 | terminal is destroyed. |
80 | |
113 | |
|
|
114 | Argument names also often indicate the type of a parameter. Here are some |
|
|
115 | hints on what they mean: |
|
|
116 | |
|
|
117 | =over 4 |
|
|
118 | |
|
|
119 | =item $text |
|
|
120 | |
|
|
121 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
|
|
122 | always represents one screen cell. See L<row_t> for a discussion of this format. |
|
|
123 | |
|
|
124 | =item $string |
|
|
125 | |
|
|
126 | A perl text string, with an emphasis on I<text>. It can store all unicode |
|
|
127 | characters and is to be distinguished with text encoded in a specific |
|
|
128 | encoding (often locale-specific) and binary data. |
|
|
129 | |
|
|
130 | =item $octets |
|
|
131 | |
|
|
132 | Either binary data or - more common - a text string encoded in a |
|
|
133 | locale-specific way. |
|
|
134 | |
|
|
135 | =back |
|
|
136 | |
|
|
137 | =head2 Extension Objects |
|
|
138 | |
|
|
139 | Very perl extension is a perl class. A separate perl object is created |
|
|
140 | for each terminal and each extension and passed as the first parameter to |
|
|
141 | hooks. So extensions can use their C<$self> object without having to think |
|
|
142 | about other extensions, with the exception of methods and members that |
|
|
143 | begin with an underscore character C<_>: these are reserved for internal |
|
|
144 | use. |
|
|
145 | |
|
|
146 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
|
|
147 | C<urxvt::term> class on this object. |
|
|
148 | |
|
|
149 | It has the following methods and data members: |
|
|
150 | |
|
|
151 | =over 4 |
|
|
152 | |
|
|
153 | =item $urxvt_term = $self->{term} |
|
|
154 | |
|
|
155 | Returns the C<urxvt::term> object associated with this instance of the |
|
|
156 | extension. This member I<must not> be changed in any way. |
|
|
157 | |
|
|
158 | =item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
159 | |
|
|
160 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
161 | this extension, replacing any previous hook. This is useful when you want |
|
|
162 | to overwrite time-critical hooks only temporarily. |
|
|
163 | |
|
|
164 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
165 | |
|
|
166 | Dynamically disable the given hooks. |
|
|
167 | |
|
|
168 | =back |
|
|
169 | |
81 | =head2 Hooks |
170 | =head2 Hooks |
82 | |
171 | |
83 | The following subroutines can be declared in loaded scripts, and will be called |
172 | The following subroutines can be declared in extension files, and will be |
84 | whenever the relevant event happens. |
173 | called whenever the relevant event happens. |
85 | |
174 | |
|
|
175 | The first argument passed to them is an extension oject as described in |
|
|
176 | the in the C<Extension Objects> section. |
|
|
177 | |
86 | All of them must return a boolean value. If it is true, then the event |
178 | B<All> of these hooks must return a boolean value. If it is true, then the |
87 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
179 | event counts as being I<consumed>, and the invocation of other hooks is |
88 | and the relevant action might not be carried out by the C++ code. |
180 | skipped, and the relevant action might not be carried out by the C++ code. |
89 | |
181 | |
90 | When in doubt, return a false value (preferably C<()>). |
182 | I<< When in doubt, return a false value (preferably C<()>). >> |
91 | |
183 | |
92 | =over 4 |
184 | =over 4 |
93 | |
185 | |
94 | =item on_init $term |
186 | =item on_init $term |
95 | |
187 | |
96 | Called after a new terminal object has been initialized, but before |
188 | Called after a new terminal object has been initialized, but before |
97 | windows are created or the command gets run. |
189 | windows are created or the command gets run. Most methods are unsafe to |
|
|
190 | call or deliver senseless data, as terminal size and other characteristics |
|
|
191 | have not yet been determined. You can safely query and change resources, |
|
|
192 | though. |
98 | |
193 | |
99 | =item on_reset $term |
194 | =item on_reset $term |
100 | |
195 | |
101 | Called after the screen is "reset" for any reason, such as resizing or |
196 | Called after the screen is "reset" for any reason, such as resizing or |
102 | control sequences. Here is where you can react on changes to size-related |
197 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
122 | requested from the server. The selection text can be queried and changed |
217 | requested from the server. The selection text can be queried and changed |
123 | by calling C<< $term->selection >>. |
218 | by calling C<< $term->selection >>. |
124 | |
219 | |
125 | Returning a true value aborts selection grabbing. It will still be hilighted. |
220 | Returning a true value aborts selection grabbing. It will still be hilighted. |
126 | |
221 | |
127 | =item on_focus_in $term |
222 | =item on_sel_extend $term |
128 | |
223 | |
129 | Called whenever the window gets the keyboard focus, before urxvt does |
224 | Called whenever the user tries to extend the selection (e.g. with a double |
130 | focus in processing. |
225 | click) and is either supposed to return false (normal operation), or |
131 | |
226 | should extend the selection itelf and return true to suppress the built-in |
132 | =item on_focus_out $term |
|
|
133 | |
|
|
134 | Called wheneever the window loses keyboard focus, before urxvt does focus |
|
|
135 | out processing. |
227 | processing. |
|
|
228 | |
|
|
229 | See the F<selection> example extension. |
136 | |
230 | |
137 | =item on_view_change $term, $offset |
231 | =item on_view_change $term, $offset |
138 | |
232 | |
139 | Called whenever the view offset changes, i..e the user or program |
233 | Called whenever the view offset changes, i..e the user or program |
140 | scrolls. Offset C<0> means display the normal terminal, positive values |
234 | scrolls. Offset C<0> means display the normal terminal, positive values |
… | |
… | |
148 | |
242 | |
149 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
243 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
150 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
244 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
151 | number of lines that will be in the scrollback buffer. |
245 | number of lines that will be in the scrollback buffer. |
152 | |
246 | |
153 | =item on_tty_activity $term *NYI* |
247 | =item on_osc_seq $term, $string |
154 | |
248 | |
155 | Called whenever the program(s) running in the urxvt window send output. |
249 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
|
|
250 | operating system command) is processed. Cursor position and other state |
|
|
251 | information is up-to-date when this happens. For interoperability, the |
|
|
252 | string should start with the extension name and a colon, to distinguish |
|
|
253 | it from commands for other extensions, and this might be enforced in the |
|
|
254 | future. |
|
|
255 | |
|
|
256 | Be careful not ever to trust (in a security sense) the data you receive, |
|
|
257 | as its source can not easily be controleld (e-mail content, messages from |
|
|
258 | other users on the same system etc.). |
|
|
259 | |
|
|
260 | =item on_add_lines $term, $string |
|
|
261 | |
|
|
262 | Called whenever text is about to be output, with the text as argument. You |
|
|
263 | can filter/change and output the text yourself by returning a true value |
|
|
264 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
|
|
265 | might be very slow, however, as your hook is called for B<all> text being |
|
|
266 | output. |
|
|
267 | |
|
|
268 | =item on_line_update $term, $row |
|
|
269 | |
|
|
270 | Called whenever a line was updated or changed. Can be used to filter |
|
|
271 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
272 | that are being shown will be filtered, and, due to performance reasons, |
|
|
273 | not always immediately. |
|
|
274 | |
|
|
275 | The row number is always the topmost row of the line if the line spans |
|
|
276 | multiple rows. |
|
|
277 | |
|
|
278 | Please note that, if you change the line, then the hook might get called |
|
|
279 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
280 | you cannot just toggle rendition bits, but only set them. |
156 | |
281 | |
157 | =item on_refresh_begin $term |
282 | =item on_refresh_begin $term |
158 | |
283 | |
159 | Called just before the screen gets redrawn. Can be used for overlay |
284 | Called just before the screen gets redrawn. Can be used for overlay |
160 | or similar effects by modify terminal contents in refresh_begin, and |
285 | or similar effects by modify terminal contents in refresh_begin, and |
… | |
… | |
169 | |
294 | |
170 | Called whenever the user presses a key combination that has a |
295 | Called whenever the user presses a key combination that has a |
171 | C<perl:string> action bound to it (see description of the B<keysym> |
296 | C<perl:string> action bound to it (see description of the B<keysym> |
172 | resource in the @@RXVT_NAME@@(1) manpage). |
297 | resource in the @@RXVT_NAME@@(1) manpage). |
173 | |
298 | |
|
|
299 | =item on_focus_in $term |
|
|
300 | |
|
|
301 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
|
|
302 | does focus in processing. |
|
|
303 | |
|
|
304 | =item on_focus_out $term |
|
|
305 | |
|
|
306 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
|
|
307 | focus out processing. |
|
|
308 | |
|
|
309 | =item on_key_press $term, $event, $keysym, $octets |
|
|
310 | |
|
|
311 | =item on_key_release $term, $event, $keysym |
|
|
312 | |
|
|
313 | =item on_button_press $term, $event |
|
|
314 | |
|
|
315 | =item on_button_release $term, $event |
|
|
316 | |
|
|
317 | =item on_motion_notify $term, $event |
|
|
318 | |
|
|
319 | =item on_map_notify $term, $event |
|
|
320 | |
|
|
321 | =item on_unmap_notify $term, $event |
|
|
322 | |
|
|
323 | Called whenever the corresponding X event is received for the terminal If |
|
|
324 | the hook returns true, then the even will be ignored by rxvt-unicode. |
|
|
325 | |
|
|
326 | The event is a hash with most values as named by Xlib (see the XEvent |
|
|
327 | manpage), with the additional members C<row> and C<col>, which are the row |
|
|
328 | and column under the mouse cursor. |
|
|
329 | |
|
|
330 | C<on_key_press> additionally receives the string rxvt-unicode would |
|
|
331 | output, if any, in locale-specific encoding. |
|
|
332 | |
|
|
333 | subwindow. |
|
|
334 | |
174 | =back |
335 | =back |
175 | |
336 | |
|
|
337 | =head2 Variables in the C<urxvt> Package |
|
|
338 | |
|
|
339 | =over 4 |
|
|
340 | |
|
|
341 | =item $urxvt::TERM |
|
|
342 | |
|
|
343 | The current terminal. This variable stores the current C<urxvt::term> |
|
|
344 | object, whenever a callback/hook is executing. |
|
|
345 | |
|
|
346 | =back |
|
|
347 | |
176 | =head2 Functions in the C<urxvt> Package |
348 | =head2 Functions in the C<urxvt> Package |
177 | |
349 | |
178 | =over 4 |
350 | =over 4 |
|
|
351 | |
|
|
352 | =item $term = new urxvt [arg...] |
|
|
353 | |
|
|
354 | Creates a new terminal, very similar as if you had started it with |
|
|
355 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
356 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
357 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
358 | C<init> and C<start> hooks will be called during the call. |
179 | |
359 | |
180 | =item urxvt::fatal $errormessage |
360 | =item urxvt::fatal $errormessage |
181 | |
361 | |
182 | Fatally aborts execution with the given error message. Avoid at all |
362 | Fatally aborts execution with the given error message. Avoid at all |
183 | costs! The only time this is acceptable is when the terminal process |
363 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
190 | that calls this function. |
370 | that calls this function. |
191 | |
371 | |
192 | Using this function has the advantage that its output ends up in the |
372 | Using this function has the advantage that its output ends up in the |
193 | correct place, e.g. on stderr of the connecting urxvtc client. |
373 | correct place, e.g. on stderr of the connecting urxvtc client. |
194 | |
374 | |
|
|
375 | =item $is_safe = urxvt::safe |
|
|
376 | |
|
|
377 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
378 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
379 | started setuid or setgid. |
|
|
380 | |
195 | =item $time = urxvt::NOW |
381 | =item $time = urxvt::NOW |
196 | |
382 | |
197 | Returns the "current time" (as per the event loop). |
383 | Returns the "current time" (as per the event loop). |
|
|
384 | |
|
|
385 | =item urxvt::CurrentTime |
|
|
386 | |
|
|
387 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
388 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
389 | Button4Mask, Button5Mask, AnyModifier |
|
|
390 | |
|
|
391 | Various constants for use in X calls and event processing. |
|
|
392 | |
|
|
393 | =back |
198 | |
394 | |
199 | =head2 RENDITION |
395 | =head2 RENDITION |
200 | |
396 | |
201 | Rendition bitsets contain information about colour, font, font styles and |
397 | Rendition bitsets contain information about colour, font, font styles and |
202 | similar information for each screen cell. |
398 | similar information for each screen cell. |
… | |
… | |
250 | |
446 | |
251 | =cut |
447 | =cut |
252 | |
448 | |
253 | package urxvt; |
449 | package urxvt; |
254 | |
450 | |
|
|
451 | use utf8; |
255 | use strict; |
452 | use strict; |
|
|
453 | use Carp (); |
|
|
454 | use Scalar::Util (); |
|
|
455 | use List::Util (); |
256 | |
456 | |
257 | our $term; |
457 | our $VERSION = 1; |
|
|
458 | our $TERM; |
258 | our @HOOKNAME; |
459 | our @HOOKNAME; |
|
|
460 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
|
|
461 | our %OPTION; |
259 | our $LIBDIR; |
462 | our $LIBDIR; |
260 | |
463 | |
261 | BEGIN { |
464 | BEGIN { |
262 | urxvt->bootstrap; |
465 | urxvt->bootstrap; |
263 | |
466 | |
… | |
… | |
266 | my $msg = join "", @_; |
469 | my $msg = join "", @_; |
267 | $msg .= "\n" |
470 | $msg .= "\n" |
268 | unless $msg =~ /\n$/; |
471 | unless $msg =~ /\n$/; |
269 | urxvt::warn ($msg); |
472 | urxvt::warn ($msg); |
270 | }; |
473 | }; |
|
|
474 | |
|
|
475 | delete $ENV{IFS}; |
|
|
476 | delete $ENV{CDPATH}; |
|
|
477 | delete $ENV{BASH_ENV}; |
|
|
478 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
271 | } |
479 | } |
272 | |
480 | |
273 | my @hook_count; |
481 | my @hook_count; |
274 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
482 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
275 | |
483 | |
276 | sub verbose { |
484 | sub verbose { |
277 | my ($level, $msg) = @_; |
485 | my ($level, $msg) = @_; |
278 | warn "$msg\n" if $level <= $verbosity; |
486 | warn "$msg\n" if $level <= $verbosity; |
279 | } |
487 | } |
280 | |
488 | |
281 | # find on_xxx subs in the package and register them |
489 | my $extension_pkg = "extension0000"; |
282 | # as hooks |
490 | my %extension_pkg; |
283 | sub register_package($) { |
|
|
284 | my ($pkg) = @_; |
|
|
285 | |
|
|
286 | for my $htype (0.. $#HOOKNAME) { |
|
|
287 | my $name = $HOOKNAME[$htype]; |
|
|
288 | |
|
|
289 | my $ref = $pkg->can ("on_" . lc $name) |
|
|
290 | or next; |
|
|
291 | |
|
|
292 | $term->{_hook}[$htype]{$ref*1} = $ref; |
|
|
293 | $hook_count[$htype]++ |
|
|
294 | or set_should_invoke $htype, 1; |
|
|
295 | } |
|
|
296 | } |
|
|
297 | |
|
|
298 | my $script_pkg = "script0000"; |
|
|
299 | my %script_pkg; |
|
|
300 | |
491 | |
301 | # load a single script into its own package, once only |
492 | # load a single script into its own package, once only |
302 | sub script_package($) { |
493 | sub extension_package($) { |
303 | my ($path) = @_; |
494 | my ($path) = @_; |
304 | |
495 | |
305 | $script_pkg{$path} ||= do { |
496 | $extension_pkg{$path} ||= do { |
306 | my $pkg = "urxvt::" . ($script_pkg++); |
497 | my $pkg = "urxvt::" . ($extension_pkg++); |
307 | |
498 | |
308 | verbose 3, "loading script '$path' into package '$pkg'"; |
499 | verbose 3, "loading extension '$path' into package '$pkg'"; |
309 | |
500 | |
310 | open my $fh, "<:raw", $path |
501 | open my $fh, "<:raw", $path |
311 | or die "$path: $!"; |
502 | or die "$path: $!"; |
312 | |
503 | |
|
|
504 | my $source = untaint |
313 | my $source = "package $pkg; use strict; use utf8;\n" |
505 | "package $pkg; use strict; use utf8;\n" |
|
|
506 | . "use base urxvt::term::extension::;\n" |
314 | . "#line 1 \"$path\"\n{\n" |
507 | . "#line 1 \"$path\"\n{\n" |
315 | . (do { local $/; <$fh> }) |
508 | . (do { local $/; <$fh> }) |
316 | . "\n};\n1"; |
509 | . "\n};\n1"; |
317 | |
510 | |
|
|
511 | eval $source |
318 | eval $source or die "$path: $@"; |
512 | or die "$path: $@"; |
319 | |
513 | |
320 | $pkg |
514 | $pkg |
321 | } |
515 | } |
322 | } |
516 | } |
323 | |
517 | |
|
|
518 | our $retval; # return value for urxvt |
|
|
519 | |
324 | # called by the rxvt core |
520 | # called by the rxvt core |
325 | sub invoke { |
521 | sub invoke { |
326 | local $term = shift; |
522 | local $TERM = shift; |
327 | my $htype = shift; |
523 | my $htype = shift; |
328 | |
524 | |
329 | if ($htype == 0) { # INIT |
525 | if ($htype == 0) { # INIT |
330 | my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); |
526 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
|
|
527 | |
|
|
528 | my %ext_arg; |
331 | |
529 | |
332 | for my $ext (split /:/, $term->resource ("perl_ext")) { |
530 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
|
|
531 | if ($_ eq "default") { |
|
|
532 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
|
|
533 | } elsif (/^-(.*)$/) { |
|
|
534 | delete $ext_arg{$1}; |
|
|
535 | } elsif (/^([^<]+)<(.*)>$/) { |
|
|
536 | push @{ $ext_arg{$1} }, $2; |
|
|
537 | } else { |
|
|
538 | $ext_arg{$_} ||= []; |
|
|
539 | } |
|
|
540 | } |
|
|
541 | |
|
|
542 | while (my ($ext, $argv) = each %ext_arg) { |
333 | my @files = grep -f $_, map "$_/$ext", @dirs; |
543 | my @files = grep -f $_, map "$_/$ext", @dirs; |
334 | |
544 | |
335 | if (@files) { |
545 | if (@files) { |
336 | register_package script_package $files[0]; |
546 | $TERM->register_package (extension_package $files[0], $argv); |
337 | } else { |
547 | } else { |
338 | warn "perl extension '$ext' not found in perl library search path\n"; |
548 | warn "perl extension '$ext' not found in perl library search path\n"; |
339 | } |
549 | } |
340 | } |
550 | } |
341 | |
551 | |
|
|
552 | eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); |
|
|
553 | warn $@ if $@; |
|
|
554 | } |
|
|
555 | |
|
|
556 | $retval = undef; |
|
|
557 | |
|
|
558 | if (my $cb = $TERM->{_hook}[$htype]) { |
|
|
559 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
|
|
560 | if $verbosity >= 10; |
|
|
561 | |
|
|
562 | keys %$cb; |
|
|
563 | |
|
|
564 | while (my ($pkg, $cb) = each %$cb) { |
|
|
565 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
|
|
566 | and last; |
|
|
567 | |
|
|
568 | if ($@) { |
|
|
569 | $TERM->ungrab; # better to lose the grab than the session |
|
|
570 | warn $@; |
|
|
571 | } |
|
|
572 | } |
|
|
573 | } |
|
|
574 | |
342 | } elsif ($htype == 1) { # DESTROY |
575 | if ($htype == 1) { # DESTROY |
343 | if (my $hook = $term->{_hook}) { |
576 | if (my $hook = delete $TERM->{_hook}) { |
344 | for my $htype (0..$#$hook) { |
577 | for my $htype (0..$#$hook) { |
345 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
578 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
346 | or set_should_invoke $htype, 0; |
579 | or set_should_invoke $htype, 0; |
347 | } |
580 | } |
348 | } |
581 | } |
|
|
582 | |
|
|
583 | # clear package objects |
|
|
584 | %$_ = () for values %{ $TERM->{_pkg} }; |
|
|
585 | |
|
|
586 | # clear package |
|
|
587 | %$TERM = (); |
349 | } |
588 | } |
350 | |
589 | |
351 | my $cb = $term->{_hook}[$htype] |
590 | $retval |
352 | or return; |
591 | } |
353 | |
592 | |
354 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" |
593 | # urxvt::term::extension |
355 | if $verbosity >= 10; |
|
|
356 | |
594 | |
|
|
595 | package urxvt::term::extension; |
|
|
596 | |
|
|
597 | sub enable { |
|
|
598 | my ($self, %hook) = @_; |
|
|
599 | my $pkg = $self->{_pkg}; |
|
|
600 | |
357 | while (my ($k, $v) = each %$cb) { |
601 | while (my ($name, $cb) = each %hook) { |
358 | return 1 if $v->($term, @_); |
602 | my $htype = $HOOKTYPE{uc $name}; |
|
|
603 | defined $htype |
|
|
604 | or Carp::croak "unsupported hook type '$name'"; |
|
|
605 | |
|
|
606 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
|
|
607 | $hook_count[$htype]++ |
|
|
608 | or urxvt::set_should_invoke $htype, 1; |
|
|
609 | } |
|
|
610 | |
|
|
611 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
359 | } |
612 | } |
|
|
613 | } |
360 | |
614 | |
|
|
615 | sub disable { |
|
|
616 | my ($self, @hook) = @_; |
|
|
617 | my $pkg = $self->{_pkg}; |
|
|
618 | |
|
|
619 | for my $name (@hook) { |
|
|
620 | my $htype = $HOOKTYPE{uc $name}; |
|
|
621 | defined $htype |
|
|
622 | or Carp::croak "unsupported hook type '$name'"; |
|
|
623 | |
|
|
624 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
|
|
625 | --$hook_count[$htype] |
|
|
626 | or urxvt::set_should_invoke $htype, 0; |
|
|
627 | } |
361 | 0 |
628 | } |
362 | } |
629 | } |
363 | |
630 | |
364 | =back |
631 | our $AUTOLOAD; |
|
|
632 | |
|
|
633 | sub AUTOLOAD { |
|
|
634 | $AUTOLOAD =~ /:([^:]+)$/ |
|
|
635 | or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable"; |
|
|
636 | |
|
|
637 | eval qq{ |
|
|
638 | sub $AUTOLOAD { |
|
|
639 | my \$proxy = shift; |
|
|
640 | \$proxy->{term}->$1 (\@_) |
|
|
641 | } |
|
|
642 | 1 |
|
|
643 | } or die "FATAL: unable to compile method forwarder: $@"; |
|
|
644 | |
|
|
645 | goto &$AUTOLOAD; |
|
|
646 | } |
|
|
647 | |
|
|
648 | sub DESTROY { |
|
|
649 | # nop |
|
|
650 | } |
|
|
651 | |
|
|
652 | # urxvt::destroy_hook |
|
|
653 | |
|
|
654 | sub urxvt::destroy_hook::DESTROY { |
|
|
655 | ${$_[0]}->(); |
|
|
656 | } |
|
|
657 | |
|
|
658 | sub urxvt::destroy_hook(&) { |
|
|
659 | bless \shift, urxvt::destroy_hook:: |
|
|
660 | } |
|
|
661 | |
|
|
662 | package urxvt::anyevent; |
|
|
663 | |
|
|
664 | =head2 The C<urxvt::anyevent> Class |
|
|
665 | |
|
|
666 | The sole purpose of this class is to deliver an interface to the |
|
|
667 | C<AnyEvent> module - any module using it will work inside urxvt without |
|
|
668 | further work. The only exception is that you cannot wait on condition |
|
|
669 | variables, but non-blocking condvar use is ok. What this means is that you |
|
|
670 | cannot use blocking APIs, but the non-blocking variant should work. |
|
|
671 | |
|
|
672 | =cut |
|
|
673 | |
|
|
674 | our $VERSION = 1; |
|
|
675 | |
|
|
676 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
|
|
677 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
|
|
678 | |
|
|
679 | sub timer { |
|
|
680 | my ($class, %arg) = @_; |
|
|
681 | |
|
|
682 | my $cb = $arg{cb}; |
|
|
683 | |
|
|
684 | urxvt::timer |
|
|
685 | ->new |
|
|
686 | ->start (urxvt::NOW + $arg{after}) |
|
|
687 | ->cb (sub { |
|
|
688 | $_[0]->stop; # need to cancel manually |
|
|
689 | $cb->(); |
|
|
690 | }) |
|
|
691 | } |
|
|
692 | |
|
|
693 | sub io { |
|
|
694 | my ($class, %arg) = @_; |
|
|
695 | |
|
|
696 | my $cb = $arg{cb}; |
|
|
697 | |
|
|
698 | bless [$arg{fh}, urxvt::iow |
|
|
699 | ->new |
|
|
700 | ->fd (fileno $arg{fh}) |
|
|
701 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
|
|
702 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
|
|
703 | ->start |
|
|
704 | ->cb (sub { |
|
|
705 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
706 | . ($_[1] & 2 ? 'w' : '')); |
|
|
707 | })], |
|
|
708 | urxvt::anyevent:: |
|
|
709 | } |
|
|
710 | |
|
|
711 | sub DESTROY { |
|
|
712 | $_[0][1]->stop; |
|
|
713 | } |
|
|
714 | |
|
|
715 | sub condvar { |
|
|
716 | bless \my $flag, urxvt::anyevent::condvar:: |
|
|
717 | } |
|
|
718 | |
|
|
719 | sub urxvt::anyevent::condvar::broadcast { |
|
|
720 | ${$_[0]}++; |
|
|
721 | } |
|
|
722 | |
|
|
723 | sub urxvt::anyevent::condvar::wait { |
|
|
724 | unless (${$_[0]}) { |
|
|
725 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
|
|
726 | } |
|
|
727 | } |
|
|
728 | |
|
|
729 | package urxvt::term; |
365 | |
730 | |
366 | =head2 The C<urxvt::term> Class |
731 | =head2 The C<urxvt::term> Class |
367 | |
732 | |
368 | =over 4 |
733 | =over 4 |
|
|
734 | |
|
|
735 | =cut |
|
|
736 | |
|
|
737 | # find on_xxx subs in the package and register them |
|
|
738 | # as hooks |
|
|
739 | sub register_package { |
|
|
740 | my ($self, $pkg, $argv) = @_; |
|
|
741 | |
|
|
742 | my $proxy = bless { |
|
|
743 | _pkg => $pkg, |
|
|
744 | argv => $argv, |
|
|
745 | }, $pkg; |
|
|
746 | Scalar::Util::weaken ($proxy->{term} = $self); |
|
|
747 | |
|
|
748 | $self->{_pkg}{$pkg} = $proxy; |
|
|
749 | |
|
|
750 | for my $name (@HOOKNAME) { |
|
|
751 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
|
|
752 | $proxy->enable ($name => $ref); |
|
|
753 | } |
|
|
754 | } |
|
|
755 | } |
|
|
756 | |
|
|
757 | =item $term->destroy |
|
|
758 | |
|
|
759 | Destroy the terminal object (close the window, free resources etc.). |
|
|
760 | |
|
|
761 | =item $isset = $term->option ($optval[, $set]) |
|
|
762 | |
|
|
763 | Returns true if the option specified by C<$optval> is enabled, and |
|
|
764 | optionally change it. All option values are stored by name in the hash |
|
|
765 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
|
|
766 | |
|
|
767 | Here is a a likely non-exhaustive list of option names, please see the |
|
|
768 | source file F</src/optinc.h> to see the actual list: |
|
|
769 | |
|
|
770 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
|
|
771 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
|
|
772 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
|
|
773 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
|
|
774 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
|
|
775 | tripleclickwords utmpInhibit visualBell |
369 | |
776 | |
370 | =item $value = $term->resource ($name[, $newval]) |
777 | =item $value = $term->resource ($name[, $newval]) |
371 | |
778 | |
372 | Returns the current resource value associated with a given name and |
779 | Returns the current resource value associated with a given name and |
373 | optionally sets a new value. Setting values is most useful in the C<init> |
780 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
383 | |
790 | |
384 | Please note that resource strings will currently only be freed when the |
791 | Please note that resource strings will currently only be freed when the |
385 | terminal is destroyed, so changing options frequently will eat memory. |
792 | terminal is destroyed, so changing options frequently will eat memory. |
386 | |
793 | |
387 | Here is a a likely non-exhaustive list of resource names, not all of which |
794 | Here is a a likely non-exhaustive list of resource names, not all of which |
388 | are supported in every build, please see the source to see the actual |
795 | are supported in every build, please see the source file F</src/rsinc.h> |
389 | list: |
796 | to see the actual list: |
390 | |
797 | |
391 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
798 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
392 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
799 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
393 | display_name embed ext_bwidth fade font geometry hold iconName |
800 | display_name embed ext_bwidth fade font geometry hold iconName |
394 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
801 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
395 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
802 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
396 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
803 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
397 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
804 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
398 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
805 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
399 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
806 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
400 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
807 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
401 | shade term_name title transparent transparent_all tripleclickwords |
808 | shade term_name title transparent transparent_all tripleclickwords |
402 | utmpInhibit visualBell |
809 | utmpInhibit visualBell |
403 | |
810 | |
404 | =cut |
811 | =cut |
405 | |
812 | |
406 | sub urxvt::term::resource($$;$) { |
813 | sub resource($$;$) { |
407 | my ($self, $name) = (shift, shift); |
814 | my ($self, $name) = (shift, shift); |
408 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
815 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
409 | goto &urxvt::term::_resource; |
816 | &urxvt::term::_resource |
410 | } |
817 | } |
|
|
818 | |
|
|
819 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
|
|
820 | |
|
|
821 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
822 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
|
|
823 | |
|
|
824 | =item $rend = $term->rstyle ([$new_rstyle]) |
|
|
825 | |
|
|
826 | Return and optionally change the current rendition. Text that is output by |
|
|
827 | the terminal application will use this style. |
|
|
828 | |
|
|
829 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
830 | |
|
|
831 | Return the current coordinates of the text cursor position and optionally |
|
|
832 | set it (which is usually bad as applications don't expect that). |
411 | |
833 | |
412 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
834 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
413 | |
835 | |
414 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
836 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
415 | |
837 | |
… | |
… | |
425 | |
847 | |
426 | =item $oldtext = $term->selection ([$newtext]) |
848 | =item $oldtext = $term->selection ([$newtext]) |
427 | |
849 | |
428 | Return the current selection text and optionally replace it by C<$newtext>. |
850 | Return the current selection text and optionally replace it by C<$newtext>. |
429 | |
851 | |
430 | =item $term->scr_overlay ($x, $y, $text) |
852 | =item $term->overlay_simple ($x, $y, $text) |
431 | |
853 | |
432 | Create a simple multi-line overlay box. See the next method for details. |
854 | Create a simple multi-line overlay box. See the next method for details. |
433 | |
855 | |
434 | =cut |
856 | =cut |
435 | |
857 | |
436 | sub urxvt::term::scr_overlay { |
858 | sub overlay_simple { |
437 | my ($self, $x, $y, $text) = @_; |
859 | my ($self, $x, $y, $text) = @_; |
438 | |
860 | |
439 | my @lines = split /\n/, $text; |
861 | my @lines = split /\n/, $text; |
440 | |
862 | |
441 | my $w = 0; |
863 | my $w = List::Util::max map $self->strwidth ($_), @lines; |
442 | for (map $self->strwidth ($_), @lines) { |
|
|
443 | $w = $_ if $w < $_; |
|
|
444 | } |
|
|
445 | |
864 | |
446 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
865 | my $overlay = $self->overlay ($x, $y, $w, scalar @lines); |
447 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
866 | $overlay->set (0, $_, $lines[$_]) for 0.. $#lines; |
448 | } |
|
|
449 | |
867 | |
|
|
868 | $overlay |
|
|
869 | } |
|
|
870 | |
450 | =item $term->scr_overlay_new ($x, $y, $width, $height) |
871 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
451 | |
872 | |
452 | Create a new (empty) overlay at the given position with the given |
873 | Create a new (empty) overlay at the given position with the given |
453 | width/height. A border will be put around the box. If either C<$x> or |
874 | width/height. C<$rstyle> defines the initial rendition style |
454 | C<$y> is negative, then this is counted from the right/bottom side, |
875 | (default: C<OVERLAY_RSTYLE>). |
455 | respectively. |
|
|
456 | |
876 | |
457 | =item $term->scr_overlay_off |
877 | If C<$border> is C<2> (default), then a decorative border will be put |
|
|
878 | around the box. |
458 | |
879 | |
459 | Switch the overlay off again. |
880 | If either C<$x> or C<$y> is negative, then this is counted from the |
|
|
881 | right/bottom side, respectively. |
460 | |
882 | |
461 | =item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) |
883 | This method returns an urxvt::overlay object. The overlay will be visible |
|
|
884 | as long as the perl object is referenced. |
462 | |
885 | |
463 | Put a single character (specified numerically) at the given overlay |
886 | The methods currently supported on C<urxvt::overlay> objects are: |
464 | position. |
|
|
465 | |
887 | |
|
|
888 | =over 4 |
|
|
889 | |
466 | =item $term->scr_overlay_set ($x, $y, $text) |
890 | =item $overlay->set ($x, $y, $text, $rend) |
467 | |
891 | |
468 | Write a string at the given position into the overlay. |
892 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
|
|
893 | text in rxvt-unicode's special encoding and an array of rendition values |
|
|
894 | at a specific position inside the overlay. |
469 | |
895 | |
|
|
896 | =item $overlay->hide |
|
|
897 | |
|
|
898 | If visible, hide the overlay, but do not destroy it. |
|
|
899 | |
|
|
900 | =item $overlay->show |
|
|
901 | |
|
|
902 | If hidden, display the overlay again. |
|
|
903 | |
|
|
904 | =back |
|
|
905 | |
|
|
906 | =item $popup = $term->popup ($event) |
|
|
907 | |
|
|
908 | Creates a new C<urxvt::popup> object that implements a popup menu. The |
|
|
909 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
|
|
910 | currently). |
|
|
911 | |
|
|
912 | =cut |
|
|
913 | |
|
|
914 | sub popup { |
|
|
915 | my ($self, $event) = @_; |
|
|
916 | |
|
|
917 | $self->grab ($event->{time}, 1) |
|
|
918 | or return; |
|
|
919 | |
|
|
920 | my $popup = bless { |
|
|
921 | term => $self, |
|
|
922 | event => $event, |
|
|
923 | }, urxvt::popup::; |
|
|
924 | |
|
|
925 | Scalar::Util::weaken $popup->{term}; |
|
|
926 | |
|
|
927 | $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy }; |
|
|
928 | Scalar::Util::weaken $self->{_destroy}{$popup}; |
|
|
929 | |
|
|
930 | $popup |
|
|
931 | } |
|
|
932 | |
470 | =item $cellwidth = $term->strwidth $string |
933 | =item $cellwidth = $term->strwidth ($string) |
471 | |
934 | |
472 | Returns the number of screen-cells this string would need. Correctly |
935 | Returns the number of screen-cells this string would need. Correctly |
473 | accounts for wide and combining characters. |
936 | accounts for wide and combining characters. |
474 | |
937 | |
475 | =item $octets = $term->locale_encode $string |
938 | =item $octets = $term->locale_encode ($string) |
476 | |
939 | |
477 | Convert the given text string into the corresponding locale encoding. |
940 | Convert the given text string into the corresponding locale encoding. |
478 | |
941 | |
479 | =item $string = $term->locale_decode $octets |
942 | =item $string = $term->locale_decode ($octets) |
480 | |
943 | |
481 | Convert the given locale-encoded octets into a perl string. |
944 | Convert the given locale-encoded octets into a perl string. |
|
|
945 | |
|
|
946 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
|
|
947 | |
|
|
948 | XORs the rendition values in the given span with the provided value |
|
|
949 | (default: C<RS_RVid>). Useful in refresh hooks to provide effects similar |
|
|
950 | to the selection. |
|
|
951 | |
|
|
952 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
|
|
953 | |
|
|
954 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
|
|
955 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
|
|
956 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
|
|
957 | it instead. |
|
|
958 | |
|
|
959 | =item $term->scr_bell |
|
|
960 | |
|
|
961 | Ring the bell! |
|
|
962 | |
|
|
963 | =item $term->scr_add_lines ($string) |
|
|
964 | |
|
|
965 | Write the given text string to the screen, as if output by the application |
|
|
966 | running inside the terminal. It may not contain command sequences (escape |
|
|
967 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
968 | string is a normal text string, not in locale-dependent encoding. |
|
|
969 | |
|
|
970 | Normally its not a good idea to use this function, as programs might be |
|
|
971 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
972 | C<on_add_lines> hook, though. |
|
|
973 | |
|
|
974 | =item $term->cmd_parse ($octets) |
|
|
975 | |
|
|
976 | Similar to C<scr_add_lines>, but the argument must be in the |
|
|
977 | locale-specific encoding of the terminal and can contain command sequences |
|
|
978 | (escape codes) that will be interpreted. |
482 | |
979 | |
483 | =item $term->tt_write ($octets) |
980 | =item $term->tt_write ($octets) |
484 | |
981 | |
485 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
982 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
486 | pass characters instead of octets, you should convert your strings first |
983 | pass characters instead of octets, you should convert your strings first |
487 | to the locale-specific encoding using C<< $term->locale_encode >>. |
984 | to the locale-specific encoding using C<< $term->locale_encode >>. |
488 | |
985 | |
|
|
986 | =item $old_events = $term->pty_ev_events ([$new_events]) |
|
|
987 | |
|
|
988 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
989 | be used to suppress input and output handling to the pty/tty. See the |
|
|
990 | description of C<< urxvt::timer->events >>. Make sure to always restore |
|
|
991 | the previous value. |
|
|
992 | |
|
|
993 | =item $windowid = $term->parent |
|
|
994 | |
|
|
995 | Return the window id of the toplevel window. |
|
|
996 | |
|
|
997 | =item $windowid = $term->vt |
|
|
998 | |
|
|
999 | Return the window id of the terminal window. |
|
|
1000 | |
|
|
1001 | =item $window_width = $term->width |
|
|
1002 | |
|
|
1003 | =item $window_height = $term->height |
|
|
1004 | |
|
|
1005 | =item $font_width = $term->fwidth |
|
|
1006 | |
|
|
1007 | =item $font_height = $term->fheight |
|
|
1008 | |
|
|
1009 | =item $font_ascent = $term->fbase |
|
|
1010 | |
489 | =item $nrow = $term->nrow |
1011 | =item $terminal_rows = $term->nrow |
490 | |
1012 | |
491 | =item $ncol = $term->ncol |
1013 | =item $terminal_columns = $term->ncol |
492 | |
1014 | |
493 | Return the number of rows/columns of the terminal window (i.e. as |
1015 | =item $has_focus = $term->focus |
494 | specified by C<-geometry>, excluding any scrollback). |
|
|
495 | |
1016 | |
496 | =item $nsaved = $term->nsaved |
1017 | =item $is_mapped = $term->mapped |
497 | |
1018 | |
498 | Returns the number of lines in the scrollback buffer. |
1019 | =item $max_scrollback = $term->saveLines |
|
|
1020 | |
|
|
1021 | =item $nrow_plus_saveLines = $term->total_rows |
|
|
1022 | |
|
|
1023 | =item $lines_in_scrollback = $term->nsaved |
|
|
1024 | |
|
|
1025 | Return various integers describing terminal characteristics. |
|
|
1026 | |
|
|
1027 | =item $lc_ctype = $term->locale |
|
|
1028 | |
|
|
1029 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
1030 | |
|
|
1031 | =item $x_display = $term->display_id |
|
|
1032 | |
|
|
1033 | Return the DISPLAY used by rxvt-unicode. |
|
|
1034 | |
|
|
1035 | =item $modifiermask = $term->ModLevel3Mask |
|
|
1036 | |
|
|
1037 | =item $modifiermask = $term->ModMetaMask |
|
|
1038 | |
|
|
1039 | =item $modifiermask = $term->ModNumLockMask |
|
|
1040 | |
|
|
1041 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
|
|
1042 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
499 | |
1043 | |
500 | =item $view_start = $term->view_start ([$newvalue]) |
1044 | =item $view_start = $term->view_start ([$newvalue]) |
501 | |
1045 | |
502 | Returns the negative row number of the topmost line. Minimum value is |
1046 | Returns the negative row number of the topmost line. Minimum value is |
503 | C<0>, which displays the normal terminal contents. Larger values scroll |
1047 | C<0>, which displays the normal terminal contents. Larger values scroll |
… | |
… | |
514 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1058 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
515 | |
1059 | |
516 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1060 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
517 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1061 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
518 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
1062 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
519 | line C<< -$term->nsaved >>. |
1063 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
|
|
1064 | is requested. |
520 | |
1065 | |
521 | If C<$new_text> is specified, it will replace characters in the current |
1066 | If C<$new_text> is specified, it will replace characters in the current |
522 | line, starting at column C<$start_col> (default C<0>), which is useful |
1067 | line, starting at column C<$start_col> (default C<0>), which is useful |
523 | to replace only parts of a line. The font index in the rendition will |
1068 | to replace only parts of a line. The font index in the rendition will |
524 | automatically be updated. |
1069 | automatically be updated. |
… | |
… | |
546 | |
1091 | |
547 | See the section on RENDITION, above. |
1092 | See the section on RENDITION, above. |
548 | |
1093 | |
549 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
1094 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
550 | |
1095 | |
551 | Returns the number of screen cells that are in use ("the line length"). If |
1096 | Returns the number of screen cells that are in use ("the line |
552 | it is C<-1>, then the line is part of a multiple-row logical "line", which |
1097 | length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the |
553 | means all characters are in use and it is continued on the next row. |
1098 | line is joined with the following one. |
|
|
1099 | |
|
|
1100 | =item $bool = $term->is_longer ($row_number) |
|
|
1101 | |
|
|
1102 | Returns true if the row is part of a multiple-row logical "line" (i.e. |
|
|
1103 | joined with the following row), which means all characters are in use |
|
|
1104 | and it is continued on the next row (and possibly a continuation of the |
|
|
1105 | previous row(s)). |
|
|
1106 | |
|
|
1107 | =item $line = $term->line ($row_number) |
|
|
1108 | |
|
|
1109 | Create and return a new C<urxvt::line> object that stores information |
|
|
1110 | about the logical line that row C<$row_number> is part of. It supports the |
|
|
1111 | following methods: |
|
|
1112 | |
|
|
1113 | =over 4 |
|
|
1114 | |
|
|
1115 | =item $text = $line->t ([$new_text]) |
|
|
1116 | |
|
|
1117 | Returns or replaces the full text of the line, similar to C<ROW_t> |
|
|
1118 | |
|
|
1119 | =item $rend = $line->r ([$new_rend]) |
|
|
1120 | |
|
|
1121 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
|
|
1122 | |
|
|
1123 | =item $length = $line->l |
|
|
1124 | |
|
|
1125 | Returns the length of the line in cells, similar to C<ROW_l>. |
|
|
1126 | |
|
|
1127 | =item $rownum = $line->beg |
|
|
1128 | |
|
|
1129 | =item $rownum = $line->end |
|
|
1130 | |
|
|
1131 | Return the row number of the first/last row of the line, respectively. |
|
|
1132 | |
|
|
1133 | =item $offset = $line->offset_of ($row, $col) |
|
|
1134 | |
|
|
1135 | Returns the character offset of the given row|col pair within the logical |
|
|
1136 | line. |
|
|
1137 | |
|
|
1138 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
1139 | |
|
|
1140 | Translates a string offset into terminal coordinates again. |
|
|
1141 | |
|
|
1142 | =back |
|
|
1143 | |
|
|
1144 | =cut |
|
|
1145 | |
|
|
1146 | sub line { |
|
|
1147 | my ($self, $row) = @_; |
|
|
1148 | |
|
|
1149 | my $maxrow = $self->nrow - 1; |
|
|
1150 | |
|
|
1151 | my ($beg, $end) = ($row, $row); |
|
|
1152 | |
|
|
1153 | --$beg while $self->ROW_is_longer ($beg - 1); |
|
|
1154 | ++$end while $self->ROW_is_longer ($end) && $end < $maxrow; |
|
|
1155 | |
|
|
1156 | bless { |
|
|
1157 | term => $self, |
|
|
1158 | beg => $beg, |
|
|
1159 | end => $end, |
|
|
1160 | ncol => $self->ncol, |
|
|
1161 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
|
|
1162 | }, urxvt::line:: |
|
|
1163 | } |
|
|
1164 | |
|
|
1165 | sub urxvt::line::t { |
|
|
1166 | my ($self) = @_; |
|
|
1167 | |
|
|
1168 | if (@_ > 1) |
|
|
1169 | { |
|
|
1170 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
1171 | for $self->{beg} .. $self->{end}; |
|
|
1172 | } |
|
|
1173 | |
|
|
1174 | defined wantarray && |
|
|
1175 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
|
|
1176 | 0, $self->{len} |
|
|
1177 | } |
|
|
1178 | |
|
|
1179 | sub urxvt::line::r { |
|
|
1180 | my ($self) = @_; |
|
|
1181 | |
|
|
1182 | if (@_ > 1) |
|
|
1183 | { |
|
|
1184 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
1185 | for $self->{beg} .. $self->{end}; |
|
|
1186 | } |
|
|
1187 | |
|
|
1188 | if (defined wantarray) { |
|
|
1189 | my $rend = [ |
|
|
1190 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
|
|
1191 | ]; |
|
|
1192 | $#$rend = $self->{len} - 1; |
|
|
1193 | return $rend; |
|
|
1194 | } |
|
|
1195 | |
|
|
1196 | () |
|
|
1197 | } |
|
|
1198 | |
|
|
1199 | sub urxvt::line::beg { $_[0]{beg} } |
|
|
1200 | sub urxvt::line::end { $_[0]{end} } |
|
|
1201 | sub urxvt::line::l { $_[0]{len} } |
|
|
1202 | |
|
|
1203 | sub urxvt::line::offset_of { |
|
|
1204 | my ($self, $row, $col) = @_; |
|
|
1205 | |
|
|
1206 | ($row - $self->{beg}) * $self->{ncol} + $col |
|
|
1207 | } |
|
|
1208 | |
|
|
1209 | sub urxvt::line::coord_of { |
|
|
1210 | my ($self, $offset) = @_; |
|
|
1211 | |
|
|
1212 | use integer; |
|
|
1213 | |
|
|
1214 | ( |
|
|
1215 | $offset / $self->{ncol} + $self->{beg}, |
|
|
1216 | $offset % $self->{ncol} |
|
|
1217 | ) |
|
|
1218 | } |
554 | |
1219 | |
555 | =item $text = $term->special_encode $string |
1220 | =item $text = $term->special_encode $string |
556 | |
1221 | |
557 | Converts a perl string into the special encoding used by rxvt-unicode, |
1222 | Converts a perl string into the special encoding used by rxvt-unicode, |
558 | where one character corresponds to one screen cell. See |
1223 | where one character corresponds to one screen cell. See |
… | |
… | |
561 | =item $string = $term->special_decode $text |
1226 | =item $string = $term->special_decode $text |
562 | |
1227 | |
563 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1228 | Converts rxvt-unicodes text reprsentation into a perl string. See |
564 | C<< $term->ROW_t >> for details. |
1229 | C<< $term->ROW_t >> for details. |
565 | |
1230 | |
|
|
1231 | =item $success = $term->grab_button ($button, $modifiermask) |
|
|
1232 | |
|
|
1233 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
1234 | |
|
|
1235 | =item $success = $term->grab ($eventtime[, $sync]) |
|
|
1236 | |
|
|
1237 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1238 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
|
|
1239 | |
|
|
1240 | =item $term->allow_events_async |
|
|
1241 | |
|
|
1242 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1243 | |
|
|
1244 | =item $term->allow_events_sync |
|
|
1245 | |
|
|
1246 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1247 | |
|
|
1248 | =item $term->allow_events_replay |
|
|
1249 | |
|
|
1250 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1251 | recent grab. |
|
|
1252 | |
|
|
1253 | =item $term->ungrab |
|
|
1254 | |
|
|
1255 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1256 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1257 | the session. |
|
|
1258 | |
566 | =back |
1259 | =back |
|
|
1260 | |
|
|
1261 | =cut |
|
|
1262 | |
|
|
1263 | package urxvt::popup; |
|
|
1264 | |
|
|
1265 | =head2 The C<urxvt::popup> Class |
|
|
1266 | |
|
|
1267 | =over 4 |
|
|
1268 | |
|
|
1269 | =cut |
|
|
1270 | |
|
|
1271 | sub add_item { |
|
|
1272 | my ($self, $item) = @_; |
|
|
1273 | |
|
|
1274 | $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal}; |
|
|
1275 | $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover}; |
|
|
1276 | $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active}; |
|
|
1277 | |
|
|
1278 | $item->{render} ||= sub { $_[0]{text} }; |
|
|
1279 | |
|
|
1280 | push @{ $self->{item} }, $item; |
|
|
1281 | } |
|
|
1282 | |
|
|
1283 | sub add_separator { |
|
|
1284 | my ($self, $sep) = @_; |
|
|
1285 | |
|
|
1286 | $sep ||= "="; |
|
|
1287 | |
|
|
1288 | $self->add_item ({ |
|
|
1289 | rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, |
|
|
1290 | text => "", |
|
|
1291 | render => sub { $sep x $self->{term}->ncol }, |
|
|
1292 | activate => sub { }, |
|
|
1293 | }); |
|
|
1294 | } |
|
|
1295 | |
|
|
1296 | sub add_title { |
|
|
1297 | my ($self, $title) = @_; |
|
|
1298 | |
|
|
1299 | $self->add_item ({ |
|
|
1300 | rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, |
|
|
1301 | text => $title, |
|
|
1302 | activate => sub { }, |
|
|
1303 | }); |
|
|
1304 | } |
|
|
1305 | |
|
|
1306 | sub add_button { |
|
|
1307 | my ($self, $text, $cb) = @_; |
|
|
1308 | |
|
|
1309 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
|
|
1310 | } |
|
|
1311 | |
|
|
1312 | sub add_toggle { |
|
|
1313 | my ($self, $text, $cb, $value) = @_; |
|
|
1314 | |
|
|
1315 | my $item; $item = { |
|
|
1316 | type => "button", |
|
|
1317 | text => " $text", |
|
|
1318 | value => $value, |
|
|
1319 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
|
|
1320 | activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, |
|
|
1321 | }; |
|
|
1322 | |
|
|
1323 | $self->add_item ($item); |
|
|
1324 | } |
|
|
1325 | |
|
|
1326 | sub show { |
|
|
1327 | my ($self) = @_; |
|
|
1328 | |
|
|
1329 | local $urxvt::popup::self = $self; |
|
|
1330 | |
|
|
1331 | local $ENV{LC_ALL} = $self->{term}->locale; |
|
|
1332 | |
|
|
1333 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
|
|
1334 | "--transient-for" => $self->{term}->parent, |
|
|
1335 | "-display" => $self->{term}->display_id, |
|
|
1336 | "-pe" => "urxvt-popup") |
|
|
1337 | or die "unable to create popup window\n"; |
|
|
1338 | } |
|
|
1339 | |
|
|
1340 | sub DESTROY { |
|
|
1341 | my ($self) = @_; |
|
|
1342 | |
|
|
1343 | delete $self->{term}{_destroy}{$self}; |
|
|
1344 | $self->{term}->ungrab; |
|
|
1345 | } |
567 | |
1346 | |
568 | =head2 The C<urxvt::timer> Class |
1347 | =head2 The C<urxvt::timer> Class |
569 | |
1348 | |
570 | This class implements timer watchers/events. Time is represented as a |
1349 | This class implements timer watchers/events. Time is represented as a |
571 | fractional number of seconds since the epoch. Example: |
1350 | fractional number of seconds since the epoch. Example: |
572 | |
1351 | |
573 | # create a digital clock display in upper right corner |
1352 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
574 | $term->{timer} = urxvt::timer |
1353 | $term->{timer} = urxvt::timer |
575 | ->new |
1354 | ->new |
576 | ->start (urxvt::NOW) |
1355 | ->interval (1) |
577 | ->cb (sub { |
1356 | ->cb (sub { |
578 | my ($timer) = @_; |
|
|
579 | my $time = $timer->at; |
|
|
580 | $timer->start ($time + 1); |
|
|
581 | $self->scr_overlay (-1, 0, |
1357 | $term->{overlay}->set (0, 0, |
582 | POSIX::strftime "%H:%M:%S", localtime $time); |
1358 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
583 | }); |
1359 | }); |
584 | |
1360 | |
585 | =over 4 |
1361 | =over 4 |
586 | |
1362 | |
587 | =item $timer = new urxvt::timer |
1363 | =item $timer = new urxvt::timer |
588 | |
1364 | |
589 | Create a new timer object in stopped state. |
1365 | Create a new timer object in started state. It is scheduled to fire |
|
|
1366 | immediately. |
590 | |
1367 | |
591 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
1368 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
592 | |
1369 | |
593 | Set the callback to be called when the timer triggers. |
1370 | Set the callback to be called when the timer triggers. |
594 | |
1371 | |
… | |
… | |
597 | Return the time this watcher will fire next. |
1374 | Return the time this watcher will fire next. |
598 | |
1375 | |
599 | =item $timer = $timer->set ($tstamp) |
1376 | =item $timer = $timer->set ($tstamp) |
600 | |
1377 | |
601 | Set the time the event is generated to $tstamp. |
1378 | Set the time the event is generated to $tstamp. |
|
|
1379 | |
|
|
1380 | =item $timer = $timer->interval ($interval) |
|
|
1381 | |
|
|
1382 | Normally (and when C<$interval> is C<0>), the timer will automatically |
|
|
1383 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
|
|
1384 | is automatically rescheduled at the given intervals. |
602 | |
1385 | |
603 | =item $timer = $timer->start |
1386 | =item $timer = $timer->start |
604 | |
1387 | |
605 | Start the timer. |
1388 | Start the timer. |
606 | |
1389 | |
… | |
… | |
620 | |
1403 | |
621 | $term->{socket} = ... |
1404 | $term->{socket} = ... |
622 | $term->{iow} = urxvt::iow |
1405 | $term->{iow} = urxvt::iow |
623 | ->new |
1406 | ->new |
624 | ->fd (fileno $term->{socket}) |
1407 | ->fd (fileno $term->{socket}) |
625 | ->events (1) # wait for read data |
1408 | ->events (urxvt::EVENT_READ) |
626 | ->start |
1409 | ->start |
627 | ->cb (sub { |
1410 | ->cb (sub { |
628 | my ($iow, $revents) = @_; |
1411 | my ($iow, $revents) = @_; |
629 | # $revents must be 1 here, no need to check |
1412 | # $revents must be 1 here, no need to check |
630 | sysread $term->{socket}, my $buf, 8192 |
1413 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
647 | |
1430 | |
648 | Set the filedescriptor (not handle) to watch. |
1431 | Set the filedescriptor (not handle) to watch. |
649 | |
1432 | |
650 | =item $iow = $iow->events ($eventmask) |
1433 | =item $iow = $iow->events ($eventmask) |
651 | |
1434 | |
652 | Set the event mask to watch. Bit #0 (value C<1>) enables watching for read |
1435 | Set the event mask to watch. The only allowed values are |
653 | data, Bit #1 (value C<2>) enables watching for write data. |
1436 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
|
|
1437 | together, or C<urxvt::EVENT_NONE>. |
654 | |
1438 | |
655 | =item $iow = $iow->start |
1439 | =item $iow = $iow->start |
656 | |
1440 | |
657 | Start watching for requested events on the given handle. |
1441 | Start watching for requested events on the given handle. |
658 | |
1442 | |
… | |
… | |
669 | This variable controls the verbosity level of the perl extension. Higher |
1453 | This variable controls the verbosity level of the perl extension. Higher |
670 | numbers indicate more verbose output. |
1454 | numbers indicate more verbose output. |
671 | |
1455 | |
672 | =over 4 |
1456 | =over 4 |
673 | |
1457 | |
674 | =item 0 - only fatal messages |
1458 | =item == 0 - fatal messages |
675 | |
1459 | |
676 | =item 3 - script loading and management |
1460 | =item >= 3 - script loading and management |
677 | |
1461 | |
678 | =item 10 - all events received |
1462 | =item >=10 - all events received |
679 | |
1463 | |
680 | =back |
1464 | =back |
681 | |
1465 | |
682 | =head1 AUTHOR |
1466 | =head1 AUTHOR |
683 | |
1467 | |