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.17 by root, Tue Jan 3 01:45:03 2006 UTC vs.
Revision 1.136 by root, Mon Feb 20 20:44:22 2006 UTC

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

Diff Legend

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