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.91 by root, Fri Jan 13 01:09:37 2006 UTC vs.
Revision 1.200 by sf-exg, Sun Nov 20 10:58:58 2011 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	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. 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>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
58	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
59	...	66	...
60		67
61	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
64	between two vertical bars:	71	between two vertical bars:
65		72
66	URxvt.selection.pattern-0: \\|([^|]+)\\|	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: ^(/[^:]+):\
67		81
68	You can look at the source of the selection extension to see more	82	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
70		84
71	This extension also offers the following bindable keyboard command:	85	This extension also offers following bindable keyboard commands:
72		86
73	=over 4	87	=over 4
74		88
75	=item rot13	89	=item rot13
76		90
…		…
83	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
84		98
85	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
86	runtime.	100	runtime.
87		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
88	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
89		120
90	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
91	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	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	};
93		143
94	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
95		145
96	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
104	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
107	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
108		189
109	=item selection-autotransform	190	=item selection-autotransform
110		191
111	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	193	whenever a selection is made.
…		…
120		201
121	For example, the following will transform selections of the form	202	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename	203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:	204	$word>:
124		205
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		207
127	And this example matches the same,but replaces it with vi-commands you can	208	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:	209	paste directly into your (vi :) editor:
129		210
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		212
132	Of course, this can be modified to suit your needs and your editor :)	213	Of course, this can be modified to suit your needs and your editor :)
133		214
134	To expand the example above to typical perl error messages ("XXX at	215	To expand the example above to typical perl error messages ("XXX at
135	FILENAME line YYY."), you need a slightly more elaborate solution:	216	FILENAME line YYY."), you need a slightly more elaborate solution:
136		217
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139		220
140	The first line tells the selection code to treat the unchanging part of	221	The first line tells the selection code to treat the unchanging part of
141	every error message as a selection pattern, and the second line transforms	222	every error message as a selection pattern, and the second line transforms
142	the message into vi commands to load the file.	223	the message into vi commands to load the file.
143		224
144	=item mark-urls	225	=item tabbed
145		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
146	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
147	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
148	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
149	the URL as first argument.	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 or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
		266	"perl:matcher:list" as seen in the example below.
		267
		268	Example configuration:
		269
		270	URxvt.perl-ext: default,matcher
		271	URxvt.urlLauncher: sensible-browser
		272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
		274	URxvt.matcher.button: 1
		275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		277	URxvt.matcher.launcher.2: gvim +$2 $1
		278
		279	=item xim-onthespot
		280
		281	This (experimental) perl extension implements OnTheSpot editing. It does
		282	not work perfectly, and some input methods don't seem to work well with
		283	OnTheSpot editing in general, but it seems to work at least for SCIM and
		284	kinput2.
		285
		286	You enable it by specifying this extension and a preedit style of
		287	C<OnTheSpot>, i.e.:
		288
		289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		290
		291	=item kuake<hotkey>
		292
		293	A very primitive quake-console-like extension. It was inspired by a
		294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		295	user presses a global accelerator key (by default C<F10>), the terminal
		296	will show or hide itself. Another press of the accelerator key will hide
		297	or show it again.
		298
		299	Initially, the window will not be shown when using this extension.
		300
		301	This is useful if you need a single terminal that is not using any desktop
		302	space most of the time but is quickly available at the press of a key.
		303
		304	The accelerator key is grabbed regardless of any modifiers, so this
		305	extension will actually grab a physical key just for this function.
		306
		307	If you want a quake-like animation, tell your window manager to do so
		308	(fvwm can do it).
		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
150		315
151	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
152		317
153	A not very useful example of filtering all text output to the terminal,	318	A not very useful example of filtering all text output to the terminal
154	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
155	similar-looking ascii character.	320	similar-looking ascii character.
156		321
157	=item digital-clock	322	=item digital-clock
158		323
159	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
		325
		326	=item remote-clipboard
		327
		328	Somewhat of a misnomer, this extension adds two menu entries to the
		329	selection popup that allows one to run external commands to store the
		330	selection somewhere and fetch it again.
		331
		332	We use it to implement a "distributed selection mechanism", which just
		333	means that one command uploads the file to a remote server, and another
		334	reads it.
		335
		336	The commands can be set using the C<URxvt.remote-selection.store> and
		337	C<URxvt.remote-selection.fetch> resources. The first should read the
		338	selection to store from STDIN (always in UTF-8), the second should provide
		339	the selection data on STDOUT (also in UTF-8).
		340
		341	The defaults (which are likely useless to you) use rsh and cat:
		342
		343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		345
		346	=item selection-pastebin
		347
		348	This is a little rarely useful extension that uploads the selection as
		349	textfile to a remote site (or does other things). (The implementation is
		350	not currently secure for use in a multiuser environment as it writes to
		351	F</tmp> directly.).
		352
		353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		354	i.e.
		355
		356	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		357
		358	Pressing this combination runs a command with C<%> replaced by the name of
		359	the textfile. This command can be set via a resource:
		360
		361	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		362
		363	And the default is likely not useful to anybody but the few people around
		364	here :)
		365
		366	The name of the textfile is the hex encoded md5 sum of the selection, so
		367	the same content should lead to the same filename.
		368
		369	After a successful upload the selection will be replaced by the text given
		370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		371	for the filename):
		372
		373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		374
		375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		376	the double C</> characters as comment start. Use C<\057\057> instead,
		377	which works regardless of whether xrdb is used to parse the resource file
		378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
160		393
161	=item example-refresh-hooks	394	=item example-refresh-hooks
162		395
163	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
164	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
165	overlays or changes.	398	overlays or changes.
		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
166		412
167	=back	413	=back
168		414
169	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
170		416
…		…
186		432
187	=over 4	433	=over 4
188		434
189	=item $text	435	=item $text
190		436
191	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
192	always represents one screen cell. See L<ROW_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
193		439
194	=item $string	440	=item $string
195		441
196	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
204		450
205	=back	451	=back
206		452
207	=head2 Extension Objects	453	=head2 Extension Objects
208		454
209	Very perl extension is a perl class. A separate perl object is created	455	Every perl extension is a perl class. A separate perl object is created
210	for each terminal and each extension and passed as the first parameter to	456	for each terminal, and each terminal has its own set of extension objects,
211	hooks. So extensions can use their C<$self> object without having to think	457	which are passed as the first parameter to hooks. So extensions can use
212	about other extensions, with the exception of methods and members that	458	their C<$self> object without having to think about clashes with other
		459	extensions or other terminals, with the exception of methods and members
213	begin with an underscore character C<_>: these are reserved for internal	460	that begin with an underscore character C<_>: these are reserved for
214	use.	461	internal use.
215		462
216	Although it isn't a C<urxvt::term> object, you can call all methods of the	463	Although it isn't a C<urxvt::term> object, you can call all methods of the
217	C<urxvt::term> class on this object.	464	C<urxvt::term> class on this object.
218		465
219	It has the following methods and data members:	466	It has the following methods and data members:
…		…
240	=head2 Hooks	487	=head2 Hooks
241		488
242	The following subroutines can be declared in extension files, and will be	489	The following subroutines can be declared in extension files, and will be
243	called whenever the relevant event happens.	490	called whenever the relevant event happens.
244		491
245	The first argument passed to them is an extension oject as described in	492	The first argument passed to them is an extension object as described in
246	the in the C<Extension Objects> section.	493	the in the C<Extension Objects> section.
247		494
248	B<All> of these hooks must return a boolean value. If it is true, then the	495	B<All> of these hooks must return a boolean value. If any of the called
249	event counts as being I<consumed>, and the invocation of other hooks is	496	hooks returns true, then the event counts as being I<consumed>, and the
250	skipped, and the relevant action might not be carried out by the C++ code.	497	relevant action might not be carried out by the C++ code.
251		498
252	I<< When in doubt, return a false value (preferably C<()>). >>	499	I<< When in doubt, return a false value (preferably C<()>). >>
253		500
254	=over 4	501	=over 4
255		502
256	=item on_init $term	503	=item on_init $term
257		504
258	Called after a new terminal object has been initialized, but before	505	Called after a new terminal object has been initialized, but before
259	windows are created or the command gets run. Most methods are unsafe to	506	windows are created or the command gets run. Most methods are unsafe to
260	call or deliver senseless data, as terminal size and other characteristics	507	call or deliver senseless data, as terminal size and other characteristics
261	have not yet been determined. You can safely query and change resources,	508	have not yet been determined. You can safely query and change resources
262	though.	509	and options, though. For many purposes the C<on_start> hook is a better
		510	place.
		511
		512	=item on_start $term
		513
		514	Called at the very end of initialisation of a new terminal, just before
		515	trying to map (display) the toplevel and returning to the main loop.
		516
		517	=item on_destroy $term
		518
		519	Called whenever something tries to destroy terminal, when the terminal is
		520	still fully functional (not for long, though).
263		521
264	=item on_reset $term	522	=item on_reset $term
265		523
266	Called after the screen is "reset" for any reason, such as resizing or	524	Called after the screen is "reset" for any reason, such as resizing or
267	control sequences. Here is where you can react on changes to size-related	525	control sequences. Here is where you can react on changes to size-related
268	variables.	526	variables.
269		527
270	=item on_start $term	528	=item on_child_start $term, $pid
271		529
272	Called at the very end of initialisation of a new terminal, just before	530	Called just after the child process has been C<fork>ed.
273	returning to the mainloop.	531
		532	=item on_child_exit $term, $status
		533
		534	Called just after the child process has exited. C<$status> is the status
		535	from C<waitpid>.
274		536
275	=item on_sel_make $term, $eventtime	537	=item on_sel_make $term, $eventtime
276		538
277	Called whenever a selection has been made by the user, but before the	539	Called whenever a selection has been made by the user, but before the
278	selection text is copied, so changes to the beginning, end or type of the	540	selection text is copied, so changes to the beginning, end or type of the
…		…
285		547
286	Called whenever a selection has been copied, but before the selection is	548	Called whenever a selection has been copied, but before the selection is
287	requested from the server. The selection text can be queried and changed	549	requested from the server. The selection text can be queried and changed
288	by calling C<< $term->selection >>.	550	by calling C<< $term->selection >>.
289		551
290	Returning a true value aborts selection grabbing. It will still be hilighted.	552	Returning a true value aborts selection grabbing. It will still be highlighted.
291		553
292	=item on_sel_extend $term	554	=item on_sel_extend $term
293		555
294	Called whenever the user tries to extend the selection (e.g. with a double	556	Called whenever the user tries to extend the selection (e.g. with a double
295	click) and is either supposed to return false (normal operation), or	557	click) and is either supposed to return false (normal operation), or
296	should extend the selection itelf and return true to suppress the built-in	558	should extend the selection itself and return true to suppress the built-in
297	processing. This can happen multiple times, as long as the callback	559	processing. This can happen multiple times, as long as the callback
298	returns true, it will be called on every further click by the user and is	560	returns true, it will be called on every further click by the user and is
299	supposed to enlarge the selection more and more, if possible.	561	supposed to enlarge the selection more and more, if possible.
300		562
301	See the F<selection> example extension.	563	See the F<selection> example extension.
302		564
303	=item on_view_change $term, $offset	565	=item on_view_change $term, $offset
304		566
305	Called whenever the view offset changes, i..e the user or program	567	Called whenever the view offset changes, i.e. the user or program
306	scrolls. Offset C<0> means display the normal terminal, positive values	568	scrolls. Offset C<0> means display the normal terminal, positive values
307	show this many lines of scrollback.	569	show this many lines of scrollback.
308		570
309	=item on_scroll_back $term, $lines, $saved	571	=item on_scroll_back $term, $lines, $saved
310		572
…		…
314		576
315	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	577	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
316	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	578	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
317	number of lines that will be in the scrollback buffer.	579	number of lines that will be in the scrollback buffer.
318		580
319	=item on_osc_seq $term, $string	581	=item on_osc_seq $term, $op, $args, $resp
		582
		583	Called on every OSC sequence and can be used to suppress it or modify its
		584	behaviour. The default should be to return an empty list. A true value
		585	suppresses execution of the request completely. Make sure you don't get
		586	confused by recursive invocations when you output an OSC sequence within
		587	this callback.
		588
		589	C<on_osc_seq_perl> should be used for new behaviour.
		590
		591	=item on_osc_seq_perl $term, $args, $resp
320		592
321	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	593	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
322	operating system command) is processed. Cursor position and other state	594	operating system command) is processed. Cursor position and other state
323	information is up-to-date when this happens. For interoperability, the	595	information is up-to-date when this happens. For interoperability, the
324	string should start with the extension name and a colon, to distinguish	596	string should start with the extension name (sans -osc) and a semicolon,
325	it from commands for other extensions, and this might be enforced in the	597	to distinguish it from commands for other extensions, and this might be
326	future.	598	enforced in the future.
		599
		600	For example, C<overlay-osc> uses this:
		601
		602	sub on_osc_seq_perl {
		603	my ($self, $osc, $resp) = @_;
		604
		605	return unless $osc =~ s/^overlay;//;
		606
		607	... process remaining $osc string
		608	}
327		609
328	Be careful not ever to trust (in a security sense) the data you receive,	610	Be careful not ever to trust (in a security sense) the data you receive,
329	as its source can not easily be controleld (e-mail content, messages from	611	as its source can not easily be controlled (e-mail content, messages from
330	other users on the same system etc.).	612	other users on the same system etc.).
		613
		614	For responses, C<$resp> contains the end-of-args separator used by the
		615	sender.
331		616
332	=item on_add_lines $term, $string	617	=item on_add_lines $term, $string
333		618
334	Called whenever text is about to be output, with the text as argument. You	619	Called whenever text is about to be output, with the text as argument. You
335	can filter/change and output the text yourself by returning a true value	620	can filter/change and output the text yourself by returning a true value
…		…
340	=item on_tt_write $term, $octets	625	=item on_tt_write $term, $octets
341		626
342	Called whenever some data is written to the tty/pty and can be used to	627	Called whenever some data is written to the tty/pty and can be used to
343	suppress or filter tty input.	628	suppress or filter tty input.
344		629
		630	=item on_tt_paste $term, $octets
		631
		632	Called whenever text is about to be pasted, with the text as argument. You
		633	can filter/change and paste the text yourself by returning a true value
		634	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		635	locale-encoded.
		636
345	=item on_line_update $term, $row	637	=item on_line_update $term, $row
346		638
347	Called whenever a line was updated or changed. Can be used to filter	639	Called whenever a line was updated or changed. Can be used to filter
348	screen output (e.g. underline urls or other useless stuff). Only lines	640	screen output (e.g. underline urls or other useless stuff). Only lines
349	that are being shown will be filtered, and, due to performance reasons,	641	that are being shown will be filtered, and, due to performance reasons,
…		…
356	later with the already-modified line (e.g. if unrelated parts change), so	648	later with the already-modified line (e.g. if unrelated parts change), so
357	you cannot just toggle rendition bits, but only set them.	649	you cannot just toggle rendition bits, but only set them.
358		650
359	=item on_refresh_begin $term	651	=item on_refresh_begin $term
360		652
361	Called just before the screen gets redrawn. Can be used for overlay	653	Called just before the screen gets redrawn. Can be used for overlay or
362	or similar effects by modify terminal contents in refresh_begin, and	654	similar effects by modifying the terminal contents in refresh_begin, and
363	restoring them in refresh_end. The built-in overlay and selection display	655	restoring them in refresh_end. The built-in overlay and selection display
364	code is run after this hook, and takes precedence.	656	code is run after this hook, and takes precedence.
365		657
366	=item on_refresh_end $term	658	=item on_refresh_end $term
367		659
368	Called just after the screen gets redrawn. See C<on_refresh_begin>.	660	Called just after the screen gets redrawn. See C<on_refresh_begin>.
369		661
370	=item on_keyboard_command $term, $string	662	=item on_user_command $term, $string
371		663
372	Called whenever the user presses a key combination that has a	664	Called whenever a user-configured event is being activated (e.g. via
373	C<perl:string> action bound to it (see description of the B<keysym>	665	a C<perl:string> action bound to a key, see description of the B<keysym>
374	resource in the @@RXVT_NAME@@(1) manpage).	666	resource in the @@RXVT_NAME@@(1) manpage).
		667
		668	The event is simply the action string. This interface is assumed to change
		669	slightly in the future.
		670
		671	=item on_resize_all_windows $term, $new_width, $new_height
		672
		673	Called just after the new window size has been calculated, but before
		674	windows are actually being resized or hints are being set. If this hook
		675	returns TRUE, setting of the window hints is being skipped.
		676
		677	=item on_x_event $term, $event
		678
		679	Called on every X event received on the vt window (and possibly other
		680	windows). Should only be used as a last resort. Most event structure
		681	members are not passed.
		682
		683	=item on_root_event $term, $event
		684
		685	Like C<on_x_event>, but is called for events on the root window.
375		686
376	=item on_focus_in $term	687	=item on_focus_in $term
377		688
378	Called whenever the window gets the keyboard focus, before rxvt-unicode	689	Called whenever the window gets the keyboard focus, before rxvt-unicode
379	does focus in processing.	690	does focus in processing.
380		691
381	=item on_focus_out $term	692	=item on_focus_out $term
382		693
383	Called wheneever the window loses keyboard focus, before rxvt-unicode does	694	Called whenever the window loses keyboard focus, before rxvt-unicode does
384	focus out processing.	695	focus out processing.
385		696
		697	=item on_configure_notify $term, $event
		698
		699	=item on_property_notify $term, $event
		700
386	=item on_key_press $term, $event, $keysym, $octets	701	=item on_key_press $term, $event, $keysym, $octets
387		702
388	=item on_key_release $term, $event, $keysym	703	=item on_key_release $term, $event, $keysym
389		704
390	=item on_button_press $term, $event	705	=item on_button_press $term, $event
…		…
395		710
396	=item on_map_notify $term, $event	711	=item on_map_notify $term, $event
397		712
398	=item on_unmap_notify $term, $event	713	=item on_unmap_notify $term, $event
399		714
400	Called whenever the corresponding X event is received for the terminal If	715	Called whenever the corresponding X event is received for the terminal. If
401	the hook returns true, then the even will be ignored by rxvt-unicode.	716	the hook returns true, then the event will be ignored by rxvt-unicode.
402		717
403	The event is a hash with most values as named by Xlib (see the XEvent	718	The event is a hash with most values as named by Xlib (see the XEvent
404	manpage), with the additional members C<row> and C<col>, which are the row	719	manpage), with the additional members C<row> and C<col>, which are the
405	and column under the mouse cursor.	720	(real, not screen-based) row and column under the mouse cursor.
406		721
407	C<on_key_press> additionally receives the string rxvt-unicode would	722	C<on_key_press> additionally receives the string rxvt-unicode would
408	output, if any, in locale-specific encoding.	723	output, if any, in locale-specific encoding.
409		724
410	subwindow.	725	subwindow.
		726
		727	=item on_client_message $term, $event
		728
		729	=item on_wm_protocols $term, $event
		730
		731	=item on_wm_delete_window $term, $event
		732
		733	Called when various types of ClientMessage events are received (all with
		734	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		735
		736	=item on_bell $term
		737
		738	Called on receipt of a bell character.
411		739
412	=back	740	=back
413		741
414	=cut	742	=cut
415		743
…		…
421	use Scalar::Util ();	749	use Scalar::Util ();
422	use List::Util ();	750	use List::Util ();
423		751
424	our $VERSION = 1;	752	our $VERSION = 1;
425	our $TERM;	753	our $TERM;
		754	our @TERM_INIT;
		755	our @TERM_EXT;
426	our @HOOKNAME;	756	our @HOOKNAME;
427	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	757	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
428	our %OPTION;	758	our %OPTION;
429		759
430	our $LIBDIR;	760	our $LIBDIR;
431	our $RESNAME;	761	our $RESNAME;
432	our $RESCLASS;	762	our $RESCLASS;
433	our $RXVTNAME;	763	our $RXVTNAME;
434		764
		765	our $NOCHAR = chr 0xffff;
		766
435	=head2 Variables in the C<urxvt> Package	767	=head2 Variables in the C<urxvt> Package
436		768
437	=over 4	769	=over 4
438		770
439	=item $urxvt::LIBDIR	771	=item $urxvt::LIBDIR
…		…
452	=item $urxvt::TERM	784	=item $urxvt::TERM
453		785
454	The current terminal. This variable stores the current C<urxvt::term>	786	The current terminal. This variable stores the current C<urxvt::term>
455	object, whenever a callback/hook is executing.	787	object, whenever a callback/hook is executing.
456		788
		789	=item @urxvt::TERM_INIT
		790
		791	All code references in this array will be called as methods of the next newly
		792	created C<urxvt::term> object (during the C<on_init> phase). The array
		793	gets cleared before the code references that were in it are being executed,
		794	so references can push themselves onto it again if they so desire.
		795
		796	This complements to the perl-eval command line option, but gets executed
		797	first.
		798
		799	=item @urxvt::TERM_EXT
		800
		801	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		802	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		803	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		804
457	=back	805	=back
458		806
459	=head2 Functions in the C<urxvt> Package	807	=head2 Functions in the C<urxvt> Package
460		808
461	=over 4	809	=over 4
462		810
463	=item urxvt::fatal $errormessage	811	=item urxvt::fatal $errormessage
464		812
465	Fatally aborts execution with the given error message. Avoid at all	813	Fatally aborts execution with the given error message (which should
466	costs! The only time this is acceptable is when the terminal process	814	include a trailing newline). Avoid at all costs! The only time this
467	starts up.	815	is acceptable (and useful) is in the init hook, where it prevents the
		816	terminal from starting up.
468		817
469	=item urxvt::warn $string	818	=item urxvt::warn $string
470		819
471	Calls C<rxvt_warn> with the given string which should not include a	820	Calls C<rxvt_warn> with the given string which should include a trailing
472	newline. The module also overwrites the C<warn> builtin with a function	821	newline. The module also overwrites the C<warn> builtin with a function
473	that calls this function.	822	that calls this function.
474		823
475	Using this function has the advantage that its output ends up in the	824	Using this function has the advantage that its output ends up in the
476	correct place, e.g. on stderr of the connecting urxvtc client.	825	correct place, e.g. on stderr of the connecting urxvtc client.
477		826
478	Messages have a size limit of 1023 bytes currently.	827	Messages have a size limit of 1023 bytes currently.
479		828
480	=item $is_safe = urxvt::safe	829	=item @terms = urxvt::termlist
481		830
482	Returns true when it is safe to do potentially unsafe things, such as	831	Returns all urxvt::term objects that exist in this process, regardless of
483	evaluating perl code specified by the user. This is true when urxvt was	832	whether they are started, being destroyed etc., so be careful. Only term
484	started setuid or setgid.	833	objects that have perl extensions attached will be returned (because there
		834	is no urxvt::term object associated with others).
485		835
486	=item $time = urxvt::NOW	836	=item $time = urxvt::NOW
487		837
488	Returns the "current time" (as per the event loop).	838	Returns the "current time" (as per the event loop).
489		839
490	=item urxvt::CurrentTime	840	=item urxvt::CurrentTime
491		841
492	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	842	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
493	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	843	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
494	Button4Mask, Button5Mask, AnyModifier	844	Button4Mask, Button5Mask, AnyModifier
		845
		846	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		847	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		848	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		849	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		850	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		851	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		852	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		853
		854	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		855	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		856	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		857	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		858	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		859	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		860	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
495		861
496	Various constants for use in X calls and event processing.	862	Various constants for use in X calls and event processing.
497		863
498	=back	864	=back
499		865
…		…
516		882
517	=item $rend = urxvt::OVERLAY_RSTYLE	883	=item $rend = urxvt::OVERLAY_RSTYLE
518		884
519	Return the rendition mask used for overlays by default.	885	Return the rendition mask used for overlays by default.
520		886
521	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	887	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		888	urxvt::RS_RVid, urxvt::RS_Uline
522		889
523	Return the bit that enabled bold, italic, blink, reverse-video and	890	Return the bit that enabled bold, italic, blink, reverse-video and
524	underline, respectively. To enable such a style, just logically OR it into	891	underline, respectively. To enable such a style, just logically OR it into
525	the bitset.	892	the bitset.
526		893
…		…
532		899
533	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	900	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
534		901
535	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	902	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
536		903
		904	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		905
537	Replace the foreground/background colour in the rendition mask with the	906	Replace the foreground/background colour in the rendition mask with the
538	specified one.	907	specified one.
539		908
540	=item $value = urxvt::GET_CUSTOM $rend	909	=item $value = urxvt::GET_CUSTOM $rend
541		910
…		…
550	=back	919	=back
551		920
552	=cut	921	=cut
553		922
554	BEGIN {	923	BEGIN {
555	urxvt->bootstrap;
556
557	# overwrite perl's warn	924	# overwrite perl's warn
558	*CORE::GLOBAL::warn = sub {	925	*CORE::GLOBAL::warn = sub {
559	my $msg = join "", @_;	926	my $msg = join "", @_;
560	$msg .= "\n"	927	$msg .= "\n"
561	unless $msg =~ /\n$/;	928	unless $msg =~ /\n$/;
562	urxvt::warn ($msg);	929	urxvt::warn ($msg);
563	};	930	};
564
565	# %ENV is the original startup environment
566	delete $ENV{IFS};
567	delete $ENV{CDPATH};
568	delete $ENV{BASH_ENV};
569	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
570	}	931	}
571		932
572	my @hook_count;	933	no warnings 'utf8';
		934
573	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	935	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
574		936
575	sub verbose {	937	sub verbose {
576	my ($level, $msg) = @_;	938	my ($level, $msg) = @_;
577	warn "$msg\n" if $level <= $verbosity;	939	warn "$msg\n" if $level <= $verbosity;
578	}	940	}
579		941
580	my $extension_pkg = "extension0000";
581	my %extension_pkg;	942	my %extension_pkg;
582		943
583	# load a single script into its own package, once only	944	# load a single script into its own package, once only
584	sub extension_package($) {	945	sub extension_package($) {
585	my ($path) = @_;	946	my ($path) = @_;
586		947
587	$extension_pkg{$path} ||= do {	948	$extension_pkg{$path} ||= do {
588	my $pkg = "urxvt::" . ($extension_pkg++);	949	$path =~ /([^\/\\]+)$/;
		950	my $pkg = $1;
		951	$pkg =~ s/[^[:word:]]/_/g;
		952	$pkg = "urxvt::ext::$pkg";
589		953
590	verbose 3, "loading extension '$path' into package '$pkg'";	954	verbose 3, "loading extension '$path' into package '$pkg'";
591		955
592	open my $fh, "<:raw", $path	956	open my $fh, "<:raw", $path
593	or die "$path: $!";	957	or die "$path: $!";
594		958
595	my $source = untaint	959	my $source =
596	"package $pkg; use strict; use utf8;\n"	960	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
597	. "use base urxvt::term::extension::;\n"
598	. "#line 1 \"$path\"\n{\n"	961	. "#line 1 \"$path\"\n{\n"
599	. (do { local $/; <$fh> })	962	. (do { local $/; <$fh> })
600	. "\n};\n1";	963	. "\n};\n1";
601		964
602	eval $source	965	eval $source
…		…
612	sub invoke {	975	sub invoke {
613	local $TERM = shift;	976	local $TERM = shift;
614	my $htype = shift;	977	my $htype = shift;
615		978
616	if ($htype == 0) { # INIT	979	if ($htype == 0) { # INIT
617	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	980	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
618		981
619	my %ext_arg;	982	my %ext_arg;
620		983
		984	{
		985	my @init = @TERM_INIT;
		986	@TERM_INIT = ();
		987	$_->($TERM) for @init;
		988	my @pkg = @TERM_EXT;
		989	@TERM_EXT = ();
		990	$TERM->register_package ($_) for @pkg;
		991	}
		992
621	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	993	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
622	if ($_ eq "default") {	994	if ($_ eq "default") {
623	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	995	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
624	} elsif (/^-(.*)$/) {	996	} elsif (/^-(.*)$/) {
625	delete $ext_arg{$1};	997	delete $ext_arg{$1};
626	} elsif (/^([^<]+)<(.*)>$/) {	998	} elsif (/^([^<]+)<(.*)>$/) {
627	push @{ $ext_arg{$1} }, $2;	999	push @{ $ext_arg{$1} }, $2;
628	} else {	1000	} else {
629	$ext_arg{$_} ||= [];	1001	$ext_arg{$_} ||= [];
630	}	1002	}
631	}	1003	}
632		1004
633	while (my ($ext, $argv) = each %ext_arg) {	1005	for my $ext (sort keys %ext_arg) {
634	my @files = grep -f $_, map "$_/$ext", @dirs;	1006	my @files = grep -f $_, map "$_/$ext", @dirs;
635		1007
636	if (@files) {	1008	if (@files) {
637	$TERM->register_package (extension_package $files[0], $argv);	1009	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
638	} else {	1010	} else {
639	warn "perl extension '$ext' not found in perl library search path\n";	1011	warn "perl extension '$ext' not found in perl library search path\n";
640	}	1012	}
641	}	1013	}
642		1014
…		…
648		1020
649	if (my $cb = $TERM->{_hook}[$htype]) {	1021	if (my $cb = $TERM->{_hook}[$htype]) {
650	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1022	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
651	if $verbosity >= 10;	1023	if $verbosity >= 10;
652		1024
653	keys %$cb;	1025	for my $pkg (keys %$cb) {
654
655	while (my ($pkg, $cb) = each %$cb) {
656	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1026	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
657	and last;	1027	$retval ||= $retval_;
658		1028
659	if ($@) {	1029	if ($@) {
660	$TERM->ungrab; # better to lose the grab than the session	1030	$TERM->ungrab; # better to lose the grab than the session
661	warn $@;	1031	warn $@;
662	}	1032	}
…		…
665	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	1035	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
666	if $verbosity >= 11;	1036	if $verbosity >= 11;
667	}	1037	}
668		1038
669	if ($htype == 1) { # DESTROY	1039	if ($htype == 1) { # DESTROY
670	if (my $hook = delete $TERM->{_hook}) {
671	for my $htype (0..$#$hook) {
672	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
673	or set_should_invoke $htype, 0;
674	}
675	}
676
677	# clear package objects	1040	# clear package objects
678	%$_ = () for values %{ $TERM->{_pkg} };	1041	%$_ = () for values %{ $TERM->{_pkg} };
679		1042
680	# clear package	1043	# clear package
681	%$TERM = ();	1044	%$TERM = ();
682	}	1045	}
683		1046
684	$retval	1047	$retval
685	}	1048	}
686		1049
687	sub exec_async(@) {	1050	sub SET_COLOR($$$) {
688	my $pid = fork;	1051	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1052	}
689		1053
690	return	1054	sub rend2mask {
691	if !defined $pid or $pid;	1055	no strict 'refs';
692		1056	my ($str, $mask) = (@_, 0);
693	%ENV = %{ $TERM->env };	1057	my %color = ( fg => undef, bg => undef );
694		1058	my @failed;
695	exec @_;	1059	for my $spec ( split /\s+/, $str ) {
696	_exit 255;	1060	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1061	$color{lc($1)} = $2;
		1062	} else {
		1063	my $neg = $spec =~ s/^[-^]//;
		1064	unless ( exists &{"RS_$spec"} ) {
		1065	push @failed, $spec;
		1066	next;
		1067	}
		1068	my $cur = &{"RS_$spec"};
		1069	if ( $neg ) {
		1070	$mask &= ~$cur;
		1071	} else {
		1072	$mask |= $cur;
		1073	}
		1074	}
		1075	}
		1076	($mask, @color{qw(fg bg)}, \@failed)
697	}	1077	}
698		1078
699	# urxvt::term::extension	1079	# urxvt::term::extension
700		1080
701	package urxvt::term::extension;	1081	package urxvt::term::extension;
…		…
707	while (my ($name, $cb) = each %hook) {	1087	while (my ($name, $cb) = each %hook) {
708	my $htype = $HOOKTYPE{uc $name};	1088	my $htype = $HOOKTYPE{uc $name};
709	defined $htype	1089	defined $htype
710	or Carp::croak "unsupported hook type '$name'";	1090	or Carp::croak "unsupported hook type '$name'";
711		1091
		1092	$self->set_should_invoke ($htype, +1)
712	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1093	unless exists $self->{term}{_hook}[$htype]{$pkg};
713	$hook_count[$htype]++
714	or urxvt::set_should_invoke $htype, 1;
715	}
716		1094
717	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1095	$self->{term}{_hook}[$htype]{$pkg} = $cb;
718	}	1096	}
719	}	1097	}
720		1098
…		…
725	for my $name (@hook) {	1103	for my $name (@hook) {
726	my $htype = $HOOKTYPE{uc $name};	1104	my $htype = $HOOKTYPE{uc $name};
727	defined $htype	1105	defined $htype
728	or Carp::croak "unsupported hook type '$name'";	1106	or Carp::croak "unsupported hook type '$name'";
729		1107
		1108	$self->set_should_invoke ($htype, -1)
730	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1109	if delete $self->{term}{_hook}[$htype]{$pkg};
731	--$hook_count[$htype]
732	or urxvt::set_should_invoke $htype, 0;
733	}
734	}	1110	}
735	}	1111	}
736		1112
737	our $AUTOLOAD;	1113	our $AUTOLOAD;
738		1114
…		…
776	is that you cannot use blocking APIs, but the non-blocking variant should	1152	is that you cannot use blocking APIs, but the non-blocking variant should
777	work.	1153	work.
778		1154
779	=cut	1155	=cut
780		1156
781	our $VERSION = 1;	1157	our $VERSION = '5.23';
782		1158
783	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1159	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
784	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1160	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
785		1161
786	sub timer {	1162	sub timer {
…		…
788		1164
789	my $cb = $arg{cb};	1165	my $cb = $arg{cb};
790		1166
791	urxvt::timer	1167	urxvt::timer
792	->new	1168	->new
793	->start (urxvt::NOW + $arg{after})	1169	->after ($arg{after}, $arg{interval})
794	->cb (sub {	1170	->cb ($arg{interval} ? $cb : sub {
795	$_[0]->stop; # need to cancel manually	1171	$_[0]->stop; # need to cancel manually
796	$cb->();	1172	$cb->();
797	})	1173	})
798	}	1174	}
799		1175
800	sub io {	1176	sub io {
801	my ($class, %arg) = @_;	1177	my ($class, %arg) = @_;
802		1178
803	my $cb = $arg{cb};	1179	my $cb = $arg{cb};
		1180	my $fd = fileno $arg{fh};
		1181	defined $fd or $fd = $arg{fh};
804		1182
805	bless [$arg{fh}, urxvt::iow	1183	bless [$arg{fh}, urxvt::iow
806	->new	1184	->new
807	->fd (fileno $arg{fh})	1185	->fd ($fd)
808	->events (($arg{poll} =~ /r/ ? 1 : 0)	1186	->events (($arg{poll} =~ /r/ ? 1 : 0)
809	| ($arg{poll} =~ /w/ ? 2 : 0))	1187	| ($arg{poll} =~ /w/ ? 2 : 0))
810	->start	1188	->start
811	->cb (sub {	1189	->cb ($cb)
812	$cb->(($_[1] & 1 ? 'r' : '')
813	. ($_[1] & 2 ? 'w' : ''));
814	})],
815	urxvt::anyevent::	1190	], urxvt::anyevent::
		1191	}
		1192
		1193	sub idle {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::iw
		1199	->new
		1200	->start
		1201	->cb ($cb)
		1202	}
		1203
		1204	sub child {
		1205	my ($class, %arg) = @_;
		1206
		1207	my $cb = $arg{cb};
		1208
		1209	urxvt::pw
		1210	->new
		1211	->start ($arg{pid})
		1212	->cb (sub {
		1213	$_[0]->stop; # need to cancel manually
		1214	$cb->($_[0]->rpid, $_[0]->rstatus);
		1215	})
816	}	1216	}
817		1217
818	sub DESTROY {	1218	sub DESTROY {
819	$_[0][1]->stop;	1219	$_[0][1]->stop;
820	}	1220	}
821		1221
822	sub condvar {	1222	# only needed for AnyEvent < 6 compatibility
823	bless \my $flag, urxvt::anyevent::condvar::	1223	sub one_event {
824	}
825
826	sub urxvt::anyevent::condvar::broadcast {
827	${$_[0]}++;
828	}
829
830	sub urxvt::anyevent::condvar::wait {
831	unless (${$_[0]}) {
832	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1224	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
833	}
834	}	1225	}
835		1226
836	package urxvt::term;	1227	package urxvt::term;
837		1228
838	=head2 The C<urxvt::term> Class	1229	=head2 The C<urxvt::term> Class
…		…
843		1234
844	# find on_xxx subs in the package and register them	1235	# find on_xxx subs in the package and register them
845	# as hooks	1236	# as hooks
846	sub register_package {	1237	sub register_package {
847	my ($self, $pkg, $argv) = @_;	1238	my ($self, $pkg, $argv) = @_;
		1239
		1240	no strict 'refs';
		1241
		1242	urxvt::verbose 6, "register package $pkg to $self";
		1243
		1244	@{"$pkg\::ISA"} = urxvt::term::extension::;
848		1245
849	my $proxy = bless {	1246	my $proxy = bless {
850	_pkg => $pkg,	1247	_pkg => $pkg,
851	argv => $argv,	1248	argv => $argv,
852	}, $pkg;	1249	}, $pkg;
…		…
868	hash which defines the environment of the new terminal.	1265	hash which defines the environment of the new terminal.
869		1266
870	Croaks (and probably outputs an error message) if the new instance	1267	Croaks (and probably outputs an error message) if the new instance
871	couldn't be created. Returns C<undef> if the new instance didn't	1268	couldn't be created. Returns C<undef> if the new instance didn't
872	initialise perl, and the terminal object otherwise. The C<init> and	1269	initialise perl, and the terminal object otherwise. The C<init> and
873	C<start> hooks will be called during this call.	1270	C<start> hooks will be called before this call returns, and are free to
		1271	refer to global data (which is race free).
874		1272
875	=cut	1273	=cut
876		1274
877	sub new {	1275	sub new {
878	my ($class, $env, @args) = @_;	1276	my ($class, $env, @args) = @_;
879		1277
		1278	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1279	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1280
880	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1281	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
881	}	1282	}
882		1283
883	=item $term->destroy	1284	=item $term->destroy
884		1285
885	Destroy the terminal object (close the window, free resources	1286	Destroy the terminal object (close the window, free resources
886	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1287	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
887	watchers (timers, io watchers) are still active.	1288	watchers (timers, io watchers) are still active.
888		1289
		1290	=item $term->exec_async ($cmd[, @args])
		1291
		1292	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1293	("starts") programs in the background. This function takes care of setting
		1294	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1295	be preferred over explicit calls to C<exec> or C<system>.
		1296
		1297	Returns the pid of the subprocess or C<undef> on error.
		1298
		1299	=cut
		1300
		1301	sub exec_async {
		1302	my $self = shift;
		1303
		1304	my $pid = fork;
		1305
		1306	return $pid
		1307	if !defined $pid or $pid;
		1308
		1309	%ENV = %{ $self->env };
		1310
		1311	exec @_;
		1312	urxvt::_exit 255;
		1313	}
		1314
889	=item $isset = $term->option ($optval[, $set])	1315	=item $isset = $term->option ($optval[, $set])
890		1316
891	Returns true if the option specified by C<$optval> is enabled, and	1317	Returns true if the option specified by C<$optval> is enabled, and
892	optionally change it. All option values are stored by name in the hash	1318	optionally change it. All option values are stored by name in the hash
893	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1319	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
894		1320
895	Here is a a likely non-exhaustive list of option names, please see the	1321	Here is a likely non-exhaustive list of option names, please see the
896	source file F</src/optinc.h> to see the actual list:	1322	source file F</src/optinc.h> to see the actual list:
897		1323
898	borderLess console cursorBlink cursorUnderline hold iconic insecure	1324	borderLess buffered console cursorBlink cursorUnderline hold iconic
899	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1325	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1326	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
900	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1327	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
901	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1328	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
902	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1329	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
903	tripleclickwords utmpInhibit visualBell	1330	urgentOnBell utmpInhibit visualBell
904		1331
905	=item $value = $term->resource ($name[, $newval])	1332	=item $value = $term->resource ($name[, $newval])
906		1333
907	Returns the current resource value associated with a given name and	1334	Returns the current resource value associated with a given name and
908	optionally sets a new value. Setting values is most useful in the C<init>	1335	optionally sets a new value. Setting values is most useful in the C<init>
…		…
917	likely change).	1344	likely change).
918		1345
919	Please note that resource strings will currently only be freed when the	1346	Please note that resource strings will currently only be freed when the
920	terminal is destroyed, so changing options frequently will eat memory.	1347	terminal is destroyed, so changing options frequently will eat memory.
921		1348
922	Here is a a likely non-exhaustive list of resource names, not all of which	1349	Here is a likely non-exhaustive list of resource names, not all of which
923	are supported in every build, please see the source file F</src/rsinc.h>	1350	are supported in every build, please see the source file F</src/rsinc.h>
924	to see the actual list:	1351	to see the actual list:
925		1352
926	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1353	answerbackstring backgroundPixmap backspace_key blendtype blurradius
927	borderLess color cursorBlink cursorUnderline cutchars delete_key	1354	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
928	display_name embed ext_bwidth fade font geometry hold iconName	1355	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
929	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1356	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1357	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
930	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1358	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
931	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1359	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
932	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1360	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
933	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1361	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
934	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1362	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
935	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1363	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
936	shade term_name title transparent transparent_all tripleclickwords	1364	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1365	term_name title transient_for transparent tripleclickwords urgentOnBell
937	utmpInhibit visualBell	1366	utmpInhibit visualBell
938		1367
939	=cut	1368	=cut
940		1369
941	sub resource($$;$) {	1370	sub resource($$;$) {
942	my ($self, $name) = (shift, shift);	1371	my ($self, $name) = (shift, shift);
943	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1372	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
944	&urxvt::term::_resource	1373	goto &urxvt::term::_resource
945	}	1374	}
946		1375
947	=item $value = $term->x_resource ($pattern)	1376	=item $value = $term->x_resource ($pattern)
948		1377
949	Returns the X-Resource for the given pattern, excluding the program or	1378	Returns the X-Resource for the given pattern, excluding the program or
…		…
974		1403
975	=item ($row, $col) = $term->selection_beg ([$row, $col])	1404	=item ($row, $col) = $term->selection_beg ([$row, $col])
976		1405
977	=item ($row, $col) = $term->selection_end ([$row, $col])	1406	=item ($row, $col) = $term->selection_end ([$row, $col])
978		1407
979	Return the current values of the selection mark, begin or end positions,	1408	Return the current values of the selection mark, begin or end positions.
980	and optionally set them to new values.	1409
		1410	When arguments are given, then the selection coordinates are set to
		1411	C<$row> and C<$col>, and the selection screen is set to the current
		1412	screen.
		1413
		1414	=item $screen = $term->selection_screen ([$screen])
		1415
		1416	Returns the current selection screen, and then optionally sets it.
981		1417
982	=item $term->selection_make ($eventtime[, $rectangular])	1418	=item $term->selection_make ($eventtime[, $rectangular])
983		1419
984	Tries to make a selection as set by C<selection_beg> and	1420	Tries to make a selection as set by C<selection_beg> and
985	C<selection_end>. If C<$rectangular> is true (default: false), a	1421	C<selection_end>. If C<$rectangular> is true (default: false), a
986	rectangular selection will be made. This is the prefered function to make	1422	rectangular selection will be made. This is the preferred function to make
987	a selection.	1423	a selection.
988		1424
989	=item $success = $term->selection_grab ($eventtime)	1425	=item $success = $term->selection_grab ($eventtime[, $clipboard])
990		1426
991	Try to request the primary selection text from the server (for example, as	1427	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1428	true) selection from the server. The corresponding text can be set
992	set by the next method). No visual feedback will be given. This function	1429	with the next method. No visual feedback will be given. This function
993	is mostly useful from within C<on_sel_grab> hooks.	1430	is mostly useful from within C<on_sel_grab> hooks.
994		1431
995	=item $oldtext = $term->selection ([$newtext])	1432	=item $oldtext = $term->selection ([$newtext, $clipboard])
996		1433
997	Return the current selection text and optionally replace it by C<$newtext>.	1434	Return the current selection (clipboard if C<$clipboard> is true) text
		1435	and optionally replace it by C<$newtext>.
		1436
		1437	=item $term->selection_clear ([$clipboard])
		1438
		1439	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
998		1440
999	=item $term->overlay_simple ($x, $y, $text)	1441	=item $term->overlay_simple ($x, $y, $text)
1000		1442
1001	Create a simple multi-line overlay box. See the next method for details.	1443	Create a simple multi-line overlay box. See the next method for details.
1002		1444
…		…
1032		1474
1033	The methods currently supported on C<urxvt::overlay> objects are:	1475	The methods currently supported on C<urxvt::overlay> objects are:
1034		1476
1035	=over 4	1477	=over 4
1036		1478
1037	=item $overlay->set ($x, $y, $text, $rend)	1479	=item $overlay->set ($x, $y, $text[, $rend])
1038		1480
1039	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1481	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1040	text in rxvt-unicode's special encoding and an array of rendition values	1482	text in rxvt-unicode's special encoding and an array of rendition values
1041	at a specific position inside the overlay.	1483	at a specific position inside the overlay.
		1484
		1485	If C<$rend> is missing, then the rendition will not be changed.
1042		1486
1043	=item $overlay->hide	1487	=item $overlay->hide
1044		1488
1045	If visible, hide the overlay, but do not destroy it.	1489	If visible, hide the overlay, but do not destroy it.
1046		1490
…		…
1116		1560
1117	Normally its not a good idea to use this function, as programs might be	1561	Normally its not a good idea to use this function, as programs might be
1118	confused by changes in cursor position or scrolling. Its useful inside a	1562	confused by changes in cursor position or scrolling. Its useful inside a
1119	C<on_add_lines> hook, though.	1563	C<on_add_lines> hook, though.
1120		1564
		1565	=item $term->scr_change_screen ($screen)
		1566
		1567	Switch to given screen - 0 primary, 1 secondary.
		1568
1121	=item $term->cmd_parse ($octets)	1569	=item $term->cmd_parse ($octets)
1122		1570
1123	Similar to C<scr_add_lines>, but the argument must be in the	1571	Similar to C<scr_add_lines>, but the argument must be in the
1124	locale-specific encoding of the terminal and can contain command sequences	1572	locale-specific encoding of the terminal and can contain command sequences
1125	(escape codes) that will be interpreted.	1573	(escape codes) that will be interpreted.
1126		1574
1127	=item $term->tt_write ($octets)	1575	=item $term->tt_write ($octets)
1128		1576
1129	Write the octets given in C<$data> to the tty (i.e. as program input). To	1577	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1130	pass characters instead of octets, you should convert your strings first	1578	pass characters instead of octets, you should convert your strings first
1131	to the locale-specific encoding using C<< $term->locale_encode >>.	1579	to the locale-specific encoding using C<< $term->locale_encode >>.
		1580
		1581	=item $term->tt_paste ($octets)
		1582
		1583	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1584	CR and bracketing the data with control sequences if bracketed paste mode
		1585	is set.
1132		1586
1133	=item $old_events = $term->pty_ev_events ([$new_events])	1587	=item $old_events = $term->pty_ev_events ([$new_events])
1134		1588
1135	Replaces the event mask of the pty watcher by the given event mask. Can	1589	Replaces the event mask of the pty watcher by the given event mask. Can
1136	be used to suppress input and output handling to the pty/tty. See the	1590	be used to suppress input and output handling to the pty/tty. See the
1137	description of C<< urxvt::timer->events >>. Make sure to always restore	1591	description of C<< urxvt::timer->events >>. Make sure to always restore
1138	the previous value.	1592	the previous value.
1139		1593
		1594	=item $fd = $term->pty_fd
		1595
		1596	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1597	is used.
		1598
1140	=item $windowid = $term->parent	1599	=item $windowid = $term->parent
1141		1600
1142	Return the window id of the toplevel window.	1601	Return the window id of the toplevel window.
1143		1602
1144	=item $windowid = $term->vt	1603	=item $windowid = $term->vt
1145		1604
1146	Return the window id of the terminal window.	1605	Return the window id of the terminal window.
1147		1606
		1607	=item $term->vt_emask_add ($x_event_mask)
		1608
		1609	Adds the specified events to the vt event mask. Useful e.g. when you want
		1610	to receive pointer events all the times:
		1611
		1612	$term->vt_emask_add (urxvt::PointerMotionMask);
		1613
		1614	=item $term->focus_in
		1615
		1616	=item $term->focus_out
		1617
		1618	=item $term->key_press ($state, $keycode[, $time])
		1619
		1620	=item $term->key_release ($state, $keycode[, $time])
		1621
		1622	Deliver various fake events to to terminal.
		1623
1148	=item $window_width = $term->width	1624	=item $window_width = $term->width
1149		1625
1150	=item $window_height = $term->height	1626	=item $window_height = $term->height
1151		1627
1152	=item $font_width = $term->fwidth	1628	=item $font_width = $term->fwidth
…		…
1165		1641
1166	=item $max_scrollback = $term->saveLines	1642	=item $max_scrollback = $term->saveLines
1167		1643
1168	=item $nrow_plus_saveLines = $term->total_rows	1644	=item $nrow_plus_saveLines = $term->total_rows
1169		1645
1170	=item $lines_in_scrollback = $term->nsaved	1646	=item $topmost_scrollback_row = $term->top_row
1171		1647
1172	Return various integers describing terminal characteristics.	1648	Return various integers describing terminal characteristics.
1173		1649
1174	=item $x_display = $term->display_id	1650	=item $x_display = $term->display_id
1175		1651
…		…
1182	=item $env = $term->env	1658	=item $env = $term->env
1183		1659
1184	Returns a copy of the environment in effect for the terminal as a hashref	1660	Returns a copy of the environment in effect for the terminal as a hashref
1185	similar to C<\%ENV>.	1661	similar to C<\%ENV>.
1186		1662
		1663	=item @envv = $term->envv
		1664
		1665	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1666
		1667	=item @argv = $term->argv
		1668
		1669	Return the argument vector as this terminal, similar to @ARGV, but
		1670	includes the program name as first element.
		1671
1187	=cut	1672	=cut
1188		1673
1189	sub env {	1674	sub env {
1190	if (my $env = $_[0]->_env) {
1191	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1675	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1192	} else {
1193	+{ %ENV }
1194	}
1195	}	1676	}
1196		1677
1197	=item $modifiermask = $term->ModLevel3Mask	1678	=item $modifiermask = $term->ModLevel3Mask
1198		1679
1199	=item $modifiermask = $term->ModMetaMask	1680	=item $modifiermask = $term->ModMetaMask
…		…
1201	=item $modifiermask = $term->ModNumLockMask	1682	=item $modifiermask = $term->ModNumLockMask
1202		1683
1203	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1684	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1204	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1685	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1205		1686
		1687	=item $screen = $term->current_screen
		1688
		1689	Returns the currently displayed screen (0 primary, 1 secondary).
		1690
		1691	=item $cursor_is_hidden = $term->hidden_cursor
		1692
		1693	Returns whether the cursor is currently hidden or not.
		1694
1206	=item $view_start = $term->view_start ([$newvalue])	1695	=item $view_start = $term->view_start ([$newvalue])
1207		1696
1208	Returns the negative row number of the topmost line. Minimum value is	1697	Returns the row number of the topmost displayed line. Maximum value is
1209	C<0>, which displays the normal terminal contents. Larger values scroll	1698	C<0>, which displays the normal terminal contents. Lower values scroll
1210	this many lines into the scrollback buffer.	1699	this many lines into the scrollback buffer.
1211		1700
1212	=item $term->want_refresh	1701	=item $term->want_refresh
1213		1702
1214	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1703	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1217		1706
1218	Used after changing terminal contents to display them.	1707	Used after changing terminal contents to display them.
1219		1708
1220	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1709	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1221		1710
1222	Returns the text of the entire row with number C<$row_number>. Row C<0>	1711	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1223	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1712	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1224	terminal line. The scrollback buffer starts at line C<-1> and extends to
1225	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1713	terminal line. Nothing will be returned if a nonexistent line
1226	is requested.	1714	is requested.
1227		1715
1228	If C<$new_text> is specified, it will replace characters in the current	1716	If C<$new_text> is specified, it will replace characters in the current
1229	line, starting at column C<$start_col> (default C<0>), which is useful	1717	line, starting at column C<$start_col> (default C<0>), which is useful
1230	to replace only parts of a line. The font index in the rendition will	1718	to replace only parts of a line. The font index in the rendition will
1231	automatically be updated.	1719	automatically be updated.
1232		1720
1233	C<$text> is in a special encoding: tabs and wide characters that use more	1721	C<$text> is in a special encoding: tabs and wide characters that use more
1234	than one cell when displayed are padded with urxvt::NOCHAR characters	1722	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1235	(C<chr 65535>). Characters with combining characters and other characters	1723	characters. Characters with combining characters and other characters that
1236	that do not fit into the normal tetx encoding will be replaced with	1724	do not fit into the normal text encoding will be replaced with characters
1237	characters in the private use area.	1725	in the private use area.
1238		1726
1239	You have to obey this encoding when changing text. The advantage is	1727	You have to obey this encoding when changing text. The advantage is
1240	that C<substr> and similar functions work on screen cells and not on	1728	that C<substr> and similar functions work on screen cells and not on
1241	characters.	1729	characters.
1242		1730
…		…
1386	where one character corresponds to one screen cell. See	1874	where one character corresponds to one screen cell. See
1387	C<< $term->ROW_t >> for details.	1875	C<< $term->ROW_t >> for details.
1388		1876
1389	=item $string = $term->special_decode $text	1877	=item $string = $term->special_decode $text
1390		1878
1391	Converts rxvt-unicodes text reprsentation into a perl string. See	1879	Converts rxvt-unicodes text representation into a perl string. See
1392	C<< $term->ROW_t >> for details.	1880	C<< $term->ROW_t >> for details.
1393		1881
1394	=item $success = $term->grab_button ($button, $modifiermask)	1882	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1395		1883
		1884	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1885
1396	Registers a synchronous button grab. See the XGrabButton manpage.	1886	Register/unregister a synchronous button grab. See the XGrabButton
		1887	manpage.
1397		1888
1398	=item $success = $term->grab ($eventtime[, $sync])	1889	=item $success = $term->grab ($eventtime[, $sync])
1399		1890
1400	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1891	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1401	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1892	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1402		1893
1403	=item $term->allow_events_async	1894	=item $term->allow_events_async
1404		1895
1405	Calls XAllowEvents with AsyncBoth for the most recent grab.	1896	Calls XAllowEvents with AsyncBoth for the most recent grab.
1406		1897
…		…
1413	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1904	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1414	recent grab.	1905	recent grab.
1415		1906
1416	=item $term->ungrab	1907	=item $term->ungrab
1417		1908
1418	Calls XUngrab for the most recent grab. Is called automatically on	1909	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1419	evaluation errors, as it is better to lose the grab in the error case as	1910	evaluation errors, as it is better to lose the grab in the error case as
1420	the session.	1911	the session.
		1912
		1913	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1914
		1915	=item $atom_name = $term->XGetAtomName ($atom)
		1916
		1917	=item @atoms = $term->XListProperties ($window)
		1918
		1919	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1920
		1921	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1922
		1923	=item $term->XDeleteProperty ($window, $property)
		1924
		1925	=item $window = $term->DefaultRootWindow
		1926
		1927	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1928
		1929	=item $term->XMapWindow ($window)
		1930
		1931	=item $term->XUnmapWindow ($window)
		1932
		1933	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1934
		1935	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1936
		1937	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1938
		1939	Various X or X-related functions. The C<$term> object only serves as
		1940	the source of the display, otherwise those functions map more-or-less
		1941	directly onto the X functions of the same name.
1421		1942
1422	=back	1943	=back
1423		1944
1424	=cut	1945	=cut
1425		1946
…		…
1489	my ($self, $text, $cb) = @_;	2010	my ($self, $text, $cb) = @_;
1490		2011
1491	$self->add_item ({ type => "button", text => $text, activate => $cb});	2012	$self->add_item ({ type => "button", text => $text, activate => $cb});
1492	}	2013	}
1493		2014
1494	=item $popup->add_toggle ($text, $cb, $initial_value)	2015	=item $popup->add_toggle ($text, $initial_value, $cb)
1495		2016
1496	Adds a toggle/checkbox item to the popup. Teh callback gets called	2017	Adds a toggle/checkbox item to the popup. The callback gets called
1497	whenever it gets toggled, with a boolean indicating its value as its first	2018	whenever it gets toggled, with a boolean indicating its new value as its
1498	argument.	2019	first argument.
1499		2020
1500	=cut	2021	=cut
1501		2022
1502	sub add_toggle {	2023	sub add_toggle {
1503	my ($self, $text, $cb, $value) = @_;	2024	my ($self, $text, $value, $cb) = @_;
1504		2025
1505	my $item; $item = {	2026	my $item; $item = {
1506	type => "button",	2027	type => "button",
1507	text => " $text",	2028	text => " $text",
1508	value => $value,	2029	value => $value,
…		…
1527	my $env = $self->{term}->env;	2048	my $env = $self->{term}->env;
1528	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2049	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1529	delete $env->{LC_ALL};	2050	delete $env->{LC_ALL};
1530	$env->{LC_CTYPE} = $self->{term}->locale;	2051	$env->{LC_CTYPE} = $self->{term}->locale;
1531		2052
1532	urxvt::term->new ($env, $self->{term}->resource ("name"),	2053	my $term = urxvt::term->new (
1533	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2054	$env, "popup",
		2055	"--perl-lib" => "", "--perl-ext-common" => "",
		2056	"-pty-fd" => -1, "-sl" => 0,
		2057	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1534	"--transient-for" => $self->{term}->parent,	2058	"--transient-for" => $self->{term}->parent,
1535	"-display" => $self->{term}->display_id,	2059	"-display" => $self->{term}->display_id,
1536	"-pe" => "urxvt-popup")	2060	"-pe" => "urxvt-popup",
1537	or die "unable to create popup window\n";	2061	) or die "unable to create popup window\n";
		2062
		2063	unless (delete $term->{urxvt_popup_init_done}) {
		2064	$term->ungrab;
		2065	$term->destroy;
		2066	die "unable to initialise popup window\n";
		2067	}
1538	}	2068	}
1539		2069
1540	sub DESTROY {	2070	sub DESTROY {
1541	my ($self) = @_;	2071	my ($self) = @_;
1542		2072
1543	delete $self->{term}{_destroy}{$self};	2073	delete $self->{term}{_destroy}{$self};
1544	$self->{term}->ungrab;	2074	$self->{term}->ungrab;
1545	}	2075	}
1546		2076
1547	=back	2077	=back
		2078
		2079	=cut
		2080
		2081	package urxvt::watcher;
1548		2082
1549	=head2 The C<urxvt::timer> Class	2083	=head2 The C<urxvt::timer> Class
1550		2084
1551	This class implements timer watchers/events. Time is represented as a	2085	This class implements timer watchers/events. Time is represented as a
1552	fractional number of seconds since the epoch. Example:	2086	fractional number of seconds since the epoch. Example:
…		…
1556	->new	2090	->new
1557	->interval (1)	2091	->interval (1)
1558	->cb (sub {	2092	->cb (sub {
1559	$term->{overlay}->set (0, 0,	2093	$term->{overlay}->set (0, 0,
1560	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2094	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1561	});	2095	});
1562		2096
1563	=over 4	2097	=over 4
1564		2098
1565	=item $timer = new urxvt::timer	2099	=item $timer = new urxvt::timer
1566		2100
…		…
1569		2103
1570	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2104	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1571		2105
1572	Set the callback to be called when the timer triggers.	2106	Set the callback to be called when the timer triggers.
1573		2107
1574	=item $tstamp = $timer->at
1575
1576	Return the time this watcher will fire next.
1577
1578	=item $timer = $timer->set ($tstamp)	2108	=item $timer = $timer->set ($tstamp[, $interval])
1579		2109
1580	Set the time the event is generated to $tstamp.	2110	Set the time the event is generated to $tstamp (and optionally specifies a
		2111	new $interval).
1581		2112
1582	=item $timer = $timer->interval ($interval)	2113	=item $timer = $timer->interval ($interval)
1583		2114
1584	Normally (and when C<$interval> is C<0>), the timer will automatically	2115	By default (and when C<$interval> is C<0>), the timer will automatically
1585	stop after it has fired once. If C<$interval> is non-zero, then the timer	2116	stop after it has fired once. If C<$interval> is non-zero, then the timer
1586	is automatically rescheduled at the given intervals.	2117	is automatically rescheduled at the given intervals.
1587		2118
1588	=item $timer = $timer->start	2119	=item $timer = $timer->start
1589		2120
1590	Start the timer.	2121	Start the timer.
1591		2122
1592	=item $timer = $timer->start ($tstamp)	2123	=item $timer = $timer->start ($tstamp[, $interval])
1593		2124
1594	Set the event trigger time to C<$tstamp> and start the timer.	2125	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2126	also replaces the interval.
		2127
		2128	=item $timer = $timer->after ($delay[, $interval])
		2129
		2130	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1595		2131
1596	=item $timer = $timer->stop	2132	=item $timer = $timer->stop
1597		2133
1598	Stop the timer.	2134	Stop the timer.
1599		2135
…		…
1605		2141
1606	$term->{socket} = ...	2142	$term->{socket} = ...
1607	$term->{iow} = urxvt::iow	2143	$term->{iow} = urxvt::iow
1608	->new	2144	->new
1609	->fd (fileno $term->{socket})	2145	->fd (fileno $term->{socket})
1610	->events (urxvt::EVENT_READ)	2146	->events (urxvt::EV_READ)
1611	->start	2147	->start
1612	->cb (sub {	2148	->cb (sub {
1613	my ($iow, $revents) = @_;	2149	my ($iow, $revents) = @_;
1614	# $revents must be 1 here, no need to check	2150	# $revents must be 1 here, no need to check
1615	sysread $term->{socket}, my $buf, 8192	2151	sysread $term->{socket}, my $buf, 8192
…		…
1628	Set the callback to be called when io events are triggered. C<$reventmask>	2164	Set the callback to be called when io events are triggered. C<$reventmask>
1629	is a bitset as described in the C<events> method.	2165	is a bitset as described in the C<events> method.
1630		2166
1631	=item $iow = $iow->fd ($fd)	2167	=item $iow = $iow->fd ($fd)
1632		2168
1633	Set the filedescriptor (not handle) to watch.	2169	Set the file descriptor (not handle) to watch.
1634		2170
1635	=item $iow = $iow->events ($eventmask)	2171	=item $iow = $iow->events ($eventmask)
1636		2172
1637	Set the event mask to watch. The only allowed values are	2173	Set the event mask to watch. The only allowed values are
1638	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2174	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1639	together, or C<urxvt::EVENT_NONE>.	2175	together, or C<urxvt::EV_NONE>.
1640		2176
1641	=item $iow = $iow->start	2177	=item $iow = $iow->start
1642		2178
1643	Start watching for requested events on the given handle.	2179	Start watching for requested events on the given handle.
1644		2180
1645	=item $iow = $iow->stop	2181	=item $iow = $iow->stop
1646		2182
1647	Stop watching for events on the given filehandle.	2183	Stop watching for events on the given file handle.
		2184
		2185	=back
		2186
		2187	=head2 The C<urxvt::iw> Class
		2188
		2189	This class implements idle watchers, that get called automatically when
		2190	the process is idle. They should return as fast as possible, after doing
		2191	some useful work.
		2192
		2193	=over 4
		2194
		2195	=item $iw = new urxvt::iw
		2196
		2197	Create a new idle watcher object in stopped state.
		2198
		2199	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2200
		2201	Set the callback to be called when the watcher triggers.
		2202
		2203	=item $timer = $timer->start
		2204
		2205	Start the watcher.
		2206
		2207	=item $timer = $timer->stop
		2208
		2209	Stop the watcher.
		2210
		2211	=back
		2212
		2213	=head2 The C<urxvt::pw> Class
		2214
		2215	This class implements process watchers. They create an event whenever a
		2216	process exits, after which they stop automatically.
		2217
		2218	my $pid = fork;
		2219	...
		2220	$term->{pw} = urxvt::pw
		2221	->new
		2222	->start ($pid)
		2223	->cb (sub {
		2224	my ($pw, $exit_status) = @_;
		2225	...
		2226	});
		2227
		2228	=over 4
		2229
		2230	=item $pw = new urxvt::pw
		2231
		2232	Create a new process watcher in stopped state.
		2233
		2234	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2235
		2236	Set the callback to be called when the timer triggers.
		2237
		2238	=item $pw = $timer->start ($pid)
		2239
		2240	Tells the watcher to start watching for process C<$pid>.
		2241
		2242	=item $pw = $pw->stop
		2243
		2244	Stop the watcher.
1648		2245
1649	=back	2246	=back
1650		2247
1651	=head1 ENVIRONMENT	2248	=head1 ENVIRONMENT
1652		2249
…		…
1661		2258
1662	=item >= 3 - script loading and management	2259	=item >= 3 - script loading and management
1663		2260
1664	=item >=10 - all called hooks	2261	=item >=10 - all called hooks
1665		2262
1666	=item >=11 - hook reutrn values	2263	=item >=11 - hook return values
1667		2264
1668	=back	2265	=back
1669		2266
1670	=head1 AUTHOR	2267	=head1 AUTHOR
1671		2268
1672	Marc Lehmann <pcg@goof.com>	2269	Marc Lehmann <schmorp@schmorp.de>
1673	http://software.schmorp.de/pkg/rxvt-unicode	2270	http://software.schmorp.de/pkg/rxvt-unicode
1674		2271
1675	=cut	2272	=cut
1676		2273
1677	1	2274	1
		2275
		2276	# vim: sw=3:

Diff Legend

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