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.115 by root, Fri Jan 20 15:57:21 2006 UTC vs.
Revision 1.209 by root, Tue Jun 5 22:38:17 2012 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
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.
…		…
165	the message into vi commands to load the file.	223	the message into vi commands to load the file.
166		224
167	=item tabbed	225	=item tabbed
168		226
169	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one	229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
172	button per tab.	230	button per tab.
173		231
174	Clicking a button will activate that tab. Pressing Shift-Left and	232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
175	Shift-Right will switch to the tab left or right of the current one.	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.
176		235
177	=item mark-urls	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):
178		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
179	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
180	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
181	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
182	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.
183		258
184	=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.
185		263
186	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
187	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
188	a custom pixmap. No scaling is supported in this mode. Exmaple:	266	"perl:matcher:list" as seen in the example below.
189		267
190	@@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.
191		315
192	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
193		317
194	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
195	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
196	similar-looking ascii character.	320	similar-looking ascii character.
197		321
198	=item digital-clock	322	=item digital-clock
199		323
200	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.
201		393
202	=item example-refresh-hooks	394	=item example-refresh-hooks
203		395
204	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
205	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
206	overlays or changes.	398	overlays or changes.
207		399
208	=item selection-pastebin	400	=item confirm-paste
209		401
210	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
211	textfile to a remote site (or does other things). (The implementation is	403	line is detected.
212	not currently secure for use in a multiuser environment as it writes to
213	F</tmp> directly.).
214		404
215	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	405	=item bell-command
216	i.e.
217		406
218	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:
219		410
220	Pressing this combination runs a command with C<%> replaced by the name of	411	URxvt.bell-command: notify-send "Beep, Beep"
221	the textfile. This command can be set via a resource:
222
223	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
224
225	And the default is likely not useful to anybody but the few people around
226	here :)
227
228	The name of the textfile is the hex encoded md5 sum of the selection, so
229	the same content should lead to the same filename.
230
231	After a successful upload the selection will be replaced by the text given
232	in the C<selection-pastebin-url> resource (again, the % is the placeholder
233	for the filename):
234
235	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
236		412
237	=back	413	=back
238		414
239	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
240		416
…		…
256		432
257	=over 4	433	=over 4
258		434
259	=item $text	435	=item $text
260		436
261	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
262	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.
263		439
264	=item $string	440	=item $string
265		441
266	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
…		…
270	=item $octets	446	=item $octets
271		447
272	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
273	locale-specific way.	449	locale-specific way.
274		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
275	=back	457	=back
276		458
277	=head2 Extension Objects	459	=head2 Extension Objects
278		460
279	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
280	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,
281	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
282	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
283	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
284	use.	467	internal use.
285		468
286	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
287	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
288		471
289	It has the following methods and data members:	472	It has the following methods and data members:
…		…
310	=head2 Hooks	493	=head2 Hooks
311		494
312	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
313	called whenever the relevant event happens.	496	called whenever the relevant event happens.
314		497
315	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
316	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
317		500
318	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
319	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
320	relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
…		…
333	place.	516	place.
334		517
335	=item on_start $term	518	=item on_start $term
336		519
337	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
338	trying to map (display) the toplevel and returning to the mainloop.	521	trying to map (display) the toplevel and returning to the main loop.
339		522
340	=item on_destroy $term	523	=item on_destroy $term
341		524
342	Called whenever something tries to destroy terminal, before doing anything	525	Called whenever something tries to destroy terminal, when the terminal is
343	yet. If this hook returns true, then destruction is skipped, but this is	526	still fully functional (not for long, though).
344	rarely a good idea.
345		527
346	=item on_reset $term	528	=item on_reset $term
347		529
348	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
349	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
…		…
371		553
372	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
373	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
374	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
375		557
376	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.
377		559
378	=item on_sel_extend $term	560	=item on_sel_extend $term
379		561
380	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
381	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
382	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
383	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
384	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
385	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
386		568
387	See the F<selection> example extension.	569	See the F<selection> example extension.
388		570
389	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
390		572
391	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
392	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
393	show this many lines of scrollback.	575	show this many lines of scrollback.
394		576
395	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
396		578
…		…
400		582
401	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,
402	$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
403	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
404		586
405	=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
406		598
407	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
408	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
409	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
410	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,
411	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
412	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	}
413		615
414	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,
415	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
416	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.
417		622
418	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
419		624
420	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
421	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
…		…
426	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
427		632
428	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
429	suppress or filter tty input.	634	suppress or filter tty input.
430		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
431	=item on_line_update $term, $row	643	=item on_line_update $term, $row
432		644
433	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
434	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
435	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,
…		…
442	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
443	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
444		656
445	=item on_refresh_begin $term	657	=item on_refresh_begin $term
446		658
447	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
448	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
449	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
450	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
451		663
452	=item on_refresh_end $term	664	=item on_refresh_end $term
453		665
454	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>.
455		667
456	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
457		669
458	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
459	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>
460	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.
461		689
462	=item on_x_event $term, $event	690	=item on_x_event $term, $event
463		691
464	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
465	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
466	members are not passed.	694	members are not passed.
467		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
468	=item on_focus_in $term	700	=item on_focus_in $term
469		701
470	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
471	does focus in processing.	703	does focus in processing.
472		704
473	=item on_focus_out $term	705	=item on_focus_out $term
474		706
475	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
476	focus out processing.	708	focus out processing.
477		709
478	=item on_configure_notify $term, $event	710	=item on_configure_notify $term, $event
479		711
		712	=item on_property_notify $term, $event
		713
480	=item on_key_press $term, $event, $keysym, $octets	714	=item on_key_press $term, $event, $keysym, $octets
481		715
482	=item on_key_release $term, $event, $keysym	716	=item on_key_release $term, $event, $keysym
483		717
484	=item on_button_press $term, $event	718	=item on_button_press $term, $event
…		…
489		723
490	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
491		725
492	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
493		727
494	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
495	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.
496		730
497	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
498	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
499	and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
500		734
501	C<on_key_press> additionally receives the string rxvt-unicode would	735	C<on_key_press> additionally receives the string rxvt-unicode would
502	output, if any, in locale-specific encoding.	736	output, if any, in locale-specific encoding.
503		737
504	subwindow.	738	subwindow.
…		…
509		743
510	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
511		745
512	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
513	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	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.
514		752
515	=back	753	=back
516		754
517	=cut	755	=cut
518		756
…		…
535	our $LIBDIR;	773	our $LIBDIR;
536	our $RESNAME;	774	our $RESNAME;
537	our $RESCLASS;	775	our $RESCLASS;
538	our $RXVTNAME;	776	our $RXVTNAME;
539		777
		778	our $NOCHAR = chr 0xffff;
		779
540	=head2 Variables in the C<urxvt> Package	780	=head2 Variables in the C<urxvt> Package
541		781
542	=over 4	782	=over 4
543		783
544	=item $urxvt::LIBDIR	784	=item $urxvt::LIBDIR
…		…
559	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
560	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
561		801
562	=item @urxvt::TERM_INIT	802	=item @urxvt::TERM_INIT
563		803
564	All coderefs in this array will be called as methods of the next newly	804	All code references in this array will be called as methods of the next newly
565	created C<urxvt::term> object (during the C<on_init> phase). The array	805	created C<urxvt::term> object (during the C<on_init> phase). The array
566	gets cleared before the codereferences that were in it are being executed,	806	gets cleared before the code references that were in it are being executed,
567	so coderefs can push themselves onto it again if they so desire.	807	so references can push themselves onto it again if they so desire.
568		808
569	This complements to the perl-eval commandline option, but gets executed	809	This complements to the perl-eval command line option, but gets executed
570	first.	810	first.
571		811
572	=item @urxvt::TERM_EXT	812	=item @urxvt::TERM_EXT
573		813
574	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	814	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
581		821
582	=over 4	822	=over 4
583		823
584	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
585		825
586	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
587	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
588	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
589		830
590	=item urxvt::warn $string	831	=item urxvt::warn $string
591		832
592	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
593	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
594	that calls this function.	835	that calls this function.
595		836
596	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
597	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
598		839
599	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).
600		848
601	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
602		850
603	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
604		852
…		…
647		895
648	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
649		897
650	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
651		899
652	=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
653		902
654	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
655	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
656	the bitset.	905	the bitset.
657		906
…		…
662	Return the foreground/background colour index, respectively.	911	Return the foreground/background colour index, respectively.
663		912
664	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
665		914
666	=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
667		918
668	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
669	specified one.	920	specified one.
670		921
671	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
…		…
690	unless $msg =~ /\n$/;	941	unless $msg =~ /\n$/;
691	urxvt::warn ($msg);	942	urxvt::warn ($msg);
692	};	943	};
693	}	944	}
694		945
		946	no warnings 'utf8';
		947
		948	sub resource {
		949	my ($term, $name, $isarg, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	warn "resourece<@_>\n";#d#
		954
		955	0
		956	}
		957
		958	sub usage {
		959	my ($term, $usage_type) = @_;
		960
		961	$term->scan_meta;
		962
		963	my $r = $term->{meta}{resource};
		964
		965	for my $regex (sort keys %$r) {
		966	my ($ext, $type, $desc) = @{ $r->{$regex} };
		967
		968	$desc .= " (-pe $ext)";
		969
		970	if ($usage_type == 1) {
		971	if ($type eq "boolean") {
		972	urxvt::log sprintf " -%-20.20s %s\n", "/+$regex", $desc;
		973	} else {
		974	urxvt::log sprintf " -%-20.20s %s\n", "$regex $type", $desc;
		975	}
		976	} else {
		977	urxvt::log sprintf " %-19.19s %s\n", "$regex:", $type;
		978	}
		979	}
		980	}
		981
695	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	982	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
696		983
697	sub verbose {	984	sub verbose {
698	my ($level, $msg) = @_;	985	my ($level, $msg) = @_;
699	warn "$msg\n" if $level <= $verbosity;	986	warn "$msg\n" if $level <= $verbosity;
…		…
715		1002
716	open my $fh, "<:raw", $path	1003	open my $fh, "<:raw", $path
717	or die "$path: $!";	1004	or die "$path: $!";
718		1005
719	my $source =	1006	my $source =
720	"package $pkg; use strict; use utf8;\n"	1007	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
721	. "#line 1 \"$path\"\n{\n"	1008	. "#line 1 \"$path\"\n{\n"
722	. (do { local $/; <$fh> })	1009	. (do { local $/; <$fh> })
723	. "\n};\n1";	1010	. "\n};\n1";
724		1011
725	eval $source	1012	eval $source
…		…
735	sub invoke {	1022	sub invoke {
736	local $TERM = shift;	1023	local $TERM = shift;
737	my $htype = shift;	1024	my $htype = shift;
738		1025
739	if ($htype == 0) { # INIT	1026	if ($htype == 0) { # INIT
740	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1027	my @dirs = $TERM->perl_libdirs;
741		1028
742	my %ext_arg;	1029	my %ext_arg;
743		1030
744	{	1031	{
745	my @init = @TERM_INIT;	1032	my @init = @TERM_INIT;
746	@TERM_INIT = ();	1033	@TERM_INIT = ();
…		…
750	$TERM->register_package ($_) for @pkg;	1037	$TERM->register_package ($_) for @pkg;
751	}	1038	}
752		1039
753	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1040	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
754	if ($_ eq "default") {	1041	if ($_ eq "default") {
755	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	1042	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
756	} elsif (/^-(.*)$/) {	1043	} elsif (/^-(.*)$/) {
757	delete $ext_arg{$1};	1044	delete $ext_arg{$1};
758	} elsif (/^([^<]+)<(.*)>$/) {	1045	} elsif (/^([^<]+)<(.*)>$/) {
759	push @{ $ext_arg{$1} }, $2;	1046	push @{ $ext_arg{$1} }, $2;
760	} else {	1047	} else {
761	$ext_arg{$_} ||= [];	1048	$ext_arg{$_} ||= [];
762	}	1049	}
763	}	1050	}
764		1051
765	while (my ($ext, $argv) = each %ext_arg) {	1052	for my $ext (sort keys %ext_arg) {
766	my @files = grep -f $_, map "$_/$ext", @dirs;	1053	my @files = grep -f $_, map "$_/$ext", @dirs;
767		1054
768	if (@files) {	1055	if (@files) {
769	$TERM->register_package (extension_package $files[0], $argv);	1056	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
770	} else {	1057	} else {
771	warn "perl extension '$ext' not found in perl library search path\n";	1058	warn "perl extension '$ext' not found in perl library search path\n";
772	}	1059	}
773	}	1060	}
774		1061
…		…
780		1067
781	if (my $cb = $TERM->{_hook}[$htype]) {	1068	if (my $cb = $TERM->{_hook}[$htype]) {
782	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1069	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
783	if $verbosity >= 10;	1070	if $verbosity >= 10;
784		1071
785	keys %$cb;	1072	for my $pkg (keys %$cb) {
786
787	while (my ($pkg, $cb) = each %$cb) {
788	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1073	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
789	$retval ||= $retval_;	1074	$retval ||= $retval_;
790		1075
791	if ($@) {	1076	if ($@) {
792	$TERM->ungrab; # better to lose the grab than the session	1077	$TERM->ungrab; # better to lose the grab than the session
793	warn $@;	1078	warn $@;
…		…
805	# clear package	1090	# clear package
806	%$TERM = ();	1091	%$TERM = ();
807	}	1092	}
808		1093
809	$retval	1094	$retval
		1095	}
		1096
		1097	sub SET_COLOR($$$) {
		1098	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1099	}
		1100
		1101	sub rend2mask {
		1102	no strict 'refs';
		1103	my ($str, $mask) = (@_, 0);
		1104	my %color = ( fg => undef, bg => undef );
		1105	my @failed;
		1106	for my $spec ( split /\s+/, $str ) {
		1107	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1108	$color{lc($1)} = $2;
		1109	} else {
		1110	my $neg = $spec =~ s/^[-^]//;
		1111	unless ( exists &{"RS_$spec"} ) {
		1112	push @failed, $spec;
		1113	next;
		1114	}
		1115	my $cur = &{"RS_$spec"};
		1116	if ( $neg ) {
		1117	$mask &= ~$cur;
		1118	} else {
		1119	$mask |= $cur;
		1120	}
		1121	}
		1122	}
		1123	($mask, @color{qw(fg bg)}, \@failed)
810	}	1124	}
811		1125
812	# urxvt::term::extension	1126	# urxvt::term::extension
813		1127
814	package urxvt::term::extension;	1128	package urxvt::term::extension;
…		…
879	=head2 The C<urxvt::anyevent> Class	1193	=head2 The C<urxvt::anyevent> Class
880		1194
881	The sole purpose of this class is to deliver an interface to the	1195	The sole purpose of this class is to deliver an interface to the
882	C<AnyEvent> module - any module using it will work inside urxvt without	1196	C<AnyEvent> module - any module using it will work inside urxvt without
883	further programming. The only exception is that you cannot wait on	1197	further programming. The only exception is that you cannot wait on
884	condition variables, but non-blocking condvar use is ok. What this means	1198	condition variables, but non-blocking condvar use is ok.
885	is that you cannot use blocking APIs, but the non-blocking variant should	1199
886	work.	1200	In practical terms this means is that you cannot use blocking APIs, but
		1201	the non-blocking variant should work.
887		1202
888	=cut	1203	=cut
889		1204
890	our $VERSION = 1;	1205	our $VERSION = '5.23';
891		1206
892	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1207	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
893	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1208	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
894		1209
895	sub timer {	1210	sub timer {
…		…
897		1212
898	my $cb = $arg{cb};	1213	my $cb = $arg{cb};
899		1214
900	urxvt::timer	1215	urxvt::timer
901	->new	1216	->new
902	->start (urxvt::NOW + $arg{after})	1217	->after ($arg{after}, $arg{interval})
903	->cb (sub {	1218	->cb ($arg{interval} ? $cb : sub {
904	$_[0]->stop; # need to cancel manually	1219	$_[0]->stop; # need to cancel manually
905	$cb->();	1220	$cb->();
906	})	1221	})
907	}	1222	}
908		1223
909	sub io {	1224	sub io {
910	my ($class, %arg) = @_;	1225	my ($class, %arg) = @_;
911		1226
912	my $cb = $arg{cb};	1227	my $cb = $arg{cb};
		1228	my $fd = fileno $arg{fh};
		1229	defined $fd or $fd = $arg{fh};
913		1230
914	bless [$arg{fh}, urxvt::iow	1231	bless [$arg{fh}, urxvt::iow
915	->new	1232	->new
916	->fd (fileno $arg{fh})	1233	->fd ($fd)
917	->events (($arg{poll} =~ /r/ ? 1 : 0)	1234	->events (($arg{poll} =~ /r/ ? 1 : 0)
918	| ($arg{poll} =~ /w/ ? 2 : 0))	1235	| ($arg{poll} =~ /w/ ? 2 : 0))
919	->start	1236	->start
920	->cb (sub {	1237	->cb ($cb)
921	$cb->(($_[1] & 1 ? 'r' : '')
922	. ($_[1] & 2 ? 'w' : ''));
923	})],
924	urxvt::anyevent::	1238	], urxvt::anyevent::
		1239	}
		1240
		1241	sub idle {
		1242	my ($class, %arg) = @_;
		1243
		1244	my $cb = $arg{cb};
		1245
		1246	urxvt::iw
		1247	->new
		1248	->start
		1249	->cb ($cb)
		1250	}
		1251
		1252	sub child {
		1253	my ($class, %arg) = @_;
		1254
		1255	my $cb = $arg{cb};
		1256
		1257	urxvt::pw
		1258	->new
		1259	->start ($arg{pid})
		1260	->cb (sub {
		1261	$_[0]->stop; # need to cancel manually
		1262	$cb->($_[0]->rpid, $_[0]->rstatus);
		1263	})
925	}	1264	}
926		1265
927	sub DESTROY {	1266	sub DESTROY {
928	$_[0][1]->stop;	1267	$_[0][1]->stop;
929	}	1268	}
930		1269
931	sub condvar {	1270	# only needed for AnyEvent < 6 compatibility
932	bless \my $flag, urxvt::anyevent::condvar::	1271	sub one_event {
933	}
934
935	sub urxvt::anyevent::condvar::broadcast {
936	${$_[0]}++;
937	}
938
939	sub urxvt::anyevent::condvar::wait {
940	unless (${$_[0]}) {
941	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1272	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
942	}
943	}	1273	}
944		1274
945	package urxvt::term;	1275	package urxvt::term;
946		1276
947	=head2 The C<urxvt::term> Class	1277	=head2 The C<urxvt::term> Class
…		…
974	$proxy->enable ($name => $ref);	1304	$proxy->enable ($name => $ref);
975	}	1305	}
976	}	1306	}
977	}	1307	}
978		1308
		1309	sub perl_libdirs {
		1310	map { split /:/ }
		1311	$_[0]->resource ("perl_lib"),
		1312	$ENV{URXVT_PERL_LIB},
		1313	"$ENV{HOME}/.urxvt/ext",
		1314	"$LIBDIR/perl"
		1315	}
		1316
		1317	sub scan_meta {
		1318	my ($self) = @_;
		1319	my @libdirs = perl_libdirs $self;
		1320
		1321	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1322
		1323	my %meta;
		1324
		1325	$self->{meta_libdirs} = join "\x00", @libdirs;
		1326	$self->{meta} = \%meta;
		1327
		1328	for my $dir (reverse @libdirs) {
		1329	opendir my $fh, $dir
		1330	or next;
		1331	for my $ext (readdir $fh) {
		1332	$ext ne "."
		1333	and $ext ne ".."
		1334	and open my $fh, "<", "$dir/$ext"
		1335	or next;
		1336
		1337	while (<$fh>) {
		1338	if (/^#:META:RESOURCE:(.*)/) {
		1339	my ($regex, $type, $desc) = split /:/, $1;
		1340	$regex =~ s/\$\$/$ext/g; # $$ in regex == extension name
		1341	$meta{resource}{$regex} = [$ext, $type, $desc];
		1342	} elsif (/^\s*(?:#|$)/) {
		1343	# skip other comments and empty lines
		1344	} else {
		1345	last; # stop parsing on first non-empty non-comment line
		1346	}
		1347	}
		1348	}
		1349	}
		1350	}
		1351
979	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1352	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
980		1353
981	Creates a new terminal, very similar as if you had started it with system	1354	Creates a new terminal, very similar as if you had started it with system
982	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1355	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
983	hash which defines the environment of the new terminal.	1356	hash which defines the environment of the new terminal.
984		1357
985	Croaks (and probably outputs an error message) if the new instance	1358	Croaks (and probably outputs an error message) if the new instance
986	couldn't be created. Returns C<undef> if the new instance didn't	1359	couldn't be created. Returns C<undef> if the new instance didn't
987	initialise perl, and the terminal object otherwise. The C<init> and	1360	initialise perl, and the terminal object otherwise. The C<init> and
988	C<start> hooks will be called during this call.	1361	C<start> hooks will be called before this call returns, and are free to
		1362	refer to global data (which is race free).
989		1363
990	=cut	1364	=cut
991		1365
992	sub new {	1366	sub new {
993	my ($class, $env, @args) = @_;	1367	my ($class, $env, @args) = @_;
994		1368
		1369	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1370	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1371
995	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1372	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
996	}	1373	}
997		1374
998	=item $term->destroy	1375	=item $term->destroy
999		1376
1000	Destroy the terminal object (close the window, free resources	1377	Destroy the terminal object (close the window, free resources
…		…
1030		1407
1031	Returns true if the option specified by C<$optval> is enabled, and	1408	Returns true if the option specified by C<$optval> is enabled, and
1032	optionally change it. All option values are stored by name in the hash	1409	optionally change it. All option values are stored by name in the hash
1033	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1410	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1034		1411
1035	Here is a a likely non-exhaustive list of option names, please see the	1412	Here is a likely non-exhaustive list of option names, please see the
1036	source file F</src/optinc.h> to see the actual list:	1413	source file F</src/optinc.h> to see the actual list:
1037		1414
1038	borderLess console cursorBlink cursorUnderline hold iconic insecure	1415	borderLess buffered console cursorBlink cursorUnderline hold iconic
1039	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1416	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1040	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1417	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1041	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1418	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1042	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1419	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1043	transparent tripleclickwords utmpInhibit visualBell	1420	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1421	urgentOnBell utmpInhibit visualBell
1044		1422
1045	=item $value = $term->resource ($name[, $newval])	1423	=item $value = $term->resource ($name[, $newval])
1046		1424
1047	Returns the current resource value associated with a given name and	1425	Returns the current resource value associated with a given name and
1048	optionally sets a new value. Setting values is most useful in the C<init>	1426	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1057	likely change).	1435	likely change).
1058		1436
1059	Please note that resource strings will currently only be freed when the	1437	Please note that resource strings will currently only be freed when the
1060	terminal is destroyed, so changing options frequently will eat memory.	1438	terminal is destroyed, so changing options frequently will eat memory.
1061		1439
1062	Here is a a likely non-exhaustive list of resource names, not all of which	1440	Here is a likely non-exhaustive list of resource names, not all of which
1063	are supported in every build, please see the source file F</src/rsinc.h>	1441	are supported in every build, please see the source file F</src/rsinc.h>
1064	to see the actual list:	1442	to see the actual list:
1065		1443
1066	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1444	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1067	borderLess color cursorBlink cursorUnderline cutchars delete_key	1445	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1068	display_name embed ext_bwidth fade font geometry hold iconName	1446	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1069	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1447	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1448	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1070	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1449	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1071	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1450	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1072	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1451	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1073	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1452	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1074	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1453	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1075	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1454	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1076	secondaryScreen secondaryScroll selectstyle shade term_name title	1455	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1077	transient_for transparent transparent_all tripleclickwords utmpInhibit	1456	term_name title transient_for transparent tripleclickwords urgentOnBell
1078	visualBell	1457	utmpInhibit visualBell
1079		1458
1080	=cut	1459	=cut
1081		1460
1082	sub resource($$;$) {	1461	sub resource($$;$) {
1083	my ($self, $name) = (shift, shift);	1462	my ($self, $name) = (shift, shift);
1084	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1463	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1085	&urxvt::term::_resource	1464	goto &urxvt::term::_resource
1086	}	1465	}
1087		1466
1088	=item $value = $term->x_resource ($pattern)	1467	=item $value = $term->x_resource ($pattern)
1089		1468
1090	Returns the X-Resource for the given pattern, excluding the program or	1469	Returns the X-Resource for the given pattern, excluding the program or
…		…
1094		1473
1095	This method should only be called during the C<on_start> hook, as there is	1474	This method should only be called during the C<on_start> hook, as there is
1096	only one resource database per display, and later invocations might return	1475	only one resource database per display, and later invocations might return
1097	the wrong resources.	1476	the wrong resources.
1098		1477
1099	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1478	=item $success = $term->parse_keysym ($key, $octets)
1100		1479
1101	Adds a keymap translation exactly as specified via a resource. See the	1480	Adds a key binding exactly as specified via a resource. See the
1102	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1481	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1482
		1483	=item $term->register_command ($keysym, $modifiermask, $string)
		1484
		1485	Adds a key binding. This is a lower level api compared to
		1486	C<parse_keysym>, as it expects a parsed key description, and can be
		1487	used only inside either the C<on_init> hook, to add a binding, or the
		1488	C<on_register_command> hook, to modify a parsed binding.
1103		1489
1104	=item $rend = $term->rstyle ([$new_rstyle])	1490	=item $rend = $term->rstyle ([$new_rstyle])
1105		1491
1106	Return and optionally change the current rendition. Text that is output by	1492	Return and optionally change the current rendition. Text that is output by
1107	the terminal application will use this style.	1493	the terminal application will use this style.
…		…
1115		1501
1116	=item ($row, $col) = $term->selection_beg ([$row, $col])	1502	=item ($row, $col) = $term->selection_beg ([$row, $col])
1117		1503
1118	=item ($row, $col) = $term->selection_end ([$row, $col])	1504	=item ($row, $col) = $term->selection_end ([$row, $col])
1119		1505
1120	Return the current values of the selection mark, begin or end positions,	1506	Return the current values of the selection mark, begin or end positions.
1121	and optionally set them to new values.	1507
		1508	When arguments are given, then the selection coordinates are set to
		1509	C<$row> and C<$col>, and the selection screen is set to the current
		1510	screen.
		1511
		1512	=item $screen = $term->selection_screen ([$screen])
		1513
		1514	Returns the current selection screen, and then optionally sets it.
1122		1515
1123	=item $term->selection_make ($eventtime[, $rectangular])	1516	=item $term->selection_make ($eventtime[, $rectangular])
1124		1517
1125	Tries to make a selection as set by C<selection_beg> and	1518	Tries to make a selection as set by C<selection_beg> and
1126	C<selection_end>. If C<$rectangular> is true (default: false), a	1519	C<selection_end>. If C<$rectangular> is true (default: false), a
1127	rectangular selection will be made. This is the prefered function to make	1520	rectangular selection will be made. This is the preferred function to make
1128	a selection.	1521	a selection.
1129		1522
1130	=item $success = $term->selection_grab ($eventtime)	1523	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1131		1524
1132	Try to request the primary selection text from the server (for example, as	1525	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1526	true) selection from the server. The corresponding text can be set
1133	set by the next method). No visual feedback will be given. This function	1527	with the next method. No visual feedback will be given. This function
1134	is mostly useful from within C<on_sel_grab> hooks.	1528	is mostly useful from within C<on_sel_grab> hooks.
1135		1529
1136	=item $oldtext = $term->selection ([$newtext])	1530	=item $oldtext = $term->selection ([$newtext, $clipboard])
1137		1531
1138	Return the current selection text and optionally replace it by C<$newtext>.	1532	Return the current selection (clipboard if C<$clipboard> is true) text
		1533	and optionally replace it by C<$newtext>.
		1534
		1535	=item $term->selection_clear ([$clipboard])
		1536
		1537	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1139		1538
1140	=item $term->overlay_simple ($x, $y, $text)	1539	=item $term->overlay_simple ($x, $y, $text)
1141		1540
1142	Create a simple multi-line overlay box. See the next method for details.	1541	Create a simple multi-line overlay box. See the next method for details.
1143		1542
…		…
1173		1572
1174	The methods currently supported on C<urxvt::overlay> objects are:	1573	The methods currently supported on C<urxvt::overlay> objects are:
1175		1574
1176	=over 4	1575	=over 4
1177		1576
1178	=item $overlay->set ($x, $y, $text, $rend)	1577	=item $overlay->set ($x, $y, $text[, $rend])
1179		1578
1180	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1579	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1181	text in rxvt-unicode's special encoding and an array of rendition values	1580	text in rxvt-unicode's special encoding and an array of rendition values
1182	at a specific position inside the overlay.	1581	at a specific position inside the overlay.
		1582
		1583	If C<$rend> is missing, then the rendition will not be changed.
1183		1584
1184	=item $overlay->hide	1585	=item $overlay->hide
1185		1586
1186	If visible, hide the overlay, but do not destroy it.	1587	If visible, hide the overlay, but do not destroy it.
1187		1588
…		…
1257		1658
1258	Normally its not a good idea to use this function, as programs might be	1659	Normally its not a good idea to use this function, as programs might be
1259	confused by changes in cursor position or scrolling. Its useful inside a	1660	confused by changes in cursor position or scrolling. Its useful inside a
1260	C<on_add_lines> hook, though.	1661	C<on_add_lines> hook, though.
1261		1662
		1663	=item $term->scr_change_screen ($screen)
		1664
		1665	Switch to given screen - 0 primary, 1 secondary.
		1666
1262	=item $term->cmd_parse ($octets)	1667	=item $term->cmd_parse ($octets)
1263		1668
1264	Similar to C<scr_add_lines>, but the argument must be in the	1669	Similar to C<scr_add_lines>, but the argument must be in the
1265	locale-specific encoding of the terminal and can contain command sequences	1670	locale-specific encoding of the terminal and can contain command sequences
1266	(escape codes) that will be interpreted.	1671	(escape codes) that will be interpreted.
1267		1672
1268	=item $term->tt_write ($octets)	1673	=item $term->tt_write ($octets)
1269		1674
1270	Write the octets given in C<$data> to the tty (i.e. as program input). To	1675	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1271	pass characters instead of octets, you should convert your strings first	1676	pass characters instead of octets, you should convert your strings first
1272	to the locale-specific encoding using C<< $term->locale_encode >>.	1677	to the locale-specific encoding using C<< $term->locale_encode >>.
		1678
		1679	=item $term->tt_paste ($octets)
		1680
		1681	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1682	CR and bracketing the data with control sequences if bracketed paste mode
		1683	is set.
1273		1684
1274	=item $old_events = $term->pty_ev_events ([$new_events])	1685	=item $old_events = $term->pty_ev_events ([$new_events])
1275		1686
1276	Replaces the event mask of the pty watcher by the given event mask. Can	1687	Replaces the event mask of the pty watcher by the given event mask. Can
1277	be used to suppress input and output handling to the pty/tty. See the	1688	be used to suppress input and output handling to the pty/tty. See the
1278	description of C<< urxvt::timer->events >>. Make sure to always restore	1689	description of C<< urxvt::timer->events >>. Make sure to always restore
1279	the previous value.	1690	the previous value.
1280		1691
		1692	=item $fd = $term->pty_fd
		1693
		1694	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1695	is used.
		1696
1281	=item $windowid = $term->parent	1697	=item $windowid = $term->parent
1282		1698
1283	Return the window id of the toplevel window.	1699	Return the window id of the toplevel window.
1284		1700
1285	=item $windowid = $term->vt	1701	=item $windowid = $term->vt
…		…
1291	Adds the specified events to the vt event mask. Useful e.g. when you want	1707	Adds the specified events to the vt event mask. Useful e.g. when you want
1292	to receive pointer events all the times:	1708	to receive pointer events all the times:
1293		1709
1294	$term->vt_emask_add (urxvt::PointerMotionMask);	1710	$term->vt_emask_add (urxvt::PointerMotionMask);
1295		1711
		1712	=item $term->set_urgency ($set)
		1713
		1714	Enable/disable the urgency hint on the toplevel window.
		1715
		1716	=item $term->focus_in
		1717
		1718	=item $term->focus_out
		1719
		1720	=item $term->key_press ($state, $keycode[, $time])
		1721
		1722	=item $term->key_release ($state, $keycode[, $time])
		1723
		1724	Deliver various fake events to to terminal.
		1725
1296	=item $window_width = $term->width	1726	=item $window_width = $term->width
1297		1727
1298	=item $window_height = $term->height	1728	=item $window_height = $term->height
1299		1729
1300	=item $font_width = $term->fwidth	1730	=item $font_width = $term->fwidth
…		…
1330	=item $env = $term->env	1760	=item $env = $term->env
1331		1761
1332	Returns a copy of the environment in effect for the terminal as a hashref	1762	Returns a copy of the environment in effect for the terminal as a hashref
1333	similar to C<\%ENV>.	1763	similar to C<\%ENV>.
1334		1764
		1765	=item @envv = $term->envv
		1766
		1767	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1768
		1769	=item @argv = $term->argv
		1770
		1771	Return the argument vector as this terminal, similar to @ARGV, but
		1772	includes the program name as first element.
		1773
1335	=cut	1774	=cut
1336		1775
1337	sub env {	1776	sub env {
1338	if (my $env = $_[0]->_env) {
1339	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1777	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1340	} else {
1341	+{ %ENV }
1342	}
1343	}	1778	}
1344		1779
1345	=item $modifiermask = $term->ModLevel3Mask	1780	=item $modifiermask = $term->ModLevel3Mask
1346		1781
1347	=item $modifiermask = $term->ModMetaMask	1782	=item $modifiermask = $term->ModMetaMask
1348		1783
1349	=item $modifiermask = $term->ModNumLockMask	1784	=item $modifiermask = $term->ModNumLockMask
1350		1785
1351	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1786	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1352	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1787	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1788
		1789	=item $screen = $term->current_screen
		1790
		1791	Returns the currently displayed screen (0 primary, 1 secondary).
		1792
		1793	=item $cursor_is_hidden = $term->hidden_cursor
		1794
		1795	Returns whether the cursor is currently hidden or not.
1353		1796
1354	=item $view_start = $term->view_start ([$newvalue])	1797	=item $view_start = $term->view_start ([$newvalue])
1355		1798
1356	Returns the row number of the topmost displayed line. Maximum value is	1799	Returns the row number of the topmost displayed line. Maximum value is
1357	C<0>, which displays the normal terminal contents. Lower values scroll	1800	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1365		1808
1366	Used after changing terminal contents to display them.	1809	Used after changing terminal contents to display them.
1367		1810
1368	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1811	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1369		1812
1370	Returns the text of the entire row with number C<$row_number>. Row C<0>	1813	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1371	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1814	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1372	terminal line. The scrollback buffer starts at line C<-1> and extends to
1373	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1815	terminal line. Nothing will be returned if a nonexistent line
1374	is requested.	1816	is requested.
1375		1817
1376	If C<$new_text> is specified, it will replace characters in the current	1818	If C<$new_text> is specified, it will replace characters in the current
1377	line, starting at column C<$start_col> (default C<0>), which is useful	1819	line, starting at column C<$start_col> (default C<0>), which is useful
1378	to replace only parts of a line. The font index in the rendition will	1820	to replace only parts of a line. The font index in the rendition will
1379	automatically be updated.	1821	automatically be updated.
1380		1822
1381	C<$text> is in a special encoding: tabs and wide characters that use more	1823	C<$text> is in a special encoding: tabs and wide characters that use more
1382	than one cell when displayed are padded with urxvt::NOCHAR characters	1824	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1383	(C<chr 65535>). Characters with combining characters and other characters	1825	characters. Characters with combining characters and other characters that
1384	that do not fit into the normal tetx encoding will be replaced with	1826	do not fit into the normal text encoding will be replaced with characters
1385	characters in the private use area.	1827	in the private use area.
1386		1828
1387	You have to obey this encoding when changing text. The advantage is	1829	You have to obey this encoding when changing text. The advantage is
1388	that C<substr> and similar functions work on screen cells and not on	1830	that C<substr> and similar functions work on screen cells and not on
1389	characters.	1831	characters.
1390		1832
…		…
1534	where one character corresponds to one screen cell. See	1976	where one character corresponds to one screen cell. See
1535	C<< $term->ROW_t >> for details.	1977	C<< $term->ROW_t >> for details.
1536		1978
1537	=item $string = $term->special_decode $text	1979	=item $string = $term->special_decode $text
1538		1980
1539	Converts rxvt-unicodes text reprsentation into a perl string. See	1981	Converts rxvt-unicodes text representation into a perl string. See
1540	C<< $term->ROW_t >> for details.	1982	C<< $term->ROW_t >> for details.
1541		1983
1542	=item $success = $term->grab_button ($button, $modifiermask)	1984	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1543		1985
		1986	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1987
1544	Registers a synchronous button grab. See the XGrabButton manpage.	1988	Register/unregister a synchronous button grab. See the XGrabButton
		1989	manpage.
1545		1990
1546	=item $success = $term->grab ($eventtime[, $sync])	1991	=item $success = $term->grab ($eventtime[, $sync])
1547		1992
1548	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1993	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1549	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1994	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1550		1995
1551	=item $term->allow_events_async	1996	=item $term->allow_events_async
1552		1997
1553	Calls XAllowEvents with AsyncBoth for the most recent grab.	1998	Calls XAllowEvents with AsyncBoth for the most recent grab.
1554		1999
…		…
1561	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2006	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1562	recent grab.	2007	recent grab.
1563		2008
1564	=item $term->ungrab	2009	=item $term->ungrab
1565		2010
1566	Calls XUngrab for the most recent grab. Is called automatically on	2011	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1567	evaluation errors, as it is better to lose the grab in the error case as	2012	evaluation errors, as it is better to lose the grab in the error case as
1568	the session.	2013	the session.
		2014
		2015	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		2016
		2017	=item $atom_name = $term->XGetAtomName ($atom)
		2018
		2019	=item @atoms = $term->XListProperties ($window)
		2020
		2021	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		2022
		2023	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		2024
		2025	=item $term->XDeleteProperty ($window, $property)
		2026
		2027	=item $window = $term->DefaultRootWindow
		2028
		2029	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		2030
		2031	=item $term->XMapWindow ($window)
		2032
		2033	=item $term->XUnmapWindow ($window)
		2034
		2035	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		2036
		2037	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		2038
		2039	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2040
		2041	=item $keysym = $term->XStringToKeysym ($string)
		2042
		2043	=item $string = $term->XKeysymToString ($keysym)
		2044
		2045	Various X or X-related functions. The C<$term> object only serves as
		2046	the source of the display, otherwise those functions map more-or-less
		2047	directly onto the X functions of the same name.
1569		2048
1570	=back	2049	=back
1571		2050
1572	=cut	2051	=cut
1573		2052
…		…
1637	my ($self, $text, $cb) = @_;	2116	my ($self, $text, $cb) = @_;
1638		2117
1639	$self->add_item ({ type => "button", text => $text, activate => $cb});	2118	$self->add_item ({ type => "button", text => $text, activate => $cb});
1640	}	2119	}
1641		2120
1642	=item $popup->add_toggle ($text, $cb, $initial_value)	2121	=item $popup->add_toggle ($text, $initial_value, $cb)
1643		2122
1644	Adds a toggle/checkbox item to the popup. Teh callback gets called	2123	Adds a toggle/checkbox item to the popup. The callback gets called
1645	whenever it gets toggled, with a boolean indicating its value as its first	2124	whenever it gets toggled, with a boolean indicating its new value as its
1646	argument.	2125	first argument.
1647		2126
1648	=cut	2127	=cut
1649		2128
1650	sub add_toggle {	2129	sub add_toggle {
1651	my ($self, $text, $cb, $value) = @_;	2130	my ($self, $text, $value, $cb) = @_;
1652		2131
1653	my $item; $item = {	2132	my $item; $item = {
1654	type => "button",	2133	type => "button",
1655	text => " $text",	2134	text => " $text",
1656	value => $value,	2135	value => $value,
…		…
1675	my $env = $self->{term}->env;	2154	my $env = $self->{term}->env;
1676	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2155	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1677	delete $env->{LC_ALL};	2156	delete $env->{LC_ALL};
1678	$env->{LC_CTYPE} = $self->{term}->locale;	2157	$env->{LC_CTYPE} = $self->{term}->locale;
1679		2158
1680	urxvt::term->new ($env, "popup",	2159	my $term = urxvt::term->new (
		2160	$env, "popup",
1681	"--perl-lib" => "", "--perl-ext-common" => "",	2161	"--perl-lib" => "", "--perl-ext-common" => "",
1682	"-pty-fd" => -1, "-sl" => 0,	2162	"-pty-fd" => -1, "-sl" => 0,
1683	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2163	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1684	"--transient-for" => $self->{term}->parent,	2164	"--transient-for" => $self->{term}->parent,
1685	"-display" => $self->{term}->display_id,	2165	"-display" => $self->{term}->display_id,
1686	"-pe" => "urxvt-popup")	2166	"-pe" => "urxvt-popup",
1687	or die "unable to create popup window\n";	2167	) or die "unable to create popup window\n";
		2168
		2169	unless (delete $term->{urxvt_popup_init_done}) {
		2170	$term->ungrab;
		2171	$term->destroy;
		2172	die "unable to initialise popup window\n";
		2173	}
1688	}	2174	}
1689		2175
1690	sub DESTROY {	2176	sub DESTROY {
1691	my ($self) = @_;	2177	my ($self) = @_;
1692		2178
…		…
1697	=back	2183	=back
1698		2184
1699	=cut	2185	=cut
1700		2186
1701	package urxvt::watcher;	2187	package urxvt::watcher;
1702
1703	@urxvt::timer::ISA = __PACKAGE__;
1704	@urxvt::iow::ISA = __PACKAGE__;
1705	@urxvt::pw::ISA = __PACKAGE__;
1706	@urxvt::iw::ISA = __PACKAGE__;
1707		2188
1708	=head2 The C<urxvt::timer> Class	2189	=head2 The C<urxvt::timer> Class
1709		2190
1710	This class implements timer watchers/events. Time is represented as a	2191	This class implements timer watchers/events. Time is represented as a
1711	fractional number of seconds since the epoch. Example:	2192	fractional number of seconds since the epoch. Example:
…		…
1715	->new	2196	->new
1716	->interval (1)	2197	->interval (1)
1717	->cb (sub {	2198	->cb (sub {
1718	$term->{overlay}->set (0, 0,	2199	$term->{overlay}->set (0, 0,
1719	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2200	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1720	});	2201	});
1721		2202
1722	=over 4	2203	=over 4
1723		2204
1724	=item $timer = new urxvt::timer	2205	=item $timer = new urxvt::timer
1725		2206
…		…
1728		2209
1729	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2210	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1730		2211
1731	Set the callback to be called when the timer triggers.	2212	Set the callback to be called when the timer triggers.
1732		2213
1733	=item $tstamp = $timer->at
1734
1735	Return the time this watcher will fire next.
1736
1737	=item $timer = $timer->set ($tstamp)	2214	=item $timer = $timer->set ($tstamp[, $interval])
1738		2215
1739	Set the time the event is generated to $tstamp.	2216	Set the time the event is generated to $tstamp (and optionally specifies a
		2217	new $interval).
1740		2218
1741	=item $timer = $timer->interval ($interval)	2219	=item $timer = $timer->interval ($interval)
1742		2220
1743	Normally (and when C<$interval> is C<0>), the timer will automatically	2221	By default (and when C<$interval> is C<0>), the timer will automatically
1744	stop after it has fired once. If C<$interval> is non-zero, then the timer	2222	stop after it has fired once. If C<$interval> is non-zero, then the timer
1745	is automatically rescheduled at the given intervals.	2223	is automatically rescheduled at the given intervals.
1746		2224
1747	=item $timer = $timer->start	2225	=item $timer = $timer->start
1748		2226
1749	Start the timer.	2227	Start the timer.
1750		2228
1751	=item $timer = $timer->start ($tstamp)	2229	=item $timer = $timer->start ($tstamp[, $interval])
1752		2230
1753	Set the event trigger time to C<$tstamp> and start the timer.	2231	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2232	also replaces the interval.
1754		2233
1755	=item $timer = $timer->after ($delay)	2234	=item $timer = $timer->after ($delay[, $interval])
1756		2235
1757	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2236	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1758		2237
1759	=item $timer = $timer->stop	2238	=item $timer = $timer->stop
1760		2239
…		…
1768		2247
1769	$term->{socket} = ...	2248	$term->{socket} = ...
1770	$term->{iow} = urxvt::iow	2249	$term->{iow} = urxvt::iow
1771	->new	2250	->new
1772	->fd (fileno $term->{socket})	2251	->fd (fileno $term->{socket})
1773	->events (urxvt::EVENT_READ)	2252	->events (urxvt::EV_READ)
1774	->start	2253	->start
1775	->cb (sub {	2254	->cb (sub {
1776	my ($iow, $revents) = @_;	2255	my ($iow, $revents) = @_;
1777	# $revents must be 1 here, no need to check	2256	# $revents must be 1 here, no need to check
1778	sysread $term->{socket}, my $buf, 8192	2257	sysread $term->{socket}, my $buf, 8192
…		…
1791	Set the callback to be called when io events are triggered. C<$reventmask>	2270	Set the callback to be called when io events are triggered. C<$reventmask>
1792	is a bitset as described in the C<events> method.	2271	is a bitset as described in the C<events> method.
1793		2272
1794	=item $iow = $iow->fd ($fd)	2273	=item $iow = $iow->fd ($fd)
1795		2274
1796	Set the filedescriptor (not handle) to watch.	2275	Set the file descriptor (not handle) to watch.
1797		2276
1798	=item $iow = $iow->events ($eventmask)	2277	=item $iow = $iow->events ($eventmask)
1799		2278
1800	Set the event mask to watch. The only allowed values are	2279	Set the event mask to watch. The only allowed values are
1801	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2280	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1802	together, or C<urxvt::EVENT_NONE>.	2281	together, or C<urxvt::EV_NONE>.
1803		2282
1804	=item $iow = $iow->start	2283	=item $iow = $iow->start
1805		2284
1806	Start watching for requested events on the given handle.	2285	Start watching for requested events on the given handle.
1807		2286
1808	=item $iow = $iow->stop	2287	=item $iow = $iow->stop
1809		2288
1810	Stop watching for events on the given filehandle.	2289	Stop watching for events on the given file handle.
1811		2290
1812	=back	2291	=back
1813		2292
1814	=head2 The C<urxvt::iw> Class	2293	=head2 The C<urxvt::iw> Class
1815		2294
…		…
1848	->new	2327	->new
1849	->start ($pid)	2328	->start ($pid)
1850	->cb (sub {	2329	->cb (sub {
1851	my ($pw, $exit_status) = @_;	2330	my ($pw, $exit_status) = @_;
1852	...	2331	...
1853	});	2332	});
1854		2333
1855	=over 4	2334	=over 4
1856		2335
1857	=item $pw = new urxvt::pw	2336	=item $pw = new urxvt::pw
1858		2337
…		…
1862		2341
1863	Set the callback to be called when the timer triggers.	2342	Set the callback to be called when the timer triggers.
1864		2343
1865	=item $pw = $timer->start ($pid)	2344	=item $pw = $timer->start ($pid)
1866		2345
1867	Tells the wqtcher to start watching for process C<$pid>.	2346	Tells the watcher to start watching for process C<$pid>.
1868		2347
1869	=item $pw = $pw->stop	2348	=item $pw = $pw->stop
1870		2349
1871	Stop the watcher.	2350	Stop the watcher.
1872		2351
…		…
1885		2364
1886	=item >= 3 - script loading and management	2365	=item >= 3 - script loading and management
1887		2366
1888	=item >=10 - all called hooks	2367	=item >=10 - all called hooks
1889		2368
1890	=item >=11 - hook reutrn values	2369	=item >=11 - hook return values
1891		2370
1892	=back	2371	=back
1893		2372
1894	=head1 AUTHOR	2373	=head1 AUTHOR
1895		2374
1896	Marc Lehmann <pcg@goof.com>	2375	Marc Lehmann <schmorp@schmorp.de>
1897	http://software.schmorp.de/pkg/rxvt-unicode	2376	http://software.schmorp.de/pkg/rxvt-unicode
1898		2377
1899	=cut	2378	=cut
1900		2379
1901	1	2380	1
		2381
		2382	# vim: sw=3:

Diff Legend

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