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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.199 by sf-exg, Sun Nov 20 10:49:56 2011 UTC vs.
Revision 1.258 by root, Tue Sep 17 20:38:14 2019 UTC

…		…
1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
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 urxvtd, 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"	31	You can disable the embedded perl interpreter by setting both "perl-ext"
32	and "perl-ext-common" resources to the empty string.	32	and "perl-ext-common" resources to the empty string.
33		33
34	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
35		35
36	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
38		39
39	You can activate them like this:	40	You can activate them like this:
40		41
41	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
42		43
43	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
44		45
45	URxvt.perl-ext-common: default,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
46		47
47	=over 4	48	Extensions may add additional resources and C<actions>, i.e., methods
48		49	which can be bound to a key and invoked by the user. An extension can
49	=item selection (enabled by default)	50	define the resources it support using so called META comments,
50		51	described below. Similarly to builtin resources, extension resources
51	(More) intelligent selection. This extension tries to be more intelligent	52	can also be specified on the command line as long options (with C<.>
52	when the user extends selections (double-click and further clicks). Right	53	replaced by C<->), in which case the corresponding extension is loaded
53	now, it tries to select words, urls and complete shell-quoted	54	automatically. For this to work the extension B<must> define META
54	arguments, which is very convenient, too, if your F<ls> supports	55	comments for its resources.
55	C<--quoting-style=shell>.
56
57	A double-click usually selects the word under the cursor, further clicks
58	will enlarge the selection.
59
60	The selection works by trying to match a number of regexes and displaying
61	them in increasing order of length. You can add your own regexes by
62	specifying resources of the form:
63
64	URxvt.selection.pattern-0: perl-regex
65	URxvt.selection.pattern-1: perl-regex
66	...
67
68	The index number (0, 1...) must not have any holes, and each regex must
69	contain at least one pair of capturing parentheses, which will be used for
70	the match. For example, the following adds a regex that matches everything
71	between two vertical bars:
72
73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
74
75	Another example: Programs I use often output "absolute path: " at the
76	beginning of a line when they process multiple files. The following
77	pattern matches the filename (note, there is a single space at the very
78	end):
79
80	URxvt.selection.pattern-0: ^(/[^:]+):\
81
82	You can look at the source of the selection extension to see more
83	interesting uses, such as parsing a line from beginning to end.
84
85	This extension also offers following bindable keyboard commands:
86
87	=over 4
88
89	=item rot13
90
91	Rot-13 the selection when activated. Used via keyboard trigger:
92
93	URxvt.keysym.C-M-r: perl:selection:rot13
94
95	=back
96
97	=item option-popup (enabled by default)
98
99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
100	runtime.
101
102	Other extensions can extend this popup menu by pushing a code reference
103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104	popup is being displayed.
105
106	Its sole argument is the popup menu, which can be modified. It should
107	either return nothing or a string, the initial boolean value and a code
108	reference. The string will be used as button text and the code reference
109	will be called when the toggle changes, with the new boolean value as
110	first argument.
111
112	The following will add an entry C<myoption> that changes
113	C<< $self->{myoption} >>:
114
115	push @{ $self->{term}{option_popup_hook} }, sub {
116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117	};
118
119	=item selection-popup (enabled by default)
120
121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
122	text into various other formats/action (such as uri unescaping, perl
123	evaluation, web-browser starting etc.), depending on content.
124
125	Other extensions can extend this popup menu by pushing a code reference
126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127	popup is being displayed.
128
129	Its sole argument is the popup menu, which can be modified. The selection
130	is in C<$_>, which can be used to decide whether to add something or not.
131	It should either return nothing or a string and a code reference. The
132	string will be used as button text and the code reference will be called
133	when the button gets activated and should transform C<$_>.
134
135	The following will add an entry C<a to b> that transforms all C<a>s in
136	the selection to C<b>s, but only if the selection currently contains any
137	C<a>s:
138
139	push @{ $self->{term}{selection_popup_hook} }, sub {
140	/a/ ? ("a to b" => sub { s/a/b/g }
141	: ()
142	};
143
144	=item searchable-scrollback<hotkey> (enabled by default)
145
146	Adds regex search functionality to the scrollback buffer, triggered
147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
148	input/output is suspended and a regex is displayed at the bottom of the
149	screen.
150
151	Inputting characters appends them to the regex and continues incremental
152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
154	bottom. C<Escape> leaves search mode and returns to the point where search
155	was started, while C<Enter> or C<Return> stay at the current position and
156	additionally stores the first match in the current line into the primary
157	selection if the C<Shift> modifier is active.
158
159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
160	get a case-sensitive search you can delete this prefix using C<BackSpace>
161	or simply use an uppercase character which removes the "(?i)" prefix.
162
163	See L<perlre> for more info about perl regular expression syntax.
164
165	=item readline (enabled by default)
166
167	A support package that tries to make editing with readline easier. At
168	the moment, it reacts to clicking shift-left mouse button by trying to
169	move the text cursor to this position. It does so by generating as many
170	cursor-left or cursor-right keypresses as required (this only works
171	for programs that correctly support wide characters).
172
173	To avoid too many false positives, this is only done when:
174
175	=over 4
176
177	=item - the tty is in ICANON state.
178
179	=item - the text cursor is visible.
180
181	=item - the primary screen is currently being displayed.
182
183	=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185	=back
186
187	The normal selection mechanism isn't disabled, so quick successive clicks
188	might interfere with selection creation in harmless ways.
189
190	=item selection-autotransform
191
192	This selection allows you to do automatic transforms on a selection
193	whenever a selection is made.
194
195	It works by specifying perl snippets (most useful is a single C<s///>
196	operator) that modify C<$_> as resources:
197
198	URxvt.selection-autotransform.0: transform
199	URxvt.selection-autotransform.1: transform
200	...
201
202	For example, the following will transform selections of the form
203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
204	$word>:
205
206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
207
208	And this example matches the same,but replaces it with vi-commands you can
209	paste directly into your (vi :) editor:
210
211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
212
213	Of course, this can be modified to suit your needs and your editor :)
214
215	To expand the example above to typical perl error messages ("XXX at
216	FILENAME line YYY."), you need a slightly more elaborate solution:
217
218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
220
221	The first line tells the selection code to treat the unchanging part of
222	every error message as a selection pattern, and the second line transforms
223	the message into vi commands to load the file.
224
225	=item tabbed
226
227	This transforms the terminal into a tabbar with additional terminals, that
228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230	button per tab.
231
232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
233	B<Shift-Right> will switch to the tab left or right of the current one,
234	while B<Shift-Down> creates a new tab.
235
236	The tabbar itself can be configured similarly to a normal terminal, but
237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
238	following four resources (shown with defaults):
239
240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242	URxvt.tabbed.tab-fg: <colour-index, default 0>
243	URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246	indices.
247
248	=item matcher
249
250	Uses per-line display filtering (C<on_line_update>) to underline text
251	matching a certain pattern and make it clickable. When clicked with the
252	mouse button specified in the C<matcher.button> resource (default 2, or
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
278
279	=item xim-onthespot
280
281	This (experimental) perl extension implements OnTheSpot editing. It does
282	not work perfectly, and some input methods don't seem to work well with
283	OnTheSpot editing in general, but it seems to work at least for SCIM and
284	kinput2.
285
286	You enable it by specifying this extension and a preedit style of
287	C<OnTheSpot>, i.e.:
288
289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
290
291	=item kuake<hotkey>
292
293	A very primitive quake-console-like extension. It was inspired by a
294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
295	user presses a global accelerator key (by default C<F10>), the terminal
296	will show or hide itself. Another press of the accelerator key will hide
297	or show it again.
298
299	Initially, the window will not be shown when using this extension.
300
301	This is useful if you need a single terminal that is not using any desktop
302	space most of the time but is quickly available at the press of a key.
303
304	The accelerator key is grabbed regardless of any modifiers, so this
305	extension will actually grab a physical key just for this function.
306
307	If you want a quake-like animation, tell your window manager to do so
308	(fvwm can do it).
309
310	=item overlay-osc
311
312	This extension implements some OSC commands to display timed popups on the
313	screen - useful for status displays from within scripts. You have to read
314	the sources for more info.
315
316	=item block-graphics-to-ascii
317
318	A not very useful example of filtering all text output to the terminal
319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
320	similar-looking ascii character.
321
322	=item digital-clock
323
324	Displays a digital clock using the built-in overlay.
325
326	=item remote-clipboard
327
328	Somewhat of a misnomer, this extension adds two menu entries to the
329	selection popup that allows one to run external commands to store the
330	selection somewhere and fetch it again.
331
332	We use it to implement a "distributed selection mechanism", which just
333	means that one command uploads the file to a remote server, and another
334	reads it.
335
336	The commands can be set using the C<URxvt.remote-selection.store> and
337	C<URxvt.remote-selection.fetch> resources. The first should read the
338	selection to store from STDIN (always in UTF-8), the second should provide
339	the selection data on STDOUT (also in UTF-8).
340
341	The defaults (which are likely useless to you) use rsh and cat:
342
343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
345
346	=item selection-pastebin
347
348	This is a little rarely useful extension that uploads the selection as
349	textfile to a remote site (or does other things). (The implementation is
350	not currently secure for use in a multiuser environment as it writes to
351	F</tmp> directly.).
352
353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
354	i.e.
355
356	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
357
358	Pressing this combination runs a command with C<%> replaced by the name of
359	the textfile. This command can be set via a resource:
360
361	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
362
363	And the default is likely not useful to anybody but the few people around
364	here :)
365
366	The name of the textfile is the hex encoded md5 sum of the selection, so
367	the same content should lead to the same filename.
368
369	After a successful upload the selection will be replaced by the text given
370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
371	for the filename):
372
373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
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
394	=item example-refresh-hooks
395
396	Displays a very simple digital clock in the upper right corner of the
397	window. Illustrates overwriting the refresh callbacks to create your own
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"
412
413	=back
414		56
415	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
416		58
417	=head2 General API Considerations	59	=head2 General API Considerations
418		60
445		87
446	=item $octets	88	=item $octets
447		89
448	Either binary data or - more common - a text string encoded in a	90	Either binary data or - more common - a text string encoded in a
449	locale-specific way.	91	locale-specific way.
		92
		93	=item $keysym
		94
		95	an integer that is a valid X11 keysym code. You can convert a string
		96	into a keysym and viceversa by using C<XStringToKeysym> and
		97	C<XKeysymToString>.
450		98
451	=back	99	=back
452		100
453	=head2 Extension Objects	101	=head2 Extension Objects
454		102
…		…
461	internal use.	109	internal use.
462		110
463	Although it isn't a C<urxvt::term> object, you can call all methods of the	111	Although it isn't a C<urxvt::term> object, you can call all methods of the
464	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
465		113
466	It has the following methods and data members:	114	Additional methods only supported for extension objects are described in
		115	the C<urxvt::extension> section below.
		116
		117	=head2 META comments
		118
		119	Rxvt-unicode recognizes special meta comments in extensions that define
		120	different types of metadata. These comments are scanned whenever a
		121	terminal is created and are typically used to autoload extensions when
		122	their resources or command line parameters are used.
		123
		124	Currently, it recognises only one such comment:
467		125
468	=over 4	126	=over 4
469		127
470	=item $urxvt_term = $self->{term}	128	=item #:META:RESOURCE:name:type:desc
471		129
472	Returns the C<urxvt::term> object associated with this instance of the	130	The RESOURCE comment defines a resource used by the extension, where
473	extension. This member I<must not> be changed in any way.	131	C<name> is the resource name, C<type> is the resource type, C<boolean>
		132	or C<string>, and C<desc> is the resource description.
474		133
475	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	134	The extension will be autoloaded when this resource is specified or used
476		135	as a command line parameter.
477	Dynamically enable the given hooks (named without the C<on_> prefix) for
478	this extension, replacing any previous hook. This is useful when you want
479	to overwrite time-critical hooks only temporarily.
480
481	=item $self->disable ($hook_name[, $hook_name..])
482
483	Dynamically disable the given hooks.
484		136
485	=back	137	=back
486		138
487	=head2 Hooks	139	=head2 Hooks
488		140
…		…
657		309
658	=item on_refresh_end $term	310	=item on_refresh_end $term
659		311
660	Called just after the screen gets redrawn. See C<on_refresh_begin>.	312	Called just after the screen gets redrawn. See C<on_refresh_begin>.
661		313
		314	=item on_action $term, $string
		315
		316	Called whenever an action is invoked for the corresponding extension
		317	(e.g. via a C<extension:string> builtin action bound to a key, see
		318	description of the B<keysym> resource in the urxvt(1) manpage). The
		319	event is simply the action string. Note that an action event is always
		320	associated to a single extension.
		321
662	=item on_user_command $term, $string	322	=item on_user_command $term, $string DEPRECATED
663		323
664	Called whenever a user-configured event is being activated (e.g. via	324	Called whenever a user-configured event is being activated (e.g. via
665	a C<perl:string> action bound to a key, see description of the B<keysym>	325	a C<perl:string> action bound to a key, see description of the B<keysym>
666	resource in the @@RXVT_NAME@@(1) manpage).	326	resource in the urxvt(1) manpage).
667		327
668	The event is simply the action string. This interface is assumed to change	328	The event is simply the action string. This interface is going away in
669	slightly in the future.	329	preference to the C<on_action> hook.
670		330
671	=item on_resize_all_windows $term, $new_width, $new_height	331	=item on_resize_all_windows $term, $new_width, $new_height
672		332
673	Called just after the new window size has been calculated, but before	333	Called just after the new window size has been calculated, but before
674	windows are actually being resized or hints are being set. If this hook	334	windows are actually being resized or hints are being set. If this hook
675	returns TRUE, setting of the window hints is being skipped.	335	returns a true value, setting of the window hints is being skipped.
676		336
677	=item on_x_event $term, $event	337	=item on_x_event $term, $event
678		338
679	Called on every X event received on the vt window (and possibly other	339	Called on every X event received on the vt window (and possibly other
680	windows). Should only be used as a last resort. Most event structure	340	windows). Should only be used as a last resort. Most event structure
…		…
720	(real, not screen-based) row and column under the mouse cursor.	380	(real, not screen-based) row and column under the mouse cursor.
721		381
722	C<on_key_press> additionally receives the string rxvt-unicode would	382	C<on_key_press> additionally receives the string rxvt-unicode would
723	output, if any, in locale-specific encoding.	383	output, if any, in locale-specific encoding.
724		384
725	subwindow.
726
727	=item on_client_message $term, $event	385	=item on_client_message $term, $event
728		386
729	=item on_wm_protocols $term, $event	387	=item on_wm_protocols $term, $event
730		388
731	=item on_wm_delete_window $term, $event	389	=item on_wm_delete_window $term, $event
…		…
742	=cut	400	=cut
743		401
744	package urxvt;	402	package urxvt;
745		403
746	use utf8;	404	use utf8;
747	use strict;	405	use strict 'vars';
748	use Carp ();	406	use Carp ();
749	use Scalar::Util ();	407	use Scalar::Util ();
750	use List::Util ();	408	use List::Util ();
751		409
752	our $VERSION = 1;	410	our $VERSION = 1;
753	our $TERM;	411	our $TERM;
754	our @TERM_INIT;	412	our @TERM_INIT; # should go, prevents async I/O etc.
755	our @TERM_EXT;	413	our @TERM_EXT; # should go, prevents async I/O etc.
756	our @HOOKNAME;	414	our @HOOKNAME;
757	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
758	our %OPTION;	416	our %OPTION;
759		417
760	our $LIBDIR;	418	our $LIBDIR;
…		…
858	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,	516	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
859	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	517	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
860	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	518	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
861		519
862	Various constants for use in X calls and event processing.	520	Various constants for use in X calls and event processing.
		521
		522	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		523	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		524	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		525	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		526	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		527	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		528	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtModeMouse,
		529	PrivMode_ExtMouseRight, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		530	PrivMode_Default
		531
		532	Constants for checking DEC private modes.
863		533
864	=back	534	=back
865		535
866	=head2 RENDITION	536	=head2 RENDITION
867		537
…		…
930	};	600	};
931	}	601	}
932		602
933	no warnings 'utf8';	603	no warnings 'utf8';
934		604
		605	sub parse_resource {
		606	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		607
		608	$term->scan_extensions;
		609
		610	# iterating over all resources has quadratic time overhead
		611	# overall, maybe this could be optimised?
		612	my $r = $term->{meta}{resource};
		613	keys %$r; # reset iterator
		614	while (my ($k, $v) = each %$r) {
		615	my $pattern = $k;
		616	$pattern =~ y/./-/ if $isarg;
		617	my $prefix = $name;
		618	my $suffix;
		619	if ($pattern =~ /\-$/) {
		620	$prefix = substr $name, 0, length $pattern;
		621	$suffix = substr $name, length $pattern;
		622	}
		623	if ($pattern eq $prefix) {
		624	$name = "$urxvt::RESCLASS.$k$suffix";
		625
		626	push @{ $term->{perl_ext_3} }, $v->[0];
		627
		628	return 1 unless $isarg;
		629
		630	if ($v->[1] eq "boolean") {
		631	$term->put_option_db ($name, $flag ? "true" : "false");
		632	return 1;
		633	} else {
		634	$term->put_option_db ($name, $value);
		635	return 1 + 2;
		636	}
		637	}
		638	}
		639
		640	0
		641	}
		642
		643	sub usage {
		644	my ($term, $usage_type) = @_;
		645
		646	$term->scan_extensions;
		647
		648	my $r = $term->{meta}{resource};
		649
		650	for my $pattern (sort keys %$r) {
		651	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		652
		653	$desc .= " (-pe $ext)";
		654
		655	if ($usage_type == 1) {
		656	$pattern =~ y/./-/;
		657	$pattern =~ s/-$/-.../g;
		658
		659	if ($type eq "boolean") {
		660	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		661	} else {
		662	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		663	}
		664	} else {
		665	$pattern =~ s/\.$/.*/g;
		666	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		667	}
		668	}
		669	}
		670
935	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	671	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
936		672
937	sub verbose {	673	sub verbose {
938	my ($level, $msg) = @_;	674	my ($level, $msg) = @_;
939	warn "$msg\n" if $level <= $verbosity;	675	warn "$msg\n" if $level <= $verbosity;
…		…
951	$pkg =~ s/[^[:word:]]/_/g;	687	$pkg =~ s/[^[:word:]]/_/g;
952	$pkg = "urxvt::ext::$pkg";	688	$pkg = "urxvt::ext::$pkg";
953		689
954	verbose 3, "loading extension '$path' into package '$pkg'";	690	verbose 3, "loading extension '$path' into package '$pkg'";
955		691
		692	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		693
956	open my $fh, "<:raw", $path	694	open my $fh, "<:raw", $path
957	or die "$path: $!";	695	or die "$path: $!";
958		696
959	my $source =	697	my $source =
960	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	698	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
961	. "#line 1 \"$path\"\n{\n"	699	. "#line 1 \"$path\"\n{\n"
962	. (do { local $/; <$fh> })	700	. (do { local $/; <$fh> })
963	. "\n};\n1";	701	. "\n};\n1";
964		702
965	eval $source	703	eval $source
…		…
974	# called by the rxvt core	712	# called by the rxvt core
975	sub invoke {	713	sub invoke {
976	local $TERM = shift;	714	local $TERM = shift;
977	my $htype = shift;	715	my $htype = shift;
978		716
979	if ($htype == 0) { # INIT	717	if ($htype == HOOK_INIT) {
980	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	718	my @dirs = $TERM->perl_libdirs;
		719
		720	$TERM->scan_extensions;
981		721
982	my %ext_arg;	722	my %ext_arg;
983		723
984	{	724	{
985	my @init = @TERM_INIT;	725	my @init = @TERM_INIT;
…		…
988	my @pkg = @TERM_EXT;	728	my @pkg = @TERM_EXT;
989	@TERM_EXT = ();	729	@TERM_EXT = ();
990	$TERM->register_package ($_) for @pkg;	730	$TERM->register_package ($_) for @pkg;
991	}	731	}
992		732
		733	for (
993	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	734	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		735	@{ delete $TERM->{perl_ext_3} }
		736	) {
994	if ($_ eq "default") {	737	if ($_ eq "default") {
		738
		739	$ext_arg{$_} = []
995	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	740	for qw(selection option-popup selection-popup readline searchable-scrollback);
		741
		742	for ($TERM->_keysym_resources) {
		743	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		744	next unless /^([A-Za-z0-9_\-]+):/;
		745
		746	my $ext = $1;
		747
		748	$ext_arg{$ext} = [];
		749	}
		750
996	} elsif (/^-(.*)$/) {	751	} elsif (/^-(.*)$/) {
997	delete $ext_arg{$1};	752	delete $ext_arg{$1};
		753
998	} elsif (/^([^<]+)<(.*)>$/) {	754	} elsif (/^([^<]+)<(.*)>$/) {
999	push @{ $ext_arg{$1} }, $2;	755	push @{ $ext_arg{$1} }, $2;
		756
1000	} else {	757	} else {
1001	$ext_arg{$_} \|\|= [];	758	$ext_arg{$_} \|\|= [];
1002	}	759	}
1003	}	760	}
1004		761
…		…
1020		777
1021	if (my $cb = $TERM->{_hook}[$htype]) {	778	if (my $cb = $TERM->{_hook}[$htype]) {
1022	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	779	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1023	if $verbosity >= 10;	780	if $verbosity >= 10;
1024		781
		782	if ($htype == HOOK_ACTION) {
		783	# this hook is only sent to the extension with the name
		784	# matching the first arg
		785	my $pkg = shift;
		786	$pkg =~ y/-/_/;
		787	$pkg = "urxvt::ext::$pkg";
		788
		789	$cb = $cb->{$pkg}
		790	or return undef; #TODO: maybe warn user?
		791
		792	$cb = { $pkg => $cb };
		793	}
		794
1025	for my $pkg (keys %$cb) {	795	for my $pkg (keys %$cb) {
1026	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	796	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
1027	$retval \|\|= $retval_;	797	$retval \|\|= $retval_;
1028		798
1029	if ($@) {	799	if ($@) {
1030	$TERM->ungrab; # better to lose the grab than the session	800	$TERM->ungrab; # better to lose the grab than the session
1031	warn $@;	801	warn $@;
…		…
1034		804
1035	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	805	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1036	if $verbosity >= 11;	806	if $verbosity >= 11;
1037	}	807	}
1038		808
1039	if ($htype == 1) { # DESTROY	809	if ($htype == HOOK_DESTROY) {
1040	# clear package objects	810	# clear package objects
1041	%$_ = () for values %{ $TERM->{_pkg} };	811	%$_ = () for values %{ $TERM->{_pkg} };
1042		812
1043	# clear package	813	# clear package
1044	%$TERM = ();	814	%$TERM = ();
…		…
1074	}	844	}
1075	}	845	}
1076	($mask, @color{qw(fg bg)}, \@failed)	846	($mask, @color{qw(fg bg)}, \@failed)
1077	}	847	}
1078		848
1079	# urxvt::term::extension
1080
1081	package urxvt::term::extension;	849	package urxvt::term::extension;
1082		850
1083	sub enable {	851	=head2 The C<urxvt::term::extension> class
1084	my ($self, %hook) = @_;
1085	my $pkg = $self->{_pkg};
1086		852
1087	while (my ($name, $cb) = each %hook) {	853	Each extension attached to a terminal object is represented by
1088	my $htype = $HOOKTYPE{uc $name};	854	a C<urxvt::term::extension> object.
1089	defined $htype
1090	or Carp::croak "unsupported hook type '$name'";
1091		855
1092	$self->set_should_invoke ($htype, +1)	856	You can use these objects, which are passed to all callbacks to store any
1093	unless exists $self->{term}{_hook}[$htype]{$pkg};	857	state related to the terminal and extension instance.
1094		858
1095	$self->{term}{_hook}[$htype]{$pkg} = $cb;	859	The methods (And data members) documented below can be called on extension
1096	}	860	objects, in addition to call methods documented for the <urxvt::term>
1097	}	861	class.
1098		862
1099	sub disable {	863	=over 4
1100	my ($self, @hook) = @_;
1101	my $pkg = $self->{_pkg};
1102		864
1103	for my $name (@hook) {	865	=item $urxvt_term = $self->{term}
1104	my $htype = $HOOKTYPE{uc $name};
1105	defined $htype
1106	or Carp::croak "unsupported hook type '$name'";
1107		866
1108	$self->set_should_invoke ($htype, -1)	867	Returns the C<urxvt::term> object associated with this instance of the
1109	if delete $self->{term}{_hook}[$htype]{$pkg};	868	extension. This member I<must not> be changed in any way.
1110	}	869
1111	}	870	=cut
1112		871
1113	our $AUTOLOAD;	872	our $AUTOLOAD;
1114		873
1115	sub AUTOLOAD {	874	sub AUTOLOAD {
1116	$AUTOLOAD =~ /:([^:]+)$/	875	$AUTOLOAD =~ /:([^:]+)$/
…		…
1129		888
1130	sub DESTROY {	889	sub DESTROY {
1131	# nop	890	# nop
1132	}	891	}
1133		892
1134	# urxvt::destroy_hook	893	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1135		894
1136	sub urxvt::destroy_hook::DESTROY {	895	sub urxvt::destroy_hook::DESTROY {
1137	${$_[0]}->();	896	${$_[0]}->();
1138	}	897	}
1139		898
1140	sub urxvt::destroy_hook(&) {	899	sub urxvt::destroy_hook(&) {
1141	bless \shift, urxvt::destroy_hook::	900	bless \shift, urxvt::destroy_hook::
1142	}	901	}
		902
		903	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		904
		905	Dynamically enable the given hooks (named without the C<on_> prefix) for
		906	this extension, replacing any hook previously installed via C<enable> in
		907	this extension.
		908
		909	This is useful when you want to overwrite time-critical hooks only
		910	temporarily.
		911
		912	To install additional callbacks for the same hook, you can use the C<on>
		913	method of the C<urxvt::term> class.
		914
		915	=item $self->disable ($hook_name[, $hook_name..])
		916
		917	Dynamically disable the given hooks.
		918
		919	=cut
		920
		921	sub enable {
		922	my ($self, %hook) = @_;
		923	my $pkg = $self->{_pkg};
		924
		925	while (my ($name, $cb) = each %hook) {
		926	my $htype = $HOOKTYPE{uc $name};
		927	defined $htype
		928	or Carp::croak "unsupported hook type '$name'";
		929
		930	$self->set_should_invoke ($htype, +1)
		931	unless exists $self->{term}{_hook}[$htype]{$pkg};
		932
		933	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		934	}
		935	}
		936
		937	sub disable {
		938	my ($self, @hook) = @_;
		939	my $pkg = $self->{_pkg};
		940
		941	for my $name (@hook) {
		942	my $htype = $HOOKTYPE{uc $name};
		943	defined $htype
		944	or Carp::croak "unsupported hook type '$name'";
		945
		946	$self->set_should_invoke ($htype, -1)
		947	if delete $self->{term}{_hook}[$htype]{$pkg};
		948	}
		949	}
		950
		951	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		952
		953	Similar to the C<enable> enable, but installs additional callbacks for
		954	the given hook(s) (that is, it doesn't replace existing callbacks), and
		955	returns a guard object. When the guard object is destroyed the callbacks
		956	are disabled again.
		957
		958	=cut
		959
		960	sub urxvt::extension::on_disable::DESTROY {
		961	my $disable = shift;
		962
		963	my $term = delete $disable->{""};
		964
		965	while (my ($htype, $id) = each %$disable) {
		966	delete $term->{_hook}[$htype]{$id};
		967	$term->set_should_invoke ($htype, -1);
		968	}
		969	}
		970
		971	sub on {
		972	my ($self, %hook) = @_;
		973
		974	my $term = $self->{term};
		975
		976	my %disable = ( "" => $term );
		977
		978	while (my ($name, $cb) = each %hook) {
		979	my $htype = $HOOKTYPE{uc $name};
		980	defined $htype
		981	or Carp::croak "unsupported hook type '$name'";
		982
		983	$term->set_should_invoke ($htype, +1);
		984	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		985	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		986	}
		987
		988	bless \%disable, "urxvt::extension::on_disable"
		989	}
		990
		991	=item $self->bind_action ($hotkey, $action)
		992
		993	=item $self->x_resource ($pattern)
		994
		995	=item $self->x_resource_boolean ($pattern)
		996
		997	These methods support an additional C<%> prefix for C<$action> or
		998	C<$pattern> when called on an extension object, compared to the
		999	C<urxvt::term> methods of the same name - see the description of these
		1000	methods in the C<urxvt::term> class for details.
		1001
		1002	=cut
		1003
		1004	sub bind_action {
		1005	my ($self, $hotkey, $action) = @_;
		1006	$action =~ s/^%:/$_[0]{_name}:/;
		1007	$self->{term}->bind_action ($hotkey, $action)
		1008	}
		1009
		1010	sub x_resource {
		1011	my ($self, $name) = @_;
		1012	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		1013	$self->{term}->x_resource ($name)
		1014	}
		1015
		1016	sub x_resource_boolean {
		1017	my ($self, $name) = @_;
		1018	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		1019	$self->{term}->x_resource_boolean ($name)
		1020	}
		1021
		1022	=back
		1023
		1024	=cut
1143		1025
1144	package urxvt::anyevent;	1026	package urxvt::anyevent;
1145		1027
1146	=head2 The C<urxvt::anyevent> Class	1028	=head2 The C<urxvt::anyevent> Class
1147		1029
1148	The sole purpose of this class is to deliver an interface to the	1030	The sole purpose of this class is to deliver an interface to the
1149	C<AnyEvent> module - any module using it will work inside urxvt without	1031	C<AnyEvent> module - any module using it will work inside urxvt without
1150	further programming. The only exception is that you cannot wait on	1032	further programming. The only exception is that you cannot wait on
1151	condition variables, but non-blocking condvar use is ok. What this means	1033	condition variables, but non-blocking condvar use is ok.
1152	is that you cannot use blocking APIs, but the non-blocking variant should	1034
1153	work.	1035	In practical terms this means is that you cannot use blocking APIs, but
		1036	the non-blocking variant should work.
1154		1037
1155	=cut	1038	=cut
1156		1039
1157	our $VERSION = '5.23';	1040	our $VERSION = '5.23';
1158		1041
…		…
1242	urxvt::verbose 6, "register package $pkg to $self";	1125	urxvt::verbose 6, "register package $pkg to $self";
1243		1126
1244	@{"$pkg\::ISA"} = urxvt::term::extension::;	1127	@{"$pkg\::ISA"} = urxvt::term::extension::;
1245		1128
1246	my $proxy = bless {	1129	my $proxy = bless {
1247	_pkg => $pkg,	1130	_pkg => $pkg,
		1131	_name => ${"$pkg\::_NAME"}, # hackish
1248	argv => $argv,	1132	argv => $argv,
1249	}, $pkg;	1133	}, $pkg;
1250	Scalar::Util::weaken ($proxy->{term} = $self);	1134	Scalar::Util::weaken ($proxy->{term} = $self);
1251		1135
1252	$self->{_pkg}{$pkg} = $proxy;	1136	$self->{_pkg}{$pkg} = $proxy;
1253		1137
…		…
1256	$proxy->enable ($name => $ref);	1140	$proxy->enable ($name => $ref);
1257	}	1141	}
1258	}	1142	}
1259	}	1143	}
1260		1144
		1145	sub perl_libdirs {
		1146	map { split /:/ }
		1147	$_[0]->resource ("perl_lib"),
		1148	$ENV{URXVT_PERL_LIB},
		1149	"$ENV{HOME}/.urxvt/ext",
		1150	"$LIBDIR/perl"
		1151	}
		1152
		1153	# scan for available extensions and collect their metadata
		1154	sub scan_extensions {
		1155	my ($self) = @_;
		1156
		1157	return if exists $self->{meta};
		1158
		1159	my @urxvtdirs = perl_libdirs $self;
		1160	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1161
		1162	$self->{meta} = \my %meta;
		1163
		1164	# first gather extensions
		1165
		1166	my $gather = sub {
		1167	my ($dir, $core) = @_;
		1168
		1169	opendir my $fh, $dir
		1170	or return;
		1171
		1172	for my $ext (readdir $fh) {
		1173	$ext !~ /^\./
		1174	or next;
		1175
		1176	open my $fh, "<", "$dir/$ext"
		1177	or next;
		1178
		1179	-f $fh
		1180	or next;
		1181
		1182	$ext =~ s/\.uext$// or $core
		1183	or next;
		1184
		1185	my %ext = (dir => $dir);
		1186
		1187	while (<$fh>) {
		1188	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1189	my ($pattern, $type, $desc) = split /:/, $1;
		1190	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1191	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1192	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1193	} else {
		1194	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1195	}
		1196	} elsif (/^\s*(?:#\|$)/) {
		1197	# skip other comments and empty lines
		1198	} else {
		1199	last; # stop parsing on first non-empty non-comment line
		1200	}
		1201	}
		1202
		1203	$meta{ext}{$ext} = \%ext;
		1204	}
		1205	};
		1206
		1207	# $gather->($_, 0) for @cpandirs;
		1208	$gather->($_, 1) for @urxvtdirs;
		1209
		1210	# and now merge resources
		1211
		1212	$meta{resource} = \my %resource;
		1213
		1214	while (my ($k, $v) = each %{ $meta{ext} }) {
		1215	#TODO: should check for extensions overriding each other
		1216	%resource = (%resource, %{ $v->{resource} });
		1217	}
		1218	}
		1219
1261	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1220	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1262		1221
1263	Creates a new terminal, very similar as if you had started it with system	1222	Creates a new terminal, very similar as if you had started it with system
1264	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1223	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1265	hash which defines the environment of the new terminal.	1224	hash which defines the environment of the new terminal.
…		…
1282	}	1241	}
1283		1242
1284	=item $term->destroy	1243	=item $term->destroy
1285		1244
1286	Destroy the terminal object (close the window, free resources	1245	Destroy the terminal object (close the window, free resources
1287	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1246	etc.). Please note that urxvt will not exit as long as any event
1288	watchers (timers, io watchers) are still active.	1247	watchers (timers, io watchers) are still active.
1289		1248
1290	=item $term->exec_async ($cmd[, @args])	1249	=item $term->exec_async ($cmd[, @args])
1291		1250
1292	Works like the combination of the C<fork>/C<exec> builtins, which executes	1251	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1348		1307
1349	Here is a likely non-exhaustive list of resource names, not all of which	1308	Here is a likely non-exhaustive list of resource names, not all of which
1350	are supported in every build, please see the source file F</src/rsinc.h>	1309	are supported in every build, please see the source file F</src/rsinc.h>
1351	to see the actual list:	1310	to see the actual list:
1352		1311
1353	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1312	answerbackstring backgroundPixmap backspace_key blurradius
1354	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1313	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1355	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1314	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1356	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1315	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1357	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1316	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1358	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1317	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1378	Returns the X-Resource for the given pattern, excluding the program or	1337	Returns the X-Resource for the given pattern, excluding the program or
1379	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1338	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1380	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1339	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1381	resource with that pattern exists.	1340	resource with that pattern exists.
1382		1341
		1342	Extensions that define extra resources also need to call this method
		1343	to access their values.
		1344
		1345	If the method is called on an extension object (basically, from an
		1346	extension), then the special prefix C<%.> will be replaced by the name of
		1347	the extension and a dot, and the lone string C<%> will be replaced by the
		1348	extension name itself. This makes it possible to code extensions so you
		1349	can rename them and get a new set of resources without having to change
		1350	the actual code.
		1351
1383	This method should only be called during the C<on_start> hook, as there is	1352	This method should only be called during the C<on_start> hook, as there is
1384	only one resource database per display, and later invocations might return	1353	only one resource database per display, and later invocations might return
1385	the wrong resources.	1354	the wrong resources.
1386		1355
1387	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1356	=item $value = $term->x_resource_boolean ($pattern)
1388		1357
		1358	Like C<x_resource>, above, but interprets the string value as a boolean
		1359	and returns C<1> for true values, C<0> for false values and C<undef> if
		1360	the resource or option isn't specified.
		1361
		1362	You should always use this method to parse boolean resources.
		1363
		1364	=cut
		1365
		1366	sub x_resource_boolean {
		1367	my $res = &x_resource;
		1368
		1369	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1370	}
		1371
		1372	=item $action = $term->lookup_keysym ($keysym, $state)
		1373
		1374	Returns the action bound to key combination C<($keysym, $state)>,
		1375	if a binding for it exists, and C<undef> otherwise.
		1376
		1377	=item $success = $term->bind_action ($key, $action)
		1378
1389	Adds a keymap translation exactly as specified via a resource. See the	1379	Adds a key binding exactly as specified via a C<keysym> resource. See the
1390	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1380	C<keysym> resource in the urxvt(1) manpage.
		1381
		1382	To add default bindings for actions, an extension should call C<<
		1383	->bind_action >> in its C<init> hook for every such binding. Doing it
		1384	in the C<init> hook allows users to override or remove the binding
		1385	again.
		1386
		1387	Example: the C<searchable-scrollback> by default binds itself
		1388	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1389	$term->bind_action >>.
		1390
		1391	sub init {
		1392	my ($self) = @_;
		1393
		1394	$self->bind_action ("M-s" => "%:start");
		1395	}
1391		1396
1392	=item $rend = $term->rstyle ([$new_rstyle])	1397	=item $rend = $term->rstyle ([$new_rstyle])
1393		1398
1394	Return and optionally change the current rendition. Text that is output by	1399	Return and optionally change the current rendition. Text that is output by
1395	the terminal application will use this style.	1400	the terminal application will use this style.
…		…
1553		1558
1554	=item $term->scr_add_lines ($string)	1559	=item $term->scr_add_lines ($string)
1555		1560
1556	Write the given text string to the screen, as if output by the application	1561	Write the given text string to the screen, as if output by the application
1557	running inside the terminal. It may not contain command sequences (escape	1562	running inside the terminal. It may not contain command sequences (escape
1558	codes), but is free to use line feeds, carriage returns and tabs. The	1563	codes - see C<cmd_parse> for that), but is free to use line feeds,
1559	string is a normal text string, not in locale-dependent encoding.	1564	carriage returns and tabs. The string is a normal text string, not in
		1565	locale-dependent encoding.
1560		1566
1561	Normally its not a good idea to use this function, as programs might be	1567	Normally its not a good idea to use this function, as programs might be
1562	confused by changes in cursor position or scrolling. Its useful inside a	1568	confused by changes in cursor position or scrolling. Its useful inside a
1563	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1564		1570
…		…
1572	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1573	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1574		1580
1575	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1576		1582
1577	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1583	Write the octets given in C<$octets> to the tty (i.e. as user input
		1584	to the program, see C<cmd_parse> for the opposite direction). To pass
1578	pass characters instead of octets, you should convert your strings first	1585	characters instead of octets, you should convert your strings first to the
1579	to the locale-specific encoding using C<< $term->locale_encode >>.	1586	locale-specific encoding using C<< $term->locale_encode >>.
		1587
		1588	=item $term->tt_write_user_input ($octets)
		1589
		1590	Like C<tt_write>, but should be used when writing strings in response to
		1591	the user pressing a key, to invoke the additional actions requested by
		1592	the user for that case (C<tt_write> doesn't do that).
		1593
		1594	The typical use case would be inside C<on_action> hooks.
1580		1595
1581	=item $term->tt_paste ($octets)	1596	=item $term->tt_paste ($octets)
1582		1597
1583	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1598	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1584	CR and bracketing the data with control sequences if bracketed paste mode	1599	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1609	Adds the specified events to the vt event mask. Useful e.g. when you want	1624	Adds the specified events to the vt event mask. Useful e.g. when you want
1610	to receive pointer events all the times:	1625	to receive pointer events all the times:
1611		1626
1612	$term->vt_emask_add (urxvt::PointerMotionMask);	1627	$term->vt_emask_add (urxvt::PointerMotionMask);
1613		1628
		1629	=item $term->set_urgency ($set)
		1630
		1631	Enable/disable the urgency hint on the toplevel window.
		1632
1614	=item $term->focus_in	1633	=item $term->focus_in
1615		1634
1616	=item $term->focus_out	1635	=item $term->focus_out
1617		1636
1618	=item $term->key_press ($state, $keycode[, $time])	1637	=item $term->key_press ($state, $keycode[, $time])
1619		1638
1620	=item $term->key_release ($state, $keycode[, $time])	1639	=item $term->key_release ($state, $keycode[, $time])
1621		1640
1622	Deliver various fake events to to terminal.	1641	Deliver various fake events to to terminal.
1623		1642
1624	=item $window_width = $term->width	1643	=item $window_width = $term->width ([$new_value])
1625		1644
1626	=item $window_height = $term->height	1645	=item $window_height = $term->height ([$new_value])
1627		1646
1628	=item $font_width = $term->fwidth	1647	=item $font_width = $term->fwidth ([$new_value])
1629		1648
1630	=item $font_height = $term->fheight	1649	=item $font_height = $term->fheight ([$new_value])
1631		1650
1632	=item $font_ascent = $term->fbase	1651	=item $font_ascent = $term->fbase ([$new_value])
1633		1652
1634	=item $terminal_rows = $term->nrow	1653	=item $terminal_rows = $term->nrow ([$new_value])
1635		1654
1636	=item $terminal_columns = $term->ncol	1655	=item $terminal_columns = $term->ncol ([$new_value])
1637		1656
1638	=item $has_focus = $term->focus	1657	=item $has_focus = $term->focus ([$new_value])
1639		1658
1640	=item $is_mapped = $term->mapped	1659	=item $is_mapped = $term->mapped ([$new_value])
1641		1660
1642	=item $max_scrollback = $term->saveLines	1661	=item $max_scrollback = $term->saveLines ([$new_value])
1643		1662
1644	=item $nrow_plus_saveLines = $term->total_rows	1663	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1645		1664
1646	=item $topmost_scrollback_row = $term->top_row	1665	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1647		1666
1648	Return various integers describing terminal characteristics.	1667	Return various integers describing terminal characteristics. If an
		1668	argument is given, changes the value and returns the previous one.
1649		1669
1650	=item $x_display = $term->display_id	1670	=item $x_display = $term->display_id
1651		1671
1652	Return the DISPLAY used by rxvt-unicode.	1672	Return the DISPLAY used by rxvt-unicode.
1653		1673
…		…
1689	Returns the currently displayed screen (0 primary, 1 secondary).	1709	Returns the currently displayed screen (0 primary, 1 secondary).
1690		1710
1691	=item $cursor_is_hidden = $term->hidden_cursor	1711	=item $cursor_is_hidden = $term->hidden_cursor
1692		1712
1693	Returns whether the cursor is currently hidden or not.	1713	Returns whether the cursor is currently hidden or not.
		1714
		1715	=item $priv_modes = $term->priv_modes
		1716
		1717	Returns a bitset with the state of DEC private modes.
		1718
		1719	Example:
		1720
		1721	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1722	# mouse reporting is turned on
		1723	}
1694		1724
1695	=item $view_start = $term->view_start ([$newvalue])	1725	=item $view_start = $term->view_start ([$newvalue])
1696		1726
1697	Returns the row number of the topmost displayed line. Maximum value is	1727	Returns the row number of the topmost displayed line. Maximum value is
1698	C<0>, which displays the normal terminal contents. Lower values scroll	1728	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1703	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1733	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1704	compare the on-screen display with its stored representation. If they	1734	compare the on-screen display with its stored representation. If they
1705	differ, it redraws the differences.	1735	differ, it redraws the differences.
1706		1736
1707	Used after changing terminal contents to display them.	1737	Used after changing terminal contents to display them.
		1738
		1739	=item $term->refresh_check
		1740
		1741	Checks if a refresh has been requested and, if so, schedules one.
1708		1742
1709	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1743	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1710		1744
1711	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1745	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1712	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1746	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1814	}	1848	}
1815		1849
1816	sub urxvt::line::t {	1850	sub urxvt::line::t {
1817	my ($self) = @_;	1851	my ($self) = @_;
1818		1852
1819	if (@_ > 1)	1853	if (@_ > 1) {
1820	{
1821	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1854	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1822	for $self->{beg} .. $self->{end};	1855	for $self->{beg} .. $self->{end};
1823	}	1856	}
1824		1857
1825	defined wantarray &&	1858	defined wantarray &&
1826	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1859	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1827	0, $self->{len}	1860	0, $self->{len}
1828	}	1861	}
1829		1862
1830	sub urxvt::line::r {	1863	sub urxvt::line::r {
1831	my ($self) = @_;	1864	my ($self) = @_;
1832		1865
1833	if (@_ > 1)	1866	if (@_ > 1) {
1834	{
1835	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1867	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1836	for $self->{beg} .. $self->{end};	1868	for $self->{beg} .. $self->{end};
1837	}	1869	}
1838		1870
1839	if (defined wantarray) {	1871	if (defined wantarray) {
1840	my $rend = [	1872	my $rend = [
1841	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1873	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1842	];	1874	];
…		…
1933	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1965	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1934		1966
1935	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1967	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1936		1968
1937	=item $term->XChangeInput ($window, $add_events[, $del_events])	1969	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1970
		1971	=item $keysym = $term->XStringToKeysym ($string)
		1972
		1973	=item $string = $term->XKeysymToString ($keysym)
1938		1974
1939	Various X or X-related functions. The C<$term> object only serves as	1975	Various X or X-related functions. The C<$term> object only serves as
1940	the source of the display, otherwise those functions map more-or-less	1976	the source of the display, otherwise those functions map more-or-less
1941	directly onto the X functions of the same name.	1977	directly onto the X functions of the same name.
1942		1978

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.199 by sf-exg, Sun Nov 20 10:49:56 2011 UTC vs. Revision 1.258 by root, Tue Sep 17 20:38:14 2019 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.199 by sf-exg, Sun Nov 20 10:49:56 2011 UTC vs.
Revision 1.258 by root, Tue Sep 17 20:38:14 2019 UTC