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.90 by root, Thu Jan 12 12:15:10 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	=item mark-urls	215	To expand the example above to typical perl error messages ("XXX at
		216	FILENAME line YYY."), you need a slightly more elaborate solution:
135		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
136	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
137	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
138	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
139	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.
140		315
141	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
142		317
143	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
144	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
145	similar-looking ascii character.	320	similar-looking ascii character.
146		321
147	=item digital-clock	322	=item digital-clock
148		323
149	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.
150		393
151	=item example-refresh-hooks	394	=item example-refresh-hooks
152		395
153	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
154	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
155	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"
156		412
157	=back	413	=back
158		414
159	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
160		416
…		…
176		432
177	=over 4	433	=over 4
178		434
179	=item $text	435	=item $text
180		436
181	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
182	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.
183		439
184	=item $string	440	=item $string
185		441
186	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
…		…
194		450
195	=back	451	=back
196		452
197	=head2 Extension Objects	453	=head2 Extension Objects
198		454
199	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
200	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,
201	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
202	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
203	begin with an underscore character C<_>: these are reserved for internal	460	that begin with an underscore character C<_>: these are reserved for
204	use.	461	internal use.
205		462
206	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
207	C<urxvt::term> class on this object.	464	C<urxvt::term> class on this object.
208		465
209	It has the following methods and data members:	466	It has the following methods and data members:
…		…
230	=head2 Hooks	487	=head2 Hooks
231		488
232	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
233	called whenever the relevant event happens.	490	called whenever the relevant event happens.
234		491
235	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
236	the in the C<Extension Objects> section.	493	the in the C<Extension Objects> section.
237		494
238	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
239	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
240	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.
241		498
242	I<< When in doubt, return a false value (preferably C<()>). >>	499	I<< When in doubt, return a false value (preferably C<()>). >>
243		500
244	=over 4	501	=over 4
245		502
246	=item on_init $term	503	=item on_init $term
247		504
248	Called after a new terminal object has been initialized, but before	505	Called after a new terminal object has been initialized, but before
249	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
250	call or deliver senseless data, as terminal size and other characteristics	507	call or deliver senseless data, as terminal size and other characteristics
251	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
252	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).
253		521
254	=item on_reset $term	522	=item on_reset $term
255		523
256	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
257	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
258	variables.	526	variables.
259		527
260	=item on_start $term	528	=item on_child_start $term, $pid
261		529
262	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.
263	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>.
264		536
265	=item on_sel_make $term, $eventtime	537	=item on_sel_make $term, $eventtime
266		538
267	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
268	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
…		…
275		547
276	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
277	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
278	by calling C<< $term->selection >>.	550	by calling C<< $term->selection >>.
279		551
280	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.
281		553
282	=item on_sel_extend $term	554	=item on_sel_extend $term
283		555
284	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
285	click) and is either supposed to return false (normal operation), or	557	click) and is either supposed to return false (normal operation), or
286	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
287	processing. This can happen multiple times, as long as the callback	559	processing. This can happen multiple times, as long as the callback
288	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
289	supposed to enlarge the selection more and more, if possible.	561	supposed to enlarge the selection more and more, if possible.
290		562
291	See the F<selection> example extension.	563	See the F<selection> example extension.
292		564
293	=item on_view_change $term, $offset	565	=item on_view_change $term, $offset
294		566
295	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
296	scrolls. Offset C<0> means display the normal terminal, positive values	568	scrolls. Offset C<0> means display the normal terminal, positive values
297	show this many lines of scrollback.	569	show this many lines of scrollback.
298		570
299	=item on_scroll_back $term, $lines, $saved	571	=item on_scroll_back $term, $lines, $saved
300		572
…		…
304		576
305	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,
306	$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
307	number of lines that will be in the scrollback buffer.	579	number of lines that will be in the scrollback buffer.
308		580
309	=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
310		592
311	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	593	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
312	operating system command) is processed. Cursor position and other state	594	operating system command) is processed. Cursor position and other state
313	information is up-to-date when this happens. For interoperability, the	595	information is up-to-date when this happens. For interoperability, the
314	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,
315	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
316	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	}
317		609
318	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,
319	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
320	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.
321		616
322	=item on_add_lines $term, $string	617	=item on_add_lines $term, $string
323		618
324	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
325	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
…		…
330	=item on_tt_write $term, $octets	625	=item on_tt_write $term, $octets
331		626
332	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
333	suppress or filter tty input.	628	suppress or filter tty input.
334		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
335	=item on_line_update $term, $row	637	=item on_line_update $term, $row
336		638
337	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
338	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
339	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,
…		…
346	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
347	you cannot just toggle rendition bits, but only set them.	649	you cannot just toggle rendition bits, but only set them.
348		650
349	=item on_refresh_begin $term	651	=item on_refresh_begin $term
350		652
351	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
352	or similar effects by modify terminal contents in refresh_begin, and	654	similar effects by modifying the terminal contents in refresh_begin, and
353	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
354	code is run after this hook, and takes precedence.	656	code is run after this hook, and takes precedence.
355		657
356	=item on_refresh_end $term	658	=item on_refresh_end $term
357		659
358	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>.
359		661
360	=item on_keyboard_command $term, $string	662	=item on_user_command $term, $string
361		663
362	Called whenever the user presses a key combination that has a	664	Called whenever a user-configured event is being activated (e.g. via
363	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>
364	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.
365		686
366	=item on_focus_in $term	687	=item on_focus_in $term
367		688
368	Called whenever the window gets the keyboard focus, before rxvt-unicode	689	Called whenever the window gets the keyboard focus, before rxvt-unicode
369	does focus in processing.	690	does focus in processing.
370		691
371	=item on_focus_out $term	692	=item on_focus_out $term
372		693
373	Called wheneever the window loses keyboard focus, before rxvt-unicode does	694	Called whenever the window loses keyboard focus, before rxvt-unicode does
374	focus out processing.	695	focus out processing.
375		696
		697	=item on_configure_notify $term, $event
		698
		699	=item on_property_notify $term, $event
		700
376	=item on_key_press $term, $event, $keysym, $octets	701	=item on_key_press $term, $event, $keysym, $octets
377		702
378	=item on_key_release $term, $event, $keysym	703	=item on_key_release $term, $event, $keysym
379		704
380	=item on_button_press $term, $event	705	=item on_button_press $term, $event
…		…
385		710
386	=item on_map_notify $term, $event	711	=item on_map_notify $term, $event
387		712
388	=item on_unmap_notify $term, $event	713	=item on_unmap_notify $term, $event
389		714
390	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
391	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.
392		717
393	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
394	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
395	and column under the mouse cursor.	720	(real, not screen-based) row and column under the mouse cursor.
396		721
397	C<on_key_press> additionally receives the string rxvt-unicode would	722	C<on_key_press> additionally receives the string rxvt-unicode would
398	output, if any, in locale-specific encoding.	723	output, if any, in locale-specific encoding.
399		724
400	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.
401		739
402	=back	740	=back
403		741
404	=cut	742	=cut
405		743
…		…
411	use Scalar::Util ();	749	use Scalar::Util ();
412	use List::Util ();	750	use List::Util ();
413		751
414	our $VERSION = 1;	752	our $VERSION = 1;
415	our $TERM;	753	our $TERM;
		754	our @TERM_INIT;
		755	our @TERM_EXT;
416	our @HOOKNAME;	756	our @HOOKNAME;
417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	757	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
418	our %OPTION;	758	our %OPTION;
419		759
420	our $LIBDIR;	760	our $LIBDIR;
421	our $RESNAME;	761	our $RESNAME;
422	our $RESCLASS;	762	our $RESCLASS;
423	our $RXVTNAME;	763	our $RXVTNAME;
424		764
		765	our $NOCHAR = chr 0xffff;
		766
425	=head2 Variables in the C<urxvt> Package	767	=head2 Variables in the C<urxvt> Package
426		768
427	=over 4	769	=over 4
428		770
429	=item $urxvt::LIBDIR	771	=item $urxvt::LIBDIR
…		…
442	=item $urxvt::TERM	784	=item $urxvt::TERM
443		785
444	The current terminal. This variable stores the current C<urxvt::term>	786	The current terminal. This variable stores the current C<urxvt::term>
445	object, whenever a callback/hook is executing.	787	object, whenever a callback/hook is executing.
446		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
447	=back	805	=back
448		806
449	=head2 Functions in the C<urxvt> Package	807	=head2 Functions in the C<urxvt> Package
450		808
451	=over 4	809	=over 4
452		810
453	=item urxvt::fatal $errormessage	811	=item urxvt::fatal $errormessage
454		812
455	Fatally aborts execution with the given error message. Avoid at all	813	Fatally aborts execution with the given error message (which should
456	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
457	starts up.	815	is acceptable (and useful) is in the init hook, where it prevents the
		816	terminal from starting up.
458		817
459	=item urxvt::warn $string	818	=item urxvt::warn $string
460		819
461	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
462	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
463	that calls this function.	822	that calls this function.
464		823
465	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
466	correct place, e.g. on stderr of the connecting urxvtc client.	825	correct place, e.g. on stderr of the connecting urxvtc client.
467		826
468	Messages have a size limit of 1023 bytes currently.	827	Messages have a size limit of 1023 bytes currently.
469		828
470	=item $is_safe = urxvt::safe	829	=item @terms = urxvt::termlist
471		830
472	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
473	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
474	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).
475		835
476	=item $time = urxvt::NOW	836	=item $time = urxvt::NOW
477		837
478	Returns the "current time" (as per the event loop).	838	Returns the "current time" (as per the event loop).
479		839
480	=item urxvt::CurrentTime	840	=item urxvt::CurrentTime
481		841
482	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	842	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
483	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	843	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
484	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
485		861
486	Various constants for use in X calls and event processing.	862	Various constants for use in X calls and event processing.
487		863
488	=back	864	=back
489		865
…		…
506		882
507	=item $rend = urxvt::OVERLAY_RSTYLE	883	=item $rend = urxvt::OVERLAY_RSTYLE
508		884
509	Return the rendition mask used for overlays by default.	885	Return the rendition mask used for overlays by default.
510		886
511	=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
512		889
513	Return the bit that enabled bold, italic, blink, reverse-video and	890	Return the bit that enabled bold, italic, blink, reverse-video and
514	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
515	the bitset.	892	the bitset.
516		893
…		…
522		899
523	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	900	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
524		901
525	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	902	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
526		903
		904	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		905
527	Replace the foreground/background colour in the rendition mask with the	906	Replace the foreground/background colour in the rendition mask with the
528	specified one.	907	specified one.
529		908
530	=item $value = urxvt::GET_CUSTOM $rend	909	=item $value = urxvt::GET_CUSTOM $rend
531		910
…		…
540	=back	919	=back
541		920
542	=cut	921	=cut
543		922
544	BEGIN {	923	BEGIN {
545	urxvt->bootstrap;
546
547	# overwrite perl's warn	924	# overwrite perl's warn
548	*CORE::GLOBAL::warn = sub {	925	*CORE::GLOBAL::warn = sub {
549	my $msg = join "", @_;	926	my $msg = join "", @_;
550	$msg .= "\n"	927	$msg .= "\n"
551	unless $msg =~ /\n$/;	928	unless $msg =~ /\n$/;
552	urxvt::warn ($msg);	929	urxvt::warn ($msg);
553	};	930	};
554
555	# %ENV is the original startup environment
556	delete $ENV{IFS};
557	delete $ENV{CDPATH};
558	delete $ENV{BASH_ENV};
559	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
560	}	931	}
561		932
562	my @hook_count;	933	no warnings 'utf8';
		934
563	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	935	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
564		936
565	sub verbose {	937	sub verbose {
566	my ($level, $msg) = @_;	938	my ($level, $msg) = @_;
567	warn "$msg\n" if $level <= $verbosity;	939	warn "$msg\n" if $level <= $verbosity;
568	}	940	}
569		941
570	my $extension_pkg = "extension0000";
571	my %extension_pkg;	942	my %extension_pkg;
572		943
573	# load a single script into its own package, once only	944	# load a single script into its own package, once only
574	sub extension_package($) {	945	sub extension_package($) {
575	my ($path) = @_;	946	my ($path) = @_;
576		947
577	$extension_pkg{$path} ||= do {	948	$extension_pkg{$path} ||= do {
578	my $pkg = "urxvt::" . ($extension_pkg++);	949	$path =~ /([^\/\\]+)$/;
		950	my $pkg = $1;
		951	$pkg =~ s/[^[:word:]]/_/g;
		952	$pkg = "urxvt::ext::$pkg";
579		953
580	verbose 3, "loading extension '$path' into package '$pkg'";	954	verbose 3, "loading extension '$path' into package '$pkg'";
581		955
582	open my $fh, "<:raw", $path	956	open my $fh, "<:raw", $path
583	or die "$path: $!";	957	or die "$path: $!";
584		958
585	my $source = untaint	959	my $source =
586	"package $pkg; use strict; use utf8;\n"	960	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
587	. "use base urxvt::term::extension::;\n"
588	. "#line 1 \"$path\"\n{\n"	961	. "#line 1 \"$path\"\n{\n"
589	. (do { local $/; <$fh> })	962	. (do { local $/; <$fh> })
590	. "\n};\n1";	963	. "\n};\n1";
591		964
592	eval $source	965	eval $source
…		…
602	sub invoke {	975	sub invoke {
603	local $TERM = shift;	976	local $TERM = shift;
604	my $htype = shift;	977	my $htype = shift;
605		978
606	if ($htype == 0) { # INIT	979	if ($htype == 0) { # INIT
607	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	980	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
608		981
609	my %ext_arg;	982	my %ext_arg;
610		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
611	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	993	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
612	if ($_ eq "default") {	994	if ($_ eq "default") {
613	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	995	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
614	} elsif (/^-(.*)$/) {	996	} elsif (/^-(.*)$/) {
615	delete $ext_arg{$1};	997	delete $ext_arg{$1};
616	} elsif (/^([^<]+)<(.*)>$/) {	998	} elsif (/^([^<]+)<(.*)>$/) {
617	push @{ $ext_arg{$1} }, $2;	999	push @{ $ext_arg{$1} }, $2;
618	} else {	1000	} else {
619	$ext_arg{$_} ||= [];	1001	$ext_arg{$_} ||= [];
620	}	1002	}
621	}	1003	}
622		1004
623	while (my ($ext, $argv) = each %ext_arg) {	1005	for my $ext (sort keys %ext_arg) {
624	my @files = grep -f $_, map "$_/$ext", @dirs;	1006	my @files = grep -f $_, map "$_/$ext", @dirs;
625		1007
626	if (@files) {	1008	if (@files) {
627	$TERM->register_package (extension_package $files[0], $argv);	1009	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
628	} else {	1010	} else {
629	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";
630	}	1012	}
631	}	1013	}
632		1014
…		…
638		1020
639	if (my $cb = $TERM->{_hook}[$htype]) {	1021	if (my $cb = $TERM->{_hook}[$htype]) {
640	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1022	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
641	if $verbosity >= 10;	1023	if $verbosity >= 10;
642		1024
643	keys %$cb;	1025	for my $pkg (keys %$cb) {
644
645	while (my ($pkg, $cb) = each %$cb) {
646	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1026	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
647	and last;	1027	$retval ||= $retval_;
648		1028
649	if ($@) {	1029	if ($@) {
650	$TERM->ungrab; # better to lose the grab than the session	1030	$TERM->ungrab; # better to lose the grab than the session
651	warn $@;	1031	warn $@;
652	}	1032	}
…		…
655	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	1035	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656	if $verbosity >= 11;	1036	if $verbosity >= 11;
657	}	1037	}
658		1038
659	if ($htype == 1) { # DESTROY	1039	if ($htype == 1) { # DESTROY
660	if (my $hook = delete $TERM->{_hook}) {
661	for my $htype (0..$#$hook) {
662	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
663	or set_should_invoke $htype, 0;
664	}
665	}
666
667	# clear package objects	1040	# clear package objects
668	%$_ = () for values %{ $TERM->{_pkg} };	1041	%$_ = () for values %{ $TERM->{_pkg} };
669		1042
670	# clear package	1043	# clear package
671	%$TERM = ();	1044	%$TERM = ();
672	}	1045	}
673		1046
674	$retval	1047	$retval
675	}	1048	}
676		1049
677	sub exec_async(@) {	1050	sub SET_COLOR($$$) {
678	my $pid = fork;	1051	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1052	}
679		1053
680	return	1054	sub rend2mask {
681	if !defined $pid or $pid;	1055	no strict 'refs';
682		1056	my ($str, $mask) = (@_, 0);
683	%ENV = %{ $TERM->env };	1057	my %color = ( fg => undef, bg => undef );
684		1058	my @failed;
685	exec @_;	1059	for my $spec ( split /\s+/, $str ) {
686	_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)
687	}	1077	}
688		1078
689	# urxvt::term::extension	1079	# urxvt::term::extension
690		1080
691	package urxvt::term::extension;	1081	package urxvt::term::extension;
…		…
697	while (my ($name, $cb) = each %hook) {	1087	while (my ($name, $cb) = each %hook) {
698	my $htype = $HOOKTYPE{uc $name};	1088	my $htype = $HOOKTYPE{uc $name};
699	defined $htype	1089	defined $htype
700	or Carp::croak "unsupported hook type '$name'";	1090	or Carp::croak "unsupported hook type '$name'";
701		1091
		1092	$self->set_should_invoke ($htype, +1)
702	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1093	unless exists $self->{term}{_hook}[$htype]{$pkg};
703	$hook_count[$htype]++
704	or urxvt::set_should_invoke $htype, 1;
705	}
706		1094
707	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1095	$self->{term}{_hook}[$htype]{$pkg} = $cb;
708	}	1096	}
709	}	1097	}
710		1098
…		…
715	for my $name (@hook) {	1103	for my $name (@hook) {
716	my $htype = $HOOKTYPE{uc $name};	1104	my $htype = $HOOKTYPE{uc $name};
717	defined $htype	1105	defined $htype
718	or Carp::croak "unsupported hook type '$name'";	1106	or Carp::croak "unsupported hook type '$name'";
719		1107
		1108	$self->set_should_invoke ($htype, -1)
720	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1109	if delete $self->{term}{_hook}[$htype]{$pkg};
721	--$hook_count[$htype]
722	or urxvt::set_should_invoke $htype, 0;
723	}
724	}	1110	}
725	}	1111	}
726		1112
727	our $AUTOLOAD;	1113	our $AUTOLOAD;
728		1114
…		…
766	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
767	work.	1153	work.
768		1154
769	=cut	1155	=cut
770		1156
771	our $VERSION = 1;	1157	our $VERSION = '5.23';
772		1158
773	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1159	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
774	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1160	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
775		1161
776	sub timer {	1162	sub timer {
…		…
778		1164
779	my $cb = $arg{cb};	1165	my $cb = $arg{cb};
780		1166
781	urxvt::timer	1167	urxvt::timer
782	->new	1168	->new
783	->start (urxvt::NOW + $arg{after})	1169	->after ($arg{after}, $arg{interval})
784	->cb (sub {	1170	->cb ($arg{interval} ? $cb : sub {
785	$_[0]->stop; # need to cancel manually	1171	$_[0]->stop; # need to cancel manually
786	$cb->();	1172	$cb->();
787	})	1173	})
788	}	1174	}
789		1175
790	sub io {	1176	sub io {
791	my ($class, %arg) = @_;	1177	my ($class, %arg) = @_;
792		1178
793	my $cb = $arg{cb};	1179	my $cb = $arg{cb};
		1180	my $fd = fileno $arg{fh};
		1181	defined $fd or $fd = $arg{fh};
794		1182
795	bless [$arg{fh}, urxvt::iow	1183	bless [$arg{fh}, urxvt::iow
796	->new	1184	->new
797	->fd (fileno $arg{fh})	1185	->fd ($fd)
798	->events (($arg{poll} =~ /r/ ? 1 : 0)	1186	->events (($arg{poll} =~ /r/ ? 1 : 0)
799	| ($arg{poll} =~ /w/ ? 2 : 0))	1187	| ($arg{poll} =~ /w/ ? 2 : 0))
800	->start	1188	->start
801	->cb (sub {	1189	->cb ($cb)
802	$cb->(($_[1] & 1 ? 'r' : '')
803	. ($_[1] & 2 ? 'w' : ''));
804	})],
805	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	})
806	}	1216	}
807		1217
808	sub DESTROY {	1218	sub DESTROY {
809	$_[0][1]->stop;	1219	$_[0][1]->stop;
810	}	1220	}
811		1221
812	sub condvar {	1222	# only needed for AnyEvent < 6 compatibility
813	bless \my $flag, urxvt::anyevent::condvar::	1223	sub one_event {
814	}
815
816	sub urxvt::anyevent::condvar::broadcast {
817	${$_[0]}++;
818	}
819
820	sub urxvt::anyevent::condvar::wait {
821	unless (${$_[0]}) {
822	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";
823	}
824	}	1225	}
825		1226
826	package urxvt::term;	1227	package urxvt::term;
827		1228
828	=head2 The C<urxvt::term> Class	1229	=head2 The C<urxvt::term> Class
…		…
833		1234
834	# find on_xxx subs in the package and register them	1235	# find on_xxx subs in the package and register them
835	# as hooks	1236	# as hooks
836	sub register_package {	1237	sub register_package {
837	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::;
838		1245
839	my $proxy = bless {	1246	my $proxy = bless {
840	_pkg => $pkg,	1247	_pkg => $pkg,
841	argv => $argv,	1248	argv => $argv,
842	}, $pkg;	1249	}, $pkg;
…		…
858	hash which defines the environment of the new terminal.	1265	hash which defines the environment of the new terminal.
859		1266
860	Croaks (and probably outputs an error message) if the new instance	1267	Croaks (and probably outputs an error message) if the new instance
861	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
862	initialise perl, and the terminal object otherwise. The C<init> and	1269	initialise perl, and the terminal object otherwise. The C<init> and
863	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).
864		1272
865	=cut	1273	=cut
866		1274
867	sub new {	1275	sub new {
868	my ($class, $env, @args) = @_;	1276	my ($class, $env, @args) = @_;
869		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
870	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1281	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
871	}	1282	}
872		1283
873	=item $term->destroy	1284	=item $term->destroy
874		1285
875	Destroy the terminal object (close the window, free resources	1286	Destroy the terminal object (close the window, free resources
876	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
877	watchers (timers, io watchers) are still active.	1288	watchers (timers, io watchers) are still active.
878		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
879	=item $isset = $term->option ($optval[, $set])	1315	=item $isset = $term->option ($optval[, $set])
880		1316
881	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
882	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
883	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.
884		1320
885	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
886	source file F</src/optinc.h> to see the actual list:	1322	source file F</src/optinc.h> to see the actual list:
887		1323
888	borderLess console cursorBlink cursorUnderline hold iconic insecure	1324	borderLess buffered console cursorBlink cursorUnderline hold iconic
889	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1325	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1326	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
890	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1327	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
891	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1328	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
892	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1329	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
893	tripleclickwords utmpInhibit visualBell	1330	urgentOnBell utmpInhibit visualBell
894		1331
895	=item $value = $term->resource ($name[, $newval])	1332	=item $value = $term->resource ($name[, $newval])
896		1333
897	Returns the current resource value associated with a given name and	1334	Returns the current resource value associated with a given name and
898	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>
…		…
907	likely change).	1344	likely change).
908		1345
909	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
910	terminal is destroyed, so changing options frequently will eat memory.	1347	terminal is destroyed, so changing options frequently will eat memory.
911		1348
912	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
913	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>
914	to see the actual list:	1351	to see the actual list:
915		1352
916	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1353	answerbackstring backgroundPixmap backspace_key blendtype blurradius
917	borderLess color cursorBlink cursorUnderline cutchars delete_key	1354	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
918	display_name embed ext_bwidth fade font geometry hold iconName	1355	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
919	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
920	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1358	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
921	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1359	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
922	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1360	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
923	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1361	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
924	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1362	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
925	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1363	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
926	shade term_name title transparent transparent_all tripleclickwords	1364	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1365	term_name title transient_for transparent tripleclickwords urgentOnBell
927	utmpInhibit visualBell	1366	utmpInhibit visualBell
928		1367
929	=cut	1368	=cut
930		1369
931	sub resource($$;$) {	1370	sub resource($$;$) {
932	my ($self, $name) = (shift, shift);	1371	my ($self, $name) = (shift, shift);
933	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1372	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
934	&urxvt::term::_resource	1373	goto &urxvt::term::_resource
935	}	1374	}
936		1375
937	=item $value = $term->x_resource ($pattern)	1376	=item $value = $term->x_resource ($pattern)
938		1377
939	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
…		…
964		1403
965	=item ($row, $col) = $term->selection_beg ([$row, $col])	1404	=item ($row, $col) = $term->selection_beg ([$row, $col])
966		1405
967	=item ($row, $col) = $term->selection_end ([$row, $col])	1406	=item ($row, $col) = $term->selection_end ([$row, $col])
968		1407
969	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.
970	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.
971		1417
972	=item $term->selection_make ($eventtime[, $rectangular])	1418	=item $term->selection_make ($eventtime[, $rectangular])
973		1419
974	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
975	C<selection_end>. If C<$rectangular> is true (default: false), a	1421	C<selection_end>. If C<$rectangular> is true (default: false), a
976	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
977	a selection.	1423	a selection.
978		1424
979	=item $success = $term->selection_grab ($eventtime)	1425	=item $success = $term->selection_grab ($eventtime[, $clipboard])
980		1426
981	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
982	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
983	is mostly useful from within C<on_sel_grab> hooks.	1430	is mostly useful from within C<on_sel_grab> hooks.
984		1431
985	=item $oldtext = $term->selection ([$newtext])	1432	=item $oldtext = $term->selection ([$newtext, $clipboard])
986		1433
987	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.
988		1440
989	=item $term->overlay_simple ($x, $y, $text)	1441	=item $term->overlay_simple ($x, $y, $text)
990		1442
991	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.
992		1444
…		…
1022		1474
1023	The methods currently supported on C<urxvt::overlay> objects are:	1475	The methods currently supported on C<urxvt::overlay> objects are:
1024		1476
1025	=over 4	1477	=over 4
1026		1478
1027	=item $overlay->set ($x, $y, $text, $rend)	1479	=item $overlay->set ($x, $y, $text[, $rend])
1028		1480
1029	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
1030	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
1031	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.
1032		1486
1033	=item $overlay->hide	1487	=item $overlay->hide
1034		1488
1035	If visible, hide the overlay, but do not destroy it.	1489	If visible, hide the overlay, but do not destroy it.
1036		1490
…		…
1106		1560
1107	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
1108	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
1109	C<on_add_lines> hook, though.	1563	C<on_add_lines> hook, though.
1110		1564
		1565	=item $term->scr_change_screen ($screen)
		1566
		1567	Switch to given screen - 0 primary, 1 secondary.
		1568
1111	=item $term->cmd_parse ($octets)	1569	=item $term->cmd_parse ($octets)
1112		1570
1113	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
1114	locale-specific encoding of the terminal and can contain command sequences	1572	locale-specific encoding of the terminal and can contain command sequences
1115	(escape codes) that will be interpreted.	1573	(escape codes) that will be interpreted.
1116		1574
1117	=item $term->tt_write ($octets)	1575	=item $term->tt_write ($octets)
1118		1576
1119	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
1120	pass characters instead of octets, you should convert your strings first	1578	pass characters instead of octets, you should convert your strings first
1121	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.
1122		1586
1123	=item $old_events = $term->pty_ev_events ([$new_events])	1587	=item $old_events = $term->pty_ev_events ([$new_events])
1124		1588
1125	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
1126	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
1127	description of C<< urxvt::timer->events >>. Make sure to always restore	1591	description of C<< urxvt::timer->events >>. Make sure to always restore
1128	the previous value.	1592	the previous value.
1129		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
1130	=item $windowid = $term->parent	1599	=item $windowid = $term->parent
1131		1600
1132	Return the window id of the toplevel window.	1601	Return the window id of the toplevel window.
1133		1602
1134	=item $windowid = $term->vt	1603	=item $windowid = $term->vt
1135		1604
1136	Return the window id of the terminal window.	1605	Return the window id of the terminal window.
1137		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
1138	=item $window_width = $term->width	1624	=item $window_width = $term->width
1139		1625
1140	=item $window_height = $term->height	1626	=item $window_height = $term->height
1141		1627
1142	=item $font_width = $term->fwidth	1628	=item $font_width = $term->fwidth
…		…
1155		1641
1156	=item $max_scrollback = $term->saveLines	1642	=item $max_scrollback = $term->saveLines
1157		1643
1158	=item $nrow_plus_saveLines = $term->total_rows	1644	=item $nrow_plus_saveLines = $term->total_rows
1159		1645
1160	=item $lines_in_scrollback = $term->nsaved	1646	=item $topmost_scrollback_row = $term->top_row
1161		1647
1162	Return various integers describing terminal characteristics.	1648	Return various integers describing terminal characteristics.
1163		1649
1164	=item $x_display = $term->display_id	1650	=item $x_display = $term->display_id
1165		1651
…		…
1172	=item $env = $term->env	1658	=item $env = $term->env
1173		1659
1174	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
1175	similar to C<\%ENV>.	1661	similar to C<\%ENV>.
1176		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
1177	=cut	1672	=cut
1178		1673
1179	sub env {	1674	sub env {
1180	if (my $env = $_[0]->_env) {
1181	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1675	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1182	} else {
1183	+{ %ENV }
1184	}
1185	}	1676	}
1186		1677
1187	=item $modifiermask = $term->ModLevel3Mask	1678	=item $modifiermask = $term->ModLevel3Mask
1188		1679
1189	=item $modifiermask = $term->ModMetaMask	1680	=item $modifiermask = $term->ModMetaMask
…		…
1191	=item $modifiermask = $term->ModNumLockMask	1682	=item $modifiermask = $term->ModNumLockMask
1192		1683
1193	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
1194	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.
1195		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
1196	=item $view_start = $term->view_start ([$newvalue])	1695	=item $view_start = $term->view_start ([$newvalue])
1197		1696
1198	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
1199	C<0>, which displays the normal terminal contents. Larger values scroll	1698	C<0>, which displays the normal terminal contents. Lower values scroll
1200	this many lines into the scrollback buffer.	1699	this many lines into the scrollback buffer.
1201		1700
1202	=item $term->want_refresh	1701	=item $term->want_refresh
1203		1702
1204	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1703	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1207		1706
1208	Used after changing terminal contents to display them.	1707	Used after changing terminal contents to display them.
1209		1708
1210	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1709	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1211		1710
1212	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 >>
1213	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
1214	terminal line. The scrollback buffer starts at line C<-1> and extends to
1215	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1713	terminal line. Nothing will be returned if a nonexistent line
1216	is requested.	1714	is requested.
1217		1715
1218	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
1219	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
1220	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
1221	automatically be updated.	1719	automatically be updated.
1222		1720
1223	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
1224	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)
1225	(C<chr 65535>). Characters with combining characters and other characters	1723	characters. Characters with combining characters and other characters that
1226	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
1227	characters in the private use area.	1725	in the private use area.
1228		1726
1229	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
1230	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
1231	characters.	1729	characters.
1232		1730
…		…
1376	where one character corresponds to one screen cell. See	1874	where one character corresponds to one screen cell. See
1377	C<< $term->ROW_t >> for details.	1875	C<< $term->ROW_t >> for details.
1378		1876
1379	=item $string = $term->special_decode $text	1877	=item $string = $term->special_decode $text
1380		1878
1381	Converts rxvt-unicodes text reprsentation into a perl string. See	1879	Converts rxvt-unicodes text representation into a perl string. See
1382	C<< $term->ROW_t >> for details.	1880	C<< $term->ROW_t >> for details.
1383		1881
1384	=item $success = $term->grab_button ($button, $modifiermask)	1882	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1385		1883
		1884	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1885
1386	Registers a synchronous button grab. See the XGrabButton manpage.	1886	Register/unregister a synchronous button grab. See the XGrabButton
		1887	manpage.
1387		1888
1388	=item $success = $term->grab ($eventtime[, $sync])	1889	=item $success = $term->grab ($eventtime[, $sync])
1389		1890
1390	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1891	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1391	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1892	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1392		1893
1393	=item $term->allow_events_async	1894	=item $term->allow_events_async
1394		1895
1395	Calls XAllowEvents with AsyncBoth for the most recent grab.	1896	Calls XAllowEvents with AsyncBoth for the most recent grab.
1396		1897
…		…
1403	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1904	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1404	recent grab.	1905	recent grab.
1405		1906
1406	=item $term->ungrab	1907	=item $term->ungrab
1407		1908
1408	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
1409	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
1410	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.
1411		1942
1412	=back	1943	=back
1413		1944
1414	=cut	1945	=cut
1415		1946
…		…
1479	my ($self, $text, $cb) = @_;	2010	my ($self, $text, $cb) = @_;
1480		2011
1481	$self->add_item ({ type => "button", text => $text, activate => $cb});	2012	$self->add_item ({ type => "button", text => $text, activate => $cb});
1482	}	2013	}
1483		2014
1484	=item $popup->add_toggle ($text, $cb, $initial_value)	2015	=item $popup->add_toggle ($text, $initial_value, $cb)
1485		2016
1486	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
1487	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
1488	argument.	2019	first argument.
1489		2020
1490	=cut	2021	=cut
1491		2022
1492	sub add_toggle {	2023	sub add_toggle {
1493	my ($self, $text, $cb, $value) = @_;	2024	my ($self, $text, $value, $cb) = @_;
1494		2025
1495	my $item; $item = {	2026	my $item; $item = {
1496	type => "button",	2027	type => "button",
1497	text => " $text",	2028	text => " $text",
1498	value => $value,	2029	value => $value,
…		…
1517	my $env = $self->{term}->env;	2048	my $env = $self->{term}->env;
1518	# 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.
1519	delete $env->{LC_ALL};	2050	delete $env->{LC_ALL};
1520	$env->{LC_CTYPE} = $self->{term}->locale;	2051	$env->{LC_CTYPE} = $self->{term}->locale;
1521		2052
1522	urxvt::term->new ($env, $self->{term}->resource ("name"),	2053	my $term = urxvt::term->new (
1523	"--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",
1524	"--transient-for" => $self->{term}->parent,	2058	"--transient-for" => $self->{term}->parent,
1525	"-display" => $self->{term}->display_id,	2059	"-display" => $self->{term}->display_id,
1526	"-pe" => "urxvt-popup")	2060	"-pe" => "urxvt-popup",
1527	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	}
1528	}	2068	}
1529		2069
1530	sub DESTROY {	2070	sub DESTROY {
1531	my ($self) = @_;	2071	my ($self) = @_;
1532		2072
1533	delete $self->{term}{_destroy}{$self};	2073	delete $self->{term}{_destroy}{$self};
1534	$self->{term}->ungrab;	2074	$self->{term}->ungrab;
1535	}	2075	}
1536		2076
1537	=back	2077	=back
		2078
		2079	=cut
		2080
		2081	package urxvt::watcher;
1538		2082
1539	=head2 The C<urxvt::timer> Class	2083	=head2 The C<urxvt::timer> Class
1540		2084
1541	This class implements timer watchers/events. Time is represented as a	2085	This class implements timer watchers/events. Time is represented as a
1542	fractional number of seconds since the epoch. Example:	2086	fractional number of seconds since the epoch. Example:
…		…
1546	->new	2090	->new
1547	->interval (1)	2091	->interval (1)
1548	->cb (sub {	2092	->cb (sub {
1549	$term->{overlay}->set (0, 0,	2093	$term->{overlay}->set (0, 0,
1550	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2094	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1551	});	2095	});
1552		2096
1553	=over 4	2097	=over 4
1554		2098
1555	=item $timer = new urxvt::timer	2099	=item $timer = new urxvt::timer
1556		2100
…		…
1559		2103
1560	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2104	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1561		2105
1562	Set the callback to be called when the timer triggers.	2106	Set the callback to be called when the timer triggers.
1563		2107
1564	=item $tstamp = $timer->at
1565
1566	Return the time this watcher will fire next.
1567
1568	=item $timer = $timer->set ($tstamp)	2108	=item $timer = $timer->set ($tstamp[, $interval])
1569		2109
1570	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).
1571		2112
1572	=item $timer = $timer->interval ($interval)	2113	=item $timer = $timer->interval ($interval)
1573		2114
1574	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
1575	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
1576	is automatically rescheduled at the given intervals.	2117	is automatically rescheduled at the given intervals.
1577		2118
1578	=item $timer = $timer->start	2119	=item $timer = $timer->start
1579		2120
1580	Start the timer.	2121	Start the timer.
1581		2122
1582	=item $timer = $timer->start ($tstamp)	2123	=item $timer = $timer->start ($tstamp[, $interval])
1583		2124
1584	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>.
1585		2131
1586	=item $timer = $timer->stop	2132	=item $timer = $timer->stop
1587		2133
1588	Stop the timer.	2134	Stop the timer.
1589		2135
…		…
1595		2141
1596	$term->{socket} = ...	2142	$term->{socket} = ...
1597	$term->{iow} = urxvt::iow	2143	$term->{iow} = urxvt::iow
1598	->new	2144	->new
1599	->fd (fileno $term->{socket})	2145	->fd (fileno $term->{socket})
1600	->events (urxvt::EVENT_READ)	2146	->events (urxvt::EV_READ)
1601	->start	2147	->start
1602	->cb (sub {	2148	->cb (sub {
1603	my ($iow, $revents) = @_;	2149	my ($iow, $revents) = @_;
1604	# $revents must be 1 here, no need to check	2150	# $revents must be 1 here, no need to check
1605	sysread $term->{socket}, my $buf, 8192	2151	sysread $term->{socket}, my $buf, 8192
…		…
1618	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>
1619	is a bitset as described in the C<events> method.	2165	is a bitset as described in the C<events> method.
1620		2166
1621	=item $iow = $iow->fd ($fd)	2167	=item $iow = $iow->fd ($fd)
1622		2168
1623	Set the filedescriptor (not handle) to watch.	2169	Set the file descriptor (not handle) to watch.
1624		2170
1625	=item $iow = $iow->events ($eventmask)	2171	=item $iow = $iow->events ($eventmask)
1626		2172
1627	Set the event mask to watch. The only allowed values are	2173	Set the event mask to watch. The only allowed values are
1628	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
1629	together, or C<urxvt::EVENT_NONE>.	2175	together, or C<urxvt::EV_NONE>.
1630		2176
1631	=item $iow = $iow->start	2177	=item $iow = $iow->start
1632		2178
1633	Start watching for requested events on the given handle.	2179	Start watching for requested events on the given handle.
1634		2180
1635	=item $iow = $iow->stop	2181	=item $iow = $iow->stop
1636		2182
1637	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.
1638		2245
1639	=back	2246	=back
1640		2247
1641	=head1 ENVIRONMENT	2248	=head1 ENVIRONMENT
1642		2249
…		…
1651		2258
1652	=item >= 3 - script loading and management	2259	=item >= 3 - script loading and management
1653		2260
1654	=item >=10 - all called hooks	2261	=item >=10 - all called hooks
1655		2262
1656	=item >=11 - hook reutrn values	2263	=item >=11 - hook return values
1657		2264
1658	=back	2265	=back
1659		2266
1660	=head1 AUTHOR	2267	=head1 AUTHOR
1661		2268
1662	Marc Lehmann <pcg@goof.com>	2269	Marc Lehmann <schmorp@schmorp.de>
1663	http://software.schmorp.de/pkg/rxvt-unicode	2270	http://software.schmorp.de/pkg/rxvt-unicode
1664		2271
1665	=cut	2272	=cut
1666		2273
1667	1	2274	1
		2275
		2276	# vim: sw=3:

Diff Legend

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