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.89 by root, Thu Jan 12 12:10:06 2006 UTC vs.
Revision 1.180 by root, Sat Dec 26 09:42:16 2009 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
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
58	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
59	...	66	...
60		67
61	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
62	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
63	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
64	between two vertical bars:	71	between two vertical bars:
65		72
66	URxvt.selection.pattern-0: \\|([^|]+)\\|	73	URxvt.selection.pattern-0: \\|([^|]+)\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
67		81
68	You can look at the source of the selection extension to see more	82	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
70		84
71	This extension also offers the following bindable keyboard command:	85	This extension also offers following bindable keyboard commands:
72		86
73	=over 4	87	=over 4
74		88
75	=item rot13	89	=item rot13
76		90
…		…
83	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
84		98
85	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
86	runtime.	100	runtime.
87		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
88	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
89		120
90	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
91	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
		124
		125	Other extensions can extend this popup menu by pushing a code reference
		126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
		128
		129	Its sole argument is the popup menu, which can be modified. The selection
		130	is in C<$_>, which can be used to decide whether to add something or not.
		131	It should either return nothing or a string and a code reference. The
		132	string will be used as button text and the code reference will be called
		133	when the button gets activated and should transform C<$_>.
		134
		135	The following will add an entry C<a to b> that transforms all C<a>s in
		136	the selection to C<b>s, but only if the selection currently contains any
		137	C<a>s:
		138
		139	push @{ $self->{term}{selection_popup_hook} }, sub {
		140	/a/ ? ("a to b" => sub { s/a/b/g }
		141	: ()
		142	};
93		143
94	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
95		145
96	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
102	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>
103	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
104	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
105	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
106	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
107	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.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
108		189
109	=item selection-autotransform	190	=item selection-autotransform
110		191
111	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	193	whenever a selection is made.
…		…
120		201
121	For example, the following will transform selections of the form	202	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename	203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:	204	$word>:
124		205
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		207
127	And this example matches the same,but replaces it with vi-commands you can	208	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:	209	paste directly into your (vi :) editor:
129		210
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		212
132	=item mark-urls	213	Of course, this can be modified to suit your needs and your editor :)
133		214
		215	To expand the example above to typical perl error messages ("XXX at
		216	FILENAME line YYY."), you need a slightly more elaborate solution:
		217
		218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		220
		221	The first line tells the selection code to treat the unchanging part of
		222	every error message as a selection pattern, and the second line transforms
		223	the message into vi commands to load the file.
		224
		225	=item tabbed
		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		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):
		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
134	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
135	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
136	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
137	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 from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
138		313
139	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
140		315
141	A not very useful example of filtering all text output to the terminal,	316	A not very useful example of filtering all text output to the terminal
142	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
143	similar-looking ascii character.	318	similar-looking ascii character.
144		319
145	=item digital-clock	320	=item digital-clock
146		321
147	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
		323
		324	=item remote-clipboard
		325
		326	Somewhat of a misnomer, this extension adds two menu entries to the
		327	selection popup that allows one to run external commands to store the
		328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		343
		344	=item selection-pastebin
		345
		346	This is a little rarely useful extension that Uploads the selection as
		347	textfile to a remote site (or does other things). (The implementation is
		348	not currently secure for use in a multiuser environment as it writes to
		349	F</tmp> directly.).
		350
		351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		352	i.e.
		353
		354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		355
		356	Pressing this combination runs a command with C<%> replaced by the name of
		357	the textfile. This command can be set via a resource:
		358
		359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		360
		361	And the default is likely not useful to anybody but the few people around
		362	here :)
		363
		364	The name of the textfile is the hex encoded md5 sum of the selection, so
		365	the same content should lead to the same filename.
		366
		367	After a successful upload the selection will be replaced by the text given
		368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		369	for the filename):
		370
		371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of wether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-pastebin and macosx-pastebin-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<maxosx-pastebin> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
148		391
149	=item example-refresh-hooks	392	=item example-refresh-hooks
150		393
151	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
152	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
192		435
193	=back	436	=back
194		437
195	=head2 Extension Objects	438	=head2 Extension Objects
196		439
197	Very perl extension is a perl class. A separate perl object is created	440	Every perl extension is a perl class. A separate perl object is created
198	for each terminal and each extension and passed as the first parameter to	441	for each terminal, and each terminal has its own set of extenion objects,
199	hooks. So extensions can use their C<$self> object without having to think	442	which are passed as the first parameter to hooks. So extensions can use
200	about other extensions, with the exception of methods and members that	443	their C<$self> object without having to think about clashes with other
		444	extensions or other terminals, with the exception of methods and members
201	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
202	use.	446	internal use.
203		447
204	Although it isn't a C<urxvt::term> object, you can call all methods of the	448	Although it isn't a C<urxvt::term> object, you can call all methods of the
205	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
206		450
207	It has the following methods and data members:	451	It has the following methods and data members:
…		…
228	=head2 Hooks	472	=head2 Hooks
229		473
230	The following subroutines can be declared in extension files, and will be	474	The following subroutines can be declared in extension files, and will be
231	called whenever the relevant event happens.	475	called whenever the relevant event happens.
232		476
233	The first argument passed to them is an extension oject as described in	477	The first argument passed to them is an extension object as described in
234	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
235		479
236	B<All> of these hooks must return a boolean value. If it is true, then the	480	B<All> of these hooks must return a boolean value. If any of the called
237	event counts as being I<consumed>, and the invocation of other hooks is	481	hooks returns true, then the event counts as being I<consumed>, and the
238	skipped, and the relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
239		483
240	I<< When in doubt, return a false value (preferably C<()>). >>	484	I<< When in doubt, return a false value (preferably C<()>). >>
241		485
242	=over 4	486	=over 4
243		487
244	=item on_init $term	488	=item on_init $term
245		489
246	Called after a new terminal object has been initialized, but before	490	Called after a new terminal object has been initialized, but before
247	windows are created or the command gets run. Most methods are unsafe to	491	windows are created or the command gets run. Most methods are unsafe to
248	call or deliver senseless data, as terminal size and other characteristics	492	call or deliver senseless data, as terminal size and other characteristics
249	have not yet been determined. You can safely query and change resources,	493	have not yet been determined. You can safely query and change resources
250	though.	494	and options, though. For many purposes the C<on_start> hook is a better
		495	place.
		496
		497	=item on_start $term
		498
		499	Called at the very end of initialisation of a new terminal, just before
		500	trying to map (display) the toplevel and returning to the main loop.
		501
		502	=item on_destroy $term
		503
		504	Called whenever something tries to destroy terminal, when the terminal is
		505	still fully functional (not for long, though).
251		506
252	=item on_reset $term	507	=item on_reset $term
253		508
254	Called after the screen is "reset" for any reason, such as resizing or	509	Called after the screen is "reset" for any reason, such as resizing or
255	control sequences. Here is where you can react on changes to size-related	510	control sequences. Here is where you can react on changes to size-related
256	variables.	511	variables.
257		512
258	=item on_start $term	513	=item on_child_start $term, $pid
259		514
260	Called at the very end of initialisation of a new terminal, just before	515	Called just after the child process has been C<fork>ed.
261	returning to the mainloop.	516
		517	=item on_child_exit $term, $status
		518
		519	Called just after the child process has exited. C<$status> is the status
		520	from C<waitpid>.
262		521
263	=item on_sel_make $term, $eventtime	522	=item on_sel_make $term, $eventtime
264		523
265	Called whenever a selection has been made by the user, but before the	524	Called whenever a selection has been made by the user, but before the
266	selection text is copied, so changes to the beginning, end or type of the	525	selection text is copied, so changes to the beginning, end or type of the
…		…
273		532
274	Called whenever a selection has been copied, but before the selection is	533	Called whenever a selection has been copied, but before the selection is
275	requested from the server. The selection text can be queried and changed	534	requested from the server. The selection text can be queried and changed
276	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
277		536
278	Returning a true value aborts selection grabbing. It will still be hilighted.	537	Returning a true value aborts selection grabbing. It will still be highlighted.
279		538
280	=item on_sel_extend $term	539	=item on_sel_extend $term
281		540
282	Called whenever the user tries to extend the selection (e.g. with a double	541	Called whenever the user tries to extend the selection (e.g. with a double
283	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
284	should extend the selection itelf and return true to suppress the built-in	543	should extend the selection itself and return true to suppress the built-in
285	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
286	returns true, it will be called on every further click by the user and is	545	returns true, it will be called on every further click by the user and is
287	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
288		547
289	See the F<selection> example extension.	548	See the F<selection> example extension.
290		549
291	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
292		551
293	Called whenever the view offset changes, i..e the user or program	552	Called whenever the view offset changes, i.e. the user or program
294	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
295	show this many lines of scrollback.	554	show this many lines of scrollback.
296		555
297	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
298		557
…		…
302		561
303	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
304	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	563	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
305	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
306		565
307	=item on_osc_seq $term, $string	566	=item on_osc_seq $term, $op, $args, $resp
		567
		568	Called on every OSC sequence and can be used to suppress it or modify its
		569	behaviour. The default should be to return an empty list. A true value
		570	suppresses execution of the request completely. Make sure you don't get
		571	confused by recursive invocations when you output an OSC sequence within
		572	this callback.
		573
		574	C<on_osc_seq_perl> should be used for new behaviour.
		575
		576	=item on_osc_seq_perl $term, $args, $resp
308		577
309	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
310	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
311	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
312	string should start with the extension name and a colon, to distinguish	581	string should start with the extension name (sans -osc) and a semicolon,
313	it from commands for other extensions, and this might be enforced in the	582	to distinguish it from commands for other extensions, and this might be
314	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
315		594
316	Be careful not ever to trust (in a security sense) the data you receive,	595	Be careful not ever to trust (in a security sense) the data you receive,
317	as its source can not easily be controleld (e-mail content, messages from	596	as its source can not easily be controlled (e-mail content, messages from
318	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
319		601
320	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
321		603
322	Called whenever text is about to be output, with the text as argument. You	604	Called whenever text is about to be output, with the text as argument. You
323	can filter/change and output the text yourself by returning a true value	605	can filter/change and output the text yourself by returning a true value
…		…
344	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
345	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
346		628
347	=item on_refresh_begin $term	629	=item on_refresh_begin $term
348		630
349	Called just before the screen gets redrawn. Can be used for overlay	631	Called just before the screen gets redrawn. Can be used for overlay or
350	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
351	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
352	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
353		635
354	=item on_refresh_end $term	636	=item on_refresh_end $term
355		637
356	Called just after the screen gets redrawn. See C<on_refresh_begin>.	638	Called just after the screen gets redrawn. See C<on_refresh_begin>.
357		639
358	=item on_keyboard_command $term, $string	640	=item on_user_command $term, $string
359		641
360	Called whenever the user presses a key combination that has a	642	Called whenever a user-configured event is being activated (e.g. via
361	C<perl:string> action bound to it (see description of the B<keysym>	643	a C<perl:string> action bound to a key, see description of the B<keysym>
362	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
		645
		646	The event is simply the action string. This interface is assumed to change
		647	slightly in the future.
		648
		649	=item on_resize_all_windows $tern, $new_width, $new_height
		650
		651	Called just after the new window size has been calculated, but before
		652	windows are actually being resized or hints are being set. If this hook
		653	returns TRUE, setting of the window hints is being skipped.
		654
		655	=item on_x_event $term, $event
		656
		657	Called on every X event received on the vt window (and possibly other
		658	windows). Should only be used as a last resort. Most event structure
		659	members are not passed.
		660
		661	=item on_root_event $term, $event
		662
		663	Like C<on_x_event>, but is called for events on the root window.
363		664
364	=item on_focus_in $term	665	=item on_focus_in $term
365		666
366	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
367	does focus in processing.	668	does focus in processing.
368		669
369	=item on_focus_out $term	670	=item on_focus_out $term
370		671
371	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
372	focus out processing.	673	focus out processing.
		674
		675	=item on_configure_notify $term, $event
		676
		677	=item on_property_notify $term, $event
373		678
374	=item on_key_press $term, $event, $keysym, $octets	679	=item on_key_press $term, $event, $keysym, $octets
375		680
376	=item on_key_release $term, $event, $keysym	681	=item on_key_release $term, $event, $keysym
377		682
…		…
387		692
388	Called whenever the corresponding X event is received for the terminal If	693	Called whenever the corresponding X event is received for the terminal If
389	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the even will be ignored by rxvt-unicode.
390		695
391	The event is a hash with most values as named by Xlib (see the XEvent	696	The event is a hash with most values as named by Xlib (see the XEvent
392	manpage), with the additional members C<row> and C<col>, which are the row	697	manpage), with the additional members C<row> and C<col>, which are the
393	and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
394		699
395	C<on_key_press> additionally receives the string rxvt-unicode would	700	C<on_key_press> additionally receives the string rxvt-unicode would
396	output, if any, in locale-specific encoding.	701	output, if any, in locale-specific encoding.
397		702
398	subwindow.	703	subwindow.
		704
		705	=item on_client_message $term, $event
		706
		707	=item on_wm_protocols $term, $event
		708
		709	=item on_wm_delete_window $term, $event
		710
		711	Called when various types of ClientMessage events are received (all with
		712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
399		713
400	=back	714	=back
401		715
402	=cut	716	=cut
403		717
…		…
409	use Scalar::Util ();	723	use Scalar::Util ();
410	use List::Util ();	724	use List::Util ();
411		725
412	our $VERSION = 1;	726	our $VERSION = 1;
413	our $TERM;	727	our $TERM;
		728	our @TERM_INIT;
		729	our @TERM_EXT;
414	our @HOOKNAME;	730	our @HOOKNAME;
415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	731	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
416	our %OPTION;	732	our %OPTION;
417		733
418	our $LIBDIR;	734	our $LIBDIR;
419	our $RESNAME;	735	our $RESNAME;
420	our $RESCLASS;	736	our $RESCLASS;
421	our $RXVTNAME;	737	our $RXVTNAME;
422		738
		739	our $NOCHAR = chr 0xffff;
		740
423	=head2 Variables in the C<urxvt> Package	741	=head2 Variables in the C<urxvt> Package
424		742
425	=over 4	743	=over 4
426		744
427	=item $urxvt::LIBDIR	745	=item $urxvt::LIBDIR
…		…
439		757
440	=item $urxvt::TERM	758	=item $urxvt::TERM
441		759
442	The current terminal. This variable stores the current C<urxvt::term>	760	The current terminal. This variable stores the current C<urxvt::term>
443	object, whenever a callback/hook is executing.	761	object, whenever a callback/hook is executing.
		762
		763	=item @urxvt::TERM_INIT
		764
		765	All code references in this array will be called as methods of the next newly
		766	created C<urxvt::term> object (during the C<on_init> phase). The array
		767	gets cleared before the code references that were in it are being executed,
		768	so references can push themselves onto it again if they so desire.
		769
		770	This complements to the perl-eval command line option, but gets executed
		771	first.
		772
		773	=item @urxvt::TERM_EXT
		774
		775	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		776	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		777	but before other extensions. Gets cleared just like C<@TERM_INIT>.
444		778
445	=back	779	=back
446		780
447	=head2 Functions in the C<urxvt> Package	781	=head2 Functions in the C<urxvt> Package
448		782
…		…
463	Using this function has the advantage that its output ends up in the	797	Using this function has the advantage that its output ends up in the
464	correct place, e.g. on stderr of the connecting urxvtc client.	798	correct place, e.g. on stderr of the connecting urxvtc client.
465		799
466	Messages have a size limit of 1023 bytes currently.	800	Messages have a size limit of 1023 bytes currently.
467		801
468	=item $is_safe = urxvt::safe	802	=item @terms = urxvt::termlist
469		803
470	Returns true when it is safe to do potentially unsafe things, such as	804	Returns all urxvt::term objects that exist in this process, regardless of
471	evaluating perl code specified by the user. This is true when urxvt was	805	whether they are started, being destroyed etc., so be careful. Only term
472	started setuid or setgid.	806	objects that have perl extensions attached will be returned (because there
		807	is no urxvt::term objet associated with others).
473		808
474	=item $time = urxvt::NOW	809	=item $time = urxvt::NOW
475		810
476	Returns the "current time" (as per the event loop).	811	Returns the "current time" (as per the event loop).
477		812
478	=item urxvt::CurrentTime	813	=item urxvt::CurrentTime
479		814
480	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	815	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
481	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	816	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
482	Button4Mask, Button5Mask, AnyModifier	817	Button4Mask, Button5Mask, AnyModifier
		818
		819	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		820	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		821	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		822	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		823	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		824	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		825	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		826
		827	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		828	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		829	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		830	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		831	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		832	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		833	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
483		834
484	Various constants for use in X calls and event processing.	835	Various constants for use in X calls and event processing.
485		836
486	=back	837	=back
487		838
…		…
520		871
521	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	872	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
522		873
523	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	874	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
524		875
		876	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		877
525	Replace the foreground/background colour in the rendition mask with the	878	Replace the foreground/background colour in the rendition mask with the
526	specified one.	879	specified one.
527		880
528	=item $value = urxvt::GET_CUSTOM $rend	881	=item $value = urxvt::GET_CUSTOM $rend
529		882
…		…
538	=back	891	=back
539		892
540	=cut	893	=cut
541		894
542	BEGIN {	895	BEGIN {
543	urxvt->bootstrap;
544
545	# overwrite perl's warn	896	# overwrite perl's warn
546	*CORE::GLOBAL::warn = sub {	897	*CORE::GLOBAL::warn = sub {
547	my $msg = join "", @_;	898	my $msg = join "", @_;
548	$msg .= "\n"	899	$msg .= "\n"
549	unless $msg =~ /\n$/;	900	unless $msg =~ /\n$/;
550	urxvt::warn ($msg);	901	urxvt::warn ($msg);
551	};	902	};
552
553	# %ENV is the original startup environment
554	delete $ENV{IFS};
555	delete $ENV{CDPATH};
556	delete $ENV{BASH_ENV};
557	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
558	}	903	}
559		904
560	my @hook_count;	905	no warnings 'utf8';
		906
561	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	907	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
562		908
563	sub verbose {	909	sub verbose {
564	my ($level, $msg) = @_;	910	my ($level, $msg) = @_;
565	warn "$msg\n" if $level <= $verbosity;	911	warn "$msg\n" if $level <= $verbosity;
566	}	912	}
567		913
568	my $extension_pkg = "extension0000";
569	my %extension_pkg;	914	my %extension_pkg;
570		915
571	# load a single script into its own package, once only	916	# load a single script into its own package, once only
572	sub extension_package($) {	917	sub extension_package($) {
573	my ($path) = @_;	918	my ($path) = @_;
574		919
575	$extension_pkg{$path} ||= do {	920	$extension_pkg{$path} ||= do {
576	my $pkg = "urxvt::" . ($extension_pkg++);	921	$path =~ /([^\/\\]+)$/;
		922	my $pkg = $1;
		923	$pkg =~ s/[^[:word:]]/_/g;
		924	$pkg = "urxvt::ext::$pkg";
577		925
578	verbose 3, "loading extension '$path' into package '$pkg'";	926	verbose 3, "loading extension '$path' into package '$pkg'";
579		927
580	open my $fh, "<:raw", $path	928	open my $fh, "<:raw", $path
581	or die "$path: $!";	929	or die "$path: $!";
582		930
583	my $source = untaint	931	my $source =
584	"package $pkg; use strict; use utf8;\n"	932	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
585	. "use base urxvt::term::extension::;\n"
586	. "#line 1 \"$path\"\n{\n"	933	. "#line 1 \"$path\"\n{\n"
587	. (do { local $/; <$fh> })	934	. (do { local $/; <$fh> })
588	. "\n};\n1";	935	. "\n};\n1";
589		936
590	eval $source	937	eval $source
…		…
601	local $TERM = shift;	948	local $TERM = shift;
602	my $htype = shift;	949	my $htype = shift;
603		950
604	if ($htype == 0) { # INIT	951	if ($htype == 0) { # INIT
605	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
606		953
607	my %ext_arg;	954	my %ext_arg;
608		955
		956	{
		957	my @init = @TERM_INIT;
		958	@TERM_INIT = ();
		959	$_->($TERM) for @init;
		960	my @pkg = @TERM_EXT;
		961	@TERM_EXT = ();
		962	$TERM->register_package ($_) for @pkg;
		963	}
		964
609	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	965	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
610	if ($_ eq "default") {	966	if ($_ eq "default") {
611	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	967	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
612	} elsif (/^-(.*)$/) {	968	} elsif (/^-(.*)$/) {
613	delete $ext_arg{$1};	969	delete $ext_arg{$1};
614	} elsif (/^([^<]+)<(.*)>$/) {	970	} elsif (/^([^<]+)<(.*)>$/) {
615	push @{ $ext_arg{$1} }, $2;	971	push @{ $ext_arg{$1} }, $2;
616	} else {	972	} else {
617	$ext_arg{$_} ||= [];	973	$ext_arg{$_} ||= [];
618	}	974	}
619	}	975	}
620		976
621	while (my ($ext, $argv) = each %ext_arg) {	977	for my $ext (sort keys %ext_arg) {
622	my @files = grep -f $_, map "$_/$ext", @dirs;	978	my @files = grep -f $_, map "$_/$ext", @dirs;
623		979
624	if (@files) {	980	if (@files) {
625	$TERM->register_package (extension_package $files[0], $argv);	981	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
626	} else {	982	} else {
627	warn "perl extension '$ext' not found in perl library search path\n";	983	warn "perl extension '$ext' not found in perl library search path\n";
628	}	984	}
629	}	985	}
630		986
…		…
636		992
637	if (my $cb = $TERM->{_hook}[$htype]) {	993	if (my $cb = $TERM->{_hook}[$htype]) {
638	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	994	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
639	if $verbosity >= 10;	995	if $verbosity >= 10;
640		996
641	keys %$cb;	997	for my $pkg (keys %$cb) {
642
643	while (my ($pkg, $cb) = each %$cb) {
644	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	998	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
645	and last;	999	$retval ||= $retval_;
646		1000
647	if ($@) {	1001	if ($@) {
648	$TERM->ungrab; # better to lose the grab than the session	1002	$TERM->ungrab; # better to lose the grab than the session
649	warn $@;	1003	warn $@;
650	}	1004	}
…		…
653	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	1007	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
654	if $verbosity >= 11;	1008	if $verbosity >= 11;
655	}	1009	}
656		1010
657	if ($htype == 1) { # DESTROY	1011	if ($htype == 1) { # DESTROY
658	if (my $hook = delete $TERM->{_hook}) {
659	for my $htype (0..$#$hook) {
660	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
661	or set_should_invoke $htype, 0;
662	}
663	}
664
665	# clear package objects	1012	# clear package objects
666	%$_ = () for values %{ $TERM->{_pkg} };	1013	%$_ = () for values %{ $TERM->{_pkg} };
667		1014
668	# clear package	1015	# clear package
669	%$TERM = ();	1016	%$TERM = ();
670	}	1017	}
671		1018
672	$retval	1019	$retval
673	}	1020	}
674		1021
675	sub exec_async(@) {	1022	sub SET_COLOR($$$) {
676	my $pid = fork;	1023	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1024	}
677		1025
678	return	1026	sub rend2mask {
679	if !defined $pid or $pid;	1027	no strict 'refs';
680		1028	my ($str, $mask) = (@_, 0);
681	%ENV = %{ $TERM->env };	1029	my %color = ( fg => undef, bg => undef );
682		1030	my @failed;
683	exec @_;	1031	for my $spec ( split /\s+/, $str ) {
684	_exit 255;	1032	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1033	$color{lc($1)} = $2;
		1034	} else {
		1035	my $neg = $spec =~ s/^[-^]//;
		1036	unless ( exists &{"RS_$spec"} ) {
		1037	push @failed, $spec;
		1038	next;
		1039	}
		1040	my $cur = &{"RS_$spec"};
		1041	if ( $neg ) {
		1042	$mask &= ~$cur;
		1043	} else {
		1044	$mask |= $cur;
		1045	}
		1046	}
		1047	}
		1048	($mask, @color{qw(fg bg)}, \@failed)
685	}	1049	}
686		1050
687	# urxvt::term::extension	1051	# urxvt::term::extension
688		1052
689	package urxvt::term::extension;	1053	package urxvt::term::extension;
…		…
695	while (my ($name, $cb) = each %hook) {	1059	while (my ($name, $cb) = each %hook) {
696	my $htype = $HOOKTYPE{uc $name};	1060	my $htype = $HOOKTYPE{uc $name};
697	defined $htype	1061	defined $htype
698	or Carp::croak "unsupported hook type '$name'";	1062	or Carp::croak "unsupported hook type '$name'";
699		1063
		1064	$self->set_should_invoke ($htype, +1)
700	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1065	unless exists $self->{term}{_hook}[$htype]{$pkg};
701	$hook_count[$htype]++
702	or urxvt::set_should_invoke $htype, 1;
703	}
704		1066
705	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1067	$self->{term}{_hook}[$htype]{$pkg} = $cb;
706	}	1068	}
707	}	1069	}
708		1070
…		…
713	for my $name (@hook) {	1075	for my $name (@hook) {
714	my $htype = $HOOKTYPE{uc $name};	1076	my $htype = $HOOKTYPE{uc $name};
715	defined $htype	1077	defined $htype
716	or Carp::croak "unsupported hook type '$name'";	1078	or Carp::croak "unsupported hook type '$name'";
717		1079
		1080	$self->set_should_invoke ($htype, -1)
718	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1081	if delete $self->{term}{_hook}[$htype]{$pkg};
719	--$hook_count[$htype]
720	or urxvt::set_should_invoke $htype, 0;
721	}
722	}	1082	}
723	}	1083	}
724		1084
725	our $AUTOLOAD;	1085	our $AUTOLOAD;
726		1086
…		…
764	is that you cannot use blocking APIs, but the non-blocking variant should	1124	is that you cannot use blocking APIs, but the non-blocking variant should
765	work.	1125	work.
766		1126
767	=cut	1127	=cut
768		1128
769	our $VERSION = 1;	1129	our $VERSION = '5.23';
770		1130
771	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1131	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
772	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1132	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
773		1133
774	sub timer {	1134	sub timer {
…		…
776		1136
777	my $cb = $arg{cb};	1137	my $cb = $arg{cb};
778		1138
779	urxvt::timer	1139	urxvt::timer
780	->new	1140	->new
781	->start (urxvt::NOW + $arg{after})	1141	->after ($arg{after}, $arg{interval})
782	->cb (sub {	1142	->cb ($arg{interval} ? $cb : sub {
783	$_[0]->stop; # need to cancel manually	1143	$_[0]->stop; # need to cancel manually
784	$cb->();	1144	$cb->();
785	})	1145	})
786	}	1146	}
787		1147
788	sub io {	1148	sub io {
789	my ($class, %arg) = @_;	1149	my ($class, %arg) = @_;
790		1150
791	my $cb = $arg{cb};	1151	my $cb = $arg{cb};
		1152	my $fd = fileno $arg{fh};
		1153	defined $fd or $fd = $arg{fh};
792		1154
793	bless [$arg{fh}, urxvt::iow	1155	bless [$arg{fh}, urxvt::iow
794	->new	1156	->new
795	->fd (fileno $arg{fh})	1157	->fd ($fd)
796	->events (($arg{poll} =~ /r/ ? 1 : 0)	1158	->events (($arg{poll} =~ /r/ ? 1 : 0)
797	| ($arg{poll} =~ /w/ ? 2 : 0))	1159	| ($arg{poll} =~ /w/ ? 2 : 0))
798	->start	1160	->start
799	->cb (sub {	1161	->cb ($cb)
800	$cb->(($_[1] & 1 ? 'r' : '')
801	. ($_[1] & 2 ? 'w' : ''));
802	})],
803	urxvt::anyevent::	1162	], urxvt::anyevent::
		1163	}
		1164
		1165	sub idle {
		1166	my ($class, %arg) = @_;
		1167
		1168	my $cb = $arg{cb};
		1169
		1170	urxvt::iw
		1171	->new
		1172	->start
		1173	->cb ($cb)
		1174	}
		1175
		1176	sub child {
		1177	my ($class, %arg) = @_;
		1178
		1179	my $cb = $arg{cb};
		1180
		1181	urxvt::pw
		1182	->new
		1183	->start ($arg{pid})
		1184	->cb (sub {
		1185	$_[0]->stop; # need to cancel manually
		1186	$cb->($_[0]->rpid, $_[0]->rstatus);
		1187	})
804	}	1188	}
805		1189
806	sub DESTROY {	1190	sub DESTROY {
807	$_[0][1]->stop;	1191	$_[0][1]->stop;
808	}	1192	}
809		1193
810	sub condvar {	1194	sub one_event {
811	bless \my $flag, urxvt::anyevent::condvar::
812	}
813
814	sub urxvt::anyevent::condvar::broadcast {
815	${$_[0]}++;
816	}
817
818	sub urxvt::anyevent::condvar::wait {
819	unless (${$_[0]}) {
820	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1195	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
821	}
822	}	1196	}
823		1197
824	package urxvt::term;	1198	package urxvt::term;
825		1199
826	=head2 The C<urxvt::term> Class	1200	=head2 The C<urxvt::term> Class
…		…
831		1205
832	# find on_xxx subs in the package and register them	1206	# find on_xxx subs in the package and register them
833	# as hooks	1207	# as hooks
834	sub register_package {	1208	sub register_package {
835	my ($self, $pkg, $argv) = @_;	1209	my ($self, $pkg, $argv) = @_;
		1210
		1211	no strict 'refs';
		1212
		1213	urxvt::verbose 6, "register package $pkg to $self";
		1214
		1215	@{"$pkg\::ISA"} = urxvt::term::extension::;
836		1216
837	my $proxy = bless {	1217	my $proxy = bless {
838	_pkg => $pkg,	1218	_pkg => $pkg,
839	argv => $argv,	1219	argv => $argv,
840	}, $pkg;	1220	}, $pkg;
…		…
856	hash which defines the environment of the new terminal.	1236	hash which defines the environment of the new terminal.
857		1237
858	Croaks (and probably outputs an error message) if the new instance	1238	Croaks (and probably outputs an error message) if the new instance
859	couldn't be created. Returns C<undef> if the new instance didn't	1239	couldn't be created. Returns C<undef> if the new instance didn't
860	initialise perl, and the terminal object otherwise. The C<init> and	1240	initialise perl, and the terminal object otherwise. The C<init> and
861	C<start> hooks will be called during this call.	1241	C<start> hooks will be called before this call returns, and are free to
		1242	refer to global data (which is race free).
862		1243
863	=cut	1244	=cut
864		1245
865	sub new {	1246	sub new {
866	my ($class, $env, @args) = @_;	1247	my ($class, $env, @args) = @_;
867		1248
		1249	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1250	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1251
868	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1252	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
869	}	1253	}
870		1254
871	=item $term->destroy	1255	=item $term->destroy
872		1256
873	Destroy the terminal object (close the window, free resources	1257	Destroy the terminal object (close the window, free resources
874	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1258	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
875	watchers (timers, io watchers) are still active.	1259	watchers (timers, io watchers) are still active.
876		1260
		1261	=item $term->exec_async ($cmd[, @args])
		1262
		1263	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1264	("starts") programs in the background. This function takes care of setting
		1265	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1266	be preferred over explicit calls to C<exec> or C<system>.
		1267
		1268	Returns the pid of the subprocess or C<undef> on error.
		1269
		1270	=cut
		1271
		1272	sub exec_async {
		1273	my $self = shift;
		1274
		1275	my $pid = fork;
		1276
		1277	return $pid
		1278	if !defined $pid or $pid;
		1279
		1280	%ENV = %{ $self->env };
		1281
		1282	exec @_;
		1283	urxvt::_exit 255;
		1284	}
		1285
877	=item $isset = $term->option ($optval[, $set])	1286	=item $isset = $term->option ($optval[, $set])
878		1287
879	Returns true if the option specified by C<$optval> is enabled, and	1288	Returns true if the option specified by C<$optval> is enabled, and
880	optionally change it. All option values are stored by name in the hash	1289	optionally change it. All option values are stored by name in the hash
881	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1290	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
882		1291
883	Here is a a likely non-exhaustive list of option names, please see the	1292	Here is a likely non-exhaustive list of option names, please see the
884	source file F</src/optinc.h> to see the actual list:	1293	source file F</src/optinc.h> to see the actual list:
885		1294
886	borderLess console cursorBlink cursorUnderline hold iconic insecure	1295	borderLess console cursorBlink cursorUnderline hold iconic insecure
887	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1296	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
888	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1297	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
889	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1298	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
890	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1299	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
891	tripleclickwords utmpInhibit visualBell	1300	transparent tripleclickwords utmpInhibit visualBell
892		1301
893	=item $value = $term->resource ($name[, $newval])	1302	=item $value = $term->resource ($name[, $newval])
894		1303
895	Returns the current resource value associated with a given name and	1304	Returns the current resource value associated with a given name and
896	optionally sets a new value. Setting values is most useful in the C<init>	1305	optionally sets a new value. Setting values is most useful in the C<init>
…		…
905	likely change).	1314	likely change).
906		1315
907	Please note that resource strings will currently only be freed when the	1316	Please note that resource strings will currently only be freed when the
908	terminal is destroyed, so changing options frequently will eat memory.	1317	terminal is destroyed, so changing options frequently will eat memory.
909		1318
910	Here is a a likely non-exhaustive list of resource names, not all of which	1319	Here is a likely non-exhaustive list of resource names, not all of which
911	are supported in every build, please see the source file F</src/rsinc.h>	1320	are supported in every build, please see the source file F</src/rsinc.h>
912	to see the actual list:	1321	to see the actual list:
913		1322
914	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1323	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
915	borderLess color cursorBlink cursorUnderline cutchars delete_key	1324	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
916	display_name embed ext_bwidth fade font geometry hold iconName	1325	display_name embed ext_bwidth fade font geometry hold iconName
917	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1326	imFont imLocale inputMethod insecure int_bwidth intensityStyles
918	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1327	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
919	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1328	modifier mouseWheelScrollPage name override_redirect pastableTabs path
920	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1329	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
921	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1330	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
922	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1331	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
923	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1332	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
924	shade term_name title transparent transparent_all tripleclickwords	1333	secondaryScreen secondaryScroll shade term_name title
925	utmpInhibit visualBell	1334	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1335	visualBell
926		1336
927	=cut	1337	=cut
928		1338
929	sub resource($$;$) {	1339	sub resource($$;$) {
930	my ($self, $name) = (shift, shift);	1340	my ($self, $name) = (shift, shift);
931	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1341	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
932	&urxvt::term::_resource	1342	goto &urxvt::term::_resource
933	}	1343	}
934		1344
935	=item $value = $term->x_resource ($pattern)	1345	=item $value = $term->x_resource ($pattern)
936		1346
937	Returns the X-Resource for the given pattern, excluding the program or	1347	Returns the X-Resource for the given pattern, excluding the program or
…		…
962		1372
963	=item ($row, $col) = $term->selection_beg ([$row, $col])	1373	=item ($row, $col) = $term->selection_beg ([$row, $col])
964		1374
965	=item ($row, $col) = $term->selection_end ([$row, $col])	1375	=item ($row, $col) = $term->selection_end ([$row, $col])
966		1376
967	Return the current values of the selection mark, begin or end positions,	1377	Return the current values of the selection mark, begin or end positions.
968	and optionally set them to new values.	1378
		1379	When arguments are given, then the selection coordinates are set to
		1380	C<$row> and C<$col>, and the selection screen is set to the current
		1381	screen.
		1382
		1383	=item $screen = $term->selection_screen ([$screen])
		1384
		1385	Returns the current selection screen, and then optionally sets it.
969		1386
970	=item $term->selection_make ($eventtime[, $rectangular])	1387	=item $term->selection_make ($eventtime[, $rectangular])
971		1388
972	Tries to make a selection as set by C<selection_beg> and	1389	Tries to make a selection as set by C<selection_beg> and
973	C<selection_end>. If C<$rectangular> is true (default: false), a	1390	C<selection_end>. If C<$rectangular> is true (default: false), a
…		…
1020		1437
1021	The methods currently supported on C<urxvt::overlay> objects are:	1438	The methods currently supported on C<urxvt::overlay> objects are:
1022		1439
1023	=over 4	1440	=over 4
1024		1441
1025	=item $overlay->set ($x, $y, $text, $rend)	1442	=item $overlay->set ($x, $y, $text[, $rend])
1026		1443
1027	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1444	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1028	text in rxvt-unicode's special encoding and an array of rendition values	1445	text in rxvt-unicode's special encoding and an array of rendition values
1029	at a specific position inside the overlay.	1446	at a specific position inside the overlay.
		1447
		1448	If C<$rend> is missing, then the rendition will not be changed.
1030		1449
1031	=item $overlay->hide	1450	=item $overlay->hide
1032		1451
1033	If visible, hide the overlay, but do not destroy it.	1452	If visible, hide the overlay, but do not destroy it.
1034		1453
…		…
1104		1523
1105	Normally its not a good idea to use this function, as programs might be	1524	Normally its not a good idea to use this function, as programs might be
1106	confused by changes in cursor position or scrolling. Its useful inside a	1525	confused by changes in cursor position or scrolling. Its useful inside a
1107	C<on_add_lines> hook, though.	1526	C<on_add_lines> hook, though.
1108		1527
		1528	=item $term->scr_change_screen ($screen)
		1529
		1530	Switch to given screen - 0 primary, 1 secondary.
		1531
1109	=item $term->cmd_parse ($octets)	1532	=item $term->cmd_parse ($octets)
1110		1533
1111	Similar to C<scr_add_lines>, but the argument must be in the	1534	Similar to C<scr_add_lines>, but the argument must be in the
1112	locale-specific encoding of the terminal and can contain command sequences	1535	locale-specific encoding of the terminal and can contain command sequences
1113	(escape codes) that will be interpreted.	1536	(escape codes) that will be interpreted.
…		…
1123	Replaces the event mask of the pty watcher by the given event mask. Can	1546	Replaces the event mask of the pty watcher by the given event mask. Can
1124	be used to suppress input and output handling to the pty/tty. See the	1547	be used to suppress input and output handling to the pty/tty. See the
1125	description of C<< urxvt::timer->events >>. Make sure to always restore	1548	description of C<< urxvt::timer->events >>. Make sure to always restore
1126	the previous value.	1549	the previous value.
1127		1550
		1551	=item $fd = $term->pty_fd
		1552
		1553	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1554	is used.
		1555
1128	=item $windowid = $term->parent	1556	=item $windowid = $term->parent
1129		1557
1130	Return the window id of the toplevel window.	1558	Return the window id of the toplevel window.
1131		1559
1132	=item $windowid = $term->vt	1560	=item $windowid = $term->vt
1133		1561
1134	Return the window id of the terminal window.	1562	Return the window id of the terminal window.
1135		1563
		1564	=item $term->vt_emask_add ($x_event_mask)
		1565
		1566	Adds the specified events to the vt event mask. Useful e.g. when you want
		1567	to receive pointer events all the times:
		1568
		1569	$term->vt_emask_add (urxvt::PointerMotionMask);
		1570
		1571	=item $term->focus_in
		1572
		1573	=item $term->focus_out
		1574
		1575	=item $term->key_press ($state, $keycode[, $time])
		1576
		1577	=item $term->key_release ($state, $keycode[, $time])
		1578
		1579	Deliver various fake events to to terminal.
		1580
1136	=item $window_width = $term->width	1581	=item $window_width = $term->width
1137		1582
1138	=item $window_height = $term->height	1583	=item $window_height = $term->height
1139		1584
1140	=item $font_width = $term->fwidth	1585	=item $font_width = $term->fwidth
…		…
1153		1598
1154	=item $max_scrollback = $term->saveLines	1599	=item $max_scrollback = $term->saveLines
1155		1600
1156	=item $nrow_plus_saveLines = $term->total_rows	1601	=item $nrow_plus_saveLines = $term->total_rows
1157		1602
1158	=item $lines_in_scrollback = $term->nsaved	1603	=item $topmost_scrollback_row = $term->top_row
1159		1604
1160	Return various integers describing terminal characteristics.	1605	Return various integers describing terminal characteristics.
1161		1606
1162	=item $x_display = $term->display_id	1607	=item $x_display = $term->display_id
1163		1608
…		…
1170	=item $env = $term->env	1615	=item $env = $term->env
1171		1616
1172	Returns a copy of the environment in effect for the terminal as a hashref	1617	Returns a copy of the environment in effect for the terminal as a hashref
1173	similar to C<\%ENV>.	1618	similar to C<\%ENV>.
1174		1619
		1620	=item @envv = $term->envv
		1621
		1622	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1623
		1624	=item @argv = $term->argv
		1625
		1626	Return the argument vector as this terminal, similar to @ARGV, but
		1627	includes the program name as first element.
		1628
1175	=cut	1629	=cut
1176		1630
1177	sub env {	1631	sub env {
1178	if (my $env = $_[0]->_env) {
1179	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1632	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1180	} else {
1181	+{ %ENV }
1182	}
1183	}	1633	}
1184		1634
1185	=item $modifiermask = $term->ModLevel3Mask	1635	=item $modifiermask = $term->ModLevel3Mask
1186		1636
1187	=item $modifiermask = $term->ModMetaMask	1637	=item $modifiermask = $term->ModMetaMask
…		…
1189	=item $modifiermask = $term->ModNumLockMask	1639	=item $modifiermask = $term->ModNumLockMask
1190		1640
1191	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1641	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1192	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1642	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1193		1643
		1644	=item $screen = $term->current_screen
		1645
		1646	Returns the currently displayed screen (0 primary, 1 secondary).
		1647
		1648	=item $cursor_is_hidden = $term->hidden_cursor
		1649
		1650	Returns whether the cursor is currently hidden or not.
		1651
1194	=item $view_start = $term->view_start ([$newvalue])	1652	=item $view_start = $term->view_start ([$newvalue])
1195		1653
1196	Returns the negative row number of the topmost line. Minimum value is	1654	Returns the row number of the topmost displayed line. Maximum value is
1197	C<0>, which displays the normal terminal contents. Larger values scroll	1655	C<0>, which displays the normal terminal contents. Lower values scroll
1198	this many lines into the scrollback buffer.	1656	this many lines into the scrollback buffer.
1199		1657
1200	=item $term->want_refresh	1658	=item $term->want_refresh
1201		1659
1202	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1660	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1205		1663
1206	Used after changing terminal contents to display them.	1664	Used after changing terminal contents to display them.
1207		1665
1208	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1666	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1209		1667
1210	Returns the text of the entire row with number C<$row_number>. Row C<0>	1668	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1211	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1669	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1212	terminal line. The scrollback buffer starts at line C<-1> and extends to
1213	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1670	terminal line. Nothing will be returned if a nonexistent line
1214	is requested.	1671	is requested.
1215		1672
1216	If C<$new_text> is specified, it will replace characters in the current	1673	If C<$new_text> is specified, it will replace characters in the current
1217	line, starting at column C<$start_col> (default C<0>), which is useful	1674	line, starting at column C<$start_col> (default C<0>), which is useful
1218	to replace only parts of a line. The font index in the rendition will	1675	to replace only parts of a line. The font index in the rendition will
1219	automatically be updated.	1676	automatically be updated.
1220		1677
1221	C<$text> is in a special encoding: tabs and wide characters that use more	1678	C<$text> is in a special encoding: tabs and wide characters that use more
1222	than one cell when displayed are padded with urxvt::NOCHAR characters	1679	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1223	(C<chr 65535>). Characters with combining characters and other characters	1680	characters. Characters with combining characters and other characters that
1224	that do not fit into the normal tetx encoding will be replaced with	1681	do not fit into the normal text encoding will be replaced with characters
1225	characters in the private use area.	1682	in the private use area.
1226		1683
1227	You have to obey this encoding when changing text. The advantage is	1684	You have to obey this encoding when changing text. The advantage is
1228	that C<substr> and similar functions work on screen cells and not on	1685	that C<substr> and similar functions work on screen cells and not on
1229	characters.	1686	characters.
1230		1687
…		…
1374	where one character corresponds to one screen cell. See	1831	where one character corresponds to one screen cell. See
1375	C<< $term->ROW_t >> for details.	1832	C<< $term->ROW_t >> for details.
1376		1833
1377	=item $string = $term->special_decode $text	1834	=item $string = $term->special_decode $text
1378		1835
1379	Converts rxvt-unicodes text reprsentation into a perl string. See	1836	Converts rxvt-unicodes text representation into a perl string. See
1380	C<< $term->ROW_t >> for details.	1837	C<< $term->ROW_t >> for details.
1381		1838
1382	=item $success = $term->grab_button ($button, $modifiermask)	1839	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1383		1840
		1841	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1842
1384	Registers a synchronous button grab. See the XGrabButton manpage.	1843	Register/unregister a synchronous button grab. See the XGrabButton
		1844	manpage.
1385		1845
1386	=item $success = $term->grab ($eventtime[, $sync])	1846	=item $success = $term->grab ($eventtime[, $sync])
1387		1847
1388	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1848	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1389	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1849	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1390		1850
1391	=item $term->allow_events_async	1851	=item $term->allow_events_async
1392		1852
1393	Calls XAllowEvents with AsyncBoth for the most recent grab.	1853	Calls XAllowEvents with AsyncBoth for the most recent grab.
1394		1854
…		…
1404	=item $term->ungrab	1864	=item $term->ungrab
1405		1865
1406	Calls XUngrab for the most recent grab. Is called automatically on	1866	Calls XUngrab for the most recent grab. Is called automatically on
1407	evaluation errors, as it is better to lose the grab in the error case as	1867	evaluation errors, as it is better to lose the grab in the error case as
1408	the session.	1868	the session.
		1869
		1870	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1871
		1872	=item $atom_name = $term->XGetAtomName ($atom)
		1873
		1874	=item @atoms = $term->XListProperties ($window)
		1875
		1876	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1877
		1878	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1879
		1880	=item $term->XDeleteProperty ($window, $property)
		1881
		1882	=item $window = $term->DefaultRootWindow
		1883
		1884	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1885
		1886	=item $term->XMapWindow ($window)
		1887
		1888	=item $term->XUnmapWindow ($window)
		1889
		1890	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1891
		1892	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1893
		1894	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1895
		1896	Various X or X-related functions. The C<$term> object only serves as
		1897	the source of the display, otherwise those functions map more-or-less
		1898	directory onto the X functions of the same name.
1409		1899
1410	=back	1900	=back
1411		1901
1412	=cut	1902	=cut
1413		1903
…		…
1477	my ($self, $text, $cb) = @_;	1967	my ($self, $text, $cb) = @_;
1478		1968
1479	$self->add_item ({ type => "button", text => $text, activate => $cb});	1969	$self->add_item ({ type => "button", text => $text, activate => $cb});
1480	}	1970	}
1481		1971
1482	=item $popup->add_toggle ($text, $cb, $initial_value)	1972	=item $popup->add_toggle ($text, $initial_value, $cb)
1483		1973
1484	Adds a toggle/checkbox item to the popup. Teh callback gets called	1974	Adds a toggle/checkbox item to the popup. The callback gets called
1485	whenever it gets toggled, with a boolean indicating its value as its first	1975	whenever it gets toggled, with a boolean indicating its new value as its
1486	argument.	1976	first argument.
1487		1977
1488	=cut	1978	=cut
1489		1979
1490	sub add_toggle {	1980	sub add_toggle {
1491	my ($self, $text, $cb, $value) = @_;	1981	my ($self, $text, $value, $cb) = @_;
1492		1982
1493	my $item; $item = {	1983	my $item; $item = {
1494	type => "button",	1984	type => "button",
1495	text => " $text",	1985	text => " $text",
1496	value => $value,	1986	value => $value,
…		…
1515	my $env = $self->{term}->env;	2005	my $env = $self->{term}->env;
1516	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2006	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1517	delete $env->{LC_ALL};	2007	delete $env->{LC_ALL};
1518	$env->{LC_CTYPE} = $self->{term}->locale;	2008	$env->{LC_CTYPE} = $self->{term}->locale;
1519		2009
1520	urxvt::term->new ($env, $self->{term}->resource ("name"),	2010	my $term = urxvt::term->new (
1521	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2011	$env, "popup",
		2012	"--perl-lib" => "", "--perl-ext-common" => "",
		2013	"-pty-fd" => -1, "-sl" => 0,
		2014	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1522	"--transient-for" => $self->{term}->parent,	2015	"--transient-for" => $self->{term}->parent,
1523	"-display" => $self->{term}->display_id,	2016	"-display" => $self->{term}->display_id,
1524	"-pe" => "urxvt-popup")	2017	"-pe" => "urxvt-popup",
1525	or die "unable to create popup window\n";	2018	) or die "unable to create popup window\n";
		2019
		2020	unless (delete $term->{urxvt_popup_init_done}) {
		2021	$term->ungrab;
		2022	$term->destroy;
		2023	die "unable to initialise popup window\n";
		2024	}
1526	}	2025	}
1527		2026
1528	sub DESTROY {	2027	sub DESTROY {
1529	my ($self) = @_;	2028	my ($self) = @_;
1530		2029
1531	delete $self->{term}{_destroy}{$self};	2030	delete $self->{term}{_destroy}{$self};
1532	$self->{term}->ungrab;	2031	$self->{term}->ungrab;
1533	}	2032	}
1534		2033
1535	=back	2034	=back
		2035
		2036	=cut
		2037
		2038	package urxvt::watcher;
1536		2039
1537	=head2 The C<urxvt::timer> Class	2040	=head2 The C<urxvt::timer> Class
1538		2041
1539	This class implements timer watchers/events. Time is represented as a	2042	This class implements timer watchers/events. Time is represented as a
1540	fractional number of seconds since the epoch. Example:	2043	fractional number of seconds since the epoch. Example:
…		…
1544	->new	2047	->new
1545	->interval (1)	2048	->interval (1)
1546	->cb (sub {	2049	->cb (sub {
1547	$term->{overlay}->set (0, 0,	2050	$term->{overlay}->set (0, 0,
1548	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2051	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1549	});	2052	});
1550		2053
1551	=over 4	2054	=over 4
1552		2055
1553	=item $timer = new urxvt::timer	2056	=item $timer = new urxvt::timer
1554		2057
…		…
1557		2060
1558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2061	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1559		2062
1560	Set the callback to be called when the timer triggers.	2063	Set the callback to be called when the timer triggers.
1561		2064
1562	=item $tstamp = $timer->at
1563
1564	Return the time this watcher will fire next.
1565
1566	=item $timer = $timer->set ($tstamp)	2065	=item $timer = $timer->set ($tstamp[, $interval])
1567		2066
1568	Set the time the event is generated to $tstamp.	2067	Set the time the event is generated to $tstamp (and optionally specifies a
		2068	new $interval).
1569		2069
1570	=item $timer = $timer->interval ($interval)	2070	=item $timer = $timer->interval ($interval)
1571		2071
1572	Normally (and when C<$interval> is C<0>), the timer will automatically	2072	By default (and when C<$interval> is C<0>), the timer will automatically
1573	stop after it has fired once. If C<$interval> is non-zero, then the timer	2073	stop after it has fired once. If C<$interval> is non-zero, then the timer
1574	is automatically rescheduled at the given intervals.	2074	is automatically rescheduled at the given intervals.
1575		2075
1576	=item $timer = $timer->start	2076	=item $timer = $timer->start
1577		2077
1578	Start the timer.	2078	Start the timer.
1579		2079
1580	=item $timer = $timer->start ($tstamp)	2080	=item $timer = $timer->start ($tstamp[, $interval])
1581		2081
1582	Set the event trigger time to C<$tstamp> and start the timer.	2082	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2083	also replaces the interval.
		2084
		2085	=item $timer = $timer->after ($delay[, $interval])
		2086
		2087	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1583		2088
1584	=item $timer = $timer->stop	2089	=item $timer = $timer->stop
1585		2090
1586	Stop the timer.	2091	Stop the timer.
1587		2092
…		…
1593		2098
1594	$term->{socket} = ...	2099	$term->{socket} = ...
1595	$term->{iow} = urxvt::iow	2100	$term->{iow} = urxvt::iow
1596	->new	2101	->new
1597	->fd (fileno $term->{socket})	2102	->fd (fileno $term->{socket})
1598	->events (urxvt::EVENT_READ)	2103	->events (urxvt::EV_READ)
1599	->start	2104	->start
1600	->cb (sub {	2105	->cb (sub {
1601	my ($iow, $revents) = @_;	2106	my ($iow, $revents) = @_;
1602	# $revents must be 1 here, no need to check	2107	# $revents must be 1 here, no need to check
1603	sysread $term->{socket}, my $buf, 8192	2108	sysread $term->{socket}, my $buf, 8192
…		…
1616	Set the callback to be called when io events are triggered. C<$reventmask>	2121	Set the callback to be called when io events are triggered. C<$reventmask>
1617	is a bitset as described in the C<events> method.	2122	is a bitset as described in the C<events> method.
1618		2123
1619	=item $iow = $iow->fd ($fd)	2124	=item $iow = $iow->fd ($fd)
1620		2125
1621	Set the filedescriptor (not handle) to watch.	2126	Set the file descriptor (not handle) to watch.
1622		2127
1623	=item $iow = $iow->events ($eventmask)	2128	=item $iow = $iow->events ($eventmask)
1624		2129
1625	Set the event mask to watch. The only allowed values are	2130	Set the event mask to watch. The only allowed values are
1626	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2131	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1627	together, or C<urxvt::EVENT_NONE>.	2132	together, or C<urxvt::EV_NONE>.
1628		2133
1629	=item $iow = $iow->start	2134	=item $iow = $iow->start
1630		2135
1631	Start watching for requested events on the given handle.	2136	Start watching for requested events on the given handle.
1632		2137
1633	=item $iow = $iow->stop	2138	=item $iow = $iow->stop
1634		2139
1635	Stop watching for events on the given filehandle.	2140	Stop watching for events on the given file handle.
		2141
		2142	=back
		2143
		2144	=head2 The C<urxvt::iw> Class
		2145
		2146	This class implements idle watchers, that get called automatically when
		2147	the process is idle. They should return as fast as possible, after doing
		2148	some useful work.
		2149
		2150	=over 4
		2151
		2152	=item $iw = new urxvt::iw
		2153
		2154	Create a new idle watcher object in stopped state.
		2155
		2156	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2157
		2158	Set the callback to be called when the watcher triggers.
		2159
		2160	=item $timer = $timer->start
		2161
		2162	Start the watcher.
		2163
		2164	=item $timer = $timer->stop
		2165
		2166	Stop the watcher.
		2167
		2168	=back
		2169
		2170	=head2 The C<urxvt::pw> Class
		2171
		2172	This class implements process watchers. They create an event whenever a
		2173	process exits, after which they stop automatically.
		2174
		2175	my $pid = fork;
		2176	...
		2177	$term->{pw} = urxvt::pw
		2178	->new
		2179	->start ($pid)
		2180	->cb (sub {
		2181	my ($pw, $exit_status) = @_;
		2182	...
		2183	});
		2184
		2185	=over 4
		2186
		2187	=item $pw = new urxvt::pw
		2188
		2189	Create a new process watcher in stopped state.
		2190
		2191	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2192
		2193	Set the callback to be called when the timer triggers.
		2194
		2195	=item $pw = $timer->start ($pid)
		2196
		2197	Tells the watcher to start watching for process C<$pid>.
		2198
		2199	=item $pw = $pw->stop
		2200
		2201	Stop the watcher.
1636		2202
1637	=back	2203	=back
1638		2204
1639	=head1 ENVIRONMENT	2205	=head1 ENVIRONMENT
1640		2206
…		…
1649		2215
1650	=item >= 3 - script loading and management	2216	=item >= 3 - script loading and management
1651		2217
1652	=item >=10 - all called hooks	2218	=item >=10 - all called hooks
1653		2219
1654	=item >=11 - hook reutrn values	2220	=item >=11 - hook return values
1655		2221
1656	=back	2222	=back
1657		2223
1658	=head1 AUTHOR	2224	=head1 AUTHOR
1659		2225
…		…
1661	http://software.schmorp.de/pkg/rxvt-unicode	2227	http://software.schmorp.de/pkg/rxvt-unicode
1662		2228
1663	=cut	2229	=cut
1664		2230
1665	1	2231	1
		2232
		2233	# vim: sw=3:

Diff Legend

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