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

Diff Legend

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