… | |
… | |
35 | |
35 | |
36 | You can activate them like this: |
36 | You can activate them like this: |
37 | |
37 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
38 | @@RXVT_NAME@@ -pe <extensionname> |
39 | |
39 | |
|
|
40 | Or by adding them to the resource for extensions loaded by default: |
|
|
41 | |
|
|
42 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
|
|
43 | |
40 | =over 4 |
44 | =over 4 |
41 | |
45 | |
42 | =item selection (enabled by default) |
46 | =item selection (enabled by default) |
43 | |
47 | |
44 | (More) intelligent selection. This extension tries to be more intelligent |
48 | (More) intelligent selection. This extension tries to be more intelligent |
45 | when the user extends selections (double-click). Right now, it tries to |
49 | when the user extends selections (double-click and further clicks). Right |
46 | select urls and complete shell-quoted arguments, which is very convenient, |
50 | now, it tries to select words, urls and complete shell-quoted |
47 | too, if your F<ls> supports C<--quoting-style=shell>. |
51 | arguments, which is very convenient, too, if your F<ls> supports |
|
|
52 | C<--quoting-style=shell>. |
48 | |
53 | |
|
|
54 | A double-click usually selects the word under the cursor, further clicks |
|
|
55 | will enlarge the selection. |
|
|
56 | |
|
|
57 | The selection works by trying to match a number of regexes and displaying |
|
|
58 | them in increasing order of length. You can add your own regexes by |
|
|
59 | specifying resources of the form: |
|
|
60 | |
|
|
61 | URxvt.selection.pattern-0: perl-regex |
|
|
62 | URxvt.selection.pattern-1: perl-regex |
|
|
63 | ... |
|
|
64 | |
|
|
65 | The index number (0, 1...) must not have any holes, and each regex must |
|
|
66 | contain at least one pair of capturing parentheses, which will be used for |
|
|
67 | the match. For example, the followign adds a regex that matches everything |
|
|
68 | between two vertical bars: |
|
|
69 | |
|
|
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
71 | |
|
|
72 | Another example: Programs I use often output "absolute path: " at the |
|
|
73 | beginning of a line when they process multiple files. The following |
|
|
74 | pattern matches the filename (note, there is a single space at the very |
|
|
75 | end): |
|
|
76 | |
|
|
77 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
|
|
78 | |
|
|
79 | You can look at the source of the selection extension to see more |
|
|
80 | interesting uses, such as parsing a line from beginning to end. |
|
|
81 | |
49 | It also offers the following bindable keyboard command: |
82 | This extension also offers following bindable keyboard commands: |
50 | |
83 | |
51 | =over 4 |
84 | =over 4 |
52 | |
85 | |
53 | =item rot13 |
86 | =item rot13 |
54 | |
87 | |
… | |
… | |
65 | |
98 | |
66 | =item selection-popup (enabled by default) |
99 | =item selection-popup (enabled by default) |
67 | |
100 | |
68 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
101 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
69 | text into various other formats/action (such as uri unescaping, perl |
102 | text into various other formats/action (such as uri unescaping, perl |
70 | 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 | }; |
71 | |
123 | |
72 | =item searchable-scrollback<hotkey> (enabled by default) |
124 | =item searchable-scrollback<hotkey> (enabled by default) |
73 | |
125 | |
74 | Adds regex search functionality to the scrollback buffer, triggered |
126 | Adds regex search functionality to the scrollback buffer, triggered |
75 | by a hotkey (default: C<M-s>). When in search mode, normal terminal |
127 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
76 | input/output is suspended. |
128 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
129 | screen. |
77 | |
130 | |
78 | C</> starts an incremental regex search, C<n> searches further, C<p> or |
131 | Inputting characters appends them to the regex and continues incremental |
79 | C<N> jump to the previous match, C<G> jumps to the bottom and clears the |
132 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
80 | history, C<enter> leaves search mode at the current position and C<escape> |
133 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
81 | returns to the original position. |
134 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
135 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
136 | additionally stores the first match in the current line into the primary |
|
|
137 | selection. |
82 | |
138 | |
83 | =item digital-clock |
139 | =item readline (enabled by default) |
84 | |
140 | |
85 | Displays a digital clock using the built-in overlay. |
141 | A support package that tries to make editing with readline easier. At the |
|
|
142 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
143 | move the text cursor to this position. It does so by generating as many |
|
|
144 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
145 | for programs that correctly support wide characters). |
|
|
146 | |
|
|
147 | To avoid too many false positives, this is only done when: |
|
|
148 | |
|
|
149 | =over 4 |
|
|
150 | |
|
|
151 | =item - the tty is in ICANON state. |
|
|
152 | |
|
|
153 | =item - the text cursor is visible. |
|
|
154 | |
|
|
155 | =item - the primary screen is currently being displayed. |
|
|
156 | |
|
|
157 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
158 | |
|
|
159 | =back |
|
|
160 | |
|
|
161 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
162 | might interfere with selection creation in harmless ways. |
|
|
163 | |
|
|
164 | =item selection-autotransform |
|
|
165 | |
|
|
166 | This selection allows you to do automatic transforms on a selection |
|
|
167 | whenever a selection is made. |
|
|
168 | |
|
|
169 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
170 | operator) that modify C<$_> as resources: |
|
|
171 | |
|
|
172 | URxvt.selection-autotransform.0: transform |
|
|
173 | URxvt.selection-autotransform.1: transform |
|
|
174 | ... |
|
|
175 | |
|
|
176 | For example, the following will transform selections of the form |
|
|
177 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
178 | $word>: |
|
|
179 | |
|
|
180 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
181 | |
|
|
182 | And this example matches the same,but replaces it with vi-commands you can |
|
|
183 | paste directly into your (vi :) editor: |
|
|
184 | |
|
|
185 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
186 | |
|
|
187 | Of course, this can be modified to suit your needs and your editor :) |
|
|
188 | |
|
|
189 | To expand the example above to typical perl error messages ("XXX at |
|
|
190 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
191 | |
|
|
192 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
193 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
194 | |
|
|
195 | The first line tells the selection code to treat the unchanging part of |
|
|
196 | every error message as a selection pattern, and the second line transforms |
|
|
197 | the message into vi commands to load the file. |
|
|
198 | |
|
|
199 | =item tabbed |
|
|
200 | |
|
|
201 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
202 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
|
|
203 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
204 | button per tab. |
|
|
205 | |
|
|
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
207 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
208 | while B<Shift-Down> creates a new tab. |
86 | |
209 | |
87 | =item mark-urls |
210 | =item mark-urls |
88 | |
211 | |
89 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
212 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
90 | make them clickable. When clicked, the program specified in the resource |
213 | make them clickable. When middle-clicked, the program specified in the |
91 | C<urlLauncher> (default C<x-www-browser>) will be started. |
214 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
|
|
215 | the URL as first argument. |
|
|
216 | |
|
|
217 | =item xim-onthespot |
|
|
218 | |
|
|
219 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
220 | not work perfectly, and some input methods don't seem to work well with |
|
|
221 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
222 | kinput2. |
|
|
223 | |
|
|
224 | You enable it by specifying this extension and a preedit style of |
|
|
225 | C<OnTheSpot>, i.e.: |
|
|
226 | |
|
|
227 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
228 | |
|
|
229 | =item automove-background |
|
|
230 | |
|
|
231 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
232 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
233 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
234 | |
|
|
235 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
92 | |
236 | |
93 | =item block-graphics-to-ascii |
237 | =item block-graphics-to-ascii |
94 | |
238 | |
95 | A not very useful example of filtering all text output to the terminal, |
239 | A not very useful example of filtering all text output to the terminal, |
96 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
240 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
97 | similar-looking ascii character. |
241 | similar-looking ascii character. |
98 | |
242 | |
|
|
243 | =item digital-clock |
|
|
244 | |
|
|
245 | Displays a digital clock using the built-in overlay. |
|
|
246 | |
99 | =item example-refresh-hooks |
247 | =item example-refresh-hooks |
100 | |
248 | |
101 | Displays a very simple digital clock in the upper right corner of the |
249 | Displays a very simple digital clock in the upper right corner of the |
102 | window. Illustrates overwriting the refresh callbacks to create your own |
250 | window. Illustrates overwriting the refresh callbacks to create your own |
103 | overlays or changes. |
251 | overlays or changes. |
|
|
252 | |
|
|
253 | =item selection-pastebin |
|
|
254 | |
|
|
255 | This is a little rarely useful extension that Uploads the selection as |
|
|
256 | textfile to a remote site (or does other things). (The implementation is |
|
|
257 | not currently secure for use in a multiuser environment as it writes to |
|
|
258 | F</tmp> directly.). |
|
|
259 | |
|
|
260 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
261 | i.e. |
|
|
262 | |
|
|
263 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
264 | |
|
|
265 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
266 | the textfile. This command can be set via a resource: |
|
|
267 | |
|
|
268 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
269 | |
|
|
270 | And the default is likely not useful to anybody but the few people around |
|
|
271 | here :) |
|
|
272 | |
|
|
273 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
274 | the same content should lead to the same filename. |
|
|
275 | |
|
|
276 | After a successful upload the selection will be replaced by the text given |
|
|
277 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
278 | for the filename): |
|
|
279 | |
|
|
280 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
104 | |
281 | |
105 | =back |
282 | =back |
106 | |
283 | |
107 | =head1 API DOCUMENTATION |
284 | =head1 API DOCUMENTATION |
108 | |
285 | |
… | |
… | |
181 | called whenever the relevant event happens. |
358 | called whenever the relevant event happens. |
182 | |
359 | |
183 | The first argument passed to them is an extension oject as described in |
360 | The first argument passed to them is an extension oject as described in |
184 | the in the C<Extension Objects> section. |
361 | the in the C<Extension Objects> section. |
185 | |
362 | |
186 | B<All> of these hooks must return a boolean value. If it is true, then the |
363 | B<All> of these hooks must return a boolean value. If any of the called |
187 | event counts as being I<consumed>, and the invocation of other hooks is |
364 | hooks returns true, then the event counts as being I<consumed>, and the |
188 | skipped, and the relevant action might not be carried out by the C++ code. |
365 | relevant action might not be carried out by the C++ code. |
189 | |
366 | |
190 | I<< When in doubt, return a false value (preferably C<()>). >> |
367 | I<< When in doubt, return a false value (preferably C<()>). >> |
191 | |
368 | |
192 | =over 4 |
369 | =over 4 |
193 | |
370 | |
194 | =item on_init $term |
371 | =item on_init $term |
195 | |
372 | |
196 | Called after a new terminal object has been initialized, but before |
373 | Called after a new terminal object has been initialized, but before |
197 | windows are created or the command gets run. Most methods are unsafe to |
374 | windows are created or the command gets run. Most methods are unsafe to |
198 | call or deliver senseless data, as terminal size and other characteristics |
375 | call or deliver senseless data, as terminal size and other characteristics |
199 | have not yet been determined. You can safely query and change resources, |
376 | have not yet been determined. You can safely query and change resources |
200 | though. |
377 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
378 | place. |
|
|
379 | |
|
|
380 | =item on_start $term |
|
|
381 | |
|
|
382 | Called at the very end of initialisation of a new terminal, just before |
|
|
383 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
384 | |
|
|
385 | =item on_destroy $term |
|
|
386 | |
|
|
387 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
388 | still fully functional (not for long, though). |
201 | |
389 | |
202 | =item on_reset $term |
390 | =item on_reset $term |
203 | |
391 | |
204 | Called after the screen is "reset" for any reason, such as resizing or |
392 | Called after the screen is "reset" for any reason, such as resizing or |
205 | control sequences. Here is where you can react on changes to size-related |
393 | control sequences. Here is where you can react on changes to size-related |
206 | variables. |
394 | variables. |
207 | |
395 | |
208 | =item on_start $term |
396 | =item on_child_start $term, $pid |
209 | |
397 | |
210 | Called at the very end of initialisation of a new terminal, just before |
398 | Called just after the child process has been C<fork>ed. |
211 | returning to the mainloop. |
399 | |
|
|
400 | =item on_child_exit $term, $status |
|
|
401 | |
|
|
402 | Called just after the child process has exited. C<$status> is the status |
|
|
403 | from C<waitpid>. |
212 | |
404 | |
213 | =item on_sel_make $term, $eventtime |
405 | =item on_sel_make $term, $eventtime |
214 | |
406 | |
215 | Called whenever a selection has been made by the user, but before the |
407 | Called whenever a selection has been made by the user, but before the |
216 | selection text is copied, so changes to the beginning, end or type of the |
408 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
230 | =item on_sel_extend $term |
422 | =item on_sel_extend $term |
231 | |
423 | |
232 | Called whenever the user tries to extend the selection (e.g. with a double |
424 | Called whenever the user tries to extend the selection (e.g. with a double |
233 | click) and is either supposed to return false (normal operation), or |
425 | click) and is either supposed to return false (normal operation), or |
234 | should extend the selection itelf and return true to suppress the built-in |
426 | should extend the selection itelf and return true to suppress the built-in |
235 | processing. |
427 | processing. This can happen multiple times, as long as the callback |
|
|
428 | returns true, it will be called on every further click by the user and is |
|
|
429 | supposed to enlarge the selection more and more, if possible. |
236 | |
430 | |
237 | See the F<selection> example extension. |
431 | See the F<selection> example extension. |
238 | |
432 | |
239 | =item on_view_change $term, $offset |
433 | =item on_view_change $term, $offset |
240 | |
434 | |
… | |
… | |
307 | |
501 | |
308 | Called whenever the user presses a key combination that has a |
502 | Called whenever the user presses a key combination that has a |
309 | C<perl:string> action bound to it (see description of the B<keysym> |
503 | C<perl:string> action bound to it (see description of the B<keysym> |
310 | resource in the @@RXVT_NAME@@(1) manpage). |
504 | resource in the @@RXVT_NAME@@(1) manpage). |
311 | |
505 | |
|
|
506 | =item on_x_event $term, $event |
|
|
507 | |
|
|
508 | Called on every X event received on the vt window (and possibly other |
|
|
509 | windows). Should only be used as a last resort. Most event structure |
|
|
510 | members are not passed. |
|
|
511 | |
312 | =item on_focus_in $term |
512 | =item on_focus_in $term |
313 | |
513 | |
314 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
514 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
315 | does focus in processing. |
515 | does focus in processing. |
316 | |
516 | |
317 | =item on_focus_out $term |
517 | =item on_focus_out $term |
318 | |
518 | |
319 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
519 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
320 | focus out processing. |
520 | focus out processing. |
321 | |
521 | |
|
|
522 | =item on_configure_notify $term, $event |
|
|
523 | |
|
|
524 | =item on_property_notify $term, $event |
|
|
525 | |
322 | =item on_key_press $term, $event, $keysym, $octets |
526 | =item on_key_press $term, $event, $keysym, $octets |
323 | |
527 | |
324 | =item on_key_release $term, $event, $keysym |
528 | =item on_key_release $term, $event, $keysym |
325 | |
529 | |
326 | =item on_button_press $term, $event |
530 | =item on_button_press $term, $event |
… | |
… | |
335 | |
539 | |
336 | Called whenever the corresponding X event is received for the terminal If |
540 | Called whenever the corresponding X event is received for the terminal If |
337 | the hook returns true, then the even will be ignored by rxvt-unicode. |
541 | the hook returns true, then the even will be ignored by rxvt-unicode. |
338 | |
542 | |
339 | The event is a hash with most values as named by Xlib (see the XEvent |
543 | The event is a hash with most values as named by Xlib (see the XEvent |
340 | manpage), with the additional members C<row> and C<col>, which are the row |
544 | manpage), with the additional members C<row> and C<col>, which are the |
341 | and column under the mouse cursor. |
545 | (real, not screen-based) row and column under the mouse cursor. |
342 | |
546 | |
343 | C<on_key_press> additionally receives the string rxvt-unicode would |
547 | C<on_key_press> additionally receives the string rxvt-unicode would |
344 | output, if any, in locale-specific encoding. |
548 | output, if any, in locale-specific encoding. |
345 | |
549 | |
346 | subwindow. |
550 | subwindow. |
|
|
551 | |
|
|
552 | =item on_client_message $term, $event |
|
|
553 | |
|
|
554 | =item on_wm_protocols $term, $event |
|
|
555 | |
|
|
556 | =item on_wm_delete_window $term, $event |
|
|
557 | |
|
|
558 | Called when various types of ClientMessage events are received (all with |
|
|
559 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
347 | |
560 | |
348 | =back |
561 | =back |
349 | |
562 | |
350 | =cut |
563 | =cut |
351 | |
564 | |
… | |
… | |
357 | use Scalar::Util (); |
570 | use Scalar::Util (); |
358 | use List::Util (); |
571 | use List::Util (); |
359 | |
572 | |
360 | our $VERSION = 1; |
573 | our $VERSION = 1; |
361 | our $TERM; |
574 | our $TERM; |
|
|
575 | our @TERM_INIT; |
|
|
576 | our @TERM_EXT; |
362 | our @HOOKNAME; |
577 | our @HOOKNAME; |
363 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
578 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
364 | our %OPTION; |
579 | our %OPTION; |
365 | |
580 | |
366 | our $LIBDIR; |
581 | our $LIBDIR; |
367 | our $RESNAME; |
582 | our $RESNAME; |
368 | our $RESCLASS; |
583 | our $RESCLASS; |
369 | our $RXVTNAME; |
584 | our $RXVTNAME; |
370 | |
585 | |
|
|
586 | our $NOCHAR = chr 0xffff; |
|
|
587 | |
371 | =head2 Variables in the C<urxvt> Package |
588 | =head2 Variables in the C<urxvt> Package |
372 | |
589 | |
373 | =over 4 |
590 | =over 4 |
374 | |
591 | |
375 | =item $urxvt::LIBDIR |
592 | =item $urxvt::LIBDIR |
… | |
… | |
387 | |
604 | |
388 | =item $urxvt::TERM |
605 | =item $urxvt::TERM |
389 | |
606 | |
390 | The current terminal. This variable stores the current C<urxvt::term> |
607 | The current terminal. This variable stores the current C<urxvt::term> |
391 | object, whenever a callback/hook is executing. |
608 | object, whenever a callback/hook is executing. |
|
|
609 | |
|
|
610 | =item @urxvt::TERM_INIT |
|
|
611 | |
|
|
612 | All coderefs in this array will be called as methods of the next newly |
|
|
613 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
614 | gets cleared before the codereferences that were in it are being executed, |
|
|
615 | so coderefs can push themselves onto it again if they so desire. |
|
|
616 | |
|
|
617 | This complements to the perl-eval commandline option, but gets executed |
|
|
618 | first. |
|
|
619 | |
|
|
620 | =item @urxvt::TERM_EXT |
|
|
621 | |
|
|
622 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
623 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
624 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
392 | |
625 | |
393 | =back |
626 | =back |
394 | |
627 | |
395 | =head2 Functions in the C<urxvt> Package |
628 | =head2 Functions in the C<urxvt> Package |
396 | |
629 | |
… | |
… | |
411 | Using this function has the advantage that its output ends up in the |
644 | Using this function has the advantage that its output ends up in the |
412 | correct place, e.g. on stderr of the connecting urxvtc client. |
645 | correct place, e.g. on stderr of the connecting urxvtc client. |
413 | |
646 | |
414 | Messages have a size limit of 1023 bytes currently. |
647 | Messages have a size limit of 1023 bytes currently. |
415 | |
648 | |
416 | =item $is_safe = urxvt::safe |
|
|
417 | |
|
|
418 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
419 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
420 | started setuid or setgid. |
|
|
421 | |
|
|
422 | =item $time = urxvt::NOW |
649 | =item $time = urxvt::NOW |
423 | |
650 | |
424 | Returns the "current time" (as per the event loop). |
651 | Returns the "current time" (as per the event loop). |
425 | |
652 | |
426 | =item urxvt::CurrentTime |
653 | =item urxvt::CurrentTime |
427 | |
654 | |
428 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
655 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
429 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
656 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
430 | Button4Mask, Button5Mask, AnyModifier |
657 | Button4Mask, Button5Mask, AnyModifier |
|
|
658 | |
|
|
659 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
660 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
661 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
662 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
663 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
664 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
665 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
666 | |
|
|
667 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
668 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
669 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
670 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
671 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
672 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
673 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
431 | |
674 | |
432 | Various constants for use in X calls and event processing. |
675 | Various constants for use in X calls and event processing. |
433 | |
676 | |
434 | =back |
677 | =back |
435 | |
678 | |
… | |
… | |
486 | =back |
729 | =back |
487 | |
730 | |
488 | =cut |
731 | =cut |
489 | |
732 | |
490 | BEGIN { |
733 | BEGIN { |
491 | urxvt->bootstrap; |
|
|
492 | |
|
|
493 | # overwrite perl's warn |
734 | # overwrite perl's warn |
494 | *CORE::GLOBAL::warn = sub { |
735 | *CORE::GLOBAL::warn = sub { |
495 | my $msg = join "", @_; |
736 | my $msg = join "", @_; |
496 | $msg .= "\n" |
737 | $msg .= "\n" |
497 | unless $msg =~ /\n$/; |
738 | unless $msg =~ /\n$/; |
498 | urxvt::warn ($msg); |
739 | urxvt::warn ($msg); |
499 | }; |
740 | }; |
500 | |
|
|
501 | delete $ENV{IFS}; |
|
|
502 | delete $ENV{CDPATH}; |
|
|
503 | delete $ENV{BASH_ENV}; |
|
|
504 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
505 | } |
741 | } |
506 | |
742 | |
507 | my @hook_count; |
743 | no warnings 'utf8'; |
|
|
744 | |
508 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
745 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
509 | |
746 | |
510 | sub verbose { |
747 | sub verbose { |
511 | my ($level, $msg) = @_; |
748 | my ($level, $msg) = @_; |
512 | warn "$msg\n" if $level <= $verbosity; |
749 | warn "$msg\n" if $level <= $verbosity; |
513 | } |
750 | } |
514 | |
751 | |
515 | my $extension_pkg = "extension0000"; |
|
|
516 | my %extension_pkg; |
752 | my %extension_pkg; |
517 | |
753 | |
518 | # load a single script into its own package, once only |
754 | # load a single script into its own package, once only |
519 | sub extension_package($) { |
755 | sub extension_package($) { |
520 | my ($path) = @_; |
756 | my ($path) = @_; |
521 | |
757 | |
522 | $extension_pkg{$path} ||= do { |
758 | $extension_pkg{$path} ||= do { |
523 | my $pkg = "urxvt::" . ($extension_pkg++); |
759 | $path =~ /([^\/\\]+)$/; |
|
|
760 | my $pkg = $1; |
|
|
761 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
762 | $pkg = "urxvt::ext::$pkg"; |
524 | |
763 | |
525 | verbose 3, "loading extension '$path' into package '$pkg'"; |
764 | verbose 3, "loading extension '$path' into package '$pkg'"; |
526 | |
765 | |
527 | open my $fh, "<:raw", $path |
766 | open my $fh, "<:raw", $path |
528 | or die "$path: $!"; |
767 | or die "$path: $!"; |
529 | |
768 | |
530 | my $source = untaint |
769 | my $source = |
531 | "package $pkg; use strict; use utf8;\n" |
770 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
532 | . "use base urxvt::term::extension::;\n" |
|
|
533 | . "#line 1 \"$path\"\n{\n" |
771 | . "#line 1 \"$path\"\n{\n" |
534 | . (do { local $/; <$fh> }) |
772 | . (do { local $/; <$fh> }) |
535 | . "\n};\n1"; |
773 | . "\n};\n1"; |
536 | |
774 | |
537 | eval $source |
775 | eval $source |
… | |
… | |
551 | if ($htype == 0) { # INIT |
789 | if ($htype == 0) { # INIT |
552 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
790 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
553 | |
791 | |
554 | my %ext_arg; |
792 | my %ext_arg; |
555 | |
793 | |
|
|
794 | { |
|
|
795 | my @init = @TERM_INIT; |
|
|
796 | @TERM_INIT = (); |
|
|
797 | $_->($TERM) for @init; |
|
|
798 | my @pkg = @TERM_EXT; |
|
|
799 | @TERM_EXT = (); |
|
|
800 | $TERM->register_package ($_) for @pkg; |
|
|
801 | } |
|
|
802 | |
556 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
803 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
557 | if ($_ eq "default") { |
804 | if ($_ eq "default") { |
558 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
805 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
559 | } elsif (/^-(.*)$/) { |
806 | } elsif (/^-(.*)$/) { |
560 | delete $ext_arg{$1}; |
807 | delete $ext_arg{$1}; |
561 | } elsif (/^([^<]+)<(.*)>$/) { |
808 | } elsif (/^([^<]+)<(.*)>$/) { |
562 | push @{ $ext_arg{$1} }, $2; |
809 | push @{ $ext_arg{$1} }, $2; |
563 | } else { |
810 | } else { |
… | |
… | |
586 | if $verbosity >= 10; |
833 | if $verbosity >= 10; |
587 | |
834 | |
588 | keys %$cb; |
835 | keys %$cb; |
589 | |
836 | |
590 | while (my ($pkg, $cb) = each %$cb) { |
837 | while (my ($pkg, $cb) = each %$cb) { |
591 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
838 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
592 | and last; |
839 | $retval ||= $retval_; |
593 | |
840 | |
594 | if ($@) { |
841 | if ($@) { |
595 | $TERM->ungrab; # better to lose the grab than the session |
842 | $TERM->ungrab; # better to lose the grab than the session |
596 | warn $@; |
843 | warn $@; |
597 | } |
844 | } |
598 | } |
845 | } |
|
|
846 | |
|
|
847 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
848 | if $verbosity >= 11; |
599 | } |
849 | } |
600 | |
850 | |
601 | if ($htype == 1) { # DESTROY |
851 | if ($htype == 1) { # DESTROY |
602 | if (my $hook = delete $TERM->{_hook}) { |
|
|
603 | for my $htype (0..$#$hook) { |
|
|
604 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
605 | or set_should_invoke $htype, 0; |
|
|
606 | } |
|
|
607 | } |
|
|
608 | |
|
|
609 | # clear package objects |
852 | # clear package objects |
610 | %$_ = () for values %{ $TERM->{_pkg} }; |
853 | %$_ = () for values %{ $TERM->{_pkg} }; |
611 | |
854 | |
612 | # clear package |
855 | # clear package |
613 | %$TERM = (); |
856 | %$TERM = (); |
… | |
… | |
627 | while (my ($name, $cb) = each %hook) { |
870 | while (my ($name, $cb) = each %hook) { |
628 | my $htype = $HOOKTYPE{uc $name}; |
871 | my $htype = $HOOKTYPE{uc $name}; |
629 | defined $htype |
872 | defined $htype |
630 | or Carp::croak "unsupported hook type '$name'"; |
873 | or Carp::croak "unsupported hook type '$name'"; |
631 | |
874 | |
|
|
875 | $self->set_should_invoke ($htype, +1) |
632 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
876 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
633 | $hook_count[$htype]++ |
|
|
634 | or urxvt::set_should_invoke $htype, 1; |
|
|
635 | } |
|
|
636 | |
877 | |
637 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
878 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
638 | } |
879 | } |
639 | } |
880 | } |
640 | |
881 | |
… | |
… | |
645 | for my $name (@hook) { |
886 | for my $name (@hook) { |
646 | my $htype = $HOOKTYPE{uc $name}; |
887 | my $htype = $HOOKTYPE{uc $name}; |
647 | defined $htype |
888 | defined $htype |
648 | or Carp::croak "unsupported hook type '$name'"; |
889 | or Carp::croak "unsupported hook type '$name'"; |
649 | |
890 | |
|
|
891 | $self->set_should_invoke ($htype, -1) |
650 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
892 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
651 | --$hook_count[$htype] |
|
|
652 | or urxvt::set_should_invoke $htype, 0; |
|
|
653 | } |
|
|
654 | } |
893 | } |
655 | } |
894 | } |
656 | |
895 | |
657 | our $AUTOLOAD; |
896 | our $AUTOLOAD; |
658 | |
897 | |
… | |
… | |
764 | # find on_xxx subs in the package and register them |
1003 | # find on_xxx subs in the package and register them |
765 | # as hooks |
1004 | # as hooks |
766 | sub register_package { |
1005 | sub register_package { |
767 | my ($self, $pkg, $argv) = @_; |
1006 | my ($self, $pkg, $argv) = @_; |
768 | |
1007 | |
|
|
1008 | no strict 'refs'; |
|
|
1009 | |
|
|
1010 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
1011 | |
|
|
1012 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
1013 | |
769 | my $proxy = bless { |
1014 | my $proxy = bless { |
770 | _pkg => $pkg, |
1015 | _pkg => $pkg, |
771 | argv => $argv, |
1016 | argv => $argv, |
772 | }, $pkg; |
1017 | }, $pkg; |
773 | Scalar::Util::weaken ($proxy->{term} = $self); |
1018 | Scalar::Util::weaken ($proxy->{term} = $self); |
… | |
… | |
804 | |
1049 | |
805 | Destroy the terminal object (close the window, free resources |
1050 | Destroy the terminal object (close the window, free resources |
806 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1051 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
807 | watchers (timers, io watchers) are still active. |
1052 | watchers (timers, io watchers) are still active. |
808 | |
1053 | |
|
|
1054 | =item $term->exec_async ($cmd[, @args]) |
|
|
1055 | |
|
|
1056 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
1057 | ("starts") programs in the background. This function takes care of setting |
|
|
1058 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
1059 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
1060 | |
|
|
1061 | Returns the pid of the subprocess or C<undef> on error. |
|
|
1062 | |
|
|
1063 | =cut |
|
|
1064 | |
|
|
1065 | sub exec_async { |
|
|
1066 | my $self = shift; |
|
|
1067 | |
|
|
1068 | my $pid = fork; |
|
|
1069 | |
|
|
1070 | return $pid |
|
|
1071 | if !defined $pid or $pid; |
|
|
1072 | |
|
|
1073 | %ENV = %{ $self->env }; |
|
|
1074 | |
|
|
1075 | exec @_; |
|
|
1076 | urxvt::_exit 255; |
|
|
1077 | } |
|
|
1078 | |
809 | =item $isset = $term->option ($optval[, $set]) |
1079 | =item $isset = $term->option ($optval[, $set]) |
810 | |
1080 | |
811 | Returns true if the option specified by C<$optval> is enabled, and |
1081 | Returns true if the option specified by C<$optval> is enabled, and |
812 | optionally change it. All option values are stored by name in the hash |
1082 | optionally change it. All option values are stored by name in the hash |
813 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1083 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
… | |
… | |
815 | Here is a a likely non-exhaustive list of option names, please see the |
1085 | Here is a a likely non-exhaustive list of option names, please see the |
816 | source file F</src/optinc.h> to see the actual list: |
1086 | source file F</src/optinc.h> to see the actual list: |
817 | |
1087 | |
818 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1088 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
819 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1089 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
820 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1090 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
821 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1091 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
822 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1092 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
823 | tripleclickwords utmpInhibit visualBell |
1093 | transparent tripleclickwords utmpInhibit visualBell |
824 | |
1094 | |
825 | =item $value = $term->resource ($name[, $newval]) |
1095 | =item $value = $term->resource ($name[, $newval]) |
826 | |
1096 | |
827 | Returns the current resource value associated with a given name and |
1097 | Returns the current resource value associated with a given name and |
828 | optionally sets a new value. Setting values is most useful in the C<init> |
1098 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
845 | |
1115 | |
846 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1116 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
847 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1117 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
848 | display_name embed ext_bwidth fade font geometry hold iconName |
1118 | display_name embed ext_bwidth fade font geometry hold iconName |
849 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1119 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
850 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1120 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
851 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1121 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
852 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1122 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
853 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1123 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
854 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1124 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
855 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1125 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
856 | shade term_name title transparent transparent_all tripleclickwords |
1126 | secondaryScreen secondaryScroll selectstyle shade term_name title |
857 | utmpInhibit visualBell |
1127 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
|
|
1128 | visualBell |
858 | |
1129 | |
859 | =cut |
1130 | =cut |
860 | |
1131 | |
861 | sub resource($$;$) { |
1132 | sub resource($$;$) { |
862 | my ($self, $name) = (shift, shift); |
1133 | my ($self, $name) = (shift, shift); |
… | |
… | |
897 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1168 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
898 | |
1169 | |
899 | Return the current values of the selection mark, begin or end positions, |
1170 | Return the current values of the selection mark, begin or end positions, |
900 | and optionally set them to new values. |
1171 | and optionally set them to new values. |
901 | |
1172 | |
|
|
1173 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
1174 | |
|
|
1175 | Tries to make a selection as set by C<selection_beg> and |
|
|
1176 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
1177 | rectangular selection will be made. This is the prefered function to make |
|
|
1178 | a selection. |
|
|
1179 | |
902 | =item $success = $term->selection_grab ($eventtime) |
1180 | =item $success = $term->selection_grab ($eventtime) |
903 | |
1181 | |
904 | Try to request the primary selection from the server (for example, as set |
1182 | Try to request the primary selection text from the server (for example, as |
905 | by the next method). |
1183 | set by the next method). No visual feedback will be given. This function |
|
|
1184 | is mostly useful from within C<on_sel_grab> hooks. |
906 | |
1185 | |
907 | =item $oldtext = $term->selection ([$newtext]) |
1186 | =item $oldtext = $term->selection ([$newtext]) |
908 | |
1187 | |
909 | Return the current selection text and optionally replace it by C<$newtext>. |
1188 | Return the current selection text and optionally replace it by C<$newtext>. |
910 | |
1189 | |
… | |
… | |
1003 | Convert the given locale-encoded octets into a perl string. |
1282 | Convert the given locale-encoded octets into a perl string. |
1004 | |
1283 | |
1005 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1284 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1006 | |
1285 | |
1007 | XORs the rendition values in the given span with the provided value |
1286 | XORs the rendition values in the given span with the provided value |
1008 | (default: C<RS_RVid>). Useful in refresh hooks to provide effects similar |
1287 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
1009 | to the selection. |
1288 | refresh hooks to provide effects similar to the selection. |
1010 | |
1289 | |
1011 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1290 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1012 | |
1291 | |
1013 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1292 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1014 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1293 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1015 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1294 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1016 | it instead. |
1295 | it instead. Both styles I<MUST NOT> contain font styles. |
1017 | |
1296 | |
1018 | =item $term->scr_bell |
1297 | =item $term->scr_bell |
1019 | |
1298 | |
1020 | Ring the bell! |
1299 | Ring the bell! |
1021 | |
1300 | |
… | |
… | |
1028 | |
1307 | |
1029 | Normally its not a good idea to use this function, as programs might be |
1308 | Normally its not a good idea to use this function, as programs might be |
1030 | confused by changes in cursor position or scrolling. Its useful inside a |
1309 | confused by changes in cursor position or scrolling. Its useful inside a |
1031 | C<on_add_lines> hook, though. |
1310 | C<on_add_lines> hook, though. |
1032 | |
1311 | |
|
|
1312 | =item $term->scr_change_screen ($screen) |
|
|
1313 | |
|
|
1314 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1315 | |
1033 | =item $term->cmd_parse ($octets) |
1316 | =item $term->cmd_parse ($octets) |
1034 | |
1317 | |
1035 | Similar to C<scr_add_lines>, but the argument must be in the |
1318 | Similar to C<scr_add_lines>, but the argument must be in the |
1036 | locale-specific encoding of the terminal and can contain command sequences |
1319 | locale-specific encoding of the terminal and can contain command sequences |
1037 | (escape codes) that will be interpreted. |
1320 | (escape codes) that will be interpreted. |
… | |
… | |
1047 | Replaces the event mask of the pty watcher by the given event mask. Can |
1330 | Replaces the event mask of the pty watcher by the given event mask. Can |
1048 | be used to suppress input and output handling to the pty/tty. See the |
1331 | be used to suppress input and output handling to the pty/tty. See the |
1049 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1332 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1050 | the previous value. |
1333 | the previous value. |
1051 | |
1334 | |
|
|
1335 | =item $fd = $term->pty_fd |
|
|
1336 | |
|
|
1337 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1338 | is used. |
|
|
1339 | |
1052 | =item $windowid = $term->parent |
1340 | =item $windowid = $term->parent |
1053 | |
1341 | |
1054 | Return the window id of the toplevel window. |
1342 | Return the window id of the toplevel window. |
1055 | |
1343 | |
1056 | =item $windowid = $term->vt |
1344 | =item $windowid = $term->vt |
1057 | |
1345 | |
1058 | Return the window id of the terminal window. |
1346 | Return the window id of the terminal window. |
1059 | |
1347 | |
|
|
1348 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1349 | |
|
|
1350 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1351 | to receive pointer events all the times: |
|
|
1352 | |
|
|
1353 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1354 | |
1060 | =item $window_width = $term->width |
1355 | =item $window_width = $term->width |
1061 | |
1356 | |
1062 | =item $window_height = $term->height |
1357 | =item $window_height = $term->height |
1063 | |
1358 | |
1064 | =item $font_width = $term->fwidth |
1359 | =item $font_width = $term->fwidth |
… | |
… | |
1077 | |
1372 | |
1078 | =item $max_scrollback = $term->saveLines |
1373 | =item $max_scrollback = $term->saveLines |
1079 | |
1374 | |
1080 | =item $nrow_plus_saveLines = $term->total_rows |
1375 | =item $nrow_plus_saveLines = $term->total_rows |
1081 | |
1376 | |
1082 | =item $lines_in_scrollback = $term->nsaved |
1377 | =item $topmost_scrollback_row = $term->top_row |
1083 | |
1378 | |
1084 | Return various integers describing terminal characteristics. |
1379 | Return various integers describing terminal characteristics. |
1085 | |
1380 | |
1086 | =item $x_display = $term->display_id |
1381 | =item $x_display = $term->display_id |
1087 | |
1382 | |
… | |
… | |
1113 | =item $modifiermask = $term->ModNumLockMask |
1408 | =item $modifiermask = $term->ModNumLockMask |
1114 | |
1409 | |
1115 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1410 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1116 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1411 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1117 | |
1412 | |
|
|
1413 | =item $screen = $term->current_screen |
|
|
1414 | |
|
|
1415 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1416 | |
|
|
1417 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1418 | |
|
|
1419 | Returns wether the cursor is currently hidden or not. |
|
|
1420 | |
1118 | =item $view_start = $term->view_start ([$newvalue]) |
1421 | =item $view_start = $term->view_start ([$newvalue]) |
1119 | |
1422 | |
1120 | Returns the negative row number of the topmost line. Minimum value is |
1423 | Returns the row number of the topmost displayed line. Maximum value is |
1121 | C<0>, which displays the normal terminal contents. Larger values scroll |
1424 | C<0>, which displays the normal terminal contents. Lower values scroll |
1122 | this many lines into the scrollback buffer. |
1425 | this many lines into the scrollback buffer. |
1123 | |
1426 | |
1124 | =item $term->want_refresh |
1427 | =item $term->want_refresh |
1125 | |
1428 | |
1126 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1429 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1141 | line, starting at column C<$start_col> (default C<0>), which is useful |
1444 | line, starting at column C<$start_col> (default C<0>), which is useful |
1142 | to replace only parts of a line. The font index in the rendition will |
1445 | to replace only parts of a line. The font index in the rendition will |
1143 | automatically be updated. |
1446 | automatically be updated. |
1144 | |
1447 | |
1145 | C<$text> is in a special encoding: tabs and wide characters that use more |
1448 | C<$text> is in a special encoding: tabs and wide characters that use more |
1146 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1449 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1147 | (C<chr 65535>). Characters with combining characters and other characters |
1450 | characters. Characters with combining characters and other characters that |
1148 | that do not fit into the normal tetx encoding will be replaced with |
1451 | do not fit into the normal tetx encoding will be replaced with characters |
1149 | characters in the private use area. |
1452 | in the private use area. |
1150 | |
1453 | |
1151 | You have to obey this encoding when changing text. The advantage is |
1454 | You have to obey this encoding when changing text. The advantage is |
1152 | that C<substr> and similar functions work on screen cells and not on |
1455 | that C<substr> and similar functions work on screen cells and not on |
1153 | characters. |
1456 | characters. |
1154 | |
1457 | |
… | |
… | |
1205 | Return the row number of the first/last row of the line, respectively. |
1508 | Return the row number of the first/last row of the line, respectively. |
1206 | |
1509 | |
1207 | =item $offset = $line->offset_of ($row, $col) |
1510 | =item $offset = $line->offset_of ($row, $col) |
1208 | |
1511 | |
1209 | Returns the character offset of the given row|col pair within the logical |
1512 | Returns the character offset of the given row|col pair within the logical |
1210 | line. |
1513 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1514 | offsets outside the string. |
1211 | |
1515 | |
1212 | =item ($row, $col) = $line->coord_of ($offset) |
1516 | =item ($row, $col) = $line->coord_of ($offset) |
1213 | |
1517 | |
1214 | Translates a string offset into terminal coordinates again. |
1518 | Translates a string offset into terminal coordinates again. |
1215 | |
1519 | |
… | |
… | |
1328 | |
1632 | |
1329 | Calls XUngrab for the most recent grab. Is called automatically on |
1633 | Calls XUngrab for the most recent grab. Is called automatically on |
1330 | evaluation errors, as it is better to lose the grab in the error case as |
1634 | evaluation errors, as it is better to lose the grab in the error case as |
1331 | the session. |
1635 | the session. |
1332 | |
1636 | |
|
|
1637 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1638 | |
|
|
1639 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1640 | |
|
|
1641 | =item @atoms = $term->XListProperties ($window) |
|
|
1642 | |
|
|
1643 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1644 | |
|
|
1645 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1646 | |
|
|
1647 | =item $term->XDeleteProperty ($window, $property) |
|
|
1648 | |
|
|
1649 | =item $window = $term->DefaultRootWindow |
|
|
1650 | |
|
|
1651 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1652 | |
|
|
1653 | =item $term->XMapWindow ($window) |
|
|
1654 | |
|
|
1655 | =item $term->XUnmapWindow ($window) |
|
|
1656 | |
|
|
1657 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1658 | |
|
|
1659 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1660 | |
|
|
1661 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1662 | |
|
|
1663 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1664 | the source of the display, otherwise those functions map more-or-less |
|
|
1665 | directory onto the X functions of the same name. |
|
|
1666 | |
1333 | =back |
1667 | =back |
1334 | |
1668 | |
1335 | =cut |
1669 | =cut |
1336 | |
1670 | |
1337 | package urxvt::popup; |
1671 | package urxvt::popup; |
… | |
… | |
1438 | my $env = $self->{term}->env; |
1772 | my $env = $self->{term}->env; |
1439 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1773 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1440 | delete $env->{LC_ALL}; |
1774 | delete $env->{LC_ALL}; |
1441 | $env->{LC_CTYPE} = $self->{term}->locale; |
1775 | $env->{LC_CTYPE} = $self->{term}->locale; |
1442 | |
1776 | |
1443 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1777 | urxvt::term->new ($env, "popup", |
1444 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1778 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
1779 | "-pty-fd" => -1, "-sl" => 0, |
|
|
1780 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1445 | "--transient-for" => $self->{term}->parent, |
1781 | "--transient-for" => $self->{term}->parent, |
1446 | "-display" => $self->{term}->display_id, |
1782 | "-display" => $self->{term}->display_id, |
1447 | "-pe" => "urxvt-popup") |
1783 | "-pe" => "urxvt-popup") |
1448 | or die "unable to create popup window\n"; |
1784 | or die "unable to create popup window\n"; |
1449 | } |
1785 | } |
… | |
… | |
1454 | delete $self->{term}{_destroy}{$self}; |
1790 | delete $self->{term}{_destroy}{$self}; |
1455 | $self->{term}->ungrab; |
1791 | $self->{term}->ungrab; |
1456 | } |
1792 | } |
1457 | |
1793 | |
1458 | =back |
1794 | =back |
|
|
1795 | |
|
|
1796 | =cut |
|
|
1797 | |
|
|
1798 | package urxvt::watcher; |
|
|
1799 | |
|
|
1800 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1801 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1802 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1803 | @urxvt::iw::ISA = __PACKAGE__; |
1459 | |
1804 | |
1460 | =head2 The C<urxvt::timer> Class |
1805 | =head2 The C<urxvt::timer> Class |
1461 | |
1806 | |
1462 | This class implements timer watchers/events. Time is represented as a |
1807 | This class implements timer watchers/events. Time is represented as a |
1463 | fractional number of seconds since the epoch. Example: |
1808 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1501 | Start the timer. |
1846 | Start the timer. |
1502 | |
1847 | |
1503 | =item $timer = $timer->start ($tstamp) |
1848 | =item $timer = $timer->start ($tstamp) |
1504 | |
1849 | |
1505 | Set the event trigger time to C<$tstamp> and start the timer. |
1850 | Set the event trigger time to C<$tstamp> and start the timer. |
|
|
1851 | |
|
|
1852 | =item $timer = $timer->after ($delay) |
|
|
1853 | |
|
|
1854 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1506 | |
1855 | |
1507 | =item $timer = $timer->stop |
1856 | =item $timer = $timer->stop |
1508 | |
1857 | |
1509 | Stop the timer. |
1858 | Stop the timer. |
1510 | |
1859 | |
… | |
… | |
1557 | |
1906 | |
1558 | Stop watching for events on the given filehandle. |
1907 | Stop watching for events on the given filehandle. |
1559 | |
1908 | |
1560 | =back |
1909 | =back |
1561 | |
1910 | |
|
|
1911 | =head2 The C<urxvt::iw> Class |
|
|
1912 | |
|
|
1913 | This class implements idle watchers, that get called automatically when |
|
|
1914 | the process is idle. They should return as fast as possible, after doing |
|
|
1915 | some useful work. |
|
|
1916 | |
|
|
1917 | =over 4 |
|
|
1918 | |
|
|
1919 | =item $iw = new urxvt::iw |
|
|
1920 | |
|
|
1921 | Create a new idle watcher object in stopped state. |
|
|
1922 | |
|
|
1923 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1924 | |
|
|
1925 | Set the callback to be called when the watcher triggers. |
|
|
1926 | |
|
|
1927 | =item $timer = $timer->start |
|
|
1928 | |
|
|
1929 | Start the watcher. |
|
|
1930 | |
|
|
1931 | =item $timer = $timer->stop |
|
|
1932 | |
|
|
1933 | Stop the watcher. |
|
|
1934 | |
|
|
1935 | =back |
|
|
1936 | |
|
|
1937 | =head2 The C<urxvt::pw> Class |
|
|
1938 | |
|
|
1939 | This class implements process watchers. They create an event whenever a |
|
|
1940 | process exits, after which they stop automatically. |
|
|
1941 | |
|
|
1942 | my $pid = fork; |
|
|
1943 | ... |
|
|
1944 | $term->{pw} = urxvt::pw |
|
|
1945 | ->new |
|
|
1946 | ->start ($pid) |
|
|
1947 | ->cb (sub { |
|
|
1948 | my ($pw, $exit_status) = @_; |
|
|
1949 | ... |
|
|
1950 | }); |
|
|
1951 | |
|
|
1952 | =over 4 |
|
|
1953 | |
|
|
1954 | =item $pw = new urxvt::pw |
|
|
1955 | |
|
|
1956 | Create a new process watcher in stopped state. |
|
|
1957 | |
|
|
1958 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1959 | |
|
|
1960 | Set the callback to be called when the timer triggers. |
|
|
1961 | |
|
|
1962 | =item $pw = $timer->start ($pid) |
|
|
1963 | |
|
|
1964 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
1965 | |
|
|
1966 | =item $pw = $pw->stop |
|
|
1967 | |
|
|
1968 | Stop the watcher. |
|
|
1969 | |
|
|
1970 | =back |
|
|
1971 | |
1562 | =head1 ENVIRONMENT |
1972 | =head1 ENVIRONMENT |
1563 | |
1973 | |
1564 | =head2 URXVT_PERL_VERBOSITY |
1974 | =head2 URXVT_PERL_VERBOSITY |
1565 | |
1975 | |
1566 | This variable controls the verbosity level of the perl extension. Higher |
1976 | This variable controls the verbosity level of the perl extension. Higher |
… | |
… | |
1570 | |
1980 | |
1571 | =item == 0 - fatal messages |
1981 | =item == 0 - fatal messages |
1572 | |
1982 | |
1573 | =item >= 3 - script loading and management |
1983 | =item >= 3 - script loading and management |
1574 | |
1984 | |
1575 | =item >=10 - all events received |
1985 | =item >=10 - all called hooks |
|
|
1986 | |
|
|
1987 | =item >=11 - hook reutrn values |
1576 | |
1988 | |
1577 | =back |
1989 | =back |
1578 | |
1990 | |
1579 | =head1 AUTHOR |
1991 | =head1 AUTHOR |
1580 | |
1992 | |