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.207 by root, Tue Jun 5 21:29:52 2012 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
…		…
200	=item $octets	446	=item $octets
201		447
202	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
203	locale-specific way.	449	locale-specific way.
204		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
205	=back	457	=back
206		458
207	=head2 Extension Objects	459	=head2 Extension Objects
208		460
209	Very perl extension is a perl class. A separate perl object is created	461	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	462	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	463	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	464	their C<$self> object without having to think about clashes with other
		465	extensions or other terminals, with the exception of methods and members
213	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
214	use.	467	internal use.
215		468
216	Although it isn't a C<urxvt::term> object, you can call all methods of the	469	Although it isn't a C<urxvt::term> object, you can call all methods of the
217	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
218		471
219	It has the following methods and data members:	472	It has the following methods and data members:
…		…
240	=head2 Hooks	493	=head2 Hooks
241		494
242	The following subroutines can be declared in extension files, and will be	495	The following subroutines can be declared in extension files, and will be
243	called whenever the relevant event happens.	496	called whenever the relevant event happens.
244		497
245	The first argument passed to them is an extension oject as described in	498	The first argument passed to them is an extension object as described in
246	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
247		500
248	B<All> of these hooks must return a boolean value. If it is true, then the	501	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	502	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.	503	relevant action might not be carried out by the C++ code.
251		504
252	I<< When in doubt, return a false value (preferably C<()>). >>	505	I<< When in doubt, return a false value (preferably C<()>). >>
253		506
254	=over 4	507	=over 4
255		508
256	=item on_init $term	509	=item on_init $term
257		510
258	Called after a new terminal object has been initialized, but before	511	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	512	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	513	call or deliver senseless data, as terminal size and other characteristics
261	have not yet been determined. You can safely query and change resources,	514	have not yet been determined. You can safely query and change resources
262	though.	515	and options, though. For many purposes the C<on_start> hook is a better
		516	place.
		517
		518	=item on_start $term
		519
		520	Called at the very end of initialisation of a new terminal, just before
		521	trying to map (display) the toplevel and returning to the main loop.
		522
		523	=item on_destroy $term
		524
		525	Called whenever something tries to destroy terminal, when the terminal is
		526	still fully functional (not for long, though).
263		527
264	=item on_reset $term	528	=item on_reset $term
265		529
266	Called after the screen is "reset" for any reason, such as resizing or	530	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	531	control sequences. Here is where you can react on changes to size-related
268	variables.	532	variables.
269		533
270	=item on_start $term	534	=item on_child_start $term, $pid
271		535
272	Called at the very end of initialisation of a new terminal, just before	536	Called just after the child process has been C<fork>ed.
273	returning to the mainloop.	537
		538	=item on_child_exit $term, $status
		539
		540	Called just after the child process has exited. C<$status> is the status
		541	from C<waitpid>.
274		542
275	=item on_sel_make $term, $eventtime	543	=item on_sel_make $term, $eventtime
276		544
277	Called whenever a selection has been made by the user, but before the	545	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	546	selection text is copied, so changes to the beginning, end or type of the
…		…
285		553
286	Called whenever a selection has been copied, but before the selection is	554	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	555	requested from the server. The selection text can be queried and changed
288	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
289		557
290	Returning a true value aborts selection grabbing. It will still be hilighted.	558	Returning a true value aborts selection grabbing. It will still be highlighted.
291		559
292	=item on_sel_extend $term	560	=item on_sel_extend $term
293		561
294	Called whenever the user tries to extend the selection (e.g. with a double	562	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	563	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	564	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	565	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	566	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.	567	supposed to enlarge the selection more and more, if possible.
300		568
301	See the F<selection> example extension.	569	See the F<selection> example extension.
302		570
303	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
304		572
305	Called whenever the view offset changes, i..e the user or program	573	Called whenever the view offset changes, i.e. the user or program
306	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
307	show this many lines of scrollback.	575	show this many lines of scrollback.
308		576
309	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
310		578
…		…
314		582
315	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	583	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	584	$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.	585	number of lines that will be in the scrollback buffer.
318		586
319	=item on_osc_seq $term, $string	587	=item on_osc_seq $term, $op, $args, $resp
		588
		589	Called on every OSC sequence and can be used to suppress it or modify its
		590	behaviour. The default should be to return an empty list. A true value
		591	suppresses execution of the request completely. Make sure you don't get
		592	confused by recursive invocations when you output an OSC sequence within
		593	this callback.
		594
		595	C<on_osc_seq_perl> should be used for new behaviour.
		596
		597	=item on_osc_seq_perl $term, $args, $resp
320		598
321	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
322	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
323	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
324	string should start with the extension name and a colon, to distinguish	602	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	603	to distinguish it from commands for other extensions, and this might be
326	future.	604	enforced in the future.
		605
		606	For example, C<overlay-osc> uses this:
		607
		608	sub on_osc_seq_perl {
		609	my ($self, $osc, $resp) = @_;
		610
		611	return unless $osc =~ s/^overlay;//;
		612
		613	... process remaining $osc string
		614	}
327		615
328	Be careful not ever to trust (in a security sense) the data you receive,	616	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	617	as its source can not easily be controlled (e-mail content, messages from
330	other users on the same system etc.).	618	other users on the same system etc.).
		619
		620	For responses, C<$resp> contains the end-of-args separator used by the
		621	sender.
331		622
332	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
333		624
334	Called whenever text is about to be output, with the text as argument. You	625	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	626	can filter/change and output the text yourself by returning a true value
…		…
340	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
341		632
342	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
343	suppress or filter tty input.	634	suppress or filter tty input.
344		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
345	=item on_line_update $term, $row	643	=item on_line_update $term, $row
346		644
347	Called whenever a line was updated or changed. Can be used to filter	645	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	646	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,	647	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	654	later with the already-modified line (e.g. if unrelated parts change), so
357	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
358		656
359	=item on_refresh_begin $term	657	=item on_refresh_begin $term
360		658
361	Called just before the screen gets redrawn. Can be used for overlay	659	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	660	similar effects by modifying the terminal contents in refresh_begin, and
363	restoring them in refresh_end. The built-in overlay and selection display	661	restoring them in refresh_end. The built-in overlay and selection display
364	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
365		663
366	=item on_refresh_end $term	664	=item on_refresh_end $term
367		665
368	Called just after the screen gets redrawn. See C<on_refresh_begin>.	666	Called just after the screen gets redrawn. See C<on_refresh_begin>.
369		667
370	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
371		669
372	Called whenever the user presses a key combination that has a	670	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>	671	a C<perl:string> action bound to a key, see description of the B<keysym>
374	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
		673
		674	The event is simply the action string. This interface is assumed to change
		675	slightly in the future.
		676
		677	=item on_register_command $term, $keysym, $modifiermask, $string
		678
		679	Called after parsing a keysym resource but before registering the
		680	associated binding. If this hook returns TRUE the binding is not
		681	registered. It can be used to modify a binding by calling
		682	C<register_command>.
		683
		684	=item on_resize_all_windows $term, $new_width, $new_height
		685
		686	Called just after the new window size has been calculated, but before
		687	windows are actually being resized or hints are being set. If this hook
		688	returns TRUE, setting of the window hints is being skipped.
		689
		690	=item on_x_event $term, $event
		691
		692	Called on every X event received on the vt window (and possibly other
		693	windows). Should only be used as a last resort. Most event structure
		694	members are not passed.
		695
		696	=item on_root_event $term, $event
		697
		698	Like C<on_x_event>, but is called for events on the root window.
375		699
376	=item on_focus_in $term	700	=item on_focus_in $term
377		701
378	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
379	does focus in processing.	703	does focus in processing.
380		704
381	=item on_focus_out $term	705	=item on_focus_out $term
382		706
383	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
384	focus out processing.	708	focus out processing.
385		709
		710	=item on_configure_notify $term, $event
		711
		712	=item on_property_notify $term, $event
		713
386	=item on_key_press $term, $event, $keysym, $octets	714	=item on_key_press $term, $event, $keysym, $octets
387		715
388	=item on_key_release $term, $event, $keysym	716	=item on_key_release $term, $event, $keysym
389		717
390	=item on_button_press $term, $event	718	=item on_button_press $term, $event
…		…
395		723
396	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
397		725
398	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
399		727
400	Called whenever the corresponding X event is received for the terminal If	728	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.	729	the hook returns true, then the event will be ignored by rxvt-unicode.
402		730
403	The event is a hash with most values as named by Xlib (see the XEvent	731	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	732	manpage), with the additional members C<row> and C<col>, which are the
405	and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
406		734
407	C<on_key_press> additionally receives the string rxvt-unicode would	735	C<on_key_press> additionally receives the string rxvt-unicode would
408	output, if any, in locale-specific encoding.	736	output, if any, in locale-specific encoding.
409		737
410	subwindow.	738	subwindow.
		739
		740	=item on_client_message $term, $event
		741
		742	=item on_wm_protocols $term, $event
		743
		744	=item on_wm_delete_window $term, $event
		745
		746	Called when various types of ClientMessage events are received (all with
		747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
411		752
412	=back	753	=back
413		754
414	=cut	755	=cut
415		756
…		…
421	use Scalar::Util ();	762	use Scalar::Util ();
422	use List::Util ();	763	use List::Util ();
423		764
424	our $VERSION = 1;	765	our $VERSION = 1;
425	our $TERM;	766	our $TERM;
		767	our @TERM_INIT;
		768	our @TERM_EXT;
426	our @HOOKNAME;	769	our @HOOKNAME;
427	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
428	our %OPTION;	771	our %OPTION;
429		772
430	our $LIBDIR;	773	our $LIBDIR;
431	our $RESNAME;	774	our $RESNAME;
432	our $RESCLASS;	775	our $RESCLASS;
433	our $RXVTNAME;	776	our $RXVTNAME;
434		777
		778	our $NOCHAR = chr 0xffff;
		779
435	=head2 Variables in the C<urxvt> Package	780	=head2 Variables in the C<urxvt> Package
436		781
437	=over 4	782	=over 4
438		783
439	=item $urxvt::LIBDIR	784	=item $urxvt::LIBDIR
…		…
452	=item $urxvt::TERM	797	=item $urxvt::TERM
453		798
454	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
455	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
456		801
		802	=item @urxvt::TERM_INIT
		803
		804	All code references in this array will be called as methods of the next newly
		805	created C<urxvt::term> object (during the C<on_init> phase). The array
		806	gets cleared before the code references that were in it are being executed,
		807	so references can push themselves onto it again if they so desire.
		808
		809	This complements to the perl-eval command line option, but gets executed
		810	first.
		811
		812	=item @urxvt::TERM_EXT
		813
		814	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		815	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		816	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		817
457	=back	818	=back
458		819
459	=head2 Functions in the C<urxvt> Package	820	=head2 Functions in the C<urxvt> Package
460		821
461	=over 4	822	=over 4
462		823
463	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
464		825
465	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
466	costs! The only time this is acceptable is when the terminal process	827	include a trailing newline). Avoid at all costs! The only time this
467	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
468		830
469	=item urxvt::warn $string	831	=item urxvt::warn $string
470		832
471	Calls C<rxvt_warn> with the given string which should not include a	833	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	834	newline. The module also overwrites the C<warn> builtin with a function
473	that calls this function.	835	that calls this function.
474		836
475	Using this function has the advantage that its output ends up in the	837	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.	838	correct place, e.g. on stderr of the connecting urxvtc client.
477		839
478	Messages have a size limit of 1023 bytes currently.	840	Messages have a size limit of 1023 bytes currently.
479		841
480	=item $is_safe = urxvt::safe	842	=item @terms = urxvt::termlist
481		843
482	Returns true when it is safe to do potentially unsafe things, such as	844	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	845	whether they are started, being destroyed etc., so be careful. Only term
484	started setuid or setgid.	846	objects that have perl extensions attached will be returned (because there
		847	is no urxvt::term object associated with others).
485		848
486	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
487		850
488	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
489		852
490	=item urxvt::CurrentTime	853	=item urxvt::CurrentTime
491		854
492	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	855	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
493	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	856	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
494	Button4Mask, Button5Mask, AnyModifier	857	Button4Mask, Button5Mask, AnyModifier
		858
		859	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		860	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		861	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		862	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		863	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		864	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		865	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		866
		867	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		868	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		869	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		870	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		871	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		872	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		873	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
495		874
496	Various constants for use in X calls and event processing.	875	Various constants for use in X calls and event processing.
497		876
498	=back	877	=back
499		878
…		…
516		895
517	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
518		897
519	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
520		899
521	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
522		902
523	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
524	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
525	the bitset.	905	the bitset.
526		906
…		…
532		912
533	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
534		914
535	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	915	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
536		916
		917	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		918
537	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
538	specified one.	920	specified one.
539		921
540	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
541		923
…		…
550	=back	932	=back
551		933
552	=cut	934	=cut
553		935
554	BEGIN {	936	BEGIN {
555	urxvt->bootstrap;
556
557	# overwrite perl's warn	937	# overwrite perl's warn
558	*CORE::GLOBAL::warn = sub {	938	*CORE::GLOBAL::warn = sub {
559	my $msg = join "", @_;	939	my $msg = join "", @_;
560	$msg .= "\n"	940	$msg .= "\n"
561	unless $msg =~ /\n$/;	941	unless $msg =~ /\n$/;
562	urxvt::warn ($msg);	942	urxvt::warn ($msg);
563	};	943	};
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	}	944	}
571		945
572	my @hook_count;	946	no warnings 'utf8';
		947
		948	sub perl_libdirs {
		949	map { split /:/ }
		950	$_[0]->resource ("perl_lib"),
		951	$ENV{URXVT_PERL_LIB},
		952	"$ENV{HOME}/.urxvt/ext",
		953	"$LIBDIR/perl"
		954	}
		955
		956	our %META; # meta header information from scripts
		957	our %SCAN; # which dirs already scanned
		958
		959	sub resource {
		960	my ($term, $name, $isarg, $flag, $value) = @_;
		961
		962	for my $dir (perl_libdirs $term) {
		963	}
		964
		965	warn "resourece<@_>\n";#d#
		966
		967	0
		968	}
		969
573	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	970	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
574		971
575	sub verbose {	972	sub verbose {
576	my ($level, $msg) = @_;	973	my ($level, $msg) = @_;
577	warn "$msg\n" if $level <= $verbosity;	974	warn "$msg\n" if $level <= $verbosity;
578	}	975	}
579		976
580	my $extension_pkg = "extension0000";
581	my %extension_pkg;	977	my %extension_pkg;
582		978
583	# load a single script into its own package, once only	979	# load a single script into its own package, once only
584	sub extension_package($) {	980	sub extension_package($) {
585	my ($path) = @_;	981	my ($path) = @_;
586		982
587	$extension_pkg{$path} ||= do {	983	$extension_pkg{$path} ||= do {
588	my $pkg = "urxvt::" . ($extension_pkg++);	984	$path =~ /([^\/\\]+)$/;
		985	my $pkg = $1;
		986	$pkg =~ s/[^[:word:]]/_/g;
		987	$pkg = "urxvt::ext::$pkg";
589		988
590	verbose 3, "loading extension '$path' into package '$pkg'";	989	verbose 3, "loading extension '$path' into package '$pkg'";
591		990
592	open my $fh, "<:raw", $path	991	open my $fh, "<:raw", $path
593	or die "$path: $!";	992	or die "$path: $!";
594		993
595	my $source = untaint	994	my $source =
596	"package $pkg; use strict; use utf8;\n"	995	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
597	. "use base urxvt::term::extension::;\n"
598	. "#line 1 \"$path\"\n{\n"	996	. "#line 1 \"$path\"\n{\n"
599	. (do { local $/; <$fh> })	997	. (do { local $/; <$fh> })
600	. "\n};\n1";	998	. "\n};\n1";
601		999
602	eval $source	1000	eval $source
…		…
612	sub invoke {	1010	sub invoke {
613	local $TERM = shift;	1011	local $TERM = shift;
614	my $htype = shift;	1012	my $htype = shift;
615		1013
616	if ($htype == 0) { # INIT	1014	if ($htype == 0) { # INIT
617	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1015	my @dirs = perl_libdirs $TERM;
618		1016
619	my %ext_arg;	1017	my %ext_arg;
620		1018
		1019	{
		1020	my @init = @TERM_INIT;
		1021	@TERM_INIT = ();
		1022	$_->($TERM) for @init;
		1023	my @pkg = @TERM_EXT;
		1024	@TERM_EXT = ();
		1025	$TERM->register_package ($_) for @pkg;
		1026	}
		1027
621	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1028	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
622	if ($_ eq "default") {	1029	if ($_ eq "default") {
623	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	1030	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
624	} elsif (/^-(.*)$/) {	1031	} elsif (/^-(.*)$/) {
625	delete $ext_arg{$1};	1032	delete $ext_arg{$1};
626	} elsif (/^([^<]+)<(.*)>$/) {	1033	} elsif (/^([^<]+)<(.*)>$/) {
627	push @{ $ext_arg{$1} }, $2;	1034	push @{ $ext_arg{$1} }, $2;
628	} else {	1035	} else {
629	$ext_arg{$_} ||= [];	1036	$ext_arg{$_} ||= [];
630	}	1037	}
631	}	1038	}
632		1039
633	while (my ($ext, $argv) = each %ext_arg) {	1040	for my $ext (sort keys %ext_arg) {
634	my @files = grep -f $_, map "$_/$ext", @dirs;	1041	my @files = grep -f $_, map "$_/$ext", @dirs;
635		1042
636	if (@files) {	1043	if (@files) {
637	$TERM->register_package (extension_package $files[0], $argv);	1044	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
638	} else {	1045	} else {
639	warn "perl extension '$ext' not found in perl library search path\n";	1046	warn "perl extension '$ext' not found in perl library search path\n";
640	}	1047	}
641	}	1048	}
642		1049
…		…
648		1055
649	if (my $cb = $TERM->{_hook}[$htype]) {	1056	if (my $cb = $TERM->{_hook}[$htype]) {
650	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1057	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
651	if $verbosity >= 10;	1058	if $verbosity >= 10;
652		1059
653	keys %$cb;	1060	for my $pkg (keys %$cb) {
654
655	while (my ($pkg, $cb) = each %$cb) {
656	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1061	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
657	and last;	1062	$retval ||= $retval_;
658		1063
659	if ($@) {	1064	if ($@) {
660	$TERM->ungrab; # better to lose the grab than the session	1065	$TERM->ungrab; # better to lose the grab than the session
661	warn $@;	1066	warn $@;
662	}	1067	}
…		…
665	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	1070	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
666	if $verbosity >= 11;	1071	if $verbosity >= 11;
667	}	1072	}
668		1073
669	if ($htype == 1) { # DESTROY	1074	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	1075	# clear package objects
678	%$_ = () for values %{ $TERM->{_pkg} };	1076	%$_ = () for values %{ $TERM->{_pkg} };
679		1077
680	# clear package	1078	# clear package
681	%$TERM = ();	1079	%$TERM = ();
682	}	1080	}
683		1081
684	$retval	1082	$retval
685	}	1083	}
686		1084
687	sub exec_async(@) {	1085	sub SET_COLOR($$$) {
688	my $pid = fork;	1086	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1087	}
689		1088
690	return	1089	sub rend2mask {
691	if !defined $pid or $pid;	1090	no strict 'refs';
692		1091	my ($str, $mask) = (@_, 0);
693	%ENV = %{ $TERM->env };	1092	my %color = ( fg => undef, bg => undef );
694		1093	my @failed;
695	exec @_;	1094	for my $spec ( split /\s+/, $str ) {
696	_exit 255;	1095	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1096	$color{lc($1)} = $2;
		1097	} else {
		1098	my $neg = $spec =~ s/^[-^]//;
		1099	unless ( exists &{"RS_$spec"} ) {
		1100	push @failed, $spec;
		1101	next;
		1102	}
		1103	my $cur = &{"RS_$spec"};
		1104	if ( $neg ) {
		1105	$mask &= ~$cur;
		1106	} else {
		1107	$mask |= $cur;
		1108	}
		1109	}
		1110	}
		1111	($mask, @color{qw(fg bg)}, \@failed)
697	}	1112	}
698		1113
699	# urxvt::term::extension	1114	# urxvt::term::extension
700		1115
701	package urxvt::term::extension;	1116	package urxvt::term::extension;
…		…
707	while (my ($name, $cb) = each %hook) {	1122	while (my ($name, $cb) = each %hook) {
708	my $htype = $HOOKTYPE{uc $name};	1123	my $htype = $HOOKTYPE{uc $name};
709	defined $htype	1124	defined $htype
710	or Carp::croak "unsupported hook type '$name'";	1125	or Carp::croak "unsupported hook type '$name'";
711		1126
		1127	$self->set_should_invoke ($htype, +1)
712	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1128	unless exists $self->{term}{_hook}[$htype]{$pkg};
713	$hook_count[$htype]++
714	or urxvt::set_should_invoke $htype, 1;
715	}
716		1129
717	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1130	$self->{term}{_hook}[$htype]{$pkg} = $cb;
718	}	1131	}
719	}	1132	}
720		1133
…		…
725	for my $name (@hook) {	1138	for my $name (@hook) {
726	my $htype = $HOOKTYPE{uc $name};	1139	my $htype = $HOOKTYPE{uc $name};
727	defined $htype	1140	defined $htype
728	or Carp::croak "unsupported hook type '$name'";	1141	or Carp::croak "unsupported hook type '$name'";
729		1142
		1143	$self->set_should_invoke ($htype, -1)
730	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1144	if delete $self->{term}{_hook}[$htype]{$pkg};
731	--$hook_count[$htype]
732	or urxvt::set_should_invoke $htype, 0;
733	}
734	}	1145	}
735	}	1146	}
736		1147
737	our $AUTOLOAD;	1148	our $AUTOLOAD;
738		1149
…		…
776	is that you cannot use blocking APIs, but the non-blocking variant should	1187	is that you cannot use blocking APIs, but the non-blocking variant should
777	work.	1188	work.
778		1189
779	=cut	1190	=cut
780		1191
781	our $VERSION = 1;	1192	our $VERSION = '5.23';
782		1193
783	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1194	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
784	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1195	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
785		1196
786	sub timer {	1197	sub timer {
…		…
788		1199
789	my $cb = $arg{cb};	1200	my $cb = $arg{cb};
790		1201
791	urxvt::timer	1202	urxvt::timer
792	->new	1203	->new
793	->start (urxvt::NOW + $arg{after})	1204	->after ($arg{after}, $arg{interval})
794	->cb (sub {	1205	->cb ($arg{interval} ? $cb : sub {
795	$_[0]->stop; # need to cancel manually	1206	$_[0]->stop; # need to cancel manually
796	$cb->();	1207	$cb->();
797	})	1208	})
798	}	1209	}
799		1210
800	sub io {	1211	sub io {
801	my ($class, %arg) = @_;	1212	my ($class, %arg) = @_;
802		1213
803	my $cb = $arg{cb};	1214	my $cb = $arg{cb};
		1215	my $fd = fileno $arg{fh};
		1216	defined $fd or $fd = $arg{fh};
804		1217
805	bless [$arg{fh}, urxvt::iow	1218	bless [$arg{fh}, urxvt::iow
806	->new	1219	->new
807	->fd (fileno $arg{fh})	1220	->fd ($fd)
808	->events (($arg{poll} =~ /r/ ? 1 : 0)	1221	->events (($arg{poll} =~ /r/ ? 1 : 0)
809	| ($arg{poll} =~ /w/ ? 2 : 0))	1222	| ($arg{poll} =~ /w/ ? 2 : 0))
810	->start	1223	->start
811	->cb (sub {	1224	->cb ($cb)
812	$cb->(($_[1] & 1 ? 'r' : '')
813	. ($_[1] & 2 ? 'w' : ''));
814	})],
815	urxvt::anyevent::	1225	], urxvt::anyevent::
		1226	}
		1227
		1228	sub idle {
		1229	my ($class, %arg) = @_;
		1230
		1231	my $cb = $arg{cb};
		1232
		1233	urxvt::iw
		1234	->new
		1235	->start
		1236	->cb ($cb)
		1237	}
		1238
		1239	sub child {
		1240	my ($class, %arg) = @_;
		1241
		1242	my $cb = $arg{cb};
		1243
		1244	urxvt::pw
		1245	->new
		1246	->start ($arg{pid})
		1247	->cb (sub {
		1248	$_[0]->stop; # need to cancel manually
		1249	$cb->($_[0]->rpid, $_[0]->rstatus);
		1250	})
816	}	1251	}
817		1252
818	sub DESTROY {	1253	sub DESTROY {
819	$_[0][1]->stop;	1254	$_[0][1]->stop;
820	}	1255	}
821		1256
822	sub condvar {	1257	# only needed for AnyEvent < 6 compatibility
823	bless \my $flag, urxvt::anyevent::condvar::	1258	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";	1259	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
833	}
834	}	1260	}
835		1261
836	package urxvt::term;	1262	package urxvt::term;
837		1263
838	=head2 The C<urxvt::term> Class	1264	=head2 The C<urxvt::term> Class
…		…
843		1269
844	# find on_xxx subs in the package and register them	1270	# find on_xxx subs in the package and register them
845	# as hooks	1271	# as hooks
846	sub register_package {	1272	sub register_package {
847	my ($self, $pkg, $argv) = @_;	1273	my ($self, $pkg, $argv) = @_;
		1274
		1275	no strict 'refs';
		1276
		1277	urxvt::verbose 6, "register package $pkg to $self";
		1278
		1279	@{"$pkg\::ISA"} = urxvt::term::extension::;
848		1280
849	my $proxy = bless {	1281	my $proxy = bless {
850	_pkg => $pkg,	1282	_pkg => $pkg,
851	argv => $argv,	1283	argv => $argv,
852	}, $pkg;	1284	}, $pkg;
…		…
868	hash which defines the environment of the new terminal.	1300	hash which defines the environment of the new terminal.
869		1301
870	Croaks (and probably outputs an error message) if the new instance	1302	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	1303	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	1304	initialise perl, and the terminal object otherwise. The C<init> and
873	C<start> hooks will be called during this call.	1305	C<start> hooks will be called before this call returns, and are free to
		1306	refer to global data (which is race free).
874		1307
875	=cut	1308	=cut
876		1309
877	sub new {	1310	sub new {
878	my ($class, $env, @args) = @_;	1311	my ($class, $env, @args) = @_;
879		1312
		1313	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1314	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1315
880	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1316	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
881	}	1317	}
882		1318
883	=item $term->destroy	1319	=item $term->destroy
884		1320
885	Destroy the terminal object (close the window, free resources	1321	Destroy the terminal object (close the window, free resources
886	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1322	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
887	watchers (timers, io watchers) are still active.	1323	watchers (timers, io watchers) are still active.
888		1324
		1325	=item $term->exec_async ($cmd[, @args])
		1326
		1327	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1328	("starts") programs in the background. This function takes care of setting
		1329	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1330	be preferred over explicit calls to C<exec> or C<system>.
		1331
		1332	Returns the pid of the subprocess or C<undef> on error.
		1333
		1334	=cut
		1335
		1336	sub exec_async {
		1337	my $self = shift;
		1338
		1339	my $pid = fork;
		1340
		1341	return $pid
		1342	if !defined $pid or $pid;
		1343
		1344	%ENV = %{ $self->env };
		1345
		1346	exec @_;
		1347	urxvt::_exit 255;
		1348	}
		1349
889	=item $isset = $term->option ($optval[, $set])	1350	=item $isset = $term->option ($optval[, $set])
890		1351
891	Returns true if the option specified by C<$optval> is enabled, and	1352	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	1353	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.	1354	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
894		1355
895	Here is a a likely non-exhaustive list of option names, please see the	1356	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:	1357	source file F</src/optinc.h> to see the actual list:
897		1358
898	borderLess console cursorBlink cursorUnderline hold iconic insecure	1359	borderLess buffered console cursorBlink cursorUnderline hold iconic
899	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1360	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1361	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
900	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1362	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
901	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1363	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
902	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1364	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
903	tripleclickwords utmpInhibit visualBell	1365	urgentOnBell utmpInhibit visualBell
904		1366
905	=item $value = $term->resource ($name[, $newval])	1367	=item $value = $term->resource ($name[, $newval])
906		1368
907	Returns the current resource value associated with a given name and	1369	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>	1370	optionally sets a new value. Setting values is most useful in the C<init>
…		…
917	likely change).	1379	likely change).
918		1380
919	Please note that resource strings will currently only be freed when the	1381	Please note that resource strings will currently only be freed when the
920	terminal is destroyed, so changing options frequently will eat memory.	1382	terminal is destroyed, so changing options frequently will eat memory.
921		1383
922	Here is a a likely non-exhaustive list of resource names, not all of which	1384	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>	1385	are supported in every build, please see the source file F</src/rsinc.h>
924	to see the actual list:	1386	to see the actual list:
925		1387
926	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1388	answerbackstring backgroundPixmap backspace_key blendtype blurradius
927	borderLess color cursorBlink cursorUnderline cutchars delete_key	1389	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
928	display_name embed ext_bwidth fade font geometry hold iconName	1390	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
929	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1391	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1392	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
930	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1393	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
931	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1394	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
932	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1395	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
933	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1396	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
934	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1397	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
935	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1398	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
936	shade term_name title transparent transparent_all tripleclickwords	1399	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1400	term_name title transient_for transparent tripleclickwords urgentOnBell
937	utmpInhibit visualBell	1401	utmpInhibit visualBell
938		1402
939	=cut	1403	=cut
940		1404
941	sub resource($$;$) {	1405	sub resource($$;$) {
942	my ($self, $name) = (shift, shift);	1406	my ($self, $name) = (shift, shift);
943	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1407	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
944	&urxvt::term::_resource	1408	goto &urxvt::term::_resource
945	}	1409	}
946		1410
947	=item $value = $term->x_resource ($pattern)	1411	=item $value = $term->x_resource ($pattern)
948		1412
949	Returns the X-Resource for the given pattern, excluding the program or	1413	Returns the X-Resource for the given pattern, excluding the program or
…		…
953		1417
954	This method should only be called during the C<on_start> hook, as there is	1418	This method should only be called during the C<on_start> hook, as there is
955	only one resource database per display, and later invocations might return	1419	only one resource database per display, and later invocations might return
956	the wrong resources.	1420	the wrong resources.
957		1421
958	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1422	=item $success = $term->parse_keysym ($key, $octets)
959		1423
960	Adds a keymap translation exactly as specified via a resource. See the	1424	Adds a key binding exactly as specified via a resource. See the
961	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1425	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1426
		1427	=item $term->register_command ($keysym, $modifiermask, $string)
		1428
		1429	Adds a key binding. This is a lower level api compared to
		1430	C<parse_keysym>, as it expects a parsed key description, and can be
		1431	used only inside either the C<on_init> hook, to add a binding, or the
		1432	C<on_register_command> hook, to modify a parsed binding.
962		1433
963	=item $rend = $term->rstyle ([$new_rstyle])	1434	=item $rend = $term->rstyle ([$new_rstyle])
964		1435
965	Return and optionally change the current rendition. Text that is output by	1436	Return and optionally change the current rendition. Text that is output by
966	the terminal application will use this style.	1437	the terminal application will use this style.
…		…
974		1445
975	=item ($row, $col) = $term->selection_beg ([$row, $col])	1446	=item ($row, $col) = $term->selection_beg ([$row, $col])
976		1447
977	=item ($row, $col) = $term->selection_end ([$row, $col])	1448	=item ($row, $col) = $term->selection_end ([$row, $col])
978		1449
979	Return the current values of the selection mark, begin or end positions,	1450	Return the current values of the selection mark, begin or end positions.
980	and optionally set them to new values.	1451
		1452	When arguments are given, then the selection coordinates are set to
		1453	C<$row> and C<$col>, and the selection screen is set to the current
		1454	screen.
		1455
		1456	=item $screen = $term->selection_screen ([$screen])
		1457
		1458	Returns the current selection screen, and then optionally sets it.
981		1459
982	=item $term->selection_make ($eventtime[, $rectangular])	1460	=item $term->selection_make ($eventtime[, $rectangular])
983		1461
984	Tries to make a selection as set by C<selection_beg> and	1462	Tries to make a selection as set by C<selection_beg> and
985	C<selection_end>. If C<$rectangular> is true (default: false), a	1463	C<selection_end>. If C<$rectangular> is true (default: false), a
986	rectangular selection will be made. This is the prefered function to make	1464	rectangular selection will be made. This is the preferred function to make
987	a selection.	1465	a selection.
988		1466
989	=item $success = $term->selection_grab ($eventtime)	1467	=item $success = $term->selection_grab ($eventtime[, $clipboard])
990		1468
991	Try to request the primary selection text from the server (for example, as	1469	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1470	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	1471	with the next method. No visual feedback will be given. This function
993	is mostly useful from within C<on_sel_grab> hooks.	1472	is mostly useful from within C<on_sel_grab> hooks.
994		1473
995	=item $oldtext = $term->selection ([$newtext])	1474	=item $oldtext = $term->selection ([$newtext, $clipboard])
996		1475
997	Return the current selection text and optionally replace it by C<$newtext>.	1476	Return the current selection (clipboard if C<$clipboard> is true) text
		1477	and optionally replace it by C<$newtext>.
		1478
		1479	=item $term->selection_clear ([$clipboard])
		1480
		1481	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
998		1482
999	=item $term->overlay_simple ($x, $y, $text)	1483	=item $term->overlay_simple ($x, $y, $text)
1000		1484
1001	Create a simple multi-line overlay box. See the next method for details.	1485	Create a simple multi-line overlay box. See the next method for details.
1002		1486
…		…
1032		1516
1033	The methods currently supported on C<urxvt::overlay> objects are:	1517	The methods currently supported on C<urxvt::overlay> objects are:
1034		1518
1035	=over 4	1519	=over 4
1036		1520
1037	=item $overlay->set ($x, $y, $text, $rend)	1521	=item $overlay->set ($x, $y, $text[, $rend])
1038		1522
1039	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1523	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	1524	text in rxvt-unicode's special encoding and an array of rendition values
1041	at a specific position inside the overlay.	1525	at a specific position inside the overlay.
		1526
		1527	If C<$rend> is missing, then the rendition will not be changed.
1042		1528
1043	=item $overlay->hide	1529	=item $overlay->hide
1044		1530
1045	If visible, hide the overlay, but do not destroy it.	1531	If visible, hide the overlay, but do not destroy it.
1046		1532
…		…
1116		1602
1117	Normally its not a good idea to use this function, as programs might be	1603	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	1604	confused by changes in cursor position or scrolling. Its useful inside a
1119	C<on_add_lines> hook, though.	1605	C<on_add_lines> hook, though.
1120		1606
		1607	=item $term->scr_change_screen ($screen)
		1608
		1609	Switch to given screen - 0 primary, 1 secondary.
		1610
1121	=item $term->cmd_parse ($octets)	1611	=item $term->cmd_parse ($octets)
1122		1612
1123	Similar to C<scr_add_lines>, but the argument must be in the	1613	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	1614	locale-specific encoding of the terminal and can contain command sequences
1125	(escape codes) that will be interpreted.	1615	(escape codes) that will be interpreted.
1126		1616
1127	=item $term->tt_write ($octets)	1617	=item $term->tt_write ($octets)
1128		1618
1129	Write the octets given in C<$data> to the tty (i.e. as program input). To	1619	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	1620	pass characters instead of octets, you should convert your strings first
1131	to the locale-specific encoding using C<< $term->locale_encode >>.	1621	to the locale-specific encoding using C<< $term->locale_encode >>.
		1622
		1623	=item $term->tt_paste ($octets)
		1624
		1625	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1626	CR and bracketing the data with control sequences if bracketed paste mode
		1627	is set.
1132		1628
1133	=item $old_events = $term->pty_ev_events ([$new_events])	1629	=item $old_events = $term->pty_ev_events ([$new_events])
1134		1630
1135	Replaces the event mask of the pty watcher by the given event mask. Can	1631	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	1632	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	1633	description of C<< urxvt::timer->events >>. Make sure to always restore
1138	the previous value.	1634	the previous value.
1139		1635
		1636	=item $fd = $term->pty_fd
		1637
		1638	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1639	is used.
		1640
1140	=item $windowid = $term->parent	1641	=item $windowid = $term->parent
1141		1642
1142	Return the window id of the toplevel window.	1643	Return the window id of the toplevel window.
1143		1644
1144	=item $windowid = $term->vt	1645	=item $windowid = $term->vt
1145		1646
1146	Return the window id of the terminal window.	1647	Return the window id of the terminal window.
1147		1648
		1649	=item $term->vt_emask_add ($x_event_mask)
		1650
		1651	Adds the specified events to the vt event mask. Useful e.g. when you want
		1652	to receive pointer events all the times:
		1653
		1654	$term->vt_emask_add (urxvt::PointerMotionMask);
		1655
		1656	=item $term->set_urgency ($set)
		1657
		1658	Enable/disable the urgency hint on the toplevel window.
		1659
		1660	=item $term->focus_in
		1661
		1662	=item $term->focus_out
		1663
		1664	=item $term->key_press ($state, $keycode[, $time])
		1665
		1666	=item $term->key_release ($state, $keycode[, $time])
		1667
		1668	Deliver various fake events to to terminal.
		1669
1148	=item $window_width = $term->width	1670	=item $window_width = $term->width
1149		1671
1150	=item $window_height = $term->height	1672	=item $window_height = $term->height
1151		1673
1152	=item $font_width = $term->fwidth	1674	=item $font_width = $term->fwidth
…		…
1165		1687
1166	=item $max_scrollback = $term->saveLines	1688	=item $max_scrollback = $term->saveLines
1167		1689
1168	=item $nrow_plus_saveLines = $term->total_rows	1690	=item $nrow_plus_saveLines = $term->total_rows
1169		1691
1170	=item $lines_in_scrollback = $term->nsaved	1692	=item $topmost_scrollback_row = $term->top_row
1171		1693
1172	Return various integers describing terminal characteristics.	1694	Return various integers describing terminal characteristics.
1173		1695
1174	=item $x_display = $term->display_id	1696	=item $x_display = $term->display_id
1175		1697
…		…
1182	=item $env = $term->env	1704	=item $env = $term->env
1183		1705
1184	Returns a copy of the environment in effect for the terminal as a hashref	1706	Returns a copy of the environment in effect for the terminal as a hashref
1185	similar to C<\%ENV>.	1707	similar to C<\%ENV>.
1186		1708
		1709	=item @envv = $term->envv
		1710
		1711	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1712
		1713	=item @argv = $term->argv
		1714
		1715	Return the argument vector as this terminal, similar to @ARGV, but
		1716	includes the program name as first element.
		1717
1187	=cut	1718	=cut
1188		1719
1189	sub env {	1720	sub env {
1190	if (my $env = $_[0]->_env) {
1191	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1721	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1192	} else {
1193	+{ %ENV }
1194	}
1195	}	1722	}
1196		1723
1197	=item $modifiermask = $term->ModLevel3Mask	1724	=item $modifiermask = $term->ModLevel3Mask
1198		1725
1199	=item $modifiermask = $term->ModMetaMask	1726	=item $modifiermask = $term->ModMetaMask
…		…
1201	=item $modifiermask = $term->ModNumLockMask	1728	=item $modifiermask = $term->ModNumLockMask
1202		1729
1203	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1730	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.	1731	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1205		1732
		1733	=item $screen = $term->current_screen
		1734
		1735	Returns the currently displayed screen (0 primary, 1 secondary).
		1736
		1737	=item $cursor_is_hidden = $term->hidden_cursor
		1738
		1739	Returns whether the cursor is currently hidden or not.
		1740
1206	=item $view_start = $term->view_start ([$newvalue])	1741	=item $view_start = $term->view_start ([$newvalue])
1207		1742
1208	Returns the negative row number of the topmost line. Minimum value is	1743	Returns the row number of the topmost displayed line. Maximum value is
1209	C<0>, which displays the normal terminal contents. Larger values scroll	1744	C<0>, which displays the normal terminal contents. Lower values scroll
1210	this many lines into the scrollback buffer.	1745	this many lines into the scrollback buffer.
1211		1746
1212	=item $term->want_refresh	1747	=item $term->want_refresh
1213		1748
1214	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1749	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1217		1752
1218	Used after changing terminal contents to display them.	1753	Used after changing terminal contents to display them.
1219		1754
1220	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1755	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1221		1756
1222	Returns the text of the entire row with number C<$row_number>. Row C<0>	1757	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	1758	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	1759	terminal line. Nothing will be returned if a nonexistent line
1226	is requested.	1760	is requested.
1227		1761
1228	If C<$new_text> is specified, it will replace characters in the current	1762	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	1763	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	1764	to replace only parts of a line. The font index in the rendition will
1231	automatically be updated.	1765	automatically be updated.
1232		1766
1233	C<$text> is in a special encoding: tabs and wide characters that use more	1767	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	1768	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1235	(C<chr 65535>). Characters with combining characters and other characters	1769	characters. Characters with combining characters and other characters that
1236	that do not fit into the normal tetx encoding will be replaced with	1770	do not fit into the normal text encoding will be replaced with characters
1237	characters in the private use area.	1771	in the private use area.
1238		1772
1239	You have to obey this encoding when changing text. The advantage is	1773	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	1774	that C<substr> and similar functions work on screen cells and not on
1241	characters.	1775	characters.
1242		1776
…		…
1386	where one character corresponds to one screen cell. See	1920	where one character corresponds to one screen cell. See
1387	C<< $term->ROW_t >> for details.	1921	C<< $term->ROW_t >> for details.
1388		1922
1389	=item $string = $term->special_decode $text	1923	=item $string = $term->special_decode $text
1390		1924
1391	Converts rxvt-unicodes text reprsentation into a perl string. See	1925	Converts rxvt-unicodes text representation into a perl string. See
1392	C<< $term->ROW_t >> for details.	1926	C<< $term->ROW_t >> for details.
1393		1927
1394	=item $success = $term->grab_button ($button, $modifiermask)	1928	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1395		1929
		1930	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1931
1396	Registers a synchronous button grab. See the XGrabButton manpage.	1932	Register/unregister a synchronous button grab. See the XGrabButton
		1933	manpage.
1397		1934
1398	=item $success = $term->grab ($eventtime[, $sync])	1935	=item $success = $term->grab ($eventtime[, $sync])
1399		1936
1400	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1937	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1401	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1938	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1402		1939
1403	=item $term->allow_events_async	1940	=item $term->allow_events_async
1404		1941
1405	Calls XAllowEvents with AsyncBoth for the most recent grab.	1942	Calls XAllowEvents with AsyncBoth for the most recent grab.
1406		1943
…		…
1413	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1950	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1414	recent grab.	1951	recent grab.
1415		1952
1416	=item $term->ungrab	1953	=item $term->ungrab
1417		1954
1418	Calls XUngrab for the most recent grab. Is called automatically on	1955	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	1956	evaluation errors, as it is better to lose the grab in the error case as
1420	the session.	1957	the session.
		1958
		1959	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1960
		1961	=item $atom_name = $term->XGetAtomName ($atom)
		1962
		1963	=item @atoms = $term->XListProperties ($window)
		1964
		1965	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1966
		1967	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1968
		1969	=item $term->XDeleteProperty ($window, $property)
		1970
		1971	=item $window = $term->DefaultRootWindow
		1972
		1973	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1974
		1975	=item $term->XMapWindow ($window)
		1976
		1977	=item $term->XUnmapWindow ($window)
		1978
		1979	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1980
		1981	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1982
		1983	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1984
		1985	=item $keysym = $term->XStringToKeysym ($string)
		1986
		1987	=item $string = $term->XKeysymToString ($keysym)
		1988
		1989	Various X or X-related functions. The C<$term> object only serves as
		1990	the source of the display, otherwise those functions map more-or-less
		1991	directly onto the X functions of the same name.
1421		1992
1422	=back	1993	=back
1423		1994
1424	=cut	1995	=cut
1425		1996
…		…
1489	my ($self, $text, $cb) = @_;	2060	my ($self, $text, $cb) = @_;
1490		2061
1491	$self->add_item ({ type => "button", text => $text, activate => $cb});	2062	$self->add_item ({ type => "button", text => $text, activate => $cb});
1492	}	2063	}
1493		2064
1494	=item $popup->add_toggle ($text, $cb, $initial_value)	2065	=item $popup->add_toggle ($text, $initial_value, $cb)
1495		2066
1496	Adds a toggle/checkbox item to the popup. Teh callback gets called	2067	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	2068	whenever it gets toggled, with a boolean indicating its new value as its
1498	argument.	2069	first argument.
1499		2070
1500	=cut	2071	=cut
1501		2072
1502	sub add_toggle {	2073	sub add_toggle {
1503	my ($self, $text, $cb, $value) = @_;	2074	my ($self, $text, $value, $cb) = @_;
1504		2075
1505	my $item; $item = {	2076	my $item; $item = {
1506	type => "button",	2077	type => "button",
1507	text => " $text",	2078	text => " $text",
1508	value => $value,	2079	value => $value,
…		…
1527	my $env = $self->{term}->env;	2098	my $env = $self->{term}->env;
1528	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2099	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1529	delete $env->{LC_ALL};	2100	delete $env->{LC_ALL};
1530	$env->{LC_CTYPE} = $self->{term}->locale;	2101	$env->{LC_CTYPE} = $self->{term}->locale;
1531		2102
1532	urxvt::term->new ($env, $self->{term}->resource ("name"),	2103	my $term = urxvt::term->new (
1533	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2104	$env, "popup",
		2105	"--perl-lib" => "", "--perl-ext-common" => "",
		2106	"-pty-fd" => -1, "-sl" => 0,
		2107	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1534	"--transient-for" => $self->{term}->parent,	2108	"--transient-for" => $self->{term}->parent,
1535	"-display" => $self->{term}->display_id,	2109	"-display" => $self->{term}->display_id,
1536	"-pe" => "urxvt-popup")	2110	"-pe" => "urxvt-popup",
1537	or die "unable to create popup window\n";	2111	) or die "unable to create popup window\n";
		2112
		2113	unless (delete $term->{urxvt_popup_init_done}) {
		2114	$term->ungrab;
		2115	$term->destroy;
		2116	die "unable to initialise popup window\n";
		2117	}
1538	}	2118	}
1539		2119
1540	sub DESTROY {	2120	sub DESTROY {
1541	my ($self) = @_;	2121	my ($self) = @_;
1542		2122
1543	delete $self->{term}{_destroy}{$self};	2123	delete $self->{term}{_destroy}{$self};
1544	$self->{term}->ungrab;	2124	$self->{term}->ungrab;
1545	}	2125	}
1546		2126
1547	=back	2127	=back
		2128
		2129	=cut
		2130
		2131	package urxvt::watcher;
1548		2132
1549	=head2 The C<urxvt::timer> Class	2133	=head2 The C<urxvt::timer> Class
1550		2134
1551	This class implements timer watchers/events. Time is represented as a	2135	This class implements timer watchers/events. Time is represented as a
1552	fractional number of seconds since the epoch. Example:	2136	fractional number of seconds since the epoch. Example:
…		…
1556	->new	2140	->new
1557	->interval (1)	2141	->interval (1)
1558	->cb (sub {	2142	->cb (sub {
1559	$term->{overlay}->set (0, 0,	2143	$term->{overlay}->set (0, 0,
1560	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2144	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1561	});	2145	});
1562		2146
1563	=over 4	2147	=over 4
1564		2148
1565	=item $timer = new urxvt::timer	2149	=item $timer = new urxvt::timer
1566		2150
…		…
1569		2153
1570	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2154	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1571		2155
1572	Set the callback to be called when the timer triggers.	2156	Set the callback to be called when the timer triggers.
1573		2157
1574	=item $tstamp = $timer->at
1575
1576	Return the time this watcher will fire next.
1577
1578	=item $timer = $timer->set ($tstamp)	2158	=item $timer = $timer->set ($tstamp[, $interval])
1579		2159
1580	Set the time the event is generated to $tstamp.	2160	Set the time the event is generated to $tstamp (and optionally specifies a
		2161	new $interval).
1581		2162
1582	=item $timer = $timer->interval ($interval)	2163	=item $timer = $timer->interval ($interval)
1583		2164
1584	Normally (and when C<$interval> is C<0>), the timer will automatically	2165	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	2166	stop after it has fired once. If C<$interval> is non-zero, then the timer
1586	is automatically rescheduled at the given intervals.	2167	is automatically rescheduled at the given intervals.
1587		2168
1588	=item $timer = $timer->start	2169	=item $timer = $timer->start
1589		2170
1590	Start the timer.	2171	Start the timer.
1591		2172
1592	=item $timer = $timer->start ($tstamp)	2173	=item $timer = $timer->start ($tstamp[, $interval])
1593		2174
1594	Set the event trigger time to C<$tstamp> and start the timer.	2175	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2176	also replaces the interval.
		2177
		2178	=item $timer = $timer->after ($delay[, $interval])
		2179
		2180	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1595		2181
1596	=item $timer = $timer->stop	2182	=item $timer = $timer->stop
1597		2183
1598	Stop the timer.	2184	Stop the timer.
1599		2185
…		…
1605		2191
1606	$term->{socket} = ...	2192	$term->{socket} = ...
1607	$term->{iow} = urxvt::iow	2193	$term->{iow} = urxvt::iow
1608	->new	2194	->new
1609	->fd (fileno $term->{socket})	2195	->fd (fileno $term->{socket})
1610	->events (urxvt::EVENT_READ)	2196	->events (urxvt::EV_READ)
1611	->start	2197	->start
1612	->cb (sub {	2198	->cb (sub {
1613	my ($iow, $revents) = @_;	2199	my ($iow, $revents) = @_;
1614	# $revents must be 1 here, no need to check	2200	# $revents must be 1 here, no need to check
1615	sysread $term->{socket}, my $buf, 8192	2201	sysread $term->{socket}, my $buf, 8192
…		…
1628	Set the callback to be called when io events are triggered. C<$reventmask>	2214	Set the callback to be called when io events are triggered. C<$reventmask>
1629	is a bitset as described in the C<events> method.	2215	is a bitset as described in the C<events> method.
1630		2216
1631	=item $iow = $iow->fd ($fd)	2217	=item $iow = $iow->fd ($fd)
1632		2218
1633	Set the filedescriptor (not handle) to watch.	2219	Set the file descriptor (not handle) to watch.
1634		2220
1635	=item $iow = $iow->events ($eventmask)	2221	=item $iow = $iow->events ($eventmask)
1636		2222
1637	Set the event mask to watch. The only allowed values are	2223	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	2224	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1639	together, or C<urxvt::EVENT_NONE>.	2225	together, or C<urxvt::EV_NONE>.
1640		2226
1641	=item $iow = $iow->start	2227	=item $iow = $iow->start
1642		2228
1643	Start watching for requested events on the given handle.	2229	Start watching for requested events on the given handle.
1644		2230
1645	=item $iow = $iow->stop	2231	=item $iow = $iow->stop
1646		2232
1647	Stop watching for events on the given filehandle.	2233	Stop watching for events on the given file handle.
		2234
		2235	=back
		2236
		2237	=head2 The C<urxvt::iw> Class
		2238
		2239	This class implements idle watchers, that get called automatically when
		2240	the process is idle. They should return as fast as possible, after doing
		2241	some useful work.
		2242
		2243	=over 4
		2244
		2245	=item $iw = new urxvt::iw
		2246
		2247	Create a new idle watcher object in stopped state.
		2248
		2249	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2250
		2251	Set the callback to be called when the watcher triggers.
		2252
		2253	=item $timer = $timer->start
		2254
		2255	Start the watcher.
		2256
		2257	=item $timer = $timer->stop
		2258
		2259	Stop the watcher.
		2260
		2261	=back
		2262
		2263	=head2 The C<urxvt::pw> Class
		2264
		2265	This class implements process watchers. They create an event whenever a
		2266	process exits, after which they stop automatically.
		2267
		2268	my $pid = fork;
		2269	...
		2270	$term->{pw} = urxvt::pw
		2271	->new
		2272	->start ($pid)
		2273	->cb (sub {
		2274	my ($pw, $exit_status) = @_;
		2275	...
		2276	});
		2277
		2278	=over 4
		2279
		2280	=item $pw = new urxvt::pw
		2281
		2282	Create a new process watcher in stopped state.
		2283
		2284	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2285
		2286	Set the callback to be called when the timer triggers.
		2287
		2288	=item $pw = $timer->start ($pid)
		2289
		2290	Tells the watcher to start watching for process C<$pid>.
		2291
		2292	=item $pw = $pw->stop
		2293
		2294	Stop the watcher.
1648		2295
1649	=back	2296	=back
1650		2297
1651	=head1 ENVIRONMENT	2298	=head1 ENVIRONMENT
1652		2299
…		…
1661		2308
1662	=item >= 3 - script loading and management	2309	=item >= 3 - script loading and management
1663		2310
1664	=item >=10 - all called hooks	2311	=item >=10 - all called hooks
1665		2312
1666	=item >=11 - hook reutrn values	2313	=item >=11 - hook return values
1667		2314
1668	=back	2315	=back
1669		2316
1670	=head1 AUTHOR	2317	=head1 AUTHOR
1671		2318
1672	Marc Lehmann <pcg@goof.com>	2319	Marc Lehmann <schmorp@schmorp.de>
1673	http://software.schmorp.de/pkg/rxvt-unicode	2320	http://software.schmorp.de/pkg/rxvt-unicode
1674		2321
1675	=cut	2322	=cut
1676		2323
1677	1	2324	1
		2325
		2326	# vim: sw=3:

Diff Legend

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