… | |
… | |
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 | Or by adding them to the resource for extensions loaded by default: |
|
|
41 | |
|
|
42 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
|
|
43 | |
40 | =over 4 |
44 | =over 4 |
41 | |
45 | |
42 | =item selection |
46 | =item selection (enabled by default) |
43 | |
47 | |
44 | Intelligent selection. This extension tries to be more intelligent when |
48 | (More) intelligent selection. This extension tries to be more intelligent |
45 | the user extends selections (double-click). Right now, it tries to select |
49 | when the user extends selections (double-click and further clicks). Right |
46 | urls and complete shell-quoted arguments, which is very convenient, too, |
50 | now, it tries to select words, urls and complete shell-quoted |
47 | if your F<ls> supports C<--quoting-style=shell>. |
51 | arguments, which is very convenient, too, if your F<ls> supports |
|
|
52 | C<--quoting-style=shell>. |
48 | |
53 | |
49 | It also offers the following bindable event: |
54 | A double-click usually selects the word under the cursor, further clicks |
|
|
55 | will enlarge the selection. |
|
|
56 | |
|
|
57 | The selection works by trying to match a number of regexes and displaying |
|
|
58 | them in increasing order of length. You can add your own regexes by |
|
|
59 | specifying resources of the form: |
|
|
60 | |
|
|
61 | URxvt.selection.pattern-0: perl-regex |
|
|
62 | URxvt.selection.pattern-1: perl-regex |
|
|
63 | ... |
|
|
64 | |
|
|
65 | The index number (0, 1...) must not have any holes, and each regex must |
|
|
66 | contain at least one pair of capturing parentheses, which will be used for |
|
|
67 | the match. For example, the followign adds a regex that matches everything |
|
|
68 | between two vertical bars: |
|
|
69 | |
|
|
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
71 | |
|
|
72 | You can look at the source of the selection extension to see more |
|
|
73 | interesting uses, such as parsing a line from beginning to end. |
|
|
74 | |
|
|
75 | This extension also offers following bindable keyboard commands: |
50 | |
76 | |
51 | =over 4 |
77 | =over 4 |
52 | |
78 | |
53 | =item rot13 |
79 | =item rot13 |
54 | |
80 | |
… | |
… | |
56 | |
82 | |
57 | URxvt.keysym.C-M-r: perl:selection:rot13 |
83 | URxvt.keysym.C-M-r: perl:selection:rot13 |
58 | |
84 | |
59 | =back |
85 | =back |
60 | |
86 | |
61 | =item digital-clock |
87 | =item option-popup (enabled by default) |
62 | |
88 | |
63 | Displays a digital clock using the built-in overlay. |
89 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
|
|
90 | runtime. |
|
|
91 | |
|
|
92 | =item selection-popup (enabled by default) |
|
|
93 | |
|
|
94 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
95 | text into various other formats/action (such as uri unescaping, perl |
|
|
96 | evaluation, web-browser starting etc.), depending on content. |
|
|
97 | |
|
|
98 | Other extensions can extend this popup menu by pushing a code reference |
|
|
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
|
|
100 | popup is displayed. |
|
|
101 | |
|
|
102 | It's sole argument is the popup menu, which can be modified. The selection |
|
|
103 | is in C<$_>, which can be used to decide wether to add something or not. |
|
|
104 | It should either return nothing or a string and a code reference. The |
|
|
105 | string will be used as button text and the code reference will be called |
|
|
106 | when the button gets activated and should transform C<$_>. |
|
|
107 | |
|
|
108 | The following will add an entry C<a to b> that transforms all C<a>s in |
|
|
109 | the selection to C<b>s, but only if the selection currently contains any |
|
|
110 | C<a>s: |
|
|
111 | |
|
|
112 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
113 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
114 | : () |
|
|
115 | }; |
|
|
116 | |
|
|
117 | =item searchable-scrollback<hotkey> (enabled by default) |
|
|
118 | |
|
|
119 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
120 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
|
|
121 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
122 | screen. |
|
|
123 | |
|
|
124 | Inputting characters appends them to the regex and continues incremental |
|
|
125 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
|
|
126 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
|
|
127 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
128 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
129 | additionally stores the first match in the current line into the primary |
|
|
130 | selection. |
|
|
131 | |
|
|
132 | =item readline (enabled by default) |
|
|
133 | |
|
|
134 | A support package that tries to make editing with readline easier. At the |
|
|
135 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
136 | move the text cursor to this position. It does so by generating as many |
|
|
137 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
138 | for programs that correctly support wide characters). |
|
|
139 | |
|
|
140 | To avoid too many false positives, this is only done when: |
|
|
141 | |
|
|
142 | =over 4 |
|
|
143 | |
|
|
144 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
145 | |
|
|
146 | =item - the primary screen is currently being displayed. |
|
|
147 | |
|
|
148 | =item - the text cursor is visible. |
|
|
149 | |
|
|
150 | =back |
|
|
151 | |
|
|
152 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
153 | might interfere with selection creation in harmless ways. |
|
|
154 | |
|
|
155 | =item selection-autotransform |
|
|
156 | |
|
|
157 | This selection allows you to do automatic transforms on a selection |
|
|
158 | whenever a selection is made. |
|
|
159 | |
|
|
160 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
161 | operator) that modify C<$_> as resources: |
|
|
162 | |
|
|
163 | URxvt.selection-autotransform.0: transform |
|
|
164 | URxvt.selection-autotransform.1: transform |
|
|
165 | ... |
|
|
166 | |
|
|
167 | For example, the following will transform selections of the form |
|
|
168 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
169 | $word>: |
|
|
170 | |
|
|
171 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
172 | |
|
|
173 | And this example matches the same,but replaces it with vi-commands you can |
|
|
174 | paste directly into your (vi :) editor: |
|
|
175 | |
|
|
176 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
177 | |
|
|
178 | Of course, this can be modified to suit your needs and your editor :) |
|
|
179 | |
|
|
180 | To expand the example above to typical perl error messages ("XXX at |
|
|
181 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
182 | |
|
|
183 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
184 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
185 | |
|
|
186 | The first line tells the selection code to treat the unchanging part of |
|
|
187 | every error message as a selection pattern, and the second line transforms |
|
|
188 | the message into vi commands to load the file. |
|
|
189 | |
|
|
190 | =item tabbed |
|
|
191 | |
|
|
192 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
193 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
|
|
194 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
195 | button per tab. |
|
|
196 | |
|
|
197 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
198 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
199 | while B<Shift-Down> creates a new tab. |
64 | |
200 | |
65 | =item mark-urls |
201 | =item mark-urls |
66 | |
202 | |
67 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
203 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
|
|
204 | make them clickable. When middle-clicked, the program specified in the |
|
|
205 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
|
|
206 | the URL as first argument. |
|
|
207 | |
|
|
208 | =item automove-background |
|
|
209 | |
|
|
210 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
211 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
212 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
213 | |
|
|
214 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
68 | |
215 | |
69 | =item block-graphics-to-ascii |
216 | =item block-graphics-to-ascii |
70 | |
217 | |
71 | A not very useful example of filtering all text output to the terminal, |
218 | A not very useful example of filtering all text output to the terminal, |
72 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
219 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
73 | similar-looking ascii character. |
220 | similar-looking ascii character. |
74 | |
221 | |
|
|
222 | =item digital-clock |
|
|
223 | |
|
|
224 | Displays a digital clock using the built-in overlay. |
|
|
225 | |
75 | =item example-refresh-hooks |
226 | =item example-refresh-hooks |
76 | |
227 | |
77 | Displays a very simple digital clock in the upper right corner of the |
228 | Displays a very simple digital clock in the upper right corner of the |
78 | window. Illustrates overwriting the refresh callbacks to create your own |
229 | window. Illustrates overwriting the refresh callbacks to create your own |
79 | overlays or changes. |
230 | overlays or changes. |
80 | |
231 | |
|
|
232 | =item selection-pastebin |
|
|
233 | |
|
|
234 | This is a little rarely useful extension that Uploads the selection as |
|
|
235 | textfile to a remote site (or does other things). (The implementation is |
|
|
236 | not currently secure for use in a multiuser environment as it writes to |
|
|
237 | F</tmp> directly.). |
|
|
238 | |
|
|
239 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
240 | i.e. |
|
|
241 | |
|
|
242 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
243 | |
|
|
244 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
245 | the textfile. This command can be set via a resource: |
|
|
246 | |
|
|
247 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
248 | |
|
|
249 | And the default is likely not useful to anybody but the few people around |
|
|
250 | here :) |
|
|
251 | |
|
|
252 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
253 | the same content should lead to the same filename. |
|
|
254 | |
|
|
255 | After a successful upload the selection will be replaced by the text given |
|
|
256 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
257 | for the filename): |
|
|
258 | |
|
|
259 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
260 | |
81 | =back |
261 | =back |
|
|
262 | |
|
|
263 | =head1 API DOCUMENTATION |
82 | |
264 | |
83 | =head2 General API Considerations |
265 | =head2 General API Considerations |
84 | |
266 | |
85 | All objects (such as terminals, time watchers etc.) are typical |
267 | All objects (such as terminals, time watchers etc.) are typical |
86 | reference-to-hash objects. The hash can be used to store anything you |
268 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
99 | =over 4 |
281 | =over 4 |
100 | |
282 | |
101 | =item $text |
283 | =item $text |
102 | |
284 | |
103 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
285 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
104 | always represents one screen cell. See L<row_t> for a discussion of this format. |
286 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
105 | |
287 | |
106 | =item $string |
288 | =item $string |
107 | |
289 | |
108 | A perl text string, with an emphasis on I<text>. It can store all unicode |
290 | A perl text string, with an emphasis on I<text>. It can store all unicode |
109 | characters and is to be distinguished with text encoded in a specific |
291 | characters and is to be distinguished with text encoded in a specific |
… | |
… | |
114 | Either binary data or - more common - a text string encoded in a |
296 | Either binary data or - more common - a text string encoded in a |
115 | locale-specific way. |
297 | locale-specific way. |
116 | |
298 | |
117 | =back |
299 | =back |
118 | |
300 | |
|
|
301 | =head2 Extension Objects |
|
|
302 | |
|
|
303 | Very perl extension is a perl class. A separate perl object is created |
|
|
304 | for each terminal and each extension and passed as the first parameter to |
|
|
305 | hooks. So extensions can use their C<$self> object without having to think |
|
|
306 | about other extensions, with the exception of methods and members that |
|
|
307 | begin with an underscore character C<_>: these are reserved for internal |
|
|
308 | use. |
|
|
309 | |
|
|
310 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
|
|
311 | C<urxvt::term> class on this object. |
|
|
312 | |
|
|
313 | It has the following methods and data members: |
|
|
314 | |
|
|
315 | =over 4 |
|
|
316 | |
|
|
317 | =item $urxvt_term = $self->{term} |
|
|
318 | |
|
|
319 | Returns the C<urxvt::term> object associated with this instance of the |
|
|
320 | extension. This member I<must not> be changed in any way. |
|
|
321 | |
|
|
322 | =item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
323 | |
|
|
324 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
325 | this extension, replacing any previous hook. This is useful when you want |
|
|
326 | to overwrite time-critical hooks only temporarily. |
|
|
327 | |
|
|
328 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
329 | |
|
|
330 | Dynamically disable the given hooks. |
|
|
331 | |
|
|
332 | =back |
|
|
333 | |
119 | =head2 Hooks |
334 | =head2 Hooks |
120 | |
335 | |
121 | The following subroutines can be declared in extension files, and will be |
336 | The following subroutines can be declared in extension files, and will be |
122 | called whenever the relevant event happens. |
337 | called whenever the relevant event happens. |
123 | |
338 | |
124 | The first argument passed to them is an object private to each terminal |
339 | The first argument passed to them is an extension oject as described in |
125 | and extension package. You can call all C<urxvt::term> methods on it, but |
340 | the in the C<Extension Objects> section. |
126 | its not a real C<urxvt::term> object. Instead, the real C<urxvt::term> |
|
|
127 | object that is shared between all packages is stored in the C<term> |
|
|
128 | member. It is, however, blessed intot he package of the extension script, |
|
|
129 | so for all practical purposes you can treat an extension script as a class. |
|
|
130 | |
341 | |
131 | All of them must return a boolean value. If it is true, then the event |
342 | B<All> of these hooks must return a boolean value. If any of the called |
132 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
343 | hooks returns true, then the event counts as being I<consumed>, and the |
133 | and the relevant action might not be carried out by the C++ code. |
344 | relevant action might not be carried out by the C++ code. |
134 | |
345 | |
135 | When in doubt, return a false value (preferably C<()>). |
346 | I<< When in doubt, return a false value (preferably C<()>). >> |
136 | |
347 | |
137 | =over 4 |
348 | =over 4 |
138 | |
349 | |
139 | =item on_init $term |
350 | =item on_init $term |
140 | |
351 | |
141 | Called after a new terminal object has been initialized, but before |
352 | Called after a new terminal object has been initialized, but before |
142 | windows are created or the command gets run. Most methods are unsafe to |
353 | windows are created or the command gets run. Most methods are unsafe to |
143 | call or deliver senseless data, as terminal size and other characteristics |
354 | call or deliver senseless data, as terminal size and other characteristics |
144 | have not yet been determined. You can safely query and change resources, |
355 | have not yet been determined. You can safely query and change resources |
145 | though. |
356 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
357 | place. |
|
|
358 | |
|
|
359 | =item on_start $term |
|
|
360 | |
|
|
361 | Called at the very end of initialisation of a new terminal, just before |
|
|
362 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
363 | |
|
|
364 | =item on_destroy $term |
|
|
365 | |
|
|
366 | Called whenever something tries to destroy terminal, before doing anything |
|
|
367 | yet. If this hook returns true, then destruction is skipped, but this is |
|
|
368 | rarely a good idea. |
146 | |
369 | |
147 | =item on_reset $term |
370 | =item on_reset $term |
148 | |
371 | |
149 | Called after the screen is "reset" for any reason, such as resizing or |
372 | Called after the screen is "reset" for any reason, such as resizing or |
150 | control sequences. Here is where you can react on changes to size-related |
373 | control sequences. Here is where you can react on changes to size-related |
151 | variables. |
374 | variables. |
152 | |
375 | |
153 | =item on_start $term |
376 | =item on_child_start $term, $pid |
154 | |
377 | |
155 | Called at the very end of initialisation of a new terminal, just before |
378 | Called just after the child process has been C<fork>ed. |
156 | returning to the mainloop. |
379 | |
|
|
380 | =item on_child_exit $term, $status |
|
|
381 | |
|
|
382 | Called just after the child process has exited. C<$status> is the status |
|
|
383 | from C<waitpid>. |
157 | |
384 | |
158 | =item on_sel_make $term, $eventtime |
385 | =item on_sel_make $term, $eventtime |
159 | |
386 | |
160 | Called whenever a selection has been made by the user, but before the |
387 | Called whenever a selection has been made by the user, but before the |
161 | selection text is copied, so changes to the beginning, end or type of the |
388 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
175 | =item on_sel_extend $term |
402 | =item on_sel_extend $term |
176 | |
403 | |
177 | Called whenever the user tries to extend the selection (e.g. with a double |
404 | Called whenever the user tries to extend the selection (e.g. with a double |
178 | click) and is either supposed to return false (normal operation), or |
405 | click) and is either supposed to return false (normal operation), or |
179 | should extend the selection itelf and return true to suppress the built-in |
406 | should extend the selection itelf and return true to suppress the built-in |
180 | processing. |
407 | processing. This can happen multiple times, as long as the callback |
|
|
408 | returns true, it will be called on every further click by the user and is |
|
|
409 | supposed to enlarge the selection more and more, if possible. |
181 | |
410 | |
182 | See the F<selection> example extension. |
411 | See the F<selection> example extension. |
183 | |
412 | |
184 | =item on_view_change $term, $offset |
413 | =item on_view_change $term, $offset |
185 | |
414 | |
… | |
… | |
194 | than the scroll back buffer or the terminal. |
423 | than the scroll back buffer or the terminal. |
195 | |
424 | |
196 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
425 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
197 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
426 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
198 | number of lines that will be in the scrollback buffer. |
427 | number of lines that will be in the scrollback buffer. |
199 | |
|
|
200 | =item on_tty_activity $term *NYI* |
|
|
201 | |
|
|
202 | Called whenever the program(s) running in the urxvt window send output. |
|
|
203 | |
428 | |
204 | =item on_osc_seq $term, $string |
429 | =item on_osc_seq $term, $string |
205 | |
430 | |
206 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
431 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
207 | operating system command) is processed. Cursor position and other state |
432 | operating system command) is processed. Cursor position and other state |
… | |
… | |
220 | can filter/change and output the text yourself by returning a true value |
445 | can filter/change and output the text yourself by returning a true value |
221 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
446 | and calling C<< $term->scr_add_lines >> yourself. Please note that this |
222 | might be very slow, however, as your hook is called for B<all> text being |
447 | might be very slow, however, as your hook is called for B<all> text being |
223 | output. |
448 | output. |
224 | |
449 | |
|
|
450 | =item on_tt_write $term, $octets |
|
|
451 | |
|
|
452 | Called whenever some data is written to the tty/pty and can be used to |
|
|
453 | suppress or filter tty input. |
|
|
454 | |
225 | =item on_line_update $term, $row |
455 | =item on_line_update $term, $row |
226 | |
456 | |
227 | Called whenever a line was updated or changed. Can be used to filter |
457 | Called whenever a line was updated or changed. Can be used to filter |
228 | screen output (e.g. underline urls or other useless stuff). Only lines |
458 | screen output (e.g. underline urls or other useless stuff). Only lines |
229 | that are being shown will be filtered, and, due to performance reasons, |
459 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
251 | |
481 | |
252 | Called whenever the user presses a key combination that has a |
482 | Called whenever the user presses a key combination that has a |
253 | C<perl:string> action bound to it (see description of the B<keysym> |
483 | C<perl:string> action bound to it (see description of the B<keysym> |
254 | resource in the @@RXVT_NAME@@(1) manpage). |
484 | resource in the @@RXVT_NAME@@(1) manpage). |
255 | |
485 | |
|
|
486 | =item on_x_event $term, $event |
|
|
487 | |
|
|
488 | Called on every X event received on the vt window (and possibly other |
|
|
489 | windows). Should only be used as a last resort. Most event structure |
|
|
490 | members are not passed. |
|
|
491 | |
256 | =item on_focus_in $term |
492 | =item on_focus_in $term |
257 | |
493 | |
258 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
494 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
259 | does focus in processing. |
495 | does focus in processing. |
260 | |
496 | |
261 | =item on_focus_out $term |
497 | =item on_focus_out $term |
262 | |
498 | |
263 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
499 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
264 | focus out processing. |
500 | focus out processing. |
265 | |
501 | |
|
|
502 | =item on_configure_notify $term, $event |
|
|
503 | |
|
|
504 | =item on_property_notify $term, $event |
|
|
505 | |
266 | =item on_key_press $term, $event, $octets |
506 | =item on_key_press $term, $event, $keysym, $octets |
267 | |
507 | |
268 | =item on_key_release $term, $event |
508 | =item on_key_release $term, $event, $keysym |
269 | |
509 | |
270 | =item on_button_press $term, $event |
510 | =item on_button_press $term, $event |
271 | |
511 | |
272 | =item on_button_release $term, $event |
512 | =item on_button_release $term, $event |
273 | |
513 | |
… | |
… | |
279 | |
519 | |
280 | Called whenever the corresponding X event is received for the terminal If |
520 | Called whenever the corresponding X event is received for the terminal If |
281 | the hook returns true, then the even will be ignored by rxvt-unicode. |
521 | the hook returns true, then the even will be ignored by rxvt-unicode. |
282 | |
522 | |
283 | The event is a hash with most values as named by Xlib (see the XEvent |
523 | The event is a hash with most values as named by Xlib (see the XEvent |
284 | manpage), with the additional members C<row> and C<col>, which are the row |
524 | manpage), with the additional members C<row> and C<col>, which are the |
285 | and column under the mouse cursor. |
525 | (real, not screen-based) row and column under the mouse cursor. |
286 | |
526 | |
287 | C<on_key_press> additionally receives the string rxvt-unicode would |
527 | C<on_key_press> additionally receives the string rxvt-unicode would |
288 | output, if any, in locale-specific encoding. |
528 | output, if any, in locale-specific encoding. |
289 | |
529 | |
290 | subwindow. |
530 | subwindow. |
291 | |
531 | |
|
|
532 | =item on_client_message $term, $event |
|
|
533 | |
|
|
534 | =item on_wm_protocols $term, $event |
|
|
535 | |
|
|
536 | =item on_wm_delete_window $term, $event |
|
|
537 | |
|
|
538 | Called when various types of ClientMessage events are received (all with |
|
|
539 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
540 | |
292 | =back |
541 | =back |
293 | |
542 | |
|
|
543 | =cut |
|
|
544 | |
|
|
545 | package urxvt; |
|
|
546 | |
|
|
547 | use utf8; |
|
|
548 | use strict; |
|
|
549 | use Carp (); |
|
|
550 | use Scalar::Util (); |
|
|
551 | use List::Util (); |
|
|
552 | |
|
|
553 | our $VERSION = 1; |
|
|
554 | our $TERM; |
|
|
555 | our @TERM_INIT; |
|
|
556 | our @TERM_EXT; |
|
|
557 | our @HOOKNAME; |
|
|
558 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
|
|
559 | our %OPTION; |
|
|
560 | |
|
|
561 | our $LIBDIR; |
|
|
562 | our $RESNAME; |
|
|
563 | our $RESCLASS; |
|
|
564 | our $RXVTNAME; |
|
|
565 | |
|
|
566 | our $NOCHAR = chr 0xfffe; |
|
|
567 | |
294 | =head2 Variables in the C<urxvt> Package |
568 | =head2 Variables in the C<urxvt> Package |
295 | |
569 | |
296 | =over 4 |
570 | =over 4 |
|
|
571 | |
|
|
572 | =item $urxvt::LIBDIR |
|
|
573 | |
|
|
574 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
575 | modules and scripts are stored. |
|
|
576 | |
|
|
577 | =item $urxvt::RESCLASS, $urxvt::RESCLASS |
|
|
578 | |
|
|
579 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
580 | |
|
|
581 | =item $urxvt::RXVTNAME |
|
|
582 | |
|
|
583 | The basename of the installed binaries, usually C<urxvt>. |
297 | |
584 | |
298 | =item $urxvt::TERM |
585 | =item $urxvt::TERM |
299 | |
586 | |
300 | The current terminal. This variable stores the current C<urxvt::term> |
587 | The current terminal. This variable stores the current C<urxvt::term> |
301 | object, whenever a callback/hook is executing. |
588 | object, whenever a callback/hook is executing. |
302 | |
589 | |
|
|
590 | =item @urxvt::TERM_INIT |
|
|
591 | |
|
|
592 | All coderefs in this array will be called as methods of the next newly |
|
|
593 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
594 | gets cleared before the codereferences that were in it are being executed, |
|
|
595 | so coderefs can push themselves onto it again if they so desire. |
|
|
596 | |
|
|
597 | This complements to the perl-eval commandline option, but gets executed |
|
|
598 | first. |
|
|
599 | |
|
|
600 | =item @urxvt::TERM_EXT |
|
|
601 | |
|
|
602 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
603 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
604 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
|
|
605 | |
303 | =back |
606 | =back |
304 | |
607 | |
305 | =head2 Functions in the C<urxvt> Package |
608 | =head2 Functions in the C<urxvt> Package |
306 | |
609 | |
307 | =over 4 |
610 | =over 4 |
308 | |
|
|
309 | =item $term = new urxvt [arg...] |
|
|
310 | |
|
|
311 | Creates a new terminal, very similar as if you had started it with |
|
|
312 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
313 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
314 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
315 | C<init> and C<start> hooks will be called during the call. |
|
|
316 | |
611 | |
317 | =item urxvt::fatal $errormessage |
612 | =item urxvt::fatal $errormessage |
318 | |
613 | |
319 | Fatally aborts execution with the given error message. Avoid at all |
614 | Fatally aborts execution with the given error message. Avoid at all |
320 | costs! The only time this is acceptable is when the terminal process |
615 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
327 | that calls this function. |
622 | that calls this function. |
328 | |
623 | |
329 | Using this function has the advantage that its output ends up in the |
624 | Using this function has the advantage that its output ends up in the |
330 | correct place, e.g. on stderr of the connecting urxvtc client. |
625 | correct place, e.g. on stderr of the connecting urxvtc client. |
331 | |
626 | |
|
|
627 | Messages have a size limit of 1023 bytes currently. |
|
|
628 | |
332 | =item $time = urxvt::NOW |
629 | =item $time = urxvt::NOW |
333 | |
630 | |
334 | Returns the "current time" (as per the event loop). |
631 | Returns the "current time" (as per the event loop). |
|
|
632 | |
|
|
633 | =item urxvt::CurrentTime |
|
|
634 | |
|
|
635 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
636 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
637 | Button4Mask, Button5Mask, AnyModifier |
|
|
638 | |
|
|
639 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
640 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
641 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
642 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
643 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
644 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
645 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
646 | |
|
|
647 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
648 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
649 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
650 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
651 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
652 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
653 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
|
|
654 | |
|
|
655 | Various constants for use in X calls and event processing. |
335 | |
656 | |
336 | =back |
657 | =back |
337 | |
658 | |
338 | =head2 RENDITION |
659 | =head2 RENDITION |
339 | |
660 | |
… | |
… | |
366 | |
687 | |
367 | =item $background = urxvt::GET_BASEBG $rend |
688 | =item $background = urxvt::GET_BASEBG $rend |
368 | |
689 | |
369 | Return the foreground/background colour index, respectively. |
690 | Return the foreground/background colour index, respectively. |
370 | |
691 | |
371 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
692 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
372 | |
693 | |
373 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
694 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
374 | |
695 | |
375 | Replace the foreground/background colour in the rendition mask with the |
696 | Replace the foreground/background colour in the rendition mask with the |
376 | specified one. |
697 | specified one. |
377 | |
698 | |
378 | =item $value = urxvt::GET_CUSTOM ($rend) |
699 | =item $value = urxvt::GET_CUSTOM $rend |
379 | |
700 | |
380 | Return the "custom" value: Every rendition has 5 bits for use by |
701 | Return the "custom" value: Every rendition has 5 bits for use by |
381 | extensions. They can be set and changed as you like and are initially |
702 | extensions. They can be set and changed as you like and are initially |
382 | zero. |
703 | zero. |
383 | |
704 | |
384 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
705 | =item $rend = urxvt::SET_CUSTOM $rend, $new_value |
385 | |
706 | |
386 | Change the custom value. |
707 | Change the custom value. |
387 | |
708 | |
388 | =back |
709 | =back |
389 | |
710 | |
390 | =cut |
711 | =cut |
391 | |
712 | |
392 | package urxvt; |
|
|
393 | |
|
|
394 | use strict; |
|
|
395 | use Scalar::Util (); |
|
|
396 | |
|
|
397 | our $TERM; |
|
|
398 | our @HOOKNAME; |
|
|
399 | our $LIBDIR; |
|
|
400 | |
|
|
401 | BEGIN { |
713 | BEGIN { |
402 | urxvt->bootstrap; |
|
|
403 | |
|
|
404 | # overwrite perl's warn |
714 | # overwrite perl's warn |
405 | *CORE::GLOBAL::warn = sub { |
715 | *CORE::GLOBAL::warn = sub { |
406 | my $msg = join "", @_; |
716 | my $msg = join "", @_; |
407 | $msg .= "\n" |
717 | $msg .= "\n" |
408 | unless $msg =~ /\n$/; |
718 | unless $msg =~ /\n$/; |
409 | urxvt::warn ($msg); |
719 | urxvt::warn ($msg); |
410 | }; |
720 | }; |
411 | } |
721 | } |
412 | |
722 | |
413 | my @hook_count; |
|
|
414 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
723 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
415 | |
724 | |
416 | sub verbose { |
725 | sub verbose { |
417 | my ($level, $msg) = @_; |
726 | my ($level, $msg) = @_; |
418 | warn "$msg\n" if $level <= $verbosity; |
727 | warn "$msg\n" if $level <= $verbosity; |
419 | } |
728 | } |
420 | |
729 | |
421 | # find on_xxx subs in the package and register them |
|
|
422 | # as hooks |
|
|
423 | sub register_package($) { |
|
|
424 | my ($pkg) = @_; |
|
|
425 | |
|
|
426 | for my $htype (0.. $#HOOKNAME) { |
|
|
427 | my $name = $HOOKNAME[$htype]; |
|
|
428 | |
|
|
429 | my $ref = $pkg->can ("on_" . lc $name) |
|
|
430 | or next; |
|
|
431 | |
|
|
432 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
|
|
433 | $hook_count[$htype]++ |
|
|
434 | or set_should_invoke $htype, 1; |
|
|
435 | } |
|
|
436 | } |
|
|
437 | |
|
|
438 | my $extension_pkg = "extension0000"; |
|
|
439 | my %extension_pkg; |
730 | my %extension_pkg; |
440 | |
731 | |
441 | # load a single script into its own package, once only |
732 | # load a single script into its own package, once only |
442 | sub extension_package($) { |
733 | sub extension_package($) { |
443 | my ($path) = @_; |
734 | my ($path) = @_; |
444 | |
735 | |
445 | $extension_pkg{$path} ||= do { |
736 | $extension_pkg{$path} ||= do { |
446 | my $pkg = "urxvt::" . ($extension_pkg++); |
737 | $path =~ /([^\/\\]+)$/; |
|
|
738 | my $pkg = $1; |
|
|
739 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
740 | $pkg = "urxvt::ext::$pkg"; |
447 | |
741 | |
448 | verbose 3, "loading extension '$path' into package '$pkg'"; |
742 | verbose 3, "loading extension '$path' into package '$pkg'"; |
449 | |
743 | |
450 | open my $fh, "<:raw", $path |
744 | open my $fh, "<:raw", $path |
451 | or die "$path: $!"; |
745 | or die "$path: $!"; |
452 | |
746 | |
|
|
747 | my $source = |
453 | my $source = "package $pkg; use strict; use utf8;\n" |
748 | "package $pkg; use strict; use utf8;\n" |
454 | . "use base urxvt::term::proxy::;\n" |
|
|
455 | . "#line 1 \"$path\"\n{\n" |
749 | . "#line 1 \"$path\"\n{\n" |
456 | . (do { local $/; <$fh> }) |
750 | . (do { local $/; <$fh> }) |
457 | . "\n};\n1"; |
751 | . "\n};\n1"; |
458 | |
752 | |
|
|
753 | eval $source |
459 | eval $source or die "$path: $@"; |
754 | or die "$path: $@"; |
460 | |
755 | |
461 | $pkg |
756 | $pkg |
462 | } |
757 | } |
463 | } |
758 | } |
464 | |
759 | |
… | |
… | |
469 | local $TERM = shift; |
764 | local $TERM = shift; |
470 | my $htype = shift; |
765 | my $htype = shift; |
471 | |
766 | |
472 | if ($htype == 0) { # INIT |
767 | if ($htype == 0) { # INIT |
473 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
768 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
|
|
769 | |
|
|
770 | my %ext_arg; |
474 | |
771 | |
|
|
772 | { |
|
|
773 | my @init = @TERM_INIT; |
|
|
774 | @TERM_INIT = (); |
|
|
775 | $_->($TERM) for @init; |
|
|
776 | my @pkg = @TERM_EXT; |
|
|
777 | @TERM_EXT = (); |
|
|
778 | $TERM->register_package ($_) for @pkg; |
|
|
779 | } |
|
|
780 | |
475 | for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
781 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
|
|
782 | if ($_ eq "default") { |
|
|
783 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
|
|
784 | } elsif (/^-(.*)$/) { |
|
|
785 | delete $ext_arg{$1}; |
|
|
786 | } elsif (/^([^<]+)<(.*)>$/) { |
|
|
787 | push @{ $ext_arg{$1} }, $2; |
|
|
788 | } else { |
|
|
789 | $ext_arg{$_} ||= []; |
|
|
790 | } |
|
|
791 | } |
|
|
792 | |
|
|
793 | while (my ($ext, $argv) = each %ext_arg) { |
476 | my @files = grep -f $_, map "$_/$ext", @dirs; |
794 | my @files = grep -f $_, map "$_/$ext", @dirs; |
477 | |
795 | |
478 | if (@files) { |
796 | if (@files) { |
479 | register_package extension_package $files[0]; |
797 | $TERM->register_package (extension_package $files[0], $argv); |
480 | } else { |
798 | } else { |
481 | warn "perl extension '$ext' not found in perl library search path\n"; |
799 | warn "perl extension '$ext' not found in perl library search path\n"; |
482 | } |
800 | } |
483 | } |
801 | } |
|
|
802 | |
|
|
803 | eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); |
|
|
804 | warn $@ if $@; |
484 | } |
805 | } |
485 | |
806 | |
486 | $retval = undef; |
807 | $retval = undef; |
487 | |
808 | |
488 | if (my $cb = $TERM->{_hook}[$htype]) { |
809 | if (my $cb = $TERM->{_hook}[$htype]) { |
… | |
… | |
490 | if $verbosity >= 10; |
811 | if $verbosity >= 10; |
491 | |
812 | |
492 | keys %$cb; |
813 | keys %$cb; |
493 | |
814 | |
494 | while (my ($pkg, $cb) = each %$cb) { |
815 | while (my ($pkg, $cb) = each %$cb) { |
495 | eval { |
816 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
496 | $retval = $cb->( |
817 | $retval ||= $retval_; |
497 | $TERM->{_pkg}{$pkg} ||= do { |
|
|
498 | my $proxy = bless { }, $pkg; |
|
|
499 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
500 | $proxy |
|
|
501 | }, |
|
|
502 | @_, |
|
|
503 | ) and last; |
|
|
504 | }; |
|
|
505 | warn $@ if $@;#d# |
|
|
506 | } |
|
|
507 | } |
|
|
508 | |
818 | |
509 | if ($htype == 1) { # DESTROY |
819 | if ($@) { |
510 | # remove hooks if unused |
820 | $TERM->ungrab; # better to lose the grab than the session |
511 | if (my $hook = $TERM->{_hook}) { |
821 | warn $@; |
512 | for my $htype (0..$#$hook) { |
|
|
513 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
514 | or set_should_invoke $htype, 0; |
|
|
515 | } |
822 | } |
516 | } |
823 | } |
517 | |
824 | |
|
|
825 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
826 | if $verbosity >= 11; |
|
|
827 | } |
|
|
828 | |
|
|
829 | if ($htype == 1) { # DESTROY |
518 | # clear package objects |
830 | # clear package objects |
519 | %$_ = () for values %{ $TERM->{_pkg} }; |
831 | %$_ = () for values %{ $TERM->{_pkg} }; |
520 | |
832 | |
521 | # clear package |
833 | # clear package |
522 | %$TERM = (); |
834 | %$TERM = (); |
523 | } |
835 | } |
524 | |
836 | |
525 | $retval |
837 | $retval |
526 | } |
838 | } |
527 | |
839 | |
528 | sub urxvt::term::proxy::AUTOLOAD { |
840 | # urxvt::term::extension |
529 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
841 | |
|
|
842 | package urxvt::term::extension; |
|
|
843 | |
|
|
844 | sub enable { |
|
|
845 | my ($self, %hook) = @_; |
|
|
846 | my $pkg = $self->{_pkg}; |
|
|
847 | |
|
|
848 | while (my ($name, $cb) = each %hook) { |
|
|
849 | my $htype = $HOOKTYPE{uc $name}; |
|
|
850 | defined $htype |
|
|
851 | or Carp::croak "unsupported hook type '$name'"; |
|
|
852 | |
|
|
853 | $self->set_should_invoke ($htype, +1) |
|
|
854 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
|
|
855 | |
|
|
856 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
857 | } |
|
|
858 | } |
|
|
859 | |
|
|
860 | sub disable { |
|
|
861 | my ($self, @hook) = @_; |
|
|
862 | my $pkg = $self->{_pkg}; |
|
|
863 | |
|
|
864 | for my $name (@hook) { |
|
|
865 | my $htype = $HOOKTYPE{uc $name}; |
|
|
866 | defined $htype |
|
|
867 | or Carp::croak "unsupported hook type '$name'"; |
|
|
868 | |
|
|
869 | $self->set_should_invoke ($htype, -1) |
|
|
870 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
|
|
871 | } |
|
|
872 | } |
|
|
873 | |
|
|
874 | our $AUTOLOAD; |
|
|
875 | |
|
|
876 | sub AUTOLOAD { |
|
|
877 | $AUTOLOAD =~ /:([^:]+)$/ |
530 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
878 | or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable"; |
531 | |
879 | |
532 | eval qq{ |
880 | eval qq{ |
533 | sub $urxvt::term::proxy::AUTOLOAD { |
881 | sub $AUTOLOAD { |
534 | my \$proxy = shift; |
882 | my \$proxy = shift; |
535 | \$proxy->{term}->$1 (\@_) |
883 | \$proxy->{term}->$1 (\@_) |
536 | } |
884 | } |
537 | 1 |
885 | 1 |
538 | } or die "FATAL: unable to compile method forwarder: $@"; |
886 | } or die "FATAL: unable to compile method forwarder: $@"; |
539 | |
887 | |
540 | goto &$urxvt::term::proxy::AUTOLOAD; |
888 | goto &$AUTOLOAD; |
541 | } |
889 | } |
|
|
890 | |
|
|
891 | sub DESTROY { |
|
|
892 | # nop |
|
|
893 | } |
|
|
894 | |
|
|
895 | # urxvt::destroy_hook |
542 | |
896 | |
543 | sub urxvt::destroy_hook::DESTROY { |
897 | sub urxvt::destroy_hook::DESTROY { |
544 | ${$_[0]}->(); |
898 | ${$_[0]}->(); |
545 | } |
899 | } |
546 | |
900 | |
547 | sub urxvt::destroy_hook(&) { |
901 | sub urxvt::destroy_hook(&) { |
548 | bless \shift, urxvt::destroy_hook:: |
902 | bless \shift, urxvt::destroy_hook:: |
549 | } |
903 | } |
550 | |
904 | |
|
|
905 | package urxvt::anyevent; |
|
|
906 | |
|
|
907 | =head2 The C<urxvt::anyevent> Class |
|
|
908 | |
|
|
909 | The sole purpose of this class is to deliver an interface to the |
|
|
910 | C<AnyEvent> module - any module using it will work inside urxvt without |
|
|
911 | further programming. The only exception is that you cannot wait on |
|
|
912 | condition variables, but non-blocking condvar use is ok. What this means |
|
|
913 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
914 | work. |
|
|
915 | |
|
|
916 | =cut |
|
|
917 | |
|
|
918 | our $VERSION = 1; |
|
|
919 | |
|
|
920 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
|
|
921 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
|
|
922 | |
|
|
923 | sub timer { |
|
|
924 | my ($class, %arg) = @_; |
|
|
925 | |
|
|
926 | my $cb = $arg{cb}; |
|
|
927 | |
|
|
928 | urxvt::timer |
|
|
929 | ->new |
|
|
930 | ->start (urxvt::NOW + $arg{after}) |
|
|
931 | ->cb (sub { |
|
|
932 | $_[0]->stop; # need to cancel manually |
|
|
933 | $cb->(); |
|
|
934 | }) |
|
|
935 | } |
|
|
936 | |
|
|
937 | sub io { |
|
|
938 | my ($class, %arg) = @_; |
|
|
939 | |
|
|
940 | my $cb = $arg{cb}; |
|
|
941 | |
|
|
942 | bless [$arg{fh}, urxvt::iow |
|
|
943 | ->new |
|
|
944 | ->fd (fileno $arg{fh}) |
|
|
945 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
|
|
946 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
|
|
947 | ->start |
|
|
948 | ->cb (sub { |
|
|
949 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
950 | . ($_[1] & 2 ? 'w' : '')); |
|
|
951 | })], |
|
|
952 | urxvt::anyevent:: |
|
|
953 | } |
|
|
954 | |
|
|
955 | sub DESTROY { |
|
|
956 | $_[0][1]->stop; |
|
|
957 | } |
|
|
958 | |
|
|
959 | sub condvar { |
|
|
960 | bless \my $flag, urxvt::anyevent::condvar:: |
|
|
961 | } |
|
|
962 | |
|
|
963 | sub urxvt::anyevent::condvar::broadcast { |
|
|
964 | ${$_[0]}++; |
|
|
965 | } |
|
|
966 | |
|
|
967 | sub urxvt::anyevent::condvar::wait { |
|
|
968 | unless (${$_[0]}) { |
|
|
969 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
|
|
970 | } |
|
|
971 | } |
|
|
972 | |
|
|
973 | package urxvt::term; |
|
|
974 | |
551 | =head2 The C<urxvt::term> Class |
975 | =head2 The C<urxvt::term> Class |
552 | |
976 | |
553 | =over 4 |
977 | =over 4 |
554 | |
978 | |
|
|
979 | =cut |
|
|
980 | |
|
|
981 | # find on_xxx subs in the package and register them |
|
|
982 | # as hooks |
|
|
983 | sub register_package { |
|
|
984 | my ($self, $pkg, $argv) = @_; |
|
|
985 | |
|
|
986 | no strict 'refs'; |
|
|
987 | |
|
|
988 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
989 | |
|
|
990 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
991 | |
|
|
992 | my $proxy = bless { |
|
|
993 | _pkg => $pkg, |
|
|
994 | argv => $argv, |
|
|
995 | }, $pkg; |
|
|
996 | Scalar::Util::weaken ($proxy->{term} = $self); |
|
|
997 | |
|
|
998 | $self->{_pkg}{$pkg} = $proxy; |
|
|
999 | |
|
|
1000 | for my $name (@HOOKNAME) { |
|
|
1001 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
|
|
1002 | $proxy->enable ($name => $ref); |
|
|
1003 | } |
|
|
1004 | } |
|
|
1005 | } |
|
|
1006 | |
|
|
1007 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
|
|
1008 | |
|
|
1009 | Creates a new terminal, very similar as if you had started it with system |
|
|
1010 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
|
|
1011 | hash which defines the environment of the new terminal. |
|
|
1012 | |
|
|
1013 | Croaks (and probably outputs an error message) if the new instance |
|
|
1014 | couldn't be created. Returns C<undef> if the new instance didn't |
|
|
1015 | initialise perl, and the terminal object otherwise. The C<init> and |
|
|
1016 | C<start> hooks will be called during this call. |
|
|
1017 | |
|
|
1018 | =cut |
|
|
1019 | |
|
|
1020 | sub new { |
|
|
1021 | my ($class, $env, @args) = @_; |
|
|
1022 | |
|
|
1023 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
|
|
1024 | } |
|
|
1025 | |
555 | =item $term->destroy |
1026 | =item $term->destroy |
556 | |
1027 | |
557 | Destroy the terminal object (close the window, free resources etc.). |
1028 | Destroy the terminal object (close the window, free resources |
|
|
1029 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
|
|
1030 | watchers (timers, io watchers) are still active. |
|
|
1031 | |
|
|
1032 | =item $term->exec_async ($cmd[, @args]) |
|
|
1033 | |
|
|
1034 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
1035 | ("starts") programs in the background. This function takes care of setting |
|
|
1036 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
1037 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
1038 | |
|
|
1039 | Returns the pid of the subprocess or C<undef> on error. |
|
|
1040 | |
|
|
1041 | =cut |
|
|
1042 | |
|
|
1043 | sub exec_async { |
|
|
1044 | my $self = shift; |
|
|
1045 | |
|
|
1046 | my $pid = fork; |
|
|
1047 | |
|
|
1048 | return $pid |
|
|
1049 | if !defined $pid or $pid; |
|
|
1050 | |
|
|
1051 | %ENV = %{ $self->env }; |
|
|
1052 | |
|
|
1053 | exec @_; |
|
|
1054 | urxvt::_exit 255; |
|
|
1055 | } |
|
|
1056 | |
|
|
1057 | =item $isset = $term->option ($optval[, $set]) |
|
|
1058 | |
|
|
1059 | Returns true if the option specified by C<$optval> is enabled, and |
|
|
1060 | optionally change it. All option values are stored by name in the hash |
|
|
1061 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
|
|
1062 | |
|
|
1063 | Here is a a likely non-exhaustive list of option names, please see the |
|
|
1064 | source file F</src/optinc.h> to see the actual list: |
|
|
1065 | |
|
|
1066 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
|
|
1067 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
|
|
1068 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
|
|
1069 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
|
|
1070 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
|
|
1071 | transparent tripleclickwords utmpInhibit visualBell |
558 | |
1072 | |
559 | =item $value = $term->resource ($name[, $newval]) |
1073 | =item $value = $term->resource ($name[, $newval]) |
560 | |
1074 | |
561 | Returns the current resource value associated with a given name and |
1075 | Returns the current resource value associated with a given name and |
562 | optionally sets a new value. Setting values is most useful in the C<init> |
1076 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
572 | |
1086 | |
573 | Please note that resource strings will currently only be freed when the |
1087 | Please note that resource strings will currently only be freed when the |
574 | terminal is destroyed, so changing options frequently will eat memory. |
1088 | terminal is destroyed, so changing options frequently will eat memory. |
575 | |
1089 | |
576 | Here is a a likely non-exhaustive list of resource names, not all of which |
1090 | Here is a a likely non-exhaustive list of resource names, not all of which |
577 | are supported in every build, please see the source to see the actual |
1091 | are supported in every build, please see the source file F</src/rsinc.h> |
578 | list: |
1092 | to see the actual list: |
579 | |
1093 | |
580 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1094 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
581 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1095 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
582 | display_name embed ext_bwidth fade font geometry hold iconName |
1096 | display_name embed ext_bwidth fade font geometry hold iconName |
583 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1097 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
584 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1098 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
585 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1099 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
586 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1100 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
587 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1101 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
588 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1102 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
589 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1103 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
590 | shade term_name title transparent transparent_all tripleclickwords |
1104 | secondaryScreen secondaryScroll selectstyle shade term_name title |
591 | utmpInhibit visualBell |
1105 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
|
|
1106 | visualBell |
592 | |
1107 | |
593 | =cut |
1108 | =cut |
594 | |
1109 | |
595 | sub urxvt::term::resource($$;$) { |
1110 | sub resource($$;$) { |
596 | my ($self, $name) = (shift, shift); |
1111 | my ($self, $name) = (shift, shift); |
597 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1112 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
598 | &urxvt::term::_resource |
1113 | &urxvt::term::_resource |
599 | } |
1114 | } |
600 | |
1115 | |
|
|
1116 | =item $value = $term->x_resource ($pattern) |
|
|
1117 | |
|
|
1118 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
1119 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
|
|
1120 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
|
|
1121 | resource with that pattern exists. |
|
|
1122 | |
|
|
1123 | This method should only be called during the C<on_start> hook, as there is |
|
|
1124 | only one resource database per display, and later invocations might return |
|
|
1125 | the wrong resources. |
|
|
1126 | |
|
|
1127 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
|
|
1128 | |
|
|
1129 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
1130 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
|
|
1131 | |
601 | =item $rend = $term->rstyle ([$new_rstyle]) |
1132 | =item $rend = $term->rstyle ([$new_rstyle]) |
602 | |
1133 | |
603 | Return and optionally change the current rendition. Text that is output by |
1134 | Return and optionally change the current rendition. Text that is output by |
604 | the terminal application will use this style. |
1135 | the terminal application will use this style. |
605 | |
1136 | |
… | |
… | |
615 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1146 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
616 | |
1147 | |
617 | Return the current values of the selection mark, begin or end positions, |
1148 | Return the current values of the selection mark, begin or end positions, |
618 | and optionally set them to new values. |
1149 | and optionally set them to new values. |
619 | |
1150 | |
|
|
1151 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
1152 | |
|
|
1153 | Tries to make a selection as set by C<selection_beg> and |
|
|
1154 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
1155 | rectangular selection will be made. This is the prefered function to make |
|
|
1156 | a selection. |
|
|
1157 | |
620 | =item $success = $term->selection_grab ($eventtime) |
1158 | =item $success = $term->selection_grab ($eventtime) |
621 | |
1159 | |
622 | Try to request the primary selection from the server (for example, as set |
1160 | Try to request the primary selection text from the server (for example, as |
623 | by the next method). |
1161 | set by the next method). No visual feedback will be given. This function |
|
|
1162 | is mostly useful from within C<on_sel_grab> hooks. |
624 | |
1163 | |
625 | =item $oldtext = $term->selection ([$newtext]) |
1164 | =item $oldtext = $term->selection ([$newtext]) |
626 | |
1165 | |
627 | Return the current selection text and optionally replace it by C<$newtext>. |
1166 | Return the current selection text and optionally replace it by C<$newtext>. |
628 | |
1167 | |
629 | #=item $term->overlay ($x, $y, $text) |
1168 | =item $term->overlay_simple ($x, $y, $text) |
630 | # |
1169 | |
631 | #Create a simple multi-line overlay box. See the next method for details. |
1170 | Create a simple multi-line overlay box. See the next method for details. |
632 | # |
1171 | |
633 | #=cut |
1172 | =cut |
634 | # |
1173 | |
635 | #sub urxvt::term::scr_overlay { |
1174 | sub overlay_simple { |
636 | # my ($self, $x, $y, $text) = @_; |
1175 | my ($self, $x, $y, $text) = @_; |
637 | # |
1176 | |
638 | # my @lines = split /\n/, $text; |
1177 | my @lines = split /\n/, $text; |
639 | # |
1178 | |
640 | # my $w = 0; |
1179 | my $w = List::Util::max map $self->strwidth ($_), @lines; |
641 | # for (map $self->strwidth ($_), @lines) { |
1180 | |
642 | # $w = $_ if $w < $_; |
|
|
643 | # } |
|
|
644 | # |
|
|
645 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
1181 | my $overlay = $self->overlay ($x, $y, $w, scalar @lines); |
646 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
1182 | $overlay->set (0, $_, $lines[$_]) for 0.. $#lines; |
647 | #} |
1183 | |
|
|
1184 | $overlay |
|
|
1185 | } |
648 | |
1186 | |
649 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
1187 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
650 | |
1188 | |
651 | Create a new (empty) overlay at the given position with the given |
1189 | Create a new (empty) overlay at the given position with the given |
652 | width/height. C<$rstyle> defines the initial rendition style |
1190 | width/height. C<$rstyle> defines the initial rendition style |
… | |
… | |
687 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
1225 | C<$event> I<must> be the event causing the menu to pop up (a button event, |
688 | currently). |
1226 | currently). |
689 | |
1227 | |
690 | =cut |
1228 | =cut |
691 | |
1229 | |
692 | sub urxvt::term::popup { |
1230 | sub popup { |
693 | my ($self, $event) = @_; |
1231 | my ($self, $event) = @_; |
694 | |
1232 | |
695 | $self->grab ($event->{time}, 1) |
1233 | $self->grab ($event->{time}, 1) |
696 | or return; |
1234 | or return; |
697 | |
1235 | |
… | |
… | |
719 | |
1257 | |
720 | =item $string = $term->locale_decode ($octets) |
1258 | =item $string = $term->locale_decode ($octets) |
721 | |
1259 | |
722 | Convert the given locale-encoded octets into a perl string. |
1260 | Convert the given locale-encoded octets into a perl string. |
723 | |
1261 | |
|
|
1262 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
|
|
1263 | |
|
|
1264 | XORs the rendition values in the given span with the provided value |
|
|
1265 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
|
|
1266 | refresh hooks to provide effects similar to the selection. |
|
|
1267 | |
|
|
1268 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
|
|
1269 | |
|
|
1270 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
|
|
1271 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
|
|
1272 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
|
|
1273 | it instead. Both styles I<MUST NOT> contain font styles. |
|
|
1274 | |
|
|
1275 | =item $term->scr_bell |
|
|
1276 | |
|
|
1277 | Ring the bell! |
|
|
1278 | |
724 | =item $term->scr_add_lines ($string) |
1279 | =item $term->scr_add_lines ($string) |
725 | |
1280 | |
726 | Write the given text string to the screen, as if output by the application |
1281 | Write the given text string to the screen, as if output by the application |
727 | running inside the terminal. It may not contain command sequences (escape |
1282 | running inside the terminal. It may not contain command sequences (escape |
728 | codes), but is free to use line feeds, carriage returns and tabs. The |
1283 | codes), but is free to use line feeds, carriage returns and tabs. The |
… | |
… | |
730 | |
1285 | |
731 | Normally its not a good idea to use this function, as programs might be |
1286 | Normally its not a good idea to use this function, as programs might be |
732 | confused by changes in cursor position or scrolling. Its useful inside a |
1287 | confused by changes in cursor position or scrolling. Its useful inside a |
733 | C<on_add_lines> hook, though. |
1288 | C<on_add_lines> hook, though. |
734 | |
1289 | |
|
|
1290 | =item $term->scr_change_screen ($screen) |
|
|
1291 | |
|
|
1292 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1293 | |
735 | =item $term->cmd_parse ($octets) |
1294 | =item $term->cmd_parse ($octets) |
736 | |
1295 | |
737 | Similar to C<scr_add_lines>, but the argument must be in the |
1296 | Similar to C<scr_add_lines>, but the argument must be in the |
738 | locale-specific encoding of the terminal and can contain command sequences |
1297 | locale-specific encoding of the terminal and can contain command sequences |
739 | (escape codes) that will be interpreted. |
1298 | (escape codes) that will be interpreted. |
… | |
… | |
742 | |
1301 | |
743 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1302 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
744 | pass characters instead of octets, you should convert your strings first |
1303 | pass characters instead of octets, you should convert your strings first |
745 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1304 | to the locale-specific encoding using C<< $term->locale_encode >>. |
746 | |
1305 | |
|
|
1306 | =item $old_events = $term->pty_ev_events ([$new_events]) |
|
|
1307 | |
|
|
1308 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
1309 | be used to suppress input and output handling to the pty/tty. See the |
|
|
1310 | description of C<< urxvt::timer->events >>. Make sure to always restore |
|
|
1311 | the previous value. |
|
|
1312 | |
747 | =item $windowid = $term->parent |
1313 | =item $windowid = $term->parent |
748 | |
1314 | |
749 | Return the window id of the toplevel window. |
1315 | Return the window id of the toplevel window. |
750 | |
1316 | |
751 | =item $windowid = $term->vt |
1317 | =item $windowid = $term->vt |
752 | |
1318 | |
753 | Return the window id of the terminal window. |
1319 | Return the window id of the terminal window. |
754 | |
1320 | |
|
|
1321 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1322 | |
|
|
1323 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1324 | to receive pointer events all the times: |
|
|
1325 | |
|
|
1326 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1327 | |
755 | =item $window_width = $term->width |
1328 | =item $window_width = $term->width |
756 | |
1329 | |
757 | =item $window_height = $term->height |
1330 | =item $window_height = $term->height |
758 | |
1331 | |
759 | =item $font_width = $term->fwidth |
1332 | =item $font_width = $term->fwidth |
… | |
… | |
772 | |
1345 | |
773 | =item $max_scrollback = $term->saveLines |
1346 | =item $max_scrollback = $term->saveLines |
774 | |
1347 | |
775 | =item $nrow_plus_saveLines = $term->total_rows |
1348 | =item $nrow_plus_saveLines = $term->total_rows |
776 | |
1349 | |
777 | =item $lines_in_scrollback = $term->nsaved |
1350 | =item $topmost_scrollback_row = $term->top_row |
778 | |
1351 | |
779 | Return various integers describing terminal characteristics. |
1352 | Return various integers describing terminal characteristics. |
780 | |
1353 | |
|
|
1354 | =item $x_display = $term->display_id |
|
|
1355 | |
|
|
1356 | Return the DISPLAY used by rxvt-unicode. |
|
|
1357 | |
|
|
1358 | =item $lc_ctype = $term->locale |
|
|
1359 | |
|
|
1360 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
1361 | |
|
|
1362 | =item $env = $term->env |
|
|
1363 | |
|
|
1364 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1365 | similar to C<\%ENV>. |
|
|
1366 | |
|
|
1367 | =cut |
|
|
1368 | |
|
|
1369 | sub env { |
|
|
1370 | if (my $env = $_[0]->_env) { |
|
|
1371 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
|
|
1372 | } else { |
|
|
1373 | +{ %ENV } |
|
|
1374 | } |
|
|
1375 | } |
|
|
1376 | |
|
|
1377 | =item $modifiermask = $term->ModLevel3Mask |
|
|
1378 | |
|
|
1379 | =item $modifiermask = $term->ModMetaMask |
|
|
1380 | |
|
|
1381 | =item $modifiermask = $term->ModNumLockMask |
|
|
1382 | |
|
|
1383 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
|
|
1384 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1385 | |
|
|
1386 | =item $screen = $term->current_screen |
|
|
1387 | |
|
|
1388 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1389 | |
|
|
1390 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1391 | |
|
|
1392 | Returns wether the cursor is currently hidden or not. |
|
|
1393 | |
781 | =item $view_start = $term->view_start ([$newvalue]) |
1394 | =item $view_start = $term->view_start ([$newvalue]) |
782 | |
1395 | |
783 | Returns the negative row number of the topmost line. Minimum value is |
1396 | Returns the row number of the topmost displayed line. Maximum value is |
784 | C<0>, which displays the normal terminal contents. Larger values scroll |
1397 | C<0>, which displays the normal terminal contents. Lower values scroll |
785 | this many lines into the scrollback buffer. |
1398 | this many lines into the scrollback buffer. |
786 | |
1399 | |
787 | =item $term->want_refresh |
1400 | =item $term->want_refresh |
788 | |
1401 | |
789 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1402 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
803 | If C<$new_text> is specified, it will replace characters in the current |
1416 | If C<$new_text> is specified, it will replace characters in the current |
804 | line, starting at column C<$start_col> (default C<0>), which is useful |
1417 | line, starting at column C<$start_col> (default C<0>), which is useful |
805 | to replace only parts of a line. The font index in the rendition will |
1418 | to replace only parts of a line. The font index in the rendition will |
806 | automatically be updated. |
1419 | automatically be updated. |
807 | |
1420 | |
808 | C<$text> is in a special encoding: tabs and wide characters that use more |
1421 | C<$text> is in a special encoding: tabs and wide characters that use |
809 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1422 | more than one cell when displayed are padded with C<$urxvt::NOCHAR> |
810 | (C<chr 65535>). Characters with combining characters and other characters |
1423 | characters. Characters with combining characters and other characters that |
811 | that do not fit into the normal tetx encoding will be replaced with |
1424 | do not fit into the normal tetx encoding will be replaced with characters |
812 | characters in the private use area. |
1425 | in the private use area. |
813 | |
1426 | |
814 | You have to obey this encoding when changing text. The advantage is |
1427 | You have to obey this encoding when changing text. The advantage is |
815 | that C<substr> and similar functions work on screen cells and not on |
1428 | that C<substr> and similar functions work on screen cells and not on |
816 | characters. |
1429 | characters. |
817 | |
1430 | |
… | |
… | |
868 | Return the row number of the first/last row of the line, respectively. |
1481 | Return the row number of the first/last row of the line, respectively. |
869 | |
1482 | |
870 | =item $offset = $line->offset_of ($row, $col) |
1483 | =item $offset = $line->offset_of ($row, $col) |
871 | |
1484 | |
872 | Returns the character offset of the given row|col pair within the logical |
1485 | Returns the character offset of the given row|col pair within the logical |
873 | line. |
1486 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1487 | offsets outside the string. |
874 | |
1488 | |
875 | =item ($row, $col) = $line->coord_of ($offset) |
1489 | =item ($row, $col) = $line->coord_of ($offset) |
876 | |
1490 | |
877 | Translates a string offset into terminal coordinates again. |
1491 | Translates a string offset into terminal coordinates again. |
878 | |
1492 | |
879 | =back |
1493 | =back |
880 | |
1494 | |
881 | =cut |
1495 | =cut |
882 | |
1496 | |
883 | sub urxvt::term::line { |
1497 | sub line { |
884 | my ($self, $row) = @_; |
1498 | my ($self, $row) = @_; |
885 | |
1499 | |
886 | my $maxrow = $self->nrow - 1; |
1500 | my $maxrow = $self->nrow - 1; |
887 | |
1501 | |
888 | my ($beg, $end) = ($row, $row); |
1502 | my ($beg, $end) = ($row, $row); |
… | |
… | |
952 | $offset / $self->{ncol} + $self->{beg}, |
1566 | $offset / $self->{ncol} + $self->{beg}, |
953 | $offset % $self->{ncol} |
1567 | $offset % $self->{ncol} |
954 | ) |
1568 | ) |
955 | } |
1569 | } |
956 | |
1570 | |
957 | =item ($row, $col) = $line->coord_of ($offset) |
|
|
958 | =item $text = $term->special_encode $string |
1571 | =item $text = $term->special_encode $string |
959 | |
1572 | |
960 | Converts a perl string into the special encoding used by rxvt-unicode, |
1573 | Converts a perl string into the special encoding used by rxvt-unicode, |
961 | where one character corresponds to one screen cell. See |
1574 | where one character corresponds to one screen cell. See |
962 | C<< $term->ROW_t >> for details. |
1575 | C<< $term->ROW_t >> for details. |
… | |
… | |
964 | =item $string = $term->special_decode $text |
1577 | =item $string = $term->special_decode $text |
965 | |
1578 | |
966 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1579 | Converts rxvt-unicodes text reprsentation into a perl string. See |
967 | C<< $term->ROW_t >> for details. |
1580 | C<< $term->ROW_t >> for details. |
968 | |
1581 | |
|
|
1582 | =item $success = $term->grab_button ($button, $modifiermask) |
|
|
1583 | |
|
|
1584 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
1585 | |
|
|
1586 | =item $success = $term->grab ($eventtime[, $sync]) |
|
|
1587 | |
|
|
1588 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1589 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
|
|
1590 | |
|
|
1591 | =item $term->allow_events_async |
|
|
1592 | |
|
|
1593 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1594 | |
|
|
1595 | =item $term->allow_events_sync |
|
|
1596 | |
|
|
1597 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1598 | |
|
|
1599 | =item $term->allow_events_replay |
|
|
1600 | |
|
|
1601 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1602 | recent grab. |
|
|
1603 | |
|
|
1604 | =item $term->ungrab |
|
|
1605 | |
|
|
1606 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1607 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1608 | the session. |
|
|
1609 | |
|
|
1610 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1611 | |
|
|
1612 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1613 | |
|
|
1614 | =item @atoms = $term->XListProperties ($window) |
|
|
1615 | |
|
|
1616 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1617 | |
|
|
1618 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1619 | |
|
|
1620 | =item $term->XDeleteProperty ($window, $property) |
|
|
1621 | |
|
|
1622 | =item $window = $term->DefaultRootWindow |
|
|
1623 | |
|
|
1624 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1625 | |
|
|
1626 | =item $term->XMapWindow ($window) |
|
|
1627 | |
|
|
1628 | =item $term->XUnmapWindow ($window) |
|
|
1629 | |
|
|
1630 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1631 | |
|
|
1632 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1633 | |
|
|
1634 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1635 | |
|
|
1636 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1637 | the source of the display, otherwise those functions map more-or-less |
|
|
1638 | directory onto the X functions of the same name. |
|
|
1639 | |
969 | =back |
1640 | =back |
970 | |
1641 | |
|
|
1642 | =cut |
|
|
1643 | |
|
|
1644 | package urxvt::popup; |
|
|
1645 | |
971 | =head2 The C<urxvt::popup> Class |
1646 | =head2 The C<urxvt::popup> Class |
972 | |
1647 | |
973 | =over 4 |
1648 | =over 4 |
974 | |
1649 | |
975 | =cut |
1650 | =cut |
976 | |
|
|
977 | package urxvt::popup; |
|
|
978 | |
1651 | |
979 | sub add_item { |
1652 | sub add_item { |
980 | my ($self, $item) = @_; |
1653 | my ($self, $item) = @_; |
981 | |
1654 | |
|
|
1655 | $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal}; |
|
|
1656 | $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover}; |
|
|
1657 | $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active}; |
|
|
1658 | |
|
|
1659 | $item->{render} ||= sub { $_[0]{text} }; |
|
|
1660 | |
982 | push @{ $self->{item} }, $item; |
1661 | push @{ $self->{item} }, $item; |
983 | } |
1662 | } |
|
|
1663 | |
|
|
1664 | =item $popup->add_title ($title) |
|
|
1665 | |
|
|
1666 | Adds a non-clickable title to the popup. |
|
|
1667 | |
|
|
1668 | =cut |
|
|
1669 | |
|
|
1670 | sub add_title { |
|
|
1671 | my ($self, $title) = @_; |
|
|
1672 | |
|
|
1673 | $self->add_item ({ |
|
|
1674 | rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, |
|
|
1675 | text => $title, |
|
|
1676 | activate => sub { }, |
|
|
1677 | }); |
|
|
1678 | } |
|
|
1679 | |
|
|
1680 | =item $popup->add_separator ([$sepchr]) |
|
|
1681 | |
|
|
1682 | Creates a separator, optionally using the character given as C<$sepchr>. |
|
|
1683 | |
|
|
1684 | =cut |
|
|
1685 | |
|
|
1686 | sub add_separator { |
|
|
1687 | my ($self, $sep) = @_; |
|
|
1688 | |
|
|
1689 | $sep ||= "="; |
|
|
1690 | |
|
|
1691 | $self->add_item ({ |
|
|
1692 | rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, |
|
|
1693 | text => "", |
|
|
1694 | render => sub { $sep x $self->{term}->ncol }, |
|
|
1695 | activate => sub { }, |
|
|
1696 | }); |
|
|
1697 | } |
|
|
1698 | |
|
|
1699 | =item $popup->add_button ($text, $cb) |
|
|
1700 | |
|
|
1701 | Adds a clickable button to the popup. C<$cb> is called whenever it is |
|
|
1702 | selected. |
|
|
1703 | |
|
|
1704 | =cut |
984 | |
1705 | |
985 | sub add_button { |
1706 | sub add_button { |
986 | my ($self, $text, $cb) = @_; |
1707 | my ($self, $text, $cb) = @_; |
987 | |
1708 | |
988 | $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb }); |
1709 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
989 | } |
1710 | } |
|
|
1711 | |
|
|
1712 | =item $popup->add_toggle ($text, $cb, $initial_value) |
|
|
1713 | |
|
|
1714 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1715 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1716 | argument. |
|
|
1717 | |
|
|
1718 | =cut |
|
|
1719 | |
|
|
1720 | sub add_toggle { |
|
|
1721 | my ($self, $text, $cb, $value) = @_; |
|
|
1722 | |
|
|
1723 | my $item; $item = { |
|
|
1724 | type => "button", |
|
|
1725 | text => " $text", |
|
|
1726 | value => $value, |
|
|
1727 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
|
|
1728 | activate => sub { $cb->($_[1]{value} = !$_[1]{value}); }, |
|
|
1729 | }; |
|
|
1730 | |
|
|
1731 | $self->add_item ($item); |
|
|
1732 | } |
|
|
1733 | |
|
|
1734 | =item $popup->show |
|
|
1735 | |
|
|
1736 | Displays the popup (which is initially hidden). |
|
|
1737 | |
|
|
1738 | =cut |
990 | |
1739 | |
991 | sub show { |
1740 | sub show { |
992 | my ($self) = @_; |
1741 | my ($self) = @_; |
993 | |
1742 | |
994 | local $urxvt::popup::self = $self; |
1743 | local $urxvt::popup::self = $self; |
995 | |
1744 | |
996 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1745 | my $env = $self->{term}->env; |
|
|
1746 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
|
|
1747 | delete $env->{LC_ALL}; |
|
|
1748 | $env->{LC_CTYPE} = $self->{term}->locale; |
|
|
1749 | |
|
|
1750 | urxvt::term->new ($env, "popup", |
|
|
1751 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
1752 | "-pty-fd" => -1, "-sl" => 0, |
|
|
1753 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
997 | "--transient-for" => $self->{term}->parent, |
1754 | "--transient-for" => $self->{term}->parent, |
|
|
1755 | "-display" => $self->{term}->display_id, |
998 | "-pe" => "urxvt-popup") |
1756 | "-pe" => "urxvt-popup") |
999 | or die "unable to create popup window\n"; |
1757 | or die "unable to create popup window\n"; |
1000 | } |
1758 | } |
1001 | |
1759 | |
1002 | sub DESTROY { |
1760 | sub DESTROY { |
1003 | my ($self) = @_; |
1761 | my ($self) = @_; |
1004 | |
1762 | |
|
|
1763 | delete $self->{term}{_destroy}{$self}; |
1005 | $self->{term}->ungrab; |
1764 | $self->{term}->ungrab; |
1006 | } |
1765 | } |
|
|
1766 | |
|
|
1767 | =back |
|
|
1768 | |
|
|
1769 | =cut |
|
|
1770 | |
|
|
1771 | package urxvt::watcher; |
|
|
1772 | |
|
|
1773 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1774 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1775 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1776 | @urxvt::iw::ISA = __PACKAGE__; |
1007 | |
1777 | |
1008 | =head2 The C<urxvt::timer> Class |
1778 | =head2 The C<urxvt::timer> Class |
1009 | |
1779 | |
1010 | This class implements timer watchers/events. Time is represented as a |
1780 | This class implements timer watchers/events. Time is represented as a |
1011 | fractional number of seconds since the epoch. Example: |
1781 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1050 | |
1820 | |
1051 | =item $timer = $timer->start ($tstamp) |
1821 | =item $timer = $timer->start ($tstamp) |
1052 | |
1822 | |
1053 | Set the event trigger time to C<$tstamp> and start the timer. |
1823 | Set the event trigger time to C<$tstamp> and start the timer. |
1054 | |
1824 | |
|
|
1825 | =item $timer = $timer->after ($delay) |
|
|
1826 | |
|
|
1827 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
|
|
1828 | |
1055 | =item $timer = $timer->stop |
1829 | =item $timer = $timer->stop |
1056 | |
1830 | |
1057 | Stop the timer. |
1831 | Stop the timer. |
1058 | |
1832 | |
1059 | =back |
1833 | =back |
… | |
… | |
1064 | |
1838 | |
1065 | $term->{socket} = ... |
1839 | $term->{socket} = ... |
1066 | $term->{iow} = urxvt::iow |
1840 | $term->{iow} = urxvt::iow |
1067 | ->new |
1841 | ->new |
1068 | ->fd (fileno $term->{socket}) |
1842 | ->fd (fileno $term->{socket}) |
1069 | ->events (1) # wait for read data |
1843 | ->events (urxvt::EVENT_READ) |
1070 | ->start |
1844 | ->start |
1071 | ->cb (sub { |
1845 | ->cb (sub { |
1072 | my ($iow, $revents) = @_; |
1846 | my ($iow, $revents) = @_; |
1073 | # $revents must be 1 here, no need to check |
1847 | # $revents must be 1 here, no need to check |
1074 | sysread $term->{socket}, my $buf, 8192 |
1848 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1091 | |
1865 | |
1092 | Set the filedescriptor (not handle) to watch. |
1866 | Set the filedescriptor (not handle) to watch. |
1093 | |
1867 | |
1094 | =item $iow = $iow->events ($eventmask) |
1868 | =item $iow = $iow->events ($eventmask) |
1095 | |
1869 | |
1096 | Set the event mask to watch. Bit #0 (value C<1>) enables watching for read |
1870 | Set the event mask to watch. The only allowed values are |
1097 | data, Bit #1 (value C<2>) enables watching for write data. |
1871 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
|
|
1872 | together, or C<urxvt::EVENT_NONE>. |
1098 | |
1873 | |
1099 | =item $iow = $iow->start |
1874 | =item $iow = $iow->start |
1100 | |
1875 | |
1101 | Start watching for requested events on the given handle. |
1876 | Start watching for requested events on the given handle. |
1102 | |
1877 | |
1103 | =item $iow = $iow->stop |
1878 | =item $iow = $iow->stop |
1104 | |
1879 | |
1105 | Stop watching for events on the given filehandle. |
1880 | Stop watching for events on the given filehandle. |
|
|
1881 | |
|
|
1882 | =back |
|
|
1883 | |
|
|
1884 | =head2 The C<urxvt::iw> Class |
|
|
1885 | |
|
|
1886 | This class implements idle watchers, that get called automatically when |
|
|
1887 | the process is idle. They should return as fast as possible, after doing |
|
|
1888 | some useful work. |
|
|
1889 | |
|
|
1890 | =over 4 |
|
|
1891 | |
|
|
1892 | =item $iw = new urxvt::iw |
|
|
1893 | |
|
|
1894 | Create a new idle watcher object in stopped state. |
|
|
1895 | |
|
|
1896 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1897 | |
|
|
1898 | Set the callback to be called when the watcher triggers. |
|
|
1899 | |
|
|
1900 | =item $timer = $timer->start |
|
|
1901 | |
|
|
1902 | Start the watcher. |
|
|
1903 | |
|
|
1904 | =item $timer = $timer->stop |
|
|
1905 | |
|
|
1906 | Stop the watcher. |
|
|
1907 | |
|
|
1908 | =back |
|
|
1909 | |
|
|
1910 | =head2 The C<urxvt::pw> Class |
|
|
1911 | |
|
|
1912 | This class implements process watchers. They create an event whenever a |
|
|
1913 | process exits, after which they stop automatically. |
|
|
1914 | |
|
|
1915 | my $pid = fork; |
|
|
1916 | ... |
|
|
1917 | $term->{pw} = urxvt::pw |
|
|
1918 | ->new |
|
|
1919 | ->start ($pid) |
|
|
1920 | ->cb (sub { |
|
|
1921 | my ($pw, $exit_status) = @_; |
|
|
1922 | ... |
|
|
1923 | }); |
|
|
1924 | |
|
|
1925 | =over 4 |
|
|
1926 | |
|
|
1927 | =item $pw = new urxvt::pw |
|
|
1928 | |
|
|
1929 | Create a new process watcher in stopped state. |
|
|
1930 | |
|
|
1931 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1932 | |
|
|
1933 | Set the callback to be called when the timer triggers. |
|
|
1934 | |
|
|
1935 | =item $pw = $timer->start ($pid) |
|
|
1936 | |
|
|
1937 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
1938 | |
|
|
1939 | =item $pw = $pw->stop |
|
|
1940 | |
|
|
1941 | Stop the watcher. |
1106 | |
1942 | |
1107 | =back |
1943 | =back |
1108 | |
1944 | |
1109 | =head1 ENVIRONMENT |
1945 | =head1 ENVIRONMENT |
1110 | |
1946 | |
… | |
… | |
1113 | This variable controls the verbosity level of the perl extension. Higher |
1949 | This variable controls the verbosity level of the perl extension. Higher |
1114 | numbers indicate more verbose output. |
1950 | numbers indicate more verbose output. |
1115 | |
1951 | |
1116 | =over 4 |
1952 | =over 4 |
1117 | |
1953 | |
1118 | =item =0 - only fatal messages |
1954 | =item == 0 - fatal messages |
1119 | |
1955 | |
1120 | =item =3 - script loading and management |
1956 | =item >= 3 - script loading and management |
1121 | |
1957 | |
1122 | =item =10 - all events received |
1958 | =item >=10 - all called hooks |
|
|
1959 | |
|
|
1960 | =item >=11 - hook reutrn values |
1123 | |
1961 | |
1124 | =back |
1962 | =back |
1125 | |
1963 | |
1126 | =head1 AUTHOR |
1964 | =head1 AUTHOR |
1127 | |
1965 | |