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.82 by root, Thu Jan 12 01:30:53 2006 UTC vs.
Revision 1.177 by root, Sat Jul 18 06:11:57 2009 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
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 clicked, the program specified in the resource	251	matching a certain pattern and make it clickable. When clicked with the
91	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.
		377
		378	=item macosx-pastebin and macosx-pastebin-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<maxosx-pastebin> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
98		391
99	=item example-refresh-hooks	392	=item example-refresh-hooks
100		393
101	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
102	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
142		435
143	=back	436	=back
144		437
145	=head2 Extension Objects	438	=head2 Extension Objects
146		439
147	Very perl extension is a perl class. A separate perl object is created	440	Every perl extension is a perl class. A separate perl object is created
148	for each terminal and each extension and passed as the first parameter to	441	for each terminal, and each terminal has its own set of extenion objects,
149	hooks. So extensions can use their C<$self> object without having to think	442	which are passed as the first parameter to hooks. So extensions can use
150	about other extensions, with the exception of methods and members that	443	their C<$self> object without having to think about clashes with other
		444	extensions or other terminals, with the exception of methods and members
151	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
152	use.	446	internal use.
153		447
154	Although it isn't a C<urxvt::term> object, you can call all methods of the	448	Although it isn't a C<urxvt::term> object, you can call all methods of the
155	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
156		450
157	It has the following methods and data members:	451	It has the following methods and data members:
…		…
178	=head2 Hooks	472	=head2 Hooks
179		473
180	The following subroutines can be declared in extension files, and will be	474	The following subroutines can be declared in extension files, and will be
181	called whenever the relevant event happens.	475	called whenever the relevant event happens.
182		476
183	The first argument passed to them is an extension oject as described in	477	The first argument passed to them is an extension object as described in
184	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
185		479
186	B<All> of these hooks must return a boolean value. If it is true, then the	480	B<All> of these hooks must return a boolean value. If any of the called
187	event counts as being I<consumed>, and the invocation of other hooks is	481	hooks returns true, then the event counts as being I<consumed>, and the
188	skipped, and the relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
189		483
190	I<< When in doubt, return a false value (preferably C<()>). >>	484	I<< When in doubt, return a false value (preferably C<()>). >>
191		485
192	=over 4	486	=over 4
193		487
194	=item on_init $term	488	=item on_init $term
195		489
196	Called after a new terminal object has been initialized, but before	490	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	491	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	492	call or deliver senseless data, as terminal size and other characteristics
199	have not yet been determined. You can safely query and change resources,	493	have not yet been determined. You can safely query and change resources
200	though.	494	and options, though. For many purposes the C<on_start> hook is a better
		495	place.
		496
		497	=item on_start $term
		498
		499	Called at the very end of initialisation of a new terminal, just before
		500	trying to map (display) the toplevel and returning to the main loop.
		501
		502	=item on_destroy $term
		503
		504	Called whenever something tries to destroy terminal, when the terminal is
		505	still fully functional (not for long, though).
201		506
202	=item on_reset $term	507	=item on_reset $term
203		508
204	Called after the screen is "reset" for any reason, such as resizing or	509	Called after the screen is "reset" for any reason, such as resizing or
205	control sequences. Here is where you can react on changes to size-related	510	control sequences. Here is where you can react on changes to size-related
206	variables.	511	variables.
207		512
208	=item on_start $term	513	=item on_child_start $term, $pid
209		514
210	Called at the very end of initialisation of a new terminal, just before	515	Called just after the child process has been C<fork>ed.
211	returning to the mainloop.	516
		517	=item on_child_exit $term, $status
		518
		519	Called just after the child process has exited. C<$status> is the status
		520	from C<waitpid>.
212		521
213	=item on_sel_make $term, $eventtime	522	=item on_sel_make $term, $eventtime
214		523
215	Called whenever a selection has been made by the user, but before the	524	Called whenever a selection has been made by the user, but before the
216	selection text is copied, so changes to the beginning, end or type of the	525	selection text is copied, so changes to the beginning, end or type of the
…		…
223		532
224	Called whenever a selection has been copied, but before the selection is	533	Called whenever a selection has been copied, but before the selection is
225	requested from the server. The selection text can be queried and changed	534	requested from the server. The selection text can be queried and changed
226	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
227		536
228	Returning a true value aborts selection grabbing. It will still be hilighted.	537	Returning a true value aborts selection grabbing. It will still be highlighted.
229		538
230	=item on_sel_extend $term	539	=item on_sel_extend $term
231		540
232	Called whenever the user tries to extend the selection (e.g. with a double	541	Called whenever the user tries to extend the selection (e.g. with a double
233	click) and is either supposed to return false (normal operation), or	542	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	543	should extend the selection itself and return true to suppress the built-in
235	processing.	544	processing. This can happen multiple times, as long as the callback
		545	returns true, it will be called on every further click by the user and is
		546	supposed to enlarge the selection more and more, if possible.
236		547
237	See the F<selection> example extension.	548	See the F<selection> example extension.
238		549
239	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
240		551
241	Called whenever the view offset changes, i..e the user or program	552	Called whenever the view offset changes, i.e. the user or program
242	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
243	show this many lines of scrollback.	554	show this many lines of scrollback.
244		555
245	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
246		557
…		…
250		561
251	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
252	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	563	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
253	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
254		565
255	=item on_osc_seq $term, $string	566	=item on_osc_seq $term, $op, $args, $resp
		567
		568	Called on every OSC sequence and can be used to suppress it or modify its
		569	behaviour. The default should be to return an empty list. A true value
		570	suppresses execution of the request completely. Make sure you don't get
		571	confused by recursive invocations when you output an OSC sequence within
		572	this callback.
		573
		574	C<on_osc_seq_perl> should be used for new behaviour.
		575
		576	=item on_osc_seq_perl $term, $args, $resp
256		577
257	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
258	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
259	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
260	string should start with the extension name and a colon, to distinguish	581	string should start with the extension name (sans -osc) and a semicolon,
261	it from commands for other extensions, and this might be enforced in the	582	to distinguish it from commands for other extensions, and this might be
262	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
263		594
264	Be careful not ever to trust (in a security sense) the data you receive,	595	Be careful not ever to trust (in a security sense) the data you receive,
265	as its source can not easily be controleld (e-mail content, messages from	596	as its source can not easily be controlled (e-mail content, messages from
266	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
267		601
268	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
269		603
270	Called whenever text is about to be output, with the text as argument. You	604	Called whenever text is about to be output, with the text as argument. You
271	can filter/change and output the text yourself by returning a true value	605	can filter/change and output the text yourself by returning a true value
…		…
292	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
293	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
294		628
295	=item on_refresh_begin $term	629	=item on_refresh_begin $term
296		630
297	Called just before the screen gets redrawn. Can be used for overlay	631	Called just before the screen gets redrawn. Can be used for overlay or
298	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
299	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
300	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
301		635
302	=item on_refresh_end $term	636	=item on_refresh_end $term
303		637
304	Called just after the screen gets redrawn. See C<on_refresh_begin>.	638	Called just after the screen gets redrawn. See C<on_refresh_begin>.
305		639
306	=item on_keyboard_command $term, $string	640	=item on_user_command $term, $string
307		641
308	Called whenever the user presses a key combination that has a	642	Called whenever a user-configured event is being activated (e.g. via
309	C<perl:string> action bound to it (see description of the B<keysym>	643	a C<perl:string> action bound to a key, see description of the B<keysym>
310	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
		645
		646	The event is simply the action string. This interface is assumed to change
		647	slightly in the future.
		648
		649	=item on_resize_all_windows $tern, $new_width, $new_height
		650
		651	Called just after the new window size has been calculated, but before
		652	windows are actually being resized or hints are being set. If this hook
		653	returns TRUE, setting of the window hints is being skipped.
		654
		655	=item on_x_event $term, $event
		656
		657	Called on every X event received on the vt window (and possibly other
		658	windows). Should only be used as a last resort. Most event structure
		659	members are not passed.
		660
		661	=item on_root_event $term, $event
		662
		663	Like C<on_x_event>, but is called for events on the root window.
311		664
312	=item on_focus_in $term	665	=item on_focus_in $term
313		666
314	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
315	does focus in processing.	668	does focus in processing.
316		669
317	=item on_focus_out $term	670	=item on_focus_out $term
318		671
319	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
320	focus out processing.	673	focus out processing.
		674
		675	=item on_configure_notify $term, $event
		676
		677	=item on_property_notify $term, $event
321		678
322	=item on_key_press $term, $event, $keysym, $octets	679	=item on_key_press $term, $event, $keysym, $octets
323		680
324	=item on_key_release $term, $event, $keysym	681	=item on_key_release $term, $event, $keysym
325		682
…		…
335		692
336	Called whenever the corresponding X event is received for the terminal If	693	Called whenever the corresponding X event is received for the terminal If
337	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the even will be ignored by rxvt-unicode.
338		695
339	The event is a hash with most values as named by Xlib (see the XEvent	696	The event is a hash with most values as named by Xlib (see the XEvent
340	manpage), with the additional members C<row> and C<col>, which are the row	697	manpage), with the additional members C<row> and C<col>, which are the
341	and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
342		699
343	C<on_key_press> additionally receives the string rxvt-unicode would	700	C<on_key_press> additionally receives the string rxvt-unicode would
344	output, if any, in locale-specific encoding.	701	output, if any, in locale-specific encoding.
345		702
346	subwindow.	703	subwindow.
		704
		705	=item on_client_message $term, $event
		706
		707	=item on_wm_protocols $term, $event
		708
		709	=item on_wm_delete_window $term, $event
		710
		711	Called when various types of ClientMessage events are received (all with
		712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
347		713
348	=back	714	=back
349		715
350	=cut	716	=cut
351		717
…		…
357	use Scalar::Util ();	723	use Scalar::Util ();
358	use List::Util ();	724	use List::Util ();
359		725
360	our $VERSION = 1;	726	our $VERSION = 1;
361	our $TERM;	727	our $TERM;
		728	our @TERM_INIT;
		729	our @TERM_EXT;
362	our @HOOKNAME;	730	our @HOOKNAME;
363	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	731	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364	our %OPTION;	732	our %OPTION;
365		733
366	our $LIBDIR;	734	our $LIBDIR;
367	our $RESNAME;	735	our $RESNAME;
368	our $RESCLASS;	736	our $RESCLASS;
369	our $RXVTNAME;	737	our $RXVTNAME;
370		738
		739	our $NOCHAR = chr 0xffff;
		740
371	=head2 Variables in the C<urxvt> Package	741	=head2 Variables in the C<urxvt> Package
372		742
373	=over 4	743	=over 4
374		744
375	=item $urxvt::LIBDIR	745	=item $urxvt::LIBDIR
…		…
387		757
388	=item $urxvt::TERM	758	=item $urxvt::TERM
389		759
390	The current terminal. This variable stores the current C<urxvt::term>	760	The current terminal. This variable stores the current C<urxvt::term>
391	object, whenever a callback/hook is executing.	761	object, whenever a callback/hook is executing.
		762
		763	=item @urxvt::TERM_INIT
		764
		765	All code references in this array will be called as methods of the next newly
		766	created C<urxvt::term> object (during the C<on_init> phase). The array
		767	gets cleared before the code references that were in it are being executed,
		768	so references can push themselves onto it again if they so desire.
		769
		770	This complements to the perl-eval command line option, but gets executed
		771	first.
		772
		773	=item @urxvt::TERM_EXT
		774
		775	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		776	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		777	but before other extensions. Gets cleared just like C<@TERM_INIT>.
392		778
393	=back	779	=back
394		780
395	=head2 Functions in the C<urxvt> Package	781	=head2 Functions in the C<urxvt> Package
396		782
…		…
411	Using this function has the advantage that its output ends up in the	797	Using this function has the advantage that its output ends up in the
412	correct place, e.g. on stderr of the connecting urxvtc client.	798	correct place, e.g. on stderr of the connecting urxvtc client.
413		799
414	Messages have a size limit of 1023 bytes currently.	800	Messages have a size limit of 1023 bytes currently.
415		801
416	=item $is_safe = urxvt::safe	802	=item @terms = urxvt::termlist
417		803
418	Returns true when it is safe to do potentially unsafe things, such as	804	Returns all urxvt::term objects that exist in this process, regardless of
419	evaluating perl code specified by the user. This is true when urxvt was	805	whether they are started, being destroyed etc., so be careful. Only term
420	started setuid or setgid.	806	objects that have perl extensions attached will be returned (because there
		807	is no urxvt::term objet associated with others).
421		808
422	=item $time = urxvt::NOW	809	=item $time = urxvt::NOW
423		810
424	Returns the "current time" (as per the event loop).	811	Returns the "current time" (as per the event loop).
425		812
426	=item urxvt::CurrentTime	813	=item urxvt::CurrentTime
427		814
428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	815	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	816	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430	Button4Mask, Button5Mask, AnyModifier	817	Button4Mask, Button5Mask, AnyModifier
		818
		819	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		820	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		821	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		822	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		823	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		824	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		825	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		826
		827	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		828	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		829	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		830	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		831	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		832	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		833	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431		834
432	Various constants for use in X calls and event processing.	835	Various constants for use in X calls and event processing.
433		836
434	=back	837	=back
435		838
…		…
468		871
469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	872	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
470		873
471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	874	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
472		875
		876	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		877
473	Replace the foreground/background colour in the rendition mask with the	878	Replace the foreground/background colour in the rendition mask with the
474	specified one.	879	specified one.
475		880
476	=item $value = urxvt::GET_CUSTOM $rend	881	=item $value = urxvt::GET_CUSTOM $rend
477		882
…		…
486	=back	891	=back
487		892
488	=cut	893	=cut
489		894
490	BEGIN {	895	BEGIN {
491	urxvt->bootstrap;
492
493	# overwrite perl's warn	896	# overwrite perl's warn
494	*CORE::GLOBAL::warn = sub {	897	*CORE::GLOBAL::warn = sub {
495	my $msg = join "", @_;	898	my $msg = join "", @_;
496	$msg .= "\n"	899	$msg .= "\n"
497	unless $msg =~ /\n$/;	900	unless $msg =~ /\n$/;
498	urxvt::warn ($msg);	901	urxvt::warn ($msg);
499	};	902	};
500
501	# %ENV is the original startup environment
502	delete $ENV{IFS};
503	delete $ENV{CDPATH};
504	delete $ENV{BASH_ENV};
505	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
506	}	903	}
507		904
508	my @hook_count;	905	no warnings 'utf8';
		906
509	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	907	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
510		908
511	sub verbose {	909	sub verbose {
512	my ($level, $msg) = @_;	910	my ($level, $msg) = @_;
513	warn "$msg\n" if $level <= $verbosity;	911	warn "$msg\n" if $level <= $verbosity;
514	}	912	}
515		913
516	my $extension_pkg = "extension0000";
517	my %extension_pkg;	914	my %extension_pkg;
518		915
519	# load a single script into its own package, once only	916	# load a single script into its own package, once only
520	sub extension_package($) {	917	sub extension_package($) {
521	my ($path) = @_;	918	my ($path) = @_;
522		919
523	$extension_pkg{$path} ||= do {	920	$extension_pkg{$path} ||= do {
524	my $pkg = "urxvt::" . ($extension_pkg++);	921	$path =~ /([^\/\\]+)$/;
		922	my $pkg = $1;
		923	$pkg =~ s/[^[:word:]]/_/g;
		924	$pkg = "urxvt::ext::$pkg";
525		925
526	verbose 3, "loading extension '$path' into package '$pkg'";	926	verbose 3, "loading extension '$path' into package '$pkg'";
527		927
528	open my $fh, "<:raw", $path	928	open my $fh, "<:raw", $path
529	or die "$path: $!";	929	or die "$path: $!";
530		930
531	my $source = untaint	931	my $source =
532	"package $pkg; use strict; use utf8;\n"	932	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
533	. "use base urxvt::term::extension::;\n"
534	. "#line 1 \"$path\"\n{\n"	933	. "#line 1 \"$path\"\n{\n"
535	. (do { local $/; <$fh> })	934	. (do { local $/; <$fh> })
536	. "\n};\n1";	935	. "\n};\n1";
537		936
538	eval $source	937	eval $source
…		…
549	local $TERM = shift;	948	local $TERM = shift;
550	my $htype = shift;	949	my $htype = shift;
551		950
552	if ($htype == 0) { # INIT	951	if ($htype == 0) { # INIT
553	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
554		953
555	my %ext_arg;	954	my %ext_arg;
556		955
		956	{
		957	my @init = @TERM_INIT;
		958	@TERM_INIT = ();
		959	$_->($TERM) for @init;
		960	my @pkg = @TERM_EXT;
		961	@TERM_EXT = ();
		962	$TERM->register_package ($_) for @pkg;
		963	}
		964
557	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	965	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
558	if ($_ eq "default") {	966	if ($_ eq "default") {
559	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	967	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
560	} elsif (/^-(.*)$/) {	968	} elsif (/^-(.*)$/) {
561	delete $ext_arg{$1};	969	delete $ext_arg{$1};
562	} elsif (/^([^<]+)<(.*)>$/) {	970	} elsif (/^([^<]+)<(.*)>$/) {
563	push @{ $ext_arg{$1} }, $2;	971	push @{ $ext_arg{$1} }, $2;
564	} else {	972	} else {
565	$ext_arg{$_} ||= [];	973	$ext_arg{$_} ||= [];
566	}	974	}
567	}	975	}
568		976
569	while (my ($ext, $argv) = each %ext_arg) {	977	for my $ext (sort keys %ext_arg) {
570	my @files = grep -f $_, map "$_/$ext", @dirs;	978	my @files = grep -f $_, map "$_/$ext", @dirs;
571		979
572	if (@files) {	980	if (@files) {
573	$TERM->register_package (extension_package $files[0], $argv);	981	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
574	} else {	982	} else {
575	warn "perl extension '$ext' not found in perl library search path\n";	983	warn "perl extension '$ext' not found in perl library search path\n";
576	}	984	}
577	}	985	}
578		986
…		…
584		992
585	if (my $cb = $TERM->{_hook}[$htype]) {	993	if (my $cb = $TERM->{_hook}[$htype]) {
586	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	994	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
587	if $verbosity >= 10;	995	if $verbosity >= 10;
588		996
589	keys %$cb;	997	for my $pkg (keys %$cb) {
590
591	while (my ($pkg, $cb) = each %$cb) {
592	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	998	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
593	and last;	999	$retval ||= $retval_;
594		1000
595	if ($@) {	1001	if ($@) {
596	$TERM->ungrab; # better to lose the grab than the session	1002	$TERM->ungrab; # better to lose the grab than the session
597	warn $@;	1003	warn $@;
598	}	1004	}
599	}	1005	}
		1006
		1007	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		1008	if $verbosity >= 11;
600	}	1009	}
601		1010
602	if ($htype == 1) { # DESTROY	1011	if ($htype == 1) { # DESTROY
603	if (my $hook = delete $TERM->{_hook}) {
604	for my $htype (0..$#$hook) {
605	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
606	or set_should_invoke $htype, 0;
607	}
608	}
609
610	# clear package objects	1012	# clear package objects
611	%$_ = () for values %{ $TERM->{_pkg} };	1013	%$_ = () for values %{ $TERM->{_pkg} };
612		1014
613	# clear package	1015	# clear package
614	%$TERM = ();	1016	%$TERM = ();
615	}	1017	}
616		1018
617	$retval	1019	$retval
		1020	}
		1021
		1022	sub SET_COLOR($$$) {
		1023	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1024	}
		1025
		1026	sub rend2mask {
		1027	no strict 'refs';
		1028	my ($str, $mask) = (@_, 0);
		1029	my %color = ( fg => undef, bg => undef );
		1030	my @failed;
		1031	for my $spec ( split /\s+/, $str ) {
		1032	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1033	$color{lc($1)} = $2;
		1034	} else {
		1035	my $neg = $spec =~ s/^[-^]//;
		1036	unless ( exists &{"RS_$spec"} ) {
		1037	push @failed, $spec;
		1038	next;
		1039	}
		1040	my $cur = &{"RS_$spec"};
		1041	if ( $neg ) {
		1042	$mask &= ~$cur;
		1043	} else {
		1044	$mask |= $cur;
		1045	}
		1046	}
		1047	}
		1048	($mask, @color{qw(fg bg)}, \@failed)
618	}	1049	}
619		1050
620	# urxvt::term::extension	1051	# urxvt::term::extension
621		1052
622	package urxvt::term::extension;	1053	package urxvt::term::extension;
…		…
628	while (my ($name, $cb) = each %hook) {	1059	while (my ($name, $cb) = each %hook) {
629	my $htype = $HOOKTYPE{uc $name};	1060	my $htype = $HOOKTYPE{uc $name};
630	defined $htype	1061	defined $htype
631	or Carp::croak "unsupported hook type '$name'";	1062	or Carp::croak "unsupported hook type '$name'";
632		1063
		1064	$self->set_should_invoke ($htype, +1)
633	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1065	unless exists $self->{term}{_hook}[$htype]{$pkg};
634	$hook_count[$htype]++
635	or urxvt::set_should_invoke $htype, 1;
636	}
637		1066
638	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1067	$self->{term}{_hook}[$htype]{$pkg} = $cb;
639	}	1068	}
640	}	1069	}
641		1070
…		…
646	for my $name (@hook) {	1075	for my $name (@hook) {
647	my $htype = $HOOKTYPE{uc $name};	1076	my $htype = $HOOKTYPE{uc $name};
648	defined $htype	1077	defined $htype
649	or Carp::croak "unsupported hook type '$name'";	1078	or Carp::croak "unsupported hook type '$name'";
650		1079
		1080	$self->set_should_invoke ($htype, -1)
651	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1081	if delete $self->{term}{_hook}[$htype]{$pkg};
652	--$hook_count[$htype]
653	or urxvt::set_should_invoke $htype, 0;
654	}
655	}	1082	}
656	}	1083	}
657		1084
658	our $AUTOLOAD;	1085	our $AUTOLOAD;
659		1086
…		…
697	is that you cannot use blocking APIs, but the non-blocking variant should	1124	is that you cannot use blocking APIs, but the non-blocking variant should
698	work.	1125	work.
699		1126
700	=cut	1127	=cut
701		1128
702	our $VERSION = 1;	1129	our $VERSION = '3.4';
703		1130
704	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1131	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
705	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1132	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
706		1133
707	sub timer {	1134	sub timer {
…		…
709		1136
710	my $cb = $arg{cb};	1137	my $cb = $arg{cb};
711		1138
712	urxvt::timer	1139	urxvt::timer
713	->new	1140	->new
714	->start (urxvt::NOW + $arg{after})	1141	->after ($arg{after})
		1142	->interval ($arg{interval})
		1143	->start
715	->cb (sub {	1144	->cb (sub {
		1145	#TODO interval?
716	$_[0]->stop; # need to cancel manually	1146	$_[0]->stop; # need to cancel manually
717	$cb->();	1147	$cb->();
718	})	1148	})
719	}	1149	}
720		1150
721	sub io {	1151	sub io {
722	my ($class, %arg) = @_;	1152	my ($class, %arg) = @_;
723		1153
724	my $cb = $arg{cb};	1154	my $cb = $arg{cb};
		1155	my $fd = fileno $arg{fh};
		1156	defined $fd or $fd = $arg{fh};
725		1157
726	bless [$arg{fh}, urxvt::iow	1158	bless [$arg{fh}, urxvt::iow
727	->new	1159	->new
728	->fd (fileno $arg{fh})	1160	->fd ($fd)
729	->events (($arg{poll} =~ /r/ ? 1 : 0)	1161	->events (($arg{poll} =~ /r/ ? 1 : 0)
730	| ($arg{poll} =~ /w/ ? 2 : 0))	1162	| ($arg{poll} =~ /w/ ? 2 : 0))
731	->start	1163	->start
732	->cb (sub {	1164	->cb ($cb)
733	$cb->(($_[1] & 1 ? 'r' : '')
734	. ($_[1] & 2 ? 'w' : ''));
735	})],
736	urxvt::anyevent::	1165	], urxvt::anyevent::
		1166	}
		1167
		1168	sub idle {
		1169	my ($class, %arg) = @_;
		1170
		1171	my $cb = $arg{cb};
		1172
		1173	urxvt::iw
		1174	->new
		1175	->start
		1176	->cb (sub {
		1177	#TODO really cancel?
		1178	$_[0]->stop; # need to cancel manually
		1179	$cb->();
		1180	})
		1181	}
		1182
		1183	sub child {
		1184	my ($class, %arg) = @_;
		1185
		1186	my $cb = $arg{cb};
		1187
		1188	urxvt::pw
		1189	->new
		1190	->start ($arg{pid})
		1191	->cb (sub {
		1192	#TODO really cancel?
		1193	$_[0]->stop; # need to cancel manually
		1194	$cb->($_[0]->rpid, $_[0]->rstatus);
		1195	})
737	}	1196	}
738		1197
739	sub DESTROY {	1198	sub DESTROY {
740	$_[0][1]->stop;	1199	$_[0][1]->stop;
741	}	1200	}
742		1201
743	sub condvar {	1202	sub one_event {
744	bless \my $flag, urxvt::anyevent::condvar::
745	}
746
747	sub urxvt::anyevent::condvar::broadcast {
748	${$_[0]}++;
749	}
750
751	sub urxvt::anyevent::condvar::wait {
752	unless (${$_[0]}) {
753	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1203	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
754	}
755	}	1204	}
756		1205
757	package urxvt::term;	1206	package urxvt::term;
758		1207
759	=head2 The C<urxvt::term> Class	1208	=head2 The C<urxvt::term> Class
…		…
764		1213
765	# find on_xxx subs in the package and register them	1214	# find on_xxx subs in the package and register them
766	# as hooks	1215	# as hooks
767	sub register_package {	1216	sub register_package {
768	my ($self, $pkg, $argv) = @_;	1217	my ($self, $pkg, $argv) = @_;
		1218
		1219	no strict 'refs';
		1220
		1221	urxvt::verbose 6, "register package $pkg to $self";
		1222
		1223	@{"$pkg\::ISA"} = urxvt::term::extension::;
769		1224
770	my $proxy = bless {	1225	my $proxy = bless {
771	_pkg => $pkg,	1226	_pkg => $pkg,
772	argv => $argv,	1227	argv => $argv,
773	}, $pkg;	1228	}, $pkg;
…		…
789	hash which defines the environment of the new terminal.	1244	hash which defines the environment of the new terminal.
790		1245
791	Croaks (and probably outputs an error message) if the new instance	1246	Croaks (and probably outputs an error message) if the new instance
792	couldn't be created. Returns C<undef> if the new instance didn't	1247	couldn't be created. Returns C<undef> if the new instance didn't
793	initialise perl, and the terminal object otherwise. The C<init> and	1248	initialise perl, and the terminal object otherwise. The C<init> and
794	C<start> hooks will be called during this call.	1249	C<start> hooks will be called before this call returns, and are free to
		1250	refer to global data (which is race free).
795		1251
796	=cut	1252	=cut
797		1253
798	sub new {	1254	sub new {
799	my ($class, $env, @args) = @_;	1255	my ($class, $env, @args) = @_;
800		1256
		1257	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1258	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1259
801	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1260	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
802	}	1261	}
803		1262
804	=item $term->destroy	1263	=item $term->destroy
805		1264
806	Destroy the terminal object (close the window, free resources	1265	Destroy the terminal object (close the window, free resources
807	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1266	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
808	watchers (timers, io watchers) are still active.	1267	watchers (timers, io watchers) are still active.
809		1268
		1269	=item $term->exec_async ($cmd[, @args])
		1270
		1271	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1272	("starts") programs in the background. This function takes care of setting
		1273	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1274	be preferred over explicit calls to C<exec> or C<system>.
		1275
		1276	Returns the pid of the subprocess or C<undef> on error.
		1277
		1278	=cut
		1279
		1280	sub exec_async {
		1281	my $self = shift;
		1282
		1283	my $pid = fork;
		1284
		1285	return $pid
		1286	if !defined $pid or $pid;
		1287
		1288	%ENV = %{ $self->env };
		1289
		1290	exec @_;
		1291	urxvt::_exit 255;
		1292	}
		1293
810	=item $isset = $term->option ($optval[, $set])	1294	=item $isset = $term->option ($optval[, $set])
811		1295
812	Returns true if the option specified by C<$optval> is enabled, and	1296	Returns true if the option specified by C<$optval> is enabled, and
813	optionally change it. All option values are stored by name in the hash	1297	optionally change it. All option values are stored by name in the hash
814	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1298	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
815		1299
816	Here is a a likely non-exhaustive list of option names, please see the	1300	Here is a likely non-exhaustive list of option names, please see the
817	source file F</src/optinc.h> to see the actual list:	1301	source file F</src/optinc.h> to see the actual list:
818		1302
819	borderLess console cursorBlink cursorUnderline hold iconic insecure	1303	borderLess console cursorBlink cursorUnderline hold iconic insecure
820	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1304	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
821	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1305	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
822	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1306	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
823	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1307	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
824	tripleclickwords utmpInhibit visualBell	1308	transparent tripleclickwords utmpInhibit visualBell
825		1309
826	=item $value = $term->resource ($name[, $newval])	1310	=item $value = $term->resource ($name[, $newval])
827		1311
828	Returns the current resource value associated with a given name and	1312	Returns the current resource value associated with a given name and
829	optionally sets a new value. Setting values is most useful in the C<init>	1313	optionally sets a new value. Setting values is most useful in the C<init>
…		…
838	likely change).	1322	likely change).
839		1323
840	Please note that resource strings will currently only be freed when the	1324	Please note that resource strings will currently only be freed when the
841	terminal is destroyed, so changing options frequently will eat memory.	1325	terminal is destroyed, so changing options frequently will eat memory.
842		1326
843	Here is a a likely non-exhaustive list of resource names, not all of which	1327	Here is a likely non-exhaustive list of resource names, not all of which
844	are supported in every build, please see the source file F</src/rsinc.h>	1328	are supported in every build, please see the source file F</src/rsinc.h>
845	to see the actual list:	1329	to see the actual list:
846		1330
847	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1331	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
848	borderLess color cursorBlink cursorUnderline cutchars delete_key	1332	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
849	display_name embed ext_bwidth fade font geometry hold iconName	1333	display_name embed ext_bwidth fade font geometry hold iconName
850	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1334	imFont imLocale inputMethod insecure int_bwidth intensityStyles
851	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1335	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
852	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1336	modifier mouseWheelScrollPage name override_redirect pastableTabs path
853	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1337	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
854	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1338	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
855	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1339	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
856	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1340	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
857	shade term_name title transparent transparent_all tripleclickwords	1341	secondaryScreen secondaryScroll shade term_name title
858	utmpInhibit visualBell	1342	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1343	visualBell
859		1344
860	=cut	1345	=cut
861		1346
862	sub resource($$;$) {	1347	sub resource($$;$) {
863	my ($self, $name) = (shift, shift);	1348	my ($self, $name) = (shift, shift);
864	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1349	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
865	&urxvt::term::_resource	1350	goto &urxvt::term::_resource
866	}	1351	}
867		1352
868	=item $value = $term->x_resource ($pattern)	1353	=item $value = $term->x_resource ($pattern)
869		1354
870	Returns the X-Resource for the given pattern, excluding the program or	1355	Returns the X-Resource for the given pattern, excluding the program or
…		…
898	=item ($row, $col) = $term->selection_end ([$row, $col])	1383	=item ($row, $col) = $term->selection_end ([$row, $col])
899		1384
900	Return the current values of the selection mark, begin or end positions,	1385	Return the current values of the selection mark, begin or end positions,
901	and optionally set them to new values.	1386	and optionally set them to new values.
902		1387
		1388	=item $term->selection_make ($eventtime[, $rectangular])
		1389
		1390	Tries to make a selection as set by C<selection_beg> and
		1391	C<selection_end>. If C<$rectangular> is true (default: false), a
		1392	rectangular selection will be made. This is the prefered function to make
		1393	a selection.
		1394
903	=item $success = $term->selection_grab ($eventtime)	1395	=item $success = $term->selection_grab ($eventtime)
904		1396
905	Try to request the primary selection from the server (for example, as set	1397	Try to request the primary selection text from the server (for example, as
906	by the next method).	1398	set by the next method). No visual feedback will be given. This function
		1399	is mostly useful from within C<on_sel_grab> hooks.
907		1400
908	=item $oldtext = $term->selection ([$newtext])	1401	=item $oldtext = $term->selection ([$newtext])
909		1402
910	Return the current selection text and optionally replace it by C<$newtext>.	1403	Return the current selection text and optionally replace it by C<$newtext>.
911		1404
…		…
945		1438
946	The methods currently supported on C<urxvt::overlay> objects are:	1439	The methods currently supported on C<urxvt::overlay> objects are:
947		1440
948	=over 4	1441	=over 4
949		1442
950	=item $overlay->set ($x, $y, $text, $rend)	1443	=item $overlay->set ($x, $y, $text[, $rend])
951		1444
952	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1445	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
953	text in rxvt-unicode's special encoding and an array of rendition values	1446	text in rxvt-unicode's special encoding and an array of rendition values
954	at a specific position inside the overlay.	1447	at a specific position inside the overlay.
		1448
		1449	If C<$rend> is missing, then the rendition will not be changed.
955		1450
956	=item $overlay->hide	1451	=item $overlay->hide
957		1452
958	If visible, hide the overlay, but do not destroy it.	1453	If visible, hide the overlay, but do not destroy it.
959		1454
…		…
1004	Convert the given locale-encoded octets into a perl string.	1499	Convert the given locale-encoded octets into a perl string.
1005		1500
1006	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1501	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1007		1502
1008	XORs the rendition values in the given span with the provided value	1503	XORs the rendition values in the given span with the provided value
1009	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1504	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1010	to the selection.	1505	refresh hooks to provide effects similar to the selection.
1011		1506
1012	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1507	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1013		1508
1014	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1509	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1015	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1510	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1016	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1511	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1017	it instead.	1512	it instead. Both styles I<MUST NOT> contain font styles.
1018		1513
1019	=item $term->scr_bell	1514	=item $term->scr_bell
1020		1515
1021	Ring the bell!	1516	Ring the bell!
1022		1517
…		…
1029		1524
1030	Normally its not a good idea to use this function, as programs might be	1525	Normally its not a good idea to use this function, as programs might be
1031	confused by changes in cursor position or scrolling. Its useful inside a	1526	confused by changes in cursor position or scrolling. Its useful inside a
1032	C<on_add_lines> hook, though.	1527	C<on_add_lines> hook, though.
1033		1528
		1529	=item $term->scr_change_screen ($screen)
		1530
		1531	Switch to given screen - 0 primary, 1 secondary.
		1532
1034	=item $term->cmd_parse ($octets)	1533	=item $term->cmd_parse ($octets)
1035		1534
1036	Similar to C<scr_add_lines>, but the argument must be in the	1535	Similar to C<scr_add_lines>, but the argument must be in the
1037	locale-specific encoding of the terminal and can contain command sequences	1536	locale-specific encoding of the terminal and can contain command sequences
1038	(escape codes) that will be interpreted.	1537	(escape codes) that will be interpreted.
…		…
1048	Replaces the event mask of the pty watcher by the given event mask. Can	1547	Replaces the event mask of the pty watcher by the given event mask. Can
1049	be used to suppress input and output handling to the pty/tty. See the	1548	be used to suppress input and output handling to the pty/tty. See the
1050	description of C<< urxvt::timer->events >>. Make sure to always restore	1549	description of C<< urxvt::timer->events >>. Make sure to always restore
1051	the previous value.	1550	the previous value.
1052		1551
		1552	=item $fd = $term->pty_fd
		1553
		1554	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1555	is used.
		1556
1053	=item $windowid = $term->parent	1557	=item $windowid = $term->parent
1054		1558
1055	Return the window id of the toplevel window.	1559	Return the window id of the toplevel window.
1056		1560
1057	=item $windowid = $term->vt	1561	=item $windowid = $term->vt
1058		1562
1059	Return the window id of the terminal window.	1563	Return the window id of the terminal window.
1060		1564
		1565	=item $term->vt_emask_add ($x_event_mask)
		1566
		1567	Adds the specified events to the vt event mask. Useful e.g. when you want
		1568	to receive pointer events all the times:
		1569
		1570	$term->vt_emask_add (urxvt::PointerMotionMask);
		1571
		1572	=item $term->focus_in
		1573
		1574	=item $term->focus_out
		1575
		1576	=item $term->key_press ($state, $keycode[, $time])
		1577
		1578	=item $term->key_release ($state, $keycode[, $time])
		1579
		1580	Deliver various fake events to to terminal.
		1581
1061	=item $window_width = $term->width	1582	=item $window_width = $term->width
1062		1583
1063	=item $window_height = $term->height	1584	=item $window_height = $term->height
1064		1585
1065	=item $font_width = $term->fwidth	1586	=item $font_width = $term->fwidth
…		…
1078		1599
1079	=item $max_scrollback = $term->saveLines	1600	=item $max_scrollback = $term->saveLines
1080		1601
1081	=item $nrow_plus_saveLines = $term->total_rows	1602	=item $nrow_plus_saveLines = $term->total_rows
1082		1603
1083	=item $lines_in_scrollback = $term->nsaved	1604	=item $topmost_scrollback_row = $term->top_row
1084		1605
1085	Return various integers describing terminal characteristics.	1606	Return various integers describing terminal characteristics.
1086		1607
1087	=item $x_display = $term->display_id	1608	=item $x_display = $term->display_id
1088		1609
…		…
1095	=item $env = $term->env	1616	=item $env = $term->env
1096		1617
1097	Returns a copy of the environment in effect for the terminal as a hashref	1618	Returns a copy of the environment in effect for the terminal as a hashref
1098	similar to C<\%ENV>.	1619	similar to C<\%ENV>.
1099		1620
		1621	=item @envv = $term->envv
		1622
		1623	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1624
		1625	=item @argv = $term->argv
		1626
		1627	Return the argument vector as this terminal, similar to @ARGV, but
		1628	includes the program name as first element.
		1629
1100	=cut	1630	=cut
1101		1631
1102	sub env {	1632	sub env {
1103	if (my $env = $_[0]->_env) {
1104	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1633	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1105	} else {
1106	+{ %ENV }
1107	}
1108	}	1634	}
1109		1635
1110	=item $modifiermask = $term->ModLevel3Mask	1636	=item $modifiermask = $term->ModLevel3Mask
1111		1637
1112	=item $modifiermask = $term->ModMetaMask	1638	=item $modifiermask = $term->ModMetaMask
…		…
1114	=item $modifiermask = $term->ModNumLockMask	1640	=item $modifiermask = $term->ModNumLockMask
1115		1641
1116	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1642	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1117	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1643	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1118		1644
		1645	=item $screen = $term->current_screen
		1646
		1647	Returns the currently displayed screen (0 primary, 1 secondary).
		1648
		1649	=item $cursor_is_hidden = $term->hidden_cursor
		1650
		1651	Returns whether the cursor is currently hidden or not.
		1652
1119	=item $view_start = $term->view_start ([$newvalue])	1653	=item $view_start = $term->view_start ([$newvalue])
1120		1654
1121	Returns the negative row number of the topmost line. Minimum value is	1655	Returns the row number of the topmost displayed line. Maximum value is
1122	C<0>, which displays the normal terminal contents. Larger values scroll	1656	C<0>, which displays the normal terminal contents. Lower values scroll
1123	this many lines into the scrollback buffer.	1657	this many lines into the scrollback buffer.
1124		1658
1125	=item $term->want_refresh	1659	=item $term->want_refresh
1126		1660
1127	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1661	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1130		1664
1131	Used after changing terminal contents to display them.	1665	Used after changing terminal contents to display them.
1132		1666
1133	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1667	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1134		1668
1135	Returns the text of the entire row with number C<$row_number>. Row C<0>	1669	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1136	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1670	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1137	terminal line. The scrollback buffer starts at line C<-1> and extends to
1138	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1671	terminal line. Nothing will be returned if a nonexistent line
1139	is requested.	1672	is requested.
1140		1673
1141	If C<$new_text> is specified, it will replace characters in the current	1674	If C<$new_text> is specified, it will replace characters in the current
1142	line, starting at column C<$start_col> (default C<0>), which is useful	1675	line, starting at column C<$start_col> (default C<0>), which is useful
1143	to replace only parts of a line. The font index in the rendition will	1676	to replace only parts of a line. The font index in the rendition will
1144	automatically be updated.	1677	automatically be updated.
1145		1678
1146	C<$text> is in a special encoding: tabs and wide characters that use more	1679	C<$text> is in a special encoding: tabs and wide characters that use more
1147	than one cell when displayed are padded with urxvt::NOCHAR characters	1680	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1148	(C<chr 65535>). Characters with combining characters and other characters	1681	characters. Characters with combining characters and other characters that
1149	that do not fit into the normal tetx encoding will be replaced with	1682	do not fit into the normal text encoding will be replaced with characters
1150	characters in the private use area.	1683	in the private use area.
1151		1684
1152	You have to obey this encoding when changing text. The advantage is	1685	You have to obey this encoding when changing text. The advantage is
1153	that C<substr> and similar functions work on screen cells and not on	1686	that C<substr> and similar functions work on screen cells and not on
1154	characters.	1687	characters.
1155		1688
…		…
1206	Return the row number of the first/last row of the line, respectively.	1739	Return the row number of the first/last row of the line, respectively.
1207		1740
1208	=item $offset = $line->offset_of ($row, $col)	1741	=item $offset = $line->offset_of ($row, $col)
1209		1742
1210	Returns the character offset of the given row|col pair within the logical	1743	Returns the character offset of the given row|col pair within the logical
1211	line.	1744	line. Works for rows outside the line, too, and returns corresponding
		1745	offsets outside the string.
1212		1746
1213	=item ($row, $col) = $line->coord_of ($offset)	1747	=item ($row, $col) = $line->coord_of ($offset)
1214		1748
1215	Translates a string offset into terminal coordinates again.	1749	Translates a string offset into terminal coordinates again.
1216		1750
…		…
1298	where one character corresponds to one screen cell. See	1832	where one character corresponds to one screen cell. See
1299	C<< $term->ROW_t >> for details.	1833	C<< $term->ROW_t >> for details.
1300		1834
1301	=item $string = $term->special_decode $text	1835	=item $string = $term->special_decode $text
1302		1836
1303	Converts rxvt-unicodes text reprsentation into a perl string. See	1837	Converts rxvt-unicodes text representation into a perl string. See
1304	C<< $term->ROW_t >> for details.	1838	C<< $term->ROW_t >> for details.
1305		1839
1306	=item $success = $term->grab_button ($button, $modifiermask)	1840	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1307		1841
		1842	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1843
1308	Registers a synchronous button grab. See the XGrabButton manpage.	1844	Register/unregister a synchronous button grab. See the XGrabButton
		1845	manpage.
1309		1846
1310	=item $success = $term->grab ($eventtime[, $sync])	1847	=item $success = $term->grab ($eventtime[, $sync])
1311		1848
1312	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1849	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1313	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1850	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1314		1851
1315	=item $term->allow_events_async	1852	=item $term->allow_events_async
1316		1853
1317	Calls XAllowEvents with AsyncBoth for the most recent grab.	1854	Calls XAllowEvents with AsyncBoth for the most recent grab.
1318		1855
…		…
1328	=item $term->ungrab	1865	=item $term->ungrab
1329		1866
1330	Calls XUngrab for the most recent grab. Is called automatically on	1867	Calls XUngrab for the most recent grab. Is called automatically on
1331	evaluation errors, as it is better to lose the grab in the error case as	1868	evaluation errors, as it is better to lose the grab in the error case as
1332	the session.	1869	the session.
		1870
		1871	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1872
		1873	=item $atom_name = $term->XGetAtomName ($atom)
		1874
		1875	=item @atoms = $term->XListProperties ($window)
		1876
		1877	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1878
		1879	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1880
		1881	=item $term->XDeleteProperty ($window, $property)
		1882
		1883	=item $window = $term->DefaultRootWindow
		1884
		1885	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1886
		1887	=item $term->XMapWindow ($window)
		1888
		1889	=item $term->XUnmapWindow ($window)
		1890
		1891	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1892
		1893	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1894
		1895	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1896
		1897	Various X or X-related functions. The C<$term> object only serves as
		1898	the source of the display, otherwise those functions map more-or-less
		1899	directory onto the X functions of the same name.
1333		1900
1334	=back	1901	=back
1335		1902
1336	=cut	1903	=cut
1337		1904
…		…
1401	my ($self, $text, $cb) = @_;	1968	my ($self, $text, $cb) = @_;
1402		1969
1403	$self->add_item ({ type => "button", text => $text, activate => $cb});	1970	$self->add_item ({ type => "button", text => $text, activate => $cb});
1404	}	1971	}
1405		1972
1406	=item $popup->add_toggle ($text, $cb, $initial_value)	1973	=item $popup->add_toggle ($text, $initial_value, $cb)
1407		1974
1408	Adds a toggle/checkbox item to the popup. Teh callback gets called	1975	Adds a toggle/checkbox item to the popup. The callback gets called
1409	whenever it gets toggled, with a boolean indicating its value as its first	1976	whenever it gets toggled, with a boolean indicating its new value as its
1410	argument.	1977	first argument.
1411		1978
1412	=cut	1979	=cut
1413		1980
1414	sub add_toggle {	1981	sub add_toggle {
1415	my ($self, $text, $cb, $value) = @_;	1982	my ($self, $text, $value, $cb) = @_;
1416		1983
1417	my $item; $item = {	1984	my $item; $item = {
1418	type => "button",	1985	type => "button",
1419	text => " $text",	1986	text => " $text",
1420	value => $value,	1987	value => $value,
…		…
1439	my $env = $self->{term}->env;	2006	my $env = $self->{term}->env;
1440	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2007	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1441	delete $env->{LC_ALL};	2008	delete $env->{LC_ALL};
1442	$env->{LC_CTYPE} = $self->{term}->locale;	2009	$env->{LC_CTYPE} = $self->{term}->locale;
1443		2010
1444	urxvt::term->new ($env, $self->{term}->resource ("name"),	2011	my $term = urxvt::term->new (
1445	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2012	$env, "popup",
		2013	"--perl-lib" => "", "--perl-ext-common" => "",
		2014	"-pty-fd" => -1, "-sl" => 0,
		2015	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1446	"--transient-for" => $self->{term}->parent,	2016	"--transient-for" => $self->{term}->parent,
1447	"-display" => $self->{term}->display_id,	2017	"-display" => $self->{term}->display_id,
1448	"-pe" => "urxvt-popup")	2018	"-pe" => "urxvt-popup",
1449	or die "unable to create popup window\n";	2019	) or die "unable to create popup window\n";
		2020
		2021	unless (delete $term->{urxvt_popup_init_done}) {
		2022	$term->ungrab;
		2023	$term->destroy;
		2024	die "unable to initialise popup window\n";
		2025	}
1450	}	2026	}
1451		2027
1452	sub DESTROY {	2028	sub DESTROY {
1453	my ($self) = @_;	2029	my ($self) = @_;
1454		2030
1455	delete $self->{term}{_destroy}{$self};	2031	delete $self->{term}{_destroy}{$self};
1456	$self->{term}->ungrab;	2032	$self->{term}->ungrab;
1457	}	2033	}
1458		2034
1459	=back	2035	=back
		2036
		2037	=cut
		2038
		2039	package urxvt::watcher;
1460		2040
1461	=head2 The C<urxvt::timer> Class	2041	=head2 The C<urxvt::timer> Class
1462		2042
1463	This class implements timer watchers/events. Time is represented as a	2043	This class implements timer watchers/events. Time is represented as a
1464	fractional number of seconds since the epoch. Example:	2044	fractional number of seconds since the epoch. Example:
…		…
1468	->new	2048	->new
1469	->interval (1)	2049	->interval (1)
1470	->cb (sub {	2050	->cb (sub {
1471	$term->{overlay}->set (0, 0,	2051	$term->{overlay}->set (0, 0,
1472	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2052	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1473	});	2053	});
1474		2054
1475	=over 4	2055	=over 4
1476		2056
1477	=item $timer = new urxvt::timer	2057	=item $timer = new urxvt::timer
1478		2058
…		…
1502	Start the timer.	2082	Start the timer.
1503		2083
1504	=item $timer = $timer->start ($tstamp)	2084	=item $timer = $timer->start ($tstamp)
1505		2085
1506	Set the event trigger time to C<$tstamp> and start the timer.	2086	Set the event trigger time to C<$tstamp> and start the timer.
		2087
		2088	=item $timer = $timer->after ($delay)
		2089
		2090	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1507		2091
1508	=item $timer = $timer->stop	2092	=item $timer = $timer->stop
1509		2093
1510	Stop the timer.	2094	Stop the timer.
1511		2095
…		…
1517		2101
1518	$term->{socket} = ...	2102	$term->{socket} = ...
1519	$term->{iow} = urxvt::iow	2103	$term->{iow} = urxvt::iow
1520	->new	2104	->new
1521	->fd (fileno $term->{socket})	2105	->fd (fileno $term->{socket})
1522	->events (urxvt::EVENT_READ)	2106	->events (urxvt::EV_READ)
1523	->start	2107	->start
1524	->cb (sub {	2108	->cb (sub {
1525	my ($iow, $revents) = @_;	2109	my ($iow, $revents) = @_;
1526	# $revents must be 1 here, no need to check	2110	# $revents must be 1 here, no need to check
1527	sysread $term->{socket}, my $buf, 8192	2111	sysread $term->{socket}, my $buf, 8192
…		…
1540	Set the callback to be called when io events are triggered. C<$reventmask>	2124	Set the callback to be called when io events are triggered. C<$reventmask>
1541	is a bitset as described in the C<events> method.	2125	is a bitset as described in the C<events> method.
1542		2126
1543	=item $iow = $iow->fd ($fd)	2127	=item $iow = $iow->fd ($fd)
1544		2128
1545	Set the filedescriptor (not handle) to watch.	2129	Set the file descriptor (not handle) to watch.
1546		2130
1547	=item $iow = $iow->events ($eventmask)	2131	=item $iow = $iow->events ($eventmask)
1548		2132
1549	Set the event mask to watch. The only allowed values are	2133	Set the event mask to watch. The only allowed values are
1550	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2134	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1551	together, or C<urxvt::EVENT_NONE>.	2135	together, or C<urxvt::EV_NONE>.
1552		2136
1553	=item $iow = $iow->start	2137	=item $iow = $iow->start
1554		2138
1555	Start watching for requested events on the given handle.	2139	Start watching for requested events on the given handle.
1556		2140
1557	=item $iow = $iow->stop	2141	=item $iow = $iow->stop
1558		2142
1559	Stop watching for events on the given filehandle.	2143	Stop watching for events on the given file handle.
		2144
		2145	=back
		2146
		2147	=head2 The C<urxvt::iw> Class
		2148
		2149	This class implements idle watchers, that get called automatically when
		2150	the process is idle. They should return as fast as possible, after doing
		2151	some useful work.
		2152
		2153	=over 4
		2154
		2155	=item $iw = new urxvt::iw
		2156
		2157	Create a new idle watcher object in stopped state.
		2158
		2159	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2160
		2161	Set the callback to be called when the watcher triggers.
		2162
		2163	=item $timer = $timer->start
		2164
		2165	Start the watcher.
		2166
		2167	=item $timer = $timer->stop
		2168
		2169	Stop the watcher.
		2170
		2171	=back
		2172
		2173	=head2 The C<urxvt::pw> Class
		2174
		2175	This class implements process watchers. They create an event whenever a
		2176	process exits, after which they stop automatically.
		2177
		2178	my $pid = fork;
		2179	...
		2180	$term->{pw} = urxvt::pw
		2181	->new
		2182	->start ($pid)
		2183	->cb (sub {
		2184	my ($pw, $exit_status) = @_;
		2185	...
		2186	});
		2187
		2188	=over 4
		2189
		2190	=item $pw = new urxvt::pw
		2191
		2192	Create a new process watcher in stopped state.
		2193
		2194	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2195
		2196	Set the callback to be called when the timer triggers.
		2197
		2198	=item $pw = $timer->start ($pid)
		2199
		2200	Tells the watcher to start watching for process C<$pid>.
		2201
		2202	=item $pw = $pw->stop
		2203
		2204	Stop the watcher.
1560		2205
1561	=back	2206	=back
1562		2207
1563	=head1 ENVIRONMENT	2208	=head1 ENVIRONMENT
1564		2209
…		…
1571		2216
1572	=item == 0 - fatal messages	2217	=item == 0 - fatal messages
1573		2218
1574	=item >= 3 - script loading and management	2219	=item >= 3 - script loading and management
1575		2220
1576	=item >=10 - all events received	2221	=item >=10 - all called hooks
		2222
		2223	=item >=11 - hook return values
1577		2224
1578	=back	2225	=back
1579		2226
1580	=head1 AUTHOR	2227	=head1 AUTHOR
1581		2228
…		…
1583	http://software.schmorp.de/pkg/rxvt-unicode	2230	http://software.schmorp.de/pkg/rxvt-unicode
1584		2231
1585	=cut	2232	=cut
1586		2233
1587	1	2234	1
		2235
		2236	# vim: sw=3:

Diff Legend

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