ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.111 by root, Thu Jan 19 19:52:54 2006 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 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 from the keyboard.
177	to the window position, in effect creating the same effect as pseudo transparency with	265	Simply bind a keysym to "perl:matcher" as seen in the example below.
178	a custom pixmap. No scaling is supported in this mode. Exmaple:
179		266
180	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
181		313
182	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
183		315
184	A not very useful example of filtering all text output to the terminal,	316	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	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
186	similar-looking ascii character.	318	similar-looking ascii character.
187		319
188	=item digital-clock	320	=item digital-clock
189		321
190	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
		323
		324	=item remote-clipboard
		325
		326	Somewhat of a misnomer, this extension adds two menu entries to the
		327	selection popup that allows one to run external commands to store the
		328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		343
		344	=item selection-pastebin
		345
		346	This is a little rarely useful extension that uploads the selection as
		347	textfile to a remote site (or does other things). (The implementation is
		348	not currently secure for use in a multiuser environment as it writes to
		349	F</tmp> directly.).
		350
		351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		352	i.e.
		353
		354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		355
		356	Pressing this combination runs a command with C<%> replaced by the name of
		357	the textfile. This command can be set via a resource:
		358
		359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		360
		361	And the default is likely not useful to anybody but the few people around
		362	here :)
		363
		364	The name of the textfile is the hex encoded md5 sum of the selection, so
		365	the same content should lead to the same filename.
		366
		367	After a successful upload the selection will be replaced by the text given
		368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		369	for the filename):
		370
		371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of whether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
191		391
192	=item example-refresh-hooks	392	=item example-refresh-hooks
193		393
194	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
195	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
196	overlays or changes.	396	overlays or changes.
197		397
198	=item selection-pastebin	398	=item confirm-paste
199		399
200	This is a little rarely useful extension that Uploads the selection as	400	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	401	line is detected.
202	not currently secure for use in a multiuser environment as it writes to
203	F</tmp> directly.).
204
205	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
206	i.e.
207
208	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
209
210	Pressing this combination runs a command with C<%> replaced by the name of
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		402
227	=back	403	=back
228		404
229	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
230		406
…		…
246		422
247	=over 4	423	=over 4
248		424
249	=item $text	425	=item $text
250		426
251	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	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.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
253		429
254	=item $string	430	=item $string
255		431
256	A perl text string, with an emphasis on I<text>. It can store all unicode	432	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
264		440
265	=back	441	=back
266		442
267	=head2 Extension Objects	443	=head2 Extension Objects
268		444
269	Very perl extension is a perl class. A separate perl object is created	445	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	446	for each terminal, and each terminal has its own set of extenion objects,
271	hooks. So extensions can use their C<$self> object without having to think	447	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	448	their C<$self> object without having to think about clashes with other
		449	extensions or other terminals, with the exception of methods and members
273	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
274	use.	451	internal use.
275		452
276	Although it isn't a C<urxvt::term> object, you can call all methods of the	453	Although it isn't a C<urxvt::term> object, you can call all methods of the
277	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
278		455
279	It has the following methods and data members:	456	It has the following methods and data members:
…		…
300	=head2 Hooks	477	=head2 Hooks
301		478
302	The following subroutines can be declared in extension files, and will be	479	The following subroutines can be declared in extension files, and will be
303	called whenever the relevant event happens.	480	called whenever the relevant event happens.
304		481
305	The first argument passed to them is an extension oject as described in	482	The first argument passed to them is an extension object as described in
306	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
307		484
308	B<All> of these hooks must return a boolean value. If it is true, then the	485	B<All> of these hooks must return a boolean value. If any of the called
309	event counts as being I<consumed>, and the invocation of other hooks is	486	hooks returns true, then the event counts as being I<consumed>, and the
310	skipped, and the relevant action might not be carried out by the C++ code.	487	relevant action might not be carried out by the C++ code.
311		488
312	I<< When in doubt, return a false value (preferably C<()>). >>	489	I<< When in doubt, return a false value (preferably C<()>). >>
313		490
314	=over 4	491	=over 4
315		492
316	=item on_init $term	493	=item on_init $term
317		494
318	Called after a new terminal object has been initialized, but before	495	Called after a new terminal object has been initialized, but before
319	windows are created or the command gets run. Most methods are unsafe to	496	windows are created or the command gets run. Most methods are unsafe to
320	call or deliver senseless data, as terminal size and other characteristics	497	call or deliver senseless data, as terminal size and other characteristics
321	have not yet been determined. You can safely query and change resources,	498	have not yet been determined. You can safely query and change resources
322	though.	499	and options, though. For many purposes the C<on_start> hook is a better
		500	place.
		501
		502	=item on_start $term
		503
		504	Called at the very end of initialisation of a new terminal, just before
		505	trying to map (display) the toplevel and returning to the main loop.
		506
		507	=item on_destroy $term
		508
		509	Called whenever something tries to destroy terminal, when the terminal is
		510	still fully functional (not for long, though).
323		511
324	=item on_reset $term	512	=item on_reset $term
325		513
326	Called after the screen is "reset" for any reason, such as resizing or	514	Called after the screen is "reset" for any reason, such as resizing or
327	control sequences. Here is where you can react on changes to size-related	515	control sequences. Here is where you can react on changes to size-related
328	variables.	516	variables.
329		517
330	=item on_start $term
331
332	Called at the very end of initialisation of a new terminal, just before
333	returning to the mainloop.
334
335	=item on_child_start $term, $pid	518	=item on_child_start $term, $pid
336		519
337	Called just after the child process has been C<fork>ed.	520	Called just after the child process has been C<fork>ed.
338		521
339	=item on_child_exit $term, $status	522	=item on_child_exit $term, $status
…		…
354		537
355	Called whenever a selection has been copied, but before the selection is	538	Called whenever a selection has been copied, but before the selection is
356	requested from the server. The selection text can be queried and changed	539	requested from the server. The selection text can be queried and changed
357	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
358		541
359	Returning a true value aborts selection grabbing. It will still be hilighted.	542	Returning a true value aborts selection grabbing. It will still be highlighted.
360		543
361	=item on_sel_extend $term	544	=item on_sel_extend $term
362		545
363	Called whenever the user tries to extend the selection (e.g. with a double	546	Called whenever the user tries to extend the selection (e.g. with a double
364	click) and is either supposed to return false (normal operation), or	547	click) and is either supposed to return false (normal operation), or
365	should extend the selection itelf and return true to suppress the built-in	548	should extend the selection itself and return true to suppress the built-in
366	processing. This can happen multiple times, as long as the callback	549	processing. This can happen multiple times, as long as the callback
367	returns true, it will be called on every further click by the user and is	550	returns true, it will be called on every further click by the user and is
368	supposed to enlarge the selection more and more, if possible.	551	supposed to enlarge the selection more and more, if possible.
369		552
370	See the F<selection> example extension.	553	See the F<selection> example extension.
371		554
372	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
373		556
374	Called whenever the view offset changes, i..e the user or program	557	Called whenever the view offset changes, i.e. the user or program
375	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
376	show this many lines of scrollback.	559	show this many lines of scrollback.
377		560
378	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
379		562
…		…
383		566
384	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	567	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
385	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	568	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
386	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
387		570
388	=item on_osc_seq $term, $string	571	=item on_osc_seq $term, $op, $args, $resp
		572
		573	Called on every OSC sequence and can be used to suppress it or modify its
		574	behaviour. The default should be to return an empty list. A true value
		575	suppresses execution of the request completely. Make sure you don't get
		576	confused by recursive invocations when you output an OSC sequence within
		577	this callback.
		578
		579	C<on_osc_seq_perl> should be used for new behaviour.
		580
		581	=item on_osc_seq_perl $term, $args, $resp
389		582
390	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
391	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
392	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
393	string should start with the extension name and a colon, to distinguish	586	string should start with the extension name (sans -osc) and a semicolon,
394	it from commands for other extensions, and this might be enforced in the	587	to distinguish it from commands for other extensions, and this might be
395	future.	588	enforced in the future.
		589
		590	For example, C<overlay-osc> uses this:
		591
		592	sub on_osc_seq_perl {
		593	my ($self, $osc, $resp) = @_;
		594
		595	return unless $osc =~ s/^overlay;//;
		596
		597	... process remaining $osc string
		598	}
396		599
397	Be careful not ever to trust (in a security sense) the data you receive,	600	Be careful not ever to trust (in a security sense) the data you receive,
398	as its source can not easily be controleld (e-mail content, messages from	601	as its source can not easily be controlled (e-mail content, messages from
399	other users on the same system etc.).	602	other users on the same system etc.).
		603
		604	For responses, C<$resp> contains the end-of-args separator used by the
		605	sender.
400		606
401	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
402		608
403	Called whenever text is about to be output, with the text as argument. You	609	Called whenever text is about to be output, with the text as argument. You
404	can filter/change and output the text yourself by returning a true value	610	can filter/change and output the text yourself by returning a true value
…		…
409	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
410		616
411	Called whenever some data is written to the tty/pty and can be used to	617	Called whenever some data is written to the tty/pty and can be used to
412	suppress or filter tty input.	618	suppress or filter tty input.
413		619
		620	=item on_tt_paste $term, $octets
		621
		622	Called whenever text is about to be pasted, with the text as argument. You
		623	can filter/change and paste the text yourself by returning a true value
		624	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		625	locale-encoded.
		626
414	=item on_line_update $term, $row	627	=item on_line_update $term, $row
415		628
416	Called whenever a line was updated or changed. Can be used to filter	629	Called whenever a line was updated or changed. Can be used to filter
417	screen output (e.g. underline urls or other useless stuff). Only lines	630	screen output (e.g. underline urls or other useless stuff). Only lines
418	that are being shown will be filtered, and, due to performance reasons,	631	that are being shown will be filtered, and, due to performance reasons,
…		…
425	later with the already-modified line (e.g. if unrelated parts change), so	638	later with the already-modified line (e.g. if unrelated parts change), so
426	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
427		640
428	=item on_refresh_begin $term	641	=item on_refresh_begin $term
429		642
430	Called just before the screen gets redrawn. Can be used for overlay	643	Called just before the screen gets redrawn. Can be used for overlay or
431	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
432	restoring them in refresh_end. The built-in overlay and selection display	645	restoring them in refresh_end. The built-in overlay and selection display
433	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
434		647
435	=item on_refresh_end $term	648	=item on_refresh_end $term
436		649
437	Called just after the screen gets redrawn. See C<on_refresh_begin>.	650	Called just after the screen gets redrawn. See C<on_refresh_begin>.
438		651
439	=item on_keyboard_command $term, $string	652	=item on_user_command $term, $string
440		653
441	Called whenever the user presses a key combination that has a	654	Called whenever a user-configured event is being activated (e.g. via
442	C<perl:string> action bound to it (see description of the B<keysym>	655	a C<perl:string> action bound to a key, see description of the B<keysym>
443	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
		657
		658	The event is simply the action string. This interface is assumed to change
		659	slightly in the future.
		660
		661	=item on_resize_all_windows $term, $new_width, $new_height
		662
		663	Called just after the new window size has been calculated, but before
		664	windows are actually being resized or hints are being set. If this hook
		665	returns TRUE, setting of the window hints is being skipped.
444		666
445	=item on_x_event $term, $event	667	=item on_x_event $term, $event
446		668
447	Called on every X event received on the vt window (and possibly other	669	Called on every X event received on the vt window (and possibly other
448	windows). Should only be used as a last resort. Most event structure	670	windows). Should only be used as a last resort. Most event structure
449	members are not passed.	671	members are not passed.
450		672
		673	=item on_root_event $term, $event
		674
		675	Like C<on_x_event>, but is called for events on the root window.
		676
451	=item on_focus_in $term	677	=item on_focus_in $term
452		678
453	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
454	does focus in processing.	680	does focus in processing.
455		681
456	=item on_focus_out $term	682	=item on_focus_out $term
457		683
458	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
459	focus out processing.	685	focus out processing.
460		686
461	=item on_configure_notify $term, $event	687	=item on_configure_notify $term, $event
462		688
		689	=item on_property_notify $term, $event
		690
463	=item on_key_press $term, $event, $keysym, $octets	691	=item on_key_press $term, $event, $keysym, $octets
464		692
465	=item on_key_release $term, $event, $keysym	693	=item on_key_release $term, $event, $keysym
466		694
467	=item on_button_press $term, $event	695	=item on_button_press $term, $event
…		…
472		700
473	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
474		702
475	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
476		704
477	Called whenever the corresponding X event is received for the terminal If	705	Called whenever the corresponding X event is received for the terminal. If
478	the hook returns true, then the even will be ignored by rxvt-unicode.	706	the hook returns true, then the event will be ignored by rxvt-unicode.
479		707
480	The event is a hash with most values as named by Xlib (see the XEvent	708	The event is a hash with most values as named by Xlib (see the XEvent
481	manpage), with the additional members C<row> and C<col>, which are the row	709	manpage), with the additional members C<row> and C<col>, which are the
482	and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
483		711
484	C<on_key_press> additionally receives the string rxvt-unicode would	712	C<on_key_press> additionally receives the string rxvt-unicode would
485	output, if any, in locale-specific encoding.	713	output, if any, in locale-specific encoding.
486		714
487	subwindow.	715	subwindow.
		716
		717	=item on_client_message $term, $event
		718
		719	=item on_wm_protocols $term, $event
		720
		721	=item on_wm_delete_window $term, $event
		722
		723	Called when various types of ClientMessage events are received (all with
		724	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		725
		726	=item on_bell $term
		727
		728	Called on receipt of a bell character.
488		729
489	=back	730	=back
490		731
491	=cut	732	=cut
492		733
…		…
498	use Scalar::Util ();	739	use Scalar::Util ();
499	use List::Util ();	740	use List::Util ();
500		741
501	our $VERSION = 1;	742	our $VERSION = 1;
502	our $TERM;	743	our $TERM;
		744	our @TERM_INIT;
		745	our @TERM_EXT;
503	our @HOOKNAME;	746	our @HOOKNAME;
504	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	747	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
505	our %OPTION;	748	our %OPTION;
506		749
507	our $LIBDIR;	750	our $LIBDIR;
508	our $RESNAME;	751	our $RESNAME;
509	our $RESCLASS;	752	our $RESCLASS;
510	our $RXVTNAME;	753	our $RXVTNAME;
511		754
		755	our $NOCHAR = chr 0xffff;
		756
512	=head2 Variables in the C<urxvt> Package	757	=head2 Variables in the C<urxvt> Package
513		758
514	=over 4	759	=over 4
515		760
516	=item $urxvt::LIBDIR	761	=item $urxvt::LIBDIR
…		…
528		773
529	=item $urxvt::TERM	774	=item $urxvt::TERM
530		775
531	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
532	object, whenever a callback/hook is executing.	777	object, whenever a callback/hook is executing.
		778
		779	=item @urxvt::TERM_INIT
		780
		781	All code references in this array will be called as methods of the next newly
		782	created C<urxvt::term> object (during the C<on_init> phase). The array
		783	gets cleared before the code references that were in it are being executed,
		784	so references can push themselves onto it again if they so desire.
		785
		786	This complements to the perl-eval command line option, but gets executed
		787	first.
		788
		789	=item @urxvt::TERM_EXT
		790
		791	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		792	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		793	but before other extensions. Gets cleared just like C<@TERM_INIT>.
533		794
534	=back	795	=back
535		796
536	=head2 Functions in the C<urxvt> Package	797	=head2 Functions in the C<urxvt> Package
537		798
…		…
551		812
552	Using this function has the advantage that its output ends up in the	813	Using this function has the advantage that its output ends up in the
553	correct place, e.g. on stderr of the connecting urxvtc client.	814	correct place, e.g. on stderr of the connecting urxvtc client.
554		815
555	Messages have a size limit of 1023 bytes currently.	816	Messages have a size limit of 1023 bytes currently.
		817
		818	=item @terms = urxvt::termlist
		819
		820	Returns all urxvt::term objects that exist in this process, regardless of
		821	whether they are started, being destroyed etc., so be careful. Only term
		822	objects that have perl extensions attached will be returned (because there
		823	is no urxvt::term objet associated with others).
556		824
557	=item $time = urxvt::NOW	825	=item $time = urxvt::NOW
558		826
559	Returns the "current time" (as per the event loop).	827	Returns the "current time" (as per the event loop).
560		828
…		…
603		871
604	=item $rend = urxvt::OVERLAY_RSTYLE	872	=item $rend = urxvt::OVERLAY_RSTYLE
605		873
606	Return the rendition mask used for overlays by default.	874	Return the rendition mask used for overlays by default.
607		875
608	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	876	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		877	urxvt::RS_RVid, urxvt::RS_Uline
609		878
610	Return the bit that enabled bold, italic, blink, reverse-video and	879	Return the bit that enabled bold, italic, blink, reverse-video and
611	underline, respectively. To enable such a style, just logically OR it into	880	underline, respectively. To enable such a style, just logically OR it into
612	the bitset.	881	the bitset.
613		882
…		…
618	Return the foreground/background colour index, respectively.	887	Return the foreground/background colour index, respectively.
619		888
620	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	889	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
621		890
622	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	891	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		892
		893	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
623		894
624	Replace the foreground/background colour in the rendition mask with the	895	Replace the foreground/background colour in the rendition mask with the
625	specified one.	896	specified one.
626		897
627	=item $value = urxvt::GET_CUSTOM $rend	898	=item $value = urxvt::GET_CUSTOM $rend
…		…
646	unless $msg =~ /\n$/;	917	unless $msg =~ /\n$/;
647	urxvt::warn ($msg);	918	urxvt::warn ($msg);
648	};	919	};
649	}	920	}
650		921
		922	no warnings 'utf8';
		923
651	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	924	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
652		925
653	sub verbose {	926	sub verbose {
654	my ($level, $msg) = @_;	927	my ($level, $msg) = @_;
655	warn "$msg\n" if $level <= $verbosity;	928	warn "$msg\n" if $level <= $verbosity;
…		…
658	my %extension_pkg;	931	my %extension_pkg;
659		932
660	# load a single script into its own package, once only	933	# load a single script into its own package, once only
661	sub extension_package($) {	934	sub extension_package($) {
662	my ($path) = @_;	935	my ($path) = @_;
663
664	no strict 'refs';
665		936
666	$extension_pkg{$path} ||= do {	937	$extension_pkg{$path} ||= do {
667	$path =~ /([^\/\\]+)$/;	938	$path =~ /([^\/\\]+)$/;
668	my $pkg = $1;	939	my $pkg = $1;
669	$pkg =~ s/[^[:word:]]/_/g;	940	$pkg =~ s/[^[:word:]]/_/g;
…		…
672	verbose 3, "loading extension '$path' into package '$pkg'";	943	verbose 3, "loading extension '$path' into package '$pkg'";
673		944
674	open my $fh, "<:raw", $path	945	open my $fh, "<:raw", $path
675	or die "$path: $!";	946	or die "$path: $!";
676		947
677	@{"$pkg\::ISA"} = urxvt::term::extension::;
678
679	my $source =	948	my $source =
680	"package $pkg; use strict; use utf8;\n"	949	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
681	. "#line 1 \"$path\"\n{\n"	950	. "#line 1 \"$path\"\n{\n"
682	. (do { local $/; <$fh> })	951	. (do { local $/; <$fh> })
683	. "\n};\n1";	952	. "\n};\n1";
684		953
685	eval $source	954	eval $source
…		…
696	local $TERM = shift;	965	local $TERM = shift;
697	my $htype = shift;	966	my $htype = shift;
698		967
699	if ($htype == 0) { # INIT	968	if ($htype == 0) { # INIT
700	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	969	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
701		970
702	my %ext_arg;	971	my %ext_arg;
703		972
		973	{
		974	my @init = @TERM_INIT;
		975	@TERM_INIT = ();
		976	$_->($TERM) for @init;
		977	my @pkg = @TERM_EXT;
		978	@TERM_EXT = ();
		979	$TERM->register_package ($_) for @pkg;
		980	}
		981
704	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	982	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
705	if ($_ eq "default") {	983	if ($_ eq "default") {
706	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	984	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
707	} elsif (/^-(.*)$/) {	985	} elsif (/^-(.*)$/) {
708	delete $ext_arg{$1};	986	delete $ext_arg{$1};
709	} elsif (/^([^<]+)<(.*)>$/) {	987	} elsif (/^([^<]+)<(.*)>$/) {
710	push @{ $ext_arg{$1} }, $2;	988	push @{ $ext_arg{$1} }, $2;
711	} else {	989	} else {
712	$ext_arg{$_} ||= [];	990	$ext_arg{$_} ||= [];
713	}	991	}
714	}	992	}
715		993
716	while (my ($ext, $argv) = each %ext_arg) {	994	for my $ext (sort keys %ext_arg) {
717	my @files = grep -f $_, map "$_/$ext", @dirs;	995	my @files = grep -f $_, map "$_/$ext", @dirs;
718		996
719	if (@files) {	997	if (@files) {
720	$TERM->register_package (extension_package $files[0], $argv);	998	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
721	} else {	999	} else {
722	warn "perl extension '$ext' not found in perl library search path\n";	1000	warn "perl extension '$ext' not found in perl library search path\n";
723	}	1001	}
724	}	1002	}
725		1003
…		…
731		1009
732	if (my $cb = $TERM->{_hook}[$htype]) {	1010	if (my $cb = $TERM->{_hook}[$htype]) {
733	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1011	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
734	if $verbosity >= 10;	1012	if $verbosity >= 10;
735		1013
736	keys %$cb;	1014	for my $pkg (keys %$cb) {
737
738	while (my ($pkg, $cb) = each %$cb) {
739	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1015	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
740	and last;	1016	$retval ||= $retval_;
741		1017
742	if ($@) {	1018	if ($@) {
743	$TERM->ungrab; # better to lose the grab than the session	1019	$TERM->ungrab; # better to lose the grab than the session
744	warn $@;	1020	warn $@;
745	}	1021	}
…		…
756	# clear package	1032	# clear package
757	%$TERM = ();	1033	%$TERM = ();
758	}	1034	}
759		1035
760	$retval	1036	$retval
		1037	}
		1038
		1039	sub SET_COLOR($$$) {
		1040	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1041	}
		1042
		1043	sub rend2mask {
		1044	no strict 'refs';
		1045	my ($str, $mask) = (@_, 0);
		1046	my %color = ( fg => undef, bg => undef );
		1047	my @failed;
		1048	for my $spec ( split /\s+/, $str ) {
		1049	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1050	$color{lc($1)} = $2;
		1051	} else {
		1052	my $neg = $spec =~ s/^[-^]//;
		1053	unless ( exists &{"RS_$spec"} ) {
		1054	push @failed, $spec;
		1055	next;
		1056	}
		1057	my $cur = &{"RS_$spec"};
		1058	if ( $neg ) {
		1059	$mask &= ~$cur;
		1060	} else {
		1061	$mask |= $cur;
		1062	}
		1063	}
		1064	}
		1065	($mask, @color{qw(fg bg)}, \@failed)
761	}	1066	}
762		1067
763	# urxvt::term::extension	1068	# urxvt::term::extension
764		1069
765	package urxvt::term::extension;	1070	package urxvt::term::extension;
…		…
836	is that you cannot use blocking APIs, but the non-blocking variant should	1141	is that you cannot use blocking APIs, but the non-blocking variant should
837	work.	1142	work.
838		1143
839	=cut	1144	=cut
840		1145
841	our $VERSION = 1;	1146	our $VERSION = '5.23';
842		1147
843	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1148	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
844	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1149	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
845		1150
846	sub timer {	1151	sub timer {
…		…
848		1153
849	my $cb = $arg{cb};	1154	my $cb = $arg{cb};
850		1155
851	urxvt::timer	1156	urxvt::timer
852	->new	1157	->new
853	->start (urxvt::NOW + $arg{after})	1158	->after ($arg{after}, $arg{interval})
854	->cb (sub {	1159	->cb ($arg{interval} ? $cb : sub {
855	$_[0]->stop; # need to cancel manually	1160	$_[0]->stop; # need to cancel manually
856	$cb->();	1161	$cb->();
857	})	1162	})
858	}	1163	}
859		1164
860	sub io {	1165	sub io {
861	my ($class, %arg) = @_;	1166	my ($class, %arg) = @_;
862		1167
863	my $cb = $arg{cb};	1168	my $cb = $arg{cb};
		1169	my $fd = fileno $arg{fh};
		1170	defined $fd or $fd = $arg{fh};
864		1171
865	bless [$arg{fh}, urxvt::iow	1172	bless [$arg{fh}, urxvt::iow
866	->new	1173	->new
867	->fd (fileno $arg{fh})	1174	->fd ($fd)
868	->events (($arg{poll} =~ /r/ ? 1 : 0)	1175	->events (($arg{poll} =~ /r/ ? 1 : 0)
869	| ($arg{poll} =~ /w/ ? 2 : 0))	1176	| ($arg{poll} =~ /w/ ? 2 : 0))
870	->start	1177	->start
871	->cb (sub {	1178	->cb ($cb)
872	$cb->(($_[1] & 1 ? 'r' : '')
873	. ($_[1] & 2 ? 'w' : ''));
874	})],
875	urxvt::anyevent::	1179	], urxvt::anyevent::
		1180	}
		1181
		1182	sub idle {
		1183	my ($class, %arg) = @_;
		1184
		1185	my $cb = $arg{cb};
		1186
		1187	urxvt::iw
		1188	->new
		1189	->start
		1190	->cb ($cb)
		1191	}
		1192
		1193	sub child {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::pw
		1199	->new
		1200	->start ($arg{pid})
		1201	->cb (sub {
		1202	$_[0]->stop; # need to cancel manually
		1203	$cb->($_[0]->rpid, $_[0]->rstatus);
		1204	})
876	}	1205	}
877		1206
878	sub DESTROY {	1207	sub DESTROY {
879	$_[0][1]->stop;	1208	$_[0][1]->stop;
880	}	1209	}
881		1210
882	sub condvar {	1211	sub one_event {
883	bless \my $flag, urxvt::anyevent::condvar::
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";	1212	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
893	}
894	}	1213	}
895		1214
896	package urxvt::term;	1215	package urxvt::term;
897		1216
898	=head2 The C<urxvt::term> Class	1217	=head2 The C<urxvt::term> Class
…		…
903		1222
904	# find on_xxx subs in the package and register them	1223	# find on_xxx subs in the package and register them
905	# as hooks	1224	# as hooks
906	sub register_package {	1225	sub register_package {
907	my ($self, $pkg, $argv) = @_;	1226	my ($self, $pkg, $argv) = @_;
		1227
		1228	no strict 'refs';
		1229
		1230	urxvt::verbose 6, "register package $pkg to $self";
		1231
		1232	@{"$pkg\::ISA"} = urxvt::term::extension::;
908		1233
909	my $proxy = bless {	1234	my $proxy = bless {
910	_pkg => $pkg,	1235	_pkg => $pkg,
911	argv => $argv,	1236	argv => $argv,
912	}, $pkg;	1237	}, $pkg;
…		…
928	hash which defines the environment of the new terminal.	1253	hash which defines the environment of the new terminal.
929		1254
930	Croaks (and probably outputs an error message) if the new instance	1255	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	1256	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	1257	initialise perl, and the terminal object otherwise. The C<init> and
933	C<start> hooks will be called during this call.	1258	C<start> hooks will be called before this call returns, and are free to
		1259	refer to global data (which is race free).
934		1260
935	=cut	1261	=cut
936		1262
937	sub new {	1263	sub new {
938	my ($class, $env, @args) = @_;	1264	my ($class, $env, @args) = @_;
939		1265
		1266	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1267	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1268
940	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1269	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
941	}	1270	}
942		1271
943	=item $term->destroy	1272	=item $term->destroy
944		1273
945	Destroy the terminal object (close the window, free resources	1274	Destroy the terminal object (close the window, free resources
…		…
975		1304
976	Returns true if the option specified by C<$optval> is enabled, and	1305	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	1306	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.	1307	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
979		1308
980	Here is a a likely non-exhaustive list of option names, please see the	1309	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:	1310	source file F</src/optinc.h> to see the actual list:
982		1311
983	borderLess console cursorBlink cursorUnderline hold iconic insecure	1312	borderLess console cursorBlink cursorUnderline hold iconic insecure
984	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1313	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
985	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1314	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1002	likely change).	1331	likely change).
1003		1332
1004	Please note that resource strings will currently only be freed when the	1333	Please note that resource strings will currently only be freed when the
1005	terminal is destroyed, so changing options frequently will eat memory.	1334	terminal is destroyed, so changing options frequently will eat memory.
1006		1335
1007	Here is a a likely non-exhaustive list of resource names, not all of which	1336	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>	1337	are supported in every build, please see the source file F</src/rsinc.h>
1009	to see the actual list:	1338	to see the actual list:
1010		1339
1011	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1340	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1012	borderLess color cursorBlink cursorUnderline cutchars delete_key	1341	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1013	display_name embed ext_bwidth fade font geometry hold iconName	1342	display_name embed ext_bwidth fade font geometry hold iconName
1014	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1343	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1015	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1344	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1016	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1345	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1017	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1346	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1018	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1347	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1019	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1348	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1020	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1349	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1021	secondaryScreen secondaryScroll selectstyle shade term_name title	1350	secondaryScreen secondaryScroll shade term_name title
1022	transient_for transparent transparent_all tripleclickwords utmpInhibit	1351	transient_for transparent transparent_all tripleclickwords utmpInhibit
1023	visualBell	1352	visualBell
1024		1353
1025	=cut	1354	=cut
1026		1355
1027	sub resource($$;$) {	1356	sub resource($$;$) {
1028	my ($self, $name) = (shift, shift);	1357	my ($self, $name) = (shift, shift);
1029	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1358	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1030	&urxvt::term::_resource	1359	goto &urxvt::term::_resource
1031	}	1360	}
1032		1361
1033	=item $value = $term->x_resource ($pattern)	1362	=item $value = $term->x_resource ($pattern)
1034		1363
1035	Returns the X-Resource for the given pattern, excluding the program or	1364	Returns the X-Resource for the given pattern, excluding the program or
…		…
1060		1389
1061	=item ($row, $col) = $term->selection_beg ([$row, $col])	1390	=item ($row, $col) = $term->selection_beg ([$row, $col])
1062		1391
1063	=item ($row, $col) = $term->selection_end ([$row, $col])	1392	=item ($row, $col) = $term->selection_end ([$row, $col])
1064		1393
1065	Return the current values of the selection mark, begin or end positions,	1394	Return the current values of the selection mark, begin or end positions.
1066	and optionally set them to new values.	1395
		1396	When arguments are given, then the selection coordinates are set to
		1397	C<$row> and C<$col>, and the selection screen is set to the current
		1398	screen.
		1399
		1400	=item $screen = $term->selection_screen ([$screen])
		1401
		1402	Returns the current selection screen, and then optionally sets it.
1067		1403
1068	=item $term->selection_make ($eventtime[, $rectangular])	1404	=item $term->selection_make ($eventtime[, $rectangular])
1069		1405
1070	Tries to make a selection as set by C<selection_beg> and	1406	Tries to make a selection as set by C<selection_beg> and
1071	C<selection_end>. If C<$rectangular> is true (default: false), a	1407	C<selection_end>. If C<$rectangular> is true (default: false), a
1072	rectangular selection will be made. This is the prefered function to make	1408	rectangular selection will be made. This is the preferred function to make
1073	a selection.	1409	a selection.
1074		1410
1075	=item $success = $term->selection_grab ($eventtime)	1411	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1076		1412
1077	Try to request the primary selection text from the server (for example, as	1413	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1414	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	1415	with the next method. No visual feedback will be given. This function
1079	is mostly useful from within C<on_sel_grab> hooks.	1416	is mostly useful from within C<on_sel_grab> hooks.
1080		1417
1081	=item $oldtext = $term->selection ([$newtext])	1418	=item $oldtext = $term->selection ([$newtext, $clipboard])
1082		1419
1083	Return the current selection text and optionally replace it by C<$newtext>.	1420	Return the current selection (clipboard if C<$clipboard> is true) text
		1421	and optionally replace it by C<$newtext>.
		1422
		1423	=item $term->selection_clear ([$clipboard])
		1424
		1425	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1084		1426
1085	=item $term->overlay_simple ($x, $y, $text)	1427	=item $term->overlay_simple ($x, $y, $text)
1086		1428
1087	Create a simple multi-line overlay box. See the next method for details.	1429	Create a simple multi-line overlay box. See the next method for details.
1088		1430
…		…
1118		1460
1119	The methods currently supported on C<urxvt::overlay> objects are:	1461	The methods currently supported on C<urxvt::overlay> objects are:
1120		1462
1121	=over 4	1463	=over 4
1122		1464
1123	=item $overlay->set ($x, $y, $text, $rend)	1465	=item $overlay->set ($x, $y, $text[, $rend])
1124		1466
1125	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1467	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	1468	text in rxvt-unicode's special encoding and an array of rendition values
1127	at a specific position inside the overlay.	1469	at a specific position inside the overlay.
		1470
		1471	If C<$rend> is missing, then the rendition will not be changed.
1128		1472
1129	=item $overlay->hide	1473	=item $overlay->hide
1130		1474
1131	If visible, hide the overlay, but do not destroy it.	1475	If visible, hide the overlay, but do not destroy it.
1132		1476
…		…
1202		1546
1203	Normally its not a good idea to use this function, as programs might be	1547	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	1548	confused by changes in cursor position or scrolling. Its useful inside a
1205	C<on_add_lines> hook, though.	1549	C<on_add_lines> hook, though.
1206		1550
		1551	=item $term->scr_change_screen ($screen)
		1552
		1553	Switch to given screen - 0 primary, 1 secondary.
		1554
1207	=item $term->cmd_parse ($octets)	1555	=item $term->cmd_parse ($octets)
1208		1556
1209	Similar to C<scr_add_lines>, but the argument must be in the	1557	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	1558	locale-specific encoding of the terminal and can contain command sequences
1211	(escape codes) that will be interpreted.	1559	(escape codes) that will be interpreted.
1212		1560
1213	=item $term->tt_write ($octets)	1561	=item $term->tt_write ($octets)
1214		1562
1215	Write the octets given in C<$data> to the tty (i.e. as program input). To	1563	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	1564	pass characters instead of octets, you should convert your strings first
1217	to the locale-specific encoding using C<< $term->locale_encode >>.	1565	to the locale-specific encoding using C<< $term->locale_encode >>.
		1566
		1567	=item $term->tt_paste ($octets)
		1568
		1569	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1570	CR and bracketing the data with control sequences if bracketed paste mode
		1571	is set.
1218		1572
1219	=item $old_events = $term->pty_ev_events ([$new_events])	1573	=item $old_events = $term->pty_ev_events ([$new_events])
1220		1574
1221	Replaces the event mask of the pty watcher by the given event mask. Can	1575	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	1576	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	1577	description of C<< urxvt::timer->events >>. Make sure to always restore
1224	the previous value.	1578	the previous value.
1225		1579
		1580	=item $fd = $term->pty_fd
		1581
		1582	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1583	is used.
		1584
1226	=item $windowid = $term->parent	1585	=item $windowid = $term->parent
1227		1586
1228	Return the window id of the toplevel window.	1587	Return the window id of the toplevel window.
1229		1588
1230	=item $windowid = $term->vt	1589	=item $windowid = $term->vt
…		…
1236	Adds the specified events to the vt event mask. Useful e.g. when you want	1595	Adds the specified events to the vt event mask. Useful e.g. when you want
1237	to receive pointer events all the times:	1596	to receive pointer events all the times:
1238		1597
1239	$term->vt_emask_add (urxvt::PointerMotionMask);	1598	$term->vt_emask_add (urxvt::PointerMotionMask);
1240		1599
		1600	=item $term->focus_in
		1601
		1602	=item $term->focus_out
		1603
		1604	=item $term->key_press ($state, $keycode[, $time])
		1605
		1606	=item $term->key_release ($state, $keycode[, $time])
		1607
		1608	Deliver various fake events to to terminal.
		1609
1241	=item $window_width = $term->width	1610	=item $window_width = $term->width
1242		1611
1243	=item $window_height = $term->height	1612	=item $window_height = $term->height
1244		1613
1245	=item $font_width = $term->fwidth	1614	=item $font_width = $term->fwidth
…		…
1275	=item $env = $term->env	1644	=item $env = $term->env
1276		1645
1277	Returns a copy of the environment in effect for the terminal as a hashref	1646	Returns a copy of the environment in effect for the terminal as a hashref
1278	similar to C<\%ENV>.	1647	similar to C<\%ENV>.
1279		1648
		1649	=item @envv = $term->envv
		1650
		1651	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1652
		1653	=item @argv = $term->argv
		1654
		1655	Return the argument vector as this terminal, similar to @ARGV, but
		1656	includes the program name as first element.
		1657
1280	=cut	1658	=cut
1281		1659
1282	sub env {	1660	sub env {
1283	if (my $env = $_[0]->_env) {
1284	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1661	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1285	} else {
1286	+{ %ENV }
1287	}
1288	}	1662	}
1289		1663
1290	=item $modifiermask = $term->ModLevel3Mask	1664	=item $modifiermask = $term->ModLevel3Mask
1291		1665
1292	=item $modifiermask = $term->ModMetaMask	1666	=item $modifiermask = $term->ModMetaMask
1293		1667
1294	=item $modifiermask = $term->ModNumLockMask	1668	=item $modifiermask = $term->ModNumLockMask
1295		1669
1296	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1670	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.	1671	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1672
		1673	=item $screen = $term->current_screen
		1674
		1675	Returns the currently displayed screen (0 primary, 1 secondary).
		1676
		1677	=item $cursor_is_hidden = $term->hidden_cursor
		1678
		1679	Returns whether the cursor is currently hidden or not.
1298		1680
1299	=item $view_start = $term->view_start ([$newvalue])	1681	=item $view_start = $term->view_start ([$newvalue])
1300		1682
1301	Returns the row number of the topmost displayed line. Maximum value is	1683	Returns the row number of the topmost displayed line. Maximum value is
1302	C<0>, which displays the normal terminal contents. Lower values scroll	1684	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1310		1692
1311	Used after changing terminal contents to display them.	1693	Used after changing terminal contents to display them.
1312		1694
1313	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1695	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1314		1696
1315	Returns the text of the entire row with number C<$row_number>. Row C<0>	1697	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	1698	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	1699	terminal line. Nothing will be returned if a nonexistent line
1319	is requested.	1700	is requested.
1320		1701
1321	If C<$new_text> is specified, it will replace characters in the current	1702	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	1703	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	1704	to replace only parts of a line. The font index in the rendition will
1324	automatically be updated.	1705	automatically be updated.
1325		1706
1326	C<$text> is in a special encoding: tabs and wide characters that use more	1707	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	1708	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1328	(C<chr 65535>). Characters with combining characters and other characters	1709	characters. Characters with combining characters and other characters that
1329	that do not fit into the normal tetx encoding will be replaced with	1710	do not fit into the normal text encoding will be replaced with characters
1330	characters in the private use area.	1711	in the private use area.
1331		1712
1332	You have to obey this encoding when changing text. The advantage is	1713	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	1714	that C<substr> and similar functions work on screen cells and not on
1334	characters.	1715	characters.
1335		1716
…		…
1479	where one character corresponds to one screen cell. See	1860	where one character corresponds to one screen cell. See
1480	C<< $term->ROW_t >> for details.	1861	C<< $term->ROW_t >> for details.
1481		1862
1482	=item $string = $term->special_decode $text	1863	=item $string = $term->special_decode $text
1483		1864
1484	Converts rxvt-unicodes text reprsentation into a perl string. See	1865	Converts rxvt-unicodes text representation into a perl string. See
1485	C<< $term->ROW_t >> for details.	1866	C<< $term->ROW_t >> for details.
1486		1867
1487	=item $success = $term->grab_button ($button, $modifiermask)	1868	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1488		1869
		1870	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1871
1489	Registers a synchronous button grab. See the XGrabButton manpage.	1872	Register/unregister a synchronous button grab. See the XGrabButton
		1873	manpage.
1490		1874
1491	=item $success = $term->grab ($eventtime[, $sync])	1875	=item $success = $term->grab ($eventtime[, $sync])
1492		1876
1493	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1877	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1494	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1878	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1495		1879
1496	=item $term->allow_events_async	1880	=item $term->allow_events_async
1497		1881
1498	Calls XAllowEvents with AsyncBoth for the most recent grab.	1882	Calls XAllowEvents with AsyncBoth for the most recent grab.
1499		1883
…		…
1506	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1890	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1507	recent grab.	1891	recent grab.
1508		1892
1509	=item $term->ungrab	1893	=item $term->ungrab
1510		1894
1511	Calls XUngrab for the most recent grab. Is called automatically on	1895	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	1896	evaluation errors, as it is better to lose the grab in the error case as
1513	the session.	1897	the session.
		1898
		1899	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1900
		1901	=item $atom_name = $term->XGetAtomName ($atom)
		1902
		1903	=item @atoms = $term->XListProperties ($window)
		1904
		1905	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1906
		1907	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1908
		1909	=item $term->XDeleteProperty ($window, $property)
		1910
		1911	=item $window = $term->DefaultRootWindow
		1912
		1913	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1914
		1915	=item $term->XMapWindow ($window)
		1916
		1917	=item $term->XUnmapWindow ($window)
		1918
		1919	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1920
		1921	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1922
		1923	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1924
		1925	Various X or X-related functions. The C<$term> object only serves as
		1926	the source of the display, otherwise those functions map more-or-less
		1927	directly onto the X functions of the same name.
1514		1928
1515	=back	1929	=back
1516		1930
1517	=cut	1931	=cut
1518		1932
…		…
1582	my ($self, $text, $cb) = @_;	1996	my ($self, $text, $cb) = @_;
1583		1997
1584	$self->add_item ({ type => "button", text => $text, activate => $cb});	1998	$self->add_item ({ type => "button", text => $text, activate => $cb});
1585	}	1999	}
1586		2000
1587	=item $popup->add_toggle ($text, $cb, $initial_value)	2001	=item $popup->add_toggle ($text, $initial_value, $cb)
1588		2002
1589	Adds a toggle/checkbox item to the popup. Teh callback gets called	2003	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	2004	whenever it gets toggled, with a boolean indicating its new value as its
1591	argument.	2005	first argument.
1592		2006
1593	=cut	2007	=cut
1594		2008
1595	sub add_toggle {	2009	sub add_toggle {
1596	my ($self, $text, $cb, $value) = @_;	2010	my ($self, $text, $value, $cb) = @_;
1597		2011
1598	my $item; $item = {	2012	my $item; $item = {
1599	type => "button",	2013	type => "button",
1600	text => " $text",	2014	text => " $text",
1601	value => $value,	2015	value => $value,
…		…
1620	my $env = $self->{term}->env;	2034	my $env = $self->{term}->env;
1621	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2035	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1622	delete $env->{LC_ALL};	2036	delete $env->{LC_ALL};
1623	$env->{LC_CTYPE} = $self->{term}->locale;	2037	$env->{LC_CTYPE} = $self->{term}->locale;
1624		2038
1625	urxvt::term->new ($env, "popup",	2039	my $term = urxvt::term->new (
		2040	$env, "popup",
1626	"--perl-lib" => "", "--perl-ext-common" => "",	2041	"--perl-lib" => "", "--perl-ext-common" => "",
1627	"-pty-fd" => -1, "-sl" => 0,	2042	"-pty-fd" => -1, "-sl" => 0,
1628	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2043	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1629	"--transient-for" => $self->{term}->parent,	2044	"--transient-for" => $self->{term}->parent,
1630	"-display" => $self->{term}->display_id,	2045	"-display" => $self->{term}->display_id,
1631	"-pe" => "urxvt-popup")	2046	"-pe" => "urxvt-popup",
1632	or die "unable to create popup window\n";	2047	) or die "unable to create popup window\n";
		2048
		2049	unless (delete $term->{urxvt_popup_init_done}) {
		2050	$term->ungrab;
		2051	$term->destroy;
		2052	die "unable to initialise popup window\n";
		2053	}
1633	}	2054	}
1634		2055
1635	sub DESTROY {	2056	sub DESTROY {
1636	my ($self) = @_;	2057	my ($self) = @_;
1637		2058
1638	delete $self->{term}{_destroy}{$self};	2059	delete $self->{term}{_destroy}{$self};
1639	$self->{term}->ungrab;	2060	$self->{term}->ungrab;
1640	}	2061	}
1641		2062
1642	=back	2063	=back
		2064
		2065	=cut
		2066
		2067	package urxvt::watcher;
1643		2068
1644	=head2 The C<urxvt::timer> Class	2069	=head2 The C<urxvt::timer> Class
1645		2070
1646	This class implements timer watchers/events. Time is represented as a	2071	This class implements timer watchers/events. Time is represented as a
1647	fractional number of seconds since the epoch. Example:	2072	fractional number of seconds since the epoch. Example:
…		…
1651	->new	2076	->new
1652	->interval (1)	2077	->interval (1)
1653	->cb (sub {	2078	->cb (sub {
1654	$term->{overlay}->set (0, 0,	2079	$term->{overlay}->set (0, 0,
1655	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2080	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1656	});	2081	});
1657		2082
1658	=over 4	2083	=over 4
1659		2084
1660	=item $timer = new urxvt::timer	2085	=item $timer = new urxvt::timer
1661		2086
…		…
1664		2089
1665	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2090	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1666		2091
1667	Set the callback to be called when the timer triggers.	2092	Set the callback to be called when the timer triggers.
1668		2093
1669	=item $tstamp = $timer->at
1670
1671	Return the time this watcher will fire next.
1672
1673	=item $timer = $timer->set ($tstamp)	2094	=item $timer = $timer->set ($tstamp[, $interval])
1674		2095
1675	Set the time the event is generated to $tstamp.	2096	Set the time the event is generated to $tstamp (and optionally specifies a
		2097	new $interval).
1676		2098
1677	=item $timer = $timer->interval ($interval)	2099	=item $timer = $timer->interval ($interval)
1678		2100
1679	Normally (and when C<$interval> is C<0>), the timer will automatically	2101	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	2102	stop after it has fired once. If C<$interval> is non-zero, then the timer
1681	is automatically rescheduled at the given intervals.	2103	is automatically rescheduled at the given intervals.
1682		2104
1683	=item $timer = $timer->start	2105	=item $timer = $timer->start
1684		2106
1685	Start the timer.	2107	Start the timer.
1686		2108
1687	=item $timer = $timer->start ($tstamp)	2109	=item $timer = $timer->start ($tstamp[, $interval])
1688		2110
1689	Set the event trigger time to C<$tstamp> and start the timer.	2111	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2112	also replaces the interval.
1690		2113
1691	=item $timer = $timer->after ($delay)	2114	=item $timer = $timer->after ($delay[, $interval])
1692		2115
1693	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2116	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1694		2117
1695	=item $timer = $timer->stop	2118	=item $timer = $timer->stop
1696		2119
…		…
1704		2127
1705	$term->{socket} = ...	2128	$term->{socket} = ...
1706	$term->{iow} = urxvt::iow	2129	$term->{iow} = urxvt::iow
1707	->new	2130	->new
1708	->fd (fileno $term->{socket})	2131	->fd (fileno $term->{socket})
1709	->events (urxvt::EVENT_READ)	2132	->events (urxvt::EV_READ)
1710	->start	2133	->start
1711	->cb (sub {	2134	->cb (sub {
1712	my ($iow, $revents) = @_;	2135	my ($iow, $revents) = @_;
1713	# $revents must be 1 here, no need to check	2136	# $revents must be 1 here, no need to check
1714	sysread $term->{socket}, my $buf, 8192	2137	sysread $term->{socket}, my $buf, 8192
…		…
1727	Set the callback to be called when io events are triggered. C<$reventmask>	2150	Set the callback to be called when io events are triggered. C<$reventmask>
1728	is a bitset as described in the C<events> method.	2151	is a bitset as described in the C<events> method.
1729		2152
1730	=item $iow = $iow->fd ($fd)	2153	=item $iow = $iow->fd ($fd)
1731		2154
1732	Set the filedescriptor (not handle) to watch.	2155	Set the file descriptor (not handle) to watch.
1733		2156
1734	=item $iow = $iow->events ($eventmask)	2157	=item $iow = $iow->events ($eventmask)
1735		2158
1736	Set the event mask to watch. The only allowed values are	2159	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	2160	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1738	together, or C<urxvt::EVENT_NONE>.	2161	together, or C<urxvt::EV_NONE>.
1739		2162
1740	=item $iow = $iow->start	2163	=item $iow = $iow->start
1741		2164
1742	Start watching for requested events on the given handle.	2165	Start watching for requested events on the given handle.
1743		2166
1744	=item $iow = $iow->stop	2167	=item $iow = $iow->stop
1745		2168
1746	Stop watching for events on the given filehandle.	2169	Stop watching for events on the given file handle.
		2170
		2171	=back
		2172
		2173	=head2 The C<urxvt::iw> Class
		2174
		2175	This class implements idle watchers, that get called automatically when
		2176	the process is idle. They should return as fast as possible, after doing
		2177	some useful work.
		2178
		2179	=over 4
		2180
		2181	=item $iw = new urxvt::iw
		2182
		2183	Create a new idle watcher object in stopped state.
		2184
		2185	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2186
		2187	Set the callback to be called when the watcher triggers.
		2188
		2189	=item $timer = $timer->start
		2190
		2191	Start the watcher.
		2192
		2193	=item $timer = $timer->stop
		2194
		2195	Stop the watcher.
		2196
		2197	=back
		2198
		2199	=head2 The C<urxvt::pw> Class
		2200
		2201	This class implements process watchers. They create an event whenever a
		2202	process exits, after which they stop automatically.
		2203
		2204	my $pid = fork;
		2205	...
		2206	$term->{pw} = urxvt::pw
		2207	->new
		2208	->start ($pid)
		2209	->cb (sub {
		2210	my ($pw, $exit_status) = @_;
		2211	...
		2212	});
		2213
		2214	=over 4
		2215
		2216	=item $pw = new urxvt::pw
		2217
		2218	Create a new process watcher in stopped state.
		2219
		2220	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2221
		2222	Set the callback to be called when the timer triggers.
		2223
		2224	=item $pw = $timer->start ($pid)
		2225
		2226	Tells the watcher to start watching for process C<$pid>.
		2227
		2228	=item $pw = $pw->stop
		2229
		2230	Stop the watcher.
1747		2231
1748	=back	2232	=back
1749		2233
1750	=head1 ENVIRONMENT	2234	=head1 ENVIRONMENT
1751		2235
…		…
1760		2244
1761	=item >= 3 - script loading and management	2245	=item >= 3 - script loading and management
1762		2246
1763	=item >=10 - all called hooks	2247	=item >=10 - all called hooks
1764		2248
1765	=item >=11 - hook reutrn values	2249	=item >=11 - hook return values
1766		2250
1767	=back	2251	=back
1768		2252
1769	=head1 AUTHOR	2253	=head1 AUTHOR
1770		2254
…		…
1772	http://software.schmorp.de/pkg/rxvt-unicode	2256	http://software.schmorp.de/pkg/rxvt-unicode
1773		2257
1774	=cut	2258	=cut
1775		2259
1776	1	2260	1
		2261
		2262	# vim: sw=3:

Diff Legend

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