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.6 by root, Mon Jan 2 18:20:23 2006 UTC vs.
Revision 1.135 by root, Sun Feb 12 05:31:53 2006 UTC

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

Diff Legend

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