--- rxvt-unicode/src/urxvt.pm 2006/01/02 17:17:02 1.4 +++ rxvt-unicode/src/urxvt.pm 2006/01/03 01:15:00 1.14 @@ -1,26 +1,44 @@ =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. - -* Each script will only be loaded once, even in urxvtd, and will be valid -globally. - -* 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 +Everytime a terminal object gets created, 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 (But not enabled) for all terminals. + +=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. All members starting with an underscore (such as C<_ptr> or +C<_hook>) are reserved for internal uses and must not 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. + =head2 Hooks The following subroutines can be declared in loaded scripts, and will be called @@ -108,6 +126,12 @@ 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). + =back =head2 Functions in the C Package @@ -122,18 +146,13 @@ =item urxvt::warn $string -Calls C witht eh given string which should not include a +Calls C with the given string which should not include a newline. The module also overwrites the C builtin with a function that calls this function. Using this function has the advantage that its output ends up in the correct place, e.g. on stderr of the connecting urxvtc client. -=item $cellwidth = urxvt::wcswidth $string - -Returns the number of screen-cells this string would need. Correctly -accounts for wide and combining characters. - =item $time = urxvt::NOW Returns the "current time" (as per the event loop). @@ -160,30 +179,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 @@ -191,14 +192,15 @@ 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]{$ref*1} = $ref; + $hook_count[$htype]++ + or set_should_invoke $htype, 1; } } @@ -206,28 +208,67 @@ my %script_pkg; # load a single script into its own package, once only -sub load_script($) { +sub script_package($) { my ($path) = @_; $script_pkg{$path} ||= do { - my $pkg = $script_pkg++; + my $pkg = "urxvt::" . ($script_pkg++); + verbose 3, "loading script '$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" + . "#line 1 \"$path\"\n{\n" + . (do { local $/; <$fh> }) + . "\n};\n1"; - register_package $pkg; + eval $source or die "$path: $@"; $pkg - }; + } } -load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>; +# 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"); + + for my $ext (split /:/, $term->resource ("perl_ext")) { + my @files = grep -f $_, map "$_/$ext", @dirs; + + if (@files) { + register_package script_package $files[0]; + } else { + warn "perl extension '$ext' not found in perl library search path\n"; + } + } + + } elsif ($htype == 1) { # DESTROY + 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; + + verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" + if $verbosity >= 10; + + while (my ($k, $v) = each %$cb) { + return 1 if $v->($term, @_); + } + + 0 +} =back @@ -252,6 +293,23 @@ Please note that resource strings will currently only be freed when the 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: + + 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_eval perl_ext + perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd + reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating + scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput + scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle + shade term_name title transparent transparent_all tripleclickwords + utmpInhibit visualBell + =cut sub urxvt::term::resource($$;$) { @@ -290,7 +348,7 @@ my @lines = split /\n/, $text; my $w = 0; - for (map urxvt::wcswidth $_, @lines) { + for (map $self->strwidth ($_), @lines) { $w = $_ if $w < $_; } @@ -318,8 +376,125 @@ Write a string at the given position into the overlay. +=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 + +Convert the given text string into the corresponding locale encoding. + +=item $string = $term->locale_decode $octets + +Convert the given locale-encoded octets into a perl string. + +=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 $ncol = $term->ncol + +Return the number of rows/columns of the terminal window (i.e. as +specified by C<-geometry>, excluding any scrollback). + +=item $nsaved = $term->nsaved + +Returns the number of lines in the scrollback buffer. + +=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 >>. + +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 +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, below. + +=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. + +=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 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 + =back +=cut + =head2 The C Class This class implements timer watchers/events. Time is represented as a