*** empty log message ***
[dana/urxvt.git] / src / urxvt.pm
index 94dac8e..0a32ee5 100644 (file)
@@ -68,7 +68,7 @@ between two vertical bars:
 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
 
@@ -122,15 +122,25 @@ For example, the following will transform selections of the form
 C<filename:number>, often seen in compiler messages, into C<vi +$filename
 $word>:
 
-   URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
+   URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
 
 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/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
+   URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b: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/
+
+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 mark-urls
 
 Uses per-line display filtering (C<on_line_update>) to underline urls and
@@ -154,6 +164,35 @@ 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 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</tmp> directly.).
+
+It listens to the C<selection-pastebin:remote-pastebin> 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<selection-pastebin-url> resource (again, the % is the placeholder
+for the filename):
+
+   URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
+
 =back
 
 =head1 API DOCUMENTATION
@@ -363,6 +402,12 @@ Called whenever the user presses a key combination that has a
 C<perl:string> action bound to it (see description of the B<keysym>
 resource in the @@RXVT_NAME@@(1) manpage).
 
+=item on_x_event $term, $event
+
+Called on every X event received on the vt window (and possibly other
+windows). Should only be used as a last resort. Most event structure
+members are not passed.
+
 =item on_focus_in $term
 
 Called whenever the window gets the keyboard focus, before rxvt-unicode
@@ -467,12 +512,6 @@ correct place, e.g. on stderr of the connecting urxvtc client.
 
 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).
@@ -483,6 +522,22 @@ Returns the "current time" (as per the event loop).
 Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
 Button4Mask, Button5Mask, AnyModifier
 
+=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
+ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
+PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
+Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
+KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
+ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
+FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
+
+=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
+EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
+GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
+UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
+ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
+CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
+SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
+
 Various constants for use in X calls and event processing.
 
 =back
@@ -542,8 +597,6 @@ Change the custom value.
 =cut
 
 BEGIN {
-   urxvt->bootstrap;
-
    # overwrite perl's warn
    *CORE::GLOBAL::warn = sub {
       my $msg = join "", @_;
@@ -559,7 +612,6 @@ BEGIN {
    $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
 }
 
-my @hook_count;
 my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
 
 sub verbose {
@@ -567,24 +619,29 @@ sub verbose {
    warn "$msg\n" if $level <= $verbosity;
 }
 
-my $extension_pkg = "extension0000";
 my %extension_pkg;
 
 # load a single script into its own package, once only
 sub extension_package($) {
    my ($path) = @_;
 
+   no strict 'refs';
+
    $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
+      @{"$pkg\::ISA"} = urxvt::term::extension::;
+
+      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";
@@ -657,13 +714,6 @@ sub invoke {
    }
 
    if ($htype == 1) { # DESTROY
-      if (my $hook = delete $TERM->{_hook}) {
-         for my $htype (0..$#$hook) {
-            $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
-               or set_should_invoke $htype, 0;
-         }
-      }
-
       # clear package objects
       %$_ = () for values %{ $TERM->{_pkg} };
 
@@ -699,10 +749,8 @@ sub enable {
       defined $htype
          or Carp::croak "unsupported hook type '$name'";
 
-      unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
-         $hook_count[$htype]++
-            or urxvt::set_should_invoke $htype, 1;
-      }
+      $self->set_should_invoke ($htype, +1)
+         unless exists $self->{term}{_hook}[$htype]{$pkg};
 
       $self->{term}{_hook}[$htype]{$pkg} = $cb;
    }
@@ -717,10 +765,8 @@ sub disable {
       defined $htype
          or Carp::croak "unsupported hook type '$name'";
 
-      if (delete $self->{term}{_hook}[$htype]{$pkg}) {
-         --$hook_count[$htype]
-            or urxvt::set_should_invoke $htype, 0;
-      }
+      $self->set_should_invoke ($htype, -1)
+         if delete $self->{term}{_hook}[$htype]{$pkg};
    }
 }
 
@@ -1135,6 +1181,13 @@ Return the window id of the toplevel window.
 
 Return the window id of the terminal window.
 
+=item $term->vt_emask_add ($x_event_mask)
+
+Adds the specified events to the vt event mask. Useful e.g. when you want
+to receive pointer events all the times:
+
+   $term->vt_emask_add (urxvt::PointerMotionMask);
+
 =item $window_width = $term->width
 
 =item $window_height = $term->height
@@ -1157,7 +1210,7 @@ Return the window id of the terminal window.
 
 =item $nrow_plus_saveLines = $term->total_rows
 
-=item $lines_in_scrollback = $term->nsaved
+=item $topmost_scrollback_row = $term->top_row
 
 Return various integers describing terminal characteristics.
 
@@ -1195,8 +1248,8 @@ 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
+Returns the row number of the topmost displayed line. Maximum value is
+C<0>, which displays the normal terminal contents. Lower values scroll
 this many lines into the scrollback buffer.
 
 =item $term->want_refresh