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.54 by root, Sun Jan 8 01:59:29 2006 UTC vs.
Revision 1.144 by root, Mon Aug 7 15:59:44 2006 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	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	Intelligent selection. This extension tries to be more intelligent when	48	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	49	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	50	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
49	It also offers the following bindable event:	54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the following adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\|([^|]+)\\|
		71
		72	Another example: Programs I use often output "absolute path: " at the
		73	beginning of a line when they process multiple files. The following
		74	pattern matches the filename (note, there is a single space at the very
		75	end):
		76
		77	URxvt.selection.pattern-0: ^(/[^:]+):\
		78
		79	You can look at the source of the selection extension to see more
		80	interesting uses, such as parsing a line from beginning to end.
		81
		82	This extension also offers following bindable keyboard commands:
50		83
51	=over 4	84	=over 4
52		85
53	=item rot13	86	=item rot13
54		87
…		…
58		91
59	=back	92	=back
60		93
61	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
62		95
63	Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at	96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	97	runtime.
65		98
66	=item digital-clock	99	Other extensions can extend this popup menu by pushing a code reference
		100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		101	popup is being displayed.
67		102
68	Displays a digital clock using the built-in overlay.	103	It's sole argument is the popup menu, which can be modified. It should
		104	either return nothing or a string, the initial boolean value and a code
		105	reference. The string will be used as button text and the code reference
		106	will be called when the toggle changes, with the new boolean value as
		107	first argument.
		108
		109	The following will add an entry C<myoption> that changes
		110	C<$self->{myoption}>:
		111
		112	push @{ $self->{term}{option_popup_hook} }, sub {
		113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		114	};
		115
		116	=item selection-popup (enabled by default)
		117
		118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		119	text into various other formats/action (such as uri unescaping, perl
		120	evaluation, web-browser starting etc.), depending on content.
		121
		122	Other extensions can extend this popup menu by pushing a code reference
		123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		124	popup is being displayed.
		125
		126	It's sole argument is the popup menu, which can be modified. The selection
		127	is in C<$_>, which can be used to decide whether to add something or not.
		128	It should either return nothing or a string and a code reference. The
		129	string will be used as button text and the code reference will be called
		130	when the button gets activated and should transform C<$_>.
		131
		132	The following will add an entry C<a to b> that transforms all C<a>s in
		133	the selection to C<b>s, but only if the selection currently contains any
		134	C<a>s:
		135
		136	push @{ $self->{term}{selection_popup_hook} }, sub {
		137	/a/ ? ("a to be" => sub { s/a/b/g }
		138	: ()
		139	};
		140
		141	=item searchable-scrollback<hotkey> (enabled by default)
		142
		143	Adds regex search functionality to the scrollback buffer, triggered
		144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		145	input/output is suspended and a regex is displayed at the bottom of the
		146	screen.
		147
		148	Inputting characters appends them to the regex and continues incremental
		149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		151	bottom. C<Escape> leaves search mode and returns to the point where search
		152	was started, while C<Enter> or C<Return> stay at the current position and
		153	additionally stores the first match in the current line into the primary
		154	selection.
		155
		156	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		157	get a case-sensitive search you can delete this prefix using C<BackSpace>
		158	or simply use an uppercase character which removes the "(?i)" prefix.
		159
		160	See L<perlre> for more info about perl regular expression syntax.
		161
		162	=item readline (enabled by default)
		163
		164	A support package that tries to make editing with readline easier. At
		165	the moment, it reacts to clicking shift-left mouse button by trying to
		166	move the text cursor to this position. It does so by generating as many
		167	cursor-left or cursor-right keypresses as required (the this only works
		168	for programs that correctly support wide characters).
		169
		170	To avoid too many false positives, this is only done when:
		171
		172	=over 4
		173
		174	=item - the tty is in ICANON state.
		175
		176	=item - the text cursor is visible.
		177
		178	=item - the primary screen is currently being displayed.
		179
		180	=item - the mouse is on the same (multi-row-) line as the text cursor.
		181
		182	=back
		183
		184	The normal selection mechanism isn't disabled, so quick successive clicks
		185	might interfere with selection creation in harmless ways.
		186
		187	=item selection-autotransform
		188
		189	This selection allows you to do automatic transforms on a selection
		190	whenever a selection is made.
		191
		192	It works by specifying perl snippets (most useful is a single C<s///>
		193	operator) that modify C<$_> as resources:
		194
		195	URxvt.selection-autotransform.0: transform
		196	URxvt.selection-autotransform.1: transform
		197	...
		198
		199	For example, the following will transform selections of the form
		200	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		201	$word>:
		202
		203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		204
		205	And this example matches the same,but replaces it with vi-commands you can
		206	paste directly into your (vi :) editor:
		207
		208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		209
		210	Of course, this can be modified to suit your needs and your editor :)
		211
		212	To expand the example above to typical perl error messages ("XXX at
		213	FILENAME line YYY."), you need a slightly more elaborate solution:
		214
		215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		217
		218	The first line tells the selection code to treat the unchanging part of
		219	every error message as a selection pattern, and the second line transforms
		220	the message into vi commands to load the file.
		221
		222	=item tabbed
		223
		224	This transforms the terminal into a tabbar with additional terminals, that
		225	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		227	button per tab.
		228
		229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		230	B<Shift-Right> will switch to the tab left or right of the current one,
		231	while B<Shift-Down> creates a new tab.
		232
		233	The tabbar itself can be configured similarly to a normal terminal, but
		234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		235	following four resources (shown with defaults):
		236
		237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		239	URxvt.tabbed.tab-fg: <colour-index, default 0>
		240	URxvt.tabbed.tab-bg: <colour-index, default 1>
		241
		242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		243	indices.
69		244
70	=item mark-urls	245	=item mark-urls
71		246
72	Uses per-line display filtering (C<on_line_update>) to underline urls.	247	Uses per-line display filtering (C<on_line_update>) to underline urls and
		248	make them clickable. When middle-clicked, the program specified in the
		249	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		250	the URL as first argument.
		251
		252	=item xim-onthespot
		253
		254	This (experimental) perl extension implements OnTheSpot editing. It does
		255	not work perfectly, and some input methods don't seem to work well with
		256	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		257	kinput2.
		258
		259	You enable it by specifying this extension and a preedit style of
		260	C<OnTheSpot>, i.e.:
		261
		262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		263
		264	=item kuake<hotkey>
		265
		266	A very primitive quake-console-like extension. It was inspired by a
		267	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		268	user presses a global accelerator key (by default C<F10>), the terminal
		269	will show or hide itself. Another press of the accelerator key will hide
		270	or show it again.
		271
		272	Initially, the window will not be shown when using this extension.
		273
		274	This is useful if you need a single terminal thats not using any desktop
		275	space most of the time but is quickly available at the press of a key.
		276
		277	The accelerator key is grabbed regardless of any modifiers, so this
		278	extension will actually grab a physical key just for this function.
		279
		280	If you want a quake-like animation, tell your window manager to do so
		281	(fvwm can do it).
		282
		283	=item automove-background
		284
		285	This is basically a very small extension that dynamically changes the
		286	background pixmap offset to the window position, in effect creating the
		287	same effect as pseudo transparency with a custom pixmap. No scaling is
		288	supported in this mode. Example:
		289
		290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
73		291
74	=item block-graphics-to-ascii	292	=item block-graphics-to-ascii
75		293
76	A not very useful example of filtering all text output to the terminal,	294	A not very useful example of filtering all text output to the terminal
77	by replacing all line-drawing characters (U+2500 .. U+259F) by a	295	by replacing all line-drawing characters (U+2500 .. U+259F) by a
78	similar-looking ascii character.	296	similar-looking ascii character.
		297
		298	=item digital-clock
		299
		300	Displays a digital clock using the built-in overlay.
		301
		302	=item remote-clipboard
		303
		304	Somewhat of a misnomer, this extension adds two menu entries to the
		305	selection popup that allows one ti run external commands to store the
		306	selection somewhere and fetch it again.
		307
		308	We use it to implement a "distributed selection mechanism", which just
		309	means that one command uploads the file to a remote server, and another
		310	reads it.
		311
		312	The commands can be set using the C<URxvt.remote-selection.store> and
		313	C<URxvt.remote-selection.fetch> resources. The first should read the
		314	selection to store from STDIN (always in UTF-8), the second should provide
		315	the selection data on STDOUT (also in UTF-8).
		316
		317	The defaults (which are likely useless to you) use rsh and cat:
		318
		319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		321
		322	=item selection-pastebin
		323
		324	This is a little rarely useful extension that Uploads the selection as
		325	textfile to a remote site (or does other things). (The implementation is
		326	not currently secure for use in a multiuser environment as it writes to
		327	F</tmp> directly.).
		328
		329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		330	i.e.
		331
		332	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		333
		334	Pressing this combination runs a command with C<%> replaced by the name of
		335	the textfile. This command can be set via a resource:
		336
		337	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		338
		339	And the default is likely not useful to anybody but the few people around
		340	here :)
		341
		342	The name of the textfile is the hex encoded md5 sum of the selection, so
		343	the same content should lead to the same filename.
		344
		345	After a successful upload the selection will be replaced by the text given
		346	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		347	for the filename):
		348
		349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
79		350
80	=item example-refresh-hooks	351	=item example-refresh-hooks
81		352
82	Displays a very simple digital clock in the upper right corner of the	353	Displays a very simple digital clock in the upper right corner of the
83	window. Illustrates overwriting the refresh callbacks to create your own	354	window. Illustrates overwriting the refresh callbacks to create your own
84	overlays or changes.	355	overlays or changes.
85		356
86	=back	357	=back
		358
		359	=head1 API DOCUMENTATION
87		360
88	=head2 General API Considerations	361	=head2 General API Considerations
89		362
90	All objects (such as terminals, time watchers etc.) are typical	363	All objects (such as terminals, time watchers etc.) are typical
91	reference-to-hash objects. The hash can be used to store anything you	364	reference-to-hash objects. The hash can be used to store anything you
…		…
104	=over 4	377	=over 4
105		378
106	=item $text	379	=item $text
107		380
108	Rxvt-unicodes special way of encoding text, where one "unicode" character	381	Rxvt-unicodes special way of encoding text, where one "unicode" character
109	always represents one screen cell. See L<row_t> for a discussion of this format.	382	always represents one screen cell. See L<ROW_t> for a discussion of this format.
110		383
111	=item $string	384	=item $string
112		385
113	A perl text string, with an emphasis on I<text>. It can store all unicode	386	A perl text string, with an emphasis on I<text>. It can store all unicode
114	characters and is to be distinguished with text encoded in a specific	387	characters and is to be distinguished with text encoded in a specific
…		…
119	Either binary data or - more common - a text string encoded in a	392	Either binary data or - more common - a text string encoded in a
120	locale-specific way.	393	locale-specific way.
121		394
122	=back	395	=back
123		396
		397	=head2 Extension Objects
		398
		399	Every perl extension is a perl class. A separate perl object is created
		400	for each terminal and each extension and passed as the first parameter to
		401	hooks. So extensions can use their C<$self> object without having to think
		402	about other extensions, with the exception of methods and members that
		403	begin with an underscore character C<_>: these are reserved for internal
		404	use.
		405
		406	Although it isn't a C<urxvt::term> object, you can call all methods of the
		407	C<urxvt::term> class on this object.
		408
		409	It has the following methods and data members:
		410
		411	=over 4
		412
		413	=item $urxvt_term = $self->{term}
		414
		415	Returns the C<urxvt::term> object associated with this instance of the
		416	extension. This member I<must not> be changed in any way.
		417
		418	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		419
		420	Dynamically enable the given hooks (named without the C<on_> prefix) for
		421	this extension, replacing any previous hook. This is useful when you want
		422	to overwrite time-critical hooks only temporarily.
		423
		424	=item $self->disable ($hook_name[, $hook_name..])
		425
		426	Dynamically disable the given hooks.
		427
		428	=back
		429
124	=head2 Hooks	430	=head2 Hooks
125		431
126	The following subroutines can be declared in extension files, and will be	432	The following subroutines can be declared in extension files, and will be
127	called whenever the relevant event happens.	433	called whenever the relevant event happens.
128		434
129	The first argument passed to them is an object private to each terminal	435	The first argument passed to them is an extension object as described in
130	and extension package. You can call all C<urxvt::term> methods on it, but	436	the in the C<Extension Objects> section.
131	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
132	object that is shared between all packages is stored in the C<term>
133	member. It is, however, blessed intot he package of the extension script,
134	so for all practical purposes you can treat an extension script as a class.
135		437
136	All of them must return a boolean value. If it is true, then the event	438	B<All> of these hooks must return a boolean value. If any of the called
137	counts as being I<consumed>, and the invocation of other hooks is skipped,	439	hooks returns true, then the event counts as being I<consumed>, and the
138	and the relevant action might not be carried out by the C++ code.	440	relevant action might not be carried out by the C++ code.
139		441
140	When in doubt, return a false value (preferably C<()>).	442	I<< When in doubt, return a false value (preferably C<()>). >>
141		443
142	=over 4	444	=over 4
143		445
144	=item on_init $term	446	=item on_init $term
145		447
146	Called after a new terminal object has been initialized, but before	448	Called after a new terminal object has been initialized, but before
147	windows are created or the command gets run. Most methods are unsafe to	449	windows are created or the command gets run. Most methods are unsafe to
148	call or deliver senseless data, as terminal size and other characteristics	450	call or deliver senseless data, as terminal size and other characteristics
149	have not yet been determined. You can safely query and change resources,	451	have not yet been determined. You can safely query and change resources
150	though.	452	and options, though. For many purposes the C<on_start> hook is a better
		453	place.
		454
		455	=item on_start $term
		456
		457	Called at the very end of initialisation of a new terminal, just before
		458	trying to map (display) the toplevel and returning to the main loop.
		459
		460	=item on_destroy $term
		461
		462	Called whenever something tries to destroy terminal, when the terminal is
		463	still fully functional (not for long, though).
151		464
152	=item on_reset $term	465	=item on_reset $term
153		466
154	Called after the screen is "reset" for any reason, such as resizing or	467	Called after the screen is "reset" for any reason, such as resizing or
155	control sequences. Here is where you can react on changes to size-related	468	control sequences. Here is where you can react on changes to size-related
156	variables.	469	variables.
157		470
158	=item on_start $term	471	=item on_child_start $term, $pid
159		472
160	Called at the very end of initialisation of a new terminal, just before	473	Called just after the child process has been C<fork>ed.
161	returning to the mainloop.	474
		475	=item on_child_exit $term, $status
		476
		477	Called just after the child process has exited. C<$status> is the status
		478	from C<waitpid>.
162		479
163	=item on_sel_make $term, $eventtime	480	=item on_sel_make $term, $eventtime
164		481
165	Called whenever a selection has been made by the user, but before the	482	Called whenever a selection has been made by the user, but before the
166	selection text is copied, so changes to the beginning, end or type of the	483	selection text is copied, so changes to the beginning, end or type of the
…		…
173		490
174	Called whenever a selection has been copied, but before the selection is	491	Called whenever a selection has been copied, but before the selection is
175	requested from the server. The selection text can be queried and changed	492	requested from the server. The selection text can be queried and changed
176	by calling C<< $term->selection >>.	493	by calling C<< $term->selection >>.
177		494
178	Returning a true value aborts selection grabbing. It will still be hilighted.	495	Returning a true value aborts selection grabbing. It will still be highlighted.
179		496
180	=item on_sel_extend $term	497	=item on_sel_extend $term
181		498
182	Called whenever the user tries to extend the selection (e.g. with a double	499	Called whenever the user tries to extend the selection (e.g. with a double
183	click) and is either supposed to return false (normal operation), or	500	click) and is either supposed to return false (normal operation), or
184	should extend the selection itelf and return true to suppress the built-in	501	should extend the selection itself and return true to suppress the built-in
185	processing.	502	processing. This can happen multiple times, as long as the callback
		503	returns true, it will be called on every further click by the user and is
		504	supposed to enlarge the selection more and more, if possible.
186		505
187	See the F<selection> example extension.	506	See the F<selection> example extension.
188		507
189	=item on_view_change $term, $offset	508	=item on_view_change $term, $offset
190		509
191	Called whenever the view offset changes, i..e the user or program	510	Called whenever the view offset changes, i.e. the user or program
192	scrolls. Offset C<0> means display the normal terminal, positive values	511	scrolls. Offset C<0> means display the normal terminal, positive values
193	show this many lines of scrollback.	512	show this many lines of scrollback.
194		513
195	=item on_scroll_back $term, $lines, $saved	514	=item on_scroll_back $term, $lines, $saved
196		515
…		…
200		519
201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	520	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	521	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
203	number of lines that will be in the scrollback buffer.	522	number of lines that will be in the scrollback buffer.
204		523
205	=item on_tty_activity $term *NYI*	524	=item on_osc_seq $term, $op, $args
206		525
207	Called whenever the program(s) running in the urxvt window send output.	526	Called on every OSC sequence and can be used to suppress it or modify its
		527	behaviour. The default should be to return an empty list. A true value
		528	suppresses execution of the request completely. Make sure you don't get
		529	confused by recursive invocations when you output an osc sequence within
		530	this callback.
208		531
		532	C<on_osc_seq_perl> should be used for new behaviour.
		533
209	=item on_osc_seq $term, $string	534	=item on_osc_seq_perl $term, $string
210		535
211	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	536	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212	operating system command) is processed. Cursor position and other state	537	operating system command) is processed. Cursor position and other state
213	information is up-to-date when this happens. For interoperability, the	538	information is up-to-date when this happens. For interoperability, the
214	string should start with the extension name and a colon, to distinguish	539	string should start with the extension name and a colon, to distinguish
215	it from commands for other extensions, and this might be enforced in the	540	it from commands for other extensions, and this might be enforced in the
216	future.	541	future.
217		542
218	Be careful not ever to trust (in a security sense) the data you receive,	543	Be careful not ever to trust (in a security sense) the data you receive,
219	as its source can not easily be controleld (e-mail content, messages from	544	as its source can not easily be controlled (e-mail content, messages from
220	other users on the same system etc.).	545	other users on the same system etc.).
221		546
222	=item on_add_lines $term, $string	547	=item on_add_lines $term, $string
223		548
224	Called whenever text is about to be output, with the text as argument. You	549	Called whenever text is about to be output, with the text as argument. You
225	can filter/change and output the text yourself by returning a true value	550	can filter/change and output the text yourself by returning a true value
226	and calling C<< $term->scr_add_lines >> yourself. Please note that this	551	and calling C<< $term->scr_add_lines >> yourself. Please note that this
227	might be very slow, however, as your hook is called for B<all> text being	552	might be very slow, however, as your hook is called for B<all> text being
228	output.	553	output.
229		554
		555	=item on_tt_write $term, $octets
		556
		557	Called whenever some data is written to the tty/pty and can be used to
		558	suppress or filter tty input.
		559
230	=item on_line_update $term, $row	560	=item on_line_update $term, $row
231		561
232	Called whenever a line was updated or changed. Can be used to filter	562	Called whenever a line was updated or changed. Can be used to filter
233	screen output (e.g. underline urls or other useless stuff). Only lines	563	screen output (e.g. underline urls or other useless stuff). Only lines
234	that are being shown will be filtered, and, due to performance reasons,	564	that are being shown will be filtered, and, due to performance reasons,
…		…
250		580
251	=item on_refresh_end $term	581	=item on_refresh_end $term
252		582
253	Called just after the screen gets redrawn. See C<on_refresh_begin>.	583	Called just after the screen gets redrawn. See C<on_refresh_begin>.
254		584
255	=item on_keyboard_command $term, $string	585	=item on_user_command $term, $string
256		586
257	Called whenever the user presses a key combination that has a	587	Called whenever a user-configured event is being activated (e.g. via
258	C<perl:string> action bound to it (see description of the B<keysym>	588	a C<perl:string> action bound to a key, see description of the B<keysym>
259	resource in the @@RXVT_NAME@@(1) manpage).	589	resource in the @@RXVT_NAME@@(1) manpage).
		590
		591	The event is simply the action string. This interface is assumed to change
		592	slightly in the future.
		593
		594	=item on_resize_all_windows $tern, $new_width, $new_height
		595
		596	Called just after the new window size has been calculated, but before
		597	windows are actually being resized or hints are being set. If this hook
		598	returns TRUE, setting of the window hints is being skipped.
		599
		600	=item on_x_event $term, $event
		601
		602	Called on every X event received on the vt window (and possibly other
		603	windows). Should only be used as a last resort. Most event structure
		604	members are not passed.
		605
		606	=item on_root_event $term, $event
		607
		608	Like C<on_x_event>, but is called for events on the root window.
260		609
261	=item on_focus_in $term	610	=item on_focus_in $term
262		611
263	Called whenever the window gets the keyboard focus, before rxvt-unicode	612	Called whenever the window gets the keyboard focus, before rxvt-unicode
264	does focus in processing.	613	does focus in processing.
265		614
266	=item on_focus_out $term	615	=item on_focus_out $term
267		616
268	Called wheneever the window loses keyboard focus, before rxvt-unicode does	617	Called whenever the window loses keyboard focus, before rxvt-unicode does
269	focus out processing.	618	focus out processing.
270		619
		620	=item on_configure_notify $term, $event
		621
		622	=item on_property_notify $term, $event
		623
271	=item on_key_press $term, $event, $octets	624	=item on_key_press $term, $event, $keysym, $octets
272		625
273	=item on_key_release $term, $event	626	=item on_key_release $term, $event, $keysym
274		627
275	=item on_button_press $term, $event	628	=item on_button_press $term, $event
276		629
277	=item on_button_release $term, $event	630	=item on_button_release $term, $event
278		631
…		…
284		637
285	Called whenever the corresponding X event is received for the terminal If	638	Called whenever the corresponding X event is received for the terminal If
286	the hook returns true, then the even will be ignored by rxvt-unicode.	639	the hook returns true, then the even will be ignored by rxvt-unicode.
287		640
288	The event is a hash with most values as named by Xlib (see the XEvent	641	The event is a hash with most values as named by Xlib (see the XEvent
289	manpage), with the additional members C<row> and C<col>, which are the row	642	manpage), with the additional members C<row> and C<col>, which are the
290	and column under the mouse cursor.	643	(real, not screen-based) row and column under the mouse cursor.
291		644
292	C<on_key_press> additionally receives the string rxvt-unicode would	645	C<on_key_press> additionally receives the string rxvt-unicode would
293	output, if any, in locale-specific encoding.	646	output, if any, in locale-specific encoding.
294		647
295	subwindow.	648	subwindow.
296		649
		650	=item on_client_message $term, $event
		651
		652	=item on_wm_protocols $term, $event
		653
		654	=item on_wm_delete_window $term, $event
		655
		656	Called when various types of ClientMessage events are received (all with
		657	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		658
297	=back	659	=back
298		660
		661	=cut
		662
		663	package urxvt;
		664
		665	use utf8;
		666	use strict;
		667	use Carp ();
		668	use Scalar::Util ();
		669	use List::Util ();
		670
		671	our $VERSION = 1;
		672	our $TERM;
		673	our @TERM_INIT;
		674	our @TERM_EXT;
		675	our @HOOKNAME;
		676	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		677	our %OPTION;
		678
		679	our $LIBDIR;
		680	our $RESNAME;
		681	our $RESCLASS;
		682	our $RXVTNAME;
		683
		684	our $NOCHAR = chr 0xffff;
		685
299	=head2 Variables in the C<urxvt> Package	686	=head2 Variables in the C<urxvt> Package
300		687
301	=over 4	688	=over 4
		689
		690	=item $urxvt::LIBDIR
		691
		692	The rxvt-unicode library directory, where, among other things, the perl
		693	modules and scripts are stored.
		694
		695	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		696
		697	The resource class and name rxvt-unicode uses to look up X resources.
		698
		699	=item $urxvt::RXVTNAME
		700
		701	The basename of the installed binaries, usually C<urxvt>.
302		702
303	=item $urxvt::TERM	703	=item $urxvt::TERM
304		704
305	The current terminal. This variable stores the current C<urxvt::term>	705	The current terminal. This variable stores the current C<urxvt::term>
306	object, whenever a callback/hook is executing.	706	object, whenever a callback/hook is executing.
307		707
		708	=item @urxvt::TERM_INIT
		709
		710	All code references in this array will be called as methods of the next newly
		711	created C<urxvt::term> object (during the C<on_init> phase). The array
		712	gets cleared before the code references that were in it are being executed,
		713	so references can push themselves onto it again if they so desire.
		714
		715	This complements to the perl-eval command line option, but gets executed
		716	first.
		717
		718	=item @urxvt::TERM_EXT
		719
		720	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		721	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		722	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		723
308	=back	724	=back
309		725
310	=head2 Functions in the C<urxvt> Package	726	=head2 Functions in the C<urxvt> Package
311		727
312	=over 4	728	=over 4
313
314	=item $term = new urxvt [arg...]
315
316	Creates a new terminal, very similar as if you had started it with
317	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
318	if the new instance couldn't be created. Returns C<undef> if the new
319	instance didn't initialise perl, and the terminal object otherwise. The
320	C<init> and C<start> hooks will be called during the call.
321		729
322	=item urxvt::fatal $errormessage	730	=item urxvt::fatal $errormessage
323		731
324	Fatally aborts execution with the given error message. Avoid at all	732	Fatally aborts execution with the given error message. Avoid at all
325	costs! The only time this is acceptable is when the terminal process	733	costs! The only time this is acceptable is when the terminal process
…		…
332	that calls this function.	740	that calls this function.
333		741
334	Using this function has the advantage that its output ends up in the	742	Using this function has the advantage that its output ends up in the
335	correct place, e.g. on stderr of the connecting urxvtc client.	743	correct place, e.g. on stderr of the connecting urxvtc client.
336		744
		745	Messages have a size limit of 1023 bytes currently.
		746
		747	=item @terms = urxvt::termlist
		748
		749	Returns all urxvt::term objects that exist in this process, regardless of
		750	whether they are started, being destroyed etc., so be careful. Only term
		751	objects that have perl extensions attached will be returned (because there
		752	is no urxvt::term objet associated with others).
		753
337	=item $time = urxvt::NOW	754	=item $time = urxvt::NOW
338		755
339	Returns the "current time" (as per the event loop).	756	Returns the "current time" (as per the event loop).
340		757
341	=item urxvt::CurrentTime	758	=item urxvt::CurrentTime
342		759
343	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	760	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
344	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	761	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
345	Button4Mask, Button5Mask, AnyModifier	762	Button4Mask, Button5Mask, AnyModifier
346		763
		764	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		765	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		766	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		767	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		768	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		769	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		770	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		771
		772	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		773	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		774	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		775	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		776	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		777	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		778	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		779
347	Various constants for use in X events.	780	Various constants for use in X calls and event processing.
348		781
349	=back	782	=back
350		783
351	=head2 RENDITION	784	=head2 RENDITION
352		785
…		…
379		812
380	=item $background = urxvt::GET_BASEBG $rend	813	=item $background = urxvt::GET_BASEBG $rend
381		814
382	Return the foreground/background colour index, respectively.	815	Return the foreground/background colour index, respectively.
383		816
384	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	817	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
385		818
386	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	819	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		820
		821	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
387		822
388	Replace the foreground/background colour in the rendition mask with the	823	Replace the foreground/background colour in the rendition mask with the
389	specified one.	824	specified one.
390		825
391	=item $value = urxvt::GET_CUSTOM ($rend)	826	=item $value = urxvt::GET_CUSTOM $rend
392		827
393	Return the "custom" value: Every rendition has 5 bits for use by	828	Return the "custom" value: Every rendition has 5 bits for use by
394	extensions. They can be set and changed as you like and are initially	829	extensions. They can be set and changed as you like and are initially
395	zero.	830	zero.
396		831
397	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	832	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
398		833
399	Change the custom value.	834	Change the custom value.
400		835
401	=back	836	=back
402		837
403	=cut	838	=cut
404		839
405	package urxvt;
406
407	use utf8;
408	use strict;
409	use Scalar::Util ();
410	use List::Util ();
411
412	our $TERM;
413	our @HOOKNAME;
414	our %OPTION;
415	our $LIBDIR;
416
417	BEGIN {	840	BEGIN {
418	urxvt->bootstrap;
419
420	# overwrite perl's warn	841	# overwrite perl's warn
421	*CORE::GLOBAL::warn = sub {	842	*CORE::GLOBAL::warn = sub {
422	my $msg = join "", @_;	843	my $msg = join "", @_;
423	$msg .= "\n"	844	$msg .= "\n"
424	unless $msg =~ /\n$/;	845	unless $msg =~ /\n$/;
425	urxvt::warn ($msg);	846	urxvt::warn ($msg);
426	};	847	};
427	}	848	}
428		849
429	my @hook_count;	850	no warnings 'utf8';
		851
430	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	852	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
431		853
432	sub verbose {	854	sub verbose {
433	my ($level, $msg) = @_;	855	my ($level, $msg) = @_;
434	warn "$msg\n" if $level <= $verbosity;	856	warn "$msg\n" if $level <= $verbosity;
435	}	857	}
436		858
437	# find on_xxx subs in the package and register them
438	# as hooks
439	sub register_package($) {
440	my ($pkg) = @_;
441
442	for my $htype (0.. $#HOOKNAME) {
443	my $name = $HOOKNAME[$htype];
444
445	my $ref = $pkg->can ("on_" . lc $name)
446	or next;
447
448	$TERM->{_hook}[$htype]{$pkg} = $ref;
449	$hook_count[$htype]++
450	or set_should_invoke $htype, 1;
451	}
452	}
453
454	my $extension_pkg = "extension0000";
455	my %extension_pkg;	859	my %extension_pkg;
456		860
457	# load a single script into its own package, once only	861	# load a single script into its own package, once only
458	sub extension_package($) {	862	sub extension_package($) {
459	my ($path) = @_;	863	my ($path) = @_;
460		864
461	$extension_pkg{$path} ||= do {	865	$extension_pkg{$path} ||= do {
462	my $pkg = "urxvt::" . ($extension_pkg++);	866	$path =~ /([^\/\\]+)$/;
		867	my $pkg = $1;
		868	$pkg =~ s/[^[:word:]]/_/g;
		869	$pkg = "urxvt::ext::$pkg";
463		870
464	verbose 3, "loading extension '$path' into package '$pkg'";	871	verbose 3, "loading extension '$path' into package '$pkg'";
465		872
466	open my $fh, "<:raw", $path	873	open my $fh, "<:raw", $path
467	or die "$path: $!";	874	or die "$path: $!";
468		875
469	my $source = "package $pkg; use strict; use utf8;\n"	876	my $source =
470	. "use base urxvt::term::proxy::;\n"	877	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
471	. "#line 1 \"$path\"\n{\n"	878	. "#line 1 \"$path\"\n{\n"
472	. (do { local $/; <$fh> })	879	. (do { local $/; <$fh> })
473	. "\n};\n1";	880	. "\n};\n1";
474		881
		882	eval $source
475	eval $source or die "$path: $@";	883	or die "$path: $@";
476		884
477	$pkg	885	$pkg
478	}	886	}
479	}	887	}
480		888
…		…
486	my $htype = shift;	894	my $htype = shift;
487		895
488	if ($htype == 0) { # INIT	896	if ($htype == 0) { # INIT
489	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	897	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
490		898
491	my %want_ext;	899	my %ext_arg;
492		900
		901	{
		902	my @init = @TERM_INIT;
		903	@TERM_INIT = ();
		904	$_->($TERM) for @init;
		905	my @pkg = @TERM_EXT;
		906	@TERM_EXT = ();
		907	$TERM->register_package ($_) for @pkg;
		908	}
		909
493	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	910	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
494	if ($_ eq "default") {	911	if ($_ eq "default") {
495	$want_ext{$_}++ for qw(selection option-popup);	912	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
496	} elsif (/^-(.*)$/) {	913	} elsif (/^-(.*)$/) {
497	delete $want_ext{$1};	914	delete $ext_arg{$1};
		915	} elsif (/^([^<]+)<(.*)>$/) {
		916	push @{ $ext_arg{$1} }, $2;
498	} else {	917	} else {
499	$want_ext{$_}++;	918	$ext_arg{$_} ||= [];
500	}	919	}
501	}	920	}
502		921
503	for my $ext (keys %want_ext) {	922	for my $ext (sort keys %ext_arg) {
504	my @files = grep -f $_, map "$_/$ext", @dirs;	923	my @files = grep -f $_, map "$_/$ext", @dirs;
505		924
506	if (@files) {	925	if (@files) {
507	register_package extension_package $files[0];	926	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
508	} else {	927	} else {
509	warn "perl extension '$ext' not found in perl library search path\n";	928	warn "perl extension '$ext' not found in perl library search path\n";
510	}	929	}
511	}	930	}
		931
		932	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		933	warn $@ if $@;
512	}	934	}
513		935
514	$retval = undef;	936	$retval = undef;
515		937
516	if (my $cb = $TERM->{_hook}[$htype]) {	938	if (my $cb = $TERM->{_hook}[$htype]) {
517	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	939	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
518	if $verbosity >= 10;	940	if $verbosity >= 10;
519		941
520	keys %$cb;	942	for my $pkg (keys %$cb) {
		943	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
		944	$retval ||= $retval_;
521		945
522	while (my ($pkg, $cb) = each %$cb) {	946	if ($@) {
523	eval {	947	$TERM->ungrab; # better to lose the grab than the session
524	$retval = $cb->(	948	warn $@;
525	$TERM->{_pkg}{$pkg} ||= do {
526	my $proxy = bless { }, $pkg;
527	Scalar::Util::weaken ($proxy->{term} = $TERM);
528	$proxy
529	},
530	@_,
531	) and last;
532	};
533	warn $@ if $@;#d#
534	}
535	}
536
537	if ($htype == 1) { # DESTROY
538	# remove hooks if unused
539	if (my $hook = $TERM->{_hook}) {
540	for my $htype (0..$#$hook) {
541	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
542	or set_should_invoke $htype, 0;
543	}	949	}
544	}	950	}
545		951
		952	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		953	if $verbosity >= 11;
		954	}
		955
		956	if ($htype == 1) { # DESTROY
546	# clear package objects	957	# clear package objects
547	%$_ = () for values %{ $TERM->{_pkg} };	958	%$_ = () for values %{ $TERM->{_pkg} };
548		959
549	# clear package	960	# clear package
550	%$TERM = ();	961	%$TERM = ();
551	}	962	}
552		963
553	$retval	964	$retval
554	}	965	}
555		966
556	sub urxvt::term::proxy::AUTOLOAD {	967	sub SET_COLOR($$$) {
557	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	968	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		969	}
		970
		971	# urxvt::term::extension
		972
		973	package urxvt::term::extension;
		974
		975	sub enable {
		976	my ($self, %hook) = @_;
		977	my $pkg = $self->{_pkg};
		978
		979	while (my ($name, $cb) = each %hook) {
		980	my $htype = $HOOKTYPE{uc $name};
		981	defined $htype
		982	or Carp::croak "unsupported hook type '$name'";
		983
		984	$self->set_should_invoke ($htype, +1)
		985	unless exists $self->{term}{_hook}[$htype]{$pkg};
		986
		987	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		988	}
		989	}
		990
		991	sub disable {
		992	my ($self, @hook) = @_;
		993	my $pkg = $self->{_pkg};
		994
		995	for my $name (@hook) {
		996	my $htype = $HOOKTYPE{uc $name};
		997	defined $htype
		998	or Carp::croak "unsupported hook type '$name'";
		999
		1000	$self->set_should_invoke ($htype, -1)
		1001	if delete $self->{term}{_hook}[$htype]{$pkg};
		1002	}
		1003	}
		1004
		1005	our $AUTOLOAD;
		1006
		1007	sub AUTOLOAD {
		1008	$AUTOLOAD =~ /:([^:]+)$/
558	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	1009	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
559		1010
560	eval qq{	1011	eval qq{
561	sub $urxvt::term::proxy::AUTOLOAD {	1012	sub $AUTOLOAD {
562	my \$proxy = shift;	1013	my \$proxy = shift;
563	\$proxy->{term}->$1 (\@_)	1014	\$proxy->{term}->$1 (\@_)
564	}	1015	}
565	1	1016	1
566	} or die "FATAL: unable to compile method forwarder: $@";	1017	} or die "FATAL: unable to compile method forwarder: $@";
567		1018
568	goto &$urxvt::term::proxy::AUTOLOAD;	1019	goto &$AUTOLOAD;
569	}	1020	}
		1021
		1022	sub DESTROY {
		1023	# nop
		1024	}
		1025
		1026	# urxvt::destroy_hook
570		1027
571	sub urxvt::destroy_hook::DESTROY {	1028	sub urxvt::destroy_hook::DESTROY {
572	${$_[0]}->();	1029	${$_[0]}->();
573	}	1030	}
574		1031
575	sub urxvt::destroy_hook(&) {	1032	sub urxvt::destroy_hook(&) {
576	bless \shift, urxvt::destroy_hook::	1033	bless \shift, urxvt::destroy_hook::
577	}	1034	}
578		1035
		1036	package urxvt::anyevent;
		1037
		1038	=head2 The C<urxvt::anyevent> Class
		1039
		1040	The sole purpose of this class is to deliver an interface to the
		1041	C<AnyEvent> module - any module using it will work inside urxvt without
		1042	further programming. The only exception is that you cannot wait on
		1043	condition variables, but non-blocking condvar use is ok. What this means
		1044	is that you cannot use blocking APIs, but the non-blocking variant should
		1045	work.
		1046
		1047	=cut
		1048
		1049	our $VERSION = 1;
		1050
		1051	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		1052	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		1053
		1054	sub timer {
		1055	my ($class, %arg) = @_;
		1056
		1057	my $cb = $arg{cb};
		1058
		1059	urxvt::timer
		1060	->new
		1061	->start (urxvt::NOW + $arg{after})
		1062	->cb (sub {
		1063	$_[0]->stop; # need to cancel manually
		1064	$cb->();
		1065	})
		1066	}
		1067
		1068	sub io {
		1069	my ($class, %arg) = @_;
		1070
		1071	my $cb = $arg{cb};
		1072
		1073	bless [$arg{fh}, urxvt::iow
		1074	->new
		1075	->fd (fileno $arg{fh})
		1076	->events (($arg{poll} =~ /r/ ? 1 : 0)
		1077	| ($arg{poll} =~ /w/ ? 2 : 0))
		1078	->start
		1079	->cb (sub {
		1080	$cb->(($_[1] & 1 ? 'r' : '')
		1081	. ($_[1] & 2 ? 'w' : ''));
		1082	})],
		1083	urxvt::anyevent::
		1084	}
		1085
		1086	sub DESTROY {
		1087	$_[0][1]->stop;
		1088	}
		1089
		1090	sub condvar {
		1091	bless \my $flag, urxvt::anyevent::condvar::
		1092	}
		1093
		1094	sub urxvt::anyevent::condvar::broadcast {
		1095	${$_[0]}++;
		1096	}
		1097
		1098	sub urxvt::anyevent::condvar::wait {
		1099	unless (${$_[0]}) {
		1100	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		1101	}
		1102	}
		1103
		1104	package urxvt::term;
		1105
579	=head2 The C<urxvt::term> Class	1106	=head2 The C<urxvt::term> Class
580		1107
581	=over 4	1108	=over 4
582		1109
		1110	=cut
		1111
		1112	# find on_xxx subs in the package and register them
		1113	# as hooks
		1114	sub register_package {
		1115	my ($self, $pkg, $argv) = @_;
		1116
		1117	no strict 'refs';
		1118
		1119	urxvt::verbose 6, "register package $pkg to $self";
		1120
		1121	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1122
		1123	my $proxy = bless {
		1124	_pkg => $pkg,
		1125	argv => $argv,
		1126	}, $pkg;
		1127	Scalar::Util::weaken ($proxy->{term} = $self);
		1128
		1129	$self->{_pkg}{$pkg} = $proxy;
		1130
		1131	for my $name (@HOOKNAME) {
		1132	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1133	$proxy->enable ($name => $ref);
		1134	}
		1135	}
		1136	}
		1137
		1138	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1139
		1140	Creates a new terminal, very similar as if you had started it with system
		1141	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1142	hash which defines the environment of the new terminal.
		1143
		1144	Croaks (and probably outputs an error message) if the new instance
		1145	couldn't be created. Returns C<undef> if the new instance didn't
		1146	initialise perl, and the terminal object otherwise. The C<init> and
		1147	C<start> hooks will be called before this call returns, and are free to
		1148	refer to global data (which is race free).
		1149
		1150	=cut
		1151
		1152	sub new {
		1153	my ($class, $env, @args) = @_;
		1154
		1155	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1156	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1157
		1158	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1159	}
		1160
583	=item $term->destroy	1161	=item $term->destroy
584		1162
585	Destroy the terminal object (close the window, free resources etc.).	1163	Destroy the terminal object (close the window, free resources
		1164	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1165	watchers (timers, io watchers) are still active.
		1166
		1167	=item $term->exec_async ($cmd[, @args])
		1168
		1169	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1170	("starts") programs in the background. This function takes care of setting
		1171	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1172	be preferred over explicit calls to C<exec> or C<system>.
		1173
		1174	Returns the pid of the subprocess or C<undef> on error.
		1175
		1176	=cut
		1177
		1178	sub exec_async {
		1179	my $self = shift;
		1180
		1181	my $pid = fork;
		1182
		1183	return $pid
		1184	if !defined $pid or $pid;
		1185
		1186	%ENV = %{ $self->env };
		1187
		1188	exec @_;
		1189	urxvt::_exit 255;
		1190	}
586		1191
587	=item $isset = $term->option ($optval[, $set])	1192	=item $isset = $term->option ($optval[, $set])
588		1193
589	Returns true if the option specified by C<$optval> is enabled, and	1194	Returns true if the option specified by C<$optval> is enabled, and
590	optionally change it. All option values are stored by name in the hash	1195	optionally change it. All option values are stored by name in the hash
591	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1196	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
592		1197
593	Here is a a likely non-exhaustive list of option names, please see the	1198	Here is a likely non-exhaustive list of option names, please see the
594	source file F</src/optinc.h> to see the actual list:	1199	source file F</src/optinc.h> to see the actual list:
595		1200
596	borderLess console cursorBlink cursorUnderline hold iconic insecure	1201	borderLess console cursorBlink cursorUnderline hold iconic insecure
597	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1202	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
598	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1203	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
599	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1204	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
600	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1205	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
601	tripleclickwords utmpInhibit visualBell	1206	transparent tripleclickwords utmpInhibit visualBell
602		1207
603	=item $value = $term->resource ($name[, $newval])	1208	=item $value = $term->resource ($name[, $newval])
604		1209
605	Returns the current resource value associated with a given name and	1210	Returns the current resource value associated with a given name and
606	optionally sets a new value. Setting values is most useful in the C<init>	1211	optionally sets a new value. Setting values is most useful in the C<init>
…		…
615	likely change).	1220	likely change).
616		1221
617	Please note that resource strings will currently only be freed when the	1222	Please note that resource strings will currently only be freed when the
618	terminal is destroyed, so changing options frequently will eat memory.	1223	terminal is destroyed, so changing options frequently will eat memory.
619		1224
620	Here is a a likely non-exhaustive list of resource names, not all of which	1225	Here is a likely non-exhaustive list of resource names, not all of which
621	are supported in every build, please see the source file F</src/rsinc.h>	1226	are supported in every build, please see the source file F</src/rsinc.h>
622	to see the actual list:	1227	to see the actual list:
623		1228
624	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1229	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
625	borderLess color cursorBlink cursorUnderline cutchars delete_key	1230	borderLess color cursorBlink cursorUnderline cutchars delete_key
626	display_name embed ext_bwidth fade font geometry hold iconName	1231	display_name embed ext_bwidth fade font geometry hold iconName
627	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1232	imFont imLocale inputMethod insecure int_bwidth intensityStyles
628	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1233	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
629	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1234	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
630	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1235	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
631	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1236	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
632	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1237	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
633	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1238	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
634	shade term_name title transparent transparent_all tripleclickwords	1239	secondaryScreen secondaryScroll selectstyle shade term_name title
635	utmpInhibit visualBell	1240	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1241	visualBell
636		1242
637	=cut	1243	=cut
638		1244
639	sub urxvt::term::resource($$;$) {	1245	sub resource($$;$) {
640	my ($self, $name) = (shift, shift);	1246	my ($self, $name) = (shift, shift);
641	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1247	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
642	&urxvt::term::_resource	1248	&urxvt::term::_resource
643	}	1249	}
644		1250
		1251	=item $value = $term->x_resource ($pattern)
		1252
		1253	Returns the X-Resource for the given pattern, excluding the program or
		1254	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1255	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1256	resource with that pattern exists.
		1257
		1258	This method should only be called during the C<on_start> hook, as there is
		1259	only one resource database per display, and later invocations might return
		1260	the wrong resources.
		1261
		1262	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1263
		1264	Adds a keymap translation exactly as specified via a resource. See the
		1265	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1266
645	=item $rend = $term->rstyle ([$new_rstyle])	1267	=item $rend = $term->rstyle ([$new_rstyle])
646		1268
647	Return and optionally change the current rendition. Text that is output by	1269	Return and optionally change the current rendition. Text that is output by
648	the terminal application will use this style.	1270	the terminal application will use this style.
649		1271
…		…
659	=item ($row, $col) = $term->selection_end ([$row, $col])	1281	=item ($row, $col) = $term->selection_end ([$row, $col])
660		1282
661	Return the current values of the selection mark, begin or end positions,	1283	Return the current values of the selection mark, begin or end positions,
662	and optionally set them to new values.	1284	and optionally set them to new values.
663		1285
		1286	=item $term->selection_make ($eventtime[, $rectangular])
		1287
		1288	Tries to make a selection as set by C<selection_beg> and
		1289	C<selection_end>. If C<$rectangular> is true (default: false), a
		1290	rectangular selection will be made. This is the prefered function to make
		1291	a selection.
		1292
664	=item $success = $term->selection_grab ($eventtime)	1293	=item $success = $term->selection_grab ($eventtime)
665		1294
666	Try to request the primary selection from the server (for example, as set	1295	Try to request the primary selection text from the server (for example, as
667	by the next method).	1296	set by the next method). No visual feedback will be given. This function
		1297	is mostly useful from within C<on_sel_grab> hooks.
668		1298
669	=item $oldtext = $term->selection ([$newtext])	1299	=item $oldtext = $term->selection ([$newtext])
670		1300
671	Return the current selection text and optionally replace it by C<$newtext>.	1301	Return the current selection text and optionally replace it by C<$newtext>.
672		1302
673	#=item $term->overlay ($x, $y, $text)	1303	=item $term->overlay_simple ($x, $y, $text)
674	#	1304
675	#Create a simple multi-line overlay box. See the next method for details.	1305	Create a simple multi-line overlay box. See the next method for details.
676	#	1306
677	#=cut	1307	=cut
678	#	1308
679	#sub urxvt::term::scr_overlay {	1309	sub overlay_simple {
680	# my ($self, $x, $y, $text) = @_;	1310	my ($self, $x, $y, $text) = @_;
681	#	1311
682	# my @lines = split /\n/, $text;	1312	my @lines = split /\n/, $text;
683	#	1313
684	# my $w = 0;	1314	my $w = List::Util::max map $self->strwidth ($_), @lines;
685	# for (map $self->strwidth ($_), @lines) {	1315
686	# $w = $_ if $w < $_;
687	# }
688	#
689	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1316	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
690	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1317	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
691	#}	1318
		1319	$overlay
		1320	}
692		1321
693	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1322	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
694		1323
695	Create a new (empty) overlay at the given position with the given	1324	Create a new (empty) overlay at the given position with the given
696	width/height. C<$rstyle> defines the initial rendition style	1325	width/height. C<$rstyle> defines the initial rendition style
…		…
731	C<$event> I<must> be the event causing the menu to pop up (a button event,	1360	C<$event> I<must> be the event causing the menu to pop up (a button event,
732	currently).	1361	currently).
733		1362
734	=cut	1363	=cut
735		1364
736	sub urxvt::term::popup {	1365	sub popup {
737	my ($self, $event) = @_;	1366	my ($self, $event) = @_;
738		1367
739	$self->grab ($event->{time}, 1)	1368	$self->grab ($event->{time}, 1)
740	or return;	1369	or return;
741		1370
…		…
763		1392
764	=item $string = $term->locale_decode ($octets)	1393	=item $string = $term->locale_decode ($octets)
765		1394
766	Convert the given locale-encoded octets into a perl string.	1395	Convert the given locale-encoded octets into a perl string.
767		1396
		1397	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1398
		1399	XORs the rendition values in the given span with the provided value
		1400	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1401	refresh hooks to provide effects similar to the selection.
		1402
		1403	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1404
		1405	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1406	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1407	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1408	it instead. Both styles I<MUST NOT> contain font styles.
		1409
		1410	=item $term->scr_bell
		1411
		1412	Ring the bell!
		1413
768	=item $term->scr_add_lines ($string)	1414	=item $term->scr_add_lines ($string)
769		1415
770	Write the given text string to the screen, as if output by the application	1416	Write the given text string to the screen, as if output by the application
771	running inside the terminal. It may not contain command sequences (escape	1417	running inside the terminal. It may not contain command sequences (escape
772	codes), but is free to use line feeds, carriage returns and tabs. The	1418	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
774		1420
775	Normally its not a good idea to use this function, as programs might be	1421	Normally its not a good idea to use this function, as programs might be
776	confused by changes in cursor position or scrolling. Its useful inside a	1422	confused by changes in cursor position or scrolling. Its useful inside a
777	C<on_add_lines> hook, though.	1423	C<on_add_lines> hook, though.
778		1424
		1425	=item $term->scr_change_screen ($screen)
		1426
		1427	Switch to given screen - 0 primary, 1 secondary.
		1428
779	=item $term->cmd_parse ($octets)	1429	=item $term->cmd_parse ($octets)
780		1430
781	Similar to C<scr_add_lines>, but the argument must be in the	1431	Similar to C<scr_add_lines>, but the argument must be in the
782	locale-specific encoding of the terminal and can contain command sequences	1432	locale-specific encoding of the terminal and can contain command sequences
783	(escape codes) that will be interpreted.	1433	(escape codes) that will be interpreted.
…		…
786		1436
787	Write the octets given in C<$data> to the tty (i.e. as program input). To	1437	Write the octets given in C<$data> to the tty (i.e. as program input). To
788	pass characters instead of octets, you should convert your strings first	1438	pass characters instead of octets, you should convert your strings first
789	to the locale-specific encoding using C<< $term->locale_encode >>.	1439	to the locale-specific encoding using C<< $term->locale_encode >>.
790		1440
		1441	=item $old_events = $term->pty_ev_events ([$new_events])
		1442
		1443	Replaces the event mask of the pty watcher by the given event mask. Can
		1444	be used to suppress input and output handling to the pty/tty. See the
		1445	description of C<< urxvt::timer->events >>. Make sure to always restore
		1446	the previous value.
		1447
		1448	=item $fd = $term->pty_fd
		1449
		1450	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1451	is used.
		1452
791	=item $windowid = $term->parent	1453	=item $windowid = $term->parent
792		1454
793	Return the window id of the toplevel window.	1455	Return the window id of the toplevel window.
794		1456
795	=item $windowid = $term->vt	1457	=item $windowid = $term->vt
796		1458
797	Return the window id of the terminal window.	1459	Return the window id of the terminal window.
798		1460
		1461	=item $term->vt_emask_add ($x_event_mask)
		1462
		1463	Adds the specified events to the vt event mask. Useful e.g. when you want
		1464	to receive pointer events all the times:
		1465
		1466	$term->vt_emask_add (urxvt::PointerMotionMask);
		1467
		1468	=item $term->focus_in
		1469
		1470	=item $term->focus_out
		1471
		1472	=item $term->key_press ($state, $keycode[, $time])
		1473
		1474	=item $term->key_release ($state, $keycode[, $time])
		1475
		1476	Deliver various fake events to to terminal.
		1477
799	=item $window_width = $term->width	1478	=item $window_width = $term->width
800		1479
801	=item $window_height = $term->height	1480	=item $window_height = $term->height
802		1481
803	=item $font_width = $term->fwidth	1482	=item $font_width = $term->fwidth
…		…
816		1495
817	=item $max_scrollback = $term->saveLines	1496	=item $max_scrollback = $term->saveLines
818		1497
819	=item $nrow_plus_saveLines = $term->total_rows	1498	=item $nrow_plus_saveLines = $term->total_rows
820		1499
821	=item $lines_in_scrollback = $term->nsaved	1500	=item $topmost_scrollback_row = $term->top_row
822		1501
823	Return various integers describing terminal characteristics.	1502	Return various integers describing terminal characteristics.
		1503
		1504	=item $x_display = $term->display_id
		1505
		1506	Return the DISPLAY used by rxvt-unicode.
		1507
		1508	=item $lc_ctype = $term->locale
		1509
		1510	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1511
		1512	=item $env = $term->env
		1513
		1514	Returns a copy of the environment in effect for the terminal as a hashref
		1515	similar to C<\%ENV>.
		1516
		1517	=item @envv = $term->envv
		1518
		1519	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1520
		1521	=item @argv = $term->argv
		1522
		1523	Return the argument vector as this terminal, similar to @ARGV, but
		1524	includes the program name as first element.
		1525
		1526	=cut
		1527
		1528	sub env {
		1529	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1530	}
824		1531
825	=item $modifiermask = $term->ModLevel3Mask	1532	=item $modifiermask = $term->ModLevel3Mask
826		1533
827	=item $modifiermask = $term->ModMetaMask	1534	=item $modifiermask = $term->ModMetaMask
828		1535
829	=item $modifiermask = $term->ModNumLockMask	1536	=item $modifiermask = $term->ModNumLockMask
830		1537
831	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1538	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
832	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1539	AltGr), the meta key (often Alt) and the num lock key, if applicable.
833		1540
		1541	=item $screen = $term->current_screen
		1542
		1543	Returns the currently displayed screen (0 primary, 1 secondary).
		1544
		1545	=item $cursor_is_hidden = $term->hidden_cursor
		1546
		1547	Returns whether the cursor is currently hidden or not.
		1548
834	=item $view_start = $term->view_start ([$newvalue])	1549	=item $view_start = $term->view_start ([$newvalue])
835		1550
836	Returns the negative row number of the topmost line. Minimum value is	1551	Returns the row number of the topmost displayed line. Maximum value is
837	C<0>, which displays the normal terminal contents. Larger values scroll	1552	C<0>, which displays the normal terminal contents. Lower values scroll
838	this many lines into the scrollback buffer.	1553	this many lines into the scrollback buffer.
839		1554
840	=item $term->want_refresh	1555	=item $term->want_refresh
841		1556
842	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1557	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
857	line, starting at column C<$start_col> (default C<0>), which is useful	1572	line, starting at column C<$start_col> (default C<0>), which is useful
858	to replace only parts of a line. The font index in the rendition will	1573	to replace only parts of a line. The font index in the rendition will
859	automatically be updated.	1574	automatically be updated.
860		1575
861	C<$text> is in a special encoding: tabs and wide characters that use more	1576	C<$text> is in a special encoding: tabs and wide characters that use more
862	than one cell when displayed are padded with urxvt::NOCHAR characters	1577	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
863	(C<chr 65535>). Characters with combining characters and other characters	1578	characters. Characters with combining characters and other characters that
864	that do not fit into the normal tetx encoding will be replaced with	1579	do not fit into the normal tetx encoding will be replaced with characters
865	characters in the private use area.	1580	in the private use area.
866		1581
867	You have to obey this encoding when changing text. The advantage is	1582	You have to obey this encoding when changing text. The advantage is
868	that C<substr> and similar functions work on screen cells and not on	1583	that C<substr> and similar functions work on screen cells and not on
869	characters.	1584	characters.
870		1585
…		…
921	Return the row number of the first/last row of the line, respectively.	1636	Return the row number of the first/last row of the line, respectively.
922		1637
923	=item $offset = $line->offset_of ($row, $col)	1638	=item $offset = $line->offset_of ($row, $col)
924		1639
925	Returns the character offset of the given row|col pair within the logical	1640	Returns the character offset of the given row|col pair within the logical
926	line.	1641	line. Works for rows outside the line, too, and returns corresponding
		1642	offsets outside the string.
927		1643
928	=item ($row, $col) = $line->coord_of ($offset)	1644	=item ($row, $col) = $line->coord_of ($offset)
929		1645
930	Translates a string offset into terminal coordinates again.	1646	Translates a string offset into terminal coordinates again.
931		1647
932	=back	1648	=back
933		1649
934	=cut	1650	=cut
935		1651
936	sub urxvt::term::line {	1652	sub line {
937	my ($self, $row) = @_;	1653	my ($self, $row) = @_;
938		1654
939	my $maxrow = $self->nrow - 1;	1655	my $maxrow = $self->nrow - 1;
940		1656
941	my ($beg, $end) = ($row, $row);	1657	my ($beg, $end) = ($row, $row);
…		…
1005	$offset / $self->{ncol} + $self->{beg},	1721	$offset / $self->{ncol} + $self->{beg},
1006	$offset % $self->{ncol}	1722	$offset % $self->{ncol}
1007	)	1723	)
1008	}	1724	}
1009		1725
1010	=item ($row, $col) = $line->coord_of ($offset)
1011	=item $text = $term->special_encode $string	1726	=item $text = $term->special_encode $string
1012		1727
1013	Converts a perl string into the special encoding used by rxvt-unicode,	1728	Converts a perl string into the special encoding used by rxvt-unicode,
1014	where one character corresponds to one screen cell. See	1729	where one character corresponds to one screen cell. See
1015	C<< $term->ROW_t >> for details.	1730	C<< $term->ROW_t >> for details.
1016		1731
1017	=item $string = $term->special_decode $text	1732	=item $string = $term->special_decode $text
1018		1733
1019	Converts rxvt-unicodes text reprsentation into a perl string. See	1734	Converts rxvt-unicodes text representation into a perl string. See
1020	C<< $term->ROW_t >> for details.	1735	C<< $term->ROW_t >> for details.
1021		1736
		1737	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
		1738
		1739	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1740
		1741	Register/unregister a synchronous button grab. See the XGrabButton
		1742	manpage.
		1743
		1744	=item $success = $term->grab ($eventtime[, $sync])
		1745
		1746	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1747	synchronous (C<$sync> is true). Also remembers the grab timestamp.
		1748
		1749	=item $term->allow_events_async
		1750
		1751	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1752
		1753	=item $term->allow_events_sync
		1754
		1755	Calls XAllowEvents with SyncBoth for the most recent grab.
		1756
		1757	=item $term->allow_events_replay
		1758
		1759	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1760	recent grab.
		1761
		1762	=item $term->ungrab
		1763
		1764	Calls XUngrab for the most recent grab. Is called automatically on
		1765	evaluation errors, as it is better to lose the grab in the error case as
		1766	the session.
		1767
		1768	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1769
		1770	=item $atom_name = $term->XGetAtomName ($atom)
		1771
		1772	=item @atoms = $term->XListProperties ($window)
		1773
		1774	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1775
		1776	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1777
		1778	=item $term->XDeleteProperty ($window, $property)
		1779
		1780	=item $window = $term->DefaultRootWindow
		1781
		1782	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1783
		1784	=item $term->XMapWindow ($window)
		1785
		1786	=item $term->XUnmapWindow ($window)
		1787
		1788	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1789
		1790	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1791
		1792	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1793
		1794	Various X or X-related functions. The C<$term> object only serves as
		1795	the source of the display, otherwise those functions map more-or-less
		1796	directory onto the X functions of the same name.
		1797
1022	=back	1798	=back
1023		1799
		1800	=cut
		1801
		1802	package urxvt::popup;
		1803
1024	=head2 The C<urxvt::popup> Class	1804	=head2 The C<urxvt::popup> Class
1025		1805
1026	=over 4	1806	=over 4
1027		1807
1028	=cut	1808	=cut
1029
1030	package urxvt::popup;
1031		1809
1032	sub add_item {	1810	sub add_item {
1033	my ($self, $item) = @_;	1811	my ($self, $item) = @_;
1034		1812
1035	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};	1813	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
…		…
1039	$item->{render} ||= sub { $_[0]{text} };	1817	$item->{render} ||= sub { $_[0]{text} };
1040		1818
1041	push @{ $self->{item} }, $item;	1819	push @{ $self->{item} }, $item;
1042	}	1820	}
1043		1821
1044	sub add_separator {	1822	=item $popup->add_title ($title)
1045	my ($self, $sep) = @_;
1046		1823
1047	$sep ||= "═";	1824	Adds a non-clickable title to the popup.
1048		1825
1049	$self->add_item ({	1826	=cut
1050	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1051	text => "",
1052	render => sub { $sep x $urxvt::TERM->ncol },
1053	activate => sub { },
1054	});
1055	}
1056		1827
1057	sub add_title {	1828	sub add_title {
1058	my ($self, $title) = @_;	1829	my ($self, $title) = @_;
1059		1830
1060	$self->add_item ({	1831	$self->add_item ({
…		…
1062	text => $title,	1833	text => $title,
1063	activate => sub { },	1834	activate => sub { },
1064	});	1835	});
1065	}	1836	}
1066		1837
		1838	=item $popup->add_separator ([$sepchr])
		1839
		1840	Creates a separator, optionally using the character given as C<$sepchr>.
		1841
		1842	=cut
		1843
		1844	sub add_separator {
		1845	my ($self, $sep) = @_;
		1846
		1847	$sep ||= "=";
		1848
		1849	$self->add_item ({
		1850	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1851	text => "",
		1852	render => sub { $sep x $self->{term}->ncol },
		1853	activate => sub { },
		1854	});
		1855	}
		1856
		1857	=item $popup->add_button ($text, $cb)
		1858
		1859	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1860	selected.
		1861
		1862	=cut
		1863
1067	sub add_button {	1864	sub add_button {
1068	my ($self, $text, $cb) = @_;	1865	my ($self, $text, $cb) = @_;
1069		1866
1070	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1867	$self->add_item ({ type => "button", text => $text, activate => $cb});
1071	}	1868	}
		1869
		1870	=item $popup->add_toggle ($text, $initial_value, $cb)
		1871
		1872	Adds a toggle/checkbox item to the popup. The callback gets called
		1873	whenever it gets toggled, with a boolean indicating its new value as its
		1874	first argument.
		1875
		1876	=cut
1072		1877
1073	sub add_toggle {	1878	sub add_toggle {
1074	my ($self, $text, $cb, $value) = @_;	1879	my ($self, $text, $value, $cb) = @_;
1075		1880
1076	my $item; $item = {	1881	my $item; $item = {
1077	type => "button",	1882	type => "button",
1078	text => " $text",	1883	text => " $text",
1079	value => $value,	1884	value => $value,
1080	render => sub { ($item->{value} ? "* " : " ") . $text },	1885	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1081	activate => sub { $cb->($item->{value} = !$item->{value}); },	1886	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1082	};	1887	};
1083		1888
1084	$self->add_item ($item);	1889	$self->add_item ($item);
1085	}	1890	}
		1891
		1892	=item $popup->show
		1893
		1894	Displays the popup (which is initially hidden).
		1895
		1896	=cut
1086		1897
1087	sub show {	1898	sub show {
1088	my ($self) = @_;	1899	my ($self) = @_;
1089		1900
1090	local $urxvt::popup::self = $self;	1901	local $urxvt::popup::self = $self;
1091		1902
1092	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1903	my $env = $self->{term}->env;
		1904	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1905	delete $env->{LC_ALL};
		1906	$env->{LC_CTYPE} = $self->{term}->locale;
		1907
		1908	urxvt::term->new ($env, "popup",
		1909	"--perl-lib" => "", "--perl-ext-common" => "",
		1910	"-pty-fd" => -1, "-sl" => 0,
		1911	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1093	"--transient-for" => $self->{term}->parent,	1912	"--transient-for" => $self->{term}->parent,
		1913	"-display" => $self->{term}->display_id,
1094	"-pe" => "urxvt-popup")	1914	"-pe" => "urxvt-popup")
1095	or die "unable to create popup window\n";	1915	or die "unable to create popup window\n";
1096	}	1916	}
1097		1917
1098	sub DESTROY {	1918	sub DESTROY {
1099	my ($self) = @_;	1919	my ($self) = @_;
1100		1920
		1921	delete $self->{term}{_destroy}{$self};
1101	$self->{term}->ungrab;	1922	$self->{term}->ungrab;
1102	}	1923	}
		1924
		1925	=back
		1926
		1927	=cut
		1928
		1929	package urxvt::watcher;
		1930
		1931	@urxvt::timer::ISA = __PACKAGE__;
		1932	@urxvt::iow::ISA = __PACKAGE__;
		1933	@urxvt::pw::ISA = __PACKAGE__;
		1934	@urxvt::iw::ISA = __PACKAGE__;
1103		1935
1104	=head2 The C<urxvt::timer> Class	1936	=head2 The C<urxvt::timer> Class
1105		1937
1106	This class implements timer watchers/events. Time is represented as a	1938	This class implements timer watchers/events. Time is represented as a
1107	fractional number of seconds since the epoch. Example:	1939	fractional number of seconds since the epoch. Example:
…		…
1146		1978
1147	=item $timer = $timer->start ($tstamp)	1979	=item $timer = $timer->start ($tstamp)
1148		1980
1149	Set the event trigger time to C<$tstamp> and start the timer.	1981	Set the event trigger time to C<$tstamp> and start the timer.
1150		1982
		1983	=item $timer = $timer->after ($delay)
		1984
		1985	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		1986
1151	=item $timer = $timer->stop	1987	=item $timer = $timer->stop
1152		1988
1153	Stop the timer.	1989	Stop the timer.
1154		1990
1155	=back	1991	=back
…		…
1160		1996
1161	$term->{socket} = ...	1997	$term->{socket} = ...
1162	$term->{iow} = urxvt::iow	1998	$term->{iow} = urxvt::iow
1163	->new	1999	->new
1164	->fd (fileno $term->{socket})	2000	->fd (fileno $term->{socket})
1165	->events (1) # wait for read data	2001	->events (urxvt::EVENT_READ)
1166	->start	2002	->start
1167	->cb (sub {	2003	->cb (sub {
1168	my ($iow, $revents) = @_;	2004	my ($iow, $revents) = @_;
1169	# $revents must be 1 here, no need to check	2005	# $revents must be 1 here, no need to check
1170	sysread $term->{socket}, my $buf, 8192	2006	sysread $term->{socket}, my $buf, 8192
…		…
1183	Set the callback to be called when io events are triggered. C<$reventmask>	2019	Set the callback to be called when io events are triggered. C<$reventmask>
1184	is a bitset as described in the C<events> method.	2020	is a bitset as described in the C<events> method.
1185		2021
1186	=item $iow = $iow->fd ($fd)	2022	=item $iow = $iow->fd ($fd)
1187		2023
1188	Set the filedescriptor (not handle) to watch.	2024	Set the file descriptor (not handle) to watch.
1189		2025
1190	=item $iow = $iow->events ($eventmask)	2026	=item $iow = $iow->events ($eventmask)
1191		2027
1192	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2028	Set the event mask to watch. The only allowed values are
1193	data, Bit #1 (value C<2>) enables watching for write data.	2029	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		2030	together, or C<urxvt::EVENT_NONE>.
1194		2031
1195	=item $iow = $iow->start	2032	=item $iow = $iow->start
1196		2033
1197	Start watching for requested events on the given handle.	2034	Start watching for requested events on the given handle.
1198		2035
1199	=item $iow = $iow->stop	2036	=item $iow = $iow->stop
1200		2037
1201	Stop watching for events on the given filehandle.	2038	Stop watching for events on the given file handle.
		2039
		2040	=back
		2041
		2042	=head2 The C<urxvt::iw> Class
		2043
		2044	This class implements idle watchers, that get called automatically when
		2045	the process is idle. They should return as fast as possible, after doing
		2046	some useful work.
		2047
		2048	=over 4
		2049
		2050	=item $iw = new urxvt::iw
		2051
		2052	Create a new idle watcher object in stopped state.
		2053
		2054	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2055
		2056	Set the callback to be called when the watcher triggers.
		2057
		2058	=item $timer = $timer->start
		2059
		2060	Start the watcher.
		2061
		2062	=item $timer = $timer->stop
		2063
		2064	Stop the watcher.
		2065
		2066	=back
		2067
		2068	=head2 The C<urxvt::pw> Class
		2069
		2070	This class implements process watchers. They create an event whenever a
		2071	process exits, after which they stop automatically.
		2072
		2073	my $pid = fork;
		2074	...
		2075	$term->{pw} = urxvt::pw
		2076	->new
		2077	->start ($pid)
		2078	->cb (sub {
		2079	my ($pw, $exit_status) = @_;
		2080	...
		2081	});
		2082
		2083	=over 4
		2084
		2085	=item $pw = new urxvt::pw
		2086
		2087	Create a new process watcher in stopped state.
		2088
		2089	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2090
		2091	Set the callback to be called when the timer triggers.
		2092
		2093	=item $pw = $timer->start ($pid)
		2094
		2095	Tells the watcher to start watching for process C<$pid>.
		2096
		2097	=item $pw = $pw->stop
		2098
		2099	Stop the watcher.
1202		2100
1203	=back	2101	=back
1204		2102
1205	=head1 ENVIRONMENT	2103	=head1 ENVIRONMENT
1206		2104
…		…
1209	This variable controls the verbosity level of the perl extension. Higher	2107	This variable controls the verbosity level of the perl extension. Higher
1210	numbers indicate more verbose output.	2108	numbers indicate more verbose output.
1211		2109
1212	=over 4	2110	=over 4
1213		2111
1214	=item =0 - only fatal messages	2112	=item == 0 - fatal messages
1215		2113
1216	=item =3 - script loading and management	2114	=item >= 3 - script loading and management
1217		2115
1218	=item =10 - all events received	2116	=item >=10 - all called hooks
		2117
		2118	=item >=11 - hook return values
1219		2119
1220	=back	2120	=back
1221		2121
1222	=head1 AUTHOR	2122	=head1 AUTHOR
1223		2123

Diff Legend

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