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

Diff Legend

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