1 | =encoding utf8 |
1 | =encoding utf8 |
2 | |
2 | |
3 | =head1 NAME |
3 | =head1 NAME |
4 | |
4 | |
5 | @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter |
5 | urxvtperl - rxvt-unicode's embedded perl interpreter |
6 | |
6 | |
7 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
8 | |
8 | |
9 | # create a file grab_test in $HOME: |
9 | # create a file grab_test in $HOME: |
10 | |
10 | |
11 | sub on_sel_grab { |
11 | sub on_sel_grab { |
12 | warn "you selected ", $_[0]->selection; |
12 | warn "you selected ", $_[0]->selection; |
13 | () |
13 | () |
14 | } |
14 | } |
15 | |
15 | |
16 | # start a @@RXVT_NAME@@ using it: |
16 | # start a urxvt using it: |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | urxvt --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Every time 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 "vars"' 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 urxvtd, 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" |
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
32 | and "perl-ext-common" resources to the empty string. |
32 | and "perl-ext-common" resources to the empty string. |
33 | |
33 | |
34 | =head1 PREPACKAGED EXTENSIONS |
34 | =head1 PREPACKAGED EXTENSIONS |
35 | |
35 | |
36 | This section describes the extensions delivered with this release. You can |
36 | A number of extensions are delivered with this release. You can find them |
37 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
37 | in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using |
|
|
38 | F<< man urxvt-<EXTENSIONNAME> >>. |
38 | |
39 | |
39 | You can activate them like this: |
40 | You can activate them like this: |
40 | |
41 | |
41 | @@RXVT_NAME@@ -pe <extensionname> |
42 | urxvt -pe <extensionname> |
42 | |
43 | |
43 | Or by adding them to the resource for extensions loaded by default: |
44 | Or by adding them to the resource for extensions loaded by default: |
44 | |
45 | |
45 | URxvt.perl-ext-common: default,selection-autotransform |
46 | URxvt.perl-ext-common: default,selection-autotransform |
46 | |
47 | |
47 | =over 4 |
48 | Extensions that add command line parameters or resources on their own are |
48 | |
49 | loaded automatically when used. |
49 | =item selection (enabled by default) |
|
|
50 | |
|
|
51 | (More) intelligent selection. This extension tries to be more intelligent |
|
|
52 | when the user extends selections (double-click and further clicks). Right |
|
|
53 | now, it tries to select words, urls and complete shell-quoted |
|
|
54 | arguments, which is very convenient, too, if your F<ls> supports |
|
|
55 | C<--quoting-style=shell>. |
|
|
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 | |
|
|
85 | This extension also offers following bindable keyboard commands: |
|
|
86 | |
|
|
87 | =over 4 |
|
|
88 | |
|
|
89 | =item rot13 |
|
|
90 | |
|
|
91 | Rot-13 the selection when activated. Used via keyboard trigger: |
|
|
92 | |
|
|
93 | URxvt.keysym.C-M-r: perl:selection:rot13 |
|
|
94 | |
|
|
95 | =back |
|
|
96 | |
|
|
97 | =item option-popup (enabled by default) |
|
|
98 | |
|
|
99 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
|
|
100 | runtime. |
|
|
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 | |
|
|
119 | =item selection-popup (enabled by default) |
|
|
120 | |
|
|
121 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
122 | text into various other formats/action (such as uri unescaping, perl |
|
|
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 | }; |
|
|
143 | |
|
|
144 | =item searchable-scrollback<hotkey> (enabled by default) |
|
|
145 | |
|
|
146 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
147 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
|
|
148 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
149 | screen. |
|
|
150 | |
|
|
151 | Inputting characters appends them to the regex and continues incremental |
|
|
152 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
|
|
153 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
|
|
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. |
|
|
158 | |
|
|
159 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
|
|
160 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
|
|
161 | or simply use an uppercase character which removes the "(?i)" prefix. |
|
|
162 | |
|
|
163 | See L<perlre> for more info about perl regular expression syntax. |
|
|
164 | |
|
|
165 | =item readline (enabled by default) |
|
|
166 | |
|
|
167 | A support package that tries to make editing with readline easier. At |
|
|
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
|
|
169 | move the text cursor to this position. It does so by generating as many |
|
|
170 | cursor-left or cursor-right keypresses as required (this only works |
|
|
171 | for programs that correctly support wide characters). |
|
|
172 | |
|
|
173 | To avoid too many false positives, this is only done when: |
|
|
174 | |
|
|
175 | =over 4 |
|
|
176 | |
|
|
177 | =item - the tty is in ICANON state. |
|
|
178 | |
|
|
179 | =item - the text cursor is visible. |
|
|
180 | |
|
|
181 | =item - the primary screen is currently being displayed. |
|
|
182 | |
|
|
183 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
184 | |
|
|
185 | =back |
|
|
186 | |
|
|
187 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
188 | might interfere with selection creation in harmless ways. |
|
|
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 | |
|
|
250 | Uses per-line display filtering (C<on_line_update>) to underline text |
|
|
251 | matching a certain pattern and make it clickable. When clicked with the |
|
|
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 from the keyboard. |
|
|
265 | Simply bind a keysym to "perl:matcher" as seen in the example below. |
|
|
266 | |
|
|
267 | Example configuration: |
|
|
268 | |
|
|
269 | URxvt.perl-ext: default,matcher |
|
|
270 | URxvt.urlLauncher: sensible-browser |
|
|
271 | URxvt.keysym.C-Delete: perl:matcher |
|
|
272 | URxvt.matcher.button: 1 |
|
|
273 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
274 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
275 | URxvt.matcher.launcher.2: gvim +$2 $1 |
|
|
276 | |
|
|
277 | =item xim-onthespot |
|
|
278 | |
|
|
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
280 | not work perfectly, and some input methods don't seem to work well with |
|
|
281 | OnTheSpot editing in general, but it seems to work at least for SCIM and |
|
|
282 | kinput2. |
|
|
283 | |
|
|
284 | You enable it by specifying this extension and a preedit style of |
|
|
285 | C<OnTheSpot>, i.e.: |
|
|
286 | |
|
|
287 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
288 | |
|
|
289 | =item kuake<hotkey> |
|
|
290 | |
|
|
291 | A very primitive quake-console-like extension. It was inspired by a |
|
|
292 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
293 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
294 | will show or hide itself. Another press of the accelerator key will hide |
|
|
295 | or show it again. |
|
|
296 | |
|
|
297 | Initially, the window will not be shown when using this extension. |
|
|
298 | |
|
|
299 | This is useful if you need a single terminal that is not using any desktop |
|
|
300 | space most of the time but is quickly available at the press of a key. |
|
|
301 | |
|
|
302 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
303 | extension will actually grab a physical key just for this function. |
|
|
304 | |
|
|
305 | If you want a quake-like animation, tell your window manager to do so |
|
|
306 | (fvwm can do it). |
|
|
307 | |
|
|
308 | =item block-graphics-to-ascii |
|
|
309 | |
|
|
310 | A not very useful example of filtering all text output to the terminal |
|
|
311 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
312 | similar-looking ascii character. |
|
|
313 | |
|
|
314 | =item digital-clock |
|
|
315 | |
|
|
316 | Displays a digital clock using the built-in overlay. |
|
|
317 | |
|
|
318 | =item remote-clipboard |
|
|
319 | |
|
|
320 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
321 | selection popup that allows one to run external commands to store the |
|
|
322 | selection somewhere and fetch it again. |
|
|
323 | |
|
|
324 | We use it to implement a "distributed selection mechanism", which just |
|
|
325 | means that one command uploads the file to a remote server, and another |
|
|
326 | reads it. |
|
|
327 | |
|
|
328 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
329 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
330 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
331 | the selection data on STDOUT (also in UTF-8). |
|
|
332 | |
|
|
333 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
334 | |
|
|
335 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
336 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
|
|
337 | |
|
|
338 | =item selection-pastebin |
|
|
339 | |
|
|
340 | This is a little rarely useful extension that Uploads the selection as |
|
|
341 | textfile to a remote site (or does other things). (The implementation is |
|
|
342 | not currently secure for use in a multiuser environment as it writes to |
|
|
343 | F</tmp> directly.). |
|
|
344 | |
|
|
345 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
346 | i.e. |
|
|
347 | |
|
|
348 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
349 | |
|
|
350 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
351 | the textfile. This command can be set via a resource: |
|
|
352 | |
|
|
353 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
354 | |
|
|
355 | And the default is likely not useful to anybody but the few people around |
|
|
356 | here :) |
|
|
357 | |
|
|
358 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
359 | the same content should lead to the same filename. |
|
|
360 | |
|
|
361 | After a successful upload the selection will be replaced by the text given |
|
|
362 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
363 | for the filename): |
|
|
364 | |
|
|
365 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
366 | |
|
|
367 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
368 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
369 | which works regardless of wether xrdb is used to parse the resource file |
|
|
370 | or not. |
|
|
371 | |
|
|
372 | =item example-refresh-hooks |
|
|
373 | |
|
|
374 | Displays a very simple digital clock in the upper right corner of the |
|
|
375 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
376 | overlays or changes. |
|
|
377 | |
|
|
378 | =back |
|
|
379 | |
50 | |
380 | =head1 API DOCUMENTATION |
51 | =head1 API DOCUMENTATION |
381 | |
52 | |
382 | =head2 General API Considerations |
53 | =head2 General API Considerations |
383 | |
54 | |
… | |
… | |
397 | |
68 | |
398 | =over 4 |
69 | =over 4 |
399 | |
70 | |
400 | =item $text |
71 | =item $text |
401 | |
72 | |
402 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
73 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
403 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
74 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
404 | |
75 | |
405 | =item $string |
76 | =item $string |
406 | |
77 | |
407 | A perl text string, with an emphasis on I<text>. It can store all unicode |
78 | A perl text string, with an emphasis on I<text>. It can store all unicode |
… | |
… | |
411 | =item $octets |
82 | =item $octets |
412 | |
83 | |
413 | Either binary data or - more common - a text string encoded in a |
84 | Either binary data or - more common - a text string encoded in a |
414 | locale-specific way. |
85 | locale-specific way. |
415 | |
86 | |
|
|
87 | =item $keysym |
|
|
88 | |
|
|
89 | an integer that is a valid X11 keysym code. You can convert a string |
|
|
90 | into a keysym and viceversa by using C<XStringToKeysym> and |
|
|
91 | C<XKeysymToString>. |
|
|
92 | |
416 | =back |
93 | =back |
417 | |
94 | |
418 | =head2 Extension Objects |
95 | =head2 Extension Objects |
419 | |
96 | |
420 | Every perl extension is a perl class. A separate perl object is created |
97 | Every perl extension is a perl class. A separate perl object is created |
421 | for each terminal, and each terminal has its own set of extenion objects, |
98 | for each terminal, and each terminal has its own set of extension objects, |
422 | which are passed as the first parameter to hooks. So extensions can use |
99 | which are passed as the first parameter to hooks. So extensions can use |
423 | their C<$self> object without having to think about clashes with other |
100 | their C<$self> object without having to think about clashes with other |
424 | extensions or other terminals, with the exception of methods and members |
101 | extensions or other terminals, with the exception of methods and members |
425 | that begin with an underscore character C<_>: these are reserved for |
102 | that begin with an underscore character C<_>: these are reserved for |
426 | internal use. |
103 | internal use. |
427 | |
104 | |
428 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
105 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
429 | C<urxvt::term> class on this object. |
106 | C<urxvt::term> class on this object. |
430 | |
107 | |
431 | It has the following methods and data members: |
108 | Additional methods only supported for extension objects are described in |
432 | |
109 | the C<urxvt::extension> section below. |
433 | =over 4 |
|
|
434 | |
|
|
435 | =item $urxvt_term = $self->{term} |
|
|
436 | |
|
|
437 | Returns the C<urxvt::term> object associated with this instance of the |
|
|
438 | extension. This member I<must not> be changed in any way. |
|
|
439 | |
|
|
440 | =item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
441 | |
|
|
442 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
443 | this extension, replacing any previous hook. This is useful when you want |
|
|
444 | to overwrite time-critical hooks only temporarily. |
|
|
445 | |
|
|
446 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
447 | |
|
|
448 | Dynamically disable the given hooks. |
|
|
449 | |
|
|
450 | =back |
|
|
451 | |
110 | |
452 | =head2 Hooks |
111 | =head2 Hooks |
453 | |
112 | |
454 | The following subroutines can be declared in extension files, and will be |
113 | The following subroutines can be declared in extension files, and will be |
455 | called whenever the relevant event happens. |
114 | called whenever the relevant event happens. |
… | |
… | |
541 | |
200 | |
542 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
201 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
543 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
202 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
544 | number of lines that will be in the scrollback buffer. |
203 | number of lines that will be in the scrollback buffer. |
545 | |
204 | |
546 | =item on_osc_seq $term, $op, $args |
205 | =item on_osc_seq $term, $op, $args, $resp |
547 | |
206 | |
548 | Called on every OSC sequence and can be used to suppress it or modify its |
207 | Called on every OSC sequence and can be used to suppress it or modify its |
549 | behaviour. The default should be to return an empty list. A true value |
208 | behaviour. The default should be to return an empty list. A true value |
550 | suppresses execution of the request completely. Make sure you don't get |
209 | suppresses execution of the request completely. Make sure you don't get |
551 | confused by recursive invocations when you output an osc sequence within |
210 | confused by recursive invocations when you output an OSC sequence within |
552 | this callback. |
211 | this callback. |
553 | |
212 | |
554 | C<on_osc_seq_perl> should be used for new behaviour. |
213 | C<on_osc_seq_perl> should be used for new behaviour. |
555 | |
214 | |
556 | =item on_osc_seq_perl $term, $string |
215 | =item on_osc_seq_perl $term, $args, $resp |
557 | |
216 | |
558 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
217 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
559 | operating system command) is processed. Cursor position and other state |
218 | operating system command) is processed. Cursor position and other state |
560 | information is up-to-date when this happens. For interoperability, the |
219 | information is up-to-date when this happens. For interoperability, the |
561 | string should start with the extension name and a colon, to distinguish |
220 | string should start with the extension name (sans -osc) and a semicolon, |
562 | it from commands for other extensions, and this might be enforced in the |
221 | to distinguish it from commands for other extensions, and this might be |
563 | future. |
222 | enforced in the future. |
|
|
223 | |
|
|
224 | For example, C<overlay-osc> uses this: |
|
|
225 | |
|
|
226 | sub on_osc_seq_perl { |
|
|
227 | my ($self, $osc, $resp) = @_; |
|
|
228 | |
|
|
229 | return unless $osc =~ s/^overlay;//; |
|
|
230 | |
|
|
231 | ... process remaining $osc string |
|
|
232 | } |
564 | |
233 | |
565 | Be careful not ever to trust (in a security sense) the data you receive, |
234 | Be careful not ever to trust (in a security sense) the data you receive, |
566 | as its source can not easily be controlled (e-mail content, messages from |
235 | as its source can not easily be controlled (e-mail content, messages from |
567 | other users on the same system etc.). |
236 | other users on the same system etc.). |
|
|
237 | |
|
|
238 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
239 | sender. |
568 | |
240 | |
569 | =item on_add_lines $term, $string |
241 | =item on_add_lines $term, $string |
570 | |
242 | |
571 | Called whenever text is about to be output, with the text as argument. You |
243 | Called whenever text is about to be output, with the text as argument. You |
572 | can filter/change and output the text yourself by returning a true value |
244 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
577 | =item on_tt_write $term, $octets |
249 | =item on_tt_write $term, $octets |
578 | |
250 | |
579 | Called whenever some data is written to the tty/pty and can be used to |
251 | Called whenever some data is written to the tty/pty and can be used to |
580 | suppress or filter tty input. |
252 | suppress or filter tty input. |
581 | |
253 | |
|
|
254 | =item on_tt_paste $term, $octets |
|
|
255 | |
|
|
256 | Called whenever text is about to be pasted, with the text as argument. You |
|
|
257 | can filter/change and paste the text yourself by returning a true value |
|
|
258 | and calling C<< $term->tt_paste >> yourself. C<$octets> is |
|
|
259 | locale-encoded. |
|
|
260 | |
582 | =item on_line_update $term, $row |
261 | =item on_line_update $term, $row |
583 | |
262 | |
584 | Called whenever a line was updated or changed. Can be used to filter |
263 | Called whenever a line was updated or changed. Can be used to filter |
585 | screen output (e.g. underline urls or other useless stuff). Only lines |
264 | screen output (e.g. underline urls or other useless stuff). Only lines |
586 | that are being shown will be filtered, and, due to performance reasons, |
265 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
593 | later with the already-modified line (e.g. if unrelated parts change), so |
272 | later with the already-modified line (e.g. if unrelated parts change), so |
594 | you cannot just toggle rendition bits, but only set them. |
273 | you cannot just toggle rendition bits, but only set them. |
595 | |
274 | |
596 | =item on_refresh_begin $term |
275 | =item on_refresh_begin $term |
597 | |
276 | |
598 | Called just before the screen gets redrawn. Can be used for overlay |
277 | Called just before the screen gets redrawn. Can be used for overlay or |
599 | or similar effects by modify terminal contents in refresh_begin, and |
278 | similar effects by modifying the terminal contents in refresh_begin, and |
600 | restoring them in refresh_end. The built-in overlay and selection display |
279 | restoring them in refresh_end. The built-in overlay and selection display |
601 | code is run after this hook, and takes precedence. |
280 | code is run after this hook, and takes precedence. |
602 | |
281 | |
603 | =item on_refresh_end $term |
282 | =item on_refresh_end $term |
604 | |
283 | |
605 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
284 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
606 | |
285 | |
607 | =item on_user_command $term, $string |
286 | =item on_user_command $term, $string *DEPRECATED* |
608 | |
287 | |
609 | Called whenever a user-configured event is being activated (e.g. via |
288 | Called whenever a user-configured event is being activated (e.g. via |
610 | a C<perl:string> action bound to a key, see description of the B<keysym> |
289 | a C<perl:string> action bound to a key, see description of the B<keysym> |
611 | resource in the @@RXVT_NAME@@(1) manpage). |
290 | resource in the urxvt(1) manpage). |
612 | |
291 | |
613 | The event is simply the action string. This interface is assumed to change |
292 | The event is simply the action string. This interface is going away in |
614 | slightly in the future. |
293 | preference to the C<on_action> hook. |
615 | |
294 | |
616 | =item on_resize_all_windows $tern, $new_width, $new_height |
295 | =item on_resize_all_windows $term, $new_width, $new_height |
617 | |
296 | |
618 | Called just after the new window size has been calculated, but before |
297 | Called just after the new window size has been calculated, but before |
619 | windows are actually being resized or hints are being set. If this hook |
298 | windows are actually being resized or hints are being set. If this hook |
620 | returns TRUE, setting of the window hints is being skipped. |
299 | returns a true value, setting of the window hints is being skipped. |
621 | |
300 | |
622 | =item on_x_event $term, $event |
301 | =item on_x_event $term, $event |
623 | |
302 | |
624 | Called on every X event received on the vt window (and possibly other |
303 | Called on every X event received on the vt window (and possibly other |
625 | windows). Should only be used as a last resort. Most event structure |
304 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
655 | |
334 | |
656 | =item on_map_notify $term, $event |
335 | =item on_map_notify $term, $event |
657 | |
336 | |
658 | =item on_unmap_notify $term, $event |
337 | =item on_unmap_notify $term, $event |
659 | |
338 | |
660 | Called whenever the corresponding X event is received for the terminal If |
339 | Called whenever the corresponding X event is received for the terminal. If |
661 | the hook returns true, then the even will be ignored by rxvt-unicode. |
340 | the hook returns true, then the event will be ignored by rxvt-unicode. |
662 | |
341 | |
663 | The event is a hash with most values as named by Xlib (see the XEvent |
342 | The event is a hash with most values as named by Xlib (see the XEvent |
664 | manpage), with the additional members C<row> and C<col>, which are the |
343 | manpage), with the additional members C<row> and C<col>, which are the |
665 | (real, not screen-based) row and column under the mouse cursor. |
344 | (real, not screen-based) row and column under the mouse cursor. |
666 | |
345 | |
667 | C<on_key_press> additionally receives the string rxvt-unicode would |
346 | C<on_key_press> additionally receives the string rxvt-unicode would |
668 | output, if any, in locale-specific encoding. |
347 | output, if any, in locale-specific encoding. |
669 | |
348 | |
670 | subwindow. |
|
|
671 | |
|
|
672 | =item on_client_message $term, $event |
349 | =item on_client_message $term, $event |
673 | |
350 | |
674 | =item on_wm_protocols $term, $event |
351 | =item on_wm_protocols $term, $event |
675 | |
352 | |
676 | =item on_wm_delete_window $term, $event |
353 | =item on_wm_delete_window $term, $event |
677 | |
354 | |
678 | Called when various types of ClientMessage events are received (all with |
355 | Called when various types of ClientMessage events are received (all with |
679 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
356 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
680 | |
357 | |
|
|
358 | =item on_bell $term |
|
|
359 | |
|
|
360 | Called on receipt of a bell character. |
|
|
361 | |
681 | =back |
362 | =back |
682 | |
363 | |
683 | =cut |
364 | =cut |
684 | |
365 | |
685 | package urxvt; |
366 | package urxvt; |
686 | |
367 | |
687 | use utf8; |
368 | use utf8; |
688 | use strict; |
369 | use strict 'vars'; |
689 | use Carp (); |
370 | use Carp (); |
690 | use Scalar::Util (); |
371 | use Scalar::Util (); |
691 | use List::Util (); |
372 | use List::Util (); |
692 | |
373 | |
693 | our $VERSION = 1; |
374 | our $VERSION = 1; |
694 | our $TERM; |
375 | our $TERM; |
695 | our @TERM_INIT; |
376 | our @TERM_INIT; # should go, prevents async I/O etc. |
696 | our @TERM_EXT; |
377 | our @TERM_EXT; # should go, prevents async I/O etc. |
697 | our @HOOKNAME; |
378 | our @HOOKNAME; |
698 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
379 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
699 | our %OPTION; |
380 | our %OPTION; |
700 | |
381 | |
701 | our $LIBDIR; |
382 | our $LIBDIR; |
… | |
… | |
749 | |
430 | |
750 | =over 4 |
431 | =over 4 |
751 | |
432 | |
752 | =item urxvt::fatal $errormessage |
433 | =item urxvt::fatal $errormessage |
753 | |
434 | |
754 | Fatally aborts execution with the given error message. Avoid at all |
435 | Fatally aborts execution with the given error message (which should |
755 | costs! The only time this is acceptable is when the terminal process |
436 | include a trailing newline). Avoid at all costs! The only time this |
756 | starts up. |
437 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
438 | terminal from starting up. |
757 | |
439 | |
758 | =item urxvt::warn $string |
440 | =item urxvt::warn $string |
759 | |
441 | |
760 | Calls C<rxvt_warn> with the given string which should not include a |
442 | Calls C<rxvt_warn> with the given string which should include a trailing |
761 | newline. The module also overwrites the C<warn> builtin with a function |
443 | newline. The module also overwrites the C<warn> builtin with a function |
762 | that calls this function. |
444 | that calls this function. |
763 | |
445 | |
764 | Using this function has the advantage that its output ends up in the |
446 | Using this function has the advantage that its output ends up in the |
765 | correct place, e.g. on stderr of the connecting urxvtc client. |
447 | correct place, e.g. on stderr of the connecting urxvtc client. |
… | |
… | |
769 | =item @terms = urxvt::termlist |
451 | =item @terms = urxvt::termlist |
770 | |
452 | |
771 | Returns all urxvt::term objects that exist in this process, regardless of |
453 | Returns all urxvt::term objects that exist in this process, regardless of |
772 | whether they are started, being destroyed etc., so be careful. Only term |
454 | whether they are started, being destroyed etc., so be careful. Only term |
773 | objects that have perl extensions attached will be returned (because there |
455 | objects that have perl extensions attached will be returned (because there |
774 | is no urxvt::term objet associated with others). |
456 | is no urxvt::term object associated with others). |
775 | |
457 | |
776 | =item $time = urxvt::NOW |
458 | =item $time = urxvt::NOW |
777 | |
459 | |
778 | Returns the "current time" (as per the event loop). |
460 | Returns the "current time" (as per the event loop). |
779 | |
461 | |
… | |
… | |
822 | |
504 | |
823 | =item $rend = urxvt::OVERLAY_RSTYLE |
505 | =item $rend = urxvt::OVERLAY_RSTYLE |
824 | |
506 | |
825 | Return the rendition mask used for overlays by default. |
507 | Return the rendition mask used for overlays by default. |
826 | |
508 | |
827 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
509 | =item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, |
|
|
510 | urxvt::RS_RVid, urxvt::RS_Uline |
828 | |
511 | |
829 | Return the bit that enabled bold, italic, blink, reverse-video and |
512 | Return the bit that enabled bold, italic, blink, reverse-video and |
830 | underline, respectively. To enable such a style, just logically OR it into |
513 | underline, respectively. To enable such a style, just logically OR it into |
831 | the bitset. |
514 | the bitset. |
832 | |
515 | |
… | |
… | |
869 | }; |
552 | }; |
870 | } |
553 | } |
871 | |
554 | |
872 | no warnings 'utf8'; |
555 | no warnings 'utf8'; |
873 | |
556 | |
|
|
557 | sub parse_resource { |
|
|
558 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
|
|
559 | |
|
|
560 | $name =~ y/-/./ if $isarg; |
|
|
561 | |
|
|
562 | $term->scan_extensions; |
|
|
563 | |
|
|
564 | my $r = $term->{meta}{resource}; |
|
|
565 | keys %$r; # reset iterator |
|
|
566 | while (my ($pattern, $v) = each %$r) { |
|
|
567 | if ( |
|
|
568 | $pattern =~ /\.$/ |
|
|
569 | ? $pattern eq substr $name, 0, length $pattern |
|
|
570 | : $pattern eq $name |
|
|
571 | ) { |
|
|
572 | $name = "$urxvt::RESCLASS.$name"; |
|
|
573 | |
|
|
574 | push @{ $term->{perl_ext_3} }, $v->[0]; |
|
|
575 | |
|
|
576 | if ($v->[1] eq "boolean") { |
|
|
577 | $term->put_option_db ($name, $flag ? "true" : "false"); |
|
|
578 | return 1; |
|
|
579 | } else { |
|
|
580 | $term->put_option_db ($name, $value); |
|
|
581 | return 1 + 2; |
|
|
582 | } |
|
|
583 | } |
|
|
584 | } |
|
|
585 | |
|
|
586 | 0 |
|
|
587 | } |
|
|
588 | |
|
|
589 | sub usage { |
|
|
590 | my ($term, $usage_type) = @_; |
|
|
591 | |
|
|
592 | $term->scan_extensions; |
|
|
593 | |
|
|
594 | my $r = $term->{meta}{resource}; |
|
|
595 | |
|
|
596 | for my $pattern (sort keys %$r) { |
|
|
597 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
|
|
598 | |
|
|
599 | $desc .= " (-pe $ext)"; |
|
|
600 | |
|
|
601 | if ($usage_type == 1) { |
|
|
602 | $pattern =~ y/./-/; |
|
|
603 | $pattern =~ s/-$/-.../g; |
|
|
604 | |
|
|
605 | if ($type eq "boolean") { |
|
|
606 | urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc; |
|
|
607 | } else { |
|
|
608 | urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc; |
|
|
609 | } |
|
|
610 | } else { |
|
|
611 | $pattern =~ s/\.$/.*/g; |
|
|
612 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
|
|
613 | } |
|
|
614 | } |
|
|
615 | } |
|
|
616 | |
874 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
617 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
875 | |
618 | |
876 | sub verbose { |
619 | sub verbose { |
877 | my ($level, $msg) = @_; |
620 | my ($level, $msg) = @_; |
878 | warn "$msg\n" if $level <= $verbosity; |
621 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
890 | $pkg =~ s/[^[:word:]]/_/g; |
633 | $pkg =~ s/[^[:word:]]/_/g; |
891 | $pkg = "urxvt::ext::$pkg"; |
634 | $pkg = "urxvt::ext::$pkg"; |
892 | |
635 | |
893 | verbose 3, "loading extension '$path' into package '$pkg'"; |
636 | verbose 3, "loading extension '$path' into package '$pkg'"; |
894 | |
637 | |
|
|
638 | (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish |
|
|
639 | |
895 | open my $fh, "<:raw", $path |
640 | open my $fh, "<:raw", $path |
896 | or die "$path: $!"; |
641 | or die "$path: $!"; |
897 | |
642 | |
898 | my $source = |
643 | my $source = |
899 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
644 | "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n" |
900 | . "#line 1 \"$path\"\n{\n" |
645 | . "#line 1 \"$path\"\n{\n" |
901 | . (do { local $/; <$fh> }) |
646 | . (do { local $/; <$fh> }) |
902 | . "\n};\n1"; |
647 | . "\n};\n1"; |
903 | |
648 | |
904 | eval $source |
649 | eval $source |
… | |
… | |
913 | # called by the rxvt core |
658 | # called by the rxvt core |
914 | sub invoke { |
659 | sub invoke { |
915 | local $TERM = shift; |
660 | local $TERM = shift; |
916 | my $htype = shift; |
661 | my $htype = shift; |
917 | |
662 | |
918 | if ($htype == 0) { # INIT |
663 | if ($htype == HOOK_INIT) { |
919 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
664 | my @dirs = $TERM->perl_libdirs; |
|
|
665 | |
|
|
666 | $TERM->scan_extensions; |
920 | |
667 | |
921 | my %ext_arg; |
668 | my %ext_arg; |
922 | |
669 | |
923 | { |
670 | { |
924 | my @init = @TERM_INIT; |
671 | my @init = @TERM_INIT; |
… | |
… | |
927 | my @pkg = @TERM_EXT; |
674 | my @pkg = @TERM_EXT; |
928 | @TERM_EXT = (); |
675 | @TERM_EXT = (); |
929 | $TERM->register_package ($_) for @pkg; |
676 | $TERM->register_package ($_) for @pkg; |
930 | } |
677 | } |
931 | |
678 | |
|
|
679 | for ( |
932 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
680 | grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 |
|
|
681 | ) { |
933 | if ($_ eq "default") { |
682 | if ($_ eq "default") { |
934 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
683 | |
|
|
684 | $ext_arg{$_} = [] |
|
|
685 | for |
|
|
686 | qw(selection option-popup selection-popup readline), |
|
|
687 | map $_->[0], values %{ $TERM->{meta}{binding} }, |
|
|
688 | @{ delete $TERM->{perl_ext_3} }; |
|
|
689 | |
|
|
690 | for ($TERM->_keysym_resources) { |
|
|
691 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
|
|
692 | next unless /^([A-Za-z0-9_\-]+):/; |
|
|
693 | |
|
|
694 | my $ext = $1; |
|
|
695 | $ext =~ y/-/_/; |
|
|
696 | |
|
|
697 | $ext_arg{$ext} = []; |
|
|
698 | } |
|
|
699 | |
935 | } elsif (/^-(.*)$/) { |
700 | } elsif (/^-(.*)$/) { |
936 | delete $ext_arg{$1}; |
701 | delete $ext_arg{$1}; |
|
|
702 | |
937 | } elsif (/^([^<]+)<(.*)>$/) { |
703 | } elsif (/^([^<]+)<(.*)>$/) { |
938 | push @{ $ext_arg{$1} }, $2; |
704 | push @{ $ext_arg{$1} }, $2; |
|
|
705 | |
939 | } else { |
706 | } else { |
940 | $ext_arg{$_} ||= []; |
707 | $ext_arg{$_} ||= []; |
|
|
708 | } |
|
|
709 | } |
|
|
710 | |
|
|
711 | # now register default key bindings |
|
|
712 | for my $ext (sort keys %ext_arg) { |
|
|
713 | while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) { |
|
|
714 | $TERM->bind_action ($k, "$v->[0]:$v->[1]"); |
941 | } |
715 | } |
942 | } |
716 | } |
943 | |
717 | |
944 | for my $ext (sort keys %ext_arg) { |
718 | for my $ext (sort keys %ext_arg) { |
945 | my @files = grep -f $_, map "$_/$ext", @dirs; |
719 | my @files = grep -f $_, map "$_/$ext", @dirs; |
… | |
… | |
959 | |
733 | |
960 | if (my $cb = $TERM->{_hook}[$htype]) { |
734 | if (my $cb = $TERM->{_hook}[$htype]) { |
961 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
735 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
962 | if $verbosity >= 10; |
736 | if $verbosity >= 10; |
963 | |
737 | |
|
|
738 | if ($htype == HOOK_ACTION) { |
|
|
739 | # this hook is only sent to the extension with the name |
|
|
740 | # matching the first arg |
|
|
741 | my $pkg = shift; |
|
|
742 | $pkg =~ y/-/_/; |
|
|
743 | $pkg = "urxvt::ext::$pkg"; |
|
|
744 | |
|
|
745 | $cb = $cb->{$pkg} |
|
|
746 | or return undef; #TODO: maybe warn user? |
|
|
747 | |
|
|
748 | $cb = { $pkg => $cb }; |
|
|
749 | } |
|
|
750 | |
964 | for my $pkg (keys %$cb) { |
751 | for my $pkg (keys %$cb) { |
965 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
752 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
966 | $retval ||= $retval_; |
753 | $retval ||= $retval_; |
967 | |
754 | |
968 | if ($@) { |
755 | if ($@) { |
969 | $TERM->ungrab; # better to lose the grab than the session |
756 | $TERM->ungrab; # better to lose the grab than the session |
970 | warn $@; |
757 | warn $@; |
… | |
… | |
973 | |
760 | |
974 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
761 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
975 | if $verbosity >= 11; |
762 | if $verbosity >= 11; |
976 | } |
763 | } |
977 | |
764 | |
978 | if ($htype == 1) { # DESTROY |
765 | if ($htype == HOOK_DESTROY) { |
979 | # clear package objects |
766 | # clear package objects |
980 | %$_ = () for values %{ $TERM->{_pkg} }; |
767 | %$_ = () for values %{ $TERM->{_pkg} }; |
981 | |
768 | |
982 | # clear package |
769 | # clear package |
983 | %$TERM = (); |
770 | %$TERM = (); |
… | |
… | |
1013 | } |
800 | } |
1014 | } |
801 | } |
1015 | ($mask, @color{qw(fg bg)}, \@failed) |
802 | ($mask, @color{qw(fg bg)}, \@failed) |
1016 | } |
803 | } |
1017 | |
804 | |
1018 | # urxvt::term::extension |
|
|
1019 | |
|
|
1020 | package urxvt::term::extension; |
805 | package urxvt::term::extension; |
1021 | |
806 | |
1022 | sub enable { |
807 | =head2 The C<urxvt::term::extension> class |
1023 | my ($self, %hook) = @_; |
|
|
1024 | my $pkg = $self->{_pkg}; |
|
|
1025 | |
808 | |
1026 | while (my ($name, $cb) = each %hook) { |
809 | Each extension attached to a terminal object is represented by |
1027 | my $htype = $HOOKTYPE{uc $name}; |
810 | a C<urxvt::term::extension> object. |
1028 | defined $htype |
|
|
1029 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1030 | |
811 | |
1031 | $self->set_should_invoke ($htype, +1) |
812 | You can use these objects, which are passed to all callbacks to store any |
1032 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
813 | state related to the terminal and extension instance. |
1033 | |
814 | |
1034 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
815 | The methods (And data members) documented below can be called on extension |
1035 | } |
816 | objects, in addition to call methods documented for the <urxvt::term> |
1036 | } |
817 | class. |
1037 | |
818 | |
1038 | sub disable { |
819 | =over 4 |
1039 | my ($self, @hook) = @_; |
|
|
1040 | my $pkg = $self->{_pkg}; |
|
|
1041 | |
820 | |
1042 | for my $name (@hook) { |
821 | =item $urxvt_term = $self->{term} |
1043 | my $htype = $HOOKTYPE{uc $name}; |
|
|
1044 | defined $htype |
|
|
1045 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1046 | |
822 | |
1047 | $self->set_should_invoke ($htype, -1) |
823 | Returns the C<urxvt::term> object associated with this instance of the |
1048 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
824 | extension. This member I<must not> be changed in any way. |
1049 | } |
825 | |
1050 | } |
826 | =cut |
1051 | |
827 | |
1052 | our $AUTOLOAD; |
828 | our $AUTOLOAD; |
1053 | |
829 | |
1054 | sub AUTOLOAD { |
830 | sub AUTOLOAD { |
1055 | $AUTOLOAD =~ /:([^:]+)$/ |
831 | $AUTOLOAD =~ /:([^:]+)$/ |
… | |
… | |
1068 | |
844 | |
1069 | sub DESTROY { |
845 | sub DESTROY { |
1070 | # nop |
846 | # nop |
1071 | } |
847 | } |
1072 | |
848 | |
1073 | # urxvt::destroy_hook |
849 | # urxvt::destroy_hook (basically a cheap Guard:: implementation) |
1074 | |
850 | |
1075 | sub urxvt::destroy_hook::DESTROY { |
851 | sub urxvt::destroy_hook::DESTROY { |
1076 | ${$_[0]}->(); |
852 | ${$_[0]}->(); |
1077 | } |
853 | } |
1078 | |
854 | |
1079 | sub urxvt::destroy_hook(&) { |
855 | sub urxvt::destroy_hook(&) { |
1080 | bless \shift, urxvt::destroy_hook:: |
856 | bless \shift, urxvt::destroy_hook:: |
1081 | } |
857 | } |
|
|
858 | |
|
|
859 | =item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
860 | |
|
|
861 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
862 | this extension, replacing any hook previously installed via C<enable> in |
|
|
863 | this extension. |
|
|
864 | |
|
|
865 | This is useful when you want to overwrite time-critical hooks only |
|
|
866 | temporarily. |
|
|
867 | |
|
|
868 | To install additional callbacks for the same hook, you can use the C<on> |
|
|
869 | method of the C<urxvt::term> class. |
|
|
870 | |
|
|
871 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
872 | |
|
|
873 | Dynamically disable the given hooks. |
|
|
874 | |
|
|
875 | =cut |
|
|
876 | |
|
|
877 | sub enable { |
|
|
878 | my ($self, %hook) = @_; |
|
|
879 | my $pkg = $self->{_pkg}; |
|
|
880 | |
|
|
881 | while (my ($name, $cb) = each %hook) { |
|
|
882 | my $htype = $HOOKTYPE{uc $name}; |
|
|
883 | defined $htype |
|
|
884 | or Carp::croak "unsupported hook type '$name'"; |
|
|
885 | |
|
|
886 | $self->set_should_invoke ($htype, +1) |
|
|
887 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
|
|
888 | |
|
|
889 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
890 | } |
|
|
891 | } |
|
|
892 | |
|
|
893 | sub disable { |
|
|
894 | my ($self, @hook) = @_; |
|
|
895 | my $pkg = $self->{_pkg}; |
|
|
896 | |
|
|
897 | for my $name (@hook) { |
|
|
898 | my $htype = $HOOKTYPE{uc $name}; |
|
|
899 | defined $htype |
|
|
900 | or Carp::croak "unsupported hook type '$name'"; |
|
|
901 | |
|
|
902 | $self->set_should_invoke ($htype, -1) |
|
|
903 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
|
|
904 | } |
|
|
905 | } |
|
|
906 | |
|
|
907 | =item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
908 | |
|
|
909 | Similar to the C<enable> enable, but installs additional callbacks for |
|
|
910 | the given hook(s) (that is, it doesn't replace existing callbacks), and |
|
|
911 | returns a guard object. When the guard object is destroyed the callbacks |
|
|
912 | are disabled again. |
|
|
913 | |
|
|
914 | =cut |
|
|
915 | |
|
|
916 | sub urxvt::extension::on_disable::DESTROY { |
|
|
917 | my $disable = shift; |
|
|
918 | |
|
|
919 | my $term = delete $disable->{""}; |
|
|
920 | |
|
|
921 | while (my ($htype, $id) = each %$disable) { |
|
|
922 | delete $term->{_hook}[$htype]{$id}; |
|
|
923 | $term->set_should_invoke ($htype, -1); |
|
|
924 | } |
|
|
925 | } |
|
|
926 | |
|
|
927 | sub on { |
|
|
928 | my ($self, %hook) = @_; |
|
|
929 | |
|
|
930 | my $term = $self->{term}; |
|
|
931 | |
|
|
932 | my %disable = ( "" => $term ); |
|
|
933 | |
|
|
934 | while (my ($name, $cb) = each %hook) { |
|
|
935 | my $htype = $HOOKTYPE{uc $name}; |
|
|
936 | defined $htype |
|
|
937 | or Carp::croak "unsupported hook type '$name'"; |
|
|
938 | |
|
|
939 | $term->set_should_invoke ($htype, +1); |
|
|
940 | $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 } |
|
|
941 | = sub { shift; $cb->($self, @_) }; # very ugly indeed |
|
|
942 | } |
|
|
943 | |
|
|
944 | bless \%disable, "urxvt::extension::on_disable" |
|
|
945 | } |
|
|
946 | |
|
|
947 | =item $self->x_resource ($pattern) |
|
|
948 | |
|
|
949 | =item $self->x_resource_boolean ($pattern) |
|
|
950 | |
|
|
951 | These methods support an additional C<%> prefix when called on an |
|
|
952 | extension object - see the description of these methods in the |
|
|
953 | C<urxvt::term> class for details. |
|
|
954 | |
|
|
955 | =cut |
|
|
956 | |
|
|
957 | sub x_resource { |
|
|
958 | my ($self, $name) = @_; |
|
|
959 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
960 | $self->{term}->x_resource ($name) |
|
|
961 | } |
|
|
962 | |
|
|
963 | sub x_resource_boolean { |
|
|
964 | my ($self, $name) = @_; |
|
|
965 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
966 | $self->{term}->x_resource_boolean ($name) |
|
|
967 | } |
|
|
968 | |
|
|
969 | =back |
|
|
970 | |
|
|
971 | =cut |
1082 | |
972 | |
1083 | package urxvt::anyevent; |
973 | package urxvt::anyevent; |
1084 | |
974 | |
1085 | =head2 The C<urxvt::anyevent> Class |
975 | =head2 The C<urxvt::anyevent> Class |
1086 | |
976 | |
1087 | The sole purpose of this class is to deliver an interface to the |
977 | The sole purpose of this class is to deliver an interface to the |
1088 | C<AnyEvent> module - any module using it will work inside urxvt without |
978 | C<AnyEvent> module - any module using it will work inside urxvt without |
1089 | further programming. The only exception is that you cannot wait on |
979 | further programming. The only exception is that you cannot wait on |
1090 | condition variables, but non-blocking condvar use is ok. What this means |
980 | condition variables, but non-blocking condvar use is ok. |
1091 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
1092 | work. |
|
|
1093 | |
981 | |
1094 | =cut |
982 | In practical terms this means is that you cannot use blocking APIs, but |
|
|
983 | the non-blocking variant should work. |
1095 | |
984 | |
|
|
985 | =cut |
|
|
986 | |
1096 | our $VERSION = 1; |
987 | our $VERSION = '5.23'; |
1097 | |
988 | |
1098 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
989 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1099 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
990 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1100 | |
991 | |
1101 | sub timer { |
992 | sub timer { |
… | |
… | |
1103 | |
994 | |
1104 | my $cb = $arg{cb}; |
995 | my $cb = $arg{cb}; |
1105 | |
996 | |
1106 | urxvt::timer |
997 | urxvt::timer |
1107 | ->new |
998 | ->new |
1108 | ->start (urxvt::NOW + $arg{after}) |
999 | ->after ($arg{after}, $arg{interval}) |
1109 | ->cb (sub { |
1000 | ->cb ($arg{interval} ? $cb : sub { |
1110 | $_[0]->stop; # need to cancel manually |
1001 | $_[0]->stop; # need to cancel manually |
1111 | $cb->(); |
1002 | $cb->(); |
1112 | }) |
1003 | }) |
1113 | } |
1004 | } |
1114 | |
1005 | |
1115 | sub io { |
1006 | sub io { |
1116 | my ($class, %arg) = @_; |
1007 | my ($class, %arg) = @_; |
1117 | |
1008 | |
1118 | my $cb = $arg{cb}; |
1009 | my $cb = $arg{cb}; |
|
|
1010 | my $fd = fileno $arg{fh}; |
|
|
1011 | defined $fd or $fd = $arg{fh}; |
1119 | |
1012 | |
1120 | bless [$arg{fh}, urxvt::iow |
1013 | bless [$arg{fh}, urxvt::iow |
1121 | ->new |
1014 | ->new |
1122 | ->fd (fileno $arg{fh}) |
1015 | ->fd ($fd) |
1123 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1016 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1124 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1017 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1125 | ->start |
1018 | ->start |
1126 | ->cb (sub { |
1019 | ->cb ($cb) |
1127 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
1128 | . ($_[1] & 2 ? 'w' : '')); |
|
|
1129 | })], |
|
|
1130 | urxvt::anyevent:: |
1020 | ], urxvt::anyevent:: |
|
|
1021 | } |
|
|
1022 | |
|
|
1023 | sub idle { |
|
|
1024 | my ($class, %arg) = @_; |
|
|
1025 | |
|
|
1026 | my $cb = $arg{cb}; |
|
|
1027 | |
|
|
1028 | urxvt::iw |
|
|
1029 | ->new |
|
|
1030 | ->start |
|
|
1031 | ->cb ($cb) |
|
|
1032 | } |
|
|
1033 | |
|
|
1034 | sub child { |
|
|
1035 | my ($class, %arg) = @_; |
|
|
1036 | |
|
|
1037 | my $cb = $arg{cb}; |
|
|
1038 | |
|
|
1039 | urxvt::pw |
|
|
1040 | ->new |
|
|
1041 | ->start ($arg{pid}) |
|
|
1042 | ->cb (sub { |
|
|
1043 | $_[0]->stop; # need to cancel manually |
|
|
1044 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1045 | }) |
1131 | } |
1046 | } |
1132 | |
1047 | |
1133 | sub DESTROY { |
1048 | sub DESTROY { |
1134 | $_[0][1]->stop; |
1049 | $_[0][1]->stop; |
1135 | } |
1050 | } |
1136 | |
1051 | |
1137 | sub condvar { |
1052 | # only needed for AnyEvent < 6 compatibility |
1138 | bless \my $flag, urxvt::anyevent:: |
|
|
1139 | } |
|
|
1140 | |
|
|
1141 | sub broadcast { |
|
|
1142 | ${$_[0]}++; |
|
|
1143 | } |
|
|
1144 | |
|
|
1145 | sub wait { |
|
|
1146 | unless (${$_[0]}) { |
|
|
1147 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
|
|
1148 | } |
|
|
1149 | } |
|
|
1150 | |
|
|
1151 | sub one_event { |
1053 | sub one_event { |
1152 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1054 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1153 | } |
1055 | } |
1154 | |
1056 | |
1155 | package urxvt::term; |
1057 | package urxvt::term; |
… | |
… | |
1170 | urxvt::verbose 6, "register package $pkg to $self"; |
1072 | urxvt::verbose 6, "register package $pkg to $self"; |
1171 | |
1073 | |
1172 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
1074 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
1173 | |
1075 | |
1174 | my $proxy = bless { |
1076 | my $proxy = bless { |
1175 | _pkg => $pkg, |
1077 | _pkg => $pkg, |
|
|
1078 | _name => ${"$pkg\::_NAME"}, # hackish |
1176 | argv => $argv, |
1079 | argv => $argv, |
1177 | }, $pkg; |
1080 | }, $pkg; |
1178 | Scalar::Util::weaken ($proxy->{term} = $self); |
1081 | Scalar::Util::weaken ($proxy->{term} = $self); |
1179 | |
1082 | |
1180 | $self->{_pkg}{$pkg} = $proxy; |
1083 | $self->{_pkg}{$pkg} = $proxy; |
1181 | |
1084 | |
… | |
… | |
1184 | $proxy->enable ($name => $ref); |
1087 | $proxy->enable ($name => $ref); |
1185 | } |
1088 | } |
1186 | } |
1089 | } |
1187 | } |
1090 | } |
1188 | |
1091 | |
|
|
1092 | sub perl_libdirs { |
|
|
1093 | map { split /:/ } |
|
|
1094 | $_[0]->resource ("perl_lib"), |
|
|
1095 | $ENV{URXVT_PERL_LIB}, |
|
|
1096 | "$ENV{HOME}/.urxvt/ext", |
|
|
1097 | "$LIBDIR/perl" |
|
|
1098 | } |
|
|
1099 | |
|
|
1100 | # scan for available extensions and collect their metadata |
|
|
1101 | sub scan_extensions { |
|
|
1102 | my ($self) = @_; |
|
|
1103 | |
|
|
1104 | return if exists $self->{meta}; |
|
|
1105 | |
|
|
1106 | my @libdirs = perl_libdirs $self; |
|
|
1107 | |
|
|
1108 | # return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d# |
|
|
1109 | |
|
|
1110 | # $self->{meta_libdirs} = join "\x00", @libdirs;#d# |
|
|
1111 | $self->{meta} = \my %meta; |
|
|
1112 | |
|
|
1113 | # first gather extensions |
|
|
1114 | for my $dir (reverse @libdirs) { |
|
|
1115 | opendir my $fh, $dir |
|
|
1116 | or next; |
|
|
1117 | for my $ext (readdir $fh) { |
|
|
1118 | $ext !~ /^\./ |
|
|
1119 | and open my $fh, "<", "$dir/$ext" |
|
|
1120 | or next; |
|
|
1121 | |
|
|
1122 | my %ext = (dir => $dir); |
|
|
1123 | |
|
|
1124 | while (<$fh>) { |
|
|
1125 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
|
|
1126 | my ($pattern, $type, $desc) = split /:/, $1; |
|
|
1127 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
|
|
1128 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
|
|
1129 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
|
|
1130 | } else { |
|
|
1131 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
|
|
1132 | } |
|
|
1133 | } elsif (/^#:META:BINDING:(.*)/) { |
|
|
1134 | my ($keysym, $action) = split /:/, $1; |
|
|
1135 | $ext{binding}{$keysym} = [$ext, $action]; |
|
|
1136 | } elsif (/^\s*(?:#|$)/) { |
|
|
1137 | # skip other comments and empty lines |
|
|
1138 | } else { |
|
|
1139 | last; # stop parsing on first non-empty non-comment line |
|
|
1140 | } |
|
|
1141 | } |
|
|
1142 | |
|
|
1143 | $meta{ext}{$ext} = \%ext; |
|
|
1144 | } |
|
|
1145 | } |
|
|
1146 | |
|
|
1147 | # and now merge resources and bindings |
|
|
1148 | while (my ($k, $v) = each %{ $meta{ext} }) { |
|
|
1149 | #TODO: should check for extensions overriding each other |
|
|
1150 | %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); |
|
|
1151 | %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} }); |
|
|
1152 | } |
|
|
1153 | } |
|
|
1154 | |
1189 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1155 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1190 | |
1156 | |
1191 | Creates a new terminal, very similar as if you had started it with system |
1157 | Creates a new terminal, very similar as if you had started it with system |
1192 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
1158 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
1193 | hash which defines the environment of the new terminal. |
1159 | hash which defines the environment of the new terminal. |
… | |
… | |
1210 | } |
1176 | } |
1211 | |
1177 | |
1212 | =item $term->destroy |
1178 | =item $term->destroy |
1213 | |
1179 | |
1214 | Destroy the terminal object (close the window, free resources |
1180 | Destroy the terminal object (close the window, free resources |
1215 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1181 | etc.). Please note that urxvt will not exit as long as any event |
1216 | watchers (timers, io watchers) are still active. |
1182 | watchers (timers, io watchers) are still active. |
1217 | |
1183 | |
1218 | =item $term->exec_async ($cmd[, @args]) |
1184 | =item $term->exec_async ($cmd[, @args]) |
1219 | |
1185 | |
1220 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
1186 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
… | |
… | |
1247 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1213 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1248 | |
1214 | |
1249 | Here is a likely non-exhaustive list of option names, please see the |
1215 | Here is a likely non-exhaustive list of option names, please see the |
1250 | source file F</src/optinc.h> to see the actual list: |
1216 | source file F</src/optinc.h> to see the actual list: |
1251 | |
1217 | |
1252 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1218 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
1253 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1219 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1254 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1220 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1255 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
1221 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1256 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
1222 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1257 | transparent tripleclickwords utmpInhibit visualBell |
1223 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
|
|
1224 | urgentOnBell utmpInhibit visualBell |
1258 | |
1225 | |
1259 | =item $value = $term->resource ($name[, $newval]) |
1226 | =item $value = $term->resource ($name[, $newval]) |
1260 | |
1227 | |
1261 | Returns the current resource value associated with a given name and |
1228 | Returns the current resource value associated with a given name and |
1262 | optionally sets a new value. Setting values is most useful in the C<init> |
1229 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
1275 | |
1242 | |
1276 | Here is a likely non-exhaustive list of resource names, not all of which |
1243 | Here is a likely non-exhaustive list of resource names, not all of which |
1277 | are supported in every build, please see the source file F</src/rsinc.h> |
1244 | are supported in every build, please see the source file F</src/rsinc.h> |
1278 | to see the actual list: |
1245 | to see the actual list: |
1279 | |
1246 | |
1280 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1247 | answerbackstring backgroundPixmap backspace_key blurradius |
1281 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1248 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1282 | display_name embed ext_bwidth fade font geometry hold iconName |
1249 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1283 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1250 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
|
|
1251 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
1284 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1252 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1285 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1253 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1286 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1254 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1287 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1255 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1288 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1256 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1289 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1257 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1290 | secondaryScreen secondaryScroll shade term_name title |
1258 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1291 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1259 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1292 | visualBell |
1260 | utmpInhibit visualBell |
1293 | |
1261 | |
1294 | =cut |
1262 | =cut |
1295 | |
1263 | |
1296 | sub resource($$;$) { |
1264 | sub resource($$;$) { |
1297 | my ($self, $name) = (shift, shift); |
1265 | my ($self, $name) = (shift, shift); |
1298 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1266 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1299 | &urxvt::term::_resource |
1267 | goto &urxvt::term::_resource |
1300 | } |
1268 | } |
1301 | |
1269 | |
1302 | =item $value = $term->x_resource ($pattern) |
1270 | =item $value = $term->x_resource ($pattern) |
1303 | |
1271 | |
1304 | Returns the X-Resource for the given pattern, excluding the program or |
1272 | Returns the X-Resource for the given pattern, excluding the program or |
1305 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1273 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1306 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1274 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1307 | resource with that pattern exists. |
1275 | resource with that pattern exists. |
1308 | |
1276 | |
|
|
1277 | Extensions that define extra resource or command line arguments also need |
|
|
1278 | to call this method to access their values. |
|
|
1279 | |
|
|
1280 | If the method is called on an extension object (basically, from an |
|
|
1281 | extension), then the special prefix C<%.> will be replaced by the name of |
|
|
1282 | the extension and a dot, and the lone string C<%> will be replaced by the |
|
|
1283 | extension name itself. This makes it possible to code extensions so you |
|
|
1284 | can rename them and get a new set of commandline switches and resources |
|
|
1285 | without having to change the actual code. |
|
|
1286 | |
1309 | This method should only be called during the C<on_start> hook, as there is |
1287 | This method should only be called during the C<on_start> hook, as there is |
1310 | only one resource database per display, and later invocations might return |
1288 | only one resource database per display, and later invocations might return |
1311 | the wrong resources. |
1289 | the wrong resources. |
1312 | |
1290 | |
1313 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
1291 | =item $value = $term->x_resource_boolean ($pattern) |
1314 | |
1292 | |
|
|
1293 | Like C<x_resource>, above, but interprets the string value as a boolean |
|
|
1294 | and returns C<1> for true values, C<0> for false values and C<undef> if |
|
|
1295 | the resource or option isn't specified. |
|
|
1296 | |
|
|
1297 | You should always use this method to parse boolean resources. |
|
|
1298 | |
|
|
1299 | =cut |
|
|
1300 | |
|
|
1301 | sub x_resource_boolean { |
|
|
1302 | my $res = &x_resource; |
|
|
1303 | |
|
|
1304 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
|
|
1305 | } |
|
|
1306 | |
|
|
1307 | =item $success = $term->bind_action ($key, $octets) |
|
|
1308 | |
1315 | Adds a keymap translation exactly as specified via a resource. See the |
1309 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1316 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1310 | C<keysym> resource in the urxvt(1) manpage. |
1317 | |
1311 | |
1318 | =item $rend = $term->rstyle ([$new_rstyle]) |
1312 | =item $rend = $term->rstyle ([$new_rstyle]) |
1319 | |
1313 | |
1320 | Return and optionally change the current rendition. Text that is output by |
1314 | Return and optionally change the current rendition. Text that is output by |
1321 | the terminal application will use this style. |
1315 | the terminal application will use this style. |
… | |
… | |
1329 | |
1323 | |
1330 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1324 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1331 | |
1325 | |
1332 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1326 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1333 | |
1327 | |
1334 | Return the current values of the selection mark, begin or end positions, |
1328 | Return the current values of the selection mark, begin or end positions. |
1335 | and optionally set them to new values. |
1329 | |
|
|
1330 | When arguments are given, then the selection coordinates are set to |
|
|
1331 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1332 | screen. |
|
|
1333 | |
|
|
1334 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1335 | |
|
|
1336 | Returns the current selection screen, and then optionally sets it. |
1336 | |
1337 | |
1337 | =item $term->selection_make ($eventtime[, $rectangular]) |
1338 | =item $term->selection_make ($eventtime[, $rectangular]) |
1338 | |
1339 | |
1339 | Tries to make a selection as set by C<selection_beg> and |
1340 | Tries to make a selection as set by C<selection_beg> and |
1340 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1341 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1341 | rectangular selection will be made. This is the prefered function to make |
1342 | rectangular selection will be made. This is the preferred function to make |
1342 | a selection. |
1343 | a selection. |
1343 | |
1344 | |
1344 | =item $success = $term->selection_grab ($eventtime) |
1345 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
1345 | |
1346 | |
1346 | Try to request the primary selection text from the server (for example, as |
1347 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1348 | true) selection from the server. The corresponding text can be set |
1347 | set by the next method). No visual feedback will be given. This function |
1349 | with the next method. No visual feedback will be given. This function |
1348 | is mostly useful from within C<on_sel_grab> hooks. |
1350 | is mostly useful from within C<on_sel_grab> hooks. |
1349 | |
1351 | |
1350 | =item $oldtext = $term->selection ([$newtext]) |
1352 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
1351 | |
1353 | |
1352 | Return the current selection text and optionally replace it by C<$newtext>. |
1354 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1355 | and optionally replace it by C<$newtext>. |
|
|
1356 | |
|
|
1357 | =item $term->selection_clear ([$clipboard]) |
|
|
1358 | |
|
|
1359 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
1353 | |
1360 | |
1354 | =item $term->overlay_simple ($x, $y, $text) |
1361 | =item $term->overlay_simple ($x, $y, $text) |
1355 | |
1362 | |
1356 | Create a simple multi-line overlay box. See the next method for details. |
1363 | Create a simple multi-line overlay box. See the next method for details. |
1357 | |
1364 | |
… | |
… | |
1387 | |
1394 | |
1388 | The methods currently supported on C<urxvt::overlay> objects are: |
1395 | The methods currently supported on C<urxvt::overlay> objects are: |
1389 | |
1396 | |
1390 | =over 4 |
1397 | =over 4 |
1391 | |
1398 | |
1392 | =item $overlay->set ($x, $y, $text, $rend) |
1399 | =item $overlay->set ($x, $y, $text[, $rend]) |
1393 | |
1400 | |
1394 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1401 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1395 | text in rxvt-unicode's special encoding and an array of rendition values |
1402 | text in rxvt-unicode's special encoding and an array of rendition values |
1396 | at a specific position inside the overlay. |
1403 | at a specific position inside the overlay. |
|
|
1404 | |
|
|
1405 | If C<$rend> is missing, then the rendition will not be changed. |
1397 | |
1406 | |
1398 | =item $overlay->hide |
1407 | =item $overlay->hide |
1399 | |
1408 | |
1400 | If visible, hide the overlay, but do not destroy it. |
1409 | If visible, hide the overlay, but do not destroy it. |
1401 | |
1410 | |
… | |
… | |
1483 | locale-specific encoding of the terminal and can contain command sequences |
1492 | locale-specific encoding of the terminal and can contain command sequences |
1484 | (escape codes) that will be interpreted. |
1493 | (escape codes) that will be interpreted. |
1485 | |
1494 | |
1486 | =item $term->tt_write ($octets) |
1495 | =item $term->tt_write ($octets) |
1487 | |
1496 | |
1488 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1497 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1489 | pass characters instead of octets, you should convert your strings first |
1498 | pass characters instead of octets, you should convert your strings first |
1490 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1499 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1500 | |
|
|
1501 | =item $term->tt_write_user_input ($octets) |
|
|
1502 | |
|
|
1503 | Like C<tt_write>, but should be used when writing strings in response to |
|
|
1504 | the user pressing a key, to invokes the additional actions requested by |
|
|
1505 | the user for that case (C<tt_write> doesn't do that). |
|
|
1506 | |
|
|
1507 | The typical use case would be inside C<on_action> hooks. |
|
|
1508 | |
|
|
1509 | =item $term->tt_paste ($octets) |
|
|
1510 | |
|
|
1511 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1512 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1513 | is set. |
1491 | |
1514 | |
1492 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1515 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1493 | |
1516 | |
1494 | Replaces the event mask of the pty watcher by the given event mask. Can |
1517 | Replaces the event mask of the pty watcher by the given event mask. Can |
1495 | be used to suppress input and output handling to the pty/tty. See the |
1518 | be used to suppress input and output handling to the pty/tty. See the |
… | |
… | |
1514 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1537 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1515 | to receive pointer events all the times: |
1538 | to receive pointer events all the times: |
1516 | |
1539 | |
1517 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1540 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1518 | |
1541 | |
|
|
1542 | =item $term->set_urgency ($set) |
|
|
1543 | |
|
|
1544 | Enable/disable the urgency hint on the toplevel window. |
|
|
1545 | |
1519 | =item $term->focus_in |
1546 | =item $term->focus_in |
1520 | |
1547 | |
1521 | =item $term->focus_out |
1548 | =item $term->focus_out |
1522 | |
1549 | |
1523 | =item $term->key_press ($state, $keycode[, $time]) |
1550 | =item $term->key_press ($state, $keycode[, $time]) |
… | |
… | |
1611 | |
1638 | |
1612 | Used after changing terminal contents to display them. |
1639 | Used after changing terminal contents to display them. |
1613 | |
1640 | |
1614 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1641 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1615 | |
1642 | |
1616 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1643 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1617 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1644 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1618 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1619 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1645 | terminal line. Nothing will be returned if a nonexistent line |
1620 | is requested. |
1646 | is requested. |
1621 | |
1647 | |
1622 | If C<$new_text> is specified, it will replace characters in the current |
1648 | If C<$new_text> is specified, it will replace characters in the current |
1623 | line, starting at column C<$start_col> (default C<0>), which is useful |
1649 | line, starting at column C<$start_col> (default C<0>), which is useful |
1624 | to replace only parts of a line. The font index in the rendition will |
1650 | to replace only parts of a line. The font index in the rendition will |
… | |
… | |
1720 | } |
1746 | } |
1721 | |
1747 | |
1722 | sub urxvt::line::t { |
1748 | sub urxvt::line::t { |
1723 | my ($self) = @_; |
1749 | my ($self) = @_; |
1724 | |
1750 | |
1725 | if (@_ > 1) |
1751 | if (@_ > 1) { |
1726 | { |
|
|
1727 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1752 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1728 | for $self->{beg} .. $self->{end}; |
1753 | for $self->{beg} .. $self->{end}; |
1729 | } |
1754 | } |
1730 | |
1755 | |
1731 | defined wantarray && |
1756 | defined wantarray && |
1732 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1757 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1733 | 0, $self->{len} |
1758 | 0, $self->{len} |
1734 | } |
1759 | } |
1735 | |
1760 | |
1736 | sub urxvt::line::r { |
1761 | sub urxvt::line::r { |
1737 | my ($self) = @_; |
1762 | my ($self) = @_; |
1738 | |
1763 | |
1739 | if (@_ > 1) |
1764 | if (@_ > 1) { |
1740 | { |
|
|
1741 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1765 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1742 | for $self->{beg} .. $self->{end}; |
1766 | for $self->{beg} .. $self->{end}; |
1743 | } |
1767 | } |
1744 | |
1768 | |
1745 | if (defined wantarray) { |
1769 | if (defined wantarray) { |
1746 | my $rend = [ |
1770 | my $rend = [ |
1747 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1771 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1748 | ]; |
1772 | ]; |
… | |
… | |
1810 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1834 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1811 | recent grab. |
1835 | recent grab. |
1812 | |
1836 | |
1813 | =item $term->ungrab |
1837 | =item $term->ungrab |
1814 | |
1838 | |
1815 | Calls XUngrab for the most recent grab. Is called automatically on |
1839 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
1816 | evaluation errors, as it is better to lose the grab in the error case as |
1840 | evaluation errors, as it is better to lose the grab in the error case as |
1817 | the session. |
1841 | the session. |
1818 | |
1842 | |
1819 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1843 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1820 | |
1844 | |
… | |
… | |
1822 | |
1846 | |
1823 | =item @atoms = $term->XListProperties ($window) |
1847 | =item @atoms = $term->XListProperties ($window) |
1824 | |
1848 | |
1825 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1849 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1826 | |
1850 | |
1827 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
1851 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
1828 | |
1852 | |
1829 | =item $term->XDeleteProperty ($window, $property) |
1853 | =item $term->XDeleteProperty ($window, $property) |
1830 | |
1854 | |
1831 | =item $window = $term->DefaultRootWindow |
1855 | =item $window = $term->DefaultRootWindow |
1832 | |
1856 | |
… | |
… | |
1839 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
1863 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
1840 | |
1864 | |
1841 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1865 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1842 | |
1866 | |
1843 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1867 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1868 | |
|
|
1869 | =item $keysym = $term->XStringToKeysym ($string) |
|
|
1870 | |
|
|
1871 | =item $string = $term->XKeysymToString ($keysym) |
1844 | |
1872 | |
1845 | Various X or X-related functions. The C<$term> object only serves as |
1873 | Various X or X-related functions. The C<$term> object only serves as |
1846 | the source of the display, otherwise those functions map more-or-less |
1874 | the source of the display, otherwise those functions map more-or-less |
1847 | directory onto the X functions of the same name. |
1875 | directly onto the X functions of the same name. |
1848 | |
1876 | |
1849 | =back |
1877 | =back |
1850 | |
1878 | |
1851 | =cut |
1879 | =cut |
1852 | |
1880 | |
… | |
… | |
2009 | |
2037 | |
2010 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2038 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2011 | |
2039 | |
2012 | Set the callback to be called when the timer triggers. |
2040 | Set the callback to be called when the timer triggers. |
2013 | |
2041 | |
2014 | =item $tstamp = $timer->at |
|
|
2015 | |
|
|
2016 | Return the time this watcher will fire next. |
|
|
2017 | |
|
|
2018 | =item $timer = $timer->set ($tstamp) |
2042 | =item $timer = $timer->set ($tstamp[, $interval]) |
2019 | |
2043 | |
2020 | Set the time the event is generated to $tstamp. |
2044 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2045 | new $interval). |
2021 | |
2046 | |
2022 | =item $timer = $timer->interval ($interval) |
2047 | =item $timer = $timer->interval ($interval) |
2023 | |
2048 | |
2024 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2049 | By default (and when C<$interval> is C<0>), the timer will automatically |
2025 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2050 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2026 | is automatically rescheduled at the given intervals. |
2051 | is automatically rescheduled at the given intervals. |
2027 | |
2052 | |
2028 | =item $timer = $timer->start |
2053 | =item $timer = $timer->start |
2029 | |
2054 | |
2030 | Start the timer. |
2055 | Start the timer. |
2031 | |
2056 | |
2032 | =item $timer = $timer->start ($tstamp) |
2057 | =item $timer = $timer->start ($tstamp[, $interval]) |
2033 | |
2058 | |
2034 | Set the event trigger time to C<$tstamp> and start the timer. |
2059 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2060 | also replaces the interval. |
2035 | |
2061 | |
2036 | =item $timer = $timer->after ($delay) |
2062 | =item $timer = $timer->after ($delay[, $interval]) |
2037 | |
2063 | |
2038 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2064 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2039 | |
2065 | |
2040 | =item $timer = $timer->stop |
2066 | =item $timer = $timer->stop |
2041 | |
2067 | |
… | |
… | |
2172 | |
2198 | |
2173 | =back |
2199 | =back |
2174 | |
2200 | |
2175 | =head1 AUTHOR |
2201 | =head1 AUTHOR |
2176 | |
2202 | |
2177 | Marc Lehmann <pcg@goof.com> |
2203 | Marc Lehmann <schmorp@schmorp.de> |
2178 | http://software.schmorp.de/pkg/rxvt-unicode |
2204 | http://software.schmorp.de/pkg/rxvt-unicode |
2179 | |
2205 | |
2180 | =cut |
2206 | =cut |
2181 | |
2207 | |
2182 | 1 |
2208 | 1 |