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.110 by root, Thu Jan 19 16:22:13 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
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
58	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
59	...	66	...
60		67
61	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
64	between two vertical bars:	71	between two vertical bars:
65		72
66	URxvt.selection.pattern-0: \\|([^|]+)\\|	73	URxvt.selection.pattern-0: \\|([^|]+)\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
67		81
68	You can look at the source of the selection extension to see more	82	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
70		84
71	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
83	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
84		98
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.	100	runtime.
87		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
88	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
89		120
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
93		124
94	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
95	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
96	popup is displayed.	127	popup is being displayed.
97		128
98	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
99	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.
100	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
101	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
102	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
103		134
104	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
105	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
106	C<a>s:	137	C<a>s:
107		138
108	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
109	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
110	: ()	141	: ()
111	};	142	};
112		143
113	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
114		145
…		…
121	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>
122	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
123	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
124	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
125	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
126	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.
127		189
128	=item selection-autotransform	190	=item selection-autotransform
129		191
130	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
131	whenever a selection is made.	193	whenever a selection is made.
…		…
158		220
159	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
160	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
161	the message into vi commands to load the file.	223	the message into vi commands to load the file.
162		224
163	=item mark-urls	225	=item tabbed
164		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
165	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
166	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
167	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
168	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.
169		258
170	=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.
171		263
172	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.
173	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.
174	a custom pixmap. No scaling is supported in this mode. Exmaple:
175		266
176	@@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.
177		313
178	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
179		315
180	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
181	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
182	similar-looking ascii character.	318	similar-looking ascii character.
183		319
184	=item digital-clock	320	=item digital-clock
185		321
186	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.
187		391
188	=item example-refresh-hooks	392	=item example-refresh-hooks
189		393
190	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
191	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
192	overlays or changes.	396	overlays or changes.
193		397
194	=item selection-pastebin	398	=item confirm-paste
195		399
196	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
197	textfile to a remote site (or does other things). (The implementation is	401	line is detected.
198	not currently secure for use in a multiuser environment as it writes to
199	F</tmp> directly.).
200
201	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
202	i.e.
203
204	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
205
206	Pressing this combination runs a command with C<%> replaced by the name of
207	the textfile. This command can be set via a resource:
208
209	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
210
211	And the default is likely not useful to anybody but the few people around
212	here :)
213
214	The name of the textfile is the hex encoded md5 sum of the selection, so
215	the same content should lead to the same filename.
216
217	After a successful upload the selection will be replaced by the text given
218	in the C<selection-pastebin-url> resource (again, the % is the placeholder
219	for the filename):
220
221	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
222		402
223	=back	403	=back
224		404
225	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
226		406
…		…
242		422
243	=over 4	423	=over 4
244		424
245	=item $text	425	=item $text
246		426
247	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
248	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.
249		429
250	=item $string	430	=item $string
251		431
252	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
…		…
260		440
261	=back	441	=back
262		442
263	=head2 Extension Objects	443	=head2 Extension Objects
264		444
265	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
266	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,
267	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
268	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
269	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
270	use.	451	internal use.
271		452
272	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
273	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
274		455
275	It has the following methods and data members:	456	It has the following methods and data members:
…		…
296	=head2 Hooks	477	=head2 Hooks
297		478
298	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
299	called whenever the relevant event happens.	480	called whenever the relevant event happens.
300		481
301	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
302	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
303		484
304	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
305	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
306	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.
307		488
308	I<< When in doubt, return a false value (preferably C<()>). >>	489	I<< When in doubt, return a false value (preferably C<()>). >>
309		490
310	=over 4	491	=over 4
311		492
312	=item on_init $term	493	=item on_init $term
313		494
314	Called after a new terminal object has been initialized, but before	495	Called after a new terminal object has been initialized, but before
315	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
316	call or deliver senseless data, as terminal size and other characteristics	497	call or deliver senseless data, as terminal size and other characteristics
317	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
318	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).
319		511
320	=item on_reset $term	512	=item on_reset $term
321		513
322	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
323	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
324	variables.	516	variables.
325		517
326	=item on_start $term
327
328	Called at the very end of initialisation of a new terminal, just before
329	returning to the mainloop.
330
331	=item on_child_start $term, $pid	518	=item on_child_start $term, $pid
332		519
333	Called just after the child process has been C<fork>ed.	520	Called just after the child process has been C<fork>ed.
334		521
335	=item on_child_exit $term, $status	522	=item on_child_exit $term, $status
…		…
350		537
351	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
352	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
353	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
354		541
355	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.
356		543
357	=item on_sel_extend $term	544	=item on_sel_extend $term
358		545
359	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
360	click) and is either supposed to return false (normal operation), or	547	click) and is either supposed to return false (normal operation), or
361	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
362	processing. This can happen multiple times, as long as the callback	549	processing. This can happen multiple times, as long as the callback
363	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
364	supposed to enlarge the selection more and more, if possible.	551	supposed to enlarge the selection more and more, if possible.
365		552
366	See the F<selection> example extension.	553	See the F<selection> example extension.
367		554
368	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
369		556
370	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
371	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
372	show this many lines of scrollback.	559	show this many lines of scrollback.
373		560
374	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
375		562
…		…
379		566
380	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,
381	$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
382	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
383		570
384	=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
385		582
386	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
387	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
388	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
389	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,
390	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
391	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	}
392		599
393	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,
394	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
395	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.
396		606
397	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
398		608
399	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
400	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
…		…
405	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
406		616
407	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
408	suppress or filter tty input.	618	suppress or filter tty input.
409		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
410	=item on_line_update $term, $row	627	=item on_line_update $term, $row
411		628
412	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
413	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
414	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,
…		…
421	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
422	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
423		640
424	=item on_refresh_begin $term	641	=item on_refresh_begin $term
425		642
426	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
427	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
428	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
429	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
430		647
431	=item on_refresh_end $term	648	=item on_refresh_end $term
432		649
433	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>.
434		651
435	=item on_keyboard_command $term, $string	652	=item on_user_command $term, $string
436		653
437	Called whenever the user presses a key combination that has a	654	Called whenever a user-configured event is being activated (e.g. via
438	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>
439	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.
440		666
441	=item on_x_event $term, $event	667	=item on_x_event $term, $event
442		668
443	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
444	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
445	members are not passed.	671	members are not passed.
446		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
447	=item on_focus_in $term	677	=item on_focus_in $term
448		678
449	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
450	does focus in processing.	680	does focus in processing.
451		681
452	=item on_focus_out $term	682	=item on_focus_out $term
453		683
454	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
455	focus out processing.	685	focus out processing.
456		686
457	=item on_configure_notify $term, $event	687	=item on_configure_notify $term, $event
458		688
		689	=item on_property_notify $term, $event
		690
459	=item on_key_press $term, $event, $keysym, $octets	691	=item on_key_press $term, $event, $keysym, $octets
460		692
461	=item on_key_release $term, $event, $keysym	693	=item on_key_release $term, $event, $keysym
462		694
463	=item on_button_press $term, $event	695	=item on_button_press $term, $event
…		…
468		700
469	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
470		702
471	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
472		704
473	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
474	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.
475		707
476	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
477	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
478	and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
479		711
480	C<on_key_press> additionally receives the string rxvt-unicode would	712	C<on_key_press> additionally receives the string rxvt-unicode would
481	output, if any, in locale-specific encoding.	713	output, if any, in locale-specific encoding.
482		714
483	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.
484		729
485	=back	730	=back
486		731
487	=cut	732	=cut
488		733
…		…
494	use Scalar::Util ();	739	use Scalar::Util ();
495	use List::Util ();	740	use List::Util ();
496		741
497	our $VERSION = 1;	742	our $VERSION = 1;
498	our $TERM;	743	our $TERM;
		744	our @TERM_INIT;
		745	our @TERM_EXT;
499	our @HOOKNAME;	746	our @HOOKNAME;
500	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	747	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
501	our %OPTION;	748	our %OPTION;
502		749
503	our $LIBDIR;	750	our $LIBDIR;
504	our $RESNAME;	751	our $RESNAME;
505	our $RESCLASS;	752	our $RESCLASS;
506	our $RXVTNAME;	753	our $RXVTNAME;
507		754
		755	our $NOCHAR = chr 0xffff;
		756
508	=head2 Variables in the C<urxvt> Package	757	=head2 Variables in the C<urxvt> Package
509		758
510	=over 4	759	=over 4
511		760
512	=item $urxvt::LIBDIR	761	=item $urxvt::LIBDIR
…		…
524		773
525	=item $urxvt::TERM	774	=item $urxvt::TERM
526		775
527	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
528	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>.
529		794
530	=back	795	=back
531		796
532	=head2 Functions in the C<urxvt> Package	797	=head2 Functions in the C<urxvt> Package
533		798
…		…
547		812
548	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
549	correct place, e.g. on stderr of the connecting urxvtc client.	814	correct place, e.g. on stderr of the connecting urxvtc client.
550		815
551	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).
552		824
553	=item $time = urxvt::NOW	825	=item $time = urxvt::NOW
554		826
555	Returns the "current time" (as per the event loop).	827	Returns the "current time" (as per the event loop).
556		828
…		…
599		871
600	=item $rend = urxvt::OVERLAY_RSTYLE	872	=item $rend = urxvt::OVERLAY_RSTYLE
601		873
602	Return the rendition mask used for overlays by default.	874	Return the rendition mask used for overlays by default.
603		875
604	=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
605		878
606	Return the bit that enabled bold, italic, blink, reverse-video and	879	Return the bit that enabled bold, italic, blink, reverse-video and
607	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
608	the bitset.	881	the bitset.
609		882
…		…
614	Return the foreground/background colour index, respectively.	887	Return the foreground/background colour index, respectively.
615		888
616	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	889	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
617		890
618	=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
619		894
620	Replace the foreground/background colour in the rendition mask with the	895	Replace the foreground/background colour in the rendition mask with the
621	specified one.	896	specified one.
622		897
623	=item $value = urxvt::GET_CUSTOM $rend	898	=item $value = urxvt::GET_CUSTOM $rend
…		…
642	unless $msg =~ /\n$/;	917	unless $msg =~ /\n$/;
643	urxvt::warn ($msg);	918	urxvt::warn ($msg);
644	};	919	};
645	}	920	}
646		921
		922	no warnings 'utf8';
		923
647	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	924	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
648		925
649	sub verbose {	926	sub verbose {
650	my ($level, $msg) = @_;	927	my ($level, $msg) = @_;
651	warn "$msg\n" if $level <= $verbosity;	928	warn "$msg\n" if $level <= $verbosity;
…		…
654	my %extension_pkg;	931	my %extension_pkg;
655		932
656	# load a single script into its own package, once only	933	# load a single script into its own package, once only
657	sub extension_package($) {	934	sub extension_package($) {
658	my ($path) = @_;	935	my ($path) = @_;
659
660	no strict 'refs';
661		936
662	$extension_pkg{$path} ||= do {	937	$extension_pkg{$path} ||= do {
663	$path =~ /([^\/\\]+)$/;	938	$path =~ /([^\/\\]+)$/;
664	my $pkg = $1;	939	my $pkg = $1;
665	$pkg =~ s/[^[:word:]]/_/g;	940	$pkg =~ s/[^[:word:]]/_/g;
…		…
668	verbose 3, "loading extension '$path' into package '$pkg'";	943	verbose 3, "loading extension '$path' into package '$pkg'";
669		944
670	open my $fh, "<:raw", $path	945	open my $fh, "<:raw", $path
671	or die "$path: $!";	946	or die "$path: $!";
672		947
673	@{"$pkg\::ISA"} = urxvt::term::extension::;
674
675	my $source =	948	my $source =
676	"package $pkg; use strict; use utf8;\n"	949	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
677	. "#line 1 \"$path\"\n{\n"	950	. "#line 1 \"$path\"\n{\n"
678	. (do { local $/; <$fh> })	951	. (do { local $/; <$fh> })
679	. "\n};\n1";	952	. "\n};\n1";
680		953
681	eval $source	954	eval $source
…		…
692	local $TERM = shift;	965	local $TERM = shift;
693	my $htype = shift;	966	my $htype = shift;
694		967
695	if ($htype == 0) { # INIT	968	if ($htype == 0) { # INIT
696	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	969	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
697		970
698	my %ext_arg;	971	my %ext_arg;
699		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
700	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	982	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
701	if ($_ eq "default") {	983	if ($_ eq "default") {
702	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	984	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
703	} elsif (/^-(.*)$/) {	985	} elsif (/^-(.*)$/) {
704	delete $ext_arg{$1};	986	delete $ext_arg{$1};
705	} elsif (/^([^<]+)<(.*)>$/) {	987	} elsif (/^([^<]+)<(.*)>$/) {
706	push @{ $ext_arg{$1} }, $2;	988	push @{ $ext_arg{$1} }, $2;
707	} else {	989	} else {
708	$ext_arg{$_} ||= [];	990	$ext_arg{$_} ||= [];
709	}	991	}
710	}	992	}
711		993
712	while (my ($ext, $argv) = each %ext_arg) {	994	for my $ext (sort keys %ext_arg) {
713	my @files = grep -f $_, map "$_/$ext", @dirs;	995	my @files = grep -f $_, map "$_/$ext", @dirs;
714		996
715	if (@files) {	997	if (@files) {
716	$TERM->register_package (extension_package $files[0], $argv);	998	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
717	} else {	999	} else {
718	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";
719	}	1001	}
720	}	1002	}
721		1003
…		…
727		1009
728	if (my $cb = $TERM->{_hook}[$htype]) {	1010	if (my $cb = $TERM->{_hook}[$htype]) {
729	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1011	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
730	if $verbosity >= 10;	1012	if $verbosity >= 10;
731		1013
732	keys %$cb;	1014	for my $pkg (keys %$cb) {
733
734	while (my ($pkg, $cb) = each %$cb) {
735	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1015	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
736	and last;	1016	$retval ||= $retval_;
737		1017
738	if ($@) {	1018	if ($@) {
739	$TERM->ungrab; # better to lose the grab than the session	1019	$TERM->ungrab; # better to lose the grab than the session
740	warn $@;	1020	warn $@;
741	}	1021	}
…		…
752	# clear package	1032	# clear package
753	%$TERM = ();	1033	%$TERM = ();
754	}	1034	}
755		1035
756	$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)
757	}	1066	}
758		1067
759	# urxvt::term::extension	1068	# urxvt::term::extension
760		1069
761	package urxvt::term::extension;	1070	package urxvt::term::extension;
…		…
832	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
833	work.	1142	work.
834		1143
835	=cut	1144	=cut
836		1145
837	our $VERSION = 1;	1146	our $VERSION = '5.23';
838		1147
839	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1148	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
840	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1149	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
841		1150
842	sub timer {	1151	sub timer {
…		…
844		1153
845	my $cb = $arg{cb};	1154	my $cb = $arg{cb};
846		1155
847	urxvt::timer	1156	urxvt::timer
848	->new	1157	->new
849	->start (urxvt::NOW + $arg{after})	1158	->after ($arg{after}, $arg{interval})
850	->cb (sub {	1159	->cb ($arg{interval} ? $cb : sub {
851	$_[0]->stop; # need to cancel manually	1160	$_[0]->stop; # need to cancel manually
852	$cb->();	1161	$cb->();
853	})	1162	})
854	}	1163	}
855		1164
856	sub io {	1165	sub io {
857	my ($class, %arg) = @_;	1166	my ($class, %arg) = @_;
858		1167
859	my $cb = $arg{cb};	1168	my $cb = $arg{cb};
		1169	my $fd = fileno $arg{fh};
		1170	defined $fd or $fd = $arg{fh};
860		1171
861	bless [$arg{fh}, urxvt::iow	1172	bless [$arg{fh}, urxvt::iow
862	->new	1173	->new
863	->fd (fileno $arg{fh})	1174	->fd ($fd)
864	->events (($arg{poll} =~ /r/ ? 1 : 0)	1175	->events (($arg{poll} =~ /r/ ? 1 : 0)
865	| ($arg{poll} =~ /w/ ? 2 : 0))	1176	| ($arg{poll} =~ /w/ ? 2 : 0))
866	->start	1177	->start
867	->cb (sub {	1178	->cb ($cb)
868	$cb->(($_[1] & 1 ? 'r' : '')
869	. ($_[1] & 2 ? 'w' : ''));
870	})],
871	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	})
872	}	1205	}
873		1206
874	sub DESTROY {	1207	sub DESTROY {
875	$_[0][1]->stop;	1208	$_[0][1]->stop;
876	}	1209	}
877		1210
878	sub condvar {	1211	sub one_event {
879	bless \my $flag, urxvt::anyevent::condvar::
880	}
881
882	sub urxvt::anyevent::condvar::broadcast {
883	${$_[0]}++;
884	}
885
886	sub urxvt::anyevent::condvar::wait {
887	unless (${$_[0]}) {
888	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";
889	}
890	}	1213	}
891		1214
892	package urxvt::term;	1215	package urxvt::term;
893		1216
894	=head2 The C<urxvt::term> Class	1217	=head2 The C<urxvt::term> Class
…		…
899		1222
900	# find on_xxx subs in the package and register them	1223	# find on_xxx subs in the package and register them
901	# as hooks	1224	# as hooks
902	sub register_package {	1225	sub register_package {
903	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::;
904		1233
905	my $proxy = bless {	1234	my $proxy = bless {
906	_pkg => $pkg,	1235	_pkg => $pkg,
907	argv => $argv,	1236	argv => $argv,
908	}, $pkg;	1237	}, $pkg;
…		…
924	hash which defines the environment of the new terminal.	1253	hash which defines the environment of the new terminal.
925		1254
926	Croaks (and probably outputs an error message) if the new instance	1255	Croaks (and probably outputs an error message) if the new instance
927	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
928	initialise perl, and the terminal object otherwise. The C<init> and	1257	initialise perl, and the terminal object otherwise. The C<init> and
929	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).
930		1260
931	=cut	1261	=cut
932		1262
933	sub new {	1263	sub new {
934	my ($class, $env, @args) = @_;	1264	my ($class, $env, @args) = @_;
935		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
936	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1269	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
937	}	1270	}
938		1271
939	=item $term->destroy	1272	=item $term->destroy
940		1273
941	Destroy the terminal object (close the window, free resources	1274	Destroy the terminal object (close the window, free resources
…		…
971		1304
972	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
973	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
974	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.
975		1308
976	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
977	source file F</src/optinc.h> to see the actual list:	1310	source file F</src/optinc.h> to see the actual list:
978		1311
979	borderLess console cursorBlink cursorUnderline hold iconic insecure	1312	borderLess console cursorBlink cursorUnderline hold iconic insecure
980	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1313	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
981	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1314	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
998	likely change).	1331	likely change).
999		1332
1000	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
1001	terminal is destroyed, so changing options frequently will eat memory.	1334	terminal is destroyed, so changing options frequently will eat memory.
1002		1335
1003	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
1004	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>
1005	to see the actual list:	1338	to see the actual list:
1006		1339
1007	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1340	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1008	borderLess color cursorBlink cursorUnderline cutchars delete_key	1341	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1009	display_name embed ext_bwidth fade font geometry hold iconName	1342	display_name embed ext_bwidth fade font geometry hold iconName
1010	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1343	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1011	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1344	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1012	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1345	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1013	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1346	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1014	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1347	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1015	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1348	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1016	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1349	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1017	secondaryScreen secondaryScroll selectstyle shade term_name title	1350	secondaryScreen secondaryScroll shade term_name title
1018	transient_for transparent transparent_all tripleclickwords utmpInhibit	1351	transient_for transparent transparent_all tripleclickwords utmpInhibit
1019	visualBell	1352	visualBell
1020		1353
1021	=cut	1354	=cut
1022		1355
1023	sub resource($$;$) {	1356	sub resource($$;$) {
1024	my ($self, $name) = (shift, shift);	1357	my ($self, $name) = (shift, shift);
1025	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1358	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1026	&urxvt::term::_resource	1359	goto &urxvt::term::_resource
1027	}	1360	}
1028		1361
1029	=item $value = $term->x_resource ($pattern)	1362	=item $value = $term->x_resource ($pattern)
1030		1363
1031	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
…		…
1056		1389
1057	=item ($row, $col) = $term->selection_beg ([$row, $col])	1390	=item ($row, $col) = $term->selection_beg ([$row, $col])
1058		1391
1059	=item ($row, $col) = $term->selection_end ([$row, $col])	1392	=item ($row, $col) = $term->selection_end ([$row, $col])
1060		1393
1061	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.
1062	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.
1063		1403
1064	=item $term->selection_make ($eventtime[, $rectangular])	1404	=item $term->selection_make ($eventtime[, $rectangular])
1065		1405
1066	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
1067	C<selection_end>. If C<$rectangular> is true (default: false), a	1407	C<selection_end>. If C<$rectangular> is true (default: false), a
1068	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
1069	a selection.	1409	a selection.
1070		1410
1071	=item $success = $term->selection_grab ($eventtime)	1411	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1072		1412
1073	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
1074	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
1075	is mostly useful from within C<on_sel_grab> hooks.	1416	is mostly useful from within C<on_sel_grab> hooks.
1076		1417
1077	=item $oldtext = $term->selection ([$newtext])	1418	=item $oldtext = $term->selection ([$newtext, $clipboard])
1078		1419
1079	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.
1080		1426
1081	=item $term->overlay_simple ($x, $y, $text)	1427	=item $term->overlay_simple ($x, $y, $text)
1082		1428
1083	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.
1084		1430
…		…
1114		1460
1115	The methods currently supported on C<urxvt::overlay> objects are:	1461	The methods currently supported on C<urxvt::overlay> objects are:
1116		1462
1117	=over 4	1463	=over 4
1118		1464
1119	=item $overlay->set ($x, $y, $text, $rend)	1465	=item $overlay->set ($x, $y, $text[, $rend])
1120		1466
1121	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
1122	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
1123	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.
1124		1472
1125	=item $overlay->hide	1473	=item $overlay->hide
1126		1474
1127	If visible, hide the overlay, but do not destroy it.	1475	If visible, hide the overlay, but do not destroy it.
1128		1476
…		…
1198		1546
1199	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
1200	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
1201	C<on_add_lines> hook, though.	1549	C<on_add_lines> hook, though.
1202		1550
		1551	=item $term->scr_change_screen ($screen)
		1552
		1553	Switch to given screen - 0 primary, 1 secondary.
		1554
1203	=item $term->cmd_parse ($octets)	1555	=item $term->cmd_parse ($octets)
1204		1556
1205	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
1206	locale-specific encoding of the terminal and can contain command sequences	1558	locale-specific encoding of the terminal and can contain command sequences
1207	(escape codes) that will be interpreted.	1559	(escape codes) that will be interpreted.
1208		1560
1209	=item $term->tt_write ($octets)	1561	=item $term->tt_write ($octets)
1210		1562
1211	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
1212	pass characters instead of octets, you should convert your strings first	1564	pass characters instead of octets, you should convert your strings first
1213	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.
1214		1572
1215	=item $old_events = $term->pty_ev_events ([$new_events])	1573	=item $old_events = $term->pty_ev_events ([$new_events])
1216		1574
1217	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
1218	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
1219	description of C<< urxvt::timer->events >>. Make sure to always restore	1577	description of C<< urxvt::timer->events >>. Make sure to always restore
1220	the previous value.	1578	the previous value.
1221		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
1222	=item $windowid = $term->parent	1585	=item $windowid = $term->parent
1223		1586
1224	Return the window id of the toplevel window.	1587	Return the window id of the toplevel window.
1225		1588
1226	=item $windowid = $term->vt	1589	=item $windowid = $term->vt
…		…
1232	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
1233	to receive pointer events all the times:	1596	to receive pointer events all the times:
1234		1597
1235	$term->vt_emask_add (urxvt::PointerMotionMask);	1598	$term->vt_emask_add (urxvt::PointerMotionMask);
1236		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
1237	=item $window_width = $term->width	1610	=item $window_width = $term->width
1238		1611
1239	=item $window_height = $term->height	1612	=item $window_height = $term->height
1240		1613
1241	=item $font_width = $term->fwidth	1614	=item $font_width = $term->fwidth
…		…
1271	=item $env = $term->env	1644	=item $env = $term->env
1272		1645
1273	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
1274	similar to C<\%ENV>.	1647	similar to C<\%ENV>.
1275		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
1276	=cut	1658	=cut
1277		1659
1278	sub env {	1660	sub env {
1279	if (my $env = $_[0]->_env) {
1280	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1661	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1281	} else {
1282	+{ %ENV }
1283	}
1284	}	1662	}
1285		1663
1286	=item $modifiermask = $term->ModLevel3Mask	1664	=item $modifiermask = $term->ModLevel3Mask
1287		1665
1288	=item $modifiermask = $term->ModMetaMask	1666	=item $modifiermask = $term->ModMetaMask
1289		1667
1290	=item $modifiermask = $term->ModNumLockMask	1668	=item $modifiermask = $term->ModNumLockMask
1291		1669
1292	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
1293	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.
1294		1680
1295	=item $view_start = $term->view_start ([$newvalue])	1681	=item $view_start = $term->view_start ([$newvalue])
1296		1682
1297	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
1298	C<0>, which displays the normal terminal contents. Lower values scroll	1684	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1306		1692
1307	Used after changing terminal contents to display them.	1693	Used after changing terminal contents to display them.
1308		1694
1309	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1695	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1310		1696
1311	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 >>
1312	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
1313	terminal line. The scrollback buffer starts at line C<-1> and extends to
1314	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1699	terminal line. Nothing will be returned if a nonexistent line
1315	is requested.	1700	is requested.
1316		1701
1317	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
1318	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
1319	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
1320	automatically be updated.	1705	automatically be updated.
1321		1706
1322	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
1323	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)
1324	(C<chr 65535>). Characters with combining characters and other characters	1709	characters. Characters with combining characters and other characters that
1325	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
1326	characters in the private use area.	1711	in the private use area.
1327		1712
1328	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
1329	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
1330	characters.	1715	characters.
1331		1716
…		…
1475	where one character corresponds to one screen cell. See	1860	where one character corresponds to one screen cell. See
1476	C<< $term->ROW_t >> for details.	1861	C<< $term->ROW_t >> for details.
1477		1862
1478	=item $string = $term->special_decode $text	1863	=item $string = $term->special_decode $text
1479		1864
1480	Converts rxvt-unicodes text reprsentation into a perl string. See	1865	Converts rxvt-unicodes text representation into a perl string. See
1481	C<< $term->ROW_t >> for details.	1866	C<< $term->ROW_t >> for details.
1482		1867
1483	=item $success = $term->grab_button ($button, $modifiermask)	1868	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1484		1869
		1870	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1871
1485	Registers a synchronous button grab. See the XGrabButton manpage.	1872	Register/unregister a synchronous button grab. See the XGrabButton
		1873	manpage.
1486		1874
1487	=item $success = $term->grab ($eventtime[, $sync])	1875	=item $success = $term->grab ($eventtime[, $sync])
1488		1876
1489	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1877	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1490	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1878	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1491		1879
1492	=item $term->allow_events_async	1880	=item $term->allow_events_async
1493		1881
1494	Calls XAllowEvents with AsyncBoth for the most recent grab.	1882	Calls XAllowEvents with AsyncBoth for the most recent grab.
1495		1883
…		…
1502	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1890	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1503	recent grab.	1891	recent grab.
1504		1892
1505	=item $term->ungrab	1893	=item $term->ungrab
1506		1894
1507	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
1508	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
1509	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.
1510		1928
1511	=back	1929	=back
1512		1930
1513	=cut	1931	=cut
1514		1932
…		…
1578	my ($self, $text, $cb) = @_;	1996	my ($self, $text, $cb) = @_;
1579		1997
1580	$self->add_item ({ type => "button", text => $text, activate => $cb});	1998	$self->add_item ({ type => "button", text => $text, activate => $cb});
1581	}	1999	}
1582		2000
1583	=item $popup->add_toggle ($text, $cb, $initial_value)	2001	=item $popup->add_toggle ($text, $initial_value, $cb)
1584		2002
1585	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
1586	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
1587	argument.	2005	first argument.
1588		2006
1589	=cut	2007	=cut
1590		2008
1591	sub add_toggle {	2009	sub add_toggle {
1592	my ($self, $text, $cb, $value) = @_;	2010	my ($self, $text, $value, $cb) = @_;
1593		2011
1594	my $item; $item = {	2012	my $item; $item = {
1595	type => "button",	2013	type => "button",
1596	text => " $text",	2014	text => " $text",
1597	value => $value,	2015	value => $value,
…		…
1616	my $env = $self->{term}->env;	2034	my $env = $self->{term}->env;
1617	# 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.
1618	delete $env->{LC_ALL};	2036	delete $env->{LC_ALL};
1619	$env->{LC_CTYPE} = $self->{term}->locale;	2037	$env->{LC_CTYPE} = $self->{term}->locale;
1620		2038
1621	urxvt::term->new ($env, "popup",	2039	my $term = urxvt::term->new (
		2040	$env, "popup",
1622	"--perl-lib" => "", "--perl-ext-common" => "",	2041	"--perl-lib" => "", "--perl-ext-common" => "",
1623	"-pty-fd" => -1, "-sl" => 0,	2042	"-pty-fd" => -1, "-sl" => 0,
1624	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2043	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1625	"--transient-for" => $self->{term}->parent,	2044	"--transient-for" => $self->{term}->parent,
1626	"-display" => $self->{term}->display_id,	2045	"-display" => $self->{term}->display_id,
1627	"-pe" => "urxvt-popup")	2046	"-pe" => "urxvt-popup",
1628	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	}
1629	}	2054	}
1630		2055
1631	sub DESTROY {	2056	sub DESTROY {
1632	my ($self) = @_;	2057	my ($self) = @_;
1633		2058
1634	delete $self->{term}{_destroy}{$self};	2059	delete $self->{term}{_destroy}{$self};
1635	$self->{term}->ungrab;	2060	$self->{term}->ungrab;
1636	}	2061	}
1637		2062
1638	=back	2063	=back
		2064
		2065	=cut
		2066
		2067	package urxvt::watcher;
1639		2068
1640	=head2 The C<urxvt::timer> Class	2069	=head2 The C<urxvt::timer> Class
1641		2070
1642	This class implements timer watchers/events. Time is represented as a	2071	This class implements timer watchers/events. Time is represented as a
1643	fractional number of seconds since the epoch. Example:	2072	fractional number of seconds since the epoch. Example:
…		…
1647	->new	2076	->new
1648	->interval (1)	2077	->interval (1)
1649	->cb (sub {	2078	->cb (sub {
1650	$term->{overlay}->set (0, 0,	2079	$term->{overlay}->set (0, 0,
1651	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2080	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1652	});	2081	});
1653		2082
1654	=over 4	2083	=over 4
1655		2084
1656	=item $timer = new urxvt::timer	2085	=item $timer = new urxvt::timer
1657		2086
…		…
1660		2089
1661	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2090	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1662		2091
1663	Set the callback to be called when the timer triggers.	2092	Set the callback to be called when the timer triggers.
1664		2093
1665	=item $tstamp = $timer->at
1666
1667	Return the time this watcher will fire next.
1668
1669	=item $timer = $timer->set ($tstamp)	2094	=item $timer = $timer->set ($tstamp[, $interval])
1670		2095
1671	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).
1672		2098
1673	=item $timer = $timer->interval ($interval)	2099	=item $timer = $timer->interval ($interval)
1674		2100
1675	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
1676	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
1677	is automatically rescheduled at the given intervals.	2103	is automatically rescheduled at the given intervals.
1678		2104
1679	=item $timer = $timer->start	2105	=item $timer = $timer->start
1680		2106
1681	Start the timer.	2107	Start the timer.
1682		2108
1683	=item $timer = $timer->start ($tstamp)	2109	=item $timer = $timer->start ($tstamp[, $interval])
1684		2110
1685	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.
1686		2113
1687	=item $timer = $timer->after ($delay)	2114	=item $timer = $timer->after ($delay[, $interval])
1688		2115
1689	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>.
1690		2117
1691	=item $timer = $timer->stop	2118	=item $timer = $timer->stop
1692		2119
…		…
1700		2127
1701	$term->{socket} = ...	2128	$term->{socket} = ...
1702	$term->{iow} = urxvt::iow	2129	$term->{iow} = urxvt::iow
1703	->new	2130	->new
1704	->fd (fileno $term->{socket})	2131	->fd (fileno $term->{socket})
1705	->events (urxvt::EVENT_READ)	2132	->events (urxvt::EV_READ)
1706	->start	2133	->start
1707	->cb (sub {	2134	->cb (sub {
1708	my ($iow, $revents) = @_;	2135	my ($iow, $revents) = @_;
1709	# $revents must be 1 here, no need to check	2136	# $revents must be 1 here, no need to check
1710	sysread $term->{socket}, my $buf, 8192	2137	sysread $term->{socket}, my $buf, 8192
…		…
1723	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>
1724	is a bitset as described in the C<events> method.	2151	is a bitset as described in the C<events> method.
1725		2152
1726	=item $iow = $iow->fd ($fd)	2153	=item $iow = $iow->fd ($fd)
1727		2154
1728	Set the filedescriptor (not handle) to watch.	2155	Set the file descriptor (not handle) to watch.
1729		2156
1730	=item $iow = $iow->events ($eventmask)	2157	=item $iow = $iow->events ($eventmask)
1731		2158
1732	Set the event mask to watch. The only allowed values are	2159	Set the event mask to watch. The only allowed values are
1733	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
1734	together, or C<urxvt::EVENT_NONE>.	2161	together, or C<urxvt::EV_NONE>.
1735		2162
1736	=item $iow = $iow->start	2163	=item $iow = $iow->start
1737		2164
1738	Start watching for requested events on the given handle.	2165	Start watching for requested events on the given handle.
1739		2166
1740	=item $iow = $iow->stop	2167	=item $iow = $iow->stop
1741		2168
1742	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.
1743		2231
1744	=back	2232	=back
1745		2233
1746	=head1 ENVIRONMENT	2234	=head1 ENVIRONMENT
1747		2235
…		…
1756		2244
1757	=item >= 3 - script loading and management	2245	=item >= 3 - script loading and management
1758		2246
1759	=item >=10 - all called hooks	2247	=item >=10 - all called hooks
1760		2248
1761	=item >=11 - hook reutrn values	2249	=item >=11 - hook return values
1762		2250
1763	=back	2251	=back
1764		2252
1765	=head1 AUTHOR	2253	=head1 AUTHOR
1766		2254
…		…
1768	http://software.schmorp.de/pkg/rxvt-unicode	2256	http://software.schmorp.de/pkg/rxvt-unicode
1769		2257
1770	=cut	2258	=cut
1771		2259
1772	1	2260	1
		2261
		2262	# vim: sw=3:

Diff Legend

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