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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.132 by root, Mon Feb 6 05:40:15 2006 UTC vs.
Revision 1.185 by sf-exg, Fri Jul 2 12:44:45 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
…		…
94	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
95		98
96	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
97	runtime.	100	runtime.
98		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
99	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
100		120
101	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
102	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
103	evaluation, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
104		124
105	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
106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
107	popup is displayed.	127	popup is being displayed.
108		128
109	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
110	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.
111	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
112	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
113	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
114		134
115	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
116	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
117	C<a>s:	137	C<a>s:
118		138
119	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
120	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
121	: ()	141	: ()
122	};	142	};
123		143
124	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
125		145
…		…
132	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>
133	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
134	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
135	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
136	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
137	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.
138		164
139	=item readline (enabled by default)	165	=item readline (enabled by default)
140		166
141	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
142	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
143	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
144	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
145	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
146		172
147	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
148		174
149	=over 4	175	=over 4
…		…
197	the message into vi commands to load the file.	223	the message into vi commands to load the file.
198		224
199	=item tabbed	225	=item tabbed
200		226
201	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
202	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
203	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
204	button per tab.	230	button per tab.
205		231
206	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
207	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,
…		…
217	URxvt.tabbed.tab-bg: <colour-index, default 1>	243	URxvt.tabbed.tab-bg: <colour-index, default 1>
218		244
219	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
220	indices.	246	indices.
221		247
222	=item mark-urls	248	=item matcher
223		249
224	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
225	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
226	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
227	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
228		276
229	=item xim-onthespot	277	=item xim-onthespot
230		278
231	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
232	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
233	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
234	kinput2.	282	kinput2.
235		283
236	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
237	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
238		286
239	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
240		288
241	=item automove-background	289	=item kuake<hotkey>
242		290
243	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
244	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
245	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.
246		296
247	@@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.
248		313
249	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
250		315
251	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
252	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
253	similar-looking ascii character.	318	similar-looking ascii character.
254		319
255	=item digital-clock	320	=item digital-clock
256		321
257	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
258		323
259	=item remote-clipboard	324	=item remote-clipboard
260		325
261	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
262	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
263	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
264		329
265	We use it to implement a "distributed selection mechanism", which just	330	We use it to implement a "distributed selection mechanism", which just
266	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
267	reads it.	332	reads it.
…		…
276	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
277	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
278		343
279	=item selection-pastebin	344	=item selection-pastebin
280		345
281	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
282	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
283	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
284	F</tmp> directly.).	349	F</tmp> directly.).
285		350
286	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
302	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
303	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
304	for the filename):	369	for the filename):
305		370
306	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.
307		391
308	=item example-refresh-hooks	392	=item example-refresh-hooks
309		393
310	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
311	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
333		417
334	=over 4	418	=over 4
335		419
336	=item $text	420	=item $text
337		421
338	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
339	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.
340		424
341	=item $string	425	=item $string
342		426
343	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
…		…
351		435
352	=back	436	=back
353		437
354	=head2 Extension Objects	438	=head2 Extension Objects
355		439
356	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
357	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,
358	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
359	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
360	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
361	use.	446	internal use.
362		447
363	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
364	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
365		450
366	It has the following methods and data members:	451	It has the following methods and data members:
…		…
387	=head2 Hooks	472	=head2 Hooks
388		473
389	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
390	called whenever the relevant event happens.	475	called whenever the relevant event happens.
391		476
392	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
393	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
394		479
395	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
396	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
397	relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
…		…
410	place.	495	place.
411		496
412	=item on_start $term	497	=item on_start $term
413		498
414	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
415	trying to map (display) the toplevel and returning to the mainloop.	500	trying to map (display) the toplevel and returning to the main loop.
416		501
417	=item on_destroy $term	502	=item on_destroy $term
418		503
419	Called whenever something tries to destroy terminal, when the terminal is	504	Called whenever something tries to destroy terminal, when the terminal is
420	still fully functional (not for long, though).	505	still fully functional (not for long, though).
…		…
447		532
448	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
449	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
450	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
451		536
452	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.
453		538
454	=item on_sel_extend $term	539	=item on_sel_extend $term
455		540
456	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
457	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
458	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
459	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
460	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
461	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
462		547
463	See the F<selection> example extension.	548	See the F<selection> example extension.
464		549
465	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
466		551
467	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
468	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
469	show this many lines of scrollback.	554	show this many lines of scrollback.
470		555
471	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
472		557
…		…
476		561
477	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,
478	$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
479	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
480		565
481	=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
482		577
483	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
484	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
485	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
486	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,
487	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
488	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	}
489		594
490	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,
491	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
492	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.
493		601
494	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
495		603
496	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
497	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
…		…
518	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
519	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
520		628
521	=item on_refresh_begin $term	629	=item on_refresh_begin $term
522		630
523	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
524	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
525	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
526	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
527		635
528	=item on_refresh_end $term	636	=item on_refresh_end $term
529		637
530	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>.
531		639
532	=item on_user_command $term, $string	640	=item on_user_command $term, $string
533		641
534	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
535	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>
536	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
537		645
538	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
539	slightly in the future.	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.
540		654
541	=item on_x_event $term, $event	655	=item on_x_event $term, $event
542		656
543	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
544	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
545	members are not passed.	659	members are not passed.
546		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
547	=item on_focus_in $term	665	=item on_focus_in $term
548		666
549	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
550	does focus in processing.	668	does focus in processing.
551		669
552	=item on_focus_out $term	670	=item on_focus_out $term
553		671
554	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
555	focus out processing.	673	focus out processing.
556		674
557	=item on_configure_notify $term, $event	675	=item on_configure_notify $term, $event
558		676
559	=item on_property_notify $term, $event	677	=item on_property_notify $term, $event
…		…
570		688
571	=item on_map_notify $term, $event	689	=item on_map_notify $term, $event
572		690
573	=item on_unmap_notify $term, $event	691	=item on_unmap_notify $term, $event
574		692
575	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
576	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.
577		695
578	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
579	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
580	(real, not screen-based) row and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
581		699
…		…
590		708
591	=item on_wm_delete_window $term, $event	709	=item on_wm_delete_window $term, $event
592		710
593	Called when various types of ClientMessage events are received (all with	711	Called when various types of ClientMessage events are received (all with
594	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.
595		717
596	=back	718	=back
597		719
598	=cut	720	=cut
599		721
…		…
642	The current terminal. This variable stores the current C<urxvt::term>	764	The current terminal. This variable stores the current C<urxvt::term>
643	object, whenever a callback/hook is executing.	765	object, whenever a callback/hook is executing.
644		766
645	=item @urxvt::TERM_INIT	767	=item @urxvt::TERM_INIT
646		768
647	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
648	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
649	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,
650	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.
651		773
652	This complements to the perl-eval commandline option, but gets executed	774	This complements to the perl-eval command line option, but gets executed
653	first.	775	first.
654		776
655	=item @urxvt::TERM_EXT	777	=item @urxvt::TERM_EXT
656		778
657	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
…		…
682	Messages have a size limit of 1023 bytes currently.	804	Messages have a size limit of 1023 bytes currently.
683		805
684	=item @terms = urxvt::termlist	806	=item @terms = urxvt::termlist
685		807
686	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
687	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
688	objects that have perl extensions attached will be returned (because there	810	objects that have perl extensions attached will be returned (because there
689	is no urxvt::term objet associated with others).	811	is no urxvt::term objet associated with others).
690		812
691	=item $time = urxvt::NOW	813	=item $time = urxvt::NOW
692		814
…		…
830	local $TERM = shift;	952	local $TERM = shift;
831	my $htype = shift;	953	my $htype = shift;
832		954
833	if ($htype == 0) { # INIT	955	if ($htype == 0) { # INIT
834	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	956	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
835		957
836	my %ext_arg;	958	my %ext_arg;
837		959
838	{	960	{
839	my @init = @TERM_INIT;	961	my @init = @TERM_INIT;
840	@TERM_INIT = ();	962	@TERM_INIT = ();
…		…
854	} else {	976	} else {
855	$ext_arg{$_} \|\|= [];	977	$ext_arg{$_} \|\|= [];
856	}	978	}
857	}	979	}
858		980
859	while (my ($ext, $argv) = each %ext_arg) {	981	for my $ext (sort keys %ext_arg) {
860	my @files = grep -f $_, map "$_/$ext", @dirs;	982	my @files = grep -f $_, map "$_/$ext", @dirs;
861		983
862	if (@files) {	984	if (@files) {
863	$TERM->register_package (extension_package $files[0], $argv);	985	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
864	} else {	986	} else {
865	warn "perl extension '$ext' not found in perl library search path\n";	987	warn "perl extension '$ext' not found in perl library search path\n";
866	}	988	}
867	}	989	}
868		990
…		…
874		996
875	if (my $cb = $TERM->{_hook}[$htype]) {	997	if (my $cb = $TERM->{_hook}[$htype]) {
876	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	998	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
877	if $verbosity >= 10;	999	if $verbosity >= 10;
878		1000
879	keys %$cb;	1001	for my $pkg (keys %$cb) {
880
881	while (my ($pkg, $cb) = each %$cb) {
882	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1002	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
883	$retval \|\|= $retval_;	1003	$retval \|\|= $retval_;
884		1004
885	if ($@) {	1005	if ($@) {
886	$TERM->ungrab; # better to lose the grab than the session	1006	$TERM->ungrab; # better to lose the grab than the session
887	warn $@;	1007	warn $@;
…		…
903	$retval	1023	$retval
904	}	1024	}
905		1025
906	sub SET_COLOR($$$) {	1026	sub SET_COLOR($$$) {
907	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)
908	}	1053	}
909		1054
910	# urxvt::term::extension	1055	# urxvt::term::extension
911		1056
912	package urxvt::term::extension;	1057	package urxvt::term::extension;
…		…
983	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
984	work.	1129	work.
985		1130
986	=cut	1131	=cut
987		1132
988	our $VERSION = 1;	1133	our $VERSION = '5.23';
989		1134
990	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1135	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
991	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1136	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
992		1137
993	sub timer {	1138	sub timer {
…		…
995		1140
996	my $cb = $arg{cb};	1141	my $cb = $arg{cb};
997		1142
998	urxvt::timer	1143	urxvt::timer
999	->new	1144	->new
1000	->start (urxvt::NOW + $arg{after})	1145	->after ($arg{after}, $arg{interval})
1001	->cb (sub {	1146	->cb ($arg{interval} ? $cb : sub {
1002	$_[0]->stop; # need to cancel manually	1147	$_[0]->stop; # need to cancel manually
1003	$cb->();	1148	$cb->();
1004	})	1149	})
1005	}	1150	}
1006		1151
1007	sub io {	1152	sub io {
1008	my ($class, %arg) = @_;	1153	my ($class, %arg) = @_;
1009		1154
1010	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
		1156	my $fd = fileno $arg{fh};
		1157	defined $fd or $fd = $arg{fh};
1011		1158
1012	bless [$arg{fh}, urxvt::iow	1159	bless [$arg{fh}, urxvt::iow
1013	->new	1160	->new
1014	->fd (fileno $arg{fh})	1161	->fd ($fd)
1015	->events (($arg{poll} =~ /r/ ? 1 : 0)	1162	->events (($arg{poll} =~ /r/ ? 1 : 0)
1016	\| ($arg{poll} =~ /w/ ? 2 : 0))	1163	\| ($arg{poll} =~ /w/ ? 2 : 0))
1017	->start	1164	->start
1018	->cb (sub {	1165	->cb ($cb)
1019	$cb->(($_[1] & 1 ? 'r' : '')
1020	. ($_[1] & 2 ? 'w' : ''));
1021	})],
1022	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	})
1023	}	1192	}
1024		1193
1025	sub DESTROY {	1194	sub DESTROY {
1026	$_[0][1]->stop;	1195	$_[0][1]->stop;
1027	}	1196	}
1028		1197
1029	sub condvar {	1198	sub one_event {
1030	bless \my $flag, urxvt::anyevent::condvar::
1031	}
1032
1033	sub urxvt::anyevent::condvar::broadcast {
1034	${$_[0]}++;
1035	}
1036
1037	sub urxvt::anyevent::condvar::wait {
1038	unless (${$_[0]}) {
1039	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";
1040	}
1041	}	1200	}
1042		1201
1043	package urxvt::term;	1202	package urxvt::term;
1044		1203
1045	=head2 The C<urxvt::term> Class	1204	=head2 The C<urxvt::term> Class
…		…
1132		1291
1133	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
1134	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
1135	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.
1136		1295
1137	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
1138	source file F</src/optinc.h> to see the actual list:	1297	source file F</src/optinc.h> to see the actual list:
1139		1298
1140	borderLess console cursorBlink cursorUnderline hold iconic insecure	1299	borderLess console cursorBlink cursorUnderline hold iconic insecure
1141	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1300	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1142	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1301	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1159	likely change).	1318	likely change).
1160		1319
1161	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
1162	terminal is destroyed, so changing options frequently will eat memory.	1321	terminal is destroyed, so changing options frequently will eat memory.
1163		1322
1164	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
1165	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>
1166	to see the actual list:	1325	to see the actual list:
1167		1326
1168	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1327	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1169	borderLess color cursorBlink cursorUnderline cutchars delete_key	1328	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1170	display_name embed ext_bwidth fade font geometry hold iconName	1329	display_name embed ext_bwidth fade font geometry hold iconName
1171	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1330	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1172	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1331	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1173	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1332	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1174	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1333	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1175	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1334	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1176	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1335	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1177	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1336	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1178	secondaryScreen secondaryScroll selectstyle shade term_name title	1337	secondaryScreen secondaryScroll shade term_name title
1179	transient_for transparent transparent_all tripleclickwords utmpInhibit	1338	transient_for transparent transparent_all tripleclickwords utmpInhibit
1180	visualBell	1339	visualBell
1181		1340
1182	=cut	1341	=cut
1183		1342
1184	sub resource($$;$) {	1343	sub resource($$;$) {
1185	my ($self, $name) = (shift, shift);	1344	my ($self, $name) = (shift, shift);
1186	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1345	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1187	&urxvt::term::_resource	1346	goto &urxvt::term::_resource
1188	}	1347	}
1189		1348
1190	=item $value = $term->x_resource ($pattern)	1349	=item $value = $term->x_resource ($pattern)
1191		1350
1192	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
…		…
1217		1376
1218	=item ($row, $col) = $term->selection_beg ([$row, $col])	1377	=item ($row, $col) = $term->selection_beg ([$row, $col])
1219		1378
1220	=item ($row, $col) = $term->selection_end ([$row, $col])	1379	=item ($row, $col) = $term->selection_end ([$row, $col])
1221		1380
1222	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.
1223	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.
1224		1390
1225	=item $term->selection_make ($eventtime[, $rectangular])	1391	=item $term->selection_make ($eventtime[, $rectangular])
1226		1392
1227	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
1228	C<selection_end>. If C<$rectangular> is true (default: false), a	1394	C<selection_end>. If C<$rectangular> is true (default: false), a
1229	rectangular selection will be made. This is the prefered function to make	1395	rectangular selection will be made. This is the preferred function to make
1230	a selection.	1396	a selection.
1231		1397
1232	=item $success = $term->selection_grab ($eventtime)	1398	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1233		1399
1234	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
1235	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
1236	is mostly useful from within C<on_sel_grab> hooks.	1403	is mostly useful from within C<on_sel_grab> hooks.
1237		1404
1238	=item $oldtext = $term->selection ([$newtext])	1405	=item $oldtext = $term->selection ([$newtext, $clipboard])
1239		1406
1240	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.
1241		1413
1242	=item $term->overlay_simple ($x, $y, $text)	1414	=item $term->overlay_simple ($x, $y, $text)
1243		1415
1244	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.
1245		1417
…		…
1275		1447
1276	The methods currently supported on C<urxvt::overlay> objects are:	1448	The methods currently supported on C<urxvt::overlay> objects are:
1277		1449
1278	=over 4	1450	=over 4
1279		1451
1280	=item $overlay->set ($x, $y, $text, $rend)	1452	=item $overlay->set ($x, $y, $text[, $rend])
1281		1453
1282	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
1283	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
1284	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.
1285		1459
1286	=item $overlay->hide	1460	=item $overlay->hide
1287		1461
1288	If visible, hide the overlay, but do not destroy it.	1462	If visible, hide the overlay, but do not destroy it.
1289		1463
…		…
1451	=item $env = $term->env	1625	=item $env = $term->env
1452		1626
1453	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
1454	similar to C<\%ENV>.	1628	similar to C<\%ENV>.
1455		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
1456	=cut	1639	=cut
1457		1640
1458	sub env {	1641	sub env {
1459	if (my $env = $_[0]->_env) {
1460	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1642	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1461	} else {
1462	+{ %ENV }
1463	}
1464	}	1643	}
1465		1644
1466	=item $modifiermask = $term->ModLevel3Mask	1645	=item $modifiermask = $term->ModLevel3Mask
1467		1646
1468	=item $modifiermask = $term->ModMetaMask	1647	=item $modifiermask = $term->ModMetaMask
…		…
1476		1655
1477	Returns the currently displayed screen (0 primary, 1 secondary).	1656	Returns the currently displayed screen (0 primary, 1 secondary).
1478		1657
1479	=item $cursor_is_hidden = $term->hidden_cursor	1658	=item $cursor_is_hidden = $term->hidden_cursor
1480		1659
1481	Returns wether the cursor is currently hidden or not.	1660	Returns whether the cursor is currently hidden or not.
1482		1661
1483	=item $view_start = $term->view_start ([$newvalue])	1662	=item $view_start = $term->view_start ([$newvalue])
1484		1663
1485	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
1486	C<0>, which displays the normal terminal contents. Lower values scroll	1665	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1494		1673
1495	Used after changing terminal contents to display them.	1674	Used after changing terminal contents to display them.
1496		1675
1497	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1676	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1498		1677
1499	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 >>
1500	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
1501	terminal line. The scrollback buffer starts at line C<-1> and extends to
1502	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1680	terminal line. Nothing will be returned if a nonexistent line
1503	is requested.	1681	is requested.
1504		1682
1505	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
1506	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
1507	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
1508	automatically be updated.	1686	automatically be updated.
1509		1687
1510	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
1511	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)
1512	characters. Characters with combining characters and other characters that	1690	characters. Characters with combining characters and other characters that
1513	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
1514	in the private use area.	1692	in the private use area.
1515		1693
1516	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
1517	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
1518	characters.	1696	characters.
…		…
1663	where one character corresponds to one screen cell. See	1841	where one character corresponds to one screen cell. See
1664	C<< $term->ROW_t >> for details.	1842	C<< $term->ROW_t >> for details.
1665		1843
1666	=item $string = $term->special_decode $text	1844	=item $string = $term->special_decode $text
1667		1845
1668	Converts rxvt-unicodes text reprsentation into a perl string. See	1846	Converts rxvt-unicodes text representation into a perl string. See
1669	C<< $term->ROW_t >> for details.	1847	C<< $term->ROW_t >> for details.
1670		1848
1671	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1849	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1672		1850
1673	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1851	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1676	manpage.	1854	manpage.
1677		1855
1678	=item $success = $term->grab ($eventtime[, $sync])	1856	=item $success = $term->grab ($eventtime[, $sync])
1679		1857
1680	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1858	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1681	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1859	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1682		1860
1683	=item $term->allow_events_async	1861	=item $term->allow_events_async
1684		1862
1685	Calls XAllowEvents with AsyncBoth for the most recent grab.	1863	Calls XAllowEvents with AsyncBoth for the most recent grab.
1686		1864
…		…
1693	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1871	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1694	recent grab.	1872	recent grab.
1695		1873
1696	=item $term->ungrab	1874	=item $term->ungrab
1697		1875
1698	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
1699	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
1700	the session.	1878	the session.
1701		1879
1702	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1880	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1703		1881
…		…
1705		1883
1706	=item @atoms = $term->XListProperties ($window)	1884	=item @atoms = $term->XListProperties ($window)
1707		1885
1708	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1886	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1709		1887
1710	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1888	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1711		1889
1712	=item $term->XDeleteProperty ($window, $property)	1890	=item $term->XDeleteProperty ($window, $property)
1713		1891
1714	=item $window = $term->DefaultRootWindow	1892	=item $window = $term->DefaultRootWindow
1715		1893
…		…
1725		1903
1726	=item $term->XChangeInput ($window, $add_events[, $del_events])	1904	=item $term->XChangeInput ($window, $add_events[, $del_events])
1727		1905
1728	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
1729	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
1730	directory onto the X functions of the same name.	1908	directly onto the X functions of the same name.
1731		1909
1732	=back	1910	=back
1733		1911
1734	=cut	1912	=cut
1735		1913
…		…
1799	my ($self, $text, $cb) = @_;	1977	my ($self, $text, $cb) = @_;
1800		1978
1801	$self->add_item ({ type => "button", text => $text, activate => $cb});	1979	$self->add_item ({ type => "button", text => $text, activate => $cb});
1802	}	1980	}
1803		1981
1804	=item $popup->add_toggle ($text, $cb, $initial_value)	1982	=item $popup->add_toggle ($text, $initial_value, $cb)
1805		1983
1806	Adds a toggle/checkbox item to the popup. Teh callback gets called	1984	Adds a toggle/checkbox item to the popup. The callback gets called
1807	whenever it gets toggled, with a boolean indicating its value as its first	1985	whenever it gets toggled, with a boolean indicating its new value as its
1808	argument.	1986	first argument.
1809		1987
1810	=cut	1988	=cut
1811		1989
1812	sub add_toggle {	1990	sub add_toggle {
1813	my ($self, $text, $cb, $value) = @_;	1991	my ($self, $text, $value, $cb) = @_;
1814		1992
1815	my $item; $item = {	1993	my $item; $item = {
1816	type => "button",	1994	type => "button",
1817	text => " $text",	1995	text => " $text",
1818	value => $value,	1996	value => $value,
…		…
1837	my $env = $self->{term}->env;	2015	my $env = $self->{term}->env;
1838	# 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.
1839	delete $env->{LC_ALL};	2017	delete $env->{LC_ALL};
1840	$env->{LC_CTYPE} = $self->{term}->locale;	2018	$env->{LC_CTYPE} = $self->{term}->locale;
1841		2019
1842	urxvt::term->new ($env, "popup",	2020	my $term = urxvt::term->new (
		2021	$env, "popup",
1843	"--perl-lib" => "", "--perl-ext-common" => "",	2022	"--perl-lib" => "", "--perl-ext-common" => "",
1844	"-pty-fd" => -1, "-sl" => 0,	2023	"-pty-fd" => -1, "-sl" => 0,
1845	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2024	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1846	"--transient-for" => $self->{term}->parent,	2025	"--transient-for" => $self->{term}->parent,
1847	"-display" => $self->{term}->display_id,	2026	"-display" => $self->{term}->display_id,
1848	"-pe" => "urxvt-popup")	2027	"-pe" => "urxvt-popup",
1849	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	}
1850	}	2035	}
1851		2036
1852	sub DESTROY {	2037	sub DESTROY {
1853	my ($self) = @_;	2038	my ($self) = @_;
1854		2039
…		…
1859	=back	2044	=back
1860		2045
1861	=cut	2046	=cut
1862		2047
1863	package urxvt::watcher;	2048	package urxvt::watcher;
1864
1865	@urxvt::timer::ISA = __PACKAGE__;
1866	@urxvt::iow::ISA = __PACKAGE__;
1867	@urxvt::pw::ISA = __PACKAGE__;
1868	@urxvt::iw::ISA = __PACKAGE__;
1869		2049
1870	=head2 The C<urxvt::timer> Class	2050	=head2 The C<urxvt::timer> Class
1871		2051
1872	This class implements timer watchers/events. Time is represented as a	2052	This class implements timer watchers/events. Time is represented as a
1873	fractional number of seconds since the epoch. Example:	2053	fractional number of seconds since the epoch. Example:
…		…
1877	->new	2057	->new
1878	->interval (1)	2058	->interval (1)
1879	->cb (sub {	2059	->cb (sub {
1880	$term->{overlay}->set (0, 0,	2060	$term->{overlay}->set (0, 0,
1881	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2061	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1882	});	2062	});
1883		2063
1884	=over 4	2064	=over 4
1885		2065
1886	=item $timer = new urxvt::timer	2066	=item $timer = new urxvt::timer
1887		2067
…		…
1890		2070
1891	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2071	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1892		2072
1893	Set the callback to be called when the timer triggers.	2073	Set the callback to be called when the timer triggers.
1894		2074
1895	=item $tstamp = $timer->at
1896
1897	Return the time this watcher will fire next.
1898
1899	=item $timer = $timer->set ($tstamp)	2075	=item $timer = $timer->set ($tstamp[, $interval])
1900		2076
1901	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).
1902		2079
1903	=item $timer = $timer->interval ($interval)	2080	=item $timer = $timer->interval ($interval)
1904		2081
1905	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
1906	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
1907	is automatically rescheduled at the given intervals.	2084	is automatically rescheduled at the given intervals.
1908		2085
1909	=item $timer = $timer->start	2086	=item $timer = $timer->start
1910		2087
1911	Start the timer.	2088	Start the timer.
1912		2089
1913	=item $timer = $timer->start ($tstamp)	2090	=item $timer = $timer->start ($tstamp[, $interval])
1914		2091
1915	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.
1916		2094
1917	=item $timer = $timer->after ($delay)	2095	=item $timer = $timer->after ($delay[, $interval])
1918		2096
1919	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>.
1920		2098
1921	=item $timer = $timer->stop	2099	=item $timer = $timer->stop
1922		2100
…		…
1930		2108
1931	$term->{socket} = ...	2109	$term->{socket} = ...
1932	$term->{iow} = urxvt::iow	2110	$term->{iow} = urxvt::iow
1933	->new	2111	->new
1934	->fd (fileno $term->{socket})	2112	->fd (fileno $term->{socket})
1935	->events (urxvt::EVENT_READ)	2113	->events (urxvt::EV_READ)
1936	->start	2114	->start
1937	->cb (sub {	2115	->cb (sub {
1938	my ($iow, $revents) = @_;	2116	my ($iow, $revents) = @_;
1939	# $revents must be 1 here, no need to check	2117	# $revents must be 1 here, no need to check
1940	sysread $term->{socket}, my $buf, 8192	2118	sysread $term->{socket}, my $buf, 8192
…		…
1953	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>
1954	is a bitset as described in the C<events> method.	2132	is a bitset as described in the C<events> method.
1955		2133
1956	=item $iow = $iow->fd ($fd)	2134	=item $iow = $iow->fd ($fd)
1957		2135
1958	Set the filedescriptor (not handle) to watch.	2136	Set the file descriptor (not handle) to watch.
1959		2137
1960	=item $iow = $iow->events ($eventmask)	2138	=item $iow = $iow->events ($eventmask)
1961		2139
1962	Set the event mask to watch. The only allowed values are	2140	Set the event mask to watch. The only allowed values are
1963	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
1964	together, or C<urxvt::EVENT_NONE>.	2142	together, or C<urxvt::EV_NONE>.
1965		2143
1966	=item $iow = $iow->start	2144	=item $iow = $iow->start
1967		2145
1968	Start watching for requested events on the given handle.	2146	Start watching for requested events on the given handle.
1969		2147
1970	=item $iow = $iow->stop	2148	=item $iow = $iow->stop
1971		2149
1972	Stop watching for events on the given filehandle.	2150	Stop watching for events on the given file handle.
1973		2151
1974	=back	2152	=back
1975		2153
1976	=head2 The C<urxvt::iw> Class	2154	=head2 The C<urxvt::iw> Class
1977		2155
…		…
2010	->new	2188	->new
2011	->start ($pid)	2189	->start ($pid)
2012	->cb (sub {	2190	->cb (sub {
2013	my ($pw, $exit_status) = @_;	2191	my ($pw, $exit_status) = @_;
2014	...	2192	...
2015	});	2193	});
2016		2194
2017	=over 4	2195	=over 4
2018		2196
2019	=item $pw = new urxvt::pw	2197	=item $pw = new urxvt::pw
2020		2198
…		…
2024		2202
2025	Set the callback to be called when the timer triggers.	2203	Set the callback to be called when the timer triggers.
2026		2204
2027	=item $pw = $timer->start ($pid)	2205	=item $pw = $timer->start ($pid)
2028		2206
2029	Tells the wqtcher to start watching for process C<$pid>.	2207	Tells the watcher to start watching for process C<$pid>.
2030		2208
2031	=item $pw = $pw->stop	2209	=item $pw = $pw->stop
2032		2210
2033	Stop the watcher.	2211	Stop the watcher.
2034		2212
…		…
2047		2225
2048	=item >= 3 - script loading and management	2226	=item >= 3 - script loading and management
2049		2227
2050	=item >=10 - all called hooks	2228	=item >=10 - all called hooks
2051		2229
2052	=item >=11 - hook reutrn values	2230	=item >=11 - hook return values
2053		2231
2054	=back	2232	=back
2055		2233
2056	=head1 AUTHOR	2234	=head1 AUTHOR
2057		2235
…		…
2059	http://software.schmorp.de/pkg/rxvt-unicode	2237	http://software.schmorp.de/pkg/rxvt-unicode
2060		2238
2061	=cut	2239	=cut
2062		2240
2063	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.132 by root, Mon Feb 6 05:40:15 2006 UTC vs. Revision 1.185 by sf-exg, Fri Jul 2 12:44:45 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.132 by root, Mon Feb 6 05:40:15 2006 UTC vs.
Revision 1.185 by sf-exg, Fri Jul 2 12:44:45 2010 UTC