--- rxvt-unicode/src/urxvt.pm 2006/01/04 00:12:12 1.29 +++ rxvt-unicode/src/urxvt.pm 2006/02/06 06:14:08 1.133 @@ -19,8 +19,8 @@ =head1 DESCRIPTION -Everytime a terminal object gets created, scripts specified via the -C resource are loaded and associated with it. +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. @@ -28,25 +28,58 @@ 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 Prepackaged Extensions +=head1 PREPACKAGED EXTENSIONS -This section describes the extensiosn delivered with this version. You can +This section describes the extensions delivered with this release. You can find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. You can activate them like this: @@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 +=item selection (enabled by default) + +(More) intelligent selection. This extension tries to be more intelligent +when the user extends selections (double-click and further clicks). Right +now, it tries to select words, urls and complete shell-quoted +arguments, which is very convenient, too, if your F supports +C<--quoting-style=shell>. + +A double-click usually selects the word under the cursor, further clicks +will enlarge the selection. + +The selection works by trying to match a number of regexes and displaying +them in increasing order of length. You can add your own regexes by +specifying resources of the form: + + URxvt.selection.pattern-0: perl-regex + URxvt.selection.pattern-1: perl-regex + ... + +The index number (0, 1...) must not have any holes, and each regex must +contain at least one pair of capturing parentheses, which will be used for +the match. For example, the followign adds a regex that matches everything +between two vertical bars: + + URxvt.selection.pattern-0: \\|([^|]+)\\| + +Another example: Programs I use often output "absolute path: " at the +beginning of a line when they process multiple files. The following +pattern matches the filename (note, there is a single space at the very +end): -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>. + URxvt.selection.pattern-0: ^(/[^:]+):\ -It also offers the following bindable event: +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 following bindable keyboard commands: =over 4 @@ -58,10 +91,237 @@ =back +=item option-popup (enabled by default) + +Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at +runtime. + +Other extensions can extend this popup menu by pushing a code reference +onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the +popup is being displayed. + +It's sole argument is the popup menu, which can be modified. It should +either return nothing or a string, the initial boolean value and a code +reference. The string will be used as button text and the code reference +will be called when the toggle changes, with the new boolean value as +first argument. + +The following will add an entry C that changes +C<$self->{myoption}>: + + push @{ $self->{term}{option_popup_hook} }, sub { + ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) + }; + +=item selection-popup (enabled by default) + +Binds a popup menu to Ctrl-Button3 that lets you convert the selection +text into various other formats/action (such as uri unescaping, perl +evaluation, 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} }>, which gets called whenever the +popup is being 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 +by a hotkey (default: C). While in search mode, normal terminal +input/output is suspended and a regex is displayed at the bottom of the +screen. + +Inputting characters appends them to the regex and continues incremental +search. C removes a character from the regex, C and C +search upwards/downwards in the scrollback buffer, C jumps to the +bottom. C leaves search mode and returns to the point where search +was started, while C or C stay at the current position and +additionally stores the first match in the current line into the primary +selection. + +=item readline (enabled by default) + +A support package that tries to make editing with readline easier. At the +moment, it reacts to clicking with the left mouse button by trying to +move the text cursor to this position. It does so by generating as many +cursor-left or cursor-right keypresses as required (the this only works +for programs that correctly support wide characters). + +To avoid too many false positives, this is only done when: + +=over 4 + +=item - the tty is in ICANON state. + +=item - the text cursor is visible. + +=item - the primary screen is currently being displayed. + +=item - the mouse is on the same (multi-row-) line as the text cursor. + +=back + +The normal selection mechanism isn't disabled, so quick successive clicks +might interfere with selection creation in harmless ways. + +=item selection-autotransform + +This selection allows you to do automatic transforms on a selection +whenever a selection is made. + +It works by specifying perl snippets (most useful is a single C +operator) that modify C<$_> as resources: + + URxvt.selection-autotransform.0: transform + URxvt.selection-autotransform.1: transform + ... + +For example, the following will transform selections of the form +C, often seen in compiler messages, into C: + + 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/^([^:[: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+)[,.]$/: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 B and +B will switch to the tab left or right of the current one, +while B creates a new tab. + +The tabbar itself can be configured similarly to a normal terminal, but +with a resource class of C. In addition, it supports the +following four resources (shown with defaults): + + URxvt.tabbed.tabbar-fg: + URxvt.tabbed.tabbar-bg: + URxvt.tabbed.tab-fg: + URxvt.tabbed.tab-bg: + +See I in the @@RXVT_NAME@@(1) manpage for valid +indices. + +=item mark-urls + +Uses per-line display filtering (C) to underline urls and +make them clickable. When middle-clicked, the program specified in the +resource C (default C) will be started with +the URL as first argument. + +=item xim-onthespot + +This (experimental) perl extension implements OnTheSpot editing. It does +not work perfectly, and some input methods don't seem to work well with +OnTheSpot editing in general, but it seems to work at leats for SCIM and +kinput2. + +You enable it by specifying this extension and a preedit style of +C, i.e.: + + @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot + +=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, +by replacing all line-drawing characters (U+2500 .. U+259F) by a +similar-looking ascii character. + =item digital-clock Displays a digital clock using the built-in overlay. +=item remote-clipboard + +Somewhat of a misnomer, this extension adds two menu entries to the +selection popup that allows one ti run external commands to store the +selection somewhere and fetch it again. + +We use it to implement a "distributed selection mechanism", which just +means that one command uploads the file to a remote server, and another +reads it. + +The commands can be set using the C and +C resources. The first should read the +selection to store from STDIN (always in UTF-8), the second should provide +the selection data on STDOUT (also in UTF-8). + +The defaults (which are likely useless to you) use rsh and cat: + + URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' + URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' + +=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/% + =item example-refresh-hooks Displays a very simple digital clock in the upper right corner of the @@ -70,6 +330,8 @@ =back +=head1 API DOCUMENTATION + =head2 General API Considerations All objects (such as terminals, time watchers etc.) are typical @@ -83,29 +345,96 @@ 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 Extension Objects + +Very perl extension is a perl class. A separate perl object is created +for each terminal and each extension and passed as the first parameter to +hooks. So extensions can use their C<$self> object without having to think +about other extensions, with the exception of methods and members that +begin with an underscore character C<_>: these are reserved for internal +use. + +Although it isn't a C object, you can call all methods of the +C class on this object. + +It has the following methods and data members: + +=over 4 + +=item $urxvt_term = $self->{term} + +Returns the C object associated with this instance of the +extension. This member I be changed in any way. + +=item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) + +Dynamically enable the given hooks (named without the C prefix) for +this extension, replacing any previous hook. This is useful when you want +to overwrite time-critical hooks only temporarily. + +=item $self->disable ($hook_name[, $hook_name..]) + +Dynamically disable the given hooks. + +=back + =head2 Hooks -The following subroutines can be declared in loaded scripts, and will be +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, -and the relevant action might not be carried out by the C++ code. +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 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. -When in doubt, return a false value (preferably C<()>). +I<< When in doubt, return a false value (preferably C<()>). >> =over 4 =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 +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, when the terminal is +still fully functional (not for long, though). =item on_reset $term @@ -113,10 +442,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 @@ -140,20 +473,12 @@ 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. +processing. This can happen multiple times, as long as the callback +returns true, it will be called on every further click by the user and is +supposed to enlarge the selection more and more, if possible. See the F example extension. -=item on_focus_in $term - -Called whenever the window gets the keyboard focus, before urxvt does -focus in processing. - -=item on_focus_out $term - -Called wheneever the window loses keyboard focus, before urxvt does focus -out processing. - =item on_view_change $term, $offset Called whenever the view offset changes, i..e the user or program @@ -170,10 +495,6 @@ $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total number of lines that will be in the scrollback buffer. -=item on_tty_activity $term *NYI* - -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 = @@ -187,6 +508,33 @@ 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_tt_write $term, $octets + +Called whenever some data is written to the tty/pty and can be used to +suppress or filter tty input. + +=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 @@ -198,22 +546,134 @@ Called just after the screen gets redrawn. See C. -=item on_keyboard_command $term, $string +=item on_user_command $term, $string -Called whenever the user presses a key combination that has a -C action bound to it (see description of the B +Called whenever the a user-configured event is being activated (e.g. via +a C action bound to a key, see description of the B resource in the @@RXVT_NAME@@(1) manpage). +The event is simply the action string. This interface is assumed to change +slightly in the future. + +=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 +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_configure_notify $term, $event + +=item on_property_notify $term, $event + +=item on_key_press $term, $event, $keysym, $octets + +=item on_key_release $term, $event, $keysym + +=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 +(real, not screen-based) row and column under the mouse cursor. + +C additionally receives the string rxvt-unicode would +output, if any, in locale-specific encoding. + +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 + +package urxvt; + +use utf8; +use strict; +use Carp (); +use Scalar::Util (); +use List::Util (); + +our $VERSION = 1; +our $TERM; +our @TERM_INIT; +our @TERM_EXT; +our @HOOKNAME; +our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; +our %OPTION; + +our $LIBDIR; +our $RESNAME; +our $RESCLASS; +our $RXVTNAME; + +our $NOCHAR = chr 0xffff; + =head2 Variables in the C Package =over 4 +=item $urxvt::LIBDIR + +The rxvt-unicode library directory, where, among other things, the perl +modules and scripts are stored. + +=item $urxvt::RESCLASS, $urxvt::RESCLASS + +The resource class and name rxvt-unicode uses to look up X resources. + +=item $urxvt::RXVTNAME + +The basename of the installed binaries, usually C. + =item $urxvt::TERM -The current terminal. Whenever a callback/Hook is bein executed, this -variable stores the current C object. +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 @@ -236,10 +696,43 @@ Using this function has the advantage that its output ends up in the correct place, e.g. on stderr of the connecting urxvtc client. +Messages have a size limit of 1023 bytes currently. + +=item @terms = urxvt::termlist + +Returns all urxvt::term objects that exist in this process, regardless of +wether they are started, being destroyed etc., so be careful. Only term +objects that have perl extensions attached will be returned (because there +is no urxvt::term objet associated with others). + =item $time = urxvt::NOW 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 + +=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 =head2 RENDITION @@ -275,20 +768,22 @@ Return the foreground/background colour index, respectively. -=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) +=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour + +=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour -=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) +=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg Replace the foreground/background colour in the rendition mask with the specified one. -=item $value = urxvt::GET_CUSTOM ($rend) +=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) +=item $rend = urxvt::SET_CUSTOM $rend, $new_value Change the custom value. @@ -296,18 +791,7 @@ =cut -package urxvt; - -use strict; -use Scalar::Util (); - -our $TERM; -our @HOOKNAME; -our $LIBDIR; - BEGIN { - urxvt->bootstrap; - # overwrite perl's warn *CORE::GLOBAL::warn = sub { my $msg = join "", @_; @@ -317,7 +801,8 @@ }; } -my @hook_count; +no warnings 'utf8'; + my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; sub verbose { @@ -325,49 +810,38 @@ warn "$msg\n" if $level <= $verbosity; } -# find on_xxx subs in the package and register them -# as hooks -sub register_package($) { - my ($pkg) = @_; - - for my $htype (0.. $#HOOKNAME) { - my $name = $HOOKNAME[$htype]; - - my $ref = $pkg->can ("on_" . lc $name) - or next; - - $TERM->{_hook}[$htype]{$pkg} = $ref; - $hook_count[$htype]++ - or set_should_invoke $htype, 1; - } -} - -my $script_pkg = "script0000"; -my %script_pkg; +my %extension_pkg; # load a single script into its own package, once only -sub script_package($) { +sub extension_package($) { my ($path) = @_; - $script_pkg{$path} ||= do { - my $pkg = "urxvt::" . ($script_pkg++); + $extension_pkg{$path} ||= do { + $path =~ /([^\/\\]+)$/; + my $pkg = $1; + $pkg =~ s/[^[:word:]]/_/g; + $pkg = "urxvt::ext::$pkg"; - verbose 3, "loading script '$path' into package '$pkg'"; + verbose 3, "loading extension '$path' into package '$pkg'"; open my $fh, "<:raw", $path or die "$path: $!"; - my $source = "package $pkg; use strict; use utf8;\n" - . "#line 1 \"$path\"\n{\n" - . (do { local $/; <$fh> }) - . "\n};\n1"; + my $source = + "package $pkg; use strict; use utf8; no warnings 'utf8';\n" + . "#line 1 \"$path\"\n{\n" + . (do { local $/; <$fh> }) + . "\n};\n1"; - eval $source or die "$path: $@"; + eval $source + or die "$path: $@"; $pkg } } +our $retval; # return value for urxvt + # called by the rxvt core sub invoke { local $TERM = shift; @@ -375,68 +849,318 @@ if ($htype == 0) { # INIT my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); + + my %ext_arg; + + { + 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 readline); + } elsif (/^-(.*)$/) { + delete $ext_arg{$1}; + } elsif (/^([^<]+)<(.*)>$/) { + push @{ $ext_arg{$1} }, $2; + } else { + $ext_arg{$_} ||= []; + } + } - for my $ext (split /:/, $TERM->resource ("perl_ext")) { + for my $ext (sort keys %ext_arg) { my @files = grep -f $_, map "$_/$ext", @dirs; if (@files) { - register_package script_package $files[0]; + $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); } 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; + 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) { + my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; + $retval ||= $retval_; + + if ($@) { + $TERM->ungrab; # better to lose the grab than the session + warn $@; } } + + verbose 11, "$HOOKNAME[$htype] returning <$retval>" + if $verbosity >= 11; } - my $cb = $TERM->{_hook}[$htype] - or return; + if ($htype == 1) { # DESTROY + # clear package objects + %$_ = () for values %{ $TERM->{_pkg} }; + + # clear package + %$TERM = (); + } + + $retval +} + +sub SET_COLOR($$$) { + SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) +} - verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" - if $verbosity >= 10; +# urxvt::term::extension - keys %$cb; +package urxvt::term::extension; - while (my ($pkg, $cb) = each %$cb) { - return 1 - if $cb->( - $TERM->{$pkg} ||= do { - my $proxy = bless { }, urxvt::term::proxy::; - Scalar::Util::weaken ($proxy->{term} = $TERM); - $proxy - }, - @_, - ); +sub enable { + my ($self, %hook) = @_; + my $pkg = $self->{_pkg}; + + while (my ($name, $cb) = each %hook) { + my $htype = $HOOKTYPE{uc $name}; + defined $htype + or Carp::croak "unsupported hook type '$name'"; + + $self->set_should_invoke ($htype, +1) + unless exists $self->{term}{_hook}[$htype]{$pkg}; + + $self->{term}{_hook}[$htype]{$pkg} = $cb; } +} - 0 +sub disable { + my ($self, @hook) = @_; + my $pkg = $self->{_pkg}; + + for my $name (@hook) { + my $htype = $HOOKTYPE{uc $name}; + defined $htype + or Carp::croak "unsupported hook type '$name'"; + + $self->set_should_invoke ($htype, -1) + if delete $self->{term}{_hook}[$htype]{$pkg}; + } } -sub urxvt::term::proxy::AUTOLOAD { - $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ - or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; +our $AUTOLOAD; + +sub AUTOLOAD { + $AUTOLOAD =~ /:([^:]+)$/ + or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable"; eval qq{ - sub $urxvt::term::proxy::AUTOLOAD { + sub $AUTOLOAD { my \$proxy = shift; \$proxy->{term}->$1 (\@_) } 1 } or die "FATAL: unable to compile method forwarder: $@"; - goto &$urxvt::term::proxy::AUTOLOAD; + goto &$AUTOLOAD; +} + +sub DESTROY { + # nop +} + +# urxvt::destroy_hook + +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 programming. 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]}) { + Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; + } +} + +package urxvt::term; + =head2 The C Class =over 4 +=cut + +# find on_xxx subs in the package and register them +# as hooks +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, + }, $pkg; + Scalar::Util::weaken ($proxy->{term} = $self); + + $self->{_pkg}{$pkg} = $proxy; + + for my $name (@HOOKNAME) { + if (my $ref = $pkg->can ("on_" . lc $name)) { + $proxy->enable ($name => $ref); + } + } +} + +=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] + +Creates a new terminal, very similar as if you had started it with system +C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like +hash which defines the environment of the new terminal. + +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 before this call returns, and are free to +refer to global data (which is race free). + +=cut + +sub new { + my ($class, $env, @args) = @_; + + $env or Carp::croak "environment hash missing in call to urxvt::term->new"; + @args or Carp::croak "name argument missing in call to urxvt::term->new"; + + _new ([ map "$_=$env->{$_}", keys %$env ], \@args); +} + +=item $term->destroy + +Destroy the terminal object (close the window, free resources +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 +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 + 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]) Returns the current resource value associated with a given name and @@ -455,30 +1179,57 @@ 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_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 + 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 -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 $value = $term->x_resource ($pattern) + +Returns the X-Resource for the given pattern, excluding the program or +class name, i.e. C<< $term->x_resource ("boldFont") >> should return the +same value as used by this instance of rxvt-unicode. Returns C if no +resource with that pattern exists. + +This method should only be called during the C hook, as there is +only one resource database per display, and later invocations might return +the wrong resources. + +=item $success = $term->parse_keysym ($keysym_spec, $command_string) + +Adds a keymap translation exactly as specified via a resource. See the +C resource in the @@RXVT_NAME@@(1) manpage. + +=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]) @@ -488,34 +1239,40 @@ Return the current values of the selection mark, begin or end positions, and optionally set them to new values. +=item $term->selection_make ($eventtime[, $rectangular]) + +Tries to make a selection as set by C and +C. If C<$rectangular> is true (default: false), a +rectangular selection will be made. This is the prefered function to make +a selection. + =item $success = $term->selection_grab ($eventtime) -Try to request the primary selection from the server (for example, as set -by the next method). +Try to request the primary selection text from the server (for example, as +set by the next method). No visual feedback will be given. This function +is mostly useful from within C hooks. =item $oldtext = $term->selection ([$newtext]) Return the current selection text and optionally replace it by C<$newtext>. -#=item $term->overlay ($x, $y, $text) -# -#Create a simple multi-line overlay box. See the next method for details. -# -#=cut +=item $term->overlay_simple ($x, $y, $text) + +Create a simple multi-line overlay box. See the next method for details. + +=cut -sub urxvt::term::scr_overlay { -die; +sub overlay_simple { my ($self, $x, $y, $text) = @_; my @lines = split /\n/, $text; - my $w = 0; - for (map $self->strwidth ($_), @lines) { - $w = $_ if $w < $_; - } + my $w = List::Util::max map $self->strwidth ($_), @lines; + + my $overlay = $self->overlay ($x, $y, $w, scalar @lines); + $overlay->set (0, $_, $lines[$_]) for 0.. $#lines; - $self->scr_overlay_new ($x, $y, $w, scalar @lines); - $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; + $overlay } =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) @@ -553,40 +1310,197 @@ =back -=item $cellwidth = $term->strwidth $string +=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). + +=cut + +sub popup { + my ($self, $event) = @_; + + $self->grab ($event->{time}, 1) + or return; + + my $popup = bless { + term => $self, + event => $event, + }, urxvt::popup::; + + Scalar::Util::weaken $popup->{term}; + + $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy }; + Scalar::Util::weaken $self->{_destroy}{$popup}; + + $popup +} + +=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_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) + +XORs the rendition values in the given span with the provided value +(default: C), which I contain font styles. Useful in +refresh hooks to provide effects similar to the selection. + +=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) + +Similar to C, but xors a rectangle instead. Trailing +whitespace will additionally be xored with the C<$rstyle2>, which defaults +to C, which removes reverse video again and underlines +it instead. Both styles I contain font styles. + +=item $term->scr_bell + +Ring the bell! + +=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->scr_change_screen ($screen) + +Switch to given screen - 0 primary, 1 secondary. + +=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 $old_events = $term->pty_ev_events ([$new_events]) + +Replaces the event mask of the pty watcher by the given event mask. Can +be used to suppress input and output handling to the pty/tty. See the +description of C<< urxvt::timer->events >>. Make sure to always restore +the previous value. + +=item $fd = $term->pty_fd + +Returns the master file descriptor for the pty in use, or C<-1> if no pty +is used. + +=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 $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 $term->focus_in + +=item $term->focus_out + +=item $term->key_press ($state, $keycode[, $time]) -=item $ncol = $term->ncol +=item $term->key_release ($state, $keycode[, $time]) -Return the number of rows/columns of the terminal window (i.e. as -specified by C<-geometry>, excluding any scrollback). +Deliver various fake events to to terminal. -=item $nsaved = $term->nsaved +=item $window_width = $term->width -Returns the number of lines in the scrollback buffer. +=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 $topmost_scrollback_row = $term->top_row + +Return various integers describing terminal characteristics. + +=item $x_display = $term->display_id + +Return the DISPLAY used by rxvt-unicode. + +=item $lc_ctype = $term->locale + +Returns the LC_CTYPE category string used by this rxvt-unicode. + +=item $env = $term->env + +Returns a copy of the environment in effect for the terminal as a hashref +similar to C<\%ENV>. + +=cut + +sub env { + if (my $env = $_[0]->_env) { + +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } + } else { + +{ %ENV } + } +} + +=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 $screen = $term->current_screen + +Returns the currently displayed screen (0 primary, 1 secondary). + +=item $cursor_is_hidden = $term->hidden_cursor + +Returns wether the cursor is currently hidden or not. =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 @@ -611,10 +1525,10 @@ 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. +than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) +characters. 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 @@ -654,13 +1568,13 @@ =over 4 -=item $text = $line->t +=item $text = $line->t ([$new_text]) -Returns the full text of the line, similar to C +Returns or replaces the full text of the line, similar to C -=item $rend = $line->r +=item $rend = $line->r ([$new_rend]) -Returns the full rendition array of the line, similar to C +Returns or replaces the full rendition array of the line, similar to C =item $length = $line->l @@ -675,7 +1589,8 @@ =item $offset = $line->offset_of ($row, $col) Returns the character offset of the given row|col pair within the logical -line. +line. Works for rows outside the line, too, and returns corresponding +offsets outside the string. =item ($row, $col) = $line->coord_of ($offset) @@ -685,7 +1600,7 @@ =cut -sub urxvt::term::line { +sub line { my ($self, $row) = @_; my $maxrow = $self->nrow - 1; @@ -699,6 +1614,7 @@ term => $self, beg => $beg, end => $end, + ncol => $self->ncol, len => ($end - $beg) * $self->ncol + $self->ROW_l ($end), }, urxvt::line:: } @@ -706,18 +1622,35 @@ sub urxvt::line::t { my ($self) = @_; - substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), - 0, $self->{len} + 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) = @_; - my $rend = [ - map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} - ]; - $#$rend = $self->{len} - 1; - $rend + 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} } @@ -727,7 +1660,7 @@ sub urxvt::line::offset_of { my ($self, $row, $col) = @_; - ($row - $self->{beg}) * $self->{term}->ncol + $col + ($row - $self->{beg}) * $self->{ncol} + $col } sub urxvt::line::coord_of { @@ -736,12 +1669,11 @@ use integer; ( - $offset / $self->{term}->ncol + $self->{beg}, - $offset % $self->{term}->ncol + $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, @@ -753,8 +1685,205 @@ Converts rxvt-unicodes text reprsentation into a perl string. See C<< $term->ROW_t >> for details. +=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) + +=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) + +Register/unregister a synchronous button grab. See the XGrabButton +manpage. + +=item $success = $term->grab ($eventtime[, $sync]) + +Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or +synchronous (C<$sync> is true). Also remembers the grab timestampe. + +=item $term->allow_events_async + +Calls XAllowEvents with AsyncBoth for the most recent grab. + +=item $term->allow_events_sync + +Calls XAllowEvents with SyncBoth for the most recent grab. + +=item $term->allow_events_replay + +Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most +recent grab. + +=item $term->ungrab + +Calls XUngrab for the most recent grab. Is called automatically on +evaluation errors, as it is better to lose the grab in the error case as +the session. + +=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) + +=item $atom_name = $term->XGetAtomName ($atom) + +=item @atoms = $term->XListProperties ($window) + +=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) + +=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) + +=item $term->XDeleteProperty ($window, $property) + +=item $window = $term->DefaultRootWindow + +=item $term->XReparentWindow ($window, $parent, [$x, $y]) + +=item $term->XMapWindow ($window) + +=item $term->XUnmapWindow ($window) + +=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) + +=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) + +=item $term->XChangeInput ($window, $add_events[, $del_events]) + +Various X or X-related functions. The C<$term> object only serves as +the source of the display, otherwise those functions map more-or-less +directory onto the X functions of the same name. + =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; +} + +=item $popup->add_title ($title) + +Adds a non-clickable title to the popup. + +=cut + +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 { }, + }); +} + +=item $popup->add_separator ([$sepchr]) + +Creates a separator, optionally using the character given as C<$sepchr>. + +=cut + +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 $self->{term}->ncol }, + activate => sub { }, + }); +} + +=item $popup->add_button ($text, $cb) + +Adds a clickable button to the popup. C<$cb> is called whenever it is +selected. + +=cut + +sub add_button { + my ($self, $text, $cb) = @_; + + $self->add_item ({ type => "button", text => $text, activate => $cb}); +} + +=item $popup->add_toggle ($text, $initial_value, $cb) + +Adds a toggle/checkbox item to the popup. The callback gets called +whenever it gets toggled, with a boolean indicating its new value as its +first argument. + +=cut + +sub add_toggle { + my ($self, $text, $value, $cb) = @_; + + my $item; $item = { + type => "button", + text => " $text", + value => $value, + render => sub { ($_[0]{value} ? "* " : " ") . $text }, + activate => sub { $cb->($_[1]{value} = !$_[1]{value}); }, + }; + + $self->add_item ($item); +} + +=item $popup->show + +Displays the popup (which is initially hidden). + +=cut + +sub show { + my ($self) = @_; + + local $urxvt::popup::self = $self; + + my $env = $self->{term}->env; + # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. + delete $env->{LC_ALL}; + $env->{LC_CTYPE} = $self->{term}->locale; + + 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") + or die "unable to create popup window\n"; +} + +sub DESTROY { + my ($self) = @_; + + delete $self->{term}{_destroy}{$self}; + $self->{term}->ungrab; +} + +=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 @@ -802,6 +1931,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. @@ -816,7 +1949,7 @@ $term->{iow} = urxvt::iow ->new ->fd (fileno $term->{socket}) - ->events (1) # wait for read data + ->events (urxvt::EVENT_READ) ->start ->cb (sub { my ($iow, $revents) = @_; @@ -843,8 +1976,9 @@ =item $iow = $iow->events ($eventmask) -Set the event mask to watch. Bit #0 (value C<1>) enables watching for read -data, Bit #1 (value C<2>) enables watching for write data. +Set the event mask to watch. The only allowed values are +C and C, which might be ORed +together, or C. =item $iow = $iow->start @@ -856,6 +1990,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 @@ -865,11 +2060,13 @@ =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 called hooks -=item =10 - all events received +=item >=11 - hook reutrn values =back