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.97 by elmex, Tue Jan 17 16:53:47 2006 UTC vs.
Revision 1.188 by sf-exg, Sat Jul 24 13:04:27 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
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 following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
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.
…		…
125	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\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/^([^:[:space:]]+(\\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	Of course, this can be modified to suit your needs and your editor :)	213	Of course, this can be modified to suit your needs and your editor :)
133		214
134	To expand the example above to typical perl error messages ("XXX at	215	To expand the example above to typical perl error messages ("XXX at
135	FILENAME line YYY."), you need a slightly more elaborate solution:	216	FILENAME line YYY."), you need a slightly more elaborate solution:
136		217
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139		220
140	The first line tells the selection code to treat the unchanging part of	221	The first line tells the selection code to treat the unchanging part of
141	every error message as a selection pattern, and the second line transforms	222	every error message as a selection pattern, and the second line transforms
142	the message into vi commands to load the file.	223	the message into vi commands to load the file.
143		224
144	=item mark-urls	225	=item tabbed
145		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
146	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
147	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
148	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
149	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.
150		313
151	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
152		315
153	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
154	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
155	similar-looking ascii character.	318	similar-looking ascii character.
156		319
157	=item digital-clock	320	=item digital-clock
158		321
159	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.
160		391
161	=item example-refresh-hooks	392	=item example-refresh-hooks
162		393
163	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
164	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
165	overlays or changes.	396	overlays or changes.
166		397
167	=item selection-pastebin	398	=item confirm-paste
168		399
169	Uploads the selection as textfile to a remote site.	400	Displays a confirmation dialog when a paste containing at least a full
170		401	line is detected.
171	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
172
173	To set the command to upload the file set this resource:
174
175	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
176
177	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
178	md5 sum of the selection.
179	After an successful upload the selection will be replaced by the following url
180	(the % is the placeholder for the filename):
181
182	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
183		402
184	=back	403	=back
185		404
186	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
187		406
…		…
203		422
204	=over 4	423	=over 4
205		424
206	=item $text	425	=item $text
207		426
208	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
209	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.
210		429
211	=item $string	430	=item $string
212		431
213	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
…		…
221		440
222	=back	441	=back
223		442
224	=head2 Extension Objects	443	=head2 Extension Objects
225		444
226	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
227	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 extenion objects,
228	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
229	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
230	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
231	use.	451	internal use.
232		452
233	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
234	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
235		455
236	It has the following methods and data members:	456	It has the following methods and data members:
…		…
257	=head2 Hooks	477	=head2 Hooks
258		478
259	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
260	called whenever the relevant event happens.	480	called whenever the relevant event happens.
261		481
262	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
263	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
264		484
265	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
266	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
267	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.
268		488
269	I<< When in doubt, return a false value (preferably C<()>). >>	489	I<< When in doubt, return a false value (preferably C<()>). >>
270		490
271	=over 4	491	=over 4
272		492
273	=item on_init $term	493	=item on_init $term
274		494
275	Called after a new terminal object has been initialized, but before	495	Called after a new terminal object has been initialized, but before
276	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
277	call or deliver senseless data, as terminal size and other characteristics	497	call or deliver senseless data, as terminal size and other characteristics
278	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
279	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).
280		511
281	=item on_reset $term	512	=item on_reset $term
282		513
283	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
284	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
285	variables.	516	variables.
286		517
287	=item on_start $term	518	=item on_child_start $term, $pid
288		519
289	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.
290	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>.
291		526
292	=item on_sel_make $term, $eventtime	527	=item on_sel_make $term, $eventtime
293		528
294	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
295	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
…		…
302		537
303	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
304	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
305	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
306		541
307	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.
308		543
309	=item on_sel_extend $term	544	=item on_sel_extend $term
310		545
311	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
312	click) and is either supposed to return false (normal operation), or	547	click) and is either supposed to return false (normal operation), or
313	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
314	processing. This can happen multiple times, as long as the callback	549	processing. This can happen multiple times, as long as the callback
315	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
316	supposed to enlarge the selection more and more, if possible.	551	supposed to enlarge the selection more and more, if possible.
317		552
318	See the F<selection> example extension.	553	See the F<selection> example extension.
319		554
320	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
321		556
322	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
323	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
324	show this many lines of scrollback.	559	show this many lines of scrollback.
325		560
326	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
327		562
…		…
331		566
332	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,
333	$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
334	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
335		570
336	=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
337		582
338	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
339	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
340	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
341	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,
342	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
343	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	}
344		599
345	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,
346	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
347	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.
348		606
349	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
350		608
351	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
352	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
…		…
357	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
358		616
359	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
360	suppress or filter tty input.	618	suppress or filter tty input.
361		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
362	=item on_line_update $term, $row	627	=item on_line_update $term, $row
363		628
364	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
365	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
366	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,
…		…
373	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
374	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
375		640
376	=item on_refresh_begin $term	641	=item on_refresh_begin $term
377		642
378	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
379	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
380	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
381	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
382		647
383	=item on_refresh_end $term	648	=item on_refresh_end $term
384		649
385	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>.
386		651
387	=item on_keyboard_command $term, $string	652	=item on_user_command $term, $string
388		653
389	Called whenever the user presses a key combination that has a	654	Called whenever a user-configured event is being activated (e.g. via
390	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>
391	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.
392		666
393	=item on_x_event $term, $event	667	=item on_x_event $term, $event
394		668
395	Called on every X event received on the vt window (and possibly other	669	Called on every X event received on the vt window (and possibly other
396	windows). Should only be used as a last resort. Most event structure	670	windows). Should only be used as a last resort. Most event structure
397	members are not passed.	671	members are not passed.
398		672
		673	=item on_root_event $term, $event
		674
		675	Like C<on_x_event>, but is called for events on the root window.
		676
399	=item on_focus_in $term	677	=item on_focus_in $term
400		678
401	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
402	does focus in processing.	680	does focus in processing.
403		681
404	=item on_focus_out $term	682	=item on_focus_out $term
405		683
406	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
407	focus out processing.	685	focus out processing.
408		686
		687	=item on_configure_notify $term, $event
		688
		689	=item on_property_notify $term, $event
		690
409	=item on_key_press $term, $event, $keysym, $octets	691	=item on_key_press $term, $event, $keysym, $octets
410		692
411	=item on_key_release $term, $event, $keysym	693	=item on_key_release $term, $event, $keysym
412		694
413	=item on_button_press $term, $event	695	=item on_button_press $term, $event
…		…
418		700
419	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
420		702
421	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
422		704
423	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
424	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.
425		707
426	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
427	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
428	and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
429		711
430	C<on_key_press> additionally receives the string rxvt-unicode would	712	C<on_key_press> additionally receives the string rxvt-unicode would
431	output, if any, in locale-specific encoding.	713	output, if any, in locale-specific encoding.
432		714
433	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.
434		729
435	=back	730	=back
436		731
437	=cut	732	=cut
438		733
…		…
444	use Scalar::Util ();	739	use Scalar::Util ();
445	use List::Util ();	740	use List::Util ();
446		741
447	our $VERSION = 1;	742	our $VERSION = 1;
448	our $TERM;	743	our $TERM;
		744	our @TERM_INIT;
		745	our @TERM_EXT;
449	our @HOOKNAME;	746	our @HOOKNAME;
450	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	747	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451	our %OPTION;	748	our %OPTION;
452		749
453	our $LIBDIR;	750	our $LIBDIR;
454	our $RESNAME;	751	our $RESNAME;
455	our $RESCLASS;	752	our $RESCLASS;
456	our $RXVTNAME;	753	our $RXVTNAME;
457		754
		755	our $NOCHAR = chr 0xffff;
		756
458	=head2 Variables in the C<urxvt> Package	757	=head2 Variables in the C<urxvt> Package
459		758
460	=over 4	759	=over 4
461		760
462	=item $urxvt::LIBDIR	761	=item $urxvt::LIBDIR
…		…
474		773
475	=item $urxvt::TERM	774	=item $urxvt::TERM
476		775
477	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
478	object, whenever a callback/hook is executing.	777	object, whenever a callback/hook is executing.
		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>.
479		794
480	=back	795	=back
481		796
482	=head2 Functions in the C<urxvt> Package	797	=head2 Functions in the C<urxvt> Package
483		798
…		…
497		812
498	Using this function has the advantage that its output ends up in the	813	Using this function has the advantage that its output ends up in the
499	correct place, e.g. on stderr of the connecting urxvtc client.	814	correct place, e.g. on stderr of the connecting urxvtc client.
500		815
501	Messages have a size limit of 1023 bytes currently.	816	Messages have a size limit of 1023 bytes currently.
		817
		818	=item @terms = urxvt::termlist
		819
		820	Returns all urxvt::term objects that exist in this process, regardless of
		821	whether they are started, being destroyed etc., so be careful. Only term
		822	objects that have perl extensions attached will be returned (because there
		823	is no urxvt::term objet associated with others).
502		824
503	=item $time = urxvt::NOW	825	=item $time = urxvt::NOW
504		826
505	Returns the "current time" (as per the event loop).	827	Returns the "current time" (as per the event loop).
506		828
…		…
565		887
566	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	888	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
567		889
568	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	890	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
569		891
		892	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		893
570	Replace the foreground/background colour in the rendition mask with the	894	Replace the foreground/background colour in the rendition mask with the
571	specified one.	895	specified one.
572		896
573	=item $value = urxvt::GET_CUSTOM $rend	897	=item $value = urxvt::GET_CUSTOM $rend
574		898
…		…
583	=back	907	=back
584		908
585	=cut	909	=cut
586		910
587	BEGIN {	911	BEGIN {
588	urxvt->bootstrap;
589
590	# overwrite perl's warn	912	# overwrite perl's warn
591	*CORE::GLOBAL::warn = sub {	913	*CORE::GLOBAL::warn = sub {
592	my $msg = join "", @_;	914	my $msg = join "", @_;
593	$msg .= "\n"	915	$msg .= "\n"
594	unless $msg =~ /\n$/;	916	unless $msg =~ /\n$/;
595	urxvt::warn ($msg);	917	urxvt::warn ($msg);
596	};	918	};
597
598	# %ENV is the original startup environment
599	delete $ENV{IFS};
600	delete $ENV{CDPATH};
601	delete $ENV{BASH_ENV};
602	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
603	}	919	}
		920
		921	no warnings 'utf8';
604		922
605	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	923	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
606		924
607	sub verbose {	925	sub verbose {
608	my ($level, $msg) = @_;	926	my ($level, $msg) = @_;
609	warn "$msg\n" if $level <= $verbosity;	927	warn "$msg\n" if $level <= $verbosity;
610	}	928	}
611		929
612	my $extension_pkg = "extension0000";
613	my %extension_pkg;	930	my %extension_pkg;
614		931
615	# load a single script into its own package, once only	932	# load a single script into its own package, once only
616	sub extension_package($) {	933	sub extension_package($) {
617	my ($path) = @_;	934	my ($path) = @_;
618		935
619	$extension_pkg{$path} ||= do {	936	$extension_pkg{$path} ||= do {
620	my $pkg = "urxvt::" . ($extension_pkg++);	937	$path =~ /([^\/\\]+)$/;
		938	my $pkg = $1;
		939	$pkg =~ s/[^[:word:]]/_/g;
		940	$pkg = "urxvt::ext::$pkg";
621		941
622	verbose 3, "loading extension '$path' into package '$pkg'";	942	verbose 3, "loading extension '$path' into package '$pkg'";
623		943
624	open my $fh, "<:raw", $path	944	open my $fh, "<:raw", $path
625	or die "$path: $!";	945	or die "$path: $!";
626		946
627	my $source =	947	my $source =
628	"package $pkg; use strict; use utf8;\n"	948	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
629	. "use base urxvt::term::extension::;\n"
630	. "#line 1 \"$path\"\n{\n"	949	. "#line 1 \"$path\"\n{\n"
631	. (do { local $/; <$fh> })	950	. (do { local $/; <$fh> })
632	. "\n};\n1";	951	. "\n};\n1";
633		952
634	eval $source	953	eval $source
…		…
645	local $TERM = shift;	964	local $TERM = shift;
646	my $htype = shift;	965	my $htype = shift;
647		966
648	if ($htype == 0) { # INIT	967	if ($htype == 0) { # INIT
649	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	968	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
650		969
651	my %ext_arg;	970	my %ext_arg;
652		971
		972	{
		973	my @init = @TERM_INIT;
		974	@TERM_INIT = ();
		975	$_->($TERM) for @init;
		976	my @pkg = @TERM_EXT;
		977	@TERM_EXT = ();
		978	$TERM->register_package ($_) for @pkg;
		979	}
		980
653	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	981	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
654	if ($_ eq "default") {	982	if ($_ eq "default") {
655	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	983	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
656	} elsif (/^-(.*)$/) {	984	} elsif (/^-(.*)$/) {
657	delete $ext_arg{$1};	985	delete $ext_arg{$1};
658	} elsif (/^([^<]+)<(.*)>$/) {	986	} elsif (/^([^<]+)<(.*)>$/) {
659	push @{ $ext_arg{$1} }, $2;	987	push @{ $ext_arg{$1} }, $2;
660	} else {	988	} else {
661	$ext_arg{$_} ||= [];	989	$ext_arg{$_} ||= [];
662	}	990	}
663	}	991	}
664		992
665	while (my ($ext, $argv) = each %ext_arg) {	993	for my $ext (sort keys %ext_arg) {
666	my @files = grep -f $_, map "$_/$ext", @dirs;	994	my @files = grep -f $_, map "$_/$ext", @dirs;
667		995
668	if (@files) {	996	if (@files) {
669	$TERM->register_package (extension_package $files[0], $argv);	997	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
670	} else {	998	} else {
671	warn "perl extension '$ext' not found in perl library search path\n";	999	warn "perl extension '$ext' not found in perl library search path\n";
672	}	1000	}
673	}	1001	}
674		1002
…		…
680		1008
681	if (my $cb = $TERM->{_hook}[$htype]) {	1009	if (my $cb = $TERM->{_hook}[$htype]) {
682	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1010	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
683	if $verbosity >= 10;	1011	if $verbosity >= 10;
684		1012
685	keys %$cb;	1013	for my $pkg (keys %$cb) {
686
687	while (my ($pkg, $cb) = each %$cb) {
688	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1014	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
689	and last;	1015	$retval ||= $retval_;
690		1016
691	if ($@) {	1017	if ($@) {
692	$TERM->ungrab; # better to lose the grab than the session	1018	$TERM->ungrab; # better to lose the grab than the session
693	warn $@;	1019	warn $@;
694	}	1020	}
…		…
707	}	1033	}
708		1034
709	$retval	1035	$retval
710	}	1036	}
711		1037
712	sub exec_async(@) {	1038	sub SET_COLOR($$$) {
713	my $pid = fork;	1039	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1040	}
714		1041
715	return	1042	sub rend2mask {
716	if !defined $pid or $pid;	1043	no strict 'refs';
717		1044	my ($str, $mask) = (@_, 0);
718	%ENV = %{ $TERM->env };	1045	my %color = ( fg => undef, bg => undef );
719		1046	my @failed;
720	exec @_;	1047	for my $spec ( split /\s+/, $str ) {
721	_exit 255;	1048	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1049	$color{lc($1)} = $2;
		1050	} else {
		1051	my $neg = $spec =~ s/^[-^]//;
		1052	unless ( exists &{"RS_$spec"} ) {
		1053	push @failed, $spec;
		1054	next;
		1055	}
		1056	my $cur = &{"RS_$spec"};
		1057	if ( $neg ) {
		1058	$mask &= ~$cur;
		1059	} else {
		1060	$mask |= $cur;
		1061	}
		1062	}
		1063	}
		1064	($mask, @color{qw(fg bg)}, \@failed)
722	}	1065	}
723		1066
724	# urxvt::term::extension	1067	# urxvt::term::extension
725		1068
726	package urxvt::term::extension;	1069	package urxvt::term::extension;
…		…
797	is that you cannot use blocking APIs, but the non-blocking variant should	1140	is that you cannot use blocking APIs, but the non-blocking variant should
798	work.	1141	work.
799		1142
800	=cut	1143	=cut
801		1144
802	our $VERSION = 1;	1145	our $VERSION = '5.23';
803		1146
804	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1147	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
805	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1148	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
806		1149
807	sub timer {	1150	sub timer {
…		…
809		1152
810	my $cb = $arg{cb};	1153	my $cb = $arg{cb};
811		1154
812	urxvt::timer	1155	urxvt::timer
813	->new	1156	->new
814	->start (urxvt::NOW + $arg{after})	1157	->after ($arg{after}, $arg{interval})
815	->cb (sub {	1158	->cb ($arg{interval} ? $cb : sub {
816	$_[0]->stop; # need to cancel manually	1159	$_[0]->stop; # need to cancel manually
817	$cb->();	1160	$cb->();
818	})	1161	})
819	}	1162	}
820		1163
821	sub io {	1164	sub io {
822	my ($class, %arg) = @_;	1165	my ($class, %arg) = @_;
823		1166
824	my $cb = $arg{cb};	1167	my $cb = $arg{cb};
		1168	my $fd = fileno $arg{fh};
		1169	defined $fd or $fd = $arg{fh};
825		1170
826	bless [$arg{fh}, urxvt::iow	1171	bless [$arg{fh}, urxvt::iow
827	->new	1172	->new
828	->fd (fileno $arg{fh})	1173	->fd ($fd)
829	->events (($arg{poll} =~ /r/ ? 1 : 0)	1174	->events (($arg{poll} =~ /r/ ? 1 : 0)
830	| ($arg{poll} =~ /w/ ? 2 : 0))	1175	| ($arg{poll} =~ /w/ ? 2 : 0))
831	->start	1176	->start
832	->cb (sub {	1177	->cb ($cb)
833	$cb->(($_[1] & 1 ? 'r' : '')
834	. ($_[1] & 2 ? 'w' : ''));
835	})],
836	urxvt::anyevent::	1178	], urxvt::anyevent::
		1179	}
		1180
		1181	sub idle {
		1182	my ($class, %arg) = @_;
		1183
		1184	my $cb = $arg{cb};
		1185
		1186	urxvt::iw
		1187	->new
		1188	->start
		1189	->cb ($cb)
		1190	}
		1191
		1192	sub child {
		1193	my ($class, %arg) = @_;
		1194
		1195	my $cb = $arg{cb};
		1196
		1197	urxvt::pw
		1198	->new
		1199	->start ($arg{pid})
		1200	->cb (sub {
		1201	$_[0]->stop; # need to cancel manually
		1202	$cb->($_[0]->rpid, $_[0]->rstatus);
		1203	})
837	}	1204	}
838		1205
839	sub DESTROY {	1206	sub DESTROY {
840	$_[0][1]->stop;	1207	$_[0][1]->stop;
841	}	1208	}
842		1209
843	sub condvar {	1210	sub one_event {
844	bless \my $flag, urxvt::anyevent::condvar::
845	}
846
847	sub urxvt::anyevent::condvar::broadcast {
848	${$_[0]}++;
849	}
850
851	sub urxvt::anyevent::condvar::wait {
852	unless (${$_[0]}) {
853	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1211	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
854	}
855	}	1212	}
856		1213
857	package urxvt::term;	1214	package urxvt::term;
858		1215
859	=head2 The C<urxvt::term> Class	1216	=head2 The C<urxvt::term> Class
…		…
864		1221
865	# find on_xxx subs in the package and register them	1222	# find on_xxx subs in the package and register them
866	# as hooks	1223	# as hooks
867	sub register_package {	1224	sub register_package {
868	my ($self, $pkg, $argv) = @_;	1225	my ($self, $pkg, $argv) = @_;
		1226
		1227	no strict 'refs';
		1228
		1229	urxvt::verbose 6, "register package $pkg to $self";
		1230
		1231	@{"$pkg\::ISA"} = urxvt::term::extension::;
869		1232
870	my $proxy = bless {	1233	my $proxy = bless {
871	_pkg => $pkg,	1234	_pkg => $pkg,
872	argv => $argv,	1235	argv => $argv,
873	}, $pkg;	1236	}, $pkg;
…		…
889	hash which defines the environment of the new terminal.	1252	hash which defines the environment of the new terminal.
890		1253
891	Croaks (and probably outputs an error message) if the new instance	1254	Croaks (and probably outputs an error message) if the new instance
892	couldn't be created. Returns C<undef> if the new instance didn't	1255	couldn't be created. Returns C<undef> if the new instance didn't
893	initialise perl, and the terminal object otherwise. The C<init> and	1256	initialise perl, and the terminal object otherwise. The C<init> and
894	C<start> hooks will be called during this call.	1257	C<start> hooks will be called before this call returns, and are free to
		1258	refer to global data (which is race free).
895		1259
896	=cut	1260	=cut
897		1261
898	sub new {	1262	sub new {
899	my ($class, $env, @args) = @_;	1263	my ($class, $env, @args) = @_;
900		1264
		1265	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1266	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1267
901	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1268	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
902	}	1269	}
903		1270
904	=item $term->destroy	1271	=item $term->destroy
905		1272
906	Destroy the terminal object (close the window, free resources	1273	Destroy the terminal object (close the window, free resources
907	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1274	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
908	watchers (timers, io watchers) are still active.	1275	watchers (timers, io watchers) are still active.
909		1276
		1277	=item $term->exec_async ($cmd[, @args])
		1278
		1279	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1280	("starts") programs in the background. This function takes care of setting
		1281	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1282	be preferred over explicit calls to C<exec> or C<system>.
		1283
		1284	Returns the pid of the subprocess or C<undef> on error.
		1285
		1286	=cut
		1287
		1288	sub exec_async {
		1289	my $self = shift;
		1290
		1291	my $pid = fork;
		1292
		1293	return $pid
		1294	if !defined $pid or $pid;
		1295
		1296	%ENV = %{ $self->env };
		1297
		1298	exec @_;
		1299	urxvt::_exit 255;
		1300	}
		1301
910	=item $isset = $term->option ($optval[, $set])	1302	=item $isset = $term->option ($optval[, $set])
911		1303
912	Returns true if the option specified by C<$optval> is enabled, and	1304	Returns true if the option specified by C<$optval> is enabled, and
913	optionally change it. All option values are stored by name in the hash	1305	optionally change it. All option values are stored by name in the hash
914	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1306	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
915		1307
916	Here is a a likely non-exhaustive list of option names, please see the	1308	Here is a likely non-exhaustive list of option names, please see the
917	source file F</src/optinc.h> to see the actual list:	1309	source file F</src/optinc.h> to see the actual list:
918		1310
919	borderLess console cursorBlink cursorUnderline hold iconic insecure	1311	borderLess console cursorBlink cursorUnderline hold iconic insecure
920	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1312	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
921	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1313	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
922	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1314	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
923	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1315	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
924	tripleclickwords utmpInhibit visualBell	1316	transparent tripleclickwords utmpInhibit visualBell
925		1317
926	=item $value = $term->resource ($name[, $newval])	1318	=item $value = $term->resource ($name[, $newval])
927		1319
928	Returns the current resource value associated with a given name and	1320	Returns the current resource value associated with a given name and
929	optionally sets a new value. Setting values is most useful in the C<init>	1321	optionally sets a new value. Setting values is most useful in the C<init>
…		…
938	likely change).	1330	likely change).
939		1331
940	Please note that resource strings will currently only be freed when the	1332	Please note that resource strings will currently only be freed when the
941	terminal is destroyed, so changing options frequently will eat memory.	1333	terminal is destroyed, so changing options frequently will eat memory.
942		1334
943	Here is a a likely non-exhaustive list of resource names, not all of which	1335	Here is a likely non-exhaustive list of resource names, not all of which
944	are supported in every build, please see the source file F</src/rsinc.h>	1336	are supported in every build, please see the source file F</src/rsinc.h>
945	to see the actual list:	1337	to see the actual list:
946		1338
947	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1339	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
948	borderLess color cursorBlink cursorUnderline cutchars delete_key	1340	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
949	display_name embed ext_bwidth fade font geometry hold iconName	1341	display_name embed ext_bwidth fade font geometry hold iconName
950	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1342	imFont imLocale inputMethod insecure int_bwidth intensityStyles
951	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1343	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
952	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1344	modifier mouseWheelScrollPage name override_redirect pastableTabs path
953	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1345	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
954	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1346	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
955	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1347	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
956	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1348	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
957	shade term_name title transparent transparent_all tripleclickwords	1349	secondaryScreen secondaryScroll shade term_name title
958	utmpInhibit visualBell	1350	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1351	visualBell
959		1352
960	=cut	1353	=cut
961		1354
962	sub resource($$;$) {	1355	sub resource($$;$) {
963	my ($self, $name) = (shift, shift);	1356	my ($self, $name) = (shift, shift);
964	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1357	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
965	&urxvt::term::_resource	1358	goto &urxvt::term::_resource
966	}	1359	}
967		1360
968	=item $value = $term->x_resource ($pattern)	1361	=item $value = $term->x_resource ($pattern)
969		1362
970	Returns the X-Resource for the given pattern, excluding the program or	1363	Returns the X-Resource for the given pattern, excluding the program or
…		…
995		1388
996	=item ($row, $col) = $term->selection_beg ([$row, $col])	1389	=item ($row, $col) = $term->selection_beg ([$row, $col])
997		1390
998	=item ($row, $col) = $term->selection_end ([$row, $col])	1391	=item ($row, $col) = $term->selection_end ([$row, $col])
999		1392
1000	Return the current values of the selection mark, begin or end positions,	1393	Return the current values of the selection mark, begin or end positions.
1001	and optionally set them to new values.	1394
		1395	When arguments are given, then the selection coordinates are set to
		1396	C<$row> and C<$col>, and the selection screen is set to the current
		1397	screen.
		1398
		1399	=item $screen = $term->selection_screen ([$screen])
		1400
		1401	Returns the current selection screen, and then optionally sets it.
1002		1402
1003	=item $term->selection_make ($eventtime[, $rectangular])	1403	=item $term->selection_make ($eventtime[, $rectangular])
1004		1404
1005	Tries to make a selection as set by C<selection_beg> and	1405	Tries to make a selection as set by C<selection_beg> and
1006	C<selection_end>. If C<$rectangular> is true (default: false), a	1406	C<selection_end>. If C<$rectangular> is true (default: false), a
1007	rectangular selection will be made. This is the prefered function to make	1407	rectangular selection will be made. This is the preferred function to make
1008	a selection.	1408	a selection.
1009		1409
1010	=item $success = $term->selection_grab ($eventtime)	1410	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1011		1411
1012	Try to request the primary selection text from the server (for example, as	1412	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1413	true) selection from the server. The corresponding text can be set
1013	set by the next method). No visual feedback will be given. This function	1414	with the next method. No visual feedback will be given. This function
1014	is mostly useful from within C<on_sel_grab> hooks.	1415	is mostly useful from within C<on_sel_grab> hooks.
1015		1416
1016	=item $oldtext = $term->selection ([$newtext])	1417	=item $oldtext = $term->selection ([$newtext, $clipboard])
1017		1418
1018	Return the current selection text and optionally replace it by C<$newtext>.	1419	Return the current selection (clipboard if C<$clipboard> is true) text
		1420	and optionally replace it by C<$newtext>.
		1421
		1422	=item $term->selection_clear ([$clipboard])
		1423
		1424	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1019		1425
1020	=item $term->overlay_simple ($x, $y, $text)	1426	=item $term->overlay_simple ($x, $y, $text)
1021		1427
1022	Create a simple multi-line overlay box. See the next method for details.	1428	Create a simple multi-line overlay box. See the next method for details.
1023		1429
…		…
1053		1459
1054	The methods currently supported on C<urxvt::overlay> objects are:	1460	The methods currently supported on C<urxvt::overlay> objects are:
1055		1461
1056	=over 4	1462	=over 4
1057		1463
1058	=item $overlay->set ($x, $y, $text, $rend)	1464	=item $overlay->set ($x, $y, $text[, $rend])
1059		1465
1060	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1466	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1061	text in rxvt-unicode's special encoding and an array of rendition values	1467	text in rxvt-unicode's special encoding and an array of rendition values
1062	at a specific position inside the overlay.	1468	at a specific position inside the overlay.
		1469
		1470	If C<$rend> is missing, then the rendition will not be changed.
1063		1471
1064	=item $overlay->hide	1472	=item $overlay->hide
1065		1473
1066	If visible, hide the overlay, but do not destroy it.	1474	If visible, hide the overlay, but do not destroy it.
1067		1475
…		…
1137		1545
1138	Normally its not a good idea to use this function, as programs might be	1546	Normally its not a good idea to use this function, as programs might be
1139	confused by changes in cursor position or scrolling. Its useful inside a	1547	confused by changes in cursor position or scrolling. Its useful inside a
1140	C<on_add_lines> hook, though.	1548	C<on_add_lines> hook, though.
1141		1549
		1550	=item $term->scr_change_screen ($screen)
		1551
		1552	Switch to given screen - 0 primary, 1 secondary.
		1553
1142	=item $term->cmd_parse ($octets)	1554	=item $term->cmd_parse ($octets)
1143		1555
1144	Similar to C<scr_add_lines>, but the argument must be in the	1556	Similar to C<scr_add_lines>, but the argument must be in the
1145	locale-specific encoding of the terminal and can contain command sequences	1557	locale-specific encoding of the terminal and can contain command sequences
1146	(escape codes) that will be interpreted.	1558	(escape codes) that will be interpreted.
1147		1559
1148	=item $term->tt_write ($octets)	1560	=item $term->tt_write ($octets)
1149		1561
1150	Write the octets given in C<$data> to the tty (i.e. as program input). To	1562	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1151	pass characters instead of octets, you should convert your strings first	1563	pass characters instead of octets, you should convert your strings first
1152	to the locale-specific encoding using C<< $term->locale_encode >>.	1564	to the locale-specific encoding using C<< $term->locale_encode >>.
		1565
		1566	=item $term->tt_paste ($octets)
		1567
		1568	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1569	CR and bracketing the data with control sequences if bracketed paste mode
		1570	is set.
1153		1571
1154	=item $old_events = $term->pty_ev_events ([$new_events])	1572	=item $old_events = $term->pty_ev_events ([$new_events])
1155		1573
1156	Replaces the event mask of the pty watcher by the given event mask. Can	1574	Replaces the event mask of the pty watcher by the given event mask. Can
1157	be used to suppress input and output handling to the pty/tty. See the	1575	be used to suppress input and output handling to the pty/tty. See the
1158	description of C<< urxvt::timer->events >>. Make sure to always restore	1576	description of C<< urxvt::timer->events >>. Make sure to always restore
1159	the previous value.	1577	the previous value.
1160		1578
		1579	=item $fd = $term->pty_fd
		1580
		1581	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1582	is used.
		1583
1161	=item $windowid = $term->parent	1584	=item $windowid = $term->parent
1162		1585
1163	Return the window id of the toplevel window.	1586	Return the window id of the toplevel window.
1164		1587
1165	=item $windowid = $term->vt	1588	=item $windowid = $term->vt
…		…
1171	Adds the specified events to the vt event mask. Useful e.g. when you want	1594	Adds the specified events to the vt event mask. Useful e.g. when you want
1172	to receive pointer events all the times:	1595	to receive pointer events all the times:
1173		1596
1174	$term->vt_emask_add (urxvt::PointerMotionMask);	1597	$term->vt_emask_add (urxvt::PointerMotionMask);
1175		1598
		1599	=item $term->focus_in
		1600
		1601	=item $term->focus_out
		1602
		1603	=item $term->key_press ($state, $keycode[, $time])
		1604
		1605	=item $term->key_release ($state, $keycode[, $time])
		1606
		1607	Deliver various fake events to to terminal.
		1608
1176	=item $window_width = $term->width	1609	=item $window_width = $term->width
1177		1610
1178	=item $window_height = $term->height	1611	=item $window_height = $term->height
1179		1612
1180	=item $font_width = $term->fwidth	1613	=item $font_width = $term->fwidth
…		…
1210	=item $env = $term->env	1643	=item $env = $term->env
1211		1644
1212	Returns a copy of the environment in effect for the terminal as a hashref	1645	Returns a copy of the environment in effect for the terminal as a hashref
1213	similar to C<\%ENV>.	1646	similar to C<\%ENV>.
1214		1647
		1648	=item @envv = $term->envv
		1649
		1650	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1651
		1652	=item @argv = $term->argv
		1653
		1654	Return the argument vector as this terminal, similar to @ARGV, but
		1655	includes the program name as first element.
		1656
1215	=cut	1657	=cut
1216		1658
1217	sub env {	1659	sub env {
1218	if (my $env = $_[0]->_env) {
1219	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1660	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1220	} else {
1221	+{ %ENV }
1222	}
1223	}	1661	}
1224		1662
1225	=item $modifiermask = $term->ModLevel3Mask	1663	=item $modifiermask = $term->ModLevel3Mask
1226		1664
1227	=item $modifiermask = $term->ModMetaMask	1665	=item $modifiermask = $term->ModMetaMask
1228		1666
1229	=item $modifiermask = $term->ModNumLockMask	1667	=item $modifiermask = $term->ModNumLockMask
1230		1668
1231	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1669	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1232	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1670	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1671
		1672	=item $screen = $term->current_screen
		1673
		1674	Returns the currently displayed screen (0 primary, 1 secondary).
		1675
		1676	=item $cursor_is_hidden = $term->hidden_cursor
		1677
		1678	Returns whether the cursor is currently hidden or not.
1233		1679
1234	=item $view_start = $term->view_start ([$newvalue])	1680	=item $view_start = $term->view_start ([$newvalue])
1235		1681
1236	Returns the row number of the topmost displayed line. Maximum value is	1682	Returns the row number of the topmost displayed line. Maximum value is
1237	C<0>, which displays the normal terminal contents. Lower values scroll	1683	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1245		1691
1246	Used after changing terminal contents to display them.	1692	Used after changing terminal contents to display them.
1247		1693
1248	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1694	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1249		1695
1250	Returns the text of the entire row with number C<$row_number>. Row C<0>	1696	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1251	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1697	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1252	terminal line. The scrollback buffer starts at line C<-1> and extends to
1253	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1698	terminal line. Nothing will be returned if a nonexistent line
1254	is requested.	1699	is requested.
1255		1700
1256	If C<$new_text> is specified, it will replace characters in the current	1701	If C<$new_text> is specified, it will replace characters in the current
1257	line, starting at column C<$start_col> (default C<0>), which is useful	1702	line, starting at column C<$start_col> (default C<0>), which is useful
1258	to replace only parts of a line. The font index in the rendition will	1703	to replace only parts of a line. The font index in the rendition will
1259	automatically be updated.	1704	automatically be updated.
1260		1705
1261	C<$text> is in a special encoding: tabs and wide characters that use more	1706	C<$text> is in a special encoding: tabs and wide characters that use more
1262	than one cell when displayed are padded with urxvt::NOCHAR characters	1707	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1263	(C<chr 65535>). Characters with combining characters and other characters	1708	characters. Characters with combining characters and other characters that
1264	that do not fit into the normal tetx encoding will be replaced with	1709	do not fit into the normal text encoding will be replaced with characters
1265	characters in the private use area.	1710	in the private use area.
1266		1711
1267	You have to obey this encoding when changing text. The advantage is	1712	You have to obey this encoding when changing text. The advantage is
1268	that C<substr> and similar functions work on screen cells and not on	1713	that C<substr> and similar functions work on screen cells and not on
1269	characters.	1714	characters.
1270		1715
…		…
1414	where one character corresponds to one screen cell. See	1859	where one character corresponds to one screen cell. See
1415	C<< $term->ROW_t >> for details.	1860	C<< $term->ROW_t >> for details.
1416		1861
1417	=item $string = $term->special_decode $text	1862	=item $string = $term->special_decode $text
1418		1863
1419	Converts rxvt-unicodes text reprsentation into a perl string. See	1864	Converts rxvt-unicodes text representation into a perl string. See
1420	C<< $term->ROW_t >> for details.	1865	C<< $term->ROW_t >> for details.
1421		1866
1422	=item $success = $term->grab_button ($button, $modifiermask)	1867	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1423		1868
		1869	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1870
1424	Registers a synchronous button grab. See the XGrabButton manpage.	1871	Register/unregister a synchronous button grab. See the XGrabButton
		1872	manpage.
1425		1873
1426	=item $success = $term->grab ($eventtime[, $sync])	1874	=item $success = $term->grab ($eventtime[, $sync])
1427		1875
1428	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1876	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1429	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1877	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1430		1878
1431	=item $term->allow_events_async	1879	=item $term->allow_events_async
1432		1880
1433	Calls XAllowEvents with AsyncBoth for the most recent grab.	1881	Calls XAllowEvents with AsyncBoth for the most recent grab.
1434		1882
…		…
1441	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1889	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1442	recent grab.	1890	recent grab.
1443		1891
1444	=item $term->ungrab	1892	=item $term->ungrab
1445		1893
1446	Calls XUngrab for the most recent grab. Is called automatically on	1894	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1447	evaluation errors, as it is better to lose the grab in the error case as	1895	evaluation errors, as it is better to lose the grab in the error case as
1448	the session.	1896	the session.
		1897
		1898	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1899
		1900	=item $atom_name = $term->XGetAtomName ($atom)
		1901
		1902	=item @atoms = $term->XListProperties ($window)
		1903
		1904	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1905
		1906	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1907
		1908	=item $term->XDeleteProperty ($window, $property)
		1909
		1910	=item $window = $term->DefaultRootWindow
		1911
		1912	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1913
		1914	=item $term->XMapWindow ($window)
		1915
		1916	=item $term->XUnmapWindow ($window)
		1917
		1918	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1919
		1920	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1921
		1922	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1923
		1924	Various X or X-related functions. The C<$term> object only serves as
		1925	the source of the display, otherwise those functions map more-or-less
		1926	directly onto the X functions of the same name.
1449		1927
1450	=back	1928	=back
1451		1929
1452	=cut	1930	=cut
1453		1931
…		…
1517	my ($self, $text, $cb) = @_;	1995	my ($self, $text, $cb) = @_;
1518		1996
1519	$self->add_item ({ type => "button", text => $text, activate => $cb});	1997	$self->add_item ({ type => "button", text => $text, activate => $cb});
1520	}	1998	}
1521		1999
1522	=item $popup->add_toggle ($text, $cb, $initial_value)	2000	=item $popup->add_toggle ($text, $initial_value, $cb)
1523		2001
1524	Adds a toggle/checkbox item to the popup. Teh callback gets called	2002	Adds a toggle/checkbox item to the popup. The callback gets called
1525	whenever it gets toggled, with a boolean indicating its value as its first	2003	whenever it gets toggled, with a boolean indicating its new value as its
1526	argument.	2004	first argument.
1527		2005
1528	=cut	2006	=cut
1529		2007
1530	sub add_toggle {	2008	sub add_toggle {
1531	my ($self, $text, $cb, $value) = @_;	2009	my ($self, $text, $value, $cb) = @_;
1532		2010
1533	my $item; $item = {	2011	my $item; $item = {
1534	type => "button",	2012	type => "button",
1535	text => " $text",	2013	text => " $text",
1536	value => $value,	2014	value => $value,
…		…
1555	my $env = $self->{term}->env;	2033	my $env = $self->{term}->env;
1556	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2034	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1557	delete $env->{LC_ALL};	2035	delete $env->{LC_ALL};
1558	$env->{LC_CTYPE} = $self->{term}->locale;	2036	$env->{LC_CTYPE} = $self->{term}->locale;
1559		2037
1560	urxvt::term->new ($env, $self->{term}->resource ("name"),	2038	my $term = urxvt::term->new (
1561	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2039	$env, "popup",
		2040	"--perl-lib" => "", "--perl-ext-common" => "",
		2041	"-pty-fd" => -1, "-sl" => 0,
		2042	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1562	"--transient-for" => $self->{term}->parent,	2043	"--transient-for" => $self->{term}->parent,
1563	"-display" => $self->{term}->display_id,	2044	"-display" => $self->{term}->display_id,
1564	"-pe" => "urxvt-popup")	2045	"-pe" => "urxvt-popup",
1565	or die "unable to create popup window\n";	2046	) or die "unable to create popup window\n";
		2047
		2048	unless (delete $term->{urxvt_popup_init_done}) {
		2049	$term->ungrab;
		2050	$term->destroy;
		2051	die "unable to initialise popup window\n";
		2052	}
1566	}	2053	}
1567		2054
1568	sub DESTROY {	2055	sub DESTROY {
1569	my ($self) = @_;	2056	my ($self) = @_;
1570		2057
1571	delete $self->{term}{_destroy}{$self};	2058	delete $self->{term}{_destroy}{$self};
1572	$self->{term}->ungrab;	2059	$self->{term}->ungrab;
1573	}	2060	}
1574		2061
1575	=back	2062	=back
		2063
		2064	=cut
		2065
		2066	package urxvt::watcher;
1576		2067
1577	=head2 The C<urxvt::timer> Class	2068	=head2 The C<urxvt::timer> Class
1578		2069
1579	This class implements timer watchers/events. Time is represented as a	2070	This class implements timer watchers/events. Time is represented as a
1580	fractional number of seconds since the epoch. Example:	2071	fractional number of seconds since the epoch. Example:
…		…
1584	->new	2075	->new
1585	->interval (1)	2076	->interval (1)
1586	->cb (sub {	2077	->cb (sub {
1587	$term->{overlay}->set (0, 0,	2078	$term->{overlay}->set (0, 0,
1588	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2079	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1589	});	2080	});
1590		2081
1591	=over 4	2082	=over 4
1592		2083
1593	=item $timer = new urxvt::timer	2084	=item $timer = new urxvt::timer
1594		2085
…		…
1597		2088
1598	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2089	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1599		2090
1600	Set the callback to be called when the timer triggers.	2091	Set the callback to be called when the timer triggers.
1601		2092
1602	=item $tstamp = $timer->at
1603
1604	Return the time this watcher will fire next.
1605
1606	=item $timer = $timer->set ($tstamp)	2093	=item $timer = $timer->set ($tstamp[, $interval])
1607		2094
1608	Set the time the event is generated to $tstamp.	2095	Set the time the event is generated to $tstamp (and optionally specifies a
		2096	new $interval).
1609		2097
1610	=item $timer = $timer->interval ($interval)	2098	=item $timer = $timer->interval ($interval)
1611		2099
1612	Normally (and when C<$interval> is C<0>), the timer will automatically	2100	By default (and when C<$interval> is C<0>), the timer will automatically
1613	stop after it has fired once. If C<$interval> is non-zero, then the timer	2101	stop after it has fired once. If C<$interval> is non-zero, then the timer
1614	is automatically rescheduled at the given intervals.	2102	is automatically rescheduled at the given intervals.
1615		2103
1616	=item $timer = $timer->start	2104	=item $timer = $timer->start
1617		2105
1618	Start the timer.	2106	Start the timer.
1619		2107
1620	=item $timer = $timer->start ($tstamp)	2108	=item $timer = $timer->start ($tstamp[, $interval])
1621		2109
1622	Set the event trigger time to C<$tstamp> and start the timer.	2110	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2111	also replaces the interval.
		2112
		2113	=item $timer = $timer->after ($delay[, $interval])
		2114
		2115	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1623		2116
1624	=item $timer = $timer->stop	2117	=item $timer = $timer->stop
1625		2118
1626	Stop the timer.	2119	Stop the timer.
1627		2120
…		…
1633		2126
1634	$term->{socket} = ...	2127	$term->{socket} = ...
1635	$term->{iow} = urxvt::iow	2128	$term->{iow} = urxvt::iow
1636	->new	2129	->new
1637	->fd (fileno $term->{socket})	2130	->fd (fileno $term->{socket})
1638	->events (urxvt::EVENT_READ)	2131	->events (urxvt::EV_READ)
1639	->start	2132	->start
1640	->cb (sub {	2133	->cb (sub {
1641	my ($iow, $revents) = @_;	2134	my ($iow, $revents) = @_;
1642	# $revents must be 1 here, no need to check	2135	# $revents must be 1 here, no need to check
1643	sysread $term->{socket}, my $buf, 8192	2136	sysread $term->{socket}, my $buf, 8192
…		…
1656	Set the callback to be called when io events are triggered. C<$reventmask>	2149	Set the callback to be called when io events are triggered. C<$reventmask>
1657	is a bitset as described in the C<events> method.	2150	is a bitset as described in the C<events> method.
1658		2151
1659	=item $iow = $iow->fd ($fd)	2152	=item $iow = $iow->fd ($fd)
1660		2153
1661	Set the filedescriptor (not handle) to watch.	2154	Set the file descriptor (not handle) to watch.
1662		2155
1663	=item $iow = $iow->events ($eventmask)	2156	=item $iow = $iow->events ($eventmask)
1664		2157
1665	Set the event mask to watch. The only allowed values are	2158	Set the event mask to watch. The only allowed values are
1666	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2159	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1667	together, or C<urxvt::EVENT_NONE>.	2160	together, or C<urxvt::EV_NONE>.
1668		2161
1669	=item $iow = $iow->start	2162	=item $iow = $iow->start
1670		2163
1671	Start watching for requested events on the given handle.	2164	Start watching for requested events on the given handle.
1672		2165
1673	=item $iow = $iow->stop	2166	=item $iow = $iow->stop
1674		2167
1675	Stop watching for events on the given filehandle.	2168	Stop watching for events on the given file handle.
		2169
		2170	=back
		2171
		2172	=head2 The C<urxvt::iw> Class
		2173
		2174	This class implements idle watchers, that get called automatically when
		2175	the process is idle. They should return as fast as possible, after doing
		2176	some useful work.
		2177
		2178	=over 4
		2179
		2180	=item $iw = new urxvt::iw
		2181
		2182	Create a new idle watcher object in stopped state.
		2183
		2184	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2185
		2186	Set the callback to be called when the watcher triggers.
		2187
		2188	=item $timer = $timer->start
		2189
		2190	Start the watcher.
		2191
		2192	=item $timer = $timer->stop
		2193
		2194	Stop the watcher.
		2195
		2196	=back
		2197
		2198	=head2 The C<urxvt::pw> Class
		2199
		2200	This class implements process watchers. They create an event whenever a
		2201	process exits, after which they stop automatically.
		2202
		2203	my $pid = fork;
		2204	...
		2205	$term->{pw} = urxvt::pw
		2206	->new
		2207	->start ($pid)
		2208	->cb (sub {
		2209	my ($pw, $exit_status) = @_;
		2210	...
		2211	});
		2212
		2213	=over 4
		2214
		2215	=item $pw = new urxvt::pw
		2216
		2217	Create a new process watcher in stopped state.
		2218
		2219	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2220
		2221	Set the callback to be called when the timer triggers.
		2222
		2223	=item $pw = $timer->start ($pid)
		2224
		2225	Tells the watcher to start watching for process C<$pid>.
		2226
		2227	=item $pw = $pw->stop
		2228
		2229	Stop the watcher.
1676		2230
1677	=back	2231	=back
1678		2232
1679	=head1 ENVIRONMENT	2233	=head1 ENVIRONMENT
1680		2234
…		…
1689		2243
1690	=item >= 3 - script loading and management	2244	=item >= 3 - script loading and management
1691		2245
1692	=item >=10 - all called hooks	2246	=item >=10 - all called hooks
1693		2247
1694	=item >=11 - hook reutrn values	2248	=item >=11 - hook return values
1695		2249
1696	=back	2250	=back
1697		2251
1698	=head1 AUTHOR	2252	=head1 AUTHOR
1699		2253
…		…
1701	http://software.schmorp.de/pkg/rxvt-unicode	2255	http://software.schmorp.de/pkg/rxvt-unicode
1702		2256
1703	=cut	2257	=cut
1704		2258
1705	1	2259	1
		2260
		2261	# vim: sw=3:

Diff Legend

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