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.183 by sf-exg, Wed Mar 31 13:14:50 2010 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 whether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-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<macosx-clipboard> 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
…		…
174		417
175	=over 4	418	=over 4
176		419
177	=item $text	420	=item $text
178		421
179	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
180	always represents one screen cell. See L<ROW_t> for a discussion of this format.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
181		424
182	=item $string	425	=item $string
183		426
184	A perl text string, with an emphasis on I<text>. It can store all unicode	427	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
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.
373		674
		675	=item on_configure_notify $term, $event
		676
		677	=item on_property_notify $term, $event
		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
378	=item on_button_press $term, $event	683	=item on_button_press $term, $event
…		…
383		688
384	=item on_map_notify $term, $event	689	=item on_map_notify $term, $event
385		690
386	=item on_unmap_notify $term, $event	691	=item on_unmap_notify $term, $event
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 event 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).
		713
		714	=item on_bell $term
		715
		716	Called on receipt of a bell character.
399		717
400	=back	718	=back
401		719
402	=cut	720	=cut
403		721
…		…
409	use Scalar::Util ();	727	use Scalar::Util ();
410	use List::Util ();	728	use List::Util ();
411		729
412	our $VERSION = 1;	730	our $VERSION = 1;
413	our $TERM;	731	our $TERM;
		732	our @TERM_INIT;
		733	our @TERM_EXT;
414	our @HOOKNAME;	734	our @HOOKNAME;
415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	735	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
416	our %OPTION;	736	our %OPTION;
417		737
418	our $LIBDIR;	738	our $LIBDIR;
419	our $RESNAME;	739	our $RESNAME;
420	our $RESCLASS;	740	our $RESCLASS;
421	our $RXVTNAME;	741	our $RXVTNAME;
422		742
		743	our $NOCHAR = chr 0xffff;
		744
423	=head2 Variables in the C<urxvt> Package	745	=head2 Variables in the C<urxvt> Package
424		746
425	=over 4	747	=over 4
426		748
427	=item $urxvt::LIBDIR	749	=item $urxvt::LIBDIR
…		…
439		761
440	=item $urxvt::TERM	762	=item $urxvt::TERM
441		763
442	The current terminal. This variable stores the current C<urxvt::term>	764	The current terminal. This variable stores the current C<urxvt::term>
443	object, whenever a callback/hook is executing.	765	object, whenever a callback/hook is executing.
		766
		767	=item @urxvt::TERM_INIT
		768
		769	All code references in this array will be called as methods of the next newly
		770	created C<urxvt::term> object (during the C<on_init> phase). The array
		771	gets cleared before the code references that were in it are being executed,
		772	so references can push themselves onto it again if they so desire.
		773
		774	This complements to the perl-eval command line option, but gets executed
		775	first.
		776
		777	=item @urxvt::TERM_EXT
		778
		779	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		780	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		781	but before other extensions. Gets cleared just like C<@TERM_INIT>.
444		782
445	=back	783	=back
446		784
447	=head2 Functions in the C<urxvt> Package	785	=head2 Functions in the C<urxvt> Package
448		786
…		…
463	Using this function has the advantage that its output ends up in the	801	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.	802	correct place, e.g. on stderr of the connecting urxvtc client.
465		803
466	Messages have a size limit of 1023 bytes currently.	804	Messages have a size limit of 1023 bytes currently.
467		805
468	=item $is_safe = urxvt::safe	806	=item @terms = urxvt::termlist
469		807
470	Returns true when it is safe to do potentially unsafe things, such as	808	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	809	whether they are started, being destroyed etc., so be careful. Only term
472	started setuid or setgid.	810	objects that have perl extensions attached will be returned (because there
		811	is no urxvt::term objet associated with others).
473		812
474	=item $time = urxvt::NOW	813	=item $time = urxvt::NOW
475		814
476	Returns the "current time" (as per the event loop).	815	Returns the "current time" (as per the event loop).
477		816
478	=item urxvt::CurrentTime	817	=item urxvt::CurrentTime
479		818
480	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	819	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
481	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	820	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
482	Button4Mask, Button5Mask, AnyModifier	821	Button4Mask, Button5Mask, AnyModifier
		822
		823	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		824	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		825	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		826	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		827	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		828	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		829	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		830
		831	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		832	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		833	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		834	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		835	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		836	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		837	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
483		838
484	Various constants for use in X calls and event processing.	839	Various constants for use in X calls and event processing.
485		840
486	=back	841	=back
487		842
…		…
520		875
521	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	876	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
522		877
523	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	878	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
524		879
		880	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		881
525	Replace the foreground/background colour in the rendition mask with the	882	Replace the foreground/background colour in the rendition mask with the
526	specified one.	883	specified one.
527		884
528	=item $value = urxvt::GET_CUSTOM $rend	885	=item $value = urxvt::GET_CUSTOM $rend
529		886
…		…
538	=back	895	=back
539		896
540	=cut	897	=cut
541		898
542	BEGIN {	899	BEGIN {
543	urxvt->bootstrap;
544
545	# overwrite perl's warn	900	# overwrite perl's warn
546	*CORE::GLOBAL::warn = sub {	901	*CORE::GLOBAL::warn = sub {
547	my $msg = join "", @_;	902	my $msg = join "", @_;
548	$msg .= "\n"	903	$msg .= "\n"
549	unless $msg =~ /\n$/;	904	unless $msg =~ /\n$/;
550	urxvt::warn ($msg);	905	urxvt::warn ($msg);
551	};	906	};
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	}	907	}
559		908
560	my @hook_count;	909	no warnings 'utf8';
		910
561	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	911	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
562		912
563	sub verbose {	913	sub verbose {
564	my ($level, $msg) = @_;	914	my ($level, $msg) = @_;
565	warn "$msg\n" if $level <= $verbosity;	915	warn "$msg\n" if $level <= $verbosity;
566	}	916	}
567		917
568	my $extension_pkg = "extension0000";
569	my %extension_pkg;	918	my %extension_pkg;
570		919
571	# load a single script into its own package, once only	920	# load a single script into its own package, once only
572	sub extension_package($) {	921	sub extension_package($) {
573	my ($path) = @_;	922	my ($path) = @_;
574		923
575	$extension_pkg{$path} ||= do {	924	$extension_pkg{$path} ||= do {
576	my $pkg = "urxvt::" . ($extension_pkg++);	925	$path =~ /([^\/\\]+)$/;
		926	my $pkg = $1;
		927	$pkg =~ s/[^[:word:]]/_/g;
		928	$pkg = "urxvt::ext::$pkg";
577		929
578	verbose 3, "loading extension '$path' into package '$pkg'";	930	verbose 3, "loading extension '$path' into package '$pkg'";
579		931
580	open my $fh, "<:raw", $path	932	open my $fh, "<:raw", $path
581	or die "$path: $!";	933	or die "$path: $!";
582		934
583	my $source = untaint	935	my $source =
584	"package $pkg; use strict; use utf8;\n"	936	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
585	. "use base urxvt::term::extension::;\n"
586	. "#line 1 \"$path\"\n{\n"	937	. "#line 1 \"$path\"\n{\n"
587	. (do { local $/; <$fh> })	938	. (do { local $/; <$fh> })
588	. "\n};\n1";	939	. "\n};\n1";
589		940
590	eval $source	941	eval $source
…		…
601	local $TERM = shift;	952	local $TERM = shift;
602	my $htype = shift;	953	my $htype = shift;
603		954
604	if ($htype == 0) { # INIT	955	if ($htype == 0) { # INIT
605	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	956	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
606		957
607	my %ext_arg;	958	my %ext_arg;
608		959
		960	{
		961	my @init = @TERM_INIT;
		962	@TERM_INIT = ();
		963	$_->($TERM) for @init;
		964	my @pkg = @TERM_EXT;
		965	@TERM_EXT = ();
		966	$TERM->register_package ($_) for @pkg;
		967	}
		968
609	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	969	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
610	if ($_ eq "default") {	970	if ($_ eq "default") {
611	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	971	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
612	} elsif (/^-(.*)$/) {	972	} elsif (/^-(.*)$/) {
613	delete $ext_arg{$1};	973	delete $ext_arg{$1};
614	} elsif (/^([^<]+)<(.*)>$/) {	974	} elsif (/^([^<]+)<(.*)>$/) {
615	push @{ $ext_arg{$1} }, $2;	975	push @{ $ext_arg{$1} }, $2;
616	} else {	976	} else {
617	$ext_arg{$_} ||= [];	977	$ext_arg{$_} ||= [];
618	}	978	}
619	}	979	}
620		980
621	while (my ($ext, $argv) = each %ext_arg) {	981	for my $ext (sort keys %ext_arg) {
622	my @files = grep -f $_, map "$_/$ext", @dirs;	982	my @files = grep -f $_, map "$_/$ext", @dirs;
623		983
624	if (@files) {	984	if (@files) {
625	$TERM->register_package (extension_package $files[0], $argv);	985	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
626	} else {	986	} else {
627	warn "perl extension '$ext' not found in perl library search path\n";	987	warn "perl extension '$ext' not found in perl library search path\n";
628	}	988	}
629	}	989	}
630		990
…		…
636		996
637	if (my $cb = $TERM->{_hook}[$htype]) {	997	if (my $cb = $TERM->{_hook}[$htype]) {
638	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	998	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
639	if $verbosity >= 10;	999	if $verbosity >= 10;
640		1000
641	keys %$cb;	1001	for my $pkg (keys %$cb) {
642
643	while (my ($pkg, $cb) = each %$cb) {
644	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1002	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
645	and last;	1003	$retval ||= $retval_;
646		1004
647	if ($@) {	1005	if ($@) {
648	$TERM->ungrab; # better to lose the grab than the session	1006	$TERM->ungrab; # better to lose the grab than the session
649	warn $@;	1007	warn $@;
650	}	1008	}
…		…
653	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	1011	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
654	if $verbosity >= 11;	1012	if $verbosity >= 11;
655	}	1013	}
656		1014
657	if ($htype == 1) { # DESTROY	1015	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	1016	# clear package objects
666	%$_ = () for values %{ $TERM->{_pkg} };	1017	%$_ = () for values %{ $TERM->{_pkg} };
667		1018
668	# clear package	1019	# clear package
669	%$TERM = ();	1020	%$TERM = ();
670	}	1021	}
671		1022
672	$retval	1023	$retval
673	}	1024	}
674		1025
675	sub exec_async(@) {	1026	sub SET_COLOR($$$) {
676	my $pid = fork;	1027	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1028	}
677		1029
678	return	1030	sub rend2mask {
679	if !defined $pid or $pid;	1031	no strict 'refs';
680		1032	my ($str, $mask) = (@_, 0);
681	%ENV = %{ $TERM->env };	1033	my %color = ( fg => undef, bg => undef );
682		1034	my @failed;
683	exec @_;	1035	for my $spec ( split /\s+/, $str ) {
684	_exit 255;	1036	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1037	$color{lc($1)} = $2;
		1038	} else {
		1039	my $neg = $spec =~ s/^[-^]//;
		1040	unless ( exists &{"RS_$spec"} ) {
		1041	push @failed, $spec;
		1042	next;
		1043	}
		1044	my $cur = &{"RS_$spec"};
		1045	if ( $neg ) {
		1046	$mask &= ~$cur;
		1047	} else {
		1048	$mask |= $cur;
		1049	}
		1050	}
		1051	}
		1052	($mask, @color{qw(fg bg)}, \@failed)
685	}	1053	}
686		1054
687	# urxvt::term::extension	1055	# urxvt::term::extension
688		1056
689	package urxvt::term::extension;	1057	package urxvt::term::extension;
…		…
695	while (my ($name, $cb) = each %hook) {	1063	while (my ($name, $cb) = each %hook) {
696	my $htype = $HOOKTYPE{uc $name};	1064	my $htype = $HOOKTYPE{uc $name};
697	defined $htype	1065	defined $htype
698	or Carp::croak "unsupported hook type '$name'";	1066	or Carp::croak "unsupported hook type '$name'";
699		1067
		1068	$self->set_should_invoke ($htype, +1)
700	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1069	unless exists $self->{term}{_hook}[$htype]{$pkg};
701	$hook_count[$htype]++
702	or urxvt::set_should_invoke $htype, 1;
703	}
704		1070
705	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1071	$self->{term}{_hook}[$htype]{$pkg} = $cb;
706	}	1072	}
707	}	1073	}
708		1074
…		…
713	for my $name (@hook) {	1079	for my $name (@hook) {
714	my $htype = $HOOKTYPE{uc $name};	1080	my $htype = $HOOKTYPE{uc $name};
715	defined $htype	1081	defined $htype
716	or Carp::croak "unsupported hook type '$name'";	1082	or Carp::croak "unsupported hook type '$name'";
717		1083
		1084	$self->set_should_invoke ($htype, -1)
718	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1085	if delete $self->{term}{_hook}[$htype]{$pkg};
719	--$hook_count[$htype]
720	or urxvt::set_should_invoke $htype, 0;
721	}
722	}	1086	}
723	}	1087	}
724		1088
725	our $AUTOLOAD;	1089	our $AUTOLOAD;
726		1090
…		…
764	is that you cannot use blocking APIs, but the non-blocking variant should	1128	is that you cannot use blocking APIs, but the non-blocking variant should
765	work.	1129	work.
766		1130
767	=cut	1131	=cut
768		1132
769	our $VERSION = 1;	1133	our $VERSION = '5.23';
770		1134
771	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1135	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
772	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1136	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
773		1137
774	sub timer {	1138	sub timer {
…		…
776		1140
777	my $cb = $arg{cb};	1141	my $cb = $arg{cb};
778		1142
779	urxvt::timer	1143	urxvt::timer
780	->new	1144	->new
781	->start (urxvt::NOW + $arg{after})	1145	->after ($arg{after}, $arg{interval})
782	->cb (sub {	1146	->cb ($arg{interval} ? $cb : sub {
783	$_[0]->stop; # need to cancel manually	1147	$_[0]->stop; # need to cancel manually
784	$cb->();	1148	$cb->();
785	})	1149	})
786	}	1150	}
787		1151
788	sub io {	1152	sub io {
789	my ($class, %arg) = @_;	1153	my ($class, %arg) = @_;
790		1154
791	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
		1156	my $fd = fileno $arg{fh};
		1157	defined $fd or $fd = $arg{fh};
792		1158
793	bless [$arg{fh}, urxvt::iow	1159	bless [$arg{fh}, urxvt::iow
794	->new	1160	->new
795	->fd (fileno $arg{fh})	1161	->fd ($fd)
796	->events (($arg{poll} =~ /r/ ? 1 : 0)	1162	->events (($arg{poll} =~ /r/ ? 1 : 0)
797	| ($arg{poll} =~ /w/ ? 2 : 0))	1163	| ($arg{poll} =~ /w/ ? 2 : 0))
798	->start	1164	->start
799	->cb (sub {	1165	->cb ($cb)
800	$cb->(($_[1] & 1 ? 'r' : '')
801	. ($_[1] & 2 ? 'w' : ''));
802	})],
803	urxvt::anyevent::	1166	], urxvt::anyevent::
		1167	}
		1168
		1169	sub idle {
		1170	my ($class, %arg) = @_;
		1171
		1172	my $cb = $arg{cb};
		1173
		1174	urxvt::iw
		1175	->new
		1176	->start
		1177	->cb ($cb)
		1178	}
		1179
		1180	sub child {
		1181	my ($class, %arg) = @_;
		1182
		1183	my $cb = $arg{cb};
		1184
		1185	urxvt::pw
		1186	->new
		1187	->start ($arg{pid})
		1188	->cb (sub {
		1189	$_[0]->stop; # need to cancel manually
		1190	$cb->($_[0]->rpid, $_[0]->rstatus);
		1191	})
804	}	1192	}
805		1193
806	sub DESTROY {	1194	sub DESTROY {
807	$_[0][1]->stop;	1195	$_[0][1]->stop;
808	}	1196	}
809		1197
810	sub condvar {	1198	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";	1199	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
821	}
822	}	1200	}
823		1201
824	package urxvt::term;	1202	package urxvt::term;
825		1203
826	=head2 The C<urxvt::term> Class	1204	=head2 The C<urxvt::term> Class
…		…
831		1209
832	# find on_xxx subs in the package and register them	1210	# find on_xxx subs in the package and register them
833	# as hooks	1211	# as hooks
834	sub register_package {	1212	sub register_package {
835	my ($self, $pkg, $argv) = @_;	1213	my ($self, $pkg, $argv) = @_;
		1214
		1215	no strict 'refs';
		1216
		1217	urxvt::verbose 6, "register package $pkg to $self";
		1218
		1219	@{"$pkg\::ISA"} = urxvt::term::extension::;
836		1220
837	my $proxy = bless {	1221	my $proxy = bless {
838	_pkg => $pkg,	1222	_pkg => $pkg,
839	argv => $argv,	1223	argv => $argv,
840	}, $pkg;	1224	}, $pkg;
…		…
856	hash which defines the environment of the new terminal.	1240	hash which defines the environment of the new terminal.
857		1241
858	Croaks (and probably outputs an error message) if the new instance	1242	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	1243	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	1244	initialise perl, and the terminal object otherwise. The C<init> and
861	C<start> hooks will be called during this call.	1245	C<start> hooks will be called before this call returns, and are free to
		1246	refer to global data (which is race free).
862		1247
863	=cut	1248	=cut
864		1249
865	sub new {	1250	sub new {
866	my ($class, $env, @args) = @_;	1251	my ($class, $env, @args) = @_;
867		1252
		1253	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1254	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1255
868	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1256	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
869	}	1257	}
870		1258
871	=item $term->destroy	1259	=item $term->destroy
872		1260
873	Destroy the terminal object (close the window, free resources	1261	Destroy the terminal object (close the window, free resources
874	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1262	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
875	watchers (timers, io watchers) are still active.	1263	watchers (timers, io watchers) are still active.
876		1264
		1265	=item $term->exec_async ($cmd[, @args])
		1266
		1267	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1268	("starts") programs in the background. This function takes care of setting
		1269	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1270	be preferred over explicit calls to C<exec> or C<system>.
		1271
		1272	Returns the pid of the subprocess or C<undef> on error.
		1273
		1274	=cut
		1275
		1276	sub exec_async {
		1277	my $self = shift;
		1278
		1279	my $pid = fork;
		1280
		1281	return $pid
		1282	if !defined $pid or $pid;
		1283
		1284	%ENV = %{ $self->env };
		1285
		1286	exec @_;
		1287	urxvt::_exit 255;
		1288	}
		1289
877	=item $isset = $term->option ($optval[, $set])	1290	=item $isset = $term->option ($optval[, $set])
878		1291
879	Returns true if the option specified by C<$optval> is enabled, and	1292	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	1293	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.	1294	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
882		1295
883	Here is a a likely non-exhaustive list of option names, please see the	1296	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:	1297	source file F</src/optinc.h> to see the actual list:
885		1298
886	borderLess console cursorBlink cursorUnderline hold iconic insecure	1299	borderLess console cursorBlink cursorUnderline hold iconic insecure
887	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1300	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
888	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1301	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
889	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1302	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
890	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1303	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
891	tripleclickwords utmpInhibit visualBell	1304	transparent tripleclickwords utmpInhibit visualBell
892		1305
893	=item $value = $term->resource ($name[, $newval])	1306	=item $value = $term->resource ($name[, $newval])
894		1307
895	Returns the current resource value associated with a given name and	1308	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>	1309	optionally sets a new value. Setting values is most useful in the C<init>
…		…
905	likely change).	1318	likely change).
906		1319
907	Please note that resource strings will currently only be freed when the	1320	Please note that resource strings will currently only be freed when the
908	terminal is destroyed, so changing options frequently will eat memory.	1321	terminal is destroyed, so changing options frequently will eat memory.
909		1322
910	Here is a a likely non-exhaustive list of resource names, not all of which	1323	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>	1324	are supported in every build, please see the source file F</src/rsinc.h>
912	to see the actual list:	1325	to see the actual list:
913		1326
914	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1327	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
915	borderLess color cursorBlink cursorUnderline cutchars delete_key	1328	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
916	display_name embed ext_bwidth fade font geometry hold iconName	1329	display_name embed ext_bwidth fade font geometry hold iconName
917	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1330	imFont imLocale inputMethod insecure int_bwidth intensityStyles
918	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1331	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
919	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1332	modifier mouseWheelScrollPage name override_redirect pastableTabs path
920	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1333	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
921	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1334	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
922	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1335	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
923	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1336	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
924	shade term_name title transparent transparent_all tripleclickwords	1337	secondaryScreen secondaryScroll shade term_name title
925	utmpInhibit visualBell	1338	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1339	visualBell
926		1340
927	=cut	1341	=cut
928		1342
929	sub resource($$;$) {	1343	sub resource($$;$) {
930	my ($self, $name) = (shift, shift);	1344	my ($self, $name) = (shift, shift);
931	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1345	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
932	&urxvt::term::_resource	1346	goto &urxvt::term::_resource
933	}	1347	}
934		1348
935	=item $value = $term->x_resource ($pattern)	1349	=item $value = $term->x_resource ($pattern)
936		1350
937	Returns the X-Resource for the given pattern, excluding the program or	1351	Returns the X-Resource for the given pattern, excluding the program or
…		…
962		1376
963	=item ($row, $col) = $term->selection_beg ([$row, $col])	1377	=item ($row, $col) = $term->selection_beg ([$row, $col])
964		1378
965	=item ($row, $col) = $term->selection_end ([$row, $col])	1379	=item ($row, $col) = $term->selection_end ([$row, $col])
966		1380
967	Return the current values of the selection mark, begin or end positions,	1381	Return the current values of the selection mark, begin or end positions.
968	and optionally set them to new values.	1382
		1383	When arguments are given, then the selection coordinates are set to
		1384	C<$row> and C<$col>, and the selection screen is set to the current
		1385	screen.
		1386
		1387	=item $screen = $term->selection_screen ([$screen])
		1388
		1389	Returns the current selection screen, and then optionally sets it.
969		1390
970	=item $term->selection_make ($eventtime[, $rectangular])	1391	=item $term->selection_make ($eventtime[, $rectangular])
971		1392
972	Tries to make a selection as set by C<selection_beg> and	1393	Tries to make a selection as set by C<selection_beg> and
973	C<selection_end>. If C<$rectangular> is true (default: false), a	1394	C<selection_end>. If C<$rectangular> is true (default: false), a
…		…
1020		1441
1021	The methods currently supported on C<urxvt::overlay> objects are:	1442	The methods currently supported on C<urxvt::overlay> objects are:
1022		1443
1023	=over 4	1444	=over 4
1024		1445
1025	=item $overlay->set ($x, $y, $text, $rend)	1446	=item $overlay->set ($x, $y, $text[, $rend])
1026		1447
1027	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1448	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	1449	text in rxvt-unicode's special encoding and an array of rendition values
1029	at a specific position inside the overlay.	1450	at a specific position inside the overlay.
		1451
		1452	If C<$rend> is missing, then the rendition will not be changed.
1030		1453
1031	=item $overlay->hide	1454	=item $overlay->hide
1032		1455
1033	If visible, hide the overlay, but do not destroy it.	1456	If visible, hide the overlay, but do not destroy it.
1034		1457
…		…
1104		1527
1105	Normally its not a good idea to use this function, as programs might be	1528	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	1529	confused by changes in cursor position or scrolling. Its useful inside a
1107	C<on_add_lines> hook, though.	1530	C<on_add_lines> hook, though.
1108		1531
		1532	=item $term->scr_change_screen ($screen)
		1533
		1534	Switch to given screen - 0 primary, 1 secondary.
		1535
1109	=item $term->cmd_parse ($octets)	1536	=item $term->cmd_parse ($octets)
1110		1537
1111	Similar to C<scr_add_lines>, but the argument must be in the	1538	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	1539	locale-specific encoding of the terminal and can contain command sequences
1113	(escape codes) that will be interpreted.	1540	(escape codes) that will be interpreted.
…		…
1123	Replaces the event mask of the pty watcher by the given event mask. Can	1550	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	1551	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	1552	description of C<< urxvt::timer->events >>. Make sure to always restore
1126	the previous value.	1553	the previous value.
1127		1554
		1555	=item $fd = $term->pty_fd
		1556
		1557	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1558	is used.
		1559
1128	=item $windowid = $term->parent	1560	=item $windowid = $term->parent
1129		1561
1130	Return the window id of the toplevel window.	1562	Return the window id of the toplevel window.
1131		1563
1132	=item $windowid = $term->vt	1564	=item $windowid = $term->vt
1133		1565
1134	Return the window id of the terminal window.	1566	Return the window id of the terminal window.
1135		1567
		1568	=item $term->vt_emask_add ($x_event_mask)
		1569
		1570	Adds the specified events to the vt event mask. Useful e.g. when you want
		1571	to receive pointer events all the times:
		1572
		1573	$term->vt_emask_add (urxvt::PointerMotionMask);
		1574
		1575	=item $term->focus_in
		1576
		1577	=item $term->focus_out
		1578
		1579	=item $term->key_press ($state, $keycode[, $time])
		1580
		1581	=item $term->key_release ($state, $keycode[, $time])
		1582
		1583	Deliver various fake events to to terminal.
		1584
1136	=item $window_width = $term->width	1585	=item $window_width = $term->width
1137		1586
1138	=item $window_height = $term->height	1587	=item $window_height = $term->height
1139		1588
1140	=item $font_width = $term->fwidth	1589	=item $font_width = $term->fwidth
…		…
1153		1602
1154	=item $max_scrollback = $term->saveLines	1603	=item $max_scrollback = $term->saveLines
1155		1604
1156	=item $nrow_plus_saveLines = $term->total_rows	1605	=item $nrow_plus_saveLines = $term->total_rows
1157		1606
1158	=item $lines_in_scrollback = $term->nsaved	1607	=item $topmost_scrollback_row = $term->top_row
1159		1608
1160	Return various integers describing terminal characteristics.	1609	Return various integers describing terminal characteristics.
1161		1610
1162	=item $x_display = $term->display_id	1611	=item $x_display = $term->display_id
1163		1612
…		…
1170	=item $env = $term->env	1619	=item $env = $term->env
1171		1620
1172	Returns a copy of the environment in effect for the terminal as a hashref	1621	Returns a copy of the environment in effect for the terminal as a hashref
1173	similar to C<\%ENV>.	1622	similar to C<\%ENV>.
1174		1623
		1624	=item @envv = $term->envv
		1625
		1626	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1627
		1628	=item @argv = $term->argv
		1629
		1630	Return the argument vector as this terminal, similar to @ARGV, but
		1631	includes the program name as first element.
		1632
1175	=cut	1633	=cut
1176		1634
1177	sub env {	1635	sub env {
1178	if (my $env = $_[0]->_env) {
1179	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1636	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1180	} else {
1181	+{ %ENV }
1182	}
1183	}	1637	}
1184		1638
1185	=item $modifiermask = $term->ModLevel3Mask	1639	=item $modifiermask = $term->ModLevel3Mask
1186		1640
1187	=item $modifiermask = $term->ModMetaMask	1641	=item $modifiermask = $term->ModMetaMask
…		…
1189	=item $modifiermask = $term->ModNumLockMask	1643	=item $modifiermask = $term->ModNumLockMask
1190		1644
1191	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1645	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.	1646	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1193		1647
		1648	=item $screen = $term->current_screen
		1649
		1650	Returns the currently displayed screen (0 primary, 1 secondary).
		1651
		1652	=item $cursor_is_hidden = $term->hidden_cursor
		1653
		1654	Returns whether the cursor is currently hidden or not.
		1655
1194	=item $view_start = $term->view_start ([$newvalue])	1656	=item $view_start = $term->view_start ([$newvalue])
1195		1657
1196	Returns the negative row number of the topmost line. Minimum value is	1658	Returns the row number of the topmost displayed line. Maximum value is
1197	C<0>, which displays the normal terminal contents. Larger values scroll	1659	C<0>, which displays the normal terminal contents. Lower values scroll
1198	this many lines into the scrollback buffer.	1660	this many lines into the scrollback buffer.
1199		1661
1200	=item $term->want_refresh	1662	=item $term->want_refresh
1201		1663
1202	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1664	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1205		1667
1206	Used after changing terminal contents to display them.	1668	Used after changing terminal contents to display them.
1207		1669
1208	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1670	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1209		1671
1210	Returns the text of the entire row with number C<$row_number>. Row C<0>	1672	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	1673	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	1674	terminal line. Nothing will be returned if a nonexistent line
1214	is requested.	1675	is requested.
1215		1676
1216	If C<$new_text> is specified, it will replace characters in the current	1677	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	1678	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	1679	to replace only parts of a line. The font index in the rendition will
1219	automatically be updated.	1680	automatically be updated.
1220		1681
1221	C<$text> is in a special encoding: tabs and wide characters that use more	1682	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	1683	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1223	(C<chr 65535>). Characters with combining characters and other characters	1684	characters. Characters with combining characters and other characters that
1224	that do not fit into the normal tetx encoding will be replaced with	1685	do not fit into the normal text encoding will be replaced with characters
1225	characters in the private use area.	1686	in the private use area.
1226		1687
1227	You have to obey this encoding when changing text. The advantage is	1688	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	1689	that C<substr> and similar functions work on screen cells and not on
1229	characters.	1690	characters.
1230		1691
…		…
1374	where one character corresponds to one screen cell. See	1835	where one character corresponds to one screen cell. See
1375	C<< $term->ROW_t >> for details.	1836	C<< $term->ROW_t >> for details.
1376		1837
1377	=item $string = $term->special_decode $text	1838	=item $string = $term->special_decode $text
1378		1839
1379	Converts rxvt-unicodes text reprsentation into a perl string. See	1840	Converts rxvt-unicodes text representation into a perl string. See
1380	C<< $term->ROW_t >> for details.	1841	C<< $term->ROW_t >> for details.
1381		1842
1382	=item $success = $term->grab_button ($button, $modifiermask)	1843	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1383		1844
		1845	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1846
1384	Registers a synchronous button grab. See the XGrabButton manpage.	1847	Register/unregister a synchronous button grab. See the XGrabButton
		1848	manpage.
1385		1849
1386	=item $success = $term->grab ($eventtime[, $sync])	1850	=item $success = $term->grab ($eventtime[, $sync])
1387		1851
1388	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1852	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1389	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1853	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1390		1854
1391	=item $term->allow_events_async	1855	=item $term->allow_events_async
1392		1856
1393	Calls XAllowEvents with AsyncBoth for the most recent grab.	1857	Calls XAllowEvents with AsyncBoth for the most recent grab.
1394		1858
…		…
1401	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1865	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1402	recent grab.	1866	recent grab.
1403		1867
1404	=item $term->ungrab	1868	=item $term->ungrab
1405		1869
1406	Calls XUngrab for the most recent grab. Is called automatically on	1870	Calls XUngrabPointer and XUngrabKeyboard 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	1871	evaluation errors, as it is better to lose the grab in the error case as
1408	the session.	1872	the session.
		1873
		1874	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1875
		1876	=item $atom_name = $term->XGetAtomName ($atom)
		1877
		1878	=item @atoms = $term->XListProperties ($window)
		1879
		1880	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1881
		1882	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1883
		1884	=item $term->XDeleteProperty ($window, $property)
		1885
		1886	=item $window = $term->DefaultRootWindow
		1887
		1888	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1889
		1890	=item $term->XMapWindow ($window)
		1891
		1892	=item $term->XUnmapWindow ($window)
		1893
		1894	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1895
		1896	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1897
		1898	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1899
		1900	Various X or X-related functions. The C<$term> object only serves as
		1901	the source of the display, otherwise those functions map more-or-less
		1902	directly onto the X functions of the same name.
1409		1903
1410	=back	1904	=back
1411		1905
1412	=cut	1906	=cut
1413		1907
…		…
1477	my ($self, $text, $cb) = @_;	1971	my ($self, $text, $cb) = @_;
1478		1972
1479	$self->add_item ({ type => "button", text => $text, activate => $cb});	1973	$self->add_item ({ type => "button", text => $text, activate => $cb});
1480	}	1974	}
1481		1975
1482	=item $popup->add_toggle ($text, $cb, $initial_value)	1976	=item $popup->add_toggle ($text, $initial_value, $cb)
1483		1977
1484	Adds a toggle/checkbox item to the popup. Teh callback gets called	1978	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	1979	whenever it gets toggled, with a boolean indicating its new value as its
1486	argument.	1980	first argument.
1487		1981
1488	=cut	1982	=cut
1489		1983
1490	sub add_toggle {	1984	sub add_toggle {
1491	my ($self, $text, $cb, $value) = @_;	1985	my ($self, $text, $value, $cb) = @_;
1492		1986
1493	my $item; $item = {	1987	my $item; $item = {
1494	type => "button",	1988	type => "button",
1495	text => " $text",	1989	text => " $text",
1496	value => $value,	1990	value => $value,
…		…
1515	my $env = $self->{term}->env;	2009	my $env = $self->{term}->env;
1516	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2010	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1517	delete $env->{LC_ALL};	2011	delete $env->{LC_ALL};
1518	$env->{LC_CTYPE} = $self->{term}->locale;	2012	$env->{LC_CTYPE} = $self->{term}->locale;
1519		2013
1520	urxvt::term->new ($env, $self->{term}->resource ("name"),	2014	my $term = urxvt::term->new (
1521	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2015	$env, "popup",
		2016	"--perl-lib" => "", "--perl-ext-common" => "",
		2017	"-pty-fd" => -1, "-sl" => 0,
		2018	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1522	"--transient-for" => $self->{term}->parent,	2019	"--transient-for" => $self->{term}->parent,
1523	"-display" => $self->{term}->display_id,	2020	"-display" => $self->{term}->display_id,
1524	"-pe" => "urxvt-popup")	2021	"-pe" => "urxvt-popup",
1525	or die "unable to create popup window\n";	2022	) or die "unable to create popup window\n";
		2023
		2024	unless (delete $term->{urxvt_popup_init_done}) {
		2025	$term->ungrab;
		2026	$term->destroy;
		2027	die "unable to initialise popup window\n";
		2028	}
1526	}	2029	}
1527		2030
1528	sub DESTROY {	2031	sub DESTROY {
1529	my ($self) = @_;	2032	my ($self) = @_;
1530		2033
1531	delete $self->{term}{_destroy}{$self};	2034	delete $self->{term}{_destroy}{$self};
1532	$self->{term}->ungrab;	2035	$self->{term}->ungrab;
1533	}	2036	}
1534		2037
1535	=back	2038	=back
		2039
		2040	=cut
		2041
		2042	package urxvt::watcher;
1536		2043
1537	=head2 The C<urxvt::timer> Class	2044	=head2 The C<urxvt::timer> Class
1538		2045
1539	This class implements timer watchers/events. Time is represented as a	2046	This class implements timer watchers/events. Time is represented as a
1540	fractional number of seconds since the epoch. Example:	2047	fractional number of seconds since the epoch. Example:
…		…
1544	->new	2051	->new
1545	->interval (1)	2052	->interval (1)
1546	->cb (sub {	2053	->cb (sub {
1547	$term->{overlay}->set (0, 0,	2054	$term->{overlay}->set (0, 0,
1548	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2055	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1549	});	2056	});
1550		2057
1551	=over 4	2058	=over 4
1552		2059
1553	=item $timer = new urxvt::timer	2060	=item $timer = new urxvt::timer
1554		2061
…		…
1557		2064
1558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2065	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1559		2066
1560	Set the callback to be called when the timer triggers.	2067	Set the callback to be called when the timer triggers.
1561		2068
1562	=item $tstamp = $timer->at
1563
1564	Return the time this watcher will fire next.
1565
1566	=item $timer = $timer->set ($tstamp)	2069	=item $timer = $timer->set ($tstamp[, $interval])
1567		2070
1568	Set the time the event is generated to $tstamp.	2071	Set the time the event is generated to $tstamp (and optionally specifies a
		2072	new $interval).
1569		2073
1570	=item $timer = $timer->interval ($interval)	2074	=item $timer = $timer->interval ($interval)
1571		2075
1572	Normally (and when C<$interval> is C<0>), the timer will automatically	2076	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	2077	stop after it has fired once. If C<$interval> is non-zero, then the timer
1574	is automatically rescheduled at the given intervals.	2078	is automatically rescheduled at the given intervals.
1575		2079
1576	=item $timer = $timer->start	2080	=item $timer = $timer->start
1577		2081
1578	Start the timer.	2082	Start the timer.
1579		2083
1580	=item $timer = $timer->start ($tstamp)	2084	=item $timer = $timer->start ($tstamp[, $interval])
1581		2085
1582	Set the event trigger time to C<$tstamp> and start the timer.	2086	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2087	also replaces the interval.
		2088
		2089	=item $timer = $timer->after ($delay[, $interval])
		2090
		2091	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1583		2092
1584	=item $timer = $timer->stop	2093	=item $timer = $timer->stop
1585		2094
1586	Stop the timer.	2095	Stop the timer.
1587		2096
…		…
1593		2102
1594	$term->{socket} = ...	2103	$term->{socket} = ...
1595	$term->{iow} = urxvt::iow	2104	$term->{iow} = urxvt::iow
1596	->new	2105	->new
1597	->fd (fileno $term->{socket})	2106	->fd (fileno $term->{socket})
1598	->events (urxvt::EVENT_READ)	2107	->events (urxvt::EV_READ)
1599	->start	2108	->start
1600	->cb (sub {	2109	->cb (sub {
1601	my ($iow, $revents) = @_;	2110	my ($iow, $revents) = @_;
1602	# $revents must be 1 here, no need to check	2111	# $revents must be 1 here, no need to check
1603	sysread $term->{socket}, my $buf, 8192	2112	sysread $term->{socket}, my $buf, 8192
…		…
1616	Set the callback to be called when io events are triggered. C<$reventmask>	2125	Set the callback to be called when io events are triggered. C<$reventmask>
1617	is a bitset as described in the C<events> method.	2126	is a bitset as described in the C<events> method.
1618		2127
1619	=item $iow = $iow->fd ($fd)	2128	=item $iow = $iow->fd ($fd)
1620		2129
1621	Set the filedescriptor (not handle) to watch.	2130	Set the file descriptor (not handle) to watch.
1622		2131
1623	=item $iow = $iow->events ($eventmask)	2132	=item $iow = $iow->events ($eventmask)
1624		2133
1625	Set the event mask to watch. The only allowed values are	2134	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	2135	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1627	together, or C<urxvt::EVENT_NONE>.	2136	together, or C<urxvt::EV_NONE>.
1628		2137
1629	=item $iow = $iow->start	2138	=item $iow = $iow->start
1630		2139
1631	Start watching for requested events on the given handle.	2140	Start watching for requested events on the given handle.
1632		2141
1633	=item $iow = $iow->stop	2142	=item $iow = $iow->stop
1634		2143
1635	Stop watching for events on the given filehandle.	2144	Stop watching for events on the given file handle.
		2145
		2146	=back
		2147
		2148	=head2 The C<urxvt::iw> Class
		2149
		2150	This class implements idle watchers, that get called automatically when
		2151	the process is idle. They should return as fast as possible, after doing
		2152	some useful work.
		2153
		2154	=over 4
		2155
		2156	=item $iw = new urxvt::iw
		2157
		2158	Create a new idle watcher object in stopped state.
		2159
		2160	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2161
		2162	Set the callback to be called when the watcher triggers.
		2163
		2164	=item $timer = $timer->start
		2165
		2166	Start the watcher.
		2167
		2168	=item $timer = $timer->stop
		2169
		2170	Stop the watcher.
		2171
		2172	=back
		2173
		2174	=head2 The C<urxvt::pw> Class
		2175
		2176	This class implements process watchers. They create an event whenever a
		2177	process exits, after which they stop automatically.
		2178
		2179	my $pid = fork;
		2180	...
		2181	$term->{pw} = urxvt::pw
		2182	->new
		2183	->start ($pid)
		2184	->cb (sub {
		2185	my ($pw, $exit_status) = @_;
		2186	...
		2187	});
		2188
		2189	=over 4
		2190
		2191	=item $pw = new urxvt::pw
		2192
		2193	Create a new process watcher in stopped state.
		2194
		2195	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2196
		2197	Set the callback to be called when the timer triggers.
		2198
		2199	=item $pw = $timer->start ($pid)
		2200
		2201	Tells the watcher to start watching for process C<$pid>.
		2202
		2203	=item $pw = $pw->stop
		2204
		2205	Stop the watcher.
1636		2206
1637	=back	2207	=back
1638		2208
1639	=head1 ENVIRONMENT	2209	=head1 ENVIRONMENT
1640		2210
…		…
1649		2219
1650	=item >= 3 - script loading and management	2220	=item >= 3 - script loading and management
1651		2221
1652	=item >=10 - all called hooks	2222	=item >=10 - all called hooks
1653		2223
1654	=item >=11 - hook reutrn values	2224	=item >=11 - hook return values
1655		2225
1656	=back	2226	=back
1657		2227
1658	=head1 AUTHOR	2228	=head1 AUTHOR
1659		2229
…		…
1661	http://software.schmorp.de/pkg/rxvt-unicode	2231	http://software.schmorp.de/pkg/rxvt-unicode
1662		2232
1663	=cut	2233	=cut
1664		2234
1665	1	2235	1
		2236
		2237	# vim: sw=3:

Diff Legend

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