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.5 by root, Mon Jan 2 17:20:00 2006 UTC vs.
Revision 1.211 by root, Wed Jun 6 14:34:03 2012 UTC

1=encoding utf8
2
1=head1 NAME 3=head1 NAME
2 4
3rxvtperl - rxvt-unicode's embedded perl interpreter 5@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4 6
5=head1 SYNOPSIS 7=head1 SYNOPSIS
6 8
7* Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, they will be loaded automatically. 9 # create a file grab_test in $HOME:
8
9* Each script will only be loaded once, even in urxvtd, and will be valid
10globally.
11
12* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
13thus must be encoded as UTF-8.
14 10
15 sub on_sel_grab { 11 sub on_sel_grab {
16 warn "you selected ", $_[0]->selection; 12 warn "you selected ", $_[0]->selection;
17 () 13 ()
18 } 14 }
19 15
20 1 16 # start a @@RXVT_NAME@@ using it:
17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
21 19
22=head1 DESCRIPTION 20=head1 DESCRIPTION
23 21
22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it.
24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26thus must be encoded as UTF-8.
27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals.
30
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
34=head1 PREPACKAGED EXTENSIONS
35
36This section describes the extensions delivered with this release. You can
37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
38
39You can activate them like this:
40
41 @@RXVT_NAME@@ -pe <extensionname>
42
43Or by adding them to the resource for extensions loaded by default:
44
45 URxvt.perl-ext-common: default,selection-autotransform
46
47=over 4
48
49=item selection (enabled by default)
50
51(More) intelligent selection. This extension tries to be more intelligent
52when the user extends selections (double-click and further clicks). Right
53now, it tries to select words, urls and complete shell-quoted
54arguments, which is very convenient, too, if your F<ls> supports
55C<--quoting-style=shell>.
56
57A double-click usually selects the word under the cursor, further clicks
58will enlarge the selection.
59
60The selection works by trying to match a number of regexes and displaying
61them in increasing order of length. You can add your own regexes by
62specifying resources of the form:
63
64 URxvt.selection.pattern-0: perl-regex
65 URxvt.selection.pattern-1: perl-regex
66 ...
67
68The index number (0, 1...) must not have any holes, and each regex must
69contain at least one pair of capturing parentheses, which will be used for
70the match. For example, the following adds a regex that matches everything
71between two vertical bars:
72
73 URxvt.selection.pattern-0: \\|([^|]+)\\|
74
75Another example: Programs I use often output "absolute path: " at the
76beginning of a line when they process multiple files. The following
77pattern matches the filename (note, there is a single space at the very
78end):
79
80 URxvt.selection.pattern-0: ^(/[^:]+):\
81
82You can look at the source of the selection extension to see more
83interesting uses, such as parsing a line from beginning to end.
84
85This extension also offers following bindable keyboard commands:
86
87=over 4
88
89=item rot13
90
91Rot-13 the selection when activated. Used via keyboard trigger:
92
93 URxvt.keysym.C-M-r: perl:selection:rot13
94
95=back
96
97=item option-popup (enabled by default)
98
99Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
100runtime.
101
102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed.
105
106Its sole argument is the popup menu, which can be modified. It should
107either return nothing or a string, the initial boolean value and a code
108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as
110first argument.
111
112The following will add an entry C<myoption> that changes
113C<< $self->{myoption} >>:
114
115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 };
118
119=item selection-popup (enabled by default)
120
121Binds a popup menu to Ctrl-Button3 that lets you convert the selection
122text into various other formats/action (such as uri unescaping, perl
123evaluation, web-browser starting etc.), depending on content.
124
125Other extensions can extend this popup menu by pushing a code reference
126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed.
128
129Its sole argument is the popup menu, which can be modified. The selection
130is in C<$_>, which can be used to decide whether to add something or not.
131It should either return nothing or a string and a code reference. The
132string will be used as button text and the code reference will be called
133when the button gets activated and should transform C<$_>.
134
135The following will add an entry C<a to b> that transforms all C<a>s in
136the selection to C<b>s, but only if the selection currently contains any
137C<a>s:
138
139 push @{ $self->{term}{selection_popup_hook} }, sub {
140 /a/ ? ("a to b" => sub { s/a/b/g }
141 : ()
142 };
143
144=item searchable-scrollback<hotkey> (enabled by default)
145
146Adds regex search functionality to the scrollback buffer, triggered
147by a hotkey (default: C<M-s>). While in search mode, normal terminal
148input/output is suspended and a regex is displayed at the bottom of the
149screen.
150
151Inputting characters appends them to the regex and continues incremental
152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
153search upwards/downwards in the scrollback buffer, C<End> jumps to the
154bottom. C<Escape> leaves search mode and returns to the point where search
155was started, while C<Enter> or C<Return> stay at the current position and
156additionally stores the first match in the current line into the primary
157selection if the C<Shift> modifier is active.
158
159The regex defaults to "(?i)", resulting in a case-insensitive search. To
160get a case-sensitive search you can delete this prefix using C<BackSpace>
161or simply use an uppercase character which removes the "(?i)" prefix.
162
163See L<perlre> for more info about perl regular expression syntax.
164
165=item readline (enabled by default)
166
167A support package that tries to make editing with readline easier. At
168the moment, it reacts to clicking shift-left mouse button by trying to
169move the text cursor to this position. It does so by generating as many
170cursor-left or cursor-right keypresses as required (this only works
171for programs that correctly support wide characters).
172
173To avoid too many false positives, this is only done when:
174
175=over 4
176
177=item - the tty is in ICANON state.
178
179=item - the text cursor is visible.
180
181=item - the primary screen is currently being displayed.
182
183=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185=back
186
187The normal selection mechanism isn't disabled, so quick successive clicks
188might interfere with selection creation in harmless ways.
189
190=item selection-autotransform
191
192This selection allows you to do automatic transforms on a selection
193whenever a selection is made.
194
195It works by specifying perl snippets (most useful is a single C<s///>
196operator) that modify C<$_> as resources:
197
198 URxvt.selection-autotransform.0: transform
199 URxvt.selection-autotransform.1: transform
200 ...
201
202For example, the following will transform selections of the form
203C<filename:number>, often seen in compiler messages, into C<vi +$filename
204$word>:
205
206 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
207
208And this example matches the same,but replaces it with vi-commands you can
209paste directly into your (vi :) editor:
210
211 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
212
213Of course, this can be modified to suit your needs and your editor :)
214
215To expand the example above to typical perl error messages ("XXX at
216FILENAME line YYY."), you need a slightly more elaborate solution:
217
218 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
219 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
220
221The first line tells the selection code to treat the unchanging part of
222every error message as a selection pattern, and the second line transforms
223the message into vi commands to load the file.
224
225=item tabbed
226
227This transforms the terminal into a tabbar with additional terminals, that
228is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230button per tab.
231
232Clicking a button will activate that tab. Pressing B<Shift-Left> and
233B<Shift-Right> will switch to the tab left or right of the current one,
234while B<Shift-Down> creates a new tab.
235
236The tabbar itself can be configured similarly to a normal terminal, but
237with a resource class of C<URxvt.tabbed>. In addition, it supports the
238following four resources (shown with defaults):
239
240 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242 URxvt.tabbed.tab-fg: <colour-index, default 0>
243 URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246indices.
247
248=item matcher
249
250Uses per-line display filtering (C<on_line_update>) to underline text
251matching a certain pattern and make it clickable. When clicked with the
252mouse button specified in the C<matcher.button> resource (default 2, or
253middle), the program specified in the C<matcher.launcher> resource
254(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255with the matched text as first argument. The default configuration is
256suitable for matching URLs and launching a web browser, like the
257former "mark-urls" extension.
258
259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis.
263
264It is possible to activate the most recently seen match or a list of matches
265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
266"perl:matcher:list" as seen in the example below.
267
268Example configuration:
269
270 URxvt.perl-ext: default,matcher
271 URxvt.urlLauncher: sensible-browser
272 URxvt.keysym.C-Delete: perl:matcher:last
273 URxvt.keysym.M-Delete: perl:matcher:list
274 URxvt.matcher.button: 1
275 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
276 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
277 URxvt.matcher.launcher.2: gvim +$2 $1
278
279=item xim-onthespot
280
281This (experimental) perl extension implements OnTheSpot editing. It does
282not work perfectly, and some input methods don't seem to work well with
283OnTheSpot editing in general, but it seems to work at least for SCIM and
284kinput2.
285
286You enable it by specifying this extension and a preedit style of
287C<OnTheSpot>, i.e.:
288
289 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
290
291=item kuake<hotkey>
292
293A very primitive quake-console-like extension. It was inspired by a
294description of how the programs C<kuake> and C<yakuake> work: Whenever the
295user presses a global accelerator key (by default C<F10>), the terminal
296will show or hide itself. Another press of the accelerator key will hide
297or show it again.
298
299Initially, the window will not be shown when using this extension.
300
301This is useful if you need a single terminal that is not using any desktop
302space most of the time but is quickly available at the press of a key.
303
304The accelerator key is grabbed regardless of any modifiers, so this
305extension will actually grab a physical key just for this function.
306
307If you want a quake-like animation, tell your window manager to do so
308(fvwm can do it).
309
310=item overlay-osc
311
312This extension implements some OSC commands to display timed popups on the
313screen - useful for status displays from within scripts. You have to read
314the sources for more info.
315
316=item block-graphics-to-ascii
317
318A not very useful example of filtering all text output to the terminal
319by replacing all line-drawing characters (U+2500 .. U+259F) by a
320similar-looking ascii character.
321
322=item digital-clock
323
324Displays a digital clock using the built-in overlay.
325
326=item remote-clipboard
327
328Somewhat of a misnomer, this extension adds two menu entries to the
329selection popup that allows one to run external commands to store the
330selection somewhere and fetch it again.
331
332We use it to implement a "distributed selection mechanism", which just
333means that one command uploads the file to a remote server, and another
334reads it.
335
336The commands can be set using the C<URxvt.remote-selection.store> and
337C<URxvt.remote-selection.fetch> resources. The first should read the
338selection to store from STDIN (always in UTF-8), the second should provide
339the selection data on STDOUT (also in UTF-8).
340
341The defaults (which are likely useless to you) use rsh and cat:
342
343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
345
346=item selection-pastebin
347
348This is a little rarely useful extension that uploads the selection as
349textfile to a remote site (or does other things). (The implementation is
350not currently secure for use in a multiuser environment as it writes to
351F</tmp> directly.).
352
353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
354i.e.
355
356 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
357
358Pressing this combination runs a command with C<%> replaced by the name of
359the textfile. This command can be set via a resource:
360
361 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
362
363And the default is likely not useful to anybody but the few people around
364here :)
365
366The name of the textfile is the hex encoded md5 sum of the selection, so
367the same content should lead to the same filename.
368
369After a successful upload the selection will be replaced by the text given
370in the C<selection-pastebin-url> resource (again, the % is the placeholder
371for the filename):
372
373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
374
375I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
376the double C</> characters as comment start. Use C<\057\057> instead,
377which works regardless of whether xrdb is used to parse the resource file
378or not.
379
380=item macosx-clipboard and macosx-clipboard-native
381
382These two modules implement an extended clipboard for Mac OS X. They are
383used like this:
384
385 URxvt.perl-ext-common: default,macosx-clipboard
386 URxvt.keysym.M-c: perl:macosx-clipboard:copy
387 URxvt.keysym.M-v: perl:macosx-clipboard:paste
388
389The difference between them is that the native variant requires a
390perl from apple's devkit or so, and C<macosx-clipboard> requires the
391C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392simpler etc. etc.
393
394=item example-refresh-hooks
395
396Displays a very simple digital clock in the upper right corner of the
397window. Illustrates overwriting the refresh callbacks to create your own
398overlays or changes.
399
400=item confirm-paste
401
402Displays a confirmation dialog when a paste containing at least a full
403line is detected.
404
405=item bell-command
406
407Runs the command specified by the C<URxvt.bell-command> resource when
408a bell event occurs. For example, the following pops up a notification
409bubble with the text "Beep, Beep" using notify-send:
410
411 URxvt.bell-command: notify-send "Beep, Beep"
412
413=back
414
415=head1 API DOCUMENTATION
416
417=head2 General API Considerations
418
419All objects (such as terminals, time watchers etc.) are typical
420reference-to-hash objects. The hash can be used to store anything you
421like. All members starting with an underscore (such as C<_ptr> or
422C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
423modified).
424
425When objects are destroyed on the C++ side, the perl object hashes are
426emptied, so its best to store related objects such as time watchers and
427the like inside the terminal object so they get destroyed as soon as the
428terminal is destroyed.
429
430Argument names also often indicate the type of a parameter. Here are some
431hints on what they mean:
432
433=over 4
434
435=item $text
436
437Rxvt-unicode's special way of encoding text, where one "unicode" character
438always represents one screen cell. See L<ROW_t> for a discussion of this format.
439
440=item $string
441
442A perl text string, with an emphasis on I<text>. It can store all unicode
443characters and is to be distinguished with text encoded in a specific
444encoding (often locale-specific) and binary data.
445
446=item $octets
447
448Either binary data or - more common - a text string encoded in a
449locale-specific way.
450
451=item $keysym
452
453an integer that is a valid X11 keysym code. You can convert a string
454into a keysym and viceversa by using C<XStringToKeysym> and
455C<XKeysymToString>.
456
457=back
458
459=head2 Extension Objects
460
461Every perl extension is a perl class. A separate perl object is created
462for each terminal, and each terminal has its own set of extension objects,
463which are passed as the first parameter to hooks. So extensions can use
464their C<$self> object without having to think about clashes with other
465extensions or other terminals, with the exception of methods and members
466that begin with an underscore character C<_>: these are reserved for
467internal use.
468
469Although it isn't a C<urxvt::term> object, you can call all methods of the
470C<urxvt::term> class on this object.
471
472It has the following methods and data members:
473
474=over 4
475
476=item $urxvt_term = $self->{term}
477
478Returns the C<urxvt::term> object associated with this instance of the
479extension. This member I<must not> be changed in any way.
480
481=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
482
483Dynamically enable the given hooks (named without the C<on_> prefix) for
484this extension, replacing any previous hook. This is useful when you want
485to overwrite time-critical hooks only temporarily.
486
487=item $self->disable ($hook_name[, $hook_name..])
488
489Dynamically disable the given hooks.
490
491=back
492
24=head2 Hooks 493=head2 Hooks
25 494
26The following subroutines can be declared in loaded scripts, and will be called 495The following subroutines can be declared in extension files, and will be
27whenever the relevant event happens. 496called whenever the relevant event happens.
28 497
29All of them must return a boolean value. If it is true, then the event 498The first argument passed to them is an extension object as described in
30counts as being I<consumed>, and the invocation of other hooks is skipped, 499the in the C<Extension Objects> section.
500
501B<All> of these hooks must return a boolean value. If any of the called
502hooks returns true, then the event counts as being I<consumed>, and the
31and the relevant action might not be carried out by the C++ code. 503relevant action might not be carried out by the C++ code.
32 504
33When in doubt, return a false value (preferably C<()>). 505I<< When in doubt, return a false value (preferably C<()>). >>
34 506
35=over 4 507=over 4
36 508
37=item on_init $term 509=item on_init $term
38 510
39Called after a new terminal object has been initialized, but before 511Called after a new terminal object has been initialized, but before
40windows are created or the command gets run. 512windows are created or the command gets run. Most methods are unsafe to
513call or deliver senseless data, as terminal size and other characteristics
514have not yet been determined. You can safely query and change resources
515and options, though. For many purposes the C<on_start> hook is a better
516place.
517
518=item on_start $term
519
520Called at the very end of initialisation of a new terminal, just before
521trying to map (display) the toplevel and returning to the main loop.
522
523=item on_destroy $term
524
525Called whenever something tries to destroy terminal, when the terminal is
526still fully functional (not for long, though).
41 527
42=item on_reset $term 528=item on_reset $term
43 529
44Called after the screen is "reset" for any reason, such as resizing or 530Called after the screen is "reset" for any reason, such as resizing or
45control sequences. Here is where you can react on changes to size-related 531control sequences. Here is where you can react on changes to size-related
46variables. 532variables.
47 533
48=item on_start $term 534=item on_child_start $term, $pid
49 535
50Called at the very end of initialisation of a new terminal, just before 536Called just after the child process has been C<fork>ed.
51returning to the mainloop. 537
538=item on_child_exit $term, $status
539
540Called just after the child process has exited. C<$status> is the status
541from C<waitpid>.
52 542
53=item on_sel_make $term, $eventtime 543=item on_sel_make $term, $eventtime
54 544
55Called whenever a selection has been made by the user, but before the 545Called whenever a selection has been made by the user, but before the
56selection text is copied, so changes to the beginning, end or type of the 546selection text is copied, so changes to the beginning, end or type of the
63 553
64Called whenever a selection has been copied, but before the selection is 554Called whenever a selection has been copied, but before the selection is
65requested from the server. The selection text can be queried and changed 555requested from the server. The selection text can be queried and changed
66by calling C<< $term->selection >>. 556by calling C<< $term->selection >>.
67 557
68Returning a true value aborts selection grabbing. It will still be hilighted. 558Returning a true value aborts selection grabbing. It will still be highlighted.
69 559
70=item on_focus_in $term 560=item on_sel_extend $term
71 561
72Called whenever the window gets the keyboard focus, before urxvt does 562Called whenever the user tries to extend the selection (e.g. with a double
73focus in processing. 563click) and is either supposed to return false (normal operation), or
564should extend the selection itself and return true to suppress the built-in
565processing. This can happen multiple times, as long as the callback
566returns true, it will be called on every further click by the user and is
567supposed to enlarge the selection more and more, if possible.
74 568
75=item on_focus_out $term 569See the F<selection> example extension.
76
77Called wheneever the window loses keyboard focus, before urxvt does focus
78out processing.
79 570
80=item on_view_change $term, $offset 571=item on_view_change $term, $offset
81 572
82Called whenever the view offset changes, i..e the user or program 573Called whenever the view offset changes, i.e. the user or program
83scrolls. Offset C<0> means display the normal terminal, positive values 574scrolls. Offset C<0> means display the normal terminal, positive values
84show this many lines of scrollback. 575show this many lines of scrollback.
85 576
86=item on_scroll_back $term, $lines, $saved 577=item on_scroll_back $term, $lines, $saved
87 578
91 582
92It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 583It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
93$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 584$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
94number of lines that will be in the scrollback buffer. 585number of lines that will be in the scrollback buffer.
95 586
96=item on_tty_activity $term *NYI* 587=item on_osc_seq $term, $op, $args, $resp
97 588
98Called whenever the program(s) running in the urxvt window send output. 589Called on every OSC sequence and can be used to suppress it or modify its
590behaviour. The default should be to return an empty list. A true value
591suppresses execution of the request completely. Make sure you don't get
592confused by recursive invocations when you output an OSC sequence within
593this callback.
594
595C<on_osc_seq_perl> should be used for new behaviour.
596
597=item on_osc_seq_perl $term, $args, $resp
598
599Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
600operating system command) is processed. Cursor position and other state
601information is up-to-date when this happens. For interoperability, the
602string should start with the extension name (sans -osc) and a semicolon,
603to distinguish it from commands for other extensions, and this might be
604enforced in the future.
605
606For example, C<overlay-osc> uses this:
607
608 sub on_osc_seq_perl {
609 my ($self, $osc, $resp) = @_;
610
611 return unless $osc =~ s/^overlay;//;
612
613 ... process remaining $osc string
614 }
615
616Be careful not ever to trust (in a security sense) the data you receive,
617as its source can not easily be controlled (e-mail content, messages from
618other users on the same system etc.).
619
620For responses, C<$resp> contains the end-of-args separator used by the
621sender.
622
623=item on_add_lines $term, $string
624
625Called whenever text is about to be output, with the text as argument. You
626can filter/change and output the text yourself by returning a true value
627and calling C<< $term->scr_add_lines >> yourself. Please note that this
628might be very slow, however, as your hook is called for B<all> text being
629output.
630
631=item on_tt_write $term, $octets
632
633Called whenever some data is written to the tty/pty and can be used to
634suppress or filter tty input.
635
636=item on_tt_paste $term, $octets
637
638Called whenever text is about to be pasted, with the text as argument. You
639can filter/change and paste the text yourself by returning a true value
640and calling C<< $term->tt_paste >> yourself. C<$octets> is
641locale-encoded.
642
643=item on_line_update $term, $row
644
645Called whenever a line was updated or changed. Can be used to filter
646screen output (e.g. underline urls or other useless stuff). Only lines
647that are being shown will be filtered, and, due to performance reasons,
648not always immediately.
649
650The row number is always the topmost row of the line if the line spans
651multiple rows.
652
653Please note that, if you change the line, then the hook might get called
654later with the already-modified line (e.g. if unrelated parts change), so
655you cannot just toggle rendition bits, but only set them.
99 656
100=item on_refresh_begin $term 657=item on_refresh_begin $term
101 658
102Called just before the screen gets redrawn. Can be used for overlay 659Called just before the screen gets redrawn. Can be used for overlay or
103or similar effects by modify terminal contents in refresh_begin, and 660similar effects by modifying the terminal contents in refresh_begin, and
104restoring them in refresh_end. The built-in overlay and selection display 661restoring them in refresh_end. The built-in overlay and selection display
105code is run after this hook, and takes precedence. 662code is run after this hook, and takes precedence.
106 663
107=item on_refresh_end $term 664=item on_refresh_end $term
108 665
109Called just after the screen gets redrawn. See C<on_refresh_begin>. 666Called just after the screen gets redrawn. See C<on_refresh_begin>.
110 667
668=item on_user_command $term, $string
669
670Called whenever a user-configured event is being activated (e.g. via
671a C<perl:string> action bound to a key, see description of the B<keysym>
672resource in the @@RXVT_NAME@@(1) manpage).
673
674The event is simply the action string. This interface is assumed to change
675slightly in the future.
676
677=item on_register_command $term, $keysym, $modifiermask, $string
678
679Called after parsing a keysym resource but before registering the
680associated binding. If this hook returns TRUE the binding is not
681registered. It can be used to modify a binding by calling
682C<register_command>.
683
684=item on_resize_all_windows $term, $new_width, $new_height
685
686Called just after the new window size has been calculated, but before
687windows are actually being resized or hints are being set. If this hook
688returns TRUE, setting of the window hints is being skipped.
689
690=item on_x_event $term, $event
691
692Called on every X event received on the vt window (and possibly other
693windows). Should only be used as a last resort. Most event structure
694members are not passed.
695
696=item on_root_event $term, $event
697
698Like C<on_x_event>, but is called for events on the root window.
699
700=item on_focus_in $term
701
702Called whenever the window gets the keyboard focus, before rxvt-unicode
703does focus in processing.
704
705=item on_focus_out $term
706
707Called whenever the window loses keyboard focus, before rxvt-unicode does
708focus out processing.
709
710=item on_configure_notify $term, $event
711
712=item on_property_notify $term, $event
713
714=item on_key_press $term, $event, $keysym, $octets
715
716=item on_key_release $term, $event, $keysym
717
718=item on_button_press $term, $event
719
720=item on_button_release $term, $event
721
722=item on_motion_notify $term, $event
723
724=item on_map_notify $term, $event
725
726=item on_unmap_notify $term, $event
727
728Called whenever the corresponding X event is received for the terminal. If
729the hook returns true, then the event will be ignored by rxvt-unicode.
730
731The event is a hash with most values as named by Xlib (see the XEvent
732manpage), with the additional members C<row> and C<col>, which are the
733(real, not screen-based) row and column under the mouse cursor.
734
735C<on_key_press> additionally receives the string rxvt-unicode would
736output, if any, in locale-specific encoding.
737
738subwindow.
739
740=item on_client_message $term, $event
741
742=item on_wm_protocols $term, $event
743
744=item on_wm_delete_window $term, $event
745
746Called when various types of ClientMessage events are received (all with
747format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
748
749=item on_bell $term
750
751Called on receipt of a bell character.
752
111=back 753=back
112 754
755=cut
756
757package urxvt;
758
759use utf8;
760use strict;
761use Carp ();
762use Scalar::Util ();
763use List::Util ();
764
765our $VERSION = 1;
766our $TERM;
767our @TERM_INIT; # should go, prevents async I/O etc.
768our @TERM_EXT; # should go, prevents async I/O etc.
769our @HOOKNAME;
770our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
771our %OPTION;
772
773our $LIBDIR;
774our $RESNAME;
775our $RESCLASS;
776our $RXVTNAME;
777
778our $NOCHAR = chr 0xffff;
779
780=head2 Variables in the C<urxvt> Package
781
782=over 4
783
784=item $urxvt::LIBDIR
785
786The rxvt-unicode library directory, where, among other things, the perl
787modules and scripts are stored.
788
789=item $urxvt::RESCLASS, $urxvt::RESCLASS
790
791The resource class and name rxvt-unicode uses to look up X resources.
792
793=item $urxvt::RXVTNAME
794
795The basename of the installed binaries, usually C<urxvt>.
796
797=item $urxvt::TERM
798
799The current terminal. This variable stores the current C<urxvt::term>
800object, whenever a callback/hook is executing.
801
802=item @urxvt::TERM_INIT
803
804All code references in this array will be called as methods of the next newly
805created C<urxvt::term> object (during the C<on_init> phase). The array
806gets cleared before the code references that were in it are being executed,
807so references can push themselves onto it again if they so desire.
808
809This complements to the perl-eval command line option, but gets executed
810first.
811
812=item @urxvt::TERM_EXT
813
814Works similar to C<@TERM_INIT>, but contains perl package/class names, which
815get registered as normal extensions after calling the hooks in C<@TERM_INIT>
816but before other extensions. Gets cleared just like C<@TERM_INIT>.
817
818=back
819
113=head2 Functions in the C<urxvt> Package 820=head2 Functions in the C<urxvt> Package
114 821
115=over 4 822=over 4
116 823
117=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
118 825
119Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
120costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
121starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
122 830
123=item urxvt::warn $string 831=item urxvt::warn $string
124 832
125Calls C<rxvt_warn> witht eh given string which should not include a 833Calls C<rxvt_warn> with the given string which should include a trailing
126newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
127that calls this function. 835that calls this function.
128 836
129Using this function has the advantage that its output ends up in the 837Using this function has the advantage that its output ends up in the
130correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
131 839
132=item $cellwidth = urxvt::wcswidth $string 840Messages have a size limit of 1023 bytes currently.
133 841
134Returns the number of screen-cells this string would need. Correctly 842=item @terms = urxvt::termlist
135accounts for wide and combining characters. 843
844Returns all urxvt::term objects that exist in this process, regardless of
845whether they are started, being destroyed etc., so be careful. Only term
846objects that have perl extensions attached will be returned (because there
847is no urxvt::term object associated with others).
136 848
137=item $time = urxvt::NOW 849=item $time = urxvt::NOW
138 850
139Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
140 852
853=item urxvt::CurrentTime
854
855=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
856Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
857Button4Mask, Button5Mask, AnyModifier
858
859=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
860ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
861PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
862Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
863KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
864ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
865FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
866
867=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
868EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
869GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
870UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
871ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
872CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
873SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
874
875Various constants for use in X calls and event processing.
876
877=back
878
879=head2 RENDITION
880
881Rendition bitsets contain information about colour, font, font styles and
882similar information for each screen cell.
883
884The following "macros" deal with changes in rendition sets. You should
885never just create a bitset, you should always modify an existing one,
886as they contain important information required for correct operation of
887rxvt-unicode.
888
889=over 4
890
891=item $rend = urxvt::DEFAULT_RSTYLE
892
893Returns the default rendition, as used when the terminal is starting up or
894being reset. Useful as a base to start when creating renditions.
895
896=item $rend = urxvt::OVERLAY_RSTYLE
897
898Return the rendition mask used for overlays by default.
899
900=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
901urxvt::RS_RVid, urxvt::RS_Uline
902
903Return the bit that enabled bold, italic, blink, reverse-video and
904underline, respectively. To enable such a style, just logically OR it into
905the bitset.
906
907=item $foreground = urxvt::GET_BASEFG $rend
908
909=item $background = urxvt::GET_BASEBG $rend
910
911Return the foreground/background colour index, respectively.
912
913=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
914
915=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
916
917=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
918
919Replace the foreground/background colour in the rendition mask with the
920specified one.
921
922=item $value = urxvt::GET_CUSTOM $rend
923
924Return the "custom" value: Every rendition has 5 bits for use by
925extensions. They can be set and changed as you like and are initially
926zero.
927
928=item $rend = urxvt::SET_CUSTOM $rend, $new_value
929
930Change the custom value.
931
932=back
933
141=cut 934=cut
142 935
143package urxvt;
144
145use strict;
146
147our $term;
148our @HOOKNAME;
149our $LIBDIR;
150
151BEGIN { 936BEGIN {
152 urxvt->bootstrap;
153
154 # overwrite perl's warn 937 # overwrite perl's warn
155 *CORE::GLOBAL::warn = sub { 938 *CORE::GLOBAL::warn = sub {
156 my $msg = join "", @_; 939 my $msg = join "", @_;
157 $msg .= "\n" 940 $msg .= "\n"
158 unless $msg =~ /\n$/; 941 unless $msg =~ /\n$/;
159 urxvt::warn ($msg); 942 urxvt::warn ($msg);
160 }; 943 };
161} 944}
162 945
946no warnings 'utf8';
947
948sub parse_resource {
949 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
950
951 $term->scan_meta;
952
953 my $r = $term->{meta}{resource};
954 while (my ($pattern, $v) = each %$r) {
955 $name =~ y/-/./ if $isarg;
956
957 if (
958 $pattern =~ s/\*$//
959 ? $pattern eq substr $name, 0, length $pattern
960 : $pattern eq $name
961 ) {
962 $name = "$urxvt::RESCLASS.$name";
963
964 push @TERM_EXT, $v->[0];
965
966 if ($v->[1] eq "boolean") {
967 $term->put_option_db ($name, $flag ? "true" : "false");
968 return 1;
969 } else {
970 $term->put_option_db ($name, $value);
971 return 1 + 2;
972 }
973 }
974 }
975
976 0
977}
978
979sub usage {
980 my ($term, $usage_type) = @_;
981
982 $term->scan_meta;
983
984 my $r = $term->{meta}{resource};
985
986 for my $pattern (sort keys %$r) {
987 my ($ext, $type, $desc) = @{ $r->{$pattern} };
988
989 $desc .= " (-pe $ext)";
990
991 if ($usage_type == 1) {
992 $pattern =~ y/./-/;
993 $pattern =~ s/\*/.../g;
994
995 if ($type eq "boolean") {
996 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
997 } else {
998 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
999 }
1000 } else {
1001 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
1002 }
1003 }
1004}
1005
163my $verbosity = $ENV{URXVT_PERL_VERBOSITY} || 10; 1006my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
164 1007
165sub verbose { 1008sub verbose {
166 my ($level, $msg) = @_; 1009 my ($level, $msg) = @_;
167 warn "$msg\n"; #d# 1010 warn "$msg\n" if $level <= $verbosity;
168} 1011}
169 1012
170my @invoke_cb; 1013my %extension_pkg;
1014
1015# load a single script into its own package, once only
1016sub extension_package($) {
1017 my ($path) = @_;
1018
1019 $extension_pkg{$path} ||= do {
1020 $path =~ /([^\/\\]+)$/;
1021 my $pkg = $1;
1022 $pkg =~ s/[^[:word:]]/_/g;
1023 $pkg = "urxvt::ext::$pkg";
1024
1025 verbose 3, "loading extension '$path' into package '$pkg'";
1026
1027 open my $fh, "<:raw", $path
1028 or die "$path: $!";
1029
1030 my $source =
1031 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
1032 . "#line 1 \"$path\"\n{\n"
1033 . (do { local $/; <$fh> })
1034 . "\n};\n1";
1035
1036 eval $source
1037 or die "$path: $@";
1038
1039 $pkg
1040 }
1041}
1042
1043our $retval; # return value for urxvt
171 1044
172# called by the rxvt core 1045# called by the rxvt core
173sub invoke { 1046sub invoke {
174 local $term = shift; 1047 local $TERM = shift;
175 my $htype = shift; 1048 my $htype = shift;
176 1049
177 my $cb = $invoke_cb[$htype]; 1050 if ($htype == 0) { # INIT
1051 my @dirs = $TERM->perl_libdirs;
178 1052
179 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" 1053 my %ext_arg;
180 if $verbosity >= 10;
181 1054
182 while (my ($k, $v) = each %$cb) { 1055 {
183 return 1 if $v->($term, @_); 1056 my @init = @TERM_INIT;
1057 @TERM_INIT = ();
1058 $_->($TERM) for @init;
1059 my @pkg = @TERM_EXT;
1060 @TERM_EXT = ();
1061 $TERM->register_package ($_) for @pkg;
1062 }
1063
1064 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
1065 if ($_ eq "default") {
1066 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
1067 } elsif (/^-(.*)$/) {
1068 delete $ext_arg{$1};
1069 } elsif (/^([^<]+)<(.*)>$/) {
1070 push @{ $ext_arg{$1} }, $2;
1071 } else {
1072 $ext_arg{$_} ||= [];
1073 }
1074 }
1075
1076 for my $ext (sort keys %ext_arg) {
1077 my @files = grep -f $_, map "$_/$ext", @dirs;
1078
1079 if (@files) {
1080 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
1081 } else {
1082 warn "perl extension '$ext' not found in perl library search path\n";
1083 }
1084 }
1085
1086 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
1087 warn $@ if $@;
184 } 1088 }
185 1089
1090 $retval = undef;
1091
1092 if (my $cb = $TERM->{_hook}[$htype]) {
1093 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1094 if $verbosity >= 10;
1095
1096 for my $pkg (keys %$cb) {
1097 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
1098 $retval ||= $retval_;
1099
1100 if ($@) {
1101 $TERM->ungrab; # better to lose the grab than the session
1102 warn $@;
1103 }
1104 }
1105
1106 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1107 if $verbosity >= 11;
186 0 1108 }
1109
1110 if ($htype == 1) { # DESTROY
1111 # clear package objects
1112 %$_ = () for values %{ $TERM->{_pkg} };
1113
1114 # clear package
1115 %$TERM = ();
1116 }
1117
1118 $retval
187} 1119}
1120
1121sub SET_COLOR($$$) {
1122 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1123}
1124
1125sub rend2mask {
1126 no strict 'refs';
1127 my ($str, $mask) = (@_, 0);
1128 my %color = ( fg => undef, bg => undef );
1129 my @failed;
1130 for my $spec ( split /\s+/, $str ) {
1131 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1132 $color{lc($1)} = $2;
1133 } else {
1134 my $neg = $spec =~ s/^[-^]//;
1135 unless ( exists &{"RS_$spec"} ) {
1136 push @failed, $spec;
1137 next;
1138 }
1139 my $cur = &{"RS_$spec"};
1140 if ( $neg ) {
1141 $mask &= ~$cur;
1142 } else {
1143 $mask |= $cur;
1144 }
1145 }
1146 }
1147 ($mask, @color{qw(fg bg)}, \@failed)
1148}
1149
1150# urxvt::term::extension
1151
1152package urxvt::term::extension;
1153
1154sub enable {
1155 my ($self, %hook) = @_;
1156 my $pkg = $self->{_pkg};
1157
1158 while (my ($name, $cb) = each %hook) {
1159 my $htype = $HOOKTYPE{uc $name};
1160 defined $htype
1161 or Carp::croak "unsupported hook type '$name'";
1162
1163 $self->set_should_invoke ($htype, +1)
1164 unless exists $self->{term}{_hook}[$htype]{$pkg};
1165
1166 $self->{term}{_hook}[$htype]{$pkg} = $cb;
1167 }
1168}
1169
1170sub disable {
1171 my ($self, @hook) = @_;
1172 my $pkg = $self->{_pkg};
1173
1174 for my $name (@hook) {
1175 my $htype = $HOOKTYPE{uc $name};
1176 defined $htype
1177 or Carp::croak "unsupported hook type '$name'";
1178
1179 $self->set_should_invoke ($htype, -1)
1180 if delete $self->{term}{_hook}[$htype]{$pkg};
1181 }
1182}
1183
1184our $AUTOLOAD;
1185
1186sub AUTOLOAD {
1187 $AUTOLOAD =~ /:([^:]+)$/
1188 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
1189
1190 eval qq{
1191 sub $AUTOLOAD {
1192 my \$proxy = shift;
1193 \$proxy->{term}->$1 (\@_)
1194 }
1195 1
1196 } or die "FATAL: unable to compile method forwarder: $@";
1197
1198 goto &$AUTOLOAD;
1199}
1200
1201sub DESTROY {
1202 # nop
1203}
1204
1205# urxvt::destroy_hook
1206
1207sub urxvt::destroy_hook::DESTROY {
1208 ${$_[0]}->();
1209}
1210
1211sub urxvt::destroy_hook(&) {
1212 bless \shift, urxvt::destroy_hook::
1213}
1214
1215package urxvt::anyevent;
1216
1217=head2 The C<urxvt::anyevent> Class
1218
1219The sole purpose of this class is to deliver an interface to the
1220C<AnyEvent> module - any module using it will work inside urxvt without
1221further programming. The only exception is that you cannot wait on
1222condition variables, but non-blocking condvar use is ok.
1223
1224In practical terms this means is that you cannot use blocking APIs, but
1225the non-blocking variant should work.
1226
1227=cut
1228
1229our $VERSION = '5.23';
1230
1231$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1232push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1233
1234sub timer {
1235 my ($class, %arg) = @_;
1236
1237 my $cb = $arg{cb};
1238
1239 urxvt::timer
1240 ->new
1241 ->after ($arg{after}, $arg{interval})
1242 ->cb ($arg{interval} ? $cb : sub {
1243 $_[0]->stop; # need to cancel manually
1244 $cb->();
1245 })
1246}
1247
1248sub io {
1249 my ($class, %arg) = @_;
1250
1251 my $cb = $arg{cb};
1252 my $fd = fileno $arg{fh};
1253 defined $fd or $fd = $arg{fh};
1254
1255 bless [$arg{fh}, urxvt::iow
1256 ->new
1257 ->fd ($fd)
1258 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1259 | ($arg{poll} =~ /w/ ? 2 : 0))
1260 ->start
1261 ->cb ($cb)
1262 ], urxvt::anyevent::
1263}
1264
1265sub idle {
1266 my ($class, %arg) = @_;
1267
1268 my $cb = $arg{cb};
1269
1270 urxvt::iw
1271 ->new
1272 ->start
1273 ->cb ($cb)
1274}
1275
1276sub child {
1277 my ($class, %arg) = @_;
1278
1279 my $cb = $arg{cb};
1280
1281 urxvt::pw
1282 ->new
1283 ->start ($arg{pid})
1284 ->cb (sub {
1285 $_[0]->stop; # need to cancel manually
1286 $cb->($_[0]->rpid, $_[0]->rstatus);
1287 })
1288}
1289
1290sub DESTROY {
1291 $_[0][1]->stop;
1292}
1293
1294# only needed for AnyEvent < 6 compatibility
1295sub one_event {
1296 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1297}
1298
1299package urxvt::term;
1300
1301=head2 The C<urxvt::term> Class
1302
1303=over 4
1304
1305=cut
188 1306
189# find on_xxx subs in the package and register them 1307# find on_xxx subs in the package and register them
190# as hooks 1308# as hooks
191sub register_package($) { 1309sub register_package {
192 my ($pkg) = @_; 1310 my ($self, $pkg, $argv) = @_;
193 1311
1312 no strict 'refs';
1313
1314 urxvt::verbose 6, "register package $pkg to $self";
1315
1316 @{"$pkg\::ISA"} = urxvt::term::extension::;
1317
1318 my $proxy = bless {
1319 _pkg => $pkg,
1320 argv => $argv,
1321 }, $pkg;
1322 Scalar::Util::weaken ($proxy->{term} = $self);
1323
1324 $self->{_pkg}{$pkg} = $proxy;
1325
194 for my $hook (0.. $#HOOKNAME) { 1326 for my $name (@HOOKNAME) {
195 my $name = $HOOKNAME[$hook];
196
197 my $ref = $pkg->can ("on_" . lc $name) 1327 if (my $ref = $pkg->can ("on_" . lc $name)) {
1328 $proxy->enable ($name => $ref);
1329 }
1330 }
1331}
1332
1333sub perl_libdirs {
1334 map { split /:/ }
1335 $_[0]->resource ("perl_lib"),
1336 $ENV{URXVT_PERL_LIB},
1337 "$ENV{HOME}/.urxvt/ext",
1338 "$LIBDIR/perl"
1339}
1340
1341sub scan_meta {
1342 my ($self) = @_;
1343 my @libdirs = perl_libdirs $self;
1344
1345 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1346
1347 my %meta;
1348
1349 $self->{meta_libdirs} = join "\x00", @libdirs;
1350 $self->{meta} = \%meta;
1351
1352 for my $dir (reverse @libdirs) {
1353 opendir my $fh, $dir
198 or next; 1354 or next;
1355 for my $ext (readdir $fh) {
1356 $ext ne "."
1357 and $ext ne ".."
1358 and open my $fh, "<", "$dir/$ext"
1359 or next;
199 1360
200 $invoke_cb[$hook]{$ref*1} = $ref; 1361 while (<$fh>) {
201 set_should_invoke $hook, 1; 1362 if (/^#:META:X_RESOURCE:(.*)/) {
1363 my ($pattern, $type, $desc) = split /:/, $1;
1364 $pattern =~ s/^%\./$ext./g; # $$ in pattern == extension name
1365 if ($pattern =~ /[^a-zA-Z\*\.]/) {
1366 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1367 } else {
1368 $meta{resource}{$pattern} = [$ext, $type, $desc];
1369 }
1370 } elsif (/^\s*(?:#|$)/) {
1371 # skip other comments and empty lines
1372 } else {
1373 last; # stop parsing on first non-empty non-comment line
1374 }
1375 }
1376 }
202 } 1377 }
203} 1378}
204 1379
205my $script_pkg = "script0000"; 1380=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
206my %script_pkg;
207 1381
208# load a single script into its own package, once only 1382Creates a new terminal, very similar as if you had started it with system
209sub load_script($) { 1383C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
210 my ($path) = @_; 1384hash which defines the environment of the new terminal.
211 1385
212 $script_pkg{$path} ||= do { 1386Croaks (and probably outputs an error message) if the new instance
213 my $pkg = $script_pkg++; 1387couldn't be created. Returns C<undef> if the new instance didn't
214 verbose 3, "loading script '$path' into package '$pkg'"; 1388initialise perl, and the terminal object otherwise. The C<init> and
1389C<start> hooks will be called before this call returns, and are free to
1390refer to global data (which is race free).
215 1391
216 open my $fh, "<:raw", $path 1392=cut
217 or die "$path: $!";
218 1393
219 eval "package $pkg; use strict; use utf8;\n" 1394sub new {
220 . "#line 1 \"$path\"\n" 1395 my ($class, $env, @args) = @_;
221 . do { local $/; <$fh> }
222 or die "$path: $@";
223 1396
224 register_package $pkg; 1397 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1398 @args or Carp::croak "name argument missing in call to urxvt::term->new";
225 1399
226 $pkg 1400 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
227 };
228} 1401}
229 1402
230load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>; 1403=item $term->destroy
231 1404
232=back 1405Destroy the terminal object (close the window, free resources
1406etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
1407watchers (timers, io watchers) are still active.
233 1408
234=head2 The C<urxvt::term> Class 1409=item $term->exec_async ($cmd[, @args])
235 1410
236=over 4 1411Works like the combination of the C<fork>/C<exec> builtins, which executes
1412("starts") programs in the background. This function takes care of setting
1413the user environment before exec'ing the command (e.g. C<PATH>) and should
1414be preferred over explicit calls to C<exec> or C<system>.
1415
1416Returns the pid of the subprocess or C<undef> on error.
1417
1418=cut
1419
1420sub exec_async {
1421 my $self = shift;
1422
1423 my $pid = fork;
1424
1425 return $pid
1426 if !defined $pid or $pid;
1427
1428 %ENV = %{ $self->env };
1429
1430 exec @_;
1431 urxvt::_exit 255;
1432}
1433
1434=item $isset = $term->option ($optval[, $set])
1435
1436Returns true if the option specified by C<$optval> is enabled, and
1437optionally change it. All option values are stored by name in the hash
1438C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1439
1440Here is a likely non-exhaustive list of option names, please see the
1441source file F</src/optinc.h> to see the actual list:
1442
1443 borderLess buffered console cursorBlink cursorUnderline hold iconic
1444 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1445 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1446 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1447 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1448 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1449 urgentOnBell utmpInhibit visualBell
237 1450
238=item $value = $term->resource ($name[, $newval]) 1451=item $value = $term->resource ($name[, $newval])
239 1452
240Returns the current resource value associated with a given name and 1453Returns the current resource value associated with a given name and
241optionally sets a new value. Setting values is most useful in the C<init> 1454optionally sets a new value. Setting values is most useful in the C<init>
250likely change). 1463likely change).
251 1464
252Please note that resource strings will currently only be freed when the 1465Please note that resource strings will currently only be freed when the
253terminal is destroyed, so changing options frequently will eat memory. 1466terminal is destroyed, so changing options frequently will eat memory.
254 1467
255Here is a a likely non-exhaustive list of resource names, not all of which 1468Here is a likely non-exhaustive list of resource names, not all of which
256are supported in every build, please see the source to see the actual 1469are supported in every build, please see the source file F</src/rsinc.h>
257list: 1470to see the actual list:
258 1471
259 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1472 answerbackstring backgroundPixmap backspace_key blendtype blurradius
260 borderLess color cursorBlink cursorUnderline cutchars delete_key 1473 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
261 display_name embed ext_bwidth fade font geometry hold iconName 1474 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
262 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1475 fade font geometry hold iconName iconfile imFont imLocale inputMethod
263 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 1476 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
264 modifier mouseWheelScrollPage name pastableTabs path pointerBlank 1477 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1478 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1479 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
265 pointerBlankDelay preeditType print_pipe pty_fd reverseVideo saveLines 1480 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
266 scrollBar scrollBar_align scrollBar_floating scrollBar_right 1481 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
267 scrollBar_thickness scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1482 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
268 scrollstyle secondaryScreen secondaryScroll selectstyle shade term_name 1483 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
269 title transparent transparent_all tripleclickwords utmpInhibit 1484 term_name title transient_for transparent tripleclickwords urgentOnBell
270 visualBell 1485 utmpInhibit visualBell
271 1486
272=cut 1487=cut
273 1488
274sub urxvt::term::resource($$;$) { 1489sub resource($$;$) {
275 my ($self, $name) = (shift, shift); 1490 my ($self, $name) = (shift, shift);
276 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1491 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
277 goto &urxvt::term::_resource; 1492 goto &urxvt::term::_resource
278} 1493}
1494
1495=item $value = $term->x_resource ($pattern)
1496
1497Returns the X-Resource for the given pattern, excluding the program or
1498class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1499same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1500resource with that pattern exists.
1501
1502This method should only be called during the C<on_start> hook, as there is
1503only one resource database per display, and later invocations might return
1504the wrong resources.
1505
1506=item $value = $term->x_resource_boolean ($pattern)
1507
1508Like C<x_resource>, above, but interprets the string value as a boolean
1509and returns C<1> for true values, C<0> for false values and C<undef> if
1510the resource or option isn't specified.
1511
1512You should always use this method to parse boolean resources.
1513
1514=cut
1515
1516sub x_resource_boolean {
1517 my $res = &x_resource;
1518
1519 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1520}
1521
1522=item $success = $term->parse_keysym ($key, $octets)
1523
1524Adds a key binding exactly as specified via a resource. See the
1525C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1526
1527=item $term->register_command ($keysym, $modifiermask, $string)
1528
1529Adds a key binding. This is a lower level api compared to
1530C<parse_keysym>, as it expects a parsed key description, and can be
1531used only inside either the C<on_init> hook, to add a binding, or the
1532C<on_register_command> hook, to modify a parsed binding.
1533
1534=item $rend = $term->rstyle ([$new_rstyle])
1535
1536Return and optionally change the current rendition. Text that is output by
1537the terminal application will use this style.
1538
1539=item ($row, $col) = $term->screen_cur ([$row, $col])
1540
1541Return the current coordinates of the text cursor position and optionally
1542set it (which is usually bad as applications don't expect that).
279 1543
280=item ($row, $col) = $term->selection_mark ([$row, $col]) 1544=item ($row, $col) = $term->selection_mark ([$row, $col])
281 1545
282=item ($row, $col) = $term->selection_beg ([$row, $col]) 1546=item ($row, $col) = $term->selection_beg ([$row, $col])
283 1547
284=item ($row, $col) = $term->selection_end ([$row, $col]) 1548=item ($row, $col) = $term->selection_end ([$row, $col])
285 1549
286Return the current values of the selection mark, begin or end positions, 1550Return the current values of the selection mark, begin or end positions.
287and optionally set them to new values.
288 1551
1552When arguments are given, then the selection coordinates are set to
1553C<$row> and C<$col>, and the selection screen is set to the current
1554screen.
1555
1556=item $screen = $term->selection_screen ([$screen])
1557
1558Returns the current selection screen, and then optionally sets it.
1559
1560=item $term->selection_make ($eventtime[, $rectangular])
1561
1562Tries to make a selection as set by C<selection_beg> and
1563C<selection_end>. If C<$rectangular> is true (default: false), a
1564rectangular selection will be made. This is the preferred function to make
1565a selection.
1566
289=item $success = $term->selection_grab ($eventtime) 1567=item $success = $term->selection_grab ($eventtime[, $clipboard])
290 1568
291Try to request the primary selection from the server (for example, as set 1569Try to acquire ownership of the primary (clipboard if C<$clipboard> is
292by the next method). 1570true) selection from the server. The corresponding text can be set
1571with the next method. No visual feedback will be given. This function
1572is mostly useful from within C<on_sel_grab> hooks.
293 1573
294=item $oldtext = $term->selection ([$newtext]) 1574=item $oldtext = $term->selection ([$newtext, $clipboard])
295 1575
296Return the current selection text and optionally replace it by C<$newtext>. 1576Return the current selection (clipboard if C<$clipboard> is true) text
1577and optionally replace it by C<$newtext>.
297 1578
1579=item $term->selection_clear ([$clipboard])
1580
1581Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1582
298=item $term->scr_overlay ($x, $y, $text) 1583=item $term->overlay_simple ($x, $y, $text)
299 1584
300Create a simple multi-line overlay box. See the next method for details. 1585Create a simple multi-line overlay box. See the next method for details.
301 1586
302=cut 1587=cut
303 1588
304sub urxvt::term::scr_overlay { 1589sub overlay_simple {
305 my ($self, $x, $y, $text) = @_; 1590 my ($self, $x, $y, $text) = @_;
306 1591
307 my @lines = split /\n/, $text; 1592 my @lines = split /\n/, $text;
308 1593
309 my $w = 0; 1594 my $w = List::Util::max map $self->strwidth ($_), @lines;
310 for (map urxvt::wcswidth $_, @lines) { 1595
311 $w = $_ if $w < $_; 1596 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
1597 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
1598
1599 $overlay
1600}
1601
1602=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
1603
1604Create a new (empty) overlay at the given position with the given
1605width/height. C<$rstyle> defines the initial rendition style
1606(default: C<OVERLAY_RSTYLE>).
1607
1608If C<$border> is C<2> (default), then a decorative border will be put
1609around the box.
1610
1611If either C<$x> or C<$y> is negative, then this is counted from the
1612right/bottom side, respectively.
1613
1614This method returns an urxvt::overlay object. The overlay will be visible
1615as long as the perl object is referenced.
1616
1617The methods currently supported on C<urxvt::overlay> objects are:
1618
1619=over 4
1620
1621=item $overlay->set ($x, $y, $text[, $rend])
1622
1623Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1624text in rxvt-unicode's special encoding and an array of rendition values
1625at a specific position inside the overlay.
1626
1627If C<$rend> is missing, then the rendition will not be changed.
1628
1629=item $overlay->hide
1630
1631If visible, hide the overlay, but do not destroy it.
1632
1633=item $overlay->show
1634
1635If hidden, display the overlay again.
1636
1637=back
1638
1639=item $popup = $term->popup ($event)
1640
1641Creates a new C<urxvt::popup> object that implements a popup menu. The
1642C<$event> I<must> be the event causing the menu to pop up (a button event,
1643currently).
1644
1645=cut
1646
1647sub popup {
1648 my ($self, $event) = @_;
1649
1650 $self->grab ($event->{time}, 1)
1651 or return;
1652
1653 my $popup = bless {
1654 term => $self,
1655 event => $event,
1656 }, urxvt::popup::;
1657
1658 Scalar::Util::weaken $popup->{term};
1659
1660 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
1661 Scalar::Util::weaken $self->{_destroy}{$popup};
1662
1663 $popup
1664}
1665
1666=item $cellwidth = $term->strwidth ($string)
1667
1668Returns the number of screen-cells this string would need. Correctly
1669accounts for wide and combining characters.
1670
1671=item $octets = $term->locale_encode ($string)
1672
1673Convert the given text string into the corresponding locale encoding.
1674
1675=item $string = $term->locale_decode ($octets)
1676
1677Convert the given locale-encoded octets into a perl string.
1678
1679=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1680
1681XORs the rendition values in the given span with the provided value
1682(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1683refresh hooks to provide effects similar to the selection.
1684
1685=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1686
1687Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1688whitespace will additionally be xored with the C<$rstyle2>, which defaults
1689to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1690it instead. Both styles I<MUST NOT> contain font styles.
1691
1692=item $term->scr_bell
1693
1694Ring the bell!
1695
1696=item $term->scr_add_lines ($string)
1697
1698Write the given text string to the screen, as if output by the application
1699running inside the terminal. It may not contain command sequences (escape
1700codes), but is free to use line feeds, carriage returns and tabs. The
1701string is a normal text string, not in locale-dependent encoding.
1702
1703Normally its not a good idea to use this function, as programs might be
1704confused by changes in cursor position or scrolling. Its useful inside a
1705C<on_add_lines> hook, though.
1706
1707=item $term->scr_change_screen ($screen)
1708
1709Switch to given screen - 0 primary, 1 secondary.
1710
1711=item $term->cmd_parse ($octets)
1712
1713Similar to C<scr_add_lines>, but the argument must be in the
1714locale-specific encoding of the terminal and can contain command sequences
1715(escape codes) that will be interpreted.
1716
1717=item $term->tt_write ($octets)
1718
1719Write the octets given in C<$octets> to the tty (i.e. as program input). To
1720pass characters instead of octets, you should convert your strings first
1721to the locale-specific encoding using C<< $term->locale_encode >>.
1722
1723=item $term->tt_paste ($octets)
1724
1725Write the octets given in C<$octets> to the tty as a paste, converting NL to
1726CR and bracketing the data with control sequences if bracketed paste mode
1727is set.
1728
1729=item $old_events = $term->pty_ev_events ([$new_events])
1730
1731Replaces the event mask of the pty watcher by the given event mask. Can
1732be used to suppress input and output handling to the pty/tty. See the
1733description of C<< urxvt::timer->events >>. Make sure to always restore
1734the previous value.
1735
1736=item $fd = $term->pty_fd
1737
1738Returns the master file descriptor for the pty in use, or C<-1> if no pty
1739is used.
1740
1741=item $windowid = $term->parent
1742
1743Return the window id of the toplevel window.
1744
1745=item $windowid = $term->vt
1746
1747Return the window id of the terminal window.
1748
1749=item $term->vt_emask_add ($x_event_mask)
1750
1751Adds the specified events to the vt event mask. Useful e.g. when you want
1752to receive pointer events all the times:
1753
1754 $term->vt_emask_add (urxvt::PointerMotionMask);
1755
1756=item $term->set_urgency ($set)
1757
1758Enable/disable the urgency hint on the toplevel window.
1759
1760=item $term->focus_in
1761
1762=item $term->focus_out
1763
1764=item $term->key_press ($state, $keycode[, $time])
1765
1766=item $term->key_release ($state, $keycode[, $time])
1767
1768Deliver various fake events to to terminal.
1769
1770=item $window_width = $term->width
1771
1772=item $window_height = $term->height
1773
1774=item $font_width = $term->fwidth
1775
1776=item $font_height = $term->fheight
1777
1778=item $font_ascent = $term->fbase
1779
1780=item $terminal_rows = $term->nrow
1781
1782=item $terminal_columns = $term->ncol
1783
1784=item $has_focus = $term->focus
1785
1786=item $is_mapped = $term->mapped
1787
1788=item $max_scrollback = $term->saveLines
1789
1790=item $nrow_plus_saveLines = $term->total_rows
1791
1792=item $topmost_scrollback_row = $term->top_row
1793
1794Return various integers describing terminal characteristics.
1795
1796=item $x_display = $term->display_id
1797
1798Return the DISPLAY used by rxvt-unicode.
1799
1800=item $lc_ctype = $term->locale
1801
1802Returns the LC_CTYPE category string used by this rxvt-unicode.
1803
1804=item $env = $term->env
1805
1806Returns a copy of the environment in effect for the terminal as a hashref
1807similar to C<\%ENV>.
1808
1809=item @envv = $term->envv
1810
1811Returns the environment as array of strings of the form C<VAR=VALUE>.
1812
1813=item @argv = $term->argv
1814
1815Return the argument vector as this terminal, similar to @ARGV, but
1816includes the program name as first element.
1817
1818=cut
1819
1820sub env {
1821 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1822}
1823
1824=item $modifiermask = $term->ModLevel3Mask
1825
1826=item $modifiermask = $term->ModMetaMask
1827
1828=item $modifiermask = $term->ModNumLockMask
1829
1830Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1831AltGr), the meta key (often Alt) and the num lock key, if applicable.
1832
1833=item $screen = $term->current_screen
1834
1835Returns the currently displayed screen (0 primary, 1 secondary).
1836
1837=item $cursor_is_hidden = $term->hidden_cursor
1838
1839Returns whether the cursor is currently hidden or not.
1840
1841=item $view_start = $term->view_start ([$newvalue])
1842
1843Returns the row number of the topmost displayed line. Maximum value is
1844C<0>, which displays the normal terminal contents. Lower values scroll
1845this many lines into the scrollback buffer.
1846
1847=item $term->want_refresh
1848
1849Requests a screen refresh. At the next opportunity, rxvt-unicode will
1850compare the on-screen display with its stored representation. If they
1851differ, it redraws the differences.
1852
1853Used after changing terminal contents to display them.
1854
1855=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1856
1857Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1858is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1859terminal line. Nothing will be returned if a nonexistent line
1860is requested.
1861
1862If C<$new_text> is specified, it will replace characters in the current
1863line, starting at column C<$start_col> (default C<0>), which is useful
1864to replace only parts of a line. The font index in the rendition will
1865automatically be updated.
1866
1867C<$text> is in a special encoding: tabs and wide characters that use more
1868than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1869characters. Characters with combining characters and other characters that
1870do not fit into the normal text encoding will be replaced with characters
1871in the private use area.
1872
1873You have to obey this encoding when changing text. The advantage is
1874that C<substr> and similar functions work on screen cells and not on
1875characters.
1876
1877The methods C<< $term->special_encode >> and C<< $term->special_decode >>
1878can be used to convert normal strings into this encoding and vice versa.
1879
1880=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
1881
1882Like C<< $term->ROW_t >>, but returns an arrayref with rendition
1883bitsets. Rendition bitsets contain information about colour, font, font
1884styles and similar information. See also C<< $term->ROW_t >>.
1885
1886When setting rendition, the font mask will be ignored.
1887
1888See the section on RENDITION, above.
1889
1890=item $length = $term->ROW_l ($row_number[, $new_length])
1891
1892Returns the number of screen cells that are in use ("the line
1893length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
1894line is joined with the following one.
1895
1896=item $bool = $term->is_longer ($row_number)
1897
1898Returns true if the row is part of a multiple-row logical "line" (i.e.
1899joined with the following row), which means all characters are in use
1900and it is continued on the next row (and possibly a continuation of the
1901previous row(s)).
1902
1903=item $line = $term->line ($row_number)
1904
1905Create and return a new C<urxvt::line> object that stores information
1906about the logical line that row C<$row_number> is part of. It supports the
1907following methods:
1908
1909=over 4
1910
1911=item $text = $line->t ([$new_text])
1912
1913Returns or replaces the full text of the line, similar to C<ROW_t>
1914
1915=item $rend = $line->r ([$new_rend])
1916
1917Returns or replaces the full rendition array of the line, similar to C<ROW_r>
1918
1919=item $length = $line->l
1920
1921Returns the length of the line in cells, similar to C<ROW_l>.
1922
1923=item $rownum = $line->beg
1924
1925=item $rownum = $line->end
1926
1927Return the row number of the first/last row of the line, respectively.
1928
1929=item $offset = $line->offset_of ($row, $col)
1930
1931Returns the character offset of the given row|col pair within the logical
1932line. Works for rows outside the line, too, and returns corresponding
1933offsets outside the string.
1934
1935=item ($row, $col) = $line->coord_of ($offset)
1936
1937Translates a string offset into terminal coordinates again.
1938
1939=back
1940
1941=cut
1942
1943sub line {
1944 my ($self, $row) = @_;
1945
1946 my $maxrow = $self->nrow - 1;
1947
1948 my ($beg, $end) = ($row, $row);
1949
1950 --$beg while $self->ROW_is_longer ($beg - 1);
1951 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
1952
1953 bless {
1954 term => $self,
1955 beg => $beg,
1956 end => $end,
1957 ncol => $self->ncol,
1958 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
1959 }, urxvt::line::
1960}
1961
1962sub urxvt::line::t {
1963 my ($self) = @_;
1964
1965 if (@_ > 1)
1966 {
1967 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1968 for $self->{beg} .. $self->{end};
1969 }
1970
1971 defined wantarray &&
1972 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1973 0, $self->{len}
1974}
1975
1976sub urxvt::line::r {
1977 my ($self) = @_;
1978
1979 if (@_ > 1)
1980 {
1981 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1982 for $self->{beg} .. $self->{end};
1983 }
1984
1985 if (defined wantarray) {
1986 my $rend = [
1987 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1988 ];
1989 $#$rend = $self->{len} - 1;
1990 return $rend;
312 } 1991 }
313 1992
314 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 1993 ()
315 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
316} 1994}
317 1995
318=item $term->scr_overlay_new ($x, $y, $width, $height) 1996sub urxvt::line::beg { $_[0]{beg} }
1997sub urxvt::line::end { $_[0]{end} }
1998sub urxvt::line::l { $_[0]{len} }
319 1999
320Create a new (empty) overlay at the given position with the given 2000sub urxvt::line::offset_of {
321width/height. A border will be put around the box. If either C<$x> or 2001 my ($self, $row, $col) = @_;
322C<$y> is negative, then this is counted from the right/bottom side,
323respectively.
324 2002
325=item $term->scr_overlay_off 2003 ($row - $self->{beg}) * $self->{ncol} + $col
2004}
326 2005
327Switch the overlay off again. 2006sub urxvt::line::coord_of {
2007 my ($self, $offset) = @_;
328 2008
329=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) 2009 use integer;
330 2010
331Put a single character (specified numerically) at the given overlay 2011 (
332position. 2012 $offset / $self->{ncol} + $self->{beg},
2013 $offset % $self->{ncol}
2014 )
2015}
333 2016
334=item $term->scr_overlay_set ($x, $y, $text) 2017=item $text = $term->special_encode $string
335 2018
336Write a string at the given position into the overlay. 2019Converts a perl string into the special encoding used by rxvt-unicode,
2020where one character corresponds to one screen cell. See
2021C<< $term->ROW_t >> for details.
2022
2023=item $string = $term->special_decode $text
2024
2025Converts rxvt-unicodes text representation into a perl string. See
2026C<< $term->ROW_t >> for details.
2027
2028=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
2029
2030=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
2031
2032Register/unregister a synchronous button grab. See the XGrabButton
2033manpage.
2034
2035=item $success = $term->grab ($eventtime[, $sync])
2036
2037Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
2038synchronous (C<$sync> is true). Also remembers the grab timestamp.
2039
2040=item $term->allow_events_async
2041
2042Calls XAllowEvents with AsyncBoth for the most recent grab.
2043
2044=item $term->allow_events_sync
2045
2046Calls XAllowEvents with SyncBoth for the most recent grab.
2047
2048=item $term->allow_events_replay
2049
2050Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
2051recent grab.
2052
2053=item $term->ungrab
2054
2055Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
2056evaluation errors, as it is better to lose the grab in the error case as
2057the session.
2058
2059=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
2060
2061=item $atom_name = $term->XGetAtomName ($atom)
2062
2063=item @atoms = $term->XListProperties ($window)
2064
2065=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
2066
2067=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
2068
2069=item $term->XDeleteProperty ($window, $property)
2070
2071=item $window = $term->DefaultRootWindow
2072
2073=item $term->XReparentWindow ($window, $parent, [$x, $y])
2074
2075=item $term->XMapWindow ($window)
2076
2077=item $term->XUnmapWindow ($window)
2078
2079=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
2080
2081=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
2082
2083=item $term->XChangeInput ($window, $add_events[, $del_events])
2084
2085=item $keysym = $term->XStringToKeysym ($string)
2086
2087=item $string = $term->XKeysymToString ($keysym)
2088
2089Various X or X-related functions. The C<$term> object only serves as
2090the source of the display, otherwise those functions map more-or-less
2091directly onto the X functions of the same name.
337 2092
338=back 2093=back
2094
2095=cut
2096
2097package urxvt::popup;
2098
2099=head2 The C<urxvt::popup> Class
2100
2101=over 4
2102
2103=cut
2104
2105sub add_item {
2106 my ($self, $item) = @_;
2107
2108 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
2109 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
2110 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
2111
2112 $item->{render} ||= sub { $_[0]{text} };
2113
2114 push @{ $self->{item} }, $item;
2115}
2116
2117=item $popup->add_title ($title)
2118
2119Adds a non-clickable title to the popup.
2120
2121=cut
2122
2123sub add_title {
2124 my ($self, $title) = @_;
2125
2126 $self->add_item ({
2127 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
2128 text => $title,
2129 activate => sub { },
2130 });
2131}
2132
2133=item $popup->add_separator ([$sepchr])
2134
2135Creates a separator, optionally using the character given as C<$sepchr>.
2136
2137=cut
2138
2139sub add_separator {
2140 my ($self, $sep) = @_;
2141
2142 $sep ||= "=";
2143
2144 $self->add_item ({
2145 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
2146 text => "",
2147 render => sub { $sep x $self->{term}->ncol },
2148 activate => sub { },
2149 });
2150}
2151
2152=item $popup->add_button ($text, $cb)
2153
2154Adds a clickable button to the popup. C<$cb> is called whenever it is
2155selected.
2156
2157=cut
2158
2159sub add_button {
2160 my ($self, $text, $cb) = @_;
2161
2162 $self->add_item ({ type => "button", text => $text, activate => $cb});
2163}
2164
2165=item $popup->add_toggle ($text, $initial_value, $cb)
2166
2167Adds a toggle/checkbox item to the popup. The callback gets called
2168whenever it gets toggled, with a boolean indicating its new value as its
2169first argument.
2170
2171=cut
2172
2173sub add_toggle {
2174 my ($self, $text, $value, $cb) = @_;
2175
2176 my $item; $item = {
2177 type => "button",
2178 text => " $text",
2179 value => $value,
2180 render => sub { ($_[0]{value} ? "* " : " ") . $text },
2181 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
2182 };
2183
2184 $self->add_item ($item);
2185}
2186
2187=item $popup->show
2188
2189Displays the popup (which is initially hidden).
2190
2191=cut
2192
2193sub show {
2194 my ($self) = @_;
2195
2196 local $urxvt::popup::self = $self;
2197
2198 my $env = $self->{term}->env;
2199 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
2200 delete $env->{LC_ALL};
2201 $env->{LC_CTYPE} = $self->{term}->locale;
2202
2203 my $term = urxvt::term->new (
2204 $env, "popup",
2205 "--perl-lib" => "", "--perl-ext-common" => "",
2206 "-pty-fd" => -1, "-sl" => 0,
2207 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
2208 "--transient-for" => $self->{term}->parent,
2209 "-display" => $self->{term}->display_id,
2210 "-pe" => "urxvt-popup",
2211 ) or die "unable to create popup window\n";
2212
2213 unless (delete $term->{urxvt_popup_init_done}) {
2214 $term->ungrab;
2215 $term->destroy;
2216 die "unable to initialise popup window\n";
2217 }
2218}
2219
2220sub DESTROY {
2221 my ($self) = @_;
2222
2223 delete $self->{term}{_destroy}{$self};
2224 $self->{term}->ungrab;
2225}
2226
2227=back
2228
2229=cut
2230
2231package urxvt::watcher;
339 2232
340=head2 The C<urxvt::timer> Class 2233=head2 The C<urxvt::timer> Class
341 2234
342This class implements timer watchers/events. Time is represented as a 2235This class implements timer watchers/events. Time is represented as a
343fractional number of seconds since the epoch. Example: 2236fractional number of seconds since the epoch. Example:
344 2237
345 # create a digital clock display in upper right corner 2238 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
346 $term->{timer} = urxvt::timer 2239 $term->{timer} = urxvt::timer
347 ->new 2240 ->new
348 ->start (urxvt::NOW) 2241 ->interval (1)
349 ->cb (sub { 2242 ->cb (sub {
350 my ($timer) = @_;
351 my $time = $timer->at;
352 $timer->start ($time + 1);
353 $self->scr_overlay (-1, 0, 2243 $term->{overlay}->set (0, 0,
354 POSIX::strftime "%H:%M:%S", localtime $time); 2244 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
355 }); 2245 });
356 2246
357=over 4 2247=over 4
358 2248
359=item $timer = new urxvt::timer 2249=item $timer = new urxvt::timer
360 2250
361Create a new timer object in stopped state. 2251Create a new timer object in started state. It is scheduled to fire
2252immediately.
362 2253
363=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2254=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
364 2255
365Set the callback to be called when the timer triggers. 2256Set the callback to be called when the timer triggers.
366 2257
367=item $tstamp = $timer->at
368
369Return the time this watcher will fire next.
370
371=item $timer = $timer->set ($tstamp) 2258=item $timer = $timer->set ($tstamp[, $interval])
372 2259
373Set the time the event is generated to $tstamp. 2260Set the time the event is generated to $tstamp (and optionally specifies a
2261new $interval).
2262
2263=item $timer = $timer->interval ($interval)
2264
2265By default (and when C<$interval> is C<0>), the timer will automatically
2266stop after it has fired once. If C<$interval> is non-zero, then the timer
2267is automatically rescheduled at the given intervals.
374 2268
375=item $timer = $timer->start 2269=item $timer = $timer->start
376 2270
377Start the timer. 2271Start the timer.
378 2272
379=item $timer = $timer->start ($tstamp) 2273=item $timer = $timer->start ($tstamp[, $interval])
380 2274
381Set the event trigger time to C<$tstamp> and start the timer. 2275Set the event trigger time to C<$tstamp> and start the timer. Optionally
2276also replaces the interval.
2277
2278=item $timer = $timer->after ($delay[, $interval])
2279
2280Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
382 2281
383=item $timer = $timer->stop 2282=item $timer = $timer->stop
384 2283
385Stop the timer. 2284Stop the timer.
386 2285
392 2291
393 $term->{socket} = ... 2292 $term->{socket} = ...
394 $term->{iow} = urxvt::iow 2293 $term->{iow} = urxvt::iow
395 ->new 2294 ->new
396 ->fd (fileno $term->{socket}) 2295 ->fd (fileno $term->{socket})
397 ->events (1) # wait for read data 2296 ->events (urxvt::EV_READ)
398 ->start 2297 ->start
399 ->cb (sub { 2298 ->cb (sub {
400 my ($iow, $revents) = @_; 2299 my ($iow, $revents) = @_;
401 # $revents must be 1 here, no need to check 2300 # $revents must be 1 here, no need to check
402 sysread $term->{socket}, my $buf, 8192 2301 sysread $term->{socket}, my $buf, 8192
415Set the callback to be called when io events are triggered. C<$reventmask> 2314Set the callback to be called when io events are triggered. C<$reventmask>
416is a bitset as described in the C<events> method. 2315is a bitset as described in the C<events> method.
417 2316
418=item $iow = $iow->fd ($fd) 2317=item $iow = $iow->fd ($fd)
419 2318
420Set the filedescriptor (not handle) to watch. 2319Set the file descriptor (not handle) to watch.
421 2320
422=item $iow = $iow->events ($eventmask) 2321=item $iow = $iow->events ($eventmask)
423 2322
424Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 2323Set the event mask to watch. The only allowed values are
425data, Bit #1 (value C<2>) enables watching for write data. 2324C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2325together, or C<urxvt::EV_NONE>.
426 2326
427=item $iow = $iow->start 2327=item $iow = $iow->start
428 2328
429Start watching for requested events on the given handle. 2329Start watching for requested events on the given handle.
430 2330
431=item $iow = $iow->stop 2331=item $iow = $iow->stop
432 2332
433Stop watching for events on the given filehandle. 2333Stop watching for events on the given file handle.
2334
2335=back
2336
2337=head2 The C<urxvt::iw> Class
2338
2339This class implements idle watchers, that get called automatically when
2340the process is idle. They should return as fast as possible, after doing
2341some useful work.
2342
2343=over 4
2344
2345=item $iw = new urxvt::iw
2346
2347Create a new idle watcher object in stopped state.
2348
2349=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2350
2351Set the callback to be called when the watcher triggers.
2352
2353=item $timer = $timer->start
2354
2355Start the watcher.
2356
2357=item $timer = $timer->stop
2358
2359Stop the watcher.
2360
2361=back
2362
2363=head2 The C<urxvt::pw> Class
2364
2365This class implements process watchers. They create an event whenever a
2366process exits, after which they stop automatically.
2367
2368 my $pid = fork;
2369 ...
2370 $term->{pw} = urxvt::pw
2371 ->new
2372 ->start ($pid)
2373 ->cb (sub {
2374 my ($pw, $exit_status) = @_;
2375 ...
2376 });
2377
2378=over 4
2379
2380=item $pw = new urxvt::pw
2381
2382Create a new process watcher in stopped state.
2383
2384=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2385
2386Set the callback to be called when the timer triggers.
2387
2388=item $pw = $timer->start ($pid)
2389
2390Tells the watcher to start watching for process C<$pid>.
2391
2392=item $pw = $pw->stop
2393
2394Stop the watcher.
434 2395
435=back 2396=back
436 2397
437=head1 ENVIRONMENT 2398=head1 ENVIRONMENT
438 2399
441This variable controls the verbosity level of the perl extension. Higher 2402This variable controls the verbosity level of the perl extension. Higher
442numbers indicate more verbose output. 2403numbers indicate more verbose output.
443 2404
444=over 4 2405=over 4
445 2406
446=item 0 - only fatal messages 2407=item == 0 - fatal messages
447 2408
448=item 3 - script loading and management 2409=item >= 3 - script loading and management
449 2410
450=item 10 - all events received 2411=item >=10 - all called hooks
2412
2413=item >=11 - hook return values
451 2414
452=back 2415=back
453 2416
454=head1 AUTHOR 2417=head1 AUTHOR
455 2418
456 Marc Lehmann <pcg@goof.com> 2419 Marc Lehmann <schmorp@schmorp.de>
457 http://software.schmorp.de/pkg/rxvt-unicode 2420 http://software.schmorp.de/pkg/rxvt-unicode
458 2421
459=cut 2422=cut
460 2423
4611 24241
2425
2426# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines