… | |
… | |
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 | |
30 | |
|
|
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
|
|
32 | and "perl-ext-common" resources to the empty string. |
|
|
33 | |
31 | =head1 PREPACKAGED EXTENSIONS |
34 | =head1 PREPACKAGED EXTENSIONS |
32 | |
35 | |
33 | This section describes the extensions delivered with this release. You can |
36 | This section describes the extensions delivered with this release. You can |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
37 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
35 | |
38 | |
… | |
… | |
37 | |
40 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
41 | @@RXVT_NAME@@ -pe <extensionname> |
39 | |
42 | |
40 | Or by adding them to the resource for extensions loaded by default: |
43 | Or by adding them to the resource for extensions loaded by default: |
41 | |
44 | |
42 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
45 | URxvt.perl-ext-common: default,selection-autotransform |
43 | |
46 | |
44 | =over 4 |
47 | =over 4 |
45 | |
48 | |
46 | =item selection (enabled by default) |
49 | =item selection (enabled by default) |
47 | |
50 | |
… | |
… | |
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: \\|([^|]+)\\| |
|
|
74 | |
|
|
75 | Another example: Programs I use often output "absolute path: " at the |
|
|
76 | beginning of a line when they process multiple files. The following |
|
|
77 | pattern matches the filename (note, there is a single space at the very |
|
|
78 | end): |
|
|
79 | |
|
|
80 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
71 | |
81 | |
72 | You can look at the source of the selection extension to see more |
82 | 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. |
83 | interesting uses, such as parsing a line from beginning to end. |
74 | |
84 | |
75 | This extension also offers following bindable keyboard commands: |
85 | This extension also offers following bindable keyboard commands: |
… | |
… | |
87 | =item option-popup (enabled by default) |
97 | =item option-popup (enabled by default) |
88 | |
98 | |
89 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
99 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
90 | runtime. |
100 | runtime. |
91 | |
101 | |
|
|
102 | Other extensions can extend this popup menu by pushing a code reference |
|
|
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
104 | popup is being displayed. |
|
|
105 | |
|
|
106 | Its sole argument is the popup menu, which can be modified. It should |
|
|
107 | either return nothing or a string, the initial boolean value and a code |
|
|
108 | reference. The string will be used as button text and the code reference |
|
|
109 | will be called when the toggle changes, with the new boolean value as |
|
|
110 | first argument. |
|
|
111 | |
|
|
112 | The following will add an entry C<myoption> that changes |
|
|
113 | C<$self->{myoption}>: |
|
|
114 | |
|
|
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
117 | }; |
|
|
118 | |
92 | =item selection-popup (enabled by default) |
119 | =item selection-popup (enabled by default) |
93 | |
120 | |
94 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
121 | 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 |
122 | text into various other formats/action (such as uri unescaping, perl |
96 | evalution, web-browser starting etc.), depending on content. |
123 | evaluation, web-browser starting etc.), depending on content. |
97 | |
124 | |
98 | 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 |
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
100 | popup is displayed. |
127 | popup is being displayed. |
101 | |
128 | |
102 | It's sole argument is the popup menu, which can be modified. The selection |
129 | Its sole argument is the popup menu, which can be modified. The selection |
103 | 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. |
104 | 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 |
105 | 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 |
106 | when the button gets activated and should transform C<$_>. |
133 | when the button gets activated and should transform C<$_>. |
107 | |
134 | |
108 | 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 |
109 | the selection to C<b>s, but only if the selection currently contains any |
136 | the selection to C<b>s, but only if the selection currently contains any |
110 | C<a>s: |
137 | C<a>s: |
111 | |
138 | |
112 | push @{ $self->{term}{selection_popup_hook} }, sub { |
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
113 | /a/ ? ("a to be" => sub { s/a/b/g } |
140 | /a/ ? ("a to b" => sub { s/a/b/g } |
114 | : () |
141 | : () |
115 | }; |
142 | }; |
116 | |
143 | |
117 | =item searchable-scrollback<hotkey> (enabled by default) |
144 | =item searchable-scrollback<hotkey> (enabled by default) |
118 | |
145 | |
… | |
… | |
125 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
152 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
126 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
153 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
127 | bottom. C<Escape> leaves search mode and returns to the point where search |
154 | bottom. C<Escape> leaves search mode and returns to the point where search |
128 | was started, while C<Enter> or C<Return> stay at the current position and |
155 | was started, while C<Enter> or C<Return> stay at the current position and |
129 | additionally stores the first match in the current line into the primary |
156 | additionally stores the first match in the current line into the primary |
130 | selection. |
157 | selection if the C<Shift> modifier is active. |
|
|
158 | |
|
|
159 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
|
|
160 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
|
|
161 | or simply use an uppercase character which removes the "(?i)" prefix. |
|
|
162 | |
|
|
163 | See L<perlre> for more info about perl regular expression syntax. |
|
|
164 | |
|
|
165 | =item readline (enabled by default) |
|
|
166 | |
|
|
167 | A support package that tries to make editing with readline easier. At |
|
|
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
|
|
169 | move the text cursor to this position. It does so by generating as many |
|
|
170 | cursor-left or cursor-right keypresses as required (this only works |
|
|
171 | for programs that correctly support wide characters). |
|
|
172 | |
|
|
173 | To avoid too many false positives, this is only done when: |
|
|
174 | |
|
|
175 | =over 4 |
|
|
176 | |
|
|
177 | =item - the tty is in ICANON state. |
|
|
178 | |
|
|
179 | =item - the text cursor is visible. |
|
|
180 | |
|
|
181 | =item - the primary screen is currently being displayed. |
|
|
182 | |
|
|
183 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
184 | |
|
|
185 | =back |
|
|
186 | |
|
|
187 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
188 | might interfere with selection creation in harmless ways. |
131 | |
189 | |
132 | =item selection-autotransform |
190 | =item selection-autotransform |
133 | |
191 | |
134 | This selection allows you to do automatic transforms on a selection |
192 | This selection allows you to do automatic transforms on a selection |
135 | whenever a selection is made. |
193 | whenever a selection is made. |
… | |
… | |
165 | the message into vi commands to load the file. |
223 | the message into vi commands to load the file. |
166 | |
224 | |
167 | =item tabbed |
225 | =item tabbed |
168 | |
226 | |
169 | This transforms the terminal into a tabbar with additional terminals, that |
227 | This transforms the terminal into a tabbar with additional terminals, that |
170 | 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 |
171 | 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 |
172 | button per tab. |
230 | button per tab. |
173 | |
231 | |
174 | Clicking a button will activate that tab. Pressing Shift-Left and |
232 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
175 | 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, |
|
|
234 | while B<Shift-Down> creates a new tab. |
176 | |
235 | |
177 | =item mark-urls |
236 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
237 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
238 | following four resources (shown with defaults): |
178 | |
239 | |
|
|
240 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
241 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
242 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
243 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
244 | |
|
|
245 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
246 | indices. |
|
|
247 | |
|
|
248 | =item matcher |
|
|
249 | |
179 | 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 |
180 | make them clickable. When middle-clicked, the program specified in the |
251 | matching a certain pattern and make it clickable. When clicked with the |
181 | 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 |
182 | 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. |
183 | |
258 | |
184 | =item automove-background |
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. |
185 | |
263 | |
186 | This is basically a one-line extension that dynamically changes the background pixmap offset |
264 | It is possible to activate the most recently seen match from the keyboard. |
187 | to the window position, in effect creating the same effect as pseudo transparency with |
265 | Simply bind a keysym to "perl:matcher" as seen in the example below. |
188 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
189 | |
266 | |
190 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
267 | Example configuration: |
|
|
268 | |
|
|
269 | URxvt.perl-ext: default,matcher |
|
|
270 | URxvt.urlLauncher: sensible-browser |
|
|
271 | URxvt.keysym.C-Delete: perl:matcher |
|
|
272 | URxvt.matcher.button: 1 |
|
|
273 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
274 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
275 | URxvt.matcher.launcher.2: gvim +$2 $1 |
|
|
276 | |
|
|
277 | =item xim-onthespot |
|
|
278 | |
|
|
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
280 | not work perfectly, and some input methods don't seem to work well with |
|
|
281 | OnTheSpot editing in general, but it seems to work at least for SCIM and |
|
|
282 | kinput2. |
|
|
283 | |
|
|
284 | You enable it by specifying this extension and a preedit style of |
|
|
285 | C<OnTheSpot>, i.e.: |
|
|
286 | |
|
|
287 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
288 | |
|
|
289 | =item kuake<hotkey> |
|
|
290 | |
|
|
291 | A very primitive quake-console-like extension. It was inspired by a |
|
|
292 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
293 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
294 | will show or hide itself. Another press of the accelerator key will hide |
|
|
295 | or show it again. |
|
|
296 | |
|
|
297 | Initially, the window will not be shown when using this extension. |
|
|
298 | |
|
|
299 | This is useful if you need a single terminal that is not using any desktop |
|
|
300 | space most of the time but is quickly available at the press of a key. |
|
|
301 | |
|
|
302 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
303 | extension will actually grab a physical key just for this function. |
|
|
304 | |
|
|
305 | If you want a quake-like animation, tell your window manager to do so |
|
|
306 | (fvwm can do it). |
191 | |
307 | |
192 | =item block-graphics-to-ascii |
308 | =item block-graphics-to-ascii |
193 | |
309 | |
194 | A not very useful example of filtering all text output to the terminal, |
310 | A not very useful example of filtering all text output to the terminal |
195 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
311 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
196 | similar-looking ascii character. |
312 | similar-looking ascii character. |
197 | |
313 | |
198 | =item digital-clock |
314 | =item digital-clock |
199 | |
315 | |
200 | Displays a digital clock using the built-in overlay. |
316 | Displays a digital clock using the built-in overlay. |
201 | |
317 | |
202 | =item example-refresh-hooks |
318 | =item remote-clipboard |
203 | |
319 | |
204 | Displays a very simple digital clock in the upper right corner of the |
320 | Somewhat of a misnomer, this extension adds two menu entries to the |
205 | window. Illustrates overwriting the refresh callbacks to create your own |
321 | selection popup that allows one to run external commands to store the |
206 | overlays or changes. |
322 | selection somewhere and fetch it again. |
|
|
323 | |
|
|
324 | We use it to implement a "distributed selection mechanism", which just |
|
|
325 | means that one command uploads the file to a remote server, and another |
|
|
326 | reads it. |
|
|
327 | |
|
|
328 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
329 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
330 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
331 | the selection data on STDOUT (also in UTF-8). |
|
|
332 | |
|
|
333 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
334 | |
|
|
335 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
336 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
207 | |
337 | |
208 | =item selection-pastebin |
338 | =item selection-pastebin |
209 | |
339 | |
210 | This is a little rarely useful extension that Uploads the selection as |
340 | This is a little rarely useful extension that Uploads the selection as |
211 | textfile to a remote site (or does other things). (The implementation is |
341 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
231 | After a successful upload the selection will be replaced by the text given |
361 | After a successful upload the selection will be replaced by the text given |
232 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
362 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
233 | for the filename): |
363 | for the filename): |
234 | |
364 | |
235 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
365 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
366 | |
|
|
367 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
368 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
369 | which works regardless of wether xrdb is used to parse the resource file |
|
|
370 | or not. |
|
|
371 | |
|
|
372 | =item example-refresh-hooks |
|
|
373 | |
|
|
374 | Displays a very simple digital clock in the upper right corner of the |
|
|
375 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
376 | overlays or changes. |
236 | |
377 | |
237 | =back |
378 | =back |
238 | |
379 | |
239 | =head1 API DOCUMENTATION |
380 | =head1 API DOCUMENTATION |
240 | |
381 | |
… | |
… | |
274 | |
415 | |
275 | =back |
416 | =back |
276 | |
417 | |
277 | =head2 Extension Objects |
418 | =head2 Extension Objects |
278 | |
419 | |
279 | Very perl extension is a perl class. A separate perl object is created |
420 | Every perl extension is a perl class. A separate perl object is created |
280 | for each terminal and each extension and passed as the first parameter to |
421 | for each terminal, and each terminal has its own set of extenion objects, |
281 | hooks. So extensions can use their C<$self> object without having to think |
422 | which are passed as the first parameter to hooks. So extensions can use |
282 | about other extensions, with the exception of methods and members that |
423 | their C<$self> object without having to think about clashes with other |
|
|
424 | extensions or other terminals, with the exception of methods and members |
283 | begin with an underscore character C<_>: these are reserved for internal |
425 | that begin with an underscore character C<_>: these are reserved for |
284 | use. |
426 | internal use. |
285 | |
427 | |
286 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
428 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
287 | C<urxvt::term> class on this object. |
429 | C<urxvt::term> class on this object. |
288 | |
430 | |
289 | It has the following methods and data members: |
431 | It has the following methods and data members: |
… | |
… | |
310 | =head2 Hooks |
452 | =head2 Hooks |
311 | |
453 | |
312 | The following subroutines can be declared in extension files, and will be |
454 | The following subroutines can be declared in extension files, and will be |
313 | called whenever the relevant event happens. |
455 | called whenever the relevant event happens. |
314 | |
456 | |
315 | The first argument passed to them is an extension oject as described in |
457 | The first argument passed to them is an extension object as described in |
316 | the in the C<Extension Objects> section. |
458 | the in the C<Extension Objects> section. |
317 | |
459 | |
318 | B<All> of these hooks must return a boolean value. If any of the called |
460 | B<All> of these hooks must return a boolean value. If any of the called |
319 | hooks returns true, then the event counts as being I<consumed>, and the |
461 | hooks returns true, then the event counts as being I<consumed>, and the |
320 | relevant action might not be carried out by the C++ code. |
462 | relevant action might not be carried out by the C++ code. |
… | |
… | |
333 | place. |
475 | place. |
334 | |
476 | |
335 | =item on_start $term |
477 | =item on_start $term |
336 | |
478 | |
337 | Called at the very end of initialisation of a new terminal, just before |
479 | Called at the very end of initialisation of a new terminal, just before |
338 | trying to map (display) the toplevel and returning to the mainloop. |
480 | trying to map (display) the toplevel and returning to the main loop. |
339 | |
481 | |
340 | =item on_destroy $term |
482 | =item on_destroy $term |
341 | |
483 | |
342 | Called whenever something tries to destroy terminal, before doing anything |
484 | Called whenever something tries to destroy terminal, when the terminal is |
343 | yet. If this hook returns true, then destruction is skipped, but this is |
485 | still fully functional (not for long, though). |
344 | rarely a good idea. |
|
|
345 | |
486 | |
346 | =item on_reset $term |
487 | =item on_reset $term |
347 | |
488 | |
348 | Called after the screen is "reset" for any reason, such as resizing or |
489 | Called after the screen is "reset" for any reason, such as resizing or |
349 | control sequences. Here is where you can react on changes to size-related |
490 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
371 | |
512 | |
372 | Called whenever a selection has been copied, but before the selection is |
513 | Called whenever a selection has been copied, but before the selection is |
373 | requested from the server. The selection text can be queried and changed |
514 | requested from the server. The selection text can be queried and changed |
374 | by calling C<< $term->selection >>. |
515 | by calling C<< $term->selection >>. |
375 | |
516 | |
376 | Returning a true value aborts selection grabbing. It will still be hilighted. |
517 | Returning a true value aborts selection grabbing. It will still be highlighted. |
377 | |
518 | |
378 | =item on_sel_extend $term |
519 | =item on_sel_extend $term |
379 | |
520 | |
380 | Called whenever the user tries to extend the selection (e.g. with a double |
521 | Called whenever the user tries to extend the selection (e.g. with a double |
381 | click) and is either supposed to return false (normal operation), or |
522 | click) and is either supposed to return false (normal operation), or |
382 | should extend the selection itelf and return true to suppress the built-in |
523 | should extend the selection itself and return true to suppress the built-in |
383 | processing. This can happen multiple times, as long as the callback |
524 | processing. This can happen multiple times, as long as the callback |
384 | returns true, it will be called on every further click by the user and is |
525 | returns true, it will be called on every further click by the user and is |
385 | supposed to enlarge the selection more and more, if possible. |
526 | supposed to enlarge the selection more and more, if possible. |
386 | |
527 | |
387 | See the F<selection> example extension. |
528 | See the F<selection> example extension. |
388 | |
529 | |
389 | =item on_view_change $term, $offset |
530 | =item on_view_change $term, $offset |
390 | |
531 | |
391 | Called whenever the view offset changes, i..e the user or program |
532 | Called whenever the view offset changes, i.e. the user or program |
392 | scrolls. Offset C<0> means display the normal terminal, positive values |
533 | scrolls. Offset C<0> means display the normal terminal, positive values |
393 | show this many lines of scrollback. |
534 | show this many lines of scrollback. |
394 | |
535 | |
395 | =item on_scroll_back $term, $lines, $saved |
536 | =item on_scroll_back $term, $lines, $saved |
396 | |
537 | |
… | |
… | |
400 | |
541 | |
401 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
542 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
402 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
543 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
403 | number of lines that will be in the scrollback buffer. |
544 | number of lines that will be in the scrollback buffer. |
404 | |
545 | |
|
|
546 | =item on_osc_seq $term, $op, $args |
|
|
547 | |
|
|
548 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
549 | behaviour. The default should be to return an empty list. A true value |
|
|
550 | suppresses execution of the request completely. Make sure you don't get |
|
|
551 | confused by recursive invocations when you output an osc sequence within |
|
|
552 | this callback. |
|
|
553 | |
|
|
554 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
555 | |
405 | =item on_osc_seq $term, $string |
556 | =item on_osc_seq_perl $term, $string |
406 | |
557 | |
407 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
558 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
408 | operating system command) is processed. Cursor position and other state |
559 | operating system command) is processed. Cursor position and other state |
409 | information is up-to-date when this happens. For interoperability, the |
560 | information is up-to-date when this happens. For interoperability, the |
410 | string should start with the extension name and a colon, to distinguish |
561 | string should start with the extension name and a colon, to distinguish |
411 | it from commands for other extensions, and this might be enforced in the |
562 | it from commands for other extensions, and this might be enforced in the |
412 | future. |
563 | future. |
413 | |
564 | |
414 | Be careful not ever to trust (in a security sense) the data you receive, |
565 | Be careful not ever to trust (in a security sense) the data you receive, |
415 | as its source can not easily be controleld (e-mail content, messages from |
566 | as its source can not easily be controlled (e-mail content, messages from |
416 | other users on the same system etc.). |
567 | other users on the same system etc.). |
417 | |
568 | |
418 | =item on_add_lines $term, $string |
569 | =item on_add_lines $term, $string |
419 | |
570 | |
420 | Called whenever text is about to be output, with the text as argument. You |
571 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
451 | |
602 | |
452 | =item on_refresh_end $term |
603 | =item on_refresh_end $term |
453 | |
604 | |
454 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
605 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
455 | |
606 | |
456 | =item on_keyboard_command $term, $string |
607 | =item on_user_command $term, $string |
457 | |
608 | |
458 | Called whenever the user presses a key combination that has a |
609 | Called whenever a user-configured event is being activated (e.g. via |
459 | C<perl:string> action bound to it (see description of the B<keysym> |
610 | a C<perl:string> action bound to a key, see description of the B<keysym> |
460 | resource in the @@RXVT_NAME@@(1) manpage). |
611 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
612 | |
|
|
613 | The event is simply the action string. This interface is assumed to change |
|
|
614 | slightly in the future. |
|
|
615 | |
|
|
616 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
617 | |
|
|
618 | Called just after the new window size has been calculated, but before |
|
|
619 | windows are actually being resized or hints are being set. If this hook |
|
|
620 | returns TRUE, setting of the window hints is being skipped. |
461 | |
621 | |
462 | =item on_x_event $term, $event |
622 | =item on_x_event $term, $event |
463 | |
623 | |
464 | Called on every X event received on the vt window (and possibly other |
624 | Called on every X event received on the vt window (and possibly other |
465 | windows). Should only be used as a last resort. Most event structure |
625 | windows). Should only be used as a last resort. Most event structure |
466 | members are not passed. |
626 | members are not passed. |
467 | |
627 | |
|
|
628 | =item on_root_event $term, $event |
|
|
629 | |
|
|
630 | Like C<on_x_event>, but is called for events on the root window. |
|
|
631 | |
468 | =item on_focus_in $term |
632 | =item on_focus_in $term |
469 | |
633 | |
470 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
634 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
471 | does focus in processing. |
635 | does focus in processing. |
472 | |
636 | |
473 | =item on_focus_out $term |
637 | =item on_focus_out $term |
474 | |
638 | |
475 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
639 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
476 | focus out processing. |
640 | focus out processing. |
477 | |
641 | |
478 | =item on_configure_notify $term, $event |
642 | =item on_configure_notify $term, $event |
|
|
643 | |
|
|
644 | =item on_property_notify $term, $event |
479 | |
645 | |
480 | =item on_key_press $term, $event, $keysym, $octets |
646 | =item on_key_press $term, $event, $keysym, $octets |
481 | |
647 | |
482 | =item on_key_release $term, $event, $keysym |
648 | =item on_key_release $term, $event, $keysym |
483 | |
649 | |
… | |
… | |
493 | |
659 | |
494 | Called whenever the corresponding X event is received for the terminal If |
660 | Called whenever the corresponding X event is received for the terminal If |
495 | the hook returns true, then the even will be ignored by rxvt-unicode. |
661 | the hook returns true, then the even will be ignored by rxvt-unicode. |
496 | |
662 | |
497 | The event is a hash with most values as named by Xlib (see the XEvent |
663 | The event is a hash with most values as named by Xlib (see the XEvent |
498 | manpage), with the additional members C<row> and C<col>, which are the row |
664 | manpage), with the additional members C<row> and C<col>, which are the |
499 | and column under the mouse cursor. |
665 | (real, not screen-based) row and column under the mouse cursor. |
500 | |
666 | |
501 | C<on_key_press> additionally receives the string rxvt-unicode would |
667 | C<on_key_press> additionally receives the string rxvt-unicode would |
502 | output, if any, in locale-specific encoding. |
668 | output, if any, in locale-specific encoding. |
503 | |
669 | |
504 | subwindow. |
670 | subwindow. |
… | |
… | |
535 | our $LIBDIR; |
701 | our $LIBDIR; |
536 | our $RESNAME; |
702 | our $RESNAME; |
537 | our $RESCLASS; |
703 | our $RESCLASS; |
538 | our $RXVTNAME; |
704 | our $RXVTNAME; |
539 | |
705 | |
|
|
706 | our $NOCHAR = chr 0xffff; |
|
|
707 | |
540 | =head2 Variables in the C<urxvt> Package |
708 | =head2 Variables in the C<urxvt> Package |
541 | |
709 | |
542 | =over 4 |
710 | =over 4 |
543 | |
711 | |
544 | =item $urxvt::LIBDIR |
712 | =item $urxvt::LIBDIR |
… | |
… | |
559 | The current terminal. This variable stores the current C<urxvt::term> |
727 | The current terminal. This variable stores the current C<urxvt::term> |
560 | object, whenever a callback/hook is executing. |
728 | object, whenever a callback/hook is executing. |
561 | |
729 | |
562 | =item @urxvt::TERM_INIT |
730 | =item @urxvt::TERM_INIT |
563 | |
731 | |
564 | All coderefs in this array will be called as methods of the next newly |
732 | All code references in this array will be called as methods of the next newly |
565 | created C<urxvt::term> object (during the C<on_init> phase). The array |
733 | created C<urxvt::term> object (during the C<on_init> phase). The array |
566 | gets cleared before the codereferences that were in it are being executed, |
734 | gets cleared before the code references that were in it are being executed, |
567 | so coderefs can push themselves onto it again if they so desire. |
735 | so references can push themselves onto it again if they so desire. |
568 | |
736 | |
569 | This complements to the perl-eval commandline option, but gets executed |
737 | This complements to the perl-eval command line option, but gets executed |
570 | first. |
738 | first. |
571 | |
739 | |
572 | =item @urxvt::TERM_EXT |
740 | =item @urxvt::TERM_EXT |
573 | |
741 | |
574 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
742 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
595 | |
763 | |
596 | Using this function has the advantage that its output ends up in the |
764 | Using this function has the advantage that its output ends up in the |
597 | correct place, e.g. on stderr of the connecting urxvtc client. |
765 | correct place, e.g. on stderr of the connecting urxvtc client. |
598 | |
766 | |
599 | Messages have a size limit of 1023 bytes currently. |
767 | Messages have a size limit of 1023 bytes currently. |
|
|
768 | |
|
|
769 | =item @terms = urxvt::termlist |
|
|
770 | |
|
|
771 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
772 | whether they are started, being destroyed etc., so be careful. Only term |
|
|
773 | objects that have perl extensions attached will be returned (because there |
|
|
774 | is no urxvt::term objet associated with others). |
600 | |
775 | |
601 | =item $time = urxvt::NOW |
776 | =item $time = urxvt::NOW |
602 | |
777 | |
603 | Returns the "current time" (as per the event loop). |
778 | Returns the "current time" (as per the event loop). |
604 | |
779 | |
… | |
… | |
662 | Return the foreground/background colour index, respectively. |
837 | Return the foreground/background colour index, respectively. |
663 | |
838 | |
664 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
839 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
665 | |
840 | |
666 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
841 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
842 | |
|
|
843 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
667 | |
844 | |
668 | Replace the foreground/background colour in the rendition mask with the |
845 | Replace the foreground/background colour in the rendition mask with the |
669 | specified one. |
846 | specified one. |
670 | |
847 | |
671 | =item $value = urxvt::GET_CUSTOM $rend |
848 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
690 | unless $msg =~ /\n$/; |
867 | unless $msg =~ /\n$/; |
691 | urxvt::warn ($msg); |
868 | urxvt::warn ($msg); |
692 | }; |
869 | }; |
693 | } |
870 | } |
694 | |
871 | |
|
|
872 | no warnings 'utf8'; |
|
|
873 | |
695 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
874 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
696 | |
875 | |
697 | sub verbose { |
876 | sub verbose { |
698 | my ($level, $msg) = @_; |
877 | my ($level, $msg) = @_; |
699 | warn "$msg\n" if $level <= $verbosity; |
878 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
715 | |
894 | |
716 | open my $fh, "<:raw", $path |
895 | open my $fh, "<:raw", $path |
717 | or die "$path: $!"; |
896 | or die "$path: $!"; |
718 | |
897 | |
719 | my $source = |
898 | my $source = |
720 | "package $pkg; use strict; use utf8;\n" |
899 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
721 | . "#line 1 \"$path\"\n{\n" |
900 | . "#line 1 \"$path\"\n{\n" |
722 | . (do { local $/; <$fh> }) |
901 | . (do { local $/; <$fh> }) |
723 | . "\n};\n1"; |
902 | . "\n};\n1"; |
724 | |
903 | |
725 | eval $source |
904 | eval $source |
… | |
… | |
736 | local $TERM = shift; |
915 | local $TERM = shift; |
737 | my $htype = shift; |
916 | my $htype = shift; |
738 | |
917 | |
739 | if ($htype == 0) { # INIT |
918 | if ($htype == 0) { # INIT |
740 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
919 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
741 | |
920 | |
742 | my %ext_arg; |
921 | my %ext_arg; |
743 | |
922 | |
744 | { |
923 | { |
745 | my @init = @TERM_INIT; |
924 | my @init = @TERM_INIT; |
746 | @TERM_INIT = (); |
925 | @TERM_INIT = (); |
… | |
… | |
750 | $TERM->register_package ($_) for @pkg; |
929 | $TERM->register_package ($_) for @pkg; |
751 | } |
930 | } |
752 | |
931 | |
753 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
932 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
754 | if ($_ eq "default") { |
933 | if ($_ eq "default") { |
755 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
934 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
756 | } elsif (/^-(.*)$/) { |
935 | } elsif (/^-(.*)$/) { |
757 | delete $ext_arg{$1}; |
936 | delete $ext_arg{$1}; |
758 | } elsif (/^([^<]+)<(.*)>$/) { |
937 | } elsif (/^([^<]+)<(.*)>$/) { |
759 | push @{ $ext_arg{$1} }, $2; |
938 | push @{ $ext_arg{$1} }, $2; |
760 | } else { |
939 | } else { |
761 | $ext_arg{$_} ||= []; |
940 | $ext_arg{$_} ||= []; |
762 | } |
941 | } |
763 | } |
942 | } |
764 | |
943 | |
765 | while (my ($ext, $argv) = each %ext_arg) { |
944 | for my $ext (sort keys %ext_arg) { |
766 | my @files = grep -f $_, map "$_/$ext", @dirs; |
945 | my @files = grep -f $_, map "$_/$ext", @dirs; |
767 | |
946 | |
768 | if (@files) { |
947 | if (@files) { |
769 | $TERM->register_package (extension_package $files[0], $argv); |
948 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
770 | } else { |
949 | } else { |
771 | warn "perl extension '$ext' not found in perl library search path\n"; |
950 | warn "perl extension '$ext' not found in perl library search path\n"; |
772 | } |
951 | } |
773 | } |
952 | } |
774 | |
953 | |
… | |
… | |
780 | |
959 | |
781 | if (my $cb = $TERM->{_hook}[$htype]) { |
960 | if (my $cb = $TERM->{_hook}[$htype]) { |
782 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
961 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
783 | if $verbosity >= 10; |
962 | if $verbosity >= 10; |
784 | |
963 | |
785 | keys %$cb; |
964 | for my $pkg (keys %$cb) { |
786 | |
|
|
787 | while (my ($pkg, $cb) = each %$cb) { |
|
|
788 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
965 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
789 | $retval ||= $retval_; |
966 | $retval ||= $retval_; |
790 | |
967 | |
791 | if ($@) { |
968 | if ($@) { |
792 | $TERM->ungrab; # better to lose the grab than the session |
969 | $TERM->ungrab; # better to lose the grab than the session |
793 | warn $@; |
970 | warn $@; |
… | |
… | |
805 | # clear package |
982 | # clear package |
806 | %$TERM = (); |
983 | %$TERM = (); |
807 | } |
984 | } |
808 | |
985 | |
809 | $retval |
986 | $retval |
|
|
987 | } |
|
|
988 | |
|
|
989 | sub SET_COLOR($$$) { |
|
|
990 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
991 | } |
|
|
992 | |
|
|
993 | sub rend2mask { |
|
|
994 | no strict 'refs'; |
|
|
995 | my ($str, $mask) = (@_, 0); |
|
|
996 | my %color = ( fg => undef, bg => undef ); |
|
|
997 | my @failed; |
|
|
998 | for my $spec ( split /\s+/, $str ) { |
|
|
999 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1000 | $color{lc($1)} = $2; |
|
|
1001 | } else { |
|
|
1002 | my $neg = $spec =~ s/^[-^]//; |
|
|
1003 | unless ( exists &{"RS_$spec"} ) { |
|
|
1004 | push @failed, $spec; |
|
|
1005 | next; |
|
|
1006 | } |
|
|
1007 | my $cur = &{"RS_$spec"}; |
|
|
1008 | if ( $neg ) { |
|
|
1009 | $mask &= ~$cur; |
|
|
1010 | } else { |
|
|
1011 | $mask |= $cur; |
|
|
1012 | } |
|
|
1013 | } |
|
|
1014 | } |
|
|
1015 | ($mask, @color{qw(fg bg)}, \@failed) |
810 | } |
1016 | } |
811 | |
1017 | |
812 | # urxvt::term::extension |
1018 | # urxvt::term::extension |
813 | |
1019 | |
814 | package urxvt::term::extension; |
1020 | package urxvt::term::extension; |
… | |
… | |
927 | sub DESTROY { |
1133 | sub DESTROY { |
928 | $_[0][1]->stop; |
1134 | $_[0][1]->stop; |
929 | } |
1135 | } |
930 | |
1136 | |
931 | sub condvar { |
1137 | sub condvar { |
932 | bless \my $flag, urxvt::anyevent::condvar:: |
1138 | bless \my $flag, urxvt::anyevent:: |
933 | } |
1139 | } |
934 | |
1140 | |
935 | sub urxvt::anyevent::condvar::broadcast { |
1141 | sub broadcast { |
936 | ${$_[0]}++; |
1142 | ${$_[0]}++; |
937 | } |
1143 | } |
938 | |
1144 | |
939 | sub urxvt::anyevent::condvar::wait { |
1145 | sub wait { |
940 | unless (${$_[0]}) { |
1146 | unless (${$_[0]}) { |
941 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1147 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
942 | } |
1148 | } |
|
|
1149 | } |
|
|
1150 | |
|
|
1151 | sub one_event { |
|
|
1152 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
943 | } |
1153 | } |
944 | |
1154 | |
945 | package urxvt::term; |
1155 | package urxvt::term; |
946 | |
1156 | |
947 | =head2 The C<urxvt::term> Class |
1157 | =head2 The C<urxvt::term> Class |
… | |
… | |
983 | hash which defines the environment of the new terminal. |
1193 | hash which defines the environment of the new terminal. |
984 | |
1194 | |
985 | Croaks (and probably outputs an error message) if the new instance |
1195 | Croaks (and probably outputs an error message) if the new instance |
986 | couldn't be created. Returns C<undef> if the new instance didn't |
1196 | couldn't be created. Returns C<undef> if the new instance didn't |
987 | initialise perl, and the terminal object otherwise. The C<init> and |
1197 | initialise perl, and the terminal object otherwise. The C<init> and |
988 | C<start> hooks will be called during this call. |
1198 | C<start> hooks will be called before this call returns, and are free to |
|
|
1199 | refer to global data (which is race free). |
989 | |
1200 | |
990 | =cut |
1201 | =cut |
991 | |
1202 | |
992 | sub new { |
1203 | sub new { |
993 | my ($class, $env, @args) = @_; |
1204 | my ($class, $env, @args) = @_; |
994 | |
1205 | |
|
|
1206 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1207 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1208 | |
995 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1209 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
996 | } |
1210 | } |
997 | |
1211 | |
998 | =item $term->destroy |
1212 | =item $term->destroy |
999 | |
1213 | |
1000 | Destroy the terminal object (close the window, free resources |
1214 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1030 | |
1244 | |
1031 | Returns true if the option specified by C<$optval> is enabled, and |
1245 | Returns true if the option specified by C<$optval> is enabled, and |
1032 | optionally change it. All option values are stored by name in the hash |
1246 | optionally change it. All option values are stored by name in the hash |
1033 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1247 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1034 | |
1248 | |
1035 | Here is a a likely non-exhaustive list of option names, please see the |
1249 | Here is a likely non-exhaustive list of option names, please see the |
1036 | source file F</src/optinc.h> to see the actual list: |
1250 | source file F</src/optinc.h> to see the actual list: |
1037 | |
1251 | |
1038 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1252 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1039 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1253 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1040 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1254 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1057 | likely change). |
1271 | likely change). |
1058 | |
1272 | |
1059 | Please note that resource strings will currently only be freed when the |
1273 | Please note that resource strings will currently only be freed when the |
1060 | terminal is destroyed, so changing options frequently will eat memory. |
1274 | terminal is destroyed, so changing options frequently will eat memory. |
1061 | |
1275 | |
1062 | Here is a a likely non-exhaustive list of resource names, not all of which |
1276 | Here is a likely non-exhaustive list of resource names, not all of which |
1063 | are supported in every build, please see the source file F</src/rsinc.h> |
1277 | are supported in every build, please see the source file F</src/rsinc.h> |
1064 | to see the actual list: |
1278 | to see the actual list: |
1065 | |
1279 | |
1066 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1280 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1067 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1281 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1257 | |
1471 | |
1258 | Normally its not a good idea to use this function, as programs might be |
1472 | Normally its not a good idea to use this function, as programs might be |
1259 | confused by changes in cursor position or scrolling. Its useful inside a |
1473 | confused by changes in cursor position or scrolling. Its useful inside a |
1260 | C<on_add_lines> hook, though. |
1474 | C<on_add_lines> hook, though. |
1261 | |
1475 | |
|
|
1476 | =item $term->scr_change_screen ($screen) |
|
|
1477 | |
|
|
1478 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1479 | |
1262 | =item $term->cmd_parse ($octets) |
1480 | =item $term->cmd_parse ($octets) |
1263 | |
1481 | |
1264 | Similar to C<scr_add_lines>, but the argument must be in the |
1482 | Similar to C<scr_add_lines>, but the argument must be in the |
1265 | locale-specific encoding of the terminal and can contain command sequences |
1483 | locale-specific encoding of the terminal and can contain command sequences |
1266 | (escape codes) that will be interpreted. |
1484 | (escape codes) that will be interpreted. |
… | |
… | |
1276 | Replaces the event mask of the pty watcher by the given event mask. Can |
1494 | Replaces the event mask of the pty watcher by the given event mask. Can |
1277 | be used to suppress input and output handling to the pty/tty. See the |
1495 | be used to suppress input and output handling to the pty/tty. See the |
1278 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1496 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1279 | the previous value. |
1497 | the previous value. |
1280 | |
1498 | |
|
|
1499 | =item $fd = $term->pty_fd |
|
|
1500 | |
|
|
1501 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1502 | is used. |
|
|
1503 | |
1281 | =item $windowid = $term->parent |
1504 | =item $windowid = $term->parent |
1282 | |
1505 | |
1283 | Return the window id of the toplevel window. |
1506 | Return the window id of the toplevel window. |
1284 | |
1507 | |
1285 | =item $windowid = $term->vt |
1508 | =item $windowid = $term->vt |
… | |
… | |
1291 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1514 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1292 | to receive pointer events all the times: |
1515 | to receive pointer events all the times: |
1293 | |
1516 | |
1294 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1517 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1295 | |
1518 | |
|
|
1519 | =item $term->focus_in |
|
|
1520 | |
|
|
1521 | =item $term->focus_out |
|
|
1522 | |
|
|
1523 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1524 | |
|
|
1525 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1526 | |
|
|
1527 | Deliver various fake events to to terminal. |
|
|
1528 | |
1296 | =item $window_width = $term->width |
1529 | =item $window_width = $term->width |
1297 | |
1530 | |
1298 | =item $window_height = $term->height |
1531 | =item $window_height = $term->height |
1299 | |
1532 | |
1300 | =item $font_width = $term->fwidth |
1533 | =item $font_width = $term->fwidth |
… | |
… | |
1330 | =item $env = $term->env |
1563 | =item $env = $term->env |
1331 | |
1564 | |
1332 | Returns a copy of the environment in effect for the terminal as a hashref |
1565 | Returns a copy of the environment in effect for the terminal as a hashref |
1333 | similar to C<\%ENV>. |
1566 | similar to C<\%ENV>. |
1334 | |
1567 | |
|
|
1568 | =item @envv = $term->envv |
|
|
1569 | |
|
|
1570 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1571 | |
|
|
1572 | =item @argv = $term->argv |
|
|
1573 | |
|
|
1574 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1575 | includes the program name as first element. |
|
|
1576 | |
1335 | =cut |
1577 | =cut |
1336 | |
1578 | |
1337 | sub env { |
1579 | sub env { |
1338 | if (my $env = $_[0]->_env) { |
|
|
1339 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1580 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1340 | } else { |
|
|
1341 | +{ %ENV } |
|
|
1342 | } |
|
|
1343 | } |
1581 | } |
1344 | |
1582 | |
1345 | =item $modifiermask = $term->ModLevel3Mask |
1583 | =item $modifiermask = $term->ModLevel3Mask |
1346 | |
1584 | |
1347 | =item $modifiermask = $term->ModMetaMask |
1585 | =item $modifiermask = $term->ModMetaMask |
1348 | |
1586 | |
1349 | =item $modifiermask = $term->ModNumLockMask |
1587 | =item $modifiermask = $term->ModNumLockMask |
1350 | |
1588 | |
1351 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1589 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1352 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1590 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1591 | |
|
|
1592 | =item $screen = $term->current_screen |
|
|
1593 | |
|
|
1594 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1595 | |
|
|
1596 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1597 | |
|
|
1598 | Returns whether the cursor is currently hidden or not. |
1353 | |
1599 | |
1354 | =item $view_start = $term->view_start ([$newvalue]) |
1600 | =item $view_start = $term->view_start ([$newvalue]) |
1355 | |
1601 | |
1356 | Returns the row number of the topmost displayed line. Maximum value is |
1602 | Returns the row number of the topmost displayed line. Maximum value is |
1357 | C<0>, which displays the normal terminal contents. Lower values scroll |
1603 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1377 | line, starting at column C<$start_col> (default C<0>), which is useful |
1623 | line, starting at column C<$start_col> (default C<0>), which is useful |
1378 | to replace only parts of a line. The font index in the rendition will |
1624 | to replace only parts of a line. The font index in the rendition will |
1379 | automatically be updated. |
1625 | automatically be updated. |
1380 | |
1626 | |
1381 | C<$text> is in a special encoding: tabs and wide characters that use more |
1627 | C<$text> is in a special encoding: tabs and wide characters that use more |
1382 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1628 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1383 | (C<chr 65535>). Characters with combining characters and other characters |
1629 | characters. Characters with combining characters and other characters that |
1384 | that do not fit into the normal tetx encoding will be replaced with |
1630 | do not fit into the normal text encoding will be replaced with characters |
1385 | characters in the private use area. |
1631 | in the private use area. |
1386 | |
1632 | |
1387 | You have to obey this encoding when changing text. The advantage is |
1633 | You have to obey this encoding when changing text. The advantage is |
1388 | that C<substr> and similar functions work on screen cells and not on |
1634 | that C<substr> and similar functions work on screen cells and not on |
1389 | characters. |
1635 | characters. |
1390 | |
1636 | |
… | |
… | |
1534 | where one character corresponds to one screen cell. See |
1780 | where one character corresponds to one screen cell. See |
1535 | C<< $term->ROW_t >> for details. |
1781 | C<< $term->ROW_t >> for details. |
1536 | |
1782 | |
1537 | =item $string = $term->special_decode $text |
1783 | =item $string = $term->special_decode $text |
1538 | |
1784 | |
1539 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1785 | Converts rxvt-unicodes text representation into a perl string. See |
1540 | C<< $term->ROW_t >> for details. |
1786 | C<< $term->ROW_t >> for details. |
1541 | |
1787 | |
1542 | =item $success = $term->grab_button ($button, $modifiermask) |
1788 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1543 | |
1789 | |
|
|
1790 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1791 | |
1544 | Registers a synchronous button grab. See the XGrabButton manpage. |
1792 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1793 | manpage. |
1545 | |
1794 | |
1546 | =item $success = $term->grab ($eventtime[, $sync]) |
1795 | =item $success = $term->grab ($eventtime[, $sync]) |
1547 | |
1796 | |
1548 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1797 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1549 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1798 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1550 | |
1799 | |
1551 | =item $term->allow_events_async |
1800 | =item $term->allow_events_async |
1552 | |
1801 | |
1553 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1802 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1554 | |
1803 | |
… | |
… | |
1564 | =item $term->ungrab |
1813 | =item $term->ungrab |
1565 | |
1814 | |
1566 | Calls XUngrab for the most recent grab. Is called automatically on |
1815 | Calls XUngrab for the most recent grab. Is called automatically on |
1567 | evaluation errors, as it is better to lose the grab in the error case as |
1816 | evaluation errors, as it is better to lose the grab in the error case as |
1568 | the session. |
1817 | the session. |
|
|
1818 | |
|
|
1819 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1820 | |
|
|
1821 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1822 | |
|
|
1823 | =item @atoms = $term->XListProperties ($window) |
|
|
1824 | |
|
|
1825 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1826 | |
|
|
1827 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1828 | |
|
|
1829 | =item $term->XDeleteProperty ($window, $property) |
|
|
1830 | |
|
|
1831 | =item $window = $term->DefaultRootWindow |
|
|
1832 | |
|
|
1833 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1834 | |
|
|
1835 | =item $term->XMapWindow ($window) |
|
|
1836 | |
|
|
1837 | =item $term->XUnmapWindow ($window) |
|
|
1838 | |
|
|
1839 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1840 | |
|
|
1841 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1842 | |
|
|
1843 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1844 | |
|
|
1845 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1846 | the source of the display, otherwise those functions map more-or-less |
|
|
1847 | directory onto the X functions of the same name. |
1569 | |
1848 | |
1570 | =back |
1849 | =back |
1571 | |
1850 | |
1572 | =cut |
1851 | =cut |
1573 | |
1852 | |
… | |
… | |
1637 | my ($self, $text, $cb) = @_; |
1916 | my ($self, $text, $cb) = @_; |
1638 | |
1917 | |
1639 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1918 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1640 | } |
1919 | } |
1641 | |
1920 | |
1642 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1921 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1643 | |
1922 | |
1644 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1923 | Adds a toggle/checkbox item to the popup. The callback gets called |
1645 | whenever it gets toggled, with a boolean indicating its value as its first |
1924 | whenever it gets toggled, with a boolean indicating its new value as its |
1646 | argument. |
1925 | first argument. |
1647 | |
1926 | |
1648 | =cut |
1927 | =cut |
1649 | |
1928 | |
1650 | sub add_toggle { |
1929 | sub add_toggle { |
1651 | my ($self, $text, $cb, $value) = @_; |
1930 | my ($self, $text, $value, $cb) = @_; |
1652 | |
1931 | |
1653 | my $item; $item = { |
1932 | my $item; $item = { |
1654 | type => "button", |
1933 | type => "button", |
1655 | text => " $text", |
1934 | text => " $text", |
1656 | value => $value, |
1935 | value => $value, |
… | |
… | |
1698 | |
1977 | |
1699 | =cut |
1978 | =cut |
1700 | |
1979 | |
1701 | package urxvt::watcher; |
1980 | package urxvt::watcher; |
1702 | |
1981 | |
1703 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1704 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1705 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1706 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1707 | |
|
|
1708 | =head2 The C<urxvt::timer> Class |
1982 | =head2 The C<urxvt::timer> Class |
1709 | |
1983 | |
1710 | This class implements timer watchers/events. Time is represented as a |
1984 | This class implements timer watchers/events. Time is represented as a |
1711 | fractional number of seconds since the epoch. Example: |
1985 | fractional number of seconds since the epoch. Example: |
1712 | |
1986 | |
… | |
… | |
1715 | ->new |
1989 | ->new |
1716 | ->interval (1) |
1990 | ->interval (1) |
1717 | ->cb (sub { |
1991 | ->cb (sub { |
1718 | $term->{overlay}->set (0, 0, |
1992 | $term->{overlay}->set (0, 0, |
1719 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1993 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1720 | }); |
1994 | }); |
1721 | |
1995 | |
1722 | =over 4 |
1996 | =over 4 |
1723 | |
1997 | |
1724 | =item $timer = new urxvt::timer |
1998 | =item $timer = new urxvt::timer |
1725 | |
1999 | |
… | |
… | |
1768 | |
2042 | |
1769 | $term->{socket} = ... |
2043 | $term->{socket} = ... |
1770 | $term->{iow} = urxvt::iow |
2044 | $term->{iow} = urxvt::iow |
1771 | ->new |
2045 | ->new |
1772 | ->fd (fileno $term->{socket}) |
2046 | ->fd (fileno $term->{socket}) |
1773 | ->events (urxvt::EVENT_READ) |
2047 | ->events (urxvt::EV_READ) |
1774 | ->start |
2048 | ->start |
1775 | ->cb (sub { |
2049 | ->cb (sub { |
1776 | my ($iow, $revents) = @_; |
2050 | my ($iow, $revents) = @_; |
1777 | # $revents must be 1 here, no need to check |
2051 | # $revents must be 1 here, no need to check |
1778 | sysread $term->{socket}, my $buf, 8192 |
2052 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1791 | Set the callback to be called when io events are triggered. C<$reventmask> |
2065 | Set the callback to be called when io events are triggered. C<$reventmask> |
1792 | is a bitset as described in the C<events> method. |
2066 | is a bitset as described in the C<events> method. |
1793 | |
2067 | |
1794 | =item $iow = $iow->fd ($fd) |
2068 | =item $iow = $iow->fd ($fd) |
1795 | |
2069 | |
1796 | Set the filedescriptor (not handle) to watch. |
2070 | Set the file descriptor (not handle) to watch. |
1797 | |
2071 | |
1798 | =item $iow = $iow->events ($eventmask) |
2072 | =item $iow = $iow->events ($eventmask) |
1799 | |
2073 | |
1800 | Set the event mask to watch. The only allowed values are |
2074 | Set the event mask to watch. The only allowed values are |
1801 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2075 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
1802 | together, or C<urxvt::EVENT_NONE>. |
2076 | together, or C<urxvt::EV_NONE>. |
1803 | |
2077 | |
1804 | =item $iow = $iow->start |
2078 | =item $iow = $iow->start |
1805 | |
2079 | |
1806 | Start watching for requested events on the given handle. |
2080 | Start watching for requested events on the given handle. |
1807 | |
2081 | |
1808 | =item $iow = $iow->stop |
2082 | =item $iow = $iow->stop |
1809 | |
2083 | |
1810 | Stop watching for events on the given filehandle. |
2084 | Stop watching for events on the given file handle. |
1811 | |
2085 | |
1812 | =back |
2086 | =back |
1813 | |
2087 | |
1814 | =head2 The C<urxvt::iw> Class |
2088 | =head2 The C<urxvt::iw> Class |
1815 | |
2089 | |
… | |
… | |
1848 | ->new |
2122 | ->new |
1849 | ->start ($pid) |
2123 | ->start ($pid) |
1850 | ->cb (sub { |
2124 | ->cb (sub { |
1851 | my ($pw, $exit_status) = @_; |
2125 | my ($pw, $exit_status) = @_; |
1852 | ... |
2126 | ... |
1853 | }); |
2127 | }); |
1854 | |
2128 | |
1855 | =over 4 |
2129 | =over 4 |
1856 | |
2130 | |
1857 | =item $pw = new urxvt::pw |
2131 | =item $pw = new urxvt::pw |
1858 | |
2132 | |
… | |
… | |
1862 | |
2136 | |
1863 | Set the callback to be called when the timer triggers. |
2137 | Set the callback to be called when the timer triggers. |
1864 | |
2138 | |
1865 | =item $pw = $timer->start ($pid) |
2139 | =item $pw = $timer->start ($pid) |
1866 | |
2140 | |
1867 | Tells the wqtcher to start watching for process C<$pid>. |
2141 | Tells the watcher to start watching for process C<$pid>. |
1868 | |
2142 | |
1869 | =item $pw = $pw->stop |
2143 | =item $pw = $pw->stop |
1870 | |
2144 | |
1871 | Stop the watcher. |
2145 | Stop the watcher. |
1872 | |
2146 | |
… | |
… | |
1885 | |
2159 | |
1886 | =item >= 3 - script loading and management |
2160 | =item >= 3 - script loading and management |
1887 | |
2161 | |
1888 | =item >=10 - all called hooks |
2162 | =item >=10 - all called hooks |
1889 | |
2163 | |
1890 | =item >=11 - hook reutrn values |
2164 | =item >=11 - hook return values |
1891 | |
2165 | |
1892 | =back |
2166 | =back |
1893 | |
2167 | |
1894 | =head1 AUTHOR |
2168 | =head1 AUTHOR |
1895 | |
2169 | |
… | |
… | |
1897 | http://software.schmorp.de/pkg/rxvt-unicode |
2171 | http://software.schmorp.de/pkg/rxvt-unicode |
1898 | |
2172 | |
1899 | =cut |
2173 | =cut |
1900 | |
2174 | |
1901 | 1 |
2175 | 1 |
|
|
2176 | |
|
|
2177 | # vim: sw=3: |