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.132 by root, Mon Feb 6 05:40:15 2006 UTC vs.
Revision 1.215 by root, Thu Jun 7 16:30:58 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	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,
…		…
217	URxvt.tabbed.tab-bg: <colour-index, default 1>	243	URxvt.tabbed.tab-bg: <colour-index, default 1>
218		244
219	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid	245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
220	indices.	246	indices.
221		247
222	=item mark-urls	248	=item matcher
223		249
224	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
225	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
226	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
227	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
228		278
229	=item xim-onthespot	279	=item xim-onthespot
230		280
231	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
232	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
233	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
234	kinput2.	284	kinput2.
235		285
236	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
237	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
238		288
239	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
240		290
241	=item automove-background	291	=item kuake<hotkey>
242		292
243	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
244	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
245	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.
246		298
247	@@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.
248		315
249	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
250		317
251	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
252	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
253	similar-looking ascii character.	320	similar-looking ascii character.
254		321
255	=item digital-clock	322	=item digital-clock
256		323
257	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
258		325
259	=item remote-clipboard	326	=item remote-clipboard
260		327
261	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
262	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
263	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
264		331
265	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
266	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
267	reads it.	334	reads it.
…		…
276	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
277	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
278		345
279	=item selection-pastebin	346	=item selection-pastebin
280		347
281	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
282	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
283	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
284	F</tmp> directly.).	351	F</tmp> directly.).
285		352
286	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
303	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
304	for the filename):	371	for the filename):
305		372
306	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
307		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
308	=item example-refresh-hooks	394	=item example-refresh-hooks
309		395
310	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
311	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
312	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"
313		412
314	=back	413	=back
315		414
316	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
317		416
…		…
333		432
334	=over 4	433	=over 4
335		434
336	=item $text	435	=item $text
337		436
338	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
339	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.
340		439
341	=item $string	440	=item $string
342		441
343	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
…		…
347	=item $octets	446	=item $octets
348		447
349	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
350	locale-specific way.	449	locale-specific way.
351		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
352	=back	457	=back
353		458
354	=head2 Extension Objects	459	=head2 Extension Objects
355		460
356	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
357	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,
358	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
359	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
360	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
361	use.	467	internal use.
362		468
363	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
364	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
365		471
366	It has the following methods and data members:	472	It has the following methods and data members:
…		…
387	=head2 Hooks	493	=head2 Hooks
388		494
389	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
390	called whenever the relevant event happens.	496	called whenever the relevant event happens.
391		497
392	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
393	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
394		500
395	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
396	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
397	relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
…		…
410	place.	516	place.
411		517
412	=item on_start $term	518	=item on_start $term
413		519
414	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
415	trying to map (display) the toplevel and returning to the mainloop.	521	trying to map (display) the toplevel and returning to the main loop.
416		522
417	=item on_destroy $term	523	=item on_destroy $term
418		524
419	Called whenever something tries to destroy terminal, when the terminal is	525	Called whenever something tries to destroy terminal, when the terminal is
420	still fully functional (not for long, though).	526	still fully functional (not for long, though).
…		…
447		553
448	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
449	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
450	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
451		557
452	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.
453		559
454	=item on_sel_extend $term	560	=item on_sel_extend $term
455		561
456	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
457	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
458	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
459	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
460	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
461	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
462		568
463	See the F<selection> example extension.	569	See the F<selection> example extension.
464		570
465	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
466		572
467	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
468	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
469	show this many lines of scrollback.	575	show this many lines of scrollback.
470		576
471	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
472		578
…		…
476		582
477	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,
478	$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
479	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
480		586
481	=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
482		598
483	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
484	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
485	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
486	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,
487	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
488	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	}
489		615
490	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,
491	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
492	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.
493		622
494	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
495		624
496	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
497	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
…		…
502	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
503		632
504	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
505	suppress or filter tty input.	634	suppress or filter tty input.
506		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
507	=item on_line_update $term, $row	643	=item on_line_update $term, $row
508		644
509	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
510	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
511	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,
…		…
518	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
519	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
520		656
521	=item on_refresh_begin $term	657	=item on_refresh_begin $term
522		658
523	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
524	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
525	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
526	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
527		663
528	=item on_refresh_end $term	664	=item on_refresh_end $term
529		665
530	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>.
531		667
532	=item on_user_command $term, $string	668	=item on_user_command $term, $string
533		669
534	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
535	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>
536	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
537		673
538	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
539	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.
540		689
541	=item on_x_event $term, $event	690	=item on_x_event $term, $event
542		691
543	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
544	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
545	members are not passed.	694	members are not passed.
546		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
547	=item on_focus_in $term	700	=item on_focus_in $term
548		701
549	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
550	does focus in processing.	703	does focus in processing.
551		704
552	=item on_focus_out $term	705	=item on_focus_out $term
553		706
554	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
555	focus out processing.	708	focus out processing.
556		709
557	=item on_configure_notify $term, $event	710	=item on_configure_notify $term, $event
558		711
559	=item on_property_notify $term, $event	712	=item on_property_notify $term, $event
…		…
570		723
571	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
572		725
573	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
574		727
575	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
576	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.
577		730
578	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
579	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
580	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
581		734
…		…
591	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
592		745
593	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
594	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
595		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
		752
596	=back	753	=back
597		754
598	=cut	755	=cut
599		756
600	package urxvt;	757	package urxvt;
601		758
602	use utf8;	759	use utf8;
603	use strict;	760	use strict 'vars';
604	use Carp ();	761	use Carp ();
605	use Scalar::Util ();	762	use Scalar::Util ();
606	use List::Util ();	763	use List::Util ();
607		764
608	our $VERSION = 1;	765	our $VERSION = 1;
609	our $TERM;	766	our $TERM;
610	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
611	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
612	our @HOOKNAME;	769	our @HOOKNAME;
613	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
614	our %OPTION;	771	our %OPTION;
615		772
616	our $LIBDIR;	773	our $LIBDIR;
…		…
642	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
643	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
644		801
645	=item @urxvt::TERM_INIT	802	=item @urxvt::TERM_INIT
646		803
647	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
648	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
649	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,
650	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.
651		808
652	This complements to the perl-eval commandline option, but gets executed	809	This complements to the perl-eval command line option, but gets executed
653	first.	810	first.
654		811
655	=item @urxvt::TERM_EXT	812	=item @urxvt::TERM_EXT
656		813
657	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
…		…
664		821
665	=over 4	822	=over 4
666		823
667	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
668		825
669	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
670	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
671	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
672		830
673	=item urxvt::warn $string	831	=item urxvt::warn $string
674		832
675	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
676	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
677	that calls this function.	835	that calls this function.
678		836
679	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
680	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
682	Messages have a size limit of 1023 bytes currently.	840	Messages have a size limit of 1023 bytes currently.
683		841
684	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
685		843
686	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
687	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
688	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
689	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
690		848
691	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
692		850
693	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
694		852
…		…
737		895
738	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
739		897
740	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
741		899
742	=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
743		902
744	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
745	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
746	the bitset.	905	the bitset.
747		906
…		…
784	};	943	};
785	}	944	}
786		945
787	no warnings 'utf8';	946	no warnings 'utf8';
788		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 =~ /\.$/
		959	? $pattern eq substr $name, 0, length $pattern
		960	: $pattern eq $name
		961	) {
		962	$name = "$urxvt::RESCLASS.$name";
		963
		964	push @{ $term->{perl_ext_3} }, $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	$pattern =~ s/\.$/.*/g;
		1002	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1003	}
		1004	}
		1005	}
		1006
789	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1007	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
790		1008
791	sub verbose {	1009	sub verbose {
792	my ($level, $msg) = @_;	1010	my ($level, $msg) = @_;
793	warn "$msg\n" if $level <= $verbosity;	1011	warn "$msg\n" if $level <= $verbosity;
…		…
809		1027
810	open my $fh, "<:raw", $path	1028	open my $fh, "<:raw", $path
811	or die "$path: $!";	1029	or die "$path: $!";
812		1030
813	my $source =	1031	my $source =
814	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	1032	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
815	. "#line 1 \"$path\"\n{\n"	1033	. "#line 1 \"$path\"\n{\n"
816	. (do { local $/; <$fh> })	1034	. (do { local $/; <$fh> })
817	. "\n};\n1";	1035	. "\n};\n1";
818		1036
819	eval $source	1037	eval $source
…		…
829	sub invoke {	1047	sub invoke {
830	local $TERM = shift;	1048	local $TERM = shift;
831	my $htype = shift;	1049	my $htype = shift;
832		1050
833	if ($htype == 0) { # INIT	1051	if ($htype == 0) { # INIT
834	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1052	my @dirs = $TERM->perl_libdirs;
835		1053
836	my %ext_arg;	1054	my %ext_arg;
837		1055
838	{	1056	{
839	my @init = @TERM_INIT;	1057	my @init = @TERM_INIT;
840	@TERM_INIT = ();	1058	@TERM_INIT = ();
…		…
842	my @pkg = @TERM_EXT;	1060	my @pkg = @TERM_EXT;
843	@TERM_EXT = ();	1061	@TERM_EXT = ();
844	$TERM->register_package ($_) for @pkg;	1062	$TERM->register_package ($_) for @pkg;
845	}	1063	}
846		1064
		1065	for (
		1066	@{ delete $TERM->{perl_ext_3} },
847	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1067	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1068	) {
848	if ($_ eq "default") {	1069	if ($_ eq "default") {
849	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	1070	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
850	} elsif (/^-(.*)$/) {	1071	} elsif (/^-(.*)$/) {
851	delete $ext_arg{$1};	1072	delete $ext_arg{$1};
852	} elsif (/^([^<]+)<(.*)>$/) {	1073	} elsif (/^([^<]+)<(.*)>$/) {
…		…
854	} else {	1075	} else {
855	$ext_arg{$_} ||= [];	1076	$ext_arg{$_} ||= [];
856	}	1077	}
857	}	1078	}
858		1079
859	while (my ($ext, $argv) = each %ext_arg) {	1080	for my $ext (sort keys %ext_arg) {
860	my @files = grep -f $_, map "$_/$ext", @dirs;	1081	my @files = grep -f $_, map "$_/$ext", @dirs;
861		1082
862	if (@files) {	1083	if (@files) {
863	$TERM->register_package (extension_package $files[0], $argv);	1084	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
864	} else {	1085	} else {
865	warn "perl extension '$ext' not found in perl library search path\n";	1086	warn "perl extension '$ext' not found in perl library search path\n";
866	}	1087	}
867	}	1088	}
868		1089
…		…
874		1095
875	if (my $cb = $TERM->{_hook}[$htype]) {	1096	if (my $cb = $TERM->{_hook}[$htype]) {
876	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1097	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
877	if $verbosity >= 10;	1098	if $verbosity >= 10;
878		1099
879	keys %$cb;	1100	for my $pkg (keys %$cb) {
880
881	while (my ($pkg, $cb) = each %$cb) {
882	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1101	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
883	$retval ||= $retval_;	1102	$retval ||= $retval_;
884		1103
885	if ($@) {	1104	if ($@) {
886	$TERM->ungrab; # better to lose the grab than the session	1105	$TERM->ungrab; # better to lose the grab than the session
887	warn $@;	1106	warn $@;
…		…
903	$retval	1122	$retval
904	}	1123	}
905		1124
906	sub SET_COLOR($$$) {	1125	sub SET_COLOR($$$) {
907	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1126	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1127	}
		1128
		1129	sub rend2mask {
		1130	no strict 'refs';
		1131	my ($str, $mask) = (@_, 0);
		1132	my %color = ( fg => undef, bg => undef );
		1133	my @failed;
		1134	for my $spec ( split /\s+/, $str ) {
		1135	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1136	$color{lc($1)} = $2;
		1137	} else {
		1138	my $neg = $spec =~ s/^[-^]//;
		1139	unless ( exists &{"RS_$spec"} ) {
		1140	push @failed, $spec;
		1141	next;
		1142	}
		1143	my $cur = &{"RS_$spec"};
		1144	if ( $neg ) {
		1145	$mask &= ~$cur;
		1146	} else {
		1147	$mask |= $cur;
		1148	}
		1149	}
		1150	}
		1151	($mask, @color{qw(fg bg)}, \@failed)
908	}	1152	}
909		1153
910	# urxvt::term::extension	1154	# urxvt::term::extension
911		1155
912	package urxvt::term::extension;	1156	package urxvt::term::extension;
…		…
977	=head2 The C<urxvt::anyevent> Class	1221	=head2 The C<urxvt::anyevent> Class
978		1222
979	The sole purpose of this class is to deliver an interface to the	1223	The sole purpose of this class is to deliver an interface to the
980	C<AnyEvent> module - any module using it will work inside urxvt without	1224	C<AnyEvent> module - any module using it will work inside urxvt without
981	further programming. The only exception is that you cannot wait on	1225	further programming. The only exception is that you cannot wait on
982	condition variables, but non-blocking condvar use is ok. What this means	1226	condition variables, but non-blocking condvar use is ok.
983	is that you cannot use blocking APIs, but the non-blocking variant should	1227
984	work.	1228	In practical terms this means is that you cannot use blocking APIs, but
		1229	the non-blocking variant should work.
985		1230
986	=cut	1231	=cut
987		1232
988	our $VERSION = 1;	1233	our $VERSION = '5.23';
989		1234
990	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1235	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
991	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1236	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
992		1237
993	sub timer {	1238	sub timer {
…		…
995		1240
996	my $cb = $arg{cb};	1241	my $cb = $arg{cb};
997		1242
998	urxvt::timer	1243	urxvt::timer
999	->new	1244	->new
1000	->start (urxvt::NOW + $arg{after})	1245	->after ($arg{after}, $arg{interval})
1001	->cb (sub {	1246	->cb ($arg{interval} ? $cb : sub {
1002	$_[0]->stop; # need to cancel manually	1247	$_[0]->stop; # need to cancel manually
1003	$cb->();	1248	$cb->();
1004	})	1249	})
1005	}	1250	}
1006		1251
1007	sub io {	1252	sub io {
1008	my ($class, %arg) = @_;	1253	my ($class, %arg) = @_;
1009		1254
1010	my $cb = $arg{cb};	1255	my $cb = $arg{cb};
		1256	my $fd = fileno $arg{fh};
		1257	defined $fd or $fd = $arg{fh};
1011		1258
1012	bless [$arg{fh}, urxvt::iow	1259	bless [$arg{fh}, urxvt::iow
1013	->new	1260	->new
1014	->fd (fileno $arg{fh})	1261	->fd ($fd)
1015	->events (($arg{poll} =~ /r/ ? 1 : 0)	1262	->events (($arg{poll} =~ /r/ ? 1 : 0)
1016	| ($arg{poll} =~ /w/ ? 2 : 0))	1263	| ($arg{poll} =~ /w/ ? 2 : 0))
1017	->start	1264	->start
1018	->cb (sub {	1265	->cb ($cb)
1019	$cb->(($_[1] & 1 ? 'r' : '')
1020	. ($_[1] & 2 ? 'w' : ''));
1021	})],
1022	urxvt::anyevent::	1266	], urxvt::anyevent::
		1267	}
		1268
		1269	sub idle {
		1270	my ($class, %arg) = @_;
		1271
		1272	my $cb = $arg{cb};
		1273
		1274	urxvt::iw
		1275	->new
		1276	->start
		1277	->cb ($cb)
		1278	}
		1279
		1280	sub child {
		1281	my ($class, %arg) = @_;
		1282
		1283	my $cb = $arg{cb};
		1284
		1285	urxvt::pw
		1286	->new
		1287	->start ($arg{pid})
		1288	->cb (sub {
		1289	$_[0]->stop; # need to cancel manually
		1290	$cb->($_[0]->rpid, $_[0]->rstatus);
		1291	})
1023	}	1292	}
1024		1293
1025	sub DESTROY {	1294	sub DESTROY {
1026	$_[0][1]->stop;	1295	$_[0][1]->stop;
1027	}	1296	}
1028		1297
1029	sub condvar {	1298	# only needed for AnyEvent < 6 compatibility
1030	bless \my $flag, urxvt::anyevent::condvar::	1299	sub one_event {
1031	}
1032
1033	sub urxvt::anyevent::condvar::broadcast {
1034	${$_[0]}++;
1035	}
1036
1037	sub urxvt::anyevent::condvar::wait {
1038	unless (${$_[0]}) {
1039	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1300	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1040	}
1041	}	1301	}
1042		1302
1043	package urxvt::term;	1303	package urxvt::term;
1044		1304
1045	=head2 The C<urxvt::term> Class	1305	=head2 The C<urxvt::term> Class
…		…
1072	$proxy->enable ($name => $ref);	1332	$proxy->enable ($name => $ref);
1073	}	1333	}
1074	}	1334	}
1075	}	1335	}
1076		1336
		1337	sub perl_libdirs {
		1338	map { split /:/ }
		1339	$_[0]->resource ("perl_lib"),
		1340	$ENV{URXVT_PERL_LIB},
		1341	"$ENV{HOME}/.urxvt/ext",
		1342	"$LIBDIR/perl"
		1343	}
		1344
		1345	sub scan_meta {
		1346	my ($self) = @_;
		1347	my @libdirs = perl_libdirs $self;
		1348
		1349	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1350
		1351	my %meta;
		1352
		1353	$self->{meta_libdirs} = join "\x00", @libdirs;
		1354	$self->{meta} = \%meta;
		1355
		1356	for my $dir (reverse @libdirs) {
		1357	opendir my $fh, $dir
		1358	or next;
		1359	for my $ext (readdir $fh) {
		1360	$ext ne "."
		1361	and $ext ne ".."
		1362	and open my $fh, "<", "$dir/$ext"
		1363	or next;
		1364
		1365	while (<$fh>) {
		1366	if (/^#:META:X_RESOURCE:(.*)/) {
		1367	my ($pattern, $type, $desc) = split /:/, $1;
		1368	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1369	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1370	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1371	} else {
		1372	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1373	}
		1374	} elsif (/^\s*(?:#|$)/) {
		1375	# skip other comments and empty lines
		1376	} else {
		1377	last; # stop parsing on first non-empty non-comment line
		1378	}
		1379	}
		1380	}
		1381	}
		1382	}
		1383
1077	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1384	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1078		1385
1079	Creates a new terminal, very similar as if you had started it with system	1386	Creates a new terminal, very similar as if you had started it with system
1080	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1387	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1081	hash which defines the environment of the new terminal.	1388	hash which defines the environment of the new terminal.
…		…
1132		1439
1133	Returns true if the option specified by C<$optval> is enabled, and	1440	Returns true if the option specified by C<$optval> is enabled, and
1134	optionally change it. All option values are stored by name in the hash	1441	optionally change it. All option values are stored by name in the hash
1135	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1442	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1136		1443
1137	Here is a a likely non-exhaustive list of option names, please see the	1444	Here is a likely non-exhaustive list of option names, please see the
1138	source file F</src/optinc.h> to see the actual list:	1445	source file F</src/optinc.h> to see the actual list:
1139		1446
1140	borderLess console cursorBlink cursorUnderline hold iconic insecure	1447	borderLess buffered console cursorBlink cursorUnderline hold iconic
1141	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1448	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1142	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1449	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1143	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1450	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1144	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1451	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1145	transparent tripleclickwords utmpInhibit visualBell	1452	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1453	urgentOnBell utmpInhibit visualBell
1146		1454
1147	=item $value = $term->resource ($name[, $newval])	1455	=item $value = $term->resource ($name[, $newval])
1148		1456
1149	Returns the current resource value associated with a given name and	1457	Returns the current resource value associated with a given name and
1150	optionally sets a new value. Setting values is most useful in the C<init>	1458	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1159	likely change).	1467	likely change).
1160		1468
1161	Please note that resource strings will currently only be freed when the	1469	Please note that resource strings will currently only be freed when the
1162	terminal is destroyed, so changing options frequently will eat memory.	1470	terminal is destroyed, so changing options frequently will eat memory.
1163		1471
1164	Here is a a likely non-exhaustive list of resource names, not all of which	1472	Here is a likely non-exhaustive list of resource names, not all of which
1165	are supported in every build, please see the source file F</src/rsinc.h>	1473	are supported in every build, please see the source file F</src/rsinc.h>
1166	to see the actual list:	1474	to see the actual list:
1167		1475
1168	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1476	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1169	borderLess color cursorBlink cursorUnderline cutchars delete_key	1477	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1170	display_name embed ext_bwidth fade font geometry hold iconName	1478	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1171	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1479	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1480	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1172	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1481	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1173	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1482	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1174	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1483	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1175	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1484	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1176	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1485	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1177	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1486	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1178	secondaryScreen secondaryScroll selectstyle shade term_name title	1487	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1179	transient_for transparent transparent_all tripleclickwords utmpInhibit	1488	term_name title transient_for transparent tripleclickwords urgentOnBell
1180	visualBell	1489	utmpInhibit visualBell
1181		1490
1182	=cut	1491	=cut
1183		1492
1184	sub resource($$;$) {	1493	sub resource($$;$) {
1185	my ($self, $name) = (shift, shift);	1494	my ($self, $name) = (shift, shift);
1186	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1495	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1187	&urxvt::term::_resource	1496	goto &urxvt::term::_resource
1188	}	1497	}
1189		1498
1190	=item $value = $term->x_resource ($pattern)	1499	=item $value = $term->x_resource ($pattern)
1191		1500
1192	Returns the X-Resource for the given pattern, excluding the program or	1501	Returns the X-Resource for the given pattern, excluding the program or
…		…
1196		1505
1197	This method should only be called during the C<on_start> hook, as there is	1506	This method should only be called during the C<on_start> hook, as there is
1198	only one resource database per display, and later invocations might return	1507	only one resource database per display, and later invocations might return
1199	the wrong resources.	1508	the wrong resources.
1200		1509
1201	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1510	=item $value = $term->x_resource_boolean ($pattern)
1202		1511
		1512	Like C<x_resource>, above, but interprets the string value as a boolean
		1513	and returns C<1> for true values, C<0> for false values and C<undef> if
		1514	the resource or option isn't specified.
		1515
		1516	You should always use this method to parse boolean resources.
		1517
		1518	=cut
		1519
		1520	sub x_resource_boolean {
		1521	my $res = &x_resource;
		1522
		1523	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1524	}
		1525
		1526	=item $success = $term->parse_keysym ($key, $octets)
		1527
1203	Adds a keymap translation exactly as specified via a resource. See the	1528	Adds a key binding exactly as specified via a resource. See the
1204	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1529	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1530
		1531	=item $term->register_command ($keysym, $modifiermask, $string)
		1532
		1533	Adds a key binding. This is a lower level api compared to
		1534	C<parse_keysym>, as it expects a parsed key description, and can be
		1535	used only inside either the C<on_init> hook, to add a binding, or the
		1536	C<on_register_command> hook, to modify a parsed binding.
1205		1537
1206	=item $rend = $term->rstyle ([$new_rstyle])	1538	=item $rend = $term->rstyle ([$new_rstyle])
1207		1539
1208	Return and optionally change the current rendition. Text that is output by	1540	Return and optionally change the current rendition. Text that is output by
1209	the terminal application will use this style.	1541	the terminal application will use this style.
…		…
1217		1549
1218	=item ($row, $col) = $term->selection_beg ([$row, $col])	1550	=item ($row, $col) = $term->selection_beg ([$row, $col])
1219		1551
1220	=item ($row, $col) = $term->selection_end ([$row, $col])	1552	=item ($row, $col) = $term->selection_end ([$row, $col])
1221		1553
1222	Return the current values of the selection mark, begin or end positions,	1554	Return the current values of the selection mark, begin or end positions.
1223	and optionally set them to new values.	1555
		1556	When arguments are given, then the selection coordinates are set to
		1557	C<$row> and C<$col>, and the selection screen is set to the current
		1558	screen.
		1559
		1560	=item $screen = $term->selection_screen ([$screen])
		1561
		1562	Returns the current selection screen, and then optionally sets it.
1224		1563
1225	=item $term->selection_make ($eventtime[, $rectangular])	1564	=item $term->selection_make ($eventtime[, $rectangular])
1226		1565
1227	Tries to make a selection as set by C<selection_beg> and	1566	Tries to make a selection as set by C<selection_beg> and
1228	C<selection_end>. If C<$rectangular> is true (default: false), a	1567	C<selection_end>. If C<$rectangular> is true (default: false), a
1229	rectangular selection will be made. This is the prefered function to make	1568	rectangular selection will be made. This is the preferred function to make
1230	a selection.	1569	a selection.
1231		1570
1232	=item $success = $term->selection_grab ($eventtime)	1571	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1233		1572
1234	Try to request the primary selection text from the server (for example, as	1573	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1574	true) selection from the server. The corresponding text can be set
1235	set by the next method). No visual feedback will be given. This function	1575	with the next method. No visual feedback will be given. This function
1236	is mostly useful from within C<on_sel_grab> hooks.	1576	is mostly useful from within C<on_sel_grab> hooks.
1237		1577
1238	=item $oldtext = $term->selection ([$newtext])	1578	=item $oldtext = $term->selection ([$newtext, $clipboard])
1239		1579
1240	Return the current selection text and optionally replace it by C<$newtext>.	1580	Return the current selection (clipboard if C<$clipboard> is true) text
		1581	and optionally replace it by C<$newtext>.
		1582
		1583	=item $term->selection_clear ([$clipboard])
		1584
		1585	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1241		1586
1242	=item $term->overlay_simple ($x, $y, $text)	1587	=item $term->overlay_simple ($x, $y, $text)
1243		1588
1244	Create a simple multi-line overlay box. See the next method for details.	1589	Create a simple multi-line overlay box. See the next method for details.
1245		1590
…		…
1275		1620
1276	The methods currently supported on C<urxvt::overlay> objects are:	1621	The methods currently supported on C<urxvt::overlay> objects are:
1277		1622
1278	=over 4	1623	=over 4
1279		1624
1280	=item $overlay->set ($x, $y, $text, $rend)	1625	=item $overlay->set ($x, $y, $text[, $rend])
1281		1626
1282	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1627	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1283	text in rxvt-unicode's special encoding and an array of rendition values	1628	text in rxvt-unicode's special encoding and an array of rendition values
1284	at a specific position inside the overlay.	1629	at a specific position inside the overlay.
		1630
		1631	If C<$rend> is missing, then the rendition will not be changed.
1285		1632
1286	=item $overlay->hide	1633	=item $overlay->hide
1287		1634
1288	If visible, hide the overlay, but do not destroy it.	1635	If visible, hide the overlay, but do not destroy it.
1289		1636
…		…
1371	locale-specific encoding of the terminal and can contain command sequences	1718	locale-specific encoding of the terminal and can contain command sequences
1372	(escape codes) that will be interpreted.	1719	(escape codes) that will be interpreted.
1373		1720
1374	=item $term->tt_write ($octets)	1721	=item $term->tt_write ($octets)
1375		1722
1376	Write the octets given in C<$data> to the tty (i.e. as program input). To	1723	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1377	pass characters instead of octets, you should convert your strings first	1724	pass characters instead of octets, you should convert your strings first
1378	to the locale-specific encoding using C<< $term->locale_encode >>.	1725	to the locale-specific encoding using C<< $term->locale_encode >>.
		1726
		1727	=item $term->tt_paste ($octets)
		1728
		1729	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1730	CR and bracketing the data with control sequences if bracketed paste mode
		1731	is set.
1379		1732
1380	=item $old_events = $term->pty_ev_events ([$new_events])	1733	=item $old_events = $term->pty_ev_events ([$new_events])
1381		1734
1382	Replaces the event mask of the pty watcher by the given event mask. Can	1735	Replaces the event mask of the pty watcher by the given event mask. Can
1383	be used to suppress input and output handling to the pty/tty. See the	1736	be used to suppress input and output handling to the pty/tty. See the
…		…
1402	Adds the specified events to the vt event mask. Useful e.g. when you want	1755	Adds the specified events to the vt event mask. Useful e.g. when you want
1403	to receive pointer events all the times:	1756	to receive pointer events all the times:
1404		1757
1405	$term->vt_emask_add (urxvt::PointerMotionMask);	1758	$term->vt_emask_add (urxvt::PointerMotionMask);
1406		1759
		1760	=item $term->set_urgency ($set)
		1761
		1762	Enable/disable the urgency hint on the toplevel window.
		1763
1407	=item $term->focus_in	1764	=item $term->focus_in
1408		1765
1409	=item $term->focus_out	1766	=item $term->focus_out
1410		1767
1411	=item $term->key_press ($state, $keycode[, $time])	1768	=item $term->key_press ($state, $keycode[, $time])
…		…
1451	=item $env = $term->env	1808	=item $env = $term->env
1452		1809
1453	Returns a copy of the environment in effect for the terminal as a hashref	1810	Returns a copy of the environment in effect for the terminal as a hashref
1454	similar to C<\%ENV>.	1811	similar to C<\%ENV>.
1455		1812
		1813	=item @envv = $term->envv
		1814
		1815	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1816
		1817	=item @argv = $term->argv
		1818
		1819	Return the argument vector as this terminal, similar to @ARGV, but
		1820	includes the program name as first element.
		1821
1456	=cut	1822	=cut
1457		1823
1458	sub env {	1824	sub env {
1459	if (my $env = $_[0]->_env) {
1460	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1825	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1461	} else {
1462	+{ %ENV }
1463	}
1464	}	1826	}
1465		1827
1466	=item $modifiermask = $term->ModLevel3Mask	1828	=item $modifiermask = $term->ModLevel3Mask
1467		1829
1468	=item $modifiermask = $term->ModMetaMask	1830	=item $modifiermask = $term->ModMetaMask
…		…
1476		1838
1477	Returns the currently displayed screen (0 primary, 1 secondary).	1839	Returns the currently displayed screen (0 primary, 1 secondary).
1478		1840
1479	=item $cursor_is_hidden = $term->hidden_cursor	1841	=item $cursor_is_hidden = $term->hidden_cursor
1480		1842
1481	Returns wether the cursor is currently hidden or not.	1843	Returns whether the cursor is currently hidden or not.
1482		1844
1483	=item $view_start = $term->view_start ([$newvalue])	1845	=item $view_start = $term->view_start ([$newvalue])
1484		1846
1485	Returns the row number of the topmost displayed line. Maximum value is	1847	Returns the row number of the topmost displayed line. Maximum value is
1486	C<0>, which displays the normal terminal contents. Lower values scroll	1848	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1494		1856
1495	Used after changing terminal contents to display them.	1857	Used after changing terminal contents to display them.
1496		1858
1497	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1859	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1498		1860
1499	Returns the text of the entire row with number C<$row_number>. Row C<0>	1861	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1500	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1862	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1501	terminal line. The scrollback buffer starts at line C<-1> and extends to
1502	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1863	terminal line. Nothing will be returned if a nonexistent line
1503	is requested.	1864	is requested.
1504		1865
1505	If C<$new_text> is specified, it will replace characters in the current	1866	If C<$new_text> is specified, it will replace characters in the current
1506	line, starting at column C<$start_col> (default C<0>), which is useful	1867	line, starting at column C<$start_col> (default C<0>), which is useful
1507	to replace only parts of a line. The font index in the rendition will	1868	to replace only parts of a line. The font index in the rendition will
1508	automatically be updated.	1869	automatically be updated.
1509		1870
1510	C<$text> is in a special encoding: tabs and wide characters that use more	1871	C<$text> is in a special encoding: tabs and wide characters that use more
1511	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1872	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1512	characters. Characters with combining characters and other characters that	1873	characters. Characters with combining characters and other characters that
1513	do not fit into the normal tetx encoding will be replaced with characters	1874	do not fit into the normal text encoding will be replaced with characters
1514	in the private use area.	1875	in the private use area.
1515		1876
1516	You have to obey this encoding when changing text. The advantage is	1877	You have to obey this encoding when changing text. The advantage is
1517	that C<substr> and similar functions work on screen cells and not on	1878	that C<substr> and similar functions work on screen cells and not on
1518	characters.	1879	characters.
…		…
1663	where one character corresponds to one screen cell. See	2024	where one character corresponds to one screen cell. See
1664	C<< $term->ROW_t >> for details.	2025	C<< $term->ROW_t >> for details.
1665		2026
1666	=item $string = $term->special_decode $text	2027	=item $string = $term->special_decode $text
1667		2028
1668	Converts rxvt-unicodes text reprsentation into a perl string. See	2029	Converts rxvt-unicodes text representation into a perl string. See
1669	C<< $term->ROW_t >> for details.	2030	C<< $term->ROW_t >> for details.
1670		2031
1671	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2032	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1672		2033
1673	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2034	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1676	manpage.	2037	manpage.
1677		2038
1678	=item $success = $term->grab ($eventtime[, $sync])	2039	=item $success = $term->grab ($eventtime[, $sync])
1679		2040
1680	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2041	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1681	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2042	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1682		2043
1683	=item $term->allow_events_async	2044	=item $term->allow_events_async
1684		2045
1685	Calls XAllowEvents with AsyncBoth for the most recent grab.	2046	Calls XAllowEvents with AsyncBoth for the most recent grab.
1686		2047
…		…
1693	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2054	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1694	recent grab.	2055	recent grab.
1695		2056
1696	=item $term->ungrab	2057	=item $term->ungrab
1697		2058
1698	Calls XUngrab for the most recent grab. Is called automatically on	2059	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1699	evaluation errors, as it is better to lose the grab in the error case as	2060	evaluation errors, as it is better to lose the grab in the error case as
1700	the session.	2061	the session.
1701		2062
1702	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2063	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1703		2064
…		…
1705		2066
1706	=item @atoms = $term->XListProperties ($window)	2067	=item @atoms = $term->XListProperties ($window)
1707		2068
1708	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2069	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1709		2070
1710	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2071	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1711		2072
1712	=item $term->XDeleteProperty ($window, $property)	2073	=item $term->XDeleteProperty ($window, $property)
1713		2074
1714	=item $window = $term->DefaultRootWindow	2075	=item $window = $term->DefaultRootWindow
1715		2076
…		…
1722	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2083	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1723		2084
1724	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2085	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1725		2086
1726	=item $term->XChangeInput ($window, $add_events[, $del_events])	2087	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2088
		2089	=item $keysym = $term->XStringToKeysym ($string)
		2090
		2091	=item $string = $term->XKeysymToString ($keysym)
1727		2092
1728	Various X or X-related functions. The C<$term> object only serves as	2093	Various X or X-related functions. The C<$term> object only serves as
1729	the source of the display, otherwise those functions map more-or-less	2094	the source of the display, otherwise those functions map more-or-less
1730	directory onto the X functions of the same name.	2095	directly onto the X functions of the same name.
1731		2096
1732	=back	2097	=back
1733		2098
1734	=cut	2099	=cut
1735		2100
…		…
1799	my ($self, $text, $cb) = @_;	2164	my ($self, $text, $cb) = @_;
1800		2165
1801	$self->add_item ({ type => "button", text => $text, activate => $cb});	2166	$self->add_item ({ type => "button", text => $text, activate => $cb});
1802	}	2167	}
1803		2168
1804	=item $popup->add_toggle ($text, $cb, $initial_value)	2169	=item $popup->add_toggle ($text, $initial_value, $cb)
1805		2170
1806	Adds a toggle/checkbox item to the popup. Teh callback gets called	2171	Adds a toggle/checkbox item to the popup. The callback gets called
1807	whenever it gets toggled, with a boolean indicating its value as its first	2172	whenever it gets toggled, with a boolean indicating its new value as its
1808	argument.	2173	first argument.
1809		2174
1810	=cut	2175	=cut
1811		2176
1812	sub add_toggle {	2177	sub add_toggle {
1813	my ($self, $text, $cb, $value) = @_;	2178	my ($self, $text, $value, $cb) = @_;
1814		2179
1815	my $item; $item = {	2180	my $item; $item = {
1816	type => "button",	2181	type => "button",
1817	text => " $text",	2182	text => " $text",
1818	value => $value,	2183	value => $value,
…		…
1837	my $env = $self->{term}->env;	2202	my $env = $self->{term}->env;
1838	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2203	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1839	delete $env->{LC_ALL};	2204	delete $env->{LC_ALL};
1840	$env->{LC_CTYPE} = $self->{term}->locale;	2205	$env->{LC_CTYPE} = $self->{term}->locale;
1841		2206
1842	urxvt::term->new ($env, "popup",	2207	my $term = urxvt::term->new (
		2208	$env, "popup",
1843	"--perl-lib" => "", "--perl-ext-common" => "",	2209	"--perl-lib" => "", "--perl-ext-common" => "",
1844	"-pty-fd" => -1, "-sl" => 0,	2210	"-pty-fd" => -1, "-sl" => 0,
1845	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2211	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1846	"--transient-for" => $self->{term}->parent,	2212	"--transient-for" => $self->{term}->parent,
1847	"-display" => $self->{term}->display_id,	2213	"-display" => $self->{term}->display_id,
1848	"-pe" => "urxvt-popup")	2214	"-pe" => "urxvt-popup",
1849	or die "unable to create popup window\n";	2215	) or die "unable to create popup window\n";
		2216
		2217	unless (delete $term->{urxvt_popup_init_done}) {
		2218	$term->ungrab;
		2219	$term->destroy;
		2220	die "unable to initialise popup window\n";
		2221	}
1850	}	2222	}
1851		2223
1852	sub DESTROY {	2224	sub DESTROY {
1853	my ($self) = @_;	2225	my ($self) = @_;
1854		2226
…		…
1859	=back	2231	=back
1860		2232
1861	=cut	2233	=cut
1862		2234
1863	package urxvt::watcher;	2235	package urxvt::watcher;
1864
1865	@urxvt::timer::ISA = __PACKAGE__;
1866	@urxvt::iow::ISA = __PACKAGE__;
1867	@urxvt::pw::ISA = __PACKAGE__;
1868	@urxvt::iw::ISA = __PACKAGE__;
1869		2236
1870	=head2 The C<urxvt::timer> Class	2237	=head2 The C<urxvt::timer> Class
1871		2238
1872	This class implements timer watchers/events. Time is represented as a	2239	This class implements timer watchers/events. Time is represented as a
1873	fractional number of seconds since the epoch. Example:	2240	fractional number of seconds since the epoch. Example:
…		…
1877	->new	2244	->new
1878	->interval (1)	2245	->interval (1)
1879	->cb (sub {	2246	->cb (sub {
1880	$term->{overlay}->set (0, 0,	2247	$term->{overlay}->set (0, 0,
1881	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2248	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1882	});	2249	});
1883		2250
1884	=over 4	2251	=over 4
1885		2252
1886	=item $timer = new urxvt::timer	2253	=item $timer = new urxvt::timer
1887		2254
…		…
1890		2257
1891	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2258	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1892		2259
1893	Set the callback to be called when the timer triggers.	2260	Set the callback to be called when the timer triggers.
1894		2261
1895	=item $tstamp = $timer->at
1896
1897	Return the time this watcher will fire next.
1898
1899	=item $timer = $timer->set ($tstamp)	2262	=item $timer = $timer->set ($tstamp[, $interval])
1900		2263
1901	Set the time the event is generated to $tstamp.	2264	Set the time the event is generated to $tstamp (and optionally specifies a
		2265	new $interval).
1902		2266
1903	=item $timer = $timer->interval ($interval)	2267	=item $timer = $timer->interval ($interval)
1904		2268
1905	Normally (and when C<$interval> is C<0>), the timer will automatically	2269	By default (and when C<$interval> is C<0>), the timer will automatically
1906	stop after it has fired once. If C<$interval> is non-zero, then the timer	2270	stop after it has fired once. If C<$interval> is non-zero, then the timer
1907	is automatically rescheduled at the given intervals.	2271	is automatically rescheduled at the given intervals.
1908		2272
1909	=item $timer = $timer->start	2273	=item $timer = $timer->start
1910		2274
1911	Start the timer.	2275	Start the timer.
1912		2276
1913	=item $timer = $timer->start ($tstamp)	2277	=item $timer = $timer->start ($tstamp[, $interval])
1914		2278
1915	Set the event trigger time to C<$tstamp> and start the timer.	2279	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2280	also replaces the interval.
1916		2281
1917	=item $timer = $timer->after ($delay)	2282	=item $timer = $timer->after ($delay[, $interval])
1918		2283
1919	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2284	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1920		2285
1921	=item $timer = $timer->stop	2286	=item $timer = $timer->stop
1922		2287
…		…
1930		2295
1931	$term->{socket} = ...	2296	$term->{socket} = ...
1932	$term->{iow} = urxvt::iow	2297	$term->{iow} = urxvt::iow
1933	->new	2298	->new
1934	->fd (fileno $term->{socket})	2299	->fd (fileno $term->{socket})
1935	->events (urxvt::EVENT_READ)	2300	->events (urxvt::EV_READ)
1936	->start	2301	->start
1937	->cb (sub {	2302	->cb (sub {
1938	my ($iow, $revents) = @_;	2303	my ($iow, $revents) = @_;
1939	# $revents must be 1 here, no need to check	2304	# $revents must be 1 here, no need to check
1940	sysread $term->{socket}, my $buf, 8192	2305	sysread $term->{socket}, my $buf, 8192
…		…
1953	Set the callback to be called when io events are triggered. C<$reventmask>	2318	Set the callback to be called when io events are triggered. C<$reventmask>
1954	is a bitset as described in the C<events> method.	2319	is a bitset as described in the C<events> method.
1955		2320
1956	=item $iow = $iow->fd ($fd)	2321	=item $iow = $iow->fd ($fd)
1957		2322
1958	Set the filedescriptor (not handle) to watch.	2323	Set the file descriptor (not handle) to watch.
1959		2324
1960	=item $iow = $iow->events ($eventmask)	2325	=item $iow = $iow->events ($eventmask)
1961		2326
1962	Set the event mask to watch. The only allowed values are	2327	Set the event mask to watch. The only allowed values are
1963	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2328	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1964	together, or C<urxvt::EVENT_NONE>.	2329	together, or C<urxvt::EV_NONE>.
1965		2330
1966	=item $iow = $iow->start	2331	=item $iow = $iow->start
1967		2332
1968	Start watching for requested events on the given handle.	2333	Start watching for requested events on the given handle.
1969		2334
1970	=item $iow = $iow->stop	2335	=item $iow = $iow->stop
1971		2336
1972	Stop watching for events on the given filehandle.	2337	Stop watching for events on the given file handle.
1973		2338
1974	=back	2339	=back
1975		2340
1976	=head2 The C<urxvt::iw> Class	2341	=head2 The C<urxvt::iw> Class
1977		2342
…		…
2010	->new	2375	->new
2011	->start ($pid)	2376	->start ($pid)
2012	->cb (sub {	2377	->cb (sub {
2013	my ($pw, $exit_status) = @_;	2378	my ($pw, $exit_status) = @_;
2014	...	2379	...
2015	});	2380	});
2016		2381
2017	=over 4	2382	=over 4
2018		2383
2019	=item $pw = new urxvt::pw	2384	=item $pw = new urxvt::pw
2020		2385
…		…
2024		2389
2025	Set the callback to be called when the timer triggers.	2390	Set the callback to be called when the timer triggers.
2026		2391
2027	=item $pw = $timer->start ($pid)	2392	=item $pw = $timer->start ($pid)
2028		2393
2029	Tells the wqtcher to start watching for process C<$pid>.	2394	Tells the watcher to start watching for process C<$pid>.
2030		2395
2031	=item $pw = $pw->stop	2396	=item $pw = $pw->stop
2032		2397
2033	Stop the watcher.	2398	Stop the watcher.
2034		2399
…		…
2047		2412
2048	=item >= 3 - script loading and management	2413	=item >= 3 - script loading and management
2049		2414
2050	=item >=10 - all called hooks	2415	=item >=10 - all called hooks
2051		2416
2052	=item >=11 - hook reutrn values	2417	=item >=11 - hook return values
2053		2418
2054	=back	2419	=back
2055		2420
2056	=head1 AUTHOR	2421	=head1 AUTHOR
2057		2422
2058	Marc Lehmann <pcg@goof.com>	2423	Marc Lehmann <schmorp@schmorp.de>
2059	http://software.schmorp.de/pkg/rxvt-unicode	2424	http://software.schmorp.de/pkg/rxvt-unicode
2060		2425
2061	=cut	2426	=cut
2062		2427
2063	1	2428	1
		2429
		2430	# vim: sw=3:

Diff Legend

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