--- rxvt-unicode/src/urxvt.pm 2006/01/02 18:20:23 1.6 +++ rxvt-unicode/src/urxvt.pm 2006/01/08 22:58:13 1.58 @@ -1,49 +1,137 @@ +=encoding utf8 + =head1 NAME -rxvtperl - rxvt-unicode's embedded perl interpreter +@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter =head1 SYNOPSIS -* Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, they will be loaded automatically. - -* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and -thus must be encoded as UTF-8. + # create a file grab_test in $HOME: sub on_sel_grab { warn "you selected ", $_[0]->selection; () } - 1 + # start a @@RXVT_NAME@@ using it: + + @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test =head1 DESCRIPTION -On startup, @@RXVT_NAME@@ will scan F<@@RXVT_LIBDIR@@/urxvt/perl-ext/> -for files and will load them. Everytime a terminal object gets created, -the directory specified by the C resource will be additionally -scanned. +Everytime a terminal object gets created, extension scripts specified via +the C resource are loaded and associated with it. + +Scripts are compiled in a 'use strict' and 'use utf8' environment, and +thus must be encoded as UTF-8. Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where -scripts will be shared for all terminals. +scripts will be shared (but not enabled) for all terminals. + +=head2 Prepackaged Extensions + +This section describes the extensiosn delivered with this version. You can +find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. + +You can activate them like this: + + @@RXVT_NAME@@ -pe + +=over 4 + +=item selection (enabled by default) + +Intelligent selection. This extension tries to be more intelligent when +the user extends selections (double-click). Right now, it tries to select +urls and complete shell-quoted arguments, which is very convenient, too, +if your F supports C<--quoting-style=shell>. + +It also offers the following bindable event: + +=over 4 + +=item rot13 + +Rot-13 the selection when activated. Used via keyboard trigger: + + URxvt.keysym.C-M-r: perl:selection:rot13 -Hooks in scripts specified by C will only be called for the -terminals created with that specific option value. +=back + +=item option-popup (enabled by default) + +Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at +runtime. + +=item digital-clock + +Displays a digital clock using the built-in overlay. + +=item mark-urls + +Uses per-line display filtering (C) to underline urls. + +=item block-graphics-to-ascii + +A not very useful example of filtering all text output to the terminal, +by replacing all line-drawing characters (U+2500 .. U+259F) by a +similar-looking ascii character. + +=item example-refresh-hooks + +Displays a very simple digital clock in the upper right corner of the +window. Illustrates overwriting the refresh callbacks to create your own +overlays or changes. + +=back =head2 General API Considerations All objects (such as terminals, time watchers etc.) are typical reference-to-hash objects. The hash can be used to store anything you -like. The only reserved member is C<_ptr>, which must not be changed. +like. All members starting with an underscore (such as C<_ptr> or +C<_hook>) are reserved for internal uses and B be accessed or +modified). When objects are destroyed on the C++ side, the perl object hashes are emptied, so its best to store related objects such as time watchers and the like inside the terminal object so they get destroyed as soon as the terminal is destroyed. +Argument names also often indicate the type of a parameter. Here are some +hints on what they mean: + +=over 4 + +=item $text + +Rxvt-unicodes special way of encoding text, where one "unicode" character +always represents one screen cell. See L for a discussion of this format. + +=item $string + +A perl text string, with an emphasis on I. It can store all unicode +characters and is to be distinguished with text encoded in a specific +encoding (often locale-specific) and binary data. + +=item $octets + +Either binary data or - more common - a text string encoded in a +locale-specific way. + +=back + =head2 Hooks -The following subroutines can be declared in loaded scripts, and will be called -whenever the relevant event happens. +The following subroutines can be declared in extension files, and will be +called whenever the relevant event happens. + +The first argument passed to them is an object private to each terminal +and extension package. You can call all C methods on it, but +its not a real C object. Instead, the real C +object that is shared between all packages is stored in the C +member. It is, however, blessed intot he package of the extension script, +so for all practical purposes you can treat an extension script as a class. All of them must return a boolean value. If it is true, then the event counts as being I, and the invocation of other hooks is skipped, @@ -56,7 +144,10 @@ =item on_init $term Called after a new terminal object has been initialized, but before -windows are created or the command gets run. +windows are created or the command gets run. Most methods are unsafe to +call or deliver senseless data, as terminal size and other characteristics +have not yet been determined. You can safely query and change resources, +though. =item on_reset $term @@ -86,15 +177,14 @@ Returning a true value aborts selection grabbing. It will still be hilighted. -=item on_focus_in $term - -Called whenever the window gets the keyboard focus, before urxvt does -focus in processing. +=item on_sel_extend $term -=item on_focus_out $term +Called whenever the user tries to extend the selection (e.g. with a double +click) and is either supposed to return false (normal operation), or +should extend the selection itelf and return true to suppress the built-in +processing. -Called wheneever the window loses keyboard focus, before urxvt does focus -out processing. +See the F example extension. =item on_view_change $term, $offset @@ -116,6 +206,41 @@ Called whenever the program(s) running in the urxvt window send output. +=item on_osc_seq $term, $string + +Called whenever the B command sequence (OSC = +operating system command) is processed. Cursor position and other state +information is up-to-date when this happens. For interoperability, the +string should start with the extension name and a colon, to distinguish +it from commands for other extensions, and this might be enforced in the +future. + +Be careful not ever to trust (in a security sense) the data you receive, +as its source can not easily be controleld (e-mail content, messages from +other users on the same system etc.). + +=item on_add_lines $term, $string + +Called whenever text is about to be output, with the text as argument. You +can filter/change and output the text yourself by returning a true value +and calling C<< $term->scr_add_lines >> yourself. Please note that this +might be very slow, however, as your hook is called for B text being +output. + +=item on_line_update $term, $row + +Called whenever a line was updated or changed. Can be used to filter +screen output (e.g. underline urls or other useless stuff). Only lines +that are being shown will be filtered, and, due to performance reasons, +not always immediately. + +The row number is always the topmost row of the line if the line spans +multiple rows. + +Please note that, if you change the line, then the hook might get called +later with the already-modified line (e.g. if unrelated parts change), so +you cannot just toggle rendition bits, but only set them. + =item on_refresh_begin $term Called just before the screen gets redrawn. Can be used for overlay @@ -127,12 +252,73 @@ Called just after the screen gets redrawn. See C. +=item on_keyboard_command $term, $string + +Called whenever the user presses a key combination that has a +C action bound to it (see description of the B +resource in the @@RXVT_NAME@@(1) manpage). + +=item on_focus_in $term + +Called whenever the window gets the keyboard focus, before rxvt-unicode +does focus in processing. + +=item on_focus_out $term + +Called wheneever the window loses keyboard focus, before rxvt-unicode does +focus out processing. + +=item on_key_press $term, $event, $octets + +=item on_key_release $term, $event + +=item on_button_press $term, $event + +=item on_button_release $term, $event + +=item on_motion_notify $term, $event + +=item on_map_notify $term, $event + +=item on_unmap_notify $term, $event + +Called whenever the corresponding X event is received for the terminal If +the hook returns true, then the even will be ignored by rxvt-unicode. + +The event is a hash with most values as named by Xlib (see the XEvent +manpage), with the additional members C and C, which are the row +and column under the mouse cursor. + +C additionally receives the string rxvt-unicode would +output, if any, in locale-specific encoding. + +subwindow. + +=back + +=head2 Variables in the C Package + +=over 4 + +=item $urxvt::TERM + +The current terminal. This variable stores the current C +object, whenever a callback/hook is executing. + =back =head2 Functions in the C Package =over 4 +=item $term = new urxvt [arg...] + +Creates a new terminal, very similar as if you had started it with +C. Croaks (and probably outputs an error message) +if the new instance couldn't be created. Returns C if the new +instance didn't initialise perl, and the terminal object otherwise. The +C and C hooks will be called during the call. + =item urxvt::fatal $errormessage Fatally aborts execution with the given error message. Avoid at all @@ -152,14 +338,81 @@ Returns the "current time" (as per the event loop). +=item urxvt::CurrentTime + +=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, +Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, +Button4Mask, Button5Mask, AnyModifier + +Various constants for use in X calls and event processing. + +=back + +=head2 RENDITION + +Rendition bitsets contain information about colour, font, font styles and +similar information for each screen cell. + +The following "macros" deal with changes in rendition sets. You should +never just create a bitset, you should always modify an existing one, +as they contain important information required for correct operation of +rxvt-unicode. + +=over 4 + +=item $rend = urxvt::DEFAULT_RSTYLE + +Returns the default rendition, as used when the terminal is starting up or +being reset. Useful as a base to start when creating renditions. + +=item $rend = urxvt::OVERLAY_RSTYLE + +Return the rendition mask used for overlays by default. + +=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline + +Return the bit that enabled bold, italic, blink, reverse-video and +underline, respectively. To enable such a style, just logically OR it into +the bitset. + +=item $foreground = urxvt::GET_BASEFG $rend + +=item $background = urxvt::GET_BASEBG $rend + +Return the foreground/background colour index, respectively. + +=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) + +=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) + +Replace the foreground/background colour in the rendition mask with the +specified one. + +=item $value = urxvt::GET_CUSTOM ($rend) + +Return the "custom" value: Every rendition has 5 bits for use by +extensions. They can be set and changed as you like and are initially +zero. + +=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) + +Change the custom value. + +=back + =cut package urxvt; +use utf8; use strict; +use Scalar::Util (); +use List::Util (); -our $term; +our $VERSION = 1; +our $TERM; our @HOOKNAME; +our %OPTION; our $LIBDIR; BEGIN { @@ -174,30 +427,12 @@ }; } -my $verbosity = $ENV{URXVT_PERL_VERBOSITY} || 10; +my @hook_count; +my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; sub verbose { my ($level, $msg) = @_; - warn "$msg\n"; #d# -} - -my @invoke_cb; - -# called by the rxvt core -sub invoke { - local $term = shift; - my $htype = shift; - - my $cb = $invoke_cb[$htype]; - - verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" - if $verbosity >= 10; - - while (my ($k, $v) = each %$cb) { - return 1 if $v->($term, @_); - } - - 0 + warn "$msg\n" if $level <= $verbosity; } # find on_xxx subs in the package and register them @@ -205,70 +440,253 @@ sub register_package($) { my ($pkg) = @_; - for my $hook (0.. $#HOOKNAME) { - my $name = $HOOKNAME[$hook]; + for my $htype (0.. $#HOOKNAME) { + my $name = $HOOKNAME[$htype]; my $ref = $pkg->can ("on_" . lc $name) or next; - $invoke_cb[$hook]{$ref*1} = $ref; - set_should_invoke $hook, 1; + $TERM->{_hook}[$htype]{$pkg} = $ref; + $hook_count[$htype]++ + or set_should_invoke $htype, 1; } } -my $script_pkg = "script0000"; -my %script_pkg; +my $extension_pkg = "extension0000"; +my %extension_pkg; # load a single script into its own package, once only -sub load_script($) { +sub extension_package($) { my ($path) = @_; - $script_pkg{$path} ||= do { - my $pkg = $script_pkg++; - verbose 3, "loading script '$path' into package '$pkg'"; + $extension_pkg{$path} ||= do { + my $pkg = "urxvt::" . ($extension_pkg++); + + verbose 3, "loading extension '$path' into package '$pkg'"; open my $fh, "<:raw", $path or die "$path: $!"; - eval "package $pkg; use strict; use utf8;\n" - . "#line 1 \"$path\"\n" - . do { local $/; <$fh> } - or die "$path: $@"; + my $source = "package $pkg; use strict; use utf8;\n" + . "use base urxvt::term::proxy::;\n" + . "#line 1 \"$path\"\n{\n" + . (do { local $/; <$fh> }) + . "\n};\n1"; - register_package $pkg; + $source =~ /(.*)/s and $source = $1; # untaint + + eval $source or die "$path: $@"; $pkg - }; + } } -sub load_scripts($) { - my ($dir) = @_; +our $retval; # return value for urxvt + +# called by the rxvt core +sub invoke { + local $TERM = shift; + my $htype = shift; + + if ($htype == 0) { # INIT + my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); + + my %want_ext; + + for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { + if ($_ eq "default") { + $want_ext{$_}++ for qw(selection option-popup); + } elsif (/^-(.*)$/) { + delete $want_ext{$1}; + } else { + $want_ext{$_}++; + } + } + + for my $ext (keys %want_ext) { + my @files = grep -f $_, map "$_/$ext", @dirs; + + if (@files) { + register_package extension_package $files[0]; + } else { + warn "perl extension '$ext' not found in perl library search path\n"; + } + } + + eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); + warn $@ if $@; + } + + $retval = undef; + + if (my $cb = $TERM->{_hook}[$htype]) { + verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" + if $verbosity >= 10; + + keys %$cb; + + while (my ($pkg, $cb) = each %$cb) { + eval { + $retval = $cb->( + $TERM->{_pkg}{$pkg} ||= do { + my $proxy = bless { }, $pkg; + Scalar::Util::weaken ($proxy->{term} = $TERM); + $proxy + }, + @_, + ) and last; + }; + if ($@) { + $TERM->ungrab; # better to lose the grab than the session + warn $@; + } + } + } + + if ($htype == 1) { # DESTROY + # remove hooks if unused + if (my $hook = $TERM->{_hook}) { + for my $htype (0..$#$hook) { + $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } + or set_should_invoke $htype, 0; + } + } - verbose 3, "loading scripts from '$dir'"; + # clear package objects + %$_ = () for values %{ $TERM->{_pkg} }; - load_script $_ - for grep -f $_, - <$dir/perl-ext/*>; + # clear package + %$TERM = (); + } + + $retval } -sub on_init { - my ($term) = @_; +# urxvt::term::proxy + +sub urxvt::term::proxy::AUTOLOAD { + $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ + or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; + + eval qq{ + sub $urxvt::term::proxy::AUTOLOAD { + my \$proxy = shift; + \$proxy->{term}->$1 (\@_) + } + 1 + } or die "FATAL: unable to compile method forwarder: $@"; - my $libdir = $term->resource ("perl_lib"); + goto &$urxvt::term::proxy::AUTOLOAD; +} - load_scripts $libdir - if defined $libdir; +sub urxvt::term::proxy::DESTROY { + # nop } -register_package __PACKAGE__; -load_scripts $LIBDIR; +# urxvt::destroy_hook -=back +sub urxvt::destroy_hook::DESTROY { + ${$_[0]}->(); +} + +sub urxvt::destroy_hook(&) { + bless \shift, urxvt::destroy_hook:: +} + +package urxvt::anyevent; + +=head2 The C Class + +The sole purpose of this class is to deliver an interface to the +C module - any module using it will work inside urxvt without +further work. The only exception is that you cannot wait on condition +variables, but non-blocking condvar use is ok. What this means is that you +cannot use blocking APIs, but the non-blocking variant should work. + +=cut + +our $VERSION = 1; + +$INC{"urxvt/anyevent.pm"} = 1; # mark us as there +push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; + +sub timer { + my ($class, %arg) = @_; + + my $cb = $arg{cb}; + + urxvt::timer + ->new + ->start (urxvt::NOW + $arg{after}) + ->cb (sub { + $_[0]->stop; # need to cancel manually + $cb->(); + }) +} + +sub io { + my ($class, %arg) = @_; + + my $cb = $arg{cb}; + + bless [$arg{fh}, urxvt::iow + ->new + ->fd (fileno $arg{fh}) + ->events (($arg{poll} =~ /r/ ? 1 : 0) + | ($arg{poll} =~ /w/ ? 2 : 0)) + ->start + ->cb (sub { + $cb->(($_[1] & 1 ? 'r' : '') + . ($_[1] & 2 ? 'w' : '')); + })], + urxvt::anyevent:: +} + +sub DESTROY { + $_[0][1]->stop; +} + +sub condvar { + bless \my $flag, urxvt::anyevent::condvar:: +} + +sub urxvt::anyevent::condvar::broadcast { + ${$_[0]}++; +} + +sub urxvt::anyevent::condvar::wait { + unless (${$_[0]}) { + require Carp; + Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"); + } +} + +package urxvt::term; =head2 The C Class =over 4 +=item $term->destroy + +Destroy the terminal object (close the window, free resources etc.). + +=item $isset = $term->option ($optval[, $set]) + +Returns true if the option specified by C<$optval> is enabled, and +optionally change it. All option values are stored by name in the hash +C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. + +Here is a a likely non-exhaustive list of option names, please see the +source file F to see the actual list: + + borderLess console cursorBlink cursorUnderline hold iconic insecure + intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage + pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating + scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer + secondaryScreen secondaryScroll skipBuiltinGlyphs transparent + tripleclickwords utmpInhibit visualBell + =item $value = $term->resource ($name[, $newval]) Returns the current resource value associated with a given name and @@ -287,15 +705,15 @@ terminal is destroyed, so changing options frequently will eat memory. Here is a a likely non-exhaustive list of resource names, not all of which -are supported in every build, please see the source to see the actual -list: +are supported in every build, please see the source file F +to see the actual list: answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont borderLess color cursorBlink cursorUnderline cutchars delete_key display_name embed ext_bwidth fade font geometry hold iconName imFont imLocale inputMethod insecure int_bwidth intensityStyles - italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 - modifier mouseWheelScrollPage name pastableTabs path perl perl_eval + italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier + mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput @@ -305,12 +723,22 @@ =cut -sub urxvt::term::resource($$;$) { +sub resource($$;$) { my ($self, $name) = (shift, shift); unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); - goto &urxvt::term::_resource; + &urxvt::term::_resource } +=item $rend = $term->rstyle ([$new_rstyle]) + +Return and optionally change the current rendition. Text that is output by +the terminal application will use this style. + +=item ($row, $col) = $term->screen_cur ([$row, $col]) + +Return the current coordinates of the text cursor position and optionally +set it (which is usually bad as applications don't expect that). + =item ($row, $col) = $term->selection_mark ([$row, $col]) =item ($row, $col) = $term->selection_beg ([$row, $col]) @@ -329,89 +757,460 @@ Return the current selection text and optionally replace it by C<$newtext>. -=item $term->scr_overlay ($x, $y, $text) +#=item $term->overlay ($x, $y, $text) +# +#Create a simple multi-line overlay box. See the next method for details. +# +#=cut +# +#sub urxvt::term::scr_overlay { +# my ($self, $x, $y, $text) = @_; +# +# my @lines = split /\n/, $text; +# +# my $w = 0; +# for (map $self->strwidth ($_), @lines) { +# $w = $_ if $w < $_; +# } +# +# $self->scr_overlay_new ($x, $y, $w, scalar @lines); +# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; +#} -Create a simple multi-line overlay box. See the next method for details. +=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) -=cut +Create a new (empty) overlay at the given position with the given +width/height. C<$rstyle> defines the initial rendition style +(default: C). -sub urxvt::term::scr_overlay { - my ($self, $x, $y, $text) = @_; +If C<$border> is C<2> (default), then a decorative border will be put +around the box. - my @lines = split /\n/, $text; +If either C<$x> or C<$y> is negative, then this is counted from the +right/bottom side, respectively. - my $w = 0; - for (map $self->strwidth ($_), @lines) { - $w = $_ if $w < $_; - } +This method returns an urxvt::overlay object. The overlay will be visible +as long as the perl object is referenced. - $self->scr_overlay_new ($x, $y, $w, scalar @lines); - $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; -} +The methods currently supported on C objects are: + +=over 4 -=item $term->scr_overlay_new ($x, $y, $width, $height) +=item $overlay->set ($x, $y, $text, $rend) -Create a new (empty) overlay at the given position with the given -width/height. A border will be put around the box. If either C<$x> or -C<$y> is negative, then this is counted from the right/bottom side, -respectively. +Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts +text in rxvt-unicode's special encoding and an array of rendition values +at a specific position inside the overlay. + +=item $overlay->hide + +If visible, hide the overlay, but do not destroy it. + +=item $overlay->show + +If hidden, display the overlay again. + +=back + +=item $popup = $term->popup ($event) + +Creates a new C object that implements a popup menu. The +C<$event> I be the event causing the menu to pop up (a button event, +currently). -=item $term->scr_overlay_off +=cut + +sub popup { + my ($self, $event) = @_; -Switch the overlay off again. + $self->grab ($event->{time}, 1) + or return; -=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) + my $popup = bless { + term => $self, + event => $event, + }, urxvt::popup::; -Put a single character (specified numerically) at the given overlay -position. + Scalar::Util::weaken $popup->{term}; -=item $term->scr_overlay_set ($x, $y, $text) + $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy }; + Scalar::Util::weaken $self->{_destroy}{$popup}; -Write a string at the given position into the overlay. + $popup +} -=item $cellwidth = $term->strwidth $string +=item $cellwidth = $term->strwidth ($string) Returns the number of screen-cells this string would need. Correctly accounts for wide and combining characters. -=item $octets = $term->locale_encode $string +=item $octets = $term->locale_encode ($string) Convert the given text string into the corresponding locale encoding. -=item $string = $term->locale_decode $octets +=item $string = $term->locale_decode ($octets) Convert the given locale-encoded octets into a perl string. +=item $term->scr_add_lines ($string) + +Write the given text string to the screen, as if output by the application +running inside the terminal. It may not contain command sequences (escape +codes), but is free to use line feeds, carriage returns and tabs. The +string is a normal text string, not in locale-dependent encoding. + +Normally its not a good idea to use this function, as programs might be +confused by changes in cursor position or scrolling. Its useful inside a +C hook, though. + +=item $term->cmd_parse ($octets) + +Similar to C, but the argument must be in the +locale-specific encoding of the terminal and can contain command sequences +(escape codes) that will be interpreted. + =item $term->tt_write ($octets) Write the octets given in C<$data> to the tty (i.e. as program input). To -pass characters instead of octets, you should convetr you strings first to -the locale-specific encoding using C<< $term->locale_encode >>. +pass characters instead of octets, you should convert your strings first +to the locale-specific encoding using C<< $term->locale_encode >>. + +=item $windowid = $term->parent + +Return the window id of the toplevel window. + +=item $windowid = $term->vt + +Return the window id of the terminal window. + +=item $window_width = $term->width + +=item $window_height = $term->height + +=item $font_width = $term->fwidth + +=item $font_height = $term->fheight + +=item $font_ascent = $term->fbase + +=item $terminal_rows = $term->nrow + +=item $terminal_columns = $term->ncol + +=item $has_focus = $term->focus + +=item $is_mapped = $term->mapped + +=item $max_scrollback = $term->saveLines + +=item $nrow_plus_saveLines = $term->total_rows + +=item $lines_in_scrollback = $term->nsaved + +Return various integers describing terminal characteristics. + +=item $modifiermask = $term->ModLevel3Mask + +=item $modifiermask = $term->ModMetaMask + +=item $modifiermask = $term->ModNumLockMask + +Return the modifier masks corresponding to the "ISO Level 3 Shift" (often +AltGr), the meta key (often Alt) and the num lock key, if applicable. + +=item $view_start = $term->view_start ([$newvalue]) + +Returns the negative row number of the topmost line. Minimum value is +C<0>, which displays the normal terminal contents. Larger values scroll +this many lines into the scrollback buffer. + +=item $term->want_refresh + +Requests a screen refresh. At the next opportunity, rxvt-unicode will +compare the on-screen display with its stored representation. If they +differ, it redraws the differences. + +Used after changing terminal contents to display them. + +=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) + +Returns the text of the entire row with number C<$row_number>. Row C<0> +is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost +terminal line. The scrollback buffer starts at line C<-1> and extends to +line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line +is requested. + +If C<$new_text> is specified, it will replace characters in the current +line, starting at column C<$start_col> (default C<0>), which is useful +to replace only parts of a line. The font index in the rendition will +automatically be updated. + +C<$text> is in a special encoding: tabs and wide characters that use more +than one cell when displayed are padded with urxvt::NOCHAR characters +(C). Characters with combining characters and other characters +that do not fit into the normal tetx encoding will be replaced with +characters in the private use area. + +You have to obey this encoding when changing text. The advantage is +that C and similar functions work on screen cells and not on +characters. + +The methods C<< $term->special_encode >> and C<< $term->special_decode >> +can be used to convert normal strings into this encoding and vice versa. + +=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]]) + +Like C<< $term->ROW_t >>, but returns an arrayref with rendition +bitsets. Rendition bitsets contain information about colour, font, font +styles and similar information. See also C<< $term->ROW_t >>. + +When setting rendition, the font mask will be ignored. + +See the section on RENDITION, above. + +=item $length = $term->ROW_l ($row_number[, $new_length]) + +Returns the number of screen cells that are in use ("the line +length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the +line is joined with the following one. + +=item $bool = $term->is_longer ($row_number) + +Returns true if the row is part of a multiple-row logical "line" (i.e. +joined with the following row), which means all characters are in use +and it is continued on the next row (and possibly a continuation of the +previous row(s)). + +=item $line = $term->line ($row_number) + +Create and return a new C object that stores information +about the logical line that row C<$row_number> is part of. It supports the +following methods: + +=over 4 + +=item $text = $line->t ([$new_text]) + +Returns or replaces the full text of the line, similar to C + +=item $rend = $line->r ([$new_rend]) + +Returns or replaces the full rendition array of the line, similar to C + +=item $length = $line->l + +Returns the length of the line in cells, similar to C. + +=item $rownum = $line->beg + +=item $rownum = $line->end + +Return the row number of the first/last row of the line, respectively. + +=item $offset = $line->offset_of ($row, $col) + +Returns the character offset of the given row|col pair within the logical +line. + +=item ($row, $col) = $line->coord_of ($offset) + +Translates a string offset into terminal coordinates again. =back +=cut + +sub line { + my ($self, $row) = @_; + + my $maxrow = $self->nrow - 1; + + my ($beg, $end) = ($row, $row); + + --$beg while $self->ROW_is_longer ($beg - 1); + ++$end while $self->ROW_is_longer ($end) && $end < $maxrow; + + bless { + term => $self, + beg => $beg, + end => $end, + ncol => $self->ncol, + len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), + }, urxvt::line:: +} + +sub urxvt::line::t { + my ($self) = @_; + + if (@_ > 1) + { + $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) + for $self->{beg} .. $self->{end}; + } + + defined wantarray && + substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), + 0, $self->{len} +} + +sub urxvt::line::r { + my ($self) = @_; + + if (@_ > 1) + { + $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) + for $self->{beg} .. $self->{end}; + } + + if (defined wantarray) { + my $rend = [ + map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} + ]; + $#$rend = $self->{len} - 1; + return $rend; + } + + () +} + +sub urxvt::line::beg { $_[0]{beg} } +sub urxvt::line::end { $_[0]{end} } +sub urxvt::line::l { $_[0]{len} } + +sub urxvt::line::offset_of { + my ($self, $row, $col) = @_; + + ($row - $self->{beg}) * $self->{ncol} + $col +} + +sub urxvt::line::coord_of { + my ($self, $offset) = @_; + + use integer; + + ( + $offset / $self->{ncol} + $self->{beg}, + $offset % $self->{ncol} + ) +} + +=item ($row, $col) = $line->coord_of ($offset) +=item $text = $term->special_encode $string + +Converts a perl string into the special encoding used by rxvt-unicode, +where one character corresponds to one screen cell. See +C<< $term->ROW_t >> for details. + +=item $string = $term->special_decode $text + +Converts rxvt-unicodes text reprsentation into a perl string. See +C<< $term->ROW_t >> for details. + +=back + +=cut + +package urxvt::popup; + +=head2 The C Class + +=over 4 + +=cut + +sub add_item { + my ($self, $item) = @_; + + $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal}; + $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover}; + $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active}; + + $item->{render} ||= sub { $_[0]{text} }; + + push @{ $self->{item} }, $item; +} + +sub add_separator { + my ($self, $sep) = @_; + + $sep ||= "═"; + + $self->add_item ({ + rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, + text => "", + render => sub { $sep x $urxvt::TERM->ncol }, + activate => sub { }, + }); +} + +sub add_title { + my ($self, $title) = @_; + + $self->add_item ({ + rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, + text => $title, + activate => sub { }, + }); +} + +sub add_button { + my ($self, $text, $cb) = @_; + + $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); +} + +sub add_toggle { + my ($self, $text, $cb, $value) = @_; + + my $item; $item = { + type => "button", + text => " $text", + value => $value, + render => sub { ($_[0]{value} ? "* " : " ") . $text }, + activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, + }; + + $self->add_item ($item); +} + +sub show { + my ($self) = @_; + + local $urxvt::popup::self = $self; + + urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, + "--transient-for" => $self->{term}->parent, + "-pe" => "urxvt-popup") + or die "unable to create popup window\n"; +} + +sub DESTROY { + my ($self) = @_; + + delete $self->{term}{_destroy}{$self}; + $self->{term}->ungrab; +} + =head2 The C Class This class implements timer watchers/events. Time is represented as a fractional number of seconds since the epoch. Example: - # create a digital clock display in upper right corner + $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); $term->{timer} = urxvt::timer ->new - ->start (urxvt::NOW) + ->interval (1) ->cb (sub { - my ($timer) = @_; - my $time = $timer->at; - $timer->start ($time + 1); - $self->scr_overlay (-1, 0, - POSIX::strftime "%H:%M:%S", localtime $time); - }); + $term->{overlay}->set (0, 0, + sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); + }); =over 4 =item $timer = new urxvt::timer -Create a new timer object in stopped state. +Create a new timer object in started state. It is scheduled to fire +immediately. =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) @@ -425,6 +1224,12 @@ Set the time the event is generated to $tstamp. +=item $timer = $timer->interval ($interval) + +Normally (and when C<$interval> is C<0>), the timer will automatically +stop after it has fired once. If C<$interval> is non-zero, then the timer +is automatically rescheduled at the given intervals. + =item $timer = $timer->start Start the timer. @@ -496,11 +1301,11 @@ =over 4 -=item 0 - only fatal messages +=item == 0 - fatal messages -=item 3 - script loading and management +=item >= 3 - script loading and management -=item 10 - all events received +=item >=10 - all events received =back