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.85 by root, Thu Jan 12 03:32:56 2006 UTC vs.
Revision 1.173 by root, Wed Nov 5 12:45:36 2008 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 and	250	Uses per-line display filtering (C<on_line_update>) to underline text
90	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
91	resource C<urlLauncher> (default C<x-www-browser>) will be started.	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 from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
92		313
93	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
94		315
95	A not very useful example of filtering all text output to the terminal,	316	A not very useful example of filtering all text output to the terminal
96	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
97	similar-looking ascii character.	318	similar-looking ascii character.
		319
		320	=item digital-clock
		321
		322	Displays a digital clock using the built-in overlay.
		323
		324	=item remote-clipboard
		325
		326	Somewhat of a misnomer, this extension adds two menu entries to the
		327	selection popup that allows one to run external commands to store the
		328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		343
		344	=item selection-pastebin
		345
		346	This is a little rarely useful extension that Uploads the selection as
		347	textfile to a remote site (or does other things). (The implementation is
		348	not currently secure for use in a multiuser environment as it writes to
		349	F</tmp> directly.).
		350
		351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		352	i.e.
		353
		354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		355
		356	Pressing this combination runs a command with C<%> replaced by the name of
		357	the textfile. This command can be set via a resource:
		358
		359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		360
		361	And the default is likely not useful to anybody but the few people around
		362	here :)
		363
		364	The name of the textfile is the hex encoded md5 sum of the selection, so
		365	the same content should lead to the same filename.
		366
		367	After a successful upload the selection will be replaced by the text given
		368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		369	for the filename):
		370
		371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of wether xrdb is used to parse the resource file
		376	or not.
98		377
99	=item example-refresh-hooks	378	=item example-refresh-hooks
100		379
101	Displays a very simple digital clock in the upper right corner of the	380	Displays a very simple digital clock in the upper right corner of the
102	window. Illustrates overwriting the refresh callbacks to create your own	381	window. Illustrates overwriting the refresh callbacks to create your own
…		…
142		421
143	=back	422	=back
144		423
145	=head2 Extension Objects	424	=head2 Extension Objects
146		425
147	Very perl extension is a perl class. A separate perl object is created	426	Every perl extension is a perl class. A separate perl object is created
148	for each terminal and each extension and passed as the first parameter to	427	for each terminal, and each terminal has its own set of extenion objects,
149	hooks. So extensions can use their C<$self> object without having to think	428	which are passed as the first parameter to hooks. So extensions can use
150	about other extensions, with the exception of methods and members that	429	their C<$self> object without having to think about clashes with other
		430	extensions or other terminals, with the exception of methods and members
151	begin with an underscore character C<_>: these are reserved for internal	431	that begin with an underscore character C<_>: these are reserved for
152	use.	432	internal use.
153		433
154	Although it isn't a C<urxvt::term> object, you can call all methods of the	434	Although it isn't a C<urxvt::term> object, you can call all methods of the
155	C<urxvt::term> class on this object.	435	C<urxvt::term> class on this object.
156		436
157	It has the following methods and data members:	437	It has the following methods and data members:
…		…
178	=head2 Hooks	458	=head2 Hooks
179		459
180	The following subroutines can be declared in extension files, and will be	460	The following subroutines can be declared in extension files, and will be
181	called whenever the relevant event happens.	461	called whenever the relevant event happens.
182		462
183	The first argument passed to them is an extension oject as described in	463	The first argument passed to them is an extension object as described in
184	the in the C<Extension Objects> section.	464	the in the C<Extension Objects> section.
185		465
186	B<All> of these hooks must return a boolean value. If it is true, then the	466	B<All> of these hooks must return a boolean value. If any of the called
187	event counts as being I<consumed>, and the invocation of other hooks is	467	hooks returns true, then the event counts as being I<consumed>, and the
188	skipped, and the relevant action might not be carried out by the C++ code.	468	relevant action might not be carried out by the C++ code.
189		469
190	I<< When in doubt, return a false value (preferably C<()>). >>	470	I<< When in doubt, return a false value (preferably C<()>). >>
191		471
192	=over 4	472	=over 4
193		473
194	=item on_init $term	474	=item on_init $term
195		475
196	Called after a new terminal object has been initialized, but before	476	Called after a new terminal object has been initialized, but before
197	windows are created or the command gets run. Most methods are unsafe to	477	windows are created or the command gets run. Most methods are unsafe to
198	call or deliver senseless data, as terminal size and other characteristics	478	call or deliver senseless data, as terminal size and other characteristics
199	have not yet been determined. You can safely query and change resources,	479	have not yet been determined. You can safely query and change resources
200	though.	480	and options, though. For many purposes the C<on_start> hook is a better
		481	place.
		482
		483	=item on_start $term
		484
		485	Called at the very end of initialisation of a new terminal, just before
		486	trying to map (display) the toplevel and returning to the main loop.
		487
		488	=item on_destroy $term
		489
		490	Called whenever something tries to destroy terminal, when the terminal is
		491	still fully functional (not for long, though).
201		492
202	=item on_reset $term	493	=item on_reset $term
203		494
204	Called after the screen is "reset" for any reason, such as resizing or	495	Called after the screen is "reset" for any reason, such as resizing or
205	control sequences. Here is where you can react on changes to size-related	496	control sequences. Here is where you can react on changes to size-related
206	variables.	497	variables.
207		498
208	=item on_start $term	499	=item on_child_start $term, $pid
209		500
210	Called at the very end of initialisation of a new terminal, just before	501	Called just after the child process has been C<fork>ed.
211	returning to the mainloop.	502
		503	=item on_child_exit $term, $status
		504
		505	Called just after the child process has exited. C<$status> is the status
		506	from C<waitpid>.
212		507
213	=item on_sel_make $term, $eventtime	508	=item on_sel_make $term, $eventtime
214		509
215	Called whenever a selection has been made by the user, but before the	510	Called whenever a selection has been made by the user, but before the
216	selection text is copied, so changes to the beginning, end or type of the	511	selection text is copied, so changes to the beginning, end or type of the
…		…
223		518
224	Called whenever a selection has been copied, but before the selection is	519	Called whenever a selection has been copied, but before the selection is
225	requested from the server. The selection text can be queried and changed	520	requested from the server. The selection text can be queried and changed
226	by calling C<< $term->selection >>.	521	by calling C<< $term->selection >>.
227		522
228	Returning a true value aborts selection grabbing. It will still be hilighted.	523	Returning a true value aborts selection grabbing. It will still be highlighted.
229		524
230	=item on_sel_extend $term	525	=item on_sel_extend $term
231		526
232	Called whenever the user tries to extend the selection (e.g. with a double	527	Called whenever the user tries to extend the selection (e.g. with a double
233	click) and is either supposed to return false (normal operation), or	528	click) and is either supposed to return false (normal operation), or
234	should extend the selection itelf and return true to suppress the built-in	529	should extend the selection itself and return true to suppress the built-in
235	processing. This can happen multiple times, as long as the callback	530	processing. This can happen multiple times, as long as the callback
236	returns true, it will be called on every further click by the user and is	531	returns true, it will be called on every further click by the user and is
237	supposed to enlarge the selection more and more, if possible.	532	supposed to enlarge the selection more and more, if possible.
238		533
239	See the F<selection> example extension.	534	See the F<selection> example extension.
240		535
241	=item on_view_change $term, $offset	536	=item on_view_change $term, $offset
242		537
243	Called whenever the view offset changes, i..e the user or program	538	Called whenever the view offset changes, i.e. the user or program
244	scrolls. Offset C<0> means display the normal terminal, positive values	539	scrolls. Offset C<0> means display the normal terminal, positive values
245	show this many lines of scrollback.	540	show this many lines of scrollback.
246		541
247	=item on_scroll_back $term, $lines, $saved	542	=item on_scroll_back $term, $lines, $saved
248		543
…		…
252		547
253	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	548	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
254	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	549	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
255	number of lines that will be in the scrollback buffer.	550	number of lines that will be in the scrollback buffer.
256		551
257	=item on_osc_seq $term, $string	552	=item on_osc_seq $term, $op, $args, $resp
		553
		554	Called on every OSC sequence and can be used to suppress it or modify its
		555	behaviour. The default should be to return an empty list. A true value
		556	suppresses execution of the request completely. Make sure you don't get
		557	confused by recursive invocations when you output an OSC sequence within
		558	this callback.
		559
		560	C<on_osc_seq_perl> should be used for new behaviour.
		561
		562	=item on_osc_seq_perl $term, $args, $resp
258		563
259	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	564	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
260	operating system command) is processed. Cursor position and other state	565	operating system command) is processed. Cursor position and other state
261	information is up-to-date when this happens. For interoperability, the	566	information is up-to-date when this happens. For interoperability, the
262	string should start with the extension name and a colon, to distinguish	567	string should start with the extension name (sans -osc) and a semicolon,
263	it from commands for other extensions, and this might be enforced in the	568	to distinguish it from commands for other extensions, and this might be
264	future.	569	enforced in the future.
		570
		571	For example, C<overlay-osc> uses this:
		572
		573	sub on_osc_seq_perl {
		574	my ($self, $osc, $resp) = @_;
		575
		576	return unless $osc =~ s/^overlay;//;
		577
		578	... process remaining $osc string
		579	}
265		580
266	Be careful not ever to trust (in a security sense) the data you receive,	581	Be careful not ever to trust (in a security sense) the data you receive,
267	as its source can not easily be controleld (e-mail content, messages from	582	as its source can not easily be controlled (e-mail content, messages from
268	other users on the same system etc.).	583	other users on the same system etc.).
		584
		585	For responses, C<$resp> contains the end-of-args separator used by the
		586	sender.
269		587
270	=item on_add_lines $term, $string	588	=item on_add_lines $term, $string
271		589
272	Called whenever text is about to be output, with the text as argument. You	590	Called whenever text is about to be output, with the text as argument. You
273	can filter/change and output the text yourself by returning a true value	591	can filter/change and output the text yourself by returning a true value
…		…
294	later with the already-modified line (e.g. if unrelated parts change), so	612	later with the already-modified line (e.g. if unrelated parts change), so
295	you cannot just toggle rendition bits, but only set them.	613	you cannot just toggle rendition bits, but only set them.
296		614
297	=item on_refresh_begin $term	615	=item on_refresh_begin $term
298		616
299	Called just before the screen gets redrawn. Can be used for overlay	617	Called just before the screen gets redrawn. Can be used for overlay or
300	or similar effects by modify terminal contents in refresh_begin, and	618	similar effects by modifying the terminal contents in refresh_begin, and
301	restoring them in refresh_end. The built-in overlay and selection display	619	restoring them in refresh_end. The built-in overlay and selection display
302	code is run after this hook, and takes precedence.	620	code is run after this hook, and takes precedence.
303		621
304	=item on_refresh_end $term	622	=item on_refresh_end $term
305		623
306	Called just after the screen gets redrawn. See C<on_refresh_begin>.	624	Called just after the screen gets redrawn. See C<on_refresh_begin>.
307		625
308	=item on_keyboard_command $term, $string	626	=item on_user_command $term, $string
309		627
310	Called whenever the user presses a key combination that has a	628	Called whenever a user-configured event is being activated (e.g. via
311	C<perl:string> action bound to it (see description of the B<keysym>	629	a C<perl:string> action bound to a key, see description of the B<keysym>
312	resource in the @@RXVT_NAME@@(1) manpage).	630	resource in the @@RXVT_NAME@@(1) manpage).
		631
		632	The event is simply the action string. This interface is assumed to change
		633	slightly in the future.
		634
		635	=item on_resize_all_windows $tern, $new_width, $new_height
		636
		637	Called just after the new window size has been calculated, but before
		638	windows are actually being resized or hints are being set. If this hook
		639	returns TRUE, setting of the window hints is being skipped.
		640
		641	=item on_x_event $term, $event
		642
		643	Called on every X event received on the vt window (and possibly other
		644	windows). Should only be used as a last resort. Most event structure
		645	members are not passed.
		646
		647	=item on_root_event $term, $event
		648
		649	Like C<on_x_event>, but is called for events on the root window.
313		650
314	=item on_focus_in $term	651	=item on_focus_in $term
315		652
316	Called whenever the window gets the keyboard focus, before rxvt-unicode	653	Called whenever the window gets the keyboard focus, before rxvt-unicode
317	does focus in processing.	654	does focus in processing.
318		655
319	=item on_focus_out $term	656	=item on_focus_out $term
320		657
321	Called wheneever the window loses keyboard focus, before rxvt-unicode does	658	Called whenever the window loses keyboard focus, before rxvt-unicode does
322	focus out processing.	659	focus out processing.
		660
		661	=item on_configure_notify $term, $event
		662
		663	=item on_property_notify $term, $event
323		664
324	=item on_key_press $term, $event, $keysym, $octets	665	=item on_key_press $term, $event, $keysym, $octets
325		666
326	=item on_key_release $term, $event, $keysym	667	=item on_key_release $term, $event, $keysym
327		668
…		…
337		678
338	Called whenever the corresponding X event is received for the terminal If	679	Called whenever the corresponding X event is received for the terminal If
339	the hook returns true, then the even will be ignored by rxvt-unicode.	680	the hook returns true, then the even will be ignored by rxvt-unicode.
340		681
341	The event is a hash with most values as named by Xlib (see the XEvent	682	The event is a hash with most values as named by Xlib (see the XEvent
342	manpage), with the additional members C<row> and C<col>, which are the row	683	manpage), with the additional members C<row> and C<col>, which are the
343	and column under the mouse cursor.	684	(real, not screen-based) row and column under the mouse cursor.
344		685
345	C<on_key_press> additionally receives the string rxvt-unicode would	686	C<on_key_press> additionally receives the string rxvt-unicode would
346	output, if any, in locale-specific encoding.	687	output, if any, in locale-specific encoding.
347		688
348	subwindow.	689	subwindow.
		690
		691	=item on_client_message $term, $event
		692
		693	=item on_wm_protocols $term, $event
		694
		695	=item on_wm_delete_window $term, $event
		696
		697	Called when various types of ClientMessage events are received (all with
		698	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
349		699
350	=back	700	=back
351		701
352	=cut	702	=cut
353		703
…		…
359	use Scalar::Util ();	709	use Scalar::Util ();
360	use List::Util ();	710	use List::Util ();
361		711
362	our $VERSION = 1;	712	our $VERSION = 1;
363	our $TERM;	713	our $TERM;
		714	our @TERM_INIT;
		715	our @TERM_EXT;
364	our @HOOKNAME;	716	our @HOOKNAME;
365	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	717	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
366	our %OPTION;	718	our %OPTION;
367		719
368	our $LIBDIR;	720	our $LIBDIR;
369	our $RESNAME;	721	our $RESNAME;
370	our $RESCLASS;	722	our $RESCLASS;
371	our $RXVTNAME;	723	our $RXVTNAME;
372		724
		725	our $NOCHAR = chr 0xffff;
		726
373	=head2 Variables in the C<urxvt> Package	727	=head2 Variables in the C<urxvt> Package
374		728
375	=over 4	729	=over 4
376		730
377	=item $urxvt::LIBDIR	731	=item $urxvt::LIBDIR
…		…
389		743
390	=item $urxvt::TERM	744	=item $urxvt::TERM
391		745
392	The current terminal. This variable stores the current C<urxvt::term>	746	The current terminal. This variable stores the current C<urxvt::term>
393	object, whenever a callback/hook is executing.	747	object, whenever a callback/hook is executing.
		748
		749	=item @urxvt::TERM_INIT
		750
		751	All code references in this array will be called as methods of the next newly
		752	created C<urxvt::term> object (during the C<on_init> phase). The array
		753	gets cleared before the code references that were in it are being executed,
		754	so references can push themselves onto it again if they so desire.
		755
		756	This complements to the perl-eval command line option, but gets executed
		757	first.
		758
		759	=item @urxvt::TERM_EXT
		760
		761	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		762	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		763	but before other extensions. Gets cleared just like C<@TERM_INIT>.
394		764
395	=back	765	=back
396		766
397	=head2 Functions in the C<urxvt> Package	767	=head2 Functions in the C<urxvt> Package
398		768
…		…
413	Using this function has the advantage that its output ends up in the	783	Using this function has the advantage that its output ends up in the
414	correct place, e.g. on stderr of the connecting urxvtc client.	784	correct place, e.g. on stderr of the connecting urxvtc client.
415		785
416	Messages have a size limit of 1023 bytes currently.	786	Messages have a size limit of 1023 bytes currently.
417		787
418	=item $is_safe = urxvt::safe	788	=item @terms = urxvt::termlist
419		789
420	Returns true when it is safe to do potentially unsafe things, such as	790	Returns all urxvt::term objects that exist in this process, regardless of
421	evaluating perl code specified by the user. This is true when urxvt was	791	whether they are started, being destroyed etc., so be careful. Only term
422	started setuid or setgid.	792	objects that have perl extensions attached will be returned (because there
		793	is no urxvt::term objet associated with others).
423		794
424	=item $time = urxvt::NOW	795	=item $time = urxvt::NOW
425		796
426	Returns the "current time" (as per the event loop).	797	Returns the "current time" (as per the event loop).
427		798
428	=item urxvt::CurrentTime	799	=item urxvt::CurrentTime
429		800
430	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	801	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
431	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	802	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
432	Button4Mask, Button5Mask, AnyModifier	803	Button4Mask, Button5Mask, AnyModifier
		804
		805	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		806	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		807	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		808	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		809	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		810	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		811	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		812
		813	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		814	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		815	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		816	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		817	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		818	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		819	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
433		820
434	Various constants for use in X calls and event processing.	821	Various constants for use in X calls and event processing.
435		822
436	=back	823	=back
437		824
…		…
470		857
471	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	858	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
472		859
473	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	860	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
474		861
		862	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		863
475	Replace the foreground/background colour in the rendition mask with the	864	Replace the foreground/background colour in the rendition mask with the
476	specified one.	865	specified one.
477		866
478	=item $value = urxvt::GET_CUSTOM $rend	867	=item $value = urxvt::GET_CUSTOM $rend
479		868
…		…
488	=back	877	=back
489		878
490	=cut	879	=cut
491		880
492	BEGIN {	881	BEGIN {
493	urxvt->bootstrap;
494
495	# overwrite perl's warn	882	# overwrite perl's warn
496	*CORE::GLOBAL::warn = sub {	883	*CORE::GLOBAL::warn = sub {
497	my $msg = join "", @_;	884	my $msg = join "", @_;
498	$msg .= "\n"	885	$msg .= "\n"
499	unless $msg =~ /\n$/;	886	unless $msg =~ /\n$/;
500	urxvt::warn ($msg);	887	urxvt::warn ($msg);
501	};	888	};
502
503	# %ENV is the original startup environment
504	delete $ENV{IFS};
505	delete $ENV{CDPATH};
506	delete $ENV{BASH_ENV};
507	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
508	}	889	}
509		890
510	my @hook_count;	891	no warnings 'utf8';
		892
511	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	893	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
512		894
513	sub verbose {	895	sub verbose {
514	my ($level, $msg) = @_;	896	my ($level, $msg) = @_;
515	warn "$msg\n" if $level <= $verbosity;	897	warn "$msg\n" if $level <= $verbosity;
516	}	898	}
517		899
518	my $extension_pkg = "extension0000";
519	my %extension_pkg;	900	my %extension_pkg;
520		901
521	# load a single script into its own package, once only	902	# load a single script into its own package, once only
522	sub extension_package($) {	903	sub extension_package($) {
523	my ($path) = @_;	904	my ($path) = @_;
524		905
525	$extension_pkg{$path} ||= do {	906	$extension_pkg{$path} ||= do {
526	my $pkg = "urxvt::" . ($extension_pkg++);	907	$path =~ /([^\/\\]+)$/;
		908	my $pkg = $1;
		909	$pkg =~ s/[^[:word:]]/_/g;
		910	$pkg = "urxvt::ext::$pkg";
527		911
528	verbose 3, "loading extension '$path' into package '$pkg'";	912	verbose 3, "loading extension '$path' into package '$pkg'";
529		913
530	open my $fh, "<:raw", $path	914	open my $fh, "<:raw", $path
531	or die "$path: $!";	915	or die "$path: $!";
532		916
533	my $source = untaint	917	my $source =
534	"package $pkg; use strict; use utf8;\n"	918	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
535	. "use base urxvt::term::extension::;\n"
536	. "#line 1 \"$path\"\n{\n"	919	. "#line 1 \"$path\"\n{\n"
537	. (do { local $/; <$fh> })	920	. (do { local $/; <$fh> })
538	. "\n};\n1";	921	. "\n};\n1";
539		922
540	eval $source	923	eval $source
…		…
551	local $TERM = shift;	934	local $TERM = shift;
552	my $htype = shift;	935	my $htype = shift;
553		936
554	if ($htype == 0) { # INIT	937	if ($htype == 0) { # INIT
555	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	938	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
556		939
557	my %ext_arg;	940	my %ext_arg;
558		941
		942	{
		943	my @init = @TERM_INIT;
		944	@TERM_INIT = ();
		945	$_->($TERM) for @init;
		946	my @pkg = @TERM_EXT;
		947	@TERM_EXT = ();
		948	$TERM->register_package ($_) for @pkg;
		949	}
		950
559	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	951	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
560	if ($_ eq "default") {	952	if ($_ eq "default") {
561	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	953	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
562	} elsif (/^-(.*)$/) {	954	} elsif (/^-(.*)$/) {
563	delete $ext_arg{$1};	955	delete $ext_arg{$1};
564	} elsif (/^([^<]+)<(.*)>$/) {	956	} elsif (/^([^<]+)<(.*)>$/) {
565	push @{ $ext_arg{$1} }, $2;	957	push @{ $ext_arg{$1} }, $2;
566	} else {	958	} else {
567	$ext_arg{$_} ||= [];	959	$ext_arg{$_} ||= [];
568	}	960	}
569	}	961	}
570		962
571	while (my ($ext, $argv) = each %ext_arg) {	963	for my $ext (sort keys %ext_arg) {
572	my @files = grep -f $_, map "$_/$ext", @dirs;	964	my @files = grep -f $_, map "$_/$ext", @dirs;
573		965
574	if (@files) {	966	if (@files) {
575	$TERM->register_package (extension_package $files[0], $argv);	967	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
576	} else {	968	} else {
577	warn "perl extension '$ext' not found in perl library search path\n";	969	warn "perl extension '$ext' not found in perl library search path\n";
578	}	970	}
579	}	971	}
580		972
…		…
586		978
587	if (my $cb = $TERM->{_hook}[$htype]) {	979	if (my $cb = $TERM->{_hook}[$htype]) {
588	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	980	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
589	if $verbosity >= 10;	981	if $verbosity >= 10;
590		982
591	keys %$cb;	983	for my $pkg (keys %$cb) {
592
593	while (my ($pkg, $cb) = each %$cb) {
594	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	984	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
595	and last;	985	$retval ||= $retval_;
596		986
597	if ($@) {	987	if ($@) {
598	$TERM->ungrab; # better to lose the grab than the session	988	$TERM->ungrab; # better to lose the grab than the session
599	warn $@;	989	warn $@;
600	}	990	}
…		…
603	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	993	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
604	if $verbosity >= 11;	994	if $verbosity >= 11;
605	}	995	}
606		996
607	if ($htype == 1) { # DESTROY	997	if ($htype == 1) { # DESTROY
608	if (my $hook = delete $TERM->{_hook}) {
609	for my $htype (0..$#$hook) {
610	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
611	or set_should_invoke $htype, 0;
612	}
613	}
614
615	# clear package objects	998	# clear package objects
616	%$_ = () for values %{ $TERM->{_pkg} };	999	%$_ = () for values %{ $TERM->{_pkg} };
617		1000
618	# clear package	1001	# clear package
619	%$TERM = ();	1002	%$TERM = ();
620	}	1003	}
621		1004
622	$retval	1005	$retval
623	}	1006	}
624		1007
625	sub exec_async(@) {	1008	sub SET_COLOR($$$) {
626	my $pid = fork;	1009	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1010	}
627		1011
628	return	1012	sub rend2mask {
629	if !defined $pid or $pid;	1013	no strict 'refs';
630		1014	my ($str, $mask) = (@_, 0);
631	%ENV = %{ $TERM->env };	1015	my %color = ( fg => undef, bg => undef );
632		1016	my @failed;
633	exec @_;	1017	for my $spec ( split /\s+/, $str ) {
634	_exit 255;	1018	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1019	$color{lc($1)} = $2;
		1020	} else {
		1021	my $neg = $spec =~ s/^[-^]//;
		1022	unless ( exists &{"RS_$spec"} ) {
		1023	push @failed, $spec;
		1024	next;
		1025	}
		1026	my $cur = &{"RS_$spec"};
		1027	if ( $neg ) {
		1028	$mask &= ~$cur;
		1029	} else {
		1030	$mask |= $cur;
		1031	}
		1032	}
		1033	}
		1034	($mask, @color{qw(fg bg)}, \@failed)
635	}	1035	}
636		1036
637	# urxvt::term::extension	1037	# urxvt::term::extension
638		1038
639	package urxvt::term::extension;	1039	package urxvt::term::extension;
…		…
645	while (my ($name, $cb) = each %hook) {	1045	while (my ($name, $cb) = each %hook) {
646	my $htype = $HOOKTYPE{uc $name};	1046	my $htype = $HOOKTYPE{uc $name};
647	defined $htype	1047	defined $htype
648	or Carp::croak "unsupported hook type '$name'";	1048	or Carp::croak "unsupported hook type '$name'";
649		1049
		1050	$self->set_should_invoke ($htype, +1)
650	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1051	unless exists $self->{term}{_hook}[$htype]{$pkg};
651	$hook_count[$htype]++
652	or urxvt::set_should_invoke $htype, 1;
653	}
654		1052
655	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1053	$self->{term}{_hook}[$htype]{$pkg} = $cb;
656	}	1054	}
657	}	1055	}
658		1056
…		…
663	for my $name (@hook) {	1061	for my $name (@hook) {
664	my $htype = $HOOKTYPE{uc $name};	1062	my $htype = $HOOKTYPE{uc $name};
665	defined $htype	1063	defined $htype
666	or Carp::croak "unsupported hook type '$name'";	1064	or Carp::croak "unsupported hook type '$name'";
667		1065
		1066	$self->set_should_invoke ($htype, -1)
668	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1067	if delete $self->{term}{_hook}[$htype]{$pkg};
669	--$hook_count[$htype]
670	or urxvt::set_should_invoke $htype, 0;
671	}
672	}	1068	}
673	}	1069	}
674		1070
675	our $AUTOLOAD;	1071	our $AUTOLOAD;
676		1072
…		…
714	is that you cannot use blocking APIs, but the non-blocking variant should	1110	is that you cannot use blocking APIs, but the non-blocking variant should
715	work.	1111	work.
716		1112
717	=cut	1113	=cut
718		1114
719	our $VERSION = 1;	1115	our $VERSION = '3.4';
720		1116
721	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1117	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
722	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1118	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
723		1119
724	sub timer {	1120	sub timer {
…		…
755		1151
756	sub DESTROY {	1152	sub DESTROY {
757	$_[0][1]->stop;	1153	$_[0][1]->stop;
758	}	1154	}
759		1155
760	sub condvar {	1156	sub one_event {
761	bless \my $flag, urxvt::anyevent::condvar::
762	}
763
764	sub urxvt::anyevent::condvar::broadcast {
765	${$_[0]}++;
766	}
767
768	sub urxvt::anyevent::condvar::wait {
769	unless (${$_[0]}) {
770	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1157	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
771	}
772	}	1158	}
773		1159
774	package urxvt::term;	1160	package urxvt::term;
775		1161
776	=head2 The C<urxvt::term> Class	1162	=head2 The C<urxvt::term> Class
…		…
781		1167
782	# find on_xxx subs in the package and register them	1168	# find on_xxx subs in the package and register them
783	# as hooks	1169	# as hooks
784	sub register_package {	1170	sub register_package {
785	my ($self, $pkg, $argv) = @_;	1171	my ($self, $pkg, $argv) = @_;
		1172
		1173	no strict 'refs';
		1174
		1175	urxvt::verbose 6, "register package $pkg to $self";
		1176
		1177	@{"$pkg\::ISA"} = urxvt::term::extension::;
786		1178
787	my $proxy = bless {	1179	my $proxy = bless {
788	_pkg => $pkg,	1180	_pkg => $pkg,
789	argv => $argv,	1181	argv => $argv,
790	}, $pkg;	1182	}, $pkg;
…		…
806	hash which defines the environment of the new terminal.	1198	hash which defines the environment of the new terminal.
807		1199
808	Croaks (and probably outputs an error message) if the new instance	1200	Croaks (and probably outputs an error message) if the new instance
809	couldn't be created. Returns C<undef> if the new instance didn't	1201	couldn't be created. Returns C<undef> if the new instance didn't
810	initialise perl, and the terminal object otherwise. The C<init> and	1202	initialise perl, and the terminal object otherwise. The C<init> and
811	C<start> hooks will be called during this call.	1203	C<start> hooks will be called before this call returns, and are free to
		1204	refer to global data (which is race free).
812		1205
813	=cut	1206	=cut
814		1207
815	sub new {	1208	sub new {
816	my ($class, $env, @args) = @_;	1209	my ($class, $env, @args) = @_;
817		1210
		1211	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1212	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1213
818	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1214	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
819	}	1215	}
820		1216
821	=item $term->destroy	1217	=item $term->destroy
822		1218
823	Destroy the terminal object (close the window, free resources	1219	Destroy the terminal object (close the window, free resources
824	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1220	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
825	watchers (timers, io watchers) are still active.	1221	watchers (timers, io watchers) are still active.
826		1222
		1223	=item $term->exec_async ($cmd[, @args])
		1224
		1225	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1226	("starts") programs in the background. This function takes care of setting
		1227	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1228	be preferred over explicit calls to C<exec> or C<system>.
		1229
		1230	Returns the pid of the subprocess or C<undef> on error.
		1231
		1232	=cut
		1233
		1234	sub exec_async {
		1235	my $self = shift;
		1236
		1237	my $pid = fork;
		1238
		1239	return $pid
		1240	if !defined $pid or $pid;
		1241
		1242	%ENV = %{ $self->env };
		1243
		1244	exec @_;
		1245	urxvt::_exit 255;
		1246	}
		1247
827	=item $isset = $term->option ($optval[, $set])	1248	=item $isset = $term->option ($optval[, $set])
828		1249
829	Returns true if the option specified by C<$optval> is enabled, and	1250	Returns true if the option specified by C<$optval> is enabled, and
830	optionally change it. All option values are stored by name in the hash	1251	optionally change it. All option values are stored by name in the hash
831	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1252	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
832		1253
833	Here is a a likely non-exhaustive list of option names, please see the	1254	Here is a likely non-exhaustive list of option names, please see the
834	source file F</src/optinc.h> to see the actual list:	1255	source file F</src/optinc.h> to see the actual list:
835		1256
836	borderLess console cursorBlink cursorUnderline hold iconic insecure	1257	borderLess console cursorBlink cursorUnderline hold iconic insecure
837	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1258	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
838	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1259	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
839	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1260	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
840	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1261	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
841	tripleclickwords utmpInhibit visualBell	1262	transparent tripleclickwords utmpInhibit visualBell
842		1263
843	=item $value = $term->resource ($name[, $newval])	1264	=item $value = $term->resource ($name[, $newval])
844		1265
845	Returns the current resource value associated with a given name and	1266	Returns the current resource value associated with a given name and
846	optionally sets a new value. Setting values is most useful in the C<init>	1267	optionally sets a new value. Setting values is most useful in the C<init>
…		…
855	likely change).	1276	likely change).
856		1277
857	Please note that resource strings will currently only be freed when the	1278	Please note that resource strings will currently only be freed when the
858	terminal is destroyed, so changing options frequently will eat memory.	1279	terminal is destroyed, so changing options frequently will eat memory.
859		1280
860	Here is a a likely non-exhaustive list of resource names, not all of which	1281	Here is a likely non-exhaustive list of resource names, not all of which
861	are supported in every build, please see the source file F</src/rsinc.h>	1282	are supported in every build, please see the source file F</src/rsinc.h>
862	to see the actual list:	1283	to see the actual list:
863		1284
864	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1285	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
865	borderLess color cursorBlink cursorUnderline cutchars delete_key	1286	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
866	display_name embed ext_bwidth fade font geometry hold iconName	1287	display_name embed ext_bwidth fade font geometry hold iconName
867	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1288	imFont imLocale inputMethod insecure int_bwidth intensityStyles
868	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1289	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
869	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1290	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
870	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1291	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
871	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1292	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
872	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1293	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
873	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1294	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
874	shade term_name title transparent transparent_all tripleclickwords	1295	secondaryScreen secondaryScroll shade term_name title
875	utmpInhibit visualBell	1296	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1297	visualBell
876		1298
877	=cut	1299	=cut
878		1300
879	sub resource($$;$) {	1301	sub resource($$;$) {
880	my ($self, $name) = (shift, shift);	1302	my ($self, $name) = (shift, shift);
881	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1303	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
882	&urxvt::term::_resource	1304	goto &urxvt::term::_resource
883	}	1305	}
884		1306
885	=item $value = $term->x_resource ($pattern)	1307	=item $value = $term->x_resource ($pattern)
886		1308
887	Returns the X-Resource for the given pattern, excluding the program or	1309	Returns the X-Resource for the given pattern, excluding the program or
…		…
915	=item ($row, $col) = $term->selection_end ([$row, $col])	1337	=item ($row, $col) = $term->selection_end ([$row, $col])
916		1338
917	Return the current values of the selection mark, begin or end positions,	1339	Return the current values of the selection mark, begin or end positions,
918	and optionally set them to new values.	1340	and optionally set them to new values.
919		1341
		1342	=item $term->selection_make ($eventtime[, $rectangular])
		1343
		1344	Tries to make a selection as set by C<selection_beg> and
		1345	C<selection_end>. If C<$rectangular> is true (default: false), a
		1346	rectangular selection will be made. This is the prefered function to make
		1347	a selection.
		1348
920	=item $success = $term->selection_grab ($eventtime)	1349	=item $success = $term->selection_grab ($eventtime)
921		1350
922	Try to request the primary selection from the server (for example, as set	1351	Try to request the primary selection text from the server (for example, as
923	by the next method).	1352	set by the next method). No visual feedback will be given. This function
		1353	is mostly useful from within C<on_sel_grab> hooks.
924		1354
925	=item $oldtext = $term->selection ([$newtext])	1355	=item $oldtext = $term->selection ([$newtext])
926		1356
927	Return the current selection text and optionally replace it by C<$newtext>.	1357	Return the current selection text and optionally replace it by C<$newtext>.
928		1358
…		…
962		1392
963	The methods currently supported on C<urxvt::overlay> objects are:	1393	The methods currently supported on C<urxvt::overlay> objects are:
964		1394
965	=over 4	1395	=over 4
966		1396
967	=item $overlay->set ($x, $y, $text, $rend)	1397	=item $overlay->set ($x, $y, $text[, $rend])
968		1398
969	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1399	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
970	text in rxvt-unicode's special encoding and an array of rendition values	1400	text in rxvt-unicode's special encoding and an array of rendition values
971	at a specific position inside the overlay.	1401	at a specific position inside the overlay.
		1402
		1403	If C<$rend> is missing, then the rendition will not be changed.
972		1404
973	=item $overlay->hide	1405	=item $overlay->hide
974		1406
975	If visible, hide the overlay, but do not destroy it.	1407	If visible, hide the overlay, but do not destroy it.
976		1408
…		…
1021	Convert the given locale-encoded octets into a perl string.	1453	Convert the given locale-encoded octets into a perl string.
1022		1454
1023	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1455	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1024		1456
1025	XORs the rendition values in the given span with the provided value	1457	XORs the rendition values in the given span with the provided value
1026	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1458	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1027	to the selection.	1459	refresh hooks to provide effects similar to the selection.
1028		1460
1029	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1461	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1030		1462
1031	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1463	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1032	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1464	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1033	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1465	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1034	it instead.	1466	it instead. Both styles I<MUST NOT> contain font styles.
1035		1467
1036	=item $term->scr_bell	1468	=item $term->scr_bell
1037		1469
1038	Ring the bell!	1470	Ring the bell!
1039		1471
…		…
1046		1478
1047	Normally its not a good idea to use this function, as programs might be	1479	Normally its not a good idea to use this function, as programs might be
1048	confused by changes in cursor position or scrolling. Its useful inside a	1480	confused by changes in cursor position or scrolling. Its useful inside a
1049	C<on_add_lines> hook, though.	1481	C<on_add_lines> hook, though.
1050		1482
		1483	=item $term->scr_change_screen ($screen)
		1484
		1485	Switch to given screen - 0 primary, 1 secondary.
		1486
1051	=item $term->cmd_parse ($octets)	1487	=item $term->cmd_parse ($octets)
1052		1488
1053	Similar to C<scr_add_lines>, but the argument must be in the	1489	Similar to C<scr_add_lines>, but the argument must be in the
1054	locale-specific encoding of the terminal and can contain command sequences	1490	locale-specific encoding of the terminal and can contain command sequences
1055	(escape codes) that will be interpreted.	1491	(escape codes) that will be interpreted.
…		…
1065	Replaces the event mask of the pty watcher by the given event mask. Can	1501	Replaces the event mask of the pty watcher by the given event mask. Can
1066	be used to suppress input and output handling to the pty/tty. See the	1502	be used to suppress input and output handling to the pty/tty. See the
1067	description of C<< urxvt::timer->events >>. Make sure to always restore	1503	description of C<< urxvt::timer->events >>. Make sure to always restore
1068	the previous value.	1504	the previous value.
1069		1505
		1506	=item $fd = $term->pty_fd
		1507
		1508	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1509	is used.
		1510
1070	=item $windowid = $term->parent	1511	=item $windowid = $term->parent
1071		1512
1072	Return the window id of the toplevel window.	1513	Return the window id of the toplevel window.
1073		1514
1074	=item $windowid = $term->vt	1515	=item $windowid = $term->vt
1075		1516
1076	Return the window id of the terminal window.	1517	Return the window id of the terminal window.
1077		1518
		1519	=item $term->vt_emask_add ($x_event_mask)
		1520
		1521	Adds the specified events to the vt event mask. Useful e.g. when you want
		1522	to receive pointer events all the times:
		1523
		1524	$term->vt_emask_add (urxvt::PointerMotionMask);
		1525
		1526	=item $term->focus_in
		1527
		1528	=item $term->focus_out
		1529
		1530	=item $term->key_press ($state, $keycode[, $time])
		1531
		1532	=item $term->key_release ($state, $keycode[, $time])
		1533
		1534	Deliver various fake events to to terminal.
		1535
1078	=item $window_width = $term->width	1536	=item $window_width = $term->width
1079		1537
1080	=item $window_height = $term->height	1538	=item $window_height = $term->height
1081		1539
1082	=item $font_width = $term->fwidth	1540	=item $font_width = $term->fwidth
…		…
1095		1553
1096	=item $max_scrollback = $term->saveLines	1554	=item $max_scrollback = $term->saveLines
1097		1555
1098	=item $nrow_plus_saveLines = $term->total_rows	1556	=item $nrow_plus_saveLines = $term->total_rows
1099		1557
1100	=item $lines_in_scrollback = $term->nsaved	1558	=item $topmost_scrollback_row = $term->top_row
1101		1559
1102	Return various integers describing terminal characteristics.	1560	Return various integers describing terminal characteristics.
1103		1561
1104	=item $x_display = $term->display_id	1562	=item $x_display = $term->display_id
1105		1563
…		…
1112	=item $env = $term->env	1570	=item $env = $term->env
1113		1571
1114	Returns a copy of the environment in effect for the terminal as a hashref	1572	Returns a copy of the environment in effect for the terminal as a hashref
1115	similar to C<\%ENV>.	1573	similar to C<\%ENV>.
1116		1574
		1575	=item @envv = $term->envv
		1576
		1577	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1578
		1579	=item @argv = $term->argv
		1580
		1581	Return the argument vector as this terminal, similar to @ARGV, but
		1582	includes the program name as first element.
		1583
1117	=cut	1584	=cut
1118		1585
1119	sub env {	1586	sub env {
1120	if (my $env = $_[0]->_env) {
1121	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1587	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1122	} else {
1123	+{ %ENV }
1124	}
1125	}	1588	}
1126		1589
1127	=item $modifiermask = $term->ModLevel3Mask	1590	=item $modifiermask = $term->ModLevel3Mask
1128		1591
1129	=item $modifiermask = $term->ModMetaMask	1592	=item $modifiermask = $term->ModMetaMask
…		…
1131	=item $modifiermask = $term->ModNumLockMask	1594	=item $modifiermask = $term->ModNumLockMask
1132		1595
1133	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1596	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1134	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1597	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1135		1598
		1599	=item $screen = $term->current_screen
		1600
		1601	Returns the currently displayed screen (0 primary, 1 secondary).
		1602
		1603	=item $cursor_is_hidden = $term->hidden_cursor
		1604
		1605	Returns whether the cursor is currently hidden or not.
		1606
1136	=item $view_start = $term->view_start ([$newvalue])	1607	=item $view_start = $term->view_start ([$newvalue])
1137		1608
1138	Returns the negative row number of the topmost line. Minimum value is	1609	Returns the row number of the topmost displayed line. Maximum value is
1139	C<0>, which displays the normal terminal contents. Larger values scroll	1610	C<0>, which displays the normal terminal contents. Lower values scroll
1140	this many lines into the scrollback buffer.	1611	this many lines into the scrollback buffer.
1141		1612
1142	=item $term->want_refresh	1613	=item $term->want_refresh
1143		1614
1144	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1615	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1147		1618
1148	Used after changing terminal contents to display them.	1619	Used after changing terminal contents to display them.
1149		1620
1150	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1621	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1151		1622
1152	Returns the text of the entire row with number C<$row_number>. Row C<0>	1623	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1153	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1624	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1154	terminal line. The scrollback buffer starts at line C<-1> and extends to
1155	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1625	terminal line. Nothing will be returned if a nonexistent line
1156	is requested.	1626	is requested.
1157		1627
1158	If C<$new_text> is specified, it will replace characters in the current	1628	If C<$new_text> is specified, it will replace characters in the current
1159	line, starting at column C<$start_col> (default C<0>), which is useful	1629	line, starting at column C<$start_col> (default C<0>), which is useful
1160	to replace only parts of a line. The font index in the rendition will	1630	to replace only parts of a line. The font index in the rendition will
1161	automatically be updated.	1631	automatically be updated.
1162		1632
1163	C<$text> is in a special encoding: tabs and wide characters that use more	1633	C<$text> is in a special encoding: tabs and wide characters that use more
1164	than one cell when displayed are padded with urxvt::NOCHAR characters	1634	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1165	(C<chr 65535>). Characters with combining characters and other characters	1635	characters. Characters with combining characters and other characters that
1166	that do not fit into the normal tetx encoding will be replaced with	1636	do not fit into the normal text encoding will be replaced with characters
1167	characters in the private use area.	1637	in the private use area.
1168		1638
1169	You have to obey this encoding when changing text. The advantage is	1639	You have to obey this encoding when changing text. The advantage is
1170	that C<substr> and similar functions work on screen cells and not on	1640	that C<substr> and similar functions work on screen cells and not on
1171	characters.	1641	characters.
1172		1642
…		…
1316	where one character corresponds to one screen cell. See	1786	where one character corresponds to one screen cell. See
1317	C<< $term->ROW_t >> for details.	1787	C<< $term->ROW_t >> for details.
1318		1788
1319	=item $string = $term->special_decode $text	1789	=item $string = $term->special_decode $text
1320		1790
1321	Converts rxvt-unicodes text reprsentation into a perl string. See	1791	Converts rxvt-unicodes text representation into a perl string. See
1322	C<< $term->ROW_t >> for details.	1792	C<< $term->ROW_t >> for details.
1323		1793
1324	=item $success = $term->grab_button ($button, $modifiermask)	1794	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1325		1795
		1796	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1797
1326	Registers a synchronous button grab. See the XGrabButton manpage.	1798	Register/unregister a synchronous button grab. See the XGrabButton
		1799	manpage.
1327		1800
1328	=item $success = $term->grab ($eventtime[, $sync])	1801	=item $success = $term->grab ($eventtime[, $sync])
1329		1802
1330	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1803	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1331	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1804	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1332		1805
1333	=item $term->allow_events_async	1806	=item $term->allow_events_async
1334		1807
1335	Calls XAllowEvents with AsyncBoth for the most recent grab.	1808	Calls XAllowEvents with AsyncBoth for the most recent grab.
1336		1809
…		…
1346	=item $term->ungrab	1819	=item $term->ungrab
1347		1820
1348	Calls XUngrab for the most recent grab. Is called automatically on	1821	Calls XUngrab for the most recent grab. Is called automatically on
1349	evaluation errors, as it is better to lose the grab in the error case as	1822	evaluation errors, as it is better to lose the grab in the error case as
1350	the session.	1823	the session.
		1824
		1825	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1826
		1827	=item $atom_name = $term->XGetAtomName ($atom)
		1828
		1829	=item @atoms = $term->XListProperties ($window)
		1830
		1831	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1832
		1833	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1834
		1835	=item $term->XDeleteProperty ($window, $property)
		1836
		1837	=item $window = $term->DefaultRootWindow
		1838
		1839	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1840
		1841	=item $term->XMapWindow ($window)
		1842
		1843	=item $term->XUnmapWindow ($window)
		1844
		1845	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1846
		1847	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1848
		1849	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1850
		1851	Various X or X-related functions. The C<$term> object only serves as
		1852	the source of the display, otherwise those functions map more-or-less
		1853	directory onto the X functions of the same name.
1351		1854
1352	=back	1855	=back
1353		1856
1354	=cut	1857	=cut
1355		1858
…		…
1419	my ($self, $text, $cb) = @_;	1922	my ($self, $text, $cb) = @_;
1420		1923
1421	$self->add_item ({ type => "button", text => $text, activate => $cb});	1924	$self->add_item ({ type => "button", text => $text, activate => $cb});
1422	}	1925	}
1423		1926
1424	=item $popup->add_toggle ($text, $cb, $initial_value)	1927	=item $popup->add_toggle ($text, $initial_value, $cb)
1425		1928
1426	Adds a toggle/checkbox item to the popup. Teh callback gets called	1929	Adds a toggle/checkbox item to the popup. The callback gets called
1427	whenever it gets toggled, with a boolean indicating its value as its first	1930	whenever it gets toggled, with a boolean indicating its new value as its
1428	argument.	1931	first argument.
1429		1932
1430	=cut	1933	=cut
1431		1934
1432	sub add_toggle {	1935	sub add_toggle {
1433	my ($self, $text, $cb, $value) = @_;	1936	my ($self, $text, $value, $cb) = @_;
1434		1937
1435	my $item; $item = {	1938	my $item; $item = {
1436	type => "button",	1939	type => "button",
1437	text => " $text",	1940	text => " $text",
1438	value => $value,	1941	value => $value,
…		…
1457	my $env = $self->{term}->env;	1960	my $env = $self->{term}->env;
1458	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1961	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1459	delete $env->{LC_ALL};	1962	delete $env->{LC_ALL};
1460	$env->{LC_CTYPE} = $self->{term}->locale;	1963	$env->{LC_CTYPE} = $self->{term}->locale;
1461		1964
1462	urxvt::term->new ($env, $self->{term}->resource ("name"),	1965	my $term = urxvt::term->new (
1463	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1966	$env, "popup",
		1967	"--perl-lib" => "", "--perl-ext-common" => "",
		1968	"-pty-fd" => -1, "-sl" => 0,
		1969	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1464	"--transient-for" => $self->{term}->parent,	1970	"--transient-for" => $self->{term}->parent,
1465	"-display" => $self->{term}->display_id,	1971	"-display" => $self->{term}->display_id,
1466	"-pe" => "urxvt-popup")	1972	"-pe" => "urxvt-popup",
1467	or die "unable to create popup window\n";	1973	) or die "unable to create popup window\n";
		1974
		1975	unless (delete $term->{urxvt_popup_init_done}) {
		1976	$term->ungrab;
		1977	$term->destroy;
		1978	die "unable to initialise popup window\n";
		1979	}
1468	}	1980	}
1469		1981
1470	sub DESTROY {	1982	sub DESTROY {
1471	my ($self) = @_;	1983	my ($self) = @_;
1472		1984
1473	delete $self->{term}{_destroy}{$self};	1985	delete $self->{term}{_destroy}{$self};
1474	$self->{term}->ungrab;	1986	$self->{term}->ungrab;
1475	}	1987	}
1476		1988
1477	=back	1989	=back
		1990
		1991	=cut
		1992
		1993	package urxvt::watcher;
1478		1994
1479	=head2 The C<urxvt::timer> Class	1995	=head2 The C<urxvt::timer> Class
1480		1996
1481	This class implements timer watchers/events. Time is represented as a	1997	This class implements timer watchers/events. Time is represented as a
1482	fractional number of seconds since the epoch. Example:	1998	fractional number of seconds since the epoch. Example:
…		…
1486	->new	2002	->new
1487	->interval (1)	2003	->interval (1)
1488	->cb (sub {	2004	->cb (sub {
1489	$term->{overlay}->set (0, 0,	2005	$term->{overlay}->set (0, 0,
1490	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2006	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1491	});	2007	});
1492		2008
1493	=over 4	2009	=over 4
1494		2010
1495	=item $timer = new urxvt::timer	2011	=item $timer = new urxvt::timer
1496		2012
…		…
1520	Start the timer.	2036	Start the timer.
1521		2037
1522	=item $timer = $timer->start ($tstamp)	2038	=item $timer = $timer->start ($tstamp)
1523		2039
1524	Set the event trigger time to C<$tstamp> and start the timer.	2040	Set the event trigger time to C<$tstamp> and start the timer.
		2041
		2042	=item $timer = $timer->after ($delay)
		2043
		2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1525		2045
1526	=item $timer = $timer->stop	2046	=item $timer = $timer->stop
1527		2047
1528	Stop the timer.	2048	Stop the timer.
1529		2049
…		…
1535		2055
1536	$term->{socket} = ...	2056	$term->{socket} = ...
1537	$term->{iow} = urxvt::iow	2057	$term->{iow} = urxvt::iow
1538	->new	2058	->new
1539	->fd (fileno $term->{socket})	2059	->fd (fileno $term->{socket})
1540	->events (urxvt::EVENT_READ)	2060	->events (urxvt::EV_READ)
1541	->start	2061	->start
1542	->cb (sub {	2062	->cb (sub {
1543	my ($iow, $revents) = @_;	2063	my ($iow, $revents) = @_;
1544	# $revents must be 1 here, no need to check	2064	# $revents must be 1 here, no need to check
1545	sysread $term->{socket}, my $buf, 8192	2065	sysread $term->{socket}, my $buf, 8192
…		…
1558	Set the callback to be called when io events are triggered. C<$reventmask>	2078	Set the callback to be called when io events are triggered. C<$reventmask>
1559	is a bitset as described in the C<events> method.	2079	is a bitset as described in the C<events> method.
1560		2080
1561	=item $iow = $iow->fd ($fd)	2081	=item $iow = $iow->fd ($fd)
1562		2082
1563	Set the filedescriptor (not handle) to watch.	2083	Set the file descriptor (not handle) to watch.
1564		2084
1565	=item $iow = $iow->events ($eventmask)	2085	=item $iow = $iow->events ($eventmask)
1566		2086
1567	Set the event mask to watch. The only allowed values are	2087	Set the event mask to watch. The only allowed values are
1568	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2088	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1569	together, or C<urxvt::EVENT_NONE>.	2089	together, or C<urxvt::EV_NONE>.
1570		2090
1571	=item $iow = $iow->start	2091	=item $iow = $iow->start
1572		2092
1573	Start watching for requested events on the given handle.	2093	Start watching for requested events on the given handle.
1574		2094
1575	=item $iow = $iow->stop	2095	=item $iow = $iow->stop
1576		2096
1577	Stop watching for events on the given filehandle.	2097	Stop watching for events on the given file handle.
		2098
		2099	=back
		2100
		2101	=head2 The C<urxvt::iw> Class
		2102
		2103	This class implements idle watchers, that get called automatically when
		2104	the process is idle. They should return as fast as possible, after doing
		2105	some useful work.
		2106
		2107	=over 4
		2108
		2109	=item $iw = new urxvt::iw
		2110
		2111	Create a new idle watcher object in stopped state.
		2112
		2113	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2114
		2115	Set the callback to be called when the watcher triggers.
		2116
		2117	=item $timer = $timer->start
		2118
		2119	Start the watcher.
		2120
		2121	=item $timer = $timer->stop
		2122
		2123	Stop the watcher.
		2124
		2125	=back
		2126
		2127	=head2 The C<urxvt::pw> Class
		2128
		2129	This class implements process watchers. They create an event whenever a
		2130	process exits, after which they stop automatically.
		2131
		2132	my $pid = fork;
		2133	...
		2134	$term->{pw} = urxvt::pw
		2135	->new
		2136	->start ($pid)
		2137	->cb (sub {
		2138	my ($pw, $exit_status) = @_;
		2139	...
		2140	});
		2141
		2142	=over 4
		2143
		2144	=item $pw = new urxvt::pw
		2145
		2146	Create a new process watcher in stopped state.
		2147
		2148	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2149
		2150	Set the callback to be called when the timer triggers.
		2151
		2152	=item $pw = $timer->start ($pid)
		2153
		2154	Tells the watcher to start watching for process C<$pid>.
		2155
		2156	=item $pw = $pw->stop
		2157
		2158	Stop the watcher.
1578		2159
1579	=back	2160	=back
1580		2161
1581	=head1 ENVIRONMENT	2162	=head1 ENVIRONMENT
1582		2163
…		…
1591		2172
1592	=item >= 3 - script loading and management	2173	=item >= 3 - script loading and management
1593		2174
1594	=item >=10 - all called hooks	2175	=item >=10 - all called hooks
1595		2176
1596	=item >=11 - hook reutrn values	2177	=item >=11 - hook return values
1597		2178
1598	=back	2179	=back
1599		2180
1600	=head1 AUTHOR	2181	=head1 AUTHOR
1601		2182
…		…
1603	http://software.schmorp.de/pkg/rxvt-unicode	2184	http://software.schmorp.de/pkg/rxvt-unicode
1604		2185
1605	=cut	2186	=cut
1606		2187
1607	1	2188	1
		2189
		2190	# vim: sw=3:

Diff Legend

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