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

Diff Legend

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