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.19 by root, Tue Jan 3 02:42:17 2006 UTC vs.
Revision 1.154 by root, Sat Jun 2 06:43:02 2007 UTC

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

Diff Legend

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