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.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC

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

Diff Legend

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