… | |
… | |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
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 | =head1 PREPACKAGED EXTENSIONS |
32 | |
32 | |
33 | This section describes the extensiosn delivered with this version. You can |
33 | This section describes the extensions delivered with this release. You can |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
35 | |
35 | |
36 | You can activate them like this: |
36 | You can activate them like this: |
37 | |
37 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
38 | @@RXVT_NAME@@ -pe <extensionname> |
39 | |
39 | |
40 | =over 4 |
40 | =over 4 |
41 | |
41 | |
42 | =item selection (enabled by default) |
42 | =item selection (enabled by default) |
43 | |
43 | |
44 | Intelligent selection. This extension tries to be more intelligent when |
44 | (More) intelligent selection. This extension tries to be more intelligent |
45 | the user extends selections (double-click). Right now, it tries to select |
45 | when the user extends selections (double-click and further clicks). Right |
46 | urls and complete shell-quoted arguments, which is very convenient, too, |
46 | now, it tries to select words, urls and complete shell-quoted |
47 | if your F<ls> supports C<--quoting-style=shell>. |
47 | arguments, which is very convenient, too, if your F<ls> supports |
|
|
48 | C<--quoting-style=shell>. |
48 | |
49 | |
49 | It also offers the following bindable event: |
50 | A double-click usually selects the word under the cursor, further clicks |
|
|
51 | will enlarge the selection. |
|
|
52 | |
|
|
53 | The selection works by trying to match a number of regexes and displaying |
|
|
54 | them in increasing order of length. You can add your own regexes by |
|
|
55 | specifying resources of the form: |
|
|
56 | |
|
|
57 | URxvt.selection.pattern-0: perl-regex |
|
|
58 | URxvt.selection.pattern-1: perl-regex |
|
|
59 | ... |
|
|
60 | |
|
|
61 | The index number (0, 1...) must not have any holes, and each regex must |
|
|
62 | contain at least one pair of capturing parentheses, which will be used for |
|
|
63 | the match. For example, the followign adds a regex that matches everything |
|
|
64 | between two vertical bars: |
|
|
65 | |
|
|
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
67 | |
|
|
68 | You can look at the source of the selection extension to see more |
|
|
69 | interesting uses, such as parsing a line from beginning to end. |
|
|
70 | |
|
|
71 | This extension also offers the following bindable keyboard command: |
50 | |
72 | |
51 | =over 4 |
73 | =over 4 |
52 | |
74 | |
53 | =item rot13 |
75 | =item rot13 |
54 | |
76 | |
… | |
… | |
58 | |
80 | |
59 | =back |
81 | =back |
60 | |
82 | |
61 | =item option-popup (enabled by default) |
83 | =item option-popup (enabled by default) |
62 | |
84 | |
63 | Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at |
85 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
64 | runtime. |
86 | runtime. |
65 | |
87 | |
66 | =item digital-clock |
88 | =item selection-popup (enabled by default) |
67 | |
89 | |
68 | Displays a digital clock using the built-in overlay. |
90 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
91 | text into various other formats/action (such as uri unescaping, perl |
|
|
92 | evalution, web-browser starting etc.), depending on content. |
|
|
93 | |
|
|
94 | =item searchable-scrollback<hotkey> (enabled by default) |
|
|
95 | |
|
|
96 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
97 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
|
|
98 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
99 | screen. |
|
|
100 | |
|
|
101 | Inputting characters appends them to the regex and continues incremental |
|
|
102 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
|
|
103 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
|
|
104 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
105 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
106 | additionally stores the first match in the current line into the primary |
|
|
107 | selection. |
|
|
108 | |
|
|
109 | =item selection-autotransform |
|
|
110 | |
|
|
111 | This selection allows you to do automatic transforms on a selection |
|
|
112 | whenever a selection is made. |
|
|
113 | |
|
|
114 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
115 | operator) that modify C<$_> as resources: |
|
|
116 | |
|
|
117 | URxvt.selection-autotransform.0: transform |
|
|
118 | URxvt.selection-autotransform.1: transform |
|
|
119 | ... |
|
|
120 | |
|
|
121 | For example, the following will transform selections of the form |
|
|
122 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
123 | $word>: |
|
|
124 | |
|
|
125 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
126 | |
|
|
127 | And this example matches the same,but replaces it with vi-commands you can |
|
|
128 | paste directly into your (vi :) editor: |
|
|
129 | |
|
|
130 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
131 | |
|
|
132 | Of course, this can be modified to suit your needs and your editor :) |
|
|
133 | |
|
|
134 | To expand the example above to typical perl error messages ("XXX at |
|
|
135 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
136 | |
|
|
137 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
|
|
138 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
139 | |
|
|
140 | The first line tells the selection code to treat the unchanging part of |
|
|
141 | every error message as a selection pattern, and the second line transforms |
|
|
142 | the message into vi commands to load the file. |
69 | |
143 | |
70 | =item mark-urls |
144 | =item mark-urls |
71 | |
145 | |
72 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
146 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
|
|
147 | make them clickable. When middle-clicked, the program specified in the |
|
|
148 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
|
|
149 | the URL as first argument. |
73 | |
150 | |
74 | =item block-graphics-to-ascii |
151 | =item block-graphics-to-ascii |
75 | |
152 | |
76 | A not very useful example of filtering all text output to the terminal, |
153 | A not very useful example of filtering all text output to the terminal, |
77 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
154 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
78 | similar-looking ascii character. |
155 | similar-looking ascii character. |
79 | |
156 | |
|
|
157 | =item digital-clock |
|
|
158 | |
|
|
159 | Displays a digital clock using the built-in overlay. |
|
|
160 | |
80 | =item example-refresh-hooks |
161 | =item example-refresh-hooks |
81 | |
162 | |
82 | Displays a very simple digital clock in the upper right corner of the |
163 | Displays a very simple digital clock in the upper right corner of the |
83 | window. Illustrates overwriting the refresh callbacks to create your own |
164 | window. Illustrates overwriting the refresh callbacks to create your own |
84 | overlays or changes. |
165 | overlays or changes. |
85 | |
166 | |
86 | =back |
167 | =back |
|
|
168 | |
|
|
169 | =head1 API DOCUMENTATION |
87 | |
170 | |
88 | =head2 General API Considerations |
171 | =head2 General API Considerations |
89 | |
172 | |
90 | All objects (such as terminals, time watchers etc.) are typical |
173 | All objects (such as terminals, time watchers etc.) are typical |
91 | reference-to-hash objects. The hash can be used to store anything you |
174 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
104 | =over 4 |
187 | =over 4 |
105 | |
188 | |
106 | =item $text |
189 | =item $text |
107 | |
190 | |
108 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
191 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
109 | always represents one screen cell. See L<row_t> for a discussion of this format. |
192 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
110 | |
193 | |
111 | =item $string |
194 | =item $string |
112 | |
195 | |
113 | A perl text string, with an emphasis on I<text>. It can store all unicode |
196 | A perl text string, with an emphasis on I<text>. It can store all unicode |
114 | characters and is to be distinguished with text encoded in a specific |
197 | characters and is to be distinguished with text encoded in a specific |
… | |
… | |
119 | Either binary data or - more common - a text string encoded in a |
202 | Either binary data or - more common - a text string encoded in a |
120 | locale-specific way. |
203 | locale-specific way. |
121 | |
204 | |
122 | =back |
205 | =back |
123 | |
206 | |
|
|
207 | =head2 Extension Objects |
|
|
208 | |
|
|
209 | Very perl extension is a perl class. A separate perl object is created |
|
|
210 | for each terminal and each extension and passed as the first parameter to |
|
|
211 | hooks. So extensions can use their C<$self> object without having to think |
|
|
212 | about other extensions, with the exception of methods and members that |
|
|
213 | begin with an underscore character C<_>: these are reserved for internal |
|
|
214 | use. |
|
|
215 | |
|
|
216 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
|
|
217 | C<urxvt::term> class on this object. |
|
|
218 | |
|
|
219 | It has the following methods and data members: |
|
|
220 | |
|
|
221 | =over 4 |
|
|
222 | |
|
|
223 | =item $urxvt_term = $self->{term} |
|
|
224 | |
|
|
225 | Returns the C<urxvt::term> object associated with this instance of the |
|
|
226 | extension. This member I<must not> be changed in any way. |
|
|
227 | |
|
|
228 | =item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
229 | |
|
|
230 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
231 | this extension, replacing any previous hook. This is useful when you want |
|
|
232 | to overwrite time-critical hooks only temporarily. |
|
|
233 | |
|
|
234 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
235 | |
|
|
236 | Dynamically disable the given hooks. |
|
|
237 | |
|
|
238 | =back |
|
|
239 | |
124 | =head2 Hooks |
240 | =head2 Hooks |
125 | |
241 | |
126 | The following subroutines can be declared in extension files, and will be |
242 | The following subroutines can be declared in extension files, and will be |
127 | called whenever the relevant event happens. |
243 | called whenever the relevant event happens. |
128 | |
244 | |
129 | The first argument passed to them is an object private to each terminal |
245 | The first argument passed to them is an extension oject as described in |
130 | and extension package. You can call all C<urxvt::term> methods on it, but |
246 | the in the C<Extension Objects> section. |
131 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
|
|
132 | object that is shared between all packages is stored in the C<term> |
|
|
133 | member. It is, however, blessed intot he package of the extension script, |
|
|
134 | so for all practical purposes you can treat an extension script as a class. |
|
|
135 | |
247 | |
136 | All of them must return a boolean value. If it is true, then the event |
248 | B<All> of these hooks must return a boolean value. If it is true, then the |
137 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
249 | event counts as being I<consumed>, and the invocation of other hooks is |
138 | and the relevant action might not be carried out by the C++ code. |
250 | skipped, and the relevant action might not be carried out by the C++ code. |
139 | |
251 | |
140 | When in doubt, return a false value (preferably C<()>). |
252 | I<< When in doubt, return a false value (preferably C<()>). >> |
141 | |
253 | |
142 | =over 4 |
254 | =over 4 |
143 | |
255 | |
144 | =item on_init $term |
256 | =item on_init $term |
145 | |
257 | |
… | |
… | |
180 | =item on_sel_extend $term |
292 | =item on_sel_extend $term |
181 | |
293 | |
182 | Called whenever the user tries to extend the selection (e.g. with a double |
294 | Called whenever the user tries to extend the selection (e.g. with a double |
183 | click) and is either supposed to return false (normal operation), or |
295 | click) and is either supposed to return false (normal operation), or |
184 | should extend the selection itelf and return true to suppress the built-in |
296 | should extend the selection itelf and return true to suppress the built-in |
185 | processing. |
297 | processing. This can happen multiple times, as long as the callback |
|
|
298 | returns true, it will be called on every further click by the user and is |
|
|
299 | supposed to enlarge the selection more and more, if possible. |
186 | |
300 | |
187 | See the F<selection> example extension. |
301 | See the F<selection> example extension. |
188 | |
302 | |
189 | =item on_view_change $term, $offset |
303 | =item on_view_change $term, $offset |
190 | |
304 | |
… | |
… | |
199 | than the scroll back buffer or the terminal. |
313 | than the scroll back buffer or the terminal. |
200 | |
314 | |
201 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
315 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
202 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
316 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
203 | number of lines that will be in the scrollback buffer. |
317 | number of lines that will be in the scrollback buffer. |
204 | |
|
|
205 | =item on_tty_activity $term *NYI* |
|
|
206 | |
|
|
207 | Called whenever the program(s) running in the urxvt window send output. |
|
|
208 | |
318 | |
209 | =item on_osc_seq $term, $string |
319 | =item on_osc_seq $term, $string |
210 | |
320 | |
211 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
321 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
212 | operating system command) is processed. Cursor position and other state |
322 | operating system command) is processed. Cursor position and other state |
… | |
… | |
225 | can filter/change and output the text yourself by returning a true value |
335 | can filter/change and output the text yourself by returning a true value |
226 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
336 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
227 | might be very slow, however, as your hook is called for B<all> text being |
337 | might be very slow, however, as your hook is called for B<all> text being |
228 | output. |
338 | output. |
229 | |
339 | |
|
|
340 | =item on_tt_write $term, $octets |
|
|
341 | |
|
|
342 | Called whenever some data is written to the tty/pty and can be used to |
|
|
343 | suppress or filter tty input. |
|
|
344 | |
230 | =item on_line_update $term, $row |
345 | =item on_line_update $term, $row |
231 | |
346 | |
232 | Called whenever a line was updated or changed. Can be used to filter |
347 | Called whenever a line was updated or changed. Can be used to filter |
233 | screen output (e.g. underline urls or other useless stuff). Only lines |
348 | screen output (e.g. underline urls or other useless stuff). Only lines |
234 | that are being shown will be filtered, and, due to performance reasons, |
349 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
256 | |
371 | |
257 | Called whenever the user presses a key combination that has a |
372 | Called whenever the user presses a key combination that has a |
258 | C<perl:string> action bound to it (see description of the B<keysym> |
373 | C<perl:string> action bound to it (see description of the B<keysym> |
259 | resource in the @@RXVT_NAME@@(1) manpage). |
374 | resource in the @@RXVT_NAME@@(1) manpage). |
260 | |
375 | |
|
|
376 | =item on_x_event $term, $event |
|
|
377 | |
|
|
378 | Called on every X event received on the vt window (and possibly other |
|
|
379 | windows). Should only be used as a last resort. Most event structure |
|
|
380 | members are not passed. |
|
|
381 | |
261 | =item on_focus_in $term |
382 | =item on_focus_in $term |
262 | |
383 | |
263 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
384 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
264 | does focus in processing. |
385 | does focus in processing. |
265 | |
386 | |
266 | =item on_focus_out $term |
387 | =item on_focus_out $term |
267 | |
388 | |
268 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
389 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
269 | focus out processing. |
390 | focus out processing. |
270 | |
391 | |
271 | =item on_key_press $term, $event, $octets |
392 | =item on_key_press $term, $event, $keysym, $octets |
272 | |
393 | |
273 | =item on_key_release $term, $event |
394 | =item on_key_release $term, $event, $keysym |
274 | |
395 | |
275 | =item on_button_press $term, $event |
396 | =item on_button_press $term, $event |
276 | |
397 | |
277 | =item on_button_release $term, $event |
398 | =item on_button_release $term, $event |
278 | |
399 | |
… | |
… | |
294 | |
415 | |
295 | subwindow. |
416 | subwindow. |
296 | |
417 | |
297 | =back |
418 | =back |
298 | |
419 | |
|
|
420 | =cut |
|
|
421 | |
|
|
422 | package urxvt; |
|
|
423 | |
|
|
424 | use utf8; |
|
|
425 | use strict; |
|
|
426 | use Carp (); |
|
|
427 | use Scalar::Util (); |
|
|
428 | use List::Util (); |
|
|
429 | |
|
|
430 | our $VERSION = 1; |
|
|
431 | our $TERM; |
|
|
432 | our @HOOKNAME; |
|
|
433 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
|
|
434 | our %OPTION; |
|
|
435 | |
|
|
436 | our $LIBDIR; |
|
|
437 | our $RESNAME; |
|
|
438 | our $RESCLASS; |
|
|
439 | our $RXVTNAME; |
|
|
440 | |
299 | =head2 Variables in the C<urxvt> Package |
441 | =head2 Variables in the C<urxvt> Package |
300 | |
442 | |
301 | =over 4 |
443 | =over 4 |
|
|
444 | |
|
|
445 | =item $urxvt::LIBDIR |
|
|
446 | |
|
|
447 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
448 | modules and scripts are stored. |
|
|
449 | |
|
|
450 | =item $urxvt::RESCLASS, $urxvt::RESCLASS |
|
|
451 | |
|
|
452 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
453 | |
|
|
454 | =item $urxvt::RXVTNAME |
|
|
455 | |
|
|
456 | The basename of the installed binaries, usually C<urxvt>. |
302 | |
457 | |
303 | =item $urxvt::TERM |
458 | =item $urxvt::TERM |
304 | |
459 | |
305 | The current terminal. This variable stores the current C<urxvt::term> |
460 | The current terminal. This variable stores the current C<urxvt::term> |
306 | object, whenever a callback/hook is executing. |
461 | object, whenever a callback/hook is executing. |
… | |
… | |
308 | =back |
463 | =back |
309 | |
464 | |
310 | =head2 Functions in the C<urxvt> Package |
465 | =head2 Functions in the C<urxvt> Package |
311 | |
466 | |
312 | =over 4 |
467 | =over 4 |
313 | |
|
|
314 | =item $term = new urxvt [arg...] |
|
|
315 | |
|
|
316 | Creates a new terminal, very similar as if you had started it with |
|
|
317 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
318 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
319 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
320 | C<init> and C<start> hooks will be called during the call. |
|
|
321 | |
468 | |
322 | =item urxvt::fatal $errormessage |
469 | =item urxvt::fatal $errormessage |
323 | |
470 | |
324 | Fatally aborts execution with the given error message. Avoid at all |
471 | Fatally aborts execution with the given error message. Avoid at all |
325 | costs! The only time this is acceptable is when the terminal process |
472 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
332 | that calls this function. |
479 | that calls this function. |
333 | |
480 | |
334 | Using this function has the advantage that its output ends up in the |
481 | Using this function has the advantage that its output ends up in the |
335 | correct place, e.g. on stderr of the connecting urxvtc client. |
482 | correct place, e.g. on stderr of the connecting urxvtc client. |
336 | |
483 | |
|
|
484 | Messages have a size limit of 1023 bytes currently. |
|
|
485 | |
|
|
486 | =item $is_safe = urxvt::safe |
|
|
487 | |
|
|
488 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
489 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
490 | started setuid or setgid. |
|
|
491 | |
337 | =item $time = urxvt::NOW |
492 | =item $time = urxvt::NOW |
338 | |
493 | |
339 | Returns the "current time" (as per the event loop). |
494 | Returns the "current time" (as per the event loop). |
340 | |
495 | |
341 | =item urxvt::CurrentTime |
496 | =item urxvt::CurrentTime |
342 | |
497 | |
343 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
498 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
344 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
499 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
345 | Button4Mask, Button5Mask, AnyModifier |
500 | Button4Mask, Button5Mask, AnyModifier |
|
|
501 | |
|
|
502 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
503 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
504 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
505 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
506 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
507 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
508 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
509 | |
|
|
510 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
511 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
512 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
513 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
514 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
515 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
516 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
346 | |
517 | |
347 | Various constants for use in X calls and event processing. |
518 | Various constants for use in X calls and event processing. |
348 | |
519 | |
349 | =back |
520 | =back |
350 | |
521 | |
… | |
… | |
379 | |
550 | |
380 | =item $background = urxvt::GET_BASEBG $rend |
551 | =item $background = urxvt::GET_BASEBG $rend |
381 | |
552 | |
382 | Return the foreground/background colour index, respectively. |
553 | Return the foreground/background colour index, respectively. |
383 | |
554 | |
384 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
555 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
385 | |
556 | |
386 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
557 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
387 | |
558 | |
388 | Replace the foreground/background colour in the rendition mask with the |
559 | Replace the foreground/background colour in the rendition mask with the |
389 | specified one. |
560 | specified one. |
390 | |
561 | |
391 | =item $value = urxvt::GET_CUSTOM ($rend) |
562 | =item $value = urxvt::GET_CUSTOM $rend |
392 | |
563 | |
393 | Return the "custom" value: Every rendition has 5 bits for use by |
564 | Return the "custom" value: Every rendition has 5 bits for use by |
394 | extensions. They can be set and changed as you like and are initially |
565 | extensions. They can be set and changed as you like and are initially |
395 | zero. |
566 | zero. |
396 | |
567 | |
397 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
568 | =item $rend = urxvt::SET_CUSTOM $rend, $new_value |
398 | |
569 | |
399 | Change the custom value. |
570 | Change the custom value. |
400 | |
571 | |
401 | =back |
572 | =back |
402 | |
573 | |
403 | =cut |
574 | =cut |
404 | |
|
|
405 | package urxvt; |
|
|
406 | |
|
|
407 | use utf8; |
|
|
408 | use strict; |
|
|
409 | use Scalar::Util (); |
|
|
410 | use List::Util (); |
|
|
411 | |
|
|
412 | our $VERSION = 1; |
|
|
413 | our $TERM; |
|
|
414 | our @HOOKNAME; |
|
|
415 | our %OPTION; |
|
|
416 | our $LIBDIR; |
|
|
417 | |
575 | |
418 | BEGIN { |
576 | BEGIN { |
419 | urxvt->bootstrap; |
577 | urxvt->bootstrap; |
420 | |
578 | |
421 | # overwrite perl's warn |
579 | # overwrite perl's warn |
… | |
… | |
423 | my $msg = join "", @_; |
581 | my $msg = join "", @_; |
424 | $msg .= "\n" |
582 | $msg .= "\n" |
425 | unless $msg =~ /\n$/; |
583 | unless $msg =~ /\n$/; |
426 | urxvt::warn ($msg); |
584 | urxvt::warn ($msg); |
427 | }; |
585 | }; |
428 | } |
|
|
429 | |
586 | |
430 | my @hook_count; |
587 | # %ENV is the original startup environment |
|
|
588 | delete $ENV{IFS}; |
|
|
589 | delete $ENV{CDPATH}; |
|
|
590 | delete $ENV{BASH_ENV}; |
|
|
591 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
592 | } |
|
|
593 | |
431 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
594 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
432 | |
595 | |
433 | sub verbose { |
596 | sub verbose { |
434 | my ($level, $msg) = @_; |
597 | my ($level, $msg) = @_; |
435 | warn "$msg\n" if $level <= $verbosity; |
598 | warn "$msg\n" if $level <= $verbosity; |
436 | } |
599 | } |
437 | |
600 | |
438 | # find on_xxx subs in the package and register them |
|
|
439 | # as hooks |
|
|
440 | sub register_package($) { |
|
|
441 | my ($pkg) = @_; |
|
|
442 | |
|
|
443 | for my $htype (0.. $#HOOKNAME) { |
|
|
444 | my $name = $HOOKNAME[$htype]; |
|
|
445 | |
|
|
446 | my $ref = $pkg->can ("on_" . lc $name) |
|
|
447 | or next; |
|
|
448 | |
|
|
449 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
|
|
450 | $hook_count[$htype]++ |
|
|
451 | or set_should_invoke $htype, 1; |
|
|
452 | } |
|
|
453 | } |
|
|
454 | |
|
|
455 | my $extension_pkg = "extension0000"; |
601 | my $extension_pkg = "extension0000"; |
456 | my %extension_pkg; |
602 | my %extension_pkg; |
457 | |
603 | |
458 | # load a single script into its own package, once only |
604 | # load a single script into its own package, once only |
459 | sub extension_package($) { |
605 | sub extension_package($) { |
… | |
… | |
465 | verbose 3, "loading extension '$path' into package '$pkg'"; |
611 | verbose 3, "loading extension '$path' into package '$pkg'"; |
466 | |
612 | |
467 | open my $fh, "<:raw", $path |
613 | open my $fh, "<:raw", $path |
468 | or die "$path: $!"; |
614 | or die "$path: $!"; |
469 | |
615 | |
|
|
616 | my $source = untaint |
470 | my $source = "package $pkg; use strict; use utf8;\n" |
617 | "package $pkg; use strict; use utf8;\n" |
471 | . "use base urxvt::term::proxy::;\n" |
618 | . "use base urxvt::term::extension::;\n" |
472 | . "#line 1 \"$path\"\n{\n" |
619 | . "#line 1 \"$path\"\n{\n" |
473 | . (do { local $/; <$fh> }) |
620 | . (do { local $/; <$fh> }) |
474 | . "\n};\n1"; |
621 | . "\n};\n1"; |
475 | |
622 | |
476 | $source =~ /(.*)/s and $source = $1; # untaint |
623 | eval $source |
477 | |
|
|
478 | eval $source or die "$path: $@"; |
624 | or die "$path: $@"; |
479 | |
625 | |
480 | $pkg |
626 | $pkg |
481 | } |
627 | } |
482 | } |
628 | } |
483 | |
629 | |
… | |
… | |
489 | my $htype = shift; |
635 | my $htype = shift; |
490 | |
636 | |
491 | if ($htype == 0) { # INIT |
637 | if ($htype == 0) { # INIT |
492 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
638 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
493 | |
639 | |
494 | my %want_ext; |
640 | my %ext_arg; |
495 | |
641 | |
496 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
642 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
497 | if ($_ eq "default") { |
643 | if ($_ eq "default") { |
498 | $want_ext{$_}++ for qw(selection option-popup); |
644 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
499 | } elsif (/^-(.*)$/) { |
645 | } elsif (/^-(.*)$/) { |
500 | delete $want_ext{$1}; |
646 | delete $ext_arg{$1}; |
|
|
647 | } elsif (/^([^<]+)<(.*)>$/) { |
|
|
648 | push @{ $ext_arg{$1} }, $2; |
501 | } else { |
649 | } else { |
502 | $want_ext{$_}++; |
650 | $ext_arg{$_} ||= []; |
503 | } |
651 | } |
504 | } |
652 | } |
505 | |
653 | |
506 | for my $ext (keys %want_ext) { |
654 | while (my ($ext, $argv) = each %ext_arg) { |
507 | my @files = grep -f $_, map "$_/$ext", @dirs; |
655 | my @files = grep -f $_, map "$_/$ext", @dirs; |
508 | |
656 | |
509 | if (@files) { |
657 | if (@files) { |
510 | register_package extension_package $files[0]; |
658 | $TERM->register_package (extension_package $files[0], $argv); |
511 | } else { |
659 | } else { |
512 | warn "perl extension '$ext' not found in perl library search path\n"; |
660 | warn "perl extension '$ext' not found in perl library search path\n"; |
513 | } |
661 | } |
514 | } |
662 | } |
515 | |
663 | |
… | |
… | |
524 | if $verbosity >= 10; |
672 | if $verbosity >= 10; |
525 | |
673 | |
526 | keys %$cb; |
674 | keys %$cb; |
527 | |
675 | |
528 | while (my ($pkg, $cb) = each %$cb) { |
676 | while (my ($pkg, $cb) = each %$cb) { |
529 | eval { |
677 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
530 | $retval = $cb->( |
|
|
531 | $TERM->{_pkg}{$pkg} ||= do { |
|
|
532 | my $proxy = bless { }, $pkg; |
|
|
533 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
534 | $proxy |
|
|
535 | }, |
|
|
536 | @_, |
|
|
537 | ) and last; |
678 | and last; |
538 | }; |
679 | |
539 | if ($@) { |
680 | if ($@) { |
540 | $TERM->ungrab; # better to lose the grab than the session |
681 | $TERM->ungrab; # better to lose the grab than the session |
541 | warn $@; |
682 | warn $@; |
542 | } |
683 | } |
543 | } |
684 | } |
|
|
685 | |
|
|
686 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
687 | if $verbosity >= 11; |
544 | } |
688 | } |
545 | |
689 | |
546 | if ($htype == 1) { # DESTROY |
690 | if ($htype == 1) { # DESTROY |
547 | # remove hooks if unused |
|
|
548 | if (my $hook = $TERM->{_hook}) { |
|
|
549 | for my $htype (0..$#$hook) { |
|
|
550 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
551 | or set_should_invoke $htype, 0; |
|
|
552 | } |
|
|
553 | } |
|
|
554 | |
|
|
555 | # clear package objects |
691 | # clear package objects |
556 | %$_ = () for values %{ $TERM->{_pkg} }; |
692 | %$_ = () for values %{ $TERM->{_pkg} }; |
557 | |
693 | |
558 | # clear package |
694 | # clear package |
559 | %$TERM = (); |
695 | %$TERM = (); |
560 | } |
696 | } |
561 | |
697 | |
562 | $retval |
698 | $retval |
563 | } |
699 | } |
564 | |
700 | |
565 | # urxvt::term::proxy |
701 | sub exec_async(@) { |
|
|
702 | my $pid = fork; |
566 | |
703 | |
567 | sub urxvt::term::proxy::AUTOLOAD { |
704 | return |
568 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
705 | if !defined $pid or $pid; |
|
|
706 | |
|
|
707 | %ENV = %{ $TERM->env }; |
|
|
708 | |
|
|
709 | exec @_; |
|
|
710 | _exit 255; |
|
|
711 | } |
|
|
712 | |
|
|
713 | # urxvt::term::extension |
|
|
714 | |
|
|
715 | package urxvt::term::extension; |
|
|
716 | |
|
|
717 | sub enable { |
|
|
718 | my ($self, %hook) = @_; |
|
|
719 | my $pkg = $self->{_pkg}; |
|
|
720 | |
|
|
721 | while (my ($name, $cb) = each %hook) { |
|
|
722 | my $htype = $HOOKTYPE{uc $name}; |
|
|
723 | defined $htype |
|
|
724 | or Carp::croak "unsupported hook type '$name'"; |
|
|
725 | |
|
|
726 | $self->set_should_invoke ($htype, +1) |
|
|
727 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
|
|
728 | |
|
|
729 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
730 | } |
|
|
731 | } |
|
|
732 | |
|
|
733 | sub disable { |
|
|
734 | my ($self, @hook) = @_; |
|
|
735 | my $pkg = $self->{_pkg}; |
|
|
736 | |
|
|
737 | for my $name (@hook) { |
|
|
738 | my $htype = $HOOKTYPE{uc $name}; |
|
|
739 | defined $htype |
|
|
740 | or Carp::croak "unsupported hook type '$name'"; |
|
|
741 | |
|
|
742 | $self->set_should_invoke ($htype, -1) |
|
|
743 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
|
|
744 | } |
|
|
745 | } |
|
|
746 | |
|
|
747 | our $AUTOLOAD; |
|
|
748 | |
|
|
749 | sub AUTOLOAD { |
|
|
750 | $AUTOLOAD =~ /:([^:]+)$/ |
569 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
751 | or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable"; |
570 | |
752 | |
571 | eval qq{ |
753 | eval qq{ |
572 | sub $urxvt::term::proxy::AUTOLOAD { |
754 | sub $AUTOLOAD { |
573 | my \$proxy = shift; |
755 | my \$proxy = shift; |
574 | \$proxy->{term}->$1 (\@_) |
756 | \$proxy->{term}->$1 (\@_) |
575 | } |
757 | } |
576 | 1 |
758 | 1 |
577 | } or die "FATAL: unable to compile method forwarder: $@"; |
759 | } or die "FATAL: unable to compile method forwarder: $@"; |
578 | |
760 | |
579 | goto &$urxvt::term::proxy::AUTOLOAD; |
761 | goto &$AUTOLOAD; |
580 | } |
762 | } |
581 | |
763 | |
582 | sub urxvt::term::proxy::DESTROY { |
764 | sub DESTROY { |
583 | # nop |
765 | # nop |
584 | } |
766 | } |
585 | |
767 | |
586 | # urxvt::destroy_hook |
768 | # urxvt::destroy_hook |
587 | |
769 | |
… | |
… | |
597 | |
779 | |
598 | =head2 The C<urxvt::anyevent> Class |
780 | =head2 The C<urxvt::anyevent> Class |
599 | |
781 | |
600 | The sole purpose of this class is to deliver an interface to the |
782 | The sole purpose of this class is to deliver an interface to the |
601 | C<AnyEvent> module - any module using it will work inside urxvt without |
783 | C<AnyEvent> module - any module using it will work inside urxvt without |
602 | further work. The only exception is that you cannot wait on condition |
784 | further programming. The only exception is that you cannot wait on |
603 | variables, but non-blocking condvar use is ok. What this means is that you |
785 | condition variables, but non-blocking condvar use is ok. What this means |
604 | cannot use blocking APIs, but the non-blocking variant should work. |
786 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
787 | work. |
605 | |
788 | |
606 | =cut |
789 | =cut |
607 | |
790 | |
608 | our $VERSION = 1; |
791 | our $VERSION = 1; |
609 | |
792 | |
… | |
… | |
654 | ${$_[0]}++; |
837 | ${$_[0]}++; |
655 | } |
838 | } |
656 | |
839 | |
657 | sub urxvt::anyevent::condvar::wait { |
840 | sub urxvt::anyevent::condvar::wait { |
658 | unless (${$_[0]}) { |
841 | unless (${$_[0]}) { |
659 | require Carp; |
|
|
660 | Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"); |
842 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
661 | } |
843 | } |
662 | } |
844 | } |
663 | |
845 | |
664 | package urxvt::term; |
846 | package urxvt::term; |
665 | |
847 | |
666 | =head2 The C<urxvt::term> Class |
848 | =head2 The C<urxvt::term> Class |
667 | |
849 | |
668 | =over 4 |
850 | =over 4 |
669 | |
851 | |
|
|
852 | =cut |
|
|
853 | |
|
|
854 | # find on_xxx subs in the package and register them |
|
|
855 | # as hooks |
|
|
856 | sub register_package { |
|
|
857 | my ($self, $pkg, $argv) = @_; |
|
|
858 | |
|
|
859 | my $proxy = bless { |
|
|
860 | _pkg => $pkg, |
|
|
861 | argv => $argv, |
|
|
862 | }, $pkg; |
|
|
863 | Scalar::Util::weaken ($proxy->{term} = $self); |
|
|
864 | |
|
|
865 | $self->{_pkg}{$pkg} = $proxy; |
|
|
866 | |
|
|
867 | for my $name (@HOOKNAME) { |
|
|
868 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
|
|
869 | $proxy->enable ($name => $ref); |
|
|
870 | } |
|
|
871 | } |
|
|
872 | } |
|
|
873 | |
|
|
874 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
|
|
875 | |
|
|
876 | Creates a new terminal, very similar as if you had started it with system |
|
|
877 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
|
|
878 | hash which defines the environment of the new terminal. |
|
|
879 | |
|
|
880 | Croaks (and probably outputs an error message) if the new instance |
|
|
881 | couldn't be created. Returns C<undef> if the new instance didn't |
|
|
882 | initialise perl, and the terminal object otherwise. The C<init> and |
|
|
883 | C<start> hooks will be called during this call. |
|
|
884 | |
|
|
885 | =cut |
|
|
886 | |
|
|
887 | sub new { |
|
|
888 | my ($class, $env, @args) = @_; |
|
|
889 | |
|
|
890 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
|
|
891 | } |
|
|
892 | |
670 | =item $term->destroy |
893 | =item $term->destroy |
671 | |
894 | |
672 | Destroy the terminal object (close the window, free resources etc.). |
895 | Destroy the terminal object (close the window, free resources |
|
|
896 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
|
|
897 | watchers (timers, io watchers) are still active. |
673 | |
898 | |
674 | =item $isset = $term->option ($optval[, $set]) |
899 | =item $isset = $term->option ($optval[, $set]) |
675 | |
900 | |
676 | Returns true if the option specified by C<$optval> is enabled, and |
901 | Returns true if the option specified by C<$optval> is enabled, and |
677 | optionally change it. All option values are stored by name in the hash |
902 | optionally change it. All option values are stored by name in the hash |
… | |
… | |
727 | my ($self, $name) = (shift, shift); |
952 | my ($self, $name) = (shift, shift); |
728 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
953 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
729 | &urxvt::term::_resource |
954 | &urxvt::term::_resource |
730 | } |
955 | } |
731 | |
956 | |
|
|
957 | =item $value = $term->x_resource ($pattern) |
|
|
958 | |
|
|
959 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
960 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
|
|
961 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
|
|
962 | resource with that pattern exists. |
|
|
963 | |
|
|
964 | This method should only be called during the C<on_start> hook, as there is |
|
|
965 | only one resource database per display, and later invocations might return |
|
|
966 | the wrong resources. |
|
|
967 | |
|
|
968 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
|
|
969 | |
|
|
970 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
971 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
|
|
972 | |
732 | =item $rend = $term->rstyle ([$new_rstyle]) |
973 | =item $rend = $term->rstyle ([$new_rstyle]) |
733 | |
974 | |
734 | Return and optionally change the current rendition. Text that is output by |
975 | Return and optionally change the current rendition. Text that is output by |
735 | the terminal application will use this style. |
976 | the terminal application will use this style. |
736 | |
977 | |
… | |
… | |
746 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
987 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
747 | |
988 | |
748 | Return the current values of the selection mark, begin or end positions, |
989 | Return the current values of the selection mark, begin or end positions, |
749 | and optionally set them to new values. |
990 | and optionally set them to new values. |
750 | |
991 | |
|
|
992 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
993 | |
|
|
994 | Tries to make a selection as set by C<selection_beg> and |
|
|
995 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
996 | rectangular selection will be made. This is the prefered function to make |
|
|
997 | a selection. |
|
|
998 | |
751 | =item $success = $term->selection_grab ($eventtime) |
999 | =item $success = $term->selection_grab ($eventtime) |
752 | |
1000 | |
753 | Try to request the primary selection from the server (for example, as set |
1001 | Try to request the primary selection text from the server (for example, as |
754 | by the next method). |
1002 | set by the next method). No visual feedback will be given. This function |
|
|
1003 | is mostly useful from within C<on_sel_grab> hooks. |
755 | |
1004 | |
756 | =item $oldtext = $term->selection ([$newtext]) |
1005 | =item $oldtext = $term->selection ([$newtext]) |
757 | |
1006 | |
758 | Return the current selection text and optionally replace it by C<$newtext>. |
1007 | Return the current selection text and optionally replace it by C<$newtext>. |
759 | |
1008 | |
760 | #=item $term->overlay ($x, $y, $text) |
1009 | =item $term->overlay_simple ($x, $y, $text) |
761 | # |
1010 | |
762 | #Create a simple multi-line overlay box. See the next method for details. |
1011 | Create a simple multi-line overlay box. See the next method for details. |
763 | # |
1012 | |
764 | #=cut |
1013 | =cut |
765 | # |
1014 | |
766 | #sub urxvt::term::scr_overlay { |
1015 | sub overlay_simple { |
767 | # my ($self, $x, $y, $text) = @_; |
1016 | my ($self, $x, $y, $text) = @_; |
768 | # |
1017 | |
769 | # my @lines = split /\n/, $text; |
1018 | my @lines = split /\n/, $text; |
770 | # |
1019 | |
771 | # my $w = 0; |
1020 | my $w = List::Util::max map $self->strwidth ($_), @lines; |
772 | # for (map $self->strwidth ($_), @lines) { |
1021 | |
773 | # $w = $_ if $w < $_; |
|
|
774 | # } |
|
|
775 | # |
|
|
776 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
1022 | my $overlay = $self->overlay ($x, $y, $w, scalar @lines); |
777 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
1023 | $overlay->set (0, $_, $lines[$_]) for 0.. $#lines; |
778 | #} |
1024 | |
|
|
1025 | $overlay |
|
|
1026 | } |
779 | |
1027 | |
780 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
1028 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
781 | |
1029 | |
782 | Create a new (empty) overlay at the given position with the given |
1030 | Create a new (empty) overlay at the given position with the given |
783 | width/height. C<$rstyle> defines the initial rendition style |
1031 | width/height. C<$rstyle> defines the initial rendition style |
… | |
… | |
850 | |
1098 | |
851 | =item $string = $term->locale_decode ($octets) |
1099 | =item $string = $term->locale_decode ($octets) |
852 | |
1100 | |
853 | Convert the given locale-encoded octets into a perl string. |
1101 | Convert the given locale-encoded octets into a perl string. |
854 | |
1102 | |
|
|
1103 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
|
|
1104 | |
|
|
1105 | XORs the rendition values in the given span with the provided value |
|
|
1106 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
|
|
1107 | refresh hooks to provide effects similar to the selection. |
|
|
1108 | |
|
|
1109 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
|
|
1110 | |
|
|
1111 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
|
|
1112 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
|
|
1113 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
|
|
1114 | it instead. Both styles I<MUST NOT> contain font styles. |
|
|
1115 | |
|
|
1116 | =item $term->scr_bell |
|
|
1117 | |
|
|
1118 | Ring the bell! |
|
|
1119 | |
855 | =item $term->scr_add_lines ($string) |
1120 | =item $term->scr_add_lines ($string) |
856 | |
1121 | |
857 | Write the given text string to the screen, as if output by the application |
1122 | Write the given text string to the screen, as if output by the application |
858 | running inside the terminal. It may not contain command sequences (escape |
1123 | running inside the terminal. It may not contain command sequences (escape |
859 | codes), but is free to use line feeds, carriage returns and tabs. The |
1124 | codes), but is free to use line feeds, carriage returns and tabs. The |
… | |
… | |
873 | |
1138 | |
874 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1139 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
875 | pass characters instead of octets, you should convert your strings first |
1140 | pass characters instead of octets, you should convert your strings first |
876 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1141 | to the locale-specific encoding using C<< $term->locale_encode >>. |
877 | |
1142 | |
|
|
1143 | =item $old_events = $term->pty_ev_events ([$new_events]) |
|
|
1144 | |
|
|
1145 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
1146 | be used to suppress input and output handling to the pty/tty. See the |
|
|
1147 | description of C<< urxvt::timer->events >>. Make sure to always restore |
|
|
1148 | the previous value. |
|
|
1149 | |
878 | =item $windowid = $term->parent |
1150 | =item $windowid = $term->parent |
879 | |
1151 | |
880 | Return the window id of the toplevel window. |
1152 | Return the window id of the toplevel window. |
881 | |
1153 | |
882 | =item $windowid = $term->vt |
1154 | =item $windowid = $term->vt |
883 | |
1155 | |
884 | Return the window id of the terminal window. |
1156 | Return the window id of the terminal window. |
885 | |
1157 | |
|
|
1158 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1159 | |
|
|
1160 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1161 | to receive pointer events all the times: |
|
|
1162 | |
|
|
1163 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1164 | |
886 | =item $window_width = $term->width |
1165 | =item $window_width = $term->width |
887 | |
1166 | |
888 | =item $window_height = $term->height |
1167 | =item $window_height = $term->height |
889 | |
1168 | |
890 | =item $font_width = $term->fwidth |
1169 | =item $font_width = $term->fwidth |
… | |
… | |
906 | =item $nrow_plus_saveLines = $term->total_rows |
1185 | =item $nrow_plus_saveLines = $term->total_rows |
907 | |
1186 | |
908 | =item $lines_in_scrollback = $term->nsaved |
1187 | =item $lines_in_scrollback = $term->nsaved |
909 | |
1188 | |
910 | Return various integers describing terminal characteristics. |
1189 | Return various integers describing terminal characteristics. |
|
|
1190 | |
|
|
1191 | =item $x_display = $term->display_id |
|
|
1192 | |
|
|
1193 | Return the DISPLAY used by rxvt-unicode. |
|
|
1194 | |
|
|
1195 | =item $lc_ctype = $term->locale |
|
|
1196 | |
|
|
1197 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
1198 | |
|
|
1199 | =item $env = $term->env |
|
|
1200 | |
|
|
1201 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1202 | similar to C<\%ENV>. |
|
|
1203 | |
|
|
1204 | =cut |
|
|
1205 | |
|
|
1206 | sub env { |
|
|
1207 | if (my $env = $_[0]->_env) { |
|
|
1208 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
|
|
1209 | } else { |
|
|
1210 | +{ %ENV } |
|
|
1211 | } |
|
|
1212 | } |
911 | |
1213 | |
912 | =item $modifiermask = $term->ModLevel3Mask |
1214 | =item $modifiermask = $term->ModLevel3Mask |
913 | |
1215 | |
914 | =item $modifiermask = $term->ModMetaMask |
1216 | =item $modifiermask = $term->ModMetaMask |
915 | |
1217 | |
… | |
… | |
1008 | Return the row number of the first/last row of the line, respectively. |
1310 | Return the row number of the first/last row of the line, respectively. |
1009 | |
1311 | |
1010 | =item $offset = $line->offset_of ($row, $col) |
1312 | =item $offset = $line->offset_of ($row, $col) |
1011 | |
1313 | |
1012 | Returns the character offset of the given row|col pair within the logical |
1314 | Returns the character offset of the given row|col pair within the logical |
1013 | line. |
1315 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1316 | offsets outside the string. |
1014 | |
1317 | |
1015 | =item ($row, $col) = $line->coord_of ($offset) |
1318 | =item ($row, $col) = $line->coord_of ($offset) |
1016 | |
1319 | |
1017 | Translates a string offset into terminal coordinates again. |
1320 | Translates a string offset into terminal coordinates again. |
1018 | |
1321 | |
… | |
… | |
1092 | $offset / $self->{ncol} + $self->{beg}, |
1395 | $offset / $self->{ncol} + $self->{beg}, |
1093 | $offset % $self->{ncol} |
1396 | $offset % $self->{ncol} |
1094 | ) |
1397 | ) |
1095 | } |
1398 | } |
1096 | |
1399 | |
1097 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
1098 | =item $text = $term->special_encode $string |
1400 | =item $text = $term->special_encode $string |
1099 | |
1401 | |
1100 | Converts a perl string into the special encoding used by rxvt-unicode, |
1402 | Converts a perl string into the special encoding used by rxvt-unicode, |
1101 | where one character corresponds to one screen cell. See |
1403 | where one character corresponds to one screen cell. See |
1102 | C<< $term->ROW_t >> for details. |
1404 | C<< $term->ROW_t >> for details. |
… | |
… | |
1104 | =item $string = $term->special_decode $text |
1406 | =item $string = $term->special_decode $text |
1105 | |
1407 | |
1106 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1408 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1107 | C<< $term->ROW_t >> for details. |
1409 | C<< $term->ROW_t >> for details. |
1108 | |
1410 | |
|
|
1411 | =item $success = $term->grab_button ($button, $modifiermask) |
|
|
1412 | |
|
|
1413 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
1414 | |
|
|
1415 | =item $success = $term->grab ($eventtime[, $sync]) |
|
|
1416 | |
|
|
1417 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1418 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
|
|
1419 | |
|
|
1420 | =item $term->allow_events_async |
|
|
1421 | |
|
|
1422 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1423 | |
|
|
1424 | =item $term->allow_events_sync |
|
|
1425 | |
|
|
1426 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1427 | |
|
|
1428 | =item $term->allow_events_replay |
|
|
1429 | |
|
|
1430 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1431 | recent grab. |
|
|
1432 | |
|
|
1433 | =item $term->ungrab |
|
|
1434 | |
|
|
1435 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1436 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1437 | the session. |
|
|
1438 | |
1109 | =back |
1439 | =back |
1110 | |
1440 | |
1111 | =cut |
1441 | =cut |
1112 | |
1442 | |
1113 | package urxvt::popup; |
1443 | package urxvt::popup; |
… | |
… | |
1128 | $item->{render} ||= sub { $_[0]{text} }; |
1458 | $item->{render} ||= sub { $_[0]{text} }; |
1129 | |
1459 | |
1130 | push @{ $self->{item} }, $item; |
1460 | push @{ $self->{item} }, $item; |
1131 | } |
1461 | } |
1132 | |
1462 | |
1133 | sub add_separator { |
1463 | =item $popup->add_title ($title) |
1134 | my ($self, $sep) = @_; |
|
|
1135 | |
1464 | |
1136 | $sep ||= "═"; |
1465 | Adds a non-clickable title to the popup. |
1137 | |
1466 | |
1138 | $self->add_item ({ |
1467 | =cut |
1139 | rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, |
|
|
1140 | text => "", |
|
|
1141 | render => sub { $sep x $urxvt::TERM->ncol }, |
|
|
1142 | activate => sub { }, |
|
|
1143 | }); |
|
|
1144 | } |
|
|
1145 | |
1468 | |
1146 | sub add_title { |
1469 | sub add_title { |
1147 | my ($self, $title) = @_; |
1470 | my ($self, $title) = @_; |
1148 | |
1471 | |
1149 | $self->add_item ({ |
1472 | $self->add_item ({ |
… | |
… | |
1151 | text => $title, |
1474 | text => $title, |
1152 | activate => sub { }, |
1475 | activate => sub { }, |
1153 | }); |
1476 | }); |
1154 | } |
1477 | } |
1155 | |
1478 | |
|
|
1479 | =item $popup->add_separator ([$sepchr]) |
|
|
1480 | |
|
|
1481 | Creates a separator, optionally using the character given as C<$sepchr>. |
|
|
1482 | |
|
|
1483 | =cut |
|
|
1484 | |
|
|
1485 | sub add_separator { |
|
|
1486 | my ($self, $sep) = @_; |
|
|
1487 | |
|
|
1488 | $sep ||= "="; |
|
|
1489 | |
|
|
1490 | $self->add_item ({ |
|
|
1491 | rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, |
|
|
1492 | text => "", |
|
|
1493 | render => sub { $sep x $self->{term}->ncol }, |
|
|
1494 | activate => sub { }, |
|
|
1495 | }); |
|
|
1496 | } |
|
|
1497 | |
|
|
1498 | =item $popup->add_button ($text, $cb) |
|
|
1499 | |
|
|
1500 | Adds a clickable button to the popup. C<$cb> is called whenever it is |
|
|
1501 | selected. |
|
|
1502 | |
|
|
1503 | =cut |
|
|
1504 | |
1156 | sub add_button { |
1505 | sub add_button { |
1157 | my ($self, $text, $cb) = @_; |
1506 | my ($self, $text, $cb) = @_; |
1158 | |
1507 | |
1159 | $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); |
1508 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1160 | } |
1509 | } |
|
|
1510 | |
|
|
1511 | =item $popup->add_toggle ($text, $cb, $initial_value) |
|
|
1512 | |
|
|
1513 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1514 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1515 | argument. |
|
|
1516 | |
|
|
1517 | =cut |
1161 | |
1518 | |
1162 | sub add_toggle { |
1519 | sub add_toggle { |
1163 | my ($self, $text, $cb, $value) = @_; |
1520 | my ($self, $text, $cb, $value) = @_; |
1164 | |
1521 | |
1165 | my $item; $item = { |
1522 | my $item; $item = { |
1166 | type => "button", |
1523 | type => "button", |
1167 | text => " $text", |
1524 | text => " $text", |
1168 | value => $value, |
1525 | value => $value, |
1169 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1526 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1170 | activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, |
1527 | activate => sub { $cb->($_[1]{value} = !$_[1]{value}); }, |
1171 | }; |
1528 | }; |
1172 | |
1529 | |
1173 | $self->add_item ($item); |
1530 | $self->add_item ($item); |
1174 | } |
1531 | } |
|
|
1532 | |
|
|
1533 | =item $popup->show |
|
|
1534 | |
|
|
1535 | Displays the popup (which is initially hidden). |
|
|
1536 | |
|
|
1537 | =cut |
1175 | |
1538 | |
1176 | sub show { |
1539 | sub show { |
1177 | my ($self) = @_; |
1540 | my ($self) = @_; |
1178 | |
1541 | |
1179 | local $urxvt::popup::self = $self; |
1542 | local $urxvt::popup::self = $self; |
1180 | |
1543 | |
|
|
1544 | my $env = $self->{term}->env; |
|
|
1545 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
|
|
1546 | delete $env->{LC_ALL}; |
|
|
1547 | $env->{LC_CTYPE} = $self->{term}->locale; |
|
|
1548 | |
|
|
1549 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1181 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1550 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1182 | "--transient-for" => $self->{term}->parent, |
1551 | "--transient-for" => $self->{term}->parent, |
|
|
1552 | "-display" => $self->{term}->display_id, |
1183 | "-pe" => "urxvt-popup") |
1553 | "-pe" => "urxvt-popup") |
1184 | or die "unable to create popup window\n"; |
1554 | or die "unable to create popup window\n"; |
1185 | } |
1555 | } |
1186 | |
1556 | |
1187 | sub DESTROY { |
1557 | sub DESTROY { |
1188 | my ($self) = @_; |
1558 | my ($self) = @_; |
1189 | |
1559 | |
1190 | delete $self->{term}{_destroy}{$self}; |
1560 | delete $self->{term}{_destroy}{$self}; |
1191 | $self->{term}->ungrab; |
1561 | $self->{term}->ungrab; |
1192 | } |
1562 | } |
|
|
1563 | |
|
|
1564 | =back |
1193 | |
1565 | |
1194 | =head2 The C<urxvt::timer> Class |
1566 | =head2 The C<urxvt::timer> Class |
1195 | |
1567 | |
1196 | This class implements timer watchers/events. Time is represented as a |
1568 | This class implements timer watchers/events. Time is represented as a |
1197 | fractional number of seconds since the epoch. Example: |
1569 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1250 | |
1622 | |
1251 | $term->{socket} = ... |
1623 | $term->{socket} = ... |
1252 | $term->{iow} = urxvt::iow |
1624 | $term->{iow} = urxvt::iow |
1253 | ->new |
1625 | ->new |
1254 | ->fd (fileno $term->{socket}) |
1626 | ->fd (fileno $term->{socket}) |
1255 | ->events (1) # wait for read data |
1627 | ->events (urxvt::EVENT_READ) |
1256 | ->start |
1628 | ->start |
1257 | ->cb (sub { |
1629 | ->cb (sub { |
1258 | my ($iow, $revents) = @_; |
1630 | my ($iow, $revents) = @_; |
1259 | # $revents must be 1 here, no need to check |
1631 | # $revents must be 1 here, no need to check |
1260 | sysread $term->{socket}, my $buf, 8192 |
1632 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1277 | |
1649 | |
1278 | Set the filedescriptor (not handle) to watch. |
1650 | Set the filedescriptor (not handle) to watch. |
1279 | |
1651 | |
1280 | =item $iow = $iow->events ($eventmask) |
1652 | =item $iow = $iow->events ($eventmask) |
1281 | |
1653 | |
1282 | Set the event mask to watch. Bit #0 (value C<1>) enables watching for read |
1654 | Set the event mask to watch. The only allowed values are |
1283 | data, Bit #1 (value C<2>) enables watching for write data. |
1655 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
|
|
1656 | together, or C<urxvt::EVENT_NONE>. |
1284 | |
1657 | |
1285 | =item $iow = $iow->start |
1658 | =item $iow = $iow->start |
1286 | |
1659 | |
1287 | Start watching for requested events on the given handle. |
1660 | Start watching for requested events on the given handle. |
1288 | |
1661 | |
… | |
… | |
1303 | |
1676 | |
1304 | =item == 0 - fatal messages |
1677 | =item == 0 - fatal messages |
1305 | |
1678 | |
1306 | =item >= 3 - script loading and management |
1679 | =item >= 3 - script loading and management |
1307 | |
1680 | |
1308 | =item >=10 - all events received |
1681 | =item >=10 - all called hooks |
|
|
1682 | |
|
|
1683 | =item >=11 - hook reutrn values |
1309 | |
1684 | |
1310 | =back |
1685 | =back |
1311 | |
1686 | |
1312 | =head1 AUTHOR |
1687 | =head1 AUTHOR |
1313 | |
1688 | |