|
|
1 | =encoding utf8 |
|
|
2 | |
1 | =head1 NAME |
3 | =head1 NAME |
2 | |
4 | |
3 | urxvt - rxvt-unicode's embedded perl interpreter |
5 | @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter |
4 | |
6 | |
5 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
6 | |
8 | |
7 | Put your scripts into $LIBDIR/perl-init/, they will be loaded automatically. |
9 | # create a file grab_test in $HOME: |
8 | |
|
|
9 | Each script will only be loaded once, even in urxvtd, and will be valid |
|
|
10 | globally. |
|
|
11 | |
|
|
12 | Scripts are evaluated in a 'use strict' and 'use utf8' environment, and |
|
|
13 | thus must be written in utf-8. |
|
|
14 | |
10 | |
15 | sub on_sel_grab { |
11 | sub on_sel_grab { |
16 | warn "you selected ", $_[0]->selection; |
12 | warn "you selected ", $_[0]->selection; |
|
|
13 | () |
17 | } |
14 | } |
18 | |
15 | |
19 | 1 |
16 | # start a @@RXVT_NAME@@ using it: |
|
|
17 | |
|
|
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
20 | |
19 | |
21 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
22 | |
21 | |
|
|
22 | Everytime a terminal object gets created, extension scripts specified via |
|
|
23 | the C<perl> resource are loaded and associated with it. |
|
|
24 | |
|
|
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
|
|
26 | thus must be encoded as UTF-8. |
|
|
27 | |
|
|
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
|
|
29 | scripts will be shared (but not enabled) for all terminals. |
|
|
30 | |
|
|
31 | =head2 Prepackaged Extensions |
|
|
32 | |
|
|
33 | This section describes the extensiosn delivered with this version. You can |
|
|
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
|
|
35 | |
|
|
36 | You can activate them like this: |
|
|
37 | |
|
|
38 | @@RXVT_NAME@@ -pe <extensionname> |
|
|
39 | |
|
|
40 | =over 4 |
|
|
41 | |
|
|
42 | =item selection (enabled by default) |
|
|
43 | |
|
|
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: |
|
|
50 | |
|
|
51 | =over 4 |
|
|
52 | |
|
|
53 | =item rot13 |
|
|
54 | |
|
|
55 | Rot-13 the selection when activated. Used via keyboard trigger: |
|
|
56 | |
|
|
57 | URxvt.keysym.C-M-r: perl:selection:rot13 |
|
|
58 | |
|
|
59 | =back |
|
|
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 digital-clock |
|
|
72 | |
|
|
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. |
|
|
84 | |
|
|
85 | =item example-refresh-hooks |
|
|
86 | |
|
|
87 | Displays a very simple digital clock in the upper right corner of the |
|
|
88 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
89 | overlays or changes. |
|
|
90 | |
|
|
91 | =back |
|
|
92 | |
|
|
93 | =head2 General API Considerations |
|
|
94 | |
|
|
95 | All objects (such as terminals, time watchers etc.) are typical |
|
|
96 | reference-to-hash objects. The hash can be used to store anything you |
|
|
97 | like. All members starting with an underscore (such as C<_ptr> or |
|
|
98 | C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or |
|
|
99 | modified). |
|
|
100 | |
|
|
101 | When objects are destroyed on the C++ side, the perl object hashes are |
|
|
102 | emptied, so its best to store related objects such as time watchers and |
|
|
103 | the like inside the terminal object so they get destroyed as soon as the |
|
|
104 | terminal is destroyed. |
|
|
105 | |
|
|
106 | Argument names also often indicate the type of a parameter. Here are some |
|
|
107 | hints on what they mean: |
|
|
108 | |
|
|
109 | =over 4 |
|
|
110 | |
|
|
111 | =item $text |
|
|
112 | |
|
|
113 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
|
|
114 | always represents one screen cell. See L<row_t> for a discussion of this format. |
|
|
115 | |
|
|
116 | =item $string |
|
|
117 | |
|
|
118 | A perl text string, with an emphasis on I<text>. It can store all unicode |
|
|
119 | characters and is to be distinguished with text encoded in a specific |
|
|
120 | encoding (often locale-specific) and binary data. |
|
|
121 | |
|
|
122 | =item $octets |
|
|
123 | |
|
|
124 | Either binary data or - more common - a text string encoded in a |
|
|
125 | locale-specific way. |
|
|
126 | |
|
|
127 | =back |
|
|
128 | |
23 | =head2 Hooks |
129 | =head2 Hooks |
24 | |
130 | |
25 | The following subroutines can be declared in loaded scripts, and will be called |
131 | The following subroutines can be declared in extension files, and will be |
26 | whenever the relevant event happens. |
132 | called whenever the relevant event happens. |
|
|
133 | |
|
|
134 | The first argument passed to them is an object private to each terminal |
|
|
135 | and extension package. You can call all C<urxvt::term> methods on it, but |
|
|
136 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
|
|
137 | object that is shared between all packages is stored in the C<term> |
|
|
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. |
27 | |
140 | |
28 | 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 |
29 | 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, |
30 | 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. |
31 | |
144 | |
… | |
… | |
34 | =over 4 |
147 | =over 4 |
35 | |
148 | |
36 | =item on_init $term |
149 | =item on_init $term |
37 | |
150 | |
38 | Called after a new terminal object has been initialized, but before |
151 | Called after a new terminal object has been initialized, but before |
39 | 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. |
40 | |
156 | |
41 | =item on_reset $term |
157 | =item on_reset $term |
42 | |
158 | |
43 | 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 |
44 | 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 |
… | |
… | |
64 | requested from the server. The selection text can be queried and changed |
180 | requested from the server. The selection text can be queried and changed |
65 | by calling C<< $term->selection >>. |
181 | by calling C<< $term->selection >>. |
66 | |
182 | |
67 | Returning a true value aborts selection grabbing. It will still be hilighted. |
183 | Returning a true value aborts selection grabbing. It will still be hilighted. |
68 | |
184 | |
69 | =item on_focus_in $term |
185 | =item on_sel_extend $term |
70 | |
186 | |
71 | Called whenever the window gets the keyboard focus, before urxvt does |
187 | Called whenever the user tries to extend the selection (e.g. with a double |
72 | focus in processing. |
188 | click) and is either supposed to return false (normal operation), or |
73 | |
189 | should extend the selection itelf and return true to suppress the built-in |
74 | =item on_focus_out $term |
|
|
75 | |
|
|
76 | Called wheneever the window loses keyboard focus, before urxvt does focus |
|
|
77 | out processing. |
190 | processing. |
|
|
191 | |
|
|
192 | See the F<selection> example extension. |
78 | |
193 | |
79 | =item on_view_change $term, $offset |
194 | =item on_view_change $term, $offset |
80 | |
195 | |
81 | 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 |
82 | scrolls. Offset C<0> means display the normal terminal, positive values |
197 | scrolls. Offset C<0> means display the normal terminal, positive values |
… | |
… | |
90 | |
205 | |
91 | 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, |
92 | $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 |
93 | number of lines that will be in the scrollback buffer. |
208 | number of lines that will be in the scrollback buffer. |
94 | |
209 | |
95 | =item on_tty_activity $term *NYI* |
210 | =item on_osc_seq $term, $string |
96 | |
211 | |
97 | Called whenever the program(s) running in the urxvt window send output. |
212 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
|
|
213 | operating system command) is processed. Cursor position and other state |
|
|
214 | information is up-to-date when this happens. For interoperability, the |
|
|
215 | string should start with the extension name and a colon, to distinguish |
|
|
216 | it from commands for other extensions, and this might be enforced in the |
|
|
217 | future. |
|
|
218 | |
|
|
219 | Be careful not ever to trust (in a security sense) the data you receive, |
|
|
220 | as its source can not easily be controleld (e-mail content, messages from |
|
|
221 | other users on the same system etc.). |
|
|
222 | |
|
|
223 | =item on_add_lines $term, $string |
|
|
224 | |
|
|
225 | Called whenever text is about to be output, with the text as argument. You |
|
|
226 | can filter/change and output the text yourself by returning a true value |
|
|
227 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
|
|
228 | might be very slow, however, as your hook is called for B<all> text being |
|
|
229 | output. |
|
|
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. |
98 | |
244 | |
99 | =item on_refresh_begin $term |
245 | =item on_refresh_begin $term |
100 | |
246 | |
101 | 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 |
102 | or similar effects by modify terminal contents in refresh_begin, and |
248 | or similar effects by modify terminal contents in refresh_begin, and |
… | |
… | |
105 | |
251 | |
106 | =item on_refresh_end $term |
252 | =item on_refresh_end $term |
107 | |
253 | |
108 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
254 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
109 | |
255 | |
|
|
256 | =item on_keyboard_command $term, $string |
|
|
257 | |
|
|
258 | Called whenever the user presses a key combination that has a |
|
|
259 | C<perl:string> action bound to it (see description of the B<keysym> |
|
|
260 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
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 | |
110 | =back |
298 | =back |
111 | |
299 | |
|
|
300 | =head2 Variables in the C<urxvt> Package |
|
|
301 | |
|
|
302 | =over 4 |
|
|
303 | |
|
|
304 | =item $urxvt::TERM |
|
|
305 | |
|
|
306 | The current terminal. This variable stores the current C<urxvt::term> |
|
|
307 | object, whenever a callback/hook is executing. |
|
|
308 | |
|
|
309 | =back |
|
|
310 | |
112 | =head2 Functions in the C<urxvt> Package |
311 | =head2 Functions in the C<urxvt> Package |
113 | |
312 | |
114 | =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. |
115 | |
322 | |
116 | =item urxvt::fatal $errormessage |
323 | =item urxvt::fatal $errormessage |
117 | |
324 | |
118 | Fatally aborts execution with the given error message. Avoid at all |
325 | Fatally aborts execution with the given error message. Avoid at all |
119 | 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 |
120 | starts up. |
327 | starts up. |
121 | |
328 | |
122 | =item urxvt::warn $string |
329 | =item urxvt::warn $string |
123 | |
330 | |
124 | Calls C<rxvt_warn> witht eh given string which should not include a |
331 | Calls C<rxvt_warn> with the given string which should not include a |
125 | newline. The module also overwrites the C<warn> builtin with a function |
332 | newline. The module also overwrites the C<warn> builtin with a function |
126 | that calls this function. |
333 | that calls this function. |
127 | |
334 | |
128 | 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 |
129 | correct place, e.g. on stderr of the connecting urxvtc client. |
336 | correct place, e.g. on stderr of the connecting urxvtc client. |
130 | |
337 | |
131 | =item $cellwidth = urxvt::wcswidth $string |
338 | =item $is_safe = urxvt::safe |
132 | |
339 | |
133 | Returns the number of screen-cells this string would need. Correctly |
340 | Returns true when it is safe to do potentially unsafe things, such as |
134 | accounts for wide and combining characters. |
341 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
342 | started setuid or setgid. |
135 | |
343 | |
136 | =item $time = urxvt::NOW |
344 | =item $time = urxvt::NOW |
137 | |
345 | |
138 | Returns the "current time" (as per the event loop). |
346 | Returns the "current time" (as per the event loop). |
139 | |
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. |
|
|
355 | |
|
|
356 | =back |
|
|
357 | |
|
|
358 | =head2 RENDITION |
|
|
359 | |
|
|
360 | Rendition bitsets contain information about colour, font, font styles and |
|
|
361 | similar information for each screen cell. |
|
|
362 | |
|
|
363 | The following "macros" deal with changes in rendition sets. You should |
|
|
364 | never just create a bitset, you should always modify an existing one, |
|
|
365 | as they contain important information required for correct operation of |
|
|
366 | rxvt-unicode. |
|
|
367 | |
|
|
368 | =over 4 |
|
|
369 | |
|
|
370 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
371 | |
|
|
372 | Returns the default rendition, as used when the terminal is starting up or |
|
|
373 | being reset. Useful as a base to start when creating renditions. |
|
|
374 | |
|
|
375 | =item $rend = urxvt::OVERLAY_RSTYLE |
|
|
376 | |
|
|
377 | Return the rendition mask used for overlays by default. |
|
|
378 | |
|
|
379 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
|
|
380 | |
|
|
381 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
382 | underline, respectively. To enable such a style, just logically OR it into |
|
|
383 | the bitset. |
|
|
384 | |
|
|
385 | =item $foreground = urxvt::GET_BASEFG $rend |
|
|
386 | |
|
|
387 | =item $background = urxvt::GET_BASEBG $rend |
|
|
388 | |
|
|
389 | Return the foreground/background colour index, respectively. |
|
|
390 | |
|
|
391 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
|
|
392 | |
|
|
393 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
|
|
394 | |
|
|
395 | Replace the foreground/background colour in the rendition mask with the |
|
|
396 | specified one. |
|
|
397 | |
|
|
398 | =item $value = urxvt::GET_CUSTOM ($rend) |
|
|
399 | |
|
|
400 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
401 | extensions. They can be set and changed as you like and are initially |
|
|
402 | zero. |
|
|
403 | |
|
|
404 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
|
|
405 | |
|
|
406 | Change the custom value. |
|
|
407 | |
|
|
408 | =back |
|
|
409 | |
140 | =cut |
410 | =cut |
141 | |
411 | |
142 | package urxvt; |
412 | package urxvt; |
143 | |
413 | |
|
|
414 | use utf8; |
144 | use strict; |
415 | use strict; |
|
|
416 | use Scalar::Util (); |
|
|
417 | use List::Util (); |
145 | |
418 | |
146 | our $term; |
419 | our $VERSION = 1; |
|
|
420 | our $TERM; |
147 | our @HOOKNAME; |
421 | our @HOOKNAME; |
|
|
422 | our %OPTION; |
148 | our $LIBDIR; |
423 | our $LIBDIR; |
149 | |
424 | |
150 | BEGIN { |
425 | BEGIN { |
151 | urxvt->bootstrap; |
426 | urxvt->bootstrap; |
152 | |
427 | |
… | |
… | |
155 | my $msg = join "", @_; |
430 | my $msg = join "", @_; |
156 | $msg .= "\n" |
431 | $msg .= "\n" |
157 | unless $msg =~ /\n$/; |
432 | unless $msg =~ /\n$/; |
158 | urxvt::warn ($msg); |
433 | urxvt::warn ($msg); |
159 | }; |
434 | }; |
160 | } |
|
|
161 | |
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"; |
|
|
440 | } |
|
|
441 | |
|
|
442 | my @hook_count; |
162 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY} || 10; |
443 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
163 | |
444 | |
164 | sub verbose { |
445 | sub verbose { |
165 | my ($level, $msg) = @_; |
446 | my ($level, $msg) = @_; |
166 | warn "$msg\n"; #d# |
447 | warn "$msg\n" if $level <= $verbosity; |
167 | } |
|
|
168 | |
|
|
169 | my @invoke_cb; |
|
|
170 | |
|
|
171 | # called by the rxvt core |
|
|
172 | sub invoke { |
|
|
173 | local $term = shift; |
|
|
174 | my $htype = shift; |
|
|
175 | |
|
|
176 | my $cb = $invoke_cb[$htype]; |
|
|
177 | |
|
|
178 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" |
|
|
179 | if $verbosity >= 10; |
|
|
180 | |
|
|
181 | while (my ($k, $v) = each %$cb) { |
|
|
182 | return 1 if $v->($term, @_); |
|
|
183 | } |
|
|
184 | |
|
|
185 | 0 |
|
|
186 | } |
448 | } |
187 | |
449 | |
188 | # find on_xxx subs in the package and register them |
450 | # find on_xxx subs in the package and register them |
189 | # as hooks |
451 | # as hooks |
190 | sub register_package($) { |
452 | sub register_package($) { |
191 | my ($pkg) = @_; |
453 | my ($pkg) = @_; |
192 | |
454 | |
193 | for my $hook (0.. $#HOOKNAME) { |
455 | for my $htype (0.. $#HOOKNAME) { |
194 | my $name = $HOOKNAME[$hook]; |
456 | my $name = $HOOKNAME[$htype]; |
195 | |
457 | |
196 | my $ref = $pkg->can ("on_" . lc $name) |
458 | my $ref = $pkg->can ("on_" . lc $name) |
197 | or next; |
459 | or next; |
198 | |
460 | |
199 | $invoke_cb[$hook]{$ref*1} = $ref; |
461 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
|
|
462 | $hook_count[$htype]++ |
200 | set_should_invoke $hook, 1; |
463 | or set_should_invoke $htype, 1; |
201 | } |
464 | } |
202 | } |
465 | } |
203 | |
466 | |
204 | my $script_pkg = "script0000"; |
467 | my $extension_pkg = "extension0000"; |
205 | my %script_pkg; |
468 | my %extension_pkg; |
206 | |
469 | |
207 | # load a single script into its own package, once only |
470 | # load a single script into its own package, once only |
208 | sub load_script($) { |
471 | sub extension_package($) { |
209 | my ($path) = @_; |
472 | my ($path) = @_; |
210 | |
473 | |
211 | $script_pkg{$path} ||= do { |
474 | $extension_pkg{$path} ||= do { |
212 | my $pkg = $script_pkg++; |
475 | my $pkg = "urxvt::" . ($extension_pkg++); |
|
|
476 | |
213 | verbose 3, "loading script '$path' into package '$pkg'"; |
477 | verbose 3, "loading extension '$path' into package '$pkg'"; |
214 | |
478 | |
215 | open my $fh, "<:raw", $path |
479 | open my $fh, "<:raw", $path |
216 | or die "$path: $!"; |
480 | or die "$path: $!"; |
217 | |
481 | |
218 | eval "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" |
219 | . "#line 1 \"$path\"\n" |
484 | . "#line 1 \"$path\"\n{\n" |
220 | . do { local $/; <$fh> } |
485 | . (do { local $/; <$fh> }) |
|
|
486 | . "\n};\n1"; |
|
|
487 | |
221 | or die "$path: $@"; |
488 | eval $source or die "$path: $@"; |
222 | |
|
|
223 | register_package $pkg; |
|
|
224 | |
489 | |
225 | $pkg |
490 | $pkg |
226 | }; |
491 | } |
227 | } |
492 | } |
228 | |
493 | |
229 | load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>; |
494 | our $retval; # return value for urxvt |
230 | |
495 | |
|
|
496 | # called by the rxvt core |
|
|
497 | sub invoke { |
|
|
498 | local $TERM = shift; |
|
|
499 | my $htype = shift; |
231 | |
500 | |
232 | =back |
501 | if ($htype == 0) { # INIT |
|
|
502 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
|
|
503 | |
|
|
504 | my %want_ext; |
|
|
505 | |
|
|
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) { |
|
|
517 | my @files = grep -f $_, map "$_/$ext", @dirs; |
|
|
518 | |
|
|
519 | if (@files) { |
|
|
520 | register_package extension_package $files[0]; |
|
|
521 | } else { |
|
|
522 | warn "perl extension '$ext' not found in perl library search path\n"; |
|
|
523 | } |
|
|
524 | } |
|
|
525 | |
|
|
526 | eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); |
|
|
527 | warn $@ if $@; |
|
|
528 | } |
|
|
529 | |
|
|
530 | $retval = undef; |
|
|
531 | |
|
|
532 | if (my $cb = $TERM->{_hook}[$htype]) { |
|
|
533 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
|
|
534 | if $verbosity >= 10; |
|
|
535 | |
|
|
536 | keys %$cb; |
|
|
537 | |
|
|
538 | while (my ($pkg, $cb) = each %$cb) { |
|
|
539 | eval { |
|
|
540 | $retval = $cb->( |
|
|
541 | $TERM->{_pkg}{$pkg} ||= do { |
|
|
542 | my $proxy = bless { }, $pkg; |
|
|
543 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
544 | $proxy |
|
|
545 | }, |
|
|
546 | @_, |
|
|
547 | ) and last; |
|
|
548 | }; |
|
|
549 | if ($@) { |
|
|
550 | $TERM->ungrab; # better to lose the grab than the session |
|
|
551 | warn $@; |
|
|
552 | } |
|
|
553 | } |
|
|
554 | } |
|
|
555 | |
|
|
556 | if ($htype == 1) { # DESTROY |
|
|
557 | # remove hooks if unused |
|
|
558 | if (my $hook = $TERM->{_hook}) { |
|
|
559 | for my $htype (0..$#$hook) { |
|
|
560 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
561 | or set_should_invoke $htype, 0; |
|
|
562 | } |
|
|
563 | } |
|
|
564 | |
|
|
565 | # clear package objects |
|
|
566 | %$_ = () for values %{ $TERM->{_pkg} }; |
|
|
567 | |
|
|
568 | # clear package |
|
|
569 | %$TERM = (); |
|
|
570 | } |
|
|
571 | |
|
|
572 | $retval |
|
|
573 | } |
|
|
574 | |
|
|
575 | # urxvt::term::proxy |
|
|
576 | |
|
|
577 | sub urxvt::term::proxy::AUTOLOAD { |
|
|
578 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
|
|
579 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
|
|
580 | |
|
|
581 | eval qq{ |
|
|
582 | sub $urxvt::term::proxy::AUTOLOAD { |
|
|
583 | my \$proxy = shift; |
|
|
584 | \$proxy->{term}->$1 (\@_) |
|
|
585 | } |
|
|
586 | 1 |
|
|
587 | } or die "FATAL: unable to compile method forwarder: $@"; |
|
|
588 | |
|
|
589 | goto &$urxvt::term::proxy::AUTOLOAD; |
|
|
590 | } |
|
|
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; |
233 | |
675 | |
234 | =head2 The C<urxvt::term> Class |
676 | =head2 The C<urxvt::term> Class |
235 | |
677 | |
236 | =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 |
|
|
699 | |
|
|
700 | =item $value = $term->resource ($name[, $newval]) |
|
|
701 | |
|
|
702 | Returns the current resource value associated with a given name and |
|
|
703 | optionally sets a new value. Setting values is most useful in the C<init> |
|
|
704 | hook. Unset resources are returned and accepted as C<undef>. |
|
|
705 | |
|
|
706 | The new value must be properly encoded to a suitable character encoding |
|
|
707 | before passing it to this method. Similarly, the returned value may need |
|
|
708 | to be converted from the used encoding to text. |
|
|
709 | |
|
|
710 | Resource names are as defined in F<src/rsinc.h>. Colours can be specified |
|
|
711 | as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will |
|
|
712 | likely change). |
|
|
713 | |
|
|
714 | Please note that resource strings will currently only be freed when the |
|
|
715 | terminal is destroyed, so changing options frequently will eat memory. |
|
|
716 | |
|
|
717 | Here is a a likely non-exhaustive list of resource names, not all of which |
|
|
718 | are supported in every build, please see the source file F</src/rsinc.h> |
|
|
719 | to see the actual list: |
|
|
720 | |
|
|
721 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
|
|
722 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
|
|
723 | display_name embed ext_bwidth fade font geometry hold iconName |
|
|
724 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
|
|
725 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
|
|
726 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
|
|
727 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
|
|
728 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
|
|
729 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
|
|
730 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
|
|
731 | shade term_name title transparent transparent_all tripleclickwords |
|
|
732 | utmpInhibit visualBell |
|
|
733 | |
|
|
734 | =cut |
|
|
735 | |
|
|
736 | sub resource($$;$) { |
|
|
737 | my ($self, $name) = (shift, shift); |
|
|
738 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
|
|
739 | &urxvt::term::_resource |
|
|
740 | } |
|
|
741 | |
|
|
742 | =item $rend = $term->rstyle ([$new_rstyle]) |
|
|
743 | |
|
|
744 | Return and optionally change the current rendition. Text that is output by |
|
|
745 | the terminal application will use this style. |
|
|
746 | |
|
|
747 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
748 | |
|
|
749 | Return the current coordinates of the text cursor position and optionally |
|
|
750 | set it (which is usually bad as applications don't expect that). |
237 | |
751 | |
238 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
752 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
239 | |
753 | |
240 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
754 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
241 | |
755 | |
… | |
… | |
251 | |
765 | |
252 | =item $oldtext = $term->selection ([$newtext]) |
766 | =item $oldtext = $term->selection ([$newtext]) |
253 | |
767 | |
254 | Return the current selection text and optionally replace it by C<$newtext>. |
768 | Return the current selection text and optionally replace it by C<$newtext>. |
255 | |
769 | |
256 | =item $term->scr_overlay ($x, $y, $text) |
770 | #=item $term->overlay ($x, $y, $text) |
257 | |
771 | # |
258 | Create a simple multi-line overlay box. See the next method for details. |
772 | #Create a simple multi-line overlay box. See the next method for details. |
|
|
773 | # |
|
|
774 | #=cut |
|
|
775 | # |
|
|
776 | #sub urxvt::term::scr_overlay { |
|
|
777 | # my ($self, $x, $y, $text) = @_; |
|
|
778 | # |
|
|
779 | # my @lines = split /\n/, $text; |
|
|
780 | # |
|
|
781 | # my $w = 0; |
|
|
782 | # for (map $self->strwidth ($_), @lines) { |
|
|
783 | # $w = $_ if $w < $_; |
|
|
784 | # } |
|
|
785 | # |
|
|
786 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
|
|
787 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
788 | #} |
|
|
789 | |
|
|
790 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
|
|
791 | |
|
|
792 | Create a new (empty) overlay at the given position with the given |
|
|
793 | width/height. C<$rstyle> defines the initial rendition style |
|
|
794 | (default: C<OVERLAY_RSTYLE>). |
|
|
795 | |
|
|
796 | If C<$border> is C<2> (default), then a decorative border will be put |
|
|
797 | around the box. |
|
|
798 | |
|
|
799 | If either C<$x> or C<$y> is negative, then this is counted from the |
|
|
800 | right/bottom side, respectively. |
|
|
801 | |
|
|
802 | This method returns an urxvt::overlay object. The overlay will be visible |
|
|
803 | as long as the perl object is referenced. |
|
|
804 | |
|
|
805 | The methods currently supported on C<urxvt::overlay> objects are: |
|
|
806 | |
|
|
807 | =over 4 |
|
|
808 | |
|
|
809 | =item $overlay->set ($x, $y, $text, $rend) |
|
|
810 | |
|
|
811 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
|
|
812 | text in rxvt-unicode's special encoding and an array of rendition values |
|
|
813 | at a specific position inside the overlay. |
|
|
814 | |
|
|
815 | =item $overlay->hide |
|
|
816 | |
|
|
817 | If visible, hide the overlay, but do not destroy it. |
|
|
818 | |
|
|
819 | =item $overlay->show |
|
|
820 | |
|
|
821 | If hidden, display the overlay again. |
|
|
822 | |
|
|
823 | =back |
|
|
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). |
259 | |
830 | |
260 | =cut |
831 | =cut |
261 | |
832 | |
262 | sub urxvt::term::scr_overlay { |
833 | sub popup { |
263 | my ($self, $x, $y, $text) = @_; |
834 | my ($self, $event) = @_; |
264 | |
835 | |
265 | my @lines = split /\n/, $text; |
836 | $self->grab ($event->{time}, 1) |
|
|
837 | or return; |
266 | |
838 | |
267 | my $w = 0; |
839 | my $popup = bless { |
268 | for (map urxvt::wcswidth $_, @lines) { |
840 | term => $self, |
269 | $w = $_ if $w < $_; |
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 | |
|
|
852 | =item $cellwidth = $term->strwidth ($string) |
|
|
853 | |
|
|
854 | Returns the number of screen-cells this string would need. Correctly |
|
|
855 | accounts for wide and combining characters. |
|
|
856 | |
|
|
857 | =item $octets = $term->locale_encode ($string) |
|
|
858 | |
|
|
859 | Convert the given text string into the corresponding locale encoding. |
|
|
860 | |
|
|
861 | =item $string = $term->locale_decode ($octets) |
|
|
862 | |
|
|
863 | Convert the given locale-encoded octets into a perl string. |
|
|
864 | |
|
|
865 | =item $term->scr_add_lines ($string) |
|
|
866 | |
|
|
867 | Write the given text string to the screen, as if output by the application |
|
|
868 | running inside the terminal. It may not contain command sequences (escape |
|
|
869 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
870 | string is a normal text string, not in locale-dependent encoding. |
|
|
871 | |
|
|
872 | Normally its not a good idea to use this function, as programs might be |
|
|
873 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
874 | C<on_add_lines> hook, though. |
|
|
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 | |
|
|
882 | =item $term->tt_write ($octets) |
|
|
883 | |
|
|
884 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
|
|
885 | pass characters instead of octets, you should convert your strings first |
|
|
886 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
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 | |
|
|
896 | =item $window_width = $term->width |
|
|
897 | |
|
|
898 | =item $window_height = $term->height |
|
|
899 | |
|
|
900 | =item $font_width = $term->fwidth |
|
|
901 | |
|
|
902 | =item $font_height = $term->fheight |
|
|
903 | |
|
|
904 | =item $font_ascent = $term->fbase |
|
|
905 | |
|
|
906 | =item $terminal_rows = $term->nrow |
|
|
907 | |
|
|
908 | =item $terminal_columns = $term->ncol |
|
|
909 | |
|
|
910 | =item $has_focus = $term->focus |
|
|
911 | |
|
|
912 | =item $is_mapped = $term->mapped |
|
|
913 | |
|
|
914 | =item $max_scrollback = $term->saveLines |
|
|
915 | |
|
|
916 | =item $nrow_plus_saveLines = $term->total_rows |
|
|
917 | |
|
|
918 | =item $lines_in_scrollback = $term->nsaved |
|
|
919 | |
|
|
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. |
|
|
930 | |
|
|
931 | =item $view_start = $term->view_start ([$newvalue]) |
|
|
932 | |
|
|
933 | Returns the negative row number of the topmost line. Minimum value is |
|
|
934 | C<0>, which displays the normal terminal contents. Larger values scroll |
|
|
935 | this many lines into the scrollback buffer. |
|
|
936 | |
|
|
937 | =item $term->want_refresh |
|
|
938 | |
|
|
939 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
|
|
940 | compare the on-screen display with its stored representation. If they |
|
|
941 | differ, it redraws the differences. |
|
|
942 | |
|
|
943 | Used after changing terminal contents to display them. |
|
|
944 | |
|
|
945 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
|
|
946 | |
|
|
947 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
|
|
948 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
|
|
949 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
950 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
|
|
951 | is requested. |
|
|
952 | |
|
|
953 | If C<$new_text> is specified, it will replace characters in the current |
|
|
954 | line, starting at column C<$start_col> (default C<0>), which is useful |
|
|
955 | to replace only parts of a line. The font index in the rendition will |
|
|
956 | automatically be updated. |
|
|
957 | |
|
|
958 | C<$text> is in a special encoding: tabs and wide characters that use more |
|
|
959 | than one cell when displayed are padded with urxvt::NOCHAR characters |
|
|
960 | (C<chr 65535>). Characters with combining characters and other characters |
|
|
961 | that do not fit into the normal tetx encoding will be replaced with |
|
|
962 | characters in the private use area. |
|
|
963 | |
|
|
964 | You have to obey this encoding when changing text. The advantage is |
|
|
965 | that C<substr> and similar functions work on screen cells and not on |
|
|
966 | characters. |
|
|
967 | |
|
|
968 | The methods C<< $term->special_encode >> and C<< $term->special_decode >> |
|
|
969 | can be used to convert normal strings into this encoding and vice versa. |
|
|
970 | |
|
|
971 | =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]]) |
|
|
972 | |
|
|
973 | Like C<< $term->ROW_t >>, but returns an arrayref with rendition |
|
|
974 | bitsets. Rendition bitsets contain information about colour, font, font |
|
|
975 | styles and similar information. See also C<< $term->ROW_t >>. |
|
|
976 | |
|
|
977 | When setting rendition, the font mask will be ignored. |
|
|
978 | |
|
|
979 | See the section on RENDITION, above. |
|
|
980 | |
|
|
981 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
|
|
982 | |
|
|
983 | Returns the number of screen cells that are in use ("the line |
|
|
984 | length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the |
|
|
985 | line is joined with the following one. |
|
|
986 | |
|
|
987 | =item $bool = $term->is_longer ($row_number) |
|
|
988 | |
|
|
989 | Returns true if the row is part of a multiple-row logical "line" (i.e. |
|
|
990 | joined with the following row), which means all characters are in use |
|
|
991 | and it is continued on the next row (and possibly a continuation of the |
|
|
992 | previous row(s)). |
|
|
993 | |
|
|
994 | =item $line = $term->line ($row_number) |
|
|
995 | |
|
|
996 | Create and return a new C<urxvt::line> object that stores information |
|
|
997 | about the logical line that row C<$row_number> is part of. It supports the |
|
|
998 | following methods: |
|
|
999 | |
|
|
1000 | =over 4 |
|
|
1001 | |
|
|
1002 | =item $text = $line->t ([$new_text]) |
|
|
1003 | |
|
|
1004 | Returns or replaces the full text of the line, similar to C<ROW_t> |
|
|
1005 | |
|
|
1006 | =item $rend = $line->r ([$new_rend]) |
|
|
1007 | |
|
|
1008 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
|
|
1009 | |
|
|
1010 | =item $length = $line->l |
|
|
1011 | |
|
|
1012 | Returns the length of the line in cells, similar to C<ROW_l>. |
|
|
1013 | |
|
|
1014 | =item $rownum = $line->beg |
|
|
1015 | |
|
|
1016 | =item $rownum = $line->end |
|
|
1017 | |
|
|
1018 | Return the row number of the first/last row of the line, respectively. |
|
|
1019 | |
|
|
1020 | =item $offset = $line->offset_of ($row, $col) |
|
|
1021 | |
|
|
1022 | Returns the character offset of the given row|col pair within the logical |
|
|
1023 | line. |
|
|
1024 | |
|
|
1025 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
1026 | |
|
|
1027 | Translates a string offset into terminal coordinates again. |
|
|
1028 | |
|
|
1029 | =back |
|
|
1030 | |
|
|
1031 | =cut |
|
|
1032 | |
|
|
1033 | sub line { |
|
|
1034 | my ($self, $row) = @_; |
|
|
1035 | |
|
|
1036 | my $maxrow = $self->nrow - 1; |
|
|
1037 | |
|
|
1038 | my ($beg, $end) = ($row, $row); |
|
|
1039 | |
|
|
1040 | --$beg while $self->ROW_is_longer ($beg - 1); |
|
|
1041 | ++$end while $self->ROW_is_longer ($end) && $end < $maxrow; |
|
|
1042 | |
|
|
1043 | bless { |
|
|
1044 | term => $self, |
|
|
1045 | beg => $beg, |
|
|
1046 | end => $end, |
|
|
1047 | ncol => $self->ncol, |
|
|
1048 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
|
|
1049 | }, urxvt::line:: |
|
|
1050 | } |
|
|
1051 | |
|
|
1052 | sub urxvt::line::t { |
|
|
1053 | my ($self) = @_; |
|
|
1054 | |
|
|
1055 | if (@_ > 1) |
|
|
1056 | { |
|
|
1057 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
1058 | for $self->{beg} .. $self->{end}; |
|
|
1059 | } |
|
|
1060 | |
|
|
1061 | defined wantarray && |
|
|
1062 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
|
|
1063 | 0, $self->{len} |
|
|
1064 | } |
|
|
1065 | |
|
|
1066 | sub urxvt::line::r { |
|
|
1067 | my ($self) = @_; |
|
|
1068 | |
|
|
1069 | if (@_ > 1) |
|
|
1070 | { |
|
|
1071 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
1072 | for $self->{beg} .. $self->{end}; |
|
|
1073 | } |
|
|
1074 | |
|
|
1075 | if (defined wantarray) { |
|
|
1076 | my $rend = [ |
|
|
1077 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
|
|
1078 | ]; |
|
|
1079 | $#$rend = $self->{len} - 1; |
|
|
1080 | return $rend; |
270 | } |
1081 | } |
271 | |
1082 | |
272 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
1083 | () |
273 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
274 | } |
1084 | } |
275 | |
1085 | |
276 | =item $term->scr_overlay_new ($x, $y, $width, $height) |
1086 | sub urxvt::line::beg { $_[0]{beg} } |
|
|
1087 | sub urxvt::line::end { $_[0]{end} } |
|
|
1088 | sub urxvt::line::l { $_[0]{len} } |
277 | |
1089 | |
278 | Create a new (empty) overlay at the given position with the given |
1090 | sub urxvt::line::offset_of { |
279 | width/height. A border will be put around the box. If either C<$x> or |
1091 | my ($self, $row, $col) = @_; |
280 | C<$y> is negative, then this is counted from the right/bottom side, |
|
|
281 | respectively. |
|
|
282 | |
1092 | |
283 | =item $term->scr_overlay_off |
1093 | ($row - $self->{beg}) * $self->{ncol} + $col |
|
|
1094 | } |
284 | |
1095 | |
285 | Switch the overlay off again. |
1096 | sub urxvt::line::coord_of { |
|
|
1097 | my ($self, $offset) = @_; |
286 | |
1098 | |
287 | =item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) |
1099 | use integer; |
288 | |
1100 | |
289 | Put a single character (specified numerically) at the given overlay |
1101 | ( |
290 | position. |
1102 | $offset / $self->{ncol} + $self->{beg}, |
|
|
1103 | $offset % $self->{ncol} |
|
|
1104 | ) |
|
|
1105 | } |
291 | |
1106 | |
292 | =item $term->scr_overlay_set ($x, $y, $text) |
1107 | =item $text = $term->special_encode $string |
293 | |
1108 | |
294 | Write a string at the given position into the overlay. |
1109 | Converts a perl string into the special encoding used by rxvt-unicode, |
|
|
1110 | where one character corresponds to one screen cell. See |
|
|
1111 | C<< $term->ROW_t >> for details. |
|
|
1112 | |
|
|
1113 | =item $string = $term->special_decode $text |
|
|
1114 | |
|
|
1115 | Converts rxvt-unicodes text reprsentation into a perl string. See |
|
|
1116 | C<< $term->ROW_t >> for details. |
|
|
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. |
295 | |
1145 | |
296 | =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 | "-display" => $self->{term}->display_id, |
|
|
1221 | "-pe" => "urxvt-popup") |
|
|
1222 | or die "unable to create popup window\n"; |
|
|
1223 | } |
|
|
1224 | |
|
|
1225 | sub DESTROY { |
|
|
1226 | my ($self) = @_; |
|
|
1227 | |
|
|
1228 | delete $self->{term}{_destroy}{$self}; |
|
|
1229 | $self->{term}->ungrab; |
|
|
1230 | } |
297 | |
1231 | |
298 | =head2 The C<urxvt::timer> Class |
1232 | =head2 The C<urxvt::timer> Class |
299 | |
1233 | |
300 | This class implements timer watchers/events. Time is represented as a |
1234 | This class implements timer watchers/events. Time is represented as a |
301 | fractional number of seconds since the epoch. Example: |
1235 | fractional number of seconds since the epoch. Example: |
302 | |
1236 | |
303 | # create a digital clock display in upper right corner |
1237 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
304 | $term->{timer} = urxvt::timer |
1238 | $term->{timer} = urxvt::timer |
305 | ->new |
1239 | ->new |
306 | ->start (urxvt::NOW) |
1240 | ->interval (1) |
307 | ->cb (sub { |
1241 | ->cb (sub { |
308 | my ($timer) = @_; |
|
|
309 | my $time = $timer->at; |
|
|
310 | $timer->start ($time + 1); |
|
|
311 | $self->scr_overlay (-1, 0, |
1242 | $term->{overlay}->set (0, 0, |
312 | POSIX::strftime "%H:%M:%S", localtime $time); |
1243 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
313 | }); |
1244 | }); |
314 | |
1245 | |
315 | =over 4 |
1246 | =over 4 |
316 | |
1247 | |
317 | =item $timer = new urxvt::timer |
1248 | =item $timer = new urxvt::timer |
318 | |
1249 | |
319 | Create a new timer object in stopped state. |
1250 | Create a new timer object in started state. It is scheduled to fire |
|
|
1251 | immediately. |
320 | |
1252 | |
321 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
1253 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
322 | |
1254 | |
323 | Set the callback to be called when the timer triggers. |
1255 | Set the callback to be called when the timer triggers. |
324 | |
1256 | |
… | |
… | |
327 | Return the time this watcher will fire next. |
1259 | Return the time this watcher will fire next. |
328 | |
1260 | |
329 | =item $timer = $timer->set ($tstamp) |
1261 | =item $timer = $timer->set ($tstamp) |
330 | |
1262 | |
331 | Set the time the event is generated to $tstamp. |
1263 | Set the time the event is generated to $tstamp. |
|
|
1264 | |
|
|
1265 | =item $timer = $timer->interval ($interval) |
|
|
1266 | |
|
|
1267 | Normally (and when C<$interval> is C<0>), the timer will automatically |
|
|
1268 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
|
|
1269 | is automatically rescheduled at the given intervals. |
332 | |
1270 | |
333 | =item $timer = $timer->start |
1271 | =item $timer = $timer->start |
334 | |
1272 | |
335 | Start the timer. |
1273 | Start the timer. |
336 | |
1274 | |
… | |
… | |
390 | |
1328 | |
391 | Stop watching for events on the given filehandle. |
1329 | Stop watching for events on the given filehandle. |
392 | |
1330 | |
393 | =back |
1331 | =back |
394 | |
1332 | |
|
|
1333 | =head1 ENVIRONMENT |
|
|
1334 | |
|
|
1335 | =head2 URXVT_PERL_VERBOSITY |
|
|
1336 | |
|
|
1337 | This variable controls the verbosity level of the perl extension. Higher |
|
|
1338 | numbers indicate more verbose output. |
|
|
1339 | |
|
|
1340 | =over 4 |
|
|
1341 | |
|
|
1342 | =item == 0 - fatal messages |
|
|
1343 | |
|
|
1344 | =item >= 3 - script loading and management |
|
|
1345 | |
|
|
1346 | =item >=10 - all events received |
|
|
1347 | |
|
|
1348 | =back |
|
|
1349 | |
395 | =head1 AUTHOR |
1350 | =head1 AUTHOR |
396 | |
1351 | |
397 | Marc Lehmann <pcg@goof.com> |
1352 | Marc Lehmann <pcg@goof.com> |
398 | http://software.schmorp.de/pkg/rxvt-unicode |
1353 | http://software.schmorp.de/pkg/rxvt-unicode |
399 | |
1354 | |