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

Diff Legend

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