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

Diff Legend

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