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.77 by root, Wed Jan 11 00:59:58 2006 UTC vs.
Revision 1.210 by root, Wed Jun 6 11:46:11 2012 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
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>
39		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
44	(More) intelligent selection. This extension tries to be more intelligent	51	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	52	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	53	now, it tries to select words, urls and complete shell-quoted
47	too, if your F<ls> supports C<--quoting-style=shell>.	54	arguments, which is very convenient, too, if your F<ls> supports
		55	C<--quoting-style=shell>.
48		56
		57	A double-click usually selects the word under the cursor, further clicks
		58	will enlarge the selection.
		59
		60	The selection works by trying to match a number of regexes and displaying
		61	them in increasing order of length. You can add your own regexes by
		62	specifying resources of the form:
		63
		64	URxvt.selection.pattern-0: perl-regex
		65	URxvt.selection.pattern-1: perl-regex
		66	...
		67
		68	The index number (0, 1...) must not have any holes, and each regex must
		69	contain at least one pair of capturing parentheses, which will be used for
		70	the match. For example, the following adds a regex that matches everything
		71	between two vertical bars:
		72
		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: ^(/[^:]+):\
		81
		82	You can look at the source of the selection extension to see more
		83	interesting uses, such as parsing a line from beginning to end.
		84
49	It also offers the following bindable keyboard command:	85	This extension also offers following bindable keyboard commands:
50		86
51	=over 4	87	=over 4
52		88
53	=item rot13	89	=item rot13
54		90
…		…
61	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
62		98
63	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
64	runtime.	100	runtime.
65		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
66	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
67		120
68	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
69	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
70	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	};
71		143
72	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
73		145
74	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	148	input/output is suspended and a regex is displayed at the bottom of the
		149	screen.
77		150
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	151	Inputting characters appends them to the regex and continues incremental
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80	history, C<enter> leaves search mode at the current position and C<escape>	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	154	bottom. C<Escape> leaves search mode and returns to the point where search
		155	was started, while C<Enter> or C<Return> stay at the current position and
		156	additionally stores the first match in the current line into the primary
		157	selection if the C<Shift> modifier is active.
82		158
83	=item digital-clock	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.
84		162
85	Displays a digital clock using the built-in overlay.	163	See L<perlre> for more info about perl regular expression syntax.
86		164
87	=item mark-urls	165	=item readline (enabled by default)
88		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.
		189
		190	=item selection-autotransform
		191
		192	This selection allows you to do automatic transforms on a selection
		193	whenever a selection is made.
		194
		195	It works by specifying perl snippets (most useful is a single C<s///>
		196	operator) that modify C<$_> as resources:
		197
		198	URxvt.selection-autotransform.0: transform
		199	URxvt.selection-autotransform.1: transform
		200	...
		201
		202	For example, the following will transform selections of the form
		203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		204	$word>:
		205
		206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		207
		208	And this example matches the same,but replaces it with vi-commands you can
		209	paste directly into your (vi :) editor:
		210
		211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		212
		213	Of course, this can be modified to suit your needs and your editor :)
		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
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	250	Uses per-line display filtering (C<on_line_update>) to underline text
		251	matching a certain pattern and make it clickable. When clicked with the
		252	mouse button specified in the C<matcher.button> resource (default 2, or
		253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
		266	"perl:matcher:list" as seen in the example below.
		267
		268	Example configuration:
		269
		270	URxvt.perl-ext: default,matcher
		271	URxvt.urlLauncher: sensible-browser
		272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
		274	URxvt.matcher.button: 1
		275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		277	URxvt.matcher.launcher.2: gvim +$2 $1
		278
		279	=item xim-onthespot
		280
		281	This (experimental) perl extension implements OnTheSpot editing. It does
		282	not work perfectly, and some input methods don't seem to work well with
		283	OnTheSpot editing in general, but it seems to work at least for SCIM and
		284	kinput2.
		285
		286	You enable it by specifying this extension and a preedit style of
		287	C<OnTheSpot>, i.e.:
		288
		289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		290
		291	=item kuake<hotkey>
		292
		293	A very primitive quake-console-like extension. It was inspired by a
		294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		295	user presses a global accelerator key (by default C<F10>), the terminal
		296	will show or hide itself. Another press of the accelerator key will hide
		297	or show it again.
		298
		299	Initially, the window will not be shown when using this extension.
		300
		301	This is useful if you need a single terminal that is not using any desktop
		302	space most of the time but is quickly available at the press of a key.
		303
		304	The accelerator key is grabbed regardless of any modifiers, so this
		305	extension will actually grab a physical key just for this function.
		306
		307	If you want a quake-like animation, tell your window manager to do so
		308	(fvwm can do it).
		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
90		315
91	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
92		317
93	A not very useful example of filtering all text output to the terminal,	318	A not very useful example of filtering all text output to the terminal
94	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	320	similar-looking ascii character.
		321
		322	=item digital-clock
		323
		324	Displays a digital clock using the built-in overlay.
		325
		326	=item remote-clipboard
		327
		328	Somewhat of a misnomer, this extension adds two menu entries to the
		329	selection popup that allows one to run external commands to store the
		330	selection somewhere and fetch it again.
		331
		332	We use it to implement a "distributed selection mechanism", which just
		333	means that one command uploads the file to a remote server, and another
		334	reads it.
		335
		336	The commands can be set using the C<URxvt.remote-selection.store> and
		337	C<URxvt.remote-selection.fetch> resources. The first should read the
		338	selection to store from STDIN (always in UTF-8), the second should provide
		339	the selection data on STDOUT (also in UTF-8).
		340
		341	The defaults (which are likely useless to you) use rsh and cat:
		342
		343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		345
		346	=item selection-pastebin
		347
		348	This is a little rarely useful extension that uploads the selection as
		349	textfile to a remote site (or does other things). (The implementation is
		350	not currently secure for use in a multiuser environment as it writes to
		351	F</tmp> directly.).
		352
		353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		354	i.e.
		355
		356	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		357
		358	Pressing this combination runs a command with C<%> replaced by the name of
		359	the textfile. This command can be set via a resource:
		360
		361	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		362
		363	And the default is likely not useful to anybody but the few people around
		364	here :)
		365
		366	The name of the textfile is the hex encoded md5 sum of the selection, so
		367	the same content should lead to the same filename.
		368
		369	After a successful upload the selection will be replaced by the text given
		370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		371	for the filename):
		372
		373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		374
		375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		376	the double C</> characters as comment start. Use C<\057\057> instead,
		377	which works regardless of whether xrdb is used to parse the resource file
		378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
96		393
97	=item example-refresh-hooks	394	=item example-refresh-hooks
98		395
99	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
101	overlays or changes.	398	overlays or changes.
		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
102		412
103	=back	413	=back
104		414
105	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
106		416
…		…
122		432
123	=over 4	433	=over 4
124		434
125	=item $text	435	=item $text
126		436
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
128	always represents one screen cell. See L<row_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		439
130	=item $string	440	=item $string
131		441
132	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
133	characters and is to be distinguished with text encoded in a specific	443	characters and is to be distinguished with text encoded in a specific
…		…
136	=item $octets	446	=item $octets
137		447
138	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
139	locale-specific way.	449	locale-specific way.
140		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
141	=back	457	=back
142		458
143	=head2 Extension Objects	459	=head2 Extension Objects
144		460
145	Very perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
146	for each terminal and each extension and passed as the first parameter to	462	for each terminal, and each terminal has its own set of extension objects,
147	hooks. So extensions can use their C<$self> object without having to think	463	which are passed as the first parameter to hooks. So extensions can use
148	about other extensions, with the exception of methods and members that	464	their C<$self> object without having to think about clashes with other
		465	extensions or other terminals, with the exception of methods and members
149	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
150	use.	467	internal use.
151		468
152	Although it isn't a C<urxvt::term> object, you can call all methods of the	469	Although it isn't a C<urxvt::term> object, you can call all methods of the
153	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
154		471
155	It has the following methods and data members:	472	It has the following methods and data members:
…		…
176	=head2 Hooks	493	=head2 Hooks
177		494
178	The following subroutines can be declared in extension files, and will be	495	The following subroutines can be declared in extension files, and will be
179	called whenever the relevant event happens.	496	called whenever the relevant event happens.
180		497
181	The first argument passed to them is an extension oject as described in	498	The first argument passed to them is an extension object as described in
182	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
183		500
184	B<All> of these hooks must return a boolean value. If it is true, then the	501	B<All> of these hooks must return a boolean value. If any of the called
185	event counts as being I<consumed>, and the invocation of other hooks is	502	hooks returns true, then the event counts as being I<consumed>, and the
186	skipped, and the relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
187		504
188	I<< When in doubt, return a false value (preferably C<()>). >>	505	I<< When in doubt, return a false value (preferably C<()>). >>
189		506
190	=over 4	507	=over 4
191		508
192	=item on_init $term	509	=item on_init $term
193		510
194	Called after a new terminal object has been initialized, but before	511	Called after a new terminal object has been initialized, but before
195	windows are created or the command gets run. Most methods are unsafe to	512	windows are created or the command gets run. Most methods are unsafe to
196	call or deliver senseless data, as terminal size and other characteristics	513	call or deliver senseless data, as terminal size and other characteristics
197	have not yet been determined. You can safely query and change resources,	514	have not yet been determined. You can safely query and change resources
198	though.	515	and options, though. For many purposes the C<on_start> hook is a better
		516	place.
		517
		518	=item on_start $term
		519
		520	Called at the very end of initialisation of a new terminal, just before
		521	trying to map (display) the toplevel and returning to the main loop.
		522
		523	=item on_destroy $term
		524
		525	Called whenever something tries to destroy terminal, when the terminal is
		526	still fully functional (not for long, though).
199		527
200	=item on_reset $term	528	=item on_reset $term
201		529
202	Called after the screen is "reset" for any reason, such as resizing or	530	Called after the screen is "reset" for any reason, such as resizing or
203	control sequences. Here is where you can react on changes to size-related	531	control sequences. Here is where you can react on changes to size-related
204	variables.	532	variables.
205		533
206	=item on_start $term	534	=item on_child_start $term, $pid
207		535
208	Called at the very end of initialisation of a new terminal, just before	536	Called just after the child process has been C<fork>ed.
209	returning to the mainloop.	537
		538	=item on_child_exit $term, $status
		539
		540	Called just after the child process has exited. C<$status> is the status
		541	from C<waitpid>.
210		542
211	=item on_sel_make $term, $eventtime	543	=item on_sel_make $term, $eventtime
212		544
213	Called whenever a selection has been made by the user, but before the	545	Called whenever a selection has been made by the user, but before the
214	selection text is copied, so changes to the beginning, end or type of the	546	selection text is copied, so changes to the beginning, end or type of the
…		…
221		553
222	Called whenever a selection has been copied, but before the selection is	554	Called whenever a selection has been copied, but before the selection is
223	requested from the server. The selection text can be queried and changed	555	requested from the server. The selection text can be queried and changed
224	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
225		557
226	Returning a true value aborts selection grabbing. It will still be hilighted.	558	Returning a true value aborts selection grabbing. It will still be highlighted.
227		559
228	=item on_sel_extend $term	560	=item on_sel_extend $term
229		561
230	Called whenever the user tries to extend the selection (e.g. with a double	562	Called whenever the user tries to extend the selection (e.g. with a double
231	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
232	should extend the selection itelf and return true to suppress the built-in	564	should extend the selection itself and return true to suppress the built-in
233	processing.	565	processing. This can happen multiple times, as long as the callback
		566	returns true, it will be called on every further click by the user and is
		567	supposed to enlarge the selection more and more, if possible.
234		568
235	See the F<selection> example extension.	569	See the F<selection> example extension.
236		570
237	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
238		572
239	Called whenever the view offset changes, i..e the user or program	573	Called whenever the view offset changes, i.e. the user or program
240	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
241	show this many lines of scrollback.	575	show this many lines of scrollback.
242		576
243	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
244		578
…		…
248		582
249	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	583	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
250	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	584	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
251	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
252		586
253	=item on_osc_seq $term, $string	587	=item on_osc_seq $term, $op, $args, $resp
		588
		589	Called on every OSC sequence and can be used to suppress it or modify its
		590	behaviour. The default should be to return an empty list. A true value
		591	suppresses execution of the request completely. Make sure you don't get
		592	confused by recursive invocations when you output an OSC sequence within
		593	this callback.
		594
		595	C<on_osc_seq_perl> should be used for new behaviour.
		596
		597	=item on_osc_seq_perl $term, $args, $resp
254		598
255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
256	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
257	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
258	string should start with the extension name and a colon, to distinguish	602	string should start with the extension name (sans -osc) and a semicolon,
259	it from commands for other extensions, and this might be enforced in the	603	to distinguish it from commands for other extensions, and this might be
260	future.	604	enforced in the future.
		605
		606	For example, C<overlay-osc> uses this:
		607
		608	sub on_osc_seq_perl {
		609	my ($self, $osc, $resp) = @_;
		610
		611	return unless $osc =~ s/^overlay;//;
		612
		613	... process remaining $osc string
		614	}
261		615
262	Be careful not ever to trust (in a security sense) the data you receive,	616	Be careful not ever to trust (in a security sense) the data you receive,
263	as its source can not easily be controleld (e-mail content, messages from	617	as its source can not easily be controlled (e-mail content, messages from
264	other users on the same system etc.).	618	other users on the same system etc.).
		619
		620	For responses, C<$resp> contains the end-of-args separator used by the
		621	sender.
265		622
266	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
267		624
268	Called whenever text is about to be output, with the text as argument. You	625	Called whenever text is about to be output, with the text as argument. You
269	can filter/change and output the text yourself by returning a true value	626	can filter/change and output the text yourself by returning a true value
…		…
274	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
275		632
276	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
277	suppress or filter tty input.	634	suppress or filter tty input.
278		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
279	=item on_line_update $term, $row	643	=item on_line_update $term, $row
280		644
281	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
282	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
283	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
290	later with the already-modified line (e.g. if unrelated parts change), so	654	later with the already-modified line (e.g. if unrelated parts change), so
291	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
292		656
293	=item on_refresh_begin $term	657	=item on_refresh_begin $term
294		658
295	Called just before the screen gets redrawn. Can be used for overlay	659	Called just before the screen gets redrawn. Can be used for overlay or
296	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
297	restoring them in refresh_end. The built-in overlay and selection display	661	restoring them in refresh_end. The built-in overlay and selection display
298	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
299		663
300	=item on_refresh_end $term	664	=item on_refresh_end $term
301		665
302	Called just after the screen gets redrawn. See C<on_refresh_begin>.	666	Called just after the screen gets redrawn. See C<on_refresh_begin>.
303		667
304	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
305		669
306	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
307	C<perl:string> action bound to it (see description of the B<keysym>	671	a C<perl:string> action bound to a key, see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
		673
		674	The event is simply the action string. This interface is assumed to change
		675	slightly in the future.
		676
		677	=item on_register_command $term, $keysym, $modifiermask, $string
		678
		679	Called after parsing a keysym resource but before registering the
		680	associated binding. If this hook returns TRUE the binding is not
		681	registered. It can be used to modify a binding by calling
		682	C<register_command>.
		683
		684	=item on_resize_all_windows $term, $new_width, $new_height
		685
		686	Called just after the new window size has been calculated, but before
		687	windows are actually being resized or hints are being set. If this hook
		688	returns TRUE, setting of the window hints is being skipped.
		689
		690	=item on_x_event $term, $event
		691
		692	Called on every X event received on the vt window (and possibly other
		693	windows). Should only be used as a last resort. Most event structure
		694	members are not passed.
		695
		696	=item on_root_event $term, $event
		697
		698	Like C<on_x_event>, but is called for events on the root window.
309		699
310	=item on_focus_in $term	700	=item on_focus_in $term
311		701
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	703	does focus in processing.
314		704
315	=item on_focus_out $term	705	=item on_focus_out $term
316		706
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	708	focus out processing.
319		709
		710	=item on_configure_notify $term, $event
		711
		712	=item on_property_notify $term, $event
		713
320	=item on_key_press $term, $event, $keysym, $octets	714	=item on_key_press $term, $event, $keysym, $octets
321		715
322	=item on_key_release $term, $event, $keysym	716	=item on_key_release $term, $event, $keysym
323		717
324	=item on_button_press $term, $event	718	=item on_button_press $term, $event
…		…
329		723
330	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
331		725
332	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
333		727
334	Called whenever the corresponding X event is received for the terminal If	728	Called whenever the corresponding X event is received for the terminal. If
335	the hook returns true, then the even will be ignored by rxvt-unicode.	729	the hook returns true, then the event will be ignored by rxvt-unicode.
336		730
337	The event is a hash with most values as named by Xlib (see the XEvent	731	The event is a hash with most values as named by Xlib (see the XEvent
338	manpage), with the additional members C<row> and C<col>, which are the row	732	manpage), with the additional members C<row> and C<col>, which are the
339	and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
340		734
341	C<on_key_press> additionally receives the string rxvt-unicode would	735	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	736	output, if any, in locale-specific encoding.
343		737
344	subwindow.	738	subwindow.
		739
		740	=item on_client_message $term, $event
		741
		742	=item on_wm_protocols $term, $event
		743
		744	=item on_wm_delete_window $term, $event
		745
		746	Called when various types of ClientMessage events are received (all with
		747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
345		752
346	=back	753	=back
347		754
348	=cut	755	=cut
349		756
…		…
355	use Scalar::Util ();	762	use Scalar::Util ();
356	use List::Util ();	763	use List::Util ();
357		764
358	our $VERSION = 1;	765	our $VERSION = 1;
359	our $TERM;	766	our $TERM;
		767	our @TERM_INIT;
		768	our @TERM_EXT;
360	our @HOOKNAME;	769	our @HOOKNAME;
361	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
362	our %OPTION;	771	our %OPTION;
363		772
364	our $LIBDIR;	773	our $LIBDIR;
365	our $RESNAME;	774	our $RESNAME;
366	our $RESCLASS;	775	our $RESCLASS;
367	our $RXVTNAME;	776	our $RXVTNAME;
368		777
		778	our $NOCHAR = chr 0xffff;
		779
369	=head2 Variables in the C<urxvt> Package	780	=head2 Variables in the C<urxvt> Package
370		781
371	=over 4	782	=over 4
372		783
373	=item $urxvt::LIBDIR	784	=item $urxvt::LIBDIR
…		…
386	=item $urxvt::TERM	797	=item $urxvt::TERM
387		798
388	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
389	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
390		801
391	=item	802	=item @urxvt::TERM_INIT
		803
		804	All code references in this array will be called as methods of the next newly
		805	created C<urxvt::term> object (during the C<on_init> phase). The array
		806	gets cleared before the code references that were in it are being executed,
		807	so references can push themselves onto it again if they so desire.
		808
		809	This complements to the perl-eval command line option, but gets executed
		810	first.
		811
		812	=item @urxvt::TERM_EXT
		813
		814	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		815	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		816	but before other extensions. Gets cleared just like C<@TERM_INIT>.
392		817
393	=back	818	=back
394		819
395	=head2 Functions in the C<urxvt> Package	820	=head2 Functions in the C<urxvt> Package
396		821
397	=over 4	822	=over 4
398		823
399	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
400		825
401	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
402	costs! The only time this is acceptable is when the terminal process	827	include a trailing newline). Avoid at all costs! The only time this
403	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
404		830
405	=item urxvt::warn $string	831	=item urxvt::warn $string
406		832
407	Calls C<rxvt_warn> with the given string which should not include a	833	Calls C<rxvt_warn> with the given string which should include a trailing
408	newline. The module also overwrites the C<warn> builtin with a function	834	newline. The module also overwrites the C<warn> builtin with a function
409	that calls this function.	835	that calls this function.
410		836
411	Using this function has the advantage that its output ends up in the	837	Using this function has the advantage that its output ends up in the
412	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
413		839
414	Messages have a size limit of 1023 bytes currently.	840	Messages have a size limit of 1023 bytes currently.
415		841
416	=item $is_safe = urxvt::safe	842	=item @terms = urxvt::termlist
417		843
418	Returns true when it is safe to do potentially unsafe things, such as	844	Returns all urxvt::term objects that exist in this process, regardless of
419	evaluating perl code specified by the user. This is true when urxvt was	845	whether they are started, being destroyed etc., so be careful. Only term
420	started setuid or setgid.	846	objects that have perl extensions attached will be returned (because there
		847	is no urxvt::term object associated with others).
421		848
422	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
423		850
424	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
425		852
426	=item urxvt::CurrentTime	853	=item urxvt::CurrentTime
427		854
428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	855	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	856	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430	Button4Mask, Button5Mask, AnyModifier	857	Button4Mask, Button5Mask, AnyModifier
		858
		859	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		860	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		861	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		862	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		863	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		864	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		865	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		866
		867	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		868	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		869	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		870	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		871	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		872	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		873	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431		874
432	Various constants for use in X calls and event processing.	875	Various constants for use in X calls and event processing.
433		876
434	=back	877	=back
435		878
…		…
452		895
453	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
454		897
455	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
456		899
457	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
458		902
459	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
460	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
461	the bitset.	905	the bitset.
462		906
…		…
468		912
469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
470		914
471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	915	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
472		916
		917	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		918
473	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
474	specified one.	920	specified one.
475		921
476	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
477		923
…		…
486	=back	932	=back
487		933
488	=cut	934	=cut
489		935
490	BEGIN {	936	BEGIN {
491	urxvt->bootstrap;
492
493	# overwrite perl's warn	937	# overwrite perl's warn
494	*CORE::GLOBAL::warn = sub {	938	*CORE::GLOBAL::warn = sub {
495	my $msg = join "", @_;	939	my $msg = join "", @_;
496	$msg .= "\n"	940	$msg .= "\n"
497	unless $msg =~ /\n$/;	941	unless $msg =~ /\n$/;
498	urxvt::warn ($msg);	942	urxvt::warn ($msg);
499	};	943	};
500
501	delete $ENV{IFS};
502	delete $ENV{CDPATH};
503	delete $ENV{BASH_ENV};
504	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
505	}	944	}
506		945
507	my @hook_count;	946	no warnings 'utf8';
		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	warn "resourece<@_>\n";#d#
		954
		955	my $r = $term->{meta}{resource};
		956	while (my ($pattern, $v) = each %$r) {
		957	$name =~ y/-/./ if $isarg;
		958
		959	if (
		960	$pattern =~ s/\*$//
		961	? $pattern eq substr $name, 0, length $pattern
		962	: $pattern eq $name
		963	) {
		964	$name = "$urxvt::RESCLASS.$name";
		965	warn "set option <$name=$value>\n";#d#
		966	#TODO: queue $v->[0] for loading
		967	if ($v->[1] eq "boolean") {
		968	$term->put_option_db ($name, $flag ? "true" : "false");
		969	return 1;
		970	} else {
		971	$term->put_option_db ($name, $value);
		972	return 1 + 2;
		973	}
		974	}
		975	}
		976
		977	0
		978	}
		979
		980	sub usage {
		981	my ($term, $usage_type) = @_;
		982
		983	$term->scan_meta;
		984
		985	my $r = $term->{meta}{resource};
		986
		987	for my $pattern (sort keys %$r) {
		988	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		989
		990	$desc .= " (-pe $ext)";
		991
		992	if ($usage_type == 1) {
		993	$pattern =~ y/./-/;
		994	$pattern =~ s/\*/.../g;
		995
		996	if ($type eq "boolean") {
		997	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		998	} else {
		999	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		1000	}
		1001	} else {
		1002	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1003	}
		1004	}
		1005	}
		1006
508	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1007	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
509		1008
510	sub verbose {	1009	sub verbose {
511	my ($level, $msg) = @_;	1010	my ($level, $msg) = @_;
512	warn "$msg\n" if $level <= $verbosity;	1011	warn "$msg\n" if $level <= $verbosity;
513	}	1012	}
514		1013
515	my $extension_pkg = "extension0000";
516	my %extension_pkg;	1014	my %extension_pkg;
517		1015
518	# load a single script into its own package, once only	1016	# load a single script into its own package, once only
519	sub extension_package($) {	1017	sub extension_package($) {
520	my ($path) = @_;	1018	my ($path) = @_;
521		1019
522	$extension_pkg{$path} ||= do {	1020	$extension_pkg{$path} ||= do {
523	my $pkg = "urxvt::" . ($extension_pkg++);	1021	$path =~ /([^\/\\]+)$/;
		1022	my $pkg = $1;
		1023	$pkg =~ s/[^[:word:]]/_/g;
		1024	$pkg = "urxvt::ext::$pkg";
524		1025
525	verbose 3, "loading extension '$path' into package '$pkg'";	1026	verbose 3, "loading extension '$path' into package '$pkg'";
526		1027
527	open my $fh, "<:raw", $path	1028	open my $fh, "<:raw", $path
528	or die "$path: $!";	1029	or die "$path: $!";
529		1030
530	my $source = untaint	1031	my $source =
531	"package $pkg; use strict; use utf8;\n"	1032	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
532	. "use base urxvt::term::extension::;\n"
533	. "#line 1 \"$path\"\n{\n"	1033	. "#line 1 \"$path\"\n{\n"
534	. (do { local $/; <$fh> })	1034	. (do { local $/; <$fh> })
535	. "\n};\n1";	1035	. "\n};\n1";
536		1036
537	eval $source	1037	eval $source
…		…
547	sub invoke {	1047	sub invoke {
548	local $TERM = shift;	1048	local $TERM = shift;
549	my $htype = shift;	1049	my $htype = shift;
550		1050
551	if ($htype == 0) { # INIT	1051	if ($htype == 0) { # INIT
552	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1052	my @dirs = $TERM->perl_libdirs;
553		1053
554	my %ext_arg;	1054	my %ext_arg;
555		1055
		1056	{
		1057	my @init = @TERM_INIT;
		1058	@TERM_INIT = ();
		1059	$_->($TERM) for @init;
		1060	my @pkg = @TERM_EXT;
		1061	@TERM_EXT = ();
		1062	$TERM->register_package ($_) for @pkg;
		1063	}
		1064
556	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1065	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
557	if ($_ eq "default") {	1066	if ($_ eq "default") {
558	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	1067	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
559	} elsif (/^-(.*)$/) {	1068	} elsif (/^-(.*)$/) {
560	delete $ext_arg{$1};	1069	delete $ext_arg{$1};
561	} elsif (/^([^<]+)<(.*)>$/) {	1070	} elsif (/^([^<]+)<(.*)>$/) {
562	push @{ $ext_arg{$1} }, $2;	1071	push @{ $ext_arg{$1} }, $2;
563	} else {	1072	} else {
564	$ext_arg{$_} ||= [];	1073	$ext_arg{$_} ||= [];
565	}	1074	}
566	}	1075	}
567		1076
568	while (my ($ext, $argv) = each %ext_arg) {	1077	for my $ext (sort keys %ext_arg) {
569	my @files = grep -f $_, map "$_/$ext", @dirs;	1078	my @files = grep -f $_, map "$_/$ext", @dirs;
570		1079
571	if (@files) {	1080	if (@files) {
572	$TERM->register_package (extension_package $files[0], $argv);	1081	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
573	} else {	1082	} else {
574	warn "perl extension '$ext' not found in perl library search path\n";	1083	warn "perl extension '$ext' not found in perl library search path\n";
575	}	1084	}
576	}	1085	}
577		1086
…		…
583		1092
584	if (my $cb = $TERM->{_hook}[$htype]) {	1093	if (my $cb = $TERM->{_hook}[$htype]) {
585	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1094	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
586	if $verbosity >= 10;	1095	if $verbosity >= 10;
587		1096
588	keys %$cb;	1097	for my $pkg (keys %$cb) {
589
590	while (my ($pkg, $cb) = each %$cb) {
591	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1098	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
592	and last;	1099	$retval ||= $retval_;
593		1100
594	if ($@) {	1101	if ($@) {
595	$TERM->ungrab; # better to lose the grab than the session	1102	$TERM->ungrab; # better to lose the grab than the session
596	warn $@;	1103	warn $@;
597	}	1104	}
598	}	1105	}
		1106
		1107	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		1108	if $verbosity >= 11;
599	}	1109	}
600		1110
601	if ($htype == 1) { # DESTROY	1111	if ($htype == 1) { # DESTROY
602	if (my $hook = delete $TERM->{_hook}) {
603	for my $htype (0..$#$hook) {
604	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
605	or set_should_invoke $htype, 0;
606	}
607	}
608
609	# clear package objects	1112	# clear package objects
610	%$_ = () for values %{ $TERM->{_pkg} };	1113	%$_ = () for values %{ $TERM->{_pkg} };
611		1114
612	# clear package	1115	# clear package
613	%$TERM = ();	1116	%$TERM = ();
614	}	1117	}
615		1118
616	$retval	1119	$retval
		1120	}
		1121
		1122	sub SET_COLOR($$$) {
		1123	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1124	}
		1125
		1126	sub rend2mask {
		1127	no strict 'refs';
		1128	my ($str, $mask) = (@_, 0);
		1129	my %color = ( fg => undef, bg => undef );
		1130	my @failed;
		1131	for my $spec ( split /\s+/, $str ) {
		1132	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1133	$color{lc($1)} = $2;
		1134	} else {
		1135	my $neg = $spec =~ s/^[-^]//;
		1136	unless ( exists &{"RS_$spec"} ) {
		1137	push @failed, $spec;
		1138	next;
		1139	}
		1140	my $cur = &{"RS_$spec"};
		1141	if ( $neg ) {
		1142	$mask &= ~$cur;
		1143	} else {
		1144	$mask |= $cur;
		1145	}
		1146	}
		1147	}
		1148	($mask, @color{qw(fg bg)}, \@failed)
617	}	1149	}
618		1150
619	# urxvt::term::extension	1151	# urxvt::term::extension
620		1152
621	package urxvt::term::extension;	1153	package urxvt::term::extension;
…		…
627	while (my ($name, $cb) = each %hook) {	1159	while (my ($name, $cb) = each %hook) {
628	my $htype = $HOOKTYPE{uc $name};	1160	my $htype = $HOOKTYPE{uc $name};
629	defined $htype	1161	defined $htype
630	or Carp::croak "unsupported hook type '$name'";	1162	or Carp::croak "unsupported hook type '$name'";
631		1163
		1164	$self->set_should_invoke ($htype, +1)
632	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1165	unless exists $self->{term}{_hook}[$htype]{$pkg};
633	$hook_count[$htype]++
634	or urxvt::set_should_invoke $htype, 1;
635	}
636		1166
637	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1167	$self->{term}{_hook}[$htype]{$pkg} = $cb;
638	}	1168	}
639	}	1169	}
640		1170
…		…
645	for my $name (@hook) {	1175	for my $name (@hook) {
646	my $htype = $HOOKTYPE{uc $name};	1176	my $htype = $HOOKTYPE{uc $name};
647	defined $htype	1177	defined $htype
648	or Carp::croak "unsupported hook type '$name'";	1178	or Carp::croak "unsupported hook type '$name'";
649		1179
		1180	$self->set_should_invoke ($htype, -1)
650	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1181	if delete $self->{term}{_hook}[$htype]{$pkg};
651	--$hook_count[$htype]
652	or urxvt::set_should_invoke $htype, 0;
653	}
654	}	1182	}
655	}	1183	}
656		1184
657	our $AUTOLOAD;	1185	our $AUTOLOAD;
658		1186
…		…
690	=head2 The C<urxvt::anyevent> Class	1218	=head2 The C<urxvt::anyevent> Class
691		1219
692	The sole purpose of this class is to deliver an interface to the	1220	The sole purpose of this class is to deliver an interface to the
693	C<AnyEvent> module - any module using it will work inside urxvt without	1221	C<AnyEvent> module - any module using it will work inside urxvt without
694	further programming. The only exception is that you cannot wait on	1222	further programming. The only exception is that you cannot wait on
695	condition variables, but non-blocking condvar use is ok. What this means	1223	condition variables, but non-blocking condvar use is ok.
696	is that you cannot use blocking APIs, but the non-blocking variant should	1224
697	work.	1225	In practical terms this means is that you cannot use blocking APIs, but
		1226	the non-blocking variant should work.
698		1227
699	=cut	1228	=cut
700		1229
701	our $VERSION = 1;	1230	our $VERSION = '5.23';
702		1231
703	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1232	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
704	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1233	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
705		1234
706	sub timer {	1235	sub timer {
…		…
708		1237
709	my $cb = $arg{cb};	1238	my $cb = $arg{cb};
710		1239
711	urxvt::timer	1240	urxvt::timer
712	->new	1241	->new
713	->start (urxvt::NOW + $arg{after})	1242	->after ($arg{after}, $arg{interval})
714	->cb (sub {	1243	->cb ($arg{interval} ? $cb : sub {
715	$_[0]->stop; # need to cancel manually	1244	$_[0]->stop; # need to cancel manually
716	$cb->();	1245	$cb->();
717	})	1246	})
718	}	1247	}
719		1248
720	sub io {	1249	sub io {
721	my ($class, %arg) = @_;	1250	my ($class, %arg) = @_;
722		1251
723	my $cb = $arg{cb};	1252	my $cb = $arg{cb};
		1253	my $fd = fileno $arg{fh};
		1254	defined $fd or $fd = $arg{fh};
724		1255
725	bless [$arg{fh}, urxvt::iow	1256	bless [$arg{fh}, urxvt::iow
726	->new	1257	->new
727	->fd (fileno $arg{fh})	1258	->fd ($fd)
728	->events (($arg{poll} =~ /r/ ? 1 : 0)	1259	->events (($arg{poll} =~ /r/ ? 1 : 0)
729	| ($arg{poll} =~ /w/ ? 2 : 0))	1260	| ($arg{poll} =~ /w/ ? 2 : 0))
730	->start	1261	->start
731	->cb (sub {	1262	->cb ($cb)
732	$cb->(($_[1] & 1 ? 'r' : '')
733	. ($_[1] & 2 ? 'w' : ''));
734	})],
735	urxvt::anyevent::	1263	], urxvt::anyevent::
		1264	}
		1265
		1266	sub idle {
		1267	my ($class, %arg) = @_;
		1268
		1269	my $cb = $arg{cb};
		1270
		1271	urxvt::iw
		1272	->new
		1273	->start
		1274	->cb ($cb)
		1275	}
		1276
		1277	sub child {
		1278	my ($class, %arg) = @_;
		1279
		1280	my $cb = $arg{cb};
		1281
		1282	urxvt::pw
		1283	->new
		1284	->start ($arg{pid})
		1285	->cb (sub {
		1286	$_[0]->stop; # need to cancel manually
		1287	$cb->($_[0]->rpid, $_[0]->rstatus);
		1288	})
736	}	1289	}
737		1290
738	sub DESTROY {	1291	sub DESTROY {
739	$_[0][1]->stop;	1292	$_[0][1]->stop;
740	}	1293	}
741		1294
742	sub condvar {	1295	# only needed for AnyEvent < 6 compatibility
743	bless \my $flag, urxvt::anyevent::condvar::	1296	sub one_event {
744	}
745
746	sub urxvt::anyevent::condvar::broadcast {
747	${$_[0]}++;
748	}
749
750	sub urxvt::anyevent::condvar::wait {
751	unless (${$_[0]}) {
752	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1297	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
753	}
754	}	1298	}
755		1299
756	package urxvt::term;	1300	package urxvt::term;
757		1301
758	=head2 The C<urxvt::term> Class	1302	=head2 The C<urxvt::term> Class
…		…
763		1307
764	# find on_xxx subs in the package and register them	1308	# find on_xxx subs in the package and register them
765	# as hooks	1309	# as hooks
766	sub register_package {	1310	sub register_package {
767	my ($self, $pkg, $argv) = @_;	1311	my ($self, $pkg, $argv) = @_;
		1312
		1313	no strict 'refs';
		1314
		1315	urxvt::verbose 6, "register package $pkg to $self";
		1316
		1317	@{"$pkg\::ISA"} = urxvt::term::extension::;
768		1318
769	my $proxy = bless {	1319	my $proxy = bless {
770	_pkg => $pkg,	1320	_pkg => $pkg,
771	argv => $argv,	1321	argv => $argv,
772	}, $pkg;	1322	}, $pkg;
…		…
779	$proxy->enable ($name => $ref);	1329	$proxy->enable ($name => $ref);
780	}	1330	}
781	}	1331	}
782	}	1332	}
783		1333
		1334	sub perl_libdirs {
		1335	map { split /:/ }
		1336	$_[0]->resource ("perl_lib"),
		1337	$ENV{URXVT_PERL_LIB},
		1338	"$ENV{HOME}/.urxvt/ext",
		1339	"$LIBDIR/perl"
		1340	}
		1341
		1342	sub scan_meta {
		1343	my ($self) = @_;
		1344	my @libdirs = perl_libdirs $self;
		1345
		1346	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1347
		1348	my %meta;
		1349
		1350	$self->{meta_libdirs} = join "\x00", @libdirs;
		1351	$self->{meta} = \%meta;
		1352
		1353	for my $dir (reverse @libdirs) {
		1354	opendir my $fh, $dir
		1355	or next;
		1356	for my $ext (readdir $fh) {
		1357	$ext ne "."
		1358	and $ext ne ".."
		1359	and open my $fh, "<", "$dir/$ext"
		1360	or next;
		1361
		1362	while (<$fh>) {
		1363	if (/^#:META:X_RESOURCE:(.*)/) {
		1364	my ($pattern, $type, $desc) = split /:/, $1;
		1365	$pattern =~ s/^%\./$ext./g; # $$ in pattern == extension name
		1366	if ($pattern =~ /[^a-zA-Z\*\.]/) {
		1367	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1368	} else {
		1369	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1370	}
		1371	} elsif (/^\s*(?:#|$)/) {
		1372	# skip other comments and empty lines
		1373	} else {
		1374	last; # stop parsing on first non-empty non-comment line
		1375	}
		1376	}
		1377	}
		1378	}
		1379	}
		1380
784	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1381	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
785		1382
786	Creates a new terminal, very similar as if you had started it with system	1383	Creates a new terminal, very similar as if you had started it with system
787	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a %ENV>-like	1384	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
788	C<hash which defines the environment of the new terminal.	1385	hash which defines the environment of the new terminal.
789		1386
790	Croaks (and probably outputs an error message) if the new instance	1387	Croaks (and probably outputs an error message) if the new instance
791	couldn't be created. Returns C<undef> if the new instance didn't	1388	couldn't be created. Returns C<undef> if the new instance didn't
792	initialise perl, and the terminal object otherwise. The C<init> and	1389	initialise perl, and the terminal object otherwise. The C<init> and
793	C<start> hooks will be called during this call.	1390	C<start> hooks will be called before this call returns, and are free to
		1391	refer to global data (which is race free).
794		1392
795	=cut	1393	=cut
796		1394
797	sub new {	1395	sub new {
798	my ($class, $env, @args) = @_;	1396	my ($class, $env, @args) = @_;
799		1397
		1398	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1399	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1400
800	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1401	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
801	}	1402	}
802		1403
803	=item $term->destroy	1404	=item $term->destroy
804		1405
805	Destroy the terminal object (close the window, free resources	1406	Destroy the terminal object (close the window, free resources
806	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1407	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
807	watchers (timers, io watchers) are still active.	1408	watchers (timers, io watchers) are still active.
808		1409
		1410	=item $term->exec_async ($cmd[, @args])
		1411
		1412	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1413	("starts") programs in the background. This function takes care of setting
		1414	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1415	be preferred over explicit calls to C<exec> or C<system>.
		1416
		1417	Returns the pid of the subprocess or C<undef> on error.
		1418
		1419	=cut
		1420
		1421	sub exec_async {
		1422	my $self = shift;
		1423
		1424	my $pid = fork;
		1425
		1426	return $pid
		1427	if !defined $pid or $pid;
		1428
		1429	%ENV = %{ $self->env };
		1430
		1431	exec @_;
		1432	urxvt::_exit 255;
		1433	}
		1434
809	=item $isset = $term->option ($optval[, $set])	1435	=item $isset = $term->option ($optval[, $set])
810		1436
811	Returns true if the option specified by C<$optval> is enabled, and	1437	Returns true if the option specified by C<$optval> is enabled, and
812	optionally change it. All option values are stored by name in the hash	1438	optionally change it. All option values are stored by name in the hash
813	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1439	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
814		1440
815	Here is a a likely non-exhaustive list of option names, please see the	1441	Here is a likely non-exhaustive list of option names, please see the
816	source file F</src/optinc.h> to see the actual list:	1442	source file F</src/optinc.h> to see the actual list:
817		1443
818	borderLess console cursorBlink cursorUnderline hold iconic insecure	1444	borderLess buffered console cursorBlink cursorUnderline hold iconic
819	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1445	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1446	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
820	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1447	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
821	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1448	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
822	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1449	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
823	tripleclickwords utmpInhibit visualBell	1450	urgentOnBell utmpInhibit visualBell
824		1451
825	=item $value = $term->resource ($name[, $newval])	1452	=item $value = $term->resource ($name[, $newval])
826		1453
827	Returns the current resource value associated with a given name and	1454	Returns the current resource value associated with a given name and
828	optionally sets a new value. Setting values is most useful in the C<init>	1455	optionally sets a new value. Setting values is most useful in the C<init>
…		…
837	likely change).	1464	likely change).
838		1465
839	Please note that resource strings will currently only be freed when the	1466	Please note that resource strings will currently only be freed when the
840	terminal is destroyed, so changing options frequently will eat memory.	1467	terminal is destroyed, so changing options frequently will eat memory.
841		1468
842	Here is a a likely non-exhaustive list of resource names, not all of which	1469	Here is a likely non-exhaustive list of resource names, not all of which
843	are supported in every build, please see the source file F</src/rsinc.h>	1470	are supported in every build, please see the source file F</src/rsinc.h>
844	to see the actual list:	1471	to see the actual list:
845		1472
846	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1473	answerbackstring backgroundPixmap backspace_key blendtype blurradius
847	borderLess color cursorBlink cursorUnderline cutchars delete_key	1474	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
848	display_name embed ext_bwidth fade font geometry hold iconName	1475	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
849	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1476	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1477	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
850	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1478	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
851	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1479	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
852	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1480	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
853	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1481	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
854	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1482	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
855	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1483	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
856	shade term_name title transparent transparent_all tripleclickwords	1484	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1485	term_name title transient_for transparent tripleclickwords urgentOnBell
857	utmpInhibit visualBell	1486	utmpInhibit visualBell
858		1487
859	=cut	1488	=cut
860		1489
861	sub resource($$;$) {	1490	sub resource($$;$) {
862	my ($self, $name) = (shift, shift);	1491	my ($self, $name) = (shift, shift);
863	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1492	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
864	&urxvt::term::_resource	1493	goto &urxvt::term::_resource
865	}	1494	}
866		1495
867	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1496	=item $value = $term->x_resource ($pattern)
868		1497
		1498	Returns the X-Resource for the given pattern, excluding the program or
		1499	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1500	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1501	resource with that pattern exists.
		1502
		1503	This method should only be called during the C<on_start> hook, as there is
		1504	only one resource database per display, and later invocations might return
		1505	the wrong resources.
		1506
		1507	=item $success = $term->parse_keysym ($key, $octets)
		1508
869	Adds a keymap translation exactly as specified via a resource. See the	1509	Adds a key binding exactly as specified via a resource. See the
870	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1510	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1511
		1512	=item $term->register_command ($keysym, $modifiermask, $string)
		1513
		1514	Adds a key binding. This is a lower level api compared to
		1515	C<parse_keysym>, as it expects a parsed key description, and can be
		1516	used only inside either the C<on_init> hook, to add a binding, or the
		1517	C<on_register_command> hook, to modify a parsed binding.
871		1518
872	=item $rend = $term->rstyle ([$new_rstyle])	1519	=item $rend = $term->rstyle ([$new_rstyle])
873		1520
874	Return and optionally change the current rendition. Text that is output by	1521	Return and optionally change the current rendition. Text that is output by
875	the terminal application will use this style.	1522	the terminal application will use this style.
…		…
883		1530
884	=item ($row, $col) = $term->selection_beg ([$row, $col])	1531	=item ($row, $col) = $term->selection_beg ([$row, $col])
885		1532
886	=item ($row, $col) = $term->selection_end ([$row, $col])	1533	=item ($row, $col) = $term->selection_end ([$row, $col])
887		1534
888	Return the current values of the selection mark, begin or end positions,	1535	Return the current values of the selection mark, begin or end positions.
889	and optionally set them to new values.
890		1536
		1537	When arguments are given, then the selection coordinates are set to
		1538	C<$row> and C<$col>, and the selection screen is set to the current
		1539	screen.
		1540
		1541	=item $screen = $term->selection_screen ([$screen])
		1542
		1543	Returns the current selection screen, and then optionally sets it.
		1544
		1545	=item $term->selection_make ($eventtime[, $rectangular])
		1546
		1547	Tries to make a selection as set by C<selection_beg> and
		1548	C<selection_end>. If C<$rectangular> is true (default: false), a
		1549	rectangular selection will be made. This is the preferred function to make
		1550	a selection.
		1551
891	=item $success = $term->selection_grab ($eventtime)	1552	=item $success = $term->selection_grab ($eventtime[, $clipboard])
892		1553
893	Try to request the primary selection from the server (for example, as set	1554	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
894	by the next method).	1555	true) selection from the server. The corresponding text can be set
		1556	with the next method. No visual feedback will be given. This function
		1557	is mostly useful from within C<on_sel_grab> hooks.
895		1558
896	=item $oldtext = $term->selection ([$newtext])	1559	=item $oldtext = $term->selection ([$newtext, $clipboard])
897		1560
898	Return the current selection text and optionally replace it by C<$newtext>.	1561	Return the current selection (clipboard if C<$clipboard> is true) text
		1562	and optionally replace it by C<$newtext>.
		1563
		1564	=item $term->selection_clear ([$clipboard])
		1565
		1566	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
899		1567
900	=item $term->overlay_simple ($x, $y, $text)	1568	=item $term->overlay_simple ($x, $y, $text)
901		1569
902	Create a simple multi-line overlay box. See the next method for details.	1570	Create a simple multi-line overlay box. See the next method for details.
903		1571
…		…
933		1601
934	The methods currently supported on C<urxvt::overlay> objects are:	1602	The methods currently supported on C<urxvt::overlay> objects are:
935		1603
936	=over 4	1604	=over 4
937		1605
938	=item $overlay->set ($x, $y, $text, $rend)	1606	=item $overlay->set ($x, $y, $text[, $rend])
939		1607
940	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1608	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
941	text in rxvt-unicode's special encoding and an array of rendition values	1609	text in rxvt-unicode's special encoding and an array of rendition values
942	at a specific position inside the overlay.	1610	at a specific position inside the overlay.
		1611
		1612	If C<$rend> is missing, then the rendition will not be changed.
943		1613
944	=item $overlay->hide	1614	=item $overlay->hide
945		1615
946	If visible, hide the overlay, but do not destroy it.	1616	If visible, hide the overlay, but do not destroy it.
947		1617
…		…
992	Convert the given locale-encoded octets into a perl string.	1662	Convert the given locale-encoded octets into a perl string.
993		1663
994	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1664	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
995		1665
996	XORs the rendition values in the given span with the provided value	1666	XORs the rendition values in the given span with the provided value
997	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1667	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
998	to the selection.	1668	refresh hooks to provide effects similar to the selection.
999		1669
1000	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1670	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1001		1671
1002	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1672	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1003	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1673	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1004	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1674	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1005	it instead.	1675	it instead. Both styles I<MUST NOT> contain font styles.
1006		1676
1007	=item $term->scr_bell	1677	=item $term->scr_bell
1008		1678
1009	Ring the bell!	1679	Ring the bell!
1010		1680
…		…
1017		1687
1018	Normally its not a good idea to use this function, as programs might be	1688	Normally its not a good idea to use this function, as programs might be
1019	confused by changes in cursor position or scrolling. Its useful inside a	1689	confused by changes in cursor position or scrolling. Its useful inside a
1020	C<on_add_lines> hook, though.	1690	C<on_add_lines> hook, though.
1021		1691
		1692	=item $term->scr_change_screen ($screen)
		1693
		1694	Switch to given screen - 0 primary, 1 secondary.
		1695
1022	=item $term->cmd_parse ($octets)	1696	=item $term->cmd_parse ($octets)
1023		1697
1024	Similar to C<scr_add_lines>, but the argument must be in the	1698	Similar to C<scr_add_lines>, but the argument must be in the
1025	locale-specific encoding of the terminal and can contain command sequences	1699	locale-specific encoding of the terminal and can contain command sequences
1026	(escape codes) that will be interpreted.	1700	(escape codes) that will be interpreted.
1027		1701
1028	=item $term->tt_write ($octets)	1702	=item $term->tt_write ($octets)
1029		1703
1030	Write the octets given in C<$data> to the tty (i.e. as program input). To	1704	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1031	pass characters instead of octets, you should convert your strings first	1705	pass characters instead of octets, you should convert your strings first
1032	to the locale-specific encoding using C<< $term->locale_encode >>.	1706	to the locale-specific encoding using C<< $term->locale_encode >>.
		1707
		1708	=item $term->tt_paste ($octets)
		1709
		1710	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1711	CR and bracketing the data with control sequences if bracketed paste mode
		1712	is set.
1033		1713
1034	=item $old_events = $term->pty_ev_events ([$new_events])	1714	=item $old_events = $term->pty_ev_events ([$new_events])
1035		1715
1036	Replaces the event mask of the pty watcher by the given event mask. Can	1716	Replaces the event mask of the pty watcher by the given event mask. Can
1037	be used to suppress input and output handling to the pty/tty. See the	1717	be used to suppress input and output handling to the pty/tty. See the
1038	description of C<< urxvt::timer->events >>. Make sure to always restore	1718	description of C<< urxvt::timer->events >>. Make sure to always restore
1039	the previous value.	1719	the previous value.
1040		1720
		1721	=item $fd = $term->pty_fd
		1722
		1723	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1724	is used.
		1725
1041	=item $windowid = $term->parent	1726	=item $windowid = $term->parent
1042		1727
1043	Return the window id of the toplevel window.	1728	Return the window id of the toplevel window.
1044		1729
1045	=item $windowid = $term->vt	1730	=item $windowid = $term->vt
1046		1731
1047	Return the window id of the terminal window.	1732	Return the window id of the terminal window.
1048		1733
		1734	=item $term->vt_emask_add ($x_event_mask)
		1735
		1736	Adds the specified events to the vt event mask. Useful e.g. when you want
		1737	to receive pointer events all the times:
		1738
		1739	$term->vt_emask_add (urxvt::PointerMotionMask);
		1740
		1741	=item $term->set_urgency ($set)
		1742
		1743	Enable/disable the urgency hint on the toplevel window.
		1744
		1745	=item $term->focus_in
		1746
		1747	=item $term->focus_out
		1748
		1749	=item $term->key_press ($state, $keycode[, $time])
		1750
		1751	=item $term->key_release ($state, $keycode[, $time])
		1752
		1753	Deliver various fake events to to terminal.
		1754
1049	=item $window_width = $term->width	1755	=item $window_width = $term->width
1050		1756
1051	=item $window_height = $term->height	1757	=item $window_height = $term->height
1052		1758
1053	=item $font_width = $term->fwidth	1759	=item $font_width = $term->fwidth
…		…
1066		1772
1067	=item $max_scrollback = $term->saveLines	1773	=item $max_scrollback = $term->saveLines
1068		1774
1069	=item $nrow_plus_saveLines = $term->total_rows	1775	=item $nrow_plus_saveLines = $term->total_rows
1070		1776
1071	=item $lines_in_scrollback = $term->nsaved	1777	=item $topmost_scrollback_row = $term->top_row
1072		1778
1073	Return various integers describing terminal characteristics.	1779	Return various integers describing terminal characteristics.
1074		1780
1075	=item $x_display = $term->display_id	1781	=item $x_display = $term->display_id
1076		1782
…		…
1083	=item $env = $term->env	1789	=item $env = $term->env
1084		1790
1085	Returns a copy of the environment in effect for the terminal as a hashref	1791	Returns a copy of the environment in effect for the terminal as a hashref
1086	similar to C<\%ENV>.	1792	similar to C<\%ENV>.
1087		1793
		1794	=item @envv = $term->envv
		1795
		1796	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1797
		1798	=item @argv = $term->argv
		1799
		1800	Return the argument vector as this terminal, similar to @ARGV, but
		1801	includes the program name as first element.
		1802
1088	=cut	1803	=cut
1089		1804
1090	sub env {	1805	sub env {
1091	if (my $env = $_[0]->_env) {
1092	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1806	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1093	} else {
1094	+{ %ENV }
1095	}
1096	}	1807	}
1097		1808
1098	=item $modifiermask = $term->ModLevel3Mask	1809	=item $modifiermask = $term->ModLevel3Mask
1099		1810
1100	=item $modifiermask = $term->ModMetaMask	1811	=item $modifiermask = $term->ModMetaMask
…		…
1102	=item $modifiermask = $term->ModNumLockMask	1813	=item $modifiermask = $term->ModNumLockMask
1103		1814
1104	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1815	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1105	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1816	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1106		1817
		1818	=item $screen = $term->current_screen
		1819
		1820	Returns the currently displayed screen (0 primary, 1 secondary).
		1821
		1822	=item $cursor_is_hidden = $term->hidden_cursor
		1823
		1824	Returns whether the cursor is currently hidden or not.
		1825
1107	=item $view_start = $term->view_start ([$newvalue])	1826	=item $view_start = $term->view_start ([$newvalue])
1108		1827
1109	Returns the negative row number of the topmost line. Minimum value is	1828	Returns the row number of the topmost displayed line. Maximum value is
1110	C<0>, which displays the normal terminal contents. Larger values scroll	1829	C<0>, which displays the normal terminal contents. Lower values scroll
1111	this many lines into the scrollback buffer.	1830	this many lines into the scrollback buffer.
1112		1831
1113	=item $term->want_refresh	1832	=item $term->want_refresh
1114		1833
1115	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1834	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1118		1837
1119	Used after changing terminal contents to display them.	1838	Used after changing terminal contents to display them.
1120		1839
1121	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1840	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1122		1841
1123	Returns the text of the entire row with number C<$row_number>. Row C<0>	1842	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1124	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1843	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1125	terminal line. The scrollback buffer starts at line C<-1> and extends to
1126	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1844	terminal line. Nothing will be returned if a nonexistent line
1127	is requested.	1845	is requested.
1128		1846
1129	If C<$new_text> is specified, it will replace characters in the current	1847	If C<$new_text> is specified, it will replace characters in the current
1130	line, starting at column C<$start_col> (default C<0>), which is useful	1848	line, starting at column C<$start_col> (default C<0>), which is useful
1131	to replace only parts of a line. The font index in the rendition will	1849	to replace only parts of a line. The font index in the rendition will
1132	automatically be updated.	1850	automatically be updated.
1133		1851
1134	C<$text> is in a special encoding: tabs and wide characters that use more	1852	C<$text> is in a special encoding: tabs and wide characters that use more
1135	than one cell when displayed are padded with urxvt::NOCHAR characters	1853	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1136	(C<chr 65535>). Characters with combining characters and other characters	1854	characters. Characters with combining characters and other characters that
1137	that do not fit into the normal tetx encoding will be replaced with	1855	do not fit into the normal text encoding will be replaced with characters
1138	characters in the private use area.	1856	in the private use area.
1139		1857
1140	You have to obey this encoding when changing text. The advantage is	1858	You have to obey this encoding when changing text. The advantage is
1141	that C<substr> and similar functions work on screen cells and not on	1859	that C<substr> and similar functions work on screen cells and not on
1142	characters.	1860	characters.
1143		1861
…		…
1194	Return the row number of the first/last row of the line, respectively.	1912	Return the row number of the first/last row of the line, respectively.
1195		1913
1196	=item $offset = $line->offset_of ($row, $col)	1914	=item $offset = $line->offset_of ($row, $col)
1197		1915
1198	Returns the character offset of the given row|col pair within the logical	1916	Returns the character offset of the given row|col pair within the logical
1199	line.	1917	line. Works for rows outside the line, too, and returns corresponding
		1918	offsets outside the string.
1200		1919
1201	=item ($row, $col) = $line->coord_of ($offset)	1920	=item ($row, $col) = $line->coord_of ($offset)
1202		1921
1203	Translates a string offset into terminal coordinates again.	1922	Translates a string offset into terminal coordinates again.
1204		1923
…		…
1286	where one character corresponds to one screen cell. See	2005	where one character corresponds to one screen cell. See
1287	C<< $term->ROW_t >> for details.	2006	C<< $term->ROW_t >> for details.
1288		2007
1289	=item $string = $term->special_decode $text	2008	=item $string = $term->special_decode $text
1290		2009
1291	Converts rxvt-unicodes text reprsentation into a perl string. See	2010	Converts rxvt-unicodes text representation into a perl string. See
1292	C<< $term->ROW_t >> for details.	2011	C<< $term->ROW_t >> for details.
1293		2012
1294	=item $success = $term->grab_button ($button, $modifiermask)	2013	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1295		2014
		2015	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2016
1296	Registers a synchronous button grab. See the XGrabButton manpage.	2017	Register/unregister a synchronous button grab. See the XGrabButton
		2018	manpage.
1297		2019
1298	=item $success = $term->grab ($eventtime[, $sync])	2020	=item $success = $term->grab ($eventtime[, $sync])
1299		2021
1300	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2022	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1301	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2023	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1302		2024
1303	=item $term->allow_events_async	2025	=item $term->allow_events_async
1304		2026
1305	Calls XAllowEvents with AsyncBoth for the most recent grab.	2027	Calls XAllowEvents with AsyncBoth for the most recent grab.
1306		2028
…		…
1313	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2035	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1314	recent grab.	2036	recent grab.
1315		2037
1316	=item $term->ungrab	2038	=item $term->ungrab
1317		2039
1318	Calls XUngrab for the most recent grab. Is called automatically on	2040	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1319	evaluation errors, as it is better to lose the grab in the error case as	2041	evaluation errors, as it is better to lose the grab in the error case as
1320	the session.	2042	the session.
		2043
		2044	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		2045
		2046	=item $atom_name = $term->XGetAtomName ($atom)
		2047
		2048	=item @atoms = $term->XListProperties ($window)
		2049
		2050	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		2051
		2052	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		2053
		2054	=item $term->XDeleteProperty ($window, $property)
		2055
		2056	=item $window = $term->DefaultRootWindow
		2057
		2058	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		2059
		2060	=item $term->XMapWindow ($window)
		2061
		2062	=item $term->XUnmapWindow ($window)
		2063
		2064	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		2065
		2066	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		2067
		2068	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2069
		2070	=item $keysym = $term->XStringToKeysym ($string)
		2071
		2072	=item $string = $term->XKeysymToString ($keysym)
		2073
		2074	Various X or X-related functions. The C<$term> object only serves as
		2075	the source of the display, otherwise those functions map more-or-less
		2076	directly onto the X functions of the same name.
1321		2077
1322	=back	2078	=back
1323		2079
1324	=cut	2080	=cut
1325		2081
…		…
1389	my ($self, $text, $cb) = @_;	2145	my ($self, $text, $cb) = @_;
1390		2146
1391	$self->add_item ({ type => "button", text => $text, activate => $cb});	2147	$self->add_item ({ type => "button", text => $text, activate => $cb});
1392	}	2148	}
1393		2149
1394	=item $popup->add_toggle ($text, $cb, $initial_value)	2150	=item $popup->add_toggle ($text, $initial_value, $cb)
1395		2151
1396	Adds a toggle/checkbox item to the popup. Teh callback gets called	2152	Adds a toggle/checkbox item to the popup. The callback gets called
1397	whenever it gets toggled, with a boolean indicating its value as its first	2153	whenever it gets toggled, with a boolean indicating its new value as its
1398	argument.	2154	first argument.
1399		2155
1400	=cut	2156	=cut
1401		2157
1402	sub add_toggle {	2158	sub add_toggle {
1403	my ($self, $text, $cb, $value) = @_;	2159	my ($self, $text, $value, $cb) = @_;
1404		2160
1405	my $item; $item = {	2161	my $item; $item = {
1406	type => "button",	2162	type => "button",
1407	text => " $text",	2163	text => " $text",
1408	value => $value,	2164	value => $value,
…		…
1427	my $env = $self->{term}->env;	2183	my $env = $self->{term}->env;
1428	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2184	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1429	delete $env->{LC_ALL};	2185	delete $env->{LC_ALL};
1430	$env->{LC_CTYPE} = $self->{term}->locale;	2186	$env->{LC_CTYPE} = $self->{term}->locale;
1431		2187
1432	urxvt::term->new ($env, $self->{term}->resource ("name"),	2188	my $term = urxvt::term->new (
1433	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2189	$env, "popup",
		2190	"--perl-lib" => "", "--perl-ext-common" => "",
		2191	"-pty-fd" => -1, "-sl" => 0,
		2192	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1434	"--transient-for" => $self->{term}->parent,	2193	"--transient-for" => $self->{term}->parent,
1435	"-display" => $self->{term}->display_id,	2194	"-display" => $self->{term}->display_id,
1436	"-pe" => "urxvt-popup")	2195	"-pe" => "urxvt-popup",
1437	or die "unable to create popup window\n";	2196	) or die "unable to create popup window\n";
		2197
		2198	unless (delete $term->{urxvt_popup_init_done}) {
		2199	$term->ungrab;
		2200	$term->destroy;
		2201	die "unable to initialise popup window\n";
		2202	}
1438	}	2203	}
1439		2204
1440	sub DESTROY {	2205	sub DESTROY {
1441	my ($self) = @_;	2206	my ($self) = @_;
1442		2207
1443	delete $self->{term}{_destroy}{$self};	2208	delete $self->{term}{_destroy}{$self};
1444	$self->{term}->ungrab;	2209	$self->{term}->ungrab;
1445	}	2210	}
		2211
		2212	=back
		2213
		2214	=cut
		2215
		2216	package urxvt::watcher;
1446		2217
1447	=head2 The C<urxvt::timer> Class	2218	=head2 The C<urxvt::timer> Class
1448		2219
1449	This class implements timer watchers/events. Time is represented as a	2220	This class implements timer watchers/events. Time is represented as a
1450	fractional number of seconds since the epoch. Example:	2221	fractional number of seconds since the epoch. Example:
…		…
1454	->new	2225	->new
1455	->interval (1)	2226	->interval (1)
1456	->cb (sub {	2227	->cb (sub {
1457	$term->{overlay}->set (0, 0,	2228	$term->{overlay}->set (0, 0,
1458	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2229	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1459	});	2230	});
1460		2231
1461	=over 4	2232	=over 4
1462		2233
1463	=item $timer = new urxvt::timer	2234	=item $timer = new urxvt::timer
1464		2235
…		…
1467		2238
1468	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2239	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1469		2240
1470	Set the callback to be called when the timer triggers.	2241	Set the callback to be called when the timer triggers.
1471		2242
1472	=item $tstamp = $timer->at
1473
1474	Return the time this watcher will fire next.
1475
1476	=item $timer = $timer->set ($tstamp)	2243	=item $timer = $timer->set ($tstamp[, $interval])
1477		2244
1478	Set the time the event is generated to $tstamp.	2245	Set the time the event is generated to $tstamp (and optionally specifies a
		2246	new $interval).
1479		2247
1480	=item $timer = $timer->interval ($interval)	2248	=item $timer = $timer->interval ($interval)
1481		2249
1482	Normally (and when C<$interval> is C<0>), the timer will automatically	2250	By default (and when C<$interval> is C<0>), the timer will automatically
1483	stop after it has fired once. If C<$interval> is non-zero, then the timer	2251	stop after it has fired once. If C<$interval> is non-zero, then the timer
1484	is automatically rescheduled at the given intervals.	2252	is automatically rescheduled at the given intervals.
1485		2253
1486	=item $timer = $timer->start	2254	=item $timer = $timer->start
1487		2255
1488	Start the timer.	2256	Start the timer.
1489		2257
1490	=item $timer = $timer->start ($tstamp)	2258	=item $timer = $timer->start ($tstamp[, $interval])
1491		2259
1492	Set the event trigger time to C<$tstamp> and start the timer.	2260	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2261	also replaces the interval.
		2262
		2263	=item $timer = $timer->after ($delay[, $interval])
		2264
		2265	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1493		2266
1494	=item $timer = $timer->stop	2267	=item $timer = $timer->stop
1495		2268
1496	Stop the timer.	2269	Stop the timer.
1497		2270
…		…
1503		2276
1504	$term->{socket} = ...	2277	$term->{socket} = ...
1505	$term->{iow} = urxvt::iow	2278	$term->{iow} = urxvt::iow
1506	->new	2279	->new
1507	->fd (fileno $term->{socket})	2280	->fd (fileno $term->{socket})
1508	->events (urxvt::EVENT_READ)	2281	->events (urxvt::EV_READ)
1509	->start	2282	->start
1510	->cb (sub {	2283	->cb (sub {
1511	my ($iow, $revents) = @_;	2284	my ($iow, $revents) = @_;
1512	# $revents must be 1 here, no need to check	2285	# $revents must be 1 here, no need to check
1513	sysread $term->{socket}, my $buf, 8192	2286	sysread $term->{socket}, my $buf, 8192
…		…
1526	Set the callback to be called when io events are triggered. C<$reventmask>	2299	Set the callback to be called when io events are triggered. C<$reventmask>
1527	is a bitset as described in the C<events> method.	2300	is a bitset as described in the C<events> method.
1528		2301
1529	=item $iow = $iow->fd ($fd)	2302	=item $iow = $iow->fd ($fd)
1530		2303
1531	Set the filedescriptor (not handle) to watch.	2304	Set the file descriptor (not handle) to watch.
1532		2305
1533	=item $iow = $iow->events ($eventmask)	2306	=item $iow = $iow->events ($eventmask)
1534		2307
1535	Set the event mask to watch. The only allowed values are	2308	Set the event mask to watch. The only allowed values are
1536	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2309	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1537	together, or C<urxvt::EVENT_NONE>.	2310	together, or C<urxvt::EV_NONE>.
1538		2311
1539	=item $iow = $iow->start	2312	=item $iow = $iow->start
1540		2313
1541	Start watching for requested events on the given handle.	2314	Start watching for requested events on the given handle.
1542		2315
1543	=item $iow = $iow->stop	2316	=item $iow = $iow->stop
1544		2317
1545	Stop watching for events on the given filehandle.	2318	Stop watching for events on the given file handle.
		2319
		2320	=back
		2321
		2322	=head2 The C<urxvt::iw> Class
		2323
		2324	This class implements idle watchers, that get called automatically when
		2325	the process is idle. They should return as fast as possible, after doing
		2326	some useful work.
		2327
		2328	=over 4
		2329
		2330	=item $iw = new urxvt::iw
		2331
		2332	Create a new idle watcher object in stopped state.
		2333
		2334	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2335
		2336	Set the callback to be called when the watcher triggers.
		2337
		2338	=item $timer = $timer->start
		2339
		2340	Start the watcher.
		2341
		2342	=item $timer = $timer->stop
		2343
		2344	Stop the watcher.
		2345
		2346	=back
		2347
		2348	=head2 The C<urxvt::pw> Class
		2349
		2350	This class implements process watchers. They create an event whenever a
		2351	process exits, after which they stop automatically.
		2352
		2353	my $pid = fork;
		2354	...
		2355	$term->{pw} = urxvt::pw
		2356	->new
		2357	->start ($pid)
		2358	->cb (sub {
		2359	my ($pw, $exit_status) = @_;
		2360	...
		2361	});
		2362
		2363	=over 4
		2364
		2365	=item $pw = new urxvt::pw
		2366
		2367	Create a new process watcher in stopped state.
		2368
		2369	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2370
		2371	Set the callback to be called when the timer triggers.
		2372
		2373	=item $pw = $timer->start ($pid)
		2374
		2375	Tells the watcher to start watching for process C<$pid>.
		2376
		2377	=item $pw = $pw->stop
		2378
		2379	Stop the watcher.
1546		2380
1547	=back	2381	=back
1548		2382
1549	=head1 ENVIRONMENT	2383	=head1 ENVIRONMENT
1550		2384
…		…
1557		2391
1558	=item == 0 - fatal messages	2392	=item == 0 - fatal messages
1559		2393
1560	=item >= 3 - script loading and management	2394	=item >= 3 - script loading and management
1561		2395
1562	=item >=10 - all events received	2396	=item >=10 - all called hooks
		2397
		2398	=item >=11 - hook return values
1563		2399
1564	=back	2400	=back
1565		2401
1566	=head1 AUTHOR	2402	=head1 AUTHOR
1567		2403
1568	Marc Lehmann <pcg@goof.com>	2404	Marc Lehmann <schmorp@schmorp.de>
1569	http://software.schmorp.de/pkg/rxvt-unicode	2405	http://software.schmorp.de/pkg/rxvt-unicode
1570		2406
1571	=cut	2407	=cut
1572		2408
1573	1	2409	1
		2410
		2411	# vim: sw=3:

Diff Legend

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