… | |
… | |
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 | =head2 Prepackaged Extensions |
31 | =head1 PREPACKAGED EXTENSIONS |
32 | |
32 | |
33 | This section describes the extensiosn delivered with this version. You can |
33 | This section describes the extensions delivered with this release. You can |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
35 | |
35 | |
36 | You can activate them like this: |
36 | You can activate them like this: |
37 | |
37 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
38 | @@RXVT_NAME@@ -pe <extensionname> |
39 | |
39 | |
40 | =over 4 |
40 | =over 4 |
41 | |
41 | |
42 | =item selection (enabled by default) |
42 | =item selection (enabled by default) |
43 | |
43 | |
44 | Intelligent selection. This extension tries to be more intelligent when |
44 | (More) intelligent selection. This extension tries to be more intelligent |
45 | the user extends selections (double-click). Right now, it tries to select |
45 | when the user extends selections (double-click and further clicks). Right |
46 | urls and complete shell-quoted arguments, which is very convenient, too, |
46 | now, it tries to select words, urls and complete shell-quoted |
47 | if your F<ls> supports C<--quoting-style=shell>. |
47 | arguments, which is very convenient, too, if your F<ls> supports |
|
|
48 | C<--quoting-style=shell>. |
48 | |
49 | |
49 | It also offers the following bindable event: |
50 | A double-click usually selects the word under the cursor, further clicks |
|
|
51 | will enlarge the selection. |
|
|
52 | |
|
|
53 | The selection works by trying to match a number of regexes and displaying |
|
|
54 | them in increasing order of length. You can add your own regexes by |
|
|
55 | specifying resources of the form: |
|
|
56 | |
|
|
57 | URxvt.selection.pattern-0: perl-regex |
|
|
58 | URxvt.selection.pattern-1: perl-regex |
|
|
59 | ... |
|
|
60 | |
|
|
61 | The index number (0, 1...) must not have any holes, and each regex must |
|
|
62 | contain at least one pair of capturing parentheses, which will be used for |
|
|
63 | the match. For example, the followign adds a regex that matches everything |
|
|
64 | between two vertical bars: |
|
|
65 | |
|
|
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
67 | |
|
|
68 | You can look at the source of the selection extension to see more |
|
|
69 | interesting uses, such as parsing a line from beginning to end. |
|
|
70 | |
|
|
71 | This extension also offers the following bindable keyboard command: |
50 | |
72 | |
51 | =over 4 |
73 | =over 4 |
52 | |
74 | |
53 | =item rot13 |
75 | =item rot13 |
54 | |
76 | |
… | |
… | |
64 | runtime. |
86 | runtime. |
65 | |
87 | |
66 | =item selection-popup (enabled by default) |
88 | =item selection-popup (enabled by default) |
67 | |
89 | |
68 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
90 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
69 | text into various other formats/action. |
91 | text into various other formats/action (such as uri unescaping, perl |
|
|
92 | evalution, web-browser starting etc.), depending on content. |
70 | |
93 | |
71 | =item searchable-scrollback (enabled by default) |
94 | =item searchable-scrollback<hotkey> (enabled by default) |
72 | |
95 | |
73 | Adds regex search functionality to the scrollback buffer, triggered by a |
96 | Adds regex search functionality to the scrollback buffer, triggered |
74 | hotkey (default: C<M-s>). When in search mode, terminal input/output is |
97 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
75 | suspended, C</> starts an incremental regex search, C<n> searches further, |
98 | input/output is suspended and a regex is displayed at the bottom of the |
76 | C<p> jumps to the previous match. C<enter> leaves search mode at the |
99 | screen. |
77 | current position and C<escape> returns to the original position. |
|
|
78 | |
100 | |
79 | =item digital-clock |
101 | Inputting characters appends them to the regex and continues incremental |
|
|
102 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
|
|
103 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
|
|
104 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
105 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
106 | additionally stores the first match in the current line into the primary |
|
|
107 | selection. |
80 | |
108 | |
81 | Displays a digital clock using the built-in overlay. |
109 | =item selection-autotransform |
|
|
110 | |
|
|
111 | This selection allows you to do automatic transforms on a selection |
|
|
112 | whenever a selection is made. |
|
|
113 | |
|
|
114 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
115 | operator) that modify C<$_> as resources: |
|
|
116 | |
|
|
117 | URxvt.selection-autotransform.0: transform |
|
|
118 | URxvt.selection-autotransform.1: transform |
|
|
119 | ... |
|
|
120 | |
|
|
121 | For example, the following will transform selections of the form |
|
|
122 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
123 | $word>: |
|
|
124 | |
|
|
125 | URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
126 | |
|
|
127 | And this example matches the same,but replaces it with vi-commands you can |
|
|
128 | paste directly into your (vi :) editor: |
|
|
129 | |
|
|
130 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
131 | |
|
|
132 | Of course, this can be modified to suit your needs and your editor :) |
|
|
133 | |
|
|
134 | To expand the example above to typical perl error messages ("XXX at |
|
|
135 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
136 | |
|
|
137 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
|
|
138 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
139 | |
|
|
140 | The first line tells the selection code to treat the unchanging part of |
|
|
141 | every error message as a selection pattern, and the second line transforms |
|
|
142 | the message into vi commands to load the file. |
82 | |
143 | |
83 | =item mark-urls |
144 | =item mark-urls |
84 | |
145 | |
85 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
146 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
|
|
147 | make them clickable. When middle-clicked, the program specified in the |
|
|
148 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
|
|
149 | the URL as first argument. |
86 | |
150 | |
87 | =item block-graphics-to-ascii |
151 | =item block-graphics-to-ascii |
88 | |
152 | |
89 | A not very useful example of filtering all text output to the terminal, |
153 | A not very useful example of filtering all text output to the terminal, |
90 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
154 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
91 | similar-looking ascii character. |
155 | similar-looking ascii character. |
92 | |
156 | |
|
|
157 | =item digital-clock |
|
|
158 | |
|
|
159 | Displays a digital clock using the built-in overlay. |
|
|
160 | |
93 | =item example-refresh-hooks |
161 | =item example-refresh-hooks |
94 | |
162 | |
95 | Displays a very simple digital clock in the upper right corner of the |
163 | Displays a very simple digital clock in the upper right corner of the |
96 | window. Illustrates overwriting the refresh callbacks to create your own |
164 | window. Illustrates overwriting the refresh callbacks to create your own |
97 | overlays or changes. |
165 | overlays or changes. |
98 | |
166 | |
99 | =back |
167 | =back |
|
|
168 | |
|
|
169 | =head1 API DOCUMENTATION |
100 | |
170 | |
101 | =head2 General API Considerations |
171 | =head2 General API Considerations |
102 | |
172 | |
103 | All objects (such as terminals, time watchers etc.) are typical |
173 | All objects (such as terminals, time watchers etc.) are typical |
104 | reference-to-hash objects. The hash can be used to store anything you |
174 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
117 | =over 4 |
187 | =over 4 |
118 | |
188 | |
119 | =item $text |
189 | =item $text |
120 | |
190 | |
121 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
191 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
122 | always represents one screen cell. See L<row_t> for a discussion of this format. |
192 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
123 | |
193 | |
124 | =item $string |
194 | =item $string |
125 | |
195 | |
126 | A perl text string, with an emphasis on I<text>. It can store all unicode |
196 | A perl text string, with an emphasis on I<text>. It can store all unicode |
127 | characters and is to be distinguished with text encoded in a specific |
197 | characters and is to be distinguished with text encoded in a specific |
… | |
… | |
222 | =item on_sel_extend $term |
292 | =item on_sel_extend $term |
223 | |
293 | |
224 | Called whenever the user tries to extend the selection (e.g. with a double |
294 | Called whenever the user tries to extend the selection (e.g. with a double |
225 | click) and is either supposed to return false (normal operation), or |
295 | click) and is either supposed to return false (normal operation), or |
226 | should extend the selection itelf and return true to suppress the built-in |
296 | should extend the selection itelf and return true to suppress the built-in |
227 | processing. |
297 | processing. This can happen multiple times, as long as the callback |
|
|
298 | returns true, it will be called on every further click by the user and is |
|
|
299 | supposed to enlarge the selection more and more, if possible. |
228 | |
300 | |
229 | See the F<selection> example extension. |
301 | See the F<selection> example extension. |
230 | |
302 | |
231 | =item on_view_change $term, $offset |
303 | =item on_view_change $term, $offset |
232 | |
304 | |
… | |
… | |
337 | |
409 | |
338 | subwindow. |
410 | subwindow. |
339 | |
411 | |
340 | =back |
412 | =back |
341 | |
413 | |
342 | =head2 Variables in the C<urxvt> Package |
|
|
343 | |
|
|
344 | =over 4 |
|
|
345 | |
|
|
346 | =item $urxvt::TERM |
|
|
347 | |
|
|
348 | The current terminal. This variable stores the current C<urxvt::term> |
|
|
349 | object, whenever a callback/hook is executing. |
|
|
350 | |
|
|
351 | =back |
|
|
352 | |
|
|
353 | =head2 Functions in the C<urxvt> Package |
|
|
354 | |
|
|
355 | =over 4 |
|
|
356 | |
|
|
357 | =item $term = new urxvt [arg...] |
|
|
358 | |
|
|
359 | Creates a new terminal, very similar as if you had started it with |
|
|
360 | C<system $binfile, arg...>. Croaks (and probably outputs an error message) |
|
|
361 | if the new instance couldn't be created. Returns C<undef> if the new |
|
|
362 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
363 | C<init> and C<start> hooks will be called during the call. |
|
|
364 | |
|
|
365 | =item urxvt::fatal $errormessage |
|
|
366 | |
|
|
367 | Fatally aborts execution with the given error message. Avoid at all |
|
|
368 | costs! The only time this is acceptable is when the terminal process |
|
|
369 | starts up. |
|
|
370 | |
|
|
371 | =item urxvt::warn $string |
|
|
372 | |
|
|
373 | Calls C<rxvt_warn> with the given string which should not include a |
|
|
374 | newline. The module also overwrites the C<warn> builtin with a function |
|
|
375 | that calls this function. |
|
|
376 | |
|
|
377 | Using this function has the advantage that its output ends up in the |
|
|
378 | correct place, e.g. on stderr of the connecting urxvtc client. |
|
|
379 | |
|
|
380 | =item $is_safe = urxvt::safe |
|
|
381 | |
|
|
382 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
383 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
384 | started setuid or setgid. |
|
|
385 | |
|
|
386 | =item $time = urxvt::NOW |
|
|
387 | |
|
|
388 | Returns the "current time" (as per the event loop). |
|
|
389 | |
|
|
390 | =item urxvt::CurrentTime |
|
|
391 | |
|
|
392 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
393 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
394 | Button4Mask, Button5Mask, AnyModifier |
|
|
395 | |
|
|
396 | Various constants for use in X calls and event processing. |
|
|
397 | |
|
|
398 | =back |
|
|
399 | |
|
|
400 | =head2 RENDITION |
|
|
401 | |
|
|
402 | Rendition bitsets contain information about colour, font, font styles and |
|
|
403 | similar information for each screen cell. |
|
|
404 | |
|
|
405 | The following "macros" deal with changes in rendition sets. You should |
|
|
406 | never just create a bitset, you should always modify an existing one, |
|
|
407 | as they contain important information required for correct operation of |
|
|
408 | rxvt-unicode. |
|
|
409 | |
|
|
410 | =over 4 |
|
|
411 | |
|
|
412 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
413 | |
|
|
414 | Returns the default rendition, as used when the terminal is starting up or |
|
|
415 | being reset. Useful as a base to start when creating renditions. |
|
|
416 | |
|
|
417 | =item $rend = urxvt::OVERLAY_RSTYLE |
|
|
418 | |
|
|
419 | Return the rendition mask used for overlays by default. |
|
|
420 | |
|
|
421 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
|
|
422 | |
|
|
423 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
424 | underline, respectively. To enable such a style, just logically OR it into |
|
|
425 | the bitset. |
|
|
426 | |
|
|
427 | =item $foreground = urxvt::GET_BASEFG $rend |
|
|
428 | |
|
|
429 | =item $background = urxvt::GET_BASEBG $rend |
|
|
430 | |
|
|
431 | Return the foreground/background colour index, respectively. |
|
|
432 | |
|
|
433 | =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
|
|
434 | |
|
|
435 | =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
|
|
436 | |
|
|
437 | Replace the foreground/background colour in the rendition mask with the |
|
|
438 | specified one. |
|
|
439 | |
|
|
440 | =item $value = urxvt::GET_CUSTOM ($rend) |
|
|
441 | |
|
|
442 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
443 | extensions. They can be set and changed as you like and are initially |
|
|
444 | zero. |
|
|
445 | |
|
|
446 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
|
|
447 | |
|
|
448 | Change the custom value. |
|
|
449 | |
|
|
450 | =back |
|
|
451 | |
|
|
452 | =cut |
414 | =cut |
453 | |
415 | |
454 | package urxvt; |
416 | package urxvt; |
455 | |
417 | |
456 | use utf8; |
418 | use utf8; |
… | |
… | |
467 | |
429 | |
468 | our $LIBDIR; |
430 | our $LIBDIR; |
469 | our $RESNAME; |
431 | our $RESNAME; |
470 | our $RESCLASS; |
432 | our $RESCLASS; |
471 | our $RXVTNAME; |
433 | our $RXVTNAME; |
|
|
434 | |
|
|
435 | =head2 Variables in the C<urxvt> Package |
|
|
436 | |
|
|
437 | =over 4 |
|
|
438 | |
|
|
439 | =item $urxvt::LIBDIR |
|
|
440 | |
|
|
441 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
442 | modules and scripts are stored. |
|
|
443 | |
|
|
444 | =item $urxvt::RESCLASS, $urxvt::RESCLASS |
|
|
445 | |
|
|
446 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
447 | |
|
|
448 | =item $urxvt::RXVTNAME |
|
|
449 | |
|
|
450 | The basename of the installed binaries, usually C<urxvt>. |
|
|
451 | |
|
|
452 | =item $urxvt::TERM |
|
|
453 | |
|
|
454 | The current terminal. This variable stores the current C<urxvt::term> |
|
|
455 | object, whenever a callback/hook is executing. |
|
|
456 | |
|
|
457 | =back |
|
|
458 | |
|
|
459 | =head2 Functions in the C<urxvt> Package |
|
|
460 | |
|
|
461 | =over 4 |
|
|
462 | |
|
|
463 | =item urxvt::fatal $errormessage |
|
|
464 | |
|
|
465 | Fatally aborts execution with the given error message. Avoid at all |
|
|
466 | costs! The only time this is acceptable is when the terminal process |
|
|
467 | starts up. |
|
|
468 | |
|
|
469 | =item urxvt::warn $string |
|
|
470 | |
|
|
471 | Calls C<rxvt_warn> with the given string which should not include a |
|
|
472 | newline. The module also overwrites the C<warn> builtin with a function |
|
|
473 | that calls this function. |
|
|
474 | |
|
|
475 | Using this function has the advantage that its output ends up in the |
|
|
476 | correct place, e.g. on stderr of the connecting urxvtc client. |
|
|
477 | |
|
|
478 | Messages have a size limit of 1023 bytes currently. |
|
|
479 | |
|
|
480 | =item $is_safe = urxvt::safe |
|
|
481 | |
|
|
482 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
483 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
484 | started setuid or setgid. |
|
|
485 | |
|
|
486 | =item $time = urxvt::NOW |
|
|
487 | |
|
|
488 | Returns the "current time" (as per the event loop). |
|
|
489 | |
|
|
490 | =item urxvt::CurrentTime |
|
|
491 | |
|
|
492 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
493 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
494 | Button4Mask, Button5Mask, AnyModifier |
|
|
495 | |
|
|
496 | Various constants for use in X calls and event processing. |
|
|
497 | |
|
|
498 | =back |
|
|
499 | |
|
|
500 | =head2 RENDITION |
|
|
501 | |
|
|
502 | Rendition bitsets contain information about colour, font, font styles and |
|
|
503 | similar information for each screen cell. |
|
|
504 | |
|
|
505 | The following "macros" deal with changes in rendition sets. You should |
|
|
506 | never just create a bitset, you should always modify an existing one, |
|
|
507 | as they contain important information required for correct operation of |
|
|
508 | rxvt-unicode. |
|
|
509 | |
|
|
510 | =over 4 |
|
|
511 | |
|
|
512 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
513 | |
|
|
514 | Returns the default rendition, as used when the terminal is starting up or |
|
|
515 | being reset. Useful as a base to start when creating renditions. |
|
|
516 | |
|
|
517 | =item $rend = urxvt::OVERLAY_RSTYLE |
|
|
518 | |
|
|
519 | Return the rendition mask used for overlays by default. |
|
|
520 | |
|
|
521 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
|
|
522 | |
|
|
523 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
524 | underline, respectively. To enable such a style, just logically OR it into |
|
|
525 | the bitset. |
|
|
526 | |
|
|
527 | =item $foreground = urxvt::GET_BASEFG $rend |
|
|
528 | |
|
|
529 | =item $background = urxvt::GET_BASEBG $rend |
|
|
530 | |
|
|
531 | Return the foreground/background colour index, respectively. |
|
|
532 | |
|
|
533 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
|
|
534 | |
|
|
535 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
536 | |
|
|
537 | Replace the foreground/background colour in the rendition mask with the |
|
|
538 | specified one. |
|
|
539 | |
|
|
540 | =item $value = urxvt::GET_CUSTOM $rend |
|
|
541 | |
|
|
542 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
543 | extensions. They can be set and changed as you like and are initially |
|
|
544 | zero. |
|
|
545 | |
|
|
546 | =item $rend = urxvt::SET_CUSTOM $rend, $new_value |
|
|
547 | |
|
|
548 | Change the custom value. |
|
|
549 | |
|
|
550 | =back |
|
|
551 | |
|
|
552 | =cut |
472 | |
553 | |
473 | BEGIN { |
554 | BEGIN { |
474 | urxvt->bootstrap; |
555 | urxvt->bootstrap; |
475 | |
556 | |
476 | # overwrite perl's warn |
557 | # overwrite perl's warn |
… | |
… | |
479 | $msg .= "\n" |
560 | $msg .= "\n" |
480 | unless $msg =~ /\n$/; |
561 | unless $msg =~ /\n$/; |
481 | urxvt::warn ($msg); |
562 | urxvt::warn ($msg); |
482 | }; |
563 | }; |
483 | |
564 | |
|
|
565 | # %ENV is the original startup environment |
484 | delete $ENV{IFS}; |
566 | delete $ENV{IFS}; |
485 | delete $ENV{CDPATH}; |
567 | delete $ENV{CDPATH}; |
486 | delete $ENV{BASH_ENV}; |
568 | delete $ENV{BASH_ENV}; |
487 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
569 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
488 | } |
570 | } |
… | |
… | |
577 | if ($@) { |
659 | if ($@) { |
578 | $TERM->ungrab; # better to lose the grab than the session |
660 | $TERM->ungrab; # better to lose the grab than the session |
579 | warn $@; |
661 | warn $@; |
580 | } |
662 | } |
581 | } |
663 | } |
|
|
664 | |
|
|
665 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
666 | if $verbosity >= 11; |
582 | } |
667 | } |
583 | |
668 | |
584 | if ($htype == 1) { # DESTROY |
669 | if ($htype == 1) { # DESTROY |
585 | if (my $hook = delete $TERM->{_hook}) { |
670 | if (my $hook = delete $TERM->{_hook}) { |
586 | for my $htype (0..$#$hook) { |
671 | for my $htype (0..$#$hook) { |
… | |
… | |
597 | } |
682 | } |
598 | |
683 | |
599 | $retval |
684 | $retval |
600 | } |
685 | } |
601 | |
686 | |
|
|
687 | sub exec_async(@) { |
|
|
688 | my $pid = fork; |
|
|
689 | |
|
|
690 | return |
|
|
691 | if !defined $pid or $pid; |
|
|
692 | |
|
|
693 | %ENV = %{ $TERM->env }; |
|
|
694 | |
|
|
695 | exec @_; |
|
|
696 | _exit 255; |
|
|
697 | } |
|
|
698 | |
602 | # urxvt::term::extension |
699 | # urxvt::term::extension |
603 | |
700 | |
604 | package urxvt::term::extension; |
701 | package urxvt::term::extension; |
605 | |
702 | |
606 | sub enable { |
703 | sub enable { |
… | |
… | |
672 | |
769 | |
673 | =head2 The C<urxvt::anyevent> Class |
770 | =head2 The C<urxvt::anyevent> Class |
674 | |
771 | |
675 | The sole purpose of this class is to deliver an interface to the |
772 | The sole purpose of this class is to deliver an interface to the |
676 | C<AnyEvent> module - any module using it will work inside urxvt without |
773 | C<AnyEvent> module - any module using it will work inside urxvt without |
677 | further work. The only exception is that you cannot wait on condition |
774 | further programming. The only exception is that you cannot wait on |
678 | variables, but non-blocking condvar use is ok. What this means is that you |
775 | condition variables, but non-blocking condvar use is ok. What this means |
679 | cannot use blocking APIs, but the non-blocking variant should work. |
776 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
777 | work. |
680 | |
778 | |
681 | =cut |
779 | =cut |
682 | |
780 | |
683 | our $VERSION = 1; |
781 | our $VERSION = 1; |
684 | |
782 | |
… | |
… | |
761 | $proxy->enable ($name => $ref); |
859 | $proxy->enable ($name => $ref); |
762 | } |
860 | } |
763 | } |
861 | } |
764 | } |
862 | } |
765 | |
863 | |
|
|
864 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
|
|
865 | |
|
|
866 | Creates a new terminal, very similar as if you had started it with system |
|
|
867 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
|
|
868 | hash which defines the environment of the new terminal. |
|
|
869 | |
|
|
870 | Croaks (and probably outputs an error message) if the new instance |
|
|
871 | couldn't be created. Returns C<undef> if the new instance didn't |
|
|
872 | initialise perl, and the terminal object otherwise. The C<init> and |
|
|
873 | C<start> hooks will be called during this call. |
|
|
874 | |
|
|
875 | =cut |
|
|
876 | |
|
|
877 | sub new { |
|
|
878 | my ($class, $env, @args) = @_; |
|
|
879 | |
|
|
880 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
|
|
881 | } |
|
|
882 | |
766 | =item $term->destroy |
883 | =item $term->destroy |
767 | |
884 | |
768 | Destroy the terminal object (close the window, free resources etc.). |
885 | Destroy the terminal object (close the window, free resources |
|
|
886 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
|
|
887 | watchers (timers, io watchers) are still active. |
769 | |
888 | |
770 | =item $isset = $term->option ($optval[, $set]) |
889 | =item $isset = $term->option ($optval[, $set]) |
771 | |
890 | |
772 | Returns true if the option specified by C<$optval> is enabled, and |
891 | Returns true if the option specified by C<$optval> is enabled, and |
773 | optionally change it. All option values are stored by name in the hash |
892 | optionally change it. All option values are stored by name in the hash |
… | |
… | |
823 | my ($self, $name) = (shift, shift); |
942 | my ($self, $name) = (shift, shift); |
824 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
943 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
825 | &urxvt::term::_resource |
944 | &urxvt::term::_resource |
826 | } |
945 | } |
827 | |
946 | |
|
|
947 | =item $value = $term->x_resource ($pattern) |
|
|
948 | |
|
|
949 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
950 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
|
|
951 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
|
|
952 | resource with that pattern exists. |
|
|
953 | |
|
|
954 | This method should only be called during the C<on_start> hook, as there is |
|
|
955 | only one resource database per display, and later invocations might return |
|
|
956 | the wrong resources. |
|
|
957 | |
828 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
958 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
829 | |
959 | |
830 | Adds a keymap translation exactly as specified via a resource. See the |
960 | Adds a keymap translation exactly as specified via a resource. See the |
831 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
961 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
832 | |
962 | |
… | |
… | |
847 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
977 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
848 | |
978 | |
849 | Return the current values of the selection mark, begin or end positions, |
979 | Return the current values of the selection mark, begin or end positions, |
850 | and optionally set them to new values. |
980 | and optionally set them to new values. |
851 | |
981 | |
|
|
982 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
983 | |
|
|
984 | Tries to make a selection as set by C<selection_beg> and |
|
|
985 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
986 | rectangular selection will be made. This is the prefered function to make |
|
|
987 | a selection. |
|
|
988 | |
852 | =item $success = $term->selection_grab ($eventtime) |
989 | =item $success = $term->selection_grab ($eventtime) |
853 | |
990 | |
854 | Try to request the primary selection from the server (for example, as set |
991 | Try to request the primary selection text from the server (for example, as |
855 | by the next method). |
992 | set by the next method). No visual feedback will be given. This function |
|
|
993 | is mostly useful from within C<on_sel_grab> hooks. |
856 | |
994 | |
857 | =item $oldtext = $term->selection ([$newtext]) |
995 | =item $oldtext = $term->selection ([$newtext]) |
858 | |
996 | |
859 | Return the current selection text and optionally replace it by C<$newtext>. |
997 | Return the current selection text and optionally replace it by C<$newtext>. |
860 | |
998 | |
… | |
… | |
953 | Convert the given locale-encoded octets into a perl string. |
1091 | Convert the given locale-encoded octets into a perl string. |
954 | |
1092 | |
955 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1093 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
956 | |
1094 | |
957 | XORs the rendition values in the given span with the provided value |
1095 | XORs the rendition values in the given span with the provided value |
958 | (default: C<RS_RVid>). Useful in refresh hooks to provide effects similar |
1096 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
959 | to the selection. |
1097 | refresh hooks to provide effects similar to the selection. |
960 | |
1098 | |
961 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1099 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
962 | |
1100 | |
963 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1101 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
964 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1102 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
965 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1103 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
966 | it instead. |
1104 | it instead. Both styles I<MUST NOT> contain font styles. |
967 | |
1105 | |
968 | =item $term->scr_bell |
1106 | =item $term->scr_bell |
969 | |
1107 | |
970 | Ring the bell! |
1108 | Ring the bell! |
971 | |
1109 | |
… | |
… | |
1031 | |
1169 | |
1032 | =item $lines_in_scrollback = $term->nsaved |
1170 | =item $lines_in_scrollback = $term->nsaved |
1033 | |
1171 | |
1034 | Return various integers describing terminal characteristics. |
1172 | Return various integers describing terminal characteristics. |
1035 | |
1173 | |
|
|
1174 | =item $x_display = $term->display_id |
|
|
1175 | |
|
|
1176 | Return the DISPLAY used by rxvt-unicode. |
|
|
1177 | |
1036 | =item $lc_ctype = $term->locale |
1178 | =item $lc_ctype = $term->locale |
1037 | |
1179 | |
1038 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1180 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1039 | |
1181 | |
1040 | =item $x_display = $term->display_id |
1182 | =item $env = $term->env |
1041 | |
1183 | |
1042 | Return the DISPLAY used by rxvt-unicode. |
1184 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1185 | similar to C<\%ENV>. |
|
|
1186 | |
|
|
1187 | =cut |
|
|
1188 | |
|
|
1189 | sub env { |
|
|
1190 | if (my $env = $_[0]->_env) { |
|
|
1191 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
|
|
1192 | } else { |
|
|
1193 | +{ %ENV } |
|
|
1194 | } |
|
|
1195 | } |
1043 | |
1196 | |
1044 | =item $modifiermask = $term->ModLevel3Mask |
1197 | =item $modifiermask = $term->ModLevel3Mask |
1045 | |
1198 | |
1046 | =item $modifiermask = $term->ModMetaMask |
1199 | =item $modifiermask = $term->ModMetaMask |
1047 | |
1200 | |
… | |
… | |
1140 | Return the row number of the first/last row of the line, respectively. |
1293 | Return the row number of the first/last row of the line, respectively. |
1141 | |
1294 | |
1142 | =item $offset = $line->offset_of ($row, $col) |
1295 | =item $offset = $line->offset_of ($row, $col) |
1143 | |
1296 | |
1144 | Returns the character offset of the given row|col pair within the logical |
1297 | Returns the character offset of the given row|col pair within the logical |
1145 | line. |
1298 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1299 | offsets outside the string. |
1146 | |
1300 | |
1147 | =item ($row, $col) = $line->coord_of ($offset) |
1301 | =item ($row, $col) = $line->coord_of ($offset) |
1148 | |
1302 | |
1149 | Translates a string offset into terminal coordinates again. |
1303 | Translates a string offset into terminal coordinates again. |
1150 | |
1304 | |
… | |
… | |
1287 | $item->{render} ||= sub { $_[0]{text} }; |
1441 | $item->{render} ||= sub { $_[0]{text} }; |
1288 | |
1442 | |
1289 | push @{ $self->{item} }, $item; |
1443 | push @{ $self->{item} }, $item; |
1290 | } |
1444 | } |
1291 | |
1445 | |
|
|
1446 | =item $popup->add_title ($title) |
|
|
1447 | |
|
|
1448 | Adds a non-clickable title to the popup. |
|
|
1449 | |
|
|
1450 | =cut |
|
|
1451 | |
|
|
1452 | sub add_title { |
|
|
1453 | my ($self, $title) = @_; |
|
|
1454 | |
|
|
1455 | $self->add_item ({ |
|
|
1456 | rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, |
|
|
1457 | text => $title, |
|
|
1458 | activate => sub { }, |
|
|
1459 | }); |
|
|
1460 | } |
|
|
1461 | |
|
|
1462 | =item $popup->add_separator ([$sepchr]) |
|
|
1463 | |
|
|
1464 | Creates a separator, optionally using the character given as C<$sepchr>. |
|
|
1465 | |
|
|
1466 | =cut |
|
|
1467 | |
1292 | sub add_separator { |
1468 | sub add_separator { |
1293 | my ($self, $sep) = @_; |
1469 | my ($self, $sep) = @_; |
1294 | |
1470 | |
1295 | $sep ||= "="; |
1471 | $sep ||= "="; |
1296 | |
1472 | |
… | |
… | |
1300 | render => sub { $sep x $self->{term}->ncol }, |
1476 | render => sub { $sep x $self->{term}->ncol }, |
1301 | activate => sub { }, |
1477 | activate => sub { }, |
1302 | }); |
1478 | }); |
1303 | } |
1479 | } |
1304 | |
1480 | |
1305 | sub add_title { |
1481 | =item $popup->add_button ($text, $cb) |
1306 | my ($self, $title) = @_; |
|
|
1307 | |
1482 | |
1308 | $self->add_item ({ |
1483 | Adds a clickable button to the popup. C<$cb> is called whenever it is |
1309 | rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, |
1484 | selected. |
1310 | text => $title, |
1485 | |
1311 | activate => sub { }, |
1486 | =cut |
1312 | }); |
|
|
1313 | } |
|
|
1314 | |
1487 | |
1315 | sub add_button { |
1488 | sub add_button { |
1316 | my ($self, $text, $cb) = @_; |
1489 | my ($self, $text, $cb) = @_; |
1317 | |
1490 | |
1318 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1491 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1319 | } |
1492 | } |
|
|
1493 | |
|
|
1494 | =item $popup->add_toggle ($text, $cb, $initial_value) |
|
|
1495 | |
|
|
1496 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1497 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1498 | argument. |
|
|
1499 | |
|
|
1500 | =cut |
1320 | |
1501 | |
1321 | sub add_toggle { |
1502 | sub add_toggle { |
1322 | my ($self, $text, $cb, $value) = @_; |
1503 | my ($self, $text, $cb, $value) = @_; |
1323 | |
1504 | |
1324 | my $item; $item = { |
1505 | my $item; $item = { |
1325 | type => "button", |
1506 | type => "button", |
1326 | text => " $text", |
1507 | text => " $text", |
1327 | value => $value, |
1508 | value => $value, |
1328 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1509 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1329 | activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, |
1510 | activate => sub { $cb->($_[1]{value} = !$_[1]{value}); }, |
1330 | }; |
1511 | }; |
1331 | |
1512 | |
1332 | $self->add_item ($item); |
1513 | $self->add_item ($item); |
1333 | } |
1514 | } |
|
|
1515 | |
|
|
1516 | =item $popup->show |
|
|
1517 | |
|
|
1518 | Displays the popup (which is initially hidden). |
|
|
1519 | |
|
|
1520 | =cut |
1334 | |
1521 | |
1335 | sub show { |
1522 | sub show { |
1336 | my ($self) = @_; |
1523 | my ($self) = @_; |
1337 | |
1524 | |
1338 | local $urxvt::popup::self = $self; |
1525 | local $urxvt::popup::self = $self; |
1339 | |
1526 | |
|
|
1527 | my $env = $self->{term}->env; |
|
|
1528 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
|
|
1529 | delete $env->{LC_ALL}; |
1340 | local $ENV{LC_ALL} = $self->{term}->locale; |
1530 | $env->{LC_CTYPE} = $self->{term}->locale; |
1341 | |
1531 | |
|
|
1532 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1342 | urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1533 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1343 | "--transient-for" => $self->{term}->parent, |
1534 | "--transient-for" => $self->{term}->parent, |
1344 | "-display" => $self->{term}->display_id, |
1535 | "-display" => $self->{term}->display_id, |
1345 | "-pe" => "urxvt-popup") |
1536 | "-pe" => "urxvt-popup") |
1346 | or die "unable to create popup window\n"; |
1537 | or die "unable to create popup window\n"; |
1347 | } |
1538 | } |
1348 | |
1539 | |
1349 | sub DESTROY { |
1540 | sub DESTROY { |
1350 | my ($self) = @_; |
1541 | my ($self) = @_; |
1351 | |
1542 | |
1352 | delete $self->{term}{_destroy}{$self}; |
1543 | delete $self->{term}{_destroy}{$self}; |
1353 | $self->{term}->ungrab; |
1544 | $self->{term}->ungrab; |
1354 | } |
1545 | } |
|
|
1546 | |
|
|
1547 | =back |
1355 | |
1548 | |
1356 | =head2 The C<urxvt::timer> Class |
1549 | =head2 The C<urxvt::timer> Class |
1357 | |
1550 | |
1358 | This class implements timer watchers/events. Time is represented as a |
1551 | This class implements timer watchers/events. Time is represented as a |
1359 | fractional number of seconds since the epoch. Example: |
1552 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1466 | |
1659 | |
1467 | =item == 0 - fatal messages |
1660 | =item == 0 - fatal messages |
1468 | |
1661 | |
1469 | =item >= 3 - script loading and management |
1662 | =item >= 3 - script loading and management |
1470 | |
1663 | |
1471 | =item >=10 - all events received |
1664 | =item >=10 - all called hooks |
|
|
1665 | |
|
|
1666 | =item >=11 - hook reutrn values |
1472 | |
1667 | |
1473 | =back |
1668 | =back |
1474 | |
1669 | |
1475 | =head1 AUTHOR |
1670 | =head1 AUTHOR |
1476 | |
1671 | |