ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

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

Diff Legend

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