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 may add additional resources and C<actions>, i.e., methods |
48 | |
49 | which can be bound to a key and invoked by the user. An extension can |
49 | =item selection (enabled by default) |
50 | define the resources it support and also default bindings for one or |
50 | |
51 | more actions it provides using so called META comments, described |
51 | (More) intelligent selection. This extension tries to be more intelligent |
52 | below. Similarly to builtin resources, extension resources can also be |
52 | when the user extends selections (double-click and further clicks). Right |
53 | specified on the command line as long options (with C<.> replaced by |
53 | now, it tries to select words, urls and complete shell-quoted |
54 | C<->), in which case the corresponding extension is loaded |
54 | arguments, which is very convenient, too, if your F<ls> supports |
55 | automatically. For this to work the extension B<must> define META |
55 | C<--quoting-style=shell>. |
56 | comments for its resources. |
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 | =item bell-command |
|
|
406 | |
|
|
407 | Runs the command specified by the C<URxvt.bell-command> resource when |
|
|
408 | a bell event occurs. For example, the following pops up a notification |
|
|
409 | bubble with the text "Beep, Beep" using notify-send: |
|
|
410 | |
|
|
411 | URxvt.bell-command: notify-send "Beep, Beep" |
|
|
412 | |
|
|
413 | =back |
|
|
414 | |
57 | |
415 | =head1 API DOCUMENTATION |
58 | =head1 API DOCUMENTATION |
416 | |
59 | |
417 | =head2 General API Considerations |
60 | =head2 General API Considerations |
418 | |
61 | |
… | |
… | |
467 | internal use. |
110 | internal use. |
468 | |
111 | |
469 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
112 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
470 | C<urxvt::term> class on this object. |
113 | C<urxvt::term> class on this object. |
471 | |
114 | |
472 | It has the following methods and data members: |
115 | Additional methods only supported for extension objects are described in |
|
|
116 | the C<urxvt::extension> section below. |
|
|
117 | |
|
|
118 | =head2 META comments |
|
|
119 | |
|
|
120 | Rxvt-unicode recognizes special meta comments in extensions that define |
|
|
121 | different types of metadata. |
|
|
122 | |
|
|
123 | Currently, it recxognises only one such comment: |
473 | |
124 | |
474 | =over 4 |
125 | =over 4 |
475 | |
126 | |
476 | =item $urxvt_term = $self->{term} |
127 | =item #:META:RESOURCE:name:type:desc |
477 | |
128 | |
478 | Returns the C<urxvt::term> object associated with this instance of the |
129 | The RESOURCE comment defines a resource used by the extension, where |
479 | extension. This member I<must not> be changed in any way. |
130 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
480 | |
131 | or C<string>, and C<desc> is the resource description. |
481 | =item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
482 | |
|
|
483 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
484 | this extension, replacing any previous hook. This is useful when you want |
|
|
485 | to overwrite time-critical hooks only temporarily. |
|
|
486 | |
|
|
487 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
488 | |
|
|
489 | Dynamically disable the given hooks. |
|
|
490 | |
132 | |
491 | =back |
133 | =back |
492 | |
134 | |
493 | =head2 Hooks |
135 | =head2 Hooks |
494 | |
136 | |
… | |
… | |
663 | |
305 | |
664 | =item on_refresh_end $term |
306 | =item on_refresh_end $term |
665 | |
307 | |
666 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
308 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
667 | |
309 | |
|
|
310 | =item on_action $term, $string |
|
|
311 | |
|
|
312 | Called whenever an action is invoked for the corresponding extension |
|
|
313 | (e.g. via a C<extension:string> builtin action bound to a key, see |
|
|
314 | description of the B<keysym> resource in the urxvt(1) manpage). The |
|
|
315 | event is simply the action string. Note that an action event is always |
|
|
316 | associated to a single extension. |
|
|
317 | |
668 | =item on_user_command $term, $string |
318 | =item on_user_command $term, $string *DEPRECATED* |
669 | |
319 | |
670 | Called whenever a user-configured event is being activated (e.g. via |
320 | Called whenever a user-configured event is being activated (e.g. via |
671 | a C<perl:string> action bound to a key, see description of the B<keysym> |
321 | a C<perl:string> action bound to a key, see description of the B<keysym> |
672 | resource in the @@RXVT_NAME@@(1) manpage). |
322 | resource in the urxvt(1) manpage). |
673 | |
323 | |
674 | The event is simply the action string. This interface is assumed to change |
324 | The event is simply the action string. This interface is going away in |
675 | slightly in the future. |
325 | preference to the C<on_action> hook. |
676 | |
|
|
677 | =item on_register_command $term, $keysym, $modifiermask, $string |
|
|
678 | |
|
|
679 | Called after parsing a keysym resource but before registering the |
|
|
680 | associated binding. If this hook returns TRUE the binding is not |
|
|
681 | registered. It can be used to modify a binding by calling |
|
|
682 | C<register_command>. |
|
|
683 | |
326 | |
684 | =item on_resize_all_windows $term, $new_width, $new_height |
327 | =item on_resize_all_windows $term, $new_width, $new_height |
685 | |
328 | |
686 | Called just after the new window size has been calculated, but before |
329 | Called just after the new window size has been calculated, but before |
687 | windows are actually being resized or hints are being set. If this hook |
330 | windows are actually being resized or hints are being set. If this hook |
688 | returns TRUE, setting of the window hints is being skipped. |
331 | returns a true value, setting of the window hints is being skipped. |
689 | |
332 | |
690 | =item on_x_event $term, $event |
333 | =item on_x_event $term, $event |
691 | |
334 | |
692 | Called on every X event received on the vt window (and possibly other |
335 | Called on every X event received on the vt window (and possibly other |
693 | windows). Should only be used as a last resort. Most event structure |
336 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
733 | (real, not screen-based) row and column under the mouse cursor. |
376 | (real, not screen-based) row and column under the mouse cursor. |
734 | |
377 | |
735 | C<on_key_press> additionally receives the string rxvt-unicode would |
378 | C<on_key_press> additionally receives the string rxvt-unicode would |
736 | output, if any, in locale-specific encoding. |
379 | output, if any, in locale-specific encoding. |
737 | |
380 | |
738 | subwindow. |
|
|
739 | |
|
|
740 | =item on_client_message $term, $event |
381 | =item on_client_message $term, $event |
741 | |
382 | |
742 | =item on_wm_protocols $term, $event |
383 | =item on_wm_protocols $term, $event |
743 | |
384 | |
744 | =item on_wm_delete_window $term, $event |
385 | =item on_wm_delete_window $term, $event |
… | |
… | |
755 | =cut |
396 | =cut |
756 | |
397 | |
757 | package urxvt; |
398 | package urxvt; |
758 | |
399 | |
759 | use utf8; |
400 | use utf8; |
760 | use strict; |
401 | use strict 'vars'; |
761 | use Carp (); |
402 | use Carp (); |
762 | use Scalar::Util (); |
403 | use Scalar::Util (); |
763 | use List::Util (); |
404 | use List::Util (); |
764 | |
405 | |
765 | our $VERSION = 1; |
406 | our $VERSION = 1; |
766 | our $TERM; |
407 | our $TERM; |
767 | our @TERM_INIT; |
408 | our @TERM_INIT; # should go, prevents async I/O etc. |
768 | our @TERM_EXT; |
409 | our @TERM_EXT; # should go, prevents async I/O etc. |
769 | our @HOOKNAME; |
410 | our @HOOKNAME; |
770 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
411 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
771 | our %OPTION; |
412 | our %OPTION; |
772 | |
413 | |
773 | our $LIBDIR; |
414 | our $LIBDIR; |
… | |
… | |
943 | }; |
584 | }; |
944 | } |
585 | } |
945 | |
586 | |
946 | no warnings 'utf8'; |
587 | no warnings 'utf8'; |
947 | |
588 | |
948 | sub resource { |
589 | sub parse_resource { |
949 | my ($term, $name, $isarg, $flag, $value) = @_; |
590 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
950 | |
591 | |
951 | $term->scan_meta; |
592 | $term->scan_extensions; |
952 | |
593 | |
953 | warn "resourece<@_>\n";#d# |
594 | my $r = $term->{meta}{resource}; |
|
|
595 | keys %$r; # reset iterator |
|
|
596 | while (my ($k, $v) = each %$r) { |
|
|
597 | my $pattern = $k; |
|
|
598 | $pattern =~ y/./-/ if $isarg; |
|
|
599 | my $prefix = $name; |
|
|
600 | my $suffix; |
|
|
601 | if ($pattern =~ /\-$/) { |
|
|
602 | $prefix = substr $name, 0, length $pattern; |
|
|
603 | $suffix = substr $name, length $pattern; |
|
|
604 | } |
|
|
605 | if ($pattern eq $prefix) { |
|
|
606 | $name = "$urxvt::RESCLASS.$k$suffix"; |
|
|
607 | |
|
|
608 | push @{ $term->{perl_ext_3} }, $v->[0]; |
|
|
609 | |
|
|
610 | if ($v->[1] eq "boolean") { |
|
|
611 | $term->put_option_db ($name, $flag ? "true" : "false"); |
|
|
612 | return 1; |
|
|
613 | } else { |
|
|
614 | $term->put_option_db ($name, $value); |
|
|
615 | return 1 + 2; |
|
|
616 | } |
|
|
617 | } |
|
|
618 | } |
954 | |
619 | |
955 | 0 |
620 | 0 |
956 | } |
621 | } |
957 | |
622 | |
958 | sub usage { |
623 | sub usage { |
959 | my ($term, $usage_type) = @_; |
624 | my ($term, $usage_type) = @_; |
960 | |
625 | |
961 | $term->scan_meta; |
626 | $term->scan_extensions; |
962 | |
627 | |
963 | my $r = $term->{meta}{resource}; |
628 | my $r = $term->{meta}{resource}; |
964 | |
629 | |
965 | for my $regex (sort keys %$r) { |
630 | for my $pattern (sort keys %$r) { |
966 | my ($ext, $type, $desc) = @{ $r->{$regex} }; |
631 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
967 | |
632 | |
968 | $desc .= " (-pe $ext)"; |
633 | $desc .= " (-pe $ext)"; |
969 | |
634 | |
970 | if ($usage_type == 1) { |
635 | if ($usage_type == 1) { |
|
|
636 | $pattern =~ y/./-/; |
|
|
637 | $pattern =~ s/-$/-.../g; |
|
|
638 | |
971 | if ($type eq "boolean") { |
639 | if ($type eq "boolean") { |
972 | urxvt::log sprintf " -%-20.20s %s\n", "/+$regex", $desc; |
640 | urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc; |
973 | } else { |
641 | } else { |
974 | urxvt::log sprintf " -%-20.20s %s\n", "$regex $type", $desc; |
642 | urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc; |
975 | } |
643 | } |
976 | } else { |
644 | } else { |
|
|
645 | $pattern =~ s/\.$/.*/g; |
977 | urxvt::log sprintf " %-19.19s %s\n", "$regex:", $type; |
646 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
978 | } |
647 | } |
979 | } |
648 | } |
980 | } |
649 | } |
981 | |
650 | |
982 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
651 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
… | |
… | |
998 | $pkg =~ s/[^[:word:]]/_/g; |
667 | $pkg =~ s/[^[:word:]]/_/g; |
999 | $pkg = "urxvt::ext::$pkg"; |
668 | $pkg = "urxvt::ext::$pkg"; |
1000 | |
669 | |
1001 | verbose 3, "loading extension '$path' into package '$pkg'"; |
670 | verbose 3, "loading extension '$path' into package '$pkg'"; |
1002 | |
671 | |
|
|
672 | (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish |
|
|
673 | |
1003 | open my $fh, "<:raw", $path |
674 | open my $fh, "<:raw", $path |
1004 | or die "$path: $!"; |
675 | or die "$path: $!"; |
1005 | |
676 | |
1006 | my $source = |
677 | my $source = |
1007 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
678 | "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n" |
1008 | . "#line 1 \"$path\"\n{\n" |
679 | . "#line 1 \"$path\"\n{\n" |
1009 | . (do { local $/; <$fh> }) |
680 | . (do { local $/; <$fh> }) |
1010 | . "\n};\n1"; |
681 | . "\n};\n1"; |
1011 | |
682 | |
1012 | eval $source |
683 | eval $source |
… | |
… | |
1021 | # called by the rxvt core |
692 | # called by the rxvt core |
1022 | sub invoke { |
693 | sub invoke { |
1023 | local $TERM = shift; |
694 | local $TERM = shift; |
1024 | my $htype = shift; |
695 | my $htype = shift; |
1025 | |
696 | |
1026 | if ($htype == 0) { # INIT |
697 | if ($htype == HOOK_INIT) { |
1027 | my @dirs = $TERM->perl_libdirs; |
698 | my @dirs = $TERM->perl_libdirs; |
|
|
699 | |
|
|
700 | $TERM->scan_extensions; |
1028 | |
701 | |
1029 | my %ext_arg; |
702 | my %ext_arg; |
1030 | |
703 | |
1031 | { |
704 | { |
1032 | my @init = @TERM_INIT; |
705 | my @init = @TERM_INIT; |
… | |
… | |
1035 | my @pkg = @TERM_EXT; |
708 | my @pkg = @TERM_EXT; |
1036 | @TERM_EXT = (); |
709 | @TERM_EXT = (); |
1037 | $TERM->register_package ($_) for @pkg; |
710 | $TERM->register_package ($_) for @pkg; |
1038 | } |
711 | } |
1039 | |
712 | |
|
|
713 | for ( |
1040 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
714 | (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2), |
|
|
715 | @{ delete $TERM->{perl_ext_3} } |
|
|
716 | ) { |
1041 | if ($_ eq "default") { |
717 | if ($_ eq "default") { |
|
|
718 | |
|
|
719 | $ext_arg{$_} = [] |
1042 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
720 | for qw(selection option-popup selection-popup readline searchable-scrollback); |
|
|
721 | |
|
|
722 | for ($TERM->_keysym_resources) { |
|
|
723 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
|
|
724 | next unless /^([A-Za-z0-9_\-]+):/; |
|
|
725 | |
|
|
726 | my $ext = $1; |
|
|
727 | |
|
|
728 | $ext_arg{$ext} = []; |
|
|
729 | } |
|
|
730 | |
1043 | } elsif (/^-(.*)$/) { |
731 | } elsif (/^-(.*)$/) { |
1044 | delete $ext_arg{$1}; |
732 | delete $ext_arg{$1}; |
|
|
733 | |
1045 | } elsif (/^([^<]+)<(.*)>$/) { |
734 | } elsif (/^([^<]+)<(.*)>$/) { |
1046 | push @{ $ext_arg{$1} }, $2; |
735 | push @{ $ext_arg{$1} }, $2; |
|
|
736 | |
1047 | } else { |
737 | } else { |
1048 | $ext_arg{$_} ||= []; |
738 | $ext_arg{$_} ||= []; |
1049 | } |
739 | } |
1050 | } |
740 | } |
1051 | |
741 | |
… | |
… | |
1067 | |
757 | |
1068 | if (my $cb = $TERM->{_hook}[$htype]) { |
758 | if (my $cb = $TERM->{_hook}[$htype]) { |
1069 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
759 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
1070 | if $verbosity >= 10; |
760 | if $verbosity >= 10; |
1071 | |
761 | |
|
|
762 | if ($htype == HOOK_ACTION) { |
|
|
763 | # this hook is only sent to the extension with the name |
|
|
764 | # matching the first arg |
|
|
765 | my $pkg = shift; |
|
|
766 | $pkg =~ y/-/_/; |
|
|
767 | $pkg = "urxvt::ext::$pkg"; |
|
|
768 | |
|
|
769 | $cb = $cb->{$pkg} |
|
|
770 | or return undef; #TODO: maybe warn user? |
|
|
771 | |
|
|
772 | $cb = { $pkg => $cb }; |
|
|
773 | } |
|
|
774 | |
1072 | for my $pkg (keys %$cb) { |
775 | for my $pkg (keys %$cb) { |
1073 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
776 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
1074 | $retval ||= $retval_; |
777 | $retval ||= $retval_; |
1075 | |
778 | |
1076 | if ($@) { |
779 | if ($@) { |
1077 | $TERM->ungrab; # better to lose the grab than the session |
780 | $TERM->ungrab; # better to lose the grab than the session |
1078 | warn $@; |
781 | warn $@; |
… | |
… | |
1081 | |
784 | |
1082 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
785 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
1083 | if $verbosity >= 11; |
786 | if $verbosity >= 11; |
1084 | } |
787 | } |
1085 | |
788 | |
1086 | if ($htype == 1) { # DESTROY |
789 | if ($htype == HOOK_DESTROY) { |
1087 | # clear package objects |
790 | # clear package objects |
1088 | %$_ = () for values %{ $TERM->{_pkg} }; |
791 | %$_ = () for values %{ $TERM->{_pkg} }; |
1089 | |
792 | |
1090 | # clear package |
793 | # clear package |
1091 | %$TERM = (); |
794 | %$TERM = (); |
… | |
… | |
1121 | } |
824 | } |
1122 | } |
825 | } |
1123 | ($mask, @color{qw(fg bg)}, \@failed) |
826 | ($mask, @color{qw(fg bg)}, \@failed) |
1124 | } |
827 | } |
1125 | |
828 | |
1126 | # urxvt::term::extension |
|
|
1127 | |
|
|
1128 | package urxvt::term::extension; |
829 | package urxvt::term::extension; |
1129 | |
830 | |
1130 | sub enable { |
831 | =head2 The C<urxvt::term::extension> class |
1131 | my ($self, %hook) = @_; |
|
|
1132 | my $pkg = $self->{_pkg}; |
|
|
1133 | |
832 | |
1134 | while (my ($name, $cb) = each %hook) { |
833 | Each extension attached to a terminal object is represented by |
1135 | my $htype = $HOOKTYPE{uc $name}; |
834 | a C<urxvt::term::extension> object. |
1136 | defined $htype |
|
|
1137 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1138 | |
835 | |
1139 | $self->set_should_invoke ($htype, +1) |
836 | You can use these objects, which are passed to all callbacks to store any |
1140 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
837 | state related to the terminal and extension instance. |
1141 | |
838 | |
1142 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
839 | The methods (And data members) documented below can be called on extension |
1143 | } |
840 | objects, in addition to call methods documented for the <urxvt::term> |
1144 | } |
841 | class. |
1145 | |
842 | |
1146 | sub disable { |
843 | =over 4 |
1147 | my ($self, @hook) = @_; |
|
|
1148 | my $pkg = $self->{_pkg}; |
|
|
1149 | |
844 | |
1150 | for my $name (@hook) { |
845 | =item $urxvt_term = $self->{term} |
1151 | my $htype = $HOOKTYPE{uc $name}; |
|
|
1152 | defined $htype |
|
|
1153 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1154 | |
846 | |
1155 | $self->set_should_invoke ($htype, -1) |
847 | Returns the C<urxvt::term> object associated with this instance of the |
1156 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
848 | extension. This member I<must not> be changed in any way. |
1157 | } |
849 | |
1158 | } |
850 | =cut |
1159 | |
851 | |
1160 | our $AUTOLOAD; |
852 | our $AUTOLOAD; |
1161 | |
853 | |
1162 | sub AUTOLOAD { |
854 | sub AUTOLOAD { |
1163 | $AUTOLOAD =~ /:([^:]+)$/ |
855 | $AUTOLOAD =~ /:([^:]+)$/ |
… | |
… | |
1176 | |
868 | |
1177 | sub DESTROY { |
869 | sub DESTROY { |
1178 | # nop |
870 | # nop |
1179 | } |
871 | } |
1180 | |
872 | |
1181 | # urxvt::destroy_hook |
873 | # urxvt::destroy_hook (basically a cheap Guard:: implementation) |
1182 | |
874 | |
1183 | sub urxvt::destroy_hook::DESTROY { |
875 | sub urxvt::destroy_hook::DESTROY { |
1184 | ${$_[0]}->(); |
876 | ${$_[0]}->(); |
1185 | } |
877 | } |
1186 | |
878 | |
1187 | sub urxvt::destroy_hook(&) { |
879 | sub urxvt::destroy_hook(&) { |
1188 | bless \shift, urxvt::destroy_hook:: |
880 | bless \shift, urxvt::destroy_hook:: |
1189 | } |
881 | } |
|
|
882 | |
|
|
883 | =item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
884 | |
|
|
885 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
886 | this extension, replacing any hook previously installed via C<enable> in |
|
|
887 | this extension. |
|
|
888 | |
|
|
889 | This is useful when you want to overwrite time-critical hooks only |
|
|
890 | temporarily. |
|
|
891 | |
|
|
892 | To install additional callbacks for the same hook, you can use the C<on> |
|
|
893 | method of the C<urxvt::term> class. |
|
|
894 | |
|
|
895 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
896 | |
|
|
897 | Dynamically disable the given hooks. |
|
|
898 | |
|
|
899 | =cut |
|
|
900 | |
|
|
901 | sub enable { |
|
|
902 | my ($self, %hook) = @_; |
|
|
903 | my $pkg = $self->{_pkg}; |
|
|
904 | |
|
|
905 | while (my ($name, $cb) = each %hook) { |
|
|
906 | my $htype = $HOOKTYPE{uc $name}; |
|
|
907 | defined $htype |
|
|
908 | or Carp::croak "unsupported hook type '$name'"; |
|
|
909 | |
|
|
910 | $self->set_should_invoke ($htype, +1) |
|
|
911 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
|
|
912 | |
|
|
913 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
914 | } |
|
|
915 | } |
|
|
916 | |
|
|
917 | sub disable { |
|
|
918 | my ($self, @hook) = @_; |
|
|
919 | my $pkg = $self->{_pkg}; |
|
|
920 | |
|
|
921 | for my $name (@hook) { |
|
|
922 | my $htype = $HOOKTYPE{uc $name}; |
|
|
923 | defined $htype |
|
|
924 | or Carp::croak "unsupported hook type '$name'"; |
|
|
925 | |
|
|
926 | $self->set_should_invoke ($htype, -1) |
|
|
927 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
|
|
928 | } |
|
|
929 | } |
|
|
930 | |
|
|
931 | =item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
932 | |
|
|
933 | Similar to the C<enable> enable, but installs additional callbacks for |
|
|
934 | the given hook(s) (that is, it doesn't replace existing callbacks), and |
|
|
935 | returns a guard object. When the guard object is destroyed the callbacks |
|
|
936 | are disabled again. |
|
|
937 | |
|
|
938 | =cut |
|
|
939 | |
|
|
940 | sub urxvt::extension::on_disable::DESTROY { |
|
|
941 | my $disable = shift; |
|
|
942 | |
|
|
943 | my $term = delete $disable->{""}; |
|
|
944 | |
|
|
945 | while (my ($htype, $id) = each %$disable) { |
|
|
946 | delete $term->{_hook}[$htype]{$id}; |
|
|
947 | $term->set_should_invoke ($htype, -1); |
|
|
948 | } |
|
|
949 | } |
|
|
950 | |
|
|
951 | sub on { |
|
|
952 | my ($self, %hook) = @_; |
|
|
953 | |
|
|
954 | my $term = $self->{term}; |
|
|
955 | |
|
|
956 | my %disable = ( "" => $term ); |
|
|
957 | |
|
|
958 | while (my ($name, $cb) = each %hook) { |
|
|
959 | my $htype = $HOOKTYPE{uc $name}; |
|
|
960 | defined $htype |
|
|
961 | or Carp::croak "unsupported hook type '$name'"; |
|
|
962 | |
|
|
963 | $term->set_should_invoke ($htype, +1); |
|
|
964 | $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 } |
|
|
965 | = sub { shift; $cb->($self, @_) }; # very ugly indeed |
|
|
966 | } |
|
|
967 | |
|
|
968 | bless \%disable, "urxvt::extension::on_disable" |
|
|
969 | } |
|
|
970 | |
|
|
971 | =item $self->bind_action ($hotkey, $action) |
|
|
972 | |
|
|
973 | =item $self->x_resource ($pattern) |
|
|
974 | |
|
|
975 | =item $self->x_resource_boolean ($pattern) |
|
|
976 | |
|
|
977 | These methods support an additional C<%> prefix for C<$action> or |
|
|
978 | C<$pattern> when called on an extension object, compared to the |
|
|
979 | C<urxvt::term> methods of the same name - see the description of these |
|
|
980 | methods in the C<urxvt::term> class for details. |
|
|
981 | |
|
|
982 | =cut |
|
|
983 | |
|
|
984 | sub bind_action { |
|
|
985 | my ($self, $hotkey, $action) = @_; |
|
|
986 | $action =~ s/^%:/$_[0]{_name}:/; |
|
|
987 | $self->{term}->bind_action ($hotkey, $action) |
|
|
988 | } |
|
|
989 | |
|
|
990 | sub x_resource { |
|
|
991 | my ($self, $name) = @_; |
|
|
992 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
993 | $self->{term}->x_resource ($name) |
|
|
994 | } |
|
|
995 | |
|
|
996 | sub x_resource_boolean { |
|
|
997 | my ($self, $name) = @_; |
|
|
998 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
999 | $self->{term}->x_resource_boolean ($name) |
|
|
1000 | } |
|
|
1001 | |
|
|
1002 | =back |
|
|
1003 | |
|
|
1004 | =cut |
1190 | |
1005 | |
1191 | package urxvt::anyevent; |
1006 | package urxvt::anyevent; |
1192 | |
1007 | |
1193 | =head2 The C<urxvt::anyevent> Class |
1008 | =head2 The C<urxvt::anyevent> Class |
1194 | |
1009 | |
… | |
… | |
1290 | urxvt::verbose 6, "register package $pkg to $self"; |
1105 | urxvt::verbose 6, "register package $pkg to $self"; |
1291 | |
1106 | |
1292 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
1107 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
1293 | |
1108 | |
1294 | my $proxy = bless { |
1109 | my $proxy = bless { |
1295 | _pkg => $pkg, |
1110 | _pkg => $pkg, |
|
|
1111 | _name => ${"$pkg\::_NAME"}, # hackish |
1296 | argv => $argv, |
1112 | argv => $argv, |
1297 | }, $pkg; |
1113 | }, $pkg; |
1298 | Scalar::Util::weaken ($proxy->{term} = $self); |
1114 | Scalar::Util::weaken ($proxy->{term} = $self); |
1299 | |
1115 | |
1300 | $self->{_pkg}{$pkg} = $proxy; |
1116 | $self->{_pkg}{$pkg} = $proxy; |
1301 | |
1117 | |
… | |
… | |
1312 | $ENV{URXVT_PERL_LIB}, |
1128 | $ENV{URXVT_PERL_LIB}, |
1313 | "$ENV{HOME}/.urxvt/ext", |
1129 | "$ENV{HOME}/.urxvt/ext", |
1314 | "$LIBDIR/perl" |
1130 | "$LIBDIR/perl" |
1315 | } |
1131 | } |
1316 | |
1132 | |
1317 | sub scan_meta { |
1133 | # scan for available extensions and collect their metadata |
|
|
1134 | sub scan_extensions { |
1318 | my ($self) = @_; |
1135 | my ($self) = @_; |
|
|
1136 | |
|
|
1137 | return if exists $self->{meta}; |
|
|
1138 | |
1319 | my @libdirs = perl_libdirs $self; |
1139 | my @urxvtdirs = perl_libdirs $self; |
|
|
1140 | my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; |
1320 | |
1141 | |
1321 | return if $self->{meta_libdirs} eq join "\x00", @libdirs; |
|
|
1322 | |
|
|
1323 | my %meta; |
|
|
1324 | |
|
|
1325 | $self->{meta_libdirs} = join "\x00", @libdirs; |
|
|
1326 | $self->{meta} = \%meta; |
1142 | $self->{meta} = \my %meta; |
1327 | |
1143 | |
1328 | for my $dir (reverse @libdirs) { |
1144 | # first gather extensions |
|
|
1145 | |
|
|
1146 | my $gather = sub { |
|
|
1147 | my ($dir, $core) = @_; |
|
|
1148 | |
1329 | opendir my $fh, $dir |
1149 | opendir my $fh, $dir |
1330 | or next; |
1150 | or return; |
|
|
1151 | |
1331 | for my $ext (readdir $fh) { |
1152 | for my $ext (readdir $fh) { |
1332 | $ext ne "." |
1153 | $ext !~ /^\./ |
1333 | and $ext ne ".." |
|
|
1334 | and open my $fh, "<", "$dir/$ext" |
|
|
1335 | or next; |
1154 | or next; |
1336 | |
1155 | |
|
|
1156 | open my $fh, "<", "$dir/$ext" |
|
|
1157 | or next; |
|
|
1158 | |
|
|
1159 | -f $fh |
|
|
1160 | or next; |
|
|
1161 | |
|
|
1162 | $ext =~ s/\.uext$// or $core |
|
|
1163 | or next; |
|
|
1164 | |
|
|
1165 | my %ext = (dir => $dir); |
|
|
1166 | |
1337 | while (<$fh>) { |
1167 | while (<$fh>) { |
1338 | if (/^#:META:RESOURCE:(.*)/) { |
1168 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
1339 | my ($regex, $type, $desc) = split /:/, $1; |
1169 | my ($pattern, $type, $desc) = split /:/, $1; |
1340 | $regex =~ s/\$\$/$ext/g; # $$ in regex == extension name |
1170 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
|
|
1171 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
|
|
1172 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
|
|
1173 | } else { |
1341 | $meta{resource}{$regex} = [$ext, $type, $desc]; |
1174 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
|
|
1175 | } |
1342 | } elsif (/^\s*(?:#|$)/) { |
1176 | } elsif (/^\s*(?:#|$)/) { |
1343 | # skip other comments and empty lines |
1177 | # skip other comments and empty lines |
1344 | } else { |
1178 | } else { |
1345 | last; # stop parsing on first non-empty non-comment line |
1179 | last; # stop parsing on first non-empty non-comment line |
1346 | } |
1180 | } |
1347 | } |
1181 | } |
|
|
1182 | |
|
|
1183 | $meta{ext}{$ext} = \%ext; |
1348 | } |
1184 | } |
|
|
1185 | }; |
|
|
1186 | |
|
|
1187 | $gather->($_, 0) for @cpandirs; |
|
|
1188 | $gather->($_, 1) for @urxvtdirs; |
|
|
1189 | |
|
|
1190 | # and now merge resources |
|
|
1191 | while (my ($k, $v) = each %{ $meta{ext} }) { |
|
|
1192 | #TODO: should check for extensions overriding each other |
|
|
1193 | %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); |
1349 | } |
1194 | } |
1350 | } |
1195 | } |
1351 | |
1196 | |
1352 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1197 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1353 | |
1198 | |
… | |
… | |
1373 | } |
1218 | } |
1374 | |
1219 | |
1375 | =item $term->destroy |
1220 | =item $term->destroy |
1376 | |
1221 | |
1377 | Destroy the terminal object (close the window, free resources |
1222 | Destroy the terminal object (close the window, free resources |
1378 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1223 | etc.). Please note that urxvt will not exit as long as any event |
1379 | watchers (timers, io watchers) are still active. |
1224 | watchers (timers, io watchers) are still active. |
1380 | |
1225 | |
1381 | =item $term->exec_async ($cmd[, @args]) |
1226 | =item $term->exec_async ($cmd[, @args]) |
1382 | |
1227 | |
1383 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
1228 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
… | |
… | |
1439 | |
1284 | |
1440 | Here is a likely non-exhaustive list of resource names, not all of which |
1285 | Here is a likely non-exhaustive list of resource names, not all of which |
1441 | are supported in every build, please see the source file F</src/rsinc.h> |
1286 | are supported in every build, please see the source file F</src/rsinc.h> |
1442 | to see the actual list: |
1287 | to see the actual list: |
1443 | |
1288 | |
1444 | answerbackstring backgroundPixmap backspace_key blendtype blurradius |
1289 | answerbackstring backgroundPixmap backspace_key blurradius |
1445 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1290 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1446 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1291 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1447 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
1292 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
1448 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
1293 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
1449 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1294 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
… | |
… | |
1469 | Returns the X-Resource for the given pattern, excluding the program or |
1314 | Returns the X-Resource for the given pattern, excluding the program or |
1470 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1315 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1471 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1316 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1472 | resource with that pattern exists. |
1317 | resource with that pattern exists. |
1473 | |
1318 | |
|
|
1319 | Extensions that define extra resources also need to call this method |
|
|
1320 | to access their values. |
|
|
1321 | |
|
|
1322 | If the method is called on an extension object (basically, from an |
|
|
1323 | extension), then the special prefix C<%.> will be replaced by the name of |
|
|
1324 | the extension and a dot, and the lone string C<%> will be replaced by the |
|
|
1325 | extension name itself. This makes it possible to code extensions so you |
|
|
1326 | can rename them and get a new set of resources without having to change |
|
|
1327 | the actual code. |
|
|
1328 | |
1474 | This method should only be called during the C<on_start> hook, as there is |
1329 | This method should only be called during the C<on_start> hook, as there is |
1475 | only one resource database per display, and later invocations might return |
1330 | only one resource database per display, and later invocations might return |
1476 | the wrong resources. |
1331 | the wrong resources. |
1477 | |
1332 | |
1478 | =item $success = $term->parse_keysym ($key, $octets) |
1333 | =item $value = $term->x_resource_boolean ($pattern) |
1479 | |
1334 | |
|
|
1335 | Like C<x_resource>, above, but interprets the string value as a boolean |
|
|
1336 | and returns C<1> for true values, C<0> for false values and C<undef> if |
|
|
1337 | the resource or option isn't specified. |
|
|
1338 | |
|
|
1339 | You should always use this method to parse boolean resources. |
|
|
1340 | |
|
|
1341 | =cut |
|
|
1342 | |
|
|
1343 | sub x_resource_boolean { |
|
|
1344 | my $res = &x_resource; |
|
|
1345 | |
|
|
1346 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
|
|
1347 | } |
|
|
1348 | |
|
|
1349 | =item $success = $term->bind_action ($key, $action) |
|
|
1350 | |
1480 | Adds a key binding exactly as specified via a resource. See the |
1351 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1481 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1352 | C<keysym> resource in the urxvt(1) manpage. |
1482 | |
1353 | |
1483 | =item $term->register_command ($keysym, $modifiermask, $string) |
1354 | To add default bindings for an extension, the extension should call C<< |
|
|
1355 | ->bind_action >> on it's C<init> hook for every such binding. Doing it |
|
|
1356 | in the C<init> hook allows users the override or remove the the binding |
|
|
1357 | again. |
1484 | |
1358 | |
1485 | Adds a key binding. This is a lower level api compared to |
1359 | Example: the C<searchable-scrollback> by default binds itself |
1486 | C<parse_keysym>, as it expects a parsed key description, and can be |
1360 | on C<Meta-s>, using C<< $self->bind_action >>, which calls C<< |
1487 | used only inside either the C<on_init> hook, to add a binding, or the |
1361 | $term->bind_action >>. |
1488 | C<on_register_command> hook, to modify a parsed binding. |
1362 | |
|
|
1363 | sub init { |
|
|
1364 | my ($self) = @_; |
|
|
1365 | |
|
|
1366 | $self->bind_action ("M-s" => "%:start"); |
|
|
1367 | } |
1489 | |
1368 | |
1490 | =item $rend = $term->rstyle ([$new_rstyle]) |
1369 | =item $rend = $term->rstyle ([$new_rstyle]) |
1491 | |
1370 | |
1492 | Return and optionally change the current rendition. Text that is output by |
1371 | Return and optionally change the current rendition. Text that is output by |
1493 | the terminal application will use this style. |
1372 | the terminal application will use this style. |
… | |
… | |
1651 | |
1530 | |
1652 | =item $term->scr_add_lines ($string) |
1531 | =item $term->scr_add_lines ($string) |
1653 | |
1532 | |
1654 | Write the given text string to the screen, as if output by the application |
1533 | Write the given text string to the screen, as if output by the application |
1655 | running inside the terminal. It may not contain command sequences (escape |
1534 | running inside the terminal. It may not contain command sequences (escape |
1656 | codes), but is free to use line feeds, carriage returns and tabs. The |
1535 | codes - see C<cmd_parse> for that), but is free to use line feeds, |
1657 | string is a normal text string, not in locale-dependent encoding. |
1536 | carriage returns and tabs. The string is a normal text string, not in |
|
|
1537 | locale-dependent encoding. |
1658 | |
1538 | |
1659 | Normally its not a good idea to use this function, as programs might be |
1539 | Normally its not a good idea to use this function, as programs might be |
1660 | confused by changes in cursor position or scrolling. Its useful inside a |
1540 | confused by changes in cursor position or scrolling. Its useful inside a |
1661 | C<on_add_lines> hook, though. |
1541 | C<on_add_lines> hook, though. |
1662 | |
1542 | |
… | |
… | |
1670 | locale-specific encoding of the terminal and can contain command sequences |
1550 | locale-specific encoding of the terminal and can contain command sequences |
1671 | (escape codes) that will be interpreted. |
1551 | (escape codes) that will be interpreted. |
1672 | |
1552 | |
1673 | =item $term->tt_write ($octets) |
1553 | =item $term->tt_write ($octets) |
1674 | |
1554 | |
1675 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1555 | Write the octets given in C<$octets> to the tty (i.e. as user input |
|
|
1556 | to the program, see C<cmd_parse> for the opposite direction). To pass |
1676 | pass characters instead of octets, you should convert your strings first |
1557 | characters instead of octets, you should convert your strings first to the |
1677 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1558 | locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1559 | |
|
|
1560 | =item $term->tt_write_user_input ($octets) |
|
|
1561 | |
|
|
1562 | Like C<tt_write>, but should be used when writing strings in response to |
|
|
1563 | the user pressing a key, to invoke the additional actions requested by |
|
|
1564 | the user for that case (C<tt_write> doesn't do that). |
|
|
1565 | |
|
|
1566 | The typical use case would be inside C<on_action> hooks. |
1678 | |
1567 | |
1679 | =item $term->tt_paste ($octets) |
1568 | =item $term->tt_paste ($octets) |
1680 | |
1569 | |
1681 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
1570 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
1682 | CR and bracketing the data with control sequences if bracketed paste mode |
1571 | CR and bracketing the data with control sequences if bracketed paste mode |
… | |
… | |
1916 | } |
1805 | } |
1917 | |
1806 | |
1918 | sub urxvt::line::t { |
1807 | sub urxvt::line::t { |
1919 | my ($self) = @_; |
1808 | my ($self) = @_; |
1920 | |
1809 | |
1921 | if (@_ > 1) |
1810 | if (@_ > 1) { |
1922 | { |
|
|
1923 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1811 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1924 | for $self->{beg} .. $self->{end}; |
1812 | for $self->{beg} .. $self->{end}; |
1925 | } |
1813 | } |
1926 | |
1814 | |
1927 | defined wantarray && |
1815 | defined wantarray && |
1928 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1816 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1929 | 0, $self->{len} |
1817 | 0, $self->{len} |
1930 | } |
1818 | } |
1931 | |
1819 | |
1932 | sub urxvt::line::r { |
1820 | sub urxvt::line::r { |
1933 | my ($self) = @_; |
1821 | my ($self) = @_; |
1934 | |
1822 | |
1935 | if (@_ > 1) |
1823 | if (@_ > 1) { |
1936 | { |
|
|
1937 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1824 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1938 | for $self->{beg} .. $self->{end}; |
1825 | for $self->{beg} .. $self->{end}; |
1939 | } |
1826 | } |
1940 | |
1827 | |
1941 | if (defined wantarray) { |
1828 | if (defined wantarray) { |
1942 | my $rend = [ |
1829 | my $rend = [ |
1943 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1830 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1944 | ]; |
1831 | ]; |