ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC vs.
Revision 1.133 by root, Mon Feb 6 06:14:08 2006 UTC

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

Diff Legend

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