… | |
… | |
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 (enabled by default) |
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 | Another example: Programs I use often output "absolute path: " at the |
|
|
73 | beginning of a line when they process multiple files. The following |
|
|
74 | pattern matches the filename (note, there is a single space at the very |
|
|
75 | end): |
|
|
76 | |
|
|
77 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
|
|
78 | |
|
|
79 | You can look at the source of the selection extension to see more |
|
|
80 | interesting uses, such as parsing a line from beginning to end. |
|
|
81 | |
|
|
82 | This extension also offers following bindable keyboard commands: |
50 | |
83 | |
51 | =over 4 |
84 | =over 4 |
52 | |
85 | |
53 | =item rot13 |
86 | =item rot13 |
54 | |
87 | |
… | |
… | |
64 | runtime. |
97 | runtime. |
65 | |
98 | |
66 | =item selection-popup (enabled by default) |
99 | =item selection-popup (enabled by default) |
67 | |
100 | |
68 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
101 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
69 | text into various other formats/action. |
102 | text into various other formats/action (such as uri unescaping, perl |
|
|
103 | evaluation, web-browser starting etc.), depending on content. |
70 | |
104 | |
71 | =item digital-clock |
105 | Other extensions can extend this popup menu by pushing a code reference |
|
|
106 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
|
|
107 | popup is displayed. |
72 | |
108 | |
73 | Displays a digital clock using the built-in overlay. |
109 | It's sole argument is the popup menu, which can be modified. The selection |
|
|
110 | is in C<$_>, which can be used to decide wether to add something or not. |
|
|
111 | It should either return nothing or a string and a code reference. The |
|
|
112 | string will be used as button text and the code reference will be called |
|
|
113 | when the button gets activated and should transform C<$_>. |
|
|
114 | |
|
|
115 | The following will add an entry C<a to b> that transforms all C<a>s in |
|
|
116 | the selection to C<b>s, but only if the selection currently contains any |
|
|
117 | C<a>s: |
|
|
118 | |
|
|
119 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
120 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
121 | : () |
|
|
122 | }; |
|
|
123 | |
|
|
124 | =item searchable-scrollback<hotkey> (enabled by default) |
|
|
125 | |
|
|
126 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
127 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
|
|
128 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
129 | screen. |
|
|
130 | |
|
|
131 | Inputting characters appends them to the regex and continues incremental |
|
|
132 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
|
|
133 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
|
|
134 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
135 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
136 | additionally stores the first match in the current line into the primary |
|
|
137 | selection. |
|
|
138 | |
|
|
139 | =item readline (enabled by default) |
|
|
140 | |
|
|
141 | A support package that tries to make editing with readline easier. At the |
|
|
142 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
143 | move the text cursor to this position. It does so by generating as many |
|
|
144 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
145 | for programs that correctly support wide characters). |
|
|
146 | |
|
|
147 | To avoid too many false positives, this is only done when: |
|
|
148 | |
|
|
149 | =over 4 |
|
|
150 | |
|
|
151 | =item - the tty is in ICANON state. |
|
|
152 | |
|
|
153 | =item - the text cursor is visible. |
|
|
154 | |
|
|
155 | =item - the primary screen is currently being displayed. |
|
|
156 | |
|
|
157 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
158 | |
|
|
159 | =back |
|
|
160 | |
|
|
161 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
162 | might interfere with selection creation in harmless ways. |
|
|
163 | |
|
|
164 | =item selection-autotransform |
|
|
165 | |
|
|
166 | This selection allows you to do automatic transforms on a selection |
|
|
167 | whenever a selection is made. |
|
|
168 | |
|
|
169 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
170 | operator) that modify C<$_> as resources: |
|
|
171 | |
|
|
172 | URxvt.selection-autotransform.0: transform |
|
|
173 | URxvt.selection-autotransform.1: transform |
|
|
174 | ... |
|
|
175 | |
|
|
176 | For example, the following will transform selections of the form |
|
|
177 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
178 | $word>: |
|
|
179 | |
|
|
180 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
181 | |
|
|
182 | And this example matches the same,but replaces it with vi-commands you can |
|
|
183 | paste directly into your (vi :) editor: |
|
|
184 | |
|
|
185 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
186 | |
|
|
187 | Of course, this can be modified to suit your needs and your editor :) |
|
|
188 | |
|
|
189 | To expand the example above to typical perl error messages ("XXX at |
|
|
190 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
191 | |
|
|
192 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
193 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
194 | |
|
|
195 | The first line tells the selection code to treat the unchanging part of |
|
|
196 | every error message as a selection pattern, and the second line transforms |
|
|
197 | the message into vi commands to load the file. |
|
|
198 | |
|
|
199 | =item tabbed |
|
|
200 | |
|
|
201 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
202 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
|
|
203 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
204 | button per tab. |
|
|
205 | |
|
|
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
207 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
208 | while B<Shift-Down> creates a new tab. |
74 | |
209 | |
75 | =item mark-urls |
210 | =item mark-urls |
76 | |
211 | |
77 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
212 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
|
|
213 | make them clickable. When middle-clicked, the program specified in the |
|
|
214 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
|
|
215 | the URL as first argument. |
|
|
216 | |
|
|
217 | =item xim-onthespot |
|
|
218 | |
|
|
219 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
220 | not work perfectly, and some input methods don't seem to work well with |
|
|
221 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
222 | kinput2. |
|
|
223 | |
|
|
224 | You enable it by specifying this extension and a preedit style of |
|
|
225 | C<OnTheSpot>, i.e.: |
|
|
226 | |
|
|
227 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
228 | |
|
|
229 | =item automove-background |
|
|
230 | |
|
|
231 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
232 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
233 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
234 | |
|
|
235 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
78 | |
236 | |
79 | =item block-graphics-to-ascii |
237 | =item block-graphics-to-ascii |
80 | |
238 | |
81 | A not very useful example of filtering all text output to the terminal, |
239 | 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 |
240 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
83 | similar-looking ascii character. |
241 | similar-looking ascii character. |
84 | |
242 | |
|
|
243 | =item digital-clock |
|
|
244 | |
|
|
245 | Displays a digital clock using the built-in overlay. |
|
|
246 | |
|
|
247 | =item remote-clipboard |
|
|
248 | |
|
|
249 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
250 | selection popup that allows one ti run external commands to store the |
|
|
251 | selection somewhere and fetch it again. |
|
|
252 | |
|
|
253 | We use it to implement a "distributed selection mechanism", which just |
|
|
254 | means that one command uploads the file to a remote server, and another |
|
|
255 | reads it. |
|
|
256 | |
|
|
257 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
258 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
259 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
260 | the selection data on STDOUT (also in UTF-8). |
|
|
261 | |
|
|
262 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
263 | |
|
|
264 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
265 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
|
|
266 | |
|
|
267 | =item selection-pastebin |
|
|
268 | |
|
|
269 | This is a little rarely useful extension that Uploads the selection as |
|
|
270 | textfile to a remote site (or does other things). (The implementation is |
|
|
271 | not currently secure for use in a multiuser environment as it writes to |
|
|
272 | F</tmp> directly.). |
|
|
273 | |
|
|
274 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
275 | i.e. |
|
|
276 | |
|
|
277 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
278 | |
|
|
279 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
280 | the textfile. This command can be set via a resource: |
|
|
281 | |
|
|
282 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
283 | |
|
|
284 | And the default is likely not useful to anybody but the few people around |
|
|
285 | here :) |
|
|
286 | |
|
|
287 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
288 | the same content should lead to the same filename. |
|
|
289 | |
|
|
290 | After a successful upload the selection will be replaced by the text given |
|
|
291 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
292 | for the filename): |
|
|
293 | |
|
|
294 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
295 | |
85 | =item example-refresh-hooks |
296 | =item example-refresh-hooks |
86 | |
297 | |
87 | Displays a very simple digital clock in the upper right corner of the |
298 | Displays a very simple digital clock in the upper right corner of the |
88 | window. Illustrates overwriting the refresh callbacks to create your own |
299 | window. Illustrates overwriting the refresh callbacks to create your own |
89 | overlays or changes. |
300 | overlays or changes. |
90 | |
301 | |
91 | =back |
302 | =back |
|
|
303 | |
|
|
304 | =head1 API DOCUMENTATION |
92 | |
305 | |
93 | =head2 General API Considerations |
306 | =head2 General API Considerations |
94 | |
307 | |
95 | All objects (such as terminals, time watchers etc.) are typical |
308 | All objects (such as terminals, time watchers etc.) are typical |
96 | reference-to-hash objects. The hash can be used to store anything you |
309 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
109 | =over 4 |
322 | =over 4 |
110 | |
323 | |
111 | =item $text |
324 | =item $text |
112 | |
325 | |
113 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
326 | 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. |
327 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
115 | |
328 | |
116 | =item $string |
329 | =item $string |
117 | |
330 | |
118 | A perl text string, with an emphasis on I<text>. It can store all unicode |
331 | 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 |
332 | 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 |
337 | Either binary data or - more common - a text string encoded in a |
125 | locale-specific way. |
338 | locale-specific way. |
126 | |
339 | |
127 | =back |
340 | =back |
128 | |
341 | |
|
|
342 | =head2 Extension Objects |
|
|
343 | |
|
|
344 | Very perl extension is a perl class. A separate perl object is created |
|
|
345 | for each terminal and each extension and passed as the first parameter to |
|
|
346 | hooks. So extensions can use their C<$self> object without having to think |
|
|
347 | about other extensions, with the exception of methods and members that |
|
|
348 | begin with an underscore character C<_>: these are reserved for internal |
|
|
349 | use. |
|
|
350 | |
|
|
351 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
|
|
352 | C<urxvt::term> class on this object. |
|
|
353 | |
|
|
354 | It has the following methods and data members: |
|
|
355 | |
|
|
356 | =over 4 |
|
|
357 | |
|
|
358 | =item $urxvt_term = $self->{term} |
|
|
359 | |
|
|
360 | Returns the C<urxvt::term> object associated with this instance of the |
|
|
361 | extension. This member I<must not> be changed in any way. |
|
|
362 | |
|
|
363 | =item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
364 | |
|
|
365 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
366 | this extension, replacing any previous hook. This is useful when you want |
|
|
367 | to overwrite time-critical hooks only temporarily. |
|
|
368 | |
|
|
369 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
370 | |
|
|
371 | Dynamically disable the given hooks. |
|
|
372 | |
|
|
373 | =back |
|
|
374 | |
129 | =head2 Hooks |
375 | =head2 Hooks |
130 | |
376 | |
131 | The following subroutines can be declared in extension files, and will be |
377 | The following subroutines can be declared in extension files, and will be |
132 | called whenever the relevant event happens. |
378 | called whenever the relevant event happens. |
133 | |
379 | |
134 | The first argument passed to them is an object private to each terminal |
380 | 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 |
381 | 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 | |
382 | |
141 | All of them must return a boolean value. If it is true, then the event |
383 | B<All> of these hooks must return a boolean value. If any of the called |
142 | counts as being I<consumed>, and the invocation of other hooks is skipped, |
384 | hooks returns true, then the event counts as being I<consumed>, and the |
143 | and the relevant action might not be carried out by the C++ code. |
385 | relevant action might not be carried out by the C++ code. |
144 | |
386 | |
145 | When in doubt, return a false value (preferably C<()>). |
387 | I<< When in doubt, return a false value (preferably C<()>). >> |
146 | |
388 | |
147 | =over 4 |
389 | =over 4 |
148 | |
390 | |
149 | =item on_init $term |
391 | =item on_init $term |
150 | |
392 | |
151 | Called after a new terminal object has been initialized, but before |
393 | Called after a new terminal object has been initialized, but before |
152 | windows are created or the command gets run. Most methods are unsafe to |
394 | windows are created or the command gets run. Most methods are unsafe to |
153 | call or deliver senseless data, as terminal size and other characteristics |
395 | call or deliver senseless data, as terminal size and other characteristics |
154 | have not yet been determined. You can safely query and change resources, |
396 | have not yet been determined. You can safely query and change resources |
155 | though. |
397 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
398 | place. |
|
|
399 | |
|
|
400 | =item on_start $term |
|
|
401 | |
|
|
402 | Called at the very end of initialisation of a new terminal, just before |
|
|
403 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
404 | |
|
|
405 | =item on_destroy $term |
|
|
406 | |
|
|
407 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
408 | still fully functional (not for long, though). |
156 | |
409 | |
157 | =item on_reset $term |
410 | =item on_reset $term |
158 | |
411 | |
159 | Called after the screen is "reset" for any reason, such as resizing or |
412 | Called after the screen is "reset" for any reason, such as resizing or |
160 | control sequences. Here is where you can react on changes to size-related |
413 | control sequences. Here is where you can react on changes to size-related |
161 | variables. |
414 | variables. |
162 | |
415 | |
163 | =item on_start $term |
416 | =item on_child_start $term, $pid |
164 | |
417 | |
165 | Called at the very end of initialisation of a new terminal, just before |
418 | Called just after the child process has been C<fork>ed. |
166 | returning to the mainloop. |
419 | |
|
|
420 | =item on_child_exit $term, $status |
|
|
421 | |
|
|
422 | Called just after the child process has exited. C<$status> is the status |
|
|
423 | from C<waitpid>. |
167 | |
424 | |
168 | =item on_sel_make $term, $eventtime |
425 | =item on_sel_make $term, $eventtime |
169 | |
426 | |
170 | Called whenever a selection has been made by the user, but before the |
427 | Called whenever a selection has been made by the user, but before the |
171 | selection text is copied, so changes to the beginning, end or type of the |
428 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
185 | =item on_sel_extend $term |
442 | =item on_sel_extend $term |
186 | |
443 | |
187 | Called whenever the user tries to extend the selection (e.g. with a double |
444 | 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 |
445 | 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 |
446 | should extend the selection itelf and return true to suppress the built-in |
190 | processing. |
447 | processing. This can happen multiple times, as long as the callback |
|
|
448 | returns true, it will be called on every further click by the user and is |
|
|
449 | supposed to enlarge the selection more and more, if possible. |
191 | |
450 | |
192 | See the F<selection> example extension. |
451 | See the F<selection> example extension. |
193 | |
452 | |
194 | =item on_view_change $term, $offset |
453 | =item on_view_change $term, $offset |
195 | |
454 | |
… | |
… | |
226 | can filter/change and output the text yourself by returning a true value |
485 | 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 |
486 | 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 |
487 | might be very slow, however, as your hook is called for B<all> text being |
229 | output. |
488 | output. |
230 | |
489 | |
|
|
490 | =item on_tt_write $term, $octets |
|
|
491 | |
|
|
492 | Called whenever some data is written to the tty/pty and can be used to |
|
|
493 | suppress or filter tty input. |
|
|
494 | |
231 | =item on_line_update $term, $row |
495 | =item on_line_update $term, $row |
232 | |
496 | |
233 | Called whenever a line was updated or changed. Can be used to filter |
497 | 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 |
498 | 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, |
499 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
251 | |
515 | |
252 | =item on_refresh_end $term |
516 | =item on_refresh_end $term |
253 | |
517 | |
254 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
518 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
255 | |
519 | |
256 | =item on_keyboard_command $term, $string |
520 | =item on_user_command $term, $string |
257 | |
521 | |
258 | Called whenever the user presses a key combination that has a |
522 | Called whenever the a user-configured event is being activated (e.g. via |
259 | C<perl:string> action bound to it (see description of the B<keysym> |
523 | a C<perl:string> action bound to a key, see description of the B<keysym> |
260 | resource in the @@RXVT_NAME@@(1) manpage). |
524 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
525 | |
|
|
526 | The event is simply the action string. This interface is assumed to change |
|
|
527 | slightly in the future. |
|
|
528 | |
|
|
529 | =item on_x_event $term, $event |
|
|
530 | |
|
|
531 | Called on every X event received on the vt window (and possibly other |
|
|
532 | windows). Should only be used as a last resort. Most event structure |
|
|
533 | members are not passed. |
261 | |
534 | |
262 | =item on_focus_in $term |
535 | =item on_focus_in $term |
263 | |
536 | |
264 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
537 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
265 | does focus in processing. |
538 | does focus in processing. |
… | |
… | |
267 | =item on_focus_out $term |
540 | =item on_focus_out $term |
268 | |
541 | |
269 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
542 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
270 | focus out processing. |
543 | focus out processing. |
271 | |
544 | |
|
|
545 | =item on_configure_notify $term, $event |
|
|
546 | |
|
|
547 | =item on_property_notify $term, $event |
|
|
548 | |
272 | =item on_key_press $term, $event, $octets |
549 | =item on_key_press $term, $event, $keysym, $octets |
273 | |
550 | |
274 | =item on_key_release $term, $event |
551 | =item on_key_release $term, $event, $keysym |
275 | |
552 | |
276 | =item on_button_press $term, $event |
553 | =item on_button_press $term, $event |
277 | |
554 | |
278 | =item on_button_release $term, $event |
555 | =item on_button_release $term, $event |
279 | |
556 | |
… | |
… | |
285 | |
562 | |
286 | Called whenever the corresponding X event is received for the terminal If |
563 | Called whenever the corresponding X event is received for the terminal If |
287 | the hook returns true, then the even will be ignored by rxvt-unicode. |
564 | the hook returns true, then the even will be ignored by rxvt-unicode. |
288 | |
565 | |
289 | The event is a hash with most values as named by Xlib (see the XEvent |
566 | The event is a hash with most values as named by Xlib (see the XEvent |
290 | manpage), with the additional members C<row> and C<col>, which are the row |
567 | manpage), with the additional members C<row> and C<col>, which are the |
291 | and column under the mouse cursor. |
568 | (real, not screen-based) row and column under the mouse cursor. |
292 | |
569 | |
293 | C<on_key_press> additionally receives the string rxvt-unicode would |
570 | C<on_key_press> additionally receives the string rxvt-unicode would |
294 | output, if any, in locale-specific encoding. |
571 | output, if any, in locale-specific encoding. |
295 | |
572 | |
296 | subwindow. |
573 | subwindow. |
297 | |
574 | |
|
|
575 | =item on_client_message $term, $event |
|
|
576 | |
|
|
577 | =item on_wm_protocols $term, $event |
|
|
578 | |
|
|
579 | =item on_wm_delete_window $term, $event |
|
|
580 | |
|
|
581 | Called when various types of ClientMessage events are received (all with |
|
|
582 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
583 | |
298 | =back |
584 | =back |
299 | |
585 | |
|
|
586 | =cut |
|
|
587 | |
|
|
588 | package urxvt; |
|
|
589 | |
|
|
590 | use utf8; |
|
|
591 | use strict; |
|
|
592 | use Carp (); |
|
|
593 | use Scalar::Util (); |
|
|
594 | use List::Util (); |
|
|
595 | |
|
|
596 | our $VERSION = 1; |
|
|
597 | our $TERM; |
|
|
598 | our @TERM_INIT; |
|
|
599 | our @TERM_EXT; |
|
|
600 | our @HOOKNAME; |
|
|
601 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
|
|
602 | our %OPTION; |
|
|
603 | |
|
|
604 | our $LIBDIR; |
|
|
605 | our $RESNAME; |
|
|
606 | our $RESCLASS; |
|
|
607 | our $RXVTNAME; |
|
|
608 | |
|
|
609 | our $NOCHAR = chr 0xffff; |
|
|
610 | |
300 | =head2 Variables in the C<urxvt> Package |
611 | =head2 Variables in the C<urxvt> Package |
301 | |
612 | |
302 | =over 4 |
613 | =over 4 |
|
|
614 | |
|
|
615 | =item $urxvt::LIBDIR |
|
|
616 | |
|
|
617 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
618 | modules and scripts are stored. |
|
|
619 | |
|
|
620 | =item $urxvt::RESCLASS, $urxvt::RESCLASS |
|
|
621 | |
|
|
622 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
623 | |
|
|
624 | =item $urxvt::RXVTNAME |
|
|
625 | |
|
|
626 | The basename of the installed binaries, usually C<urxvt>. |
303 | |
627 | |
304 | =item $urxvt::TERM |
628 | =item $urxvt::TERM |
305 | |
629 | |
306 | The current terminal. This variable stores the current C<urxvt::term> |
630 | The current terminal. This variable stores the current C<urxvt::term> |
307 | object, whenever a callback/hook is executing. |
631 | object, whenever a callback/hook is executing. |
308 | |
632 | |
|
|
633 | =item @urxvt::TERM_INIT |
|
|
634 | |
|
|
635 | All coderefs in this array will be called as methods of the next newly |
|
|
636 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
637 | gets cleared before the codereferences that were in it are being executed, |
|
|
638 | so coderefs can push themselves onto it again if they so desire. |
|
|
639 | |
|
|
640 | This complements to the perl-eval commandline option, but gets executed |
|
|
641 | first. |
|
|
642 | |
|
|
643 | =item @urxvt::TERM_EXT |
|
|
644 | |
|
|
645 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
646 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
647 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
|
|
648 | |
309 | =back |
649 | =back |
310 | |
650 | |
311 | =head2 Functions in the C<urxvt> Package |
651 | =head2 Functions in the C<urxvt> Package |
312 | |
652 | |
313 | =over 4 |
653 | =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 | |
654 | |
323 | =item urxvt::fatal $errormessage |
655 | =item urxvt::fatal $errormessage |
324 | |
656 | |
325 | Fatally aborts execution with the given error message. Avoid at all |
657 | Fatally aborts execution with the given error message. Avoid at all |
326 | costs! The only time this is acceptable is when the terminal process |
658 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
333 | that calls this function. |
665 | that calls this function. |
334 | |
666 | |
335 | Using this function has the advantage that its output ends up in the |
667 | 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. |
668 | correct place, e.g. on stderr of the connecting urxvtc client. |
337 | |
669 | |
338 | =item $is_safe = urxvt::safe |
670 | Messages have a size limit of 1023 bytes currently. |
339 | |
671 | |
340 | Returns true when it is safe to do potentially unsafe things, such as |
672 | =item @terms = urxvt::termlist |
341 | evaluating perl code specified by the user. This is true when urxvt was |
673 | |
342 | started setuid or setgid. |
674 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
675 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
676 | objects that have perl extensions attached will be returned (because there |
|
|
677 | is no urxvt::term objet associated with others). |
343 | |
678 | |
344 | =item $time = urxvt::NOW |
679 | =item $time = urxvt::NOW |
345 | |
680 | |
346 | Returns the "current time" (as per the event loop). |
681 | Returns the "current time" (as per the event loop). |
347 | |
682 | |
348 | =item urxvt::CurrentTime |
683 | =item urxvt::CurrentTime |
349 | |
684 | |
350 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
685 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
351 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
686 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
352 | Button4Mask, Button5Mask, AnyModifier |
687 | Button4Mask, Button5Mask, AnyModifier |
|
|
688 | |
|
|
689 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
690 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
691 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
692 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
693 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
694 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
695 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
696 | |
|
|
697 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
698 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
699 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
700 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
701 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
702 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
703 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
353 | |
704 | |
354 | Various constants for use in X calls and event processing. |
705 | Various constants for use in X calls and event processing. |
355 | |
706 | |
356 | =back |
707 | =back |
357 | |
708 | |
… | |
… | |
386 | |
737 | |
387 | =item $background = urxvt::GET_BASEBG $rend |
738 | =item $background = urxvt::GET_BASEBG $rend |
388 | |
739 | |
389 | Return the foreground/background colour index, respectively. |
740 | Return the foreground/background colour index, respectively. |
390 | |
741 | |
391 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
742 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
392 | |
743 | |
393 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
744 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
394 | |
745 | |
395 | Replace the foreground/background colour in the rendition mask with the |
746 | Replace the foreground/background colour in the rendition mask with the |
396 | specified one. |
747 | specified one. |
397 | |
748 | |
398 | =item $value = urxvt::GET_CUSTOM ($rend) |
749 | =item $value = urxvt::GET_CUSTOM $rend |
399 | |
750 | |
400 | Return the "custom" value: Every rendition has 5 bits for use by |
751 | 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 |
752 | extensions. They can be set and changed as you like and are initially |
402 | zero. |
753 | zero. |
403 | |
754 | |
404 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
755 | =item $rend = urxvt::SET_CUSTOM $rend, $new_value |
405 | |
756 | |
406 | Change the custom value. |
757 | Change the custom value. |
407 | |
758 | |
408 | =back |
759 | =back |
409 | |
760 | |
410 | =cut |
761 | =cut |
411 | |
762 | |
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 | |
|
|
425 | BEGIN { |
763 | BEGIN { |
426 | urxvt->bootstrap; |
|
|
427 | |
|
|
428 | # overwrite perl's warn |
764 | # overwrite perl's warn |
429 | *CORE::GLOBAL::warn = sub { |
765 | *CORE::GLOBAL::warn = sub { |
430 | my $msg = join "", @_; |
766 | my $msg = join "", @_; |
431 | $msg .= "\n" |
767 | $msg .= "\n" |
432 | unless $msg =~ /\n$/; |
768 | unless $msg =~ /\n$/; |
433 | urxvt::warn ($msg); |
769 | urxvt::warn ($msg); |
434 | }; |
770 | }; |
435 | |
|
|
436 | delete $ENV{IFS}; |
|
|
437 | delete $ENV{CDPATH}; |
|
|
438 | delete $ENV{BASH_ENV}; |
|
|
439 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
440 | } |
771 | } |
441 | |
772 | |
442 | my @hook_count; |
773 | no warnings 'utf8'; |
|
|
774 | |
443 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
775 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
444 | |
776 | |
445 | sub verbose { |
777 | sub verbose { |
446 | my ($level, $msg) = @_; |
778 | my ($level, $msg) = @_; |
447 | warn "$msg\n" if $level <= $verbosity; |
779 | warn "$msg\n" if $level <= $verbosity; |
448 | } |
780 | } |
449 | |
781 | |
450 | # find on_xxx subs in the package and register them |
|
|
451 | # as hooks |
|
|
452 | sub register_package($) { |
|
|
453 | my ($pkg) = @_; |
|
|
454 | |
|
|
455 | for my $htype (0.. $#HOOKNAME) { |
|
|
456 | my $name = $HOOKNAME[$htype]; |
|
|
457 | |
|
|
458 | my $ref = $pkg->can ("on_" . lc $name) |
|
|
459 | or next; |
|
|
460 | |
|
|
461 | $TERM->{_hook}[$htype]{$pkg} = $ref; |
|
|
462 | $hook_count[$htype]++ |
|
|
463 | or set_should_invoke $htype, 1; |
|
|
464 | } |
|
|
465 | } |
|
|
466 | |
|
|
467 | my $extension_pkg = "extension0000"; |
|
|
468 | my %extension_pkg; |
782 | my %extension_pkg; |
469 | |
783 | |
470 | # load a single script into its own package, once only |
784 | # load a single script into its own package, once only |
471 | sub extension_package($) { |
785 | sub extension_package($) { |
472 | my ($path) = @_; |
786 | my ($path) = @_; |
473 | |
787 | |
474 | $extension_pkg{$path} ||= do { |
788 | $extension_pkg{$path} ||= do { |
475 | my $pkg = "urxvt::" . ($extension_pkg++); |
789 | $path =~ /([^\/\\]+)$/; |
|
|
790 | my $pkg = $1; |
|
|
791 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
792 | $pkg = "urxvt::ext::$pkg"; |
476 | |
793 | |
477 | verbose 3, "loading extension '$path' into package '$pkg'"; |
794 | verbose 3, "loading extension '$path' into package '$pkg'"; |
478 | |
795 | |
479 | open my $fh, "<:raw", $path |
796 | open my $fh, "<:raw", $path |
480 | or die "$path: $!"; |
797 | or die "$path: $!"; |
481 | |
798 | |
482 | my $source = untaint "package $pkg; use strict; use utf8;\n" |
799 | my $source = |
483 | . "use base urxvt::term::proxy::;\n" |
800 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
484 | . "#line 1 \"$path\"\n{\n" |
801 | . "#line 1 \"$path\"\n{\n" |
485 | . (do { local $/; <$fh> }) |
802 | . (do { local $/; <$fh> }) |
486 | . "\n};\n1"; |
803 | . "\n};\n1"; |
487 | |
804 | |
|
|
805 | eval $source |
488 | eval $source or die "$path: $@"; |
806 | or die "$path: $@"; |
489 | |
807 | |
490 | $pkg |
808 | $pkg |
491 | } |
809 | } |
492 | } |
810 | } |
493 | |
811 | |
… | |
… | |
499 | my $htype = shift; |
817 | my $htype = shift; |
500 | |
818 | |
501 | if ($htype == 0) { # INIT |
819 | if ($htype == 0) { # INIT |
502 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
820 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
503 | |
821 | |
504 | my %want_ext; |
822 | my %ext_arg; |
505 | |
823 | |
|
|
824 | { |
|
|
825 | my @init = @TERM_INIT; |
|
|
826 | @TERM_INIT = (); |
|
|
827 | $_->($TERM) for @init; |
|
|
828 | my @pkg = @TERM_EXT; |
|
|
829 | @TERM_EXT = (); |
|
|
830 | $TERM->register_package ($_) for @pkg; |
|
|
831 | } |
|
|
832 | |
506 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
833 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
507 | if ($_ eq "default") { |
834 | if ($_ eq "default") { |
508 | $want_ext{$_}++ for qw(selection option-popup selection-popup); |
835 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
509 | } elsif (/^-(.*)$/) { |
836 | } elsif (/^-(.*)$/) { |
510 | delete $want_ext{$1}; |
837 | delete $ext_arg{$1}; |
|
|
838 | } elsif (/^([^<]+)<(.*)>$/) { |
|
|
839 | push @{ $ext_arg{$1} }, $2; |
511 | } else { |
840 | } else { |
512 | $want_ext{$_}++; |
841 | $ext_arg{$_} ||= []; |
513 | } |
842 | } |
514 | } |
843 | } |
515 | |
844 | |
516 | for my $ext (keys %want_ext) { |
845 | while (my ($ext, $argv) = each %ext_arg) { |
517 | my @files = grep -f $_, map "$_/$ext", @dirs; |
846 | my @files = grep -f $_, map "$_/$ext", @dirs; |
518 | |
847 | |
519 | if (@files) { |
848 | if (@files) { |
520 | register_package extension_package $files[0]; |
849 | $TERM->register_package (extension_package $files[0], $argv); |
521 | } else { |
850 | } else { |
522 | warn "perl extension '$ext' not found in perl library search path\n"; |
851 | warn "perl extension '$ext' not found in perl library search path\n"; |
523 | } |
852 | } |
524 | } |
853 | } |
525 | |
854 | |
… | |
… | |
534 | if $verbosity >= 10; |
863 | if $verbosity >= 10; |
535 | |
864 | |
536 | keys %$cb; |
865 | keys %$cb; |
537 | |
866 | |
538 | while (my ($pkg, $cb) = each %$cb) { |
867 | while (my ($pkg, $cb) = each %$cb) { |
539 | eval { |
868 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
540 | $retval = $cb->( |
869 | $retval ||= $retval_; |
541 | $TERM->{_pkg}{$pkg} ||= do { |
870 | |
542 | my $proxy = bless { }, $pkg; |
|
|
543 | Scalar::Util::weaken ($proxy->{term} = $TERM); |
|
|
544 | $proxy |
|
|
545 | }, |
|
|
546 | @_, |
|
|
547 | ) and last; |
|
|
548 | }; |
|
|
549 | if ($@) { |
871 | if ($@) { |
550 | $TERM->ungrab; # better to lose the grab than the session |
872 | $TERM->ungrab; # better to lose the grab than the session |
551 | warn $@; |
873 | warn $@; |
552 | } |
874 | } |
553 | } |
875 | } |
|
|
876 | |
|
|
877 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
878 | if $verbosity >= 11; |
554 | } |
879 | } |
555 | |
880 | |
556 | if ($htype == 1) { # DESTROY |
881 | if ($htype == 1) { # DESTROY |
557 | # remove hooks if unused |
|
|
558 | if (my $hook = $TERM->{_hook}) { |
|
|
559 | for my $htype (0..$#$hook) { |
|
|
560 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
561 | or set_should_invoke $htype, 0; |
|
|
562 | } |
|
|
563 | } |
|
|
564 | |
|
|
565 | # clear package objects |
882 | # clear package objects |
566 | %$_ = () for values %{ $TERM->{_pkg} }; |
883 | %$_ = () for values %{ $TERM->{_pkg} }; |
567 | |
884 | |
568 | # clear package |
885 | # clear package |
569 | %$TERM = (); |
886 | %$TERM = (); |
570 | } |
887 | } |
571 | |
888 | |
572 | $retval |
889 | $retval |
573 | } |
890 | } |
574 | |
891 | |
575 | # urxvt::term::proxy |
892 | # urxvt::term::extension |
576 | |
893 | |
577 | sub urxvt::term::proxy::AUTOLOAD { |
894 | package urxvt::term::extension; |
578 | $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ |
895 | |
|
|
896 | sub enable { |
|
|
897 | my ($self, %hook) = @_; |
|
|
898 | my $pkg = $self->{_pkg}; |
|
|
899 | |
|
|
900 | while (my ($name, $cb) = each %hook) { |
|
|
901 | my $htype = $HOOKTYPE{uc $name}; |
|
|
902 | defined $htype |
|
|
903 | or Carp::croak "unsupported hook type '$name'"; |
|
|
904 | |
|
|
905 | $self->set_should_invoke ($htype, +1) |
|
|
906 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
|
|
907 | |
|
|
908 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
909 | } |
|
|
910 | } |
|
|
911 | |
|
|
912 | sub disable { |
|
|
913 | my ($self, @hook) = @_; |
|
|
914 | my $pkg = $self->{_pkg}; |
|
|
915 | |
|
|
916 | for my $name (@hook) { |
|
|
917 | my $htype = $HOOKTYPE{uc $name}; |
|
|
918 | defined $htype |
|
|
919 | or Carp::croak "unsupported hook type '$name'"; |
|
|
920 | |
|
|
921 | $self->set_should_invoke ($htype, -1) |
|
|
922 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
|
|
923 | } |
|
|
924 | } |
|
|
925 | |
|
|
926 | our $AUTOLOAD; |
|
|
927 | |
|
|
928 | sub AUTOLOAD { |
|
|
929 | $AUTOLOAD =~ /:([^:]+)$/ |
579 | or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; |
930 | or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable"; |
580 | |
931 | |
581 | eval qq{ |
932 | eval qq{ |
582 | sub $urxvt::term::proxy::AUTOLOAD { |
933 | sub $AUTOLOAD { |
583 | my \$proxy = shift; |
934 | my \$proxy = shift; |
584 | \$proxy->{term}->$1 (\@_) |
935 | \$proxy->{term}->$1 (\@_) |
585 | } |
936 | } |
586 | 1 |
937 | 1 |
587 | } or die "FATAL: unable to compile method forwarder: $@"; |
938 | } or die "FATAL: unable to compile method forwarder: $@"; |
588 | |
939 | |
589 | goto &$urxvt::term::proxy::AUTOLOAD; |
940 | goto &$AUTOLOAD; |
590 | } |
941 | } |
591 | |
942 | |
592 | sub urxvt::term::proxy::DESTROY { |
943 | sub DESTROY { |
593 | # nop |
944 | # nop |
594 | } |
945 | } |
595 | |
946 | |
596 | # urxvt::destroy_hook |
947 | # urxvt::destroy_hook |
597 | |
948 | |
… | |
… | |
607 | |
958 | |
608 | =head2 The C<urxvt::anyevent> Class |
959 | =head2 The C<urxvt::anyevent> Class |
609 | |
960 | |
610 | The sole purpose of this class is to deliver an interface to the |
961 | The sole purpose of this class is to deliver an interface to the |
611 | C<AnyEvent> module - any module using it will work inside urxvt without |
962 | C<AnyEvent> module - any module using it will work inside urxvt without |
612 | further work. The only exception is that you cannot wait on condition |
963 | further programming. The only exception is that you cannot wait on |
613 | variables, but non-blocking condvar use is ok. What this means is that you |
964 | condition variables, but non-blocking condvar use is ok. What this means |
614 | cannot use blocking APIs, but the non-blocking variant should work. |
965 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
966 | work. |
615 | |
967 | |
616 | =cut |
968 | =cut |
617 | |
969 | |
618 | our $VERSION = 1; |
970 | our $VERSION = 1; |
619 | |
971 | |
… | |
… | |
664 | ${$_[0]}++; |
1016 | ${$_[0]}++; |
665 | } |
1017 | } |
666 | |
1018 | |
667 | sub urxvt::anyevent::condvar::wait { |
1019 | sub urxvt::anyevent::condvar::wait { |
668 | unless (${$_[0]}) { |
1020 | unless (${$_[0]}) { |
669 | require Carp; |
|
|
670 | Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"); |
1021 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
671 | } |
1022 | } |
672 | } |
1023 | } |
673 | |
1024 | |
674 | package urxvt::term; |
1025 | package urxvt::term; |
675 | |
1026 | |
676 | =head2 The C<urxvt::term> Class |
1027 | =head2 The C<urxvt::term> Class |
677 | |
1028 | |
678 | =over 4 |
1029 | =over 4 |
679 | |
1030 | |
|
|
1031 | =cut |
|
|
1032 | |
|
|
1033 | # find on_xxx subs in the package and register them |
|
|
1034 | # as hooks |
|
|
1035 | sub register_package { |
|
|
1036 | my ($self, $pkg, $argv) = @_; |
|
|
1037 | |
|
|
1038 | no strict 'refs'; |
|
|
1039 | |
|
|
1040 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
1041 | |
|
|
1042 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
1043 | |
|
|
1044 | my $proxy = bless { |
|
|
1045 | _pkg => $pkg, |
|
|
1046 | argv => $argv, |
|
|
1047 | }, $pkg; |
|
|
1048 | Scalar::Util::weaken ($proxy->{term} = $self); |
|
|
1049 | |
|
|
1050 | $self->{_pkg}{$pkg} = $proxy; |
|
|
1051 | |
|
|
1052 | for my $name (@HOOKNAME) { |
|
|
1053 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
|
|
1054 | $proxy->enable ($name => $ref); |
|
|
1055 | } |
|
|
1056 | } |
|
|
1057 | } |
|
|
1058 | |
|
|
1059 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
|
|
1060 | |
|
|
1061 | Creates a new terminal, very similar as if you had started it with system |
|
|
1062 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
|
|
1063 | hash which defines the environment of the new terminal. |
|
|
1064 | |
|
|
1065 | Croaks (and probably outputs an error message) if the new instance |
|
|
1066 | couldn't be created. Returns C<undef> if the new instance didn't |
|
|
1067 | initialise perl, and the terminal object otherwise. The C<init> and |
|
|
1068 | C<start> hooks will be called before this call returns, and are free to |
|
|
1069 | refer to global data (which is race free). |
|
|
1070 | |
|
|
1071 | =cut |
|
|
1072 | |
|
|
1073 | sub new { |
|
|
1074 | my ($class, $env, @args) = @_; |
|
|
1075 | |
|
|
1076 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1077 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1078 | |
|
|
1079 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
|
|
1080 | } |
|
|
1081 | |
680 | =item $term->destroy |
1082 | =item $term->destroy |
681 | |
1083 | |
682 | Destroy the terminal object (close the window, free resources etc.). |
1084 | Destroy the terminal object (close the window, free resources |
|
|
1085 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
|
|
1086 | watchers (timers, io watchers) are still active. |
|
|
1087 | |
|
|
1088 | =item $term->exec_async ($cmd[, @args]) |
|
|
1089 | |
|
|
1090 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
1091 | ("starts") programs in the background. This function takes care of setting |
|
|
1092 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
1093 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
1094 | |
|
|
1095 | Returns the pid of the subprocess or C<undef> on error. |
|
|
1096 | |
|
|
1097 | =cut |
|
|
1098 | |
|
|
1099 | sub exec_async { |
|
|
1100 | my $self = shift; |
|
|
1101 | |
|
|
1102 | my $pid = fork; |
|
|
1103 | |
|
|
1104 | return $pid |
|
|
1105 | if !defined $pid or $pid; |
|
|
1106 | |
|
|
1107 | %ENV = %{ $self->env }; |
|
|
1108 | |
|
|
1109 | exec @_; |
|
|
1110 | urxvt::_exit 255; |
|
|
1111 | } |
683 | |
1112 | |
684 | =item $isset = $term->option ($optval[, $set]) |
1113 | =item $isset = $term->option ($optval[, $set]) |
685 | |
1114 | |
686 | Returns true if the option specified by C<$optval> is enabled, and |
1115 | Returns true if the option specified by C<$optval> is enabled, and |
687 | optionally change it. All option values are stored by name in the hash |
1116 | optionally change it. All option values are stored by name in the hash |
… | |
… | |
690 | Here is a a likely non-exhaustive list of option names, please see the |
1119 | Here is a a likely non-exhaustive list of option names, please see the |
691 | source file F</src/optinc.h> to see the actual list: |
1120 | source file F</src/optinc.h> to see the actual list: |
692 | |
1121 | |
693 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1122 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
694 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1123 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
695 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1124 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
696 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1125 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
697 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1126 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
698 | tripleclickwords utmpInhibit visualBell |
1127 | transparent tripleclickwords utmpInhibit visualBell |
699 | |
1128 | |
700 | =item $value = $term->resource ($name[, $newval]) |
1129 | =item $value = $term->resource ($name[, $newval]) |
701 | |
1130 | |
702 | Returns the current resource value associated with a given name and |
1131 | Returns the current resource value associated with a given name and |
703 | optionally sets a new value. Setting values is most useful in the C<init> |
1132 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
720 | |
1149 | |
721 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1150 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
722 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1151 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
723 | display_name embed ext_bwidth fade font geometry hold iconName |
1152 | display_name embed ext_bwidth fade font geometry hold iconName |
724 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1153 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
725 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1154 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
726 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1155 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
727 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1156 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
728 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1157 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
729 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1158 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
730 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1159 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
731 | shade term_name title transparent transparent_all tripleclickwords |
1160 | secondaryScreen secondaryScroll selectstyle shade term_name title |
732 | utmpInhibit visualBell |
1161 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
|
|
1162 | visualBell |
733 | |
1163 | |
734 | =cut |
1164 | =cut |
735 | |
1165 | |
736 | sub resource($$;$) { |
1166 | sub resource($$;$) { |
737 | my ($self, $name) = (shift, shift); |
1167 | my ($self, $name) = (shift, shift); |
738 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1168 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
739 | &urxvt::term::_resource |
1169 | &urxvt::term::_resource |
740 | } |
1170 | } |
741 | |
1171 | |
|
|
1172 | =item $value = $term->x_resource ($pattern) |
|
|
1173 | |
|
|
1174 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
1175 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
|
|
1176 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
|
|
1177 | resource with that pattern exists. |
|
|
1178 | |
|
|
1179 | This method should only be called during the C<on_start> hook, as there is |
|
|
1180 | only one resource database per display, and later invocations might return |
|
|
1181 | the wrong resources. |
|
|
1182 | |
|
|
1183 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
|
|
1184 | |
|
|
1185 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
1186 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
|
|
1187 | |
742 | =item $rend = $term->rstyle ([$new_rstyle]) |
1188 | =item $rend = $term->rstyle ([$new_rstyle]) |
743 | |
1189 | |
744 | Return and optionally change the current rendition. Text that is output by |
1190 | Return and optionally change the current rendition. Text that is output by |
745 | the terminal application will use this style. |
1191 | the terminal application will use this style. |
746 | |
1192 | |
… | |
… | |
756 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1202 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
757 | |
1203 | |
758 | Return the current values of the selection mark, begin or end positions, |
1204 | Return the current values of the selection mark, begin or end positions, |
759 | and optionally set them to new values. |
1205 | and optionally set them to new values. |
760 | |
1206 | |
|
|
1207 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
1208 | |
|
|
1209 | Tries to make a selection as set by C<selection_beg> and |
|
|
1210 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
1211 | rectangular selection will be made. This is the prefered function to make |
|
|
1212 | a selection. |
|
|
1213 | |
761 | =item $success = $term->selection_grab ($eventtime) |
1214 | =item $success = $term->selection_grab ($eventtime) |
762 | |
1215 | |
763 | Try to request the primary selection from the server (for example, as set |
1216 | Try to request the primary selection text from the server (for example, as |
764 | by the next method). |
1217 | set by the next method). No visual feedback will be given. This function |
|
|
1218 | is mostly useful from within C<on_sel_grab> hooks. |
765 | |
1219 | |
766 | =item $oldtext = $term->selection ([$newtext]) |
1220 | =item $oldtext = $term->selection ([$newtext]) |
767 | |
1221 | |
768 | Return the current selection text and optionally replace it by C<$newtext>. |
1222 | Return the current selection text and optionally replace it by C<$newtext>. |
769 | |
1223 | |
770 | #=item $term->overlay ($x, $y, $text) |
1224 | =item $term->overlay_simple ($x, $y, $text) |
771 | # |
1225 | |
772 | #Create a simple multi-line overlay box. See the next method for details. |
1226 | Create a simple multi-line overlay box. See the next method for details. |
773 | # |
1227 | |
774 | #=cut |
1228 | =cut |
775 | # |
1229 | |
776 | #sub urxvt::term::scr_overlay { |
1230 | sub overlay_simple { |
777 | # my ($self, $x, $y, $text) = @_; |
1231 | my ($self, $x, $y, $text) = @_; |
778 | # |
1232 | |
779 | # my @lines = split /\n/, $text; |
1233 | my @lines = split /\n/, $text; |
780 | # |
1234 | |
781 | # my $w = 0; |
1235 | my $w = List::Util::max map $self->strwidth ($_), @lines; |
782 | # for (map $self->strwidth ($_), @lines) { |
1236 | |
783 | # $w = $_ if $w < $_; |
|
|
784 | # } |
|
|
785 | # |
|
|
786 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
1237 | my $overlay = $self->overlay ($x, $y, $w, scalar @lines); |
787 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
1238 | $overlay->set (0, $_, $lines[$_]) for 0.. $#lines; |
788 | #} |
1239 | |
|
|
1240 | $overlay |
|
|
1241 | } |
789 | |
1242 | |
790 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
1243 | =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
791 | |
1244 | |
792 | Create a new (empty) overlay at the given position with the given |
1245 | Create a new (empty) overlay at the given position with the given |
793 | width/height. C<$rstyle> defines the initial rendition style |
1246 | width/height. C<$rstyle> defines the initial rendition style |
… | |
… | |
860 | |
1313 | |
861 | =item $string = $term->locale_decode ($octets) |
1314 | =item $string = $term->locale_decode ($octets) |
862 | |
1315 | |
863 | Convert the given locale-encoded octets into a perl string. |
1316 | Convert the given locale-encoded octets into a perl string. |
864 | |
1317 | |
|
|
1318 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
|
|
1319 | |
|
|
1320 | XORs the rendition values in the given span with the provided value |
|
|
1321 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
|
|
1322 | refresh hooks to provide effects similar to the selection. |
|
|
1323 | |
|
|
1324 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
|
|
1325 | |
|
|
1326 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
|
|
1327 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
|
|
1328 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
|
|
1329 | it instead. Both styles I<MUST NOT> contain font styles. |
|
|
1330 | |
|
|
1331 | =item $term->scr_bell |
|
|
1332 | |
|
|
1333 | Ring the bell! |
|
|
1334 | |
865 | =item $term->scr_add_lines ($string) |
1335 | =item $term->scr_add_lines ($string) |
866 | |
1336 | |
867 | Write the given text string to the screen, as if output by the application |
1337 | Write the given text string to the screen, as if output by the application |
868 | running inside the terminal. It may not contain command sequences (escape |
1338 | running inside the terminal. It may not contain command sequences (escape |
869 | codes), but is free to use line feeds, carriage returns and tabs. The |
1339 | codes), but is free to use line feeds, carriage returns and tabs. The |
… | |
… | |
871 | |
1341 | |
872 | Normally its not a good idea to use this function, as programs might be |
1342 | Normally its not a good idea to use this function, as programs might be |
873 | confused by changes in cursor position or scrolling. Its useful inside a |
1343 | confused by changes in cursor position or scrolling. Its useful inside a |
874 | C<on_add_lines> hook, though. |
1344 | C<on_add_lines> hook, though. |
875 | |
1345 | |
|
|
1346 | =item $term->scr_change_screen ($screen) |
|
|
1347 | |
|
|
1348 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1349 | |
876 | =item $term->cmd_parse ($octets) |
1350 | =item $term->cmd_parse ($octets) |
877 | |
1351 | |
878 | Similar to C<scr_add_lines>, but the argument must be in the |
1352 | Similar to C<scr_add_lines>, but the argument must be in the |
879 | locale-specific encoding of the terminal and can contain command sequences |
1353 | locale-specific encoding of the terminal and can contain command sequences |
880 | (escape codes) that will be interpreted. |
1354 | (escape codes) that will be interpreted. |
… | |
… | |
883 | |
1357 | |
884 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1358 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
885 | pass characters instead of octets, you should convert your strings first |
1359 | pass characters instead of octets, you should convert your strings first |
886 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1360 | to the locale-specific encoding using C<< $term->locale_encode >>. |
887 | |
1361 | |
|
|
1362 | =item $old_events = $term->pty_ev_events ([$new_events]) |
|
|
1363 | |
|
|
1364 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
1365 | be used to suppress input and output handling to the pty/tty. See the |
|
|
1366 | description of C<< urxvt::timer->events >>. Make sure to always restore |
|
|
1367 | the previous value. |
|
|
1368 | |
|
|
1369 | =item $fd = $term->pty_fd |
|
|
1370 | |
|
|
1371 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1372 | is used. |
|
|
1373 | |
888 | =item $windowid = $term->parent |
1374 | =item $windowid = $term->parent |
889 | |
1375 | |
890 | Return the window id of the toplevel window. |
1376 | Return the window id of the toplevel window. |
891 | |
1377 | |
892 | =item $windowid = $term->vt |
1378 | =item $windowid = $term->vt |
893 | |
1379 | |
894 | Return the window id of the terminal window. |
1380 | Return the window id of the terminal window. |
895 | |
1381 | |
|
|
1382 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1383 | |
|
|
1384 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1385 | to receive pointer events all the times: |
|
|
1386 | |
|
|
1387 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1388 | |
896 | =item $window_width = $term->width |
1389 | =item $window_width = $term->width |
897 | |
1390 | |
898 | =item $window_height = $term->height |
1391 | =item $window_height = $term->height |
899 | |
1392 | |
900 | =item $font_width = $term->fwidth |
1393 | =item $font_width = $term->fwidth |
… | |
… | |
913 | |
1406 | |
914 | =item $max_scrollback = $term->saveLines |
1407 | =item $max_scrollback = $term->saveLines |
915 | |
1408 | |
916 | =item $nrow_plus_saveLines = $term->total_rows |
1409 | =item $nrow_plus_saveLines = $term->total_rows |
917 | |
1410 | |
918 | =item $lines_in_scrollback = $term->nsaved |
1411 | =item $topmost_scrollback_row = $term->top_row |
919 | |
1412 | |
920 | Return various integers describing terminal characteristics. |
1413 | Return various integers describing terminal characteristics. |
|
|
1414 | |
|
|
1415 | =item $x_display = $term->display_id |
|
|
1416 | |
|
|
1417 | Return the DISPLAY used by rxvt-unicode. |
|
|
1418 | |
|
|
1419 | =item $lc_ctype = $term->locale |
|
|
1420 | |
|
|
1421 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
1422 | |
|
|
1423 | =item $env = $term->env |
|
|
1424 | |
|
|
1425 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1426 | similar to C<\%ENV>. |
|
|
1427 | |
|
|
1428 | =cut |
|
|
1429 | |
|
|
1430 | sub env { |
|
|
1431 | if (my $env = $_[0]->_env) { |
|
|
1432 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
|
|
1433 | } else { |
|
|
1434 | +{ %ENV } |
|
|
1435 | } |
|
|
1436 | } |
921 | |
1437 | |
922 | =item $modifiermask = $term->ModLevel3Mask |
1438 | =item $modifiermask = $term->ModLevel3Mask |
923 | |
1439 | |
924 | =item $modifiermask = $term->ModMetaMask |
1440 | =item $modifiermask = $term->ModMetaMask |
925 | |
1441 | |
926 | =item $modifiermask = $term->ModNumLockMask |
1442 | =item $modifiermask = $term->ModNumLockMask |
927 | |
1443 | |
928 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1444 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
929 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1445 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
930 | |
1446 | |
|
|
1447 | =item $screen = $term->current_screen |
|
|
1448 | |
|
|
1449 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1450 | |
|
|
1451 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1452 | |
|
|
1453 | Returns wether the cursor is currently hidden or not. |
|
|
1454 | |
931 | =item $view_start = $term->view_start ([$newvalue]) |
1455 | =item $view_start = $term->view_start ([$newvalue]) |
932 | |
1456 | |
933 | Returns the negative row number of the topmost line. Minimum value is |
1457 | Returns the row number of the topmost displayed line. Maximum value is |
934 | C<0>, which displays the normal terminal contents. Larger values scroll |
1458 | C<0>, which displays the normal terminal contents. Lower values scroll |
935 | this many lines into the scrollback buffer. |
1459 | this many lines into the scrollback buffer. |
936 | |
1460 | |
937 | =item $term->want_refresh |
1461 | =item $term->want_refresh |
938 | |
1462 | |
939 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1463 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
954 | line, starting at column C<$start_col> (default C<0>), which is useful |
1478 | line, starting at column C<$start_col> (default C<0>), which is useful |
955 | to replace only parts of a line. The font index in the rendition will |
1479 | to replace only parts of a line. The font index in the rendition will |
956 | automatically be updated. |
1480 | automatically be updated. |
957 | |
1481 | |
958 | C<$text> is in a special encoding: tabs and wide characters that use more |
1482 | C<$text> is in a special encoding: tabs and wide characters that use more |
959 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1483 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
960 | (C<chr 65535>). Characters with combining characters and other characters |
1484 | characters. Characters with combining characters and other characters that |
961 | that do not fit into the normal tetx encoding will be replaced with |
1485 | do not fit into the normal tetx encoding will be replaced with characters |
962 | characters in the private use area. |
1486 | in the private use area. |
963 | |
1487 | |
964 | You have to obey this encoding when changing text. The advantage is |
1488 | You have to obey this encoding when changing text. The advantage is |
965 | that C<substr> and similar functions work on screen cells and not on |
1489 | that C<substr> and similar functions work on screen cells and not on |
966 | characters. |
1490 | characters. |
967 | |
1491 | |
… | |
… | |
1018 | Return the row number of the first/last row of the line, respectively. |
1542 | Return the row number of the first/last row of the line, respectively. |
1019 | |
1543 | |
1020 | =item $offset = $line->offset_of ($row, $col) |
1544 | =item $offset = $line->offset_of ($row, $col) |
1021 | |
1545 | |
1022 | Returns the character offset of the given row|col pair within the logical |
1546 | Returns the character offset of the given row|col pair within the logical |
1023 | line. |
1547 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1548 | offsets outside the string. |
1024 | |
1549 | |
1025 | =item ($row, $col) = $line->coord_of ($offset) |
1550 | =item ($row, $col) = $line->coord_of ($offset) |
1026 | |
1551 | |
1027 | Translates a string offset into terminal coordinates again. |
1552 | Translates a string offset into terminal coordinates again. |
1028 | |
1553 | |
… | |
… | |
1113 | =item $string = $term->special_decode $text |
1638 | =item $string = $term->special_decode $text |
1114 | |
1639 | |
1115 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1640 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1116 | C<< $term->ROW_t >> for details. |
1641 | C<< $term->ROW_t >> for details. |
1117 | |
1642 | |
1118 | =item $success = $term->grab_button ($button, $modifiermask) |
1643 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1119 | |
1644 | |
|
|
1645 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1646 | |
1120 | Registers a synchronous button grab. See XGrabButton. |
1647 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1648 | manpage. |
1121 | |
1649 | |
1122 | =item $success = $term->grab ($eventtime[, $sync]) |
1650 | =item $success = $term->grab ($eventtime[, $sync]) |
1123 | |
1651 | |
1124 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1652 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1125 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1653 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
… | |
… | |
1141 | |
1669 | |
1142 | Calls XUngrab for the most recent grab. Is called automatically on |
1670 | Calls XUngrab for the most recent grab. Is called automatically on |
1143 | evaluation errors, as it is better to lose the grab in the error case as |
1671 | evaluation errors, as it is better to lose the grab in the error case as |
1144 | the session. |
1672 | the session. |
1145 | |
1673 | |
|
|
1674 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1675 | |
|
|
1676 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1677 | |
|
|
1678 | =item @atoms = $term->XListProperties ($window) |
|
|
1679 | |
|
|
1680 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1681 | |
|
|
1682 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1683 | |
|
|
1684 | =item $term->XDeleteProperty ($window, $property) |
|
|
1685 | |
|
|
1686 | =item $window = $term->DefaultRootWindow |
|
|
1687 | |
|
|
1688 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1689 | |
|
|
1690 | =item $term->XMapWindow ($window) |
|
|
1691 | |
|
|
1692 | =item $term->XUnmapWindow ($window) |
|
|
1693 | |
|
|
1694 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1695 | |
|
|
1696 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1697 | |
|
|
1698 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1699 | |
|
|
1700 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1701 | the source of the display, otherwise those functions map more-or-less |
|
|
1702 | directory onto the X functions of the same name. |
|
|
1703 | |
1146 | =back |
1704 | =back |
1147 | |
1705 | |
1148 | =cut |
1706 | =cut |
1149 | |
1707 | |
1150 | package urxvt::popup; |
1708 | package urxvt::popup; |
… | |
… | |
1165 | $item->{render} ||= sub { $_[0]{text} }; |
1723 | $item->{render} ||= sub { $_[0]{text} }; |
1166 | |
1724 | |
1167 | push @{ $self->{item} }, $item; |
1725 | push @{ $self->{item} }, $item; |
1168 | } |
1726 | } |
1169 | |
1727 | |
1170 | sub add_separator { |
1728 | =item $popup->add_title ($title) |
1171 | my ($self, $sep) = @_; |
|
|
1172 | |
1729 | |
1173 | $sep ||= "═"; |
1730 | Adds a non-clickable title to the popup. |
1174 | |
1731 | |
1175 | $self->add_item ({ |
1732 | =cut |
1176 | rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, |
|
|
1177 | text => "", |
|
|
1178 | render => sub { $sep x $urxvt::TERM->ncol }, |
|
|
1179 | activate => sub { }, |
|
|
1180 | }); |
|
|
1181 | } |
|
|
1182 | |
1733 | |
1183 | sub add_title { |
1734 | sub add_title { |
1184 | my ($self, $title) = @_; |
1735 | my ($self, $title) = @_; |
1185 | |
1736 | |
1186 | $self->add_item ({ |
1737 | $self->add_item ({ |
… | |
… | |
1188 | text => $title, |
1739 | text => $title, |
1189 | activate => sub { }, |
1740 | activate => sub { }, |
1190 | }); |
1741 | }); |
1191 | } |
1742 | } |
1192 | |
1743 | |
|
|
1744 | =item $popup->add_separator ([$sepchr]) |
|
|
1745 | |
|
|
1746 | Creates a separator, optionally using the character given as C<$sepchr>. |
|
|
1747 | |
|
|
1748 | =cut |
|
|
1749 | |
|
|
1750 | sub add_separator { |
|
|
1751 | my ($self, $sep) = @_; |
|
|
1752 | |
|
|
1753 | $sep ||= "="; |
|
|
1754 | |
|
|
1755 | $self->add_item ({ |
|
|
1756 | rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, |
|
|
1757 | text => "", |
|
|
1758 | render => sub { $sep x $self->{term}->ncol }, |
|
|
1759 | activate => sub { }, |
|
|
1760 | }); |
|
|
1761 | } |
|
|
1762 | |
|
|
1763 | =item $popup->add_button ($text, $cb) |
|
|
1764 | |
|
|
1765 | Adds a clickable button to the popup. C<$cb> is called whenever it is |
|
|
1766 | selected. |
|
|
1767 | |
|
|
1768 | =cut |
|
|
1769 | |
1193 | sub add_button { |
1770 | sub add_button { |
1194 | my ($self, $text, $cb) = @_; |
1771 | my ($self, $text, $cb) = @_; |
1195 | |
1772 | |
1196 | $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); |
1773 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1197 | } |
1774 | } |
|
|
1775 | |
|
|
1776 | =item $popup->add_toggle ($text, $cb, $initial_value) |
|
|
1777 | |
|
|
1778 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1779 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1780 | argument. |
|
|
1781 | |
|
|
1782 | =cut |
1198 | |
1783 | |
1199 | sub add_toggle { |
1784 | sub add_toggle { |
1200 | my ($self, $text, $cb, $value) = @_; |
1785 | my ($self, $text, $cb, $value) = @_; |
1201 | |
1786 | |
1202 | my $item; $item = { |
1787 | my $item; $item = { |
1203 | type => "button", |
1788 | type => "button", |
1204 | text => " $text", |
1789 | text => " $text", |
1205 | value => $value, |
1790 | value => $value, |
1206 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1791 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1207 | activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, |
1792 | activate => sub { $cb->($_[1]{value} = !$_[1]{value}); }, |
1208 | }; |
1793 | }; |
1209 | |
1794 | |
1210 | $self->add_item ($item); |
1795 | $self->add_item ($item); |
1211 | } |
1796 | } |
|
|
1797 | |
|
|
1798 | =item $popup->show |
|
|
1799 | |
|
|
1800 | Displays the popup (which is initially hidden). |
|
|
1801 | |
|
|
1802 | =cut |
1212 | |
1803 | |
1213 | sub show { |
1804 | sub show { |
1214 | my ($self) = @_; |
1805 | my ($self) = @_; |
1215 | |
1806 | |
1216 | local $urxvt::popup::self = $self; |
1807 | local $urxvt::popup::self = $self; |
1217 | |
1808 | |
1218 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1809 | my $env = $self->{term}->env; |
|
|
1810 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
|
|
1811 | delete $env->{LC_ALL}; |
|
|
1812 | $env->{LC_CTYPE} = $self->{term}->locale; |
|
|
1813 | |
|
|
1814 | urxvt::term->new ($env, "popup", |
|
|
1815 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
1816 | "-pty-fd" => -1, "-sl" => 0, |
|
|
1817 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1219 | "--transient-for" => $self->{term}->parent, |
1818 | "--transient-for" => $self->{term}->parent, |
1220 | "-display" => $self->{term}->display_id, |
1819 | "-display" => $self->{term}->display_id, |
1221 | "-pe" => "urxvt-popup") |
1820 | "-pe" => "urxvt-popup") |
1222 | or die "unable to create popup window\n"; |
1821 | or die "unable to create popup window\n"; |
1223 | } |
1822 | } |
1224 | |
1823 | |
1225 | sub DESTROY { |
1824 | sub DESTROY { |
1226 | my ($self) = @_; |
1825 | my ($self) = @_; |
1227 | |
1826 | |
1228 | delete $self->{term}{_destroy}{$self}; |
1827 | delete $self->{term}{_destroy}{$self}; |
1229 | $self->{term}->ungrab; |
1828 | $self->{term}->ungrab; |
1230 | } |
1829 | } |
|
|
1830 | |
|
|
1831 | =back |
|
|
1832 | |
|
|
1833 | =cut |
|
|
1834 | |
|
|
1835 | package urxvt::watcher; |
|
|
1836 | |
|
|
1837 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1838 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1839 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1840 | @urxvt::iw::ISA = __PACKAGE__; |
1231 | |
1841 | |
1232 | =head2 The C<urxvt::timer> Class |
1842 | =head2 The C<urxvt::timer> Class |
1233 | |
1843 | |
1234 | This class implements timer watchers/events. Time is represented as a |
1844 | This class implements timer watchers/events. Time is represented as a |
1235 | fractional number of seconds since the epoch. Example: |
1845 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1274 | |
1884 | |
1275 | =item $timer = $timer->start ($tstamp) |
1885 | =item $timer = $timer->start ($tstamp) |
1276 | |
1886 | |
1277 | Set the event trigger time to C<$tstamp> and start the timer. |
1887 | Set the event trigger time to C<$tstamp> and start the timer. |
1278 | |
1888 | |
|
|
1889 | =item $timer = $timer->after ($delay) |
|
|
1890 | |
|
|
1891 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
|
|
1892 | |
1279 | =item $timer = $timer->stop |
1893 | =item $timer = $timer->stop |
1280 | |
1894 | |
1281 | Stop the timer. |
1895 | Stop the timer. |
1282 | |
1896 | |
1283 | =back |
1897 | =back |
… | |
… | |
1288 | |
1902 | |
1289 | $term->{socket} = ... |
1903 | $term->{socket} = ... |
1290 | $term->{iow} = urxvt::iow |
1904 | $term->{iow} = urxvt::iow |
1291 | ->new |
1905 | ->new |
1292 | ->fd (fileno $term->{socket}) |
1906 | ->fd (fileno $term->{socket}) |
1293 | ->events (1) # wait for read data |
1907 | ->events (urxvt::EVENT_READ) |
1294 | ->start |
1908 | ->start |
1295 | ->cb (sub { |
1909 | ->cb (sub { |
1296 | my ($iow, $revents) = @_; |
1910 | my ($iow, $revents) = @_; |
1297 | # $revents must be 1 here, no need to check |
1911 | # $revents must be 1 here, no need to check |
1298 | sysread $term->{socket}, my $buf, 8192 |
1912 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1315 | |
1929 | |
1316 | Set the filedescriptor (not handle) to watch. |
1930 | Set the filedescriptor (not handle) to watch. |
1317 | |
1931 | |
1318 | =item $iow = $iow->events ($eventmask) |
1932 | =item $iow = $iow->events ($eventmask) |
1319 | |
1933 | |
1320 | Set the event mask to watch. Bit #0 (value C<1>) enables watching for read |
1934 | Set the event mask to watch. The only allowed values are |
1321 | data, Bit #1 (value C<2>) enables watching for write data. |
1935 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
|
|
1936 | together, or C<urxvt::EVENT_NONE>. |
1322 | |
1937 | |
1323 | =item $iow = $iow->start |
1938 | =item $iow = $iow->start |
1324 | |
1939 | |
1325 | Start watching for requested events on the given handle. |
1940 | Start watching for requested events on the given handle. |
1326 | |
1941 | |
1327 | =item $iow = $iow->stop |
1942 | =item $iow = $iow->stop |
1328 | |
1943 | |
1329 | Stop watching for events on the given filehandle. |
1944 | Stop watching for events on the given filehandle. |
|
|
1945 | |
|
|
1946 | =back |
|
|
1947 | |
|
|
1948 | =head2 The C<urxvt::iw> Class |
|
|
1949 | |
|
|
1950 | This class implements idle watchers, that get called automatically when |
|
|
1951 | the process is idle. They should return as fast as possible, after doing |
|
|
1952 | some useful work. |
|
|
1953 | |
|
|
1954 | =over 4 |
|
|
1955 | |
|
|
1956 | =item $iw = new urxvt::iw |
|
|
1957 | |
|
|
1958 | Create a new idle watcher object in stopped state. |
|
|
1959 | |
|
|
1960 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1961 | |
|
|
1962 | Set the callback to be called when the watcher triggers. |
|
|
1963 | |
|
|
1964 | =item $timer = $timer->start |
|
|
1965 | |
|
|
1966 | Start the watcher. |
|
|
1967 | |
|
|
1968 | =item $timer = $timer->stop |
|
|
1969 | |
|
|
1970 | Stop the watcher. |
|
|
1971 | |
|
|
1972 | =back |
|
|
1973 | |
|
|
1974 | =head2 The C<urxvt::pw> Class |
|
|
1975 | |
|
|
1976 | This class implements process watchers. They create an event whenever a |
|
|
1977 | process exits, after which they stop automatically. |
|
|
1978 | |
|
|
1979 | my $pid = fork; |
|
|
1980 | ... |
|
|
1981 | $term->{pw} = urxvt::pw |
|
|
1982 | ->new |
|
|
1983 | ->start ($pid) |
|
|
1984 | ->cb (sub { |
|
|
1985 | my ($pw, $exit_status) = @_; |
|
|
1986 | ... |
|
|
1987 | }); |
|
|
1988 | |
|
|
1989 | =over 4 |
|
|
1990 | |
|
|
1991 | =item $pw = new urxvt::pw |
|
|
1992 | |
|
|
1993 | Create a new process watcher in stopped state. |
|
|
1994 | |
|
|
1995 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1996 | |
|
|
1997 | Set the callback to be called when the timer triggers. |
|
|
1998 | |
|
|
1999 | =item $pw = $timer->start ($pid) |
|
|
2000 | |
|
|
2001 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
2002 | |
|
|
2003 | =item $pw = $pw->stop |
|
|
2004 | |
|
|
2005 | Stop the watcher. |
1330 | |
2006 | |
1331 | =back |
2007 | =back |
1332 | |
2008 | |
1333 | =head1 ENVIRONMENT |
2009 | =head1 ENVIRONMENT |
1334 | |
2010 | |
… | |
… | |
1341 | |
2017 | |
1342 | =item == 0 - fatal messages |
2018 | =item == 0 - fatal messages |
1343 | |
2019 | |
1344 | =item >= 3 - script loading and management |
2020 | =item >= 3 - script loading and management |
1345 | |
2021 | |
1346 | =item >=10 - all events received |
2022 | =item >=10 - all called hooks |
|
|
2023 | |
|
|
2024 | =item >=11 - hook reutrn values |
1347 | |
2025 | |
1348 | =back |
2026 | =back |
1349 | |
2027 | |
1350 | =head1 AUTHOR |
2028 | =head1 AUTHOR |
1351 | |
2029 | |