… | |
… | |
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 | |
36 | You can activate them like this: |
39 | You can activate them like this: |
37 | |
40 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
41 | @@RXVT_NAME@@ -pe <extensionname> |
39 | |
42 | |
|
|
43 | Or by adding them to the resource for extensions loaded by default: |
|
|
44 | |
|
|
45 | URxvt.perl-ext-common: default,selection-autotransform |
|
|
46 | |
40 | =over 4 |
47 | =over 4 |
41 | |
48 | |
42 | =item selection (enabled by default) |
49 | =item selection (enabled by default) |
43 | |
50 | |
44 | (More) intelligent selection. This extension tries to be more intelligent |
51 | (More) intelligent selection. This extension tries to be more intelligent |
45 | when the user extends selections (double-click). Right now, it tries to |
52 | when the user extends selections (double-click and further clicks). Right |
46 | select urls and complete shell-quoted arguments, which is very convenient, |
53 | now, it tries to select words, urls and complete shell-quoted |
47 | too, if your F<ls> supports C<--quoting-style=shell>. |
54 | arguments, which is very convenient, too, if your F<ls> supports |
|
|
55 | C<--quoting-style=shell>. |
48 | |
56 | |
|
|
57 | A double-click usually selects the word under the cursor, further clicks |
|
|
58 | will enlarge the selection. |
|
|
59 | |
|
|
60 | The selection works by trying to match a number of regexes and displaying |
|
|
61 | them in increasing order of length. You can add your own regexes by |
|
|
62 | specifying resources of the form: |
|
|
63 | |
|
|
64 | URxvt.selection.pattern-0: perl-regex |
|
|
65 | URxvt.selection.pattern-1: perl-regex |
|
|
66 | ... |
|
|
67 | |
|
|
68 | The index number (0, 1...) must not have any holes, and each regex must |
|
|
69 | contain at least one pair of capturing parentheses, which will be used for |
|
|
70 | the match. For example, the following adds a regex that matches everything |
|
|
71 | between two vertical bars: |
|
|
72 | |
|
|
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: ^(/[^:]+):\ |
|
|
81 | |
|
|
82 | You can look at the source of the selection extension to see more |
|
|
83 | interesting uses, such as parsing a line from beginning to end. |
|
|
84 | |
49 | It also offers the following bindable keyboard command: |
85 | This extension also offers following bindable keyboard commands: |
50 | |
86 | |
51 | =over 4 |
87 | =over 4 |
52 | |
88 | |
53 | =item rot13 |
89 | =item rot13 |
54 | |
90 | |
… | |
… | |
61 | =item option-popup (enabled by default) |
97 | =item option-popup (enabled by default) |
62 | |
98 | |
63 | 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 |
64 | runtime. |
100 | runtime. |
65 | |
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 | |
66 | =item selection-popup (enabled by default) |
119 | =item selection-popup (enabled by default) |
67 | |
120 | |
68 | 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 |
69 | text into various other formats/action (such as uri unescaping, perl |
122 | text into various other formats/action (such as uri unescaping, perl |
70 | evalution, web-browser starting etc.), depending on content. |
123 | evaluation, web-browser starting etc.), depending on content. |
|
|
124 | |
|
|
125 | Other extensions can extend this popup menu by pushing a code reference |
|
|
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
|
|
127 | popup is being displayed. |
|
|
128 | |
|
|
129 | Its sole argument is the popup menu, which can be modified. The selection |
|
|
130 | is in C<$_>, which can be used to decide whether to add something or not. |
|
|
131 | It should either return nothing or a string and a code reference. The |
|
|
132 | string will be used as button text and the code reference will be called |
|
|
133 | when the button gets activated and should transform C<$_>. |
|
|
134 | |
|
|
135 | The following will add an entry C<a to b> that transforms all C<a>s in |
|
|
136 | the selection to C<b>s, but only if the selection currently contains any |
|
|
137 | C<a>s: |
|
|
138 | |
|
|
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
140 | /a/ ? ("a to b" => sub { s/a/b/g } |
|
|
141 | : () |
|
|
142 | }; |
71 | |
143 | |
72 | =item searchable-scrollback<hotkey> (enabled by default) |
144 | =item searchable-scrollback<hotkey> (enabled by default) |
73 | |
145 | |
74 | Adds regex search functionality to the scrollback buffer, triggered |
146 | Adds regex search functionality to the scrollback buffer, triggered |
75 | by a hotkey (default: C<M-s>). When in search mode, normal terminal |
147 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
76 | input/output is suspended. |
148 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
149 | screen. |
77 | |
150 | |
78 | C</> starts an incremental regex search, C<n> searches further, C<p> or |
151 | Inputting characters appends them to the regex and continues incremental |
79 | C<N> jump to the previous match, C<G> jumps to the bottom and clears the |
152 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
80 | history, C<enter> leaves search mode at the current position and C<escape> |
153 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
81 | returns to the original position. |
154 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
155 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
156 | additionally stores the first match in the current line into the primary |
|
|
157 | selection if the C<Shift> modifier is active. |
82 | |
158 | |
83 | =item digital-clock |
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. |
84 | |
162 | |
85 | Displays a digital clock using the built-in overlay. |
163 | See L<perlre> for more info about perl regular expression syntax. |
86 | |
164 | |
87 | =item mark-urls |
165 | =item readline (enabled by default) |
88 | |
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. |
|
|
189 | |
|
|
190 | =item selection-autotransform |
|
|
191 | |
|
|
192 | This selection allows you to do automatic transforms on a selection |
|
|
193 | whenever a selection is made. |
|
|
194 | |
|
|
195 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
196 | operator) that modify C<$_> as resources: |
|
|
197 | |
|
|
198 | URxvt.selection-autotransform.0: transform |
|
|
199 | URxvt.selection-autotransform.1: transform |
|
|
200 | ... |
|
|
201 | |
|
|
202 | For example, the following will transform selections of the form |
|
|
203 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
204 | $word>: |
|
|
205 | |
|
|
206 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
207 | |
|
|
208 | And this example matches the same,but replaces it with vi-commands you can |
|
|
209 | paste directly into your (vi :) editor: |
|
|
210 | |
|
|
211 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
212 | |
|
|
213 | Of course, this can be modified to suit your needs and your editor :) |
|
|
214 | |
|
|
215 | To expand the example above to typical perl error messages ("XXX at |
|
|
216 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
217 | |
|
|
218 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
219 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
220 | |
|
|
221 | The first line tells the selection code to treat the unchanging part of |
|
|
222 | every error message as a selection pattern, and the second line transforms |
|
|
223 | the message into vi commands to load the file. |
|
|
224 | |
|
|
225 | =item tabbed |
|
|
226 | |
|
|
227 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
228 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
|
|
229 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
230 | button per tab. |
|
|
231 | |
|
|
232 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
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. |
|
|
235 | |
|
|
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): |
|
|
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 | |
89 | 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 |
90 | make them clickable. When clicked, the program specified in the resource |
251 | matching a certain pattern and make it clickable. When clicked with the |
91 | C<urlLauncher> (default C<x-www-browser>) will be started. |
252 | mouse button specified in the C<matcher.button> resource (default 2, or |
|
|
253 | middle), the program specified in the C<matcher.launcher> resource |
|
|
254 | (default, the C<urlLauncher> resource, C<sensible-browser>) will be started |
|
|
255 | with the matched text as first argument. The default configuration is |
|
|
256 | suitable for matching URLs and launching a web browser, like the |
|
|
257 | former "mark-urls" extension. |
|
|
258 | |
|
|
259 | The default pattern to match URLs can be overridden with the |
|
|
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
|
|
261 | with numbered patterns, in a manner similar to the "selection" extension. |
|
|
262 | The launcher can also be overridden on a per-pattern basis. |
|
|
263 | |
|
|
264 | It is possible to activate the most recently seen match or a list of matches |
|
|
265 | from the keyboard. Simply bind a keysym to "perl:matcher:last" or |
|
|
266 | "perl:matcher:list" as seen in the example below. |
|
|
267 | |
|
|
268 | Example configuration: |
|
|
269 | |
|
|
270 | URxvt.perl-ext: default,matcher |
|
|
271 | URxvt.urlLauncher: sensible-browser |
|
|
272 | URxvt.keysym.C-Delete: perl:matcher:last |
|
|
273 | URxvt.keysym.M-Delete: perl:matcher:list |
|
|
274 | URxvt.matcher.button: 1 |
|
|
275 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
276 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
277 | URxvt.matcher.launcher.2: gvim +$2 $1 |
|
|
278 | |
|
|
279 | =item xim-onthespot |
|
|
280 | |
|
|
281 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
282 | not work perfectly, and some input methods don't seem to work well with |
|
|
283 | OnTheSpot editing in general, but it seems to work at least for SCIM and |
|
|
284 | kinput2. |
|
|
285 | |
|
|
286 | You enable it by specifying this extension and a preedit style of |
|
|
287 | C<OnTheSpot>, i.e.: |
|
|
288 | |
|
|
289 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
290 | |
|
|
291 | =item kuake<hotkey> |
|
|
292 | |
|
|
293 | A very primitive quake-console-like extension. It was inspired by a |
|
|
294 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
295 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
296 | will show or hide itself. Another press of the accelerator key will hide |
|
|
297 | or show it again. |
|
|
298 | |
|
|
299 | Initially, the window will not be shown when using this extension. |
|
|
300 | |
|
|
301 | This is useful if you need a single terminal that is not using any desktop |
|
|
302 | space most of the time but is quickly available at the press of a key. |
|
|
303 | |
|
|
304 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
305 | extension will actually grab a physical key just for this function. |
|
|
306 | |
|
|
307 | If you want a quake-like animation, tell your window manager to do so |
|
|
308 | (fvwm can do it). |
|
|
309 | |
|
|
310 | =item overlay-osc |
|
|
311 | |
|
|
312 | This extension implements some OSC commands to display timed popups on the |
|
|
313 | screen - useful for status displays from within scripts. You have to read |
|
|
314 | the sources for more info. |
92 | |
315 | |
93 | =item block-graphics-to-ascii |
316 | =item block-graphics-to-ascii |
94 | |
317 | |
95 | A not very useful example of filtering all text output to the terminal, |
318 | A not very useful example of filtering all text output to the terminal |
96 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
319 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
97 | similar-looking ascii character. |
320 | similar-looking ascii character. |
|
|
321 | |
|
|
322 | =item digital-clock |
|
|
323 | |
|
|
324 | Displays a digital clock using the built-in overlay. |
|
|
325 | |
|
|
326 | =item remote-clipboard |
|
|
327 | |
|
|
328 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
329 | selection popup that allows one to run external commands to store the |
|
|
330 | selection somewhere and fetch it again. |
|
|
331 | |
|
|
332 | We use it to implement a "distributed selection mechanism", which just |
|
|
333 | means that one command uploads the file to a remote server, and another |
|
|
334 | reads it. |
|
|
335 | |
|
|
336 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
337 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
338 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
339 | the selection data on STDOUT (also in UTF-8). |
|
|
340 | |
|
|
341 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
342 | |
|
|
343 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
344 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
|
|
345 | |
|
|
346 | =item selection-pastebin |
|
|
347 | |
|
|
348 | This is a little rarely useful extension that uploads the selection as |
|
|
349 | textfile to a remote site (or does other things). (The implementation is |
|
|
350 | not currently secure for use in a multiuser environment as it writes to |
|
|
351 | F</tmp> directly.). |
|
|
352 | |
|
|
353 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
354 | i.e. |
|
|
355 | |
|
|
356 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
357 | |
|
|
358 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
359 | the textfile. This command can be set via a resource: |
|
|
360 | |
|
|
361 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
362 | |
|
|
363 | And the default is likely not useful to anybody but the few people around |
|
|
364 | here :) |
|
|
365 | |
|
|
366 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
367 | the same content should lead to the same filename. |
|
|
368 | |
|
|
369 | After a successful upload the selection will be replaced by the text given |
|
|
370 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
371 | for the filename): |
|
|
372 | |
|
|
373 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
374 | |
|
|
375 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
376 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
377 | which works regardless of whether xrdb is used to parse the resource file |
|
|
378 | or not. |
|
|
379 | |
|
|
380 | =item macosx-clipboard and macosx-clipboard-native |
|
|
381 | |
|
|
382 | These two modules implement an extended clipboard for Mac OS X. They are |
|
|
383 | used like this: |
|
|
384 | |
|
|
385 | URxvt.perl-ext-common: default,macosx-clipboard |
|
|
386 | URxvt.keysym.M-c: perl:macosx-clipboard:copy |
|
|
387 | URxvt.keysym.M-v: perl:macosx-clipboard:paste |
|
|
388 | |
|
|
389 | The difference between them is that the native variant requires a |
|
|
390 | perl from apple's devkit or so, and C<macosx-clipboard> requires the |
|
|
391 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
|
|
392 | simpler etc. etc. |
98 | |
393 | |
99 | =item example-refresh-hooks |
394 | =item example-refresh-hooks |
100 | |
395 | |
101 | Displays a very simple digital clock in the upper right corner of the |
396 | Displays a very simple digital clock in the upper right corner of the |
102 | window. Illustrates overwriting the refresh callbacks to create your own |
397 | window. Illustrates overwriting the refresh callbacks to create your own |
103 | overlays or changes. |
398 | overlays or changes. |
|
|
399 | |
|
|
400 | =item confirm-paste |
|
|
401 | |
|
|
402 | Displays a confirmation dialog when a paste containing at least a full |
|
|
403 | line is detected. |
104 | |
404 | |
105 | =back |
405 | =back |
106 | |
406 | |
107 | =head1 API DOCUMENTATION |
407 | =head1 API DOCUMENTATION |
108 | |
408 | |
… | |
… | |
124 | |
424 | |
125 | =over 4 |
425 | =over 4 |
126 | |
426 | |
127 | =item $text |
427 | =item $text |
128 | |
428 | |
129 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
429 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
130 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
430 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
131 | |
431 | |
132 | =item $string |
432 | =item $string |
133 | |
433 | |
134 | A perl text string, with an emphasis on I<text>. It can store all unicode |
434 | A perl text string, with an emphasis on I<text>. It can store all unicode |
… | |
… | |
142 | |
442 | |
143 | =back |
443 | =back |
144 | |
444 | |
145 | =head2 Extension Objects |
445 | =head2 Extension Objects |
146 | |
446 | |
147 | Very perl extension is a perl class. A separate perl object is created |
447 | Every perl extension is a perl class. A separate perl object is created |
148 | for each terminal and each extension and passed as the first parameter to |
448 | for each terminal, and each terminal has its own set of extension objects, |
149 | hooks. So extensions can use their C<$self> object without having to think |
449 | which are passed as the first parameter to hooks. So extensions can use |
150 | about other extensions, with the exception of methods and members that |
450 | their C<$self> object without having to think about clashes with other |
|
|
451 | extensions or other terminals, with the exception of methods and members |
151 | begin with an underscore character C<_>: these are reserved for internal |
452 | that begin with an underscore character C<_>: these are reserved for |
152 | use. |
453 | internal use. |
153 | |
454 | |
154 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
455 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
155 | C<urxvt::term> class on this object. |
456 | C<urxvt::term> class on this object. |
156 | |
457 | |
157 | It has the following methods and data members: |
458 | It has the following methods and data members: |
… | |
… | |
178 | =head2 Hooks |
479 | =head2 Hooks |
179 | |
480 | |
180 | The following subroutines can be declared in extension files, and will be |
481 | The following subroutines can be declared in extension files, and will be |
181 | called whenever the relevant event happens. |
482 | called whenever the relevant event happens. |
182 | |
483 | |
183 | The first argument passed to them is an extension oject as described in |
484 | The first argument passed to them is an extension object as described in |
184 | the in the C<Extension Objects> section. |
485 | the in the C<Extension Objects> section. |
185 | |
486 | |
186 | B<All> of these hooks must return a boolean value. If it is true, then the |
487 | B<All> of these hooks must return a boolean value. If any of the called |
187 | event counts as being I<consumed>, and the invocation of other hooks is |
488 | hooks returns true, then the event counts as being I<consumed>, and the |
188 | skipped, and the relevant action might not be carried out by the C++ code. |
489 | relevant action might not be carried out by the C++ code. |
189 | |
490 | |
190 | I<< When in doubt, return a false value (preferably C<()>). >> |
491 | I<< When in doubt, return a false value (preferably C<()>). >> |
191 | |
492 | |
192 | =over 4 |
493 | =over 4 |
193 | |
494 | |
194 | =item on_init $term |
495 | =item on_init $term |
195 | |
496 | |
196 | Called after a new terminal object has been initialized, but before |
497 | Called after a new terminal object has been initialized, but before |
197 | windows are created or the command gets run. Most methods are unsafe to |
498 | windows are created or the command gets run. Most methods are unsafe to |
198 | call or deliver senseless data, as terminal size and other characteristics |
499 | call or deliver senseless data, as terminal size and other characteristics |
199 | have not yet been determined. You can safely query and change resources, |
500 | have not yet been determined. You can safely query and change resources |
200 | though. |
501 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
502 | place. |
|
|
503 | |
|
|
504 | =item on_start $term |
|
|
505 | |
|
|
506 | Called at the very end of initialisation of a new terminal, just before |
|
|
507 | trying to map (display) the toplevel and returning to the main loop. |
|
|
508 | |
|
|
509 | =item on_destroy $term |
|
|
510 | |
|
|
511 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
512 | still fully functional (not for long, though). |
201 | |
513 | |
202 | =item on_reset $term |
514 | =item on_reset $term |
203 | |
515 | |
204 | Called after the screen is "reset" for any reason, such as resizing or |
516 | Called after the screen is "reset" for any reason, such as resizing or |
205 | control sequences. Here is where you can react on changes to size-related |
517 | control sequences. Here is where you can react on changes to size-related |
206 | variables. |
518 | variables. |
207 | |
519 | |
208 | =item on_start $term |
520 | =item on_child_start $term, $pid |
209 | |
521 | |
210 | Called at the very end of initialisation of a new terminal, just before |
522 | Called just after the child process has been C<fork>ed. |
211 | returning to the mainloop. |
523 | |
|
|
524 | =item on_child_exit $term, $status |
|
|
525 | |
|
|
526 | Called just after the child process has exited. C<$status> is the status |
|
|
527 | from C<waitpid>. |
212 | |
528 | |
213 | =item on_sel_make $term, $eventtime |
529 | =item on_sel_make $term, $eventtime |
214 | |
530 | |
215 | Called whenever a selection has been made by the user, but before the |
531 | Called whenever a selection has been made by the user, but before the |
216 | selection text is copied, so changes to the beginning, end or type of the |
532 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
223 | |
539 | |
224 | Called whenever a selection has been copied, but before the selection is |
540 | Called whenever a selection has been copied, but before the selection is |
225 | requested from the server. The selection text can be queried and changed |
541 | requested from the server. The selection text can be queried and changed |
226 | by calling C<< $term->selection >>. |
542 | by calling C<< $term->selection >>. |
227 | |
543 | |
228 | Returning a true value aborts selection grabbing. It will still be hilighted. |
544 | Returning a true value aborts selection grabbing. It will still be highlighted. |
229 | |
545 | |
230 | =item on_sel_extend $term |
546 | =item on_sel_extend $term |
231 | |
547 | |
232 | Called whenever the user tries to extend the selection (e.g. with a double |
548 | Called whenever the user tries to extend the selection (e.g. with a double |
233 | click) and is either supposed to return false (normal operation), or |
549 | click) and is either supposed to return false (normal operation), or |
234 | should extend the selection itelf and return true to suppress the built-in |
550 | should extend the selection itself and return true to suppress the built-in |
235 | processing. |
551 | processing. This can happen multiple times, as long as the callback |
|
|
552 | returns true, it will be called on every further click by the user and is |
|
|
553 | supposed to enlarge the selection more and more, if possible. |
236 | |
554 | |
237 | See the F<selection> example extension. |
555 | See the F<selection> example extension. |
238 | |
556 | |
239 | =item on_view_change $term, $offset |
557 | =item on_view_change $term, $offset |
240 | |
558 | |
241 | Called whenever the view offset changes, i..e the user or program |
559 | Called whenever the view offset changes, i.e. the user or program |
242 | scrolls. Offset C<0> means display the normal terminal, positive values |
560 | scrolls. Offset C<0> means display the normal terminal, positive values |
243 | show this many lines of scrollback. |
561 | show this many lines of scrollback. |
244 | |
562 | |
245 | =item on_scroll_back $term, $lines, $saved |
563 | =item on_scroll_back $term, $lines, $saved |
246 | |
564 | |
… | |
… | |
250 | |
568 | |
251 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
569 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
252 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
570 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
253 | number of lines that will be in the scrollback buffer. |
571 | number of lines that will be in the scrollback buffer. |
254 | |
572 | |
255 | =item on_osc_seq $term, $string |
573 | =item on_osc_seq $term, $op, $args, $resp |
|
|
574 | |
|
|
575 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
576 | behaviour. The default should be to return an empty list. A true value |
|
|
577 | suppresses execution of the request completely. Make sure you don't get |
|
|
578 | confused by recursive invocations when you output an OSC sequence within |
|
|
579 | this callback. |
|
|
580 | |
|
|
581 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
582 | |
|
|
583 | =item on_osc_seq_perl $term, $args, $resp |
256 | |
584 | |
257 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
585 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
258 | operating system command) is processed. Cursor position and other state |
586 | operating system command) is processed. Cursor position and other state |
259 | information is up-to-date when this happens. For interoperability, the |
587 | information is up-to-date when this happens. For interoperability, the |
260 | string should start with the extension name and a colon, to distinguish |
588 | string should start with the extension name (sans -osc) and a semicolon, |
261 | it from commands for other extensions, and this might be enforced in the |
589 | to distinguish it from commands for other extensions, and this might be |
262 | future. |
590 | enforced in the future. |
|
|
591 | |
|
|
592 | For example, C<overlay-osc> uses this: |
|
|
593 | |
|
|
594 | sub on_osc_seq_perl { |
|
|
595 | my ($self, $osc, $resp) = @_; |
|
|
596 | |
|
|
597 | return unless $osc =~ s/^overlay;//; |
|
|
598 | |
|
|
599 | ... process remaining $osc string |
|
|
600 | } |
263 | |
601 | |
264 | Be careful not ever to trust (in a security sense) the data you receive, |
602 | Be careful not ever to trust (in a security sense) the data you receive, |
265 | as its source can not easily be controleld (e-mail content, messages from |
603 | as its source can not easily be controlled (e-mail content, messages from |
266 | other users on the same system etc.). |
604 | other users on the same system etc.). |
|
|
605 | |
|
|
606 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
607 | sender. |
267 | |
608 | |
268 | =item on_add_lines $term, $string |
609 | =item on_add_lines $term, $string |
269 | |
610 | |
270 | Called whenever text is about to be output, with the text as argument. You |
611 | Called whenever text is about to be output, with the text as argument. You |
271 | can filter/change and output the text yourself by returning a true value |
612 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
276 | =item on_tt_write $term, $octets |
617 | =item on_tt_write $term, $octets |
277 | |
618 | |
278 | Called whenever some data is written to the tty/pty and can be used to |
619 | Called whenever some data is written to the tty/pty and can be used to |
279 | suppress or filter tty input. |
620 | suppress or filter tty input. |
280 | |
621 | |
|
|
622 | =item on_tt_paste $term, $octets |
|
|
623 | |
|
|
624 | Called whenever text is about to be pasted, with the text as argument. You |
|
|
625 | can filter/change and paste the text yourself by returning a true value |
|
|
626 | and calling C<< $term->tt_paste >> yourself. C<$octets> is |
|
|
627 | locale-encoded. |
|
|
628 | |
281 | =item on_line_update $term, $row |
629 | =item on_line_update $term, $row |
282 | |
630 | |
283 | Called whenever a line was updated or changed. Can be used to filter |
631 | Called whenever a line was updated or changed. Can be used to filter |
284 | screen output (e.g. underline urls or other useless stuff). Only lines |
632 | screen output (e.g. underline urls or other useless stuff). Only lines |
285 | that are being shown will be filtered, and, due to performance reasons, |
633 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
292 | later with the already-modified line (e.g. if unrelated parts change), so |
640 | later with the already-modified line (e.g. if unrelated parts change), so |
293 | you cannot just toggle rendition bits, but only set them. |
641 | you cannot just toggle rendition bits, but only set them. |
294 | |
642 | |
295 | =item on_refresh_begin $term |
643 | =item on_refresh_begin $term |
296 | |
644 | |
297 | Called just before the screen gets redrawn. Can be used for overlay |
645 | Called just before the screen gets redrawn. Can be used for overlay or |
298 | or similar effects by modify terminal contents in refresh_begin, and |
646 | similar effects by modifying the terminal contents in refresh_begin, and |
299 | restoring them in refresh_end. The built-in overlay and selection display |
647 | restoring them in refresh_end. The built-in overlay and selection display |
300 | code is run after this hook, and takes precedence. |
648 | code is run after this hook, and takes precedence. |
301 | |
649 | |
302 | =item on_refresh_end $term |
650 | =item on_refresh_end $term |
303 | |
651 | |
304 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
652 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
305 | |
653 | |
306 | =item on_keyboard_command $term, $string |
654 | =item on_user_command $term, $string |
307 | |
655 | |
308 | Called whenever the user presses a key combination that has a |
656 | Called whenever a user-configured event is being activated (e.g. via |
309 | C<perl:string> action bound to it (see description of the B<keysym> |
657 | a C<perl:string> action bound to a key, see description of the B<keysym> |
310 | resource in the @@RXVT_NAME@@(1) manpage). |
658 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
659 | |
|
|
660 | The event is simply the action string. This interface is assumed to change |
|
|
661 | slightly in the future. |
|
|
662 | |
|
|
663 | =item on_resize_all_windows $term, $new_width, $new_height |
|
|
664 | |
|
|
665 | Called just after the new window size has been calculated, but before |
|
|
666 | windows are actually being resized or hints are being set. If this hook |
|
|
667 | returns TRUE, setting of the window hints is being skipped. |
|
|
668 | |
|
|
669 | =item on_x_event $term, $event |
|
|
670 | |
|
|
671 | Called on every X event received on the vt window (and possibly other |
|
|
672 | windows). Should only be used as a last resort. Most event structure |
|
|
673 | members are not passed. |
|
|
674 | |
|
|
675 | =item on_root_event $term, $event |
|
|
676 | |
|
|
677 | Like C<on_x_event>, but is called for events on the root window. |
311 | |
678 | |
312 | =item on_focus_in $term |
679 | =item on_focus_in $term |
313 | |
680 | |
314 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
681 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
315 | does focus in processing. |
682 | does focus in processing. |
316 | |
683 | |
317 | =item on_focus_out $term |
684 | =item on_focus_out $term |
318 | |
685 | |
319 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
686 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
320 | focus out processing. |
687 | focus out processing. |
321 | |
688 | |
|
|
689 | =item on_configure_notify $term, $event |
|
|
690 | |
|
|
691 | =item on_property_notify $term, $event |
|
|
692 | |
322 | =item on_key_press $term, $event, $keysym, $octets |
693 | =item on_key_press $term, $event, $keysym, $octets |
323 | |
694 | |
324 | =item on_key_release $term, $event, $keysym |
695 | =item on_key_release $term, $event, $keysym |
325 | |
696 | |
326 | =item on_button_press $term, $event |
697 | =item on_button_press $term, $event |
… | |
… | |
331 | |
702 | |
332 | =item on_map_notify $term, $event |
703 | =item on_map_notify $term, $event |
333 | |
704 | |
334 | =item on_unmap_notify $term, $event |
705 | =item on_unmap_notify $term, $event |
335 | |
706 | |
336 | Called whenever the corresponding X event is received for the terminal If |
707 | Called whenever the corresponding X event is received for the terminal. If |
337 | the hook returns true, then the even will be ignored by rxvt-unicode. |
708 | the hook returns true, then the event will be ignored by rxvt-unicode. |
338 | |
709 | |
339 | The event is a hash with most values as named by Xlib (see the XEvent |
710 | The event is a hash with most values as named by Xlib (see the XEvent |
340 | manpage), with the additional members C<row> and C<col>, which are the row |
711 | manpage), with the additional members C<row> and C<col>, which are the |
341 | and column under the mouse cursor. |
712 | (real, not screen-based) row and column under the mouse cursor. |
342 | |
713 | |
343 | C<on_key_press> additionally receives the string rxvt-unicode would |
714 | C<on_key_press> additionally receives the string rxvt-unicode would |
344 | output, if any, in locale-specific encoding. |
715 | output, if any, in locale-specific encoding. |
345 | |
716 | |
346 | subwindow. |
717 | subwindow. |
|
|
718 | |
|
|
719 | =item on_client_message $term, $event |
|
|
720 | |
|
|
721 | =item on_wm_protocols $term, $event |
|
|
722 | |
|
|
723 | =item on_wm_delete_window $term, $event |
|
|
724 | |
|
|
725 | Called when various types of ClientMessage events are received (all with |
|
|
726 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
727 | |
|
|
728 | =item on_bell $term |
|
|
729 | |
|
|
730 | Called on receipt of a bell character. |
347 | |
731 | |
348 | =back |
732 | =back |
349 | |
733 | |
350 | =cut |
734 | =cut |
351 | |
735 | |
… | |
… | |
357 | use Scalar::Util (); |
741 | use Scalar::Util (); |
358 | use List::Util (); |
742 | use List::Util (); |
359 | |
743 | |
360 | our $VERSION = 1; |
744 | our $VERSION = 1; |
361 | our $TERM; |
745 | our $TERM; |
|
|
746 | our @TERM_INIT; |
|
|
747 | our @TERM_EXT; |
362 | our @HOOKNAME; |
748 | our @HOOKNAME; |
363 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
749 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
364 | our %OPTION; |
750 | our %OPTION; |
365 | |
751 | |
366 | our $LIBDIR; |
752 | our $LIBDIR; |
367 | our $RESNAME; |
753 | our $RESNAME; |
368 | our $RESCLASS; |
754 | our $RESCLASS; |
369 | our $RXVTNAME; |
755 | our $RXVTNAME; |
370 | |
756 | |
|
|
757 | our $NOCHAR = chr 0xffff; |
|
|
758 | |
371 | =head2 Variables in the C<urxvt> Package |
759 | =head2 Variables in the C<urxvt> Package |
372 | |
760 | |
373 | =over 4 |
761 | =over 4 |
374 | |
762 | |
375 | =item $urxvt::LIBDIR |
763 | =item $urxvt::LIBDIR |
… | |
… | |
388 | =item $urxvt::TERM |
776 | =item $urxvt::TERM |
389 | |
777 | |
390 | The current terminal. This variable stores the current C<urxvt::term> |
778 | The current terminal. This variable stores the current C<urxvt::term> |
391 | object, whenever a callback/hook is executing. |
779 | object, whenever a callback/hook is executing. |
392 | |
780 | |
|
|
781 | =item @urxvt::TERM_INIT |
|
|
782 | |
|
|
783 | All code references in this array will be called as methods of the next newly |
|
|
784 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
785 | gets cleared before the code references that were in it are being executed, |
|
|
786 | so references can push themselves onto it again if they so desire. |
|
|
787 | |
|
|
788 | This complements to the perl-eval command line option, but gets executed |
|
|
789 | first. |
|
|
790 | |
|
|
791 | =item @urxvt::TERM_EXT |
|
|
792 | |
|
|
793 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
794 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
795 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
|
|
796 | |
393 | =back |
797 | =back |
394 | |
798 | |
395 | =head2 Functions in the C<urxvt> Package |
799 | =head2 Functions in the C<urxvt> Package |
396 | |
800 | |
397 | =over 4 |
801 | =over 4 |
398 | |
802 | |
399 | =item urxvt::fatal $errormessage |
803 | =item urxvt::fatal $errormessage |
400 | |
804 | |
401 | Fatally aborts execution with the given error message. Avoid at all |
805 | Fatally aborts execution with the given error message (which should |
402 | costs! The only time this is acceptable is when the terminal process |
806 | include a trailing newline). Avoid at all costs! The only time this |
403 | starts up. |
807 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
808 | terminal from starting up. |
404 | |
809 | |
405 | =item urxvt::warn $string |
810 | =item urxvt::warn $string |
406 | |
811 | |
407 | Calls C<rxvt_warn> with the given string which should not include a |
812 | Calls C<rxvt_warn> with the given string which should include a trailing |
408 | newline. The module also overwrites the C<warn> builtin with a function |
813 | newline. The module also overwrites the C<warn> builtin with a function |
409 | that calls this function. |
814 | that calls this function. |
410 | |
815 | |
411 | Using this function has the advantage that its output ends up in the |
816 | Using this function has the advantage that its output ends up in the |
412 | correct place, e.g. on stderr of the connecting urxvtc client. |
817 | correct place, e.g. on stderr of the connecting urxvtc client. |
413 | |
818 | |
414 | Messages have a size limit of 1023 bytes currently. |
819 | Messages have a size limit of 1023 bytes currently. |
415 | |
820 | |
416 | =item $is_safe = urxvt::safe |
821 | =item @terms = urxvt::termlist |
417 | |
822 | |
418 | Returns true when it is safe to do potentially unsafe things, such as |
823 | Returns all urxvt::term objects that exist in this process, regardless of |
419 | evaluating perl code specified by the user. This is true when urxvt was |
824 | whether they are started, being destroyed etc., so be careful. Only term |
420 | started setuid or setgid. |
825 | objects that have perl extensions attached will be returned (because there |
|
|
826 | is no urxvt::term object associated with others). |
421 | |
827 | |
422 | =item $time = urxvt::NOW |
828 | =item $time = urxvt::NOW |
423 | |
829 | |
424 | Returns the "current time" (as per the event loop). |
830 | Returns the "current time" (as per the event loop). |
425 | |
831 | |
426 | =item urxvt::CurrentTime |
832 | =item urxvt::CurrentTime |
427 | |
833 | |
428 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
834 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
429 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
835 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
430 | Button4Mask, Button5Mask, AnyModifier |
836 | Button4Mask, Button5Mask, AnyModifier |
|
|
837 | |
|
|
838 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
839 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
840 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
841 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
842 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
843 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
844 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
845 | |
|
|
846 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
847 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
848 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
849 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
850 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
851 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
852 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
431 | |
853 | |
432 | Various constants for use in X calls and event processing. |
854 | Various constants for use in X calls and event processing. |
433 | |
855 | |
434 | =back |
856 | =back |
435 | |
857 | |
… | |
… | |
452 | |
874 | |
453 | =item $rend = urxvt::OVERLAY_RSTYLE |
875 | =item $rend = urxvt::OVERLAY_RSTYLE |
454 | |
876 | |
455 | Return the rendition mask used for overlays by default. |
877 | Return the rendition mask used for overlays by default. |
456 | |
878 | |
457 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
879 | =item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, |
|
|
880 | urxvt::RS_RVid, urxvt::RS_Uline |
458 | |
881 | |
459 | Return the bit that enabled bold, italic, blink, reverse-video and |
882 | Return the bit that enabled bold, italic, blink, reverse-video and |
460 | underline, respectively. To enable such a style, just logically OR it into |
883 | underline, respectively. To enable such a style, just logically OR it into |
461 | the bitset. |
884 | the bitset. |
462 | |
885 | |
… | |
… | |
468 | |
891 | |
469 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
892 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
470 | |
893 | |
471 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
894 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
472 | |
895 | |
|
|
896 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
|
|
897 | |
473 | Replace the foreground/background colour in the rendition mask with the |
898 | Replace the foreground/background colour in the rendition mask with the |
474 | specified one. |
899 | specified one. |
475 | |
900 | |
476 | =item $value = urxvt::GET_CUSTOM $rend |
901 | =item $value = urxvt::GET_CUSTOM $rend |
477 | |
902 | |
… | |
… | |
486 | =back |
911 | =back |
487 | |
912 | |
488 | =cut |
913 | =cut |
489 | |
914 | |
490 | BEGIN { |
915 | BEGIN { |
491 | urxvt->bootstrap; |
|
|
492 | |
|
|
493 | # overwrite perl's warn |
916 | # overwrite perl's warn |
494 | *CORE::GLOBAL::warn = sub { |
917 | *CORE::GLOBAL::warn = sub { |
495 | my $msg = join "", @_; |
918 | my $msg = join "", @_; |
496 | $msg .= "\n" |
919 | $msg .= "\n" |
497 | unless $msg =~ /\n$/; |
920 | unless $msg =~ /\n$/; |
498 | urxvt::warn ($msg); |
921 | urxvt::warn ($msg); |
499 | }; |
922 | }; |
500 | |
|
|
501 | # delete $ENV{IFS}; |
|
|
502 | # delete $ENV{CDPATH}; |
|
|
503 | # delete $ENV{BASH_ENV}; |
|
|
504 | # $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
505 | } |
923 | } |
506 | |
924 | |
507 | my @hook_count; |
925 | no warnings 'utf8'; |
|
|
926 | |
508 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
927 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
509 | |
928 | |
510 | sub verbose { |
929 | sub verbose { |
511 | my ($level, $msg) = @_; |
930 | my ($level, $msg) = @_; |
512 | warn "$msg\n" if $level <= $verbosity; |
931 | warn "$msg\n" if $level <= $verbosity; |
513 | } |
932 | } |
514 | |
933 | |
515 | my $extension_pkg = "extension0000"; |
|
|
516 | my %extension_pkg; |
934 | my %extension_pkg; |
517 | |
935 | |
518 | # load a single script into its own package, once only |
936 | # load a single script into its own package, once only |
519 | sub extension_package($) { |
937 | sub extension_package($) { |
520 | my ($path) = @_; |
938 | my ($path) = @_; |
521 | |
939 | |
522 | $extension_pkg{$path} ||= do { |
940 | $extension_pkg{$path} ||= do { |
523 | my $pkg = "urxvt::" . ($extension_pkg++); |
941 | $path =~ /([^\/\\]+)$/; |
|
|
942 | my $pkg = $1; |
|
|
943 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
944 | $pkg = "urxvt::ext::$pkg"; |
524 | |
945 | |
525 | verbose 3, "loading extension '$path' into package '$pkg'"; |
946 | verbose 3, "loading extension '$path' into package '$pkg'"; |
526 | |
947 | |
527 | open my $fh, "<:raw", $path |
948 | open my $fh, "<:raw", $path |
528 | or die "$path: $!"; |
949 | or die "$path: $!"; |
529 | |
950 | |
530 | my $source = untaint |
951 | my $source = |
531 | "package $pkg; use strict; use utf8;\n" |
952 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
532 | . "use base urxvt::term::extension::;\n" |
|
|
533 | . "#line 1 \"$path\"\n{\n" |
953 | . "#line 1 \"$path\"\n{\n" |
534 | . (do { local $/; <$fh> }) |
954 | . (do { local $/; <$fh> }) |
535 | . "\n};\n1"; |
955 | . "\n};\n1"; |
536 | |
956 | |
537 | eval $source |
957 | eval $source |
… | |
… | |
548 | local $TERM = shift; |
968 | local $TERM = shift; |
549 | my $htype = shift; |
969 | my $htype = shift; |
550 | |
970 | |
551 | if ($htype == 0) { # INIT |
971 | if ($htype == 0) { # INIT |
552 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
972 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
553 | |
973 | |
554 | my %ext_arg; |
974 | my %ext_arg; |
555 | |
975 | |
|
|
976 | { |
|
|
977 | my @init = @TERM_INIT; |
|
|
978 | @TERM_INIT = (); |
|
|
979 | $_->($TERM) for @init; |
|
|
980 | my @pkg = @TERM_EXT; |
|
|
981 | @TERM_EXT = (); |
|
|
982 | $TERM->register_package ($_) for @pkg; |
|
|
983 | } |
|
|
984 | |
556 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
985 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
557 | if ($_ eq "default") { |
986 | if ($_ eq "default") { |
558 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
987 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
559 | } elsif (/^-(.*)$/) { |
988 | } elsif (/^-(.*)$/) { |
560 | delete $ext_arg{$1}; |
989 | delete $ext_arg{$1}; |
561 | } elsif (/^([^<]+)<(.*)>$/) { |
990 | } elsif (/^([^<]+)<(.*)>$/) { |
562 | push @{ $ext_arg{$1} }, $2; |
991 | push @{ $ext_arg{$1} }, $2; |
563 | } else { |
992 | } else { |
564 | $ext_arg{$_} ||= []; |
993 | $ext_arg{$_} ||= []; |
565 | } |
994 | } |
566 | } |
995 | } |
567 | |
996 | |
568 | while (my ($ext, $argv) = each %ext_arg) { |
997 | for my $ext (sort keys %ext_arg) { |
569 | my @files = grep -f $_, map "$_/$ext", @dirs; |
998 | my @files = grep -f $_, map "$_/$ext", @dirs; |
570 | |
999 | |
571 | if (@files) { |
1000 | if (@files) { |
572 | $TERM->register_package (extension_package $files[0], $argv); |
1001 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
573 | } else { |
1002 | } else { |
574 | warn "perl extension '$ext' not found in perl library search path\n"; |
1003 | warn "perl extension '$ext' not found in perl library search path\n"; |
575 | } |
1004 | } |
576 | } |
1005 | } |
577 | |
1006 | |
… | |
… | |
583 | |
1012 | |
584 | if (my $cb = $TERM->{_hook}[$htype]) { |
1013 | if (my $cb = $TERM->{_hook}[$htype]) { |
585 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
1014 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
586 | if $verbosity >= 10; |
1015 | if $verbosity >= 10; |
587 | |
1016 | |
588 | keys %$cb; |
1017 | for my $pkg (keys %$cb) { |
589 | |
|
|
590 | while (my ($pkg, $cb) = each %$cb) { |
|
|
591 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
1018 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
592 | and last; |
1019 | $retval ||= $retval_; |
593 | |
1020 | |
594 | if ($@) { |
1021 | if ($@) { |
595 | $TERM->ungrab; # better to lose the grab than the session |
1022 | $TERM->ungrab; # better to lose the grab than the session |
596 | warn $@; |
1023 | warn $@; |
597 | } |
1024 | } |
598 | } |
1025 | } |
|
|
1026 | |
|
|
1027 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
1028 | if $verbosity >= 11; |
599 | } |
1029 | } |
600 | |
1030 | |
601 | if ($htype == 1) { # DESTROY |
1031 | if ($htype == 1) { # DESTROY |
602 | if (my $hook = delete $TERM->{_hook}) { |
|
|
603 | for my $htype (0..$#$hook) { |
|
|
604 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
605 | or set_should_invoke $htype, 0; |
|
|
606 | } |
|
|
607 | } |
|
|
608 | |
|
|
609 | # clear package objects |
1032 | # clear package objects |
610 | %$_ = () for values %{ $TERM->{_pkg} }; |
1033 | %$_ = () for values %{ $TERM->{_pkg} }; |
611 | |
1034 | |
612 | # clear package |
1035 | # clear package |
613 | %$TERM = (); |
1036 | %$TERM = (); |
614 | } |
1037 | } |
615 | |
1038 | |
616 | $retval |
1039 | $retval |
|
|
1040 | } |
|
|
1041 | |
|
|
1042 | sub SET_COLOR($$$) { |
|
|
1043 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
1044 | } |
|
|
1045 | |
|
|
1046 | sub rend2mask { |
|
|
1047 | no strict 'refs'; |
|
|
1048 | my ($str, $mask) = (@_, 0); |
|
|
1049 | my %color = ( fg => undef, bg => undef ); |
|
|
1050 | my @failed; |
|
|
1051 | for my $spec ( split /\s+/, $str ) { |
|
|
1052 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1053 | $color{lc($1)} = $2; |
|
|
1054 | } else { |
|
|
1055 | my $neg = $spec =~ s/^[-^]//; |
|
|
1056 | unless ( exists &{"RS_$spec"} ) { |
|
|
1057 | push @failed, $spec; |
|
|
1058 | next; |
|
|
1059 | } |
|
|
1060 | my $cur = &{"RS_$spec"}; |
|
|
1061 | if ( $neg ) { |
|
|
1062 | $mask &= ~$cur; |
|
|
1063 | } else { |
|
|
1064 | $mask |= $cur; |
|
|
1065 | } |
|
|
1066 | } |
|
|
1067 | } |
|
|
1068 | ($mask, @color{qw(fg bg)}, \@failed) |
617 | } |
1069 | } |
618 | |
1070 | |
619 | # urxvt::term::extension |
1071 | # urxvt::term::extension |
620 | |
1072 | |
621 | package urxvt::term::extension; |
1073 | package urxvt::term::extension; |
… | |
… | |
627 | while (my ($name, $cb) = each %hook) { |
1079 | while (my ($name, $cb) = each %hook) { |
628 | my $htype = $HOOKTYPE{uc $name}; |
1080 | my $htype = $HOOKTYPE{uc $name}; |
629 | defined $htype |
1081 | defined $htype |
630 | or Carp::croak "unsupported hook type '$name'"; |
1082 | or Carp::croak "unsupported hook type '$name'"; |
631 | |
1083 | |
|
|
1084 | $self->set_should_invoke ($htype, +1) |
632 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
1085 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
633 | $hook_count[$htype]++ |
|
|
634 | or urxvt::set_should_invoke $htype, 1; |
|
|
635 | } |
|
|
636 | |
1086 | |
637 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
1087 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
638 | } |
1088 | } |
639 | } |
1089 | } |
640 | |
1090 | |
… | |
… | |
645 | for my $name (@hook) { |
1095 | for my $name (@hook) { |
646 | my $htype = $HOOKTYPE{uc $name}; |
1096 | my $htype = $HOOKTYPE{uc $name}; |
647 | defined $htype |
1097 | defined $htype |
648 | or Carp::croak "unsupported hook type '$name'"; |
1098 | or Carp::croak "unsupported hook type '$name'"; |
649 | |
1099 | |
|
|
1100 | $self->set_should_invoke ($htype, -1) |
650 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
1101 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
651 | --$hook_count[$htype] |
|
|
652 | or urxvt::set_should_invoke $htype, 0; |
|
|
653 | } |
|
|
654 | } |
1102 | } |
655 | } |
1103 | } |
656 | |
1104 | |
657 | our $AUTOLOAD; |
1105 | our $AUTOLOAD; |
658 | |
1106 | |
… | |
… | |
696 | is that you cannot use blocking APIs, but the non-blocking variant should |
1144 | is that you cannot use blocking APIs, but the non-blocking variant should |
697 | work. |
1145 | work. |
698 | |
1146 | |
699 | =cut |
1147 | =cut |
700 | |
1148 | |
701 | our $VERSION = 1; |
1149 | our $VERSION = '5.23'; |
702 | |
1150 | |
703 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1151 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
704 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1152 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
705 | |
1153 | |
706 | sub timer { |
1154 | sub timer { |
… | |
… | |
708 | |
1156 | |
709 | my $cb = $arg{cb}; |
1157 | my $cb = $arg{cb}; |
710 | |
1158 | |
711 | urxvt::timer |
1159 | urxvt::timer |
712 | ->new |
1160 | ->new |
713 | ->start (urxvt::NOW + $arg{after}) |
1161 | ->after ($arg{after}, $arg{interval}) |
714 | ->cb (sub { |
1162 | ->cb ($arg{interval} ? $cb : sub { |
715 | $_[0]->stop; # need to cancel manually |
1163 | $_[0]->stop; # need to cancel manually |
716 | $cb->(); |
1164 | $cb->(); |
717 | }) |
1165 | }) |
718 | } |
1166 | } |
719 | |
1167 | |
720 | sub io { |
1168 | sub io { |
721 | my ($class, %arg) = @_; |
1169 | my ($class, %arg) = @_; |
722 | |
1170 | |
723 | my $cb = $arg{cb}; |
1171 | my $cb = $arg{cb}; |
|
|
1172 | my $fd = fileno $arg{fh}; |
|
|
1173 | defined $fd or $fd = $arg{fh}; |
724 | |
1174 | |
725 | bless [$arg{fh}, urxvt::iow |
1175 | bless [$arg{fh}, urxvt::iow |
726 | ->new |
1176 | ->new |
727 | ->fd (fileno $arg{fh}) |
1177 | ->fd ($fd) |
728 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1178 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
729 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1179 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
730 | ->start |
1180 | ->start |
731 | ->cb (sub { |
1181 | ->cb ($cb) |
732 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
733 | . ($_[1] & 2 ? 'w' : '')); |
|
|
734 | })], |
|
|
735 | urxvt::anyevent:: |
1182 | ], urxvt::anyevent:: |
|
|
1183 | } |
|
|
1184 | |
|
|
1185 | sub idle { |
|
|
1186 | my ($class, %arg) = @_; |
|
|
1187 | |
|
|
1188 | my $cb = $arg{cb}; |
|
|
1189 | |
|
|
1190 | urxvt::iw |
|
|
1191 | ->new |
|
|
1192 | ->start |
|
|
1193 | ->cb ($cb) |
|
|
1194 | } |
|
|
1195 | |
|
|
1196 | sub child { |
|
|
1197 | my ($class, %arg) = @_; |
|
|
1198 | |
|
|
1199 | my $cb = $arg{cb}; |
|
|
1200 | |
|
|
1201 | urxvt::pw |
|
|
1202 | ->new |
|
|
1203 | ->start ($arg{pid}) |
|
|
1204 | ->cb (sub { |
|
|
1205 | $_[0]->stop; # need to cancel manually |
|
|
1206 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1207 | }) |
736 | } |
1208 | } |
737 | |
1209 | |
738 | sub DESTROY { |
1210 | sub DESTROY { |
739 | $_[0][1]->stop; |
1211 | $_[0][1]->stop; |
740 | } |
1212 | } |
741 | |
1213 | |
742 | sub condvar { |
1214 | sub one_event { |
743 | bless \my $flag, urxvt::anyevent::condvar:: |
|
|
744 | } |
|
|
745 | |
|
|
746 | sub urxvt::anyevent::condvar::broadcast { |
|
|
747 | ${$_[0]}++; |
|
|
748 | } |
|
|
749 | |
|
|
750 | sub urxvt::anyevent::condvar::wait { |
|
|
751 | unless (${$_[0]}) { |
|
|
752 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1215 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
753 | } |
|
|
754 | } |
1216 | } |
755 | |
1217 | |
756 | package urxvt::term; |
1218 | package urxvt::term; |
757 | |
1219 | |
758 | =head2 The C<urxvt::term> Class |
1220 | =head2 The C<urxvt::term> Class |
… | |
… | |
763 | |
1225 | |
764 | # find on_xxx subs in the package and register them |
1226 | # find on_xxx subs in the package and register them |
765 | # as hooks |
1227 | # as hooks |
766 | sub register_package { |
1228 | sub register_package { |
767 | my ($self, $pkg, $argv) = @_; |
1229 | my ($self, $pkg, $argv) = @_; |
|
|
1230 | |
|
|
1231 | no strict 'refs'; |
|
|
1232 | |
|
|
1233 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
1234 | |
|
|
1235 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
768 | |
1236 | |
769 | my $proxy = bless { |
1237 | my $proxy = bless { |
770 | _pkg => $pkg, |
1238 | _pkg => $pkg, |
771 | argv => $argv, |
1239 | argv => $argv, |
772 | }, $pkg; |
1240 | }, $pkg; |
… | |
… | |
788 | hash which defines the environment of the new terminal. |
1256 | hash which defines the environment of the new terminal. |
789 | |
1257 | |
790 | Croaks (and probably outputs an error message) if the new instance |
1258 | Croaks (and probably outputs an error message) if the new instance |
791 | couldn't be created. Returns C<undef> if the new instance didn't |
1259 | couldn't be created. Returns C<undef> if the new instance didn't |
792 | initialise perl, and the terminal object otherwise. The C<init> and |
1260 | initialise perl, and the terminal object otherwise. The C<init> and |
793 | C<start> hooks will be called during this call. |
1261 | C<start> hooks will be called before this call returns, and are free to |
|
|
1262 | refer to global data (which is race free). |
794 | |
1263 | |
795 | =cut |
1264 | =cut |
796 | |
1265 | |
797 | sub new { |
1266 | sub new { |
798 | my ($class, $env, @args) = @_; |
1267 | my ($class, $env, @args) = @_; |
799 | |
1268 | |
|
|
1269 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1270 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1271 | |
800 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1272 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
801 | } |
1273 | } |
802 | |
1274 | |
803 | =item $term->destroy |
1275 | =item $term->destroy |
804 | |
1276 | |
805 | Destroy the terminal object (close the window, free resources |
1277 | Destroy the terminal object (close the window, free resources |
806 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1278 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
807 | watchers (timers, io watchers) are still active. |
1279 | watchers (timers, io watchers) are still active. |
808 | |
1280 | |
|
|
1281 | =item $term->exec_async ($cmd[, @args]) |
|
|
1282 | |
|
|
1283 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
1284 | ("starts") programs in the background. This function takes care of setting |
|
|
1285 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
1286 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
1287 | |
|
|
1288 | Returns the pid of the subprocess or C<undef> on error. |
|
|
1289 | |
|
|
1290 | =cut |
|
|
1291 | |
|
|
1292 | sub exec_async { |
|
|
1293 | my $self = shift; |
|
|
1294 | |
|
|
1295 | my $pid = fork; |
|
|
1296 | |
|
|
1297 | return $pid |
|
|
1298 | if !defined $pid or $pid; |
|
|
1299 | |
|
|
1300 | %ENV = %{ $self->env }; |
|
|
1301 | |
|
|
1302 | exec @_; |
|
|
1303 | urxvt::_exit 255; |
|
|
1304 | } |
|
|
1305 | |
809 | =item $isset = $term->option ($optval[, $set]) |
1306 | =item $isset = $term->option ($optval[, $set]) |
810 | |
1307 | |
811 | Returns true if the option specified by C<$optval> is enabled, and |
1308 | Returns true if the option specified by C<$optval> is enabled, and |
812 | optionally change it. All option values are stored by name in the hash |
1309 | optionally change it. All option values are stored by name in the hash |
813 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1310 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
814 | |
1311 | |
815 | Here is a a likely non-exhaustive list of option names, please see the |
1312 | Here is a likely non-exhaustive list of option names, please see the |
816 | source file F</src/optinc.h> to see the actual list: |
1313 | source file F</src/optinc.h> to see the actual list: |
817 | |
1314 | |
818 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1315 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
819 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1316 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
|
|
1317 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
820 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1318 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
821 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1319 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
822 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1320 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
823 | tripleclickwords utmpInhibit visualBell |
1321 | urgentOnBell utmpInhibit visualBell |
824 | |
1322 | |
825 | =item $value = $term->resource ($name[, $newval]) |
1323 | =item $value = $term->resource ($name[, $newval]) |
826 | |
1324 | |
827 | Returns the current resource value associated with a given name and |
1325 | Returns the current resource value associated with a given name and |
828 | optionally sets a new value. Setting values is most useful in the C<init> |
1326 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
837 | likely change). |
1335 | likely change). |
838 | |
1336 | |
839 | Please note that resource strings will currently only be freed when the |
1337 | Please note that resource strings will currently only be freed when the |
840 | terminal is destroyed, so changing options frequently will eat memory. |
1338 | terminal is destroyed, so changing options frequently will eat memory. |
841 | |
1339 | |
842 | Here is a a likely non-exhaustive list of resource names, not all of which |
1340 | Here is a likely non-exhaustive list of resource names, not all of which |
843 | are supported in every build, please see the source file F</src/rsinc.h> |
1341 | are supported in every build, please see the source file F</src/rsinc.h> |
844 | to see the actual list: |
1342 | to see the actual list: |
845 | |
1343 | |
846 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1344 | answerbackstring backgroundPixmap backspace_key blendtype blurradius |
847 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1345 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
848 | display_name embed ext_bwidth fade font geometry hold iconName |
1346 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
849 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1347 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
|
|
1348 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
850 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1349 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
851 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1350 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
852 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1351 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
853 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1352 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
854 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1353 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
855 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1354 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
856 | shade term_name title transparent transparent_all tripleclickwords |
1355 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
|
|
1356 | term_name title transient_for transparent tripleclickwords urgentOnBell |
857 | utmpInhibit visualBell |
1357 | utmpInhibit visualBell |
858 | |
1358 | |
859 | =cut |
1359 | =cut |
860 | |
1360 | |
861 | sub resource($$;$) { |
1361 | sub resource($$;$) { |
862 | my ($self, $name) = (shift, shift); |
1362 | my ($self, $name) = (shift, shift); |
863 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1363 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
864 | &urxvt::term::_resource |
1364 | goto &urxvt::term::_resource |
865 | } |
1365 | } |
866 | |
1366 | |
867 | =item $value = $term->x_resource ($pattern) |
1367 | =item $value = $term->x_resource ($pattern) |
868 | |
1368 | |
869 | Returns the X-Resource for the given pattern, excluding the program or |
1369 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
894 | |
1394 | |
895 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1395 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
896 | |
1396 | |
897 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1397 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
898 | |
1398 | |
899 | Return the current values of the selection mark, begin or end positions, |
1399 | Return the current values of the selection mark, begin or end positions. |
900 | and optionally set them to new values. |
|
|
901 | |
1400 | |
|
|
1401 | When arguments are given, then the selection coordinates are set to |
|
|
1402 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1403 | screen. |
|
|
1404 | |
|
|
1405 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1406 | |
|
|
1407 | Returns the current selection screen, and then optionally sets it. |
|
|
1408 | |
|
|
1409 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
1410 | |
|
|
1411 | Tries to make a selection as set by C<selection_beg> and |
|
|
1412 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
1413 | rectangular selection will be made. This is the preferred function to make |
|
|
1414 | a selection. |
|
|
1415 | |
902 | =item $success = $term->selection_grab ($eventtime) |
1416 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
903 | |
1417 | |
904 | Try to request the primary selection from the server (for example, as set |
1418 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
905 | by the next method). |
1419 | true) selection from the server. The corresponding text can be set |
|
|
1420 | with the next method. No visual feedback will be given. This function |
|
|
1421 | is mostly useful from within C<on_sel_grab> hooks. |
906 | |
1422 | |
907 | =item $oldtext = $term->selection ([$newtext]) |
1423 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
908 | |
1424 | |
909 | Return the current selection text and optionally replace it by C<$newtext>. |
1425 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1426 | and optionally replace it by C<$newtext>. |
|
|
1427 | |
|
|
1428 | =item $term->selection_clear ([$clipboard]) |
|
|
1429 | |
|
|
1430 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
910 | |
1431 | |
911 | =item $term->overlay_simple ($x, $y, $text) |
1432 | =item $term->overlay_simple ($x, $y, $text) |
912 | |
1433 | |
913 | Create a simple multi-line overlay box. See the next method for details. |
1434 | Create a simple multi-line overlay box. See the next method for details. |
914 | |
1435 | |
… | |
… | |
944 | |
1465 | |
945 | The methods currently supported on C<urxvt::overlay> objects are: |
1466 | The methods currently supported on C<urxvt::overlay> objects are: |
946 | |
1467 | |
947 | =over 4 |
1468 | =over 4 |
948 | |
1469 | |
949 | =item $overlay->set ($x, $y, $text, $rend) |
1470 | =item $overlay->set ($x, $y, $text[, $rend]) |
950 | |
1471 | |
951 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1472 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
952 | text in rxvt-unicode's special encoding and an array of rendition values |
1473 | text in rxvt-unicode's special encoding and an array of rendition values |
953 | at a specific position inside the overlay. |
1474 | at a specific position inside the overlay. |
|
|
1475 | |
|
|
1476 | If C<$rend> is missing, then the rendition will not be changed. |
954 | |
1477 | |
955 | =item $overlay->hide |
1478 | =item $overlay->hide |
956 | |
1479 | |
957 | If visible, hide the overlay, but do not destroy it. |
1480 | If visible, hide the overlay, but do not destroy it. |
958 | |
1481 | |
… | |
… | |
1003 | Convert the given locale-encoded octets into a perl string. |
1526 | Convert the given locale-encoded octets into a perl string. |
1004 | |
1527 | |
1005 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1528 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1006 | |
1529 | |
1007 | XORs the rendition values in the given span with the provided value |
1530 | XORs the rendition values in the given span with the provided value |
1008 | (default: C<RS_RVid>). Useful in refresh hooks to provide effects similar |
1531 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
1009 | to the selection. |
1532 | refresh hooks to provide effects similar to the selection. |
1010 | |
1533 | |
1011 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1534 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1012 | |
1535 | |
1013 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1536 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1014 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1537 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1015 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1538 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1016 | it instead. |
1539 | it instead. Both styles I<MUST NOT> contain font styles. |
1017 | |
1540 | |
1018 | =item $term->scr_bell |
1541 | =item $term->scr_bell |
1019 | |
1542 | |
1020 | Ring the bell! |
1543 | Ring the bell! |
1021 | |
1544 | |
… | |
… | |
1028 | |
1551 | |
1029 | Normally its not a good idea to use this function, as programs might be |
1552 | Normally its not a good idea to use this function, as programs might be |
1030 | confused by changes in cursor position or scrolling. Its useful inside a |
1553 | confused by changes in cursor position or scrolling. Its useful inside a |
1031 | C<on_add_lines> hook, though. |
1554 | C<on_add_lines> hook, though. |
1032 | |
1555 | |
|
|
1556 | =item $term->scr_change_screen ($screen) |
|
|
1557 | |
|
|
1558 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1559 | |
1033 | =item $term->cmd_parse ($octets) |
1560 | =item $term->cmd_parse ($octets) |
1034 | |
1561 | |
1035 | Similar to C<scr_add_lines>, but the argument must be in the |
1562 | Similar to C<scr_add_lines>, but the argument must be in the |
1036 | locale-specific encoding of the terminal and can contain command sequences |
1563 | locale-specific encoding of the terminal and can contain command sequences |
1037 | (escape codes) that will be interpreted. |
1564 | (escape codes) that will be interpreted. |
1038 | |
1565 | |
1039 | =item $term->tt_write ($octets) |
1566 | =item $term->tt_write ($octets) |
1040 | |
1567 | |
1041 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1568 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1042 | pass characters instead of octets, you should convert your strings first |
1569 | pass characters instead of octets, you should convert your strings first |
1043 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1570 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1571 | |
|
|
1572 | =item $term->tt_paste ($octets) |
|
|
1573 | |
|
|
1574 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1575 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1576 | is set. |
1044 | |
1577 | |
1045 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1578 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1046 | |
1579 | |
1047 | Replaces the event mask of the pty watcher by the given event mask. Can |
1580 | Replaces the event mask of the pty watcher by the given event mask. Can |
1048 | be used to suppress input and output handling to the pty/tty. See the |
1581 | be used to suppress input and output handling to the pty/tty. See the |
1049 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1582 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1050 | the previous value. |
1583 | the previous value. |
1051 | |
1584 | |
|
|
1585 | =item $fd = $term->pty_fd |
|
|
1586 | |
|
|
1587 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1588 | is used. |
|
|
1589 | |
1052 | =item $windowid = $term->parent |
1590 | =item $windowid = $term->parent |
1053 | |
1591 | |
1054 | Return the window id of the toplevel window. |
1592 | Return the window id of the toplevel window. |
1055 | |
1593 | |
1056 | =item $windowid = $term->vt |
1594 | =item $windowid = $term->vt |
1057 | |
1595 | |
1058 | Return the window id of the terminal window. |
1596 | Return the window id of the terminal window. |
1059 | |
1597 | |
|
|
1598 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1599 | |
|
|
1600 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1601 | to receive pointer events all the times: |
|
|
1602 | |
|
|
1603 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1604 | |
|
|
1605 | =item $term->focus_in |
|
|
1606 | |
|
|
1607 | =item $term->focus_out |
|
|
1608 | |
|
|
1609 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1610 | |
|
|
1611 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1612 | |
|
|
1613 | Deliver various fake events to to terminal. |
|
|
1614 | |
1060 | =item $window_width = $term->width |
1615 | =item $window_width = $term->width |
1061 | |
1616 | |
1062 | =item $window_height = $term->height |
1617 | =item $window_height = $term->height |
1063 | |
1618 | |
1064 | =item $font_width = $term->fwidth |
1619 | =item $font_width = $term->fwidth |
… | |
… | |
1077 | |
1632 | |
1078 | =item $max_scrollback = $term->saveLines |
1633 | =item $max_scrollback = $term->saveLines |
1079 | |
1634 | |
1080 | =item $nrow_plus_saveLines = $term->total_rows |
1635 | =item $nrow_plus_saveLines = $term->total_rows |
1081 | |
1636 | |
1082 | =item $lines_in_scrollback = $term->nsaved |
1637 | =item $topmost_scrollback_row = $term->top_row |
1083 | |
1638 | |
1084 | Return various integers describing terminal characteristics. |
1639 | Return various integers describing terminal characteristics. |
1085 | |
1640 | |
1086 | =item $x_display = $term->display_id |
1641 | =item $x_display = $term->display_id |
1087 | |
1642 | |
… | |
… | |
1094 | =item $env = $term->env |
1649 | =item $env = $term->env |
1095 | |
1650 | |
1096 | Returns a copy of the environment in effect for the terminal as a hashref |
1651 | Returns a copy of the environment in effect for the terminal as a hashref |
1097 | similar to C<\%ENV>. |
1652 | similar to C<\%ENV>. |
1098 | |
1653 | |
|
|
1654 | =item @envv = $term->envv |
|
|
1655 | |
|
|
1656 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1657 | |
|
|
1658 | =item @argv = $term->argv |
|
|
1659 | |
|
|
1660 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1661 | includes the program name as first element. |
|
|
1662 | |
1099 | =cut |
1663 | =cut |
1100 | |
1664 | |
1101 | sub env { |
1665 | sub env { |
1102 | if (my $env = $_[0]->_env) { |
|
|
1103 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1666 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1104 | } else { |
|
|
1105 | +{ %ENV } |
|
|
1106 | } |
|
|
1107 | } |
1667 | } |
1108 | |
1668 | |
1109 | =item $modifiermask = $term->ModLevel3Mask |
1669 | =item $modifiermask = $term->ModLevel3Mask |
1110 | |
1670 | |
1111 | =item $modifiermask = $term->ModMetaMask |
1671 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1113 | =item $modifiermask = $term->ModNumLockMask |
1673 | =item $modifiermask = $term->ModNumLockMask |
1114 | |
1674 | |
1115 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1675 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1116 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1676 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1117 | |
1677 | |
|
|
1678 | =item $screen = $term->current_screen |
|
|
1679 | |
|
|
1680 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1681 | |
|
|
1682 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1683 | |
|
|
1684 | Returns whether the cursor is currently hidden or not. |
|
|
1685 | |
1118 | =item $view_start = $term->view_start ([$newvalue]) |
1686 | =item $view_start = $term->view_start ([$newvalue]) |
1119 | |
1687 | |
1120 | Returns the negative row number of the topmost line. Minimum value is |
1688 | Returns the row number of the topmost displayed line. Maximum value is |
1121 | C<0>, which displays the normal terminal contents. Larger values scroll |
1689 | C<0>, which displays the normal terminal contents. Lower values scroll |
1122 | this many lines into the scrollback buffer. |
1690 | this many lines into the scrollback buffer. |
1123 | |
1691 | |
1124 | =item $term->want_refresh |
1692 | =item $term->want_refresh |
1125 | |
1693 | |
1126 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1694 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1129 | |
1697 | |
1130 | Used after changing terminal contents to display them. |
1698 | Used after changing terminal contents to display them. |
1131 | |
1699 | |
1132 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1700 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1133 | |
1701 | |
1134 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1702 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1135 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1703 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1136 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1137 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1704 | terminal line. Nothing will be returned if a nonexistent line |
1138 | is requested. |
1705 | is requested. |
1139 | |
1706 | |
1140 | If C<$new_text> is specified, it will replace characters in the current |
1707 | If C<$new_text> is specified, it will replace characters in the current |
1141 | line, starting at column C<$start_col> (default C<0>), which is useful |
1708 | line, starting at column C<$start_col> (default C<0>), which is useful |
1142 | to replace only parts of a line. The font index in the rendition will |
1709 | to replace only parts of a line. The font index in the rendition will |
1143 | automatically be updated. |
1710 | automatically be updated. |
1144 | |
1711 | |
1145 | C<$text> is in a special encoding: tabs and wide characters that use more |
1712 | C<$text> is in a special encoding: tabs and wide characters that use more |
1146 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1713 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1147 | (C<chr 65535>). Characters with combining characters and other characters |
1714 | characters. Characters with combining characters and other characters that |
1148 | that do not fit into the normal tetx encoding will be replaced with |
1715 | do not fit into the normal text encoding will be replaced with characters |
1149 | characters in the private use area. |
1716 | in the private use area. |
1150 | |
1717 | |
1151 | You have to obey this encoding when changing text. The advantage is |
1718 | You have to obey this encoding when changing text. The advantage is |
1152 | that C<substr> and similar functions work on screen cells and not on |
1719 | that C<substr> and similar functions work on screen cells and not on |
1153 | characters. |
1720 | characters. |
1154 | |
1721 | |
… | |
… | |
1205 | Return the row number of the first/last row of the line, respectively. |
1772 | Return the row number of the first/last row of the line, respectively. |
1206 | |
1773 | |
1207 | =item $offset = $line->offset_of ($row, $col) |
1774 | =item $offset = $line->offset_of ($row, $col) |
1208 | |
1775 | |
1209 | Returns the character offset of the given row|col pair within the logical |
1776 | Returns the character offset of the given row|col pair within the logical |
1210 | line. |
1777 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1778 | offsets outside the string. |
1211 | |
1779 | |
1212 | =item ($row, $col) = $line->coord_of ($offset) |
1780 | =item ($row, $col) = $line->coord_of ($offset) |
1213 | |
1781 | |
1214 | Translates a string offset into terminal coordinates again. |
1782 | Translates a string offset into terminal coordinates again. |
1215 | |
1783 | |
… | |
… | |
1297 | where one character corresponds to one screen cell. See |
1865 | where one character corresponds to one screen cell. See |
1298 | C<< $term->ROW_t >> for details. |
1866 | C<< $term->ROW_t >> for details. |
1299 | |
1867 | |
1300 | =item $string = $term->special_decode $text |
1868 | =item $string = $term->special_decode $text |
1301 | |
1869 | |
1302 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1870 | Converts rxvt-unicodes text representation into a perl string. See |
1303 | C<< $term->ROW_t >> for details. |
1871 | C<< $term->ROW_t >> for details. |
1304 | |
1872 | |
1305 | =item $success = $term->grab_button ($button, $modifiermask) |
1873 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1306 | |
1874 | |
|
|
1875 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1876 | |
1307 | Registers a synchronous button grab. See the XGrabButton manpage. |
1877 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1878 | manpage. |
1308 | |
1879 | |
1309 | =item $success = $term->grab ($eventtime[, $sync]) |
1880 | =item $success = $term->grab ($eventtime[, $sync]) |
1310 | |
1881 | |
1311 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1882 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1312 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1883 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1313 | |
1884 | |
1314 | =item $term->allow_events_async |
1885 | =item $term->allow_events_async |
1315 | |
1886 | |
1316 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1887 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1317 | |
1888 | |
… | |
… | |
1324 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1895 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1325 | recent grab. |
1896 | recent grab. |
1326 | |
1897 | |
1327 | =item $term->ungrab |
1898 | =item $term->ungrab |
1328 | |
1899 | |
1329 | Calls XUngrab for the most recent grab. Is called automatically on |
1900 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
1330 | evaluation errors, as it is better to lose the grab in the error case as |
1901 | evaluation errors, as it is better to lose the grab in the error case as |
1331 | the session. |
1902 | the session. |
|
|
1903 | |
|
|
1904 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1905 | |
|
|
1906 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1907 | |
|
|
1908 | =item @atoms = $term->XListProperties ($window) |
|
|
1909 | |
|
|
1910 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1911 | |
|
|
1912 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
|
|
1913 | |
|
|
1914 | =item $term->XDeleteProperty ($window, $property) |
|
|
1915 | |
|
|
1916 | =item $window = $term->DefaultRootWindow |
|
|
1917 | |
|
|
1918 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1919 | |
|
|
1920 | =item $term->XMapWindow ($window) |
|
|
1921 | |
|
|
1922 | =item $term->XUnmapWindow ($window) |
|
|
1923 | |
|
|
1924 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1925 | |
|
|
1926 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1927 | |
|
|
1928 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1929 | |
|
|
1930 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1931 | the source of the display, otherwise those functions map more-or-less |
|
|
1932 | directly onto the X functions of the same name. |
1332 | |
1933 | |
1333 | =back |
1934 | =back |
1334 | |
1935 | |
1335 | =cut |
1936 | =cut |
1336 | |
1937 | |
… | |
… | |
1400 | my ($self, $text, $cb) = @_; |
2001 | my ($self, $text, $cb) = @_; |
1401 | |
2002 | |
1402 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
2003 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1403 | } |
2004 | } |
1404 | |
2005 | |
1405 | =item $popup->add_toggle ($text, $cb, $initial_value) |
2006 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1406 | |
2007 | |
1407 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
2008 | Adds a toggle/checkbox item to the popup. The callback gets called |
1408 | whenever it gets toggled, with a boolean indicating its value as its first |
2009 | whenever it gets toggled, with a boolean indicating its new value as its |
1409 | argument. |
2010 | first argument. |
1410 | |
2011 | |
1411 | =cut |
2012 | =cut |
1412 | |
2013 | |
1413 | sub add_toggle { |
2014 | sub add_toggle { |
1414 | my ($self, $text, $cb, $value) = @_; |
2015 | my ($self, $text, $value, $cb) = @_; |
1415 | |
2016 | |
1416 | my $item; $item = { |
2017 | my $item; $item = { |
1417 | type => "button", |
2018 | type => "button", |
1418 | text => " $text", |
2019 | text => " $text", |
1419 | value => $value, |
2020 | value => $value, |
… | |
… | |
1438 | my $env = $self->{term}->env; |
2039 | my $env = $self->{term}->env; |
1439 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
2040 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1440 | delete $env->{LC_ALL}; |
2041 | delete $env->{LC_ALL}; |
1441 | $env->{LC_CTYPE} = $self->{term}->locale; |
2042 | $env->{LC_CTYPE} = $self->{term}->locale; |
1442 | |
2043 | |
1443 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
2044 | my $term = urxvt::term->new ( |
1444 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
2045 | $env, "popup", |
|
|
2046 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
2047 | "-pty-fd" => -1, "-sl" => 0, |
|
|
2048 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1445 | "--transient-for" => $self->{term}->parent, |
2049 | "--transient-for" => $self->{term}->parent, |
1446 | "-display" => $self->{term}->display_id, |
2050 | "-display" => $self->{term}->display_id, |
1447 | "-pe" => "urxvt-popup") |
2051 | "-pe" => "urxvt-popup", |
1448 | or die "unable to create popup window\n"; |
2052 | ) or die "unable to create popup window\n"; |
|
|
2053 | |
|
|
2054 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
2055 | $term->ungrab; |
|
|
2056 | $term->destroy; |
|
|
2057 | die "unable to initialise popup window\n"; |
|
|
2058 | } |
1449 | } |
2059 | } |
1450 | |
2060 | |
1451 | sub DESTROY { |
2061 | sub DESTROY { |
1452 | my ($self) = @_; |
2062 | my ($self) = @_; |
1453 | |
2063 | |
1454 | delete $self->{term}{_destroy}{$self}; |
2064 | delete $self->{term}{_destroy}{$self}; |
1455 | $self->{term}->ungrab; |
2065 | $self->{term}->ungrab; |
1456 | } |
2066 | } |
1457 | |
2067 | |
1458 | =back |
2068 | =back |
|
|
2069 | |
|
|
2070 | =cut |
|
|
2071 | |
|
|
2072 | package urxvt::watcher; |
1459 | |
2073 | |
1460 | =head2 The C<urxvt::timer> Class |
2074 | =head2 The C<urxvt::timer> Class |
1461 | |
2075 | |
1462 | This class implements timer watchers/events. Time is represented as a |
2076 | This class implements timer watchers/events. Time is represented as a |
1463 | fractional number of seconds since the epoch. Example: |
2077 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1467 | ->new |
2081 | ->new |
1468 | ->interval (1) |
2082 | ->interval (1) |
1469 | ->cb (sub { |
2083 | ->cb (sub { |
1470 | $term->{overlay}->set (0, 0, |
2084 | $term->{overlay}->set (0, 0, |
1471 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2085 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1472 | }); |
2086 | }); |
1473 | |
2087 | |
1474 | =over 4 |
2088 | =over 4 |
1475 | |
2089 | |
1476 | =item $timer = new urxvt::timer |
2090 | =item $timer = new urxvt::timer |
1477 | |
2091 | |
… | |
… | |
1480 | |
2094 | |
1481 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2095 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
1482 | |
2096 | |
1483 | Set the callback to be called when the timer triggers. |
2097 | Set the callback to be called when the timer triggers. |
1484 | |
2098 | |
1485 | =item $tstamp = $timer->at |
|
|
1486 | |
|
|
1487 | Return the time this watcher will fire next. |
|
|
1488 | |
|
|
1489 | =item $timer = $timer->set ($tstamp) |
2099 | =item $timer = $timer->set ($tstamp[, $interval]) |
1490 | |
2100 | |
1491 | Set the time the event is generated to $tstamp. |
2101 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2102 | new $interval). |
1492 | |
2103 | |
1493 | =item $timer = $timer->interval ($interval) |
2104 | =item $timer = $timer->interval ($interval) |
1494 | |
2105 | |
1495 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2106 | By default (and when C<$interval> is C<0>), the timer will automatically |
1496 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2107 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
1497 | is automatically rescheduled at the given intervals. |
2108 | is automatically rescheduled at the given intervals. |
1498 | |
2109 | |
1499 | =item $timer = $timer->start |
2110 | =item $timer = $timer->start |
1500 | |
2111 | |
1501 | Start the timer. |
2112 | Start the timer. |
1502 | |
2113 | |
1503 | =item $timer = $timer->start ($tstamp) |
2114 | =item $timer = $timer->start ($tstamp[, $interval]) |
1504 | |
2115 | |
1505 | Set the event trigger time to C<$tstamp> and start the timer. |
2116 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2117 | also replaces the interval. |
|
|
2118 | |
|
|
2119 | =item $timer = $timer->after ($delay[, $interval]) |
|
|
2120 | |
|
|
2121 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1506 | |
2122 | |
1507 | =item $timer = $timer->stop |
2123 | =item $timer = $timer->stop |
1508 | |
2124 | |
1509 | Stop the timer. |
2125 | Stop the timer. |
1510 | |
2126 | |
… | |
… | |
1516 | |
2132 | |
1517 | $term->{socket} = ... |
2133 | $term->{socket} = ... |
1518 | $term->{iow} = urxvt::iow |
2134 | $term->{iow} = urxvt::iow |
1519 | ->new |
2135 | ->new |
1520 | ->fd (fileno $term->{socket}) |
2136 | ->fd (fileno $term->{socket}) |
1521 | ->events (urxvt::EVENT_READ) |
2137 | ->events (urxvt::EV_READ) |
1522 | ->start |
2138 | ->start |
1523 | ->cb (sub { |
2139 | ->cb (sub { |
1524 | my ($iow, $revents) = @_; |
2140 | my ($iow, $revents) = @_; |
1525 | # $revents must be 1 here, no need to check |
2141 | # $revents must be 1 here, no need to check |
1526 | sysread $term->{socket}, my $buf, 8192 |
2142 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1539 | Set the callback to be called when io events are triggered. C<$reventmask> |
2155 | Set the callback to be called when io events are triggered. C<$reventmask> |
1540 | is a bitset as described in the C<events> method. |
2156 | is a bitset as described in the C<events> method. |
1541 | |
2157 | |
1542 | =item $iow = $iow->fd ($fd) |
2158 | =item $iow = $iow->fd ($fd) |
1543 | |
2159 | |
1544 | Set the filedescriptor (not handle) to watch. |
2160 | Set the file descriptor (not handle) to watch. |
1545 | |
2161 | |
1546 | =item $iow = $iow->events ($eventmask) |
2162 | =item $iow = $iow->events ($eventmask) |
1547 | |
2163 | |
1548 | Set the event mask to watch. The only allowed values are |
2164 | Set the event mask to watch. The only allowed values are |
1549 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2165 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
1550 | together, or C<urxvt::EVENT_NONE>. |
2166 | together, or C<urxvt::EV_NONE>. |
1551 | |
2167 | |
1552 | =item $iow = $iow->start |
2168 | =item $iow = $iow->start |
1553 | |
2169 | |
1554 | Start watching for requested events on the given handle. |
2170 | Start watching for requested events on the given handle. |
1555 | |
2171 | |
1556 | =item $iow = $iow->stop |
2172 | =item $iow = $iow->stop |
1557 | |
2173 | |
1558 | Stop watching for events on the given filehandle. |
2174 | Stop watching for events on the given file handle. |
|
|
2175 | |
|
|
2176 | =back |
|
|
2177 | |
|
|
2178 | =head2 The C<urxvt::iw> Class |
|
|
2179 | |
|
|
2180 | This class implements idle watchers, that get called automatically when |
|
|
2181 | the process is idle. They should return as fast as possible, after doing |
|
|
2182 | some useful work. |
|
|
2183 | |
|
|
2184 | =over 4 |
|
|
2185 | |
|
|
2186 | =item $iw = new urxvt::iw |
|
|
2187 | |
|
|
2188 | Create a new idle watcher object in stopped state. |
|
|
2189 | |
|
|
2190 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
2191 | |
|
|
2192 | Set the callback to be called when the watcher triggers. |
|
|
2193 | |
|
|
2194 | =item $timer = $timer->start |
|
|
2195 | |
|
|
2196 | Start the watcher. |
|
|
2197 | |
|
|
2198 | =item $timer = $timer->stop |
|
|
2199 | |
|
|
2200 | Stop the watcher. |
|
|
2201 | |
|
|
2202 | =back |
|
|
2203 | |
|
|
2204 | =head2 The C<urxvt::pw> Class |
|
|
2205 | |
|
|
2206 | This class implements process watchers. They create an event whenever a |
|
|
2207 | process exits, after which they stop automatically. |
|
|
2208 | |
|
|
2209 | my $pid = fork; |
|
|
2210 | ... |
|
|
2211 | $term->{pw} = urxvt::pw |
|
|
2212 | ->new |
|
|
2213 | ->start ($pid) |
|
|
2214 | ->cb (sub { |
|
|
2215 | my ($pw, $exit_status) = @_; |
|
|
2216 | ... |
|
|
2217 | }); |
|
|
2218 | |
|
|
2219 | =over 4 |
|
|
2220 | |
|
|
2221 | =item $pw = new urxvt::pw |
|
|
2222 | |
|
|
2223 | Create a new process watcher in stopped state. |
|
|
2224 | |
|
|
2225 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
2226 | |
|
|
2227 | Set the callback to be called when the timer triggers. |
|
|
2228 | |
|
|
2229 | =item $pw = $timer->start ($pid) |
|
|
2230 | |
|
|
2231 | Tells the watcher to start watching for process C<$pid>. |
|
|
2232 | |
|
|
2233 | =item $pw = $pw->stop |
|
|
2234 | |
|
|
2235 | Stop the watcher. |
1559 | |
2236 | |
1560 | =back |
2237 | =back |
1561 | |
2238 | |
1562 | =head1 ENVIRONMENT |
2239 | =head1 ENVIRONMENT |
1563 | |
2240 | |
… | |
… | |
1570 | |
2247 | |
1571 | =item == 0 - fatal messages |
2248 | =item == 0 - fatal messages |
1572 | |
2249 | |
1573 | =item >= 3 - script loading and management |
2250 | =item >= 3 - script loading and management |
1574 | |
2251 | |
1575 | =item >=10 - all events received |
2252 | =item >=10 - all called hooks |
|
|
2253 | |
|
|
2254 | =item >=11 - hook return values |
1576 | |
2255 | |
1577 | =back |
2256 | =back |
1578 | |
2257 | |
1579 | =head1 AUTHOR |
2258 | =head1 AUTHOR |
1580 | |
2259 | |
1581 | Marc Lehmann <pcg@goof.com> |
2260 | Marc Lehmann <schmorp@schmorp.de> |
1582 | http://software.schmorp.de/pkg/rxvt-unicode |
2261 | http://software.schmorp.de/pkg/rxvt-unicode |
1583 | |
2262 | |
1584 | =cut |
2263 | =cut |
1585 | |
2264 | |
1586 | 1 |
2265 | 1 |
|
|
2266 | |
|
|
2267 | # vim: sw=3: |