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 some directory: |
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 instance using it: |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | urxvt --perl-lib path/to/somedirectory -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 qw(vars subs)' and 'use utf8' |
26 | thus must be encoded as UTF-8. |
26 | environment, and 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 using so called META comments, |
50 | |
51 | described below. Similarly to builtin resources, extension resources |
51 | (More) intelligent selection. This extension tries to be more intelligent |
52 | can also be specified on the command line as long options (with C<.> |
52 | when the user extends selections (double-click and further clicks). Right |
53 | replaced by C<->), in which case the corresponding extension is loaded |
53 | now, it tries to select words, urls and complete shell-quoted |
54 | automatically. For this to work the extension B<must> define META |
54 | arguments, which is very convenient, too, if your F<ls> supports |
55 | comments for its resources. |
55 | C<--quoting-style=shell>. |
|
|
56 | |
|
|
57 | A double-click usually selects the word under the cursor, further clicks |
|
|
58 | will enlarge the selection. |
|
|
59 | |
|
|
60 | The selection works by trying to match a number of regexes and displaying |
|
|
61 | them in increasing order of length. You can add your own regexes by |
|
|
62 | specifying resources of the form: |
|
|
63 | |
|
|
64 | URxvt.selection.pattern-0: perl-regex |
|
|
65 | URxvt.selection.pattern-1: perl-regex |
|
|
66 | ... |
|
|
67 | |
|
|
68 | The index number (0, 1...) must not have any holes, and each regex must |
|
|
69 | contain at least one pair of capturing parentheses, which will be used for |
|
|
70 | the match. For example, the following adds a regex that matches everything |
|
|
71 | between two vertical bars: |
|
|
72 | |
|
|
73 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
74 | |
|
|
75 | Another example: Programs I use often output "absolute path: " at the |
|
|
76 | beginning of a line when they process multiple files. The following |
|
|
77 | pattern matches the filename (note, there is a single space at the very |
|
|
78 | end): |
|
|
79 | |
|
|
80 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
|
|
81 | |
|
|
82 | You can look at the source of the selection extension to see more |
|
|
83 | interesting uses, such as parsing a line from beginning to end. |
|
|
84 | |
|
|
85 | This extension also offers following bindable keyboard commands: |
|
|
86 | |
|
|
87 | =over 4 |
|
|
88 | |
|
|
89 | =item rot13 |
|
|
90 | |
|
|
91 | Rot-13 the selection when activated. Used via keyboard trigger: |
|
|
92 | |
|
|
93 | URxvt.keysym.C-M-r: perl:selection:rot13 |
|
|
94 | |
|
|
95 | =back |
|
|
96 | |
|
|
97 | =item option-popup (enabled by default) |
|
|
98 | |
|
|
99 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
|
|
100 | runtime. |
|
|
101 | |
|
|
102 | Other extensions can extend this popup menu by pushing a code reference |
|
|
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
104 | popup is being displayed. |
|
|
105 | |
|
|
106 | Its sole argument is the popup menu, which can be modified. It should |
|
|
107 | either return nothing or a string, the initial boolean value and a code |
|
|
108 | reference. The string will be used as button text and the code reference |
|
|
109 | will be called when the toggle changes, with the new boolean value as |
|
|
110 | first argument. |
|
|
111 | |
|
|
112 | The following will add an entry C<myoption> that changes |
|
|
113 | C<$self->{myoption}>: |
|
|
114 | |
|
|
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
117 | }; |
|
|
118 | |
|
|
119 | =item selection-popup (enabled by default) |
|
|
120 | |
|
|
121 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
122 | text into various other formats/action (such as uri unescaping, perl |
|
|
123 | evaluation, web-browser starting etc.), depending on content. |
|
|
124 | |
|
|
125 | Other extensions can extend this popup menu by pushing a code reference |
|
|
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
|
|
127 | popup is being displayed. |
|
|
128 | |
|
|
129 | Its sole argument is the popup menu, which can be modified. The selection |
|
|
130 | is in C<$_>, which can be used to decide whether to add something or not. |
|
|
131 | It should either return nothing or a string and a code reference. The |
|
|
132 | string will be used as button text and the code reference will be called |
|
|
133 | when the button gets activated and should transform C<$_>. |
|
|
134 | |
|
|
135 | The following will add an entry C<a to b> that transforms all C<a>s in |
|
|
136 | the selection to C<b>s, but only if the selection currently contains any |
|
|
137 | C<a>s: |
|
|
138 | |
|
|
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
140 | /a/ ? ("a to b" => sub { s/a/b/g } |
|
|
141 | : () |
|
|
142 | }; |
|
|
143 | |
|
|
144 | =item searchable-scrollback<hotkey> (enabled by default) |
|
|
145 | |
|
|
146 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
147 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
|
|
148 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
149 | screen. |
|
|
150 | |
|
|
151 | Inputting characters appends them to the regex and continues incremental |
|
|
152 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
|
|
153 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
|
|
154 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
155 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
156 | additionally stores the first match in the current line into the primary |
|
|
157 | selection if the C<Shift> modifier is active. |
|
|
158 | |
|
|
159 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
|
|
160 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
|
|
161 | or simply use an uppercase character which removes the "(?i)" prefix. |
|
|
162 | |
|
|
163 | See L<perlre> for more info about perl regular expression syntax. |
|
|
164 | |
|
|
165 | =item readline (enabled by default) |
|
|
166 | |
|
|
167 | A support package that tries to make editing with readline easier. At |
|
|
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
|
|
169 | move the text cursor to this position. It does so by generating as many |
|
|
170 | cursor-left or cursor-right keypresses as required (this only works |
|
|
171 | for programs that correctly support wide characters). |
|
|
172 | |
|
|
173 | To avoid too many false positives, this is only done when: |
|
|
174 | |
|
|
175 | =over 4 |
|
|
176 | |
|
|
177 | =item - the tty is in ICANON state. |
|
|
178 | |
|
|
179 | =item - the text cursor is visible. |
|
|
180 | |
|
|
181 | =item - the primary screen is currently being displayed. |
|
|
182 | |
|
|
183 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
184 | |
|
|
185 | =back |
|
|
186 | |
|
|
187 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
188 | might interfere with selection creation in harmless ways. |
|
|
189 | |
|
|
190 | =item selection-autotransform |
|
|
191 | |
|
|
192 | This selection allows you to do automatic transforms on a selection |
|
|
193 | whenever a selection is made. |
|
|
194 | |
|
|
195 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
196 | operator) that modify C<$_> as resources: |
|
|
197 | |
|
|
198 | URxvt.selection-autotransform.0: transform |
|
|
199 | URxvt.selection-autotransform.1: transform |
|
|
200 | ... |
|
|
201 | |
|
|
202 | For example, the following will transform selections of the form |
|
|
203 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
204 | $word>: |
|
|
205 | |
|
|
206 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
207 | |
|
|
208 | And this example matches the same,but replaces it with vi-commands you can |
|
|
209 | paste directly into your (vi :) editor: |
|
|
210 | |
|
|
211 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
212 | |
|
|
213 | Of course, this can be modified to suit your needs and your editor :) |
|
|
214 | |
|
|
215 | To expand the example above to typical perl error messages ("XXX at |
|
|
216 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
217 | |
|
|
218 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
219 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
220 | |
|
|
221 | The first line tells the selection code to treat the unchanging part of |
|
|
222 | every error message as a selection pattern, and the second line transforms |
|
|
223 | the message into vi commands to load the file. |
|
|
224 | |
|
|
225 | =item tabbed |
|
|
226 | |
|
|
227 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
228 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
|
|
229 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
230 | button per tab. |
|
|
231 | |
|
|
232 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
233 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
234 | while B<Shift-Down> creates a new tab. |
|
|
235 | |
|
|
236 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
237 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
238 | following four resources (shown with defaults): |
|
|
239 | |
|
|
240 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
241 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
242 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
243 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
244 | |
|
|
245 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
246 | indices. |
|
|
247 | |
|
|
248 | =item matcher |
|
|
249 | |
|
|
250 | Uses per-line display filtering (C<on_line_update>) to underline text |
|
|
251 | matching a certain pattern and make it clickable. When clicked with the |
|
|
252 | mouse button specified in the C<matcher.button> resource (default 2, or |
|
|
253 | middle), the program specified in the C<matcher.launcher> resource |
|
|
254 | (default, the C<urlLauncher> resource, C<sensible-browser>) will be started |
|
|
255 | with the matched text as first argument. The default configuration is |
|
|
256 | suitable for matching URLs and launching a web browser, like the |
|
|
257 | former "mark-urls" extension. |
|
|
258 | |
|
|
259 | The default pattern to match URLs can be overridden with the |
|
|
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
|
|
261 | with numbered patterns, in a manner similar to the "selection" extension. |
|
|
262 | The launcher can also be overridden on a per-pattern basis. |
|
|
263 | |
|
|
264 | It is possible to activate the most recently seen match from the keyboard. |
|
|
265 | Simply bind a keysym to "perl:matcher" as seen in the example below. |
|
|
266 | |
|
|
267 | Example configuration: |
|
|
268 | |
|
|
269 | URxvt.perl-ext: default,matcher |
|
|
270 | URxvt.urlLauncher: sensible-browser |
|
|
271 | URxvt.keysym.C-Delete: perl:matcher |
|
|
272 | URxvt.matcher.button: 1 |
|
|
273 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
274 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
275 | URxvt.matcher.launcher.2: gvim +$2 $1 |
|
|
276 | |
|
|
277 | =item xim-onthespot |
|
|
278 | |
|
|
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
280 | not work perfectly, and some input methods don't seem to work well with |
|
|
281 | OnTheSpot editing in general, but it seems to work at least for SCIM and |
|
|
282 | kinput2. |
|
|
283 | |
|
|
284 | You enable it by specifying this extension and a preedit style of |
|
|
285 | C<OnTheSpot>, i.e.: |
|
|
286 | |
|
|
287 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
288 | |
|
|
289 | =item kuake<hotkey> |
|
|
290 | |
|
|
291 | A very primitive quake-console-like extension. It was inspired by a |
|
|
292 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
293 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
294 | will show or hide itself. Another press of the accelerator key will hide |
|
|
295 | or show it again. |
|
|
296 | |
|
|
297 | Initially, the window will not be shown when using this extension. |
|
|
298 | |
|
|
299 | This is useful if you need a single terminal that is not using any desktop |
|
|
300 | space most of the time but is quickly available at the press of a key. |
|
|
301 | |
|
|
302 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
303 | extension will actually grab a physical key just for this function. |
|
|
304 | |
|
|
305 | If you want a quake-like animation, tell your window manager to do so |
|
|
306 | (fvwm can do it). |
|
|
307 | |
|
|
308 | =item block-graphics-to-ascii |
|
|
309 | |
|
|
310 | A not very useful example of filtering all text output to the terminal |
|
|
311 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
312 | similar-looking ascii character. |
|
|
313 | |
|
|
314 | =item digital-clock |
|
|
315 | |
|
|
316 | Displays a digital clock using the built-in overlay. |
|
|
317 | |
|
|
318 | =item remote-clipboard |
|
|
319 | |
|
|
320 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
321 | selection popup that allows one to run external commands to store the |
|
|
322 | selection somewhere and fetch it again. |
|
|
323 | |
|
|
324 | We use it to implement a "distributed selection mechanism", which just |
|
|
325 | means that one command uploads the file to a remote server, and another |
|
|
326 | reads it. |
|
|
327 | |
|
|
328 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
329 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
330 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
331 | the selection data on STDOUT (also in UTF-8). |
|
|
332 | |
|
|
333 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
334 | |
|
|
335 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
336 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
|
|
337 | |
|
|
338 | =item selection-pastebin |
|
|
339 | |
|
|
340 | This is a little rarely useful extension that Uploads the selection as |
|
|
341 | textfile to a remote site (or does other things). (The implementation is |
|
|
342 | not currently secure for use in a multiuser environment as it writes to |
|
|
343 | F</tmp> directly.). |
|
|
344 | |
|
|
345 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
346 | i.e. |
|
|
347 | |
|
|
348 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
349 | |
|
|
350 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
351 | the textfile. This command can be set via a resource: |
|
|
352 | |
|
|
353 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
354 | |
|
|
355 | And the default is likely not useful to anybody but the few people around |
|
|
356 | here :) |
|
|
357 | |
|
|
358 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
359 | the same content should lead to the same filename. |
|
|
360 | |
|
|
361 | After a successful upload the selection will be replaced by the text given |
|
|
362 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
363 | for the filename): |
|
|
364 | |
|
|
365 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
366 | |
|
|
367 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
368 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
369 | which works regardless of wether xrdb is used to parse the resource file |
|
|
370 | or not. |
|
|
371 | |
|
|
372 | =item example-refresh-hooks |
|
|
373 | |
|
|
374 | Displays a very simple digital clock in the upper right corner of the |
|
|
375 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
376 | overlays or changes. |
|
|
377 | |
|
|
378 | =back |
|
|
379 | |
56 | |
380 | =head1 API DOCUMENTATION |
57 | =head1 API DOCUMENTATION |
381 | |
58 | |
382 | =head2 General API Considerations |
59 | =head2 General API Considerations |
383 | |
60 | |
… | |
… | |
393 | terminal is destroyed. |
70 | terminal is destroyed. |
394 | |
71 | |
395 | Argument names also often indicate the type of a parameter. Here are some |
72 | Argument names also often indicate the type of a parameter. Here are some |
396 | hints on what they mean: |
73 | hints on what they mean: |
397 | |
74 | |
398 | =over 4 |
75 | =over |
399 | |
76 | |
400 | =item $text |
77 | =item $text |
401 | |
78 | |
402 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
79 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
403 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
80 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
404 | |
81 | |
405 | =item $string |
82 | =item $string |
406 | |
83 | |
407 | A perl text string, with an emphasis on I<text>. It can store all unicode |
84 | A perl text string, with an emphasis on I<text>. It can store all unicode |
… | |
… | |
411 | =item $octets |
88 | =item $octets |
412 | |
89 | |
413 | Either binary data or - more common - a text string encoded in a |
90 | Either binary data or - more common - a text string encoded in a |
414 | locale-specific way. |
91 | locale-specific way. |
415 | |
92 | |
|
|
93 | =item $keysym |
|
|
94 | |
|
|
95 | an integer that is a valid X11 keysym code. You can convert a string |
|
|
96 | into a keysym and viceversa by using C<XStringToKeysym> and |
|
|
97 | C<XKeysymToString>. |
|
|
98 | |
416 | =back |
99 | =back |
417 | |
100 | |
418 | =head2 Extension Objects |
101 | =head2 Extension Objects |
419 | |
102 | |
420 | Every perl extension is a perl class. A separate perl object is created |
103 | Every perl extension is a perl class. A separate perl object is created |
421 | for each terminal, and each terminal has its own set of extenion objects, |
104 | for each terminal, and each terminal has its own set of extension objects, |
422 | which are passed as the first parameter to hooks. So extensions can use |
105 | which are passed as the first parameter to hooks. So extensions can use |
423 | their C<$self> object without having to think about clashes with other |
106 | their C<$self> object without having to think about clashes with other |
424 | extensions or other terminals, with the exception of methods and members |
107 | extensions or other terminals, with the exception of methods and members |
425 | that begin with an underscore character C<_>: these are reserved for |
108 | that begin with an underscore character C<_>: these are reserved for |
426 | internal use. |
109 | internal use. |
427 | |
110 | |
428 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
111 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
429 | C<urxvt::term> class on this object. |
112 | C<urxvt::term> class on this object. |
430 | |
113 | |
431 | It has the following methods and data members: |
114 | Additional methods only supported for extension objects are described in |
|
|
115 | the C<urxvt::extension> section below. |
432 | |
116 | |
|
|
117 | =head2 META comments |
|
|
118 | |
|
|
119 | Rxvt-unicode recognizes special meta comments in extensions that define |
|
|
120 | different types of metadata. These comments are scanned whenever a |
|
|
121 | terminal is created and are typically used to autoload extensions when |
|
|
122 | their resources or command line parameters are used. |
|
|
123 | |
|
|
124 | Currently, it recognises these comments below. Individual components are |
|
|
125 | separated by colons (C<:>), and should not contain colons themselves - |
|
|
126 | there is also currently no escaping mechanism provided for this. |
|
|
127 | |
433 | =over 4 |
128 | =over |
434 | |
129 | |
435 | =item $urxvt_term = $self->{term} |
130 | =item #:META:RESOURCE:name:type:desc |
436 | |
131 | |
437 | Returns the C<urxvt::term> object associated with this instance of the |
132 | The RESOURCE comment defines a resource used by the extension, where |
438 | extension. This member I<must not> be changed in any way. |
133 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
|
|
134 | or C<string>, and C<desc> is the resource description. |
439 | |
135 | |
440 | =item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
136 | The extension will be autoloaded when this resource is specified or used |
|
|
137 | as a command line parameter. |
441 | |
138 | |
442 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
139 | Example: matcher provides the C<matcher.launcher> resource by having this |
443 | this extension, replacing any previous hook. This is useful when you want |
140 | comment: |
444 | to overwrite time-critical hooks only temporarily. |
|
|
445 | |
141 | |
446 | =item $self->disable ($hook_name[, $hook_name..]) |
142 | #:META:RESOURCE:%.launcher:string:default launcher command |
447 | |
143 | |
448 | Dynamically disable the given hooks. |
144 | Example: load this extension when the C<-tr> command line option or |
|
|
145 | resource name is used. |
|
|
146 | |
|
|
147 | #:META:RESOURCE:tr:boolean:set root pixmap as background |
|
|
148 | |
|
|
149 | =item #:META:OSC:number:desc |
|
|
150 | |
|
|
151 | The OSC comment specifies an OSC sequence, where C<number> is the |
|
|
152 | numerical OSC code and C<desc> is a short description that is currently |
|
|
153 | unused. |
|
|
154 | |
|
|
155 | This will cause the extension to be autoloaded when the OSC sequence is |
|
|
156 | used for the first time. |
|
|
157 | |
|
|
158 | Note that autoloading carries some extra responsibilities with it: |
|
|
159 | although the terminal cannot really protect itself against malicious |
|
|
160 | sources of command sequences, therefore relying on the programs running |
|
|
161 | I<inside> to sanitize data that they output, it is very common for |
|
|
162 | programs to emit command sequences from untrusted sources. |
|
|
163 | |
|
|
164 | While this means that extensions should, as a defense-in-depth mechanism, |
|
|
165 | always consider whether OSC sequences are safe, autoloading automatically |
|
|
166 | exposes any autoloaded extension in all terminal windows, so extra care |
|
|
167 | should be taken. |
|
|
168 | |
|
|
169 | Example: the background extension registers OSC C<20> like this: |
|
|
170 | |
|
|
171 | #:META:OSC:20:change/query background image |
|
|
172 | |
|
|
173 | =item #:META:OSC_PERL:prefix:desc |
|
|
174 | |
|
|
175 | The same as the OSC comment, but for the Perl OSC sequence (C<777>). The |
|
|
176 | C<prefix> should be unique among extensions, of course, which is most |
|
|
177 | easily arranged by using the extension name, although this is not |
|
|
178 | required. |
|
|
179 | |
|
|
180 | Example: the overlay-osc extension registers its Perl OSC like this: |
|
|
181 | |
|
|
182 | #:META:OSC_PERL:overlay:man overlay-osc |
449 | |
183 | |
450 | =back |
184 | =back |
451 | |
185 | |
452 | =head2 Hooks |
186 | =head2 Hooks |
453 | |
187 | |
… | |
… | |
461 | hooks returns true, then the event counts as being I<consumed>, and the |
195 | hooks returns true, then the event counts as being I<consumed>, and the |
462 | relevant action might not be carried out by the C++ code. |
196 | relevant action might not be carried out by the C++ code. |
463 | |
197 | |
464 | I<< When in doubt, return a false value (preferably C<()>). >> |
198 | I<< When in doubt, return a false value (preferably C<()>). >> |
465 | |
199 | |
466 | =over 4 |
200 | =over |
467 | |
201 | |
468 | =item on_init $term |
202 | =item on_init $term |
469 | |
203 | |
470 | Called after a new terminal object has been initialized, but before |
204 | Called after a new terminal object has been initialized, but before |
471 | windows are created or the command gets run. Most methods are unsafe to |
205 | windows are created or the command gets run. Most methods are unsafe to |
… | |
… | |
541 | |
275 | |
542 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
276 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
543 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
277 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
544 | number of lines that will be in the scrollback buffer. |
278 | number of lines that will be in the scrollback buffer. |
545 | |
279 | |
546 | =item on_osc_seq $term, $op, $args |
280 | =item on_osc_seq $term, $op, $args, $resp |
547 | |
281 | |
548 | Called on every OSC sequence and can be used to suppress it or modify its |
282 | Called on every OSC sequence and can be used to suppress it or modify its |
549 | behaviour. The default should be to return an empty list. A true value |
283 | behaviour. The default should be to return an empty list. A true value |
550 | suppresses execution of the request completely. Make sure you don't get |
284 | suppresses execution of the request completely. Make sure you don't get |
551 | confused by recursive invocations when you output an osc sequence within |
285 | confused by recursive invocations when you output an OSC sequence within |
552 | this callback. |
286 | this callback. |
553 | |
287 | |
554 | C<on_osc_seq_perl> should be used for new behaviour. |
288 | C<on_osc_seq_perl> should be used for new behaviour. |
555 | |
289 | |
556 | =item on_osc_seq_perl $term, $string |
290 | =item on_osc_seq_perl $term, $args, $resp |
557 | |
291 | |
558 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
292 | Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence |
559 | operating system command) is processed. Cursor position and other state |
293 | (OSC = operating system command) is processed. Cursor position and other |
560 | information is up-to-date when this happens. For interoperability, the |
294 | state information is up-to-date when this happens. For interoperability, |
561 | string should start with the extension name and a colon, to distinguish |
295 | the argument should start with the extension name (sans -osc) or some |
562 | it from commands for other extensions, and this might be enforced in the |
296 | other suitable prefix, and a semicolon, to distinguish it from commands |
563 | future. |
297 | for other extensions. |
|
|
298 | |
|
|
299 | For example, C<overlay-osc> uses this: |
|
|
300 | |
|
|
301 | sub on_osc_seq_perl { |
|
|
302 | my ($self, $osc, $resp) = @_; |
|
|
303 | |
|
|
304 | return unless $osc =~ s/^overlay;//; |
|
|
305 | |
|
|
306 | ... process remaining $osc string |
|
|
307 | } |
564 | |
308 | |
565 | Be careful not ever to trust (in a security sense) the data you receive, |
309 | Be careful not ever to trust (in a security sense) the data you receive, |
566 | as its source can not easily be controlled (e-mail content, messages from |
310 | as its source can not easily be controlled (e-mail content, messages from |
567 | other users on the same system etc.). |
311 | other users on the same system etc.). |
|
|
312 | |
|
|
313 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
314 | sender. |
568 | |
315 | |
569 | =item on_add_lines $term, $string |
316 | =item on_add_lines $term, $string |
570 | |
317 | |
571 | Called whenever text is about to be output, with the text as argument. You |
318 | Called whenever text is about to be output, with the text as argument. You |
572 | can filter/change and output the text yourself by returning a true value |
319 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
577 | =item on_tt_write $term, $octets |
324 | =item on_tt_write $term, $octets |
578 | |
325 | |
579 | Called whenever some data is written to the tty/pty and can be used to |
326 | Called whenever some data is written to the tty/pty and can be used to |
580 | suppress or filter tty input. |
327 | suppress or filter tty input. |
581 | |
328 | |
|
|
329 | =item on_tt_paste $term, $octets |
|
|
330 | |
|
|
331 | Called whenever text is about to be pasted, with the text as argument. You |
|
|
332 | can filter/change and paste the text yourself by returning a true value |
|
|
333 | and calling C<< $term->tt_paste >> yourself. C<$octets> is |
|
|
334 | locale-encoded. |
|
|
335 | |
582 | =item on_line_update $term, $row |
336 | =item on_line_update $term, $row |
583 | |
337 | |
584 | Called whenever a line was updated or changed. Can be used to filter |
338 | Called whenever a line was updated or changed. Can be used to filter |
585 | screen output (e.g. underline urls or other useless stuff). Only lines |
339 | screen output (e.g. underline urls or other useless stuff). Only lines |
586 | that are being shown will be filtered, and, due to performance reasons, |
340 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
593 | later with the already-modified line (e.g. if unrelated parts change), so |
347 | later with the already-modified line (e.g. if unrelated parts change), so |
594 | you cannot just toggle rendition bits, but only set them. |
348 | you cannot just toggle rendition bits, but only set them. |
595 | |
349 | |
596 | =item on_refresh_begin $term |
350 | =item on_refresh_begin $term |
597 | |
351 | |
598 | Called just before the screen gets redrawn. Can be used for overlay |
352 | Called just before the screen gets redrawn. Can be used for overlay or |
599 | or similar effects by modify terminal contents in refresh_begin, and |
353 | similar effects by modifying the terminal contents in refresh_begin, and |
600 | restoring them in refresh_end. The built-in overlay and selection display |
354 | restoring them in refresh_end. The built-in overlay and selection display |
601 | code is run after this hook, and takes precedence. |
355 | code is run after this hook, and takes precedence. |
602 | |
356 | |
603 | =item on_refresh_end $term |
357 | =item on_refresh_end $term |
604 | |
358 | |
605 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
359 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
606 | |
360 | |
|
|
361 | =item on_action $term, $string |
|
|
362 | |
|
|
363 | Called whenever an action is invoked for the corresponding extension |
|
|
364 | (e.g. via a C<extension:string> builtin action bound to a key, see |
|
|
365 | description of the B<keysym> resource in the urxvt(1) manpage). The |
|
|
366 | event is simply the action string. Note that an action event is always |
|
|
367 | associated to a single extension. |
|
|
368 | |
607 | =item on_user_command $term, $string |
369 | =item on_user_command $term, $string *DEPRECATED* |
608 | |
370 | |
609 | Called whenever a user-configured event is being activated (e.g. via |
371 | Called whenever a user-configured event is being activated (e.g. via |
610 | a C<perl:string> action bound to a key, see description of the B<keysym> |
372 | a C<perl:string> action bound to a key, see description of the B<keysym> |
611 | resource in the @@RXVT_NAME@@(1) manpage). |
373 | resource in the urxvt(1) manpage). |
612 | |
374 | |
613 | The event is simply the action string. This interface is assumed to change |
375 | The event is simply the action string. This interface is going away in |
614 | slightly in the future. |
376 | preference to the C<on_action> hook. |
615 | |
377 | |
616 | =item on_resize_all_windows $tern, $new_width, $new_height |
378 | =item on_resize_all_windows $term, $new_width, $new_height |
617 | |
379 | |
618 | Called just after the new window size has been calculated, but before |
380 | Called just after the new window size has been calculated, but before |
619 | windows are actually being resized or hints are being set. If this hook |
381 | windows are actually being resized or hints are being set. If this hook |
620 | returns TRUE, setting of the window hints is being skipped. |
382 | returns a true value, setting of the window hints is being skipped. |
621 | |
383 | |
622 | =item on_x_event $term, $event |
384 | =item on_x_event $term, $event |
623 | |
385 | |
624 | Called on every X event received on the vt window (and possibly other |
386 | Called on every X event received on the vt window (and possibly other |
625 | windows). Should only be used as a last resort. Most event structure |
387 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
655 | |
417 | |
656 | =item on_map_notify $term, $event |
418 | =item on_map_notify $term, $event |
657 | |
419 | |
658 | =item on_unmap_notify $term, $event |
420 | =item on_unmap_notify $term, $event |
659 | |
421 | |
660 | Called whenever the corresponding X event is received for the terminal If |
422 | Called whenever the corresponding X event is received for the terminal. If |
661 | the hook returns true, then the even will be ignored by rxvt-unicode. |
423 | the hook returns true, then the event will be ignored by rxvt-unicode. |
662 | |
424 | |
663 | The event is a hash with most values as named by Xlib (see the XEvent |
425 | The event is a hash with most values as named by Xlib (see the XEvent |
664 | manpage), with the additional members C<row> and C<col>, which are the |
426 | manpage), with the additional members C<row> and C<col>, which are the |
665 | (real, not screen-based) row and column under the mouse cursor. |
427 | (real, not screen-based) row and column under the mouse cursor. |
666 | |
428 | |
667 | C<on_key_press> additionally receives the string rxvt-unicode would |
429 | C<on_key_press> additionally receives the string rxvt-unicode would |
668 | output, if any, in locale-specific encoding. |
430 | output, if any, in locale-specific encoding. |
669 | |
431 | |
670 | subwindow. |
|
|
671 | |
|
|
672 | =item on_client_message $term, $event |
432 | =item on_client_message $term, $event |
673 | |
433 | |
674 | =item on_wm_protocols $term, $event |
434 | =item on_wm_protocols $term, $event |
675 | |
435 | |
676 | =item on_wm_delete_window $term, $event |
436 | =item on_wm_delete_window $term, $event |
677 | |
437 | |
678 | Called when various types of ClientMessage events are received (all with |
438 | Called when various types of ClientMessage events are received (all with |
679 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
439 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
680 | |
440 | |
|
|
441 | =item on_bell $term |
|
|
442 | |
|
|
443 | Called on receipt of a bell character. |
|
|
444 | |
681 | =back |
445 | =back |
682 | |
446 | |
683 | =cut |
447 | =cut |
684 | |
448 | |
685 | package urxvt; |
449 | package urxvt; |
686 | |
450 | |
687 | use utf8; |
451 | use utf8; |
688 | use strict; |
452 | use strict qw(vars subs); |
689 | use Carp (); |
453 | use Carp (); |
690 | use Scalar::Util (); |
454 | use Scalar::Util (); |
691 | use List::Util (); |
455 | use List::Util (); |
692 | |
456 | |
693 | our $VERSION = 1; |
457 | our $VERSION = 1; |
694 | our $TERM; |
458 | our $TERM; |
695 | our @TERM_INIT; |
459 | our @TERM_INIT; # should go, prevents async I/O etc. |
696 | our @TERM_EXT; |
460 | our @TERM_EXT; # should go, prevents async I/O etc. |
697 | our @HOOKNAME; |
461 | our @HOOKNAME; |
698 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
462 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
699 | our %OPTION; |
463 | our %OPTION; |
700 | |
464 | |
701 | our $LIBDIR; |
465 | our $LIBDIR; |
… | |
… | |
705 | |
469 | |
706 | our $NOCHAR = chr 0xffff; |
470 | our $NOCHAR = chr 0xffff; |
707 | |
471 | |
708 | =head2 Variables in the C<urxvt> Package |
472 | =head2 Variables in the C<urxvt> Package |
709 | |
473 | |
710 | =over 4 |
474 | =over |
711 | |
475 | |
712 | =item $urxvt::LIBDIR |
476 | =item $urxvt::LIBDIR |
713 | |
477 | |
714 | The rxvt-unicode library directory, where, among other things, the perl |
478 | The rxvt-unicode library directory, where, among other things, the perl |
715 | modules and scripts are stored. |
479 | modules and scripts are stored. |
… | |
… | |
745 | |
509 | |
746 | =back |
510 | =back |
747 | |
511 | |
748 | =head2 Functions in the C<urxvt> Package |
512 | =head2 Functions in the C<urxvt> Package |
749 | |
513 | |
750 | =over 4 |
514 | =over |
751 | |
515 | |
752 | =item urxvt::fatal $errormessage |
516 | =item urxvt::fatal $errormessage |
753 | |
517 | |
754 | Fatally aborts execution with the given error message. Avoid at all |
518 | Fatally aborts execution with the given error message (which should |
755 | costs! The only time this is acceptable is when the terminal process |
519 | include a trailing newline). Avoid at all costs! The only time this |
756 | starts up. |
520 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
521 | terminal from starting up. |
757 | |
522 | |
758 | =item urxvt::warn $string |
523 | =item urxvt::warn $string |
759 | |
524 | |
760 | Calls C<rxvt_warn> with the given string which should not include a |
525 | Calls C<rxvt_warn> with the given string which should include a trailing |
761 | newline. The module also overwrites the C<warn> builtin with a function |
526 | newline. The module also overwrites the C<warn> builtin with a function |
762 | that calls this function. |
527 | that calls this function. |
763 | |
528 | |
764 | Using this function has the advantage that its output ends up in the |
529 | Using this function has the advantage that its output ends up in the |
765 | correct place, e.g. on stderr of the connecting urxvtc client. |
530 | correct place, e.g. on stderr of the connecting urxvtc client. |
… | |
… | |
769 | =item @terms = urxvt::termlist |
534 | =item @terms = urxvt::termlist |
770 | |
535 | |
771 | Returns all urxvt::term objects that exist in this process, regardless of |
536 | Returns all urxvt::term objects that exist in this process, regardless of |
772 | whether they are started, being destroyed etc., so be careful. Only term |
537 | whether they are started, being destroyed etc., so be careful. Only term |
773 | objects that have perl extensions attached will be returned (because there |
538 | objects that have perl extensions attached will be returned (because there |
774 | is no urxvt::term objet associated with others). |
539 | is no urxvt::term object associated with others). |
775 | |
540 | |
776 | =item $time = urxvt::NOW |
541 | =item $time = urxvt::NOW |
777 | |
542 | |
778 | Returns the "current time" (as per the event loop). |
543 | Returns the "current time" (as per the event loop). |
779 | |
544 | |
… | |
… | |
799 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
564 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
800 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
565 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
801 | |
566 | |
802 | Various constants for use in X calls and event processing. |
567 | Various constants for use in X calls and event processing. |
803 | |
568 | |
|
|
569 | =item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin, |
|
|
570 | PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP, |
|
|
571 | PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys, |
|
|
572 | PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11, |
|
|
573 | PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress, |
|
|
574 | PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent, |
|
|
575 | PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8, |
|
|
576 | PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report, |
|
|
577 | PrivMode_Default |
|
|
578 | |
|
|
579 | Constants for checking DEC private modes. |
|
|
580 | |
804 | =back |
581 | =back |
805 | |
582 | |
806 | =head2 RENDITION |
583 | =head2 RENDITION |
807 | |
584 | |
808 | Rendition bitsets contain information about colour, font, font styles and |
585 | Rendition bitsets contain information about colour, font, font styles and |
… | |
… | |
811 | The following "macros" deal with changes in rendition sets. You should |
588 | The following "macros" deal with changes in rendition sets. You should |
812 | never just create a bitset, you should always modify an existing one, |
589 | never just create a bitset, you should always modify an existing one, |
813 | as they contain important information required for correct operation of |
590 | as they contain important information required for correct operation of |
814 | rxvt-unicode. |
591 | rxvt-unicode. |
815 | |
592 | |
816 | =over 4 |
593 | =over |
817 | |
594 | |
818 | =item $rend = urxvt::DEFAULT_RSTYLE |
595 | =item $rend = urxvt::DEFAULT_RSTYLE |
819 | |
596 | |
820 | Returns the default rendition, as used when the terminal is starting up or |
597 | Returns the default rendition, as used when the terminal is starting up or |
821 | being reset. Useful as a base to start when creating renditions. |
598 | being reset. Useful as a base to start when creating renditions. |
822 | |
599 | |
823 | =item $rend = urxvt::OVERLAY_RSTYLE |
600 | =item $rend = urxvt::OVERLAY_RSTYLE |
824 | |
601 | |
825 | Return the rendition mask used for overlays by default. |
602 | Return the rendition mask used for overlays by default. |
826 | |
603 | |
827 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
604 | =item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, |
|
|
605 | urxvt::RS_RVid, urxvt::RS_Uline |
828 | |
606 | |
829 | Return the bit that enabled bold, italic, blink, reverse-video and |
607 | Return the bit that enabled bold, italic, blink, reverse-video and |
830 | underline, respectively. To enable such a style, just logically OR it into |
608 | underline, respectively. To enable such a style, just logically OR it into |
831 | the bitset. |
609 | the bitset. |
832 | |
610 | |
… | |
… | |
869 | }; |
647 | }; |
870 | } |
648 | } |
871 | |
649 | |
872 | no warnings 'utf8'; |
650 | no warnings 'utf8'; |
873 | |
651 | |
|
|
652 | sub parse_resource { |
|
|
653 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
|
|
654 | |
|
|
655 | $term->scan_extensions; |
|
|
656 | |
|
|
657 | # iterating over all resources has quadratic time overhead |
|
|
658 | # overall, maybe this could be optimised? |
|
|
659 | my $r = $term->{meta}{resource}; |
|
|
660 | keys %$r; # reset iterator |
|
|
661 | while (my ($k, $v) = each %$r) { |
|
|
662 | my $pattern = $k; |
|
|
663 | $pattern =~ y/./-/ if $isarg; |
|
|
664 | my $prefix = $name; |
|
|
665 | my $suffix; |
|
|
666 | if ($pattern =~ /\-$/) { |
|
|
667 | $prefix = substr $name, 0, length $pattern; |
|
|
668 | $suffix = substr $name, length $pattern; |
|
|
669 | } |
|
|
670 | if ($pattern eq $prefix) { |
|
|
671 | $name = "$urxvt::RESCLASS.$k$suffix"; |
|
|
672 | |
|
|
673 | push @{ $term->{perl_ext_3} }, $v->[0]; |
|
|
674 | |
|
|
675 | return 1 unless $isarg; |
|
|
676 | |
|
|
677 | if ($v->[1] eq "boolean") { |
|
|
678 | $term->put_option_db ($name, $flag ? "true" : "false"); |
|
|
679 | return 1; |
|
|
680 | } else { |
|
|
681 | $term->put_option_db ($name, $value); |
|
|
682 | return 1 + 2; |
|
|
683 | } |
|
|
684 | } |
|
|
685 | } |
|
|
686 | |
|
|
687 | 0 |
|
|
688 | } |
|
|
689 | |
|
|
690 | sub usage { |
|
|
691 | my ($term, $usage_type) = @_; |
|
|
692 | |
|
|
693 | $term->scan_extensions; |
|
|
694 | |
|
|
695 | my $r = $term->{meta}{resource}; |
|
|
696 | |
|
|
697 | for my $pattern (sort keys %$r) { |
|
|
698 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
|
|
699 | |
|
|
700 | $desc .= " (-pe $ext)"; |
|
|
701 | |
|
|
702 | if ($usage_type == 1) { |
|
|
703 | $pattern =~ y/./-/; |
|
|
704 | $pattern =~ s/-$/-.../g; |
|
|
705 | |
|
|
706 | if ($type eq "boolean") { |
|
|
707 | urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc; |
|
|
708 | } else { |
|
|
709 | urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc; |
|
|
710 | } |
|
|
711 | } else { |
|
|
712 | $pattern =~ s/\.$/.*/g; |
|
|
713 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
|
|
714 | } |
|
|
715 | } |
|
|
716 | } |
|
|
717 | |
874 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
718 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2; |
875 | |
719 | |
876 | sub verbose { |
720 | sub verbose { |
877 | my ($level, $msg) = @_; |
721 | my ($level, $msg) = @_; |
878 | warn "$msg\n" if $level <= $verbosity; |
722 | warn "$msg\n" if $level <= $verbosity; |
879 | } |
723 | } |
… | |
… | |
890 | $pkg =~ s/[^[:word:]]/_/g; |
734 | $pkg =~ s/[^[:word:]]/_/g; |
891 | $pkg = "urxvt::ext::$pkg"; |
735 | $pkg = "urxvt::ext::$pkg"; |
892 | |
736 | |
893 | verbose 3, "loading extension '$path' into package '$pkg'"; |
737 | verbose 3, "loading extension '$path' into package '$pkg'"; |
894 | |
738 | |
|
|
739 | (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish |
|
|
740 | |
895 | open my $fh, "<:raw", $path |
741 | open my $fh, "<:raw", $path |
896 | or die "$path: $!"; |
742 | or die "$path: $!"; |
897 | |
743 | |
898 | my $source = |
744 | my $source = |
899 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
745 | "package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n" |
900 | . "#line 1 \"$path\"\n{\n" |
746 | . "#line 1 \"$path\"\n{\n" |
901 | . (do { local $/; <$fh> }) |
747 | . (do { local $/; <$fh> }) |
902 | . "\n};\n1"; |
748 | . "\n};\n1"; |
903 | |
749 | |
904 | eval $source |
750 | eval $source |
… | |
… | |
913 | # called by the rxvt core |
759 | # called by the rxvt core |
914 | sub invoke { |
760 | sub invoke { |
915 | local $TERM = shift; |
761 | local $TERM = shift; |
916 | my $htype = shift; |
762 | my $htype = shift; |
917 | |
763 | |
918 | if ($htype == 0) { # INIT |
764 | if ($htype == HOOK_INIT) { |
919 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
765 | $TERM->scan_extensions; |
920 | |
766 | |
921 | my %ext_arg; |
767 | my %ext_arg; |
922 | |
768 | |
923 | { |
769 | { |
924 | my @init = @TERM_INIT; |
770 | my @init = @TERM_INIT; |
… | |
… | |
927 | my @pkg = @TERM_EXT; |
773 | my @pkg = @TERM_EXT; |
928 | @TERM_EXT = (); |
774 | @TERM_EXT = (); |
929 | $TERM->register_package ($_) for @pkg; |
775 | $TERM->register_package ($_) for @pkg; |
930 | } |
776 | } |
931 | |
777 | |
|
|
778 | for ( |
|
|
779 | @{ delete $TERM->{perl_ext_3} }, |
932 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
780 | (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2), |
|
|
781 | ) { |
933 | if ($_ eq "default") { |
782 | if ($_ eq "default") { |
|
|
783 | |
|
|
784 | $ext_arg{$_} = [] |
934 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
785 | for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste); |
|
|
786 | |
|
|
787 | for ($TERM->_keysym_resources) { |
|
|
788 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
|
|
789 | next unless /^([A-Za-z0-9_\-]+):/; |
|
|
790 | |
|
|
791 | my $ext = $1; |
|
|
792 | |
|
|
793 | $ext_arg{$ext} = []; |
|
|
794 | } |
|
|
795 | |
935 | } elsif (/^-(.*)$/) { |
796 | } elsif (/^-(.*)$/) { # remove from set |
936 | delete $ext_arg{$1}; |
797 | delete $ext_arg{$1}; |
937 | } elsif (/^([^<]+)<(.*)>$/) { |
798 | |
|
|
799 | } elsif (/^\/(.*)$/) { # prohibit loading |
|
|
800 | undef $TERM->{ext_prohibit}{$1}; |
|
|
801 | |
|
|
802 | } elsif (/^([^<]+)(?:<(.*)>)?$/) { # add to set, clear prohibit status |
|
|
803 | delete $TERM->{ext_prohibit}{$1}; |
938 | push @{ $ext_arg{$1} }, $2; |
804 | push @{ $ext_arg{$1} }, defined $2 ? $2 : (); |
|
|
805 | |
939 | } else { |
806 | } else { |
940 | $ext_arg{$_} ||= []; |
807 | verbose 2, "cannot parse extension specification '$_', ignoring."; |
941 | } |
808 | } |
942 | } |
809 | } |
943 | |
810 | |
|
|
811 | $TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc}; |
|
|
812 | $TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl}; |
|
|
813 | |
944 | for my $ext (sort keys %ext_arg) { |
814 | for my $ext (sort keys %ext_arg) { |
945 | my @files = grep -f $_, map "$_/$ext", @dirs; |
815 | my $path = $TERM->extension_path ($ext); |
946 | |
816 | |
947 | if (@files) { |
817 | if (defined $path) { |
948 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
818 | $TERM->autoload_extension ($ext, $ext_arg{$ext}); |
949 | } else { |
819 | } else { |
950 | warn "perl extension '$ext' not found in perl library search path\n"; |
820 | verbose 2, "perl extension '$ext' not found in perl library search path"; |
951 | } |
821 | } |
952 | } |
822 | } |
953 | |
823 | |
954 | eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); |
824 | eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); |
955 | warn $@ if $@; |
825 | warn $@ if $@; |
956 | } |
826 | } |
957 | |
827 | |
958 | $retval = undef; |
828 | $retval = undef; |
959 | |
829 | |
|
|
830 | if ($htype == HOOK_OSC_SEQ) { |
|
|
831 | if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) { |
|
|
832 | $TERM->autoload_extension ($_->[0]) for @$exts; |
|
|
833 | } |
|
|
834 | } elsif ($htype == HOOK_OSC_SEQ_PERL) { |
|
|
835 | if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) { |
|
|
836 | $TERM->autoload_extension ($_->[0]) for @$exts; |
|
|
837 | } |
|
|
838 | } |
|
|
839 | |
960 | if (my $cb = $TERM->{_hook}[$htype]) { |
840 | if (my $cb = $TERM->{_hook}[$htype]) { |
961 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
841 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
962 | if $verbosity >= 10; |
842 | if $verbosity >= 10; |
963 | |
843 | |
|
|
844 | if ($htype == HOOK_ACTION) { |
|
|
845 | # this hook is only sent to the extension with the name |
|
|
846 | # matching the first arg |
|
|
847 | my $pkg = shift; |
|
|
848 | $pkg =~ y/-/_/; |
|
|
849 | $pkg = "urxvt::ext::$pkg"; |
|
|
850 | |
|
|
851 | $cb = $cb->{$pkg} |
|
|
852 | or return undef; #TODO: maybe warn user? |
|
|
853 | |
|
|
854 | $cb = { $pkg => $cb }; |
|
|
855 | } |
|
|
856 | |
964 | for my $pkg (keys %$cb) { |
857 | for my $pkg (keys %$cb) { |
965 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
858 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
966 | $retval ||= $retval_; |
859 | $retval ||= $retval_; |
967 | |
860 | |
968 | if ($@) { |
861 | if ($@) { |
969 | $TERM->ungrab; # better to lose the grab than the session |
862 | $TERM->ungrab; # better to lose the grab than the session |
970 | warn $@; |
863 | warn $@; |
… | |
… | |
973 | |
866 | |
974 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
867 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
975 | if $verbosity >= 11; |
868 | if $verbosity >= 11; |
976 | } |
869 | } |
977 | |
870 | |
978 | if ($htype == 1) { # DESTROY |
871 | if ($htype == HOOK_DESTROY) { |
979 | # clear package objects |
872 | # clear package objects |
980 | %$_ = () for values %{ $TERM->{_pkg} }; |
873 | %$_ = () for values %{ $TERM->{_pkg} }; |
981 | |
874 | |
982 | # clear package |
875 | # clear package |
983 | %$TERM = (); |
876 | %$TERM = (); |
… | |
… | |
1013 | } |
906 | } |
1014 | } |
907 | } |
1015 | ($mask, @color{qw(fg bg)}, \@failed) |
908 | ($mask, @color{qw(fg bg)}, \@failed) |
1016 | } |
909 | } |
1017 | |
910 | |
1018 | # urxvt::term::extension |
|
|
1019 | |
|
|
1020 | package urxvt::term::extension; |
911 | package urxvt::term::extension; |
1021 | |
912 | |
1022 | sub enable { |
913 | =head2 The C<urxvt::term::extension> class |
1023 | my ($self, %hook) = @_; |
|
|
1024 | my $pkg = $self->{_pkg}; |
|
|
1025 | |
914 | |
1026 | while (my ($name, $cb) = each %hook) { |
915 | Each extension attached to a terminal object is represented by |
1027 | my $htype = $HOOKTYPE{uc $name}; |
916 | a C<urxvt::term::extension> object. |
1028 | defined $htype |
|
|
1029 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1030 | |
917 | |
1031 | $self->set_should_invoke ($htype, +1) |
918 | You can use these objects, which are passed to all callbacks to store any |
1032 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
919 | state related to the terminal and extension instance. |
1033 | |
920 | |
1034 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
921 | The methods (And data members) documented below can be called on extension |
1035 | } |
922 | objects, in addition to call methods documented for the <urxvt::term> |
1036 | } |
923 | class. |
1037 | |
924 | |
1038 | sub disable { |
925 | =over |
1039 | my ($self, @hook) = @_; |
|
|
1040 | my $pkg = $self->{_pkg}; |
|
|
1041 | |
926 | |
1042 | for my $name (@hook) { |
927 | =item $urxvt_term = $self->{term} |
1043 | my $htype = $HOOKTYPE{uc $name}; |
|
|
1044 | defined $htype |
|
|
1045 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1046 | |
928 | |
1047 | $self->set_should_invoke ($htype, -1) |
929 | Returns the C<urxvt::term> object associated with this instance of the |
1048 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
930 | extension. This member I<must not> be changed in any way. |
1049 | } |
931 | |
1050 | } |
932 | =cut |
1051 | |
933 | |
1052 | our $AUTOLOAD; |
934 | our $AUTOLOAD; |
1053 | |
935 | |
1054 | sub AUTOLOAD { |
936 | sub AUTOLOAD { |
1055 | $AUTOLOAD =~ /:([^:]+)$/ |
937 | $AUTOLOAD =~ /:([^:]+)$/ |
… | |
… | |
1068 | |
950 | |
1069 | sub DESTROY { |
951 | sub DESTROY { |
1070 | # nop |
952 | # nop |
1071 | } |
953 | } |
1072 | |
954 | |
1073 | # urxvt::destroy_hook |
955 | # urxvt::destroy_hook (basically a cheap Guard:: implementation) |
1074 | |
956 | |
1075 | sub urxvt::destroy_hook::DESTROY { |
957 | sub urxvt::destroy_hook::DESTROY { |
1076 | ${$_[0]}->(); |
958 | ${$_[0]}->(); |
1077 | } |
959 | } |
1078 | |
960 | |
1079 | sub urxvt::destroy_hook(&) { |
961 | sub urxvt::destroy_hook(&) { |
1080 | bless \shift, urxvt::destroy_hook:: |
962 | bless \shift, urxvt::destroy_hook:: |
1081 | } |
963 | } |
|
|
964 | |
|
|
965 | =item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
966 | |
|
|
967 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
968 | this extension, replacing any hook previously installed via C<enable> in |
|
|
969 | this extension. |
|
|
970 | |
|
|
971 | This is useful when you want to overwrite time-critical hooks only |
|
|
972 | temporarily. |
|
|
973 | |
|
|
974 | To install additional callbacks for the same hook, you can use the C<on> |
|
|
975 | method of the C<urxvt::term> class. |
|
|
976 | |
|
|
977 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
978 | |
|
|
979 | Dynamically disable the given hooks. |
|
|
980 | |
|
|
981 | =cut |
|
|
982 | |
|
|
983 | sub enable { |
|
|
984 | my ($self, %hook) = @_; |
|
|
985 | my $pkg = $self->{_pkg}; |
|
|
986 | |
|
|
987 | while (my ($name, $cb) = each %hook) { |
|
|
988 | my $htype = $HOOKTYPE{uc $name}; |
|
|
989 | defined $htype |
|
|
990 | or Carp::croak "unsupported hook type '$name'"; |
|
|
991 | |
|
|
992 | $self->set_should_invoke ($htype, +1) |
|
|
993 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
|
|
994 | |
|
|
995 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
996 | } |
|
|
997 | } |
|
|
998 | |
|
|
999 | sub disable { |
|
|
1000 | my ($self, @hook) = @_; |
|
|
1001 | my $pkg = $self->{_pkg}; |
|
|
1002 | |
|
|
1003 | for my $name (@hook) { |
|
|
1004 | my $htype = $HOOKTYPE{uc $name}; |
|
|
1005 | defined $htype |
|
|
1006 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1007 | |
|
|
1008 | $self->set_should_invoke ($htype, -1) |
|
|
1009 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
|
|
1010 | } |
|
|
1011 | } |
|
|
1012 | |
|
|
1013 | =item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
1014 | |
|
|
1015 | Similar to the C<enable> enable, but installs additional callbacks for |
|
|
1016 | the given hook(s) (that is, it doesn't replace existing callbacks), and |
|
|
1017 | returns a guard object. When the guard object is destroyed the callbacks |
|
|
1018 | are disabled again. |
|
|
1019 | |
|
|
1020 | =cut |
|
|
1021 | |
|
|
1022 | sub urxvt::extension::on_disable::DESTROY { |
|
|
1023 | my $disable = shift; |
|
|
1024 | |
|
|
1025 | my $term = delete $disable->{""}; |
|
|
1026 | |
|
|
1027 | while (my ($htype, $id) = each %$disable) { |
|
|
1028 | delete $term->{_hook}[$htype]{$id}; |
|
|
1029 | $term->set_should_invoke ($htype, -1); |
|
|
1030 | } |
|
|
1031 | } |
|
|
1032 | |
|
|
1033 | sub on { |
|
|
1034 | my ($self, %hook) = @_; |
|
|
1035 | |
|
|
1036 | my $term = $self->{term}; |
|
|
1037 | |
|
|
1038 | my %disable = ( "" => $term ); |
|
|
1039 | |
|
|
1040 | while (my ($name, $cb) = each %hook) { |
|
|
1041 | my $htype = $HOOKTYPE{uc $name}; |
|
|
1042 | defined $htype |
|
|
1043 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1044 | |
|
|
1045 | $term->set_should_invoke ($htype, +1); |
|
|
1046 | $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 } |
|
|
1047 | = sub { shift; $cb->($self, @_) }; # very ugly indeed |
|
|
1048 | } |
|
|
1049 | |
|
|
1050 | bless \%disable, "urxvt::extension::on_disable" |
|
|
1051 | } |
|
|
1052 | |
|
|
1053 | =item $self->bind_action ($hotkey, $action) |
|
|
1054 | |
|
|
1055 | =item $self->x_resource ($pattern) |
|
|
1056 | |
|
|
1057 | =item $self->x_resource_boolean ($pattern) |
|
|
1058 | |
|
|
1059 | These methods support an additional C<%> prefix for C<$action> or |
|
|
1060 | C<$pattern> when called on an extension object, compared to the |
|
|
1061 | C<urxvt::term> methods of the same name - see the description of these |
|
|
1062 | methods in the C<urxvt::term> class for details. |
|
|
1063 | |
|
|
1064 | =cut |
|
|
1065 | |
|
|
1066 | sub bind_action { |
|
|
1067 | my ($self, $hotkey, $action) = @_; |
|
|
1068 | $action =~ s/^%:/$_[0]{_name}:/; |
|
|
1069 | $self->{term}->bind_action ($hotkey, $action) |
|
|
1070 | } |
|
|
1071 | |
|
|
1072 | sub x_resource { |
|
|
1073 | my ($self, $name) = @_; |
|
|
1074 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
1075 | $self->{term}->x_resource ($name) |
|
|
1076 | } |
|
|
1077 | |
|
|
1078 | sub x_resource_boolean { |
|
|
1079 | my ($self, $name) = @_; |
|
|
1080 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
1081 | $self->{term}->x_resource_boolean ($name) |
|
|
1082 | } |
|
|
1083 | |
|
|
1084 | =back |
|
|
1085 | |
|
|
1086 | =cut |
1082 | |
1087 | |
1083 | package urxvt::anyevent; |
1088 | package urxvt::anyevent; |
1084 | |
1089 | |
1085 | =head2 The C<urxvt::anyevent> Class |
1090 | =head2 The C<urxvt::anyevent> Class |
1086 | |
1091 | |
1087 | The sole purpose of this class is to deliver an interface to the |
1092 | The sole purpose of this class is to deliver an interface to the |
1088 | C<AnyEvent> module - any module using it will work inside urxvt without |
1093 | C<AnyEvent> module - any module using it will work inside urxvt without |
1089 | further programming. The only exception is that you cannot wait on |
1094 | further programming. The only exception is that you cannot wait on |
1090 | condition variables, but non-blocking condvar use is ok. What this means |
1095 | condition variables, but non-blocking condvar use is ok. |
1091 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
1092 | work. |
|
|
1093 | |
1096 | |
1094 | =cut |
1097 | In practical terms this means is that you cannot use blocking APIs, but |
|
|
1098 | the non-blocking variant should work. |
1095 | |
1099 | |
|
|
1100 | =cut |
|
|
1101 | |
1096 | our $VERSION = '3.4'; |
1102 | our $VERSION = '5.23'; |
1097 | |
1103 | |
1098 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1104 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1099 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1105 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1100 | |
1106 | |
1101 | sub timer { |
1107 | sub timer { |
… | |
… | |
1103 | |
1109 | |
1104 | my $cb = $arg{cb}; |
1110 | my $cb = $arg{cb}; |
1105 | |
1111 | |
1106 | urxvt::timer |
1112 | urxvt::timer |
1107 | ->new |
1113 | ->new |
1108 | ->start (urxvt::NOW + $arg{after}) |
1114 | ->after ($arg{after}, $arg{interval}) |
1109 | ->cb (sub { |
1115 | ->cb ($arg{interval} ? $cb : sub { |
1110 | $_[0]->stop; # need to cancel manually |
1116 | $_[0]->stop; # need to cancel manually |
1111 | $cb->(); |
1117 | $cb->(); |
1112 | }) |
1118 | }) |
1113 | } |
1119 | } |
1114 | |
1120 | |
1115 | sub io { |
1121 | sub io { |
1116 | my ($class, %arg) = @_; |
1122 | my ($class, %arg) = @_; |
1117 | |
1123 | |
1118 | my $cb = $arg{cb}; |
1124 | my $cb = $arg{cb}; |
|
|
1125 | my $fd = fileno $arg{fh}; |
|
|
1126 | defined $fd or $fd = $arg{fh}; |
1119 | |
1127 | |
1120 | bless [$arg{fh}, urxvt::iow |
1128 | bless [$arg{fh}, urxvt::iow |
1121 | ->new |
1129 | ->new |
1122 | ->fd (fileno $arg{fh}) |
1130 | ->fd ($fd) |
1123 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1131 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1124 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1132 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1125 | ->start |
1133 | ->start |
1126 | ->cb (sub { |
1134 | ->cb ($cb) |
1127 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
1128 | . ($_[1] & 2 ? 'w' : '')); |
|
|
1129 | })], |
|
|
1130 | urxvt::anyevent:: |
1135 | ], urxvt::anyevent:: |
|
|
1136 | } |
|
|
1137 | |
|
|
1138 | sub idle { |
|
|
1139 | my ($class, %arg) = @_; |
|
|
1140 | |
|
|
1141 | my $cb = $arg{cb}; |
|
|
1142 | |
|
|
1143 | urxvt::iw |
|
|
1144 | ->new |
|
|
1145 | ->start |
|
|
1146 | ->cb ($cb) |
|
|
1147 | } |
|
|
1148 | |
|
|
1149 | sub child { |
|
|
1150 | my ($class, %arg) = @_; |
|
|
1151 | |
|
|
1152 | my $cb = $arg{cb}; |
|
|
1153 | |
|
|
1154 | urxvt::pw |
|
|
1155 | ->new |
|
|
1156 | ->start ($arg{pid}) |
|
|
1157 | ->cb (sub { |
|
|
1158 | $_[0]->stop; # need to cancel manually |
|
|
1159 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1160 | }) |
1131 | } |
1161 | } |
1132 | |
1162 | |
1133 | sub DESTROY { |
1163 | sub DESTROY { |
1134 | $_[0][1]->stop; |
1164 | $_[0][1]->stop; |
1135 | } |
1165 | } |
1136 | |
1166 | |
|
|
1167 | # only needed for AnyEvent < 6 compatibility |
1137 | sub one_event { |
1168 | sub one_event { |
1138 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1169 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1139 | } |
1170 | } |
1140 | |
1171 | |
1141 | package urxvt::term; |
1172 | package urxvt::term; |
1142 | |
1173 | |
1143 | =head2 The C<urxvt::term> Class |
1174 | =head2 The C<urxvt::term> Class |
1144 | |
1175 | |
1145 | =over 4 |
1176 | =over |
1146 | |
1177 | |
1147 | =cut |
1178 | =cut |
1148 | |
1179 | |
1149 | # find on_xxx subs in the package and register them |
1180 | # find on_xxx subs in the package and register them |
1150 | # as hooks |
1181 | # as hooks |
… | |
… | |
1156 | urxvt::verbose 6, "register package $pkg to $self"; |
1187 | urxvt::verbose 6, "register package $pkg to $self"; |
1157 | |
1188 | |
1158 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
1189 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
1159 | |
1190 | |
1160 | my $proxy = bless { |
1191 | my $proxy = bless { |
1161 | _pkg => $pkg, |
1192 | _pkg => $pkg, |
|
|
1193 | _name => ${"$pkg\::_NAME"}, # hackish |
1162 | argv => $argv, |
1194 | argv => $argv, |
1163 | }, $pkg; |
1195 | }, $pkg; |
1164 | Scalar::Util::weaken ($proxy->{term} = $self); |
1196 | Scalar::Util::weaken ($proxy->{term} = $self); |
1165 | |
1197 | |
1166 | $self->{_pkg}{$pkg} = $proxy; |
1198 | $self->{_pkg}{$pkg} = $proxy; |
1167 | |
1199 | |
… | |
… | |
1170 | $proxy->enable ($name => $ref); |
1202 | $proxy->enable ($name => $ref); |
1171 | } |
1203 | } |
1172 | } |
1204 | } |
1173 | } |
1205 | } |
1174 | |
1206 | |
|
|
1207 | # map extension name to filesystem path |
|
|
1208 | sub extension_path { |
|
|
1209 | (grep -f $_, map "$_/$_[1]", $_[0]->perl_libdirs)[0] |
|
|
1210 | } |
|
|
1211 | |
|
|
1212 | # load an extension by name |
|
|
1213 | sub load_extension_file { |
|
|
1214 | my ($self, $path, $argv) = @_; |
|
|
1215 | |
|
|
1216 | $self->register_package (urxvt::extension_package $path, $argv); |
|
|
1217 | } |
|
|
1218 | |
|
|
1219 | # autoload an extension unless loading it is prohibited |
|
|
1220 | sub autoload_extension { |
|
|
1221 | my ($self, $name, $argv) = @_; |
|
|
1222 | |
|
|
1223 | return if exists $self->{ext_prohibit}{$name}; |
|
|
1224 | |
|
|
1225 | my $path = $self->extension_path ($name) |
|
|
1226 | // return urxvt::verbose 2, "perl extension '$name' not found in perl library search path (during autoload)"; |
|
|
1227 | |
|
|
1228 | $self->load_extension_file ($path, $argv); |
|
|
1229 | } |
|
|
1230 | |
|
|
1231 | sub perl_libdirs { |
|
|
1232 | map { split /:/ } |
|
|
1233 | $_[0]->resource ("perl_lib"), |
|
|
1234 | $ENV{URXVT_PERL_LIB}, |
|
|
1235 | "$ENV{HOME}/.urxvt/ext", |
|
|
1236 | "$LIBDIR/perl" |
|
|
1237 | } |
|
|
1238 | |
|
|
1239 | # scan for available extensions and collect their metadata |
|
|
1240 | sub scan_extensions { |
|
|
1241 | my ($self) = @_; |
|
|
1242 | |
|
|
1243 | return if exists $self->{meta}; |
|
|
1244 | |
|
|
1245 | my @urxvtdirs = perl_libdirs $self; |
|
|
1246 | # my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; |
|
|
1247 | |
|
|
1248 | $self->{meta} = \my %allmeta; |
|
|
1249 | |
|
|
1250 | # first gather extensions |
|
|
1251 | |
|
|
1252 | my $gather = sub { |
|
|
1253 | my ($dir, $core) = @_; |
|
|
1254 | |
|
|
1255 | opendir my $fh, $dir |
|
|
1256 | or return; |
|
|
1257 | |
|
|
1258 | for my $ext (readdir $fh) { |
|
|
1259 | $ext !~ /^\./ |
|
|
1260 | or next; |
|
|
1261 | |
|
|
1262 | open my $fh, "<", "$dir/$ext" |
|
|
1263 | or next; |
|
|
1264 | |
|
|
1265 | -f $fh |
|
|
1266 | or next; |
|
|
1267 | |
|
|
1268 | $ext =~ s/\.uext$// or $core |
|
|
1269 | or next; |
|
|
1270 | |
|
|
1271 | my %meta = (dir => $dir); |
|
|
1272 | |
|
|
1273 | while (<$fh>) { |
|
|
1274 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
|
|
1275 | my ($pattern, $type, $desc) = split /:/, $1; |
|
|
1276 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
|
|
1277 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
|
|
1278 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
|
|
1279 | } else { |
|
|
1280 | $meta{resource}{$pattern} = [$ext, $type, $desc]; |
|
|
1281 | } |
|
|
1282 | |
|
|
1283 | } elsif (/^#:META:OSC:([0-9]+):(.*)/) { |
|
|
1284 | push @{$allmeta{autoload_osc}{$1}}, [$ext, $2]; |
|
|
1285 | |
|
|
1286 | } elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) { |
|
|
1287 | push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2]; |
|
|
1288 | |
|
|
1289 | } elsif (/^\s*(?:#|$)/) { |
|
|
1290 | # skip other comments and empty lines |
|
|
1291 | |
|
|
1292 | } else { |
|
|
1293 | last; # stop parsing on first non-empty non-comment line |
|
|
1294 | } |
|
|
1295 | } |
|
|
1296 | |
|
|
1297 | $allmeta{ext}{$ext} = \%meta; |
|
|
1298 | } |
|
|
1299 | }; |
|
|
1300 | |
|
|
1301 | # $gather->($_, 0) for @cpandirs; |
|
|
1302 | $gather->($_, 1) for @urxvtdirs; |
|
|
1303 | |
|
|
1304 | # and now merge resources |
|
|
1305 | |
|
|
1306 | $allmeta{resource} = \my %resource; |
|
|
1307 | |
|
|
1308 | while (my ($k, $v) = each %{ $allmeta{ext} }) { |
|
|
1309 | #TODO: should check for extensions overriding each other |
|
|
1310 | %resource = (%resource, %{ $v->{resource} }); |
|
|
1311 | } |
|
|
1312 | } |
|
|
1313 | |
1175 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1314 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1176 | |
1315 | |
1177 | Creates a new terminal, very similar as if you had started it with system |
1316 | Creates a new terminal, very similar as if you had started it with system |
1178 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
1317 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
1179 | hash which defines the environment of the new terminal. |
1318 | hash which defines the environment of the new terminal. |
… | |
… | |
1196 | } |
1335 | } |
1197 | |
1336 | |
1198 | =item $term->destroy |
1337 | =item $term->destroy |
1199 | |
1338 | |
1200 | Destroy the terminal object (close the window, free resources |
1339 | Destroy the terminal object (close the window, free resources |
1201 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1340 | etc.). Please note that urxvt will not exit as long as any event |
1202 | watchers (timers, io watchers) are still active. |
1341 | watchers (timers, io watchers) are still active. |
1203 | |
1342 | |
1204 | =item $term->exec_async ($cmd[, @args]) |
1343 | =item $term->exec_async ($cmd[, @args]) |
1205 | |
1344 | |
1206 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
1345 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
… | |
… | |
1233 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1372 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1234 | |
1373 | |
1235 | Here is a likely non-exhaustive list of option names, please see the |
1374 | Here is a likely non-exhaustive list of option names, please see the |
1236 | source file F</src/optinc.h> to see the actual list: |
1375 | source file F</src/optinc.h> to see the actual list: |
1237 | |
1376 | |
1238 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1377 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
1239 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1378 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1240 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1379 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1241 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
1380 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1242 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
1381 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1243 | transparent tripleclickwords utmpInhibit visualBell |
1382 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
|
|
1383 | urgentOnBell utmpInhibit visualBell disablePasteBrackets |
1244 | |
1384 | |
1245 | =item $value = $term->resource ($name[, $newval]) |
1385 | =item $value = $term->resource ($name[, $newval]) |
1246 | |
1386 | |
1247 | Returns the current resource value associated with a given name and |
1387 | Returns the current resource value associated with a given name and |
1248 | optionally sets a new value. Setting values is most useful in the C<init> |
1388 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
1261 | |
1401 | |
1262 | Here is a likely non-exhaustive list of resource names, not all of which |
1402 | Here is a likely non-exhaustive list of resource names, not all of which |
1263 | are supported in every build, please see the source file F</src/rsinc.h> |
1403 | are supported in every build, please see the source file F</src/rsinc.h> |
1264 | to see the actual list: |
1404 | to see the actual list: |
1265 | |
1405 | |
1266 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1406 | answerbackstring backgroundPixmap backspace_key blurradius |
1267 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1407 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1268 | display_name embed ext_bwidth fade font geometry hold iconName |
1408 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1269 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1409 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
|
|
1410 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
1270 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1411 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1271 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1412 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1272 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1413 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1273 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1414 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1274 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1415 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1275 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1416 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1276 | secondaryScreen secondaryScroll shade term_name title |
1417 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1277 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1418 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1278 | visualBell |
1419 | utmpInhibit visualBell rewrapMode disablePasteBrackets |
1279 | |
1420 | |
1280 | =cut |
1421 | =cut |
1281 | |
1422 | |
1282 | sub resource($$;$) { |
1423 | sub resource($$;$) { |
1283 | my ($self, $name) = (shift, shift); |
1424 | my ($self, $name) = (shift, shift); |
1284 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1425 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1285 | &urxvt::term::_resource |
1426 | goto &urxvt::term::_resource |
1286 | } |
1427 | } |
1287 | |
1428 | |
1288 | =item $value = $term->x_resource ($pattern) |
1429 | =item $value = $term->x_resource ($pattern) |
1289 | |
1430 | |
1290 | Returns the X-Resource for the given pattern, excluding the program or |
1431 | Returns the X-Resource for the given pattern, excluding the program or |
1291 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1432 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1292 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1433 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1293 | resource with that pattern exists. |
1434 | resource with that pattern exists. |
1294 | |
1435 | |
|
|
1436 | Extensions that define extra resources also need to call this method |
|
|
1437 | to access their values. |
|
|
1438 | |
|
|
1439 | If the method is called on an extension object (basically, from an |
|
|
1440 | extension), then the special prefix C<%.> will be replaced by the name of |
|
|
1441 | the extension and a dot, and the lone string C<%> will be replaced by the |
|
|
1442 | extension name itself. This makes it possible to code extensions so you |
|
|
1443 | can rename them and get a new set of resources without having to change |
|
|
1444 | the actual code. |
|
|
1445 | |
1295 | This method should only be called during the C<on_start> hook, as there is |
1446 | This method should only be called during the C<on_start> hook, as there is |
1296 | only one resource database per display, and later invocations might return |
1447 | only one resource database per display, and later invocations might return |
1297 | the wrong resources. |
1448 | the wrong resources. |
1298 | |
1449 | |
1299 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
1450 | =item $value = $term->x_resource_boolean ($pattern) |
1300 | |
1451 | |
|
|
1452 | Like C<x_resource>, above, but interprets the string value as a boolean |
|
|
1453 | and returns C<1> for true values, C<0> for false values and C<undef> if |
|
|
1454 | the resource or option isn't specified. |
|
|
1455 | |
|
|
1456 | You should always use this method to parse boolean resources. |
|
|
1457 | |
|
|
1458 | =cut |
|
|
1459 | |
|
|
1460 | sub x_resource_boolean { |
|
|
1461 | my $res = &x_resource; |
|
|
1462 | |
|
|
1463 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
|
|
1464 | } |
|
|
1465 | |
|
|
1466 | =item $action = $term->lookup_keysym ($keysym, $state) |
|
|
1467 | |
|
|
1468 | Returns the action bound to key combination C<($keysym, $state)>, |
|
|
1469 | if a binding for it exists, and C<undef> otherwise. |
|
|
1470 | |
|
|
1471 | =item $success = $term->bind_action ($key, $action) |
|
|
1472 | |
1301 | Adds a keymap translation exactly as specified via a resource. See the |
1473 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1302 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1474 | C<keysym> resource in the urxvt(1) manpage. |
|
|
1475 | |
|
|
1476 | To add default bindings for actions, an extension should call C<< |
|
|
1477 | ->bind_action >> in its C<init> hook for every such binding. Doing it |
|
|
1478 | in the C<init> hook allows users to override or remove the binding |
|
|
1479 | again. |
|
|
1480 | |
|
|
1481 | Example: the C<searchable-scrollback> by default binds itself |
|
|
1482 | on C<Meta-s>, using C<< $self->bind_action >>, which calls C<< |
|
|
1483 | $term->bind_action >>. |
|
|
1484 | |
|
|
1485 | sub init { |
|
|
1486 | my ($self) = @_; |
|
|
1487 | |
|
|
1488 | $self->bind_action ("M-s" => "%:start"); |
|
|
1489 | } |
1303 | |
1490 | |
1304 | =item $rend = $term->rstyle ([$new_rstyle]) |
1491 | =item $rend = $term->rstyle ([$new_rstyle]) |
1305 | |
1492 | |
1306 | Return and optionally change the current rendition. Text that is output by |
1493 | Return and optionally change the current rendition. Text that is output by |
1307 | the terminal application will use this style. |
1494 | the terminal application will use this style. |
… | |
… | |
1315 | |
1502 | |
1316 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1503 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1317 | |
1504 | |
1318 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1505 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1319 | |
1506 | |
1320 | Return the current values of the selection mark, begin or end positions, |
1507 | Return the current values of the selection mark, begin or end positions. |
1321 | and optionally set them to new values. |
1508 | |
|
|
1509 | When arguments are given, then the selection coordinates are set to |
|
|
1510 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1511 | screen. |
|
|
1512 | |
|
|
1513 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1514 | |
|
|
1515 | Returns the current selection screen, and then optionally sets it. |
1322 | |
1516 | |
1323 | =item $term->selection_make ($eventtime[, $rectangular]) |
1517 | =item $term->selection_make ($eventtime[, $rectangular]) |
1324 | |
1518 | |
1325 | Tries to make a selection as set by C<selection_beg> and |
1519 | Tries to make a selection as set by C<selection_beg> and |
1326 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1520 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1327 | rectangular selection will be made. This is the prefered function to make |
1521 | rectangular selection will be made. This is the preferred function to make |
1328 | a selection. |
1522 | a selection. |
1329 | |
1523 | |
1330 | =item $success = $term->selection_grab ($eventtime) |
1524 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
1331 | |
1525 | |
1332 | Try to request the primary selection text from the server (for example, as |
1526 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1527 | true) selection from the server. The corresponding text can be set |
1333 | set by the next method). No visual feedback will be given. This function |
1528 | with the next method. No visual feedback will be given. This function |
1334 | is mostly useful from within C<on_sel_grab> hooks. |
1529 | is mostly useful from within C<on_sel_grab> hooks. |
1335 | |
1530 | |
1336 | =item $oldtext = $term->selection ([$newtext]) |
1531 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
1337 | |
1532 | |
1338 | Return the current selection text and optionally replace it by C<$newtext>. |
1533 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1534 | and optionally replace it by C<$newtext>. |
|
|
1535 | |
|
|
1536 | =item $term->selection_clear ([$clipboard]) |
|
|
1537 | |
|
|
1538 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
1339 | |
1539 | |
1340 | =item $term->overlay_simple ($x, $y, $text) |
1540 | =item $term->overlay_simple ($x, $y, $text) |
1341 | |
1541 | |
1342 | Create a simple multi-line overlay box. See the next method for details. |
1542 | Create a simple multi-line overlay box. See the next method for details. |
1343 | |
1543 | |
… | |
… | |
1371 | This method returns an urxvt::overlay object. The overlay will be visible |
1571 | This method returns an urxvt::overlay object. The overlay will be visible |
1372 | as long as the perl object is referenced. |
1572 | as long as the perl object is referenced. |
1373 | |
1573 | |
1374 | The methods currently supported on C<urxvt::overlay> objects are: |
1574 | The methods currently supported on C<urxvt::overlay> objects are: |
1375 | |
1575 | |
1376 | =over 4 |
1576 | =over |
1377 | |
1577 | |
1378 | =item $overlay->set ($x, $y, $text, $rend) |
1578 | =item $overlay->set ($x, $y, $text[, $rend]) |
1379 | |
1579 | |
1380 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1580 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1381 | text in rxvt-unicode's special encoding and an array of rendition values |
1581 | text in rxvt-unicode's special encoding and an array of rendition values |
1382 | at a specific position inside the overlay. |
1582 | at a specific position inside the overlay. |
|
|
1583 | |
|
|
1584 | If C<$rend> is missing, then the rendition will not be changed. |
1383 | |
1585 | |
1384 | =item $overlay->hide |
1586 | =item $overlay->hide |
1385 | |
1587 | |
1386 | If visible, hide the overlay, but do not destroy it. |
1588 | If visible, hide the overlay, but do not destroy it. |
1387 | |
1589 | |
… | |
… | |
1450 | |
1652 | |
1451 | =item $term->scr_add_lines ($string) |
1653 | =item $term->scr_add_lines ($string) |
1452 | |
1654 | |
1453 | Write the given text string to the screen, as if output by the application |
1655 | Write the given text string to the screen, as if output by the application |
1454 | running inside the terminal. It may not contain command sequences (escape |
1656 | running inside the terminal. It may not contain command sequences (escape |
1455 | codes), but is free to use line feeds, carriage returns and tabs. The |
1657 | codes - see C<cmd_parse> for that), but is free to use line feeds, |
1456 | string is a normal text string, not in locale-dependent encoding. |
1658 | carriage returns and tabs. The string is a normal text string, not in |
|
|
1659 | locale-dependent encoding. |
1457 | |
1660 | |
1458 | Normally its not a good idea to use this function, as programs might be |
1661 | Normally its not a good idea to use this function, as programs might be |
1459 | confused by changes in cursor position or scrolling. Its useful inside a |
1662 | confused by changes in cursor position or scrolling. Its useful inside a |
1460 | C<on_add_lines> hook, though. |
1663 | C<on_add_lines> hook, though. |
1461 | |
1664 | |
… | |
… | |
1469 | locale-specific encoding of the terminal and can contain command sequences |
1672 | locale-specific encoding of the terminal and can contain command sequences |
1470 | (escape codes) that will be interpreted. |
1673 | (escape codes) that will be interpreted. |
1471 | |
1674 | |
1472 | =item $term->tt_write ($octets) |
1675 | =item $term->tt_write ($octets) |
1473 | |
1676 | |
1474 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1677 | Write the octets given in C<$octets> to the tty (i.e. as user input |
|
|
1678 | to the program, see C<cmd_parse> for the opposite direction). To pass |
1475 | pass characters instead of octets, you should convert your strings first |
1679 | characters instead of octets, you should convert your strings first to the |
1476 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1680 | locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1681 | |
|
|
1682 | =item $term->tt_write_user_input ($octets) |
|
|
1683 | |
|
|
1684 | Like C<tt_write>, but should be used when writing strings in response to |
|
|
1685 | the user pressing a key, to invoke the additional actions requested by |
|
|
1686 | the user for that case (C<tt_write> doesn't do that). |
|
|
1687 | |
|
|
1688 | The typical use case would be inside C<on_action> hooks. |
|
|
1689 | |
|
|
1690 | =item $term->tt_paste ($octets) |
|
|
1691 | |
|
|
1692 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1693 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1694 | is set. |
1477 | |
1695 | |
1478 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1696 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1479 | |
1697 | |
1480 | Replaces the event mask of the pty watcher by the given event mask. Can |
1698 | Replaces the event mask of the pty watcher by the given event mask. Can |
1481 | be used to suppress input and output handling to the pty/tty. See the |
1699 | be used to suppress input and output handling to the pty/tty. See the |
… | |
… | |
1500 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1718 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1501 | to receive pointer events all the times: |
1719 | to receive pointer events all the times: |
1502 | |
1720 | |
1503 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1721 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1504 | |
1722 | |
|
|
1723 | =item $term->set_urgency ($set) |
|
|
1724 | |
|
|
1725 | Enable/disable the urgency hint on the toplevel window. |
|
|
1726 | |
1505 | =item $term->focus_in |
1727 | =item $term->focus_in |
1506 | |
1728 | |
1507 | =item $term->focus_out |
1729 | =item $term->focus_out |
1508 | |
1730 | |
1509 | =item $term->key_press ($state, $keycode[, $time]) |
1731 | =item $term->key_press ($state, $keycode[, $time]) |
1510 | |
1732 | |
1511 | =item $term->key_release ($state, $keycode[, $time]) |
1733 | =item $term->key_release ($state, $keycode[, $time]) |
1512 | |
1734 | |
1513 | Deliver various fake events to to terminal. |
1735 | Deliver various fake events to to terminal. |
1514 | |
1736 | |
1515 | =item $window_width = $term->width |
1737 | =item $window_width = $term->width ([$new_value]) |
1516 | |
1738 | |
1517 | =item $window_height = $term->height |
1739 | =item $window_height = $term->height ([$new_value]) |
1518 | |
1740 | |
1519 | =item $font_width = $term->fwidth |
1741 | =item $font_width = $term->fwidth ([$new_value]) |
1520 | |
1742 | |
1521 | =item $font_height = $term->fheight |
1743 | =item $font_height = $term->fheight ([$new_value]) |
1522 | |
1744 | |
1523 | =item $font_ascent = $term->fbase |
1745 | =item $font_ascent = $term->fbase ([$new_value]) |
1524 | |
1746 | |
1525 | =item $terminal_rows = $term->nrow |
1747 | =item $terminal_rows = $term->nrow ([$new_value]) |
1526 | |
1748 | |
1527 | =item $terminal_columns = $term->ncol |
1749 | =item $terminal_columns = $term->ncol ([$new_value]) |
1528 | |
1750 | |
1529 | =item $has_focus = $term->focus |
1751 | =item $has_focus = $term->focus ([$new_value]) |
1530 | |
1752 | |
1531 | =item $is_mapped = $term->mapped |
1753 | =item $is_mapped = $term->mapped ([$new_value]) |
1532 | |
1754 | |
1533 | =item $max_scrollback = $term->saveLines |
1755 | =item $max_scrollback = $term->saveLines ([$new_value]) |
1534 | |
1756 | |
1535 | =item $nrow_plus_saveLines = $term->total_rows |
1757 | =item $nrow_plus_saveLines = $term->total_rows ([$new_value]) |
1536 | |
1758 | |
1537 | =item $topmost_scrollback_row = $term->top_row |
1759 | =item $topmost_scrollback_row = $term->top_row ([$new_value]) |
1538 | |
1760 | |
1539 | Return various integers describing terminal characteristics. |
1761 | Return various integers describing terminal characteristics. If an |
|
|
1762 | argument is given, changes the value and returns the previous one. |
1540 | |
1763 | |
1541 | =item $x_display = $term->display_id |
1764 | =item $x_display = $term->display_id |
1542 | |
1765 | |
1543 | Return the DISPLAY used by rxvt-unicode. |
1766 | Return the DISPLAY used by rxvt-unicode. |
1544 | |
1767 | |
… | |
… | |
1581 | |
1804 | |
1582 | =item $cursor_is_hidden = $term->hidden_cursor |
1805 | =item $cursor_is_hidden = $term->hidden_cursor |
1583 | |
1806 | |
1584 | Returns whether the cursor is currently hidden or not. |
1807 | Returns whether the cursor is currently hidden or not. |
1585 | |
1808 | |
|
|
1809 | =item $priv_modes = $term->priv_modes |
|
|
1810 | |
|
|
1811 | Returns a bitset with the state of DEC private modes. |
|
|
1812 | |
|
|
1813 | Example: |
|
|
1814 | |
|
|
1815 | if ($term->priv_modes & urxvt::PrivMode_mouse_report) { |
|
|
1816 | # mouse reporting is turned on |
|
|
1817 | } |
|
|
1818 | |
1586 | =item $view_start = $term->view_start ([$newvalue]) |
1819 | =item $view_start = $term->view_start ([$newvalue]) |
1587 | |
1820 | |
1588 | Returns the row number of the topmost displayed line. Maximum value is |
1821 | Returns the row number of the topmost displayed line and changes it, |
1589 | C<0>, which displays the normal terminal contents. Lower values scroll |
1822 | if an argument is given. Values greater than or equal to C<0> display |
1590 | this many lines into the scrollback buffer. |
1823 | the terminal contents. Lower values scroll this many lines into the |
|
|
1824 | scrollback buffer. |
1591 | |
1825 | |
1592 | =item $term->want_refresh |
1826 | =item $term->want_refresh |
1593 | |
1827 | |
1594 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1828 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1595 | compare the on-screen display with its stored representation. If they |
1829 | compare the on-screen display with its stored representation. If they |
1596 | differ, it redraws the differences. |
1830 | differ, it redraws the differences. |
1597 | |
1831 | |
1598 | Used after changing terminal contents to display them. |
1832 | Used after changing terminal contents to display them. |
|
|
1833 | |
|
|
1834 | =item $term->refresh_check |
|
|
1835 | |
|
|
1836 | Checks if a refresh has been requested and, if so, schedules one. |
1599 | |
1837 | |
1600 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1838 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1601 | |
1839 | |
1602 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1840 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1603 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1841 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
… | |
… | |
1649 | |
1887 | |
1650 | Create and return a new C<urxvt::line> object that stores information |
1888 | Create and return a new C<urxvt::line> object that stores information |
1651 | about the logical line that row C<$row_number> is part of. It supports the |
1889 | about the logical line that row C<$row_number> is part of. It supports the |
1652 | following methods: |
1890 | following methods: |
1653 | |
1891 | |
1654 | =over 4 |
1892 | =over |
1655 | |
1893 | |
1656 | =item $text = $line->t ([$new_text]) |
1894 | =item $text = $line->t ([$new_text]) |
1657 | |
1895 | |
1658 | Returns or replaces the full text of the line, similar to C<ROW_t> |
1896 | Returns or replaces the full text of the line, similar to C<ROW_t> |
1659 | |
1897 | |
… | |
… | |
1705 | } |
1943 | } |
1706 | |
1944 | |
1707 | sub urxvt::line::t { |
1945 | sub urxvt::line::t { |
1708 | my ($self) = @_; |
1946 | my ($self) = @_; |
1709 | |
1947 | |
1710 | if (@_ > 1) |
1948 | if (@_ > 1) { |
1711 | { |
|
|
1712 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1949 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1713 | for $self->{beg} .. $self->{end}; |
1950 | for $self->{beg} .. $self->{end}; |
1714 | } |
1951 | } |
1715 | |
1952 | |
1716 | defined wantarray && |
1953 | defined wantarray && |
1717 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1954 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1718 | 0, $self->{len} |
1955 | 0, $self->{len} |
1719 | } |
1956 | } |
1720 | |
1957 | |
1721 | sub urxvt::line::r { |
1958 | sub urxvt::line::r { |
1722 | my ($self) = @_; |
1959 | my ($self) = @_; |
1723 | |
1960 | |
1724 | if (@_ > 1) |
1961 | if (@_ > 1) { |
1725 | { |
|
|
1726 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1962 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1727 | for $self->{beg} .. $self->{end}; |
1963 | for $self->{beg} .. $self->{end}; |
1728 | } |
1964 | } |
1729 | |
1965 | |
1730 | if (defined wantarray) { |
1966 | if (defined wantarray) { |
1731 | my $rend = [ |
1967 | my $rend = [ |
1732 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1968 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1733 | ]; |
1969 | ]; |
… | |
… | |
1765 | where one character corresponds to one screen cell. See |
2001 | where one character corresponds to one screen cell. See |
1766 | C<< $term->ROW_t >> for details. |
2002 | C<< $term->ROW_t >> for details. |
1767 | |
2003 | |
1768 | =item $string = $term->special_decode $text |
2004 | =item $string = $term->special_decode $text |
1769 | |
2005 | |
1770 | Converts rxvt-unicodes text representation into a perl string. See |
2006 | Converts rxvt-unicode's text representation into a perl string. See |
1771 | C<< $term->ROW_t >> for details. |
2007 | C<< $term->ROW_t >> for details. |
1772 | |
2008 | |
1773 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
2009 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1774 | |
2010 | |
1775 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
2011 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1795 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
2031 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1796 | recent grab. |
2032 | recent grab. |
1797 | |
2033 | |
1798 | =item $term->ungrab |
2034 | =item $term->ungrab |
1799 | |
2035 | |
1800 | Calls XUngrab for the most recent grab. Is called automatically on |
2036 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
1801 | evaluation errors, as it is better to lose the grab in the error case as |
2037 | evaluation errors, as it is better to lose the grab in the error case as |
1802 | the session. |
2038 | the session. |
1803 | |
2039 | |
1804 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
2040 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1805 | |
2041 | |
… | |
… | |
1807 | |
2043 | |
1808 | =item @atoms = $term->XListProperties ($window) |
2044 | =item @atoms = $term->XListProperties ($window) |
1809 | |
2045 | |
1810 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
2046 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1811 | |
2047 | |
1812 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
2048 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
1813 | |
2049 | |
1814 | =item $term->XDeleteProperty ($window, $property) |
2050 | =item $term->XDeleteProperty ($window, $property) |
1815 | |
2051 | |
1816 | =item $window = $term->DefaultRootWindow |
2052 | =item $window = $term->DefaultRootWindow |
1817 | |
2053 | |
… | |
… | |
1824 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
2060 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
1825 | |
2061 | |
1826 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
2062 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1827 | |
2063 | |
1828 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
2064 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
2065 | |
|
|
2066 | =item $keysym = $term->XStringToKeysym ($string) |
|
|
2067 | |
|
|
2068 | =item $string = $term->XKeysymToString ($keysym) |
1829 | |
2069 | |
1830 | Various X or X-related functions. The C<$term> object only serves as |
2070 | Various X or X-related functions. The C<$term> object only serves as |
1831 | the source of the display, otherwise those functions map more-or-less |
2071 | the source of the display, otherwise those functions map more-or-less |
1832 | directory onto the X functions of the same name. |
2072 | directly onto the X functions of the same name. |
1833 | |
2073 | |
1834 | =back |
2074 | =back |
1835 | |
2075 | |
1836 | =cut |
2076 | =cut |
1837 | |
2077 | |
1838 | package urxvt::popup; |
2078 | package urxvt::popup; |
1839 | |
2079 | |
1840 | =head2 The C<urxvt::popup> Class |
2080 | =head2 The C<urxvt::popup> Class |
1841 | |
2081 | |
1842 | =over 4 |
2082 | =over |
1843 | |
2083 | |
1844 | =cut |
2084 | =cut |
1845 | |
2085 | |
1846 | sub add_item { |
2086 | sub add_item { |
1847 | my ($self, $item) = @_; |
2087 | my ($self, $item) = @_; |
… | |
… | |
1983 | ->cb (sub { |
2223 | ->cb (sub { |
1984 | $term->{overlay}->set (0, 0, |
2224 | $term->{overlay}->set (0, 0, |
1985 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2225 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1986 | }); |
2226 | }); |
1987 | |
2227 | |
1988 | =over 4 |
2228 | =over |
1989 | |
2229 | |
1990 | =item $timer = new urxvt::timer |
2230 | =item $timer = new urxvt::timer |
1991 | |
2231 | |
1992 | Create a new timer object in started state. It is scheduled to fire |
2232 | Create a new timer object in started state. It is scheduled to fire |
1993 | immediately. |
2233 | immediately. |
1994 | |
2234 | |
1995 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2235 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
1996 | |
2236 | |
1997 | Set the callback to be called when the timer triggers. |
2237 | Set the callback to be called when the timer triggers. |
1998 | |
2238 | |
1999 | =item $tstamp = $timer->at |
|
|
2000 | |
|
|
2001 | Return the time this watcher will fire next. |
|
|
2002 | |
|
|
2003 | =item $timer = $timer->set ($tstamp) |
2239 | =item $timer = $timer->set ($tstamp[, $interval]) |
2004 | |
2240 | |
2005 | Set the time the event is generated to $tstamp. |
2241 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2242 | new $interval). |
2006 | |
2243 | |
2007 | =item $timer = $timer->interval ($interval) |
2244 | =item $timer = $timer->interval ($interval) |
2008 | |
2245 | |
2009 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2246 | By default (and when C<$interval> is C<0>), the timer will automatically |
2010 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2247 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2011 | is automatically rescheduled at the given intervals. |
2248 | is automatically rescheduled at the given intervals. |
2012 | |
2249 | |
2013 | =item $timer = $timer->start |
2250 | =item $timer = $timer->start |
2014 | |
2251 | |
2015 | Start the timer. |
2252 | Start the timer. |
2016 | |
2253 | |
2017 | =item $timer = $timer->start ($tstamp) |
2254 | =item $timer = $timer->start ($tstamp[, $interval]) |
2018 | |
2255 | |
2019 | Set the event trigger time to C<$tstamp> and start the timer. |
2256 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2257 | also replaces the interval. |
2020 | |
2258 | |
2021 | =item $timer = $timer->after ($delay) |
2259 | =item $timer = $timer->after ($delay[, $interval]) |
2022 | |
2260 | |
2023 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2261 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2024 | |
2262 | |
2025 | =item $timer = $timer->stop |
2263 | =item $timer = $timer->stop |
2026 | |
2264 | |
… | |
… | |
2044 | sysread $term->{socket}, my $buf, 8192 |
2282 | sysread $term->{socket}, my $buf, 8192 |
2045 | or end-of-file; |
2283 | or end-of-file; |
2046 | }); |
2284 | }); |
2047 | |
2285 | |
2048 | |
2286 | |
2049 | =over 4 |
2287 | =over |
2050 | |
2288 | |
2051 | =item $iow = new urxvt::iow |
2289 | =item $iow = new urxvt::iow |
2052 | |
2290 | |
2053 | Create a new io watcher object in stopped state. |
2291 | Create a new io watcher object in stopped state. |
2054 | |
2292 | |
… | |
… | |
2081 | |
2319 | |
2082 | This class implements idle watchers, that get called automatically when |
2320 | This class implements idle watchers, that get called automatically when |
2083 | the process is idle. They should return as fast as possible, after doing |
2321 | the process is idle. They should return as fast as possible, after doing |
2084 | some useful work. |
2322 | some useful work. |
2085 | |
2323 | |
2086 | =over 4 |
2324 | =over |
2087 | |
2325 | |
2088 | =item $iw = new urxvt::iw |
2326 | =item $iw = new urxvt::iw |
2089 | |
2327 | |
2090 | Create a new idle watcher object in stopped state. |
2328 | Create a new idle watcher object in stopped state. |
2091 | |
2329 | |
… | |
… | |
2116 | ->cb (sub { |
2354 | ->cb (sub { |
2117 | my ($pw, $exit_status) = @_; |
2355 | my ($pw, $exit_status) = @_; |
2118 | ... |
2356 | ... |
2119 | }); |
2357 | }); |
2120 | |
2358 | |
2121 | =over 4 |
2359 | =over |
2122 | |
2360 | |
2123 | =item $pw = new urxvt::pw |
2361 | =item $pw = new urxvt::pw |
2124 | |
2362 | |
2125 | Create a new process watcher in stopped state. |
2363 | Create a new process watcher in stopped state. |
2126 | |
2364 | |
… | |
… | |
2143 | =head2 URXVT_PERL_VERBOSITY |
2381 | =head2 URXVT_PERL_VERBOSITY |
2144 | |
2382 | |
2145 | This variable controls the verbosity level of the perl extension. Higher |
2383 | This variable controls the verbosity level of the perl extension. Higher |
2146 | numbers indicate more verbose output. |
2384 | numbers indicate more verbose output. |
2147 | |
2385 | |
2148 | =over 4 |
2386 | =over |
2149 | |
2387 | |
2150 | =item == 0 - fatal messages |
2388 | =item == 0 - fatal messages only |
|
|
2389 | |
|
|
2390 | =item >= 2 - general warnings (default level) |
2151 | |
2391 | |
2152 | =item >= 3 - script loading and management |
2392 | =item >= 3 - script loading and management |
2153 | |
2393 | |
2154 | =item >=10 - all called hooks |
2394 | =item >=10 - all called hooks |
2155 | |
2395 | |
… | |
… | |
2157 | |
2397 | |
2158 | =back |
2398 | =back |
2159 | |
2399 | |
2160 | =head1 AUTHOR |
2400 | =head1 AUTHOR |
2161 | |
2401 | |
2162 | Marc Lehmann <pcg@goof.com> |
2402 | Marc Lehmann <schmorp@schmorp.de> |
2163 | http://software.schmorp.de/pkg/rxvt-unicode |
2403 | http://software.schmorp.de/pkg/rxvt-unicode |
2164 | |
2404 | |
2165 | =cut |
2405 | =cut |
2166 | |
2406 | |
2167 | 1 |
2407 | 1 |