… | |
… | |
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 following bindable keyboard commands: |
50 | |
72 | |
51 | =over 4 |
73 | =over 4 |
52 | |
74 | |
53 | =item rot13 |
75 | =item rot13 |
54 | |
76 | |
… | |
… | |
64 | runtime. |
86 | runtime. |
65 | |
87 | |
66 | =item selection-popup (enabled by default) |
88 | =item selection-popup (enabled by default) |
67 | |
89 | |
68 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
90 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
69 | text into various other formats/action. |
91 | text into various other formats/action (such as uri unescaping, perl |
|
|
92 | evalution, web-browser starting etc.), depending on content. |
70 | |
93 | |
71 | =item digital-clock |
94 | =item searchable-scrollback<hotkey> (enabled by default) |
72 | |
95 | |
73 | Displays a digital clock using the built-in overlay. |
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. |
74 | |
143 | |
75 | =item mark-urls |
144 | =item mark-urls |
76 | |
145 | |
77 | 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. |
78 | |
150 | |
79 | =item block-graphics-to-ascii |
151 | =item block-graphics-to-ascii |
80 | |
152 | |
81 | 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, |
82 | 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 |
83 | similar-looking ascii character. |
155 | similar-looking ascii character. |
84 | |
156 | |
|
|
157 | =item digital-clock |
|
|
158 | |
|
|
159 | Displays a digital clock using the built-in overlay. |
|
|
160 | |
85 | =item example-refresh-hooks |
161 | =item example-refresh-hooks |
86 | |
162 | |
87 | 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 |
88 | window. Illustrates overwriting the refresh callbacks to create your own |
164 | window. Illustrates overwriting the refresh callbacks to create your own |
89 | overlays or changes. |
165 | overlays or changes. |
90 | |
166 | |
|
|
167 | =item selection-pastebin |
|
|
168 | |
|
|
169 | This is a little rarely useful extension that Uploads the selection as |
|
|
170 | textfile to a remote site (or does other things). (The implementation is |
|
|
171 | not currently secure for use in a multiuser environment as it writes to |
|
|
172 | F</tmp> directly.). |
|
|
173 | |
|
|
174 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
175 | i.e. |
|
|
176 | |
|
|
177 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
178 | |
|
|
179 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
180 | the textfile. This command can be set via a resource: |
|
|
181 | |
|
|
182 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
183 | |
|
|
184 | And the default is likely not useful to anybody but the few people around |
|
|
185 | here :) |
|
|
186 | |
|
|
187 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
188 | the same content should lead to the same filename. |
|
|
189 | |
|
|
190 | After a successful upload the selection will be replaced by the text given |
|
|
191 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
192 | for the filename): |
|
|
193 | |
|
|
194 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
195 | |
91 | =back |
196 | =back |
|
|
197 | |
|
|
198 | =head1 API DOCUMENTATION |
92 | |
199 | |
93 | =head2 General API Considerations |
200 | =head2 General API Considerations |
94 | |
201 | |
95 | All objects (such as terminals, time watchers etc.) are typical |
202 | All objects (such as terminals, time watchers etc.) are typical |
96 | reference-to-hash objects. The hash can be used to store anything you |
203 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
109 | =over 4 |
216 | =over 4 |
110 | |
217 | |
111 | =item $text |
218 | =item $text |
112 | |
219 | |
113 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
220 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
114 | always represents one screen cell. See L<row_t> for a discussion of this format. |
221 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
115 | |
222 | |
116 | =item $string |
223 | =item $string |
117 | |
224 | |
118 | A perl text string, with an emphasis on I<text>. It can store all unicode |
225 | A perl text string, with an emphasis on I<text>. It can store all unicode |
119 | characters and is to be distinguished with text encoded in a specific |
226 | characters and is to be distinguished with text encoded in a specific |
… | |
… | |
124 | Either binary data or - more common - a text string encoded in a |
231 | Either binary data or - more common - a text string encoded in a |
125 | locale-specific way. |
232 | locale-specific way. |
126 | |
233 | |
127 | =back |
234 | =back |
128 | |
235 | |
|
|
236 | =head2 Extension Objects |
|
|
237 | |
|
|
238 | Very perl extension is a perl class. A separate perl object is created |
|
|
239 | for each terminal and each extension and passed as the first parameter to |
|
|
240 | hooks. So extensions can use their C<$self> object without having to think |
|
|
241 | about other extensions, with the exception of methods and members that |
|
|
242 | begin with an underscore character C<_>: these are reserved for internal |
|
|
243 | use. |
|
|
244 | |
|
|
245 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
|
|
246 | C<urxvt::term> class on this object. |
|
|
247 | |
|
|
248 | It has the following methods and data members: |
|
|
249 | |
|
|
250 | =over 4 |
|
|
251 | |
|
|
252 | =item $urxvt_term = $self->{term} |
|
|
253 | |
|
|
254 | Returns the C<urxvt::term> object associated with this instance of the |
|
|
255 | extension. This member I<must not> be changed in any way. |
|
|
256 | |
|
|
257 | =item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
258 | |
|
|
259 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
260 | this extension, replacing any previous hook. This is useful when you want |
|
|
261 | to overwrite time-critical hooks only temporarily. |
|
|
262 | |
|
|
263 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
264 | |
|
|
265 | Dynamically disable the given hooks. |
|
|
266 | |
|
|
267 | =back |
|
|
268 | |
129 | =head2 Hooks |
269 | =head2 Hooks |
130 | |
270 | |
131 | The following subroutines can be declared in extension files, and will be |
271 | The following subroutines can be declared in extension files, and will be |
132 | called whenever the relevant event happens. |
272 | called whenever the relevant event happens. |
133 | |
273 | |
134 | The first argument passed to them is an object private to each terminal |
274 | The first argument passed to them is an extension oject as described in |
135 | and extension package. You can call all C<urxvt::term> methods on it, but |
275 | the in the C<Extension Objects> section. |
136 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
|
|
137 | object that is shared between all packages is stored in the C<term> |
|
|
138 | member. It is, however, blessed intot he package of the extension script, |
|
|
139 | so for all practical purposes you can treat an extension script as a class. |
|
|
140 | |
276 | |
141 | All of them must return a boolean value. If it is true, then the event |
277 | B<All> of these hooks must return a boolean value. If it is true, then the |
142 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
278 | event counts as being I<consumed>, and the invocation of other hooks is |
143 | and the relevant action might not be carried out by the C++ code. |
279 | skipped, and the relevant action might not be carried out by the C++ code. |
144 | |
280 | |
145 | When in doubt, return a false value (preferably C<()>). |
281 | I<< When in doubt, return a false value (preferably C<()>). >> |
146 | |
282 | |
147 | =over 4 |
283 | =over 4 |
148 | |
284 | |
149 | =item on_init $term |
285 | =item on_init $term |
150 | |
286 | |
… | |
… | |
185 | =item on_sel_extend $term |
321 | =item on_sel_extend $term |
186 | |
322 | |
187 | Called whenever the user tries to extend the selection (e.g. with a double |
323 | Called whenever the user tries to extend the selection (e.g. with a double |
188 | click) and is either supposed to return false (normal operation), or |
324 | click) and is either supposed to return false (normal operation), or |
189 | should extend the selection itelf and return true to suppress the built-in |
325 | should extend the selection itelf and return true to suppress the built-in |
190 | processing. |
326 | processing. This can happen multiple times, as long as the callback |
|
|
327 | returns true, it will be called on every further click by the user and is |
|
|
328 | supposed to enlarge the selection more and more, if possible. |
191 | |
329 | |
192 | See the F<selection> example extension. |
330 | See the F<selection> example extension. |
193 | |
331 | |
194 | =item on_view_change $term, $offset |
332 | =item on_view_change $term, $offset |
195 | |
333 | |
… | |
… | |
226 | can filter/change and output the text yourself by returning a true value |
364 | can filter/change and output the text yourself by returning a true value |
227 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
365 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
228 | might be very slow, however, as your hook is called for B<all> text being |
366 | might be very slow, however, as your hook is called for B<all> text being |
229 | output. |
367 | output. |
230 | |
368 | |
|
|
369 | =item on_tt_write $term, $octets |
|
|
370 | |
|
|
371 | Called whenever some data is written to the tty/pty and can be used to |
|
|
372 | suppress or filter tty input. |
|
|
373 | |
231 | =item on_line_update $term, $row |
374 | =item on_line_update $term, $row |
232 | |
375 | |
233 | Called whenever a line was updated or changed. Can be used to filter |
376 | Called whenever a line was updated or changed. Can be used to filter |
234 | screen output (e.g. underline urls or other useless stuff). Only lines |
377 | screen output (e.g. underline urls or other useless stuff). Only lines |
235 | that are being shown will be filtered, and, due to performance reasons, |
378 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
257 | |
400 | |
258 | Called whenever the user presses a key combination that has a |
401 | Called whenever the user presses a key combination that has a |
259 | C<perl:string> action bound to it (see description of the B<keysym> |
402 | C<perl:string> action bound to it (see description of the B<keysym> |
260 | resource in the @@RXVT_NAME@@(1) manpage). |
403 | resource in the @@RXVT_NAME@@(1) manpage). |
261 | |
404 | |
|
|
405 | =item on_x_event $term, $event |
|
|
406 | |
|
|
407 | Called on every X event received on the vt window (and possibly other |
|
|
408 | windows). Should only be used as a last resort. Most event structure |
|
|
409 | members are not passed. |
|
|
410 | |
262 | =item on_focus_in $term |
411 | =item on_focus_in $term |
263 | |
412 | |
264 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
413 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
265 | does focus in processing. |
414 | does focus in processing. |
266 | |
415 | |
267 | =item on_focus_out $term |
416 | =item on_focus_out $term |
268 | |
417 | |
269 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
418 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
270 | focus out processing. |
419 | focus out processing. |
271 | |
420 | |
272 | =item on_key_press $term, $event, $octets |
421 | =item on_key_press $term, $event, $keysym, $octets |
273 | |
422 | |
274 | =item on_key_release $term, $event |
423 | =item on_key_release $term, $event, $keysym |
275 | |
424 | |
276 | =item on_button_press $term, $event |
425 | =item on_button_press $term, $event |
277 | |
426 | |
278 | =item on_button_release $term, $event |
427 | =item on_button_release $term, $event |
279 | |
428 | |
… | |
… | |
295 | |
444 | |
296 | subwindow. |
445 | subwindow. |
297 | |
446 | |
298 | =back |
447 | =back |
299 | |
448 | |
|
|
449 | =cut |
|
|
450 | |
|
|
451 | package urxvt; |
|
|
452 | |
|
|
453 | use utf8; |
|
|
454 | use strict; |
|
|
455 | use Carp (); |
|
|
456 | use Scalar::Util (); |
|
|
457 | use List::Util (); |
|
|
458 | |
|
|
459 | our $VERSION = 1; |
|
|
460 | our $TERM; |
|
|
461 | our @HOOKNAME; |
|
|
462 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
|
|
463 | our %OPTION; |
|
|
464 | |
|
|
465 | our $LIBDIR; |
|
|
466 | our $RESNAME; |
|
|
467 | our $RESCLASS; |
|
|
468 | our $RXVTNAME; |
|
|
469 | |
300 | =head2 Variables in the C<urxvt> Package |
470 | =head2 Variables in the C<urxvt> Package |
301 | |
471 | |
302 | =over 4 |
472 | =over 4 |
|
|
473 | |
|
|
474 | =item $urxvt::LIBDIR |
|
|
475 | |
|
|
476 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
477 | modules and scripts are stored. |
|
|
478 | |
|
|
479 | =item $urxvt::RESCLASS, $urxvt::RESCLASS |
|
|
480 | |
|
|
481 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
482 | |
|
|
483 | =item $urxvt::RXVTNAME |
|
|
484 | |
|
|
485 | The basename of the installed binaries, usually C<urxvt>. |
303 | |
486 | |
304 | =item $urxvt::TERM |
487 | =item $urxvt::TERM |
305 | |
488 | |
306 | The current terminal. This variable stores the current C<urxvt::term> |
489 | The current terminal. This variable stores the current C<urxvt::term> |
307 | object, whenever a callback/hook is executing. |
490 | object, whenever a callback/hook is executing. |
… | |
… | |
309 | =back |
492 | =back |
310 | |
493 | |
311 | =head2 Functions in the C<urxvt> Package |
494 | =head2 Functions in the C<urxvt> Package |
312 | |
495 | |
313 | =over 4 |
496 | =over 4 |
314 | |
|
|
315 | =item $term = new urxvt [arg...] |
|
|
316 | |
|
|
317 | Creates a new terminal, very similar as if you had started it with |
|
|
318 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
319 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
320 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
321 | C<init> and C<start> hooks will be called during the call. |
|
|
322 | |
497 | |
323 | =item urxvt::fatal $errormessage |
498 | =item urxvt::fatal $errormessage |
324 | |
499 | |
325 | Fatally aborts execution with the given error message. Avoid at all |
500 | Fatally aborts execution with the given error message. Avoid at all |
326 | costs! The only time this is acceptable is when the terminal process |
501 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
333 | that calls this function. |
508 | that calls this function. |
334 | |
509 | |
335 | Using this function has the advantage that its output ends up in the |
510 | Using this function has the advantage that its output ends up in the |
336 | correct place, e.g. on stderr of the connecting urxvtc client. |
511 | correct place, e.g. on stderr of the connecting urxvtc client. |
337 | |
512 | |
338 | =item $is_safe = urxvt::safe |
513 | Messages have a size limit of 1023 bytes currently. |
339 | |
|
|
340 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
341 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
342 | started setuid or setgid. |
|
|
343 | |
514 | |
344 | =item $time = urxvt::NOW |
515 | =item $time = urxvt::NOW |
345 | |
516 | |
346 | Returns the "current time" (as per the event loop). |
517 | Returns the "current time" (as per the event loop). |
347 | |
518 | |
348 | =item urxvt::CurrentTime |
519 | =item urxvt::CurrentTime |
349 | |
520 | |
350 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
521 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
351 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
522 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
352 | Button4Mask, Button5Mask, AnyModifier |
523 | Button4Mask, Button5Mask, AnyModifier |
|
|
524 | |
|
|
525 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
526 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
527 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
528 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
529 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
530 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
531 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
532 | |
|
|
533 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
534 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
535 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
536 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
537 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
538 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
539 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
353 | |
540 | |
354 | Various constants for use in X calls and event processing. |
541 | Various constants for use in X calls and event processing. |
355 | |
542 | |
356 | =back |
543 | =back |
357 | |
544 | |
… | |
… | |
386 | |
573 | |
387 | =item $background = urxvt::GET_BASEBG $rend |
574 | =item $background = urxvt::GET_BASEBG $rend |
388 | |
575 | |
389 | Return the foreground/background colour index, respectively. |
576 | Return the foreground/background colour index, respectively. |
390 | |
577 | |
391 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
578 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
392 | |
579 | |
393 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
580 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
394 | |
581 | |
395 | Replace the foreground/background colour in the rendition mask with the |
582 | Replace the foreground/background colour in the rendition mask with the |
396 | specified one. |
583 | specified one. |
397 | |
584 | |
398 | =item $value = urxvt::GET_CUSTOM ($rend) |
585 | =item $value = urxvt::GET_CUSTOM $rend |
399 | |
586 | |
400 | Return the "custom" value: Every rendition has 5 bits for use by |
587 | Return the "custom" value: Every rendition has 5 bits for use by |
401 | extensions. They can be set and changed as you like and are initially |
588 | extensions. They can be set and changed as you like and are initially |
402 | zero. |
589 | zero. |
403 | |
590 | |
404 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
591 | =item $rend = urxvt::SET_CUSTOM $rend, $new_value |
405 | |
592 | |
406 | Change the custom value. |
593 | Change the custom value. |
407 | |
594 | |
408 | =back |
595 | =back |
409 | |
596 | |
410 | =cut |
597 | =cut |
411 | |
|
|
412 | package urxvt; |
|
|
413 | |
|
|
414 | use utf8; |
|
|
415 | use strict; |
|
|
416 | use Scalar::Util (); |
|
|
417 | use List::Util (); |
|
|
418 | |
|
|
419 | our $VERSION = 1; |
|
|
420 | our $TERM; |
|
|
421 | our @HOOKNAME; |
|
|
422 | our %OPTION; |
|
|
423 | our $LIBDIR; |
|
|
424 | |
598 | |
425 | BEGIN { |
599 | BEGIN { |
426 | urxvt->bootstrap; |
600 | urxvt->bootstrap; |
427 | |
601 | |
428 | # overwrite perl's warn |
602 | # overwrite perl's warn |
… | |
… | |
431 | $msg .= "\n" |
605 | $msg .= "\n" |
432 | unless $msg =~ /\n$/; |
606 | unless $msg =~ /\n$/; |
433 | urxvt::warn ($msg); |
607 | urxvt::warn ($msg); |
434 | }; |
608 | }; |
435 | |
609 | |
|
|
610 | # %ENV is the original startup environment |
436 | delete $ENV{IFS}; |
611 | delete $ENV{IFS}; |
437 | delete $ENV{CDPATH}; |
612 | delete $ENV{CDPATH}; |
438 | delete $ENV{BASH_ENV}; |
613 | delete $ENV{BASH_ENV}; |
439 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
614 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
440 | } |
615 | } |
441 | |
616 | |
442 | my @hook_count; |
|
|
443 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
617 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
444 | |
618 | |
445 | sub verbose { |
619 | sub verbose { |
446 | my ($level, $msg) = @_; |
620 | my ($level, $msg) = @_; |
447 | warn "$msg\n" if $level <= $verbosity; |
621 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
460 | verbose 3, "loading extension '$path' into package '$pkg'"; |
634 | verbose 3, "loading extension '$path' into package '$pkg'"; |
461 | |
635 | |
462 | open my $fh, "<:raw", $path |
636 | open my $fh, "<:raw", $path |
463 | or die "$path: $!"; |
637 | or die "$path: $!"; |
464 | |
638 | |
|
|
639 | my $source = |
465 | my $source = untaint "package $pkg; use strict; use utf8;\n" |
640 | "package $pkg; use strict; use utf8;\n" |
466 | . "use base urxvt::term::proxy::;\n" |
641 | . "use base urxvt::term::extension::;\n" |
467 | . "#line 1 \"$path\"\n{\n" |
642 | . "#line 1 \"$path\"\n{\n" |
468 | . (do { local $/; <$fh> }) |
643 | . (do { local $/; <$fh> }) |
469 | . "\n};\n1"; |
644 | . "\n};\n1"; |
470 | |
645 | |
|
|
646 | eval $source |
471 | eval $source or die "$path: $@"; |
647 | or die "$path: $@"; |
472 | |
648 | |
473 | $pkg |
649 | $pkg |
474 | } |
650 | } |
475 | } |
651 | } |
476 | |
652 | |
… | |
… | |
486 | |
662 | |
487 | my %ext_arg; |
663 | my %ext_arg; |
488 | |
664 | |
489 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
665 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
490 | if ($_ eq "default") { |
666 | if ($_ eq "default") { |
491 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup); |
667 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
492 | } elsif (/^-(.*)$/) { |
668 | } elsif (/^-(.*)$/) { |
493 | delete $ext_arg{$1}; |
669 | delete $ext_arg{$1}; |
494 | } elsif (/^([^<]+)<(.*)>$/) { |
670 | } elsif (/^([^<]+)<(.*)>$/) { |
495 | push @{ $ext_arg{$1} }, $2; |
671 | push @{ $ext_arg{$1} }, $2; |
496 | } else { |
672 | } else { |
… | |
… | |
527 | if ($@) { |
703 | if ($@) { |
528 | $TERM->ungrab; # better to lose the grab than the session |
704 | $TERM->ungrab; # better to lose the grab than the session |
529 | warn $@; |
705 | warn $@; |
530 | } |
706 | } |
531 | } |
707 | } |
|
|
708 | |
|
|
709 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
710 | if $verbosity >= 11; |
532 | } |
711 | } |
533 | |
712 | |
534 | if ($htype == 1) { # DESTROY |
713 | if ($htype == 1) { # DESTROY |
535 | # remove hooks if unused |
|
|
536 | if (my $hook = $TERM->{_hook}) { |
|
|
537 | for my $htype (0..$#$hook) { |
|
|
538 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
539 | or set_should_invoke $htype, 0; |
|
|
540 | } |
|
|
541 | } |
|
|
542 | |
|
|
543 | # clear package objects |
714 | # clear package objects |
544 | %$_ = () for values %{ $TERM->{_pkg} }; |
715 | %$_ = () for values %{ $TERM->{_pkg} }; |
545 | |
716 | |
546 | # clear package |
717 | # clear package |
547 | %$TERM = (); |
718 | %$TERM = (); |
548 | } |
719 | } |
549 | |
720 | |
550 | $retval |
721 | $retval |
551 | } |
722 | } |
552 | |
723 | |
553 | # urxvt::term::proxy |
724 | sub exec_async(@) { |
|
|
725 | my $pid = fork; |
554 | |
726 | |
555 | sub urxvt::term::proxy::AUTOLOAD { |
727 | return |
556 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
728 | if !defined $pid or $pid; |
|
|
729 | |
|
|
730 | %ENV = %{ $TERM->env }; |
|
|
731 | |
|
|
732 | exec @_; |
|
|
733 | _exit 255; |
|
|
734 | } |
|
|
735 | |
|
|
736 | # urxvt::term::extension |
|
|
737 | |
|
|
738 | package urxvt::term::extension; |
|
|
739 | |
|
|
740 | sub enable { |
|
|
741 | my ($self, %hook) = @_; |
|
|
742 | my $pkg = $self->{_pkg}; |
|
|
743 | |
|
|
744 | while (my ($name, $cb) = each %hook) { |
|
|
745 | my $htype = $HOOKTYPE{uc $name}; |
|
|
746 | defined $htype |
|
|
747 | or Carp::croak "unsupported hook type '$name'"; |
|
|
748 | |
|
|
749 | $self->set_should_invoke ($htype, +1) |
|
|
750 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
|
|
751 | |
|
|
752 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
753 | } |
|
|
754 | } |
|
|
755 | |
|
|
756 | sub disable { |
|
|
757 | my ($self, @hook) = @_; |
|
|
758 | my $pkg = $self->{_pkg}; |
|
|
759 | |
|
|
760 | for my $name (@hook) { |
|
|
761 | my $htype = $HOOKTYPE{uc $name}; |
|
|
762 | defined $htype |
|
|
763 | or Carp::croak "unsupported hook type '$name'"; |
|
|
764 | |
|
|
765 | $self->set_should_invoke ($htype, -1) |
|
|
766 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
|
|
767 | } |
|
|
768 | } |
|
|
769 | |
|
|
770 | our $AUTOLOAD; |
|
|
771 | |
|
|
772 | sub AUTOLOAD { |
|
|
773 | $AUTOLOAD =~ /:([^:]+)$/ |
557 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
774 | or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable"; |
558 | |
775 | |
559 | eval qq{ |
776 | eval qq{ |
560 | sub $urxvt::term::proxy::AUTOLOAD { |
777 | sub $AUTOLOAD { |
561 | my \$proxy = shift; |
778 | my \$proxy = shift; |
562 | \$proxy->{term}->$1 (\@_) |
779 | \$proxy->{term}->$1 (\@_) |
563 | } |
780 | } |
564 | 1 |
781 | 1 |
565 | } or die "FATAL: unable to compile method forwarder: $@"; |
782 | } or die "FATAL: unable to compile method forwarder: $@"; |
566 | |
783 | |
567 | goto &$urxvt::term::proxy::AUTOLOAD; |
784 | goto &$AUTOLOAD; |
568 | } |
785 | } |
569 | |
786 | |
570 | sub urxvt::term::proxy::DESTROY { |
787 | sub DESTROY { |
571 | # nop |
788 | # nop |
572 | } |
789 | } |
573 | |
790 | |
574 | # urxvt::destroy_hook |
791 | # urxvt::destroy_hook |
575 | |
792 | |
… | |
… | |
585 | |
802 | |
586 | =head2 The C<urxvt::anyevent> Class |
803 | =head2 The C<urxvt::anyevent> Class |
587 | |
804 | |
588 | The sole purpose of this class is to deliver an interface to the |
805 | The sole purpose of this class is to deliver an interface to the |
589 | C<AnyEvent> module - any module using it will work inside urxvt without |
806 | C<AnyEvent> module - any module using it will work inside urxvt without |
590 | further work. The only exception is that you cannot wait on condition |
807 | further programming. The only exception is that you cannot wait on |
591 | variables, but non-blocking condvar use is ok. What this means is that you |
808 | condition variables, but non-blocking condvar use is ok. What this means |
592 | cannot use blocking APIs, but the non-blocking variant should work. |
809 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
810 | work. |
593 | |
811 | |
594 | =cut |
812 | =cut |
595 | |
813 | |
596 | our $VERSION = 1; |
814 | our $VERSION = 1; |
597 | |
815 | |
… | |
… | |
642 | ${$_[0]}++; |
860 | ${$_[0]}++; |
643 | } |
861 | } |
644 | |
862 | |
645 | sub urxvt::anyevent::condvar::wait { |
863 | sub urxvt::anyevent::condvar::wait { |
646 | unless (${$_[0]}) { |
864 | unless (${$_[0]}) { |
647 | require Carp; |
|
|
648 | Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"); |
865 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
649 | } |
866 | } |
650 | } |
867 | } |
651 | |
868 | |
652 | package urxvt::term; |
869 | package urxvt::term; |
653 | |
870 | |
… | |
… | |
660 | # find on_xxx subs in the package and register them |
877 | # find on_xxx subs in the package and register them |
661 | # as hooks |
878 | # as hooks |
662 | sub register_package { |
879 | sub register_package { |
663 | my ($self, $pkg, $argv) = @_; |
880 | my ($self, $pkg, $argv) = @_; |
664 | |
881 | |
665 | my $proxy = bless { argv => $argv }, $pkg; |
882 | my $proxy = bless { |
|
|
883 | _pkg => $pkg, |
|
|
884 | argv => $argv, |
|
|
885 | }, $pkg; |
666 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
886 | Scalar::Util::weaken ($proxy->{term} = $self); |
667 | |
887 | |
668 | $self->{_pkg}{$pkg} = $proxy; |
888 | $self->{_pkg}{$pkg} = $proxy; |
669 | |
889 | |
670 | for my $htype (0.. $#HOOKNAME) { |
890 | for my $name (@HOOKNAME) { |
671 | my $name = $HOOKNAME[$htype]; |
|
|
672 | |
|
|
673 | my $ref = $pkg->can ("on_" . lc $name) |
891 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
674 | or next; |
892 | $proxy->enable ($name => $ref); |
675 | |
893 | } |
676 | $self->{_hook}[$htype]{$pkg} = $ref; |
|
|
677 | $hook_count[$htype]++ |
|
|
678 | or urxvt::set_should_invoke $htype, 1; |
|
|
679 | } |
894 | } |
680 | } |
895 | } |
681 | |
896 | |
|
|
897 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
|
|
898 | |
|
|
899 | Creates a new terminal, very similar as if you had started it with system |
|
|
900 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
|
|
901 | hash which defines the environment of the new terminal. |
|
|
902 | |
|
|
903 | Croaks (and probably outputs an error message) if the new instance |
|
|
904 | couldn't be created. Returns C<undef> if the new instance didn't |
|
|
905 | initialise perl, and the terminal object otherwise. The C<init> and |
|
|
906 | C<start> hooks will be called during this call. |
|
|
907 | |
|
|
908 | =cut |
|
|
909 | |
|
|
910 | sub new { |
|
|
911 | my ($class, $env, @args) = @_; |
|
|
912 | |
|
|
913 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
|
|
914 | } |
|
|
915 | |
682 | =item $term->destroy |
916 | =item $term->destroy |
683 | |
917 | |
684 | Destroy the terminal object (close the window, free resources etc.). |
918 | Destroy the terminal object (close the window, free resources |
|
|
919 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
|
|
920 | watchers (timers, io watchers) are still active. |
685 | |
921 | |
686 | =item $isset = $term->option ($optval[, $set]) |
922 | =item $isset = $term->option ($optval[, $set]) |
687 | |
923 | |
688 | Returns true if the option specified by C<$optval> is enabled, and |
924 | Returns true if the option specified by C<$optval> is enabled, and |
689 | optionally change it. All option values are stored by name in the hash |
925 | optionally change it. All option values are stored by name in the hash |
… | |
… | |
739 | my ($self, $name) = (shift, shift); |
975 | my ($self, $name) = (shift, shift); |
740 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
976 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
741 | &urxvt::term::_resource |
977 | &urxvt::term::_resource |
742 | } |
978 | } |
743 | |
979 | |
|
|
980 | =item $value = $term->x_resource ($pattern) |
|
|
981 | |
|
|
982 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
983 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
|
|
984 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
|
|
985 | resource with that pattern exists. |
|
|
986 | |
|
|
987 | This method should only be called during the C<on_start> hook, as there is |
|
|
988 | only one resource database per display, and later invocations might return |
|
|
989 | the wrong resources. |
|
|
990 | |
|
|
991 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
|
|
992 | |
|
|
993 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
994 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
|
|
995 | |
744 | =item $rend = $term->rstyle ([$new_rstyle]) |
996 | =item $rend = $term->rstyle ([$new_rstyle]) |
745 | |
997 | |
746 | Return and optionally change the current rendition. Text that is output by |
998 | Return and optionally change the current rendition. Text that is output by |
747 | the terminal application will use this style. |
999 | the terminal application will use this style. |
748 | |
1000 | |
… | |
… | |
758 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1010 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
759 | |
1011 | |
760 | Return the current values of the selection mark, begin or end positions, |
1012 | Return the current values of the selection mark, begin or end positions, |
761 | and optionally set them to new values. |
1013 | and optionally set them to new values. |
762 | |
1014 | |
|
|
1015 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
1016 | |
|
|
1017 | Tries to make a selection as set by C<selection_beg> and |
|
|
1018 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
1019 | rectangular selection will be made. This is the prefered function to make |
|
|
1020 | a selection. |
|
|
1021 | |
763 | =item $success = $term->selection_grab ($eventtime) |
1022 | =item $success = $term->selection_grab ($eventtime) |
764 | |
1023 | |
765 | Try to request the primary selection from the server (for example, as set |
1024 | Try to request the primary selection text from the server (for example, as |
766 | by the next method). |
1025 | set by the next method). No visual feedback will be given. This function |
|
|
1026 | is mostly useful from within C<on_sel_grab> hooks. |
767 | |
1027 | |
768 | =item $oldtext = $term->selection ([$newtext]) |
1028 | =item $oldtext = $term->selection ([$newtext]) |
769 | |
1029 | |
770 | Return the current selection text and optionally replace it by C<$newtext>. |
1030 | Return the current selection text and optionally replace it by C<$newtext>. |
771 | |
1031 | |
772 | #=item $term->overlay ($x, $y, $text) |
1032 | =item $term->overlay_simple ($x, $y, $text) |
773 | # |
1033 | |
774 | #Create a simple multi-line overlay box. See the next method for details. |
1034 | Create a simple multi-line overlay box. See the next method for details. |
775 | # |
1035 | |
776 | #=cut |
1036 | =cut |
777 | # |
1037 | |
778 | #sub urxvt::term::scr_overlay { |
1038 | sub overlay_simple { |
779 | # my ($self, $x, $y, $text) = @_; |
1039 | my ($self, $x, $y, $text) = @_; |
780 | # |
1040 | |
781 | # my @lines = split /\n/, $text; |
1041 | my @lines = split /\n/, $text; |
782 | # |
1042 | |
783 | # my $w = 0; |
1043 | my $w = List::Util::max map $self->strwidth ($_), @lines; |
784 | # for (map $self->strwidth ($_), @lines) { |
1044 | |
785 | # $w = $_ if $w < $_; |
|
|
786 | # } |
|
|
787 | # |
|
|
788 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
1045 | my $overlay = $self->overlay ($x, $y, $w, scalar @lines); |
789 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
1046 | $overlay->set (0, $_, $lines[$_]) for 0.. $#lines; |
790 | #} |
1047 | |
|
|
1048 | $overlay |
|
|
1049 | } |
791 | |
1050 | |
792 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
1051 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
793 | |
1052 | |
794 | Create a new (empty) overlay at the given position with the given |
1053 | Create a new (empty) overlay at the given position with the given |
795 | width/height. C<$rstyle> defines the initial rendition style |
1054 | width/height. C<$rstyle> defines the initial rendition style |
… | |
… | |
862 | |
1121 | |
863 | =item $string = $term->locale_decode ($octets) |
1122 | =item $string = $term->locale_decode ($octets) |
864 | |
1123 | |
865 | Convert the given locale-encoded octets into a perl string. |
1124 | Convert the given locale-encoded octets into a perl string. |
866 | |
1125 | |
|
|
1126 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
|
|
1127 | |
|
|
1128 | XORs the rendition values in the given span with the provided value |
|
|
1129 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
|
|
1130 | refresh hooks to provide effects similar to the selection. |
|
|
1131 | |
|
|
1132 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
|
|
1133 | |
|
|
1134 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
|
|
1135 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
|
|
1136 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
|
|
1137 | it instead. Both styles I<MUST NOT> contain font styles. |
|
|
1138 | |
|
|
1139 | =item $term->scr_bell |
|
|
1140 | |
|
|
1141 | Ring the bell! |
|
|
1142 | |
867 | =item $term->scr_add_lines ($string) |
1143 | =item $term->scr_add_lines ($string) |
868 | |
1144 | |
869 | Write the given text string to the screen, as if output by the application |
1145 | Write the given text string to the screen, as if output by the application |
870 | running inside the terminal. It may not contain command sequences (escape |
1146 | running inside the terminal. It may not contain command sequences (escape |
871 | codes), but is free to use line feeds, carriage returns and tabs. The |
1147 | codes), but is free to use line feeds, carriage returns and tabs. The |
… | |
… | |
885 | |
1161 | |
886 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1162 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
887 | pass characters instead of octets, you should convert your strings first |
1163 | pass characters instead of octets, you should convert your strings first |
888 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1164 | to the locale-specific encoding using C<< $term->locale_encode >>. |
889 | |
1165 | |
|
|
1166 | =item $old_events = $term->pty_ev_events ([$new_events]) |
|
|
1167 | |
|
|
1168 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
1169 | be used to suppress input and output handling to the pty/tty. See the |
|
|
1170 | description of C<< urxvt::timer->events >>. Make sure to always restore |
|
|
1171 | the previous value. |
|
|
1172 | |
890 | =item $windowid = $term->parent |
1173 | =item $windowid = $term->parent |
891 | |
1174 | |
892 | Return the window id of the toplevel window. |
1175 | Return the window id of the toplevel window. |
893 | |
1176 | |
894 | =item $windowid = $term->vt |
1177 | =item $windowid = $term->vt |
895 | |
1178 | |
896 | Return the window id of the terminal window. |
1179 | Return the window id of the terminal window. |
897 | |
1180 | |
|
|
1181 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1182 | |
|
|
1183 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1184 | to receive pointer events all the times: |
|
|
1185 | |
|
|
1186 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1187 | |
898 | =item $window_width = $term->width |
1188 | =item $window_width = $term->width |
899 | |
1189 | |
900 | =item $window_height = $term->height |
1190 | =item $window_height = $term->height |
901 | |
1191 | |
902 | =item $font_width = $term->fwidth |
1192 | =item $font_width = $term->fwidth |
… | |
… | |
915 | |
1205 | |
916 | =item $max_scrollback = $term->saveLines |
1206 | =item $max_scrollback = $term->saveLines |
917 | |
1207 | |
918 | =item $nrow_plus_saveLines = $term->total_rows |
1208 | =item $nrow_plus_saveLines = $term->total_rows |
919 | |
1209 | |
920 | =item $lines_in_scrollback = $term->nsaved |
1210 | =item $topmost_scrollback_row = $term->top_row |
921 | |
1211 | |
922 | Return various integers describing terminal characteristics. |
1212 | Return various integers describing terminal characteristics. |
923 | |
1213 | |
|
|
1214 | =item $x_display = $term->display_id |
|
|
1215 | |
|
|
1216 | Return the DISPLAY used by rxvt-unicode. |
|
|
1217 | |
924 | =item $lc_ctype = $term->locale |
1218 | =item $lc_ctype = $term->locale |
925 | |
1219 | |
926 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1220 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
927 | |
1221 | |
928 | =item $x_display = $term->display_id |
1222 | =item $env = $term->env |
929 | |
1223 | |
930 | Return the DISPLAY used by rxvt-unicode. |
1224 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1225 | similar to C<\%ENV>. |
|
|
1226 | |
|
|
1227 | =cut |
|
|
1228 | |
|
|
1229 | sub env { |
|
|
1230 | if (my $env = $_[0]->_env) { |
|
|
1231 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
|
|
1232 | } else { |
|
|
1233 | +{ %ENV } |
|
|
1234 | } |
|
|
1235 | } |
931 | |
1236 | |
932 | =item $modifiermask = $term->ModLevel3Mask |
1237 | =item $modifiermask = $term->ModLevel3Mask |
933 | |
1238 | |
934 | =item $modifiermask = $term->ModMetaMask |
1239 | =item $modifiermask = $term->ModMetaMask |
935 | |
1240 | |
… | |
… | |
938 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1243 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
939 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1244 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
940 | |
1245 | |
941 | =item $view_start = $term->view_start ([$newvalue]) |
1246 | =item $view_start = $term->view_start ([$newvalue]) |
942 | |
1247 | |
943 | Returns the negative row number of the topmost line. Minimum value is |
1248 | Returns the row number of the topmost displayed line. Maximum value is |
944 | C<0>, which displays the normal terminal contents. Larger values scroll |
1249 | C<0>, which displays the normal terminal contents. Lower values scroll |
945 | this many lines into the scrollback buffer. |
1250 | this many lines into the scrollback buffer. |
946 | |
1251 | |
947 | =item $term->want_refresh |
1252 | =item $term->want_refresh |
948 | |
1253 | |
949 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1254 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1028 | Return the row number of the first/last row of the line, respectively. |
1333 | Return the row number of the first/last row of the line, respectively. |
1029 | |
1334 | |
1030 | =item $offset = $line->offset_of ($row, $col) |
1335 | =item $offset = $line->offset_of ($row, $col) |
1031 | |
1336 | |
1032 | Returns the character offset of the given row|col pair within the logical |
1337 | Returns the character offset of the given row|col pair within the logical |
1033 | line. |
1338 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1339 | offsets outside the string. |
1034 | |
1340 | |
1035 | =item ($row, $col) = $line->coord_of ($offset) |
1341 | =item ($row, $col) = $line->coord_of ($offset) |
1036 | |
1342 | |
1037 | Translates a string offset into terminal coordinates again. |
1343 | Translates a string offset into terminal coordinates again. |
1038 | |
1344 | |
… | |
… | |
1175 | $item->{render} ||= sub { $_[0]{text} }; |
1481 | $item->{render} ||= sub { $_[0]{text} }; |
1176 | |
1482 | |
1177 | push @{ $self->{item} }, $item; |
1483 | push @{ $self->{item} }, $item; |
1178 | } |
1484 | } |
1179 | |
1485 | |
|
|
1486 | =item $popup->add_title ($title) |
|
|
1487 | |
|
|
1488 | Adds a non-clickable title to the popup. |
|
|
1489 | |
|
|
1490 | =cut |
|
|
1491 | |
|
|
1492 | sub add_title { |
|
|
1493 | my ($self, $title) = @_; |
|
|
1494 | |
|
|
1495 | $self->add_item ({ |
|
|
1496 | rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, |
|
|
1497 | text => $title, |
|
|
1498 | activate => sub { }, |
|
|
1499 | }); |
|
|
1500 | } |
|
|
1501 | |
|
|
1502 | =item $popup->add_separator ([$sepchr]) |
|
|
1503 | |
|
|
1504 | Creates a separator, optionally using the character given as C<$sepchr>. |
|
|
1505 | |
|
|
1506 | =cut |
|
|
1507 | |
1180 | sub add_separator { |
1508 | sub add_separator { |
1181 | my ($self, $sep) = @_; |
1509 | my ($self, $sep) = @_; |
1182 | |
1510 | |
1183 | $sep ||= "="; |
1511 | $sep ||= "="; |
1184 | |
1512 | |
… | |
… | |
1188 | render => sub { $sep x $self->{term}->ncol }, |
1516 | render => sub { $sep x $self->{term}->ncol }, |
1189 | activate => sub { }, |
1517 | activate => sub { }, |
1190 | }); |
1518 | }); |
1191 | } |
1519 | } |
1192 | |
1520 | |
1193 | sub add_title { |
1521 | =item $popup->add_button ($text, $cb) |
1194 | my ($self, $title) = @_; |
|
|
1195 | |
1522 | |
1196 | $self->add_item ({ |
1523 | Adds a clickable button to the popup. C<$cb> is called whenever it is |
1197 | rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, |
1524 | selected. |
1198 | text => $title, |
1525 | |
1199 | activate => sub { }, |
1526 | =cut |
1200 | }); |
|
|
1201 | } |
|
|
1202 | |
1527 | |
1203 | sub add_button { |
1528 | sub add_button { |
1204 | my ($self, $text, $cb) = @_; |
1529 | my ($self, $text, $cb) = @_; |
1205 | |
1530 | |
1206 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1531 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1207 | } |
1532 | } |
|
|
1533 | |
|
|
1534 | =item $popup->add_toggle ($text, $cb, $initial_value) |
|
|
1535 | |
|
|
1536 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1537 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1538 | argument. |
|
|
1539 | |
|
|
1540 | =cut |
1208 | |
1541 | |
1209 | sub add_toggle { |
1542 | sub add_toggle { |
1210 | my ($self, $text, $cb, $value) = @_; |
1543 | my ($self, $text, $cb, $value) = @_; |
1211 | |
1544 | |
1212 | my $item; $item = { |
1545 | my $item; $item = { |
1213 | type => "button", |
1546 | type => "button", |
1214 | text => " $text", |
1547 | text => " $text", |
1215 | value => $value, |
1548 | value => $value, |
1216 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1549 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1217 | activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, |
1550 | activate => sub { $cb->($_[1]{value} = !$_[1]{value}); }, |
1218 | }; |
1551 | }; |
1219 | |
1552 | |
1220 | $self->add_item ($item); |
1553 | $self->add_item ($item); |
1221 | } |
1554 | } |
|
|
1555 | |
|
|
1556 | =item $popup->show |
|
|
1557 | |
|
|
1558 | Displays the popup (which is initially hidden). |
|
|
1559 | |
|
|
1560 | =cut |
1222 | |
1561 | |
1223 | sub show { |
1562 | sub show { |
1224 | my ($self) = @_; |
1563 | my ($self) = @_; |
1225 | |
1564 | |
1226 | local $urxvt::popup::self = $self; |
1565 | local $urxvt::popup::self = $self; |
1227 | |
1566 | |
|
|
1567 | my $env = $self->{term}->env; |
|
|
1568 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
|
|
1569 | delete $env->{LC_ALL}; |
1228 | local $ENV{LC_ALL} = $self->{term}->locale; |
1570 | $env->{LC_CTYPE} = $self->{term}->locale; |
1229 | |
1571 | |
|
|
1572 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1230 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1573 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1231 | "--transient-for" => $self->{term}->parent, |
1574 | "--transient-for" => $self->{term}->parent, |
1232 | "-display" => $self->{term}->display_id, |
1575 | "-display" => $self->{term}->display_id, |
1233 | "-pe" => "urxvt-popup") |
1576 | "-pe" => "urxvt-popup") |
1234 | or die "unable to create popup window\n"; |
1577 | or die "unable to create popup window\n"; |
1235 | } |
1578 | } |
1236 | |
1579 | |
1237 | sub DESTROY { |
1580 | sub DESTROY { |
1238 | my ($self) = @_; |
1581 | my ($self) = @_; |
1239 | |
1582 | |
1240 | delete $self->{term}{_destroy}{$self}; |
1583 | delete $self->{term}{_destroy}{$self}; |
1241 | $self->{term}->ungrab; |
1584 | $self->{term}->ungrab; |
1242 | } |
1585 | } |
|
|
1586 | |
|
|
1587 | =back |
1243 | |
1588 | |
1244 | =head2 The C<urxvt::timer> Class |
1589 | =head2 The C<urxvt::timer> Class |
1245 | |
1590 | |
1246 | This class implements timer watchers/events. Time is represented as a |
1591 | This class implements timer watchers/events. Time is represented as a |
1247 | fractional number of seconds since the epoch. Example: |
1592 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1300 | |
1645 | |
1301 | $term->{socket} = ... |
1646 | $term->{socket} = ... |
1302 | $term->{iow} = urxvt::iow |
1647 | $term->{iow} = urxvt::iow |
1303 | ->new |
1648 | ->new |
1304 | ->fd (fileno $term->{socket}) |
1649 | ->fd (fileno $term->{socket}) |
1305 | ->events (1) # wait for read data |
1650 | ->events (urxvt::EVENT_READ) |
1306 | ->start |
1651 | ->start |
1307 | ->cb (sub { |
1652 | ->cb (sub { |
1308 | my ($iow, $revents) = @_; |
1653 | my ($iow, $revents) = @_; |
1309 | # $revents must be 1 here, no need to check |
1654 | # $revents must be 1 here, no need to check |
1310 | sysread $term->{socket}, my $buf, 8192 |
1655 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1327 | |
1672 | |
1328 | Set the filedescriptor (not handle) to watch. |
1673 | Set the filedescriptor (not handle) to watch. |
1329 | |
1674 | |
1330 | =item $iow = $iow->events ($eventmask) |
1675 | =item $iow = $iow->events ($eventmask) |
1331 | |
1676 | |
1332 | Set the event mask to watch. Bit #0 (value C<1>) enables watching for read |
1677 | Set the event mask to watch. The only allowed values are |
1333 | data, Bit #1 (value C<2>) enables watching for write data. |
1678 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
|
|
1679 | together, or C<urxvt::EVENT_NONE>. |
1334 | |
1680 | |
1335 | =item $iow = $iow->start |
1681 | =item $iow = $iow->start |
1336 | |
1682 | |
1337 | Start watching for requested events on the given handle. |
1683 | Start watching for requested events on the given handle. |
1338 | |
1684 | |
… | |
… | |
1353 | |
1699 | |
1354 | =item == 0 - fatal messages |
1700 | =item == 0 - fatal messages |
1355 | |
1701 | |
1356 | =item >= 3 - script loading and management |
1702 | =item >= 3 - script loading and management |
1357 | |
1703 | |
1358 | =item >=10 - all events received |
1704 | =item >=10 - all called hooks |
|
|
1705 | |
|
|
1706 | =item >=11 - hook reutrn values |
1359 | |
1707 | |
1360 | =back |
1708 | =back |
1361 | |
1709 | |
1362 | =head1 AUTHOR |
1710 | =head1 AUTHOR |
1363 | |
1711 | |