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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.170 by root, Tue Sep 23 07:03:13 2008 UTC vs.
Revision 1.219 by sf-exg, Sun Jun 10 18:23:18 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.
…		…
541		218
542	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	219	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	220	$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.	221	number of lines that will be in the scrollback buffer.
545		222
546	=item on_osc_seq $term, $op, $args	223	=item on_osc_seq $term, $op, $args, $resp
547		224
548	Called on every OSC sequence and can be used to suppress it or modify its	225	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	226	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	227	suppresses execution of the request completely. Make sure you don't get
551	confused by recursive invocations when you output an osc sequence within	228	confused by recursive invocations when you output an OSC sequence within
552	this callback.	229	this callback.
553		230
554	C<on_osc_seq_perl> should be used for new behaviour.	231	C<on_osc_seq_perl> should be used for new behaviour.
555		232
556	=item on_osc_seq_perl $term, $string	233	=item on_osc_seq_perl $term, $args, $resp
557		234
558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	235	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559	operating system command) is processed. Cursor position and other state	236	operating system command) is processed. Cursor position and other state
560	information is up-to-date when this happens. For interoperability, the	237	information is up-to-date when this happens. For interoperability, the
561	string should start with the extension name and a colon, to distinguish	238	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	239	to distinguish it from commands for other extensions, and this might be
563	future.	240	enforced in the future.
		241
		242	For example, C<overlay-osc> uses this:
		243
		244	sub on_osc_seq_perl {
		245	my ($self, $osc, $resp) = @_;
		246
		247	return unless $osc =~ s/^overlay;//;
		248
		249	... process remaining $osc string
		250	}
564		251
565	Be careful not ever to trust (in a security sense) the data you receive,	252	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	253	as its source can not easily be controlled (e-mail content, messages from
567	other users on the same system etc.).	254	other users on the same system etc.).
		255
		256	For responses, C<$resp> contains the end-of-args separator used by the
		257	sender.
568		258
569	=item on_add_lines $term, $string	259	=item on_add_lines $term, $string
570		260
571	Called whenever text is about to be output, with the text as argument. You	261	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	262	can filter/change and output the text yourself by returning a true value
…		…
577	=item on_tt_write $term, $octets	267	=item on_tt_write $term, $octets
578		268
579	Called whenever some data is written to the tty/pty and can be used to	269	Called whenever some data is written to the tty/pty and can be used to
580	suppress or filter tty input.	270	suppress or filter tty input.
581		271
		272	=item on_tt_paste $term, $octets
		273
		274	Called whenever text is about to be pasted, with the text as argument. You
		275	can filter/change and paste the text yourself by returning a true value
		276	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		277	locale-encoded.
		278
582	=item on_line_update $term, $row	279	=item on_line_update $term, $row
583		280
584	Called whenever a line was updated or changed. Can be used to filter	281	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	282	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,	283	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	290	later with the already-modified line (e.g. if unrelated parts change), so
594	you cannot just toggle rendition bits, but only set them.	291	you cannot just toggle rendition bits, but only set them.
595		292
596	=item on_refresh_begin $term	293	=item on_refresh_begin $term
597		294
598	Called just before the screen gets redrawn. Can be used for overlay	295	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	296	similar effects by modifying the terminal contents in refresh_begin, and
600	restoring them in refresh_end. The built-in overlay and selection display	297	restoring them in refresh_end. The built-in overlay and selection display
601	code is run after this hook, and takes precedence.	298	code is run after this hook, and takes precedence.
602		299
603	=item on_refresh_end $term	300	=item on_refresh_end $term
604		301
…		…
611	resource in the @@RXVT_NAME@@(1) manpage).	308	resource in the @@RXVT_NAME@@(1) manpage).
612		309
613	The event is simply the action string. This interface is assumed to change	310	The event is simply the action string. This interface is assumed to change
614	slightly in the future.	311	slightly in the future.
615		312
		313	=item on_register_command $term, $keysym, $modifiermask, $string
		314
		315	Called after parsing a keysym resource but before registering the
		316	associated binding. If this hook returns TRUE the binding is not
		317	registered. It can be used to modify a binding by calling
		318	C<register_command>.
		319
616	=item on_resize_all_windows $tern, $new_width, $new_height	320	=item on_resize_all_windows $term, $new_width, $new_height
617		321
618	Called just after the new window size has been calculated, but before	322	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	323	windows are actually being resized or hints are being set. If this hook
620	returns TRUE, setting of the window hints is being skipped.	324	returns TRUE, setting of the window hints is being skipped.
621		325
…		…
655		359
656	=item on_map_notify $term, $event	360	=item on_map_notify $term, $event
657		361
658	=item on_unmap_notify $term, $event	362	=item on_unmap_notify $term, $event
659		363
660	Called whenever the corresponding X event is received for the terminal If	364	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.	365	the hook returns true, then the event will be ignored by rxvt-unicode.
662		366
663	The event is a hash with most values as named by Xlib (see the XEvent	367	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	368	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.	369	(real, not screen-based) row and column under the mouse cursor.
666		370
…		…
676	=item on_wm_delete_window $term, $event	380	=item on_wm_delete_window $term, $event
677		381
678	Called when various types of ClientMessage events are received (all with	382	Called when various types of ClientMessage events are received (all with
679	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	383	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
680		384
		385	=item on_bell $term
		386
		387	Called on receipt of a bell character.
		388
681	=back	389	=back
682		390
683	=cut	391	=cut
684		392
685	package urxvt;	393	package urxvt;
686		394
687	use utf8;	395	use utf8;
688	use strict;	396	use strict 'vars';
689	use Carp ();	397	use Carp ();
690	use Scalar::Util ();	398	use Scalar::Util ();
691	use List::Util ();	399	use List::Util ();
692		400
693	our $VERSION = 1;	401	our $VERSION = 1;
694	our $TERM;	402	our $TERM;
695	our @TERM_INIT;	403	our @TERM_INIT; # should go, prevents async I/O etc.
696	our @TERM_EXT;	404	our @TERM_EXT; # should go, prevents async I/O etc.
697	our @HOOKNAME;	405	our @HOOKNAME;
698	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	406	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
699	our %OPTION;	407	our %OPTION;
700		408
701	our $LIBDIR;	409	our $LIBDIR;
…		…
749		457
750	=over 4	458	=over 4
751		459
752	=item urxvt::fatal $errormessage	460	=item urxvt::fatal $errormessage
753		461
754	Fatally aborts execution with the given error message. Avoid at all	462	Fatally aborts execution with the given error message (which should
755	costs! The only time this is acceptable is when the terminal process	463	include a trailing newline). Avoid at all costs! The only time this
756	starts up.	464	is acceptable (and useful) is in the init hook, where it prevents the
		465	terminal from starting up.
757		466
758	=item urxvt::warn $string	467	=item urxvt::warn $string
759		468
760	Calls C<rxvt_warn> with the given string which should not include a	469	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	470	newline. The module also overwrites the C<warn> builtin with a function
762	that calls this function.	471	that calls this function.
763		472
764	Using this function has the advantage that its output ends up in the	473	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.	474	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
769	=item @terms = urxvt::termlist	478	=item @terms = urxvt::termlist
770		479
771	Returns all urxvt::term objects that exist in this process, regardless of	480	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	481	whether they are started, being destroyed etc., so be careful. Only term
773	objects that have perl extensions attached will be returned (because there	482	objects that have perl extensions attached will be returned (because there
774	is no urxvt::term objet associated with others).	483	is no urxvt::term object associated with others).
775		484
776	=item $time = urxvt::NOW	485	=item $time = urxvt::NOW
777		486
778	Returns the "current time" (as per the event loop).	487	Returns the "current time" (as per the event loop).
779		488
…		…
822		531
823	=item $rend = urxvt::OVERLAY_RSTYLE	532	=item $rend = urxvt::OVERLAY_RSTYLE
824		533
825	Return the rendition mask used for overlays by default.	534	Return the rendition mask used for overlays by default.
826		535
827	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	536	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		537	urxvt::RS_RVid, urxvt::RS_Uline
828		538
829	Return the bit that enabled bold, italic, blink, reverse-video and	539	Return the bit that enabled bold, italic, blink, reverse-video and
830	underline, respectively. To enable such a style, just logically OR it into	540	underline, respectively. To enable such a style, just logically OR it into
831	the bitset.	541	the bitset.
832		542
…		…
869	};	579	};
870	}	580	}
871		581
872	no warnings 'utf8';	582	no warnings 'utf8';
873		583
		584	sub parse_resource {
		585	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		586
		587	$name =~ y/-/./ if $isarg;
		588
		589	$term->scan_meta;
		590
		591	my $r = $term->{meta}{resource};
		592	keys %$r; # reste iterator
		593	while (my ($pattern, $v) = each %$r) {
		594	if (
		595	$pattern =~ /\.$/
		596	? $pattern eq substr $name, 0, length $pattern
		597	: $pattern eq $name
		598	) {
		599	$name = "$urxvt::RESCLASS.$name";
		600
		601	push @{ $term->{perl_ext_3} }, $v->[0];
		602
		603	if ($v->[1] eq "boolean") {
		604	$term->put_option_db ($name, $flag ? "true" : "false");
		605	return 1;
		606	} else {
		607	$term->put_option_db ($name, $value);
		608	return 1 + 2;
		609	}
		610	}
		611	}
		612
		613	0
		614	}
		615
		616	sub usage {
		617	my ($term, $usage_type) = @_;
		618
		619	$term->scan_meta;
		620
		621	my $r = $term->{meta}{resource};
		622
		623	for my $pattern (sort keys %$r) {
		624	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		625
		626	$desc .= " (-pe $ext)";
		627
		628	if ($usage_type == 1) {
		629	$pattern =~ y/./-/;
		630	$pattern =~ s/-$/-.../g;
		631
		632	if ($type eq "boolean") {
		633	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		634	} else {
		635	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		636	}
		637	} else {
		638	$pattern =~ s/\.$/.*/g;
		639	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		640	}
		641	}
		642	}
		643
874	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	644	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
875		645
876	sub verbose {	646	sub verbose {
877	my ($level, $msg) = @_;	647	my ($level, $msg) = @_;
878	warn "$msg\n" if $level <= $verbosity;	648	warn "$msg\n" if $level <= $verbosity;
…		…
890	$pkg =~ s/[^[:word:]]/_/g;	660	$pkg =~ s/[^[:word:]]/_/g;
891	$pkg = "urxvt::ext::$pkg";	661	$pkg = "urxvt::ext::$pkg";
892		662
893	verbose 3, "loading extension '$path' into package '$pkg'";	663	verbose 3, "loading extension '$path' into package '$pkg'";
894		664
		665	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		666
895	open my $fh, "<:raw", $path	667	open my $fh, "<:raw", $path
896	or die "$path: $!";	668	or die "$path: $!";
897		669
898	my $source =	670	my $source =
899	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	671	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
900	. "#line 1 \"$path\"\n{\n"	672	. "#line 1 \"$path\"\n{\n"
901	. (do { local $/; <$fh> })	673	. (do { local $/; <$fh> })
902	. "\n};\n1";	674	. "\n};\n1";
903		675
904	eval $source	676	eval $source
…		…
914	sub invoke {	686	sub invoke {
915	local $TERM = shift;	687	local $TERM = shift;
916	my $htype = shift;	688	my $htype = shift;
917		689
918	if ($htype == 0) { # INIT	690	if ($htype == 0) { # INIT
919	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	691	my @dirs = $TERM->perl_libdirs;
920		692
921	my %ext_arg;	693	my %ext_arg;
922		694
923	{	695	{
924	my @init = @TERM_INIT;	696	my @init = @TERM_INIT;
…		…
927	my @pkg = @TERM_EXT;	699	my @pkg = @TERM_EXT;
928	@TERM_EXT = ();	700	@TERM_EXT = ();
929	$TERM->register_package ($_) for @pkg;	701	$TERM->register_package ($_) for @pkg;
930	}	702	}
931		703
		704	for (
		705	@{ delete $TERM->{perl_ext_3} },
932	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		707	) {
933	if ($_ eq "default") {	708	if ($_ eq "default") {
934	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	709	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
935	} elsif (/^-(.*)$/) {	710	} elsif (/^-(.*)$/) {
936	delete $ext_arg{$1};	711	delete $ext_arg{$1};
937	} elsif (/^([^<]+)<(.*)>$/) {	712	} elsif (/^([^<]+)<(.*)>$/) {
…		…
1013	}	788	}
1014	}	789	}
1015	($mask, @color{qw(fg bg)}, \@failed)	790	($mask, @color{qw(fg bg)}, \@failed)
1016	}	791	}
1017		792
1018	# urxvt::term::extension
1019
1020	package urxvt::term::extension;	793	package urxvt::term::extension;
1021		794
1022	sub enable {	795	sub enable {
1023	my ($self, %hook) = @_;	796	my ($self, %hook) = @_;
1024	my $pkg = $self->{_pkg};	797	my $pkg = $self->{_pkg};
…		…
1078		851
1079	sub urxvt::destroy_hook(&) {	852	sub urxvt::destroy_hook(&) {
1080	bless \shift, urxvt::destroy_hook::	853	bless \shift, urxvt::destroy_hook::
1081	}	854	}
1082		855
		856	sub x_resource {
		857	my ($self, $name) = @_;
		858	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		859	$self->{term}->x_resource ($name)
		860	}
		861
		862	sub x_resource_boolean {
		863	my ($self, $name) = @_;
		864	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		865	$self->{term}->x_resource_boolean ($name)
		866	}
		867
1083	package urxvt::anyevent;	868	package urxvt::anyevent;
1084		869
1085	=head2 The C<urxvt::anyevent> Class	870	=head2 The C<urxvt::anyevent> Class
1086		871
1087	The sole purpose of this class is to deliver an interface to the	872	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	873	C<AnyEvent> module - any module using it will work inside urxvt without
1089	further programming. The only exception is that you cannot wait on	874	further programming. The only exception is that you cannot wait on
1090	condition variables, but non-blocking condvar use is ok. What this means	875	condition variables, but non-blocking condvar use is ok.
1091	is that you cannot use blocking APIs, but the non-blocking variant should	876
1092	work.	877	In practical terms this means is that you cannot use blocking APIs, but
		878	the non-blocking variant should work.
1093		879
1094	=cut	880	=cut
1095		881
1096	our $VERSION = '3.4';	882	our $VERSION = '5.23';
1097		883
1098	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	884	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	885	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100		886
1101	sub timer {	887	sub timer {
…		…
1103		889
1104	my $cb = $arg{cb};	890	my $cb = $arg{cb};
1105		891
1106	urxvt::timer	892	urxvt::timer
1107	->new	893	->new
1108	->start (urxvt::NOW + $arg{after})	894	->after ($arg{after}, $arg{interval})
1109	->cb (sub {	895	->cb ($arg{interval} ? $cb : sub {
1110	$_[0]->stop; # need to cancel manually	896	$_[0]->stop; # need to cancel manually
1111	$cb->();	897	$cb->();
1112	})	898	})
1113	}	899	}
1114		900
1115	sub io {	901	sub io {
1116	my ($class, %arg) = @_;	902	my ($class, %arg) = @_;
1117		903
1118	my $cb = $arg{cb};	904	my $cb = $arg{cb};
		905	my $fd = fileno $arg{fh};
		906	defined $fd or $fd = $arg{fh};
1119		907
1120	bless [$arg{fh}, urxvt::iow	908	bless [$arg{fh}, urxvt::iow
1121	->new	909	->new
1122	->fd (fileno $arg{fh})	910	->fd ($fd)
1123	->events (($arg{poll} =~ /r/ ? 1 : 0)	911	->events (($arg{poll} =~ /r/ ? 1 : 0)
1124	\| ($arg{poll} =~ /w/ ? 2 : 0))	912	\| ($arg{poll} =~ /w/ ? 2 : 0))
1125	->start	913	->start
1126	->cb (sub {	914	->cb ($cb)
1127	$cb->(($_[1] & 1 ? 'r' : '')
1128	. ($_[1] & 2 ? 'w' : ''));
1129	})],
1130	urxvt::anyevent::	915	], urxvt::anyevent::
		916	}
		917
		918	sub idle {
		919	my ($class, %arg) = @_;
		920
		921	my $cb = $arg{cb};
		922
		923	urxvt::iw
		924	->new
		925	->start
		926	->cb ($cb)
		927	}
		928
		929	sub child {
		930	my ($class, %arg) = @_;
		931
		932	my $cb = $arg{cb};
		933
		934	urxvt::pw
		935	->new
		936	->start ($arg{pid})
		937	->cb (sub {
		938	$_[0]->stop; # need to cancel manually
		939	$cb->($_[0]->rpid, $_[0]->rstatus);
		940	})
1131	}	941	}
1132		942
1133	sub DESTROY {	943	sub DESTROY {
1134	$_[0][1]->stop;	944	$_[0][1]->stop;
1135	}	945	}
1136		946
		947	# only needed for AnyEvent < 6 compatibility
1137	sub one_event {	948	sub one_event {
1138	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	949	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1139	}	950	}
1140		951
1141	package urxvt::term;	952	package urxvt::term;
…		…
1156	urxvt::verbose 6, "register package $pkg to $self";	967	urxvt::verbose 6, "register package $pkg to $self";
1157		968
1158	@{"$pkg\::ISA"} = urxvt::term::extension::;	969	@{"$pkg\::ISA"} = urxvt::term::extension::;
1159		970
1160	my $proxy = bless {	971	my $proxy = bless {
1161	_pkg => $pkg,	972	_pkg => $pkg,
		973	_name => ${"$pkg\::_NAME"}, # hackish
1162	argv => $argv,	974	argv => $argv,
1163	}, $pkg;	975	}, $pkg;
1164	Scalar::Util::weaken ($proxy->{term} = $self);	976	Scalar::Util::weaken ($proxy->{term} = $self);
1165		977
1166	$self->{_pkg}{$pkg} = $proxy;	978	$self->{_pkg}{$pkg} = $proxy;
1167		979
…		…
1170	$proxy->enable ($name => $ref);	982	$proxy->enable ($name => $ref);
1171	}	983	}
1172	}	984	}
1173	}	985	}
1174		986
		987	sub perl_libdirs {
		988	map { split /:/ }
		989	$_[0]->resource ("perl_lib"),
		990	$ENV{URXVT_PERL_LIB},
		991	"$ENV{HOME}/.urxvt/ext",
		992	"$LIBDIR/perl"
		993	}
		994
		995	sub scan_meta {
		996	my ($self) = @_;
		997	my @libdirs = perl_libdirs $self;
		998
		999	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1000
		1001	my %meta;
		1002
		1003	$self->{meta_libdirs} = join "\x00", @libdirs;
		1004	$self->{meta} = \%meta;
		1005
		1006	for my $dir (reverse @libdirs) {
		1007	opendir my $fh, $dir
		1008	or next;
		1009	for my $ext (readdir $fh) {
		1010	$ext ne "."
		1011	and $ext ne ".."
		1012	and open my $fh, "<", "$dir/$ext"
		1013	or next;
		1014
		1015	while (<$fh>) {
		1016	if (/^#:META:X_RESOURCE:(.*)/) {
		1017	my ($pattern, $type, $desc) = split /:/, $1;
		1018	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1019	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1020	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1021	} else {
		1022	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1023	}
		1024	} elsif (/^\s*(?:#\|$)/) {
		1025	# skip other comments and empty lines
		1026	} else {
		1027	last; # stop parsing on first non-empty non-comment line
		1028	}
		1029	}
		1030	}
		1031	}
		1032	}
		1033
1175	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1176		1035
1177	Creates a new terminal, very similar as if you had started it with system	1036	Creates a new terminal, very similar as if you had started it with system
1178	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1037	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1179	hash which defines the environment of the new terminal.	1038	hash which defines the environment of the new terminal.
…		…
1233	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1092	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1234		1093
1235	Here is a likely non-exhaustive list of option names, please see the	1094	Here is a likely non-exhaustive list of option names, please see the
1236	source file F</src/optinc.h> to see the actual list:	1095	source file F</src/optinc.h> to see the actual list:
1237		1096
1238	borderLess console cursorBlink cursorUnderline hold iconic insecure	1097	borderLess buffered console cursorBlink cursorUnderline hold iconic
1239	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1098	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1240	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1099	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1241	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1100	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1242	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1101	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1243	transparent tripleclickwords utmpInhibit visualBell	1102	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1103	urgentOnBell utmpInhibit visualBell
1244		1104
1245	=item $value = $term->resource ($name[, $newval])	1105	=item $value = $term->resource ($name[, $newval])
1246		1106
1247	Returns the current resource value associated with a given name and	1107	Returns the current resource value associated with a given name and
1248	optionally sets a new value. Setting values is most useful in the C<init>	1108	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1261		1121
1262	Here is a likely non-exhaustive list of resource names, not all of which	1122	Here is a likely non-exhaustive list of resource names, not all of which
1263	are supported in every build, please see the source file F</src/rsinc.h>	1123	are supported in every build, please see the source file F</src/rsinc.h>
1264	to see the actual list:	1124	to see the actual list:
1265		1125
1266	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1126	answerbackstring backgroundPixmap backspace_key blurradius
1267	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1268	display_name embed ext_bwidth fade font geometry hold iconName	1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1269	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1129	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1130	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1270	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1271	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1132	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1272	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1133	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1273	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1134	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1274	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1135	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1275	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1136	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1276	secondaryScreen secondaryScroll shade term_name title	1137	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1277	transient_for transparent transparent_all tripleclickwords utmpInhibit	1138	term_name title transient_for transparent tripleclickwords urgentOnBell
1278	visualBell	1139	utmpInhibit visualBell
1279		1140
1280	=cut	1141	=cut
1281		1142
1282	sub resource($$;$) {	1143	sub resource($$;$) {
1283	my ($self, $name) = (shift, shift);	1144	my ($self, $name) = (shift, shift);
…		…
1290	Returns the X-Resource for the given pattern, excluding the program or	1151	Returns the X-Resource for the given pattern, excluding the program or
1291	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1152	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1292	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1153	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1293	resource with that pattern exists.	1154	resource with that pattern exists.
1294		1155
		1156	Extensions that define extra resource or command line arguments also need
		1157	to call this method to access their values.
		1158
		1159	If the method is called on an extension object (basically, from an
		1160	extension), then the special prefix C<%.> will be replaced by the name of
		1161	the extension and a dot, and the lone string C<%> will be replaced by the
		1162	extension name itself. This makes it possible to code extensions so you
		1163	can rename them and get a new set of commandline switches and resources
		1164	without having to change the actual code.
		1165
1295	This method should only be called during the C<on_start> hook, as there is	1166	This method should only be called during the C<on_start> hook, as there is
1296	only one resource database per display, and later invocations might return	1167	only one resource database per display, and later invocations might return
1297	the wrong resources.	1168	the wrong resources.
1298		1169
1299	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1170	=item $value = $term->x_resource_boolean ($pattern)
1300		1171
		1172	Like C<x_resource>, above, but interprets the string value as a boolean
		1173	and returns C<1> for true values, C<0> for false values and C<undef> if
		1174	the resource or option isn't specified.
		1175
		1176	You should always use this method to parse boolean resources.
		1177
		1178	=cut
		1179
		1180	sub x_resource_boolean {
		1181	my $res = &x_resource;
		1182
		1183	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1184	}
		1185
		1186	=item $success = $term->parse_keysym ($key, $octets)
		1187
1301	Adds a keymap translation exactly as specified via a resource. See the	1188	Adds a key binding exactly as specified via a resource. See the
1302	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1189	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1190
		1191	=item $term->register_command ($keysym, $modifiermask, $string)
		1192
		1193	Adds a key binding. This is a lower level api compared to
		1194	C<parse_keysym>, as it expects a parsed key description, and can be
		1195	used only inside either the C<on_init> hook, to add a binding, or the
		1196	C<on_register_command> hook, to modify a parsed binding.
1303		1197
1304	=item $rend = $term->rstyle ([$new_rstyle])	1198	=item $rend = $term->rstyle ([$new_rstyle])
1305		1199
1306	Return and optionally change the current rendition. Text that is output by	1200	Return and optionally change the current rendition. Text that is output by
1307	the terminal application will use this style.	1201	the terminal application will use this style.
…		…
1315		1209
1316	=item ($row, $col) = $term->selection_beg ([$row, $col])	1210	=item ($row, $col) = $term->selection_beg ([$row, $col])
1317		1211
1318	=item ($row, $col) = $term->selection_end ([$row, $col])	1212	=item ($row, $col) = $term->selection_end ([$row, $col])
1319		1213
1320	Return the current values of the selection mark, begin or end positions,	1214	Return the current values of the selection mark, begin or end positions.
1321	and optionally set them to new values.	1215
		1216	When arguments are given, then the selection coordinates are set to
		1217	C<$row> and C<$col>, and the selection screen is set to the current
		1218	screen.
		1219
		1220	=item $screen = $term->selection_screen ([$screen])
		1221
		1222	Returns the current selection screen, and then optionally sets it.
1322		1223
1323	=item $term->selection_make ($eventtime[, $rectangular])	1224	=item $term->selection_make ($eventtime[, $rectangular])
1324		1225
1325	Tries to make a selection as set by C<selection_beg> and	1226	Tries to make a selection as set by C<selection_beg> and
1326	C<selection_end>. If C<$rectangular> is true (default: false), a	1227	C<selection_end>. If C<$rectangular> is true (default: false), a
1327	rectangular selection will be made. This is the prefered function to make	1228	rectangular selection will be made. This is the preferred function to make
1328	a selection.	1229	a selection.
1329		1230
1330	=item $success = $term->selection_grab ($eventtime)	1231	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1331		1232
1332	Try to request the primary selection text from the server (for example, as	1233	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1234	true) selection from the server. The corresponding text can be set
1333	set by the next method). No visual feedback will be given. This function	1235	with the next method. No visual feedback will be given. This function
1334	is mostly useful from within C<on_sel_grab> hooks.	1236	is mostly useful from within C<on_sel_grab> hooks.
1335		1237
1336	=item $oldtext = $term->selection ([$newtext])	1238	=item $oldtext = $term->selection ([$newtext, $clipboard])
1337		1239
1338	Return the current selection text and optionally replace it by C<$newtext>.	1240	Return the current selection (clipboard if C<$clipboard> is true) text
		1241	and optionally replace it by C<$newtext>.
		1242
		1243	=item $term->selection_clear ([$clipboard])
		1244
		1245	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1339		1246
1340	=item $term->overlay_simple ($x, $y, $text)	1247	=item $term->overlay_simple ($x, $y, $text)
1341		1248
1342	Create a simple multi-line overlay box. See the next method for details.	1249	Create a simple multi-line overlay box. See the next method for details.
1343		1250
…		…
1373		1280
1374	The methods currently supported on C<urxvt::overlay> objects are:	1281	The methods currently supported on C<urxvt::overlay> objects are:
1375		1282
1376	=over 4	1283	=over 4
1377		1284
1378	=item $overlay->set ($x, $y, $text, $rend)	1285	=item $overlay->set ($x, $y, $text[, $rend])
1379		1286
1380	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1287	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1381	text in rxvt-unicode's special encoding and an array of rendition values	1288	text in rxvt-unicode's special encoding and an array of rendition values
1382	at a specific position inside the overlay.	1289	at a specific position inside the overlay.
		1290
		1291	If C<$rend> is missing, then the rendition will not be changed.
1383		1292
1384	=item $overlay->hide	1293	=item $overlay->hide
1385		1294
1386	If visible, hide the overlay, but do not destroy it.	1295	If visible, hide the overlay, but do not destroy it.
1387		1296
…		…
1469	locale-specific encoding of the terminal and can contain command sequences	1378	locale-specific encoding of the terminal and can contain command sequences
1470	(escape codes) that will be interpreted.	1379	(escape codes) that will be interpreted.
1471		1380
1472	=item $term->tt_write ($octets)	1381	=item $term->tt_write ($octets)
1473		1382
1474	Write the octets given in C<$data> to the tty (i.e. as program input). To	1383	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1475	pass characters instead of octets, you should convert your strings first	1384	pass characters instead of octets, you should convert your strings first
1476	to the locale-specific encoding using C<< $term->locale_encode >>.	1385	to the locale-specific encoding using C<< $term->locale_encode >>.
		1386
		1387	=item $term->tt_paste ($octets)
		1388
		1389	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1390	CR and bracketing the data with control sequences if bracketed paste mode
		1391	is set.
1477		1392
1478	=item $old_events = $term->pty_ev_events ([$new_events])	1393	=item $old_events = $term->pty_ev_events ([$new_events])
1479		1394
1480	Replaces the event mask of the pty watcher by the given event mask. Can	1395	Replaces the event mask of the pty watcher by the given event mask. Can
1481	be used to suppress input and output handling to the pty/tty. See the	1396	be used to suppress input and output handling to the pty/tty. See the
…		…
1499		1414
1500	Adds the specified events to the vt event mask. Useful e.g. when you want	1415	Adds the specified events to the vt event mask. Useful e.g. when you want
1501	to receive pointer events all the times:	1416	to receive pointer events all the times:
1502		1417
1503	$term->vt_emask_add (urxvt::PointerMotionMask);	1418	$term->vt_emask_add (urxvt::PointerMotionMask);
		1419
		1420	=item $term->set_urgency ($set)
		1421
		1422	Enable/disable the urgency hint on the toplevel window.
1504		1423
1505	=item $term->focus_in	1424	=item $term->focus_in
1506		1425
1507	=item $term->focus_out	1426	=item $term->focus_out
1508		1427
…		…
1795	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1714	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1796	recent grab.	1715	recent grab.
1797		1716
1798	=item $term->ungrab	1717	=item $term->ungrab
1799		1718
1800	Calls XUngrab for the most recent grab. Is called automatically on	1719	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1801	evaluation errors, as it is better to lose the grab in the error case as	1720	evaluation errors, as it is better to lose the grab in the error case as
1802	the session.	1721	the session.
1803		1722
1804	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1723	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1805		1724
…		…
1825		1744
1826	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1745	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1827		1746
1828	=item $term->XChangeInput ($window, $add_events[, $del_events])	1747	=item $term->XChangeInput ($window, $add_events[, $del_events])
1829		1748
		1749	=item $keysym = $term->XStringToKeysym ($string)
		1750
		1751	=item $string = $term->XKeysymToString ($keysym)
		1752
1830	Various X or X-related functions. The C<$term> object only serves as	1753	Various X or X-related functions. The C<$term> object only serves as
1831	the source of the display, otherwise those functions map more-or-less	1754	the source of the display, otherwise those functions map more-or-less
1832	directory onto the X functions of the same name.	1755	directly onto the X functions of the same name.
1833		1756
1834	=back	1757	=back
1835		1758
1836	=cut	1759	=cut
1837		1760
…		…
1994		1917
1995	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1918	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1996		1919
1997	Set the callback to be called when the timer triggers.	1920	Set the callback to be called when the timer triggers.
1998		1921
1999	=item $tstamp = $timer->at
2000
2001	Return the time this watcher will fire next.
2002
2003	=item $timer = $timer->set ($tstamp)	1922	=item $timer = $timer->set ($tstamp[, $interval])
2004		1923
2005	Set the time the event is generated to $tstamp.	1924	Set the time the event is generated to $tstamp (and optionally specifies a
		1925	new $interval).
2006		1926
2007	=item $timer = $timer->interval ($interval)	1927	=item $timer = $timer->interval ($interval)
2008		1928
2009	Normally (and when C<$interval> is C<0>), the timer will automatically	1929	By default (and when C<$interval> is C<0>), the timer will automatically
2010	stop after it has fired once. If C<$interval> is non-zero, then the timer	1930	stop after it has fired once. If C<$interval> is non-zero, then the timer
2011	is automatically rescheduled at the given intervals.	1931	is automatically rescheduled at the given intervals.
2012		1932
2013	=item $timer = $timer->start	1933	=item $timer = $timer->start
2014		1934
2015	Start the timer.	1935	Start the timer.
2016		1936
2017	=item $timer = $timer->start ($tstamp)	1937	=item $timer = $timer->start ($tstamp[, $interval])
2018		1938
2019	Set the event trigger time to C<$tstamp> and start the timer.	1939	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		1940	also replaces the interval.
2020		1941
2021	=item $timer = $timer->after ($delay)	1942	=item $timer = $timer->after ($delay[, $interval])
2022		1943
2023	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	1944	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2024		1945
2025	=item $timer = $timer->stop	1946	=item $timer = $timer->stop
2026		1947
…		…
2157		2078
2158	=back	2079	=back
2159		2080
2160	=head1 AUTHOR	2081	=head1 AUTHOR
2161		2082
2162	Marc Lehmann <pcg@goof.com>	2083	Marc Lehmann <schmorp@schmorp.de>
2163	http://software.schmorp.de/pkg/rxvt-unicode	2084	http://software.schmorp.de/pkg/rxvt-unicode
2164		2085
2165	=cut	2086	=cut
2166		2087
2167	1	2088	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.170 by root, Tue Sep 23 07:03:13 2008 UTC vs. Revision 1.219 by sf-exg, Sun Jun 10 18:23:18 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.170 by root, Tue Sep 23 07:03:13 2008 UTC vs.
Revision 1.219 by sf-exg, Sun Jun 10 18:23:18 2012 UTC