… | |
… | |
67 | the match. For example, the followign adds a regex that matches everything |
67 | the match. For example, the followign adds a regex that matches everything |
68 | between two vertical bars: |
68 | between two vertical bars: |
69 | |
69 | |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
71 | |
71 | |
|
|
72 | Another example: Programs I use often output "absolute path: " at the |
|
|
73 | beginning of a line when they process multiple files. The following |
|
|
74 | pattern matches the filename (note, there is a single space at the very |
|
|
75 | end): |
|
|
76 | |
|
|
77 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
|
|
78 | |
72 | You can look at the source of the selection extension to see more |
79 | You can look at the source of the selection extension to see more |
73 | interesting uses, such as parsing a line from beginning to end. |
80 | interesting uses, such as parsing a line from beginning to end. |
74 | |
81 | |
75 | This extension also offers following bindable keyboard commands: |
82 | This extension also offers following bindable keyboard commands: |
76 | |
83 | |
… | |
… | |
86 | |
93 | |
87 | =item option-popup (enabled by default) |
94 | =item option-popup (enabled by default) |
88 | |
95 | |
89 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
90 | runtime. |
97 | runtime. |
|
|
98 | |
|
|
99 | Other extensions can extend this popup menu by pushing a code reference |
|
|
100 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
101 | popup is being displayed. |
|
|
102 | |
|
|
103 | It's sole argument is the popup menu, which can be modified. It should |
|
|
104 | either return nothing or a string, the initial boolean value and a code |
|
|
105 | reference. The string will be used as button text and the code reference |
|
|
106 | will be called when the toggle changes, with the new boolean value as |
|
|
107 | first argument. |
|
|
108 | |
|
|
109 | The following will add an entry C<myoption> that changes |
|
|
110 | C<$self->{myoption}>: |
|
|
111 | |
|
|
112 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
113 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
114 | }; |
91 | |
115 | |
92 | =item selection-popup (enabled by default) |
116 | =item selection-popup (enabled by default) |
93 | |
117 | |
94 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
95 | text into various other formats/action (such as uri unescaping, perl |
119 | text into various other formats/action (such as uri unescaping, perl |
96 | evaluation, web-browser starting etc.), depending on content. |
120 | evaluation, web-browser starting etc.), depending on content. |
97 | |
121 | |
98 | Other extensions can extend this popup menu by pushing a code reference |
122 | Other extensions can extend this popup menu by pushing a code reference |
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
100 | popup is displayed. |
124 | popup is being displayed. |
101 | |
125 | |
102 | It's sole argument is the popup menu, which can be modified. The selection |
126 | It's sole argument is the popup menu, which can be modified. The selection |
103 | is in C<$_>, which can be used to decide wether to add something or not. |
127 | is in C<$_>, which can be used to decide wether to add something or not. |
104 | It should either return nothing or a string and a code reference. The |
128 | It should either return nothing or a string and a code reference. The |
105 | string will be used as button text and the code reference will be called |
129 | string will be used as button text and the code reference will be called |
… | |
… | |
127 | bottom. C<Escape> leaves search mode and returns to the point where search |
151 | bottom. C<Escape> leaves search mode and returns to the point where search |
128 | was started, while C<Enter> or C<Return> stay at the current position and |
152 | was started, while C<Enter> or C<Return> stay at the current position and |
129 | additionally stores the first match in the current line into the primary |
153 | additionally stores the first match in the current line into the primary |
130 | selection. |
154 | selection. |
131 | |
155 | |
|
|
156 | =item readline (enabled by default) |
|
|
157 | |
|
|
158 | A support package that tries to make editing with readline easier. At |
|
|
159 | the moment, it reacts to clicking shift-left mouse button by trying to |
|
|
160 | move the text cursor to this position. It does so by generating as many |
|
|
161 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
162 | for programs that correctly support wide characters). |
|
|
163 | |
|
|
164 | To avoid too many false positives, this is only done when: |
|
|
165 | |
|
|
166 | =over 4 |
|
|
167 | |
|
|
168 | =item - the tty is in ICANON state. |
|
|
169 | |
|
|
170 | =item - the text cursor is visible. |
|
|
171 | |
|
|
172 | =item - the primary screen is currently being displayed. |
|
|
173 | |
|
|
174 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
175 | |
|
|
176 | =back |
|
|
177 | |
|
|
178 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
179 | might interfere with selection creation in harmless ways. |
|
|
180 | |
132 | =item selection-autotransform |
181 | =item selection-autotransform |
133 | |
182 | |
134 | This selection allows you to do automatic transforms on a selection |
183 | This selection allows you to do automatic transforms on a selection |
135 | whenever a selection is made. |
184 | whenever a selection is made. |
136 | |
185 | |
… | |
… | |
173 | |
222 | |
174 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
223 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
175 | B<Shift-Right> will switch to the tab left or right of the current one, |
224 | B<Shift-Right> will switch to the tab left or right of the current one, |
176 | while B<Shift-Down> creates a new tab. |
225 | while B<Shift-Down> creates a new tab. |
177 | |
226 | |
|
|
227 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
228 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
229 | following four resources (shown with defaults): |
|
|
230 | |
|
|
231 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
232 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
233 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
234 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
235 | |
|
|
236 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
237 | indices. |
|
|
238 | |
178 | =item mark-urls |
239 | =item mark-urls |
179 | |
240 | |
180 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
241 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
181 | make them clickable. When middle-clicked, the program specified in the |
242 | make them clickable. When middle-clicked, the program specified in the |
182 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
243 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
183 | the URL as first argument. |
244 | the URL as first argument. |
184 | |
245 | |
|
|
246 | =item xim-onthespot |
|
|
247 | |
|
|
248 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
249 | not work perfectly, and some input methods don't seem to work well with |
|
|
250 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
251 | kinput2. |
|
|
252 | |
|
|
253 | You enable it by specifying this extension and a preedit style of |
|
|
254 | C<OnTheSpot>, i.e.: |
|
|
255 | |
|
|
256 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
257 | |
185 | =item automove-background |
258 | =item automove-background |
186 | |
259 | |
187 | This is basically a one-line extension that dynamically changes the background pixmap offset |
260 | This is basically a one-line extension that dynamically changes the background pixmap offset |
188 | to the window position, in effect creating the same effect as pseudo transparency with |
261 | to the window position, in effect creating the same effect as pseudo transparency with |
189 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
262 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
… | |
… | |
198 | |
271 | |
199 | =item digital-clock |
272 | =item digital-clock |
200 | |
273 | |
201 | Displays a digital clock using the built-in overlay. |
274 | Displays a digital clock using the built-in overlay. |
202 | |
275 | |
203 | =item example-refresh-hooks |
276 | =item remote-clipboard |
204 | |
277 | |
205 | Displays a very simple digital clock in the upper right corner of the |
278 | Somewhat of a misnomer, this extension adds two menu entries to the |
206 | window. Illustrates overwriting the refresh callbacks to create your own |
279 | selection popup that allows one ti run external commands to store the |
207 | overlays or changes. |
280 | selection somewhere and fetch it again. |
|
|
281 | |
|
|
282 | We use it to implement a "distributed selection mechanism", which just |
|
|
283 | means that one command uploads the file to a remote server, and another |
|
|
284 | reads it. |
|
|
285 | |
|
|
286 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
287 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
288 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
289 | the selection data on STDOUT (also in UTF-8). |
|
|
290 | |
|
|
291 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
292 | |
|
|
293 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
294 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
208 | |
295 | |
209 | =item selection-pastebin |
296 | =item selection-pastebin |
210 | |
297 | |
211 | This is a little rarely useful extension that Uploads the selection as |
298 | This is a little rarely useful extension that Uploads the selection as |
212 | textfile to a remote site (or does other things). (The implementation is |
299 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
232 | After a successful upload the selection will be replaced by the text given |
319 | After a successful upload the selection will be replaced by the text given |
233 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
320 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
234 | for the filename): |
321 | for the filename): |
235 | |
322 | |
236 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
323 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
324 | |
|
|
325 | =item example-refresh-hooks |
|
|
326 | |
|
|
327 | Displays a very simple digital clock in the upper right corner of the |
|
|
328 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
329 | overlays or changes. |
237 | |
330 | |
238 | =back |
331 | =back |
239 | |
332 | |
240 | =head1 API DOCUMENTATION |
333 | =head1 API DOCUMENTATION |
241 | |
334 | |
… | |
… | |
338 | Called at the very end of initialisation of a new terminal, just before |
431 | Called at the very end of initialisation of a new terminal, just before |
339 | trying to map (display) the toplevel and returning to the mainloop. |
432 | trying to map (display) the toplevel and returning to the mainloop. |
340 | |
433 | |
341 | =item on_destroy $term |
434 | =item on_destroy $term |
342 | |
435 | |
343 | Called whenever something tries to destroy terminal, before doing anything |
436 | Called whenever something tries to destroy terminal, when the terminal is |
344 | yet. If this hook returns true, then destruction is skipped, but this is |
437 | still fully functional (not for long, though). |
345 | rarely a good idea. |
|
|
346 | |
438 | |
347 | =item on_reset $term |
439 | =item on_reset $term |
348 | |
440 | |
349 | Called after the screen is "reset" for any reason, such as resizing or |
441 | Called after the screen is "reset" for any reason, such as resizing or |
350 | control sequences. Here is where you can react on changes to size-related |
442 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
401 | |
493 | |
402 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
494 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
403 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
495 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
404 | number of lines that will be in the scrollback buffer. |
496 | number of lines that will be in the scrollback buffer. |
405 | |
497 | |
|
|
498 | =item on_osc_seq $term, $op, $args |
|
|
499 | |
|
|
500 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
501 | behaviour. The default should be to return an empty list. A true value |
|
|
502 | suppresses execution of the request completely. Make sure you don't get |
|
|
503 | confused by recursive invocations when you output an osc sequence within |
|
|
504 | this callback. |
|
|
505 | |
|
|
506 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
507 | |
406 | =item on_osc_seq $term, $string |
508 | =item on_osc_seq_perl $term, $string |
407 | |
509 | |
408 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
510 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
409 | operating system command) is processed. Cursor position and other state |
511 | operating system command) is processed. Cursor position and other state |
410 | information is up-to-date when this happens. For interoperability, the |
512 | information is up-to-date when this happens. For interoperability, the |
411 | string should start with the extension name and a colon, to distinguish |
513 | string should start with the extension name and a colon, to distinguish |
… | |
… | |
452 | |
554 | |
453 | =item on_refresh_end $term |
555 | =item on_refresh_end $term |
454 | |
556 | |
455 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
557 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
456 | |
558 | |
457 | =item on_keyboard_command $term, $string |
559 | =item on_user_command $term, $string |
458 | |
560 | |
459 | Called whenever the user presses a key combination that has a |
561 | Called whenever the a user-configured event is being activated (e.g. via |
460 | C<perl:string> action bound to it (see description of the B<keysym> |
562 | a C<perl:string> action bound to a key, see description of the B<keysym> |
461 | resource in the @@RXVT_NAME@@(1) manpage). |
563 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
564 | |
|
|
565 | The event is simply the action string. This interface is assumed to change |
|
|
566 | slightly in the future. |
|
|
567 | |
|
|
568 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
569 | |
|
|
570 | Called just after the new window size has been calculcated, but before |
|
|
571 | windows are actually being resized or hints are being set. If this hook |
|
|
572 | returns TRUE, setting of the window hints is being skipped. |
462 | |
573 | |
463 | =item on_x_event $term, $event |
574 | =item on_x_event $term, $event |
464 | |
575 | |
465 | Called on every X event received on the vt window (and possibly other |
576 | Called on every X event received on the vt window (and possibly other |
466 | windows). Should only be used as a last resort. Most event structure |
577 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
476 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
587 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
477 | focus out processing. |
588 | focus out processing. |
478 | |
589 | |
479 | =item on_configure_notify $term, $event |
590 | =item on_configure_notify $term, $event |
480 | |
591 | |
|
|
592 | =item on_property_notify $term, $event |
|
|
593 | |
481 | =item on_key_press $term, $event, $keysym, $octets |
594 | =item on_key_press $term, $event, $keysym, $octets |
482 | |
595 | |
483 | =item on_key_release $term, $event, $keysym |
596 | =item on_key_release $term, $event, $keysym |
484 | |
597 | |
485 | =item on_button_press $term, $event |
598 | =item on_button_press $term, $event |
… | |
… | |
494 | |
607 | |
495 | Called whenever the corresponding X event is received for the terminal If |
608 | Called whenever the corresponding X event is received for the terminal If |
496 | the hook returns true, then the even will be ignored by rxvt-unicode. |
609 | the hook returns true, then the even will be ignored by rxvt-unicode. |
497 | |
610 | |
498 | The event is a hash with most values as named by Xlib (see the XEvent |
611 | The event is a hash with most values as named by Xlib (see the XEvent |
499 | manpage), with the additional members C<row> and C<col>, which are the row |
612 | manpage), with the additional members C<row> and C<col>, which are the |
500 | and column under the mouse cursor. |
613 | (real, not screen-based) row and column under the mouse cursor. |
501 | |
614 | |
502 | C<on_key_press> additionally receives the string rxvt-unicode would |
615 | C<on_key_press> additionally receives the string rxvt-unicode would |
503 | output, if any, in locale-specific encoding. |
616 | output, if any, in locale-specific encoding. |
504 | |
617 | |
505 | subwindow. |
618 | subwindow. |
… | |
… | |
536 | our $LIBDIR; |
649 | our $LIBDIR; |
537 | our $RESNAME; |
650 | our $RESNAME; |
538 | our $RESCLASS; |
651 | our $RESCLASS; |
539 | our $RXVTNAME; |
652 | our $RXVTNAME; |
540 | |
653 | |
|
|
654 | our $NOCHAR = chr 0xffff; |
|
|
655 | |
541 | =head2 Variables in the C<urxvt> Package |
656 | =head2 Variables in the C<urxvt> Package |
542 | |
657 | |
543 | =over 4 |
658 | =over 4 |
544 | |
659 | |
545 | =item $urxvt::LIBDIR |
660 | =item $urxvt::LIBDIR |
… | |
… | |
596 | |
711 | |
597 | Using this function has the advantage that its output ends up in the |
712 | Using this function has the advantage that its output ends up in the |
598 | correct place, e.g. on stderr of the connecting urxvtc client. |
713 | correct place, e.g. on stderr of the connecting urxvtc client. |
599 | |
714 | |
600 | Messages have a size limit of 1023 bytes currently. |
715 | Messages have a size limit of 1023 bytes currently. |
|
|
716 | |
|
|
717 | =item @terms = urxvt::termlist |
|
|
718 | |
|
|
719 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
720 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
721 | objects that have perl extensions attached will be returned (because there |
|
|
722 | is no urxvt::term objet associated with others). |
601 | |
723 | |
602 | =item $time = urxvt::NOW |
724 | =item $time = urxvt::NOW |
603 | |
725 | |
604 | Returns the "current time" (as per the event loop). |
726 | Returns the "current time" (as per the event loop). |
605 | |
727 | |
… | |
… | |
663 | Return the foreground/background colour index, respectively. |
785 | Return the foreground/background colour index, respectively. |
664 | |
786 | |
665 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
787 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
666 | |
788 | |
667 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
789 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
790 | |
|
|
791 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
668 | |
792 | |
669 | Replace the foreground/background colour in the rendition mask with the |
793 | Replace the foreground/background colour in the rendition mask with the |
670 | specified one. |
794 | specified one. |
671 | |
795 | |
672 | =item $value = urxvt::GET_CUSTOM $rend |
796 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
691 | unless $msg =~ /\n$/; |
815 | unless $msg =~ /\n$/; |
692 | urxvt::warn ($msg); |
816 | urxvt::warn ($msg); |
693 | }; |
817 | }; |
694 | } |
818 | } |
695 | |
819 | |
|
|
820 | no warnings 'utf8'; |
|
|
821 | |
696 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
822 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
697 | |
823 | |
698 | sub verbose { |
824 | sub verbose { |
699 | my ($level, $msg) = @_; |
825 | my ($level, $msg) = @_; |
700 | warn "$msg\n" if $level <= $verbosity; |
826 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
716 | |
842 | |
717 | open my $fh, "<:raw", $path |
843 | open my $fh, "<:raw", $path |
718 | or die "$path: $!"; |
844 | or die "$path: $!"; |
719 | |
845 | |
720 | my $source = |
846 | my $source = |
721 | "package $pkg; use strict; use utf8;\n" |
847 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
722 | . "#line 1 \"$path\"\n{\n" |
848 | . "#line 1 \"$path\"\n{\n" |
723 | . (do { local $/; <$fh> }) |
849 | . (do { local $/; <$fh> }) |
724 | . "\n};\n1"; |
850 | . "\n};\n1"; |
725 | |
851 | |
726 | eval $source |
852 | eval $source |
… | |
… | |
751 | $TERM->register_package ($_) for @pkg; |
877 | $TERM->register_package ($_) for @pkg; |
752 | } |
878 | } |
753 | |
879 | |
754 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
880 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
755 | if ($_ eq "default") { |
881 | if ($_ eq "default") { |
756 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
882 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
757 | } elsif (/^-(.*)$/) { |
883 | } elsif (/^-(.*)$/) { |
758 | delete $ext_arg{$1}; |
884 | delete $ext_arg{$1}; |
759 | } elsif (/^([^<]+)<(.*)>$/) { |
885 | } elsif (/^([^<]+)<(.*)>$/) { |
760 | push @{ $ext_arg{$1} }, $2; |
886 | push @{ $ext_arg{$1} }, $2; |
761 | } else { |
887 | } else { |
762 | $ext_arg{$_} ||= []; |
888 | $ext_arg{$_} ||= []; |
763 | } |
889 | } |
764 | } |
890 | } |
765 | |
891 | |
766 | while (my ($ext, $argv) = each %ext_arg) { |
892 | for my $ext (sort keys %ext_arg) { |
767 | my @files = grep -f $_, map "$_/$ext", @dirs; |
893 | my @files = grep -f $_, map "$_/$ext", @dirs; |
768 | |
894 | |
769 | if (@files) { |
895 | if (@files) { |
770 | $TERM->register_package (extension_package $files[0], $argv); |
896 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
771 | } else { |
897 | } else { |
772 | warn "perl extension '$ext' not found in perl library search path\n"; |
898 | warn "perl extension '$ext' not found in perl library search path\n"; |
773 | } |
899 | } |
774 | } |
900 | } |
775 | |
901 | |
… | |
… | |
806 | # clear package |
932 | # clear package |
807 | %$TERM = (); |
933 | %$TERM = (); |
808 | } |
934 | } |
809 | |
935 | |
810 | $retval |
936 | $retval |
|
|
937 | } |
|
|
938 | |
|
|
939 | sub SET_COLOR($$$) { |
|
|
940 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
811 | } |
941 | } |
812 | |
942 | |
813 | # urxvt::term::extension |
943 | # urxvt::term::extension |
814 | |
944 | |
815 | package urxvt::term::extension; |
945 | package urxvt::term::extension; |
… | |
… | |
984 | hash which defines the environment of the new terminal. |
1114 | hash which defines the environment of the new terminal. |
985 | |
1115 | |
986 | Croaks (and probably outputs an error message) if the new instance |
1116 | Croaks (and probably outputs an error message) if the new instance |
987 | couldn't be created. Returns C<undef> if the new instance didn't |
1117 | couldn't be created. Returns C<undef> if the new instance didn't |
988 | initialise perl, and the terminal object otherwise. The C<init> and |
1118 | initialise perl, and the terminal object otherwise. The C<init> and |
989 | C<start> hooks will be called during this call. |
1119 | C<start> hooks will be called before this call returns, and are free to |
|
|
1120 | refer to global data (which is race free). |
990 | |
1121 | |
991 | =cut |
1122 | =cut |
992 | |
1123 | |
993 | sub new { |
1124 | sub new { |
994 | my ($class, $env, @args) = @_; |
1125 | my ($class, $env, @args) = @_; |
995 | |
1126 | |
|
|
1127 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1128 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1129 | |
996 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1130 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
997 | } |
1131 | } |
998 | |
1132 | |
999 | =item $term->destroy |
1133 | =item $term->destroy |
1000 | |
1134 | |
1001 | Destroy the terminal object (close the window, free resources |
1135 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1258 | |
1392 | |
1259 | Normally its not a good idea to use this function, as programs might be |
1393 | Normally its not a good idea to use this function, as programs might be |
1260 | confused by changes in cursor position or scrolling. Its useful inside a |
1394 | confused by changes in cursor position or scrolling. Its useful inside a |
1261 | C<on_add_lines> hook, though. |
1395 | C<on_add_lines> hook, though. |
1262 | |
1396 | |
|
|
1397 | =item $term->scr_change_screen ($screen) |
|
|
1398 | |
|
|
1399 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1400 | |
1263 | =item $term->cmd_parse ($octets) |
1401 | =item $term->cmd_parse ($octets) |
1264 | |
1402 | |
1265 | Similar to C<scr_add_lines>, but the argument must be in the |
1403 | Similar to C<scr_add_lines>, but the argument must be in the |
1266 | locale-specific encoding of the terminal and can contain command sequences |
1404 | locale-specific encoding of the terminal and can contain command sequences |
1267 | (escape codes) that will be interpreted. |
1405 | (escape codes) that will be interpreted. |
… | |
… | |
1277 | Replaces the event mask of the pty watcher by the given event mask. Can |
1415 | Replaces the event mask of the pty watcher by the given event mask. Can |
1278 | be used to suppress input and output handling to the pty/tty. See the |
1416 | be used to suppress input and output handling to the pty/tty. See the |
1279 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1417 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1280 | the previous value. |
1418 | the previous value. |
1281 | |
1419 | |
|
|
1420 | =item $fd = $term->pty_fd |
|
|
1421 | |
|
|
1422 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1423 | is used. |
|
|
1424 | |
1282 | =item $windowid = $term->parent |
1425 | =item $windowid = $term->parent |
1283 | |
1426 | |
1284 | Return the window id of the toplevel window. |
1427 | Return the window id of the toplevel window. |
1285 | |
1428 | |
1286 | =item $windowid = $term->vt |
1429 | =item $windowid = $term->vt |
… | |
… | |
1292 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1435 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1293 | to receive pointer events all the times: |
1436 | to receive pointer events all the times: |
1294 | |
1437 | |
1295 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1438 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1296 | |
1439 | |
|
|
1440 | =item $term->focus_in |
|
|
1441 | |
|
|
1442 | =item $term->focus_out |
|
|
1443 | |
|
|
1444 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1445 | |
|
|
1446 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1447 | |
|
|
1448 | Deliver various fake events to to terminal. |
|
|
1449 | |
1297 | =item $window_width = $term->width |
1450 | =item $window_width = $term->width |
1298 | |
1451 | |
1299 | =item $window_height = $term->height |
1452 | =item $window_height = $term->height |
1300 | |
1453 | |
1301 | =item $font_width = $term->fwidth |
1454 | =item $font_width = $term->fwidth |
… | |
… | |
1331 | =item $env = $term->env |
1484 | =item $env = $term->env |
1332 | |
1485 | |
1333 | Returns a copy of the environment in effect for the terminal as a hashref |
1486 | Returns a copy of the environment in effect for the terminal as a hashref |
1334 | similar to C<\%ENV>. |
1487 | similar to C<\%ENV>. |
1335 | |
1488 | |
|
|
1489 | =item @envv = $term->envv |
|
|
1490 | |
|
|
1491 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1492 | |
|
|
1493 | =item @argv = $term->argv |
|
|
1494 | |
|
|
1495 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1496 | includes the program name as first element. |
|
|
1497 | |
1336 | =cut |
1498 | =cut |
1337 | |
1499 | |
1338 | sub env { |
1500 | sub env { |
1339 | if (my $env = $_[0]->_env) { |
|
|
1340 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1501 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1341 | } else { |
|
|
1342 | +{ %ENV } |
|
|
1343 | } |
|
|
1344 | } |
1502 | } |
1345 | |
1503 | |
1346 | =item $modifiermask = $term->ModLevel3Mask |
1504 | =item $modifiermask = $term->ModLevel3Mask |
1347 | |
1505 | |
1348 | =item $modifiermask = $term->ModMetaMask |
1506 | =item $modifiermask = $term->ModMetaMask |
1349 | |
1507 | |
1350 | =item $modifiermask = $term->ModNumLockMask |
1508 | =item $modifiermask = $term->ModNumLockMask |
1351 | |
1509 | |
1352 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1510 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1353 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1511 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1512 | |
|
|
1513 | =item $screen = $term->current_screen |
|
|
1514 | |
|
|
1515 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1516 | |
|
|
1517 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1518 | |
|
|
1519 | Returns wether the cursor is currently hidden or not. |
1354 | |
1520 | |
1355 | =item $view_start = $term->view_start ([$newvalue]) |
1521 | =item $view_start = $term->view_start ([$newvalue]) |
1356 | |
1522 | |
1357 | Returns the row number of the topmost displayed line. Maximum value is |
1523 | Returns the row number of the topmost displayed line. Maximum value is |
1358 | C<0>, which displays the normal terminal contents. Lower values scroll |
1524 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1378 | line, starting at column C<$start_col> (default C<0>), which is useful |
1544 | line, starting at column C<$start_col> (default C<0>), which is useful |
1379 | to replace only parts of a line. The font index in the rendition will |
1545 | to replace only parts of a line. The font index in the rendition will |
1380 | automatically be updated. |
1546 | automatically be updated. |
1381 | |
1547 | |
1382 | C<$text> is in a special encoding: tabs and wide characters that use more |
1548 | C<$text> is in a special encoding: tabs and wide characters that use more |
1383 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1549 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1384 | (C<chr 65535>). Characters with combining characters and other characters |
1550 | characters. Characters with combining characters and other characters that |
1385 | that do not fit into the normal tetx encoding will be replaced with |
1551 | do not fit into the normal tetx encoding will be replaced with characters |
1386 | characters in the private use area. |
1552 | in the private use area. |
1387 | |
1553 | |
1388 | You have to obey this encoding when changing text. The advantage is |
1554 | You have to obey this encoding when changing text. The advantage is |
1389 | that C<substr> and similar functions work on screen cells and not on |
1555 | that C<substr> and similar functions work on screen cells and not on |
1390 | characters. |
1556 | characters. |
1391 | |
1557 | |
… | |
… | |
1538 | =item $string = $term->special_decode $text |
1704 | =item $string = $term->special_decode $text |
1539 | |
1705 | |
1540 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1706 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1541 | C<< $term->ROW_t >> for details. |
1707 | C<< $term->ROW_t >> for details. |
1542 | |
1708 | |
1543 | =item $success = $term->grab_button ($button, $modifiermask) |
1709 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1544 | |
1710 | |
|
|
1711 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1712 | |
1545 | Registers a synchronous button grab. See the XGrabButton manpage. |
1713 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1714 | manpage. |
1546 | |
1715 | |
1547 | =item $success = $term->grab ($eventtime[, $sync]) |
1716 | =item $success = $term->grab ($eventtime[, $sync]) |
1548 | |
1717 | |
1549 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1718 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1550 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1719 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
… | |
… | |
1565 | =item $term->ungrab |
1734 | =item $term->ungrab |
1566 | |
1735 | |
1567 | Calls XUngrab for the most recent grab. Is called automatically on |
1736 | Calls XUngrab for the most recent grab. Is called automatically on |
1568 | evaluation errors, as it is better to lose the grab in the error case as |
1737 | evaluation errors, as it is better to lose the grab in the error case as |
1569 | the session. |
1738 | the session. |
|
|
1739 | |
|
|
1740 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1741 | |
|
|
1742 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1743 | |
|
|
1744 | =item @atoms = $term->XListProperties ($window) |
|
|
1745 | |
|
|
1746 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1747 | |
|
|
1748 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1749 | |
|
|
1750 | =item $term->XDeleteProperty ($window, $property) |
|
|
1751 | |
|
|
1752 | =item $window = $term->DefaultRootWindow |
|
|
1753 | |
|
|
1754 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1755 | |
|
|
1756 | =item $term->XMapWindow ($window) |
|
|
1757 | |
|
|
1758 | =item $term->XUnmapWindow ($window) |
|
|
1759 | |
|
|
1760 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1761 | |
|
|
1762 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1763 | |
|
|
1764 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1765 | |
|
|
1766 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1767 | the source of the display, otherwise those functions map more-or-less |
|
|
1768 | directory onto the X functions of the same name. |
1570 | |
1769 | |
1571 | =back |
1770 | =back |
1572 | |
1771 | |
1573 | =cut |
1772 | =cut |
1574 | |
1773 | |
… | |
… | |
1638 | my ($self, $text, $cb) = @_; |
1837 | my ($self, $text, $cb) = @_; |
1639 | |
1838 | |
1640 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1839 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1641 | } |
1840 | } |
1642 | |
1841 | |
1643 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1842 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1644 | |
1843 | |
1645 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1844 | Adds a toggle/checkbox item to the popup. The callback gets called |
1646 | whenever it gets toggled, with a boolean indicating its value as its first |
1845 | whenever it gets toggled, with a boolean indicating its new value as its |
1647 | argument. |
1846 | first argument. |
1648 | |
1847 | |
1649 | =cut |
1848 | =cut |
1650 | |
1849 | |
1651 | sub add_toggle { |
1850 | sub add_toggle { |
1652 | my ($self, $text, $cb, $value) = @_; |
1851 | my ($self, $text, $value, $cb) = @_; |
1653 | |
1852 | |
1654 | my $item; $item = { |
1853 | my $item; $item = { |
1655 | type => "button", |
1854 | type => "button", |
1656 | text => " $text", |
1855 | text => " $text", |
1657 | value => $value, |
1856 | value => $value, |