… | |
… | |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Everytime a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
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 | |
|
|
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
|
|
32 | and "perl-ext-common" resources to the empty string. |
30 | |
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/>. |
… | |
… | |
62 | URxvt.selection.pattern-1: perl-regex |
65 | URxvt.selection.pattern-1: perl-regex |
63 | ... |
66 | ... |
64 | |
67 | |
65 | The index number (0, 1...) must not have any holes, and each regex must |
68 | The index number (0, 1...) must not have any holes, and each regex must |
66 | contain at least one pair of capturing parentheses, which will be used for |
69 | contain at least one pair of capturing parentheses, which will be used for |
67 | the match. For example, the followign adds a regex that matches everything |
70 | the match. For example, the following adds a regex that matches everything |
68 | between two vertical bars: |
71 | between two vertical bars: |
69 | |
72 | |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
73 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
71 | |
74 | |
72 | Another example: Programs I use often output "absolute path: " at the |
75 | Another example: Programs I use often output "absolute path: " at the |
… | |
… | |
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 | It's sole argument is the popup menu, which can be modified. The selection |
127 | is in C<$_>, which can be used to decide wether 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 |
… | |
… | |
220 | the message into vi commands to load the file. |
223 | the message into vi commands to load the file. |
221 | |
224 | |
222 | =item tabbed |
225 | =item tabbed |
223 | |
226 | |
224 | This transforms the terminal into a tabbar with additional terminals, that |
227 | This transforms the terminal into a tabbar with additional terminals, that |
225 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
228 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
226 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
229 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
227 | button per tab. |
230 | button per tab. |
228 | |
231 | |
229 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
232 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
230 | B<Shift-Right> will switch to the tab left or right of the current one, |
233 | B<Shift-Right> will switch to the tab left or right of the current one, |
… | |
… | |
240 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
243 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
241 | |
244 | |
242 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
245 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
243 | indices. |
246 | indices. |
244 | |
247 | |
245 | =item mark-urls |
248 | =item matcher |
246 | |
249 | |
247 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
250 | Uses per-line display filtering (C<on_line_update>) to underline text |
248 | make them clickable. When middle-clicked, the program specified in the |
251 | matching a certain pattern and make it clickable. When clicked with the |
249 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
252 | mouse button specified in the C<matcher.button> resource (default 2, or |
250 | the URL as first argument. |
253 | middle), the program specified in the C<matcher.launcher> resource |
|
|
254 | (default, the C<urlLauncher> resource, C<sensible-browser>) will be started |
|
|
255 | with the matched text as first argument. The default configuration is |
|
|
256 | suitable for matching URLs and launching a web browser, like the |
|
|
257 | former "mark-urls" extension. |
|
|
258 | |
|
|
259 | The default pattern to match URLs can be overridden with the |
|
|
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
|
|
261 | with numbered patterns, in a manner similar to the "selection" extension. |
|
|
262 | The launcher can also be overridden on a per-pattern basis. |
|
|
263 | |
|
|
264 | Example configuration: |
|
|
265 | |
|
|
266 | URxvt.perl-ext: default,matcher |
|
|
267 | URxvt.urlLauncher: sensible-browser |
|
|
268 | URxvt.keysym.C-Delete: perl:matcher |
|
|
269 | URxvt.matcher.button: 1 |
|
|
270 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
271 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
272 | URxvt.matcher.launcher.2: gvim +$2 $1 |
251 | |
273 | |
252 | =item xim-onthespot |
274 | =item xim-onthespot |
253 | |
275 | |
254 | This (experimental) perl extension implements OnTheSpot editing. It does |
276 | This (experimental) perl extension implements OnTheSpot editing. It does |
255 | not work perfectly, and some input methods don't seem to work well with |
277 | not work perfectly, and some input methods don't seem to work well with |
… | |
… | |
259 | You enable it by specifying this extension and a preedit style of |
281 | You enable it by specifying this extension and a preedit style of |
260 | C<OnTheSpot>, i.e.: |
282 | C<OnTheSpot>, i.e.: |
261 | |
283 | |
262 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
284 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
263 | |
285 | |
|
|
286 | =item kuake<hotkey> |
|
|
287 | |
|
|
288 | A very primitive quake-console-like extension. It was inspired by a |
|
|
289 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
290 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
291 | will show or hide itself. Another press of the accelerator key will hide |
|
|
292 | or show it again. |
|
|
293 | |
|
|
294 | Initially, the window will not be shown when using this extension. |
|
|
295 | |
|
|
296 | This is useful if you need a single terminal thats not using any desktop |
|
|
297 | space most of the time but is quickly available at the press of a key. |
|
|
298 | |
|
|
299 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
300 | extension will actually grab a physical key just for this function. |
|
|
301 | |
|
|
302 | If you want a quake-like animation, tell your window manager to do so |
|
|
303 | (fvwm can do it). |
|
|
304 | |
264 | =item automove-background |
305 | =item automove-background |
265 | |
306 | |
266 | This is basically a very small extension that dynamically changes the |
307 | This is basically a very small extension that dynamically changes the |
267 | background pixmap offset to the window position, in effect creating the |
308 | background pixmap offset to the window position, in effect creating the |
268 | same effect as pseudo transparency with a custom pixmap. No scaling is |
309 | same effect as pseudo transparency with a custom pixmap. No scaling is |
269 | supported in this mode. Exmaple: |
310 | supported in this mode. Example: |
270 | |
311 | |
271 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
312 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
313 | |
|
|
314 | L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions> |
|
|
315 | shows how this extension can be used to implement an automatically blurred |
|
|
316 | transparent background. |
272 | |
317 | |
273 | =item block-graphics-to-ascii |
318 | =item block-graphics-to-ascii |
274 | |
319 | |
275 | A not very useful example of filtering all text output to the terminal |
320 | A not very useful example of filtering all text output to the terminal |
276 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
321 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
… | |
… | |
326 | After a successful upload the selection will be replaced by the text given |
371 | After a successful upload the selection will be replaced by the text given |
327 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
372 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
328 | for the filename): |
373 | for the filename): |
329 | |
374 | |
330 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
375 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
376 | |
|
|
377 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
378 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
379 | which works regardless of wether xrdb is used to parse the resource file |
|
|
380 | or not. |
331 | |
381 | |
332 | =item example-refresh-hooks |
382 | =item example-refresh-hooks |
333 | |
383 | |
334 | Displays a very simple digital clock in the upper right corner of the |
384 | Displays a very simple digital clock in the upper right corner of the |
335 | window. Illustrates overwriting the refresh callbacks to create your own |
385 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
376 | =back |
426 | =back |
377 | |
427 | |
378 | =head2 Extension Objects |
428 | =head2 Extension Objects |
379 | |
429 | |
380 | Every perl extension is a perl class. A separate perl object is created |
430 | Every perl extension is a perl class. A separate perl object is created |
381 | for each terminal and each extension and passed as the first parameter to |
431 | for each terminal, and each terminal has its own set of extenion objects, |
382 | hooks. So extensions can use their C<$self> object without having to think |
432 | which are passed as the first parameter to hooks. So extensions can use |
383 | about other extensions, with the exception of methods and members that |
433 | their C<$self> object without having to think about clashes with other |
|
|
434 | extensions or other terminals, with the exception of methods and members |
384 | begin with an underscore character C<_>: these are reserved for internal |
435 | that begin with an underscore character C<_>: these are reserved for |
385 | use. |
436 | internal use. |
386 | |
437 | |
387 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
438 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
388 | C<urxvt::term> class on this object. |
439 | C<urxvt::term> class on this object. |
389 | |
440 | |
390 | It has the following methods and data members: |
441 | It has the following methods and data members: |
… | |
… | |
411 | =head2 Hooks |
462 | =head2 Hooks |
412 | |
463 | |
413 | The following subroutines can be declared in extension files, and will be |
464 | The following subroutines can be declared in extension files, and will be |
414 | called whenever the relevant event happens. |
465 | called whenever the relevant event happens. |
415 | |
466 | |
416 | The first argument passed to them is an extension oject as described in |
467 | The first argument passed to them is an extension object as described in |
417 | the in the C<Extension Objects> section. |
468 | the in the C<Extension Objects> section. |
418 | |
469 | |
419 | B<All> of these hooks must return a boolean value. If any of the called |
470 | B<All> of these hooks must return a boolean value. If any of the called |
420 | hooks returns true, then the event counts as being I<consumed>, and the |
471 | hooks returns true, then the event counts as being I<consumed>, and the |
421 | relevant action might not be carried out by the C++ code. |
472 | relevant action might not be carried out by the C++ code. |
… | |
… | |
434 | place. |
485 | place. |
435 | |
486 | |
436 | =item on_start $term |
487 | =item on_start $term |
437 | |
488 | |
438 | Called at the very end of initialisation of a new terminal, just before |
489 | Called at the very end of initialisation of a new terminal, just before |
439 | trying to map (display) the toplevel and returning to the mainloop. |
490 | trying to map (display) the toplevel and returning to the main loop. |
440 | |
491 | |
441 | =item on_destroy $term |
492 | =item on_destroy $term |
442 | |
493 | |
443 | Called whenever something tries to destroy terminal, when the terminal is |
494 | Called whenever something tries to destroy terminal, when the terminal is |
444 | still fully functional (not for long, though). |
495 | still fully functional (not for long, though). |
… | |
… | |
471 | |
522 | |
472 | Called whenever a selection has been copied, but before the selection is |
523 | Called whenever a selection has been copied, but before the selection is |
473 | requested from the server. The selection text can be queried and changed |
524 | requested from the server. The selection text can be queried and changed |
474 | by calling C<< $term->selection >>. |
525 | by calling C<< $term->selection >>. |
475 | |
526 | |
476 | Returning a true value aborts selection grabbing. It will still be hilighted. |
527 | Returning a true value aborts selection grabbing. It will still be highlighted. |
477 | |
528 | |
478 | =item on_sel_extend $term |
529 | =item on_sel_extend $term |
479 | |
530 | |
480 | Called whenever the user tries to extend the selection (e.g. with a double |
531 | Called whenever the user tries to extend the selection (e.g. with a double |
481 | click) and is either supposed to return false (normal operation), or |
532 | click) and is either supposed to return false (normal operation), or |
482 | should extend the selection itelf and return true to suppress the built-in |
533 | should extend the selection itself and return true to suppress the built-in |
483 | processing. This can happen multiple times, as long as the callback |
534 | processing. This can happen multiple times, as long as the callback |
484 | returns true, it will be called on every further click by the user and is |
535 | returns true, it will be called on every further click by the user and is |
485 | supposed to enlarge the selection more and more, if possible. |
536 | supposed to enlarge the selection more and more, if possible. |
486 | |
537 | |
487 | See the F<selection> example extension. |
538 | See the F<selection> example extension. |
488 | |
539 | |
489 | =item on_view_change $term, $offset |
540 | =item on_view_change $term, $offset |
490 | |
541 | |
491 | Called whenever the view offset changes, i..e the user or program |
542 | Called whenever the view offset changes, i.e. the user or program |
492 | scrolls. Offset C<0> means display the normal terminal, positive values |
543 | scrolls. Offset C<0> means display the normal terminal, positive values |
493 | show this many lines of scrollback. |
544 | show this many lines of scrollback. |
494 | |
545 | |
495 | =item on_scroll_back $term, $lines, $saved |
546 | =item on_scroll_back $term, $lines, $saved |
496 | |
547 | |
… | |
… | |
520 | string should start with the extension name and a colon, to distinguish |
571 | string should start with the extension name and a colon, to distinguish |
521 | it from commands for other extensions, and this might be enforced in the |
572 | it from commands for other extensions, and this might be enforced in the |
522 | future. |
573 | future. |
523 | |
574 | |
524 | Be careful not ever to trust (in a security sense) the data you receive, |
575 | Be careful not ever to trust (in a security sense) the data you receive, |
525 | as its source can not easily be controleld (e-mail content, messages from |
576 | as its source can not easily be controlled (e-mail content, messages from |
526 | other users on the same system etc.). |
577 | other users on the same system etc.). |
527 | |
578 | |
528 | =item on_add_lines $term, $string |
579 | =item on_add_lines $term, $string |
529 | |
580 | |
530 | Called whenever text is about to be output, with the text as argument. You |
581 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
563 | |
614 | |
564 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
615 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
565 | |
616 | |
566 | =item on_user_command $term, $string |
617 | =item on_user_command $term, $string |
567 | |
618 | |
568 | Called whenever the a user-configured event is being activated (e.g. via |
619 | Called whenever a user-configured event is being activated (e.g. via |
569 | a C<perl:string> action bound to a key, see description of the B<keysym> |
620 | a C<perl:string> action bound to a key, see description of the B<keysym> |
570 | resource in the @@RXVT_NAME@@(1) manpage). |
621 | resource in the @@RXVT_NAME@@(1) manpage). |
571 | |
622 | |
572 | The event is simply the action string. This interface is assumed to change |
623 | The event is simply the action string. This interface is assumed to change |
573 | slightly in the future. |
624 | slightly in the future. |
574 | |
625 | |
575 | =item on_resize_all_windows $tern, $new_width, $new_height |
626 | =item on_resize_all_windows $tern, $new_width, $new_height |
576 | |
627 | |
577 | Called just after the new window size has been calculcated, but before |
628 | Called just after the new window size has been calculated, but before |
578 | windows are actually being resized or hints are being set. If this hook |
629 | windows are actually being resized or hints are being set. If this hook |
579 | returns TRUE, setting of the window hints is being skipped. |
630 | returns TRUE, setting of the window hints is being skipped. |
580 | |
631 | |
581 | =item on_x_event $term, $event |
632 | =item on_x_event $term, $event |
582 | |
633 | |
583 | Called on every X event received on the vt window (and possibly other |
634 | Called on every X event received on the vt window (and possibly other |
584 | windows). Should only be used as a last resort. Most event structure |
635 | windows). Should only be used as a last resort. Most event structure |
585 | members are not passed. |
636 | members are not passed. |
586 | |
637 | |
|
|
638 | =item on_root_event $term, $event |
|
|
639 | |
|
|
640 | Like C<on_x_event>, but is called for events on the root window. |
|
|
641 | |
587 | =item on_focus_in $term |
642 | =item on_focus_in $term |
588 | |
643 | |
589 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
644 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
590 | does focus in processing. |
645 | does focus in processing. |
591 | |
646 | |
592 | =item on_focus_out $term |
647 | =item on_focus_out $term |
593 | |
648 | |
594 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
649 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
595 | focus out processing. |
650 | focus out processing. |
596 | |
651 | |
597 | =item on_configure_notify $term, $event |
652 | =item on_configure_notify $term, $event |
598 | |
653 | |
599 | =item on_property_notify $term, $event |
654 | =item on_property_notify $term, $event |
… | |
… | |
682 | The current terminal. This variable stores the current C<urxvt::term> |
737 | The current terminal. This variable stores the current C<urxvt::term> |
683 | object, whenever a callback/hook is executing. |
738 | object, whenever a callback/hook is executing. |
684 | |
739 | |
685 | =item @urxvt::TERM_INIT |
740 | =item @urxvt::TERM_INIT |
686 | |
741 | |
687 | All coderefs in this array will be called as methods of the next newly |
742 | All code references in this array will be called as methods of the next newly |
688 | created C<urxvt::term> object (during the C<on_init> phase). The array |
743 | created C<urxvt::term> object (during the C<on_init> phase). The array |
689 | gets cleared before the codereferences that were in it are being executed, |
744 | gets cleared before the code references that were in it are being executed, |
690 | so coderefs can push themselves onto it again if they so desire. |
745 | so references can push themselves onto it again if they so desire. |
691 | |
746 | |
692 | This complements to the perl-eval commandline option, but gets executed |
747 | This complements to the perl-eval command line option, but gets executed |
693 | first. |
748 | first. |
694 | |
749 | |
695 | =item @urxvt::TERM_EXT |
750 | =item @urxvt::TERM_EXT |
696 | |
751 | |
697 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
752 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
722 | Messages have a size limit of 1023 bytes currently. |
777 | Messages have a size limit of 1023 bytes currently. |
723 | |
778 | |
724 | =item @terms = urxvt::termlist |
779 | =item @terms = urxvt::termlist |
725 | |
780 | |
726 | Returns all urxvt::term objects that exist in this process, regardless of |
781 | Returns all urxvt::term objects that exist in this process, regardless of |
727 | wether they are started, being destroyed etc., so be careful. Only term |
782 | whether they are started, being destroyed etc., so be careful. Only term |
728 | objects that have perl extensions attached will be returned (because there |
783 | objects that have perl extensions attached will be returned (because there |
729 | is no urxvt::term objet associated with others). |
784 | is no urxvt::term objet associated with others). |
730 | |
785 | |
731 | =item $time = urxvt::NOW |
786 | =item $time = urxvt::NOW |
732 | |
787 | |
… | |
… | |
943 | |
998 | |
944 | sub SET_COLOR($$$) { |
999 | sub SET_COLOR($$$) { |
945 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
1000 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
946 | } |
1001 | } |
947 | |
1002 | |
|
|
1003 | sub rend2mask { |
|
|
1004 | no strict 'refs'; |
|
|
1005 | my ($str, $mask) = (@_, 0); |
|
|
1006 | my %color = ( fg => undef, bg => undef ); |
|
|
1007 | my @failed; |
|
|
1008 | for my $spec ( split /\s+/, $str ) { |
|
|
1009 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1010 | $color{lc($1)} = $2; |
|
|
1011 | } else { |
|
|
1012 | my $neg = $spec =~ s/^[-^]//; |
|
|
1013 | unless ( exists &{"RS_$spec"} ) { |
|
|
1014 | push @failed, $spec; |
|
|
1015 | next; |
|
|
1016 | } |
|
|
1017 | my $cur = &{"RS_$spec"}; |
|
|
1018 | if ( $neg ) { |
|
|
1019 | $mask &= ~$cur; |
|
|
1020 | } else { |
|
|
1021 | $mask |= $cur; |
|
|
1022 | } |
|
|
1023 | } |
|
|
1024 | } |
|
|
1025 | ($mask, @color{qw(fg bg)}, \@failed) |
|
|
1026 | } |
|
|
1027 | |
948 | # urxvt::term::extension |
1028 | # urxvt::term::extension |
949 | |
1029 | |
950 | package urxvt::term::extension; |
1030 | package urxvt::term::extension; |
951 | |
1031 | |
952 | sub enable { |
1032 | sub enable { |
… | |
… | |
1063 | sub DESTROY { |
1143 | sub DESTROY { |
1064 | $_[0][1]->stop; |
1144 | $_[0][1]->stop; |
1065 | } |
1145 | } |
1066 | |
1146 | |
1067 | sub condvar { |
1147 | sub condvar { |
1068 | bless \my $flag, urxvt::anyevent::condvar:: |
1148 | bless \my $flag, urxvt::anyevent:: |
1069 | } |
1149 | } |
1070 | |
1150 | |
1071 | sub urxvt::anyevent::condvar::broadcast { |
1151 | sub broadcast { |
1072 | ${$_[0]}++; |
1152 | ${$_[0]}++; |
1073 | } |
1153 | } |
1074 | |
1154 | |
1075 | sub urxvt::anyevent::condvar::wait { |
1155 | sub wait { |
1076 | unless (${$_[0]}) { |
1156 | unless (${$_[0]}) { |
1077 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1157 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1078 | } |
1158 | } |
|
|
1159 | } |
|
|
1160 | |
|
|
1161 | sub one_event { |
|
|
1162 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1079 | } |
1163 | } |
1080 | |
1164 | |
1081 | package urxvt::term; |
1165 | package urxvt::term; |
1082 | |
1166 | |
1083 | =head2 The C<urxvt::term> Class |
1167 | =head2 The C<urxvt::term> Class |
… | |
… | |
1170 | |
1254 | |
1171 | Returns true if the option specified by C<$optval> is enabled, and |
1255 | Returns true if the option specified by C<$optval> is enabled, and |
1172 | optionally change it. All option values are stored by name in the hash |
1256 | optionally change it. All option values are stored by name in the hash |
1173 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1257 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1174 | |
1258 | |
1175 | Here is a a likely non-exhaustive list of option names, please see the |
1259 | Here is a likely non-exhaustive list of option names, please see the |
1176 | source file F</src/optinc.h> to see the actual list: |
1260 | source file F</src/optinc.h> to see the actual list: |
1177 | |
1261 | |
1178 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1262 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1179 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1263 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1180 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1264 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1197 | likely change). |
1281 | likely change). |
1198 | |
1282 | |
1199 | Please note that resource strings will currently only be freed when the |
1283 | Please note that resource strings will currently only be freed when the |
1200 | terminal is destroyed, so changing options frequently will eat memory. |
1284 | terminal is destroyed, so changing options frequently will eat memory. |
1201 | |
1285 | |
1202 | Here is a a likely non-exhaustive list of resource names, not all of which |
1286 | Here is a likely non-exhaustive list of resource names, not all of which |
1203 | are supported in every build, please see the source file F</src/rsinc.h> |
1287 | are supported in every build, please see the source file F</src/rsinc.h> |
1204 | to see the actual list: |
1288 | to see the actual list: |
1205 | |
1289 | |
1206 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1290 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1207 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1291 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1519 | |
1603 | |
1520 | Returns the currently displayed screen (0 primary, 1 secondary). |
1604 | Returns the currently displayed screen (0 primary, 1 secondary). |
1521 | |
1605 | |
1522 | =item $cursor_is_hidden = $term->hidden_cursor |
1606 | =item $cursor_is_hidden = $term->hidden_cursor |
1523 | |
1607 | |
1524 | Returns wether the cursor is currently hidden or not. |
1608 | Returns whether the cursor is currently hidden or not. |
1525 | |
1609 | |
1526 | =item $view_start = $term->view_start ([$newvalue]) |
1610 | =item $view_start = $term->view_start ([$newvalue]) |
1527 | |
1611 | |
1528 | Returns the row number of the topmost displayed line. Maximum value is |
1612 | Returns the row number of the topmost displayed line. Maximum value is |
1529 | C<0>, which displays the normal terminal contents. Lower values scroll |
1613 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1706 | where one character corresponds to one screen cell. See |
1790 | where one character corresponds to one screen cell. See |
1707 | C<< $term->ROW_t >> for details. |
1791 | C<< $term->ROW_t >> for details. |
1708 | |
1792 | |
1709 | =item $string = $term->special_decode $text |
1793 | =item $string = $term->special_decode $text |
1710 | |
1794 | |
1711 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1795 | Converts rxvt-unicodes text representation into a perl string. See |
1712 | C<< $term->ROW_t >> for details. |
1796 | C<< $term->ROW_t >> for details. |
1713 | |
1797 | |
1714 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1798 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1715 | |
1799 | |
1716 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
1800 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1719 | manpage. |
1803 | manpage. |
1720 | |
1804 | |
1721 | =item $success = $term->grab ($eventtime[, $sync]) |
1805 | =item $success = $term->grab ($eventtime[, $sync]) |
1722 | |
1806 | |
1723 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1807 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1724 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1808 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1725 | |
1809 | |
1726 | =item $term->allow_events_async |
1810 | =item $term->allow_events_async |
1727 | |
1811 | |
1728 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1812 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1729 | |
1813 | |
… | |
… | |
1902 | =back |
1986 | =back |
1903 | |
1987 | |
1904 | =cut |
1988 | =cut |
1905 | |
1989 | |
1906 | package urxvt::watcher; |
1990 | package urxvt::watcher; |
1907 | |
|
|
1908 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1909 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1910 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1911 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1912 | |
1991 | |
1913 | =head2 The C<urxvt::timer> Class |
1992 | =head2 The C<urxvt::timer> Class |
1914 | |
1993 | |
1915 | This class implements timer watchers/events. Time is represented as a |
1994 | This class implements timer watchers/events. Time is represented as a |
1916 | fractional number of seconds since the epoch. Example: |
1995 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1996 | Set the callback to be called when io events are triggered. C<$reventmask> |
2075 | Set the callback to be called when io events are triggered. C<$reventmask> |
1997 | is a bitset as described in the C<events> method. |
2076 | is a bitset as described in the C<events> method. |
1998 | |
2077 | |
1999 | =item $iow = $iow->fd ($fd) |
2078 | =item $iow = $iow->fd ($fd) |
2000 | |
2079 | |
2001 | Set the filedescriptor (not handle) to watch. |
2080 | Set the file descriptor (not handle) to watch. |
2002 | |
2081 | |
2003 | =item $iow = $iow->events ($eventmask) |
2082 | =item $iow = $iow->events ($eventmask) |
2004 | |
2083 | |
2005 | Set the event mask to watch. The only allowed values are |
2084 | Set the event mask to watch. The only allowed values are |
2006 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2085 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
… | |
… | |
2010 | |
2089 | |
2011 | Start watching for requested events on the given handle. |
2090 | Start watching for requested events on the given handle. |
2012 | |
2091 | |
2013 | =item $iow = $iow->stop |
2092 | =item $iow = $iow->stop |
2014 | |
2093 | |
2015 | Stop watching for events on the given filehandle. |
2094 | Stop watching for events on the given file handle. |
2016 | |
2095 | |
2017 | =back |
2096 | =back |
2018 | |
2097 | |
2019 | =head2 The C<urxvt::iw> Class |
2098 | =head2 The C<urxvt::iw> Class |
2020 | |
2099 | |
… | |
… | |
2067 | |
2146 | |
2068 | Set the callback to be called when the timer triggers. |
2147 | Set the callback to be called when the timer triggers. |
2069 | |
2148 | |
2070 | =item $pw = $timer->start ($pid) |
2149 | =item $pw = $timer->start ($pid) |
2071 | |
2150 | |
2072 | Tells the wqtcher to start watching for process C<$pid>. |
2151 | Tells the watcher to start watching for process C<$pid>. |
2073 | |
2152 | |
2074 | =item $pw = $pw->stop |
2153 | =item $pw = $pw->stop |
2075 | |
2154 | |
2076 | Stop the watcher. |
2155 | Stop the watcher. |
2077 | |
2156 | |
… | |
… | |
2090 | |
2169 | |
2091 | =item >= 3 - script loading and management |
2170 | =item >= 3 - script loading and management |
2092 | |
2171 | |
2093 | =item >=10 - all called hooks |
2172 | =item >=10 - all called hooks |
2094 | |
2173 | |
2095 | =item >=11 - hook reutrn values |
2174 | =item >=11 - hook return values |
2096 | |
2175 | |
2097 | =back |
2176 | =back |
2098 | |
2177 | |
2099 | =head1 AUTHOR |
2178 | =head1 AUTHOR |
2100 | |
2179 | |
… | |
… | |
2102 | http://software.schmorp.de/pkg/rxvt-unicode |
2181 | http://software.schmorp.de/pkg/rxvt-unicode |
2103 | |
2182 | |
2104 | =cut |
2183 | =cut |
2105 | |
2184 | |
2106 | 1 |
2185 | 1 |
|
|
2186 | |
|
|
2187 | # vim: sw=3: |