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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.164 by root, Mon Dec 24 08:21:40 2007 UTC vs.
Revision 1.225 by root, Fri Aug 10 19:06:06 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"	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<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed
		38	using 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	@@RXVT_NAME@@ -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 that add command line parameters or resources on their own are
48		49	loaded automatically when used.
49	=item selection (enabled by default)
50
51	(More) intelligent selection. This extension tries to be more intelligent
52	when the user extends selections (double-click and further clicks). Right
53	now, it tries to select words, urls and complete shell-quoted
54	arguments, which is very convenient, too, if your F<ls> supports
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 from the keyboard.
265	Simply bind a keysym to "perl:matcher" as seen in the example below.
266
267	Example configuration:
268
269	URxvt.perl-ext: default,matcher
270	URxvt.urlLauncher: sensible-browser
271	URxvt.keysym.C-Delete: perl:matcher
272	URxvt.matcher.button: 1
273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
275	URxvt.matcher.launcher.2: gvim +$2 $1
276
277	=item xim-onthespot
278
279	This (experimental) perl extension implements OnTheSpot editing. It does
280	not work perfectly, and some input methods don't seem to work well with
281	OnTheSpot editing in general, but it seems to work at least for SCIM and
282	kinput2.
283
284	You enable it by specifying this extension and a preedit style of
285	C<OnTheSpot>, i.e.:
286
287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
288
289	=item kuake<hotkey>
290
291	A very primitive quake-console-like extension. It was inspired by a
292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
293	user presses a global accelerator key (by default C<F10>), the terminal
294	will show or hide itself. Another press of the accelerator key will hide
295	or show it again.
296
297	Initially, the window will not be shown when using this extension.
298
299	This is useful if you need a single terminal that is not using any desktop
300	space most of the time but is quickly available at the press of a key.
301
302	The accelerator key is grabbed regardless of any modifiers, so this
303	extension will actually grab a physical key just for this function.
304
305	If you want a quake-like animation, tell your window manager to do so
306	(fvwm can do it).
307
308	=item block-graphics-to-ascii
309
310	A not very useful example of filtering all text output to the terminal
311	by replacing all line-drawing characters (U+2500 .. U+259F) by a
312	similar-looking ascii character.
313
314	=item digital-clock
315
316	Displays a digital clock using the built-in overlay.
317
318	=item remote-clipboard
319
320	Somewhat of a misnomer, this extension adds two menu entries to the
321	selection popup that allows one to run external commands to store the
322	selection somewhere and fetch it again.
323
324	We use it to implement a "distributed selection mechanism", which just
325	means that one command uploads the file to a remote server, and another
326	reads it.
327
328	The commands can be set using the C<URxvt.remote-selection.store> and
329	C<URxvt.remote-selection.fetch> resources. The first should read the
330	selection to store from STDIN (always in UTF-8), the second should provide
331	the selection data on STDOUT (also in UTF-8).
332
333	The defaults (which are likely useless to you) use rsh and cat:
334
335	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
336	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
337
338	=item selection-pastebin
339
340	This is a little rarely useful extension that Uploads the selection as
341	textfile to a remote site (or does other things). (The implementation is
342	not currently secure for use in a multiuser environment as it writes to
343	F</tmp> directly.).
344
345	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
346	i.e.
347
348	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
349
350	Pressing this combination runs a command with C<%> replaced by the name of
351	the textfile. This command can be set via a resource:
352
353	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
354
355	And the default is likely not useful to anybody but the few people around
356	here :)
357
358	The name of the textfile is the hex encoded md5 sum of the selection, so
359	the same content should lead to the same filename.
360
361	After a successful upload the selection will be replaced by the text given
362	in the C<selection-pastebin-url> resource (again, the % is the placeholder
363	for the filename):
364
365	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366
367	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
368	the double C</> characters as comment start. Use C<\057\057> instead,
369	which works regardless of wether xrdb is used to parse the resource file
370	or not.
371
372	=item example-refresh-hooks
373
374	Displays a very simple digital clock in the upper right corner of the
375	window. Illustrates overwriting the refresh callbacks to create your own
376	overlays or changes.
377
378	=back
379		50
380	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
381		52
382	=head2 General API Considerations	53	=head2 General API Considerations
383		54
…		…
397		68
398	=over 4	69	=over 4
399		70
400	=item $text	71	=item $text
401		72
402	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
403	always represents one screen cell. See L<ROW_t> for a discussion of this format.	74	always represents one screen cell. See L<ROW_t> for a discussion of this format.
404		75
405	=item $string	76	=item $string
406		77
407	A perl text string, with an emphasis on I<text>. It can store all unicode	78	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
411	=item $octets	82	=item $octets
412		83
413	Either binary data or - more common - a text string encoded in a	84	Either binary data or - more common - a text string encoded in a
414	locale-specific way.	85	locale-specific way.
415		86
		87	=item $keysym
		88
		89	an integer that is a valid X11 keysym code. You can convert a string
		90	into a keysym and viceversa by using C<XStringToKeysym> and
		91	C<XKeysymToString>.
		92
416	=back	93	=back
417		94
418	=head2 Extension Objects	95	=head2 Extension Objects
419		96
420	Every perl extension is a perl class. A separate perl object is created	97	Every perl extension is a perl class. A separate perl object is created
421	for each terminal, and each terminal has its own set of extenion objects,	98	for each terminal, and each terminal has its own set of extension objects,
422	which are passed as the first parameter to hooks. So extensions can use	99	which are passed as the first parameter to hooks. So extensions can use
423	their C<$self> object without having to think about clashes with other	100	their C<$self> object without having to think about clashes with other
424	extensions or other terminals, with the exception of methods and members	101	extensions or other terminals, with the exception of methods and members
425	that begin with an underscore character C<_>: these are reserved for	102	that begin with an underscore character C<_>: these are reserved for
426	internal use.	103	internal use.
427		104
428	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
429	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
430		107
431	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
432		109	the C<urxvt::extension> section below.
433	=over 4
434
435	=item $urxvt_term = $self->{term}
436
437	Returns the C<urxvt::term> object associated with this instance of the
438	extension. This member I<must not> be changed in any way.
439
440	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
441
442	Dynamically enable the given hooks (named without the C<on_> prefix) for
443	this extension, replacing any previous hook. This is useful when you want
444	to overwrite time-critical hooks only temporarily.
445
446	=item $self->disable ($hook_name[, $hook_name..])
447
448	Dynamically disable the given hooks.
449
450	=back
451		110
452	=head2 Hooks	111	=head2 Hooks
453		112
454	The following subroutines can be declared in extension files, and will be	113	The following subroutines can be declared in extension files, and will be
455	called whenever the relevant event happens.	114	called whenever the relevant event happens.
…		…
541		200
542	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
543	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
544	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
545		204
546	=item on_osc_seq $term, $op, $args	205	=item on_osc_seq $term, $op, $args, $resp
547		206
548	Called on every OSC sequence and can be used to suppress it or modify its	207	Called on every OSC sequence and can be used to suppress it or modify its
549	behaviour. The default should be to return an empty list. A true value	208	behaviour. The default should be to return an empty list. A true value
550	suppresses execution of the request completely. Make sure you don't get	209	suppresses execution of the request completely. Make sure you don't get
551	confused by recursive invocations when you output an osc sequence within	210	confused by recursive invocations when you output an OSC sequence within
552	this callback.	211	this callback.
553		212
554	C<on_osc_seq_perl> should be used for new behaviour.	213	C<on_osc_seq_perl> should be used for new behaviour.
555		214
556	=item on_osc_seq_perl $term, $string	215	=item on_osc_seq_perl $term, $args, $resp
557		216
558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
560	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
561	string should start with the extension name and a colon, to distinguish	220	string should start with the extension name (sans -osc) and a semicolon,
562	it from commands for other extensions, and this might be enforced in the	221	to distinguish it from commands for other extensions, and this might be
563	future.	222	enforced in the future.
		223
		224	For example, C<overlay-osc> uses this:
		225
		226	sub on_osc_seq_perl {
		227	my ($self, $osc, $resp) = @_;
		228
		229	return unless $osc =~ s/^overlay;//;
		230
		231	... process remaining $osc string
		232	}
564		233
565	Be careful not ever to trust (in a security sense) the data you receive,	234	Be careful not ever to trust (in a security sense) the data you receive,
566	as its source can not easily be controlled (e-mail content, messages from	235	as its source can not easily be controlled (e-mail content, messages from
567	other users on the same system etc.).	236	other users on the same system etc.).
		237
		238	For responses, C<$resp> contains the end-of-args separator used by the
		239	sender.
568		240
569	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
570		242
571	Called whenever text is about to be output, with the text as argument. You	243	Called whenever text is about to be output, with the text as argument. You
572	can filter/change and output the text yourself by returning a true value	244	can filter/change and output the text yourself by returning a true value
…		…
577	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
578		250
579	Called whenever some data is written to the tty/pty and can be used to	251	Called whenever some data is written to the tty/pty and can be used to
580	suppress or filter tty input.	252	suppress or filter tty input.
581		253
		254	=item on_tt_paste $term, $octets
		255
		256	Called whenever text is about to be pasted, with the text as argument. You
		257	can filter/change and paste the text yourself by returning a true value
		258	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		259	locale-encoded.
		260
582	=item on_line_update $term, $row	261	=item on_line_update $term, $row
583		262
584	Called whenever a line was updated or changed. Can be used to filter	263	Called whenever a line was updated or changed. Can be used to filter
585	screen output (e.g. underline urls or other useless stuff). Only lines	264	screen output (e.g. underline urls or other useless stuff). Only lines
586	that are being shown will be filtered, and, due to performance reasons,	265	that are being shown will be filtered, and, due to performance reasons,
…		…
593	later with the already-modified line (e.g. if unrelated parts change), so	272	later with the already-modified line (e.g. if unrelated parts change), so
594	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
595		274
596	=item on_refresh_begin $term	275	=item on_refresh_begin $term
597		276
598	Called just before the screen gets redrawn. Can be used for overlay	277	Called just before the screen gets redrawn. Can be used for overlay or
599	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
600	restoring them in refresh_end. The built-in overlay and selection display	279	restoring them in refresh_end. The built-in overlay and selection display
601	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
602		281
603	=item on_refresh_end $term	282	=item on_refresh_end $term
604		283
…		…
611	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the @@RXVT_NAME@@(1) manpage).
612		291
613	The event is simply the action string. This interface is assumed to change	292	The event is simply the action string. This interface is assumed to change
614	slightly in the future.	293	slightly in the future.
615		294
		295	=item on_register_command $term, $keysym, $modifiermask, $string
		296
		297	Called after parsing a keysym resource but before registering the
		298	associated binding. If this hook returns TRUE the binding is not
		299	registered. It can be used to modify a binding by calling
		300	C<register_command>.
		301
616	=item on_resize_all_windows $tern, $new_width, $new_height	302	=item on_resize_all_windows $term, $new_width, $new_height
617		303
618	Called just after the new window size has been calculated, but before	304	Called just after the new window size has been calculated, but before
619	windows are actually being resized or hints are being set. If this hook	305	windows are actually being resized or hints are being set. If this hook
620	returns TRUE, setting of the window hints is being skipped.	306	returns TRUE, setting of the window hints is being skipped.
621		307
…		…
655		341
656	=item on_map_notify $term, $event	342	=item on_map_notify $term, $event
657		343
658	=item on_unmap_notify $term, $event	344	=item on_unmap_notify $term, $event
659		345
660	Called whenever the corresponding X event is received for the terminal If	346	Called whenever the corresponding X event is received for the terminal. If
661	the hook returns true, then the even will be ignored by rxvt-unicode.	347	the hook returns true, then the event will be ignored by rxvt-unicode.
662		348
663	The event is a hash with most values as named by Xlib (see the XEvent	349	The event is a hash with most values as named by Xlib (see the XEvent
664	manpage), with the additional members C<row> and C<col>, which are the	350	manpage), with the additional members C<row> and C<col>, which are the
665	(real, not screen-based) row and column under the mouse cursor.	351	(real, not screen-based) row and column under the mouse cursor.
666		352
…		…
676	=item on_wm_delete_window $term, $event	362	=item on_wm_delete_window $term, $event
677		363
678	Called when various types of ClientMessage events are received (all with	364	Called when various types of ClientMessage events are received (all with
679	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	365	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
680		366
		367	=item on_bell $term
		368
		369	Called on receipt of a bell character.
		370
681	=back	371	=back
682		372
683	=cut	373	=cut
684		374
685	package urxvt;	375	package urxvt;
686		376
687	use utf8;	377	use utf8;
688	use strict;	378	use strict 'vars';
689	use Carp ();	379	use Carp ();
690	use Scalar::Util ();	380	use Scalar::Util ();
691	use List::Util ();	381	use List::Util ();
692		382
693	our $VERSION = 1;	383	our $VERSION = 1;
694	our $TERM;	384	our $TERM;
695	our @TERM_INIT;	385	our @TERM_INIT; # should go, prevents async I/O etc.
696	our @TERM_EXT;	386	our @TERM_EXT; # should go, prevents async I/O etc.
697	our @HOOKNAME;	387	our @HOOKNAME;
698	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	388	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
699	our %OPTION;	389	our %OPTION;
700		390
701	our $LIBDIR;	391	our $LIBDIR;
…		…
749		439
750	=over 4	440	=over 4
751		441
752	=item urxvt::fatal $errormessage	442	=item urxvt::fatal $errormessage
753		443
754	Fatally aborts execution with the given error message. Avoid at all	444	Fatally aborts execution with the given error message (which should
755	costs! The only time this is acceptable is when the terminal process	445	include a trailing newline). Avoid at all costs! The only time this
756	starts up.	446	is acceptable (and useful) is in the init hook, where it prevents the
		447	terminal from starting up.
757		448
758	=item urxvt::warn $string	449	=item urxvt::warn $string
759		450
760	Calls C<rxvt_warn> with the given string which should not include a	451	Calls C<rxvt_warn> with the given string which should include a trailing
761	newline. The module also overwrites the C<warn> builtin with a function	452	newline. The module also overwrites the C<warn> builtin with a function
762	that calls this function.	453	that calls this function.
763		454
764	Using this function has the advantage that its output ends up in the	455	Using this function has the advantage that its output ends up in the
765	correct place, e.g. on stderr of the connecting urxvtc client.	456	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
769	=item @terms = urxvt::termlist	460	=item @terms = urxvt::termlist
770		461
771	Returns all urxvt::term objects that exist in this process, regardless of	462	Returns all urxvt::term objects that exist in this process, regardless of
772	whether they are started, being destroyed etc., so be careful. Only term	463	whether they are started, being destroyed etc., so be careful. Only term
773	objects that have perl extensions attached will be returned (because there	464	objects that have perl extensions attached will be returned (because there
774	is no urxvt::term objet associated with others).	465	is no urxvt::term object associated with others).
775		466
776	=item $time = urxvt::NOW	467	=item $time = urxvt::NOW
777		468
778	Returns the "current time" (as per the event loop).	469	Returns the "current time" (as per the event loop).
779		470
…		…
822		513
823	=item $rend = urxvt::OVERLAY_RSTYLE	514	=item $rend = urxvt::OVERLAY_RSTYLE
824		515
825	Return the rendition mask used for overlays by default.	516	Return the rendition mask used for overlays by default.
826		517
827	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	518	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		519	urxvt::RS_RVid, urxvt::RS_Uline
828		520
829	Return the bit that enabled bold, italic, blink, reverse-video and	521	Return the bit that enabled bold, italic, blink, reverse-video and
830	underline, respectively. To enable such a style, just logically OR it into	522	underline, respectively. To enable such a style, just logically OR it into
831	the bitset.	523	the bitset.
832		524
…		…
869	};	561	};
870	}	562	}
871		563
872	no warnings 'utf8';	564	no warnings 'utf8';
873		565
		566	sub parse_resource {
		567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		568
		569	$name =~ y/-/./ if $isarg;
		570
		571	$term->scan_meta;
		572
		573	my $r = $term->{meta}{resource};
		574	keys %$r; # reste iterator
		575	while (my ($pattern, $v) = each %$r) {
		576	if (
		577	$pattern =~ /\.$/
		578	? $pattern eq substr $name, 0, length $pattern
		579	: $pattern eq $name
		580	) {
		581	$name = "$urxvt::RESCLASS.$name";
		582
		583	push @{ $term->{perl_ext_3} }, $v->[0];
		584
		585	if ($v->[1] eq "boolean") {
		586	$term->put_option_db ($name, $flag ? "true" : "false");
		587	return 1;
		588	} else {
		589	$term->put_option_db ($name, $value);
		590	return 1 + 2;
		591	}
		592	}
		593	}
		594
		595	0
		596	}
		597
		598	sub usage {
		599	my ($term, $usage_type) = @_;
		600
		601	$term->scan_meta;
		602
		603	my $r = $term->{meta}{resource};
		604
		605	for my $pattern (sort keys %$r) {
		606	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		607
		608	$desc .= " (-pe $ext)";
		609
		610	if ($usage_type == 1) {
		611	$pattern =~ y/./-/;
		612	$pattern =~ s/-$/-.../g;
		613
		614	if ($type eq "boolean") {
		615	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		616	} else {
		617	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		618	}
		619	} else {
		620	$pattern =~ s/\.$/.*/g;
		621	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		622	}
		623	}
		624	}
		625
874	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
875		627
876	sub verbose {	628	sub verbose {
877	my ($level, $msg) = @_;	629	my ($level, $msg) = @_;
878	warn "$msg\n" if $level <= $verbosity;	630	warn "$msg\n" if $level <= $verbosity;
…		…
890	$pkg =~ s/[^[:word:]]/_/g;	642	$pkg =~ s/[^[:word:]]/_/g;
891	$pkg = "urxvt::ext::$pkg";	643	$pkg = "urxvt::ext::$pkg";
892		644
893	verbose 3, "loading extension '$path' into package '$pkg'";	645	verbose 3, "loading extension '$path' into package '$pkg'";
894		646
		647	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		648
895	open my $fh, "<:raw", $path	649	open my $fh, "<:raw", $path
896	or die "$path: $!";	650	or die "$path: $!";
897		651
898	my $source =	652	my $source =
899	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
900	. "#line 1 \"$path\"\n{\n"	654	. "#line 1 \"$path\"\n{\n"
901	. (do { local $/; <$fh> })	655	. (do { local $/; <$fh> })
902	. "\n};\n1";	656	. "\n};\n1";
903		657
904	eval $source	658	eval $source
…		…
914	sub invoke {	668	sub invoke {
915	local $TERM = shift;	669	local $TERM = shift;
916	my $htype = shift;	670	my $htype = shift;
917		671
918	if ($htype == 0) { # INIT	672	if ($htype == 0) { # INIT
919	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	673	my @dirs = $TERM->perl_libdirs;
920		674
921	my %ext_arg;	675	my %ext_arg;
922		676
923	{	677	{
924	my @init = @TERM_INIT;	678	my @init = @TERM_INIT;
…		…
927	my @pkg = @TERM_EXT;	681	my @pkg = @TERM_EXT;
928	@TERM_EXT = ();	682	@TERM_EXT = ();
929	$TERM->register_package ($_) for @pkg;	683	$TERM->register_package ($_) for @pkg;
930	}	684	}
931		685
		686	for (
		687	@{ delete $TERM->{perl_ext_3} },
932	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		689	) {
933	if ($_ eq "default") {	690	if ($_ eq "default") {
934	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	691	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
935	} elsif (/^-(.*)$/) {	692	} elsif (/^-(.*)$/) {
936	delete $ext_arg{$1};	693	delete $ext_arg{$1};
937	} elsif (/^([^<]+)<(.*)>$/) {	694	} elsif (/^([^<]+)<(.*)>$/) {
…		…
960	if (my $cb = $TERM->{_hook}[$htype]) {	717	if (my $cb = $TERM->{_hook}[$htype]) {
961	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
962	if $verbosity >= 10;	719	if $verbosity >= 10;
963		720
964	for my $pkg (keys %$cb) {	721	for my $pkg (keys %$cb) {
965	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
966	$retval \|\|= $retval_;	723	$retval \|\|= $retval_;
967		724
968	if ($@) {	725	if ($@) {
969	$TERM->ungrab; # better to lose the grab than the session	726	$TERM->ungrab; # better to lose the grab than the session
970	warn $@;	727	warn $@;
…		…
1013	}	770	}
1014	}	771	}
1015	($mask, @color{qw(fg bg)}, \@failed)	772	($mask, @color{qw(fg bg)}, \@failed)
1016	}	773	}
1017		774
1018	# urxvt::term::extension
1019
1020	package urxvt::term::extension;	775	package urxvt::term::extension;
1021		776
1022	sub enable {	777	=head2 The C<urxvt::term::extension> class
1023	my ($self, %hook) = @_;
1024	my $pkg = $self->{_pkg};
1025		778
1026	while (my ($name, $cb) = each %hook) {	779	Each extension attached to a terminal object is represented by
1027	my $htype = $HOOKTYPE{uc $name};	780	a C<urxvt::term::extension> object.
1028	defined $htype
1029	or Carp::croak "unsupported hook type '$name'";
1030		781
1031	$self->set_should_invoke ($htype, +1)	782	You can use these objects, which are passed to all callbacks to store any
1032	unless exists $self->{term}{_hook}[$htype]{$pkg};	783	state related to the terminal and extension instance.
1033		784
1034	$self->{term}{_hook}[$htype]{$pkg} = $cb;	785	The methods (And data members) documented below can be called on extension
1035	}	786	objects, in addition to call methods documented for the <urxvt::term>
1036	}	787	class.
1037		788
1038	sub disable {	789	=over 4
1039	my ($self, @hook) = @_;
1040	my $pkg = $self->{_pkg};
1041		790
1042	for my $name (@hook) {	791	=item $urxvt_term = $self->{term}
1043	my $htype = $HOOKTYPE{uc $name};
1044	defined $htype
1045	or Carp::croak "unsupported hook type '$name'";
1046		792
1047	$self->set_should_invoke ($htype, -1)	793	Returns the C<urxvt::term> object associated with this instance of the
1048	if delete $self->{term}{_hook}[$htype]{$pkg};	794	extension. This member I<must not> be changed in any way.
1049	}	795
1050	}	796	=cut
1051		797
1052	our $AUTOLOAD;	798	our $AUTOLOAD;
1053		799
1054	sub AUTOLOAD {	800	sub AUTOLOAD {
1055	$AUTOLOAD =~ /:([^:]+)$/	801	$AUTOLOAD =~ /:([^:]+)$/
…		…
1068		814
1069	sub DESTROY {	815	sub DESTROY {
1070	# nop	816	# nop
1071	}	817	}
1072		818
1073	# urxvt::destroy_hook	819	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1074		820
1075	sub urxvt::destroy_hook::DESTROY {	821	sub urxvt::destroy_hook::DESTROY {
1076	${$_[0]}->();	822	${$_[0]}->();
1077	}	823	}
1078		824
1079	sub urxvt::destroy_hook(&) {	825	sub urxvt::destroy_hook(&) {
1080	bless \shift, urxvt::destroy_hook::	826	bless \shift, urxvt::destroy_hook::
1081	}	827	}
		828
		829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		830
		831	Dynamically enable the given hooks (named without the C<on_> prefix) for
		832	this extension, replacing any previous hook. This is useful when you want
		833	to overwrite time-critical hooks only temporarily.
		834
		835	To install additional callbacks for the same hook, you can use the C<on>
		836	method of the C<urxvt::term> class.
		837
		838	=item $self->disable ($hook_name[, $hook_name..])
		839
		840	Dynamically disable the given hooks.
		841
		842	=cut
		843
		844	sub enable {
		845	my ($self, %hook) = @_;
		846	my $pkg = $self->{_pkg};
		847
		848	while (my ($name, $cb) = each %hook) {
		849	my $htype = $HOOKTYPE{uc $name};
		850	defined $htype
		851	or Carp::croak "unsupported hook type '$name'";
		852
		853	$self->set_should_invoke ($htype, +1)
		854	unless exists $self->{term}{_hook}[$htype]{$pkg};
		855
		856	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		857	}
		858	}
		859
		860	sub disable {
		861	my ($self, @hook) = @_;
		862	my $pkg = $self->{_pkg};
		863
		864	for my $name (@hook) {
		865	my $htype = $HOOKTYPE{uc $name};
		866	defined $htype
		867	or Carp::croak "unsupported hook type '$name'";
		868
		869	$self->set_should_invoke ($htype, -1)
		870	if delete $self->{term}{_hook}[$htype]{$pkg};
		871	}
		872	}
		873
		874	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		875
		876	Similar to the C<enable> enable, but installs additional callbacks for
		877	the given hook(s) (that is, it doesn't replace existing callbacks), and
		878	returns a guard object. When the guard object is destroyed the callbacks
		879	are disabled again.
		880
		881	=cut
		882
		883	sub urxvt::extension::on_disable::DESTROY {
		884	my $disable = shift;
		885
		886	my $term = delete $disable->{""};
		887
		888	while (my ($htype, $id) = each %$disable) {
		889	delete $term->{_hook}[$htype]{$id};
		890	$term->set_should_invoke ($htype, -1);
		891	}
		892	}
		893
		894	sub on {
		895	my ($self, %hook) = @_;
		896
		897	my $term = $self->{term};
		898
		899	my %disable = ( "" => $term );
		900
		901	while (my ($name, $cb) = each %hook) {
		902	my $htype = $HOOKTYPE{uc $name};
		903	defined $htype
		904	or Carp::croak "unsupported hook type '$name'";
		905
		906	$term->set_should_invoke ($htype, +1);
		907	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		908	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		909	}
		910
		911	bless \%disable, "urxvt::extension::on_disable"
		912	}
		913
		914	=item $self->x_resource ($pattern)
		915
		916	=item $self->x_resource_boolean ($pattern)
		917
		918	These methods support an additional C<%> prefix when called on an
		919	extension object - see the description of these methods in the
		920	C<urxvt::term> class for details.
		921
		922	=cut
		923
		924	sub x_resource {
		925	my ($self, $name) = @_;
		926	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		927	$self->{term}->x_resource ($name)
		928	}
		929
		930	sub x_resource_boolean {
		931	my ($self, $name) = @_;
		932	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		933	$self->{term}->x_resource_boolean ($name)
		934	}
		935
		936	=back
		937
		938	=cut
1082		939
1083	package urxvt::anyevent;	940	package urxvt::anyevent;
1084		941
1085	=head2 The C<urxvt::anyevent> Class	942	=head2 The C<urxvt::anyevent> Class
1086		943
1087	The sole purpose of this class is to deliver an interface to the	944	The sole purpose of this class is to deliver an interface to the
1088	C<AnyEvent> module - any module using it will work inside urxvt without	945	C<AnyEvent> module - any module using it will work inside urxvt without
1089	further programming. The only exception is that you cannot wait on	946	further programming. The only exception is that you cannot wait on
1090	condition variables, but non-blocking condvar use is ok. What this means	947	condition variables, but non-blocking condvar use is ok.
1091	is that you cannot use blocking APIs, but the non-blocking variant should
1092	work.
1093		948
1094	=cut	949	In practical terms this means is that you cannot use blocking APIs, but
		950	the non-blocking variant should work.
1095		951
		952	=cut
		953
1096	our $VERSION = 1;	954	our $VERSION = '5.23';
1097		955
1098	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	956	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	957	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100		958
1101	sub timer {	959	sub timer {
…		…
1103		961
1104	my $cb = $arg{cb};	962	my $cb = $arg{cb};
1105		963
1106	urxvt::timer	964	urxvt::timer
1107	->new	965	->new
1108	->start (urxvt::NOW + $arg{after})	966	->after ($arg{after}, $arg{interval})
1109	->cb (sub {	967	->cb ($arg{interval} ? $cb : sub {
1110	$_[0]->stop; # need to cancel manually	968	$_[0]->stop; # need to cancel manually
1111	$cb->();	969	$cb->();
1112	})	970	})
1113	}	971	}
1114		972
1115	sub io {	973	sub io {
1116	my ($class, %arg) = @_;	974	my ($class, %arg) = @_;
1117		975
1118	my $cb = $arg{cb};	976	my $cb = $arg{cb};
		977	my $fd = fileno $arg{fh};
		978	defined $fd or $fd = $arg{fh};
1119		979
1120	bless [$arg{fh}, urxvt::iow	980	bless [$arg{fh}, urxvt::iow
1121	->new	981	->new
1122	->fd (fileno $arg{fh})	982	->fd ($fd)
1123	->events (($arg{poll} =~ /r/ ? 1 : 0)	983	->events (($arg{poll} =~ /r/ ? 1 : 0)
1124	\| ($arg{poll} =~ /w/ ? 2 : 0))	984	\| ($arg{poll} =~ /w/ ? 2 : 0))
1125	->start	985	->start
1126	->cb (sub {	986	->cb ($cb)
1127	$cb->(($_[1] & 1 ? 'r' : '')
1128	. ($_[1] & 2 ? 'w' : ''));
1129	})],
1130	urxvt::anyevent::	987	], urxvt::anyevent::
		988	}
		989
		990	sub idle {
		991	my ($class, %arg) = @_;
		992
		993	my $cb = $arg{cb};
		994
		995	urxvt::iw
		996	->new
		997	->start
		998	->cb ($cb)
		999	}
		1000
		1001	sub child {
		1002	my ($class, %arg) = @_;
		1003
		1004	my $cb = $arg{cb};
		1005
		1006	urxvt::pw
		1007	->new
		1008	->start ($arg{pid})
		1009	->cb (sub {
		1010	$_[0]->stop; # need to cancel manually
		1011	$cb->($_[0]->rpid, $_[0]->rstatus);
		1012	})
1131	}	1013	}
1132		1014
1133	sub DESTROY {	1015	sub DESTROY {
1134	$_[0][1]->stop;	1016	$_[0][1]->stop;
1135	}	1017	}
1136		1018
1137	sub condvar {	1019	# only needed for AnyEvent < 6 compatibility
1138	bless \my $flag, urxvt::anyevent::
1139	}
1140
1141	sub broadcast {
1142	${$_[0]}++;
1143	}
1144
1145	sub wait {
1146	unless (${$_[0]}) {
1147	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1148	}
1149	}
1150
1151	sub one_event {	1020	sub one_event {
1152	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1021	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1153	}	1022	}
1154		1023
1155	package urxvt::term;	1024	package urxvt::term;
…		…
1170	urxvt::verbose 6, "register package $pkg to $self";	1039	urxvt::verbose 6, "register package $pkg to $self";
1171		1040
1172	@{"$pkg\::ISA"} = urxvt::term::extension::;	1041	@{"$pkg\::ISA"} = urxvt::term::extension::;
1173		1042
1174	my $proxy = bless {	1043	my $proxy = bless {
1175	_pkg => $pkg,	1044	_pkg => $pkg,
		1045	_name => ${"$pkg\::_NAME"}, # hackish
1176	argv => $argv,	1046	argv => $argv,
1177	}, $pkg;	1047	}, $pkg;
1178	Scalar::Util::weaken ($proxy->{term} = $self);	1048	Scalar::Util::weaken ($proxy->{term} = $self);
1179		1049
1180	$self->{_pkg}{$pkg} = $proxy;	1050	$self->{_pkg}{$pkg} = $proxy;
1181		1051
…		…
1184	$proxy->enable ($name => $ref);	1054	$proxy->enable ($name => $ref);
1185	}	1055	}
1186	}	1056	}
1187	}	1057	}
1188		1058
		1059	sub perl_libdirs {
		1060	map { split /:/ }
		1061	$_[0]->resource ("perl_lib"),
		1062	$ENV{URXVT_PERL_LIB},
		1063	"$ENV{HOME}/.urxvt/ext",
		1064	"$LIBDIR/perl"
		1065	}
		1066
		1067	sub scan_meta {
		1068	my ($self) = @_;
		1069	my @libdirs = perl_libdirs $self;
		1070
		1071	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1072
		1073	my %meta;
		1074
		1075	$self->{meta_libdirs} = join "\x00", @libdirs;
		1076	$self->{meta} = \%meta;
		1077
		1078	for my $dir (reverse @libdirs) {
		1079	opendir my $fh, $dir
		1080	or next;
		1081	for my $ext (readdir $fh) {
		1082	$ext !~ /^\./
		1083	and open my $fh, "<", "$dir/$ext"
		1084	or next;
		1085
		1086	while (<$fh>) {
		1087	if (/^#:META:X_RESOURCE:(.*)/) {
		1088	my ($pattern, $type, $desc) = split /:/, $1;
		1089	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1090	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1091	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1092	} else {
		1093	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1094	}
		1095	} elsif (/^\s*(?:#\|$)/) {
		1096	# skip other comments and empty lines
		1097	} else {
		1098	last; # stop parsing on first non-empty non-comment line
		1099	}
		1100	}
		1101	}
		1102	}
		1103	}
		1104
1189	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1105	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1190		1106
1191	Creates a new terminal, very similar as if you had started it with system	1107	Creates a new terminal, very similar as if you had started it with system
1192	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1108	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1193	hash which defines the environment of the new terminal.	1109	hash which defines the environment of the new terminal.
…		…
1247	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1163	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1248		1164
1249	Here is a likely non-exhaustive list of option names, please see the	1165	Here is a likely non-exhaustive list of option names, please see the
1250	source file F</src/optinc.h> to see the actual list:	1166	source file F</src/optinc.h> to see the actual list:
1251		1167
1252	borderLess console cursorBlink cursorUnderline hold iconic insecure	1168	borderLess buffered console cursorBlink cursorUnderline hold iconic
1253	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1169	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1254	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1170	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1255	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1171	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1256	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1172	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1257	transparent tripleclickwords utmpInhibit visualBell	1173	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1174	urgentOnBell utmpInhibit visualBell
1258		1175
1259	=item $value = $term->resource ($name[, $newval])	1176	=item $value = $term->resource ($name[, $newval])
1260		1177
1261	Returns the current resource value associated with a given name and	1178	Returns the current resource value associated with a given name and
1262	optionally sets a new value. Setting values is most useful in the C<init>	1179	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1275		1192
1276	Here is a likely non-exhaustive list of resource names, not all of which	1193	Here is a likely non-exhaustive list of resource names, not all of which
1277	are supported in every build, please see the source file F</src/rsinc.h>	1194	are supported in every build, please see the source file F</src/rsinc.h>
1278	to see the actual list:	1195	to see the actual list:
1279		1196
1280	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1197	answerbackstring backgroundPixmap backspace_key blurradius
1281	borderLess color cursorBlink cursorUnderline cutchars delete_key	1198	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1282	display_name embed ext_bwidth fade font geometry hold iconName	1199	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1283	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1200	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1201	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1284	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1202	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1285	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1203	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1286	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1204	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1287	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1205	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1288	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1206	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1289	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1207	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1290	secondaryScreen secondaryScroll shade term_name title	1208	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1291	transient_for transparent transparent_all tripleclickwords utmpInhibit	1209	term_name title transient_for transparent tripleclickwords urgentOnBell
1292	visualBell	1210	utmpInhibit visualBell
1293		1211
1294	=cut	1212	=cut
1295		1213
1296	sub resource($$;$) {	1214	sub resource($$;$) {
1297	my ($self, $name) = (shift, shift);	1215	my ($self, $name) = (shift, shift);
1298	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1216	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1299	&urxvt::term::_resource	1217	goto &urxvt::term::_resource
1300	}	1218	}
1301		1219
1302	=item $value = $term->x_resource ($pattern)	1220	=item $value = $term->x_resource ($pattern)
1303		1221
1304	Returns the X-Resource for the given pattern, excluding the program or	1222	Returns the X-Resource for the given pattern, excluding the program or
1305	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1223	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1306	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1224	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1307	resource with that pattern exists.	1225	resource with that pattern exists.
1308		1226
		1227	Extensions that define extra resource or command line arguments also need
		1228	to call this method to access their values.
		1229
		1230	If the method is called on an extension object (basically, from an
		1231	extension), then the special prefix C<%.> will be replaced by the name of
		1232	the extension and a dot, and the lone string C<%> will be replaced by the
		1233	extension name itself. This makes it possible to code extensions so you
		1234	can rename them and get a new set of commandline switches and resources
		1235	without having to change the actual code.
		1236
1309	This method should only be called during the C<on_start> hook, as there is	1237	This method should only be called during the C<on_start> hook, as there is
1310	only one resource database per display, and later invocations might return	1238	only one resource database per display, and later invocations might return
1311	the wrong resources.	1239	the wrong resources.
1312		1240
1313	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1241	=item $value = $term->x_resource_boolean ($pattern)
1314		1242
		1243	Like C<x_resource>, above, but interprets the string value as a boolean
		1244	and returns C<1> for true values, C<0> for false values and C<undef> if
		1245	the resource or option isn't specified.
		1246
		1247	You should always use this method to parse boolean resources.
		1248
		1249	=cut
		1250
		1251	sub x_resource_boolean {
		1252	my $res = &x_resource;
		1253
		1254	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1255	}
		1256
		1257	=item $success = $term->parse_keysym ($key, $octets)
		1258
1315	Adds a keymap translation exactly as specified via a resource. See the	1259	Adds a key binding exactly as specified via a resource. See the
1316	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1260	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1261
		1262	=item $term->register_command ($keysym, $modifiermask, $string)
		1263
		1264	Adds a key binding. This is a lower level api compared to
		1265	C<parse_keysym>, as it expects a parsed key description, and can be
		1266	used only inside either the C<on_init> hook, to add a binding, or the
		1267	C<on_register_command> hook, to modify a parsed binding.
1317		1268
1318	=item $rend = $term->rstyle ([$new_rstyle])	1269	=item $rend = $term->rstyle ([$new_rstyle])
1319		1270
1320	Return and optionally change the current rendition. Text that is output by	1271	Return and optionally change the current rendition. Text that is output by
1321	the terminal application will use this style.	1272	the terminal application will use this style.
…		…
1329		1280
1330	=item ($row, $col) = $term->selection_beg ([$row, $col])	1281	=item ($row, $col) = $term->selection_beg ([$row, $col])
1331		1282
1332	=item ($row, $col) = $term->selection_end ([$row, $col])	1283	=item ($row, $col) = $term->selection_end ([$row, $col])
1333		1284
1334	Return the current values of the selection mark, begin or end positions,	1285	Return the current values of the selection mark, begin or end positions.
1335	and optionally set them to new values.	1286
		1287	When arguments are given, then the selection coordinates are set to
		1288	C<$row> and C<$col>, and the selection screen is set to the current
		1289	screen.
		1290
		1291	=item $screen = $term->selection_screen ([$screen])
		1292
		1293	Returns the current selection screen, and then optionally sets it.
1336		1294
1337	=item $term->selection_make ($eventtime[, $rectangular])	1295	=item $term->selection_make ($eventtime[, $rectangular])
1338		1296
1339	Tries to make a selection as set by C<selection_beg> and	1297	Tries to make a selection as set by C<selection_beg> and
1340	C<selection_end>. If C<$rectangular> is true (default: false), a	1298	C<selection_end>. If C<$rectangular> is true (default: false), a
1341	rectangular selection will be made. This is the prefered function to make	1299	rectangular selection will be made. This is the preferred function to make
1342	a selection.	1300	a selection.
1343		1301
1344	=item $success = $term->selection_grab ($eventtime)	1302	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1345		1303
1346	Try to request the primary selection text from the server (for example, as	1304	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1305	true) selection from the server. The corresponding text can be set
1347	set by the next method). No visual feedback will be given. This function	1306	with the next method. No visual feedback will be given. This function
1348	is mostly useful from within C<on_sel_grab> hooks.	1307	is mostly useful from within C<on_sel_grab> hooks.
1349		1308
1350	=item $oldtext = $term->selection ([$newtext])	1309	=item $oldtext = $term->selection ([$newtext, $clipboard])
1351		1310
1352	Return the current selection text and optionally replace it by C<$newtext>.	1311	Return the current selection (clipboard if C<$clipboard> is true) text
		1312	and optionally replace it by C<$newtext>.
		1313
		1314	=item $term->selection_clear ([$clipboard])
		1315
		1316	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1353		1317
1354	=item $term->overlay_simple ($x, $y, $text)	1318	=item $term->overlay_simple ($x, $y, $text)
1355		1319
1356	Create a simple multi-line overlay box. See the next method for details.	1320	Create a simple multi-line overlay box. See the next method for details.
1357		1321
…		…
1387		1351
1388	The methods currently supported on C<urxvt::overlay> objects are:	1352	The methods currently supported on C<urxvt::overlay> objects are:
1389		1353
1390	=over 4	1354	=over 4
1391		1355
1392	=item $overlay->set ($x, $y, $text, $rend)	1356	=item $overlay->set ($x, $y, $text[, $rend])
1393		1357
1394	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1358	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1395	text in rxvt-unicode's special encoding and an array of rendition values	1359	text in rxvt-unicode's special encoding and an array of rendition values
1396	at a specific position inside the overlay.	1360	at a specific position inside the overlay.
		1361
		1362	If C<$rend> is missing, then the rendition will not be changed.
1397		1363
1398	=item $overlay->hide	1364	=item $overlay->hide
1399		1365
1400	If visible, hide the overlay, but do not destroy it.	1366	If visible, hide the overlay, but do not destroy it.
1401		1367
…		…
1483	locale-specific encoding of the terminal and can contain command sequences	1449	locale-specific encoding of the terminal and can contain command sequences
1484	(escape codes) that will be interpreted.	1450	(escape codes) that will be interpreted.
1485		1451
1486	=item $term->tt_write ($octets)	1452	=item $term->tt_write ($octets)
1487		1453
1488	Write the octets given in C<$data> to the tty (i.e. as program input). To	1454	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1489	pass characters instead of octets, you should convert your strings first	1455	pass characters instead of octets, you should convert your strings first
1490	to the locale-specific encoding using C<< $term->locale_encode >>.	1456	to the locale-specific encoding using C<< $term->locale_encode >>.
		1457
		1458	=item $term->tt_paste ($octets)
		1459
		1460	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1461	CR and bracketing the data with control sequences if bracketed paste mode
		1462	is set.
1491		1463
1492	=item $old_events = $term->pty_ev_events ([$new_events])	1464	=item $old_events = $term->pty_ev_events ([$new_events])
1493		1465
1494	Replaces the event mask of the pty watcher by the given event mask. Can	1466	Replaces the event mask of the pty watcher by the given event mask. Can
1495	be used to suppress input and output handling to the pty/tty. See the	1467	be used to suppress input and output handling to the pty/tty. See the
…		…
1514	Adds the specified events to the vt event mask. Useful e.g. when you want	1486	Adds the specified events to the vt event mask. Useful e.g. when you want
1515	to receive pointer events all the times:	1487	to receive pointer events all the times:
1516		1488
1517	$term->vt_emask_add (urxvt::PointerMotionMask);	1489	$term->vt_emask_add (urxvt::PointerMotionMask);
1518		1490
		1491	=item $term->set_urgency ($set)
		1492
		1493	Enable/disable the urgency hint on the toplevel window.
		1494
1519	=item $term->focus_in	1495	=item $term->focus_in
1520		1496
1521	=item $term->focus_out	1497	=item $term->focus_out
1522		1498
1523	=item $term->key_press ($state, $keycode[, $time])	1499	=item $term->key_press ($state, $keycode[, $time])
…		…
1611		1587
1612	Used after changing terminal contents to display them.	1588	Used after changing terminal contents to display them.
1613		1589
1614	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1590	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1615		1591
1616	Returns the text of the entire row with number C<$row_number>. Row C<0>	1592	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1617	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1593	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1618	terminal line. The scrollback buffer starts at line C<-1> and extends to
1619	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1594	terminal line. Nothing will be returned if a nonexistent line
1620	is requested.	1595	is requested.
1621		1596
1622	If C<$new_text> is specified, it will replace characters in the current	1597	If C<$new_text> is specified, it will replace characters in the current
1623	line, starting at column C<$start_col> (default C<0>), which is useful	1598	line, starting at column C<$start_col> (default C<0>), which is useful
1624	to replace only parts of a line. The font index in the rendition will	1599	to replace only parts of a line. The font index in the rendition will
…		…
1810	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1785	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1811	recent grab.	1786	recent grab.
1812		1787
1813	=item $term->ungrab	1788	=item $term->ungrab
1814		1789
1815	Calls XUngrab for the most recent grab. Is called automatically on	1790	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1816	evaluation errors, as it is better to lose the grab in the error case as	1791	evaluation errors, as it is better to lose the grab in the error case as
1817	the session.	1792	the session.
1818		1793
1819	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1794	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1820		1795
…		…
1822		1797
1823	=item @atoms = $term->XListProperties ($window)	1798	=item @atoms = $term->XListProperties ($window)
1824		1799
1825	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1800	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1826		1801
1827	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1802	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1828		1803
1829	=item $term->XDeleteProperty ($window, $property)	1804	=item $term->XDeleteProperty ($window, $property)
1830		1805
1831	=item $window = $term->DefaultRootWindow	1806	=item $window = $term->DefaultRootWindow
1832		1807
…		…
1839	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1814	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1840		1815
1841	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1816	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1842		1817
1843	=item $term->XChangeInput ($window, $add_events[, $del_events])	1818	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1819
		1820	=item $keysym = $term->XStringToKeysym ($string)
		1821
		1822	=item $string = $term->XKeysymToString ($keysym)
1844		1823
1845	Various X or X-related functions. The C<$term> object only serves as	1824	Various X or X-related functions. The C<$term> object only serves as
1846	the source of the display, otherwise those functions map more-or-less	1825	the source of the display, otherwise those functions map more-or-less
1847	directory onto the X functions of the same name.	1826	directly onto the X functions of the same name.
1848		1827
1849	=back	1828	=back
1850		1829
1851	=cut	1830	=cut
1852		1831
…		…
2009		1988
2010	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1989	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2011		1990
2012	Set the callback to be called when the timer triggers.	1991	Set the callback to be called when the timer triggers.
2013		1992
2014	=item $tstamp = $timer->at
2015
2016	Return the time this watcher will fire next.
2017
2018	=item $timer = $timer->set ($tstamp)	1993	=item $timer = $timer->set ($tstamp[, $interval])
2019		1994
2020	Set the time the event is generated to $tstamp.	1995	Set the time the event is generated to $tstamp (and optionally specifies a
		1996	new $interval).
2021		1997
2022	=item $timer = $timer->interval ($interval)	1998	=item $timer = $timer->interval ($interval)
2023		1999
2024	Normally (and when C<$interval> is C<0>), the timer will automatically	2000	By default (and when C<$interval> is C<0>), the timer will automatically
2025	stop after it has fired once. If C<$interval> is non-zero, then the timer	2001	stop after it has fired once. If C<$interval> is non-zero, then the timer
2026	is automatically rescheduled at the given intervals.	2002	is automatically rescheduled at the given intervals.
2027		2003
2028	=item $timer = $timer->start	2004	=item $timer = $timer->start
2029		2005
2030	Start the timer.	2006	Start the timer.
2031		2007
2032	=item $timer = $timer->start ($tstamp)	2008	=item $timer = $timer->start ($tstamp[, $interval])
2033		2009
2034	Set the event trigger time to C<$tstamp> and start the timer.	2010	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2011	also replaces the interval.
2035		2012
2036	=item $timer = $timer->after ($delay)	2013	=item $timer = $timer->after ($delay[, $interval])
2037		2014
2038	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2015	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2039		2016
2040	=item $timer = $timer->stop	2017	=item $timer = $timer->stop
2041		2018
…		…
2172		2149
2173	=back	2150	=back
2174		2151
2175	=head1 AUTHOR	2152	=head1 AUTHOR
2176		2153
2177	Marc Lehmann <pcg@goof.com>	2154	Marc Lehmann <schmorp@schmorp.de>
2178	http://software.schmorp.de/pkg/rxvt-unicode	2155	http://software.schmorp.de/pkg/rxvt-unicode
2179		2156
2180	=cut	2157	=cut
2181		2158
2182	1	2159	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.164 by root, Mon Dec 24 08:21:40 2007 UTC vs. Revision 1.225 by root, Fri Aug 10 19:06:06 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.164 by root, Mon Dec 24 08:21:40 2007 UTC vs.
Revision 1.225 by root, Fri Aug 10 19:06:06 2012 UTC