… | |
… | |
40 | |
40 | |
41 | @@RXVT_NAME@@ -pe <extensionname> |
41 | @@RXVT_NAME@@ -pe <extensionname> |
42 | |
42 | |
43 | 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: |
44 | |
44 | |
45 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
45 | URxvt.perl-ext-common: default,selection-autotransform |
46 | |
46 | |
47 | =over 4 |
47 | =over 4 |
48 | |
48 | |
49 | =item selection (enabled by default) |
49 | =item selection (enabled by default) |
50 | |
50 | |
… | |
… | |
101 | |
101 | |
102 | 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 |
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
104 | popup is being displayed. |
104 | popup is being displayed. |
105 | |
105 | |
106 | 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 |
107 | 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 |
108 | 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 |
109 | 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 |
110 | first argument. |
110 | first argument. |
111 | |
111 | |
112 | The following will add an entry C<myoption> that changes |
112 | The following will add an entry C<myoption> that changes |
113 | C<$self->{myoption}>: |
113 | C<< $self->{myoption} >>: |
114 | |
114 | |
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
117 | }; |
117 | }; |
118 | |
118 | |
… | |
… | |
124 | |
124 | |
125 | 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 |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
127 | popup is being displayed. |
127 | popup is being displayed. |
128 | |
128 | |
129 | 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 |
130 | 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. |
131 | 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 |
132 | 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 |
133 | when the button gets activated and should transform C<$_>. |
133 | when the button gets activated and should transform C<$_>. |
134 | |
134 | |
135 | 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 |
136 | 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 |
137 | C<a>s: |
137 | C<a>s: |
138 | |
138 | |
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
140 | /a/ ? ("a to be" => sub { s/a/b/g } |
140 | /a/ ? ("a to b" => sub { s/a/b/g } |
141 | : () |
141 | : () |
142 | }; |
142 | }; |
143 | |
143 | |
144 | =item searchable-scrollback<hotkey> (enabled by default) |
144 | =item searchable-scrollback<hotkey> (enabled by default) |
145 | |
145 | |
… | |
… | |
165 | =item readline (enabled by default) |
165 | =item readline (enabled by default) |
166 | |
166 | |
167 | 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 |
168 | 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 |
169 | 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 |
170 | cursor-left or cursor-right keypresses as required (the this only works |
170 | cursor-left or cursor-right keypresses as required (this only works |
171 | for programs that correctly support wide characters). |
171 | for programs that correctly support wide characters). |
172 | |
172 | |
173 | To avoid too many false positives, this is only done when: |
173 | To avoid too many false positives, this is only done when: |
174 | |
174 | |
175 | =over 4 |
175 | =over 4 |
… | |
… | |
259 | The default pattern to match URLs can be overridden with the |
259 | The default pattern to match URLs can be overridden with the |
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
261 | with numbered patterns, in a manner similar to the "selection" extension. |
261 | with numbered patterns, in a manner similar to the "selection" extension. |
262 | The launcher can also be overridden on a per-pattern basis. |
262 | The launcher can also be overridden on a per-pattern basis. |
263 | |
263 | |
264 | It is possible to activate the most recently seen match from the keyboard. |
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 |
265 | Simply bind a keysym to "perl:matcher" as seen in the example below. |
266 | "perl:matcher:list" as seen in the example below. |
266 | |
267 | |
267 | Example configuration: |
268 | Example configuration: |
268 | |
269 | |
269 | URxvt.perl-ext: default,matcher |
270 | URxvt.perl-ext: default,matcher |
270 | URxvt.urlLauncher: sensible-browser |
271 | URxvt.urlLauncher: sensible-browser |
271 | URxvt.keysym.C-Delete: perl:matcher |
272 | URxvt.keysym.C-Delete: perl:matcher:last |
|
|
273 | URxvt.keysym.M-Delete: perl:matcher:list |
272 | URxvt.matcher.button: 1 |
274 | URxvt.matcher.button: 1 |
273 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
275 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
274 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
276 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
275 | URxvt.matcher.launcher.2: gvim +$2 $1 |
277 | URxvt.matcher.launcher.2: gvim +$2 $1 |
276 | |
278 | |
277 | =item xim-onthespot |
279 | =item xim-onthespot |
278 | |
280 | |
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
281 | This (experimental) perl extension implements OnTheSpot editing. It does |
280 | 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 |
281 | 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 |
282 | kinput2. |
284 | kinput2. |
283 | |
285 | |
284 | 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 |
285 | C<OnTheSpot>, i.e.: |
287 | C<OnTheSpot>, i.e.: |
286 | |
288 | |
… | |
… | |
294 | 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 |
295 | or show it again. |
297 | or show it again. |
296 | |
298 | |
297 | Initially, the window will not be shown when using this extension. |
299 | Initially, the window will not be shown when using this extension. |
298 | |
300 | |
299 | 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 |
300 | 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. |
301 | |
303 | |
302 | The accelerator key is grabbed regardless of any modifiers, so this |
304 | The accelerator key is grabbed regardless of any modifiers, so this |
303 | extension will actually grab a physical key just for this function. |
305 | extension will actually grab a physical key just for this function. |
304 | |
306 | |
305 | 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 |
306 | (fvwm can do it). |
308 | (fvwm can do it). |
307 | |
309 | |
308 | =item automove-background |
310 | =item overlay-osc |
309 | |
311 | |
310 | This is basically a very small extension that dynamically changes the |
312 | This extension implements some OSC commands to display timed popups on the |
311 | background pixmap offset to the window position, in effect creating the |
313 | screen - useful for status displays from within scripts. You have to read |
312 | same effect as pseudo transparency with a custom pixmap. No scaling is |
314 | the sources for more info. |
313 | supported in this mode. Example: |
|
|
314 | |
|
|
315 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
316 | |
|
|
317 | L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions> |
|
|
318 | shows how this extension can be used to implement an automatically blurred |
|
|
319 | transparent background. |
|
|
320 | |
315 | |
321 | =item block-graphics-to-ascii |
316 | =item block-graphics-to-ascii |
322 | |
317 | |
323 | 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 |
324 | 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 |
… | |
… | |
329 | Displays a digital clock using the built-in overlay. |
324 | Displays a digital clock using the built-in overlay. |
330 | |
325 | |
331 | =item remote-clipboard |
326 | =item remote-clipboard |
332 | |
327 | |
333 | 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 |
334 | 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 |
335 | selection somewhere and fetch it again. |
330 | selection somewhere and fetch it again. |
336 | |
331 | |
337 | We use it to implement a "distributed selection mechanism", which just |
332 | We use it to implement a "distributed selection mechanism", which just |
338 | 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 |
339 | reads it. |
334 | reads it. |
… | |
… | |
348 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
343 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
349 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
344 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
350 | |
345 | |
351 | =item selection-pastebin |
346 | =item selection-pastebin |
352 | |
347 | |
353 | 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 |
354 | 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 |
355 | 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 |
356 | F</tmp> directly.). |
351 | F</tmp> directly.). |
357 | |
352 | |
358 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
353 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
… | |
… | |
377 | |
372 | |
378 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
373 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
379 | |
374 | |
380 | 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 |
381 | 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, |
382 | 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 |
383 | 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. |
384 | |
393 | |
385 | =item example-refresh-hooks |
394 | =item example-refresh-hooks |
386 | |
395 | |
387 | 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 |
388 | window. Illustrates overwriting the refresh callbacks to create your own |
397 | window. Illustrates overwriting the refresh callbacks to create your own |
389 | 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" |
390 | |
412 | |
391 | =back |
413 | =back |
392 | |
414 | |
393 | =head1 API DOCUMENTATION |
415 | =head1 API DOCUMENTATION |
394 | |
416 | |
… | |
… | |
410 | |
432 | |
411 | =over 4 |
433 | =over 4 |
412 | |
434 | |
413 | =item $text |
435 | =item $text |
414 | |
436 | |
415 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
437 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
416 | 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. |
417 | |
439 | |
418 | =item $string |
440 | =item $string |
419 | |
441 | |
420 | 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 |
… | |
… | |
424 | =item $octets |
446 | =item $octets |
425 | |
447 | |
426 | Either binary data or - more common - a text string encoded in a |
448 | Either binary data or - more common - a text string encoded in a |
427 | locale-specific way. |
449 | locale-specific way. |
428 | |
450 | |
|
|
451 | =item $keysym |
|
|
452 | |
|
|
453 | an integer that is a valid X11 keysym code. You can convert a string |
|
|
454 | into a keysym and viceversa by using C<XStringToKeysym> and |
|
|
455 | C<XKeysymToString>. |
|
|
456 | |
429 | =back |
457 | =back |
430 | |
458 | |
431 | =head2 Extension Objects |
459 | =head2 Extension Objects |
432 | |
460 | |
433 | Every perl extension is a perl class. A separate perl object is created |
461 | Every perl extension is a perl class. A separate perl object is created |
434 | for each terminal, and each terminal has its own set of extenion objects, |
462 | for each terminal, and each terminal has its own set of extension objects, |
435 | which are passed as the first parameter to hooks. So extensions can use |
463 | which are passed as the first parameter to hooks. So extensions can use |
436 | their C<$self> object without having to think about clashes with other |
464 | their C<$self> object without having to think about clashes with other |
437 | extensions or other terminals, with the exception of methods and members |
465 | extensions or other terminals, with the exception of methods and members |
438 | that begin with an underscore character C<_>: these are reserved for |
466 | that begin with an underscore character C<_>: these are reserved for |
439 | internal use. |
467 | internal use. |
… | |
… | |
554 | |
582 | |
555 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
583 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
556 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
584 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
557 | number of lines that will be in the scrollback buffer. |
585 | number of lines that will be in the scrollback buffer. |
558 | |
586 | |
559 | =item on_osc_seq $term, $op, $args |
587 | =item on_osc_seq $term, $op, $args, $resp |
560 | |
588 | |
561 | Called on every OSC sequence and can be used to suppress it or modify its |
589 | Called on every OSC sequence and can be used to suppress it or modify its |
562 | behaviour. The default should be to return an empty list. A true value |
590 | behaviour. The default should be to return an empty list. A true value |
563 | suppresses execution of the request completely. Make sure you don't get |
591 | suppresses execution of the request completely. Make sure you don't get |
564 | confused by recursive invocations when you output an osc sequence within |
592 | confused by recursive invocations when you output an OSC sequence within |
565 | this callback. |
593 | this callback. |
566 | |
594 | |
567 | C<on_osc_seq_perl> should be used for new behaviour. |
595 | C<on_osc_seq_perl> should be used for new behaviour. |
568 | |
596 | |
569 | =item on_osc_seq_perl $term, $string |
597 | =item on_osc_seq_perl $term, $args, $resp |
570 | |
598 | |
571 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
599 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
572 | operating system command) is processed. Cursor position and other state |
600 | operating system command) is processed. Cursor position and other state |
573 | information is up-to-date when this happens. For interoperability, the |
601 | information is up-to-date when this happens. For interoperability, the |
574 | string should start with the extension name and a colon, to distinguish |
602 | string should start with the extension name (sans -osc) and a semicolon, |
575 | it from commands for other extensions, and this might be enforced in the |
603 | to distinguish it from commands for other extensions, and this might be |
576 | future. |
604 | enforced in the future. |
|
|
605 | |
|
|
606 | For example, C<overlay-osc> uses this: |
|
|
607 | |
|
|
608 | sub on_osc_seq_perl { |
|
|
609 | my ($self, $osc, $resp) = @_; |
|
|
610 | |
|
|
611 | return unless $osc =~ s/^overlay;//; |
|
|
612 | |
|
|
613 | ... process remaining $osc string |
|
|
614 | } |
577 | |
615 | |
578 | Be careful not ever to trust (in a security sense) the data you receive, |
616 | Be careful not ever to trust (in a security sense) the data you receive, |
579 | as its source can not easily be controlled (e-mail content, messages from |
617 | as its source can not easily be controlled (e-mail content, messages from |
580 | other users on the same system etc.). |
618 | other users on the same system etc.). |
|
|
619 | |
|
|
620 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
621 | sender. |
581 | |
622 | |
582 | =item on_add_lines $term, $string |
623 | =item on_add_lines $term, $string |
583 | |
624 | |
584 | Called whenever text is about to be output, with the text as argument. You |
625 | Called whenever text is about to be output, with the text as argument. You |
585 | can filter/change and output the text yourself by returning a true value |
626 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
590 | =item on_tt_write $term, $octets |
631 | =item on_tt_write $term, $octets |
591 | |
632 | |
592 | Called whenever some data is written to the tty/pty and can be used to |
633 | Called whenever some data is written to the tty/pty and can be used to |
593 | suppress or filter tty input. |
634 | suppress or filter tty input. |
594 | |
635 | |
|
|
636 | =item on_tt_paste $term, $octets |
|
|
637 | |
|
|
638 | Called whenever text is about to be pasted, with the text as argument. You |
|
|
639 | can filter/change and paste the text yourself by returning a true value |
|
|
640 | and calling C<< $term->tt_paste >> yourself. C<$octets> is |
|
|
641 | locale-encoded. |
|
|
642 | |
595 | =item on_line_update $term, $row |
643 | =item on_line_update $term, $row |
596 | |
644 | |
597 | Called whenever a line was updated or changed. Can be used to filter |
645 | Called whenever a line was updated or changed. Can be used to filter |
598 | screen output (e.g. underline urls or other useless stuff). Only lines |
646 | screen output (e.g. underline urls or other useless stuff). Only lines |
599 | that are being shown will be filtered, and, due to performance reasons, |
647 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
606 | later with the already-modified line (e.g. if unrelated parts change), so |
654 | later with the already-modified line (e.g. if unrelated parts change), so |
607 | you cannot just toggle rendition bits, but only set them. |
655 | you cannot just toggle rendition bits, but only set them. |
608 | |
656 | |
609 | =item on_refresh_begin $term |
657 | =item on_refresh_begin $term |
610 | |
658 | |
611 | Called just before the screen gets redrawn. Can be used for overlay |
659 | Called just before the screen gets redrawn. Can be used for overlay or |
612 | or similar effects by modify terminal contents in refresh_begin, and |
660 | similar effects by modifying the terminal contents in refresh_begin, and |
613 | restoring them in refresh_end. The built-in overlay and selection display |
661 | restoring them in refresh_end. The built-in overlay and selection display |
614 | code is run after this hook, and takes precedence. |
662 | code is run after this hook, and takes precedence. |
615 | |
663 | |
616 | =item on_refresh_end $term |
664 | =item on_refresh_end $term |
617 | |
665 | |
… | |
… | |
624 | resource in the @@RXVT_NAME@@(1) manpage). |
672 | resource in the @@RXVT_NAME@@(1) manpage). |
625 | |
673 | |
626 | The event is simply the action string. This interface is assumed to change |
674 | The event is simply the action string. This interface is assumed to change |
627 | slightly in the future. |
675 | slightly in the future. |
628 | |
676 | |
|
|
677 | =item on_register_command $term, $keysym, $modifiermask, $string |
|
|
678 | |
|
|
679 | Called after parsing a keysym resource but before registering the |
|
|
680 | associated binding. If this hook returns TRUE the binding is not |
|
|
681 | registered. It can be used to modify a binding by calling |
|
|
682 | C<register_command>. |
|
|
683 | |
629 | =item on_resize_all_windows $tern, $new_width, $new_height |
684 | =item on_resize_all_windows $term, $new_width, $new_height |
630 | |
685 | |
631 | Called just after the new window size has been calculated, but before |
686 | Called just after the new window size has been calculated, but before |
632 | windows are actually being resized or hints are being set. If this hook |
687 | windows are actually being resized or hints are being set. If this hook |
633 | returns TRUE, setting of the window hints is being skipped. |
688 | returns TRUE, setting of the window hints is being skipped. |
634 | |
689 | |
… | |
… | |
668 | |
723 | |
669 | =item on_map_notify $term, $event |
724 | =item on_map_notify $term, $event |
670 | |
725 | |
671 | =item on_unmap_notify $term, $event |
726 | =item on_unmap_notify $term, $event |
672 | |
727 | |
673 | Called whenever the corresponding X event is received for the terminal If |
728 | Called whenever the corresponding X event is received for the terminal. If |
674 | the hook returns true, then the even will be ignored by rxvt-unicode. |
729 | the hook returns true, then the event will be ignored by rxvt-unicode. |
675 | |
730 | |
676 | The event is a hash with most values as named by Xlib (see the XEvent |
731 | The event is a hash with most values as named by Xlib (see the XEvent |
677 | manpage), with the additional members C<row> and C<col>, which are the |
732 | manpage), with the additional members C<row> and C<col>, which are the |
678 | (real, not screen-based) row and column under the mouse cursor. |
733 | (real, not screen-based) row and column under the mouse cursor. |
679 | |
734 | |
… | |
… | |
688 | |
743 | |
689 | =item on_wm_delete_window $term, $event |
744 | =item on_wm_delete_window $term, $event |
690 | |
745 | |
691 | Called when various types of ClientMessage events are received (all with |
746 | Called when various types of ClientMessage events are received (all with |
692 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
747 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
748 | |
|
|
749 | =item on_bell $term |
|
|
750 | |
|
|
751 | Called on receipt of a bell character. |
693 | |
752 | |
694 | =back |
753 | =back |
695 | |
754 | |
696 | =cut |
755 | =cut |
697 | |
756 | |
… | |
… | |
703 | use Scalar::Util (); |
762 | use Scalar::Util (); |
704 | use List::Util (); |
763 | use List::Util (); |
705 | |
764 | |
706 | our $VERSION = 1; |
765 | our $VERSION = 1; |
707 | our $TERM; |
766 | our $TERM; |
708 | our @TERM_INIT; |
767 | our @TERM_INIT; # should go, prevents async I/O etc. |
709 | our @TERM_EXT; |
768 | our @TERM_EXT; # should go, prevents async I/O etc. |
710 | our @HOOKNAME; |
769 | our @HOOKNAME; |
711 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
770 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
712 | our %OPTION; |
771 | our %OPTION; |
713 | |
772 | |
714 | our $LIBDIR; |
773 | our $LIBDIR; |
… | |
… | |
762 | |
821 | |
763 | =over 4 |
822 | =over 4 |
764 | |
823 | |
765 | =item urxvt::fatal $errormessage |
824 | =item urxvt::fatal $errormessage |
766 | |
825 | |
767 | Fatally aborts execution with the given error message. Avoid at all |
826 | Fatally aborts execution with the given error message (which should |
768 | costs! The only time this is acceptable is when the terminal process |
827 | include a trailing newline). Avoid at all costs! The only time this |
769 | starts up. |
828 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
829 | terminal from starting up. |
770 | |
830 | |
771 | =item urxvt::warn $string |
831 | =item urxvt::warn $string |
772 | |
832 | |
773 | Calls C<rxvt_warn> with the given string which should not include a |
833 | Calls C<rxvt_warn> with the given string which should include a trailing |
774 | newline. The module also overwrites the C<warn> builtin with a function |
834 | newline. The module also overwrites the C<warn> builtin with a function |
775 | that calls this function. |
835 | that calls this function. |
776 | |
836 | |
777 | Using this function has the advantage that its output ends up in the |
837 | Using this function has the advantage that its output ends up in the |
778 | correct place, e.g. on stderr of the connecting urxvtc client. |
838 | correct place, e.g. on stderr of the connecting urxvtc client. |
… | |
… | |
782 | =item @terms = urxvt::termlist |
842 | =item @terms = urxvt::termlist |
783 | |
843 | |
784 | Returns all urxvt::term objects that exist in this process, regardless of |
844 | Returns all urxvt::term objects that exist in this process, regardless of |
785 | whether they are started, being destroyed etc., so be careful. Only term |
845 | whether they are started, being destroyed etc., so be careful. Only term |
786 | objects that have perl extensions attached will be returned (because there |
846 | objects that have perl extensions attached will be returned (because there |
787 | is no urxvt::term objet associated with others). |
847 | is no urxvt::term object associated with others). |
788 | |
848 | |
789 | =item $time = urxvt::NOW |
849 | =item $time = urxvt::NOW |
790 | |
850 | |
791 | Returns the "current time" (as per the event loop). |
851 | Returns the "current time" (as per the event loop). |
792 | |
852 | |
… | |
… | |
835 | |
895 | |
836 | =item $rend = urxvt::OVERLAY_RSTYLE |
896 | =item $rend = urxvt::OVERLAY_RSTYLE |
837 | |
897 | |
838 | Return the rendition mask used for overlays by default. |
898 | Return the rendition mask used for overlays by default. |
839 | |
899 | |
840 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
900 | =item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, |
|
|
901 | urxvt::RS_RVid, urxvt::RS_Uline |
841 | |
902 | |
842 | Return the bit that enabled bold, italic, blink, reverse-video and |
903 | Return the bit that enabled bold, italic, blink, reverse-video and |
843 | underline, respectively. To enable such a style, just logically OR it into |
904 | underline, respectively. To enable such a style, just logically OR it into |
844 | the bitset. |
905 | the bitset. |
845 | |
906 | |
… | |
… | |
882 | }; |
943 | }; |
883 | } |
944 | } |
884 | |
945 | |
885 | no warnings 'utf8'; |
946 | no warnings 'utf8'; |
886 | |
947 | |
|
|
948 | sub parse_resource { |
|
|
949 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
|
|
950 | |
|
|
951 | $term->scan_meta; |
|
|
952 | |
|
|
953 | my $r = $term->{meta}{resource}; |
|
|
954 | while (my ($pattern, $v) = each %$r) { |
|
|
955 | $name =~ y/-/./ if $isarg; |
|
|
956 | |
|
|
957 | if ( |
|
|
958 | $pattern =~ /\.$/ |
|
|
959 | ? $pattern eq substr $name, 0, length $pattern |
|
|
960 | : $pattern eq $name |
|
|
961 | ) { |
|
|
962 | $name = "$urxvt::RESCLASS.$name"; |
|
|
963 | |
|
|
964 | push @TERM_EXT, $v->[0]; |
|
|
965 | |
|
|
966 | if ($v->[1] eq "boolean") { |
|
|
967 | $term->put_option_db ($name, $flag ? "true" : "false"); |
|
|
968 | return 1; |
|
|
969 | } else { |
|
|
970 | $term->put_option_db ($name, $value); |
|
|
971 | return 1 + 2; |
|
|
972 | } |
|
|
973 | } |
|
|
974 | } |
|
|
975 | |
|
|
976 | 0 |
|
|
977 | } |
|
|
978 | |
|
|
979 | sub usage { |
|
|
980 | my ($term, $usage_type) = @_; |
|
|
981 | |
|
|
982 | $term->scan_meta; |
|
|
983 | |
|
|
984 | my $r = $term->{meta}{resource}; |
|
|
985 | |
|
|
986 | for my $pattern (sort keys %$r) { |
|
|
987 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
|
|
988 | |
|
|
989 | $desc .= " (-pe $ext)"; |
|
|
990 | |
|
|
991 | if ($usage_type == 1) { |
|
|
992 | $pattern =~ y/./-/; |
|
|
993 | $pattern =~ s/-$/-.../g; |
|
|
994 | |
|
|
995 | if ($type eq "boolean") { |
|
|
996 | urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc; |
|
|
997 | } else { |
|
|
998 | urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc; |
|
|
999 | } |
|
|
1000 | } else { |
|
|
1001 | $pattern =~ s/\.$/.*/g; |
|
|
1002 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
|
|
1003 | } |
|
|
1004 | } |
|
|
1005 | } |
|
|
1006 | |
887 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
1007 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
888 | |
1008 | |
889 | sub verbose { |
1009 | sub verbose { |
890 | my ($level, $msg) = @_; |
1010 | my ($level, $msg) = @_; |
891 | warn "$msg\n" if $level <= $verbosity; |
1011 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
927 | sub invoke { |
1047 | sub invoke { |
928 | local $TERM = shift; |
1048 | local $TERM = shift; |
929 | my $htype = shift; |
1049 | my $htype = shift; |
930 | |
1050 | |
931 | if ($htype == 0) { # INIT |
1051 | if ($htype == 0) { # INIT |
932 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
1052 | my @dirs = $TERM->perl_libdirs; |
933 | |
1053 | |
934 | my %ext_arg; |
1054 | my %ext_arg; |
935 | |
1055 | |
936 | { |
1056 | { |
937 | my @init = @TERM_INIT; |
1057 | my @init = @TERM_INIT; |
938 | @TERM_INIT = (); |
1058 | @TERM_INIT = (); |
… | |
… | |
1098 | =head2 The C<urxvt::anyevent> Class |
1218 | =head2 The C<urxvt::anyevent> Class |
1099 | |
1219 | |
1100 | The sole purpose of this class is to deliver an interface to the |
1220 | The sole purpose of this class is to deliver an interface to the |
1101 | C<AnyEvent> module - any module using it will work inside urxvt without |
1221 | C<AnyEvent> module - any module using it will work inside urxvt without |
1102 | further programming. The only exception is that you cannot wait on |
1222 | further programming. The only exception is that you cannot wait on |
1103 | condition variables, but non-blocking condvar use is ok. What this means |
1223 | condition variables, but non-blocking condvar use is ok. |
1104 | is that you cannot use blocking APIs, but the non-blocking variant should |
1224 | |
1105 | work. |
1225 | In practical terms this means is that you cannot use blocking APIs, but |
|
|
1226 | the non-blocking variant should work. |
1106 | |
1227 | |
1107 | =cut |
1228 | =cut |
1108 | |
1229 | |
1109 | our $VERSION = 1; |
1230 | our $VERSION = '5.23'; |
1110 | |
1231 | |
1111 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1232 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1112 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1233 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1113 | |
1234 | |
1114 | sub timer { |
1235 | sub timer { |
… | |
… | |
1116 | |
1237 | |
1117 | my $cb = $arg{cb}; |
1238 | my $cb = $arg{cb}; |
1118 | |
1239 | |
1119 | urxvt::timer |
1240 | urxvt::timer |
1120 | ->new |
1241 | ->new |
1121 | ->start (urxvt::NOW + $arg{after}) |
1242 | ->after ($arg{after}, $arg{interval}) |
1122 | ->cb (sub { |
1243 | ->cb ($arg{interval} ? $cb : sub { |
1123 | $_[0]->stop; # need to cancel manually |
1244 | $_[0]->stop; # need to cancel manually |
1124 | $cb->(); |
1245 | $cb->(); |
1125 | }) |
1246 | }) |
1126 | } |
1247 | } |
1127 | |
1248 | |
1128 | sub io { |
1249 | sub io { |
1129 | my ($class, %arg) = @_; |
1250 | my ($class, %arg) = @_; |
1130 | |
1251 | |
1131 | my $cb = $arg{cb}; |
1252 | my $cb = $arg{cb}; |
|
|
1253 | my $fd = fileno $arg{fh}; |
|
|
1254 | defined $fd or $fd = $arg{fh}; |
1132 | |
1255 | |
1133 | bless [$arg{fh}, urxvt::iow |
1256 | bless [$arg{fh}, urxvt::iow |
1134 | ->new |
1257 | ->new |
1135 | ->fd (fileno $arg{fh}) |
1258 | ->fd ($fd) |
1136 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1259 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1137 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1260 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1138 | ->start |
1261 | ->start |
1139 | ->cb (sub { |
1262 | ->cb ($cb) |
1140 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
1141 | . ($_[1] & 2 ? 'w' : '')); |
|
|
1142 | })], |
|
|
1143 | urxvt::anyevent:: |
1263 | ], urxvt::anyevent:: |
|
|
1264 | } |
|
|
1265 | |
|
|
1266 | sub idle { |
|
|
1267 | my ($class, %arg) = @_; |
|
|
1268 | |
|
|
1269 | my $cb = $arg{cb}; |
|
|
1270 | |
|
|
1271 | urxvt::iw |
|
|
1272 | ->new |
|
|
1273 | ->start |
|
|
1274 | ->cb ($cb) |
|
|
1275 | } |
|
|
1276 | |
|
|
1277 | sub child { |
|
|
1278 | my ($class, %arg) = @_; |
|
|
1279 | |
|
|
1280 | my $cb = $arg{cb}; |
|
|
1281 | |
|
|
1282 | urxvt::pw |
|
|
1283 | ->new |
|
|
1284 | ->start ($arg{pid}) |
|
|
1285 | ->cb (sub { |
|
|
1286 | $_[0]->stop; # need to cancel manually |
|
|
1287 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1288 | }) |
1144 | } |
1289 | } |
1145 | |
1290 | |
1146 | sub DESTROY { |
1291 | sub DESTROY { |
1147 | $_[0][1]->stop; |
1292 | $_[0][1]->stop; |
1148 | } |
1293 | } |
1149 | |
1294 | |
1150 | sub condvar { |
1295 | # only needed for AnyEvent < 6 compatibility |
1151 | bless \my $flag, urxvt::anyevent:: |
|
|
1152 | } |
|
|
1153 | |
|
|
1154 | sub broadcast { |
|
|
1155 | ${$_[0]}++; |
|
|
1156 | } |
|
|
1157 | |
|
|
1158 | sub wait { |
|
|
1159 | unless (${$_[0]}) { |
|
|
1160 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
|
|
1161 | } |
|
|
1162 | } |
|
|
1163 | |
|
|
1164 | sub one_event { |
1296 | sub one_event { |
1165 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1297 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1166 | } |
1298 | } |
1167 | |
1299 | |
1168 | package urxvt::term; |
1300 | package urxvt::term; |
… | |
… | |
1197 | $proxy->enable ($name => $ref); |
1329 | $proxy->enable ($name => $ref); |
1198 | } |
1330 | } |
1199 | } |
1331 | } |
1200 | } |
1332 | } |
1201 | |
1333 | |
|
|
1334 | sub perl_libdirs { |
|
|
1335 | map { split /:/ } |
|
|
1336 | $_[0]->resource ("perl_lib"), |
|
|
1337 | $ENV{URXVT_PERL_LIB}, |
|
|
1338 | "$ENV{HOME}/.urxvt/ext", |
|
|
1339 | "$LIBDIR/perl" |
|
|
1340 | } |
|
|
1341 | |
|
|
1342 | sub scan_meta { |
|
|
1343 | my ($self) = @_; |
|
|
1344 | my @libdirs = perl_libdirs $self; |
|
|
1345 | |
|
|
1346 | return if $self->{meta_libdirs} eq join "\x00", @libdirs; |
|
|
1347 | |
|
|
1348 | my %meta; |
|
|
1349 | |
|
|
1350 | $self->{meta_libdirs} = join "\x00", @libdirs; |
|
|
1351 | $self->{meta} = \%meta; |
|
|
1352 | |
|
|
1353 | for my $dir (reverse @libdirs) { |
|
|
1354 | opendir my $fh, $dir |
|
|
1355 | or next; |
|
|
1356 | for my $ext (readdir $fh) { |
|
|
1357 | $ext ne "." |
|
|
1358 | and $ext ne ".." |
|
|
1359 | and open my $fh, "<", "$dir/$ext" |
|
|
1360 | or next; |
|
|
1361 | |
|
|
1362 | while (<$fh>) { |
|
|
1363 | if (/^#:META:X_RESOURCE:(.*)/) { |
|
|
1364 | my ($pattern, $type, $desc) = split /:/, $1; |
|
|
1365 | $pattern =~ s/^%(?:\.|$)/$ext./g; # % in pattern == extension name |
|
|
1366 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
|
|
1367 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
|
|
1368 | } else { |
|
|
1369 | $meta{resource}{$pattern} = [$ext, $type, $desc]; |
|
|
1370 | } |
|
|
1371 | } elsif (/^\s*(?:#|$)/) { |
|
|
1372 | # skip other comments and empty lines |
|
|
1373 | } else { |
|
|
1374 | last; # stop parsing on first non-empty non-comment line |
|
|
1375 | } |
|
|
1376 | } |
|
|
1377 | } |
|
|
1378 | } |
|
|
1379 | } |
|
|
1380 | |
1202 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1381 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1203 | |
1382 | |
1204 | Creates a new terminal, very similar as if you had started it with system |
1383 | Creates a new terminal, very similar as if you had started it with system |
1205 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
1384 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
1206 | hash which defines the environment of the new terminal. |
1385 | hash which defines the environment of the new terminal. |
… | |
… | |
1260 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1439 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1261 | |
1440 | |
1262 | Here is a likely non-exhaustive list of option names, please see the |
1441 | Here is a likely non-exhaustive list of option names, please see the |
1263 | source file F</src/optinc.h> to see the actual list: |
1442 | source file F</src/optinc.h> to see the actual list: |
1264 | |
1443 | |
1265 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1444 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
1266 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1445 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1267 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1446 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1268 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
1447 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1269 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
1448 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1270 | transparent tripleclickwords utmpInhibit visualBell |
1449 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
|
|
1450 | urgentOnBell utmpInhibit visualBell |
1271 | |
1451 | |
1272 | =item $value = $term->resource ($name[, $newval]) |
1452 | =item $value = $term->resource ($name[, $newval]) |
1273 | |
1453 | |
1274 | Returns the current resource value associated with a given name and |
1454 | Returns the current resource value associated with a given name and |
1275 | optionally sets a new value. Setting values is most useful in the C<init> |
1455 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
1288 | |
1468 | |
1289 | Here is a likely non-exhaustive list of resource names, not all of which |
1469 | Here is a likely non-exhaustive list of resource names, not all of which |
1290 | are supported in every build, please see the source file F</src/rsinc.h> |
1470 | are supported in every build, please see the source file F</src/rsinc.h> |
1291 | to see the actual list: |
1471 | to see the actual list: |
1292 | |
1472 | |
1293 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1473 | answerbackstring backgroundPixmap backspace_key blendtype blurradius |
1294 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1474 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1295 | display_name embed ext_bwidth fade font geometry hold iconName |
1475 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1296 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1476 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
|
|
1477 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
1297 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1478 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1298 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1479 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1299 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1480 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1300 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1481 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1301 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1482 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1302 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1483 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1303 | secondaryScreen secondaryScroll selectstyle shade term_name title |
1484 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1304 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1485 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1305 | visualBell |
1486 | utmpInhibit visualBell |
1306 | |
1487 | |
1307 | =cut |
1488 | =cut |
1308 | |
1489 | |
1309 | sub resource($$;$) { |
1490 | sub resource($$;$) { |
1310 | my ($self, $name) = (shift, shift); |
1491 | my ($self, $name) = (shift, shift); |
1311 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1492 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1312 | &urxvt::term::_resource |
1493 | goto &urxvt::term::_resource |
1313 | } |
1494 | } |
1314 | |
1495 | |
1315 | =item $value = $term->x_resource ($pattern) |
1496 | =item $value = $term->x_resource ($pattern) |
1316 | |
1497 | |
1317 | Returns the X-Resource for the given pattern, excluding the program or |
1498 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
1321 | |
1502 | |
1322 | This method should only be called during the C<on_start> hook, as there is |
1503 | This method should only be called during the C<on_start> hook, as there is |
1323 | only one resource database per display, and later invocations might return |
1504 | only one resource database per display, and later invocations might return |
1324 | the wrong resources. |
1505 | the wrong resources. |
1325 | |
1506 | |
1326 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
1507 | =item $value = $term->x_resource_boolean ($pattern) |
1327 | |
1508 | |
|
|
1509 | Like C<x_resource>, above, but interprets the string value as a boolean |
|
|
1510 | and returns C<1> for true values, C<0> for false values and C<undef> if |
|
|
1511 | the resource or option isn't specified. |
|
|
1512 | |
|
|
1513 | You should always use this method to parse boolean resources. |
|
|
1514 | |
|
|
1515 | =cut |
|
|
1516 | |
|
|
1517 | sub x_resource_boolean { |
|
|
1518 | my $res = &x_resource; |
|
|
1519 | |
|
|
1520 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
|
|
1521 | } |
|
|
1522 | |
|
|
1523 | =item $success = $term->parse_keysym ($key, $octets) |
|
|
1524 | |
1328 | Adds a keymap translation exactly as specified via a resource. See the |
1525 | Adds a key binding exactly as specified via a resource. See the |
1329 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1526 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
|
|
1527 | |
|
|
1528 | =item $term->register_command ($keysym, $modifiermask, $string) |
|
|
1529 | |
|
|
1530 | Adds a key binding. This is a lower level api compared to |
|
|
1531 | C<parse_keysym>, as it expects a parsed key description, and can be |
|
|
1532 | used only inside either the C<on_init> hook, to add a binding, or the |
|
|
1533 | C<on_register_command> hook, to modify a parsed binding. |
1330 | |
1534 | |
1331 | =item $rend = $term->rstyle ([$new_rstyle]) |
1535 | =item $rend = $term->rstyle ([$new_rstyle]) |
1332 | |
1536 | |
1333 | Return and optionally change the current rendition. Text that is output by |
1537 | Return and optionally change the current rendition. Text that is output by |
1334 | the terminal application will use this style. |
1538 | the terminal application will use this style. |
… | |
… | |
1342 | |
1546 | |
1343 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1547 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1344 | |
1548 | |
1345 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1549 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1346 | |
1550 | |
1347 | Return the current values of the selection mark, begin or end positions, |
1551 | Return the current values of the selection mark, begin or end positions. |
1348 | and optionally set them to new values. |
1552 | |
|
|
1553 | When arguments are given, then the selection coordinates are set to |
|
|
1554 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1555 | screen. |
|
|
1556 | |
|
|
1557 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1558 | |
|
|
1559 | Returns the current selection screen, and then optionally sets it. |
1349 | |
1560 | |
1350 | =item $term->selection_make ($eventtime[, $rectangular]) |
1561 | =item $term->selection_make ($eventtime[, $rectangular]) |
1351 | |
1562 | |
1352 | Tries to make a selection as set by C<selection_beg> and |
1563 | Tries to make a selection as set by C<selection_beg> and |
1353 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1564 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1354 | rectangular selection will be made. This is the prefered function to make |
1565 | rectangular selection will be made. This is the preferred function to make |
1355 | a selection. |
1566 | a selection. |
1356 | |
1567 | |
1357 | =item $success = $term->selection_grab ($eventtime) |
1568 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
1358 | |
1569 | |
1359 | Try to request the primary selection text from the server (for example, as |
1570 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1571 | true) selection from the server. The corresponding text can be set |
1360 | set by the next method). No visual feedback will be given. This function |
1572 | with the next method. No visual feedback will be given. This function |
1361 | is mostly useful from within C<on_sel_grab> hooks. |
1573 | is mostly useful from within C<on_sel_grab> hooks. |
1362 | |
1574 | |
1363 | =item $oldtext = $term->selection ([$newtext]) |
1575 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
1364 | |
1576 | |
1365 | Return the current selection text and optionally replace it by C<$newtext>. |
1577 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1578 | and optionally replace it by C<$newtext>. |
|
|
1579 | |
|
|
1580 | =item $term->selection_clear ([$clipboard]) |
|
|
1581 | |
|
|
1582 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
1366 | |
1583 | |
1367 | =item $term->overlay_simple ($x, $y, $text) |
1584 | =item $term->overlay_simple ($x, $y, $text) |
1368 | |
1585 | |
1369 | Create a simple multi-line overlay box. See the next method for details. |
1586 | Create a simple multi-line overlay box. See the next method for details. |
1370 | |
1587 | |
… | |
… | |
1400 | |
1617 | |
1401 | The methods currently supported on C<urxvt::overlay> objects are: |
1618 | The methods currently supported on C<urxvt::overlay> objects are: |
1402 | |
1619 | |
1403 | =over 4 |
1620 | =over 4 |
1404 | |
1621 | |
1405 | =item $overlay->set ($x, $y, $text, $rend) |
1622 | =item $overlay->set ($x, $y, $text[, $rend]) |
1406 | |
1623 | |
1407 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1624 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1408 | text in rxvt-unicode's special encoding and an array of rendition values |
1625 | text in rxvt-unicode's special encoding and an array of rendition values |
1409 | at a specific position inside the overlay. |
1626 | at a specific position inside the overlay. |
|
|
1627 | |
|
|
1628 | If C<$rend> is missing, then the rendition will not be changed. |
1410 | |
1629 | |
1411 | =item $overlay->hide |
1630 | =item $overlay->hide |
1412 | |
1631 | |
1413 | If visible, hide the overlay, but do not destroy it. |
1632 | If visible, hide the overlay, but do not destroy it. |
1414 | |
1633 | |
… | |
… | |
1496 | locale-specific encoding of the terminal and can contain command sequences |
1715 | locale-specific encoding of the terminal and can contain command sequences |
1497 | (escape codes) that will be interpreted. |
1716 | (escape codes) that will be interpreted. |
1498 | |
1717 | |
1499 | =item $term->tt_write ($octets) |
1718 | =item $term->tt_write ($octets) |
1500 | |
1719 | |
1501 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1720 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1502 | pass characters instead of octets, you should convert your strings first |
1721 | pass characters instead of octets, you should convert your strings first |
1503 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1722 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1723 | |
|
|
1724 | =item $term->tt_paste ($octets) |
|
|
1725 | |
|
|
1726 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1727 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1728 | is set. |
1504 | |
1729 | |
1505 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1730 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1506 | |
1731 | |
1507 | Replaces the event mask of the pty watcher by the given event mask. Can |
1732 | Replaces the event mask of the pty watcher by the given event mask. Can |
1508 | be used to suppress input and output handling to the pty/tty. See the |
1733 | be used to suppress input and output handling to the pty/tty. See the |
… | |
… | |
1527 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1752 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1528 | to receive pointer events all the times: |
1753 | to receive pointer events all the times: |
1529 | |
1754 | |
1530 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1755 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1531 | |
1756 | |
|
|
1757 | =item $term->set_urgency ($set) |
|
|
1758 | |
|
|
1759 | Enable/disable the urgency hint on the toplevel window. |
|
|
1760 | |
1532 | =item $term->focus_in |
1761 | =item $term->focus_in |
1533 | |
1762 | |
1534 | =item $term->focus_out |
1763 | =item $term->focus_out |
1535 | |
1764 | |
1536 | =item $term->key_press ($state, $keycode[, $time]) |
1765 | =item $term->key_press ($state, $keycode[, $time]) |
… | |
… | |
1624 | |
1853 | |
1625 | Used after changing terminal contents to display them. |
1854 | Used after changing terminal contents to display them. |
1626 | |
1855 | |
1627 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1856 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1628 | |
1857 | |
1629 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1858 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1630 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1859 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1631 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1632 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1860 | terminal line. Nothing will be returned if a nonexistent line |
1633 | is requested. |
1861 | is requested. |
1634 | |
1862 | |
1635 | If C<$new_text> is specified, it will replace characters in the current |
1863 | If C<$new_text> is specified, it will replace characters in the current |
1636 | line, starting at column C<$start_col> (default C<0>), which is useful |
1864 | line, starting at column C<$start_col> (default C<0>), which is useful |
1637 | to replace only parts of a line. The font index in the rendition will |
1865 | to replace only parts of a line. The font index in the rendition will |
1638 | automatically be updated. |
1866 | automatically be updated. |
1639 | |
1867 | |
1640 | C<$text> is in a special encoding: tabs and wide characters that use more |
1868 | C<$text> is in a special encoding: tabs and wide characters that use more |
1641 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1869 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1642 | characters. Characters with combining characters and other characters that |
1870 | characters. Characters with combining characters and other characters that |
1643 | do not fit into the normal tetx encoding will be replaced with characters |
1871 | do not fit into the normal text encoding will be replaced with characters |
1644 | in the private use area. |
1872 | in the private use area. |
1645 | |
1873 | |
1646 | You have to obey this encoding when changing text. The advantage is |
1874 | You have to obey this encoding when changing text. The advantage is |
1647 | that C<substr> and similar functions work on screen cells and not on |
1875 | that C<substr> and similar functions work on screen cells and not on |
1648 | characters. |
1876 | characters. |
… | |
… | |
1823 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
2051 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1824 | recent grab. |
2052 | recent grab. |
1825 | |
2053 | |
1826 | =item $term->ungrab |
2054 | =item $term->ungrab |
1827 | |
2055 | |
1828 | Calls XUngrab for the most recent grab. Is called automatically on |
2056 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
1829 | evaluation errors, as it is better to lose the grab in the error case as |
2057 | evaluation errors, as it is better to lose the grab in the error case as |
1830 | the session. |
2058 | the session. |
1831 | |
2059 | |
1832 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
2060 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1833 | |
2061 | |
… | |
… | |
1835 | |
2063 | |
1836 | =item @atoms = $term->XListProperties ($window) |
2064 | =item @atoms = $term->XListProperties ($window) |
1837 | |
2065 | |
1838 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
2066 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1839 | |
2067 | |
1840 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
2068 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
1841 | |
2069 | |
1842 | =item $term->XDeleteProperty ($window, $property) |
2070 | =item $term->XDeleteProperty ($window, $property) |
1843 | |
2071 | |
1844 | =item $window = $term->DefaultRootWindow |
2072 | =item $window = $term->DefaultRootWindow |
1845 | |
2073 | |
… | |
… | |
1852 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
2080 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
1853 | |
2081 | |
1854 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
2082 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1855 | |
2083 | |
1856 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
2084 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
2085 | |
|
|
2086 | =item $keysym = $term->XStringToKeysym ($string) |
|
|
2087 | |
|
|
2088 | =item $string = $term->XKeysymToString ($keysym) |
1857 | |
2089 | |
1858 | Various X or X-related functions. The C<$term> object only serves as |
2090 | Various X or X-related functions. The C<$term> object only serves as |
1859 | the source of the display, otherwise those functions map more-or-less |
2091 | the source of the display, otherwise those functions map more-or-less |
1860 | directory onto the X functions of the same name. |
2092 | directly onto the X functions of the same name. |
1861 | |
2093 | |
1862 | =back |
2094 | =back |
1863 | |
2095 | |
1864 | =cut |
2096 | =cut |
1865 | |
2097 | |
… | |
… | |
1967 | my $env = $self->{term}->env; |
2199 | my $env = $self->{term}->env; |
1968 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
2200 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1969 | delete $env->{LC_ALL}; |
2201 | delete $env->{LC_ALL}; |
1970 | $env->{LC_CTYPE} = $self->{term}->locale; |
2202 | $env->{LC_CTYPE} = $self->{term}->locale; |
1971 | |
2203 | |
1972 | urxvt::term->new ($env, "popup", |
2204 | my $term = urxvt::term->new ( |
|
|
2205 | $env, "popup", |
1973 | "--perl-lib" => "", "--perl-ext-common" => "", |
2206 | "--perl-lib" => "", "--perl-ext-common" => "", |
1974 | "-pty-fd" => -1, "-sl" => 0, |
2207 | "-pty-fd" => -1, "-sl" => 0, |
1975 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
2208 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1976 | "--transient-for" => $self->{term}->parent, |
2209 | "--transient-for" => $self->{term}->parent, |
1977 | "-display" => $self->{term}->display_id, |
2210 | "-display" => $self->{term}->display_id, |
1978 | "-pe" => "urxvt-popup") |
2211 | "-pe" => "urxvt-popup", |
1979 | or die "unable to create popup window\n"; |
2212 | ) or die "unable to create popup window\n"; |
|
|
2213 | |
|
|
2214 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
2215 | $term->ungrab; |
|
|
2216 | $term->destroy; |
|
|
2217 | die "unable to initialise popup window\n"; |
|
|
2218 | } |
1980 | } |
2219 | } |
1981 | |
2220 | |
1982 | sub DESTROY { |
2221 | sub DESTROY { |
1983 | my ($self) = @_; |
2222 | my ($self) = @_; |
1984 | |
2223 | |
… | |
… | |
2002 | ->new |
2241 | ->new |
2003 | ->interval (1) |
2242 | ->interval (1) |
2004 | ->cb (sub { |
2243 | ->cb (sub { |
2005 | $term->{overlay}->set (0, 0, |
2244 | $term->{overlay}->set (0, 0, |
2006 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2245 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2007 | }); |
2246 | }); |
2008 | |
2247 | |
2009 | =over 4 |
2248 | =over 4 |
2010 | |
2249 | |
2011 | =item $timer = new urxvt::timer |
2250 | =item $timer = new urxvt::timer |
2012 | |
2251 | |
… | |
… | |
2015 | |
2254 | |
2016 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2255 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2017 | |
2256 | |
2018 | Set the callback to be called when the timer triggers. |
2257 | Set the callback to be called when the timer triggers. |
2019 | |
2258 | |
2020 | =item $tstamp = $timer->at |
|
|
2021 | |
|
|
2022 | Return the time this watcher will fire next. |
|
|
2023 | |
|
|
2024 | =item $timer = $timer->set ($tstamp) |
2259 | =item $timer = $timer->set ($tstamp[, $interval]) |
2025 | |
2260 | |
2026 | Set the time the event is generated to $tstamp. |
2261 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2262 | new $interval). |
2027 | |
2263 | |
2028 | =item $timer = $timer->interval ($interval) |
2264 | =item $timer = $timer->interval ($interval) |
2029 | |
2265 | |
2030 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2266 | By default (and when C<$interval> is C<0>), the timer will automatically |
2031 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2267 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2032 | is automatically rescheduled at the given intervals. |
2268 | is automatically rescheduled at the given intervals. |
2033 | |
2269 | |
2034 | =item $timer = $timer->start |
2270 | =item $timer = $timer->start |
2035 | |
2271 | |
2036 | Start the timer. |
2272 | Start the timer. |
2037 | |
2273 | |
2038 | =item $timer = $timer->start ($tstamp) |
2274 | =item $timer = $timer->start ($tstamp[, $interval]) |
2039 | |
2275 | |
2040 | Set the event trigger time to C<$tstamp> and start the timer. |
2276 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2277 | also replaces the interval. |
2041 | |
2278 | |
2042 | =item $timer = $timer->after ($delay) |
2279 | =item $timer = $timer->after ($delay[, $interval]) |
2043 | |
2280 | |
2044 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2281 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2045 | |
2282 | |
2046 | =item $timer = $timer->stop |
2283 | =item $timer = $timer->stop |
2047 | |
2284 | |
… | |
… | |
2055 | |
2292 | |
2056 | $term->{socket} = ... |
2293 | $term->{socket} = ... |
2057 | $term->{iow} = urxvt::iow |
2294 | $term->{iow} = urxvt::iow |
2058 | ->new |
2295 | ->new |
2059 | ->fd (fileno $term->{socket}) |
2296 | ->fd (fileno $term->{socket}) |
2060 | ->events (urxvt::EVENT_READ) |
2297 | ->events (urxvt::EV_READ) |
2061 | ->start |
2298 | ->start |
2062 | ->cb (sub { |
2299 | ->cb (sub { |
2063 | my ($iow, $revents) = @_; |
2300 | my ($iow, $revents) = @_; |
2064 | # $revents must be 1 here, no need to check |
2301 | # $revents must be 1 here, no need to check |
2065 | sysread $term->{socket}, my $buf, 8192 |
2302 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
2083 | Set the file descriptor (not handle) to watch. |
2320 | Set the file descriptor (not handle) to watch. |
2084 | |
2321 | |
2085 | =item $iow = $iow->events ($eventmask) |
2322 | =item $iow = $iow->events ($eventmask) |
2086 | |
2323 | |
2087 | Set the event mask to watch. The only allowed values are |
2324 | Set the event mask to watch. The only allowed values are |
2088 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2325 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
2089 | together, or C<urxvt::EVENT_NONE>. |
2326 | together, or C<urxvt::EV_NONE>. |
2090 | |
2327 | |
2091 | =item $iow = $iow->start |
2328 | =item $iow = $iow->start |
2092 | |
2329 | |
2093 | Start watching for requested events on the given handle. |
2330 | Start watching for requested events on the given handle. |
2094 | |
2331 | |
… | |
… | |
2135 | ->new |
2372 | ->new |
2136 | ->start ($pid) |
2373 | ->start ($pid) |
2137 | ->cb (sub { |
2374 | ->cb (sub { |
2138 | my ($pw, $exit_status) = @_; |
2375 | my ($pw, $exit_status) = @_; |
2139 | ... |
2376 | ... |
2140 | }); |
2377 | }); |
2141 | |
2378 | |
2142 | =over 4 |
2379 | =over 4 |
2143 | |
2380 | |
2144 | =item $pw = new urxvt::pw |
2381 | =item $pw = new urxvt::pw |
2145 | |
2382 | |
… | |
… | |
2178 | |
2415 | |
2179 | =back |
2416 | =back |
2180 | |
2417 | |
2181 | =head1 AUTHOR |
2418 | =head1 AUTHOR |
2182 | |
2419 | |
2183 | Marc Lehmann <pcg@goof.com> |
2420 | Marc Lehmann <schmorp@schmorp.de> |
2184 | http://software.schmorp.de/pkg/rxvt-unicode |
2421 | http://software.schmorp.de/pkg/rxvt-unicode |
2185 | |
2422 | |
2186 | =cut |
2423 | =cut |
2187 | |
2424 | |
2188 | 1 |
2425 | 1 |