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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.137 by root, Sat Mar 4 20:17:52 2006 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 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	167	A support package that tries to make editing with readline easier. At
159	the moment, it reacts to clicking shift-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, $op, $args	566	=item on_osc_seq $term, $op, $args, $resp
499		567
500	Called on every OSC sequence and can be used to suppress it or modify its	568	Called on every OSC sequence and can be used to suppress it or modify its
501	behaviour. The default should be to return an empty list. A true value	569	behaviour. The default should be to return an empty list. A true value
502	suppresses execution of the request completely. Make sure you don't get	570	suppresses execution of the request completely. Make sure you don't get
503	confused by recursive invocations when you output an osc sequence within	571	confused by recursive invocations when you output an OSC sequence within
504	this callback.	572	this callback.
505		573
506	C<on_osc_seq_perl> should be used for new behaviour.	574	C<on_osc_seq_perl> should be used for new behaviour.
507		575
508	=item on_osc_seq_perl $term, $string	576	=item on_osc_seq_perl $term, $args, $resp
509		577
510	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
511	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
512	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
513	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,
514	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
515	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	}
516		594
517	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,
518	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
519	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.
520		601
521	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
522		603
523	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
524	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
…		…
529	=item on_tt_write $term, $octets	610	=item on_tt_write $term, $octets
530		611
531	Called whenever some data is written to the tty/pty and can be used to	612	Called whenever some data is written to the tty/pty and can be used to
532	suppress or filter tty input.	613	suppress or filter tty input.
533		614
		615	=item on_tt_paste $term, $octets
		616
		617	Called whenever text is about to be pasted, with the text as argument. You
		618	can filter/change and paste the text yourself by returning a true value
		619	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		620	locale-encoded.
		621
534	=item on_line_update $term, $row	622	=item on_line_update $term, $row
535		623
536	Called whenever a line was updated or changed. Can be used to filter	624	Called whenever a line was updated or changed. Can be used to filter
537	screen output (e.g. underline urls or other useless stuff). Only lines	625	screen output (e.g. underline urls or other useless stuff). Only lines
538	that are being shown will be filtered, and, due to performance reasons,	626	that are being shown will be filtered, and, due to performance reasons,
…		…
545	later with the already-modified line (e.g. if unrelated parts change), so	633	later with the already-modified line (e.g. if unrelated parts change), so
546	you cannot just toggle rendition bits, but only set them.	634	you cannot just toggle rendition bits, but only set them.
547		635
548	=item on_refresh_begin $term	636	=item on_refresh_begin $term
549		637
550	Called just before the screen gets redrawn. Can be used for overlay	638	Called just before the screen gets redrawn. Can be used for overlay or
551	or similar effects by modify terminal contents in refresh_begin, and	639	similar effects by modifying the terminal contents in refresh_begin, and
552	restoring them in refresh_end. The built-in overlay and selection display	640	restoring them in refresh_end. The built-in overlay and selection display
553	code is run after this hook, and takes precedence.	641	code is run after this hook, and takes precedence.
554		642
555	=item on_refresh_end $term	643	=item on_refresh_end $term
556		644
557	Called just after the screen gets redrawn. See C<on_refresh_begin>.	645	Called just after the screen gets redrawn. See C<on_refresh_begin>.
558		646
559	=item on_user_command $term, $string	647	=item on_user_command $term, $string
560		648
561	Called whenever the a user-configured event is being activated (e.g. via	649	Called whenever a user-configured event is being activated (e.g. via
562	a C<perl:string> action bound to a key, see description of the B<keysym>	650	a C<perl:string> action bound to a key, see description of the B<keysym>
563	resource in the @@RXVT_NAME@@(1) manpage).	651	resource in the @@RXVT_NAME@@(1) manpage).
564		652
565	The event is simply the action string. This interface is assumed to change	653	The event is simply the action string. This interface is assumed to change
566	slightly in the future.	654	slightly in the future.
567		655
568	=item on_resize_all_windows $tern, $new_width, $new_height	656	=item on_resize_all_windows $term, $new_width, $new_height
569		657
570	Called just after the new window size has been calculcated, but before	658	Called just after the new window size has been calculated, but before
571	windows are actually being resized or hints are being set. If this hook	659	windows are actually being resized or hints are being set. If this hook
572	returns TRUE, setting of the window hints is being skipped.	660	returns TRUE, setting of the window hints is being skipped.
573		661
574	=item on_x_event $term, $event	662	=item on_x_event $term, $event
575		663
576	Called on every X event received on the vt window (and possibly other	664	Called on every X event received on the vt window (and possibly other
577	windows). Should only be used as a last resort. Most event structure	665	windows). Should only be used as a last resort. Most event structure
578	members are not passed.	666	members are not passed.
579		667
		668	=item on_root_event $term, $event
		669
		670	Like C<on_x_event>, but is called for events on the root window.
		671
580	=item on_focus_in $term	672	=item on_focus_in $term
581		673
582	Called whenever the window gets the keyboard focus, before rxvt-unicode	674	Called whenever the window gets the keyboard focus, before rxvt-unicode
583	does focus in processing.	675	does focus in processing.
584		676
585	=item on_focus_out $term	677	=item on_focus_out $term
586		678
587	Called wheneever the window loses keyboard focus, before rxvt-unicode does	679	Called whenever the window loses keyboard focus, before rxvt-unicode does
588	focus out processing.	680	focus out processing.
589		681
590	=item on_configure_notify $term, $event	682	=item on_configure_notify $term, $event
591		683
592	=item on_property_notify $term, $event	684	=item on_property_notify $term, $event
…		…
603		695
604	=item on_map_notify $term, $event	696	=item on_map_notify $term, $event
605		697
606	=item on_unmap_notify $term, $event	698	=item on_unmap_notify $term, $event
607		699
608	Called whenever the corresponding X event is received for the terminal If	700	Called whenever the corresponding X event is received for the terminal. If
609	the hook returns true, then the even will be ignored by rxvt-unicode.	701	the hook returns true, then the event will be ignored by rxvt-unicode.
610		702
611	The event is a hash with most values as named by Xlib (see the XEvent	703	The event is a hash with most values as named by Xlib (see the XEvent
612	manpage), with the additional members C<row> and C<col>, which are the	704	manpage), with the additional members C<row> and C<col>, which are the
613	(real, not screen-based) row and column under the mouse cursor.	705	(real, not screen-based) row and column under the mouse cursor.
614		706
…		…
623		715
624	=item on_wm_delete_window $term, $event	716	=item on_wm_delete_window $term, $event
625		717
626	Called when various types of ClientMessage events are received (all with	718	Called when various types of ClientMessage events are received (all with
627	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	719	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		720
		721	=item on_bell $term
		722
		723	Called on receipt of a bell character.
628		724
629	=back	725	=back
630		726
631	=cut	727	=cut
632		728
…		…
675	The current terminal. This variable stores the current C<urxvt::term>	771	The current terminal. This variable stores the current C<urxvt::term>
676	object, whenever a callback/hook is executing.	772	object, whenever a callback/hook is executing.
677		773
678	=item @urxvt::TERM_INIT	774	=item @urxvt::TERM_INIT
679		775
680	All coderefs in this array will be called as methods of the next newly	776	All code references in this array will be called as methods of the next newly
681	created C<urxvt::term> object (during the C<on_init> phase). The array	777	created C<urxvt::term> object (during the C<on_init> phase). The array
682	gets cleared before the codereferences that were in it are being executed,	778	gets cleared before the code references that were in it are being executed,
683	so coderefs can push themselves onto it again if they so desire.	779	so references can push themselves onto it again if they so desire.
684		780
685	This complements to the perl-eval commandline option, but gets executed	781	This complements to the perl-eval command line option, but gets executed
686	first.	782	first.
687		783
688	=item @urxvt::TERM_EXT	784	=item @urxvt::TERM_EXT
689		785
690	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	786	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
715	Messages have a size limit of 1023 bytes currently.	811	Messages have a size limit of 1023 bytes currently.
716		812
717	=item @terms = urxvt::termlist	813	=item @terms = urxvt::termlist
718		814
719	Returns all urxvt::term objects that exist in this process, regardless of	815	Returns all urxvt::term objects that exist in this process, regardless of
720	wether they are started, being destroyed etc., so be careful. Only term	816	whether they are started, being destroyed etc., so be careful. Only term
721	objects that have perl extensions attached will be returned (because there	817	objects that have perl extensions attached will be returned (because there
722	is no urxvt::term objet associated with others).	818	is no urxvt::term objet associated with others).
723		819
724	=item $time = urxvt::NOW	820	=item $time = urxvt::NOW
725		821
…		…
863	local $TERM = shift;	959	local $TERM = shift;
864	my $htype = shift;	960	my $htype = shift;
865		961
866	if ($htype == 0) { # INIT	962	if ($htype == 0) { # INIT
867	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	963	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
868		964
869	my %ext_arg;	965	my %ext_arg;
870		966
871	{	967	{
872	my @init = @TERM_INIT;	968	my @init = @TERM_INIT;
873	@TERM_INIT = ();	969	@TERM_INIT = ();
…		…
907		1003
908	if (my $cb = $TERM->{_hook}[$htype]) {	1004	if (my $cb = $TERM->{_hook}[$htype]) {
909	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1005	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
910	if $verbosity >= 10;	1006	if $verbosity >= 10;
911		1007
912	keys %$cb;	1008	for my $pkg (keys %$cb) {
913
914	while (my ($pkg, $cb) = each %$cb) {
915	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1009	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
916	$retval \|\|= $retval_;	1010	$retval \|\|= $retval_;
917		1011
918	if ($@) {	1012	if ($@) {
919	$TERM->ungrab; # better to lose the grab than the session	1013	$TERM->ungrab; # better to lose the grab than the session
920	warn $@;	1014	warn $@;
…		…
936	$retval	1030	$retval
937	}	1031	}
938		1032
939	sub SET_COLOR($$$) {	1033	sub SET_COLOR($$$) {
940	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1034	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1035	}
		1036
		1037	sub rend2mask {
		1038	no strict 'refs';
		1039	my ($str, $mask) = (@_, 0);
		1040	my %color = ( fg => undef, bg => undef );
		1041	my @failed;
		1042	for my $spec ( split /\s+/, $str ) {
		1043	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1044	$color{lc($1)} = $2;
		1045	} else {
		1046	my $neg = $spec =~ s/^[-^]//;
		1047	unless ( exists &{"RS_$spec"} ) {
		1048	push @failed, $spec;
		1049	next;
		1050	}
		1051	my $cur = &{"RS_$spec"};
		1052	if ( $neg ) {
		1053	$mask &= ~$cur;
		1054	} else {
		1055	$mask \|= $cur;
		1056	}
		1057	}
		1058	}
		1059	($mask, @color{qw(fg bg)}, \@failed)
941	}	1060	}
942		1061
943	# urxvt::term::extension	1062	# urxvt::term::extension
944		1063
945	package urxvt::term::extension;	1064	package urxvt::term::extension;
…		…
1016	is that you cannot use blocking APIs, but the non-blocking variant should	1135	is that you cannot use blocking APIs, but the non-blocking variant should
1017	work.	1136	work.
1018		1137
1019	=cut	1138	=cut
1020		1139
1021	our $VERSION = 1;	1140	our $VERSION = '5.23';
1022		1141
1023	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1142	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1024	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1143	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1025		1144
1026	sub timer {	1145	sub timer {
…		…
1028		1147
1029	my $cb = $arg{cb};	1148	my $cb = $arg{cb};
1030		1149
1031	urxvt::timer	1150	urxvt::timer
1032	->new	1151	->new
1033	->start (urxvt::NOW + $arg{after})	1152	->after ($arg{after}, $arg{interval})
1034	->cb (sub {	1153	->cb ($arg{interval} ? $cb : sub {
1035	$_[0]->stop; # need to cancel manually	1154	$_[0]->stop; # need to cancel manually
1036	$cb->();	1155	$cb->();
1037	})	1156	})
1038	}	1157	}
1039		1158
1040	sub io {	1159	sub io {
1041	my ($class, %arg) = @_;	1160	my ($class, %arg) = @_;
1042		1161
1043	my $cb = $arg{cb};	1162	my $cb = $arg{cb};
		1163	my $fd = fileno $arg{fh};
		1164	defined $fd or $fd = $arg{fh};
1044		1165
1045	bless [$arg{fh}, urxvt::iow	1166	bless [$arg{fh}, urxvt::iow
1046	->new	1167	->new
1047	->fd (fileno $arg{fh})	1168	->fd ($fd)
1048	->events (($arg{poll} =~ /r/ ? 1 : 0)	1169	->events (($arg{poll} =~ /r/ ? 1 : 0)
1049	\| ($arg{poll} =~ /w/ ? 2 : 0))	1170	\| ($arg{poll} =~ /w/ ? 2 : 0))
1050	->start	1171	->start
1051	->cb (sub {	1172	->cb ($cb)
1052	$cb->(($_[1] & 1 ? 'r' : '')
1053	. ($_[1] & 2 ? 'w' : ''));
1054	})],
1055	urxvt::anyevent::	1173	], urxvt::anyevent::
		1174	}
		1175
		1176	sub idle {
		1177	my ($class, %arg) = @_;
		1178
		1179	my $cb = $arg{cb};
		1180
		1181	urxvt::iw
		1182	->new
		1183	->start
		1184	->cb ($cb)
		1185	}
		1186
		1187	sub child {
		1188	my ($class, %arg) = @_;
		1189
		1190	my $cb = $arg{cb};
		1191
		1192	urxvt::pw
		1193	->new
		1194	->start ($arg{pid})
		1195	->cb (sub {
		1196	$_[0]->stop; # need to cancel manually
		1197	$cb->($_[0]->rpid, $_[0]->rstatus);
		1198	})
1056	}	1199	}
1057		1200
1058	sub DESTROY {	1201	sub DESTROY {
1059	$_[0][1]->stop;	1202	$_[0][1]->stop;
1060	}	1203	}
1061		1204
1062	sub condvar {	1205	sub one_event {
1063	bless \my $flag, urxvt::anyevent::condvar::
1064	}
1065
1066	sub urxvt::anyevent::condvar::broadcast {
1067	${$_[0]}++;
1068	}
1069
1070	sub urxvt::anyevent::condvar::wait {
1071	unless (${$_[0]}) {
1072	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1206	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1073	}
1074	}	1207	}
1075		1208
1076	package urxvt::term;	1209	package urxvt::term;
1077		1210
1078	=head2 The C<urxvt::term> Class	1211	=head2 The C<urxvt::term> Class
…		…
1165		1298
1166	Returns true if the option specified by C<$optval> is enabled, and	1299	Returns true if the option specified by C<$optval> is enabled, and
1167	optionally change it. All option values are stored by name in the hash	1300	optionally change it. All option values are stored by name in the hash
1168	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1301	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1169		1302
1170	Here is a a likely non-exhaustive list of option names, please see the	1303	Here is a likely non-exhaustive list of option names, please see the
1171	source file F</src/optinc.h> to see the actual list:	1304	source file F</src/optinc.h> to see the actual list:
1172		1305
1173	borderLess console cursorBlink cursorUnderline hold iconic insecure	1306	borderLess console cursorBlink cursorUnderline hold iconic insecure
1174	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1307	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1175	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1308	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1192	likely change).	1325	likely change).
1193		1326
1194	Please note that resource strings will currently only be freed when the	1327	Please note that resource strings will currently only be freed when the
1195	terminal is destroyed, so changing options frequently will eat memory.	1328	terminal is destroyed, so changing options frequently will eat memory.
1196		1329
1197	Here is a a likely non-exhaustive list of resource names, not all of which	1330	Here is a likely non-exhaustive list of resource names, not all of which
1198	are supported in every build, please see the source file F</src/rsinc.h>	1331	are supported in every build, please see the source file F</src/rsinc.h>
1199	to see the actual list:	1332	to see the actual list:
1200		1333
1201	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1334	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1202	borderLess color cursorBlink cursorUnderline cutchars delete_key	1335	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1203	display_name embed ext_bwidth fade font geometry hold iconName	1336	display_name embed ext_bwidth fade font geometry hold iconName
1204	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1337	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1205	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1338	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1206	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1339	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1207	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1340	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1208	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1341	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1209	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1342	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1210	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1343	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1211	secondaryScreen secondaryScroll selectstyle shade term_name title	1344	secondaryScreen secondaryScroll shade term_name title
1212	transient_for transparent transparent_all tripleclickwords utmpInhibit	1345	transient_for transparent transparent_all tripleclickwords utmpInhibit
1213	visualBell	1346	visualBell
1214		1347
1215	=cut	1348	=cut
1216		1349
1217	sub resource($$;$) {	1350	sub resource($$;$) {
1218	my ($self, $name) = (shift, shift);	1351	my ($self, $name) = (shift, shift);
1219	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1352	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1220	&urxvt::term::_resource	1353	goto &urxvt::term::_resource
1221	}	1354	}
1222		1355
1223	=item $value = $term->x_resource ($pattern)	1356	=item $value = $term->x_resource ($pattern)
1224		1357
1225	Returns the X-Resource for the given pattern, excluding the program or	1358	Returns the X-Resource for the given pattern, excluding the program or
…		…
1250		1383
1251	=item ($row, $col) = $term->selection_beg ([$row, $col])	1384	=item ($row, $col) = $term->selection_beg ([$row, $col])
1252		1385
1253	=item ($row, $col) = $term->selection_end ([$row, $col])	1386	=item ($row, $col) = $term->selection_end ([$row, $col])
1254		1387
1255	Return the current values of the selection mark, begin or end positions,	1388	Return the current values of the selection mark, begin or end positions.
1256	and optionally set them to new values.	1389
		1390	When arguments are given, then the selection coordinates are set to
		1391	C<$row> and C<$col>, and the selection screen is set to the current
		1392	screen.
		1393
		1394	=item $screen = $term->selection_screen ([$screen])
		1395
		1396	Returns the current selection screen, and then optionally sets it.
1257		1397
1258	=item $term->selection_make ($eventtime[, $rectangular])	1398	=item $term->selection_make ($eventtime[, $rectangular])
1259		1399
1260	Tries to make a selection as set by C<selection_beg> and	1400	Tries to make a selection as set by C<selection_beg> and
1261	C<selection_end>. If C<$rectangular> is true (default: false), a	1401	C<selection_end>. If C<$rectangular> is true (default: false), a
1262	rectangular selection will be made. This is the prefered function to make	1402	rectangular selection will be made. This is the preferred function to make
1263	a selection.	1403	a selection.
1264		1404
1265	=item $success = $term->selection_grab ($eventtime)	1405	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1266		1406
1267	Try to request the primary selection text from the server (for example, as	1407	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1408	true) selection from the server. The corresponding text can be set
1268	set by the next method). No visual feedback will be given. This function	1409	with the next method. No visual feedback will be given. This function
1269	is mostly useful from within C<on_sel_grab> hooks.	1410	is mostly useful from within C<on_sel_grab> hooks.
1270		1411
1271	=item $oldtext = $term->selection ([$newtext])	1412	=item $oldtext = $term->selection ([$newtext, $clipboard])
1272		1413
1273	Return the current selection text and optionally replace it by C<$newtext>.	1414	Return the current selection (clipboard if C<$clipboard> is true) text
		1415	and optionally replace it by C<$newtext>.
		1416
		1417	=item $term->selection_clear ([$clipboard])
		1418
		1419	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1274		1420
1275	=item $term->overlay_simple ($x, $y, $text)	1421	=item $term->overlay_simple ($x, $y, $text)
1276		1422
1277	Create a simple multi-line overlay box. See the next method for details.	1423	Create a simple multi-line overlay box. See the next method for details.
1278		1424
…		…
1308		1454
1309	The methods currently supported on C<urxvt::overlay> objects are:	1455	The methods currently supported on C<urxvt::overlay> objects are:
1310		1456
1311	=over 4	1457	=over 4
1312		1458
1313	=item $overlay->set ($x, $y, $text, $rend)	1459	=item $overlay->set ($x, $y, $text[, $rend])
1314		1460
1315	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1461	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1316	text in rxvt-unicode's special encoding and an array of rendition values	1462	text in rxvt-unicode's special encoding and an array of rendition values
1317	at a specific position inside the overlay.	1463	at a specific position inside the overlay.
		1464
		1465	If C<$rend> is missing, then the rendition will not be changed.
1318		1466
1319	=item $overlay->hide	1467	=item $overlay->hide
1320		1468
1321	If visible, hide the overlay, but do not destroy it.	1469	If visible, hide the overlay, but do not destroy it.
1322		1470
…		…
1404	locale-specific encoding of the terminal and can contain command sequences	1552	locale-specific encoding of the terminal and can contain command sequences
1405	(escape codes) that will be interpreted.	1553	(escape codes) that will be interpreted.
1406		1554
1407	=item $term->tt_write ($octets)	1555	=item $term->tt_write ($octets)
1408		1556
1409	Write the octets given in C<$data> to the tty (i.e. as program input). To	1557	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1410	pass characters instead of octets, you should convert your strings first	1558	pass characters instead of octets, you should convert your strings first
1411	to the locale-specific encoding using C<< $term->locale_encode >>.	1559	to the locale-specific encoding using C<< $term->locale_encode >>.
		1560
		1561	=item $term->tt_paste ($octets)
		1562
		1563	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1564	CR and bracketing the data with control sequences if bracketed paste mode
		1565	is set.
1412		1566
1413	=item $old_events = $term->pty_ev_events ([$new_events])	1567	=item $old_events = $term->pty_ev_events ([$new_events])
1414		1568
1415	Replaces the event mask of the pty watcher by the given event mask. Can	1569	Replaces the event mask of the pty watcher by the given event mask. Can
1416	be used to suppress input and output handling to the pty/tty. See the	1570	be used to suppress input and output handling to the pty/tty. See the
…		…
1514		1668
1515	Returns the currently displayed screen (0 primary, 1 secondary).	1669	Returns the currently displayed screen (0 primary, 1 secondary).
1516		1670
1517	=item $cursor_is_hidden = $term->hidden_cursor	1671	=item $cursor_is_hidden = $term->hidden_cursor
1518		1672
1519	Returns wether the cursor is currently hidden or not.	1673	Returns whether the cursor is currently hidden or not.
1520		1674
1521	=item $view_start = $term->view_start ([$newvalue])	1675	=item $view_start = $term->view_start ([$newvalue])
1522		1676
1523	Returns the row number of the topmost displayed line. Maximum value is	1677	Returns the row number of the topmost displayed line. Maximum value is
1524	C<0>, which displays the normal terminal contents. Lower values scroll	1678	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1532		1686
1533	Used after changing terminal contents to display them.	1687	Used after changing terminal contents to display them.
1534		1688
1535	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1689	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1536		1690
1537	Returns the text of the entire row with number C<$row_number>. Row C<0>	1691	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1538	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1692	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1539	terminal line. The scrollback buffer starts at line C<-1> and extends to
1540	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1693	terminal line. Nothing will be returned if a nonexistent line
1541	is requested.	1694	is requested.
1542		1695
1543	If C<$new_text> is specified, it will replace characters in the current	1696	If C<$new_text> is specified, it will replace characters in the current
1544	line, starting at column C<$start_col> (default C<0>), which is useful	1697	line, starting at column C<$start_col> (default C<0>), which is useful
1545	to replace only parts of a line. The font index in the rendition will	1698	to replace only parts of a line. The font index in the rendition will
1546	automatically be updated.	1699	automatically be updated.
1547		1700
1548	C<$text> is in a special encoding: tabs and wide characters that use more	1701	C<$text> is in a special encoding: tabs and wide characters that use more
1549	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1702	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1550	characters. Characters with combining characters and other characters that	1703	characters. Characters with combining characters and other characters that
1551	do not fit into the normal tetx encoding will be replaced with characters	1704	do not fit into the normal text encoding will be replaced with characters
1552	in the private use area.	1705	in the private use area.
1553		1706
1554	You have to obey this encoding when changing text. The advantage is	1707	You have to obey this encoding when changing text. The advantage is
1555	that C<substr> and similar functions work on screen cells and not on	1708	that C<substr> and similar functions work on screen cells and not on
1556	characters.	1709	characters.
…		…
1701	where one character corresponds to one screen cell. See	1854	where one character corresponds to one screen cell. See
1702	C<< $term->ROW_t >> for details.	1855	C<< $term->ROW_t >> for details.
1703		1856
1704	=item $string = $term->special_decode $text	1857	=item $string = $term->special_decode $text
1705		1858
1706	Converts rxvt-unicodes text reprsentation into a perl string. See	1859	Converts rxvt-unicodes text representation into a perl string. See
1707	C<< $term->ROW_t >> for details.	1860	C<< $term->ROW_t >> for details.
1708		1861
1709	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1862	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1710		1863
1711	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1864	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1714	manpage.	1867	manpage.
1715		1868
1716	=item $success = $term->grab ($eventtime[, $sync])	1869	=item $success = $term->grab ($eventtime[, $sync])
1717		1870
1718	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1871	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1719	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1872	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1720		1873
1721	=item $term->allow_events_async	1874	=item $term->allow_events_async
1722		1875
1723	Calls XAllowEvents with AsyncBoth for the most recent grab.	1876	Calls XAllowEvents with AsyncBoth for the most recent grab.
1724		1877
…		…
1731	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1884	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1732	recent grab.	1885	recent grab.
1733		1886
1734	=item $term->ungrab	1887	=item $term->ungrab
1735		1888
1736	Calls XUngrab for the most recent grab. Is called automatically on	1889	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1737	evaluation errors, as it is better to lose the grab in the error case as	1890	evaluation errors, as it is better to lose the grab in the error case as
1738	the session.	1891	the session.
1739		1892
1740	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1893	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1741		1894
…		…
1743		1896
1744	=item @atoms = $term->XListProperties ($window)	1897	=item @atoms = $term->XListProperties ($window)
1745		1898
1746	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1899	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1747		1900
1748	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1901	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1749		1902
1750	=item $term->XDeleteProperty ($window, $property)	1903	=item $term->XDeleteProperty ($window, $property)
1751		1904
1752	=item $window = $term->DefaultRootWindow	1905	=item $window = $term->DefaultRootWindow
1753		1906
…		…
1763		1916
1764	=item $term->XChangeInput ($window, $add_events[, $del_events])	1917	=item $term->XChangeInput ($window, $add_events[, $del_events])
1765		1918
1766	Various X or X-related functions. The C<$term> object only serves as	1919	Various X or X-related functions. The C<$term> object only serves as
1767	the source of the display, otherwise those functions map more-or-less	1920	the source of the display, otherwise those functions map more-or-less
1768	directory onto the X functions of the same name.	1921	directly onto the X functions of the same name.
1769		1922
1770	=back	1923	=back
1771		1924
1772	=cut	1925	=cut
1773		1926
…		…
1875	my $env = $self->{term}->env;	2028	my $env = $self->{term}->env;
1876	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2029	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1877	delete $env->{LC_ALL};	2030	delete $env->{LC_ALL};
1878	$env->{LC_CTYPE} = $self->{term}->locale;	2031	$env->{LC_CTYPE} = $self->{term}->locale;
1879		2032
1880	urxvt::term->new ($env, "popup",	2033	my $term = urxvt::term->new (
		2034	$env, "popup",
1881	"--perl-lib" => "", "--perl-ext-common" => "",	2035	"--perl-lib" => "", "--perl-ext-common" => "",
1882	"-pty-fd" => -1, "-sl" => 0,	2036	"-pty-fd" => -1, "-sl" => 0,
1883	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2037	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1884	"--transient-for" => $self->{term}->parent,	2038	"--transient-for" => $self->{term}->parent,
1885	"-display" => $self->{term}->display_id,	2039	"-display" => $self->{term}->display_id,
1886	"-pe" => "urxvt-popup")	2040	"-pe" => "urxvt-popup",
1887	or die "unable to create popup window\n";	2041	) or die "unable to create popup window\n";
		2042
		2043	unless (delete $term->{urxvt_popup_init_done}) {
		2044	$term->ungrab;
		2045	$term->destroy;
		2046	die "unable to initialise popup window\n";
		2047	}
1888	}	2048	}
1889		2049
1890	sub DESTROY {	2050	sub DESTROY {
1891	my ($self) = @_;	2051	my ($self) = @_;
1892		2052
…		…
1897	=back	2057	=back
1898		2058
1899	=cut	2059	=cut
1900		2060
1901	package urxvt::watcher;	2061	package urxvt::watcher;
1902
1903	@urxvt::timer::ISA = __PACKAGE__;
1904	@urxvt::iow::ISA = __PACKAGE__;
1905	@urxvt::pw::ISA = __PACKAGE__;
1906	@urxvt::iw::ISA = __PACKAGE__;
1907		2062
1908	=head2 The C<urxvt::timer> Class	2063	=head2 The C<urxvt::timer> Class
1909		2064
1910	This class implements timer watchers/events. Time is represented as a	2065	This class implements timer watchers/events. Time is represented as a
1911	fractional number of seconds since the epoch. Example:	2066	fractional number of seconds since the epoch. Example:
…		…
1915	->new	2070	->new
1916	->interval (1)	2071	->interval (1)
1917	->cb (sub {	2072	->cb (sub {
1918	$term->{overlay}->set (0, 0,	2073	$term->{overlay}->set (0, 0,
1919	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2074	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1920	});	2075	});
1921		2076
1922	=over 4	2077	=over 4
1923		2078
1924	=item $timer = new urxvt::timer	2079	=item $timer = new urxvt::timer
1925		2080
…		…
1928		2083
1929	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2084	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1930		2085
1931	Set the callback to be called when the timer triggers.	2086	Set the callback to be called when the timer triggers.
1932		2087
1933	=item $tstamp = $timer->at
1934
1935	Return the time this watcher will fire next.
1936
1937	=item $timer = $timer->set ($tstamp)	2088	=item $timer = $timer->set ($tstamp[, $interval])
1938		2089
1939	Set the time the event is generated to $tstamp.	2090	Set the time the event is generated to $tstamp (and optionally specifies a
		2091	new $interval).
1940		2092
1941	=item $timer = $timer->interval ($interval)	2093	=item $timer = $timer->interval ($interval)
1942		2094
1943	Normally (and when C<$interval> is C<0>), the timer will automatically	2095	By default (and when C<$interval> is C<0>), the timer will automatically
1944	stop after it has fired once. If C<$interval> is non-zero, then the timer	2096	stop after it has fired once. If C<$interval> is non-zero, then the timer
1945	is automatically rescheduled at the given intervals.	2097	is automatically rescheduled at the given intervals.
1946		2098
1947	=item $timer = $timer->start	2099	=item $timer = $timer->start
1948		2100
1949	Start the timer.	2101	Start the timer.
1950		2102
1951	=item $timer = $timer->start ($tstamp)	2103	=item $timer = $timer->start ($tstamp[, $interval])
1952		2104
1953	Set the event trigger time to C<$tstamp> and start the timer.	2105	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2106	also replaces the interval.
1954		2107
1955	=item $timer = $timer->after ($delay)	2108	=item $timer = $timer->after ($delay[, $interval])
1956		2109
1957	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2110	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1958		2111
1959	=item $timer = $timer->stop	2112	=item $timer = $timer->stop
1960		2113
…		…
1968		2121
1969	$term->{socket} = ...	2122	$term->{socket} = ...
1970	$term->{iow} = urxvt::iow	2123	$term->{iow} = urxvt::iow
1971	->new	2124	->new
1972	->fd (fileno $term->{socket})	2125	->fd (fileno $term->{socket})
1973	->events (urxvt::EVENT_READ)	2126	->events (urxvt::EV_READ)
1974	->start	2127	->start
1975	->cb (sub {	2128	->cb (sub {
1976	my ($iow, $revents) = @_;	2129	my ($iow, $revents) = @_;
1977	# $revents must be 1 here, no need to check	2130	# $revents must be 1 here, no need to check
1978	sysread $term->{socket}, my $buf, 8192	2131	sysread $term->{socket}, my $buf, 8192
…		…
1991	Set the callback to be called when io events are triggered. C<$reventmask>	2144	Set the callback to be called when io events are triggered. C<$reventmask>
1992	is a bitset as described in the C<events> method.	2145	is a bitset as described in the C<events> method.
1993		2146
1994	=item $iow = $iow->fd ($fd)	2147	=item $iow = $iow->fd ($fd)
1995		2148
1996	Set the filedescriptor (not handle) to watch.	2149	Set the file descriptor (not handle) to watch.
1997		2150
1998	=item $iow = $iow->events ($eventmask)	2151	=item $iow = $iow->events ($eventmask)
1999		2152
2000	Set the event mask to watch. The only allowed values are	2153	Set the event mask to watch. The only allowed values are
2001	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2154	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2002	together, or C<urxvt::EVENT_NONE>.	2155	together, or C<urxvt::EV_NONE>.
2003		2156
2004	=item $iow = $iow->start	2157	=item $iow = $iow->start
2005		2158
2006	Start watching for requested events on the given handle.	2159	Start watching for requested events on the given handle.
2007		2160
2008	=item $iow = $iow->stop	2161	=item $iow = $iow->stop
2009		2162
2010	Stop watching for events on the given filehandle.	2163	Stop watching for events on the given file handle.
2011		2164
2012	=back	2165	=back
2013		2166
2014	=head2 The C<urxvt::iw> Class	2167	=head2 The C<urxvt::iw> Class
2015		2168
…		…
2048	->new	2201	->new
2049	->start ($pid)	2202	->start ($pid)
2050	->cb (sub {	2203	->cb (sub {
2051	my ($pw, $exit_status) = @_;	2204	my ($pw, $exit_status) = @_;
2052	...	2205	...
2053	});	2206	});
2054		2207
2055	=over 4	2208	=over 4
2056		2209
2057	=item $pw = new urxvt::pw	2210	=item $pw = new urxvt::pw
2058		2211
…		…
2062		2215
2063	Set the callback to be called when the timer triggers.	2216	Set the callback to be called when the timer triggers.
2064		2217
2065	=item $pw = $timer->start ($pid)	2218	=item $pw = $timer->start ($pid)
2066		2219
2067	Tells the wqtcher to start watching for process C<$pid>.	2220	Tells the watcher to start watching for process C<$pid>.
2068		2221
2069	=item $pw = $pw->stop	2222	=item $pw = $pw->stop
2070		2223
2071	Stop the watcher.	2224	Stop the watcher.
2072		2225
…		…
2085		2238
2086	=item >= 3 - script loading and management	2239	=item >= 3 - script loading and management
2087		2240
2088	=item >=10 - all called hooks	2241	=item >=10 - all called hooks
2089		2242
2090	=item >=11 - hook reutrn values	2243	=item >=11 - hook return values
2091		2244
2092	=back	2245	=back
2093		2246
2094	=head1 AUTHOR	2247	=head1 AUTHOR
2095		2248
…		…
2097	http://software.schmorp.de/pkg/rxvt-unicode	2250	http://software.schmorp.de/pkg/rxvt-unicode
2098		2251
2099	=cut	2252	=cut
2100		2253
2101	1	2254	1
		2255
		2256	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.137 by root, Sat Mar 4 20:17:52 2006 UTC vs. Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.137 by root, Sat Mar 4 20:17:52 2006 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC