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.111 by root, Thu Jan 19 19:52:54 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 it is true, then the	137	B<All> of these hooks must return a boolean value. If any of the called
309	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
310	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.
311		140
312	I<< When in doubt, return a false value (preferably C<()>). >>	141	I<< When in doubt, return a false value (preferably C<()>). >>
313		142
314	=over 4	143	=over 4
315		144
316	=item on_init $term	145	=item on_init $term
317		146
318	Called after a new terminal object has been initialized, but before	147	Called after a new terminal object has been initialized, but before
319	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
320	call or deliver senseless data, as terminal size and other characteristics	149	call or deliver senseless data, as terminal size and other characteristics
321	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
322	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).
323		163
324	=item on_reset $term	164	=item on_reset $term
325		165
326	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
327	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
328	variables.	168	variables.
329		169
330	=item on_start $term
331
332	Called at the very end of initialisation of a new terminal, just before
333	returning to the mainloop.
334
335	=item on_child_start $term, $pid	170	=item on_child_start $term, $pid
336		171
337	Called just after the child process has been C<fork>ed.	172	Called just after the child process has been C<fork>ed.
338		173
339	=item on_child_exit $term, $status	174	=item on_child_exit $term, $status
…		…
354		189
355	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
356	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
357	by calling C<< $term->selection >>.	192	by calling C<< $term->selection >>.
358		193
359	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.
360		195
361	=item on_sel_extend $term	196	=item on_sel_extend $term
362		197
363	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
364	click) and is either supposed to return false (normal operation), or	199	click) and is either supposed to return false (normal operation), or
365	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
366	processing. This can happen multiple times, as long as the callback	201	processing. This can happen multiple times, as long as the callback
367	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
368	supposed to enlarge the selection more and more, if possible.	203	supposed to enlarge the selection more and more, if possible.
369		204
370	See the F<selection> example extension.	205	See the F<selection> example extension.
371		206
372	=item on_view_change $term, $offset	207	=item on_view_change $term, $offset
373		208
374	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
375	scrolls. Offset C<0> means display the normal terminal, positive values	210	scrolls. Offset C<0> means display the normal terminal, positive values
376	show this many lines of scrollback.	211	show this many lines of scrollback.
377		212
378	=item on_scroll_back $term, $lines, $saved	213	=item on_scroll_back $term, $lines, $saved
379		214
…		…
383		218
384	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,
385	$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
386	number of lines that will be in the scrollback buffer.	221	number of lines that will be in the scrollback buffer.
387		222
388	=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
389		234
390	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	235	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
391	operating system command) is processed. Cursor position and other state	236	operating system command) is processed. Cursor position and other state
392	information is up-to-date when this happens. For interoperability, the	237	information is up-to-date when this happens. For interoperability, the
393	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,
394	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
395	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	}
396		251
397	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,
398	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
399	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.
400		258
401	=item on_add_lines $term, $string	259	=item on_add_lines $term, $string
402		260
403	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
404	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
…		…
409	=item on_tt_write $term, $octets	267	=item on_tt_write $term, $octets
410		268
411	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
412	suppress or filter tty input.	270	suppress or filter tty input.
413		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
414	=item on_line_update $term, $row	279	=item on_line_update $term, $row
415		280
416	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
417	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
418	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,
…		…
425	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
426	you cannot just toggle rendition bits, but only set them.	291	you cannot just toggle rendition bits, but only set them.
427		292
428	=item on_refresh_begin $term	293	=item on_refresh_begin $term
429		294
430	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
431	or similar effects by modify terminal contents in refresh_begin, and	296	similar effects by modifying the terminal contents in refresh_begin, and
432	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
433	code is run after this hook, and takes precedence.	298	code is run after this hook, and takes precedence.
434		299
435	=item on_refresh_end $term	300	=item on_refresh_end $term
436		301
437	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>.
438		303
439	=item on_keyboard_command $term, $string	304	=item on_user_command $term, $string
440		305
441	Called whenever the user presses a key combination that has a	306	Called whenever a user-configured event is being activated (e.g. via
442	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>
443	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.
444		325
445	=item on_x_event $term, $event	326	=item on_x_event $term, $event
446		327
447	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
448	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
449	members are not passed.	330	members are not passed.
450		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
451	=item on_focus_in $term	336	=item on_focus_in $term
452		337
453	Called whenever the window gets the keyboard focus, before rxvt-unicode	338	Called whenever the window gets the keyboard focus, before rxvt-unicode
454	does focus in processing.	339	does focus in processing.
455		340
456	=item on_focus_out $term	341	=item on_focus_out $term
457		342
458	Called wheneever the window loses keyboard focus, before rxvt-unicode does	343	Called whenever the window loses keyboard focus, before rxvt-unicode does
459	focus out processing.	344	focus out processing.
460		345
461	=item on_configure_notify $term, $event	346	=item on_configure_notify $term, $event
462		347
		348	=item on_property_notify $term, $event
		349
463	=item on_key_press $term, $event, $keysym, $octets	350	=item on_key_press $term, $event, $keysym, $octets
464		351
465	=item on_key_release $term, $event, $keysym	352	=item on_key_release $term, $event, $keysym
466		353
467	=item on_button_press $term, $event	354	=item on_button_press $term, $event
…		…
472		359
473	=item on_map_notify $term, $event	360	=item on_map_notify $term, $event
474		361
475	=item on_unmap_notify $term, $event	362	=item on_unmap_notify $term, $event
476		363
477	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
478	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.
479		366
480	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
481	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
482	and column under the mouse cursor.	369	(real, not screen-based) row and column under the mouse cursor.
483		370
484	C<on_key_press> additionally receives the string rxvt-unicode would	371	C<on_key_press> additionally receives the string rxvt-unicode would
485	output, if any, in locale-specific encoding.	372	output, if any, in locale-specific encoding.
486		373
487	subwindow.	374	subwindow.
488		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
489	=back	389	=back
490		390
491	=cut	391	=cut
492		392
493	package urxvt;	393	package urxvt;
494		394
495	use utf8;	395	use utf8;
496	use strict;	396	use strict 'vars';
497	use Carp ();	397	use Carp ();
498	use Scalar::Util ();	398	use Scalar::Util ();
499	use List::Util ();	399	use List::Util ();
500		400
501	our $VERSION = 1;	401	our $VERSION = 1;
502	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.
503	our @HOOKNAME;	405	our @HOOKNAME;
504	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	406	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
505	our %OPTION;	407	our %OPTION;
506		408
507	our $LIBDIR;	409	our $LIBDIR;
508	our $RESNAME;	410	our $RESNAME;
509	our $RESCLASS;	411	our $RESCLASS;
510	our $RXVTNAME;	412	our $RXVTNAME;
511		413
		414	our $NOCHAR = chr 0xffff;
		415
512	=head2 Variables in the C<urxvt> Package	416	=head2 Variables in the C<urxvt> Package
513		417
514	=over 4	418	=over 4
515		419
516	=item $urxvt::LIBDIR	420	=item $urxvt::LIBDIR
…		…
529	=item $urxvt::TERM	433	=item $urxvt::TERM
530		434
531	The current terminal. This variable stores the current C<urxvt::term>	435	The current terminal. This variable stores the current C<urxvt::term>
532	object, whenever a callback/hook is executing.	436	object, whenever a callback/hook is executing.
533		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
534	=back	454	=back
535		455
536	=head2 Functions in the C<urxvt> Package	456	=head2 Functions in the C<urxvt> Package
537		457
538	=over 4	458	=over 4
539		459
540	=item urxvt::fatal $errormessage	460	=item urxvt::fatal $errormessage
541		461
542	Fatally aborts execution with the given error message. Avoid at all	462	Fatally aborts execution with the given error message (which should
543	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
544	starts up.	464	is acceptable (and useful) is in the init hook, where it prevents the
		465	terminal from starting up.
545		466
546	=item urxvt::warn $string	467	=item urxvt::warn $string
547		468
548	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
549	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
550	that calls this function.	471	that calls this function.
551		472
552	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
553	correct place, e.g. on stderr of the connecting urxvtc client.	474	correct place, e.g. on stderr of the connecting urxvtc client.
554		475
555	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).
556		484
557	=item $time = urxvt::NOW	485	=item $time = urxvt::NOW
558		486
559	Returns the "current time" (as per the event loop).	487	Returns the "current time" (as per the event loop).
560		488
…		…
603		531
604	=item $rend = urxvt::OVERLAY_RSTYLE	532	=item $rend = urxvt::OVERLAY_RSTYLE
605		533
606	Return the rendition mask used for overlays by default.	534	Return the rendition mask used for overlays by default.
607		535
608	=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
609		538
610	Return the bit that enabled bold, italic, blink, reverse-video and	539	Return the bit that enabled bold, italic, blink, reverse-video and
611	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
612	the bitset.	541	the bitset.
613		542
…		…
618	Return the foreground/background colour index, respectively.	547	Return the foreground/background colour index, respectively.
619		548
620	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	549	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
621		550
622	=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
623		554
624	Replace the foreground/background colour in the rendition mask with the	555	Replace the foreground/background colour in the rendition mask with the
625	specified one.	556	specified one.
626		557
627	=item $value = urxvt::GET_CUSTOM $rend	558	=item $value = urxvt::GET_CUSTOM $rend
…		…
646	unless $msg =~ /\n$/;	577	unless $msg =~ /\n$/;
647	urxvt::warn ($msg);	578	urxvt::warn ($msg);
648	};	579	};
649	}	580	}
650		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
651	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	644	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
652		645
653	sub verbose {	646	sub verbose {
654	my ($level, $msg) = @_;	647	my ($level, $msg) = @_;
655	warn "$msg\n" if $level <= $verbosity;	648	warn "$msg\n" if $level <= $verbosity;
…		…
658	my %extension_pkg;	651	my %extension_pkg;
659		652
660	# load a single script into its own package, once only	653	# load a single script into its own package, once only
661	sub extension_package($) {	654	sub extension_package($) {
662	my ($path) = @_;	655	my ($path) = @_;
663
664	no strict 'refs';
665		656
666	$extension_pkg{$path} ||= do {	657	$extension_pkg{$path} ||= do {
667	$path =~ /([^\/\\]+)$/;	658	$path =~ /([^\/\\]+)$/;
668	my $pkg = $1;	659	my $pkg = $1;
669	$pkg =~ s/[^[:word:]]/_/g;	660	$pkg =~ s/[^[:word:]]/_/g;
670	$pkg = "urxvt::ext::$pkg";	661	$pkg = "urxvt::ext::$pkg";
671		662
672	verbose 3, "loading extension '$path' into package '$pkg'";	663	verbose 3, "loading extension '$path' into package '$pkg'";
673		664
		665	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		666
674	open my $fh, "<:raw", $path	667	open my $fh, "<:raw", $path
675	or die "$path: $!";	668	or die "$path: $!";
676		669
677	@{"$pkg\::ISA"} = urxvt::term::extension::;
678
679	my $source =	670	my $source =
680	"package $pkg; use strict; use utf8;\n"	671	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
681	. "#line 1 \"$path\"\n{\n"	672	. "#line 1 \"$path\"\n{\n"
682	. (do { local $/; <$fh> })	673	. (do { local $/; <$fh> })
683	. "\n};\n1";	674	. "\n};\n1";
684		675
685	eval $source	676	eval $source
…		…
695	sub invoke {	686	sub invoke {
696	local $TERM = shift;	687	local $TERM = shift;
697	my $htype = shift;	688	my $htype = shift;
698		689
699	if ($htype == 0) { # INIT	690	if ($htype == 0) { # INIT
700	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	691	my @dirs = $TERM->perl_libdirs;
701		692
702	my %ext_arg;	693	my %ext_arg;
703		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} },
704	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		707	) {
705	if ($_ eq "default") {	708	if ($_ eq "default") {
706	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	709	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
707	} elsif (/^-(.*)$/) {	710	} elsif (/^-(.*)$/) {
708	delete $ext_arg{$1};	711	delete $ext_arg{$1};
709	} elsif (/^([^<]+)<(.*)>$/) {	712	} elsif (/^([^<]+)<(.*)>$/) {
710	push @{ $ext_arg{$1} }, $2;	713	push @{ $ext_arg{$1} }, $2;
711	} else {	714	} else {
712	$ext_arg{$_} ||= [];	715	$ext_arg{$_} ||= [];
713	}	716	}
714	}	717	}
715		718
716	while (my ($ext, $argv) = each %ext_arg) {	719	for my $ext (sort keys %ext_arg) {
717	my @files = grep -f $_, map "$_/$ext", @dirs;	720	my @files = grep -f $_, map "$_/$ext", @dirs;
718		721
719	if (@files) {	722	if (@files) {
720	$TERM->register_package (extension_package $files[0], $argv);	723	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
721	} else {	724	} else {
722	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";
723	}	726	}
724	}	727	}
725		728
…		…
731		734
732	if (my $cb = $TERM->{_hook}[$htype]) {	735	if (my $cb = $TERM->{_hook}[$htype]) {
733	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
734	if $verbosity >= 10;	737	if $verbosity >= 10;
735		738
736	keys %$cb;	739	for my $pkg (keys %$cb) {
737
738	while (my ($pkg, $cb) = each %$cb) {
739	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
740	and last;	741	$retval ||= $retval_;
741		742
742	if ($@) {	743	if ($@) {
743	$TERM->ungrab; # better to lose the grab than the session	744	$TERM->ungrab; # better to lose the grab than the session
744	warn $@;	745	warn $@;
745	}	746	}
…		…
758	}	759	}
759		760
760	$retval	761	$retval
761	}	762	}
762		763
763	# 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	}
764		792
765	package urxvt::term::extension;	793	package urxvt::term::extension;
766		794
767	sub enable {	795	sub enable {
768	my ($self, %hook) = @_;	796	my ($self, %hook) = @_;
…		…
823		851
824	sub urxvt::destroy_hook(&) {	852	sub urxvt::destroy_hook(&) {
825	bless \shift, urxvt::destroy_hook::	853	bless \shift, urxvt::destroy_hook::
826	}	854	}
827		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
828	package urxvt::anyevent;	868	package urxvt::anyevent;
829		869
830	=head2 The C<urxvt::anyevent> Class	870	=head2 The C<urxvt::anyevent> Class
831		871
832	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
833	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
834	further programming. The only exception is that you cannot wait on	874	further programming. The only exception is that you cannot wait on
835	condition variables, but non-blocking condvar use is ok. What this means	875	condition variables, but non-blocking condvar use is ok.
836	is that you cannot use blocking APIs, but the non-blocking variant should	876
837	work.	877	In practical terms this means is that you cannot use blocking APIs, but
		878	the non-blocking variant should work.
838		879
839	=cut	880	=cut
840		881
841	our $VERSION = 1;	882	our $VERSION = '5.23';
842		883
843	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	884	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
844	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	885	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
845		886
846	sub timer {	887	sub timer {
…		…
848		889
849	my $cb = $arg{cb};	890	my $cb = $arg{cb};
850		891
851	urxvt::timer	892	urxvt::timer
852	->new	893	->new
853	->start (urxvt::NOW + $arg{after})	894	->after ($arg{after}, $arg{interval})
854	->cb (sub {	895	->cb ($arg{interval} ? $cb : sub {
855	$_[0]->stop; # need to cancel manually	896	$_[0]->stop; # need to cancel manually
856	$cb->();	897	$cb->();
857	})	898	})
858	}	899	}
859		900
860	sub io {	901	sub io {
861	my ($class, %arg) = @_;	902	my ($class, %arg) = @_;
862		903
863	my $cb = $arg{cb};	904	my $cb = $arg{cb};
		905	my $fd = fileno $arg{fh};
		906	defined $fd or $fd = $arg{fh};
864		907
865	bless [$arg{fh}, urxvt::iow	908	bless [$arg{fh}, urxvt::iow
866	->new	909	->new
867	->fd (fileno $arg{fh})	910	->fd ($fd)
868	->events (($arg{poll} =~ /r/ ? 1 : 0)	911	->events (($arg{poll} =~ /r/ ? 1 : 0)
869	| ($arg{poll} =~ /w/ ? 2 : 0))	912	| ($arg{poll} =~ /w/ ? 2 : 0))
870	->start	913	->start
871	->cb (sub {	914	->cb ($cb)
872	$cb->(($_[1] & 1 ? 'r' : '')
873	. ($_[1] & 2 ? 'w' : ''));
874	})],
875	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	})
876	}	941	}
877		942
878	sub DESTROY {	943	sub DESTROY {
879	$_[0][1]->stop;	944	$_[0][1]->stop;
880	}	945	}
881		946
882	sub condvar {	947	# only needed for AnyEvent < 6 compatibility
883	bless \my $flag, urxvt::anyevent::condvar::	948	sub one_event {
884	}
885
886	sub urxvt::anyevent::condvar::broadcast {
887	${$_[0]}++;
888	}
889
890	sub urxvt::anyevent::condvar::wait {
891	unless (${$_[0]}) {
892	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";
893	}
894	}	950	}
895		951
896	package urxvt::term;	952	package urxvt::term;
897		953
898	=head2 The C<urxvt::term> Class	954	=head2 The C<urxvt::term> Class
…		…
904	# find on_xxx subs in the package and register them	960	# find on_xxx subs in the package and register them
905	# as hooks	961	# as hooks
906	sub register_package {	962	sub register_package {
907	my ($self, $pkg, $argv) = @_;	963	my ($self, $pkg, $argv) = @_;
908		964
		965	no strict 'refs';
		966
		967	urxvt::verbose 6, "register package $pkg to $self";
		968
		969	@{"$pkg\::ISA"} = urxvt::term::extension::;
		970
909	my $proxy = bless {	971	my $proxy = bless {
910	_pkg => $pkg,	972	_pkg => $pkg,
		973	_name => ${"$pkg\::_NAME"}, # hackish
911	argv => $argv,	974	argv => $argv,
912	}, $pkg;	975	}, $pkg;
913	Scalar::Util::weaken ($proxy->{term} = $self);	976	Scalar::Util::weaken ($proxy->{term} = $self);
914		977
915	$self->{_pkg}{$pkg} = $proxy;	978	$self->{_pkg}{$pkg} = $proxy;
916		979
…		…
919	$proxy->enable ($name => $ref);	982	$proxy->enable ($name => $ref);
920	}	983	}
921	}	984	}
922	}	985	}
923		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
924	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
925		1035
926	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
927	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
928	hash which defines the environment of the new terminal.	1038	hash which defines the environment of the new terminal.
929		1039
930	Croaks (and probably outputs an error message) if the new instance	1040	Croaks (and probably outputs an error message) if the new instance
931	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
932	initialise perl, and the terminal object otherwise. The C<init> and	1042	initialise perl, and the terminal object otherwise. The C<init> and
933	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).
934		1045
935	=cut	1046	=cut
936		1047
937	sub new {	1048	sub new {
938	my ($class, $env, @args) = @_;	1049	my ($class, $env, @args) = @_;
939		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
940	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1054	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
941	}	1055	}
942		1056
943	=item $term->destroy	1057	=item $term->destroy
944		1058
945	Destroy the terminal object (close the window, free resources	1059	Destroy the terminal object (close the window, free resources
…		…
975		1089
976	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
977	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
978	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.
979		1093
980	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
981	source file F</src/optinc.h> to see the actual list:	1095	source file F</src/optinc.h> to see the actual list:
982		1096
983	borderLess console cursorBlink cursorUnderline hold iconic insecure	1097	borderLess buffered console cursorBlink cursorUnderline hold iconic
984	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1098	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
985	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1099	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
986	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1100	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
987	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1101	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
988	transparent tripleclickwords utmpInhibit visualBell	1102	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1103	urgentOnBell utmpInhibit visualBell
989		1104
990	=item $value = $term->resource ($name[, $newval])	1105	=item $value = $term->resource ($name[, $newval])
991		1106
992	Returns the current resource value associated with a given name and	1107	Returns the current resource value associated with a given name and
993	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>
…		…
1002	likely change).	1117	likely change).
1003		1118
1004	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
1005	terminal is destroyed, so changing options frequently will eat memory.	1120	terminal is destroyed, so changing options frequently will eat memory.
1006		1121
1007	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
1008	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>
1009	to see the actual list:	1124	to see the actual list:
1010		1125
1011	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1012	borderLess color cursorBlink cursorUnderline cutchars delete_key	1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1013	display_name embed ext_bwidth fade font geometry hold iconName	1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1014	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
1015	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1016	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1132	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1017	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1133	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1018	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1134	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1019	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1135	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1020	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1136	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1021	secondaryScreen secondaryScroll selectstyle shade term_name title	1137	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1022	transient_for transparent transparent_all tripleclickwords utmpInhibit	1138	term_name title transient_for transparent tripleclickwords urgentOnBell
1023	visualBell	1139	utmpInhibit visualBell
1024		1140
1025	=cut	1141	=cut
1026		1142
1027	sub resource($$;$) {	1143	sub resource($$;$) {
1028	my ($self, $name) = (shift, shift);	1144	my ($self, $name) = (shift, shift);
1029	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1145	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1030	&urxvt::term::_resource	1146	goto &urxvt::term::_resource
1031	}	1147	}
1032		1148
1033	=item $value = $term->x_resource ($pattern)	1149	=item $value = $term->x_resource ($pattern)
1034		1150
1035	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
1036	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
1037	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
1038	resource with that pattern exists.	1154	resource with that pattern exists.
1039		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
1040	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
1041	only one resource database per display, and later invocations might return	1167	only one resource database per display, and later invocations might return
1042	the wrong resources.	1168	the wrong resources.
1043		1169
1044	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1170	=item $value = $term->x_resource_boolean ($pattern)
1045		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
1046	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
1047	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.
1048		1197
1049	=item $rend = $term->rstyle ([$new_rstyle])	1198	=item $rend = $term->rstyle ([$new_rstyle])
1050		1199
1051	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
1052	the terminal application will use this style.	1201	the terminal application will use this style.
…		…
1060		1209
1061	=item ($row, $col) = $term->selection_beg ([$row, $col])	1210	=item ($row, $col) = $term->selection_beg ([$row, $col])
1062		1211
1063	=item ($row, $col) = $term->selection_end ([$row, $col])	1212	=item ($row, $col) = $term->selection_end ([$row, $col])
1064		1213
1065	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.
1066	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.
1067		1223
1068	=item $term->selection_make ($eventtime[, $rectangular])	1224	=item $term->selection_make ($eventtime[, $rectangular])
1069		1225
1070	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
1071	C<selection_end>. If C<$rectangular> is true (default: false), a	1227	C<selection_end>. If C<$rectangular> is true (default: false), a
1072	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
1073	a selection.	1229	a selection.
1074		1230
1075	=item $success = $term->selection_grab ($eventtime)	1231	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1076		1232
1077	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
1078	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
1079	is mostly useful from within C<on_sel_grab> hooks.	1236	is mostly useful from within C<on_sel_grab> hooks.
1080		1237
1081	=item $oldtext = $term->selection ([$newtext])	1238	=item $oldtext = $term->selection ([$newtext, $clipboard])
1082		1239
1083	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.
1084		1246
1085	=item $term->overlay_simple ($x, $y, $text)	1247	=item $term->overlay_simple ($x, $y, $text)
1086		1248
1087	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.
1088		1250
…		…
1118		1280
1119	The methods currently supported on C<urxvt::overlay> objects are:	1281	The methods currently supported on C<urxvt::overlay> objects are:
1120		1282
1121	=over 4	1283	=over 4
1122		1284
1123	=item $overlay->set ($x, $y, $text, $rend)	1285	=item $overlay->set ($x, $y, $text[, $rend])
1124		1286
1125	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
1126	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
1127	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.
1128		1292
1129	=item $overlay->hide	1293	=item $overlay->hide
1130		1294
1131	If visible, hide the overlay, but do not destroy it.	1295	If visible, hide the overlay, but do not destroy it.
1132		1296
…		…
1202		1366
1203	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
1204	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
1205	C<on_add_lines> hook, though.	1369	C<on_add_lines> hook, though.
1206		1370
		1371	=item $term->scr_change_screen ($screen)
		1372
		1373	Switch to given screen - 0 primary, 1 secondary.
		1374
1207	=item $term->cmd_parse ($octets)	1375	=item $term->cmd_parse ($octets)
1208		1376
1209	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
1210	locale-specific encoding of the terminal and can contain command sequences	1378	locale-specific encoding of the terminal and can contain command sequences
1211	(escape codes) that will be interpreted.	1379	(escape codes) that will be interpreted.
1212		1380
1213	=item $term->tt_write ($octets)	1381	=item $term->tt_write ($octets)
1214		1382
1215	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
1216	pass characters instead of octets, you should convert your strings first	1384	pass characters instead of octets, you should convert your strings first
1217	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.
1218		1392
1219	=item $old_events = $term->pty_ev_events ([$new_events])	1393	=item $old_events = $term->pty_ev_events ([$new_events])
1220		1394
1221	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
1222	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
1223	description of C<< urxvt::timer->events >>. Make sure to always restore	1397	description of C<< urxvt::timer->events >>. Make sure to always restore
1224	the previous value.	1398	the previous value.
1225		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
1226	=item $windowid = $term->parent	1405	=item $windowid = $term->parent
1227		1406
1228	Return the window id of the toplevel window.	1407	Return the window id of the toplevel window.
1229		1408
1230	=item $windowid = $term->vt	1409	=item $windowid = $term->vt
…		…
1236	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
1237	to receive pointer events all the times:	1416	to receive pointer events all the times:
1238		1417
1239	$term->vt_emask_add (urxvt::PointerMotionMask);	1418	$term->vt_emask_add (urxvt::PointerMotionMask);
1240		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
1241	=item $window_width = $term->width	1434	=item $window_width = $term->width
1242		1435
1243	=item $window_height = $term->height	1436	=item $window_height = $term->height
1244		1437
1245	=item $font_width = $term->fwidth	1438	=item $font_width = $term->fwidth
…		…
1275	=item $env = $term->env	1468	=item $env = $term->env
1276		1469
1277	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
1278	similar to C<\%ENV>.	1471	similar to C<\%ENV>.
1279		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
1280	=cut	1482	=cut
1281		1483
1282	sub env {	1484	sub env {
1283	if (my $env = $_[0]->_env) {
1284	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1485	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1285	} else {
1286	+{ %ENV }
1287	}
1288	}	1486	}
1289		1487
1290	=item $modifiermask = $term->ModLevel3Mask	1488	=item $modifiermask = $term->ModLevel3Mask
1291		1489
1292	=item $modifiermask = $term->ModMetaMask	1490	=item $modifiermask = $term->ModMetaMask
1293		1491
1294	=item $modifiermask = $term->ModNumLockMask	1492	=item $modifiermask = $term->ModNumLockMask
1295		1493
1296	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
1297	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.
1298		1504
1299	=item $view_start = $term->view_start ([$newvalue])	1505	=item $view_start = $term->view_start ([$newvalue])
1300		1506
1301	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
1302	C<0>, which displays the normal terminal contents. Lower values scroll	1508	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1310		1516
1311	Used after changing terminal contents to display them.	1517	Used after changing terminal contents to display them.
1312		1518
1313	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1314		1520
1315	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 >>
1316	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
1317	terminal line. The scrollback buffer starts at line C<-1> and extends to
1318	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1523	terminal line. Nothing will be returned if a nonexistent line
1319	is requested.	1524	is requested.
1320		1525
1321	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
1322	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
1323	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
1324	automatically be updated.	1529	automatically be updated.
1325		1530
1326	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
1327	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)
1328	(C<chr 65535>). Characters with combining characters and other characters	1533	characters. Characters with combining characters and other characters that
1329	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
1330	characters in the private use area.	1535	in the private use area.
1331		1536
1332	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
1333	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
1334	characters.	1539	characters.
1335		1540
…		…
1479	where one character corresponds to one screen cell. See	1684	where one character corresponds to one screen cell. See
1480	C<< $term->ROW_t >> for details.	1685	C<< $term->ROW_t >> for details.
1481		1686
1482	=item $string = $term->special_decode $text	1687	=item $string = $term->special_decode $text
1483		1688
1484	Converts rxvt-unicodes text reprsentation into a perl string. See	1689	Converts rxvt-unicodes text representation into a perl string. See
1485	C<< $term->ROW_t >> for details.	1690	C<< $term->ROW_t >> for details.
1486		1691
1487	=item $success = $term->grab_button ($button, $modifiermask)	1692	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1488		1693
		1694	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1695
1489	Registers a synchronous button grab. See the XGrabButton manpage.	1696	Register/unregister a synchronous button grab. See the XGrabButton
		1697	manpage.
1490		1698
1491	=item $success = $term->grab ($eventtime[, $sync])	1699	=item $success = $term->grab ($eventtime[, $sync])
1492		1700
1493	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1701	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1494	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1702	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1495		1703
1496	=item $term->allow_events_async	1704	=item $term->allow_events_async
1497		1705
1498	Calls XAllowEvents with AsyncBoth for the most recent grab.	1706	Calls XAllowEvents with AsyncBoth for the most recent grab.
1499		1707
…		…
1506	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1714	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1507	recent grab.	1715	recent grab.
1508		1716
1509	=item $term->ungrab	1717	=item $term->ungrab
1510		1718
1511	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
1512	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
1513	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.
1514		1756
1515	=back	1757	=back
1516		1758
1517	=cut	1759	=cut
1518		1760
…		…
1582	my ($self, $text, $cb) = @_;	1824	my ($self, $text, $cb) = @_;
1583		1825
1584	$self->add_item ({ type => "button", text => $text, activate => $cb});	1826	$self->add_item ({ type => "button", text => $text, activate => $cb});
1585	}	1827	}
1586		1828
1587	=item $popup->add_toggle ($text, $cb, $initial_value)	1829	=item $popup->add_toggle ($text, $initial_value, $cb)
1588		1830
1589	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
1590	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
1591	argument.	1833	first argument.
1592		1834
1593	=cut	1835	=cut
1594		1836
1595	sub add_toggle {	1837	sub add_toggle {
1596	my ($self, $text, $cb, $value) = @_;	1838	my ($self, $text, $value, $cb) = @_;
1597		1839
1598	my $item; $item = {	1840	my $item; $item = {
1599	type => "button",	1841	type => "button",
1600	text => " $text",	1842	text => " $text",
1601	value => $value,	1843	value => $value,
…		…
1620	my $env = $self->{term}->env;	1862	my $env = $self->{term}->env;
1621	# 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.
1622	delete $env->{LC_ALL};	1864	delete $env->{LC_ALL};
1623	$env->{LC_CTYPE} = $self->{term}->locale;	1865	$env->{LC_CTYPE} = $self->{term}->locale;
1624		1866
1625	urxvt::term->new ($env, "popup",	1867	my $term = urxvt::term->new (
		1868	$env, "popup",
1626	"--perl-lib" => "", "--perl-ext-common" => "",	1869	"--perl-lib" => "", "--perl-ext-common" => "",
1627	"-pty-fd" => -1, "-sl" => 0,	1870	"-pty-fd" => -1, "-sl" => 0,
1628	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1871	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1629	"--transient-for" => $self->{term}->parent,	1872	"--transient-for" => $self->{term}->parent,
1630	"-display" => $self->{term}->display_id,	1873	"-display" => $self->{term}->display_id,
1631	"-pe" => "urxvt-popup")	1874	"-pe" => "urxvt-popup",
1632	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	}
1633	}	1882	}
1634		1883
1635	sub DESTROY {	1884	sub DESTROY {
1636	my ($self) = @_;	1885	my ($self) = @_;
1637		1886
1638	delete $self->{term}{_destroy}{$self};	1887	delete $self->{term}{_destroy}{$self};
1639	$self->{term}->ungrab;	1888	$self->{term}->ungrab;
1640	}	1889	}
1641		1890
1642	=back	1891	=back
		1892
		1893	=cut
		1894
		1895	package urxvt::watcher;
1643		1896
1644	=head2 The C<urxvt::timer> Class	1897	=head2 The C<urxvt::timer> Class
1645		1898
1646	This class implements timer watchers/events. Time is represented as a	1899	This class implements timer watchers/events. Time is represented as a
1647	fractional number of seconds since the epoch. Example:	1900	fractional number of seconds since the epoch. Example:
…		…
1651	->new	1904	->new
1652	->interval (1)	1905	->interval (1)
1653	->cb (sub {	1906	->cb (sub {
1654	$term->{overlay}->set (0, 0,	1907	$term->{overlay}->set (0, 0,
1655	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1908	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1656	});	1909	});
1657		1910
1658	=over 4	1911	=over 4
1659		1912
1660	=item $timer = new urxvt::timer	1913	=item $timer = new urxvt::timer
1661		1914
…		…
1664		1917
1665	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1918	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1666		1919
1667	Set the callback to be called when the timer triggers.	1920	Set the callback to be called when the timer triggers.
1668		1921
1669	=item $tstamp = $timer->at
1670
1671	Return the time this watcher will fire next.
1672
1673	=item $timer = $timer->set ($tstamp)	1922	=item $timer = $timer->set ($tstamp[, $interval])
1674		1923
1675	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).
1676		1926
1677	=item $timer = $timer->interval ($interval)	1927	=item $timer = $timer->interval ($interval)
1678		1928
1679	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
1680	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
1681	is automatically rescheduled at the given intervals.	1931	is automatically rescheduled at the given intervals.
1682		1932
1683	=item $timer = $timer->start	1933	=item $timer = $timer->start
1684		1934
1685	Start the timer.	1935	Start the timer.
1686		1936
1687	=item $timer = $timer->start ($tstamp)	1937	=item $timer = $timer->start ($tstamp[, $interval])
1688		1938
1689	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.
1690		1941
1691	=item $timer = $timer->after ($delay)	1942	=item $timer = $timer->after ($delay[, $interval])
1692		1943
1693	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>.
1694		1945
1695	=item $timer = $timer->stop	1946	=item $timer = $timer->stop
1696		1947
…		…
1704		1955
1705	$term->{socket} = ...	1956	$term->{socket} = ...
1706	$term->{iow} = urxvt::iow	1957	$term->{iow} = urxvt::iow
1707	->new	1958	->new
1708	->fd (fileno $term->{socket})	1959	->fd (fileno $term->{socket})
1709	->events (urxvt::EVENT_READ)	1960	->events (urxvt::EV_READ)
1710	->start	1961	->start
1711	->cb (sub {	1962	->cb (sub {
1712	my ($iow, $revents) = @_;	1963	my ($iow, $revents) = @_;
1713	# $revents must be 1 here, no need to check	1964	# $revents must be 1 here, no need to check
1714	sysread $term->{socket}, my $buf, 8192	1965	sysread $term->{socket}, my $buf, 8192
…		…
1727	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>
1728	is a bitset as described in the C<events> method.	1979	is a bitset as described in the C<events> method.
1729		1980
1730	=item $iow = $iow->fd ($fd)	1981	=item $iow = $iow->fd ($fd)
1731		1982
1732	Set the filedescriptor (not handle) to watch.	1983	Set the file descriptor (not handle) to watch.
1733		1984
1734	=item $iow = $iow->events ($eventmask)	1985	=item $iow = $iow->events ($eventmask)
1735		1986
1736	Set the event mask to watch. The only allowed values are	1987	Set the event mask to watch. The only allowed values are
1737	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
1738	together, or C<urxvt::EVENT_NONE>.	1989	together, or C<urxvt::EV_NONE>.
1739		1990
1740	=item $iow = $iow->start	1991	=item $iow = $iow->start
1741		1992
1742	Start watching for requested events on the given handle.	1993	Start watching for requested events on the given handle.
1743		1994
1744	=item $iow = $iow->stop	1995	=item $iow = $iow->stop
1745		1996
1746	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.
1747		2059
1748	=back	2060	=back
1749		2061
1750	=head1 ENVIRONMENT	2062	=head1 ENVIRONMENT
1751		2063
…		…
1760		2072
1761	=item >= 3 - script loading and management	2073	=item >= 3 - script loading and management
1762		2074
1763	=item >=10 - all called hooks	2075	=item >=10 - all called hooks
1764		2076
1765	=item >=11 - hook reutrn values	2077	=item >=11 - hook return values
1766		2078
1767	=back	2079	=back
1768		2080
1769	=head1 AUTHOR	2081	=head1 AUTHOR
1770		2082
1771	Marc Lehmann <pcg@goof.com>	2083	Marc Lehmann <schmorp@schmorp.de>
1772	http://software.schmorp.de/pkg/rxvt-unicode	2084	http://software.schmorp.de/pkg/rxvt-unicode
1773		2085
1774	=cut	2086	=cut
1775		2087
1776	1	2088	1
		2089
		2090	# vim: sw=3:

Diff Legend

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