… | |
… | |
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 | |
|
|
40 | Or by adding them to the resource for extensions loaded by default: |
|
|
41 | |
|
|
42 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
39 | |
43 | |
40 | =over 4 |
44 | =over 4 |
41 | |
45 | |
42 | =item selection (enabled by default) |
46 | =item selection (enabled by default) |
43 | |
47 | |
… | |
… | |
63 | the match. For example, the followign adds a regex that matches everything |
67 | the match. For example, the followign adds a regex that matches everything |
64 | between two vertical bars: |
68 | between two vertical bars: |
65 | |
69 | |
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
67 | |
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 | |
68 | You can look at the source of the selection extension to see more |
79 | You can look at the source of the selection extension to see more |
69 | interesting uses, such as parsing a line from beginning to end. |
80 | interesting uses, such as parsing a line from beginning to end. |
70 | |
81 | |
71 | This extension also offers following bindable keyboard commands: |
82 | This extension also offers following bindable keyboard commands: |
72 | |
83 | |
… | |
… | |
83 | =item option-popup (enabled by default) |
94 | =item option-popup (enabled by default) |
84 | |
95 | |
85 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
86 | runtime. |
97 | runtime. |
87 | |
98 | |
|
|
99 | Other extensions can extend this popup menu by pushing a code reference |
|
|
100 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
101 | popup is being displayed. |
|
|
102 | |
|
|
103 | It's sole argument is the popup menu, which can be modified. It should |
|
|
104 | either return nothing or a string, the initial boolean value and a code |
|
|
105 | reference. The string will be used as button text and the code reference |
|
|
106 | will be called when the toggle changes, with the new boolean value as |
|
|
107 | first argument. |
|
|
108 | |
|
|
109 | The following will add an entry C<myoption> that changes |
|
|
110 | C<$self->{myoption}>: |
|
|
111 | |
|
|
112 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
113 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
114 | }; |
|
|
115 | |
88 | =item selection-popup (enabled by default) |
116 | =item selection-popup (enabled by default) |
89 | |
117 | |
90 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
91 | text into various other formats/action (such as uri unescaping, perl |
119 | text into various other formats/action (such as uri unescaping, perl |
92 | evalution, web-browser starting etc.), depending on content. |
120 | evaluation, web-browser starting etc.), depending on content. |
93 | |
121 | |
94 | Other extensions can extend this popup menu by pushing a code reference onto |
122 | Other extensions can extend this popup menu by pushing a code reference |
95 | C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed. |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
|
|
124 | popup is being displayed. |
96 | |
125 | |
97 | It's sole argument is the popup menu, which can be modified. The selection |
126 | It's sole argument is the popup menu, which can be modified. The selection |
98 | is in C<$_>, which can be used to decide wether to add something or not. |
127 | is in C<$_>, which can be used to decide wether to add something or not. |
99 | It should either return nothing or a string and a code reference. The |
128 | It should either return nothing or a string and a code reference. The |
100 | string will be used as button text and the code reference will be called |
129 | string will be used as button text and the code reference will be called |
… | |
… | |
102 | |
131 | |
103 | The following will add an entry C<a to b> that transforms all C<a>s in |
132 | The following will add an entry C<a to b> that transforms all C<a>s in |
104 | the selection to C<b>s, but only if the selection currently contains any |
133 | the selection to C<b>s, but only if the selection currently contains any |
105 | C<a>s: |
134 | C<a>s: |
106 | |
135 | |
107 | push urxvt::ext::selection_popup::hook, sub { |
136 | push @{ $self->{term}{selection_popup_hook} }, sub { |
108 | /a/ ? ("a to be" => sub { s/a/b/g } |
137 | /a/ ? ("a to be" => sub { s/a/b/g } |
109 | : () |
138 | : () |
110 | }; |
139 | }; |
111 | |
140 | |
112 | =item searchable-scrollback<hotkey> (enabled by default) |
141 | =item searchable-scrollback<hotkey> (enabled by default) |
… | |
… | |
122 | bottom. C<Escape> leaves search mode and returns to the point where search |
151 | bottom. C<Escape> leaves search mode and returns to the point where search |
123 | was started, while C<Enter> or C<Return> stay at the current position and |
152 | was started, while C<Enter> or C<Return> stay at the current position and |
124 | additionally stores the first match in the current line into the primary |
153 | additionally stores the first match in the current line into the primary |
125 | selection. |
154 | selection. |
126 | |
155 | |
|
|
156 | =item readline (enabled by default) |
|
|
157 | |
|
|
158 | A support package that tries to make editing with readline easier. At |
|
|
159 | the moment, it reacts to clicking shift-left mouse button by trying to |
|
|
160 | move the text cursor to this position. It does so by generating as many |
|
|
161 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
162 | for programs that correctly support wide characters). |
|
|
163 | |
|
|
164 | To avoid too many false positives, this is only done when: |
|
|
165 | |
|
|
166 | =over 4 |
|
|
167 | |
|
|
168 | =item - the tty is in ICANON state. |
|
|
169 | |
|
|
170 | =item - the text cursor is visible. |
|
|
171 | |
|
|
172 | =item - the primary screen is currently being displayed. |
|
|
173 | |
|
|
174 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
175 | |
|
|
176 | =back |
|
|
177 | |
|
|
178 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
179 | might interfere with selection creation in harmless ways. |
|
|
180 | |
127 | =item selection-autotransform |
181 | =item selection-autotransform |
128 | |
182 | |
129 | This selection allows you to do automatic transforms on a selection |
183 | This selection allows you to do automatic transforms on a selection |
130 | whenever a selection is made. |
184 | whenever a selection is made. |
131 | |
185 | |
… | |
… | |
143 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
197 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
144 | |
198 | |
145 | And this example matches the same,but replaces it with vi-commands you can |
199 | And this example matches the same,but replaces it with vi-commands you can |
146 | paste directly into your (vi :) editor: |
200 | paste directly into your (vi :) editor: |
147 | |
201 | |
148 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
202 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
149 | |
203 | |
150 | Of course, this can be modified to suit your needs and your editor :) |
204 | Of course, this can be modified to suit your needs and your editor :) |
151 | |
205 | |
152 | To expand the example above to typical perl error messages ("XXX at |
206 | To expand the example above to typical perl error messages ("XXX at |
153 | FILENAME line YYY."), you need a slightly more elaborate solution: |
207 | FILENAME line YYY."), you need a slightly more elaborate solution: |
154 | |
208 | |
155 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
209 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
156 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
210 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
157 | |
211 | |
158 | The first line tells the selection code to treat the unchanging part of |
212 | The first line tells the selection code to treat the unchanging part of |
159 | every error message as a selection pattern, and the second line transforms |
213 | every error message as a selection pattern, and the second line transforms |
160 | the message into vi commands to load the file. |
214 | the message into vi commands to load the file. |
|
|
215 | |
|
|
216 | =item tabbed |
|
|
217 | |
|
|
218 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
219 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
|
|
220 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
221 | button per tab. |
|
|
222 | |
|
|
223 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
224 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
225 | while B<Shift-Down> creates a new tab. |
|
|
226 | |
|
|
227 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
228 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
229 | following four resources (shown with defaults): |
|
|
230 | |
|
|
231 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
232 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
233 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
234 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
235 | |
|
|
236 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
237 | indices. |
161 | |
238 | |
162 | =item mark-urls |
239 | =item mark-urls |
163 | |
240 | |
164 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
241 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
165 | make them clickable. When middle-clicked, the program specified in the |
242 | make them clickable. When middle-clicked, the program specified in the |
166 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
243 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
167 | the URL as first argument. |
244 | the URL as first argument. |
168 | |
245 | |
|
|
246 | =item xim-onthespot |
|
|
247 | |
|
|
248 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
249 | not work perfectly, and some input methods don't seem to work well with |
|
|
250 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
251 | kinput2. |
|
|
252 | |
|
|
253 | You enable it by specifying this extension and a preedit style of |
|
|
254 | C<OnTheSpot>, i.e.: |
|
|
255 | |
|
|
256 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
257 | |
|
|
258 | =item automove-background |
|
|
259 | |
|
|
260 | This is basically a very small extension that dynamically changes the |
|
|
261 | background pixmap offset to the window position, in effect creating the |
|
|
262 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
263 | supported in this mode. Exmaple: |
|
|
264 | |
|
|
265 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
266 | |
169 | =item block-graphics-to-ascii |
267 | =item block-graphics-to-ascii |
170 | |
268 | |
171 | A not very useful example of filtering all text output to the terminal, |
269 | A not very useful example of filtering all text output to the terminal, |
172 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
270 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
173 | similar-looking ascii character. |
271 | similar-looking ascii character. |
174 | |
272 | |
175 | =item digital-clock |
273 | =item digital-clock |
176 | |
274 | |
177 | Displays a digital clock using the built-in overlay. |
275 | Displays a digital clock using the built-in overlay. |
178 | |
276 | |
179 | =item example-refresh-hooks |
277 | =item remote-clipboard |
180 | |
278 | |
181 | Displays a very simple digital clock in the upper right corner of the |
279 | Somewhat of a misnomer, this extension adds two menu entries to the |
182 | window. Illustrates overwriting the refresh callbacks to create your own |
280 | selection popup that allows one ti run external commands to store the |
183 | overlays or changes. |
281 | selection somewhere and fetch it again. |
|
|
282 | |
|
|
283 | We use it to implement a "distributed selection mechanism", which just |
|
|
284 | means that one command uploads the file to a remote server, and another |
|
|
285 | reads it. |
|
|
286 | |
|
|
287 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
288 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
289 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
290 | the selection data on STDOUT (also in UTF-8). |
|
|
291 | |
|
|
292 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
293 | |
|
|
294 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
295 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
184 | |
296 | |
185 | =item selection-pastebin |
297 | =item selection-pastebin |
186 | |
298 | |
187 | This is a little rarely useful extension that Uploads the selection as |
299 | This is a little rarely useful extension that Uploads the selection as |
188 | textfile to a remote site (or does other things). (The implementation is |
300 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
208 | After a successful upload the selection will be replaced by the text given |
320 | After a successful upload the selection will be replaced by the text given |
209 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
321 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
210 | for the filename): |
322 | for the filename): |
211 | |
323 | |
212 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
324 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
325 | |
|
|
326 | =item example-refresh-hooks |
|
|
327 | |
|
|
328 | Displays a very simple digital clock in the upper right corner of the |
|
|
329 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
330 | overlays or changes. |
213 | |
331 | |
214 | =back |
332 | =back |
215 | |
333 | |
216 | =head1 API DOCUMENTATION |
334 | =head1 API DOCUMENTATION |
217 | |
335 | |
… | |
… | |
251 | |
369 | |
252 | =back |
370 | =back |
253 | |
371 | |
254 | =head2 Extension Objects |
372 | =head2 Extension Objects |
255 | |
373 | |
256 | Very perl extension is a perl class. A separate perl object is created |
374 | Every perl extension is a perl class. A separate perl object is created |
257 | for each terminal and each extension and passed as the first parameter to |
375 | for each terminal and each extension and passed as the first parameter to |
258 | hooks. So extensions can use their C<$self> object without having to think |
376 | hooks. So extensions can use their C<$self> object without having to think |
259 | about other extensions, with the exception of methods and members that |
377 | about other extensions, with the exception of methods and members that |
260 | begin with an underscore character C<_>: these are reserved for internal |
378 | begin with an underscore character C<_>: these are reserved for internal |
261 | use. |
379 | use. |
… | |
… | |
290 | called whenever the relevant event happens. |
408 | called whenever the relevant event happens. |
291 | |
409 | |
292 | The first argument passed to them is an extension oject as described in |
410 | The first argument passed to them is an extension oject as described in |
293 | the in the C<Extension Objects> section. |
411 | the in the C<Extension Objects> section. |
294 | |
412 | |
295 | B<All> of these hooks must return a boolean value. If it is true, then the |
413 | B<All> of these hooks must return a boolean value. If any of the called |
296 | event counts as being I<consumed>, and the invocation of other hooks is |
414 | hooks returns true, then the event counts as being I<consumed>, and the |
297 | skipped, and the relevant action might not be carried out by the C++ code. |
415 | relevant action might not be carried out by the C++ code. |
298 | |
416 | |
299 | I<< When in doubt, return a false value (preferably C<()>). >> |
417 | I<< When in doubt, return a false value (preferably C<()>). >> |
300 | |
418 | |
301 | =over 4 |
419 | =over 4 |
302 | |
420 | |
303 | =item on_init $term |
421 | =item on_init $term |
304 | |
422 | |
305 | Called after a new terminal object has been initialized, but before |
423 | Called after a new terminal object has been initialized, but before |
306 | windows are created or the command gets run. Most methods are unsafe to |
424 | windows are created or the command gets run. Most methods are unsafe to |
307 | call or deliver senseless data, as terminal size and other characteristics |
425 | call or deliver senseless data, as terminal size and other characteristics |
308 | have not yet been determined. You can safely query and change resources, |
426 | have not yet been determined. You can safely query and change resources |
309 | though. |
427 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
428 | place. |
|
|
429 | |
|
|
430 | =item on_start $term |
|
|
431 | |
|
|
432 | Called at the very end of initialisation of a new terminal, just before |
|
|
433 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
434 | |
|
|
435 | =item on_destroy $term |
|
|
436 | |
|
|
437 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
438 | still fully functional (not for long, though). |
310 | |
439 | |
311 | =item on_reset $term |
440 | =item on_reset $term |
312 | |
441 | |
313 | Called after the screen is "reset" for any reason, such as resizing or |
442 | Called after the screen is "reset" for any reason, such as resizing or |
314 | control sequences. Here is where you can react on changes to size-related |
443 | control sequences. Here is where you can react on changes to size-related |
315 | variables. |
444 | variables. |
316 | |
445 | |
317 | =item on_start $term |
446 | =item on_child_start $term, $pid |
318 | |
447 | |
319 | Called at the very end of initialisation of a new terminal, just before |
448 | Called just after the child process has been C<fork>ed. |
320 | returning to the mainloop. |
449 | |
|
|
450 | =item on_child_exit $term, $status |
|
|
451 | |
|
|
452 | Called just after the child process has exited. C<$status> is the status |
|
|
453 | from C<waitpid>. |
321 | |
454 | |
322 | =item on_sel_make $term, $eventtime |
455 | =item on_sel_make $term, $eventtime |
323 | |
456 | |
324 | Called whenever a selection has been made by the user, but before the |
457 | Called whenever a selection has been made by the user, but before the |
325 | selection text is copied, so changes to the beginning, end or type of the |
458 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
361 | |
494 | |
362 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
495 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
363 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
496 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
364 | number of lines that will be in the scrollback buffer. |
497 | number of lines that will be in the scrollback buffer. |
365 | |
498 | |
|
|
499 | =item on_osc_seq $term, $op, $args |
|
|
500 | |
|
|
501 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
502 | behaviour. The default should be to return an empty list. A true value |
|
|
503 | suppresses execution of the request completely. Make sure you don't get |
|
|
504 | confused by recursive invocations when you output an osc sequence within |
|
|
505 | this callback. |
|
|
506 | |
|
|
507 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
508 | |
366 | =item on_osc_seq $term, $string |
509 | =item on_osc_seq_perl $term, $string |
367 | |
510 | |
368 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
511 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
369 | operating system command) is processed. Cursor position and other state |
512 | operating system command) is processed. Cursor position and other state |
370 | information is up-to-date when this happens. For interoperability, the |
513 | information is up-to-date when this happens. For interoperability, the |
371 | string should start with the extension name and a colon, to distinguish |
514 | string should start with the extension name and a colon, to distinguish |
… | |
… | |
412 | |
555 | |
413 | =item on_refresh_end $term |
556 | =item on_refresh_end $term |
414 | |
557 | |
415 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
558 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
416 | |
559 | |
417 | =item on_keyboard_command $term, $string |
560 | =item on_user_command $term, $string |
418 | |
561 | |
419 | Called whenever the user presses a key combination that has a |
562 | Called whenever the a user-configured event is being activated (e.g. via |
420 | C<perl:string> action bound to it (see description of the B<keysym> |
563 | a C<perl:string> action bound to a key, see description of the B<keysym> |
421 | resource in the @@RXVT_NAME@@(1) manpage). |
564 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
565 | |
|
|
566 | The event is simply the action string. This interface is assumed to change |
|
|
567 | slightly in the future. |
|
|
568 | |
|
|
569 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
570 | |
|
|
571 | Called just after the new window size has been calculcated, but before |
|
|
572 | windows are actually being resized or hints are being set. If this hook |
|
|
573 | returns TRUE, setting of the window hints is being skipped. |
422 | |
574 | |
423 | =item on_x_event $term, $event |
575 | =item on_x_event $term, $event |
424 | |
576 | |
425 | Called on every X event received on the vt window (and possibly other |
577 | Called on every X event received on the vt window (and possibly other |
426 | windows). Should only be used as a last resort. Most event structure |
578 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
436 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
588 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
437 | focus out processing. |
589 | focus out processing. |
438 | |
590 | |
439 | =item on_configure_notify $term, $event |
591 | =item on_configure_notify $term, $event |
440 | |
592 | |
|
|
593 | =item on_property_notify $term, $event |
|
|
594 | |
441 | =item on_key_press $term, $event, $keysym, $octets |
595 | =item on_key_press $term, $event, $keysym, $octets |
442 | |
596 | |
443 | =item on_key_release $term, $event, $keysym |
597 | =item on_key_release $term, $event, $keysym |
444 | |
598 | |
445 | =item on_button_press $term, $event |
599 | =item on_button_press $term, $event |
… | |
… | |
454 | |
608 | |
455 | Called whenever the corresponding X event is received for the terminal If |
609 | Called whenever the corresponding X event is received for the terminal If |
456 | the hook returns true, then the even will be ignored by rxvt-unicode. |
610 | the hook returns true, then the even will be ignored by rxvt-unicode. |
457 | |
611 | |
458 | The event is a hash with most values as named by Xlib (see the XEvent |
612 | The event is a hash with most values as named by Xlib (see the XEvent |
459 | manpage), with the additional members C<row> and C<col>, which are the row |
613 | manpage), with the additional members C<row> and C<col>, which are the |
460 | and column under the mouse cursor. |
614 | (real, not screen-based) row and column under the mouse cursor. |
461 | |
615 | |
462 | C<on_key_press> additionally receives the string rxvt-unicode would |
616 | C<on_key_press> additionally receives the string rxvt-unicode would |
463 | output, if any, in locale-specific encoding. |
617 | output, if any, in locale-specific encoding. |
464 | |
618 | |
465 | subwindow. |
619 | subwindow. |
|
|
620 | |
|
|
621 | =item on_client_message $term, $event |
|
|
622 | |
|
|
623 | =item on_wm_protocols $term, $event |
|
|
624 | |
|
|
625 | =item on_wm_delete_window $term, $event |
|
|
626 | |
|
|
627 | Called when various types of ClientMessage events are received (all with |
|
|
628 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
466 | |
629 | |
467 | =back |
630 | =back |
468 | |
631 | |
469 | =cut |
632 | =cut |
470 | |
633 | |
… | |
… | |
476 | use Scalar::Util (); |
639 | use Scalar::Util (); |
477 | use List::Util (); |
640 | use List::Util (); |
478 | |
641 | |
479 | our $VERSION = 1; |
642 | our $VERSION = 1; |
480 | our $TERM; |
643 | our $TERM; |
|
|
644 | our @TERM_INIT; |
|
|
645 | our @TERM_EXT; |
481 | our @HOOKNAME; |
646 | our @HOOKNAME; |
482 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
647 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
483 | our %OPTION; |
648 | our %OPTION; |
484 | |
649 | |
485 | our $LIBDIR; |
650 | our $LIBDIR; |
486 | our $RESNAME; |
651 | our $RESNAME; |
487 | our $RESCLASS; |
652 | our $RESCLASS; |
488 | our $RXVTNAME; |
653 | our $RXVTNAME; |
489 | |
654 | |
|
|
655 | our $NOCHAR = chr 0xffff; |
|
|
656 | |
490 | =head2 Variables in the C<urxvt> Package |
657 | =head2 Variables in the C<urxvt> Package |
491 | |
658 | |
492 | =over 4 |
659 | =over 4 |
493 | |
660 | |
494 | =item $urxvt::LIBDIR |
661 | =item $urxvt::LIBDIR |
… | |
… | |
506 | |
673 | |
507 | =item $urxvt::TERM |
674 | =item $urxvt::TERM |
508 | |
675 | |
509 | The current terminal. This variable stores the current C<urxvt::term> |
676 | The current terminal. This variable stores the current C<urxvt::term> |
510 | object, whenever a callback/hook is executing. |
677 | object, whenever a callback/hook is executing. |
|
|
678 | |
|
|
679 | =item @urxvt::TERM_INIT |
|
|
680 | |
|
|
681 | All coderefs in this array will be called as methods of the next newly |
|
|
682 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
683 | gets cleared before the codereferences that were in it are being executed, |
|
|
684 | so coderefs can push themselves onto it again if they so desire. |
|
|
685 | |
|
|
686 | This complements to the perl-eval commandline option, but gets executed |
|
|
687 | first. |
|
|
688 | |
|
|
689 | =item @urxvt::TERM_EXT |
|
|
690 | |
|
|
691 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
692 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
693 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
511 | |
694 | |
512 | =back |
695 | =back |
513 | |
696 | |
514 | =head2 Functions in the C<urxvt> Package |
697 | =head2 Functions in the C<urxvt> Package |
515 | |
698 | |
… | |
… | |
529 | |
712 | |
530 | Using this function has the advantage that its output ends up in the |
713 | Using this function has the advantage that its output ends up in the |
531 | correct place, e.g. on stderr of the connecting urxvtc client. |
714 | correct place, e.g. on stderr of the connecting urxvtc client. |
532 | |
715 | |
533 | Messages have a size limit of 1023 bytes currently. |
716 | Messages have a size limit of 1023 bytes currently. |
|
|
717 | |
|
|
718 | =item @terms = urxvt::termlist |
|
|
719 | |
|
|
720 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
721 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
722 | objects that have perl extensions attached will be returned (because there |
|
|
723 | is no urxvt::term objet associated with others). |
534 | |
724 | |
535 | =item $time = urxvt::NOW |
725 | =item $time = urxvt::NOW |
536 | |
726 | |
537 | Returns the "current time" (as per the event loop). |
727 | Returns the "current time" (as per the event loop). |
538 | |
728 | |
… | |
… | |
596 | Return the foreground/background colour index, respectively. |
786 | Return the foreground/background colour index, respectively. |
597 | |
787 | |
598 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
788 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
599 | |
789 | |
600 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
790 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
791 | |
|
|
792 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
601 | |
793 | |
602 | Replace the foreground/background colour in the rendition mask with the |
794 | Replace the foreground/background colour in the rendition mask with the |
603 | specified one. |
795 | specified one. |
604 | |
796 | |
605 | =item $value = urxvt::GET_CUSTOM $rend |
797 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
622 | my $msg = join "", @_; |
814 | my $msg = join "", @_; |
623 | $msg .= "\n" |
815 | $msg .= "\n" |
624 | unless $msg =~ /\n$/; |
816 | unless $msg =~ /\n$/; |
625 | urxvt::warn ($msg); |
817 | urxvt::warn ($msg); |
626 | }; |
818 | }; |
627 | |
|
|
628 | # %ENV is the original startup environment |
|
|
629 | delete $ENV{IFS}; |
|
|
630 | delete $ENV{CDPATH}; |
|
|
631 | delete $ENV{BASH_ENV}; |
|
|
632 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
633 | } |
819 | } |
|
|
820 | |
|
|
821 | no warnings 'utf8'; |
634 | |
822 | |
635 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
823 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
636 | |
824 | |
637 | sub verbose { |
825 | sub verbose { |
638 | my ($level, $msg) = @_; |
826 | my ($level, $msg) = @_; |
… | |
… | |
642 | my %extension_pkg; |
830 | my %extension_pkg; |
643 | |
831 | |
644 | # load a single script into its own package, once only |
832 | # load a single script into its own package, once only |
645 | sub extension_package($) { |
833 | sub extension_package($) { |
646 | my ($path) = @_; |
834 | my ($path) = @_; |
647 | |
|
|
648 | no strict 'refs'; |
|
|
649 | |
835 | |
650 | $extension_pkg{$path} ||= do { |
836 | $extension_pkg{$path} ||= do { |
651 | $path =~ /([^\/\\]+)$/; |
837 | $path =~ /([^\/\\]+)$/; |
652 | my $pkg = $1; |
838 | my $pkg = $1; |
653 | $pkg =~ s/[^[:word:]]/_/g; |
839 | $pkg =~ s/[^[:word:]]/_/g; |
… | |
… | |
656 | verbose 3, "loading extension '$path' into package '$pkg'"; |
842 | verbose 3, "loading extension '$path' into package '$pkg'"; |
657 | |
843 | |
658 | open my $fh, "<:raw", $path |
844 | open my $fh, "<:raw", $path |
659 | or die "$path: $!"; |
845 | or die "$path: $!"; |
660 | |
846 | |
661 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
662 | |
|
|
663 | my $source = |
847 | my $source = |
664 | "package $pkg; use strict; use utf8;\n" |
848 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
665 | . "#line 1 \"$path\"\n{\n" |
849 | . "#line 1 \"$path\"\n{\n" |
666 | . (do { local $/; <$fh> }) |
850 | . (do { local $/; <$fh> }) |
667 | . "\n};\n1"; |
851 | . "\n};\n1"; |
668 | |
852 | |
669 | eval $source |
853 | eval $source |
… | |
… | |
683 | if ($htype == 0) { # INIT |
867 | if ($htype == 0) { # INIT |
684 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
868 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
685 | |
869 | |
686 | my %ext_arg; |
870 | my %ext_arg; |
687 | |
871 | |
|
|
872 | { |
|
|
873 | my @init = @TERM_INIT; |
|
|
874 | @TERM_INIT = (); |
|
|
875 | $_->($TERM) for @init; |
|
|
876 | my @pkg = @TERM_EXT; |
|
|
877 | @TERM_EXT = (); |
|
|
878 | $TERM->register_package ($_) for @pkg; |
|
|
879 | } |
|
|
880 | |
688 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
881 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
689 | if ($_ eq "default") { |
882 | if ($_ eq "default") { |
690 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
883 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
691 | } elsif (/^-(.*)$/) { |
884 | } elsif (/^-(.*)$/) { |
692 | delete $ext_arg{$1}; |
885 | delete $ext_arg{$1}; |
693 | } elsif (/^([^<]+)<(.*)>$/) { |
886 | } elsif (/^([^<]+)<(.*)>$/) { |
694 | push @{ $ext_arg{$1} }, $2; |
887 | push @{ $ext_arg{$1} }, $2; |
695 | } else { |
888 | } else { |
696 | $ext_arg{$_} ||= []; |
889 | $ext_arg{$_} ||= []; |
697 | } |
890 | } |
698 | } |
891 | } |
699 | |
892 | |
700 | while (my ($ext, $argv) = each %ext_arg) { |
893 | for my $ext (sort keys %ext_arg) { |
701 | my @files = grep -f $_, map "$_/$ext", @dirs; |
894 | my @files = grep -f $_, map "$_/$ext", @dirs; |
702 | |
895 | |
703 | if (@files) { |
896 | if (@files) { |
704 | $TERM->register_package (extension_package $files[0], $argv); |
897 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
705 | } else { |
898 | } else { |
706 | warn "perl extension '$ext' not found in perl library search path\n"; |
899 | warn "perl extension '$ext' not found in perl library search path\n"; |
707 | } |
900 | } |
708 | } |
901 | } |
709 | |
902 | |
… | |
… | |
715 | |
908 | |
716 | if (my $cb = $TERM->{_hook}[$htype]) { |
909 | if (my $cb = $TERM->{_hook}[$htype]) { |
717 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
910 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
718 | if $verbosity >= 10; |
911 | if $verbosity >= 10; |
719 | |
912 | |
720 | keys %$cb; |
913 | for my $pkg (keys %$cb) { |
721 | |
|
|
722 | while (my ($pkg, $cb) = each %$cb) { |
|
|
723 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
914 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
724 | and last; |
915 | $retval ||= $retval_; |
725 | |
916 | |
726 | if ($@) { |
917 | if ($@) { |
727 | $TERM->ungrab; # better to lose the grab than the session |
918 | $TERM->ungrab; # better to lose the grab than the session |
728 | warn $@; |
919 | warn $@; |
729 | } |
920 | } |
… | |
… | |
742 | } |
933 | } |
743 | |
934 | |
744 | $retval |
935 | $retval |
745 | } |
936 | } |
746 | |
937 | |
747 | sub exec_async(@) { |
938 | sub SET_COLOR($$$) { |
748 | my $pid = fork; |
939 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
749 | |
|
|
750 | return |
|
|
751 | if !defined $pid or $pid; |
|
|
752 | |
|
|
753 | %ENV = %{ $TERM->env }; |
|
|
754 | |
|
|
755 | exec @_; |
|
|
756 | _exit 255; |
|
|
757 | } |
940 | } |
758 | |
941 | |
759 | # urxvt::term::extension |
942 | # urxvt::term::extension |
760 | |
943 | |
761 | package urxvt::term::extension; |
944 | package urxvt::term::extension; |
… | |
… | |
900 | # find on_xxx subs in the package and register them |
1083 | # find on_xxx subs in the package and register them |
901 | # as hooks |
1084 | # as hooks |
902 | sub register_package { |
1085 | sub register_package { |
903 | my ($self, $pkg, $argv) = @_; |
1086 | my ($self, $pkg, $argv) = @_; |
904 | |
1087 | |
|
|
1088 | no strict 'refs'; |
|
|
1089 | |
|
|
1090 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
1091 | |
|
|
1092 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
1093 | |
905 | my $proxy = bless { |
1094 | my $proxy = bless { |
906 | _pkg => $pkg, |
1095 | _pkg => $pkg, |
907 | argv => $argv, |
1096 | argv => $argv, |
908 | }, $pkg; |
1097 | }, $pkg; |
909 | Scalar::Util::weaken ($proxy->{term} = $self); |
1098 | Scalar::Util::weaken ($proxy->{term} = $self); |
… | |
… | |
924 | hash which defines the environment of the new terminal. |
1113 | hash which defines the environment of the new terminal. |
925 | |
1114 | |
926 | Croaks (and probably outputs an error message) if the new instance |
1115 | Croaks (and probably outputs an error message) if the new instance |
927 | couldn't be created. Returns C<undef> if the new instance didn't |
1116 | couldn't be created. Returns C<undef> if the new instance didn't |
928 | initialise perl, and the terminal object otherwise. The C<init> and |
1117 | initialise perl, and the terminal object otherwise. The C<init> and |
929 | C<start> hooks will be called during this call. |
1118 | C<start> hooks will be called before this call returns, and are free to |
|
|
1119 | refer to global data (which is race free). |
930 | |
1120 | |
931 | =cut |
1121 | =cut |
932 | |
1122 | |
933 | sub new { |
1123 | sub new { |
934 | my ($class, $env, @args) = @_; |
1124 | my ($class, $env, @args) = @_; |
935 | |
1125 | |
|
|
1126 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1127 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1128 | |
936 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1129 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
937 | } |
1130 | } |
938 | |
1131 | |
939 | =item $term->destroy |
1132 | =item $term->destroy |
940 | |
1133 | |
941 | Destroy the terminal object (close the window, free resources |
1134 | Destroy the terminal object (close the window, free resources |
942 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1135 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
943 | watchers (timers, io watchers) are still active. |
1136 | watchers (timers, io watchers) are still active. |
944 | |
1137 | |
|
|
1138 | =item $term->exec_async ($cmd[, @args]) |
|
|
1139 | |
|
|
1140 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
1141 | ("starts") programs in the background. This function takes care of setting |
|
|
1142 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
1143 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
1144 | |
|
|
1145 | Returns the pid of the subprocess or C<undef> on error. |
|
|
1146 | |
|
|
1147 | =cut |
|
|
1148 | |
|
|
1149 | sub exec_async { |
|
|
1150 | my $self = shift; |
|
|
1151 | |
|
|
1152 | my $pid = fork; |
|
|
1153 | |
|
|
1154 | return $pid |
|
|
1155 | if !defined $pid or $pid; |
|
|
1156 | |
|
|
1157 | %ENV = %{ $self->env }; |
|
|
1158 | |
|
|
1159 | exec @_; |
|
|
1160 | urxvt::_exit 255; |
|
|
1161 | } |
|
|
1162 | |
945 | =item $isset = $term->option ($optval[, $set]) |
1163 | =item $isset = $term->option ($optval[, $set]) |
946 | |
1164 | |
947 | Returns true if the option specified by C<$optval> is enabled, and |
1165 | Returns true if the option specified by C<$optval> is enabled, and |
948 | optionally change it. All option values are stored by name in the hash |
1166 | optionally change it. All option values are stored by name in the hash |
949 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1167 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
… | |
… | |
951 | Here is a a likely non-exhaustive list of option names, please see the |
1169 | Here is a a likely non-exhaustive list of option names, please see the |
952 | source file F</src/optinc.h> to see the actual list: |
1170 | source file F</src/optinc.h> to see the actual list: |
953 | |
1171 | |
954 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1172 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
955 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1173 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
956 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1174 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
957 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1175 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
958 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1176 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
959 | tripleclickwords utmpInhibit visualBell |
1177 | transparent tripleclickwords utmpInhibit visualBell |
960 | |
1178 | |
961 | =item $value = $term->resource ($name[, $newval]) |
1179 | =item $value = $term->resource ($name[, $newval]) |
962 | |
1180 | |
963 | Returns the current resource value associated with a given name and |
1181 | Returns the current resource value associated with a given name and |
964 | optionally sets a new value. Setting values is most useful in the C<init> |
1182 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
981 | |
1199 | |
982 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1200 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
983 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1201 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
984 | display_name embed ext_bwidth fade font geometry hold iconName |
1202 | display_name embed ext_bwidth fade font geometry hold iconName |
985 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1203 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
986 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1204 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
987 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1205 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
988 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1206 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
989 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1207 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
990 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1208 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
991 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1209 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
992 | shade term_name title transparent transparent_all tripleclickwords |
1210 | secondaryScreen secondaryScroll selectstyle shade term_name title |
993 | utmpInhibit visualBell |
1211 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
|
|
1212 | visualBell |
994 | |
1213 | |
995 | =cut |
1214 | =cut |
996 | |
1215 | |
997 | sub resource($$;$) { |
1216 | sub resource($$;$) { |
998 | my ($self, $name) = (shift, shift); |
1217 | my ($self, $name) = (shift, shift); |
… | |
… | |
1172 | |
1391 | |
1173 | Normally its not a good idea to use this function, as programs might be |
1392 | Normally its not a good idea to use this function, as programs might be |
1174 | confused by changes in cursor position or scrolling. Its useful inside a |
1393 | confused by changes in cursor position or scrolling. Its useful inside a |
1175 | C<on_add_lines> hook, though. |
1394 | C<on_add_lines> hook, though. |
1176 | |
1395 | |
|
|
1396 | =item $term->scr_change_screen ($screen) |
|
|
1397 | |
|
|
1398 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1399 | |
1177 | =item $term->cmd_parse ($octets) |
1400 | =item $term->cmd_parse ($octets) |
1178 | |
1401 | |
1179 | Similar to C<scr_add_lines>, but the argument must be in the |
1402 | Similar to C<scr_add_lines>, but the argument must be in the |
1180 | locale-specific encoding of the terminal and can contain command sequences |
1403 | locale-specific encoding of the terminal and can contain command sequences |
1181 | (escape codes) that will be interpreted. |
1404 | (escape codes) that will be interpreted. |
… | |
… | |
1191 | Replaces the event mask of the pty watcher by the given event mask. Can |
1414 | Replaces the event mask of the pty watcher by the given event mask. Can |
1192 | be used to suppress input and output handling to the pty/tty. See the |
1415 | be used to suppress input and output handling to the pty/tty. See the |
1193 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1416 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1194 | the previous value. |
1417 | the previous value. |
1195 | |
1418 | |
|
|
1419 | =item $fd = $term->pty_fd |
|
|
1420 | |
|
|
1421 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1422 | is used. |
|
|
1423 | |
1196 | =item $windowid = $term->parent |
1424 | =item $windowid = $term->parent |
1197 | |
1425 | |
1198 | Return the window id of the toplevel window. |
1426 | Return the window id of the toplevel window. |
1199 | |
1427 | |
1200 | =item $windowid = $term->vt |
1428 | =item $windowid = $term->vt |
… | |
… | |
1206 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1434 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1207 | to receive pointer events all the times: |
1435 | to receive pointer events all the times: |
1208 | |
1436 | |
1209 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1437 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1210 | |
1438 | |
|
|
1439 | =item $term->focus_in |
|
|
1440 | |
|
|
1441 | =item $term->focus_out |
|
|
1442 | |
|
|
1443 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1444 | |
|
|
1445 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1446 | |
|
|
1447 | Deliver various fake events to to terminal. |
|
|
1448 | |
1211 | =item $window_width = $term->width |
1449 | =item $window_width = $term->width |
1212 | |
1450 | |
1213 | =item $window_height = $term->height |
1451 | =item $window_height = $term->height |
1214 | |
1452 | |
1215 | =item $font_width = $term->fwidth |
1453 | =item $font_width = $term->fwidth |
… | |
… | |
1245 | =item $env = $term->env |
1483 | =item $env = $term->env |
1246 | |
1484 | |
1247 | Returns a copy of the environment in effect for the terminal as a hashref |
1485 | Returns a copy of the environment in effect for the terminal as a hashref |
1248 | similar to C<\%ENV>. |
1486 | similar to C<\%ENV>. |
1249 | |
1487 | |
|
|
1488 | =item @envv = $term->envv |
|
|
1489 | |
|
|
1490 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1491 | |
|
|
1492 | =item @argv = $term->argv |
|
|
1493 | |
|
|
1494 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1495 | includes the program name as first element. |
|
|
1496 | |
1250 | =cut |
1497 | =cut |
1251 | |
1498 | |
1252 | sub env { |
1499 | sub env { |
1253 | if (my $env = $_[0]->_env) { |
|
|
1254 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1500 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1255 | } else { |
|
|
1256 | +{ %ENV } |
|
|
1257 | } |
|
|
1258 | } |
1501 | } |
1259 | |
1502 | |
1260 | =item $modifiermask = $term->ModLevel3Mask |
1503 | =item $modifiermask = $term->ModLevel3Mask |
1261 | |
1504 | |
1262 | =item $modifiermask = $term->ModMetaMask |
1505 | =item $modifiermask = $term->ModMetaMask |
1263 | |
1506 | |
1264 | =item $modifiermask = $term->ModNumLockMask |
1507 | =item $modifiermask = $term->ModNumLockMask |
1265 | |
1508 | |
1266 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1509 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1267 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1510 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1511 | |
|
|
1512 | =item $screen = $term->current_screen |
|
|
1513 | |
|
|
1514 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1515 | |
|
|
1516 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1517 | |
|
|
1518 | Returns wether the cursor is currently hidden or not. |
1268 | |
1519 | |
1269 | =item $view_start = $term->view_start ([$newvalue]) |
1520 | =item $view_start = $term->view_start ([$newvalue]) |
1270 | |
1521 | |
1271 | Returns the row number of the topmost displayed line. Maximum value is |
1522 | Returns the row number of the topmost displayed line. Maximum value is |
1272 | C<0>, which displays the normal terminal contents. Lower values scroll |
1523 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1292 | line, starting at column C<$start_col> (default C<0>), which is useful |
1543 | line, starting at column C<$start_col> (default C<0>), which is useful |
1293 | to replace only parts of a line. The font index in the rendition will |
1544 | to replace only parts of a line. The font index in the rendition will |
1294 | automatically be updated. |
1545 | automatically be updated. |
1295 | |
1546 | |
1296 | C<$text> is in a special encoding: tabs and wide characters that use more |
1547 | C<$text> is in a special encoding: tabs and wide characters that use more |
1297 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1548 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1298 | (C<chr 65535>). Characters with combining characters and other characters |
1549 | characters. Characters with combining characters and other characters that |
1299 | that do not fit into the normal tetx encoding will be replaced with |
1550 | do not fit into the normal tetx encoding will be replaced with characters |
1300 | characters in the private use area. |
1551 | in the private use area. |
1301 | |
1552 | |
1302 | You have to obey this encoding when changing text. The advantage is |
1553 | You have to obey this encoding when changing text. The advantage is |
1303 | that C<substr> and similar functions work on screen cells and not on |
1554 | that C<substr> and similar functions work on screen cells and not on |
1304 | characters. |
1555 | characters. |
1305 | |
1556 | |
… | |
… | |
1452 | =item $string = $term->special_decode $text |
1703 | =item $string = $term->special_decode $text |
1453 | |
1704 | |
1454 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1705 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1455 | C<< $term->ROW_t >> for details. |
1706 | C<< $term->ROW_t >> for details. |
1456 | |
1707 | |
1457 | =item $success = $term->grab_button ($button, $modifiermask) |
1708 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1458 | |
1709 | |
|
|
1710 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1711 | |
1459 | Registers a synchronous button grab. See the XGrabButton manpage. |
1712 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1713 | manpage. |
1460 | |
1714 | |
1461 | =item $success = $term->grab ($eventtime[, $sync]) |
1715 | =item $success = $term->grab ($eventtime[, $sync]) |
1462 | |
1716 | |
1463 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1717 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1464 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1718 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
… | |
… | |
1479 | =item $term->ungrab |
1733 | =item $term->ungrab |
1480 | |
1734 | |
1481 | Calls XUngrab for the most recent grab. Is called automatically on |
1735 | Calls XUngrab for the most recent grab. Is called automatically on |
1482 | evaluation errors, as it is better to lose the grab in the error case as |
1736 | evaluation errors, as it is better to lose the grab in the error case as |
1483 | the session. |
1737 | the session. |
|
|
1738 | |
|
|
1739 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1740 | |
|
|
1741 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1742 | |
|
|
1743 | =item @atoms = $term->XListProperties ($window) |
|
|
1744 | |
|
|
1745 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1746 | |
|
|
1747 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1748 | |
|
|
1749 | =item $term->XDeleteProperty ($window, $property) |
|
|
1750 | |
|
|
1751 | =item $window = $term->DefaultRootWindow |
|
|
1752 | |
|
|
1753 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1754 | |
|
|
1755 | =item $term->XMapWindow ($window) |
|
|
1756 | |
|
|
1757 | =item $term->XUnmapWindow ($window) |
|
|
1758 | |
|
|
1759 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1760 | |
|
|
1761 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1762 | |
|
|
1763 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1764 | |
|
|
1765 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1766 | the source of the display, otherwise those functions map more-or-less |
|
|
1767 | directory onto the X functions of the same name. |
1484 | |
1768 | |
1485 | =back |
1769 | =back |
1486 | |
1770 | |
1487 | =cut |
1771 | =cut |
1488 | |
1772 | |
… | |
… | |
1552 | my ($self, $text, $cb) = @_; |
1836 | my ($self, $text, $cb) = @_; |
1553 | |
1837 | |
1554 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1838 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1555 | } |
1839 | } |
1556 | |
1840 | |
1557 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1841 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1558 | |
1842 | |
1559 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1843 | Adds a toggle/checkbox item to the popup. The callback gets called |
1560 | whenever it gets toggled, with a boolean indicating its value as its first |
1844 | whenever it gets toggled, with a boolean indicating its new value as its |
1561 | argument. |
1845 | first argument. |
1562 | |
1846 | |
1563 | =cut |
1847 | =cut |
1564 | |
1848 | |
1565 | sub add_toggle { |
1849 | sub add_toggle { |
1566 | my ($self, $text, $cb, $value) = @_; |
1850 | my ($self, $text, $value, $cb) = @_; |
1567 | |
1851 | |
1568 | my $item; $item = { |
1852 | my $item; $item = { |
1569 | type => "button", |
1853 | type => "button", |
1570 | text => " $text", |
1854 | text => " $text", |
1571 | value => $value, |
1855 | value => $value, |
… | |
… | |
1591 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1875 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1592 | delete $env->{LC_ALL}; |
1876 | delete $env->{LC_ALL}; |
1593 | $env->{LC_CTYPE} = $self->{term}->locale; |
1877 | $env->{LC_CTYPE} = $self->{term}->locale; |
1594 | |
1878 | |
1595 | urxvt::term->new ($env, "popup", |
1879 | urxvt::term->new ($env, "popup", |
1596 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1880 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
1881 | "-pty-fd" => -1, "-sl" => 0, |
|
|
1882 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1597 | "--transient-for" => $self->{term}->parent, |
1883 | "--transient-for" => $self->{term}->parent, |
1598 | "-display" => $self->{term}->display_id, |
1884 | "-display" => $self->{term}->display_id, |
1599 | "-pe" => "urxvt-popup") |
1885 | "-pe" => "urxvt-popup") |
1600 | or die "unable to create popup window\n"; |
1886 | or die "unable to create popup window\n"; |
1601 | } |
1887 | } |
… | |
… | |
1606 | delete $self->{term}{_destroy}{$self}; |
1892 | delete $self->{term}{_destroy}{$self}; |
1607 | $self->{term}->ungrab; |
1893 | $self->{term}->ungrab; |
1608 | } |
1894 | } |
1609 | |
1895 | |
1610 | =back |
1896 | =back |
|
|
1897 | |
|
|
1898 | =cut |
|
|
1899 | |
|
|
1900 | package urxvt::watcher; |
|
|
1901 | |
|
|
1902 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1903 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1904 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1905 | @urxvt::iw::ISA = __PACKAGE__; |
1611 | |
1906 | |
1612 | =head2 The C<urxvt::timer> Class |
1907 | =head2 The C<urxvt::timer> Class |
1613 | |
1908 | |
1614 | This class implements timer watchers/events. Time is represented as a |
1909 | This class implements timer watchers/events. Time is represented as a |
1615 | fractional number of seconds since the epoch. Example: |
1910 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1713 | |
2008 | |
1714 | Stop watching for events on the given filehandle. |
2009 | Stop watching for events on the given filehandle. |
1715 | |
2010 | |
1716 | =back |
2011 | =back |
1717 | |
2012 | |
|
|
2013 | =head2 The C<urxvt::iw> Class |
|
|
2014 | |
|
|
2015 | This class implements idle watchers, that get called automatically when |
|
|
2016 | the process is idle. They should return as fast as possible, after doing |
|
|
2017 | some useful work. |
|
|
2018 | |
|
|
2019 | =over 4 |
|
|
2020 | |
|
|
2021 | =item $iw = new urxvt::iw |
|
|
2022 | |
|
|
2023 | Create a new idle watcher object in stopped state. |
|
|
2024 | |
|
|
2025 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
2026 | |
|
|
2027 | Set the callback to be called when the watcher triggers. |
|
|
2028 | |
|
|
2029 | =item $timer = $timer->start |
|
|
2030 | |
|
|
2031 | Start the watcher. |
|
|
2032 | |
|
|
2033 | =item $timer = $timer->stop |
|
|
2034 | |
|
|
2035 | Stop the watcher. |
|
|
2036 | |
|
|
2037 | =back |
|
|
2038 | |
|
|
2039 | =head2 The C<urxvt::pw> Class |
|
|
2040 | |
|
|
2041 | This class implements process watchers. They create an event whenever a |
|
|
2042 | process exits, after which they stop automatically. |
|
|
2043 | |
|
|
2044 | my $pid = fork; |
|
|
2045 | ... |
|
|
2046 | $term->{pw} = urxvt::pw |
|
|
2047 | ->new |
|
|
2048 | ->start ($pid) |
|
|
2049 | ->cb (sub { |
|
|
2050 | my ($pw, $exit_status) = @_; |
|
|
2051 | ... |
|
|
2052 | }); |
|
|
2053 | |
|
|
2054 | =over 4 |
|
|
2055 | |
|
|
2056 | =item $pw = new urxvt::pw |
|
|
2057 | |
|
|
2058 | Create a new process watcher in stopped state. |
|
|
2059 | |
|
|
2060 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
2061 | |
|
|
2062 | Set the callback to be called when the timer triggers. |
|
|
2063 | |
|
|
2064 | =item $pw = $timer->start ($pid) |
|
|
2065 | |
|
|
2066 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
2067 | |
|
|
2068 | =item $pw = $pw->stop |
|
|
2069 | |
|
|
2070 | Stop the watcher. |
|
|
2071 | |
|
|
2072 | =back |
|
|
2073 | |
1718 | =head1 ENVIRONMENT |
2074 | =head1 ENVIRONMENT |
1719 | |
2075 | |
1720 | =head2 URXVT_PERL_VERBOSITY |
2076 | =head2 URXVT_PERL_VERBOSITY |
1721 | |
2077 | |
1722 | This variable controls the verbosity level of the perl extension. Higher |
2078 | This variable controls the verbosity level of the perl extension. Higher |