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

Diff Legend

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