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.89 by root, Thu Jan 12 12:10:06 2006 UTC vs.
Revision 1.219 by sf-exg, Sun Jun 10 18:23:18 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 viewed
		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	=over 4	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	=item selection (enabled by default)	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	Extensions that add command line parameters or resources on their own are
45	when the user extends selections (double-click and further clicks). Right	49	loaded automatically when used.
46	now, it tries to select words, urls and complete shell-quoted
47	arguments, which is very convenient, too, if your F<ls> supports
48	C<--quoting-style=shell>.
49
50	A double-click usually selects the word under the cursor, further clicks
51	will enlarge the selection.
52
53	The selection works by trying to match a number of regexes and displaying
54	them in increasing order of length. You can add your own regexes by
55	specifying resources of the form:
56
57	URxvt.selection.pattern-0: perl-regex
58	URxvt.selection.pattern-1: perl-regex
59	...
60
61	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything
64	between two vertical bars:
65
66	URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.
70
71	This extension also offers the following bindable keyboard command:
72
73	=over 4
74
75	=item rot13
76
77	Rot-13 the selection when activated. Used via keyboard trigger:
78
79	URxvt.keysym.C-M-r: perl:selection:rot13
80
81	=back
82
83	=item option-popup (enabled by default)
84
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.
87
88	=item selection-popup (enabled by default)
89
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.
93
94	=item searchable-scrollback<hotkey> (enabled by default)
95
96	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
98	input/output is suspended and a regex is displayed at the bottom of the
99	screen.
100
101	Inputting characters appends them to the regex and continues incremental
102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
104	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary
107	selection.
108
109	=item selection-autotransform
110
111	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.
113
114	It works by specifying perl snippets (most useful is a single C<s///>
115	operator) that modify C<$_> as resources:
116
117	URxvt.selection-autotransform.0: transform
118	URxvt.selection-autotransform.1: transform
119	...
120
121	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:
124
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126
127	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:
129
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131
132	=item mark-urls
133
134	Uses per-line display filtering (C<on_line_update>) to underline urls and
135	make them clickable. When middle-clicked, the program specified in the
136	resource C<urlLauncher> (default C<x-www-browser>) will be started with
137	the URL as first argument.
138
139	=item block-graphics-to-ascii
140
141	A not very useful example of filtering all text output to the terminal,
142	by replacing all line-drawing characters (U+2500 .. U+259F) by a
143	similar-looking ascii character.
144
145	=item digital-clock
146
147	Displays a digital clock using the built-in overlay.
148
149	=item example-refresh-hooks
150
151	Displays a very simple digital clock in the upper right corner of the
152	window. Illustrates overwriting the refresh callbacks to create your own
153	overlays or changes.
154
155	=back
156		50
157	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
158		52
159	=head2 General API Considerations	53	=head2 General API Considerations
160		54
…		…
174		68
175	=over 4	69	=over 4
176		70
177	=item $text	71	=item $text
178		72
179	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
180	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.
181		75
182	=item $string	76	=item $string
183		77
184	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
…		…
188	=item $octets	82	=item $octets
189		83
190	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
191	locale-specific way.	85	locale-specific way.
192		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
193	=back	93	=back
194		94
195	=head2 Extension Objects	95	=head2 Extension Objects
196		96
197	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
198	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,
199	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
200	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
201	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
202	use.	103	internal use.
203		104
204	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
205	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
206		107
207	It has the following methods and data members:	108	It has the following methods and data members:
…		…
228	=head2 Hooks	129	=head2 Hooks
229		130
230	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
231	called whenever the relevant event happens.	132	called whenever the relevant event happens.
232		133
233	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
234	the in the C<Extension Objects> section.	135	the in the C<Extension Objects> section.
235		136
236	B<All> of these hooks must return a boolean value. If it is true, then the	137	B<All> of these hooks must return a boolean value. If any of the called
237	event counts as being I<consumed>, and the invocation of other hooks is	138	hooks returns true, then the event counts as being I<consumed>, and the
238	skipped, and the relevant action might not be carried out by the C++ code.	139	relevant action might not be carried out by the C++ code.
239		140
240	I<< When in doubt, return a false value (preferably C<()>). >>	141	I<< When in doubt, return a false value (preferably C<()>). >>
241		142
242	=over 4	143	=over 4
243		144
244	=item on_init $term	145	=item on_init $term
245		146
246	Called after a new terminal object has been initialized, but before	147	Called after a new terminal object has been initialized, but before
247	windows are created or the command gets run. Most methods are unsafe to	148	windows are created or the command gets run. Most methods are unsafe to
248	call or deliver senseless data, as terminal size and other characteristics	149	call or deliver senseless data, as terminal size and other characteristics
249	have not yet been determined. You can safely query and change resources,	150	have not yet been determined. You can safely query and change resources
250	though.	151	and options, though. For many purposes the C<on_start> hook is a better
		152	place.
		153
		154	=item on_start $term
		155
		156	Called at the very end of initialisation of a new terminal, just before
		157	trying to map (display) the toplevel and returning to the main loop.
		158
		159	=item on_destroy $term
		160
		161	Called whenever something tries to destroy terminal, when the terminal is
		162	still fully functional (not for long, though).
251		163
252	=item on_reset $term	164	=item on_reset $term
253		165
254	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
255	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
256	variables.	168	variables.
257		169
258	=item on_start $term	170	=item on_child_start $term, $pid
259		171
260	Called at the very end of initialisation of a new terminal, just before	172	Called just after the child process has been C<fork>ed.
261	returning to the mainloop.	173
		174	=item on_child_exit $term, $status
		175
		176	Called just after the child process has exited. C<$status> is the status
		177	from C<waitpid>.
262		178
263	=item on_sel_make $term, $eventtime	179	=item on_sel_make $term, $eventtime
264		180
265	Called whenever a selection has been made by the user, but before the	181	Called whenever a selection has been made by the user, but before the
266	selection text is copied, so changes to the beginning, end or type of the	182	selection text is copied, so changes to the beginning, end or type of the
…		…
273		189
274	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
275	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
276	by calling C<< $term->selection >>.	192	by calling C<< $term->selection >>.
277		193
278	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.
279		195
280	=item on_sel_extend $term	196	=item on_sel_extend $term
281		197
282	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
283	click) and is either supposed to return false (normal operation), or	199	click) and is either supposed to return false (normal operation), or
284	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
285	processing. This can happen multiple times, as long as the callback	201	processing. This can happen multiple times, as long as the callback
286	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
287	supposed to enlarge the selection more and more, if possible.	203	supposed to enlarge the selection more and more, if possible.
288		204
289	See the F<selection> example extension.	205	See the F<selection> example extension.
290		206
291	=item on_view_change $term, $offset	207	=item on_view_change $term, $offset
292		208
293	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
294	scrolls. Offset C<0> means display the normal terminal, positive values	210	scrolls. Offset C<0> means display the normal terminal, positive values
295	show this many lines of scrollback.	211	show this many lines of scrollback.
296		212
297	=item on_scroll_back $term, $lines, $saved	213	=item on_scroll_back $term, $lines, $saved
298		214
…		…
302		218
303	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,
304	$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
305	number of lines that will be in the scrollback buffer.	221	number of lines that will be in the scrollback buffer.
306		222
307	=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
308		234
309	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	235	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
310	operating system command) is processed. Cursor position and other state	236	operating system command) is processed. Cursor position and other state
311	information is up-to-date when this happens. For interoperability, the	237	information is up-to-date when this happens. For interoperability, the
312	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,
313	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
314	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	}
315		251
316	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,
317	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
318	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.
319		258
320	=item on_add_lines $term, $string	259	=item on_add_lines $term, $string
321		260
322	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
323	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
…		…
328	=item on_tt_write $term, $octets	267	=item on_tt_write $term, $octets
329		268
330	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
331	suppress or filter tty input.	270	suppress or filter tty input.
332		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
333	=item on_line_update $term, $row	279	=item on_line_update $term, $row
334		280
335	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
336	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
337	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,
…		…
344	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
345	you cannot just toggle rendition bits, but only set them.	291	you cannot just toggle rendition bits, but only set them.
346		292
347	=item on_refresh_begin $term	293	=item on_refresh_begin $term
348		294
349	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
350	or similar effects by modify terminal contents in refresh_begin, and	296	similar effects by modifying the terminal contents in refresh_begin, and
351	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
352	code is run after this hook, and takes precedence.	298	code is run after this hook, and takes precedence.
353		299
354	=item on_refresh_end $term	300	=item on_refresh_end $term
355		301
356	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>.
357		303
358	=item on_keyboard_command $term, $string	304	=item on_user_command $term, $string
359		305
360	Called whenever the user presses a key combination that has a	306	Called whenever a user-configured event is being activated (e.g. via
361	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>
362	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.
		325
		326	=item on_x_event $term, $event
		327
		328	Called on every X event received on the vt window (and possibly other
		329	windows). Should only be used as a last resort. Most event structure
		330	members are not passed.
		331
		332	=item on_root_event $term, $event
		333
		334	Like C<on_x_event>, but is called for events on the root window.
363		335
364	=item on_focus_in $term	336	=item on_focus_in $term
365		337
366	Called whenever the window gets the keyboard focus, before rxvt-unicode	338	Called whenever the window gets the keyboard focus, before rxvt-unicode
367	does focus in processing.	339	does focus in processing.
368		340
369	=item on_focus_out $term	341	=item on_focus_out $term
370		342
371	Called wheneever the window loses keyboard focus, before rxvt-unicode does	343	Called whenever the window loses keyboard focus, before rxvt-unicode does
372	focus out processing.	344	focus out processing.
373		345
		346	=item on_configure_notify $term, $event
		347
		348	=item on_property_notify $term, $event
		349
374	=item on_key_press $term, $event, $keysym, $octets	350	=item on_key_press $term, $event, $keysym, $octets
375		351
376	=item on_key_release $term, $event, $keysym	352	=item on_key_release $term, $event, $keysym
377		353
378	=item on_button_press $term, $event	354	=item on_button_press $term, $event
…		…
383		359
384	=item on_map_notify $term, $event	360	=item on_map_notify $term, $event
385		361
386	=item on_unmap_notify $term, $event	362	=item on_unmap_notify $term, $event
387		363
388	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
389	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.
390		366
391	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
392	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
393	and column under the mouse cursor.	369	(real, not screen-based) row and column under the mouse cursor.
394		370
395	C<on_key_press> additionally receives the string rxvt-unicode would	371	C<on_key_press> additionally receives the string rxvt-unicode would
396	output, if any, in locale-specific encoding.	372	output, if any, in locale-specific encoding.
397		373
398	subwindow.	374	subwindow.
399		375
		376	=item on_client_message $term, $event
		377
		378	=item on_wm_protocols $term, $event
		379
		380	=item on_wm_delete_window $term, $event
		381
		382	Called when various types of ClientMessage events are received (all with
		383	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		384
		385	=item on_bell $term
		386
		387	Called on receipt of a bell character.
		388
400	=back	389	=back
401		390
402	=cut	391	=cut
403		392
404	package urxvt;	393	package urxvt;
405		394
406	use utf8;	395	use utf8;
407	use strict;	396	use strict 'vars';
408	use Carp ();	397	use Carp ();
409	use Scalar::Util ();	398	use Scalar::Util ();
410	use List::Util ();	399	use List::Util ();
411		400
412	our $VERSION = 1;	401	our $VERSION = 1;
413	our $TERM;	402	our $TERM;
		403	our @TERM_INIT; # should go, prevents async I/O etc.
		404	our @TERM_EXT; # should go, prevents async I/O etc.
414	our @HOOKNAME;	405	our @HOOKNAME;
415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	406	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
416	our %OPTION;	407	our %OPTION;
417		408
418	our $LIBDIR;	409	our $LIBDIR;
419	our $RESNAME;	410	our $RESNAME;
420	our $RESCLASS;	411	our $RESCLASS;
421	our $RXVTNAME;	412	our $RXVTNAME;
422		413
		414	our $NOCHAR = chr 0xffff;
		415
423	=head2 Variables in the C<urxvt> Package	416	=head2 Variables in the C<urxvt> Package
424		417
425	=over 4	418	=over 4
426		419
427	=item $urxvt::LIBDIR	420	=item $urxvt::LIBDIR
…		…
440	=item $urxvt::TERM	433	=item $urxvt::TERM
441		434
442	The current terminal. This variable stores the current C<urxvt::term>	435	The current terminal. This variable stores the current C<urxvt::term>
443	object, whenever a callback/hook is executing.	436	object, whenever a callback/hook is executing.
444		437
		438	=item @urxvt::TERM_INIT
		439
		440	All code references in this array will be called as methods of the next newly
		441	created C<urxvt::term> object (during the C<on_init> phase). The array
		442	gets cleared before the code references that were in it are being executed,
		443	so references can push themselves onto it again if they so desire.
		444
		445	This complements to the perl-eval command line option, but gets executed
		446	first.
		447
		448	=item @urxvt::TERM_EXT
		449
		450	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		451	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		452	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		453
445	=back	454	=back
446		455
447	=head2 Functions in the C<urxvt> Package	456	=head2 Functions in the C<urxvt> Package
448		457
449	=over 4	458	=over 4
450		459
451	=item urxvt::fatal $errormessage	460	=item urxvt::fatal $errormessage
452		461
453	Fatally aborts execution with the given error message. Avoid at all	462	Fatally aborts execution with the given error message (which should
454	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
455	starts up.	464	is acceptable (and useful) is in the init hook, where it prevents the
		465	terminal from starting up.
456		466
457	=item urxvt::warn $string	467	=item urxvt::warn $string
458		468
459	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
460	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
461	that calls this function.	471	that calls this function.
462		472
463	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
464	correct place, e.g. on stderr of the connecting urxvtc client.	474	correct place, e.g. on stderr of the connecting urxvtc client.
465		475
466	Messages have a size limit of 1023 bytes currently.	476	Messages have a size limit of 1023 bytes currently.
467		477
468	=item $is_safe = urxvt::safe	478	=item @terms = urxvt::termlist
469		479
470	Returns true when it is safe to do potentially unsafe things, such as	480	Returns all urxvt::term objects that exist in this process, regardless of
471	evaluating perl code specified by the user. This is true when urxvt was	481	whether they are started, being destroyed etc., so be careful. Only term
472	started setuid or setgid.	482	objects that have perl extensions attached will be returned (because there
		483	is no urxvt::term object associated with others).
473		484
474	=item $time = urxvt::NOW	485	=item $time = urxvt::NOW
475		486
476	Returns the "current time" (as per the event loop).	487	Returns the "current time" (as per the event loop).
477		488
478	=item urxvt::CurrentTime	489	=item urxvt::CurrentTime
479		490
480	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	491	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
481	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	492	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
482	Button4Mask, Button5Mask, AnyModifier	493	Button4Mask, Button5Mask, AnyModifier
		494
		495	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		496	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		497	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		498	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		499	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		500	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		501	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		502
		503	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		504	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		505	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		506	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		507	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		508	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		509	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
483		510
484	Various constants for use in X calls and event processing.	511	Various constants for use in X calls and event processing.
485		512
486	=back	513	=back
487		514
…		…
504		531
505	=item $rend = urxvt::OVERLAY_RSTYLE	532	=item $rend = urxvt::OVERLAY_RSTYLE
506		533
507	Return the rendition mask used for overlays by default.	534	Return the rendition mask used for overlays by default.
508		535
509	=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
510		538
511	Return the bit that enabled bold, italic, blink, reverse-video and	539	Return the bit that enabled bold, italic, blink, reverse-video and
512	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
513	the bitset.	541	the bitset.
514		542
…		…
520		548
521	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	549	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
522		550
523	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	551	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
524		552
		553	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		554
525	Replace the foreground/background colour in the rendition mask with the	555	Replace the foreground/background colour in the rendition mask with the
526	specified one.	556	specified one.
527		557
528	=item $value = urxvt::GET_CUSTOM $rend	558	=item $value = urxvt::GET_CUSTOM $rend
529		559
…		…
538	=back	568	=back
539		569
540	=cut	570	=cut
541		571
542	BEGIN {	572	BEGIN {
543	urxvt->bootstrap;
544
545	# overwrite perl's warn	573	# overwrite perl's warn
546	*CORE::GLOBAL::warn = sub {	574	*CORE::GLOBAL::warn = sub {
547	my $msg = join "", @_;	575	my $msg = join "", @_;
548	$msg .= "\n"	576	$msg .= "\n"
549	unless $msg =~ /\n$/;	577	unless $msg =~ /\n$/;
550	urxvt::warn ($msg);	578	urxvt::warn ($msg);
551	};	579	};
552
553	# %ENV is the original startup environment
554	delete $ENV{IFS};
555	delete $ENV{CDPATH};
556	delete $ENV{BASH_ENV};
557	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
558	}	580	}
559		581
560	my @hook_count;	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
561	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	644	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
562		645
563	sub verbose {	646	sub verbose {
564	my ($level, $msg) = @_;	647	my ($level, $msg) = @_;
565	warn "$msg\n" if $level <= $verbosity;	648	warn "$msg\n" if $level <= $verbosity;
566	}	649	}
567		650
568	my $extension_pkg = "extension0000";
569	my %extension_pkg;	651	my %extension_pkg;
570		652
571	# load a single script into its own package, once only	653	# load a single script into its own package, once only
572	sub extension_package($) {	654	sub extension_package($) {
573	my ($path) = @_;	655	my ($path) = @_;
574		656
575	$extension_pkg{$path} ||= do {	657	$extension_pkg{$path} ||= do {
576	my $pkg = "urxvt::" . ($extension_pkg++);	658	$path =~ /([^\/\\]+)$/;
		659	my $pkg = $1;
		660	$pkg =~ s/[^[:word:]]/_/g;
		661	$pkg = "urxvt::ext::$pkg";
577		662
578	verbose 3, "loading extension '$path' into package '$pkg'";	663	verbose 3, "loading extension '$path' into package '$pkg'";
		664
		665	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
579		666
580	open my $fh, "<:raw", $path	667	open my $fh, "<:raw", $path
581	or die "$path: $!";	668	or die "$path: $!";
582		669
583	my $source = untaint	670	my $source =
584	"package $pkg; use strict; use utf8;\n"	671	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
585	. "use base urxvt::term::extension::;\n"
586	. "#line 1 \"$path\"\n{\n"	672	. "#line 1 \"$path\"\n{\n"
587	. (do { local $/; <$fh> })	673	. (do { local $/; <$fh> })
588	. "\n};\n1";	674	. "\n};\n1";
589		675
590	eval $source	676	eval $source
…		…
600	sub invoke {	686	sub invoke {
601	local $TERM = shift;	687	local $TERM = shift;
602	my $htype = shift;	688	my $htype = shift;
603		689
604	if ($htype == 0) { # INIT	690	if ($htype == 0) { # INIT
605	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	691	my @dirs = $TERM->perl_libdirs;
606		692
607	my %ext_arg;	693	my %ext_arg;
608		694
		695	{
		696	my @init = @TERM_INIT;
		697	@TERM_INIT = ();
		698	$_->($TERM) for @init;
		699	my @pkg = @TERM_EXT;
		700	@TERM_EXT = ();
		701	$TERM->register_package ($_) for @pkg;
		702	}
		703
		704	for (
		705	@{ delete $TERM->{perl_ext_3} },
609	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		707	) {
610	if ($_ eq "default") {	708	if ($_ eq "default") {
611	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	709	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
612	} elsif (/^-(.*)$/) {	710	} elsif (/^-(.*)$/) {
613	delete $ext_arg{$1};	711	delete $ext_arg{$1};
614	} elsif (/^([^<]+)<(.*)>$/) {	712	} elsif (/^([^<]+)<(.*)>$/) {
615	push @{ $ext_arg{$1} }, $2;	713	push @{ $ext_arg{$1} }, $2;
616	} else {	714	} else {
617	$ext_arg{$_} ||= [];	715	$ext_arg{$_} ||= [];
618	}	716	}
619	}	717	}
620		718
621	while (my ($ext, $argv) = each %ext_arg) {	719	for my $ext (sort keys %ext_arg) {
622	my @files = grep -f $_, map "$_/$ext", @dirs;	720	my @files = grep -f $_, map "$_/$ext", @dirs;
623		721
624	if (@files) {	722	if (@files) {
625	$TERM->register_package (extension_package $files[0], $argv);	723	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
626	} else {	724	} else {
627	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";
628	}	726	}
629	}	727	}
630		728
…		…
636		734
637	if (my $cb = $TERM->{_hook}[$htype]) {	735	if (my $cb = $TERM->{_hook}[$htype]) {
638	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
639	if $verbosity >= 10;	737	if $verbosity >= 10;
640		738
641	keys %$cb;	739	for my $pkg (keys %$cb) {
642
643	while (my ($pkg, $cb) = each %$cb) {
644	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
645	and last;	741	$retval ||= $retval_;
646		742
647	if ($@) {	743	if ($@) {
648	$TERM->ungrab; # better to lose the grab than the session	744	$TERM->ungrab; # better to lose the grab than the session
649	warn $@;	745	warn $@;
650	}	746	}
…		…
653	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
654	if $verbosity >= 11;	750	if $verbosity >= 11;
655	}	751	}
656		752
657	if ($htype == 1) { # DESTROY	753	if ($htype == 1) { # DESTROY
658	if (my $hook = delete $TERM->{_hook}) {
659	for my $htype (0..$#$hook) {
660	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
661	or set_should_invoke $htype, 0;
662	}
663	}
664
665	# clear package objects	754	# clear package objects
666	%$_ = () for values %{ $TERM->{_pkg} };	755	%$_ = () for values %{ $TERM->{_pkg} };
667		756
668	# clear package	757	# clear package
669	%$TERM = ();	758	%$TERM = ();
670	}	759	}
671		760
672	$retval	761	$retval
673	}	762	}
674		763
675	sub exec_async(@) {	764	sub SET_COLOR($$$) {
676	my $pid = fork;	765	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
677
678	return
679	if !defined $pid or $pid;
680
681	%ENV = %{ $TERM->env };
682
683	exec @_;
684	_exit 255;
685	}	766	}
686		767
687	# urxvt::term::extension	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	}
688		792
689	package urxvt::term::extension;	793	package urxvt::term::extension;
690		794
691	sub enable {	795	sub enable {
692	my ($self, %hook) = @_;	796	my ($self, %hook) = @_;
…		…
695	while (my ($name, $cb) = each %hook) {	799	while (my ($name, $cb) = each %hook) {
696	my $htype = $HOOKTYPE{uc $name};	800	my $htype = $HOOKTYPE{uc $name};
697	defined $htype	801	defined $htype
698	or Carp::croak "unsupported hook type '$name'";	802	or Carp::croak "unsupported hook type '$name'";
699		803
		804	$self->set_should_invoke ($htype, +1)
700	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	805	unless exists $self->{term}{_hook}[$htype]{$pkg};
701	$hook_count[$htype]++
702	or urxvt::set_should_invoke $htype, 1;
703	}
704		806
705	$self->{term}{_hook}[$htype]{$pkg} = $cb;	807	$self->{term}{_hook}[$htype]{$pkg} = $cb;
706	}	808	}
707	}	809	}
708		810
…		…
713	for my $name (@hook) {	815	for my $name (@hook) {
714	my $htype = $HOOKTYPE{uc $name};	816	my $htype = $HOOKTYPE{uc $name};
715	defined $htype	817	defined $htype
716	or Carp::croak "unsupported hook type '$name'";	818	or Carp::croak "unsupported hook type '$name'";
717		819
		820	$self->set_should_invoke ($htype, -1)
718	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	821	if delete $self->{term}{_hook}[$htype]{$pkg};
719	--$hook_count[$htype]
720	or urxvt::set_should_invoke $htype, 0;
721	}
722	}	822	}
723	}	823	}
724		824
725	our $AUTOLOAD;	825	our $AUTOLOAD;
726		826
…		…
751		851
752	sub urxvt::destroy_hook(&) {	852	sub urxvt::destroy_hook(&) {
753	bless \shift, urxvt::destroy_hook::	853	bless \shift, urxvt::destroy_hook::
754	}	854	}
755		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
756	package urxvt::anyevent;	868	package urxvt::anyevent;
757		869
758	=head2 The C<urxvt::anyevent> Class	870	=head2 The C<urxvt::anyevent> Class
759		871
760	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
761	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
762	further programming. The only exception is that you cannot wait on	874	further programming. The only exception is that you cannot wait on
763	condition variables, but non-blocking condvar use is ok. What this means	875	condition variables, but non-blocking condvar use is ok.
764	is that you cannot use blocking APIs, but the non-blocking variant should	876
765	work.	877	In practical terms this means is that you cannot use blocking APIs, but
		878	the non-blocking variant should work.
766		879
767	=cut	880	=cut
768		881
769	our $VERSION = 1;	882	our $VERSION = '5.23';
770		883
771	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	884	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
772	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	885	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
773		886
774	sub timer {	887	sub timer {
…		…
776		889
777	my $cb = $arg{cb};	890	my $cb = $arg{cb};
778		891
779	urxvt::timer	892	urxvt::timer
780	->new	893	->new
781	->start (urxvt::NOW + $arg{after})	894	->after ($arg{after}, $arg{interval})
782	->cb (sub {	895	->cb ($arg{interval} ? $cb : sub {
783	$_[0]->stop; # need to cancel manually	896	$_[0]->stop; # need to cancel manually
784	$cb->();	897	$cb->();
785	})	898	})
786	}	899	}
787		900
788	sub io {	901	sub io {
789	my ($class, %arg) = @_;	902	my ($class, %arg) = @_;
790		903
791	my $cb = $arg{cb};	904	my $cb = $arg{cb};
		905	my $fd = fileno $arg{fh};
		906	defined $fd or $fd = $arg{fh};
792		907
793	bless [$arg{fh}, urxvt::iow	908	bless [$arg{fh}, urxvt::iow
794	->new	909	->new
795	->fd (fileno $arg{fh})	910	->fd ($fd)
796	->events (($arg{poll} =~ /r/ ? 1 : 0)	911	->events (($arg{poll} =~ /r/ ? 1 : 0)
797	| ($arg{poll} =~ /w/ ? 2 : 0))	912	| ($arg{poll} =~ /w/ ? 2 : 0))
798	->start	913	->start
799	->cb (sub {	914	->cb ($cb)
800	$cb->(($_[1] & 1 ? 'r' : '')
801	. ($_[1] & 2 ? 'w' : ''));
802	})],
803	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	})
804	}	941	}
805		942
806	sub DESTROY {	943	sub DESTROY {
807	$_[0][1]->stop;	944	$_[0][1]->stop;
808	}	945	}
809		946
810	sub condvar {	947	# only needed for AnyEvent < 6 compatibility
811	bless \my $flag, urxvt::anyevent::condvar::	948	sub one_event {
812	}
813
814	sub urxvt::anyevent::condvar::broadcast {
815	${$_[0]}++;
816	}
817
818	sub urxvt::anyevent::condvar::wait {
819	unless (${$_[0]}) {
820	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";
821	}
822	}	950	}
823		951
824	package urxvt::term;	952	package urxvt::term;
825		953
826	=head2 The C<urxvt::term> Class	954	=head2 The C<urxvt::term> Class
…		…
832	# find on_xxx subs in the package and register them	960	# find on_xxx subs in the package and register them
833	# as hooks	961	# as hooks
834	sub register_package {	962	sub register_package {
835	my ($self, $pkg, $argv) = @_;	963	my ($self, $pkg, $argv) = @_;
836		964
		965	no strict 'refs';
		966
		967	urxvt::verbose 6, "register package $pkg to $self";
		968
		969	@{"$pkg\::ISA"} = urxvt::term::extension::;
		970
837	my $proxy = bless {	971	my $proxy = bless {
838	_pkg => $pkg,	972	_pkg => $pkg,
		973	_name => ${"$pkg\::_NAME"}, # hackish
839	argv => $argv,	974	argv => $argv,
840	}, $pkg;	975	}, $pkg;
841	Scalar::Util::weaken ($proxy->{term} = $self);	976	Scalar::Util::weaken ($proxy->{term} = $self);
842		977
843	$self->{_pkg}{$pkg} = $proxy;	978	$self->{_pkg}{$pkg} = $proxy;
844		979
…		…
847	$proxy->enable ($name => $ref);	982	$proxy->enable ($name => $ref);
848	}	983	}
849	}	984	}
850	}	985	}
851		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
852	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
853		1035
854	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
855	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
856	hash which defines the environment of the new terminal.	1038	hash which defines the environment of the new terminal.
857		1039
858	Croaks (and probably outputs an error message) if the new instance	1040	Croaks (and probably outputs an error message) if the new instance
859	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
860	initialise perl, and the terminal object otherwise. The C<init> and	1042	initialise perl, and the terminal object otherwise. The C<init> and
861	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).
862		1045
863	=cut	1046	=cut
864		1047
865	sub new {	1048	sub new {
866	my ($class, $env, @args) = @_;	1049	my ($class, $env, @args) = @_;
867		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
868	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1054	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
869	}	1055	}
870		1056
871	=item $term->destroy	1057	=item $term->destroy
872		1058
873	Destroy the terminal object (close the window, free resources	1059	Destroy the terminal object (close the window, free resources
874	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1060	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
875	watchers (timers, io watchers) are still active.	1061	watchers (timers, io watchers) are still active.
876		1062
		1063	=item $term->exec_async ($cmd[, @args])
		1064
		1065	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1066	("starts") programs in the background. This function takes care of setting
		1067	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1068	be preferred over explicit calls to C<exec> or C<system>.
		1069
		1070	Returns the pid of the subprocess or C<undef> on error.
		1071
		1072	=cut
		1073
		1074	sub exec_async {
		1075	my $self = shift;
		1076
		1077	my $pid = fork;
		1078
		1079	return $pid
		1080	if !defined $pid or $pid;
		1081
		1082	%ENV = %{ $self->env };
		1083
		1084	exec @_;
		1085	urxvt::_exit 255;
		1086	}
		1087
877	=item $isset = $term->option ($optval[, $set])	1088	=item $isset = $term->option ($optval[, $set])
878		1089
879	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
880	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
881	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.
882		1093
883	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
884	source file F</src/optinc.h> to see the actual list:	1095	source file F</src/optinc.h> to see the actual list:
885		1096
886	borderLess console cursorBlink cursorUnderline hold iconic insecure	1097	borderLess buffered console cursorBlink cursorUnderline hold iconic
887	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1098	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1099	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
888	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1100	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
889	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1101	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
890	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1102	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
891	tripleclickwords utmpInhibit visualBell	1103	urgentOnBell utmpInhibit visualBell
892		1104
893	=item $value = $term->resource ($name[, $newval])	1105	=item $value = $term->resource ($name[, $newval])
894		1106
895	Returns the current resource value associated with a given name and	1107	Returns the current resource value associated with a given name and
896	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>
…		…
905	likely change).	1117	likely change).
906		1118
907	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
908	terminal is destroyed, so changing options frequently will eat memory.	1120	terminal is destroyed, so changing options frequently will eat memory.
909		1121
910	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
911	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>
912	to see the actual list:	1124	to see the actual list:
913		1125
914	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1126	answerbackstring backgroundPixmap backspace_key blurradius
915	borderLess color cursorBlink cursorUnderline cutchars delete_key	1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
916	display_name embed ext_bwidth fade font geometry hold iconName	1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
917	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
918	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
919	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1132	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
920	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1133	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
921	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1134	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
922	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1135	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
923	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1136	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
924	shade term_name title transparent transparent_all tripleclickwords	1137	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1138	term_name title transient_for transparent tripleclickwords urgentOnBell
925	utmpInhibit visualBell	1139	utmpInhibit visualBell
926		1140
927	=cut	1141	=cut
928		1142
929	sub resource($$;$) {	1143	sub resource($$;$) {
930	my ($self, $name) = (shift, shift);	1144	my ($self, $name) = (shift, shift);
931	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1145	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
932	&urxvt::term::_resource	1146	goto &urxvt::term::_resource
933	}	1147	}
934		1148
935	=item $value = $term->x_resource ($pattern)	1149	=item $value = $term->x_resource ($pattern)
936		1150
937	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
938	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
939	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
940	resource with that pattern exists.	1154	resource with that pattern exists.
941		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 replaced 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
942	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
943	only one resource database per display, and later invocations might return	1167	only one resource database per display, and later invocations might return
944	the wrong resources.	1168	the wrong resources.
945		1169
946	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1170	=item $value = $term->x_resource_boolean ($pattern)
947		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
948	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
949	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.
950		1197
951	=item $rend = $term->rstyle ([$new_rstyle])	1198	=item $rend = $term->rstyle ([$new_rstyle])
952		1199
953	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
954	the terminal application will use this style.	1201	the terminal application will use this style.
…		…
962		1209
963	=item ($row, $col) = $term->selection_beg ([$row, $col])	1210	=item ($row, $col) = $term->selection_beg ([$row, $col])
964		1211
965	=item ($row, $col) = $term->selection_end ([$row, $col])	1212	=item ($row, $col) = $term->selection_end ([$row, $col])
966		1213
967	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.
968	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.
969		1223
970	=item $term->selection_make ($eventtime[, $rectangular])	1224	=item $term->selection_make ($eventtime[, $rectangular])
971		1225
972	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
973	C<selection_end>. If C<$rectangular> is true (default: false), a	1227	C<selection_end>. If C<$rectangular> is true (default: false), a
974	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
975	a selection.	1229	a selection.
976		1230
977	=item $success = $term->selection_grab ($eventtime)	1231	=item $success = $term->selection_grab ($eventtime[, $clipboard])
978		1232
979	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
980	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
981	is mostly useful from within C<on_sel_grab> hooks.	1236	is mostly useful from within C<on_sel_grab> hooks.
982		1237
983	=item $oldtext = $term->selection ([$newtext])	1238	=item $oldtext = $term->selection ([$newtext, $clipboard])
984		1239
985	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.
986		1246
987	=item $term->overlay_simple ($x, $y, $text)	1247	=item $term->overlay_simple ($x, $y, $text)
988		1248
989	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.
990		1250
…		…
1020		1280
1021	The methods currently supported on C<urxvt::overlay> objects are:	1281	The methods currently supported on C<urxvt::overlay> objects are:
1022		1282
1023	=over 4	1283	=over 4
1024		1284
1025	=item $overlay->set ($x, $y, $text, $rend)	1285	=item $overlay->set ($x, $y, $text[, $rend])
1026		1286
1027	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
1028	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
1029	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.
1030		1292
1031	=item $overlay->hide	1293	=item $overlay->hide
1032		1294
1033	If visible, hide the overlay, but do not destroy it.	1295	If visible, hide the overlay, but do not destroy it.
1034		1296
…		…
1104		1366
1105	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
1106	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
1107	C<on_add_lines> hook, though.	1369	C<on_add_lines> hook, though.
1108		1370
		1371	=item $term->scr_change_screen ($screen)
		1372
		1373	Switch to given screen - 0 primary, 1 secondary.
		1374
1109	=item $term->cmd_parse ($octets)	1375	=item $term->cmd_parse ($octets)
1110		1376
1111	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
1112	locale-specific encoding of the terminal and can contain command sequences	1378	locale-specific encoding of the terminal and can contain command sequences
1113	(escape codes) that will be interpreted.	1379	(escape codes) that will be interpreted.
1114		1380
1115	=item $term->tt_write ($octets)	1381	=item $term->tt_write ($octets)
1116		1382
1117	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
1118	pass characters instead of octets, you should convert your strings first	1384	pass characters instead of octets, you should convert your strings first
1119	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.
1120		1392
1121	=item $old_events = $term->pty_ev_events ([$new_events])	1393	=item $old_events = $term->pty_ev_events ([$new_events])
1122		1394
1123	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
1124	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
1125	description of C<< urxvt::timer->events >>. Make sure to always restore	1397	description of C<< urxvt::timer->events >>. Make sure to always restore
1126	the previous value.	1398	the previous value.
1127		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
1128	=item $windowid = $term->parent	1405	=item $windowid = $term->parent
1129		1406
1130	Return the window id of the toplevel window.	1407	Return the window id of the toplevel window.
1131		1408
1132	=item $windowid = $term->vt	1409	=item $windowid = $term->vt
1133		1410
1134	Return the window id of the terminal window.	1411	Return the window id of the terminal window.
1135		1412
		1413	=item $term->vt_emask_add ($x_event_mask)
		1414
		1415	Adds the specified events to the vt event mask. Useful e.g. when you want
		1416	to receive pointer events all the times:
		1417
		1418	$term->vt_emask_add (urxvt::PointerMotionMask);
		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
1136	=item $window_width = $term->width	1434	=item $window_width = $term->width
1137		1435
1138	=item $window_height = $term->height	1436	=item $window_height = $term->height
1139		1437
1140	=item $font_width = $term->fwidth	1438	=item $font_width = $term->fwidth
…		…
1153		1451
1154	=item $max_scrollback = $term->saveLines	1452	=item $max_scrollback = $term->saveLines
1155		1453
1156	=item $nrow_plus_saveLines = $term->total_rows	1454	=item $nrow_plus_saveLines = $term->total_rows
1157		1455
1158	=item $lines_in_scrollback = $term->nsaved	1456	=item $topmost_scrollback_row = $term->top_row
1159		1457
1160	Return various integers describing terminal characteristics.	1458	Return various integers describing terminal characteristics.
1161		1459
1162	=item $x_display = $term->display_id	1460	=item $x_display = $term->display_id
1163		1461
…		…
1170	=item $env = $term->env	1468	=item $env = $term->env
1171		1469
1172	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
1173	similar to C<\%ENV>.	1471	similar to C<\%ENV>.
1174		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
1175	=cut	1482	=cut
1176		1483
1177	sub env {	1484	sub env {
1178	if (my $env = $_[0]->_env) {
1179	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1485	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1180	} else {
1181	+{ %ENV }
1182	}
1183	}	1486	}
1184		1487
1185	=item $modifiermask = $term->ModLevel3Mask	1488	=item $modifiermask = $term->ModLevel3Mask
1186		1489
1187	=item $modifiermask = $term->ModMetaMask	1490	=item $modifiermask = $term->ModMetaMask
…		…
1189	=item $modifiermask = $term->ModNumLockMask	1492	=item $modifiermask = $term->ModNumLockMask
1190		1493
1191	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
1192	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.
1193		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.
		1504
1194	=item $view_start = $term->view_start ([$newvalue])	1505	=item $view_start = $term->view_start ([$newvalue])
1195		1506
1196	Returns the negative row number of the topmost line. Minimum value is	1507	Returns the row number of the topmost displayed line. Maximum value is
1197	C<0>, which displays the normal terminal contents. Larger values scroll	1508	C<0>, which displays the normal terminal contents. Lower values scroll
1198	this many lines into the scrollback buffer.	1509	this many lines into the scrollback buffer.
1199		1510
1200	=item $term->want_refresh	1511	=item $term->want_refresh
1201		1512
1202	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1513	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1205		1516
1206	Used after changing terminal contents to display them.	1517	Used after changing terminal contents to display them.
1207		1518
1208	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1209		1520
1210	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 >>
1211	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
1212	terminal line. The scrollback buffer starts at line C<-1> and extends to
1213	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1523	terminal line. Nothing will be returned if a nonexistent line
1214	is requested.	1524	is requested.
1215		1525
1216	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
1217	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
1218	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
1219	automatically be updated.	1529	automatically be updated.
1220		1530
1221	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
1222	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)
1223	(C<chr 65535>). Characters with combining characters and other characters	1533	characters. Characters with combining characters and other characters that
1224	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
1225	characters in the private use area.	1535	in the private use area.
1226		1536
1227	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
1228	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
1229	characters.	1539	characters.
1230		1540
…		…
1374	where one character corresponds to one screen cell. See	1684	where one character corresponds to one screen cell. See
1375	C<< $term->ROW_t >> for details.	1685	C<< $term->ROW_t >> for details.
1376		1686
1377	=item $string = $term->special_decode $text	1687	=item $string = $term->special_decode $text
1378		1688
1379	Converts rxvt-unicodes text reprsentation into a perl string. See	1689	Converts rxvt-unicodes text representation into a perl string. See
1380	C<< $term->ROW_t >> for details.	1690	C<< $term->ROW_t >> for details.
1381		1691
1382	=item $success = $term->grab_button ($button, $modifiermask)	1692	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1383		1693
		1694	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1695
1384	Registers a synchronous button grab. See the XGrabButton manpage.	1696	Register/unregister a synchronous button grab. See the XGrabButton
		1697	manpage.
1385		1698
1386	=item $success = $term->grab ($eventtime[, $sync])	1699	=item $success = $term->grab ($eventtime[, $sync])
1387		1700
1388	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1701	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1389	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1702	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1390		1703
1391	=item $term->allow_events_async	1704	=item $term->allow_events_async
1392		1705
1393	Calls XAllowEvents with AsyncBoth for the most recent grab.	1706	Calls XAllowEvents with AsyncBoth for the most recent grab.
1394		1707
…		…
1401	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1714	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1402	recent grab.	1715	recent grab.
1403		1716
1404	=item $term->ungrab	1717	=item $term->ungrab
1405		1718
1406	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
1407	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
1408	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.
1409		1756
1410	=back	1757	=back
1411		1758
1412	=cut	1759	=cut
1413		1760
…		…
1477	my ($self, $text, $cb) = @_;	1824	my ($self, $text, $cb) = @_;
1478		1825
1479	$self->add_item ({ type => "button", text => $text, activate => $cb});	1826	$self->add_item ({ type => "button", text => $text, activate => $cb});
1480	}	1827	}
1481		1828
1482	=item $popup->add_toggle ($text, $cb, $initial_value)	1829	=item $popup->add_toggle ($text, $initial_value, $cb)
1483		1830
1484	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
1485	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
1486	argument.	1833	first argument.
1487		1834
1488	=cut	1835	=cut
1489		1836
1490	sub add_toggle {	1837	sub add_toggle {
1491	my ($self, $text, $cb, $value) = @_;	1838	my ($self, $text, $value, $cb) = @_;
1492		1839
1493	my $item; $item = {	1840	my $item; $item = {
1494	type => "button",	1841	type => "button",
1495	text => " $text",	1842	text => " $text",
1496	value => $value,	1843	value => $value,
…		…
1515	my $env = $self->{term}->env;	1862	my $env = $self->{term}->env;
1516	# 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.
1517	delete $env->{LC_ALL};	1864	delete $env->{LC_ALL};
1518	$env->{LC_CTYPE} = $self->{term}->locale;	1865	$env->{LC_CTYPE} = $self->{term}->locale;
1519		1866
1520	urxvt::term->new ($env, $self->{term}->resource ("name"),	1867	my $term = urxvt::term->new (
1521	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1868	$env, "popup",
		1869	"--perl-lib" => "", "--perl-ext-common" => "",
		1870	"-pty-fd" => -1, "-sl" => 0,
		1871	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1522	"--transient-for" => $self->{term}->parent,	1872	"--transient-for" => $self->{term}->parent,
1523	"-display" => $self->{term}->display_id,	1873	"-display" => $self->{term}->display_id,
1524	"-pe" => "urxvt-popup")	1874	"-pe" => "urxvt-popup",
1525	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	}
1526	}	1882	}
1527		1883
1528	sub DESTROY {	1884	sub DESTROY {
1529	my ($self) = @_;	1885	my ($self) = @_;
1530		1886
1531	delete $self->{term}{_destroy}{$self};	1887	delete $self->{term}{_destroy}{$self};
1532	$self->{term}->ungrab;	1888	$self->{term}->ungrab;
1533	}	1889	}
1534		1890
1535	=back	1891	=back
		1892
		1893	=cut
		1894
		1895	package urxvt::watcher;
1536		1896
1537	=head2 The C<urxvt::timer> Class	1897	=head2 The C<urxvt::timer> Class
1538		1898
1539	This class implements timer watchers/events. Time is represented as a	1899	This class implements timer watchers/events. Time is represented as a
1540	fractional number of seconds since the epoch. Example:	1900	fractional number of seconds since the epoch. Example:
…		…
1544	->new	1904	->new
1545	->interval (1)	1905	->interval (1)
1546	->cb (sub {	1906	->cb (sub {
1547	$term->{overlay}->set (0, 0,	1907	$term->{overlay}->set (0, 0,
1548	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1908	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1549	});	1909	});
1550		1910
1551	=over 4	1911	=over 4
1552		1912
1553	=item $timer = new urxvt::timer	1913	=item $timer = new urxvt::timer
1554		1914
…		…
1557		1917
1558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1918	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1559		1919
1560	Set the callback to be called when the timer triggers.	1920	Set the callback to be called when the timer triggers.
1561		1921
1562	=item $tstamp = $timer->at
1563
1564	Return the time this watcher will fire next.
1565
1566	=item $timer = $timer->set ($tstamp)	1922	=item $timer = $timer->set ($tstamp[, $interval])
1567		1923
1568	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).
1569		1926
1570	=item $timer = $timer->interval ($interval)	1927	=item $timer = $timer->interval ($interval)
1571		1928
1572	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
1573	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
1574	is automatically rescheduled at the given intervals.	1931	is automatically rescheduled at the given intervals.
1575		1932
1576	=item $timer = $timer->start	1933	=item $timer = $timer->start
1577		1934
1578	Start the timer.	1935	Start the timer.
1579		1936
1580	=item $timer = $timer->start ($tstamp)	1937	=item $timer = $timer->start ($tstamp[, $interval])
1581		1938
1582	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.
		1941
		1942	=item $timer = $timer->after ($delay[, $interval])
		1943
		1944	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1583		1945
1584	=item $timer = $timer->stop	1946	=item $timer = $timer->stop
1585		1947
1586	Stop the timer.	1948	Stop the timer.
1587		1949
…		…
1593		1955
1594	$term->{socket} = ...	1956	$term->{socket} = ...
1595	$term->{iow} = urxvt::iow	1957	$term->{iow} = urxvt::iow
1596	->new	1958	->new
1597	->fd (fileno $term->{socket})	1959	->fd (fileno $term->{socket})
1598	->events (urxvt::EVENT_READ)	1960	->events (urxvt::EV_READ)
1599	->start	1961	->start
1600	->cb (sub {	1962	->cb (sub {
1601	my ($iow, $revents) = @_;	1963	my ($iow, $revents) = @_;
1602	# $revents must be 1 here, no need to check	1964	# $revents must be 1 here, no need to check
1603	sysread $term->{socket}, my $buf, 8192	1965	sysread $term->{socket}, my $buf, 8192
…		…
1616	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>
1617	is a bitset as described in the C<events> method.	1979	is a bitset as described in the C<events> method.
1618		1980
1619	=item $iow = $iow->fd ($fd)	1981	=item $iow = $iow->fd ($fd)
1620		1982
1621	Set the filedescriptor (not handle) to watch.	1983	Set the file descriptor (not handle) to watch.
1622		1984
1623	=item $iow = $iow->events ($eventmask)	1985	=item $iow = $iow->events ($eventmask)
1624		1986
1625	Set the event mask to watch. The only allowed values are	1987	Set the event mask to watch. The only allowed values are
1626	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
1627	together, or C<urxvt::EVENT_NONE>.	1989	together, or C<urxvt::EV_NONE>.
1628		1990
1629	=item $iow = $iow->start	1991	=item $iow = $iow->start
1630		1992
1631	Start watching for requested events on the given handle.	1993	Start watching for requested events on the given handle.
1632		1994
1633	=item $iow = $iow->stop	1995	=item $iow = $iow->stop
1634		1996
1635	Stop watching for events on the given filehandle.	1997	Stop watching for events on the given file handle.
		1998
		1999	=back
		2000
		2001	=head2 The C<urxvt::iw> Class
		2002
		2003	This class implements idle watchers, that get called automatically when
		2004	the process is idle. They should return as fast as possible, after doing
		2005	some useful work.
		2006
		2007	=over 4
		2008
		2009	=item $iw = new urxvt::iw
		2010
		2011	Create a new idle watcher object in stopped state.
		2012
		2013	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2014
		2015	Set the callback to be called when the watcher triggers.
		2016
		2017	=item $timer = $timer->start
		2018
		2019	Start the watcher.
		2020
		2021	=item $timer = $timer->stop
		2022
		2023	Stop the watcher.
		2024
		2025	=back
		2026
		2027	=head2 The C<urxvt::pw> Class
		2028
		2029	This class implements process watchers. They create an event whenever a
		2030	process exits, after which they stop automatically.
		2031
		2032	my $pid = fork;
		2033	...
		2034	$term->{pw} = urxvt::pw
		2035	->new
		2036	->start ($pid)
		2037	->cb (sub {
		2038	my ($pw, $exit_status) = @_;
		2039	...
		2040	});
		2041
		2042	=over 4
		2043
		2044	=item $pw = new urxvt::pw
		2045
		2046	Create a new process watcher in stopped state.
		2047
		2048	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2049
		2050	Set the callback to be called when the timer triggers.
		2051
		2052	=item $pw = $timer->start ($pid)
		2053
		2054	Tells the watcher to start watching for process C<$pid>.
		2055
		2056	=item $pw = $pw->stop
		2057
		2058	Stop the watcher.
1636		2059
1637	=back	2060	=back
1638		2061
1639	=head1 ENVIRONMENT	2062	=head1 ENVIRONMENT
1640		2063
…		…
1649		2072
1650	=item >= 3 - script loading and management	2073	=item >= 3 - script loading and management
1651		2074
1652	=item >=10 - all called hooks	2075	=item >=10 - all called hooks
1653		2076
1654	=item >=11 - hook reutrn values	2077	=item >=11 - hook return values
1655		2078
1656	=back	2079	=back
1657		2080
1658	=head1 AUTHOR	2081	=head1 AUTHOR
1659		2082
1660	Marc Lehmann <pcg@goof.com>	2083	Marc Lehmann <schmorp@schmorp.de>
1661	http://software.schmorp.de/pkg/rxvt-unicode	2084	http://software.schmorp.de/pkg/rxvt-unicode
1662		2085
1663	=cut	2086	=cut
1664		2087
1665	1	2088	1
		2089
		2090	# vim: sw=3:

Diff Legend

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