--- rxvt-unicode/src/urxvt.pm 2006/01/03 01:39:17 1.15 +++ rxvt-unicode/src/urxvt.pm 2006/01/07 04:19:43 1.43 @@ -1,3 +1,5 @@ +=encoding utf8 + =head1 NAME @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter @@ -24,9 +26,9 @@ 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 (But not enabled) for all terminals. +scripts will be shared (but not enabled) for all terminals. -=head1 PACKAGED EXTENSIONS +=head2 Prepackaged Extensions This section describes the extensiosn delivered with this version. You can find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. @@ -39,7 +41,12 @@ =item selection -Miscellaneous selection modifications. +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 @@ -53,14 +60,24 @@ =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. -=item simple-overlay-clock - -Displays a digital clock using the built-in overlay (colorful, useless). - =back =head2 General API Considerations @@ -68,7 +85,7 @@ All objects (such as terminals, time watchers etc.) are typical reference-to-hash objects. The hash can be used to store anything you like. All members starting with an underscore (such as C<_ptr> or -C<_hook>) are reserved for internal uses and must not be accessed 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 @@ -76,10 +93,39 @@ 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. 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, @@ -92,7 +138,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 @@ -122,6 +171,15 @@ Returning a true value aborts selection grabbing. It will still be hilighted. +=item on_sel_extend $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. + +See the F example extension. + =item on_focus_in $term Called whenever the window gets the keyboard focus, before urxvt does @@ -152,6 +210,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 @@ -169,12 +262,53 @@ C action bound to it (see description of the B resource in the @@RXVT_NAME@@(1) manpage). +=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 + +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 @@ -194,13 +328,68 @@ Returns the "current time" (as per the event loop). +=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 strict; +use Scalar::Util (); -our $term; +our $TERM; our @HOOKNAME; our $LIBDIR; @@ -235,7 +424,7 @@ my $ref = $pkg->can ("on_" . lc $name) or next; - $term->{_hook}[$htype]{$ref*1} = $ref; + $TERM->{_hook}[$htype]{$pkg} = $ref; $hook_count[$htype]++ or set_should_invoke $htype, 1; } @@ -267,15 +456,17 @@ } } +our $retval; # return value for urxvt + # called by the rxvt core sub invoke { - local $term = shift; + local $TERM = shift; my $htype = shift; if ($htype == 0) { # INIT - my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl"); + my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); - for my $ext (split /:/, $term->resource ("perl_ext")) { + for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { my @files = grep -f $_, map "$_/$ext", @dirs; if (@files) { @@ -284,35 +475,70 @@ warn "perl extension '$ext' not found in perl library search path\n"; } } + } + + $retval = undef; - } elsif ($htype == 1) { # DESTROY - if (my $hook = $term->{_hook}) { + if (my $cb = $TERM->{_hook}[$htype]) { + verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" + if $verbosity >= 10; + + keys %$cb; + + while (my ($pkg, $cb) = each %$cb) { + $retval = $cb->( + $TERM->{_pkg}{$pkg} ||= do { + my $proxy = bless { }, urxvt::term::proxy::; + Scalar::Util::weaken ($proxy->{term} = $TERM); + $proxy + }, + @_, + ) and last; + } + } + + 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; } } - } - my $cb = $term->{_hook}[$htype] - or return; + # clear package objects + %$_ = () for values %{ $TERM->{_pkg} }; - verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" - if $verbosity >= 10; - - while (my ($k, $v) = each %$cb) { - return 1 if $v->($term, @_); + # clear package + %$TERM = (); } - 0 + $retval } -=back +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: $@"; + + goto &$urxvt::term::proxy::AUTOLOAD; +} =head2 The C Class =over 4 +=item $term->destroy + +Destroy the terminal object (close the window, free resources etc.). + =item $value = $term->resource ($name[, $newval]) Returns the current resource value associated with a given name and @@ -339,7 +565,7 @@ 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_eval perl_ext + 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 @@ -355,6 +581,16 @@ goto &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]) @@ -373,75 +609,130 @@ 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: -=item $term->scr_overlay_new ($x, $y, $width, $height) +=over 4 -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. +=item $overlay->set ($x, $y, $text, $rend) -=item $term->scr_overlay_off +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. -Switch the overlay off again. +=item $overlay->hide -=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) +If visible, hide the overlay, but do not destroy it. -Put a single character (specified numerically) at the given overlay -position. +=item $overlay->show -=item $term->scr_overlay_set ($x, $y, $text) +If hidden, display the overlay again. -Write a string at the given position into the overlay. +=back -=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 convert your strings first to the locale-specific encoding using C<< $term->locale_encode >>. -=item $nrow = $term->nrow +=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 $ncol = $term->ncol +=item $window_height = $term->height -Return the number of rows/columns of the terminal window (i.e. as -specified by C<-geometry>, excluding any scrollback). +=item $font_width = $term->fwidth -=item $nsaved = $term->nsaved +=item $font_height = $term->fheight -Returns the number of lines in the scrollback buffer. +=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 $view_start = $term->view_start ([$newvalue]) @@ -462,11 +753,12 @@ 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 >>. +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 iindex in the rendition will +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 @@ -490,70 +782,168 @@ When setting rendition, the font mask will be ignored. -See the section on RENDITION, below. +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"). If -it is C<-1>, then the line is part of a multiple-row logical "line", which -means all characters are in use and it is continued on the next row. +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: -=item $text = $term->special_encode $string +=over 4 -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 $text = $line->t ([$new_text]) -=item $string = $term->special_decode $text +Returns or replaces the full text of the line, similar to C -Converts rxvt-unicodes text reprsentation into a perl string. See -C<< $term->ROW_t >> for details. +=item $rend = $line->r ([$new_rend]) -=back +Returns or replaces the full rendition array of the line, similar to C -=head2 RENDITION +=item $length = $line->l -Rendition bitsets contain information about colour, font, font styles and -similar information for each screen cell. +Returns the length of the line in cells, similar to C. -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. +=item $rownum = $line->beg -=over 4 +=item $rownum = $line->end -=item $rend = urxvt::DEFAULT_RSTYLE +Return the row number of the first/last row of the line, respectively. -Returns the default rendition, as used when the terminal is starting up or -being reset. Useful as a base +=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 urxvt::term::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 + =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) = @_; ... }) @@ -567,6 +957,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. @@ -638,11 +1034,11 @@ =over 4 -=item 0 - only fatal messages +=item =0 - only 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