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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines