ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.114 by root, Fri Jan 20 12:16:28 2006 UTC vs.
Revision 1.218 by root, Sun Jun 10 17:31:53 2012 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
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be vewiwed
		38	using F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	@@RXVT_NAME@@ -pe <extensionname>
39		43
40	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions that add command line parameters or resources on their own are
45		49	laoded automatically when used.
46	=item selection (enabled by default)
47
48	(More) intelligent selection. This extension tries to be more intelligent
49	when the user extends selections (double-click and further clicks). Right
50	now, it tries to select words, urls and complete shell-quoted
51	arguments, which is very convenient, too, if your F<ls> supports
52	C<--quoting-style=shell>.
53
54	A double-click usually selects the word under the cursor, further clicks
55	will enlarge the selection.
56
57	The selection works by trying to match a number of regexes and displaying
58	them in increasing order of length. You can add your own regexes by
59	specifying resources of the form:
60
61	URxvt.selection.pattern-0: perl-regex
62	URxvt.selection.pattern-1: perl-regex
63	...
64
65	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything
68	between two vertical bars:
69
70	URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72	You can look at the source of the selection extension to see more
73	interesting uses, such as parsing a line from beginning to end.
74
75	This extension also offers following bindable keyboard commands:
76
77	=over 4
78
79	=item rot13
80
81	Rot-13 the selection when activated. Used via keyboard trigger:
82
83	URxvt.keysym.C-M-r: perl:selection:rot13
84
85	=back
86
87	=item option-popup (enabled by default)
88
89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90	runtime.
91
92	=item selection-popup (enabled by default)
93
94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95	text into various other formats/action (such as uri unescaping, perl
96	evalution, web-browser starting etc.), depending on content.
97
98	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100	popup is displayed.
101
102	It's sole argument is the popup menu, which can be modified. The selection
103	is in C<$_>, which can be used to decide wether to add something or not.
104	It should either return nothing or a string and a code reference. The
105	string will be used as button text and the code reference will be called
106	when the button gets activated and should transform C<$_>.
107
108	The following will add an entry C<a to b> that transforms all C<a>s in
109	the selection to C<b>s, but only if the selection currently contains any
110	C<a>s:
111
112	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }
114	: ()
115	};
116
117	=item searchable-scrollback<hotkey> (enabled by default)
118
119	Adds regex search functionality to the scrollback buffer, triggered
120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
121	input/output is suspended and a regex is displayed at the bottom of the
122	screen.
123
124	Inputting characters appends them to the regex and continues incremental
125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
127	bottom. C<Escape> leaves search mode and returns to the point where search
128	was started, while C<Enter> or C<Return> stay at the current position and
129	additionally stores the first match in the current line into the primary
130	selection.
131
132	=item selection-autotransform
133
134	This selection allows you to do automatic transforms on a selection
135	whenever a selection is made.
136
137	It works by specifying perl snippets (most useful is a single C<s///>
138	operator) that modify C<$_> as resources:
139
140	URxvt.selection-autotransform.0: transform
141	URxvt.selection-autotransform.1: transform
142	...
143
144	For example, the following will transform selections of the form
145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
146	$word>:
147
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149
150	And this example matches the same,but replaces it with vi-commands you can
151	paste directly into your (vi :) editor:
152
153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154
155	Of course, this can be modified to suit your needs and your editor :)
156
157	To expand the example above to typical perl error messages ("XXX at
158	FILENAME line YYY."), you need a slightly more elaborate solution:
159
160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163	The first line tells the selection code to treat the unchanging part of
164	every error message as a selection pattern, and the second line transforms
165	the message into vi commands to load the file.
166
167	=item mark-urls
168
169	Uses per-line display filtering (C<on_line_update>) to underline urls and
170	make them clickable. When middle-clicked, the program specified in the
171	resource C<urlLauncher> (default C<x-www-browser>) will be started with
172	the URL as first argument.
173
174	=item automove-background
175
176	This is basically a one-line extension that dynamically changes the background pixmap offset
177	to the window position, in effect creating the same effect as pseudo transparency with
178	a custom pixmap. No scaling is supported in this mode. Exmaple:
179
180	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
181
182	=item block-graphics-to-ascii
183
184	A not very useful example of filtering all text output to the terminal,
185	by replacing all line-drawing characters (U+2500 .. U+259F) by a
186	similar-looking ascii character.
187
188	=item digital-clock
189
190	Displays a digital clock using the built-in overlay.
191
192	=item example-refresh-hooks
193
194	Displays a very simple digital clock in the upper right corner of the
195	window. Illustrates overwriting the refresh callbacks to create your own
196	overlays or changes.
197
198	=item selection-pastebin
199
200	This is a little rarely useful extension that Uploads the selection as
201	textfile to a remote site (or does other things). (The implementation is
202	not currently secure for use in a multiuser environment as it writes to
203	F</tmp> directly.).
204
205	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
206	i.e.
207
208	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
209
210	Pressing this combination runs a command with C<%> replaced by the name of
211	the textfile. This command can be set via a resource:
212
213	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
214
215	And the default is likely not useful to anybody but the few people around
216	here :)
217
218	The name of the textfile is the hex encoded md5 sum of the selection, so
219	the same content should lead to the same filename.
220
221	After a successful upload the selection will be replaced by the text given
222	in the C<selection-pastebin-url> resource (again, the % is the placeholder
223	for the filename):
224
225	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
226
227	=back
228		50
229	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
230		52
231	=head2 General API Considerations	53	=head2 General API Considerations
232		54
…		…
246		68
247	=over 4	69	=over 4
248		70
249	=item $text	71	=item $text
250		72
251	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
252	always represents one screen cell. See L<ROW_t> for a discussion of this format.	74	always represents one screen cell. See L<ROW_t> for a discussion of this format.
253		75
254	=item $string	76	=item $string
255		77
256	A perl text string, with an emphasis on I<text>. It can store all unicode	78	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
260	=item $octets	82	=item $octets
261		83
262	Either binary data or - more common - a text string encoded in a	84	Either binary data or - more common - a text string encoded in a
263	locale-specific way.	85	locale-specific way.
264		86
		87	=item $keysym
		88
		89	an integer that is a valid X11 keysym code. You can convert a string
		90	into a keysym and viceversa by using C<XStringToKeysym> and
		91	C<XKeysymToString>.
		92
265	=back	93	=back
266		94
267	=head2 Extension Objects	95	=head2 Extension Objects
268		96
269	Very perl extension is a perl class. A separate perl object is created	97	Every perl extension is a perl class. A separate perl object is created
270	for each terminal and each extension and passed as the first parameter to	98	for each terminal, and each terminal has its own set of extension objects,
271	hooks. So extensions can use their C<$self> object without having to think	99	which are passed as the first parameter to hooks. So extensions can use
272	about other extensions, with the exception of methods and members that	100	their C<$self> object without having to think about clashes with other
		101	extensions or other terminals, with the exception of methods and members
273	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
274	use.	103	internal use.
275		104
276	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
277	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
278		107
279	It has the following methods and data members:	108	It has the following methods and data members:
…		…
300	=head2 Hooks	129	=head2 Hooks
301		130
302	The following subroutines can be declared in extension files, and will be	131	The following subroutines can be declared in extension files, and will be
303	called whenever the relevant event happens.	132	called whenever the relevant event happens.
304		133
305	The first argument passed to them is an extension oject as described in	134	The first argument passed to them is an extension object as described in
306	the in the C<Extension Objects> section.	135	the in the C<Extension Objects> section.
307		136
308	B<All> of these hooks must return a boolean value. If any of the called	137	B<All> of these hooks must return a boolean value. If any of the called
309	hooks returns true, then the event counts as being I<consumed>, and the	138	hooks returns true, then the event counts as being I<consumed>, and the
310	relevant action might not be carried out by the C++ code.	139	relevant action might not be carried out by the C++ code.
…		…
323	place.	152	place.
324		153
325	=item on_start $term	154	=item on_start $term
326		155
327	Called at the very end of initialisation of a new terminal, just before	156	Called at the very end of initialisation of a new terminal, just before
328	trying to map (display) the toplevel and returning to the mainloop.	157	trying to map (display) the toplevel and returning to the main loop.
329		158
330	=item on_destroy $term	159	=item on_destroy $term
331		160
332	Called whenever something tries to destroy terminal, before doing anything	161	Called whenever something tries to destroy terminal, when the terminal is
333	yet. If this hook returns true, then destruction is skipped, but this is	162	still fully functional (not for long, though).
334	rarely a good idea.
335		163
336	=item on_reset $term	164	=item on_reset $term
337		165
338	Called after the screen is "reset" for any reason, such as resizing or	166	Called after the screen is "reset" for any reason, such as resizing or
339	control sequences. Here is where you can react on changes to size-related	167	control sequences. Here is where you can react on changes to size-related
…		…
361		189
362	Called whenever a selection has been copied, but before the selection is	190	Called whenever a selection has been copied, but before the selection is
363	requested from the server. The selection text can be queried and changed	191	requested from the server. The selection text can be queried and changed
364	by calling C<< $term->selection >>.	192	by calling C<< $term->selection >>.
365		193
366	Returning a true value aborts selection grabbing. It will still be hilighted.	194	Returning a true value aborts selection grabbing. It will still be highlighted.
367		195
368	=item on_sel_extend $term	196	=item on_sel_extend $term
369		197
370	Called whenever the user tries to extend the selection (e.g. with a double	198	Called whenever the user tries to extend the selection (e.g. with a double
371	click) and is either supposed to return false (normal operation), or	199	click) and is either supposed to return false (normal operation), or
372	should extend the selection itelf and return true to suppress the built-in	200	should extend the selection itself and return true to suppress the built-in
373	processing. This can happen multiple times, as long as the callback	201	processing. This can happen multiple times, as long as the callback
374	returns true, it will be called on every further click by the user and is	202	returns true, it will be called on every further click by the user and is
375	supposed to enlarge the selection more and more, if possible.	203	supposed to enlarge the selection more and more, if possible.
376		204
377	See the F<selection> example extension.	205	See the F<selection> example extension.
378		206
379	=item on_view_change $term, $offset	207	=item on_view_change $term, $offset
380		208
381	Called whenever the view offset changes, i..e the user or program	209	Called whenever the view offset changes, i.e. the user or program
382	scrolls. Offset C<0> means display the normal terminal, positive values	210	scrolls. Offset C<0> means display the normal terminal, positive values
383	show this many lines of scrollback.	211	show this many lines of scrollback.
384		212
385	=item on_scroll_back $term, $lines, $saved	213	=item on_scroll_back $term, $lines, $saved
386		214
…		…
390		218
391	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	219	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
392	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	220	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
393	number of lines that will be in the scrollback buffer.	221	number of lines that will be in the scrollback buffer.
394		222
395	=item on_osc_seq $term, $string	223	=item on_osc_seq $term, $op, $args, $resp
		224
		225	Called on every OSC sequence and can be used to suppress it or modify its
		226	behaviour. The default should be to return an empty list. A true value
		227	suppresses execution of the request completely. Make sure you don't get
		228	confused by recursive invocations when you output an OSC sequence within
		229	this callback.
		230
		231	C<on_osc_seq_perl> should be used for new behaviour.
		232
		233	=item on_osc_seq_perl $term, $args, $resp
396		234
397	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	235	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
398	operating system command) is processed. Cursor position and other state	236	operating system command) is processed. Cursor position and other state
399	information is up-to-date when this happens. For interoperability, the	237	information is up-to-date when this happens. For interoperability, the
400	string should start with the extension name and a colon, to distinguish	238	string should start with the extension name (sans -osc) and a semicolon,
401	it from commands for other extensions, and this might be enforced in the	239	to distinguish it from commands for other extensions, and this might be
402	future.	240	enforced in the future.
		241
		242	For example, C<overlay-osc> uses this:
		243
		244	sub on_osc_seq_perl {
		245	my ($self, $osc, $resp) = @_;
		246
		247	return unless $osc =~ s/^overlay;//;
		248
		249	... process remaining $osc string
		250	}
403		251
404	Be careful not ever to trust (in a security sense) the data you receive,	252	Be careful not ever to trust (in a security sense) the data you receive,
405	as its source can not easily be controleld (e-mail content, messages from	253	as its source can not easily be controlled (e-mail content, messages from
406	other users on the same system etc.).	254	other users on the same system etc.).
		255
		256	For responses, C<$resp> contains the end-of-args separator used by the
		257	sender.
407		258
408	=item on_add_lines $term, $string	259	=item on_add_lines $term, $string
409		260
410	Called whenever text is about to be output, with the text as argument. You	261	Called whenever text is about to be output, with the text as argument. You
411	can filter/change and output the text yourself by returning a true value	262	can filter/change and output the text yourself by returning a true value
…		…
416	=item on_tt_write $term, $octets	267	=item on_tt_write $term, $octets
417		268
418	Called whenever some data is written to the tty/pty and can be used to	269	Called whenever some data is written to the tty/pty and can be used to
419	suppress or filter tty input.	270	suppress or filter tty input.
420		271
		272	=item on_tt_paste $term, $octets
		273
		274	Called whenever text is about to be pasted, with the text as argument. You
		275	can filter/change and paste the text yourself by returning a true value
		276	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		277	locale-encoded.
		278
421	=item on_line_update $term, $row	279	=item on_line_update $term, $row
422		280
423	Called whenever a line was updated or changed. Can be used to filter	281	Called whenever a line was updated or changed. Can be used to filter
424	screen output (e.g. underline urls or other useless stuff). Only lines	282	screen output (e.g. underline urls or other useless stuff). Only lines
425	that are being shown will be filtered, and, due to performance reasons,	283	that are being shown will be filtered, and, due to performance reasons,
…		…
432	later with the already-modified line (e.g. if unrelated parts change), so	290	later with the already-modified line (e.g. if unrelated parts change), so
433	you cannot just toggle rendition bits, but only set them.	291	you cannot just toggle rendition bits, but only set them.
434		292
435	=item on_refresh_begin $term	293	=item on_refresh_begin $term
436		294
437	Called just before the screen gets redrawn. Can be used for overlay	295	Called just before the screen gets redrawn. Can be used for overlay or
438	or similar effects by modify terminal contents in refresh_begin, and	296	similar effects by modifying the terminal contents in refresh_begin, and
439	restoring them in refresh_end. The built-in overlay and selection display	297	restoring them in refresh_end. The built-in overlay and selection display
440	code is run after this hook, and takes precedence.	298	code is run after this hook, and takes precedence.
441		299
442	=item on_refresh_end $term	300	=item on_refresh_end $term
443		301
444	Called just after the screen gets redrawn. See C<on_refresh_begin>.	302	Called just after the screen gets redrawn. See C<on_refresh_begin>.
445		303
446	=item on_keyboard_command $term, $string	304	=item on_user_command $term, $string
447		305
448	Called whenever the user presses a key combination that has a	306	Called whenever a user-configured event is being activated (e.g. via
449	C<perl:string> action bound to it (see description of the B<keysym>	307	a C<perl:string> action bound to a key, see description of the B<keysym>
450	resource in the @@RXVT_NAME@@(1) manpage).	308	resource in the @@RXVT_NAME@@(1) manpage).
		309
		310	The event is simply the action string. This interface is assumed to change
		311	slightly in the future.
		312
		313	=item on_register_command $term, $keysym, $modifiermask, $string
		314
		315	Called after parsing a keysym resource but before registering the
		316	associated binding. If this hook returns TRUE the binding is not
		317	registered. It can be used to modify a binding by calling
		318	C<register_command>.
		319
		320	=item on_resize_all_windows $term, $new_width, $new_height
		321
		322	Called just after the new window size has been calculated, but before
		323	windows are actually being resized or hints are being set. If this hook
		324	returns TRUE, setting of the window hints is being skipped.
451		325
452	=item on_x_event $term, $event	326	=item on_x_event $term, $event
453		327
454	Called on every X event received on the vt window (and possibly other	328	Called on every X event received on the vt window (and possibly other
455	windows). Should only be used as a last resort. Most event structure	329	windows). Should only be used as a last resort. Most event structure
456	members are not passed.	330	members are not passed.
457		331
		332	=item on_root_event $term, $event
		333
		334	Like C<on_x_event>, but is called for events on the root window.
		335
458	=item on_focus_in $term	336	=item on_focus_in $term
459		337
460	Called whenever the window gets the keyboard focus, before rxvt-unicode	338	Called whenever the window gets the keyboard focus, before rxvt-unicode
461	does focus in processing.	339	does focus in processing.
462		340
463	=item on_focus_out $term	341	=item on_focus_out $term
464		342
465	Called wheneever the window loses keyboard focus, before rxvt-unicode does	343	Called whenever the window loses keyboard focus, before rxvt-unicode does
466	focus out processing.	344	focus out processing.
467		345
468	=item on_configure_notify $term, $event	346	=item on_configure_notify $term, $event
469		347
		348	=item on_property_notify $term, $event
		349
470	=item on_key_press $term, $event, $keysym, $octets	350	=item on_key_press $term, $event, $keysym, $octets
471		351
472	=item on_key_release $term, $event, $keysym	352	=item on_key_release $term, $event, $keysym
473		353
474	=item on_button_press $term, $event	354	=item on_button_press $term, $event
…		…
479		359
480	=item on_map_notify $term, $event	360	=item on_map_notify $term, $event
481		361
482	=item on_unmap_notify $term, $event	362	=item on_unmap_notify $term, $event
483		363
484	Called whenever the corresponding X event is received for the terminal If	364	Called whenever the corresponding X event is received for the terminal. If
485	the hook returns true, then the even will be ignored by rxvt-unicode.	365	the hook returns true, then the event will be ignored by rxvt-unicode.
486		366
487	The event is a hash with most values as named by Xlib (see the XEvent	367	The event is a hash with most values as named by Xlib (see the XEvent
488	manpage), with the additional members C<row> and C<col>, which are the row	368	manpage), with the additional members C<row> and C<col>, which are the
489	and column under the mouse cursor.	369	(real, not screen-based) row and column under the mouse cursor.
490		370
491	C<on_key_press> additionally receives the string rxvt-unicode would	371	C<on_key_press> additionally receives the string rxvt-unicode would
492	output, if any, in locale-specific encoding.	372	output, if any, in locale-specific encoding.
493		373
494	subwindow.	374	subwindow.
…		…
500	=item on_wm_delete_window $term, $event	380	=item on_wm_delete_window $term, $event
501		381
502	Called when various types of ClientMessage events are received (all with	382	Called when various types of ClientMessage events are received (all with
503	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	383	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
504		384
		385	=item on_bell $term
		386
		387	Called on receipt of a bell character.
		388
505	=back	389	=back
506		390
507	=cut	391	=cut
508		392
509	package urxvt;	393	package urxvt;
510		394
511	use utf8;	395	use utf8;
512	use strict;	396	use strict 'vars';
513	use Carp ();	397	use Carp ();
514	use Scalar::Util ();	398	use Scalar::Util ();
515	use List::Util ();	399	use List::Util ();
516		400
517	our $VERSION = 1;	401	our $VERSION = 1;
518	our $TERM;	402	our $TERM;
519	our @TERM_INIT;	403	our @TERM_INIT; # should go, prevents async I/O etc.
520	our @TERM_EXT;	404	our @TERM_EXT; # should go, prevents async I/O etc.
521	our @HOOKNAME;	405	our @HOOKNAME;
522	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	406	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
523	our %OPTION;	407	our %OPTION;
524		408
525	our $LIBDIR;	409	our $LIBDIR;
526	our $RESNAME;	410	our $RESNAME;
527	our $RESCLASS;	411	our $RESCLASS;
528	our $RXVTNAME;	412	our $RXVTNAME;
529		413
		414	our $NOCHAR = chr 0xffff;
		415
530	=head2 Variables in the C<urxvt> Package	416	=head2 Variables in the C<urxvt> Package
531		417
532	=over 4	418	=over 4
533		419
534	=item $urxvt::LIBDIR	420	=item $urxvt::LIBDIR
…		…
549	The current terminal. This variable stores the current C<urxvt::term>	435	The current terminal. This variable stores the current C<urxvt::term>
550	object, whenever a callback/hook is executing.	436	object, whenever a callback/hook is executing.
551		437
552	=item @urxvt::TERM_INIT	438	=item @urxvt::TERM_INIT
553		439
554	All coderefs in this array will be called as methods of the next newly	440	All code references in this array will be called as methods of the next newly
555	created C<urxvt::term> object (during the C<on_init> phase). The array	441	created C<urxvt::term> object (during the C<on_init> phase). The array
556	gets cleared before the codereferences that were in it are being executed,	442	gets cleared before the code references that were in it are being executed,
557	so coderefs can push themselves onto it again if they so desire.	443	so references can push themselves onto it again if they so desire.
558		444
559	This complements to the perl-eval commandline option, but gets executed	445	This complements to the perl-eval command line option, but gets executed
560	first.	446	first.
561		447
562	=item @urxvt::TERM_EXT	448	=item @urxvt::TERM_EXT
563		449
564	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	450	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
571		457
572	=over 4	458	=over 4
573		459
574	=item urxvt::fatal $errormessage	460	=item urxvt::fatal $errormessage
575		461
576	Fatally aborts execution with the given error message. Avoid at all	462	Fatally aborts execution with the given error message (which should
577	costs! The only time this is acceptable is when the terminal process	463	include a trailing newline). Avoid at all costs! The only time this
578	starts up.	464	is acceptable (and useful) is in the init hook, where it prevents the
		465	terminal from starting up.
579		466
580	=item urxvt::warn $string	467	=item urxvt::warn $string
581		468
582	Calls C<rxvt_warn> with the given string which should not include a	469	Calls C<rxvt_warn> with the given string which should include a trailing
583	newline. The module also overwrites the C<warn> builtin with a function	470	newline. The module also overwrites the C<warn> builtin with a function
584	that calls this function.	471	that calls this function.
585		472
586	Using this function has the advantage that its output ends up in the	473	Using this function has the advantage that its output ends up in the
587	correct place, e.g. on stderr of the connecting urxvtc client.	474	correct place, e.g. on stderr of the connecting urxvtc client.
588		475
589	Messages have a size limit of 1023 bytes currently.	476	Messages have a size limit of 1023 bytes currently.
		477
		478	=item @terms = urxvt::termlist
		479
		480	Returns all urxvt::term objects that exist in this process, regardless of
		481	whether they are started, being destroyed etc., so be careful. Only term
		482	objects that have perl extensions attached will be returned (because there
		483	is no urxvt::term object associated with others).
590		484
591	=item $time = urxvt::NOW	485	=item $time = urxvt::NOW
592		486
593	Returns the "current time" (as per the event loop).	487	Returns the "current time" (as per the event loop).
594		488
…		…
637		531
638	=item $rend = urxvt::OVERLAY_RSTYLE	532	=item $rend = urxvt::OVERLAY_RSTYLE
639		533
640	Return the rendition mask used for overlays by default.	534	Return the rendition mask used for overlays by default.
641		535
642	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	536	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		537	urxvt::RS_RVid, urxvt::RS_Uline
643		538
644	Return the bit that enabled bold, italic, blink, reverse-video and	539	Return the bit that enabled bold, italic, blink, reverse-video and
645	underline, respectively. To enable such a style, just logically OR it into	540	underline, respectively. To enable such a style, just logically OR it into
646	the bitset.	541	the bitset.
647		542
…		…
652	Return the foreground/background colour index, respectively.	547	Return the foreground/background colour index, respectively.
653		548
654	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	549	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
655		550
656	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	551	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		552
		553	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
657		554
658	Replace the foreground/background colour in the rendition mask with the	555	Replace the foreground/background colour in the rendition mask with the
659	specified one.	556	specified one.
660		557
661	=item $value = urxvt::GET_CUSTOM $rend	558	=item $value = urxvt::GET_CUSTOM $rend
…		…
680	unless $msg =~ /\n$/;	577	unless $msg =~ /\n$/;
681	urxvt::warn ($msg);	578	urxvt::warn ($msg);
682	};	579	};
683	}	580	}
684		581
		582	no warnings 'utf8';
		583
		584	sub parse_resource {
		585	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		586
		587	$name =~ y/-/./ if $isarg;
		588
		589	$term->scan_meta;
		590
		591	my $r = $term->{meta}{resource};
		592	keys %$r; # reste iterator
		593	while (my ($pattern, $v) = each %$r) {
		594	if (
		595	$pattern =~ /\.$/
		596	? $pattern eq substr $name, 0, length $pattern
		597	: $pattern eq $name
		598	) {
		599	$name = "$urxvt::RESCLASS.$name";
		600
		601	push @{ $term->{perl_ext_3} }, $v->[0];
		602
		603	if ($v->[1] eq "boolean") {
		604	$term->put_option_db ($name, $flag ? "true" : "false");
		605	return 1;
		606	} else {
		607	$term->put_option_db ($name, $value);
		608	return 1 + 2;
		609	}
		610	}
		611	}
		612
		613	0
		614	}
		615
		616	sub usage {
		617	my ($term, $usage_type) = @_;
		618
		619	$term->scan_meta;
		620
		621	my $r = $term->{meta}{resource};
		622
		623	for my $pattern (sort keys %$r) {
		624	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		625
		626	$desc .= " (-pe $ext)";
		627
		628	if ($usage_type == 1) {
		629	$pattern =~ y/./-/;
		630	$pattern =~ s/-$/-.../g;
		631
		632	if ($type eq "boolean") {
		633	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		634	} else {
		635	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		636	}
		637	} else {
		638	$pattern =~ s/\.$/.*/g;
		639	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		640	}
		641	}
		642	}
		643
685	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	644	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
686		645
687	sub verbose {	646	sub verbose {
688	my ($level, $msg) = @_;	647	my ($level, $msg) = @_;
689	warn "$msg\n" if $level <= $verbosity;	648	warn "$msg\n" if $level <= $verbosity;
…		…
701	$pkg =~ s/[^[:word:]]/_/g;	660	$pkg =~ s/[^[:word:]]/_/g;
702	$pkg = "urxvt::ext::$pkg";	661	$pkg = "urxvt::ext::$pkg";
703		662
704	verbose 3, "loading extension '$path' into package '$pkg'";	663	verbose 3, "loading extension '$path' into package '$pkg'";
705		664
		665	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		666
706	open my $fh, "<:raw", $path	667	open my $fh, "<:raw", $path
707	or die "$path: $!";	668	or die "$path: $!";
708		669
709	my $source =	670	my $source =
710	"package $pkg; use strict; use utf8;\n"	671	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
711	. "#line 1 \"$path\"\n{\n"	672	. "#line 1 \"$path\"\n{\n"
712	. (do { local $/; <$fh> })	673	. (do { local $/; <$fh> })
713	. "\n};\n1";	674	. "\n};\n1";
714		675
715	eval $source	676	eval $source
…		…
725	sub invoke {	686	sub invoke {
726	local $TERM = shift;	687	local $TERM = shift;
727	my $htype = shift;	688	my $htype = shift;
728		689
729	if ($htype == 0) { # INIT	690	if ($htype == 0) { # INIT
730	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	691	my @dirs = $TERM->perl_libdirs;
731		692
732	my %ext_arg;	693	my %ext_arg;
733		694
734	{	695	{
735	my @init = @TERM_INIT;	696	my @init = @TERM_INIT;
736	@TERM_INIT = ();	697	@TERM_INIT = ();
…		…
738	my @pkg = @TERM_EXT;	699	my @pkg = @TERM_EXT;
739	@TERM_EXT = ();	700	@TERM_EXT = ();
740	$TERM->register_package ($_) for @pkg;	701	$TERM->register_package ($_) for @pkg;
741	}	702	}
742		703
		704	for (
		705	@{ delete $TERM->{perl_ext_3} },
743	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		707	) {
744	if ($_ eq "default") {	708	if ($_ eq "default") {
745	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	709	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
746	} elsif (/^-(.*)$/) {	710	} elsif (/^-(.*)$/) {
747	delete $ext_arg{$1};	711	delete $ext_arg{$1};
748	} elsif (/^([^<]+)<(.*)>$/) {	712	} elsif (/^([^<]+)<(.*)>$/) {
749	push @{ $ext_arg{$1} }, $2;	713	push @{ $ext_arg{$1} }, $2;
750	} else {	714	} else {
751	$ext_arg{$_} ||= [];	715	$ext_arg{$_} ||= [];
752	}	716	}
753	}	717	}
754		718
755	while (my ($ext, $argv) = each %ext_arg) {	719	for my $ext (sort keys %ext_arg) {
756	my @files = grep -f $_, map "$_/$ext", @dirs;	720	my @files = grep -f $_, map "$_/$ext", @dirs;
757		721
758	if (@files) {	722	if (@files) {
759	$TERM->register_package (extension_package $files[0], $argv);	723	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
760	} else {	724	} else {
761	warn "perl extension '$ext' not found in perl library search path\n";	725	warn "perl extension '$ext' not found in perl library search path\n";
762	}	726	}
763	}	727	}
764		728
…		…
770		734
771	if (my $cb = $TERM->{_hook}[$htype]) {	735	if (my $cb = $TERM->{_hook}[$htype]) {
772	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
773	if $verbosity >= 10;	737	if $verbosity >= 10;
774		738
775	keys %$cb;	739	for my $pkg (keys %$cb) {
776
777	while (my ($pkg, $cb) = each %$cb) {
778	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
779	$retval ||= $retval_;	741	$retval ||= $retval_;
780		742
781	if ($@) {	743	if ($@) {
782	$TERM->ungrab; # better to lose the grab than the session	744	$TERM->ungrab; # better to lose the grab than the session
783	warn $@;	745	warn $@;
…		…
797	}	759	}
798		760
799	$retval	761	$retval
800	}	762	}
801		763
802	# urxvt::term::extension	764	sub SET_COLOR($$$) {
		765	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		766	}
		767
		768	sub rend2mask {
		769	no strict 'refs';
		770	my ($str, $mask) = (@_, 0);
		771	my %color = ( fg => undef, bg => undef );
		772	my @failed;
		773	for my $spec ( split /\s+/, $str ) {
		774	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		775	$color{lc($1)} = $2;
		776	} else {
		777	my $neg = $spec =~ s/^[-^]//;
		778	unless ( exists &{"RS_$spec"} ) {
		779	push @failed, $spec;
		780	next;
		781	}
		782	my $cur = &{"RS_$spec"};
		783	if ( $neg ) {
		784	$mask &= ~$cur;
		785	} else {
		786	$mask |= $cur;
		787	}
		788	}
		789	}
		790	($mask, @color{qw(fg bg)}, \@failed)
		791	}
803		792
804	package urxvt::term::extension;	793	package urxvt::term::extension;
805		794
806	sub enable {	795	sub enable {
807	my ($self, %hook) = @_;	796	my ($self, %hook) = @_;
…		…
862		851
863	sub urxvt::destroy_hook(&) {	852	sub urxvt::destroy_hook(&) {
864	bless \shift, urxvt::destroy_hook::	853	bless \shift, urxvt::destroy_hook::
865	}	854	}
866		855
		856	sub x_resource {
		857	my ($self, $name) = @_;
		858	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		859	$self->{term}->x_resource ($name)
		860	}
		861
		862	sub x_resource_boolean {
		863	my ($self, $name) = @_;
		864	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		865	$self->{term}->x_resource_boolean ($name)
		866	}
		867
867	package urxvt::anyevent;	868	package urxvt::anyevent;
868		869
869	=head2 The C<urxvt::anyevent> Class	870	=head2 The C<urxvt::anyevent> Class
870		871
871	The sole purpose of this class is to deliver an interface to the	872	The sole purpose of this class is to deliver an interface to the
872	C<AnyEvent> module - any module using it will work inside urxvt without	873	C<AnyEvent> module - any module using it will work inside urxvt without
873	further programming. The only exception is that you cannot wait on	874	further programming. The only exception is that you cannot wait on
874	condition variables, but non-blocking condvar use is ok. What this means	875	condition variables, but non-blocking condvar use is ok.
875	is that you cannot use blocking APIs, but the non-blocking variant should	876
876	work.	877	In practical terms this means is that you cannot use blocking APIs, but
		878	the non-blocking variant should work.
877		879
878	=cut	880	=cut
879		881
880	our $VERSION = 1;	882	our $VERSION = '5.23';
881		883
882	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	884	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
883	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	885	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
884		886
885	sub timer {	887	sub timer {
…		…
887		889
888	my $cb = $arg{cb};	890	my $cb = $arg{cb};
889		891
890	urxvt::timer	892	urxvt::timer
891	->new	893	->new
892	->start (urxvt::NOW + $arg{after})	894	->after ($arg{after}, $arg{interval})
893	->cb (sub {	895	->cb ($arg{interval} ? $cb : sub {
894	$_[0]->stop; # need to cancel manually	896	$_[0]->stop; # need to cancel manually
895	$cb->();	897	$cb->();
896	})	898	})
897	}	899	}
898		900
899	sub io {	901	sub io {
900	my ($class, %arg) = @_;	902	my ($class, %arg) = @_;
901		903
902	my $cb = $arg{cb};	904	my $cb = $arg{cb};
		905	my $fd = fileno $arg{fh};
		906	defined $fd or $fd = $arg{fh};
903		907
904	bless [$arg{fh}, urxvt::iow	908	bless [$arg{fh}, urxvt::iow
905	->new	909	->new
906	->fd (fileno $arg{fh})	910	->fd ($fd)
907	->events (($arg{poll} =~ /r/ ? 1 : 0)	911	->events (($arg{poll} =~ /r/ ? 1 : 0)
908	| ($arg{poll} =~ /w/ ? 2 : 0))	912	| ($arg{poll} =~ /w/ ? 2 : 0))
909	->start	913	->start
910	->cb (sub {	914	->cb ($cb)
911	$cb->(($_[1] & 1 ? 'r' : '')
912	. ($_[1] & 2 ? 'w' : ''));
913	})],
914	urxvt::anyevent::	915	], urxvt::anyevent::
		916	}
		917
		918	sub idle {
		919	my ($class, %arg) = @_;
		920
		921	my $cb = $arg{cb};
		922
		923	urxvt::iw
		924	->new
		925	->start
		926	->cb ($cb)
		927	}
		928
		929	sub child {
		930	my ($class, %arg) = @_;
		931
		932	my $cb = $arg{cb};
		933
		934	urxvt::pw
		935	->new
		936	->start ($arg{pid})
		937	->cb (sub {
		938	$_[0]->stop; # need to cancel manually
		939	$cb->($_[0]->rpid, $_[0]->rstatus);
		940	})
915	}	941	}
916		942
917	sub DESTROY {	943	sub DESTROY {
918	$_[0][1]->stop;	944	$_[0][1]->stop;
919	}	945	}
920		946
921	sub condvar {	947	# only needed for AnyEvent < 6 compatibility
922	bless \my $flag, urxvt::anyevent::condvar::	948	sub one_event {
923	}
924
925	sub urxvt::anyevent::condvar::broadcast {
926	${$_[0]}++;
927	}
928
929	sub urxvt::anyevent::condvar::wait {
930	unless (${$_[0]}) {
931	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	949	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
932	}
933	}	950	}
934		951
935	package urxvt::term;	952	package urxvt::term;
936		953
937	=head2 The C<urxvt::term> Class	954	=head2 The C<urxvt::term> Class
…		…
950	urxvt::verbose 6, "register package $pkg to $self";	967	urxvt::verbose 6, "register package $pkg to $self";
951		968
952	@{"$pkg\::ISA"} = urxvt::term::extension::;	969	@{"$pkg\::ISA"} = urxvt::term::extension::;
953		970
954	my $proxy = bless {	971	my $proxy = bless {
955	_pkg => $pkg,	972	_pkg => $pkg,
		973	_name => ${"$pkg\::_NAME"}, # hackish
956	argv => $argv,	974	argv => $argv,
957	}, $pkg;	975	}, $pkg;
958	Scalar::Util::weaken ($proxy->{term} = $self);	976	Scalar::Util::weaken ($proxy->{term} = $self);
959		977
960	$self->{_pkg}{$pkg} = $proxy;	978	$self->{_pkg}{$pkg} = $proxy;
961		979
…		…
964	$proxy->enable ($name => $ref);	982	$proxy->enable ($name => $ref);
965	}	983	}
966	}	984	}
967	}	985	}
968		986
		987	sub perl_libdirs {
		988	map { split /:/ }
		989	$_[0]->resource ("perl_lib"),
		990	$ENV{URXVT_PERL_LIB},
		991	"$ENV{HOME}/.urxvt/ext",
		992	"$LIBDIR/perl"
		993	}
		994
		995	sub scan_meta {
		996	my ($self) = @_;
		997	my @libdirs = perl_libdirs $self;
		998
		999	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1000
		1001	my %meta;
		1002
		1003	$self->{meta_libdirs} = join "\x00", @libdirs;
		1004	$self->{meta} = \%meta;
		1005
		1006	for my $dir (reverse @libdirs) {
		1007	opendir my $fh, $dir
		1008	or next;
		1009	for my $ext (readdir $fh) {
		1010	$ext ne "."
		1011	and $ext ne ".."
		1012	and open my $fh, "<", "$dir/$ext"
		1013	or next;
		1014
		1015	while (<$fh>) {
		1016	if (/^#:META:X_RESOURCE:(.*)/) {
		1017	my ($pattern, $type, $desc) = split /:/, $1;
		1018	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1019	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1020	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1021	} else {
		1022	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1023	}
		1024	} elsif (/^\s*(?:#|$)/) {
		1025	# skip other comments and empty lines
		1026	} else {
		1027	last; # stop parsing on first non-empty non-comment line
		1028	}
		1029	}
		1030	}
		1031	}
		1032	}
		1033
969	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
970		1035
971	Creates a new terminal, very similar as if you had started it with system	1036	Creates a new terminal, very similar as if you had started it with system
972	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1037	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
973	hash which defines the environment of the new terminal.	1038	hash which defines the environment of the new terminal.
974		1039
975	Croaks (and probably outputs an error message) if the new instance	1040	Croaks (and probably outputs an error message) if the new instance
976	couldn't be created. Returns C<undef> if the new instance didn't	1041	couldn't be created. Returns C<undef> if the new instance didn't
977	initialise perl, and the terminal object otherwise. The C<init> and	1042	initialise perl, and the terminal object otherwise. The C<init> and
978	C<start> hooks will be called during this call.	1043	C<start> hooks will be called before this call returns, and are free to
		1044	refer to global data (which is race free).
979		1045
980	=cut	1046	=cut
981		1047
982	sub new {	1048	sub new {
983	my ($class, $env, @args) = @_;	1049	my ($class, $env, @args) = @_;
984		1050
		1051	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1052	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1053
985	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1054	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
986	}	1055	}
987		1056
988	=item $term->destroy	1057	=item $term->destroy
989		1058
990	Destroy the terminal object (close the window, free resources	1059	Destroy the terminal object (close the window, free resources
…		…
1020		1089
1021	Returns true if the option specified by C<$optval> is enabled, and	1090	Returns true if the option specified by C<$optval> is enabled, and
1022	optionally change it. All option values are stored by name in the hash	1091	optionally change it. All option values are stored by name in the hash
1023	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1092	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1024		1093
1025	Here is a a likely non-exhaustive list of option names, please see the	1094	Here is a likely non-exhaustive list of option names, please see the
1026	source file F</src/optinc.h> to see the actual list:	1095	source file F</src/optinc.h> to see the actual list:
1027		1096
1028	borderLess console cursorBlink cursorUnderline hold iconic insecure	1097	borderLess buffered console cursorBlink cursorUnderline hold iconic
1029	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1098	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1030	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1099	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1031	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1100	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1032	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1101	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1033	transparent tripleclickwords utmpInhibit visualBell	1102	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1103	urgentOnBell utmpInhibit visualBell
1034		1104
1035	=item $value = $term->resource ($name[, $newval])	1105	=item $value = $term->resource ($name[, $newval])
1036		1106
1037	Returns the current resource value associated with a given name and	1107	Returns the current resource value associated with a given name and
1038	optionally sets a new value. Setting values is most useful in the C<init>	1108	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1047	likely change).	1117	likely change).
1048		1118
1049	Please note that resource strings will currently only be freed when the	1119	Please note that resource strings will currently only be freed when the
1050	terminal is destroyed, so changing options frequently will eat memory.	1120	terminal is destroyed, so changing options frequently will eat memory.
1051		1121
1052	Here is a a likely non-exhaustive list of resource names, not all of which	1122	Here is a likely non-exhaustive list of resource names, not all of which
1053	are supported in every build, please see the source file F</src/rsinc.h>	1123	are supported in every build, please see the source file F</src/rsinc.h>
1054	to see the actual list:	1124	to see the actual list:
1055		1125
1056	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1057	borderLess color cursorBlink cursorUnderline cutchars delete_key	1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1058	display_name embed ext_bwidth fade font geometry hold iconName	1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1059	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1129	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1130	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1060	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1061	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1132	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1062	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1133	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1063	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1134	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1064	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1135	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1065	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1136	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1066	secondaryScreen secondaryScroll selectstyle shade term_name title	1137	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1067	transient_for transparent transparent_all tripleclickwords utmpInhibit	1138	term_name title transient_for transparent tripleclickwords urgentOnBell
1068	visualBell	1139	utmpInhibit visualBell
1069		1140
1070	=cut	1141	=cut
1071		1142
1072	sub resource($$;$) {	1143	sub resource($$;$) {
1073	my ($self, $name) = (shift, shift);	1144	my ($self, $name) = (shift, shift);
1074	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1145	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1075	&urxvt::term::_resource	1146	goto &urxvt::term::_resource
1076	}	1147	}
1077		1148
1078	=item $value = $term->x_resource ($pattern)	1149	=item $value = $term->x_resource ($pattern)
1079		1150
1080	Returns the X-Resource for the given pattern, excluding the program or	1151	Returns the X-Resource for the given pattern, excluding the program or
1081	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1152	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1082	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1153	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1083	resource with that pattern exists.	1154	resource with that pattern exists.
1084		1155
		1156	Extensions that define extra resource or command line arguments also need
		1157	to call this method to access their values.
		1158
		1159	If the method is called on an extension object (basically, from an
		1160	extension), then the special prefix C<%.> will be replaced by the name of
		1161	the extension and a dot, and the lone string C<%> will be replcaed by the
		1162	extension name itself. This makes it possible to code extensions so you
		1163	can rename them and get a new set of commandline switches and resources
		1164	without having to change the actual code.
		1165
1085	This method should only be called during the C<on_start> hook, as there is	1166	This method should only be called during the C<on_start> hook, as there is
1086	only one resource database per display, and later invocations might return	1167	only one resource database per display, and later invocations might return
1087	the wrong resources.	1168	the wrong resources.
1088		1169
1089	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1170	=item $value = $term->x_resource_boolean ($pattern)
1090		1171
		1172	Like C<x_resource>, above, but interprets the string value as a boolean
		1173	and returns C<1> for true values, C<0> for false values and C<undef> if
		1174	the resource or option isn't specified.
		1175
		1176	You should always use this method to parse boolean resources.
		1177
		1178	=cut
		1179
		1180	sub x_resource_boolean {
		1181	my $res = &x_resource;
		1182
		1183	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1184	}
		1185
		1186	=item $success = $term->parse_keysym ($key, $octets)
		1187
1091	Adds a keymap translation exactly as specified via a resource. See the	1188	Adds a key binding exactly as specified via a resource. See the
1092	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1189	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1190
		1191	=item $term->register_command ($keysym, $modifiermask, $string)
		1192
		1193	Adds a key binding. This is a lower level api compared to
		1194	C<parse_keysym>, as it expects a parsed key description, and can be
		1195	used only inside either the C<on_init> hook, to add a binding, or the
		1196	C<on_register_command> hook, to modify a parsed binding.
1093		1197
1094	=item $rend = $term->rstyle ([$new_rstyle])	1198	=item $rend = $term->rstyle ([$new_rstyle])
1095		1199
1096	Return and optionally change the current rendition. Text that is output by	1200	Return and optionally change the current rendition. Text that is output by
1097	the terminal application will use this style.	1201	the terminal application will use this style.
…		…
1105		1209
1106	=item ($row, $col) = $term->selection_beg ([$row, $col])	1210	=item ($row, $col) = $term->selection_beg ([$row, $col])
1107		1211
1108	=item ($row, $col) = $term->selection_end ([$row, $col])	1212	=item ($row, $col) = $term->selection_end ([$row, $col])
1109		1213
1110	Return the current values of the selection mark, begin or end positions,	1214	Return the current values of the selection mark, begin or end positions.
1111	and optionally set them to new values.	1215
		1216	When arguments are given, then the selection coordinates are set to
		1217	C<$row> and C<$col>, and the selection screen is set to the current
		1218	screen.
		1219
		1220	=item $screen = $term->selection_screen ([$screen])
		1221
		1222	Returns the current selection screen, and then optionally sets it.
1112		1223
1113	=item $term->selection_make ($eventtime[, $rectangular])	1224	=item $term->selection_make ($eventtime[, $rectangular])
1114		1225
1115	Tries to make a selection as set by C<selection_beg> and	1226	Tries to make a selection as set by C<selection_beg> and
1116	C<selection_end>. If C<$rectangular> is true (default: false), a	1227	C<selection_end>. If C<$rectangular> is true (default: false), a
1117	rectangular selection will be made. This is the prefered function to make	1228	rectangular selection will be made. This is the preferred function to make
1118	a selection.	1229	a selection.
1119		1230
1120	=item $success = $term->selection_grab ($eventtime)	1231	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1121		1232
1122	Try to request the primary selection text from the server (for example, as	1233	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1234	true) selection from the server. The corresponding text can be set
1123	set by the next method). No visual feedback will be given. This function	1235	with the next method. No visual feedback will be given. This function
1124	is mostly useful from within C<on_sel_grab> hooks.	1236	is mostly useful from within C<on_sel_grab> hooks.
1125		1237
1126	=item $oldtext = $term->selection ([$newtext])	1238	=item $oldtext = $term->selection ([$newtext, $clipboard])
1127		1239
1128	Return the current selection text and optionally replace it by C<$newtext>.	1240	Return the current selection (clipboard if C<$clipboard> is true) text
		1241	and optionally replace it by C<$newtext>.
		1242
		1243	=item $term->selection_clear ([$clipboard])
		1244
		1245	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1129		1246
1130	=item $term->overlay_simple ($x, $y, $text)	1247	=item $term->overlay_simple ($x, $y, $text)
1131		1248
1132	Create a simple multi-line overlay box. See the next method for details.	1249	Create a simple multi-line overlay box. See the next method for details.
1133		1250
…		…
1163		1280
1164	The methods currently supported on C<urxvt::overlay> objects are:	1281	The methods currently supported on C<urxvt::overlay> objects are:
1165		1282
1166	=over 4	1283	=over 4
1167		1284
1168	=item $overlay->set ($x, $y, $text, $rend)	1285	=item $overlay->set ($x, $y, $text[, $rend])
1169		1286
1170	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1287	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1171	text in rxvt-unicode's special encoding and an array of rendition values	1288	text in rxvt-unicode's special encoding and an array of rendition values
1172	at a specific position inside the overlay.	1289	at a specific position inside the overlay.
		1290
		1291	If C<$rend> is missing, then the rendition will not be changed.
1173		1292
1174	=item $overlay->hide	1293	=item $overlay->hide
1175		1294
1176	If visible, hide the overlay, but do not destroy it.	1295	If visible, hide the overlay, but do not destroy it.
1177		1296
…		…
1247		1366
1248	Normally its not a good idea to use this function, as programs might be	1367	Normally its not a good idea to use this function, as programs might be
1249	confused by changes in cursor position or scrolling. Its useful inside a	1368	confused by changes in cursor position or scrolling. Its useful inside a
1250	C<on_add_lines> hook, though.	1369	C<on_add_lines> hook, though.
1251		1370
		1371	=item $term->scr_change_screen ($screen)
		1372
		1373	Switch to given screen - 0 primary, 1 secondary.
		1374
1252	=item $term->cmd_parse ($octets)	1375	=item $term->cmd_parse ($octets)
1253		1376
1254	Similar to C<scr_add_lines>, but the argument must be in the	1377	Similar to C<scr_add_lines>, but the argument must be in the
1255	locale-specific encoding of the terminal and can contain command sequences	1378	locale-specific encoding of the terminal and can contain command sequences
1256	(escape codes) that will be interpreted.	1379	(escape codes) that will be interpreted.
1257		1380
1258	=item $term->tt_write ($octets)	1381	=item $term->tt_write ($octets)
1259		1382
1260	Write the octets given in C<$data> to the tty (i.e. as program input). To	1383	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1261	pass characters instead of octets, you should convert your strings first	1384	pass characters instead of octets, you should convert your strings first
1262	to the locale-specific encoding using C<< $term->locale_encode >>.	1385	to the locale-specific encoding using C<< $term->locale_encode >>.
		1386
		1387	=item $term->tt_paste ($octets)
		1388
		1389	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1390	CR and bracketing the data with control sequences if bracketed paste mode
		1391	is set.
1263		1392
1264	=item $old_events = $term->pty_ev_events ([$new_events])	1393	=item $old_events = $term->pty_ev_events ([$new_events])
1265		1394
1266	Replaces the event mask of the pty watcher by the given event mask. Can	1395	Replaces the event mask of the pty watcher by the given event mask. Can
1267	be used to suppress input and output handling to the pty/tty. See the	1396	be used to suppress input and output handling to the pty/tty. See the
1268	description of C<< urxvt::timer->events >>. Make sure to always restore	1397	description of C<< urxvt::timer->events >>. Make sure to always restore
1269	the previous value.	1398	the previous value.
1270		1399
		1400	=item $fd = $term->pty_fd
		1401
		1402	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1403	is used.
		1404
1271	=item $windowid = $term->parent	1405	=item $windowid = $term->parent
1272		1406
1273	Return the window id of the toplevel window.	1407	Return the window id of the toplevel window.
1274		1408
1275	=item $windowid = $term->vt	1409	=item $windowid = $term->vt
…		…
1281	Adds the specified events to the vt event mask. Useful e.g. when you want	1415	Adds the specified events to the vt event mask. Useful e.g. when you want
1282	to receive pointer events all the times:	1416	to receive pointer events all the times:
1283		1417
1284	$term->vt_emask_add (urxvt::PointerMotionMask);	1418	$term->vt_emask_add (urxvt::PointerMotionMask);
1285		1419
		1420	=item $term->set_urgency ($set)
		1421
		1422	Enable/disable the urgency hint on the toplevel window.
		1423
		1424	=item $term->focus_in
		1425
		1426	=item $term->focus_out
		1427
		1428	=item $term->key_press ($state, $keycode[, $time])
		1429
		1430	=item $term->key_release ($state, $keycode[, $time])
		1431
		1432	Deliver various fake events to to terminal.
		1433
1286	=item $window_width = $term->width	1434	=item $window_width = $term->width
1287		1435
1288	=item $window_height = $term->height	1436	=item $window_height = $term->height
1289		1437
1290	=item $font_width = $term->fwidth	1438	=item $font_width = $term->fwidth
…		…
1320	=item $env = $term->env	1468	=item $env = $term->env
1321		1469
1322	Returns a copy of the environment in effect for the terminal as a hashref	1470	Returns a copy of the environment in effect for the terminal as a hashref
1323	similar to C<\%ENV>.	1471	similar to C<\%ENV>.
1324		1472
		1473	=item @envv = $term->envv
		1474
		1475	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1476
		1477	=item @argv = $term->argv
		1478
		1479	Return the argument vector as this terminal, similar to @ARGV, but
		1480	includes the program name as first element.
		1481
1325	=cut	1482	=cut
1326		1483
1327	sub env {	1484	sub env {
1328	if (my $env = $_[0]->_env) {
1329	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1485	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1330	} else {
1331	+{ %ENV }
1332	}
1333	}	1486	}
1334		1487
1335	=item $modifiermask = $term->ModLevel3Mask	1488	=item $modifiermask = $term->ModLevel3Mask
1336		1489
1337	=item $modifiermask = $term->ModMetaMask	1490	=item $modifiermask = $term->ModMetaMask
1338		1491
1339	=item $modifiermask = $term->ModNumLockMask	1492	=item $modifiermask = $term->ModNumLockMask
1340		1493
1341	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1494	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1342	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1495	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1496
		1497	=item $screen = $term->current_screen
		1498
		1499	Returns the currently displayed screen (0 primary, 1 secondary).
		1500
		1501	=item $cursor_is_hidden = $term->hidden_cursor
		1502
		1503	Returns whether the cursor is currently hidden or not.
1343		1504
1344	=item $view_start = $term->view_start ([$newvalue])	1505	=item $view_start = $term->view_start ([$newvalue])
1345		1506
1346	Returns the row number of the topmost displayed line. Maximum value is	1507	Returns the row number of the topmost displayed line. Maximum value is
1347	C<0>, which displays the normal terminal contents. Lower values scroll	1508	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1355		1516
1356	Used after changing terminal contents to display them.	1517	Used after changing terminal contents to display them.
1357		1518
1358	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1359		1520
1360	Returns the text of the entire row with number C<$row_number>. Row C<0>	1521	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1361	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1522	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1362	terminal line. The scrollback buffer starts at line C<-1> and extends to
1363	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1523	terminal line. Nothing will be returned if a nonexistent line
1364	is requested.	1524	is requested.
1365		1525
1366	If C<$new_text> is specified, it will replace characters in the current	1526	If C<$new_text> is specified, it will replace characters in the current
1367	line, starting at column C<$start_col> (default C<0>), which is useful	1527	line, starting at column C<$start_col> (default C<0>), which is useful
1368	to replace only parts of a line. The font index in the rendition will	1528	to replace only parts of a line. The font index in the rendition will
1369	automatically be updated.	1529	automatically be updated.
1370		1530
1371	C<$text> is in a special encoding: tabs and wide characters that use more	1531	C<$text> is in a special encoding: tabs and wide characters that use more
1372	than one cell when displayed are padded with urxvt::NOCHAR characters	1532	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1373	(C<chr 65535>). Characters with combining characters and other characters	1533	characters. Characters with combining characters and other characters that
1374	that do not fit into the normal tetx encoding will be replaced with	1534	do not fit into the normal text encoding will be replaced with characters
1375	characters in the private use area.	1535	in the private use area.
1376		1536
1377	You have to obey this encoding when changing text. The advantage is	1537	You have to obey this encoding when changing text. The advantage is
1378	that C<substr> and similar functions work on screen cells and not on	1538	that C<substr> and similar functions work on screen cells and not on
1379	characters.	1539	characters.
1380		1540
…		…
1524	where one character corresponds to one screen cell. See	1684	where one character corresponds to one screen cell. See
1525	C<< $term->ROW_t >> for details.	1685	C<< $term->ROW_t >> for details.
1526		1686
1527	=item $string = $term->special_decode $text	1687	=item $string = $term->special_decode $text
1528		1688
1529	Converts rxvt-unicodes text reprsentation into a perl string. See	1689	Converts rxvt-unicodes text representation into a perl string. See
1530	C<< $term->ROW_t >> for details.	1690	C<< $term->ROW_t >> for details.
1531		1691
1532	=item $success = $term->grab_button ($button, $modifiermask)	1692	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1533		1693
		1694	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1695
1534	Registers a synchronous button grab. See the XGrabButton manpage.	1696	Register/unregister a synchronous button grab. See the XGrabButton
		1697	manpage.
1535		1698
1536	=item $success = $term->grab ($eventtime[, $sync])	1699	=item $success = $term->grab ($eventtime[, $sync])
1537		1700
1538	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1701	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1539	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1702	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1540		1703
1541	=item $term->allow_events_async	1704	=item $term->allow_events_async
1542		1705
1543	Calls XAllowEvents with AsyncBoth for the most recent grab.	1706	Calls XAllowEvents with AsyncBoth for the most recent grab.
1544		1707
…		…
1551	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1714	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1552	recent grab.	1715	recent grab.
1553		1716
1554	=item $term->ungrab	1717	=item $term->ungrab
1555		1718
1556	Calls XUngrab for the most recent grab. Is called automatically on	1719	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1557	evaluation errors, as it is better to lose the grab in the error case as	1720	evaluation errors, as it is better to lose the grab in the error case as
1558	the session.	1721	the session.
		1722
		1723	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1724
		1725	=item $atom_name = $term->XGetAtomName ($atom)
		1726
		1727	=item @atoms = $term->XListProperties ($window)
		1728
		1729	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1730
		1731	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1732
		1733	=item $term->XDeleteProperty ($window, $property)
		1734
		1735	=item $window = $term->DefaultRootWindow
		1736
		1737	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1738
		1739	=item $term->XMapWindow ($window)
		1740
		1741	=item $term->XUnmapWindow ($window)
		1742
		1743	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1744
		1745	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1746
		1747	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1748
		1749	=item $keysym = $term->XStringToKeysym ($string)
		1750
		1751	=item $string = $term->XKeysymToString ($keysym)
		1752
		1753	Various X or X-related functions. The C<$term> object only serves as
		1754	the source of the display, otherwise those functions map more-or-less
		1755	directly onto the X functions of the same name.
1559		1756
1560	=back	1757	=back
1561		1758
1562	=cut	1759	=cut
1563		1760
…		…
1627	my ($self, $text, $cb) = @_;	1824	my ($self, $text, $cb) = @_;
1628		1825
1629	$self->add_item ({ type => "button", text => $text, activate => $cb});	1826	$self->add_item ({ type => "button", text => $text, activate => $cb});
1630	}	1827	}
1631		1828
1632	=item $popup->add_toggle ($text, $cb, $initial_value)	1829	=item $popup->add_toggle ($text, $initial_value, $cb)
1633		1830
1634	Adds a toggle/checkbox item to the popup. Teh callback gets called	1831	Adds a toggle/checkbox item to the popup. The callback gets called
1635	whenever it gets toggled, with a boolean indicating its value as its first	1832	whenever it gets toggled, with a boolean indicating its new value as its
1636	argument.	1833	first argument.
1637		1834
1638	=cut	1835	=cut
1639		1836
1640	sub add_toggle {	1837	sub add_toggle {
1641	my ($self, $text, $cb, $value) = @_;	1838	my ($self, $text, $value, $cb) = @_;
1642		1839
1643	my $item; $item = {	1840	my $item; $item = {
1644	type => "button",	1841	type => "button",
1645	text => " $text",	1842	text => " $text",
1646	value => $value,	1843	value => $value,
…		…
1665	my $env = $self->{term}->env;	1862	my $env = $self->{term}->env;
1666	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1863	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1667	delete $env->{LC_ALL};	1864	delete $env->{LC_ALL};
1668	$env->{LC_CTYPE} = $self->{term}->locale;	1865	$env->{LC_CTYPE} = $self->{term}->locale;
1669		1866
1670	urxvt::term->new ($env, "popup",	1867	my $term = urxvt::term->new (
		1868	$env, "popup",
1671	"--perl-lib" => "", "--perl-ext-common" => "",	1869	"--perl-lib" => "", "--perl-ext-common" => "",
1672	"-pty-fd" => -1, "-sl" => 0,	1870	"-pty-fd" => -1, "-sl" => 0,
1673	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1871	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1674	"--transient-for" => $self->{term}->parent,	1872	"--transient-for" => $self->{term}->parent,
1675	"-display" => $self->{term}->display_id,	1873	"-display" => $self->{term}->display_id,
1676	"-pe" => "urxvt-popup")	1874	"-pe" => "urxvt-popup",
1677	or die "unable to create popup window\n";	1875	) or die "unable to create popup window\n";
		1876
		1877	unless (delete $term->{urxvt_popup_init_done}) {
		1878	$term->ungrab;
		1879	$term->destroy;
		1880	die "unable to initialise popup window\n";
		1881	}
1678	}	1882	}
1679		1883
1680	sub DESTROY {	1884	sub DESTROY {
1681	my ($self) = @_;	1885	my ($self) = @_;
1682		1886
…		…
1687	=back	1891	=back
1688		1892
1689	=cut	1893	=cut
1690		1894
1691	package urxvt::watcher;	1895	package urxvt::watcher;
1692
1693	@urxvt::timer::ISA = __PACKAGE__;
1694	@urxvt::iow::ISA = __PACKAGE__;
1695	@urxvt::pw::ISA = __PACKAGE__;
1696	@urxvt::iw::ISA = __PACKAGE__;
1697		1896
1698	=head2 The C<urxvt::timer> Class	1897	=head2 The C<urxvt::timer> Class
1699		1898
1700	This class implements timer watchers/events. Time is represented as a	1899	This class implements timer watchers/events. Time is represented as a
1701	fractional number of seconds since the epoch. Example:	1900	fractional number of seconds since the epoch. Example:
…		…
1705	->new	1904	->new
1706	->interval (1)	1905	->interval (1)
1707	->cb (sub {	1906	->cb (sub {
1708	$term->{overlay}->set (0, 0,	1907	$term->{overlay}->set (0, 0,
1709	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1908	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1710	});	1909	});
1711		1910
1712	=over 4	1911	=over 4
1713		1912
1714	=item $timer = new urxvt::timer	1913	=item $timer = new urxvt::timer
1715		1914
…		…
1718		1917
1719	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1918	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1720		1919
1721	Set the callback to be called when the timer triggers.	1920	Set the callback to be called when the timer triggers.
1722		1921
1723	=item $tstamp = $timer->at
1724
1725	Return the time this watcher will fire next.
1726
1727	=item $timer = $timer->set ($tstamp)	1922	=item $timer = $timer->set ($tstamp[, $interval])
1728		1923
1729	Set the time the event is generated to $tstamp.	1924	Set the time the event is generated to $tstamp (and optionally specifies a
		1925	new $interval).
1730		1926
1731	=item $timer = $timer->interval ($interval)	1927	=item $timer = $timer->interval ($interval)
1732		1928
1733	Normally (and when C<$interval> is C<0>), the timer will automatically	1929	By default (and when C<$interval> is C<0>), the timer will automatically
1734	stop after it has fired once. If C<$interval> is non-zero, then the timer	1930	stop after it has fired once. If C<$interval> is non-zero, then the timer
1735	is automatically rescheduled at the given intervals.	1931	is automatically rescheduled at the given intervals.
1736		1932
1737	=item $timer = $timer->start	1933	=item $timer = $timer->start
1738		1934
1739	Start the timer.	1935	Start the timer.
1740		1936
1741	=item $timer = $timer->start ($tstamp)	1937	=item $timer = $timer->start ($tstamp[, $interval])
1742		1938
1743	Set the event trigger time to C<$tstamp> and start the timer.	1939	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		1940	also replaces the interval.
1744		1941
1745	=item $timer = $timer->after ($delay)	1942	=item $timer = $timer->after ($delay[, $interval])
1746		1943
1747	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	1944	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1748		1945
1749	=item $timer = $timer->stop	1946	=item $timer = $timer->stop
1750		1947
…		…
1758		1955
1759	$term->{socket} = ...	1956	$term->{socket} = ...
1760	$term->{iow} = urxvt::iow	1957	$term->{iow} = urxvt::iow
1761	->new	1958	->new
1762	->fd (fileno $term->{socket})	1959	->fd (fileno $term->{socket})
1763	->events (urxvt::EVENT_READ)	1960	->events (urxvt::EV_READ)
1764	->start	1961	->start
1765	->cb (sub {	1962	->cb (sub {
1766	my ($iow, $revents) = @_;	1963	my ($iow, $revents) = @_;
1767	# $revents must be 1 here, no need to check	1964	# $revents must be 1 here, no need to check
1768	sysread $term->{socket}, my $buf, 8192	1965	sysread $term->{socket}, my $buf, 8192
…		…
1781	Set the callback to be called when io events are triggered. C<$reventmask>	1978	Set the callback to be called when io events are triggered. C<$reventmask>
1782	is a bitset as described in the C<events> method.	1979	is a bitset as described in the C<events> method.
1783		1980
1784	=item $iow = $iow->fd ($fd)	1981	=item $iow = $iow->fd ($fd)
1785		1982
1786	Set the filedescriptor (not handle) to watch.	1983	Set the file descriptor (not handle) to watch.
1787		1984
1788	=item $iow = $iow->events ($eventmask)	1985	=item $iow = $iow->events ($eventmask)
1789		1986
1790	Set the event mask to watch. The only allowed values are	1987	Set the event mask to watch. The only allowed values are
1791	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	1988	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1792	together, or C<urxvt::EVENT_NONE>.	1989	together, or C<urxvt::EV_NONE>.
1793		1990
1794	=item $iow = $iow->start	1991	=item $iow = $iow->start
1795		1992
1796	Start watching for requested events on the given handle.	1993	Start watching for requested events on the given handle.
1797		1994
1798	=item $iow = $iow->stop	1995	=item $iow = $iow->stop
1799		1996
1800	Stop watching for events on the given filehandle.	1997	Stop watching for events on the given file handle.
1801		1998
1802	=back	1999	=back
1803		2000
1804	=head2 The C<urxvt::iw> Class	2001	=head2 The C<urxvt::iw> Class
1805		2002
…		…
1838	->new	2035	->new
1839	->start ($pid)	2036	->start ($pid)
1840	->cb (sub {	2037	->cb (sub {
1841	my ($pw, $exit_status) = @_;	2038	my ($pw, $exit_status) = @_;
1842	...	2039	...
1843	});	2040	});
1844		2041
1845	=over 4	2042	=over 4
1846		2043
1847	=item $pw = new urxvt::pw	2044	=item $pw = new urxvt::pw
1848		2045
…		…
1852		2049
1853	Set the callback to be called when the timer triggers.	2050	Set the callback to be called when the timer triggers.
1854		2051
1855	=item $pw = $timer->start ($pid)	2052	=item $pw = $timer->start ($pid)
1856		2053
1857	Tells the wqtcher to start watching for process C<$pid>.	2054	Tells the watcher to start watching for process C<$pid>.
1858		2055
1859	=item $pw = $pw->stop	2056	=item $pw = $pw->stop
1860		2057
1861	Stop the watcher.	2058	Stop the watcher.
1862		2059
…		…
1875		2072
1876	=item >= 3 - script loading and management	2073	=item >= 3 - script loading and management
1877		2074
1878	=item >=10 - all called hooks	2075	=item >=10 - all called hooks
1879		2076
1880	=item >=11 - hook reutrn values	2077	=item >=11 - hook return values
1881		2078
1882	=back	2079	=back
1883		2080
1884	=head1 AUTHOR	2081	=head1 AUTHOR
1885		2082
1886	Marc Lehmann <pcg@goof.com>	2083	Marc Lehmann <schmorp@schmorp.de>
1887	http://software.schmorp.de/pkg/rxvt-unicode	2084	http://software.schmorp.de/pkg/rxvt-unicode
1888		2085
1889	=cut	2086	=cut
1890		2087
1891	1	2088	1
		2089
		2090	# vim: sw=3:

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines