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.13 by root, Tue Jan 3 00:06:57 2006 UTC vs.
Revision 1.129 by root, Wed Jan 25 15:11:31 2006 UTC

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

Diff Legend

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