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

Diff Legend

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