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.5 by root, Mon Jan 2 17:20:00 2006 UTC vs.
Revision 1.153 by root, Sat Jun 2 05:23:11 2007 UTC

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

Diff Legend

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