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

Diff Legend

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