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.8 by root, Mon Jan 2 20:35:39 2006 UTC vs.
Revision 1.209 by root, Tue Jun 5 22:38:17 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* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
10thus must be encoded as UTF-8.
11 10
12 sub on_sel_grab { 11 sub on_sel_grab {
13 warn "you selected ", $_[0]->selection; 12 warn "you selected ", $_[0]->selection;
14 () 13 ()
15 } 14 }
16 15
17 1 16 # start a @@RXVT_NAME@@ using it:
17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
18 19
19=head1 DESCRIPTION 20=head1 DESCRIPTION
20 21
21Everytime a terminal object gets created, scripts specified via the 22Every time a terminal object gets created, extension scripts specified via
22C<perl> resource are associated with it. 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.
23 27
24Each 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
25scripts will be shared (But not enabled) for all terminals. 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
26 416
27=head2 General API Considerations 417=head2 General API Considerations
28 418
29All objects (such as terminals, time watchers etc.) are typical 419All objects (such as terminals, time watchers etc.) are typical
30reference-to-hash objects. The hash can be used to store anything you 420reference-to-hash objects. The hash can be used to store anything you
31like. All members starting with an underscore (such as C<_ptr> or 421like. All members starting with an underscore (such as C<_ptr> or
32C<_hook>) are reserved for internal uses and must not be accessed or 422C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
33modified). 423modified).
34 424
35When objects are destroyed on the C++ side, the perl object hashes are 425When objects are destroyed on the C++ side, the perl object hashes are
36emptied, so its best to store related objects such as time watchers and 426emptied, so its best to store related objects such as time watchers and
37the like inside the terminal object so they get destroyed as soon as the 427the like inside the terminal object so they get destroyed as soon as the
38terminal is destroyed. 428terminal is destroyed.
39 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
40=head2 Hooks 493=head2 Hooks
41 494
42The following subroutines can be declared in loaded scripts, and will be called 495The following subroutines can be declared in extension files, and will be
43whenever the relevant event happens. 496called whenever the relevant event happens.
44 497
45All 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
46counts 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
47and the relevant action might not be carried out by the C++ code. 503relevant action might not be carried out by the C++ code.
48 504
49When in doubt, return a false value (preferably C<()>). 505I<< When in doubt, return a false value (preferably C<()>). >>
50 506
51=over 4 507=over 4
52 508
53=item on_init $term 509=item on_init $term
54 510
55Called after a new terminal object has been initialized, but before 511Called after a new terminal object has been initialized, but before
56windows 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).
57 527
58=item on_reset $term 528=item on_reset $term
59 529
60Called 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
61control 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
62variables. 532variables.
63 533
64=item on_start $term 534=item on_child_start $term, $pid
65 535
66Called at the very end of initialisation of a new terminal, just before 536Called just after the child process has been C<fork>ed.
67returning 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>.
68 542
69=item on_sel_make $term, $eventtime 543=item on_sel_make $term, $eventtime
70 544
71Called 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
72selection 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
79 553
80Called whenever a selection has been copied, but before the selection is 554Called whenever a selection has been copied, but before the selection is
81requested from the server. The selection text can be queried and changed 555requested from the server. The selection text can be queried and changed
82by calling C<< $term->selection >>. 556by calling C<< $term->selection >>.
83 557
84Returning a true value aborts selection grabbing. It will still be hilighted. 558Returning a true value aborts selection grabbing. It will still be highlighted.
85 559
86=item on_focus_in $term 560=item on_sel_extend $term
87 561
88Called whenever the window gets the keyboard focus, before urxvt does 562Called whenever the user tries to extend the selection (e.g. with a double
89focus 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.
90 568
91=item on_focus_out $term 569See the F<selection> example extension.
92
93Called wheneever the window loses keyboard focus, before urxvt does focus
94out processing.
95 570
96=item on_view_change $term, $offset 571=item on_view_change $term, $offset
97 572
98Called whenever the view offset changes, i..e the user or program 573Called whenever the view offset changes, i.e. the user or program
99scrolls. Offset C<0> means display the normal terminal, positive values 574scrolls. Offset C<0> means display the normal terminal, positive values
100show this many lines of scrollback. 575show this many lines of scrollback.
101 576
102=item on_scroll_back $term, $lines, $saved 577=item on_scroll_back $term, $lines, $saved
103 578
107 582
108It 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,
109$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
110number of lines that will be in the scrollback buffer. 585number of lines that will be in the scrollback buffer.
111 586
112=item on_tty_activity $term *NYI* 587=item on_osc_seq $term, $op, $args, $resp
113 588
114Called 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.
115 656
116=item on_refresh_begin $term 657=item on_refresh_begin $term
117 658
118Called just before the screen gets redrawn. Can be used for overlay 659Called just before the screen gets redrawn. Can be used for overlay or
119or similar effects by modify terminal contents in refresh_begin, and 660similar effects by modifying the terminal contents in refresh_begin, and
120restoring them in refresh_end. The built-in overlay and selection display 661restoring them in refresh_end. The built-in overlay and selection display
121code is run after this hook, and takes precedence. 662code is run after this hook, and takes precedence.
122 663
123=item on_refresh_end $term 664=item on_refresh_end $term
124 665
125Called just after the screen gets redrawn. See C<on_refresh_begin>. 666Called just after the screen gets redrawn. See C<on_refresh_begin>.
126 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
127=back 753=back
128 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;
768our @TERM_EXT;
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
129=head2 Functions in the C<urxvt> Package 820=head2 Functions in the C<urxvt> Package
130 821
131=over 4 822=over 4
132 823
133=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
134 825
135Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
136costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
137starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
138 830
139=item urxvt::warn $string 831=item urxvt::warn $string
140 832
141Calls C<rxvt_warn> with the given string which should not include a 833Calls C<rxvt_warn> with the given string which should include a trailing
142newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
143that calls this function. 835that calls this function.
144 836
145Using 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
146correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
147 839
840Messages have a size limit of 1023 bytes currently.
841
842=item @terms = urxvt::termlist
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).
848
148=item $time = urxvt::NOW 849=item $time = urxvt::NOW
149 850
150Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
151 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
152=cut 934=cut
153 935
154package urxvt;
155
156use strict;
157
158our $term;
159our @HOOKNAME;
160our $LIBDIR;
161
162BEGIN { 936BEGIN {
163 urxvt->bootstrap;
164
165 # overwrite perl's warn 937 # overwrite perl's warn
166 *CORE::GLOBAL::warn = sub { 938 *CORE::GLOBAL::warn = sub {
167 my $msg = join "", @_; 939 my $msg = join "", @_;
168 $msg .= "\n" 940 $msg .= "\n"
169 unless $msg =~ /\n$/; 941 unless $msg =~ /\n$/;
170 urxvt::warn ($msg); 942 urxvt::warn ($msg);
171 }; 943 };
172} 944}
173 945
174my @hook_count; 946no warnings 'utf8';
947
948sub resource {
949 my ($term, $name, $isarg, $flag, $value) = @_;
950
951 $term->scan_meta;
952
953 warn "resourece<@_>\n";#d#
954
955 0
956}
957
958sub usage {
959 my ($term, $usage_type) = @_;
960
961 $term->scan_meta;
962
963 my $r = $term->{meta}{resource};
964
965 for my $regex (sort keys %$r) {
966 my ($ext, $type, $desc) = @{ $r->{$regex} };
967
968 $desc .= " (-pe $ext)";
969
970 if ($usage_type == 1) {
971 if ($type eq "boolean") {
972 urxvt::log sprintf " -%-20.20s %s\n", "/+$regex", $desc;
973 } else {
974 urxvt::log sprintf " -%-20.20s %s\n", "$regex $type", $desc;
975 }
976 } else {
977 urxvt::log sprintf " %-19.19s %s\n", "$regex:", $type;
978 }
979 }
980}
981
175my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 982my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
176 983
177sub verbose { 984sub verbose {
178 my ($level, $msg) = @_; 985 my ($level, $msg) = @_;
179 warn "$msg\n" if $level <= $verbosity; 986 warn "$msg\n" if $level <= $verbosity;
180} 987}
181 988
182# find on_xxx subs in the package and register them 989my %extension_pkg;
183# as hooks
184sub register_package($) {
185 my ($pkg) = @_;
186
187 for my $htype (0.. $#HOOKNAME) {
188 my $name = $HOOKNAME[$htype];
189
190 my $ref = $pkg->can ("on_" . lc $name)
191 or next;
192
193 $term->{_hook}[$htype]{$ref*1} = $ref;
194 $hook_count[$htype]++
195 or set_should_invoke $htype, 1;
196 }
197}
198
199my $script_pkg = "script0000";
200my %script_pkg;
201 990
202# load a single script into its own package, once only 991# load a single script into its own package, once only
203sub script_package($) { 992sub extension_package($) {
204 my ($path) = @_; 993 my ($path) = @_;
205 994
206 $script_pkg{$path} ||= do { 995 $extension_pkg{$path} ||= do {
207 my $pkg = "urxvt::" . ($script_pkg++); 996 $path =~ /([^\/\\]+)$/;
997 my $pkg = $1;
998 $pkg =~ s/[^[:word:]]/_/g;
999 $pkg = "urxvt::ext::$pkg";
208 1000
209 verbose 3, "loading script '$path' into package '$pkg'"; 1001 verbose 3, "loading extension '$path' into package '$pkg'";
210 1002
211 open my $fh, "<:raw", $path 1003 open my $fh, "<:raw", $path
212 or die "$path: $!"; 1004 or die "$path: $!";
213 1005
214 my $source = "package $pkg; use strict; use utf8;\n" 1006 my $source =
1007 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
215 . "#line 1 \"$path\"\n{\n" 1008 . "#line 1 \"$path\"\n{\n"
216 . (do { local $/; <$fh> }) 1009 . (do { local $/; <$fh> })
217 . "\n};\n1"; 1010 . "\n};\n1";
218 1011
1012 eval $source
219 eval $source or die "$path: $@"; 1013 or die "$path: $@";
220 1014
221 $pkg 1015 $pkg
222 } 1016 }
223} 1017}
224 1018
1019our $retval; # return value for urxvt
1020
225# called by the rxvt core 1021# called by the rxvt core
226sub invoke { 1022sub invoke {
227 local $term = shift; 1023 local $TERM = shift;
228 my $htype = shift; 1024 my $htype = shift;
229 1025
230 if ($htype == 0) { # INIT 1026 if ($htype == 0) { # INIT
231 my @dirs = ((split /:/, $term->resource ("perl_lib")), $LIBDIR); 1027 my @dirs = $TERM->perl_libdirs;
232 1028
233 for my $ext (split /:/, $term->resource ("perl_ext")) { 1029 my %ext_arg;
1030
1031 {
1032 my @init = @TERM_INIT;
1033 @TERM_INIT = ();
1034 $_->($TERM) for @init;
1035 my @pkg = @TERM_EXT;
1036 @TERM_EXT = ();
1037 $TERM->register_package ($_) for @pkg;
1038 }
1039
1040 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
1041 if ($_ eq "default") {
1042 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
1043 } elsif (/^-(.*)$/) {
1044 delete $ext_arg{$1};
1045 } elsif (/^([^<]+)<(.*)>$/) {
1046 push @{ $ext_arg{$1} }, $2;
1047 } else {
1048 $ext_arg{$_} ||= [];
1049 }
1050 }
1051
1052 for my $ext (sort keys %ext_arg) {
234 my @files = grep -f $_, map "$_/$ext", @dirs; 1053 my @files = grep -f $_, map "$_/$ext", @dirs;
235 1054
236 if (@files) { 1055 if (@files) {
237 register_package script_package $files[0]; 1056 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
238 } else { 1057 } else {
239 warn "perl extension '$ext' not found in perl library search path\n"; 1058 warn "perl extension '$ext' not found in perl library search path\n";
240 } 1059 }
241 } 1060 }
242 1061
1062 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
1063 warn $@ if $@;
1064 }
1065
1066 $retval = undef;
1067
1068 if (my $cb = $TERM->{_hook}[$htype]) {
1069 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1070 if $verbosity >= 10;
1071
1072 for my $pkg (keys %$cb) {
1073 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
1074 $retval ||= $retval_;
1075
1076 if ($@) {
1077 $TERM->ungrab; # better to lose the grab than the session
1078 warn $@;
1079 }
1080 }
1081
1082 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1083 if $verbosity >= 11;
1084 }
1085
243 } elsif ($htype == 1) { # DESTROY 1086 if ($htype == 1) { # DESTROY
244 if (my $hook = $term->{_hook}) { 1087 # clear package objects
245 for my $htype (0..$#$hook) { 1088 %$_ = () for values %{ $TERM->{_pkg} };
246 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 1089
247 or set_should_invoke $htype, 0; 1090 # clear package
1091 %$TERM = ();
1092 }
1093
1094 $retval
1095}
1096
1097sub SET_COLOR($$$) {
1098 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1099}
1100
1101sub rend2mask {
1102 no strict 'refs';
1103 my ($str, $mask) = (@_, 0);
1104 my %color = ( fg => undef, bg => undef );
1105 my @failed;
1106 for my $spec ( split /\s+/, $str ) {
1107 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1108 $color{lc($1)} = $2;
1109 } else {
1110 my $neg = $spec =~ s/^[-^]//;
1111 unless ( exists &{"RS_$spec"} ) {
1112 push @failed, $spec;
1113 next;
1114 }
1115 my $cur = &{"RS_$spec"};
1116 if ( $neg ) {
1117 $mask &= ~$cur;
1118 } else {
1119 $mask |= $cur;
248 } 1120 }
249 } 1121 }
250 } 1122 }
1123 ($mask, @color{qw(fg bg)}, \@failed)
1124}
251 1125
252 my $cb = $term->{_hook}[$htype] 1126# urxvt::term::extension
253 or return;
254 1127
255 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" 1128package urxvt::term::extension;
256 if $verbosity >= 10;
257 1129
1130sub enable {
1131 my ($self, %hook) = @_;
1132 my $pkg = $self->{_pkg};
1133
258 while (my ($k, $v) = each %$cb) { 1134 while (my ($name, $cb) = each %hook) {
259 return 1 if $v->($term, @_); 1135 my $htype = $HOOKTYPE{uc $name};
1136 defined $htype
1137 or Carp::croak "unsupported hook type '$name'";
1138
1139 $self->set_should_invoke ($htype, +1)
1140 unless exists $self->{term}{_hook}[$htype]{$pkg};
1141
1142 $self->{term}{_hook}[$htype]{$pkg} = $cb;
260 } 1143 }
1144}
261 1145
1146sub disable {
1147 my ($self, @hook) = @_;
1148 my $pkg = $self->{_pkg};
1149
1150 for my $name (@hook) {
1151 my $htype = $HOOKTYPE{uc $name};
1152 defined $htype
1153 or Carp::croak "unsupported hook type '$name'";
1154
1155 $self->set_should_invoke ($htype, -1)
1156 if delete $self->{term}{_hook}[$htype]{$pkg};
262 0 1157 }
263} 1158}
264 1159
265=back 1160our $AUTOLOAD;
1161
1162sub AUTOLOAD {
1163 $AUTOLOAD =~ /:([^:]+)$/
1164 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
1165
1166 eval qq{
1167 sub $AUTOLOAD {
1168 my \$proxy = shift;
1169 \$proxy->{term}->$1 (\@_)
1170 }
1171 1
1172 } or die "FATAL: unable to compile method forwarder: $@";
1173
1174 goto &$AUTOLOAD;
1175}
1176
1177sub DESTROY {
1178 # nop
1179}
1180
1181# urxvt::destroy_hook
1182
1183sub urxvt::destroy_hook::DESTROY {
1184 ${$_[0]}->();
1185}
1186
1187sub urxvt::destroy_hook(&) {
1188 bless \shift, urxvt::destroy_hook::
1189}
1190
1191package urxvt::anyevent;
1192
1193=head2 The C<urxvt::anyevent> Class
1194
1195The sole purpose of this class is to deliver an interface to the
1196C<AnyEvent> module - any module using it will work inside urxvt without
1197further programming. The only exception is that you cannot wait on
1198condition variables, but non-blocking condvar use is ok.
1199
1200In practical terms this means is that you cannot use blocking APIs, but
1201the non-blocking variant should work.
1202
1203=cut
1204
1205our $VERSION = '5.23';
1206
1207$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1208push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1209
1210sub timer {
1211 my ($class, %arg) = @_;
1212
1213 my $cb = $arg{cb};
1214
1215 urxvt::timer
1216 ->new
1217 ->after ($arg{after}, $arg{interval})
1218 ->cb ($arg{interval} ? $cb : sub {
1219 $_[0]->stop; # need to cancel manually
1220 $cb->();
1221 })
1222}
1223
1224sub io {
1225 my ($class, %arg) = @_;
1226
1227 my $cb = $arg{cb};
1228 my $fd = fileno $arg{fh};
1229 defined $fd or $fd = $arg{fh};
1230
1231 bless [$arg{fh}, urxvt::iow
1232 ->new
1233 ->fd ($fd)
1234 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1235 | ($arg{poll} =~ /w/ ? 2 : 0))
1236 ->start
1237 ->cb ($cb)
1238 ], urxvt::anyevent::
1239}
1240
1241sub idle {
1242 my ($class, %arg) = @_;
1243
1244 my $cb = $arg{cb};
1245
1246 urxvt::iw
1247 ->new
1248 ->start
1249 ->cb ($cb)
1250}
1251
1252sub child {
1253 my ($class, %arg) = @_;
1254
1255 my $cb = $arg{cb};
1256
1257 urxvt::pw
1258 ->new
1259 ->start ($arg{pid})
1260 ->cb (sub {
1261 $_[0]->stop; # need to cancel manually
1262 $cb->($_[0]->rpid, $_[0]->rstatus);
1263 })
1264}
1265
1266sub DESTROY {
1267 $_[0][1]->stop;
1268}
1269
1270# only needed for AnyEvent < 6 compatibility
1271sub one_event {
1272 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1273}
1274
1275package urxvt::term;
266 1276
267=head2 The C<urxvt::term> Class 1277=head2 The C<urxvt::term> Class
268 1278
269=over 4 1279=over 4
1280
1281=cut
1282
1283# find on_xxx subs in the package and register them
1284# as hooks
1285sub register_package {
1286 my ($self, $pkg, $argv) = @_;
1287
1288 no strict 'refs';
1289
1290 urxvt::verbose 6, "register package $pkg to $self";
1291
1292 @{"$pkg\::ISA"} = urxvt::term::extension::;
1293
1294 my $proxy = bless {
1295 _pkg => $pkg,
1296 argv => $argv,
1297 }, $pkg;
1298 Scalar::Util::weaken ($proxy->{term} = $self);
1299
1300 $self->{_pkg}{$pkg} = $proxy;
1301
1302 for my $name (@HOOKNAME) {
1303 if (my $ref = $pkg->can ("on_" . lc $name)) {
1304 $proxy->enable ($name => $ref);
1305 }
1306 }
1307}
1308
1309sub perl_libdirs {
1310 map { split /:/ }
1311 $_[0]->resource ("perl_lib"),
1312 $ENV{URXVT_PERL_LIB},
1313 "$ENV{HOME}/.urxvt/ext",
1314 "$LIBDIR/perl"
1315}
1316
1317sub scan_meta {
1318 my ($self) = @_;
1319 my @libdirs = perl_libdirs $self;
1320
1321 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1322
1323 my %meta;
1324
1325 $self->{meta_libdirs} = join "\x00", @libdirs;
1326 $self->{meta} = \%meta;
1327
1328 for my $dir (reverse @libdirs) {
1329 opendir my $fh, $dir
1330 or next;
1331 for my $ext (readdir $fh) {
1332 $ext ne "."
1333 and $ext ne ".."
1334 and open my $fh, "<", "$dir/$ext"
1335 or next;
1336
1337 while (<$fh>) {
1338 if (/^#:META:RESOURCE:(.*)/) {
1339 my ($regex, $type, $desc) = split /:/, $1;
1340 $regex =~ s/\$\$/$ext/g; # $$ in regex == extension name
1341 $meta{resource}{$regex} = [$ext, $type, $desc];
1342 } elsif (/^\s*(?:#|$)/) {
1343 # skip other comments and empty lines
1344 } else {
1345 last; # stop parsing on first non-empty non-comment line
1346 }
1347 }
1348 }
1349 }
1350}
1351
1352=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1353
1354Creates a new terminal, very similar as if you had started it with system
1355C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1356hash which defines the environment of the new terminal.
1357
1358Croaks (and probably outputs an error message) if the new instance
1359couldn't be created. Returns C<undef> if the new instance didn't
1360initialise perl, and the terminal object otherwise. The C<init> and
1361C<start> hooks will be called before this call returns, and are free to
1362refer to global data (which is race free).
1363
1364=cut
1365
1366sub new {
1367 my ($class, $env, @args) = @_;
1368
1369 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1370 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1371
1372 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1373}
1374
1375=item $term->destroy
1376
1377Destroy the terminal object (close the window, free resources
1378etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
1379watchers (timers, io watchers) are still active.
1380
1381=item $term->exec_async ($cmd[, @args])
1382
1383Works like the combination of the C<fork>/C<exec> builtins, which executes
1384("starts") programs in the background. This function takes care of setting
1385the user environment before exec'ing the command (e.g. C<PATH>) and should
1386be preferred over explicit calls to C<exec> or C<system>.
1387
1388Returns the pid of the subprocess or C<undef> on error.
1389
1390=cut
1391
1392sub exec_async {
1393 my $self = shift;
1394
1395 my $pid = fork;
1396
1397 return $pid
1398 if !defined $pid or $pid;
1399
1400 %ENV = %{ $self->env };
1401
1402 exec @_;
1403 urxvt::_exit 255;
1404}
1405
1406=item $isset = $term->option ($optval[, $set])
1407
1408Returns true if the option specified by C<$optval> is enabled, and
1409optionally change it. All option values are stored by name in the hash
1410C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1411
1412Here is a likely non-exhaustive list of option names, please see the
1413source file F</src/optinc.h> to see the actual list:
1414
1415 borderLess buffered console cursorBlink cursorUnderline hold iconic
1416 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1417 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1418 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1419 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1420 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1421 urgentOnBell utmpInhibit visualBell
270 1422
271=item $value = $term->resource ($name[, $newval]) 1423=item $value = $term->resource ($name[, $newval])
272 1424
273Returns the current resource value associated with a given name and 1425Returns the current resource value associated with a given name and
274optionally sets a new value. Setting values is most useful in the C<init> 1426optionally sets a new value. Setting values is most useful in the C<init>
283likely change). 1435likely change).
284 1436
285Please note that resource strings will currently only be freed when the 1437Please note that resource strings will currently only be freed when the
286terminal is destroyed, so changing options frequently will eat memory. 1438terminal is destroyed, so changing options frequently will eat memory.
287 1439
288Here is a a likely non-exhaustive list of resource names, not all of which 1440Here is a likely non-exhaustive list of resource names, not all of which
289are supported in every build, please see the source to see the actual 1441are supported in every build, please see the source file F</src/rsinc.h>
290list: 1442to see the actual list:
291 1443
292 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1444 answerbackstring backgroundPixmap backspace_key blendtype blurradius
293 borderLess color cursorBlink cursorUnderline cutchars delete_key 1445 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
294 display_name embed ext_bwidth fade font geometry hold iconName 1446 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
295 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1447 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1448 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
296 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1449 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
297 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 1450 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
298 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1451 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
299 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1452 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
300 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1453 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
301 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1454 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
302 shade term_name title transparent transparent_all tripleclickwords 1455 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1456 term_name title transient_for transparent tripleclickwords urgentOnBell
303 utmpInhibit visualBell 1457 utmpInhibit visualBell
304 1458
305=cut 1459=cut
306 1460
307sub urxvt::term::resource($$;$) { 1461sub resource($$;$) {
308 my ($self, $name) = (shift, shift); 1462 my ($self, $name) = (shift, shift);
309 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1463 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
310 goto &urxvt::term::_resource; 1464 goto &urxvt::term::_resource
311} 1465}
1466
1467=item $value = $term->x_resource ($pattern)
1468
1469Returns the X-Resource for the given pattern, excluding the program or
1470class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1471same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1472resource with that pattern exists.
1473
1474This method should only be called during the C<on_start> hook, as there is
1475only one resource database per display, and later invocations might return
1476the wrong resources.
1477
1478=item $success = $term->parse_keysym ($key, $octets)
1479
1480Adds a key binding exactly as specified via a resource. See the
1481C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1482
1483=item $term->register_command ($keysym, $modifiermask, $string)
1484
1485Adds a key binding. This is a lower level api compared to
1486C<parse_keysym>, as it expects a parsed key description, and can be
1487used only inside either the C<on_init> hook, to add a binding, or the
1488C<on_register_command> hook, to modify a parsed binding.
1489
1490=item $rend = $term->rstyle ([$new_rstyle])
1491
1492Return and optionally change the current rendition. Text that is output by
1493the terminal application will use this style.
1494
1495=item ($row, $col) = $term->screen_cur ([$row, $col])
1496
1497Return the current coordinates of the text cursor position and optionally
1498set it (which is usually bad as applications don't expect that).
312 1499
313=item ($row, $col) = $term->selection_mark ([$row, $col]) 1500=item ($row, $col) = $term->selection_mark ([$row, $col])
314 1501
315=item ($row, $col) = $term->selection_beg ([$row, $col]) 1502=item ($row, $col) = $term->selection_beg ([$row, $col])
316 1503
317=item ($row, $col) = $term->selection_end ([$row, $col]) 1504=item ($row, $col) = $term->selection_end ([$row, $col])
318 1505
319Return the current values of the selection mark, begin or end positions, 1506Return the current values of the selection mark, begin or end positions.
320and optionally set them to new values.
321 1507
1508When arguments are given, then the selection coordinates are set to
1509C<$row> and C<$col>, and the selection screen is set to the current
1510screen.
1511
1512=item $screen = $term->selection_screen ([$screen])
1513
1514Returns the current selection screen, and then optionally sets it.
1515
1516=item $term->selection_make ($eventtime[, $rectangular])
1517
1518Tries to make a selection as set by C<selection_beg> and
1519C<selection_end>. If C<$rectangular> is true (default: false), a
1520rectangular selection will be made. This is the preferred function to make
1521a selection.
1522
322=item $success = $term->selection_grab ($eventtime) 1523=item $success = $term->selection_grab ($eventtime[, $clipboard])
323 1524
324Try to request the primary selection from the server (for example, as set 1525Try to acquire ownership of the primary (clipboard if C<$clipboard> is
325by the next method). 1526true) selection from the server. The corresponding text can be set
1527with the next method. No visual feedback will be given. This function
1528is mostly useful from within C<on_sel_grab> hooks.
326 1529
327=item $oldtext = $term->selection ([$newtext]) 1530=item $oldtext = $term->selection ([$newtext, $clipboard])
328 1531
329Return the current selection text and optionally replace it by C<$newtext>. 1532Return the current selection (clipboard if C<$clipboard> is true) text
1533and optionally replace it by C<$newtext>.
330 1534
1535=item $term->selection_clear ([$clipboard])
1536
1537Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1538
331=item $term->scr_overlay ($x, $y, $text) 1539=item $term->overlay_simple ($x, $y, $text)
332 1540
333Create a simple multi-line overlay box. See the next method for details. 1541Create a simple multi-line overlay box. See the next method for details.
334 1542
335=cut 1543=cut
336 1544
337sub urxvt::term::scr_overlay { 1545sub overlay_simple {
338 my ($self, $x, $y, $text) = @_; 1546 my ($self, $x, $y, $text) = @_;
339 1547
340 my @lines = split /\n/, $text; 1548 my @lines = split /\n/, $text;
341 1549
342 my $w = 0; 1550 my $w = List::Util::max map $self->strwidth ($_), @lines;
343 for (map $self->strwidth ($_), @lines) {
344 $w = $_ if $w < $_;
345 }
346 1551
347 $self->scr_overlay_new ($x, $y, $w, scalar @lines); 1552 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
348 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 1553 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
349}
350 1554
1555 $overlay
1556}
1557
351=item $term->scr_overlay_new ($x, $y, $width, $height) 1558=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
352 1559
353Create a new (empty) overlay at the given position with the given 1560Create a new (empty) overlay at the given position with the given
354width/height. A border will be put around the box. If either C<$x> or 1561width/height. C<$rstyle> defines the initial rendition style
355C<$y> is negative, then this is counted from the right/bottom side, 1562(default: C<OVERLAY_RSTYLE>).
356respectively.
357 1563
358=item $term->scr_overlay_off 1564If C<$border> is C<2> (default), then a decorative border will be put
1565around the box.
359 1566
360Switch the overlay off again. 1567If either C<$x> or C<$y> is negative, then this is counted from the
1568right/bottom side, respectively.
361 1569
362=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) 1570This method returns an urxvt::overlay object. The overlay will be visible
1571as long as the perl object is referenced.
363 1572
364Put a single character (specified numerically) at the given overlay 1573The methods currently supported on C<urxvt::overlay> objects are:
365position.
366 1574
1575=over 4
1576
367=item $term->scr_overlay_set ($x, $y, $text) 1577=item $overlay->set ($x, $y, $text[, $rend])
368 1578
369Write a string at the given position into the overlay. 1579Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1580text in rxvt-unicode's special encoding and an array of rendition values
1581at a specific position inside the overlay.
370 1582
1583If C<$rend> is missing, then the rendition will not be changed.
1584
1585=item $overlay->hide
1586
1587If visible, hide the overlay, but do not destroy it.
1588
1589=item $overlay->show
1590
1591If hidden, display the overlay again.
1592
1593=back
1594
1595=item $popup = $term->popup ($event)
1596
1597Creates a new C<urxvt::popup> object that implements a popup menu. The
1598C<$event> I<must> be the event causing the menu to pop up (a button event,
1599currently).
1600
1601=cut
1602
1603sub popup {
1604 my ($self, $event) = @_;
1605
1606 $self->grab ($event->{time}, 1)
1607 or return;
1608
1609 my $popup = bless {
1610 term => $self,
1611 event => $event,
1612 }, urxvt::popup::;
1613
1614 Scalar::Util::weaken $popup->{term};
1615
1616 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
1617 Scalar::Util::weaken $self->{_destroy}{$popup};
1618
1619 $popup
1620}
1621
371=item $cellwidth = $term->strwidth $string 1622=item $cellwidth = $term->strwidth ($string)
372 1623
373Returns the number of screen-cells this string would need. Correctly 1624Returns the number of screen-cells this string would need. Correctly
374accounts for wide and combining characters. 1625accounts for wide and combining characters.
375 1626
376=item $octets = $term->locale_encode $string 1627=item $octets = $term->locale_encode ($string)
377 1628
378Convert the given text string into the corresponding locale encoding. 1629Convert the given text string into the corresponding locale encoding.
379 1630
380=item $string = $term->locale_decode $octets 1631=item $string = $term->locale_decode ($octets)
381 1632
382Convert the given locale-encoded octets into a perl string. 1633Convert the given locale-encoded octets into a perl string.
383 1634
1635=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1636
1637XORs the rendition values in the given span with the provided value
1638(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1639refresh hooks to provide effects similar to the selection.
1640
1641=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1642
1643Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1644whitespace will additionally be xored with the C<$rstyle2>, which defaults
1645to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1646it instead. Both styles I<MUST NOT> contain font styles.
1647
1648=item $term->scr_bell
1649
1650Ring the bell!
1651
1652=item $term->scr_add_lines ($string)
1653
1654Write the given text string to the screen, as if output by the application
1655running inside the terminal. It may not contain command sequences (escape
1656codes), but is free to use line feeds, carriage returns and tabs. The
1657string is a normal text string, not in locale-dependent encoding.
1658
1659Normally its not a good idea to use this function, as programs might be
1660confused by changes in cursor position or scrolling. Its useful inside a
1661C<on_add_lines> hook, though.
1662
1663=item $term->scr_change_screen ($screen)
1664
1665Switch to given screen - 0 primary, 1 secondary.
1666
1667=item $term->cmd_parse ($octets)
1668
1669Similar to C<scr_add_lines>, but the argument must be in the
1670locale-specific encoding of the terminal and can contain command sequences
1671(escape codes) that will be interpreted.
1672
384=item $term->tt_write ($octets) 1673=item $term->tt_write ($octets)
385 1674
386Write the octets given in C<$data> to the tty (i.e. as program input). To 1675Write the octets given in C<$octets> to the tty (i.e. as program input). To
387pass characters instead of octets, you should convetr you strings first to 1676pass characters instead of octets, you should convert your strings first
388the locale-specific encoding using C<< $term->locale_encode >>. 1677to the locale-specific encoding using C<< $term->locale_encode >>.
1678
1679=item $term->tt_paste ($octets)
1680
1681Write the octets given in C<$octets> to the tty as a paste, converting NL to
1682CR and bracketing the data with control sequences if bracketed paste mode
1683is set.
1684
1685=item $old_events = $term->pty_ev_events ([$new_events])
1686
1687Replaces the event mask of the pty watcher by the given event mask. Can
1688be used to suppress input and output handling to the pty/tty. See the
1689description of C<< urxvt::timer->events >>. Make sure to always restore
1690the previous value.
1691
1692=item $fd = $term->pty_fd
1693
1694Returns the master file descriptor for the pty in use, or C<-1> if no pty
1695is used.
1696
1697=item $windowid = $term->parent
1698
1699Return the window id of the toplevel window.
1700
1701=item $windowid = $term->vt
1702
1703Return the window id of the terminal window.
1704
1705=item $term->vt_emask_add ($x_event_mask)
1706
1707Adds the specified events to the vt event mask. Useful e.g. when you want
1708to receive pointer events all the times:
1709
1710 $term->vt_emask_add (urxvt::PointerMotionMask);
1711
1712=item $term->set_urgency ($set)
1713
1714Enable/disable the urgency hint on the toplevel window.
1715
1716=item $term->focus_in
1717
1718=item $term->focus_out
1719
1720=item $term->key_press ($state, $keycode[, $time])
1721
1722=item $term->key_release ($state, $keycode[, $time])
1723
1724Deliver various fake events to to terminal.
1725
1726=item $window_width = $term->width
1727
1728=item $window_height = $term->height
1729
1730=item $font_width = $term->fwidth
1731
1732=item $font_height = $term->fheight
1733
1734=item $font_ascent = $term->fbase
1735
1736=item $terminal_rows = $term->nrow
1737
1738=item $terminal_columns = $term->ncol
1739
1740=item $has_focus = $term->focus
1741
1742=item $is_mapped = $term->mapped
1743
1744=item $max_scrollback = $term->saveLines
1745
1746=item $nrow_plus_saveLines = $term->total_rows
1747
1748=item $topmost_scrollback_row = $term->top_row
1749
1750Return various integers describing terminal characteristics.
1751
1752=item $x_display = $term->display_id
1753
1754Return the DISPLAY used by rxvt-unicode.
1755
1756=item $lc_ctype = $term->locale
1757
1758Returns the LC_CTYPE category string used by this rxvt-unicode.
1759
1760=item $env = $term->env
1761
1762Returns a copy of the environment in effect for the terminal as a hashref
1763similar to C<\%ENV>.
1764
1765=item @envv = $term->envv
1766
1767Returns the environment as array of strings of the form C<VAR=VALUE>.
1768
1769=item @argv = $term->argv
1770
1771Return the argument vector as this terminal, similar to @ARGV, but
1772includes the program name as first element.
1773
1774=cut
1775
1776sub env {
1777 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1778}
1779
1780=item $modifiermask = $term->ModLevel3Mask
1781
1782=item $modifiermask = $term->ModMetaMask
1783
1784=item $modifiermask = $term->ModNumLockMask
1785
1786Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1787AltGr), the meta key (often Alt) and the num lock key, if applicable.
1788
1789=item $screen = $term->current_screen
1790
1791Returns the currently displayed screen (0 primary, 1 secondary).
1792
1793=item $cursor_is_hidden = $term->hidden_cursor
1794
1795Returns whether the cursor is currently hidden or not.
1796
1797=item $view_start = $term->view_start ([$newvalue])
1798
1799Returns the row number of the topmost displayed line. Maximum value is
1800C<0>, which displays the normal terminal contents. Lower values scroll
1801this many lines into the scrollback buffer.
1802
1803=item $term->want_refresh
1804
1805Requests a screen refresh. At the next opportunity, rxvt-unicode will
1806compare the on-screen display with its stored representation. If they
1807differ, it redraws the differences.
1808
1809Used after changing terminal contents to display them.
1810
1811=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1812
1813Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1814is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1815terminal line. Nothing will be returned if a nonexistent line
1816is requested.
1817
1818If C<$new_text> is specified, it will replace characters in the current
1819line, starting at column C<$start_col> (default C<0>), which is useful
1820to replace only parts of a line. The font index in the rendition will
1821automatically be updated.
1822
1823C<$text> is in a special encoding: tabs and wide characters that use more
1824than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1825characters. Characters with combining characters and other characters that
1826do not fit into the normal text encoding will be replaced with characters
1827in the private use area.
1828
1829You have to obey this encoding when changing text. The advantage is
1830that C<substr> and similar functions work on screen cells and not on
1831characters.
1832
1833The methods C<< $term->special_encode >> and C<< $term->special_decode >>
1834can be used to convert normal strings into this encoding and vice versa.
1835
1836=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
1837
1838Like C<< $term->ROW_t >>, but returns an arrayref with rendition
1839bitsets. Rendition bitsets contain information about colour, font, font
1840styles and similar information. See also C<< $term->ROW_t >>.
1841
1842When setting rendition, the font mask will be ignored.
1843
1844See the section on RENDITION, above.
1845
1846=item $length = $term->ROW_l ($row_number[, $new_length])
1847
1848Returns the number of screen cells that are in use ("the line
1849length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
1850line is joined with the following one.
1851
1852=item $bool = $term->is_longer ($row_number)
1853
1854Returns true if the row is part of a multiple-row logical "line" (i.e.
1855joined with the following row), which means all characters are in use
1856and it is continued on the next row (and possibly a continuation of the
1857previous row(s)).
1858
1859=item $line = $term->line ($row_number)
1860
1861Create and return a new C<urxvt::line> object that stores information
1862about the logical line that row C<$row_number> is part of. It supports the
1863following methods:
1864
1865=over 4
1866
1867=item $text = $line->t ([$new_text])
1868
1869Returns or replaces the full text of the line, similar to C<ROW_t>
1870
1871=item $rend = $line->r ([$new_rend])
1872
1873Returns or replaces the full rendition array of the line, similar to C<ROW_r>
1874
1875=item $length = $line->l
1876
1877Returns the length of the line in cells, similar to C<ROW_l>.
1878
1879=item $rownum = $line->beg
1880
1881=item $rownum = $line->end
1882
1883Return the row number of the first/last row of the line, respectively.
1884
1885=item $offset = $line->offset_of ($row, $col)
1886
1887Returns the character offset of the given row|col pair within the logical
1888line. Works for rows outside the line, too, and returns corresponding
1889offsets outside the string.
1890
1891=item ($row, $col) = $line->coord_of ($offset)
1892
1893Translates a string offset into terminal coordinates again.
389 1894
390=back 1895=back
1896
1897=cut
1898
1899sub line {
1900 my ($self, $row) = @_;
1901
1902 my $maxrow = $self->nrow - 1;
1903
1904 my ($beg, $end) = ($row, $row);
1905
1906 --$beg while $self->ROW_is_longer ($beg - 1);
1907 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
1908
1909 bless {
1910 term => $self,
1911 beg => $beg,
1912 end => $end,
1913 ncol => $self->ncol,
1914 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
1915 }, urxvt::line::
1916}
1917
1918sub urxvt::line::t {
1919 my ($self) = @_;
1920
1921 if (@_ > 1)
1922 {
1923 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1924 for $self->{beg} .. $self->{end};
1925 }
1926
1927 defined wantarray &&
1928 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1929 0, $self->{len}
1930}
1931
1932sub urxvt::line::r {
1933 my ($self) = @_;
1934
1935 if (@_ > 1)
1936 {
1937 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1938 for $self->{beg} .. $self->{end};
1939 }
1940
1941 if (defined wantarray) {
1942 my $rend = [
1943 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1944 ];
1945 $#$rend = $self->{len} - 1;
1946 return $rend;
1947 }
1948
1949 ()
1950}
1951
1952sub urxvt::line::beg { $_[0]{beg} }
1953sub urxvt::line::end { $_[0]{end} }
1954sub urxvt::line::l { $_[0]{len} }
1955
1956sub urxvt::line::offset_of {
1957 my ($self, $row, $col) = @_;
1958
1959 ($row - $self->{beg}) * $self->{ncol} + $col
1960}
1961
1962sub urxvt::line::coord_of {
1963 my ($self, $offset) = @_;
1964
1965 use integer;
1966
1967 (
1968 $offset / $self->{ncol} + $self->{beg},
1969 $offset % $self->{ncol}
1970 )
1971}
1972
1973=item $text = $term->special_encode $string
1974
1975Converts a perl string into the special encoding used by rxvt-unicode,
1976where one character corresponds to one screen cell. See
1977C<< $term->ROW_t >> for details.
1978
1979=item $string = $term->special_decode $text
1980
1981Converts rxvt-unicodes text representation into a perl string. See
1982C<< $term->ROW_t >> for details.
1983
1984=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1985
1986=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1987
1988Register/unregister a synchronous button grab. See the XGrabButton
1989manpage.
1990
1991=item $success = $term->grab ($eventtime[, $sync])
1992
1993Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1994synchronous (C<$sync> is true). Also remembers the grab timestamp.
1995
1996=item $term->allow_events_async
1997
1998Calls XAllowEvents with AsyncBoth for the most recent grab.
1999
2000=item $term->allow_events_sync
2001
2002Calls XAllowEvents with SyncBoth for the most recent grab.
2003
2004=item $term->allow_events_replay
2005
2006Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
2007recent grab.
2008
2009=item $term->ungrab
2010
2011Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
2012evaluation errors, as it is better to lose the grab in the error case as
2013the session.
2014
2015=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
2016
2017=item $atom_name = $term->XGetAtomName ($atom)
2018
2019=item @atoms = $term->XListProperties ($window)
2020
2021=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
2022
2023=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
2024
2025=item $term->XDeleteProperty ($window, $property)
2026
2027=item $window = $term->DefaultRootWindow
2028
2029=item $term->XReparentWindow ($window, $parent, [$x, $y])
2030
2031=item $term->XMapWindow ($window)
2032
2033=item $term->XUnmapWindow ($window)
2034
2035=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
2036
2037=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
2038
2039=item $term->XChangeInput ($window, $add_events[, $del_events])
2040
2041=item $keysym = $term->XStringToKeysym ($string)
2042
2043=item $string = $term->XKeysymToString ($keysym)
2044
2045Various X or X-related functions. The C<$term> object only serves as
2046the source of the display, otherwise those functions map more-or-less
2047directly onto the X functions of the same name.
2048
2049=back
2050
2051=cut
2052
2053package urxvt::popup;
2054
2055=head2 The C<urxvt::popup> Class
2056
2057=over 4
2058
2059=cut
2060
2061sub add_item {
2062 my ($self, $item) = @_;
2063
2064 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
2065 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
2066 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
2067
2068 $item->{render} ||= sub { $_[0]{text} };
2069
2070 push @{ $self->{item} }, $item;
2071}
2072
2073=item $popup->add_title ($title)
2074
2075Adds a non-clickable title to the popup.
2076
2077=cut
2078
2079sub add_title {
2080 my ($self, $title) = @_;
2081
2082 $self->add_item ({
2083 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
2084 text => $title,
2085 activate => sub { },
2086 });
2087}
2088
2089=item $popup->add_separator ([$sepchr])
2090
2091Creates a separator, optionally using the character given as C<$sepchr>.
2092
2093=cut
2094
2095sub add_separator {
2096 my ($self, $sep) = @_;
2097
2098 $sep ||= "=";
2099
2100 $self->add_item ({
2101 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
2102 text => "",
2103 render => sub { $sep x $self->{term}->ncol },
2104 activate => sub { },
2105 });
2106}
2107
2108=item $popup->add_button ($text, $cb)
2109
2110Adds a clickable button to the popup. C<$cb> is called whenever it is
2111selected.
2112
2113=cut
2114
2115sub add_button {
2116 my ($self, $text, $cb) = @_;
2117
2118 $self->add_item ({ type => "button", text => $text, activate => $cb});
2119}
2120
2121=item $popup->add_toggle ($text, $initial_value, $cb)
2122
2123Adds a toggle/checkbox item to the popup. The callback gets called
2124whenever it gets toggled, with a boolean indicating its new value as its
2125first argument.
2126
2127=cut
2128
2129sub add_toggle {
2130 my ($self, $text, $value, $cb) = @_;
2131
2132 my $item; $item = {
2133 type => "button",
2134 text => " $text",
2135 value => $value,
2136 render => sub { ($_[0]{value} ? "* " : " ") . $text },
2137 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
2138 };
2139
2140 $self->add_item ($item);
2141}
2142
2143=item $popup->show
2144
2145Displays the popup (which is initially hidden).
2146
2147=cut
2148
2149sub show {
2150 my ($self) = @_;
2151
2152 local $urxvt::popup::self = $self;
2153
2154 my $env = $self->{term}->env;
2155 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
2156 delete $env->{LC_ALL};
2157 $env->{LC_CTYPE} = $self->{term}->locale;
2158
2159 my $term = urxvt::term->new (
2160 $env, "popup",
2161 "--perl-lib" => "", "--perl-ext-common" => "",
2162 "-pty-fd" => -1, "-sl" => 0,
2163 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
2164 "--transient-for" => $self->{term}->parent,
2165 "-display" => $self->{term}->display_id,
2166 "-pe" => "urxvt-popup",
2167 ) or die "unable to create popup window\n";
2168
2169 unless (delete $term->{urxvt_popup_init_done}) {
2170 $term->ungrab;
2171 $term->destroy;
2172 die "unable to initialise popup window\n";
2173 }
2174}
2175
2176sub DESTROY {
2177 my ($self) = @_;
2178
2179 delete $self->{term}{_destroy}{$self};
2180 $self->{term}->ungrab;
2181}
2182
2183=back
2184
2185=cut
2186
2187package urxvt::watcher;
391 2188
392=head2 The C<urxvt::timer> Class 2189=head2 The C<urxvt::timer> Class
393 2190
394This class implements timer watchers/events. Time is represented as a 2191This class implements timer watchers/events. Time is represented as a
395fractional number of seconds since the epoch. Example: 2192fractional number of seconds since the epoch. Example:
396 2193
397 # create a digital clock display in upper right corner 2194 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
398 $term->{timer} = urxvt::timer 2195 $term->{timer} = urxvt::timer
399 ->new 2196 ->new
400 ->start (urxvt::NOW) 2197 ->interval (1)
401 ->cb (sub { 2198 ->cb (sub {
402 my ($timer) = @_;
403 my $time = $timer->at;
404 $timer->start ($time + 1);
405 $self->scr_overlay (-1, 0, 2199 $term->{overlay}->set (0, 0,
406 POSIX::strftime "%H:%M:%S", localtime $time); 2200 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
407 }); 2201 });
408 2202
409=over 4 2203=over 4
410 2204
411=item $timer = new urxvt::timer 2205=item $timer = new urxvt::timer
412 2206
413Create a new timer object in stopped state. 2207Create a new timer object in started state. It is scheduled to fire
2208immediately.
414 2209
415=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2210=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
416 2211
417Set the callback to be called when the timer triggers. 2212Set the callback to be called when the timer triggers.
418 2213
419=item $tstamp = $timer->at
420
421Return the time this watcher will fire next.
422
423=item $timer = $timer->set ($tstamp) 2214=item $timer = $timer->set ($tstamp[, $interval])
424 2215
425Set the time the event is generated to $tstamp. 2216Set the time the event is generated to $tstamp (and optionally specifies a
2217new $interval).
2218
2219=item $timer = $timer->interval ($interval)
2220
2221By default (and when C<$interval> is C<0>), the timer will automatically
2222stop after it has fired once. If C<$interval> is non-zero, then the timer
2223is automatically rescheduled at the given intervals.
426 2224
427=item $timer = $timer->start 2225=item $timer = $timer->start
428 2226
429Start the timer. 2227Start the timer.
430 2228
431=item $timer = $timer->start ($tstamp) 2229=item $timer = $timer->start ($tstamp[, $interval])
432 2230
433Set the event trigger time to C<$tstamp> and start the timer. 2231Set the event trigger time to C<$tstamp> and start the timer. Optionally
2232also replaces the interval.
2233
2234=item $timer = $timer->after ($delay[, $interval])
2235
2236Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
434 2237
435=item $timer = $timer->stop 2238=item $timer = $timer->stop
436 2239
437Stop the timer. 2240Stop the timer.
438 2241
444 2247
445 $term->{socket} = ... 2248 $term->{socket} = ...
446 $term->{iow} = urxvt::iow 2249 $term->{iow} = urxvt::iow
447 ->new 2250 ->new
448 ->fd (fileno $term->{socket}) 2251 ->fd (fileno $term->{socket})
449 ->events (1) # wait for read data 2252 ->events (urxvt::EV_READ)
450 ->start 2253 ->start
451 ->cb (sub { 2254 ->cb (sub {
452 my ($iow, $revents) = @_; 2255 my ($iow, $revents) = @_;
453 # $revents must be 1 here, no need to check 2256 # $revents must be 1 here, no need to check
454 sysread $term->{socket}, my $buf, 8192 2257 sysread $term->{socket}, my $buf, 8192
467Set the callback to be called when io events are triggered. C<$reventmask> 2270Set the callback to be called when io events are triggered. C<$reventmask>
468is a bitset as described in the C<events> method. 2271is a bitset as described in the C<events> method.
469 2272
470=item $iow = $iow->fd ($fd) 2273=item $iow = $iow->fd ($fd)
471 2274
472Set the filedescriptor (not handle) to watch. 2275Set the file descriptor (not handle) to watch.
473 2276
474=item $iow = $iow->events ($eventmask) 2277=item $iow = $iow->events ($eventmask)
475 2278
476Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 2279Set the event mask to watch. The only allowed values are
477data, Bit #1 (value C<2>) enables watching for write data. 2280C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2281together, or C<urxvt::EV_NONE>.
478 2282
479=item $iow = $iow->start 2283=item $iow = $iow->start
480 2284
481Start watching for requested events on the given handle. 2285Start watching for requested events on the given handle.
482 2286
483=item $iow = $iow->stop 2287=item $iow = $iow->stop
484 2288
485Stop watching for events on the given filehandle. 2289Stop watching for events on the given file handle.
2290
2291=back
2292
2293=head2 The C<urxvt::iw> Class
2294
2295This class implements idle watchers, that get called automatically when
2296the process is idle. They should return as fast as possible, after doing
2297some useful work.
2298
2299=over 4
2300
2301=item $iw = new urxvt::iw
2302
2303Create a new idle watcher object in stopped state.
2304
2305=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2306
2307Set the callback to be called when the watcher triggers.
2308
2309=item $timer = $timer->start
2310
2311Start the watcher.
2312
2313=item $timer = $timer->stop
2314
2315Stop the watcher.
2316
2317=back
2318
2319=head2 The C<urxvt::pw> Class
2320
2321This class implements process watchers. They create an event whenever a
2322process exits, after which they stop automatically.
2323
2324 my $pid = fork;
2325 ...
2326 $term->{pw} = urxvt::pw
2327 ->new
2328 ->start ($pid)
2329 ->cb (sub {
2330 my ($pw, $exit_status) = @_;
2331 ...
2332 });
2333
2334=over 4
2335
2336=item $pw = new urxvt::pw
2337
2338Create a new process watcher in stopped state.
2339
2340=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2341
2342Set the callback to be called when the timer triggers.
2343
2344=item $pw = $timer->start ($pid)
2345
2346Tells the watcher to start watching for process C<$pid>.
2347
2348=item $pw = $pw->stop
2349
2350Stop the watcher.
486 2351
487=back 2352=back
488 2353
489=head1 ENVIRONMENT 2354=head1 ENVIRONMENT
490 2355
493This variable controls the verbosity level of the perl extension. Higher 2358This variable controls the verbosity level of the perl extension. Higher
494numbers indicate more verbose output. 2359numbers indicate more verbose output.
495 2360
496=over 4 2361=over 4
497 2362
498=item 0 - only fatal messages 2363=item == 0 - fatal messages
499 2364
500=item 3 - script loading and management 2365=item >= 3 - script loading and management
501 2366
502=item 10 - all events received 2367=item >=10 - all called hooks
2368
2369=item >=11 - hook return values
503 2370
504=back 2371=back
505 2372
506=head1 AUTHOR 2373=head1 AUTHOR
507 2374
508 Marc Lehmann <pcg@goof.com> 2375 Marc Lehmann <schmorp@schmorp.de>
509 http://software.schmorp.de/pkg/rxvt-unicode 2376 http://software.schmorp.de/pkg/rxvt-unicode
510 2377
511=cut 2378=cut
512 2379
5131 23801
2381
2382# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines