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.92 by root, Fri Jan 13 04:59:04 2006 UTC vs.
Revision 1.209 by root, Tue Jun 5 22:38:17 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.
375		689
376	=item on_x_event $term, $event	690	=item on_x_event $term, $event
377		691
378	Called on every X event received on the vt window (and possibly other	692	Called on every X event received on the vt window (and possibly other
379	windows). Should only be used as a last resort. Most event structure	693	windows). Should only be used as a last resort. Most event structure
380	members are not passed.	694	members are not passed.
381		695
		696	=item on_root_event $term, $event
		697
		698	Like C<on_x_event>, but is called for events on the root window.
		699
382	=item on_focus_in $term	700	=item on_focus_in $term
383		701
384	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
385	does focus in processing.	703	does focus in processing.
386		704
387	=item on_focus_out $term	705	=item on_focus_out $term
388		706
389	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
390	focus out processing.	708	focus out processing.
391		709
		710	=item on_configure_notify $term, $event
		711
		712	=item on_property_notify $term, $event
		713
392	=item on_key_press $term, $event, $keysym, $octets	714	=item on_key_press $term, $event, $keysym, $octets
393		715
394	=item on_key_release $term, $event, $keysym	716	=item on_key_release $term, $event, $keysym
395		717
396	=item on_button_press $term, $event	718	=item on_button_press $term, $event
…		…
401		723
402	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
403		725
404	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
405		727
406	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
407	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.
408		730
409	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
410	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
411	and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
412		734
413	C<on_key_press> additionally receives the string rxvt-unicode would	735	C<on_key_press> additionally receives the string rxvt-unicode would
414	output, if any, in locale-specific encoding.	736	output, if any, in locale-specific encoding.
415		737
416	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.
417		752
418	=back	753	=back
419		754
420	=cut	755	=cut
421		756
…		…
427	use Scalar::Util ();	762	use Scalar::Util ();
428	use List::Util ();	763	use List::Util ();
429		764
430	our $VERSION = 1;	765	our $VERSION = 1;
431	our $TERM;	766	our $TERM;
		767	our @TERM_INIT;
		768	our @TERM_EXT;
432	our @HOOKNAME;	769	our @HOOKNAME;
433	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
434	our %OPTION;	771	our %OPTION;
435		772
436	our $LIBDIR;	773	our $LIBDIR;
437	our $RESNAME;	774	our $RESNAME;
438	our $RESCLASS;	775	our $RESCLASS;
439	our $RXVTNAME;	776	our $RXVTNAME;
440		777
		778	our $NOCHAR = chr 0xffff;
		779
441	=head2 Variables in the C<urxvt> Package	780	=head2 Variables in the C<urxvt> Package
442		781
443	=over 4	782	=over 4
444		783
445	=item $urxvt::LIBDIR	784	=item $urxvt::LIBDIR
…		…
458	=item $urxvt::TERM	797	=item $urxvt::TERM
459		798
460	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
461	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
462		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
463	=back	818	=back
464		819
465	=head2 Functions in the C<urxvt> Package	820	=head2 Functions in the C<urxvt> Package
466		821
467	=over 4	822	=over 4
468		823
469	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
470		825
471	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
472	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
473	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
474		830
475	=item urxvt::warn $string	831	=item urxvt::warn $string
476		832
477	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
478	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
479	that calls this function.	835	that calls this function.
480		836
481	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
482	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
483		839
484	Messages have a size limit of 1023 bytes currently.	840	Messages have a size limit of 1023 bytes currently.
485		841
486	=item $is_safe = urxvt::safe	842	=item @terms = urxvt::termlist
487		843
488	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
489	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
490	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).
491		848
492	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
493		850
494	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
495		852
…		…
538		895
539	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
540		897
541	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
542		899
543	=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
544		902
545	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
546	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
547	the bitset.	905	the bitset.
548		906
…		…
554		912
555	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
556		914
557	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	915	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
558		916
		917	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		918
559	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
560	specified one.	920	specified one.
561		921
562	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
563		923
…		…
572	=back	932	=back
573		933
574	=cut	934	=cut
575		935
576	BEGIN {	936	BEGIN {
577	urxvt->bootstrap;
578
579	# overwrite perl's warn	937	# overwrite perl's warn
580	*CORE::GLOBAL::warn = sub {	938	*CORE::GLOBAL::warn = sub {
581	my $msg = join "", @_;	939	my $msg = join "", @_;
582	$msg .= "\n"	940	$msg .= "\n"
583	unless $msg =~ /\n$/;	941	unless $msg =~ /\n$/;
584	urxvt::warn ($msg);	942	urxvt::warn ($msg);
585	};	943	};
		944	}
586		945
587	# %ENV is the original startup environment	946	no warnings 'utf8';
588	delete $ENV{IFS};	947
589	delete $ENV{CDPATH};	948	sub resource {
590	delete $ENV{BASH_ENV};	949	my ($term, $name, $isarg, $flag, $value) = @_;
591	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	950
		951	$term->scan_meta;
		952
		953	warn "resourece<@_>\n";#d#
		954
		955	0
		956	}
		957
		958	sub usage {
		959	my ($term, $usage_type) = @_;
		960
		961	$term->scan_meta;
		962
		963	my $r = $term->{meta}{resource};
		964
		965	for my $regex (sort keys %$r) {
		966	my ($ext, $type, $desc) = @{ $r->{$regex} };
		967
		968	$desc .= " (-pe $ext)";
		969
		970	if ($usage_type == 1) {
		971	if ($type eq "boolean") {
		972	urxvt::log sprintf " -%-20.20s %s\n", "/+$regex", $desc;
		973	} else {
		974	urxvt::log sprintf " -%-20.20s %s\n", "$regex $type", $desc;
		975	}
		976	} else {
		977	urxvt::log sprintf " %-19.19s %s\n", "$regex:", $type;
		978	}
		979	}
592	}	980	}
593		981
594	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	982	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
595		983
596	sub verbose {	984	sub verbose {
597	my ($level, $msg) = @_;	985	my ($level, $msg) = @_;
598	warn "$msg\n" if $level <= $verbosity;	986	warn "$msg\n" if $level <= $verbosity;
599	}	987	}
600		988
601	my $extension_pkg = "extension0000";
602	my %extension_pkg;	989	my %extension_pkg;
603		990
604	# load a single script into its own package, once only	991	# load a single script into its own package, once only
605	sub extension_package($) {	992	sub extension_package($) {
606	my ($path) = @_;	993	my ($path) = @_;
607		994
608	$extension_pkg{$path} ||= do {	995	$extension_pkg{$path} ||= do {
609	my $pkg = "urxvt::" . ($extension_pkg++);	996	$path =~ /([^\/\\]+)$/;
		997	my $pkg = $1;
		998	$pkg =~ s/[^[:word:]]/_/g;
		999	$pkg = "urxvt::ext::$pkg";
610		1000
611	verbose 3, "loading extension '$path' into package '$pkg'";	1001	verbose 3, "loading extension '$path' into package '$pkg'";
612		1002
613	open my $fh, "<:raw", $path	1003	open my $fh, "<:raw", $path
614	or die "$path: $!";	1004	or die "$path: $!";
615		1005
616	my $source = untaint	1006	my $source =
617	"package $pkg; use strict; use utf8;\n"	1007	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
618	. "use base urxvt::term::extension::;\n"
619	. "#line 1 \"$path\"\n{\n"	1008	. "#line 1 \"$path\"\n{\n"
620	. (do { local $/; <$fh> })	1009	. (do { local $/; <$fh> })
621	. "\n};\n1";	1010	. "\n};\n1";
622		1011
623	eval $source	1012	eval $source
…		…
633	sub invoke {	1022	sub invoke {
634	local $TERM = shift;	1023	local $TERM = shift;
635	my $htype = shift;	1024	my $htype = shift;
636		1025
637	if ($htype == 0) { # INIT	1026	if ($htype == 0) { # INIT
638	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1027	my @dirs = $TERM->perl_libdirs;
639		1028
640	my %ext_arg;	1029	my %ext_arg;
641		1030
		1031	{
		1032	my @init = @TERM_INIT;
		1033	@TERM_INIT = ();
		1034	$_->($TERM) for @init;
		1035	my @pkg = @TERM_EXT;
		1036	@TERM_EXT = ();
		1037	$TERM->register_package ($_) for @pkg;
		1038	}
		1039
642	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1040	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
643	if ($_ eq "default") {	1041	if ($_ eq "default") {
644	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	1042	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
645	} elsif (/^-(.*)$/) {	1043	} elsif (/^-(.*)$/) {
646	delete $ext_arg{$1};	1044	delete $ext_arg{$1};
647	} elsif (/^([^<]+)<(.*)>$/) {	1045	} elsif (/^([^<]+)<(.*)>$/) {
648	push @{ $ext_arg{$1} }, $2;	1046	push @{ $ext_arg{$1} }, $2;
649	} else {	1047	} else {
650	$ext_arg{$_} ||= [];	1048	$ext_arg{$_} ||= [];
651	}	1049	}
652	}	1050	}
653		1051
654	while (my ($ext, $argv) = each %ext_arg) {	1052	for my $ext (sort keys %ext_arg) {
655	my @files = grep -f $_, map "$_/$ext", @dirs;	1053	my @files = grep -f $_, map "$_/$ext", @dirs;
656		1054
657	if (@files) {	1055	if (@files) {
658	$TERM->register_package (extension_package $files[0], $argv);	1056	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
659	} else {	1057	} else {
660	warn "perl extension '$ext' not found in perl library search path\n";	1058	warn "perl extension '$ext' not found in perl library search path\n";
661	}	1059	}
662	}	1060	}
663		1061
…		…
669		1067
670	if (my $cb = $TERM->{_hook}[$htype]) {	1068	if (my $cb = $TERM->{_hook}[$htype]) {
671	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1069	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
672	if $verbosity >= 10;	1070	if $verbosity >= 10;
673		1071
674	keys %$cb;	1072	for my $pkg (keys %$cb) {
675
676	while (my ($pkg, $cb) = each %$cb) {
677	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1073	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
678	and last;	1074	$retval ||= $retval_;
679		1075
680	if ($@) {	1076	if ($@) {
681	$TERM->ungrab; # better to lose the grab than the session	1077	$TERM->ungrab; # better to lose the grab than the session
682	warn $@;	1078	warn $@;
683	}	1079	}
…		…
696	}	1092	}
697		1093
698	$retval	1094	$retval
699	}	1095	}
700		1096
701	sub exec_async(@) {	1097	sub SET_COLOR($$$) {
702	my $pid = fork;	1098	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1099	}
703		1100
704	return	1101	sub rend2mask {
705	if !defined $pid or $pid;	1102	no strict 'refs';
706		1103	my ($str, $mask) = (@_, 0);
707	%ENV = %{ $TERM->env };	1104	my %color = ( fg => undef, bg => undef );
708		1105	my @failed;
709	exec @_;	1106	for my $spec ( split /\s+/, $str ) {
710	_exit 255;	1107	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1108	$color{lc($1)} = $2;
		1109	} else {
		1110	my $neg = $spec =~ s/^[-^]//;
		1111	unless ( exists &{"RS_$spec"} ) {
		1112	push @failed, $spec;
		1113	next;
		1114	}
		1115	my $cur = &{"RS_$spec"};
		1116	if ( $neg ) {
		1117	$mask &= ~$cur;
		1118	} else {
		1119	$mask |= $cur;
		1120	}
		1121	}
		1122	}
		1123	($mask, @color{qw(fg bg)}, \@failed)
711	}	1124	}
712		1125
713	# urxvt::term::extension	1126	# urxvt::term::extension
714		1127
715	package urxvt::term::extension;	1128	package urxvt::term::extension;
…		…
780	=head2 The C<urxvt::anyevent> Class	1193	=head2 The C<urxvt::anyevent> Class
781		1194
782	The sole purpose of this class is to deliver an interface to the	1195	The sole purpose of this class is to deliver an interface to the
783	C<AnyEvent> module - any module using it will work inside urxvt without	1196	C<AnyEvent> module - any module using it will work inside urxvt without
784	further programming. The only exception is that you cannot wait on	1197	further programming. The only exception is that you cannot wait on
785	condition variables, but non-blocking condvar use is ok. What this means	1198	condition variables, but non-blocking condvar use is ok.
786	is that you cannot use blocking APIs, but the non-blocking variant should	1199
787	work.	1200	In practical terms this means is that you cannot use blocking APIs, but
		1201	the non-blocking variant should work.
788		1202
789	=cut	1203	=cut
790		1204
791	our $VERSION = 1;	1205	our $VERSION = '5.23';
792		1206
793	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1207	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
794	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1208	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
795		1209
796	sub timer {	1210	sub timer {
…		…
798		1212
799	my $cb = $arg{cb};	1213	my $cb = $arg{cb};
800		1214
801	urxvt::timer	1215	urxvt::timer
802	->new	1216	->new
803	->start (urxvt::NOW + $arg{after})	1217	->after ($arg{after}, $arg{interval})
804	->cb (sub {	1218	->cb ($arg{interval} ? $cb : sub {
805	$_[0]->stop; # need to cancel manually	1219	$_[0]->stop; # need to cancel manually
806	$cb->();	1220	$cb->();
807	})	1221	})
808	}	1222	}
809		1223
810	sub io {	1224	sub io {
811	my ($class, %arg) = @_;	1225	my ($class, %arg) = @_;
812		1226
813	my $cb = $arg{cb};	1227	my $cb = $arg{cb};
		1228	my $fd = fileno $arg{fh};
		1229	defined $fd or $fd = $arg{fh};
814		1230
815	bless [$arg{fh}, urxvt::iow	1231	bless [$arg{fh}, urxvt::iow
816	->new	1232	->new
817	->fd (fileno $arg{fh})	1233	->fd ($fd)
818	->events (($arg{poll} =~ /r/ ? 1 : 0)	1234	->events (($arg{poll} =~ /r/ ? 1 : 0)
819	| ($arg{poll} =~ /w/ ? 2 : 0))	1235	| ($arg{poll} =~ /w/ ? 2 : 0))
820	->start	1236	->start
821	->cb (sub {	1237	->cb ($cb)
822	$cb->(($_[1] & 1 ? 'r' : '')
823	. ($_[1] & 2 ? 'w' : ''));
824	})],
825	urxvt::anyevent::	1238	], urxvt::anyevent::
		1239	}
		1240
		1241	sub idle {
		1242	my ($class, %arg) = @_;
		1243
		1244	my $cb = $arg{cb};
		1245
		1246	urxvt::iw
		1247	->new
		1248	->start
		1249	->cb ($cb)
		1250	}
		1251
		1252	sub child {
		1253	my ($class, %arg) = @_;
		1254
		1255	my $cb = $arg{cb};
		1256
		1257	urxvt::pw
		1258	->new
		1259	->start ($arg{pid})
		1260	->cb (sub {
		1261	$_[0]->stop; # need to cancel manually
		1262	$cb->($_[0]->rpid, $_[0]->rstatus);
		1263	})
826	}	1264	}
827		1265
828	sub DESTROY {	1266	sub DESTROY {
829	$_[0][1]->stop;	1267	$_[0][1]->stop;
830	}	1268	}
831		1269
832	sub condvar {	1270	# only needed for AnyEvent < 6 compatibility
833	bless \my $flag, urxvt::anyevent::condvar::	1271	sub one_event {
834	}
835
836	sub urxvt::anyevent::condvar::broadcast {
837	${$_[0]}++;
838	}
839
840	sub urxvt::anyevent::condvar::wait {
841	unless (${$_[0]}) {
842	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1272	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
843	}
844	}	1273	}
845		1274
846	package urxvt::term;	1275	package urxvt::term;
847		1276
848	=head2 The C<urxvt::term> Class	1277	=head2 The C<urxvt::term> Class
…		…
853		1282
854	# find on_xxx subs in the package and register them	1283	# find on_xxx subs in the package and register them
855	# as hooks	1284	# as hooks
856	sub register_package {	1285	sub register_package {
857	my ($self, $pkg, $argv) = @_;	1286	my ($self, $pkg, $argv) = @_;
		1287
		1288	no strict 'refs';
		1289
		1290	urxvt::verbose 6, "register package $pkg to $self";
		1291
		1292	@{"$pkg\::ISA"} = urxvt::term::extension::;
858		1293
859	my $proxy = bless {	1294	my $proxy = bless {
860	_pkg => $pkg,	1295	_pkg => $pkg,
861	argv => $argv,	1296	argv => $argv,
862	}, $pkg;	1297	}, $pkg;
…		…
869	$proxy->enable ($name => $ref);	1304	$proxy->enable ($name => $ref);
870	}	1305	}
871	}	1306	}
872	}	1307	}
873		1308
		1309	sub perl_libdirs {
		1310	map { split /:/ }
		1311	$_[0]->resource ("perl_lib"),
		1312	$ENV{URXVT_PERL_LIB},
		1313	"$ENV{HOME}/.urxvt/ext",
		1314	"$LIBDIR/perl"
		1315	}
		1316
		1317	sub scan_meta {
		1318	my ($self) = @_;
		1319	my @libdirs = perl_libdirs $self;
		1320
		1321	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1322
		1323	my %meta;
		1324
		1325	$self->{meta_libdirs} = join "\x00", @libdirs;
		1326	$self->{meta} = \%meta;
		1327
		1328	for my $dir (reverse @libdirs) {
		1329	opendir my $fh, $dir
		1330	or next;
		1331	for my $ext (readdir $fh) {
		1332	$ext ne "."
		1333	and $ext ne ".."
		1334	and open my $fh, "<", "$dir/$ext"
		1335	or next;
		1336
		1337	while (<$fh>) {
		1338	if (/^#:META:RESOURCE:(.*)/) {
		1339	my ($regex, $type, $desc) = split /:/, $1;
		1340	$regex =~ s/\$\$/$ext/g; # $$ in regex == extension name
		1341	$meta{resource}{$regex} = [$ext, $type, $desc];
		1342	} elsif (/^\s*(?:#|$)/) {
		1343	# skip other comments and empty lines
		1344	} else {
		1345	last; # stop parsing on first non-empty non-comment line
		1346	}
		1347	}
		1348	}
		1349	}
		1350	}
		1351
874	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1352	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
875		1353
876	Creates a new terminal, very similar as if you had started it with system	1354	Creates a new terminal, very similar as if you had started it with system
877	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1355	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
878	hash which defines the environment of the new terminal.	1356	hash which defines the environment of the new terminal.
879		1357
880	Croaks (and probably outputs an error message) if the new instance	1358	Croaks (and probably outputs an error message) if the new instance
881	couldn't be created. Returns C<undef> if the new instance didn't	1359	couldn't be created. Returns C<undef> if the new instance didn't
882	initialise perl, and the terminal object otherwise. The C<init> and	1360	initialise perl, and the terminal object otherwise. The C<init> and
883	C<start> hooks will be called during this call.	1361	C<start> hooks will be called before this call returns, and are free to
		1362	refer to global data (which is race free).
884		1363
885	=cut	1364	=cut
886		1365
887	sub new {	1366	sub new {
888	my ($class, $env, @args) = @_;	1367	my ($class, $env, @args) = @_;
889		1368
		1369	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1370	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1371
890	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1372	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
891	}	1373	}
892		1374
893	=item $term->destroy	1375	=item $term->destroy
894		1376
895	Destroy the terminal object (close the window, free resources	1377	Destroy the terminal object (close the window, free resources
896	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1378	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
897	watchers (timers, io watchers) are still active.	1379	watchers (timers, io watchers) are still active.
898		1380
		1381	=item $term->exec_async ($cmd[, @args])
		1382
		1383	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1384	("starts") programs in the background. This function takes care of setting
		1385	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1386	be preferred over explicit calls to C<exec> or C<system>.
		1387
		1388	Returns the pid of the subprocess or C<undef> on error.
		1389
		1390	=cut
		1391
		1392	sub exec_async {
		1393	my $self = shift;
		1394
		1395	my $pid = fork;
		1396
		1397	return $pid
		1398	if !defined $pid or $pid;
		1399
		1400	%ENV = %{ $self->env };
		1401
		1402	exec @_;
		1403	urxvt::_exit 255;
		1404	}
		1405
899	=item $isset = $term->option ($optval[, $set])	1406	=item $isset = $term->option ($optval[, $set])
900		1407
901	Returns true if the option specified by C<$optval> is enabled, and	1408	Returns true if the option specified by C<$optval> is enabled, and
902	optionally change it. All option values are stored by name in the hash	1409	optionally change it. All option values are stored by name in the hash
903	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1410	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
904		1411
905	Here is a a likely non-exhaustive list of option names, please see the	1412	Here is a likely non-exhaustive list of option names, please see the
906	source file F</src/optinc.h> to see the actual list:	1413	source file F</src/optinc.h> to see the actual list:
907		1414
908	borderLess console cursorBlink cursorUnderline hold iconic insecure	1415	borderLess buffered console cursorBlink cursorUnderline hold iconic
909	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1416	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1417	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
910	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1418	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
911	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1419	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
912	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1420	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
913	tripleclickwords utmpInhibit visualBell	1421	urgentOnBell utmpInhibit visualBell
914		1422
915	=item $value = $term->resource ($name[, $newval])	1423	=item $value = $term->resource ($name[, $newval])
916		1424
917	Returns the current resource value associated with a given name and	1425	Returns the current resource value associated with a given name and
918	optionally sets a new value. Setting values is most useful in the C<init>	1426	optionally sets a new value. Setting values is most useful in the C<init>
…		…
927	likely change).	1435	likely change).
928		1436
929	Please note that resource strings will currently only be freed when the	1437	Please note that resource strings will currently only be freed when the
930	terminal is destroyed, so changing options frequently will eat memory.	1438	terminal is destroyed, so changing options frequently will eat memory.
931		1439
932	Here is a a likely non-exhaustive list of resource names, not all of which	1440	Here is a likely non-exhaustive list of resource names, not all of which
933	are supported in every build, please see the source file F</src/rsinc.h>	1441	are supported in every build, please see the source file F</src/rsinc.h>
934	to see the actual list:	1442	to see the actual list:
935		1443
936	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1444	answerbackstring backgroundPixmap backspace_key blendtype blurradius
937	borderLess color cursorBlink cursorUnderline cutchars delete_key	1445	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
938	display_name embed ext_bwidth fade font geometry hold iconName	1446	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
939	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1447	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1448	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
940	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1449	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
941	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1450	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
942	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1451	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
943	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1452	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
944	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1453	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
945	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1454	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
946	shade term_name title transparent transparent_all tripleclickwords	1455	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1456	term_name title transient_for transparent tripleclickwords urgentOnBell
947	utmpInhibit visualBell	1457	utmpInhibit visualBell
948		1458
949	=cut	1459	=cut
950		1460
951	sub resource($$;$) {	1461	sub resource($$;$) {
952	my ($self, $name) = (shift, shift);	1462	my ($self, $name) = (shift, shift);
953	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1463	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
954	&urxvt::term::_resource	1464	goto &urxvt::term::_resource
955	}	1465	}
956		1466
957	=item $value = $term->x_resource ($pattern)	1467	=item $value = $term->x_resource ($pattern)
958		1468
959	Returns the X-Resource for the given pattern, excluding the program or	1469	Returns the X-Resource for the given pattern, excluding the program or
…		…
963		1473
964	This method should only be called during the C<on_start> hook, as there is	1474	This method should only be called during the C<on_start> hook, as there is
965	only one resource database per display, and later invocations might return	1475	only one resource database per display, and later invocations might return
966	the wrong resources.	1476	the wrong resources.
967		1477
968	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1478	=item $success = $term->parse_keysym ($key, $octets)
969		1479
970	Adds a keymap translation exactly as specified via a resource. See the	1480	Adds a key binding exactly as specified via a resource. See the
971	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1481	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1482
		1483	=item $term->register_command ($keysym, $modifiermask, $string)
		1484
		1485	Adds a key binding. This is a lower level api compared to
		1486	C<parse_keysym>, as it expects a parsed key description, and can be
		1487	used only inside either the C<on_init> hook, to add a binding, or the
		1488	C<on_register_command> hook, to modify a parsed binding.
972		1489
973	=item $rend = $term->rstyle ([$new_rstyle])	1490	=item $rend = $term->rstyle ([$new_rstyle])
974		1491
975	Return and optionally change the current rendition. Text that is output by	1492	Return and optionally change the current rendition. Text that is output by
976	the terminal application will use this style.	1493	the terminal application will use this style.
…		…
984		1501
985	=item ($row, $col) = $term->selection_beg ([$row, $col])	1502	=item ($row, $col) = $term->selection_beg ([$row, $col])
986		1503
987	=item ($row, $col) = $term->selection_end ([$row, $col])	1504	=item ($row, $col) = $term->selection_end ([$row, $col])
988		1505
989	Return the current values of the selection mark, begin or end positions,	1506	Return the current values of the selection mark, begin or end positions.
990	and optionally set them to new values.	1507
		1508	When arguments are given, then the selection coordinates are set to
		1509	C<$row> and C<$col>, and the selection screen is set to the current
		1510	screen.
		1511
		1512	=item $screen = $term->selection_screen ([$screen])
		1513
		1514	Returns the current selection screen, and then optionally sets it.
991		1515
992	=item $term->selection_make ($eventtime[, $rectangular])	1516	=item $term->selection_make ($eventtime[, $rectangular])
993		1517
994	Tries to make a selection as set by C<selection_beg> and	1518	Tries to make a selection as set by C<selection_beg> and
995	C<selection_end>. If C<$rectangular> is true (default: false), a	1519	C<selection_end>. If C<$rectangular> is true (default: false), a
996	rectangular selection will be made. This is the prefered function to make	1520	rectangular selection will be made. This is the preferred function to make
997	a selection.	1521	a selection.
998		1522
999	=item $success = $term->selection_grab ($eventtime)	1523	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1000		1524
1001	Try to request the primary selection text from the server (for example, as	1525	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1526	true) selection from the server. The corresponding text can be set
1002	set by the next method). No visual feedback will be given. This function	1527	with the next method. No visual feedback will be given. This function
1003	is mostly useful from within C<on_sel_grab> hooks.	1528	is mostly useful from within C<on_sel_grab> hooks.
1004		1529
1005	=item $oldtext = $term->selection ([$newtext])	1530	=item $oldtext = $term->selection ([$newtext, $clipboard])
1006		1531
1007	Return the current selection text and optionally replace it by C<$newtext>.	1532	Return the current selection (clipboard if C<$clipboard> is true) text
		1533	and optionally replace it by C<$newtext>.
		1534
		1535	=item $term->selection_clear ([$clipboard])
		1536
		1537	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1008		1538
1009	=item $term->overlay_simple ($x, $y, $text)	1539	=item $term->overlay_simple ($x, $y, $text)
1010		1540
1011	Create a simple multi-line overlay box. See the next method for details.	1541	Create a simple multi-line overlay box. See the next method for details.
1012		1542
…		…
1042		1572
1043	The methods currently supported on C<urxvt::overlay> objects are:	1573	The methods currently supported on C<urxvt::overlay> objects are:
1044		1574
1045	=over 4	1575	=over 4
1046		1576
1047	=item $overlay->set ($x, $y, $text, $rend)	1577	=item $overlay->set ($x, $y, $text[, $rend])
1048		1578
1049	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1579	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1050	text in rxvt-unicode's special encoding and an array of rendition values	1580	text in rxvt-unicode's special encoding and an array of rendition values
1051	at a specific position inside the overlay.	1581	at a specific position inside the overlay.
		1582
		1583	If C<$rend> is missing, then the rendition will not be changed.
1052		1584
1053	=item $overlay->hide	1585	=item $overlay->hide
1054		1586
1055	If visible, hide the overlay, but do not destroy it.	1587	If visible, hide the overlay, but do not destroy it.
1056		1588
…		…
1126		1658
1127	Normally its not a good idea to use this function, as programs might be	1659	Normally its not a good idea to use this function, as programs might be
1128	confused by changes in cursor position or scrolling. Its useful inside a	1660	confused by changes in cursor position or scrolling. Its useful inside a
1129	C<on_add_lines> hook, though.	1661	C<on_add_lines> hook, though.
1130		1662
		1663	=item $term->scr_change_screen ($screen)
		1664
		1665	Switch to given screen - 0 primary, 1 secondary.
		1666
1131	=item $term->cmd_parse ($octets)	1667	=item $term->cmd_parse ($octets)
1132		1668
1133	Similar to C<scr_add_lines>, but the argument must be in the	1669	Similar to C<scr_add_lines>, but the argument must be in the
1134	locale-specific encoding of the terminal and can contain command sequences	1670	locale-specific encoding of the terminal and can contain command sequences
1135	(escape codes) that will be interpreted.	1671	(escape codes) that will be interpreted.
1136		1672
1137	=item $term->tt_write ($octets)	1673	=item $term->tt_write ($octets)
1138		1674
1139	Write the octets given in C<$data> to the tty (i.e. as program input). To	1675	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1140	pass characters instead of octets, you should convert your strings first	1676	pass characters instead of octets, you should convert your strings first
1141	to the locale-specific encoding using C<< $term->locale_encode >>.	1677	to the locale-specific encoding using C<< $term->locale_encode >>.
		1678
		1679	=item $term->tt_paste ($octets)
		1680
		1681	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1682	CR and bracketing the data with control sequences if bracketed paste mode
		1683	is set.
1142		1684
1143	=item $old_events = $term->pty_ev_events ([$new_events])	1685	=item $old_events = $term->pty_ev_events ([$new_events])
1144		1686
1145	Replaces the event mask of the pty watcher by the given event mask. Can	1687	Replaces the event mask of the pty watcher by the given event mask. Can
1146	be used to suppress input and output handling to the pty/tty. See the	1688	be used to suppress input and output handling to the pty/tty. See the
1147	description of C<< urxvt::timer->events >>. Make sure to always restore	1689	description of C<< urxvt::timer->events >>. Make sure to always restore
1148	the previous value.	1690	the previous value.
1149		1691
		1692	=item $fd = $term->pty_fd
		1693
		1694	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1695	is used.
		1696
1150	=item $windowid = $term->parent	1697	=item $windowid = $term->parent
1151		1698
1152	Return the window id of the toplevel window.	1699	Return the window id of the toplevel window.
1153		1700
1154	=item $windowid = $term->vt	1701	=item $windowid = $term->vt
…		…
1160	Adds the specified events to the vt event mask. Useful e.g. when you want	1707	Adds the specified events to the vt event mask. Useful e.g. when you want
1161	to receive pointer events all the times:	1708	to receive pointer events all the times:
1162		1709
1163	$term->vt_emask_add (urxvt::PointerMotionMask);	1710	$term->vt_emask_add (urxvt::PointerMotionMask);
1164		1711
		1712	=item $term->set_urgency ($set)
		1713
		1714	Enable/disable the urgency hint on the toplevel window.
		1715
		1716	=item $term->focus_in
		1717
		1718	=item $term->focus_out
		1719
		1720	=item $term->key_press ($state, $keycode[, $time])
		1721
		1722	=item $term->key_release ($state, $keycode[, $time])
		1723
		1724	Deliver various fake events to to terminal.
		1725
1165	=item $window_width = $term->width	1726	=item $window_width = $term->width
1166		1727
1167	=item $window_height = $term->height	1728	=item $window_height = $term->height
1168		1729
1169	=item $font_width = $term->fwidth	1730	=item $font_width = $term->fwidth
…		…
1182		1743
1183	=item $max_scrollback = $term->saveLines	1744	=item $max_scrollback = $term->saveLines
1184		1745
1185	=item $nrow_plus_saveLines = $term->total_rows	1746	=item $nrow_plus_saveLines = $term->total_rows
1186		1747
1187	=item $lines_in_scrollback = $term->nsaved	1748	=item $topmost_scrollback_row = $term->top_row
1188		1749
1189	Return various integers describing terminal characteristics.	1750	Return various integers describing terminal characteristics.
1190		1751
1191	=item $x_display = $term->display_id	1752	=item $x_display = $term->display_id
1192		1753
…		…
1199	=item $env = $term->env	1760	=item $env = $term->env
1200		1761
1201	Returns a copy of the environment in effect for the terminal as a hashref	1762	Returns a copy of the environment in effect for the terminal as a hashref
1202	similar to C<\%ENV>.	1763	similar to C<\%ENV>.
1203		1764
		1765	=item @envv = $term->envv
		1766
		1767	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1768
		1769	=item @argv = $term->argv
		1770
		1771	Return the argument vector as this terminal, similar to @ARGV, but
		1772	includes the program name as first element.
		1773
1204	=cut	1774	=cut
1205		1775
1206	sub env {	1776	sub env {
1207	if (my $env = $_[0]->_env) {
1208	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1777	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1209	} else {
1210	+{ %ENV }
1211	}
1212	}	1778	}
1213		1779
1214	=item $modifiermask = $term->ModLevel3Mask	1780	=item $modifiermask = $term->ModLevel3Mask
1215		1781
1216	=item $modifiermask = $term->ModMetaMask	1782	=item $modifiermask = $term->ModMetaMask
…		…
1218	=item $modifiermask = $term->ModNumLockMask	1784	=item $modifiermask = $term->ModNumLockMask
1219		1785
1220	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1786	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1221	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1787	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1222		1788
		1789	=item $screen = $term->current_screen
		1790
		1791	Returns the currently displayed screen (0 primary, 1 secondary).
		1792
		1793	=item $cursor_is_hidden = $term->hidden_cursor
		1794
		1795	Returns whether the cursor is currently hidden or not.
		1796
1223	=item $view_start = $term->view_start ([$newvalue])	1797	=item $view_start = $term->view_start ([$newvalue])
1224		1798
1225	Returns the negative row number of the topmost line. Minimum value is	1799	Returns the row number of the topmost displayed line. Maximum value is
1226	C<0>, which displays the normal terminal contents. Larger values scroll	1800	C<0>, which displays the normal terminal contents. Lower values scroll
1227	this many lines into the scrollback buffer.	1801	this many lines into the scrollback buffer.
1228		1802
1229	=item $term->want_refresh	1803	=item $term->want_refresh
1230		1804
1231	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1805	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1234		1808
1235	Used after changing terminal contents to display them.	1809	Used after changing terminal contents to display them.
1236		1810
1237	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1811	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1238		1812
1239	Returns the text of the entire row with number C<$row_number>. Row C<0>	1813	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1240	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1814	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1241	terminal line. The scrollback buffer starts at line C<-1> and extends to
1242	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1815	terminal line. Nothing will be returned if a nonexistent line
1243	is requested.	1816	is requested.
1244		1817
1245	If C<$new_text> is specified, it will replace characters in the current	1818	If C<$new_text> is specified, it will replace characters in the current
1246	line, starting at column C<$start_col> (default C<0>), which is useful	1819	line, starting at column C<$start_col> (default C<0>), which is useful
1247	to replace only parts of a line. The font index in the rendition will	1820	to replace only parts of a line. The font index in the rendition will
1248	automatically be updated.	1821	automatically be updated.
1249		1822
1250	C<$text> is in a special encoding: tabs and wide characters that use more	1823	C<$text> is in a special encoding: tabs and wide characters that use more
1251	than one cell when displayed are padded with urxvt::NOCHAR characters	1824	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1252	(C<chr 65535>). Characters with combining characters and other characters	1825	characters. Characters with combining characters and other characters that
1253	that do not fit into the normal tetx encoding will be replaced with	1826	do not fit into the normal text encoding will be replaced with characters
1254	characters in the private use area.	1827	in the private use area.
1255		1828
1256	You have to obey this encoding when changing text. The advantage is	1829	You have to obey this encoding when changing text. The advantage is
1257	that C<substr> and similar functions work on screen cells and not on	1830	that C<substr> and similar functions work on screen cells and not on
1258	characters.	1831	characters.
1259		1832
…		…
1403	where one character corresponds to one screen cell. See	1976	where one character corresponds to one screen cell. See
1404	C<< $term->ROW_t >> for details.	1977	C<< $term->ROW_t >> for details.
1405		1978
1406	=item $string = $term->special_decode $text	1979	=item $string = $term->special_decode $text
1407		1980
1408	Converts rxvt-unicodes text reprsentation into a perl string. See	1981	Converts rxvt-unicodes text representation into a perl string. See
1409	C<< $term->ROW_t >> for details.	1982	C<< $term->ROW_t >> for details.
1410		1983
1411	=item $success = $term->grab_button ($button, $modifiermask)	1984	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1412		1985
		1986	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1987
1413	Registers a synchronous button grab. See the XGrabButton manpage.	1988	Register/unregister a synchronous button grab. See the XGrabButton
		1989	manpage.
1414		1990
1415	=item $success = $term->grab ($eventtime[, $sync])	1991	=item $success = $term->grab ($eventtime[, $sync])
1416		1992
1417	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1993	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1418	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1994	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1419		1995
1420	=item $term->allow_events_async	1996	=item $term->allow_events_async
1421		1997
1422	Calls XAllowEvents with AsyncBoth for the most recent grab.	1998	Calls XAllowEvents with AsyncBoth for the most recent grab.
1423		1999
…		…
1430	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2006	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1431	recent grab.	2007	recent grab.
1432		2008
1433	=item $term->ungrab	2009	=item $term->ungrab
1434		2010
1435	Calls XUngrab for the most recent grab. Is called automatically on	2011	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1436	evaluation errors, as it is better to lose the grab in the error case as	2012	evaluation errors, as it is better to lose the grab in the error case as
1437	the session.	2013	the session.
		2014
		2015	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		2016
		2017	=item $atom_name = $term->XGetAtomName ($atom)
		2018
		2019	=item @atoms = $term->XListProperties ($window)
		2020
		2021	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		2022
		2023	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		2024
		2025	=item $term->XDeleteProperty ($window, $property)
		2026
		2027	=item $window = $term->DefaultRootWindow
		2028
		2029	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		2030
		2031	=item $term->XMapWindow ($window)
		2032
		2033	=item $term->XUnmapWindow ($window)
		2034
		2035	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		2036
		2037	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		2038
		2039	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2040
		2041	=item $keysym = $term->XStringToKeysym ($string)
		2042
		2043	=item $string = $term->XKeysymToString ($keysym)
		2044
		2045	Various X or X-related functions. The C<$term> object only serves as
		2046	the source of the display, otherwise those functions map more-or-less
		2047	directly onto the X functions of the same name.
1438		2048
1439	=back	2049	=back
1440		2050
1441	=cut	2051	=cut
1442		2052
…		…
1506	my ($self, $text, $cb) = @_;	2116	my ($self, $text, $cb) = @_;
1507		2117
1508	$self->add_item ({ type => "button", text => $text, activate => $cb});	2118	$self->add_item ({ type => "button", text => $text, activate => $cb});
1509	}	2119	}
1510		2120
1511	=item $popup->add_toggle ($text, $cb, $initial_value)	2121	=item $popup->add_toggle ($text, $initial_value, $cb)
1512		2122
1513	Adds a toggle/checkbox item to the popup. Teh callback gets called	2123	Adds a toggle/checkbox item to the popup. The callback gets called
1514	whenever it gets toggled, with a boolean indicating its value as its first	2124	whenever it gets toggled, with a boolean indicating its new value as its
1515	argument.	2125	first argument.
1516		2126
1517	=cut	2127	=cut
1518		2128
1519	sub add_toggle {	2129	sub add_toggle {
1520	my ($self, $text, $cb, $value) = @_;	2130	my ($self, $text, $value, $cb) = @_;
1521		2131
1522	my $item; $item = {	2132	my $item; $item = {
1523	type => "button",	2133	type => "button",
1524	text => " $text",	2134	text => " $text",
1525	value => $value,	2135	value => $value,
…		…
1544	my $env = $self->{term}->env;	2154	my $env = $self->{term}->env;
1545	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2155	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1546	delete $env->{LC_ALL};	2156	delete $env->{LC_ALL};
1547	$env->{LC_CTYPE} = $self->{term}->locale;	2157	$env->{LC_CTYPE} = $self->{term}->locale;
1548		2158
1549	urxvt::term->new ($env, $self->{term}->resource ("name"),	2159	my $term = urxvt::term->new (
1550	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2160	$env, "popup",
		2161	"--perl-lib" => "", "--perl-ext-common" => "",
		2162	"-pty-fd" => -1, "-sl" => 0,
		2163	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1551	"--transient-for" => $self->{term}->parent,	2164	"--transient-for" => $self->{term}->parent,
1552	"-display" => $self->{term}->display_id,	2165	"-display" => $self->{term}->display_id,
1553	"-pe" => "urxvt-popup")	2166	"-pe" => "urxvt-popup",
1554	or die "unable to create popup window\n";	2167	) or die "unable to create popup window\n";
		2168
		2169	unless (delete $term->{urxvt_popup_init_done}) {
		2170	$term->ungrab;
		2171	$term->destroy;
		2172	die "unable to initialise popup window\n";
		2173	}
1555	}	2174	}
1556		2175
1557	sub DESTROY {	2176	sub DESTROY {
1558	my ($self) = @_;	2177	my ($self) = @_;
1559		2178
1560	delete $self->{term}{_destroy}{$self};	2179	delete $self->{term}{_destroy}{$self};
1561	$self->{term}->ungrab;	2180	$self->{term}->ungrab;
1562	}	2181	}
1563		2182
1564	=back	2183	=back
		2184
		2185	=cut
		2186
		2187	package urxvt::watcher;
1565		2188
1566	=head2 The C<urxvt::timer> Class	2189	=head2 The C<urxvt::timer> Class
1567		2190
1568	This class implements timer watchers/events. Time is represented as a	2191	This class implements timer watchers/events. Time is represented as a
1569	fractional number of seconds since the epoch. Example:	2192	fractional number of seconds since the epoch. Example:
…		…
1573	->new	2196	->new
1574	->interval (1)	2197	->interval (1)
1575	->cb (sub {	2198	->cb (sub {
1576	$term->{overlay}->set (0, 0,	2199	$term->{overlay}->set (0, 0,
1577	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2200	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1578	});	2201	});
1579		2202
1580	=over 4	2203	=over 4
1581		2204
1582	=item $timer = new urxvt::timer	2205	=item $timer = new urxvt::timer
1583		2206
…		…
1586		2209
1587	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2210	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1588		2211
1589	Set the callback to be called when the timer triggers.	2212	Set the callback to be called when the timer triggers.
1590		2213
1591	=item $tstamp = $timer->at
1592
1593	Return the time this watcher will fire next.
1594
1595	=item $timer = $timer->set ($tstamp)	2214	=item $timer = $timer->set ($tstamp[, $interval])
1596		2215
1597	Set the time the event is generated to $tstamp.	2216	Set the time the event is generated to $tstamp (and optionally specifies a
		2217	new $interval).
1598		2218
1599	=item $timer = $timer->interval ($interval)	2219	=item $timer = $timer->interval ($interval)
1600		2220
1601	Normally (and when C<$interval> is C<0>), the timer will automatically	2221	By default (and when C<$interval> is C<0>), the timer will automatically
1602	stop after it has fired once. If C<$interval> is non-zero, then the timer	2222	stop after it has fired once. If C<$interval> is non-zero, then the timer
1603	is automatically rescheduled at the given intervals.	2223	is automatically rescheduled at the given intervals.
1604		2224
1605	=item $timer = $timer->start	2225	=item $timer = $timer->start
1606		2226
1607	Start the timer.	2227	Start the timer.
1608		2228
1609	=item $timer = $timer->start ($tstamp)	2229	=item $timer = $timer->start ($tstamp[, $interval])
1610		2230
1611	Set the event trigger time to C<$tstamp> and start the timer.	2231	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2232	also replaces the interval.
		2233
		2234	=item $timer = $timer->after ($delay[, $interval])
		2235
		2236	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1612		2237
1613	=item $timer = $timer->stop	2238	=item $timer = $timer->stop
1614		2239
1615	Stop the timer.	2240	Stop the timer.
1616		2241
…		…
1622		2247
1623	$term->{socket} = ...	2248	$term->{socket} = ...
1624	$term->{iow} = urxvt::iow	2249	$term->{iow} = urxvt::iow
1625	->new	2250	->new
1626	->fd (fileno $term->{socket})	2251	->fd (fileno $term->{socket})
1627	->events (urxvt::EVENT_READ)	2252	->events (urxvt::EV_READ)
1628	->start	2253	->start
1629	->cb (sub {	2254	->cb (sub {
1630	my ($iow, $revents) = @_;	2255	my ($iow, $revents) = @_;
1631	# $revents must be 1 here, no need to check	2256	# $revents must be 1 here, no need to check
1632	sysread $term->{socket}, my $buf, 8192	2257	sysread $term->{socket}, my $buf, 8192
…		…
1645	Set the callback to be called when io events are triggered. C<$reventmask>	2270	Set the callback to be called when io events are triggered. C<$reventmask>
1646	is a bitset as described in the C<events> method.	2271	is a bitset as described in the C<events> method.
1647		2272
1648	=item $iow = $iow->fd ($fd)	2273	=item $iow = $iow->fd ($fd)
1649		2274
1650	Set the filedescriptor (not handle) to watch.	2275	Set the file descriptor (not handle) to watch.
1651		2276
1652	=item $iow = $iow->events ($eventmask)	2277	=item $iow = $iow->events ($eventmask)
1653		2278
1654	Set the event mask to watch. The only allowed values are	2279	Set the event mask to watch. The only allowed values are
1655	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2280	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1656	together, or C<urxvt::EVENT_NONE>.	2281	together, or C<urxvt::EV_NONE>.
1657		2282
1658	=item $iow = $iow->start	2283	=item $iow = $iow->start
1659		2284
1660	Start watching for requested events on the given handle.	2285	Start watching for requested events on the given handle.
1661		2286
1662	=item $iow = $iow->stop	2287	=item $iow = $iow->stop
1663		2288
1664	Stop watching for events on the given filehandle.	2289	Stop watching for events on the given file handle.
		2290
		2291	=back
		2292
		2293	=head2 The C<urxvt::iw> Class
		2294
		2295	This class implements idle watchers, that get called automatically when
		2296	the process is idle. They should return as fast as possible, after doing
		2297	some useful work.
		2298
		2299	=over 4
		2300
		2301	=item $iw = new urxvt::iw
		2302
		2303	Create a new idle watcher object in stopped state.
		2304
		2305	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2306
		2307	Set the callback to be called when the watcher triggers.
		2308
		2309	=item $timer = $timer->start
		2310
		2311	Start the watcher.
		2312
		2313	=item $timer = $timer->stop
		2314
		2315	Stop the watcher.
		2316
		2317	=back
		2318
		2319	=head2 The C<urxvt::pw> Class
		2320
		2321	This class implements process watchers. They create an event whenever a
		2322	process exits, after which they stop automatically.
		2323
		2324	my $pid = fork;
		2325	...
		2326	$term->{pw} = urxvt::pw
		2327	->new
		2328	->start ($pid)
		2329	->cb (sub {
		2330	my ($pw, $exit_status) = @_;
		2331	...
		2332	});
		2333
		2334	=over 4
		2335
		2336	=item $pw = new urxvt::pw
		2337
		2338	Create a new process watcher in stopped state.
		2339
		2340	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2341
		2342	Set the callback to be called when the timer triggers.
		2343
		2344	=item $pw = $timer->start ($pid)
		2345
		2346	Tells the watcher to start watching for process C<$pid>.
		2347
		2348	=item $pw = $pw->stop
		2349
		2350	Stop the watcher.
1665		2351
1666	=back	2352	=back
1667		2353
1668	=head1 ENVIRONMENT	2354	=head1 ENVIRONMENT
1669		2355
…		…
1678		2364
1679	=item >= 3 - script loading and management	2365	=item >= 3 - script loading and management
1680		2366
1681	=item >=10 - all called hooks	2367	=item >=10 - all called hooks
1682		2368
1683	=item >=11 - hook reutrn values	2369	=item >=11 - hook return values
1684		2370
1685	=back	2371	=back
1686		2372
1687	=head1 AUTHOR	2373	=head1 AUTHOR
1688		2374
1689	Marc Lehmann <pcg@goof.com>	2375	Marc Lehmann <schmorp@schmorp.de>
1690	http://software.schmorp.de/pkg/rxvt-unicode	2376	http://software.schmorp.de/pkg/rxvt-unicode
1691		2377
1692	=cut	2378	=cut
1693		2379
1694	1	2380	1
		2381
		2382	# vim: sw=3:

Diff Legend

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