… | |
… | |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
30 | |
30 | |
|
|
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
|
|
32 | and "perl-ext-common" resources to the empty string. |
|
|
33 | |
31 | =head1 PREPACKAGED EXTENSIONS |
34 | =head1 PREPACKAGED EXTENSIONS |
32 | |
35 | |
33 | This section describes the extensions delivered with this release. You can |
36 | This section describes the extensions delivered with this release. You can |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
37 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
35 | |
38 | |
… | |
… | |
37 | |
40 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
41 | @@RXVT_NAME@@ -pe <extensionname> |
39 | |
42 | |
40 | Or by adding them to the resource for extensions loaded by default: |
43 | Or by adding them to the resource for extensions loaded by default: |
41 | |
44 | |
42 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
45 | URxvt.perl-ext-common: default,selection-autotransform |
43 | |
46 | |
44 | =over 4 |
47 | =over 4 |
45 | |
48 | |
46 | =item selection (enabled by default) |
49 | =item selection (enabled by default) |
47 | |
50 | |
… | |
… | |
98 | |
101 | |
99 | Other extensions can extend this popup menu by pushing a code reference |
102 | Other extensions can extend this popup menu by pushing a code reference |
100 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
101 | popup is being displayed. |
104 | popup is being displayed. |
102 | |
105 | |
103 | It's sole argument is the popup menu, which can be modified. It should |
106 | Its sole argument is the popup menu, which can be modified. It should |
104 | either return nothing or a string, the initial boolean value and a code |
107 | either return nothing or a string, the initial boolean value and a code |
105 | reference. The string will be used as button text and the code reference |
108 | reference. The string will be used as button text and the code reference |
106 | will be called when the toggle changes, with the new boolean value as |
109 | will be called when the toggle changes, with the new boolean value as |
107 | first argument. |
110 | first argument. |
108 | |
111 | |
109 | The following will add an entry C<myoption> that changes |
112 | The following will add an entry C<myoption> that changes |
110 | C<$self->{myoption}>: |
113 | C<< $self->{myoption} >>: |
111 | |
114 | |
112 | push @{ $self->{term}{option_popup_hook} }, sub { |
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
113 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
114 | }; |
117 | }; |
115 | |
118 | |
… | |
… | |
121 | |
124 | |
122 | Other extensions can extend this popup menu by pushing a code reference |
125 | Other extensions can extend this popup menu by pushing a code reference |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
124 | popup is being displayed. |
127 | popup is being displayed. |
125 | |
128 | |
126 | It's sole argument is the popup menu, which can be modified. The selection |
129 | Its sole argument is the popup menu, which can be modified. The selection |
127 | is in C<$_>, which can be used to decide whether to add something or not. |
130 | is in C<$_>, which can be used to decide whether to add something or not. |
128 | It should either return nothing or a string and a code reference. The |
131 | It should either return nothing or a string and a code reference. The |
129 | string will be used as button text and the code reference will be called |
132 | string will be used as button text and the code reference will be called |
130 | when the button gets activated and should transform C<$_>. |
133 | when the button gets activated and should transform C<$_>. |
131 | |
134 | |
132 | The following will add an entry C<a to b> that transforms all C<a>s in |
135 | The following will add an entry C<a to b> that transforms all C<a>s in |
133 | the selection to C<b>s, but only if the selection currently contains any |
136 | the selection to C<b>s, but only if the selection currently contains any |
134 | C<a>s: |
137 | C<a>s: |
135 | |
138 | |
136 | push @{ $self->{term}{selection_popup_hook} }, sub { |
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
137 | /a/ ? ("a to be" => sub { s/a/b/g } |
140 | /a/ ? ("a to b" => sub { s/a/b/g } |
138 | : () |
141 | : () |
139 | }; |
142 | }; |
140 | |
143 | |
141 | =item searchable-scrollback<hotkey> (enabled by default) |
144 | =item searchable-scrollback<hotkey> (enabled by default) |
142 | |
145 | |
… | |
… | |
149 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
152 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
150 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
153 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
151 | bottom. C<Escape> leaves search mode and returns to the point where search |
154 | bottom. C<Escape> leaves search mode and returns to the point where search |
152 | was started, while C<Enter> or C<Return> stay at the current position and |
155 | was started, while C<Enter> or C<Return> stay at the current position and |
153 | additionally stores the first match in the current line into the primary |
156 | additionally stores the first match in the current line into the primary |
154 | selection. |
157 | selection if the C<Shift> modifier is active. |
155 | |
158 | |
156 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
159 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
157 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
160 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
158 | or simply use an uppercase character which removes the "(?i)" prefix. |
161 | or simply use an uppercase character which removes the "(?i)" prefix. |
159 | |
162 | |
… | |
… | |
162 | =item readline (enabled by default) |
165 | =item readline (enabled by default) |
163 | |
166 | |
164 | A support package that tries to make editing with readline easier. At |
167 | A support package that tries to make editing with readline easier. At |
165 | the moment, it reacts to clicking shift-left mouse button by trying to |
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
166 | move the text cursor to this position. It does so by generating as many |
169 | move the text cursor to this position. It does so by generating as many |
167 | cursor-left or cursor-right keypresses as required (the this only works |
170 | cursor-left or cursor-right keypresses as required (this only works |
168 | for programs that correctly support wide characters). |
171 | for programs that correctly support wide characters). |
169 | |
172 | |
170 | To avoid too many false positives, this is only done when: |
173 | To avoid too many false positives, this is only done when: |
171 | |
174 | |
172 | =over 4 |
175 | =over 4 |
… | |
… | |
256 | The default pattern to match URLs can be overridden with the |
259 | The default pattern to match URLs can be overridden with the |
257 | C<matcher.pattern.0> resource, and additional patterns can be specified |
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
258 | with numbered patterns, in a manner similar to the "selection" extension. |
261 | with numbered patterns, in a manner similar to the "selection" extension. |
259 | The launcher can also be overridden on a per-pattern basis. |
262 | The launcher can also be overridden on a per-pattern basis. |
260 | |
263 | |
|
|
264 | It is possible to activate the most recently seen match or a list of matches |
|
|
265 | from the keyboard. Simply bind a keysym to "perl:matcher:last" or |
|
|
266 | "perl:matcher:list" as seen in the example below. |
|
|
267 | |
261 | Example configuration: |
268 | Example configuration: |
262 | |
269 | |
263 | URxvt.perl-ext: default,matcher |
270 | URxvt.perl-ext: default,matcher |
264 | URxvt.urlLauncher: sensible-browser |
271 | URxvt.urlLauncher: sensible-browser |
|
|
272 | URxvt.keysym.C-Delete: perl:matcher:last |
|
|
273 | URxvt.keysym.M-Delete: perl:matcher:list |
265 | URxvt.matcher.button: 1 |
274 | URxvt.matcher.button: 1 |
266 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
275 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
267 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
276 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
268 | URxvt.matcher.launcher.2: gvim +$2 $1 |
277 | URxvt.matcher.launcher.2: gvim +$2 $1 |
269 | |
278 | |
270 | =item xim-onthespot |
279 | =item xim-onthespot |
271 | |
280 | |
272 | This (experimental) perl extension implements OnTheSpot editing. It does |
281 | This (experimental) perl extension implements OnTheSpot editing. It does |
273 | not work perfectly, and some input methods don't seem to work well with |
282 | not work perfectly, and some input methods don't seem to work well with |
274 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
283 | OnTheSpot editing in general, but it seems to work at least for SCIM and |
275 | kinput2. |
284 | kinput2. |
276 | |
285 | |
277 | You enable it by specifying this extension and a preedit style of |
286 | You enable it by specifying this extension and a preedit style of |
278 | C<OnTheSpot>, i.e.: |
287 | C<OnTheSpot>, i.e.: |
279 | |
288 | |
… | |
… | |
287 | will show or hide itself. Another press of the accelerator key will hide |
296 | will show or hide itself. Another press of the accelerator key will hide |
288 | or show it again. |
297 | or show it again. |
289 | |
298 | |
290 | Initially, the window will not be shown when using this extension. |
299 | Initially, the window will not be shown when using this extension. |
291 | |
300 | |
292 | This is useful if you need a single terminal thats not using any desktop |
301 | This is useful if you need a single terminal that is not using any desktop |
293 | space most of the time but is quickly available at the press of a key. |
302 | space most of the time but is quickly available at the press of a key. |
294 | |
303 | |
295 | The accelerator key is grabbed regardless of any modifiers, so this |
304 | The accelerator key is grabbed regardless of any modifiers, so this |
296 | extension will actually grab a physical key just for this function. |
305 | extension will actually grab a physical key just for this function. |
297 | |
306 | |
298 | If you want a quake-like animation, tell your window manager to do so |
307 | If you want a quake-like animation, tell your window manager to do so |
299 | (fvwm can do it). |
308 | (fvwm can do it). |
300 | |
309 | |
301 | =item automove-background |
310 | =item overlay-osc |
302 | |
311 | |
303 | This is basically a very small extension that dynamically changes the |
312 | This extension implements some OSC commands to display timed popups on the |
304 | background pixmap offset to the window position, in effect creating the |
313 | screen - useful for status displays from within scripts. You have to read |
305 | same effect as pseudo transparency with a custom pixmap. No scaling is |
314 | the sources for more info. |
306 | supported in this mode. Example: |
|
|
307 | |
|
|
308 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
309 | |
315 | |
310 | =item block-graphics-to-ascii |
316 | =item block-graphics-to-ascii |
311 | |
317 | |
312 | A not very useful example of filtering all text output to the terminal |
318 | A not very useful example of filtering all text output to the terminal |
313 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
319 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
… | |
… | |
318 | Displays a digital clock using the built-in overlay. |
324 | Displays a digital clock using the built-in overlay. |
319 | |
325 | |
320 | =item remote-clipboard |
326 | =item remote-clipboard |
321 | |
327 | |
322 | Somewhat of a misnomer, this extension adds two menu entries to the |
328 | Somewhat of a misnomer, this extension adds two menu entries to the |
323 | selection popup that allows one ti run external commands to store the |
329 | selection popup that allows one to run external commands to store the |
324 | selection somewhere and fetch it again. |
330 | selection somewhere and fetch it again. |
325 | |
331 | |
326 | We use it to implement a "distributed selection mechanism", which just |
332 | We use it to implement a "distributed selection mechanism", which just |
327 | means that one command uploads the file to a remote server, and another |
333 | means that one command uploads the file to a remote server, and another |
328 | reads it. |
334 | reads it. |
… | |
… | |
337 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
343 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
338 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
344 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
339 | |
345 | |
340 | =item selection-pastebin |
346 | =item selection-pastebin |
341 | |
347 | |
342 | This is a little rarely useful extension that Uploads the selection as |
348 | This is a little rarely useful extension that uploads the selection as |
343 | textfile to a remote site (or does other things). (The implementation is |
349 | textfile to a remote site (or does other things). (The implementation is |
344 | not currently secure for use in a multiuser environment as it writes to |
350 | not currently secure for use in a multiuser environment as it writes to |
345 | F</tmp> directly.). |
351 | F</tmp> directly.). |
346 | |
352 | |
347 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
353 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
… | |
… | |
366 | |
372 | |
367 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
373 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
368 | |
374 | |
369 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
375 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
370 | the double C</> characters as comment start. Use C<\057\057> instead, |
376 | the double C</> characters as comment start. Use C<\057\057> instead, |
371 | which works regardless of wether xrdb is used to parse the resource file |
377 | which works regardless of whether xrdb is used to parse the resource file |
372 | or not. |
378 | or not. |
|
|
379 | |
|
|
380 | =item macosx-clipboard and macosx-clipboard-native |
|
|
381 | |
|
|
382 | These two modules implement an extended clipboard for Mac OS X. They are |
|
|
383 | used like this: |
|
|
384 | |
|
|
385 | URxvt.perl-ext-common: default,macosx-clipboard |
|
|
386 | URxvt.keysym.M-c: perl:macosx-clipboard:copy |
|
|
387 | URxvt.keysym.M-v: perl:macosx-clipboard:paste |
|
|
388 | |
|
|
389 | The difference between them is that the native variant requires a |
|
|
390 | perl from apple's devkit or so, and C<macosx-clipboard> requires the |
|
|
391 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
|
|
392 | simpler etc. etc. |
373 | |
393 | |
374 | =item example-refresh-hooks |
394 | =item example-refresh-hooks |
375 | |
395 | |
376 | Displays a very simple digital clock in the upper right corner of the |
396 | Displays a very simple digital clock in the upper right corner of the |
377 | window. Illustrates overwriting the refresh callbacks to create your own |
397 | window. Illustrates overwriting the refresh callbacks to create your own |
378 | overlays or changes. |
398 | overlays or changes. |
|
|
399 | |
|
|
400 | =item confirm-paste |
|
|
401 | |
|
|
402 | Displays a confirmation dialog when a paste containing at least a full |
|
|
403 | line is detected. |
|
|
404 | |
|
|
405 | =item bell-command |
|
|
406 | |
|
|
407 | Runs the command specified by the C<URxvt.bell-command> resource when |
|
|
408 | a bell event occurs. For example, the following pops up a notification |
|
|
409 | bubble with the text "Beep, Beep" using notify-send: |
|
|
410 | |
|
|
411 | URxvt.bell-command: notify-send "Beep, Beep" |
379 | |
412 | |
380 | =back |
413 | =back |
381 | |
414 | |
382 | =head1 API DOCUMENTATION |
415 | =head1 API DOCUMENTATION |
383 | |
416 | |
… | |
… | |
399 | |
432 | |
400 | =over 4 |
433 | =over 4 |
401 | |
434 | |
402 | =item $text |
435 | =item $text |
403 | |
436 | |
404 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
437 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
405 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
438 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
406 | |
439 | |
407 | =item $string |
440 | =item $string |
408 | |
441 | |
409 | A perl text string, with an emphasis on I<text>. It can store all unicode |
442 | A perl text string, with an emphasis on I<text>. It can store all unicode |
… | |
… | |
418 | =back |
451 | =back |
419 | |
452 | |
420 | =head2 Extension Objects |
453 | =head2 Extension Objects |
421 | |
454 | |
422 | Every perl extension is a perl class. A separate perl object is created |
455 | Every perl extension is a perl class. A separate perl object is created |
423 | for each terminal, and each terminal has its own set of extenion objects, |
456 | for each terminal, and each terminal has its own set of extension objects, |
424 | which are passed as the first parameter to hooks. So extensions can use |
457 | which are passed as the first parameter to hooks. So extensions can use |
425 | their C<$self> object without having to think about clashes with other |
458 | their C<$self> object without having to think about clashes with other |
426 | extensions or other terminals, with the exception of methods and members |
459 | extensions or other terminals, with the exception of methods and members |
427 | that begin with an underscore character C<_>: these are reserved for |
460 | that begin with an underscore character C<_>: these are reserved for |
428 | internal use. |
461 | internal use. |
… | |
… | |
543 | |
576 | |
544 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
577 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
545 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
578 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
546 | number of lines that will be in the scrollback buffer. |
579 | number of lines that will be in the scrollback buffer. |
547 | |
580 | |
548 | =item on_osc_seq $term, $op, $args |
581 | =item on_osc_seq $term, $op, $args, $resp |
549 | |
582 | |
550 | Called on every OSC sequence and can be used to suppress it or modify its |
583 | Called on every OSC sequence and can be used to suppress it or modify its |
551 | behaviour. The default should be to return an empty list. A true value |
584 | behaviour. The default should be to return an empty list. A true value |
552 | suppresses execution of the request completely. Make sure you don't get |
585 | suppresses execution of the request completely. Make sure you don't get |
553 | confused by recursive invocations when you output an osc sequence within |
586 | confused by recursive invocations when you output an OSC sequence within |
554 | this callback. |
587 | this callback. |
555 | |
588 | |
556 | C<on_osc_seq_perl> should be used for new behaviour. |
589 | C<on_osc_seq_perl> should be used for new behaviour. |
557 | |
590 | |
558 | =item on_osc_seq_perl $term, $string |
591 | =item on_osc_seq_perl $term, $args, $resp |
559 | |
592 | |
560 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
593 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
561 | operating system command) is processed. Cursor position and other state |
594 | operating system command) is processed. Cursor position and other state |
562 | information is up-to-date when this happens. For interoperability, the |
595 | information is up-to-date when this happens. For interoperability, the |
563 | string should start with the extension name and a colon, to distinguish |
596 | string should start with the extension name (sans -osc) and a semicolon, |
564 | it from commands for other extensions, and this might be enforced in the |
597 | to distinguish it from commands for other extensions, and this might be |
565 | future. |
598 | enforced in the future. |
|
|
599 | |
|
|
600 | For example, C<overlay-osc> uses this: |
|
|
601 | |
|
|
602 | sub on_osc_seq_perl { |
|
|
603 | my ($self, $osc, $resp) = @_; |
|
|
604 | |
|
|
605 | return unless $osc =~ s/^overlay;//; |
|
|
606 | |
|
|
607 | ... process remaining $osc string |
|
|
608 | } |
566 | |
609 | |
567 | Be careful not ever to trust (in a security sense) the data you receive, |
610 | Be careful not ever to trust (in a security sense) the data you receive, |
568 | as its source can not easily be controlled (e-mail content, messages from |
611 | as its source can not easily be controlled (e-mail content, messages from |
569 | other users on the same system etc.). |
612 | other users on the same system etc.). |
|
|
613 | |
|
|
614 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
615 | sender. |
570 | |
616 | |
571 | =item on_add_lines $term, $string |
617 | =item on_add_lines $term, $string |
572 | |
618 | |
573 | Called whenever text is about to be output, with the text as argument. You |
619 | Called whenever text is about to be output, with the text as argument. You |
574 | can filter/change and output the text yourself by returning a true value |
620 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
579 | =item on_tt_write $term, $octets |
625 | =item on_tt_write $term, $octets |
580 | |
626 | |
581 | Called whenever some data is written to the tty/pty and can be used to |
627 | Called whenever some data is written to the tty/pty and can be used to |
582 | suppress or filter tty input. |
628 | suppress or filter tty input. |
583 | |
629 | |
|
|
630 | =item on_tt_paste $term, $octets |
|
|
631 | |
|
|
632 | Called whenever text is about to be pasted, with the text as argument. You |
|
|
633 | can filter/change and paste the text yourself by returning a true value |
|
|
634 | and calling C<< $term->tt_paste >> yourself. C<$octets> is |
|
|
635 | locale-encoded. |
|
|
636 | |
584 | =item on_line_update $term, $row |
637 | =item on_line_update $term, $row |
585 | |
638 | |
586 | Called whenever a line was updated or changed. Can be used to filter |
639 | Called whenever a line was updated or changed. Can be used to filter |
587 | screen output (e.g. underline urls or other useless stuff). Only lines |
640 | screen output (e.g. underline urls or other useless stuff). Only lines |
588 | that are being shown will be filtered, and, due to performance reasons, |
641 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
595 | later with the already-modified line (e.g. if unrelated parts change), so |
648 | later with the already-modified line (e.g. if unrelated parts change), so |
596 | you cannot just toggle rendition bits, but only set them. |
649 | you cannot just toggle rendition bits, but only set them. |
597 | |
650 | |
598 | =item on_refresh_begin $term |
651 | =item on_refresh_begin $term |
599 | |
652 | |
600 | Called just before the screen gets redrawn. Can be used for overlay |
653 | Called just before the screen gets redrawn. Can be used for overlay or |
601 | or similar effects by modify terminal contents in refresh_begin, and |
654 | similar effects by modifying the terminal contents in refresh_begin, and |
602 | restoring them in refresh_end. The built-in overlay and selection display |
655 | restoring them in refresh_end. The built-in overlay and selection display |
603 | code is run after this hook, and takes precedence. |
656 | code is run after this hook, and takes precedence. |
604 | |
657 | |
605 | =item on_refresh_end $term |
658 | =item on_refresh_end $term |
606 | |
659 | |
… | |
… | |
613 | resource in the @@RXVT_NAME@@(1) manpage). |
666 | resource in the @@RXVT_NAME@@(1) manpage). |
614 | |
667 | |
615 | The event is simply the action string. This interface is assumed to change |
668 | The event is simply the action string. This interface is assumed to change |
616 | slightly in the future. |
669 | slightly in the future. |
617 | |
670 | |
618 | =item on_resize_all_windows $tern, $new_width, $new_height |
671 | =item on_resize_all_windows $term, $new_width, $new_height |
619 | |
672 | |
620 | Called just after the new window size has been calculated, but before |
673 | Called just after the new window size has been calculated, but before |
621 | windows are actually being resized or hints are being set. If this hook |
674 | windows are actually being resized or hints are being set. If this hook |
622 | returns TRUE, setting of the window hints is being skipped. |
675 | returns TRUE, setting of the window hints is being skipped. |
623 | |
676 | |
… | |
… | |
657 | |
710 | |
658 | =item on_map_notify $term, $event |
711 | =item on_map_notify $term, $event |
659 | |
712 | |
660 | =item on_unmap_notify $term, $event |
713 | =item on_unmap_notify $term, $event |
661 | |
714 | |
662 | Called whenever the corresponding X event is received for the terminal If |
715 | Called whenever the corresponding X event is received for the terminal. If |
663 | the hook returns true, then the even will be ignored by rxvt-unicode. |
716 | the hook returns true, then the event will be ignored by rxvt-unicode. |
664 | |
717 | |
665 | The event is a hash with most values as named by Xlib (see the XEvent |
718 | The event is a hash with most values as named by Xlib (see the XEvent |
666 | manpage), with the additional members C<row> and C<col>, which are the |
719 | manpage), with the additional members C<row> and C<col>, which are the |
667 | (real, not screen-based) row and column under the mouse cursor. |
720 | (real, not screen-based) row and column under the mouse cursor. |
668 | |
721 | |
… | |
… | |
677 | |
730 | |
678 | =item on_wm_delete_window $term, $event |
731 | =item on_wm_delete_window $term, $event |
679 | |
732 | |
680 | Called when various types of ClientMessage events are received (all with |
733 | Called when various types of ClientMessage events are received (all with |
681 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
734 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
735 | |
|
|
736 | =item on_bell $term |
|
|
737 | |
|
|
738 | Called on receipt of a bell character. |
682 | |
739 | |
683 | =back |
740 | =back |
684 | |
741 | |
685 | =cut |
742 | =cut |
686 | |
743 | |
… | |
… | |
751 | |
808 | |
752 | =over 4 |
809 | =over 4 |
753 | |
810 | |
754 | =item urxvt::fatal $errormessage |
811 | =item urxvt::fatal $errormessage |
755 | |
812 | |
756 | Fatally aborts execution with the given error message. Avoid at all |
813 | Fatally aborts execution with the given error message (which should |
757 | costs! The only time this is acceptable is when the terminal process |
814 | include a trailing newline). Avoid at all costs! The only time this |
758 | starts up. |
815 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
816 | terminal from starting up. |
759 | |
817 | |
760 | =item urxvt::warn $string |
818 | =item urxvt::warn $string |
761 | |
819 | |
762 | Calls C<rxvt_warn> with the given string which should not include a |
820 | Calls C<rxvt_warn> with the given string which should include a trailing |
763 | newline. The module also overwrites the C<warn> builtin with a function |
821 | newline. The module also overwrites the C<warn> builtin with a function |
764 | that calls this function. |
822 | that calls this function. |
765 | |
823 | |
766 | Using this function has the advantage that its output ends up in the |
824 | Using this function has the advantage that its output ends up in the |
767 | correct place, e.g. on stderr of the connecting urxvtc client. |
825 | correct place, e.g. on stderr of the connecting urxvtc client. |
… | |
… | |
771 | =item @terms = urxvt::termlist |
829 | =item @terms = urxvt::termlist |
772 | |
830 | |
773 | Returns all urxvt::term objects that exist in this process, regardless of |
831 | Returns all urxvt::term objects that exist in this process, regardless of |
774 | whether they are started, being destroyed etc., so be careful. Only term |
832 | whether they are started, being destroyed etc., so be careful. Only term |
775 | objects that have perl extensions attached will be returned (because there |
833 | objects that have perl extensions attached will be returned (because there |
776 | is no urxvt::term objet associated with others). |
834 | is no urxvt::term object associated with others). |
777 | |
835 | |
778 | =item $time = urxvt::NOW |
836 | =item $time = urxvt::NOW |
779 | |
837 | |
780 | Returns the "current time" (as per the event loop). |
838 | Returns the "current time" (as per the event loop). |
781 | |
839 | |
… | |
… | |
824 | |
882 | |
825 | =item $rend = urxvt::OVERLAY_RSTYLE |
883 | =item $rend = urxvt::OVERLAY_RSTYLE |
826 | |
884 | |
827 | Return the rendition mask used for overlays by default. |
885 | Return the rendition mask used for overlays by default. |
828 | |
886 | |
829 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
887 | =item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, |
|
|
888 | urxvt::RS_RVid, urxvt::RS_Uline |
830 | |
889 | |
831 | Return the bit that enabled bold, italic, blink, reverse-video and |
890 | Return the bit that enabled bold, italic, blink, reverse-video and |
832 | underline, respectively. To enable such a style, just logically OR it into |
891 | underline, respectively. To enable such a style, just logically OR it into |
833 | the bitset. |
892 | the bitset. |
834 | |
893 | |
… | |
… | |
917 | local $TERM = shift; |
976 | local $TERM = shift; |
918 | my $htype = shift; |
977 | my $htype = shift; |
919 | |
978 | |
920 | if ($htype == 0) { # INIT |
979 | if ($htype == 0) { # INIT |
921 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
980 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
922 | |
981 | |
923 | my %ext_arg; |
982 | my %ext_arg; |
924 | |
983 | |
925 | { |
984 | { |
926 | my @init = @TERM_INIT; |
985 | my @init = @TERM_INIT; |
927 | @TERM_INIT = (); |
986 | @TERM_INIT = (); |
… | |
… | |
990 | |
1049 | |
991 | sub SET_COLOR($$$) { |
1050 | sub SET_COLOR($$$) { |
992 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
1051 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
993 | } |
1052 | } |
994 | |
1053 | |
|
|
1054 | sub rend2mask { |
|
|
1055 | no strict 'refs'; |
|
|
1056 | my ($str, $mask) = (@_, 0); |
|
|
1057 | my %color = ( fg => undef, bg => undef ); |
|
|
1058 | my @failed; |
|
|
1059 | for my $spec ( split /\s+/, $str ) { |
|
|
1060 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1061 | $color{lc($1)} = $2; |
|
|
1062 | } else { |
|
|
1063 | my $neg = $spec =~ s/^[-^]//; |
|
|
1064 | unless ( exists &{"RS_$spec"} ) { |
|
|
1065 | push @failed, $spec; |
|
|
1066 | next; |
|
|
1067 | } |
|
|
1068 | my $cur = &{"RS_$spec"}; |
|
|
1069 | if ( $neg ) { |
|
|
1070 | $mask &= ~$cur; |
|
|
1071 | } else { |
|
|
1072 | $mask |= $cur; |
|
|
1073 | } |
|
|
1074 | } |
|
|
1075 | } |
|
|
1076 | ($mask, @color{qw(fg bg)}, \@failed) |
|
|
1077 | } |
|
|
1078 | |
995 | # urxvt::term::extension |
1079 | # urxvt::term::extension |
996 | |
1080 | |
997 | package urxvt::term::extension; |
1081 | package urxvt::term::extension; |
998 | |
1082 | |
999 | sub enable { |
1083 | sub enable { |
… | |
… | |
1068 | is that you cannot use blocking APIs, but the non-blocking variant should |
1152 | is that you cannot use blocking APIs, but the non-blocking variant should |
1069 | work. |
1153 | work. |
1070 | |
1154 | |
1071 | =cut |
1155 | =cut |
1072 | |
1156 | |
1073 | our $VERSION = 1; |
1157 | our $VERSION = '5.23'; |
1074 | |
1158 | |
1075 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1159 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1076 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1160 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1077 | |
1161 | |
1078 | sub timer { |
1162 | sub timer { |
… | |
… | |
1080 | |
1164 | |
1081 | my $cb = $arg{cb}; |
1165 | my $cb = $arg{cb}; |
1082 | |
1166 | |
1083 | urxvt::timer |
1167 | urxvt::timer |
1084 | ->new |
1168 | ->new |
1085 | ->start (urxvt::NOW + $arg{after}) |
1169 | ->after ($arg{after}, $arg{interval}) |
1086 | ->cb (sub { |
1170 | ->cb ($arg{interval} ? $cb : sub { |
1087 | $_[0]->stop; # need to cancel manually |
1171 | $_[0]->stop; # need to cancel manually |
1088 | $cb->(); |
1172 | $cb->(); |
1089 | }) |
1173 | }) |
1090 | } |
1174 | } |
1091 | |
1175 | |
1092 | sub io { |
1176 | sub io { |
1093 | my ($class, %arg) = @_; |
1177 | my ($class, %arg) = @_; |
1094 | |
1178 | |
1095 | my $cb = $arg{cb}; |
1179 | my $cb = $arg{cb}; |
|
|
1180 | my $fd = fileno $arg{fh}; |
|
|
1181 | defined $fd or $fd = $arg{fh}; |
1096 | |
1182 | |
1097 | bless [$arg{fh}, urxvt::iow |
1183 | bless [$arg{fh}, urxvt::iow |
1098 | ->new |
1184 | ->new |
1099 | ->fd (fileno $arg{fh}) |
1185 | ->fd ($fd) |
1100 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1186 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1101 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1187 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1102 | ->start |
1188 | ->start |
1103 | ->cb (sub { |
1189 | ->cb ($cb) |
1104 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
1105 | . ($_[1] & 2 ? 'w' : '')); |
|
|
1106 | })], |
|
|
1107 | urxvt::anyevent:: |
1190 | ], urxvt::anyevent:: |
|
|
1191 | } |
|
|
1192 | |
|
|
1193 | sub idle { |
|
|
1194 | my ($class, %arg) = @_; |
|
|
1195 | |
|
|
1196 | my $cb = $arg{cb}; |
|
|
1197 | |
|
|
1198 | urxvt::iw |
|
|
1199 | ->new |
|
|
1200 | ->start |
|
|
1201 | ->cb ($cb) |
|
|
1202 | } |
|
|
1203 | |
|
|
1204 | sub child { |
|
|
1205 | my ($class, %arg) = @_; |
|
|
1206 | |
|
|
1207 | my $cb = $arg{cb}; |
|
|
1208 | |
|
|
1209 | urxvt::pw |
|
|
1210 | ->new |
|
|
1211 | ->start ($arg{pid}) |
|
|
1212 | ->cb (sub { |
|
|
1213 | $_[0]->stop; # need to cancel manually |
|
|
1214 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1215 | }) |
1108 | } |
1216 | } |
1109 | |
1217 | |
1110 | sub DESTROY { |
1218 | sub DESTROY { |
1111 | $_[0][1]->stop; |
1219 | $_[0][1]->stop; |
1112 | } |
1220 | } |
1113 | |
1221 | |
1114 | sub condvar { |
1222 | # only needed for AnyEvent < 6 compatibility |
1115 | bless \my $flag, urxvt::anyevent::condvar:: |
1223 | sub one_event { |
1116 | } |
|
|
1117 | |
|
|
1118 | sub urxvt::anyevent::condvar::broadcast { |
|
|
1119 | ${$_[0]}++; |
|
|
1120 | } |
|
|
1121 | |
|
|
1122 | sub urxvt::anyevent::condvar::wait { |
|
|
1123 | unless (${$_[0]}) { |
|
|
1124 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1224 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1125 | } |
|
|
1126 | } |
1225 | } |
1127 | |
1226 | |
1128 | package urxvt::term; |
1227 | package urxvt::term; |
1129 | |
1228 | |
1130 | =head2 The C<urxvt::term> Class |
1229 | =head2 The C<urxvt::term> Class |
… | |
… | |
1220 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1319 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1221 | |
1320 | |
1222 | Here is a likely non-exhaustive list of option names, please see the |
1321 | Here is a likely non-exhaustive list of option names, please see the |
1223 | source file F</src/optinc.h> to see the actual list: |
1322 | source file F</src/optinc.h> to see the actual list: |
1224 | |
1323 | |
1225 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1324 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
1226 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1325 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1227 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1326 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1228 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
1327 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1229 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
1328 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1230 | transparent tripleclickwords utmpInhibit visualBell |
1329 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
|
|
1330 | urgentOnBell utmpInhibit visualBell |
1231 | |
1331 | |
1232 | =item $value = $term->resource ($name[, $newval]) |
1332 | =item $value = $term->resource ($name[, $newval]) |
1233 | |
1333 | |
1234 | Returns the current resource value associated with a given name and |
1334 | Returns the current resource value associated with a given name and |
1235 | optionally sets a new value. Setting values is most useful in the C<init> |
1335 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
1248 | |
1348 | |
1249 | Here is a likely non-exhaustive list of resource names, not all of which |
1349 | Here is a likely non-exhaustive list of resource names, not all of which |
1250 | are supported in every build, please see the source file F</src/rsinc.h> |
1350 | are supported in every build, please see the source file F</src/rsinc.h> |
1251 | to see the actual list: |
1351 | to see the actual list: |
1252 | |
1352 | |
1253 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1353 | answerbackstring backgroundPixmap backspace_key blendtype blurradius |
1254 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1354 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1255 | display_name embed ext_bwidth fade font geometry hold iconName |
1355 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1256 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1356 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
|
|
1357 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
1257 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1358 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1258 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1359 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1259 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1360 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1260 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1361 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1261 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1362 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1262 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1363 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1263 | secondaryScreen secondaryScroll selectstyle shade term_name title |
1364 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1264 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1365 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1265 | visualBell |
1366 | utmpInhibit visualBell |
1266 | |
1367 | |
1267 | =cut |
1368 | =cut |
1268 | |
1369 | |
1269 | sub resource($$;$) { |
1370 | sub resource($$;$) { |
1270 | my ($self, $name) = (shift, shift); |
1371 | my ($self, $name) = (shift, shift); |
1271 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1372 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1272 | &urxvt::term::_resource |
1373 | goto &urxvt::term::_resource |
1273 | } |
1374 | } |
1274 | |
1375 | |
1275 | =item $value = $term->x_resource ($pattern) |
1376 | =item $value = $term->x_resource ($pattern) |
1276 | |
1377 | |
1277 | Returns the X-Resource for the given pattern, excluding the program or |
1378 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
1302 | |
1403 | |
1303 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1404 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1304 | |
1405 | |
1305 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1406 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1306 | |
1407 | |
1307 | Return the current values of the selection mark, begin or end positions, |
1408 | Return the current values of the selection mark, begin or end positions. |
1308 | and optionally set them to new values. |
1409 | |
|
|
1410 | When arguments are given, then the selection coordinates are set to |
|
|
1411 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1412 | screen. |
|
|
1413 | |
|
|
1414 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1415 | |
|
|
1416 | Returns the current selection screen, and then optionally sets it. |
1309 | |
1417 | |
1310 | =item $term->selection_make ($eventtime[, $rectangular]) |
1418 | =item $term->selection_make ($eventtime[, $rectangular]) |
1311 | |
1419 | |
1312 | Tries to make a selection as set by C<selection_beg> and |
1420 | Tries to make a selection as set by C<selection_beg> and |
1313 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1421 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1314 | rectangular selection will be made. This is the prefered function to make |
1422 | rectangular selection will be made. This is the preferred function to make |
1315 | a selection. |
1423 | a selection. |
1316 | |
1424 | |
1317 | =item $success = $term->selection_grab ($eventtime) |
1425 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
1318 | |
1426 | |
1319 | Try to request the primary selection text from the server (for example, as |
1427 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1428 | true) selection from the server. The corresponding text can be set |
1320 | set by the next method). No visual feedback will be given. This function |
1429 | with the next method. No visual feedback will be given. This function |
1321 | is mostly useful from within C<on_sel_grab> hooks. |
1430 | is mostly useful from within C<on_sel_grab> hooks. |
1322 | |
1431 | |
1323 | =item $oldtext = $term->selection ([$newtext]) |
1432 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
1324 | |
1433 | |
1325 | Return the current selection text and optionally replace it by C<$newtext>. |
1434 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1435 | and optionally replace it by C<$newtext>. |
|
|
1436 | |
|
|
1437 | =item $term->selection_clear ([$clipboard]) |
|
|
1438 | |
|
|
1439 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
1326 | |
1440 | |
1327 | =item $term->overlay_simple ($x, $y, $text) |
1441 | =item $term->overlay_simple ($x, $y, $text) |
1328 | |
1442 | |
1329 | Create a simple multi-line overlay box. See the next method for details. |
1443 | Create a simple multi-line overlay box. See the next method for details. |
1330 | |
1444 | |
… | |
… | |
1360 | |
1474 | |
1361 | The methods currently supported on C<urxvt::overlay> objects are: |
1475 | The methods currently supported on C<urxvt::overlay> objects are: |
1362 | |
1476 | |
1363 | =over 4 |
1477 | =over 4 |
1364 | |
1478 | |
1365 | =item $overlay->set ($x, $y, $text, $rend) |
1479 | =item $overlay->set ($x, $y, $text[, $rend]) |
1366 | |
1480 | |
1367 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1481 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1368 | text in rxvt-unicode's special encoding and an array of rendition values |
1482 | text in rxvt-unicode's special encoding and an array of rendition values |
1369 | at a specific position inside the overlay. |
1483 | at a specific position inside the overlay. |
|
|
1484 | |
|
|
1485 | If C<$rend> is missing, then the rendition will not be changed. |
1370 | |
1486 | |
1371 | =item $overlay->hide |
1487 | =item $overlay->hide |
1372 | |
1488 | |
1373 | If visible, hide the overlay, but do not destroy it. |
1489 | If visible, hide the overlay, but do not destroy it. |
1374 | |
1490 | |
… | |
… | |
1456 | locale-specific encoding of the terminal and can contain command sequences |
1572 | locale-specific encoding of the terminal and can contain command sequences |
1457 | (escape codes) that will be interpreted. |
1573 | (escape codes) that will be interpreted. |
1458 | |
1574 | |
1459 | =item $term->tt_write ($octets) |
1575 | =item $term->tt_write ($octets) |
1460 | |
1576 | |
1461 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1577 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1462 | pass characters instead of octets, you should convert your strings first |
1578 | pass characters instead of octets, you should convert your strings first |
1463 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1579 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1580 | |
|
|
1581 | =item $term->tt_paste ($octets) |
|
|
1582 | |
|
|
1583 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1584 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1585 | is set. |
1464 | |
1586 | |
1465 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1587 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1466 | |
1588 | |
1467 | Replaces the event mask of the pty watcher by the given event mask. Can |
1589 | Replaces the event mask of the pty watcher by the given event mask. Can |
1468 | be used to suppress input and output handling to the pty/tty. See the |
1590 | be used to suppress input and output handling to the pty/tty. See the |
… | |
… | |
1584 | |
1706 | |
1585 | Used after changing terminal contents to display them. |
1707 | Used after changing terminal contents to display them. |
1586 | |
1708 | |
1587 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1709 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1588 | |
1710 | |
1589 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1711 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1590 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1712 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1591 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1592 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1713 | terminal line. Nothing will be returned if a nonexistent line |
1593 | is requested. |
1714 | is requested. |
1594 | |
1715 | |
1595 | If C<$new_text> is specified, it will replace characters in the current |
1716 | If C<$new_text> is specified, it will replace characters in the current |
1596 | line, starting at column C<$start_col> (default C<0>), which is useful |
1717 | line, starting at column C<$start_col> (default C<0>), which is useful |
1597 | to replace only parts of a line. The font index in the rendition will |
1718 | to replace only parts of a line. The font index in the rendition will |
1598 | automatically be updated. |
1719 | automatically be updated. |
1599 | |
1720 | |
1600 | C<$text> is in a special encoding: tabs and wide characters that use more |
1721 | C<$text> is in a special encoding: tabs and wide characters that use more |
1601 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1722 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1602 | characters. Characters with combining characters and other characters that |
1723 | characters. Characters with combining characters and other characters that |
1603 | do not fit into the normal tetx encoding will be replaced with characters |
1724 | do not fit into the normal text encoding will be replaced with characters |
1604 | in the private use area. |
1725 | in the private use area. |
1605 | |
1726 | |
1606 | You have to obey this encoding when changing text. The advantage is |
1727 | You have to obey this encoding when changing text. The advantage is |
1607 | that C<substr> and similar functions work on screen cells and not on |
1728 | that C<substr> and similar functions work on screen cells and not on |
1608 | characters. |
1729 | characters. |
… | |
… | |
1783 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1904 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1784 | recent grab. |
1905 | recent grab. |
1785 | |
1906 | |
1786 | =item $term->ungrab |
1907 | =item $term->ungrab |
1787 | |
1908 | |
1788 | Calls XUngrab for the most recent grab. Is called automatically on |
1909 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
1789 | evaluation errors, as it is better to lose the grab in the error case as |
1910 | evaluation errors, as it is better to lose the grab in the error case as |
1790 | the session. |
1911 | the session. |
1791 | |
1912 | |
1792 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1913 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1793 | |
1914 | |
… | |
… | |
1795 | |
1916 | |
1796 | =item @atoms = $term->XListProperties ($window) |
1917 | =item @atoms = $term->XListProperties ($window) |
1797 | |
1918 | |
1798 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1919 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1799 | |
1920 | |
1800 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
1921 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
1801 | |
1922 | |
1802 | =item $term->XDeleteProperty ($window, $property) |
1923 | =item $term->XDeleteProperty ($window, $property) |
1803 | |
1924 | |
1804 | =item $window = $term->DefaultRootWindow |
1925 | =item $window = $term->DefaultRootWindow |
1805 | |
1926 | |
… | |
… | |
1815 | |
1936 | |
1816 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1937 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1817 | |
1938 | |
1818 | Various X or X-related functions. The C<$term> object only serves as |
1939 | Various X or X-related functions. The C<$term> object only serves as |
1819 | the source of the display, otherwise those functions map more-or-less |
1940 | the source of the display, otherwise those functions map more-or-less |
1820 | directory onto the X functions of the same name. |
1941 | directly onto the X functions of the same name. |
1821 | |
1942 | |
1822 | =back |
1943 | =back |
1823 | |
1944 | |
1824 | =cut |
1945 | =cut |
1825 | |
1946 | |
… | |
… | |
1927 | my $env = $self->{term}->env; |
2048 | my $env = $self->{term}->env; |
1928 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
2049 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1929 | delete $env->{LC_ALL}; |
2050 | delete $env->{LC_ALL}; |
1930 | $env->{LC_CTYPE} = $self->{term}->locale; |
2051 | $env->{LC_CTYPE} = $self->{term}->locale; |
1931 | |
2052 | |
1932 | urxvt::term->new ($env, "popup", |
2053 | my $term = urxvt::term->new ( |
|
|
2054 | $env, "popup", |
1933 | "--perl-lib" => "", "--perl-ext-common" => "", |
2055 | "--perl-lib" => "", "--perl-ext-common" => "", |
1934 | "-pty-fd" => -1, "-sl" => 0, |
2056 | "-pty-fd" => -1, "-sl" => 0, |
1935 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
2057 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1936 | "--transient-for" => $self->{term}->parent, |
2058 | "--transient-for" => $self->{term}->parent, |
1937 | "-display" => $self->{term}->display_id, |
2059 | "-display" => $self->{term}->display_id, |
1938 | "-pe" => "urxvt-popup") |
2060 | "-pe" => "urxvt-popup", |
1939 | or die "unable to create popup window\n"; |
2061 | ) or die "unable to create popup window\n"; |
|
|
2062 | |
|
|
2063 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
2064 | $term->ungrab; |
|
|
2065 | $term->destroy; |
|
|
2066 | die "unable to initialise popup window\n"; |
|
|
2067 | } |
1940 | } |
2068 | } |
1941 | |
2069 | |
1942 | sub DESTROY { |
2070 | sub DESTROY { |
1943 | my ($self) = @_; |
2071 | my ($self) = @_; |
1944 | |
2072 | |
… | |
… | |
1949 | =back |
2077 | =back |
1950 | |
2078 | |
1951 | =cut |
2079 | =cut |
1952 | |
2080 | |
1953 | package urxvt::watcher; |
2081 | package urxvt::watcher; |
1954 | |
|
|
1955 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1956 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1957 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1958 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1959 | |
2082 | |
1960 | =head2 The C<urxvt::timer> Class |
2083 | =head2 The C<urxvt::timer> Class |
1961 | |
2084 | |
1962 | This class implements timer watchers/events. Time is represented as a |
2085 | This class implements timer watchers/events. Time is represented as a |
1963 | fractional number of seconds since the epoch. Example: |
2086 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1967 | ->new |
2090 | ->new |
1968 | ->interval (1) |
2091 | ->interval (1) |
1969 | ->cb (sub { |
2092 | ->cb (sub { |
1970 | $term->{overlay}->set (0, 0, |
2093 | $term->{overlay}->set (0, 0, |
1971 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2094 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1972 | }); |
2095 | }); |
1973 | |
2096 | |
1974 | =over 4 |
2097 | =over 4 |
1975 | |
2098 | |
1976 | =item $timer = new urxvt::timer |
2099 | =item $timer = new urxvt::timer |
1977 | |
2100 | |
… | |
… | |
1980 | |
2103 | |
1981 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2104 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
1982 | |
2105 | |
1983 | Set the callback to be called when the timer triggers. |
2106 | Set the callback to be called when the timer triggers. |
1984 | |
2107 | |
1985 | =item $tstamp = $timer->at |
|
|
1986 | |
|
|
1987 | Return the time this watcher will fire next. |
|
|
1988 | |
|
|
1989 | =item $timer = $timer->set ($tstamp) |
2108 | =item $timer = $timer->set ($tstamp[, $interval]) |
1990 | |
2109 | |
1991 | Set the time the event is generated to $tstamp. |
2110 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2111 | new $interval). |
1992 | |
2112 | |
1993 | =item $timer = $timer->interval ($interval) |
2113 | =item $timer = $timer->interval ($interval) |
1994 | |
2114 | |
1995 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2115 | By default (and when C<$interval> is C<0>), the timer will automatically |
1996 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2116 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
1997 | is automatically rescheduled at the given intervals. |
2117 | is automatically rescheduled at the given intervals. |
1998 | |
2118 | |
1999 | =item $timer = $timer->start |
2119 | =item $timer = $timer->start |
2000 | |
2120 | |
2001 | Start the timer. |
2121 | Start the timer. |
2002 | |
2122 | |
2003 | =item $timer = $timer->start ($tstamp) |
2123 | =item $timer = $timer->start ($tstamp[, $interval]) |
2004 | |
2124 | |
2005 | Set the event trigger time to C<$tstamp> and start the timer. |
2125 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2126 | also replaces the interval. |
2006 | |
2127 | |
2007 | =item $timer = $timer->after ($delay) |
2128 | =item $timer = $timer->after ($delay[, $interval]) |
2008 | |
2129 | |
2009 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2130 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2010 | |
2131 | |
2011 | =item $timer = $timer->stop |
2132 | =item $timer = $timer->stop |
2012 | |
2133 | |
… | |
… | |
2020 | |
2141 | |
2021 | $term->{socket} = ... |
2142 | $term->{socket} = ... |
2022 | $term->{iow} = urxvt::iow |
2143 | $term->{iow} = urxvt::iow |
2023 | ->new |
2144 | ->new |
2024 | ->fd (fileno $term->{socket}) |
2145 | ->fd (fileno $term->{socket}) |
2025 | ->events (urxvt::EVENT_READ) |
2146 | ->events (urxvt::EV_READ) |
2026 | ->start |
2147 | ->start |
2027 | ->cb (sub { |
2148 | ->cb (sub { |
2028 | my ($iow, $revents) = @_; |
2149 | my ($iow, $revents) = @_; |
2029 | # $revents must be 1 here, no need to check |
2150 | # $revents must be 1 here, no need to check |
2030 | sysread $term->{socket}, my $buf, 8192 |
2151 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
2048 | Set the file descriptor (not handle) to watch. |
2169 | Set the file descriptor (not handle) to watch. |
2049 | |
2170 | |
2050 | =item $iow = $iow->events ($eventmask) |
2171 | =item $iow = $iow->events ($eventmask) |
2051 | |
2172 | |
2052 | Set the event mask to watch. The only allowed values are |
2173 | Set the event mask to watch. The only allowed values are |
2053 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2174 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
2054 | together, or C<urxvt::EVENT_NONE>. |
2175 | together, or C<urxvt::EV_NONE>. |
2055 | |
2176 | |
2056 | =item $iow = $iow->start |
2177 | =item $iow = $iow->start |
2057 | |
2178 | |
2058 | Start watching for requested events on the given handle. |
2179 | Start watching for requested events on the given handle. |
2059 | |
2180 | |
… | |
… | |
2100 | ->new |
2221 | ->new |
2101 | ->start ($pid) |
2222 | ->start ($pid) |
2102 | ->cb (sub { |
2223 | ->cb (sub { |
2103 | my ($pw, $exit_status) = @_; |
2224 | my ($pw, $exit_status) = @_; |
2104 | ... |
2225 | ... |
2105 | }); |
2226 | }); |
2106 | |
2227 | |
2107 | =over 4 |
2228 | =over 4 |
2108 | |
2229 | |
2109 | =item $pw = new urxvt::pw |
2230 | =item $pw = new urxvt::pw |
2110 | |
2231 | |
… | |
… | |
2143 | |
2264 | |
2144 | =back |
2265 | =back |
2145 | |
2266 | |
2146 | =head1 AUTHOR |
2267 | =head1 AUTHOR |
2147 | |
2268 | |
2148 | Marc Lehmann <pcg@goof.com> |
2269 | Marc Lehmann <schmorp@schmorp.de> |
2149 | http://software.schmorp.de/pkg/rxvt-unicode |
2270 | http://software.schmorp.de/pkg/rxvt-unicode |
2150 | |
2271 | |
2151 | =cut |
2272 | =cut |
2152 | |
2273 | |
2153 | 1 |
2274 | 1 |
|
|
2275 | |
|
|
2276 | # vim: sw=3: |