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.84 by root, Thu Jan 12 02:20:56 2006 UTC vs.
Revision 1.151 by root, Thu Dec 14 17:22:04 2006 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
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39 39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
44(More) intelligent selection. This extension tries to be more intelligent 48(More) intelligent selection. This extension tries to be more intelligent
45when the user extends selections (double-click). Right now, it tries to 49when the user extends selections (double-click and further clicks). Right
46select urls and complete shell-quoted arguments, which is very convenient, 50now, it tries to select words, urls and complete shell-quoted
47too, if your F<ls> supports C<--quoting-style=shell>. 51arguments, which is very convenient, too, if your F<ls> supports
52C<--quoting-style=shell>.
48 53
54A double-click usually selects the word under the cursor, further clicks
55will enlarge the selection.
56
57The selection works by trying to match a number of regexes and displaying
58them in increasing order of length. You can add your own regexes by
59specifying resources of the form:
60
61 URxvt.selection.pattern-0: perl-regex
62 URxvt.selection.pattern-1: perl-regex
63 ...
64
65The index number (0, 1...) must not have any holes, and each regex must
66contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the following adds a regex that matches everything
68between two vertical bars:
69
70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72Another example: Programs I use often output "absolute path: " at the
73beginning of a line when they process multiple files. The following
74pattern matches the filename (note, there is a single space at the very
75end):
76
77 URxvt.selection.pattern-0: ^(/[^:]+):\
78
79You can look at the source of the selection extension to see more
80interesting uses, such as parsing a line from beginning to end.
81
49It also offers the following bindable keyboard command: 82This extension also offers following bindable keyboard commands:
50 83
51=over 4 84=over 4
52 85
53=item rot13 86=item rot13
54 87
61=item option-popup (enabled by default) 94=item option-popup (enabled by default)
62 95
63Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 96Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64runtime. 97runtime.
65 98
99Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed.
102
103It's sole argument is the popup menu, which can be modified. It should
104either return nothing or a string, the initial boolean value and a code
105reference. The string will be used as button text and the code reference
106will be called when the toggle changes, with the new boolean value as
107first argument.
108
109The following will add an entry C<myoption> that changes
110C<$self->{myoption}>:
111
112 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 };
115
66=item selection-popup (enabled by default) 116=item selection-popup (enabled by default)
67 117
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection 118Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action (such as uri unescaping, perl 119text into various other formats/action (such as uri unescaping, perl
70evalution, web-browser starting etc.), depending on content. 120evaluation, web-browser starting etc.), depending on content.
121
122Other extensions can extend this popup menu by pushing a code reference
123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124popup is being displayed.
125
126It's sole argument is the popup menu, which can be modified. The selection
127is in C<$_>, which can be used to decide whether to add something or not.
128It should either return nothing or a string and a code reference. The
129string will be used as button text and the code reference will be called
130when the button gets activated and should transform C<$_>.
131
132The following will add an entry C<a to b> that transforms all C<a>s in
133the selection to C<b>s, but only if the selection currently contains any
134C<a>s:
135
136 push @{ $self->{term}{selection_popup_hook} }, sub {
137 /a/ ? ("a to be" => sub { s/a/b/g }
138 : ()
139 };
71 140
72=item searchable-scrollback<hotkey> (enabled by default) 141=item searchable-scrollback<hotkey> (enabled by default)
73 142
74Adds regex search functionality to the scrollback buffer, triggered 143Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 144by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 145input/output is suspended and a regex is displayed at the bottom of the
146screen.
77 147
78C</> starts an incremental regex search, C<n> searches further, C<p> or 148Inputting characters appends them to the regex and continues incremental
79C<N> jump to the previous match, C<G> jumps to the bottom and clears the 149search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80history, C<enter> leaves search mode at the current position and C<escape> 150search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 151bottom. C<Escape> leaves search mode and returns to the point where search
152was started, while C<Enter> or C<Return> stay at the current position and
153additionally stores the first match in the current line into the primary
154selection.
82 155
83=item digital-clock 156The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix.
84 159
85Displays a digital clock using the built-in overlay. 160See L<perlre> for more info about perl regular expression syntax.
86 161
87=item mark-urls 162=item readline (enabled by default)
88 163
164A support package that tries to make editing with readline easier. At
165the moment, it reacts to clicking shift-left mouse button by trying to
166move the text cursor to this position. It does so by generating as many
167cursor-left or cursor-right keypresses as required (the this only works
168for programs that correctly support wide characters).
169
170To avoid too many false positives, this is only done when:
171
172=over 4
173
174=item - the tty is in ICANON state.
175
176=item - the text cursor is visible.
177
178=item - the primary screen is currently being displayed.
179
180=item - the mouse is on the same (multi-row-) line as the text cursor.
181
182=back
183
184The normal selection mechanism isn't disabled, so quick successive clicks
185might interfere with selection creation in harmless ways.
186
187=item selection-autotransform
188
189This selection allows you to do automatic transforms on a selection
190whenever a selection is made.
191
192It works by specifying perl snippets (most useful is a single C<s///>
193operator) that modify C<$_> as resources:
194
195 URxvt.selection-autotransform.0: transform
196 URxvt.selection-autotransform.1: transform
197 ...
198
199For example, the following will transform selections of the form
200C<filename:number>, often seen in compiler messages, into C<vi +$filename
201$word>:
202
203 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
204
205And this example matches the same,but replaces it with vi-commands you can
206paste directly into your (vi :) editor:
207
208 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
209
210Of course, this can be modified to suit your needs and your editor :)
211
212To expand the example above to typical perl error messages ("XXX at
213FILENAME line YYY."), you need a slightly more elaborate solution:
214
215 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
216 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
217
218The first line tells the selection code to treat the unchanging part of
219every error message as a selection pattern, and the second line transforms
220the message into vi commands to load the file.
221
222=item tabbed
223
224This transforms the terminal into a tabbar with additional terminals, that
225is, it implements what is commonly referred to as "tabbed terminal". The topmost line
226displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
227button per tab.
228
229Clicking a button will activate that tab. Pressing B<Shift-Left> and
230B<Shift-Right> will switch to the tab left or right of the current one,
231while B<Shift-Down> creates a new tab.
232
233The tabbar itself can be configured similarly to a normal terminal, but
234with a resource class of C<URxvt.tabbed>. In addition, it supports the
235following four resources (shown with defaults):
236
237 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
238 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
239 URxvt.tabbed.tab-fg: <colour-index, default 0>
240 URxvt.tabbed.tab-bg: <colour-index, default 1>
241
242See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243indices.
244
245=item matcher
246
89Uses per-line display filtering (C<on_line_update>) to underline urls and 247Uses per-line display filtering (C<on_line_update>) to underline text
90make them clickable. When middle-clicked, the program specified in the 248matching a certain pattern and make it clickable. When clicked with the
91resource C<urlLauncher> (default C<x-www-browser>) will be started. 249mouse button specified in the C<matcher.button> resource (default 2, or
250middle), the program specified in the C<matcher.launcher> resource
251(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
252with the matched text as first argument. The default configuration is
253suitable for matching URLs and launching a web browser, like the
254former "mark-urls" extension.
255
256The default pattern to match URLs can be overridden with the
257C<matcher.pattern.0> resource, and additional patterns can be specified
258with numbered patterns, in a manner similar to the "selection" extension.
259The launcher can also be overridden on a per-pattern basis.
260
261Example configuration:
262
263 URxvt.perl-ext: default,matcher
264 URxvt.urlLauncher: sensible-browser
265 URxvt.matcher.button: 1
266 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
267 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
268 URxvt.matcher.launcher.2: gvim +$2 $1
269
270=item xim-onthespot
271
272This (experimental) perl extension implements OnTheSpot editing. It does
273not work perfectly, and some input methods don't seem to work well with
274OnTheSpot editing in general, but it seems to work at leats for SCIM and
275kinput2.
276
277You enable it by specifying this extension and a preedit style of
278C<OnTheSpot>, i.e.:
279
280 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
281
282=item kuake<hotkey>
283
284A very primitive quake-console-like extension. It was inspired by a
285description of how the programs C<kuake> and C<yakuake> work: Whenever the
286user presses a global accelerator key (by default C<F10>), the terminal
287will show or hide itself. Another press of the accelerator key will hide
288or show it again.
289
290Initially, the window will not be shown when using this extension.
291
292This is useful if you need a single terminal thats not using any desktop
293space most of the time but is quickly available at the press of a key.
294
295The accelerator key is grabbed regardless of any modifiers, so this
296extension will actually grab a physical key just for this function.
297
298If you want a quake-like animation, tell your window manager to do so
299(fvwm can do it).
300
301=item automove-background
302
303This is basically a very small extension that dynamically changes the
304background pixmap offset to the window position, in effect creating the
305same effect as pseudo transparency with a custom pixmap. No scaling is
306supported in this mode. Example:
307
308 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
92 309
93=item block-graphics-to-ascii 310=item block-graphics-to-ascii
94 311
95A not very useful example of filtering all text output to the terminal, 312A not very useful example of filtering all text output to the terminal
96by replacing all line-drawing characters (U+2500 .. U+259F) by a 313by replacing all line-drawing characters (U+2500 .. U+259F) by a
97similar-looking ascii character. 314similar-looking ascii character.
315
316=item digital-clock
317
318Displays a digital clock using the built-in overlay.
319
320=item remote-clipboard
321
322Somewhat of a misnomer, this extension adds two menu entries to the
323selection popup that allows one ti run external commands to store the
324selection somewhere and fetch it again.
325
326We use it to implement a "distributed selection mechanism", which just
327means that one command uploads the file to a remote server, and another
328reads it.
329
330The commands can be set using the C<URxvt.remote-selection.store> and
331C<URxvt.remote-selection.fetch> resources. The first should read the
332selection to store from STDIN (always in UTF-8), the second should provide
333the selection data on STDOUT (also in UTF-8).
334
335The defaults (which are likely useless to you) use rsh and cat:
336
337 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
338 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
339
340=item selection-pastebin
341
342This is a little rarely useful extension that Uploads the selection as
343textfile to a remote site (or does other things). (The implementation is
344not currently secure for use in a multiuser environment as it writes to
345F</tmp> directly.).
346
347It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
348i.e.
349
350 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
351
352Pressing this combination runs a command with C<%> replaced by the name of
353the textfile. This command can be set via a resource:
354
355 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
356
357And the default is likely not useful to anybody but the few people around
358here :)
359
360The name of the textfile is the hex encoded md5 sum of the selection, so
361the same content should lead to the same filename.
362
363After a successful upload the selection will be replaced by the text given
364in the C<selection-pastebin-url> resource (again, the % is the placeholder
365for the filename):
366
367 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
368
369I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
370the double C</> characters as comment start. Use C<\057\057> instead,
371which works regardless of wether xrdb is used to parse the resource file
372or not.
98 373
99=item example-refresh-hooks 374=item example-refresh-hooks
100 375
101Displays a very simple digital clock in the upper right corner of the 376Displays a very simple digital clock in the upper right corner of the
102window. Illustrates overwriting the refresh callbacks to create your own 377window. Illustrates overwriting the refresh callbacks to create your own
142 417
143=back 418=back
144 419
145=head2 Extension Objects 420=head2 Extension Objects
146 421
147Very perl extension is a perl class. A separate perl object is created 422Every perl extension is a perl class. A separate perl object is created
148for each terminal and each extension and passed as the first parameter to 423for each terminal, and each terminal has its own set of extenion objects,
149hooks. So extensions can use their C<$self> object without having to think 424which are passed as the first parameter to hooks. So extensions can use
150about other extensions, with the exception of methods and members that 425their C<$self> object without having to think about clashes with other
426extensions or other terminals, with the exception of methods and members
151begin with an underscore character C<_>: these are reserved for internal 427that begin with an underscore character C<_>: these are reserved for
152use. 428internal use.
153 429
154Although it isn't a C<urxvt::term> object, you can call all methods of the 430Although it isn't a C<urxvt::term> object, you can call all methods of the
155C<urxvt::term> class on this object. 431C<urxvt::term> class on this object.
156 432
157It has the following methods and data members: 433It has the following methods and data members:
178=head2 Hooks 454=head2 Hooks
179 455
180The following subroutines can be declared in extension files, and will be 456The following subroutines can be declared in extension files, and will be
181called whenever the relevant event happens. 457called whenever the relevant event happens.
182 458
183The first argument passed to them is an extension oject as described in 459The first argument passed to them is an extension object as described in
184the in the C<Extension Objects> section. 460the in the C<Extension Objects> section.
185 461
186B<All> of these hooks must return a boolean value. If it is true, then the 462B<All> of these hooks must return a boolean value. If any of the called
187event counts as being I<consumed>, and the invocation of other hooks is 463hooks returns true, then the event counts as being I<consumed>, and the
188skipped, and the relevant action might not be carried out by the C++ code. 464relevant action might not be carried out by the C++ code.
189 465
190I<< When in doubt, return a false value (preferably C<()>). >> 466I<< When in doubt, return a false value (preferably C<()>). >>
191 467
192=over 4 468=over 4
193 469
194=item on_init $term 470=item on_init $term
195 471
196Called after a new terminal object has been initialized, but before 472Called after a new terminal object has been initialized, but before
197windows are created or the command gets run. Most methods are unsafe to 473windows are created or the command gets run. Most methods are unsafe to
198call or deliver senseless data, as terminal size and other characteristics 474call or deliver senseless data, as terminal size and other characteristics
199have not yet been determined. You can safely query and change resources, 475have not yet been determined. You can safely query and change resources
200though. 476and options, though. For many purposes the C<on_start> hook is a better
477place.
478
479=item on_start $term
480
481Called at the very end of initialisation of a new terminal, just before
482trying to map (display) the toplevel and returning to the main loop.
483
484=item on_destroy $term
485
486Called whenever something tries to destroy terminal, when the terminal is
487still fully functional (not for long, though).
201 488
202=item on_reset $term 489=item on_reset $term
203 490
204Called after the screen is "reset" for any reason, such as resizing or 491Called after the screen is "reset" for any reason, such as resizing or
205control sequences. Here is where you can react on changes to size-related 492control sequences. Here is where you can react on changes to size-related
206variables. 493variables.
207 494
208=item on_start $term 495=item on_child_start $term, $pid
209 496
210Called at the very end of initialisation of a new terminal, just before 497Called just after the child process has been C<fork>ed.
211returning to the mainloop. 498
499=item on_child_exit $term, $status
500
501Called just after the child process has exited. C<$status> is the status
502from C<waitpid>.
212 503
213=item on_sel_make $term, $eventtime 504=item on_sel_make $term, $eventtime
214 505
215Called whenever a selection has been made by the user, but before the 506Called whenever a selection has been made by the user, but before the
216selection text is copied, so changes to the beginning, end or type of the 507selection text is copied, so changes to the beginning, end or type of the
223 514
224Called whenever a selection has been copied, but before the selection is 515Called whenever a selection has been copied, but before the selection is
225requested from the server. The selection text can be queried and changed 516requested from the server. The selection text can be queried and changed
226by calling C<< $term->selection >>. 517by calling C<< $term->selection >>.
227 518
228Returning a true value aborts selection grabbing. It will still be hilighted. 519Returning a true value aborts selection grabbing. It will still be highlighted.
229 520
230=item on_sel_extend $term 521=item on_sel_extend $term
231 522
232Called whenever the user tries to extend the selection (e.g. with a double 523Called whenever the user tries to extend the selection (e.g. with a double
233click) and is either supposed to return false (normal operation), or 524click) and is either supposed to return false (normal operation), or
234should extend the selection itelf and return true to suppress the built-in 525should extend the selection itself and return true to suppress the built-in
235processing. 526processing. This can happen multiple times, as long as the callback
527returns true, it will be called on every further click by the user and is
528supposed to enlarge the selection more and more, if possible.
236 529
237See the F<selection> example extension. 530See the F<selection> example extension.
238 531
239=item on_view_change $term, $offset 532=item on_view_change $term, $offset
240 533
241Called whenever the view offset changes, i..e the user or program 534Called whenever the view offset changes, i.e. the user or program
242scrolls. Offset C<0> means display the normal terminal, positive values 535scrolls. Offset C<0> means display the normal terminal, positive values
243show this many lines of scrollback. 536show this many lines of scrollback.
244 537
245=item on_scroll_back $term, $lines, $saved 538=item on_scroll_back $term, $lines, $saved
246 539
250 543
251It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 544It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
252$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 545$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
253number of lines that will be in the scrollback buffer. 546number of lines that will be in the scrollback buffer.
254 547
548=item on_osc_seq $term, $op, $args
549
550Called on every OSC sequence and can be used to suppress it or modify its
551behaviour. The default should be to return an empty list. A true value
552suppresses execution of the request completely. Make sure you don't get
553confused by recursive invocations when you output an osc sequence within
554this callback.
555
556C<on_osc_seq_perl> should be used for new behaviour.
557
255=item on_osc_seq $term, $string 558=item on_osc_seq_perl $term, $string
256 559
257Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 560Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
258operating system command) is processed. Cursor position and other state 561operating system command) is processed. Cursor position and other state
259information is up-to-date when this happens. For interoperability, the 562information is up-to-date when this happens. For interoperability, the
260string should start with the extension name and a colon, to distinguish 563string should start with the extension name and a colon, to distinguish
261it from commands for other extensions, and this might be enforced in the 564it from commands for other extensions, and this might be enforced in the
262future. 565future.
263 566
264Be careful not ever to trust (in a security sense) the data you receive, 567Be careful not ever to trust (in a security sense) the data you receive,
265as its source can not easily be controleld (e-mail content, messages from 568as its source can not easily be controlled (e-mail content, messages from
266other users on the same system etc.). 569other users on the same system etc.).
267 570
268=item on_add_lines $term, $string 571=item on_add_lines $term, $string
269 572
270Called whenever text is about to be output, with the text as argument. You 573Called whenever text is about to be output, with the text as argument. You
301 604
302=item on_refresh_end $term 605=item on_refresh_end $term
303 606
304Called just after the screen gets redrawn. See C<on_refresh_begin>. 607Called just after the screen gets redrawn. See C<on_refresh_begin>.
305 608
306=item on_keyboard_command $term, $string 609=item on_user_command $term, $string
307 610
308Called whenever the user presses a key combination that has a 611Called whenever a user-configured event is being activated (e.g. via
309C<perl:string> action bound to it (see description of the B<keysym> 612a C<perl:string> action bound to a key, see description of the B<keysym>
310resource in the @@RXVT_NAME@@(1) manpage). 613resource in the @@RXVT_NAME@@(1) manpage).
614
615The event is simply the action string. This interface is assumed to change
616slightly in the future.
617
618=item on_resize_all_windows $tern, $new_width, $new_height
619
620Called just after the new window size has been calculated, but before
621windows are actually being resized or hints are being set. If this hook
622returns TRUE, setting of the window hints is being skipped.
623
624=item on_x_event $term, $event
625
626Called on every X event received on the vt window (and possibly other
627windows). Should only be used as a last resort. Most event structure
628members are not passed.
629
630=item on_root_event $term, $event
631
632Like C<on_x_event>, but is called for events on the root window.
311 633
312=item on_focus_in $term 634=item on_focus_in $term
313 635
314Called whenever the window gets the keyboard focus, before rxvt-unicode 636Called whenever the window gets the keyboard focus, before rxvt-unicode
315does focus in processing. 637does focus in processing.
316 638
317=item on_focus_out $term 639=item on_focus_out $term
318 640
319Called wheneever the window loses keyboard focus, before rxvt-unicode does 641Called whenever the window loses keyboard focus, before rxvt-unicode does
320focus out processing. 642focus out processing.
643
644=item on_configure_notify $term, $event
645
646=item on_property_notify $term, $event
321 647
322=item on_key_press $term, $event, $keysym, $octets 648=item on_key_press $term, $event, $keysym, $octets
323 649
324=item on_key_release $term, $event, $keysym 650=item on_key_release $term, $event, $keysym
325 651
335 661
336Called whenever the corresponding X event is received for the terminal If 662Called whenever the corresponding X event is received for the terminal If
337the hook returns true, then the even will be ignored by rxvt-unicode. 663the hook returns true, then the even will be ignored by rxvt-unicode.
338 664
339The event is a hash with most values as named by Xlib (see the XEvent 665The event is a hash with most values as named by Xlib (see the XEvent
340manpage), with the additional members C<row> and C<col>, which are the row 666manpage), with the additional members C<row> and C<col>, which are the
341and column under the mouse cursor. 667(real, not screen-based) row and column under the mouse cursor.
342 668
343C<on_key_press> additionally receives the string rxvt-unicode would 669C<on_key_press> additionally receives the string rxvt-unicode would
344output, if any, in locale-specific encoding. 670output, if any, in locale-specific encoding.
345 671
346subwindow. 672subwindow.
673
674=item on_client_message $term, $event
675
676=item on_wm_protocols $term, $event
677
678=item on_wm_delete_window $term, $event
679
680Called when various types of ClientMessage events are received (all with
681format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
347 682
348=back 683=back
349 684
350=cut 685=cut
351 686
357use Scalar::Util (); 692use Scalar::Util ();
358use List::Util (); 693use List::Util ();
359 694
360our $VERSION = 1; 695our $VERSION = 1;
361our $TERM; 696our $TERM;
697our @TERM_INIT;
698our @TERM_EXT;
362our @HOOKNAME; 699our @HOOKNAME;
363our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 700our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364our %OPTION; 701our %OPTION;
365 702
366our $LIBDIR; 703our $LIBDIR;
367our $RESNAME; 704our $RESNAME;
368our $RESCLASS; 705our $RESCLASS;
369our $RXVTNAME; 706our $RXVTNAME;
370 707
708our $NOCHAR = chr 0xffff;
709
371=head2 Variables in the C<urxvt> Package 710=head2 Variables in the C<urxvt> Package
372 711
373=over 4 712=over 4
374 713
375=item $urxvt::LIBDIR 714=item $urxvt::LIBDIR
387 726
388=item $urxvt::TERM 727=item $urxvt::TERM
389 728
390The current terminal. This variable stores the current C<urxvt::term> 729The current terminal. This variable stores the current C<urxvt::term>
391object, whenever a callback/hook is executing. 730object, whenever a callback/hook is executing.
731
732=item @urxvt::TERM_INIT
733
734All code references in this array will be called as methods of the next newly
735created C<urxvt::term> object (during the C<on_init> phase). The array
736gets cleared before the code references that were in it are being executed,
737so references can push themselves onto it again if they so desire.
738
739This complements to the perl-eval command line option, but gets executed
740first.
741
742=item @urxvt::TERM_EXT
743
744Works similar to C<@TERM_INIT>, but contains perl package/class names, which
745get registered as normal extensions after calling the hooks in C<@TERM_INIT>
746but before other extensions. Gets cleared just like C<@TERM_INIT>.
392 747
393=back 748=back
394 749
395=head2 Functions in the C<urxvt> Package 750=head2 Functions in the C<urxvt> Package
396 751
411Using this function has the advantage that its output ends up in the 766Using this function has the advantage that its output ends up in the
412correct place, e.g. on stderr of the connecting urxvtc client. 767correct place, e.g. on stderr of the connecting urxvtc client.
413 768
414Messages have a size limit of 1023 bytes currently. 769Messages have a size limit of 1023 bytes currently.
415 770
416=item $is_safe = urxvt::safe 771=item @terms = urxvt::termlist
417 772
418Returns true when it is safe to do potentially unsafe things, such as 773Returns all urxvt::term objects that exist in this process, regardless of
419evaluating perl code specified by the user. This is true when urxvt was 774whether they are started, being destroyed etc., so be careful. Only term
420started setuid or setgid. 775objects that have perl extensions attached will be returned (because there
776is no urxvt::term objet associated with others).
421 777
422=item $time = urxvt::NOW 778=item $time = urxvt::NOW
423 779
424Returns the "current time" (as per the event loop). 780Returns the "current time" (as per the event loop).
425 781
426=item urxvt::CurrentTime 782=item urxvt::CurrentTime
427 783
428=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 784=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 785Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430Button4Mask, Button5Mask, AnyModifier 786Button4Mask, Button5Mask, AnyModifier
787
788=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
789ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
790PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
791Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
792KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
793ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
794FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
795
796=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
797EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
798GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
799UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
800ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
801CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
802SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431 803
432Various constants for use in X calls and event processing. 804Various constants for use in X calls and event processing.
433 805
434=back 806=back
435 807
468 840
469=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 841=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
470 842
471=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 843=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
472 844
845=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
846
473Replace the foreground/background colour in the rendition mask with the 847Replace the foreground/background colour in the rendition mask with the
474specified one. 848specified one.
475 849
476=item $value = urxvt::GET_CUSTOM $rend 850=item $value = urxvt::GET_CUSTOM $rend
477 851
486=back 860=back
487 861
488=cut 862=cut
489 863
490BEGIN { 864BEGIN {
491 urxvt->bootstrap;
492
493 # overwrite perl's warn 865 # overwrite perl's warn
494 *CORE::GLOBAL::warn = sub { 866 *CORE::GLOBAL::warn = sub {
495 my $msg = join "", @_; 867 my $msg = join "", @_;
496 $msg .= "\n" 868 $msg .= "\n"
497 unless $msg =~ /\n$/; 869 unless $msg =~ /\n$/;
498 urxvt::warn ($msg); 870 urxvt::warn ($msg);
499 }; 871 };
500
501 # %ENV is the original startup environment
502 delete $ENV{IFS};
503 delete $ENV{CDPATH};
504 delete $ENV{BASH_ENV};
505 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
506} 872}
507 873
508my @hook_count; 874no warnings 'utf8';
875
509my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 876my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
510 877
511sub verbose { 878sub verbose {
512 my ($level, $msg) = @_; 879 my ($level, $msg) = @_;
513 warn "$msg\n" if $level <= $verbosity; 880 warn "$msg\n" if $level <= $verbosity;
514} 881}
515 882
516my $extension_pkg = "extension0000";
517my %extension_pkg; 883my %extension_pkg;
518 884
519# load a single script into its own package, once only 885# load a single script into its own package, once only
520sub extension_package($) { 886sub extension_package($) {
521 my ($path) = @_; 887 my ($path) = @_;
522 888
523 $extension_pkg{$path} ||= do { 889 $extension_pkg{$path} ||= do {
524 my $pkg = "urxvt::" . ($extension_pkg++); 890 $path =~ /([^\/\\]+)$/;
891 my $pkg = $1;
892 $pkg =~ s/[^[:word:]]/_/g;
893 $pkg = "urxvt::ext::$pkg";
525 894
526 verbose 3, "loading extension '$path' into package '$pkg'"; 895 verbose 3, "loading extension '$path' into package '$pkg'";
527 896
528 open my $fh, "<:raw", $path 897 open my $fh, "<:raw", $path
529 or die "$path: $!"; 898 or die "$path: $!";
530 899
531 my $source = untaint 900 my $source =
532 "package $pkg; use strict; use utf8;\n" 901 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
533 . "use base urxvt::term::extension::;\n"
534 . "#line 1 \"$path\"\n{\n" 902 . "#line 1 \"$path\"\n{\n"
535 . (do { local $/; <$fh> }) 903 . (do { local $/; <$fh> })
536 . "\n};\n1"; 904 . "\n};\n1";
537 905
538 eval $source 906 eval $source
552 if ($htype == 0) { # INIT 920 if ($htype == 0) { # INIT
553 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 921 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
554 922
555 my %ext_arg; 923 my %ext_arg;
556 924
925 {
926 my @init = @TERM_INIT;
927 @TERM_INIT = ();
928 $_->($TERM) for @init;
929 my @pkg = @TERM_EXT;
930 @TERM_EXT = ();
931 $TERM->register_package ($_) for @pkg;
932 }
933
557 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 934 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
558 if ($_ eq "default") { 935 if ($_ eq "default") {
559 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 936 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
560 } elsif (/^-(.*)$/) { 937 } elsif (/^-(.*)$/) {
561 delete $ext_arg{$1}; 938 delete $ext_arg{$1};
562 } elsif (/^([^<]+)<(.*)>$/) { 939 } elsif (/^([^<]+)<(.*)>$/) {
563 push @{ $ext_arg{$1} }, $2; 940 push @{ $ext_arg{$1} }, $2;
564 } else { 941 } else {
565 $ext_arg{$_} ||= []; 942 $ext_arg{$_} ||= [];
566 } 943 }
567 } 944 }
568 945
569 while (my ($ext, $argv) = each %ext_arg) { 946 for my $ext (sort keys %ext_arg) {
570 my @files = grep -f $_, map "$_/$ext", @dirs; 947 my @files = grep -f $_, map "$_/$ext", @dirs;
571 948
572 if (@files) { 949 if (@files) {
573 $TERM->register_package (extension_package $files[0], $argv); 950 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
574 } else { 951 } else {
575 warn "perl extension '$ext' not found in perl library search path\n"; 952 warn "perl extension '$ext' not found in perl library search path\n";
576 } 953 }
577 } 954 }
578 955
584 961
585 if (my $cb = $TERM->{_hook}[$htype]) { 962 if (my $cb = $TERM->{_hook}[$htype]) {
586 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 963 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
587 if $verbosity >= 10; 964 if $verbosity >= 10;
588 965
589 keys %$cb; 966 for my $pkg (keys %$cb) {
590
591 while (my ($pkg, $cb) = each %$cb) {
592 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 967 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
593 and last; 968 $retval ||= $retval_;
594 969
595 if ($@) { 970 if ($@) {
596 $TERM->ungrab; # better to lose the grab than the session 971 $TERM->ungrab; # better to lose the grab than the session
597 warn $@; 972 warn $@;
598 } 973 }
599 } 974 }
975
976 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
977 if $verbosity >= 11;
600 } 978 }
601 979
602 if ($htype == 1) { # DESTROY 980 if ($htype == 1) { # DESTROY
603 if (my $hook = delete $TERM->{_hook}) {
604 for my $htype (0..$#$hook) {
605 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
606 or set_should_invoke $htype, 0;
607 }
608 }
609
610 # clear package objects 981 # clear package objects
611 %$_ = () for values %{ $TERM->{_pkg} }; 982 %$_ = () for values %{ $TERM->{_pkg} };
612 983
613 # clear package 984 # clear package
614 %$TERM = (); 985 %$TERM = ();
615 } 986 }
616 987
617 $retval 988 $retval
618} 989}
619 990
620sub exec_async(@) { 991sub SET_COLOR($$$) {
621 my $pid = fork; 992 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
622
623 return
624 if !defined $pid or $pid;
625
626 %ENV = %{ $TERM->env };
627
628 exec @_;
629 _exit 255;
630} 993}
631 994
632# urxvt::term::extension 995# urxvt::term::extension
633 996
634package urxvt::term::extension; 997package urxvt::term::extension;
640 while (my ($name, $cb) = each %hook) { 1003 while (my ($name, $cb) = each %hook) {
641 my $htype = $HOOKTYPE{uc $name}; 1004 my $htype = $HOOKTYPE{uc $name};
642 defined $htype 1005 defined $htype
643 or Carp::croak "unsupported hook type '$name'"; 1006 or Carp::croak "unsupported hook type '$name'";
644 1007
1008 $self->set_should_invoke ($htype, +1)
645 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 1009 unless exists $self->{term}{_hook}[$htype]{$pkg};
646 $hook_count[$htype]++
647 or urxvt::set_should_invoke $htype, 1;
648 }
649 1010
650 $self->{term}{_hook}[$htype]{$pkg} = $cb; 1011 $self->{term}{_hook}[$htype]{$pkg} = $cb;
651 } 1012 }
652} 1013}
653 1014
658 for my $name (@hook) { 1019 for my $name (@hook) {
659 my $htype = $HOOKTYPE{uc $name}; 1020 my $htype = $HOOKTYPE{uc $name};
660 defined $htype 1021 defined $htype
661 or Carp::croak "unsupported hook type '$name'"; 1022 or Carp::croak "unsupported hook type '$name'";
662 1023
1024 $self->set_should_invoke ($htype, -1)
663 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 1025 if delete $self->{term}{_hook}[$htype]{$pkg};
664 --$hook_count[$htype]
665 or urxvt::set_should_invoke $htype, 0;
666 }
667 } 1026 }
668} 1027}
669 1028
670our $AUTOLOAD; 1029our $AUTOLOAD;
671 1030
751sub DESTROY { 1110sub DESTROY {
752 $_[0][1]->stop; 1111 $_[0][1]->stop;
753} 1112}
754 1113
755sub condvar { 1114sub condvar {
756 bless \my $flag, urxvt::anyevent::condvar:: 1115 bless \my $flag, urxvt::anyevent::
757} 1116}
758 1117
759sub urxvt::anyevent::condvar::broadcast { 1118sub broadcast {
760 ${$_[0]}++; 1119 ${$_[0]}++;
761} 1120}
762 1121
763sub urxvt::anyevent::condvar::wait { 1122sub wait {
764 unless (${$_[0]}) { 1123 unless (${$_[0]}) {
765 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1124 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
766 } 1125 }
1126}
1127
1128sub one_event {
1129 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
767} 1130}
768 1131
769package urxvt::term; 1132package urxvt::term;
770 1133
771=head2 The C<urxvt::term> Class 1134=head2 The C<urxvt::term> Class
776 1139
777# find on_xxx subs in the package and register them 1140# find on_xxx subs in the package and register them
778# as hooks 1141# as hooks
779sub register_package { 1142sub register_package {
780 my ($self, $pkg, $argv) = @_; 1143 my ($self, $pkg, $argv) = @_;
1144
1145 no strict 'refs';
1146
1147 urxvt::verbose 6, "register package $pkg to $self";
1148
1149 @{"$pkg\::ISA"} = urxvt::term::extension::;
781 1150
782 my $proxy = bless { 1151 my $proxy = bless {
783 _pkg => $pkg, 1152 _pkg => $pkg,
784 argv => $argv, 1153 argv => $argv,
785 }, $pkg; 1154 }, $pkg;
801hash which defines the environment of the new terminal. 1170hash which defines the environment of the new terminal.
802 1171
803Croaks (and probably outputs an error message) if the new instance 1172Croaks (and probably outputs an error message) if the new instance
804couldn't be created. Returns C<undef> if the new instance didn't 1173couldn't be created. Returns C<undef> if the new instance didn't
805initialise perl, and the terminal object otherwise. The C<init> and 1174initialise perl, and the terminal object otherwise. The C<init> and
806C<start> hooks will be called during this call. 1175C<start> hooks will be called before this call returns, and are free to
1176refer to global data (which is race free).
807 1177
808=cut 1178=cut
809 1179
810sub new { 1180sub new {
811 my ($class, $env, @args) = @_; 1181 my ($class, $env, @args) = @_;
812 1182
1183 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1184 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1185
813 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1186 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
814} 1187}
815 1188
816=item $term->destroy 1189=item $term->destroy
817 1190
818Destroy the terminal object (close the window, free resources 1191Destroy the terminal object (close the window, free resources
819etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1192etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
820watchers (timers, io watchers) are still active. 1193watchers (timers, io watchers) are still active.
821 1194
1195=item $term->exec_async ($cmd[, @args])
1196
1197Works like the combination of the C<fork>/C<exec> builtins, which executes
1198("starts") programs in the background. This function takes care of setting
1199the user environment before exec'ing the command (e.g. C<PATH>) and should
1200be preferred over explicit calls to C<exec> or C<system>.
1201
1202Returns the pid of the subprocess or C<undef> on error.
1203
1204=cut
1205
1206sub exec_async {
1207 my $self = shift;
1208
1209 my $pid = fork;
1210
1211 return $pid
1212 if !defined $pid or $pid;
1213
1214 %ENV = %{ $self->env };
1215
1216 exec @_;
1217 urxvt::_exit 255;
1218}
1219
822=item $isset = $term->option ($optval[, $set]) 1220=item $isset = $term->option ($optval[, $set])
823 1221
824Returns true if the option specified by C<$optval> is enabled, and 1222Returns true if the option specified by C<$optval> is enabled, and
825optionally change it. All option values are stored by name in the hash 1223optionally change it. All option values are stored by name in the hash
826C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1224C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
827 1225
828Here is a a likely non-exhaustive list of option names, please see the 1226Here is a likely non-exhaustive list of option names, please see the
829source file F</src/optinc.h> to see the actual list: 1227source file F</src/optinc.h> to see the actual list:
830 1228
831 borderLess console cursorBlink cursorUnderline hold iconic insecure 1229 borderLess console cursorBlink cursorUnderline hold iconic insecure
832 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1230 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
833 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1231 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
834 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1232 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
835 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1233 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
836 tripleclickwords utmpInhibit visualBell 1234 transparent tripleclickwords utmpInhibit visualBell
837 1235
838=item $value = $term->resource ($name[, $newval]) 1236=item $value = $term->resource ($name[, $newval])
839 1237
840Returns the current resource value associated with a given name and 1238Returns the current resource value associated with a given name and
841optionally sets a new value. Setting values is most useful in the C<init> 1239optionally sets a new value. Setting values is most useful in the C<init>
850likely change). 1248likely change).
851 1249
852Please note that resource strings will currently only be freed when the 1250Please note that resource strings will currently only be freed when the
853terminal is destroyed, so changing options frequently will eat memory. 1251terminal is destroyed, so changing options frequently will eat memory.
854 1252
855Here is a a likely non-exhaustive list of resource names, not all of which 1253Here is a likely non-exhaustive list of resource names, not all of which
856are supported in every build, please see the source file F</src/rsinc.h> 1254are supported in every build, please see the source file F</src/rsinc.h>
857to see the actual list: 1255to see the actual list:
858 1256
859 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1257 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
860 borderLess color cursorBlink cursorUnderline cutchars delete_key 1258 borderLess color cursorBlink cursorUnderline cutchars delete_key
861 display_name embed ext_bwidth fade font geometry hold iconName 1259 display_name embed ext_bwidth fade font geometry hold iconName
862 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1260 imFont imLocale inputMethod insecure int_bwidth intensityStyles
863 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1261 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
864 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1262 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
865 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1263 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
866 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1264 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
867 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1265 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
868 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1266 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
869 shade term_name title transparent transparent_all tripleclickwords 1267 secondaryScreen secondaryScroll selectstyle shade term_name title
870 utmpInhibit visualBell 1268 transient_for transparent transparent_all tripleclickwords utmpInhibit
1269 visualBell
871 1270
872=cut 1271=cut
873 1272
874sub resource($$;$) { 1273sub resource($$;$) {
875 my ($self, $name) = (shift, shift); 1274 my ($self, $name) = (shift, shift);
910=item ($row, $col) = $term->selection_end ([$row, $col]) 1309=item ($row, $col) = $term->selection_end ([$row, $col])
911 1310
912Return the current values of the selection mark, begin or end positions, 1311Return the current values of the selection mark, begin or end positions,
913and optionally set them to new values. 1312and optionally set them to new values.
914 1313
1314=item $term->selection_make ($eventtime[, $rectangular])
1315
1316Tries to make a selection as set by C<selection_beg> and
1317C<selection_end>. If C<$rectangular> is true (default: false), a
1318rectangular selection will be made. This is the prefered function to make
1319a selection.
1320
915=item $success = $term->selection_grab ($eventtime) 1321=item $success = $term->selection_grab ($eventtime)
916 1322
917Try to request the primary selection from the server (for example, as set 1323Try to request the primary selection text from the server (for example, as
918by the next method). 1324set by the next method). No visual feedback will be given. This function
1325is mostly useful from within C<on_sel_grab> hooks.
919 1326
920=item $oldtext = $term->selection ([$newtext]) 1327=item $oldtext = $term->selection ([$newtext])
921 1328
922Return the current selection text and optionally replace it by C<$newtext>. 1329Return the current selection text and optionally replace it by C<$newtext>.
923 1330
1016Convert the given locale-encoded octets into a perl string. 1423Convert the given locale-encoded octets into a perl string.
1017 1424
1018=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1425=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1019 1426
1020XORs the rendition values in the given span with the provided value 1427XORs the rendition values in the given span with the provided value
1021(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1428(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1022to the selection. 1429refresh hooks to provide effects similar to the selection.
1023 1430
1024=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1431=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1025 1432
1026Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1433Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1027whitespace will additionally be xored with the C<$rstyle2>, which defaults 1434whitespace will additionally be xored with the C<$rstyle2>, which defaults
1028to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1435to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1029it instead. 1436it instead. Both styles I<MUST NOT> contain font styles.
1030 1437
1031=item $term->scr_bell 1438=item $term->scr_bell
1032 1439
1033Ring the bell! 1440Ring the bell!
1034 1441
1041 1448
1042Normally its not a good idea to use this function, as programs might be 1449Normally its not a good idea to use this function, as programs might be
1043confused by changes in cursor position or scrolling. Its useful inside a 1450confused by changes in cursor position or scrolling. Its useful inside a
1044C<on_add_lines> hook, though. 1451C<on_add_lines> hook, though.
1045 1452
1453=item $term->scr_change_screen ($screen)
1454
1455Switch to given screen - 0 primary, 1 secondary.
1456
1046=item $term->cmd_parse ($octets) 1457=item $term->cmd_parse ($octets)
1047 1458
1048Similar to C<scr_add_lines>, but the argument must be in the 1459Similar to C<scr_add_lines>, but the argument must be in the
1049locale-specific encoding of the terminal and can contain command sequences 1460locale-specific encoding of the terminal and can contain command sequences
1050(escape codes) that will be interpreted. 1461(escape codes) that will be interpreted.
1060Replaces the event mask of the pty watcher by the given event mask. Can 1471Replaces the event mask of the pty watcher by the given event mask. Can
1061be used to suppress input and output handling to the pty/tty. See the 1472be used to suppress input and output handling to the pty/tty. See the
1062description of C<< urxvt::timer->events >>. Make sure to always restore 1473description of C<< urxvt::timer->events >>. Make sure to always restore
1063the previous value. 1474the previous value.
1064 1475
1476=item $fd = $term->pty_fd
1477
1478Returns the master file descriptor for the pty in use, or C<-1> if no pty
1479is used.
1480
1065=item $windowid = $term->parent 1481=item $windowid = $term->parent
1066 1482
1067Return the window id of the toplevel window. 1483Return the window id of the toplevel window.
1068 1484
1069=item $windowid = $term->vt 1485=item $windowid = $term->vt
1070 1486
1071Return the window id of the terminal window. 1487Return the window id of the terminal window.
1072 1488
1489=item $term->vt_emask_add ($x_event_mask)
1490
1491Adds the specified events to the vt event mask. Useful e.g. when you want
1492to receive pointer events all the times:
1493
1494 $term->vt_emask_add (urxvt::PointerMotionMask);
1495
1496=item $term->focus_in
1497
1498=item $term->focus_out
1499
1500=item $term->key_press ($state, $keycode[, $time])
1501
1502=item $term->key_release ($state, $keycode[, $time])
1503
1504Deliver various fake events to to terminal.
1505
1073=item $window_width = $term->width 1506=item $window_width = $term->width
1074 1507
1075=item $window_height = $term->height 1508=item $window_height = $term->height
1076 1509
1077=item $font_width = $term->fwidth 1510=item $font_width = $term->fwidth
1090 1523
1091=item $max_scrollback = $term->saveLines 1524=item $max_scrollback = $term->saveLines
1092 1525
1093=item $nrow_plus_saveLines = $term->total_rows 1526=item $nrow_plus_saveLines = $term->total_rows
1094 1527
1095=item $lines_in_scrollback = $term->nsaved 1528=item $topmost_scrollback_row = $term->top_row
1096 1529
1097Return various integers describing terminal characteristics. 1530Return various integers describing terminal characteristics.
1098 1531
1099=item $x_display = $term->display_id 1532=item $x_display = $term->display_id
1100 1533
1107=item $env = $term->env 1540=item $env = $term->env
1108 1541
1109Returns a copy of the environment in effect for the terminal as a hashref 1542Returns a copy of the environment in effect for the terminal as a hashref
1110similar to C<\%ENV>. 1543similar to C<\%ENV>.
1111 1544
1545=item @envv = $term->envv
1546
1547Returns the environment as array of strings of the form C<VAR=VALUE>.
1548
1549=item @argv = $term->argv
1550
1551Return the argument vector as this terminal, similar to @ARGV, but
1552includes the program name as first element.
1553
1112=cut 1554=cut
1113 1555
1114sub env { 1556sub env {
1115 if (my $env = $_[0]->_env) {
1116 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1557 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1117 } else {
1118 +{ %ENV }
1119 }
1120} 1558}
1121 1559
1122=item $modifiermask = $term->ModLevel3Mask 1560=item $modifiermask = $term->ModLevel3Mask
1123 1561
1124=item $modifiermask = $term->ModMetaMask 1562=item $modifiermask = $term->ModMetaMask
1126=item $modifiermask = $term->ModNumLockMask 1564=item $modifiermask = $term->ModNumLockMask
1127 1565
1128Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1566Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1129AltGr), the meta key (often Alt) and the num lock key, if applicable. 1567AltGr), the meta key (often Alt) and the num lock key, if applicable.
1130 1568
1569=item $screen = $term->current_screen
1570
1571Returns the currently displayed screen (0 primary, 1 secondary).
1572
1573=item $cursor_is_hidden = $term->hidden_cursor
1574
1575Returns whether the cursor is currently hidden or not.
1576
1131=item $view_start = $term->view_start ([$newvalue]) 1577=item $view_start = $term->view_start ([$newvalue])
1132 1578
1133Returns the negative row number of the topmost line. Minimum value is 1579Returns the row number of the topmost displayed line. Maximum value is
1134C<0>, which displays the normal terminal contents. Larger values scroll 1580C<0>, which displays the normal terminal contents. Lower values scroll
1135this many lines into the scrollback buffer. 1581this many lines into the scrollback buffer.
1136 1582
1137=item $term->want_refresh 1583=item $term->want_refresh
1138 1584
1139Requests a screen refresh. At the next opportunity, rxvt-unicode will 1585Requests a screen refresh. At the next opportunity, rxvt-unicode will
1154line, starting at column C<$start_col> (default C<0>), which is useful 1600line, starting at column C<$start_col> (default C<0>), which is useful
1155to replace only parts of a line. The font index in the rendition will 1601to replace only parts of a line. The font index in the rendition will
1156automatically be updated. 1602automatically be updated.
1157 1603
1158C<$text> is in a special encoding: tabs and wide characters that use more 1604C<$text> is in a special encoding: tabs and wide characters that use more
1159than one cell when displayed are padded with urxvt::NOCHAR characters 1605than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1160(C<chr 65535>). Characters with combining characters and other characters 1606characters. Characters with combining characters and other characters that
1161that do not fit into the normal tetx encoding will be replaced with 1607do not fit into the normal tetx encoding will be replaced with characters
1162characters in the private use area. 1608in the private use area.
1163 1609
1164You have to obey this encoding when changing text. The advantage is 1610You have to obey this encoding when changing text. The advantage is
1165that C<substr> and similar functions work on screen cells and not on 1611that C<substr> and similar functions work on screen cells and not on
1166characters. 1612characters.
1167 1613
1218Return the row number of the first/last row of the line, respectively. 1664Return the row number of the first/last row of the line, respectively.
1219 1665
1220=item $offset = $line->offset_of ($row, $col) 1666=item $offset = $line->offset_of ($row, $col)
1221 1667
1222Returns the character offset of the given row|col pair within the logical 1668Returns the character offset of the given row|col pair within the logical
1223line. 1669line. Works for rows outside the line, too, and returns corresponding
1670offsets outside the string.
1224 1671
1225=item ($row, $col) = $line->coord_of ($offset) 1672=item ($row, $col) = $line->coord_of ($offset)
1226 1673
1227Translates a string offset into terminal coordinates again. 1674Translates a string offset into terminal coordinates again.
1228 1675
1310where one character corresponds to one screen cell. See 1757where one character corresponds to one screen cell. See
1311C<< $term->ROW_t >> for details. 1758C<< $term->ROW_t >> for details.
1312 1759
1313=item $string = $term->special_decode $text 1760=item $string = $term->special_decode $text
1314 1761
1315Converts rxvt-unicodes text reprsentation into a perl string. See 1762Converts rxvt-unicodes text representation into a perl string. See
1316C<< $term->ROW_t >> for details. 1763C<< $term->ROW_t >> for details.
1317 1764
1318=item $success = $term->grab_button ($button, $modifiermask) 1765=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1319 1766
1767=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1768
1320Registers a synchronous button grab. See the XGrabButton manpage. 1769Register/unregister a synchronous button grab. See the XGrabButton
1770manpage.
1321 1771
1322=item $success = $term->grab ($eventtime[, $sync]) 1772=item $success = $term->grab ($eventtime[, $sync])
1323 1773
1324Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1774Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1325synchronous (C<$sync> is true). Also remembers the grab timestampe. 1775synchronous (C<$sync> is true). Also remembers the grab timestamp.
1326 1776
1327=item $term->allow_events_async 1777=item $term->allow_events_async
1328 1778
1329Calls XAllowEvents with AsyncBoth for the most recent grab. 1779Calls XAllowEvents with AsyncBoth for the most recent grab.
1330 1780
1340=item $term->ungrab 1790=item $term->ungrab
1341 1791
1342Calls XUngrab for the most recent grab. Is called automatically on 1792Calls XUngrab for the most recent grab. Is called automatically on
1343evaluation errors, as it is better to lose the grab in the error case as 1793evaluation errors, as it is better to lose the grab in the error case as
1344the session. 1794the session.
1795
1796=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1797
1798=item $atom_name = $term->XGetAtomName ($atom)
1799
1800=item @atoms = $term->XListProperties ($window)
1801
1802=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1803
1804=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1805
1806=item $term->XDeleteProperty ($window, $property)
1807
1808=item $window = $term->DefaultRootWindow
1809
1810=item $term->XReparentWindow ($window, $parent, [$x, $y])
1811
1812=item $term->XMapWindow ($window)
1813
1814=item $term->XUnmapWindow ($window)
1815
1816=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1817
1818=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1819
1820=item $term->XChangeInput ($window, $add_events[, $del_events])
1821
1822Various X or X-related functions. The C<$term> object only serves as
1823the source of the display, otherwise those functions map more-or-less
1824directory onto the X functions of the same name.
1345 1825
1346=back 1826=back
1347 1827
1348=cut 1828=cut
1349 1829
1413 my ($self, $text, $cb) = @_; 1893 my ($self, $text, $cb) = @_;
1414 1894
1415 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1895 $self->add_item ({ type => "button", text => $text, activate => $cb});
1416} 1896}
1417 1897
1418=item $popup->add_toggle ($text, $cb, $initial_value) 1898=item $popup->add_toggle ($text, $initial_value, $cb)
1419 1899
1420Adds a toggle/checkbox item to the popup. Teh callback gets called 1900Adds a toggle/checkbox item to the popup. The callback gets called
1421whenever it gets toggled, with a boolean indicating its value as its first 1901whenever it gets toggled, with a boolean indicating its new value as its
1422argument. 1902first argument.
1423 1903
1424=cut 1904=cut
1425 1905
1426sub add_toggle { 1906sub add_toggle {
1427 my ($self, $text, $cb, $value) = @_; 1907 my ($self, $text, $value, $cb) = @_;
1428 1908
1429 my $item; $item = { 1909 my $item; $item = {
1430 type => "button", 1910 type => "button",
1431 text => " $text", 1911 text => " $text",
1432 value => $value, 1912 value => $value,
1451 my $env = $self->{term}->env; 1931 my $env = $self->{term}->env;
1452 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1932 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1453 delete $env->{LC_ALL}; 1933 delete $env->{LC_ALL};
1454 $env->{LC_CTYPE} = $self->{term}->locale; 1934 $env->{LC_CTYPE} = $self->{term}->locale;
1455 1935
1456 urxvt::term->new ($env, $self->{term}->resource ("name"), 1936 urxvt::term->new ($env, "popup",
1457 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1937 "--perl-lib" => "", "--perl-ext-common" => "",
1938 "-pty-fd" => -1, "-sl" => 0,
1939 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1458 "--transient-for" => $self->{term}->parent, 1940 "--transient-for" => $self->{term}->parent,
1459 "-display" => $self->{term}->display_id, 1941 "-display" => $self->{term}->display_id,
1460 "-pe" => "urxvt-popup") 1942 "-pe" => "urxvt-popup")
1461 or die "unable to create popup window\n"; 1943 or die "unable to create popup window\n";
1462} 1944}
1467 delete $self->{term}{_destroy}{$self}; 1949 delete $self->{term}{_destroy}{$self};
1468 $self->{term}->ungrab; 1950 $self->{term}->ungrab;
1469} 1951}
1470 1952
1471=back 1953=back
1954
1955=cut
1956
1957package urxvt::watcher;
1472 1958
1473=head2 The C<urxvt::timer> Class 1959=head2 The C<urxvt::timer> Class
1474 1960
1475This class implements timer watchers/events. Time is represented as a 1961This class implements timer watchers/events. Time is represented as a
1476fractional number of seconds since the epoch. Example: 1962fractional number of seconds since the epoch. Example:
1514Start the timer. 2000Start the timer.
1515 2001
1516=item $timer = $timer->start ($tstamp) 2002=item $timer = $timer->start ($tstamp)
1517 2003
1518Set the event trigger time to C<$tstamp> and start the timer. 2004Set the event trigger time to C<$tstamp> and start the timer.
2005
2006=item $timer = $timer->after ($delay)
2007
2008Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1519 2009
1520=item $timer = $timer->stop 2010=item $timer = $timer->stop
1521 2011
1522Stop the timer. 2012Stop the timer.
1523 2013
1552Set the callback to be called when io events are triggered. C<$reventmask> 2042Set the callback to be called when io events are triggered. C<$reventmask>
1553is a bitset as described in the C<events> method. 2043is a bitset as described in the C<events> method.
1554 2044
1555=item $iow = $iow->fd ($fd) 2045=item $iow = $iow->fd ($fd)
1556 2046
1557Set the filedescriptor (not handle) to watch. 2047Set the file descriptor (not handle) to watch.
1558 2048
1559=item $iow = $iow->events ($eventmask) 2049=item $iow = $iow->events ($eventmask)
1560 2050
1561Set the event mask to watch. The only allowed values are 2051Set the event mask to watch. The only allowed values are
1562C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2052C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1566 2056
1567Start watching for requested events on the given handle. 2057Start watching for requested events on the given handle.
1568 2058
1569=item $iow = $iow->stop 2059=item $iow = $iow->stop
1570 2060
1571Stop watching for events on the given filehandle. 2061Stop watching for events on the given file handle.
2062
2063=back
2064
2065=head2 The C<urxvt::iw> Class
2066
2067This class implements idle watchers, that get called automatically when
2068the process is idle. They should return as fast as possible, after doing
2069some useful work.
2070
2071=over 4
2072
2073=item $iw = new urxvt::iw
2074
2075Create a new idle watcher object in stopped state.
2076
2077=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2078
2079Set the callback to be called when the watcher triggers.
2080
2081=item $timer = $timer->start
2082
2083Start the watcher.
2084
2085=item $timer = $timer->stop
2086
2087Stop the watcher.
2088
2089=back
2090
2091=head2 The C<urxvt::pw> Class
2092
2093This class implements process watchers. They create an event whenever a
2094process exits, after which they stop automatically.
2095
2096 my $pid = fork;
2097 ...
2098 $term->{pw} = urxvt::pw
2099 ->new
2100 ->start ($pid)
2101 ->cb (sub {
2102 my ($pw, $exit_status) = @_;
2103 ...
2104 });
2105
2106=over 4
2107
2108=item $pw = new urxvt::pw
2109
2110Create a new process watcher in stopped state.
2111
2112=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2113
2114Set the callback to be called when the timer triggers.
2115
2116=item $pw = $timer->start ($pid)
2117
2118Tells the watcher to start watching for process C<$pid>.
2119
2120=item $pw = $pw->stop
2121
2122Stop the watcher.
1572 2123
1573=back 2124=back
1574 2125
1575=head1 ENVIRONMENT 2126=head1 ENVIRONMENT
1576 2127
1583 2134
1584=item == 0 - fatal messages 2135=item == 0 - fatal messages
1585 2136
1586=item >= 3 - script loading and management 2137=item >= 3 - script loading and management
1587 2138
1588=item >=10 - all events received 2139=item >=10 - all called hooks
2140
2141=item >=11 - hook return values
1589 2142
1590=back 2143=back
1591 2144
1592=head1 AUTHOR 2145=head1 AUTHOR
1593 2146

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines