1 | =encoding utf8 |
1 | =encoding utf8 |
2 | |
2 | |
3 | =head1 NAME |
3 | =head1 NAME |
4 | |
4 | |
5 | @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter |
5 | urxvtperl - rxvt-unicode's embedded perl interpreter |
6 | |
6 | |
7 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
8 | |
8 | |
9 | # create a file grab_test in $HOME: |
9 | # create a file grab_test in $HOME: |
10 | |
10 | |
11 | sub on_sel_grab { |
11 | sub on_sel_grab { |
12 | warn "you selected ", $_[0]->selection; |
12 | warn "you selected ", $_[0]->selection; |
13 | () |
13 | () |
14 | } |
14 | } |
15 | |
15 | |
16 | # start a @@RXVT_NAME@@ using it: |
16 | # start a urxvt using it: |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | urxvt --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 | Every time 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 "vars"' 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 urxvtd, where |
29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
30 | |
30 | |
31 | =head2 Prepackaged Extensions |
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
|
|
32 | and "perl-ext-common" resources to the empty string. |
32 | |
33 | |
33 | This section describes the extensiosn delivered with this version. You can |
34 | =head1 PREPACKAGED EXTENSIONS |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
35 | |
|
|
36 | A number of extensions are delivered with this release. You can find them |
|
|
37 | in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using |
|
|
38 | F<< man urxvt-<EXTENSIONNAME> >>. |
35 | |
39 | |
36 | You can activate them like this: |
40 | You can activate them like this: |
37 | |
41 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
42 | urxvt -pe <extensionname> |
39 | |
43 | |
40 | =over 4 |
44 | Or by adding them to the resource for extensions loaded by default: |
41 | |
45 | |
42 | =item selection |
46 | URxvt.perl-ext-common: default,selection-autotransform |
43 | |
47 | |
44 | Miscellaneous selection modifications. |
48 | Extensions that add command line parameters or resources on their own are |
|
|
49 | loaded automatically when used. |
45 | |
50 | |
46 | =over 4 |
51 | =head1 API DOCUMENTATION |
47 | |
|
|
48 | =item rot13 |
|
|
49 | |
|
|
50 | Rot-13 the selection when activated. Used via keyboard trigger: |
|
|
51 | |
|
|
52 | URxvt.keysym.C-M-r: perl:selection:rot13 |
|
|
53 | |
|
|
54 | =back |
|
|
55 | |
|
|
56 | =item digital-clock |
|
|
57 | |
|
|
58 | Displays a very simple digital clock in the upper right corner of the |
|
|
59 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
60 | overlays or changes. |
|
|
61 | |
|
|
62 | =item simple-overlay-clock |
|
|
63 | |
|
|
64 | Displays a digital clock using the built-in overlay (colourful, useless). |
|
|
65 | |
|
|
66 | =back |
|
|
67 | |
52 | |
68 | =head2 General API Considerations |
53 | =head2 General API Considerations |
69 | |
54 | |
70 | All objects (such as terminals, time watchers etc.) are typical |
55 | All objects (such as terminals, time watchers etc.) are typical |
71 | reference-to-hash objects. The hash can be used to store anything you |
56 | 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 |
57 | 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 |
58 | C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or |
74 | modified). |
59 | modified). |
75 | |
60 | |
76 | When objects are destroyed on the C++ side, the perl object hashes are |
61 | 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 |
62 | 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 |
63 | the like inside the terminal object so they get destroyed as soon as the |
79 | terminal is destroyed. |
64 | terminal is destroyed. |
80 | |
65 | |
|
|
66 | Argument names also often indicate the type of a parameter. Here are some |
|
|
67 | hints on what they mean: |
|
|
68 | |
|
|
69 | =over 4 |
|
|
70 | |
|
|
71 | =item $text |
|
|
72 | |
|
|
73 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
|
|
74 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
|
|
75 | |
|
|
76 | =item $string |
|
|
77 | |
|
|
78 | A perl text string, with an emphasis on I<text>. It can store all unicode |
|
|
79 | characters and is to be distinguished with text encoded in a specific |
|
|
80 | encoding (often locale-specific) and binary data. |
|
|
81 | |
|
|
82 | =item $octets |
|
|
83 | |
|
|
84 | Either binary data or - more common - a text string encoded in a |
|
|
85 | locale-specific way. |
|
|
86 | |
|
|
87 | =item $keysym |
|
|
88 | |
|
|
89 | an integer that is a valid X11 keysym code. You can convert a string |
|
|
90 | into a keysym and viceversa by using C<XStringToKeysym> and |
|
|
91 | C<XKeysymToString>. |
|
|
92 | |
|
|
93 | =back |
|
|
94 | |
|
|
95 | =head2 Extension Objects |
|
|
96 | |
|
|
97 | Every perl extension is a perl class. A separate perl object is created |
|
|
98 | for each terminal, and each terminal has its own set of extension objects, |
|
|
99 | which are passed as the first parameter to hooks. So extensions can use |
|
|
100 | their C<$self> object without having to think about clashes with other |
|
|
101 | extensions or other terminals, with the exception of methods and members |
|
|
102 | that begin with an underscore character C<_>: these are reserved for |
|
|
103 | internal use. |
|
|
104 | |
|
|
105 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
|
|
106 | C<urxvt::term> class on this object. |
|
|
107 | |
|
|
108 | Additional methods only supported for extension objects are described in |
|
|
109 | the C<urxvt::extension> section below. |
|
|
110 | |
81 | =head2 Hooks |
111 | =head2 Hooks |
82 | |
112 | |
83 | The following subroutines can be declared in loaded scripts, and will be called |
113 | The following subroutines can be declared in extension files, and will be |
84 | whenever the relevant event happens. |
114 | called whenever the relevant event happens. |
85 | |
115 | |
86 | All of them must return a boolean value. If it is true, then the event |
116 | The first argument passed to them is an extension object as described in |
87 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
117 | the in the C<Extension Objects> section. |
|
|
118 | |
|
|
119 | B<All> of these hooks must return a boolean value. If any of the called |
|
|
120 | hooks returns true, then the event counts as being I<consumed>, and the |
88 | and the relevant action might not be carried out by the C++ code. |
121 | relevant action might not be carried out by the C++ code. |
89 | |
122 | |
90 | When in doubt, return a false value (preferably C<()>). |
123 | I<< When in doubt, return a false value (preferably C<()>). >> |
91 | |
124 | |
92 | =over 4 |
125 | =over 4 |
93 | |
126 | |
94 | =item on_init $term |
127 | =item on_init $term |
95 | |
128 | |
96 | Called after a new terminal object has been initialized, but before |
129 | Called after a new terminal object has been initialized, but before |
97 | windows are created or the command gets run. |
130 | windows are created or the command gets run. Most methods are unsafe to |
|
|
131 | call or deliver senseless data, as terminal size and other characteristics |
|
|
132 | have not yet been determined. You can safely query and change resources |
|
|
133 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
134 | place. |
|
|
135 | |
|
|
136 | =item on_start $term |
|
|
137 | |
|
|
138 | Called at the very end of initialisation of a new terminal, just before |
|
|
139 | trying to map (display) the toplevel and returning to the main loop. |
|
|
140 | |
|
|
141 | =item on_destroy $term |
|
|
142 | |
|
|
143 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
144 | still fully functional (not for long, though). |
98 | |
145 | |
99 | =item on_reset $term |
146 | =item on_reset $term |
100 | |
147 | |
101 | Called after the screen is "reset" for any reason, such as resizing or |
148 | 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 |
149 | control sequences. Here is where you can react on changes to size-related |
103 | variables. |
150 | variables. |
104 | |
151 | |
105 | =item on_start $term |
152 | =item on_child_start $term, $pid |
106 | |
153 | |
107 | Called at the very end of initialisation of a new terminal, just before |
154 | Called just after the child process has been C<fork>ed. |
108 | returning to the mainloop. |
155 | |
|
|
156 | =item on_child_exit $term, $status |
|
|
157 | |
|
|
158 | Called just after the child process has exited. C<$status> is the status |
|
|
159 | from C<waitpid>. |
109 | |
160 | |
110 | =item on_sel_make $term, $eventtime |
161 | =item on_sel_make $term, $eventtime |
111 | |
162 | |
112 | Called whenever a selection has been made by the user, but before the |
163 | Called whenever a selection has been made by the user, but before the |
113 | selection text is copied, so changes to the beginning, end or type of the |
164 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
120 | |
171 | |
121 | Called whenever a selection has been copied, but before the selection is |
172 | Called whenever a selection has been copied, but before the selection is |
122 | requested from the server. The selection text can be queried and changed |
173 | requested from the server. The selection text can be queried and changed |
123 | by calling C<< $term->selection >>. |
174 | by calling C<< $term->selection >>. |
124 | |
175 | |
125 | Returning a true value aborts selection grabbing. It will still be hilighted. |
176 | Returning a true value aborts selection grabbing. It will still be highlighted. |
126 | |
177 | |
127 | =item on_focus_in $term |
178 | =item on_sel_extend $term |
128 | |
179 | |
129 | Called whenever the window gets the keyboard focus, before urxvt does |
180 | Called whenever the user tries to extend the selection (e.g. with a double |
130 | focus in processing. |
181 | click) and is either supposed to return false (normal operation), or |
|
|
182 | should extend the selection itself and return true to suppress the built-in |
|
|
183 | processing. This can happen multiple times, as long as the callback |
|
|
184 | returns true, it will be called on every further click by the user and is |
|
|
185 | supposed to enlarge the selection more and more, if possible. |
131 | |
186 | |
132 | =item on_focus_out $term |
187 | See the F<selection> example extension. |
133 | |
|
|
134 | Called wheneever the window loses keyboard focus, before urxvt does focus |
|
|
135 | out processing. |
|
|
136 | |
188 | |
137 | =item on_view_change $term, $offset |
189 | =item on_view_change $term, $offset |
138 | |
190 | |
139 | Called whenever the view offset changes, i..e the user or program |
191 | Called whenever the view offset changes, i.e. the user or program |
140 | scrolls. Offset C<0> means display the normal terminal, positive values |
192 | scrolls. Offset C<0> means display the normal terminal, positive values |
141 | show this many lines of scrollback. |
193 | show this many lines of scrollback. |
142 | |
194 | |
143 | =item on_scroll_back $term, $lines, $saved |
195 | =item on_scroll_back $term, $lines, $saved |
144 | |
196 | |
… | |
… | |
148 | |
200 | |
149 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
201 | 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 |
202 | $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. |
203 | number of lines that will be in the scrollback buffer. |
152 | |
204 | |
153 | =item on_tty_activity $term *NYI* |
205 | =item on_osc_seq $term, $op, $args, $resp |
154 | |
206 | |
155 | Called whenever the program(s) running in the urxvt window send output. |
207 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
208 | behaviour. The default should be to return an empty list. A true value |
|
|
209 | suppresses execution of the request completely. Make sure you don't get |
|
|
210 | confused by recursive invocations when you output an OSC sequence within |
|
|
211 | this callback. |
|
|
212 | |
|
|
213 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
214 | |
|
|
215 | =item on_osc_seq_perl $term, $args, $resp |
|
|
216 | |
|
|
217 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
|
|
218 | operating system command) is processed. Cursor position and other state |
|
|
219 | information is up-to-date when this happens. For interoperability, the |
|
|
220 | string should start with the extension name (sans -osc) and a semicolon, |
|
|
221 | to distinguish it from commands for other extensions, and this might be |
|
|
222 | enforced in the future. |
|
|
223 | |
|
|
224 | For example, C<overlay-osc> uses this: |
|
|
225 | |
|
|
226 | sub on_osc_seq_perl { |
|
|
227 | my ($self, $osc, $resp) = @_; |
|
|
228 | |
|
|
229 | return unless $osc =~ s/^overlay;//; |
|
|
230 | |
|
|
231 | ... process remaining $osc string |
|
|
232 | } |
|
|
233 | |
|
|
234 | Be careful not ever to trust (in a security sense) the data you receive, |
|
|
235 | as its source can not easily be controlled (e-mail content, messages from |
|
|
236 | other users on the same system etc.). |
|
|
237 | |
|
|
238 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
239 | sender. |
|
|
240 | |
|
|
241 | =item on_add_lines $term, $string |
|
|
242 | |
|
|
243 | Called whenever text is about to be output, with the text as argument. You |
|
|
244 | can filter/change and output the text yourself by returning a true value |
|
|
245 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
|
|
246 | might be very slow, however, as your hook is called for B<all> text being |
|
|
247 | output. |
|
|
248 | |
|
|
249 | =item on_tt_write $term, $octets |
|
|
250 | |
|
|
251 | Called whenever some data is written to the tty/pty and can be used to |
|
|
252 | suppress or filter tty input. |
|
|
253 | |
|
|
254 | =item on_tt_paste $term, $octets |
|
|
255 | |
|
|
256 | Called whenever text is about to be pasted, with the text as argument. You |
|
|
257 | can filter/change and paste the text yourself by returning a true value |
|
|
258 | and calling C<< $term->tt_paste >> yourself. C<$octets> is |
|
|
259 | locale-encoded. |
|
|
260 | |
|
|
261 | =item on_line_update $term, $row |
|
|
262 | |
|
|
263 | Called whenever a line was updated or changed. Can be used to filter |
|
|
264 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
265 | that are being shown will be filtered, and, due to performance reasons, |
|
|
266 | not always immediately. |
|
|
267 | |
|
|
268 | The row number is always the topmost row of the line if the line spans |
|
|
269 | multiple rows. |
|
|
270 | |
|
|
271 | Please note that, if you change the line, then the hook might get called |
|
|
272 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
273 | you cannot just toggle rendition bits, but only set them. |
156 | |
274 | |
157 | =item on_refresh_begin $term |
275 | =item on_refresh_begin $term |
158 | |
276 | |
159 | Called just before the screen gets redrawn. Can be used for overlay |
277 | Called just before the screen gets redrawn. Can be used for overlay or |
160 | or similar effects by modify terminal contents in refresh_begin, and |
278 | similar effects by modifying the terminal contents in refresh_begin, and |
161 | restoring them in refresh_end. The built-in overlay and selection display |
279 | restoring them in refresh_end. The built-in overlay and selection display |
162 | code is run after this hook, and takes precedence. |
280 | code is run after this hook, and takes precedence. |
163 | |
281 | |
164 | =item on_refresh_end $term |
282 | =item on_refresh_end $term |
165 | |
283 | |
166 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
284 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
167 | |
285 | |
168 | =item on_keyboard_command $term, $string |
286 | =item on_user_command $term, $string |
169 | |
287 | |
170 | Called whenever the user presses a key combination that has a |
288 | Called whenever a user-configured event is being activated (e.g. via |
171 | C<perl:string> action bound to it (see description of the B<keysym> |
289 | a C<perl:string> action bound to a key, see description of the B<keysym> |
172 | resource in the @@RXVT_NAME@@(1) manpage). |
290 | resource in the urxvt(1) manpage). |
|
|
291 | |
|
|
292 | The event is simply the action string. This interface is assumed to change |
|
|
293 | slightly in the future. |
|
|
294 | |
|
|
295 | =item on_register_command $term, $keysym, $modifiermask, $string |
|
|
296 | |
|
|
297 | Called after parsing a keysym resource but before registering the |
|
|
298 | associated binding. If this hook returns TRUE the binding is not |
|
|
299 | registered. It can be used to modify a binding by calling |
|
|
300 | C<register_command>. |
|
|
301 | |
|
|
302 | =item on_resize_all_windows $term, $new_width, $new_height |
|
|
303 | |
|
|
304 | Called just after the new window size has been calculated, but before |
|
|
305 | windows are actually being resized or hints are being set. If this hook |
|
|
306 | returns TRUE, setting of the window hints is being skipped. |
|
|
307 | |
|
|
308 | =item on_x_event $term, $event |
|
|
309 | |
|
|
310 | Called on every X event received on the vt window (and possibly other |
|
|
311 | windows). Should only be used as a last resort. Most event structure |
|
|
312 | members are not passed. |
|
|
313 | |
|
|
314 | =item on_root_event $term, $event |
|
|
315 | |
|
|
316 | Like C<on_x_event>, but is called for events on the root window. |
|
|
317 | |
|
|
318 | =item on_focus_in $term |
|
|
319 | |
|
|
320 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
|
|
321 | does focus in processing. |
|
|
322 | |
|
|
323 | =item on_focus_out $term |
|
|
324 | |
|
|
325 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
|
|
326 | focus out processing. |
|
|
327 | |
|
|
328 | =item on_configure_notify $term, $event |
|
|
329 | |
|
|
330 | =item on_property_notify $term, $event |
|
|
331 | |
|
|
332 | =item on_key_press $term, $event, $keysym, $octets |
|
|
333 | |
|
|
334 | =item on_key_release $term, $event, $keysym |
|
|
335 | |
|
|
336 | =item on_button_press $term, $event |
|
|
337 | |
|
|
338 | =item on_button_release $term, $event |
|
|
339 | |
|
|
340 | =item on_motion_notify $term, $event |
|
|
341 | |
|
|
342 | =item on_map_notify $term, $event |
|
|
343 | |
|
|
344 | =item on_unmap_notify $term, $event |
|
|
345 | |
|
|
346 | Called whenever the corresponding X event is received for the terminal. If |
|
|
347 | the hook returns true, then the event will be ignored by rxvt-unicode. |
|
|
348 | |
|
|
349 | The event is a hash with most values as named by Xlib (see the XEvent |
|
|
350 | manpage), with the additional members C<row> and C<col>, which are the |
|
|
351 | (real, not screen-based) row and column under the mouse cursor. |
|
|
352 | |
|
|
353 | C<on_key_press> additionally receives the string rxvt-unicode would |
|
|
354 | output, if any, in locale-specific encoding. |
|
|
355 | |
|
|
356 | subwindow. |
|
|
357 | |
|
|
358 | =item on_client_message $term, $event |
|
|
359 | |
|
|
360 | =item on_wm_protocols $term, $event |
|
|
361 | |
|
|
362 | =item on_wm_delete_window $term, $event |
|
|
363 | |
|
|
364 | Called when various types of ClientMessage events are received (all with |
|
|
365 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
366 | |
|
|
367 | =item on_bell $term |
|
|
368 | |
|
|
369 | Called on receipt of a bell character. |
173 | |
370 | |
174 | =back |
371 | =back |
175 | |
372 | |
|
|
373 | =cut |
|
|
374 | |
|
|
375 | package urxvt; |
|
|
376 | |
|
|
377 | use utf8; |
|
|
378 | use strict 'vars'; |
|
|
379 | use Carp (); |
|
|
380 | use Scalar::Util (); |
|
|
381 | use List::Util (); |
|
|
382 | |
|
|
383 | our $VERSION = 1; |
|
|
384 | our $TERM; |
|
|
385 | our @TERM_INIT; # should go, prevents async I/O etc. |
|
|
386 | our @TERM_EXT; # should go, prevents async I/O etc. |
|
|
387 | our @HOOKNAME; |
|
|
388 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
|
|
389 | our %OPTION; |
|
|
390 | |
|
|
391 | our $LIBDIR; |
|
|
392 | our $RESNAME; |
|
|
393 | our $RESCLASS; |
|
|
394 | our $RXVTNAME; |
|
|
395 | |
|
|
396 | our $NOCHAR = chr 0xffff; |
|
|
397 | |
|
|
398 | =head2 Variables in the C<urxvt> Package |
|
|
399 | |
|
|
400 | =over 4 |
|
|
401 | |
|
|
402 | =item $urxvt::LIBDIR |
|
|
403 | |
|
|
404 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
405 | modules and scripts are stored. |
|
|
406 | |
|
|
407 | =item $urxvt::RESCLASS, $urxvt::RESCLASS |
|
|
408 | |
|
|
409 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
410 | |
|
|
411 | =item $urxvt::RXVTNAME |
|
|
412 | |
|
|
413 | The basename of the installed binaries, usually C<urxvt>. |
|
|
414 | |
|
|
415 | =item $urxvt::TERM |
|
|
416 | |
|
|
417 | The current terminal. This variable stores the current C<urxvt::term> |
|
|
418 | object, whenever a callback/hook is executing. |
|
|
419 | |
|
|
420 | =item @urxvt::TERM_INIT |
|
|
421 | |
|
|
422 | All code references in this array will be called as methods of the next newly |
|
|
423 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
424 | gets cleared before the code references that were in it are being executed, |
|
|
425 | so references can push themselves onto it again if they so desire. |
|
|
426 | |
|
|
427 | This complements to the perl-eval command line option, but gets executed |
|
|
428 | first. |
|
|
429 | |
|
|
430 | =item @urxvt::TERM_EXT |
|
|
431 | |
|
|
432 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
433 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
434 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
|
|
435 | |
|
|
436 | =back |
|
|
437 | |
176 | =head2 Functions in the C<urxvt> Package |
438 | =head2 Functions in the C<urxvt> Package |
177 | |
439 | |
178 | =over 4 |
440 | =over 4 |
179 | |
441 | |
180 | =item urxvt::fatal $errormessage |
442 | =item urxvt::fatal $errormessage |
181 | |
443 | |
182 | Fatally aborts execution with the given error message. Avoid at all |
444 | Fatally aborts execution with the given error message (which should |
183 | costs! The only time this is acceptable is when the terminal process |
445 | include a trailing newline). Avoid at all costs! The only time this |
184 | starts up. |
446 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
447 | terminal from starting up. |
185 | |
448 | |
186 | =item urxvt::warn $string |
449 | =item urxvt::warn $string |
187 | |
450 | |
188 | Calls C<rxvt_warn> with the given string which should not include a |
451 | Calls C<rxvt_warn> with the given string which should include a trailing |
189 | newline. The module also overwrites the C<warn> builtin with a function |
452 | newline. The module also overwrites the C<warn> builtin with a function |
190 | that calls this function. |
453 | that calls this function. |
191 | |
454 | |
192 | Using this function has the advantage that its output ends up in the |
455 | 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. |
456 | correct place, e.g. on stderr of the connecting urxvtc client. |
194 | |
457 | |
|
|
458 | Messages have a size limit of 1023 bytes currently. |
|
|
459 | |
|
|
460 | =item @terms = urxvt::termlist |
|
|
461 | |
|
|
462 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
463 | whether they are started, being destroyed etc., so be careful. Only term |
|
|
464 | objects that have perl extensions attached will be returned (because there |
|
|
465 | is no urxvt::term object associated with others). |
|
|
466 | |
195 | =item $time = urxvt::NOW |
467 | =item $time = urxvt::NOW |
196 | |
468 | |
197 | Returns the "current time" (as per the event loop). |
469 | Returns the "current time" (as per the event loop). |
|
|
470 | |
|
|
471 | =item urxvt::CurrentTime |
|
|
472 | |
|
|
473 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
474 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
475 | Button4Mask, Button5Mask, AnyModifier |
|
|
476 | |
|
|
477 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
478 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
479 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
480 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
481 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
482 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
483 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
484 | |
|
|
485 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
486 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
487 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
488 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
489 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
490 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
491 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
|
|
492 | |
|
|
493 | Various constants for use in X calls and event processing. |
|
|
494 | |
|
|
495 | =back |
198 | |
496 | |
199 | =head2 RENDITION |
497 | =head2 RENDITION |
200 | |
498 | |
201 | Rendition bitsets contain information about colour, font, font styles and |
499 | Rendition bitsets contain information about colour, font, font styles and |
202 | similar information for each screen cell. |
500 | similar information for each screen cell. |
… | |
… | |
215 | |
513 | |
216 | =item $rend = urxvt::OVERLAY_RSTYLE |
514 | =item $rend = urxvt::OVERLAY_RSTYLE |
217 | |
515 | |
218 | Return the rendition mask used for overlays by default. |
516 | Return the rendition mask used for overlays by default. |
219 | |
517 | |
220 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
518 | =item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, |
|
|
519 | urxvt::RS_RVid, urxvt::RS_Uline |
221 | |
520 | |
222 | Return the bit that enabled bold, italic, blink, reverse-video and |
521 | Return the bit that enabled bold, italic, blink, reverse-video and |
223 | underline, respectively. To enable such a style, just or it onto the |
522 | underline, respectively. To enable such a style, just logically OR it into |
224 | bitset. |
523 | the bitset. |
225 | |
524 | |
226 | =item $foreground = urxvt::GET_BASEFG $rend |
525 | =item $foreground = urxvt::GET_BASEFG $rend |
227 | |
526 | |
228 | =item $background = urxvt::GET_BASEBG $rend |
527 | =item $background = urxvt::GET_BASEBG $rend |
229 | |
528 | |
230 | Return the foreground/background colour index, respectively. |
529 | Return the foreground/background colour index, respectively. |
231 | |
530 | |
232 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
531 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
233 | |
532 | |
234 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
533 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
534 | |
|
|
535 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
235 | |
536 | |
236 | Replace the foreground/background colour in the rendition mask with the |
537 | Replace the foreground/background colour in the rendition mask with the |
237 | specified one. |
538 | specified one. |
238 | |
539 | |
|
|
540 | =item $value = urxvt::GET_CUSTOM $rend |
|
|
541 | |
|
|
542 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
543 | extensions. They can be set and changed as you like and are initially |
|
|
544 | zero. |
|
|
545 | |
|
|
546 | =item $rend = urxvt::SET_CUSTOM $rend, $new_value |
|
|
547 | |
|
|
548 | Change the custom value. |
|
|
549 | |
239 | =back |
550 | =back |
240 | |
551 | |
241 | =cut |
552 | =cut |
242 | |
553 | |
243 | package urxvt; |
|
|
244 | |
|
|
245 | use strict; |
|
|
246 | |
|
|
247 | our $term; |
|
|
248 | our @HOOKNAME; |
|
|
249 | our $LIBDIR; |
|
|
250 | |
|
|
251 | BEGIN { |
554 | BEGIN { |
252 | urxvt->bootstrap; |
|
|
253 | |
|
|
254 | # overwrite perl's warn |
555 | # overwrite perl's warn |
255 | *CORE::GLOBAL::warn = sub { |
556 | *CORE::GLOBAL::warn = sub { |
256 | my $msg = join "", @_; |
557 | my $msg = join "", @_; |
257 | $msg .= "\n" |
558 | $msg .= "\n" |
258 | unless $msg =~ /\n$/; |
559 | unless $msg =~ /\n$/; |
259 | urxvt::warn ($msg); |
560 | urxvt::warn ($msg); |
260 | }; |
561 | }; |
261 | } |
562 | } |
262 | |
563 | |
263 | my @hook_count; |
564 | no warnings 'utf8'; |
|
|
565 | |
|
|
566 | sub parse_resource { |
|
|
567 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
|
|
568 | |
|
|
569 | $name =~ y/-/./ if $isarg; |
|
|
570 | |
|
|
571 | $term->scan_meta; |
|
|
572 | |
|
|
573 | my $r = $term->{meta}{resource}; |
|
|
574 | keys %$r; # reste iterator |
|
|
575 | while (my ($pattern, $v) = each %$r) { |
|
|
576 | if ( |
|
|
577 | $pattern =~ /\.$/ |
|
|
578 | ? $pattern eq substr $name, 0, length $pattern |
|
|
579 | : $pattern eq $name |
|
|
580 | ) { |
|
|
581 | $name = "$urxvt::RESCLASS.$name"; |
|
|
582 | |
|
|
583 | push @{ $term->{perl_ext_3} }, $v->[0]; |
|
|
584 | |
|
|
585 | if ($v->[1] eq "boolean") { |
|
|
586 | $term->put_option_db ($name, $flag ? "true" : "false"); |
|
|
587 | return 1; |
|
|
588 | } else { |
|
|
589 | $term->put_option_db ($name, $value); |
|
|
590 | return 1 + 2; |
|
|
591 | } |
|
|
592 | } |
|
|
593 | } |
|
|
594 | |
|
|
595 | 0 |
|
|
596 | } |
|
|
597 | |
|
|
598 | sub usage { |
|
|
599 | my ($term, $usage_type) = @_; |
|
|
600 | |
|
|
601 | $term->scan_meta; |
|
|
602 | |
|
|
603 | my $r = $term->{meta}{resource}; |
|
|
604 | |
|
|
605 | for my $pattern (sort keys %$r) { |
|
|
606 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
|
|
607 | |
|
|
608 | $desc .= " (-pe $ext)"; |
|
|
609 | |
|
|
610 | if ($usage_type == 1) { |
|
|
611 | $pattern =~ y/./-/; |
|
|
612 | $pattern =~ s/-$/-.../g; |
|
|
613 | |
|
|
614 | if ($type eq "boolean") { |
|
|
615 | urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc; |
|
|
616 | } else { |
|
|
617 | urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc; |
|
|
618 | } |
|
|
619 | } else { |
|
|
620 | $pattern =~ s/\.$/.*/g; |
|
|
621 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
|
|
622 | } |
|
|
623 | } |
|
|
624 | } |
|
|
625 | |
264 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
626 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
265 | |
627 | |
266 | sub verbose { |
628 | sub verbose { |
267 | my ($level, $msg) = @_; |
629 | my ($level, $msg) = @_; |
268 | warn "$msg\n" if $level <= $verbosity; |
630 | warn "$msg\n" if $level <= $verbosity; |
269 | } |
631 | } |
270 | |
632 | |
271 | # find on_xxx subs in the package and register them |
633 | my %extension_pkg; |
272 | # as hooks |
|
|
273 | sub register_package($) { |
|
|
274 | my ($pkg) = @_; |
|
|
275 | |
|
|
276 | for my $htype (0.. $#HOOKNAME) { |
|
|
277 | my $name = $HOOKNAME[$htype]; |
|
|
278 | |
|
|
279 | my $ref = $pkg->can ("on_" . lc $name) |
|
|
280 | or next; |
|
|
281 | |
|
|
282 | $term->{_hook}[$htype]{$ref*1} = $ref; |
|
|
283 | $hook_count[$htype]++ |
|
|
284 | or set_should_invoke $htype, 1; |
|
|
285 | } |
|
|
286 | } |
|
|
287 | |
|
|
288 | my $script_pkg = "script0000"; |
|
|
289 | my %script_pkg; |
|
|
290 | |
634 | |
291 | # load a single script into its own package, once only |
635 | # load a single script into its own package, once only |
292 | sub script_package($) { |
636 | sub extension_package($) { |
293 | my ($path) = @_; |
637 | my ($path) = @_; |
294 | |
638 | |
295 | $script_pkg{$path} ||= do { |
639 | $extension_pkg{$path} ||= do { |
296 | my $pkg = "urxvt::" . ($script_pkg++); |
640 | $path =~ /([^\/\\]+)$/; |
|
|
641 | my $pkg = $1; |
|
|
642 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
643 | $pkg = "urxvt::ext::$pkg"; |
297 | |
644 | |
298 | verbose 3, "loading script '$path' into package '$pkg'"; |
645 | verbose 3, "loading extension '$path' into package '$pkg'"; |
|
|
646 | |
|
|
647 | (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish |
299 | |
648 | |
300 | open my $fh, "<:raw", $path |
649 | open my $fh, "<:raw", $path |
301 | or die "$path: $!"; |
650 | or die "$path: $!"; |
302 | |
651 | |
303 | my $source = "package $pkg; use strict; use utf8;\n" |
652 | my $source = |
|
|
653 | "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n" |
304 | . "#line 1 \"$path\"\n{\n" |
654 | . "#line 1 \"$path\"\n{\n" |
305 | . (do { local $/; <$fh> }) |
655 | . (do { local $/; <$fh> }) |
306 | . "\n};\n1"; |
656 | . "\n};\n1"; |
307 | |
657 | |
|
|
658 | eval $source |
308 | eval $source or die "$path: $@"; |
659 | or die "$path: $@"; |
309 | |
660 | |
310 | $pkg |
661 | $pkg |
311 | } |
662 | } |
312 | } |
663 | } |
313 | |
664 | |
|
|
665 | our $retval; # return value for urxvt |
|
|
666 | |
314 | # called by the rxvt core |
667 | # called by the rxvt core |
315 | sub invoke { |
668 | sub invoke { |
316 | local $term = shift; |
669 | local $TERM = shift; |
317 | my $htype = shift; |
670 | my $htype = shift; |
318 | |
671 | |
319 | if ($htype == 0) { # INIT |
672 | if ($htype == 0) { # INIT |
320 | my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); |
673 | my @dirs = $TERM->perl_libdirs; |
321 | |
674 | |
322 | for my $ext (split /:/, $term->resource ("perl_ext")) { |
675 | my %ext_arg; |
|
|
676 | |
|
|
677 | { |
|
|
678 | my @init = @TERM_INIT; |
|
|
679 | @TERM_INIT = (); |
|
|
680 | $_->($TERM) for @init; |
|
|
681 | my @pkg = @TERM_EXT; |
|
|
682 | @TERM_EXT = (); |
|
|
683 | $TERM->register_package ($_) for @pkg; |
|
|
684 | } |
|
|
685 | |
|
|
686 | for ( |
|
|
687 | @{ delete $TERM->{perl_ext_3} }, |
|
|
688 | grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 |
|
|
689 | ) { |
|
|
690 | if ($_ eq "default") { |
|
|
691 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
|
|
692 | } elsif (/^-(.*)$/) { |
|
|
693 | delete $ext_arg{$1}; |
|
|
694 | } elsif (/^([^<]+)<(.*)>$/) { |
|
|
695 | push @{ $ext_arg{$1} }, $2; |
|
|
696 | } else { |
|
|
697 | $ext_arg{$_} ||= []; |
|
|
698 | } |
|
|
699 | } |
|
|
700 | |
|
|
701 | for my $ext (sort keys %ext_arg) { |
323 | my @files = grep -f $_, map "$_/$ext", @dirs; |
702 | my @files = grep -f $_, map "$_/$ext", @dirs; |
324 | |
703 | |
325 | if (@files) { |
704 | if (@files) { |
326 | register_package script_package $files[0]; |
705 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
327 | } else { |
706 | } else { |
328 | warn "perl extension '$ext' not found in perl library search path\n"; |
707 | warn "perl extension '$ext' not found in perl library search path\n"; |
329 | } |
708 | } |
330 | } |
709 | } |
331 | |
710 | |
|
|
711 | eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); |
|
|
712 | warn $@ if $@; |
|
|
713 | } |
|
|
714 | |
|
|
715 | $retval = undef; |
|
|
716 | |
|
|
717 | if (my $cb = $TERM->{_hook}[$htype]) { |
|
|
718 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
|
|
719 | if $verbosity >= 10; |
|
|
720 | |
|
|
721 | for my $pkg (keys %$cb) { |
|
|
722 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
|
|
723 | $retval ||= $retval_; |
|
|
724 | |
|
|
725 | if ($@) { |
|
|
726 | $TERM->ungrab; # better to lose the grab than the session |
|
|
727 | warn $@; |
|
|
728 | } |
|
|
729 | } |
|
|
730 | |
|
|
731 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
732 | if $verbosity >= 11; |
|
|
733 | } |
|
|
734 | |
332 | } elsif ($htype == 1) { # DESTROY |
735 | if ($htype == 1) { # DESTROY |
333 | if (my $hook = $term->{_hook}) { |
736 | # clear package objects |
334 | for my $htype (0..$#$hook) { |
737 | %$_ = () for values %{ $TERM->{_pkg} }; |
335 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
738 | |
336 | or set_should_invoke $htype, 0; |
739 | # clear package |
|
|
740 | %$TERM = (); |
|
|
741 | } |
|
|
742 | |
|
|
743 | $retval |
|
|
744 | } |
|
|
745 | |
|
|
746 | sub SET_COLOR($$$) { |
|
|
747 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
748 | } |
|
|
749 | |
|
|
750 | sub rend2mask { |
|
|
751 | no strict 'refs'; |
|
|
752 | my ($str, $mask) = (@_, 0); |
|
|
753 | my %color = ( fg => undef, bg => undef ); |
|
|
754 | my @failed; |
|
|
755 | for my $spec ( split /\s+/, $str ) { |
|
|
756 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
757 | $color{lc($1)} = $2; |
|
|
758 | } else { |
|
|
759 | my $neg = $spec =~ s/^[-^]//; |
|
|
760 | unless ( exists &{"RS_$spec"} ) { |
|
|
761 | push @failed, $spec; |
|
|
762 | next; |
|
|
763 | } |
|
|
764 | my $cur = &{"RS_$spec"}; |
|
|
765 | if ( $neg ) { |
|
|
766 | $mask &= ~$cur; |
|
|
767 | } else { |
|
|
768 | $mask |= $cur; |
337 | } |
769 | } |
338 | } |
770 | } |
339 | } |
771 | } |
|
|
772 | ($mask, @color{qw(fg bg)}, \@failed) |
|
|
773 | } |
340 | |
774 | |
341 | my $cb = $term->{_hook}[$htype] |
775 | package urxvt::term::extension; |
342 | or return; |
|
|
343 | |
776 | |
344 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" |
777 | =head2 The C<urxvt::term::extension> class |
345 | if $verbosity >= 10; |
|
|
346 | |
778 | |
|
|
779 | Each extension attached to a terminal object is represented by |
|
|
780 | a C<urxvt::term::extension> object. |
|
|
781 | |
|
|
782 | You can use these objects, which are passed to all callbacks to store any |
|
|
783 | state related to the terminal and extension instance. |
|
|
784 | |
|
|
785 | The methods (And data members) documented below can be called on extension |
|
|
786 | objects, in addition to call methods documented for the <urxvt::term> |
|
|
787 | class. |
|
|
788 | |
|
|
789 | =over 4 |
|
|
790 | |
|
|
791 | =item $urxvt_term = $self->{term} |
|
|
792 | |
|
|
793 | Returns the C<urxvt::term> object associated with this instance of the |
|
|
794 | extension. This member I<must not> be changed in any way. |
|
|
795 | |
|
|
796 | =cut |
|
|
797 | |
|
|
798 | our $AUTOLOAD; |
|
|
799 | |
|
|
800 | sub AUTOLOAD { |
|
|
801 | $AUTOLOAD =~ /:([^:]+)$/ |
|
|
802 | or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable"; |
|
|
803 | |
|
|
804 | eval qq{ |
|
|
805 | sub $AUTOLOAD { |
|
|
806 | my \$proxy = shift; |
|
|
807 | \$proxy->{term}->$1 (\@_) |
|
|
808 | } |
|
|
809 | 1 |
|
|
810 | } or die "FATAL: unable to compile method forwarder: $@"; |
|
|
811 | |
|
|
812 | goto &$AUTOLOAD; |
|
|
813 | } |
|
|
814 | |
|
|
815 | sub DESTROY { |
|
|
816 | # nop |
|
|
817 | } |
|
|
818 | |
|
|
819 | # urxvt::destroy_hook (basically a cheap Guard:: implementation) |
|
|
820 | |
|
|
821 | sub urxvt::destroy_hook::DESTROY { |
|
|
822 | ${$_[0]}->(); |
|
|
823 | } |
|
|
824 | |
|
|
825 | sub urxvt::destroy_hook(&) { |
|
|
826 | bless \shift, urxvt::destroy_hook:: |
|
|
827 | } |
|
|
828 | |
|
|
829 | =item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
830 | |
|
|
831 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
832 | this extension, replacing any previous hook. This is useful when you want |
|
|
833 | to overwrite time-critical hooks only temporarily. |
|
|
834 | |
|
|
835 | To install additional callbacks for the same hook, you can use the C<on> |
|
|
836 | method of the C<urxvt::term> class. |
|
|
837 | |
|
|
838 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
839 | |
|
|
840 | Dynamically disable the given hooks. |
|
|
841 | |
|
|
842 | =cut |
|
|
843 | |
|
|
844 | sub enable { |
|
|
845 | my ($self, %hook) = @_; |
|
|
846 | my $pkg = $self->{_pkg}; |
|
|
847 | |
347 | while (my ($k, $v) = each %$cb) { |
848 | while (my ($name, $cb) = each %hook) { |
348 | return 1 if $v->($term, @_); |
849 | my $htype = $HOOKTYPE{uc $name}; |
|
|
850 | defined $htype |
|
|
851 | or Carp::croak "unsupported hook type '$name'"; |
|
|
852 | |
|
|
853 | $self->set_should_invoke ($htype, +1) |
|
|
854 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
|
|
855 | |
|
|
856 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
349 | } |
857 | } |
|
|
858 | } |
350 | |
859 | |
|
|
860 | sub disable { |
|
|
861 | my ($self, @hook) = @_; |
|
|
862 | my $pkg = $self->{_pkg}; |
|
|
863 | |
|
|
864 | for my $name (@hook) { |
|
|
865 | my $htype = $HOOKTYPE{uc $name}; |
|
|
866 | defined $htype |
|
|
867 | or Carp::croak "unsupported hook type '$name'"; |
|
|
868 | |
|
|
869 | $self->set_should_invoke ($htype, -1) |
|
|
870 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
351 | 0 |
871 | } |
|
|
872 | } |
|
|
873 | |
|
|
874 | =item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
875 | |
|
|
876 | Similar to the C<enable> enable, but installs additional callbacks for |
|
|
877 | the given hook(s) (that is, it doesn't replace existing callbacks), and |
|
|
878 | returns a guard object. When the guard object is destroyed the callbacks |
|
|
879 | are disabled again. |
|
|
880 | |
|
|
881 | =cut |
|
|
882 | |
|
|
883 | sub urxvt::extension::on_disable::DESTROY { |
|
|
884 | my $disable = shift; |
|
|
885 | |
|
|
886 | my $term = delete $disable->{""}; |
|
|
887 | |
|
|
888 | while (my ($htype, $id) = each %$disable) { |
|
|
889 | delete $term->{_hook}[$htype]{$id}; |
|
|
890 | $term->set_should_invoke ($htype, -1); |
|
|
891 | } |
|
|
892 | } |
|
|
893 | |
|
|
894 | sub on { |
|
|
895 | my ($self, %hook) = @_; |
|
|
896 | |
|
|
897 | my $term = $self->{term}; |
|
|
898 | |
|
|
899 | my %disable = ( "" => $term ); |
|
|
900 | |
|
|
901 | while (my ($name, $cb) = each %hook) { |
|
|
902 | my $htype = $HOOKTYPE{uc $name}; |
|
|
903 | defined $htype |
|
|
904 | or Carp::croak "unsupported hook type '$name'"; |
|
|
905 | |
|
|
906 | $term->set_should_invoke ($htype, +1); |
|
|
907 | $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 } |
|
|
908 | = sub { shift; $cb->($self, @_) }; # very ugly indeed |
|
|
909 | } |
|
|
910 | |
|
|
911 | bless \%disable, "urxvt::extension::on_disable" |
|
|
912 | } |
|
|
913 | |
|
|
914 | =item $self->x_resource ($pattern) |
|
|
915 | |
|
|
916 | =item $self->x_resource_boolean ($pattern) |
|
|
917 | |
|
|
918 | These methods support an additional C<%> prefix when called on an |
|
|
919 | extension object - see the description of these methods in the |
|
|
920 | C<urxvt::term> class for details. |
|
|
921 | |
|
|
922 | =cut |
|
|
923 | |
|
|
924 | sub x_resource { |
|
|
925 | my ($self, $name) = @_; |
|
|
926 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
927 | $self->{term}->x_resource ($name) |
|
|
928 | } |
|
|
929 | |
|
|
930 | sub x_resource_boolean { |
|
|
931 | my ($self, $name) = @_; |
|
|
932 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
933 | $self->{term}->x_resource_boolean ($name) |
352 | } |
934 | } |
353 | |
935 | |
354 | =back |
936 | =back |
355 | |
937 | |
|
|
938 | =cut |
|
|
939 | |
|
|
940 | package urxvt::anyevent; |
|
|
941 | |
|
|
942 | =head2 The C<urxvt::anyevent> Class |
|
|
943 | |
|
|
944 | The sole purpose of this class is to deliver an interface to the |
|
|
945 | C<AnyEvent> module - any module using it will work inside urxvt without |
|
|
946 | further programming. The only exception is that you cannot wait on |
|
|
947 | condition variables, but non-blocking condvar use is ok. |
|
|
948 | |
|
|
949 | In practical terms this means is that you cannot use blocking APIs, but |
|
|
950 | the non-blocking variant should work. |
|
|
951 | |
|
|
952 | =cut |
|
|
953 | |
|
|
954 | our $VERSION = '5.23'; |
|
|
955 | |
|
|
956 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
|
|
957 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
|
|
958 | |
|
|
959 | sub timer { |
|
|
960 | my ($class, %arg) = @_; |
|
|
961 | |
|
|
962 | my $cb = $arg{cb}; |
|
|
963 | |
|
|
964 | urxvt::timer |
|
|
965 | ->new |
|
|
966 | ->after ($arg{after}, $arg{interval}) |
|
|
967 | ->cb ($arg{interval} ? $cb : sub { |
|
|
968 | $_[0]->stop; # need to cancel manually |
|
|
969 | $cb->(); |
|
|
970 | }) |
|
|
971 | } |
|
|
972 | |
|
|
973 | sub io { |
|
|
974 | my ($class, %arg) = @_; |
|
|
975 | |
|
|
976 | my $cb = $arg{cb}; |
|
|
977 | my $fd = fileno $arg{fh}; |
|
|
978 | defined $fd or $fd = $arg{fh}; |
|
|
979 | |
|
|
980 | bless [$arg{fh}, urxvt::iow |
|
|
981 | ->new |
|
|
982 | ->fd ($fd) |
|
|
983 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
|
|
984 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
|
|
985 | ->start |
|
|
986 | ->cb ($cb) |
|
|
987 | ], urxvt::anyevent:: |
|
|
988 | } |
|
|
989 | |
|
|
990 | sub idle { |
|
|
991 | my ($class, %arg) = @_; |
|
|
992 | |
|
|
993 | my $cb = $arg{cb}; |
|
|
994 | |
|
|
995 | urxvt::iw |
|
|
996 | ->new |
|
|
997 | ->start |
|
|
998 | ->cb ($cb) |
|
|
999 | } |
|
|
1000 | |
|
|
1001 | sub child { |
|
|
1002 | my ($class, %arg) = @_; |
|
|
1003 | |
|
|
1004 | my $cb = $arg{cb}; |
|
|
1005 | |
|
|
1006 | urxvt::pw |
|
|
1007 | ->new |
|
|
1008 | ->start ($arg{pid}) |
|
|
1009 | ->cb (sub { |
|
|
1010 | $_[0]->stop; # need to cancel manually |
|
|
1011 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1012 | }) |
|
|
1013 | } |
|
|
1014 | |
|
|
1015 | sub DESTROY { |
|
|
1016 | $_[0][1]->stop; |
|
|
1017 | } |
|
|
1018 | |
|
|
1019 | # only needed for AnyEvent < 6 compatibility |
|
|
1020 | sub one_event { |
|
|
1021 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
|
|
1022 | } |
|
|
1023 | |
|
|
1024 | package urxvt::term; |
|
|
1025 | |
356 | =head2 The C<urxvt::term> Class |
1026 | =head2 The C<urxvt::term> Class |
357 | |
1027 | |
358 | =over 4 |
1028 | =over 4 |
|
|
1029 | |
|
|
1030 | =cut |
|
|
1031 | |
|
|
1032 | # find on_xxx subs in the package and register them |
|
|
1033 | # as hooks |
|
|
1034 | sub register_package { |
|
|
1035 | my ($self, $pkg, $argv) = @_; |
|
|
1036 | |
|
|
1037 | no strict 'refs'; |
|
|
1038 | |
|
|
1039 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
1040 | |
|
|
1041 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
1042 | |
|
|
1043 | my $proxy = bless { |
|
|
1044 | _pkg => $pkg, |
|
|
1045 | _name => ${"$pkg\::_NAME"}, # hackish |
|
|
1046 | argv => $argv, |
|
|
1047 | }, $pkg; |
|
|
1048 | Scalar::Util::weaken ($proxy->{term} = $self); |
|
|
1049 | |
|
|
1050 | $self->{_pkg}{$pkg} = $proxy; |
|
|
1051 | |
|
|
1052 | for my $name (@HOOKNAME) { |
|
|
1053 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
|
|
1054 | $proxy->enable ($name => $ref); |
|
|
1055 | } |
|
|
1056 | } |
|
|
1057 | } |
|
|
1058 | |
|
|
1059 | sub perl_libdirs { |
|
|
1060 | map { split /:/ } |
|
|
1061 | $_[0]->resource ("perl_lib"), |
|
|
1062 | $ENV{URXVT_PERL_LIB}, |
|
|
1063 | "$ENV{HOME}/.urxvt/ext", |
|
|
1064 | "$LIBDIR/perl" |
|
|
1065 | } |
|
|
1066 | |
|
|
1067 | sub scan_meta { |
|
|
1068 | my ($self) = @_; |
|
|
1069 | my @libdirs = perl_libdirs $self; |
|
|
1070 | |
|
|
1071 | return if $self->{meta_libdirs} eq join "\x00", @libdirs; |
|
|
1072 | |
|
|
1073 | my %meta; |
|
|
1074 | |
|
|
1075 | $self->{meta_libdirs} = join "\x00", @libdirs; |
|
|
1076 | $self->{meta} = \%meta; |
|
|
1077 | |
|
|
1078 | for my $dir (reverse @libdirs) { |
|
|
1079 | opendir my $fh, $dir |
|
|
1080 | or next; |
|
|
1081 | for my $ext (readdir $fh) { |
|
|
1082 | $ext !~ /^\./ |
|
|
1083 | and open my $fh, "<", "$dir/$ext" |
|
|
1084 | or next; |
|
|
1085 | |
|
|
1086 | while (<$fh>) { |
|
|
1087 | if (/^#:META:X_RESOURCE:(.*)/) { |
|
|
1088 | my ($pattern, $type, $desc) = split /:/, $1; |
|
|
1089 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
|
|
1090 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
|
|
1091 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
|
|
1092 | } else { |
|
|
1093 | $meta{resource}{$pattern} = [$ext, $type, $desc]; |
|
|
1094 | } |
|
|
1095 | } elsif (/^\s*(?:#|$)/) { |
|
|
1096 | # skip other comments and empty lines |
|
|
1097 | } else { |
|
|
1098 | last; # stop parsing on first non-empty non-comment line |
|
|
1099 | } |
|
|
1100 | } |
|
|
1101 | } |
|
|
1102 | } |
|
|
1103 | } |
|
|
1104 | |
|
|
1105 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
|
|
1106 | |
|
|
1107 | Creates a new terminal, very similar as if you had started it with system |
|
|
1108 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
|
|
1109 | hash which defines the environment of the new terminal. |
|
|
1110 | |
|
|
1111 | Croaks (and probably outputs an error message) if the new instance |
|
|
1112 | couldn't be created. Returns C<undef> if the new instance didn't |
|
|
1113 | initialise perl, and the terminal object otherwise. The C<init> and |
|
|
1114 | C<start> hooks will be called before this call returns, and are free to |
|
|
1115 | refer to global data (which is race free). |
|
|
1116 | |
|
|
1117 | =cut |
|
|
1118 | |
|
|
1119 | sub new { |
|
|
1120 | my ($class, $env, @args) = @_; |
|
|
1121 | |
|
|
1122 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1123 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1124 | |
|
|
1125 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
|
|
1126 | } |
|
|
1127 | |
|
|
1128 | =item $term->destroy |
|
|
1129 | |
|
|
1130 | Destroy the terminal object (close the window, free resources |
|
|
1131 | etc.). Please note that urxvt will not exit as long as any event |
|
|
1132 | watchers (timers, io watchers) are still active. |
|
|
1133 | |
|
|
1134 | =item $term->exec_async ($cmd[, @args]) |
|
|
1135 | |
|
|
1136 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
1137 | ("starts") programs in the background. This function takes care of setting |
|
|
1138 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
1139 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
1140 | |
|
|
1141 | Returns the pid of the subprocess or C<undef> on error. |
|
|
1142 | |
|
|
1143 | =cut |
|
|
1144 | |
|
|
1145 | sub exec_async { |
|
|
1146 | my $self = shift; |
|
|
1147 | |
|
|
1148 | my $pid = fork; |
|
|
1149 | |
|
|
1150 | return $pid |
|
|
1151 | if !defined $pid or $pid; |
|
|
1152 | |
|
|
1153 | %ENV = %{ $self->env }; |
|
|
1154 | |
|
|
1155 | exec @_; |
|
|
1156 | urxvt::_exit 255; |
|
|
1157 | } |
|
|
1158 | |
|
|
1159 | =item $isset = $term->option ($optval[, $set]) |
|
|
1160 | |
|
|
1161 | Returns true if the option specified by C<$optval> is enabled, and |
|
|
1162 | optionally change it. All option values are stored by name in the hash |
|
|
1163 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
|
|
1164 | |
|
|
1165 | Here is a likely non-exhaustive list of option names, please see the |
|
|
1166 | source file F</src/optinc.h> to see the actual list: |
|
|
1167 | |
|
|
1168 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
|
|
1169 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
|
|
1170 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
|
|
1171 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
|
|
1172 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
|
|
1173 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
|
|
1174 | urgentOnBell utmpInhibit visualBell |
359 | |
1175 | |
360 | =item $value = $term->resource ($name[, $newval]) |
1176 | =item $value = $term->resource ($name[, $newval]) |
361 | |
1177 | |
362 | Returns the current resource value associated with a given name and |
1178 | Returns the current resource value associated with a given name and |
363 | optionally sets a new value. Setting values is most useful in the C<init> |
1179 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
372 | likely change). |
1188 | likely change). |
373 | |
1189 | |
374 | Please note that resource strings will currently only be freed when the |
1190 | Please note that resource strings will currently only be freed when the |
375 | terminal is destroyed, so changing options frequently will eat memory. |
1191 | terminal is destroyed, so changing options frequently will eat memory. |
376 | |
1192 | |
377 | Here is a a likely non-exhaustive list of resource names, not all of which |
1193 | Here is a likely non-exhaustive list of resource names, not all of which |
378 | are supported in every build, please see the source to see the actual |
1194 | are supported in every build, please see the source file F</src/rsinc.h> |
379 | list: |
1195 | to see the actual list: |
380 | |
1196 | |
381 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1197 | answerbackstring backgroundPixmap backspace_key blurradius |
382 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1198 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
383 | display_name embed ext_bwidth fade font geometry hold iconName |
1199 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
384 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1200 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
|
|
1201 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
385 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1202 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
386 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
1203 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
387 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1204 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
388 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1205 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
389 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1206 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
390 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1207 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
391 | shade term_name title transparent transparent_all tripleclickwords |
1208 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
|
|
1209 | term_name title transient_for transparent tripleclickwords urgentOnBell |
392 | utmpInhibit visualBell |
1210 | utmpInhibit visualBell |
393 | |
1211 | |
394 | =cut |
1212 | =cut |
395 | |
1213 | |
396 | sub urxvt::term::resource($$;$) { |
1214 | sub resource($$;$) { |
397 | my ($self, $name) = (shift, shift); |
1215 | my ($self, $name) = (shift, shift); |
398 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1216 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
399 | goto &urxvt::term::_resource; |
1217 | goto &urxvt::term::_resource |
400 | } |
1218 | } |
|
|
1219 | |
|
|
1220 | =item $value = $term->x_resource ($pattern) |
|
|
1221 | |
|
|
1222 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
1223 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
|
|
1224 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
|
|
1225 | resource with that pattern exists. |
|
|
1226 | |
|
|
1227 | Extensions that define extra resource or command line arguments also need |
|
|
1228 | to call this method to access their values. |
|
|
1229 | |
|
|
1230 | If the method is called on an extension object (basically, from an |
|
|
1231 | extension), then the special prefix C<%.> will be replaced by the name of |
|
|
1232 | the extension and a dot, and the lone string C<%> will be replaced by the |
|
|
1233 | extension name itself. This makes it possible to code extensions so you |
|
|
1234 | can rename them and get a new set of commandline switches and resources |
|
|
1235 | without having to change the actual code. |
|
|
1236 | |
|
|
1237 | This method should only be called during the C<on_start> hook, as there is |
|
|
1238 | only one resource database per display, and later invocations might return |
|
|
1239 | the wrong resources. |
|
|
1240 | |
|
|
1241 | =item $value = $term->x_resource_boolean ($pattern) |
|
|
1242 | |
|
|
1243 | Like C<x_resource>, above, but interprets the string value as a boolean |
|
|
1244 | and returns C<1> for true values, C<0> for false values and C<undef> if |
|
|
1245 | the resource or option isn't specified. |
|
|
1246 | |
|
|
1247 | You should always use this method to parse boolean resources. |
|
|
1248 | |
|
|
1249 | =cut |
|
|
1250 | |
|
|
1251 | sub x_resource_boolean { |
|
|
1252 | my $res = &x_resource; |
|
|
1253 | |
|
|
1254 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
|
|
1255 | } |
|
|
1256 | |
|
|
1257 | =item $success = $term->parse_keysym ($key, $octets) |
|
|
1258 | |
|
|
1259 | Adds a key binding exactly as specified via a resource. See the |
|
|
1260 | C<keysym> resource in the urxvt(1) manpage. |
|
|
1261 | |
|
|
1262 | =item $term->register_command ($keysym, $modifiermask, $string) |
|
|
1263 | |
|
|
1264 | Adds a key binding. This is a lower level api compared to |
|
|
1265 | C<parse_keysym>, as it expects a parsed key description, and can be |
|
|
1266 | used only inside either the C<on_init> hook, to add a binding, or the |
|
|
1267 | C<on_register_command> hook, to modify a parsed binding. |
|
|
1268 | |
|
|
1269 | =item $rend = $term->rstyle ([$new_rstyle]) |
|
|
1270 | |
|
|
1271 | Return and optionally change the current rendition. Text that is output by |
|
|
1272 | the terminal application will use this style. |
|
|
1273 | |
|
|
1274 | =item ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
1275 | |
|
|
1276 | Return the current coordinates of the text cursor position and optionally |
|
|
1277 | set it (which is usually bad as applications don't expect that). |
401 | |
1278 | |
402 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
1279 | =item ($row, $col) = $term->selection_mark ([$row, $col]) |
403 | |
1280 | |
404 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1281 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
405 | |
1282 | |
406 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1283 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
407 | |
1284 | |
408 | Return the current values of the selection mark, begin or end positions, |
1285 | Return the current values of the selection mark, begin or end positions. |
409 | and optionally set them to new values. |
|
|
410 | |
1286 | |
|
|
1287 | When arguments are given, then the selection coordinates are set to |
|
|
1288 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1289 | screen. |
|
|
1290 | |
|
|
1291 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1292 | |
|
|
1293 | Returns the current selection screen, and then optionally sets it. |
|
|
1294 | |
|
|
1295 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
1296 | |
|
|
1297 | Tries to make a selection as set by C<selection_beg> and |
|
|
1298 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
1299 | rectangular selection will be made. This is the preferred function to make |
|
|
1300 | a selection. |
|
|
1301 | |
411 | =item $success = $term->selection_grab ($eventtime) |
1302 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
412 | |
1303 | |
413 | Try to request the primary selection from the server (for example, as set |
1304 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
414 | by the next method). |
1305 | true) selection from the server. The corresponding text can be set |
|
|
1306 | with the next method. No visual feedback will be given. This function |
|
|
1307 | is mostly useful from within C<on_sel_grab> hooks. |
415 | |
1308 | |
416 | =item $oldtext = $term->selection ([$newtext]) |
1309 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
417 | |
1310 | |
418 | Return the current selection text and optionally replace it by C<$newtext>. |
1311 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1312 | and optionally replace it by C<$newtext>. |
419 | |
1313 | |
|
|
1314 | =item $term->selection_clear ([$clipboard]) |
|
|
1315 | |
|
|
1316 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
|
|
1317 | |
420 | =item $term->scr_overlay ($x, $y, $text) |
1318 | =item $term->overlay_simple ($x, $y, $text) |
421 | |
1319 | |
422 | Create a simple multi-line overlay box. See the next method for details. |
1320 | Create a simple multi-line overlay box. See the next method for details. |
423 | |
1321 | |
424 | =cut |
1322 | =cut |
425 | |
1323 | |
426 | sub urxvt::term::scr_overlay { |
1324 | sub overlay_simple { |
427 | my ($self, $x, $y, $text) = @_; |
1325 | my ($self, $x, $y, $text) = @_; |
428 | |
1326 | |
429 | my @lines = split /\n/, $text; |
1327 | my @lines = split /\n/, $text; |
430 | |
1328 | |
431 | my $w = 0; |
1329 | my $w = List::Util::max map $self->strwidth ($_), @lines; |
432 | for (map $self->strwidth ($_), @lines) { |
|
|
433 | $w = $_ if $w < $_; |
|
|
434 | } |
|
|
435 | |
1330 | |
436 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
1331 | my $overlay = $self->overlay ($x, $y, $w, scalar @lines); |
437 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
1332 | $overlay->set (0, $_, $lines[$_]) for 0.. $#lines; |
438 | } |
|
|
439 | |
1333 | |
|
|
1334 | $overlay |
|
|
1335 | } |
|
|
1336 | |
440 | =item $term->scr_overlay_new ($x, $y, $width, $height) |
1337 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
441 | |
1338 | |
442 | Create a new (empty) overlay at the given position with the given |
1339 | Create a new (empty) overlay at the given position with the given |
443 | width/height. A border will be put around the box. If either C<$x> or |
1340 | width/height. C<$rstyle> defines the initial rendition style |
444 | C<$y> is negative, then this is counted from the right/bottom side, |
1341 | (default: C<OVERLAY_RSTYLE>). |
445 | respectively. |
|
|
446 | |
1342 | |
447 | =item $term->scr_overlay_off |
1343 | If C<$border> is C<2> (default), then a decorative border will be put |
|
|
1344 | around the box. |
448 | |
1345 | |
449 | Switch the overlay off again. |
1346 | If either C<$x> or C<$y> is negative, then this is counted from the |
|
|
1347 | right/bottom side, respectively. |
450 | |
1348 | |
451 | =item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) |
1349 | This method returns an urxvt::overlay object. The overlay will be visible |
|
|
1350 | as long as the perl object is referenced. |
452 | |
1351 | |
453 | Put a single character (specified numerically) at the given overlay |
1352 | The methods currently supported on C<urxvt::overlay> objects are: |
454 | position. |
|
|
455 | |
1353 | |
|
|
1354 | =over 4 |
|
|
1355 | |
456 | =item $term->scr_overlay_set ($x, $y, $text) |
1356 | =item $overlay->set ($x, $y, $text[, $rend]) |
457 | |
1357 | |
458 | Write a string at the given position into the overlay. |
1358 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
|
|
1359 | text in rxvt-unicode's special encoding and an array of rendition values |
|
|
1360 | at a specific position inside the overlay. |
459 | |
1361 | |
|
|
1362 | If C<$rend> is missing, then the rendition will not be changed. |
|
|
1363 | |
|
|
1364 | =item $overlay->hide |
|
|
1365 | |
|
|
1366 | If visible, hide the overlay, but do not destroy it. |
|
|
1367 | |
|
|
1368 | =item $overlay->show |
|
|
1369 | |
|
|
1370 | If hidden, display the overlay again. |
|
|
1371 | |
|
|
1372 | =back |
|
|
1373 | |
|
|
1374 | =item $popup = $term->popup ($event) |
|
|
1375 | |
|
|
1376 | Creates a new C<urxvt::popup> object that implements a popup menu. The |
|
|
1377 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
|
|
1378 | currently). |
|
|
1379 | |
|
|
1380 | =cut |
|
|
1381 | |
|
|
1382 | sub popup { |
|
|
1383 | my ($self, $event) = @_; |
|
|
1384 | |
|
|
1385 | $self->grab ($event->{time}, 1) |
|
|
1386 | or return; |
|
|
1387 | |
|
|
1388 | my $popup = bless { |
|
|
1389 | term => $self, |
|
|
1390 | event => $event, |
|
|
1391 | }, urxvt::popup::; |
|
|
1392 | |
|
|
1393 | Scalar::Util::weaken $popup->{term}; |
|
|
1394 | |
|
|
1395 | $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy }; |
|
|
1396 | Scalar::Util::weaken $self->{_destroy}{$popup}; |
|
|
1397 | |
|
|
1398 | $popup |
|
|
1399 | } |
|
|
1400 | |
460 | =item $cellwidth = $term->strwidth $string |
1401 | =item $cellwidth = $term->strwidth ($string) |
461 | |
1402 | |
462 | Returns the number of screen-cells this string would need. Correctly |
1403 | Returns the number of screen-cells this string would need. Correctly |
463 | accounts for wide and combining characters. |
1404 | accounts for wide and combining characters. |
464 | |
1405 | |
465 | =item $octets = $term->locale_encode $string |
1406 | =item $octets = $term->locale_encode ($string) |
466 | |
1407 | |
467 | Convert the given text string into the corresponding locale encoding. |
1408 | Convert the given text string into the corresponding locale encoding. |
468 | |
1409 | |
469 | =item $string = $term->locale_decode $octets |
1410 | =item $string = $term->locale_decode ($octets) |
470 | |
1411 | |
471 | Convert the given locale-encoded octets into a perl string. |
1412 | Convert the given locale-encoded octets into a perl string. |
472 | |
1413 | |
|
|
1414 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
|
|
1415 | |
|
|
1416 | XORs the rendition values in the given span with the provided value |
|
|
1417 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
|
|
1418 | refresh hooks to provide effects similar to the selection. |
|
|
1419 | |
|
|
1420 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
|
|
1421 | |
|
|
1422 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
|
|
1423 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
|
|
1424 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
|
|
1425 | it instead. Both styles I<MUST NOT> contain font styles. |
|
|
1426 | |
|
|
1427 | =item $term->scr_bell |
|
|
1428 | |
|
|
1429 | Ring the bell! |
|
|
1430 | |
|
|
1431 | =item $term->scr_add_lines ($string) |
|
|
1432 | |
|
|
1433 | Write the given text string to the screen, as if output by the application |
|
|
1434 | running inside the terminal. It may not contain command sequences (escape |
|
|
1435 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
1436 | string is a normal text string, not in locale-dependent encoding. |
|
|
1437 | |
|
|
1438 | Normally its not a good idea to use this function, as programs might be |
|
|
1439 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
1440 | C<on_add_lines> hook, though. |
|
|
1441 | |
|
|
1442 | =item $term->scr_change_screen ($screen) |
|
|
1443 | |
|
|
1444 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1445 | |
|
|
1446 | =item $term->cmd_parse ($octets) |
|
|
1447 | |
|
|
1448 | Similar to C<scr_add_lines>, but the argument must be in the |
|
|
1449 | locale-specific encoding of the terminal and can contain command sequences |
|
|
1450 | (escape codes) that will be interpreted. |
|
|
1451 | |
473 | =item $term->tt_write ($octets) |
1452 | =item $term->tt_write ($octets) |
474 | |
1453 | |
475 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1454 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
476 | pass characters instead of octets, you should convert your strings first |
1455 | pass characters instead of octets, you should convert your strings first |
477 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1456 | to the locale-specific encoding using C<< $term->locale_encode >>. |
478 | |
1457 | |
|
|
1458 | =item $term->tt_paste ($octets) |
|
|
1459 | |
|
|
1460 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1461 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1462 | is set. |
|
|
1463 | |
|
|
1464 | =item $old_events = $term->pty_ev_events ([$new_events]) |
|
|
1465 | |
|
|
1466 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
1467 | be used to suppress input and output handling to the pty/tty. See the |
|
|
1468 | description of C<< urxvt::timer->events >>. Make sure to always restore |
|
|
1469 | the previous value. |
|
|
1470 | |
|
|
1471 | =item $fd = $term->pty_fd |
|
|
1472 | |
|
|
1473 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1474 | is used. |
|
|
1475 | |
|
|
1476 | =item $windowid = $term->parent |
|
|
1477 | |
|
|
1478 | Return the window id of the toplevel window. |
|
|
1479 | |
|
|
1480 | =item $windowid = $term->vt |
|
|
1481 | |
|
|
1482 | Return the window id of the terminal window. |
|
|
1483 | |
|
|
1484 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1485 | |
|
|
1486 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1487 | to receive pointer events all the times: |
|
|
1488 | |
|
|
1489 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1490 | |
|
|
1491 | =item $term->set_urgency ($set) |
|
|
1492 | |
|
|
1493 | Enable/disable the urgency hint on the toplevel window. |
|
|
1494 | |
|
|
1495 | =item $term->focus_in |
|
|
1496 | |
|
|
1497 | =item $term->focus_out |
|
|
1498 | |
|
|
1499 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1500 | |
|
|
1501 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1502 | |
|
|
1503 | Deliver various fake events to to terminal. |
|
|
1504 | |
|
|
1505 | =item $window_width = $term->width |
|
|
1506 | |
|
|
1507 | =item $window_height = $term->height |
|
|
1508 | |
|
|
1509 | =item $font_width = $term->fwidth |
|
|
1510 | |
|
|
1511 | =item $font_height = $term->fheight |
|
|
1512 | |
|
|
1513 | =item $font_ascent = $term->fbase |
|
|
1514 | |
479 | =item $nrow = $term->nrow |
1515 | =item $terminal_rows = $term->nrow |
480 | |
1516 | |
481 | =item $ncol = $term->ncol |
1517 | =item $terminal_columns = $term->ncol |
482 | |
1518 | |
483 | Return the number of rows/columns of the terminal window (i.e. as |
1519 | =item $has_focus = $term->focus |
484 | specified by C<-geometry>, excluding any scrollback). |
|
|
485 | |
1520 | |
|
|
1521 | =item $is_mapped = $term->mapped |
|
|
1522 | |
|
|
1523 | =item $max_scrollback = $term->saveLines |
|
|
1524 | |
|
|
1525 | =item $nrow_plus_saveLines = $term->total_rows |
|
|
1526 | |
|
|
1527 | =item $topmost_scrollback_row = $term->top_row |
|
|
1528 | |
|
|
1529 | Return various integers describing terminal characteristics. |
|
|
1530 | |
|
|
1531 | =item $x_display = $term->display_id |
|
|
1532 | |
|
|
1533 | Return the DISPLAY used by rxvt-unicode. |
|
|
1534 | |
|
|
1535 | =item $lc_ctype = $term->locale |
|
|
1536 | |
|
|
1537 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
1538 | |
486 | =item $nsaved = $term->nsaved |
1539 | =item $env = $term->env |
487 | |
1540 | |
488 | Returns the number of lines in the scrollback buffer. |
1541 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1542 | similar to C<\%ENV>. |
|
|
1543 | |
|
|
1544 | =item @envv = $term->envv |
|
|
1545 | |
|
|
1546 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1547 | |
|
|
1548 | =item @argv = $term->argv |
|
|
1549 | |
|
|
1550 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1551 | includes the program name as first element. |
|
|
1552 | |
|
|
1553 | =cut |
|
|
1554 | |
|
|
1555 | sub env { |
|
|
1556 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
|
|
1557 | } |
|
|
1558 | |
|
|
1559 | =item $modifiermask = $term->ModLevel3Mask |
|
|
1560 | |
|
|
1561 | =item $modifiermask = $term->ModMetaMask |
|
|
1562 | |
|
|
1563 | =item $modifiermask = $term->ModNumLockMask |
|
|
1564 | |
|
|
1565 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
|
|
1566 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1567 | |
|
|
1568 | =item $screen = $term->current_screen |
|
|
1569 | |
|
|
1570 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1571 | |
|
|
1572 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1573 | |
|
|
1574 | Returns whether the cursor is currently hidden or not. |
489 | |
1575 | |
490 | =item $view_start = $term->view_start ([$newvalue]) |
1576 | =item $view_start = $term->view_start ([$newvalue]) |
491 | |
1577 | |
492 | Returns the negative row number of the topmost line. Minimum value is |
1578 | Returns the row number of the topmost displayed line. Maximum value is |
493 | C<0>, which displays the normal terminal contents. Larger values scroll |
1579 | C<0>, which displays the normal terminal contents. Lower values scroll |
494 | this many lines into the scrollback buffer. |
1580 | this many lines into the scrollback buffer. |
495 | |
1581 | |
496 | =item $term->want_refresh |
1582 | =item $term->want_refresh |
497 | |
1583 | |
498 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1584 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
501 | |
1587 | |
502 | Used after changing terminal contents to display them. |
1588 | Used after changing terminal contents to display them. |
503 | |
1589 | |
504 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1590 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
505 | |
1591 | |
506 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1592 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
507 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1593 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
508 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
1594 | terminal line. Nothing will be returned if a nonexistent line |
509 | line C<< -$term->nsaved >>. |
1595 | is requested. |
510 | |
1596 | |
511 | If C<$new_text> is specified, it will replace characters in the current |
1597 | If C<$new_text> is specified, it will replace characters in the current |
512 | line, starting at column C<$start_col> (default C<0>), which is useful |
1598 | line, starting at column C<$start_col> (default C<0>), which is useful |
513 | to replace only parts of a line. The font index in the rendition will |
1599 | to replace only parts of a line. The font index in the rendition will |
514 | automatically be updated. |
1600 | automatically be updated. |
515 | |
1601 | |
516 | C<$text> is in a special encoding: tabs and wide characters that use more |
1602 | C<$text> is in a special encoding: tabs and wide characters that use more |
517 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1603 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
518 | (C<chr 65535>). Characters with combining characters and other characters |
1604 | characters. Characters with combining characters and other characters that |
519 | that do not fit into the normal tetx encoding will be replaced with |
1605 | do not fit into the normal text encoding will be replaced with characters |
520 | characters in the private use area. |
1606 | in the private use area. |
521 | |
1607 | |
522 | You have to obey this encoding when changing text. The advantage is |
1608 | You have to obey this encoding when changing text. The advantage is |
523 | that C<substr> and similar functions work on screen cells and not on |
1609 | that C<substr> and similar functions work on screen cells and not on |
524 | characters. |
1610 | characters. |
525 | |
1611 | |
… | |
… | |
536 | |
1622 | |
537 | See the section on RENDITION, above. |
1623 | See the section on RENDITION, above. |
538 | |
1624 | |
539 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
1625 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
540 | |
1626 | |
541 | Returns the number of screen cells that are in use ("the line length"). If |
1627 | Returns the number of screen cells that are in use ("the line |
542 | it is C<-1>, then the line is part of a multiple-row logical "line", which |
1628 | length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the |
543 | means all characters are in use and it is continued on the next row. |
1629 | line is joined with the following one. |
|
|
1630 | |
|
|
1631 | =item $bool = $term->is_longer ($row_number) |
|
|
1632 | |
|
|
1633 | Returns true if the row is part of a multiple-row logical "line" (i.e. |
|
|
1634 | joined with the following row), which means all characters are in use |
|
|
1635 | and it is continued on the next row (and possibly a continuation of the |
|
|
1636 | previous row(s)). |
|
|
1637 | |
|
|
1638 | =item $line = $term->line ($row_number) |
|
|
1639 | |
|
|
1640 | Create and return a new C<urxvt::line> object that stores information |
|
|
1641 | about the logical line that row C<$row_number> is part of. It supports the |
|
|
1642 | following methods: |
|
|
1643 | |
|
|
1644 | =over 4 |
|
|
1645 | |
|
|
1646 | =item $text = $line->t ([$new_text]) |
|
|
1647 | |
|
|
1648 | Returns or replaces the full text of the line, similar to C<ROW_t> |
|
|
1649 | |
|
|
1650 | =item $rend = $line->r ([$new_rend]) |
|
|
1651 | |
|
|
1652 | Returns or replaces the full rendition array of the line, similar to C<ROW_r> |
|
|
1653 | |
|
|
1654 | =item $length = $line->l |
|
|
1655 | |
|
|
1656 | Returns the length of the line in cells, similar to C<ROW_l>. |
|
|
1657 | |
|
|
1658 | =item $rownum = $line->beg |
|
|
1659 | |
|
|
1660 | =item $rownum = $line->end |
|
|
1661 | |
|
|
1662 | Return the row number of the first/last row of the line, respectively. |
|
|
1663 | |
|
|
1664 | =item $offset = $line->offset_of ($row, $col) |
|
|
1665 | |
|
|
1666 | Returns the character offset of the given row|col pair within the logical |
|
|
1667 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1668 | offsets outside the string. |
|
|
1669 | |
|
|
1670 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
1671 | |
|
|
1672 | Translates a string offset into terminal coordinates again. |
|
|
1673 | |
|
|
1674 | =back |
|
|
1675 | |
|
|
1676 | =cut |
|
|
1677 | |
|
|
1678 | sub line { |
|
|
1679 | my ($self, $row) = @_; |
|
|
1680 | |
|
|
1681 | my $maxrow = $self->nrow - 1; |
|
|
1682 | |
|
|
1683 | my ($beg, $end) = ($row, $row); |
|
|
1684 | |
|
|
1685 | --$beg while $self->ROW_is_longer ($beg - 1); |
|
|
1686 | ++$end while $self->ROW_is_longer ($end) && $end < $maxrow; |
|
|
1687 | |
|
|
1688 | bless { |
|
|
1689 | term => $self, |
|
|
1690 | beg => $beg, |
|
|
1691 | end => $end, |
|
|
1692 | ncol => $self->ncol, |
|
|
1693 | len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), |
|
|
1694 | }, urxvt::line:: |
|
|
1695 | } |
|
|
1696 | |
|
|
1697 | sub urxvt::line::t { |
|
|
1698 | my ($self) = @_; |
|
|
1699 | |
|
|
1700 | if (@_ > 1) { |
|
|
1701 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
1702 | for $self->{beg} .. $self->{end}; |
|
|
1703 | } |
|
|
1704 | |
|
|
1705 | defined wantarray && |
|
|
1706 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
|
|
1707 | 0, $self->{len} |
|
|
1708 | } |
|
|
1709 | |
|
|
1710 | sub urxvt::line::r { |
|
|
1711 | my ($self) = @_; |
|
|
1712 | |
|
|
1713 | if (@_ > 1) { |
|
|
1714 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
|
|
1715 | for $self->{beg} .. $self->{end}; |
|
|
1716 | } |
|
|
1717 | |
|
|
1718 | if (defined wantarray) { |
|
|
1719 | my $rend = [ |
|
|
1720 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
|
|
1721 | ]; |
|
|
1722 | $#$rend = $self->{len} - 1; |
|
|
1723 | return $rend; |
|
|
1724 | } |
|
|
1725 | |
|
|
1726 | () |
|
|
1727 | } |
|
|
1728 | |
|
|
1729 | sub urxvt::line::beg { $_[0]{beg} } |
|
|
1730 | sub urxvt::line::end { $_[0]{end} } |
|
|
1731 | sub urxvt::line::l { $_[0]{len} } |
|
|
1732 | |
|
|
1733 | sub urxvt::line::offset_of { |
|
|
1734 | my ($self, $row, $col) = @_; |
|
|
1735 | |
|
|
1736 | ($row - $self->{beg}) * $self->{ncol} + $col |
|
|
1737 | } |
|
|
1738 | |
|
|
1739 | sub urxvt::line::coord_of { |
|
|
1740 | my ($self, $offset) = @_; |
|
|
1741 | |
|
|
1742 | use integer; |
|
|
1743 | |
|
|
1744 | ( |
|
|
1745 | $offset / $self->{ncol} + $self->{beg}, |
|
|
1746 | $offset % $self->{ncol} |
|
|
1747 | ) |
|
|
1748 | } |
544 | |
1749 | |
545 | =item $text = $term->special_encode $string |
1750 | =item $text = $term->special_encode $string |
546 | |
1751 | |
547 | Converts a perl string into the special encoding used by rxvt-unicode, |
1752 | Converts a perl string into the special encoding used by rxvt-unicode, |
548 | where one character corresponds to one screen cell. See |
1753 | where one character corresponds to one screen cell. See |
549 | C<< $term->ROW_t >> for details. |
1754 | C<< $term->ROW_t >> for details. |
550 | |
1755 | |
551 | =item $string = $term->special_decode $text |
1756 | =item $string = $term->special_decode $text |
552 | |
1757 | |
553 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1758 | Converts rxvt-unicodes text representation into a perl string. See |
554 | C<< $term->ROW_t >> for details. |
1759 | C<< $term->ROW_t >> for details. |
555 | |
1760 | |
|
|
1761 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1762 | |
|
|
1763 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1764 | |
|
|
1765 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1766 | manpage. |
|
|
1767 | |
|
|
1768 | =item $success = $term->grab ($eventtime[, $sync]) |
|
|
1769 | |
|
|
1770 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1771 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
|
|
1772 | |
|
|
1773 | =item $term->allow_events_async |
|
|
1774 | |
|
|
1775 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1776 | |
|
|
1777 | =item $term->allow_events_sync |
|
|
1778 | |
|
|
1779 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1780 | |
|
|
1781 | =item $term->allow_events_replay |
|
|
1782 | |
|
|
1783 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1784 | recent grab. |
|
|
1785 | |
|
|
1786 | =item $term->ungrab |
|
|
1787 | |
|
|
1788 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
|
|
1789 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1790 | the session. |
|
|
1791 | |
|
|
1792 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1793 | |
|
|
1794 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1795 | |
|
|
1796 | =item @atoms = $term->XListProperties ($window) |
|
|
1797 | |
|
|
1798 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1799 | |
|
|
1800 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
|
|
1801 | |
|
|
1802 | =item $term->XDeleteProperty ($window, $property) |
|
|
1803 | |
|
|
1804 | =item $window = $term->DefaultRootWindow |
|
|
1805 | |
|
|
1806 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1807 | |
|
|
1808 | =item $term->XMapWindow ($window) |
|
|
1809 | |
|
|
1810 | =item $term->XUnmapWindow ($window) |
|
|
1811 | |
|
|
1812 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1813 | |
|
|
1814 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1815 | |
|
|
1816 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1817 | |
|
|
1818 | =item $keysym = $term->XStringToKeysym ($string) |
|
|
1819 | |
|
|
1820 | =item $string = $term->XKeysymToString ($keysym) |
|
|
1821 | |
|
|
1822 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1823 | the source of the display, otherwise those functions map more-or-less |
|
|
1824 | directly onto the X functions of the same name. |
|
|
1825 | |
556 | =back |
1826 | =back |
|
|
1827 | |
|
|
1828 | =cut |
|
|
1829 | |
|
|
1830 | package urxvt::popup; |
|
|
1831 | |
|
|
1832 | =head2 The C<urxvt::popup> Class |
|
|
1833 | |
|
|
1834 | =over 4 |
|
|
1835 | |
|
|
1836 | =cut |
|
|
1837 | |
|
|
1838 | sub add_item { |
|
|
1839 | my ($self, $item) = @_; |
|
|
1840 | |
|
|
1841 | $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal}; |
|
|
1842 | $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover}; |
|
|
1843 | $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active}; |
|
|
1844 | |
|
|
1845 | $item->{render} ||= sub { $_[0]{text} }; |
|
|
1846 | |
|
|
1847 | push @{ $self->{item} }, $item; |
|
|
1848 | } |
|
|
1849 | |
|
|
1850 | =item $popup->add_title ($title) |
|
|
1851 | |
|
|
1852 | Adds a non-clickable title to the popup. |
|
|
1853 | |
|
|
1854 | =cut |
|
|
1855 | |
|
|
1856 | sub add_title { |
|
|
1857 | my ($self, $title) = @_; |
|
|
1858 | |
|
|
1859 | $self->add_item ({ |
|
|
1860 | rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, |
|
|
1861 | text => $title, |
|
|
1862 | activate => sub { }, |
|
|
1863 | }); |
|
|
1864 | } |
|
|
1865 | |
|
|
1866 | =item $popup->add_separator ([$sepchr]) |
|
|
1867 | |
|
|
1868 | Creates a separator, optionally using the character given as C<$sepchr>. |
|
|
1869 | |
|
|
1870 | =cut |
|
|
1871 | |
|
|
1872 | sub add_separator { |
|
|
1873 | my ($self, $sep) = @_; |
|
|
1874 | |
|
|
1875 | $sep ||= "="; |
|
|
1876 | |
|
|
1877 | $self->add_item ({ |
|
|
1878 | rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, |
|
|
1879 | text => "", |
|
|
1880 | render => sub { $sep x $self->{term}->ncol }, |
|
|
1881 | activate => sub { }, |
|
|
1882 | }); |
|
|
1883 | } |
|
|
1884 | |
|
|
1885 | =item $popup->add_button ($text, $cb) |
|
|
1886 | |
|
|
1887 | Adds a clickable button to the popup. C<$cb> is called whenever it is |
|
|
1888 | selected. |
|
|
1889 | |
|
|
1890 | =cut |
|
|
1891 | |
|
|
1892 | sub add_button { |
|
|
1893 | my ($self, $text, $cb) = @_; |
|
|
1894 | |
|
|
1895 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
|
|
1896 | } |
|
|
1897 | |
|
|
1898 | =item $popup->add_toggle ($text, $initial_value, $cb) |
|
|
1899 | |
|
|
1900 | Adds a toggle/checkbox item to the popup. The callback gets called |
|
|
1901 | whenever it gets toggled, with a boolean indicating its new value as its |
|
|
1902 | first argument. |
|
|
1903 | |
|
|
1904 | =cut |
|
|
1905 | |
|
|
1906 | sub add_toggle { |
|
|
1907 | my ($self, $text, $value, $cb) = @_; |
|
|
1908 | |
|
|
1909 | my $item; $item = { |
|
|
1910 | type => "button", |
|
|
1911 | text => " $text", |
|
|
1912 | value => $value, |
|
|
1913 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
|
|
1914 | activate => sub { $cb->($_[1]{value} = !$_[1]{value}); }, |
|
|
1915 | }; |
|
|
1916 | |
|
|
1917 | $self->add_item ($item); |
|
|
1918 | } |
|
|
1919 | |
|
|
1920 | =item $popup->show |
|
|
1921 | |
|
|
1922 | Displays the popup (which is initially hidden). |
|
|
1923 | |
|
|
1924 | =cut |
|
|
1925 | |
|
|
1926 | sub show { |
|
|
1927 | my ($self) = @_; |
|
|
1928 | |
|
|
1929 | local $urxvt::popup::self = $self; |
|
|
1930 | |
|
|
1931 | my $env = $self->{term}->env; |
|
|
1932 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
|
|
1933 | delete $env->{LC_ALL}; |
|
|
1934 | $env->{LC_CTYPE} = $self->{term}->locale; |
|
|
1935 | |
|
|
1936 | my $term = urxvt::term->new ( |
|
|
1937 | $env, "popup", |
|
|
1938 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
1939 | "-pty-fd" => -1, "-sl" => 0, |
|
|
1940 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
|
|
1941 | "--transient-for" => $self->{term}->parent, |
|
|
1942 | "-display" => $self->{term}->display_id, |
|
|
1943 | "-pe" => "urxvt-popup", |
|
|
1944 | ) or die "unable to create popup window\n"; |
|
|
1945 | |
|
|
1946 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
1947 | $term->ungrab; |
|
|
1948 | $term->destroy; |
|
|
1949 | die "unable to initialise popup window\n"; |
|
|
1950 | } |
|
|
1951 | } |
|
|
1952 | |
|
|
1953 | sub DESTROY { |
|
|
1954 | my ($self) = @_; |
|
|
1955 | |
|
|
1956 | delete $self->{term}{_destroy}{$self}; |
|
|
1957 | $self->{term}->ungrab; |
|
|
1958 | } |
|
|
1959 | |
|
|
1960 | =back |
|
|
1961 | |
|
|
1962 | =cut |
|
|
1963 | |
|
|
1964 | package urxvt::watcher; |
557 | |
1965 | |
558 | =head2 The C<urxvt::timer> Class |
1966 | =head2 The C<urxvt::timer> Class |
559 | |
1967 | |
560 | This class implements timer watchers/events. Time is represented as a |
1968 | This class implements timer watchers/events. Time is represented as a |
561 | fractional number of seconds since the epoch. Example: |
1969 | fractional number of seconds since the epoch. Example: |
562 | |
1970 | |
563 | # create a digital clock display in upper right corner |
1971 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
564 | $term->{timer} = urxvt::timer |
1972 | $term->{timer} = urxvt::timer |
565 | ->new |
1973 | ->new |
566 | ->start (urxvt::NOW) |
1974 | ->interval (1) |
567 | ->cb (sub { |
1975 | ->cb (sub { |
568 | my ($timer) = @_; |
|
|
569 | my $time = $timer->at; |
|
|
570 | $timer->start ($time + 1); |
|
|
571 | $self->scr_overlay (-1, 0, |
1976 | $term->{overlay}->set (0, 0, |
572 | POSIX::strftime "%H:%M:%S", localtime $time); |
1977 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
573 | }); |
1978 | }); |
574 | |
1979 | |
575 | =over 4 |
1980 | =over 4 |
576 | |
1981 | |
577 | =item $timer = new urxvt::timer |
1982 | =item $timer = new urxvt::timer |
578 | |
1983 | |
579 | Create a new timer object in stopped state. |
1984 | Create a new timer object in started state. It is scheduled to fire |
|
|
1985 | immediately. |
580 | |
1986 | |
581 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
1987 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
582 | |
1988 | |
583 | Set the callback to be called when the timer triggers. |
1989 | Set the callback to be called when the timer triggers. |
584 | |
1990 | |
585 | =item $tstamp = $timer->at |
|
|
586 | |
|
|
587 | Return the time this watcher will fire next. |
|
|
588 | |
|
|
589 | =item $timer = $timer->set ($tstamp) |
1991 | =item $timer = $timer->set ($tstamp[, $interval]) |
590 | |
1992 | |
591 | Set the time the event is generated to $tstamp. |
1993 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
1994 | new $interval). |
|
|
1995 | |
|
|
1996 | =item $timer = $timer->interval ($interval) |
|
|
1997 | |
|
|
1998 | By default (and when C<$interval> is C<0>), the timer will automatically |
|
|
1999 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
|
|
2000 | is automatically rescheduled at the given intervals. |
592 | |
2001 | |
593 | =item $timer = $timer->start |
2002 | =item $timer = $timer->start |
594 | |
2003 | |
595 | Start the timer. |
2004 | Start the timer. |
596 | |
2005 | |
597 | =item $timer = $timer->start ($tstamp) |
2006 | =item $timer = $timer->start ($tstamp[, $interval]) |
598 | |
2007 | |
599 | Set the event trigger time to C<$tstamp> and start the timer. |
2008 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2009 | also replaces the interval. |
|
|
2010 | |
|
|
2011 | =item $timer = $timer->after ($delay[, $interval]) |
|
|
2012 | |
|
|
2013 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
600 | |
2014 | |
601 | =item $timer = $timer->stop |
2015 | =item $timer = $timer->stop |
602 | |
2016 | |
603 | Stop the timer. |
2017 | Stop the timer. |
604 | |
2018 | |
… | |
… | |
610 | |
2024 | |
611 | $term->{socket} = ... |
2025 | $term->{socket} = ... |
612 | $term->{iow} = urxvt::iow |
2026 | $term->{iow} = urxvt::iow |
613 | ->new |
2027 | ->new |
614 | ->fd (fileno $term->{socket}) |
2028 | ->fd (fileno $term->{socket}) |
615 | ->events (1) # wait for read data |
2029 | ->events (urxvt::EV_READ) |
616 | ->start |
2030 | ->start |
617 | ->cb (sub { |
2031 | ->cb (sub { |
618 | my ($iow, $revents) = @_; |
2032 | my ($iow, $revents) = @_; |
619 | # $revents must be 1 here, no need to check |
2033 | # $revents must be 1 here, no need to check |
620 | sysread $term->{socket}, my $buf, 8192 |
2034 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
633 | Set the callback to be called when io events are triggered. C<$reventmask> |
2047 | Set the callback to be called when io events are triggered. C<$reventmask> |
634 | is a bitset as described in the C<events> method. |
2048 | is a bitset as described in the C<events> method. |
635 | |
2049 | |
636 | =item $iow = $iow->fd ($fd) |
2050 | =item $iow = $iow->fd ($fd) |
637 | |
2051 | |
638 | Set the filedescriptor (not handle) to watch. |
2052 | Set the file descriptor (not handle) to watch. |
639 | |
2053 | |
640 | =item $iow = $iow->events ($eventmask) |
2054 | =item $iow = $iow->events ($eventmask) |
641 | |
2055 | |
642 | Set the event mask to watch. Bit #0 (value C<1>) enables watching for read |
2056 | Set the event mask to watch. The only allowed values are |
643 | data, Bit #1 (value C<2>) enables watching for write data. |
2057 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
|
|
2058 | together, or C<urxvt::EV_NONE>. |
644 | |
2059 | |
645 | =item $iow = $iow->start |
2060 | =item $iow = $iow->start |
646 | |
2061 | |
647 | Start watching for requested events on the given handle. |
2062 | Start watching for requested events on the given handle. |
648 | |
2063 | |
649 | =item $iow = $iow->stop |
2064 | =item $iow = $iow->stop |
650 | |
2065 | |
651 | Stop watching for events on the given filehandle. |
2066 | Stop watching for events on the given file handle. |
|
|
2067 | |
|
|
2068 | =back |
|
|
2069 | |
|
|
2070 | =head2 The C<urxvt::iw> Class |
|
|
2071 | |
|
|
2072 | This class implements idle watchers, that get called automatically when |
|
|
2073 | the process is idle. They should return as fast as possible, after doing |
|
|
2074 | some useful work. |
|
|
2075 | |
|
|
2076 | =over 4 |
|
|
2077 | |
|
|
2078 | =item $iw = new urxvt::iw |
|
|
2079 | |
|
|
2080 | Create a new idle watcher object in stopped state. |
|
|
2081 | |
|
|
2082 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
2083 | |
|
|
2084 | Set the callback to be called when the watcher triggers. |
|
|
2085 | |
|
|
2086 | =item $timer = $timer->start |
|
|
2087 | |
|
|
2088 | Start the watcher. |
|
|
2089 | |
|
|
2090 | =item $timer = $timer->stop |
|
|
2091 | |
|
|
2092 | Stop the watcher. |
|
|
2093 | |
|
|
2094 | =back |
|
|
2095 | |
|
|
2096 | =head2 The C<urxvt::pw> Class |
|
|
2097 | |
|
|
2098 | This class implements process watchers. They create an event whenever a |
|
|
2099 | process exits, after which they stop automatically. |
|
|
2100 | |
|
|
2101 | my $pid = fork; |
|
|
2102 | ... |
|
|
2103 | $term->{pw} = urxvt::pw |
|
|
2104 | ->new |
|
|
2105 | ->start ($pid) |
|
|
2106 | ->cb (sub { |
|
|
2107 | my ($pw, $exit_status) = @_; |
|
|
2108 | ... |
|
|
2109 | }); |
|
|
2110 | |
|
|
2111 | =over 4 |
|
|
2112 | |
|
|
2113 | =item $pw = new urxvt::pw |
|
|
2114 | |
|
|
2115 | Create a new process watcher in stopped state. |
|
|
2116 | |
|
|
2117 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
2118 | |
|
|
2119 | Set the callback to be called when the timer triggers. |
|
|
2120 | |
|
|
2121 | =item $pw = $timer->start ($pid) |
|
|
2122 | |
|
|
2123 | Tells the watcher to start watching for process C<$pid>. |
|
|
2124 | |
|
|
2125 | =item $pw = $pw->stop |
|
|
2126 | |
|
|
2127 | Stop the watcher. |
652 | |
2128 | |
653 | =back |
2129 | =back |
654 | |
2130 | |
655 | =head1 ENVIRONMENT |
2131 | =head1 ENVIRONMENT |
656 | |
2132 | |
… | |
… | |
659 | This variable controls the verbosity level of the perl extension. Higher |
2135 | This variable controls the verbosity level of the perl extension. Higher |
660 | numbers indicate more verbose output. |
2136 | numbers indicate more verbose output. |
661 | |
2137 | |
662 | =over 4 |
2138 | =over 4 |
663 | |
2139 | |
664 | =item 0 - only fatal messages |
2140 | =item == 0 - fatal messages |
665 | |
2141 | |
666 | =item 3 - script loading and management |
2142 | =item >= 3 - script loading and management |
667 | |
2143 | |
668 | =item 10 - all events received |
2144 | =item >=10 - all called hooks |
|
|
2145 | |
|
|
2146 | =item >=11 - hook return values |
669 | |
2147 | |
670 | =back |
2148 | =back |
671 | |
2149 | |
672 | =head1 AUTHOR |
2150 | =head1 AUTHOR |
673 | |
2151 | |
674 | Marc Lehmann <pcg@goof.com> |
2152 | Marc Lehmann <schmorp@schmorp.de> |
675 | http://software.schmorp.de/pkg/rxvt-unicode |
2153 | http://software.schmorp.de/pkg/rxvt-unicode |
676 | |
2154 | |
677 | =cut |
2155 | =cut |
678 | |
2156 | |
679 | 1 |
2157 | 1 |
|
|
2158 | |
|
|
2159 | # vim: sw=3: |