ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC

1=encoding utf8
2
1=head1 NAME 3=head1 NAME
2 4
3@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter 5@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4 6
5=head1 SYNOPSIS 7=head1 SYNOPSIS
15 17
16 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
17 19
18=head1 DESCRIPTION 20=head1 DESCRIPTION
19 21
20Everytime a terminal object gets created, scripts specified via the 22Everytime a terminal object gets created, extension scripts specified via
21C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
22 24
23Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
24thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
25 27
26Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
27scripts will be shared (But not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
28 30
29=head1 PACKAGED EXTENSIONS 31=head2 Prepackaged Extensions
30 32
31This section describes the extensiosn delivered with this version. You can 33This section describes the extensiosn delivered with this version. You can
32find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
33 35
34You can activate them like this: 36You can activate them like this:
35 37
36 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
37 39
38=over 4 40=over 4
39 41
40=item selection 42=item selection (enabled by default)
41 43
42Miscellaneous selection modifications. 44Intelligent selection. This extension tries to be more intelligent when
45the user extends selections (double-click). Right now, it tries to select
46urls and complete shell-quoted arguments, which is very convenient, too,
47if your F<ls> supports C<--quoting-style=shell>.
48
49It also offers the following bindable event:
43 50
44=over 4 51=over 4
45 52
46=item rot13 53=item rot13
47 54
49 56
50 URxvt.keysym.C-M-r: perl:selection:rot13 57 URxvt.keysym.C-M-r: perl:selection:rot13
51 58
52=back 59=back
53 60
61=item option-popup (enabled by default)
62
63Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at
64runtime.
65
54=item digital-clock 66=item digital-clock
67
68Displays a digital clock using the built-in overlay.
69
70=item mark-urls
71
72Uses per-line display filtering (C<on_line_update>) to underline urls.
73
74=item block-graphics-to-ascii
75
76A not very useful example of filtering all text output to the terminal,
77by replacing all line-drawing characters (U+2500 .. U+259F) by a
78similar-looking ascii character.
79
80=item example-refresh-hooks
55 81
56Displays a very simple digital clock in the upper right corner of the 82Displays a very simple digital clock in the upper right corner of the
57window. Illustrates overwriting the refresh callbacks to create your own 83window. Illustrates overwriting the refresh callbacks to create your own
58overlays or changes. 84overlays or changes.
59 85
60=item simple-overlay-clock
61
62Displays a digital clock using the built-in overlay (colorful, useless).
63
64=back 86=back
65 87
66=head2 General API Considerations 88=head2 General API Considerations
67 89
68All objects (such as terminals, time watchers etc.) are typical 90All objects (such as terminals, time watchers etc.) are typical
69reference-to-hash objects. The hash can be used to store anything you 91reference-to-hash objects. The hash can be used to store anything you
70like. All members starting with an underscore (such as C<_ptr> or 92like. All members starting with an underscore (such as C<_ptr> or
71C<_hook>) are reserved for internal uses and must not be accessed or 93C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
72modified). 94modified).
73 95
74When objects are destroyed on the C++ side, the perl object hashes are 96When objects are destroyed on the C++ side, the perl object hashes are
75emptied, so its best to store related objects such as time watchers and 97emptied, so its best to store related objects such as time watchers and
76the like inside the terminal object so they get destroyed as soon as the 98the like inside the terminal object so they get destroyed as soon as the
77terminal is destroyed. 99terminal is destroyed.
78 100
101Argument names also often indicate the type of a parameter. Here are some
102hints on what they mean:
103
104=over 4
105
106=item $text
107
108Rxvt-unicodes special way of encoding text, where one "unicode" character
109always represents one screen cell. See L<row_t> for a discussion of this format.
110
111=item $string
112
113A perl text string, with an emphasis on I<text>. It can store all unicode
114characters and is to be distinguished with text encoded in a specific
115encoding (often locale-specific) and binary data.
116
117=item $octets
118
119Either binary data or - more common - a text string encoded in a
120locale-specific way.
121
122=back
123
79=head2 Hooks 124=head2 Hooks
80 125
81The following subroutines can be declared in loaded scripts, and will be called 126The following subroutines can be declared in extension files, and will be
82whenever the relevant event happens. 127called whenever the relevant event happens.
128
129The first argument passed to them is an object private to each terminal
130and extension package. You can call all C<urxvt::term> methods on it, but
131its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
132object that is shared between all packages is stored in the C<term>
133member. It is, however, blessed intot he package of the extension script,
134so for all practical purposes you can treat an extension script as a class.
83 135
84All of them must return a boolean value. If it is true, then the event 136All of them must return a boolean value. If it is true, then the event
85counts as being I<consumed>, and the invocation of other hooks is skipped, 137counts as being I<consumed>, and the invocation of other hooks is skipped,
86and the relevant action might not be carried out by the C++ code. 138and the relevant action might not be carried out by the C++ code.
87 139
90=over 4 142=over 4
91 143
92=item on_init $term 144=item on_init $term
93 145
94Called after a new terminal object has been initialized, but before 146Called after a new terminal object has been initialized, but before
95windows are created or the command gets run. 147windows are created or the command gets run. Most methods are unsafe to
148call or deliver senseless data, as terminal size and other characteristics
149have not yet been determined. You can safely query and change resources,
150though.
96 151
97=item on_reset $term 152=item on_reset $term
98 153
99Called after the screen is "reset" for any reason, such as resizing or 154Called after the screen is "reset" for any reason, such as resizing or
100control sequences. Here is where you can react on changes to size-related 155control sequences. Here is where you can react on changes to size-related
120requested from the server. The selection text can be queried and changed 175requested from the server. The selection text can be queried and changed
121by calling C<< $term->selection >>. 176by calling C<< $term->selection >>.
122 177
123Returning a true value aborts selection grabbing. It will still be hilighted. 178Returning a true value aborts selection grabbing. It will still be hilighted.
124 179
125=item on_focus_in $term 180=item on_sel_extend $term
126 181
127Called whenever the window gets the keyboard focus, before urxvt does 182Called whenever the user tries to extend the selection (e.g. with a double
128focus in processing. 183click) and is either supposed to return false (normal operation), or
129 184should extend the selection itelf and return true to suppress the built-in
130=item on_focus_out $term
131
132Called wheneever the window loses keyboard focus, before urxvt does focus
133out processing. 185processing.
186
187See the F<selection> example extension.
134 188
135=item on_view_change $term, $offset 189=item on_view_change $term, $offset
136 190
137Called whenever the view offset changes, i..e the user or program 191Called whenever the view offset changes, i..e the user or program
138scrolls. Offset C<0> means display the normal terminal, positive values 192scrolls. Offset C<0> means display the normal terminal, positive values
149number of lines that will be in the scrollback buffer. 203number of lines that will be in the scrollback buffer.
150 204
151=item on_tty_activity $term *NYI* 205=item on_tty_activity $term *NYI*
152 206
153Called whenever the program(s) running in the urxvt window send output. 207Called whenever the program(s) running in the urxvt window send output.
208
209=item on_osc_seq $term, $string
210
211Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212operating system command) is processed. Cursor position and other state
213information is up-to-date when this happens. For interoperability, the
214string should start with the extension name and a colon, to distinguish
215it from commands for other extensions, and this might be enforced in the
216future.
217
218Be careful not ever to trust (in a security sense) the data you receive,
219as its source can not easily be controleld (e-mail content, messages from
220other users on the same system etc.).
221
222=item on_add_lines $term, $string
223
224Called whenever text is about to be output, with the text as argument. You
225can filter/change and output the text yourself by returning a true value
226and calling C<< $term->scr_add_lines >> yourself. Please note that this
227might be very slow, however, as your hook is called for B<all> text being
228output.
229
230=item on_line_update $term, $row
231
232Called whenever a line was updated or changed. Can be used to filter
233screen output (e.g. underline urls or other useless stuff). Only lines
234that are being shown will be filtered, and, due to performance reasons,
235not always immediately.
236
237The row number is always the topmost row of the line if the line spans
238multiple rows.
239
240Please note that, if you change the line, then the hook might get called
241later with the already-modified line (e.g. if unrelated parts change), so
242you cannot just toggle rendition bits, but only set them.
154 243
155=item on_refresh_begin $term 244=item on_refresh_begin $term
156 245
157Called just before the screen gets redrawn. Can be used for overlay 246Called just before the screen gets redrawn. Can be used for overlay
158or similar effects by modify terminal contents in refresh_begin, and 247or similar effects by modify terminal contents in refresh_begin, and
167 256
168Called whenever the user presses a key combination that has a 257Called whenever the user presses a key combination that has a
169C<perl:string> action bound to it (see description of the B<keysym> 258C<perl:string> action bound to it (see description of the B<keysym>
170resource in the @@RXVT_NAME@@(1) manpage). 259resource in the @@RXVT_NAME@@(1) manpage).
171 260
261=item on_focus_in $term
262
263Called whenever the window gets the keyboard focus, before rxvt-unicode
264does focus in processing.
265
266=item on_focus_out $term
267
268Called wheneever the window loses keyboard focus, before rxvt-unicode does
269focus out processing.
270
271=item on_key_press $term, $event, $octets
272
273=item on_key_release $term, $event
274
275=item on_button_press $term, $event
276
277=item on_button_release $term, $event
278
279=item on_motion_notify $term, $event
280
281=item on_map_notify $term, $event
282
283=item on_unmap_notify $term, $event
284
285Called whenever the corresponding X event is received for the terminal If
286the hook returns true, then the even will be ignored by rxvt-unicode.
287
288The event is a hash with most values as named by Xlib (see the XEvent
289manpage), with the additional members C<row> and C<col>, which are the row
290and column under the mouse cursor.
291
292C<on_key_press> additionally receives the string rxvt-unicode would
293output, if any, in locale-specific encoding.
294
295subwindow.
296
172=back 297=back
173 298
299=head2 Variables in the C<urxvt> Package
300
301=over 4
302
303=item $urxvt::TERM
304
305The current terminal. This variable stores the current C<urxvt::term>
306object, whenever a callback/hook is executing.
307
308=back
309
174=head2 Functions in the C<urxvt> Package 310=head2 Functions in the C<urxvt> Package
175 311
176=over 4 312=over 4
313
314=item $term = new urxvt [arg...]
315
316Creates a new terminal, very similar as if you had started it with
317C<system $binfile, arg...>. Croaks (and probably outputs an error message)
318if the new instance couldn't be created. Returns C<undef> if the new
319instance didn't initialise perl, and the terminal object otherwise. The
320C<init> and C<start> hooks will be called during the call.
177 321
178=item urxvt::fatal $errormessage 322=item urxvt::fatal $errormessage
179 323
180Fatally aborts execution with the given error message. Avoid at all 324Fatally aborts execution with the given error message. Avoid at all
181costs! The only time this is acceptable is when the terminal process 325costs! The only time this is acceptable is when the terminal process
192 336
193=item $time = urxvt::NOW 337=item $time = urxvt::NOW
194 338
195Returns the "current time" (as per the event loop). 339Returns the "current time" (as per the event loop).
196 340
341=item urxvt::CurrentTime
342
343=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
344Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
345Button4Mask, Button5Mask, AnyModifier
346
347Various constants for use in X events.
348
349=back
350
351=head2 RENDITION
352
353Rendition bitsets contain information about colour, font, font styles and
354similar information for each screen cell.
355
356The following "macros" deal with changes in rendition sets. You should
357never just create a bitset, you should always modify an existing one,
358as they contain important information required for correct operation of
359rxvt-unicode.
360
361=over 4
362
363=item $rend = urxvt::DEFAULT_RSTYLE
364
365Returns the default rendition, as used when the terminal is starting up or
366being reset. Useful as a base to start when creating renditions.
367
368=item $rend = urxvt::OVERLAY_RSTYLE
369
370Return the rendition mask used for overlays by default.
371
372=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
373
374Return the bit that enabled bold, italic, blink, reverse-video and
375underline, respectively. To enable such a style, just logically OR it into
376the bitset.
377
378=item $foreground = urxvt::GET_BASEFG $rend
379
380=item $background = urxvt::GET_BASEBG $rend
381
382Return the foreground/background colour index, respectively.
383
384=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
385
386=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
387
388Replace the foreground/background colour in the rendition mask with the
389specified one.
390
391=item $value = urxvt::GET_CUSTOM ($rend)
392
393Return the "custom" value: Every rendition has 5 bits for use by
394extensions. They can be set and changed as you like and are initially
395zero.
396
397=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
398
399Change the custom value.
400
401=back
402
197=cut 403=cut
198 404
199package urxvt; 405package urxvt;
200 406
407use utf8;
201use strict; 408use strict;
409use Scalar::Util ();
410use List::Util ();
202 411
203our $term; 412our $TERM;
204our @HOOKNAME; 413our @HOOKNAME;
414our %OPTION;
205our $LIBDIR; 415our $LIBDIR;
206 416
207BEGIN { 417BEGIN {
208 urxvt->bootstrap; 418 urxvt->bootstrap;
209 419
233 my $name = $HOOKNAME[$htype]; 443 my $name = $HOOKNAME[$htype];
234 444
235 my $ref = $pkg->can ("on_" . lc $name) 445 my $ref = $pkg->can ("on_" . lc $name)
236 or next; 446 or next;
237 447
238 $term->{_hook}[$htype]{$ref*1} = $ref; 448 $TERM->{_hook}[$htype]{$pkg} = $ref;
239 $hook_count[$htype]++ 449 $hook_count[$htype]++
240 or set_should_invoke $htype, 1; 450 or set_should_invoke $htype, 1;
241 } 451 }
242} 452}
243 453
244my $script_pkg = "script0000"; 454my $extension_pkg = "extension0000";
245my %script_pkg; 455my %extension_pkg;
246 456
247# load a single script into its own package, once only 457# load a single script into its own package, once only
248sub script_package($) { 458sub extension_package($) {
249 my ($path) = @_; 459 my ($path) = @_;
250 460
251 $script_pkg{$path} ||= do { 461 $extension_pkg{$path} ||= do {
252 my $pkg = "urxvt::" . ($script_pkg++); 462 my $pkg = "urxvt::" . ($extension_pkg++);
253 463
254 verbose 3, "loading script '$path' into package '$pkg'"; 464 verbose 3, "loading extension '$path' into package '$pkg'";
255 465
256 open my $fh, "<:raw", $path 466 open my $fh, "<:raw", $path
257 or die "$path: $!"; 467 or die "$path: $!";
258 468
259 my $source = "package $pkg; use strict; use utf8;\n" 469 my $source = "package $pkg; use strict; use utf8;\n"
470 . "use base urxvt::term::proxy::;\n"
260 . "#line 1 \"$path\"\n{\n" 471 . "#line 1 \"$path\"\n{\n"
261 . (do { local $/; <$fh> }) 472 . (do { local $/; <$fh> })
262 . "\n};\n1"; 473 . "\n};\n1";
263 474
264 eval $source or die "$path: $@"; 475 eval $source or die "$path: $@";
265 476
266 $pkg 477 $pkg
267 } 478 }
268} 479}
269 480
481our $retval; # return value for urxvt
482
270# called by the rxvt core 483# called by the rxvt core
271sub invoke { 484sub invoke {
272 local $term = shift; 485 local $TERM = shift;
273 my $htype = shift; 486 my $htype = shift;
274 487
275 if ($htype == 0) { # INIT 488 if ($htype == 0) { # INIT
276 my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); 489 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
490
491 my %want_ext;
277 492
278 for my $ext (split /:/, $term->resource ("perl_ext")) { 493 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
494 if ($_ eq "default") {
495 $want_ext{$_}++ for qw(selection option-popup);
496 } elsif (/^-(.*)$/) {
497 delete $want_ext{$1};
498 } else {
499 $want_ext{$_}++;
500 }
501 }
502
503 for my $ext (keys %want_ext) {
279 my @files = grep -f $_, map "$_/$ext", @dirs; 504 my @files = grep -f $_, map "$_/$ext", @dirs;
280 505
281 if (@files) { 506 if (@files) {
282 register_package script_package $files[0]; 507 register_package extension_package $files[0];
283 } else { 508 } else {
284 warn "perl extension '$ext' not found in perl library search path\n"; 509 warn "perl extension '$ext' not found in perl library search path\n";
285 } 510 }
286 } 511 }
512 }
287 513
514 $retval = undef;
515
516 if (my $cb = $TERM->{_hook}[$htype]) {
517 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
518 if $verbosity >= 10;
519
520 keys %$cb;
521
522 while (my ($pkg, $cb) = each %$cb) {
523 eval {
524 $retval = $cb->(
525 $TERM->{_pkg}{$pkg} ||= do {
526 my $proxy = bless { }, $pkg;
527 Scalar::Util::weaken ($proxy->{term} = $TERM);
528 $proxy
529 },
530 @_,
531 ) and last;
532 };
533 warn $@ if $@;#d#
534 }
535 }
536
288 } elsif ($htype == 1) { # DESTROY 537 if ($htype == 1) { # DESTROY
538 # remove hooks if unused
289 if (my $hook = $term->{_hook}) { 539 if (my $hook = $TERM->{_hook}) {
290 for my $htype (0..$#$hook) { 540 for my $htype (0..$#$hook) {
291 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 541 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
292 or set_should_invoke $htype, 0; 542 or set_should_invoke $htype, 0;
293 } 543 }
294 } 544 }
545
546 # clear package objects
547 %$_ = () for values %{ $TERM->{_pkg} };
548
549 # clear package
550 %$TERM = ();
295 } 551 }
296 552
297 my $cb = $term->{_hook}[$htype] 553 $retval
298 or return;
299
300 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
301 if $verbosity >= 10;
302
303 while (my ($k, $v) = each %$cb) {
304 return 1 if $v->($term, @_);
305 }
306
307 0
308} 554}
309 555
310=back 556sub urxvt::term::proxy::AUTOLOAD {
557 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
558 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
559
560 eval qq{
561 sub $urxvt::term::proxy::AUTOLOAD {
562 my \$proxy = shift;
563 \$proxy->{term}->$1 (\@_)
564 }
565 1
566 } or die "FATAL: unable to compile method forwarder: $@";
567
568 goto &$urxvt::term::proxy::AUTOLOAD;
569}
570
571sub urxvt::destroy_hook::DESTROY {
572 ${$_[0]}->();
573}
574
575sub urxvt::destroy_hook(&) {
576 bless \shift, urxvt::destroy_hook::
577}
311 578
312=head2 The C<urxvt::term> Class 579=head2 The C<urxvt::term> Class
313 580
314=over 4 581=over 4
582
583=item $term->destroy
584
585Destroy the terminal object (close the window, free resources etc.).
586
587=item $isset = $term->option ($optval[, $set])
588
589Returns true if the option specified by C<$optval> is enabled, and
590optionally change it. All option values are stored by name in the hash
591C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
592
593Here is a a likely non-exhaustive list of option names, please see the
594source file F</src/optinc.h> to see the actual list:
595
596 borderLess console cursorBlink cursorUnderline hold iconic insecure
597 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
598 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
599 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
600 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
601 tripleclickwords utmpInhibit visualBell
315 602
316=item $value = $term->resource ($name[, $newval]) 603=item $value = $term->resource ($name[, $newval])
317 604
318Returns the current resource value associated with a given name and 605Returns the current resource value associated with a given name and
319optionally sets a new value. Setting values is most useful in the C<init> 606optionally sets a new value. Setting values is most useful in the C<init>
329 616
330Please note that resource strings will currently only be freed when the 617Please note that resource strings will currently only be freed when the
331terminal is destroyed, so changing options frequently will eat memory. 618terminal is destroyed, so changing options frequently will eat memory.
332 619
333Here is a a likely non-exhaustive list of resource names, not all of which 620Here is a a likely non-exhaustive list of resource names, not all of which
334are supported in every build, please see the source to see the actual 621are supported in every build, please see the source file F</src/rsinc.h>
335list: 622to see the actual list:
336 623
337 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 624 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
338 borderLess color cursorBlink cursorUnderline cutchars delete_key 625 borderLess color cursorBlink cursorUnderline cutchars delete_key
339 display_name embed ext_bwidth fade font geometry hold iconName 626 display_name embed ext_bwidth fade font geometry hold iconName
340 imFont imLocale inputMethod insecure int_bwidth intensityStyles 627 imFont imLocale inputMethod insecure int_bwidth intensityStyles
341 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 628 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
342 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 629 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
343 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 630 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
344 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 631 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
345 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 632 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
346 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 633 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
347 shade term_name title transparent transparent_all tripleclickwords 634 shade term_name title transparent transparent_all tripleclickwords
350=cut 637=cut
351 638
352sub urxvt::term::resource($$;$) { 639sub urxvt::term::resource($$;$) {
353 my ($self, $name) = (shift, shift); 640 my ($self, $name) = (shift, shift);
354 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 641 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
355 goto &urxvt::term::_resource; 642 &urxvt::term::_resource
356} 643}
644
645=item $rend = $term->rstyle ([$new_rstyle])
646
647Return and optionally change the current rendition. Text that is output by
648the terminal application will use this style.
649
650=item ($row, $col) = $term->screen_cur ([$row, $col])
651
652Return the current coordinates of the text cursor position and optionally
653set it (which is usually bad as applications don't expect that).
357 654
358=item ($row, $col) = $term->selection_mark ([$row, $col]) 655=item ($row, $col) = $term->selection_mark ([$row, $col])
359 656
360=item ($row, $col) = $term->selection_beg ([$row, $col]) 657=item ($row, $col) = $term->selection_beg ([$row, $col])
361 658
371 668
372=item $oldtext = $term->selection ([$newtext]) 669=item $oldtext = $term->selection ([$newtext])
373 670
374Return the current selection text and optionally replace it by C<$newtext>. 671Return the current selection text and optionally replace it by C<$newtext>.
375 672
376=item $term->scr_overlay ($x, $y, $text) 673#=item $term->overlay ($x, $y, $text)
377 674#
378Create a simple multi-line overlay box. See the next method for details. 675#Create a simple multi-line overlay box. See the next method for details.
676#
677#=cut
678#
679#sub urxvt::term::scr_overlay {
680# my ($self, $x, $y, $text) = @_;
681#
682# my @lines = split /\n/, $text;
683#
684# my $w = 0;
685# for (map $self->strwidth ($_), @lines) {
686# $w = $_ if $w < $_;
687# }
688#
689# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
690# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
691#}
692
693=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
694
695Create a new (empty) overlay at the given position with the given
696width/height. C<$rstyle> defines the initial rendition style
697(default: C<OVERLAY_RSTYLE>).
698
699If C<$border> is C<2> (default), then a decorative border will be put
700around the box.
701
702If either C<$x> or C<$y> is negative, then this is counted from the
703right/bottom side, respectively.
704
705This method returns an urxvt::overlay object. The overlay will be visible
706as long as the perl object is referenced.
707
708The methods currently supported on C<urxvt::overlay> objects are:
709
710=over 4
711
712=item $overlay->set ($x, $y, $text, $rend)
713
714Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
715text in rxvt-unicode's special encoding and an array of rendition values
716at a specific position inside the overlay.
717
718=item $overlay->hide
719
720If visible, hide the overlay, but do not destroy it.
721
722=item $overlay->show
723
724If hidden, display the overlay again.
725
726=back
727
728=item $popup = $term->popup ($event)
729
730Creates a new C<urxvt::popup> object that implements a popup menu. The
731C<$event> I<must> be the event causing the menu to pop up (a button event,
732currently).
379 733
380=cut 734=cut
381 735
382sub urxvt::term::scr_overlay { 736sub urxvt::term::popup {
383 my ($self, $x, $y, $text) = @_; 737 my ($self, $event) = @_;
384 738
385 my @lines = split /\n/, $text; 739 $self->grab ($event->{time}, 1)
740 or return;
386 741
387 my $w = 0; 742 my $popup = bless {
388 for (map $self->strwidth ($_), @lines) { 743 term => $self,
389 $w = $_ if $w < $_; 744 event => $event,
390 } 745 }, urxvt::popup::;
391 746
392 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 747 Scalar::Util::weaken $popup->{term};
393 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
394}
395 748
396=item $term->scr_overlay_new ($x, $y, $width, $height) 749 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
750 Scalar::Util::weaken $self->{_destroy}{$popup};
397 751
398Create a new (empty) overlay at the given position with the given 752 $popup
399width/height. A border will be put around the box. If either C<$x> or 753}
400C<$y> is negative, then this is counted from the right/bottom side,
401respectively.
402 754
403=item $term->scr_overlay_off
404
405Switch the overlay off again.
406
407=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)
408
409Put a single character (specified numerically) at the given overlay
410position.
411
412=item $term->scr_overlay_set ($x, $y, $text)
413
414Write a string at the given position into the overlay.
415
416=item $cellwidth = $term->strwidth $string 755=item $cellwidth = $term->strwidth ($string)
417 756
418Returns the number of screen-cells this string would need. Correctly 757Returns the number of screen-cells this string would need. Correctly
419accounts for wide and combining characters. 758accounts for wide and combining characters.
420 759
421=item $octets = $term->locale_encode $string 760=item $octets = $term->locale_encode ($string)
422 761
423Convert the given text string into the corresponding locale encoding. 762Convert the given text string into the corresponding locale encoding.
424 763
425=item $string = $term->locale_decode $octets 764=item $string = $term->locale_decode ($octets)
426 765
427Convert the given locale-encoded octets into a perl string. 766Convert the given locale-encoded octets into a perl string.
767
768=item $term->scr_add_lines ($string)
769
770Write the given text string to the screen, as if output by the application
771running inside the terminal. It may not contain command sequences (escape
772codes), but is free to use line feeds, carriage returns and tabs. The
773string is a normal text string, not in locale-dependent encoding.
774
775Normally its not a good idea to use this function, as programs might be
776confused by changes in cursor position or scrolling. Its useful inside a
777C<on_add_lines> hook, though.
778
779=item $term->cmd_parse ($octets)
780
781Similar to C<scr_add_lines>, but the argument must be in the
782locale-specific encoding of the terminal and can contain command sequences
783(escape codes) that will be interpreted.
428 784
429=item $term->tt_write ($octets) 785=item $term->tt_write ($octets)
430 786
431Write the octets given in C<$data> to the tty (i.e. as program input). To 787Write the octets given in C<$data> to the tty (i.e. as program input). To
432pass characters instead of octets, you should convert your strings first 788pass characters instead of octets, you should convert your strings first
433to the locale-specific encoding using C<< $term->locale_encode >>. 789to the locale-specific encoding using C<< $term->locale_encode >>.
434 790
791=item $windowid = $term->parent
792
793Return the window id of the toplevel window.
794
795=item $windowid = $term->vt
796
797Return the window id of the terminal window.
798
799=item $window_width = $term->width
800
801=item $window_height = $term->height
802
803=item $font_width = $term->fwidth
804
805=item $font_height = $term->fheight
806
807=item $font_ascent = $term->fbase
808
435=item $nrow = $term->nrow 809=item $terminal_rows = $term->nrow
436 810
437=item $ncol = $term->ncol 811=item $terminal_columns = $term->ncol
438 812
439Return the number of rows/columns of the terminal window (i.e. as 813=item $has_focus = $term->focus
440specified by C<-geometry>, excluding any scrollback).
441 814
442=item $nsaved = $term->nsaved 815=item $is_mapped = $term->mapped
443 816
444Returns the number of lines in the scrollback buffer. 817=item $max_scrollback = $term->saveLines
818
819=item $nrow_plus_saveLines = $term->total_rows
820
821=item $lines_in_scrollback = $term->nsaved
822
823Return various integers describing terminal characteristics.
824
825=item $modifiermask = $term->ModLevel3Mask
826
827=item $modifiermask = $term->ModMetaMask
828
829=item $modifiermask = $term->ModNumLockMask
830
831Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
832AltGr), the meta key (often Alt) and the num lock key, if applicable.
445 833
446=item $view_start = $term->view_start ([$newvalue]) 834=item $view_start = $term->view_start ([$newvalue])
447 835
448Returns the negative row number of the topmost line. Minimum value is 836Returns the negative row number of the topmost line. Minimum value is
449C<0>, which displays the normal terminal contents. Larger values scroll 837C<0>, which displays the normal terminal contents. Larger values scroll
460=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 848=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
461 849
462Returns the text of the entire row with number C<$row_number>. Row C<0> 850Returns the text of the entire row with number C<$row_number>. Row C<0>
463is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 851is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
464terminal line. The scrollback buffer starts at line C<-1> and extends to 852terminal line. The scrollback buffer starts at line C<-1> and extends to
465line C<< -$term->nsaved >>. 853line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
854is requested.
466 855
467If C<$new_text> is specified, it will replace characters in the current 856If C<$new_text> is specified, it will replace characters in the current
468line, starting at column C<$start_col> (default C<0>), which is useful 857line, starting at column C<$start_col> (default C<0>), which is useful
469to replace only parts of a line. The font iindex in the rendition will 858to replace only parts of a line. The font index in the rendition will
470automatically be updated. 859automatically be updated.
471 860
472C<$text> is in a special encoding: tabs and wide characters that use more 861C<$text> is in a special encoding: tabs and wide characters that use more
473than one cell when displayed are padded with urxvt::NOCHAR characters 862than one cell when displayed are padded with urxvt::NOCHAR characters
474(C<chr 65535>). Characters with combining characters and other characters 863(C<chr 65535>). Characters with combining characters and other characters
488bitsets. Rendition bitsets contain information about colour, font, font 877bitsets. Rendition bitsets contain information about colour, font, font
489styles and similar information. See also C<< $term->ROW_t >>. 878styles and similar information. See also C<< $term->ROW_t >>.
490 879
491When setting rendition, the font mask will be ignored. 880When setting rendition, the font mask will be ignored.
492 881
493See the section on RENDITION, below. 882See the section on RENDITION, above.
494 883
495=item $length = $term->ROW_l ($row_number[, $new_length]) 884=item $length = $term->ROW_l ($row_number[, $new_length])
496 885
497Returns the number of screen cells that are in use ("the line length"). If 886Returns the number of screen cells that are in use ("the line
498it is C<-1>, then the line is part of a multiple-row logical "line", which 887length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
499means all characters are in use and it is continued on the next row. 888line is joined with the following one.
500 889
890=item $bool = $term->is_longer ($row_number)
891
892Returns true if the row is part of a multiple-row logical "line" (i.e.
893joined with the following row), which means all characters are in use
894and it is continued on the next row (and possibly a continuation of the
895previous row(s)).
896
897=item $line = $term->line ($row_number)
898
899Create and return a new C<urxvt::line> object that stores information
900about the logical line that row C<$row_number> is part of. It supports the
901following methods:
902
903=over 4
904
905=item $text = $line->t ([$new_text])
906
907Returns or replaces the full text of the line, similar to C<ROW_t>
908
909=item $rend = $line->r ([$new_rend])
910
911Returns or replaces the full rendition array of the line, similar to C<ROW_r>
912
913=item $length = $line->l
914
915Returns the length of the line in cells, similar to C<ROW_l>.
916
917=item $rownum = $line->beg
918
919=item $rownum = $line->end
920
921Return the row number of the first/last row of the line, respectively.
922
923=item $offset = $line->offset_of ($row, $col)
924
925Returns the character offset of the given row|col pair within the logical
926line.
927
928=item ($row, $col) = $line->coord_of ($offset)
929
930Translates a string offset into terminal coordinates again.
931
932=back
933
934=cut
935
936sub urxvt::term::line {
937 my ($self, $row) = @_;
938
939 my $maxrow = $self->nrow - 1;
940
941 my ($beg, $end) = ($row, $row);
942
943 --$beg while $self->ROW_is_longer ($beg - 1);
944 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
945
946 bless {
947 term => $self,
948 beg => $beg,
949 end => $end,
950 ncol => $self->ncol,
951 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
952 }, urxvt::line::
953}
954
955sub urxvt::line::t {
956 my ($self) = @_;
957
958 if (@_ > 1)
959 {
960 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
961 for $self->{beg} .. $self->{end};
962 }
963
964 defined wantarray &&
965 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
966 0, $self->{len}
967}
968
969sub urxvt::line::r {
970 my ($self) = @_;
971
972 if (@_ > 1)
973 {
974 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
975 for $self->{beg} .. $self->{end};
976 }
977
978 if (defined wantarray) {
979 my $rend = [
980 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
981 ];
982 $#$rend = $self->{len} - 1;
983 return $rend;
984 }
985
986 ()
987}
988
989sub urxvt::line::beg { $_[0]{beg} }
990sub urxvt::line::end { $_[0]{end} }
991sub urxvt::line::l { $_[0]{len} }
992
993sub urxvt::line::offset_of {
994 my ($self, $row, $col) = @_;
995
996 ($row - $self->{beg}) * $self->{ncol} + $col
997}
998
999sub urxvt::line::coord_of {
1000 my ($self, $offset) = @_;
1001
1002 use integer;
1003
1004 (
1005 $offset / $self->{ncol} + $self->{beg},
1006 $offset % $self->{ncol}
1007 )
1008}
1009
1010=item ($row, $col) = $line->coord_of ($offset)
501=item $text = $term->special_encode $string 1011=item $text = $term->special_encode $string
502 1012
503Converts a perl string into the special encoding used by rxvt-unicode, 1013Converts a perl string into the special encoding used by rxvt-unicode,
504where one character corresponds to one screen cell. See 1014where one character corresponds to one screen cell. See
505C<< $term->ROW_t >> for details. 1015C<< $term->ROW_t >> for details.
509Converts rxvt-unicodes text reprsentation into a perl string. See 1019Converts rxvt-unicodes text reprsentation into a perl string. See
510C<< $term->ROW_t >> for details. 1020C<< $term->ROW_t >> for details.
511 1021
512=back 1022=back
513 1023
514=head2 RENDITION 1024=head2 The C<urxvt::popup> Class
515 1025
516Rendition bitsets contain information about colour, font, font styles and
517similar information for each screen cell.
518
519The following "macros" deal with changes in rendition sets. You should
520never just create a bitset, you should always modify an existing one,
521as they contain important information required for correct operation of
522rxvt-unicode.
523
524=over 4 1026=over 4
525
526=item $rend = urxvt::DEFAULT_RSTYLE
527
528Returns the default rendition, as used when the terminal is starting up or
529being reset. Useful as a base
530
531=back
532 1027
533=cut 1028=cut
1029
1030package urxvt::popup;
1031
1032sub add_item {
1033 my ($self, $item) = @_;
1034
1035 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1036 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1037 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1038
1039 $item->{render} ||= sub { $_[0]{text} };
1040
1041 push @{ $self->{item} }, $item;
1042}
1043
1044sub add_separator {
1045 my ($self, $sep) = @_;
1046
1047 $sep ||= "═";
1048
1049 $self->add_item ({
1050 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1051 text => "",
1052 render => sub { $sep x $urxvt::TERM->ncol },
1053 activate => sub { },
1054 });
1055}
1056
1057sub add_title {
1058 my ($self, $title) = @_;
1059
1060 $self->add_item ({
1061 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1062 text => $title,
1063 activate => sub { },
1064 });
1065}
1066
1067sub add_button {
1068 my ($self, $text, $cb) = @_;
1069
1070 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
1071}
1072
1073sub add_toggle {
1074 my ($self, $text, $cb, $value) = @_;
1075
1076 my $item; $item = {
1077 type => "button",
1078 text => " $text",
1079 value => $value,
1080 render => sub { ($item->{value} ? "* " : " ") . $text },
1081 activate => sub { $cb->($item->{value} = !$item->{value}); },
1082 };
1083
1084 $self->add_item ($item);
1085}
1086
1087sub show {
1088 my ($self) = @_;
1089
1090 local $urxvt::popup::self = $self;
1091
1092 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1093 "--transient-for" => $self->{term}->parent,
1094 "-pe" => "urxvt-popup")
1095 or die "unable to create popup window\n";
1096}
1097
1098sub DESTROY {
1099 my ($self) = @_;
1100
1101 $self->{term}->ungrab;
1102}
534 1103
535=head2 The C<urxvt::timer> Class 1104=head2 The C<urxvt::timer> Class
536 1105
537This class implements timer watchers/events. Time is represented as a 1106This class implements timer watchers/events. Time is represented as a
538fractional number of seconds since the epoch. Example: 1107fractional number of seconds since the epoch. Example:
539 1108
540 # create a digital clock display in upper right corner 1109 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
541 $term->{timer} = urxvt::timer 1110 $term->{timer} = urxvt::timer
542 ->new 1111 ->new
543 ->start (urxvt::NOW) 1112 ->interval (1)
544 ->cb (sub { 1113 ->cb (sub {
545 my ($timer) = @_;
546 my $time = $timer->at;
547 $timer->start ($time + 1);
548 $self->scr_overlay (-1, 0, 1114 $term->{overlay}->set (0, 0,
549 POSIX::strftime "%H:%M:%S", localtime $time); 1115 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
550 }); 1116 });
551 1117
552=over 4 1118=over 4
553 1119
554=item $timer = new urxvt::timer 1120=item $timer = new urxvt::timer
555 1121
556Create a new timer object in stopped state. 1122Create a new timer object in started state. It is scheduled to fire
1123immediately.
557 1124
558=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 1125=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
559 1126
560Set the callback to be called when the timer triggers. 1127Set the callback to be called when the timer triggers.
561 1128
564Return the time this watcher will fire next. 1131Return the time this watcher will fire next.
565 1132
566=item $timer = $timer->set ($tstamp) 1133=item $timer = $timer->set ($tstamp)
567 1134
568Set the time the event is generated to $tstamp. 1135Set the time the event is generated to $tstamp.
1136
1137=item $timer = $timer->interval ($interval)
1138
1139Normally (and when C<$interval> is C<0>), the timer will automatically
1140stop after it has fired once. If C<$interval> is non-zero, then the timer
1141is automatically rescheduled at the given intervals.
569 1142
570=item $timer = $timer->start 1143=item $timer = $timer->start
571 1144
572Start the timer. 1145Start the timer.
573 1146
636This variable controls the verbosity level of the perl extension. Higher 1209This variable controls the verbosity level of the perl extension. Higher
637numbers indicate more verbose output. 1210numbers indicate more verbose output.
638 1211
639=over 4 1212=over 4
640 1213
641=item 0 - only fatal messages 1214=item =0 - only fatal messages
642 1215
643=item 3 - script loading and management 1216=item =3 - script loading and management
644 1217
645=item 10 - all events received 1218=item =10 - all events received
646 1219
647=back 1220=back
648 1221
649=head1 AUTHOR 1222=head1 AUTHOR
650 1223

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines