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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.144 by root, Mon Aug 7 15:59:44 2006 UTC vs.
Revision 1.205 by root, Tue Jun 5 19:32:29 2012 UTC

…		…
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
…		…
98		101
99	Other extensions can extend this popup menu by pushing a code reference	102	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the	103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.	104	popup is being displayed.
102		105
103	It's sole argument is the popup menu, which can be modified. It should	106	Its sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code	107	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference	108	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as	109	will be called when the toggle changes, with the new boolean value as
107	first argument.	110	first argument.
108		111
109	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
111		114
112	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};	117	};
115		118
…		…
121		124
122	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
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.	127	popup is being displayed.
125		128
126	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
127	is in C<$_>, which can be used to decide whether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
128	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
129	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
130	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
131		134
132	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
133	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
134	C<a>s:	137	C<a>s:
135		138
136	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
138	: ()	141	: ()
139	};	142	};
140		143
141	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
142		145
…		…
149	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>
150	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
151	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
152	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
153	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
154	selection.	157	selection if the C<Shift> modifier is active.
155		158
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To	159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>	160	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.	161	or simply use an uppercase character which removes the "(?i)" prefix.
159		162
…		…
162	=item readline (enabled by default)	165	=item readline (enabled by default)
163		166
164	A support package that tries to make editing with readline easier. At	167	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
166	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
167	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
168	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
169		172
170	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
171		174
172	=over 4	175	=over 4
…		…
240	URxvt.tabbed.tab-bg: <colour-index, default 1>	243	URxvt.tabbed.tab-bg: <colour-index, default 1>
241		244
242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid	245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243	indices.	246	indices.
244		247
245	=item mark-urls	248	=item matcher
246		249
247	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
248	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
249	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
250	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
251		278
252	=item xim-onthespot	279	=item xim-onthespot
253		280
254	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
255	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
256	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
257	kinput2.	284	kinput2.
258		285
259	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
260	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
261		288
…		…
269	will show or hide itself. Another press of the accelerator key will hide	296	will show or hide itself. Another press of the accelerator key will hide
270	or show it again.	297	or show it again.
271		298
272	Initially, the window will not be shown when using this extension.	299	Initially, the window will not be shown when using this extension.
273		300
274	This is useful if you need a single terminal thats not using any desktop	301	This is useful if you need a single terminal that is not using any desktop
275	space most of the time but is quickly available at the press of a key.	302	space most of the time but is quickly available at the press of a key.
276		303
277	The accelerator key is grabbed regardless of any modifiers, so this	304	The accelerator key is grabbed regardless of any modifiers, so this
278	extension will actually grab a physical key just for this function.	305	extension will actually grab a physical key just for this function.
279		306
280	If you want a quake-like animation, tell your window manager to do so	307	If you want a quake-like animation, tell your window manager to do so
281	(fvwm can do it).	308	(fvwm can do it).
282		309
283	=item automove-background	310	=item overlay-osc
284		311
285	This is basically a very small extension that dynamically changes the	312	This extension implements some OSC commands to display timed popups on the
286	background pixmap offset to the window position, in effect creating the	313	screen - useful for status displays from within scripts. You have to read
287	same effect as pseudo transparency with a custom pixmap. No scaling is	314	the sources for more info.
288	supported in this mode. Example:
289
290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291		315
292	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
293		317
294	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
295	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
…		…
300	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
301		325
302	=item remote-clipboard	326	=item remote-clipboard
303		327
304	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
305	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
306	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
307		331
308	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
309	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
310	reads it.	334	reads it.
…		…
319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321		345
322	=item selection-pastebin	346	=item selection-pastebin
323		347
324	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
325	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
326	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
327	F</tmp> directly.).	351	F</tmp> directly.).
328		352
329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
346	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
347	for the filename):	371	for the filename):
348		372
349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350		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
351	=item example-refresh-hooks	394	=item example-refresh-hooks
352		395
353	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
354	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
355	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"
356		412
357	=back	413	=back
358		414
359	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
360		416
…		…
376		432
377	=over 4	433	=over 4
378		434
379	=item $text	435	=item $text
380		436
381	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
382	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.
383		439
384	=item $string	440	=item $string
385		441
386	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
…		…
390	=item $octets	446	=item $octets
391		447
392	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
393	locale-specific way.	449	locale-specific way.
394		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
395	=back	457	=back
396		458
397	=head2 Extension Objects	459	=head2 Extension Objects
398		460
399	Every 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
400	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,
401	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
402	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
403	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
404	use.	467	internal use.
405		468
406	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
407	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
408		471
409	It has the following methods and data members:	472	It has the following methods and data members:
…		…
519		582
520	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,
521	$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
522	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
523		586
524	=item on_osc_seq $term, $op, $args	587	=item on_osc_seq $term, $op, $args, $resp
525		588
526	Called on every OSC sequence and can be used to suppress it or modify its	589	Called on every OSC sequence and can be used to suppress it or modify its
527	behaviour. The default should be to return an empty list. A true value	590	behaviour. The default should be to return an empty list. A true value
528	suppresses execution of the request completely. Make sure you don't get	591	suppresses execution of the request completely. Make sure you don't get
529	confused by recursive invocations when you output an osc sequence within	592	confused by recursive invocations when you output an OSC sequence within
530	this callback.	593	this callback.
531		594
532	C<on_osc_seq_perl> should be used for new behaviour.	595	C<on_osc_seq_perl> should be used for new behaviour.
533		596
534	=item on_osc_seq_perl $term, $string	597	=item on_osc_seq_perl $term, $args, $resp
535		598
536	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
537	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
538	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
539	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,
540	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
541	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	}
542		615
543	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,
544	as its source can not easily be controlled (e-mail content, messages from	617	as its source can not easily be controlled (e-mail content, messages from
545	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.
546		622
547	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
548		624
549	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
550	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
…		…
555	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
556		632
557	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
558	suppress or filter tty input.	634	suppress or filter tty input.
559		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
560	=item on_line_update $term, $row	643	=item on_line_update $term, $row
561		644
562	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
563	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
564	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,
…		…
571	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
572	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
573		656
574	=item on_refresh_begin $term	657	=item on_refresh_begin $term
575		658
576	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
577	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
578	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
579	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
580		663
581	=item on_refresh_end $term	664	=item on_refresh_end $term
582		665
…		…
589	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
590		673
591	The event is simply the action string. This interface is assumed to change	674	The event is simply the action string. This interface is assumed to change
592	slightly in the future.	675	slightly in the future.
593		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
594	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
595		685
596	Called just after the new window size has been calculated, but before	686	Called just after the new window size has been calculated, but before
597	windows are actually being resized or hints are being set. If this hook	687	windows are actually being resized or hints are being set. If this hook
598	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
599		689
…		…
633		723
634	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
635		725
636	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
637		727
638	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
639	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.
640		730
641	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
642	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
643	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
644		734
…		…
653		743
654	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
655		745
656	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
657	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.
658		752
659	=back	753	=back
660		754
661	=cut	755	=cut
662		756
…		…
727		821
728	=over 4	822	=over 4
729		823
730	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
731		825
732	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
733	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
734	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
735		830
736	=item urxvt::warn $string	831	=item urxvt::warn $string
737		832
738	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
739	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
740	that calls this function.	835	that calls this function.
741		836
742	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
743	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
747	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
748		843
749	Returns all urxvt::term objects that exist in this process, regardless of	844	Returns all urxvt::term objects that exist in this process, regardless of
750	whether they are started, being destroyed etc., so be careful. Only term	845	whether they are started, being destroyed etc., so be careful. Only term
751	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
752	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
753		848
754	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
755		850
756	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
757		852
…		…
800		895
801	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
802		897
803	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
804		899
805	=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
806		902
807	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
808	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
809	the bitset.	905	the bitset.
810		906
…		…
892	sub invoke {	988	sub invoke {
893	local $TERM = shift;	989	local $TERM = shift;
894	my $htype = shift;	990	my $htype = shift;
895		991
896	if ($htype == 0) { # INIT	992	if ($htype == 0) { # INIT
897	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	993	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
898		994
899	my %ext_arg;	995	my %ext_arg;
900		996
901	{	997	{
902	my @init = @TERM_INIT;	998	my @init = @TERM_INIT;
903	@TERM_INIT = ();	999	@TERM_INIT = ();
…		…
966		1062
967	sub SET_COLOR($$$) {	1063	sub SET_COLOR($$$) {
968	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1064	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
969	}	1065	}
970		1066
		1067	sub rend2mask {
		1068	no strict 'refs';
		1069	my ($str, $mask) = (@_, 0);
		1070	my %color = ( fg => undef, bg => undef );
		1071	my @failed;
		1072	for my $spec ( split /\s+/, $str ) {
		1073	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1074	$color{lc($1)} = $2;
		1075	} else {
		1076	my $neg = $spec =~ s/^[-^]//;
		1077	unless ( exists &{"RS_$spec"} ) {
		1078	push @failed, $spec;
		1079	next;
		1080	}
		1081	my $cur = &{"RS_$spec"};
		1082	if ( $neg ) {
		1083	$mask &= ~$cur;
		1084	} else {
		1085	$mask \|= $cur;
		1086	}
		1087	}
		1088	}
		1089	($mask, @color{qw(fg bg)}, \@failed)
		1090	}
		1091
971	# urxvt::term::extension	1092	# urxvt::term::extension
972		1093
973	package urxvt::term::extension;	1094	package urxvt::term::extension;
974		1095
975	sub enable {	1096	sub enable {
…		…
979	while (my ($name, $cb) = each %hook) {	1100	while (my ($name, $cb) = each %hook) {
980	my $htype = $HOOKTYPE{uc $name};	1101	my $htype = $HOOKTYPE{uc $name};
981	defined $htype	1102	defined $htype
982	or Carp::croak "unsupported hook type '$name'";	1103	or Carp::croak "unsupported hook type '$name'";
983		1104
984	$self->set_should_invoke ($htype, +1)	1105	$self->modify_should_invoke_count ($htype, +1)
985	unless exists $self->{term}{_hook}[$htype]{$pkg};	1106	unless exists $self->{term}{_hook}[$htype]{$pkg};
986		1107
987	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1108	$self->{term}{_hook}[$htype]{$pkg} = $cb;
988	}	1109	}
989	}	1110	}
…		…
995	for my $name (@hook) {	1116	for my $name (@hook) {
996	my $htype = $HOOKTYPE{uc $name};	1117	my $htype = $HOOKTYPE{uc $name};
997	defined $htype	1118	defined $htype
998	or Carp::croak "unsupported hook type '$name'";	1119	or Carp::croak "unsupported hook type '$name'";
999		1120
1000	$self->set_should_invoke ($htype, -1)	1121	$self->modify_should_invoke_count ($htype, -1)
1001	if delete $self->{term}{_hook}[$htype]{$pkg};	1122	if delete $self->{term}{_hook}[$htype]{$pkg};
1002	}	1123	}
1003	}	1124	}
1004		1125
1005	our $AUTOLOAD;	1126	our $AUTOLOAD;
…		…
1044	is that you cannot use blocking APIs, but the non-blocking variant should	1165	is that you cannot use blocking APIs, but the non-blocking variant should
1045	work.	1166	work.
1046		1167
1047	=cut	1168	=cut
1048		1169
1049	our $VERSION = 1;	1170	our $VERSION = '5.23';
1050		1171
1051	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1172	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1052	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1173	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1053		1174
1054	sub timer {	1175	sub timer {
…		…
1056		1177
1057	my $cb = $arg{cb};	1178	my $cb = $arg{cb};
1058		1179
1059	urxvt::timer	1180	urxvt::timer
1060	->new	1181	->new
1061	->start (urxvt::NOW + $arg{after})	1182	->after ($arg{after}, $arg{interval})
1062	->cb (sub {	1183	->cb ($arg{interval} ? $cb : sub {
1063	$_[0]->stop; # need to cancel manually	1184	$_[0]->stop; # need to cancel manually
1064	$cb->();	1185	$cb->();
1065	})	1186	})
1066	}	1187	}
1067		1188
1068	sub io {	1189	sub io {
1069	my ($class, %arg) = @_;	1190	my ($class, %arg) = @_;
1070		1191
1071	my $cb = $arg{cb};	1192	my $cb = $arg{cb};
		1193	my $fd = fileno $arg{fh};
		1194	defined $fd or $fd = $arg{fh};
1072		1195
1073	bless [$arg{fh}, urxvt::iow	1196	bless [$arg{fh}, urxvt::iow
1074	->new	1197	->new
1075	->fd (fileno $arg{fh})	1198	->fd ($fd)
1076	->events (($arg{poll} =~ /r/ ? 1 : 0)	1199	->events (($arg{poll} =~ /r/ ? 1 : 0)
1077	\| ($arg{poll} =~ /w/ ? 2 : 0))	1200	\| ($arg{poll} =~ /w/ ? 2 : 0))
1078	->start	1201	->start
1079	->cb (sub {	1202	->cb ($cb)
1080	$cb->(($_[1] & 1 ? 'r' : '')
1081	. ($_[1] & 2 ? 'w' : ''));
1082	})],
1083	urxvt::anyevent::	1203	], urxvt::anyevent::
		1204	}
		1205
		1206	sub idle {
		1207	my ($class, %arg) = @_;
		1208
		1209	my $cb = $arg{cb};
		1210
		1211	urxvt::iw
		1212	->new
		1213	->start
		1214	->cb ($cb)
		1215	}
		1216
		1217	sub child {
		1218	my ($class, %arg) = @_;
		1219
		1220	my $cb = $arg{cb};
		1221
		1222	urxvt::pw
		1223	->new
		1224	->start ($arg{pid})
		1225	->cb (sub {
		1226	$_[0]->stop; # need to cancel manually
		1227	$cb->($_[0]->rpid, $_[0]->rstatus);
		1228	})
1084	}	1229	}
1085		1230
1086	sub DESTROY {	1231	sub DESTROY {
1087	$_[0][1]->stop;	1232	$_[0][1]->stop;
1088	}	1233	}
1089		1234
1090	sub condvar {	1235	# only needed for AnyEvent < 6 compatibility
1091	bless \my $flag, urxvt::anyevent::condvar::	1236	sub one_event {
1092	}
1093
1094	sub urxvt::anyevent::condvar::broadcast {
1095	${$_[0]}++;
1096	}
1097
1098	sub urxvt::anyevent::condvar::wait {
1099	unless (${$_[0]}) {
1100	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1237	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1101	}
1102	}	1238	}
1103		1239
1104	package urxvt::term;	1240	package urxvt::term;
1105		1241
1106	=head2 The C<urxvt::term> Class	1242	=head2 The C<urxvt::term> Class
…		…
1196	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1332	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1197		1333
1198	Here is a likely non-exhaustive list of option names, please see the	1334	Here is a likely non-exhaustive list of option names, please see the
1199	source file F</src/optinc.h> to see the actual list:	1335	source file F</src/optinc.h> to see the actual list:
1200		1336
1201	borderLess console cursorBlink cursorUnderline hold iconic insecure	1337	borderLess buffered console cursorBlink cursorUnderline hold iconic
1202	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1338	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1203	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1339	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1204	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1340	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1205	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1341	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1206	transparent tripleclickwords utmpInhibit visualBell	1342	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1343	urgentOnBell utmpInhibit visualBell
1207		1344
1208	=item $value = $term->resource ($name[, $newval])	1345	=item $value = $term->resource ($name[, $newval])
1209		1346
1210	Returns the current resource value associated with a given name and	1347	Returns the current resource value associated with a given name and
1211	optionally sets a new value. Setting values is most useful in the C<init>	1348	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1224		1361
1225	Here is a likely non-exhaustive list of resource names, not all of which	1362	Here is a likely non-exhaustive list of resource names, not all of which
1226	are supported in every build, please see the source file F</src/rsinc.h>	1363	are supported in every build, please see the source file F</src/rsinc.h>
1227	to see the actual list:	1364	to see the actual list:
1228		1365
1229	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1366	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1230	borderLess color cursorBlink cursorUnderline cutchars delete_key	1367	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1231	display_name embed ext_bwidth fade font geometry hold iconName	1368	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1232	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1369	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1370	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1233	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1371	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1234	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1372	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1235	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1373	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1236	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1374	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1237	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1375	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1238	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1376	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1239	secondaryScreen secondaryScroll selectstyle shade term_name title	1377	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1240	transient_for transparent transparent_all tripleclickwords utmpInhibit	1378	term_name title transient_for transparent tripleclickwords urgentOnBell
1241	visualBell	1379	utmpInhibit visualBell
1242		1380
1243	=cut	1381	=cut
1244		1382
1245	sub resource($$;$) {	1383	sub resource($$;$) {
1246	my ($self, $name) = (shift, shift);	1384	my ($self, $name) = (shift, shift);
1247	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1385	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1248	&urxvt::term::_resource	1386	goto &urxvt::term::_resource
1249	}	1387	}
1250		1388
1251	=item $value = $term->x_resource ($pattern)	1389	=item $value = $term->x_resource ($pattern)
1252		1390
1253	Returns the X-Resource for the given pattern, excluding the program or	1391	Returns the X-Resource for the given pattern, excluding the program or
…		…
1257		1395
1258	This method should only be called during the C<on_start> hook, as there is	1396	This method should only be called during the C<on_start> hook, as there is
1259	only one resource database per display, and later invocations might return	1397	only one resource database per display, and later invocations might return
1260	the wrong resources.	1398	the wrong resources.
1261		1399
1262	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1400	=item $success = $term->parse_keysym ($key, $octets)
1263		1401
1264	Adds a keymap translation exactly as specified via a resource. See the	1402	Adds a key binding exactly as specified via a resource. See the
1265	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1403	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1404
		1405	=item $term->register_command ($keysym, $modifiermask, $string)
		1406
		1407	Adds a key binding. This is a lower level api compared to
		1408	C<parse_keysym>, as it expects a parsed key description, and can be
		1409	used only inside either the C<on_init> hook, to add a binding, or the
		1410	C<on_register_command> hook, to modify a parsed binding.
1266		1411
1267	=item $rend = $term->rstyle ([$new_rstyle])	1412	=item $rend = $term->rstyle ([$new_rstyle])
1268		1413
1269	Return and optionally change the current rendition. Text that is output by	1414	Return and optionally change the current rendition. Text that is output by
1270	the terminal application will use this style.	1415	the terminal application will use this style.
…		…
1278		1423
1279	=item ($row, $col) = $term->selection_beg ([$row, $col])	1424	=item ($row, $col) = $term->selection_beg ([$row, $col])
1280		1425
1281	=item ($row, $col) = $term->selection_end ([$row, $col])	1426	=item ($row, $col) = $term->selection_end ([$row, $col])
1282		1427
1283	Return the current values of the selection mark, begin or end positions,	1428	Return the current values of the selection mark, begin or end positions.
1284	and optionally set them to new values.	1429
		1430	When arguments are given, then the selection coordinates are set to
		1431	C<$row> and C<$col>, and the selection screen is set to the current
		1432	screen.
		1433
		1434	=item $screen = $term->selection_screen ([$screen])
		1435
		1436	Returns the current selection screen, and then optionally sets it.
1285		1437
1286	=item $term->selection_make ($eventtime[, $rectangular])	1438	=item $term->selection_make ($eventtime[, $rectangular])
1287		1439
1288	Tries to make a selection as set by C<selection_beg> and	1440	Tries to make a selection as set by C<selection_beg> and
1289	C<selection_end>. If C<$rectangular> is true (default: false), a	1441	C<selection_end>. If C<$rectangular> is true (default: false), a
1290	rectangular selection will be made. This is the prefered function to make	1442	rectangular selection will be made. This is the preferred function to make
1291	a selection.	1443	a selection.
1292		1444
1293	=item $success = $term->selection_grab ($eventtime)	1445	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1294		1446
1295	Try to request the primary selection text from the server (for example, as	1447	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1448	true) selection from the server. The corresponding text can be set
1296	set by the next method). No visual feedback will be given. This function	1449	with the next method. No visual feedback will be given. This function
1297	is mostly useful from within C<on_sel_grab> hooks.	1450	is mostly useful from within C<on_sel_grab> hooks.
1298		1451
1299	=item $oldtext = $term->selection ([$newtext])	1452	=item $oldtext = $term->selection ([$newtext, $clipboard])
1300		1453
1301	Return the current selection text and optionally replace it by C<$newtext>.	1454	Return the current selection (clipboard if C<$clipboard> is true) text
		1455	and optionally replace it by C<$newtext>.
		1456
		1457	=item $term->selection_clear ([$clipboard])
		1458
		1459	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1302		1460
1303	=item $term->overlay_simple ($x, $y, $text)	1461	=item $term->overlay_simple ($x, $y, $text)
1304		1462
1305	Create a simple multi-line overlay box. See the next method for details.	1463	Create a simple multi-line overlay box. See the next method for details.
1306		1464
…		…
1336		1494
1337	The methods currently supported on C<urxvt::overlay> objects are:	1495	The methods currently supported on C<urxvt::overlay> objects are:
1338		1496
1339	=over 4	1497	=over 4
1340		1498
1341	=item $overlay->set ($x, $y, $text, $rend)	1499	=item $overlay->set ($x, $y, $text[, $rend])
1342		1500
1343	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1501	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1344	text in rxvt-unicode's special encoding and an array of rendition values	1502	text in rxvt-unicode's special encoding and an array of rendition values
1345	at a specific position inside the overlay.	1503	at a specific position inside the overlay.
		1504
		1505	If C<$rend> is missing, then the rendition will not be changed.
1346		1506
1347	=item $overlay->hide	1507	=item $overlay->hide
1348		1508
1349	If visible, hide the overlay, but do not destroy it.	1509	If visible, hide the overlay, but do not destroy it.
1350		1510
…		…
1432	locale-specific encoding of the terminal and can contain command sequences	1592	locale-specific encoding of the terminal and can contain command sequences
1433	(escape codes) that will be interpreted.	1593	(escape codes) that will be interpreted.
1434		1594
1435	=item $term->tt_write ($octets)	1595	=item $term->tt_write ($octets)
1436		1596
1437	Write the octets given in C<$data> to the tty (i.e. as program input). To	1597	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1438	pass characters instead of octets, you should convert your strings first	1598	pass characters instead of octets, you should convert your strings first
1439	to the locale-specific encoding using C<< $term->locale_encode >>.	1599	to the locale-specific encoding using C<< $term->locale_encode >>.
		1600
		1601	=item $term->tt_paste ($octets)
		1602
		1603	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1604	CR and bracketing the data with control sequences if bracketed paste mode
		1605	is set.
1440		1606
1441	=item $old_events = $term->pty_ev_events ([$new_events])	1607	=item $old_events = $term->pty_ev_events ([$new_events])
1442		1608
1443	Replaces the event mask of the pty watcher by the given event mask. Can	1609	Replaces the event mask of the pty watcher by the given event mask. Can
1444	be used to suppress input and output handling to the pty/tty. See the	1610	be used to suppress input and output handling to the pty/tty. See the
…		…
1463	Adds the specified events to the vt event mask. Useful e.g. when you want	1629	Adds the specified events to the vt event mask. Useful e.g. when you want
1464	to receive pointer events all the times:	1630	to receive pointer events all the times:
1465		1631
1466	$term->vt_emask_add (urxvt::PointerMotionMask);	1632	$term->vt_emask_add (urxvt::PointerMotionMask);
1467		1633
		1634	=item $term->set_urgency ($set)
		1635
		1636	Enable/disable the urgency hint on the toplevel window.
		1637
1468	=item $term->focus_in	1638	=item $term->focus_in
1469		1639
1470	=item $term->focus_out	1640	=item $term->focus_out
1471		1641
1472	=item $term->key_press ($state, $keycode[, $time])	1642	=item $term->key_press ($state, $keycode[, $time])
…		…
1560		1730
1561	Used after changing terminal contents to display them.	1731	Used after changing terminal contents to display them.
1562		1732
1563	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1733	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1564		1734
1565	Returns the text of the entire row with number C<$row_number>. Row C<0>	1735	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1566	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1736	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1567	terminal line. The scrollback buffer starts at line C<-1> and extends to
1568	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1737	terminal line. Nothing will be returned if a nonexistent line
1569	is requested.	1738	is requested.
1570		1739
1571	If C<$new_text> is specified, it will replace characters in the current	1740	If C<$new_text> is specified, it will replace characters in the current
1572	line, starting at column C<$start_col> (default C<0>), which is useful	1741	line, starting at column C<$start_col> (default C<0>), which is useful
1573	to replace only parts of a line. The font index in the rendition will	1742	to replace only parts of a line. The font index in the rendition will
1574	automatically be updated.	1743	automatically be updated.
1575		1744
1576	C<$text> is in a special encoding: tabs and wide characters that use more	1745	C<$text> is in a special encoding: tabs and wide characters that use more
1577	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1746	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1578	characters. Characters with combining characters and other characters that	1747	characters. Characters with combining characters and other characters that
1579	do not fit into the normal tetx encoding will be replaced with characters	1748	do not fit into the normal text encoding will be replaced with characters
1580	in the private use area.	1749	in the private use area.
1581		1750
1582	You have to obey this encoding when changing text. The advantage is	1751	You have to obey this encoding when changing text. The advantage is
1583	that C<substr> and similar functions work on screen cells and not on	1752	that C<substr> and similar functions work on screen cells and not on
1584	characters.	1753	characters.
…		…
1759	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1928	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1760	recent grab.	1929	recent grab.
1761		1930
1762	=item $term->ungrab	1931	=item $term->ungrab
1763		1932
1764	Calls XUngrab for the most recent grab. Is called automatically on	1933	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1765	evaluation errors, as it is better to lose the grab in the error case as	1934	evaluation errors, as it is better to lose the grab in the error case as
1766	the session.	1935	the session.
1767		1936
1768	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1937	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1769		1938
…		…
1771		1940
1772	=item @atoms = $term->XListProperties ($window)	1941	=item @atoms = $term->XListProperties ($window)
1773		1942
1774	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1943	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1775		1944
1776	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1945	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1777		1946
1778	=item $term->XDeleteProperty ($window, $property)	1947	=item $term->XDeleteProperty ($window, $property)
1779		1948
1780	=item $window = $term->DefaultRootWindow	1949	=item $window = $term->DefaultRootWindow
1781		1950
…		…
1788	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1957	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1789		1958
1790	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1959	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1791		1960
1792	=item $term->XChangeInput ($window, $add_events[, $del_events])	1961	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1962
		1963	=item $keysym = $term->XStringToKeysym ($string)
		1964
		1965	=item $string = $term->XKeysymToString ($keysym)
1793		1966
1794	Various X or X-related functions. The C<$term> object only serves as	1967	Various X or X-related functions. The C<$term> object only serves as
1795	the source of the display, otherwise those functions map more-or-less	1968	the source of the display, otherwise those functions map more-or-less
1796	directory onto the X functions of the same name.	1969	directly onto the X functions of the same name.
1797		1970
1798	=back	1971	=back
1799		1972
1800	=cut	1973	=cut
1801		1974
…		…
1903	my $env = $self->{term}->env;	2076	my $env = $self->{term}->env;
1904	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2077	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1905	delete $env->{LC_ALL};	2078	delete $env->{LC_ALL};
1906	$env->{LC_CTYPE} = $self->{term}->locale;	2079	$env->{LC_CTYPE} = $self->{term}->locale;
1907		2080
1908	urxvt::term->new ($env, "popup",	2081	my $term = urxvt::term->new (
		2082	$env, "popup",
1909	"--perl-lib" => "", "--perl-ext-common" => "",	2083	"--perl-lib" => "", "--perl-ext-common" => "",
1910	"-pty-fd" => -1, "-sl" => 0,	2084	"-pty-fd" => -1, "-sl" => 0,
1911	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2085	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1912	"--transient-for" => $self->{term}->parent,	2086	"--transient-for" => $self->{term}->parent,
1913	"-display" => $self->{term}->display_id,	2087	"-display" => $self->{term}->display_id,
1914	"-pe" => "urxvt-popup")	2088	"-pe" => "urxvt-popup",
1915	or die "unable to create popup window\n";	2089	) or die "unable to create popup window\n";
		2090
		2091	unless (delete $term->{urxvt_popup_init_done}) {
		2092	$term->ungrab;
		2093	$term->destroy;
		2094	die "unable to initialise popup window\n";
		2095	}
1916	}	2096	}
1917		2097
1918	sub DESTROY {	2098	sub DESTROY {
1919	my ($self) = @_;	2099	my ($self) = @_;
1920		2100
…		…
1925	=back	2105	=back
1926		2106
1927	=cut	2107	=cut
1928		2108
1929	package urxvt::watcher;	2109	package urxvt::watcher;
1930
1931	@urxvt::timer::ISA = __PACKAGE__;
1932	@urxvt::iow::ISA = __PACKAGE__;
1933	@urxvt::pw::ISA = __PACKAGE__;
1934	@urxvt::iw::ISA = __PACKAGE__;
1935		2110
1936	=head2 The C<urxvt::timer> Class	2111	=head2 The C<urxvt::timer> Class
1937		2112
1938	This class implements timer watchers/events. Time is represented as a	2113	This class implements timer watchers/events. Time is represented as a
1939	fractional number of seconds since the epoch. Example:	2114	fractional number of seconds since the epoch. Example:
…		…
1943	->new	2118	->new
1944	->interval (1)	2119	->interval (1)
1945	->cb (sub {	2120	->cb (sub {
1946	$term->{overlay}->set (0, 0,	2121	$term->{overlay}->set (0, 0,
1947	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2122	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1948	});	2123	});
1949		2124
1950	=over 4	2125	=over 4
1951		2126
1952	=item $timer = new urxvt::timer	2127	=item $timer = new urxvt::timer
1953		2128
…		…
1956		2131
1957	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2132	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1958		2133
1959	Set the callback to be called when the timer triggers.	2134	Set the callback to be called when the timer triggers.
1960		2135
1961	=item $tstamp = $timer->at
1962
1963	Return the time this watcher will fire next.
1964
1965	=item $timer = $timer->set ($tstamp)	2136	=item $timer = $timer->set ($tstamp[, $interval])
1966		2137
1967	Set the time the event is generated to $tstamp.	2138	Set the time the event is generated to $tstamp (and optionally specifies a
		2139	new $interval).
1968		2140
1969	=item $timer = $timer->interval ($interval)	2141	=item $timer = $timer->interval ($interval)
1970		2142
1971	Normally (and when C<$interval> is C<0>), the timer will automatically	2143	By default (and when C<$interval> is C<0>), the timer will automatically
1972	stop after it has fired once. If C<$interval> is non-zero, then the timer	2144	stop after it has fired once. If C<$interval> is non-zero, then the timer
1973	is automatically rescheduled at the given intervals.	2145	is automatically rescheduled at the given intervals.
1974		2146
1975	=item $timer = $timer->start	2147	=item $timer = $timer->start
1976		2148
1977	Start the timer.	2149	Start the timer.
1978		2150
1979	=item $timer = $timer->start ($tstamp)	2151	=item $timer = $timer->start ($tstamp[, $interval])
1980		2152
1981	Set the event trigger time to C<$tstamp> and start the timer.	2153	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2154	also replaces the interval.
1982		2155
1983	=item $timer = $timer->after ($delay)	2156	=item $timer = $timer->after ($delay[, $interval])
1984		2157
1985	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2158	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1986		2159
1987	=item $timer = $timer->stop	2160	=item $timer = $timer->stop
1988		2161
…		…
1996		2169
1997	$term->{socket} = ...	2170	$term->{socket} = ...
1998	$term->{iow} = urxvt::iow	2171	$term->{iow} = urxvt::iow
1999	->new	2172	->new
2000	->fd (fileno $term->{socket})	2173	->fd (fileno $term->{socket})
2001	->events (urxvt::EVENT_READ)	2174	->events (urxvt::EV_READ)
2002	->start	2175	->start
2003	->cb (sub {	2176	->cb (sub {
2004	my ($iow, $revents) = @_;	2177	my ($iow, $revents) = @_;
2005	# $revents must be 1 here, no need to check	2178	# $revents must be 1 here, no need to check
2006	sysread $term->{socket}, my $buf, 8192	2179	sysread $term->{socket}, my $buf, 8192
…		…
2024	Set the file descriptor (not handle) to watch.	2197	Set the file descriptor (not handle) to watch.
2025		2198
2026	=item $iow = $iow->events ($eventmask)	2199	=item $iow = $iow->events ($eventmask)
2027		2200
2028	Set the event mask to watch. The only allowed values are	2201	Set the event mask to watch. The only allowed values are
2029	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2202	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2030	together, or C<urxvt::EVENT_NONE>.	2203	together, or C<urxvt::EV_NONE>.
2031		2204
2032	=item $iow = $iow->start	2205	=item $iow = $iow->start
2033		2206
2034	Start watching for requested events on the given handle.	2207	Start watching for requested events on the given handle.
2035		2208
…		…
2076	->new	2249	->new
2077	->start ($pid)	2250	->start ($pid)
2078	->cb (sub {	2251	->cb (sub {
2079	my ($pw, $exit_status) = @_;	2252	my ($pw, $exit_status) = @_;
2080	...	2253	...
2081	});	2254	});
2082		2255
2083	=over 4	2256	=over 4
2084		2257
2085	=item $pw = new urxvt::pw	2258	=item $pw = new urxvt::pw
2086		2259
…		…
2119		2292
2120	=back	2293	=back
2121		2294
2122	=head1 AUTHOR	2295	=head1 AUTHOR
2123		2296
2124	Marc Lehmann <pcg@goof.com>	2297	Marc Lehmann <schmorp@schmorp.de>
2125	http://software.schmorp.de/pkg/rxvt-unicode	2298	http://software.schmorp.de/pkg/rxvt-unicode
2126		2299
2127	=cut	2300	=cut
2128		2301
2129	1	2302	1
		2303
		2304	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.144 by root, Mon Aug 7 15:59:44 2006 UTC vs. Revision 1.205 by root, Tue Jun 5 19:32:29 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.144 by root, Mon Aug 7 15:59:44 2006 UTC vs.
Revision 1.205 by root, Tue Jun 5 19:32:29 2012 UTC