… | |
… | |
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 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
|
|
157 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
|
|
158 | or simply use an uppercase character which removes the "(?i)" prefix. |
|
|
159 | |
|
|
160 | See L<perlre> for more info about perl regular expression syntax. |
|
|
161 | |
132 | =item readline (enabled by default) |
162 | =item readline (enabled by default) |
133 | |
163 | |
134 | A support package that tries to make editing with readline easier. At the |
164 | A support package that tries to make editing with readline easier. At |
135 | moment, it reacts to clicking with the left mouse button by trying to |
165 | the moment, it reacts to clicking shift-left mouse button by trying to |
136 | move the text cursor to this position. It does so by generating as many |
166 | move the text cursor to this position. It does so by generating as many |
137 | cursor-left or cursor-right keypresses as required (the this only works |
167 | cursor-left or cursor-right keypresses as required (the this only works |
138 | for programs that correctly support wide characters). |
168 | for programs that correctly support wide characters). |
139 | |
169 | |
140 | To avoid too many false positives, this is only done when: |
170 | To avoid too many false positives, this is only done when: |
141 | |
171 | |
142 | =over 4 |
172 | =over 4 |
143 | |
173 | |
|
|
174 | =item - the tty is in ICANON state. |
|
|
175 | |
|
|
176 | =item - the text cursor is visible. |
|
|
177 | |
|
|
178 | =item - the primary screen is currently being displayed. |
|
|
179 | |
144 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
180 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
145 | |
|
|
146 | =item - the primary screen is currently being displayed. |
|
|
147 | |
|
|
148 | =item - the text cursor is visible. |
|
|
149 | |
181 | |
150 | =back |
182 | =back |
151 | |
183 | |
152 | The normal selection mechanism isn't disabled, so quick successive clicks |
184 | The normal selection mechanism isn't disabled, so quick successive clicks |
153 | might interfere with selection creation in harmless ways. |
185 | might interfere with selection creation in harmless ways. |
… | |
… | |
196 | |
228 | |
197 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
229 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
198 | B<Shift-Right> will switch to the tab left or right of the current one, |
230 | B<Shift-Right> will switch to the tab left or right of the current one, |
199 | while B<Shift-Down> creates a new tab. |
231 | while B<Shift-Down> creates a new tab. |
200 | |
232 | |
|
|
233 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
234 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
235 | following four resources (shown with defaults): |
|
|
236 | |
|
|
237 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
238 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
239 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
240 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
241 | |
|
|
242 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
243 | indices. |
|
|
244 | |
201 | =item mark-urls |
245 | =item mark-urls |
202 | |
246 | |
203 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
247 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
204 | make them clickable. When middle-clicked, the program specified in the |
248 | make them clickable. When middle-clicked, the program specified in the |
205 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
249 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
206 | the URL as first argument. |
250 | the URL as first argument. |
207 | |
251 | |
|
|
252 | =item xim-onthespot |
|
|
253 | |
|
|
254 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
255 | not work perfectly, and some input methods don't seem to work well with |
|
|
256 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
257 | kinput2. |
|
|
258 | |
|
|
259 | You enable it by specifying this extension and a preedit style of |
|
|
260 | C<OnTheSpot>, i.e.: |
|
|
261 | |
|
|
262 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
263 | |
|
|
264 | =item kuake<hotkey> |
|
|
265 | |
|
|
266 | A very primitive quake-console-like extension. It was inspired by a |
|
|
267 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
268 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
269 | will show or hide itself. Another press of the accelerator key will hide |
|
|
270 | or show it again. |
|
|
271 | |
|
|
272 | Initially, the window will not be shown when using this extension. |
|
|
273 | |
|
|
274 | This is useful if you need a single terminal thats not using any desktop |
|
|
275 | space most of the time but is quickly available at the press of a key. |
|
|
276 | |
|
|
277 | The accelerator key is grabbed regardless of any modifers, so this |
|
|
278 | extension will actually grab a physical key just for this function. |
|
|
279 | |
|
|
280 | If you want a quake-like animation, tell your window manager to do so |
|
|
281 | (fvwm can do it). |
|
|
282 | |
208 | =item automove-background |
283 | =item automove-background |
209 | |
284 | |
210 | This is basically a one-line extension that dynamically changes the background pixmap offset |
285 | This is basically a very small extension that dynamically changes the |
211 | to the window position, in effect creating the same effect as pseudo transparency with |
286 | background pixmap offset to the window position, in effect creating the |
212 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
287 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
288 | supported in this mode. Exmaple: |
213 | |
289 | |
214 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
290 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
215 | |
291 | |
216 | =item block-graphics-to-ascii |
292 | =item block-graphics-to-ascii |
217 | |
293 | |
218 | A not very useful example of filtering all text output to the terminal, |
294 | A not very useful example of filtering all text output to the terminal |
219 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
295 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
220 | similar-looking ascii character. |
296 | similar-looking ascii character. |
221 | |
297 | |
222 | =item digital-clock |
298 | =item digital-clock |
223 | |
299 | |
224 | Displays a digital clock using the built-in overlay. |
300 | Displays a digital clock using the built-in overlay. |
225 | |
301 | |
226 | =item example-refresh-hooks |
302 | =item remote-clipboard |
227 | |
303 | |
228 | Displays a very simple digital clock in the upper right corner of the |
304 | Somewhat of a misnomer, this extension adds two menu entries to the |
229 | window. Illustrates overwriting the refresh callbacks to create your own |
305 | selection popup that allows one ti run external commands to store the |
230 | overlays or changes. |
306 | selection somewhere and fetch it again. |
|
|
307 | |
|
|
308 | We use it to implement a "distributed selection mechanism", which just |
|
|
309 | means that one command uploads the file to a remote server, and another |
|
|
310 | reads it. |
|
|
311 | |
|
|
312 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
313 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
314 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
315 | the selection data on STDOUT (also in UTF-8). |
|
|
316 | |
|
|
317 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
318 | |
|
|
319 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
320 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
231 | |
321 | |
232 | =item selection-pastebin |
322 | =item selection-pastebin |
233 | |
323 | |
234 | This is a little rarely useful extension that Uploads the selection as |
324 | This is a little rarely useful extension that Uploads the selection as |
235 | textfile to a remote site (or does other things). (The implementation is |
325 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
255 | After a successful upload the selection will be replaced by the text given |
345 | After a successful upload the selection will be replaced by the text given |
256 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
346 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
257 | for the filename): |
347 | for the filename): |
258 | |
348 | |
259 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
349 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
350 | |
|
|
351 | =item example-refresh-hooks |
|
|
352 | |
|
|
353 | Displays a very simple digital clock in the upper right corner of the |
|
|
354 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
355 | overlays or changes. |
260 | |
356 | |
261 | =back |
357 | =back |
262 | |
358 | |
263 | =head1 API DOCUMENTATION |
359 | =head1 API DOCUMENTATION |
264 | |
360 | |
… | |
… | |
298 | |
394 | |
299 | =back |
395 | =back |
300 | |
396 | |
301 | =head2 Extension Objects |
397 | =head2 Extension Objects |
302 | |
398 | |
303 | Very perl extension is a perl class. A separate perl object is created |
399 | Every perl extension is a perl class. A separate perl object is created |
304 | for each terminal and each extension and passed as the first parameter to |
400 | for each terminal and each extension and passed as the first parameter to |
305 | hooks. So extensions can use their C<$self> object without having to think |
401 | hooks. So extensions can use their C<$self> object without having to think |
306 | about other extensions, with the exception of methods and members that |
402 | about other extensions, with the exception of methods and members that |
307 | begin with an underscore character C<_>: these are reserved for internal |
403 | begin with an underscore character C<_>: these are reserved for internal |
308 | use. |
404 | use. |
… | |
… | |
361 | Called at the very end of initialisation of a new terminal, just before |
457 | Called at the very end of initialisation of a new terminal, just before |
362 | trying to map (display) the toplevel and returning to the mainloop. |
458 | trying to map (display) the toplevel and returning to the mainloop. |
363 | |
459 | |
364 | =item on_destroy $term |
460 | =item on_destroy $term |
365 | |
461 | |
366 | Called whenever something tries to destroy terminal, before doing anything |
462 | Called whenever something tries to destroy terminal, when the terminal is |
367 | yet. If this hook returns true, then destruction is skipped, but this is |
463 | still fully functional (not for long, though). |
368 | rarely a good idea. |
|
|
369 | |
464 | |
370 | =item on_reset $term |
465 | =item on_reset $term |
371 | |
466 | |
372 | Called after the screen is "reset" for any reason, such as resizing or |
467 | Called after the screen is "reset" for any reason, such as resizing or |
373 | control sequences. Here is where you can react on changes to size-related |
468 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
424 | |
519 | |
425 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
520 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
426 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
521 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
427 | number of lines that will be in the scrollback buffer. |
522 | number of lines that will be in the scrollback buffer. |
428 | |
523 | |
|
|
524 | =item on_osc_seq $term, $op, $args |
|
|
525 | |
|
|
526 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
527 | behaviour. The default should be to return an empty list. A true value |
|
|
528 | suppresses execution of the request completely. Make sure you don't get |
|
|
529 | confused by recursive invocations when you output an osc sequence within |
|
|
530 | this callback. |
|
|
531 | |
|
|
532 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
533 | |
429 | =item on_osc_seq $term, $string |
534 | =item on_osc_seq_perl $term, $string |
430 | |
535 | |
431 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
536 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
432 | operating system command) is processed. Cursor position and other state |
537 | operating system command) is processed. Cursor position and other state |
433 | information is up-to-date when this happens. For interoperability, the |
538 | information is up-to-date when this happens. For interoperability, the |
434 | string should start with the extension name and a colon, to distinguish |
539 | string should start with the extension name and a colon, to distinguish |
… | |
… | |
475 | |
580 | |
476 | =item on_refresh_end $term |
581 | =item on_refresh_end $term |
477 | |
582 | |
478 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
583 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
479 | |
584 | |
480 | =item on_keyboard_command $term, $string |
585 | =item on_user_command $term, $string |
481 | |
586 | |
482 | Called whenever the user presses a key combination that has a |
587 | Called whenever the a user-configured event is being activated (e.g. via |
483 | C<perl:string> action bound to it (see description of the B<keysym> |
588 | a C<perl:string> action bound to a key, see description of the B<keysym> |
484 | resource in the @@RXVT_NAME@@(1) manpage). |
589 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
590 | |
|
|
591 | The event is simply the action string. This interface is assumed to change |
|
|
592 | slightly in the future. |
|
|
593 | |
|
|
594 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
595 | |
|
|
596 | Called just after the new window size has been calculcated, but before |
|
|
597 | windows are actually being resized or hints are being set. If this hook |
|
|
598 | returns TRUE, setting of the window hints is being skipped. |
485 | |
599 | |
486 | =item on_x_event $term, $event |
600 | =item on_x_event $term, $event |
487 | |
601 | |
488 | Called on every X event received on the vt window (and possibly other |
602 | Called on every X event received on the vt window (and possibly other |
489 | windows). Should only be used as a last resort. Most event structure |
603 | windows). Should only be used as a last resort. Most event structure |
490 | members are not passed. |
604 | members are not passed. |
|
|
605 | |
|
|
606 | =item on_root_event $term, $event |
|
|
607 | |
|
|
608 | Like C<on_x_event>, but is called for events on the root window. |
491 | |
609 | |
492 | =item on_focus_in $term |
610 | =item on_focus_in $term |
493 | |
611 | |
494 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
612 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
495 | does focus in processing. |
613 | does focus in processing. |
… | |
… | |
624 | Using this function has the advantage that its output ends up in the |
742 | Using this function has the advantage that its output ends up in the |
625 | correct place, e.g. on stderr of the connecting urxvtc client. |
743 | correct place, e.g. on stderr of the connecting urxvtc client. |
626 | |
744 | |
627 | Messages have a size limit of 1023 bytes currently. |
745 | Messages have a size limit of 1023 bytes currently. |
628 | |
746 | |
|
|
747 | =item @terms = urxvt::termlist |
|
|
748 | |
|
|
749 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
750 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
751 | objects that have perl extensions attached will be returned (because there |
|
|
752 | is no urxvt::term objet associated with others). |
|
|
753 | |
629 | =item $time = urxvt::NOW |
754 | =item $time = urxvt::NOW |
630 | |
755 | |
631 | Returns the "current time" (as per the event loop). |
756 | Returns the "current time" (as per the event loop). |
632 | |
757 | |
633 | =item urxvt::CurrentTime |
758 | =item urxvt::CurrentTime |
… | |
… | |
690 | Return the foreground/background colour index, respectively. |
815 | Return the foreground/background colour index, respectively. |
691 | |
816 | |
692 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
817 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
693 | |
818 | |
694 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
819 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
820 | |
|
|
821 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
695 | |
822 | |
696 | Replace the foreground/background colour in the rendition mask with the |
823 | Replace the foreground/background colour in the rendition mask with the |
697 | specified one. |
824 | specified one. |
698 | |
825 | |
699 | =item $value = urxvt::GET_CUSTOM $rend |
826 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
790 | } else { |
917 | } else { |
791 | $ext_arg{$_} ||= []; |
918 | $ext_arg{$_} ||= []; |
792 | } |
919 | } |
793 | } |
920 | } |
794 | |
921 | |
795 | while (my ($ext, $argv) = each %ext_arg) { |
922 | for my $ext (sort keys %ext_arg) { |
796 | my @files = grep -f $_, map "$_/$ext", @dirs; |
923 | my @files = grep -f $_, map "$_/$ext", @dirs; |
797 | |
924 | |
798 | if (@files) { |
925 | if (@files) { |
799 | $TERM->register_package (extension_package $files[0], $argv); |
926 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
800 | } else { |
927 | } else { |
801 | warn "perl extension '$ext' not found in perl library search path\n"; |
928 | warn "perl extension '$ext' not found in perl library search path\n"; |
802 | } |
929 | } |
803 | } |
930 | } |
804 | |
931 | |
… | |
… | |
810 | |
937 | |
811 | if (my $cb = $TERM->{_hook}[$htype]) { |
938 | if (my $cb = $TERM->{_hook}[$htype]) { |
812 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
939 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
813 | if $verbosity >= 10; |
940 | if $verbosity >= 10; |
814 | |
941 | |
815 | keys %$cb; |
942 | for my $pkg (keys %$cb) { |
816 | |
|
|
817 | while (my ($pkg, $cb) = each %$cb) { |
|
|
818 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
943 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
819 | $retval ||= $retval_; |
944 | $retval ||= $retval_; |
820 | |
945 | |
821 | if ($@) { |
946 | if ($@) { |
822 | $TERM->ungrab; # better to lose the grab than the session |
947 | $TERM->ungrab; # better to lose the grab than the session |
823 | warn $@; |
948 | warn $@; |
… | |
… | |
835 | # clear package |
960 | # clear package |
836 | %$TERM = (); |
961 | %$TERM = (); |
837 | } |
962 | } |
838 | |
963 | |
839 | $retval |
964 | $retval |
|
|
965 | } |
|
|
966 | |
|
|
967 | sub SET_COLOR($$$) { |
|
|
968 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
840 | } |
969 | } |
841 | |
970 | |
842 | # urxvt::term::extension |
971 | # urxvt::term::extension |
843 | |
972 | |
844 | package urxvt::term::extension; |
973 | package urxvt::term::extension; |
… | |
… | |
1013 | hash which defines the environment of the new terminal. |
1142 | hash which defines the environment of the new terminal. |
1014 | |
1143 | |
1015 | Croaks (and probably outputs an error message) if the new instance |
1144 | Croaks (and probably outputs an error message) if the new instance |
1016 | couldn't be created. Returns C<undef> if the new instance didn't |
1145 | couldn't be created. Returns C<undef> if the new instance didn't |
1017 | initialise perl, and the terminal object otherwise. The C<init> and |
1146 | initialise perl, and the terminal object otherwise. The C<init> and |
1018 | C<start> hooks will be called during this call. |
1147 | C<start> hooks will be called before this call returns, and are free to |
|
|
1148 | refer to global data (which is race free). |
1019 | |
1149 | |
1020 | =cut |
1150 | =cut |
1021 | |
1151 | |
1022 | sub new { |
1152 | sub new { |
1023 | my ($class, $env, @args) = @_; |
1153 | my ($class, $env, @args) = @_; |
1024 | |
1154 | |
|
|
1155 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1156 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1157 | |
1025 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1158 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1026 | } |
1159 | } |
1027 | |
1160 | |
1028 | =item $term->destroy |
1161 | =item $term->destroy |
1029 | |
1162 | |
1030 | Destroy the terminal object (close the window, free resources |
1163 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1310 | Replaces the event mask of the pty watcher by the given event mask. Can |
1443 | Replaces the event mask of the pty watcher by the given event mask. Can |
1311 | be used to suppress input and output handling to the pty/tty. See the |
1444 | be used to suppress input and output handling to the pty/tty. See the |
1312 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1445 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1313 | the previous value. |
1446 | the previous value. |
1314 | |
1447 | |
|
|
1448 | =item $fd = $term->pty_fd |
|
|
1449 | |
|
|
1450 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1451 | is used. |
|
|
1452 | |
1315 | =item $windowid = $term->parent |
1453 | =item $windowid = $term->parent |
1316 | |
1454 | |
1317 | Return the window id of the toplevel window. |
1455 | Return the window id of the toplevel window. |
1318 | |
1456 | |
1319 | =item $windowid = $term->vt |
1457 | =item $windowid = $term->vt |
… | |
… | |
1325 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1463 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1326 | to receive pointer events all the times: |
1464 | to receive pointer events all the times: |
1327 | |
1465 | |
1328 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1466 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1329 | |
1467 | |
|
|
1468 | =item $term->focus_in |
|
|
1469 | |
|
|
1470 | =item $term->focus_out |
|
|
1471 | |
|
|
1472 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1473 | |
|
|
1474 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1475 | |
|
|
1476 | Deliver various fake events to to terminal. |
|
|
1477 | |
1330 | =item $window_width = $term->width |
1478 | =item $window_width = $term->width |
1331 | |
1479 | |
1332 | =item $window_height = $term->height |
1480 | =item $window_height = $term->height |
1333 | |
1481 | |
1334 | =item $font_width = $term->fwidth |
1482 | =item $font_width = $term->fwidth |
… | |
… | |
1364 | =item $env = $term->env |
1512 | =item $env = $term->env |
1365 | |
1513 | |
1366 | Returns a copy of the environment in effect for the terminal as a hashref |
1514 | Returns a copy of the environment in effect for the terminal as a hashref |
1367 | similar to C<\%ENV>. |
1515 | similar to C<\%ENV>. |
1368 | |
1516 | |
|
|
1517 | =item @envv = $term->envv |
|
|
1518 | |
|
|
1519 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1520 | |
|
|
1521 | =item @argv = $term->argv |
|
|
1522 | |
|
|
1523 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1524 | includes the program name as first element. |
|
|
1525 | |
1369 | =cut |
1526 | =cut |
1370 | |
1527 | |
1371 | sub env { |
1528 | sub env { |
1372 | if (my $env = $_[0]->_env) { |
|
|
1373 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1529 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1374 | } else { |
|
|
1375 | +{ %ENV } |
|
|
1376 | } |
|
|
1377 | } |
1530 | } |
1378 | |
1531 | |
1379 | =item $modifiermask = $term->ModLevel3Mask |
1532 | =item $modifiermask = $term->ModLevel3Mask |
1380 | |
1533 | |
1381 | =item $modifiermask = $term->ModMetaMask |
1534 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1579 | =item $string = $term->special_decode $text |
1732 | =item $string = $term->special_decode $text |
1580 | |
1733 | |
1581 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1734 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1582 | C<< $term->ROW_t >> for details. |
1735 | C<< $term->ROW_t >> for details. |
1583 | |
1736 | |
1584 | =item $success = $term->grab_button ($button, $modifiermask) |
1737 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1585 | |
1738 | |
|
|
1739 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1740 | |
1586 | Registers a synchronous button grab. See the XGrabButton manpage. |
1741 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1742 | manpage. |
1587 | |
1743 | |
1588 | =item $success = $term->grab ($eventtime[, $sync]) |
1744 | =item $success = $term->grab ($eventtime[, $sync]) |
1589 | |
1745 | |
1590 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1746 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1591 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1747 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
… | |
… | |
1709 | my ($self, $text, $cb) = @_; |
1865 | my ($self, $text, $cb) = @_; |
1710 | |
1866 | |
1711 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1867 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1712 | } |
1868 | } |
1713 | |
1869 | |
1714 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1870 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1715 | |
1871 | |
1716 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1872 | Adds a toggle/checkbox item to the popup. The callback gets called |
1717 | whenever it gets toggled, with a boolean indicating its value as its first |
1873 | whenever it gets toggled, with a boolean indicating its new value as its |
1718 | argument. |
1874 | first argument. |
1719 | |
1875 | |
1720 | =cut |
1876 | =cut |
1721 | |
1877 | |
1722 | sub add_toggle { |
1878 | sub add_toggle { |
1723 | my ($self, $text, $cb, $value) = @_; |
1879 | my ($self, $text, $value, $cb) = @_; |
1724 | |
1880 | |
1725 | my $item; $item = { |
1881 | my $item; $item = { |
1726 | type => "button", |
1882 | type => "button", |
1727 | text => " $text", |
1883 | text => " $text", |
1728 | value => $value, |
1884 | value => $value, |