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.127 by root, Wed Jan 25 00:42:21 2006 UTC vs.
Revision 1.210 by root, Wed Jun 6 11:46:11 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.
216		258
217	=item automove-background	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.
218		263
219	This is basically a one-line extension that dynamically changes the background pixmap offset	264	It is possible to activate the most recently seen match or a list of matches
220	to the window position, in effect creating the same effect as pseudo transparency with	265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
221	a custom pixmap. No scaling is supported in this mode. Exmaple:	266	"perl:matcher:list" as seen in the example below.
222		267
223	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	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
		278
		279	=item xim-onthespot
		280
		281	This (experimental) perl extension implements OnTheSpot editing. It does
		282	not work perfectly, and some input methods don't seem to work well with
		283	OnTheSpot editing in general, but it seems to work at least for SCIM and
		284	kinput2.
		285
		286	You enable it by specifying this extension and a preedit style of
		287	C<OnTheSpot>, i.e.:
		288
		289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		290
		291	=item kuake<hotkey>
		292
		293	A very primitive quake-console-like extension. It was inspired by a
		294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		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.
		298
		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.
224		315
225	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
226		317
227	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
228	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
229	similar-looking ascii character.	320	similar-looking ascii character.
230		321
231	=item digital-clock	322	=item digital-clock
232		323
233	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
		325
		326	=item remote-clipboard
		327
		328	Somewhat of a misnomer, this extension adds two menu entries to the
		329	selection popup that allows one to run external commands to store the
		330	selection somewhere and fetch it again.
		331
		332	We use it to implement a "distributed selection mechanism", which just
		333	means that one command uploads the file to a remote server, and another
		334	reads it.
		335
		336	The commands can be set using the C<URxvt.remote-selection.store> and
		337	C<URxvt.remote-selection.fetch> resources. The first should read the
		338	selection to store from STDIN (always in UTF-8), the second should provide
		339	the selection data on STDOUT (also in UTF-8).
		340
		341	The defaults (which are likely useless to you) use rsh and cat:
		342
		343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		345
		346	=item selection-pastebin
		347
		348	This is a little rarely useful extension that uploads the selection as
		349	textfile to a remote site (or does other things). (The implementation is
		350	not currently secure for use in a multiuser environment as it writes to
		351	F</tmp> directly.).
		352
		353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		354	i.e.
		355
		356	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		357
		358	Pressing this combination runs a command with C<%> replaced by the name of
		359	the textfile. This command can be set via a resource:
		360
		361	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		362
		363	And the default is likely not useful to anybody but the few people around
		364	here :)
		365
		366	The name of the textfile is the hex encoded md5 sum of the selection, so
		367	the same content should lead to the same filename.
		368
		369	After a successful upload the selection will be replaced by the text given
		370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		371	for the filename):
		372
		373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		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.
234		393
235	=item example-refresh-hooks	394	=item example-refresh-hooks
236		395
237	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
238	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
239	overlays or changes.	398	overlays or changes.
240		399
241	=item selection-pastebin	400	=item confirm-paste
242		401
243	This is a little rarely useful extension that Uploads the selection as	402	Displays a confirmation dialog when a paste containing at least a full
244	textfile to a remote site (or does other things). (The implementation is	403	line is detected.
245	not currently secure for use in a multiuser environment as it writes to
246	F</tmp> directly.).
247		404
248	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	405	=item bell-command
249	i.e.
250		406
251	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin	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:
252		410
253	Pressing this combination runs a command with C<%> replaced by the name of	411	URxvt.bell-command: notify-send "Beep, Beep"
254	the textfile. This command can be set via a resource:
255
256	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
257
258	And the default is likely not useful to anybody but the few people around
259	here :)
260
261	The name of the textfile is the hex encoded md5 sum of the selection, so
262	the same content should lead to the same filename.
263
264	After a successful upload the selection will be replaced by the text given
265	in the C<selection-pastebin-url> resource (again, the % is the placeholder
266	for the filename):
267
268	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
269		412
270	=back	413	=back
271		414
272	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
273		416
…		…
289		432
290	=over 4	433	=over 4
291		434
292	=item $text	435	=item $text
293		436
294	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
295	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.
296		439
297	=item $string	440	=item $string
298		441
299	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
…		…
303	=item $octets	446	=item $octets
304		447
305	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
306	locale-specific way.	449	locale-specific way.
307		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
308	=back	457	=back
309		458
310	=head2 Extension Objects	459	=head2 Extension Objects
311		460
312	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
313	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,
314	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
315	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
316	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
317	use.	467	internal use.
318		468
319	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
320	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
321		471
322	It has the following methods and data members:	472	It has the following methods and data members:
…		…
343	=head2 Hooks	493	=head2 Hooks
344		494
345	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
346	called whenever the relevant event happens.	496	called whenever the relevant event happens.
347		497
348	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
349	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
350		500
351	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
352	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
353	relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
…		…
366	place.	516	place.
367		517
368	=item on_start $term	518	=item on_start $term
369		519
370	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
371	trying to map (display) the toplevel and returning to the mainloop.	521	trying to map (display) the toplevel and returning to the main loop.
372		522
373	=item on_destroy $term	523	=item on_destroy $term
374		524
375	Called whenever something tries to destroy terminal, when the terminal is	525	Called whenever something tries to destroy terminal, when the terminal is
376	still fully functional (not for long, though).	526	still fully functional (not for long, though).
…		…
403		553
404	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
405	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
406	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
407		557
408	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.
409		559
410	=item on_sel_extend $term	560	=item on_sel_extend $term
411		561
412	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
413	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
414	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
415	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
416	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
417	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
418		568
419	See the F<selection> example extension.	569	See the F<selection> example extension.
420		570
421	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
422		572
423	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
424	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
425	show this many lines of scrollback.	575	show this many lines of scrollback.
426		576
427	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
428		578
…		…
432		582
433	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,
434	$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
435	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
436		586
437	=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
438		598
439	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
440	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
441	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
442	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,
443	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
444	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	}
445		615
446	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,
447	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
448	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.
449		622
450	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
451		624
452	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
453	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
…		…
458	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
459		632
460	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
461	suppress or filter tty input.	634	suppress or filter tty input.
462		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
463	=item on_line_update $term, $row	643	=item on_line_update $term, $row
464		644
465	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
466	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
467	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,
…		…
474	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
475	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
476		656
477	=item on_refresh_begin $term	657	=item on_refresh_begin $term
478		658
479	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
480	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
481	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
482	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
483		663
484	=item on_refresh_end $term	664	=item on_refresh_end $term
485		665
486	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>.
487		667
488	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
489		669
490	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
491	C<perl:string> action bound to it (see description of the B<keysym>	671	a C<perl:string> action bound to a key, see description of the B<keysym>
492	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
		673
		674	The event is simply the action string. This interface is assumed to change
		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.
493		689
494	=item on_x_event $term, $event	690	=item on_x_event $term, $event
495		691
496	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
497	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
498	members are not passed.	694	members are not passed.
499		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
500	=item on_focus_in $term	700	=item on_focus_in $term
501		701
502	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
503	does focus in processing.	703	does focus in processing.
504		704
505	=item on_focus_out $term	705	=item on_focus_out $term
506		706
507	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
508	focus out processing.	708	focus out processing.
509		709
510	=item on_configure_notify $term, $event	710	=item on_configure_notify $term, $event
511		711
512	=item on_property_notify $term, $event	712	=item on_property_notify $term, $event
…		…
523		723
524	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
525		725
526	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
527		727
528	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
529	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.
530		730
531	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
532	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
533	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
534		734
…		…
543		743
544	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
545		745
546	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
547	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.
548		752
549	=back	753	=back
550		754
551	=cut	755	=cut
552		756
…		…
595	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
596	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
597		801
598	=item @urxvt::TERM_INIT	802	=item @urxvt::TERM_INIT
599		803
600	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
601	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
602	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,
603	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.
604		808
605	This complements to the perl-eval commandline option, but gets executed	809	This complements to the perl-eval command line option, but gets executed
606	first.	810	first.
607		811
608	=item @urxvt::TERM_EXT	812	=item @urxvt::TERM_EXT
609		813
610	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
…		…
617		821
618	=over 4	822	=over 4
619		823
620	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
621		825
622	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
623	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
624	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
625		830
626	=item urxvt::warn $string	831	=item urxvt::warn $string
627		832
628	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
629	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
630	that calls this function.	835	that calls this function.
631		836
632	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
633	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
634		839
635	Messages have a size limit of 1023 bytes currently.	840	Messages have a size limit of 1023 bytes currently.
		841
		842	=item @terms = urxvt::termlist
		843
		844	Returns all urxvt::term objects that exist in this process, regardless of
		845	whether they are started, being destroyed etc., so be careful. Only term
		846	objects that have perl extensions attached will be returned (because there
		847	is no urxvt::term object associated with others).
636		848
637	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
638		850
639	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
640		852
…		…
683		895
684	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
685		897
686	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
687		899
688	=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
689		902
690	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
691	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
692	the bitset.	905	the bitset.
693		906
…		…
698	Return the foreground/background colour index, respectively.	911	Return the foreground/background colour index, respectively.
699		912
700	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
701		914
702	=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
703		918
704	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
705	specified one.	920	specified one.
706		921
707	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
…		…
728	};	943	};
729	}	944	}
730		945
731	no warnings 'utf8';	946	no warnings 'utf8';
732		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	warn "resourece<@_>\n";#d#
		954
		955	my $r = $term->{meta}{resource};
		956	while (my ($pattern, $v) = each %$r) {
		957	$name =~ y/-/./ if $isarg;
		958
		959	if (
		960	$pattern =~ s/\*$//
		961	? $pattern eq substr $name, 0, length $pattern
		962	: $pattern eq $name
		963	) {
		964	$name = "$urxvt::RESCLASS.$name";
		965	warn "set option <$name=$value>\n";#d#
		966	#TODO: queue $v->[0] for loading
		967	if ($v->[1] eq "boolean") {
		968	$term->put_option_db ($name, $flag ? "true" : "false");
		969	return 1;
		970	} else {
		971	$term->put_option_db ($name, $value);
		972	return 1 + 2;
		973	}
		974	}
		975	}
		976
		977	0
		978	}
		979
		980	sub usage {
		981	my ($term, $usage_type) = @_;
		982
		983	$term->scan_meta;
		984
		985	my $r = $term->{meta}{resource};
		986
		987	for my $pattern (sort keys %$r) {
		988	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		989
		990	$desc .= " (-pe $ext)";
		991
		992	if ($usage_type == 1) {
		993	$pattern =~ y/./-/;
		994	$pattern =~ s/\*/.../g;
		995
		996	if ($type eq "boolean") {
		997	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		998	} else {
		999	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		1000	}
		1001	} else {
		1002	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1003	}
		1004	}
		1005	}
		1006
733	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1007	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
734		1008
735	sub verbose {	1009	sub verbose {
736	my ($level, $msg) = @_;	1010	my ($level, $msg) = @_;
737	warn "$msg\n" if $level <= $verbosity;	1011	warn "$msg\n" if $level <= $verbosity;
…		…
773	sub invoke {	1047	sub invoke {
774	local $TERM = shift;	1048	local $TERM = shift;
775	my $htype = shift;	1049	my $htype = shift;
776		1050
777	if ($htype == 0) { # INIT	1051	if ($htype == 0) { # INIT
778	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1052	my @dirs = $TERM->perl_libdirs;
779		1053
780	my %ext_arg;	1054	my %ext_arg;
781		1055
782	{	1056	{
783	my @init = @TERM_INIT;	1057	my @init = @TERM_INIT;
784	@TERM_INIT = ();	1058	@TERM_INIT = ();
…		…
798	} else {	1072	} else {
799	$ext_arg{$_} ||= [];	1073	$ext_arg{$_} ||= [];
800	}	1074	}
801	}	1075	}
802		1076
803	while (my ($ext, $argv) = each %ext_arg) {	1077	for my $ext (sort keys %ext_arg) {
804	my @files = grep -f $_, map "$_/$ext", @dirs;	1078	my @files = grep -f $_, map "$_/$ext", @dirs;
805		1079
806	if (@files) {	1080	if (@files) {
807	$TERM->register_package (extension_package $files[0], $argv);	1081	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
808	} else {	1082	} else {
809	warn "perl extension '$ext' not found in perl library search path\n";	1083	warn "perl extension '$ext' not found in perl library search path\n";
810	}	1084	}
811	}	1085	}
812		1086
…		…
818		1092
819	if (my $cb = $TERM->{_hook}[$htype]) {	1093	if (my $cb = $TERM->{_hook}[$htype]) {
820	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1094	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
821	if $verbosity >= 10;	1095	if $verbosity >= 10;
822		1096
823	keys %$cb;	1097	for my $pkg (keys %$cb) {
824
825	while (my ($pkg, $cb) = each %$cb) {
826	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1098	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
827	$retval ||= $retval_;	1099	$retval ||= $retval_;
828		1100
829	if ($@) {	1101	if ($@) {
830	$TERM->ungrab; # better to lose the grab than the session	1102	$TERM->ungrab; # better to lose the grab than the session
831	warn $@;	1103	warn $@;
…		…
843	# clear package	1115	# clear package
844	%$TERM = ();	1116	%$TERM = ();
845	}	1117	}
846		1118
847	$retval	1119	$retval
		1120	}
		1121
		1122	sub SET_COLOR($$$) {
		1123	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1124	}
		1125
		1126	sub rend2mask {
		1127	no strict 'refs';
		1128	my ($str, $mask) = (@_, 0);
		1129	my %color = ( fg => undef, bg => undef );
		1130	my @failed;
		1131	for my $spec ( split /\s+/, $str ) {
		1132	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1133	$color{lc($1)} = $2;
		1134	} else {
		1135	my $neg = $spec =~ s/^[-^]//;
		1136	unless ( exists &{"RS_$spec"} ) {
		1137	push @failed, $spec;
		1138	next;
		1139	}
		1140	my $cur = &{"RS_$spec"};
		1141	if ( $neg ) {
		1142	$mask &= ~$cur;
		1143	} else {
		1144	$mask |= $cur;
		1145	}
		1146	}
		1147	}
		1148	($mask, @color{qw(fg bg)}, \@failed)
848	}	1149	}
849		1150
850	# urxvt::term::extension	1151	# urxvt::term::extension
851		1152
852	package urxvt::term::extension;	1153	package urxvt::term::extension;
…		…
917	=head2 The C<urxvt::anyevent> Class	1218	=head2 The C<urxvt::anyevent> Class
918		1219
919	The sole purpose of this class is to deliver an interface to the	1220	The sole purpose of this class is to deliver an interface to the
920	C<AnyEvent> module - any module using it will work inside urxvt without	1221	C<AnyEvent> module - any module using it will work inside urxvt without
921	further programming. The only exception is that you cannot wait on	1222	further programming. The only exception is that you cannot wait on
922	condition variables, but non-blocking condvar use is ok. What this means	1223	condition variables, but non-blocking condvar use is ok.
923	is that you cannot use blocking APIs, but the non-blocking variant should	1224
924	work.	1225	In practical terms this means is that you cannot use blocking APIs, but
		1226	the non-blocking variant should work.
925		1227
926	=cut	1228	=cut
927		1229
928	our $VERSION = 1;	1230	our $VERSION = '5.23';
929		1231
930	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1232	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
931	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1233	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
932		1234
933	sub timer {	1235	sub timer {
…		…
935		1237
936	my $cb = $arg{cb};	1238	my $cb = $arg{cb};
937		1239
938	urxvt::timer	1240	urxvt::timer
939	->new	1241	->new
940	->start (urxvt::NOW + $arg{after})	1242	->after ($arg{after}, $arg{interval})
941	->cb (sub {	1243	->cb ($arg{interval} ? $cb : sub {
942	$_[0]->stop; # need to cancel manually	1244	$_[0]->stop; # need to cancel manually
943	$cb->();	1245	$cb->();
944	})	1246	})
945	}	1247	}
946		1248
947	sub io {	1249	sub io {
948	my ($class, %arg) = @_;	1250	my ($class, %arg) = @_;
949		1251
950	my $cb = $arg{cb};	1252	my $cb = $arg{cb};
		1253	my $fd = fileno $arg{fh};
		1254	defined $fd or $fd = $arg{fh};
951		1255
952	bless [$arg{fh}, urxvt::iow	1256	bless [$arg{fh}, urxvt::iow
953	->new	1257	->new
954	->fd (fileno $arg{fh})	1258	->fd ($fd)
955	->events (($arg{poll} =~ /r/ ? 1 : 0)	1259	->events (($arg{poll} =~ /r/ ? 1 : 0)
956	| ($arg{poll} =~ /w/ ? 2 : 0))	1260	| ($arg{poll} =~ /w/ ? 2 : 0))
957	->start	1261	->start
958	->cb (sub {	1262	->cb ($cb)
959	$cb->(($_[1] & 1 ? 'r' : '')
960	. ($_[1] & 2 ? 'w' : ''));
961	})],
962	urxvt::anyevent::	1263	], urxvt::anyevent::
		1264	}
		1265
		1266	sub idle {
		1267	my ($class, %arg) = @_;
		1268
		1269	my $cb = $arg{cb};
		1270
		1271	urxvt::iw
		1272	->new
		1273	->start
		1274	->cb ($cb)
		1275	}
		1276
		1277	sub child {
		1278	my ($class, %arg) = @_;
		1279
		1280	my $cb = $arg{cb};
		1281
		1282	urxvt::pw
		1283	->new
		1284	->start ($arg{pid})
		1285	->cb (sub {
		1286	$_[0]->stop; # need to cancel manually
		1287	$cb->($_[0]->rpid, $_[0]->rstatus);
		1288	})
963	}	1289	}
964		1290
965	sub DESTROY {	1291	sub DESTROY {
966	$_[0][1]->stop;	1292	$_[0][1]->stop;
967	}	1293	}
968		1294
969	sub condvar {	1295	# only needed for AnyEvent < 6 compatibility
970	bless \my $flag, urxvt::anyevent::condvar::	1296	sub one_event {
971	}
972
973	sub urxvt::anyevent::condvar::broadcast {
974	${$_[0]}++;
975	}
976
977	sub urxvt::anyevent::condvar::wait {
978	unless (${$_[0]}) {
979	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1297	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
980	}
981	}	1298	}
982		1299
983	package urxvt::term;	1300	package urxvt::term;
984		1301
985	=head2 The C<urxvt::term> Class	1302	=head2 The C<urxvt::term> Class
…		…
1012	$proxy->enable ($name => $ref);	1329	$proxy->enable ($name => $ref);
1013	}	1330	}
1014	}	1331	}
1015	}	1332	}
1016		1333
		1334	sub perl_libdirs {
		1335	map { split /:/ }
		1336	$_[0]->resource ("perl_lib"),
		1337	$ENV{URXVT_PERL_LIB},
		1338	"$ENV{HOME}/.urxvt/ext",
		1339	"$LIBDIR/perl"
		1340	}
		1341
		1342	sub scan_meta {
		1343	my ($self) = @_;
		1344	my @libdirs = perl_libdirs $self;
		1345
		1346	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1347
		1348	my %meta;
		1349
		1350	$self->{meta_libdirs} = join "\x00", @libdirs;
		1351	$self->{meta} = \%meta;
		1352
		1353	for my $dir (reverse @libdirs) {
		1354	opendir my $fh, $dir
		1355	or next;
		1356	for my $ext (readdir $fh) {
		1357	$ext ne "."
		1358	and $ext ne ".."
		1359	and open my $fh, "<", "$dir/$ext"
		1360	or next;
		1361
		1362	while (<$fh>) {
		1363	if (/^#:META:X_RESOURCE:(.*)/) {
		1364	my ($pattern, $type, $desc) = split /:/, $1;
		1365	$pattern =~ s/^%\./$ext./g; # $$ in pattern == extension name
		1366	if ($pattern =~ /[^a-zA-Z\*\.]/) {
		1367	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1368	} else {
		1369	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1370	}
		1371	} elsif (/^\s*(?:#|$)/) {
		1372	# skip other comments and empty lines
		1373	} else {
		1374	last; # stop parsing on first non-empty non-comment line
		1375	}
		1376	}
		1377	}
		1378	}
		1379	}
		1380
1017	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1381	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1018		1382
1019	Creates a new terminal, very similar as if you had started it with system	1383	Creates a new terminal, very similar as if you had started it with system
1020	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1384	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1021	hash which defines the environment of the new terminal.	1385	hash which defines the environment of the new terminal.
1022		1386
1023	Croaks (and probably outputs an error message) if the new instance	1387	Croaks (and probably outputs an error message) if the new instance
1024	couldn't be created. Returns C<undef> if the new instance didn't	1388	couldn't be created. Returns C<undef> if the new instance didn't
1025	initialise perl, and the terminal object otherwise. The C<init> and	1389	initialise perl, and the terminal object otherwise. The C<init> and
1026	C<start> hooks will be called during this call.	1390	C<start> hooks will be called before this call returns, and are free to
		1391	refer to global data (which is race free).
1027		1392
1028	=cut	1393	=cut
1029		1394
1030	sub new {	1395	sub new {
1031	my ($class, $env, @args) = @_;	1396	my ($class, $env, @args) = @_;
1032		1397
		1398	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1399	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1400
1033	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1401	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1034	}	1402	}
1035		1403
1036	=item $term->destroy	1404	=item $term->destroy
1037		1405
1038	Destroy the terminal object (close the window, free resources	1406	Destroy the terminal object (close the window, free resources
…		…
1068		1436
1069	Returns true if the option specified by C<$optval> is enabled, and	1437	Returns true if the option specified by C<$optval> is enabled, and
1070	optionally change it. All option values are stored by name in the hash	1438	optionally change it. All option values are stored by name in the hash
1071	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1439	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1072		1440
1073	Here is a a likely non-exhaustive list of option names, please see the	1441	Here is a likely non-exhaustive list of option names, please see the
1074	source file F</src/optinc.h> to see the actual list:	1442	source file F</src/optinc.h> to see the actual list:
1075		1443
1076	borderLess console cursorBlink cursorUnderline hold iconic insecure	1444	borderLess buffered console cursorBlink cursorUnderline hold iconic
1077	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1445	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1078	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1446	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1079	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1447	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1080	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1448	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1081	transparent tripleclickwords utmpInhibit visualBell	1449	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1450	urgentOnBell utmpInhibit visualBell
1082		1451
1083	=item $value = $term->resource ($name[, $newval])	1452	=item $value = $term->resource ($name[, $newval])
1084		1453
1085	Returns the current resource value associated with a given name and	1454	Returns the current resource value associated with a given name and
1086	optionally sets a new value. Setting values is most useful in the C<init>	1455	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1095	likely change).	1464	likely change).
1096		1465
1097	Please note that resource strings will currently only be freed when the	1466	Please note that resource strings will currently only be freed when the
1098	terminal is destroyed, so changing options frequently will eat memory.	1467	terminal is destroyed, so changing options frequently will eat memory.
1099		1468
1100	Here is a a likely non-exhaustive list of resource names, not all of which	1469	Here is a likely non-exhaustive list of resource names, not all of which
1101	are supported in every build, please see the source file F</src/rsinc.h>	1470	are supported in every build, please see the source file F</src/rsinc.h>
1102	to see the actual list:	1471	to see the actual list:
1103		1472
1104	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1473	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1105	borderLess color cursorBlink cursorUnderline cutchars delete_key	1474	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1106	display_name embed ext_bwidth fade font geometry hold iconName	1475	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1107	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1476	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1477	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1108	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1478	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1109	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1479	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1110	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1480	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1111	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1481	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1112	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1482	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1113	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1483	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1114	secondaryScreen secondaryScroll selectstyle shade term_name title	1484	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1115	transient_for transparent transparent_all tripleclickwords utmpInhibit	1485	term_name title transient_for transparent tripleclickwords urgentOnBell
1116	visualBell	1486	utmpInhibit visualBell
1117		1487
1118	=cut	1488	=cut
1119		1489
1120	sub resource($$;$) {	1490	sub resource($$;$) {
1121	my ($self, $name) = (shift, shift);	1491	my ($self, $name) = (shift, shift);
1122	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1492	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1123	&urxvt::term::_resource	1493	goto &urxvt::term::_resource
1124	}	1494	}
1125		1495
1126	=item $value = $term->x_resource ($pattern)	1496	=item $value = $term->x_resource ($pattern)
1127		1497
1128	Returns the X-Resource for the given pattern, excluding the program or	1498	Returns the X-Resource for the given pattern, excluding the program or
…		…
1132		1502
1133	This method should only be called during the C<on_start> hook, as there is	1503	This method should only be called during the C<on_start> hook, as there is
1134	only one resource database per display, and later invocations might return	1504	only one resource database per display, and later invocations might return
1135	the wrong resources.	1505	the wrong resources.
1136		1506
1137	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1507	=item $success = $term->parse_keysym ($key, $octets)
1138		1508
1139	Adds a keymap translation exactly as specified via a resource. See the	1509	Adds a key binding exactly as specified via a resource. See the
1140	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1510	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1511
		1512	=item $term->register_command ($keysym, $modifiermask, $string)
		1513
		1514	Adds a key binding. This is a lower level api compared to
		1515	C<parse_keysym>, as it expects a parsed key description, and can be
		1516	used only inside either the C<on_init> hook, to add a binding, or the
		1517	C<on_register_command> hook, to modify a parsed binding.
1141		1518
1142	=item $rend = $term->rstyle ([$new_rstyle])	1519	=item $rend = $term->rstyle ([$new_rstyle])
1143		1520
1144	Return and optionally change the current rendition. Text that is output by	1521	Return and optionally change the current rendition. Text that is output by
1145	the terminal application will use this style.	1522	the terminal application will use this style.
…		…
1153		1530
1154	=item ($row, $col) = $term->selection_beg ([$row, $col])	1531	=item ($row, $col) = $term->selection_beg ([$row, $col])
1155		1532
1156	=item ($row, $col) = $term->selection_end ([$row, $col])	1533	=item ($row, $col) = $term->selection_end ([$row, $col])
1157		1534
1158	Return the current values of the selection mark, begin or end positions,	1535	Return the current values of the selection mark, begin or end positions.
1159	and optionally set them to new values.	1536
		1537	When arguments are given, then the selection coordinates are set to
		1538	C<$row> and C<$col>, and the selection screen is set to the current
		1539	screen.
		1540
		1541	=item $screen = $term->selection_screen ([$screen])
		1542
		1543	Returns the current selection screen, and then optionally sets it.
1160		1544
1161	=item $term->selection_make ($eventtime[, $rectangular])	1545	=item $term->selection_make ($eventtime[, $rectangular])
1162		1546
1163	Tries to make a selection as set by C<selection_beg> and	1547	Tries to make a selection as set by C<selection_beg> and
1164	C<selection_end>. If C<$rectangular> is true (default: false), a	1548	C<selection_end>. If C<$rectangular> is true (default: false), a
1165	rectangular selection will be made. This is the prefered function to make	1549	rectangular selection will be made. This is the preferred function to make
1166	a selection.	1550	a selection.
1167		1551
1168	=item $success = $term->selection_grab ($eventtime)	1552	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1169		1553
1170	Try to request the primary selection text from the server (for example, as	1554	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1555	true) selection from the server. The corresponding text can be set
1171	set by the next method). No visual feedback will be given. This function	1556	with the next method. No visual feedback will be given. This function
1172	is mostly useful from within C<on_sel_grab> hooks.	1557	is mostly useful from within C<on_sel_grab> hooks.
1173		1558
1174	=item $oldtext = $term->selection ([$newtext])	1559	=item $oldtext = $term->selection ([$newtext, $clipboard])
1175		1560
1176	Return the current selection text and optionally replace it by C<$newtext>.	1561	Return the current selection (clipboard if C<$clipboard> is true) text
		1562	and optionally replace it by C<$newtext>.
		1563
		1564	=item $term->selection_clear ([$clipboard])
		1565
		1566	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1177		1567
1178	=item $term->overlay_simple ($x, $y, $text)	1568	=item $term->overlay_simple ($x, $y, $text)
1179		1569
1180	Create a simple multi-line overlay box. See the next method for details.	1570	Create a simple multi-line overlay box. See the next method for details.
1181		1571
…		…
1211		1601
1212	The methods currently supported on C<urxvt::overlay> objects are:	1602	The methods currently supported on C<urxvt::overlay> objects are:
1213		1603
1214	=over 4	1604	=over 4
1215		1605
1216	=item $overlay->set ($x, $y, $text, $rend)	1606	=item $overlay->set ($x, $y, $text[, $rend])
1217		1607
1218	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1608	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1219	text in rxvt-unicode's special encoding and an array of rendition values	1609	text in rxvt-unicode's special encoding and an array of rendition values
1220	at a specific position inside the overlay.	1610	at a specific position inside the overlay.
		1611
		1612	If C<$rend> is missing, then the rendition will not be changed.
1221		1613
1222	=item $overlay->hide	1614	=item $overlay->hide
1223		1615
1224	If visible, hide the overlay, but do not destroy it.	1616	If visible, hide the overlay, but do not destroy it.
1225		1617
…		…
1307	locale-specific encoding of the terminal and can contain command sequences	1699	locale-specific encoding of the terminal and can contain command sequences
1308	(escape codes) that will be interpreted.	1700	(escape codes) that will be interpreted.
1309		1701
1310	=item $term->tt_write ($octets)	1702	=item $term->tt_write ($octets)
1311		1703
1312	Write the octets given in C<$data> to the tty (i.e. as program input). To	1704	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1313	pass characters instead of octets, you should convert your strings first	1705	pass characters instead of octets, you should convert your strings first
1314	to the locale-specific encoding using C<< $term->locale_encode >>.	1706	to the locale-specific encoding using C<< $term->locale_encode >>.
		1707
		1708	=item $term->tt_paste ($octets)
		1709
		1710	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1711	CR and bracketing the data with control sequences if bracketed paste mode
		1712	is set.
1315		1713
1316	=item $old_events = $term->pty_ev_events ([$new_events])	1714	=item $old_events = $term->pty_ev_events ([$new_events])
1317		1715
1318	Replaces the event mask of the pty watcher by the given event mask. Can	1716	Replaces the event mask of the pty watcher by the given event mask. Can
1319	be used to suppress input and output handling to the pty/tty. See the	1717	be used to suppress input and output handling to the pty/tty. See the
…		…
1338	Adds the specified events to the vt event mask. Useful e.g. when you want	1736	Adds the specified events to the vt event mask. Useful e.g. when you want
1339	to receive pointer events all the times:	1737	to receive pointer events all the times:
1340		1738
1341	$term->vt_emask_add (urxvt::PointerMotionMask);	1739	$term->vt_emask_add (urxvt::PointerMotionMask);
1342		1740
		1741	=item $term->set_urgency ($set)
		1742
		1743	Enable/disable the urgency hint on the toplevel window.
		1744
		1745	=item $term->focus_in
		1746
		1747	=item $term->focus_out
		1748
		1749	=item $term->key_press ($state, $keycode[, $time])
		1750
		1751	=item $term->key_release ($state, $keycode[, $time])
		1752
		1753	Deliver various fake events to to terminal.
		1754
1343	=item $window_width = $term->width	1755	=item $window_width = $term->width
1344		1756
1345	=item $window_height = $term->height	1757	=item $window_height = $term->height
1346		1758
1347	=item $font_width = $term->fwidth	1759	=item $font_width = $term->fwidth
…		…
1377	=item $env = $term->env	1789	=item $env = $term->env
1378		1790
1379	Returns a copy of the environment in effect for the terminal as a hashref	1791	Returns a copy of the environment in effect for the terminal as a hashref
1380	similar to C<\%ENV>.	1792	similar to C<\%ENV>.
1381		1793
		1794	=item @envv = $term->envv
		1795
		1796	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1797
		1798	=item @argv = $term->argv
		1799
		1800	Return the argument vector as this terminal, similar to @ARGV, but
		1801	includes the program name as first element.
		1802
1382	=cut	1803	=cut
1383		1804
1384	sub env {	1805	sub env {
1385	if (my $env = $_[0]->_env) {
1386	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1806	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1387	} else {
1388	+{ %ENV }
1389	}
1390	}	1807	}
1391		1808
1392	=item $modifiermask = $term->ModLevel3Mask	1809	=item $modifiermask = $term->ModLevel3Mask
1393		1810
1394	=item $modifiermask = $term->ModMetaMask	1811	=item $modifiermask = $term->ModMetaMask
…		…
1402		1819
1403	Returns the currently displayed screen (0 primary, 1 secondary).	1820	Returns the currently displayed screen (0 primary, 1 secondary).
1404		1821
1405	=item $cursor_is_hidden = $term->hidden_cursor	1822	=item $cursor_is_hidden = $term->hidden_cursor
1406		1823
1407	Returns wether the cursor is currently hidden or not.	1824	Returns whether the cursor is currently hidden or not.
1408		1825
1409	=item $view_start = $term->view_start ([$newvalue])	1826	=item $view_start = $term->view_start ([$newvalue])
1410		1827
1411	Returns the row number of the topmost displayed line. Maximum value is	1828	Returns the row number of the topmost displayed line. Maximum value is
1412	C<0>, which displays the normal terminal contents. Lower values scroll	1829	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1420		1837
1421	Used after changing terminal contents to display them.	1838	Used after changing terminal contents to display them.
1422		1839
1423	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1840	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1424		1841
1425	Returns the text of the entire row with number C<$row_number>. Row C<0>	1842	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1426	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1843	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1427	terminal line. The scrollback buffer starts at line C<-1> and extends to
1428	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1844	terminal line. Nothing will be returned if a nonexistent line
1429	is requested.	1845	is requested.
1430		1846
1431	If C<$new_text> is specified, it will replace characters in the current	1847	If C<$new_text> is specified, it will replace characters in the current
1432	line, starting at column C<$start_col> (default C<0>), which is useful	1848	line, starting at column C<$start_col> (default C<0>), which is useful
1433	to replace only parts of a line. The font index in the rendition will	1849	to replace only parts of a line. The font index in the rendition will
1434	automatically be updated.	1850	automatically be updated.
1435		1851
1436	C<$text> is in a special encoding: tabs and wide characters that use more	1852	C<$text> is in a special encoding: tabs and wide characters that use more
1437	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1853	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1438	characters. Characters with combining characters and other characters that	1854	characters. Characters with combining characters and other characters that
1439	do not fit into the normal tetx encoding will be replaced with characters	1855	do not fit into the normal text encoding will be replaced with characters
1440	in the private use area.	1856	in the private use area.
1441		1857
1442	You have to obey this encoding when changing text. The advantage is	1858	You have to obey this encoding when changing text. The advantage is
1443	that C<substr> and similar functions work on screen cells and not on	1859	that C<substr> and similar functions work on screen cells and not on
1444	characters.	1860	characters.
…		…
1589	where one character corresponds to one screen cell. See	2005	where one character corresponds to one screen cell. See
1590	C<< $term->ROW_t >> for details.	2006	C<< $term->ROW_t >> for details.
1591		2007
1592	=item $string = $term->special_decode $text	2008	=item $string = $term->special_decode $text
1593		2009
1594	Converts rxvt-unicodes text reprsentation into a perl string. See	2010	Converts rxvt-unicodes text representation into a perl string. See
1595	C<< $term->ROW_t >> for details.	2011	C<< $term->ROW_t >> for details.
1596		2012
1597	=item $success = $term->grab_button ($button, $modifiermask)	2013	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1598		2014
		2015	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2016
1599	Registers a synchronous button grab. See the XGrabButton manpage.	2017	Register/unregister a synchronous button grab. See the XGrabButton
		2018	manpage.
1600		2019
1601	=item $success = $term->grab ($eventtime[, $sync])	2020	=item $success = $term->grab ($eventtime[, $sync])
1602		2021
1603	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2022	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1604	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2023	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1605		2024
1606	=item $term->allow_events_async	2025	=item $term->allow_events_async
1607		2026
1608	Calls XAllowEvents with AsyncBoth for the most recent grab.	2027	Calls XAllowEvents with AsyncBoth for the most recent grab.
1609		2028
…		…
1616	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2035	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1617	recent grab.	2036	recent grab.
1618		2037
1619	=item $term->ungrab	2038	=item $term->ungrab
1620		2039
1621	Calls XUngrab for the most recent grab. Is called automatically on	2040	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1622	evaluation errors, as it is better to lose the grab in the error case as	2041	evaluation errors, as it is better to lose the grab in the error case as
1623	the session.	2042	the session.
1624		2043
1625	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2044	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1626		2045
…		…
1628		2047
1629	=item @atoms = $term->XListProperties ($window)	2048	=item @atoms = $term->XListProperties ($window)
1630		2049
1631	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2050	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1632		2051
1633	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2052	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1634		2053
1635	=item $term->XDeleteProperty ($window, $property)	2054	=item $term->XDeleteProperty ($window, $property)
1636		2055
1637	=item $window = $term->DefaultRootWindow	2056	=item $window = $term->DefaultRootWindow
1638		2057
…		…
1645	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2064	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1646		2065
1647	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2066	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1648		2067
1649	=item $term->XChangeInput ($window, $add_events[, $del_events])	2068	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2069
		2070	=item $keysym = $term->XStringToKeysym ($string)
		2071
		2072	=item $string = $term->XKeysymToString ($keysym)
1650		2073
1651	Various X or X-related functions. The C<$term> object only serves as	2074	Various X or X-related functions. The C<$term> object only serves as
1652	the source of the display, otherwise those functions map more-or-less	2075	the source of the display, otherwise those functions map more-or-less
1653	directory onto the X functions of the same name.	2076	directly onto the X functions of the same name.
1654		2077
1655	=back	2078	=back
1656		2079
1657	=cut	2080	=cut
1658		2081
…		…
1722	my ($self, $text, $cb) = @_;	2145	my ($self, $text, $cb) = @_;
1723		2146
1724	$self->add_item ({ type => "button", text => $text, activate => $cb});	2147	$self->add_item ({ type => "button", text => $text, activate => $cb});
1725	}	2148	}
1726		2149
1727	=item $popup->add_toggle ($text, $cb, $initial_value)	2150	=item $popup->add_toggle ($text, $initial_value, $cb)
1728		2151
1729	Adds a toggle/checkbox item to the popup. Teh callback gets called	2152	Adds a toggle/checkbox item to the popup. The callback gets called
1730	whenever it gets toggled, with a boolean indicating its value as its first	2153	whenever it gets toggled, with a boolean indicating its new value as its
1731	argument.	2154	first argument.
1732		2155
1733	=cut	2156	=cut
1734		2157
1735	sub add_toggle {	2158	sub add_toggle {
1736	my ($self, $text, $cb, $value) = @_;	2159	my ($self, $text, $value, $cb) = @_;
1737		2160
1738	my $item; $item = {	2161	my $item; $item = {
1739	type => "button",	2162	type => "button",
1740	text => " $text",	2163	text => " $text",
1741	value => $value,	2164	value => $value,
…		…
1760	my $env = $self->{term}->env;	2183	my $env = $self->{term}->env;
1761	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2184	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1762	delete $env->{LC_ALL};	2185	delete $env->{LC_ALL};
1763	$env->{LC_CTYPE} = $self->{term}->locale;	2186	$env->{LC_CTYPE} = $self->{term}->locale;
1764		2187
1765	urxvt::term->new ($env, "popup",	2188	my $term = urxvt::term->new (
		2189	$env, "popup",
1766	"--perl-lib" => "", "--perl-ext-common" => "",	2190	"--perl-lib" => "", "--perl-ext-common" => "",
1767	"-pty-fd" => -1, "-sl" => 0,	2191	"-pty-fd" => -1, "-sl" => 0,
1768	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2192	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1769	"--transient-for" => $self->{term}->parent,	2193	"--transient-for" => $self->{term}->parent,
1770	"-display" => $self->{term}->display_id,	2194	"-display" => $self->{term}->display_id,
1771	"-pe" => "urxvt-popup")	2195	"-pe" => "urxvt-popup",
1772	or die "unable to create popup window\n";	2196	) or die "unable to create popup window\n";
		2197
		2198	unless (delete $term->{urxvt_popup_init_done}) {
		2199	$term->ungrab;
		2200	$term->destroy;
		2201	die "unable to initialise popup window\n";
		2202	}
1773	}	2203	}
1774		2204
1775	sub DESTROY {	2205	sub DESTROY {
1776	my ($self) = @_;	2206	my ($self) = @_;
1777		2207
…		…
1782	=back	2212	=back
1783		2213
1784	=cut	2214	=cut
1785		2215
1786	package urxvt::watcher;	2216	package urxvt::watcher;
1787
1788	@urxvt::timer::ISA = __PACKAGE__;
1789	@urxvt::iow::ISA = __PACKAGE__;
1790	@urxvt::pw::ISA = __PACKAGE__;
1791	@urxvt::iw::ISA = __PACKAGE__;
1792		2217
1793	=head2 The C<urxvt::timer> Class	2218	=head2 The C<urxvt::timer> Class
1794		2219
1795	This class implements timer watchers/events. Time is represented as a	2220	This class implements timer watchers/events. Time is represented as a
1796	fractional number of seconds since the epoch. Example:	2221	fractional number of seconds since the epoch. Example:
…		…
1800	->new	2225	->new
1801	->interval (1)	2226	->interval (1)
1802	->cb (sub {	2227	->cb (sub {
1803	$term->{overlay}->set (0, 0,	2228	$term->{overlay}->set (0, 0,
1804	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2229	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1805	});	2230	});
1806		2231
1807	=over 4	2232	=over 4
1808		2233
1809	=item $timer = new urxvt::timer	2234	=item $timer = new urxvt::timer
1810		2235
…		…
1813		2238
1814	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2239	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1815		2240
1816	Set the callback to be called when the timer triggers.	2241	Set the callback to be called when the timer triggers.
1817		2242
1818	=item $tstamp = $timer->at
1819
1820	Return the time this watcher will fire next.
1821
1822	=item $timer = $timer->set ($tstamp)	2243	=item $timer = $timer->set ($tstamp[, $interval])
1823		2244
1824	Set the time the event is generated to $tstamp.	2245	Set the time the event is generated to $tstamp (and optionally specifies a
		2246	new $interval).
1825		2247
1826	=item $timer = $timer->interval ($interval)	2248	=item $timer = $timer->interval ($interval)
1827		2249
1828	Normally (and when C<$interval> is C<0>), the timer will automatically	2250	By default (and when C<$interval> is C<0>), the timer will automatically
1829	stop after it has fired once. If C<$interval> is non-zero, then the timer	2251	stop after it has fired once. If C<$interval> is non-zero, then the timer
1830	is automatically rescheduled at the given intervals.	2252	is automatically rescheduled at the given intervals.
1831		2253
1832	=item $timer = $timer->start	2254	=item $timer = $timer->start
1833		2255
1834	Start the timer.	2256	Start the timer.
1835		2257
1836	=item $timer = $timer->start ($tstamp)	2258	=item $timer = $timer->start ($tstamp[, $interval])
1837		2259
1838	Set the event trigger time to C<$tstamp> and start the timer.	2260	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2261	also replaces the interval.
1839		2262
1840	=item $timer = $timer->after ($delay)	2263	=item $timer = $timer->after ($delay[, $interval])
1841		2264
1842	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2265	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1843		2266
1844	=item $timer = $timer->stop	2267	=item $timer = $timer->stop
1845		2268
…		…
1853		2276
1854	$term->{socket} = ...	2277	$term->{socket} = ...
1855	$term->{iow} = urxvt::iow	2278	$term->{iow} = urxvt::iow
1856	->new	2279	->new
1857	->fd (fileno $term->{socket})	2280	->fd (fileno $term->{socket})
1858	->events (urxvt::EVENT_READ)	2281	->events (urxvt::EV_READ)
1859	->start	2282	->start
1860	->cb (sub {	2283	->cb (sub {
1861	my ($iow, $revents) = @_;	2284	my ($iow, $revents) = @_;
1862	# $revents must be 1 here, no need to check	2285	# $revents must be 1 here, no need to check
1863	sysread $term->{socket}, my $buf, 8192	2286	sysread $term->{socket}, my $buf, 8192
…		…
1876	Set the callback to be called when io events are triggered. C<$reventmask>	2299	Set the callback to be called when io events are triggered. C<$reventmask>
1877	is a bitset as described in the C<events> method.	2300	is a bitset as described in the C<events> method.
1878		2301
1879	=item $iow = $iow->fd ($fd)	2302	=item $iow = $iow->fd ($fd)
1880		2303
1881	Set the filedescriptor (not handle) to watch.	2304	Set the file descriptor (not handle) to watch.
1882		2305
1883	=item $iow = $iow->events ($eventmask)	2306	=item $iow = $iow->events ($eventmask)
1884		2307
1885	Set the event mask to watch. The only allowed values are	2308	Set the event mask to watch. The only allowed values are
1886	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2309	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1887	together, or C<urxvt::EVENT_NONE>.	2310	together, or C<urxvt::EV_NONE>.
1888		2311
1889	=item $iow = $iow->start	2312	=item $iow = $iow->start
1890		2313
1891	Start watching for requested events on the given handle.	2314	Start watching for requested events on the given handle.
1892		2315
1893	=item $iow = $iow->stop	2316	=item $iow = $iow->stop
1894		2317
1895	Stop watching for events on the given filehandle.	2318	Stop watching for events on the given file handle.
1896		2319
1897	=back	2320	=back
1898		2321
1899	=head2 The C<urxvt::iw> Class	2322	=head2 The C<urxvt::iw> Class
1900		2323
…		…
1933	->new	2356	->new
1934	->start ($pid)	2357	->start ($pid)
1935	->cb (sub {	2358	->cb (sub {
1936	my ($pw, $exit_status) = @_;	2359	my ($pw, $exit_status) = @_;
1937	...	2360	...
1938	});	2361	});
1939		2362
1940	=over 4	2363	=over 4
1941		2364
1942	=item $pw = new urxvt::pw	2365	=item $pw = new urxvt::pw
1943		2366
…		…
1947		2370
1948	Set the callback to be called when the timer triggers.	2371	Set the callback to be called when the timer triggers.
1949		2372
1950	=item $pw = $timer->start ($pid)	2373	=item $pw = $timer->start ($pid)
1951		2374
1952	Tells the wqtcher to start watching for process C<$pid>.	2375	Tells the watcher to start watching for process C<$pid>.
1953		2376
1954	=item $pw = $pw->stop	2377	=item $pw = $pw->stop
1955		2378
1956	Stop the watcher.	2379	Stop the watcher.
1957		2380
…		…
1970		2393
1971	=item >= 3 - script loading and management	2394	=item >= 3 - script loading and management
1972		2395
1973	=item >=10 - all called hooks	2396	=item >=10 - all called hooks
1974		2397
1975	=item >=11 - hook reutrn values	2398	=item >=11 - hook return values
1976		2399
1977	=back	2400	=back
1978		2401
1979	=head1 AUTHOR	2402	=head1 AUTHOR
1980		2403
1981	Marc Lehmann <pcg@goof.com>	2404	Marc Lehmann <schmorp@schmorp.de>
1982	http://software.schmorp.de/pkg/rxvt-unicode	2405	http://software.schmorp.de/pkg/rxvt-unicode
1983		2406
1984	=cut	2407	=cut
1985		2408
1986	1	2409	1
		2410
		2411	# vim: sw=3:

Diff Legend

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