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.112 by root, Thu Jan 19 21:02:06 2006 UTC vs.
Revision 1.211 by root, Wed Jun 6 14:34:03 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
…		…
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 any of the called	501	B<All> of these hooks must return a boolean value. If any of the called
309	hooks returns true, then the event counts as being I<consumed>, and the	502	hooks returns true, then the event counts as being I<consumed>, and the
310	relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
…		…
323	place.	516	place.
324		517
325	=item on_start $term	518	=item on_start $term
326		519
327	Called at the very end of initialisation of a new terminal, just before	520	Called at the very end of initialisation of a new terminal, just before
328	returning to the mainloop.	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).
329		527
330	=item on_reset $term	528	=item on_reset $term
331		529
332	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
333	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
…		…
355		553
356	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
357	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
358	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
359		557
360	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.
361		559
362	=item on_sel_extend $term	560	=item on_sel_extend $term
363		561
364	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
365	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
366	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
367	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
368	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
369	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
370		568
371	See the F<selection> example extension.	569	See the F<selection> example extension.
372		570
373	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
374		572
375	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
376	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
377	show this many lines of scrollback.	575	show this many lines of scrollback.
378		576
379	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
380		578
…		…
384		582
385	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,
386	$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
387	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
388		586
389	=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
390		598
391	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
392	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
393	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
394	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,
395	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
396	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	}
397		615
398	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,
399	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
400	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.
401		622
402	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
403		624
404	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
405	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
…		…
410	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
411		632
412	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
413	suppress or filter tty input.	634	suppress or filter tty input.
414		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
415	=item on_line_update $term, $row	643	=item on_line_update $term, $row
416		644
417	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
418	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
419	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,
…		…
426	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
427	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
428		656
429	=item on_refresh_begin $term	657	=item on_refresh_begin $term
430		658
431	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
432	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
433	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
434	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
435		663
436	=item on_refresh_end $term	664	=item on_refresh_end $term
437		665
438	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>.
439		667
440	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
441		669
442	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
443	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>
444	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.
445		689
446	=item on_x_event $term, $event	690	=item on_x_event $term, $event
447		691
448	Called on every X event received on the vt window (and possibly other	692	Called on every X event received on the vt window (and possibly other
449	windows). Should only be used as a last resort. Most event structure	693	windows). Should only be used as a last resort. Most event structure
450	members are not passed.	694	members are not passed.
451		695
		696	=item on_root_event $term, $event
		697
		698	Like C<on_x_event>, but is called for events on the root window.
		699
452	=item on_focus_in $term	700	=item on_focus_in $term
453		701
454	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
455	does focus in processing.	703	does focus in processing.
456		704
457	=item on_focus_out $term	705	=item on_focus_out $term
458		706
459	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
460	focus out processing.	708	focus out processing.
461		709
462	=item on_configure_notify $term, $event	710	=item on_configure_notify $term, $event
463		711
		712	=item on_property_notify $term, $event
		713
464	=item on_key_press $term, $event, $keysym, $octets	714	=item on_key_press $term, $event, $keysym, $octets
465		715
466	=item on_key_release $term, $event, $keysym	716	=item on_key_release $term, $event, $keysym
467		717
468	=item on_button_press $term, $event	718	=item on_button_press $term, $event
…		…
473		723
474	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
475		725
476	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
477		727
478	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
479	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.
480		730
481	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
482	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
483	and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
484		734
485	C<on_key_press> additionally receives the string rxvt-unicode would	735	C<on_key_press> additionally receives the string rxvt-unicode would
486	output, if any, in locale-specific encoding.	736	output, if any, in locale-specific encoding.
487		737
488	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.
489		752
490	=back	753	=back
491		754
492	=cut	755	=cut
493		756
…		…
499	use Scalar::Util ();	762	use Scalar::Util ();
500	use List::Util ();	763	use List::Util ();
501		764
502	our $VERSION = 1;	765	our $VERSION = 1;
503	our $TERM;	766	our $TERM;
		767	our @TERM_INIT; # should go, prevents async I/O etc.
		768	our @TERM_EXT; # should go, prevents async I/O etc.
504	our @HOOKNAME;	769	our @HOOKNAME;
505	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
506	our %OPTION;	771	our %OPTION;
507		772
508	our $LIBDIR;	773	our $LIBDIR;
509	our $RESNAME;	774	our $RESNAME;
510	our $RESCLASS;	775	our $RESCLASS;
511	our $RXVTNAME;	776	our $RXVTNAME;
512		777
		778	our $NOCHAR = chr 0xffff;
		779
513	=head2 Variables in the C<urxvt> Package	780	=head2 Variables in the C<urxvt> Package
514		781
515	=over 4	782	=over 4
516		783
517	=item $urxvt::LIBDIR	784	=item $urxvt::LIBDIR
…		…
530	=item $urxvt::TERM	797	=item $urxvt::TERM
531		798
532	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
533	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
534		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
535	=back	818	=back
536		819
537	=head2 Functions in the C<urxvt> Package	820	=head2 Functions in the C<urxvt> Package
538		821
539	=over 4	822	=over 4
540		823
541	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
542		825
543	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
544	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
545	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
546		830
547	=item urxvt::warn $string	831	=item urxvt::warn $string
548		832
549	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
550	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
551	that calls this function.	835	that calls this function.
552		836
553	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
554	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
555		839
556	Messages have a size limit of 1023 bytes currently.	840	Messages have a size limit of 1023 bytes currently.
		841
		842	=item @terms = urxvt::termlist
		843
		844	Returns all urxvt::term objects that exist in this process, regardless of
		845	whether they are started, being destroyed etc., so be careful. Only term
		846	objects that have perl extensions attached will be returned (because there
		847	is no urxvt::term object associated with others).
557		848
558	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
559		850
560	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
561		852
…		…
604		895
605	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
606		897
607	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
608		899
609	=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
610		902
611	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
612	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
613	the bitset.	905	the bitset.
614		906
…		…
619	Return the foreground/background colour index, respectively.	911	Return the foreground/background colour index, respectively.
620		912
621	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
622		914
623	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	915	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		916
		917	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
624		918
625	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
626	specified one.	920	specified one.
627		921
628	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
…		…
647	unless $msg =~ /\n$/;	941	unless $msg =~ /\n$/;
648	urxvt::warn ($msg);	942	urxvt::warn ($msg);
649	};	943	};
650	}	944	}
651		945
		946	no warnings 'utf8';
		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	my $r = $term->{meta}{resource};
		954	while (my ($pattern, $v) = each %$r) {
		955	$name =~ y/-/./ if $isarg;
		956
		957	if (
		958	$pattern =~ s/\*$//
		959	? $pattern eq substr $name, 0, length $pattern
		960	: $pattern eq $name
		961	) {
		962	$name = "$urxvt::RESCLASS.$name";
		963
		964	push @TERM_EXT, $v->[0];
		965
		966	if ($v->[1] eq "boolean") {
		967	$term->put_option_db ($name, $flag ? "true" : "false");
		968	return 1;
		969	} else {
		970	$term->put_option_db ($name, $value);
		971	return 1 + 2;
		972	}
		973	}
		974	}
		975
		976	0
		977	}
		978
		979	sub usage {
		980	my ($term, $usage_type) = @_;
		981
		982	$term->scan_meta;
		983
		984	my $r = $term->{meta}{resource};
		985
		986	for my $pattern (sort keys %$r) {
		987	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		988
		989	$desc .= " (-pe $ext)";
		990
		991	if ($usage_type == 1) {
		992	$pattern =~ y/./-/;
		993	$pattern =~ s/\*/.../g;
		994
		995	if ($type eq "boolean") {
		996	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		997	} else {
		998	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		999	}
		1000	} else {
		1001	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1002	}
		1003	}
		1004	}
		1005
652	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1006	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
653		1007
654	sub verbose {	1008	sub verbose {
655	my ($level, $msg) = @_;	1009	my ($level, $msg) = @_;
656	warn "$msg\n" if $level <= $verbosity;	1010	warn "$msg\n" if $level <= $verbosity;
…		…
659	my %extension_pkg;	1013	my %extension_pkg;
660		1014
661	# load a single script into its own package, once only	1015	# load a single script into its own package, once only
662	sub extension_package($) {	1016	sub extension_package($) {
663	my ($path) = @_;	1017	my ($path) = @_;
664
665	no strict 'refs';
666		1018
667	$extension_pkg{$path} ||= do {	1019	$extension_pkg{$path} ||= do {
668	$path =~ /([^\/\\]+)$/;	1020	$path =~ /([^\/\\]+)$/;
669	my $pkg = $1;	1021	my $pkg = $1;
670	$pkg =~ s/[^[:word:]]/_/g;	1022	$pkg =~ s/[^[:word:]]/_/g;
…		…
673	verbose 3, "loading extension '$path' into package '$pkg'";	1025	verbose 3, "loading extension '$path' into package '$pkg'";
674		1026
675	open my $fh, "<:raw", $path	1027	open my $fh, "<:raw", $path
676	or die "$path: $!";	1028	or die "$path: $!";
677		1029
678	@{"$pkg\::ISA"} = urxvt::term::extension::;
679
680	my $source =	1030	my $source =
681	"package $pkg; use strict; use utf8;\n"	1031	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
682	. "#line 1 \"$path\"\n{\n"	1032	. "#line 1 \"$path\"\n{\n"
683	. (do { local $/; <$fh> })	1033	. (do { local $/; <$fh> })
684	. "\n};\n1";	1034	. "\n};\n1";
685		1035
686	eval $source	1036	eval $source
…		…
696	sub invoke {	1046	sub invoke {
697	local $TERM = shift;	1047	local $TERM = shift;
698	my $htype = shift;	1048	my $htype = shift;
699		1049
700	if ($htype == 0) { # INIT	1050	if ($htype == 0) { # INIT
701	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1051	my @dirs = $TERM->perl_libdirs;
702		1052
703	my %ext_arg;	1053	my %ext_arg;
704		1054
		1055	{
		1056	my @init = @TERM_INIT;
		1057	@TERM_INIT = ();
		1058	$_->($TERM) for @init;
		1059	my @pkg = @TERM_EXT;
		1060	@TERM_EXT = ();
		1061	$TERM->register_package ($_) for @pkg;
		1062	}
		1063
705	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1064	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
706	if ($_ eq "default") {	1065	if ($_ eq "default") {
707	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	1066	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
708	} elsif (/^-(.*)$/) {	1067	} elsif (/^-(.*)$/) {
709	delete $ext_arg{$1};	1068	delete $ext_arg{$1};
710	} elsif (/^([^<]+)<(.*)>$/) {	1069	} elsif (/^([^<]+)<(.*)>$/) {
711	push @{ $ext_arg{$1} }, $2;	1070	push @{ $ext_arg{$1} }, $2;
712	} else {	1071	} else {
713	$ext_arg{$_} ||= [];	1072	$ext_arg{$_} ||= [];
714	}	1073	}
715	}	1074	}
716		1075
717	while (my ($ext, $argv) = each %ext_arg) {	1076	for my $ext (sort keys %ext_arg) {
718	my @files = grep -f $_, map "$_/$ext", @dirs;	1077	my @files = grep -f $_, map "$_/$ext", @dirs;
719		1078
720	if (@files) {	1079	if (@files) {
721	$TERM->register_package (extension_package $files[0], $argv);	1080	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
722	} else {	1081	} else {
723	warn "perl extension '$ext' not found in perl library search path\n";	1082	warn "perl extension '$ext' not found in perl library search path\n";
724	}	1083	}
725	}	1084	}
726		1085
…		…
732		1091
733	if (my $cb = $TERM->{_hook}[$htype]) {	1092	if (my $cb = $TERM->{_hook}[$htype]) {
734	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1093	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
735	if $verbosity >= 10;	1094	if $verbosity >= 10;
736		1095
737	keys %$cb;	1096	for my $pkg (keys %$cb) {
738
739	while (my ($pkg, $cb) = each %$cb) {
740	$retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1097	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
		1098	$retval ||= $retval_;
741		1099
742	if ($@) {	1100	if ($@) {
743	$TERM->ungrab; # better to lose the grab than the session	1101	$TERM->ungrab; # better to lose the grab than the session
744	warn $@;	1102	warn $@;
745	}	1103	}
…		…
756	# clear package	1114	# clear package
757	%$TERM = ();	1115	%$TERM = ();
758	}	1116	}
759		1117
760	$retval	1118	$retval
		1119	}
		1120
		1121	sub SET_COLOR($$$) {
		1122	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1123	}
		1124
		1125	sub rend2mask {
		1126	no strict 'refs';
		1127	my ($str, $mask) = (@_, 0);
		1128	my %color = ( fg => undef, bg => undef );
		1129	my @failed;
		1130	for my $spec ( split /\s+/, $str ) {
		1131	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1132	$color{lc($1)} = $2;
		1133	} else {
		1134	my $neg = $spec =~ s/^[-^]//;
		1135	unless ( exists &{"RS_$spec"} ) {
		1136	push @failed, $spec;
		1137	next;
		1138	}
		1139	my $cur = &{"RS_$spec"};
		1140	if ( $neg ) {
		1141	$mask &= ~$cur;
		1142	} else {
		1143	$mask |= $cur;
		1144	}
		1145	}
		1146	}
		1147	($mask, @color{qw(fg bg)}, \@failed)
761	}	1148	}
762		1149
763	# urxvt::term::extension	1150	# urxvt::term::extension
764		1151
765	package urxvt::term::extension;	1152	package urxvt::term::extension;
…		…
830	=head2 The C<urxvt::anyevent> Class	1217	=head2 The C<urxvt::anyevent> Class
831		1218
832	The sole purpose of this class is to deliver an interface to the	1219	The sole purpose of this class is to deliver an interface to the
833	C<AnyEvent> module - any module using it will work inside urxvt without	1220	C<AnyEvent> module - any module using it will work inside urxvt without
834	further programming. The only exception is that you cannot wait on	1221	further programming. The only exception is that you cannot wait on
835	condition variables, but non-blocking condvar use is ok. What this means	1222	condition variables, but non-blocking condvar use is ok.
836	is that you cannot use blocking APIs, but the non-blocking variant should	1223
837	work.	1224	In practical terms this means is that you cannot use blocking APIs, but
		1225	the non-blocking variant should work.
838		1226
839	=cut	1227	=cut
840		1228
841	our $VERSION = 1;	1229	our $VERSION = '5.23';
842		1230
843	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1231	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
844	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1232	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
845		1233
846	sub timer {	1234	sub timer {
…		…
848		1236
849	my $cb = $arg{cb};	1237	my $cb = $arg{cb};
850		1238
851	urxvt::timer	1239	urxvt::timer
852	->new	1240	->new
853	->start (urxvt::NOW + $arg{after})	1241	->after ($arg{after}, $arg{interval})
854	->cb (sub {	1242	->cb ($arg{interval} ? $cb : sub {
855	$_[0]->stop; # need to cancel manually	1243	$_[0]->stop; # need to cancel manually
856	$cb->();	1244	$cb->();
857	})	1245	})
858	}	1246	}
859		1247
860	sub io {	1248	sub io {
861	my ($class, %arg) = @_;	1249	my ($class, %arg) = @_;
862		1250
863	my $cb = $arg{cb};	1251	my $cb = $arg{cb};
		1252	my $fd = fileno $arg{fh};
		1253	defined $fd or $fd = $arg{fh};
864		1254
865	bless [$arg{fh}, urxvt::iow	1255	bless [$arg{fh}, urxvt::iow
866	->new	1256	->new
867	->fd (fileno $arg{fh})	1257	->fd ($fd)
868	->events (($arg{poll} =~ /r/ ? 1 : 0)	1258	->events (($arg{poll} =~ /r/ ? 1 : 0)
869	| ($arg{poll} =~ /w/ ? 2 : 0))	1259	| ($arg{poll} =~ /w/ ? 2 : 0))
870	->start	1260	->start
871	->cb (sub {	1261	->cb ($cb)
872	$cb->(($_[1] & 1 ? 'r' : '')
873	. ($_[1] & 2 ? 'w' : ''));
874	})],
875	urxvt::anyevent::	1262	], urxvt::anyevent::
		1263	}
		1264
		1265	sub idle {
		1266	my ($class, %arg) = @_;
		1267
		1268	my $cb = $arg{cb};
		1269
		1270	urxvt::iw
		1271	->new
		1272	->start
		1273	->cb ($cb)
		1274	}
		1275
		1276	sub child {
		1277	my ($class, %arg) = @_;
		1278
		1279	my $cb = $arg{cb};
		1280
		1281	urxvt::pw
		1282	->new
		1283	->start ($arg{pid})
		1284	->cb (sub {
		1285	$_[0]->stop; # need to cancel manually
		1286	$cb->($_[0]->rpid, $_[0]->rstatus);
		1287	})
876	}	1288	}
877		1289
878	sub DESTROY {	1290	sub DESTROY {
879	$_[0][1]->stop;	1291	$_[0][1]->stop;
880	}	1292	}
881		1293
882	sub condvar {	1294	# only needed for AnyEvent < 6 compatibility
883	bless \my $flag, urxvt::anyevent::condvar::	1295	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";	1296	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
893	}
894	}	1297	}
895		1298
896	package urxvt::term;	1299	package urxvt::term;
897		1300
898	=head2 The C<urxvt::term> Class	1301	=head2 The C<urxvt::term> Class
…		…
903		1306
904	# find on_xxx subs in the package and register them	1307	# find on_xxx subs in the package and register them
905	# as hooks	1308	# as hooks
906	sub register_package {	1309	sub register_package {
907	my ($self, $pkg, $argv) = @_;	1310	my ($self, $pkg, $argv) = @_;
		1311
		1312	no strict 'refs';
		1313
		1314	urxvt::verbose 6, "register package $pkg to $self";
		1315
		1316	@{"$pkg\::ISA"} = urxvt::term::extension::;
908		1317
909	my $proxy = bless {	1318	my $proxy = bless {
910	_pkg => $pkg,	1319	_pkg => $pkg,
911	argv => $argv,	1320	argv => $argv,
912	}, $pkg;	1321	}, $pkg;
…		…
919	$proxy->enable ($name => $ref);	1328	$proxy->enable ($name => $ref);
920	}	1329	}
921	}	1330	}
922	}	1331	}
923		1332
		1333	sub perl_libdirs {
		1334	map { split /:/ }
		1335	$_[0]->resource ("perl_lib"),
		1336	$ENV{URXVT_PERL_LIB},
		1337	"$ENV{HOME}/.urxvt/ext",
		1338	"$LIBDIR/perl"
		1339	}
		1340
		1341	sub scan_meta {
		1342	my ($self) = @_;
		1343	my @libdirs = perl_libdirs $self;
		1344
		1345	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1346
		1347	my %meta;
		1348
		1349	$self->{meta_libdirs} = join "\x00", @libdirs;
		1350	$self->{meta} = \%meta;
		1351
		1352	for my $dir (reverse @libdirs) {
		1353	opendir my $fh, $dir
		1354	or next;
		1355	for my $ext (readdir $fh) {
		1356	$ext ne "."
		1357	and $ext ne ".."
		1358	and open my $fh, "<", "$dir/$ext"
		1359	or next;
		1360
		1361	while (<$fh>) {
		1362	if (/^#:META:X_RESOURCE:(.*)/) {
		1363	my ($pattern, $type, $desc) = split /:/, $1;
		1364	$pattern =~ s/^%\./$ext./g; # $$ in pattern == extension name
		1365	if ($pattern =~ /[^a-zA-Z\*\.]/) {
		1366	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1367	} else {
		1368	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1369	}
		1370	} elsif (/^\s*(?:#|$)/) {
		1371	# skip other comments and empty lines
		1372	} else {
		1373	last; # stop parsing on first non-empty non-comment line
		1374	}
		1375	}
		1376	}
		1377	}
		1378	}
		1379
924	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1380	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
925		1381
926	Creates a new terminal, very similar as if you had started it with system	1382	Creates a new terminal, very similar as if you had started it with system
927	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1383	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
928	hash which defines the environment of the new terminal.	1384	hash which defines the environment of the new terminal.
929		1385
930	Croaks (and probably outputs an error message) if the new instance	1386	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	1387	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	1388	initialise perl, and the terminal object otherwise. The C<init> and
933	C<start> hooks will be called during this call.	1389	C<start> hooks will be called before this call returns, and are free to
		1390	refer to global data (which is race free).
934		1391
935	=cut	1392	=cut
936		1393
937	sub new {	1394	sub new {
938	my ($class, $env, @args) = @_;	1395	my ($class, $env, @args) = @_;
939		1396
		1397	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1398	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1399
940	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1400	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
941	}	1401	}
942		1402
943	=item $term->destroy	1403	=item $term->destroy
944		1404
945	Destroy the terminal object (close the window, free resources	1405	Destroy the terminal object (close the window, free resources
…		…
975		1435
976	Returns true if the option specified by C<$optval> is enabled, and	1436	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	1437	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.	1438	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
979		1439
980	Here is a a likely non-exhaustive list of option names, please see the	1440	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:	1441	source file F</src/optinc.h> to see the actual list:
982		1442
983	borderLess console cursorBlink cursorUnderline hold iconic insecure	1443	borderLess buffered console cursorBlink cursorUnderline hold iconic
984	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1444	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
985	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1445	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
986	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1446	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
987	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1447	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
988	transparent tripleclickwords utmpInhibit visualBell	1448	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1449	urgentOnBell utmpInhibit visualBell
989		1450
990	=item $value = $term->resource ($name[, $newval])	1451	=item $value = $term->resource ($name[, $newval])
991		1452
992	Returns the current resource value associated with a given name and	1453	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>	1454	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1002	likely change).	1463	likely change).
1003		1464
1004	Please note that resource strings will currently only be freed when the	1465	Please note that resource strings will currently only be freed when the
1005	terminal is destroyed, so changing options frequently will eat memory.	1466	terminal is destroyed, so changing options frequently will eat memory.
1006		1467
1007	Here is a a likely non-exhaustive list of resource names, not all of which	1468	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>	1469	are supported in every build, please see the source file F</src/rsinc.h>
1009	to see the actual list:	1470	to see the actual list:
1010		1471
1011	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1472	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1012	borderLess color cursorBlink cursorUnderline cutchars delete_key	1473	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1013	display_name embed ext_bwidth fade font geometry hold iconName	1474	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1014	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1475	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1476	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1015	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1477	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1016	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1478	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1017	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1479	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1018	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1480	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1019	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1481	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1020	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1482	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1021	secondaryScreen secondaryScroll selectstyle shade term_name title	1483	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1022	transient_for transparent transparent_all tripleclickwords utmpInhibit	1484	term_name title transient_for transparent tripleclickwords urgentOnBell
1023	visualBell	1485	utmpInhibit visualBell
1024		1486
1025	=cut	1487	=cut
1026		1488
1027	sub resource($$;$) {	1489	sub resource($$;$) {
1028	my ($self, $name) = (shift, shift);	1490	my ($self, $name) = (shift, shift);
1029	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1491	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1030	&urxvt::term::_resource	1492	goto &urxvt::term::_resource
1031	}	1493	}
1032		1494
1033	=item $value = $term->x_resource ($pattern)	1495	=item $value = $term->x_resource ($pattern)
1034		1496
1035	Returns the X-Resource for the given pattern, excluding the program or	1497	Returns the X-Resource for the given pattern, excluding the program or
…		…
1039		1501
1040	This method should only be called during the C<on_start> hook, as there is	1502	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	1503	only one resource database per display, and later invocations might return
1042	the wrong resources.	1504	the wrong resources.
1043		1505
1044	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1506	=item $value = $term->x_resource_boolean ($pattern)
1045		1507
		1508	Like C<x_resource>, above, but interprets the string value as a boolean
		1509	and returns C<1> for true values, C<0> for false values and C<undef> if
		1510	the resource or option isn't specified.
		1511
		1512	You should always use this method to parse boolean resources.
		1513
		1514	=cut
		1515
		1516	sub x_resource_boolean {
		1517	my $res = &x_resource;
		1518
		1519	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1520	}
		1521
		1522	=item $success = $term->parse_keysym ($key, $octets)
		1523
1046	Adds a keymap translation exactly as specified via a resource. See the	1524	Adds a key binding exactly as specified via a resource. See the
1047	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1525	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1526
		1527	=item $term->register_command ($keysym, $modifiermask, $string)
		1528
		1529	Adds a key binding. This is a lower level api compared to
		1530	C<parse_keysym>, as it expects a parsed key description, and can be
		1531	used only inside either the C<on_init> hook, to add a binding, or the
		1532	C<on_register_command> hook, to modify a parsed binding.
1048		1533
1049	=item $rend = $term->rstyle ([$new_rstyle])	1534	=item $rend = $term->rstyle ([$new_rstyle])
1050		1535
1051	Return and optionally change the current rendition. Text that is output by	1536	Return and optionally change the current rendition. Text that is output by
1052	the terminal application will use this style.	1537	the terminal application will use this style.
…		…
1060		1545
1061	=item ($row, $col) = $term->selection_beg ([$row, $col])	1546	=item ($row, $col) = $term->selection_beg ([$row, $col])
1062		1547
1063	=item ($row, $col) = $term->selection_end ([$row, $col])	1548	=item ($row, $col) = $term->selection_end ([$row, $col])
1064		1549
1065	Return the current values of the selection mark, begin or end positions,	1550	Return the current values of the selection mark, begin or end positions.
1066	and optionally set them to new values.	1551
		1552	When arguments are given, then the selection coordinates are set to
		1553	C<$row> and C<$col>, and the selection screen is set to the current
		1554	screen.
		1555
		1556	=item $screen = $term->selection_screen ([$screen])
		1557
		1558	Returns the current selection screen, and then optionally sets it.
1067		1559
1068	=item $term->selection_make ($eventtime[, $rectangular])	1560	=item $term->selection_make ($eventtime[, $rectangular])
1069		1561
1070	Tries to make a selection as set by C<selection_beg> and	1562	Tries to make a selection as set by C<selection_beg> and
1071	C<selection_end>. If C<$rectangular> is true (default: false), a	1563	C<selection_end>. If C<$rectangular> is true (default: false), a
1072	rectangular selection will be made. This is the prefered function to make	1564	rectangular selection will be made. This is the preferred function to make
1073	a selection.	1565	a selection.
1074		1566
1075	=item $success = $term->selection_grab ($eventtime)	1567	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1076		1568
1077	Try to request the primary selection text from the server (for example, as	1569	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1570	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	1571	with the next method. No visual feedback will be given. This function
1079	is mostly useful from within C<on_sel_grab> hooks.	1572	is mostly useful from within C<on_sel_grab> hooks.
1080		1573
1081	=item $oldtext = $term->selection ([$newtext])	1574	=item $oldtext = $term->selection ([$newtext, $clipboard])
1082		1575
1083	Return the current selection text and optionally replace it by C<$newtext>.	1576	Return the current selection (clipboard if C<$clipboard> is true) text
		1577	and optionally replace it by C<$newtext>.
		1578
		1579	=item $term->selection_clear ([$clipboard])
		1580
		1581	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1084		1582
1085	=item $term->overlay_simple ($x, $y, $text)	1583	=item $term->overlay_simple ($x, $y, $text)
1086		1584
1087	Create a simple multi-line overlay box. See the next method for details.	1585	Create a simple multi-line overlay box. See the next method for details.
1088		1586
…		…
1118		1616
1119	The methods currently supported on C<urxvt::overlay> objects are:	1617	The methods currently supported on C<urxvt::overlay> objects are:
1120		1618
1121	=over 4	1619	=over 4
1122		1620
1123	=item $overlay->set ($x, $y, $text, $rend)	1621	=item $overlay->set ($x, $y, $text[, $rend])
1124		1622
1125	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1623	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	1624	text in rxvt-unicode's special encoding and an array of rendition values
1127	at a specific position inside the overlay.	1625	at a specific position inside the overlay.
		1626
		1627	If C<$rend> is missing, then the rendition will not be changed.
1128		1628
1129	=item $overlay->hide	1629	=item $overlay->hide
1130		1630
1131	If visible, hide the overlay, but do not destroy it.	1631	If visible, hide the overlay, but do not destroy it.
1132		1632
…		…
1202		1702
1203	Normally its not a good idea to use this function, as programs might be	1703	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	1704	confused by changes in cursor position or scrolling. Its useful inside a
1205	C<on_add_lines> hook, though.	1705	C<on_add_lines> hook, though.
1206		1706
		1707	=item $term->scr_change_screen ($screen)
		1708
		1709	Switch to given screen - 0 primary, 1 secondary.
		1710
1207	=item $term->cmd_parse ($octets)	1711	=item $term->cmd_parse ($octets)
1208		1712
1209	Similar to C<scr_add_lines>, but the argument must be in the	1713	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	1714	locale-specific encoding of the terminal and can contain command sequences
1211	(escape codes) that will be interpreted.	1715	(escape codes) that will be interpreted.
1212		1716
1213	=item $term->tt_write ($octets)	1717	=item $term->tt_write ($octets)
1214		1718
1215	Write the octets given in C<$data> to the tty (i.e. as program input). To	1719	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	1720	pass characters instead of octets, you should convert your strings first
1217	to the locale-specific encoding using C<< $term->locale_encode >>.	1721	to the locale-specific encoding using C<< $term->locale_encode >>.
		1722
		1723	=item $term->tt_paste ($octets)
		1724
		1725	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1726	CR and bracketing the data with control sequences if bracketed paste mode
		1727	is set.
1218		1728
1219	=item $old_events = $term->pty_ev_events ([$new_events])	1729	=item $old_events = $term->pty_ev_events ([$new_events])
1220		1730
1221	Replaces the event mask of the pty watcher by the given event mask. Can	1731	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	1732	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	1733	description of C<< urxvt::timer->events >>. Make sure to always restore
1224	the previous value.	1734	the previous value.
1225		1735
		1736	=item $fd = $term->pty_fd
		1737
		1738	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1739	is used.
		1740
1226	=item $windowid = $term->parent	1741	=item $windowid = $term->parent
1227		1742
1228	Return the window id of the toplevel window.	1743	Return the window id of the toplevel window.
1229		1744
1230	=item $windowid = $term->vt	1745	=item $windowid = $term->vt
…		…
1236	Adds the specified events to the vt event mask. Useful e.g. when you want	1751	Adds the specified events to the vt event mask. Useful e.g. when you want
1237	to receive pointer events all the times:	1752	to receive pointer events all the times:
1238		1753
1239	$term->vt_emask_add (urxvt::PointerMotionMask);	1754	$term->vt_emask_add (urxvt::PointerMotionMask);
1240		1755
		1756	=item $term->set_urgency ($set)
		1757
		1758	Enable/disable the urgency hint on the toplevel window.
		1759
		1760	=item $term->focus_in
		1761
		1762	=item $term->focus_out
		1763
		1764	=item $term->key_press ($state, $keycode[, $time])
		1765
		1766	=item $term->key_release ($state, $keycode[, $time])
		1767
		1768	Deliver various fake events to to terminal.
		1769
1241	=item $window_width = $term->width	1770	=item $window_width = $term->width
1242		1771
1243	=item $window_height = $term->height	1772	=item $window_height = $term->height
1244		1773
1245	=item $font_width = $term->fwidth	1774	=item $font_width = $term->fwidth
…		…
1275	=item $env = $term->env	1804	=item $env = $term->env
1276		1805
1277	Returns a copy of the environment in effect for the terminal as a hashref	1806	Returns a copy of the environment in effect for the terminal as a hashref
1278	similar to C<\%ENV>.	1807	similar to C<\%ENV>.
1279		1808
		1809	=item @envv = $term->envv
		1810
		1811	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1812
		1813	=item @argv = $term->argv
		1814
		1815	Return the argument vector as this terminal, similar to @ARGV, but
		1816	includes the program name as first element.
		1817
1280	=cut	1818	=cut
1281		1819
1282	sub env {	1820	sub env {
1283	if (my $env = $_[0]->_env) {
1284	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1821	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1285	} else {
1286	+{ %ENV }
1287	}
1288	}	1822	}
1289		1823
1290	=item $modifiermask = $term->ModLevel3Mask	1824	=item $modifiermask = $term->ModLevel3Mask
1291		1825
1292	=item $modifiermask = $term->ModMetaMask	1826	=item $modifiermask = $term->ModMetaMask
1293		1827
1294	=item $modifiermask = $term->ModNumLockMask	1828	=item $modifiermask = $term->ModNumLockMask
1295		1829
1296	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1830	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.	1831	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1832
		1833	=item $screen = $term->current_screen
		1834
		1835	Returns the currently displayed screen (0 primary, 1 secondary).
		1836
		1837	=item $cursor_is_hidden = $term->hidden_cursor
		1838
		1839	Returns whether the cursor is currently hidden or not.
1298		1840
1299	=item $view_start = $term->view_start ([$newvalue])	1841	=item $view_start = $term->view_start ([$newvalue])
1300		1842
1301	Returns the row number of the topmost displayed line. Maximum value is	1843	Returns the row number of the topmost displayed line. Maximum value is
1302	C<0>, which displays the normal terminal contents. Lower values scroll	1844	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1310		1852
1311	Used after changing terminal contents to display them.	1853	Used after changing terminal contents to display them.
1312		1854
1313	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1855	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1314		1856
1315	Returns the text of the entire row with number C<$row_number>. Row C<0>	1857	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	1858	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	1859	terminal line. Nothing will be returned if a nonexistent line
1319	is requested.	1860	is requested.
1320		1861
1321	If C<$new_text> is specified, it will replace characters in the current	1862	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	1863	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	1864	to replace only parts of a line. The font index in the rendition will
1324	automatically be updated.	1865	automatically be updated.
1325		1866
1326	C<$text> is in a special encoding: tabs and wide characters that use more	1867	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	1868	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1328	(C<chr 65535>). Characters with combining characters and other characters	1869	characters. Characters with combining characters and other characters that
1329	that do not fit into the normal tetx encoding will be replaced with	1870	do not fit into the normal text encoding will be replaced with characters
1330	characters in the private use area.	1871	in the private use area.
1331		1872
1332	You have to obey this encoding when changing text. The advantage is	1873	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	1874	that C<substr> and similar functions work on screen cells and not on
1334	characters.	1875	characters.
1335		1876
…		…
1479	where one character corresponds to one screen cell. See	2020	where one character corresponds to one screen cell. See
1480	C<< $term->ROW_t >> for details.	2021	C<< $term->ROW_t >> for details.
1481		2022
1482	=item $string = $term->special_decode $text	2023	=item $string = $term->special_decode $text
1483		2024
1484	Converts rxvt-unicodes text reprsentation into a perl string. See	2025	Converts rxvt-unicodes text representation into a perl string. See
1485	C<< $term->ROW_t >> for details.	2026	C<< $term->ROW_t >> for details.
1486		2027
1487	=item $success = $term->grab_button ($button, $modifiermask)	2028	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1488		2029
		2030	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2031
1489	Registers a synchronous button grab. See the XGrabButton manpage.	2032	Register/unregister a synchronous button grab. See the XGrabButton
		2033	manpage.
1490		2034
1491	=item $success = $term->grab ($eventtime[, $sync])	2035	=item $success = $term->grab ($eventtime[, $sync])
1492		2036
1493	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2037	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1494	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2038	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1495		2039
1496	=item $term->allow_events_async	2040	=item $term->allow_events_async
1497		2041
1498	Calls XAllowEvents with AsyncBoth for the most recent grab.	2042	Calls XAllowEvents with AsyncBoth for the most recent grab.
1499		2043
…		…
1506	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2050	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1507	recent grab.	2051	recent grab.
1508		2052
1509	=item $term->ungrab	2053	=item $term->ungrab
1510		2054
1511	Calls XUngrab for the most recent grab. Is called automatically on	2055	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	2056	evaluation errors, as it is better to lose the grab in the error case as
1513	the session.	2057	the session.
		2058
		2059	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		2060
		2061	=item $atom_name = $term->XGetAtomName ($atom)
		2062
		2063	=item @atoms = $term->XListProperties ($window)
		2064
		2065	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		2066
		2067	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		2068
		2069	=item $term->XDeleteProperty ($window, $property)
		2070
		2071	=item $window = $term->DefaultRootWindow
		2072
		2073	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		2074
		2075	=item $term->XMapWindow ($window)
		2076
		2077	=item $term->XUnmapWindow ($window)
		2078
		2079	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		2080
		2081	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		2082
		2083	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2084
		2085	=item $keysym = $term->XStringToKeysym ($string)
		2086
		2087	=item $string = $term->XKeysymToString ($keysym)
		2088
		2089	Various X or X-related functions. The C<$term> object only serves as
		2090	the source of the display, otherwise those functions map more-or-less
		2091	directly onto the X functions of the same name.
1514		2092
1515	=back	2093	=back
1516		2094
1517	=cut	2095	=cut
1518		2096
…		…
1582	my ($self, $text, $cb) = @_;	2160	my ($self, $text, $cb) = @_;
1583		2161
1584	$self->add_item ({ type => "button", text => $text, activate => $cb});	2162	$self->add_item ({ type => "button", text => $text, activate => $cb});
1585	}	2163	}
1586		2164
1587	=item $popup->add_toggle ($text, $cb, $initial_value)	2165	=item $popup->add_toggle ($text, $initial_value, $cb)
1588		2166
1589	Adds a toggle/checkbox item to the popup. Teh callback gets called	2167	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	2168	whenever it gets toggled, with a boolean indicating its new value as its
1591	argument.	2169	first argument.
1592		2170
1593	=cut	2171	=cut
1594		2172
1595	sub add_toggle {	2173	sub add_toggle {
1596	my ($self, $text, $cb, $value) = @_;	2174	my ($self, $text, $value, $cb) = @_;
1597		2175
1598	my $item; $item = {	2176	my $item; $item = {
1599	type => "button",	2177	type => "button",
1600	text => " $text",	2178	text => " $text",
1601	value => $value,	2179	value => $value,
…		…
1620	my $env = $self->{term}->env;	2198	my $env = $self->{term}->env;
1621	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2199	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1622	delete $env->{LC_ALL};	2200	delete $env->{LC_ALL};
1623	$env->{LC_CTYPE} = $self->{term}->locale;	2201	$env->{LC_CTYPE} = $self->{term}->locale;
1624		2202
1625	urxvt::term->new ($env, "popup",	2203	my $term = urxvt::term->new (
		2204	$env, "popup",
1626	"--perl-lib" => "", "--perl-ext-common" => "",	2205	"--perl-lib" => "", "--perl-ext-common" => "",
1627	"-pty-fd" => -1, "-sl" => 0,	2206	"-pty-fd" => -1, "-sl" => 0,
1628	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2207	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1629	"--transient-for" => $self->{term}->parent,	2208	"--transient-for" => $self->{term}->parent,
1630	"-display" => $self->{term}->display_id,	2209	"-display" => $self->{term}->display_id,
1631	"-pe" => "urxvt-popup")	2210	"-pe" => "urxvt-popup",
1632	or die "unable to create popup window\n";	2211	) or die "unable to create popup window\n";
		2212
		2213	unless (delete $term->{urxvt_popup_init_done}) {
		2214	$term->ungrab;
		2215	$term->destroy;
		2216	die "unable to initialise popup window\n";
		2217	}
1633	}	2218	}
1634		2219
1635	sub DESTROY {	2220	sub DESTROY {
1636	my ($self) = @_;	2221	my ($self) = @_;
1637		2222
1638	delete $self->{term}{_destroy}{$self};	2223	delete $self->{term}{_destroy}{$self};
1639	$self->{term}->ungrab;	2224	$self->{term}->ungrab;
1640	}	2225	}
1641		2226
1642	=back	2227	=back
		2228
		2229	=cut
		2230
		2231	package urxvt::watcher;
1643		2232
1644	=head2 The C<urxvt::timer> Class	2233	=head2 The C<urxvt::timer> Class
1645		2234
1646	This class implements timer watchers/events. Time is represented as a	2235	This class implements timer watchers/events. Time is represented as a
1647	fractional number of seconds since the epoch. Example:	2236	fractional number of seconds since the epoch. Example:
…		…
1651	->new	2240	->new
1652	->interval (1)	2241	->interval (1)
1653	->cb (sub {	2242	->cb (sub {
1654	$term->{overlay}->set (0, 0,	2243	$term->{overlay}->set (0, 0,
1655	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2244	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1656	});	2245	});
1657		2246
1658	=over 4	2247	=over 4
1659		2248
1660	=item $timer = new urxvt::timer	2249	=item $timer = new urxvt::timer
1661		2250
…		…
1664		2253
1665	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2254	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1666		2255
1667	Set the callback to be called when the timer triggers.	2256	Set the callback to be called when the timer triggers.
1668		2257
1669	=item $tstamp = $timer->at
1670
1671	Return the time this watcher will fire next.
1672
1673	=item $timer = $timer->set ($tstamp)	2258	=item $timer = $timer->set ($tstamp[, $interval])
1674		2259
1675	Set the time the event is generated to $tstamp.	2260	Set the time the event is generated to $tstamp (and optionally specifies a
		2261	new $interval).
1676		2262
1677	=item $timer = $timer->interval ($interval)	2263	=item $timer = $timer->interval ($interval)
1678		2264
1679	Normally (and when C<$interval> is C<0>), the timer will automatically	2265	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	2266	stop after it has fired once. If C<$interval> is non-zero, then the timer
1681	is automatically rescheduled at the given intervals.	2267	is automatically rescheduled at the given intervals.
1682		2268
1683	=item $timer = $timer->start	2269	=item $timer = $timer->start
1684		2270
1685	Start the timer.	2271	Start the timer.
1686		2272
1687	=item $timer = $timer->start ($tstamp)	2273	=item $timer = $timer->start ($tstamp[, $interval])
1688		2274
1689	Set the event trigger time to C<$tstamp> and start the timer.	2275	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2276	also replaces the interval.
1690		2277
1691	=item $timer = $timer->after ($delay)	2278	=item $timer = $timer->after ($delay[, $interval])
1692		2279
1693	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2280	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1694		2281
1695	=item $timer = $timer->stop	2282	=item $timer = $timer->stop
1696		2283
…		…
1704		2291
1705	$term->{socket} = ...	2292	$term->{socket} = ...
1706	$term->{iow} = urxvt::iow	2293	$term->{iow} = urxvt::iow
1707	->new	2294	->new
1708	->fd (fileno $term->{socket})	2295	->fd (fileno $term->{socket})
1709	->events (urxvt::EVENT_READ)	2296	->events (urxvt::EV_READ)
1710	->start	2297	->start
1711	->cb (sub {	2298	->cb (sub {
1712	my ($iow, $revents) = @_;	2299	my ($iow, $revents) = @_;
1713	# $revents must be 1 here, no need to check	2300	# $revents must be 1 here, no need to check
1714	sysread $term->{socket}, my $buf, 8192	2301	sysread $term->{socket}, my $buf, 8192
…		…
1727	Set the callback to be called when io events are triggered. C<$reventmask>	2314	Set the callback to be called when io events are triggered. C<$reventmask>
1728	is a bitset as described in the C<events> method.	2315	is a bitset as described in the C<events> method.
1729		2316
1730	=item $iow = $iow->fd ($fd)	2317	=item $iow = $iow->fd ($fd)
1731		2318
1732	Set the filedescriptor (not handle) to watch.	2319	Set the file descriptor (not handle) to watch.
1733		2320
1734	=item $iow = $iow->events ($eventmask)	2321	=item $iow = $iow->events ($eventmask)
1735		2322
1736	Set the event mask to watch. The only allowed values are	2323	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	2324	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1738	together, or C<urxvt::EVENT_NONE>.	2325	together, or C<urxvt::EV_NONE>.
1739		2326
1740	=item $iow = $iow->start	2327	=item $iow = $iow->start
1741		2328
1742	Start watching for requested events on the given handle.	2329	Start watching for requested events on the given handle.
1743		2330
1744	=item $iow = $iow->stop	2331	=item $iow = $iow->stop
1745		2332
1746	Stop watching for events on the given filehandle.	2333	Stop watching for events on the given file handle.
		2334
		2335	=back
		2336
		2337	=head2 The C<urxvt::iw> Class
		2338
		2339	This class implements idle watchers, that get called automatically when
		2340	the process is idle. They should return as fast as possible, after doing
		2341	some useful work.
		2342
		2343	=over 4
		2344
		2345	=item $iw = new urxvt::iw
		2346
		2347	Create a new idle watcher object in stopped state.
		2348
		2349	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2350
		2351	Set the callback to be called when the watcher triggers.
		2352
		2353	=item $timer = $timer->start
		2354
		2355	Start the watcher.
		2356
		2357	=item $timer = $timer->stop
		2358
		2359	Stop the watcher.
		2360
		2361	=back
		2362
		2363	=head2 The C<urxvt::pw> Class
		2364
		2365	This class implements process watchers. They create an event whenever a
		2366	process exits, after which they stop automatically.
		2367
		2368	my $pid = fork;
		2369	...
		2370	$term->{pw} = urxvt::pw
		2371	->new
		2372	->start ($pid)
		2373	->cb (sub {
		2374	my ($pw, $exit_status) = @_;
		2375	...
		2376	});
		2377
		2378	=over 4
		2379
		2380	=item $pw = new urxvt::pw
		2381
		2382	Create a new process watcher in stopped state.
		2383
		2384	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2385
		2386	Set the callback to be called when the timer triggers.
		2387
		2388	=item $pw = $timer->start ($pid)
		2389
		2390	Tells the watcher to start watching for process C<$pid>.
		2391
		2392	=item $pw = $pw->stop
		2393
		2394	Stop the watcher.
1747		2395
1748	=back	2396	=back
1749		2397
1750	=head1 ENVIRONMENT	2398	=head1 ENVIRONMENT
1751		2399
…		…
1760		2408
1761	=item >= 3 - script loading and management	2409	=item >= 3 - script loading and management
1762		2410
1763	=item >=10 - all called hooks	2411	=item >=10 - all called hooks
1764		2412
1765	=item >=11 - hook reutrn values	2413	=item >=11 - hook return values
1766		2414
1767	=back	2415	=back
1768		2416
1769	=head1 AUTHOR	2417	=head1 AUTHOR
1770		2418
1771	Marc Lehmann <pcg@goof.com>	2419	Marc Lehmann <schmorp@schmorp.de>
1772	http://software.schmorp.de/pkg/rxvt-unicode	2420	http://software.schmorp.de/pkg/rxvt-unicode
1773		2421
1774	=cut	2422	=cut
1775		2423
1776	1	2424	1
		2425
		2426	# vim: sw=3:

Diff Legend

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