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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.117 by ayin, Fri Jan 20 18:02:43 2006 UTC vs.
Revision 1.180 by root, Sat Dec 26 09:42:16 2009 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' 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	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
62	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
63	...	66	...
64		67
65	The index number (0, 1...) must not have any holes, and each regex must	68	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	69	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	70	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:	71	between two vertical bars:
69		72
70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
71		81
72	You can look at the source of the selection extension to see more	82	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.	83	interesting uses, such as parsing a line from beginning to end.
74		84
75	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
86		96
87	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
88		98
89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90	runtime.	100	runtime.
		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
91		118
92	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
93		120
94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	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	122	text into various other formats/action (such as uri unescaping, perl
96	evaluation, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
97		124
98	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
100	popup is displayed.	127	popup is being displayed.
101		128
102	It's sole argument is the popup menu, which can be modified. The selection	129	Its 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.	130	is in C<$_>, which can be used to decide whether to add something or not.
104	It should either return nothing or a string and a code reference. The	131	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	132	string will be used as button text and the code reference will be called
106	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
107		134
108	The following will add an entry C<a to b> that transforms all C<a>s in	135	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	136	the selection to C<b>s, but only if the selection currently contains any
110	C<a>s:	137	C<a>s:
111		138
112	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
114	: ()	141	: ()
115	};	142	};
116		143
117	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
118		145
…		…
125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	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	153	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	154	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	155	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	156	additionally stores the first match in the current line into the primary
130	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
131		189
132	=item selection-autotransform	190	=item selection-autotransform
133		191
134	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
135	whenever a selection is made.	193	whenever a selection is made.
…		…
165	the message into vi commands to load the file.	223	the message into vi commands to load the file.
166		224
167	=item tabbed	225	=item tabbed
168		226
169	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one	229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
172	button per tab.	230	button per tab.
173		231
174	Clicking a button will activate that tab. Pressing B<Shift-Left> and	232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
175	B<Shift-Right> will switch to the tab left or right of the current one,	233	B<Shift-Right> will switch to the tab left or right of the current one,
176	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
177		235
178	=item mark-urls	236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
179		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
180	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
181	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
182	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
183	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
184		258
185	=item automove-background	259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
186		263
187	This is basically a one-line extension that dynamically changes the background pixmap offset	264	It is possible to activate the most recently seen match from the keyboard.
188	to the window position, in effect creating the same effect as pseudo transparency with	265	Simply bind a keysym to "perl:matcher" as seen in the example below.
189	a custom pixmap. No scaling is supported in this mode. Exmaple:
190		266
191	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
192		313
193	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
194		315
195	A not very useful example of filtering all text output to the terminal,	316	A not very useful example of filtering all text output to the terminal
196	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
197	similar-looking ascii character.	318	similar-looking ascii character.
198		319
199	=item digital-clock	320	=item digital-clock
200		321
201	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
202		323
203	=item example-refresh-hooks	324	=item remote-clipboard
204		325
205	Displays a very simple digital clock in the upper right corner of the	326	Somewhat of a misnomer, this extension adds two menu entries to the
206	window. Illustrates overwriting the refresh callbacks to create your own	327	selection popup that allows one to run external commands to store the
207	overlays or changes.	328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
208		343
209	=item selection-pastebin	344	=item selection-pastebin
210		345
211	This is a little rarely useful extension that Uploads the selection as	346	This is a little rarely useful extension that Uploads the selection as
212	textfile to a remote site (or does other things). (The implementation is	347	textfile to a remote site (or does other things). (The implementation is
…		…
232	After a successful upload the selection will be replaced by the text given	367	After a successful upload the selection will be replaced by the text given
233	in the C<selection-pastebin-url> resource (again, the % is the placeholder	368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
234	for the filename):	369	for the filename):
235		370
236	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of wether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-pastebin and macosx-pastebin-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<maxosx-pastebin> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
		391
		392	=item example-refresh-hooks
		393
		394	Displays a very simple digital clock in the upper right corner of the
		395	window. Illustrates overwriting the refresh callbacks to create your own
		396	overlays or changes.
237		397
238	=back	398	=back
239		399
240	=head1 API DOCUMENTATION	400	=head1 API DOCUMENTATION
241		401
…		…
275		435
276	=back	436	=back
277		437
278	=head2 Extension Objects	438	=head2 Extension Objects
279		439
280	Very perl extension is a perl class. A separate perl object is created	440	Every perl extension is a perl class. A separate perl object is created
281	for each terminal and each extension and passed as the first parameter to	441	for each terminal, and each terminal has its own set of extenion objects,
282	hooks. So extensions can use their C<$self> object without having to think	442	which are passed as the first parameter to hooks. So extensions can use
283	about other extensions, with the exception of methods and members that	443	their C<$self> object without having to think about clashes with other
		444	extensions or other terminals, with the exception of methods and members
284	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
285	use.	446	internal use.
286		447
287	Although it isn't a C<urxvt::term> object, you can call all methods of the	448	Although it isn't a C<urxvt::term> object, you can call all methods of the
288	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
289		450
290	It has the following methods and data members:	451	It has the following methods and data members:
…		…
311	=head2 Hooks	472	=head2 Hooks
312		473
313	The following subroutines can be declared in extension files, and will be	474	The following subroutines can be declared in extension files, and will be
314	called whenever the relevant event happens.	475	called whenever the relevant event happens.
315		476
316	The first argument passed to them is an extension oject as described in	477	The first argument passed to them is an extension object as described in
317	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
318		479
319	B<All> of these hooks must return a boolean value. If any of the called	480	B<All> of these hooks must return a boolean value. If any of the called
320	hooks returns true, then the event counts as being I<consumed>, and the	481	hooks returns true, then the event counts as being I<consumed>, and the
321	relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
…		…
334	place.	495	place.
335		496
336	=item on_start $term	497	=item on_start $term
337		498
338	Called at the very end of initialisation of a new terminal, just before	499	Called at the very end of initialisation of a new terminal, just before
339	trying to map (display) the toplevel and returning to the mainloop.	500	trying to map (display) the toplevel and returning to the main loop.
340		501
341	=item on_destroy $term	502	=item on_destroy $term
342		503
343	Called whenever something tries to destroy terminal, before doing anything	504	Called whenever something tries to destroy terminal, when the terminal is
344	yet. If this hook returns true, then destruction is skipped, but this is	505	still fully functional (not for long, though).
345	rarely a good idea.
346		506
347	=item on_reset $term	507	=item on_reset $term
348		508
349	Called after the screen is "reset" for any reason, such as resizing or	509	Called after the screen is "reset" for any reason, such as resizing or
350	control sequences. Here is where you can react on changes to size-related	510	control sequences. Here is where you can react on changes to size-related
…		…
372		532
373	Called whenever a selection has been copied, but before the selection is	533	Called whenever a selection has been copied, but before the selection is
374	requested from the server. The selection text can be queried and changed	534	requested from the server. The selection text can be queried and changed
375	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
376		536
377	Returning a true value aborts selection grabbing. It will still be hilighted.	537	Returning a true value aborts selection grabbing. It will still be highlighted.
378		538
379	=item on_sel_extend $term	539	=item on_sel_extend $term
380		540
381	Called whenever the user tries to extend the selection (e.g. with a double	541	Called whenever the user tries to extend the selection (e.g. with a double
382	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
383	should extend the selection itelf and return true to suppress the built-in	543	should extend the selection itself and return true to suppress the built-in
384	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
385	returns true, it will be called on every further click by the user and is	545	returns true, it will be called on every further click by the user and is
386	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
387		547
388	See the F<selection> example extension.	548	See the F<selection> example extension.
389		549
390	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
391		551
392	Called whenever the view offset changes, i..e the user or program	552	Called whenever the view offset changes, i.e. the user or program
393	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
394	show this many lines of scrollback.	554	show this many lines of scrollback.
395		555
396	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
397		557
…		…
401		561
402	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
403	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	563	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
404	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
405		565
406	=item on_osc_seq $term, $string	566	=item on_osc_seq $term, $op, $args, $resp
		567
		568	Called on every OSC sequence and can be used to suppress it or modify its
		569	behaviour. The default should be to return an empty list. A true value
		570	suppresses execution of the request completely. Make sure you don't get
		571	confused by recursive invocations when you output an OSC sequence within
		572	this callback.
		573
		574	C<on_osc_seq_perl> should be used for new behaviour.
		575
		576	=item on_osc_seq_perl $term, $args, $resp
407		577
408	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
409	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
410	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
411	string should start with the extension name and a colon, to distinguish	581	string should start with the extension name (sans -osc) and a semicolon,
412	it from commands for other extensions, and this might be enforced in the	582	to distinguish it from commands for other extensions, and this might be
413	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
414		594
415	Be careful not ever to trust (in a security sense) the data you receive,	595	Be careful not ever to trust (in a security sense) the data you receive,
416	as its source can not easily be controleld (e-mail content, messages from	596	as its source can not easily be controlled (e-mail content, messages from
417	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
418		601
419	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
420		603
421	Called whenever text is about to be output, with the text as argument. You	604	Called whenever text is about to be output, with the text as argument. You
422	can filter/change and output the text yourself by returning a true value	605	can filter/change and output the text yourself by returning a true value
…		…
443	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
444	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
445		628
446	=item on_refresh_begin $term	629	=item on_refresh_begin $term
447		630
448	Called just before the screen gets redrawn. Can be used for overlay	631	Called just before the screen gets redrawn. Can be used for overlay or
449	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
450	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
451	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
452		635
453	=item on_refresh_end $term	636	=item on_refresh_end $term
454		637
455	Called just after the screen gets redrawn. See C<on_refresh_begin>.	638	Called just after the screen gets redrawn. See C<on_refresh_begin>.
456		639
457	=item on_keyboard_command $term, $string	640	=item on_user_command $term, $string
458		641
459	Called whenever the user presses a key combination that has a	642	Called whenever a user-configured event is being activated (e.g. via
460	C<perl:string> action bound to it (see description of the B<keysym>	643	a C<perl:string> action bound to a key, see description of the B<keysym>
461	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
		645
		646	The event is simply the action string. This interface is assumed to change
		647	slightly in the future.
		648
		649	=item on_resize_all_windows $tern, $new_width, $new_height
		650
		651	Called just after the new window size has been calculated, but before
		652	windows are actually being resized or hints are being set. If this hook
		653	returns TRUE, setting of the window hints is being skipped.
462		654
463	=item on_x_event $term, $event	655	=item on_x_event $term, $event
464		656
465	Called on every X event received on the vt window (and possibly other	657	Called on every X event received on the vt window (and possibly other
466	windows). Should only be used as a last resort. Most event structure	658	windows). Should only be used as a last resort. Most event structure
467	members are not passed.	659	members are not passed.
468		660
		661	=item on_root_event $term, $event
		662
		663	Like C<on_x_event>, but is called for events on the root window.
		664
469	=item on_focus_in $term	665	=item on_focus_in $term
470		666
471	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
472	does focus in processing.	668	does focus in processing.
473		669
474	=item on_focus_out $term	670	=item on_focus_out $term
475		671
476	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
477	focus out processing.	673	focus out processing.
478		674
479	=item on_configure_notify $term, $event	675	=item on_configure_notify $term, $event
		676
		677	=item on_property_notify $term, $event
480		678
481	=item on_key_press $term, $event, $keysym, $octets	679	=item on_key_press $term, $event, $keysym, $octets
482		680
483	=item on_key_release $term, $event, $keysym	681	=item on_key_release $term, $event, $keysym
484		682
…		…
494		692
495	Called whenever the corresponding X event is received for the terminal If	693	Called whenever the corresponding X event is received for the terminal If
496	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the even will be ignored by rxvt-unicode.
497		695
498	The event is a hash with most values as named by Xlib (see the XEvent	696	The event is a hash with most values as named by Xlib (see the XEvent
499	manpage), with the additional members C<row> and C<col>, which are the row	697	manpage), with the additional members C<row> and C<col>, which are the
500	and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
501		699
502	C<on_key_press> additionally receives the string rxvt-unicode would	700	C<on_key_press> additionally receives the string rxvt-unicode would
503	output, if any, in locale-specific encoding.	701	output, if any, in locale-specific encoding.
504		702
505	subwindow.	703	subwindow.
…		…
536	our $LIBDIR;	734	our $LIBDIR;
537	our $RESNAME;	735	our $RESNAME;
538	our $RESCLASS;	736	our $RESCLASS;
539	our $RXVTNAME;	737	our $RXVTNAME;
540		738
		739	our $NOCHAR = chr 0xffff;
		740
541	=head2 Variables in the C<urxvt> Package	741	=head2 Variables in the C<urxvt> Package
542		742
543	=over 4	743	=over 4
544		744
545	=item $urxvt::LIBDIR	745	=item $urxvt::LIBDIR
…		…
560	The current terminal. This variable stores the current C<urxvt::term>	760	The current terminal. This variable stores the current C<urxvt::term>
561	object, whenever a callback/hook is executing.	761	object, whenever a callback/hook is executing.
562		762
563	=item @urxvt::TERM_INIT	763	=item @urxvt::TERM_INIT
564		764
565	All coderefs in this array will be called as methods of the next newly	765	All code references in this array will be called as methods of the next newly
566	created C<urxvt::term> object (during the C<on_init> phase). The array	766	created C<urxvt::term> object (during the C<on_init> phase). The array
567	gets cleared before the codereferences that were in it are being executed,	767	gets cleared before the code references that were in it are being executed,
568	so coderefs can push themselves onto it again if they so desire.	768	so references can push themselves onto it again if they so desire.
569		769
570	This complements to the perl-eval commandline option, but gets executed	770	This complements to the perl-eval command line option, but gets executed
571	first.	771	first.
572		772
573	=item @urxvt::TERM_EXT	773	=item @urxvt::TERM_EXT
574		774
575	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	775	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
596		796
597	Using this function has the advantage that its output ends up in the	797	Using this function has the advantage that its output ends up in the
598	correct place, e.g. on stderr of the connecting urxvtc client.	798	correct place, e.g. on stderr of the connecting urxvtc client.
599		799
600	Messages have a size limit of 1023 bytes currently.	800	Messages have a size limit of 1023 bytes currently.
		801
		802	=item @terms = urxvt::termlist
		803
		804	Returns all urxvt::term objects that exist in this process, regardless of
		805	whether they are started, being destroyed etc., so be careful. Only term
		806	objects that have perl extensions attached will be returned (because there
		807	is no urxvt::term objet associated with others).
601		808
602	=item $time = urxvt::NOW	809	=item $time = urxvt::NOW
603		810
604	Returns the "current time" (as per the event loop).	811	Returns the "current time" (as per the event loop).
605		812
…		…
663	Return the foreground/background colour index, respectively.	870	Return the foreground/background colour index, respectively.
664		871
665	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	872	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
666		873
667	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	874	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		875
		876	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
668		877
669	Replace the foreground/background colour in the rendition mask with the	878	Replace the foreground/background colour in the rendition mask with the
670	specified one.	879	specified one.
671		880
672	=item $value = urxvt::GET_CUSTOM $rend	881	=item $value = urxvt::GET_CUSTOM $rend
…		…
691	unless $msg =~ /\n$/;	900	unless $msg =~ /\n$/;
692	urxvt::warn ($msg);	901	urxvt::warn ($msg);
693	};	902	};
694	}	903	}
695		904
		905	no warnings 'utf8';
		906
696	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	907	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
697		908
698	sub verbose {	909	sub verbose {
699	my ($level, $msg) = @_;	910	my ($level, $msg) = @_;
700	warn "$msg\n" if $level <= $verbosity;	911	warn "$msg\n" if $level <= $verbosity;
…		…
716		927
717	open my $fh, "<:raw", $path	928	open my $fh, "<:raw", $path
718	or die "$path: $!";	929	or die "$path: $!";
719		930
720	my $source =	931	my $source =
721	"package $pkg; use strict; use utf8;\n"	932	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
722	. "#line 1 \"$path\"\n{\n"	933	. "#line 1 \"$path\"\n{\n"
723	. (do { local $/; <$fh> })	934	. (do { local $/; <$fh> })
724	. "\n};\n1";	935	. "\n};\n1";
725		936
726	eval $source	937	eval $source
…		…
737	local $TERM = shift;	948	local $TERM = shift;
738	my $htype = shift;	949	my $htype = shift;
739		950
740	if ($htype == 0) { # INIT	951	if ($htype == 0) { # INIT
741	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
742		953
743	my %ext_arg;	954	my %ext_arg;
744		955
745	{	956	{
746	my @init = @TERM_INIT;	957	my @init = @TERM_INIT;
747	@TERM_INIT = ();	958	@TERM_INIT = ();
…		…
751	$TERM->register_package ($_) for @pkg;	962	$TERM->register_package ($_) for @pkg;
752	}	963	}
753		964
754	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	965	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
755	if ($_ eq "default") {	966	if ($_ eq "default") {
756	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	967	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
757	} elsif (/^-(.*)$/) {	968	} elsif (/^-(.*)$/) {
758	delete $ext_arg{$1};	969	delete $ext_arg{$1};
759	} elsif (/^([^<]+)<(.*)>$/) {	970	} elsif (/^([^<]+)<(.*)>$/) {
760	push @{ $ext_arg{$1} }, $2;	971	push @{ $ext_arg{$1} }, $2;
761	} else {	972	} else {
762	$ext_arg{$_} \|\|= [];	973	$ext_arg{$_} \|\|= [];
763	}	974	}
764	}	975	}
765		976
766	while (my ($ext, $argv) = each %ext_arg) {	977	for my $ext (sort keys %ext_arg) {
767	my @files = grep -f $_, map "$_/$ext", @dirs;	978	my @files = grep -f $_, map "$_/$ext", @dirs;
768		979
769	if (@files) {	980	if (@files) {
770	$TERM->register_package (extension_package $files[0], $argv);	981	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
771	} else {	982	} else {
772	warn "perl extension '$ext' not found in perl library search path\n";	983	warn "perl extension '$ext' not found in perl library search path\n";
773	}	984	}
774	}	985	}
775		986
…		…
781		992
782	if (my $cb = $TERM->{_hook}[$htype]) {	993	if (my $cb = $TERM->{_hook}[$htype]) {
783	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	994	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
784	if $verbosity >= 10;	995	if $verbosity >= 10;
785		996
786	keys %$cb;	997	for my $pkg (keys %$cb) {
787
788	while (my ($pkg, $cb) = each %$cb) {
789	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	998	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
790	$retval \|\|= $retval_;	999	$retval \|\|= $retval_;
791		1000
792	if ($@) {	1001	if ($@) {
793	$TERM->ungrab; # better to lose the grab than the session	1002	$TERM->ungrab; # better to lose the grab than the session
794	warn $@;	1003	warn $@;
…		…
806	# clear package	1015	# clear package
807	%$TERM = ();	1016	%$TERM = ();
808	}	1017	}
809		1018
810	$retval	1019	$retval
		1020	}
		1021
		1022	sub SET_COLOR($$$) {
		1023	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1024	}
		1025
		1026	sub rend2mask {
		1027	no strict 'refs';
		1028	my ($str, $mask) = (@_, 0);
		1029	my %color = ( fg => undef, bg => undef );
		1030	my @failed;
		1031	for my $spec ( split /\s+/, $str ) {
		1032	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1033	$color{lc($1)} = $2;
		1034	} else {
		1035	my $neg = $spec =~ s/^[-^]//;
		1036	unless ( exists &{"RS_$spec"} ) {
		1037	push @failed, $spec;
		1038	next;
		1039	}
		1040	my $cur = &{"RS_$spec"};
		1041	if ( $neg ) {
		1042	$mask &= ~$cur;
		1043	} else {
		1044	$mask \|= $cur;
		1045	}
		1046	}
		1047	}
		1048	($mask, @color{qw(fg bg)}, \@failed)
811	}	1049	}
812		1050
813	# urxvt::term::extension	1051	# urxvt::term::extension
814		1052
815	package urxvt::term::extension;	1053	package urxvt::term::extension;
…		…
886	is that you cannot use blocking APIs, but the non-blocking variant should	1124	is that you cannot use blocking APIs, but the non-blocking variant should
887	work.	1125	work.
888		1126
889	=cut	1127	=cut
890		1128
891	our $VERSION = 1;	1129	our $VERSION = '5.23';
892		1130
893	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1131	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
894	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1132	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
895		1133
896	sub timer {	1134	sub timer {
…		…
898		1136
899	my $cb = $arg{cb};	1137	my $cb = $arg{cb};
900		1138
901	urxvt::timer	1139	urxvt::timer
902	->new	1140	->new
903	->start (urxvt::NOW + $arg{after})	1141	->after ($arg{after}, $arg{interval})
904	->cb (sub {	1142	->cb ($arg{interval} ? $cb : sub {
905	$_[0]->stop; # need to cancel manually	1143	$_[0]->stop; # need to cancel manually
906	$cb->();	1144	$cb->();
907	})	1145	})
908	}	1146	}
909		1147
910	sub io {	1148	sub io {
911	my ($class, %arg) = @_;	1149	my ($class, %arg) = @_;
912		1150
913	my $cb = $arg{cb};	1151	my $cb = $arg{cb};
		1152	my $fd = fileno $arg{fh};
		1153	defined $fd or $fd = $arg{fh};
914		1154
915	bless [$arg{fh}, urxvt::iow	1155	bless [$arg{fh}, urxvt::iow
916	->new	1156	->new
917	->fd (fileno $arg{fh})	1157	->fd ($fd)
918	->events (($arg{poll} =~ /r/ ? 1 : 0)	1158	->events (($arg{poll} =~ /r/ ? 1 : 0)
919	\| ($arg{poll} =~ /w/ ? 2 : 0))	1159	\| ($arg{poll} =~ /w/ ? 2 : 0))
920	->start	1160	->start
921	->cb (sub {	1161	->cb ($cb)
922	$cb->(($_[1] & 1 ? 'r' : '')
923	. ($_[1] & 2 ? 'w' : ''));
924	})],
925	urxvt::anyevent::	1162	], urxvt::anyevent::
		1163	}
		1164
		1165	sub idle {
		1166	my ($class, %arg) = @_;
		1167
		1168	my $cb = $arg{cb};
		1169
		1170	urxvt::iw
		1171	->new
		1172	->start
		1173	->cb ($cb)
		1174	}
		1175
		1176	sub child {
		1177	my ($class, %arg) = @_;
		1178
		1179	my $cb = $arg{cb};
		1180
		1181	urxvt::pw
		1182	->new
		1183	->start ($arg{pid})
		1184	->cb (sub {
		1185	$_[0]->stop; # need to cancel manually
		1186	$cb->($_[0]->rpid, $_[0]->rstatus);
		1187	})
926	}	1188	}
927		1189
928	sub DESTROY {	1190	sub DESTROY {
929	$_[0][1]->stop;	1191	$_[0][1]->stop;
930	}	1192	}
931		1193
932	sub condvar {	1194	sub one_event {
933	bless \my $flag, urxvt::anyevent::condvar::
934	}
935
936	sub urxvt::anyevent::condvar::broadcast {
937	${$_[0]}++;
938	}
939
940	sub urxvt::anyevent::condvar::wait {
941	unless (${$_[0]}) {
942	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1195	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
943	}
944	}	1196	}
945		1197
946	package urxvt::term;	1198	package urxvt::term;
947		1199
948	=head2 The C<urxvt::term> Class	1200	=head2 The C<urxvt::term> Class
…		…
984	hash which defines the environment of the new terminal.	1236	hash which defines the environment of the new terminal.
985		1237
986	Croaks (and probably outputs an error message) if the new instance	1238	Croaks (and probably outputs an error message) if the new instance
987	couldn't be created. Returns C<undef> if the new instance didn't	1239	couldn't be created. Returns C<undef> if the new instance didn't
988	initialise perl, and the terminal object otherwise. The C<init> and	1240	initialise perl, and the terminal object otherwise. The C<init> and
989	C<start> hooks will be called during this call.	1241	C<start> hooks will be called before this call returns, and are free to
		1242	refer to global data (which is race free).
990		1243
991	=cut	1244	=cut
992		1245
993	sub new {	1246	sub new {
994	my ($class, $env, @args) = @_;	1247	my ($class, $env, @args) = @_;
995		1248
		1249	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1250	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1251
996	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1252	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
997	}	1253	}
998		1254
999	=item $term->destroy	1255	=item $term->destroy
1000		1256
1001	Destroy the terminal object (close the window, free resources	1257	Destroy the terminal object (close the window, free resources
…		…
1031		1287
1032	Returns true if the option specified by C<$optval> is enabled, and	1288	Returns true if the option specified by C<$optval> is enabled, and
1033	optionally change it. All option values are stored by name in the hash	1289	optionally change it. All option values are stored by name in the hash
1034	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1290	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1035		1291
1036	Here is a a likely non-exhaustive list of option names, please see the	1292	Here is a likely non-exhaustive list of option names, please see the
1037	source file F</src/optinc.h> to see the actual list:	1293	source file F</src/optinc.h> to see the actual list:
1038		1294
1039	borderLess console cursorBlink cursorUnderline hold iconic insecure	1295	borderLess console cursorBlink cursorUnderline hold iconic insecure
1040	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1296	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1041	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1297	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1058	likely change).	1314	likely change).
1059		1315
1060	Please note that resource strings will currently only be freed when the	1316	Please note that resource strings will currently only be freed when the
1061	terminal is destroyed, so changing options frequently will eat memory.	1317	terminal is destroyed, so changing options frequently will eat memory.
1062		1318
1063	Here is a a likely non-exhaustive list of resource names, not all of which	1319	Here is a likely non-exhaustive list of resource names, not all of which
1064	are supported in every build, please see the source file F</src/rsinc.h>	1320	are supported in every build, please see the source file F</src/rsinc.h>
1065	to see the actual list:	1321	to see the actual list:
1066		1322
1067	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1323	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1068	borderLess color cursorBlink cursorUnderline cutchars delete_key	1324	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1069	display_name embed ext_bwidth fade font geometry hold iconName	1325	display_name embed ext_bwidth fade font geometry hold iconName
1070	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1326	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1071	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1327	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1072	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1328	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1073	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1329	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1074	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1330	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1075	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1331	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1076	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1332	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1077	secondaryScreen secondaryScroll selectstyle shade term_name title	1333	secondaryScreen secondaryScroll shade term_name title
1078	transient_for transparent transparent_all tripleclickwords utmpInhibit	1334	transient_for transparent transparent_all tripleclickwords utmpInhibit
1079	visualBell	1335	visualBell
1080		1336
1081	=cut	1337	=cut
1082		1338
1083	sub resource($$;$) {	1339	sub resource($$;$) {
1084	my ($self, $name) = (shift, shift);	1340	my ($self, $name) = (shift, shift);
1085	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1341	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1086	&urxvt::term::_resource	1342	goto &urxvt::term::_resource
1087	}	1343	}
1088		1344
1089	=item $value = $term->x_resource ($pattern)	1345	=item $value = $term->x_resource ($pattern)
1090		1346
1091	Returns the X-Resource for the given pattern, excluding the program or	1347	Returns the X-Resource for the given pattern, excluding the program or
…		…
1116		1372
1117	=item ($row, $col) = $term->selection_beg ([$row, $col])	1373	=item ($row, $col) = $term->selection_beg ([$row, $col])
1118		1374
1119	=item ($row, $col) = $term->selection_end ([$row, $col])	1375	=item ($row, $col) = $term->selection_end ([$row, $col])
1120		1376
1121	Return the current values of the selection mark, begin or end positions,	1377	Return the current values of the selection mark, begin or end positions.
1122	and optionally set them to new values.	1378
		1379	When arguments are given, then the selection coordinates are set to
		1380	C<$row> and C<$col>, and the selection screen is set to the current
		1381	screen.
		1382
		1383	=item $screen = $term->selection_screen ([$screen])
		1384
		1385	Returns the current selection screen, and then optionally sets it.
1123		1386
1124	=item $term->selection_make ($eventtime[, $rectangular])	1387	=item $term->selection_make ($eventtime[, $rectangular])
1125		1388
1126	Tries to make a selection as set by C<selection_beg> and	1389	Tries to make a selection as set by C<selection_beg> and
1127	C<selection_end>. If C<$rectangular> is true (default: false), a	1390	C<selection_end>. If C<$rectangular> is true (default: false), a
…		…
1174		1437
1175	The methods currently supported on C<urxvt::overlay> objects are:	1438	The methods currently supported on C<urxvt::overlay> objects are:
1176		1439
1177	=over 4	1440	=over 4
1178		1441
1179	=item $overlay->set ($x, $y, $text, $rend)	1442	=item $overlay->set ($x, $y, $text[, $rend])
1180		1443
1181	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1444	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1182	text in rxvt-unicode's special encoding and an array of rendition values	1445	text in rxvt-unicode's special encoding and an array of rendition values
1183	at a specific position inside the overlay.	1446	at a specific position inside the overlay.
		1447
		1448	If C<$rend> is missing, then the rendition will not be changed.
1184		1449
1185	=item $overlay->hide	1450	=item $overlay->hide
1186		1451
1187	If visible, hide the overlay, but do not destroy it.	1452	If visible, hide the overlay, but do not destroy it.
1188		1453
…		…
1258		1523
1259	Normally its not a good idea to use this function, as programs might be	1524	Normally its not a good idea to use this function, as programs might be
1260	confused by changes in cursor position or scrolling. Its useful inside a	1525	confused by changes in cursor position or scrolling. Its useful inside a
1261	C<on_add_lines> hook, though.	1526	C<on_add_lines> hook, though.
1262		1527
		1528	=item $term->scr_change_screen ($screen)
		1529
		1530	Switch to given screen - 0 primary, 1 secondary.
		1531
1263	=item $term->cmd_parse ($octets)	1532	=item $term->cmd_parse ($octets)
1264		1533
1265	Similar to C<scr_add_lines>, but the argument must be in the	1534	Similar to C<scr_add_lines>, but the argument must be in the
1266	locale-specific encoding of the terminal and can contain command sequences	1535	locale-specific encoding of the terminal and can contain command sequences
1267	(escape codes) that will be interpreted.	1536	(escape codes) that will be interpreted.
…		…
1277	Replaces the event mask of the pty watcher by the given event mask. Can	1546	Replaces the event mask of the pty watcher by the given event mask. Can
1278	be used to suppress input and output handling to the pty/tty. See the	1547	be used to suppress input and output handling to the pty/tty. See the
1279	description of C<< urxvt::timer->events >>. Make sure to always restore	1548	description of C<< urxvt::timer->events >>. Make sure to always restore
1280	the previous value.	1549	the previous value.
1281		1550
		1551	=item $fd = $term->pty_fd
		1552
		1553	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1554	is used.
		1555
1282	=item $windowid = $term->parent	1556	=item $windowid = $term->parent
1283		1557
1284	Return the window id of the toplevel window.	1558	Return the window id of the toplevel window.
1285		1559
1286	=item $windowid = $term->vt	1560	=item $windowid = $term->vt
…		…
1292	Adds the specified events to the vt event mask. Useful e.g. when you want	1566	Adds the specified events to the vt event mask. Useful e.g. when you want
1293	to receive pointer events all the times:	1567	to receive pointer events all the times:
1294		1568
1295	$term->vt_emask_add (urxvt::PointerMotionMask);	1569	$term->vt_emask_add (urxvt::PointerMotionMask);
1296		1570
		1571	=item $term->focus_in
		1572
		1573	=item $term->focus_out
		1574
		1575	=item $term->key_press ($state, $keycode[, $time])
		1576
		1577	=item $term->key_release ($state, $keycode[, $time])
		1578
		1579	Deliver various fake events to to terminal.
		1580
1297	=item $window_width = $term->width	1581	=item $window_width = $term->width
1298		1582
1299	=item $window_height = $term->height	1583	=item $window_height = $term->height
1300		1584
1301	=item $font_width = $term->fwidth	1585	=item $font_width = $term->fwidth
…		…
1331	=item $env = $term->env	1615	=item $env = $term->env
1332		1616
1333	Returns a copy of the environment in effect for the terminal as a hashref	1617	Returns a copy of the environment in effect for the terminal as a hashref
1334	similar to C<\%ENV>.	1618	similar to C<\%ENV>.
1335		1619
		1620	=item @envv = $term->envv
		1621
		1622	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1623
		1624	=item @argv = $term->argv
		1625
		1626	Return the argument vector as this terminal, similar to @ARGV, but
		1627	includes the program name as first element.
		1628
1336	=cut	1629	=cut
1337		1630
1338	sub env {	1631	sub env {
1339	if (my $env = $_[0]->_env) {
1340	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1632	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1341	} else {
1342	+{ %ENV }
1343	}
1344	}	1633	}
1345		1634
1346	=item $modifiermask = $term->ModLevel3Mask	1635	=item $modifiermask = $term->ModLevel3Mask
1347		1636
1348	=item $modifiermask = $term->ModMetaMask	1637	=item $modifiermask = $term->ModMetaMask
1349		1638
1350	=item $modifiermask = $term->ModNumLockMask	1639	=item $modifiermask = $term->ModNumLockMask
1351		1640
1352	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1641	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1353	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1642	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1643
		1644	=item $screen = $term->current_screen
		1645
		1646	Returns the currently displayed screen (0 primary, 1 secondary).
		1647
		1648	=item $cursor_is_hidden = $term->hidden_cursor
		1649
		1650	Returns whether the cursor is currently hidden or not.
1354		1651
1355	=item $view_start = $term->view_start ([$newvalue])	1652	=item $view_start = $term->view_start ([$newvalue])
1356		1653
1357	Returns the row number of the topmost displayed line. Maximum value is	1654	Returns the row number of the topmost displayed line. Maximum value is
1358	C<0>, which displays the normal terminal contents. Lower values scroll	1655	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1366		1663
1367	Used after changing terminal contents to display them.	1664	Used after changing terminal contents to display them.
1368		1665
1369	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1666	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1370		1667
1371	Returns the text of the entire row with number C<$row_number>. Row C<0>	1668	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1372	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1669	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1373	terminal line. The scrollback buffer starts at line C<-1> and extends to
1374	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1670	terminal line. Nothing will be returned if a nonexistent line
1375	is requested.	1671	is requested.
1376		1672
1377	If C<$new_text> is specified, it will replace characters in the current	1673	If C<$new_text> is specified, it will replace characters in the current
1378	line, starting at column C<$start_col> (default C<0>), which is useful	1674	line, starting at column C<$start_col> (default C<0>), which is useful
1379	to replace only parts of a line. The font index in the rendition will	1675	to replace only parts of a line. The font index in the rendition will
1380	automatically be updated.	1676	automatically be updated.
1381		1677
1382	C<$text> is in a special encoding: tabs and wide characters that use more	1678	C<$text> is in a special encoding: tabs and wide characters that use more
1383	than one cell when displayed are padded with urxvt::NOCHAR characters	1679	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1384	(C<chr 65535>). Characters with combining characters and other characters	1680	characters. Characters with combining characters and other characters that
1385	that do not fit into the normal tetx encoding will be replaced with	1681	do not fit into the normal text encoding will be replaced with characters
1386	characters in the private use area.	1682	in the private use area.
1387		1683
1388	You have to obey this encoding when changing text. The advantage is	1684	You have to obey this encoding when changing text. The advantage is
1389	that C<substr> and similar functions work on screen cells and not on	1685	that C<substr> and similar functions work on screen cells and not on
1390	characters.	1686	characters.
1391		1687
…		…
1535	where one character corresponds to one screen cell. See	1831	where one character corresponds to one screen cell. See
1536	C<< $term->ROW_t >> for details.	1832	C<< $term->ROW_t >> for details.
1537		1833
1538	=item $string = $term->special_decode $text	1834	=item $string = $term->special_decode $text
1539		1835
1540	Converts rxvt-unicodes text reprsentation into a perl string. See	1836	Converts rxvt-unicodes text representation into a perl string. See
1541	C<< $term->ROW_t >> for details.	1837	C<< $term->ROW_t >> for details.
1542		1838
1543	=item $success = $term->grab_button ($button, $modifiermask)	1839	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1544		1840
		1841	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1842
1545	Registers a synchronous button grab. See the XGrabButton manpage.	1843	Register/unregister a synchronous button grab. See the XGrabButton
		1844	manpage.
1546		1845
1547	=item $success = $term->grab ($eventtime[, $sync])	1846	=item $success = $term->grab ($eventtime[, $sync])
1548		1847
1549	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1848	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1550	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1849	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1551		1850
1552	=item $term->allow_events_async	1851	=item $term->allow_events_async
1553		1852
1554	Calls XAllowEvents with AsyncBoth for the most recent grab.	1853	Calls XAllowEvents with AsyncBoth for the most recent grab.
1555		1854
…		…
1565	=item $term->ungrab	1864	=item $term->ungrab
1566		1865
1567	Calls XUngrab for the most recent grab. Is called automatically on	1866	Calls XUngrab for the most recent grab. Is called automatically on
1568	evaluation errors, as it is better to lose the grab in the error case as	1867	evaluation errors, as it is better to lose the grab in the error case as
1569	the session.	1868	the session.
		1869
		1870	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1871
		1872	=item $atom_name = $term->XGetAtomName ($atom)
		1873
		1874	=item @atoms = $term->XListProperties ($window)
		1875
		1876	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1877
		1878	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1879
		1880	=item $term->XDeleteProperty ($window, $property)
		1881
		1882	=item $window = $term->DefaultRootWindow
		1883
		1884	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1885
		1886	=item $term->XMapWindow ($window)
		1887
		1888	=item $term->XUnmapWindow ($window)
		1889
		1890	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1891
		1892	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1893
		1894	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1895
		1896	Various X or X-related functions. The C<$term> object only serves as
		1897	the source of the display, otherwise those functions map more-or-less
		1898	directory onto the X functions of the same name.
1570		1899
1571	=back	1900	=back
1572		1901
1573	=cut	1902	=cut
1574		1903
…		…
1638	my ($self, $text, $cb) = @_;	1967	my ($self, $text, $cb) = @_;
1639		1968
1640	$self->add_item ({ type => "button", text => $text, activate => $cb});	1969	$self->add_item ({ type => "button", text => $text, activate => $cb});
1641	}	1970	}
1642		1971
1643	=item $popup->add_toggle ($text, $cb, $initial_value)	1972	=item $popup->add_toggle ($text, $initial_value, $cb)
1644		1973
1645	Adds a toggle/checkbox item to the popup. Teh callback gets called	1974	Adds a toggle/checkbox item to the popup. The callback gets called
1646	whenever it gets toggled, with a boolean indicating its value as its first	1975	whenever it gets toggled, with a boolean indicating its new value as its
1647	argument.	1976	first argument.
1648		1977
1649	=cut	1978	=cut
1650		1979
1651	sub add_toggle {	1980	sub add_toggle {
1652	my ($self, $text, $cb, $value) = @_;	1981	my ($self, $text, $value, $cb) = @_;
1653		1982
1654	my $item; $item = {	1983	my $item; $item = {
1655	type => "button",	1984	type => "button",
1656	text => " $text",	1985	text => " $text",
1657	value => $value,	1986	value => $value,
…		…
1676	my $env = $self->{term}->env;	2005	my $env = $self->{term}->env;
1677	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2006	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1678	delete $env->{LC_ALL};	2007	delete $env->{LC_ALL};
1679	$env->{LC_CTYPE} = $self->{term}->locale;	2008	$env->{LC_CTYPE} = $self->{term}->locale;
1680		2009
1681	urxvt::term->new ($env, "popup",	2010	my $term = urxvt::term->new (
		2011	$env, "popup",
1682	"--perl-lib" => "", "--perl-ext-common" => "",	2012	"--perl-lib" => "", "--perl-ext-common" => "",
1683	"-pty-fd" => -1, "-sl" => 0,	2013	"-pty-fd" => -1, "-sl" => 0,
1684	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2014	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1685	"--transient-for" => $self->{term}->parent,	2015	"--transient-for" => $self->{term}->parent,
1686	"-display" => $self->{term}->display_id,	2016	"-display" => $self->{term}->display_id,
1687	"-pe" => "urxvt-popup")	2017	"-pe" => "urxvt-popup",
1688	or die "unable to create popup window\n";	2018	) or die "unable to create popup window\n";
		2019
		2020	unless (delete $term->{urxvt_popup_init_done}) {
		2021	$term->ungrab;
		2022	$term->destroy;
		2023	die "unable to initialise popup window\n";
		2024	}
1689	}	2025	}
1690		2026
1691	sub DESTROY {	2027	sub DESTROY {
1692	my ($self) = @_;	2028	my ($self) = @_;
1693		2029
…		…
1698	=back	2034	=back
1699		2035
1700	=cut	2036	=cut
1701		2037
1702	package urxvt::watcher;	2038	package urxvt::watcher;
1703
1704	@urxvt::timer::ISA = __PACKAGE__;
1705	@urxvt::iow::ISA = __PACKAGE__;
1706	@urxvt::pw::ISA = __PACKAGE__;
1707	@urxvt::iw::ISA = __PACKAGE__;
1708		2039
1709	=head2 The C<urxvt::timer> Class	2040	=head2 The C<urxvt::timer> Class
1710		2041
1711	This class implements timer watchers/events. Time is represented as a	2042	This class implements timer watchers/events. Time is represented as a
1712	fractional number of seconds since the epoch. Example:	2043	fractional number of seconds since the epoch. Example:
…		…
1716	->new	2047	->new
1717	->interval (1)	2048	->interval (1)
1718	->cb (sub {	2049	->cb (sub {
1719	$term->{overlay}->set (0, 0,	2050	$term->{overlay}->set (0, 0,
1720	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2051	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1721	});	2052	});
1722		2053
1723	=over 4	2054	=over 4
1724		2055
1725	=item $timer = new urxvt::timer	2056	=item $timer = new urxvt::timer
1726		2057
…		…
1729		2060
1730	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2061	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1731		2062
1732	Set the callback to be called when the timer triggers.	2063	Set the callback to be called when the timer triggers.
1733		2064
1734	=item $tstamp = $timer->at
1735
1736	Return the time this watcher will fire next.
1737
1738	=item $timer = $timer->set ($tstamp)	2065	=item $timer = $timer->set ($tstamp[, $interval])
1739		2066
1740	Set the time the event is generated to $tstamp.	2067	Set the time the event is generated to $tstamp (and optionally specifies a
		2068	new $interval).
1741		2069
1742	=item $timer = $timer->interval ($interval)	2070	=item $timer = $timer->interval ($interval)
1743		2071
1744	Normally (and when C<$interval> is C<0>), the timer will automatically	2072	By default (and when C<$interval> is C<0>), the timer will automatically
1745	stop after it has fired once. If C<$interval> is non-zero, then the timer	2073	stop after it has fired once. If C<$interval> is non-zero, then the timer
1746	is automatically rescheduled at the given intervals.	2074	is automatically rescheduled at the given intervals.
1747		2075
1748	=item $timer = $timer->start	2076	=item $timer = $timer->start
1749		2077
1750	Start the timer.	2078	Start the timer.
1751		2079
1752	=item $timer = $timer->start ($tstamp)	2080	=item $timer = $timer->start ($tstamp[, $interval])
1753		2081
1754	Set the event trigger time to C<$tstamp> and start the timer.	2082	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2083	also replaces the interval.
1755		2084
1756	=item $timer = $timer->after ($delay)	2085	=item $timer = $timer->after ($delay[, $interval])
1757		2086
1758	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2087	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1759		2088
1760	=item $timer = $timer->stop	2089	=item $timer = $timer->stop
1761		2090
…		…
1769		2098
1770	$term->{socket} = ...	2099	$term->{socket} = ...
1771	$term->{iow} = urxvt::iow	2100	$term->{iow} = urxvt::iow
1772	->new	2101	->new
1773	->fd (fileno $term->{socket})	2102	->fd (fileno $term->{socket})
1774	->events (urxvt::EVENT_READ)	2103	->events (urxvt::EV_READ)
1775	->start	2104	->start
1776	->cb (sub {	2105	->cb (sub {
1777	my ($iow, $revents) = @_;	2106	my ($iow, $revents) = @_;
1778	# $revents must be 1 here, no need to check	2107	# $revents must be 1 here, no need to check
1779	sysread $term->{socket}, my $buf, 8192	2108	sysread $term->{socket}, my $buf, 8192
…		…
1792	Set the callback to be called when io events are triggered. C<$reventmask>	2121	Set the callback to be called when io events are triggered. C<$reventmask>
1793	is a bitset as described in the C<events> method.	2122	is a bitset as described in the C<events> method.
1794		2123
1795	=item $iow = $iow->fd ($fd)	2124	=item $iow = $iow->fd ($fd)
1796		2125
1797	Set the filedescriptor (not handle) to watch.	2126	Set the file descriptor (not handle) to watch.
1798		2127
1799	=item $iow = $iow->events ($eventmask)	2128	=item $iow = $iow->events ($eventmask)
1800		2129
1801	Set the event mask to watch. The only allowed values are	2130	Set the event mask to watch. The only allowed values are
1802	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2131	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1803	together, or C<urxvt::EVENT_NONE>.	2132	together, or C<urxvt::EV_NONE>.
1804		2133
1805	=item $iow = $iow->start	2134	=item $iow = $iow->start
1806		2135
1807	Start watching for requested events on the given handle.	2136	Start watching for requested events on the given handle.
1808		2137
1809	=item $iow = $iow->stop	2138	=item $iow = $iow->stop
1810		2139
1811	Stop watching for events on the given filehandle.	2140	Stop watching for events on the given file handle.
1812		2141
1813	=back	2142	=back
1814		2143
1815	=head2 The C<urxvt::iw> Class	2144	=head2 The C<urxvt::iw> Class
1816		2145
…		…
1849	->new	2178	->new
1850	->start ($pid)	2179	->start ($pid)
1851	->cb (sub {	2180	->cb (sub {
1852	my ($pw, $exit_status) = @_;	2181	my ($pw, $exit_status) = @_;
1853	...	2182	...
1854	});	2183	});
1855		2184
1856	=over 4	2185	=over 4
1857		2186
1858	=item $pw = new urxvt::pw	2187	=item $pw = new urxvt::pw
1859		2188
…		…
1863		2192
1864	Set the callback to be called when the timer triggers.	2193	Set the callback to be called when the timer triggers.
1865		2194
1866	=item $pw = $timer->start ($pid)	2195	=item $pw = $timer->start ($pid)
1867		2196
1868	Tells the wqtcher to start watching for process C<$pid>.	2197	Tells the watcher to start watching for process C<$pid>.
1869		2198
1870	=item $pw = $pw->stop	2199	=item $pw = $pw->stop
1871		2200
1872	Stop the watcher.	2201	Stop the watcher.
1873		2202
…		…
1886		2215
1887	=item >= 3 - script loading and management	2216	=item >= 3 - script loading and management
1888		2217
1889	=item >=10 - all called hooks	2218	=item >=10 - all called hooks
1890		2219
1891	=item >=11 - hook reutrn values	2220	=item >=11 - hook return values
1892		2221
1893	=back	2222	=back
1894		2223
1895	=head1 AUTHOR	2224	=head1 AUTHOR
1896		2225
…		…
1898	http://software.schmorp.de/pkg/rxvt-unicode	2227	http://software.schmorp.de/pkg/rxvt-unicode
1899		2228
1900	=cut	2229	=cut
1901		2230
1902	1	2231	1
		2232
		2233	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.117 by ayin, Fri Jan 20 18:02:43 2006 UTC vs. Revision 1.180 by root, Sat Dec 26 09:42:16 2009 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.117 by ayin, Fri Jan 20 18:02:43 2006 UTC vs.
Revision 1.180 by root, Sat Dec 26 09:42:16 2009 UTC