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.111 by root, Thu Jan 19 19:52:54 2006 UTC vs.
Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 2011 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
62	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
63	...	66	...
64		67
65	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
66	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
67	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
68	between two vertical bars:	71	between two vertical bars:
69		72
70	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: ^(/[^:]+):\
71		81
72	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
73	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
74		84
75	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
87	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
88		98
89	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
90	runtime.	100	runtime.
91		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
92	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
93		120
94	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
95	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
96	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
97		124
98	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
100	popup is displayed.	127	popup is being displayed.
101		128
102	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
103	is in C<$_>, which can be used to decide wether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
104	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
105	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
106	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
107		134
108	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
109	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
110	C<a>s:	137	C<a>s:
111		138
112	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
114	: ()	141	: ()
115	};	142	};
116		143
117	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
118		145
…		…
125	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>
126	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
127	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
128	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
129	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
130	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.
131		189
132	=item selection-autotransform	190	=item selection-autotransform
133		191
134	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
135	whenever a selection is made.	193	whenever a selection is made.
…		…
162		220
163	The first line tells the selection code to treat the unchanging part of	221	The first line tells the selection code to treat the unchanging part of
164	every error message as a selection pattern, and the second line transforms	222	every error message as a selection pattern, and the second line transforms
165	the message into vi commands to load the file.	223	the message into vi commands to load the file.
166		224
167	=item mark-urls	225	=item tabbed
168		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
169	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
170	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
171	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
172	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.
173		258
174	=item automove-background	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.
175		263
176	This is basically a one-line extension that dynamically changes the background pixmap offset	264	It is possible to activate the most recently seen match or a list of matches
177	to the window position, in effect creating the same effect as pseudo transparency with	265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
178	a custom pixmap. No scaling is supported in this mode. Exmaple:	266	"perl:matcher:list" as seen in the example below.
179		267
180	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	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.
181		315
182	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
183		317
184	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
185	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
186	similar-looking ascii character.	320	similar-looking ascii character.
187		321
188	=item digital-clock	322	=item digital-clock
189		323
190	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.
191		393
192	=item example-refresh-hooks	394	=item example-refresh-hooks
193		395
194	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
195	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
196	overlays or changes.	398	overlays or changes.
197		399
198	=item selection-pastebin	400	=item confirm-paste
199		401
200	This is a little rarely useful extension that Uploads the selection as	402	Displays a confirmation dialog when a paste containing at least a full
201	textfile to a remote site (or does other things). (The implementation is	403	line is detected.
202	not currently secure for use in a multiuser environment as it writes to
203	F</tmp> directly.).
204		404
205	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	405	=item bell-command
206	i.e.
207		406
208	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin	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:
209		410
210	Pressing this combination runs a command with C<%> replaced by the name of	411	URxvt.bell-command: notify-send "Beep, Beep"
211	the textfile. This command can be set via a resource:
212
213	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
214
215	And the default is likely not useful to anybody but the few people around
216	here :)
217
218	The name of the textfile is the hex encoded md5 sum of the selection, so
219	the same content should lead to the same filename.
220
221	After a successful upload the selection will be replaced by the text given
222	in the C<selection-pastebin-url> resource (again, the % is the placeholder
223	for the filename):
224
225	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
226		412
227	=back	413	=back
228		414
229	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
230		416
…		…
246		432
247	=over 4	433	=over 4
248		434
249	=item $text	435	=item $text
250		436
251	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
252	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.
253		439
254	=item $string	440	=item $string
255		441
256	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
…		…
260	=item $octets	446	=item $octets
261		447
262	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
263	locale-specific way.	449	locale-specific way.
264		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
265	=back	457	=back
266		458
267	=head2 Extension Objects	459	=head2 Extension Objects
268		460
269	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
270	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,
271	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
272	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
273	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
274	use.	467	internal use.
275		468
276	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
277	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
278		471
279	It has the following methods and data members:	472	It has the following methods and data members:
…		…
300	=head2 Hooks	493	=head2 Hooks
301		494
302	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
303	called whenever the relevant event happens.	496	called whenever the relevant event happens.
304		497
305	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
306	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
307		500
308	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
309	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
310	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.
311		504
312	I<< When in doubt, return a false value (preferably C<()>). >>	505	I<< When in doubt, return a false value (preferably C<()>). >>
313		506
314	=over 4	507	=over 4
315		508
316	=item on_init $term	509	=item on_init $term
317		510
318	Called after a new terminal object has been initialized, but before	511	Called after a new terminal object has been initialized, but before
319	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
320	call or deliver senseless data, as terminal size and other characteristics	513	call or deliver senseless data, as terminal size and other characteristics
321	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
322	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).
323		527
324	=item on_reset $term	528	=item on_reset $term
325		529
326	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
327	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
328	variables.	532	variables.
329		533
330	=item on_start $term
331
332	Called at the very end of initialisation of a new terminal, just before
333	returning to the mainloop.
334
335	=item on_child_start $term, $pid	534	=item on_child_start $term, $pid
336		535
337	Called just after the child process has been C<fork>ed.	536	Called just after the child process has been C<fork>ed.
338		537
339	=item on_child_exit $term, $status	538	=item on_child_exit $term, $status
…		…
354		553
355	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
356	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
357	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
358		557
359	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.
360		559
361	=item on_sel_extend $term	560	=item on_sel_extend $term
362		561
363	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
364	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
365	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
366	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
367	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
368	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
369		568
370	See the F<selection> example extension.	569	See the F<selection> example extension.
371		570
372	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
373		572
374	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
375	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
376	show this many lines of scrollback.	575	show this many lines of scrollback.
377		576
378	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
379		578
…		…
383		582
384	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,
385	$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
386	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
387		586
388	=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
389		598
390	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
391	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
392	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
393	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,
394	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
395	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	}
396		615
397	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,
398	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
399	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.
400		622
401	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
402		624
403	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
404	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
…		…
409	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
410		632
411	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
412	suppress or filter tty input.	634	suppress or filter tty input.
413		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
414	=item on_line_update $term, $row	643	=item on_line_update $term, $row
415		644
416	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
417	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
418	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,
…		…
425	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
426	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
427		656
428	=item on_refresh_begin $term	657	=item on_refresh_begin $term
429		658
430	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
431	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
432	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
433	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
434		663
435	=item on_refresh_end $term	664	=item on_refresh_end $term
436		665
437	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>.
438		667
439	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
440		669
441	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
442	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>
443	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_resize_all_windows $term, $new_width, $new_height
		678
		679	Called just after the new window size has been calculated, but before
		680	windows are actually being resized or hints are being set. If this hook
		681	returns TRUE, setting of the window hints is being skipped.
444		682
445	=item on_x_event $term, $event	683	=item on_x_event $term, $event
446		684
447	Called on every X event received on the vt window (and possibly other	685	Called on every X event received on the vt window (and possibly other
448	windows). Should only be used as a last resort. Most event structure	686	windows). Should only be used as a last resort. Most event structure
449	members are not passed.	687	members are not passed.
450		688
		689	=item on_root_event $term, $event
		690
		691	Like C<on_x_event>, but is called for events on the root window.
		692
451	=item on_focus_in $term	693	=item on_focus_in $term
452		694
453	Called whenever the window gets the keyboard focus, before rxvt-unicode	695	Called whenever the window gets the keyboard focus, before rxvt-unicode
454	does focus in processing.	696	does focus in processing.
455		697
456	=item on_focus_out $term	698	=item on_focus_out $term
457		699
458	Called wheneever the window loses keyboard focus, before rxvt-unicode does	700	Called whenever the window loses keyboard focus, before rxvt-unicode does
459	focus out processing.	701	focus out processing.
460		702
461	=item on_configure_notify $term, $event	703	=item on_configure_notify $term, $event
462		704
		705	=item on_property_notify $term, $event
		706
463	=item on_key_press $term, $event, $keysym, $octets	707	=item on_key_press $term, $event, $keysym, $octets
464		708
465	=item on_key_release $term, $event, $keysym	709	=item on_key_release $term, $event, $keysym
466		710
467	=item on_button_press $term, $event	711	=item on_button_press $term, $event
…		…
472		716
473	=item on_map_notify $term, $event	717	=item on_map_notify $term, $event
474		718
475	=item on_unmap_notify $term, $event	719	=item on_unmap_notify $term, $event
476		720
477	Called whenever the corresponding X event is received for the terminal If	721	Called whenever the corresponding X event is received for the terminal. If
478	the hook returns true, then the even will be ignored by rxvt-unicode.	722	the hook returns true, then the event will be ignored by rxvt-unicode.
479		723
480	The event is a hash with most values as named by Xlib (see the XEvent	724	The event is a hash with most values as named by Xlib (see the XEvent
481	manpage), with the additional members C<row> and C<col>, which are the row	725	manpage), with the additional members C<row> and C<col>, which are the
482	and column under the mouse cursor.	726	(real, not screen-based) row and column under the mouse cursor.
483		727
484	C<on_key_press> additionally receives the string rxvt-unicode would	728	C<on_key_press> additionally receives the string rxvt-unicode would
485	output, if any, in locale-specific encoding.	729	output, if any, in locale-specific encoding.
486		730
487	subwindow.	731	subwindow.
		732
		733	=item on_client_message $term, $event
		734
		735	=item on_wm_protocols $term, $event
		736
		737	=item on_wm_delete_window $term, $event
		738
		739	Called when various types of ClientMessage events are received (all with
		740	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		741
		742	=item on_bell $term
		743
		744	Called on receipt of a bell character.
488		745
489	=back	746	=back
490		747
491	=cut	748	=cut
492		749
…		…
498	use Scalar::Util ();	755	use Scalar::Util ();
499	use List::Util ();	756	use List::Util ();
500		757
501	our $VERSION = 1;	758	our $VERSION = 1;
502	our $TERM;	759	our $TERM;
		760	our @TERM_INIT;
		761	our @TERM_EXT;
503	our @HOOKNAME;	762	our @HOOKNAME;
504	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	763	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
505	our %OPTION;	764	our %OPTION;
506		765
507	our $LIBDIR;	766	our $LIBDIR;
508	our $RESNAME;	767	our $RESNAME;
509	our $RESCLASS;	768	our $RESCLASS;
510	our $RXVTNAME;	769	our $RXVTNAME;
511		770
		771	our $NOCHAR = chr 0xffff;
		772
512	=head2 Variables in the C<urxvt> Package	773	=head2 Variables in the C<urxvt> Package
513		774
514	=over 4	775	=over 4
515		776
516	=item $urxvt::LIBDIR	777	=item $urxvt::LIBDIR
…		…
529	=item $urxvt::TERM	790	=item $urxvt::TERM
530		791
531	The current terminal. This variable stores the current C<urxvt::term>	792	The current terminal. This variable stores the current C<urxvt::term>
532	object, whenever a callback/hook is executing.	793	object, whenever a callback/hook is executing.
533		794
		795	=item @urxvt::TERM_INIT
		796
		797	All code references in this array will be called as methods of the next newly
		798	created C<urxvt::term> object (during the C<on_init> phase). The array
		799	gets cleared before the code references that were in it are being executed,
		800	so references can push themselves onto it again if they so desire.
		801
		802	This complements to the perl-eval command line option, but gets executed
		803	first.
		804
		805	=item @urxvt::TERM_EXT
		806
		807	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		808	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		809	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		810
534	=back	811	=back
535		812
536	=head2 Functions in the C<urxvt> Package	813	=head2 Functions in the C<urxvt> Package
537		814
538	=over 4	815	=over 4
539		816
540	=item urxvt::fatal $errormessage	817	=item urxvt::fatal $errormessage
541		818
542	Fatally aborts execution with the given error message. Avoid at all	819	Fatally aborts execution with the given error message (which should
543	costs! The only time this is acceptable is when the terminal process	820	include a trailing newline). Avoid at all costs! The only time this
544	starts up.	821	is acceptable (and useful) is in the init hook, where it prevents the
		822	terminal from starting up.
545		823
546	=item urxvt::warn $string	824	=item urxvt::warn $string
547		825
548	Calls C<rxvt_warn> with the given string which should not include a	826	Calls C<rxvt_warn> with the given string which should include a trailing
549	newline. The module also overwrites the C<warn> builtin with a function	827	newline. The module also overwrites the C<warn> builtin with a function
550	that calls this function.	828	that calls this function.
551		829
552	Using this function has the advantage that its output ends up in the	830	Using this function has the advantage that its output ends up in the
553	correct place, e.g. on stderr of the connecting urxvtc client.	831	correct place, e.g. on stderr of the connecting urxvtc client.
554		832
555	Messages have a size limit of 1023 bytes currently.	833	Messages have a size limit of 1023 bytes currently.
		834
		835	=item @terms = urxvt::termlist
		836
		837	Returns all urxvt::term objects that exist in this process, regardless of
		838	whether they are started, being destroyed etc., so be careful. Only term
		839	objects that have perl extensions attached will be returned (because there
		840	is no urxvt::term object associated with others).
556		841
557	=item $time = urxvt::NOW	842	=item $time = urxvt::NOW
558		843
559	Returns the "current time" (as per the event loop).	844	Returns the "current time" (as per the event loop).
560		845
…		…
603		888
604	=item $rend = urxvt::OVERLAY_RSTYLE	889	=item $rend = urxvt::OVERLAY_RSTYLE
605		890
606	Return the rendition mask used for overlays by default.	891	Return the rendition mask used for overlays by default.
607		892
608	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	893	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		894	urxvt::RS_RVid, urxvt::RS_Uline
609		895
610	Return the bit that enabled bold, italic, blink, reverse-video and	896	Return the bit that enabled bold, italic, blink, reverse-video and
611	underline, respectively. To enable such a style, just logically OR it into	897	underline, respectively. To enable such a style, just logically OR it into
612	the bitset.	898	the bitset.
613		899
…		…
618	Return the foreground/background colour index, respectively.	904	Return the foreground/background colour index, respectively.
619		905
620	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	906	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
621		907
622	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	908	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		909
		910	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
623		911
624	Replace the foreground/background colour in the rendition mask with the	912	Replace the foreground/background colour in the rendition mask with the
625	specified one.	913	specified one.
626		914
627	=item $value = urxvt::GET_CUSTOM $rend	915	=item $value = urxvt::GET_CUSTOM $rend
…		…
646	unless $msg =~ /\n$/;	934	unless $msg =~ /\n$/;
647	urxvt::warn ($msg);	935	urxvt::warn ($msg);
648	};	936	};
649	}	937	}
650		938
		939	no warnings 'utf8';
		940
651	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	941	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
652		942
653	sub verbose {	943	sub verbose {
654	my ($level, $msg) = @_;	944	my ($level, $msg) = @_;
655	warn "$msg\n" if $level <= $verbosity;	945	warn "$msg\n" if $level <= $verbosity;
…		…
658	my %extension_pkg;	948	my %extension_pkg;
659		949
660	# load a single script into its own package, once only	950	# load a single script into its own package, once only
661	sub extension_package($) {	951	sub extension_package($) {
662	my ($path) = @_;	952	my ($path) = @_;
663
664	no strict 'refs';
665		953
666	$extension_pkg{$path} ||= do {	954	$extension_pkg{$path} ||= do {
667	$path =~ /([^\/\\]+)$/;	955	$path =~ /([^\/\\]+)$/;
668	my $pkg = $1;	956	my $pkg = $1;
669	$pkg =~ s/[^[:word:]]/_/g;	957	$pkg =~ s/[^[:word:]]/_/g;
…		…
672	verbose 3, "loading extension '$path' into package '$pkg'";	960	verbose 3, "loading extension '$path' into package '$pkg'";
673		961
674	open my $fh, "<:raw", $path	962	open my $fh, "<:raw", $path
675	or die "$path: $!";	963	or die "$path: $!";
676		964
677	@{"$pkg\::ISA"} = urxvt::term::extension::;
678
679	my $source =	965	my $source =
680	"package $pkg; use strict; use utf8;\n"	966	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
681	. "#line 1 \"$path\"\n{\n"	967	. "#line 1 \"$path\"\n{\n"
682	. (do { local $/; <$fh> })	968	. (do { local $/; <$fh> })
683	. "\n};\n1";	969	. "\n};\n1";
684		970
685	eval $source	971	eval $source
…		…
695	sub invoke {	981	sub invoke {
696	local $TERM = shift;	982	local $TERM = shift;
697	my $htype = shift;	983	my $htype = shift;
698		984
699	if ($htype == 0) { # INIT	985	if ($htype == 0) { # INIT
700	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	986	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
701		987
702	my %ext_arg;	988	my %ext_arg;
703		989
		990	{
		991	my @init = @TERM_INIT;
		992	@TERM_INIT = ();
		993	$_->($TERM) for @init;
		994	my @pkg = @TERM_EXT;
		995	@TERM_EXT = ();
		996	$TERM->register_package ($_) for @pkg;
		997	}
		998
704	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	999	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
705	if ($_ eq "default") {	1000	if ($_ eq "default") {
706	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	1001	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
707	} elsif (/^-(.*)$/) {	1002	} elsif (/^-(.*)$/) {
708	delete $ext_arg{$1};	1003	delete $ext_arg{$1};
709	} elsif (/^([^<]+)<(.*)>$/) {	1004	} elsif (/^([^<]+)<(.*)>$/) {
710	push @{ $ext_arg{$1} }, $2;	1005	push @{ $ext_arg{$1} }, $2;
711	} else {	1006	} else {
712	$ext_arg{$_} ||= [];	1007	$ext_arg{$_} ||= [];
713	}	1008	}
714	}	1009	}
715		1010
716	while (my ($ext, $argv) = each %ext_arg) {	1011	for my $ext (sort keys %ext_arg) {
717	my @files = grep -f $_, map "$_/$ext", @dirs;	1012	my @files = grep -f $_, map "$_/$ext", @dirs;
718		1013
719	if (@files) {	1014	if (@files) {
720	$TERM->register_package (extension_package $files[0], $argv);	1015	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
721	} else {	1016	} else {
722	warn "perl extension '$ext' not found in perl library search path\n";	1017	warn "perl extension '$ext' not found in perl library search path\n";
723	}	1018	}
724	}	1019	}
725		1020
…		…
731		1026
732	if (my $cb = $TERM->{_hook}[$htype]) {	1027	if (my $cb = $TERM->{_hook}[$htype]) {
733	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1028	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
734	if $verbosity >= 10;	1029	if $verbosity >= 10;
735		1030
736	keys %$cb;	1031	for my $pkg (keys %$cb) {
737
738	while (my ($pkg, $cb) = each %$cb) {
739	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1032	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
740	and last;	1033	$retval ||= $retval_;
741		1034
742	if ($@) {	1035	if ($@) {
743	$TERM->ungrab; # better to lose the grab than the session	1036	$TERM->ungrab; # better to lose the grab than the session
744	warn $@;	1037	warn $@;
745	}	1038	}
…		…
756	# clear package	1049	# clear package
757	%$TERM = ();	1050	%$TERM = ();
758	}	1051	}
759		1052
760	$retval	1053	$retval
		1054	}
		1055
		1056	sub SET_COLOR($$$) {
		1057	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1058	}
		1059
		1060	sub rend2mask {
		1061	no strict 'refs';
		1062	my ($str, $mask) = (@_, 0);
		1063	my %color = ( fg => undef, bg => undef );
		1064	my @failed;
		1065	for my $spec ( split /\s+/, $str ) {
		1066	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1067	$color{lc($1)} = $2;
		1068	} else {
		1069	my $neg = $spec =~ s/^[-^]//;
		1070	unless ( exists &{"RS_$spec"} ) {
		1071	push @failed, $spec;
		1072	next;
		1073	}
		1074	my $cur = &{"RS_$spec"};
		1075	if ( $neg ) {
		1076	$mask &= ~$cur;
		1077	} else {
		1078	$mask |= $cur;
		1079	}
		1080	}
		1081	}
		1082	($mask, @color{qw(fg bg)}, \@failed)
761	}	1083	}
762		1084
763	# urxvt::term::extension	1085	# urxvt::term::extension
764		1086
765	package urxvt::term::extension;	1087	package urxvt::term::extension;
…		…
836	is that you cannot use blocking APIs, but the non-blocking variant should	1158	is that you cannot use blocking APIs, but the non-blocking variant should
837	work.	1159	work.
838		1160
839	=cut	1161	=cut
840		1162
841	our $VERSION = 1;	1163	our $VERSION = '5.23';
842		1164
843	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1165	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
844	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1166	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
845		1167
846	sub timer {	1168	sub timer {
…		…
848		1170
849	my $cb = $arg{cb};	1171	my $cb = $arg{cb};
850		1172
851	urxvt::timer	1173	urxvt::timer
852	->new	1174	->new
853	->start (urxvt::NOW + $arg{after})	1175	->after ($arg{after}, $arg{interval})
854	->cb (sub {	1176	->cb ($arg{interval} ? $cb : sub {
855	$_[0]->stop; # need to cancel manually	1177	$_[0]->stop; # need to cancel manually
856	$cb->();	1178	$cb->();
857	})	1179	})
858	}	1180	}
859		1181
860	sub io {	1182	sub io {
861	my ($class, %arg) = @_;	1183	my ($class, %arg) = @_;
862		1184
863	my $cb = $arg{cb};	1185	my $cb = $arg{cb};
		1186	my $fd = fileno $arg{fh};
		1187	defined $fd or $fd = $arg{fh};
864		1188
865	bless [$arg{fh}, urxvt::iow	1189	bless [$arg{fh}, urxvt::iow
866	->new	1190	->new
867	->fd (fileno $arg{fh})	1191	->fd ($fd)
868	->events (($arg{poll} =~ /r/ ? 1 : 0)	1192	->events (($arg{poll} =~ /r/ ? 1 : 0)
869	| ($arg{poll} =~ /w/ ? 2 : 0))	1193	| ($arg{poll} =~ /w/ ? 2 : 0))
870	->start	1194	->start
871	->cb (sub {	1195	->cb ($cb)
872	$cb->(($_[1] & 1 ? 'r' : '')
873	. ($_[1] & 2 ? 'w' : ''));
874	})],
875	urxvt::anyevent::	1196	], urxvt::anyevent::
		1197	}
		1198
		1199	sub idle {
		1200	my ($class, %arg) = @_;
		1201
		1202	my $cb = $arg{cb};
		1203
		1204	urxvt::iw
		1205	->new
		1206	->start
		1207	->cb ($cb)
		1208	}
		1209
		1210	sub child {
		1211	my ($class, %arg) = @_;
		1212
		1213	my $cb = $arg{cb};
		1214
		1215	urxvt::pw
		1216	->new
		1217	->start ($arg{pid})
		1218	->cb (sub {
		1219	$_[0]->stop; # need to cancel manually
		1220	$cb->($_[0]->rpid, $_[0]->rstatus);
		1221	})
876	}	1222	}
877		1223
878	sub DESTROY {	1224	sub DESTROY {
879	$_[0][1]->stop;	1225	$_[0][1]->stop;
880	}	1226	}
881		1227
882	sub condvar {	1228	# only needed for AnyEvent < 6 compatibility
883	bless \my $flag, urxvt::anyevent::condvar::	1229	sub one_event {
884	}
885
886	sub urxvt::anyevent::condvar::broadcast {
887	${$_[0]}++;
888	}
889
890	sub urxvt::anyevent::condvar::wait {
891	unless (${$_[0]}) {
892	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1230	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
893	}
894	}	1231	}
895		1232
896	package urxvt::term;	1233	package urxvt::term;
897		1234
898	=head2 The C<urxvt::term> Class	1235	=head2 The C<urxvt::term> Class
…		…
903		1240
904	# find on_xxx subs in the package and register them	1241	# find on_xxx subs in the package and register them
905	# as hooks	1242	# as hooks
906	sub register_package {	1243	sub register_package {
907	my ($self, $pkg, $argv) = @_;	1244	my ($self, $pkg, $argv) = @_;
		1245
		1246	no strict 'refs';
		1247
		1248	urxvt::verbose 6, "register package $pkg to $self";
		1249
		1250	@{"$pkg\::ISA"} = urxvt::term::extension::;
908		1251
909	my $proxy = bless {	1252	my $proxy = bless {
910	_pkg => $pkg,	1253	_pkg => $pkg,
911	argv => $argv,	1254	argv => $argv,
912	}, $pkg;	1255	}, $pkg;
…		…
928	hash which defines the environment of the new terminal.	1271	hash which defines the environment of the new terminal.
929		1272
930	Croaks (and probably outputs an error message) if the new instance	1273	Croaks (and probably outputs an error message) if the new instance
931	couldn't be created. Returns C<undef> if the new instance didn't	1274	couldn't be created. Returns C<undef> if the new instance didn't
932	initialise perl, and the terminal object otherwise. The C<init> and	1275	initialise perl, and the terminal object otherwise. The C<init> and
933	C<start> hooks will be called during this call.	1276	C<start> hooks will be called before this call returns, and are free to
		1277	refer to global data (which is race free).
934		1278
935	=cut	1279	=cut
936		1280
937	sub new {	1281	sub new {
938	my ($class, $env, @args) = @_;	1282	my ($class, $env, @args) = @_;
939		1283
		1284	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1285	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1286
940	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1287	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
941	}	1288	}
942		1289
943	=item $term->destroy	1290	=item $term->destroy
944		1291
945	Destroy the terminal object (close the window, free resources	1292	Destroy the terminal object (close the window, free resources
…		…
975		1322
976	Returns true if the option specified by C<$optval> is enabled, and	1323	Returns true if the option specified by C<$optval> is enabled, and
977	optionally change it. All option values are stored by name in the hash	1324	optionally change it. All option values are stored by name in the hash
978	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1325	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
979		1326
980	Here is a a likely non-exhaustive list of option names, please see the	1327	Here is a likely non-exhaustive list of option names, please see the
981	source file F</src/optinc.h> to see the actual list:	1328	source file F</src/optinc.h> to see the actual list:
982		1329
983	borderLess console cursorBlink cursorUnderline hold iconic insecure	1330	borderLess buffered console cursorBlink cursorUnderline hold iconic
984	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1331	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
985	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1332	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
986	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1333	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
987	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1334	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
988	transparent tripleclickwords utmpInhibit visualBell	1335	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1336	urgentOnBell utmpInhibit visualBell
989		1337
990	=item $value = $term->resource ($name[, $newval])	1338	=item $value = $term->resource ($name[, $newval])
991		1339
992	Returns the current resource value associated with a given name and	1340	Returns the current resource value associated with a given name and
993	optionally sets a new value. Setting values is most useful in the C<init>	1341	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1002	likely change).	1350	likely change).
1003		1351
1004	Please note that resource strings will currently only be freed when the	1352	Please note that resource strings will currently only be freed when the
1005	terminal is destroyed, so changing options frequently will eat memory.	1353	terminal is destroyed, so changing options frequently will eat memory.
1006		1354
1007	Here is a a likely non-exhaustive list of resource names, not all of which	1355	Here is a likely non-exhaustive list of resource names, not all of which
1008	are supported in every build, please see the source file F</src/rsinc.h>	1356	are supported in every build, please see the source file F</src/rsinc.h>
1009	to see the actual list:	1357	to see the actual list:
1010		1358
1011	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1359	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1012	borderLess color cursorBlink cursorUnderline cutchars delete_key	1360	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1013	display_name embed ext_bwidth fade font geometry hold iconName	1361	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1014	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1362	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1363	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1015	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1364	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1016	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1365	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1017	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1366	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1018	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1367	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1019	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1368	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1020	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1369	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1021	secondaryScreen secondaryScroll selectstyle shade term_name title	1370	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1022	transient_for transparent transparent_all tripleclickwords utmpInhibit	1371	term_name title transient_for transparent tripleclickwords urgentOnBell
1023	visualBell	1372	utmpInhibit visualBell
1024		1373
1025	=cut	1374	=cut
1026		1375
1027	sub resource($$;$) {	1376	sub resource($$;$) {
1028	my ($self, $name) = (shift, shift);	1377	my ($self, $name) = (shift, shift);
1029	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1378	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1030	&urxvt::term::_resource	1379	goto &urxvt::term::_resource
1031	}	1380	}
1032		1381
1033	=item $value = $term->x_resource ($pattern)	1382	=item $value = $term->x_resource ($pattern)
1034		1383
1035	Returns the X-Resource for the given pattern, excluding the program or	1384	Returns the X-Resource for the given pattern, excluding the program or
…		…
1039		1388
1040	This method should only be called during the C<on_start> hook, as there is	1389	This method should only be called during the C<on_start> hook, as there is
1041	only one resource database per display, and later invocations might return	1390	only one resource database per display, and later invocations might return
1042	the wrong resources.	1391	the wrong resources.
1043		1392
1044	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1393	=item $success = $term->parse_keysym ($key, $octets)
1045		1394
1046	Adds a keymap translation exactly as specified via a resource. See the	1395	Adds a key binding exactly as specified via a resource. See the
1047	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1396	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1048		1397
1049	=item $rend = $term->rstyle ([$new_rstyle])	1398	=item $rend = $term->rstyle ([$new_rstyle])
1050		1399
1051	Return and optionally change the current rendition. Text that is output by	1400	Return and optionally change the current rendition. Text that is output by
…		…
1060		1409
1061	=item ($row, $col) = $term->selection_beg ([$row, $col])	1410	=item ($row, $col) = $term->selection_beg ([$row, $col])
1062		1411
1063	=item ($row, $col) = $term->selection_end ([$row, $col])	1412	=item ($row, $col) = $term->selection_end ([$row, $col])
1064		1413
1065	Return the current values of the selection mark, begin or end positions,	1414	Return the current values of the selection mark, begin or end positions.
1066	and optionally set them to new values.	1415
		1416	When arguments are given, then the selection coordinates are set to
		1417	C<$row> and C<$col>, and the selection screen is set to the current
		1418	screen.
		1419
		1420	=item $screen = $term->selection_screen ([$screen])
		1421
		1422	Returns the current selection screen, and then optionally sets it.
1067		1423
1068	=item $term->selection_make ($eventtime[, $rectangular])	1424	=item $term->selection_make ($eventtime[, $rectangular])
1069		1425
1070	Tries to make a selection as set by C<selection_beg> and	1426	Tries to make a selection as set by C<selection_beg> and
1071	C<selection_end>. If C<$rectangular> is true (default: false), a	1427	C<selection_end>. If C<$rectangular> is true (default: false), a
1072	rectangular selection will be made. This is the prefered function to make	1428	rectangular selection will be made. This is the preferred function to make
1073	a selection.	1429	a selection.
1074		1430
1075	=item $success = $term->selection_grab ($eventtime)	1431	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1076		1432
1077	Try to request the primary selection text from the server (for example, as	1433	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1434	true) selection from the server. The corresponding text can be set
1078	set by the next method). No visual feedback will be given. This function	1435	with the next method. No visual feedback will be given. This function
1079	is mostly useful from within C<on_sel_grab> hooks.	1436	is mostly useful from within C<on_sel_grab> hooks.
1080		1437
1081	=item $oldtext = $term->selection ([$newtext])	1438	=item $oldtext = $term->selection ([$newtext, $clipboard])
1082		1439
1083	Return the current selection text and optionally replace it by C<$newtext>.	1440	Return the current selection (clipboard if C<$clipboard> is true) text
		1441	and optionally replace it by C<$newtext>.
		1442
		1443	=item $term->selection_clear ([$clipboard])
		1444
		1445	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1084		1446
1085	=item $term->overlay_simple ($x, $y, $text)	1447	=item $term->overlay_simple ($x, $y, $text)
1086		1448
1087	Create a simple multi-line overlay box. See the next method for details.	1449	Create a simple multi-line overlay box. See the next method for details.
1088		1450
…		…
1118		1480
1119	The methods currently supported on C<urxvt::overlay> objects are:	1481	The methods currently supported on C<urxvt::overlay> objects are:
1120		1482
1121	=over 4	1483	=over 4
1122		1484
1123	=item $overlay->set ($x, $y, $text, $rend)	1485	=item $overlay->set ($x, $y, $text[, $rend])
1124		1486
1125	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1487	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1126	text in rxvt-unicode's special encoding and an array of rendition values	1488	text in rxvt-unicode's special encoding and an array of rendition values
1127	at a specific position inside the overlay.	1489	at a specific position inside the overlay.
		1490
		1491	If C<$rend> is missing, then the rendition will not be changed.
1128		1492
1129	=item $overlay->hide	1493	=item $overlay->hide
1130		1494
1131	If visible, hide the overlay, but do not destroy it.	1495	If visible, hide the overlay, but do not destroy it.
1132		1496
…		…
1202		1566
1203	Normally its not a good idea to use this function, as programs might be	1567	Normally its not a good idea to use this function, as programs might be
1204	confused by changes in cursor position or scrolling. Its useful inside a	1568	confused by changes in cursor position or scrolling. Its useful inside a
1205	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1206		1570
		1571	=item $term->scr_change_screen ($screen)
		1572
		1573	Switch to given screen - 0 primary, 1 secondary.
		1574
1207	=item $term->cmd_parse ($octets)	1575	=item $term->cmd_parse ($octets)
1208		1576
1209	Similar to C<scr_add_lines>, but the argument must be in the	1577	Similar to C<scr_add_lines>, but the argument must be in the
1210	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1211	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1212		1580
1213	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1214		1582
1215	Write the octets given in C<$data> to the tty (i.e. as program input). To	1583	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1216	pass characters instead of octets, you should convert your strings first	1584	pass characters instead of octets, you should convert your strings first
1217	to the locale-specific encoding using C<< $term->locale_encode >>.	1585	to the locale-specific encoding using C<< $term->locale_encode >>.
		1586
		1587	=item $term->tt_paste ($octets)
		1588
		1589	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1590	CR and bracketing the data with control sequences if bracketed paste mode
		1591	is set.
1218		1592
1219	=item $old_events = $term->pty_ev_events ([$new_events])	1593	=item $old_events = $term->pty_ev_events ([$new_events])
1220		1594
1221	Replaces the event mask of the pty watcher by the given event mask. Can	1595	Replaces the event mask of the pty watcher by the given event mask. Can
1222	be used to suppress input and output handling to the pty/tty. See the	1596	be used to suppress input and output handling to the pty/tty. See the
1223	description of C<< urxvt::timer->events >>. Make sure to always restore	1597	description of C<< urxvt::timer->events >>. Make sure to always restore
1224	the previous value.	1598	the previous value.
1225		1599
		1600	=item $fd = $term->pty_fd
		1601
		1602	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1603	is used.
		1604
1226	=item $windowid = $term->parent	1605	=item $windowid = $term->parent
1227		1606
1228	Return the window id of the toplevel window.	1607	Return the window id of the toplevel window.
1229		1608
1230	=item $windowid = $term->vt	1609	=item $windowid = $term->vt
…		…
1236	Adds the specified events to the vt event mask. Useful e.g. when you want	1615	Adds the specified events to the vt event mask. Useful e.g. when you want
1237	to receive pointer events all the times:	1616	to receive pointer events all the times:
1238		1617
1239	$term->vt_emask_add (urxvt::PointerMotionMask);	1618	$term->vt_emask_add (urxvt::PointerMotionMask);
1240		1619
		1620	=item $term->focus_in
		1621
		1622	=item $term->focus_out
		1623
		1624	=item $term->key_press ($state, $keycode[, $time])
		1625
		1626	=item $term->key_release ($state, $keycode[, $time])
		1627
		1628	Deliver various fake events to to terminal.
		1629
1241	=item $window_width = $term->width	1630	=item $window_width = $term->width
1242		1631
1243	=item $window_height = $term->height	1632	=item $window_height = $term->height
1244		1633
1245	=item $font_width = $term->fwidth	1634	=item $font_width = $term->fwidth
…		…
1275	=item $env = $term->env	1664	=item $env = $term->env
1276		1665
1277	Returns a copy of the environment in effect for the terminal as a hashref	1666	Returns a copy of the environment in effect for the terminal as a hashref
1278	similar to C<\%ENV>.	1667	similar to C<\%ENV>.
1279		1668
		1669	=item @envv = $term->envv
		1670
		1671	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1672
		1673	=item @argv = $term->argv
		1674
		1675	Return the argument vector as this terminal, similar to @ARGV, but
		1676	includes the program name as first element.
		1677
1280	=cut	1678	=cut
1281		1679
1282	sub env {	1680	sub env {
1283	if (my $env = $_[0]->_env) {
1284	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1681	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1285	} else {
1286	+{ %ENV }
1287	}
1288	}	1682	}
1289		1683
1290	=item $modifiermask = $term->ModLevel3Mask	1684	=item $modifiermask = $term->ModLevel3Mask
1291		1685
1292	=item $modifiermask = $term->ModMetaMask	1686	=item $modifiermask = $term->ModMetaMask
1293		1687
1294	=item $modifiermask = $term->ModNumLockMask	1688	=item $modifiermask = $term->ModNumLockMask
1295		1689
1296	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1690	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1297	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1691	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1692
		1693	=item $screen = $term->current_screen
		1694
		1695	Returns the currently displayed screen (0 primary, 1 secondary).
		1696
		1697	=item $cursor_is_hidden = $term->hidden_cursor
		1698
		1699	Returns whether the cursor is currently hidden or not.
1298		1700
1299	=item $view_start = $term->view_start ([$newvalue])	1701	=item $view_start = $term->view_start ([$newvalue])
1300		1702
1301	Returns the row number of the topmost displayed line. Maximum value is	1703	Returns the row number of the topmost displayed line. Maximum value is
1302	C<0>, which displays the normal terminal contents. Lower values scroll	1704	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1310		1712
1311	Used after changing terminal contents to display them.	1713	Used after changing terminal contents to display them.
1312		1714
1313	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1715	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1314		1716
1315	Returns the text of the entire row with number C<$row_number>. Row C<0>	1717	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1316	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1718	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1317	terminal line. The scrollback buffer starts at line C<-1> and extends to
1318	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1719	terminal line. Nothing will be returned if a nonexistent line
1319	is requested.	1720	is requested.
1320		1721
1321	If C<$new_text> is specified, it will replace characters in the current	1722	If C<$new_text> is specified, it will replace characters in the current
1322	line, starting at column C<$start_col> (default C<0>), which is useful	1723	line, starting at column C<$start_col> (default C<0>), which is useful
1323	to replace only parts of a line. The font index in the rendition will	1724	to replace only parts of a line. The font index in the rendition will
1324	automatically be updated.	1725	automatically be updated.
1325		1726
1326	C<$text> is in a special encoding: tabs and wide characters that use more	1727	C<$text> is in a special encoding: tabs and wide characters that use more
1327	than one cell when displayed are padded with urxvt::NOCHAR characters	1728	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1328	(C<chr 65535>). Characters with combining characters and other characters	1729	characters. Characters with combining characters and other characters that
1329	that do not fit into the normal tetx encoding will be replaced with	1730	do not fit into the normal text encoding will be replaced with characters
1330	characters in the private use area.	1731	in the private use area.
1331		1732
1332	You have to obey this encoding when changing text. The advantage is	1733	You have to obey this encoding when changing text. The advantage is
1333	that C<substr> and similar functions work on screen cells and not on	1734	that C<substr> and similar functions work on screen cells and not on
1334	characters.	1735	characters.
1335		1736
…		…
1479	where one character corresponds to one screen cell. See	1880	where one character corresponds to one screen cell. See
1480	C<< $term->ROW_t >> for details.	1881	C<< $term->ROW_t >> for details.
1481		1882
1482	=item $string = $term->special_decode $text	1883	=item $string = $term->special_decode $text
1483		1884
1484	Converts rxvt-unicodes text reprsentation into a perl string. See	1885	Converts rxvt-unicodes text representation into a perl string. See
1485	C<< $term->ROW_t >> for details.	1886	C<< $term->ROW_t >> for details.
1486		1887
1487	=item $success = $term->grab_button ($button, $modifiermask)	1888	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1488		1889
		1890	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1891
1489	Registers a synchronous button grab. See the XGrabButton manpage.	1892	Register/unregister a synchronous button grab. See the XGrabButton
		1893	manpage.
1490		1894
1491	=item $success = $term->grab ($eventtime[, $sync])	1895	=item $success = $term->grab ($eventtime[, $sync])
1492		1896
1493	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1897	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1494	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1898	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1495		1899
1496	=item $term->allow_events_async	1900	=item $term->allow_events_async
1497		1901
1498	Calls XAllowEvents with AsyncBoth for the most recent grab.	1902	Calls XAllowEvents with AsyncBoth for the most recent grab.
1499		1903
…		…
1506	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1910	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1507	recent grab.	1911	recent grab.
1508		1912
1509	=item $term->ungrab	1913	=item $term->ungrab
1510		1914
1511	Calls XUngrab for the most recent grab. Is called automatically on	1915	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1512	evaluation errors, as it is better to lose the grab in the error case as	1916	evaluation errors, as it is better to lose the grab in the error case as
1513	the session.	1917	the session.
		1918
		1919	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1920
		1921	=item $atom_name = $term->XGetAtomName ($atom)
		1922
		1923	=item @atoms = $term->XListProperties ($window)
		1924
		1925	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1926
		1927	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1928
		1929	=item $term->XDeleteProperty ($window, $property)
		1930
		1931	=item $window = $term->DefaultRootWindow
		1932
		1933	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1934
		1935	=item $term->XMapWindow ($window)
		1936
		1937	=item $term->XUnmapWindow ($window)
		1938
		1939	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1940
		1941	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1942
		1943	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1944
		1945	=item $keysym = $term->XStringToKeysym ($string)
		1946
		1947	=item $string = $term->XKeysymToString ($keysym)
		1948
		1949	Various X or X-related functions. The C<$term> object only serves as
		1950	the source of the display, otherwise those functions map more-or-less
		1951	directly onto the X functions of the same name.
1514		1952
1515	=back	1953	=back
1516		1954
1517	=cut	1955	=cut
1518		1956
…		…
1582	my ($self, $text, $cb) = @_;	2020	my ($self, $text, $cb) = @_;
1583		2021
1584	$self->add_item ({ type => "button", text => $text, activate => $cb});	2022	$self->add_item ({ type => "button", text => $text, activate => $cb});
1585	}	2023	}
1586		2024
1587	=item $popup->add_toggle ($text, $cb, $initial_value)	2025	=item $popup->add_toggle ($text, $initial_value, $cb)
1588		2026
1589	Adds a toggle/checkbox item to the popup. Teh callback gets called	2027	Adds a toggle/checkbox item to the popup. The callback gets called
1590	whenever it gets toggled, with a boolean indicating its value as its first	2028	whenever it gets toggled, with a boolean indicating its new value as its
1591	argument.	2029	first argument.
1592		2030
1593	=cut	2031	=cut
1594		2032
1595	sub add_toggle {	2033	sub add_toggle {
1596	my ($self, $text, $cb, $value) = @_;	2034	my ($self, $text, $value, $cb) = @_;
1597		2035
1598	my $item; $item = {	2036	my $item; $item = {
1599	type => "button",	2037	type => "button",
1600	text => " $text",	2038	text => " $text",
1601	value => $value,	2039	value => $value,
…		…
1620	my $env = $self->{term}->env;	2058	my $env = $self->{term}->env;
1621	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2059	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1622	delete $env->{LC_ALL};	2060	delete $env->{LC_ALL};
1623	$env->{LC_CTYPE} = $self->{term}->locale;	2061	$env->{LC_CTYPE} = $self->{term}->locale;
1624		2062
1625	urxvt::term->new ($env, "popup",	2063	my $term = urxvt::term->new (
		2064	$env, "popup",
1626	"--perl-lib" => "", "--perl-ext-common" => "",	2065	"--perl-lib" => "", "--perl-ext-common" => "",
1627	"-pty-fd" => -1, "-sl" => 0,	2066	"-pty-fd" => -1, "-sl" => 0,
1628	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2067	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1629	"--transient-for" => $self->{term}->parent,	2068	"--transient-for" => $self->{term}->parent,
1630	"-display" => $self->{term}->display_id,	2069	"-display" => $self->{term}->display_id,
1631	"-pe" => "urxvt-popup")	2070	"-pe" => "urxvt-popup",
1632	or die "unable to create popup window\n";	2071	) or die "unable to create popup window\n";
		2072
		2073	unless (delete $term->{urxvt_popup_init_done}) {
		2074	$term->ungrab;
		2075	$term->destroy;
		2076	die "unable to initialise popup window\n";
		2077	}
1633	}	2078	}
1634		2079
1635	sub DESTROY {	2080	sub DESTROY {
1636	my ($self) = @_;	2081	my ($self) = @_;
1637		2082
1638	delete $self->{term}{_destroy}{$self};	2083	delete $self->{term}{_destroy}{$self};
1639	$self->{term}->ungrab;	2084	$self->{term}->ungrab;
1640	}	2085	}
1641		2086
1642	=back	2087	=back
		2088
		2089	=cut
		2090
		2091	package urxvt::watcher;
1643		2092
1644	=head2 The C<urxvt::timer> Class	2093	=head2 The C<urxvt::timer> Class
1645		2094
1646	This class implements timer watchers/events. Time is represented as a	2095	This class implements timer watchers/events. Time is represented as a
1647	fractional number of seconds since the epoch. Example:	2096	fractional number of seconds since the epoch. Example:
…		…
1651	->new	2100	->new
1652	->interval (1)	2101	->interval (1)
1653	->cb (sub {	2102	->cb (sub {
1654	$term->{overlay}->set (0, 0,	2103	$term->{overlay}->set (0, 0,
1655	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2104	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1656	});	2105	});
1657		2106
1658	=over 4	2107	=over 4
1659		2108
1660	=item $timer = new urxvt::timer	2109	=item $timer = new urxvt::timer
1661		2110
…		…
1664		2113
1665	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2114	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1666		2115
1667	Set the callback to be called when the timer triggers.	2116	Set the callback to be called when the timer triggers.
1668		2117
1669	=item $tstamp = $timer->at
1670
1671	Return the time this watcher will fire next.
1672
1673	=item $timer = $timer->set ($tstamp)	2118	=item $timer = $timer->set ($tstamp[, $interval])
1674		2119
1675	Set the time the event is generated to $tstamp.	2120	Set the time the event is generated to $tstamp (and optionally specifies a
		2121	new $interval).
1676		2122
1677	=item $timer = $timer->interval ($interval)	2123	=item $timer = $timer->interval ($interval)
1678		2124
1679	Normally (and when C<$interval> is C<0>), the timer will automatically	2125	By default (and when C<$interval> is C<0>), the timer will automatically
1680	stop after it has fired once. If C<$interval> is non-zero, then the timer	2126	stop after it has fired once. If C<$interval> is non-zero, then the timer
1681	is automatically rescheduled at the given intervals.	2127	is automatically rescheduled at the given intervals.
1682		2128
1683	=item $timer = $timer->start	2129	=item $timer = $timer->start
1684		2130
1685	Start the timer.	2131	Start the timer.
1686		2132
1687	=item $timer = $timer->start ($tstamp)	2133	=item $timer = $timer->start ($tstamp[, $interval])
1688		2134
1689	Set the event trigger time to C<$tstamp> and start the timer.	2135	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2136	also replaces the interval.
1690		2137
1691	=item $timer = $timer->after ($delay)	2138	=item $timer = $timer->after ($delay[, $interval])
1692		2139
1693	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2140	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1694		2141
1695	=item $timer = $timer->stop	2142	=item $timer = $timer->stop
1696		2143
…		…
1704		2151
1705	$term->{socket} = ...	2152	$term->{socket} = ...
1706	$term->{iow} = urxvt::iow	2153	$term->{iow} = urxvt::iow
1707	->new	2154	->new
1708	->fd (fileno $term->{socket})	2155	->fd (fileno $term->{socket})
1709	->events (urxvt::EVENT_READ)	2156	->events (urxvt::EV_READ)
1710	->start	2157	->start
1711	->cb (sub {	2158	->cb (sub {
1712	my ($iow, $revents) = @_;	2159	my ($iow, $revents) = @_;
1713	# $revents must be 1 here, no need to check	2160	# $revents must be 1 here, no need to check
1714	sysread $term->{socket}, my $buf, 8192	2161	sysread $term->{socket}, my $buf, 8192
…		…
1727	Set the callback to be called when io events are triggered. C<$reventmask>	2174	Set the callback to be called when io events are triggered. C<$reventmask>
1728	is a bitset as described in the C<events> method.	2175	is a bitset as described in the C<events> method.
1729		2176
1730	=item $iow = $iow->fd ($fd)	2177	=item $iow = $iow->fd ($fd)
1731		2178
1732	Set the filedescriptor (not handle) to watch.	2179	Set the file descriptor (not handle) to watch.
1733		2180
1734	=item $iow = $iow->events ($eventmask)	2181	=item $iow = $iow->events ($eventmask)
1735		2182
1736	Set the event mask to watch. The only allowed values are	2183	Set the event mask to watch. The only allowed values are
1737	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2184	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1738	together, or C<urxvt::EVENT_NONE>.	2185	together, or C<urxvt::EV_NONE>.
1739		2186
1740	=item $iow = $iow->start	2187	=item $iow = $iow->start
1741		2188
1742	Start watching for requested events on the given handle.	2189	Start watching for requested events on the given handle.
1743		2190
1744	=item $iow = $iow->stop	2191	=item $iow = $iow->stop
1745		2192
1746	Stop watching for events on the given filehandle.	2193	Stop watching for events on the given file handle.
		2194
		2195	=back
		2196
		2197	=head2 The C<urxvt::iw> Class
		2198
		2199	This class implements idle watchers, that get called automatically when
		2200	the process is idle. They should return as fast as possible, after doing
		2201	some useful work.
		2202
		2203	=over 4
		2204
		2205	=item $iw = new urxvt::iw
		2206
		2207	Create a new idle watcher object in stopped state.
		2208
		2209	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2210
		2211	Set the callback to be called when the watcher triggers.
		2212
		2213	=item $timer = $timer->start
		2214
		2215	Start the watcher.
		2216
		2217	=item $timer = $timer->stop
		2218
		2219	Stop the watcher.
		2220
		2221	=back
		2222
		2223	=head2 The C<urxvt::pw> Class
		2224
		2225	This class implements process watchers. They create an event whenever a
		2226	process exits, after which they stop automatically.
		2227
		2228	my $pid = fork;
		2229	...
		2230	$term->{pw} = urxvt::pw
		2231	->new
		2232	->start ($pid)
		2233	->cb (sub {
		2234	my ($pw, $exit_status) = @_;
		2235	...
		2236	});
		2237
		2238	=over 4
		2239
		2240	=item $pw = new urxvt::pw
		2241
		2242	Create a new process watcher in stopped state.
		2243
		2244	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2245
		2246	Set the callback to be called when the timer triggers.
		2247
		2248	=item $pw = $timer->start ($pid)
		2249
		2250	Tells the watcher to start watching for process C<$pid>.
		2251
		2252	=item $pw = $pw->stop
		2253
		2254	Stop the watcher.
1747		2255
1748	=back	2256	=back
1749		2257
1750	=head1 ENVIRONMENT	2258	=head1 ENVIRONMENT
1751		2259
…		…
1760		2268
1761	=item >= 3 - script loading and management	2269	=item >= 3 - script loading and management
1762		2270
1763	=item >=10 - all called hooks	2271	=item >=10 - all called hooks
1764		2272
1765	=item >=11 - hook reutrn values	2273	=item >=11 - hook return values
1766		2274
1767	=back	2275	=back
1768		2276
1769	=head1 AUTHOR	2277	=head1 AUTHOR
1770		2278
1771	Marc Lehmann <pcg@goof.com>	2279	Marc Lehmann <schmorp@schmorp.de>
1772	http://software.schmorp.de/pkg/rxvt-unicode	2280	http://software.schmorp.de/pkg/rxvt-unicode
1773		2281
1774	=cut	2282	=cut
1775		2283
1776	1	2284	1
		2285
		2286	# vim: sw=3:

Diff Legend

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