--- rxvt-unicode/src/urxvt.pm 2006/01/15 06:02:41 1.94 +++ rxvt-unicode/src/urxvt.pm 2006/01/20 15:57:21 1.115 @@ -37,6 +37,10 @@ @@RXVT_NAME@@ -pe +Or by adding them to the resource for extensions loaded by default: + + URxvt.perl-ext-common: default,automove-background,selection-autotransform + =over 4 =item selection (enabled by default) @@ -68,7 +72,7 @@ You can look at the source of the selection extension to see more interesting uses, such as parsing a line from beginning to end. -This extension also offers the following bindable keyboard command: +This extension also offers following bindable keyboard commands: =over 4 @@ -91,6 +95,25 @@ text into various other formats/action (such as uri unescaping, perl evalution, web-browser starting etc.), depending on content. +Other extensions can extend this popup menu by pushing a code reference +onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the +popup is displayed. + +It's sole argument is the popup menu, which can be modified. The selection +is in C<$_>, which can be used to decide wether to add something or not. +It should either return nothing or a string and a code reference. The +string will be used as button text and the code reference will be called +when the button gets activated and should transform C<$_>. + +The following will add an entry C that transforms all Cs in +the selection to Cs, but only if the selection currently contains any +Cs: + + push @{ $self->{term}{selection_popup_hook} }, sub { + /a/ ? ("a to be" => sub { s/a/b/g } + : () + }; + =item searchable-scrollback (enabled by default) Adds regex search functionality to the scrollback buffer, triggered @@ -127,20 +150,30 @@ And this example matches the same,but replaces it with vi-commands you can paste directly into your (vi :) editor: - URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ + URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ Of course, this can be modified to suit your needs and your editor :) To expand the example above to typical perl error messages ("XXX at FILENAME line YYY."), you need a slightly more elaborate solution: - URxvt.selection.pattern-0: ( at .*? line \\d+\\.) - URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ + URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) + URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ The first line tells the selection code to treat the unchanging part of every error message as a selection pattern, and the second line transforms the message into vi commands to load the file. +=item tabbed + +This transforms the terminal into a tabbar with additional terminals, that +is, it implements what is commonly refered to as "tabbed terminal". The topmost line +displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one +button per tab. + +Clicking a button will activate that tab. Pressing Shift-Left and +Shift-Right will switch to the tab left or right of the current one. + =item mark-urls Uses per-line display filtering (C) to underline urls and @@ -148,6 +181,14 @@ resource C (default C) will be started with the URL as first argument. +=item automove-background + +This is basically a one-line extension that dynamically changes the background pixmap offset +to the window position, in effect creating the same effect as pseudo transparency with +a custom pixmap. No scaling is supported in this mode. Exmaple: + + @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background + =item block-graphics-to-ascii A not very useful example of filtering all text output to the terminal, @@ -164,6 +205,35 @@ window. Illustrates overwriting the refresh callbacks to create your own overlays or changes. +=item selection-pastebin + +This is a little rarely useful extension that Uploads the selection as +textfile to a remote site (or does other things). (The implementation is +not currently secure for use in a multiuser environment as it writes to +F directly.). + +It listens to the C keyboard command, +i.e. + + URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin + +Pressing this combination runs a command with C<%> replaced by the name of +the textfile. This command can be set via a resource: + + URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. + +And the default is likely not useful to anybody but the few people around +here :) + +The name of the textfile is the hex encoded md5 sum of the selection, so +the same content should lead to the same filename. + +After a successful upload the selection will be replaced by the text given +in the C resource (again, the % is the placeholder +for the filename): + + URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% + =back =head1 API DOCUMENTATION @@ -245,9 +315,9 @@ The first argument passed to them is an extension oject as described in the in the C section. -B of these hooks must return a boolean value. If it is true, then the -event counts as being I, and the invocation of other hooks is -skipped, and the relevant action might not be carried out by the C++ code. +B of these hooks must return a boolean value. If any of the called +hooks returns true, then the event counts as being I, and the +relevant action might not be carried out by the C++ code. I<< When in doubt, return a false value (preferably C<()>). >> @@ -258,8 +328,20 @@ Called after a new terminal object has been initialized, but before 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. +have not yet been determined. You can safely query and change resources +and options, though. For many purposes the C hook is a better +place. + +=item on_start $term + +Called at the very end of initialisation of a new terminal, just before +trying to map (display) the toplevel and returning to the mainloop. + +=item on_destroy $term + +Called whenever something tries to destroy terminal, before doing anything +yet. If this hook returns true, then destruction is skipped, but this is +rarely a good idea. =item on_reset $term @@ -267,10 +349,14 @@ control sequences. Here is where you can react on changes to size-related variables. -=item on_start $term +=item on_child_start $term, $pid -Called at the very end of initialisation of a new terminal, just before -returning to the mainloop. +Called just after the child process has been Ced. + +=item on_child_exit $term, $status + +Called just after the child process has exited. C<$status> is the status +from C. =item on_sel_make $term, $eventtime @@ -389,6 +475,8 @@ Called wheneever the window loses keyboard focus, before rxvt-unicode does focus out processing. +=item on_configure_notify $term, $event + =item on_key_press $term, $event, $keysym, $octets =item on_key_release $term, $event, $keysym @@ -415,6 +503,15 @@ subwindow. +=item on_client_message $term, $event + +=item on_wm_protocols $term, $event + +=item on_wm_delete_window $term, $event + +Called when various types of ClientMessage events are received (all with +format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). + =back =cut @@ -429,6 +526,8 @@ our $VERSION = 1; our $TERM; +our @TERM_INIT; +our @TERM_EXT; our @HOOKNAME; our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; our %OPTION; @@ -460,6 +559,22 @@ The current terminal. This variable stores the current C object, whenever a callback/hook is executing. +=item @urxvt::TERM_INIT + +All coderefs in this array will be called as methods of the next newly +created C object (during the C phase). The array +gets cleared before the codereferences that were in it are being executed, +so coderefs can push themselves onto it again if they so desire. + +This complements to the perl-eval commandline option, but gets executed +first. + +=item @urxvt::TERM_EXT + +Works similar to C<@TERM_INIT>, but contains perl package/class names, which +get registered as normal extensions after calling the hooks in C<@TERM_INIT> +but before other extensions. Gets cleared just like C<@TERM_INIT>. + =back =head2 Functions in the C Package @@ -483,12 +598,6 @@ Messages have a size limit of 1023 bytes currently. -=item $is_safe = urxvt::safe - -Returns true when it is safe to do potentially unsafe things, such as -evaluating perl code specified by the user. This is true when urxvt was -started setuid or setgid. - =item $time = urxvt::NOW Returns the "current time" (as per the event loop). @@ -574,8 +683,6 @@ =cut BEGIN { - urxvt->bootstrap; - # overwrite perl's warn *CORE::GLOBAL::warn = sub { my $msg = join "", @_; @@ -583,12 +690,6 @@ unless $msg =~ /\n$/; urxvt::warn ($msg); }; - - # %ENV is the original startup environment - delete $ENV{IFS}; - delete $ENV{CDPATH}; - delete $ENV{BASH_ENV}; - $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; } my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; @@ -598,7 +699,6 @@ warn "$msg\n" if $level <= $verbosity; } -my $extension_pkg = "extension0000"; my %extension_pkg; # load a single script into its own package, once only @@ -606,16 +706,18 @@ my ($path) = @_; $extension_pkg{$path} ||= do { - my $pkg = "urxvt::" . ($extension_pkg++); + $path =~ /([^\/\\]+)$/; + my $pkg = $1; + $pkg =~ s/[^[:word:]]/_/g; + $pkg = "urxvt::ext::$pkg"; verbose 3, "loading extension '$path' into package '$pkg'"; open my $fh, "<:raw", $path or die "$path: $!"; - my $source = untaint + my $source = "package $pkg; use strict; use utf8;\n" - . "use base urxvt::term::extension::;\n" . "#line 1 \"$path\"\n{\n" . (do { local $/; <$fh> }) . "\n};\n1"; @@ -639,7 +741,16 @@ my %ext_arg; - for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { + { + my @init = @TERM_INIT; + @TERM_INIT = (); + $_->($TERM) for @init; + my @pkg = @TERM_EXT; + @TERM_EXT = (); + $TERM->register_package ($_) for @pkg; + } + + for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { if ($_ eq "default") { $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); } elsif (/^-(.*)$/) { @@ -674,8 +785,8 @@ keys %$cb; while (my ($pkg, $cb) = each %$cb) { - $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } - and last; + my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; + $retval ||= $retval_; if ($@) { $TERM->ungrab; # better to lose the grab than the session @@ -698,18 +809,6 @@ $retval } -sub exec_async(@) { - my $pid = fork; - - return - if !defined $pid or $pid; - - %ENV = %{ $TERM->env }; - - exec @_; - _exit 255; -} - # urxvt::term::extension package urxvt::term::extension; @@ -856,6 +955,12 @@ sub register_package { my ($self, $pkg, $argv) = @_; + no strict 'refs'; + + urxvt::verbose 6, "register package $pkg to $self"; + + @{"$pkg\::ISA"} = urxvt::term::extension::; + my $proxy = bless { _pkg => $pkg, argv => $argv, @@ -896,6 +1001,31 @@ etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event watchers (timers, io watchers) are still active. +=item $term->exec_async ($cmd[, @args]) + +Works like the combination of the C/C builtins, which executes +("starts") programs in the background. This function takes care of setting +the user environment before exec'ing the command (e.g. C) and should +be preferred over explicit calls to C or C. + +Returns the pid of the subprocess or C on error. + +=cut + +sub exec_async { + my $self = shift; + + my $pid = fork; + + return $pid + if !defined $pid or $pid; + + %ENV = %{ $self->env }; + + exec @_; + urxvt::_exit 255; +} + =item $isset = $term->option ($optval[, $set]) Returns true if the option specified by C<$optval> is enabled, and @@ -907,10 +1037,10 @@ 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 + override-redirect pastableTabs pointerBlank reverseVideo scrollBar + scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput + scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs + transparent tripleclickwords utmpInhibit visualBell =item $value = $term->resource ($name[, $newval]) @@ -937,14 +1067,15 @@ 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_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 - scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle - shade term_name title transparent transparent_all tripleclickwords - utmpInhibit visualBell + italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier + mouseWheelScrollPage name override_redirect 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 scrollWithBuffer scrollstyle + secondaryScreen secondaryScroll selectstyle shade term_name title + transient_for transparent transparent_all tripleclickwords utmpInhibit + visualBell =cut @@ -1546,8 +1677,10 @@ delete $env->{LC_ALL}; $env->{LC_CTYPE} = $self->{term}->locale; - urxvt::term->new ($env, $self->{term}->resource ("name"), - "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, + urxvt::term->new ($env, "popup", + "--perl-lib" => "", "--perl-ext-common" => "", + "-pty-fd" => -1, "-sl" => 0, + "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", "--transient-for" => $self->{term}->parent, "-display" => $self->{term}->display_id, "-pe" => "urxvt-popup") @@ -1563,6 +1696,15 @@ =back +=cut + +package urxvt::watcher; + +@urxvt::timer::ISA = __PACKAGE__; +@urxvt::iow::ISA = __PACKAGE__; +@urxvt::pw::ISA = __PACKAGE__; +@urxvt::iw::ISA = __PACKAGE__; + =head2 The C Class This class implements timer watchers/events. Time is represented as a @@ -1610,6 +1752,10 @@ Set the event trigger time to C<$tstamp> and start the timer. +=item $timer = $timer->after ($delay) + +Like C, but sets the expiry timer to c. + =item $timer = $timer->stop Stop the timer. @@ -1665,6 +1811,67 @@ =back +=head2 The C Class + +This class implements idle watchers, that get called automatically when +the process is idle. They should return as fast as possible, after doing +some useful work. + +=over 4 + +=item $iw = new urxvt::iw + +Create a new idle watcher object in stopped state. + +=item $iw = $iw->cb (sub { my ($iw) = @_; ... }) + +Set the callback to be called when the watcher triggers. + +=item $timer = $timer->start + +Start the watcher. + +=item $timer = $timer->stop + +Stop the watcher. + +=back + +=head2 The C Class + +This class implements process watchers. They create an event whenever a +process exits, after which they stop automatically. + + my $pid = fork; + ... + $term->{pw} = urxvt::pw + ->new + ->start ($pid) + ->cb (sub { + my ($pw, $exit_status) = @_; + ... + }); + +=over 4 + +=item $pw = new urxvt::pw + +Create a new process watcher in stopped state. + +=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) + +Set the callback to be called when the timer triggers. + +=item $pw = $timer->start ($pid) + +Tells the wqtcher to start watching for process C<$pid>. + +=item $pw = $pw->stop + +Stop the watcher. + +=back + =head1 ENVIRONMENT =head2 URXVT_PERL_VERBOSITY