… | |
… | |
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 the following bindable keyboard command: |
82 | This extension also offers following bindable keyboard commands: |
72 | |
83 | |
73 | =over 4 |
84 | =over 4 |
74 | |
85 | |
75 | =item rot13 |
86 | =item rot13 |
76 | |
87 | |
… | |
… | |
87 | |
98 | |
88 | =item selection-popup (enabled by default) |
99 | =item selection-popup (enabled by default) |
89 | |
100 | |
90 | 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 |
91 | text into various other formats/action (such as uri unescaping, perl |
102 | text into various other formats/action (such as uri unescaping, perl |
92 | evalution, web-browser starting etc.), depending on content. |
103 | evaluation, web-browser starting etc.), depending on content. |
|
|
104 | |
|
|
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. |
|
|
108 | |
|
|
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 | }; |
93 | |
123 | |
94 | =item searchable-scrollback<hotkey> (enabled by default) |
124 | =item searchable-scrollback<hotkey> (enabled by default) |
95 | |
125 | |
96 | Adds regex search functionality to the scrollback buffer, triggered |
126 | Adds regex search functionality to the scrollback buffer, triggered |
97 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
127 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
… | |
… | |
104 | bottom. C<Escape> leaves search mode and returns to the point where search |
134 | bottom. C<Escape> leaves search mode and returns to the point where search |
105 | was started, while C<Enter> or C<Return> stay at the current position and |
135 | was started, while C<Enter> or C<Return> stay at the current position and |
106 | additionally stores the first match in the current line into the primary |
136 | additionally stores the first match in the current line into the primary |
107 | selection. |
137 | selection. |
108 | |
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 | |
109 | =item selection-autotransform |
164 | =item selection-autotransform |
110 | |
165 | |
111 | This selection allows you to do automatic transforms on a selection |
166 | This selection allows you to do automatic transforms on a selection |
112 | whenever a selection is made. |
167 | whenever a selection is made. |
113 | |
168 | |
… | |
… | |
120 | |
175 | |
121 | For example, the following will transform selections of the form |
176 | For example, the following will transform selections of the form |
122 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
177 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
123 | $word>: |
178 | $word>: |
124 | |
179 | |
125 | URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
180 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
126 | |
181 | |
127 | And this example matches the same,but replaces it with vi-commands you can |
182 | And this example matches the same,but replaces it with vi-commands you can |
128 | paste directly into your (vi :) editor: |
183 | paste directly into your (vi :) editor: |
129 | |
184 | |
130 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
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. |
|
|
209 | |
|
|
210 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
211 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
212 | following four resources (shown with defaults): |
|
|
213 | |
|
|
214 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
215 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
216 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
217 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
218 | |
|
|
219 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
220 | indices. |
131 | |
221 | |
132 | =item mark-urls |
222 | =item mark-urls |
133 | |
223 | |
134 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
224 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
135 | make them clickable. When middle-clicked, the program specified in the |
225 | make them clickable. When middle-clicked, the program specified in the |
136 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
226 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
137 | the URL as first argument. |
227 | the URL as first argument. |
138 | |
228 | |
|
|
229 | =item xim-onthespot |
|
|
230 | |
|
|
231 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
232 | not work perfectly, and some input methods don't seem to work well with |
|
|
233 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
234 | kinput2. |
|
|
235 | |
|
|
236 | You enable it by specifying this extension and a preedit style of |
|
|
237 | C<OnTheSpot>, i.e.: |
|
|
238 | |
|
|
239 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
240 | |
|
|
241 | =item automove-background |
|
|
242 | |
|
|
243 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
244 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
245 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
246 | |
|
|
247 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
248 | |
139 | =item block-graphics-to-ascii |
249 | =item block-graphics-to-ascii |
140 | |
250 | |
141 | A not very useful example of filtering all text output to the terminal, |
251 | A not very useful example of filtering all text output to the terminal, |
142 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
252 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
143 | similar-looking ascii character. |
253 | similar-looking ascii character. |
144 | |
254 | |
145 | =item digital-clock |
255 | =item digital-clock |
146 | |
256 | |
147 | Displays a digital clock using the built-in overlay. |
257 | Displays a digital clock using the built-in overlay. |
|
|
258 | |
|
|
259 | =item remote-clipboard |
|
|
260 | |
|
|
261 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
262 | selection popup that allows one ti run external commands to store the |
|
|
263 | selection somewhere and fetch it again. |
|
|
264 | |
|
|
265 | We use it to implement a "distributed selection mechanism", which just |
|
|
266 | means that one command uploads the file to a remote server, and another |
|
|
267 | reads it. |
|
|
268 | |
|
|
269 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
270 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
271 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
272 | the selection data on STDOUT (also in UTF-8). |
|
|
273 | |
|
|
274 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
275 | |
|
|
276 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
277 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
|
|
278 | |
|
|
279 | =item selection-pastebin |
|
|
280 | |
|
|
281 | This is a little rarely useful extension that Uploads the selection as |
|
|
282 | textfile to a remote site (or does other things). (The implementation is |
|
|
283 | not currently secure for use in a multiuser environment as it writes to |
|
|
284 | F</tmp> directly.). |
|
|
285 | |
|
|
286 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
287 | i.e. |
|
|
288 | |
|
|
289 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
290 | |
|
|
291 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
292 | the textfile. This command can be set via a resource: |
|
|
293 | |
|
|
294 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
295 | |
|
|
296 | And the default is likely not useful to anybody but the few people around |
|
|
297 | here :) |
|
|
298 | |
|
|
299 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
300 | the same content should lead to the same filename. |
|
|
301 | |
|
|
302 | After a successful upload the selection will be replaced by the text given |
|
|
303 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
304 | for the filename): |
|
|
305 | |
|
|
306 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
148 | |
307 | |
149 | =item example-refresh-hooks |
308 | =item example-refresh-hooks |
150 | |
309 | |
151 | Displays a very simple digital clock in the upper right corner of the |
310 | Displays a very simple digital clock in the upper right corner of the |
152 | window. Illustrates overwriting the refresh callbacks to create your own |
311 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
231 | called whenever the relevant event happens. |
390 | called whenever the relevant event happens. |
232 | |
391 | |
233 | The first argument passed to them is an extension oject as described in |
392 | The first argument passed to them is an extension oject as described in |
234 | the in the C<Extension Objects> section. |
393 | the in the C<Extension Objects> section. |
235 | |
394 | |
236 | B<All> of these hooks must return a boolean value. If it is true, then the |
395 | B<All> of these hooks must return a boolean value. If any of the called |
237 | event counts as being I<consumed>, and the invocation of other hooks is |
396 | hooks returns true, then the event counts as being I<consumed>, and the |
238 | skipped, and the relevant action might not be carried out by the C++ code. |
397 | relevant action might not be carried out by the C++ code. |
239 | |
398 | |
240 | I<< When in doubt, return a false value (preferably C<()>). >> |
399 | I<< When in doubt, return a false value (preferably C<()>). >> |
241 | |
400 | |
242 | =over 4 |
401 | =over 4 |
243 | |
402 | |
244 | =item on_init $term |
403 | =item on_init $term |
245 | |
404 | |
246 | Called after a new terminal object has been initialized, but before |
405 | Called after a new terminal object has been initialized, but before |
247 | windows are created or the command gets run. Most methods are unsafe to |
406 | windows are created or the command gets run. Most methods are unsafe to |
248 | call or deliver senseless data, as terminal size and other characteristics |
407 | call or deliver senseless data, as terminal size and other characteristics |
249 | have not yet been determined. You can safely query and change resources, |
408 | have not yet been determined. You can safely query and change resources |
250 | though. |
409 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
410 | place. |
|
|
411 | |
|
|
412 | =item on_start $term |
|
|
413 | |
|
|
414 | Called at the very end of initialisation of a new terminal, just before |
|
|
415 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
416 | |
|
|
417 | =item on_destroy $term |
|
|
418 | |
|
|
419 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
420 | still fully functional (not for long, though). |
251 | |
421 | |
252 | =item on_reset $term |
422 | =item on_reset $term |
253 | |
423 | |
254 | Called after the screen is "reset" for any reason, such as resizing or |
424 | Called after the screen is "reset" for any reason, such as resizing or |
255 | control sequences. Here is where you can react on changes to size-related |
425 | control sequences. Here is where you can react on changes to size-related |
256 | variables. |
426 | variables. |
257 | |
427 | |
258 | =item on_start $term |
428 | =item on_child_start $term, $pid |
259 | |
429 | |
260 | Called at the very end of initialisation of a new terminal, just before |
430 | Called just after the child process has been C<fork>ed. |
261 | returning to the mainloop. |
431 | |
|
|
432 | =item on_child_exit $term, $status |
|
|
433 | |
|
|
434 | Called just after the child process has exited. C<$status> is the status |
|
|
435 | from C<waitpid>. |
262 | |
436 | |
263 | =item on_sel_make $term, $eventtime |
437 | =item on_sel_make $term, $eventtime |
264 | |
438 | |
265 | Called whenever a selection has been made by the user, but before the |
439 | Called whenever a selection has been made by the user, but before the |
266 | selection text is copied, so changes to the beginning, end or type of the |
440 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
353 | |
527 | |
354 | =item on_refresh_end $term |
528 | =item on_refresh_end $term |
355 | |
529 | |
356 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
530 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
357 | |
531 | |
358 | =item on_keyboard_command $term, $string |
532 | =item on_user_command $term, $string |
359 | |
533 | |
360 | Called whenever the user presses a key combination that has a |
534 | Called whenever the a user-configured event is being activated (e.g. via |
361 | C<perl:string> action bound to it (see description of the B<keysym> |
535 | a C<perl:string> action bound to a key, see description of the B<keysym> |
362 | resource in the @@RXVT_NAME@@(1) manpage). |
536 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
537 | |
|
|
538 | The event is simply the action string. This interface is assumed to change |
|
|
539 | slightly in the future. |
|
|
540 | |
|
|
541 | =item on_x_event $term, $event |
|
|
542 | |
|
|
543 | Called on every X event received on the vt window (and possibly other |
|
|
544 | windows). Should only be used as a last resort. Most event structure |
|
|
545 | members are not passed. |
363 | |
546 | |
364 | =item on_focus_in $term |
547 | =item on_focus_in $term |
365 | |
548 | |
366 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
549 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
367 | does focus in processing. |
550 | does focus in processing. |
… | |
… | |
369 | =item on_focus_out $term |
552 | =item on_focus_out $term |
370 | |
553 | |
371 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
554 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
372 | focus out processing. |
555 | focus out processing. |
373 | |
556 | |
|
|
557 | =item on_configure_notify $term, $event |
|
|
558 | |
|
|
559 | =item on_property_notify $term, $event |
|
|
560 | |
374 | =item on_key_press $term, $event, $keysym, $octets |
561 | =item on_key_press $term, $event, $keysym, $octets |
375 | |
562 | |
376 | =item on_key_release $term, $event, $keysym |
563 | =item on_key_release $term, $event, $keysym |
377 | |
564 | |
378 | =item on_button_press $term, $event |
565 | =item on_button_press $term, $event |
… | |
… | |
387 | |
574 | |
388 | Called whenever the corresponding X event is received for the terminal If |
575 | Called whenever the corresponding X event is received for the terminal If |
389 | the hook returns true, then the even will be ignored by rxvt-unicode. |
576 | the hook returns true, then the even will be ignored by rxvt-unicode. |
390 | |
577 | |
391 | The event is a hash with most values as named by Xlib (see the XEvent |
578 | The event is a hash with most values as named by Xlib (see the XEvent |
392 | manpage), with the additional members C<row> and C<col>, which are the row |
579 | manpage), with the additional members C<row> and C<col>, which are the |
393 | and column under the mouse cursor. |
580 | (real, not screen-based) row and column under the mouse cursor. |
394 | |
581 | |
395 | C<on_key_press> additionally receives the string rxvt-unicode would |
582 | C<on_key_press> additionally receives the string rxvt-unicode would |
396 | output, if any, in locale-specific encoding. |
583 | output, if any, in locale-specific encoding. |
397 | |
584 | |
398 | subwindow. |
585 | subwindow. |
|
|
586 | |
|
|
587 | =item on_client_message $term, $event |
|
|
588 | |
|
|
589 | =item on_wm_protocols $term, $event |
|
|
590 | |
|
|
591 | =item on_wm_delete_window $term, $event |
|
|
592 | |
|
|
593 | Called when various types of ClientMessage events are received (all with |
|
|
594 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
399 | |
595 | |
400 | =back |
596 | =back |
401 | |
597 | |
402 | =cut |
598 | =cut |
403 | |
599 | |
… | |
… | |
409 | use Scalar::Util (); |
605 | use Scalar::Util (); |
410 | use List::Util (); |
606 | use List::Util (); |
411 | |
607 | |
412 | our $VERSION = 1; |
608 | our $VERSION = 1; |
413 | our $TERM; |
609 | our $TERM; |
|
|
610 | our @TERM_INIT; |
|
|
611 | our @TERM_EXT; |
414 | our @HOOKNAME; |
612 | our @HOOKNAME; |
415 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
613 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
416 | our %OPTION; |
614 | our %OPTION; |
417 | |
615 | |
418 | our $LIBDIR; |
616 | our $LIBDIR; |
419 | our $RESNAME; |
617 | our $RESNAME; |
420 | our $RESCLASS; |
618 | our $RESCLASS; |
421 | our $RXVTNAME; |
619 | our $RXVTNAME; |
422 | |
620 | |
|
|
621 | our $NOCHAR = chr 0xffff; |
|
|
622 | |
423 | =head2 Variables in the C<urxvt> Package |
623 | =head2 Variables in the C<urxvt> Package |
424 | |
624 | |
425 | =over 4 |
625 | =over 4 |
426 | |
626 | |
427 | =item $urxvt::LIBDIR |
627 | =item $urxvt::LIBDIR |
… | |
… | |
439 | |
639 | |
440 | =item $urxvt::TERM |
640 | =item $urxvt::TERM |
441 | |
641 | |
442 | The current terminal. This variable stores the current C<urxvt::term> |
642 | The current terminal. This variable stores the current C<urxvt::term> |
443 | object, whenever a callback/hook is executing. |
643 | object, whenever a callback/hook is executing. |
|
|
644 | |
|
|
645 | =item @urxvt::TERM_INIT |
|
|
646 | |
|
|
647 | All coderefs in this array will be called as methods of the next newly |
|
|
648 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
649 | gets cleared before the codereferences that were in it are being executed, |
|
|
650 | so coderefs can push themselves onto it again if they so desire. |
|
|
651 | |
|
|
652 | This complements to the perl-eval commandline option, but gets executed |
|
|
653 | first. |
|
|
654 | |
|
|
655 | =item @urxvt::TERM_EXT |
|
|
656 | |
|
|
657 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
658 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
659 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
444 | |
660 | |
445 | =back |
661 | =back |
446 | |
662 | |
447 | =head2 Functions in the C<urxvt> Package |
663 | =head2 Functions in the C<urxvt> Package |
448 | |
664 | |
… | |
… | |
463 | Using this function has the advantage that its output ends up in the |
679 | Using this function has the advantage that its output ends up in the |
464 | correct place, e.g. on stderr of the connecting urxvtc client. |
680 | correct place, e.g. on stderr of the connecting urxvtc client. |
465 | |
681 | |
466 | Messages have a size limit of 1023 bytes currently. |
682 | Messages have a size limit of 1023 bytes currently. |
467 | |
683 | |
468 | =item $is_safe = urxvt::safe |
684 | =item @terms = urxvt::termlist |
469 | |
685 | |
470 | Returns true when it is safe to do potentially unsafe things, such as |
686 | Returns all urxvt::term objects that exist in this process, regardless of |
471 | evaluating perl code specified by the user. This is true when urxvt was |
687 | wether they are started, being destroyed etc., so be careful. Only term |
472 | started setuid or setgid. |
688 | objects that have perl extensions attached will be returned (because there |
|
|
689 | is no urxvt::term objet associated with others). |
473 | |
690 | |
474 | =item $time = urxvt::NOW |
691 | =item $time = urxvt::NOW |
475 | |
692 | |
476 | Returns the "current time" (as per the event loop). |
693 | Returns the "current time" (as per the event loop). |
477 | |
694 | |
478 | =item urxvt::CurrentTime |
695 | =item urxvt::CurrentTime |
479 | |
696 | |
480 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
697 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
481 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
698 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
482 | Button4Mask, Button5Mask, AnyModifier |
699 | Button4Mask, Button5Mask, AnyModifier |
|
|
700 | |
|
|
701 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
702 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
703 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
704 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
705 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
706 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
707 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
708 | |
|
|
709 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
710 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
711 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
712 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
713 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
714 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
715 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
483 | |
716 | |
484 | Various constants for use in X calls and event processing. |
717 | Various constants for use in X calls and event processing. |
485 | |
718 | |
486 | =back |
719 | =back |
487 | |
720 | |
… | |
… | |
520 | |
753 | |
521 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
754 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
522 | |
755 | |
523 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
756 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
524 | |
757 | |
|
|
758 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
|
|
759 | |
525 | Replace the foreground/background colour in the rendition mask with the |
760 | Replace the foreground/background colour in the rendition mask with the |
526 | specified one. |
761 | specified one. |
527 | |
762 | |
528 | =item $value = urxvt::GET_CUSTOM $rend |
763 | =item $value = urxvt::GET_CUSTOM $rend |
529 | |
764 | |
… | |
… | |
538 | =back |
773 | =back |
539 | |
774 | |
540 | =cut |
775 | =cut |
541 | |
776 | |
542 | BEGIN { |
777 | BEGIN { |
543 | urxvt->bootstrap; |
|
|
544 | |
|
|
545 | # overwrite perl's warn |
778 | # overwrite perl's warn |
546 | *CORE::GLOBAL::warn = sub { |
779 | *CORE::GLOBAL::warn = sub { |
547 | my $msg = join "", @_; |
780 | my $msg = join "", @_; |
548 | $msg .= "\n" |
781 | $msg .= "\n" |
549 | unless $msg =~ /\n$/; |
782 | unless $msg =~ /\n$/; |
550 | urxvt::warn ($msg); |
783 | urxvt::warn ($msg); |
551 | }; |
784 | }; |
552 | |
|
|
553 | # %ENV is the original startup environment |
|
|
554 | delete $ENV{IFS}; |
|
|
555 | delete $ENV{CDPATH}; |
|
|
556 | delete $ENV{BASH_ENV}; |
|
|
557 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
558 | } |
785 | } |
559 | |
786 | |
560 | my @hook_count; |
787 | no warnings 'utf8'; |
|
|
788 | |
561 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
789 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
562 | |
790 | |
563 | sub verbose { |
791 | sub verbose { |
564 | my ($level, $msg) = @_; |
792 | my ($level, $msg) = @_; |
565 | warn "$msg\n" if $level <= $verbosity; |
793 | warn "$msg\n" if $level <= $verbosity; |
566 | } |
794 | } |
567 | |
795 | |
568 | my $extension_pkg = "extension0000"; |
|
|
569 | my %extension_pkg; |
796 | my %extension_pkg; |
570 | |
797 | |
571 | # load a single script into its own package, once only |
798 | # load a single script into its own package, once only |
572 | sub extension_package($) { |
799 | sub extension_package($) { |
573 | my ($path) = @_; |
800 | my ($path) = @_; |
574 | |
801 | |
575 | $extension_pkg{$path} ||= do { |
802 | $extension_pkg{$path} ||= do { |
576 | my $pkg = "urxvt::" . ($extension_pkg++); |
803 | $path =~ /([^\/\\]+)$/; |
|
|
804 | my $pkg = $1; |
|
|
805 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
806 | $pkg = "urxvt::ext::$pkg"; |
577 | |
807 | |
578 | verbose 3, "loading extension '$path' into package '$pkg'"; |
808 | verbose 3, "loading extension '$path' into package '$pkg'"; |
579 | |
809 | |
580 | open my $fh, "<:raw", $path |
810 | open my $fh, "<:raw", $path |
581 | or die "$path: $!"; |
811 | or die "$path: $!"; |
582 | |
812 | |
583 | my $source = untaint |
813 | my $source = |
584 | "package $pkg; use strict; use utf8;\n" |
814 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
585 | . "use base urxvt::term::extension::;\n" |
|
|
586 | . "#line 1 \"$path\"\n{\n" |
815 | . "#line 1 \"$path\"\n{\n" |
587 | . (do { local $/; <$fh> }) |
816 | . (do { local $/; <$fh> }) |
588 | . "\n};\n1"; |
817 | . "\n};\n1"; |
589 | |
818 | |
590 | eval $source |
819 | eval $source |
… | |
… | |
604 | if ($htype == 0) { # INIT |
833 | if ($htype == 0) { # INIT |
605 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
834 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
606 | |
835 | |
607 | my %ext_arg; |
836 | my %ext_arg; |
608 | |
837 | |
|
|
838 | { |
|
|
839 | my @init = @TERM_INIT; |
|
|
840 | @TERM_INIT = (); |
|
|
841 | $_->($TERM) for @init; |
|
|
842 | my @pkg = @TERM_EXT; |
|
|
843 | @TERM_EXT = (); |
|
|
844 | $TERM->register_package ($_) for @pkg; |
|
|
845 | } |
|
|
846 | |
609 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
847 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
610 | if ($_ eq "default") { |
848 | if ($_ eq "default") { |
611 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
849 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
612 | } elsif (/^-(.*)$/) { |
850 | } elsif (/^-(.*)$/) { |
613 | delete $ext_arg{$1}; |
851 | delete $ext_arg{$1}; |
614 | } elsif (/^([^<]+)<(.*)>$/) { |
852 | } elsif (/^([^<]+)<(.*)>$/) { |
615 | push @{ $ext_arg{$1} }, $2; |
853 | push @{ $ext_arg{$1} }, $2; |
616 | } else { |
854 | } else { |
… | |
… | |
639 | if $verbosity >= 10; |
877 | if $verbosity >= 10; |
640 | |
878 | |
641 | keys %$cb; |
879 | keys %$cb; |
642 | |
880 | |
643 | while (my ($pkg, $cb) = each %$cb) { |
881 | while (my ($pkg, $cb) = each %$cb) { |
644 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
882 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
645 | and last; |
883 | $retval ||= $retval_; |
646 | |
884 | |
647 | if ($@) { |
885 | if ($@) { |
648 | $TERM->ungrab; # better to lose the grab than the session |
886 | $TERM->ungrab; # better to lose the grab than the session |
649 | warn $@; |
887 | warn $@; |
650 | } |
888 | } |
… | |
… | |
653 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
891 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
654 | if $verbosity >= 11; |
892 | if $verbosity >= 11; |
655 | } |
893 | } |
656 | |
894 | |
657 | if ($htype == 1) { # DESTROY |
895 | if ($htype == 1) { # DESTROY |
658 | if (my $hook = delete $TERM->{_hook}) { |
|
|
659 | for my $htype (0..$#$hook) { |
|
|
660 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
661 | or set_should_invoke $htype, 0; |
|
|
662 | } |
|
|
663 | } |
|
|
664 | |
|
|
665 | # clear package objects |
896 | # clear package objects |
666 | %$_ = () for values %{ $TERM->{_pkg} }; |
897 | %$_ = () for values %{ $TERM->{_pkg} }; |
667 | |
898 | |
668 | # clear package |
899 | # clear package |
669 | %$TERM = (); |
900 | %$TERM = (); |
670 | } |
901 | } |
671 | |
902 | |
672 | $retval |
903 | $retval |
673 | } |
904 | } |
674 | |
905 | |
675 | sub exec_async(@) { |
906 | sub SET_COLOR($$$) { |
676 | my $pid = fork; |
907 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
677 | |
|
|
678 | return |
|
|
679 | if !defined $pid or $pid; |
|
|
680 | |
|
|
681 | %ENV = %{ $TERM->env }; |
|
|
682 | |
|
|
683 | exec @_; |
|
|
684 | _exit 255; |
|
|
685 | } |
908 | } |
686 | |
909 | |
687 | # urxvt::term::extension |
910 | # urxvt::term::extension |
688 | |
911 | |
689 | package urxvt::term::extension; |
912 | package urxvt::term::extension; |
… | |
… | |
695 | while (my ($name, $cb) = each %hook) { |
918 | while (my ($name, $cb) = each %hook) { |
696 | my $htype = $HOOKTYPE{uc $name}; |
919 | my $htype = $HOOKTYPE{uc $name}; |
697 | defined $htype |
920 | defined $htype |
698 | or Carp::croak "unsupported hook type '$name'"; |
921 | or Carp::croak "unsupported hook type '$name'"; |
699 | |
922 | |
|
|
923 | $self->set_should_invoke ($htype, +1) |
700 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
924 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
701 | $hook_count[$htype]++ |
|
|
702 | or urxvt::set_should_invoke $htype, 1; |
|
|
703 | } |
|
|
704 | |
925 | |
705 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
926 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
706 | } |
927 | } |
707 | } |
928 | } |
708 | |
929 | |
… | |
… | |
713 | for my $name (@hook) { |
934 | for my $name (@hook) { |
714 | my $htype = $HOOKTYPE{uc $name}; |
935 | my $htype = $HOOKTYPE{uc $name}; |
715 | defined $htype |
936 | defined $htype |
716 | or Carp::croak "unsupported hook type '$name'"; |
937 | or Carp::croak "unsupported hook type '$name'"; |
717 | |
938 | |
|
|
939 | $self->set_should_invoke ($htype, -1) |
718 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
940 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
719 | --$hook_count[$htype] |
|
|
720 | or urxvt::set_should_invoke $htype, 0; |
|
|
721 | } |
|
|
722 | } |
941 | } |
723 | } |
942 | } |
724 | |
943 | |
725 | our $AUTOLOAD; |
944 | our $AUTOLOAD; |
726 | |
945 | |
… | |
… | |
832 | # find on_xxx subs in the package and register them |
1051 | # find on_xxx subs in the package and register them |
833 | # as hooks |
1052 | # as hooks |
834 | sub register_package { |
1053 | sub register_package { |
835 | my ($self, $pkg, $argv) = @_; |
1054 | my ($self, $pkg, $argv) = @_; |
836 | |
1055 | |
|
|
1056 | no strict 'refs'; |
|
|
1057 | |
|
|
1058 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
1059 | |
|
|
1060 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
1061 | |
837 | my $proxy = bless { |
1062 | my $proxy = bless { |
838 | _pkg => $pkg, |
1063 | _pkg => $pkg, |
839 | argv => $argv, |
1064 | argv => $argv, |
840 | }, $pkg; |
1065 | }, $pkg; |
841 | Scalar::Util::weaken ($proxy->{term} = $self); |
1066 | Scalar::Util::weaken ($proxy->{term} = $self); |
… | |
… | |
856 | hash which defines the environment of the new terminal. |
1081 | hash which defines the environment of the new terminal. |
857 | |
1082 | |
858 | Croaks (and probably outputs an error message) if the new instance |
1083 | Croaks (and probably outputs an error message) if the new instance |
859 | couldn't be created. Returns C<undef> if the new instance didn't |
1084 | couldn't be created. Returns C<undef> if the new instance didn't |
860 | initialise perl, and the terminal object otherwise. The C<init> and |
1085 | initialise perl, and the terminal object otherwise. The C<init> and |
861 | C<start> hooks will be called during this call. |
1086 | C<start> hooks will be called before this call returns, and are free to |
|
|
1087 | refer to global data (which is race free). |
862 | |
1088 | |
863 | =cut |
1089 | =cut |
864 | |
1090 | |
865 | sub new { |
1091 | sub new { |
866 | my ($class, $env, @args) = @_; |
1092 | my ($class, $env, @args) = @_; |
867 | |
1093 | |
|
|
1094 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1095 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1096 | |
868 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1097 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
869 | } |
1098 | } |
870 | |
1099 | |
871 | =item $term->destroy |
1100 | =item $term->destroy |
872 | |
1101 | |
873 | Destroy the terminal object (close the window, free resources |
1102 | Destroy the terminal object (close the window, free resources |
874 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1103 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
875 | watchers (timers, io watchers) are still active. |
1104 | watchers (timers, io watchers) are still active. |
876 | |
1105 | |
|
|
1106 | =item $term->exec_async ($cmd[, @args]) |
|
|
1107 | |
|
|
1108 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
1109 | ("starts") programs in the background. This function takes care of setting |
|
|
1110 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
1111 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
1112 | |
|
|
1113 | Returns the pid of the subprocess or C<undef> on error. |
|
|
1114 | |
|
|
1115 | =cut |
|
|
1116 | |
|
|
1117 | sub exec_async { |
|
|
1118 | my $self = shift; |
|
|
1119 | |
|
|
1120 | my $pid = fork; |
|
|
1121 | |
|
|
1122 | return $pid |
|
|
1123 | if !defined $pid or $pid; |
|
|
1124 | |
|
|
1125 | %ENV = %{ $self->env }; |
|
|
1126 | |
|
|
1127 | exec @_; |
|
|
1128 | urxvt::_exit 255; |
|
|
1129 | } |
|
|
1130 | |
877 | =item $isset = $term->option ($optval[, $set]) |
1131 | =item $isset = $term->option ($optval[, $set]) |
878 | |
1132 | |
879 | Returns true if the option specified by C<$optval> is enabled, and |
1133 | Returns true if the option specified by C<$optval> is enabled, and |
880 | optionally change it. All option values are stored by name in the hash |
1134 | optionally change it. All option values are stored by name in the hash |
881 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1135 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
… | |
… | |
883 | Here is a a likely non-exhaustive list of option names, please see the |
1137 | Here is a a likely non-exhaustive list of option names, please see the |
884 | source file F</src/optinc.h> to see the actual list: |
1138 | source file F</src/optinc.h> to see the actual list: |
885 | |
1139 | |
886 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1140 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
887 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1141 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
888 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1142 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
889 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1143 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
890 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1144 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
891 | tripleclickwords utmpInhibit visualBell |
1145 | transparent tripleclickwords utmpInhibit visualBell |
892 | |
1146 | |
893 | =item $value = $term->resource ($name[, $newval]) |
1147 | =item $value = $term->resource ($name[, $newval]) |
894 | |
1148 | |
895 | Returns the current resource value associated with a given name and |
1149 | Returns the current resource value associated with a given name and |
896 | optionally sets a new value. Setting values is most useful in the C<init> |
1150 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
913 | |
1167 | |
914 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1168 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
915 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1169 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
916 | display_name embed ext_bwidth fade font geometry hold iconName |
1170 | display_name embed ext_bwidth fade font geometry hold iconName |
917 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1171 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
918 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1172 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
919 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1173 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
920 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1174 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
921 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1175 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
922 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1176 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
923 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1177 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
924 | shade term_name title transparent transparent_all tripleclickwords |
1178 | secondaryScreen secondaryScroll selectstyle shade term_name title |
925 | utmpInhibit visualBell |
1179 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
|
|
1180 | visualBell |
926 | |
1181 | |
927 | =cut |
1182 | =cut |
928 | |
1183 | |
929 | sub resource($$;$) { |
1184 | sub resource($$;$) { |
930 | my ($self, $name) = (shift, shift); |
1185 | my ($self, $name) = (shift, shift); |
… | |
… | |
1104 | |
1359 | |
1105 | Normally its not a good idea to use this function, as programs might be |
1360 | Normally its not a good idea to use this function, as programs might be |
1106 | confused by changes in cursor position or scrolling. Its useful inside a |
1361 | confused by changes in cursor position or scrolling. Its useful inside a |
1107 | C<on_add_lines> hook, though. |
1362 | C<on_add_lines> hook, though. |
1108 | |
1363 | |
|
|
1364 | =item $term->scr_change_screen ($screen) |
|
|
1365 | |
|
|
1366 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1367 | |
1109 | =item $term->cmd_parse ($octets) |
1368 | =item $term->cmd_parse ($octets) |
1110 | |
1369 | |
1111 | Similar to C<scr_add_lines>, but the argument must be in the |
1370 | Similar to C<scr_add_lines>, but the argument must be in the |
1112 | locale-specific encoding of the terminal and can contain command sequences |
1371 | locale-specific encoding of the terminal and can contain command sequences |
1113 | (escape codes) that will be interpreted. |
1372 | (escape codes) that will be interpreted. |
… | |
… | |
1123 | Replaces the event mask of the pty watcher by the given event mask. Can |
1382 | Replaces the event mask of the pty watcher by the given event mask. Can |
1124 | be used to suppress input and output handling to the pty/tty. See the |
1383 | be used to suppress input and output handling to the pty/tty. See the |
1125 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1384 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1126 | the previous value. |
1385 | the previous value. |
1127 | |
1386 | |
|
|
1387 | =item $fd = $term->pty_fd |
|
|
1388 | |
|
|
1389 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1390 | is used. |
|
|
1391 | |
1128 | =item $windowid = $term->parent |
1392 | =item $windowid = $term->parent |
1129 | |
1393 | |
1130 | Return the window id of the toplevel window. |
1394 | Return the window id of the toplevel window. |
1131 | |
1395 | |
1132 | =item $windowid = $term->vt |
1396 | =item $windowid = $term->vt |
1133 | |
1397 | |
1134 | Return the window id of the terminal window. |
1398 | Return the window id of the terminal window. |
1135 | |
1399 | |
|
|
1400 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1401 | |
|
|
1402 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1403 | to receive pointer events all the times: |
|
|
1404 | |
|
|
1405 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1406 | |
|
|
1407 | =item $term->focus_in |
|
|
1408 | |
|
|
1409 | =item $term->focus_out |
|
|
1410 | |
|
|
1411 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1412 | |
|
|
1413 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1414 | |
|
|
1415 | Deliver various fake events to to terminal. |
|
|
1416 | |
1136 | =item $window_width = $term->width |
1417 | =item $window_width = $term->width |
1137 | |
1418 | |
1138 | =item $window_height = $term->height |
1419 | =item $window_height = $term->height |
1139 | |
1420 | |
1140 | =item $font_width = $term->fwidth |
1421 | =item $font_width = $term->fwidth |
… | |
… | |
1153 | |
1434 | |
1154 | =item $max_scrollback = $term->saveLines |
1435 | =item $max_scrollback = $term->saveLines |
1155 | |
1436 | |
1156 | =item $nrow_plus_saveLines = $term->total_rows |
1437 | =item $nrow_plus_saveLines = $term->total_rows |
1157 | |
1438 | |
1158 | =item $lines_in_scrollback = $term->nsaved |
1439 | =item $topmost_scrollback_row = $term->top_row |
1159 | |
1440 | |
1160 | Return various integers describing terminal characteristics. |
1441 | Return various integers describing terminal characteristics. |
1161 | |
1442 | |
1162 | =item $x_display = $term->display_id |
1443 | =item $x_display = $term->display_id |
1163 | |
1444 | |
… | |
… | |
1189 | =item $modifiermask = $term->ModNumLockMask |
1470 | =item $modifiermask = $term->ModNumLockMask |
1190 | |
1471 | |
1191 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1472 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1192 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1473 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1193 | |
1474 | |
|
|
1475 | =item $screen = $term->current_screen |
|
|
1476 | |
|
|
1477 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1478 | |
|
|
1479 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1480 | |
|
|
1481 | Returns wether the cursor is currently hidden or not. |
|
|
1482 | |
1194 | =item $view_start = $term->view_start ([$newvalue]) |
1483 | =item $view_start = $term->view_start ([$newvalue]) |
1195 | |
1484 | |
1196 | Returns the negative row number of the topmost line. Minimum value is |
1485 | Returns the row number of the topmost displayed line. Maximum value is |
1197 | C<0>, which displays the normal terminal contents. Larger values scroll |
1486 | C<0>, which displays the normal terminal contents. Lower values scroll |
1198 | this many lines into the scrollback buffer. |
1487 | this many lines into the scrollback buffer. |
1199 | |
1488 | |
1200 | =item $term->want_refresh |
1489 | =item $term->want_refresh |
1201 | |
1490 | |
1202 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1491 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1217 | line, starting at column C<$start_col> (default C<0>), which is useful |
1506 | line, starting at column C<$start_col> (default C<0>), which is useful |
1218 | to replace only parts of a line. The font index in the rendition will |
1507 | to replace only parts of a line. The font index in the rendition will |
1219 | automatically be updated. |
1508 | automatically be updated. |
1220 | |
1509 | |
1221 | C<$text> is in a special encoding: tabs and wide characters that use more |
1510 | C<$text> is in a special encoding: tabs and wide characters that use more |
1222 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1511 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1223 | (C<chr 65535>). Characters with combining characters and other characters |
1512 | characters. Characters with combining characters and other characters that |
1224 | that do not fit into the normal tetx encoding will be replaced with |
1513 | do not fit into the normal tetx encoding will be replaced with characters |
1225 | characters in the private use area. |
1514 | in the private use area. |
1226 | |
1515 | |
1227 | You have to obey this encoding when changing text. The advantage is |
1516 | You have to obey this encoding when changing text. The advantage is |
1228 | that C<substr> and similar functions work on screen cells and not on |
1517 | that C<substr> and similar functions work on screen cells and not on |
1229 | characters. |
1518 | characters. |
1230 | |
1519 | |
… | |
… | |
1377 | =item $string = $term->special_decode $text |
1666 | =item $string = $term->special_decode $text |
1378 | |
1667 | |
1379 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1668 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1380 | C<< $term->ROW_t >> for details. |
1669 | C<< $term->ROW_t >> for details. |
1381 | |
1670 | |
1382 | =item $success = $term->grab_button ($button, $modifiermask) |
1671 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1383 | |
1672 | |
|
|
1673 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1674 | |
1384 | Registers a synchronous button grab. See the XGrabButton manpage. |
1675 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1676 | manpage. |
1385 | |
1677 | |
1386 | =item $success = $term->grab ($eventtime[, $sync]) |
1678 | =item $success = $term->grab ($eventtime[, $sync]) |
1387 | |
1679 | |
1388 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1680 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1389 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1681 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
… | |
… | |
1404 | =item $term->ungrab |
1696 | =item $term->ungrab |
1405 | |
1697 | |
1406 | Calls XUngrab for the most recent grab. Is called automatically on |
1698 | Calls XUngrab for the most recent grab. Is called automatically on |
1407 | evaluation errors, as it is better to lose the grab in the error case as |
1699 | evaluation errors, as it is better to lose the grab in the error case as |
1408 | the session. |
1700 | the session. |
|
|
1701 | |
|
|
1702 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1703 | |
|
|
1704 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1705 | |
|
|
1706 | =item @atoms = $term->XListProperties ($window) |
|
|
1707 | |
|
|
1708 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1709 | |
|
|
1710 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1711 | |
|
|
1712 | =item $term->XDeleteProperty ($window, $property) |
|
|
1713 | |
|
|
1714 | =item $window = $term->DefaultRootWindow |
|
|
1715 | |
|
|
1716 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1717 | |
|
|
1718 | =item $term->XMapWindow ($window) |
|
|
1719 | |
|
|
1720 | =item $term->XUnmapWindow ($window) |
|
|
1721 | |
|
|
1722 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1723 | |
|
|
1724 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1725 | |
|
|
1726 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1727 | |
|
|
1728 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1729 | the source of the display, otherwise those functions map more-or-less |
|
|
1730 | directory onto the X functions of the same name. |
1409 | |
1731 | |
1410 | =back |
1732 | =back |
1411 | |
1733 | |
1412 | =cut |
1734 | =cut |
1413 | |
1735 | |
… | |
… | |
1515 | my $env = $self->{term}->env; |
1837 | my $env = $self->{term}->env; |
1516 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1838 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1517 | delete $env->{LC_ALL}; |
1839 | delete $env->{LC_ALL}; |
1518 | $env->{LC_CTYPE} = $self->{term}->locale; |
1840 | $env->{LC_CTYPE} = $self->{term}->locale; |
1519 | |
1841 | |
1520 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1842 | urxvt::term->new ($env, "popup", |
1521 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1843 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
1844 | "-pty-fd" => -1, "-sl" => 0, |
|
|
1845 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1522 | "--transient-for" => $self->{term}->parent, |
1846 | "--transient-for" => $self->{term}->parent, |
1523 | "-display" => $self->{term}->display_id, |
1847 | "-display" => $self->{term}->display_id, |
1524 | "-pe" => "urxvt-popup") |
1848 | "-pe" => "urxvt-popup") |
1525 | or die "unable to create popup window\n"; |
1849 | or die "unable to create popup window\n"; |
1526 | } |
1850 | } |
… | |
… | |
1531 | delete $self->{term}{_destroy}{$self}; |
1855 | delete $self->{term}{_destroy}{$self}; |
1532 | $self->{term}->ungrab; |
1856 | $self->{term}->ungrab; |
1533 | } |
1857 | } |
1534 | |
1858 | |
1535 | =back |
1859 | =back |
|
|
1860 | |
|
|
1861 | =cut |
|
|
1862 | |
|
|
1863 | package urxvt::watcher; |
|
|
1864 | |
|
|
1865 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1866 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1867 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1868 | @urxvt::iw::ISA = __PACKAGE__; |
1536 | |
1869 | |
1537 | =head2 The C<urxvt::timer> Class |
1870 | =head2 The C<urxvt::timer> Class |
1538 | |
1871 | |
1539 | This class implements timer watchers/events. Time is represented as a |
1872 | This class implements timer watchers/events. Time is represented as a |
1540 | fractional number of seconds since the epoch. Example: |
1873 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1578 | Start the timer. |
1911 | Start the timer. |
1579 | |
1912 | |
1580 | =item $timer = $timer->start ($tstamp) |
1913 | =item $timer = $timer->start ($tstamp) |
1581 | |
1914 | |
1582 | Set the event trigger time to C<$tstamp> and start the timer. |
1915 | Set the event trigger time to C<$tstamp> and start the timer. |
|
|
1916 | |
|
|
1917 | =item $timer = $timer->after ($delay) |
|
|
1918 | |
|
|
1919 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1583 | |
1920 | |
1584 | =item $timer = $timer->stop |
1921 | =item $timer = $timer->stop |
1585 | |
1922 | |
1586 | Stop the timer. |
1923 | Stop the timer. |
1587 | |
1924 | |
… | |
… | |
1634 | |
1971 | |
1635 | Stop watching for events on the given filehandle. |
1972 | Stop watching for events on the given filehandle. |
1636 | |
1973 | |
1637 | =back |
1974 | =back |
1638 | |
1975 | |
|
|
1976 | =head2 The C<urxvt::iw> Class |
|
|
1977 | |
|
|
1978 | This class implements idle watchers, that get called automatically when |
|
|
1979 | the process is idle. They should return as fast as possible, after doing |
|
|
1980 | some useful work. |
|
|
1981 | |
|
|
1982 | =over 4 |
|
|
1983 | |
|
|
1984 | =item $iw = new urxvt::iw |
|
|
1985 | |
|
|
1986 | Create a new idle watcher object in stopped state. |
|
|
1987 | |
|
|
1988 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1989 | |
|
|
1990 | Set the callback to be called when the watcher triggers. |
|
|
1991 | |
|
|
1992 | =item $timer = $timer->start |
|
|
1993 | |
|
|
1994 | Start the watcher. |
|
|
1995 | |
|
|
1996 | =item $timer = $timer->stop |
|
|
1997 | |
|
|
1998 | Stop the watcher. |
|
|
1999 | |
|
|
2000 | =back |
|
|
2001 | |
|
|
2002 | =head2 The C<urxvt::pw> Class |
|
|
2003 | |
|
|
2004 | This class implements process watchers. They create an event whenever a |
|
|
2005 | process exits, after which they stop automatically. |
|
|
2006 | |
|
|
2007 | my $pid = fork; |
|
|
2008 | ... |
|
|
2009 | $term->{pw} = urxvt::pw |
|
|
2010 | ->new |
|
|
2011 | ->start ($pid) |
|
|
2012 | ->cb (sub { |
|
|
2013 | my ($pw, $exit_status) = @_; |
|
|
2014 | ... |
|
|
2015 | }); |
|
|
2016 | |
|
|
2017 | =over 4 |
|
|
2018 | |
|
|
2019 | =item $pw = new urxvt::pw |
|
|
2020 | |
|
|
2021 | Create a new process watcher in stopped state. |
|
|
2022 | |
|
|
2023 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
2024 | |
|
|
2025 | Set the callback to be called when the timer triggers. |
|
|
2026 | |
|
|
2027 | =item $pw = $timer->start ($pid) |
|
|
2028 | |
|
|
2029 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
2030 | |
|
|
2031 | =item $pw = $pw->stop |
|
|
2032 | |
|
|
2033 | Stop the watcher. |
|
|
2034 | |
|
|
2035 | =back |
|
|
2036 | |
1639 | =head1 ENVIRONMENT |
2037 | =head1 ENVIRONMENT |
1640 | |
2038 | |
1641 | =head2 URXVT_PERL_VERBOSITY |
2039 | =head2 URXVT_PERL_VERBOSITY |
1642 | |
2040 | |
1643 | This variable controls the verbosity level of the perl extension. Higher |
2041 | This variable controls the verbosity level of the perl extension. Higher |