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.8 by root, Mon Jan 2 20:35:39 2006 UTC vs.
Revision 1.127 by root, Wed Jan 25 00:42:21 2006 UTC

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

Diff Legend

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