ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.89 by root, Thu Jan 12 12:10:06 2006 UTC vs.
Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 2011 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
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
58	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
59	...	66	...
60		67
61	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
62	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
63	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
64	between two vertical bars:	71	between two vertical bars:
65		72
66	URxvt.selection.pattern-0: \\|([^|]+)\\|	73	URxvt.selection.pattern-0: \\|([^|]+)\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
67		81
68	You can look at the source of the selection extension to see more	82	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
70		84
71	This extension also offers the following bindable keyboard command:	85	This extension also offers following bindable keyboard commands:
72		86
73	=over 4	87	=over 4
74		88
75	=item rot13	89	=item rot13
76		90
…		…
83	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
84		98
85	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
86	runtime.	100	runtime.
87		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
88	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
89		120
90	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
91	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
		124
		125	Other extensions can extend this popup menu by pushing a code reference
		126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
		128
		129	Its sole argument is the popup menu, which can be modified. The selection
		130	is in C<$_>, which can be used to decide whether to add something or not.
		131	It should either return nothing or a string and a code reference. The
		132	string will be used as button text and the code reference will be called
		133	when the button gets activated and should transform C<$_>.
		134
		135	The following will add an entry C<a to b> that transforms all C<a>s in
		136	the selection to C<b>s, but only if the selection currently contains any
		137	C<a>s:
		138
		139	push @{ $self->{term}{selection_popup_hook} }, sub {
		140	/a/ ? ("a to b" => sub { s/a/b/g }
		141	: ()
		142	};
93		143
94	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
95		145
96	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
102	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>
103	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
104	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
105	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
106	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
107	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
108		189
109	=item selection-autotransform	190	=item selection-autotransform
110		191
111	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	193	whenever a selection is made.
…		…
120		201
121	For example, the following will transform selections of the form	202	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename	203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:	204	$word>:
124		205
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		207
127	And this example matches the same,but replaces it with vi-commands you can	208	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:	209	paste directly into your (vi :) editor:
129		210
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		212
132	=item mark-urls	213	Of course, this can be modified to suit your needs and your editor :)
133		214
		215	To expand the example above to typical perl error messages ("XXX at
		216	FILENAME line YYY."), you need a slightly more elaborate solution:
		217
		218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		220
		221	The first line tells the selection code to treat the unchanging part of
		222	every error message as a selection pattern, and the second line transforms
		223	the message into vi commands to load the file.
		224
		225	=item tabbed
		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
134	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
135	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
136	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
137	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
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
138		313
139	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
140		315
141	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
142	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
143	similar-looking ascii character.	318	similar-looking ascii character.
144		319
145	=item digital-clock	320	=item digital-clock
146		321
147	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
		323
		324	=item remote-clipboard
		325
		326	Somewhat of a misnomer, this extension adds two menu entries to the
		327	selection popup that allows one to run external commands to store the
		328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		343
		344	=item selection-pastebin
		345
		346	This is a little rarely useful extension that uploads the selection as
		347	textfile to a remote site (or does other things). (The implementation is
		348	not currently secure for use in a multiuser environment as it writes to
		349	F</tmp> directly.).
		350
		351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		352	i.e.
		353
		354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		355
		356	Pressing this combination runs a command with C<%> replaced by the name of
		357	the textfile. This command can be set via a resource:
		358
		359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		360
		361	And the default is likely not useful to anybody but the few people around
		362	here :)
		363
		364	The name of the textfile is the hex encoded md5 sum of the selection, so
		365	the same content should lead to the same filename.
		366
		367	After a successful upload the selection will be replaced by the text given
		368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		369	for the filename):
		370
		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.
148		391
149	=item example-refresh-hooks	392	=item example-refresh-hooks
150		393
151	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
152	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
153	overlays or changes.	396	overlays or changes.
		397
		398	=item confirm-paste
		399
		400	Displays a confirmation dialog when a paste containing at least a full
		401	line is detected.
154		402
155	=back	403	=back
156		404
157	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
158		406
…		…
174		422
175	=over 4	423	=over 4
176		424
177	=item $text	425	=item $text
178		426
179	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
180	always represents one screen cell. See L<ROW_t> for a discussion of this format.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
181		429
182	=item $string	430	=item $string
183		431
184	A perl text string, with an emphasis on I<text>. It can store all unicode	432	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
192		440
193	=back	441	=back
194		442
195	=head2 Extension Objects	443	=head2 Extension Objects
196		444
197	Very perl extension is a perl class. A separate perl object is created	445	Every perl extension is a perl class. A separate perl object is created
198	for each terminal and each extension and passed as the first parameter to	446	for each terminal, and each terminal has its own set of extension objects,
199	hooks. So extensions can use their C<$self> object without having to think	447	which are passed as the first parameter to hooks. So extensions can use
200	about other extensions, with the exception of methods and members that	448	their C<$self> object without having to think about clashes with other
		449	extensions or other terminals, with the exception of methods and members
201	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
202	use.	451	internal use.
203		452
204	Although it isn't a C<urxvt::term> object, you can call all methods of the	453	Although it isn't a C<urxvt::term> object, you can call all methods of the
205	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
206		455
207	It has the following methods and data members:	456	It has the following methods and data members:
…		…
228	=head2 Hooks	477	=head2 Hooks
229		478
230	The following subroutines can be declared in extension files, and will be	479	The following subroutines can be declared in extension files, and will be
231	called whenever the relevant event happens.	480	called whenever the relevant event happens.
232		481
233	The first argument passed to them is an extension oject as described in	482	The first argument passed to them is an extension object as described in
234	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
235		484
236	B<All> of these hooks must return a boolean value. If it is true, then the	485	B<All> of these hooks must return a boolean value. If any of the called
237	event counts as being I<consumed>, and the invocation of other hooks is	486	hooks returns true, then the event counts as being I<consumed>, and the
238	skipped, and the relevant action might not be carried out by the C++ code.	487	relevant action might not be carried out by the C++ code.
239		488
240	I<< When in doubt, return a false value (preferably C<()>). >>	489	I<< When in doubt, return a false value (preferably C<()>). >>
241		490
242	=over 4	491	=over 4
243		492
244	=item on_init $term	493	=item on_init $term
245		494
246	Called after a new terminal object has been initialized, but before	495	Called after a new terminal object has been initialized, but before
247	windows are created or the command gets run. Most methods are unsafe to	496	windows are created or the command gets run. Most methods are unsafe to
248	call or deliver senseless data, as terminal size and other characteristics	497	call or deliver senseless data, as terminal size and other characteristics
249	have not yet been determined. You can safely query and change resources,	498	have not yet been determined. You can safely query and change resources
250	though.	499	and options, though. For many purposes the C<on_start> hook is a better
		500	place.
		501
		502	=item on_start $term
		503
		504	Called at the very end of initialisation of a new terminal, just before
		505	trying to map (display) the toplevel and returning to the main loop.
		506
		507	=item on_destroy $term
		508
		509	Called whenever something tries to destroy terminal, when the terminal is
		510	still fully functional (not for long, though).
251		511
252	=item on_reset $term	512	=item on_reset $term
253		513
254	Called after the screen is "reset" for any reason, such as resizing or	514	Called after the screen is "reset" for any reason, such as resizing or
255	control sequences. Here is where you can react on changes to size-related	515	control sequences. Here is where you can react on changes to size-related
256	variables.	516	variables.
257		517
258	=item on_start $term	518	=item on_child_start $term, $pid
259		519
260	Called at the very end of initialisation of a new terminal, just before	520	Called just after the child process has been C<fork>ed.
261	returning to the mainloop.	521
		522	=item on_child_exit $term, $status
		523
		524	Called just after the child process has exited. C<$status> is the status
		525	from C<waitpid>.
262		526
263	=item on_sel_make $term, $eventtime	527	=item on_sel_make $term, $eventtime
264		528
265	Called whenever a selection has been made by the user, but before the	529	Called whenever a selection has been made by the user, but before the
266	selection text is copied, so changes to the beginning, end or type of the	530	selection text is copied, so changes to the beginning, end or type of the
…		…
273		537
274	Called whenever a selection has been copied, but before the selection is	538	Called whenever a selection has been copied, but before the selection is
275	requested from the server. The selection text can be queried and changed	539	requested from the server. The selection text can be queried and changed
276	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
277		541
278	Returning a true value aborts selection grabbing. It will still be hilighted.	542	Returning a true value aborts selection grabbing. It will still be highlighted.
279		543
280	=item on_sel_extend $term	544	=item on_sel_extend $term
281		545
282	Called whenever the user tries to extend the selection (e.g. with a double	546	Called whenever the user tries to extend the selection (e.g. with a double
283	click) and is either supposed to return false (normal operation), or	547	click) and is either supposed to return false (normal operation), or
284	should extend the selection itelf and return true to suppress the built-in	548	should extend the selection itself and return true to suppress the built-in
285	processing. This can happen multiple times, as long as the callback	549	processing. This can happen multiple times, as long as the callback
286	returns true, it will be called on every further click by the user and is	550	returns true, it will be called on every further click by the user and is
287	supposed to enlarge the selection more and more, if possible.	551	supposed to enlarge the selection more and more, if possible.
288		552
289	See the F<selection> example extension.	553	See the F<selection> example extension.
290		554
291	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
292		556
293	Called whenever the view offset changes, i..e the user or program	557	Called whenever the view offset changes, i.e. the user or program
294	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
295	show this many lines of scrollback.	559	show this many lines of scrollback.
296		560
297	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
298		562
…		…
302		566
303	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	567	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
304	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	568	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
305	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
306		570
307	=item on_osc_seq $term, $string	571	=item on_osc_seq $term, $op, $args, $resp
		572
		573	Called on every OSC sequence and can be used to suppress it or modify its
		574	behaviour. The default should be to return an empty list. A true value
		575	suppresses execution of the request completely. Make sure you don't get
		576	confused by recursive invocations when you output an OSC sequence within
		577	this callback.
		578
		579	C<on_osc_seq_perl> should be used for new behaviour.
		580
		581	=item on_osc_seq_perl $term, $args, $resp
308		582
309	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
310	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
311	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
312	string should start with the extension name and a colon, to distinguish	586	string should start with the extension name (sans -osc) and a semicolon,
313	it from commands for other extensions, and this might be enforced in the	587	to distinguish it from commands for other extensions, and this might be
314	future.	588	enforced in the future.
		589
		590	For example, C<overlay-osc> uses this:
		591
		592	sub on_osc_seq_perl {
		593	my ($self, $osc, $resp) = @_;
		594
		595	return unless $osc =~ s/^overlay;//;
		596
		597	... process remaining $osc string
		598	}
315		599
316	Be careful not ever to trust (in a security sense) the data you receive,	600	Be careful not ever to trust (in a security sense) the data you receive,
317	as its source can not easily be controleld (e-mail content, messages from	601	as its source can not easily be controlled (e-mail content, messages from
318	other users on the same system etc.).	602	other users on the same system etc.).
		603
		604	For responses, C<$resp> contains the end-of-args separator used by the
		605	sender.
319		606
320	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
321		608
322	Called whenever text is about to be output, with the text as argument. You	609	Called whenever text is about to be output, with the text as argument. You
323	can filter/change and output the text yourself by returning a true value	610	can filter/change and output the text yourself by returning a true value
…		…
328	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
329		616
330	Called whenever some data is written to the tty/pty and can be used to	617	Called whenever some data is written to the tty/pty and can be used to
331	suppress or filter tty input.	618	suppress or filter tty input.
332		619
		620	=item on_tt_paste $term, $octets
		621
		622	Called whenever text is about to be pasted, with the text as argument. You
		623	can filter/change and paste the text yourself by returning a true value
		624	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		625	locale-encoded.
		626
333	=item on_line_update $term, $row	627	=item on_line_update $term, $row
334		628
335	Called whenever a line was updated or changed. Can be used to filter	629	Called whenever a line was updated or changed. Can be used to filter
336	screen output (e.g. underline urls or other useless stuff). Only lines	630	screen output (e.g. underline urls or other useless stuff). Only lines
337	that are being shown will be filtered, and, due to performance reasons,	631	that are being shown will be filtered, and, due to performance reasons,
…		…
344	later with the already-modified line (e.g. if unrelated parts change), so	638	later with the already-modified line (e.g. if unrelated parts change), so
345	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
346		640
347	=item on_refresh_begin $term	641	=item on_refresh_begin $term
348		642
349	Called just before the screen gets redrawn. Can be used for overlay	643	Called just before the screen gets redrawn. Can be used for overlay or
350	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
351	restoring them in refresh_end. The built-in overlay and selection display	645	restoring them in refresh_end. The built-in overlay and selection display
352	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
353		647
354	=item on_refresh_end $term	648	=item on_refresh_end $term
355		649
356	Called just after the screen gets redrawn. See C<on_refresh_begin>.	650	Called just after the screen gets redrawn. See C<on_refresh_begin>.
357		651
358	=item on_keyboard_command $term, $string	652	=item on_user_command $term, $string
359		653
360	Called whenever the user presses a key combination that has a	654	Called whenever a user-configured event is being activated (e.g. via
361	C<perl:string> action bound to it (see description of the B<keysym>	655	a C<perl:string> action bound to a key, see description of the B<keysym>
362	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
		657
		658	The event is simply the action string. This interface is assumed to change
		659	slightly in the future.
		660
		661	=item on_resize_all_windows $term, $new_width, $new_height
		662
		663	Called just after the new window size has been calculated, but before
		664	windows are actually being resized or hints are being set. If this hook
		665	returns TRUE, setting of the window hints is being skipped.
		666
		667	=item on_x_event $term, $event
		668
		669	Called on every X event received on the vt window (and possibly other
		670	windows). Should only be used as a last resort. Most event structure
		671	members are not passed.
		672
		673	=item on_root_event $term, $event
		674
		675	Like C<on_x_event>, but is called for events on the root window.
363		676
364	=item on_focus_in $term	677	=item on_focus_in $term
365		678
366	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
367	does focus in processing.	680	does focus in processing.
368		681
369	=item on_focus_out $term	682	=item on_focus_out $term
370		683
371	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
372	focus out processing.	685	focus out processing.
373		686
		687	=item on_configure_notify $term, $event
		688
		689	=item on_property_notify $term, $event
		690
374	=item on_key_press $term, $event, $keysym, $octets	691	=item on_key_press $term, $event, $keysym, $octets
375		692
376	=item on_key_release $term, $event, $keysym	693	=item on_key_release $term, $event, $keysym
377		694
378	=item on_button_press $term, $event	695	=item on_button_press $term, $event
…		…
383		700
384	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
385		702
386	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
387		704
388	Called whenever the corresponding X event is received for the terminal If	705	Called whenever the corresponding X event is received for the terminal. If
389	the hook returns true, then the even will be ignored by rxvt-unicode.	706	the hook returns true, then the event will be ignored by rxvt-unicode.
390		707
391	The event is a hash with most values as named by Xlib (see the XEvent	708	The event is a hash with most values as named by Xlib (see the XEvent
392	manpage), with the additional members C<row> and C<col>, which are the row	709	manpage), with the additional members C<row> and C<col>, which are the
393	and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
394		711
395	C<on_key_press> additionally receives the string rxvt-unicode would	712	C<on_key_press> additionally receives the string rxvt-unicode would
396	output, if any, in locale-specific encoding.	713	output, if any, in locale-specific encoding.
397		714
398	subwindow.	715	subwindow.
		716
		717	=item on_client_message $term, $event
		718
		719	=item on_wm_protocols $term, $event
		720
		721	=item on_wm_delete_window $term, $event
		722
		723	Called when various types of ClientMessage events are received (all with
		724	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		725
		726	=item on_bell $term
		727
		728	Called on receipt of a bell character.
399		729
400	=back	730	=back
401		731
402	=cut	732	=cut
403		733
…		…
409	use Scalar::Util ();	739	use Scalar::Util ();
410	use List::Util ();	740	use List::Util ();
411		741
412	our $VERSION = 1;	742	our $VERSION = 1;
413	our $TERM;	743	our $TERM;
		744	our @TERM_INIT;
		745	our @TERM_EXT;
414	our @HOOKNAME;	746	our @HOOKNAME;
415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	747	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
416	our %OPTION;	748	our %OPTION;
417		749
418	our $LIBDIR;	750	our $LIBDIR;
419	our $RESNAME;	751	our $RESNAME;
420	our $RESCLASS;	752	our $RESCLASS;
421	our $RXVTNAME;	753	our $RXVTNAME;
422		754
		755	our $NOCHAR = chr 0xffff;
		756
423	=head2 Variables in the C<urxvt> Package	757	=head2 Variables in the C<urxvt> Package
424		758
425	=over 4	759	=over 4
426		760
427	=item $urxvt::LIBDIR	761	=item $urxvt::LIBDIR
…		…
440	=item $urxvt::TERM	774	=item $urxvt::TERM
441		775
442	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
443	object, whenever a callback/hook is executing.	777	object, whenever a callback/hook is executing.
444		778
		779	=item @urxvt::TERM_INIT
		780
		781	All code references in this array will be called as methods of the next newly
		782	created C<urxvt::term> object (during the C<on_init> phase). The array
		783	gets cleared before the code references that were in it are being executed,
		784	so references can push themselves onto it again if they so desire.
		785
		786	This complements to the perl-eval command line option, but gets executed
		787	first.
		788
		789	=item @urxvt::TERM_EXT
		790
		791	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		792	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		793	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		794
445	=back	795	=back
446		796
447	=head2 Functions in the C<urxvt> Package	797	=head2 Functions in the C<urxvt> Package
448		798
449	=over 4	799	=over 4
450		800
451	=item urxvt::fatal $errormessage	801	=item urxvt::fatal $errormessage
452		802
453	Fatally aborts execution with the given error message. Avoid at all	803	Fatally aborts execution with the given error message (which should
454	costs! The only time this is acceptable is when the terminal process	804	include a trailing newline). Avoid at all costs! The only time this
455	starts up.	805	is acceptable (and useful) is in the init hook, where it prevents the
		806	terminal from starting up.
456		807
457	=item urxvt::warn $string	808	=item urxvt::warn $string
458		809
459	Calls C<rxvt_warn> with the given string which should not include a	810	Calls C<rxvt_warn> with the given string which should include a trailing
460	newline. The module also overwrites the C<warn> builtin with a function	811	newline. The module also overwrites the C<warn> builtin with a function
461	that calls this function.	812	that calls this function.
462		813
463	Using this function has the advantage that its output ends up in the	814	Using this function has the advantage that its output ends up in the
464	correct place, e.g. on stderr of the connecting urxvtc client.	815	correct place, e.g. on stderr of the connecting urxvtc client.
465		816
466	Messages have a size limit of 1023 bytes currently.	817	Messages have a size limit of 1023 bytes currently.
467		818
468	=item $is_safe = urxvt::safe	819	=item @terms = urxvt::termlist
469		820
470	Returns true when it is safe to do potentially unsafe things, such as	821	Returns all urxvt::term objects that exist in this process, regardless of
471	evaluating perl code specified by the user. This is true when urxvt was	822	whether they are started, being destroyed etc., so be careful. Only term
472	started setuid or setgid.	823	objects that have perl extensions attached will be returned (because there
		824	is no urxvt::term object associated with others).
473		825
474	=item $time = urxvt::NOW	826	=item $time = urxvt::NOW
475		827
476	Returns the "current time" (as per the event loop).	828	Returns the "current time" (as per the event loop).
477		829
478	=item urxvt::CurrentTime	830	=item urxvt::CurrentTime
479		831
480	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	832	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
481	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	833	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
482	Button4Mask, Button5Mask, AnyModifier	834	Button4Mask, Button5Mask, AnyModifier
		835
		836	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		837	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		838	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		839	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		840	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		841	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		842	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		843
		844	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		845	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		846	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		847	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		848	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		849	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		850	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
483		851
484	Various constants for use in X calls and event processing.	852	Various constants for use in X calls and event processing.
485		853
486	=back	854	=back
487		855
…		…
504		872
505	=item $rend = urxvt::OVERLAY_RSTYLE	873	=item $rend = urxvt::OVERLAY_RSTYLE
506		874
507	Return the rendition mask used for overlays by default.	875	Return the rendition mask used for overlays by default.
508		876
509	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	877	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		878	urxvt::RS_RVid, urxvt::RS_Uline
510		879
511	Return the bit that enabled bold, italic, blink, reverse-video and	880	Return the bit that enabled bold, italic, blink, reverse-video and
512	underline, respectively. To enable such a style, just logically OR it into	881	underline, respectively. To enable such a style, just logically OR it into
513	the bitset.	882	the bitset.
514		883
…		…
520		889
521	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	890	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
522		891
523	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	892	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
524		893
		894	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		895
525	Replace the foreground/background colour in the rendition mask with the	896	Replace the foreground/background colour in the rendition mask with the
526	specified one.	897	specified one.
527		898
528	=item $value = urxvt::GET_CUSTOM $rend	899	=item $value = urxvt::GET_CUSTOM $rend
529		900
…		…
538	=back	909	=back
539		910
540	=cut	911	=cut
541		912
542	BEGIN {	913	BEGIN {
543	urxvt->bootstrap;
544
545	# overwrite perl's warn	914	# overwrite perl's warn
546	*CORE::GLOBAL::warn = sub {	915	*CORE::GLOBAL::warn = sub {
547	my $msg = join "", @_;	916	my $msg = join "", @_;
548	$msg .= "\n"	917	$msg .= "\n"
549	unless $msg =~ /\n$/;	918	unless $msg =~ /\n$/;
550	urxvt::warn ($msg);	919	urxvt::warn ($msg);
551	};	920	};
552
553	# %ENV is the original startup environment
554	delete $ENV{IFS};
555	delete $ENV{CDPATH};
556	delete $ENV{BASH_ENV};
557	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
558	}	921	}
559		922
560	my @hook_count;	923	no warnings 'utf8';
		924
561	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	925	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
562		926
563	sub verbose {	927	sub verbose {
564	my ($level, $msg) = @_;	928	my ($level, $msg) = @_;
565	warn "$msg\n" if $level <= $verbosity;	929	warn "$msg\n" if $level <= $verbosity;
566	}	930	}
567		931
568	my $extension_pkg = "extension0000";
569	my %extension_pkg;	932	my %extension_pkg;
570		933
571	# load a single script into its own package, once only	934	# load a single script into its own package, once only
572	sub extension_package($) {	935	sub extension_package($) {
573	my ($path) = @_;	936	my ($path) = @_;
574		937
575	$extension_pkg{$path} ||= do {	938	$extension_pkg{$path} ||= do {
576	my $pkg = "urxvt::" . ($extension_pkg++);	939	$path =~ /([^\/\\]+)$/;
		940	my $pkg = $1;
		941	$pkg =~ s/[^[:word:]]/_/g;
		942	$pkg = "urxvt::ext::$pkg";
577		943
578	verbose 3, "loading extension '$path' into package '$pkg'";	944	verbose 3, "loading extension '$path' into package '$pkg'";
579		945
580	open my $fh, "<:raw", $path	946	open my $fh, "<:raw", $path
581	or die "$path: $!";	947	or die "$path: $!";
582		948
583	my $source = untaint	949	my $source =
584	"package $pkg; use strict; use utf8;\n"	950	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
585	. "use base urxvt::term::extension::;\n"
586	. "#line 1 \"$path\"\n{\n"	951	. "#line 1 \"$path\"\n{\n"
587	. (do { local $/; <$fh> })	952	. (do { local $/; <$fh> })
588	. "\n};\n1";	953	. "\n};\n1";
589		954
590	eval $source	955	eval $source
…		…
601	local $TERM = shift;	966	local $TERM = shift;
602	my $htype = shift;	967	my $htype = shift;
603		968
604	if ($htype == 0) { # INIT	969	if ($htype == 0) { # INIT
605	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	970	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
606		971
607	my %ext_arg;	972	my %ext_arg;
608		973
		974	{
		975	my @init = @TERM_INIT;
		976	@TERM_INIT = ();
		977	$_->($TERM) for @init;
		978	my @pkg = @TERM_EXT;
		979	@TERM_EXT = ();
		980	$TERM->register_package ($_) for @pkg;
		981	}
		982
609	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	983	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
610	if ($_ eq "default") {	984	if ($_ eq "default") {
611	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	985	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
612	} elsif (/^-(.*)$/) {	986	} elsif (/^-(.*)$/) {
613	delete $ext_arg{$1};	987	delete $ext_arg{$1};
614	} elsif (/^([^<]+)<(.*)>$/) {	988	} elsif (/^([^<]+)<(.*)>$/) {
615	push @{ $ext_arg{$1} }, $2;	989	push @{ $ext_arg{$1} }, $2;
616	} else {	990	} else {
617	$ext_arg{$_} ||= [];	991	$ext_arg{$_} ||= [];
618	}	992	}
619	}	993	}
620		994
621	while (my ($ext, $argv) = each %ext_arg) {	995	for my $ext (sort keys %ext_arg) {
622	my @files = grep -f $_, map "$_/$ext", @dirs;	996	my @files = grep -f $_, map "$_/$ext", @dirs;
623		997
624	if (@files) {	998	if (@files) {
625	$TERM->register_package (extension_package $files[0], $argv);	999	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
626	} else {	1000	} else {
627	warn "perl extension '$ext' not found in perl library search path\n";	1001	warn "perl extension '$ext' not found in perl library search path\n";
628	}	1002	}
629	}	1003	}
630		1004
…		…
636		1010
637	if (my $cb = $TERM->{_hook}[$htype]) {	1011	if (my $cb = $TERM->{_hook}[$htype]) {
638	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1012	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
639	if $verbosity >= 10;	1013	if $verbosity >= 10;
640		1014
641	keys %$cb;	1015	for my $pkg (keys %$cb) {
642
643	while (my ($pkg, $cb) = each %$cb) {
644	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1016	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
645	and last;	1017	$retval ||= $retval_;
646		1018
647	if ($@) {	1019	if ($@) {
648	$TERM->ungrab; # better to lose the grab than the session	1020	$TERM->ungrab; # better to lose the grab than the session
649	warn $@;	1021	warn $@;
650	}	1022	}
…		…
653	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	1025	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
654	if $verbosity >= 11;	1026	if $verbosity >= 11;
655	}	1027	}
656		1028
657	if ($htype == 1) { # DESTROY	1029	if ($htype == 1) { # DESTROY
658	if (my $hook = delete $TERM->{_hook}) {
659	for my $htype (0..$#$hook) {
660	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
661	or set_should_invoke $htype, 0;
662	}
663	}
664
665	# clear package objects	1030	# clear package objects
666	%$_ = () for values %{ $TERM->{_pkg} };	1031	%$_ = () for values %{ $TERM->{_pkg} };
667		1032
668	# clear package	1033	# clear package
669	%$TERM = ();	1034	%$TERM = ();
670	}	1035	}
671		1036
672	$retval	1037	$retval
673	}	1038	}
674		1039
675	sub exec_async(@) {	1040	sub SET_COLOR($$$) {
676	my $pid = fork;	1041	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1042	}
677		1043
678	return	1044	sub rend2mask {
679	if !defined $pid or $pid;	1045	no strict 'refs';
680		1046	my ($str, $mask) = (@_, 0);
681	%ENV = %{ $TERM->env };	1047	my %color = ( fg => undef, bg => undef );
682		1048	my @failed;
683	exec @_;	1049	for my $spec ( split /\s+/, $str ) {
684	_exit 255;	1050	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1051	$color{lc($1)} = $2;
		1052	} else {
		1053	my $neg = $spec =~ s/^[-^]//;
		1054	unless ( exists &{"RS_$spec"} ) {
		1055	push @failed, $spec;
		1056	next;
		1057	}
		1058	my $cur = &{"RS_$spec"};
		1059	if ( $neg ) {
		1060	$mask &= ~$cur;
		1061	} else {
		1062	$mask |= $cur;
		1063	}
		1064	}
		1065	}
		1066	($mask, @color{qw(fg bg)}, \@failed)
685	}	1067	}
686		1068
687	# urxvt::term::extension	1069	# urxvt::term::extension
688		1070
689	package urxvt::term::extension;	1071	package urxvt::term::extension;
…		…
695	while (my ($name, $cb) = each %hook) {	1077	while (my ($name, $cb) = each %hook) {
696	my $htype = $HOOKTYPE{uc $name};	1078	my $htype = $HOOKTYPE{uc $name};
697	defined $htype	1079	defined $htype
698	or Carp::croak "unsupported hook type '$name'";	1080	or Carp::croak "unsupported hook type '$name'";
699		1081
		1082	$self->set_should_invoke ($htype, +1)
700	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1083	unless exists $self->{term}{_hook}[$htype]{$pkg};
701	$hook_count[$htype]++
702	or urxvt::set_should_invoke $htype, 1;
703	}
704		1084
705	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1085	$self->{term}{_hook}[$htype]{$pkg} = $cb;
706	}	1086	}
707	}	1087	}
708		1088
…		…
713	for my $name (@hook) {	1093	for my $name (@hook) {
714	my $htype = $HOOKTYPE{uc $name};	1094	my $htype = $HOOKTYPE{uc $name};
715	defined $htype	1095	defined $htype
716	or Carp::croak "unsupported hook type '$name'";	1096	or Carp::croak "unsupported hook type '$name'";
717		1097
		1098	$self->set_should_invoke ($htype, -1)
718	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1099	if delete $self->{term}{_hook}[$htype]{$pkg};
719	--$hook_count[$htype]
720	or urxvt::set_should_invoke $htype, 0;
721	}
722	}	1100	}
723	}	1101	}
724		1102
725	our $AUTOLOAD;	1103	our $AUTOLOAD;
726		1104
…		…
764	is that you cannot use blocking APIs, but the non-blocking variant should	1142	is that you cannot use blocking APIs, but the non-blocking variant should
765	work.	1143	work.
766		1144
767	=cut	1145	=cut
768		1146
769	our $VERSION = 1;	1147	our $VERSION = '5.23';
770		1148
771	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1149	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
772	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1150	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
773		1151
774	sub timer {	1152	sub timer {
…		…
776		1154
777	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
778		1156
779	urxvt::timer	1157	urxvt::timer
780	->new	1158	->new
781	->start (urxvt::NOW + $arg{after})	1159	->after ($arg{after}, $arg{interval})
782	->cb (sub {	1160	->cb ($arg{interval} ? $cb : sub {
783	$_[0]->stop; # need to cancel manually	1161	$_[0]->stop; # need to cancel manually
784	$cb->();	1162	$cb->();
785	})	1163	})
786	}	1164	}
787		1165
788	sub io {	1166	sub io {
789	my ($class, %arg) = @_;	1167	my ($class, %arg) = @_;
790		1168
791	my $cb = $arg{cb};	1169	my $cb = $arg{cb};
		1170	my $fd = fileno $arg{fh};
		1171	defined $fd or $fd = $arg{fh};
792		1172
793	bless [$arg{fh}, urxvt::iow	1173	bless [$arg{fh}, urxvt::iow
794	->new	1174	->new
795	->fd (fileno $arg{fh})	1175	->fd ($fd)
796	->events (($arg{poll} =~ /r/ ? 1 : 0)	1176	->events (($arg{poll} =~ /r/ ? 1 : 0)
797	| ($arg{poll} =~ /w/ ? 2 : 0))	1177	| ($arg{poll} =~ /w/ ? 2 : 0))
798	->start	1178	->start
799	->cb (sub {	1179	->cb ($cb)
800	$cb->(($_[1] & 1 ? 'r' : '')
801	. ($_[1] & 2 ? 'w' : ''));
802	})],
803	urxvt::anyevent::	1180	], urxvt::anyevent::
		1181	}
		1182
		1183	sub idle {
		1184	my ($class, %arg) = @_;
		1185
		1186	my $cb = $arg{cb};
		1187
		1188	urxvt::iw
		1189	->new
		1190	->start
		1191	->cb ($cb)
		1192	}
		1193
		1194	sub child {
		1195	my ($class, %arg) = @_;
		1196
		1197	my $cb = $arg{cb};
		1198
		1199	urxvt::pw
		1200	->new
		1201	->start ($arg{pid})
		1202	->cb (sub {
		1203	$_[0]->stop; # need to cancel manually
		1204	$cb->($_[0]->rpid, $_[0]->rstatus);
		1205	})
804	}	1206	}
805		1207
806	sub DESTROY {	1208	sub DESTROY {
807	$_[0][1]->stop;	1209	$_[0][1]->stop;
808	}	1210	}
809		1211
810	sub condvar {	1212	sub one_event {
811	bless \my $flag, urxvt::anyevent::condvar::
812	}
813
814	sub urxvt::anyevent::condvar::broadcast {
815	${$_[0]}++;
816	}
817
818	sub urxvt::anyevent::condvar::wait {
819	unless (${$_[0]}) {
820	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1213	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
821	}
822	}	1214	}
823		1215
824	package urxvt::term;	1216	package urxvt::term;
825		1217
826	=head2 The C<urxvt::term> Class	1218	=head2 The C<urxvt::term> Class
…		…
831		1223
832	# find on_xxx subs in the package and register them	1224	# find on_xxx subs in the package and register them
833	# as hooks	1225	# as hooks
834	sub register_package {	1226	sub register_package {
835	my ($self, $pkg, $argv) = @_;	1227	my ($self, $pkg, $argv) = @_;
		1228
		1229	no strict 'refs';
		1230
		1231	urxvt::verbose 6, "register package $pkg to $self";
		1232
		1233	@{"$pkg\::ISA"} = urxvt::term::extension::;
836		1234
837	my $proxy = bless {	1235	my $proxy = bless {
838	_pkg => $pkg,	1236	_pkg => $pkg,
839	argv => $argv,	1237	argv => $argv,
840	}, $pkg;	1238	}, $pkg;
…		…
856	hash which defines the environment of the new terminal.	1254	hash which defines the environment of the new terminal.
857		1255
858	Croaks (and probably outputs an error message) if the new instance	1256	Croaks (and probably outputs an error message) if the new instance
859	couldn't be created. Returns C<undef> if the new instance didn't	1257	couldn't be created. Returns C<undef> if the new instance didn't
860	initialise perl, and the terminal object otherwise. The C<init> and	1258	initialise perl, and the terminal object otherwise. The C<init> and
861	C<start> hooks will be called during this call.	1259	C<start> hooks will be called before this call returns, and are free to
		1260	refer to global data (which is race free).
862		1261
863	=cut	1262	=cut
864		1263
865	sub new {	1264	sub new {
866	my ($class, $env, @args) = @_;	1265	my ($class, $env, @args) = @_;
867		1266
		1267	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1268	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1269
868	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1270	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
869	}	1271	}
870		1272
871	=item $term->destroy	1273	=item $term->destroy
872		1274
873	Destroy the terminal object (close the window, free resources	1275	Destroy the terminal object (close the window, free resources
874	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1276	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
875	watchers (timers, io watchers) are still active.	1277	watchers (timers, io watchers) are still active.
876		1278
		1279	=item $term->exec_async ($cmd[, @args])
		1280
		1281	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1282	("starts") programs in the background. This function takes care of setting
		1283	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1284	be preferred over explicit calls to C<exec> or C<system>.
		1285
		1286	Returns the pid of the subprocess or C<undef> on error.
		1287
		1288	=cut
		1289
		1290	sub exec_async {
		1291	my $self = shift;
		1292
		1293	my $pid = fork;
		1294
		1295	return $pid
		1296	if !defined $pid or $pid;
		1297
		1298	%ENV = %{ $self->env };
		1299
		1300	exec @_;
		1301	urxvt::_exit 255;
		1302	}
		1303
877	=item $isset = $term->option ($optval[, $set])	1304	=item $isset = $term->option ($optval[, $set])
878		1305
879	Returns true if the option specified by C<$optval> is enabled, and	1306	Returns true if the option specified by C<$optval> is enabled, and
880	optionally change it. All option values are stored by name in the hash	1307	optionally change it. All option values are stored by name in the hash
881	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1308	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
882		1309
883	Here is a a likely non-exhaustive list of option names, please see the	1310	Here is a likely non-exhaustive list of option names, please see the
884	source file F</src/optinc.h> to see the actual list:	1311	source file F</src/optinc.h> to see the actual list:
885		1312
886	borderLess console cursorBlink cursorUnderline hold iconic insecure	1313	borderLess console cursorBlink cursorUnderline hold iconic insecure
887	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1314	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
888	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1315	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
889	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1316	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
890	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1317	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
891	tripleclickwords utmpInhibit visualBell	1318	transparent tripleclickwords utmpInhibit visualBell
892		1319
893	=item $value = $term->resource ($name[, $newval])	1320	=item $value = $term->resource ($name[, $newval])
894		1321
895	Returns the current resource value associated with a given name and	1322	Returns the current resource value associated with a given name and
896	optionally sets a new value. Setting values is most useful in the C<init>	1323	optionally sets a new value. Setting values is most useful in the C<init>
…		…
905	likely change).	1332	likely change).
906		1333
907	Please note that resource strings will currently only be freed when the	1334	Please note that resource strings will currently only be freed when the
908	terminal is destroyed, so changing options frequently will eat memory.	1335	terminal is destroyed, so changing options frequently will eat memory.
909		1336
910	Here is a a likely non-exhaustive list of resource names, not all of which	1337	Here is a likely non-exhaustive list of resource names, not all of which
911	are supported in every build, please see the source file F</src/rsinc.h>	1338	are supported in every build, please see the source file F</src/rsinc.h>
912	to see the actual list:	1339	to see the actual list:
913		1340
914	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1341	answerbackstring backgroundPixmap backspace_key blendtype blurradius
915	borderLess color cursorBlink cursorUnderline cutchars delete_key	1342	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
916	display_name embed ext_bwidth fade font geometry hold iconName	1343	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
917	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1344	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1345	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
918	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1346	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
919	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1347	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
920	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1348	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
921	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1349	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
922	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1350	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
923	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1351	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
924	shade term_name title transparent transparent_all tripleclickwords	1352	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1353	term_name title transient_for transparent tripleclickwords urgentOnBell
925	utmpInhibit visualBell	1354	utmpInhibit visualBell
926		1355
927	=cut	1356	=cut
928		1357
929	sub resource($$;$) {	1358	sub resource($$;$) {
930	my ($self, $name) = (shift, shift);	1359	my ($self, $name) = (shift, shift);
931	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1360	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
932	&urxvt::term::_resource	1361	goto &urxvt::term::_resource
933	}	1362	}
934		1363
935	=item $value = $term->x_resource ($pattern)	1364	=item $value = $term->x_resource ($pattern)
936		1365
937	Returns the X-Resource for the given pattern, excluding the program or	1366	Returns the X-Resource for the given pattern, excluding the program or
…		…
962		1391
963	=item ($row, $col) = $term->selection_beg ([$row, $col])	1392	=item ($row, $col) = $term->selection_beg ([$row, $col])
964		1393
965	=item ($row, $col) = $term->selection_end ([$row, $col])	1394	=item ($row, $col) = $term->selection_end ([$row, $col])
966		1395
967	Return the current values of the selection mark, begin or end positions,	1396	Return the current values of the selection mark, begin or end positions.
968	and optionally set them to new values.	1397
		1398	When arguments are given, then the selection coordinates are set to
		1399	C<$row> and C<$col>, and the selection screen is set to the current
		1400	screen.
		1401
		1402	=item $screen = $term->selection_screen ([$screen])
		1403
		1404	Returns the current selection screen, and then optionally sets it.
969		1405
970	=item $term->selection_make ($eventtime[, $rectangular])	1406	=item $term->selection_make ($eventtime[, $rectangular])
971		1407
972	Tries to make a selection as set by C<selection_beg> and	1408	Tries to make a selection as set by C<selection_beg> and
973	C<selection_end>. If C<$rectangular> is true (default: false), a	1409	C<selection_end>. If C<$rectangular> is true (default: false), a
974	rectangular selection will be made. This is the prefered function to make	1410	rectangular selection will be made. This is the preferred function to make
975	a selection.	1411	a selection.
976		1412
977	=item $success = $term->selection_grab ($eventtime)	1413	=item $success = $term->selection_grab ($eventtime[, $clipboard])
978		1414
979	Try to request the primary selection text from the server (for example, as	1415	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1416	true) selection from the server. The corresponding text can be set
980	set by the next method). No visual feedback will be given. This function	1417	with the next method. No visual feedback will be given. This function
981	is mostly useful from within C<on_sel_grab> hooks.	1418	is mostly useful from within C<on_sel_grab> hooks.
982		1419
983	=item $oldtext = $term->selection ([$newtext])	1420	=item $oldtext = $term->selection ([$newtext, $clipboard])
984		1421
985	Return the current selection text and optionally replace it by C<$newtext>.	1422	Return the current selection (clipboard if C<$clipboard> is true) text
		1423	and optionally replace it by C<$newtext>.
		1424
		1425	=item $term->selection_clear ([$clipboard])
		1426
		1427	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
986		1428
987	=item $term->overlay_simple ($x, $y, $text)	1429	=item $term->overlay_simple ($x, $y, $text)
988		1430
989	Create a simple multi-line overlay box. See the next method for details.	1431	Create a simple multi-line overlay box. See the next method for details.
990		1432
…		…
1020		1462
1021	The methods currently supported on C<urxvt::overlay> objects are:	1463	The methods currently supported on C<urxvt::overlay> objects are:
1022		1464
1023	=over 4	1465	=over 4
1024		1466
1025	=item $overlay->set ($x, $y, $text, $rend)	1467	=item $overlay->set ($x, $y, $text[, $rend])
1026		1468
1027	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1469	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1028	text in rxvt-unicode's special encoding and an array of rendition values	1470	text in rxvt-unicode's special encoding and an array of rendition values
1029	at a specific position inside the overlay.	1471	at a specific position inside the overlay.
		1472
		1473	If C<$rend> is missing, then the rendition will not be changed.
1030		1474
1031	=item $overlay->hide	1475	=item $overlay->hide
1032		1476
1033	If visible, hide the overlay, but do not destroy it.	1477	If visible, hide the overlay, but do not destroy it.
1034		1478
…		…
1104		1548
1105	Normally its not a good idea to use this function, as programs might be	1549	Normally its not a good idea to use this function, as programs might be
1106	confused by changes in cursor position or scrolling. Its useful inside a	1550	confused by changes in cursor position or scrolling. Its useful inside a
1107	C<on_add_lines> hook, though.	1551	C<on_add_lines> hook, though.
1108		1552
		1553	=item $term->scr_change_screen ($screen)
		1554
		1555	Switch to given screen - 0 primary, 1 secondary.
		1556
1109	=item $term->cmd_parse ($octets)	1557	=item $term->cmd_parse ($octets)
1110		1558
1111	Similar to C<scr_add_lines>, but the argument must be in the	1559	Similar to C<scr_add_lines>, but the argument must be in the
1112	locale-specific encoding of the terminal and can contain command sequences	1560	locale-specific encoding of the terminal and can contain command sequences
1113	(escape codes) that will be interpreted.	1561	(escape codes) that will be interpreted.
1114		1562
1115	=item $term->tt_write ($octets)	1563	=item $term->tt_write ($octets)
1116		1564
1117	Write the octets given in C<$data> to the tty (i.e. as program input). To	1565	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1118	pass characters instead of octets, you should convert your strings first	1566	pass characters instead of octets, you should convert your strings first
1119	to the locale-specific encoding using C<< $term->locale_encode >>.	1567	to the locale-specific encoding using C<< $term->locale_encode >>.
		1568
		1569	=item $term->tt_paste ($octets)
		1570
		1571	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1572	CR and bracketing the data with control sequences if bracketed paste mode
		1573	is set.
1120		1574
1121	=item $old_events = $term->pty_ev_events ([$new_events])	1575	=item $old_events = $term->pty_ev_events ([$new_events])
1122		1576
1123	Replaces the event mask of the pty watcher by the given event mask. Can	1577	Replaces the event mask of the pty watcher by the given event mask. Can
1124	be used to suppress input and output handling to the pty/tty. See the	1578	be used to suppress input and output handling to the pty/tty. See the
1125	description of C<< urxvt::timer->events >>. Make sure to always restore	1579	description of C<< urxvt::timer->events >>. Make sure to always restore
1126	the previous value.	1580	the previous value.
1127		1581
		1582	=item $fd = $term->pty_fd
		1583
		1584	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1585	is used.
		1586
1128	=item $windowid = $term->parent	1587	=item $windowid = $term->parent
1129		1588
1130	Return the window id of the toplevel window.	1589	Return the window id of the toplevel window.
1131		1590
1132	=item $windowid = $term->vt	1591	=item $windowid = $term->vt
1133		1592
1134	Return the window id of the terminal window.	1593	Return the window id of the terminal window.
1135		1594
		1595	=item $term->vt_emask_add ($x_event_mask)
		1596
		1597	Adds the specified events to the vt event mask. Useful e.g. when you want
		1598	to receive pointer events all the times:
		1599
		1600	$term->vt_emask_add (urxvt::PointerMotionMask);
		1601
		1602	=item $term->focus_in
		1603
		1604	=item $term->focus_out
		1605
		1606	=item $term->key_press ($state, $keycode[, $time])
		1607
		1608	=item $term->key_release ($state, $keycode[, $time])
		1609
		1610	Deliver various fake events to to terminal.
		1611
1136	=item $window_width = $term->width	1612	=item $window_width = $term->width
1137		1613
1138	=item $window_height = $term->height	1614	=item $window_height = $term->height
1139		1615
1140	=item $font_width = $term->fwidth	1616	=item $font_width = $term->fwidth
…		…
1153		1629
1154	=item $max_scrollback = $term->saveLines	1630	=item $max_scrollback = $term->saveLines
1155		1631
1156	=item $nrow_plus_saveLines = $term->total_rows	1632	=item $nrow_plus_saveLines = $term->total_rows
1157		1633
1158	=item $lines_in_scrollback = $term->nsaved	1634	=item $topmost_scrollback_row = $term->top_row
1159		1635
1160	Return various integers describing terminal characteristics.	1636	Return various integers describing terminal characteristics.
1161		1637
1162	=item $x_display = $term->display_id	1638	=item $x_display = $term->display_id
1163		1639
…		…
1170	=item $env = $term->env	1646	=item $env = $term->env
1171		1647
1172	Returns a copy of the environment in effect for the terminal as a hashref	1648	Returns a copy of the environment in effect for the terminal as a hashref
1173	similar to C<\%ENV>.	1649	similar to C<\%ENV>.
1174		1650
		1651	=item @envv = $term->envv
		1652
		1653	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1654
		1655	=item @argv = $term->argv
		1656
		1657	Return the argument vector as this terminal, similar to @ARGV, but
		1658	includes the program name as first element.
		1659
1175	=cut	1660	=cut
1176		1661
1177	sub env {	1662	sub env {
1178	if (my $env = $_[0]->_env) {
1179	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1663	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1180	} else {
1181	+{ %ENV }
1182	}
1183	}	1664	}
1184		1665
1185	=item $modifiermask = $term->ModLevel3Mask	1666	=item $modifiermask = $term->ModLevel3Mask
1186		1667
1187	=item $modifiermask = $term->ModMetaMask	1668	=item $modifiermask = $term->ModMetaMask
…		…
1189	=item $modifiermask = $term->ModNumLockMask	1670	=item $modifiermask = $term->ModNumLockMask
1190		1671
1191	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1672	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1192	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1673	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1193		1674
		1675	=item $screen = $term->current_screen
		1676
		1677	Returns the currently displayed screen (0 primary, 1 secondary).
		1678
		1679	=item $cursor_is_hidden = $term->hidden_cursor
		1680
		1681	Returns whether the cursor is currently hidden or not.
		1682
1194	=item $view_start = $term->view_start ([$newvalue])	1683	=item $view_start = $term->view_start ([$newvalue])
1195		1684
1196	Returns the negative row number of the topmost line. Minimum value is	1685	Returns the row number of the topmost displayed line. Maximum value is
1197	C<0>, which displays the normal terminal contents. Larger values scroll	1686	C<0>, which displays the normal terminal contents. Lower values scroll
1198	this many lines into the scrollback buffer.	1687	this many lines into the scrollback buffer.
1199		1688
1200	=item $term->want_refresh	1689	=item $term->want_refresh
1201		1690
1202	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1691	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1205		1694
1206	Used after changing terminal contents to display them.	1695	Used after changing terminal contents to display them.
1207		1696
1208	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1697	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1209		1698
1210	Returns the text of the entire row with number C<$row_number>. Row C<0>	1699	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1211	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1700	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1212	terminal line. The scrollback buffer starts at line C<-1> and extends to
1213	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1701	terminal line. Nothing will be returned if a nonexistent line
1214	is requested.	1702	is requested.
1215		1703
1216	If C<$new_text> is specified, it will replace characters in the current	1704	If C<$new_text> is specified, it will replace characters in the current
1217	line, starting at column C<$start_col> (default C<0>), which is useful	1705	line, starting at column C<$start_col> (default C<0>), which is useful
1218	to replace only parts of a line. The font index in the rendition will	1706	to replace only parts of a line. The font index in the rendition will
1219	automatically be updated.	1707	automatically be updated.
1220		1708
1221	C<$text> is in a special encoding: tabs and wide characters that use more	1709	C<$text> is in a special encoding: tabs and wide characters that use more
1222	than one cell when displayed are padded with urxvt::NOCHAR characters	1710	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1223	(C<chr 65535>). Characters with combining characters and other characters	1711	characters. Characters with combining characters and other characters that
1224	that do not fit into the normal tetx encoding will be replaced with	1712	do not fit into the normal text encoding will be replaced with characters
1225	characters in the private use area.	1713	in the private use area.
1226		1714
1227	You have to obey this encoding when changing text. The advantage is	1715	You have to obey this encoding when changing text. The advantage is
1228	that C<substr> and similar functions work on screen cells and not on	1716	that C<substr> and similar functions work on screen cells and not on
1229	characters.	1717	characters.
1230		1718
…		…
1374	where one character corresponds to one screen cell. See	1862	where one character corresponds to one screen cell. See
1375	C<< $term->ROW_t >> for details.	1863	C<< $term->ROW_t >> for details.
1376		1864
1377	=item $string = $term->special_decode $text	1865	=item $string = $term->special_decode $text
1378		1866
1379	Converts rxvt-unicodes text reprsentation into a perl string. See	1867	Converts rxvt-unicodes text representation into a perl string. See
1380	C<< $term->ROW_t >> for details.	1868	C<< $term->ROW_t >> for details.
1381		1869
1382	=item $success = $term->grab_button ($button, $modifiermask)	1870	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1383		1871
		1872	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1873
1384	Registers a synchronous button grab. See the XGrabButton manpage.	1874	Register/unregister a synchronous button grab. See the XGrabButton
		1875	manpage.
1385		1876
1386	=item $success = $term->grab ($eventtime[, $sync])	1877	=item $success = $term->grab ($eventtime[, $sync])
1387		1878
1388	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1879	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1389	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1880	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1390		1881
1391	=item $term->allow_events_async	1882	=item $term->allow_events_async
1392		1883
1393	Calls XAllowEvents with AsyncBoth for the most recent grab.	1884	Calls XAllowEvents with AsyncBoth for the most recent grab.
1394		1885
…		…
1401	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1892	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1402	recent grab.	1893	recent grab.
1403		1894
1404	=item $term->ungrab	1895	=item $term->ungrab
1405		1896
1406	Calls XUngrab for the most recent grab. Is called automatically on	1897	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1407	evaluation errors, as it is better to lose the grab in the error case as	1898	evaluation errors, as it is better to lose the grab in the error case as
1408	the session.	1899	the session.
		1900
		1901	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1902
		1903	=item $atom_name = $term->XGetAtomName ($atom)
		1904
		1905	=item @atoms = $term->XListProperties ($window)
		1906
		1907	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1908
		1909	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1910
		1911	=item $term->XDeleteProperty ($window, $property)
		1912
		1913	=item $window = $term->DefaultRootWindow
		1914
		1915	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1916
		1917	=item $term->XMapWindow ($window)
		1918
		1919	=item $term->XUnmapWindow ($window)
		1920
		1921	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1922
		1923	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1924
		1925	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1926
		1927	Various X or X-related functions. The C<$term> object only serves as
		1928	the source of the display, otherwise those functions map more-or-less
		1929	directly onto the X functions of the same name.
1409		1930
1410	=back	1931	=back
1411		1932
1412	=cut	1933	=cut
1413		1934
…		…
1477	my ($self, $text, $cb) = @_;	1998	my ($self, $text, $cb) = @_;
1478		1999
1479	$self->add_item ({ type => "button", text => $text, activate => $cb});	2000	$self->add_item ({ type => "button", text => $text, activate => $cb});
1480	}	2001	}
1481		2002
1482	=item $popup->add_toggle ($text, $cb, $initial_value)	2003	=item $popup->add_toggle ($text, $initial_value, $cb)
1483		2004
1484	Adds a toggle/checkbox item to the popup. Teh callback gets called	2005	Adds a toggle/checkbox item to the popup. The callback gets called
1485	whenever it gets toggled, with a boolean indicating its value as its first	2006	whenever it gets toggled, with a boolean indicating its new value as its
1486	argument.	2007	first argument.
1487		2008
1488	=cut	2009	=cut
1489		2010
1490	sub add_toggle {	2011	sub add_toggle {
1491	my ($self, $text, $cb, $value) = @_;	2012	my ($self, $text, $value, $cb) = @_;
1492		2013
1493	my $item; $item = {	2014	my $item; $item = {
1494	type => "button",	2015	type => "button",
1495	text => " $text",	2016	text => " $text",
1496	value => $value,	2017	value => $value,
…		…
1515	my $env = $self->{term}->env;	2036	my $env = $self->{term}->env;
1516	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2037	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1517	delete $env->{LC_ALL};	2038	delete $env->{LC_ALL};
1518	$env->{LC_CTYPE} = $self->{term}->locale;	2039	$env->{LC_CTYPE} = $self->{term}->locale;
1519		2040
1520	urxvt::term->new ($env, $self->{term}->resource ("name"),	2041	my $term = urxvt::term->new (
1521	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2042	$env, "popup",
		2043	"--perl-lib" => "", "--perl-ext-common" => "",
		2044	"-pty-fd" => -1, "-sl" => 0,
		2045	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1522	"--transient-for" => $self->{term}->parent,	2046	"--transient-for" => $self->{term}->parent,
1523	"-display" => $self->{term}->display_id,	2047	"-display" => $self->{term}->display_id,
1524	"-pe" => "urxvt-popup")	2048	"-pe" => "urxvt-popup",
1525	or die "unable to create popup window\n";	2049	) or die "unable to create popup window\n";
		2050
		2051	unless (delete $term->{urxvt_popup_init_done}) {
		2052	$term->ungrab;
		2053	$term->destroy;
		2054	die "unable to initialise popup window\n";
		2055	}
1526	}	2056	}
1527		2057
1528	sub DESTROY {	2058	sub DESTROY {
1529	my ($self) = @_;	2059	my ($self) = @_;
1530		2060
1531	delete $self->{term}{_destroy}{$self};	2061	delete $self->{term}{_destroy}{$self};
1532	$self->{term}->ungrab;	2062	$self->{term}->ungrab;
1533	}	2063	}
1534		2064
1535	=back	2065	=back
		2066
		2067	=cut
		2068
		2069	package urxvt::watcher;
1536		2070
1537	=head2 The C<urxvt::timer> Class	2071	=head2 The C<urxvt::timer> Class
1538		2072
1539	This class implements timer watchers/events. Time is represented as a	2073	This class implements timer watchers/events. Time is represented as a
1540	fractional number of seconds since the epoch. Example:	2074	fractional number of seconds since the epoch. Example:
…		…
1544	->new	2078	->new
1545	->interval (1)	2079	->interval (1)
1546	->cb (sub {	2080	->cb (sub {
1547	$term->{overlay}->set (0, 0,	2081	$term->{overlay}->set (0, 0,
1548	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2082	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1549	});	2083	});
1550		2084
1551	=over 4	2085	=over 4
1552		2086
1553	=item $timer = new urxvt::timer	2087	=item $timer = new urxvt::timer
1554		2088
…		…
1557		2091
1558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2092	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1559		2093
1560	Set the callback to be called when the timer triggers.	2094	Set the callback to be called when the timer triggers.
1561		2095
1562	=item $tstamp = $timer->at
1563
1564	Return the time this watcher will fire next.
1565
1566	=item $timer = $timer->set ($tstamp)	2096	=item $timer = $timer->set ($tstamp[, $interval])
1567		2097
1568	Set the time the event is generated to $tstamp.	2098	Set the time the event is generated to $tstamp (and optionally specifies a
		2099	new $interval).
1569		2100
1570	=item $timer = $timer->interval ($interval)	2101	=item $timer = $timer->interval ($interval)
1571		2102
1572	Normally (and when C<$interval> is C<0>), the timer will automatically	2103	By default (and when C<$interval> is C<0>), the timer will automatically
1573	stop after it has fired once. If C<$interval> is non-zero, then the timer	2104	stop after it has fired once. If C<$interval> is non-zero, then the timer
1574	is automatically rescheduled at the given intervals.	2105	is automatically rescheduled at the given intervals.
1575		2106
1576	=item $timer = $timer->start	2107	=item $timer = $timer->start
1577		2108
1578	Start the timer.	2109	Start the timer.
1579		2110
1580	=item $timer = $timer->start ($tstamp)	2111	=item $timer = $timer->start ($tstamp[, $interval])
1581		2112
1582	Set the event trigger time to C<$tstamp> and start the timer.	2113	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2114	also replaces the interval.
		2115
		2116	=item $timer = $timer->after ($delay[, $interval])
		2117
		2118	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1583		2119
1584	=item $timer = $timer->stop	2120	=item $timer = $timer->stop
1585		2121
1586	Stop the timer.	2122	Stop the timer.
1587		2123
…		…
1593		2129
1594	$term->{socket} = ...	2130	$term->{socket} = ...
1595	$term->{iow} = urxvt::iow	2131	$term->{iow} = urxvt::iow
1596	->new	2132	->new
1597	->fd (fileno $term->{socket})	2133	->fd (fileno $term->{socket})
1598	->events (urxvt::EVENT_READ)	2134	->events (urxvt::EV_READ)
1599	->start	2135	->start
1600	->cb (sub {	2136	->cb (sub {
1601	my ($iow, $revents) = @_;	2137	my ($iow, $revents) = @_;
1602	# $revents must be 1 here, no need to check	2138	# $revents must be 1 here, no need to check
1603	sysread $term->{socket}, my $buf, 8192	2139	sysread $term->{socket}, my $buf, 8192
…		…
1616	Set the callback to be called when io events are triggered. C<$reventmask>	2152	Set the callback to be called when io events are triggered. C<$reventmask>
1617	is a bitset as described in the C<events> method.	2153	is a bitset as described in the C<events> method.
1618		2154
1619	=item $iow = $iow->fd ($fd)	2155	=item $iow = $iow->fd ($fd)
1620		2156
1621	Set the filedescriptor (not handle) to watch.	2157	Set the file descriptor (not handle) to watch.
1622		2158
1623	=item $iow = $iow->events ($eventmask)	2159	=item $iow = $iow->events ($eventmask)
1624		2160
1625	Set the event mask to watch. The only allowed values are	2161	Set the event mask to watch. The only allowed values are
1626	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2162	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1627	together, or C<urxvt::EVENT_NONE>.	2163	together, or C<urxvt::EV_NONE>.
1628		2164
1629	=item $iow = $iow->start	2165	=item $iow = $iow->start
1630		2166
1631	Start watching for requested events on the given handle.	2167	Start watching for requested events on the given handle.
1632		2168
1633	=item $iow = $iow->stop	2169	=item $iow = $iow->stop
1634		2170
1635	Stop watching for events on the given filehandle.	2171	Stop watching for events on the given file handle.
		2172
		2173	=back
		2174
		2175	=head2 The C<urxvt::iw> Class
		2176
		2177	This class implements idle watchers, that get called automatically when
		2178	the process is idle. They should return as fast as possible, after doing
		2179	some useful work.
		2180
		2181	=over 4
		2182
		2183	=item $iw = new urxvt::iw
		2184
		2185	Create a new idle watcher object in stopped state.
		2186
		2187	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2188
		2189	Set the callback to be called when the watcher triggers.
		2190
		2191	=item $timer = $timer->start
		2192
		2193	Start the watcher.
		2194
		2195	=item $timer = $timer->stop
		2196
		2197	Stop the watcher.
		2198
		2199	=back
		2200
		2201	=head2 The C<urxvt::pw> Class
		2202
		2203	This class implements process watchers. They create an event whenever a
		2204	process exits, after which they stop automatically.
		2205
		2206	my $pid = fork;
		2207	...
		2208	$term->{pw} = urxvt::pw
		2209	->new
		2210	->start ($pid)
		2211	->cb (sub {
		2212	my ($pw, $exit_status) = @_;
		2213	...
		2214	});
		2215
		2216	=over 4
		2217
		2218	=item $pw = new urxvt::pw
		2219
		2220	Create a new process watcher in stopped state.
		2221
		2222	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2223
		2224	Set the callback to be called when the timer triggers.
		2225
		2226	=item $pw = $timer->start ($pid)
		2227
		2228	Tells the watcher to start watching for process C<$pid>.
		2229
		2230	=item $pw = $pw->stop
		2231
		2232	Stop the watcher.
1636		2233
1637	=back	2234	=back
1638		2235
1639	=head1 ENVIRONMENT	2236	=head1 ENVIRONMENT
1640		2237
…		…
1649		2246
1650	=item >= 3 - script loading and management	2247	=item >= 3 - script loading and management
1651		2248
1652	=item >=10 - all called hooks	2249	=item >=10 - all called hooks
1653		2250
1654	=item >=11 - hook reutrn values	2251	=item >=11 - hook return values
1655		2252
1656	=back	2253	=back
1657		2254
1658	=head1 AUTHOR	2255	=head1 AUTHOR
1659		2256
1660	Marc Lehmann <pcg@goof.com>	2257	Marc Lehmann <schmorp@schmorp.de>
1661	http://software.schmorp.de/pkg/rxvt-unicode	2258	http://software.schmorp.de/pkg/rxvt-unicode
1662		2259
1663	=cut	2260	=cut
1664		2261
1665	1	2262	1
		2263
		2264	# vim: sw=3:

Diff Legend

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