ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.59 by root, Mon Jan 9 00:34:36 2006 UTC vs.
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC

26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31=head2 Prepackaged Extensions 31=head1 PREPACKAGED EXTENSIONS
32 32
33This section describes the extensiosn delivered with this version. You can 33This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39 39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
44Intelligent selection. This extension tries to be more intelligent when 48(More) intelligent selection. This extension tries to be more intelligent
45the user extends selections (double-click). Right now, it tries to select 49when the user extends selections (double-click and further clicks). Right
46urls and complete shell-quoted arguments, which is very convenient, too, 50now, it tries to select words, urls and complete shell-quoted
47if your F<ls> supports C<--quoting-style=shell>. 51arguments, which is very convenient, too, if your F<ls> supports
52C<--quoting-style=shell>.
48 53
49It also offers the following bindable event: 54A double-click usually selects the word under the cursor, further clicks
55will enlarge the selection.
56
57The selection works by trying to match a number of regexes and displaying
58them in increasing order of length. You can add your own regexes by
59specifying resources of the form:
60
61 URxvt.selection.pattern-0: perl-regex
62 URxvt.selection.pattern-1: perl-regex
63 ...
64
65The index number (0, 1...) must not have any holes, and each regex must
66contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything
68between two vertical bars:
69
70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72You can look at the source of the selection extension to see more
73interesting uses, such as parsing a line from beginning to end.
74
75This extension also offers following bindable keyboard commands:
50 76
51=over 4 77=over 4
52 78
53=item rot13 79=item rot13
54 80
64runtime. 90runtime.
65 91
66=item selection-popup (enabled by default) 92=item selection-popup (enabled by default)
67 93
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection 94Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action. 95text into various other formats/action (such as uri unescaping, perl
96evaluation, web-browser starting etc.), depending on content.
70 97
71=item digital-clock 98Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed.
72 101
73Displays a digital clock using the built-in overlay. 102It's sole argument is the popup menu, which can be modified. The selection
103is in C<$_>, which can be used to decide wether to add something or not.
104It should either return nothing or a string and a code reference. The
105string will be used as button text and the code reference will be called
106when the button gets activated and should transform C<$_>.
107
108The following will add an entry C<a to b> that transforms all C<a>s in
109the selection to C<b>s, but only if the selection currently contains any
110C<a>s:
111
112 push @{ $self->{term}{selection_popup_hook} }, sub {
113 /a/ ? ("a to be" => sub { s/a/b/g }
114 : ()
115 };
116
117=item searchable-scrollback<hotkey> (enabled by default)
118
119Adds regex search functionality to the scrollback buffer, triggered
120by a hotkey (default: C<M-s>). While in search mode, normal terminal
121input/output is suspended and a regex is displayed at the bottom of the
122screen.
123
124Inputting characters appends them to the regex and continues incremental
125search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126search upwards/downwards in the scrollback buffer, C<End> jumps to the
127bottom. C<Escape> leaves search mode and returns to the point where search
128was started, while C<Enter> or C<Return> stay at the current position and
129additionally stores the first match in the current line into the primary
130selection.
131
132=item selection-autotransform
133
134This selection allows you to do automatic transforms on a selection
135whenever a selection is made.
136
137It works by specifying perl snippets (most useful is a single C<s///>
138operator) that modify C<$_> as resources:
139
140 URxvt.selection-autotransform.0: transform
141 URxvt.selection-autotransform.1: transform
142 ...
143
144For example, the following will transform selections of the form
145C<filename:number>, often seen in compiler messages, into C<vi +$filename
146$word>:
147
148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149
150And this example matches the same,but replaces it with vi-commands you can
151paste directly into your (vi :) editor:
152
153 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154
155Of course, this can be modified to suit your needs and your editor :)
156
157To expand the example above to typical perl error messages ("XXX at
158FILENAME line YYY."), you need a slightly more elaborate solution:
159
160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file.
166
167=item readline
168
169A support package that tries to make editing with readline easier. At the
170moment, it reacts to clicking with the left mouse button by trying to
171move the text cursor to this position. It does so by generating as many
172cursor-left or cursor-right keypresses as required (the this only works
173for programs that correctly support wide characters).
174
175It only works when clicking into the same line (possibly extended over
176multiple rows) as the text cursor and on the primary screen, to reduce the
177risk of misinterpreting. The normal selection isn't disabled, so quick
178successive clicks might interfere with selection creation in harmless
179ways.
180
181=item tabbed
182
183This transforms the terminal into a tabbar with additional terminals, that
184is, it implements what is commonly refered to as "tabbed terminal". The topmost line
185displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
186button per tab.
187
188Clicking a button will activate that tab. Pressing B<Shift-Left> and
189B<Shift-Right> will switch to the tab left or right of the current one,
190while B<Shift-Down> creates a new tab.
74 191
75=item mark-urls 192=item mark-urls
76 193
77Uses per-line display filtering (C<on_line_update>) to underline urls. 194Uses per-line display filtering (C<on_line_update>) to underline urls and
195make them clickable. When middle-clicked, the program specified in the
196resource C<urlLauncher> (default C<x-www-browser>) will be started with
197the URL as first argument.
198
199=item automove-background
200
201This is basically a one-line extension that dynamically changes the background pixmap offset
202to the window position, in effect creating the same effect as pseudo transparency with
203a custom pixmap. No scaling is supported in this mode. Exmaple:
204
205 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
78 206
79=item block-graphics-to-ascii 207=item block-graphics-to-ascii
80 208
81A not very useful example of filtering all text output to the terminal, 209A not very useful example of filtering all text output to the terminal,
82by replacing all line-drawing characters (U+2500 .. U+259F) by a 210by replacing all line-drawing characters (U+2500 .. U+259F) by a
83similar-looking ascii character. 211similar-looking ascii character.
84 212
213=item digital-clock
214
215Displays a digital clock using the built-in overlay.
216
85=item example-refresh-hooks 217=item example-refresh-hooks
86 218
87Displays a very simple digital clock in the upper right corner of the 219Displays a very simple digital clock in the upper right corner of the
88window. Illustrates overwriting the refresh callbacks to create your own 220window. Illustrates overwriting the refresh callbacks to create your own
89overlays or changes. 221overlays or changes.
90 222
223=item selection-pastebin
224
225This is a little rarely useful extension that Uploads the selection as
226textfile to a remote site (or does other things). (The implementation is
227not currently secure for use in a multiuser environment as it writes to
228F</tmp> directly.).
229
230It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
231i.e.
232
233 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
234
235Pressing this combination runs a command with C<%> replaced by the name of
236the textfile. This command can be set via a resource:
237
238 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
239
240And the default is likely not useful to anybody but the few people around
241here :)
242
243The name of the textfile is the hex encoded md5 sum of the selection, so
244the same content should lead to the same filename.
245
246After a successful upload the selection will be replaced by the text given
247in the C<selection-pastebin-url> resource (again, the % is the placeholder
248for the filename):
249
250 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
251
91=back 252=back
253
254=head1 API DOCUMENTATION
92 255
93=head2 General API Considerations 256=head2 General API Considerations
94 257
95All objects (such as terminals, time watchers etc.) are typical 258All objects (such as terminals, time watchers etc.) are typical
96reference-to-hash objects. The hash can be used to store anything you 259reference-to-hash objects. The hash can be used to store anything you
109=over 4 272=over 4
110 273
111=item $text 274=item $text
112 275
113Rxvt-unicodes special way of encoding text, where one "unicode" character 276Rxvt-unicodes special way of encoding text, where one "unicode" character
114always represents one screen cell. See L<row_t> for a discussion of this format. 277always represents one screen cell. See L<ROW_t> for a discussion of this format.
115 278
116=item $string 279=item $string
117 280
118A perl text string, with an emphasis on I<text>. It can store all unicode 281A perl text string, with an emphasis on I<text>. It can store all unicode
119characters and is to be distinguished with text encoded in a specific 282characters and is to be distinguished with text encoded in a specific
124Either binary data or - more common - a text string encoded in a 287Either binary data or - more common - a text string encoded in a
125locale-specific way. 288locale-specific way.
126 289
127=back 290=back
128 291
292=head2 Extension Objects
293
294Very perl extension is a perl class. A separate perl object is created
295for each terminal and each extension and passed as the first parameter to
296hooks. So extensions can use their C<$self> object without having to think
297about other extensions, with the exception of methods and members that
298begin with an underscore character C<_>: these are reserved for internal
299use.
300
301Although it isn't a C<urxvt::term> object, you can call all methods of the
302C<urxvt::term> class on this object.
303
304It has the following methods and data members:
305
306=over 4
307
308=item $urxvt_term = $self->{term}
309
310Returns the C<urxvt::term> object associated with this instance of the
311extension. This member I<must not> be changed in any way.
312
313=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
314
315Dynamically enable the given hooks (named without the C<on_> prefix) for
316this extension, replacing any previous hook. This is useful when you want
317to overwrite time-critical hooks only temporarily.
318
319=item $self->disable ($hook_name[, $hook_name..])
320
321Dynamically disable the given hooks.
322
323=back
324
129=head2 Hooks 325=head2 Hooks
130 326
131The following subroutines can be declared in extension files, and will be 327The following subroutines can be declared in extension files, and will be
132called whenever the relevant event happens. 328called whenever the relevant event happens.
133 329
134The first argument passed to them is an object private to each terminal 330The first argument passed to them is an extension oject as described in
135and extension package. You can call all C<urxvt::term> methods on it, but 331the in the C<Extension Objects> section.
136its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137object that is shared between all packages is stored in the C<term>
138member. It is, however, blessed intot he package of the extension script,
139so for all practical purposes you can treat an extension script as a class.
140 332
141All of them must return a boolean value. If it is true, then the event 333B<All> of these hooks must return a boolean value. If any of the called
142counts as being I<consumed>, and the invocation of other hooks is skipped, 334hooks returns true, then the event counts as being I<consumed>, and the
143and the relevant action might not be carried out by the C++ code. 335relevant action might not be carried out by the C++ code.
144 336
145When in doubt, return a false value (preferably C<()>). 337I<< When in doubt, return a false value (preferably C<()>). >>
146 338
147=over 4 339=over 4
148 340
149=item on_init $term 341=item on_init $term
150 342
151Called after a new terminal object has been initialized, but before 343Called after a new terminal object has been initialized, but before
152windows are created or the command gets run. Most methods are unsafe to 344windows are created or the command gets run. Most methods are unsafe to
153call or deliver senseless data, as terminal size and other characteristics 345call or deliver senseless data, as terminal size and other characteristics
154have not yet been determined. You can safely query and change resources, 346have not yet been determined. You can safely query and change resources
155though. 347and options, though. For many purposes the C<on_start> hook is a better
348place.
349
350=item on_start $term
351
352Called at the very end of initialisation of a new terminal, just before
353trying to map (display) the toplevel and returning to the mainloop.
354
355=item on_destroy $term
356
357Called whenever something tries to destroy terminal, before doing anything
358yet. If this hook returns true, then destruction is skipped, but this is
359rarely a good idea.
156 360
157=item on_reset $term 361=item on_reset $term
158 362
159Called after the screen is "reset" for any reason, such as resizing or 363Called after the screen is "reset" for any reason, such as resizing or
160control sequences. Here is where you can react on changes to size-related 364control sequences. Here is where you can react on changes to size-related
161variables. 365variables.
162 366
163=item on_start $term 367=item on_child_start $term, $pid
164 368
165Called at the very end of initialisation of a new terminal, just before 369Called just after the child process has been C<fork>ed.
166returning to the mainloop. 370
371=item on_child_exit $term, $status
372
373Called just after the child process has exited. C<$status> is the status
374from C<waitpid>.
167 375
168=item on_sel_make $term, $eventtime 376=item on_sel_make $term, $eventtime
169 377
170Called whenever a selection has been made by the user, but before the 378Called whenever a selection has been made by the user, but before the
171selection text is copied, so changes to the beginning, end or type of the 379selection text is copied, so changes to the beginning, end or type of the
185=item on_sel_extend $term 393=item on_sel_extend $term
186 394
187Called whenever the user tries to extend the selection (e.g. with a double 395Called whenever the user tries to extend the selection (e.g. with a double
188click) and is either supposed to return false (normal operation), or 396click) and is either supposed to return false (normal operation), or
189should extend the selection itelf and return true to suppress the built-in 397should extend the selection itelf and return true to suppress the built-in
190processing. 398processing. This can happen multiple times, as long as the callback
399returns true, it will be called on every further click by the user and is
400supposed to enlarge the selection more and more, if possible.
191 401
192See the F<selection> example extension. 402See the F<selection> example extension.
193 403
194=item on_view_change $term, $offset 404=item on_view_change $term, $offset
195 405
204than the scroll back buffer or the terminal. 414than the scroll back buffer or the terminal.
205 415
206It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 416It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
207$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 417$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
208number of lines that will be in the scrollback buffer. 418number of lines that will be in the scrollback buffer.
209
210=item on_tty_activity $term *NYI*
211
212Called whenever the program(s) running in the urxvt window send output.
213 419
214=item on_osc_seq $term, $string 420=item on_osc_seq $term, $string
215 421
216Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 422Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217operating system command) is processed. Cursor position and other state 423operating system command) is processed. Cursor position and other state
230can filter/change and output the text yourself by returning a true value 436can filter/change and output the text yourself by returning a true value
231and calling C<< $term->scr_add_lines >> yourself. Please note that this 437and calling C<< $term->scr_add_lines >> yourself. Please note that this
232might be very slow, however, as your hook is called for B<all> text being 438might be very slow, however, as your hook is called for B<all> text being
233output. 439output.
234 440
441=item on_tt_write $term, $octets
442
443Called whenever some data is written to the tty/pty and can be used to
444suppress or filter tty input.
445
235=item on_line_update $term, $row 446=item on_line_update $term, $row
236 447
237Called whenever a line was updated or changed. Can be used to filter 448Called whenever a line was updated or changed. Can be used to filter
238screen output (e.g. underline urls or other useless stuff). Only lines 449screen output (e.g. underline urls or other useless stuff). Only lines
239that are being shown will be filtered, and, due to performance reasons, 450that are being shown will be filtered, and, due to performance reasons,
261 472
262Called whenever the user presses a key combination that has a 473Called whenever the user presses a key combination that has a
263C<perl:string> action bound to it (see description of the B<keysym> 474C<perl:string> action bound to it (see description of the B<keysym>
264resource in the @@RXVT_NAME@@(1) manpage). 475resource in the @@RXVT_NAME@@(1) manpage).
265 476
477=item on_x_event $term, $event
478
479Called on every X event received on the vt window (and possibly other
480windows). Should only be used as a last resort. Most event structure
481members are not passed.
482
266=item on_focus_in $term 483=item on_focus_in $term
267 484
268Called whenever the window gets the keyboard focus, before rxvt-unicode 485Called whenever the window gets the keyboard focus, before rxvt-unicode
269does focus in processing. 486does focus in processing.
270 487
271=item on_focus_out $term 488=item on_focus_out $term
272 489
273Called wheneever the window loses keyboard focus, before rxvt-unicode does 490Called wheneever the window loses keyboard focus, before rxvt-unicode does
274focus out processing. 491focus out processing.
275 492
493=item on_configure_notify $term, $event
494
495=item on_property_notify $term, $event
496
276=item on_key_press $term, $event, $octets 497=item on_key_press $term, $event, $keysym, $octets
277 498
278=item on_key_release $term, $event 499=item on_key_release $term, $event, $keysym
279 500
280=item on_button_press $term, $event 501=item on_button_press $term, $event
281 502
282=item on_button_release $term, $event 503=item on_button_release $term, $event
283 504
289 510
290Called whenever the corresponding X event is received for the terminal If 511Called whenever the corresponding X event is received for the terminal If
291the hook returns true, then the even will be ignored by rxvt-unicode. 512the hook returns true, then the even will be ignored by rxvt-unicode.
292 513
293The event is a hash with most values as named by Xlib (see the XEvent 514The event is a hash with most values as named by Xlib (see the XEvent
294manpage), with the additional members C<row> and C<col>, which are the row 515manpage), with the additional members C<row> and C<col>, which are the
295and column under the mouse cursor. 516(real, not screen-based) row and column under the mouse cursor.
296 517
297C<on_key_press> additionally receives the string rxvt-unicode would 518C<on_key_press> additionally receives the string rxvt-unicode would
298output, if any, in locale-specific encoding. 519output, if any, in locale-specific encoding.
299 520
300subwindow. 521subwindow.
301 522
523=item on_client_message $term, $event
524
525=item on_wm_protocols $term, $event
526
527=item on_wm_delete_window $term, $event
528
529Called when various types of ClientMessage events are received (all with
530format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
531
302=back 532=back
303 533
534=cut
535
536package urxvt;
537
538use utf8;
539use strict;
540use Carp ();
541use Scalar::Util ();
542use List::Util ();
543
544our $VERSION = 1;
545our $TERM;
546our @TERM_INIT;
547our @TERM_EXT;
548our @HOOKNAME;
549our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
550our %OPTION;
551
552our $LIBDIR;
553our $RESNAME;
554our $RESCLASS;
555our $RXVTNAME;
556
557our $NOCHAR = chr 0xfffe;
558
304=head2 Variables in the C<urxvt> Package 559=head2 Variables in the C<urxvt> Package
305 560
306=over 4 561=over 4
562
563=item $urxvt::LIBDIR
564
565The rxvt-unicode library directory, where, among other things, the perl
566modules and scripts are stored.
567
568=item $urxvt::RESCLASS, $urxvt::RESCLASS
569
570The resource class and name rxvt-unicode uses to look up X resources.
571
572=item $urxvt::RXVTNAME
573
574The basename of the installed binaries, usually C<urxvt>.
307 575
308=item $urxvt::TERM 576=item $urxvt::TERM
309 577
310The current terminal. This variable stores the current C<urxvt::term> 578The current terminal. This variable stores the current C<urxvt::term>
311object, whenever a callback/hook is executing. 579object, whenever a callback/hook is executing.
312 580
581=item @urxvt::TERM_INIT
582
583All coderefs in this array will be called as methods of the next newly
584created C<urxvt::term> object (during the C<on_init> phase). The array
585gets cleared before the codereferences that were in it are being executed,
586so coderefs can push themselves onto it again if they so desire.
587
588This complements to the perl-eval commandline option, but gets executed
589first.
590
591=item @urxvt::TERM_EXT
592
593Works similar to C<@TERM_INIT>, but contains perl package/class names, which
594get registered as normal extensions after calling the hooks in C<@TERM_INIT>
595but before other extensions. Gets cleared just like C<@TERM_INIT>.
596
313=back 597=back
314 598
315=head2 Functions in the C<urxvt> Package 599=head2 Functions in the C<urxvt> Package
316 600
317=over 4 601=over 4
318
319=item $term = new urxvt [arg...]
320
321Creates a new terminal, very similar as if you had started it with
322C<system $binfile, arg...>. Croaks (and probably outputs an error message)
323if the new instance couldn't be created. Returns C<undef> if the new
324instance didn't initialise perl, and the terminal object otherwise. The
325C<init> and C<start> hooks will be called during the call.
326 602
327=item urxvt::fatal $errormessage 603=item urxvt::fatal $errormessage
328 604
329Fatally aborts execution with the given error message. Avoid at all 605Fatally aborts execution with the given error message. Avoid at all
330costs! The only time this is acceptable is when the terminal process 606costs! The only time this is acceptable is when the terminal process
337that calls this function. 613that calls this function.
338 614
339Using this function has the advantage that its output ends up in the 615Using this function has the advantage that its output ends up in the
340correct place, e.g. on stderr of the connecting urxvtc client. 616correct place, e.g. on stderr of the connecting urxvtc client.
341 617
618Messages have a size limit of 1023 bytes currently.
619
342=item $time = urxvt::NOW 620=item $time = urxvt::NOW
343 621
344Returns the "current time" (as per the event loop). 622Returns the "current time" (as per the event loop).
345 623
346=item urxvt::CurrentTime 624=item urxvt::CurrentTime
347 625
348=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 626=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
349Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 627Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
350Button4Mask, Button5Mask, AnyModifier 628Button4Mask, Button5Mask, AnyModifier
629
630=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
631ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
632PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
633Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
634KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
635ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
636FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
637
638=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
639EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
640GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
641UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
642ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
643CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
644SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
351 645
352Various constants for use in X calls and event processing. 646Various constants for use in X calls and event processing.
353 647
354=back 648=back
355 649
384 678
385=item $background = urxvt::GET_BASEBG $rend 679=item $background = urxvt::GET_BASEBG $rend
386 680
387Return the foreground/background colour index, respectively. 681Return the foreground/background colour index, respectively.
388 682
389=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 683=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
390 684
391=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 685=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
392 686
393Replace the foreground/background colour in the rendition mask with the 687Replace the foreground/background colour in the rendition mask with the
394specified one. 688specified one.
395 689
396=item $value = urxvt::GET_CUSTOM ($rend) 690=item $value = urxvt::GET_CUSTOM $rend
397 691
398Return the "custom" value: Every rendition has 5 bits for use by 692Return the "custom" value: Every rendition has 5 bits for use by
399extensions. They can be set and changed as you like and are initially 693extensions. They can be set and changed as you like and are initially
400zero. 694zero.
401 695
402=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 696=item $rend = urxvt::SET_CUSTOM $rend, $new_value
403 697
404Change the custom value. 698Change the custom value.
405 699
406=back 700=back
407 701
408=cut 702=cut
409 703
410package urxvt;
411
412use utf8;
413use strict;
414use Scalar::Util ();
415use List::Util ();
416
417our $VERSION = 1;
418our $TERM;
419our @HOOKNAME;
420our %OPTION;
421our $LIBDIR;
422
423BEGIN { 704BEGIN {
424 urxvt->bootstrap;
425
426 # overwrite perl's warn 705 # overwrite perl's warn
427 *CORE::GLOBAL::warn = sub { 706 *CORE::GLOBAL::warn = sub {
428 my $msg = join "", @_; 707 my $msg = join "", @_;
429 $msg .= "\n" 708 $msg .= "\n"
430 unless $msg =~ /\n$/; 709 unless $msg =~ /\n$/;
431 urxvt::warn ($msg); 710 urxvt::warn ($msg);
432 }; 711 };
433
434 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
435 delete $ENV{CDPATH};
436} 712}
437 713
438my @hook_count;
439my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 714my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
440 715
441sub verbose { 716sub verbose {
442 my ($level, $msg) = @_; 717 my ($level, $msg) = @_;
443 warn "$msg\n" if $level <= $verbosity; 718 warn "$msg\n" if $level <= $verbosity;
444} 719}
445 720
446# find on_xxx subs in the package and register them
447# as hooks
448sub register_package($) {
449 my ($pkg) = @_;
450
451 for my $htype (0.. $#HOOKNAME) {
452 my $name = $HOOKNAME[$htype];
453
454 my $ref = $pkg->can ("on_" . lc $name)
455 or next;
456
457 $TERM->{_hook}[$htype]{$pkg} = $ref;
458 $hook_count[$htype]++
459 or set_should_invoke $htype, 1;
460 }
461}
462
463my $extension_pkg = "extension0000";
464my %extension_pkg; 721my %extension_pkg;
465 722
466# load a single script into its own package, once only 723# load a single script into its own package, once only
467sub extension_package($) { 724sub extension_package($) {
468 my ($path) = @_; 725 my ($path) = @_;
469 726
470 $extension_pkg{$path} ||= do { 727 $extension_pkg{$path} ||= do {
471 my $pkg = "urxvt::" . ($extension_pkg++); 728 $path =~ /([^\/\\]+)$/;
729 my $pkg = $1;
730 $pkg =~ s/[^[:word:]]/_/g;
731 $pkg = "urxvt::ext::$pkg";
472 732
473 verbose 3, "loading extension '$path' into package '$pkg'"; 733 verbose 3, "loading extension '$path' into package '$pkg'";
474 734
475 open my $fh, "<:raw", $path 735 open my $fh, "<:raw", $path
476 or die "$path: $!"; 736 or die "$path: $!";
477 737
738 my $source =
478 my $source = untaint "package $pkg; use strict; use utf8;\n" 739 "package $pkg; use strict; use utf8;\n"
479 . "use base urxvt::term::proxy::;\n"
480 . "#line 1 \"$path\"\n{\n" 740 . "#line 1 \"$path\"\n{\n"
481 . (do { local $/; <$fh> }) 741 . (do { local $/; <$fh> })
482 . "\n};\n1"; 742 . "\n};\n1";
483 743
744 eval $source
484 eval $source or die "$path: $@"; 745 or die "$path: $@";
485 746
486 $pkg 747 $pkg
487 } 748 }
488} 749}
489 750
495 my $htype = shift; 756 my $htype = shift;
496 757
497 if ($htype == 0) { # INIT 758 if ($htype == 0) { # INIT
498 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 759 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
499 760
500 my %want_ext; 761 my %ext_arg;
501 762
763 {
764 my @init = @TERM_INIT;
765 @TERM_INIT = ();
766 $_->($TERM) for @init;
767 my @pkg = @TERM_EXT;
768 @TERM_EXT = ();
769 $TERM->register_package ($_) for @pkg;
770 }
771
502 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 772 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
503 if ($_ eq "default") { 773 if ($_ eq "default") {
504 $want_ext{$_}++ for qw(selection option-popup selection-popup); 774 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
505 } elsif (/^-(.*)$/) { 775 } elsif (/^-(.*)$/) {
506 delete $want_ext{$1}; 776 delete $ext_arg{$1};
777 } elsif (/^([^<]+)<(.*)>$/) {
778 push @{ $ext_arg{$1} }, $2;
507 } else { 779 } else {
508 $want_ext{$_}++; 780 $ext_arg{$_} ||= [];
509 } 781 }
510 } 782 }
511 783
512 for my $ext (keys %want_ext) { 784 while (my ($ext, $argv) = each %ext_arg) {
513 my @files = grep -f $_, map "$_/$ext", @dirs; 785 my @files = grep -f $_, map "$_/$ext", @dirs;
514 786
515 if (@files) { 787 if (@files) {
516 register_package extension_package $files[0]; 788 $TERM->register_package (extension_package $files[0], $argv);
517 } else { 789 } else {
518 warn "perl extension '$ext' not found in perl library search path\n"; 790 warn "perl extension '$ext' not found in perl library search path\n";
519 } 791 }
520 } 792 }
521 793
530 if $verbosity >= 10; 802 if $verbosity >= 10;
531 803
532 keys %$cb; 804 keys %$cb;
533 805
534 while (my ($pkg, $cb) = each %$cb) { 806 while (my ($pkg, $cb) = each %$cb) {
535 eval { 807 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
536 $retval = $cb->( 808 $retval ||= $retval_;
537 $TERM->{_pkg}{$pkg} ||= do { 809
538 my $proxy = bless { }, $pkg;
539 Scalar::Util::weaken ($proxy->{term} = $TERM);
540 $proxy
541 },
542 @_,
543 ) and last;
544 };
545 if ($@) { 810 if ($@) {
546 $TERM->ungrab; # better to lose the grab than the session 811 $TERM->ungrab; # better to lose the grab than the session
547 warn $@; 812 warn $@;
548 } 813 }
549 } 814 }
815
816 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
817 if $verbosity >= 11;
550 } 818 }
551 819
552 if ($htype == 1) { # DESTROY 820 if ($htype == 1) { # DESTROY
553 # remove hooks if unused
554 if (my $hook = $TERM->{_hook}) {
555 for my $htype (0..$#$hook) {
556 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
557 or set_should_invoke $htype, 0;
558 }
559 }
560
561 # clear package objects 821 # clear package objects
562 %$_ = () for values %{ $TERM->{_pkg} }; 822 %$_ = () for values %{ $TERM->{_pkg} };
563 823
564 # clear package 824 # clear package
565 %$TERM = (); 825 %$TERM = ();
566 } 826 }
567 827
568 $retval 828 $retval
569} 829}
570 830
571# urxvt::term::proxy 831# urxvt::term::extension
572 832
573sub urxvt::term::proxy::AUTOLOAD { 833package urxvt::term::extension;
574 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 834
835sub enable {
836 my ($self, %hook) = @_;
837 my $pkg = $self->{_pkg};
838
839 while (my ($name, $cb) = each %hook) {
840 my $htype = $HOOKTYPE{uc $name};
841 defined $htype
842 or Carp::croak "unsupported hook type '$name'";
843
844 $self->set_should_invoke ($htype, +1)
845 unless exists $self->{term}{_hook}[$htype]{$pkg};
846
847 $self->{term}{_hook}[$htype]{$pkg} = $cb;
848 }
849}
850
851sub disable {
852 my ($self, @hook) = @_;
853 my $pkg = $self->{_pkg};
854
855 for my $name (@hook) {
856 my $htype = $HOOKTYPE{uc $name};
857 defined $htype
858 or Carp::croak "unsupported hook type '$name'";
859
860 $self->set_should_invoke ($htype, -1)
861 if delete $self->{term}{_hook}[$htype]{$pkg};
862 }
863}
864
865our $AUTOLOAD;
866
867sub AUTOLOAD {
868 $AUTOLOAD =~ /:([^:]+)$/
575 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 869 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
576 870
577 eval qq{ 871 eval qq{
578 sub $urxvt::term::proxy::AUTOLOAD { 872 sub $AUTOLOAD {
579 my \$proxy = shift; 873 my \$proxy = shift;
580 \$proxy->{term}->$1 (\@_) 874 \$proxy->{term}->$1 (\@_)
581 } 875 }
582 1 876 1
583 } or die "FATAL: unable to compile method forwarder: $@"; 877 } or die "FATAL: unable to compile method forwarder: $@";
584 878
585 goto &$urxvt::term::proxy::AUTOLOAD; 879 goto &$AUTOLOAD;
586} 880}
587 881
588sub urxvt::term::proxy::DESTROY { 882sub DESTROY {
589 # nop 883 # nop
590} 884}
591 885
592# urxvt::destroy_hook 886# urxvt::destroy_hook
593 887
603 897
604=head2 The C<urxvt::anyevent> Class 898=head2 The C<urxvt::anyevent> Class
605 899
606The sole purpose of this class is to deliver an interface to the 900The sole purpose of this class is to deliver an interface to the
607C<AnyEvent> module - any module using it will work inside urxvt without 901C<AnyEvent> module - any module using it will work inside urxvt without
608further work. The only exception is that you cannot wait on condition 902further programming. The only exception is that you cannot wait on
609variables, but non-blocking condvar use is ok. What this means is that you 903condition variables, but non-blocking condvar use is ok. What this means
610cannot use blocking APIs, but the non-blocking variant should work. 904is that you cannot use blocking APIs, but the non-blocking variant should
905work.
611 906
612=cut 907=cut
613 908
614our $VERSION = 1; 909our $VERSION = 1;
615 910
660 ${$_[0]}++; 955 ${$_[0]}++;
661} 956}
662 957
663sub urxvt::anyevent::condvar::wait { 958sub urxvt::anyevent::condvar::wait {
664 unless (${$_[0]}) { 959 unless (${$_[0]}) {
665 require Carp;
666 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"); 960 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
667 } 961 }
668} 962}
669 963
670package urxvt::term; 964package urxvt::term;
671 965
672=head2 The C<urxvt::term> Class 966=head2 The C<urxvt::term> Class
673 967
674=over 4 968=over 4
675 969
970=cut
971
972# find on_xxx subs in the package and register them
973# as hooks
974sub register_package {
975 my ($self, $pkg, $argv) = @_;
976
977 no strict 'refs';
978
979 urxvt::verbose 6, "register package $pkg to $self";
980
981 @{"$pkg\::ISA"} = urxvt::term::extension::;
982
983 my $proxy = bless {
984 _pkg => $pkg,
985 argv => $argv,
986 }, $pkg;
987 Scalar::Util::weaken ($proxy->{term} = $self);
988
989 $self->{_pkg}{$pkg} = $proxy;
990
991 for my $name (@HOOKNAME) {
992 if (my $ref = $pkg->can ("on_" . lc $name)) {
993 $proxy->enable ($name => $ref);
994 }
995 }
996}
997
998=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
999
1000Creates a new terminal, very similar as if you had started it with system
1001C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1002hash which defines the environment of the new terminal.
1003
1004Croaks (and probably outputs an error message) if the new instance
1005couldn't be created. Returns C<undef> if the new instance didn't
1006initialise perl, and the terminal object otherwise. The C<init> and
1007C<start> hooks will be called during this call.
1008
1009=cut
1010
1011sub new {
1012 my ($class, $env, @args) = @_;
1013
1014 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
1015}
1016
676=item $term->destroy 1017=item $term->destroy
677 1018
678Destroy the terminal object (close the window, free resources etc.). 1019Destroy the terminal object (close the window, free resources
1020etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
1021watchers (timers, io watchers) are still active.
1022
1023=item $term->exec_async ($cmd[, @args])
1024
1025Works like the combination of the C<fork>/C<exec> builtins, which executes
1026("starts") programs in the background. This function takes care of setting
1027the user environment before exec'ing the command (e.g. C<PATH>) and should
1028be preferred over explicit calls to C<exec> or C<system>.
1029
1030Returns the pid of the subprocess or C<undef> on error.
1031
1032=cut
1033
1034sub exec_async {
1035 my $self = shift;
1036
1037 my $pid = fork;
1038
1039 return $pid
1040 if !defined $pid or $pid;
1041
1042 %ENV = %{ $self->env };
1043
1044 exec @_;
1045 urxvt::_exit 255;
1046}
679 1047
680=item $isset = $term->option ($optval[, $set]) 1048=item $isset = $term->option ($optval[, $set])
681 1049
682Returns true if the option specified by C<$optval> is enabled, and 1050Returns true if the option specified by C<$optval> is enabled, and
683optionally change it. All option values are stored by name in the hash 1051optionally change it. All option values are stored by name in the hash
686Here is a a likely non-exhaustive list of option names, please see the 1054Here is a a likely non-exhaustive list of option names, please see the
687source file F</src/optinc.h> to see the actual list: 1055source file F</src/optinc.h> to see the actual list:
688 1056
689 borderLess console cursorBlink cursorUnderline hold iconic insecure 1057 borderLess console cursorBlink cursorUnderline hold iconic insecure
690 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1058 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
691 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1059 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
692 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1060 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
693 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1061 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
694 tripleclickwords utmpInhibit visualBell 1062 transparent tripleclickwords utmpInhibit visualBell
695 1063
696=item $value = $term->resource ($name[, $newval]) 1064=item $value = $term->resource ($name[, $newval])
697 1065
698Returns the current resource value associated with a given name and 1066Returns the current resource value associated with a given name and
699optionally sets a new value. Setting values is most useful in the C<init> 1067optionally sets a new value. Setting values is most useful in the C<init>
716 1084
717 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1085 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
718 borderLess color cursorBlink cursorUnderline cutchars delete_key 1086 borderLess color cursorBlink cursorUnderline cutchars delete_key
719 display_name embed ext_bwidth fade font geometry hold iconName 1087 display_name embed ext_bwidth fade font geometry hold iconName
720 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1088 imFont imLocale inputMethod insecure int_bwidth intensityStyles
721 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1089 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
722 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1090 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
723 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1091 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
724 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1092 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
725 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1093 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
726 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1094 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
727 shade term_name title transparent transparent_all tripleclickwords 1095 secondaryScreen secondaryScroll selectstyle shade term_name title
728 utmpInhibit visualBell 1096 transient_for transparent transparent_all tripleclickwords utmpInhibit
1097 visualBell
729 1098
730=cut 1099=cut
731 1100
732sub resource($$;$) { 1101sub resource($$;$) {
733 my ($self, $name) = (shift, shift); 1102 my ($self, $name) = (shift, shift);
734 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1103 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
735 &urxvt::term::_resource 1104 &urxvt::term::_resource
736} 1105}
737 1106
1107=item $value = $term->x_resource ($pattern)
1108
1109Returns the X-Resource for the given pattern, excluding the program or
1110class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1111same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1112resource with that pattern exists.
1113
1114This method should only be called during the C<on_start> hook, as there is
1115only one resource database per display, and later invocations might return
1116the wrong resources.
1117
1118=item $success = $term->parse_keysym ($keysym_spec, $command_string)
1119
1120Adds a keymap translation exactly as specified via a resource. See the
1121C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1122
738=item $rend = $term->rstyle ([$new_rstyle]) 1123=item $rend = $term->rstyle ([$new_rstyle])
739 1124
740Return and optionally change the current rendition. Text that is output by 1125Return and optionally change the current rendition. Text that is output by
741the terminal application will use this style. 1126the terminal application will use this style.
742 1127
752=item ($row, $col) = $term->selection_end ([$row, $col]) 1137=item ($row, $col) = $term->selection_end ([$row, $col])
753 1138
754Return the current values of the selection mark, begin or end positions, 1139Return the current values of the selection mark, begin or end positions,
755and optionally set them to new values. 1140and optionally set them to new values.
756 1141
1142=item $term->selection_make ($eventtime[, $rectangular])
1143
1144Tries to make a selection as set by C<selection_beg> and
1145C<selection_end>. If C<$rectangular> is true (default: false), a
1146rectangular selection will be made. This is the prefered function to make
1147a selection.
1148
757=item $success = $term->selection_grab ($eventtime) 1149=item $success = $term->selection_grab ($eventtime)
758 1150
759Try to request the primary selection from the server (for example, as set 1151Try to request the primary selection text from the server (for example, as
760by the next method). 1152set by the next method). No visual feedback will be given. This function
1153is mostly useful from within C<on_sel_grab> hooks.
761 1154
762=item $oldtext = $term->selection ([$newtext]) 1155=item $oldtext = $term->selection ([$newtext])
763 1156
764Return the current selection text and optionally replace it by C<$newtext>. 1157Return the current selection text and optionally replace it by C<$newtext>.
765 1158
766#=item $term->overlay ($x, $y, $text) 1159=item $term->overlay_simple ($x, $y, $text)
767# 1160
768#Create a simple multi-line overlay box. See the next method for details. 1161Create a simple multi-line overlay box. See the next method for details.
769# 1162
770#=cut 1163=cut
771# 1164
772#sub urxvt::term::scr_overlay { 1165sub overlay_simple {
773# my ($self, $x, $y, $text) = @_; 1166 my ($self, $x, $y, $text) = @_;
774# 1167
775# my @lines = split /\n/, $text; 1168 my @lines = split /\n/, $text;
776# 1169
777# my $w = 0; 1170 my $w = List::Util::max map $self->strwidth ($_), @lines;
778# for (map $self->strwidth ($_), @lines) { 1171
779# $w = $_ if $w < $_;
780# }
781#
782# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 1172 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
783# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 1173 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
784#} 1174
1175 $overlay
1176}
785 1177
786=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 1178=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
787 1179
788Create a new (empty) overlay at the given position with the given 1180Create a new (empty) overlay at the given position with the given
789width/height. C<$rstyle> defines the initial rendition style 1181width/height. C<$rstyle> defines the initial rendition style
856 1248
857=item $string = $term->locale_decode ($octets) 1249=item $string = $term->locale_decode ($octets)
858 1250
859Convert the given locale-encoded octets into a perl string. 1251Convert the given locale-encoded octets into a perl string.
860 1252
1253=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1254
1255XORs the rendition values in the given span with the provided value
1256(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1257refresh hooks to provide effects similar to the selection.
1258
1259=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1260
1261Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1262whitespace will additionally be xored with the C<$rstyle2>, which defaults
1263to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1264it instead. Both styles I<MUST NOT> contain font styles.
1265
1266=item $term->scr_bell
1267
1268Ring the bell!
1269
861=item $term->scr_add_lines ($string) 1270=item $term->scr_add_lines ($string)
862 1271
863Write the given text string to the screen, as if output by the application 1272Write the given text string to the screen, as if output by the application
864running inside the terminal. It may not contain command sequences (escape 1273running inside the terminal. It may not contain command sequences (escape
865codes), but is free to use line feeds, carriage returns and tabs. The 1274codes), but is free to use line feeds, carriage returns and tabs. The
867 1276
868Normally its not a good idea to use this function, as programs might be 1277Normally its not a good idea to use this function, as programs might be
869confused by changes in cursor position or scrolling. Its useful inside a 1278confused by changes in cursor position or scrolling. Its useful inside a
870C<on_add_lines> hook, though. 1279C<on_add_lines> hook, though.
871 1280
1281=item $term->scr_change_screen ($screen)
1282
1283Switch to given screen - 0 primary, 1 secondary.
1284
872=item $term->cmd_parse ($octets) 1285=item $term->cmd_parse ($octets)
873 1286
874Similar to C<scr_add_lines>, but the argument must be in the 1287Similar to C<scr_add_lines>, but the argument must be in the
875locale-specific encoding of the terminal and can contain command sequences 1288locale-specific encoding of the terminal and can contain command sequences
876(escape codes) that will be interpreted. 1289(escape codes) that will be interpreted.
879 1292
880Write the octets given in C<$data> to the tty (i.e. as program input). To 1293Write the octets given in C<$data> to the tty (i.e. as program input). To
881pass characters instead of octets, you should convert your strings first 1294pass characters instead of octets, you should convert your strings first
882to the locale-specific encoding using C<< $term->locale_encode >>. 1295to the locale-specific encoding using C<< $term->locale_encode >>.
883 1296
1297=item $old_events = $term->pty_ev_events ([$new_events])
1298
1299Replaces the event mask of the pty watcher by the given event mask. Can
1300be used to suppress input and output handling to the pty/tty. See the
1301description of C<< urxvt::timer->events >>. Make sure to always restore
1302the previous value.
1303
884=item $windowid = $term->parent 1304=item $windowid = $term->parent
885 1305
886Return the window id of the toplevel window. 1306Return the window id of the toplevel window.
887 1307
888=item $windowid = $term->vt 1308=item $windowid = $term->vt
889 1309
890Return the window id of the terminal window. 1310Return the window id of the terminal window.
891 1311
1312=item $term->vt_emask_add ($x_event_mask)
1313
1314Adds the specified events to the vt event mask. Useful e.g. when you want
1315to receive pointer events all the times:
1316
1317 $term->vt_emask_add (urxvt::PointerMotionMask);
1318
892=item $window_width = $term->width 1319=item $window_width = $term->width
893 1320
894=item $window_height = $term->height 1321=item $window_height = $term->height
895 1322
896=item $font_width = $term->fwidth 1323=item $font_width = $term->fwidth
909 1336
910=item $max_scrollback = $term->saveLines 1337=item $max_scrollback = $term->saveLines
911 1338
912=item $nrow_plus_saveLines = $term->total_rows 1339=item $nrow_plus_saveLines = $term->total_rows
913 1340
914=item $lines_in_scrollback = $term->nsaved 1341=item $topmost_scrollback_row = $term->top_row
915 1342
916Return various integers describing terminal characteristics. 1343Return various integers describing terminal characteristics.
1344
1345=item $x_display = $term->display_id
1346
1347Return the DISPLAY used by rxvt-unicode.
1348
1349=item $lc_ctype = $term->locale
1350
1351Returns the LC_CTYPE category string used by this rxvt-unicode.
1352
1353=item $env = $term->env
1354
1355Returns a copy of the environment in effect for the terminal as a hashref
1356similar to C<\%ENV>.
1357
1358=cut
1359
1360sub env {
1361 if (my $env = $_[0]->_env) {
1362 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1363 } else {
1364 +{ %ENV }
1365 }
1366}
917 1367
918=item $modifiermask = $term->ModLevel3Mask 1368=item $modifiermask = $term->ModLevel3Mask
919 1369
920=item $modifiermask = $term->ModMetaMask 1370=item $modifiermask = $term->ModMetaMask
921 1371
922=item $modifiermask = $term->ModNumLockMask 1372=item $modifiermask = $term->ModNumLockMask
923 1373
924Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1374Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
925AltGr), the meta key (often Alt) and the num lock key, if applicable. 1375AltGr), the meta key (often Alt) and the num lock key, if applicable.
926 1376
1377=item $screen = $term->current_screen
1378
1379Returns the currently displayed screen (0 primary, 1 secondary).
1380
927=item $view_start = $term->view_start ([$newvalue]) 1381=item $view_start = $term->view_start ([$newvalue])
928 1382
929Returns the negative row number of the topmost line. Minimum value is 1383Returns the row number of the topmost displayed line. Maximum value is
930C<0>, which displays the normal terminal contents. Larger values scroll 1384C<0>, which displays the normal terminal contents. Lower values scroll
931this many lines into the scrollback buffer. 1385this many lines into the scrollback buffer.
932 1386
933=item $term->want_refresh 1387=item $term->want_refresh
934 1388
935Requests a screen refresh. At the next opportunity, rxvt-unicode will 1389Requests a screen refresh. At the next opportunity, rxvt-unicode will
949If C<$new_text> is specified, it will replace characters in the current 1403If C<$new_text> is specified, it will replace characters in the current
950line, starting at column C<$start_col> (default C<0>), which is useful 1404line, starting at column C<$start_col> (default C<0>), which is useful
951to replace only parts of a line. The font index in the rendition will 1405to replace only parts of a line. The font index in the rendition will
952automatically be updated. 1406automatically be updated.
953 1407
954C<$text> is in a special encoding: tabs and wide characters that use more 1408C<$text> is in a special encoding: tabs and wide characters that use
955than one cell when displayed are padded with urxvt::NOCHAR characters 1409more than one cell when displayed are padded with C<$urxvt::NOCHAR>
956(C<chr 65535>). Characters with combining characters and other characters 1410characters. Characters with combining characters and other characters that
957that do not fit into the normal tetx encoding will be replaced with 1411do not fit into the normal tetx encoding will be replaced with characters
958characters in the private use area. 1412in the private use area.
959 1413
960You have to obey this encoding when changing text. The advantage is 1414You have to obey this encoding when changing text. The advantage is
961that C<substr> and similar functions work on screen cells and not on 1415that C<substr> and similar functions work on screen cells and not on
962characters. 1416characters.
963 1417
1014Return the row number of the first/last row of the line, respectively. 1468Return the row number of the first/last row of the line, respectively.
1015 1469
1016=item $offset = $line->offset_of ($row, $col) 1470=item $offset = $line->offset_of ($row, $col)
1017 1471
1018Returns the character offset of the given row|col pair within the logical 1472Returns the character offset of the given row|col pair within the logical
1019line. 1473line. Works for rows outside the line, too, and returns corresponding
1474offsets outside the string.
1020 1475
1021=item ($row, $col) = $line->coord_of ($offset) 1476=item ($row, $col) = $line->coord_of ($offset)
1022 1477
1023Translates a string offset into terminal coordinates again. 1478Translates a string offset into terminal coordinates again.
1024 1479
1098 $offset / $self->{ncol} + $self->{beg}, 1553 $offset / $self->{ncol} + $self->{beg},
1099 $offset % $self->{ncol} 1554 $offset % $self->{ncol}
1100 ) 1555 )
1101} 1556}
1102 1557
1103=item ($row, $col) = $line->coord_of ($offset)
1104=item $text = $term->special_encode $string 1558=item $text = $term->special_encode $string
1105 1559
1106Converts a perl string into the special encoding used by rxvt-unicode, 1560Converts a perl string into the special encoding used by rxvt-unicode,
1107where one character corresponds to one screen cell. See 1561where one character corresponds to one screen cell. See
1108C<< $term->ROW_t >> for details. 1562C<< $term->ROW_t >> for details.
1110=item $string = $term->special_decode $text 1564=item $string = $term->special_decode $text
1111 1565
1112Converts rxvt-unicodes text reprsentation into a perl string. See 1566Converts rxvt-unicodes text reprsentation into a perl string. See
1113C<< $term->ROW_t >> for details. 1567C<< $term->ROW_t >> for details.
1114 1568
1569=item $success = $term->grab_button ($button, $modifiermask)
1570
1571Registers a synchronous button grab. See the XGrabButton manpage.
1572
1573=item $success = $term->grab ($eventtime[, $sync])
1574
1575Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1576synchronous (C<$sync> is true). Also remembers the grab timestampe.
1577
1578=item $term->allow_events_async
1579
1580Calls XAllowEvents with AsyncBoth for the most recent grab.
1581
1582=item $term->allow_events_sync
1583
1584Calls XAllowEvents with SyncBoth for the most recent grab.
1585
1586=item $term->allow_events_replay
1587
1588Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1589recent grab.
1590
1591=item $term->ungrab
1592
1593Calls XUngrab for the most recent grab. Is called automatically on
1594evaluation errors, as it is better to lose the grab in the error case as
1595the session.
1596
1597=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1598
1599=item $atom_name = $term->XGetAtomName ($atom)
1600
1601=item @atoms = $term->XListProperties ($window)
1602
1603=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1604
1605=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1606
1607=item $term->XDeleteProperty ($window, $property)
1608
1609=item $window = $term->DefaultRootWindow
1610
1611=item $term->XReparentWindow ($window, $parent, [$x, $y])
1612
1613=item $term->XMapWindow ($window)
1614
1615=item $term->XUnmapWindow ($window)
1616
1617=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1618
1619=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1620
1621=item $term->XChangeInput ($window, $add_events[, $del_events])
1622
1623Various X or X-related functions. The C<$term> object only serves as
1624the source of the display, otherwise those functions map more-or-less
1625directory onto the X functions of the same name.
1626
1115=back 1627=back
1116 1628
1117=cut 1629=cut
1118 1630
1119package urxvt::popup; 1631package urxvt::popup;
1134 $item->{render} ||= sub { $_[0]{text} }; 1646 $item->{render} ||= sub { $_[0]{text} };
1135 1647
1136 push @{ $self->{item} }, $item; 1648 push @{ $self->{item} }, $item;
1137} 1649}
1138 1650
1139sub add_separator { 1651=item $popup->add_title ($title)
1140 my ($self, $sep) = @_;
1141 1652
1142 $sep ||= "═"; 1653Adds a non-clickable title to the popup.
1143 1654
1144 $self->add_item ({ 1655=cut
1145 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1146 text => "",
1147 render => sub { $sep x $urxvt::TERM->ncol },
1148 activate => sub { },
1149 });
1150}
1151 1656
1152sub add_title { 1657sub add_title {
1153 my ($self, $title) = @_; 1658 my ($self, $title) = @_;
1154 1659
1155 $self->add_item ({ 1660 $self->add_item ({
1157 text => $title, 1662 text => $title,
1158 activate => sub { }, 1663 activate => sub { },
1159 }); 1664 });
1160} 1665}
1161 1666
1667=item $popup->add_separator ([$sepchr])
1668
1669Creates a separator, optionally using the character given as C<$sepchr>.
1670
1671=cut
1672
1673sub add_separator {
1674 my ($self, $sep) = @_;
1675
1676 $sep ||= "=";
1677
1678 $self->add_item ({
1679 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1680 text => "",
1681 render => sub { $sep x $self->{term}->ncol },
1682 activate => sub { },
1683 });
1684}
1685
1686=item $popup->add_button ($text, $cb)
1687
1688Adds a clickable button to the popup. C<$cb> is called whenever it is
1689selected.
1690
1691=cut
1692
1162sub add_button { 1693sub add_button {
1163 my ($self, $text, $cb) = @_; 1694 my ($self, $text, $cb) = @_;
1164 1695
1165 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); 1696 $self->add_item ({ type => "button", text => $text, activate => $cb});
1166} 1697}
1698
1699=item $popup->add_toggle ($text, $cb, $initial_value)
1700
1701Adds a toggle/checkbox item to the popup. Teh callback gets called
1702whenever it gets toggled, with a boolean indicating its value as its first
1703argument.
1704
1705=cut
1167 1706
1168sub add_toggle { 1707sub add_toggle {
1169 my ($self, $text, $cb, $value) = @_; 1708 my ($self, $text, $cb, $value) = @_;
1170 1709
1171 my $item; $item = { 1710 my $item; $item = {
1172 type => "button", 1711 type => "button",
1173 text => " $text", 1712 text => " $text",
1174 value => $value, 1713 value => $value,
1175 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1714 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1176 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1715 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1177 }; 1716 };
1178 1717
1179 $self->add_item ($item); 1718 $self->add_item ($item);
1180} 1719}
1720
1721=item $popup->show
1722
1723Displays the popup (which is initially hidden).
1724
1725=cut
1181 1726
1182sub show { 1727sub show {
1183 my ($self) = @_; 1728 my ($self) = @_;
1184 1729
1185 local $urxvt::popup::self = $self; 1730 local $urxvt::popup::self = $self;
1186 1731
1187 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1732 my $env = $self->{term}->env;
1733 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1734 delete $env->{LC_ALL};
1735 $env->{LC_CTYPE} = $self->{term}->locale;
1736
1737 urxvt::term->new ($env, "popup",
1738 "--perl-lib" => "", "--perl-ext-common" => "",
1739 "-pty-fd" => -1, "-sl" => 0,
1740 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1188 "--transient-for" => $self->{term}->parent, 1741 "--transient-for" => $self->{term}->parent,
1742 "-display" => $self->{term}->display_id,
1189 "-pe" => "urxvt-popup") 1743 "-pe" => "urxvt-popup")
1190 or die "unable to create popup window\n"; 1744 or die "unable to create popup window\n";
1191} 1745}
1192 1746
1193sub DESTROY { 1747sub DESTROY {
1194 my ($self) = @_; 1748 my ($self) = @_;
1195 1749
1196 delete $self->{term}{_destroy}{$self}; 1750 delete $self->{term}{_destroy}{$self};
1197 $self->{term}->ungrab; 1751 $self->{term}->ungrab;
1198} 1752}
1753
1754=back
1755
1756=cut
1757
1758package urxvt::watcher;
1759
1760@urxvt::timer::ISA = __PACKAGE__;
1761@urxvt::iow::ISA = __PACKAGE__;
1762@urxvt::pw::ISA = __PACKAGE__;
1763@urxvt::iw::ISA = __PACKAGE__;
1199 1764
1200=head2 The C<urxvt::timer> Class 1765=head2 The C<urxvt::timer> Class
1201 1766
1202This class implements timer watchers/events. Time is represented as a 1767This class implements timer watchers/events. Time is represented as a
1203fractional number of seconds since the epoch. Example: 1768fractional number of seconds since the epoch. Example:
1242 1807
1243=item $timer = $timer->start ($tstamp) 1808=item $timer = $timer->start ($tstamp)
1244 1809
1245Set the event trigger time to C<$tstamp> and start the timer. 1810Set the event trigger time to C<$tstamp> and start the timer.
1246 1811
1812=item $timer = $timer->after ($delay)
1813
1814Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1815
1247=item $timer = $timer->stop 1816=item $timer = $timer->stop
1248 1817
1249Stop the timer. 1818Stop the timer.
1250 1819
1251=back 1820=back
1256 1825
1257 $term->{socket} = ... 1826 $term->{socket} = ...
1258 $term->{iow} = urxvt::iow 1827 $term->{iow} = urxvt::iow
1259 ->new 1828 ->new
1260 ->fd (fileno $term->{socket}) 1829 ->fd (fileno $term->{socket})
1261 ->events (1) # wait for read data 1830 ->events (urxvt::EVENT_READ)
1262 ->start 1831 ->start
1263 ->cb (sub { 1832 ->cb (sub {
1264 my ($iow, $revents) = @_; 1833 my ($iow, $revents) = @_;
1265 # $revents must be 1 here, no need to check 1834 # $revents must be 1 here, no need to check
1266 sysread $term->{socket}, my $buf, 8192 1835 sysread $term->{socket}, my $buf, 8192
1283 1852
1284Set the filedescriptor (not handle) to watch. 1853Set the filedescriptor (not handle) to watch.
1285 1854
1286=item $iow = $iow->events ($eventmask) 1855=item $iow = $iow->events ($eventmask)
1287 1856
1288Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 1857Set the event mask to watch. The only allowed values are
1289data, Bit #1 (value C<2>) enables watching for write data. 1858C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1859together, or C<urxvt::EVENT_NONE>.
1290 1860
1291=item $iow = $iow->start 1861=item $iow = $iow->start
1292 1862
1293Start watching for requested events on the given handle. 1863Start watching for requested events on the given handle.
1294 1864
1295=item $iow = $iow->stop 1865=item $iow = $iow->stop
1296 1866
1297Stop watching for events on the given filehandle. 1867Stop watching for events on the given filehandle.
1868
1869=back
1870
1871=head2 The C<urxvt::iw> Class
1872
1873This class implements idle watchers, that get called automatically when
1874the process is idle. They should return as fast as possible, after doing
1875some useful work.
1876
1877=over 4
1878
1879=item $iw = new urxvt::iw
1880
1881Create a new idle watcher object in stopped state.
1882
1883=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
1884
1885Set the callback to be called when the watcher triggers.
1886
1887=item $timer = $timer->start
1888
1889Start the watcher.
1890
1891=item $timer = $timer->stop
1892
1893Stop the watcher.
1894
1895=back
1896
1897=head2 The C<urxvt::pw> Class
1898
1899This class implements process watchers. They create an event whenever a
1900process exits, after which they stop automatically.
1901
1902 my $pid = fork;
1903 ...
1904 $term->{pw} = urxvt::pw
1905 ->new
1906 ->start ($pid)
1907 ->cb (sub {
1908 my ($pw, $exit_status) = @_;
1909 ...
1910 });
1911
1912=over 4
1913
1914=item $pw = new urxvt::pw
1915
1916Create a new process watcher in stopped state.
1917
1918=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
1919
1920Set the callback to be called when the timer triggers.
1921
1922=item $pw = $timer->start ($pid)
1923
1924Tells the wqtcher to start watching for process C<$pid>.
1925
1926=item $pw = $pw->stop
1927
1928Stop the watcher.
1298 1929
1299=back 1930=back
1300 1931
1301=head1 ENVIRONMENT 1932=head1 ENVIRONMENT
1302 1933
1309 1940
1310=item == 0 - fatal messages 1941=item == 0 - fatal messages
1311 1942
1312=item >= 3 - script loading and management 1943=item >= 3 - script loading and management
1313 1944
1314=item >=10 - all events received 1945=item >=10 - all called hooks
1946
1947=item >=11 - hook reutrn values
1315 1948
1316=back 1949=back
1317 1950
1318=head1 AUTHOR 1951=head1 AUTHOR
1319 1952

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines