[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.129 by root, Wed Jan 25 15:11:31 2006 UTC vs.
Revision 1.208 by root, Tue Jun 5 22:23:07 2012 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
62	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
63	...	66	...
64		67
65	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:	71	between two vertical bars:
69		72
70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
71		74
72	Another example: Programs I use often output "absolute path: " at the	75	Another example: Programs I use often output "absolute path: " at the
…		…
94	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
95		98
96	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
97	runtime.	100	runtime.
98		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
99	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
100		120
101	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
102	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
103	evaluation, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
104		124
105	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
106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
107	popup is displayed.	127	popup is being displayed.
108		128
109	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
110	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.
111	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
112	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
113	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
114		134
115	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
116	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
117	C<a>s:	137	C<a>s:
118		138
119	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
120	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
121	: ()	141	: ()
122	};	142	};
123		143
124	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
125		145
…		…
132	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>
133	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
134	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
135	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
136	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
137	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.
138		164
139	=item readline (enabled by default)	165	=item readline (enabled by default)
140		166
141	A support package that tries to make editing with readline easier. At the	167	A support package that tries to make editing with readline easier. At
142	moment, it reacts to clicking with the left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
143	move the text cursor to this position. It does so by generating as many	169	move the text cursor to this position. It does so by generating as many
144	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
145	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
146		172
147	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
148		174
149	=over 4	175	=over 4
…		…
197	the message into vi commands to load the file.	223	the message into vi commands to load the file.
198		224
199	=item tabbed	225	=item tabbed
200		226
201	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one	229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204	button per tab.	230	button per tab.
205		231
206	Clicking a button will activate that tab. Pressing B<Shift-Left> and	232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
207	B<Shift-Right> will switch to the tab left or right of the current one,	233	B<Shift-Right> will switch to the tab left or right of the current one,
208	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
209		235
210	=item mark-urls	236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
211		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
212	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
213	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
214	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
215	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.
		258
		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.
		263
		264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
		266	"perl:matcher:list" as seen in the example below.
		267
		268	Example configuration:
		269
		270	URxvt.perl-ext: default,matcher
		271	URxvt.urlLauncher: sensible-browser
		272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
		274	URxvt.matcher.button: 1
		275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		277	URxvt.matcher.launcher.2: gvim +$2 $1
216		278
217	=item xim-onthespot	279	=item xim-onthespot
218		280
219	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
220	not work perfectly, and some input methods don't seem to work well with	282	not work perfectly, and some input methods don't seem to work well with
221	OnTheSpot editing in general, but it seems to work at leats for SCIM and	283	OnTheSpot editing in general, but it seems to work at least for SCIM and
222	kinput2.	284	kinput2.
223		285
224	You enable it by specifying this extension and a preedit style of	286	You enable it by specifying this extension and a preedit style of
225	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
226		288
227	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
228		290
229	=item automove-background	291	=item kuake<hotkey>
230		292
231	This is basically a one-line extension that dynamically changes the background pixmap offset	293	A very primitive quake-console-like extension. It was inspired by a
232	to the window position, in effect creating the same effect as pseudo transparency with	294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
233	a custom pixmap. No scaling is supported in this mode. Exmaple:	295	user presses a global accelerator key (by default C<F10>), the terminal
		296	will show or hide itself. Another press of the accelerator key will hide
		297	or show it again.
234		298
235	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	299	Initially, the window will not be shown when using this extension.
		300
		301	This is useful if you need a single terminal that is not using any desktop
		302	space most of the time but is quickly available at the press of a key.
		303
		304	The accelerator key is grabbed regardless of any modifiers, so this
		305	extension will actually grab a physical key just for this function.
		306
		307	If you want a quake-like animation, tell your window manager to do so
		308	(fvwm can do it).
		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
236		315
237	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
238		317
239	A not very useful example of filtering all text output to the terminal,	318	A not very useful example of filtering all text output to the terminal
240	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
241	similar-looking ascii character.	320	similar-looking ascii character.
242		321
243	=item digital-clock	322	=item digital-clock
244		323
245	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
246		325
247	=item remote-selection	326	=item remote-clipboard
248		327
249	Somewhat of a misnomer, this extension adds two menu entries to the	328	Somewhat of a misnomer, this extension adds two menu entries to the
250	selection popup that allows one ti run external commands to store the	329	selection popup that allows one to run external commands to store the
251	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
252		331
253	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
254	means that one command uploads the file to a remote server, and another	333	means that one command uploads the file to a remote server, and another
255	reads it.	334	reads it.
…		…
264	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
265	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
266		345
267	=item selection-pastebin	346	=item selection-pastebin
268		347
269	This is a little rarely useful extension that Uploads the selection as	348	This is a little rarely useful extension that uploads the selection as
270	textfile to a remote site (or does other things). (The implementation is	349	textfile to a remote site (or does other things). (The implementation is
271	not currently secure for use in a multiuser environment as it writes to	350	not currently secure for use in a multiuser environment as it writes to
272	F</tmp> directly.).	351	F</tmp> directly.).
273		352
274	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
291	in the C<selection-pastebin-url> resource (again, the % is the placeholder	370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
292	for the filename):	371	for the filename):
293		372
294	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
295		374
		375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		376	the double C</> characters as comment start. Use C<\057\057> instead,
		377	which works regardless of whether xrdb is used to parse the resource file
		378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
		393
296	=item example-refresh-hooks	394	=item example-refresh-hooks
297		395
298	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
299	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
300	overlays or changes.	398	overlays or changes.
		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
301		412
302	=back	413	=back
303		414
304	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
305		416
…		…
321		432
322	=over 4	433	=over 4
323		434
324	=item $text	435	=item $text
325		436
326	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
327	always represents one screen cell. See L<ROW_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
328		439
329	=item $string	440	=item $string
330		441
331	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
335	=item $octets	446	=item $octets
336		447
337	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
338	locale-specific way.	449	locale-specific way.
339		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
340	=back	457	=back
341		458
342	=head2 Extension Objects	459	=head2 Extension Objects
343		460
344	Very perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
345	for each terminal and each extension and passed as the first parameter to	462	for each terminal, and each terminal has its own set of extension objects,
346	hooks. So extensions can use their C<$self> object without having to think	463	which are passed as the first parameter to hooks. So extensions can use
347	about other extensions, with the exception of methods and members that	464	their C<$self> object without having to think about clashes with other
		465	extensions or other terminals, with the exception of methods and members
348	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
349	use.	467	internal use.
350		468
351	Although it isn't a C<urxvt::term> object, you can call all methods of the	469	Although it isn't a C<urxvt::term> object, you can call all methods of the
352	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
353		471
354	It has the following methods and data members:	472	It has the following methods and data members:
…		…
375	=head2 Hooks	493	=head2 Hooks
376		494
377	The following subroutines can be declared in extension files, and will be	495	The following subroutines can be declared in extension files, and will be
378	called whenever the relevant event happens.	496	called whenever the relevant event happens.
379		497
380	The first argument passed to them is an extension oject as described in	498	The first argument passed to them is an extension object as described in
381	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
382		500
383	B<All> of these hooks must return a boolean value. If any of the called	501	B<All> of these hooks must return a boolean value. If any of the called
384	hooks returns true, then the event counts as being I<consumed>, and the	502	hooks returns true, then the event counts as being I<consumed>, and the
385	relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
…		…
398	place.	516	place.
399		517
400	=item on_start $term	518	=item on_start $term
401		519
402	Called at the very end of initialisation of a new terminal, just before	520	Called at the very end of initialisation of a new terminal, just before
403	trying to map (display) the toplevel and returning to the mainloop.	521	trying to map (display) the toplevel and returning to the main loop.
404		522
405	=item on_destroy $term	523	=item on_destroy $term
406		524
407	Called whenever something tries to destroy terminal, when the terminal is	525	Called whenever something tries to destroy terminal, when the terminal is
408	still fully functional (not for long, though).	526	still fully functional (not for long, though).
…		…
435		553
436	Called whenever a selection has been copied, but before the selection is	554	Called whenever a selection has been copied, but before the selection is
437	requested from the server. The selection text can be queried and changed	555	requested from the server. The selection text can be queried and changed
438	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
439		557
440	Returning a true value aborts selection grabbing. It will still be hilighted.	558	Returning a true value aborts selection grabbing. It will still be highlighted.
441		559
442	=item on_sel_extend $term	560	=item on_sel_extend $term
443		561
444	Called whenever the user tries to extend the selection (e.g. with a double	562	Called whenever the user tries to extend the selection (e.g. with a double
445	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
446	should extend the selection itelf and return true to suppress the built-in	564	should extend the selection itself and return true to suppress the built-in
447	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
448	returns true, it will be called on every further click by the user and is	566	returns true, it will be called on every further click by the user and is
449	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
450		568
451	See the F<selection> example extension.	569	See the F<selection> example extension.
452		570
453	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
454		572
455	Called whenever the view offset changes, i..e the user or program	573	Called whenever the view offset changes, i.e. the user or program
456	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
457	show this many lines of scrollback.	575	show this many lines of scrollback.
458		576
459	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
460		578
…		…
464		582
465	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	583	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
466	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	584	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
467	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
468		586
469	=item on_osc_seq $term, $string	587	=item on_osc_seq $term, $op, $args, $resp
		588
		589	Called on every OSC sequence and can be used to suppress it or modify its
		590	behaviour. The default should be to return an empty list. A true value
		591	suppresses execution of the request completely. Make sure you don't get
		592	confused by recursive invocations when you output an OSC sequence within
		593	this callback.
		594
		595	C<on_osc_seq_perl> should be used for new behaviour.
		596
		597	=item on_osc_seq_perl $term, $args, $resp
470		598
471	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
472	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
473	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
474	string should start with the extension name and a colon, to distinguish	602	string should start with the extension name (sans -osc) and a semicolon,
475	it from commands for other extensions, and this might be enforced in the	603	to distinguish it from commands for other extensions, and this might be
476	future.	604	enforced in the future.
		605
		606	For example, C<overlay-osc> uses this:
		607
		608	sub on_osc_seq_perl {
		609	my ($self, $osc, $resp) = @_;
		610
		611	return unless $osc =~ s/^overlay;//;
		612
		613	... process remaining $osc string
		614	}
477		615
478	Be careful not ever to trust (in a security sense) the data you receive,	616	Be careful not ever to trust (in a security sense) the data you receive,
479	as its source can not easily be controleld (e-mail content, messages from	617	as its source can not easily be controlled (e-mail content, messages from
480	other users on the same system etc.).	618	other users on the same system etc.).
		619
		620	For responses, C<$resp> contains the end-of-args separator used by the
		621	sender.
481		622
482	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
483		624
484	Called whenever text is about to be output, with the text as argument. You	625	Called whenever text is about to be output, with the text as argument. You
485	can filter/change and output the text yourself by returning a true value	626	can filter/change and output the text yourself by returning a true value
…		…
490	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
491		632
492	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
493	suppress or filter tty input.	634	suppress or filter tty input.
494		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
495	=item on_line_update $term, $row	643	=item on_line_update $term, $row
496		644
497	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
498	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
499	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
506	later with the already-modified line (e.g. if unrelated parts change), so	654	later with the already-modified line (e.g. if unrelated parts change), so
507	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
508		656
509	=item on_refresh_begin $term	657	=item on_refresh_begin $term
510		658
511	Called just before the screen gets redrawn. Can be used for overlay	659	Called just before the screen gets redrawn. Can be used for overlay or
512	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
513	restoring them in refresh_end. The built-in overlay and selection display	661	restoring them in refresh_end. The built-in overlay and selection display
514	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
515		663
516	=item on_refresh_end $term	664	=item on_refresh_end $term
517		665
518	Called just after the screen gets redrawn. See C<on_refresh_begin>.	666	Called just after the screen gets redrawn. See C<on_refresh_begin>.
519		667
520	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
521		669
522	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
523	C<perl:string> action bound to it (see description of the B<keysym>	671	a C<perl:string> action bound to a key, see description of the B<keysym>
524	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
		673
		674	The event is simply the action string. This interface is assumed to change
		675	slightly in the future.
		676
		677	=item on_register_command $term, $keysym, $modifiermask, $string
		678
		679	Called after parsing a keysym resource but before registering the
		680	associated binding. If this hook returns TRUE the binding is not
		681	registered. It can be used to modify a binding by calling
		682	C<register_command>.
		683
		684	=item on_resize_all_windows $term, $new_width, $new_height
		685
		686	Called just after the new window size has been calculated, but before
		687	windows are actually being resized or hints are being set. If this hook
		688	returns TRUE, setting of the window hints is being skipped.
525		689
526	=item on_x_event $term, $event	690	=item on_x_event $term, $event
527		691
528	Called on every X event received on the vt window (and possibly other	692	Called on every X event received on the vt window (and possibly other
529	windows). Should only be used as a last resort. Most event structure	693	windows). Should only be used as a last resort. Most event structure
530	members are not passed.	694	members are not passed.
531		695
		696	=item on_root_event $term, $event
		697
		698	Like C<on_x_event>, but is called for events on the root window.
		699
532	=item on_focus_in $term	700	=item on_focus_in $term
533		701
534	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
535	does focus in processing.	703	does focus in processing.
536		704
537	=item on_focus_out $term	705	=item on_focus_out $term
538		706
539	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
540	focus out processing.	708	focus out processing.
541		709
542	=item on_configure_notify $term, $event	710	=item on_configure_notify $term, $event
543		711
544	=item on_property_notify $term, $event	712	=item on_property_notify $term, $event
…		…
555		723
556	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
557		725
558	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
559		727
560	Called whenever the corresponding X event is received for the terminal If	728	Called whenever the corresponding X event is received for the terminal. If
561	the hook returns true, then the even will be ignored by rxvt-unicode.	729	the hook returns true, then the event will be ignored by rxvt-unicode.
562		730
563	The event is a hash with most values as named by Xlib (see the XEvent	731	The event is a hash with most values as named by Xlib (see the XEvent
564	manpage), with the additional members C<row> and C<col>, which are the	732	manpage), with the additional members C<row> and C<col>, which are the
565	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
566		734
…		…
575		743
576	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
577		745
578	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
579	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
580		752
581	=back	753	=back
582		754
583	=cut	755	=cut
584		756
…		…
627	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
628	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
629		801
630	=item @urxvt::TERM_INIT	802	=item @urxvt::TERM_INIT
631		803
632	All coderefs in this array will be called as methods of the next newly	804	All code references in this array will be called as methods of the next newly
633	created C<urxvt::term> object (during the C<on_init> phase). The array	805	created C<urxvt::term> object (during the C<on_init> phase). The array
634	gets cleared before the codereferences that were in it are being executed,	806	gets cleared before the code references that were in it are being executed,
635	so coderefs can push themselves onto it again if they so desire.	807	so references can push themselves onto it again if they so desire.
636		808
637	This complements to the perl-eval commandline option, but gets executed	809	This complements to the perl-eval command line option, but gets executed
638	first.	810	first.
639		811
640	=item @urxvt::TERM_EXT	812	=item @urxvt::TERM_EXT
641		813
642	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	814	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
649		821
650	=over 4	822	=over 4
651		823
652	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
653		825
654	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
655	costs! The only time this is acceptable is when the terminal process	827	include a trailing newline). Avoid at all costs! The only time this
656	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
657		830
658	=item urxvt::warn $string	831	=item urxvt::warn $string
659		832
660	Calls C<rxvt_warn> with the given string which should not include a	833	Calls C<rxvt_warn> with the given string which should include a trailing
661	newline. The module also overwrites the C<warn> builtin with a function	834	newline. The module also overwrites the C<warn> builtin with a function
662	that calls this function.	835	that calls this function.
663		836
664	Using this function has the advantage that its output ends up in the	837	Using this function has the advantage that its output ends up in the
665	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
666		839
667	Messages have a size limit of 1023 bytes currently.	840	Messages have a size limit of 1023 bytes currently.
		841
		842	=item @terms = urxvt::termlist
		843
		844	Returns all urxvt::term objects that exist in this process, regardless of
		845	whether they are started, being destroyed etc., so be careful. Only term
		846	objects that have perl extensions attached will be returned (because there
		847	is no urxvt::term object associated with others).
668		848
669	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
670		850
671	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
672		852
…		…
715		895
716	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
717		897
718	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
719		899
720	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
721		902
722	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
723	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
724	the bitset.	905	the bitset.
725		906
…		…
730	Return the foreground/background colour index, respectively.	911	Return the foreground/background colour index, respectively.
731		912
732	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
733		914
734	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	915	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		916
		917	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
735		918
736	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
737	specified one.	920	specified one.
738		921
739	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
…		…
760	};	943	};
761	}	944	}
762		945
763	no warnings 'utf8';	946	no warnings 'utf8';
764		947
		948	sub resource {
		949	my ($term, $name, $isarg, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	warn "resourece<@_>\n";#d#
		954
		955	0
		956	}
		957
		958	sub usage {
		959	my ($term, $usage_type) = @_;
		960
		961	$term->scan_meta;
		962
		963	my $r = $term->{meta}{resource};
		964
		965	for my $regex (sort keys %$r) {
		966	my ($ext, $type, $desc) = @{ $r->{$regex} };
		967
		968	$desc .= " (-pe $ext)";
		969
		970	if ($usage_type == 1) {
		971	if ($type eq "boolean") {
		972	urxvt::log sprintf " -%-20.20s %s\n", "/+$regex", $desc;
		973	} else {
		974	urxvt::log sprintf " -%-20.20s %s\n", "$regex $type", $desc;
		975	}
		976	} else {
		977	urxvt::log sprintf " %-19.19s %s\n", "$regex:", $type;
		978	}
		979	}
		980	}
		981
765	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	982	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
766		983
767	sub verbose {	984	sub verbose {
768	my ($level, $msg) = @_;	985	my ($level, $msg) = @_;
769	warn "$msg\n" if $level <= $verbosity;	986	warn "$msg\n" if $level <= $verbosity;
…		…
805	sub invoke {	1022	sub invoke {
806	local $TERM = shift;	1023	local $TERM = shift;
807	my $htype = shift;	1024	my $htype = shift;
808		1025
809	if ($htype == 0) { # INIT	1026	if ($htype == 0) { # INIT
810	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1027	my @dirs = $TERM->perl_libdirs;
811		1028
812	my %ext_arg;	1029	my %ext_arg;
813		1030
814	{	1031	{
815	my @init = @TERM_INIT;	1032	my @init = @TERM_INIT;
816	@TERM_INIT = ();	1033	@TERM_INIT = ();
…		…
830	} else {	1047	} else {
831	$ext_arg{$_} \|\|= [];	1048	$ext_arg{$_} \|\|= [];
832	}	1049	}
833	}	1050	}
834		1051
835	while (my ($ext, $argv) = each %ext_arg) {	1052	for my $ext (sort keys %ext_arg) {
836	my @files = grep -f $_, map "$_/$ext", @dirs;	1053	my @files = grep -f $_, map "$_/$ext", @dirs;
837		1054
838	if (@files) {	1055	if (@files) {
839	$TERM->register_package (extension_package $files[0], $argv);	1056	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
840	} else {	1057	} else {
841	warn "perl extension '$ext' not found in perl library search path\n";	1058	warn "perl extension '$ext' not found in perl library search path\n";
842	}	1059	}
843	}	1060	}
844		1061
…		…
850		1067
851	if (my $cb = $TERM->{_hook}[$htype]) {	1068	if (my $cb = $TERM->{_hook}[$htype]) {
852	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1069	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
853	if $verbosity >= 10;	1070	if $verbosity >= 10;
854		1071
855	keys %$cb;	1072	for my $pkg (keys %$cb) {
856
857	while (my ($pkg, $cb) = each %$cb) {
858	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1073	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
859	$retval \|\|= $retval_;	1074	$retval \|\|= $retval_;
860		1075
861	if ($@) {	1076	if ($@) {
862	$TERM->ungrab; # better to lose the grab than the session	1077	$TERM->ungrab; # better to lose the grab than the session
863	warn $@;	1078	warn $@;
…		…
875	# clear package	1090	# clear package
876	%$TERM = ();	1091	%$TERM = ();
877	}	1092	}
878		1093
879	$retval	1094	$retval
		1095	}
		1096
		1097	sub SET_COLOR($$$) {
		1098	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1099	}
		1100
		1101	sub rend2mask {
		1102	no strict 'refs';
		1103	my ($str, $mask) = (@_, 0);
		1104	my %color = ( fg => undef, bg => undef );
		1105	my @failed;
		1106	for my $spec ( split /\s+/, $str ) {
		1107	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1108	$color{lc($1)} = $2;
		1109	} else {
		1110	my $neg = $spec =~ s/^[-^]//;
		1111	unless ( exists &{"RS_$spec"} ) {
		1112	push @failed, $spec;
		1113	next;
		1114	}
		1115	my $cur = &{"RS_$spec"};
		1116	if ( $neg ) {
		1117	$mask &= ~$cur;
		1118	} else {
		1119	$mask \|= $cur;
		1120	}
		1121	}
		1122	}
		1123	($mask, @color{qw(fg bg)}, \@failed)
880	}	1124	}
881		1125
882	# urxvt::term::extension	1126	# urxvt::term::extension
883		1127
884	package urxvt::term::extension;	1128	package urxvt::term::extension;
…		…
955	is that you cannot use blocking APIs, but the non-blocking variant should	1199	is that you cannot use blocking APIs, but the non-blocking variant should
956	work.	1200	work.
957		1201
958	=cut	1202	=cut
959		1203
960	our $VERSION = 1;	1204	our $VERSION = '5.23';
961		1205
962	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1206	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
963	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1207	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
964		1208
965	sub timer {	1209	sub timer {
…		…
967		1211
968	my $cb = $arg{cb};	1212	my $cb = $arg{cb};
969		1213
970	urxvt::timer	1214	urxvt::timer
971	->new	1215	->new
972	->start (urxvt::NOW + $arg{after})	1216	->after ($arg{after}, $arg{interval})
973	->cb (sub {	1217	->cb ($arg{interval} ? $cb : sub {
974	$_[0]->stop; # need to cancel manually	1218	$_[0]->stop; # need to cancel manually
975	$cb->();	1219	$cb->();
976	})	1220	})
977	}	1221	}
978		1222
979	sub io {	1223	sub io {
980	my ($class, %arg) = @_;	1224	my ($class, %arg) = @_;
981		1225
982	my $cb = $arg{cb};	1226	my $cb = $arg{cb};
		1227	my $fd = fileno $arg{fh};
		1228	defined $fd or $fd = $arg{fh};
983		1229
984	bless [$arg{fh}, urxvt::iow	1230	bless [$arg{fh}, urxvt::iow
985	->new	1231	->new
986	->fd (fileno $arg{fh})	1232	->fd ($fd)
987	->events (($arg{poll} =~ /r/ ? 1 : 0)	1233	->events (($arg{poll} =~ /r/ ? 1 : 0)
988	\| ($arg{poll} =~ /w/ ? 2 : 0))	1234	\| ($arg{poll} =~ /w/ ? 2 : 0))
989	->start	1235	->start
990	->cb (sub {	1236	->cb ($cb)
991	$cb->(($_[1] & 1 ? 'r' : '')
992	. ($_[1] & 2 ? 'w' : ''));
993	})],
994	urxvt::anyevent::	1237	], urxvt::anyevent::
		1238	}
		1239
		1240	sub idle {
		1241	my ($class, %arg) = @_;
		1242
		1243	my $cb = $arg{cb};
		1244
		1245	urxvt::iw
		1246	->new
		1247	->start
		1248	->cb ($cb)
		1249	}
		1250
		1251	sub child {
		1252	my ($class, %arg) = @_;
		1253
		1254	my $cb = $arg{cb};
		1255
		1256	urxvt::pw
		1257	->new
		1258	->start ($arg{pid})
		1259	->cb (sub {
		1260	$_[0]->stop; # need to cancel manually
		1261	$cb->($_[0]->rpid, $_[0]->rstatus);
		1262	})
995	}	1263	}
996		1264
997	sub DESTROY {	1265	sub DESTROY {
998	$_[0][1]->stop;	1266	$_[0][1]->stop;
999	}	1267	}
1000		1268
1001	sub condvar {	1269	# only needed for AnyEvent < 6 compatibility
1002	bless \my $flag, urxvt::anyevent::condvar::	1270	sub one_event {
1003	}
1004
1005	sub urxvt::anyevent::condvar::broadcast {
1006	${$_[0]}++;
1007	}
1008
1009	sub urxvt::anyevent::condvar::wait {
1010	unless (${$_[0]}) {
1011	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1271	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1012	}
1013	}	1272	}
1014		1273
1015	package urxvt::term;	1274	package urxvt::term;
1016		1275
1017	=head2 The C<urxvt::term> Class	1276	=head2 The C<urxvt::term> Class
…		…
1044	$proxy->enable ($name => $ref);	1303	$proxy->enable ($name => $ref);
1045	}	1304	}
1046	}	1305	}
1047	}	1306	}
1048		1307
		1308	sub perl_libdirs {
		1309	map { split /:/ }
		1310	$_[0]->resource ("perl_lib"),
		1311	$ENV{URXVT_PERL_LIB},
		1312	"$ENV{HOME}/.urxvt/ext",
		1313	"$LIBDIR/perl"
		1314	}
		1315
		1316	sub scan_meta {
		1317	my ($self) = @_;
		1318	my @libdirs = perl_libdirs $self;
		1319
		1320	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1321
		1322	my %meta;
		1323
		1324	$self->{meta_libdirs} = join "\x00", @libdirs;
		1325	$self->{meta} = \%meta;
		1326
		1327	for my $dir (reverse @libdirs) {
		1328	opendir my $fh, $dir
		1329	or next;
		1330	for my $ext (readdir $fh) {
		1331	$ext ne "."
		1332	and $ext ne ".."
		1333	and open my $fh, "<", "$dir/$ext"
		1334	or next;
		1335
		1336	while (<$fh>) {
		1337	if (/^#:META:RESOURCE:(.*)/) {
		1338	my ($regex, $type, $desc) = split /:/, $1;
		1339	$regex =~ s/\$\$/$ext/g; # $$ in regex == extension name
		1340	$meta{resource}{$regex} = [$ext, $type, $desc];
		1341	} elsif (/^\s*(?:#\|$)/) {
		1342	# skip other comments and empty lines
		1343	} else {
		1344	last; # stop parsing on first non-empty non-comment line
		1345	}
		1346	}
		1347	}
		1348	}
		1349	}
		1350
1049	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1351	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1050		1352
1051	Creates a new terminal, very similar as if you had started it with system	1353	Creates a new terminal, very similar as if you had started it with system
1052	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1354	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1053	hash which defines the environment of the new terminal.	1355	hash which defines the environment of the new terminal.
1054		1356
1055	Croaks (and probably outputs an error message) if the new instance	1357	Croaks (and probably outputs an error message) if the new instance
1056	couldn't be created. Returns C<undef> if the new instance didn't	1358	couldn't be created. Returns C<undef> if the new instance didn't
1057	initialise perl, and the terminal object otherwise. The C<init> and	1359	initialise perl, and the terminal object otherwise. The C<init> and
1058	C<start> hooks will be called during this call.	1360	C<start> hooks will be called before this call returns, and are free to
		1361	refer to global data (which is race free).
1059		1362
1060	=cut	1363	=cut
1061		1364
1062	sub new {	1365	sub new {
1063	my ($class, $env, @args) = @_;	1366	my ($class, $env, @args) = @_;
1064		1367
		1368	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1369	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1370
1065	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1371	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1066	}	1372	}
1067		1373
1068	=item $term->destroy	1374	=item $term->destroy
1069		1375
1070	Destroy the terminal object (close the window, free resources	1376	Destroy the terminal object (close the window, free resources
…		…
1100		1406
1101	Returns true if the option specified by C<$optval> is enabled, and	1407	Returns true if the option specified by C<$optval> is enabled, and
1102	optionally change it. All option values are stored by name in the hash	1408	optionally change it. All option values are stored by name in the hash
1103	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1409	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1104		1410
1105	Here is a a likely non-exhaustive list of option names, please see the	1411	Here is a likely non-exhaustive list of option names, please see the
1106	source file F</src/optinc.h> to see the actual list:	1412	source file F</src/optinc.h> to see the actual list:
1107		1413
1108	borderLess console cursorBlink cursorUnderline hold iconic insecure	1414	borderLess buffered console cursorBlink cursorUnderline hold iconic
1109	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1415	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1110	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1416	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1111	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1417	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1112	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1418	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1113	transparent tripleclickwords utmpInhibit visualBell	1419	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1420	urgentOnBell utmpInhibit visualBell
1114		1421
1115	=item $value = $term->resource ($name[, $newval])	1422	=item $value = $term->resource ($name[, $newval])
1116		1423
1117	Returns the current resource value associated with a given name and	1424	Returns the current resource value associated with a given name and
1118	optionally sets a new value. Setting values is most useful in the C<init>	1425	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1127	likely change).	1434	likely change).
1128		1435
1129	Please note that resource strings will currently only be freed when the	1436	Please note that resource strings will currently only be freed when the
1130	terminal is destroyed, so changing options frequently will eat memory.	1437	terminal is destroyed, so changing options frequently will eat memory.
1131		1438
1132	Here is a a likely non-exhaustive list of resource names, not all of which	1439	Here is a likely non-exhaustive list of resource names, not all of which
1133	are supported in every build, please see the source file F</src/rsinc.h>	1440	are supported in every build, please see the source file F</src/rsinc.h>
1134	to see the actual list:	1441	to see the actual list:
1135		1442
1136	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1443	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1137	borderLess color cursorBlink cursorUnderline cutchars delete_key	1444	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1138	display_name embed ext_bwidth fade font geometry hold iconName	1445	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1139	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1446	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1447	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1140	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1448	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1141	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1449	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1142	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1450	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1143	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1451	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1144	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1452	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1145	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1453	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1146	secondaryScreen secondaryScroll selectstyle shade term_name title	1454	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1147	transient_for transparent transparent_all tripleclickwords utmpInhibit	1455	term_name title transient_for transparent tripleclickwords urgentOnBell
1148	visualBell	1456	utmpInhibit visualBell
1149		1457
1150	=cut	1458	=cut
1151		1459
1152	sub resource($$;$) {	1460	sub resource($$;$) {
1153	my ($self, $name) = (shift, shift);	1461	my ($self, $name) = (shift, shift);
1154	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1462	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1155	&urxvt::term::_resource	1463	goto &urxvt::term::_resource
1156	}	1464	}
1157		1465
1158	=item $value = $term->x_resource ($pattern)	1466	=item $value = $term->x_resource ($pattern)
1159		1467
1160	Returns the X-Resource for the given pattern, excluding the program or	1468	Returns the X-Resource for the given pattern, excluding the program or
…		…
1164		1472
1165	This method should only be called during the C<on_start> hook, as there is	1473	This method should only be called during the C<on_start> hook, as there is
1166	only one resource database per display, and later invocations might return	1474	only one resource database per display, and later invocations might return
1167	the wrong resources.	1475	the wrong resources.
1168		1476
1169	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1477	=item $success = $term->parse_keysym ($key, $octets)
1170		1478
1171	Adds a keymap translation exactly as specified via a resource. See the	1479	Adds a key binding exactly as specified via a resource. See the
1172	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1480	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1481
		1482	=item $term->register_command ($keysym, $modifiermask, $string)
		1483
		1484	Adds a key binding. This is a lower level api compared to
		1485	C<parse_keysym>, as it expects a parsed key description, and can be
		1486	used only inside either the C<on_init> hook, to add a binding, or the
		1487	C<on_register_command> hook, to modify a parsed binding.
1173		1488
1174	=item $rend = $term->rstyle ([$new_rstyle])	1489	=item $rend = $term->rstyle ([$new_rstyle])
1175		1490
1176	Return and optionally change the current rendition. Text that is output by	1491	Return and optionally change the current rendition. Text that is output by
1177	the terminal application will use this style.	1492	the terminal application will use this style.
…		…
1185		1500
1186	=item ($row, $col) = $term->selection_beg ([$row, $col])	1501	=item ($row, $col) = $term->selection_beg ([$row, $col])
1187		1502
1188	=item ($row, $col) = $term->selection_end ([$row, $col])	1503	=item ($row, $col) = $term->selection_end ([$row, $col])
1189		1504
1190	Return the current values of the selection mark, begin or end positions,	1505	Return the current values of the selection mark, begin or end positions.
1191	and optionally set them to new values.	1506
		1507	When arguments are given, then the selection coordinates are set to
		1508	C<$row> and C<$col>, and the selection screen is set to the current
		1509	screen.
		1510
		1511	=item $screen = $term->selection_screen ([$screen])
		1512
		1513	Returns the current selection screen, and then optionally sets it.
1192		1514
1193	=item $term->selection_make ($eventtime[, $rectangular])	1515	=item $term->selection_make ($eventtime[, $rectangular])
1194		1516
1195	Tries to make a selection as set by C<selection_beg> and	1517	Tries to make a selection as set by C<selection_beg> and
1196	C<selection_end>. If C<$rectangular> is true (default: false), a	1518	C<selection_end>. If C<$rectangular> is true (default: false), a
1197	rectangular selection will be made. This is the prefered function to make	1519	rectangular selection will be made. This is the preferred function to make
1198	a selection.	1520	a selection.
1199		1521
1200	=item $success = $term->selection_grab ($eventtime)	1522	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1201		1523
1202	Try to request the primary selection text from the server (for example, as	1524	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1525	true) selection from the server. The corresponding text can be set
1203	set by the next method). No visual feedback will be given. This function	1526	with the next method. No visual feedback will be given. This function
1204	is mostly useful from within C<on_sel_grab> hooks.	1527	is mostly useful from within C<on_sel_grab> hooks.
1205		1528
1206	=item $oldtext = $term->selection ([$newtext])	1529	=item $oldtext = $term->selection ([$newtext, $clipboard])
1207		1530
1208	Return the current selection text and optionally replace it by C<$newtext>.	1531	Return the current selection (clipboard if C<$clipboard> is true) text
		1532	and optionally replace it by C<$newtext>.
		1533
		1534	=item $term->selection_clear ([$clipboard])
		1535
		1536	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1209		1537
1210	=item $term->overlay_simple ($x, $y, $text)	1538	=item $term->overlay_simple ($x, $y, $text)
1211		1539
1212	Create a simple multi-line overlay box. See the next method for details.	1540	Create a simple multi-line overlay box. See the next method for details.
1213		1541
…		…
1243		1571
1244	The methods currently supported on C<urxvt::overlay> objects are:	1572	The methods currently supported on C<urxvt::overlay> objects are:
1245		1573
1246	=over 4	1574	=over 4
1247		1575
1248	=item $overlay->set ($x, $y, $text, $rend)	1576	=item $overlay->set ($x, $y, $text[, $rend])
1249		1577
1250	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1578	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1251	text in rxvt-unicode's special encoding and an array of rendition values	1579	text in rxvt-unicode's special encoding and an array of rendition values
1252	at a specific position inside the overlay.	1580	at a specific position inside the overlay.
		1581
		1582	If C<$rend> is missing, then the rendition will not be changed.
1253		1583
1254	=item $overlay->hide	1584	=item $overlay->hide
1255		1585
1256	If visible, hide the overlay, but do not destroy it.	1586	If visible, hide the overlay, but do not destroy it.
1257		1587
…		…
1339	locale-specific encoding of the terminal and can contain command sequences	1669	locale-specific encoding of the terminal and can contain command sequences
1340	(escape codes) that will be interpreted.	1670	(escape codes) that will be interpreted.
1341		1671
1342	=item $term->tt_write ($octets)	1672	=item $term->tt_write ($octets)
1343		1673
1344	Write the octets given in C<$data> to the tty (i.e. as program input). To	1674	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1345	pass characters instead of octets, you should convert your strings first	1675	pass characters instead of octets, you should convert your strings first
1346	to the locale-specific encoding using C<< $term->locale_encode >>.	1676	to the locale-specific encoding using C<< $term->locale_encode >>.
		1677
		1678	=item $term->tt_paste ($octets)
		1679
		1680	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1681	CR and bracketing the data with control sequences if bracketed paste mode
		1682	is set.
1347		1683
1348	=item $old_events = $term->pty_ev_events ([$new_events])	1684	=item $old_events = $term->pty_ev_events ([$new_events])
1349		1685
1350	Replaces the event mask of the pty watcher by the given event mask. Can	1686	Replaces the event mask of the pty watcher by the given event mask. Can
1351	be used to suppress input and output handling to the pty/tty. See the	1687	be used to suppress input and output handling to the pty/tty. See the
…		…
1370	Adds the specified events to the vt event mask. Useful e.g. when you want	1706	Adds the specified events to the vt event mask. Useful e.g. when you want
1371	to receive pointer events all the times:	1707	to receive pointer events all the times:
1372		1708
1373	$term->vt_emask_add (urxvt::PointerMotionMask);	1709	$term->vt_emask_add (urxvt::PointerMotionMask);
1374		1710
		1711	=item $term->set_urgency ($set)
		1712
		1713	Enable/disable the urgency hint on the toplevel window.
		1714
		1715	=item $term->focus_in
		1716
		1717	=item $term->focus_out
		1718
		1719	=item $term->key_press ($state, $keycode[, $time])
		1720
		1721	=item $term->key_release ($state, $keycode[, $time])
		1722
		1723	Deliver various fake events to to terminal.
		1724
1375	=item $window_width = $term->width	1725	=item $window_width = $term->width
1376		1726
1377	=item $window_height = $term->height	1727	=item $window_height = $term->height
1378		1728
1379	=item $font_width = $term->fwidth	1729	=item $font_width = $term->fwidth
…		…
1409	=item $env = $term->env	1759	=item $env = $term->env
1410		1760
1411	Returns a copy of the environment in effect for the terminal as a hashref	1761	Returns a copy of the environment in effect for the terminal as a hashref
1412	similar to C<\%ENV>.	1762	similar to C<\%ENV>.
1413		1763
		1764	=item @envv = $term->envv
		1765
		1766	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1767
		1768	=item @argv = $term->argv
		1769
		1770	Return the argument vector as this terminal, similar to @ARGV, but
		1771	includes the program name as first element.
		1772
1414	=cut	1773	=cut
1415		1774
1416	sub env {	1775	sub env {
1417	if (my $env = $_[0]->_env) {
1418	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1776	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1419	} else {
1420	+{ %ENV }
1421	}
1422	}	1777	}
1423		1778
1424	=item $modifiermask = $term->ModLevel3Mask	1779	=item $modifiermask = $term->ModLevel3Mask
1425		1780
1426	=item $modifiermask = $term->ModMetaMask	1781	=item $modifiermask = $term->ModMetaMask
…		…
1434		1789
1435	Returns the currently displayed screen (0 primary, 1 secondary).	1790	Returns the currently displayed screen (0 primary, 1 secondary).
1436		1791
1437	=item $cursor_is_hidden = $term->hidden_cursor	1792	=item $cursor_is_hidden = $term->hidden_cursor
1438		1793
1439	Returns wether the cursor is currently hidden or not.	1794	Returns whether the cursor is currently hidden or not.
1440		1795
1441	=item $view_start = $term->view_start ([$newvalue])	1796	=item $view_start = $term->view_start ([$newvalue])
1442		1797
1443	Returns the row number of the topmost displayed line. Maximum value is	1798	Returns the row number of the topmost displayed line. Maximum value is
1444	C<0>, which displays the normal terminal contents. Lower values scroll	1799	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1452		1807
1453	Used after changing terminal contents to display them.	1808	Used after changing terminal contents to display them.
1454		1809
1455	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1810	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1456		1811
1457	Returns the text of the entire row with number C<$row_number>. Row C<0>	1812	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1458	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1813	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1459	terminal line. The scrollback buffer starts at line C<-1> and extends to
1460	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1814	terminal line. Nothing will be returned if a nonexistent line
1461	is requested.	1815	is requested.
1462		1816
1463	If C<$new_text> is specified, it will replace characters in the current	1817	If C<$new_text> is specified, it will replace characters in the current
1464	line, starting at column C<$start_col> (default C<0>), which is useful	1818	line, starting at column C<$start_col> (default C<0>), which is useful
1465	to replace only parts of a line. The font index in the rendition will	1819	to replace only parts of a line. The font index in the rendition will
1466	automatically be updated.	1820	automatically be updated.
1467		1821
1468	C<$text> is in a special encoding: tabs and wide characters that use more	1822	C<$text> is in a special encoding: tabs and wide characters that use more
1469	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1823	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1470	characters. Characters with combining characters and other characters that	1824	characters. Characters with combining characters and other characters that
1471	do not fit into the normal tetx encoding will be replaced with characters	1825	do not fit into the normal text encoding will be replaced with characters
1472	in the private use area.	1826	in the private use area.
1473		1827
1474	You have to obey this encoding when changing text. The advantage is	1828	You have to obey this encoding when changing text. The advantage is
1475	that C<substr> and similar functions work on screen cells and not on	1829	that C<substr> and similar functions work on screen cells and not on
1476	characters.	1830	characters.
…		…
1621	where one character corresponds to one screen cell. See	1975	where one character corresponds to one screen cell. See
1622	C<< $term->ROW_t >> for details.	1976	C<< $term->ROW_t >> for details.
1623		1977
1624	=item $string = $term->special_decode $text	1978	=item $string = $term->special_decode $text
1625		1979
1626	Converts rxvt-unicodes text reprsentation into a perl string. See	1980	Converts rxvt-unicodes text representation into a perl string. See
1627	C<< $term->ROW_t >> for details.	1981	C<< $term->ROW_t >> for details.
1628		1982
1629	=item $success = $term->grab_button ($button, $modifiermask)	1983	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1630		1984
		1985	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1986
1631	Registers a synchronous button grab. See the XGrabButton manpage.	1987	Register/unregister a synchronous button grab. See the XGrabButton
		1988	manpage.
1632		1989
1633	=item $success = $term->grab ($eventtime[, $sync])	1990	=item $success = $term->grab ($eventtime[, $sync])
1634		1991
1635	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1992	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1636	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1993	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1637		1994
1638	=item $term->allow_events_async	1995	=item $term->allow_events_async
1639		1996
1640	Calls XAllowEvents with AsyncBoth for the most recent grab.	1997	Calls XAllowEvents with AsyncBoth for the most recent grab.
1641		1998
…		…
1648	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2005	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1649	recent grab.	2006	recent grab.
1650		2007
1651	=item $term->ungrab	2008	=item $term->ungrab
1652		2009
1653	Calls XUngrab for the most recent grab. Is called automatically on	2010	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1654	evaluation errors, as it is better to lose the grab in the error case as	2011	evaluation errors, as it is better to lose the grab in the error case as
1655	the session.	2012	the session.
1656		2013
1657	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2014	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1658		2015
…		…
1660		2017
1661	=item @atoms = $term->XListProperties ($window)	2018	=item @atoms = $term->XListProperties ($window)
1662		2019
1663	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2020	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1664		2021
1665	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2022	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1666		2023
1667	=item $term->XDeleteProperty ($window, $property)	2024	=item $term->XDeleteProperty ($window, $property)
1668		2025
1669	=item $window = $term->DefaultRootWindow	2026	=item $window = $term->DefaultRootWindow
1670		2027
…		…
1677	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2034	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1678		2035
1679	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2036	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1680		2037
1681	=item $term->XChangeInput ($window, $add_events[, $del_events])	2038	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2039
		2040	=item $keysym = $term->XStringToKeysym ($string)
		2041
		2042	=item $string = $term->XKeysymToString ($keysym)
1682		2043
1683	Various X or X-related functions. The C<$term> object only serves as	2044	Various X or X-related functions. The C<$term> object only serves as
1684	the source of the display, otherwise those functions map more-or-less	2045	the source of the display, otherwise those functions map more-or-less
1685	directory onto the X functions of the same name.	2046	directly onto the X functions of the same name.
1686		2047
1687	=back	2048	=back
1688		2049
1689	=cut	2050	=cut
1690		2051
…		…
1754	my ($self, $text, $cb) = @_;	2115	my ($self, $text, $cb) = @_;
1755		2116
1756	$self->add_item ({ type => "button", text => $text, activate => $cb});	2117	$self->add_item ({ type => "button", text => $text, activate => $cb});
1757	}	2118	}
1758		2119
1759	=item $popup->add_toggle ($text, $cb, $initial_value)	2120	=item $popup->add_toggle ($text, $initial_value, $cb)
1760		2121
1761	Adds a toggle/checkbox item to the popup. Teh callback gets called	2122	Adds a toggle/checkbox item to the popup. The callback gets called
1762	whenever it gets toggled, with a boolean indicating its value as its first	2123	whenever it gets toggled, with a boolean indicating its new value as its
1763	argument.	2124	first argument.
1764		2125
1765	=cut	2126	=cut
1766		2127
1767	sub add_toggle {	2128	sub add_toggle {
1768	my ($self, $text, $cb, $value) = @_;	2129	my ($self, $text, $value, $cb) = @_;
1769		2130
1770	my $item; $item = {	2131	my $item; $item = {
1771	type => "button",	2132	type => "button",
1772	text => " $text",	2133	text => " $text",
1773	value => $value,	2134	value => $value,
…		…
1792	my $env = $self->{term}->env;	2153	my $env = $self->{term}->env;
1793	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2154	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1794	delete $env->{LC_ALL};	2155	delete $env->{LC_ALL};
1795	$env->{LC_CTYPE} = $self->{term}->locale;	2156	$env->{LC_CTYPE} = $self->{term}->locale;
1796		2157
1797	urxvt::term->new ($env, "popup",	2158	my $term = urxvt::term->new (
		2159	$env, "popup",
1798	"--perl-lib" => "", "--perl-ext-common" => "",	2160	"--perl-lib" => "", "--perl-ext-common" => "",
1799	"-pty-fd" => -1, "-sl" => 0,	2161	"-pty-fd" => -1, "-sl" => 0,
1800	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2162	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1801	"--transient-for" => $self->{term}->parent,	2163	"--transient-for" => $self->{term}->parent,
1802	"-display" => $self->{term}->display_id,	2164	"-display" => $self->{term}->display_id,
1803	"-pe" => "urxvt-popup")	2165	"-pe" => "urxvt-popup",
1804	or die "unable to create popup window\n";	2166	) or die "unable to create popup window\n";
		2167
		2168	unless (delete $term->{urxvt_popup_init_done}) {
		2169	$term->ungrab;
		2170	$term->destroy;
		2171	die "unable to initialise popup window\n";
		2172	}
1805	}	2173	}
1806		2174
1807	sub DESTROY {	2175	sub DESTROY {
1808	my ($self) = @_;	2176	my ($self) = @_;
1809		2177
…		…
1814	=back	2182	=back
1815		2183
1816	=cut	2184	=cut
1817		2185
1818	package urxvt::watcher;	2186	package urxvt::watcher;
1819
1820	@urxvt::timer::ISA = __PACKAGE__;
1821	@urxvt::iow::ISA = __PACKAGE__;
1822	@urxvt::pw::ISA = __PACKAGE__;
1823	@urxvt::iw::ISA = __PACKAGE__;
1824		2187
1825	=head2 The C<urxvt::timer> Class	2188	=head2 The C<urxvt::timer> Class
1826		2189
1827	This class implements timer watchers/events. Time is represented as a	2190	This class implements timer watchers/events. Time is represented as a
1828	fractional number of seconds since the epoch. Example:	2191	fractional number of seconds since the epoch. Example:
…		…
1832	->new	2195	->new
1833	->interval (1)	2196	->interval (1)
1834	->cb (sub {	2197	->cb (sub {
1835	$term->{overlay}->set (0, 0,	2198	$term->{overlay}->set (0, 0,
1836	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2199	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1837	});	2200	});
1838		2201
1839	=over 4	2202	=over 4
1840		2203
1841	=item $timer = new urxvt::timer	2204	=item $timer = new urxvt::timer
1842		2205
…		…
1845		2208
1846	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2209	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1847		2210
1848	Set the callback to be called when the timer triggers.	2211	Set the callback to be called when the timer triggers.
1849		2212
1850	=item $tstamp = $timer->at
1851
1852	Return the time this watcher will fire next.
1853
1854	=item $timer = $timer->set ($tstamp)	2213	=item $timer = $timer->set ($tstamp[, $interval])
1855		2214
1856	Set the time the event is generated to $tstamp.	2215	Set the time the event is generated to $tstamp (and optionally specifies a
		2216	new $interval).
1857		2217
1858	=item $timer = $timer->interval ($interval)	2218	=item $timer = $timer->interval ($interval)
1859		2219
1860	Normally (and when C<$interval> is C<0>), the timer will automatically	2220	By default (and when C<$interval> is C<0>), the timer will automatically
1861	stop after it has fired once. If C<$interval> is non-zero, then the timer	2221	stop after it has fired once. If C<$interval> is non-zero, then the timer
1862	is automatically rescheduled at the given intervals.	2222	is automatically rescheduled at the given intervals.
1863		2223
1864	=item $timer = $timer->start	2224	=item $timer = $timer->start
1865		2225
1866	Start the timer.	2226	Start the timer.
1867		2227
1868	=item $timer = $timer->start ($tstamp)	2228	=item $timer = $timer->start ($tstamp[, $interval])
1869		2229
1870	Set the event trigger time to C<$tstamp> and start the timer.	2230	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2231	also replaces the interval.
1871		2232
1872	=item $timer = $timer->after ($delay)	2233	=item $timer = $timer->after ($delay[, $interval])
1873		2234
1874	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2235	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1875		2236
1876	=item $timer = $timer->stop	2237	=item $timer = $timer->stop
1877		2238
…		…
1885		2246
1886	$term->{socket} = ...	2247	$term->{socket} = ...
1887	$term->{iow} = urxvt::iow	2248	$term->{iow} = urxvt::iow
1888	->new	2249	->new
1889	->fd (fileno $term->{socket})	2250	->fd (fileno $term->{socket})
1890	->events (urxvt::EVENT_READ)	2251	->events (urxvt::EV_READ)
1891	->start	2252	->start
1892	->cb (sub {	2253	->cb (sub {
1893	my ($iow, $revents) = @_;	2254	my ($iow, $revents) = @_;
1894	# $revents must be 1 here, no need to check	2255	# $revents must be 1 here, no need to check
1895	sysread $term->{socket}, my $buf, 8192	2256	sysread $term->{socket}, my $buf, 8192
…		…
1908	Set the callback to be called when io events are triggered. C<$reventmask>	2269	Set the callback to be called when io events are triggered. C<$reventmask>
1909	is a bitset as described in the C<events> method.	2270	is a bitset as described in the C<events> method.
1910		2271
1911	=item $iow = $iow->fd ($fd)	2272	=item $iow = $iow->fd ($fd)
1912		2273
1913	Set the filedescriptor (not handle) to watch.	2274	Set the file descriptor (not handle) to watch.
1914		2275
1915	=item $iow = $iow->events ($eventmask)	2276	=item $iow = $iow->events ($eventmask)
1916		2277
1917	Set the event mask to watch. The only allowed values are	2278	Set the event mask to watch. The only allowed values are
1918	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2279	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1919	together, or C<urxvt::EVENT_NONE>.	2280	together, or C<urxvt::EV_NONE>.
1920		2281
1921	=item $iow = $iow->start	2282	=item $iow = $iow->start
1922		2283
1923	Start watching for requested events on the given handle.	2284	Start watching for requested events on the given handle.
1924		2285
1925	=item $iow = $iow->stop	2286	=item $iow = $iow->stop
1926		2287
1927	Stop watching for events on the given filehandle.	2288	Stop watching for events on the given file handle.
1928		2289
1929	=back	2290	=back
1930		2291
1931	=head2 The C<urxvt::iw> Class	2292	=head2 The C<urxvt::iw> Class
1932		2293
…		…
1965	->new	2326	->new
1966	->start ($pid)	2327	->start ($pid)
1967	->cb (sub {	2328	->cb (sub {
1968	my ($pw, $exit_status) = @_;	2329	my ($pw, $exit_status) = @_;
1969	...	2330	...
1970	});	2331	});
1971		2332
1972	=over 4	2333	=over 4
1973		2334
1974	=item $pw = new urxvt::pw	2335	=item $pw = new urxvt::pw
1975		2336
…		…
1979		2340
1980	Set the callback to be called when the timer triggers.	2341	Set the callback to be called when the timer triggers.
1981		2342
1982	=item $pw = $timer->start ($pid)	2343	=item $pw = $timer->start ($pid)
1983		2344
1984	Tells the wqtcher to start watching for process C<$pid>.	2345	Tells the watcher to start watching for process C<$pid>.
1985		2346
1986	=item $pw = $pw->stop	2347	=item $pw = $pw->stop
1987		2348
1988	Stop the watcher.	2349	Stop the watcher.
1989		2350
…		…
2002		2363
2003	=item >= 3 - script loading and management	2364	=item >= 3 - script loading and management
2004		2365
2005	=item >=10 - all called hooks	2366	=item >=10 - all called hooks
2006		2367
2007	=item >=11 - hook reutrn values	2368	=item >=11 - hook return values
2008		2369
2009	=back	2370	=back
2010		2371
2011	=head1 AUTHOR	2372	=head1 AUTHOR
2012		2373
2013	Marc Lehmann <pcg@goof.com>	2374	Marc Lehmann <schmorp@schmorp.de>
2014	http://software.schmorp.de/pkg/rxvt-unicode	2375	http://software.schmorp.de/pkg/rxvt-unicode
2015		2376
2016	=cut	2377	=cut
2017		2378
2018	1	2379	1
		2380
		2381	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.129 by root, Wed Jan 25 15:11:31 2006 UTC vs. Revision 1.208 by root, Tue Jun 5 22:23:07 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.129 by root, Wed Jan 25 15:11:31 2006 UTC vs.
Revision 1.208 by root, Tue Jun 5 22:23:07 2012 UTC