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 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. |
|
|
315 | |
|
|
316 | =item block-graphics-to-ascii |
|
|
317 | |
|
|
318 | A not very useful example of filtering all text output to the terminal |
|
|
319 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
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. |
|
|
393 | |
|
|
394 | =item example-refresh-hooks |
|
|
395 | |
|
|
396 | Displays a very simple digital clock in the upper right corner of the |
|
|
397 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
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. |
|
|
404 | |
|
|
405 | =back |
|
|
406 | |
50 | |
407 | =head1 API DOCUMENTATION |
51 | =head1 API DOCUMENTATION |
408 | |
52 | |
409 | =head2 General API Considerations |
53 | =head2 General API Considerations |
410 | |
54 | |
… | |
… | |
437 | |
81 | |
438 | =item $octets |
82 | =item $octets |
439 | |
83 | |
440 | 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 |
441 | locale-specific way. |
85 | locale-specific way. |
|
|
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>. |
442 | |
92 | |
443 | =back |
93 | =back |
444 | |
94 | |
445 | =head2 Extension Objects |
95 | =head2 Extension Objects |
446 | |
96 | |
… | |
… | |
453 | internal use. |
103 | internal use. |
454 | |
104 | |
455 | 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 |
456 | C<urxvt::term> class on this object. |
106 | C<urxvt::term> class on this object. |
457 | |
107 | |
458 | It has the following methods and data members: |
108 | Additional methods only supported for extension objects are described in |
459 | |
109 | the C<urxvt::extension> section below. |
460 | =over 4 |
|
|
461 | |
|
|
462 | =item $urxvt_term = $self->{term} |
|
|
463 | |
|
|
464 | Returns the C<urxvt::term> object associated with this instance of the |
|
|
465 | extension. This member I<must not> be changed in any way. |
|
|
466 | |
|
|
467 | =item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
468 | |
|
|
469 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
470 | this extension, replacing any previous hook. This is useful when you want |
|
|
471 | to overwrite time-critical hooks only temporarily. |
|
|
472 | |
|
|
473 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
474 | |
|
|
475 | Dynamically disable the given hooks. |
|
|
476 | |
|
|
477 | =back |
|
|
478 | |
110 | |
479 | =head2 Hooks |
111 | =head2 Hooks |
480 | |
112 | |
481 | 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 |
482 | called whenever the relevant event happens. |
114 | called whenever the relevant event happens. |
… | |
… | |
649 | |
281 | |
650 | =item on_refresh_end $term |
282 | =item on_refresh_end $term |
651 | |
283 | |
652 | 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>. |
653 | |
285 | |
654 | =item on_user_command $term, $string |
286 | =item on_user_command $term, $string *DEPRECATED* |
655 | |
287 | |
656 | 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 |
657 | 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> |
658 | resource in the @@RXVT_NAME@@(1) manpage). |
290 | resource in the urxvt(1) manpage). |
659 | |
291 | |
660 | 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 |
661 | slightly in the future. |
293 | preference to the C<on_action> hook. |
662 | |
294 | |
663 | =item on_resize_all_windows $term, $new_width, $new_height |
295 | =item on_resize_all_windows $term, $new_width, $new_height |
664 | |
296 | |
665 | 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 |
666 | 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 |
667 | returns TRUE, setting of the window hints is being skipped. |
299 | returns a true value, setting of the window hints is being skipped. |
668 | |
300 | |
669 | =item on_x_event $term, $event |
301 | =item on_x_event $term, $event |
670 | |
302 | |
671 | 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 |
672 | 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 |
… | |
… | |
712 | (real, not screen-based) row and column under the mouse cursor. |
344 | (real, not screen-based) row and column under the mouse cursor. |
713 | |
345 | |
714 | C<on_key_press> additionally receives the string rxvt-unicode would |
346 | C<on_key_press> additionally receives the string rxvt-unicode would |
715 | output, if any, in locale-specific encoding. |
347 | output, if any, in locale-specific encoding. |
716 | |
348 | |
717 | subwindow. |
|
|
718 | |
|
|
719 | =item on_client_message $term, $event |
349 | =item on_client_message $term, $event |
720 | |
350 | |
721 | =item on_wm_protocols $term, $event |
351 | =item on_wm_protocols $term, $event |
722 | |
352 | |
723 | =item on_wm_delete_window $term, $event |
353 | =item on_wm_delete_window $term, $event |
… | |
… | |
734 | =cut |
364 | =cut |
735 | |
365 | |
736 | package urxvt; |
366 | package urxvt; |
737 | |
367 | |
738 | use utf8; |
368 | use utf8; |
739 | use strict; |
369 | use strict 'vars'; |
740 | use Carp (); |
370 | use Carp (); |
741 | use Scalar::Util (); |
371 | use Scalar::Util (); |
742 | use List::Util (); |
372 | use List::Util (); |
743 | |
373 | |
744 | our $VERSION = 1; |
374 | our $VERSION = 1; |
745 | our $TERM; |
375 | our $TERM; |
746 | our @TERM_INIT; |
376 | our @TERM_INIT; # should go, prevents async I/O etc. |
747 | our @TERM_EXT; |
377 | our @TERM_EXT; # should go, prevents async I/O etc. |
748 | our @HOOKNAME; |
378 | our @HOOKNAME; |
749 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
379 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
750 | our %OPTION; |
380 | our %OPTION; |
751 | |
381 | |
752 | our $LIBDIR; |
382 | our $LIBDIR; |
… | |
… | |
922 | }; |
552 | }; |
923 | } |
553 | } |
924 | |
554 | |
925 | no warnings 'utf8'; |
555 | no warnings 'utf8'; |
926 | |
556 | |
|
|
557 | sub parse_resource { |
|
|
558 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
|
|
559 | |
|
|
560 | $term->scan_extensions; |
|
|
561 | |
|
|
562 | my $r = $term->{meta}{resource}; |
|
|
563 | keys %$r; # reset iterator |
|
|
564 | while (my ($k, $v) = each %$r) { |
|
|
565 | my $pattern = $k; |
|
|
566 | $pattern =~ y/./-/ if $isarg; |
|
|
567 | my $prefix = $name; |
|
|
568 | my $suffix; |
|
|
569 | if ($pattern =~ /\-$/) { |
|
|
570 | $prefix = substr $name, 0, length $pattern; |
|
|
571 | $suffix = substr $name, length $pattern; |
|
|
572 | } |
|
|
573 | if ($pattern eq $prefix) { |
|
|
574 | $name = "$urxvt::RESCLASS.$k$suffix"; |
|
|
575 | |
|
|
576 | push @{ $term->{perl_ext_3} }, $v->[0]; |
|
|
577 | |
|
|
578 | if ($v->[1] eq "boolean") { |
|
|
579 | $term->put_option_db ($name, $flag ? "true" : "false"); |
|
|
580 | return 1; |
|
|
581 | } else { |
|
|
582 | $term->put_option_db ($name, $value); |
|
|
583 | return 1 + 2; |
|
|
584 | } |
|
|
585 | } |
|
|
586 | } |
|
|
587 | |
|
|
588 | 0 |
|
|
589 | } |
|
|
590 | |
|
|
591 | sub usage { |
|
|
592 | my ($term, $usage_type) = @_; |
|
|
593 | |
|
|
594 | $term->scan_extensions; |
|
|
595 | |
|
|
596 | my $r = $term->{meta}{resource}; |
|
|
597 | |
|
|
598 | for my $pattern (sort keys %$r) { |
|
|
599 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
|
|
600 | |
|
|
601 | $desc .= " (-pe $ext)"; |
|
|
602 | |
|
|
603 | if ($usage_type == 1) { |
|
|
604 | $pattern =~ y/./-/; |
|
|
605 | $pattern =~ s/-$/-.../g; |
|
|
606 | |
|
|
607 | if ($type eq "boolean") { |
|
|
608 | urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc; |
|
|
609 | } else { |
|
|
610 | urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc; |
|
|
611 | } |
|
|
612 | } else { |
|
|
613 | $pattern =~ s/\.$/.*/g; |
|
|
614 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
|
|
615 | } |
|
|
616 | } |
|
|
617 | } |
|
|
618 | |
927 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
619 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
928 | |
620 | |
929 | sub verbose { |
621 | sub verbose { |
930 | my ($level, $msg) = @_; |
622 | my ($level, $msg) = @_; |
931 | warn "$msg\n" if $level <= $verbosity; |
623 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
943 | $pkg =~ s/[^[:word:]]/_/g; |
635 | $pkg =~ s/[^[:word:]]/_/g; |
944 | $pkg = "urxvt::ext::$pkg"; |
636 | $pkg = "urxvt::ext::$pkg"; |
945 | |
637 | |
946 | verbose 3, "loading extension '$path' into package '$pkg'"; |
638 | verbose 3, "loading extension '$path' into package '$pkg'"; |
947 | |
639 | |
|
|
640 | (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish |
|
|
641 | |
948 | open my $fh, "<:raw", $path |
642 | open my $fh, "<:raw", $path |
949 | or die "$path: $!"; |
643 | or die "$path: $!"; |
950 | |
644 | |
951 | my $source = |
645 | my $source = |
952 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
646 | "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n" |
953 | . "#line 1 \"$path\"\n{\n" |
647 | . "#line 1 \"$path\"\n{\n" |
954 | . (do { local $/; <$fh> }) |
648 | . (do { local $/; <$fh> }) |
955 | . "\n};\n1"; |
649 | . "\n};\n1"; |
956 | |
650 | |
957 | eval $source |
651 | eval $source |
… | |
… | |
966 | # called by the rxvt core |
660 | # called by the rxvt core |
967 | sub invoke { |
661 | sub invoke { |
968 | local $TERM = shift; |
662 | local $TERM = shift; |
969 | my $htype = shift; |
663 | my $htype = shift; |
970 | |
664 | |
971 | if ($htype == 0) { # INIT |
665 | if ($htype == HOOK_INIT) { |
972 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
666 | my @dirs = $TERM->perl_libdirs; |
|
|
667 | |
|
|
668 | $TERM->scan_extensions; |
973 | |
669 | |
974 | my %ext_arg; |
670 | my %ext_arg; |
975 | |
671 | |
976 | { |
672 | { |
977 | my @init = @TERM_INIT; |
673 | my @init = @TERM_INIT; |
… | |
… | |
980 | my @pkg = @TERM_EXT; |
676 | my @pkg = @TERM_EXT; |
981 | @TERM_EXT = (); |
677 | @TERM_EXT = (); |
982 | $TERM->register_package ($_) for @pkg; |
678 | $TERM->register_package ($_) for @pkg; |
983 | } |
679 | } |
984 | |
680 | |
|
|
681 | for ( |
985 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
682 | grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 |
|
|
683 | ) { |
986 | if ($_ eq "default") { |
684 | if ($_ eq "default") { |
987 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
685 | |
|
|
686 | $ext_arg{$_} = [] |
|
|
687 | for |
|
|
688 | qw(selection option-popup selection-popup readline), |
|
|
689 | @{ delete $TERM->{perl_ext_3} }, |
|
|
690 | map $_->[0], values %{ $TERM->{meta}{binding} }; |
|
|
691 | |
|
|
692 | for ($TERM->_keysym_resources) { |
|
|
693 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
|
|
694 | next unless /^([A-Za-z0-9_\-]+):/; |
|
|
695 | |
|
|
696 | my $ext = $1; |
|
|
697 | |
|
|
698 | $ext_arg{$ext} = []; |
|
|
699 | } |
|
|
700 | |
988 | } elsif (/^-(.*)$/) { |
701 | } elsif (/^-(.*)$/) { |
989 | delete $ext_arg{$1}; |
702 | delete $ext_arg{$1}; |
|
|
703 | |
990 | } elsif (/^([^<]+)<(.*)>$/) { |
704 | } elsif (/^([^<]+)<(.*)>$/) { |
991 | push @{ $ext_arg{$1} }, $2; |
705 | push @{ $ext_arg{$1} }, $2; |
|
|
706 | |
992 | } else { |
707 | } else { |
993 | $ext_arg{$_} ||= []; |
708 | $ext_arg{$_} ||= []; |
|
|
709 | } |
|
|
710 | } |
|
|
711 | |
|
|
712 | # now register default key bindings |
|
|
713 | for my $ext (sort keys %ext_arg) { |
|
|
714 | while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) { |
|
|
715 | $TERM->bind_action ($k, "$v->[0]:$v->[1]"); |
994 | } |
716 | } |
995 | } |
717 | } |
996 | |
718 | |
997 | for my $ext (sort keys %ext_arg) { |
719 | for my $ext (sort keys %ext_arg) { |
998 | my @files = grep -f $_, map "$_/$ext", @dirs; |
720 | my @files = grep -f $_, map "$_/$ext", @dirs; |
… | |
… | |
1012 | |
734 | |
1013 | if (my $cb = $TERM->{_hook}[$htype]) { |
735 | if (my $cb = $TERM->{_hook}[$htype]) { |
1014 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
736 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
1015 | if $verbosity >= 10; |
737 | if $verbosity >= 10; |
1016 | |
738 | |
|
|
739 | if ($htype == HOOK_ACTION) { |
|
|
740 | # this hook is only sent to the extension with the name |
|
|
741 | # matching the first arg |
|
|
742 | my $pkg = shift; |
|
|
743 | $pkg =~ y/-/_/; |
|
|
744 | $pkg = "urxvt::ext::$pkg"; |
|
|
745 | |
|
|
746 | $cb = $cb->{$pkg} |
|
|
747 | or return undef; #TODO: maybe warn user? |
|
|
748 | |
|
|
749 | $cb = { $pkg => $cb }; |
|
|
750 | } |
|
|
751 | |
1017 | for my $pkg (keys %$cb) { |
752 | for my $pkg (keys %$cb) { |
1018 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
753 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
1019 | $retval ||= $retval_; |
754 | $retval ||= $retval_; |
1020 | |
755 | |
1021 | if ($@) { |
756 | if ($@) { |
1022 | $TERM->ungrab; # better to lose the grab than the session |
757 | $TERM->ungrab; # better to lose the grab than the session |
1023 | warn $@; |
758 | warn $@; |
… | |
… | |
1026 | |
761 | |
1027 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
762 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
1028 | if $verbosity >= 11; |
763 | if $verbosity >= 11; |
1029 | } |
764 | } |
1030 | |
765 | |
1031 | if ($htype == 1) { # DESTROY |
766 | if ($htype == HOOK_DESTROY) { |
1032 | # clear package objects |
767 | # clear package objects |
1033 | %$_ = () for values %{ $TERM->{_pkg} }; |
768 | %$_ = () for values %{ $TERM->{_pkg} }; |
1034 | |
769 | |
1035 | # clear package |
770 | # clear package |
1036 | %$TERM = (); |
771 | %$TERM = (); |
… | |
… | |
1066 | } |
801 | } |
1067 | } |
802 | } |
1068 | ($mask, @color{qw(fg bg)}, \@failed) |
803 | ($mask, @color{qw(fg bg)}, \@failed) |
1069 | } |
804 | } |
1070 | |
805 | |
1071 | # urxvt::term::extension |
|
|
1072 | |
|
|
1073 | package urxvt::term::extension; |
806 | package urxvt::term::extension; |
1074 | |
807 | |
1075 | sub enable { |
808 | =head2 The C<urxvt::term::extension> class |
1076 | my ($self, %hook) = @_; |
|
|
1077 | my $pkg = $self->{_pkg}; |
|
|
1078 | |
809 | |
1079 | while (my ($name, $cb) = each %hook) { |
810 | Each extension attached to a terminal object is represented by |
1080 | my $htype = $HOOKTYPE{uc $name}; |
811 | a C<urxvt::term::extension> object. |
1081 | defined $htype |
|
|
1082 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1083 | |
812 | |
1084 | $self->set_should_invoke ($htype, +1) |
813 | You can use these objects, which are passed to all callbacks to store any |
1085 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
814 | state related to the terminal and extension instance. |
1086 | |
815 | |
1087 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
816 | The methods (And data members) documented below can be called on extension |
1088 | } |
817 | objects, in addition to call methods documented for the <urxvt::term> |
1089 | } |
818 | class. |
1090 | |
819 | |
1091 | sub disable { |
820 | =over 4 |
1092 | my ($self, @hook) = @_; |
|
|
1093 | my $pkg = $self->{_pkg}; |
|
|
1094 | |
821 | |
1095 | for my $name (@hook) { |
822 | =item $urxvt_term = $self->{term} |
1096 | my $htype = $HOOKTYPE{uc $name}; |
|
|
1097 | defined $htype |
|
|
1098 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1099 | |
823 | |
1100 | $self->set_should_invoke ($htype, -1) |
824 | Returns the C<urxvt::term> object associated with this instance of the |
1101 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
825 | extension. This member I<must not> be changed in any way. |
1102 | } |
826 | |
1103 | } |
827 | =cut |
1104 | |
828 | |
1105 | our $AUTOLOAD; |
829 | our $AUTOLOAD; |
1106 | |
830 | |
1107 | sub AUTOLOAD { |
831 | sub AUTOLOAD { |
1108 | $AUTOLOAD =~ /:([^:]+)$/ |
832 | $AUTOLOAD =~ /:([^:]+)$/ |
… | |
… | |
1121 | |
845 | |
1122 | sub DESTROY { |
846 | sub DESTROY { |
1123 | # nop |
847 | # nop |
1124 | } |
848 | } |
1125 | |
849 | |
1126 | # urxvt::destroy_hook |
850 | # urxvt::destroy_hook (basically a cheap Guard:: implementation) |
1127 | |
851 | |
1128 | sub urxvt::destroy_hook::DESTROY { |
852 | sub urxvt::destroy_hook::DESTROY { |
1129 | ${$_[0]}->(); |
853 | ${$_[0]}->(); |
1130 | } |
854 | } |
1131 | |
855 | |
1132 | sub urxvt::destroy_hook(&) { |
856 | sub urxvt::destroy_hook(&) { |
1133 | bless \shift, urxvt::destroy_hook:: |
857 | bless \shift, urxvt::destroy_hook:: |
1134 | } |
858 | } |
|
|
859 | |
|
|
860 | =item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
861 | |
|
|
862 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
863 | this extension, replacing any hook previously installed via C<enable> in |
|
|
864 | this extension. |
|
|
865 | |
|
|
866 | This is useful when you want to overwrite time-critical hooks only |
|
|
867 | temporarily. |
|
|
868 | |
|
|
869 | To install additional callbacks for the same hook, you can use the C<on> |
|
|
870 | method of the C<urxvt::term> class. |
|
|
871 | |
|
|
872 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
873 | |
|
|
874 | Dynamically disable the given hooks. |
|
|
875 | |
|
|
876 | =cut |
|
|
877 | |
|
|
878 | sub enable { |
|
|
879 | my ($self, %hook) = @_; |
|
|
880 | my $pkg = $self->{_pkg}; |
|
|
881 | |
|
|
882 | while (my ($name, $cb) = each %hook) { |
|
|
883 | my $htype = $HOOKTYPE{uc $name}; |
|
|
884 | defined $htype |
|
|
885 | or Carp::croak "unsupported hook type '$name'"; |
|
|
886 | |
|
|
887 | $self->set_should_invoke ($htype, +1) |
|
|
888 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
|
|
889 | |
|
|
890 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
891 | } |
|
|
892 | } |
|
|
893 | |
|
|
894 | sub disable { |
|
|
895 | my ($self, @hook) = @_; |
|
|
896 | my $pkg = $self->{_pkg}; |
|
|
897 | |
|
|
898 | for my $name (@hook) { |
|
|
899 | my $htype = $HOOKTYPE{uc $name}; |
|
|
900 | defined $htype |
|
|
901 | or Carp::croak "unsupported hook type '$name'"; |
|
|
902 | |
|
|
903 | $self->set_should_invoke ($htype, -1) |
|
|
904 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
|
|
905 | } |
|
|
906 | } |
|
|
907 | |
|
|
908 | =item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
909 | |
|
|
910 | Similar to the C<enable> enable, but installs additional callbacks for |
|
|
911 | the given hook(s) (that is, it doesn't replace existing callbacks), and |
|
|
912 | returns a guard object. When the guard object is destroyed the callbacks |
|
|
913 | are disabled again. |
|
|
914 | |
|
|
915 | =cut |
|
|
916 | |
|
|
917 | sub urxvt::extension::on_disable::DESTROY { |
|
|
918 | my $disable = shift; |
|
|
919 | |
|
|
920 | my $term = delete $disable->{""}; |
|
|
921 | |
|
|
922 | while (my ($htype, $id) = each %$disable) { |
|
|
923 | delete $term->{_hook}[$htype]{$id}; |
|
|
924 | $term->set_should_invoke ($htype, -1); |
|
|
925 | } |
|
|
926 | } |
|
|
927 | |
|
|
928 | sub on { |
|
|
929 | my ($self, %hook) = @_; |
|
|
930 | |
|
|
931 | my $term = $self->{term}; |
|
|
932 | |
|
|
933 | my %disable = ( "" => $term ); |
|
|
934 | |
|
|
935 | while (my ($name, $cb) = each %hook) { |
|
|
936 | my $htype = $HOOKTYPE{uc $name}; |
|
|
937 | defined $htype |
|
|
938 | or Carp::croak "unsupported hook type '$name'"; |
|
|
939 | |
|
|
940 | $term->set_should_invoke ($htype, +1); |
|
|
941 | $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 } |
|
|
942 | = sub { shift; $cb->($self, @_) }; # very ugly indeed |
|
|
943 | } |
|
|
944 | |
|
|
945 | bless \%disable, "urxvt::extension::on_disable" |
|
|
946 | } |
|
|
947 | |
|
|
948 | =item $self->x_resource ($pattern) |
|
|
949 | |
|
|
950 | =item $self->x_resource_boolean ($pattern) |
|
|
951 | |
|
|
952 | These methods support an additional C<%> prefix when called on an |
|
|
953 | extension object - see the description of these methods in the |
|
|
954 | C<urxvt::term> class for details. |
|
|
955 | |
|
|
956 | =cut |
|
|
957 | |
|
|
958 | sub x_resource { |
|
|
959 | my ($self, $name) = @_; |
|
|
960 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
961 | $self->{term}->x_resource ($name) |
|
|
962 | } |
|
|
963 | |
|
|
964 | sub x_resource_boolean { |
|
|
965 | my ($self, $name) = @_; |
|
|
966 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
967 | $self->{term}->x_resource_boolean ($name) |
|
|
968 | } |
|
|
969 | |
|
|
970 | =back |
|
|
971 | |
|
|
972 | =cut |
1135 | |
973 | |
1136 | package urxvt::anyevent; |
974 | package urxvt::anyevent; |
1137 | |
975 | |
1138 | =head2 The C<urxvt::anyevent> Class |
976 | =head2 The C<urxvt::anyevent> Class |
1139 | |
977 | |
1140 | The sole purpose of this class is to deliver an interface to the |
978 | The sole purpose of this class is to deliver an interface to the |
1141 | C<AnyEvent> module - any module using it will work inside urxvt without |
979 | C<AnyEvent> module - any module using it will work inside urxvt without |
1142 | further programming. The only exception is that you cannot wait on |
980 | further programming. The only exception is that you cannot wait on |
1143 | condition variables, but non-blocking condvar use is ok. What this means |
981 | condition variables, but non-blocking condvar use is ok. |
1144 | is that you cannot use blocking APIs, but the non-blocking variant should |
982 | |
1145 | work. |
983 | In practical terms this means is that you cannot use blocking APIs, but |
|
|
984 | the non-blocking variant should work. |
1146 | |
985 | |
1147 | =cut |
986 | =cut |
1148 | |
987 | |
1149 | our $VERSION = '5.23'; |
988 | our $VERSION = '5.23'; |
1150 | |
989 | |
… | |
… | |
1209 | |
1048 | |
1210 | sub DESTROY { |
1049 | sub DESTROY { |
1211 | $_[0][1]->stop; |
1050 | $_[0][1]->stop; |
1212 | } |
1051 | } |
1213 | |
1052 | |
|
|
1053 | # only needed for AnyEvent < 6 compatibility |
1214 | sub one_event { |
1054 | sub one_event { |
1215 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1055 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1216 | } |
1056 | } |
1217 | |
1057 | |
1218 | package urxvt::term; |
1058 | package urxvt::term; |
… | |
… | |
1233 | urxvt::verbose 6, "register package $pkg to $self"; |
1073 | urxvt::verbose 6, "register package $pkg to $self"; |
1234 | |
1074 | |
1235 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
1075 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
1236 | |
1076 | |
1237 | my $proxy = bless { |
1077 | my $proxy = bless { |
1238 | _pkg => $pkg, |
1078 | _pkg => $pkg, |
|
|
1079 | _name => ${"$pkg\::_NAME"}, # hackish |
1239 | argv => $argv, |
1080 | argv => $argv, |
1240 | }, $pkg; |
1081 | }, $pkg; |
1241 | Scalar::Util::weaken ($proxy->{term} = $self); |
1082 | Scalar::Util::weaken ($proxy->{term} = $self); |
1242 | |
1083 | |
1243 | $self->{_pkg}{$pkg} = $proxy; |
1084 | $self->{_pkg}{$pkg} = $proxy; |
1244 | |
1085 | |
… | |
… | |
1247 | $proxy->enable ($name => $ref); |
1088 | $proxy->enable ($name => $ref); |
1248 | } |
1089 | } |
1249 | } |
1090 | } |
1250 | } |
1091 | } |
1251 | |
1092 | |
|
|
1093 | sub perl_libdirs { |
|
|
1094 | map { split /:/ } |
|
|
1095 | $_[0]->resource ("perl_lib"), |
|
|
1096 | $ENV{URXVT_PERL_LIB}, |
|
|
1097 | "$ENV{HOME}/.urxvt/ext", |
|
|
1098 | "$LIBDIR/perl" |
|
|
1099 | } |
|
|
1100 | |
|
|
1101 | # scan for available extensions and collect their metadata |
|
|
1102 | sub scan_extensions { |
|
|
1103 | my ($self) = @_; |
|
|
1104 | |
|
|
1105 | return if exists $self->{meta}; |
|
|
1106 | |
|
|
1107 | my @libdirs = perl_libdirs $self; |
|
|
1108 | |
|
|
1109 | # return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d# |
|
|
1110 | |
|
|
1111 | # $self->{meta_libdirs} = join "\x00", @libdirs;#d# |
|
|
1112 | $self->{meta} = \my %meta; |
|
|
1113 | |
|
|
1114 | # first gather extensions |
|
|
1115 | for my $dir (reverse @libdirs) { |
|
|
1116 | opendir my $fh, $dir |
|
|
1117 | or next; |
|
|
1118 | for my $ext (readdir $fh) { |
|
|
1119 | $ext !~ /^\./ |
|
|
1120 | and open my $fh, "<", "$dir/$ext" |
|
|
1121 | or next; |
|
|
1122 | |
|
|
1123 | my %ext = (dir => $dir); |
|
|
1124 | |
|
|
1125 | while (<$fh>) { |
|
|
1126 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
|
|
1127 | my ($pattern, $type, $desc) = split /:/, $1; |
|
|
1128 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
|
|
1129 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
|
|
1130 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
|
|
1131 | } else { |
|
|
1132 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
|
|
1133 | } |
|
|
1134 | } elsif (/^#:META:BINDING:(.*)/) { |
|
|
1135 | my ($keysym, $action) = split /:/, $1; |
|
|
1136 | $ext{binding}{$keysym} = [$ext, $action]; |
|
|
1137 | } elsif (/^\s*(?:#|$)/) { |
|
|
1138 | # skip other comments and empty lines |
|
|
1139 | } else { |
|
|
1140 | last; # stop parsing on first non-empty non-comment line |
|
|
1141 | } |
|
|
1142 | } |
|
|
1143 | |
|
|
1144 | $meta{ext}{$ext} = \%ext; |
|
|
1145 | } |
|
|
1146 | } |
|
|
1147 | |
|
|
1148 | # and now merge resources and bindings |
|
|
1149 | while (my ($k, $v) = each %{ $meta{ext} }) { |
|
|
1150 | #TODO: should check for extensions overriding each other |
|
|
1151 | %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); |
|
|
1152 | %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} }); |
|
|
1153 | } |
|
|
1154 | } |
|
|
1155 | |
1252 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1156 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1253 | |
1157 | |
1254 | Creates a new terminal, very similar as if you had started it with system |
1158 | Creates a new terminal, very similar as if you had started it with system |
1255 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
1159 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
1256 | hash which defines the environment of the new terminal. |
1160 | hash which defines the environment of the new terminal. |
… | |
… | |
1273 | } |
1177 | } |
1274 | |
1178 | |
1275 | =item $term->destroy |
1179 | =item $term->destroy |
1276 | |
1180 | |
1277 | Destroy the terminal object (close the window, free resources |
1181 | Destroy the terminal object (close the window, free resources |
1278 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1182 | etc.). Please note that urxvt will not exit as long as any event |
1279 | watchers (timers, io watchers) are still active. |
1183 | watchers (timers, io watchers) are still active. |
1280 | |
1184 | |
1281 | =item $term->exec_async ($cmd[, @args]) |
1185 | =item $term->exec_async ($cmd[, @args]) |
1282 | |
1186 | |
1283 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
1187 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
… | |
… | |
1339 | |
1243 | |
1340 | Here is a likely non-exhaustive list of resource names, not all of which |
1244 | Here is a likely non-exhaustive list of resource names, not all of which |
1341 | are supported in every build, please see the source file F</src/rsinc.h> |
1245 | are supported in every build, please see the source file F</src/rsinc.h> |
1342 | to see the actual list: |
1246 | to see the actual list: |
1343 | |
1247 | |
1344 | answerbackstring backgroundPixmap backspace_key blendtype blurradius |
1248 | answerbackstring backgroundPixmap backspace_key blurradius |
1345 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1249 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1346 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1250 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1347 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
1251 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
1348 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
1252 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
1349 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1253 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
… | |
… | |
1369 | Returns the X-Resource for the given pattern, excluding the program or |
1273 | Returns the X-Resource for the given pattern, excluding the program or |
1370 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1274 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1371 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1275 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1372 | resource with that pattern exists. |
1276 | resource with that pattern exists. |
1373 | |
1277 | |
|
|
1278 | Extensions that define extra resource or command line arguments also need |
|
|
1279 | to call this method to access their values. |
|
|
1280 | |
|
|
1281 | If the method is called on an extension object (basically, from an |
|
|
1282 | extension), then the special prefix C<%.> will be replaced by the name of |
|
|
1283 | the extension and a dot, and the lone string C<%> will be replaced by the |
|
|
1284 | extension name itself. This makes it possible to code extensions so you |
|
|
1285 | can rename them and get a new set of commandline switches and resources |
|
|
1286 | without having to change the actual code. |
|
|
1287 | |
1374 | This method should only be called during the C<on_start> hook, as there is |
1288 | This method should only be called during the C<on_start> hook, as there is |
1375 | only one resource database per display, and later invocations might return |
1289 | only one resource database per display, and later invocations might return |
1376 | the wrong resources. |
1290 | the wrong resources. |
1377 | |
1291 | |
1378 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
1292 | =item $value = $term->x_resource_boolean ($pattern) |
1379 | |
1293 | |
|
|
1294 | Like C<x_resource>, above, but interprets the string value as a boolean |
|
|
1295 | and returns C<1> for true values, C<0> for false values and C<undef> if |
|
|
1296 | the resource or option isn't specified. |
|
|
1297 | |
|
|
1298 | You should always use this method to parse boolean resources. |
|
|
1299 | |
|
|
1300 | =cut |
|
|
1301 | |
|
|
1302 | sub x_resource_boolean { |
|
|
1303 | my $res = &x_resource; |
|
|
1304 | |
|
|
1305 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
|
|
1306 | } |
|
|
1307 | |
|
|
1308 | =item $success = $term->bind_action ($key, $octets) |
|
|
1309 | |
1380 | Adds a keymap translation exactly as specified via a resource. See the |
1310 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1381 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1311 | C<keysym> resource in the urxvt(1) manpage. |
1382 | |
1312 | |
1383 | =item $rend = $term->rstyle ([$new_rstyle]) |
1313 | =item $rend = $term->rstyle ([$new_rstyle]) |
1384 | |
1314 | |
1385 | Return and optionally change the current rendition. Text that is output by |
1315 | Return and optionally change the current rendition. Text that is output by |
1386 | the terminal application will use this style. |
1316 | the terminal application will use this style. |
… | |
… | |
1567 | |
1497 | |
1568 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1498 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1569 | pass characters instead of octets, you should convert your strings first |
1499 | pass characters instead of octets, you should convert your strings first |
1570 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1500 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1571 | |
1501 | |
|
|
1502 | =item $term->tt_write_user_input ($octets) |
|
|
1503 | |
|
|
1504 | Like C<tt_write>, but should be used when writing strings in response to |
|
|
1505 | the user pressing a key, to invoke the additional actions requested by |
|
|
1506 | the user for that case (C<tt_write> doesn't do that). |
|
|
1507 | |
|
|
1508 | The typical use case would be inside C<on_action> hooks. |
|
|
1509 | |
1572 | =item $term->tt_paste ($octets) |
1510 | =item $term->tt_paste ($octets) |
1573 | |
1511 | |
1574 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
1512 | 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 |
1513 | CR and bracketing the data with control sequences if bracketed paste mode |
1576 | is set. |
1514 | is set. |
… | |
… | |
1599 | |
1537 | |
1600 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1538 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1601 | to receive pointer events all the times: |
1539 | to receive pointer events all the times: |
1602 | |
1540 | |
1603 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1541 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1542 | |
|
|
1543 | =item $term->set_urgency ($set) |
|
|
1544 | |
|
|
1545 | Enable/disable the urgency hint on the toplevel window. |
1604 | |
1546 | |
1605 | =item $term->focus_in |
1547 | =item $term->focus_in |
1606 | |
1548 | |
1607 | =item $term->focus_out |
1549 | =item $term->focus_out |
1608 | |
1550 | |
… | |
… | |
1805 | } |
1747 | } |
1806 | |
1748 | |
1807 | sub urxvt::line::t { |
1749 | sub urxvt::line::t { |
1808 | my ($self) = @_; |
1750 | my ($self) = @_; |
1809 | |
1751 | |
1810 | if (@_ > 1) |
1752 | if (@_ > 1) { |
1811 | { |
|
|
1812 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1753 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1813 | for $self->{beg} .. $self->{end}; |
1754 | for $self->{beg} .. $self->{end}; |
1814 | } |
1755 | } |
1815 | |
1756 | |
1816 | defined wantarray && |
1757 | defined wantarray && |
1817 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1758 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1818 | 0, $self->{len} |
1759 | 0, $self->{len} |
1819 | } |
1760 | } |
1820 | |
1761 | |
1821 | sub urxvt::line::r { |
1762 | sub urxvt::line::r { |
1822 | my ($self) = @_; |
1763 | my ($self) = @_; |
1823 | |
1764 | |
1824 | if (@_ > 1) |
1765 | if (@_ > 1) { |
1825 | { |
|
|
1826 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1766 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1827 | for $self->{beg} .. $self->{end}; |
1767 | for $self->{beg} .. $self->{end}; |
1828 | } |
1768 | } |
1829 | |
1769 | |
1830 | if (defined wantarray) { |
1770 | if (defined wantarray) { |
1831 | my $rend = [ |
1771 | my $rend = [ |
1832 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1772 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1833 | ]; |
1773 | ]; |
… | |
… | |
1924 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
1864 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
1925 | |
1865 | |
1926 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1866 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1927 | |
1867 | |
1928 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1868 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1869 | |
|
|
1870 | =item $keysym = $term->XStringToKeysym ($string) |
|
|
1871 | |
|
|
1872 | =item $string = $term->XKeysymToString ($keysym) |
1929 | |
1873 | |
1930 | Various X or X-related functions. The C<$term> object only serves as |
1874 | 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 |
1875 | the source of the display, otherwise those functions map more-or-less |
1932 | directly onto the X functions of the same name. |
1876 | directly onto the X functions of the same name. |
1933 | |
1877 | |