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

Diff Legend

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