1 | =encoding utf8 |
1 | =encoding utf8 |
2 | |
2 | |
3 | =head1 NAME |
3 | =head1 NAME |
4 | |
4 | |
5 | @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter |
5 | urxvtperl - rxvt-unicode's embedded perl interpreter |
6 | |
6 | |
7 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
8 | |
8 | |
9 | # create a file grab_test in $HOME: |
9 | # create a file grab_test in $HOME: |
10 | |
10 | |
11 | sub on_sel_grab { |
11 | sub on_sel_grab { |
12 | warn "you selected ", $_[0]->selection; |
12 | warn "you selected ", $_[0]->selection; |
13 | () |
13 | () |
14 | } |
14 | } |
15 | |
15 | |
16 | # start a @@RXVT_NAME@@ using it: |
16 | # start a urxvt using it: |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | urxvt --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Every time a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in urxvtd, where |
29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
30 | |
30 | |
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
32 | and "perl-ext-common" resources to the empty string. |
32 | and "perl-ext-common" resources to the empty string. |
33 | |
33 | |
34 | =head1 PREPACKAGED EXTENSIONS |
34 | =head1 PREPACKAGED EXTENSIONS |
35 | |
35 | |
36 | This section describes the extensions delivered with this release. You can |
36 | A number of extensions are delivered with this release. You can find them |
37 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
37 | in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using |
|
|
38 | F<< man urxvt-<EXTENSIONNAME> >>. |
38 | |
39 | |
39 | You can activate them like this: |
40 | You can activate them like this: |
40 | |
41 | |
41 | @@RXVT_NAME@@ -pe <extensionname> |
42 | urxvt -pe <extensionname> |
42 | |
43 | |
43 | Or by adding them to the resource for extensions loaded by default: |
44 | Or by adding them to the resource for extensions loaded by default: |
44 | |
45 | |
45 | URxvt.perl-ext-common: default,selection-autotransform |
46 | URxvt.perl-ext-common: default,selection-autotransform |
46 | |
47 | |
47 | =over 4 |
48 | Extensions that add command line parameters or resources on their own are |
48 | |
49 | loaded automatically when used. |
49 | =item selection (enabled by default) |
|
|
50 | |
|
|
51 | (More) intelligent selection. This extension tries to be more intelligent |
|
|
52 | when the user extends selections (double-click and further clicks). Right |
|
|
53 | now, it tries to select words, urls and complete shell-quoted |
|
|
54 | arguments, which is very convenient, too, if your F<ls> supports |
|
|
55 | C<--quoting-style=shell>. |
|
|
56 | |
|
|
57 | A double-click usually selects the word under the cursor, further clicks |
|
|
58 | will enlarge the selection. |
|
|
59 | |
|
|
60 | The selection works by trying to match a number of regexes and displaying |
|
|
61 | them in increasing order of length. You can add your own regexes by |
|
|
62 | specifying resources of the form: |
|
|
63 | |
|
|
64 | URxvt.selection.pattern-0: perl-regex |
|
|
65 | URxvt.selection.pattern-1: perl-regex |
|
|
66 | ... |
|
|
67 | |
|
|
68 | The index number (0, 1...) must not have any holes, and each regex must |
|
|
69 | contain at least one pair of capturing parentheses, which will be used for |
|
|
70 | the match. For example, the following adds a regex that matches everything |
|
|
71 | between two vertical bars: |
|
|
72 | |
|
|
73 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
74 | |
|
|
75 | Another example: Programs I use often output "absolute path: " at the |
|
|
76 | beginning of a line when they process multiple files. The following |
|
|
77 | pattern matches the filename (note, there is a single space at the very |
|
|
78 | end): |
|
|
79 | |
|
|
80 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
|
|
81 | |
|
|
82 | You can look at the source of the selection extension to see more |
|
|
83 | interesting uses, such as parsing a line from beginning to end. |
|
|
84 | |
|
|
85 | This extension also offers following bindable keyboard commands: |
|
|
86 | |
|
|
87 | =over 4 |
|
|
88 | |
|
|
89 | =item rot13 |
|
|
90 | |
|
|
91 | Rot-13 the selection when activated. Used via keyboard trigger: |
|
|
92 | |
|
|
93 | URxvt.keysym.C-M-r: perl:selection:rot13 |
|
|
94 | |
|
|
95 | =back |
|
|
96 | |
|
|
97 | =item option-popup (enabled by default) |
|
|
98 | |
|
|
99 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
|
|
100 | runtime. |
|
|
101 | |
|
|
102 | Other extensions can extend this popup menu by pushing a code reference |
|
|
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
104 | popup is being displayed. |
|
|
105 | |
|
|
106 | Its sole argument is the popup menu, which can be modified. It should |
|
|
107 | either return nothing or a string, the initial boolean value and a code |
|
|
108 | reference. The string will be used as button text and the code reference |
|
|
109 | will be called when the toggle changes, with the new boolean value as |
|
|
110 | first argument. |
|
|
111 | |
|
|
112 | The following will add an entry C<myoption> that changes |
|
|
113 | C<< $self->{myoption} >>: |
|
|
114 | |
|
|
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
117 | }; |
|
|
118 | |
|
|
119 | =item selection-popup (enabled by default) |
|
|
120 | |
|
|
121 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
122 | text into various other formats/action (such as uri unescaping, perl |
|
|
123 | evaluation, web-browser starting etc.), depending on content. |
|
|
124 | |
|
|
125 | Other extensions can extend this popup menu by pushing a code reference |
|
|
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
|
|
127 | popup is being displayed. |
|
|
128 | |
|
|
129 | Its sole argument is the popup menu, which can be modified. The selection |
|
|
130 | is in C<$_>, which can be used to decide whether to add something or not. |
|
|
131 | It should either return nothing or a string and a code reference. The |
|
|
132 | string will be used as button text and the code reference will be called |
|
|
133 | when the button gets activated and should transform C<$_>. |
|
|
134 | |
|
|
135 | The following will add an entry C<a to b> that transforms all C<a>s in |
|
|
136 | the selection to C<b>s, but only if the selection currently contains any |
|
|
137 | C<a>s: |
|
|
138 | |
|
|
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
140 | /a/ ? ("a to b" => sub { s/a/b/g } |
|
|
141 | : () |
|
|
142 | }; |
|
|
143 | |
|
|
144 | =item searchable-scrollback<hotkey> (enabled by default) |
|
|
145 | |
|
|
146 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
147 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
|
|
148 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
149 | screen. |
|
|
150 | |
|
|
151 | Inputting characters appends them to the regex and continues incremental |
|
|
152 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
|
|
153 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
|
|
154 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
155 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
156 | additionally stores the first match in the current line into the primary |
|
|
157 | selection if the C<Shift> modifier is active. |
|
|
158 | |
|
|
159 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
|
|
160 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
|
|
161 | or simply use an uppercase character which removes the "(?i)" prefix. |
|
|
162 | |
|
|
163 | See L<perlre> for more info about perl regular expression syntax. |
|
|
164 | |
|
|
165 | =item readline (enabled by default) |
|
|
166 | |
|
|
167 | A support package that tries to make editing with readline easier. At |
|
|
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
|
|
169 | move the text cursor to this position. It does so by generating as many |
|
|
170 | cursor-left or cursor-right keypresses as required (this only works |
|
|
171 | for programs that correctly support wide characters). |
|
|
172 | |
|
|
173 | To avoid too many false positives, this is only done when: |
|
|
174 | |
|
|
175 | =over 4 |
|
|
176 | |
|
|
177 | =item - the tty is in ICANON state. |
|
|
178 | |
|
|
179 | =item - the text cursor is visible. |
|
|
180 | |
|
|
181 | =item - the primary screen is currently being displayed. |
|
|
182 | |
|
|
183 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
184 | |
|
|
185 | =back |
|
|
186 | |
|
|
187 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
188 | might interfere with selection creation in harmless ways. |
|
|
189 | |
|
|
190 | =item selection-autotransform |
|
|
191 | |
|
|
192 | This selection allows you to do automatic transforms on a selection |
|
|
193 | whenever a selection is made. |
|
|
194 | |
|
|
195 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
196 | operator) that modify C<$_> as resources: |
|
|
197 | |
|
|
198 | URxvt.selection-autotransform.0: transform |
|
|
199 | URxvt.selection-autotransform.1: transform |
|
|
200 | ... |
|
|
201 | |
|
|
202 | For example, the following will transform selections of the form |
|
|
203 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
204 | $word>: |
|
|
205 | |
|
|
206 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
207 | |
|
|
208 | And this example matches the same,but replaces it with vi-commands you can |
|
|
209 | paste directly into your (vi :) editor: |
|
|
210 | |
|
|
211 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
212 | |
|
|
213 | Of course, this can be modified to suit your needs and your editor :) |
|
|
214 | |
|
|
215 | To expand the example above to typical perl error messages ("XXX at |
|
|
216 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
217 | |
|
|
218 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
219 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
220 | |
|
|
221 | The first line tells the selection code to treat the unchanging part of |
|
|
222 | every error message as a selection pattern, and the second line transforms |
|
|
223 | the message into vi commands to load the file. |
|
|
224 | |
|
|
225 | =item tabbed |
|
|
226 | |
|
|
227 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
228 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
|
|
229 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
230 | button per tab. |
|
|
231 | |
|
|
232 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
233 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
234 | while B<Shift-Down> creates a new tab. |
|
|
235 | |
|
|
236 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
237 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
238 | following four resources (shown with defaults): |
|
|
239 | |
|
|
240 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
241 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
242 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
243 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
244 | |
|
|
245 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
246 | indices. |
|
|
247 | |
|
|
248 | =item matcher |
|
|
249 | |
|
|
250 | Uses per-line display filtering (C<on_line_update>) to underline text |
|
|
251 | matching a certain pattern and make it clickable. When clicked with the |
|
|
252 | mouse button specified in the C<matcher.button> resource (default 2, or |
|
|
253 | middle), the program specified in the C<matcher.launcher> resource |
|
|
254 | (default, the C<urlLauncher> resource, C<sensible-browser>) will be started |
|
|
255 | with the matched text as first argument. The default configuration is |
|
|
256 | suitable for matching URLs and launching a web browser, like the |
|
|
257 | former "mark-urls" extension. |
|
|
258 | |
|
|
259 | The default pattern to match URLs can be overridden with the |
|
|
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
|
|
261 | with numbered patterns, in a manner similar to the "selection" extension. |
|
|
262 | The launcher can also be overridden on a per-pattern basis. |
|
|
263 | |
|
|
264 | It is possible to activate the most recently seen match from the keyboard. |
|
|
265 | Simply bind a keysym to "perl:matcher" as seen in the example below. |
|
|
266 | |
|
|
267 | Example configuration: |
|
|
268 | |
|
|
269 | URxvt.perl-ext: default,matcher |
|
|
270 | URxvt.urlLauncher: sensible-browser |
|
|
271 | URxvt.keysym.C-Delete: perl:matcher |
|
|
272 | URxvt.matcher.button: 1 |
|
|
273 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
274 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
275 | URxvt.matcher.launcher.2: gvim +$2 $1 |
|
|
276 | |
|
|
277 | =item xim-onthespot |
|
|
278 | |
|
|
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
280 | not work perfectly, and some input methods don't seem to work well with |
|
|
281 | OnTheSpot editing in general, but it seems to work at least for SCIM and |
|
|
282 | kinput2. |
|
|
283 | |
|
|
284 | You enable it by specifying this extension and a preedit style of |
|
|
285 | C<OnTheSpot>, i.e.: |
|
|
286 | |
|
|
287 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
288 | |
|
|
289 | =item kuake<hotkey> |
|
|
290 | |
|
|
291 | A very primitive quake-console-like extension. It was inspired by a |
|
|
292 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
293 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
294 | will show or hide itself. Another press of the accelerator key will hide |
|
|
295 | or show it again. |
|
|
296 | |
|
|
297 | Initially, the window will not be shown when using this extension. |
|
|
298 | |
|
|
299 | This is useful if you need a single terminal that is not using any desktop |
|
|
300 | space most of the time but is quickly available at the press of a key. |
|
|
301 | |
|
|
302 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
303 | extension will actually grab a physical key just for this function. |
|
|
304 | |
|
|
305 | If you want a quake-like animation, tell your window manager to do so |
|
|
306 | (fvwm can do it). |
|
|
307 | |
|
|
308 | =item overlay-osc |
|
|
309 | |
|
|
310 | This extension implements some OSC commands to display timed popups on the |
|
|
311 | screen - useful for status displays from within scripts. You have to read |
|
|
312 | the sources for more info. |
|
|
313 | |
|
|
314 | =item block-graphics-to-ascii |
|
|
315 | |
|
|
316 | A not very useful example of filtering all text output to the terminal |
|
|
317 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
318 | similar-looking ascii character. |
|
|
319 | |
|
|
320 | =item digital-clock |
|
|
321 | |
|
|
322 | Displays a digital clock using the built-in overlay. |
|
|
323 | |
|
|
324 | =item remote-clipboard |
|
|
325 | |
|
|
326 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
327 | selection popup that allows one to run external commands to store the |
|
|
328 | selection somewhere and fetch it again. |
|
|
329 | |
|
|
330 | We use it to implement a "distributed selection mechanism", which just |
|
|
331 | means that one command uploads the file to a remote server, and another |
|
|
332 | reads it. |
|
|
333 | |
|
|
334 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
335 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
336 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
337 | the selection data on STDOUT (also in UTF-8). |
|
|
338 | |
|
|
339 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
340 | |
|
|
341 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
342 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
|
|
343 | |
|
|
344 | =item selection-pastebin |
|
|
345 | |
|
|
346 | This is a little rarely useful extension that uploads the selection as |
|
|
347 | textfile to a remote site (or does other things). (The implementation is |
|
|
348 | not currently secure for use in a multiuser environment as it writes to |
|
|
349 | F</tmp> directly.). |
|
|
350 | |
|
|
351 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
352 | i.e. |
|
|
353 | |
|
|
354 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
355 | |
|
|
356 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
357 | the textfile. This command can be set via a resource: |
|
|
358 | |
|
|
359 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
360 | |
|
|
361 | And the default is likely not useful to anybody but the few people around |
|
|
362 | here :) |
|
|
363 | |
|
|
364 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
365 | the same content should lead to the same filename. |
|
|
366 | |
|
|
367 | After a successful upload the selection will be replaced by the text given |
|
|
368 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
369 | for the filename): |
|
|
370 | |
|
|
371 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
372 | |
|
|
373 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
374 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
375 | which works regardless of whether xrdb is used to parse the resource file |
|
|
376 | or not. |
|
|
377 | |
|
|
378 | =item macosx-clipboard and macosx-clipboard-native |
|
|
379 | |
|
|
380 | These two modules implement an extended clipboard for Mac OS X. They are |
|
|
381 | used like this: |
|
|
382 | |
|
|
383 | URxvt.perl-ext-common: default,macosx-clipboard |
|
|
384 | URxvt.keysym.M-c: perl:macosx-clipboard:copy |
|
|
385 | URxvt.keysym.M-v: perl:macosx-clipboard:paste |
|
|
386 | |
|
|
387 | The difference between them is that the native variant requires a |
|
|
388 | perl from apple's devkit or so, and C<macosx-clipboard> requires the |
|
|
389 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
|
|
390 | simpler etc. etc. |
|
|
391 | |
|
|
392 | =item example-refresh-hooks |
|
|
393 | |
|
|
394 | Displays a very simple digital clock in the upper right corner of the |
|
|
395 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
396 | overlays or changes. |
|
|
397 | |
|
|
398 | =item confirm-paste |
|
|
399 | |
|
|
400 | Displays a confirmation dialog when a paste containing at least a full |
|
|
401 | line is detected. |
|
|
402 | |
|
|
403 | =back |
|
|
404 | |
50 | |
405 | =head1 API DOCUMENTATION |
51 | =head1 API DOCUMENTATION |
406 | |
52 | |
407 | =head2 General API Considerations |
53 | =head2 General API Considerations |
408 | |
54 | |
… | |
… | |
436 | =item $octets |
82 | =item $octets |
437 | |
83 | |
438 | 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 |
439 | locale-specific way. |
85 | locale-specific way. |
440 | |
86 | |
|
|
87 | =item $keysym |
|
|
88 | |
|
|
89 | an integer that is a valid X11 keysym code. You can convert a string |
|
|
90 | into a keysym and viceversa by using C<XStringToKeysym> and |
|
|
91 | C<XKeysymToString>. |
|
|
92 | |
441 | =back |
93 | =back |
442 | |
94 | |
443 | =head2 Extension Objects |
95 | =head2 Extension Objects |
444 | |
96 | |
445 | Every perl extension is a perl class. A separate perl object is created |
97 | Every perl extension is a perl class. A separate perl object is created |
446 | for each terminal, and each terminal has its own set of extenion objects, |
98 | for each terminal, and each terminal has its own set of extension objects, |
447 | which are passed as the first parameter to hooks. So extensions can use |
99 | which are passed as the first parameter to hooks. So extensions can use |
448 | their C<$self> object without having to think about clashes with other |
100 | their C<$self> object without having to think about clashes with other |
449 | extensions or other terminals, with the exception of methods and members |
101 | extensions or other terminals, with the exception of methods and members |
450 | that begin with an underscore character C<_>: these are reserved for |
102 | that begin with an underscore character C<_>: these are reserved for |
451 | internal use. |
103 | internal use. |
452 | |
104 | |
453 | 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 |
454 | C<urxvt::term> class on this object. |
106 | C<urxvt::term> class on this object. |
455 | |
107 | |
456 | It has the following methods and data members: |
108 | Additional methods only supported for extension objects are described in |
457 | |
109 | the C<urxvt::extension> section below. |
458 | =over 4 |
|
|
459 | |
|
|
460 | =item $urxvt_term = $self->{term} |
|
|
461 | |
|
|
462 | Returns the C<urxvt::term> object associated with this instance of the |
|
|
463 | extension. This member I<must not> be changed in any way. |
|
|
464 | |
|
|
465 | =item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
466 | |
|
|
467 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
468 | this extension, replacing any previous hook. This is useful when you want |
|
|
469 | to overwrite time-critical hooks only temporarily. |
|
|
470 | |
|
|
471 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
472 | |
|
|
473 | Dynamically disable the given hooks. |
|
|
474 | |
|
|
475 | =back |
|
|
476 | |
110 | |
477 | =head2 Hooks |
111 | =head2 Hooks |
478 | |
112 | |
479 | 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 |
480 | called whenever the relevant event happens. |
114 | called whenever the relevant event happens. |
… | |
… | |
647 | |
281 | |
648 | =item on_refresh_end $term |
282 | =item on_refresh_end $term |
649 | |
283 | |
650 | 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>. |
651 | |
285 | |
652 | =item on_user_command $term, $string |
286 | =item on_user_command $term, $string *DEPRECATED* |
653 | |
287 | |
654 | 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 |
655 | 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> |
656 | resource in the @@RXVT_NAME@@(1) manpage). |
290 | resource in the urxvt(1) manpage). |
657 | |
291 | |
658 | 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 |
659 | slightly in the future. |
293 | preference to the C<< ->register_keysym_action >> method. |
|
|
294 | |
|
|
295 | =item on_register_command $term, $keysym, $modifiermask, $string |
|
|
296 | |
|
|
297 | Called after parsing a keysym resource but before registering the |
|
|
298 | associated binding. If this hook returns a true value the binding |
|
|
299 | is not registered. It can be used to modify a binding by calling |
|
|
300 | C<register_command>. |
660 | |
301 | |
661 | =item on_resize_all_windows $term, $new_width, $new_height |
302 | =item on_resize_all_windows $term, $new_width, $new_height |
662 | |
303 | |
663 | Called just after the new window size has been calculated, but before |
304 | Called just after the new window size has been calculated, but before |
664 | windows are actually being resized or hints are being set. If this hook |
305 | windows are actually being resized or hints are being set. If this hook |
665 | returns TRUE, setting of the window hints is being skipped. |
306 | returns a true value, setting of the window hints is being skipped. |
666 | |
307 | |
667 | =item on_x_event $term, $event |
308 | =item on_x_event $term, $event |
668 | |
309 | |
669 | Called on every X event received on the vt window (and possibly other |
310 | Called on every X event received on the vt window (and possibly other |
670 | windows). Should only be used as a last resort. Most event structure |
311 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
732 | =cut |
373 | =cut |
733 | |
374 | |
734 | package urxvt; |
375 | package urxvt; |
735 | |
376 | |
736 | use utf8; |
377 | use utf8; |
737 | use strict; |
378 | use strict 'vars'; |
738 | use Carp (); |
379 | use Carp (); |
739 | use Scalar::Util (); |
380 | use Scalar::Util (); |
740 | use List::Util (); |
381 | use List::Util (); |
741 | |
382 | |
742 | our $VERSION = 1; |
383 | our $VERSION = 1; |
743 | our $TERM; |
384 | our $TERM; |
744 | our @TERM_INIT; |
385 | our @TERM_INIT; # should go, prevents async I/O etc. |
745 | our @TERM_EXT; |
386 | our @TERM_EXT; # should go, prevents async I/O etc. |
746 | our @HOOKNAME; |
387 | our @HOOKNAME; |
747 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
388 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
748 | our %OPTION; |
389 | our %OPTION; |
749 | |
390 | |
750 | our $LIBDIR; |
391 | our $LIBDIR; |
… | |
… | |
798 | |
439 | |
799 | =over 4 |
440 | =over 4 |
800 | |
441 | |
801 | =item urxvt::fatal $errormessage |
442 | =item urxvt::fatal $errormessage |
802 | |
443 | |
803 | Fatally aborts execution with the given error message. Avoid at all |
444 | Fatally aborts execution with the given error message (which should |
804 | costs! The only time this is acceptable is when the terminal process |
445 | include a trailing newline). Avoid at all costs! The only time this |
805 | starts up. |
446 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
447 | terminal from starting up. |
806 | |
448 | |
807 | =item urxvt::warn $string |
449 | =item urxvt::warn $string |
808 | |
450 | |
809 | Calls C<rxvt_warn> with the given string which should not include a |
451 | Calls C<rxvt_warn> with the given string which should include a trailing |
810 | newline. The module also overwrites the C<warn> builtin with a function |
452 | newline. The module also overwrites the C<warn> builtin with a function |
811 | that calls this function. |
453 | that calls this function. |
812 | |
454 | |
813 | Using this function has the advantage that its output ends up in the |
455 | Using this function has the advantage that its output ends up in the |
814 | correct place, e.g. on stderr of the connecting urxvtc client. |
456 | correct place, e.g. on stderr of the connecting urxvtc client. |
… | |
… | |
818 | =item @terms = urxvt::termlist |
460 | =item @terms = urxvt::termlist |
819 | |
461 | |
820 | Returns all urxvt::term objects that exist in this process, regardless of |
462 | Returns all urxvt::term objects that exist in this process, regardless of |
821 | whether they are started, being destroyed etc., so be careful. Only term |
463 | whether they are started, being destroyed etc., so be careful. Only term |
822 | objects that have perl extensions attached will be returned (because there |
464 | objects that have perl extensions attached will be returned (because there |
823 | is no urxvt::term objet associated with others). |
465 | is no urxvt::term object associated with others). |
824 | |
466 | |
825 | =item $time = urxvt::NOW |
467 | =item $time = urxvt::NOW |
826 | |
468 | |
827 | Returns the "current time" (as per the event loop). |
469 | Returns the "current time" (as per the event loop). |
828 | |
470 | |
… | |
… | |
919 | }; |
561 | }; |
920 | } |
562 | } |
921 | |
563 | |
922 | no warnings 'utf8'; |
564 | no warnings 'utf8'; |
923 | |
565 | |
|
|
566 | sub parse_resource { |
|
|
567 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
|
|
568 | |
|
|
569 | $name =~ y/-/./ if $isarg; |
|
|
570 | |
|
|
571 | $term->scan_meta; |
|
|
572 | |
|
|
573 | my $r = $term->{meta}{resource}; |
|
|
574 | keys %$r; # reset iterator |
|
|
575 | while (my ($pattern, $v) = each %$r) { |
|
|
576 | if ( |
|
|
577 | $pattern =~ /\.$/ |
|
|
578 | ? $pattern eq substr $name, 0, length $pattern |
|
|
579 | : $pattern eq $name |
|
|
580 | ) { |
|
|
581 | $name = "$urxvt::RESCLASS.$name"; |
|
|
582 | |
|
|
583 | push @{ $term->{perl_ext_3} }, $v->[0]; |
|
|
584 | |
|
|
585 | if ($v->[1] eq "boolean") { |
|
|
586 | $term->put_option_db ($name, $flag ? "true" : "false"); |
|
|
587 | return 1; |
|
|
588 | } else { |
|
|
589 | $term->put_option_db ($name, $value); |
|
|
590 | return 1 + 2; |
|
|
591 | } |
|
|
592 | } |
|
|
593 | } |
|
|
594 | |
|
|
595 | 0 |
|
|
596 | } |
|
|
597 | |
|
|
598 | sub usage { |
|
|
599 | my ($term, $usage_type) = @_; |
|
|
600 | |
|
|
601 | $term->scan_meta; |
|
|
602 | |
|
|
603 | my $r = $term->{meta}{resource}; |
|
|
604 | |
|
|
605 | for my $pattern (sort keys %$r) { |
|
|
606 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
|
|
607 | |
|
|
608 | $desc .= " (-pe $ext)"; |
|
|
609 | |
|
|
610 | if ($usage_type == 1) { |
|
|
611 | $pattern =~ y/./-/; |
|
|
612 | $pattern =~ s/-$/-.../g; |
|
|
613 | |
|
|
614 | if ($type eq "boolean") { |
|
|
615 | urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc; |
|
|
616 | } else { |
|
|
617 | urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc; |
|
|
618 | } |
|
|
619 | } else { |
|
|
620 | $pattern =~ s/\.$/.*/g; |
|
|
621 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
|
|
622 | } |
|
|
623 | } |
|
|
624 | } |
|
|
625 | |
924 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
626 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
925 | |
627 | |
926 | sub verbose { |
628 | sub verbose { |
927 | my ($level, $msg) = @_; |
629 | my ($level, $msg) = @_; |
928 | warn "$msg\n" if $level <= $verbosity; |
630 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
940 | $pkg =~ s/[^[:word:]]/_/g; |
642 | $pkg =~ s/[^[:word:]]/_/g; |
941 | $pkg = "urxvt::ext::$pkg"; |
643 | $pkg = "urxvt::ext::$pkg"; |
942 | |
644 | |
943 | verbose 3, "loading extension '$path' into package '$pkg'"; |
645 | verbose 3, "loading extension '$path' into package '$pkg'"; |
944 | |
646 | |
|
|
647 | (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish |
|
|
648 | |
945 | open my $fh, "<:raw", $path |
649 | open my $fh, "<:raw", $path |
946 | or die "$path: $!"; |
650 | or die "$path: $!"; |
947 | |
651 | |
948 | my $source = |
652 | my $source = |
949 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
653 | "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n" |
950 | . "#line 1 \"$path\"\n{\n" |
654 | . "#line 1 \"$path\"\n{\n" |
951 | . (do { local $/; <$fh> }) |
655 | . (do { local $/; <$fh> }) |
952 | . "\n};\n1"; |
656 | . "\n};\n1"; |
953 | |
657 | |
954 | eval $source |
658 | eval $source |
… | |
… | |
964 | sub invoke { |
668 | sub invoke { |
965 | local $TERM = shift; |
669 | local $TERM = shift; |
966 | my $htype = shift; |
670 | my $htype = shift; |
967 | |
671 | |
968 | if ($htype == 0) { # INIT |
672 | if ($htype == 0) { # INIT |
969 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
673 | my @dirs = $TERM->perl_libdirs; |
970 | |
674 | |
971 | my %ext_arg; |
675 | my %ext_arg; |
972 | |
676 | |
973 | { |
677 | { |
974 | my @init = @TERM_INIT; |
678 | my @init = @TERM_INIT; |
… | |
… | |
977 | my @pkg = @TERM_EXT; |
681 | my @pkg = @TERM_EXT; |
978 | @TERM_EXT = (); |
682 | @TERM_EXT = (); |
979 | $TERM->register_package ($_) for @pkg; |
683 | $TERM->register_package ($_) for @pkg; |
980 | } |
684 | } |
981 | |
685 | |
|
|
686 | for ( |
|
|
687 | @{ delete $TERM->{perl_ext_3} }, |
982 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
688 | grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 |
|
|
689 | ) { |
983 | if ($_ eq "default") { |
690 | if ($_ eq "default") { |
984 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
691 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
985 | } elsif (/^-(.*)$/) { |
692 | } elsif (/^-(.*)$/) { |
986 | delete $ext_arg{$1}; |
693 | delete $ext_arg{$1}; |
987 | } elsif (/^([^<]+)<(.*)>$/) { |
694 | } elsif (/^([^<]+)<(.*)>$/) { |
… | |
… | |
1010 | if (my $cb = $TERM->{_hook}[$htype]) { |
717 | if (my $cb = $TERM->{_hook}[$htype]) { |
1011 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
718 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
1012 | if $verbosity >= 10; |
719 | if $verbosity >= 10; |
1013 | |
720 | |
1014 | for my $pkg (keys %$cb) { |
721 | for my $pkg (keys %$cb) { |
1015 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
722 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
1016 | $retval ||= $retval_; |
723 | $retval ||= $retval_; |
1017 | |
724 | |
1018 | if ($@) { |
725 | if ($@) { |
1019 | $TERM->ungrab; # better to lose the grab than the session |
726 | $TERM->ungrab; # better to lose the grab than the session |
1020 | warn $@; |
727 | warn $@; |
… | |
… | |
1063 | } |
770 | } |
1064 | } |
771 | } |
1065 | ($mask, @color{qw(fg bg)}, \@failed) |
772 | ($mask, @color{qw(fg bg)}, \@failed) |
1066 | } |
773 | } |
1067 | |
774 | |
1068 | # urxvt::term::extension |
|
|
1069 | |
|
|
1070 | package urxvt::term::extension; |
775 | package urxvt::term::extension; |
1071 | |
776 | |
1072 | sub enable { |
777 | =head2 The C<urxvt::term::extension> class |
1073 | my ($self, %hook) = @_; |
|
|
1074 | my $pkg = $self->{_pkg}; |
|
|
1075 | |
778 | |
1076 | while (my ($name, $cb) = each %hook) { |
779 | Each extension attached to a terminal object is represented by |
1077 | my $htype = $HOOKTYPE{uc $name}; |
780 | a C<urxvt::term::extension> object. |
1078 | defined $htype |
|
|
1079 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1080 | |
781 | |
1081 | $self->set_should_invoke ($htype, +1) |
782 | You can use these objects, which are passed to all callbacks to store any |
1082 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
783 | state related to the terminal and extension instance. |
1083 | |
784 | |
1084 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
785 | The methods (And data members) documented below can be called on extension |
1085 | } |
786 | objects, in addition to call methods documented for the <urxvt::term> |
1086 | } |
787 | class. |
1087 | |
788 | |
1088 | sub disable { |
789 | =over 4 |
1089 | my ($self, @hook) = @_; |
|
|
1090 | my $pkg = $self->{_pkg}; |
|
|
1091 | |
790 | |
1092 | for my $name (@hook) { |
791 | =item $urxvt_term = $self->{term} |
1093 | my $htype = $HOOKTYPE{uc $name}; |
|
|
1094 | defined $htype |
|
|
1095 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1096 | |
792 | |
1097 | $self->set_should_invoke ($htype, -1) |
793 | Returns the C<urxvt::term> object associated with this instance of the |
1098 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
794 | extension. This member I<must not> be changed in any way. |
1099 | } |
795 | |
1100 | } |
796 | =cut |
1101 | |
797 | |
1102 | our $AUTOLOAD; |
798 | our $AUTOLOAD; |
1103 | |
799 | |
1104 | sub AUTOLOAD { |
800 | sub AUTOLOAD { |
1105 | $AUTOLOAD =~ /:([^:]+)$/ |
801 | $AUTOLOAD =~ /:([^:]+)$/ |
… | |
… | |
1118 | |
814 | |
1119 | sub DESTROY { |
815 | sub DESTROY { |
1120 | # nop |
816 | # nop |
1121 | } |
817 | } |
1122 | |
818 | |
1123 | # urxvt::destroy_hook |
819 | # urxvt::destroy_hook (basically a cheap Guard:: implementation) |
1124 | |
820 | |
1125 | sub urxvt::destroy_hook::DESTROY { |
821 | sub urxvt::destroy_hook::DESTROY { |
1126 | ${$_[0]}->(); |
822 | ${$_[0]}->(); |
1127 | } |
823 | } |
1128 | |
824 | |
1129 | sub urxvt::destroy_hook(&) { |
825 | sub urxvt::destroy_hook(&) { |
1130 | bless \shift, urxvt::destroy_hook:: |
826 | bless \shift, urxvt::destroy_hook:: |
1131 | } |
827 | } |
|
|
828 | |
|
|
829 | =item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
830 | |
|
|
831 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
832 | this extension, replacing any hook previously installed via C<enable> in |
|
|
833 | this extension. |
|
|
834 | |
|
|
835 | This is useful when you want to overwrite time-critical hooks only |
|
|
836 | temporarily. |
|
|
837 | |
|
|
838 | To install additional callbacks for the same hook, you can use the C<on> |
|
|
839 | method of the C<urxvt::term> class. |
|
|
840 | |
|
|
841 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
842 | |
|
|
843 | Dynamically disable the given hooks. |
|
|
844 | |
|
|
845 | =cut |
|
|
846 | |
|
|
847 | sub enable { |
|
|
848 | my ($self, %hook) = @_; |
|
|
849 | my $pkg = $self->{_pkg}; |
|
|
850 | |
|
|
851 | while (my ($name, $cb) = each %hook) { |
|
|
852 | my $htype = $HOOKTYPE{uc $name}; |
|
|
853 | defined $htype |
|
|
854 | or Carp::croak "unsupported hook type '$name'"; |
|
|
855 | |
|
|
856 | $self->set_should_invoke ($htype, +1) |
|
|
857 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
|
|
858 | |
|
|
859 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
860 | } |
|
|
861 | } |
|
|
862 | |
|
|
863 | sub disable { |
|
|
864 | my ($self, @hook) = @_; |
|
|
865 | my $pkg = $self->{_pkg}; |
|
|
866 | |
|
|
867 | for my $name (@hook) { |
|
|
868 | my $htype = $HOOKTYPE{uc $name}; |
|
|
869 | defined $htype |
|
|
870 | or Carp::croak "unsupported hook type '$name'"; |
|
|
871 | |
|
|
872 | $self->set_should_invoke ($htype, -1) |
|
|
873 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
|
|
874 | } |
|
|
875 | } |
|
|
876 | |
|
|
877 | =item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
878 | |
|
|
879 | Similar to the C<enable> enable, but installs additional callbacks for |
|
|
880 | the given hook(s) (that is, it doesn't replace existing callbacks), and |
|
|
881 | returns a guard object. When the guard object is destroyed the callbacks |
|
|
882 | are disabled again. |
|
|
883 | |
|
|
884 | =cut |
|
|
885 | |
|
|
886 | sub urxvt::extension::on_disable::DESTROY { |
|
|
887 | my $disable = shift; |
|
|
888 | |
|
|
889 | my $term = delete $disable->{""}; |
|
|
890 | |
|
|
891 | while (my ($htype, $id) = each %$disable) { |
|
|
892 | delete $term->{_hook}[$htype]{$id}; |
|
|
893 | $term->set_should_invoke ($htype, -1); |
|
|
894 | } |
|
|
895 | } |
|
|
896 | |
|
|
897 | sub on { |
|
|
898 | my ($self, %hook) = @_; |
|
|
899 | |
|
|
900 | my $term = $self->{term}; |
|
|
901 | |
|
|
902 | my %disable = ( "" => $term ); |
|
|
903 | |
|
|
904 | while (my ($name, $cb) = each %hook) { |
|
|
905 | my $htype = $HOOKTYPE{uc $name}; |
|
|
906 | defined $htype |
|
|
907 | or Carp::croak "unsupported hook type '$name'"; |
|
|
908 | |
|
|
909 | $term->set_should_invoke ($htype, +1); |
|
|
910 | $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 } |
|
|
911 | = sub { shift; $cb->($self, @_) }; # very ugly indeed |
|
|
912 | } |
|
|
913 | |
|
|
914 | bless \%disable, "urxvt::extension::on_disable" |
|
|
915 | } |
|
|
916 | |
|
|
917 | =item $self->x_resource ($pattern) |
|
|
918 | |
|
|
919 | =item $self->x_resource_boolean ($pattern) |
|
|
920 | |
|
|
921 | These methods support an additional C<%> prefix when called on an |
|
|
922 | extension object - see the description of these methods in the |
|
|
923 | C<urxvt::term> class for details. |
|
|
924 | |
|
|
925 | =cut |
|
|
926 | |
|
|
927 | sub x_resource { |
|
|
928 | my ($self, $name) = @_; |
|
|
929 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
930 | $self->{term}->x_resource ($name) |
|
|
931 | } |
|
|
932 | |
|
|
933 | sub x_resource_boolean { |
|
|
934 | my ($self, $name) = @_; |
|
|
935 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
936 | $self->{term}->x_resource_boolean ($name) |
|
|
937 | } |
|
|
938 | |
|
|
939 | =back |
|
|
940 | |
|
|
941 | =cut |
1132 | |
942 | |
1133 | package urxvt::anyevent; |
943 | package urxvt::anyevent; |
1134 | |
944 | |
1135 | =head2 The C<urxvt::anyevent> Class |
945 | =head2 The C<urxvt::anyevent> Class |
1136 | |
946 | |
1137 | The sole purpose of this class is to deliver an interface to the |
947 | The sole purpose of this class is to deliver an interface to the |
1138 | C<AnyEvent> module - any module using it will work inside urxvt without |
948 | C<AnyEvent> module - any module using it will work inside urxvt without |
1139 | further programming. The only exception is that you cannot wait on |
949 | further programming. The only exception is that you cannot wait on |
1140 | condition variables, but non-blocking condvar use is ok. What this means |
950 | condition variables, but non-blocking condvar use is ok. |
1141 | is that you cannot use blocking APIs, but the non-blocking variant should |
951 | |
1142 | work. |
952 | In practical terms this means is that you cannot use blocking APIs, but |
|
|
953 | the non-blocking variant should work. |
1143 | |
954 | |
1144 | =cut |
955 | =cut |
1145 | |
956 | |
1146 | our $VERSION = '5.23'; |
957 | our $VERSION = '5.23'; |
1147 | |
958 | |
… | |
… | |
1206 | |
1017 | |
1207 | sub DESTROY { |
1018 | sub DESTROY { |
1208 | $_[0][1]->stop; |
1019 | $_[0][1]->stop; |
1209 | } |
1020 | } |
1210 | |
1021 | |
|
|
1022 | # only needed for AnyEvent < 6 compatibility |
1211 | sub one_event { |
1023 | sub one_event { |
1212 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1024 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1213 | } |
1025 | } |
1214 | |
1026 | |
1215 | package urxvt::term; |
1027 | package urxvt::term; |
… | |
… | |
1230 | urxvt::verbose 6, "register package $pkg to $self"; |
1042 | urxvt::verbose 6, "register package $pkg to $self"; |
1231 | |
1043 | |
1232 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
1044 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
1233 | |
1045 | |
1234 | my $proxy = bless { |
1046 | my $proxy = bless { |
1235 | _pkg => $pkg, |
1047 | _pkg => $pkg, |
|
|
1048 | _name => ${"$pkg\::_NAME"}, # hackish |
1236 | argv => $argv, |
1049 | argv => $argv, |
1237 | }, $pkg; |
1050 | }, $pkg; |
1238 | Scalar::Util::weaken ($proxy->{term} = $self); |
1051 | Scalar::Util::weaken ($proxy->{term} = $self); |
1239 | |
1052 | |
1240 | $self->{_pkg}{$pkg} = $proxy; |
1053 | $self->{_pkg}{$pkg} = $proxy; |
1241 | |
1054 | |
… | |
… | |
1244 | $proxy->enable ($name => $ref); |
1057 | $proxy->enable ($name => $ref); |
1245 | } |
1058 | } |
1246 | } |
1059 | } |
1247 | } |
1060 | } |
1248 | |
1061 | |
|
|
1062 | sub perl_libdirs { |
|
|
1063 | map { split /:/ } |
|
|
1064 | $_[0]->resource ("perl_lib"), |
|
|
1065 | $ENV{URXVT_PERL_LIB}, |
|
|
1066 | "$ENV{HOME}/.urxvt/ext", |
|
|
1067 | "$LIBDIR/perl" |
|
|
1068 | } |
|
|
1069 | |
|
|
1070 | sub scan_meta { |
|
|
1071 | my ($self) = @_; |
|
|
1072 | my @libdirs = perl_libdirs $self; |
|
|
1073 | |
|
|
1074 | return if $self->{meta_libdirs} eq join "\x00", @libdirs; |
|
|
1075 | |
|
|
1076 | my %meta; |
|
|
1077 | |
|
|
1078 | $self->{meta_libdirs} = join "\x00", @libdirs; |
|
|
1079 | $self->{meta} = \%meta; |
|
|
1080 | |
|
|
1081 | for my $dir (reverse @libdirs) { |
|
|
1082 | opendir my $fh, $dir |
|
|
1083 | or next; |
|
|
1084 | for my $ext (readdir $fh) { |
|
|
1085 | $ext !~ /^\./ |
|
|
1086 | and open my $fh, "<", "$dir/$ext" |
|
|
1087 | or next; |
|
|
1088 | |
|
|
1089 | while (<$fh>) { |
|
|
1090 | if (/^#:META:X_RESOURCE:(.*)/) { |
|
|
1091 | my ($pattern, $type, $desc) = split /:/, $1; |
|
|
1092 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
|
|
1093 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
|
|
1094 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
|
|
1095 | } else { |
|
|
1096 | $meta{resource}{$pattern} = [$ext, $type, $desc]; |
|
|
1097 | } |
|
|
1098 | } elsif (/^\s*(?:#|$)/) { |
|
|
1099 | # skip other comments and empty lines |
|
|
1100 | } else { |
|
|
1101 | last; # stop parsing on first non-empty non-comment line |
|
|
1102 | } |
|
|
1103 | } |
|
|
1104 | } |
|
|
1105 | } |
|
|
1106 | } |
|
|
1107 | |
1249 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1108 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1250 | |
1109 | |
1251 | Creates a new terminal, very similar as if you had started it with system |
1110 | Creates a new terminal, very similar as if you had started it with system |
1252 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
1111 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
1253 | hash which defines the environment of the new terminal. |
1112 | hash which defines the environment of the new terminal. |
… | |
… | |
1270 | } |
1129 | } |
1271 | |
1130 | |
1272 | =item $term->destroy |
1131 | =item $term->destroy |
1273 | |
1132 | |
1274 | Destroy the terminal object (close the window, free resources |
1133 | Destroy the terminal object (close the window, free resources |
1275 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1134 | etc.). Please note that urxvt will not exit as long as any event |
1276 | watchers (timers, io watchers) are still active. |
1135 | watchers (timers, io watchers) are still active. |
1277 | |
1136 | |
1278 | =item $term->exec_async ($cmd[, @args]) |
1137 | =item $term->exec_async ($cmd[, @args]) |
1279 | |
1138 | |
1280 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
1139 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
… | |
… | |
1307 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1166 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1308 | |
1167 | |
1309 | Here is a likely non-exhaustive list of option names, please see the |
1168 | Here is a likely non-exhaustive list of option names, please see the |
1310 | source file F</src/optinc.h> to see the actual list: |
1169 | source file F</src/optinc.h> to see the actual list: |
1311 | |
1170 | |
1312 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1171 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
1313 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1172 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1314 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1173 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1315 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
1174 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1316 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
1175 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1317 | transparent tripleclickwords utmpInhibit visualBell |
1176 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
|
|
1177 | urgentOnBell utmpInhibit visualBell |
1318 | |
1178 | |
1319 | =item $value = $term->resource ($name[, $newval]) |
1179 | =item $value = $term->resource ($name[, $newval]) |
1320 | |
1180 | |
1321 | Returns the current resource value associated with a given name and |
1181 | Returns the current resource value associated with a given name and |
1322 | optionally sets a new value. Setting values is most useful in the C<init> |
1182 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
1335 | |
1195 | |
1336 | Here is a likely non-exhaustive list of resource names, not all of which |
1196 | Here is a likely non-exhaustive list of resource names, not all of which |
1337 | are supported in every build, please see the source file F</src/rsinc.h> |
1197 | are supported in every build, please see the source file F</src/rsinc.h> |
1338 | to see the actual list: |
1198 | to see the actual list: |
1339 | |
1199 | |
1340 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1200 | answerbackstring backgroundPixmap backspace_key blurradius |
1341 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1201 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1342 | display_name embed ext_bwidth fade font geometry hold iconName |
1202 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1343 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1203 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
1344 | italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 |
1204 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
|
|
1205 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1345 | modifier mouseWheelScrollPage name override_redirect pastableTabs path |
1206 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1346 | perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1207 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1347 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1208 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1348 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1209 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1349 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1210 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1350 | secondaryScreen secondaryScroll shade term_name title |
1211 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1351 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1212 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1352 | visualBell |
1213 | utmpInhibit visualBell |
1353 | |
1214 | |
1354 | =cut |
1215 | =cut |
1355 | |
1216 | |
1356 | sub resource($$;$) { |
1217 | sub resource($$;$) { |
1357 | my ($self, $name) = (shift, shift); |
1218 | my ($self, $name) = (shift, shift); |
… | |
… | |
1364 | Returns the X-Resource for the given pattern, excluding the program or |
1225 | Returns the X-Resource for the given pattern, excluding the program or |
1365 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1226 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1366 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1227 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1367 | resource with that pattern exists. |
1228 | resource with that pattern exists. |
1368 | |
1229 | |
|
|
1230 | Extensions that define extra resource or command line arguments also need |
|
|
1231 | to call this method to access their values. |
|
|
1232 | |
|
|
1233 | If the method is called on an extension object (basically, from an |
|
|
1234 | extension), then the special prefix C<%.> will be replaced by the name of |
|
|
1235 | the extension and a dot, and the lone string C<%> will be replaced by the |
|
|
1236 | extension name itself. This makes it possible to code extensions so you |
|
|
1237 | can rename them and get a new set of commandline switches and resources |
|
|
1238 | without having to change the actual code. |
|
|
1239 | |
1369 | This method should only be called during the C<on_start> hook, as there is |
1240 | This method should only be called during the C<on_start> hook, as there is |
1370 | only one resource database per display, and later invocations might return |
1241 | only one resource database per display, and later invocations might return |
1371 | the wrong resources. |
1242 | the wrong resources. |
1372 | |
1243 | |
1373 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
1244 | =item $value = $term->x_resource_boolean ($pattern) |
1374 | |
1245 | |
|
|
1246 | Like C<x_resource>, above, but interprets the string value as a boolean |
|
|
1247 | and returns C<1> for true values, C<0> for false values and C<undef> if |
|
|
1248 | the resource or option isn't specified. |
|
|
1249 | |
|
|
1250 | You should always use this method to parse boolean resources. |
|
|
1251 | |
|
|
1252 | =cut |
|
|
1253 | |
|
|
1254 | sub x_resource_boolean { |
|
|
1255 | my $res = &x_resource; |
|
|
1256 | |
|
|
1257 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
|
|
1258 | } |
|
|
1259 | |
|
|
1260 | =item $success = $term->parse_keysym ($key, $octets) |
|
|
1261 | |
1375 | Adds a keymap translation exactly as specified via a resource. See the |
1262 | Adds a key binding exactly as specified via a resource. See the |
1376 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1263 | C<keysym> resource in the urxvt(1) manpage. |
|
|
1264 | |
|
|
1265 | =item $term->register_command ($keysym, $modifiermask, $string) |
|
|
1266 | |
|
|
1267 | Adds a key binding. This is a lower level api compared to |
|
|
1268 | C<parse_keysym>, as it expects a parsed key description, and can be |
|
|
1269 | used only inside either the C<on_init> hook, to add a binding, or the |
|
|
1270 | C<on_register_command> hook, to modify a parsed binding. |
1377 | |
1271 | |
1378 | =item $rend = $term->rstyle ([$new_rstyle]) |
1272 | =item $rend = $term->rstyle ([$new_rstyle]) |
1379 | |
1273 | |
1380 | Return and optionally change the current rendition. Text that is output by |
1274 | Return and optionally change the current rendition. Text that is output by |
1381 | the terminal application will use this style. |
1275 | the terminal application will use this style. |
… | |
… | |
1594 | |
1488 | |
1595 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1489 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1596 | to receive pointer events all the times: |
1490 | to receive pointer events all the times: |
1597 | |
1491 | |
1598 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1492 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1493 | |
|
|
1494 | =item $term->set_urgency ($set) |
|
|
1495 | |
|
|
1496 | Enable/disable the urgency hint on the toplevel window. |
1599 | |
1497 | |
1600 | =item $term->focus_in |
1498 | =item $term->focus_in |
1601 | |
1499 | |
1602 | =item $term->focus_out |
1500 | =item $term->focus_out |
1603 | |
1501 | |
… | |
… | |
1800 | } |
1698 | } |
1801 | |
1699 | |
1802 | sub urxvt::line::t { |
1700 | sub urxvt::line::t { |
1803 | my ($self) = @_; |
1701 | my ($self) = @_; |
1804 | |
1702 | |
1805 | if (@_ > 1) |
1703 | if (@_ > 1) { |
1806 | { |
|
|
1807 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1704 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1808 | for $self->{beg} .. $self->{end}; |
1705 | for $self->{beg} .. $self->{end}; |
1809 | } |
1706 | } |
1810 | |
1707 | |
1811 | defined wantarray && |
1708 | defined wantarray && |
1812 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1709 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1813 | 0, $self->{len} |
1710 | 0, $self->{len} |
1814 | } |
1711 | } |
1815 | |
1712 | |
1816 | sub urxvt::line::r { |
1713 | sub urxvt::line::r { |
1817 | my ($self) = @_; |
1714 | my ($self) = @_; |
1818 | |
1715 | |
1819 | if (@_ > 1) |
1716 | if (@_ > 1) { |
1820 | { |
|
|
1821 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1717 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1822 | for $self->{beg} .. $self->{end}; |
1718 | for $self->{beg} .. $self->{end}; |
1823 | } |
1719 | } |
1824 | |
1720 | |
1825 | if (defined wantarray) { |
1721 | if (defined wantarray) { |
1826 | my $rend = [ |
1722 | my $rend = [ |
1827 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1723 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1828 | ]; |
1724 | ]; |
… | |
… | |
1919 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
1815 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
1920 | |
1816 | |
1921 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1817 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1922 | |
1818 | |
1923 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1819 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1820 | |
|
|
1821 | =item $keysym = $term->XStringToKeysym ($string) |
|
|
1822 | |
|
|
1823 | =item $string = $term->XKeysymToString ($keysym) |
1924 | |
1824 | |
1925 | Various X or X-related functions. The C<$term> object only serves as |
1825 | Various X or X-related functions. The C<$term> object only serves as |
1926 | the source of the display, otherwise those functions map more-or-less |
1826 | the source of the display, otherwise those functions map more-or-less |
1927 | directly onto the X functions of the same name. |
1827 | directly onto the X functions of the same name. |
1928 | |
1828 | |
… | |
… | |
2250 | |
2150 | |
2251 | =back |
2151 | =back |
2252 | |
2152 | |
2253 | =head1 AUTHOR |
2153 | =head1 AUTHOR |
2254 | |
2154 | |
2255 | Marc Lehmann <pcg@goof.com> |
2155 | Marc Lehmann <schmorp@schmorp.de> |
2256 | http://software.schmorp.de/pkg/rxvt-unicode |
2156 | http://software.schmorp.de/pkg/rxvt-unicode |
2257 | |
2157 | |
2258 | =cut |
2158 | =cut |
2259 | |
2159 | |
2260 | 1 |
2160 | 1 |