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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.134 by root, Sat Feb 11 02:31:13 2006 UTC vs.
Revision 1.184 by sf-exg, Thu Jul 1 21:17:11 2010 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: \\\|([^\|]+)\\\|
71		74
72	Another example: Programs I use often output "absolute path: " at the	75	Another example: Programs I use often output "absolute path: " at the
…		…
98		101
99	Other extensions can extend this popup menu by pushing a code reference	102	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the	103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.	104	popup is being displayed.
102		105
103	It's sole argument is the popup menu, which can be modified. It should	106	Its sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code	107	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference	108	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as	109	will be called when the toggle changes, with the new boolean value as
107	first argument.	110	first argument.
108		111
109	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
111		114
112	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};	117	};
115		118
…		…
121		124
122	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
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.	127	popup is being displayed.
125		128
126	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
127	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.
128	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
129	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
130	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
131		134
132	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
133	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
134	C<a>s:	137	C<a>s:
135		138
136	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
138	: ()	141	: ()
139	};	142	};
140		143
141	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
142		145
…		…
149	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>
150	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
151	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
152	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
153	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
154	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.
155		164
156	=item readline (enabled by default)	165	=item readline (enabled by default)
157		166
158	A support package that tries to make editing with readline easier. At the	167	A support package that tries to make editing with readline easier. At
159	moment, it reacts to clicking with the left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
160	move the text cursor to this position. It does so by generating as many	169	move the text cursor to this position. It does so by generating as many
161	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
162	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
163		172
164	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
165		174
166	=over 4	175	=over 4
…		…
214	the message into vi commands to load the file.	223	the message into vi commands to load the file.
215		224
216	=item tabbed	225	=item tabbed
217		226
218	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
219	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
220	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
221	button per tab.	230	button per tab.
222		231
223	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
224	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,
…		…
234	URxvt.tabbed.tab-bg: <colour-index, default 1>	243	URxvt.tabbed.tab-bg: <colour-index, default 1>
235		244
236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid	245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
237	indices.	246	indices.
238		247
239	=item mark-urls	248	=item matcher
240		249
241	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
242	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
243	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
244	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.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
245		276
246	=item xim-onthespot	277	=item xim-onthespot
247		278
248	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
249	not work perfectly, and some input methods don't seem to work well with	280	not work perfectly, and some input methods don't seem to work well with
250	OnTheSpot editing in general, but it seems to work at leats for SCIM and	281	OnTheSpot editing in general, but it seems to work at least for SCIM and
251	kinput2.	282	kinput2.
252		283
253	You enable it by specifying this extension and a preedit style of	284	You enable it by specifying this extension and a preedit style of
254	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
255		286
256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257		288
258	=item automove-background	289	=item kuake<hotkey>
259		290
260	This is basically a one-line extension that dynamically changes the background pixmap offset	291	A very primitive quake-console-like extension. It was inspired by a
261	to the window position, in effect creating the same effect as pseudo transparency with	292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
262	a custom pixmap. No scaling is supported in this mode. Exmaple:	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.
263		296
264	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	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.
265		313
266	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
267		315
268	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
269	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
270	similar-looking ascii character.	318	similar-looking ascii character.
271		319
272	=item digital-clock	320	=item digital-clock
273		321
274	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
275		323
276	=item remote-clipboard	324	=item remote-clipboard
277		325
278	Somewhat of a misnomer, this extension adds two menu entries to the	326	Somewhat of a misnomer, this extension adds two menu entries to the
279	selection popup that allows one ti run external commands to store the	327	selection popup that allows one to run external commands to store the
280	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
281		329
282	We use it to implement a "distributed selection mechanism", which just	330	We use it to implement a "distributed selection mechanism", which just
283	means that one command uploads the file to a remote server, and another	331	means that one command uploads the file to a remote server, and another
284	reads it.	332	reads it.
…		…
293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
295		343
296	=item selection-pastebin	344	=item selection-pastebin
297		345
298	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
299	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
300	not currently secure for use in a multiuser environment as it writes to	348	not currently secure for use in a multiuser environment as it writes to
301	F</tmp> directly.).	349	F</tmp> directly.).
302		350
303	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
319	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
320	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
321	for the filename):	369	for the filename):
322		370
323	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 whether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-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<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
324		391
325	=item example-refresh-hooks	392	=item example-refresh-hooks
326		393
327	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
328	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
350		417
351	=over 4	418	=over 4
352		419
353	=item $text	420	=item $text
354		421
355	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
356	always represents one screen cell. See L<ROW_t> for a discussion of this format.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
357		424
358	=item $string	425	=item $string
359		426
360	A perl text string, with an emphasis on I<text>. It can store all unicode	427	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
368		435
369	=back	436	=back
370		437
371	=head2 Extension Objects	438	=head2 Extension Objects
372		439
373	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
374	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,
375	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
376	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
377	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
378	use.	446	internal use.
379		447
380	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
381	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
382		450
383	It has the following methods and data members:	451	It has the following methods and data members:
…		…
404	=head2 Hooks	472	=head2 Hooks
405		473
406	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
407	called whenever the relevant event happens.	475	called whenever the relevant event happens.
408		476
409	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
410	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
411		479
412	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
413	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
414	relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
…		…
427	place.	495	place.
428		496
429	=item on_start $term	497	=item on_start $term
430		498
431	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
432	trying to map (display) the toplevel and returning to the mainloop.	500	trying to map (display) the toplevel and returning to the main loop.
433		501
434	=item on_destroy $term	502	=item on_destroy $term
435		503
436	Called whenever something tries to destroy terminal, when the terminal is	504	Called whenever something tries to destroy terminal, when the terminal is
437	still fully functional (not for long, though).	505	still fully functional (not for long, though).
…		…
464		532
465	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
466	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
467	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
468		536
469	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.
470		538
471	=item on_sel_extend $term	539	=item on_sel_extend $term
472		540
473	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
474	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
475	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
476	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
477	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
478	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
479		547
480	See the F<selection> example extension.	548	See the F<selection> example extension.
481		549
482	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
483		551
484	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
485	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
486	show this many lines of scrollback.	554	show this many lines of scrollback.
487		555
488	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
489		557
…		…
493		561
494	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,
495	$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
496	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
497		565
498	=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
499		577
500	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
501	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
502	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
503	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,
504	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
505	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	}
506		594
507	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,
508	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
509	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.
510		601
511	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
512		603
513	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
514	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
…		…
535	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
536	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
537		628
538	=item on_refresh_begin $term	629	=item on_refresh_begin $term
539		630
540	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
541	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
542	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
543	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
544		635
545	=item on_refresh_end $term	636	=item on_refresh_end $term
546		637
547	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>.
548		639
549	=item on_user_command $term, $string	640	=item on_user_command $term, $string
550		641
551	Called whenever the a user-configured event is being activated (e.g. via	642	Called whenever a user-configured event is being activated (e.g. via
552	a C<perl:string> action bound to a key, see description of the B<keysym>	643	a C<perl:string> action bound to a key, see description of the B<keysym>
553	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
554		645
555	The event is simply the action string. This interface is assumed to change	646	The event is simply the action string. This interface is assumed to change
556	slightly in the future.	647	slightly in the future.
557		648
558	=item on_resize_all_windows $tern, $new_width, $new_height	649	=item on_resize_all_windows $tern, $new_width, $new_height
559		650
560	Called just after the new window size has been calculcated, but before	651	Called just after the new window size has been calculated, but before
561	windows are actually being resized or hints are being set. If this hook	652	windows are actually being resized or hints are being set. If this hook
562	returns TRUE, setting of the window hints is being skipped.	653	returns TRUE, setting of the window hints is being skipped.
563		654
564	=item on_x_event $term, $event	655	=item on_x_event $term, $event
565		656
566	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
567	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
568	members are not passed.	659	members are not passed.
569		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
570	=item on_focus_in $term	665	=item on_focus_in $term
571		666
572	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
573	does focus in processing.	668	does focus in processing.
574		669
575	=item on_focus_out $term	670	=item on_focus_out $term
576		671
577	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
578	focus out processing.	673	focus out processing.
579		674
580	=item on_configure_notify $term, $event	675	=item on_configure_notify $term, $event
581		676
582	=item on_property_notify $term, $event	677	=item on_property_notify $term, $event
…		…
593		688
594	=item on_map_notify $term, $event	689	=item on_map_notify $term, $event
595		690
596	=item on_unmap_notify $term, $event	691	=item on_unmap_notify $term, $event
597		692
598	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
599	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the event will be ignored by rxvt-unicode.
600		695
601	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
602	manpage), with the additional members C<row> and C<col>, which are the	697	manpage), with the additional members C<row> and C<col>, which are the
603	(real, not screen-based) row and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
604		699
…		…
613		708
614	=item on_wm_delete_window $term, $event	709	=item on_wm_delete_window $term, $event
615		710
616	Called when various types of ClientMessage events are received (all with	711	Called when various types of ClientMessage events are received (all with
617	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		713
		714	=item on_bell $term
		715
		716	Called on receipt of a bell character.
618		717
619	=back	718	=back
620		719
621	=cut	720	=cut
622		721
…		…
665	The current terminal. This variable stores the current C<urxvt::term>	764	The current terminal. This variable stores the current C<urxvt::term>
666	object, whenever a callback/hook is executing.	765	object, whenever a callback/hook is executing.
667		766
668	=item @urxvt::TERM_INIT	767	=item @urxvt::TERM_INIT
669		768
670	All coderefs in this array will be called as methods of the next newly	769	All code references in this array will be called as methods of the next newly
671	created C<urxvt::term> object (during the C<on_init> phase). The array	770	created C<urxvt::term> object (during the C<on_init> phase). The array
672	gets cleared before the codereferences that were in it are being executed,	771	gets cleared before the code references that were in it are being executed,
673	so coderefs can push themselves onto it again if they so desire.	772	so references can push themselves onto it again if they so desire.
674		773
675	This complements to the perl-eval commandline option, but gets executed	774	This complements to the perl-eval command line option, but gets executed
676	first.	775	first.
677		776
678	=item @urxvt::TERM_EXT	777	=item @urxvt::TERM_EXT
679		778
680	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	779	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
705	Messages have a size limit of 1023 bytes currently.	804	Messages have a size limit of 1023 bytes currently.
706		805
707	=item @terms = urxvt::termlist	806	=item @terms = urxvt::termlist
708		807
709	Returns all urxvt::term objects that exist in this process, regardless of	808	Returns all urxvt::term objects that exist in this process, regardless of
710	wether they are started, being destroyed etc., so be careful. Only term	809	whether they are started, being destroyed etc., so be careful. Only term
711	objects that have perl extensions attached will be returned (because there	810	objects that have perl extensions attached will be returned (because there
712	is no urxvt::term objet associated with others).	811	is no urxvt::term objet associated with others).
713		812
714	=item $time = urxvt::NOW	813	=item $time = urxvt::NOW
715		814
…		…
853	local $TERM = shift;	952	local $TERM = shift;
854	my $htype = shift;	953	my $htype = shift;
855		954
856	if ($htype == 0) { # INIT	955	if ($htype == 0) { # INIT
857	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	956	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
858		957
859	my %ext_arg;	958	my %ext_arg;
860		959
861	{	960	{
862	my @init = @TERM_INIT;	961	my @init = @TERM_INIT;
863	@TERM_INIT = ();	962	@TERM_INIT = ();
…		…
897		996
898	if (my $cb = $TERM->{_hook}[$htype]) {	997	if (my $cb = $TERM->{_hook}[$htype]) {
899	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	998	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
900	if $verbosity >= 10;	999	if $verbosity >= 10;
901		1000
902	keys %$cb;	1001	for my $pkg (keys %$cb) {
903
904	while (my ($pkg, $cb) = each %$cb) {
905	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1002	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
906	$retval \|\|= $retval_;	1003	$retval \|\|= $retval_;
907		1004
908	if ($@) {	1005	if ($@) {
909	$TERM->ungrab; # better to lose the grab than the session	1006	$TERM->ungrab; # better to lose the grab than the session
910	warn $@;	1007	warn $@;
…		…
926	$retval	1023	$retval
927	}	1024	}
928		1025
929	sub SET_COLOR($$$) {	1026	sub SET_COLOR($$$) {
930	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1027	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1028	}
		1029
		1030	sub rend2mask {
		1031	no strict 'refs';
		1032	my ($str, $mask) = (@_, 0);
		1033	my %color = ( fg => undef, bg => undef );
		1034	my @failed;
		1035	for my $spec ( split /\s+/, $str ) {
		1036	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1037	$color{lc($1)} = $2;
		1038	} else {
		1039	my $neg = $spec =~ s/^[-^]//;
		1040	unless ( exists &{"RS_$spec"} ) {
		1041	push @failed, $spec;
		1042	next;
		1043	}
		1044	my $cur = &{"RS_$spec"};
		1045	if ( $neg ) {
		1046	$mask &= ~$cur;
		1047	} else {
		1048	$mask \|= $cur;
		1049	}
		1050	}
		1051	}
		1052	($mask, @color{qw(fg bg)}, \@failed)
931	}	1053	}
932		1054
933	# urxvt::term::extension	1055	# urxvt::term::extension
934		1056
935	package urxvt::term::extension;	1057	package urxvt::term::extension;
…		…
1006	is that you cannot use blocking APIs, but the non-blocking variant should	1128	is that you cannot use blocking APIs, but the non-blocking variant should
1007	work.	1129	work.
1008		1130
1009	=cut	1131	=cut
1010		1132
1011	our $VERSION = 1;	1133	our $VERSION = '5.23';
1012		1134
1013	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1135	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1014	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1136	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1015		1137
1016	sub timer {	1138	sub timer {
…		…
1018		1140
1019	my $cb = $arg{cb};	1141	my $cb = $arg{cb};
1020		1142
1021	urxvt::timer	1143	urxvt::timer
1022	->new	1144	->new
1023	->start (urxvt::NOW + $arg{after})	1145	->after ($arg{after}, $arg{interval})
1024	->cb (sub {	1146	->cb ($arg{interval} ? $cb : sub {
1025	$_[0]->stop; # need to cancel manually	1147	$_[0]->stop; # need to cancel manually
1026	$cb->();	1148	$cb->();
1027	})	1149	})
1028	}	1150	}
1029		1151
1030	sub io {	1152	sub io {
1031	my ($class, %arg) = @_;	1153	my ($class, %arg) = @_;
1032		1154
1033	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
		1156	my $fd = fileno $arg{fh};
		1157	defined $fd or $fd = $arg{fh};
1034		1158
1035	bless [$arg{fh}, urxvt::iow	1159	bless [$arg{fh}, urxvt::iow
1036	->new	1160	->new
1037	->fd (fileno $arg{fh})	1161	->fd ($fd)
1038	->events (($arg{poll} =~ /r/ ? 1 : 0)	1162	->events (($arg{poll} =~ /r/ ? 1 : 0)
1039	\| ($arg{poll} =~ /w/ ? 2 : 0))	1163	\| ($arg{poll} =~ /w/ ? 2 : 0))
1040	->start	1164	->start
1041	->cb (sub {	1165	->cb ($cb)
1042	$cb->(($_[1] & 1 ? 'r' : '')
1043	. ($_[1] & 2 ? 'w' : ''));
1044	})],
1045	urxvt::anyevent::	1166	], urxvt::anyevent::
		1167	}
		1168
		1169	sub idle {
		1170	my ($class, %arg) = @_;
		1171
		1172	my $cb = $arg{cb};
		1173
		1174	urxvt::iw
		1175	->new
		1176	->start
		1177	->cb ($cb)
		1178	}
		1179
		1180	sub child {
		1181	my ($class, %arg) = @_;
		1182
		1183	my $cb = $arg{cb};
		1184
		1185	urxvt::pw
		1186	->new
		1187	->start ($arg{pid})
		1188	->cb (sub {
		1189	$_[0]->stop; # need to cancel manually
		1190	$cb->($_[0]->rpid, $_[0]->rstatus);
		1191	})
1046	}	1192	}
1047		1193
1048	sub DESTROY {	1194	sub DESTROY {
1049	$_[0][1]->stop;	1195	$_[0][1]->stop;
1050	}	1196	}
1051		1197
1052	sub condvar {	1198	sub one_event {
1053	bless \my $flag, urxvt::anyevent::condvar::
1054	}
1055
1056	sub urxvt::anyevent::condvar::broadcast {
1057	${$_[0]}++;
1058	}
1059
1060	sub urxvt::anyevent::condvar::wait {
1061	unless (${$_[0]}) {
1062	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1199	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1063	}
1064	}	1200	}
1065		1201
1066	package urxvt::term;	1202	package urxvt::term;
1067		1203
1068	=head2 The C<urxvt::term> Class	1204	=head2 The C<urxvt::term> Class
…		…
1155		1291
1156	Returns true if the option specified by C<$optval> is enabled, and	1292	Returns true if the option specified by C<$optval> is enabled, and
1157	optionally change it. All option values are stored by name in the hash	1293	optionally change it. All option values are stored by name in the hash
1158	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1294	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1159		1295
1160	Here is a a likely non-exhaustive list of option names, please see the	1296	Here is a likely non-exhaustive list of option names, please see the
1161	source file F</src/optinc.h> to see the actual list:	1297	source file F</src/optinc.h> to see the actual list:
1162		1298
1163	borderLess console cursorBlink cursorUnderline hold iconic insecure	1299	borderLess console cursorBlink cursorUnderline hold iconic insecure
1164	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1300	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1165	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1301	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1182	likely change).	1318	likely change).
1183		1319
1184	Please note that resource strings will currently only be freed when the	1320	Please note that resource strings will currently only be freed when the
1185	terminal is destroyed, so changing options frequently will eat memory.	1321	terminal is destroyed, so changing options frequently will eat memory.
1186		1322
1187	Here is a a likely non-exhaustive list of resource names, not all of which	1323	Here is a likely non-exhaustive list of resource names, not all of which
1188	are supported in every build, please see the source file F</src/rsinc.h>	1324	are supported in every build, please see the source file F</src/rsinc.h>
1189	to see the actual list:	1325	to see the actual list:
1190		1326
1191	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1327	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1192	borderLess color cursorBlink cursorUnderline cutchars delete_key	1328	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1193	display_name embed ext_bwidth fade font geometry hold iconName	1329	display_name embed ext_bwidth fade font geometry hold iconName
1194	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1330	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1195	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1331	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1196	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1332	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1197	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1333	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1198	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1334	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1199	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1335	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1200	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1336	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1201	secondaryScreen secondaryScroll selectstyle shade term_name title	1337	secondaryScreen secondaryScroll shade term_name title
1202	transient_for transparent transparent_all tripleclickwords utmpInhibit	1338	transient_for transparent transparent_all tripleclickwords utmpInhibit
1203	visualBell	1339	visualBell
1204		1340
1205	=cut	1341	=cut
1206		1342
1207	sub resource($$;$) {	1343	sub resource($$;$) {
1208	my ($self, $name) = (shift, shift);	1344	my ($self, $name) = (shift, shift);
1209	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1345	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1210	&urxvt::term::_resource	1346	goto &urxvt::term::_resource
1211	}	1347	}
1212		1348
1213	=item $value = $term->x_resource ($pattern)	1349	=item $value = $term->x_resource ($pattern)
1214		1350
1215	Returns the X-Resource for the given pattern, excluding the program or	1351	Returns the X-Resource for the given pattern, excluding the program or
…		…
1240		1376
1241	=item ($row, $col) = $term->selection_beg ([$row, $col])	1377	=item ($row, $col) = $term->selection_beg ([$row, $col])
1242		1378
1243	=item ($row, $col) = $term->selection_end ([$row, $col])	1379	=item ($row, $col) = $term->selection_end ([$row, $col])
1244		1380
1245	Return the current values of the selection mark, begin or end positions,	1381	Return the current values of the selection mark, begin or end positions.
1246	and optionally set them to new values.	1382
		1383	When arguments are given, then the selection coordinates are set to
		1384	C<$row> and C<$col>, and the selection screen is set to the current
		1385	screen.
		1386
		1387	=item $screen = $term->selection_screen ([$screen])
		1388
		1389	Returns the current selection screen, and then optionally sets it.
1247		1390
1248	=item $term->selection_make ($eventtime[, $rectangular])	1391	=item $term->selection_make ($eventtime[, $rectangular])
1249		1392
1250	Tries to make a selection as set by C<selection_beg> and	1393	Tries to make a selection as set by C<selection_beg> and
1251	C<selection_end>. If C<$rectangular> is true (default: false), a	1394	C<selection_end>. If C<$rectangular> is true (default: false), a
1252	rectangular selection will be made. This is the prefered function to make	1395	rectangular selection will be made. This is the prefered function to make
1253	a selection.	1396	a selection.
1254		1397
1255	=item $success = $term->selection_grab ($eventtime)	1398	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1256		1399
1257	Try to request the primary selection text from the server (for example, as	1400	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1401	true) selection from the server. The corresponding text can be set
1258	set by the next method). No visual feedback will be given. This function	1402	with the next method. No visual feedback will be given. This function
1259	is mostly useful from within C<on_sel_grab> hooks.	1403	is mostly useful from within C<on_sel_grab> hooks.
1260		1404
1261	=item $oldtext = $term->selection ([$newtext])	1405	=item $oldtext = $term->selection ([$newtext, $clipboard])
1262		1406
1263	Return the current selection text and optionally replace it by C<$newtext>.	1407	Return the current selection (clipboard if C<$clipboard> is true) text
		1408	and optionally replace it by C<$newtext>.
		1409
		1410	=item $term->selection_clear ([$clipboard])
		1411
		1412	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1264		1413
1265	=item $term->overlay_simple ($x, $y, $text)	1414	=item $term->overlay_simple ($x, $y, $text)
1266		1415
1267	Create a simple multi-line overlay box. See the next method for details.	1416	Create a simple multi-line overlay box. See the next method for details.
1268		1417
…		…
1298		1447
1299	The methods currently supported on C<urxvt::overlay> objects are:	1448	The methods currently supported on C<urxvt::overlay> objects are:
1300		1449
1301	=over 4	1450	=over 4
1302		1451
1303	=item $overlay->set ($x, $y, $text, $rend)	1452	=item $overlay->set ($x, $y, $text[, $rend])
1304		1453
1305	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1454	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1306	text in rxvt-unicode's special encoding and an array of rendition values	1455	text in rxvt-unicode's special encoding and an array of rendition values
1307	at a specific position inside the overlay.	1456	at a specific position inside the overlay.
		1457
		1458	If C<$rend> is missing, then the rendition will not be changed.
1308		1459
1309	=item $overlay->hide	1460	=item $overlay->hide
1310		1461
1311	If visible, hide the overlay, but do not destroy it.	1462	If visible, hide the overlay, but do not destroy it.
1312		1463
…		…
1474	=item $env = $term->env	1625	=item $env = $term->env
1475		1626
1476	Returns a copy of the environment in effect for the terminal as a hashref	1627	Returns a copy of the environment in effect for the terminal as a hashref
1477	similar to C<\%ENV>.	1628	similar to C<\%ENV>.
1478		1629
		1630	=item @envv = $term->envv
		1631
		1632	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1633
		1634	=item @argv = $term->argv
		1635
		1636	Return the argument vector as this terminal, similar to @ARGV, but
		1637	includes the program name as first element.
		1638
1479	=cut	1639	=cut
1480		1640
1481	sub env {	1641	sub env {
1482	if (my $env = $_[0]->_env) {
1483	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1642	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1484	} else {
1485	+{ %ENV }
1486	}
1487	}	1643	}
1488		1644
1489	=item $modifiermask = $term->ModLevel3Mask	1645	=item $modifiermask = $term->ModLevel3Mask
1490		1646
1491	=item $modifiermask = $term->ModMetaMask	1647	=item $modifiermask = $term->ModMetaMask
…		…
1499		1655
1500	Returns the currently displayed screen (0 primary, 1 secondary).	1656	Returns the currently displayed screen (0 primary, 1 secondary).
1501		1657
1502	=item $cursor_is_hidden = $term->hidden_cursor	1658	=item $cursor_is_hidden = $term->hidden_cursor
1503		1659
1504	Returns wether the cursor is currently hidden or not.	1660	Returns whether the cursor is currently hidden or not.
1505		1661
1506	=item $view_start = $term->view_start ([$newvalue])	1662	=item $view_start = $term->view_start ([$newvalue])
1507		1663
1508	Returns the row number of the topmost displayed line. Maximum value is	1664	Returns the row number of the topmost displayed line. Maximum value is
1509	C<0>, which displays the normal terminal contents. Lower values scroll	1665	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1517		1673
1518	Used after changing terminal contents to display them.	1674	Used after changing terminal contents to display them.
1519		1675
1520	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1676	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1521		1677
1522	Returns the text of the entire row with number C<$row_number>. Row C<0>	1678	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1523	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1679	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1524	terminal line. The scrollback buffer starts at line C<-1> and extends to
1525	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1680	terminal line. Nothing will be returned if a nonexistent line
1526	is requested.	1681	is requested.
1527		1682
1528	If C<$new_text> is specified, it will replace characters in the current	1683	If C<$new_text> is specified, it will replace characters in the current
1529	line, starting at column C<$start_col> (default C<0>), which is useful	1684	line, starting at column C<$start_col> (default C<0>), which is useful
1530	to replace only parts of a line. The font index in the rendition will	1685	to replace only parts of a line. The font index in the rendition will
1531	automatically be updated.	1686	automatically be updated.
1532		1687
1533	C<$text> is in a special encoding: tabs and wide characters that use more	1688	C<$text> is in a special encoding: tabs and wide characters that use more
1534	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1689	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1535	characters. Characters with combining characters and other characters that	1690	characters. Characters with combining characters and other characters that
1536	do not fit into the normal tetx encoding will be replaced with characters	1691	do not fit into the normal text encoding will be replaced with characters
1537	in the private use area.	1692	in the private use area.
1538		1693
1539	You have to obey this encoding when changing text. The advantage is	1694	You have to obey this encoding when changing text. The advantage is
1540	that C<substr> and similar functions work on screen cells and not on	1695	that C<substr> and similar functions work on screen cells and not on
1541	characters.	1696	characters.
…		…
1686	where one character corresponds to one screen cell. See	1841	where one character corresponds to one screen cell. See
1687	C<< $term->ROW_t >> for details.	1842	C<< $term->ROW_t >> for details.
1688		1843
1689	=item $string = $term->special_decode $text	1844	=item $string = $term->special_decode $text
1690		1845
1691	Converts rxvt-unicodes text reprsentation into a perl string. See	1846	Converts rxvt-unicodes text representation into a perl string. See
1692	C<< $term->ROW_t >> for details.	1847	C<< $term->ROW_t >> for details.
1693		1848
1694	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1849	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1695		1850
1696	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1851	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1699	manpage.	1854	manpage.
1700		1855
1701	=item $success = $term->grab ($eventtime[, $sync])	1856	=item $success = $term->grab ($eventtime[, $sync])
1702		1857
1703	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1858	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1704	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1859	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1705		1860
1706	=item $term->allow_events_async	1861	=item $term->allow_events_async
1707		1862
1708	Calls XAllowEvents with AsyncBoth for the most recent grab.	1863	Calls XAllowEvents with AsyncBoth for the most recent grab.
1709		1864
…		…
1716	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1871	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1717	recent grab.	1872	recent grab.
1718		1873
1719	=item $term->ungrab	1874	=item $term->ungrab
1720		1875
1721	Calls XUngrab for the most recent grab. Is called automatically on	1876	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1722	evaluation errors, as it is better to lose the grab in the error case as	1877	evaluation errors, as it is better to lose the grab in the error case as
1723	the session.	1878	the session.
1724		1879
1725	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1880	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1726		1881
…		…
1728		1883
1729	=item @atoms = $term->XListProperties ($window)	1884	=item @atoms = $term->XListProperties ($window)
1730		1885
1731	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1886	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1732		1887
1733	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1888	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1734		1889
1735	=item $term->XDeleteProperty ($window, $property)	1890	=item $term->XDeleteProperty ($window, $property)
1736		1891
1737	=item $window = $term->DefaultRootWindow	1892	=item $window = $term->DefaultRootWindow
1738		1893
…		…
1748		1903
1749	=item $term->XChangeInput ($window, $add_events[, $del_events])	1904	=item $term->XChangeInput ($window, $add_events[, $del_events])
1750		1905
1751	Various X or X-related functions. The C<$term> object only serves as	1906	Various X or X-related functions. The C<$term> object only serves as
1752	the source of the display, otherwise those functions map more-or-less	1907	the source of the display, otherwise those functions map more-or-less
1753	directory onto the X functions of the same name.	1908	directly onto the X functions of the same name.
1754		1909
1755	=back	1910	=back
1756		1911
1757	=cut	1912	=cut
1758		1913
…		…
1860	my $env = $self->{term}->env;	2015	my $env = $self->{term}->env;
1861	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2016	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1862	delete $env->{LC_ALL};	2017	delete $env->{LC_ALL};
1863	$env->{LC_CTYPE} = $self->{term}->locale;	2018	$env->{LC_CTYPE} = $self->{term}->locale;
1864		2019
1865	urxvt::term->new ($env, "popup",	2020	my $term = urxvt::term->new (
		2021	$env, "popup",
1866	"--perl-lib" => "", "--perl-ext-common" => "",	2022	"--perl-lib" => "", "--perl-ext-common" => "",
1867	"-pty-fd" => -1, "-sl" => 0,	2023	"-pty-fd" => -1, "-sl" => 0,
1868	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2024	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1869	"--transient-for" => $self->{term}->parent,	2025	"--transient-for" => $self->{term}->parent,
1870	"-display" => $self->{term}->display_id,	2026	"-display" => $self->{term}->display_id,
1871	"-pe" => "urxvt-popup")	2027	"-pe" => "urxvt-popup",
1872	or die "unable to create popup window\n";	2028	) or die "unable to create popup window\n";
		2029
		2030	unless (delete $term->{urxvt_popup_init_done}) {
		2031	$term->ungrab;
		2032	$term->destroy;
		2033	die "unable to initialise popup window\n";
		2034	}
1873	}	2035	}
1874		2036
1875	sub DESTROY {	2037	sub DESTROY {
1876	my ($self) = @_;	2038	my ($self) = @_;
1877		2039
…		…
1882	=back	2044	=back
1883		2045
1884	=cut	2046	=cut
1885		2047
1886	package urxvt::watcher;	2048	package urxvt::watcher;
1887
1888	@urxvt::timer::ISA = __PACKAGE__;
1889	@urxvt::iow::ISA = __PACKAGE__;
1890	@urxvt::pw::ISA = __PACKAGE__;
1891	@urxvt::iw::ISA = __PACKAGE__;
1892		2049
1893	=head2 The C<urxvt::timer> Class	2050	=head2 The C<urxvt::timer> Class
1894		2051
1895	This class implements timer watchers/events. Time is represented as a	2052	This class implements timer watchers/events. Time is represented as a
1896	fractional number of seconds since the epoch. Example:	2053	fractional number of seconds since the epoch. Example:
…		…
1900	->new	2057	->new
1901	->interval (1)	2058	->interval (1)
1902	->cb (sub {	2059	->cb (sub {
1903	$term->{overlay}->set (0, 0,	2060	$term->{overlay}->set (0, 0,
1904	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2061	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1905	});	2062	});
1906		2063
1907	=over 4	2064	=over 4
1908		2065
1909	=item $timer = new urxvt::timer	2066	=item $timer = new urxvt::timer
1910		2067
…		…
1913		2070
1914	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2071	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1915		2072
1916	Set the callback to be called when the timer triggers.	2073	Set the callback to be called when the timer triggers.
1917		2074
1918	=item $tstamp = $timer->at
1919
1920	Return the time this watcher will fire next.
1921
1922	=item $timer = $timer->set ($tstamp)	2075	=item $timer = $timer->set ($tstamp[, $interval])
1923		2076
1924	Set the time the event is generated to $tstamp.	2077	Set the time the event is generated to $tstamp (and optionally specifies a
		2078	new $interval).
1925		2079
1926	=item $timer = $timer->interval ($interval)	2080	=item $timer = $timer->interval ($interval)
1927		2081
1928	Normally (and when C<$interval> is C<0>), the timer will automatically	2082	By default (and when C<$interval> is C<0>), the timer will automatically
1929	stop after it has fired once. If C<$interval> is non-zero, then the timer	2083	stop after it has fired once. If C<$interval> is non-zero, then the timer
1930	is automatically rescheduled at the given intervals.	2084	is automatically rescheduled at the given intervals.
1931		2085
1932	=item $timer = $timer->start	2086	=item $timer = $timer->start
1933		2087
1934	Start the timer.	2088	Start the timer.
1935		2089
1936	=item $timer = $timer->start ($tstamp)	2090	=item $timer = $timer->start ($tstamp[, $interval])
1937		2091
1938	Set the event trigger time to C<$tstamp> and start the timer.	2092	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2093	also replaces the interval.
1939		2094
1940	=item $timer = $timer->after ($delay)	2095	=item $timer = $timer->after ($delay[, $interval])
1941		2096
1942	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2097	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1943		2098
1944	=item $timer = $timer->stop	2099	=item $timer = $timer->stop
1945		2100
…		…
1953		2108
1954	$term->{socket} = ...	2109	$term->{socket} = ...
1955	$term->{iow} = urxvt::iow	2110	$term->{iow} = urxvt::iow
1956	->new	2111	->new
1957	->fd (fileno $term->{socket})	2112	->fd (fileno $term->{socket})
1958	->events (urxvt::EVENT_READ)	2113	->events (urxvt::EV_READ)
1959	->start	2114	->start
1960	->cb (sub {	2115	->cb (sub {
1961	my ($iow, $revents) = @_;	2116	my ($iow, $revents) = @_;
1962	# $revents must be 1 here, no need to check	2117	# $revents must be 1 here, no need to check
1963	sysread $term->{socket}, my $buf, 8192	2118	sysread $term->{socket}, my $buf, 8192
…		…
1976	Set the callback to be called when io events are triggered. C<$reventmask>	2131	Set the callback to be called when io events are triggered. C<$reventmask>
1977	is a bitset as described in the C<events> method.	2132	is a bitset as described in the C<events> method.
1978		2133
1979	=item $iow = $iow->fd ($fd)	2134	=item $iow = $iow->fd ($fd)
1980		2135
1981	Set the filedescriptor (not handle) to watch.	2136	Set the file descriptor (not handle) to watch.
1982		2137
1983	=item $iow = $iow->events ($eventmask)	2138	=item $iow = $iow->events ($eventmask)
1984		2139
1985	Set the event mask to watch. The only allowed values are	2140	Set the event mask to watch. The only allowed values are
1986	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2141	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1987	together, or C<urxvt::EVENT_NONE>.	2142	together, or C<urxvt::EV_NONE>.
1988		2143
1989	=item $iow = $iow->start	2144	=item $iow = $iow->start
1990		2145
1991	Start watching for requested events on the given handle.	2146	Start watching for requested events on the given handle.
1992		2147
1993	=item $iow = $iow->stop	2148	=item $iow = $iow->stop
1994		2149
1995	Stop watching for events on the given filehandle.	2150	Stop watching for events on the given file handle.
1996		2151
1997	=back	2152	=back
1998		2153
1999	=head2 The C<urxvt::iw> Class	2154	=head2 The C<urxvt::iw> Class
2000		2155
…		…
2033	->new	2188	->new
2034	->start ($pid)	2189	->start ($pid)
2035	->cb (sub {	2190	->cb (sub {
2036	my ($pw, $exit_status) = @_;	2191	my ($pw, $exit_status) = @_;
2037	...	2192	...
2038	});	2193	});
2039		2194
2040	=over 4	2195	=over 4
2041		2196
2042	=item $pw = new urxvt::pw	2197	=item $pw = new urxvt::pw
2043		2198
…		…
2047		2202
2048	Set the callback to be called when the timer triggers.	2203	Set the callback to be called when the timer triggers.
2049		2204
2050	=item $pw = $timer->start ($pid)	2205	=item $pw = $timer->start ($pid)
2051		2206
2052	Tells the wqtcher to start watching for process C<$pid>.	2207	Tells the watcher to start watching for process C<$pid>.
2053		2208
2054	=item $pw = $pw->stop	2209	=item $pw = $pw->stop
2055		2210
2056	Stop the watcher.	2211	Stop the watcher.
2057		2212
…		…
2070		2225
2071	=item >= 3 - script loading and management	2226	=item >= 3 - script loading and management
2072		2227
2073	=item >=10 - all called hooks	2228	=item >=10 - all called hooks
2074		2229
2075	=item >=11 - hook reutrn values	2230	=item >=11 - hook return values
2076		2231
2077	=back	2232	=back
2078		2233
2079	=head1 AUTHOR	2234	=head1 AUTHOR
2080		2235
…		…
2082	http://software.schmorp.de/pkg/rxvt-unicode	2237	http://software.schmorp.de/pkg/rxvt-unicode
2083		2238
2084	=cut	2239	=cut
2085		2240
2086	1	2241	1
		2242
		2243	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.134 by root, Sat Feb 11 02:31:13 2006 UTC vs. Revision 1.184 by sf-exg, Thu Jul 1 21:17:11 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.134 by root, Sat Feb 11 02:31:13 2006 UTC vs.
Revision 1.184 by sf-exg, Thu Jul 1 21:17:11 2010 UTC