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

Diff Legend

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