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.28 by root, Wed Jan 4 00:09:12 2006 UTC vs.
Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines