… | |
… | |
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 @@RXVT_NAME@@d, 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<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be vewiwed |
|
|
38 | using 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 | @@RXVT_NAME@@ -pe <extensionname> |
42 | |
43 | |
43 | Or by adding them to the resource for extensions loaded by default: |
44 | Or by adding them to the resource for extensions loaded by default: |
44 | |
45 | |
45 | URxvt.perl-ext-common: default,selection-autotransform |
46 | URxvt.perl-ext-common: default,selection-autotransform |
46 | |
47 | |
47 | =over 4 |
48 | Extensions that add command line parameters or resources on their own are |
48 | |
49 | laoded automatically when used. |
49 | =item selection (enabled by default) |
|
|
50 | |
|
|
51 | (More) intelligent selection. This extension tries to be more intelligent |
|
|
52 | when the user extends selections (double-click and further clicks). Right |
|
|
53 | now, it tries to select words, urls and complete shell-quoted |
|
|
54 | arguments, which is very convenient, too, if your F<ls> supports |
|
|
55 | C<--quoting-style=shell>. |
|
|
56 | |
|
|
57 | A double-click usually selects the word under the cursor, further clicks |
|
|
58 | will enlarge the selection. |
|
|
59 | |
|
|
60 | The selection works by trying to match a number of regexes and displaying |
|
|
61 | them in increasing order of length. You can add your own regexes by |
|
|
62 | specifying resources of the form: |
|
|
63 | |
|
|
64 | URxvt.selection.pattern-0: perl-regex |
|
|
65 | URxvt.selection.pattern-1: perl-regex |
|
|
66 | ... |
|
|
67 | |
|
|
68 | The index number (0, 1...) must not have any holes, and each regex must |
|
|
69 | contain at least one pair of capturing parentheses, which will be used for |
|
|
70 | the match. For example, the following adds a regex that matches everything |
|
|
71 | between two vertical bars: |
|
|
72 | |
|
|
73 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
74 | |
|
|
75 | Another example: Programs I use often output "absolute path: " at the |
|
|
76 | beginning of a line when they process multiple files. The following |
|
|
77 | pattern matches the filename (note, there is a single space at the very |
|
|
78 | end): |
|
|
79 | |
|
|
80 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
|
|
81 | |
|
|
82 | You can look at the source of the selection extension to see more |
|
|
83 | interesting uses, such as parsing a line from beginning to end. |
|
|
84 | |
|
|
85 | This extension also offers following bindable keyboard commands: |
|
|
86 | |
|
|
87 | =over 4 |
|
|
88 | |
|
|
89 | =item rot13 |
|
|
90 | |
|
|
91 | Rot-13 the selection when activated. Used via keyboard trigger: |
|
|
92 | |
|
|
93 | URxvt.keysym.C-M-r: perl:selection:rot13 |
|
|
94 | |
|
|
95 | =back |
|
|
96 | |
|
|
97 | =item option-popup (enabled by default) |
|
|
98 | |
|
|
99 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
|
|
100 | runtime. |
|
|
101 | |
|
|
102 | Other extensions can extend this popup menu by pushing a code reference |
|
|
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
104 | popup is being displayed. |
|
|
105 | |
|
|
106 | Its sole argument is the popup menu, which can be modified. It should |
|
|
107 | either return nothing or a string, the initial boolean value and a code |
|
|
108 | reference. The string will be used as button text and the code reference |
|
|
109 | will be called when the toggle changes, with the new boolean value as |
|
|
110 | first argument. |
|
|
111 | |
|
|
112 | The following will add an entry C<myoption> that changes |
|
|
113 | C<< $self->{myoption} >>: |
|
|
114 | |
|
|
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
117 | }; |
|
|
118 | |
|
|
119 | =item selection-popup (enabled by default) |
|
|
120 | |
|
|
121 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
122 | text into various other formats/action (such as uri unescaping, perl |
|
|
123 | evaluation, web-browser starting etc.), depending on content. |
|
|
124 | |
|
|
125 | Other extensions can extend this popup menu by pushing a code reference |
|
|
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
|
|
127 | popup is being displayed. |
|
|
128 | |
|
|
129 | Its sole argument is the popup menu, which can be modified. The selection |
|
|
130 | is in C<$_>, which can be used to decide whether to add something or not. |
|
|
131 | It should either return nothing or a string and a code reference. The |
|
|
132 | string will be used as button text and the code reference will be called |
|
|
133 | when the button gets activated and should transform C<$_>. |
|
|
134 | |
|
|
135 | The following will add an entry C<a to b> that transforms all C<a>s in |
|
|
136 | the selection to C<b>s, but only if the selection currently contains any |
|
|
137 | C<a>s: |
|
|
138 | |
|
|
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
140 | /a/ ? ("a to b" => sub { s/a/b/g } |
|
|
141 | : () |
|
|
142 | }; |
|
|
143 | |
|
|
144 | =item searchable-scrollback<hotkey> (enabled by default) |
|
|
145 | |
|
|
146 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
147 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
|
|
148 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
149 | screen. |
|
|
150 | |
|
|
151 | Inputting characters appends them to the regex and continues incremental |
|
|
152 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
|
|
153 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
|
|
154 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
155 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
156 | additionally stores the first match in the current line into the primary |
|
|
157 | selection if the C<Shift> modifier is active. |
|
|
158 | |
|
|
159 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
|
|
160 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
|
|
161 | or simply use an uppercase character which removes the "(?i)" prefix. |
|
|
162 | |
|
|
163 | See L<perlre> for more info about perl regular expression syntax. |
|
|
164 | |
|
|
165 | =item readline (enabled by default) |
|
|
166 | |
|
|
167 | A support package that tries to make editing with readline easier. At |
|
|
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
|
|
169 | move the text cursor to this position. It does so by generating as many |
|
|
170 | cursor-left or cursor-right keypresses as required (this only works |
|
|
171 | for programs that correctly support wide characters). |
|
|
172 | |
|
|
173 | To avoid too many false positives, this is only done when: |
|
|
174 | |
|
|
175 | =over 4 |
|
|
176 | |
|
|
177 | =item - the tty is in ICANON state. |
|
|
178 | |
|
|
179 | =item - the text cursor is visible. |
|
|
180 | |
|
|
181 | =item - the primary screen is currently being displayed. |
|
|
182 | |
|
|
183 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
184 | |
|
|
185 | =back |
|
|
186 | |
|
|
187 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
188 | might interfere with selection creation in harmless ways. |
|
|
189 | |
|
|
190 | =item selection-autotransform |
|
|
191 | |
|
|
192 | This selection allows you to do automatic transforms on a selection |
|
|
193 | whenever a selection is made. |
|
|
194 | |
|
|
195 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
196 | operator) that modify C<$_> as resources: |
|
|
197 | |
|
|
198 | URxvt.selection-autotransform.0: transform |
|
|
199 | URxvt.selection-autotransform.1: transform |
|
|
200 | ... |
|
|
201 | |
|
|
202 | For example, the following will transform selections of the form |
|
|
203 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
204 | $word>: |
|
|
205 | |
|
|
206 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
207 | |
|
|
208 | And this example matches the same,but replaces it with vi-commands you can |
|
|
209 | paste directly into your (vi :) editor: |
|
|
210 | |
|
|
211 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
212 | |
|
|
213 | Of course, this can be modified to suit your needs and your editor :) |
|
|
214 | |
|
|
215 | To expand the example above to typical perl error messages ("XXX at |
|
|
216 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
217 | |
|
|
218 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
219 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
220 | |
|
|
221 | The first line tells the selection code to treat the unchanging part of |
|
|
222 | every error message as a selection pattern, and the second line transforms |
|
|
223 | the message into vi commands to load the file. |
|
|
224 | |
|
|
225 | =item tabbed |
|
|
226 | |
|
|
227 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
228 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
|
|
229 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
230 | button per tab. |
|
|
231 | |
|
|
232 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
233 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
234 | while B<Shift-Down> creates a new tab. |
|
|
235 | |
|
|
236 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
237 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
238 | following four resources (shown with defaults): |
|
|
239 | |
|
|
240 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
241 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
242 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
243 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
244 | |
|
|
245 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
246 | indices. |
|
|
247 | |
|
|
248 | =item matcher |
|
|
249 | |
|
|
250 | Uses per-line display filtering (C<on_line_update>) to underline text |
|
|
251 | matching a certain pattern and make it clickable. When clicked with the |
|
|
252 | mouse button specified in the C<matcher.button> resource (default 2, or |
|
|
253 | middle), the program specified in the C<matcher.launcher> resource |
|
|
254 | (default, the C<urlLauncher> resource, C<sensible-browser>) will be started |
|
|
255 | with the matched text as first argument. The default configuration is |
|
|
256 | suitable for matching URLs and launching a web browser, like the |
|
|
257 | former "mark-urls" extension. |
|
|
258 | |
|
|
259 | The default pattern to match URLs can be overridden with the |
|
|
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
|
|
261 | with numbered patterns, in a manner similar to the "selection" extension. |
|
|
262 | The launcher can also be overridden on a per-pattern basis. |
|
|
263 | |
|
|
264 | It is possible to activate the most recently seen match from the keyboard. |
|
|
265 | Simply bind a keysym to "perl:matcher" as seen in the example below. |
|
|
266 | |
|
|
267 | Example configuration: |
|
|
268 | |
|
|
269 | URxvt.perl-ext: default,matcher |
|
|
270 | URxvt.urlLauncher: sensible-browser |
|
|
271 | URxvt.keysym.C-Delete: perl:matcher |
|
|
272 | URxvt.matcher.button: 1 |
|
|
273 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
274 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
275 | URxvt.matcher.launcher.2: gvim +$2 $1 |
|
|
276 | |
|
|
277 | =item xim-onthespot |
|
|
278 | |
|
|
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
280 | not work perfectly, and some input methods don't seem to work well with |
|
|
281 | OnTheSpot editing in general, but it seems to work at least for SCIM and |
|
|
282 | kinput2. |
|
|
283 | |
|
|
284 | You enable it by specifying this extension and a preedit style of |
|
|
285 | C<OnTheSpot>, i.e.: |
|
|
286 | |
|
|
287 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
288 | |
|
|
289 | =item kuake<hotkey> |
|
|
290 | |
|
|
291 | A very primitive quake-console-like extension. It was inspired by a |
|
|
292 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
293 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
294 | will show or hide itself. Another press of the accelerator key will hide |
|
|
295 | or show it again. |
|
|
296 | |
|
|
297 | Initially, the window will not be shown when using this extension. |
|
|
298 | |
|
|
299 | This is useful if you need a single terminal that is not using any desktop |
|
|
300 | space most of the time but is quickly available at the press of a key. |
|
|
301 | |
|
|
302 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
303 | extension will actually grab a physical key just for this function. |
|
|
304 | |
|
|
305 | If you want a quake-like animation, tell your window manager to do so |
|
|
306 | (fvwm can do it). |
|
|
307 | |
|
|
308 | =item overlay-osc |
|
|
309 | |
|
|
310 | This extension implements some OSC commands to display timed popups on the |
|
|
311 | screen - useful for status displays from within scripts. You have to read |
|
|
312 | the sources for more info. |
|
|
313 | |
|
|
314 | =item block-graphics-to-ascii |
|
|
315 | |
|
|
316 | A not very useful example of filtering all text output to the terminal |
|
|
317 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
318 | similar-looking ascii character. |
|
|
319 | |
|
|
320 | =item digital-clock |
|
|
321 | |
|
|
322 | Displays a digital clock using the built-in overlay. |
|
|
323 | |
|
|
324 | =item remote-clipboard |
|
|
325 | |
|
|
326 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
327 | selection popup that allows one to run external commands to store the |
|
|
328 | selection somewhere and fetch it again. |
|
|
329 | |
|
|
330 | We use it to implement a "distributed selection mechanism", which just |
|
|
331 | means that one command uploads the file to a remote server, and another |
|
|
332 | reads it. |
|
|
333 | |
|
|
334 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
335 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
336 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
337 | the selection data on STDOUT (also in UTF-8). |
|
|
338 | |
|
|
339 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
340 | |
|
|
341 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
342 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
|
|
343 | |
|
|
344 | =item selection-pastebin |
|
|
345 | |
|
|
346 | This is a little rarely useful extension that Uploads the selection as |
|
|
347 | textfile to a remote site (or does other things). (The implementation is |
|
|
348 | not currently secure for use in a multiuser environment as it writes to |
|
|
349 | F</tmp> directly.). |
|
|
350 | |
|
|
351 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
352 | i.e. |
|
|
353 | |
|
|
354 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
355 | |
|
|
356 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
357 | the textfile. This command can be set via a resource: |
|
|
358 | |
|
|
359 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
360 | |
|
|
361 | And the default is likely not useful to anybody but the few people around |
|
|
362 | here :) |
|
|
363 | |
|
|
364 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
365 | the same content should lead to the same filename. |
|
|
366 | |
|
|
367 | After a successful upload the selection will be replaced by the text given |
|
|
368 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
369 | for the filename): |
|
|
370 | |
|
|
371 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
372 | |
|
|
373 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
374 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
375 | which works regardless of wether xrdb is used to parse the resource file |
|
|
376 | or not. |
|
|
377 | |
|
|
378 | =item macosx-pastebin and macosx-pastebin-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<maxosx-pastebin> 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 | =back |
|
|
399 | |
50 | |
400 | =head1 API DOCUMENTATION |
51 | =head1 API DOCUMENTATION |
401 | |
52 | |
402 | =head2 General API Considerations |
53 | =head2 General API Considerations |
403 | |
54 | |
… | |
… | |
417 | |
68 | |
418 | =over 4 |
69 | =over 4 |
419 | |
70 | |
420 | =item $text |
71 | =item $text |
421 | |
72 | |
422 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
73 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
423 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
74 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
424 | |
75 | |
425 | =item $string |
76 | =item $string |
426 | |
77 | |
427 | A perl text string, with an emphasis on I<text>. It can store all unicode |
78 | A perl text string, with an emphasis on I<text>. It can store all unicode |
… | |
… | |
431 | =item $octets |
82 | =item $octets |
432 | |
83 | |
433 | Either binary data or - more common - a text string encoded in a |
84 | Either binary data or - more common - a text string encoded in a |
434 | locale-specific way. |
85 | locale-specific way. |
435 | |
86 | |
|
|
87 | =item $keysym |
|
|
88 | |
|
|
89 | an integer that is a valid X11 keysym code. You can convert a string |
|
|
90 | into a keysym and viceversa by using C<XStringToKeysym> and |
|
|
91 | C<XKeysymToString>. |
|
|
92 | |
436 | =back |
93 | =back |
437 | |
94 | |
438 | =head2 Extension Objects |
95 | =head2 Extension Objects |
439 | |
96 | |
440 | Every perl extension is a perl class. A separate perl object is created |
97 | Every perl extension is a perl class. A separate perl object is created |
441 | for each terminal, and each terminal has its own set of extenion objects, |
98 | for each terminal, and each terminal has its own set of extension objects, |
442 | which are passed as the first parameter to hooks. So extensions can use |
99 | which are passed as the first parameter to hooks. So extensions can use |
443 | their C<$self> object without having to think about clashes with other |
100 | their C<$self> object without having to think about clashes with other |
444 | extensions or other terminals, with the exception of methods and members |
101 | extensions or other terminals, with the exception of methods and members |
445 | that begin with an underscore character C<_>: these are reserved for |
102 | that begin with an underscore character C<_>: these are reserved for |
446 | internal use. |
103 | internal use. |
… | |
… | |
610 | =item on_tt_write $term, $octets |
267 | =item on_tt_write $term, $octets |
611 | |
268 | |
612 | Called whenever some data is written to the tty/pty and can be used to |
269 | Called whenever some data is written to the tty/pty and can be used to |
613 | suppress or filter tty input. |
270 | suppress or filter tty input. |
614 | |
271 | |
|
|
272 | =item on_tt_paste $term, $octets |
|
|
273 | |
|
|
274 | Called whenever text is about to be pasted, with the text as argument. You |
|
|
275 | can filter/change and paste the text yourself by returning a true value |
|
|
276 | and calling C<< $term->tt_paste >> yourself. C<$octets> is |
|
|
277 | locale-encoded. |
|
|
278 | |
615 | =item on_line_update $term, $row |
279 | =item on_line_update $term, $row |
616 | |
280 | |
617 | Called whenever a line was updated or changed. Can be used to filter |
281 | Called whenever a line was updated or changed. Can be used to filter |
618 | screen output (e.g. underline urls or other useless stuff). Only lines |
282 | screen output (e.g. underline urls or other useless stuff). Only lines |
619 | that are being shown will be filtered, and, due to performance reasons, |
283 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
644 | resource in the @@RXVT_NAME@@(1) manpage). |
308 | resource in the @@RXVT_NAME@@(1) manpage). |
645 | |
309 | |
646 | The event is simply the action string. This interface is assumed to change |
310 | The event is simply the action string. This interface is assumed to change |
647 | slightly in the future. |
311 | slightly in the future. |
648 | |
312 | |
|
|
313 | =item on_register_command $term, $keysym, $modifiermask, $string |
|
|
314 | |
|
|
315 | Called after parsing a keysym resource but before registering the |
|
|
316 | associated binding. If this hook returns TRUE the binding is not |
|
|
317 | registered. It can be used to modify a binding by calling |
|
|
318 | C<register_command>. |
|
|
319 | |
649 | =item on_resize_all_windows $tern, $new_width, $new_height |
320 | =item on_resize_all_windows $term, $new_width, $new_height |
650 | |
321 | |
651 | Called just after the new window size has been calculated, but before |
322 | Called just after the new window size has been calculated, but before |
652 | windows are actually being resized or hints are being set. If this hook |
323 | windows are actually being resized or hints are being set. If this hook |
653 | returns TRUE, setting of the window hints is being skipped. |
324 | returns TRUE, setting of the window hints is being skipped. |
654 | |
325 | |
… | |
… | |
688 | |
359 | |
689 | =item on_map_notify $term, $event |
360 | =item on_map_notify $term, $event |
690 | |
361 | |
691 | =item on_unmap_notify $term, $event |
362 | =item on_unmap_notify $term, $event |
692 | |
363 | |
693 | Called whenever the corresponding X event is received for the terminal If |
364 | Called whenever the corresponding X event is received for the terminal. If |
694 | the hook returns true, then the even will be ignored by rxvt-unicode. |
365 | the hook returns true, then the event will be ignored by rxvt-unicode. |
695 | |
366 | |
696 | The event is a hash with most values as named by Xlib (see the XEvent |
367 | The event is a hash with most values as named by Xlib (see the XEvent |
697 | manpage), with the additional members C<row> and C<col>, which are the |
368 | manpage), with the additional members C<row> and C<col>, which are the |
698 | (real, not screen-based) row and column under the mouse cursor. |
369 | (real, not screen-based) row and column under the mouse cursor. |
699 | |
370 | |
… | |
… | |
709 | =item on_wm_delete_window $term, $event |
380 | =item on_wm_delete_window $term, $event |
710 | |
381 | |
711 | Called when various types of ClientMessage events are received (all with |
382 | Called when various types of ClientMessage events are received (all with |
712 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
383 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
713 | |
384 | |
|
|
385 | =item on_bell $term |
|
|
386 | |
|
|
387 | Called on receipt of a bell character. |
|
|
388 | |
714 | =back |
389 | =back |
715 | |
390 | |
716 | =cut |
391 | =cut |
717 | |
392 | |
718 | package urxvt; |
393 | package urxvt; |
719 | |
394 | |
720 | use utf8; |
395 | use utf8; |
721 | use strict; |
396 | use strict 'vars'; |
722 | use Carp (); |
397 | use Carp (); |
723 | use Scalar::Util (); |
398 | use Scalar::Util (); |
724 | use List::Util (); |
399 | use List::Util (); |
725 | |
400 | |
726 | our $VERSION = 1; |
401 | our $VERSION = 1; |
727 | our $TERM; |
402 | our $TERM; |
728 | our @TERM_INIT; |
403 | our @TERM_INIT; # should go, prevents async I/O etc. |
729 | our @TERM_EXT; |
404 | our @TERM_EXT; # should go, prevents async I/O etc. |
730 | our @HOOKNAME; |
405 | our @HOOKNAME; |
731 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
406 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
732 | our %OPTION; |
407 | our %OPTION; |
733 | |
408 | |
734 | our $LIBDIR; |
409 | our $LIBDIR; |
… | |
… | |
782 | |
457 | |
783 | =over 4 |
458 | =over 4 |
784 | |
459 | |
785 | =item urxvt::fatal $errormessage |
460 | =item urxvt::fatal $errormessage |
786 | |
461 | |
787 | Fatally aborts execution with the given error message. Avoid at all |
462 | Fatally aborts execution with the given error message (which should |
788 | costs! The only time this is acceptable is when the terminal process |
463 | include a trailing newline). Avoid at all costs! The only time this |
789 | starts up. |
464 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
465 | terminal from starting up. |
790 | |
466 | |
791 | =item urxvt::warn $string |
467 | =item urxvt::warn $string |
792 | |
468 | |
793 | Calls C<rxvt_warn> with the given string which should not include a |
469 | Calls C<rxvt_warn> with the given string which should include a trailing |
794 | newline. The module also overwrites the C<warn> builtin with a function |
470 | newline. The module also overwrites the C<warn> builtin with a function |
795 | that calls this function. |
471 | that calls this function. |
796 | |
472 | |
797 | Using this function has the advantage that its output ends up in the |
473 | Using this function has the advantage that its output ends up in the |
798 | correct place, e.g. on stderr of the connecting urxvtc client. |
474 | correct place, e.g. on stderr of the connecting urxvtc client. |
… | |
… | |
802 | =item @terms = urxvt::termlist |
478 | =item @terms = urxvt::termlist |
803 | |
479 | |
804 | Returns all urxvt::term objects that exist in this process, regardless of |
480 | Returns all urxvt::term objects that exist in this process, regardless of |
805 | whether they are started, being destroyed etc., so be careful. Only term |
481 | whether they are started, being destroyed etc., so be careful. Only term |
806 | objects that have perl extensions attached will be returned (because there |
482 | objects that have perl extensions attached will be returned (because there |
807 | is no urxvt::term objet associated with others). |
483 | is no urxvt::term object associated with others). |
808 | |
484 | |
809 | =item $time = urxvt::NOW |
485 | =item $time = urxvt::NOW |
810 | |
486 | |
811 | Returns the "current time" (as per the event loop). |
487 | Returns the "current time" (as per the event loop). |
812 | |
488 | |
… | |
… | |
855 | |
531 | |
856 | =item $rend = urxvt::OVERLAY_RSTYLE |
532 | =item $rend = urxvt::OVERLAY_RSTYLE |
857 | |
533 | |
858 | Return the rendition mask used for overlays by default. |
534 | Return the rendition mask used for overlays by default. |
859 | |
535 | |
860 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
536 | =item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, |
|
|
537 | urxvt::RS_RVid, urxvt::RS_Uline |
861 | |
538 | |
862 | Return the bit that enabled bold, italic, blink, reverse-video and |
539 | Return the bit that enabled bold, italic, blink, reverse-video and |
863 | underline, respectively. To enable such a style, just logically OR it into |
540 | underline, respectively. To enable such a style, just logically OR it into |
864 | the bitset. |
541 | the bitset. |
865 | |
542 | |
… | |
… | |
902 | }; |
579 | }; |
903 | } |
580 | } |
904 | |
581 | |
905 | no warnings 'utf8'; |
582 | no warnings 'utf8'; |
906 | |
583 | |
|
|
584 | sub parse_resource { |
|
|
585 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
|
|
586 | |
|
|
587 | $name =~ y/-/./ if $isarg; |
|
|
588 | |
|
|
589 | $term->scan_meta; |
|
|
590 | |
|
|
591 | my $r = $term->{meta}{resource}; |
|
|
592 | keys %$r; # reste iterator |
|
|
593 | while (my ($pattern, $v) = each %$r) { |
|
|
594 | if ( |
|
|
595 | $pattern =~ /\.$/ |
|
|
596 | ? $pattern eq substr $name, 0, length $pattern |
|
|
597 | : $pattern eq $name |
|
|
598 | ) { |
|
|
599 | $name = "$urxvt::RESCLASS.$name"; |
|
|
600 | |
|
|
601 | push @{ $term->{perl_ext_3} }, $v->[0]; |
|
|
602 | |
|
|
603 | if ($v->[1] eq "boolean") { |
|
|
604 | $term->put_option_db ($name, $flag ? "true" : "false"); |
|
|
605 | return 1; |
|
|
606 | } else { |
|
|
607 | $term->put_option_db ($name, $value); |
|
|
608 | return 1 + 2; |
|
|
609 | } |
|
|
610 | } |
|
|
611 | } |
|
|
612 | |
|
|
613 | 0 |
|
|
614 | } |
|
|
615 | |
|
|
616 | sub usage { |
|
|
617 | my ($term, $usage_type) = @_; |
|
|
618 | |
|
|
619 | $term->scan_meta; |
|
|
620 | |
|
|
621 | my $r = $term->{meta}{resource}; |
|
|
622 | |
|
|
623 | for my $pattern (sort keys %$r) { |
|
|
624 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
|
|
625 | |
|
|
626 | $desc .= " (-pe $ext)"; |
|
|
627 | |
|
|
628 | if ($usage_type == 1) { |
|
|
629 | $pattern =~ y/./-/; |
|
|
630 | $pattern =~ s/-$/-.../g; |
|
|
631 | |
|
|
632 | if ($type eq "boolean") { |
|
|
633 | urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc; |
|
|
634 | } else { |
|
|
635 | urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc; |
|
|
636 | } |
|
|
637 | } else { |
|
|
638 | $pattern =~ s/\.$/.*/g; |
|
|
639 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
|
|
640 | } |
|
|
641 | } |
|
|
642 | } |
|
|
643 | |
907 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
644 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
908 | |
645 | |
909 | sub verbose { |
646 | sub verbose { |
910 | my ($level, $msg) = @_; |
647 | my ($level, $msg) = @_; |
911 | warn "$msg\n" if $level <= $verbosity; |
648 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
923 | $pkg =~ s/[^[:word:]]/_/g; |
660 | $pkg =~ s/[^[:word:]]/_/g; |
924 | $pkg = "urxvt::ext::$pkg"; |
661 | $pkg = "urxvt::ext::$pkg"; |
925 | |
662 | |
926 | verbose 3, "loading extension '$path' into package '$pkg'"; |
663 | verbose 3, "loading extension '$path' into package '$pkg'"; |
927 | |
664 | |
|
|
665 | (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish |
|
|
666 | |
928 | open my $fh, "<:raw", $path |
667 | open my $fh, "<:raw", $path |
929 | or die "$path: $!"; |
668 | or die "$path: $!"; |
930 | |
669 | |
931 | my $source = |
670 | my $source = |
932 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
671 | "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n" |
933 | . "#line 1 \"$path\"\n{\n" |
672 | . "#line 1 \"$path\"\n{\n" |
934 | . (do { local $/; <$fh> }) |
673 | . (do { local $/; <$fh> }) |
935 | . "\n};\n1"; |
674 | . "\n};\n1"; |
936 | |
675 | |
937 | eval $source |
676 | eval $source |
… | |
… | |
947 | sub invoke { |
686 | sub invoke { |
948 | local $TERM = shift; |
687 | local $TERM = shift; |
949 | my $htype = shift; |
688 | my $htype = shift; |
950 | |
689 | |
951 | if ($htype == 0) { # INIT |
690 | if ($htype == 0) { # INIT |
952 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
691 | my @dirs = $TERM->perl_libdirs; |
953 | |
692 | |
954 | my %ext_arg; |
693 | my %ext_arg; |
955 | |
694 | |
956 | { |
695 | { |
957 | my @init = @TERM_INIT; |
696 | my @init = @TERM_INIT; |
… | |
… | |
960 | my @pkg = @TERM_EXT; |
699 | my @pkg = @TERM_EXT; |
961 | @TERM_EXT = (); |
700 | @TERM_EXT = (); |
962 | $TERM->register_package ($_) for @pkg; |
701 | $TERM->register_package ($_) for @pkg; |
963 | } |
702 | } |
964 | |
703 | |
|
|
704 | for ( |
|
|
705 | @{ delete $TERM->{perl_ext_3} }, |
965 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
706 | grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 |
|
|
707 | ) { |
966 | if ($_ eq "default") { |
708 | if ($_ eq "default") { |
967 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
709 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
968 | } elsif (/^-(.*)$/) { |
710 | } elsif (/^-(.*)$/) { |
969 | delete $ext_arg{$1}; |
711 | delete $ext_arg{$1}; |
970 | } elsif (/^([^<]+)<(.*)>$/) { |
712 | } elsif (/^([^<]+)<(.*)>$/) { |
… | |
… | |
1046 | } |
788 | } |
1047 | } |
789 | } |
1048 | ($mask, @color{qw(fg bg)}, \@failed) |
790 | ($mask, @color{qw(fg bg)}, \@failed) |
1049 | } |
791 | } |
1050 | |
792 | |
1051 | # urxvt::term::extension |
|
|
1052 | |
|
|
1053 | package urxvt::term::extension; |
793 | package urxvt::term::extension; |
1054 | |
794 | |
1055 | sub enable { |
795 | sub enable { |
1056 | my ($self, %hook) = @_; |
796 | my ($self, %hook) = @_; |
1057 | my $pkg = $self->{_pkg}; |
797 | my $pkg = $self->{_pkg}; |
… | |
… | |
1111 | |
851 | |
1112 | sub urxvt::destroy_hook(&) { |
852 | sub urxvt::destroy_hook(&) { |
1113 | bless \shift, urxvt::destroy_hook:: |
853 | bless \shift, urxvt::destroy_hook:: |
1114 | } |
854 | } |
1115 | |
855 | |
|
|
856 | sub x_resource { |
|
|
857 | my ($self, $name) = @_; |
|
|
858 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
859 | $self->{term}->x_resource ($name) |
|
|
860 | } |
|
|
861 | |
|
|
862 | sub x_resource_boolean { |
|
|
863 | my ($self, $name) = @_; |
|
|
864 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
865 | $self->{term}->x_resource_boolean ($name) |
|
|
866 | } |
|
|
867 | |
1116 | package urxvt::anyevent; |
868 | package urxvt::anyevent; |
1117 | |
869 | |
1118 | =head2 The C<urxvt::anyevent> Class |
870 | =head2 The C<urxvt::anyevent> Class |
1119 | |
871 | |
1120 | The sole purpose of this class is to deliver an interface to the |
872 | The sole purpose of this class is to deliver an interface to the |
1121 | C<AnyEvent> module - any module using it will work inside urxvt without |
873 | C<AnyEvent> module - any module using it will work inside urxvt without |
1122 | further programming. The only exception is that you cannot wait on |
874 | further programming. The only exception is that you cannot wait on |
1123 | condition variables, but non-blocking condvar use is ok. What this means |
875 | condition variables, but non-blocking condvar use is ok. |
1124 | is that you cannot use blocking APIs, but the non-blocking variant should |
876 | |
1125 | work. |
877 | In practical terms this means is that you cannot use blocking APIs, but |
|
|
878 | the non-blocking variant should work. |
1126 | |
879 | |
1127 | =cut |
880 | =cut |
1128 | |
881 | |
1129 | our $VERSION = '5.23'; |
882 | our $VERSION = '5.23'; |
1130 | |
883 | |
… | |
… | |
1136 | |
889 | |
1137 | my $cb = $arg{cb}; |
890 | my $cb = $arg{cb}; |
1138 | |
891 | |
1139 | urxvt::timer |
892 | urxvt::timer |
1140 | ->new |
893 | ->new |
1141 | ->after ($arg{after}) |
894 | ->after ($arg{after}, $arg{interval}) |
1142 | ->interval ($arg{interval}) |
|
|
1143 | ->start |
|
|
1144 | ->cb ($argv{interval} ? $cb : sub { |
895 | ->cb ($arg{interval} ? $cb : sub { |
1145 | $_[0]->stop; # need to cancel manually |
896 | $_[0]->stop; # need to cancel manually |
1146 | $cb->(); |
897 | $cb->(); |
1147 | }) |
898 | }) |
1148 | } |
899 | } |
1149 | |
900 | |
… | |
… | |
1191 | |
942 | |
1192 | sub DESTROY { |
943 | sub DESTROY { |
1193 | $_[0][1]->stop; |
944 | $_[0][1]->stop; |
1194 | } |
945 | } |
1195 | |
946 | |
|
|
947 | # only needed for AnyEvent < 6 compatibility |
1196 | sub one_event { |
948 | sub one_event { |
1197 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
949 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1198 | } |
950 | } |
1199 | |
951 | |
1200 | package urxvt::term; |
952 | package urxvt::term; |
… | |
… | |
1215 | urxvt::verbose 6, "register package $pkg to $self"; |
967 | urxvt::verbose 6, "register package $pkg to $self"; |
1216 | |
968 | |
1217 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
969 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
1218 | |
970 | |
1219 | my $proxy = bless { |
971 | my $proxy = bless { |
1220 | _pkg => $pkg, |
972 | _pkg => $pkg, |
|
|
973 | _name => ${"$pkg\::_NAME"}, # hackish |
1221 | argv => $argv, |
974 | argv => $argv, |
1222 | }, $pkg; |
975 | }, $pkg; |
1223 | Scalar::Util::weaken ($proxy->{term} = $self); |
976 | Scalar::Util::weaken ($proxy->{term} = $self); |
1224 | |
977 | |
1225 | $self->{_pkg}{$pkg} = $proxy; |
978 | $self->{_pkg}{$pkg} = $proxy; |
1226 | |
979 | |
… | |
… | |
1229 | $proxy->enable ($name => $ref); |
982 | $proxy->enable ($name => $ref); |
1230 | } |
983 | } |
1231 | } |
984 | } |
1232 | } |
985 | } |
1233 | |
986 | |
|
|
987 | sub perl_libdirs { |
|
|
988 | map { split /:/ } |
|
|
989 | $_[0]->resource ("perl_lib"), |
|
|
990 | $ENV{URXVT_PERL_LIB}, |
|
|
991 | "$ENV{HOME}/.urxvt/ext", |
|
|
992 | "$LIBDIR/perl" |
|
|
993 | } |
|
|
994 | |
|
|
995 | sub scan_meta { |
|
|
996 | my ($self) = @_; |
|
|
997 | my @libdirs = perl_libdirs $self; |
|
|
998 | |
|
|
999 | return if $self->{meta_libdirs} eq join "\x00", @libdirs; |
|
|
1000 | |
|
|
1001 | my %meta; |
|
|
1002 | |
|
|
1003 | $self->{meta_libdirs} = join "\x00", @libdirs; |
|
|
1004 | $self->{meta} = \%meta; |
|
|
1005 | |
|
|
1006 | for my $dir (reverse @libdirs) { |
|
|
1007 | opendir my $fh, $dir |
|
|
1008 | or next; |
|
|
1009 | for my $ext (readdir $fh) { |
|
|
1010 | $ext ne "." |
|
|
1011 | and $ext ne ".." |
|
|
1012 | and open my $fh, "<", "$dir/$ext" |
|
|
1013 | or next; |
|
|
1014 | |
|
|
1015 | while (<$fh>) { |
|
|
1016 | if (/^#:META:X_RESOURCE:(.*)/) { |
|
|
1017 | my ($pattern, $type, $desc) = split /:/, $1; |
|
|
1018 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
|
|
1019 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
|
|
1020 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
|
|
1021 | } else { |
|
|
1022 | $meta{resource}{$pattern} = [$ext, $type, $desc]; |
|
|
1023 | } |
|
|
1024 | } elsif (/^\s*(?:#|$)/) { |
|
|
1025 | # skip other comments and empty lines |
|
|
1026 | } else { |
|
|
1027 | last; # stop parsing on first non-empty non-comment line |
|
|
1028 | } |
|
|
1029 | } |
|
|
1030 | } |
|
|
1031 | } |
|
|
1032 | } |
|
|
1033 | |
1234 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1034 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1235 | |
1035 | |
1236 | Creates a new terminal, very similar as if you had started it with system |
1036 | Creates a new terminal, very similar as if you had started it with system |
1237 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
1037 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
1238 | hash which defines the environment of the new terminal. |
1038 | hash which defines the environment of the new terminal. |
… | |
… | |
1292 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1092 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1293 | |
1093 | |
1294 | Here is a likely non-exhaustive list of option names, please see the |
1094 | Here is a likely non-exhaustive list of option names, please see the |
1295 | source file F</src/optinc.h> to see the actual list: |
1095 | source file F</src/optinc.h> to see the actual list: |
1296 | |
1096 | |
1297 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1097 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
1298 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1098 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1299 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1099 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1300 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
1100 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1301 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
1101 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1302 | transparent tripleclickwords utmpInhibit visualBell |
1102 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
|
|
1103 | urgentOnBell utmpInhibit visualBell |
1303 | |
1104 | |
1304 | =item $value = $term->resource ($name[, $newval]) |
1105 | =item $value = $term->resource ($name[, $newval]) |
1305 | |
1106 | |
1306 | Returns the current resource value associated with a given name and |
1107 | Returns the current resource value associated with a given name and |
1307 | optionally sets a new value. Setting values is most useful in the C<init> |
1108 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
1320 | |
1121 | |
1321 | Here is a likely non-exhaustive list of resource names, not all of which |
1122 | Here is a likely non-exhaustive list of resource names, not all of which |
1322 | are supported in every build, please see the source file F</src/rsinc.h> |
1123 | are supported in every build, please see the source file F</src/rsinc.h> |
1323 | to see the actual list: |
1124 | to see the actual list: |
1324 | |
1125 | |
1325 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1126 | answerbackstring backgroundPixmap backspace_key blendtype blurradius |
1326 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1127 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1327 | display_name embed ext_bwidth fade font geometry hold iconName |
1128 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1328 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1129 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
1329 | italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 |
1130 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
|
|
1131 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1330 | modifier mouseWheelScrollPage name override_redirect pastableTabs path |
1132 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1331 | perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1133 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1332 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1134 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1333 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1135 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1334 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1136 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1335 | secondaryScreen secondaryScroll shade term_name title |
1137 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1336 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1138 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1337 | visualBell |
1139 | utmpInhibit visualBell |
1338 | |
1140 | |
1339 | =cut |
1141 | =cut |
1340 | |
1142 | |
1341 | sub resource($$;$) { |
1143 | sub resource($$;$) { |
1342 | my ($self, $name) = (shift, shift); |
1144 | my ($self, $name) = (shift, shift); |
… | |
… | |
1349 | Returns the X-Resource for the given pattern, excluding the program or |
1151 | Returns the X-Resource for the given pattern, excluding the program or |
1350 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1152 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1351 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1153 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1352 | resource with that pattern exists. |
1154 | resource with that pattern exists. |
1353 | |
1155 | |
|
|
1156 | Extensions that define extra resource or command line arguments also need |
|
|
1157 | to call this method to access their values. |
|
|
1158 | |
|
|
1159 | If the method is called on an extension object (basically, from an |
|
|
1160 | extension), then the special prefix C<%.> will be replaced by the name of |
|
|
1161 | the extension and a dot, and the lone string C<%> will be replcaed by the |
|
|
1162 | extension name itself. This makes it possible to code extensions so you |
|
|
1163 | can rename them and get a new set of commandline switches and resources |
|
|
1164 | without having to change the actual code. |
|
|
1165 | |
1354 | This method should only be called during the C<on_start> hook, as there is |
1166 | This method should only be called during the C<on_start> hook, as there is |
1355 | only one resource database per display, and later invocations might return |
1167 | only one resource database per display, and later invocations might return |
1356 | the wrong resources. |
1168 | the wrong resources. |
1357 | |
1169 | |
1358 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
1170 | =item $value = $term->x_resource_boolean ($pattern) |
1359 | |
1171 | |
|
|
1172 | Like C<x_resource>, above, but interprets the string value as a boolean |
|
|
1173 | and returns C<1> for true values, C<0> for false values and C<undef> if |
|
|
1174 | the resource or option isn't specified. |
|
|
1175 | |
|
|
1176 | You should always use this method to parse boolean resources. |
|
|
1177 | |
|
|
1178 | =cut |
|
|
1179 | |
|
|
1180 | sub x_resource_boolean { |
|
|
1181 | my $res = &x_resource; |
|
|
1182 | |
|
|
1183 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
|
|
1184 | } |
|
|
1185 | |
|
|
1186 | =item $success = $term->parse_keysym ($key, $octets) |
|
|
1187 | |
1360 | Adds a keymap translation exactly as specified via a resource. See the |
1188 | Adds a key binding exactly as specified via a resource. See the |
1361 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1189 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
|
|
1190 | |
|
|
1191 | =item $term->register_command ($keysym, $modifiermask, $string) |
|
|
1192 | |
|
|
1193 | Adds a key binding. This is a lower level api compared to |
|
|
1194 | C<parse_keysym>, as it expects a parsed key description, and can be |
|
|
1195 | used only inside either the C<on_init> hook, to add a binding, or the |
|
|
1196 | C<on_register_command> hook, to modify a parsed binding. |
1362 | |
1197 | |
1363 | =item $rend = $term->rstyle ([$new_rstyle]) |
1198 | =item $rend = $term->rstyle ([$new_rstyle]) |
1364 | |
1199 | |
1365 | Return and optionally change the current rendition. Text that is output by |
1200 | Return and optionally change the current rendition. Text that is output by |
1366 | the terminal application will use this style. |
1201 | the terminal application will use this style. |
… | |
… | |
1374 | |
1209 | |
1375 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1210 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1376 | |
1211 | |
1377 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1212 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1378 | |
1213 | |
1379 | Return the current values of the selection mark, begin or end positions, |
1214 | Return the current values of the selection mark, begin or end positions. |
1380 | and optionally set them to new values. |
1215 | |
|
|
1216 | When arguments are given, then the selection coordinates are set to |
|
|
1217 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1218 | screen. |
|
|
1219 | |
|
|
1220 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1221 | |
|
|
1222 | Returns the current selection screen, and then optionally sets it. |
1381 | |
1223 | |
1382 | =item $term->selection_make ($eventtime[, $rectangular]) |
1224 | =item $term->selection_make ($eventtime[, $rectangular]) |
1383 | |
1225 | |
1384 | Tries to make a selection as set by C<selection_beg> and |
1226 | Tries to make a selection as set by C<selection_beg> and |
1385 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1227 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1386 | rectangular selection will be made. This is the prefered function to make |
1228 | rectangular selection will be made. This is the preferred function to make |
1387 | a selection. |
1229 | a selection. |
1388 | |
1230 | |
1389 | =item $success = $term->selection_grab ($eventtime) |
1231 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
1390 | |
1232 | |
1391 | Try to request the primary selection text from the server (for example, as |
1233 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1234 | true) selection from the server. The corresponding text can be set |
1392 | set by the next method). No visual feedback will be given. This function |
1235 | with the next method. No visual feedback will be given. This function |
1393 | is mostly useful from within C<on_sel_grab> hooks. |
1236 | is mostly useful from within C<on_sel_grab> hooks. |
1394 | |
1237 | |
1395 | =item $oldtext = $term->selection ([$newtext]) |
1238 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
1396 | |
1239 | |
1397 | Return the current selection text and optionally replace it by C<$newtext>. |
1240 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1241 | and optionally replace it by C<$newtext>. |
|
|
1242 | |
|
|
1243 | =item $term->selection_clear ([$clipboard]) |
|
|
1244 | |
|
|
1245 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
1398 | |
1246 | |
1399 | =item $term->overlay_simple ($x, $y, $text) |
1247 | =item $term->overlay_simple ($x, $y, $text) |
1400 | |
1248 | |
1401 | Create a simple multi-line overlay box. See the next method for details. |
1249 | Create a simple multi-line overlay box. See the next method for details. |
1402 | |
1250 | |
… | |
… | |
1530 | locale-specific encoding of the terminal and can contain command sequences |
1378 | locale-specific encoding of the terminal and can contain command sequences |
1531 | (escape codes) that will be interpreted. |
1379 | (escape codes) that will be interpreted. |
1532 | |
1380 | |
1533 | =item $term->tt_write ($octets) |
1381 | =item $term->tt_write ($octets) |
1534 | |
1382 | |
1535 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1383 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1536 | pass characters instead of octets, you should convert your strings first |
1384 | pass characters instead of octets, you should convert your strings first |
1537 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1385 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1386 | |
|
|
1387 | =item $term->tt_paste ($octets) |
|
|
1388 | |
|
|
1389 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1390 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1391 | is set. |
1538 | |
1392 | |
1539 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1393 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1540 | |
1394 | |
1541 | Replaces the event mask of the pty watcher by the given event mask. Can |
1395 | Replaces the event mask of the pty watcher by the given event mask. Can |
1542 | be used to suppress input and output handling to the pty/tty. See the |
1396 | be used to suppress input and output handling to the pty/tty. See the |
… | |
… | |
1560 | |
1414 | |
1561 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1415 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1562 | to receive pointer events all the times: |
1416 | to receive pointer events all the times: |
1563 | |
1417 | |
1564 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1418 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1419 | |
|
|
1420 | =item $term->set_urgency ($set) |
|
|
1421 | |
|
|
1422 | Enable/disable the urgency hint on the toplevel window. |
1565 | |
1423 | |
1566 | =item $term->focus_in |
1424 | =item $term->focus_in |
1567 | |
1425 | |
1568 | =item $term->focus_out |
1426 | =item $term->focus_out |
1569 | |
1427 | |
… | |
… | |
1856 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1714 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1857 | recent grab. |
1715 | recent grab. |
1858 | |
1716 | |
1859 | =item $term->ungrab |
1717 | =item $term->ungrab |
1860 | |
1718 | |
1861 | Calls XUngrab for the most recent grab. Is called automatically on |
1719 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
1862 | evaluation errors, as it is better to lose the grab in the error case as |
1720 | evaluation errors, as it is better to lose the grab in the error case as |
1863 | the session. |
1721 | the session. |
1864 | |
1722 | |
1865 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1723 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1866 | |
1724 | |
… | |
… | |
1886 | |
1744 | |
1887 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1745 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1888 | |
1746 | |
1889 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1747 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1890 | |
1748 | |
|
|
1749 | =item $keysym = $term->XStringToKeysym ($string) |
|
|
1750 | |
|
|
1751 | =item $string = $term->XKeysymToString ($keysym) |
|
|
1752 | |
1891 | Various X or X-related functions. The C<$term> object only serves as |
1753 | Various X or X-related functions. The C<$term> object only serves as |
1892 | the source of the display, otherwise those functions map more-or-less |
1754 | the source of the display, otherwise those functions map more-or-less |
1893 | directory onto the X functions of the same name. |
1755 | directly onto the X functions of the same name. |
1894 | |
1756 | |
1895 | =back |
1757 | =back |
1896 | |
1758 | |
1897 | =cut |
1759 | =cut |
1898 | |
1760 | |
… | |
… | |
2055 | |
1917 | |
2056 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
1918 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2057 | |
1919 | |
2058 | Set the callback to be called when the timer triggers. |
1920 | Set the callback to be called when the timer triggers. |
2059 | |
1921 | |
2060 | =item $tstamp = $timer->at |
|
|
2061 | |
|
|
2062 | Return the time this watcher will fire next. |
|
|
2063 | |
|
|
2064 | =item $timer = $timer->set ($tstamp) |
1922 | =item $timer = $timer->set ($tstamp[, $interval]) |
2065 | |
1923 | |
2066 | Set the time the event is generated to $tstamp. |
1924 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
1925 | new $interval). |
2067 | |
1926 | |
2068 | =item $timer = $timer->interval ($interval) |
1927 | =item $timer = $timer->interval ($interval) |
2069 | |
1928 | |
2070 | Normally (and when C<$interval> is C<0>), the timer will automatically |
1929 | By default (and when C<$interval> is C<0>), the timer will automatically |
2071 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
1930 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2072 | is automatically rescheduled at the given intervals. |
1931 | is automatically rescheduled at the given intervals. |
2073 | |
1932 | |
2074 | =item $timer = $timer->start |
1933 | =item $timer = $timer->start |
2075 | |
1934 | |
2076 | Start the timer. |
1935 | Start the timer. |
2077 | |
1936 | |
2078 | =item $timer = $timer->start ($tstamp) |
1937 | =item $timer = $timer->start ($tstamp[, $interval]) |
2079 | |
1938 | |
2080 | Set the event trigger time to C<$tstamp> and start the timer. |
1939 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
1940 | also replaces the interval. |
2081 | |
1941 | |
2082 | =item $timer = $timer->after ($delay) |
1942 | =item $timer = $timer->after ($delay[, $interval]) |
2083 | |
1943 | |
2084 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1944 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2085 | |
1945 | |
2086 | =item $timer = $timer->stop |
1946 | =item $timer = $timer->stop |
2087 | |
1947 | |
… | |
… | |
2218 | |
2078 | |
2219 | =back |
2079 | =back |
2220 | |
2080 | |
2221 | =head1 AUTHOR |
2081 | =head1 AUTHOR |
2222 | |
2082 | |
2223 | Marc Lehmann <pcg@goof.com> |
2083 | Marc Lehmann <schmorp@schmorp.de> |
2224 | http://software.schmorp.de/pkg/rxvt-unicode |
2084 | http://software.schmorp.de/pkg/rxvt-unicode |
2225 | |
2085 | |
2226 | =cut |
2086 | =cut |
2227 | |
2087 | |
2228 | 1 |
2088 | 1 |