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.131 by root, Sun Jan 29 20:51:28 2006 UTC vs.
Revision 1.211 by root, Wed Jun 6 14:34:03 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' 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	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
62	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
63	...	66	...
64		67
65	The index number (0, 1...) must not have any holes, and each regex must	68	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	69	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	70	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:	71	between two vertical bars:
69		72
70	URxvt.selection.pattern-0: \\|([^|]+)\\|	73	URxvt.selection.pattern-0: \\|([^|]+)\\|
71		74
72	Another example: Programs I use often output "absolute path: " at the	75	Another example: Programs I use often output "absolute path: " at the
…		…
94	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
95		98
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.	100	runtime.
98		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
99	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
100		120
101	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
102	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
103	evaluation, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
104		124
105	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
107	popup is displayed.	127	popup is being displayed.
108		128
109	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
110	is in C<$_>, which can be used to decide wether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
111	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
112	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
113	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
114		134
115	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
116	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
117	C<a>s:	137	C<a>s:
118		138
119	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
120	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
121	: ()	141	: ()
122	};	142	};
123		143
124	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
125		145
…		…
132	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
133	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
134	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
135	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
136	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
137	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
138		164
139	=item readline (enabled by default)	165	=item readline (enabled by default)
140		166
141	A support package that tries to make editing with readline easier. At the	167	A support package that tries to make editing with readline easier. At
142	moment, it reacts to clicking with the left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
143	move the text cursor to this position. It does so by generating as many	169	move the text cursor to this position. It does so by generating as many
144	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
145	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
146		172
147	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
148		174
149	=over 4	175	=over 4
…		…
197	the message into vi commands to load the file.	223	the message into vi commands to load the file.
198		224
199	=item tabbed	225	=item tabbed
200		226
201	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one	229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204	button per tab.	230	button per tab.
205		231
206	Clicking a button will activate that tab. Pressing B<Shift-Left> and	232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
207	B<Shift-Right> will switch to the tab left or right of the current one,	233	B<Shift-Right> will switch to the tab left or right of the current one,
208	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
209		235
210	=item mark-urls	236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
211		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
212	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
213	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
214	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
215	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
		266	"perl:matcher:list" as seen in the example below.
		267
		268	Example configuration:
		269
		270	URxvt.perl-ext: default,matcher
		271	URxvt.urlLauncher: sensible-browser
		272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
		274	URxvt.matcher.button: 1
		275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		277	URxvt.matcher.launcher.2: gvim +$2 $1
216		278
217	=item xim-onthespot	279	=item xim-onthespot
218		280
219	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
220	not work perfectly, and some input methods don't seem to work well with	282	not work perfectly, and some input methods don't seem to work well with
221	OnTheSpot editing in general, but it seems to work at leats for SCIM and	283	OnTheSpot editing in general, but it seems to work at least for SCIM and
222	kinput2.	284	kinput2.
223		285
224	You enable it by specifying this extension and a preedit style of	286	You enable it by specifying this extension and a preedit style of
225	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
226		288
227	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
228		290
229	=item automove-background	291	=item kuake<hotkey>
230		292
231	This is basically a one-line extension that dynamically changes the background pixmap offset	293	A very primitive quake-console-like extension. It was inspired by a
232	to the window position, in effect creating the same effect as pseudo transparency with	294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
233	a custom pixmap. No scaling is supported in this mode. Exmaple:	295	user presses a global accelerator key (by default C<F10>), the terminal
		296	will show or hide itself. Another press of the accelerator key will hide
		297	or show it again.
234		298
235	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	299	Initially, the window will not be shown when using this extension.
		300
		301	This is useful if you need a single terminal that is not using any desktop
		302	space most of the time but is quickly available at the press of a key.
		303
		304	The accelerator key is grabbed regardless of any modifiers, so this
		305	extension will actually grab a physical key just for this function.
		306
		307	If you want a quake-like animation, tell your window manager to do so
		308	(fvwm can do it).
		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
236		315
237	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
238		317
239	A not very useful example of filtering all text output to the terminal,	318	A not very useful example of filtering all text output to the terminal
240	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
241	similar-looking ascii character.	320	similar-looking ascii character.
242		321
243	=item digital-clock	322	=item digital-clock
244		323
245	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
246		325
247	=item remote-clipboard	326	=item remote-clipboard
248		327
249	Somewhat of a misnomer, this extension adds two menu entries to the	328	Somewhat of a misnomer, this extension adds two menu entries to the
250	selection popup that allows one ti run external commands to store the	329	selection popup that allows one to run external commands to store the
251	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
252		331
253	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
254	means that one command uploads the file to a remote server, and another	333	means that one command uploads the file to a remote server, and another
255	reads it.	334	reads it.
…		…
264	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
265	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
266		345
267	=item selection-pastebin	346	=item selection-pastebin
268		347
269	This is a little rarely useful extension that Uploads the selection as	348	This is a little rarely useful extension that uploads the selection as
270	textfile to a remote site (or does other things). (The implementation is	349	textfile to a remote site (or does other things). (The implementation is
271	not currently secure for use in a multiuser environment as it writes to	350	not currently secure for use in a multiuser environment as it writes to
272	F</tmp> directly.).	351	F</tmp> directly.).
273		352
274	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
291	in the C<selection-pastebin-url> resource (again, the % is the placeholder	370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
292	for the filename):	371	for the filename):
293		372
294	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
295		374
		375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		376	the double C</> characters as comment start. Use C<\057\057> instead,
		377	which works regardless of whether xrdb is used to parse the resource file
		378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
		393
296	=item example-refresh-hooks	394	=item example-refresh-hooks
297		395
298	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
299	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
300	overlays or changes.	398	overlays or changes.
		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
301		412
302	=back	413	=back
303		414
304	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
305		416
…		…
321		432
322	=over 4	433	=over 4
323		434
324	=item $text	435	=item $text
325		436
326	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
327	always represents one screen cell. See L<ROW_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
328		439
329	=item $string	440	=item $string
330		441
331	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
335	=item $octets	446	=item $octets
336		447
337	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
338	locale-specific way.	449	locale-specific way.
339		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
340	=back	457	=back
341		458
342	=head2 Extension Objects	459	=head2 Extension Objects
343		460
344	Very perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
345	for each terminal and each extension and passed as the first parameter to	462	for each terminal, and each terminal has its own set of extension objects,
346	hooks. So extensions can use their C<$self> object without having to think	463	which are passed as the first parameter to hooks. So extensions can use
347	about other extensions, with the exception of methods and members that	464	their C<$self> object without having to think about clashes with other
		465	extensions or other terminals, with the exception of methods and members
348	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
349	use.	467	internal use.
350		468
351	Although it isn't a C<urxvt::term> object, you can call all methods of the	469	Although it isn't a C<urxvt::term> object, you can call all methods of the
352	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
353		471
354	It has the following methods and data members:	472	It has the following methods and data members:
…		…
375	=head2 Hooks	493	=head2 Hooks
376		494
377	The following subroutines can be declared in extension files, and will be	495	The following subroutines can be declared in extension files, and will be
378	called whenever the relevant event happens.	496	called whenever the relevant event happens.
379		497
380	The first argument passed to them is an extension oject as described in	498	The first argument passed to them is an extension object as described in
381	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
382		500
383	B<All> of these hooks must return a boolean value. If any of the called	501	B<All> of these hooks must return a boolean value. If any of the called
384	hooks returns true, then the event counts as being I<consumed>, and the	502	hooks returns true, then the event counts as being I<consumed>, and the
385	relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
…		…
398	place.	516	place.
399		517
400	=item on_start $term	518	=item on_start $term
401		519
402	Called at the very end of initialisation of a new terminal, just before	520	Called at the very end of initialisation of a new terminal, just before
403	trying to map (display) the toplevel and returning to the mainloop.	521	trying to map (display) the toplevel and returning to the main loop.
404		522
405	=item on_destroy $term	523	=item on_destroy $term
406		524
407	Called whenever something tries to destroy terminal, when the terminal is	525	Called whenever something tries to destroy terminal, when the terminal is
408	still fully functional (not for long, though).	526	still fully functional (not for long, though).
…		…
435		553
436	Called whenever a selection has been copied, but before the selection is	554	Called whenever a selection has been copied, but before the selection is
437	requested from the server. The selection text can be queried and changed	555	requested from the server. The selection text can be queried and changed
438	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
439		557
440	Returning a true value aborts selection grabbing. It will still be hilighted.	558	Returning a true value aborts selection grabbing. It will still be highlighted.
441		559
442	=item on_sel_extend $term	560	=item on_sel_extend $term
443		561
444	Called whenever the user tries to extend the selection (e.g. with a double	562	Called whenever the user tries to extend the selection (e.g. with a double
445	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
446	should extend the selection itelf and return true to suppress the built-in	564	should extend the selection itself and return true to suppress the built-in
447	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
448	returns true, it will be called on every further click by the user and is	566	returns true, it will be called on every further click by the user and is
449	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
450		568
451	See the F<selection> example extension.	569	See the F<selection> example extension.
452		570
453	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
454		572
455	Called whenever the view offset changes, i..e the user or program	573	Called whenever the view offset changes, i.e. the user or program
456	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
457	show this many lines of scrollback.	575	show this many lines of scrollback.
458		576
459	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
460		578
…		…
464		582
465	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	583	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
466	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	584	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
467	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
468		586
469	=item on_osc_seq $term, $string	587	=item on_osc_seq $term, $op, $args, $resp
		588
		589	Called on every OSC sequence and can be used to suppress it or modify its
		590	behaviour. The default should be to return an empty list. A true value
		591	suppresses execution of the request completely. Make sure you don't get
		592	confused by recursive invocations when you output an OSC sequence within
		593	this callback.
		594
		595	C<on_osc_seq_perl> should be used for new behaviour.
		596
		597	=item on_osc_seq_perl $term, $args, $resp
470		598
471	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
472	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
473	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
474	string should start with the extension name and a colon, to distinguish	602	string should start with the extension name (sans -osc) and a semicolon,
475	it from commands for other extensions, and this might be enforced in the	603	to distinguish it from commands for other extensions, and this might be
476	future.	604	enforced in the future.
		605
		606	For example, C<overlay-osc> uses this:
		607
		608	sub on_osc_seq_perl {
		609	my ($self, $osc, $resp) = @_;
		610
		611	return unless $osc =~ s/^overlay;//;
		612
		613	... process remaining $osc string
		614	}
477		615
478	Be careful not ever to trust (in a security sense) the data you receive,	616	Be careful not ever to trust (in a security sense) the data you receive,
479	as its source can not easily be controleld (e-mail content, messages from	617	as its source can not easily be controlled (e-mail content, messages from
480	other users on the same system etc.).	618	other users on the same system etc.).
		619
		620	For responses, C<$resp> contains the end-of-args separator used by the
		621	sender.
481		622
482	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
483		624
484	Called whenever text is about to be output, with the text as argument. You	625	Called whenever text is about to be output, with the text as argument. You
485	can filter/change and output the text yourself by returning a true value	626	can filter/change and output the text yourself by returning a true value
…		…
490	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
491		632
492	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
493	suppress or filter tty input.	634	suppress or filter tty input.
494		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
495	=item on_line_update $term, $row	643	=item on_line_update $term, $row
496		644
497	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
498	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
499	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
506	later with the already-modified line (e.g. if unrelated parts change), so	654	later with the already-modified line (e.g. if unrelated parts change), so
507	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
508		656
509	=item on_refresh_begin $term	657	=item on_refresh_begin $term
510		658
511	Called just before the screen gets redrawn. Can be used for overlay	659	Called just before the screen gets redrawn. Can be used for overlay or
512	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
513	restoring them in refresh_end. The built-in overlay and selection display	661	restoring them in refresh_end. The built-in overlay and selection display
514	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
515		663
516	=item on_refresh_end $term	664	=item on_refresh_end $term
517		665
518	Called just after the screen gets redrawn. See C<on_refresh_begin>.	666	Called just after the screen gets redrawn. See C<on_refresh_begin>.
519		667
520	=item on_user_command $term, $string	668	=item on_user_command $term, $string
521		669
522	Called whenever the a user-configured event is being activated (e.g. via	670	Called whenever a user-configured event is being activated (e.g. via
523	a C<perl:string> action bound to a key, see description of the B<keysym>	671	a C<perl:string> action bound to a key, see description of the B<keysym>
524	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
525		673
526	The event is simply the action string. This interface is assumed to change	674	The event is simply the action string. This interface is assumed to change
527	slightly in the future.	675	slightly in the future.
		676
		677	=item on_register_command $term, $keysym, $modifiermask, $string
		678
		679	Called after parsing a keysym resource but before registering the
		680	associated binding. If this hook returns TRUE the binding is not
		681	registered. It can be used to modify a binding by calling
		682	C<register_command>.
		683
		684	=item on_resize_all_windows $term, $new_width, $new_height
		685
		686	Called just after the new window size has been calculated, but before
		687	windows are actually being resized or hints are being set. If this hook
		688	returns TRUE, setting of the window hints is being skipped.
528		689
529	=item on_x_event $term, $event	690	=item on_x_event $term, $event
530		691
531	Called on every X event received on the vt window (and possibly other	692	Called on every X event received on the vt window (and possibly other
532	windows). Should only be used as a last resort. Most event structure	693	windows). Should only be used as a last resort. Most event structure
533	members are not passed.	694	members are not passed.
534		695
		696	=item on_root_event $term, $event
		697
		698	Like C<on_x_event>, but is called for events on the root window.
		699
535	=item on_focus_in $term	700	=item on_focus_in $term
536		701
537	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
538	does focus in processing.	703	does focus in processing.
539		704
540	=item on_focus_out $term	705	=item on_focus_out $term
541		706
542	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
543	focus out processing.	708	focus out processing.
544		709
545	=item on_configure_notify $term, $event	710	=item on_configure_notify $term, $event
546		711
547	=item on_property_notify $term, $event	712	=item on_property_notify $term, $event
…		…
558		723
559	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
560		725
561	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
562		727
563	Called whenever the corresponding X event is received for the terminal If	728	Called whenever the corresponding X event is received for the terminal. If
564	the hook returns true, then the even will be ignored by rxvt-unicode.	729	the hook returns true, then the event will be ignored by rxvt-unicode.
565		730
566	The event is a hash with most values as named by Xlib (see the XEvent	731	The event is a hash with most values as named by Xlib (see the XEvent
567	manpage), with the additional members C<row> and C<col>, which are the	732	manpage), with the additional members C<row> and C<col>, which are the
568	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
569		734
…		…
578		743
579	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
580		745
581	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
582	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
583		752
584	=back	753	=back
585		754
586	=cut	755	=cut
587		756
…		…
593	use Scalar::Util ();	762	use Scalar::Util ();
594	use List::Util ();	763	use List::Util ();
595		764
596	our $VERSION = 1;	765	our $VERSION = 1;
597	our $TERM;	766	our $TERM;
598	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
599	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
600	our @HOOKNAME;	769	our @HOOKNAME;
601	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
602	our %OPTION;	771	our %OPTION;
603		772
604	our $LIBDIR;	773	our $LIBDIR;
…		…
630	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
631	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
632		801
633	=item @urxvt::TERM_INIT	802	=item @urxvt::TERM_INIT
634		803
635	All coderefs in this array will be called as methods of the next newly	804	All code references in this array will be called as methods of the next newly
636	created C<urxvt::term> object (during the C<on_init> phase). The array	805	created C<urxvt::term> object (during the C<on_init> phase). The array
637	gets cleared before the codereferences that were in it are being executed,	806	gets cleared before the code references that were in it are being executed,
638	so coderefs can push themselves onto it again if they so desire.	807	so references can push themselves onto it again if they so desire.
639		808
640	This complements to the perl-eval commandline option, but gets executed	809	This complements to the perl-eval command line option, but gets executed
641	first.	810	first.
642		811
643	=item @urxvt::TERM_EXT	812	=item @urxvt::TERM_EXT
644		813
645	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	814	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
652		821
653	=over 4	822	=over 4
654		823
655	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
656		825
657	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
658	costs! The only time this is acceptable is when the terminal process	827	include a trailing newline). Avoid at all costs! The only time this
659	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
660		830
661	=item urxvt::warn $string	831	=item urxvt::warn $string
662		832
663	Calls C<rxvt_warn> with the given string which should not include a	833	Calls C<rxvt_warn> with the given string which should include a trailing
664	newline. The module also overwrites the C<warn> builtin with a function	834	newline. The module also overwrites the C<warn> builtin with a function
665	that calls this function.	835	that calls this function.
666		836
667	Using this function has the advantage that its output ends up in the	837	Using this function has the advantage that its output ends up in the
668	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
670	Messages have a size limit of 1023 bytes currently.	840	Messages have a size limit of 1023 bytes currently.
671		841
672	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
673		843
674	Returns all urxvt::term objects that exist in this process, regardless of	844	Returns all urxvt::term objects that exist in this process, regardless of
675	wether they are started, being destroyed etc., so be careful. Only term	845	whether they are started, being destroyed etc., so be careful. Only term
676	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
677	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
678		848
679	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
680		850
681	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
682		852
…		…
725		895
726	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
727		897
728	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
729		899
730	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
731		902
732	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
733	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
734	the bitset.	905	the bitset.
735		906
…		…
740	Return the foreground/background colour index, respectively.	911	Return the foreground/background colour index, respectively.
741		912
742	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
743		914
744	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	915	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		916
		917	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
745		918
746	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
747	specified one.	920	specified one.
748		921
749	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
…		…
770	};	943	};
771	}	944	}
772		945
773	no warnings 'utf8';	946	no warnings 'utf8';
774		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	my $r = $term->{meta}{resource};
		954	while (my ($pattern, $v) = each %$r) {
		955	$name =~ y/-/./ if $isarg;
		956
		957	if (
		958	$pattern =~ s/\*$//
		959	? $pattern eq substr $name, 0, length $pattern
		960	: $pattern eq $name
		961	) {
		962	$name = "$urxvt::RESCLASS.$name";
		963
		964	push @TERM_EXT, $v->[0];
		965
		966	if ($v->[1] eq "boolean") {
		967	$term->put_option_db ($name, $flag ? "true" : "false");
		968	return 1;
		969	} else {
		970	$term->put_option_db ($name, $value);
		971	return 1 + 2;
		972	}
		973	}
		974	}
		975
		976	0
		977	}
		978
		979	sub usage {
		980	my ($term, $usage_type) = @_;
		981
		982	$term->scan_meta;
		983
		984	my $r = $term->{meta}{resource};
		985
		986	for my $pattern (sort keys %$r) {
		987	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		988
		989	$desc .= " (-pe $ext)";
		990
		991	if ($usage_type == 1) {
		992	$pattern =~ y/./-/;
		993	$pattern =~ s/\*/.../g;
		994
		995	if ($type eq "boolean") {
		996	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		997	} else {
		998	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		999	}
		1000	} else {
		1001	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1002	}
		1003	}
		1004	}
		1005
775	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1006	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
776		1007
777	sub verbose {	1008	sub verbose {
778	my ($level, $msg) = @_;	1009	my ($level, $msg) = @_;
779	warn "$msg\n" if $level <= $verbosity;	1010	warn "$msg\n" if $level <= $verbosity;
…		…
815	sub invoke {	1046	sub invoke {
816	local $TERM = shift;	1047	local $TERM = shift;
817	my $htype = shift;	1048	my $htype = shift;
818		1049
819	if ($htype == 0) { # INIT	1050	if ($htype == 0) { # INIT
820	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1051	my @dirs = $TERM->perl_libdirs;
821		1052
822	my %ext_arg;	1053	my %ext_arg;
823		1054
824	{	1055	{
825	my @init = @TERM_INIT;	1056	my @init = @TERM_INIT;
826	@TERM_INIT = ();	1057	@TERM_INIT = ();
…		…
840	} else {	1071	} else {
841	$ext_arg{$_} ||= [];	1072	$ext_arg{$_} ||= [];
842	}	1073	}
843	}	1074	}
844		1075
845	while (my ($ext, $argv) = each %ext_arg) {	1076	for my $ext (sort keys %ext_arg) {
846	my @files = grep -f $_, map "$_/$ext", @dirs;	1077	my @files = grep -f $_, map "$_/$ext", @dirs;
847		1078
848	if (@files) {	1079	if (@files) {
849	$TERM->register_package (extension_package $files[0], $argv);	1080	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
850	} else {	1081	} else {
851	warn "perl extension '$ext' not found in perl library search path\n";	1082	warn "perl extension '$ext' not found in perl library search path\n";
852	}	1083	}
853	}	1084	}
854		1085
…		…
860		1091
861	if (my $cb = $TERM->{_hook}[$htype]) {	1092	if (my $cb = $TERM->{_hook}[$htype]) {
862	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1093	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
863	if $verbosity >= 10;	1094	if $verbosity >= 10;
864		1095
865	keys %$cb;	1096	for my $pkg (keys %$cb) {
866
867	while (my ($pkg, $cb) = each %$cb) {
868	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1097	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
869	$retval ||= $retval_;	1098	$retval ||= $retval_;
870		1099
871	if ($@) {	1100	if ($@) {
872	$TERM->ungrab; # better to lose the grab than the session	1101	$TERM->ungrab; # better to lose the grab than the session
873	warn $@;	1102	warn $@;
…		…
885	# clear package	1114	# clear package
886	%$TERM = ();	1115	%$TERM = ();
887	}	1116	}
888		1117
889	$retval	1118	$retval
		1119	}
		1120
		1121	sub SET_COLOR($$$) {
		1122	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1123	}
		1124
		1125	sub rend2mask {
		1126	no strict 'refs';
		1127	my ($str, $mask) = (@_, 0);
		1128	my %color = ( fg => undef, bg => undef );
		1129	my @failed;
		1130	for my $spec ( split /\s+/, $str ) {
		1131	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1132	$color{lc($1)} = $2;
		1133	} else {
		1134	my $neg = $spec =~ s/^[-^]//;
		1135	unless ( exists &{"RS_$spec"} ) {
		1136	push @failed, $spec;
		1137	next;
		1138	}
		1139	my $cur = &{"RS_$spec"};
		1140	if ( $neg ) {
		1141	$mask &= ~$cur;
		1142	} else {
		1143	$mask |= $cur;
		1144	}
		1145	}
		1146	}
		1147	($mask, @color{qw(fg bg)}, \@failed)
890	}	1148	}
891		1149
892	# urxvt::term::extension	1150	# urxvt::term::extension
893		1151
894	package urxvt::term::extension;	1152	package urxvt::term::extension;
…		…
959	=head2 The C<urxvt::anyevent> Class	1217	=head2 The C<urxvt::anyevent> Class
960		1218
961	The sole purpose of this class is to deliver an interface to the	1219	The sole purpose of this class is to deliver an interface to the
962	C<AnyEvent> module - any module using it will work inside urxvt without	1220	C<AnyEvent> module - any module using it will work inside urxvt without
963	further programming. The only exception is that you cannot wait on	1221	further programming. The only exception is that you cannot wait on
964	condition variables, but non-blocking condvar use is ok. What this means	1222	condition variables, but non-blocking condvar use is ok.
965	is that you cannot use blocking APIs, but the non-blocking variant should	1223
966	work.	1224	In practical terms this means is that you cannot use blocking APIs, but
		1225	the non-blocking variant should work.
967		1226
968	=cut	1227	=cut
969		1228
970	our $VERSION = 1;	1229	our $VERSION = '5.23';
971		1230
972	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1231	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
973	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1232	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
974		1233
975	sub timer {	1234	sub timer {
…		…
977		1236
978	my $cb = $arg{cb};	1237	my $cb = $arg{cb};
979		1238
980	urxvt::timer	1239	urxvt::timer
981	->new	1240	->new
982	->start (urxvt::NOW + $arg{after})	1241	->after ($arg{after}, $arg{interval})
983	->cb (sub {	1242	->cb ($arg{interval} ? $cb : sub {
984	$_[0]->stop; # need to cancel manually	1243	$_[0]->stop; # need to cancel manually
985	$cb->();	1244	$cb->();
986	})	1245	})
987	}	1246	}
988		1247
989	sub io {	1248	sub io {
990	my ($class, %arg) = @_;	1249	my ($class, %arg) = @_;
991		1250
992	my $cb = $arg{cb};	1251	my $cb = $arg{cb};
		1252	my $fd = fileno $arg{fh};
		1253	defined $fd or $fd = $arg{fh};
993		1254
994	bless [$arg{fh}, urxvt::iow	1255	bless [$arg{fh}, urxvt::iow
995	->new	1256	->new
996	->fd (fileno $arg{fh})	1257	->fd ($fd)
997	->events (($arg{poll} =~ /r/ ? 1 : 0)	1258	->events (($arg{poll} =~ /r/ ? 1 : 0)
998	| ($arg{poll} =~ /w/ ? 2 : 0))	1259	| ($arg{poll} =~ /w/ ? 2 : 0))
999	->start	1260	->start
1000	->cb (sub {	1261	->cb ($cb)
1001	$cb->(($_[1] & 1 ? 'r' : '')
1002	. ($_[1] & 2 ? 'w' : ''));
1003	})],
1004	urxvt::anyevent::	1262	], urxvt::anyevent::
		1263	}
		1264
		1265	sub idle {
		1266	my ($class, %arg) = @_;
		1267
		1268	my $cb = $arg{cb};
		1269
		1270	urxvt::iw
		1271	->new
		1272	->start
		1273	->cb ($cb)
		1274	}
		1275
		1276	sub child {
		1277	my ($class, %arg) = @_;
		1278
		1279	my $cb = $arg{cb};
		1280
		1281	urxvt::pw
		1282	->new
		1283	->start ($arg{pid})
		1284	->cb (sub {
		1285	$_[0]->stop; # need to cancel manually
		1286	$cb->($_[0]->rpid, $_[0]->rstatus);
		1287	})
1005	}	1288	}
1006		1289
1007	sub DESTROY {	1290	sub DESTROY {
1008	$_[0][1]->stop;	1291	$_[0][1]->stop;
1009	}	1292	}
1010		1293
1011	sub condvar {	1294	# only needed for AnyEvent < 6 compatibility
1012	bless \my $flag, urxvt::anyevent::condvar::	1295	sub one_event {
1013	}
1014
1015	sub urxvt::anyevent::condvar::broadcast {
1016	${$_[0]}++;
1017	}
1018
1019	sub urxvt::anyevent::condvar::wait {
1020	unless (${$_[0]}) {
1021	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1296	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1022	}
1023	}	1297	}
1024		1298
1025	package urxvt::term;	1299	package urxvt::term;
1026		1300
1027	=head2 The C<urxvt::term> Class	1301	=head2 The C<urxvt::term> Class
…		…
1054	$proxy->enable ($name => $ref);	1328	$proxy->enable ($name => $ref);
1055	}	1329	}
1056	}	1330	}
1057	}	1331	}
1058		1332
		1333	sub perl_libdirs {
		1334	map { split /:/ }
		1335	$_[0]->resource ("perl_lib"),
		1336	$ENV{URXVT_PERL_LIB},
		1337	"$ENV{HOME}/.urxvt/ext",
		1338	"$LIBDIR/perl"
		1339	}
		1340
		1341	sub scan_meta {
		1342	my ($self) = @_;
		1343	my @libdirs = perl_libdirs $self;
		1344
		1345	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1346
		1347	my %meta;
		1348
		1349	$self->{meta_libdirs} = join "\x00", @libdirs;
		1350	$self->{meta} = \%meta;
		1351
		1352	for my $dir (reverse @libdirs) {
		1353	opendir my $fh, $dir
		1354	or next;
		1355	for my $ext (readdir $fh) {
		1356	$ext ne "."
		1357	and $ext ne ".."
		1358	and open my $fh, "<", "$dir/$ext"
		1359	or next;
		1360
		1361	while (<$fh>) {
		1362	if (/^#:META:X_RESOURCE:(.*)/) {
		1363	my ($pattern, $type, $desc) = split /:/, $1;
		1364	$pattern =~ s/^%\./$ext./g; # $$ in pattern == extension name
		1365	if ($pattern =~ /[^a-zA-Z\*\.]/) {
		1366	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1367	} else {
		1368	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1369	}
		1370	} elsif (/^\s*(?:#|$)/) {
		1371	# skip other comments and empty lines
		1372	} else {
		1373	last; # stop parsing on first non-empty non-comment line
		1374	}
		1375	}
		1376	}
		1377	}
		1378	}
		1379
1059	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1380	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1060		1381
1061	Creates a new terminal, very similar as if you had started it with system	1382	Creates a new terminal, very similar as if you had started it with system
1062	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1383	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1063	hash which defines the environment of the new terminal.	1384	hash which defines the environment of the new terminal.
…		…
1114		1435
1115	Returns true if the option specified by C<$optval> is enabled, and	1436	Returns true if the option specified by C<$optval> is enabled, and
1116	optionally change it. All option values are stored by name in the hash	1437	optionally change it. All option values are stored by name in the hash
1117	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1438	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1118		1439
1119	Here is a a likely non-exhaustive list of option names, please see the	1440	Here is a likely non-exhaustive list of option names, please see the
1120	source file F</src/optinc.h> to see the actual list:	1441	source file F</src/optinc.h> to see the actual list:
1121		1442
1122	borderLess console cursorBlink cursorUnderline hold iconic insecure	1443	borderLess buffered console cursorBlink cursorUnderline hold iconic
1123	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1444	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1124	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1445	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1125	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1446	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1126	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1447	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1127	transparent tripleclickwords utmpInhibit visualBell	1448	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1449	urgentOnBell utmpInhibit visualBell
1128		1450
1129	=item $value = $term->resource ($name[, $newval])	1451	=item $value = $term->resource ($name[, $newval])
1130		1452
1131	Returns the current resource value associated with a given name and	1453	Returns the current resource value associated with a given name and
1132	optionally sets a new value. Setting values is most useful in the C<init>	1454	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1141	likely change).	1463	likely change).
1142		1464
1143	Please note that resource strings will currently only be freed when the	1465	Please note that resource strings will currently only be freed when the
1144	terminal is destroyed, so changing options frequently will eat memory.	1466	terminal is destroyed, so changing options frequently will eat memory.
1145		1467
1146	Here is a a likely non-exhaustive list of resource names, not all of which	1468	Here is a likely non-exhaustive list of resource names, not all of which
1147	are supported in every build, please see the source file F</src/rsinc.h>	1469	are supported in every build, please see the source file F</src/rsinc.h>
1148	to see the actual list:	1470	to see the actual list:
1149		1471
1150	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1472	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1151	borderLess color cursorBlink cursorUnderline cutchars delete_key	1473	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1152	display_name embed ext_bwidth fade font geometry hold iconName	1474	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1153	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1475	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1476	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1154	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1477	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1155	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1478	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1156	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1479	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1157	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1480	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1158	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1481	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1159	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1482	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1160	secondaryScreen secondaryScroll selectstyle shade term_name title	1483	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1161	transient_for transparent transparent_all tripleclickwords utmpInhibit	1484	term_name title transient_for transparent tripleclickwords urgentOnBell
1162	visualBell	1485	utmpInhibit visualBell
1163		1486
1164	=cut	1487	=cut
1165		1488
1166	sub resource($$;$) {	1489	sub resource($$;$) {
1167	my ($self, $name) = (shift, shift);	1490	my ($self, $name) = (shift, shift);
1168	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1491	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1169	&urxvt::term::_resource	1492	goto &urxvt::term::_resource
1170	}	1493	}
1171		1494
1172	=item $value = $term->x_resource ($pattern)	1495	=item $value = $term->x_resource ($pattern)
1173		1496
1174	Returns the X-Resource for the given pattern, excluding the program or	1497	Returns the X-Resource for the given pattern, excluding the program or
…		…
1178		1501
1179	This method should only be called during the C<on_start> hook, as there is	1502	This method should only be called during the C<on_start> hook, as there is
1180	only one resource database per display, and later invocations might return	1503	only one resource database per display, and later invocations might return
1181	the wrong resources.	1504	the wrong resources.
1182		1505
1183	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1506	=item $value = $term->x_resource_boolean ($pattern)
1184		1507
		1508	Like C<x_resource>, above, but interprets the string value as a boolean
		1509	and returns C<1> for true values, C<0> for false values and C<undef> if
		1510	the resource or option isn't specified.
		1511
		1512	You should always use this method to parse boolean resources.
		1513
		1514	=cut
		1515
		1516	sub x_resource_boolean {
		1517	my $res = &x_resource;
		1518
		1519	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1520	}
		1521
		1522	=item $success = $term->parse_keysym ($key, $octets)
		1523
1185	Adds a keymap translation exactly as specified via a resource. See the	1524	Adds a key binding exactly as specified via a resource. See the
1186	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1525	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1526
		1527	=item $term->register_command ($keysym, $modifiermask, $string)
		1528
		1529	Adds a key binding. This is a lower level api compared to
		1530	C<parse_keysym>, as it expects a parsed key description, and can be
		1531	used only inside either the C<on_init> hook, to add a binding, or the
		1532	C<on_register_command> hook, to modify a parsed binding.
1187		1533
1188	=item $rend = $term->rstyle ([$new_rstyle])	1534	=item $rend = $term->rstyle ([$new_rstyle])
1189		1535
1190	Return and optionally change the current rendition. Text that is output by	1536	Return and optionally change the current rendition. Text that is output by
1191	the terminal application will use this style.	1537	the terminal application will use this style.
…		…
1199		1545
1200	=item ($row, $col) = $term->selection_beg ([$row, $col])	1546	=item ($row, $col) = $term->selection_beg ([$row, $col])
1201		1547
1202	=item ($row, $col) = $term->selection_end ([$row, $col])	1548	=item ($row, $col) = $term->selection_end ([$row, $col])
1203		1549
1204	Return the current values of the selection mark, begin or end positions,	1550	Return the current values of the selection mark, begin or end positions.
1205	and optionally set them to new values.	1551
		1552	When arguments are given, then the selection coordinates are set to
		1553	C<$row> and C<$col>, and the selection screen is set to the current
		1554	screen.
		1555
		1556	=item $screen = $term->selection_screen ([$screen])
		1557
		1558	Returns the current selection screen, and then optionally sets it.
1206		1559
1207	=item $term->selection_make ($eventtime[, $rectangular])	1560	=item $term->selection_make ($eventtime[, $rectangular])
1208		1561
1209	Tries to make a selection as set by C<selection_beg> and	1562	Tries to make a selection as set by C<selection_beg> and
1210	C<selection_end>. If C<$rectangular> is true (default: false), a	1563	C<selection_end>. If C<$rectangular> is true (default: false), a
1211	rectangular selection will be made. This is the prefered function to make	1564	rectangular selection will be made. This is the preferred function to make
1212	a selection.	1565	a selection.
1213		1566
1214	=item $success = $term->selection_grab ($eventtime)	1567	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1215		1568
1216	Try to request the primary selection text from the server (for example, as	1569	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1570	true) selection from the server. The corresponding text can be set
1217	set by the next method). No visual feedback will be given. This function	1571	with the next method. No visual feedback will be given. This function
1218	is mostly useful from within C<on_sel_grab> hooks.	1572	is mostly useful from within C<on_sel_grab> hooks.
1219		1573
1220	=item $oldtext = $term->selection ([$newtext])	1574	=item $oldtext = $term->selection ([$newtext, $clipboard])
1221		1575
1222	Return the current selection text and optionally replace it by C<$newtext>.	1576	Return the current selection (clipboard if C<$clipboard> is true) text
		1577	and optionally replace it by C<$newtext>.
		1578
		1579	=item $term->selection_clear ([$clipboard])
		1580
		1581	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1223		1582
1224	=item $term->overlay_simple ($x, $y, $text)	1583	=item $term->overlay_simple ($x, $y, $text)
1225		1584
1226	Create a simple multi-line overlay box. See the next method for details.	1585	Create a simple multi-line overlay box. See the next method for details.
1227		1586
…		…
1257		1616
1258	The methods currently supported on C<urxvt::overlay> objects are:	1617	The methods currently supported on C<urxvt::overlay> objects are:
1259		1618
1260	=over 4	1619	=over 4
1261		1620
1262	=item $overlay->set ($x, $y, $text, $rend)	1621	=item $overlay->set ($x, $y, $text[, $rend])
1263		1622
1264	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1623	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1265	text in rxvt-unicode's special encoding and an array of rendition values	1624	text in rxvt-unicode's special encoding and an array of rendition values
1266	at a specific position inside the overlay.	1625	at a specific position inside the overlay.
		1626
		1627	If C<$rend> is missing, then the rendition will not be changed.
1267		1628
1268	=item $overlay->hide	1629	=item $overlay->hide
1269		1630
1270	If visible, hide the overlay, but do not destroy it.	1631	If visible, hide the overlay, but do not destroy it.
1271		1632
…		…
1353	locale-specific encoding of the terminal and can contain command sequences	1714	locale-specific encoding of the terminal and can contain command sequences
1354	(escape codes) that will be interpreted.	1715	(escape codes) that will be interpreted.
1355		1716
1356	=item $term->tt_write ($octets)	1717	=item $term->tt_write ($octets)
1357		1718
1358	Write the octets given in C<$data> to the tty (i.e. as program input). To	1719	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1359	pass characters instead of octets, you should convert your strings first	1720	pass characters instead of octets, you should convert your strings first
1360	to the locale-specific encoding using C<< $term->locale_encode >>.	1721	to the locale-specific encoding using C<< $term->locale_encode >>.
		1722
		1723	=item $term->tt_paste ($octets)
		1724
		1725	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1726	CR and bracketing the data with control sequences if bracketed paste mode
		1727	is set.
1361		1728
1362	=item $old_events = $term->pty_ev_events ([$new_events])	1729	=item $old_events = $term->pty_ev_events ([$new_events])
1363		1730
1364	Replaces the event mask of the pty watcher by the given event mask. Can	1731	Replaces the event mask of the pty watcher by the given event mask. Can
1365	be used to suppress input and output handling to the pty/tty. See the	1732	be used to suppress input and output handling to the pty/tty. See the
…		…
1384	Adds the specified events to the vt event mask. Useful e.g. when you want	1751	Adds the specified events to the vt event mask. Useful e.g. when you want
1385	to receive pointer events all the times:	1752	to receive pointer events all the times:
1386		1753
1387	$term->vt_emask_add (urxvt::PointerMotionMask);	1754	$term->vt_emask_add (urxvt::PointerMotionMask);
1388		1755
		1756	=item $term->set_urgency ($set)
		1757
		1758	Enable/disable the urgency hint on the toplevel window.
		1759
		1760	=item $term->focus_in
		1761
		1762	=item $term->focus_out
		1763
		1764	=item $term->key_press ($state, $keycode[, $time])
		1765
		1766	=item $term->key_release ($state, $keycode[, $time])
		1767
		1768	Deliver various fake events to to terminal.
		1769
1389	=item $window_width = $term->width	1770	=item $window_width = $term->width
1390		1771
1391	=item $window_height = $term->height	1772	=item $window_height = $term->height
1392		1773
1393	=item $font_width = $term->fwidth	1774	=item $font_width = $term->fwidth
…		…
1423	=item $env = $term->env	1804	=item $env = $term->env
1424		1805
1425	Returns a copy of the environment in effect for the terminal as a hashref	1806	Returns a copy of the environment in effect for the terminal as a hashref
1426	similar to C<\%ENV>.	1807	similar to C<\%ENV>.
1427		1808
		1809	=item @envv = $term->envv
		1810
		1811	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1812
		1813	=item @argv = $term->argv
		1814
		1815	Return the argument vector as this terminal, similar to @ARGV, but
		1816	includes the program name as first element.
		1817
1428	=cut	1818	=cut
1429		1819
1430	sub env {	1820	sub env {
1431	if (my $env = $_[0]->_env) {
1432	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1821	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1433	} else {
1434	+{ %ENV }
1435	}
1436	}	1822	}
1437		1823
1438	=item $modifiermask = $term->ModLevel3Mask	1824	=item $modifiermask = $term->ModLevel3Mask
1439		1825
1440	=item $modifiermask = $term->ModMetaMask	1826	=item $modifiermask = $term->ModMetaMask
…		…
1448		1834
1449	Returns the currently displayed screen (0 primary, 1 secondary).	1835	Returns the currently displayed screen (0 primary, 1 secondary).
1450		1836
1451	=item $cursor_is_hidden = $term->hidden_cursor	1837	=item $cursor_is_hidden = $term->hidden_cursor
1452		1838
1453	Returns wether the cursor is currently hidden or not.	1839	Returns whether the cursor is currently hidden or not.
1454		1840
1455	=item $view_start = $term->view_start ([$newvalue])	1841	=item $view_start = $term->view_start ([$newvalue])
1456		1842
1457	Returns the row number of the topmost displayed line. Maximum value is	1843	Returns the row number of the topmost displayed line. Maximum value is
1458	C<0>, which displays the normal terminal contents. Lower values scroll	1844	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1466		1852
1467	Used after changing terminal contents to display them.	1853	Used after changing terminal contents to display them.
1468		1854
1469	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1855	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1470		1856
1471	Returns the text of the entire row with number C<$row_number>. Row C<0>	1857	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1472	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1858	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1473	terminal line. The scrollback buffer starts at line C<-1> and extends to
1474	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1859	terminal line. Nothing will be returned if a nonexistent line
1475	is requested.	1860	is requested.
1476		1861
1477	If C<$new_text> is specified, it will replace characters in the current	1862	If C<$new_text> is specified, it will replace characters in the current
1478	line, starting at column C<$start_col> (default C<0>), which is useful	1863	line, starting at column C<$start_col> (default C<0>), which is useful
1479	to replace only parts of a line. The font index in the rendition will	1864	to replace only parts of a line. The font index in the rendition will
1480	automatically be updated.	1865	automatically be updated.
1481		1866
1482	C<$text> is in a special encoding: tabs and wide characters that use more	1867	C<$text> is in a special encoding: tabs and wide characters that use more
1483	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1868	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1484	characters. Characters with combining characters and other characters that	1869	characters. Characters with combining characters and other characters that
1485	do not fit into the normal tetx encoding will be replaced with characters	1870	do not fit into the normal text encoding will be replaced with characters
1486	in the private use area.	1871	in the private use area.
1487		1872
1488	You have to obey this encoding when changing text. The advantage is	1873	You have to obey this encoding when changing text. The advantage is
1489	that C<substr> and similar functions work on screen cells and not on	1874	that C<substr> and similar functions work on screen cells and not on
1490	characters.	1875	characters.
…		…
1635	where one character corresponds to one screen cell. See	2020	where one character corresponds to one screen cell. See
1636	C<< $term->ROW_t >> for details.	2021	C<< $term->ROW_t >> for details.
1637		2022
1638	=item $string = $term->special_decode $text	2023	=item $string = $term->special_decode $text
1639		2024
1640	Converts rxvt-unicodes text reprsentation into a perl string. See	2025	Converts rxvt-unicodes text representation into a perl string. See
1641	C<< $term->ROW_t >> for details.	2026	C<< $term->ROW_t >> for details.
1642		2027
1643	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2028	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1644		2029
1645	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2030	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1648	manpage.	2033	manpage.
1649		2034
1650	=item $success = $term->grab ($eventtime[, $sync])	2035	=item $success = $term->grab ($eventtime[, $sync])
1651		2036
1652	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2037	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1653	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2038	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1654		2039
1655	=item $term->allow_events_async	2040	=item $term->allow_events_async
1656		2041
1657	Calls XAllowEvents with AsyncBoth for the most recent grab.	2042	Calls XAllowEvents with AsyncBoth for the most recent grab.
1658		2043
…		…
1665	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2050	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1666	recent grab.	2051	recent grab.
1667		2052
1668	=item $term->ungrab	2053	=item $term->ungrab
1669		2054
1670	Calls XUngrab for the most recent grab. Is called automatically on	2055	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1671	evaluation errors, as it is better to lose the grab in the error case as	2056	evaluation errors, as it is better to lose the grab in the error case as
1672	the session.	2057	the session.
1673		2058
1674	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2059	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1675		2060
…		…
1677		2062
1678	=item @atoms = $term->XListProperties ($window)	2063	=item @atoms = $term->XListProperties ($window)
1679		2064
1680	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2065	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1681		2066
1682	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2067	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1683		2068
1684	=item $term->XDeleteProperty ($window, $property)	2069	=item $term->XDeleteProperty ($window, $property)
1685		2070
1686	=item $window = $term->DefaultRootWindow	2071	=item $window = $term->DefaultRootWindow
1687		2072
…		…
1694	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2079	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1695		2080
1696	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2081	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1697		2082
1698	=item $term->XChangeInput ($window, $add_events[, $del_events])	2083	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2084
		2085	=item $keysym = $term->XStringToKeysym ($string)
		2086
		2087	=item $string = $term->XKeysymToString ($keysym)
1699		2088
1700	Various X or X-related functions. The C<$term> object only serves as	2089	Various X or X-related functions. The C<$term> object only serves as
1701	the source of the display, otherwise those functions map more-or-less	2090	the source of the display, otherwise those functions map more-or-less
1702	directory onto the X functions of the same name.	2091	directly onto the X functions of the same name.
1703		2092
1704	=back	2093	=back
1705		2094
1706	=cut	2095	=cut
1707		2096
…		…
1771	my ($self, $text, $cb) = @_;	2160	my ($self, $text, $cb) = @_;
1772		2161
1773	$self->add_item ({ type => "button", text => $text, activate => $cb});	2162	$self->add_item ({ type => "button", text => $text, activate => $cb});
1774	}	2163	}
1775		2164
1776	=item $popup->add_toggle ($text, $cb, $initial_value)	2165	=item $popup->add_toggle ($text, $initial_value, $cb)
1777		2166
1778	Adds a toggle/checkbox item to the popup. Teh callback gets called	2167	Adds a toggle/checkbox item to the popup. The callback gets called
1779	whenever it gets toggled, with a boolean indicating its value as its first	2168	whenever it gets toggled, with a boolean indicating its new value as its
1780	argument.	2169	first argument.
1781		2170
1782	=cut	2171	=cut
1783		2172
1784	sub add_toggle {	2173	sub add_toggle {
1785	my ($self, $text, $cb, $value) = @_;	2174	my ($self, $text, $value, $cb) = @_;
1786		2175
1787	my $item; $item = {	2176	my $item; $item = {
1788	type => "button",	2177	type => "button",
1789	text => " $text",	2178	text => " $text",
1790	value => $value,	2179	value => $value,
…		…
1809	my $env = $self->{term}->env;	2198	my $env = $self->{term}->env;
1810	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2199	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1811	delete $env->{LC_ALL};	2200	delete $env->{LC_ALL};
1812	$env->{LC_CTYPE} = $self->{term}->locale;	2201	$env->{LC_CTYPE} = $self->{term}->locale;
1813		2202
1814	urxvt::term->new ($env, "popup",	2203	my $term = urxvt::term->new (
		2204	$env, "popup",
1815	"--perl-lib" => "", "--perl-ext-common" => "",	2205	"--perl-lib" => "", "--perl-ext-common" => "",
1816	"-pty-fd" => -1, "-sl" => 0,	2206	"-pty-fd" => -1, "-sl" => 0,
1817	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2207	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1818	"--transient-for" => $self->{term}->parent,	2208	"--transient-for" => $self->{term}->parent,
1819	"-display" => $self->{term}->display_id,	2209	"-display" => $self->{term}->display_id,
1820	"-pe" => "urxvt-popup")	2210	"-pe" => "urxvt-popup",
1821	or die "unable to create popup window\n";	2211	) or die "unable to create popup window\n";
		2212
		2213	unless (delete $term->{urxvt_popup_init_done}) {
		2214	$term->ungrab;
		2215	$term->destroy;
		2216	die "unable to initialise popup window\n";
		2217	}
1822	}	2218	}
1823		2219
1824	sub DESTROY {	2220	sub DESTROY {
1825	my ($self) = @_;	2221	my ($self) = @_;
1826		2222
…		…
1831	=back	2227	=back
1832		2228
1833	=cut	2229	=cut
1834		2230
1835	package urxvt::watcher;	2231	package urxvt::watcher;
1836
1837	@urxvt::timer::ISA = __PACKAGE__;
1838	@urxvt::iow::ISA = __PACKAGE__;
1839	@urxvt::pw::ISA = __PACKAGE__;
1840	@urxvt::iw::ISA = __PACKAGE__;
1841		2232
1842	=head2 The C<urxvt::timer> Class	2233	=head2 The C<urxvt::timer> Class
1843		2234
1844	This class implements timer watchers/events. Time is represented as a	2235	This class implements timer watchers/events. Time is represented as a
1845	fractional number of seconds since the epoch. Example:	2236	fractional number of seconds since the epoch. Example:
…		…
1849	->new	2240	->new
1850	->interval (1)	2241	->interval (1)
1851	->cb (sub {	2242	->cb (sub {
1852	$term->{overlay}->set (0, 0,	2243	$term->{overlay}->set (0, 0,
1853	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2244	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1854	});	2245	});
1855		2246
1856	=over 4	2247	=over 4
1857		2248
1858	=item $timer = new urxvt::timer	2249	=item $timer = new urxvt::timer
1859		2250
…		…
1862		2253
1863	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2254	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1864		2255
1865	Set the callback to be called when the timer triggers.	2256	Set the callback to be called when the timer triggers.
1866		2257
1867	=item $tstamp = $timer->at
1868
1869	Return the time this watcher will fire next.
1870
1871	=item $timer = $timer->set ($tstamp)	2258	=item $timer = $timer->set ($tstamp[, $interval])
1872		2259
1873	Set the time the event is generated to $tstamp.	2260	Set the time the event is generated to $tstamp (and optionally specifies a
		2261	new $interval).
1874		2262
1875	=item $timer = $timer->interval ($interval)	2263	=item $timer = $timer->interval ($interval)
1876		2264
1877	Normally (and when C<$interval> is C<0>), the timer will automatically	2265	By default (and when C<$interval> is C<0>), the timer will automatically
1878	stop after it has fired once. If C<$interval> is non-zero, then the timer	2266	stop after it has fired once. If C<$interval> is non-zero, then the timer
1879	is automatically rescheduled at the given intervals.	2267	is automatically rescheduled at the given intervals.
1880		2268
1881	=item $timer = $timer->start	2269	=item $timer = $timer->start
1882		2270
1883	Start the timer.	2271	Start the timer.
1884		2272
1885	=item $timer = $timer->start ($tstamp)	2273	=item $timer = $timer->start ($tstamp[, $interval])
1886		2274
1887	Set the event trigger time to C<$tstamp> and start the timer.	2275	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2276	also replaces the interval.
1888		2277
1889	=item $timer = $timer->after ($delay)	2278	=item $timer = $timer->after ($delay[, $interval])
1890		2279
1891	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2280	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1892		2281
1893	=item $timer = $timer->stop	2282	=item $timer = $timer->stop
1894		2283
…		…
1902		2291
1903	$term->{socket} = ...	2292	$term->{socket} = ...
1904	$term->{iow} = urxvt::iow	2293	$term->{iow} = urxvt::iow
1905	->new	2294	->new
1906	->fd (fileno $term->{socket})	2295	->fd (fileno $term->{socket})
1907	->events (urxvt::EVENT_READ)	2296	->events (urxvt::EV_READ)
1908	->start	2297	->start
1909	->cb (sub {	2298	->cb (sub {
1910	my ($iow, $revents) = @_;	2299	my ($iow, $revents) = @_;
1911	# $revents must be 1 here, no need to check	2300	# $revents must be 1 here, no need to check
1912	sysread $term->{socket}, my $buf, 8192	2301	sysread $term->{socket}, my $buf, 8192
…		…
1925	Set the callback to be called when io events are triggered. C<$reventmask>	2314	Set the callback to be called when io events are triggered. C<$reventmask>
1926	is a bitset as described in the C<events> method.	2315	is a bitset as described in the C<events> method.
1927		2316
1928	=item $iow = $iow->fd ($fd)	2317	=item $iow = $iow->fd ($fd)
1929		2318
1930	Set the filedescriptor (not handle) to watch.	2319	Set the file descriptor (not handle) to watch.
1931		2320
1932	=item $iow = $iow->events ($eventmask)	2321	=item $iow = $iow->events ($eventmask)
1933		2322
1934	Set the event mask to watch. The only allowed values are	2323	Set the event mask to watch. The only allowed values are
1935	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2324	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1936	together, or C<urxvt::EVENT_NONE>.	2325	together, or C<urxvt::EV_NONE>.
1937		2326
1938	=item $iow = $iow->start	2327	=item $iow = $iow->start
1939		2328
1940	Start watching for requested events on the given handle.	2329	Start watching for requested events on the given handle.
1941		2330
1942	=item $iow = $iow->stop	2331	=item $iow = $iow->stop
1943		2332
1944	Stop watching for events on the given filehandle.	2333	Stop watching for events on the given file handle.
1945		2334
1946	=back	2335	=back
1947		2336
1948	=head2 The C<urxvt::iw> Class	2337	=head2 The C<urxvt::iw> Class
1949		2338
…		…
1982	->new	2371	->new
1983	->start ($pid)	2372	->start ($pid)
1984	->cb (sub {	2373	->cb (sub {
1985	my ($pw, $exit_status) = @_;	2374	my ($pw, $exit_status) = @_;
1986	...	2375	...
1987	});	2376	});
1988		2377
1989	=over 4	2378	=over 4
1990		2379
1991	=item $pw = new urxvt::pw	2380	=item $pw = new urxvt::pw
1992		2381
…		…
1996		2385
1997	Set the callback to be called when the timer triggers.	2386	Set the callback to be called when the timer triggers.
1998		2387
1999	=item $pw = $timer->start ($pid)	2388	=item $pw = $timer->start ($pid)
2000		2389
2001	Tells the wqtcher to start watching for process C<$pid>.	2390	Tells the watcher to start watching for process C<$pid>.
2002		2391
2003	=item $pw = $pw->stop	2392	=item $pw = $pw->stop
2004		2393
2005	Stop the watcher.	2394	Stop the watcher.
2006		2395
…		…
2019		2408
2020	=item >= 3 - script loading and management	2409	=item >= 3 - script loading and management
2021		2410
2022	=item >=10 - all called hooks	2411	=item >=10 - all called hooks
2023		2412
2024	=item >=11 - hook reutrn values	2413	=item >=11 - hook return values
2025		2414
2026	=back	2415	=back
2027		2416
2028	=head1 AUTHOR	2417	=head1 AUTHOR
2029		2418
2030	Marc Lehmann <pcg@goof.com>	2419	Marc Lehmann <schmorp@schmorp.de>
2031	http://software.schmorp.de/pkg/rxvt-unicode	2420	http://software.schmorp.de/pkg/rxvt-unicode
2032		2421
2033	=cut	2422	=cut
2034		2423
2035	1	2424	1
		2425
		2426	# vim: sw=3:

Diff Legend

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