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.1 by root, Mon Jan 2 15:35:43 2006 UTC vs.
Revision 1.178 by root, Sat Dec 26 09:02:42 2009 UTC

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

Diff Legend

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