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.89 by root, Thu Jan 12 12:10:06 2006 UTC vs.
Revision 1.208 by root, Tue Jun 5 22:23:07 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	=item mark-urls	213	Of course, this can be modified to suit your needs and your editor :)
133		214
		215	To expand the example above to typical perl error messages ("XXX at
		216	FILENAME line YYY."), you need a slightly more elaborate solution:
		217
		218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		220
		221	The first line tells the selection code to treat the unchanging part of
		222	every error message as a selection pattern, and the second line transforms
		223	the message into vi commands to load the file.
		224
		225	=item tabbed
		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
134	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
135	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
136	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
137	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.
138		315
139	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
140		317
141	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
142	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
143	similar-looking ascii character.	320	similar-looking ascii character.
144		321
145	=item digital-clock	322	=item digital-clock
146		323
147	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.
148		393
149	=item example-refresh-hooks	394	=item example-refresh-hooks
150		395
151	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
152	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
153	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"
154		412
155	=back	413	=back
156		414
157	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
158		416
…		…
174		432
175	=over 4	433	=over 4
176		434
177	=item $text	435	=item $text
178		436
179	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
180	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.
181		439
182	=item $string	440	=item $string
183		441
184	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
…		…
188	=item $octets	446	=item $octets
189		447
190	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
191	locale-specific way.	449	locale-specific way.
192		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
193	=back	457	=back
194		458
195	=head2 Extension Objects	459	=head2 Extension Objects
196		460
197	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
198	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,
199	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
200	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
201	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
202	use.	467	internal use.
203		468
204	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
205	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
206		471
207	It has the following methods and data members:	472	It has the following methods and data members:
…		…
228	=head2 Hooks	493	=head2 Hooks
229		494
230	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
231	called whenever the relevant event happens.	496	called whenever the relevant event happens.
232		497
233	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
234	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
235		500
236	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
237	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
238	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.
239		504
240	I<< When in doubt, return a false value (preferably C<()>). >>	505	I<< When in doubt, return a false value (preferably C<()>). >>
241		506
242	=over 4	507	=over 4
243		508
244	=item on_init $term	509	=item on_init $term
245		510
246	Called after a new terminal object has been initialized, but before	511	Called after a new terminal object has been initialized, but before
247	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
248	call or deliver senseless data, as terminal size and other characteristics	513	call or deliver senseless data, as terminal size and other characteristics
249	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
250	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).
251		527
252	=item on_reset $term	528	=item on_reset $term
253		529
254	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
255	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
256	variables.	532	variables.
257		533
258	=item on_start $term	534	=item on_child_start $term, $pid
259		535
260	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.
261	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>.
262		542
263	=item on_sel_make $term, $eventtime	543	=item on_sel_make $term, $eventtime
264		544
265	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
266	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
…		…
273		553
274	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
275	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
276	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
277		557
278	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.
279		559
280	=item on_sel_extend $term	560	=item on_sel_extend $term
281		561
282	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
283	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
284	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
285	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
286	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
287	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
288		568
289	See the F<selection> example extension.	569	See the F<selection> example extension.
290		570
291	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
292		572
293	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
294	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
295	show this many lines of scrollback.	575	show this many lines of scrollback.
296		576
297	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
298		578
…		…
302		582
303	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,
304	$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
305	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
306		586
307	=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
308		598
309	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
310	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
311	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
312	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,
313	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
314	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	}
315		615
316	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,
317	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
318	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.
319		622
320	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
321		624
322	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
323	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
…		…
328	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
329		632
330	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
331	suppress or filter tty input.	634	suppress or filter tty input.
332		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
333	=item on_line_update $term, $row	643	=item on_line_update $term, $row
334		644
335	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
336	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
337	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,
…		…
344	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
345	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
346		656
347	=item on_refresh_begin $term	657	=item on_refresh_begin $term
348		658
349	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
350	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
351	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
352	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
353		663
354	=item on_refresh_end $term	664	=item on_refresh_end $term
355		665
356	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>.
357		667
358	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
359		669
360	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
361	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>
362	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.
363		699
364	=item on_focus_in $term	700	=item on_focus_in $term
365		701
366	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
367	does focus in processing.	703	does focus in processing.
368		704
369	=item on_focus_out $term	705	=item on_focus_out $term
370		706
371	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
372	focus out processing.	708	focus out processing.
373		709
		710	=item on_configure_notify $term, $event
		711
		712	=item on_property_notify $term, $event
		713
374	=item on_key_press $term, $event, $keysym, $octets	714	=item on_key_press $term, $event, $keysym, $octets
375		715
376	=item on_key_release $term, $event, $keysym	716	=item on_key_release $term, $event, $keysym
377		717
378	=item on_button_press $term, $event	718	=item on_button_press $term, $event
…		…
383		723
384	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
385		725
386	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
387		727
388	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
389	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.
390		730
391	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
392	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
393	and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
394		734
395	C<on_key_press> additionally receives the string rxvt-unicode would	735	C<on_key_press> additionally receives the string rxvt-unicode would
396	output, if any, in locale-specific encoding.	736	output, if any, in locale-specific encoding.
397		737
398	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.
399		752
400	=back	753	=back
401		754
402	=cut	755	=cut
403		756
…		…
409	use Scalar::Util ();	762	use Scalar::Util ();
410	use List::Util ();	763	use List::Util ();
411		764
412	our $VERSION = 1;	765	our $VERSION = 1;
413	our $TERM;	766	our $TERM;
		767	our @TERM_INIT;
		768	our @TERM_EXT;
414	our @HOOKNAME;	769	our @HOOKNAME;
415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
416	our %OPTION;	771	our %OPTION;
417		772
418	our $LIBDIR;	773	our $LIBDIR;
419	our $RESNAME;	774	our $RESNAME;
420	our $RESCLASS;	775	our $RESCLASS;
421	our $RXVTNAME;	776	our $RXVTNAME;
422		777
		778	our $NOCHAR = chr 0xffff;
		779
423	=head2 Variables in the C<urxvt> Package	780	=head2 Variables in the C<urxvt> Package
424		781
425	=over 4	782	=over 4
426		783
427	=item $urxvt::LIBDIR	784	=item $urxvt::LIBDIR
…		…
440	=item $urxvt::TERM	797	=item $urxvt::TERM
441		798
442	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
443	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
444		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
445	=back	818	=back
446		819
447	=head2 Functions in the C<urxvt> Package	820	=head2 Functions in the C<urxvt> Package
448		821
449	=over 4	822	=over 4
450		823
451	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
452		825
453	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
454	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
455	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
456		830
457	=item urxvt::warn $string	831	=item urxvt::warn $string
458		832
459	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
460	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
461	that calls this function.	835	that calls this function.
462		836
463	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
464	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
465		839
466	Messages have a size limit of 1023 bytes currently.	840	Messages have a size limit of 1023 bytes currently.
467		841
468	=item $is_safe = urxvt::safe	842	=item @terms = urxvt::termlist
469		843
470	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
471	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
472	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).
473		848
474	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
475		850
476	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
477		852
478	=item urxvt::CurrentTime	853	=item urxvt::CurrentTime
479		854
480	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	855	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
481	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	856	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
482	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
483		874
484	Various constants for use in X calls and event processing.	875	Various constants for use in X calls and event processing.
485		876
486	=back	877	=back
487		878
…		…
504		895
505	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
506		897
507	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
508		899
509	=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
510		902
511	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
512	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
513	the bitset.	905	the bitset.
514		906
…		…
520		912
521	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
522		914
523	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	915	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
524		916
		917	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		918
525	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
526	specified one.	920	specified one.
527		921
528	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
529		923
…		…
538	=back	932	=back
539		933
540	=cut	934	=cut
541		935
542	BEGIN {	936	BEGIN {
543	urxvt->bootstrap;
544
545	# overwrite perl's warn	937	# overwrite perl's warn
546	*CORE::GLOBAL::warn = sub {	938	*CORE::GLOBAL::warn = sub {
547	my $msg = join "", @_;	939	my $msg = join "", @_;
548	$msg .= "\n"	940	$msg .= "\n"
549	unless $msg =~ /\n$/;	941	unless $msg =~ /\n$/;
550	urxvt::warn ($msg);	942	urxvt::warn ($msg);
551	};	943	};
552
553	# %ENV is the original startup environment
554	delete $ENV{IFS};
555	delete $ENV{CDPATH};
556	delete $ENV{BASH_ENV};
557	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
558	}	944	}
559		945
560	my @hook_count;	946	no warnings 'utf8';
		947
		948	sub resource {
		949	my ($term, $name, $isarg, $flag, $value) = @_;
		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	}
		980	}
		981
561	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	982	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
562		983
563	sub verbose {	984	sub verbose {
564	my ($level, $msg) = @_;	985	my ($level, $msg) = @_;
565	warn "$msg\n" if $level <= $verbosity;	986	warn "$msg\n" if $level <= $verbosity;
566	}	987	}
567		988
568	my $extension_pkg = "extension0000";
569	my %extension_pkg;	989	my %extension_pkg;
570		990
571	# load a single script into its own package, once only	991	# load a single script into its own package, once only
572	sub extension_package($) {	992	sub extension_package($) {
573	my ($path) = @_;	993	my ($path) = @_;
574		994
575	$extension_pkg{$path} ||= do {	995	$extension_pkg{$path} ||= do {
576	my $pkg = "urxvt::" . ($extension_pkg++);	996	$path =~ /([^\/\\]+)$/;
		997	my $pkg = $1;
		998	$pkg =~ s/[^[:word:]]/_/g;
		999	$pkg = "urxvt::ext::$pkg";
577		1000
578	verbose 3, "loading extension '$path' into package '$pkg'";	1001	verbose 3, "loading extension '$path' into package '$pkg'";
579		1002
580	open my $fh, "<:raw", $path	1003	open my $fh, "<:raw", $path
581	or die "$path: $!";	1004	or die "$path: $!";
582		1005
583	my $source = untaint	1006	my $source =
584	"package $pkg; use strict; use utf8;\n"	1007	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
585	. "use base urxvt::term::extension::;\n"
586	. "#line 1 \"$path\"\n{\n"	1008	. "#line 1 \"$path\"\n{\n"
587	. (do { local $/; <$fh> })	1009	. (do { local $/; <$fh> })
588	. "\n};\n1";	1010	. "\n};\n1";
589		1011
590	eval $source	1012	eval $source
…		…
600	sub invoke {	1022	sub invoke {
601	local $TERM = shift;	1023	local $TERM = shift;
602	my $htype = shift;	1024	my $htype = shift;
603		1025
604	if ($htype == 0) { # INIT	1026	if ($htype == 0) { # INIT
605	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1027	my @dirs = $TERM->perl_libdirs;
606		1028
607	my %ext_arg;	1029	my %ext_arg;
608		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
609	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1040	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
610	if ($_ eq "default") {	1041	if ($_ eq "default") {
611	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	1042	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
612	} elsif (/^-(.*)$/) {	1043	} elsif (/^-(.*)$/) {
613	delete $ext_arg{$1};	1044	delete $ext_arg{$1};
614	} elsif (/^([^<]+)<(.*)>$/) {	1045	} elsif (/^([^<]+)<(.*)>$/) {
615	push @{ $ext_arg{$1} }, $2;	1046	push @{ $ext_arg{$1} }, $2;
616	} else {	1047	} else {
617	$ext_arg{$_} ||= [];	1048	$ext_arg{$_} ||= [];
618	}	1049	}
619	}	1050	}
620		1051
621	while (my ($ext, $argv) = each %ext_arg) {	1052	for my $ext (sort keys %ext_arg) {
622	my @files = grep -f $_, map "$_/$ext", @dirs;	1053	my @files = grep -f $_, map "$_/$ext", @dirs;
623		1054
624	if (@files) {	1055	if (@files) {
625	$TERM->register_package (extension_package $files[0], $argv);	1056	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
626	} else {	1057	} else {
627	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";
628	}	1059	}
629	}	1060	}
630		1061
…		…
636		1067
637	if (my $cb = $TERM->{_hook}[$htype]) {	1068	if (my $cb = $TERM->{_hook}[$htype]) {
638	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1069	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
639	if $verbosity >= 10;	1070	if $verbosity >= 10;
640		1071
641	keys %$cb;	1072	for my $pkg (keys %$cb) {
642
643	while (my ($pkg, $cb) = each %$cb) {
644	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1073	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
645	and last;	1074	$retval ||= $retval_;
646		1075
647	if ($@) {	1076	if ($@) {
648	$TERM->ungrab; # better to lose the grab than the session	1077	$TERM->ungrab; # better to lose the grab than the session
649	warn $@;	1078	warn $@;
650	}	1079	}
…		…
653	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	1082	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
654	if $verbosity >= 11;	1083	if $verbosity >= 11;
655	}	1084	}
656		1085
657	if ($htype == 1) { # DESTROY	1086	if ($htype == 1) { # DESTROY
658	if (my $hook = delete $TERM->{_hook}) {
659	for my $htype (0..$#$hook) {
660	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
661	or set_should_invoke $htype, 0;
662	}
663	}
664
665	# clear package objects	1087	# clear package objects
666	%$_ = () for values %{ $TERM->{_pkg} };	1088	%$_ = () for values %{ $TERM->{_pkg} };
667		1089
668	# clear package	1090	# clear package
669	%$TERM = ();	1091	%$TERM = ();
670	}	1092	}
671		1093
672	$retval	1094	$retval
673	}	1095	}
674		1096
675	sub exec_async(@) {	1097	sub SET_COLOR($$$) {
676	my $pid = fork;	1098	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1099	}
677		1100
678	return	1101	sub rend2mask {
679	if !defined $pid or $pid;	1102	no strict 'refs';
680		1103	my ($str, $mask) = (@_, 0);
681	%ENV = %{ $TERM->env };	1104	my %color = ( fg => undef, bg => undef );
682		1105	my @failed;
683	exec @_;	1106	for my $spec ( split /\s+/, $str ) {
684	_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)
685	}	1124	}
686		1125
687	# urxvt::term::extension	1126	# urxvt::term::extension
688		1127
689	package urxvt::term::extension;	1128	package urxvt::term::extension;
…		…
695	while (my ($name, $cb) = each %hook) {	1134	while (my ($name, $cb) = each %hook) {
696	my $htype = $HOOKTYPE{uc $name};	1135	my $htype = $HOOKTYPE{uc $name};
697	defined $htype	1136	defined $htype
698	or Carp::croak "unsupported hook type '$name'";	1137	or Carp::croak "unsupported hook type '$name'";
699		1138
		1139	$self->set_should_invoke ($htype, +1)
700	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1140	unless exists $self->{term}{_hook}[$htype]{$pkg};
701	$hook_count[$htype]++
702	or urxvt::set_should_invoke $htype, 1;
703	}
704		1141
705	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1142	$self->{term}{_hook}[$htype]{$pkg} = $cb;
706	}	1143	}
707	}	1144	}
708		1145
…		…
713	for my $name (@hook) {	1150	for my $name (@hook) {
714	my $htype = $HOOKTYPE{uc $name};	1151	my $htype = $HOOKTYPE{uc $name};
715	defined $htype	1152	defined $htype
716	or Carp::croak "unsupported hook type '$name'";	1153	or Carp::croak "unsupported hook type '$name'";
717		1154
		1155	$self->set_should_invoke ($htype, -1)
718	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1156	if delete $self->{term}{_hook}[$htype]{$pkg};
719	--$hook_count[$htype]
720	or urxvt::set_should_invoke $htype, 0;
721	}
722	}	1157	}
723	}	1158	}
724		1159
725	our $AUTOLOAD;	1160	our $AUTOLOAD;
726		1161
…		…
764	is that you cannot use blocking APIs, but the non-blocking variant should	1199	is that you cannot use blocking APIs, but the non-blocking variant should
765	work.	1200	work.
766		1201
767	=cut	1202	=cut
768		1203
769	our $VERSION = 1;	1204	our $VERSION = '5.23';
770		1205
771	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1206	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
772	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1207	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
773		1208
774	sub timer {	1209	sub timer {
…		…
776		1211
777	my $cb = $arg{cb};	1212	my $cb = $arg{cb};
778		1213
779	urxvt::timer	1214	urxvt::timer
780	->new	1215	->new
781	->start (urxvt::NOW + $arg{after})	1216	->after ($arg{after}, $arg{interval})
782	->cb (sub {	1217	->cb ($arg{interval} ? $cb : sub {
783	$_[0]->stop; # need to cancel manually	1218	$_[0]->stop; # need to cancel manually
784	$cb->();	1219	$cb->();
785	})	1220	})
786	}	1221	}
787		1222
788	sub io {	1223	sub io {
789	my ($class, %arg) = @_;	1224	my ($class, %arg) = @_;
790		1225
791	my $cb = $arg{cb};	1226	my $cb = $arg{cb};
		1227	my $fd = fileno $arg{fh};
		1228	defined $fd or $fd = $arg{fh};
792		1229
793	bless [$arg{fh}, urxvt::iow	1230	bless [$arg{fh}, urxvt::iow
794	->new	1231	->new
795	->fd (fileno $arg{fh})	1232	->fd ($fd)
796	->events (($arg{poll} =~ /r/ ? 1 : 0)	1233	->events (($arg{poll} =~ /r/ ? 1 : 0)
797	| ($arg{poll} =~ /w/ ? 2 : 0))	1234	| ($arg{poll} =~ /w/ ? 2 : 0))
798	->start	1235	->start
799	->cb (sub {	1236	->cb ($cb)
800	$cb->(($_[1] & 1 ? 'r' : '')
801	. ($_[1] & 2 ? 'w' : ''));
802	})],
803	urxvt::anyevent::	1237	], urxvt::anyevent::
		1238	}
		1239
		1240	sub idle {
		1241	my ($class, %arg) = @_;
		1242
		1243	my $cb = $arg{cb};
		1244
		1245	urxvt::iw
		1246	->new
		1247	->start
		1248	->cb ($cb)
		1249	}
		1250
		1251	sub child {
		1252	my ($class, %arg) = @_;
		1253
		1254	my $cb = $arg{cb};
		1255
		1256	urxvt::pw
		1257	->new
		1258	->start ($arg{pid})
		1259	->cb (sub {
		1260	$_[0]->stop; # need to cancel manually
		1261	$cb->($_[0]->rpid, $_[0]->rstatus);
		1262	})
804	}	1263	}
805		1264
806	sub DESTROY {	1265	sub DESTROY {
807	$_[0][1]->stop;	1266	$_[0][1]->stop;
808	}	1267	}
809		1268
810	sub condvar {	1269	# only needed for AnyEvent < 6 compatibility
811	bless \my $flag, urxvt::anyevent::condvar::	1270	sub one_event {
812	}
813
814	sub urxvt::anyevent::condvar::broadcast {
815	${$_[0]}++;
816	}
817
818	sub urxvt::anyevent::condvar::wait {
819	unless (${$_[0]}) {
820	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1271	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
821	}
822	}	1272	}
823		1273
824	package urxvt::term;	1274	package urxvt::term;
825		1275
826	=head2 The C<urxvt::term> Class	1276	=head2 The C<urxvt::term> Class
…		…
831		1281
832	# find on_xxx subs in the package and register them	1282	# find on_xxx subs in the package and register them
833	# as hooks	1283	# as hooks
834	sub register_package {	1284	sub register_package {
835	my ($self, $pkg, $argv) = @_;	1285	my ($self, $pkg, $argv) = @_;
		1286
		1287	no strict 'refs';
		1288
		1289	urxvt::verbose 6, "register package $pkg to $self";
		1290
		1291	@{"$pkg\::ISA"} = urxvt::term::extension::;
836		1292
837	my $proxy = bless {	1293	my $proxy = bless {
838	_pkg => $pkg,	1294	_pkg => $pkg,
839	argv => $argv,	1295	argv => $argv,
840	}, $pkg;	1296	}, $pkg;
…		…
847	$proxy->enable ($name => $ref);	1303	$proxy->enable ($name => $ref);
848	}	1304	}
849	}	1305	}
850	}	1306	}
851		1307
		1308	sub perl_libdirs {
		1309	map { split /:/ }
		1310	$_[0]->resource ("perl_lib"),
		1311	$ENV{URXVT_PERL_LIB},
		1312	"$ENV{HOME}/.urxvt/ext",
		1313	"$LIBDIR/perl"
		1314	}
		1315
		1316	sub scan_meta {
		1317	my ($self) = @_;
		1318	my @libdirs = perl_libdirs $self;
		1319
		1320	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1321
		1322	my %meta;
		1323
		1324	$self->{meta_libdirs} = join "\x00", @libdirs;
		1325	$self->{meta} = \%meta;
		1326
		1327	for my $dir (reverse @libdirs) {
		1328	opendir my $fh, $dir
		1329	or next;
		1330	for my $ext (readdir $fh) {
		1331	$ext ne "."
		1332	and $ext ne ".."
		1333	and open my $fh, "<", "$dir/$ext"
		1334	or next;
		1335
		1336	while (<$fh>) {
		1337	if (/^#:META:RESOURCE:(.*)/) {
		1338	my ($regex, $type, $desc) = split /:/, $1;
		1339	$regex =~ s/\$\$/$ext/g; # $$ in regex == extension name
		1340	$meta{resource}{$regex} = [$ext, $type, $desc];
		1341	} elsif (/^\s*(?:#|$)/) {
		1342	# skip other comments and empty lines
		1343	} else {
		1344	last; # stop parsing on first non-empty non-comment line
		1345	}
		1346	}
		1347	}
		1348	}
		1349	}
		1350
852	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1351	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
853		1352
854	Creates a new terminal, very similar as if you had started it with system	1353	Creates a new terminal, very similar as if you had started it with system
855	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1354	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
856	hash which defines the environment of the new terminal.	1355	hash which defines the environment of the new terminal.
857		1356
858	Croaks (and probably outputs an error message) if the new instance	1357	Croaks (and probably outputs an error message) if the new instance
859	couldn't be created. Returns C<undef> if the new instance didn't	1358	couldn't be created. Returns C<undef> if the new instance didn't
860	initialise perl, and the terminal object otherwise. The C<init> and	1359	initialise perl, and the terminal object otherwise. The C<init> and
861	C<start> hooks will be called during this call.	1360	C<start> hooks will be called before this call returns, and are free to
		1361	refer to global data (which is race free).
862		1362
863	=cut	1363	=cut
864		1364
865	sub new {	1365	sub new {
866	my ($class, $env, @args) = @_;	1366	my ($class, $env, @args) = @_;
867		1367
		1368	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1369	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1370
868	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1371	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
869	}	1372	}
870		1373
871	=item $term->destroy	1374	=item $term->destroy
872		1375
873	Destroy the terminal object (close the window, free resources	1376	Destroy the terminal object (close the window, free resources
874	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1377	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
875	watchers (timers, io watchers) are still active.	1378	watchers (timers, io watchers) are still active.
876		1379
		1380	=item $term->exec_async ($cmd[, @args])
		1381
		1382	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1383	("starts") programs in the background. This function takes care of setting
		1384	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1385	be preferred over explicit calls to C<exec> or C<system>.
		1386
		1387	Returns the pid of the subprocess or C<undef> on error.
		1388
		1389	=cut
		1390
		1391	sub exec_async {
		1392	my $self = shift;
		1393
		1394	my $pid = fork;
		1395
		1396	return $pid
		1397	if !defined $pid or $pid;
		1398
		1399	%ENV = %{ $self->env };
		1400
		1401	exec @_;
		1402	urxvt::_exit 255;
		1403	}
		1404
877	=item $isset = $term->option ($optval[, $set])	1405	=item $isset = $term->option ($optval[, $set])
878		1406
879	Returns true if the option specified by C<$optval> is enabled, and	1407	Returns true if the option specified by C<$optval> is enabled, and
880	optionally change it. All option values are stored by name in the hash	1408	optionally change it. All option values are stored by name in the hash
881	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1409	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
882		1410
883	Here is a a likely non-exhaustive list of option names, please see the	1411	Here is a likely non-exhaustive list of option names, please see the
884	source file F</src/optinc.h> to see the actual list:	1412	source file F</src/optinc.h> to see the actual list:
885		1413
886	borderLess console cursorBlink cursorUnderline hold iconic insecure	1414	borderLess buffered console cursorBlink cursorUnderline hold iconic
887	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1415	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1416	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
888	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1417	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
889	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1418	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
890	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1419	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
891	tripleclickwords utmpInhibit visualBell	1420	urgentOnBell utmpInhibit visualBell
892		1421
893	=item $value = $term->resource ($name[, $newval])	1422	=item $value = $term->resource ($name[, $newval])
894		1423
895	Returns the current resource value associated with a given name and	1424	Returns the current resource value associated with a given name and
896	optionally sets a new value. Setting values is most useful in the C<init>	1425	optionally sets a new value. Setting values is most useful in the C<init>
…		…
905	likely change).	1434	likely change).
906		1435
907	Please note that resource strings will currently only be freed when the	1436	Please note that resource strings will currently only be freed when the
908	terminal is destroyed, so changing options frequently will eat memory.	1437	terminal is destroyed, so changing options frequently will eat memory.
909		1438
910	Here is a a likely non-exhaustive list of resource names, not all of which	1439	Here is a likely non-exhaustive list of resource names, not all of which
911	are supported in every build, please see the source file F</src/rsinc.h>	1440	are supported in every build, please see the source file F</src/rsinc.h>
912	to see the actual list:	1441	to see the actual list:
913		1442
914	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1443	answerbackstring backgroundPixmap backspace_key blendtype blurradius
915	borderLess color cursorBlink cursorUnderline cutchars delete_key	1444	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
916	display_name embed ext_bwidth fade font geometry hold iconName	1445	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
917	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1446	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1447	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
918	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1448	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
919	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1449	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
920	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1450	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
921	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1451	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
922	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1452	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
923	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1453	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
924	shade term_name title transparent transparent_all tripleclickwords	1454	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1455	term_name title transient_for transparent tripleclickwords urgentOnBell
925	utmpInhibit visualBell	1456	utmpInhibit visualBell
926		1457
927	=cut	1458	=cut
928		1459
929	sub resource($$;$) {	1460	sub resource($$;$) {
930	my ($self, $name) = (shift, shift);	1461	my ($self, $name) = (shift, shift);
931	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1462	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
932	&urxvt::term::_resource	1463	goto &urxvt::term::_resource
933	}	1464	}
934		1465
935	=item $value = $term->x_resource ($pattern)	1466	=item $value = $term->x_resource ($pattern)
936		1467
937	Returns the X-Resource for the given pattern, excluding the program or	1468	Returns the X-Resource for the given pattern, excluding the program or
…		…
941		1472
942	This method should only be called during the C<on_start> hook, as there is	1473	This method should only be called during the C<on_start> hook, as there is
943	only one resource database per display, and later invocations might return	1474	only one resource database per display, and later invocations might return
944	the wrong resources.	1475	the wrong resources.
945		1476
946	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1477	=item $success = $term->parse_keysym ($key, $octets)
947		1478
948	Adds a keymap translation exactly as specified via a resource. See the	1479	Adds a key binding exactly as specified via a resource. See the
949	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1480	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1481
		1482	=item $term->register_command ($keysym, $modifiermask, $string)
		1483
		1484	Adds a key binding. This is a lower level api compared to
		1485	C<parse_keysym>, as it expects a parsed key description, and can be
		1486	used only inside either the C<on_init> hook, to add a binding, or the
		1487	C<on_register_command> hook, to modify a parsed binding.
950		1488
951	=item $rend = $term->rstyle ([$new_rstyle])	1489	=item $rend = $term->rstyle ([$new_rstyle])
952		1490
953	Return and optionally change the current rendition. Text that is output by	1491	Return and optionally change the current rendition. Text that is output by
954	the terminal application will use this style.	1492	the terminal application will use this style.
…		…
962		1500
963	=item ($row, $col) = $term->selection_beg ([$row, $col])	1501	=item ($row, $col) = $term->selection_beg ([$row, $col])
964		1502
965	=item ($row, $col) = $term->selection_end ([$row, $col])	1503	=item ($row, $col) = $term->selection_end ([$row, $col])
966		1504
967	Return the current values of the selection mark, begin or end positions,	1505	Return the current values of the selection mark, begin or end positions.
968	and optionally set them to new values.	1506
		1507	When arguments are given, then the selection coordinates are set to
		1508	C<$row> and C<$col>, and the selection screen is set to the current
		1509	screen.
		1510
		1511	=item $screen = $term->selection_screen ([$screen])
		1512
		1513	Returns the current selection screen, and then optionally sets it.
969		1514
970	=item $term->selection_make ($eventtime[, $rectangular])	1515	=item $term->selection_make ($eventtime[, $rectangular])
971		1516
972	Tries to make a selection as set by C<selection_beg> and	1517	Tries to make a selection as set by C<selection_beg> and
973	C<selection_end>. If C<$rectangular> is true (default: false), a	1518	C<selection_end>. If C<$rectangular> is true (default: false), a
974	rectangular selection will be made. This is the prefered function to make	1519	rectangular selection will be made. This is the preferred function to make
975	a selection.	1520	a selection.
976		1521
977	=item $success = $term->selection_grab ($eventtime)	1522	=item $success = $term->selection_grab ($eventtime[, $clipboard])
978		1523
979	Try to request the primary selection text from the server (for example, as	1524	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1525	true) selection from the server. The corresponding text can be set
980	set by the next method). No visual feedback will be given. This function	1526	with the next method. No visual feedback will be given. This function
981	is mostly useful from within C<on_sel_grab> hooks.	1527	is mostly useful from within C<on_sel_grab> hooks.
982		1528
983	=item $oldtext = $term->selection ([$newtext])	1529	=item $oldtext = $term->selection ([$newtext, $clipboard])
984		1530
985	Return the current selection text and optionally replace it by C<$newtext>.	1531	Return the current selection (clipboard if C<$clipboard> is true) text
		1532	and optionally replace it by C<$newtext>.
		1533
		1534	=item $term->selection_clear ([$clipboard])
		1535
		1536	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
986		1537
987	=item $term->overlay_simple ($x, $y, $text)	1538	=item $term->overlay_simple ($x, $y, $text)
988		1539
989	Create a simple multi-line overlay box. See the next method for details.	1540	Create a simple multi-line overlay box. See the next method for details.
990		1541
…		…
1020		1571
1021	The methods currently supported on C<urxvt::overlay> objects are:	1572	The methods currently supported on C<urxvt::overlay> objects are:
1022		1573
1023	=over 4	1574	=over 4
1024		1575
1025	=item $overlay->set ($x, $y, $text, $rend)	1576	=item $overlay->set ($x, $y, $text[, $rend])
1026		1577
1027	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1578	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1028	text in rxvt-unicode's special encoding and an array of rendition values	1579	text in rxvt-unicode's special encoding and an array of rendition values
1029	at a specific position inside the overlay.	1580	at a specific position inside the overlay.
		1581
		1582	If C<$rend> is missing, then the rendition will not be changed.
1030		1583
1031	=item $overlay->hide	1584	=item $overlay->hide
1032		1585
1033	If visible, hide the overlay, but do not destroy it.	1586	If visible, hide the overlay, but do not destroy it.
1034		1587
…		…
1104		1657
1105	Normally its not a good idea to use this function, as programs might be	1658	Normally its not a good idea to use this function, as programs might be
1106	confused by changes in cursor position or scrolling. Its useful inside a	1659	confused by changes in cursor position or scrolling. Its useful inside a
1107	C<on_add_lines> hook, though.	1660	C<on_add_lines> hook, though.
1108		1661
		1662	=item $term->scr_change_screen ($screen)
		1663
		1664	Switch to given screen - 0 primary, 1 secondary.
		1665
1109	=item $term->cmd_parse ($octets)	1666	=item $term->cmd_parse ($octets)
1110		1667
1111	Similar to C<scr_add_lines>, but the argument must be in the	1668	Similar to C<scr_add_lines>, but the argument must be in the
1112	locale-specific encoding of the terminal and can contain command sequences	1669	locale-specific encoding of the terminal and can contain command sequences
1113	(escape codes) that will be interpreted.	1670	(escape codes) that will be interpreted.
1114		1671
1115	=item $term->tt_write ($octets)	1672	=item $term->tt_write ($octets)
1116		1673
1117	Write the octets given in C<$data> to the tty (i.e. as program input). To	1674	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1118	pass characters instead of octets, you should convert your strings first	1675	pass characters instead of octets, you should convert your strings first
1119	to the locale-specific encoding using C<< $term->locale_encode >>.	1676	to the locale-specific encoding using C<< $term->locale_encode >>.
		1677
		1678	=item $term->tt_paste ($octets)
		1679
		1680	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1681	CR and bracketing the data with control sequences if bracketed paste mode
		1682	is set.
1120		1683
1121	=item $old_events = $term->pty_ev_events ([$new_events])	1684	=item $old_events = $term->pty_ev_events ([$new_events])
1122		1685
1123	Replaces the event mask of the pty watcher by the given event mask. Can	1686	Replaces the event mask of the pty watcher by the given event mask. Can
1124	be used to suppress input and output handling to the pty/tty. See the	1687	be used to suppress input and output handling to the pty/tty. See the
1125	description of C<< urxvt::timer->events >>. Make sure to always restore	1688	description of C<< urxvt::timer->events >>. Make sure to always restore
1126	the previous value.	1689	the previous value.
1127		1690
		1691	=item $fd = $term->pty_fd
		1692
		1693	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1694	is used.
		1695
1128	=item $windowid = $term->parent	1696	=item $windowid = $term->parent
1129		1697
1130	Return the window id of the toplevel window.	1698	Return the window id of the toplevel window.
1131		1699
1132	=item $windowid = $term->vt	1700	=item $windowid = $term->vt
1133		1701
1134	Return the window id of the terminal window.	1702	Return the window id of the terminal window.
1135		1703
		1704	=item $term->vt_emask_add ($x_event_mask)
		1705
		1706	Adds the specified events to the vt event mask. Useful e.g. when you want
		1707	to receive pointer events all the times:
		1708
		1709	$term->vt_emask_add (urxvt::PointerMotionMask);
		1710
		1711	=item $term->set_urgency ($set)
		1712
		1713	Enable/disable the urgency hint on the toplevel window.
		1714
		1715	=item $term->focus_in
		1716
		1717	=item $term->focus_out
		1718
		1719	=item $term->key_press ($state, $keycode[, $time])
		1720
		1721	=item $term->key_release ($state, $keycode[, $time])
		1722
		1723	Deliver various fake events to to terminal.
		1724
1136	=item $window_width = $term->width	1725	=item $window_width = $term->width
1137		1726
1138	=item $window_height = $term->height	1727	=item $window_height = $term->height
1139		1728
1140	=item $font_width = $term->fwidth	1729	=item $font_width = $term->fwidth
…		…
1153		1742
1154	=item $max_scrollback = $term->saveLines	1743	=item $max_scrollback = $term->saveLines
1155		1744
1156	=item $nrow_plus_saveLines = $term->total_rows	1745	=item $nrow_plus_saveLines = $term->total_rows
1157		1746
1158	=item $lines_in_scrollback = $term->nsaved	1747	=item $topmost_scrollback_row = $term->top_row
1159		1748
1160	Return various integers describing terminal characteristics.	1749	Return various integers describing terminal characteristics.
1161		1750
1162	=item $x_display = $term->display_id	1751	=item $x_display = $term->display_id
1163		1752
…		…
1170	=item $env = $term->env	1759	=item $env = $term->env
1171		1760
1172	Returns a copy of the environment in effect for the terminal as a hashref	1761	Returns a copy of the environment in effect for the terminal as a hashref
1173	similar to C<\%ENV>.	1762	similar to C<\%ENV>.
1174		1763
		1764	=item @envv = $term->envv
		1765
		1766	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1767
		1768	=item @argv = $term->argv
		1769
		1770	Return the argument vector as this terminal, similar to @ARGV, but
		1771	includes the program name as first element.
		1772
1175	=cut	1773	=cut
1176		1774
1177	sub env {	1775	sub env {
1178	if (my $env = $_[0]->_env) {
1179	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1776	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1180	} else {
1181	+{ %ENV }
1182	}
1183	}	1777	}
1184		1778
1185	=item $modifiermask = $term->ModLevel3Mask	1779	=item $modifiermask = $term->ModLevel3Mask
1186		1780
1187	=item $modifiermask = $term->ModMetaMask	1781	=item $modifiermask = $term->ModMetaMask
…		…
1189	=item $modifiermask = $term->ModNumLockMask	1783	=item $modifiermask = $term->ModNumLockMask
1190		1784
1191	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1785	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1192	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1786	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1193		1787
		1788	=item $screen = $term->current_screen
		1789
		1790	Returns the currently displayed screen (0 primary, 1 secondary).
		1791
		1792	=item $cursor_is_hidden = $term->hidden_cursor
		1793
		1794	Returns whether the cursor is currently hidden or not.
		1795
1194	=item $view_start = $term->view_start ([$newvalue])	1796	=item $view_start = $term->view_start ([$newvalue])
1195		1797
1196	Returns the negative row number of the topmost line. Minimum value is	1798	Returns the row number of the topmost displayed line. Maximum value is
1197	C<0>, which displays the normal terminal contents. Larger values scroll	1799	C<0>, which displays the normal terminal contents. Lower values scroll
1198	this many lines into the scrollback buffer.	1800	this many lines into the scrollback buffer.
1199		1801
1200	=item $term->want_refresh	1802	=item $term->want_refresh
1201		1803
1202	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1804	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1205		1807
1206	Used after changing terminal contents to display them.	1808	Used after changing terminal contents to display them.
1207		1809
1208	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1810	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1209		1811
1210	Returns the text of the entire row with number C<$row_number>. Row C<0>	1812	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1211	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1813	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1212	terminal line. The scrollback buffer starts at line C<-1> and extends to
1213	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1814	terminal line. Nothing will be returned if a nonexistent line
1214	is requested.	1815	is requested.
1215		1816
1216	If C<$new_text> is specified, it will replace characters in the current	1817	If C<$new_text> is specified, it will replace characters in the current
1217	line, starting at column C<$start_col> (default C<0>), which is useful	1818	line, starting at column C<$start_col> (default C<0>), which is useful
1218	to replace only parts of a line. The font index in the rendition will	1819	to replace only parts of a line. The font index in the rendition will
1219	automatically be updated.	1820	automatically be updated.
1220		1821
1221	C<$text> is in a special encoding: tabs and wide characters that use more	1822	C<$text> is in a special encoding: tabs and wide characters that use more
1222	than one cell when displayed are padded with urxvt::NOCHAR characters	1823	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1223	(C<chr 65535>). Characters with combining characters and other characters	1824	characters. Characters with combining characters and other characters that
1224	that do not fit into the normal tetx encoding will be replaced with	1825	do not fit into the normal text encoding will be replaced with characters
1225	characters in the private use area.	1826	in the private use area.
1226		1827
1227	You have to obey this encoding when changing text. The advantage is	1828	You have to obey this encoding when changing text. The advantage is
1228	that C<substr> and similar functions work on screen cells and not on	1829	that C<substr> and similar functions work on screen cells and not on
1229	characters.	1830	characters.
1230		1831
…		…
1374	where one character corresponds to one screen cell. See	1975	where one character corresponds to one screen cell. See
1375	C<< $term->ROW_t >> for details.	1976	C<< $term->ROW_t >> for details.
1376		1977
1377	=item $string = $term->special_decode $text	1978	=item $string = $term->special_decode $text
1378		1979
1379	Converts rxvt-unicodes text reprsentation into a perl string. See	1980	Converts rxvt-unicodes text representation into a perl string. See
1380	C<< $term->ROW_t >> for details.	1981	C<< $term->ROW_t >> for details.
1381		1982
1382	=item $success = $term->grab_button ($button, $modifiermask)	1983	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1383		1984
		1985	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1986
1384	Registers a synchronous button grab. See the XGrabButton manpage.	1987	Register/unregister a synchronous button grab. See the XGrabButton
		1988	manpage.
1385		1989
1386	=item $success = $term->grab ($eventtime[, $sync])	1990	=item $success = $term->grab ($eventtime[, $sync])
1387		1991
1388	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1992	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1389	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1993	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1390		1994
1391	=item $term->allow_events_async	1995	=item $term->allow_events_async
1392		1996
1393	Calls XAllowEvents with AsyncBoth for the most recent grab.	1997	Calls XAllowEvents with AsyncBoth for the most recent grab.
1394		1998
…		…
1401	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2005	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1402	recent grab.	2006	recent grab.
1403		2007
1404	=item $term->ungrab	2008	=item $term->ungrab
1405		2009
1406	Calls XUngrab for the most recent grab. Is called automatically on	2010	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1407	evaluation errors, as it is better to lose the grab in the error case as	2011	evaluation errors, as it is better to lose the grab in the error case as
1408	the session.	2012	the session.
		2013
		2014	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		2015
		2016	=item $atom_name = $term->XGetAtomName ($atom)
		2017
		2018	=item @atoms = $term->XListProperties ($window)
		2019
		2020	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		2021
		2022	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		2023
		2024	=item $term->XDeleteProperty ($window, $property)
		2025
		2026	=item $window = $term->DefaultRootWindow
		2027
		2028	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		2029
		2030	=item $term->XMapWindow ($window)
		2031
		2032	=item $term->XUnmapWindow ($window)
		2033
		2034	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		2035
		2036	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		2037
		2038	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2039
		2040	=item $keysym = $term->XStringToKeysym ($string)
		2041
		2042	=item $string = $term->XKeysymToString ($keysym)
		2043
		2044	Various X or X-related functions. The C<$term> object only serves as
		2045	the source of the display, otherwise those functions map more-or-less
		2046	directly onto the X functions of the same name.
1409		2047
1410	=back	2048	=back
1411		2049
1412	=cut	2050	=cut
1413		2051
…		…
1477	my ($self, $text, $cb) = @_;	2115	my ($self, $text, $cb) = @_;
1478		2116
1479	$self->add_item ({ type => "button", text => $text, activate => $cb});	2117	$self->add_item ({ type => "button", text => $text, activate => $cb});
1480	}	2118	}
1481		2119
1482	=item $popup->add_toggle ($text, $cb, $initial_value)	2120	=item $popup->add_toggle ($text, $initial_value, $cb)
1483		2121
1484	Adds a toggle/checkbox item to the popup. Teh callback gets called	2122	Adds a toggle/checkbox item to the popup. The callback gets called
1485	whenever it gets toggled, with a boolean indicating its value as its first	2123	whenever it gets toggled, with a boolean indicating its new value as its
1486	argument.	2124	first argument.
1487		2125
1488	=cut	2126	=cut
1489		2127
1490	sub add_toggle {	2128	sub add_toggle {
1491	my ($self, $text, $cb, $value) = @_;	2129	my ($self, $text, $value, $cb) = @_;
1492		2130
1493	my $item; $item = {	2131	my $item; $item = {
1494	type => "button",	2132	type => "button",
1495	text => " $text",	2133	text => " $text",
1496	value => $value,	2134	value => $value,
…		…
1515	my $env = $self->{term}->env;	2153	my $env = $self->{term}->env;
1516	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2154	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1517	delete $env->{LC_ALL};	2155	delete $env->{LC_ALL};
1518	$env->{LC_CTYPE} = $self->{term}->locale;	2156	$env->{LC_CTYPE} = $self->{term}->locale;
1519		2157
1520	urxvt::term->new ($env, $self->{term}->resource ("name"),	2158	my $term = urxvt::term->new (
1521	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2159	$env, "popup",
		2160	"--perl-lib" => "", "--perl-ext-common" => "",
		2161	"-pty-fd" => -1, "-sl" => 0,
		2162	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1522	"--transient-for" => $self->{term}->parent,	2163	"--transient-for" => $self->{term}->parent,
1523	"-display" => $self->{term}->display_id,	2164	"-display" => $self->{term}->display_id,
1524	"-pe" => "urxvt-popup")	2165	"-pe" => "urxvt-popup",
1525	or die "unable to create popup window\n";	2166	) or die "unable to create popup window\n";
		2167
		2168	unless (delete $term->{urxvt_popup_init_done}) {
		2169	$term->ungrab;
		2170	$term->destroy;
		2171	die "unable to initialise popup window\n";
		2172	}
1526	}	2173	}
1527		2174
1528	sub DESTROY {	2175	sub DESTROY {
1529	my ($self) = @_;	2176	my ($self) = @_;
1530		2177
1531	delete $self->{term}{_destroy}{$self};	2178	delete $self->{term}{_destroy}{$self};
1532	$self->{term}->ungrab;	2179	$self->{term}->ungrab;
1533	}	2180	}
1534		2181
1535	=back	2182	=back
		2183
		2184	=cut
		2185
		2186	package urxvt::watcher;
1536		2187
1537	=head2 The C<urxvt::timer> Class	2188	=head2 The C<urxvt::timer> Class
1538		2189
1539	This class implements timer watchers/events. Time is represented as a	2190	This class implements timer watchers/events. Time is represented as a
1540	fractional number of seconds since the epoch. Example:	2191	fractional number of seconds since the epoch. Example:
…		…
1544	->new	2195	->new
1545	->interval (1)	2196	->interval (1)
1546	->cb (sub {	2197	->cb (sub {
1547	$term->{overlay}->set (0, 0,	2198	$term->{overlay}->set (0, 0,
1548	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2199	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1549	});	2200	});
1550		2201
1551	=over 4	2202	=over 4
1552		2203
1553	=item $timer = new urxvt::timer	2204	=item $timer = new urxvt::timer
1554		2205
…		…
1557		2208
1558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2209	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1559		2210
1560	Set the callback to be called when the timer triggers.	2211	Set the callback to be called when the timer triggers.
1561		2212
1562	=item $tstamp = $timer->at
1563
1564	Return the time this watcher will fire next.
1565
1566	=item $timer = $timer->set ($tstamp)	2213	=item $timer = $timer->set ($tstamp[, $interval])
1567		2214
1568	Set the time the event is generated to $tstamp.	2215	Set the time the event is generated to $tstamp (and optionally specifies a
		2216	new $interval).
1569		2217
1570	=item $timer = $timer->interval ($interval)	2218	=item $timer = $timer->interval ($interval)
1571		2219
1572	Normally (and when C<$interval> is C<0>), the timer will automatically	2220	By default (and when C<$interval> is C<0>), the timer will automatically
1573	stop after it has fired once. If C<$interval> is non-zero, then the timer	2221	stop after it has fired once. If C<$interval> is non-zero, then the timer
1574	is automatically rescheduled at the given intervals.	2222	is automatically rescheduled at the given intervals.
1575		2223
1576	=item $timer = $timer->start	2224	=item $timer = $timer->start
1577		2225
1578	Start the timer.	2226	Start the timer.
1579		2227
1580	=item $timer = $timer->start ($tstamp)	2228	=item $timer = $timer->start ($tstamp[, $interval])
1581		2229
1582	Set the event trigger time to C<$tstamp> and start the timer.	2230	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2231	also replaces the interval.
		2232
		2233	=item $timer = $timer->after ($delay[, $interval])
		2234
		2235	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1583		2236
1584	=item $timer = $timer->stop	2237	=item $timer = $timer->stop
1585		2238
1586	Stop the timer.	2239	Stop the timer.
1587		2240
…		…
1593		2246
1594	$term->{socket} = ...	2247	$term->{socket} = ...
1595	$term->{iow} = urxvt::iow	2248	$term->{iow} = urxvt::iow
1596	->new	2249	->new
1597	->fd (fileno $term->{socket})	2250	->fd (fileno $term->{socket})
1598	->events (urxvt::EVENT_READ)	2251	->events (urxvt::EV_READ)
1599	->start	2252	->start
1600	->cb (sub {	2253	->cb (sub {
1601	my ($iow, $revents) = @_;	2254	my ($iow, $revents) = @_;
1602	# $revents must be 1 here, no need to check	2255	# $revents must be 1 here, no need to check
1603	sysread $term->{socket}, my $buf, 8192	2256	sysread $term->{socket}, my $buf, 8192
…		…
1616	Set the callback to be called when io events are triggered. C<$reventmask>	2269	Set the callback to be called when io events are triggered. C<$reventmask>
1617	is a bitset as described in the C<events> method.	2270	is a bitset as described in the C<events> method.
1618		2271
1619	=item $iow = $iow->fd ($fd)	2272	=item $iow = $iow->fd ($fd)
1620		2273
1621	Set the filedescriptor (not handle) to watch.	2274	Set the file descriptor (not handle) to watch.
1622		2275
1623	=item $iow = $iow->events ($eventmask)	2276	=item $iow = $iow->events ($eventmask)
1624		2277
1625	Set the event mask to watch. The only allowed values are	2278	Set the event mask to watch. The only allowed values are
1626	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2279	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1627	together, or C<urxvt::EVENT_NONE>.	2280	together, or C<urxvt::EV_NONE>.
1628		2281
1629	=item $iow = $iow->start	2282	=item $iow = $iow->start
1630		2283
1631	Start watching for requested events on the given handle.	2284	Start watching for requested events on the given handle.
1632		2285
1633	=item $iow = $iow->stop	2286	=item $iow = $iow->stop
1634		2287
1635	Stop watching for events on the given filehandle.	2288	Stop watching for events on the given file handle.
		2289
		2290	=back
		2291
		2292	=head2 The C<urxvt::iw> Class
		2293
		2294	This class implements idle watchers, that get called automatically when
		2295	the process is idle. They should return as fast as possible, after doing
		2296	some useful work.
		2297
		2298	=over 4
		2299
		2300	=item $iw = new urxvt::iw
		2301
		2302	Create a new idle watcher object in stopped state.
		2303
		2304	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2305
		2306	Set the callback to be called when the watcher triggers.
		2307
		2308	=item $timer = $timer->start
		2309
		2310	Start the watcher.
		2311
		2312	=item $timer = $timer->stop
		2313
		2314	Stop the watcher.
		2315
		2316	=back
		2317
		2318	=head2 The C<urxvt::pw> Class
		2319
		2320	This class implements process watchers. They create an event whenever a
		2321	process exits, after which they stop automatically.
		2322
		2323	my $pid = fork;
		2324	...
		2325	$term->{pw} = urxvt::pw
		2326	->new
		2327	->start ($pid)
		2328	->cb (sub {
		2329	my ($pw, $exit_status) = @_;
		2330	...
		2331	});
		2332
		2333	=over 4
		2334
		2335	=item $pw = new urxvt::pw
		2336
		2337	Create a new process watcher in stopped state.
		2338
		2339	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2340
		2341	Set the callback to be called when the timer triggers.
		2342
		2343	=item $pw = $timer->start ($pid)
		2344
		2345	Tells the watcher to start watching for process C<$pid>.
		2346
		2347	=item $pw = $pw->stop
		2348
		2349	Stop the watcher.
1636		2350
1637	=back	2351	=back
1638		2352
1639	=head1 ENVIRONMENT	2353	=head1 ENVIRONMENT
1640		2354
…		…
1649		2363
1650	=item >= 3 - script loading and management	2364	=item >= 3 - script loading and management
1651		2365
1652	=item >=10 - all called hooks	2366	=item >=10 - all called hooks
1653		2367
1654	=item >=11 - hook reutrn values	2368	=item >=11 - hook return values
1655		2369
1656	=back	2370	=back
1657		2371
1658	=head1 AUTHOR	2372	=head1 AUTHOR
1659		2373
1660	Marc Lehmann <pcg@goof.com>	2374	Marc Lehmann <schmorp@schmorp.de>
1661	http://software.schmorp.de/pkg/rxvt-unicode	2375	http://software.schmorp.de/pkg/rxvt-unicode
1662		2376
1663	=cut	2377	=cut
1664		2378
1665	1	2379	1
		2380
		2381	# vim: sw=3:

Diff Legend

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