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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.146 by root, Thu Aug 17 21:56:11 2006 UTC vs.
Revision 1.217 by root, Sun Jun 10 13:58:05 2012 UTC

…		…
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Every time 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 "vars"' 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
…		…
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,
…		…
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
351	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret	375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
352	the double C</> characters as comment start. Use C<\057\057> instead,	376	the double C</> characters as comment start. Use C<\057\057> instead,
353	which works regardless of wether xrdb is used to parse the resource file	377	which works regardless of whether xrdb is used to parse the resource file
354	or not.	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.
355		393
356	=item example-refresh-hooks	394	=item example-refresh-hooks
357		395
358	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
359	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
360	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"
361		412
362	=back	413	=back
363		414
364	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
365		416
…		…
381		432
382	=over 4	433	=over 4
383		434
384	=item $text	435	=item $text
385		436
386	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
387	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.
388		439
389	=item $string	440	=item $string
390		441
391	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
…		…
395	=item $octets	446	=item $octets
396		447
397	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
398	locale-specific way.	449	locale-specific way.
399		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
400	=back	457	=back
401		458
402	=head2 Extension Objects	459	=head2 Extension Objects
403		460
404	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
405	for each terminal, and each terminal has its own set of extenion objects,	462	for each terminal, and each terminal has its own set of extension objects,
406	which are passed as the first parameter to hooks. So extensions can use	463	which are passed as the first parameter to hooks. So extensions can use
407	their C<$self> object without having to think about clashes with other	464	their C<$self> object without having to think about clashes with other
408	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
409	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
410	internal use.	467	internal use.
…		…
525		582
526	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,
527	$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
528	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
529		586
530	=item on_osc_seq $term, $op, $args	587	=item on_osc_seq $term, $op, $args, $resp
531		588
532	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
533	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
534	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
535	confused by recursive invocations when you output an osc sequence within	592	confused by recursive invocations when you output an OSC sequence within
536	this callback.	593	this callback.
537		594
538	C<on_osc_seq_perl> should be used for new behaviour.	595	C<on_osc_seq_perl> should be used for new behaviour.
539		596
540	=item on_osc_seq_perl $term, $string	597	=item on_osc_seq_perl $term, $args, $resp
541		598
542	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
543	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
544	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
545	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,
546	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
547	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	}
548		615
549	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,
550	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
551	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.
552		622
553	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
554		624
555	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
556	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
…		…
561	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
562		632
563	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
564	suppress or filter tty input.	634	suppress or filter tty input.
565		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
566	=item on_line_update $term, $row	643	=item on_line_update $term, $row
567		644
568	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
569	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
570	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,
…		…
577	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
578	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
579		656
580	=item on_refresh_begin $term	657	=item on_refresh_begin $term
581		658
582	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
583	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
584	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
585	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
586		663
587	=item on_refresh_end $term	664	=item on_refresh_end $term
588		665
…		…
595	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
596		673
597	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
598	slightly in the future.	675	slightly in the future.
599		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
600	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
601		685
602	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
603	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
604	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
605		689
…		…
639		723
640	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
641		725
642	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
643		727
644	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
645	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.
646		730
647	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
648	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
649	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
650		734
…		…
660	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
661		745
662	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
663	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
664		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
		752
665	=back	753	=back
666		754
667	=cut	755	=cut
668		756
669	package urxvt;	757	package urxvt;
670		758
671	use utf8;	759	use utf8;
672	use strict;	760	use strict 'vars';
673	use Carp ();	761	use Carp ();
674	use Scalar::Util ();	762	use Scalar::Util ();
675	use List::Util ();	763	use List::Util ();
676		764
677	our $VERSION = 1;	765	our $VERSION = 1;
678	our $TERM;	766	our $TERM;
679	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
680	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
681	our @HOOKNAME;	769	our @HOOKNAME;
682	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
683	our %OPTION;	771	our %OPTION;
684		772
685	our $LIBDIR;	773	our $LIBDIR;
…		…
733		821
734	=over 4	822	=over 4
735		823
736	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
737		825
738	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
739	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
740	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
741		830
742	=item urxvt::warn $string	831	=item urxvt::warn $string
743		832
744	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
745	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
746	that calls this function.	835	that calls this function.
747		836
748	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
749	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
753	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
754		843
755	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
756	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
757	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
758	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
759		848
760	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
761		850
762	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
763		852
…		…
806		895
807	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
808		897
809	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
810		899
811	=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
812		902
813	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
814	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
815	the bitset.	905	the bitset.
816		906
…		…
853	};	943	};
854	}	944	}
855		945
856	no warnings 'utf8';	946	no warnings 'utf8';
857		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$name =~ y/-/./ if $isarg;
		952
		953	$term->scan_meta;
		954
		955	my $r = $term->{meta}{resource};
		956	keys %$r; # reste iterator
		957	while (my ($pattern, $v) = each %$r) {
		958	if (
		959	$pattern =~ /\.$/
		960	? $pattern eq substr $name, 0, length $pattern
		961	: $pattern eq $name
		962	) {
		963	$name = "$urxvt::RESCLASS.$name";
		964
		965	push @{ $term->{perl_ext_3} }, $v->[0];
		966
		967	if ($v->[1] eq "boolean") {
		968	$term->put_option_db ($name, $flag ? "true" : "false");
		969	return 1;
		970	} else {
		971	$term->put_option_db ($name, $value);
		972	return 1 + 2;
		973	}
		974	}
		975	}
		976
		977	0
		978	}
		979
		980	sub usage {
		981	my ($term, $usage_type) = @_;
		982
		983	$term->scan_meta;
		984
		985	my $r = $term->{meta}{resource};
		986
		987	for my $pattern (sort keys %$r) {
		988	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		989
		990	$desc .= " (-pe $ext)";
		991
		992	if ($usage_type == 1) {
		993	$pattern =~ y/./-/;
		994	$pattern =~ s/-$/-.../g;
		995
		996	if ($type eq "boolean") {
		997	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		998	} else {
		999	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		1000	}
		1001	} else {
		1002	$pattern =~ s/\.$/.*/g;
		1003	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1004	}
		1005	}
		1006	}
		1007
858	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1008	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
859		1009
860	sub verbose {	1010	sub verbose {
861	my ($level, $msg) = @_;	1011	my ($level, $msg) = @_;
862	warn "$msg\n" if $level <= $verbosity;	1012	warn "$msg\n" if $level <= $verbosity;
…		…
874	$pkg =~ s/[^[:word:]]/_/g;	1024	$pkg =~ s/[^[:word:]]/_/g;
875	$pkg = "urxvt::ext::$pkg";	1025	$pkg = "urxvt::ext::$pkg";
876		1026
877	verbose 3, "loading extension '$path' into package '$pkg'";	1027	verbose 3, "loading extension '$path' into package '$pkg'";
878		1028
		1029	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		1030
879	open my $fh, "<:raw", $path	1031	open my $fh, "<:raw", $path
880	or die "$path: $!";	1032	or die "$path: $!";
881		1033
882	my $source =	1034	my $source =
883	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	1035	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
884	. "#line 1 \"$path\"\n{\n"	1036	. "#line 1 \"$path\"\n{\n"
885	. (do { local $/; <$fh> })	1037	. (do { local $/; <$fh> })
886	. "\n};\n1";	1038	. "\n};\n1";
887		1039
888	eval $source	1040	eval $source
…		…
898	sub invoke {	1050	sub invoke {
899	local $TERM = shift;	1051	local $TERM = shift;
900	my $htype = shift;	1052	my $htype = shift;
901		1053
902	if ($htype == 0) { # INIT	1054	if ($htype == 0) { # INIT
903	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1055	my @dirs = $TERM->perl_libdirs;
904		1056
905	my %ext_arg;	1057	my %ext_arg;
906		1058
907	{	1059	{
908	my @init = @TERM_INIT;	1060	my @init = @TERM_INIT;
909	@TERM_INIT = ();	1061	@TERM_INIT = ();
…		…
911	my @pkg = @TERM_EXT;	1063	my @pkg = @TERM_EXT;
912	@TERM_EXT = ();	1064	@TERM_EXT = ();
913	$TERM->register_package ($_) for @pkg;	1065	$TERM->register_package ($_) for @pkg;
914	}	1066	}
915		1067
		1068	for (
		1069	@{ delete $TERM->{perl_ext_3} },
916	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1070	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1071	) {
917	if ($_ eq "default") {	1072	if ($_ eq "default") {
918	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	1073	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
919	} elsif (/^-(.*)$/) {	1074	} elsif (/^-(.*)$/) {
920	delete $ext_arg{$1};	1075	delete $ext_arg{$1};
921	} elsif (/^([^<]+)<(.*)>$/) {	1076	} elsif (/^([^<]+)<(.*)>$/) {
…		…
972		1127
973	sub SET_COLOR($$$) {	1128	sub SET_COLOR($$$) {
974	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1129	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
975	}	1130	}
976		1131
977	# urxvt::term::extension	1132	sub rend2mask {
		1133	no strict 'refs';
		1134	my ($str, $mask) = (@_, 0);
		1135	my %color = ( fg => undef, bg => undef );
		1136	my @failed;
		1137	for my $spec ( split /\s+/, $str ) {
		1138	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1139	$color{lc($1)} = $2;
		1140	} else {
		1141	my $neg = $spec =~ s/^[-^]//;
		1142	unless ( exists &{"RS_$spec"} ) {
		1143	push @failed, $spec;
		1144	next;
		1145	}
		1146	my $cur = &{"RS_$spec"};
		1147	if ( $neg ) {
		1148	$mask &= ~$cur;
		1149	} else {
		1150	$mask \|= $cur;
		1151	}
		1152	}
		1153	}
		1154	($mask, @color{qw(fg bg)}, \@failed)
		1155	}
978		1156
979	package urxvt::term::extension;	1157	package urxvt::term::extension;
980		1158
981	sub enable {	1159	sub enable {
982	my ($self, %hook) = @_;	1160	my ($self, %hook) = @_;
…		…
1037		1215
1038	sub urxvt::destroy_hook(&) {	1216	sub urxvt::destroy_hook(&) {
1039	bless \shift, urxvt::destroy_hook::	1217	bless \shift, urxvt::destroy_hook::
1040	}	1218	}
1041		1219
		1220	sub x_resource {
		1221	my ($self, $name) = @_;
		1222	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		1223	$self->{term}->x_resource ($name)
		1224	}
		1225
		1226	sub x_resource_boolean {
		1227	my ($self, $name) = @_;
		1228	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		1229	$self->{term}->x_resource_boolean ($name)
		1230	}
		1231
1042	package urxvt::anyevent;	1232	package urxvt::anyevent;
1043		1233
1044	=head2 The C<urxvt::anyevent> Class	1234	=head2 The C<urxvt::anyevent> Class
1045		1235
1046	The sole purpose of this class is to deliver an interface to the	1236	The sole purpose of this class is to deliver an interface to the
1047	C<AnyEvent> module - any module using it will work inside urxvt without	1237	C<AnyEvent> module - any module using it will work inside urxvt without
1048	further programming. The only exception is that you cannot wait on	1238	further programming. The only exception is that you cannot wait on
1049	condition variables, but non-blocking condvar use is ok. What this means	1239	condition variables, but non-blocking condvar use is ok.
1050	is that you cannot use blocking APIs, but the non-blocking variant should	1240
1051	work.	1241	In practical terms this means is that you cannot use blocking APIs, but
		1242	the non-blocking variant should work.
1052		1243
1053	=cut	1244	=cut
1054		1245
1055	our $VERSION = 1;	1246	our $VERSION = '5.23';
1056		1247
1057	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1248	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1058	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1249	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1059		1250
1060	sub timer {	1251	sub timer {
…		…
1062		1253
1063	my $cb = $arg{cb};	1254	my $cb = $arg{cb};
1064		1255
1065	urxvt::timer	1256	urxvt::timer
1066	->new	1257	->new
1067	->start (urxvt::NOW + $arg{after})	1258	->after ($arg{after}, $arg{interval})
1068	->cb (sub {	1259	->cb ($arg{interval} ? $cb : sub {
1069	$_[0]->stop; # need to cancel manually	1260	$_[0]->stop; # need to cancel manually
1070	$cb->();	1261	$cb->();
1071	})	1262	})
1072	}	1263	}
1073		1264
1074	sub io {	1265	sub io {
1075	my ($class, %arg) = @_;	1266	my ($class, %arg) = @_;
1076		1267
1077	my $cb = $arg{cb};	1268	my $cb = $arg{cb};
		1269	my $fd = fileno $arg{fh};
		1270	defined $fd or $fd = $arg{fh};
1078		1271
1079	bless [$arg{fh}, urxvt::iow	1272	bless [$arg{fh}, urxvt::iow
1080	->new	1273	->new
1081	->fd (fileno $arg{fh})	1274	->fd ($fd)
1082	->events (($arg{poll} =~ /r/ ? 1 : 0)	1275	->events (($arg{poll} =~ /r/ ? 1 : 0)
1083	\| ($arg{poll} =~ /w/ ? 2 : 0))	1276	\| ($arg{poll} =~ /w/ ? 2 : 0))
1084	->start	1277	->start
1085	->cb (sub {	1278	->cb ($cb)
1086	$cb->(($_[1] & 1 ? 'r' : '')
1087	. ($_[1] & 2 ? 'w' : ''));
1088	})],
1089	urxvt::anyevent::	1279	], urxvt::anyevent::
		1280	}
		1281
		1282	sub idle {
		1283	my ($class, %arg) = @_;
		1284
		1285	my $cb = $arg{cb};
		1286
		1287	urxvt::iw
		1288	->new
		1289	->start
		1290	->cb ($cb)
		1291	}
		1292
		1293	sub child {
		1294	my ($class, %arg) = @_;
		1295
		1296	my $cb = $arg{cb};
		1297
		1298	urxvt::pw
		1299	->new
		1300	->start ($arg{pid})
		1301	->cb (sub {
		1302	$_[0]->stop; # need to cancel manually
		1303	$cb->($_[0]->rpid, $_[0]->rstatus);
		1304	})
1090	}	1305	}
1091		1306
1092	sub DESTROY {	1307	sub DESTROY {
1093	$_[0][1]->stop;	1308	$_[0][1]->stop;
1094	}	1309	}
1095		1310
1096	sub condvar {	1311	# only needed for AnyEvent < 6 compatibility
1097	bless \my $flag, urxvt::anyevent::condvar::	1312	sub one_event {
1098	}
1099
1100	sub urxvt::anyevent::condvar::broadcast {
1101	${$_[0]}++;
1102	}
1103
1104	sub urxvt::anyevent::condvar::wait {
1105	unless (${$_[0]}) {
1106	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1313	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1107	}
1108	}	1314	}
1109		1315
1110	package urxvt::term;	1316	package urxvt::term;
1111		1317
1112	=head2 The C<urxvt::term> Class	1318	=head2 The C<urxvt::term> Class
…		…
1125	urxvt::verbose 6, "register package $pkg to $self";	1331	urxvt::verbose 6, "register package $pkg to $self";
1126		1332
1127	@{"$pkg\::ISA"} = urxvt::term::extension::;	1333	@{"$pkg\::ISA"} = urxvt::term::extension::;
1128		1334
1129	my $proxy = bless {	1335	my $proxy = bless {
1130	_pkg => $pkg,	1336	_pkg => $pkg,
		1337	_name => ${"$pkg\::_NAME"}, # hackish
1131	argv => $argv,	1338	argv => $argv,
1132	}, $pkg;	1339	}, $pkg;
1133	Scalar::Util::weaken ($proxy->{term} = $self);	1340	Scalar::Util::weaken ($proxy->{term} = $self);
1134		1341
1135	$self->{_pkg}{$pkg} = $proxy;	1342	$self->{_pkg}{$pkg} = $proxy;
1136		1343
…		…
1139	$proxy->enable ($name => $ref);	1346	$proxy->enable ($name => $ref);
1140	}	1347	}
1141	}	1348	}
1142	}	1349	}
1143		1350
		1351	sub perl_libdirs {
		1352	map { split /:/ }
		1353	$_[0]->resource ("perl_lib"),
		1354	$ENV{URXVT_PERL_LIB},
		1355	"$ENV{HOME}/.urxvt/ext",
		1356	"$LIBDIR/perl"
		1357	}
		1358
		1359	sub scan_meta {
		1360	my ($self) = @_;
		1361	my @libdirs = perl_libdirs $self;
		1362
		1363	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1364
		1365	my %meta;
		1366
		1367	$self->{meta_libdirs} = join "\x00", @libdirs;
		1368	$self->{meta} = \%meta;
		1369
		1370	for my $dir (reverse @libdirs) {
		1371	opendir my $fh, $dir
		1372	or next;
		1373	for my $ext (readdir $fh) {
		1374	$ext ne "."
		1375	and $ext ne ".."
		1376	and open my $fh, "<", "$dir/$ext"
		1377	or next;
		1378
		1379	while (<$fh>) {
		1380	if (/^#:META:X_RESOURCE:(.*)/) {
		1381	my ($pattern, $type, $desc) = split /:/, $1;
		1382	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1383	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1384	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1385	} else {
		1386	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1387	}
		1388	} elsif (/^\s*(?:#\|$)/) {
		1389	# skip other comments and empty lines
		1390	} else {
		1391	last; # stop parsing on first non-empty non-comment line
		1392	}
		1393	}
		1394	}
		1395	}
		1396	}
		1397
1144	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1398	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1145		1399
1146	Creates a new terminal, very similar as if you had started it with system	1400	Creates a new terminal, very similar as if you had started it with system
1147	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1401	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1148	hash which defines the environment of the new terminal.	1402	hash which defines the environment of the new terminal.
…		…
1202	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1456	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1203		1457
1204	Here is a likely non-exhaustive list of option names, please see the	1458	Here is a likely non-exhaustive list of option names, please see the
1205	source file F</src/optinc.h> to see the actual list:	1459	source file F</src/optinc.h> to see the actual list:
1206		1460
1207	borderLess console cursorBlink cursorUnderline hold iconic insecure	1461	borderLess buffered console cursorBlink cursorUnderline hold iconic
1208	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1462	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1209	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1463	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1210	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1464	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1211	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1465	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1212	transparent tripleclickwords utmpInhibit visualBell	1466	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1467	urgentOnBell utmpInhibit visualBell
1213		1468
1214	=item $value = $term->resource ($name[, $newval])	1469	=item $value = $term->resource ($name[, $newval])
1215		1470
1216	Returns the current resource value associated with a given name and	1471	Returns the current resource value associated with a given name and
1217	optionally sets a new value. Setting values is most useful in the C<init>	1472	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1230		1485
1231	Here is a likely non-exhaustive list of resource names, not all of which	1486	Here is a likely non-exhaustive list of resource names, not all of which
1232	are supported in every build, please see the source file F</src/rsinc.h>	1487	are supported in every build, please see the source file F</src/rsinc.h>
1233	to see the actual list:	1488	to see the actual list:
1234		1489
1235	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1490	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1236	borderLess color cursorBlink cursorUnderline cutchars delete_key	1491	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1237	display_name embed ext_bwidth fade font geometry hold iconName	1492	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1238	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1493	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1494	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1239	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1495	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1240	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1496	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1241	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1497	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1242	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1498	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1243	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1499	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1244	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1500	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1245	secondaryScreen secondaryScroll selectstyle shade term_name title	1501	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1246	transient_for transparent transparent_all tripleclickwords utmpInhibit	1502	term_name title transient_for transparent tripleclickwords urgentOnBell
1247	visualBell	1503	utmpInhibit visualBell
1248		1504
1249	=cut	1505	=cut
1250		1506
1251	sub resource($$;$) {	1507	sub resource($$;$) {
1252	my ($self, $name) = (shift, shift);	1508	my ($self, $name) = (shift, shift);
1253	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1509	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1254	&urxvt::term::_resource	1510	goto &urxvt::term::_resource
1255	}	1511	}
1256		1512
1257	=item $value = $term->x_resource ($pattern)	1513	=item $value = $term->x_resource ($pattern)
1258		1514
1259	Returns the X-Resource for the given pattern, excluding the program or	1515	Returns the X-Resource for the given pattern, excluding the program or
1260	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1516	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1261	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1517	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1262	resource with that pattern exists.	1518	resource with that pattern exists.
1263		1519
		1520	Extensions that define extra resource or command line arguments also need
		1521	to call this method to access their values.
		1522
		1523	If the method is called on an extension object (basically, from an
		1524	extension), then the special prefix C<%.> will be replaced by the name of
		1525	the extension and a dot, and the lone string C<%> will be replcaed by the
		1526	extension name itself. This makes it possible to code extensions so you
		1527	can rename them and get a new set of commandline switches and resources
		1528	without having to change the actual code.
		1529
1264	This method should only be called during the C<on_start> hook, as there is	1530	This method should only be called during the C<on_start> hook, as there is
1265	only one resource database per display, and later invocations might return	1531	only one resource database per display, and later invocations might return
1266	the wrong resources.	1532	the wrong resources.
1267		1533
1268	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1534	=item $value = $term->x_resource_boolean ($pattern)
1269		1535
		1536	Like C<x_resource>, above, but interprets the string value as a boolean
		1537	and returns C<1> for true values, C<0> for false values and C<undef> if
		1538	the resource or option isn't specified.
		1539
		1540	You should always use this method to parse boolean resources.
		1541
		1542	=cut
		1543
		1544	sub x_resource_boolean {
		1545	my $res = &x_resource;
		1546
		1547	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1548	}
		1549
		1550	=item $success = $term->parse_keysym ($key, $octets)
		1551
1270	Adds a keymap translation exactly as specified via a resource. See the	1552	Adds a key binding exactly as specified via a resource. See the
1271	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1553	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1554
		1555	=item $term->register_command ($keysym, $modifiermask, $string)
		1556
		1557	Adds a key binding. This is a lower level api compared to
		1558	C<parse_keysym>, as it expects a parsed key description, and can be
		1559	used only inside either the C<on_init> hook, to add a binding, or the
		1560	C<on_register_command> hook, to modify a parsed binding.
1272		1561
1273	=item $rend = $term->rstyle ([$new_rstyle])	1562	=item $rend = $term->rstyle ([$new_rstyle])
1274		1563
1275	Return and optionally change the current rendition. Text that is output by	1564	Return and optionally change the current rendition. Text that is output by
1276	the terminal application will use this style.	1565	the terminal application will use this style.
…		…
1284		1573
1285	=item ($row, $col) = $term->selection_beg ([$row, $col])	1574	=item ($row, $col) = $term->selection_beg ([$row, $col])
1286		1575
1287	=item ($row, $col) = $term->selection_end ([$row, $col])	1576	=item ($row, $col) = $term->selection_end ([$row, $col])
1288		1577
1289	Return the current values of the selection mark, begin or end positions,	1578	Return the current values of the selection mark, begin or end positions.
1290	and optionally set them to new values.	1579
		1580	When arguments are given, then the selection coordinates are set to
		1581	C<$row> and C<$col>, and the selection screen is set to the current
		1582	screen.
		1583
		1584	=item $screen = $term->selection_screen ([$screen])
		1585
		1586	Returns the current selection screen, and then optionally sets it.
1291		1587
1292	=item $term->selection_make ($eventtime[, $rectangular])	1588	=item $term->selection_make ($eventtime[, $rectangular])
1293		1589
1294	Tries to make a selection as set by C<selection_beg> and	1590	Tries to make a selection as set by C<selection_beg> and
1295	C<selection_end>. If C<$rectangular> is true (default: false), a	1591	C<selection_end>. If C<$rectangular> is true (default: false), a
1296	rectangular selection will be made. This is the prefered function to make	1592	rectangular selection will be made. This is the preferred function to make
1297	a selection.	1593	a selection.
1298		1594
1299	=item $success = $term->selection_grab ($eventtime)	1595	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1300		1596
1301	Try to request the primary selection text from the server (for example, as	1597	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1598	true) selection from the server. The corresponding text can be set
1302	set by the next method). No visual feedback will be given. This function	1599	with the next method. No visual feedback will be given. This function
1303	is mostly useful from within C<on_sel_grab> hooks.	1600	is mostly useful from within C<on_sel_grab> hooks.
1304		1601
1305	=item $oldtext = $term->selection ([$newtext])	1602	=item $oldtext = $term->selection ([$newtext, $clipboard])
1306		1603
1307	Return the current selection text and optionally replace it by C<$newtext>.	1604	Return the current selection (clipboard if C<$clipboard> is true) text
		1605	and optionally replace it by C<$newtext>.
		1606
		1607	=item $term->selection_clear ([$clipboard])
		1608
		1609	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1308		1610
1309	=item $term->overlay_simple ($x, $y, $text)	1611	=item $term->overlay_simple ($x, $y, $text)
1310		1612
1311	Create a simple multi-line overlay box. See the next method for details.	1613	Create a simple multi-line overlay box. See the next method for details.
1312		1614
…		…
1342		1644
1343	The methods currently supported on C<urxvt::overlay> objects are:	1645	The methods currently supported on C<urxvt::overlay> objects are:
1344		1646
1345	=over 4	1647	=over 4
1346		1648
1347	=item $overlay->set ($x, $y, $text, $rend)	1649	=item $overlay->set ($x, $y, $text[, $rend])
1348		1650
1349	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1651	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1350	text in rxvt-unicode's special encoding and an array of rendition values	1652	text in rxvt-unicode's special encoding and an array of rendition values
1351	at a specific position inside the overlay.	1653	at a specific position inside the overlay.
		1654
		1655	If C<$rend> is missing, then the rendition will not be changed.
1352		1656
1353	=item $overlay->hide	1657	=item $overlay->hide
1354		1658
1355	If visible, hide the overlay, but do not destroy it.	1659	If visible, hide the overlay, but do not destroy it.
1356		1660
…		…
1438	locale-specific encoding of the terminal and can contain command sequences	1742	locale-specific encoding of the terminal and can contain command sequences
1439	(escape codes) that will be interpreted.	1743	(escape codes) that will be interpreted.
1440		1744
1441	=item $term->tt_write ($octets)	1745	=item $term->tt_write ($octets)
1442		1746
1443	Write the octets given in C<$data> to the tty (i.e. as program input). To	1747	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1444	pass characters instead of octets, you should convert your strings first	1748	pass characters instead of octets, you should convert your strings first
1445	to the locale-specific encoding using C<< $term->locale_encode >>.	1749	to the locale-specific encoding using C<< $term->locale_encode >>.
		1750
		1751	=item $term->tt_paste ($octets)
		1752
		1753	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1754	CR and bracketing the data with control sequences if bracketed paste mode
		1755	is set.
1446		1756
1447	=item $old_events = $term->pty_ev_events ([$new_events])	1757	=item $old_events = $term->pty_ev_events ([$new_events])
1448		1758
1449	Replaces the event mask of the pty watcher by the given event mask. Can	1759	Replaces the event mask of the pty watcher by the given event mask. Can
1450	be used to suppress input and output handling to the pty/tty. See the	1760	be used to suppress input and output handling to the pty/tty. See the
…		…
1469	Adds the specified events to the vt event mask. Useful e.g. when you want	1779	Adds the specified events to the vt event mask. Useful e.g. when you want
1470	to receive pointer events all the times:	1780	to receive pointer events all the times:
1471		1781
1472	$term->vt_emask_add (urxvt::PointerMotionMask);	1782	$term->vt_emask_add (urxvt::PointerMotionMask);
1473		1783
		1784	=item $term->set_urgency ($set)
		1785
		1786	Enable/disable the urgency hint on the toplevel window.
		1787
1474	=item $term->focus_in	1788	=item $term->focus_in
1475		1789
1476	=item $term->focus_out	1790	=item $term->focus_out
1477		1791
1478	=item $term->key_press ($state, $keycode[, $time])	1792	=item $term->key_press ($state, $keycode[, $time])
…		…
1566		1880
1567	Used after changing terminal contents to display them.	1881	Used after changing terminal contents to display them.
1568		1882
1569	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1883	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1570		1884
1571	Returns the text of the entire row with number C<$row_number>. Row C<0>	1885	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1572	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1886	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1573	terminal line. The scrollback buffer starts at line C<-1> and extends to
1574	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1887	terminal line. Nothing will be returned if a nonexistent line
1575	is requested.	1888	is requested.
1576		1889
1577	If C<$new_text> is specified, it will replace characters in the current	1890	If C<$new_text> is specified, it will replace characters in the current
1578	line, starting at column C<$start_col> (default C<0>), which is useful	1891	line, starting at column C<$start_col> (default C<0>), which is useful
1579	to replace only parts of a line. The font index in the rendition will	1892	to replace only parts of a line. The font index in the rendition will
1580	automatically be updated.	1893	automatically be updated.
1581		1894
1582	C<$text> is in a special encoding: tabs and wide characters that use more	1895	C<$text> is in a special encoding: tabs and wide characters that use more
1583	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1896	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1584	characters. Characters with combining characters and other characters that	1897	characters. Characters with combining characters and other characters that
1585	do not fit into the normal tetx encoding will be replaced with characters	1898	do not fit into the normal text encoding will be replaced with characters
1586	in the private use area.	1899	in the private use area.
1587		1900
1588	You have to obey this encoding when changing text. The advantage is	1901	You have to obey this encoding when changing text. The advantage is
1589	that C<substr> and similar functions work on screen cells and not on	1902	that C<substr> and similar functions work on screen cells and not on
1590	characters.	1903	characters.
…		…
1765	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2078	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1766	recent grab.	2079	recent grab.
1767		2080
1768	=item $term->ungrab	2081	=item $term->ungrab
1769		2082
1770	Calls XUngrab for the most recent grab. Is called automatically on	2083	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1771	evaluation errors, as it is better to lose the grab in the error case as	2084	evaluation errors, as it is better to lose the grab in the error case as
1772	the session.	2085	the session.
1773		2086
1774	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2087	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1775		2088
…		…
1777		2090
1778	=item @atoms = $term->XListProperties ($window)	2091	=item @atoms = $term->XListProperties ($window)
1779		2092
1780	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2093	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1781		2094
1782	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2095	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1783		2096
1784	=item $term->XDeleteProperty ($window, $property)	2097	=item $term->XDeleteProperty ($window, $property)
1785		2098
1786	=item $window = $term->DefaultRootWindow	2099	=item $window = $term->DefaultRootWindow
1787		2100
…		…
1794	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2107	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1795		2108
1796	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2109	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1797		2110
1798	=item $term->XChangeInput ($window, $add_events[, $del_events])	2111	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2112
		2113	=item $keysym = $term->XStringToKeysym ($string)
		2114
		2115	=item $string = $term->XKeysymToString ($keysym)
1799		2116
1800	Various X or X-related functions. The C<$term> object only serves as	2117	Various X or X-related functions. The C<$term> object only serves as
1801	the source of the display, otherwise those functions map more-or-less	2118	the source of the display, otherwise those functions map more-or-less
1802	directory onto the X functions of the same name.	2119	directly onto the X functions of the same name.
1803		2120
1804	=back	2121	=back
1805		2122
1806	=cut	2123	=cut
1807		2124
…		…
1909	my $env = $self->{term}->env;	2226	my $env = $self->{term}->env;
1910	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2227	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1911	delete $env->{LC_ALL};	2228	delete $env->{LC_ALL};
1912	$env->{LC_CTYPE} = $self->{term}->locale;	2229	$env->{LC_CTYPE} = $self->{term}->locale;
1913		2230
1914	urxvt::term->new ($env, "popup",	2231	my $term = urxvt::term->new (
		2232	$env, "popup",
1915	"--perl-lib" => "", "--perl-ext-common" => "",	2233	"--perl-lib" => "", "--perl-ext-common" => "",
1916	"-pty-fd" => -1, "-sl" => 0,	2234	"-pty-fd" => -1, "-sl" => 0,
1917	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2235	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1918	"--transient-for" => $self->{term}->parent,	2236	"--transient-for" => $self->{term}->parent,
1919	"-display" => $self->{term}->display_id,	2237	"-display" => $self->{term}->display_id,
1920	"-pe" => "urxvt-popup")	2238	"-pe" => "urxvt-popup",
1921	or die "unable to create popup window\n";	2239	) or die "unable to create popup window\n";
		2240
		2241	unless (delete $term->{urxvt_popup_init_done}) {
		2242	$term->ungrab;
		2243	$term->destroy;
		2244	die "unable to initialise popup window\n";
		2245	}
1922	}	2246	}
1923		2247
1924	sub DESTROY {	2248	sub DESTROY {
1925	my ($self) = @_;	2249	my ($self) = @_;
1926		2250
…		…
1931	=back	2255	=back
1932		2256
1933	=cut	2257	=cut
1934		2258
1935	package urxvt::watcher;	2259	package urxvt::watcher;
1936
1937	@urxvt::timer::ISA = __PACKAGE__;
1938	@urxvt::iow::ISA = __PACKAGE__;
1939	@urxvt::pw::ISA = __PACKAGE__;
1940	@urxvt::iw::ISA = __PACKAGE__;
1941		2260
1942	=head2 The C<urxvt::timer> Class	2261	=head2 The C<urxvt::timer> Class
1943		2262
1944	This class implements timer watchers/events. Time is represented as a	2263	This class implements timer watchers/events. Time is represented as a
1945	fractional number of seconds since the epoch. Example:	2264	fractional number of seconds since the epoch. Example:
…		…
1949	->new	2268	->new
1950	->interval (1)	2269	->interval (1)
1951	->cb (sub {	2270	->cb (sub {
1952	$term->{overlay}->set (0, 0,	2271	$term->{overlay}->set (0, 0,
1953	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2272	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1954	});	2273	});
1955		2274
1956	=over 4	2275	=over 4
1957		2276
1958	=item $timer = new urxvt::timer	2277	=item $timer = new urxvt::timer
1959		2278
…		…
1962		2281
1963	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2282	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1964		2283
1965	Set the callback to be called when the timer triggers.	2284	Set the callback to be called when the timer triggers.
1966		2285
1967	=item $tstamp = $timer->at
1968
1969	Return the time this watcher will fire next.
1970
1971	=item $timer = $timer->set ($tstamp)	2286	=item $timer = $timer->set ($tstamp[, $interval])
1972		2287
1973	Set the time the event is generated to $tstamp.	2288	Set the time the event is generated to $tstamp (and optionally specifies a
		2289	new $interval).
1974		2290
1975	=item $timer = $timer->interval ($interval)	2291	=item $timer = $timer->interval ($interval)
1976		2292
1977	Normally (and when C<$interval> is C<0>), the timer will automatically	2293	By default (and when C<$interval> is C<0>), the timer will automatically
1978	stop after it has fired once. If C<$interval> is non-zero, then the timer	2294	stop after it has fired once. If C<$interval> is non-zero, then the timer
1979	is automatically rescheduled at the given intervals.	2295	is automatically rescheduled at the given intervals.
1980		2296
1981	=item $timer = $timer->start	2297	=item $timer = $timer->start
1982		2298
1983	Start the timer.	2299	Start the timer.
1984		2300
1985	=item $timer = $timer->start ($tstamp)	2301	=item $timer = $timer->start ($tstamp[, $interval])
1986		2302
1987	Set the event trigger time to C<$tstamp> and start the timer.	2303	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2304	also replaces the interval.
1988		2305
1989	=item $timer = $timer->after ($delay)	2306	=item $timer = $timer->after ($delay[, $interval])
1990		2307
1991	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2308	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1992		2309
1993	=item $timer = $timer->stop	2310	=item $timer = $timer->stop
1994		2311
…		…
2002		2319
2003	$term->{socket} = ...	2320	$term->{socket} = ...
2004	$term->{iow} = urxvt::iow	2321	$term->{iow} = urxvt::iow
2005	->new	2322	->new
2006	->fd (fileno $term->{socket})	2323	->fd (fileno $term->{socket})
2007	->events (urxvt::EVENT_READ)	2324	->events (urxvt::EV_READ)
2008	->start	2325	->start
2009	->cb (sub {	2326	->cb (sub {
2010	my ($iow, $revents) = @_;	2327	my ($iow, $revents) = @_;
2011	# $revents must be 1 here, no need to check	2328	# $revents must be 1 here, no need to check
2012	sysread $term->{socket}, my $buf, 8192	2329	sysread $term->{socket}, my $buf, 8192
…		…
2030	Set the file descriptor (not handle) to watch.	2347	Set the file descriptor (not handle) to watch.
2031		2348
2032	=item $iow = $iow->events ($eventmask)	2349	=item $iow = $iow->events ($eventmask)
2033		2350
2034	Set the event mask to watch. The only allowed values are	2351	Set the event mask to watch. The only allowed values are
2035	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2352	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2036	together, or C<urxvt::EVENT_NONE>.	2353	together, or C<urxvt::EV_NONE>.
2037		2354
2038	=item $iow = $iow->start	2355	=item $iow = $iow->start
2039		2356
2040	Start watching for requested events on the given handle.	2357	Start watching for requested events on the given handle.
2041		2358
…		…
2082	->new	2399	->new
2083	->start ($pid)	2400	->start ($pid)
2084	->cb (sub {	2401	->cb (sub {
2085	my ($pw, $exit_status) = @_;	2402	my ($pw, $exit_status) = @_;
2086	...	2403	...
2087	});	2404	});
2088		2405
2089	=over 4	2406	=over 4
2090		2407
2091	=item $pw = new urxvt::pw	2408	=item $pw = new urxvt::pw
2092		2409
…		…
2125		2442
2126	=back	2443	=back
2127		2444
2128	=head1 AUTHOR	2445	=head1 AUTHOR
2129		2446
2130	Marc Lehmann <pcg@goof.com>	2447	Marc Lehmann <schmorp@schmorp.de>
2131	http://software.schmorp.de/pkg/rxvt-unicode	2448	http://software.schmorp.de/pkg/rxvt-unicode
2132		2449
2133	=cut	2450	=cut
2134		2451
2135	1	2452	1
		2453
		2454	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.146 by root, Thu Aug 17 21:56:11 2006 UTC vs. Revision 1.217 by root, Sun Jun 10 13:58:05 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.146 by root, Thu Aug 17 21:56:11 2006 UTC vs.
Revision 1.217 by root, Sun Jun 10 13:58:05 2012 UTC