1 | =encoding utf8 |
1 | =encoding utf8 |
2 | |
2 | |
3 | =head1 NAME |
3 | =head1 NAME |
4 | |
4 | |
5 | @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter |
5 | urxvtperl - rxvt-unicode's embedded perl interpreter |
6 | |
6 | |
7 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
8 | |
8 | |
9 | # create a file grab_test in $HOME: |
9 | # create a file grab_test in $HOME: |
10 | |
10 | |
11 | sub on_sel_grab { |
11 | sub on_sel_grab { |
12 | warn "you selected ", $_[0]->selection; |
12 | warn "you selected ", $_[0]->selection; |
13 | () |
13 | () |
14 | } |
14 | } |
15 | |
15 | |
16 | # start a @@RXVT_NAME@@ using it: |
16 | # start a urxvt using it: |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | urxvt --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Every time a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in urxvtd, where |
29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
30 | |
30 | |
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
32 | and "perl-ext-common" resources to the empty string. |
32 | and "perl-ext-common" resources to the empty string. |
33 | |
33 | |
34 | =head1 PREPACKAGED EXTENSIONS |
34 | =head1 PREPACKAGED EXTENSIONS |
35 | |
35 | |
36 | This section describes the extensions delivered with this release. You can |
36 | A number of extensions are delivered with this release. You can find them |
37 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
37 | in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using |
|
|
38 | F<< man urxvt-<EXTENSIONNAME> >>. |
38 | |
39 | |
39 | You can activate them like this: |
40 | You can activate them like this: |
40 | |
41 | |
41 | @@RXVT_NAME@@ -pe <extensionname> |
42 | urxvt -pe <extensionname> |
42 | |
43 | |
43 | Or by adding them to the resource for extensions loaded by default: |
44 | Or by adding them to the resource for extensions loaded by default: |
44 | |
45 | |
45 | URxvt.perl-ext-common: default,selection-autotransform |
46 | URxvt.perl-ext-common: default,selection-autotransform |
46 | |
47 | |
47 | =over 4 |
48 | Extensions may add additional resources and C<actions>, i.e., methods |
48 | |
49 | which can be bound to a key and invoked by the user. An extension can |
49 | =item selection (enabled by default) |
50 | define the resources it support 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 overlay-osc |
|
|
309 | |
|
|
310 | This extension implements some OSC commands to display timed popups on the |
|
|
311 | screen - useful for status displays from within scripts. You have to read |
|
|
312 | the sources for more info. |
|
|
313 | |
|
|
314 | =item block-graphics-to-ascii |
|
|
315 | |
|
|
316 | A not very useful example of filtering all text output to the terminal |
|
|
317 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
318 | similar-looking ascii character. |
|
|
319 | |
|
|
320 | =item digital-clock |
|
|
321 | |
|
|
322 | Displays a digital clock using the built-in overlay. |
|
|
323 | |
|
|
324 | =item remote-clipboard |
|
|
325 | |
|
|
326 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
327 | selection popup that allows one to run external commands to store the |
|
|
328 | selection somewhere and fetch it again. |
|
|
329 | |
|
|
330 | We use it to implement a "distributed selection mechanism", which just |
|
|
331 | means that one command uploads the file to a remote server, and another |
|
|
332 | reads it. |
|
|
333 | |
|
|
334 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
335 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
336 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
337 | the selection data on STDOUT (also in UTF-8). |
|
|
338 | |
|
|
339 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
340 | |
|
|
341 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
342 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
|
|
343 | |
|
|
344 | =item selection-pastebin |
|
|
345 | |
|
|
346 | This is a little rarely useful extension that uploads the selection as |
|
|
347 | textfile to a remote site (or does other things). (The implementation is |
|
|
348 | not currently secure for use in a multiuser environment as it writes to |
|
|
349 | F</tmp> directly.). |
|
|
350 | |
|
|
351 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
352 | i.e. |
|
|
353 | |
|
|
354 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
355 | |
|
|
356 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
357 | the textfile. This command can be set via a resource: |
|
|
358 | |
|
|
359 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
360 | |
|
|
361 | And the default is likely not useful to anybody but the few people around |
|
|
362 | here :) |
|
|
363 | |
|
|
364 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
365 | the same content should lead to the same filename. |
|
|
366 | |
|
|
367 | After a successful upload the selection will be replaced by the text given |
|
|
368 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
369 | for the filename): |
|
|
370 | |
|
|
371 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
372 | |
|
|
373 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
374 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
375 | which works regardless of whether xrdb is used to parse the resource file |
|
|
376 | or not. |
|
|
377 | |
|
|
378 | =item macosx-clipboard and macosx-clipboard-native |
|
|
379 | |
|
|
380 | These two modules implement an extended clipboard for Mac OS X. They are |
|
|
381 | used like this: |
|
|
382 | |
|
|
383 | URxvt.perl-ext-common: default,macosx-clipboard |
|
|
384 | URxvt.keysym.M-c: perl:macosx-clipboard:copy |
|
|
385 | URxvt.keysym.M-v: perl:macosx-clipboard:paste |
|
|
386 | |
|
|
387 | The difference between them is that the native variant requires a |
|
|
388 | perl from apple's devkit or so, and C<macosx-clipboard> requires the |
|
|
389 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
|
|
390 | simpler etc. etc. |
|
|
391 | |
|
|
392 | =item example-refresh-hooks |
|
|
393 | |
|
|
394 | Displays a very simple digital clock in the upper right corner of the |
|
|
395 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
396 | overlays or changes. |
|
|
397 | |
|
|
398 | =item confirm-paste |
|
|
399 | |
|
|
400 | Displays a confirmation dialog when a paste containing at least a full |
|
|
401 | line is detected. |
|
|
402 | |
|
|
403 | =back |
|
|
404 | |
56 | |
405 | =head1 API DOCUMENTATION |
57 | =head1 API DOCUMENTATION |
406 | |
58 | |
407 | =head2 General API Considerations |
59 | =head2 General API Considerations |
408 | |
60 | |
… | |
… | |
435 | |
87 | |
436 | =item $octets |
88 | =item $octets |
437 | |
89 | |
438 | 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 |
439 | locale-specific way. |
91 | locale-specific way. |
|
|
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>. |
440 | |
98 | |
441 | =back |
99 | =back |
442 | |
100 | |
443 | =head2 Extension Objects |
101 | =head2 Extension Objects |
444 | |
102 | |
… | |
… | |
451 | internal use. |
109 | internal use. |
452 | |
110 | |
453 | 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 |
454 | C<urxvt::term> class on this object. |
112 | C<urxvt::term> class on this object. |
455 | |
113 | |
456 | 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. |
|
|
116 | |
|
|
117 | =head2 META comments |
|
|
118 | |
|
|
119 | Rxvt-unicode recognizes special meta comments in extensions that define |
|
|
120 | different types of metadata. |
|
|
121 | |
|
|
122 | Currently, it recognises only one such comment: |
457 | |
123 | |
458 | =over 4 |
124 | =over 4 |
459 | |
125 | |
460 | =item $urxvt_term = $self->{term} |
126 | =item #:META:RESOURCE:name:type:desc |
461 | |
127 | |
462 | Returns the C<urxvt::term> object associated with this instance of the |
128 | The RESOURCE comment defines a resource used by the extension, where |
463 | extension. This member I<must not> be changed in any way. |
129 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
464 | |
130 | or C<string>, and C<desc> is the resource description. |
465 | =item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
466 | |
|
|
467 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
468 | this extension, replacing any previous hook. This is useful when you want |
|
|
469 | to overwrite time-critical hooks only temporarily. |
|
|
470 | |
|
|
471 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
472 | |
|
|
473 | Dynamically disable the given hooks. |
|
|
474 | |
131 | |
475 | =back |
132 | =back |
476 | |
133 | |
477 | =head2 Hooks |
134 | =head2 Hooks |
478 | |
135 | |
… | |
… | |
647 | |
304 | |
648 | =item on_refresh_end $term |
305 | =item on_refresh_end $term |
649 | |
306 | |
650 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
307 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
651 | |
308 | |
|
|
309 | =item on_action $term, $string |
|
|
310 | |
|
|
311 | Called whenever an action is invoked for the corresponding extension |
|
|
312 | (e.g. via a C<extension:string> builtin action bound to a key, see |
|
|
313 | description of the B<keysym> resource in the urxvt(1) manpage). The |
|
|
314 | event is simply the action string. Note that an action event is always |
|
|
315 | associated to a single extension. |
|
|
316 | |
652 | =item on_user_command $term, $string |
317 | =item on_user_command $term, $string *DEPRECATED* |
653 | |
318 | |
654 | Called whenever a user-configured event is being activated (e.g. via |
319 | Called whenever a user-configured event is being activated (e.g. via |
655 | a C<perl:string> action bound to a key, see description of the B<keysym> |
320 | a C<perl:string> action bound to a key, see description of the B<keysym> |
656 | resource in the @@RXVT_NAME@@(1) manpage). |
321 | resource in the urxvt(1) manpage). |
657 | |
322 | |
658 | The event is simply the action string. This interface is assumed to change |
323 | The event is simply the action string. This interface is going away in |
659 | slightly in the future. |
324 | preference to the C<on_action> hook. |
660 | |
325 | |
661 | =item on_resize_all_windows $term, $new_width, $new_height |
326 | =item on_resize_all_windows $term, $new_width, $new_height |
662 | |
327 | |
663 | Called just after the new window size has been calculated, but before |
328 | Called just after the new window size has been calculated, but before |
664 | windows are actually being resized or hints are being set. If this hook |
329 | windows are actually being resized or hints are being set. If this hook |
665 | returns TRUE, setting of the window hints is being skipped. |
330 | returns a true value, setting of the window hints is being skipped. |
666 | |
331 | |
667 | =item on_x_event $term, $event |
332 | =item on_x_event $term, $event |
668 | |
333 | |
669 | Called on every X event received on the vt window (and possibly other |
334 | Called on every X event received on the vt window (and possibly other |
670 | windows). Should only be used as a last resort. Most event structure |
335 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
710 | (real, not screen-based) row and column under the mouse cursor. |
375 | (real, not screen-based) row and column under the mouse cursor. |
711 | |
376 | |
712 | C<on_key_press> additionally receives the string rxvt-unicode would |
377 | C<on_key_press> additionally receives the string rxvt-unicode would |
713 | output, if any, in locale-specific encoding. |
378 | output, if any, in locale-specific encoding. |
714 | |
379 | |
715 | subwindow. |
|
|
716 | |
|
|
717 | =item on_client_message $term, $event |
380 | =item on_client_message $term, $event |
718 | |
381 | |
719 | =item on_wm_protocols $term, $event |
382 | =item on_wm_protocols $term, $event |
720 | |
383 | |
721 | =item on_wm_delete_window $term, $event |
384 | =item on_wm_delete_window $term, $event |
… | |
… | |
732 | =cut |
395 | =cut |
733 | |
396 | |
734 | package urxvt; |
397 | package urxvt; |
735 | |
398 | |
736 | use utf8; |
399 | use utf8; |
737 | use strict; |
400 | use strict 'vars'; |
738 | use Carp (); |
401 | use Carp (); |
739 | use Scalar::Util (); |
402 | use Scalar::Util (); |
740 | use List::Util (); |
403 | use List::Util (); |
741 | |
404 | |
742 | our $VERSION = 1; |
405 | our $VERSION = 1; |
743 | our $TERM; |
406 | our $TERM; |
744 | our @TERM_INIT; |
407 | our @TERM_INIT; # should go, prevents async I/O etc. |
745 | our @TERM_EXT; |
408 | our @TERM_EXT; # should go, prevents async I/O etc. |
746 | our @HOOKNAME; |
409 | our @HOOKNAME; |
747 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
410 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
748 | our %OPTION; |
411 | our %OPTION; |
749 | |
412 | |
750 | our $LIBDIR; |
413 | our $LIBDIR; |
… | |
… | |
920 | }; |
583 | }; |
921 | } |
584 | } |
922 | |
585 | |
923 | no warnings 'utf8'; |
586 | no warnings 'utf8'; |
924 | |
587 | |
|
|
588 | sub parse_resource { |
|
|
589 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
|
|
590 | |
|
|
591 | $term->scan_extensions; |
|
|
592 | |
|
|
593 | my $r = $term->{meta}{resource}; |
|
|
594 | keys %$r; # reset iterator |
|
|
595 | while (my ($k, $v) = each %$r) { |
|
|
596 | my $pattern = $k; |
|
|
597 | $pattern =~ y/./-/ if $isarg; |
|
|
598 | my $prefix = $name; |
|
|
599 | my $suffix; |
|
|
600 | if ($pattern =~ /\-$/) { |
|
|
601 | $prefix = substr $name, 0, length $pattern; |
|
|
602 | $suffix = substr $name, length $pattern; |
|
|
603 | } |
|
|
604 | if ($pattern eq $prefix) { |
|
|
605 | $name = "$urxvt::RESCLASS.$k$suffix"; |
|
|
606 | |
|
|
607 | push @{ $term->{perl_ext_3} }, $v->[0]; |
|
|
608 | |
|
|
609 | if ($v->[1] eq "boolean") { |
|
|
610 | $term->put_option_db ($name, $flag ? "true" : "false"); |
|
|
611 | return 1; |
|
|
612 | } else { |
|
|
613 | $term->put_option_db ($name, $value); |
|
|
614 | return 1 + 2; |
|
|
615 | } |
|
|
616 | } |
|
|
617 | } |
|
|
618 | |
|
|
619 | 0 |
|
|
620 | } |
|
|
621 | |
|
|
622 | sub usage { |
|
|
623 | my ($term, $usage_type) = @_; |
|
|
624 | |
|
|
625 | $term->scan_extensions; |
|
|
626 | |
|
|
627 | my $r = $term->{meta}{resource}; |
|
|
628 | |
|
|
629 | for my $pattern (sort keys %$r) { |
|
|
630 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
|
|
631 | |
|
|
632 | $desc .= " (-pe $ext)"; |
|
|
633 | |
|
|
634 | if ($usage_type == 1) { |
|
|
635 | $pattern =~ y/./-/; |
|
|
636 | $pattern =~ s/-$/-.../g; |
|
|
637 | |
|
|
638 | if ($type eq "boolean") { |
|
|
639 | urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc; |
|
|
640 | } else { |
|
|
641 | urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc; |
|
|
642 | } |
|
|
643 | } else { |
|
|
644 | $pattern =~ s/\.$/.*/g; |
|
|
645 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
|
|
646 | } |
|
|
647 | } |
|
|
648 | } |
|
|
649 | |
925 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
650 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
926 | |
651 | |
927 | sub verbose { |
652 | sub verbose { |
928 | my ($level, $msg) = @_; |
653 | my ($level, $msg) = @_; |
929 | warn "$msg\n" if $level <= $verbosity; |
654 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
941 | $pkg =~ s/[^[:word:]]/_/g; |
666 | $pkg =~ s/[^[:word:]]/_/g; |
942 | $pkg = "urxvt::ext::$pkg"; |
667 | $pkg = "urxvt::ext::$pkg"; |
943 | |
668 | |
944 | verbose 3, "loading extension '$path' into package '$pkg'"; |
669 | verbose 3, "loading extension '$path' into package '$pkg'"; |
945 | |
670 | |
|
|
671 | (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish |
|
|
672 | |
946 | open my $fh, "<:raw", $path |
673 | open my $fh, "<:raw", $path |
947 | or die "$path: $!"; |
674 | or die "$path: $!"; |
948 | |
675 | |
949 | my $source = |
676 | my $source = |
950 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
677 | "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n" |
951 | . "#line 1 \"$path\"\n{\n" |
678 | . "#line 1 \"$path\"\n{\n" |
952 | . (do { local $/; <$fh> }) |
679 | . (do { local $/; <$fh> }) |
953 | . "\n};\n1"; |
680 | . "\n};\n1"; |
954 | |
681 | |
955 | eval $source |
682 | eval $source |
… | |
… | |
964 | # called by the rxvt core |
691 | # called by the rxvt core |
965 | sub invoke { |
692 | sub invoke { |
966 | local $TERM = shift; |
693 | local $TERM = shift; |
967 | my $htype = shift; |
694 | my $htype = shift; |
968 | |
695 | |
969 | if ($htype == 0) { # INIT |
696 | if ($htype == HOOK_INIT) { |
970 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
697 | my @dirs = $TERM->perl_libdirs; |
|
|
698 | |
|
|
699 | $TERM->scan_extensions; |
971 | |
700 | |
972 | my %ext_arg; |
701 | my %ext_arg; |
973 | |
702 | |
974 | { |
703 | { |
975 | my @init = @TERM_INIT; |
704 | my @init = @TERM_INIT; |
… | |
… | |
978 | my @pkg = @TERM_EXT; |
707 | my @pkg = @TERM_EXT; |
979 | @TERM_EXT = (); |
708 | @TERM_EXT = (); |
980 | $TERM->register_package ($_) for @pkg; |
709 | $TERM->register_package ($_) for @pkg; |
981 | } |
710 | } |
982 | |
711 | |
|
|
712 | for ( |
983 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
713 | (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2), |
|
|
714 | @{ delete $TERM->{perl_ext_3} } |
|
|
715 | ) { |
984 | if ($_ eq "default") { |
716 | if ($_ eq "default") { |
|
|
717 | |
|
|
718 | $ext_arg{$_} = [] |
985 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
719 | for qw(selection option-popup selection-popup readline searchable-scrollback); |
|
|
720 | |
|
|
721 | for ($TERM->_keysym_resources) { |
|
|
722 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
|
|
723 | next unless /^([A-Za-z0-9_\-]+):/; |
|
|
724 | |
|
|
725 | my $ext = $1; |
|
|
726 | |
|
|
727 | $ext_arg{$ext} = []; |
|
|
728 | } |
|
|
729 | |
986 | } elsif (/^-(.*)$/) { |
730 | } elsif (/^-(.*)$/) { |
987 | delete $ext_arg{$1}; |
731 | delete $ext_arg{$1}; |
|
|
732 | |
988 | } elsif (/^([^<]+)<(.*)>$/) { |
733 | } elsif (/^([^<]+)<(.*)>$/) { |
989 | push @{ $ext_arg{$1} }, $2; |
734 | push @{ $ext_arg{$1} }, $2; |
|
|
735 | |
990 | } else { |
736 | } else { |
991 | $ext_arg{$_} ||= []; |
737 | $ext_arg{$_} ||= []; |
992 | } |
738 | } |
993 | } |
739 | } |
994 | |
740 | |
… | |
… | |
1010 | |
756 | |
1011 | if (my $cb = $TERM->{_hook}[$htype]) { |
757 | if (my $cb = $TERM->{_hook}[$htype]) { |
1012 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
758 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
1013 | if $verbosity >= 10; |
759 | if $verbosity >= 10; |
1014 | |
760 | |
|
|
761 | if ($htype == HOOK_ACTION) { |
|
|
762 | # this hook is only sent to the extension with the name |
|
|
763 | # matching the first arg |
|
|
764 | my $pkg = shift; |
|
|
765 | $pkg =~ y/-/_/; |
|
|
766 | $pkg = "urxvt::ext::$pkg"; |
|
|
767 | |
|
|
768 | $cb = $cb->{$pkg} |
|
|
769 | or return undef; #TODO: maybe warn user? |
|
|
770 | |
|
|
771 | $cb = { $pkg => $cb }; |
|
|
772 | } |
|
|
773 | |
1015 | for my $pkg (keys %$cb) { |
774 | for my $pkg (keys %$cb) { |
1016 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
775 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
1017 | $retval ||= $retval_; |
776 | $retval ||= $retval_; |
1018 | |
777 | |
1019 | if ($@) { |
778 | if ($@) { |
1020 | $TERM->ungrab; # better to lose the grab than the session |
779 | $TERM->ungrab; # better to lose the grab than the session |
1021 | warn $@; |
780 | warn $@; |
… | |
… | |
1024 | |
783 | |
1025 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
784 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
1026 | if $verbosity >= 11; |
785 | if $verbosity >= 11; |
1027 | } |
786 | } |
1028 | |
787 | |
1029 | if ($htype == 1) { # DESTROY |
788 | if ($htype == HOOK_DESTROY) { |
1030 | # clear package objects |
789 | # clear package objects |
1031 | %$_ = () for values %{ $TERM->{_pkg} }; |
790 | %$_ = () for values %{ $TERM->{_pkg} }; |
1032 | |
791 | |
1033 | # clear package |
792 | # clear package |
1034 | %$TERM = (); |
793 | %$TERM = (); |
… | |
… | |
1064 | } |
823 | } |
1065 | } |
824 | } |
1066 | ($mask, @color{qw(fg bg)}, \@failed) |
825 | ($mask, @color{qw(fg bg)}, \@failed) |
1067 | } |
826 | } |
1068 | |
827 | |
1069 | # urxvt::term::extension |
|
|
1070 | |
|
|
1071 | package urxvt::term::extension; |
828 | package urxvt::term::extension; |
1072 | |
829 | |
1073 | sub enable { |
830 | =head2 The C<urxvt::term::extension> class |
1074 | my ($self, %hook) = @_; |
|
|
1075 | my $pkg = $self->{_pkg}; |
|
|
1076 | |
831 | |
1077 | while (my ($name, $cb) = each %hook) { |
832 | Each extension attached to a terminal object is represented by |
1078 | my $htype = $HOOKTYPE{uc $name}; |
833 | a C<urxvt::term::extension> object. |
1079 | defined $htype |
|
|
1080 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1081 | |
834 | |
1082 | $self->set_should_invoke ($htype, +1) |
835 | You can use these objects, which are passed to all callbacks to store any |
1083 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
836 | state related to the terminal and extension instance. |
1084 | |
837 | |
1085 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
838 | The methods (And data members) documented below can be called on extension |
1086 | } |
839 | objects, in addition to call methods documented for the <urxvt::term> |
1087 | } |
840 | class. |
1088 | |
841 | |
1089 | sub disable { |
842 | =over 4 |
1090 | my ($self, @hook) = @_; |
|
|
1091 | my $pkg = $self->{_pkg}; |
|
|
1092 | |
843 | |
1093 | for my $name (@hook) { |
844 | =item $urxvt_term = $self->{term} |
1094 | my $htype = $HOOKTYPE{uc $name}; |
|
|
1095 | defined $htype |
|
|
1096 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1097 | |
845 | |
1098 | $self->set_should_invoke ($htype, -1) |
846 | Returns the C<urxvt::term> object associated with this instance of the |
1099 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
847 | extension. This member I<must not> be changed in any way. |
1100 | } |
848 | |
1101 | } |
849 | =cut |
1102 | |
850 | |
1103 | our $AUTOLOAD; |
851 | our $AUTOLOAD; |
1104 | |
852 | |
1105 | sub AUTOLOAD { |
853 | sub AUTOLOAD { |
1106 | $AUTOLOAD =~ /:([^:]+)$/ |
854 | $AUTOLOAD =~ /:([^:]+)$/ |
… | |
… | |
1119 | |
867 | |
1120 | sub DESTROY { |
868 | sub DESTROY { |
1121 | # nop |
869 | # nop |
1122 | } |
870 | } |
1123 | |
871 | |
1124 | # urxvt::destroy_hook |
872 | # urxvt::destroy_hook (basically a cheap Guard:: implementation) |
1125 | |
873 | |
1126 | sub urxvt::destroy_hook::DESTROY { |
874 | sub urxvt::destroy_hook::DESTROY { |
1127 | ${$_[0]}->(); |
875 | ${$_[0]}->(); |
1128 | } |
876 | } |
1129 | |
877 | |
1130 | sub urxvt::destroy_hook(&) { |
878 | sub urxvt::destroy_hook(&) { |
1131 | bless \shift, urxvt::destroy_hook:: |
879 | bless \shift, urxvt::destroy_hook:: |
1132 | } |
880 | } |
|
|
881 | |
|
|
882 | =item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
883 | |
|
|
884 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
885 | this extension, replacing any hook previously installed via C<enable> in |
|
|
886 | this extension. |
|
|
887 | |
|
|
888 | This is useful when you want to overwrite time-critical hooks only |
|
|
889 | temporarily. |
|
|
890 | |
|
|
891 | To install additional callbacks for the same hook, you can use the C<on> |
|
|
892 | method of the C<urxvt::term> class. |
|
|
893 | |
|
|
894 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
895 | |
|
|
896 | Dynamically disable the given hooks. |
|
|
897 | |
|
|
898 | =cut |
|
|
899 | |
|
|
900 | sub enable { |
|
|
901 | my ($self, %hook) = @_; |
|
|
902 | my $pkg = $self->{_pkg}; |
|
|
903 | |
|
|
904 | while (my ($name, $cb) = each %hook) { |
|
|
905 | my $htype = $HOOKTYPE{uc $name}; |
|
|
906 | defined $htype |
|
|
907 | or Carp::croak "unsupported hook type '$name'"; |
|
|
908 | |
|
|
909 | $self->set_should_invoke ($htype, +1) |
|
|
910 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
|
|
911 | |
|
|
912 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
913 | } |
|
|
914 | } |
|
|
915 | |
|
|
916 | sub disable { |
|
|
917 | my ($self, @hook) = @_; |
|
|
918 | my $pkg = $self->{_pkg}; |
|
|
919 | |
|
|
920 | for my $name (@hook) { |
|
|
921 | my $htype = $HOOKTYPE{uc $name}; |
|
|
922 | defined $htype |
|
|
923 | or Carp::croak "unsupported hook type '$name'"; |
|
|
924 | |
|
|
925 | $self->set_should_invoke ($htype, -1) |
|
|
926 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
|
|
927 | } |
|
|
928 | } |
|
|
929 | |
|
|
930 | =item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
931 | |
|
|
932 | Similar to the C<enable> enable, but installs additional callbacks for |
|
|
933 | the given hook(s) (that is, it doesn't replace existing callbacks), and |
|
|
934 | returns a guard object. When the guard object is destroyed the callbacks |
|
|
935 | are disabled again. |
|
|
936 | |
|
|
937 | =cut |
|
|
938 | |
|
|
939 | sub urxvt::extension::on_disable::DESTROY { |
|
|
940 | my $disable = shift; |
|
|
941 | |
|
|
942 | my $term = delete $disable->{""}; |
|
|
943 | |
|
|
944 | while (my ($htype, $id) = each %$disable) { |
|
|
945 | delete $term->{_hook}[$htype]{$id}; |
|
|
946 | $term->set_should_invoke ($htype, -1); |
|
|
947 | } |
|
|
948 | } |
|
|
949 | |
|
|
950 | sub on { |
|
|
951 | my ($self, %hook) = @_; |
|
|
952 | |
|
|
953 | my $term = $self->{term}; |
|
|
954 | |
|
|
955 | my %disable = ( "" => $term ); |
|
|
956 | |
|
|
957 | while (my ($name, $cb) = each %hook) { |
|
|
958 | my $htype = $HOOKTYPE{uc $name}; |
|
|
959 | defined $htype |
|
|
960 | or Carp::croak "unsupported hook type '$name'"; |
|
|
961 | |
|
|
962 | $term->set_should_invoke ($htype, +1); |
|
|
963 | $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 } |
|
|
964 | = sub { shift; $cb->($self, @_) }; # very ugly indeed |
|
|
965 | } |
|
|
966 | |
|
|
967 | bless \%disable, "urxvt::extension::on_disable" |
|
|
968 | } |
|
|
969 | |
|
|
970 | =item $self->bind_action ($hotkey, $action) |
|
|
971 | |
|
|
972 | =item $self->x_resource ($pattern) |
|
|
973 | |
|
|
974 | =item $self->x_resource_boolean ($pattern) |
|
|
975 | |
|
|
976 | These methods support an additional C<%> prefix for C<$action> or |
|
|
977 | C<$pattern> when called on an extension object, compared to the |
|
|
978 | C<urxvt::term> methods of the same name - see the description of these |
|
|
979 | methods in the C<urxvt::term> class for details. |
|
|
980 | |
|
|
981 | =cut |
|
|
982 | |
|
|
983 | sub bind_action { |
|
|
984 | my ($self, $hotkey, $action) = @_; |
|
|
985 | $action =~ s/^%:/$_[0]{_name}:/; |
|
|
986 | $self->{term}->bind_action ($hotkey, $action) |
|
|
987 | } |
|
|
988 | |
|
|
989 | sub x_resource { |
|
|
990 | my ($self, $name) = @_; |
|
|
991 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
992 | $self->{term}->x_resource ($name) |
|
|
993 | } |
|
|
994 | |
|
|
995 | sub x_resource_boolean { |
|
|
996 | my ($self, $name) = @_; |
|
|
997 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
998 | $self->{term}->x_resource_boolean ($name) |
|
|
999 | } |
|
|
1000 | |
|
|
1001 | =back |
|
|
1002 | |
|
|
1003 | =cut |
1133 | |
1004 | |
1134 | package urxvt::anyevent; |
1005 | package urxvt::anyevent; |
1135 | |
1006 | |
1136 | =head2 The C<urxvt::anyevent> Class |
1007 | =head2 The C<urxvt::anyevent> Class |
1137 | |
1008 | |
1138 | The sole purpose of this class is to deliver an interface to the |
1009 | The sole purpose of this class is to deliver an interface to the |
1139 | C<AnyEvent> module - any module using it will work inside urxvt without |
1010 | C<AnyEvent> module - any module using it will work inside urxvt without |
1140 | further programming. The only exception is that you cannot wait on |
1011 | further programming. The only exception is that you cannot wait on |
1141 | condition variables, but non-blocking condvar use is ok. What this means |
1012 | condition variables, but non-blocking condvar use is ok. |
1142 | is that you cannot use blocking APIs, but the non-blocking variant should |
1013 | |
1143 | work. |
1014 | In practical terms this means is that you cannot use blocking APIs, but |
|
|
1015 | the non-blocking variant should work. |
1144 | |
1016 | |
1145 | =cut |
1017 | =cut |
1146 | |
1018 | |
1147 | our $VERSION = '5.23'; |
1019 | our $VERSION = '5.23'; |
1148 | |
1020 | |
… | |
… | |
1207 | |
1079 | |
1208 | sub DESTROY { |
1080 | sub DESTROY { |
1209 | $_[0][1]->stop; |
1081 | $_[0][1]->stop; |
1210 | } |
1082 | } |
1211 | |
1083 | |
|
|
1084 | # only needed for AnyEvent < 6 compatibility |
1212 | sub one_event { |
1085 | sub one_event { |
1213 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1086 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1214 | } |
1087 | } |
1215 | |
1088 | |
1216 | package urxvt::term; |
1089 | package urxvt::term; |
… | |
… | |
1231 | urxvt::verbose 6, "register package $pkg to $self"; |
1104 | urxvt::verbose 6, "register package $pkg to $self"; |
1232 | |
1105 | |
1233 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
1106 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
1234 | |
1107 | |
1235 | my $proxy = bless { |
1108 | my $proxy = bless { |
1236 | _pkg => $pkg, |
1109 | _pkg => $pkg, |
|
|
1110 | _name => ${"$pkg\::_NAME"}, # hackish |
1237 | argv => $argv, |
1111 | argv => $argv, |
1238 | }, $pkg; |
1112 | }, $pkg; |
1239 | Scalar::Util::weaken ($proxy->{term} = $self); |
1113 | Scalar::Util::weaken ($proxy->{term} = $self); |
1240 | |
1114 | |
1241 | $self->{_pkg}{$pkg} = $proxy; |
1115 | $self->{_pkg}{$pkg} = $proxy; |
1242 | |
1116 | |
… | |
… | |
1245 | $proxy->enable ($name => $ref); |
1119 | $proxy->enable ($name => $ref); |
1246 | } |
1120 | } |
1247 | } |
1121 | } |
1248 | } |
1122 | } |
1249 | |
1123 | |
|
|
1124 | sub perl_libdirs { |
|
|
1125 | map { split /:/ } |
|
|
1126 | $_[0]->resource ("perl_lib"), |
|
|
1127 | $ENV{URXVT_PERL_LIB}, |
|
|
1128 | "$ENV{HOME}/.urxvt/ext", |
|
|
1129 | "$LIBDIR/perl" |
|
|
1130 | } |
|
|
1131 | |
|
|
1132 | # scan for available extensions and collect their metadata |
|
|
1133 | sub scan_extensions { |
|
|
1134 | my ($self) = @_; |
|
|
1135 | |
|
|
1136 | return if exists $self->{meta}; |
|
|
1137 | |
|
|
1138 | my @urxvtdirs = perl_libdirs $self; |
|
|
1139 | # my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; |
|
|
1140 | |
|
|
1141 | $self->{meta} = \my %meta; |
|
|
1142 | |
|
|
1143 | # first gather extensions |
|
|
1144 | |
|
|
1145 | my $gather = sub { |
|
|
1146 | my ($dir, $core) = @_; |
|
|
1147 | |
|
|
1148 | opendir my $fh, $dir |
|
|
1149 | or return; |
|
|
1150 | |
|
|
1151 | for my $ext (readdir $fh) { |
|
|
1152 | $ext !~ /^\./ |
|
|
1153 | or next; |
|
|
1154 | |
|
|
1155 | open my $fh, "<", "$dir/$ext" |
|
|
1156 | or next; |
|
|
1157 | |
|
|
1158 | -f $fh |
|
|
1159 | or next; |
|
|
1160 | |
|
|
1161 | $ext =~ s/\.uext$// or $core |
|
|
1162 | or next; |
|
|
1163 | |
|
|
1164 | my %ext = (dir => $dir); |
|
|
1165 | |
|
|
1166 | while (<$fh>) { |
|
|
1167 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
|
|
1168 | my ($pattern, $type, $desc) = split /:/, $1; |
|
|
1169 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
|
|
1170 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
|
|
1171 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
|
|
1172 | } else { |
|
|
1173 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
|
|
1174 | } |
|
|
1175 | } elsif (/^\s*(?:#|$)/) { |
|
|
1176 | # skip other comments and empty lines |
|
|
1177 | } else { |
|
|
1178 | last; # stop parsing on first non-empty non-comment line |
|
|
1179 | } |
|
|
1180 | } |
|
|
1181 | |
|
|
1182 | $meta{ext}{$ext} = \%ext; |
|
|
1183 | } |
|
|
1184 | }; |
|
|
1185 | |
|
|
1186 | # $gather->($_, 0) for @cpandirs; |
|
|
1187 | $gather->($_, 1) for @urxvtdirs; |
|
|
1188 | |
|
|
1189 | # and now merge resources |
|
|
1190 | |
|
|
1191 | $meta{resource} = \my %resource; |
|
|
1192 | |
|
|
1193 | while (my ($k, $v) = each %{ $meta{ext} }) { |
|
|
1194 | #TODO: should check for extensions overriding each other |
|
|
1195 | %resource = (%resource, %{ $v->{resource} }); |
|
|
1196 | } |
|
|
1197 | } |
|
|
1198 | |
1250 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1199 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1251 | |
1200 | |
1252 | Creates a new terminal, very similar as if you had started it with system |
1201 | Creates a new terminal, very similar as if you had started it with system |
1253 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
1202 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
1254 | hash which defines the environment of the new terminal. |
1203 | hash which defines the environment of the new terminal. |
… | |
… | |
1271 | } |
1220 | } |
1272 | |
1221 | |
1273 | =item $term->destroy |
1222 | =item $term->destroy |
1274 | |
1223 | |
1275 | Destroy the terminal object (close the window, free resources |
1224 | Destroy the terminal object (close the window, free resources |
1276 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1225 | etc.). Please note that urxvt will not exit as long as any event |
1277 | watchers (timers, io watchers) are still active. |
1226 | watchers (timers, io watchers) are still active. |
1278 | |
1227 | |
1279 | =item $term->exec_async ($cmd[, @args]) |
1228 | =item $term->exec_async ($cmd[, @args]) |
1280 | |
1229 | |
1281 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
1230 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
… | |
… | |
1308 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1257 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1309 | |
1258 | |
1310 | Here is a likely non-exhaustive list of option names, please see the |
1259 | Here is a likely non-exhaustive list of option names, please see the |
1311 | source file F</src/optinc.h> to see the actual list: |
1260 | source file F</src/optinc.h> to see the actual list: |
1312 | |
1261 | |
1313 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1262 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
1314 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1263 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1315 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1264 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1316 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
1265 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1317 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
1266 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1318 | transparent tripleclickwords utmpInhibit visualBell |
1267 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
|
|
1268 | urgentOnBell utmpInhibit visualBell |
1319 | |
1269 | |
1320 | =item $value = $term->resource ($name[, $newval]) |
1270 | =item $value = $term->resource ($name[, $newval]) |
1321 | |
1271 | |
1322 | Returns the current resource value associated with a given name and |
1272 | Returns the current resource value associated with a given name and |
1323 | optionally sets a new value. Setting values is most useful in the C<init> |
1273 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
1336 | |
1286 | |
1337 | Here is a likely non-exhaustive list of resource names, not all of which |
1287 | Here is a likely non-exhaustive list of resource names, not all of which |
1338 | are supported in every build, please see the source file F</src/rsinc.h> |
1288 | are supported in every build, please see the source file F</src/rsinc.h> |
1339 | to see the actual list: |
1289 | to see the actual list: |
1340 | |
1290 | |
1341 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1291 | answerbackstring backgroundPixmap backspace_key blurradius |
1342 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1292 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1343 | display_name embed ext_bwidth fade font geometry hold iconName |
1293 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1344 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1294 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
1345 | italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 |
1295 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
|
|
1296 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1346 | modifier mouseWheelScrollPage name override_redirect pastableTabs path |
1297 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1347 | perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1298 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1348 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1299 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1349 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1300 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1350 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1301 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1351 | secondaryScreen secondaryScroll shade term_name title |
1302 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1352 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1303 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1353 | visualBell |
1304 | utmpInhibit visualBell |
1354 | |
1305 | |
1355 | =cut |
1306 | =cut |
1356 | |
1307 | |
1357 | sub resource($$;$) { |
1308 | sub resource($$;$) { |
1358 | my ($self, $name) = (shift, shift); |
1309 | my ($self, $name) = (shift, shift); |
… | |
… | |
1365 | Returns the X-Resource for the given pattern, excluding the program or |
1316 | Returns the X-Resource for the given pattern, excluding the program or |
1366 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1317 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1367 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1318 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1368 | resource with that pattern exists. |
1319 | resource with that pattern exists. |
1369 | |
1320 | |
|
|
1321 | Extensions that define extra resources also need to call this method |
|
|
1322 | to access their values. |
|
|
1323 | |
|
|
1324 | If the method is called on an extension object (basically, from an |
|
|
1325 | extension), then the special prefix C<%.> will be replaced by the name of |
|
|
1326 | the extension and a dot, and the lone string C<%> will be replaced by the |
|
|
1327 | extension name itself. This makes it possible to code extensions so you |
|
|
1328 | can rename them and get a new set of resources without having to change |
|
|
1329 | the actual code. |
|
|
1330 | |
1370 | This method should only be called during the C<on_start> hook, as there is |
1331 | This method should only be called during the C<on_start> hook, as there is |
1371 | only one resource database per display, and later invocations might return |
1332 | only one resource database per display, and later invocations might return |
1372 | the wrong resources. |
1333 | the wrong resources. |
1373 | |
1334 | |
1374 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
1335 | =item $value = $term->x_resource_boolean ($pattern) |
1375 | |
1336 | |
|
|
1337 | Like C<x_resource>, above, but interprets the string value as a boolean |
|
|
1338 | and returns C<1> for true values, C<0> for false values and C<undef> if |
|
|
1339 | the resource or option isn't specified. |
|
|
1340 | |
|
|
1341 | You should always use this method to parse boolean resources. |
|
|
1342 | |
|
|
1343 | =cut |
|
|
1344 | |
|
|
1345 | sub x_resource_boolean { |
|
|
1346 | my $res = &x_resource; |
|
|
1347 | |
|
|
1348 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
|
|
1349 | } |
|
|
1350 | |
|
|
1351 | =item $success = $term->bind_action ($key, $action) |
|
|
1352 | |
1376 | Adds a keymap translation exactly as specified via a resource. See the |
1353 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1377 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1354 | C<keysym> resource in the urxvt(1) manpage. |
|
|
1355 | |
|
|
1356 | To add default bindings for actions, an extension should call C<< |
|
|
1357 | ->bind_action >> in its C<init> hook for every such binding. Doing it |
|
|
1358 | in the C<init> hook allows users to override or remove the binding |
|
|
1359 | again. |
|
|
1360 | |
|
|
1361 | Example: the C<searchable-scrollback> by default binds itself |
|
|
1362 | on C<Meta-s>, using C<< $self->bind_action >>, which calls C<< |
|
|
1363 | $term->bind_action >>. |
|
|
1364 | |
|
|
1365 | sub init { |
|
|
1366 | my ($self) = @_; |
|
|
1367 | |
|
|
1368 | $self->bind_action ("M-s" => "%:start"); |
|
|
1369 | } |
1378 | |
1370 | |
1379 | =item $rend = $term->rstyle ([$new_rstyle]) |
1371 | =item $rend = $term->rstyle ([$new_rstyle]) |
1380 | |
1372 | |
1381 | Return and optionally change the current rendition. Text that is output by |
1373 | Return and optionally change the current rendition. Text that is output by |
1382 | the terminal application will use this style. |
1374 | the terminal application will use this style. |
… | |
… | |
1540 | |
1532 | |
1541 | =item $term->scr_add_lines ($string) |
1533 | =item $term->scr_add_lines ($string) |
1542 | |
1534 | |
1543 | Write the given text string to the screen, as if output by the application |
1535 | Write the given text string to the screen, as if output by the application |
1544 | running inside the terminal. It may not contain command sequences (escape |
1536 | running inside the terminal. It may not contain command sequences (escape |
1545 | codes), but is free to use line feeds, carriage returns and tabs. The |
1537 | codes - see C<cmd_parse> for that), but is free to use line feeds, |
1546 | string is a normal text string, not in locale-dependent encoding. |
1538 | carriage returns and tabs. The string is a normal text string, not in |
|
|
1539 | locale-dependent encoding. |
1547 | |
1540 | |
1548 | Normally its not a good idea to use this function, as programs might be |
1541 | Normally its not a good idea to use this function, as programs might be |
1549 | confused by changes in cursor position or scrolling. Its useful inside a |
1542 | confused by changes in cursor position or scrolling. Its useful inside a |
1550 | C<on_add_lines> hook, though. |
1543 | C<on_add_lines> hook, though. |
1551 | |
1544 | |
… | |
… | |
1559 | locale-specific encoding of the terminal and can contain command sequences |
1552 | locale-specific encoding of the terminal and can contain command sequences |
1560 | (escape codes) that will be interpreted. |
1553 | (escape codes) that will be interpreted. |
1561 | |
1554 | |
1562 | =item $term->tt_write ($octets) |
1555 | =item $term->tt_write ($octets) |
1563 | |
1556 | |
1564 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1557 | Write the octets given in C<$octets> to the tty (i.e. as user input |
|
|
1558 | to the program, see C<cmd_parse> for the opposite direction). To pass |
1565 | pass characters instead of octets, you should convert your strings first |
1559 | characters instead of octets, you should convert your strings first to the |
1566 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1560 | locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1561 | |
|
|
1562 | =item $term->tt_write_user_input ($octets) |
|
|
1563 | |
|
|
1564 | Like C<tt_write>, but should be used when writing strings in response to |
|
|
1565 | the user pressing a key, to invoke the additional actions requested by |
|
|
1566 | the user for that case (C<tt_write> doesn't do that). |
|
|
1567 | |
|
|
1568 | The typical use case would be inside C<on_action> hooks. |
1567 | |
1569 | |
1568 | =item $term->tt_paste ($octets) |
1570 | =item $term->tt_paste ($octets) |
1569 | |
1571 | |
1570 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
1572 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
1571 | CR and bracketing the data with control sequences if bracketed paste mode |
1573 | CR and bracketing the data with control sequences if bracketed paste mode |
… | |
… | |
1596 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1598 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1597 | to receive pointer events all the times: |
1599 | to receive pointer events all the times: |
1598 | |
1600 | |
1599 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1601 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1600 | |
1602 | |
|
|
1603 | =item $term->set_urgency ($set) |
|
|
1604 | |
|
|
1605 | Enable/disable the urgency hint on the toplevel window. |
|
|
1606 | |
1601 | =item $term->focus_in |
1607 | =item $term->focus_in |
1602 | |
1608 | |
1603 | =item $term->focus_out |
1609 | =item $term->focus_out |
1604 | |
1610 | |
1605 | =item $term->key_press ($state, $keycode[, $time]) |
1611 | =item $term->key_press ($state, $keycode[, $time]) |
… | |
… | |
1690 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1696 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1691 | compare the on-screen display with its stored representation. If they |
1697 | compare the on-screen display with its stored representation. If they |
1692 | differ, it redraws the differences. |
1698 | differ, it redraws the differences. |
1693 | |
1699 | |
1694 | Used after changing terminal contents to display them. |
1700 | Used after changing terminal contents to display them. |
|
|
1701 | |
|
|
1702 | =item $term->refresh_check |
|
|
1703 | |
|
|
1704 | Checks if a refresh has been requested and, if so, schedules one. |
1695 | |
1705 | |
1696 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1706 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1697 | |
1707 | |
1698 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1708 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1699 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1709 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
… | |
… | |
1801 | } |
1811 | } |
1802 | |
1812 | |
1803 | sub urxvt::line::t { |
1813 | sub urxvt::line::t { |
1804 | my ($self) = @_; |
1814 | my ($self) = @_; |
1805 | |
1815 | |
1806 | if (@_ > 1) |
1816 | if (@_ > 1) { |
1807 | { |
|
|
1808 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1817 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1809 | for $self->{beg} .. $self->{end}; |
1818 | for $self->{beg} .. $self->{end}; |
1810 | } |
1819 | } |
1811 | |
1820 | |
1812 | defined wantarray && |
1821 | defined wantarray && |
1813 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1822 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1814 | 0, $self->{len} |
1823 | 0, $self->{len} |
1815 | } |
1824 | } |
1816 | |
1825 | |
1817 | sub urxvt::line::r { |
1826 | sub urxvt::line::r { |
1818 | my ($self) = @_; |
1827 | my ($self) = @_; |
1819 | |
1828 | |
1820 | if (@_ > 1) |
1829 | if (@_ > 1) { |
1821 | { |
|
|
1822 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1830 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1823 | for $self->{beg} .. $self->{end}; |
1831 | for $self->{beg} .. $self->{end}; |
1824 | } |
1832 | } |
1825 | |
1833 | |
1826 | if (defined wantarray) { |
1834 | if (defined wantarray) { |
1827 | my $rend = [ |
1835 | my $rend = [ |
1828 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1836 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1829 | ]; |
1837 | ]; |
… | |
… | |
1920 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
1928 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
1921 | |
1929 | |
1922 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1930 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1923 | |
1931 | |
1924 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1932 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1933 | |
|
|
1934 | =item $keysym = $term->XStringToKeysym ($string) |
|
|
1935 | |
|
|
1936 | =item $string = $term->XKeysymToString ($keysym) |
1925 | |
1937 | |
1926 | Various X or X-related functions. The C<$term> object only serves as |
1938 | Various X or X-related functions. The C<$term> object only serves as |
1927 | the source of the display, otherwise those functions map more-or-less |
1939 | the source of the display, otherwise those functions map more-or-less |
1928 | directly onto the X functions of the same name. |
1940 | directly onto the X functions of the same name. |
1929 | |
1941 | |