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.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.173 by root, Wed Nov 5 12:45:36 2008 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, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the 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,selection-autotransform
		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
44	Intelligent selection. This extension tries to be more intelligent when	51	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	52	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	53	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	54	arguments, which is very convenient, too, if your F<ls> supports
		55	C<--quoting-style=shell>.
48		56
49	It also offers the following bindable event:	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:
50		86
51	=over 4	87	=over 4
52		88
53	=item rot13	89	=item rot13
54		90
…		…
61	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
62		98
63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	100	runtime.
65		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
66	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
67		120
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	122	text into various other formats/action (such as uri unescaping, perl
		123	evaluation, web-browser starting etc.), depending on content.
		124
		125	Other extensions can extend this popup menu by pushing a code reference
		126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
		128
		129	Its sole argument is the popup menu, which can be modified. The selection
		130	is in C<$_>, which can be used to decide whether to add something or not.
		131	It should either return nothing or a string and a code reference. The
		132	string will be used as button text and the code reference will be called
		133	when the button gets activated and should transform C<$_>.
		134
		135	The following will add an entry C<a to b> that transforms all C<a>s in
		136	the selection to C<b>s, but only if the selection currently contains any
		137	C<a>s:
		138
		139	push @{ $self->{term}{selection_popup_hook} }, sub {
		140	/a/ ? ("a to b" => sub { s/a/b/g }
		141	: ()
		142	};
70		143
71	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
72		145
73	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
74	by a hotkey (default: C<M-s>). When in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	input/output is suspended.	148	input/output is suspended and a regex is displayed at the bottom of the
		149	screen.
76		150
77	C</> starts an incremental regex search, C<n> searches further, C<p> or	151	Inputting characters appends them to the regex and continues incremental
78	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
79	history, C<enter> leaves search mode at the current position and C<escape>	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
80	returns to the original position.	154	bottom. C<Escape> leaves search mode and returns to the point where search
		155	was started, while C<Enter> or C<Return> stay at the current position and
		156	additionally stores the first match in the current line into the primary
		157	selection if the C<Shift> modifier is active.
81		158
82	=item digital-clock	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.
83		162
84	Displays a digital clock using the built-in overlay.	163	See L<perlre> for more info about perl regular expression syntax.
85		164
86	=item mark-urls	165	=item readline (enabled by default)
87		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
		189
		190	=item selection-autotransform
		191
		192	This selection allows you to do automatic transforms on a selection
		193	whenever a selection is made.
		194
		195	It works by specifying perl snippets (most useful is a single C<s///>
		196	operator) that modify C<$_> as resources:
		197
		198	URxvt.selection-autotransform.0: transform
		199	URxvt.selection-autotransform.1: transform
		200	...
		201
		202	For example, the following will transform selections of the form
		203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		204	$word>:
		205
		206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		207
		208	And this example matches the same,but replaces it with vi-commands you can
		209	paste directly into your (vi :) editor:
		210
		211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		212
		213	Of course, this can be modified to suit your needs and your editor :)
		214
		215	To expand the example above to typical perl error messages ("XXX at
		216	FILENAME line YYY."), you need a slightly more elaborate solution:
		217
		218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		220
		221	The first line tells the selection code to treat the unchanging part of
		222	every error message as a selection pattern, and the second line transforms
		223	the message into vi commands to load the file.
		224
		225	=item tabbed
		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
88	Uses per-line display filtering (C<on_line_update>) to underline urls.	250	Uses per-line display filtering (C<on_line_update>) to underline text
		251	matching a certain pattern and make it clickable. When clicked with the
		252	mouse button specified in the C<matcher.button> resource (default 2, or
		253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
89		313
90	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
91		315
92	A not very useful example of filtering all text output to the terminal,	316	A not very useful example of filtering all text output to the terminal
93	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
94	similar-looking ascii character.	318	similar-looking ascii character.
		319
		320	=item digital-clock
		321
		322	Displays a digital clock using the built-in overlay.
		323
		324	=item remote-clipboard
		325
		326	Somewhat of a misnomer, this extension adds two menu entries to the
		327	selection popup that allows one to run external commands to store the
		328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		343
		344	=item selection-pastebin
		345
		346	This is a little rarely useful extension that Uploads the selection as
		347	textfile to a remote site (or does other things). (The implementation is
		348	not currently secure for use in a multiuser environment as it writes to
		349	F</tmp> directly.).
		350
		351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		352	i.e.
		353
		354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		355
		356	Pressing this combination runs a command with C<%> replaced by the name of
		357	the textfile. This command can be set via a resource:
		358
		359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		360
		361	And the default is likely not useful to anybody but the few people around
		362	here :)
		363
		364	The name of the textfile is the hex encoded md5 sum of the selection, so
		365	the same content should lead to the same filename.
		366
		367	After a successful upload the selection will be replaced by the text given
		368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		369	for the filename):
		370
		371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of wether xrdb is used to parse the resource file
		376	or not.
95		377
96	=item example-refresh-hooks	378	=item example-refresh-hooks
97		379
98	Displays a very simple digital clock in the upper right corner of the	380	Displays a very simple digital clock in the upper right corner of the
99	window. Illustrates overwriting the refresh callbacks to create your own	381	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	382	overlays or changes.
101		383
102	=back	384	=back
		385
		386	=head1 API DOCUMENTATION
103		387
104	=head2 General API Considerations	388	=head2 General API Considerations
105		389
106	All objects (such as terminals, time watchers etc.) are typical	390	All objects (such as terminals, time watchers etc.) are typical
107	reference-to-hash objects. The hash can be used to store anything you	391	reference-to-hash objects. The hash can be used to store anything you
…		…
120	=over 4	404	=over 4
121		405
122	=item $text	406	=item $text
123		407
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	408	Rxvt-unicodes special way of encoding text, where one "unicode" character
125	always represents one screen cell. See L<row_t> for a discussion of this format.	409	always represents one screen cell. See L<ROW_t> for a discussion of this format.
126		410
127	=item $string	411	=item $string
128		412
129	A perl text string, with an emphasis on I<text>. It can store all unicode	413	A perl text string, with an emphasis on I<text>. It can store all unicode
130	characters and is to be distinguished with text encoded in a specific	414	characters and is to be distinguished with text encoded in a specific
…		…
137		421
138	=back	422	=back
139		423
140	=head2 Extension Objects	424	=head2 Extension Objects
141		425
142	Very perl extension is a perl class. A separate perl object is created	426	Every perl extension is a perl class. A separate perl object is created
143	for each terminal and each extension and passed as the first parameter to	427	for each terminal, and each terminal has its own set of extenion objects,
144	hooks. So extensions can use their C<$self> object without having to think	428	which are passed as the first parameter to hooks. So extensions can use
145	about other extensions, with the exception of methods and members that	429	their C<$self> object without having to think about clashes with other
		430	extensions or other terminals, with the exception of methods and members
146	begin with an underscore character C<_>: these are reserved for internal	431	that begin with an underscore character C<_>: these are reserved for
147	use.	432	internal use.
148		433
149	Although it isn't a C<urxvt::term> object, you can call all methods of the	434	Although it isn't a C<urxvt::term> object, you can call all methods of the
150	C<urxvt::term> class on this object.	435	C<urxvt::term> class on this object.
151		436
152	It has the following methods and data members:	437	It has the following methods and data members:
…		…
173	=head2 Hooks	458	=head2 Hooks
174		459
175	The following subroutines can be declared in extension files, and will be	460	The following subroutines can be declared in extension files, and will be
176	called whenever the relevant event happens.	461	called whenever the relevant event happens.
177		462
178	The first argument passed to them is an extension oject as described in	463	The first argument passed to them is an extension object as described in
179	the in the C<Extension Objects> section.	464	the in the C<Extension Objects> section.
180		465
181	B<All> of these hooks must return a boolean value. If it is true, then the	466	B<All> of these hooks must return a boolean value. If any of the called
182	event counts as being I<consumed>, and the invocation of other hooks is	467	hooks returns true, then the event counts as being I<consumed>, and the
183	skipped, and the relevant action might not be carried out by the C++ code.	468	relevant action might not be carried out by the C++ code.
184		469
185	I<< When in doubt, return a false value (preferably C<()>). >>	470	I<< When in doubt, return a false value (preferably C<()>). >>
186		471
187	=over 4	472	=over 4
188		473
189	=item on_init $term	474	=item on_init $term
190		475
191	Called after a new terminal object has been initialized, but before	476	Called after a new terminal object has been initialized, but before
192	windows are created or the command gets run. Most methods are unsafe to	477	windows are created or the command gets run. Most methods are unsafe to
193	call or deliver senseless data, as terminal size and other characteristics	478	call or deliver senseless data, as terminal size and other characteristics
194	have not yet been determined. You can safely query and change resources,	479	have not yet been determined. You can safely query and change resources
195	though.	480	and options, though. For many purposes the C<on_start> hook is a better
		481	place.
		482
		483	=item on_start $term
		484
		485	Called at the very end of initialisation of a new terminal, just before
		486	trying to map (display) the toplevel and returning to the main loop.
		487
		488	=item on_destroy $term
		489
		490	Called whenever something tries to destroy terminal, when the terminal is
		491	still fully functional (not for long, though).
196		492
197	=item on_reset $term	493	=item on_reset $term
198		494
199	Called after the screen is "reset" for any reason, such as resizing or	495	Called after the screen is "reset" for any reason, such as resizing or
200	control sequences. Here is where you can react on changes to size-related	496	control sequences. Here is where you can react on changes to size-related
201	variables.	497	variables.
202		498
203	=item on_start $term	499	=item on_child_start $term, $pid
204		500
205	Called at the very end of initialisation of a new terminal, just before	501	Called just after the child process has been C<fork>ed.
206	returning to the mainloop.	502
		503	=item on_child_exit $term, $status
		504
		505	Called just after the child process has exited. C<$status> is the status
		506	from C<waitpid>.
207		507
208	=item on_sel_make $term, $eventtime	508	=item on_sel_make $term, $eventtime
209		509
210	Called whenever a selection has been made by the user, but before the	510	Called whenever a selection has been made by the user, but before the
211	selection text is copied, so changes to the beginning, end or type of the	511	selection text is copied, so changes to the beginning, end or type of the
…		…
218		518
219	Called whenever a selection has been copied, but before the selection is	519	Called whenever a selection has been copied, but before the selection is
220	requested from the server. The selection text can be queried and changed	520	requested from the server. The selection text can be queried and changed
221	by calling C<< $term->selection >>.	521	by calling C<< $term->selection >>.
222		522
223	Returning a true value aborts selection grabbing. It will still be hilighted.	523	Returning a true value aborts selection grabbing. It will still be highlighted.
224		524
225	=item on_sel_extend $term	525	=item on_sel_extend $term
226		526
227	Called whenever the user tries to extend the selection (e.g. with a double	527	Called whenever the user tries to extend the selection (e.g. with a double
228	click) and is either supposed to return false (normal operation), or	528	click) and is either supposed to return false (normal operation), or
229	should extend the selection itelf and return true to suppress the built-in	529	should extend the selection itself and return true to suppress the built-in
230	processing.	530	processing. This can happen multiple times, as long as the callback
		531	returns true, it will be called on every further click by the user and is
		532	supposed to enlarge the selection more and more, if possible.
231		533
232	See the F<selection> example extension.	534	See the F<selection> example extension.
233		535
234	=item on_view_change $term, $offset	536	=item on_view_change $term, $offset
235		537
236	Called whenever the view offset changes, i..e the user or program	538	Called whenever the view offset changes, i.e. the user or program
237	scrolls. Offset C<0> means display the normal terminal, positive values	539	scrolls. Offset C<0> means display the normal terminal, positive values
238	show this many lines of scrollback.	540	show this many lines of scrollback.
239		541
240	=item on_scroll_back $term, $lines, $saved	542	=item on_scroll_back $term, $lines, $saved
241		543
…		…
245		547
246	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	548	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
247	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	549	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
248	number of lines that will be in the scrollback buffer.	550	number of lines that will be in the scrollback buffer.
249		551
250	=item on_osc_seq $term, $string	552	=item on_osc_seq $term, $op, $args, $resp
		553
		554	Called on every OSC sequence and can be used to suppress it or modify its
		555	behaviour. The default should be to return an empty list. A true value
		556	suppresses execution of the request completely. Make sure you don't get
		557	confused by recursive invocations when you output an OSC sequence within
		558	this callback.
		559
		560	C<on_osc_seq_perl> should be used for new behaviour.
		561
		562	=item on_osc_seq_perl $term, $args, $resp
251		563
252	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	564	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
253	operating system command) is processed. Cursor position and other state	565	operating system command) is processed. Cursor position and other state
254	information is up-to-date when this happens. For interoperability, the	566	information is up-to-date when this happens. For interoperability, the
255	string should start with the extension name and a colon, to distinguish	567	string should start with the extension name (sans -osc) and a semicolon,
256	it from commands for other extensions, and this might be enforced in the	568	to distinguish it from commands for other extensions, and this might be
257	future.	569	enforced in the future.
		570
		571	For example, C<overlay-osc> uses this:
		572
		573	sub on_osc_seq_perl {
		574	my ($self, $osc, $resp) = @_;
		575
		576	return unless $osc =~ s/^overlay;//;
		577
		578	... process remaining $osc string
		579	}
258		580
259	Be careful not ever to trust (in a security sense) the data you receive,	581	Be careful not ever to trust (in a security sense) the data you receive,
260	as its source can not easily be controleld (e-mail content, messages from	582	as its source can not easily be controlled (e-mail content, messages from
261	other users on the same system etc.).	583	other users on the same system etc.).
		584
		585	For responses, C<$resp> contains the end-of-args separator used by the
		586	sender.
262		587
263	=item on_add_lines $term, $string	588	=item on_add_lines $term, $string
264		589
265	Called whenever text is about to be output, with the text as argument. You	590	Called whenever text is about to be output, with the text as argument. You
266	can filter/change and output the text yourself by returning a true value	591	can filter/change and output the text yourself by returning a true value
…		…
287	later with the already-modified line (e.g. if unrelated parts change), so	612	later with the already-modified line (e.g. if unrelated parts change), so
288	you cannot just toggle rendition bits, but only set them.	613	you cannot just toggle rendition bits, but only set them.
289		614
290	=item on_refresh_begin $term	615	=item on_refresh_begin $term
291		616
292	Called just before the screen gets redrawn. Can be used for overlay	617	Called just before the screen gets redrawn. Can be used for overlay or
293	or similar effects by modify terminal contents in refresh_begin, and	618	similar effects by modifying the terminal contents in refresh_begin, and
294	restoring them in refresh_end. The built-in overlay and selection display	619	restoring them in refresh_end. The built-in overlay and selection display
295	code is run after this hook, and takes precedence.	620	code is run after this hook, and takes precedence.
296		621
297	=item on_refresh_end $term	622	=item on_refresh_end $term
298		623
299	Called just after the screen gets redrawn. See C<on_refresh_begin>.	624	Called just after the screen gets redrawn. See C<on_refresh_begin>.
300		625
301	=item on_keyboard_command $term, $string	626	=item on_user_command $term, $string
302		627
303	Called whenever the user presses a key combination that has a	628	Called whenever a user-configured event is being activated (e.g. via
304	C<perl:string> action bound to it (see description of the B<keysym>	629	a C<perl:string> action bound to a key, see description of the B<keysym>
305	resource in the @@RXVT_NAME@@(1) manpage).	630	resource in the @@RXVT_NAME@@(1) manpage).
		631
		632	The event is simply the action string. This interface is assumed to change
		633	slightly in the future.
		634
		635	=item on_resize_all_windows $tern, $new_width, $new_height
		636
		637	Called just after the new window size has been calculated, but before
		638	windows are actually being resized or hints are being set. If this hook
		639	returns TRUE, setting of the window hints is being skipped.
		640
		641	=item on_x_event $term, $event
		642
		643	Called on every X event received on the vt window (and possibly other
		644	windows). Should only be used as a last resort. Most event structure
		645	members are not passed.
		646
		647	=item on_root_event $term, $event
		648
		649	Like C<on_x_event>, but is called for events on the root window.
306		650
307	=item on_focus_in $term	651	=item on_focus_in $term
308		652
309	Called whenever the window gets the keyboard focus, before rxvt-unicode	653	Called whenever the window gets the keyboard focus, before rxvt-unicode
310	does focus in processing.	654	does focus in processing.
311		655
312	=item on_focus_out $term	656	=item on_focus_out $term
313		657
314	Called wheneever the window loses keyboard focus, before rxvt-unicode does	658	Called whenever the window loses keyboard focus, before rxvt-unicode does
315	focus out processing.	659	focus out processing.
		660
		661	=item on_configure_notify $term, $event
		662
		663	=item on_property_notify $term, $event
316		664
317	=item on_key_press $term, $event, $keysym, $octets	665	=item on_key_press $term, $event, $keysym, $octets
318		666
319	=item on_key_release $term, $event, $keysym	667	=item on_key_release $term, $event, $keysym
320		668
…		…
330		678
331	Called whenever the corresponding X event is received for the terminal If	679	Called whenever the corresponding X event is received for the terminal If
332	the hook returns true, then the even will be ignored by rxvt-unicode.	680	the hook returns true, then the even will be ignored by rxvt-unicode.
333		681
334	The event is a hash with most values as named by Xlib (see the XEvent	682	The event is a hash with most values as named by Xlib (see the XEvent
335	manpage), with the additional members C<row> and C<col>, which are the row	683	manpage), with the additional members C<row> and C<col>, which are the
336	and column under the mouse cursor.	684	(real, not screen-based) row and column under the mouse cursor.
337		685
338	C<on_key_press> additionally receives the string rxvt-unicode would	686	C<on_key_press> additionally receives the string rxvt-unicode would
339	output, if any, in locale-specific encoding.	687	output, if any, in locale-specific encoding.
340		688
341	subwindow.	689	subwindow.
342		690
343	=back	691	=item on_client_message $term, $event
344		692
345	=head2 Variables in the C<urxvt> Package	693	=item on_wm_protocols $term, $event
346		694
347	=over 4	695	=item on_wm_delete_window $term, $event
348		696
349	=item $urxvt::TERM	697	Called when various types of ClientMessage events are received (all with
350		698	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
351	The current terminal. This variable stores the current C<urxvt::term>
352	object, whenever a callback/hook is executing.
353
354	=back
355
356	=head2 Functions in the C<urxvt> Package
357
358	=over 4
359
360	=item $term = new urxvt [arg...]
361
362	Creates a new terminal, very similar as if you had started it with
363	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
364	if the new instance couldn't be created. Returns C<undef> if the new
365	instance didn't initialise perl, and the terminal object otherwise. The
366	C<init> and C<start> hooks will be called during the call.
367
368	=item urxvt::fatal $errormessage
369
370	Fatally aborts execution with the given error message. Avoid at all
371	costs! The only time this is acceptable is when the terminal process
372	starts up.
373
374	=item urxvt::warn $string
375
376	Calls C<rxvt_warn> with the given string which should not include a
377	newline. The module also overwrites the C<warn> builtin with a function
378	that calls this function.
379
380	Using this function has the advantage that its output ends up in the
381	correct place, e.g. on stderr of the connecting urxvtc client.
382
383	=item $is_safe = urxvt::safe
384
385	Returns true when it is safe to do potentially unsafe things, such as
386	evaluating perl code specified by the user. This is true when urxvt was
387	started setuid or setgid.
388
389	=item $time = urxvt::NOW
390
391	Returns the "current time" (as per the event loop).
392
393	=item urxvt::CurrentTime
394
395	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
396	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
397	Button4Mask, Button5Mask, AnyModifier
398
399	Various constants for use in X calls and event processing.
400
401	=back
402
403	=head2 RENDITION
404
405	Rendition bitsets contain information about colour, font, font styles and
406	similar information for each screen cell.
407
408	The following "macros" deal with changes in rendition sets. You should
409	never just create a bitset, you should always modify an existing one,
410	as they contain important information required for correct operation of
411	rxvt-unicode.
412
413	=over 4
414
415	=item $rend = urxvt::DEFAULT_RSTYLE
416
417	Returns the default rendition, as used when the terminal is starting up or
418	being reset. Useful as a base to start when creating renditions.
419
420	=item $rend = urxvt::OVERLAY_RSTYLE
421
422	Return the rendition mask used for overlays by default.
423
424	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
425
426	Return the bit that enabled bold, italic, blink, reverse-video and
427	underline, respectively. To enable such a style, just logically OR it into
428	the bitset.
429
430	=item $foreground = urxvt::GET_BASEFG $rend
431
432	=item $background = urxvt::GET_BASEBG $rend
433
434	Return the foreground/background colour index, respectively.
435
436	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
437
438	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
439
440	Replace the foreground/background colour in the rendition mask with the
441	specified one.
442
443	=item $value = urxvt::GET_CUSTOM ($rend)
444
445	Return the "custom" value: Every rendition has 5 bits for use by
446	extensions. They can be set and changed as you like and are initially
447	zero.
448
449	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
450
451	Change the custom value.
452		699
453	=back	700	=back
454		701
455	=cut	702	=cut
456		703
…		…
462	use Scalar::Util ();	709	use Scalar::Util ();
463	use List::Util ();	710	use List::Util ();
464		711
465	our $VERSION = 1;	712	our $VERSION = 1;
466	our $TERM;	713	our $TERM;
		714	our @TERM_INIT;
		715	our @TERM_EXT;
467	our @HOOKNAME;	716	our @HOOKNAME;
468	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	717	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
469	our %OPTION;	718	our %OPTION;
470		719
471	our $LIBDIR;	720	our $LIBDIR;
472	our $RESNAME;	721	our $RESNAME;
473	our $RESCLASS;	722	our $RESCLASS;
474	our $RXVTNAME;	723	our $RXVTNAME;
475		724
		725	our $NOCHAR = chr 0xffff;
		726
		727	=head2 Variables in the C<urxvt> Package
		728
		729	=over 4
		730
		731	=item $urxvt::LIBDIR
		732
		733	The rxvt-unicode library directory, where, among other things, the perl
		734	modules and scripts are stored.
		735
		736	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		737
		738	The resource class and name rxvt-unicode uses to look up X resources.
		739
		740	=item $urxvt::RXVTNAME
		741
		742	The basename of the installed binaries, usually C<urxvt>.
		743
		744	=item $urxvt::TERM
		745
		746	The current terminal. This variable stores the current C<urxvt::term>
		747	object, whenever a callback/hook is executing.
		748
		749	=item @urxvt::TERM_INIT
		750
		751	All code references in this array will be called as methods of the next newly
		752	created C<urxvt::term> object (during the C<on_init> phase). The array
		753	gets cleared before the code references that were in it are being executed,
		754	so references can push themselves onto it again if they so desire.
		755
		756	This complements to the perl-eval command line option, but gets executed
		757	first.
		758
		759	=item @urxvt::TERM_EXT
		760
		761	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		762	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		763	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		764
		765	=back
		766
		767	=head2 Functions in the C<urxvt> Package
		768
		769	=over 4
		770
		771	=item urxvt::fatal $errormessage
		772
		773	Fatally aborts execution with the given error message. Avoid at all
		774	costs! The only time this is acceptable is when the terminal process
		775	starts up.
		776
		777	=item urxvt::warn $string
		778
		779	Calls C<rxvt_warn> with the given string which should not include a
		780	newline. The module also overwrites the C<warn> builtin with a function
		781	that calls this function.
		782
		783	Using this function has the advantage that its output ends up in the
		784	correct place, e.g. on stderr of the connecting urxvtc client.
		785
		786	Messages have a size limit of 1023 bytes currently.
		787
		788	=item @terms = urxvt::termlist
		789
		790	Returns all urxvt::term objects that exist in this process, regardless of
		791	whether they are started, being destroyed etc., so be careful. Only term
		792	objects that have perl extensions attached will be returned (because there
		793	is no urxvt::term objet associated with others).
		794
		795	=item $time = urxvt::NOW
		796
		797	Returns the "current time" (as per the event loop).
		798
		799	=item urxvt::CurrentTime
		800
		801	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		802	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		803	Button4Mask, Button5Mask, AnyModifier
		804
		805	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		806	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		807	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		808	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		809	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		810	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		811	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		812
		813	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		814	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		815	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		816	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		817	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		818	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		819	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		820
		821	Various constants for use in X calls and event processing.
		822
		823	=back
		824
		825	=head2 RENDITION
		826
		827	Rendition bitsets contain information about colour, font, font styles and
		828	similar information for each screen cell.
		829
		830	The following "macros" deal with changes in rendition sets. You should
		831	never just create a bitset, you should always modify an existing one,
		832	as they contain important information required for correct operation of
		833	rxvt-unicode.
		834
		835	=over 4
		836
		837	=item $rend = urxvt::DEFAULT_RSTYLE
		838
		839	Returns the default rendition, as used when the terminal is starting up or
		840	being reset. Useful as a base to start when creating renditions.
		841
		842	=item $rend = urxvt::OVERLAY_RSTYLE
		843
		844	Return the rendition mask used for overlays by default.
		845
		846	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		847
		848	Return the bit that enabled bold, italic, blink, reverse-video and
		849	underline, respectively. To enable such a style, just logically OR it into
		850	the bitset.
		851
		852	=item $foreground = urxvt::GET_BASEFG $rend
		853
		854	=item $background = urxvt::GET_BASEBG $rend
		855
		856	Return the foreground/background colour index, respectively.
		857
		858	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		859
		860	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		861
		862	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		863
		864	Replace the foreground/background colour in the rendition mask with the
		865	specified one.
		866
		867	=item $value = urxvt::GET_CUSTOM $rend
		868
		869	Return the "custom" value: Every rendition has 5 bits for use by
		870	extensions. They can be set and changed as you like and are initially
		871	zero.
		872
		873	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		874
		875	Change the custom value.
		876
		877	=back
		878
		879	=cut
		880
476	BEGIN {	881	BEGIN {
477	urxvt->bootstrap;
478
479	# overwrite perl's warn	882	# overwrite perl's warn
480	*CORE::GLOBAL::warn = sub {	883	*CORE::GLOBAL::warn = sub {
481	my $msg = join "", @_;	884	my $msg = join "", @_;
482	$msg .= "\n"	885	$msg .= "\n"
483	unless $msg =~ /\n$/;	886	unless $msg =~ /\n$/;
484	urxvt::warn ($msg);	887	urxvt::warn ($msg);
485	};	888	};
486
487	delete $ENV{IFS};
488	delete $ENV{CDPATH};
489	delete $ENV{BASH_ENV};
490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
491	}	889	}
492		890
493	my @hook_count;	891	no warnings 'utf8';
		892
494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	893	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
495		894
496	sub verbose {	895	sub verbose {
497	my ($level, $msg) = @_;	896	my ($level, $msg) = @_;
498	warn "$msg\n" if $level <= $verbosity;	897	warn "$msg\n" if $level <= $verbosity;
499	}	898	}
500		899
501	my $extension_pkg = "extension0000";
502	my %extension_pkg;	900	my %extension_pkg;
503		901
504	# load a single script into its own package, once only	902	# load a single script into its own package, once only
505	sub extension_package($) {	903	sub extension_package($) {
506	my ($path) = @_;	904	my ($path) = @_;
507		905
508	$extension_pkg{$path} ||= do {	906	$extension_pkg{$path} ||= do {
509	my $pkg = "urxvt::" . ($extension_pkg++);	907	$path =~ /([^\/\\]+)$/;
		908	my $pkg = $1;
		909	$pkg =~ s/[^[:word:]]/_/g;
		910	$pkg = "urxvt::ext::$pkg";
510		911
511	verbose 3, "loading extension '$path' into package '$pkg'";	912	verbose 3, "loading extension '$path' into package '$pkg'";
512		913
513	open my $fh, "<:raw", $path	914	open my $fh, "<:raw", $path
514	or die "$path: $!";	915	or die "$path: $!";
515		916
516	my $source = untaint	917	my $source =
517	"package $pkg; use strict; use utf8;\n"	918	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
518	. "use base urxvt::term::extension::;\n"
519	. "#line 1 \"$path\"\n{\n"	919	. "#line 1 \"$path\"\n{\n"
520	. (do { local $/; <$fh> })	920	. (do { local $/; <$fh> })
521	. "\n};\n1";	921	. "\n};\n1";
522		922
523	eval $source	923	eval $source
…		…
534	local $TERM = shift;	934	local $TERM = shift;
535	my $htype = shift;	935	my $htype = shift;
536		936
537	if ($htype == 0) { # INIT	937	if ($htype == 0) { # INIT
538	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	938	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
539		939
540	my %ext_arg;	940	my %ext_arg;
541		941
		942	{
		943	my @init = @TERM_INIT;
		944	@TERM_INIT = ();
		945	$_->($TERM) for @init;
		946	my @pkg = @TERM_EXT;
		947	@TERM_EXT = ();
		948	$TERM->register_package ($_) for @pkg;
		949	}
		950
542	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	951	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
543	if ($_ eq "default") {	952	if ($_ eq "default") {
544	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	953	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
545	} elsif (/^-(.*)$/) {	954	} elsif (/^-(.*)$/) {
546	delete $ext_arg{$1};	955	delete $ext_arg{$1};
547	} elsif (/^([^<]+)<(.*)>$/) {	956	} elsif (/^([^<]+)<(.*)>$/) {
548	push @{ $ext_arg{$1} }, $2;	957	push @{ $ext_arg{$1} }, $2;
549	} else {	958	} else {
550	$ext_arg{$_} ||= [];	959	$ext_arg{$_} ||= [];
551	}	960	}
552	}	961	}
553		962
554	while (my ($ext, $argv) = each %ext_arg) {	963	for my $ext (sort keys %ext_arg) {
555	my @files = grep -f $_, map "$_/$ext", @dirs;	964	my @files = grep -f $_, map "$_/$ext", @dirs;
556		965
557	if (@files) {	966	if (@files) {
558	$TERM->register_package (extension_package $files[0], $argv);	967	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
559	} else {	968	} else {
560	warn "perl extension '$ext' not found in perl library search path\n";	969	warn "perl extension '$ext' not found in perl library search path\n";
561	}	970	}
562	}	971	}
563		972
…		…
569		978
570	if (my $cb = $TERM->{_hook}[$htype]) {	979	if (my $cb = $TERM->{_hook}[$htype]) {
571	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	980	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
572	if $verbosity >= 10;	981	if $verbosity >= 10;
573		982
574	keys %$cb;	983	for my $pkg (keys %$cb) {
575
576	while (my ($pkg, $cb) = each %$cb) {
577	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	984	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
578	and last;	985	$retval ||= $retval_;
579		986
580	if ($@) {	987	if ($@) {
581	$TERM->ungrab; # better to lose the grab than the session	988	$TERM->ungrab; # better to lose the grab than the session
582	warn $@;	989	warn $@;
583	}	990	}
584	}	991	}
		992
		993	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		994	if $verbosity >= 11;
585	}	995	}
586		996
587	if ($htype == 1) { # DESTROY	997	if ($htype == 1) { # DESTROY
588	if (my $hook = delete $TERM->{_hook}) {
589	for my $htype (0..$#$hook) {
590	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
591	or set_should_invoke $htype, 0;
592	}
593	}
594
595	# clear package objects	998	# clear package objects
596	%$_ = () for values %{ $TERM->{_pkg} };	999	%$_ = () for values %{ $TERM->{_pkg} };
597		1000
598	# clear package	1001	# clear package
599	%$TERM = ();	1002	%$TERM = ();
600	}	1003	}
601		1004
602	$retval	1005	$retval
		1006	}
		1007
		1008	sub SET_COLOR($$$) {
		1009	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1010	}
		1011
		1012	sub rend2mask {
		1013	no strict 'refs';
		1014	my ($str, $mask) = (@_, 0);
		1015	my %color = ( fg => undef, bg => undef );
		1016	my @failed;
		1017	for my $spec ( split /\s+/, $str ) {
		1018	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1019	$color{lc($1)} = $2;
		1020	} else {
		1021	my $neg = $spec =~ s/^[-^]//;
		1022	unless ( exists &{"RS_$spec"} ) {
		1023	push @failed, $spec;
		1024	next;
		1025	}
		1026	my $cur = &{"RS_$spec"};
		1027	if ( $neg ) {
		1028	$mask &= ~$cur;
		1029	} else {
		1030	$mask |= $cur;
		1031	}
		1032	}
		1033	}
		1034	($mask, @color{qw(fg bg)}, \@failed)
603	}	1035	}
604		1036
605	# urxvt::term::extension	1037	# urxvt::term::extension
606		1038
607	package urxvt::term::extension;	1039	package urxvt::term::extension;
…		…
613	while (my ($name, $cb) = each %hook) {	1045	while (my ($name, $cb) = each %hook) {
614	my $htype = $HOOKTYPE{uc $name};	1046	my $htype = $HOOKTYPE{uc $name};
615	defined $htype	1047	defined $htype
616	or Carp::croak "unsupported hook type '$name'";	1048	or Carp::croak "unsupported hook type '$name'";
617		1049
		1050	$self->set_should_invoke ($htype, +1)
618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1051	unless exists $self->{term}{_hook}[$htype]{$pkg};
619	$hook_count[$htype]++
620	or urxvt::set_should_invoke $htype, 1;
621	}
622		1052
623	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1053	$self->{term}{_hook}[$htype]{$pkg} = $cb;
624	}	1054	}
625	}	1055	}
626		1056
…		…
631	for my $name (@hook) {	1061	for my $name (@hook) {
632	my $htype = $HOOKTYPE{uc $name};	1062	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	1063	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	1064	or Carp::croak "unsupported hook type '$name'";
635		1065
		1066	$self->set_should_invoke ($htype, -1)
636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1067	if delete $self->{term}{_hook}[$htype]{$pkg};
637	--$hook_count[$htype]
638	or urxvt::set_should_invoke $htype, 0;
639	}
640	}	1068	}
641	}	1069	}
642		1070
643	our $AUTOLOAD;	1071	our $AUTOLOAD;
644		1072
…		…
675		1103
676	=head2 The C<urxvt::anyevent> Class	1104	=head2 The C<urxvt::anyevent> Class
677		1105
678	The sole purpose of this class is to deliver an interface to the	1106	The sole purpose of this class is to deliver an interface to the
679	C<AnyEvent> module - any module using it will work inside urxvt without	1107	C<AnyEvent> module - any module using it will work inside urxvt without
680	further work. The only exception is that you cannot wait on condition	1108	further programming. The only exception is that you cannot wait on
681	variables, but non-blocking condvar use is ok. What this means is that you	1109	condition variables, but non-blocking condvar use is ok. What this means
682	cannot use blocking APIs, but the non-blocking variant should work.	1110	is that you cannot use blocking APIs, but the non-blocking variant should
		1111	work.
683		1112
684	=cut	1113	=cut
685		1114
686	our $VERSION = 1;	1115	our $VERSION = '3.4';
687		1116
688	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1117	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
689	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1118	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
690		1119
691	sub timer {	1120	sub timer {
…		…
722		1151
723	sub DESTROY {	1152	sub DESTROY {
724	$_[0][1]->stop;	1153	$_[0][1]->stop;
725	}	1154	}
726		1155
727	sub condvar {	1156	sub one_event {
728	bless \my $flag, urxvt::anyevent::condvar::
729	}
730
731	sub urxvt::anyevent::condvar::broadcast {
732	${$_[0]}++;
733	}
734
735	sub urxvt::anyevent::condvar::wait {
736	unless (${$_[0]}) {
737	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1157	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
738	}
739	}	1158	}
740		1159
741	package urxvt::term;	1160	package urxvt::term;
742		1161
743	=head2 The C<urxvt::term> Class	1162	=head2 The C<urxvt::term> Class
…		…
748		1167
749	# find on_xxx subs in the package and register them	1168	# find on_xxx subs in the package and register them
750	# as hooks	1169	# as hooks
751	sub register_package {	1170	sub register_package {
752	my ($self, $pkg, $argv) = @_;	1171	my ($self, $pkg, $argv) = @_;
		1172
		1173	no strict 'refs';
		1174
		1175	urxvt::verbose 6, "register package $pkg to $self";
		1176
		1177	@{"$pkg\::ISA"} = urxvt::term::extension::;
753		1178
754	my $proxy = bless {	1179	my $proxy = bless {
755	_pkg => $pkg,	1180	_pkg => $pkg,
756	argv => $argv,	1181	argv => $argv,
757	}, $pkg;	1182	}, $pkg;
…		…
764	$proxy->enable ($name => $ref);	1189	$proxy->enable ($name => $ref);
765	}	1190	}
766	}	1191	}
767	}	1192	}
768		1193
		1194	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1195
		1196	Creates a new terminal, very similar as if you had started it with system
		1197	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1198	hash which defines the environment of the new terminal.
		1199
		1200	Croaks (and probably outputs an error message) if the new instance
		1201	couldn't be created. Returns C<undef> if the new instance didn't
		1202	initialise perl, and the terminal object otherwise. The C<init> and
		1203	C<start> hooks will be called before this call returns, and are free to
		1204	refer to global data (which is race free).
		1205
		1206	=cut
		1207
		1208	sub new {
		1209	my ($class, $env, @args) = @_;
		1210
		1211	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1212	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1213
		1214	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1215	}
		1216
769	=item $term->destroy	1217	=item $term->destroy
770		1218
771	Destroy the terminal object (close the window, free resources etc.).	1219	Destroy the terminal object (close the window, free resources
		1220	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1221	watchers (timers, io watchers) are still active.
		1222
		1223	=item $term->exec_async ($cmd[, @args])
		1224
		1225	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1226	("starts") programs in the background. This function takes care of setting
		1227	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1228	be preferred over explicit calls to C<exec> or C<system>.
		1229
		1230	Returns the pid of the subprocess or C<undef> on error.
		1231
		1232	=cut
		1233
		1234	sub exec_async {
		1235	my $self = shift;
		1236
		1237	my $pid = fork;
		1238
		1239	return $pid
		1240	if !defined $pid or $pid;
		1241
		1242	%ENV = %{ $self->env };
		1243
		1244	exec @_;
		1245	urxvt::_exit 255;
		1246	}
772		1247
773	=item $isset = $term->option ($optval[, $set])	1248	=item $isset = $term->option ($optval[, $set])
774		1249
775	Returns true if the option specified by C<$optval> is enabled, and	1250	Returns true if the option specified by C<$optval> is enabled, and
776	optionally change it. All option values are stored by name in the hash	1251	optionally change it. All option values are stored by name in the hash
777	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1252	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
778		1253
779	Here is a a likely non-exhaustive list of option names, please see the	1254	Here is a likely non-exhaustive list of option names, please see the
780	source file F</src/optinc.h> to see the actual list:	1255	source file F</src/optinc.h> to see the actual list:
781		1256
782	borderLess console cursorBlink cursorUnderline hold iconic insecure	1257	borderLess console cursorBlink cursorUnderline hold iconic insecure
783	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1258	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
784	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1259	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
785	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1260	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
786	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1261	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
787	tripleclickwords utmpInhibit visualBell	1262	transparent tripleclickwords utmpInhibit visualBell
788		1263
789	=item $value = $term->resource ($name[, $newval])	1264	=item $value = $term->resource ($name[, $newval])
790		1265
791	Returns the current resource value associated with a given name and	1266	Returns the current resource value associated with a given name and
792	optionally sets a new value. Setting values is most useful in the C<init>	1267	optionally sets a new value. Setting values is most useful in the C<init>
…		…
801	likely change).	1276	likely change).
802		1277
803	Please note that resource strings will currently only be freed when the	1278	Please note that resource strings will currently only be freed when the
804	terminal is destroyed, so changing options frequently will eat memory.	1279	terminal is destroyed, so changing options frequently will eat memory.
805		1280
806	Here is a a likely non-exhaustive list of resource names, not all of which	1281	Here is a likely non-exhaustive list of resource names, not all of which
807	are supported in every build, please see the source file F</src/rsinc.h>	1282	are supported in every build, please see the source file F</src/rsinc.h>
808	to see the actual list:	1283	to see the actual list:
809		1284
810	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1285	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
811	borderLess color cursorBlink cursorUnderline cutchars delete_key	1286	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
812	display_name embed ext_bwidth fade font geometry hold iconName	1287	display_name embed ext_bwidth fade font geometry hold iconName
813	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1288	imFont imLocale inputMethod insecure int_bwidth intensityStyles
814	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1289	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
815	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1290	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
816	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1291	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
817	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1292	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
818	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1293	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
819	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1294	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
820	shade term_name title transparent transparent_all tripleclickwords	1295	secondaryScreen secondaryScroll shade term_name title
821	utmpInhibit visualBell	1296	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1297	visualBell
822		1298
823	=cut	1299	=cut
824		1300
825	sub resource($$;$) {	1301	sub resource($$;$) {
826	my ($self, $name) = (shift, shift);	1302	my ($self, $name) = (shift, shift);
827	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1303	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
828	&urxvt::term::_resource	1304	goto &urxvt::term::_resource
829	}	1305	}
		1306
		1307	=item $value = $term->x_resource ($pattern)
		1308
		1309	Returns the X-Resource for the given pattern, excluding the program or
		1310	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1311	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1312	resource with that pattern exists.
		1313
		1314	This method should only be called during the C<on_start> hook, as there is
		1315	only one resource database per display, and later invocations might return
		1316	the wrong resources.
830		1317
831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1318	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832		1319
833	Adds a keymap translation exactly as specified via a resource. See the	1320	Adds a keymap translation exactly as specified via a resource. See the
834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1321	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
…		…
850	=item ($row, $col) = $term->selection_end ([$row, $col])	1337	=item ($row, $col) = $term->selection_end ([$row, $col])
851		1338
852	Return the current values of the selection mark, begin or end positions,	1339	Return the current values of the selection mark, begin or end positions,
853	and optionally set them to new values.	1340	and optionally set them to new values.
854		1341
		1342	=item $term->selection_make ($eventtime[, $rectangular])
		1343
		1344	Tries to make a selection as set by C<selection_beg> and
		1345	C<selection_end>. If C<$rectangular> is true (default: false), a
		1346	rectangular selection will be made. This is the prefered function to make
		1347	a selection.
		1348
855	=item $success = $term->selection_grab ($eventtime)	1349	=item $success = $term->selection_grab ($eventtime)
856		1350
857	Try to request the primary selection from the server (for example, as set	1351	Try to request the primary selection text from the server (for example, as
858	by the next method).	1352	set by the next method). No visual feedback will be given. This function
		1353	is mostly useful from within C<on_sel_grab> hooks.
859		1354
860	=item $oldtext = $term->selection ([$newtext])	1355	=item $oldtext = $term->selection ([$newtext])
861		1356
862	Return the current selection text and optionally replace it by C<$newtext>.	1357	Return the current selection text and optionally replace it by C<$newtext>.
863		1358
…		…
897		1392
898	The methods currently supported on C<urxvt::overlay> objects are:	1393	The methods currently supported on C<urxvt::overlay> objects are:
899		1394
900	=over 4	1395	=over 4
901		1396
902	=item $overlay->set ($x, $y, $text, $rend)	1397	=item $overlay->set ($x, $y, $text[, $rend])
903		1398
904	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1399	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
905	text in rxvt-unicode's special encoding and an array of rendition values	1400	text in rxvt-unicode's special encoding and an array of rendition values
906	at a specific position inside the overlay.	1401	at a specific position inside the overlay.
		1402
		1403	If C<$rend> is missing, then the rendition will not be changed.
907		1404
908	=item $overlay->hide	1405	=item $overlay->hide
909		1406
910	If visible, hide the overlay, but do not destroy it.	1407	If visible, hide the overlay, but do not destroy it.
911		1408
…		…
956	Convert the given locale-encoded octets into a perl string.	1453	Convert the given locale-encoded octets into a perl string.
957		1454
958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1455	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
959		1456
960	XORs the rendition values in the given span with the provided value	1457	XORs the rendition values in the given span with the provided value
961	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1458	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
962	to the selection.	1459	refresh hooks to provide effects similar to the selection.
963		1460
964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1461	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
965		1462
966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1463	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
967	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1464	whitespace will additionally be xored with the C<$rstyle2>, which defaults
968	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1465	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
969	it instead.	1466	it instead. Both styles I<MUST NOT> contain font styles.
970		1467
971	=item $term->scr_bell	1468	=item $term->scr_bell
972		1469
973	Ring the bell!	1470	Ring the bell!
974		1471
…		…
981		1478
982	Normally its not a good idea to use this function, as programs might be	1479	Normally its not a good idea to use this function, as programs might be
983	confused by changes in cursor position or scrolling. Its useful inside a	1480	confused by changes in cursor position or scrolling. Its useful inside a
984	C<on_add_lines> hook, though.	1481	C<on_add_lines> hook, though.
985		1482
		1483	=item $term->scr_change_screen ($screen)
		1484
		1485	Switch to given screen - 0 primary, 1 secondary.
		1486
986	=item $term->cmd_parse ($octets)	1487	=item $term->cmd_parse ($octets)
987		1488
988	Similar to C<scr_add_lines>, but the argument must be in the	1489	Similar to C<scr_add_lines>, but the argument must be in the
989	locale-specific encoding of the terminal and can contain command sequences	1490	locale-specific encoding of the terminal and can contain command sequences
990	(escape codes) that will be interpreted.	1491	(escape codes) that will be interpreted.
…		…
1000	Replaces the event mask of the pty watcher by the given event mask. Can	1501	Replaces the event mask of the pty watcher by the given event mask. Can
1001	be used to suppress input and output handling to the pty/tty. See the	1502	be used to suppress input and output handling to the pty/tty. See the
1002	description of C<< urxvt::timer->events >>. Make sure to always restore	1503	description of C<< urxvt::timer->events >>. Make sure to always restore
1003	the previous value.	1504	the previous value.
1004		1505
		1506	=item $fd = $term->pty_fd
		1507
		1508	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1509	is used.
		1510
1005	=item $windowid = $term->parent	1511	=item $windowid = $term->parent
1006		1512
1007	Return the window id of the toplevel window.	1513	Return the window id of the toplevel window.
1008		1514
1009	=item $windowid = $term->vt	1515	=item $windowid = $term->vt
1010		1516
1011	Return the window id of the terminal window.	1517	Return the window id of the terminal window.
1012		1518
		1519	=item $term->vt_emask_add ($x_event_mask)
		1520
		1521	Adds the specified events to the vt event mask. Useful e.g. when you want
		1522	to receive pointer events all the times:
		1523
		1524	$term->vt_emask_add (urxvt::PointerMotionMask);
		1525
		1526	=item $term->focus_in
		1527
		1528	=item $term->focus_out
		1529
		1530	=item $term->key_press ($state, $keycode[, $time])
		1531
		1532	=item $term->key_release ($state, $keycode[, $time])
		1533
		1534	Deliver various fake events to to terminal.
		1535
1013	=item $window_width = $term->width	1536	=item $window_width = $term->width
1014		1537
1015	=item $window_height = $term->height	1538	=item $window_height = $term->height
1016		1539
1017	=item $font_width = $term->fwidth	1540	=item $font_width = $term->fwidth
…		…
1030		1553
1031	=item $max_scrollback = $term->saveLines	1554	=item $max_scrollback = $term->saveLines
1032		1555
1033	=item $nrow_plus_saveLines = $term->total_rows	1556	=item $nrow_plus_saveLines = $term->total_rows
1034		1557
1035	=item $lines_in_scrollback = $term->nsaved	1558	=item $topmost_scrollback_row = $term->top_row
1036		1559
1037	Return various integers describing terminal characteristics.	1560	Return various integers describing terminal characteristics.
1038		1561
		1562	=item $x_display = $term->display_id
		1563
		1564	Return the DISPLAY used by rxvt-unicode.
		1565
1039	=item $lc_ctype = $term->locale	1566	=item $lc_ctype = $term->locale
1040		1567
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1568	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1569
1043	=item $x_display = $term->display_id	1570	=item $env = $term->env
1044		1571
1045	Return the DISPLAY used by rxvt-unicode.	1572	Returns a copy of the environment in effect for the terminal as a hashref
		1573	similar to C<\%ENV>.
		1574
		1575	=item @envv = $term->envv
		1576
		1577	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1578
		1579	=item @argv = $term->argv
		1580
		1581	Return the argument vector as this terminal, similar to @ARGV, but
		1582	includes the program name as first element.
		1583
		1584	=cut
		1585
		1586	sub env {
		1587	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1588	}
1046		1589
1047	=item $modifiermask = $term->ModLevel3Mask	1590	=item $modifiermask = $term->ModLevel3Mask
1048		1591
1049	=item $modifiermask = $term->ModMetaMask	1592	=item $modifiermask = $term->ModMetaMask
1050		1593
1051	=item $modifiermask = $term->ModNumLockMask	1594	=item $modifiermask = $term->ModNumLockMask
1052		1595
1053	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1596	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1054	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1597	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1055		1598
		1599	=item $screen = $term->current_screen
		1600
		1601	Returns the currently displayed screen (0 primary, 1 secondary).
		1602
		1603	=item $cursor_is_hidden = $term->hidden_cursor
		1604
		1605	Returns whether the cursor is currently hidden or not.
		1606
1056	=item $view_start = $term->view_start ([$newvalue])	1607	=item $view_start = $term->view_start ([$newvalue])
1057		1608
1058	Returns the negative row number of the topmost line. Minimum value is	1609	Returns the row number of the topmost displayed line. Maximum value is
1059	C<0>, which displays the normal terminal contents. Larger values scroll	1610	C<0>, which displays the normal terminal contents. Lower values scroll
1060	this many lines into the scrollback buffer.	1611	this many lines into the scrollback buffer.
1061		1612
1062	=item $term->want_refresh	1613	=item $term->want_refresh
1063		1614
1064	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1615	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1067		1618
1068	Used after changing terminal contents to display them.	1619	Used after changing terminal contents to display them.
1069		1620
1070	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1621	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1071		1622
1072	Returns the text of the entire row with number C<$row_number>. Row C<0>	1623	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1073	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1624	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1074	terminal line. The scrollback buffer starts at line C<-1> and extends to
1075	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1625	terminal line. Nothing will be returned if a nonexistent line
1076	is requested.	1626	is requested.
1077		1627
1078	If C<$new_text> is specified, it will replace characters in the current	1628	If C<$new_text> is specified, it will replace characters in the current
1079	line, starting at column C<$start_col> (default C<0>), which is useful	1629	line, starting at column C<$start_col> (default C<0>), which is useful
1080	to replace only parts of a line. The font index in the rendition will	1630	to replace only parts of a line. The font index in the rendition will
1081	automatically be updated.	1631	automatically be updated.
1082		1632
1083	C<$text> is in a special encoding: tabs and wide characters that use more	1633	C<$text> is in a special encoding: tabs and wide characters that use more
1084	than one cell when displayed are padded with urxvt::NOCHAR characters	1634	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1085	(C<chr 65535>). Characters with combining characters and other characters	1635	characters. Characters with combining characters and other characters that
1086	that do not fit into the normal tetx encoding will be replaced with	1636	do not fit into the normal text encoding will be replaced with characters
1087	characters in the private use area.	1637	in the private use area.
1088		1638
1089	You have to obey this encoding when changing text. The advantage is	1639	You have to obey this encoding when changing text. The advantage is
1090	that C<substr> and similar functions work on screen cells and not on	1640	that C<substr> and similar functions work on screen cells and not on
1091	characters.	1641	characters.
1092		1642
…		…
1143	Return the row number of the first/last row of the line, respectively.	1693	Return the row number of the first/last row of the line, respectively.
1144		1694
1145	=item $offset = $line->offset_of ($row, $col)	1695	=item $offset = $line->offset_of ($row, $col)
1146		1696
1147	Returns the character offset of the given row|col pair within the logical	1697	Returns the character offset of the given row|col pair within the logical
1148	line.	1698	line. Works for rows outside the line, too, and returns corresponding
		1699	offsets outside the string.
1149		1700
1150	=item ($row, $col) = $line->coord_of ($offset)	1701	=item ($row, $col) = $line->coord_of ($offset)
1151		1702
1152	Translates a string offset into terminal coordinates again.	1703	Translates a string offset into terminal coordinates again.
1153		1704
…		…
1235	where one character corresponds to one screen cell. See	1786	where one character corresponds to one screen cell. See
1236	C<< $term->ROW_t >> for details.	1787	C<< $term->ROW_t >> for details.
1237		1788
1238	=item $string = $term->special_decode $text	1789	=item $string = $term->special_decode $text
1239		1790
1240	Converts rxvt-unicodes text reprsentation into a perl string. See	1791	Converts rxvt-unicodes text representation into a perl string. See
1241	C<< $term->ROW_t >> for details.	1792	C<< $term->ROW_t >> for details.
1242		1793
1243	=item $success = $term->grab_button ($button, $modifiermask)	1794	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1244		1795
		1796	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1797
1245	Registers a synchronous button grab. See the XGrabButton manpage.	1798	Register/unregister a synchronous button grab. See the XGrabButton
		1799	manpage.
1246		1800
1247	=item $success = $term->grab ($eventtime[, $sync])	1801	=item $success = $term->grab ($eventtime[, $sync])
1248		1802
1249	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1803	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1250	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1804	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1251		1805
1252	=item $term->allow_events_async	1806	=item $term->allow_events_async
1253		1807
1254	Calls XAllowEvents with AsyncBoth for the most recent grab.	1808	Calls XAllowEvents with AsyncBoth for the most recent grab.
1255		1809
…		…
1266		1820
1267	Calls XUngrab for the most recent grab. Is called automatically on	1821	Calls XUngrab for the most recent grab. Is called automatically on
1268	evaluation errors, as it is better to lose the grab in the error case as	1822	evaluation errors, as it is better to lose the grab in the error case as
1269	the session.	1823	the session.
1270		1824
		1825	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1826
		1827	=item $atom_name = $term->XGetAtomName ($atom)
		1828
		1829	=item @atoms = $term->XListProperties ($window)
		1830
		1831	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1832
		1833	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1834
		1835	=item $term->XDeleteProperty ($window, $property)
		1836
		1837	=item $window = $term->DefaultRootWindow
		1838
		1839	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1840
		1841	=item $term->XMapWindow ($window)
		1842
		1843	=item $term->XUnmapWindow ($window)
		1844
		1845	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1846
		1847	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1848
		1849	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1850
		1851	Various X or X-related functions. The C<$term> object only serves as
		1852	the source of the display, otherwise those functions map more-or-less
		1853	directory onto the X functions of the same name.
		1854
1271	=back	1855	=back
1272		1856
1273	=cut	1857	=cut
1274		1858
1275	package urxvt::popup;	1859	package urxvt::popup;
…		…
1289		1873
1290	$item->{render} ||= sub { $_[0]{text} };	1874	$item->{render} ||= sub { $_[0]{text} };
1291		1875
1292	push @{ $self->{item} }, $item;	1876	push @{ $self->{item} }, $item;
1293	}	1877	}
		1878
		1879	=item $popup->add_title ($title)
		1880
		1881	Adds a non-clickable title to the popup.
		1882
		1883	=cut
		1884
		1885	sub add_title {
		1886	my ($self, $title) = @_;
		1887
		1888	$self->add_item ({
		1889	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1890	text => $title,
		1891	activate => sub { },
		1892	});
		1893	}
		1894
		1895	=item $popup->add_separator ([$sepchr])
		1896
		1897	Creates a separator, optionally using the character given as C<$sepchr>.
		1898
		1899	=cut
1294		1900
1295	sub add_separator {	1901	sub add_separator {
1296	my ($self, $sep) = @_;	1902	my ($self, $sep) = @_;
1297		1903
1298	$sep ||= "=";	1904	$sep ||= "=";
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1909	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1910	activate => sub { },
1305	});	1911	});
1306	}	1912	}
1307		1913
1308	sub add_title {	1914	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1915
1311	$self->add_item ({	1916	Adds a clickable button to the popup. C<$cb> is called whenever it is
1312	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1917	selected.
1313	text => $title,	1918
1314	activate => sub { },	1919	=cut
1315	});
1316	}
1317		1920
1318	sub add_button {	1921	sub add_button {
1319	my ($self, $text, $cb) = @_;	1922	my ($self, $text, $cb) = @_;
1320		1923
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1924	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	1925	}
1323		1926
		1927	=item $popup->add_toggle ($text, $initial_value, $cb)
		1928
		1929	Adds a toggle/checkbox item to the popup. The callback gets called
		1930	whenever it gets toggled, with a boolean indicating its new value as its
		1931	first argument.
		1932
		1933	=cut
		1934
1324	sub add_toggle {	1935	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	1936	my ($self, $text, $value, $cb) = @_;
1326		1937
1327	my $item; $item = {	1938	my $item; $item = {
1328	type => "button",	1939	type => "button",
1329	text => " $text",	1940	text => " $text",
1330	value => $value,	1941	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1942	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1943	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	1944	};
1334		1945
1335	$self->add_item ($item);	1946	$self->add_item ($item);
1336	}	1947	}
		1948
		1949	=item $popup->show
		1950
		1951	Displays the popup (which is initially hidden).
		1952
		1953	=cut
1337		1954
1338	sub show {	1955	sub show {
1339	my ($self) = @_;	1956	my ($self) = @_;
1340		1957
1341	local $urxvt::popup::self = $self;	1958	local $urxvt::popup::self = $self;
1342		1959
		1960	my $env = $self->{term}->env;
		1961	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1962	delete $env->{LC_ALL};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	1963	$env->{LC_CTYPE} = $self->{term}->locale;
1344		1964
1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1965	my $term = urxvt::term->new (
		1966	$env, "popup",
		1967	"--perl-lib" => "", "--perl-ext-common" => "",
		1968	"-pty-fd" => -1, "-sl" => 0,
		1969	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1346	"--transient-for" => $self->{term}->parent,	1970	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	1971	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	1972	"-pe" => "urxvt-popup",
1349	or die "unable to create popup window\n";	1973	) or die "unable to create popup window\n";
		1974
		1975	unless (delete $term->{urxvt_popup_init_done}) {
		1976	$term->ungrab;
		1977	$term->destroy;
		1978	die "unable to initialise popup window\n";
		1979	}
1350	}	1980	}
1351		1981
1352	sub DESTROY {	1982	sub DESTROY {
1353	my ($self) = @_;	1983	my ($self) = @_;
1354		1984
1355	delete $self->{term}{_destroy}{$self};	1985	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	1986	$self->{term}->ungrab;
1357	}	1987	}
		1988
		1989	=back
		1990
		1991	=cut
		1992
		1993	package urxvt::watcher;
1358		1994
1359	=head2 The C<urxvt::timer> Class	1995	=head2 The C<urxvt::timer> Class
1360		1996
1361	This class implements timer watchers/events. Time is represented as a	1997	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	1998	fractional number of seconds since the epoch. Example:
…		…
1366	->new	2002	->new
1367	->interval (1)	2003	->interval (1)
1368	->cb (sub {	2004	->cb (sub {
1369	$term->{overlay}->set (0, 0,	2005	$term->{overlay}->set (0, 0,
1370	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2006	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1371	});	2007	});
1372		2008
1373	=over 4	2009	=over 4
1374		2010
1375	=item $timer = new urxvt::timer	2011	=item $timer = new urxvt::timer
1376		2012
…		…
1400	Start the timer.	2036	Start the timer.
1401		2037
1402	=item $timer = $timer->start ($tstamp)	2038	=item $timer = $timer->start ($tstamp)
1403		2039
1404	Set the event trigger time to C<$tstamp> and start the timer.	2040	Set the event trigger time to C<$tstamp> and start the timer.
		2041
		2042	=item $timer = $timer->after ($delay)
		2043
		2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1405		2045
1406	=item $timer = $timer->stop	2046	=item $timer = $timer->stop
1407		2047
1408	Stop the timer.	2048	Stop the timer.
1409		2049
…		…
1415		2055
1416	$term->{socket} = ...	2056	$term->{socket} = ...
1417	$term->{iow} = urxvt::iow	2057	$term->{iow} = urxvt::iow
1418	->new	2058	->new
1419	->fd (fileno $term->{socket})	2059	->fd (fileno $term->{socket})
1420	->events (urxvt::EVENT_READ)	2060	->events (urxvt::EV_READ)
1421	->start	2061	->start
1422	->cb (sub {	2062	->cb (sub {
1423	my ($iow, $revents) = @_;	2063	my ($iow, $revents) = @_;
1424	# $revents must be 1 here, no need to check	2064	# $revents must be 1 here, no need to check
1425	sysread $term->{socket}, my $buf, 8192	2065	sysread $term->{socket}, my $buf, 8192
…		…
1438	Set the callback to be called when io events are triggered. C<$reventmask>	2078	Set the callback to be called when io events are triggered. C<$reventmask>
1439	is a bitset as described in the C<events> method.	2079	is a bitset as described in the C<events> method.
1440		2080
1441	=item $iow = $iow->fd ($fd)	2081	=item $iow = $iow->fd ($fd)
1442		2082
1443	Set the filedescriptor (not handle) to watch.	2083	Set the file descriptor (not handle) to watch.
1444		2084
1445	=item $iow = $iow->events ($eventmask)	2085	=item $iow = $iow->events ($eventmask)
1446		2086
1447	Set the event mask to watch. The only allowed values are	2087	Set the event mask to watch. The only allowed values are
1448	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2088	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1449	together, or C<urxvt::EVENT_NONE>.	2089	together, or C<urxvt::EV_NONE>.
1450		2090
1451	=item $iow = $iow->start	2091	=item $iow = $iow->start
1452		2092
1453	Start watching for requested events on the given handle.	2093	Start watching for requested events on the given handle.
1454		2094
1455	=item $iow = $iow->stop	2095	=item $iow = $iow->stop
1456		2096
1457	Stop watching for events on the given filehandle.	2097	Stop watching for events on the given file handle.
		2098
		2099	=back
		2100
		2101	=head2 The C<urxvt::iw> Class
		2102
		2103	This class implements idle watchers, that get called automatically when
		2104	the process is idle. They should return as fast as possible, after doing
		2105	some useful work.
		2106
		2107	=over 4
		2108
		2109	=item $iw = new urxvt::iw
		2110
		2111	Create a new idle watcher object in stopped state.
		2112
		2113	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2114
		2115	Set the callback to be called when the watcher triggers.
		2116
		2117	=item $timer = $timer->start
		2118
		2119	Start the watcher.
		2120
		2121	=item $timer = $timer->stop
		2122
		2123	Stop the watcher.
		2124
		2125	=back
		2126
		2127	=head2 The C<urxvt::pw> Class
		2128
		2129	This class implements process watchers. They create an event whenever a
		2130	process exits, after which they stop automatically.
		2131
		2132	my $pid = fork;
		2133	...
		2134	$term->{pw} = urxvt::pw
		2135	->new
		2136	->start ($pid)
		2137	->cb (sub {
		2138	my ($pw, $exit_status) = @_;
		2139	...
		2140	});
		2141
		2142	=over 4
		2143
		2144	=item $pw = new urxvt::pw
		2145
		2146	Create a new process watcher in stopped state.
		2147
		2148	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2149
		2150	Set the callback to be called when the timer triggers.
		2151
		2152	=item $pw = $timer->start ($pid)
		2153
		2154	Tells the watcher to start watching for process C<$pid>.
		2155
		2156	=item $pw = $pw->stop
		2157
		2158	Stop the watcher.
1458		2159
1459	=back	2160	=back
1460		2161
1461	=head1 ENVIRONMENT	2162	=head1 ENVIRONMENT
1462		2163
…		…
1469		2170
1470	=item == 0 - fatal messages	2171	=item == 0 - fatal messages
1471		2172
1472	=item >= 3 - script loading and management	2173	=item >= 3 - script loading and management
1473		2174
1474	=item >=10 - all events received	2175	=item >=10 - all called hooks
		2176
		2177	=item >=11 - hook return values
1475		2178
1476	=back	2179	=back
1477		2180
1478	=head1 AUTHOR	2181	=head1 AUTHOR
1479		2182
…		…
1481	http://software.schmorp.de/pkg/rxvt-unicode	2184	http://software.schmorp.de/pkg/rxvt-unicode
1482		2185
1483	=cut	2186	=cut
1484		2187
1485	1	2188	1
		2189
		2190	# vim: sw=3:

Diff Legend

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