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.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.165 by root, Sat May 10 22:36:46 2008 UTC

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

Diff Legend

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