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.121 by root, Fri Jan 20 22:49:34 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	evaluation, 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 readline
168
169	A support package that tries to make editing with readline easier. At the
170	moment, it reacts to clicking with the left mouse button by trying to
171	move the text cursor to this position. It does so by generating as many
172	cursor-left or cursor-right keypresses as required (the this only works
173	for programs that correctly support wide characters).
174
175	It only works when clicking into the same line (possibly extended over
176	multiple rows) as the text cursor and on the primary screen, to reduce the
177	risk of misinterpreting. The normal selection isn't disabled, so quick
178	successive clicks might interfere with selection creation in harmless
179	ways.
180
181	=item tabbed
182
183	This transforms the terminal into a tabbar with additional terminals, that
184	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
185	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
186	button per tab.
187
188	Clicking a button will activate that tab. Pressing B<Shift-Left> and
189	B<Shift-Right> will switch to the tab left or right of the current one,
190	while B<Shift-Down> creates a new tab.
191
192	=item mark-urls
193
194	Uses per-line display filtering (C<on_line_update>) to underline urls and
195	make them clickable. When middle-clicked, the program specified in the
196	resource C<urlLauncher> (default C<x-www-browser>) will be started with
197	the URL as first argument.
198
199	=item automove-background
200
201	This is basically a one-line extension that dynamically changes the background pixmap offset
202	to the window position, in effect creating the same effect as pseudo transparency with
203	a custom pixmap. No scaling is supported in this mode. Exmaple:
204
205	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
206
207	=item block-graphics-to-ascii
208
209	A not very useful example of filtering all text output to the terminal,
210	by replacing all line-drawing characters (U+2500 .. U+259F) by a
211	similar-looking ascii character.
212
213	=item digital-clock
214
215	Displays a digital clock using the built-in overlay.
216
217	=item example-refresh-hooks
218
219	Displays a very simple digital clock in the upper right corner of the
220	window. Illustrates overwriting the refresh callbacks to create your own
221	overlays or changes.
222
223	=item selection-pastebin
224
225	This is a little rarely useful extension that Uploads the selection as
226	textfile to a remote site (or does other things). (The implementation is
227	not currently secure for use in a multiuser environment as it writes to
228	F</tmp> directly.).
229
230	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
231	i.e.
232
233	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
234
235	Pressing this combination runs a command with C<%> replaced by the name of
236	the textfile. This command can be set via a resource:
237
238	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
239
240	And the default is likely not useful to anybody but the few people around
241	here :)
242
243	The name of the textfile is the hex encoded md5 sum of the selection, so
244	the same content should lead to the same filename.
245
246	After a successful upload the selection will be replaced by the text given
247	in the C<selection-pastebin-url> resource (again, the % is the placeholder
248	for the filename):
249
250	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
251
252	=back
253		50
254	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
255		52
256	=head2 General API Considerations	53	=head2 General API Considerations
257		54
…		…
271		68
272	=over 4	69	=over 4
273		70
274	=item $text	71	=item $text
275		72
276	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
277	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.
278		75
279	=item $string	76	=item $string
280		77
281	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
…		…
285	=item $octets	82	=item $octets
286		83
287	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
288	locale-specific way.	85	locale-specific way.
289		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
290	=back	93	=back
291		94
292	=head2 Extension Objects	95	=head2 Extension Objects
293		96
294	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
295	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,
296	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
297	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
298	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
299	use.	103	internal use.
300		104
301	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
302	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
303		107
304	It has the following methods and data members:	108	It has the following methods and data members:
…		…
325	=head2 Hooks	129	=head2 Hooks
326		130
327	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
328	called whenever the relevant event happens.	132	called whenever the relevant event happens.
329		133
330	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
331	the in the C<Extension Objects> section.	135	the in the C<Extension Objects> section.
332		136
333	B<All> of these hooks must return a boolean value. If any of the called	137	B<All> of these hooks must return a boolean value. If any of the called
334	hooks returns true, then the event counts as being I<consumed>, and the	138	hooks returns true, then the event counts as being I<consumed>, and the
335	relevant action might not be carried out by the C++ code.	139	relevant action might not be carried out by the C++ code.
…		…
348	place.	152	place.
349		153
350	=item on_start $term	154	=item on_start $term
351		155
352	Called at the very end of initialisation of a new terminal, just before	156	Called at the very end of initialisation of a new terminal, just before
353	trying to map (display) the toplevel and returning to the mainloop.	157	trying to map (display) the toplevel and returning to the main loop.
354		158
355	=item on_destroy $term	159	=item on_destroy $term
356		160
357	Called whenever something tries to destroy terminal, before doing anything	161	Called whenever something tries to destroy terminal, when the terminal is
358	yet. If this hook returns true, then destruction is skipped, but this is	162	still fully functional (not for long, though).
359	rarely a good idea.
360		163
361	=item on_reset $term	164	=item on_reset $term
362		165
363	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
364	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
…		…
386		189
387	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
388	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
389	by calling C<< $term->selection >>.	192	by calling C<< $term->selection >>.
390		193
391	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.
392		195
393	=item on_sel_extend $term	196	=item on_sel_extend $term
394		197
395	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
396	click) and is either supposed to return false (normal operation), or	199	click) and is either supposed to return false (normal operation), or
397	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
398	processing. This can happen multiple times, as long as the callback	201	processing. This can happen multiple times, as long as the callback
399	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
400	supposed to enlarge the selection more and more, if possible.	203	supposed to enlarge the selection more and more, if possible.
401		204
402	See the F<selection> example extension.	205	See the F<selection> example extension.
403		206
404	=item on_view_change $term, $offset	207	=item on_view_change $term, $offset
405		208
406	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
407	scrolls. Offset C<0> means display the normal terminal, positive values	210	scrolls. Offset C<0> means display the normal terminal, positive values
408	show this many lines of scrollback.	211	show this many lines of scrollback.
409		212
410	=item on_scroll_back $term, $lines, $saved	213	=item on_scroll_back $term, $lines, $saved
411		214
…		…
415		218
416	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,
417	$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
418	number of lines that will be in the scrollback buffer.	221	number of lines that will be in the scrollback buffer.
419		222
420	=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
421		234
422	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	235	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
423	operating system command) is processed. Cursor position and other state	236	operating system command) is processed. Cursor position and other state
424	information is up-to-date when this happens. For interoperability, the	237	information is up-to-date when this happens. For interoperability, the
425	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,
426	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
427	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	}
428		251
429	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,
430	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
431	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.
432		258
433	=item on_add_lines $term, $string	259	=item on_add_lines $term, $string
434		260
435	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
436	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
…		…
441	=item on_tt_write $term, $octets	267	=item on_tt_write $term, $octets
442		268
443	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
444	suppress or filter tty input.	270	suppress or filter tty input.
445		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
446	=item on_line_update $term, $row	279	=item on_line_update $term, $row
447		280
448	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
449	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
450	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,
…		…
457	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
458	you cannot just toggle rendition bits, but only set them.	291	you cannot just toggle rendition bits, but only set them.
459		292
460	=item on_refresh_begin $term	293	=item on_refresh_begin $term
461		294
462	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
463	or similar effects by modify terminal contents in refresh_begin, and	296	similar effects by modifying the terminal contents in refresh_begin, and
464	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
465	code is run after this hook, and takes precedence.	298	code is run after this hook, and takes precedence.
466		299
467	=item on_refresh_end $term	300	=item on_refresh_end $term
468		301
469	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>.
470		303
471	=item on_keyboard_command $term, $string	304	=item on_user_command $term, $string
472		305
473	Called whenever the user presses a key combination that has a	306	Called whenever a user-configured event is being activated (e.g. via
474	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>
475	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.
476		325
477	=item on_x_event $term, $event	326	=item on_x_event $term, $event
478		327
479	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
480	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
481	members are not passed.	330	members are not passed.
482		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
483	=item on_focus_in $term	336	=item on_focus_in $term
484		337
485	Called whenever the window gets the keyboard focus, before rxvt-unicode	338	Called whenever the window gets the keyboard focus, before rxvt-unicode
486	does focus in processing.	339	does focus in processing.
487		340
488	=item on_focus_out $term	341	=item on_focus_out $term
489		342
490	Called wheneever the window loses keyboard focus, before rxvt-unicode does	343	Called whenever the window loses keyboard focus, before rxvt-unicode does
491	focus out processing.	344	focus out processing.
492		345
493	=item on_configure_notify $term, $event	346	=item on_configure_notify $term, $event
494		347
495	=item on_property_notify $term, $event	348	=item on_property_notify $term, $event
…		…
506		359
507	=item on_map_notify $term, $event	360	=item on_map_notify $term, $event
508		361
509	=item on_unmap_notify $term, $event	362	=item on_unmap_notify $term, $event
510		363
511	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
512	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.
513		366
514	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
515	manpage), with the additional members C<row> and C<col>, which are the	368	manpage), with the additional members C<row> and C<col>, which are the
516	(real, not screen-based) row and column under the mouse cursor.	369	(real, not screen-based) row and column under the mouse cursor.
517		370
…		…
527	=item on_wm_delete_window $term, $event	380	=item on_wm_delete_window $term, $event
528		381
529	Called when various types of ClientMessage events are received (all with	382	Called when various types of ClientMessage events are received (all with
530	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	383	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
531		384
		385	=item on_bell $term
		386
		387	Called on receipt of a bell character.
		388
532	=back	389	=back
533		390
534	=cut	391	=cut
535		392
536	package urxvt;	393	package urxvt;
537		394
538	use utf8;	395	use utf8;
539	use strict;	396	use strict 'vars';
540	use Carp ();	397	use Carp ();
541	use Scalar::Util ();	398	use Scalar::Util ();
542	use List::Util ();	399	use List::Util ();
543		400
544	our $VERSION = 1;	401	our $VERSION = 1;
545	our $TERM;	402	our $TERM;
546	our @TERM_INIT;	403	our @TERM_INIT; # should go, prevents async I/O etc.
547	our @TERM_EXT;	404	our @TERM_EXT; # should go, prevents async I/O etc.
548	our @HOOKNAME;	405	our @HOOKNAME;
549	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	406	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
550	our %OPTION;	407	our %OPTION;
551		408
552	our $LIBDIR;	409	our $LIBDIR;
553	our $RESNAME;	410	our $RESNAME;
554	our $RESCLASS;	411	our $RESCLASS;
555	our $RXVTNAME;	412	our $RXVTNAME;
556		413
557	our $NOCHAR = chr 0xfffe;	414	our $NOCHAR = chr 0xffff;
558		415
559	=head2 Variables in the C<urxvt> Package	416	=head2 Variables in the C<urxvt> Package
560		417
561	=over 4	418	=over 4
562		419
…		…
578	The current terminal. This variable stores the current C<urxvt::term>	435	The current terminal. This variable stores the current C<urxvt::term>
579	object, whenever a callback/hook is executing.	436	object, whenever a callback/hook is executing.
580		437
581	=item @urxvt::TERM_INIT	438	=item @urxvt::TERM_INIT
582		439
583	All coderefs in this array will be called as methods of the next newly	440	All code references in this array will be called as methods of the next newly
584	created C<urxvt::term> object (during the C<on_init> phase). The array	441	created C<urxvt::term> object (during the C<on_init> phase). The array
585	gets cleared before the codereferences that were in it are being executed,	442	gets cleared before the code references that were in it are being executed,
586	so coderefs can push themselves onto it again if they so desire.	443	so references can push themselves onto it again if they so desire.
587		444
588	This complements to the perl-eval commandline option, but gets executed	445	This complements to the perl-eval command line option, but gets executed
589	first.	446	first.
590		447
591	=item @urxvt::TERM_EXT	448	=item @urxvt::TERM_EXT
592		449
593	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	450	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
600		457
601	=over 4	458	=over 4
602		459
603	=item urxvt::fatal $errormessage	460	=item urxvt::fatal $errormessage
604		461
605	Fatally aborts execution with the given error message. Avoid at all	462	Fatally aborts execution with the given error message (which should
606	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
607	starts up.	464	is acceptable (and useful) is in the init hook, where it prevents the
		465	terminal from starting up.
608		466
609	=item urxvt::warn $string	467	=item urxvt::warn $string
610		468
611	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
612	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
613	that calls this function.	471	that calls this function.
614		472
615	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
616	correct place, e.g. on stderr of the connecting urxvtc client.	474	correct place, e.g. on stderr of the connecting urxvtc client.
617		475
618	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).
619		484
620	=item $time = urxvt::NOW	485	=item $time = urxvt::NOW
621		486
622	Returns the "current time" (as per the event loop).	487	Returns the "current time" (as per the event loop).
623		488
…		…
666		531
667	=item $rend = urxvt::OVERLAY_RSTYLE	532	=item $rend = urxvt::OVERLAY_RSTYLE
668		533
669	Return the rendition mask used for overlays by default.	534	Return the rendition mask used for overlays by default.
670		535
671	=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
672		538
673	Return the bit that enabled bold, italic, blink, reverse-video and	539	Return the bit that enabled bold, italic, blink, reverse-video and
674	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
675	the bitset.	541	the bitset.
676		542
…		…
681	Return the foreground/background colour index, respectively.	547	Return the foreground/background colour index, respectively.
682		548
683	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	549	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
684		550
685	=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
686		554
687	Replace the foreground/background colour in the rendition mask with the	555	Replace the foreground/background colour in the rendition mask with the
688	specified one.	556	specified one.
689		557
690	=item $value = urxvt::GET_CUSTOM $rend	558	=item $value = urxvt::GET_CUSTOM $rend
…		…
709	unless $msg =~ /\n$/;	577	unless $msg =~ /\n$/;
710	urxvt::warn ($msg);	578	urxvt::warn ($msg);
711	};	579	};
712	}	580	}
713		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
714	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	644	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
715		645
716	sub verbose {	646	sub verbose {
717	my ($level, $msg) = @_;	647	my ($level, $msg) = @_;
718	warn "$msg\n" if $level <= $verbosity;	648	warn "$msg\n" if $level <= $verbosity;
…		…
730	$pkg =~ s/[^[:word:]]/_/g;	660	$pkg =~ s/[^[:word:]]/_/g;
731	$pkg = "urxvt::ext::$pkg";	661	$pkg = "urxvt::ext::$pkg";
732		662
733	verbose 3, "loading extension '$path' into package '$pkg'";	663	verbose 3, "loading extension '$path' into package '$pkg'";
734		664
		665	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		666
735	open my $fh, "<:raw", $path	667	open my $fh, "<:raw", $path
736	or die "$path: $!";	668	or die "$path: $!";
737		669
738	my $source =	670	my $source =
739	"package $pkg; use strict; use utf8;\n"	671	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
740	. "#line 1 \"$path\"\n{\n"	672	. "#line 1 \"$path\"\n{\n"
741	. (do { local $/; <$fh> })	673	. (do { local $/; <$fh> })
742	. "\n};\n1";	674	. "\n};\n1";
743		675
744	eval $source	676	eval $source
…		…
754	sub invoke {	686	sub invoke {
755	local $TERM = shift;	687	local $TERM = shift;
756	my $htype = shift;	688	my $htype = shift;
757		689
758	if ($htype == 0) { # INIT	690	if ($htype == 0) { # INIT
759	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	691	my @dirs = $TERM->perl_libdirs;
760		692
761	my %ext_arg;	693	my %ext_arg;
762		694
763	{	695	{
764	my @init = @TERM_INIT;	696	my @init = @TERM_INIT;
765	@TERM_INIT = ();	697	@TERM_INIT = ();
…		…
767	my @pkg = @TERM_EXT;	699	my @pkg = @TERM_EXT;
768	@TERM_EXT = ();	700	@TERM_EXT = ();
769	$TERM->register_package ($_) for @pkg;	701	$TERM->register_package ($_) for @pkg;
770	}	702	}
771		703
		704	for (
		705	@{ delete $TERM->{perl_ext_3} },
772	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		707	) {
773	if ($_ eq "default") {	708	if ($_ eq "default") {
774	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	709	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
775	} elsif (/^-(.*)$/) {	710	} elsif (/^-(.*)$/) {
776	delete $ext_arg{$1};	711	delete $ext_arg{$1};
777	} elsif (/^([^<]+)<(.*)>$/) {	712	} elsif (/^([^<]+)<(.*)>$/) {
778	push @{ $ext_arg{$1} }, $2;	713	push @{ $ext_arg{$1} }, $2;
779	} else {	714	} else {
780	$ext_arg{$_} ||= [];	715	$ext_arg{$_} ||= [];
781	}	716	}
782	}	717	}
783		718
784	while (my ($ext, $argv) = each %ext_arg) {	719	for my $ext (sort keys %ext_arg) {
785	my @files = grep -f $_, map "$_/$ext", @dirs;	720	my @files = grep -f $_, map "$_/$ext", @dirs;
786		721
787	if (@files) {	722	if (@files) {
788	$TERM->register_package (extension_package $files[0], $argv);	723	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
789	} else {	724	} else {
790	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";
791	}	726	}
792	}	727	}
793		728
…		…
799		734
800	if (my $cb = $TERM->{_hook}[$htype]) {	735	if (my $cb = $TERM->{_hook}[$htype]) {
801	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
802	if $verbosity >= 10;	737	if $verbosity >= 10;
803		738
804	keys %$cb;	739	for my $pkg (keys %$cb) {
805
806	while (my ($pkg, $cb) = each %$cb) {
807	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
808	$retval ||= $retval_;	741	$retval ||= $retval_;
809		742
810	if ($@) {	743	if ($@) {
811	$TERM->ungrab; # better to lose the grab than the session	744	$TERM->ungrab; # better to lose the grab than the session
812	warn $@;	745	warn $@;
…		…
826	}	759	}
827		760
828	$retval	761	$retval
829	}	762	}
830		763
831	# 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	}
832		792
833	package urxvt::term::extension;	793	package urxvt::term::extension;
834		794
835	sub enable {	795	sub enable {
836	my ($self, %hook) = @_;	796	my ($self, %hook) = @_;
…		…
891		851
892	sub urxvt::destroy_hook(&) {	852	sub urxvt::destroy_hook(&) {
893	bless \shift, urxvt::destroy_hook::	853	bless \shift, urxvt::destroy_hook::
894	}	854	}
895		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
896	package urxvt::anyevent;	868	package urxvt::anyevent;
897		869
898	=head2 The C<urxvt::anyevent> Class	870	=head2 The C<urxvt::anyevent> Class
899		871
900	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
901	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
902	further programming. The only exception is that you cannot wait on	874	further programming. The only exception is that you cannot wait on
903	condition variables, but non-blocking condvar use is ok. What this means	875	condition variables, but non-blocking condvar use is ok.
904	is that you cannot use blocking APIs, but the non-blocking variant should	876
905	work.	877	In practical terms this means is that you cannot use blocking APIs, but
		878	the non-blocking variant should work.
906		879
907	=cut	880	=cut
908		881
909	our $VERSION = 1;	882	our $VERSION = '5.23';
910		883
911	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	884	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
912	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	885	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
913		886
914	sub timer {	887	sub timer {
…		…
916		889
917	my $cb = $arg{cb};	890	my $cb = $arg{cb};
918		891
919	urxvt::timer	892	urxvt::timer
920	->new	893	->new
921	->start (urxvt::NOW + $arg{after})	894	->after ($arg{after}, $arg{interval})
922	->cb (sub {	895	->cb ($arg{interval} ? $cb : sub {
923	$_[0]->stop; # need to cancel manually	896	$_[0]->stop; # need to cancel manually
924	$cb->();	897	$cb->();
925	})	898	})
926	}	899	}
927		900
928	sub io {	901	sub io {
929	my ($class, %arg) = @_;	902	my ($class, %arg) = @_;
930		903
931	my $cb = $arg{cb};	904	my $cb = $arg{cb};
		905	my $fd = fileno $arg{fh};
		906	defined $fd or $fd = $arg{fh};
932		907
933	bless [$arg{fh}, urxvt::iow	908	bless [$arg{fh}, urxvt::iow
934	->new	909	->new
935	->fd (fileno $arg{fh})	910	->fd ($fd)
936	->events (($arg{poll} =~ /r/ ? 1 : 0)	911	->events (($arg{poll} =~ /r/ ? 1 : 0)
937	| ($arg{poll} =~ /w/ ? 2 : 0))	912	| ($arg{poll} =~ /w/ ? 2 : 0))
938	->start	913	->start
939	->cb (sub {	914	->cb ($cb)
940	$cb->(($_[1] & 1 ? 'r' : '')
941	. ($_[1] & 2 ? 'w' : ''));
942	})],
943	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	})
944	}	941	}
945		942
946	sub DESTROY {	943	sub DESTROY {
947	$_[0][1]->stop;	944	$_[0][1]->stop;
948	}	945	}
949		946
950	sub condvar {	947	# only needed for AnyEvent < 6 compatibility
951	bless \my $flag, urxvt::anyevent::condvar::	948	sub one_event {
952	}
953
954	sub urxvt::anyevent::condvar::broadcast {
955	${$_[0]}++;
956	}
957
958	sub urxvt::anyevent::condvar::wait {
959	unless (${$_[0]}) {
960	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";
961	}
962	}	950	}
963		951
964	package urxvt::term;	952	package urxvt::term;
965		953
966	=head2 The C<urxvt::term> Class	954	=head2 The C<urxvt::term> Class
…		…
979	urxvt::verbose 6, "register package $pkg to $self";	967	urxvt::verbose 6, "register package $pkg to $self";
980		968
981	@{"$pkg\::ISA"} = urxvt::term::extension::;	969	@{"$pkg\::ISA"} = urxvt::term::extension::;
982		970
983	my $proxy = bless {	971	my $proxy = bless {
984	_pkg => $pkg,	972	_pkg => $pkg,
		973	_name => ${"$pkg\::_NAME"}, # hackish
985	argv => $argv,	974	argv => $argv,
986	}, $pkg;	975	}, $pkg;
987	Scalar::Util::weaken ($proxy->{term} = $self);	976	Scalar::Util::weaken ($proxy->{term} = $self);
988		977
989	$self->{_pkg}{$pkg} = $proxy;	978	$self->{_pkg}{$pkg} = $proxy;
990		979
…		…
993	$proxy->enable ($name => $ref);	982	$proxy->enable ($name => $ref);
994	}	983	}
995	}	984	}
996	}	985	}
997		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
998	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
999		1035
1000	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
1001	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
1002	hash which defines the environment of the new terminal.	1038	hash which defines the environment of the new terminal.
1003		1039
1004	Croaks (and probably outputs an error message) if the new instance	1040	Croaks (and probably outputs an error message) if the new instance
1005	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
1006	initialise perl, and the terminal object otherwise. The C<init> and	1042	initialise perl, and the terminal object otherwise. The C<init> and
1007	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).
1008		1045
1009	=cut	1046	=cut
1010		1047
1011	sub new {	1048	sub new {
1012	my ($class, $env, @args) = @_;	1049	my ($class, $env, @args) = @_;
1013		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
1014	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1054	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1015	}	1055	}
1016		1056
1017	=item $term->destroy	1057	=item $term->destroy
1018		1058
1019	Destroy the terminal object (close the window, free resources	1059	Destroy the terminal object (close the window, free resources
…		…
1049		1089
1050	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
1051	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
1052	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.
1053		1093
1054	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
1055	source file F</src/optinc.h> to see the actual list:	1095	source file F</src/optinc.h> to see the actual list:
1056		1096
1057	borderLess console cursorBlink cursorUnderline hold iconic insecure	1097	borderLess buffered console cursorBlink cursorUnderline hold iconic
1058	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1098	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1059	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1099	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1060	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1100	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1061	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1101	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1062	transparent tripleclickwords utmpInhibit visualBell	1102	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1103	urgentOnBell utmpInhibit visualBell
1063		1104
1064	=item $value = $term->resource ($name[, $newval])	1105	=item $value = $term->resource ($name[, $newval])
1065		1106
1066	Returns the current resource value associated with a given name and	1107	Returns the current resource value associated with a given name and
1067	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>
…		…
1076	likely change).	1117	likely change).
1077		1118
1078	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
1079	terminal is destroyed, so changing options frequently will eat memory.	1120	terminal is destroyed, so changing options frequently will eat memory.
1080		1121
1081	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
1082	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>
1083	to see the actual list:	1124	to see the actual list:
1084		1125
1085	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1086	borderLess color cursorBlink cursorUnderline cutchars delete_key	1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1087	display_name embed ext_bwidth fade font geometry hold iconName	1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1088	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
1089	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1090	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1132	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1091	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1133	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1092	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1134	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1093	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1135	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1094	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1136	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1095	secondaryScreen secondaryScroll selectstyle shade term_name title	1137	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1096	transient_for transparent transparent_all tripleclickwords utmpInhibit	1138	term_name title transient_for transparent tripleclickwords urgentOnBell
1097	visualBell	1139	utmpInhibit visualBell
1098		1140
1099	=cut	1141	=cut
1100		1142
1101	sub resource($$;$) {	1143	sub resource($$;$) {
1102	my ($self, $name) = (shift, shift);	1144	my ($self, $name) = (shift, shift);
1103	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1145	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1104	&urxvt::term::_resource	1146	goto &urxvt::term::_resource
1105	}	1147	}
1106		1148
1107	=item $value = $term->x_resource ($pattern)	1149	=item $value = $term->x_resource ($pattern)
1108		1150
1109	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
1110	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
1111	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
1112	resource with that pattern exists.	1154	resource with that pattern exists.
1113		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
1114	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
1115	only one resource database per display, and later invocations might return	1167	only one resource database per display, and later invocations might return
1116	the wrong resources.	1168	the wrong resources.
1117		1169
1118	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1170	=item $value = $term->x_resource_boolean ($pattern)
1119		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
1120	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
1121	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.
1122		1197
1123	=item $rend = $term->rstyle ([$new_rstyle])	1198	=item $rend = $term->rstyle ([$new_rstyle])
1124		1199
1125	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
1126	the terminal application will use this style.	1201	the terminal application will use this style.
…		…
1134		1209
1135	=item ($row, $col) = $term->selection_beg ([$row, $col])	1210	=item ($row, $col) = $term->selection_beg ([$row, $col])
1136		1211
1137	=item ($row, $col) = $term->selection_end ([$row, $col])	1212	=item ($row, $col) = $term->selection_end ([$row, $col])
1138		1213
1139	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.
1140	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.
1141		1223
1142	=item $term->selection_make ($eventtime[, $rectangular])	1224	=item $term->selection_make ($eventtime[, $rectangular])
1143		1225
1144	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
1145	C<selection_end>. If C<$rectangular> is true (default: false), a	1227	C<selection_end>. If C<$rectangular> is true (default: false), a
1146	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
1147	a selection.	1229	a selection.
1148		1230
1149	=item $success = $term->selection_grab ($eventtime)	1231	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1150		1232
1151	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
1152	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
1153	is mostly useful from within C<on_sel_grab> hooks.	1236	is mostly useful from within C<on_sel_grab> hooks.
1154		1237
1155	=item $oldtext = $term->selection ([$newtext])	1238	=item $oldtext = $term->selection ([$newtext, $clipboard])
1156		1239
1157	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.
1158		1246
1159	=item $term->overlay_simple ($x, $y, $text)	1247	=item $term->overlay_simple ($x, $y, $text)
1160		1248
1161	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.
1162		1250
…		…
1192		1280
1193	The methods currently supported on C<urxvt::overlay> objects are:	1281	The methods currently supported on C<urxvt::overlay> objects are:
1194		1282
1195	=over 4	1283	=over 4
1196		1284
1197	=item $overlay->set ($x, $y, $text, $rend)	1285	=item $overlay->set ($x, $y, $text[, $rend])
1198		1286
1199	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
1200	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
1201	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.
1202		1292
1203	=item $overlay->hide	1293	=item $overlay->hide
1204		1294
1205	If visible, hide the overlay, but do not destroy it.	1295	If visible, hide the overlay, but do not destroy it.
1206		1296
…		…
1288	locale-specific encoding of the terminal and can contain command sequences	1378	locale-specific encoding of the terminal and can contain command sequences
1289	(escape codes) that will be interpreted.	1379	(escape codes) that will be interpreted.
1290		1380
1291	=item $term->tt_write ($octets)	1381	=item $term->tt_write ($octets)
1292		1382
1293	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
1294	pass characters instead of octets, you should convert your strings first	1384	pass characters instead of octets, you should convert your strings first
1295	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.
1296		1392
1297	=item $old_events = $term->pty_ev_events ([$new_events])	1393	=item $old_events = $term->pty_ev_events ([$new_events])
1298		1394
1299	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
1300	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
1301	description of C<< urxvt::timer->events >>. Make sure to always restore	1397	description of C<< urxvt::timer->events >>. Make sure to always restore
1302	the previous value.	1398	the previous value.
1303		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
1304	=item $windowid = $term->parent	1405	=item $windowid = $term->parent
1305		1406
1306	Return the window id of the toplevel window.	1407	Return the window id of the toplevel window.
1307		1408
1308	=item $windowid = $term->vt	1409	=item $windowid = $term->vt
…		…
1314	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
1315	to receive pointer events all the times:	1416	to receive pointer events all the times:
1316		1417
1317	$term->vt_emask_add (urxvt::PointerMotionMask);	1418	$term->vt_emask_add (urxvt::PointerMotionMask);
1318		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
1319	=item $window_width = $term->width	1434	=item $window_width = $term->width
1320		1435
1321	=item $window_height = $term->height	1436	=item $window_height = $term->height
1322		1437
1323	=item $font_width = $term->fwidth	1438	=item $font_width = $term->fwidth
…		…
1353	=item $env = $term->env	1468	=item $env = $term->env
1354		1469
1355	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
1356	similar to C<\%ENV>.	1471	similar to C<\%ENV>.
1357		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
1358	=cut	1482	=cut
1359		1483
1360	sub env {	1484	sub env {
1361	if (my $env = $_[0]->_env) {
1362	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1485	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1363	} else {
1364	+{ %ENV }
1365	}
1366	}	1486	}
1367		1487
1368	=item $modifiermask = $term->ModLevel3Mask	1488	=item $modifiermask = $term->ModLevel3Mask
1369		1489
1370	=item $modifiermask = $term->ModMetaMask	1490	=item $modifiermask = $term->ModMetaMask
…		…
1375	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.
1376		1496
1377	=item $screen = $term->current_screen	1497	=item $screen = $term->current_screen
1378		1498
1379	Returns the currently displayed screen (0 primary, 1 secondary).	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.
1380		1504
1381	=item $view_start = $term->view_start ([$newvalue])	1505	=item $view_start = $term->view_start ([$newvalue])
1382		1506
1383	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
1384	C<0>, which displays the normal terminal contents. Lower values scroll	1508	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1392		1516
1393	Used after changing terminal contents to display them.	1517	Used after changing terminal contents to display them.
1394		1518
1395	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1396		1520
1397	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 >>
1398	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
1399	terminal line. The scrollback buffer starts at line C<-1> and extends to
1400	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1523	terminal line. Nothing will be returned if a nonexistent line
1401	is requested.	1524	is requested.
1402		1525
1403	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
1404	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
1405	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
1406	automatically be updated.	1529	automatically be updated.
1407		1530
1408	C<$text> is in a special encoding: tabs and wide characters that use	1531	C<$text> is in a special encoding: tabs and wide characters that use more
1409	more than one cell when displayed are padded with C<$urxvt::NOCHAR>	1532	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1410	characters. Characters with combining characters and other characters that	1533	characters. Characters with combining characters and other characters that
1411	do not fit into the normal tetx encoding will be replaced with characters	1534	do not fit into the normal text encoding will be replaced with characters
1412	in the private use area.	1535	in the private use area.
1413		1536
1414	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
1415	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
1416	characters.	1539	characters.
…		…
1561	where one character corresponds to one screen cell. See	1684	where one character corresponds to one screen cell. See
1562	C<< $term->ROW_t >> for details.	1685	C<< $term->ROW_t >> for details.
1563		1686
1564	=item $string = $term->special_decode $text	1687	=item $string = $term->special_decode $text
1565		1688
1566	Converts rxvt-unicodes text reprsentation into a perl string. See	1689	Converts rxvt-unicodes text representation into a perl string. See
1567	C<< $term->ROW_t >> for details.	1690	C<< $term->ROW_t >> for details.
1568		1691
1569	=item $success = $term->grab_button ($button, $modifiermask)	1692	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1570		1693
		1694	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1695
1571	Registers a synchronous button grab. See the XGrabButton manpage.	1696	Register/unregister a synchronous button grab. See the XGrabButton
		1697	manpage.
1572		1698
1573	=item $success = $term->grab ($eventtime[, $sync])	1699	=item $success = $term->grab ($eventtime[, $sync])
1574		1700
1575	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1701	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1576	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1702	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1577		1703
1578	=item $term->allow_events_async	1704	=item $term->allow_events_async
1579		1705
1580	Calls XAllowEvents with AsyncBoth for the most recent grab.	1706	Calls XAllowEvents with AsyncBoth for the most recent grab.
1581		1707
…		…
1588	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1714	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1589	recent grab.	1715	recent grab.
1590		1716
1591	=item $term->ungrab	1717	=item $term->ungrab
1592		1718
1593	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
1594	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
1595	the session.	1721	the session.
1596		1722
1597	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1723	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1598		1724
…		…
1600		1726
1601	=item @atoms = $term->XListProperties ($window)	1727	=item @atoms = $term->XListProperties ($window)
1602		1728
1603	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1729	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1604		1730
1605	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1731	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1606		1732
1607	=item $term->XDeleteProperty ($window, $property)	1733	=item $term->XDeleteProperty ($window, $property)
1608		1734
1609	=item $window = $term->DefaultRootWindow	1735	=item $window = $term->DefaultRootWindow
1610		1736
…		…
1617	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1743	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1618		1744
1619	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1745	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1620		1746
1621	=item $term->XChangeInput ($window, $add_events[, $del_events])	1747	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1748
		1749	=item $keysym = $term->XStringToKeysym ($string)
		1750
		1751	=item $string = $term->XKeysymToString ($keysym)
1622		1752
1623	Various X or X-related functions. The C<$term> object only serves as	1753	Various X or X-related functions. The C<$term> object only serves as
1624	the source of the display, otherwise those functions map more-or-less	1754	the source of the display, otherwise those functions map more-or-less
1625	directory onto the X functions of the same name.	1755	directly onto the X functions of the same name.
1626		1756
1627	=back	1757	=back
1628		1758
1629	=cut	1759	=cut
1630		1760
…		…
1694	my ($self, $text, $cb) = @_;	1824	my ($self, $text, $cb) = @_;
1695		1825
1696	$self->add_item ({ type => "button", text => $text, activate => $cb});	1826	$self->add_item ({ type => "button", text => $text, activate => $cb});
1697	}	1827	}
1698		1828
1699	=item $popup->add_toggle ($text, $cb, $initial_value)	1829	=item $popup->add_toggle ($text, $initial_value, $cb)
1700		1830
1701	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
1702	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
1703	argument.	1833	first argument.
1704		1834
1705	=cut	1835	=cut
1706		1836
1707	sub add_toggle {	1837	sub add_toggle {
1708	my ($self, $text, $cb, $value) = @_;	1838	my ($self, $text, $value, $cb) = @_;
1709		1839
1710	my $item; $item = {	1840	my $item; $item = {
1711	type => "button",	1841	type => "button",
1712	text => " $text",	1842	text => " $text",
1713	value => $value,	1843	value => $value,
…		…
1732	my $env = $self->{term}->env;	1862	my $env = $self->{term}->env;
1733	# 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.
1734	delete $env->{LC_ALL};	1864	delete $env->{LC_ALL};
1735	$env->{LC_CTYPE} = $self->{term}->locale;	1865	$env->{LC_CTYPE} = $self->{term}->locale;
1736		1866
1737	urxvt::term->new ($env, "popup",	1867	my $term = urxvt::term->new (
		1868	$env, "popup",
1738	"--perl-lib" => "", "--perl-ext-common" => "",	1869	"--perl-lib" => "", "--perl-ext-common" => "",
1739	"-pty-fd" => -1, "-sl" => 0,	1870	"-pty-fd" => -1, "-sl" => 0,
1740	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1871	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1741	"--transient-for" => $self->{term}->parent,	1872	"--transient-for" => $self->{term}->parent,
1742	"-display" => $self->{term}->display_id,	1873	"-display" => $self->{term}->display_id,
1743	"-pe" => "urxvt-popup")	1874	"-pe" => "urxvt-popup",
1744	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	}
1745	}	1882	}
1746		1883
1747	sub DESTROY {	1884	sub DESTROY {
1748	my ($self) = @_;	1885	my ($self) = @_;
1749		1886
…		…
1754	=back	1891	=back
1755		1892
1756	=cut	1893	=cut
1757		1894
1758	package urxvt::watcher;	1895	package urxvt::watcher;
1759
1760	@urxvt::timer::ISA = __PACKAGE__;
1761	@urxvt::iow::ISA = __PACKAGE__;
1762	@urxvt::pw::ISA = __PACKAGE__;
1763	@urxvt::iw::ISA = __PACKAGE__;
1764		1896
1765	=head2 The C<urxvt::timer> Class	1897	=head2 The C<urxvt::timer> Class
1766		1898
1767	This class implements timer watchers/events. Time is represented as a	1899	This class implements timer watchers/events. Time is represented as a
1768	fractional number of seconds since the epoch. Example:	1900	fractional number of seconds since the epoch. Example:
…		…
1772	->new	1904	->new
1773	->interval (1)	1905	->interval (1)
1774	->cb (sub {	1906	->cb (sub {
1775	$term->{overlay}->set (0, 0,	1907	$term->{overlay}->set (0, 0,
1776	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1908	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1777	});	1909	});
1778		1910
1779	=over 4	1911	=over 4
1780		1912
1781	=item $timer = new urxvt::timer	1913	=item $timer = new urxvt::timer
1782		1914
…		…
1785		1917
1786	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1918	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1787		1919
1788	Set the callback to be called when the timer triggers.	1920	Set the callback to be called when the timer triggers.
1789		1921
1790	=item $tstamp = $timer->at
1791
1792	Return the time this watcher will fire next.
1793
1794	=item $timer = $timer->set ($tstamp)	1922	=item $timer = $timer->set ($tstamp[, $interval])
1795		1923
1796	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).
1797		1926
1798	=item $timer = $timer->interval ($interval)	1927	=item $timer = $timer->interval ($interval)
1799		1928
1800	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
1801	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
1802	is automatically rescheduled at the given intervals.	1931	is automatically rescheduled at the given intervals.
1803		1932
1804	=item $timer = $timer->start	1933	=item $timer = $timer->start
1805		1934
1806	Start the timer.	1935	Start the timer.
1807		1936
1808	=item $timer = $timer->start ($tstamp)	1937	=item $timer = $timer->start ($tstamp[, $interval])
1809		1938
1810	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.
1811		1941
1812	=item $timer = $timer->after ($delay)	1942	=item $timer = $timer->after ($delay[, $interval])
1813		1943
1814	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>.
1815		1945
1816	=item $timer = $timer->stop	1946	=item $timer = $timer->stop
1817		1947
…		…
1825		1955
1826	$term->{socket} = ...	1956	$term->{socket} = ...
1827	$term->{iow} = urxvt::iow	1957	$term->{iow} = urxvt::iow
1828	->new	1958	->new
1829	->fd (fileno $term->{socket})	1959	->fd (fileno $term->{socket})
1830	->events (urxvt::EVENT_READ)	1960	->events (urxvt::EV_READ)
1831	->start	1961	->start
1832	->cb (sub {	1962	->cb (sub {
1833	my ($iow, $revents) = @_;	1963	my ($iow, $revents) = @_;
1834	# $revents must be 1 here, no need to check	1964	# $revents must be 1 here, no need to check
1835	sysread $term->{socket}, my $buf, 8192	1965	sysread $term->{socket}, my $buf, 8192
…		…
1848	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>
1849	is a bitset as described in the C<events> method.	1979	is a bitset as described in the C<events> method.
1850		1980
1851	=item $iow = $iow->fd ($fd)	1981	=item $iow = $iow->fd ($fd)
1852		1982
1853	Set the filedescriptor (not handle) to watch.	1983	Set the file descriptor (not handle) to watch.
1854		1984
1855	=item $iow = $iow->events ($eventmask)	1985	=item $iow = $iow->events ($eventmask)
1856		1986
1857	Set the event mask to watch. The only allowed values are	1987	Set the event mask to watch. The only allowed values are
1858	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
1859	together, or C<urxvt::EVENT_NONE>.	1989	together, or C<urxvt::EV_NONE>.
1860		1990
1861	=item $iow = $iow->start	1991	=item $iow = $iow->start
1862		1992
1863	Start watching for requested events on the given handle.	1993	Start watching for requested events on the given handle.
1864		1994
1865	=item $iow = $iow->stop	1995	=item $iow = $iow->stop
1866		1996
1867	Stop watching for events on the given filehandle.	1997	Stop watching for events on the given file handle.
1868		1998
1869	=back	1999	=back
1870		2000
1871	=head2 The C<urxvt::iw> Class	2001	=head2 The C<urxvt::iw> Class
1872		2002
…		…
1905	->new	2035	->new
1906	->start ($pid)	2036	->start ($pid)
1907	->cb (sub {	2037	->cb (sub {
1908	my ($pw, $exit_status) = @_;	2038	my ($pw, $exit_status) = @_;
1909	...	2039	...
1910	});	2040	});
1911		2041
1912	=over 4	2042	=over 4
1913		2043
1914	=item $pw = new urxvt::pw	2044	=item $pw = new urxvt::pw
1915		2045
…		…
1919		2049
1920	Set the callback to be called when the timer triggers.	2050	Set the callback to be called when the timer triggers.
1921		2051
1922	=item $pw = $timer->start ($pid)	2052	=item $pw = $timer->start ($pid)
1923		2053
1924	Tells the wqtcher to start watching for process C<$pid>.	2054	Tells the watcher to start watching for process C<$pid>.
1925		2055
1926	=item $pw = $pw->stop	2056	=item $pw = $pw->stop
1927		2057
1928	Stop the watcher.	2058	Stop the watcher.
1929		2059
…		…
1942		2072
1943	=item >= 3 - script loading and management	2073	=item >= 3 - script loading and management
1944		2074
1945	=item >=10 - all called hooks	2075	=item >=10 - all called hooks
1946		2076
1947	=item >=11 - hook reutrn values	2077	=item >=11 - hook return values
1948		2078
1949	=back	2079	=back
1950		2080
1951	=head1 AUTHOR	2081	=head1 AUTHOR
1952		2082
1953	Marc Lehmann <pcg@goof.com>	2083	Marc Lehmann <schmorp@schmorp.de>
1954	http://software.schmorp.de/pkg/rxvt-unicode	2084	http://software.schmorp.de/pkg/rxvt-unicode
1955		2085
1956	=cut	2086	=cut
1957		2087
1958	1	2088	1
		2089
		2090	# vim: sw=3:

Diff Legend

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