ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC vs.
Revision 1.224 by root, Sat Jul 14 08:00:34 2012 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime 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 followign adds a regex that matches everything
68	between two vertical bars:
69
70	URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72	You can look at the source of the selection extension to see more
73	interesting uses, such as parsing a line from beginning to end.
74
75	This extension also offers following bindable keyboard commands:
76
77	=over 4
78
79	=item rot13
80
81	Rot-13 the selection when activated. Used via keyboard trigger:
82
83	URxvt.keysym.C-M-r: perl:selection:rot13
84
85	=back
86
87	=item option-popup (enabled by default)
88
89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90	runtime.
91
92	=item selection-popup (enabled by default)
93
94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95	text into various other formats/action (such as uri unescaping, perl
96	evaluation, web-browser starting etc.), depending on content.
97
98	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100	popup is displayed.
101
102	It's sole argument is the popup menu, which can be modified. The selection
103	is in C<$_>, which can be used to decide wether to add something or not.
104	It should either return nothing or a string and a code reference. The
105	string will be used as button text and the code reference will be called
106	when the button gets activated and should transform C<$_>.
107
108	The following will add an entry C<a to b> that transforms all C<a>s in
109	the selection to C<b>s, but only if the selection currently contains any
110	C<a>s:
111
112	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }
114	: ()
115	};
116
117	=item searchable-scrollback<hotkey> (enabled by default)
118
119	Adds regex search functionality to the scrollback buffer, triggered
120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
121	input/output is suspended and a regex is displayed at the bottom of the
122	screen.
123
124	Inputting characters appends them to the regex and continues incremental
125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
127	bottom. C<Escape> leaves search mode and returns to the point where search
128	was started, while C<Enter> or C<Return> stay at the current position and
129	additionally stores the first match in the current line into the primary
130	selection.
131
132	=item selection-autotransform
133
134	This selection allows you to do automatic transforms on a selection
135	whenever a selection is made.
136
137	It works by specifying perl snippets (most useful is a single C<s///>
138	operator) that modify C<$_> as resources:
139
140	URxvt.selection-autotransform.0: transform
141	URxvt.selection-autotransform.1: transform
142	...
143
144	For example, the following will transform selections of the form
145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
146	$word>:
147
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149
150	And this example matches the same,but replaces it with vi-commands you can
151	paste directly into your (vi :) editor:
152
153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154
155	Of course, this can be modified to suit your needs and your editor :)
156
157	To expand the example above to typical perl error messages ("XXX at
158	FILENAME line YYY."), you need a slightly more elaborate solution:
159
160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163	The first line tells the selection code to treat the unchanging part of
164	every error message as a selection pattern, and the second line transforms
165	the message into vi commands to load the file.
166
167	=item readline
168
169	A support package that tries to make editing with readline easier. At the
170	moment, it reacts to clicking with the left mouse button by trying to
171	move the text cursor to this position. It does so by generating as many
172	cursor-left or cursor-right keypresses as required (the this only works
173	for programs that correctly support wide characters).
174
175	It only works when clicking into the same line (possibly extended over
176	multiple rows) as the text cursor and on the primary screen, to reduce the
177	risk of misinterpreting. The normal selection isn't disabled, so quick
178	successive clicks might interfere with selection creation in harmless
179	ways.
180
181	=item tabbed
182
183	This transforms the terminal into a tabbar with additional terminals, that
184	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
185	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
186	button per tab.
187
188	Clicking a button will activate that tab. Pressing B<Shift-Left> and
189	B<Shift-Right> will switch to the tab left or right of the current one,
190	while B<Shift-Down> creates a new tab.
191
192	=item mark-urls
193
194	Uses per-line display filtering (C<on_line_update>) to underline urls and
195	make them clickable. When middle-clicked, the program specified in the
196	resource C<urlLauncher> (default C<x-www-browser>) will be started with
197	the URL as first argument.
198
199	=item automove-background
200
201	This is basically a one-line extension that dynamically changes the background pixmap offset
202	to the window position, in effect creating the same effect as pseudo transparency with
203	a custom pixmap. No scaling is supported in this mode. Exmaple:
204
205	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
206
207	=item block-graphics-to-ascii
208
209	A not very useful example of filtering all text output to the terminal,
210	by replacing all line-drawing characters (U+2500 .. U+259F) by a
211	similar-looking ascii character.
212
213	=item digital-clock
214
215	Displays a digital clock using the built-in overlay.
216
217	=item example-refresh-hooks
218
219	Displays a very simple digital clock in the upper right corner of the
220	window. Illustrates overwriting the refresh callbacks to create your own
221	overlays or changes.
222
223	=item selection-pastebin
224
225	This is a little rarely useful extension that Uploads the selection as
226	textfile to a remote site (or does other things). (The implementation is
227	not currently secure for use in a multiuser environment as it writes to
228	F</tmp> directly.).
229
230	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
231	i.e.
232
233	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
234
235	Pressing this combination runs a command with C<%> replaced by the name of
236	the textfile. This command can be set via a resource:
237
238	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
239
240	And the default is likely not useful to anybody but the few people around
241	here :)
242
243	The name of the textfile is the hex encoded md5 sum of the selection, so
244	the same content should lead to the same filename.
245
246	After a successful upload the selection will be replaced by the text given
247	in the C<selection-pastebin-url> resource (again, the % is the placeholder
248	for the filename):
249
250	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
251
252	=back
253		50
254	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
255		52
256	=head2 General API Considerations	53	=head2 General API Considerations
257		54
…		…
271		68
272	=over 4	69	=over 4
273		70
274	=item $text	71	=item $text
275		72
276	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
277	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.
278		75
279	=item $string	76	=item $string
280		77
281	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
…		…
285	=item $octets	82	=item $octets
286		83
287	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
288	locale-specific way.	85	locale-specific way.
289		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
290	=back	93	=back
291		94
292	=head2 Extension Objects	95	=head2 Extension Objects
293		96
294	Very 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
295	for each terminal and each extension and passed as the first parameter to	98	for each terminal, and each terminal has its own set of extension objects,
296	hooks. So extensions can use their C<$self> object without having to think	99	which are passed as the first parameter to hooks. So extensions can use
297	about other extensions, with the exception of methods and members that	100	their C<$self> object without having to think about clashes with other
		101	extensions or other terminals, with the exception of methods and members
298	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
299	use.	103	internal use.
300		104
301	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
302	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
303		107
304	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
305		109	the C<urxvt::extension> section below.
306	=over 4
307
308	=item $urxvt_term = $self->{term}
309
310	Returns the C<urxvt::term> object associated with this instance of the
311	extension. This member I<must not> be changed in any way.
312
313	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
314
315	Dynamically enable the given hooks (named without the C<on_> prefix) for
316	this extension, replacing any previous hook. This is useful when you want
317	to overwrite time-critical hooks only temporarily.
318
319	=item $self->disable ($hook_name[, $hook_name..])
320
321	Dynamically disable the given hooks.
322
323	=back
324		110
325	=head2 Hooks	111	=head2 Hooks
326		112
327	The following subroutines can be declared in extension files, and will be	113	The following subroutines can be declared in extension files, and will be
328	called whenever the relevant event happens.	114	called whenever the relevant event happens.
329		115
330	The first argument passed to them is an extension oject as described in	116	The first argument passed to them is an extension object as described in
331	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
332		118
333	B<All> of these hooks must return a boolean value. If any of the called	119	B<All> of these hooks must return a boolean value. If any of the called
334	hooks returns true, then the event counts as being I<consumed>, and the	120	hooks returns true, then the event counts as being I<consumed>, and the
335	relevant action might not be carried out by the C++ code.	121	relevant action might not be carried out by the C++ code.
…		…
348	place.	134	place.
349		135
350	=item on_start $term	136	=item on_start $term
351		137
352	Called at the very end of initialisation of a new terminal, just before	138	Called at the very end of initialisation of a new terminal, just before
353	trying to map (display) the toplevel and returning to the mainloop.	139	trying to map (display) the toplevel and returning to the main loop.
354		140
355	=item on_destroy $term	141	=item on_destroy $term
356		142
357	Called whenever something tries to destroy terminal, before doing anything	143	Called whenever something tries to destroy terminal, when the terminal is
358	yet. If this hook returns true, then destruction is skipped, but this is	144	still fully functional (not for long, though).
359	rarely a good idea.
360		145
361	=item on_reset $term	146	=item on_reset $term
362		147
363	Called after the screen is "reset" for any reason, such as resizing or	148	Called after the screen is "reset" for any reason, such as resizing or
364	control sequences. Here is where you can react on changes to size-related	149	control sequences. Here is where you can react on changes to size-related
…		…
386		171
387	Called whenever a selection has been copied, but before the selection is	172	Called whenever a selection has been copied, but before the selection is
388	requested from the server. The selection text can be queried and changed	173	requested from the server. The selection text can be queried and changed
389	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
390		175
391	Returning a true value aborts selection grabbing. It will still be hilighted.	176	Returning a true value aborts selection grabbing. It will still be highlighted.
392		177
393	=item on_sel_extend $term	178	=item on_sel_extend $term
394		179
395	Called whenever the user tries to extend the selection (e.g. with a double	180	Called whenever the user tries to extend the selection (e.g. with a double
396	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
397	should extend the selection itelf and return true to suppress the built-in	182	should extend the selection itself and return true to suppress the built-in
398	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
399	returns true, it will be called on every further click by the user and is	184	returns true, it will be called on every further click by the user and is
400	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
401		186
402	See the F<selection> example extension.	187	See the F<selection> example extension.
403		188
404	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
405		190
406	Called whenever the view offset changes, i..e the user or program	191	Called whenever the view offset changes, i.e. the user or program
407	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
408	show this many lines of scrollback.	193	show this many lines of scrollback.
409		194
410	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
411		196
…		…
415		200
416	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
417	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
418	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
419		204
420	=item on_osc_seq $term, $string	205	=item on_osc_seq $term, $op, $args, $resp
		206
		207	Called on every OSC sequence and can be used to suppress it or modify its
		208	behaviour. The default should be to return an empty list. A true value
		209	suppresses execution of the request completely. Make sure you don't get
		210	confused by recursive invocations when you output an OSC sequence within
		211	this callback.
		212
		213	C<on_osc_seq_perl> should be used for new behaviour.
		214
		215	=item on_osc_seq_perl $term, $args, $resp
421		216
422	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
423	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
424	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
425	string should start with the extension name and a colon, to distinguish	220	string should start with the extension name (sans -osc) and a semicolon,
426	it from commands for other extensions, and this might be enforced in the	221	to distinguish it from commands for other extensions, and this might be
427	future.	222	enforced in the future.
		223
		224	For example, C<overlay-osc> uses this:
		225
		226	sub on_osc_seq_perl {
		227	my ($self, $osc, $resp) = @_;
		228
		229	return unless $osc =~ s/^overlay;//;
		230
		231	... process remaining $osc string
		232	}
428		233
429	Be careful not ever to trust (in a security sense) the data you receive,	234	Be careful not ever to trust (in a security sense) the data you receive,
430	as its source can not easily be controleld (e-mail content, messages from	235	as its source can not easily be controlled (e-mail content, messages from
431	other users on the same system etc.).	236	other users on the same system etc.).
		237
		238	For responses, C<$resp> contains the end-of-args separator used by the
		239	sender.
432		240
433	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
434		242
435	Called whenever text is about to be output, with the text as argument. You	243	Called whenever text is about to be output, with the text as argument. You
436	can filter/change and output the text yourself by returning a true value	244	can filter/change and output the text yourself by returning a true value
…		…
441	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
442		250
443	Called whenever some data is written to the tty/pty and can be used to	251	Called whenever some data is written to the tty/pty and can be used to
444	suppress or filter tty input.	252	suppress or filter tty input.
445		253
		254	=item on_tt_paste $term, $octets
		255
		256	Called whenever text is about to be pasted, with the text as argument. You
		257	can filter/change and paste the text yourself by returning a true value
		258	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		259	locale-encoded.
		260
446	=item on_line_update $term, $row	261	=item on_line_update $term, $row
447		262
448	Called whenever a line was updated or changed. Can be used to filter	263	Called whenever a line was updated or changed. Can be used to filter
449	screen output (e.g. underline urls or other useless stuff). Only lines	264	screen output (e.g. underline urls or other useless stuff). Only lines
450	that are being shown will be filtered, and, due to performance reasons,	265	that are being shown will be filtered, and, due to performance reasons,
…		…
457	later with the already-modified line (e.g. if unrelated parts change), so	272	later with the already-modified line (e.g. if unrelated parts change), so
458	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
459		274
460	=item on_refresh_begin $term	275	=item on_refresh_begin $term
461		276
462	Called just before the screen gets redrawn. Can be used for overlay	277	Called just before the screen gets redrawn. Can be used for overlay or
463	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
464	restoring them in refresh_end. The built-in overlay and selection display	279	restoring them in refresh_end. The built-in overlay and selection display
465	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
466		281
467	=item on_refresh_end $term	282	=item on_refresh_end $term
468		283
469	Called just after the screen gets redrawn. See C<on_refresh_begin>.	284	Called just after the screen gets redrawn. See C<on_refresh_begin>.
470		285
471	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string
472		287
473	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
474	C<perl:string> action bound to it (see description of the B<keysym>	289	a C<perl:string> action bound to a key, see description of the B<keysym>
475	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the @@RXVT_NAME@@(1) manpage).
		291
		292	The event is simply the action string. This interface is assumed to change
		293	slightly in the future.
		294
		295	=item on_register_command $term, $keysym, $modifiermask, $string
		296
		297	Called after parsing a keysym resource but before registering the
		298	associated binding. If this hook returns TRUE the binding is not
		299	registered. It can be used to modify a binding by calling
		300	C<register_command>.
		301
		302	=item on_resize_all_windows $term, $new_width, $new_height
		303
		304	Called just after the new window size has been calculated, but before
		305	windows are actually being resized or hints are being set. If this hook
		306	returns TRUE, setting of the window hints is being skipped.
476		307
477	=item on_x_event $term, $event	308	=item on_x_event $term, $event
478		309
479	Called on every X event received on the vt window (and possibly other	310	Called on every X event received on the vt window (and possibly other
480	windows). Should only be used as a last resort. Most event structure	311	windows). Should only be used as a last resort. Most event structure
481	members are not passed.	312	members are not passed.
482		313
		314	=item on_root_event $term, $event
		315
		316	Like C<on_x_event>, but is called for events on the root window.
		317
483	=item on_focus_in $term	318	=item on_focus_in $term
484		319
485	Called whenever the window gets the keyboard focus, before rxvt-unicode	320	Called whenever the window gets the keyboard focus, before rxvt-unicode
486	does focus in processing.	321	does focus in processing.
487		322
488	=item on_focus_out $term	323	=item on_focus_out $term
489		324
490	Called wheneever the window loses keyboard focus, before rxvt-unicode does	325	Called whenever the window loses keyboard focus, before rxvt-unicode does
491	focus out processing.	326	focus out processing.
492		327
493	=item on_configure_notify $term, $event	328	=item on_configure_notify $term, $event
494		329
495	=item on_property_notify $term, $event	330	=item on_property_notify $term, $event
…		…
506		341
507	=item on_map_notify $term, $event	342	=item on_map_notify $term, $event
508		343
509	=item on_unmap_notify $term, $event	344	=item on_unmap_notify $term, $event
510		345
511	Called whenever the corresponding X event is received for the terminal If	346	Called whenever the corresponding X event is received for the terminal. If
512	the hook returns true, then the even will be ignored by rxvt-unicode.	347	the hook returns true, then the event will be ignored by rxvt-unicode.
513		348
514	The event is a hash with most values as named by Xlib (see the XEvent	349	The event is a hash with most values as named by Xlib (see the XEvent
515	manpage), with the additional members C<row> and C<col>, which are the	350	manpage), with the additional members C<row> and C<col>, which are the
516	(real, not screen-based) row and column under the mouse cursor.	351	(real, not screen-based) row and column under the mouse cursor.
517		352
…		…
527	=item on_wm_delete_window $term, $event	362	=item on_wm_delete_window $term, $event
528		363
529	Called when various types of ClientMessage events are received (all with	364	Called when various types of ClientMessage events are received (all with
530	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	365	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
531		366
		367	=item on_bell $term
		368
		369	Called on receipt of a bell character.
		370
532	=back	371	=back
533		372
534	=cut	373	=cut
535		374
536	package urxvt;	375	package urxvt;
537		376
538	use utf8;	377	use utf8;
539	use strict;	378	use strict 'vars';
540	use Carp ();	379	use Carp ();
541	use Scalar::Util ();	380	use Scalar::Util ();
542	use List::Util ();	381	use List::Util ();
543		382
544	our $VERSION = 1;	383	our $VERSION = 1;
545	our $TERM;	384	our $TERM;
546	our @TERM_INIT;	385	our @TERM_INIT; # should go, prevents async I/O etc.
547	our @TERM_EXT;	386	our @TERM_EXT; # should go, prevents async I/O etc.
548	our @HOOKNAME;	387	our @HOOKNAME;
549	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	388	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
550	our %OPTION;	389	our %OPTION;
551		390
552	our $LIBDIR;	391	our $LIBDIR;
553	our $RESNAME;	392	our $RESNAME;
554	our $RESCLASS;	393	our $RESCLASS;
555	our $RXVTNAME;	394	our $RXVTNAME;
556		395
557	our $NOCHAR = chr 0xfffe;	396	our $NOCHAR = chr 0xffff;
558		397
559	=head2 Variables in the C<urxvt> Package	398	=head2 Variables in the C<urxvt> Package
560		399
561	=over 4	400	=over 4
562		401
…		…
578	The current terminal. This variable stores the current C<urxvt::term>	417	The current terminal. This variable stores the current C<urxvt::term>
579	object, whenever a callback/hook is executing.	418	object, whenever a callback/hook is executing.
580		419
581	=item @urxvt::TERM_INIT	420	=item @urxvt::TERM_INIT
582		421
583	All coderefs in this array will be called as methods of the next newly	422	All code references in this array will be called as methods of the next newly
584	created C<urxvt::term> object (during the C<on_init> phase). The array	423	created C<urxvt::term> object (during the C<on_init> phase). The array
585	gets cleared before the codereferences that were in it are being executed,	424	gets cleared before the code references that were in it are being executed,
586	so coderefs can push themselves onto it again if they so desire.	425	so references can push themselves onto it again if they so desire.
587		426
588	This complements to the perl-eval commandline option, but gets executed	427	This complements to the perl-eval command line option, but gets executed
589	first.	428	first.
590		429
591	=item @urxvt::TERM_EXT	430	=item @urxvt::TERM_EXT
592		431
593	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	432	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
600		439
601	=over 4	440	=over 4
602		441
603	=item urxvt::fatal $errormessage	442	=item urxvt::fatal $errormessage
604		443
605	Fatally aborts execution with the given error message. Avoid at all	444	Fatally aborts execution with the given error message (which should
606	costs! The only time this is acceptable is when the terminal process	445	include a trailing newline). Avoid at all costs! The only time this
607	starts up.	446	is acceptable (and useful) is in the init hook, where it prevents the
		447	terminal from starting up.
608		448
609	=item urxvt::warn $string	449	=item urxvt::warn $string
610		450
611	Calls C<rxvt_warn> with the given string which should not include a	451	Calls C<rxvt_warn> with the given string which should include a trailing
612	newline. The module also overwrites the C<warn> builtin with a function	452	newline. The module also overwrites the C<warn> builtin with a function
613	that calls this function.	453	that calls this function.
614		454
615	Using this function has the advantage that its output ends up in the	455	Using this function has the advantage that its output ends up in the
616	correct place, e.g. on stderr of the connecting urxvtc client.	456	correct place, e.g. on stderr of the connecting urxvtc client.
617		457
618	Messages have a size limit of 1023 bytes currently.	458	Messages have a size limit of 1023 bytes currently.
		459
		460	=item @terms = urxvt::termlist
		461
		462	Returns all urxvt::term objects that exist in this process, regardless of
		463	whether they are started, being destroyed etc., so be careful. Only term
		464	objects that have perl extensions attached will be returned (because there
		465	is no urxvt::term object associated with others).
619		466
620	=item $time = urxvt::NOW	467	=item $time = urxvt::NOW
621		468
622	Returns the "current time" (as per the event loop).	469	Returns the "current time" (as per the event loop).
623		470
…		…
666		513
667	=item $rend = urxvt::OVERLAY_RSTYLE	514	=item $rend = urxvt::OVERLAY_RSTYLE
668		515
669	Return the rendition mask used for overlays by default.	516	Return the rendition mask used for overlays by default.
670		517
671	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	518	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		519	urxvt::RS_RVid, urxvt::RS_Uline
672		520
673	Return the bit that enabled bold, italic, blink, reverse-video and	521	Return the bit that enabled bold, italic, blink, reverse-video and
674	underline, respectively. To enable such a style, just logically OR it into	522	underline, respectively. To enable such a style, just logically OR it into
675	the bitset.	523	the bitset.
676		524
…		…
681	Return the foreground/background colour index, respectively.	529	Return the foreground/background colour index, respectively.
682		530
683	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	531	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
684		532
685	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	533	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		534
		535	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
686		536
687	Replace the foreground/background colour in the rendition mask with the	537	Replace the foreground/background colour in the rendition mask with the
688	specified one.	538	specified one.
689		539
690	=item $value = urxvt::GET_CUSTOM $rend	540	=item $value = urxvt::GET_CUSTOM $rend
…		…
709	unless $msg =~ /\n$/;	559	unless $msg =~ /\n$/;
710	urxvt::warn ($msg);	560	urxvt::warn ($msg);
711	};	561	};
712	}	562	}
713		563
		564	no warnings 'utf8';
		565
		566	sub parse_resource {
		567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		568
		569	$name =~ y/-/./ if $isarg;
		570
		571	$term->scan_meta;
		572
		573	my $r = $term->{meta}{resource};
		574	keys %$r; # reste iterator
		575	while (my ($pattern, $v) = each %$r) {
		576	if (
		577	$pattern =~ /\.$/
		578	? $pattern eq substr $name, 0, length $pattern
		579	: $pattern eq $name
		580	) {
		581	$name = "$urxvt::RESCLASS.$name";
		582
		583	push @{ $term->{perl_ext_3} }, $v->[0];
		584
		585	if ($v->[1] eq "boolean") {
		586	$term->put_option_db ($name, $flag ? "true" : "false");
		587	return 1;
		588	} else {
		589	$term->put_option_db ($name, $value);
		590	return 1 + 2;
		591	}
		592	}
		593	}
		594
		595	0
		596	}
		597
		598	sub usage {
		599	my ($term, $usage_type) = @_;
		600
		601	$term->scan_meta;
		602
		603	my $r = $term->{meta}{resource};
		604
		605	for my $pattern (sort keys %$r) {
		606	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		607
		608	$desc .= " (-pe $ext)";
		609
		610	if ($usage_type == 1) {
		611	$pattern =~ y/./-/;
		612	$pattern =~ s/-$/-.../g;
		613
		614	if ($type eq "boolean") {
		615	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		616	} else {
		617	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		618	}
		619	} else {
		620	$pattern =~ s/\.$/.*/g;
		621	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		622	}
		623	}
		624	}
		625
714	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
715		627
716	sub verbose {	628	sub verbose {
717	my ($level, $msg) = @_;	629	my ($level, $msg) = @_;
718	warn "$msg\n" if $level <= $verbosity;	630	warn "$msg\n" if $level <= $verbosity;
…		…
730	$pkg =~ s/[^[:word:]]/_/g;	642	$pkg =~ s/[^[:word:]]/_/g;
731	$pkg = "urxvt::ext::$pkg";	643	$pkg = "urxvt::ext::$pkg";
732		644
733	verbose 3, "loading extension '$path' into package '$pkg'";	645	verbose 3, "loading extension '$path' into package '$pkg'";
734		646
		647	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		648
735	open my $fh, "<:raw", $path	649	open my $fh, "<:raw", $path
736	or die "$path: $!";	650	or die "$path: $!";
737		651
738	my $source =	652	my $source =
739	"package $pkg; use strict; use utf8;\n"	653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
740	. "#line 1 \"$path\"\n{\n"	654	. "#line 1 \"$path\"\n{\n"
741	. (do { local $/; <$fh> })	655	. (do { local $/; <$fh> })
742	. "\n};\n1";	656	. "\n};\n1";
743		657
744	eval $source	658	eval $source
…		…
754	sub invoke {	668	sub invoke {
755	local $TERM = shift;	669	local $TERM = shift;
756	my $htype = shift;	670	my $htype = shift;
757		671
758	if ($htype == 0) { # INIT	672	if ($htype == 0) { # INIT
759	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	673	my @dirs = $TERM->perl_libdirs;
760		674
761	my %ext_arg;	675	my %ext_arg;
762		676
763	{	677	{
764	my @init = @TERM_INIT;	678	my @init = @TERM_INIT;
765	@TERM_INIT = ();	679	@TERM_INIT = ();
…		…
767	my @pkg = @TERM_EXT;	681	my @pkg = @TERM_EXT;
768	@TERM_EXT = ();	682	@TERM_EXT = ();
769	$TERM->register_package ($_) for @pkg;	683	$TERM->register_package ($_) for @pkg;
770	}	684	}
771		685
		686	for (
		687	@{ delete $TERM->{perl_ext_3} },
772	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		689	) {
773	if ($_ eq "default") {	690	if ($_ eq "default") {
774	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	691	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
775	} elsif (/^-(.*)$/) {	692	} elsif (/^-(.*)$/) {
776	delete $ext_arg{$1};	693	delete $ext_arg{$1};
777	} elsif (/^([^<]+)<(.*)>$/) {	694	} elsif (/^([^<]+)<(.*)>$/) {
778	push @{ $ext_arg{$1} }, $2;	695	push @{ $ext_arg{$1} }, $2;
779	} else {	696	} else {
780	$ext_arg{$_} ||= [];	697	$ext_arg{$_} ||= [];
781	}	698	}
782	}	699	}
783		700
784	while (my ($ext, $argv) = each %ext_arg) {	701	for my $ext (sort keys %ext_arg) {
785	my @files = grep -f $_, map "$_/$ext", @dirs;	702	my @files = grep -f $_, map "$_/$ext", @dirs;
786		703
787	if (@files) {	704	if (@files) {
788	$TERM->register_package (extension_package $files[0], $argv);	705	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
789	} else {	706	} else {
790	warn "perl extension '$ext' not found in perl library search path\n";	707	warn "perl extension '$ext' not found in perl library search path\n";
791	}	708	}
792	}	709	}
793		710
…		…
799		716
800	if (my $cb = $TERM->{_hook}[$htype]) {	717	if (my $cb = $TERM->{_hook}[$htype]) {
801	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
802	if $verbosity >= 10;	719	if $verbosity >= 10;
803		720
804	keys %$cb;	721	for my $pkg (keys %$cb) {
805
806	while (my ($pkg, $cb) = each %$cb) {
807	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
808	$retval ||= $retval_;	723	$retval ||= $retval_;
809		724
810	if ($@) {	725	if ($@) {
811	$TERM->ungrab; # better to lose the grab than the session	726	$TERM->ungrab; # better to lose the grab than the session
812	warn $@;	727	warn $@;
…		…
826	}	741	}
827		742
828	$retval	743	$retval
829	}	744	}
830		745
831	# urxvt::term::extension	746	sub SET_COLOR($$$) {
		747	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		748	}
		749
		750	sub rend2mask {
		751	no strict 'refs';
		752	my ($str, $mask) = (@_, 0);
		753	my %color = ( fg => undef, bg => undef );
		754	my @failed;
		755	for my $spec ( split /\s+/, $str ) {
		756	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		757	$color{lc($1)} = $2;
		758	} else {
		759	my $neg = $spec =~ s/^[-^]//;
		760	unless ( exists &{"RS_$spec"} ) {
		761	push @failed, $spec;
		762	next;
		763	}
		764	my $cur = &{"RS_$spec"};
		765	if ( $neg ) {
		766	$mask &= ~$cur;
		767	} else {
		768	$mask |= $cur;
		769	}
		770	}
		771	}
		772	($mask, @color{qw(fg bg)}, \@failed)
		773	}
832		774
833	package urxvt::term::extension;	775	package urxvt::term::extension;
834		776
835	sub enable {	777	=head2 The C<urxvt::term::extension> class
836	my ($self, %hook) = @_;
837	my $pkg = $self->{_pkg};
838		778
839	while (my ($name, $cb) = each %hook) {	779	Each extension attached to a terminal object is represented by
840	my $htype = $HOOKTYPE{uc $name};	780	a C<urxvt::term::extension> object.
841	defined $htype
842	or Carp::croak "unsupported hook type '$name'";
843		781
844	$self->set_should_invoke ($htype, +1)	782	You can use these objects, which are passed to all callbacks to store any
845	unless exists $self->{term}{_hook}[$htype]{$pkg};	783	state related to the terminal and extension instance.
846		784
847	$self->{term}{_hook}[$htype]{$pkg} = $cb;	785	The methods (And data members) documented below can be called on extension
848	}	786	objects, in addition to call methods documented for the <urxvt::term>
849	}	787	class.
850		788
851	sub disable {	789	=over 4
852	my ($self, @hook) = @_;
853	my $pkg = $self->{_pkg};
854		790
855	for my $name (@hook) {	791	=item $urxvt_term = $self->{term}
856	my $htype = $HOOKTYPE{uc $name};
857	defined $htype
858	or Carp::croak "unsupported hook type '$name'";
859		792
860	$self->set_should_invoke ($htype, -1)	793	Returns the C<urxvt::term> object associated with this instance of the
861	if delete $self->{term}{_hook}[$htype]{$pkg};	794	extension. This member I<must not> be changed in any way.
862	}	795
863	}	796	=cut
864		797
865	our $AUTOLOAD;	798	our $AUTOLOAD;
866		799
867	sub AUTOLOAD {	800	sub AUTOLOAD {
868	$AUTOLOAD =~ /:([^:]+)$/	801	$AUTOLOAD =~ /:([^:]+)$/
…		…
881		814
882	sub DESTROY {	815	sub DESTROY {
883	# nop	816	# nop
884	}	817	}
885		818
886	# urxvt::destroy_hook	819	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
887		820
888	sub urxvt::destroy_hook::DESTROY {	821	sub urxvt::destroy_hook::DESTROY {
889	${$_[0]}->();	822	${$_[0]}->();
890	}	823	}
891		824
892	sub urxvt::destroy_hook(&) {	825	sub urxvt::destroy_hook(&) {
893	bless \shift, urxvt::destroy_hook::	826	bless \shift, urxvt::destroy_hook::
894	}	827	}
		828
		829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		830
		831	Dynamically enable the given hooks (named without the C<on_> prefix) for
		832	this extension, replacing any previous hook. This is useful when you want
		833	to overwrite time-critical hooks only temporarily.
		834
		835	To install additional callbacks for the same hook, you can use the C<on>
		836	method of the C<urxvt::term> class.
		837
		838	=item $self->disable ($hook_name[, $hook_name..])
		839
		840	Dynamically disable the given hooks.
		841
		842	=cut
		843
		844	sub enable {
		845	my ($self, %hook) = @_;
		846	my $pkg = $self->{_pkg};
		847
		848	while (my ($name, $cb) = each %hook) {
		849	my $htype = $HOOKTYPE{uc $name};
		850	defined $htype
		851	or Carp::croak "unsupported hook type '$name'";
		852
		853	$self->set_should_invoke ($htype, +1)
		854	unless exists $self->{term}{_hook}[$htype]{$pkg};
		855
		856	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		857	}
		858	}
		859
		860	sub disable {
		861	my ($self, @hook) = @_;
		862	my $pkg = $self->{_pkg};
		863
		864	for my $name (@hook) {
		865	my $htype = $HOOKTYPE{uc $name};
		866	defined $htype
		867	or Carp::croak "unsupported hook type '$name'";
		868
		869	$self->set_should_invoke ($htype, -1)
		870	if delete $self->{term}{_hook}[$htype]{$pkg};
		871	}
		872	}
		873
		874	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		875
		876	Similar to the C<enable> enable, but installs additional callbacks for
		877	the given hook(s) (that is, it doesn't replace existing callbacks), and
		878	returns a guard object. When the guard object is destroyed the callbacks
		879	are disabled again.
		880
		881	=cut
		882
		883	sub urxvt::extension::on_disable::DESTROY {
		884	my $disable = shift;
		885
		886	my $term = delete $disable->{""};
		887
		888	while (my ($htype, $id) = each %$disable) {
		889	delete $term->{_hook}[$htype]{$id};
		890	$term->set_should_invoke ($htype, -1);
		891	}
		892	}
		893
		894	sub on {
		895	my ($self, %hook) = @_;
		896
		897	my $term = $self->{term};
		898
		899	my %disable = ( "" => $term );
		900
		901	while (my ($name, $cb) = each %hook) {
		902	my $htype = $HOOKTYPE{uc $name};
		903	defined $htype
		904	or Carp::croak "unsupported hook type '$name'";
		905
		906	$term->set_should_invoke ($htype, +1);
		907	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		908	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		909	}
		910
		911	bless \%disable, "urxvt::extension::on_disable"
		912	}
		913
		914	=item $self->x_resource ($pattern)
		915
		916	=item $self->x_resource_boolean ($pattern)
		917
		918	These methods support an additional C<%> prefix when called on an
		919	extension object - see the description of these methods in the
		920	C<urxvt::term> class for details.
		921
		922	=cut
		923
		924	sub x_resource {
		925	my ($self, $name) = @_;
		926	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		927	$self->{term}->x_resource ($name)
		928	}
		929
		930	sub x_resource_boolean {
		931	my ($self, $name) = @_;
		932	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		933	$self->{term}->x_resource_boolean ($name)
		934	}
		935
		936	=back
		937
		938	=cut
895		939
896	package urxvt::anyevent;	940	package urxvt::anyevent;
897		941
898	=head2 The C<urxvt::anyevent> Class	942	=head2 The C<urxvt::anyevent> Class
899		943
900	The sole purpose of this class is to deliver an interface to the	944	The sole purpose of this class is to deliver an interface to the
901	C<AnyEvent> module - any module using it will work inside urxvt without	945	C<AnyEvent> module - any module using it will work inside urxvt without
902	further programming. The only exception is that you cannot wait on	946	further programming. The only exception is that you cannot wait on
903	condition variables, but non-blocking condvar use is ok. What this means	947	condition variables, but non-blocking condvar use is ok.
904	is that you cannot use blocking APIs, but the non-blocking variant should
905	work.
906		948
907	=cut	949	In practical terms this means is that you cannot use blocking APIs, but
		950	the non-blocking variant should work.
908		951
		952	=cut
		953
909	our $VERSION = 1;	954	our $VERSION = '5.23';
910		955
911	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	956	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
912	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	957	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
913		958
914	sub timer {	959	sub timer {
…		…
916		961
917	my $cb = $arg{cb};	962	my $cb = $arg{cb};
918		963
919	urxvt::timer	964	urxvt::timer
920	->new	965	->new
921	->start (urxvt::NOW + $arg{after})	966	->after ($arg{after}, $arg{interval})
922	->cb (sub {	967	->cb ($arg{interval} ? $cb : sub {
923	$_[0]->stop; # need to cancel manually	968	$_[0]->stop; # need to cancel manually
924	$cb->();	969	$cb->();
925	})	970	})
926	}	971	}
927		972
928	sub io {	973	sub io {
929	my ($class, %arg) = @_;	974	my ($class, %arg) = @_;
930		975
931	my $cb = $arg{cb};	976	my $cb = $arg{cb};
		977	my $fd = fileno $arg{fh};
		978	defined $fd or $fd = $arg{fh};
932		979
933	bless [$arg{fh}, urxvt::iow	980	bless [$arg{fh}, urxvt::iow
934	->new	981	->new
935	->fd (fileno $arg{fh})	982	->fd ($fd)
936	->events (($arg{poll} =~ /r/ ? 1 : 0)	983	->events (($arg{poll} =~ /r/ ? 1 : 0)
937	| ($arg{poll} =~ /w/ ? 2 : 0))	984	| ($arg{poll} =~ /w/ ? 2 : 0))
938	->start	985	->start
939	->cb (sub {	986	->cb ($cb)
940	$cb->(($_[1] & 1 ? 'r' : '')
941	. ($_[1] & 2 ? 'w' : ''));
942	})],
943	urxvt::anyevent::	987	], urxvt::anyevent::
		988	}
		989
		990	sub idle {
		991	my ($class, %arg) = @_;
		992
		993	my $cb = $arg{cb};
		994
		995	urxvt::iw
		996	->new
		997	->start
		998	->cb ($cb)
		999	}
		1000
		1001	sub child {
		1002	my ($class, %arg) = @_;
		1003
		1004	my $cb = $arg{cb};
		1005
		1006	urxvt::pw
		1007	->new
		1008	->start ($arg{pid})
		1009	->cb (sub {
		1010	$_[0]->stop; # need to cancel manually
		1011	$cb->($_[0]->rpid, $_[0]->rstatus);
		1012	})
944	}	1013	}
945		1014
946	sub DESTROY {	1015	sub DESTROY {
947	$_[0][1]->stop;	1016	$_[0][1]->stop;
948	}	1017	}
949		1018
950	sub condvar {	1019	# only needed for AnyEvent < 6 compatibility
951	bless \my $flag, urxvt::anyevent::condvar::	1020	sub one_event {
952	}
953
954	sub urxvt::anyevent::condvar::broadcast {
955	${$_[0]}++;
956	}
957
958	sub urxvt::anyevent::condvar::wait {
959	unless (${$_[0]}) {
960	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1021	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
961	}
962	}	1022	}
963		1023
964	package urxvt::term;	1024	package urxvt::term;
965		1025
966	=head2 The C<urxvt::term> Class	1026	=head2 The C<urxvt::term> Class
…		…
979	urxvt::verbose 6, "register package $pkg to $self";	1039	urxvt::verbose 6, "register package $pkg to $self";
980		1040
981	@{"$pkg\::ISA"} = urxvt::term::extension::;	1041	@{"$pkg\::ISA"} = urxvt::term::extension::;
982		1042
983	my $proxy = bless {	1043	my $proxy = bless {
984	_pkg => $pkg,	1044	_pkg => $pkg,
		1045	_name => ${"$pkg\::_NAME"}, # hackish
985	argv => $argv,	1046	argv => $argv,
986	}, $pkg;	1047	}, $pkg;
987	Scalar::Util::weaken ($proxy->{term} = $self);	1048	Scalar::Util::weaken ($proxy->{term} = $self);
988		1049
989	$self->{_pkg}{$pkg} = $proxy;	1050	$self->{_pkg}{$pkg} = $proxy;
990		1051
…		…
993	$proxy->enable ($name => $ref);	1054	$proxy->enable ($name => $ref);
994	}	1055	}
995	}	1056	}
996	}	1057	}
997		1058
		1059	sub perl_libdirs {
		1060	map { split /:/ }
		1061	$_[0]->resource ("perl_lib"),
		1062	$ENV{URXVT_PERL_LIB},
		1063	"$ENV{HOME}/.urxvt/ext",
		1064	"$LIBDIR/perl"
		1065	}
		1066
		1067	sub scan_meta {
		1068	my ($self) = @_;
		1069	my @libdirs = perl_libdirs $self;
		1070
		1071	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1072
		1073	my %meta;
		1074
		1075	$self->{meta_libdirs} = join "\x00", @libdirs;
		1076	$self->{meta} = \%meta;
		1077
		1078	for my $dir (reverse @libdirs) {
		1079	opendir my $fh, $dir
		1080	or next;
		1081	for my $ext (readdir $fh) {
		1082	$ext ne "."
		1083	and $ext ne ".."
		1084	and open my $fh, "<", "$dir/$ext"
		1085	or next;
		1086
		1087	while (<$fh>) {
		1088	if (/^#:META:X_RESOURCE:(.*)/) {
		1089	my ($pattern, $type, $desc) = split /:/, $1;
		1090	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1091	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1092	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1093	} else {
		1094	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1095	}
		1096	} elsif (/^\s*(?:#|$)/) {
		1097	# skip other comments and empty lines
		1098	} else {
		1099	last; # stop parsing on first non-empty non-comment line
		1100	}
		1101	}
		1102	}
		1103	}
		1104	}
		1105
998	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1106	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
999		1107
1000	Creates a new terminal, very similar as if you had started it with system	1108	Creates a new terminal, very similar as if you had started it with system
1001	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1109	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1002	hash which defines the environment of the new terminal.	1110	hash which defines the environment of the new terminal.
1003		1111
1004	Croaks (and probably outputs an error message) if the new instance	1112	Croaks (and probably outputs an error message) if the new instance
1005	couldn't be created. Returns C<undef> if the new instance didn't	1113	couldn't be created. Returns C<undef> if the new instance didn't
1006	initialise perl, and the terminal object otherwise. The C<init> and	1114	initialise perl, and the terminal object otherwise. The C<init> and
1007	C<start> hooks will be called during this call.	1115	C<start> hooks will be called before this call returns, and are free to
		1116	refer to global data (which is race free).
1008		1117
1009	=cut	1118	=cut
1010		1119
1011	sub new {	1120	sub new {
1012	my ($class, $env, @args) = @_;	1121	my ($class, $env, @args) = @_;
1013		1122
		1123	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1124	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1125
1014	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1126	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1015	}	1127	}
1016		1128
1017	=item $term->destroy	1129	=item $term->destroy
1018		1130
1019	Destroy the terminal object (close the window, free resources	1131	Destroy the terminal object (close the window, free resources
…		…
1049		1161
1050	Returns true if the option specified by C<$optval> is enabled, and	1162	Returns true if the option specified by C<$optval> is enabled, and
1051	optionally change it. All option values are stored by name in the hash	1163	optionally change it. All option values are stored by name in the hash
1052	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1164	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1053		1165
1054	Here is a a likely non-exhaustive list of option names, please see the	1166	Here is a likely non-exhaustive list of option names, please see the
1055	source file F</src/optinc.h> to see the actual list:	1167	source file F</src/optinc.h> to see the actual list:
1056		1168
1057	borderLess console cursorBlink cursorUnderline hold iconic insecure	1169	borderLess buffered console cursorBlink cursorUnderline hold iconic
1058	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1170	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1059	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1171	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1060	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1172	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1061	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1173	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1062	transparent tripleclickwords utmpInhibit visualBell	1174	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1175	urgentOnBell utmpInhibit visualBell
1063		1176
1064	=item $value = $term->resource ($name[, $newval])	1177	=item $value = $term->resource ($name[, $newval])
1065		1178
1066	Returns the current resource value associated with a given name and	1179	Returns the current resource value associated with a given name and
1067	optionally sets a new value. Setting values is most useful in the C<init>	1180	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1076	likely change).	1189	likely change).
1077		1190
1078	Please note that resource strings will currently only be freed when the	1191	Please note that resource strings will currently only be freed when the
1079	terminal is destroyed, so changing options frequently will eat memory.	1192	terminal is destroyed, so changing options frequently will eat memory.
1080		1193
1081	Here is a a likely non-exhaustive list of resource names, not all of which	1194	Here is a likely non-exhaustive list of resource names, not all of which
1082	are supported in every build, please see the source file F</src/rsinc.h>	1195	are supported in every build, please see the source file F</src/rsinc.h>
1083	to see the actual list:	1196	to see the actual list:
1084		1197
1085	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1198	answerbackstring backgroundPixmap backspace_key blurradius
1086	borderLess color cursorBlink cursorUnderline cutchars delete_key	1199	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1087	display_name embed ext_bwidth fade font geometry hold iconName	1200	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1088	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1201	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1202	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1089	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1203	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1090	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1204	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1091	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1205	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1092	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1206	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1093	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1207	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1094	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1208	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1095	secondaryScreen secondaryScroll selectstyle shade term_name title	1209	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1096	transient_for transparent transparent_all tripleclickwords utmpInhibit	1210	term_name title transient_for transparent tripleclickwords urgentOnBell
1097	visualBell	1211	utmpInhibit visualBell
1098		1212
1099	=cut	1213	=cut
1100		1214
1101	sub resource($$;$) {	1215	sub resource($$;$) {
1102	my ($self, $name) = (shift, shift);	1216	my ($self, $name) = (shift, shift);
1103	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1217	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1104	&urxvt::term::_resource	1218	goto &urxvt::term::_resource
1105	}	1219	}
1106		1220
1107	=item $value = $term->x_resource ($pattern)	1221	=item $value = $term->x_resource ($pattern)
1108		1222
1109	Returns the X-Resource for the given pattern, excluding the program or	1223	Returns the X-Resource for the given pattern, excluding the program or
1110	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1224	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1111	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1225	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1112	resource with that pattern exists.	1226	resource with that pattern exists.
1113		1227
		1228	Extensions that define extra resource or command line arguments also need
		1229	to call this method to access their values.
		1230
		1231	If the method is called on an extension object (basically, from an
		1232	extension), then the special prefix C<%.> will be replaced by the name of
		1233	the extension and a dot, and the lone string C<%> will be replaced by the
		1234	extension name itself. This makes it possible to code extensions so you
		1235	can rename them and get a new set of commandline switches and resources
		1236	without having to change the actual code.
		1237
1114	This method should only be called during the C<on_start> hook, as there is	1238	This method should only be called during the C<on_start> hook, as there is
1115	only one resource database per display, and later invocations might return	1239	only one resource database per display, and later invocations might return
1116	the wrong resources.	1240	the wrong resources.
1117		1241
1118	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1242	=item $value = $term->x_resource_boolean ($pattern)
1119		1243
		1244	Like C<x_resource>, above, but interprets the string value as a boolean
		1245	and returns C<1> for true values, C<0> for false values and C<undef> if
		1246	the resource or option isn't specified.
		1247
		1248	You should always use this method to parse boolean resources.
		1249
		1250	=cut
		1251
		1252	sub x_resource_boolean {
		1253	my $res = &x_resource;
		1254
		1255	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1256	}
		1257
		1258	=item $success = $term->parse_keysym ($key, $octets)
		1259
1120	Adds a keymap translation exactly as specified via a resource. See the	1260	Adds a key binding exactly as specified via a resource. See the
1121	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1261	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1262
		1263	=item $term->register_command ($keysym, $modifiermask, $string)
		1264
		1265	Adds a key binding. This is a lower level api compared to
		1266	C<parse_keysym>, as it expects a parsed key description, and can be
		1267	used only inside either the C<on_init> hook, to add a binding, or the
		1268	C<on_register_command> hook, to modify a parsed binding.
1122		1269
1123	=item $rend = $term->rstyle ([$new_rstyle])	1270	=item $rend = $term->rstyle ([$new_rstyle])
1124		1271
1125	Return and optionally change the current rendition. Text that is output by	1272	Return and optionally change the current rendition. Text that is output by
1126	the terminal application will use this style.	1273	the terminal application will use this style.
…		…
1134		1281
1135	=item ($row, $col) = $term->selection_beg ([$row, $col])	1282	=item ($row, $col) = $term->selection_beg ([$row, $col])
1136		1283
1137	=item ($row, $col) = $term->selection_end ([$row, $col])	1284	=item ($row, $col) = $term->selection_end ([$row, $col])
1138		1285
1139	Return the current values of the selection mark, begin or end positions,	1286	Return the current values of the selection mark, begin or end positions.
1140	and optionally set them to new values.	1287
		1288	When arguments are given, then the selection coordinates are set to
		1289	C<$row> and C<$col>, and the selection screen is set to the current
		1290	screen.
		1291
		1292	=item $screen = $term->selection_screen ([$screen])
		1293
		1294	Returns the current selection screen, and then optionally sets it.
1141		1295
1142	=item $term->selection_make ($eventtime[, $rectangular])	1296	=item $term->selection_make ($eventtime[, $rectangular])
1143		1297
1144	Tries to make a selection as set by C<selection_beg> and	1298	Tries to make a selection as set by C<selection_beg> and
1145	C<selection_end>. If C<$rectangular> is true (default: false), a	1299	C<selection_end>. If C<$rectangular> is true (default: false), a
1146	rectangular selection will be made. This is the prefered function to make	1300	rectangular selection will be made. This is the preferred function to make
1147	a selection.	1301	a selection.
1148		1302
1149	=item $success = $term->selection_grab ($eventtime)	1303	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1150		1304
1151	Try to request the primary selection text from the server (for example, as	1305	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1306	true) selection from the server. The corresponding text can be set
1152	set by the next method). No visual feedback will be given. This function	1307	with the next method. No visual feedback will be given. This function
1153	is mostly useful from within C<on_sel_grab> hooks.	1308	is mostly useful from within C<on_sel_grab> hooks.
1154		1309
1155	=item $oldtext = $term->selection ([$newtext])	1310	=item $oldtext = $term->selection ([$newtext, $clipboard])
1156		1311
1157	Return the current selection text and optionally replace it by C<$newtext>.	1312	Return the current selection (clipboard if C<$clipboard> is true) text
		1313	and optionally replace it by C<$newtext>.
		1314
		1315	=item $term->selection_clear ([$clipboard])
		1316
		1317	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1158		1318
1159	=item $term->overlay_simple ($x, $y, $text)	1319	=item $term->overlay_simple ($x, $y, $text)
1160		1320
1161	Create a simple multi-line overlay box. See the next method for details.	1321	Create a simple multi-line overlay box. See the next method for details.
1162		1322
…		…
1192		1352
1193	The methods currently supported on C<urxvt::overlay> objects are:	1353	The methods currently supported on C<urxvt::overlay> objects are:
1194		1354
1195	=over 4	1355	=over 4
1196		1356
1197	=item $overlay->set ($x, $y, $text, $rend)	1357	=item $overlay->set ($x, $y, $text[, $rend])
1198		1358
1199	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1359	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1200	text in rxvt-unicode's special encoding and an array of rendition values	1360	text in rxvt-unicode's special encoding and an array of rendition values
1201	at a specific position inside the overlay.	1361	at a specific position inside the overlay.
		1362
		1363	If C<$rend> is missing, then the rendition will not be changed.
1202		1364
1203	=item $overlay->hide	1365	=item $overlay->hide
1204		1366
1205	If visible, hide the overlay, but do not destroy it.	1367	If visible, hide the overlay, but do not destroy it.
1206		1368
…		…
1288	locale-specific encoding of the terminal and can contain command sequences	1450	locale-specific encoding of the terminal and can contain command sequences
1289	(escape codes) that will be interpreted.	1451	(escape codes) that will be interpreted.
1290		1452
1291	=item $term->tt_write ($octets)	1453	=item $term->tt_write ($octets)
1292		1454
1293	Write the octets given in C<$data> to the tty (i.e. as program input). To	1455	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1294	pass characters instead of octets, you should convert your strings first	1456	pass characters instead of octets, you should convert your strings first
1295	to the locale-specific encoding using C<< $term->locale_encode >>.	1457	to the locale-specific encoding using C<< $term->locale_encode >>.
		1458
		1459	=item $term->tt_paste ($octets)
		1460
		1461	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1462	CR and bracketing the data with control sequences if bracketed paste mode
		1463	is set.
1296		1464
1297	=item $old_events = $term->pty_ev_events ([$new_events])	1465	=item $old_events = $term->pty_ev_events ([$new_events])
1298		1466
1299	Replaces the event mask of the pty watcher by the given event mask. Can	1467	Replaces the event mask of the pty watcher by the given event mask. Can
1300	be used to suppress input and output handling to the pty/tty. See the	1468	be used to suppress input and output handling to the pty/tty. See the
1301	description of C<< urxvt::timer->events >>. Make sure to always restore	1469	description of C<< urxvt::timer->events >>. Make sure to always restore
1302	the previous value.	1470	the previous value.
1303		1471
		1472	=item $fd = $term->pty_fd
		1473
		1474	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1475	is used.
		1476
1304	=item $windowid = $term->parent	1477	=item $windowid = $term->parent
1305		1478
1306	Return the window id of the toplevel window.	1479	Return the window id of the toplevel window.
1307		1480
1308	=item $windowid = $term->vt	1481	=item $windowid = $term->vt
…		…
1314	Adds the specified events to the vt event mask. Useful e.g. when you want	1487	Adds the specified events to the vt event mask. Useful e.g. when you want
1315	to receive pointer events all the times:	1488	to receive pointer events all the times:
1316		1489
1317	$term->vt_emask_add (urxvt::PointerMotionMask);	1490	$term->vt_emask_add (urxvt::PointerMotionMask);
1318		1491
		1492	=item $term->set_urgency ($set)
		1493
		1494	Enable/disable the urgency hint on the toplevel window.
		1495
		1496	=item $term->focus_in
		1497
		1498	=item $term->focus_out
		1499
		1500	=item $term->key_press ($state, $keycode[, $time])
		1501
		1502	=item $term->key_release ($state, $keycode[, $time])
		1503
		1504	Deliver various fake events to to terminal.
		1505
1319	=item $window_width = $term->width	1506	=item $window_width = $term->width
1320		1507
1321	=item $window_height = $term->height	1508	=item $window_height = $term->height
1322		1509
1323	=item $font_width = $term->fwidth	1510	=item $font_width = $term->fwidth
…		…
1353	=item $env = $term->env	1540	=item $env = $term->env
1354		1541
1355	Returns a copy of the environment in effect for the terminal as a hashref	1542	Returns a copy of the environment in effect for the terminal as a hashref
1356	similar to C<\%ENV>.	1543	similar to C<\%ENV>.
1357		1544
		1545	=item @envv = $term->envv
		1546
		1547	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1548
		1549	=item @argv = $term->argv
		1550
		1551	Return the argument vector as this terminal, similar to @ARGV, but
		1552	includes the program name as first element.
		1553
1358	=cut	1554	=cut
1359		1555
1360	sub env {	1556	sub env {
1361	if (my $env = $_[0]->_env) {
1362	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1557	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1363	} else {
1364	+{ %ENV }
1365	}
1366	}	1558	}
1367		1559
1368	=item $modifiermask = $term->ModLevel3Mask	1560	=item $modifiermask = $term->ModLevel3Mask
1369		1561
1370	=item $modifiermask = $term->ModMetaMask	1562	=item $modifiermask = $term->ModMetaMask
…		…
1375	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1567	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1376		1568
1377	=item $screen = $term->current_screen	1569	=item $screen = $term->current_screen
1378		1570
1379	Returns the currently displayed screen (0 primary, 1 secondary).	1571	Returns the currently displayed screen (0 primary, 1 secondary).
		1572
		1573	=item $cursor_is_hidden = $term->hidden_cursor
		1574
		1575	Returns whether the cursor is currently hidden or not.
1380		1576
1381	=item $view_start = $term->view_start ([$newvalue])	1577	=item $view_start = $term->view_start ([$newvalue])
1382		1578
1383	Returns the row number of the topmost displayed line. Maximum value is	1579	Returns the row number of the topmost displayed line. Maximum value is
1384	C<0>, which displays the normal terminal contents. Lower values scroll	1580	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1392		1588
1393	Used after changing terminal contents to display them.	1589	Used after changing terminal contents to display them.
1394		1590
1395	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1591	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1396		1592
1397	Returns the text of the entire row with number C<$row_number>. Row C<0>	1593	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1398	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1594	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1399	terminal line. The scrollback buffer starts at line C<-1> and extends to
1400	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1595	terminal line. Nothing will be returned if a nonexistent line
1401	is requested.	1596	is requested.
1402		1597
1403	If C<$new_text> is specified, it will replace characters in the current	1598	If C<$new_text> is specified, it will replace characters in the current
1404	line, starting at column C<$start_col> (default C<0>), which is useful	1599	line, starting at column C<$start_col> (default C<0>), which is useful
1405	to replace only parts of a line. The font index in the rendition will	1600	to replace only parts of a line. The font index in the rendition will
1406	automatically be updated.	1601	automatically be updated.
1407		1602
1408	C<$text> is in a special encoding: tabs and wide characters that use	1603	C<$text> is in a special encoding: tabs and wide characters that use more
1409	more than one cell when displayed are padded with C<$urxvt::NOCHAR>	1604	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1410	characters. Characters with combining characters and other characters that	1605	characters. Characters with combining characters and other characters that
1411	do not fit into the normal tetx encoding will be replaced with characters	1606	do not fit into the normal text encoding will be replaced with characters
1412	in the private use area.	1607	in the private use area.
1413		1608
1414	You have to obey this encoding when changing text. The advantage is	1609	You have to obey this encoding when changing text. The advantage is
1415	that C<substr> and similar functions work on screen cells and not on	1610	that C<substr> and similar functions work on screen cells and not on
1416	characters.	1611	characters.
…		…
1561	where one character corresponds to one screen cell. See	1756	where one character corresponds to one screen cell. See
1562	C<< $term->ROW_t >> for details.	1757	C<< $term->ROW_t >> for details.
1563		1758
1564	=item $string = $term->special_decode $text	1759	=item $string = $term->special_decode $text
1565		1760
1566	Converts rxvt-unicodes text reprsentation into a perl string. See	1761	Converts rxvt-unicodes text representation into a perl string. See
1567	C<< $term->ROW_t >> for details.	1762	C<< $term->ROW_t >> for details.
1568		1763
1569	=item $success = $term->grab_button ($button, $modifiermask)	1764	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1570		1765
		1766	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1767
1571	Registers a synchronous button grab. See the XGrabButton manpage.	1768	Register/unregister a synchronous button grab. See the XGrabButton
		1769	manpage.
1572		1770
1573	=item $success = $term->grab ($eventtime[, $sync])	1771	=item $success = $term->grab ($eventtime[, $sync])
1574		1772
1575	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1773	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1576	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1774	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1577		1775
1578	=item $term->allow_events_async	1776	=item $term->allow_events_async
1579		1777
1580	Calls XAllowEvents with AsyncBoth for the most recent grab.	1778	Calls XAllowEvents with AsyncBoth for the most recent grab.
1581		1779
…		…
1588	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1786	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1589	recent grab.	1787	recent grab.
1590		1788
1591	=item $term->ungrab	1789	=item $term->ungrab
1592		1790
1593	Calls XUngrab for the most recent grab. Is called automatically on	1791	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1594	evaluation errors, as it is better to lose the grab in the error case as	1792	evaluation errors, as it is better to lose the grab in the error case as
1595	the session.	1793	the session.
1596		1794
1597	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1795	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1598		1796
…		…
1600		1798
1601	=item @atoms = $term->XListProperties ($window)	1799	=item @atoms = $term->XListProperties ($window)
1602		1800
1603	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1801	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1604		1802
1605	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1803	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1606		1804
1607	=item $term->XDeleteProperty ($window, $property)	1805	=item $term->XDeleteProperty ($window, $property)
1608		1806
1609	=item $window = $term->DefaultRootWindow	1807	=item $window = $term->DefaultRootWindow
1610		1808
…		…
1617	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1815	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1618		1816
1619	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1817	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1620		1818
1621	=item $term->XChangeInput ($window, $add_events[, $del_events])	1819	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1820
		1821	=item $keysym = $term->XStringToKeysym ($string)
		1822
		1823	=item $string = $term->XKeysymToString ($keysym)
1622		1824
1623	Various X or X-related functions. The C<$term> object only serves as	1825	Various X or X-related functions. The C<$term> object only serves as
1624	the source of the display, otherwise those functions map more-or-less	1826	the source of the display, otherwise those functions map more-or-less
1625	directory onto the X functions of the same name.	1827	directly onto the X functions of the same name.
1626		1828
1627	=back	1829	=back
1628		1830
1629	=cut	1831	=cut
1630		1832
…		…
1694	my ($self, $text, $cb) = @_;	1896	my ($self, $text, $cb) = @_;
1695		1897
1696	$self->add_item ({ type => "button", text => $text, activate => $cb});	1898	$self->add_item ({ type => "button", text => $text, activate => $cb});
1697	}	1899	}
1698		1900
1699	=item $popup->add_toggle ($text, $cb, $initial_value)	1901	=item $popup->add_toggle ($text, $initial_value, $cb)
1700		1902
1701	Adds a toggle/checkbox item to the popup. Teh callback gets called	1903	Adds a toggle/checkbox item to the popup. The callback gets called
1702	whenever it gets toggled, with a boolean indicating its value as its first	1904	whenever it gets toggled, with a boolean indicating its new value as its
1703	argument.	1905	first argument.
1704		1906
1705	=cut	1907	=cut
1706		1908
1707	sub add_toggle {	1909	sub add_toggle {
1708	my ($self, $text, $cb, $value) = @_;	1910	my ($self, $text, $value, $cb) = @_;
1709		1911
1710	my $item; $item = {	1912	my $item; $item = {
1711	type => "button",	1913	type => "button",
1712	text => " $text",	1914	text => " $text",
1713	value => $value,	1915	value => $value,
…		…
1732	my $env = $self->{term}->env;	1934	my $env = $self->{term}->env;
1733	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1935	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1734	delete $env->{LC_ALL};	1936	delete $env->{LC_ALL};
1735	$env->{LC_CTYPE} = $self->{term}->locale;	1937	$env->{LC_CTYPE} = $self->{term}->locale;
1736		1938
1737	urxvt::term->new ($env, "popup",	1939	my $term = urxvt::term->new (
		1940	$env, "popup",
1738	"--perl-lib" => "", "--perl-ext-common" => "",	1941	"--perl-lib" => "", "--perl-ext-common" => "",
1739	"-pty-fd" => -1, "-sl" => 0,	1942	"-pty-fd" => -1, "-sl" => 0,
1740	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1943	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1741	"--transient-for" => $self->{term}->parent,	1944	"--transient-for" => $self->{term}->parent,
1742	"-display" => $self->{term}->display_id,	1945	"-display" => $self->{term}->display_id,
1743	"-pe" => "urxvt-popup")	1946	"-pe" => "urxvt-popup",
1744	or die "unable to create popup window\n";	1947	) or die "unable to create popup window\n";
		1948
		1949	unless (delete $term->{urxvt_popup_init_done}) {
		1950	$term->ungrab;
		1951	$term->destroy;
		1952	die "unable to initialise popup window\n";
		1953	}
1745	}	1954	}
1746		1955
1747	sub DESTROY {	1956	sub DESTROY {
1748	my ($self) = @_;	1957	my ($self) = @_;
1749		1958
…		…
1754	=back	1963	=back
1755		1964
1756	=cut	1965	=cut
1757		1966
1758	package urxvt::watcher;	1967	package urxvt::watcher;
1759
1760	@urxvt::timer::ISA = __PACKAGE__;
1761	@urxvt::iow::ISA = __PACKAGE__;
1762	@urxvt::pw::ISA = __PACKAGE__;
1763	@urxvt::iw::ISA = __PACKAGE__;
1764		1968
1765	=head2 The C<urxvt::timer> Class	1969	=head2 The C<urxvt::timer> Class
1766		1970
1767	This class implements timer watchers/events. Time is represented as a	1971	This class implements timer watchers/events. Time is represented as a
1768	fractional number of seconds since the epoch. Example:	1972	fractional number of seconds since the epoch. Example:
…		…
1772	->new	1976	->new
1773	->interval (1)	1977	->interval (1)
1774	->cb (sub {	1978	->cb (sub {
1775	$term->{overlay}->set (0, 0,	1979	$term->{overlay}->set (0, 0,
1776	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1980	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1777	});	1981	});
1778		1982
1779	=over 4	1983	=over 4
1780		1984
1781	=item $timer = new urxvt::timer	1985	=item $timer = new urxvt::timer
1782		1986
…		…
1785		1989
1786	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1990	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1787		1991
1788	Set the callback to be called when the timer triggers.	1992	Set the callback to be called when the timer triggers.
1789		1993
1790	=item $tstamp = $timer->at
1791
1792	Return the time this watcher will fire next.
1793
1794	=item $timer = $timer->set ($tstamp)	1994	=item $timer = $timer->set ($tstamp[, $interval])
1795		1995
1796	Set the time the event is generated to $tstamp.	1996	Set the time the event is generated to $tstamp (and optionally specifies a
		1997	new $interval).
1797		1998
1798	=item $timer = $timer->interval ($interval)	1999	=item $timer = $timer->interval ($interval)
1799		2000
1800	Normally (and when C<$interval> is C<0>), the timer will automatically	2001	By default (and when C<$interval> is C<0>), the timer will automatically
1801	stop after it has fired once. If C<$interval> is non-zero, then the timer	2002	stop after it has fired once. If C<$interval> is non-zero, then the timer
1802	is automatically rescheduled at the given intervals.	2003	is automatically rescheduled at the given intervals.
1803		2004
1804	=item $timer = $timer->start	2005	=item $timer = $timer->start
1805		2006
1806	Start the timer.	2007	Start the timer.
1807		2008
1808	=item $timer = $timer->start ($tstamp)	2009	=item $timer = $timer->start ($tstamp[, $interval])
1809		2010
1810	Set the event trigger time to C<$tstamp> and start the timer.	2011	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2012	also replaces the interval.
1811		2013
1812	=item $timer = $timer->after ($delay)	2014	=item $timer = $timer->after ($delay[, $interval])
1813		2015
1814	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2016	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1815		2017
1816	=item $timer = $timer->stop	2018	=item $timer = $timer->stop
1817		2019
…		…
1825		2027
1826	$term->{socket} = ...	2028	$term->{socket} = ...
1827	$term->{iow} = urxvt::iow	2029	$term->{iow} = urxvt::iow
1828	->new	2030	->new
1829	->fd (fileno $term->{socket})	2031	->fd (fileno $term->{socket})
1830	->events (urxvt::EVENT_READ)	2032	->events (urxvt::EV_READ)
1831	->start	2033	->start
1832	->cb (sub {	2034	->cb (sub {
1833	my ($iow, $revents) = @_;	2035	my ($iow, $revents) = @_;
1834	# $revents must be 1 here, no need to check	2036	# $revents must be 1 here, no need to check
1835	sysread $term->{socket}, my $buf, 8192	2037	sysread $term->{socket}, my $buf, 8192
…		…
1848	Set the callback to be called when io events are triggered. C<$reventmask>	2050	Set the callback to be called when io events are triggered. C<$reventmask>
1849	is a bitset as described in the C<events> method.	2051	is a bitset as described in the C<events> method.
1850		2052
1851	=item $iow = $iow->fd ($fd)	2053	=item $iow = $iow->fd ($fd)
1852		2054
1853	Set the filedescriptor (not handle) to watch.	2055	Set the file descriptor (not handle) to watch.
1854		2056
1855	=item $iow = $iow->events ($eventmask)	2057	=item $iow = $iow->events ($eventmask)
1856		2058
1857	Set the event mask to watch. The only allowed values are	2059	Set the event mask to watch. The only allowed values are
1858	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2060	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1859	together, or C<urxvt::EVENT_NONE>.	2061	together, or C<urxvt::EV_NONE>.
1860		2062
1861	=item $iow = $iow->start	2063	=item $iow = $iow->start
1862		2064
1863	Start watching for requested events on the given handle.	2065	Start watching for requested events on the given handle.
1864		2066
1865	=item $iow = $iow->stop	2067	=item $iow = $iow->stop
1866		2068
1867	Stop watching for events on the given filehandle.	2069	Stop watching for events on the given file handle.
1868		2070
1869	=back	2071	=back
1870		2072
1871	=head2 The C<urxvt::iw> Class	2073	=head2 The C<urxvt::iw> Class
1872		2074
…		…
1905	->new	2107	->new
1906	->start ($pid)	2108	->start ($pid)
1907	->cb (sub {	2109	->cb (sub {
1908	my ($pw, $exit_status) = @_;	2110	my ($pw, $exit_status) = @_;
1909	...	2111	...
1910	});	2112	});
1911		2113
1912	=over 4	2114	=over 4
1913		2115
1914	=item $pw = new urxvt::pw	2116	=item $pw = new urxvt::pw
1915		2117
…		…
1919		2121
1920	Set the callback to be called when the timer triggers.	2122	Set the callback to be called when the timer triggers.
1921		2123
1922	=item $pw = $timer->start ($pid)	2124	=item $pw = $timer->start ($pid)
1923		2125
1924	Tells the wqtcher to start watching for process C<$pid>.	2126	Tells the watcher to start watching for process C<$pid>.
1925		2127
1926	=item $pw = $pw->stop	2128	=item $pw = $pw->stop
1927		2129
1928	Stop the watcher.	2130	Stop the watcher.
1929		2131
…		…
1942		2144
1943	=item >= 3 - script loading and management	2145	=item >= 3 - script loading and management
1944		2146
1945	=item >=10 - all called hooks	2147	=item >=10 - all called hooks
1946		2148
1947	=item >=11 - hook reutrn values	2149	=item >=11 - hook return values
1948		2150
1949	=back	2151	=back
1950		2152
1951	=head1 AUTHOR	2153	=head1 AUTHOR
1952		2154
1953	Marc Lehmann <pcg@goof.com>	2155	Marc Lehmann <schmorp@schmorp.de>
1954	http://software.schmorp.de/pkg/rxvt-unicode	2156	http://software.schmorp.de/pkg/rxvt-unicode
1955		2157
1956	=cut	2158	=cut
1957		2159
1958	1	2160	1
		2161
		2162	# vim: sw=3:

Diff Legend

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