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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.152 by tpope, Tue Jan 9 16:18:56 2007 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"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	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> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	@@RXVT_NAME@@ -pe <extensionname>
39		43
40	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:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions that add command line parameters or resources on their own are
45		49	loaded automatically when used.
46	=item selection (enabled by default)
47
48	(More) intelligent selection. This extension tries to be more intelligent
49	when the user extends selections (double-click and further clicks). Right
50	now, it tries to select words, urls and complete shell-quoted
51	arguments, which is very convenient, too, if your F<ls> supports
52	C<--quoting-style=shell>.
53
54	A double-click usually selects the word under the cursor, further clicks
55	will enlarge the selection.
56
57	The selection works by trying to match a number of regexes and displaying
58	them in increasing order of length. You can add your own regexes by
59	specifying resources of the form:
60
61	URxvt.selection.pattern-0: perl-regex
62	URxvt.selection.pattern-1: perl-regex
63	...
64
65	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:
69
70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
71
72	Another example: Programs I use often output "absolute path: " at the
73	beginning of a line when they process multiple files. The following
74	pattern matches the filename (note, there is a single space at the very
75	end):
76
77	URxvt.selection.pattern-0: ^(/[^:]+):\
78
79	You can look at the source of the selection extension to see more
80	interesting uses, such as parsing a line from beginning to end.
81
82	This extension also offers following bindable keyboard commands:
83
84	=over 4
85
86	=item rot13
87
88	Rot-13 the selection when activated. Used via keyboard trigger:
89
90	URxvt.keysym.C-M-r: perl:selection:rot13
91
92	=back
93
94	=item option-popup (enabled by default)
95
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.
98
99	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.
102
103	It's sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as
107	first argument.
108
109	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:
111
112	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};
115
116	=item selection-popup (enabled by default)
117
118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
119	text into various other formats/action (such as uri unescaping, perl
120	evaluation, web-browser starting etc.), depending on content.
121
122	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.
125
126	It's sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide whether to add something or not.
128	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.
131
132	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:
135
136	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }
138	: ()
139	};
140
141	=item searchable-scrollback<hotkey> (enabled by default)
142
143	Adds regex search functionality to the scrollback buffer, triggered
144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
145	input/output is suspended and a regex is displayed at the bottom of the
146	screen.
147
148	Inputting characters appends them to the regex and continues incremental
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary
154	selection.
155
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.
159
160	See L<perlre> for more info about perl regular expression syntax.
161
162	=item readline (enabled by default)
163
164	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to
166	move the text cursor to this position. It does so by generating as many
167	cursor-left or cursor-right keypresses as required (the this only works
168	for programs that correctly support wide characters).
169
170	To avoid too many false positives, this is only done when:
171
172	=over 4
173
174	=item - the tty is in ICANON state.
175
176	=item - the text cursor is visible.
177
178	=item - the primary screen is currently being displayed.
179
180	=item - the mouse is on the same (multi-row-) line as the text cursor.
181
182	=back
183
184	The normal selection mechanism isn't disabled, so quick successive clicks
185	might interfere with selection creation in harmless ways.
186
187	=item selection-autotransform
188
189	This selection allows you to do automatic transforms on a selection
190	whenever a selection is made.
191
192	It works by specifying perl snippets (most useful is a single C<s///>
193	operator) that modify C<$_> as resources:
194
195	URxvt.selection-autotransform.0: transform
196	URxvt.selection-autotransform.1: transform
197	...
198
199	For example, the following will transform selections of the form
200	C<filename:number>, often seen in compiler messages, into C<vi +$filename
201	$word>:
202
203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
204
205	And this example matches the same,but replaces it with vi-commands you can
206	paste directly into your (vi :) editor:
207
208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
209
210	Of course, this can be modified to suit your needs and your editor :)
211
212	To expand the example above to typical perl error messages ("XXX at
213	FILENAME line YYY."), you need a slightly more elaborate solution:
214
215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
217
218	The first line tells the selection code to treat the unchanging part of
219	every error message as a selection pattern, and the second line transforms
220	the message into vi commands to load the file.
221
222	=item tabbed
223
224	This transforms the terminal into a tabbar with additional terminals, that
225	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
227	button per tab.
228
229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
230	B<Shift-Right> will switch to the tab left or right of the current one,
231	while B<Shift-Down> creates a new tab.
232
233	The tabbar itself can be configured similarly to a normal terminal, but
234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
235	following four resources (shown with defaults):
236
237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
239	URxvt.tabbed.tab-fg: <colour-index, default 0>
240	URxvt.tabbed.tab-bg: <colour-index, default 1>
241
242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243	indices.
244
245	=item matcher
246
247	Uses per-line display filtering (C<on_line_update>) to underline text
248	matching a certain pattern and make it clickable. When clicked with the
249	mouse button specified in the C<matcher.button> resource (default 2, or
250	middle), the program specified in the C<matcher.launcher> resource
251	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
252	with the matched text as first argument. The default configuration is
253	suitable for matching URLs and launching a web browser, like the
254	former "mark-urls" extension.
255
256	The default pattern to match URLs can be overridden with the
257	C<matcher.pattern.0> resource, and additional patterns can be specified
258	with numbered patterns, in a manner similar to the "selection" extension.
259	The launcher can also be overridden on a per-pattern basis.
260
261	Example configuration:
262
263	URxvt.perl-ext: default,matcher
264	URxvt.urlLauncher: sensible-browser
265	URxvt.keysym.C-Delete: perl:matcher
266	URxvt.matcher.button: 1
267	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
268	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
269	URxvt.matcher.launcher.2: gvim +$2 $1
270
271	=item xim-onthespot
272
273	This (experimental) perl extension implements OnTheSpot editing. It does
274	not work perfectly, and some input methods don't seem to work well with
275	OnTheSpot editing in general, but it seems to work at leats for SCIM and
276	kinput2.
277
278	You enable it by specifying this extension and a preedit style of
279	C<OnTheSpot>, i.e.:
280
281	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
282
283	=item kuake<hotkey>
284
285	A very primitive quake-console-like extension. It was inspired by a
286	description of how the programs C<kuake> and C<yakuake> work: Whenever the
287	user presses a global accelerator key (by default C<F10>), the terminal
288	will show or hide itself. Another press of the accelerator key will hide
289	or show it again.
290
291	Initially, the window will not be shown when using this extension.
292
293	This is useful if you need a single terminal thats not using any desktop
294	space most of the time but is quickly available at the press of a key.
295
296	The accelerator key is grabbed regardless of any modifiers, so this
297	extension will actually grab a physical key just for this function.
298
299	If you want a quake-like animation, tell your window manager to do so
300	(fvwm can do it).
301
302	=item automove-background
303
304	This is basically a very small extension that dynamically changes the
305	background pixmap offset to the window position, in effect creating the
306	same effect as pseudo transparency with a custom pixmap. No scaling is
307	supported in this mode. Example:
308
309	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
310
311	=item block-graphics-to-ascii
312
313	A not very useful example of filtering all text output to the terminal
314	by replacing all line-drawing characters (U+2500 .. U+259F) by a
315	similar-looking ascii character.
316
317	=item digital-clock
318
319	Displays a digital clock using the built-in overlay.
320
321	=item remote-clipboard
322
323	Somewhat of a misnomer, this extension adds two menu entries to the
324	selection popup that allows one ti run external commands to store the
325	selection somewhere and fetch it again.
326
327	We use it to implement a "distributed selection mechanism", which just
328	means that one command uploads the file to a remote server, and another
329	reads it.
330
331	The commands can be set using the C<URxvt.remote-selection.store> and
332	C<URxvt.remote-selection.fetch> resources. The first should read the
333	selection to store from STDIN (always in UTF-8), the second should provide
334	the selection data on STDOUT (also in UTF-8).
335
336	The defaults (which are likely useless to you) use rsh and cat:
337
338	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
339	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
340
341	=item selection-pastebin
342
343	This is a little rarely useful extension that Uploads the selection as
344	textfile to a remote site (or does other things). (The implementation is
345	not currently secure for use in a multiuser environment as it writes to
346	F</tmp> directly.).
347
348	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
349	i.e.
350
351	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
352
353	Pressing this combination runs a command with C<%> replaced by the name of
354	the textfile. This command can be set via a resource:
355
356	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
357
358	And the default is likely not useful to anybody but the few people around
359	here :)
360
361	The name of the textfile is the hex encoded md5 sum of the selection, so
362	the same content should lead to the same filename.
363
364	After a successful upload the selection will be replaced by the text given
365	in the C<selection-pastebin-url> resource (again, the % is the placeholder
366	for the filename):
367
368	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
369
370	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
371	the double C</> characters as comment start. Use C<\057\057> instead,
372	which works regardless of wether xrdb is used to parse the resource file
373	or not.
374
375	=item example-refresh-hooks
376
377	Displays a very simple digital clock in the upper right corner of the
378	window. Illustrates overwriting the refresh callbacks to create your own
379	overlays or changes.
380
381	=back
382		50
383	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
384		52
385	=head2 General API Considerations	53	=head2 General API Considerations
386		54
…		…
400		68
401	=over 4	69	=over 4
402		70
403	=item $text	71	=item $text
404		72
405	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
406	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.
407		75
408	=item $string	76	=item $string
409		77
410	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
…		…
414	=item $octets	82	=item $octets
415		83
416	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
417	locale-specific way.	85	locale-specific way.
418		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
419	=back	93	=back
420		94
421	=head2 Extension Objects	95	=head2 Extension Objects
422		96
423	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
424	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,
425	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
426	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
427	extensions or other terminals, with the exception of methods and members	101	extensions or other terminals, with the exception of methods and members
428	that begin with an underscore character C<_>: these are reserved for	102	that begin with an underscore character C<_>: these are reserved for
429	internal use.	103	internal use.
…		…
544		218
545	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,
546	$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
547	number of lines that will be in the scrollback buffer.	221	number of lines that will be in the scrollback buffer.
548		222
549	=item on_osc_seq $term, $op, $args	223	=item on_osc_seq $term, $op, $args, $resp
550		224
551	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
552	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
553	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
554	confused by recursive invocations when you output an osc sequence within	228	confused by recursive invocations when you output an OSC sequence within
555	this callback.	229	this callback.
556		230
557	C<on_osc_seq_perl> should be used for new behaviour.	231	C<on_osc_seq_perl> should be used for new behaviour.
558		232
559	=item on_osc_seq_perl $term, $string	233	=item on_osc_seq_perl $term, $args, $resp
560		234
561	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	235	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
562	operating system command) is processed. Cursor position and other state	236	operating system command) is processed. Cursor position and other state
563	information is up-to-date when this happens. For interoperability, the	237	information is up-to-date when this happens. For interoperability, the
564	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,
565	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
566	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	}
567		251
568	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,
569	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
570	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.
571		258
572	=item on_add_lines $term, $string	259	=item on_add_lines $term, $string
573		260
574	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
575	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
…		…
580	=item on_tt_write $term, $octets	267	=item on_tt_write $term, $octets
581		268
582	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
583	suppress or filter tty input.	270	suppress or filter tty input.
584		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
585	=item on_line_update $term, $row	279	=item on_line_update $term, $row
586		280
587	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
588	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
589	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,
…		…
596	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
597	you cannot just toggle rendition bits, but only set them.	291	you cannot just toggle rendition bits, but only set them.
598		292
599	=item on_refresh_begin $term	293	=item on_refresh_begin $term
600		294
601	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
602	or similar effects by modify terminal contents in refresh_begin, and	296	similar effects by modifying the terminal contents in refresh_begin, and
603	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
604	code is run after this hook, and takes precedence.	298	code is run after this hook, and takes precedence.
605		299
606	=item on_refresh_end $term	300	=item on_refresh_end $term
607		301
…		…
614	resource in the @@RXVT_NAME@@(1) manpage).	308	resource in the @@RXVT_NAME@@(1) manpage).
615		309
616	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
617	slightly in the future.	311	slightly in the future.
618		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
619	=item on_resize_all_windows $tern, $new_width, $new_height	320	=item on_resize_all_windows $term, $new_width, $new_height
620		321
621	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
622	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
623	returns TRUE, setting of the window hints is being skipped.	324	returns TRUE, setting of the window hints is being skipped.
624		325
…		…
658		359
659	=item on_map_notify $term, $event	360	=item on_map_notify $term, $event
660		361
661	=item on_unmap_notify $term, $event	362	=item on_unmap_notify $term, $event
662		363
663	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
664	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.
665		366
666	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
667	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
668	(real, not screen-based) row and column under the mouse cursor.	369	(real, not screen-based) row and column under the mouse cursor.
669		370
…		…
679	=item on_wm_delete_window $term, $event	380	=item on_wm_delete_window $term, $event
680		381
681	Called when various types of ClientMessage events are received (all with	382	Called when various types of ClientMessage events are received (all with
682	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	383	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
683		384
		385	=item on_bell $term
		386
		387	Called on receipt of a bell character.
		388
684	=back	389	=back
685		390
686	=cut	391	=cut
687		392
688	package urxvt;	393	package urxvt;
689		394
690	use utf8;	395	use utf8;
691	use strict;	396	use strict 'vars';
692	use Carp ();	397	use Carp ();
693	use Scalar::Util ();	398	use Scalar::Util ();
694	use List::Util ();	399	use List::Util ();
695		400
696	our $VERSION = 1;	401	our $VERSION = 1;
697	our $TERM;	402	our $TERM;
698	our @TERM_INIT;	403	our @TERM_INIT; # should go, prevents async I/O etc.
699	our @TERM_EXT;	404	our @TERM_EXT; # should go, prevents async I/O etc.
700	our @HOOKNAME;	405	our @HOOKNAME;
701	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	406	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
702	our %OPTION;	407	our %OPTION;
703		408
704	our $LIBDIR;	409	our $LIBDIR;
…		…
752		457
753	=over 4	458	=over 4
754		459
755	=item urxvt::fatal $errormessage	460	=item urxvt::fatal $errormessage
756		461
757	Fatally aborts execution with the given error message. Avoid at all	462	Fatally aborts execution with the given error message (which should
758	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
759	starts up.	464	is acceptable (and useful) is in the init hook, where it prevents the
		465	terminal from starting up.
760		466
761	=item urxvt::warn $string	467	=item urxvt::warn $string
762		468
763	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
764	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
765	that calls this function.	471	that calls this function.
766		472
767	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
768	correct place, e.g. on stderr of the connecting urxvtc client.	474	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
772	=item @terms = urxvt::termlist	478	=item @terms = urxvt::termlist
773		479
774	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
775	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
776	objects that have perl extensions attached will be returned (because there	482	objects that have perl extensions attached will be returned (because there
777	is no urxvt::term objet associated with others).	483	is no urxvt::term object associated with others).
778		484
779	=item $time = urxvt::NOW	485	=item $time = urxvt::NOW
780		486
781	Returns the "current time" (as per the event loop).	487	Returns the "current time" (as per the event loop).
782		488
…		…
825		531
826	=item $rend = urxvt::OVERLAY_RSTYLE	532	=item $rend = urxvt::OVERLAY_RSTYLE
827		533
828	Return the rendition mask used for overlays by default.	534	Return the rendition mask used for overlays by default.
829		535
830	=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
831		538
832	Return the bit that enabled bold, italic, blink, reverse-video and	539	Return the bit that enabled bold, italic, blink, reverse-video and
833	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
834	the bitset.	541	the bitset.
835		542
…		…
872	};	579	};
873	}	580	}
874		581
875	no warnings 'utf8';	582	no warnings 'utf8';
876		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
877	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	644	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
878		645
879	sub verbose {	646	sub verbose {
880	my ($level, $msg) = @_;	647	my ($level, $msg) = @_;
881	warn "$msg\n" if $level <= $verbosity;	648	warn "$msg\n" if $level <= $verbosity;
…		…
893	$pkg =~ s/[^[:word:]]/_/g;	660	$pkg =~ s/[^[:word:]]/_/g;
894	$pkg = "urxvt::ext::$pkg";	661	$pkg = "urxvt::ext::$pkg";
895		662
896	verbose 3, "loading extension '$path' into package '$pkg'";	663	verbose 3, "loading extension '$path' into package '$pkg'";
897		664
		665	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		666
898	open my $fh, "<:raw", $path	667	open my $fh, "<:raw", $path
899	or die "$path: $!";	668	or die "$path: $!";
900		669
901	my $source =	670	my $source =
902	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	671	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
903	. "#line 1 \"$path\"\n{\n"	672	. "#line 1 \"$path\"\n{\n"
904	. (do { local $/; <$fh> })	673	. (do { local $/; <$fh> })
905	. "\n};\n1";	674	. "\n};\n1";
906		675
907	eval $source	676	eval $source
…		…
917	sub invoke {	686	sub invoke {
918	local $TERM = shift;	687	local $TERM = shift;
919	my $htype = shift;	688	my $htype = shift;
920		689
921	if ($htype == 0) { # INIT	690	if ($htype == 0) { # INIT
922	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	691	my @dirs = $TERM->perl_libdirs;
923		692
924	my %ext_arg;	693	my %ext_arg;
925		694
926	{	695	{
927	my @init = @TERM_INIT;	696	my @init = @TERM_INIT;
928	@TERM_INIT = ();	697	@TERM_INIT = ();
…		…
930	my @pkg = @TERM_EXT;	699	my @pkg = @TERM_EXT;
931	@TERM_EXT = ();	700	@TERM_EXT = ();
932	$TERM->register_package ($_) for @pkg;	701	$TERM->register_package ($_) for @pkg;
933	}	702	}
934		703
		704	for (
		705	@{ delete $TERM->{perl_ext_3} },
935	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		707	) {
936	if ($_ eq "default") {	708	if ($_ eq "default") {
937	$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);
938	} elsif (/^-(.*)$/) {	710	} elsif (/^-(.*)$/) {
939	delete $ext_arg{$1};	711	delete $ext_arg{$1};
940	} elsif (/^([^<]+)<(.*)>$/) {	712	} elsif (/^([^<]+)<(.*)>$/) {
…		…
1016	}	788	}
1017	}	789	}
1018	($mask, @color{qw(fg bg)}, \@failed)	790	($mask, @color{qw(fg bg)}, \@failed)
1019	}	791	}
1020		792
1021	# urxvt::term::extension
1022
1023	package urxvt::term::extension;	793	package urxvt::term::extension;
1024		794
1025	sub enable {	795	sub enable {
1026	my ($self, %hook) = @_;	796	my ($self, %hook) = @_;
1027	my $pkg = $self->{_pkg};	797	my $pkg = $self->{_pkg};
…		…
1081		851
1082	sub urxvt::destroy_hook(&) {	852	sub urxvt::destroy_hook(&) {
1083	bless \shift, urxvt::destroy_hook::	853	bless \shift, urxvt::destroy_hook::
1084	}	854	}
1085		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
1086	package urxvt::anyevent;	868	package urxvt::anyevent;
1087		869
1088	=head2 The C<urxvt::anyevent> Class	870	=head2 The C<urxvt::anyevent> Class
1089		871
1090	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
1091	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
1092	further programming. The only exception is that you cannot wait on	874	further programming. The only exception is that you cannot wait on
1093	condition variables, but non-blocking condvar use is ok. What this means	875	condition variables, but non-blocking condvar use is ok.
1094	is that you cannot use blocking APIs, but the non-blocking variant should	876
1095	work.	877	In practical terms this means is that you cannot use blocking APIs, but
		878	the non-blocking variant should work.
1096		879
1097	=cut	880	=cut
1098		881
1099	our $VERSION = 1;	882	our $VERSION = '5.23';
1100		883
1101	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	884	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1102	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	885	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1103		886
1104	sub timer {	887	sub timer {
…		…
1106		889
1107	my $cb = $arg{cb};	890	my $cb = $arg{cb};
1108		891
1109	urxvt::timer	892	urxvt::timer
1110	->new	893	->new
1111	->start (urxvt::NOW + $arg{after})	894	->after ($arg{after}, $arg{interval})
1112	->cb (sub {	895	->cb ($arg{interval} ? $cb : sub {
1113	$_[0]->stop; # need to cancel manually	896	$_[0]->stop; # need to cancel manually
1114	$cb->();	897	$cb->();
1115	})	898	})
1116	}	899	}
1117		900
1118	sub io {	901	sub io {
1119	my ($class, %arg) = @_;	902	my ($class, %arg) = @_;
1120		903
1121	my $cb = $arg{cb};	904	my $cb = $arg{cb};
		905	my $fd = fileno $arg{fh};
		906	defined $fd or $fd = $arg{fh};
1122		907
1123	bless [$arg{fh}, urxvt::iow	908	bless [$arg{fh}, urxvt::iow
1124	->new	909	->new
1125	->fd (fileno $arg{fh})	910	->fd ($fd)
1126	->events (($arg{poll} =~ /r/ ? 1 : 0)	911	->events (($arg{poll} =~ /r/ ? 1 : 0)
1127	\| ($arg{poll} =~ /w/ ? 2 : 0))	912	\| ($arg{poll} =~ /w/ ? 2 : 0))
1128	->start	913	->start
1129	->cb (sub {	914	->cb ($cb)
1130	$cb->(($_[1] & 1 ? 'r' : '')
1131	. ($_[1] & 2 ? 'w' : ''));
1132	})],
1133	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	})
1134	}	941	}
1135		942
1136	sub DESTROY {	943	sub DESTROY {
1137	$_[0][1]->stop;	944	$_[0][1]->stop;
1138	}	945	}
1139		946
1140	sub condvar {	947	# only needed for AnyEvent < 6 compatibility
1141	bless \my $flag, urxvt::anyevent::
1142	}
1143
1144	sub broadcast {
1145	${$_[0]}++;
1146	}
1147
1148	sub wait {
1149	unless (${$_[0]}) {
1150	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1151	}
1152	}
1153
1154	sub one_event {	948	sub one_event {
1155	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";
1156	}	950	}
1157		951
1158	package urxvt::term;	952	package urxvt::term;
…		…
1173	urxvt::verbose 6, "register package $pkg to $self";	967	urxvt::verbose 6, "register package $pkg to $self";
1174		968
1175	@{"$pkg\::ISA"} = urxvt::term::extension::;	969	@{"$pkg\::ISA"} = urxvt::term::extension::;
1176		970
1177	my $proxy = bless {	971	my $proxy = bless {
1178	_pkg => $pkg,	972	_pkg => $pkg,
		973	_name => ${"$pkg\::_NAME"}, # hackish
1179	argv => $argv,	974	argv => $argv,
1180	}, $pkg;	975	}, $pkg;
1181	Scalar::Util::weaken ($proxy->{term} = $self);	976	Scalar::Util::weaken ($proxy->{term} = $self);
1182		977
1183	$self->{_pkg}{$pkg} = $proxy;	978	$self->{_pkg}{$pkg} = $proxy;
1184		979
…		…
1187	$proxy->enable ($name => $ref);	982	$proxy->enable ($name => $ref);
1188	}	983	}
1189	}	984	}
1190	}	985	}
1191		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
1192	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1193		1035
1194	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
1195	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
1196	hash which defines the environment of the new terminal.	1038	hash which defines the environment of the new terminal.
…		…
1250	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.
1251		1093
1252	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
1253	source file F</src/optinc.h> to see the actual list:	1095	source file F</src/optinc.h> to see the actual list:
1254		1096
1255	borderLess console cursorBlink cursorUnderline hold iconic insecure	1097	borderLess buffered console cursorBlink cursorUnderline hold iconic
1256	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1098	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1257	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1099	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1258	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1100	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1259	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1101	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1260	transparent tripleclickwords utmpInhibit visualBell	1102	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1103	urgentOnBell utmpInhibit visualBell
1261		1104
1262	=item $value = $term->resource ($name[, $newval])	1105	=item $value = $term->resource ($name[, $newval])
1263		1106
1264	Returns the current resource value associated with a given name and	1107	Returns the current resource value associated with a given name and
1265	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>
…		…
1278		1121
1279	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
1280	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>
1281	to see the actual list:	1124	to see the actual list:
1282		1125
1283	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1126	answerbackstring backgroundPixmap backspace_key blurradius
1284	borderLess color cursorBlink cursorUnderline cutchars delete_key	1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1285	display_name embed ext_bwidth fade font geometry hold iconName	1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1286	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
1287	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1288	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1132	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1289	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1133	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1290	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1134	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1291	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1135	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1292	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1136	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1293	secondaryScreen secondaryScroll selectstyle shade term_name title	1137	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1294	transient_for transparent transparent_all tripleclickwords utmpInhibit	1138	term_name title transient_for transparent tripleclickwords urgentOnBell
1295	visualBell	1139	utmpInhibit visualBell
1296		1140
1297	=cut	1141	=cut
1298		1142
1299	sub resource($$;$) {	1143	sub resource($$;$) {
1300	my ($self, $name) = (shift, shift);	1144	my ($self, $name) = (shift, shift);
1301	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1145	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1302	&urxvt::term::_resource	1146	goto &urxvt::term::_resource
1303	}	1147	}
1304		1148
1305	=item $value = $term->x_resource ($pattern)	1149	=item $value = $term->x_resource ($pattern)
1306		1150
1307	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
1308	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
1309	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
1310	resource with that pattern exists.	1154	resource with that pattern exists.
1311		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
1312	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
1313	only one resource database per display, and later invocations might return	1167	only one resource database per display, and later invocations might return
1314	the wrong resources.	1168	the wrong resources.
1315		1169
1316	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1170	=item $value = $term->x_resource_boolean ($pattern)
1317		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
1318	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
1319	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.
1320		1197
1321	=item $rend = $term->rstyle ([$new_rstyle])	1198	=item $rend = $term->rstyle ([$new_rstyle])
1322		1199
1323	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
1324	the terminal application will use this style.	1201	the terminal application will use this style.
…		…
1332		1209
1333	=item ($row, $col) = $term->selection_beg ([$row, $col])	1210	=item ($row, $col) = $term->selection_beg ([$row, $col])
1334		1211
1335	=item ($row, $col) = $term->selection_end ([$row, $col])	1212	=item ($row, $col) = $term->selection_end ([$row, $col])
1336		1213
1337	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.
1338	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.
1339		1223
1340	=item $term->selection_make ($eventtime[, $rectangular])	1224	=item $term->selection_make ($eventtime[, $rectangular])
1341		1225
1342	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
1343	C<selection_end>. If C<$rectangular> is true (default: false), a	1227	C<selection_end>. If C<$rectangular> is true (default: false), a
1344	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
1345	a selection.	1229	a selection.
1346		1230
1347	=item $success = $term->selection_grab ($eventtime)	1231	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1348		1232
1349	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
1350	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
1351	is mostly useful from within C<on_sel_grab> hooks.	1236	is mostly useful from within C<on_sel_grab> hooks.
1352		1237
1353	=item $oldtext = $term->selection ([$newtext])	1238	=item $oldtext = $term->selection ([$newtext, $clipboard])
1354		1239
1355	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.
1356		1246
1357	=item $term->overlay_simple ($x, $y, $text)	1247	=item $term->overlay_simple ($x, $y, $text)
1358		1248
1359	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.
1360		1250
…		…
1390		1280
1391	The methods currently supported on C<urxvt::overlay> objects are:	1281	The methods currently supported on C<urxvt::overlay> objects are:
1392		1282
1393	=over 4	1283	=over 4
1394		1284
1395	=item $overlay->set ($x, $y, $text, $rend)	1285	=item $overlay->set ($x, $y, $text[, $rend])
1396		1286
1397	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
1398	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
1399	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.
1400		1292
1401	=item $overlay->hide	1293	=item $overlay->hide
1402		1294
1403	If visible, hide the overlay, but do not destroy it.	1295	If visible, hide the overlay, but do not destroy it.
1404		1296
…		…
1486	locale-specific encoding of the terminal and can contain command sequences	1378	locale-specific encoding of the terminal and can contain command sequences
1487	(escape codes) that will be interpreted.	1379	(escape codes) that will be interpreted.
1488		1380
1489	=item $term->tt_write ($octets)	1381	=item $term->tt_write ($octets)
1490		1382
1491	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
1492	pass characters instead of octets, you should convert your strings first	1384	pass characters instead of octets, you should convert your strings first
1493	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.
1494		1392
1495	=item $old_events = $term->pty_ev_events ([$new_events])	1393	=item $old_events = $term->pty_ev_events ([$new_events])
1496		1394
1497	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
1498	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
…		…
1517	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
1518	to receive pointer events all the times:	1416	to receive pointer events all the times:
1519		1417
1520	$term->vt_emask_add (urxvt::PointerMotionMask);	1418	$term->vt_emask_add (urxvt::PointerMotionMask);
1521		1419
		1420	=item $term->set_urgency ($set)
		1421
		1422	Enable/disable the urgency hint on the toplevel window.
		1423
1522	=item $term->focus_in	1424	=item $term->focus_in
1523		1425
1524	=item $term->focus_out	1426	=item $term->focus_out
1525		1427
1526	=item $term->key_press ($state, $keycode[, $time])	1428	=item $term->key_press ($state, $keycode[, $time])
…		…
1614		1516
1615	Used after changing terminal contents to display them.	1517	Used after changing terminal contents to display them.
1616		1518
1617	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1618		1520
1619	Returns the text of the entire row with number C<$row_number>. Row C<0>	1521	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1620	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1522	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1621	terminal line. The scrollback buffer starts at line C<-1> and extends to
1622	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1523	terminal line. Nothing will be returned if a nonexistent line
1623	is requested.	1524	is requested.
1624		1525
1625	If C<$new_text> is specified, it will replace characters in the current	1526	If C<$new_text> is specified, it will replace characters in the current
1626	line, starting at column C<$start_col> (default C<0>), which is useful	1527	line, starting at column C<$start_col> (default C<0>), which is useful
1627	to replace only parts of a line. The font index in the rendition will	1528	to replace only parts of a line. The font index in the rendition will
1628	automatically be updated.	1529	automatically be updated.
1629		1530
1630	C<$text> is in a special encoding: tabs and wide characters that use more	1531	C<$text> is in a special encoding: tabs and wide characters that use more
1631	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1532	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1632	characters. Characters with combining characters and other characters that	1533	characters. Characters with combining characters and other characters that
1633	do not fit into the normal tetx encoding will be replaced with characters	1534	do not fit into the normal text encoding will be replaced with characters
1634	in the private use area.	1535	in the private use area.
1635		1536
1636	You have to obey this encoding when changing text. The advantage is	1537	You have to obey this encoding when changing text. The advantage is
1637	that C<substr> and similar functions work on screen cells and not on	1538	that C<substr> and similar functions work on screen cells and not on
1638	characters.	1539	characters.
…		…
1813	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1714	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1814	recent grab.	1715	recent grab.
1815		1716
1816	=item $term->ungrab	1717	=item $term->ungrab
1817		1718
1818	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
1819	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
1820	the session.	1721	the session.
1821		1722
1822	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1723	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1823		1724
…		…
1825		1726
1826	=item @atoms = $term->XListProperties ($window)	1727	=item @atoms = $term->XListProperties ($window)
1827		1728
1828	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1729	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1829		1730
1830	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1731	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1831		1732
1832	=item $term->XDeleteProperty ($window, $property)	1733	=item $term->XDeleteProperty ($window, $property)
1833		1734
1834	=item $window = $term->DefaultRootWindow	1735	=item $window = $term->DefaultRootWindow
1835		1736
…		…
1842	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1743	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1843		1744
1844	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1745	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1845		1746
1846	=item $term->XChangeInput ($window, $add_events[, $del_events])	1747	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1748
		1749	=item $keysym = $term->XStringToKeysym ($string)
		1750
		1751	=item $string = $term->XKeysymToString ($keysym)
1847		1752
1848	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
1849	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
1850	directory onto the X functions of the same name.	1755	directly onto the X functions of the same name.
1851		1756
1852	=back	1757	=back
1853		1758
1854	=cut	1759	=cut
1855		1760
…		…
1957	my $env = $self->{term}->env;	1862	my $env = $self->{term}->env;
1958	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1863	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1959	delete $env->{LC_ALL};	1864	delete $env->{LC_ALL};
1960	$env->{LC_CTYPE} = $self->{term}->locale;	1865	$env->{LC_CTYPE} = $self->{term}->locale;
1961		1866
1962	urxvt::term->new ($env, "popup",	1867	my $term = urxvt::term->new (
		1868	$env, "popup",
1963	"--perl-lib" => "", "--perl-ext-common" => "",	1869	"--perl-lib" => "", "--perl-ext-common" => "",
1964	"-pty-fd" => -1, "-sl" => 0,	1870	"-pty-fd" => -1, "-sl" => 0,
1965	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1871	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1966	"--transient-for" => $self->{term}->parent,	1872	"--transient-for" => $self->{term}->parent,
1967	"-display" => $self->{term}->display_id,	1873	"-display" => $self->{term}->display_id,
1968	"-pe" => "urxvt-popup")	1874	"-pe" => "urxvt-popup",
1969	or die "unable to create popup window\n";	1875	) or die "unable to create popup window\n";
		1876
		1877	unless (delete $term->{urxvt_popup_init_done}) {
		1878	$term->ungrab;
		1879	$term->destroy;
		1880	die "unable to initialise popup window\n";
		1881	}
1970	}	1882	}
1971		1883
1972	sub DESTROY {	1884	sub DESTROY {
1973	my ($self) = @_;	1885	my ($self) = @_;
1974		1886
…		…
1992	->new	1904	->new
1993	->interval (1)	1905	->interval (1)
1994	->cb (sub {	1906	->cb (sub {
1995	$term->{overlay}->set (0, 0,	1907	$term->{overlay}->set (0, 0,
1996	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1908	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1997	});	1909	});
1998		1910
1999	=over 4	1911	=over 4
2000		1912
2001	=item $timer = new urxvt::timer	1913	=item $timer = new urxvt::timer
2002		1914
…		…
2005		1917
2006	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1918	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2007		1919
2008	Set the callback to be called when the timer triggers.	1920	Set the callback to be called when the timer triggers.
2009		1921
2010	=item $tstamp = $timer->at
2011
2012	Return the time this watcher will fire next.
2013
2014	=item $timer = $timer->set ($tstamp)	1922	=item $timer = $timer->set ($tstamp[, $interval])
2015		1923
2016	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).
2017		1926
2018	=item $timer = $timer->interval ($interval)	1927	=item $timer = $timer->interval ($interval)
2019		1928
2020	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
2021	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
2022	is automatically rescheduled at the given intervals.	1931	is automatically rescheduled at the given intervals.
2023		1932
2024	=item $timer = $timer->start	1933	=item $timer = $timer->start
2025		1934
2026	Start the timer.	1935	Start the timer.
2027		1936
2028	=item $timer = $timer->start ($tstamp)	1937	=item $timer = $timer->start ($tstamp[, $interval])
2029		1938
2030	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.
2031		1941
2032	=item $timer = $timer->after ($delay)	1942	=item $timer = $timer->after ($delay[, $interval])
2033		1943
2034	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>.
2035		1945
2036	=item $timer = $timer->stop	1946	=item $timer = $timer->stop
2037		1947
…		…
2045		1955
2046	$term->{socket} = ...	1956	$term->{socket} = ...
2047	$term->{iow} = urxvt::iow	1957	$term->{iow} = urxvt::iow
2048	->new	1958	->new
2049	->fd (fileno $term->{socket})	1959	->fd (fileno $term->{socket})
2050	->events (urxvt::EVENT_READ)	1960	->events (urxvt::EV_READ)
2051	->start	1961	->start
2052	->cb (sub {	1962	->cb (sub {
2053	my ($iow, $revents) = @_;	1963	my ($iow, $revents) = @_;
2054	# $revents must be 1 here, no need to check	1964	# $revents must be 1 here, no need to check
2055	sysread $term->{socket}, my $buf, 8192	1965	sysread $term->{socket}, my $buf, 8192
…		…
2073	Set the file descriptor (not handle) to watch.	1983	Set the file descriptor (not handle) to watch.
2074		1984
2075	=item $iow = $iow->events ($eventmask)	1985	=item $iow = $iow->events ($eventmask)
2076		1986
2077	Set the event mask to watch. The only allowed values are	1987	Set the event mask to watch. The only allowed values are
2078	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	1988	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2079	together, or C<urxvt::EVENT_NONE>.	1989	together, or C<urxvt::EV_NONE>.
2080		1990
2081	=item $iow = $iow->start	1991	=item $iow = $iow->start
2082		1992
2083	Start watching for requested events on the given handle.	1993	Start watching for requested events on the given handle.
2084		1994
…		…
2125	->new	2035	->new
2126	->start ($pid)	2036	->start ($pid)
2127	->cb (sub {	2037	->cb (sub {
2128	my ($pw, $exit_status) = @_;	2038	my ($pw, $exit_status) = @_;
2129	...	2039	...
2130	});	2040	});
2131		2041
2132	=over 4	2042	=over 4
2133		2043
2134	=item $pw = new urxvt::pw	2044	=item $pw = new urxvt::pw
2135		2045
…		…
2168		2078
2169	=back	2079	=back
2170		2080
2171	=head1 AUTHOR	2081	=head1 AUTHOR
2172		2082
2173	Marc Lehmann <pcg@goof.com>	2083	Marc Lehmann <schmorp@schmorp.de>
2174	http://software.schmorp.de/pkg/rxvt-unicode	2084	http://software.schmorp.de/pkg/rxvt-unicode
2175		2085
2176	=cut	2086	=cut
2177		2087
2178	1	2088	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.152 by tpope, Tue Jan 9 16:18:56 2007 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.152 by tpope, Tue Jan 9 16:18:56 2007 UTC vs.
Revision 1.219 by sf-exg, Sun Jun 10 18:23:18 2012 UTC