ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.7 by root, Mon Jan 2 19:05:05 2006 UTC vs.
Revision 1.146 by root, Thu Aug 17 21:56:11 2006 UTC

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

Diff Legend

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