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.7 by root, Mon Jan 2 19:05:05 2006 UTC vs.
Revision 1.142 by root, Thu Jul 6 18:56:10 2006 UTC

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

Diff Legend

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