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.180 by root, Sat Dec 26 09:42:16 2009 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
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 = '5.23';
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}, $arg{interval})
715	->cb (sub {	1142	->cb ($arg{interval} ? $cb : sub {
716	$_[0]->stop; # need to cancel manually	1143	$_[0]->stop; # need to cancel manually
717	$cb->();	1144	$cb->();
718	})	1145	})
719	}	1146	}
720		1147
721	sub io {	1148	sub io {
722	my ($class, %arg) = @_;	1149	my ($class, %arg) = @_;
723		1150
724	my $cb = $arg{cb};	1151	my $cb = $arg{cb};
		1152	my $fd = fileno $arg{fh};
		1153	defined $fd or $fd = $arg{fh};
725		1154
726	bless [$arg{fh}, urxvt::iow	1155	bless [$arg{fh}, urxvt::iow
727	->new	1156	->new
728	->fd (fileno $arg{fh})	1157	->fd ($fd)
729	->events (($arg{poll} =~ /r/ ? 1 : 0)	1158	->events (($arg{poll} =~ /r/ ? 1 : 0)
730	| ($arg{poll} =~ /w/ ? 2 : 0))	1159	| ($arg{poll} =~ /w/ ? 2 : 0))
731	->start	1160	->start
732	->cb (sub {	1161	->cb ($cb)
733	$cb->(($_[1] & 1 ? 'r' : '')
734	. ($_[1] & 2 ? 'w' : ''));
735	})],
736	urxvt::anyevent::	1162	], urxvt::anyevent::
		1163	}
		1164
		1165	sub idle {
		1166	my ($class, %arg) = @_;
		1167
		1168	my $cb = $arg{cb};
		1169
		1170	urxvt::iw
		1171	->new
		1172	->start
		1173	->cb ($cb)
		1174	}
		1175
		1176	sub child {
		1177	my ($class, %arg) = @_;
		1178
		1179	my $cb = $arg{cb};
		1180
		1181	urxvt::pw
		1182	->new
		1183	->start ($arg{pid})
		1184	->cb (sub {
		1185	$_[0]->stop; # need to cancel manually
		1186	$cb->($_[0]->rpid, $_[0]->rstatus);
		1187	})
737	}	1188	}
738		1189
739	sub DESTROY {	1190	sub DESTROY {
740	$_[0][1]->stop;	1191	$_[0][1]->stop;
741	}	1192	}
742		1193
743	sub condvar {	1194	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";	1195	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
754	}
755	}	1196	}
756		1197
757	package urxvt::term;	1198	package urxvt::term;
758		1199
759	=head2 The C<urxvt::term> Class	1200	=head2 The C<urxvt::term> Class
…		…
764		1205
765	# find on_xxx subs in the package and register them	1206	# find on_xxx subs in the package and register them
766	# as hooks	1207	# as hooks
767	sub register_package {	1208	sub register_package {
768	my ($self, $pkg, $argv) = @_;	1209	my ($self, $pkg, $argv) = @_;
		1210
		1211	no strict 'refs';
		1212
		1213	urxvt::verbose 6, "register package $pkg to $self";
		1214
		1215	@{"$pkg\::ISA"} = urxvt::term::extension::;
769		1216
770	my $proxy = bless {	1217	my $proxy = bless {
771	_pkg => $pkg,	1218	_pkg => $pkg,
772	argv => $argv,	1219	argv => $argv,
773	}, $pkg;	1220	}, $pkg;
…		…
789	hash which defines the environment of the new terminal.	1236	hash which defines the environment of the new terminal.
790		1237
791	Croaks (and probably outputs an error message) if the new instance	1238	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	1239	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	1240	initialise perl, and the terminal object otherwise. The C<init> and
794	C<start> hooks will be called during this call.	1241	C<start> hooks will be called before this call returns, and are free to
		1242	refer to global data (which is race free).
795		1243
796	=cut	1244	=cut
797		1245
798	sub new {	1246	sub new {
799	my ($class, $env, @args) = @_;	1247	my ($class, $env, @args) = @_;
800		1248
		1249	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1250	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1251
801	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1252	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
802	}	1253	}
803		1254
804	=item $term->destroy	1255	=item $term->destroy
805		1256
806	Destroy the terminal object (close the window, free resources	1257	Destroy the terminal object (close the window, free resources
807	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1258	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
808	watchers (timers, io watchers) are still active.	1259	watchers (timers, io watchers) are still active.
809		1260
		1261	=item $term->exec_async ($cmd[, @args])
		1262
		1263	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1264	("starts") programs in the background. This function takes care of setting
		1265	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1266	be preferred over explicit calls to C<exec> or C<system>.
		1267
		1268	Returns the pid of the subprocess or C<undef> on error.
		1269
		1270	=cut
		1271
		1272	sub exec_async {
		1273	my $self = shift;
		1274
		1275	my $pid = fork;
		1276
		1277	return $pid
		1278	if !defined $pid or $pid;
		1279
		1280	%ENV = %{ $self->env };
		1281
		1282	exec @_;
		1283	urxvt::_exit 255;
		1284	}
		1285
810	=item $isset = $term->option ($optval[, $set])	1286	=item $isset = $term->option ($optval[, $set])
811		1287
812	Returns true if the option specified by C<$optval> is enabled, and	1288	Returns true if the option specified by C<$optval> is enabled, and
813	optionally change it. All option values are stored by name in the hash	1289	optionally change it. All option values are stored by name in the hash
814	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1290	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
815		1291
816	Here is a a likely non-exhaustive list of option names, please see the	1292	Here is a likely non-exhaustive list of option names, please see the
817	source file F</src/optinc.h> to see the actual list:	1293	source file F</src/optinc.h> to see the actual list:
818		1294
819	borderLess console cursorBlink cursorUnderline hold iconic insecure	1295	borderLess console cursorBlink cursorUnderline hold iconic insecure
820	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1296	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
821	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1297	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
822	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1298	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
823	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1299	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
824	tripleclickwords utmpInhibit visualBell	1300	transparent tripleclickwords utmpInhibit visualBell
825		1301
826	=item $value = $term->resource ($name[, $newval])	1302	=item $value = $term->resource ($name[, $newval])
827		1303
828	Returns the current resource value associated with a given name and	1304	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>	1305	optionally sets a new value. Setting values is most useful in the C<init>
…		…
838	likely change).	1314	likely change).
839		1315
840	Please note that resource strings will currently only be freed when the	1316	Please note that resource strings will currently only be freed when the
841	terminal is destroyed, so changing options frequently will eat memory.	1317	terminal is destroyed, so changing options frequently will eat memory.
842		1318
843	Here is a a likely non-exhaustive list of resource names, not all of which	1319	Here is a likely non-exhaustive list of resource names, not all of which
844	are supported in every build, please see the source file F</src/rsinc.h>	1320	are supported in every build, please see the source file F</src/rsinc.h>
845	to see the actual list:	1321	to see the actual list:
846		1322
847	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1323	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
848	borderLess color cursorBlink cursorUnderline cutchars delete_key	1324	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
849	display_name embed ext_bwidth fade font geometry hold iconName	1325	display_name embed ext_bwidth fade font geometry hold iconName
850	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1326	imFont imLocale inputMethod insecure int_bwidth intensityStyles
851	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1327	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
852	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1328	modifier mouseWheelScrollPage name override_redirect pastableTabs path
853	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1329	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
854	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1330	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
855	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1331	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
856	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1332	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
857	shade term_name title transparent transparent_all tripleclickwords	1333	secondaryScreen secondaryScroll shade term_name title
858	utmpInhibit visualBell	1334	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1335	visualBell
859		1336
860	=cut	1337	=cut
861		1338
862	sub resource($$;$) {	1339	sub resource($$;$) {
863	my ($self, $name) = (shift, shift);	1340	my ($self, $name) = (shift, shift);
864	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1341	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
865	&urxvt::term::_resource	1342	goto &urxvt::term::_resource
866	}	1343	}
867		1344
868	=item $value = $term->x_resource ($pattern)	1345	=item $value = $term->x_resource ($pattern)
869		1346
870	Returns the X-Resource for the given pattern, excluding the program or	1347	Returns the X-Resource for the given pattern, excluding the program or
…		…
895		1372
896	=item ($row, $col) = $term->selection_beg ([$row, $col])	1373	=item ($row, $col) = $term->selection_beg ([$row, $col])
897		1374
898	=item ($row, $col) = $term->selection_end ([$row, $col])	1375	=item ($row, $col) = $term->selection_end ([$row, $col])
899		1376
900	Return the current values of the selection mark, begin or end positions,	1377	Return the current values of the selection mark, begin or end positions.
901	and optionally set them to new values.	1378
		1379	When arguments are given, then the selection coordinates are set to
		1380	C<$row> and C<$col>, and the selection screen is set to the current
		1381	screen.
		1382
		1383	=item $screen = $term->selection_screen ([$screen])
		1384
		1385	Returns the current selection screen, and then optionally sets it.
		1386
		1387	=item $term->selection_make ($eventtime[, $rectangular])
		1388
		1389	Tries to make a selection as set by C<selection_beg> and
		1390	C<selection_end>. If C<$rectangular> is true (default: false), a
		1391	rectangular selection will be made. This is the prefered function to make
		1392	a selection.
902		1393
903	=item $success = $term->selection_grab ($eventtime)	1394	=item $success = $term->selection_grab ($eventtime)
904		1395
905	Try to request the primary selection from the server (for example, as set	1396	Try to request the primary selection text from the server (for example, as
906	by the next method).	1397	set by the next method). No visual feedback will be given. This function
		1398	is mostly useful from within C<on_sel_grab> hooks.
907		1399
908	=item $oldtext = $term->selection ([$newtext])	1400	=item $oldtext = $term->selection ([$newtext])
909		1401
910	Return the current selection text and optionally replace it by C<$newtext>.	1402	Return the current selection text and optionally replace it by C<$newtext>.
911		1403
…		…
945		1437
946	The methods currently supported on C<urxvt::overlay> objects are:	1438	The methods currently supported on C<urxvt::overlay> objects are:
947		1439
948	=over 4	1440	=over 4
949		1441
950	=item $overlay->set ($x, $y, $text, $rend)	1442	=item $overlay->set ($x, $y, $text[, $rend])
951		1443
952	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1444	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
953	text in rxvt-unicode's special encoding and an array of rendition values	1445	text in rxvt-unicode's special encoding and an array of rendition values
954	at a specific position inside the overlay.	1446	at a specific position inside the overlay.
		1447
		1448	If C<$rend> is missing, then the rendition will not be changed.
955		1449
956	=item $overlay->hide	1450	=item $overlay->hide
957		1451
958	If visible, hide the overlay, but do not destroy it.	1452	If visible, hide the overlay, but do not destroy it.
959		1453
…		…
1004	Convert the given locale-encoded octets into a perl string.	1498	Convert the given locale-encoded octets into a perl string.
1005		1499
1006	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1500	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1007		1501
1008	XORs the rendition values in the given span with the provided value	1502	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	1503	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1010	to the selection.	1504	refresh hooks to provide effects similar to the selection.
1011		1505
1012	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1506	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1013		1507
1014	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1508	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1015	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1509	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	1510	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1017	it instead.	1511	it instead. Both styles I<MUST NOT> contain font styles.
1018		1512
1019	=item $term->scr_bell	1513	=item $term->scr_bell
1020		1514
1021	Ring the bell!	1515	Ring the bell!
1022		1516
…		…
1029		1523
1030	Normally its not a good idea to use this function, as programs might be	1524	Normally its not a good idea to use this function, as programs might be
1031	confused by changes in cursor position or scrolling. Its useful inside a	1525	confused by changes in cursor position or scrolling. Its useful inside a
1032	C<on_add_lines> hook, though.	1526	C<on_add_lines> hook, though.
1033		1527
		1528	=item $term->scr_change_screen ($screen)
		1529
		1530	Switch to given screen - 0 primary, 1 secondary.
		1531
1034	=item $term->cmd_parse ($octets)	1532	=item $term->cmd_parse ($octets)
1035		1533
1036	Similar to C<scr_add_lines>, but the argument must be in the	1534	Similar to C<scr_add_lines>, but the argument must be in the
1037	locale-specific encoding of the terminal and can contain command sequences	1535	locale-specific encoding of the terminal and can contain command sequences
1038	(escape codes) that will be interpreted.	1536	(escape codes) that will be interpreted.
…		…
1048	Replaces the event mask of the pty watcher by the given event mask. Can	1546	Replaces the event mask of the pty watcher by the given event mask. Can
1049	be used to suppress input and output handling to the pty/tty. See the	1547	be used to suppress input and output handling to the pty/tty. See the
1050	description of C<< urxvt::timer->events >>. Make sure to always restore	1548	description of C<< urxvt::timer->events >>. Make sure to always restore
1051	the previous value.	1549	the previous value.
1052		1550
		1551	=item $fd = $term->pty_fd
		1552
		1553	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1554	is used.
		1555
1053	=item $windowid = $term->parent	1556	=item $windowid = $term->parent
1054		1557
1055	Return the window id of the toplevel window.	1558	Return the window id of the toplevel window.
1056		1559
1057	=item $windowid = $term->vt	1560	=item $windowid = $term->vt
1058		1561
1059	Return the window id of the terminal window.	1562	Return the window id of the terminal window.
1060		1563
		1564	=item $term->vt_emask_add ($x_event_mask)
		1565
		1566	Adds the specified events to the vt event mask. Useful e.g. when you want
		1567	to receive pointer events all the times:
		1568
		1569	$term->vt_emask_add (urxvt::PointerMotionMask);
		1570
		1571	=item $term->focus_in
		1572
		1573	=item $term->focus_out
		1574
		1575	=item $term->key_press ($state, $keycode[, $time])
		1576
		1577	=item $term->key_release ($state, $keycode[, $time])
		1578
		1579	Deliver various fake events to to terminal.
		1580
1061	=item $window_width = $term->width	1581	=item $window_width = $term->width
1062		1582
1063	=item $window_height = $term->height	1583	=item $window_height = $term->height
1064		1584
1065	=item $font_width = $term->fwidth	1585	=item $font_width = $term->fwidth
…		…
1078		1598
1079	=item $max_scrollback = $term->saveLines	1599	=item $max_scrollback = $term->saveLines
1080		1600
1081	=item $nrow_plus_saveLines = $term->total_rows	1601	=item $nrow_plus_saveLines = $term->total_rows
1082		1602
1083	=item $lines_in_scrollback = $term->nsaved	1603	=item $topmost_scrollback_row = $term->top_row
1084		1604
1085	Return various integers describing terminal characteristics.	1605	Return various integers describing terminal characteristics.
1086		1606
1087	=item $x_display = $term->display_id	1607	=item $x_display = $term->display_id
1088		1608
…		…
1095	=item $env = $term->env	1615	=item $env = $term->env
1096		1616
1097	Returns a copy of the environment in effect for the terminal as a hashref	1617	Returns a copy of the environment in effect for the terminal as a hashref
1098	similar to C<\%ENV>.	1618	similar to C<\%ENV>.
1099		1619
		1620	=item @envv = $term->envv
		1621
		1622	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1623
		1624	=item @argv = $term->argv
		1625
		1626	Return the argument vector as this terminal, similar to @ARGV, but
		1627	includes the program name as first element.
		1628
1100	=cut	1629	=cut
1101		1630
1102	sub env {	1631	sub env {
1103	if (my $env = $_[0]->_env) {
1104	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1632	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1105	} else {
1106	+{ %ENV }
1107	}
1108	}	1633	}
1109		1634
1110	=item $modifiermask = $term->ModLevel3Mask	1635	=item $modifiermask = $term->ModLevel3Mask
1111		1636
1112	=item $modifiermask = $term->ModMetaMask	1637	=item $modifiermask = $term->ModMetaMask
…		…
1114	=item $modifiermask = $term->ModNumLockMask	1639	=item $modifiermask = $term->ModNumLockMask
1115		1640
1116	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1641	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1117	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1642	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1118		1643
		1644	=item $screen = $term->current_screen
		1645
		1646	Returns the currently displayed screen (0 primary, 1 secondary).
		1647
		1648	=item $cursor_is_hidden = $term->hidden_cursor
		1649
		1650	Returns whether the cursor is currently hidden or not.
		1651
1119	=item $view_start = $term->view_start ([$newvalue])	1652	=item $view_start = $term->view_start ([$newvalue])
1120		1653
1121	Returns the negative row number of the topmost line. Minimum value is	1654	Returns the row number of the topmost displayed line. Maximum value is
1122	C<0>, which displays the normal terminal contents. Larger values scroll	1655	C<0>, which displays the normal terminal contents. Lower values scroll
1123	this many lines into the scrollback buffer.	1656	this many lines into the scrollback buffer.
1124		1657
1125	=item $term->want_refresh	1658	=item $term->want_refresh
1126		1659
1127	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1660	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1130		1663
1131	Used after changing terminal contents to display them.	1664	Used after changing terminal contents to display them.
1132		1665
1133	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1666	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1134		1667
1135	Returns the text of the entire row with number C<$row_number>. Row C<0>	1668	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1136	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1669	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
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	1670	terminal line. Nothing will be returned if a nonexistent line
1139	is requested.	1671	is requested.
1140		1672
1141	If C<$new_text> is specified, it will replace characters in the current	1673	If C<$new_text> is specified, it will replace characters in the current
1142	line, starting at column C<$start_col> (default C<0>), which is useful	1674	line, starting at column C<$start_col> (default C<0>), which is useful
1143	to replace only parts of a line. The font index in the rendition will	1675	to replace only parts of a line. The font index in the rendition will
1144	automatically be updated.	1676	automatically be updated.
1145		1677
1146	C<$text> is in a special encoding: tabs and wide characters that use more	1678	C<$text> is in a special encoding: tabs and wide characters that use more
1147	than one cell when displayed are padded with urxvt::NOCHAR characters	1679	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1148	(C<chr 65535>). Characters with combining characters and other characters	1680	characters. Characters with combining characters and other characters that
1149	that do not fit into the normal tetx encoding will be replaced with	1681	do not fit into the normal text encoding will be replaced with characters
1150	characters in the private use area.	1682	in the private use area.
1151		1683
1152	You have to obey this encoding when changing text. The advantage is	1684	You have to obey this encoding when changing text. The advantage is
1153	that C<substr> and similar functions work on screen cells and not on	1685	that C<substr> and similar functions work on screen cells and not on
1154	characters.	1686	characters.
1155		1687
…		…
1206	Return the row number of the first/last row of the line, respectively.	1738	Return the row number of the first/last row of the line, respectively.
1207		1739
1208	=item $offset = $line->offset_of ($row, $col)	1740	=item $offset = $line->offset_of ($row, $col)
1209		1741
1210	Returns the character offset of the given row|col pair within the logical	1742	Returns the character offset of the given row|col pair within the logical
1211	line.	1743	line. Works for rows outside the line, too, and returns corresponding
		1744	offsets outside the string.
1212		1745
1213	=item ($row, $col) = $line->coord_of ($offset)	1746	=item ($row, $col) = $line->coord_of ($offset)
1214		1747
1215	Translates a string offset into terminal coordinates again.	1748	Translates a string offset into terminal coordinates again.
1216		1749
…		…
1298	where one character corresponds to one screen cell. See	1831	where one character corresponds to one screen cell. See
1299	C<< $term->ROW_t >> for details.	1832	C<< $term->ROW_t >> for details.
1300		1833
1301	=item $string = $term->special_decode $text	1834	=item $string = $term->special_decode $text
1302		1835
1303	Converts rxvt-unicodes text reprsentation into a perl string. See	1836	Converts rxvt-unicodes text representation into a perl string. See
1304	C<< $term->ROW_t >> for details.	1837	C<< $term->ROW_t >> for details.
1305		1838
1306	=item $success = $term->grab_button ($button, $modifiermask)	1839	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1307		1840
		1841	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1842
1308	Registers a synchronous button grab. See the XGrabButton manpage.	1843	Register/unregister a synchronous button grab. See the XGrabButton
		1844	manpage.
1309		1845
1310	=item $success = $term->grab ($eventtime[, $sync])	1846	=item $success = $term->grab ($eventtime[, $sync])
1311		1847
1312	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1848	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1313	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1849	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1314		1850
1315	=item $term->allow_events_async	1851	=item $term->allow_events_async
1316		1852
1317	Calls XAllowEvents with AsyncBoth for the most recent grab.	1853	Calls XAllowEvents with AsyncBoth for the most recent grab.
1318		1854
…		…
1328	=item $term->ungrab	1864	=item $term->ungrab
1329		1865
1330	Calls XUngrab for the most recent grab. Is called automatically on	1866	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	1867	evaluation errors, as it is better to lose the grab in the error case as
1332	the session.	1868	the session.
		1869
		1870	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1871
		1872	=item $atom_name = $term->XGetAtomName ($atom)
		1873
		1874	=item @atoms = $term->XListProperties ($window)
		1875
		1876	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1877
		1878	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1879
		1880	=item $term->XDeleteProperty ($window, $property)
		1881
		1882	=item $window = $term->DefaultRootWindow
		1883
		1884	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1885
		1886	=item $term->XMapWindow ($window)
		1887
		1888	=item $term->XUnmapWindow ($window)
		1889
		1890	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1891
		1892	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1893
		1894	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1895
		1896	Various X or X-related functions. The C<$term> object only serves as
		1897	the source of the display, otherwise those functions map more-or-less
		1898	directory onto the X functions of the same name.
1333		1899
1334	=back	1900	=back
1335		1901
1336	=cut	1902	=cut
1337		1903
…		…
1401	my ($self, $text, $cb) = @_;	1967	my ($self, $text, $cb) = @_;
1402		1968
1403	$self->add_item ({ type => "button", text => $text, activate => $cb});	1969	$self->add_item ({ type => "button", text => $text, activate => $cb});
1404	}	1970	}
1405		1971
1406	=item $popup->add_toggle ($text, $cb, $initial_value)	1972	=item $popup->add_toggle ($text, $initial_value, $cb)
1407		1973
1408	Adds a toggle/checkbox item to the popup. Teh callback gets called	1974	Adds a toggle/checkbox item to the popup. The callback gets called
1409	whenever it gets toggled, with a boolean indicating its value as its first	1975	whenever it gets toggled, with a boolean indicating its new value as its
1410	argument.	1976	first argument.
1411		1977
1412	=cut	1978	=cut
1413		1979
1414	sub add_toggle {	1980	sub add_toggle {
1415	my ($self, $text, $cb, $value) = @_;	1981	my ($self, $text, $value, $cb) = @_;
1416		1982
1417	my $item; $item = {	1983	my $item; $item = {
1418	type => "button",	1984	type => "button",
1419	text => " $text",	1985	text => " $text",
1420	value => $value,	1986	value => $value,
…		…
1439	my $env = $self->{term}->env;	2005	my $env = $self->{term}->env;
1440	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2006	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1441	delete $env->{LC_ALL};	2007	delete $env->{LC_ALL};
1442	$env->{LC_CTYPE} = $self->{term}->locale;	2008	$env->{LC_CTYPE} = $self->{term}->locale;
1443		2009
1444	urxvt::term->new ($env, $self->{term}->resource ("name"),	2010	my $term = urxvt::term->new (
1445	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2011	$env, "popup",
		2012	"--perl-lib" => "", "--perl-ext-common" => "",
		2013	"-pty-fd" => -1, "-sl" => 0,
		2014	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1446	"--transient-for" => $self->{term}->parent,	2015	"--transient-for" => $self->{term}->parent,
1447	"-display" => $self->{term}->display_id,	2016	"-display" => $self->{term}->display_id,
1448	"-pe" => "urxvt-popup")	2017	"-pe" => "urxvt-popup",
1449	or die "unable to create popup window\n";	2018	) or die "unable to create popup window\n";
		2019
		2020	unless (delete $term->{urxvt_popup_init_done}) {
		2021	$term->ungrab;
		2022	$term->destroy;
		2023	die "unable to initialise popup window\n";
		2024	}
1450	}	2025	}
1451		2026
1452	sub DESTROY {	2027	sub DESTROY {
1453	my ($self) = @_;	2028	my ($self) = @_;
1454		2029
1455	delete $self->{term}{_destroy}{$self};	2030	delete $self->{term}{_destroy}{$self};
1456	$self->{term}->ungrab;	2031	$self->{term}->ungrab;
1457	}	2032	}
1458		2033
1459	=back	2034	=back
		2035
		2036	=cut
		2037
		2038	package urxvt::watcher;
1460		2039
1461	=head2 The C<urxvt::timer> Class	2040	=head2 The C<urxvt::timer> Class
1462		2041
1463	This class implements timer watchers/events. Time is represented as a	2042	This class implements timer watchers/events. Time is represented as a
1464	fractional number of seconds since the epoch. Example:	2043	fractional number of seconds since the epoch. Example:
…		…
1468	->new	2047	->new
1469	->interval (1)	2048	->interval (1)
1470	->cb (sub {	2049	->cb (sub {
1471	$term->{overlay}->set (0, 0,	2050	$term->{overlay}->set (0, 0,
1472	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2051	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1473	});	2052	});
1474		2053
1475	=over 4	2054	=over 4
1476		2055
1477	=item $timer = new urxvt::timer	2056	=item $timer = new urxvt::timer
1478		2057
…		…
1481		2060
1482	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2061	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1483		2062
1484	Set the callback to be called when the timer triggers.	2063	Set the callback to be called when the timer triggers.
1485		2064
1486	=item $tstamp = $timer->at
1487
1488	Return the time this watcher will fire next.
1489
1490	=item $timer = $timer->set ($tstamp)	2065	=item $timer = $timer->set ($tstamp[, $interval])
1491		2066
1492	Set the time the event is generated to $tstamp.	2067	Set the time the event is generated to $tstamp (and optionally specifies a
		2068	new $interval).
1493		2069
1494	=item $timer = $timer->interval ($interval)	2070	=item $timer = $timer->interval ($interval)
1495		2071
1496	Normally (and when C<$interval> is C<0>), the timer will automatically	2072	By default (and when C<$interval> is C<0>), the timer will automatically
1497	stop after it has fired once. If C<$interval> is non-zero, then the timer	2073	stop after it has fired once. If C<$interval> is non-zero, then the timer
1498	is automatically rescheduled at the given intervals.	2074	is automatically rescheduled at the given intervals.
1499		2075
1500	=item $timer = $timer->start	2076	=item $timer = $timer->start
1501		2077
1502	Start the timer.	2078	Start the timer.
1503		2079
1504	=item $timer = $timer->start ($tstamp)	2080	=item $timer = $timer->start ($tstamp[, $interval])
1505		2081
1506	Set the event trigger time to C<$tstamp> and start the timer.	2082	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2083	also replaces the interval.
		2084
		2085	=item $timer = $timer->after ($delay[, $interval])
		2086
		2087	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1507		2088
1508	=item $timer = $timer->stop	2089	=item $timer = $timer->stop
1509		2090
1510	Stop the timer.	2091	Stop the timer.
1511		2092
…		…
1517		2098
1518	$term->{socket} = ...	2099	$term->{socket} = ...
1519	$term->{iow} = urxvt::iow	2100	$term->{iow} = urxvt::iow
1520	->new	2101	->new
1521	->fd (fileno $term->{socket})	2102	->fd (fileno $term->{socket})
1522	->events (urxvt::EVENT_READ)	2103	->events (urxvt::EV_READ)
1523	->start	2104	->start
1524	->cb (sub {	2105	->cb (sub {
1525	my ($iow, $revents) = @_;	2106	my ($iow, $revents) = @_;
1526	# $revents must be 1 here, no need to check	2107	# $revents must be 1 here, no need to check
1527	sysread $term->{socket}, my $buf, 8192	2108	sysread $term->{socket}, my $buf, 8192
…		…
1540	Set the callback to be called when io events are triggered. C<$reventmask>	2121	Set the callback to be called when io events are triggered. C<$reventmask>
1541	is a bitset as described in the C<events> method.	2122	is a bitset as described in the C<events> method.
1542		2123
1543	=item $iow = $iow->fd ($fd)	2124	=item $iow = $iow->fd ($fd)
1544		2125
1545	Set the filedescriptor (not handle) to watch.	2126	Set the file descriptor (not handle) to watch.
1546		2127
1547	=item $iow = $iow->events ($eventmask)	2128	=item $iow = $iow->events ($eventmask)
1548		2129
1549	Set the event mask to watch. The only allowed values are	2130	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	2131	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1551	together, or C<urxvt::EVENT_NONE>.	2132	together, or C<urxvt::EV_NONE>.
1552		2133
1553	=item $iow = $iow->start	2134	=item $iow = $iow->start
1554		2135
1555	Start watching for requested events on the given handle.	2136	Start watching for requested events on the given handle.
1556		2137
1557	=item $iow = $iow->stop	2138	=item $iow = $iow->stop
1558		2139
1559	Stop watching for events on the given filehandle.	2140	Stop watching for events on the given file handle.
		2141
		2142	=back
		2143
		2144	=head2 The C<urxvt::iw> Class
		2145
		2146	This class implements idle watchers, that get called automatically when
		2147	the process is idle. They should return as fast as possible, after doing
		2148	some useful work.
		2149
		2150	=over 4
		2151
		2152	=item $iw = new urxvt::iw
		2153
		2154	Create a new idle watcher object in stopped state.
		2155
		2156	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2157
		2158	Set the callback to be called when the watcher triggers.
		2159
		2160	=item $timer = $timer->start
		2161
		2162	Start the watcher.
		2163
		2164	=item $timer = $timer->stop
		2165
		2166	Stop the watcher.
		2167
		2168	=back
		2169
		2170	=head2 The C<urxvt::pw> Class
		2171
		2172	This class implements process watchers. They create an event whenever a
		2173	process exits, after which they stop automatically.
		2174
		2175	my $pid = fork;
		2176	...
		2177	$term->{pw} = urxvt::pw
		2178	->new
		2179	->start ($pid)
		2180	->cb (sub {
		2181	my ($pw, $exit_status) = @_;
		2182	...
		2183	});
		2184
		2185	=over 4
		2186
		2187	=item $pw = new urxvt::pw
		2188
		2189	Create a new process watcher in stopped state.
		2190
		2191	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2192
		2193	Set the callback to be called when the timer triggers.
		2194
		2195	=item $pw = $timer->start ($pid)
		2196
		2197	Tells the watcher to start watching for process C<$pid>.
		2198
		2199	=item $pw = $pw->stop
		2200
		2201	Stop the watcher.
1560		2202
1561	=back	2203	=back
1562		2204
1563	=head1 ENVIRONMENT	2205	=head1 ENVIRONMENT
1564		2206
…		…
1571		2213
1572	=item == 0 - fatal messages	2214	=item == 0 - fatal messages
1573		2215
1574	=item >= 3 - script loading and management	2216	=item >= 3 - script loading and management
1575		2217
1576	=item >=10 - all events received	2218	=item >=10 - all called hooks
		2219
		2220	=item >=11 - hook return values
1577		2221
1578	=back	2222	=back
1579		2223
1580	=head1 AUTHOR	2224	=head1 AUTHOR
1581		2225
…		…
1583	http://software.schmorp.de/pkg/rxvt-unicode	2227	http://software.schmorp.de/pkg/rxvt-unicode
1584		2228
1585	=cut	2229	=cut
1586		2230
1587	1	2231	1
		2232
		2233	# vim: sw=3:

Diff Legend

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