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.109 by root, Thu Jan 19 16:07:09 2006 UTC vs.
Revision 1.196 by sf-exg, Wed Jun 29 22:46:48 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 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.
93		124
94	Other extensions can extend this popup menu by pushing a code reference onto	125	Other extensions can extend this popup menu by pushing a code reference
95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
96		128
97	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
98	is in C<$_>, which can be used to decide wether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
99	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
100	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
101	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
102		134
103	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
104	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:	137	C<a>s:
106		138
107	push urxvt::ext::selection_popup::hook, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
109	: ()	141	: ()
110	};	142	};
111
112	Don't run it in a hook, otherwise the menu will grow and grow. Instead put
113	it at the toplevel of your extension.
114		143
115	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
116		145
117	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
118	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
…		…
123	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>
124	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
125	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
126	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
127	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
128	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.
129		189
130	=item selection-autotransform	190	=item selection-autotransform
131		191
132	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
133	whenever a selection is made.	193	whenever a selection is made.
…		…
160		220
161	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
162	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
163	the message into vi commands to load the file.	223	the message into vi commands to load the file.
164		224
165	=item mark-urls	225	=item tabbed
166		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
167	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
168	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
169	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
170	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.
171		258
172	=item automove-background	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.
173		263
174	This is basically a one-line extension that dynamically changes the background pixmap offset	264	It is possible to activate the most recently seen match from the keyboard.
175	to the window position, in effect creating the same effect as pseudo transparency with	265	Simply bind a keysym to "perl:matcher" as seen in the example below.
176	a custom pixmap. No scaling is supported in this mode. Exmaple:
177		266
178	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	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.
179		313
180	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
181		315
182	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
183	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
184	similar-looking ascii character.	318	similar-looking ascii character.
185		319
186	=item digital-clock	320	=item digital-clock
187		321
188	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.
189		391
190	=item example-refresh-hooks	392	=item example-refresh-hooks
191		393
192	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
193	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
194	overlays or changes.	396	overlays or changes.
195		397
196	=item selection-pastebin	398	=item confirm-paste
197		399
198	This is a little rarely useful extension that Uploads the selection as	400	Displays a confirmation dialog when a paste containing at least a full
199	textfile to a remote site (or does other things). (The implementation is	401	line is detected.
200	not currently secure for use in a multiuser environment as it writes to
201	F</tmp> directly.).
202
203	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
204	i.e.
205
206	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
207
208	Pressing this combination runs a command with C<%> replaced by the name of
209	the textfile. This command can be set via a resource:
210
211	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
212
213	And the default is likely not useful to anybody but the few people around
214	here :)
215
216	The name of the textfile is the hex encoded md5 sum of the selection, so
217	the same content should lead to the same filename.
218
219	After a successful upload the selection will be replaced by the text given
220	in the C<selection-pastebin-url> resource (again, the % is the placeholder
221	for the filename):
222
223	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
224		402
225	=back	403	=back
226		404
227	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
228		406
…		…
244		422
245	=over 4	423	=over 4
246		424
247	=item $text	425	=item $text
248		426
249	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
250	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.
251		429
252	=item $string	430	=item $string
253		431
254	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
…		…
262		440
263	=back	441	=back
264		442
265	=head2 Extension Objects	443	=head2 Extension Objects
266		444
267	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
268	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,
269	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
270	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
271	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
272	use.	451	internal use.
273		452
274	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
275	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
276		455
277	It has the following methods and data members:	456	It has the following methods and data members:
…		…
298	=head2 Hooks	477	=head2 Hooks
299		478
300	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
301	called whenever the relevant event happens.	480	called whenever the relevant event happens.
302		481
303	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
304	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
305		484
306	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
307	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
308	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.
309		488
310	I<< When in doubt, return a false value (preferably C<()>). >>	489	I<< When in doubt, return a false value (preferably C<()>). >>
311		490
312	=over 4	491	=over 4
313		492
314	=item on_init $term	493	=item on_init $term
315		494
316	Called after a new terminal object has been initialized, but before	495	Called after a new terminal object has been initialized, but before
317	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
318	call or deliver senseless data, as terminal size and other characteristics	497	call or deliver senseless data, as terminal size and other characteristics
319	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
320	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).
321		511
322	=item on_reset $term	512	=item on_reset $term
323		513
324	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
325	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
326	variables.	516	variables.
327		517
328	=item on_start $term
329
330	Called at the very end of initialisation of a new terminal, just before
331	returning to the mainloop.
332
333	=item on_child_start $term, $pid	518	=item on_child_start $term, $pid
334		519
335	Called just after the child process has been C<fork>ed.	520	Called just after the child process has been C<fork>ed.
336		521
337	=item on_child_exit $term, $status	522	=item on_child_exit $term, $status
…		…
352		537
353	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
354	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
355	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
356		541
357	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.
358		543
359	=item on_sel_extend $term	544	=item on_sel_extend $term
360		545
361	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
362	click) and is either supposed to return false (normal operation), or	547	click) and is either supposed to return false (normal operation), or
363	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
364	processing. This can happen multiple times, as long as the callback	549	processing. This can happen multiple times, as long as the callback
365	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
366	supposed to enlarge the selection more and more, if possible.	551	supposed to enlarge the selection more and more, if possible.
367		552
368	See the F<selection> example extension.	553	See the F<selection> example extension.
369		554
370	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
371		556
372	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
373	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
374	show this many lines of scrollback.	559	show this many lines of scrollback.
375		560
376	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
377		562
…		…
381		566
382	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,
383	$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
384	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
385		570
386	=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
387		582
388	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
389	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
390	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
391	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,
392	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
393	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	}
394		599
395	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,
396	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
397	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.
398		606
399	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
400		608
401	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
402	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
…		…
407	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
408		616
409	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
410	suppress or filter tty input.	618	suppress or filter tty input.
411		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
412	=item on_line_update $term, $row	627	=item on_line_update $term, $row
413		628
414	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
415	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
416	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,
…		…
423	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
424	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
425		640
426	=item on_refresh_begin $term	641	=item on_refresh_begin $term
427		642
428	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
429	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
430	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
431	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
432		647
433	=item on_refresh_end $term	648	=item on_refresh_end $term
434		649
435	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>.
436		651
437	=item on_keyboard_command $term, $string	652	=item on_user_command $term, $string
438		653
439	Called whenever the user presses a key combination that has a	654	Called whenever a user-configured event is being activated (e.g. via
440	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>
441	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.
442		666
443	=item on_x_event $term, $event	667	=item on_x_event $term, $event
444		668
445	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
446	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
447	members are not passed.	671	members are not passed.
448		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
449	=item on_focus_in $term	677	=item on_focus_in $term
450		678
451	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
452	does focus in processing.	680	does focus in processing.
453		681
454	=item on_focus_out $term	682	=item on_focus_out $term
455		683
456	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
457	focus out processing.	685	focus out processing.
458		686
459	=item on_configure_notify $term, $event	687	=item on_configure_notify $term, $event
460		688
		689	=item on_property_notify $term, $event
		690
461	=item on_key_press $term, $event, $keysym, $octets	691	=item on_key_press $term, $event, $keysym, $octets
462		692
463	=item on_key_release $term, $event, $keysym	693	=item on_key_release $term, $event, $keysym
464		694
465	=item on_button_press $term, $event	695	=item on_button_press $term, $event
…		…
470		700
471	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
472		702
473	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
474		704
475	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
476	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.
477		707
478	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
479	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
480	and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
481		711
482	C<on_key_press> additionally receives the string rxvt-unicode would	712	C<on_key_press> additionally receives the string rxvt-unicode would
483	output, if any, in locale-specific encoding.	713	output, if any, in locale-specific encoding.
484		714
485	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.
486		729
487	=back	730	=back
488		731
489	=cut	732	=cut
490		733
…		…
496	use Scalar::Util ();	739	use Scalar::Util ();
497	use List::Util ();	740	use List::Util ();
498		741
499	our $VERSION = 1;	742	our $VERSION = 1;
500	our $TERM;	743	our $TERM;
		744	our @TERM_INIT;
		745	our @TERM_EXT;
501	our @HOOKNAME;	746	our @HOOKNAME;
502	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	747	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
503	our %OPTION;	748	our %OPTION;
504		749
505	our $LIBDIR;	750	our $LIBDIR;
506	our $RESNAME;	751	our $RESNAME;
507	our $RESCLASS;	752	our $RESCLASS;
508	our $RXVTNAME;	753	our $RXVTNAME;
509		754
		755	our $NOCHAR = chr 0xffff;
		756
510	=head2 Variables in the C<urxvt> Package	757	=head2 Variables in the C<urxvt> Package
511		758
512	=over 4	759	=over 4
513		760
514	=item $urxvt::LIBDIR	761	=item $urxvt::LIBDIR
…		…
527	=item $urxvt::TERM	774	=item $urxvt::TERM
528		775
529	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
530	object, whenever a callback/hook is executing.	777	object, whenever a callback/hook is executing.
531		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
532	=back	795	=back
533		796
534	=head2 Functions in the C<urxvt> Package	797	=head2 Functions in the C<urxvt> Package
535		798
536	=over 4	799	=over 4
537		800
538	=item urxvt::fatal $errormessage	801	=item urxvt::fatal $errormessage
539		802
540	Fatally aborts execution with the given error message. Avoid at all	803	Fatally aborts execution with the given error message (which should
541	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
542	starts up.	805	is acceptable (and useful) is in the init hook, where it prevents the
		806	terminal from starting up.
543		807
544	=item urxvt::warn $string	808	=item urxvt::warn $string
545		809
546	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
547	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
548	that calls this function.	812	that calls this function.
549		813
550	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
551	correct place, e.g. on stderr of the connecting urxvtc client.	815	correct place, e.g. on stderr of the connecting urxvtc client.
552		816
553	Messages have a size limit of 1023 bytes currently.	817	Messages have a size limit of 1023 bytes currently.
		818
		819	=item @terms = urxvt::termlist
		820
		821	Returns all urxvt::term objects that exist in this process, regardless of
		822	whether they are started, being destroyed etc., so be careful. Only term
		823	objects that have perl extensions attached will be returned (because there
		824	is no urxvt::term object associated with others).
554		825
555	=item $time = urxvt::NOW	826	=item $time = urxvt::NOW
556		827
557	Returns the "current time" (as per the event loop).	828	Returns the "current time" (as per the event loop).
558		829
…		…
601		872
602	=item $rend = urxvt::OVERLAY_RSTYLE	873	=item $rend = urxvt::OVERLAY_RSTYLE
603		874
604	Return the rendition mask used for overlays by default.	875	Return the rendition mask used for overlays by default.
605		876
606	=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
607		879
608	Return the bit that enabled bold, italic, blink, reverse-video and	880	Return the bit that enabled bold, italic, blink, reverse-video and
609	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
610	the bitset.	882	the bitset.
611		883
…		…
616	Return the foreground/background colour index, respectively.	888	Return the foreground/background colour index, respectively.
617		889
618	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	890	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
619		891
620	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	892	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		893
		894	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
621		895
622	Replace the foreground/background colour in the rendition mask with the	896	Replace the foreground/background colour in the rendition mask with the
623	specified one.	897	specified one.
624		898
625	=item $value = urxvt::GET_CUSTOM $rend	899	=item $value = urxvt::GET_CUSTOM $rend
…		…
644	unless $msg =~ /\n$/;	918	unless $msg =~ /\n$/;
645	urxvt::warn ($msg);	919	urxvt::warn ($msg);
646	};	920	};
647	}	921	}
648		922
		923	no warnings 'utf8';
		924
649	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	925	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
650		926
651	sub verbose {	927	sub verbose {
652	my ($level, $msg) = @_;	928	my ($level, $msg) = @_;
653	warn "$msg\n" if $level <= $verbosity;	929	warn "$msg\n" if $level <= $verbosity;
…		…
656	my %extension_pkg;	932	my %extension_pkg;
657		933
658	# load a single script into its own package, once only	934	# load a single script into its own package, once only
659	sub extension_package($) {	935	sub extension_package($) {
660	my ($path) = @_;	936	my ($path) = @_;
661
662	no strict 'refs';
663		937
664	$extension_pkg{$path} ||= do {	938	$extension_pkg{$path} ||= do {
665	$path =~ /([^\/\\]+)$/;	939	$path =~ /([^\/\\]+)$/;
666	my $pkg = $1;	940	my $pkg = $1;
667	$pkg =~ s/[^[:word:]]/_/g;	941	$pkg =~ s/[^[:word:]]/_/g;
…		…
670	verbose 3, "loading extension '$path' into package '$pkg'";	944	verbose 3, "loading extension '$path' into package '$pkg'";
671		945
672	open my $fh, "<:raw", $path	946	open my $fh, "<:raw", $path
673	or die "$path: $!";	947	or die "$path: $!";
674		948
675	@{"$pkg\::ISA"} = urxvt::term::extension::;
676
677	my $source =	949	my $source =
678	"package $pkg; use strict; use utf8;\n"	950	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
679	. "#line 1 \"$path\"\n{\n"	951	. "#line 1 \"$path\"\n{\n"
680	. (do { local $/; <$fh> })	952	. (do { local $/; <$fh> })
681	. "\n};\n1";	953	. "\n};\n1";
682		954
683	eval $source	955	eval $source
…		…
694	local $TERM = shift;	966	local $TERM = shift;
695	my $htype = shift;	967	my $htype = shift;
696		968
697	if ($htype == 0) { # INIT	969	if ($htype == 0) { # INIT
698	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	970	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
699		971
700	my %ext_arg;	972	my %ext_arg;
701		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
702	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	983	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
703	if ($_ eq "default") {	984	if ($_ eq "default") {
704	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	985	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
705	} elsif (/^-(.*)$/) {	986	} elsif (/^-(.*)$/) {
706	delete $ext_arg{$1};	987	delete $ext_arg{$1};
707	} elsif (/^([^<]+)<(.*)>$/) {	988	} elsif (/^([^<]+)<(.*)>$/) {
708	push @{ $ext_arg{$1} }, $2;	989	push @{ $ext_arg{$1} }, $2;
709	} else {	990	} else {
710	$ext_arg{$_} ||= [];	991	$ext_arg{$_} ||= [];
711	}	992	}
712	}	993	}
713		994
714	while (my ($ext, $argv) = each %ext_arg) {	995	for my $ext (sort keys %ext_arg) {
715	my @files = grep -f $_, map "$_/$ext", @dirs;	996	my @files = grep -f $_, map "$_/$ext", @dirs;
716		997
717	if (@files) {	998	if (@files) {
718	$TERM->register_package (extension_package $files[0], $argv);	999	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
719	} else {	1000	} else {
720	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";
721	}	1002	}
722	}	1003	}
723		1004
…		…
729		1010
730	if (my $cb = $TERM->{_hook}[$htype]) {	1011	if (my $cb = $TERM->{_hook}[$htype]) {
731	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1012	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
732	if $verbosity >= 10;	1013	if $verbosity >= 10;
733		1014
734	keys %$cb;	1015	for my $pkg (keys %$cb) {
735
736	while (my ($pkg, $cb) = each %$cb) {
737	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1016	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
738	and last;	1017	$retval ||= $retval_;
739		1018
740	if ($@) {	1019	if ($@) {
741	$TERM->ungrab; # better to lose the grab than the session	1020	$TERM->ungrab; # better to lose the grab than the session
742	warn $@;	1021	warn $@;
743	}	1022	}
…		…
754	# clear package	1033	# clear package
755	%$TERM = ();	1034	%$TERM = ();
756	}	1035	}
757		1036
758	$retval	1037	$retval
		1038	}
		1039
		1040	sub SET_COLOR($$$) {
		1041	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1042	}
		1043
		1044	sub rend2mask {
		1045	no strict 'refs';
		1046	my ($str, $mask) = (@_, 0);
		1047	my %color = ( fg => undef, bg => undef );
		1048	my @failed;
		1049	for my $spec ( split /\s+/, $str ) {
		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)
759	}	1067	}
760		1068
761	# urxvt::term::extension	1069	# urxvt::term::extension
762		1070
763	package urxvt::term::extension;	1071	package urxvt::term::extension;
…		…
834	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
835	work.	1143	work.
836		1144
837	=cut	1145	=cut
838		1146
839	our $VERSION = 1;	1147	our $VERSION = '5.23';
840		1148
841	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1149	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
842	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1150	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
843		1151
844	sub timer {	1152	sub timer {
…		…
846		1154
847	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
848		1156
849	urxvt::timer	1157	urxvt::timer
850	->new	1158	->new
851	->start (urxvt::NOW + $arg{after})	1159	->after ($arg{after}, $arg{interval})
852	->cb (sub {	1160	->cb ($arg{interval} ? $cb : sub {
853	$_[0]->stop; # need to cancel manually	1161	$_[0]->stop; # need to cancel manually
854	$cb->();	1162	$cb->();
855	})	1163	})
856	}	1164	}
857		1165
858	sub io {	1166	sub io {
859	my ($class, %arg) = @_;	1167	my ($class, %arg) = @_;
860		1168
861	my $cb = $arg{cb};	1169	my $cb = $arg{cb};
		1170	my $fd = fileno $arg{fh};
		1171	defined $fd or $fd = $arg{fh};
862		1172
863	bless [$arg{fh}, urxvt::iow	1173	bless [$arg{fh}, urxvt::iow
864	->new	1174	->new
865	->fd (fileno $arg{fh})	1175	->fd ($fd)
866	->events (($arg{poll} =~ /r/ ? 1 : 0)	1176	->events (($arg{poll} =~ /r/ ? 1 : 0)
867	| ($arg{poll} =~ /w/ ? 2 : 0))	1177	| ($arg{poll} =~ /w/ ? 2 : 0))
868	->start	1178	->start
869	->cb (sub {	1179	->cb ($cb)
870	$cb->(($_[1] & 1 ? 'r' : '')
871	. ($_[1] & 2 ? 'w' : ''));
872	})],
873	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	})
874	}	1206	}
875		1207
876	sub DESTROY {	1208	sub DESTROY {
877	$_[0][1]->stop;	1209	$_[0][1]->stop;
878	}	1210	}
879		1211
880	sub condvar {	1212	sub one_event {
881	bless \my $flag, urxvt::anyevent::condvar::
882	}
883
884	sub urxvt::anyevent::condvar::broadcast {
885	${$_[0]}++;
886	}
887
888	sub urxvt::anyevent::condvar::wait {
889	unless (${$_[0]}) {
890	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";
891	}
892	}	1214	}
893		1215
894	package urxvt::term;	1216	package urxvt::term;
895		1217
896	=head2 The C<urxvt::term> Class	1218	=head2 The C<urxvt::term> Class
…		…
901		1223
902	# find on_xxx subs in the package and register them	1224	# find on_xxx subs in the package and register them
903	# as hooks	1225	# as hooks
904	sub register_package {	1226	sub register_package {
905	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::;
906		1234
907	my $proxy = bless {	1235	my $proxy = bless {
908	_pkg => $pkg,	1236	_pkg => $pkg,
909	argv => $argv,	1237	argv => $argv,
910	}, $pkg;	1238	}, $pkg;
…		…
926	hash which defines the environment of the new terminal.	1254	hash which defines the environment of the new terminal.
927		1255
928	Croaks (and probably outputs an error message) if the new instance	1256	Croaks (and probably outputs an error message) if the new instance
929	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
930	initialise perl, and the terminal object otherwise. The C<init> and	1258	initialise perl, and the terminal object otherwise. The C<init> and
931	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).
932		1261
933	=cut	1262	=cut
934		1263
935	sub new {	1264	sub new {
936	my ($class, $env, @args) = @_;	1265	my ($class, $env, @args) = @_;
937		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
938	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1270	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
939	}	1271	}
940		1272
941	=item $term->destroy	1273	=item $term->destroy
942		1274
943	Destroy the terminal object (close the window, free resources	1275	Destroy the terminal object (close the window, free resources
…		…
973		1305
974	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
975	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
976	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.
977		1309
978	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
979	source file F</src/optinc.h> to see the actual list:	1311	source file F</src/optinc.h> to see the actual list:
980		1312
981	borderLess console cursorBlink cursorUnderline hold iconic insecure	1313	borderLess buffered console cursorBlink cursorUnderline hold iconic
982	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1314	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
983	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1315	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
984	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1316	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
985	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1317	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
986	transparent tripleclickwords utmpInhibit visualBell	1318	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1319	urgentOnBell utmpInhibit visualBell
987		1320
988	=item $value = $term->resource ($name[, $newval])	1321	=item $value = $term->resource ($name[, $newval])
989		1322
990	Returns the current resource value associated with a given name and	1323	Returns the current resource value associated with a given name and
991	optionally sets a new value. Setting values is most useful in the C<init>	1324	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1000	likely change).	1333	likely change).
1001		1334
1002	Please note that resource strings will currently only be freed when the	1335	Please note that resource strings will currently only be freed when the
1003	terminal is destroyed, so changing options frequently will eat memory.	1336	terminal is destroyed, so changing options frequently will eat memory.
1004		1337
1005	Here is a a likely non-exhaustive list of resource names, not all of which	1338	Here is a likely non-exhaustive list of resource names, not all of which
1006	are supported in every build, please see the source file F</src/rsinc.h>	1339	are supported in every build, please see the source file F</src/rsinc.h>
1007	to see the actual list:	1340	to see the actual list:
1008		1341
1009	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1342	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1010	borderLess color cursorBlink cursorUnderline cutchars delete_key	1343	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1011	display_name embed ext_bwidth fade font geometry hold iconName	1344	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1012	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1345	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1346	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1013	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1347	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1014	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1348	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1015	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1349	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1016	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1350	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1017	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1351	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1018	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1352	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1019	secondaryScreen secondaryScroll selectstyle shade term_name title	1353	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1020	transient_for transparent transparent_all tripleclickwords utmpInhibit	1354	term_name title transient_for transparent tripleclickwords urgentOnBell
1021	visualBell	1355	utmpInhibit visualBell
1022		1356
1023	=cut	1357	=cut
1024		1358
1025	sub resource($$;$) {	1359	sub resource($$;$) {
1026	my ($self, $name) = (shift, shift);	1360	my ($self, $name) = (shift, shift);
1027	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1361	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1028	&urxvt::term::_resource	1362	goto &urxvt::term::_resource
1029	}	1363	}
1030		1364
1031	=item $value = $term->x_resource ($pattern)	1365	=item $value = $term->x_resource ($pattern)
1032		1366
1033	Returns the X-Resource for the given pattern, excluding the program or	1367	Returns the X-Resource for the given pattern, excluding the program or
…		…
1058		1392
1059	=item ($row, $col) = $term->selection_beg ([$row, $col])	1393	=item ($row, $col) = $term->selection_beg ([$row, $col])
1060		1394
1061	=item ($row, $col) = $term->selection_end ([$row, $col])	1395	=item ($row, $col) = $term->selection_end ([$row, $col])
1062		1396
1063	Return the current values of the selection mark, begin or end positions,	1397	Return the current values of the selection mark, begin or end positions.
1064	and optionally set them to new values.	1398
		1399	When arguments are given, then the selection coordinates are set to
		1400	C<$row> and C<$col>, and the selection screen is set to the current
		1401	screen.
		1402
		1403	=item $screen = $term->selection_screen ([$screen])
		1404
		1405	Returns the current selection screen, and then optionally sets it.
1065		1406
1066	=item $term->selection_make ($eventtime[, $rectangular])	1407	=item $term->selection_make ($eventtime[, $rectangular])
1067		1408
1068	Tries to make a selection as set by C<selection_beg> and	1409	Tries to make a selection as set by C<selection_beg> and
1069	C<selection_end>. If C<$rectangular> is true (default: false), a	1410	C<selection_end>. If C<$rectangular> is true (default: false), a
1070	rectangular selection will be made. This is the prefered function to make	1411	rectangular selection will be made. This is the preferred function to make
1071	a selection.	1412	a selection.
1072		1413
1073	=item $success = $term->selection_grab ($eventtime)	1414	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1074		1415
1075	Try to request the primary selection text from the server (for example, as	1416	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1417	true) selection from the server. The corresponding text can be set
1076	set by the next method). No visual feedback will be given. This function	1418	with the next method. No visual feedback will be given. This function
1077	is mostly useful from within C<on_sel_grab> hooks.	1419	is mostly useful from within C<on_sel_grab> hooks.
1078		1420
1079	=item $oldtext = $term->selection ([$newtext])	1421	=item $oldtext = $term->selection ([$newtext, $clipboard])
1080		1422
1081	Return the current selection text and optionally replace it by C<$newtext>.	1423	Return the current selection (clipboard if C<$clipboard> is true) text
		1424	and optionally replace it by C<$newtext>.
		1425
		1426	=item $term->selection_clear ([$clipboard])
		1427
		1428	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1082		1429
1083	=item $term->overlay_simple ($x, $y, $text)	1430	=item $term->overlay_simple ($x, $y, $text)
1084		1431
1085	Create a simple multi-line overlay box. See the next method for details.	1432	Create a simple multi-line overlay box. See the next method for details.
1086		1433
…		…
1116		1463
1117	The methods currently supported on C<urxvt::overlay> objects are:	1464	The methods currently supported on C<urxvt::overlay> objects are:
1118		1465
1119	=over 4	1466	=over 4
1120		1467
1121	=item $overlay->set ($x, $y, $text, $rend)	1468	=item $overlay->set ($x, $y, $text[, $rend])
1122		1469
1123	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1470	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1124	text in rxvt-unicode's special encoding and an array of rendition values	1471	text in rxvt-unicode's special encoding and an array of rendition values
1125	at a specific position inside the overlay.	1472	at a specific position inside the overlay.
		1473
		1474	If C<$rend> is missing, then the rendition will not be changed.
1126		1475
1127	=item $overlay->hide	1476	=item $overlay->hide
1128		1477
1129	If visible, hide the overlay, but do not destroy it.	1478	If visible, hide the overlay, but do not destroy it.
1130		1479
…		…
1200		1549
1201	Normally its not a good idea to use this function, as programs might be	1550	Normally its not a good idea to use this function, as programs might be
1202	confused by changes in cursor position or scrolling. Its useful inside a	1551	confused by changes in cursor position or scrolling. Its useful inside a
1203	C<on_add_lines> hook, though.	1552	C<on_add_lines> hook, though.
1204		1553
		1554	=item $term->scr_change_screen ($screen)
		1555
		1556	Switch to given screen - 0 primary, 1 secondary.
		1557
1205	=item $term->cmd_parse ($octets)	1558	=item $term->cmd_parse ($octets)
1206		1559
1207	Similar to C<scr_add_lines>, but the argument must be in the	1560	Similar to C<scr_add_lines>, but the argument must be in the
1208	locale-specific encoding of the terminal and can contain command sequences	1561	locale-specific encoding of the terminal and can contain command sequences
1209	(escape codes) that will be interpreted.	1562	(escape codes) that will be interpreted.
1210		1563
1211	=item $term->tt_write ($octets)	1564	=item $term->tt_write ($octets)
1212		1565
1213	Write the octets given in C<$data> to the tty (i.e. as program input). To	1566	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1214	pass characters instead of octets, you should convert your strings first	1567	pass characters instead of octets, you should convert your strings first
1215	to the locale-specific encoding using C<< $term->locale_encode >>.	1568	to the locale-specific encoding using C<< $term->locale_encode >>.
		1569
		1570	=item $term->tt_paste ($octets)
		1571
		1572	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1573	CR and bracketing the data with control sequences if bracketed paste mode
		1574	is set.
1216		1575
1217	=item $old_events = $term->pty_ev_events ([$new_events])	1576	=item $old_events = $term->pty_ev_events ([$new_events])
1218		1577
1219	Replaces the event mask of the pty watcher by the given event mask. Can	1578	Replaces the event mask of the pty watcher by the given event mask. Can
1220	be used to suppress input and output handling to the pty/tty. See the	1579	be used to suppress input and output handling to the pty/tty. See the
1221	description of C<< urxvt::timer->events >>. Make sure to always restore	1580	description of C<< urxvt::timer->events >>. Make sure to always restore
1222	the previous value.	1581	the previous value.
1223		1582
		1583	=item $fd = $term->pty_fd
		1584
		1585	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1586	is used.
		1587
1224	=item $windowid = $term->parent	1588	=item $windowid = $term->parent
1225		1589
1226	Return the window id of the toplevel window.	1590	Return the window id of the toplevel window.
1227		1591
1228	=item $windowid = $term->vt	1592	=item $windowid = $term->vt
…		…
1234	Adds the specified events to the vt event mask. Useful e.g. when you want	1598	Adds the specified events to the vt event mask. Useful e.g. when you want
1235	to receive pointer events all the times:	1599	to receive pointer events all the times:
1236		1600
1237	$term->vt_emask_add (urxvt::PointerMotionMask);	1601	$term->vt_emask_add (urxvt::PointerMotionMask);
1238		1602
		1603	=item $term->focus_in
		1604
		1605	=item $term->focus_out
		1606
		1607	=item $term->key_press ($state, $keycode[, $time])
		1608
		1609	=item $term->key_release ($state, $keycode[, $time])
		1610
		1611	Deliver various fake events to to terminal.
		1612
1239	=item $window_width = $term->width	1613	=item $window_width = $term->width
1240		1614
1241	=item $window_height = $term->height	1615	=item $window_height = $term->height
1242		1616
1243	=item $font_width = $term->fwidth	1617	=item $font_width = $term->fwidth
…		…
1273	=item $env = $term->env	1647	=item $env = $term->env
1274		1648
1275	Returns a copy of the environment in effect for the terminal as a hashref	1649	Returns a copy of the environment in effect for the terminal as a hashref
1276	similar to C<\%ENV>.	1650	similar to C<\%ENV>.
1277		1651
		1652	=item @envv = $term->envv
		1653
		1654	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1655
		1656	=item @argv = $term->argv
		1657
		1658	Return the argument vector as this terminal, similar to @ARGV, but
		1659	includes the program name as first element.
		1660
1278	=cut	1661	=cut
1279		1662
1280	sub env {	1663	sub env {
1281	if (my $env = $_[0]->_env) {
1282	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1664	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1283	} else {
1284	+{ %ENV }
1285	}
1286	}	1665	}
1287		1666
1288	=item $modifiermask = $term->ModLevel3Mask	1667	=item $modifiermask = $term->ModLevel3Mask
1289		1668
1290	=item $modifiermask = $term->ModMetaMask	1669	=item $modifiermask = $term->ModMetaMask
1291		1670
1292	=item $modifiermask = $term->ModNumLockMask	1671	=item $modifiermask = $term->ModNumLockMask
1293		1672
1294	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1673	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1295	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1674	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1675
		1676	=item $screen = $term->current_screen
		1677
		1678	Returns the currently displayed screen (0 primary, 1 secondary).
		1679
		1680	=item $cursor_is_hidden = $term->hidden_cursor
		1681
		1682	Returns whether the cursor is currently hidden or not.
1296		1683
1297	=item $view_start = $term->view_start ([$newvalue])	1684	=item $view_start = $term->view_start ([$newvalue])
1298		1685
1299	Returns the row number of the topmost displayed line. Maximum value is	1686	Returns the row number of the topmost displayed line. Maximum value is
1300	C<0>, which displays the normal terminal contents. Lower values scroll	1687	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1308		1695
1309	Used after changing terminal contents to display them.	1696	Used after changing terminal contents to display them.
1310		1697
1311	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1698	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1312		1699
1313	Returns the text of the entire row with number C<$row_number>. Row C<0>	1700	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1314	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1701	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1315	terminal line. The scrollback buffer starts at line C<-1> and extends to
1316	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1702	terminal line. Nothing will be returned if a nonexistent line
1317	is requested.	1703	is requested.
1318		1704
1319	If C<$new_text> is specified, it will replace characters in the current	1705	If C<$new_text> is specified, it will replace characters in the current
1320	line, starting at column C<$start_col> (default C<0>), which is useful	1706	line, starting at column C<$start_col> (default C<0>), which is useful
1321	to replace only parts of a line. The font index in the rendition will	1707	to replace only parts of a line. The font index in the rendition will
1322	automatically be updated.	1708	automatically be updated.
1323		1709
1324	C<$text> is in a special encoding: tabs and wide characters that use more	1710	C<$text> is in a special encoding: tabs and wide characters that use more
1325	than one cell when displayed are padded with urxvt::NOCHAR characters	1711	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1326	(C<chr 65535>). Characters with combining characters and other characters	1712	characters. Characters with combining characters and other characters that
1327	that do not fit into the normal tetx encoding will be replaced with	1713	do not fit into the normal text encoding will be replaced with characters
1328	characters in the private use area.	1714	in the private use area.
1329		1715
1330	You have to obey this encoding when changing text. The advantage is	1716	You have to obey this encoding when changing text. The advantage is
1331	that C<substr> and similar functions work on screen cells and not on	1717	that C<substr> and similar functions work on screen cells and not on
1332	characters.	1718	characters.
1333		1719
…		…
1477	where one character corresponds to one screen cell. See	1863	where one character corresponds to one screen cell. See
1478	C<< $term->ROW_t >> for details.	1864	C<< $term->ROW_t >> for details.
1479		1865
1480	=item $string = $term->special_decode $text	1866	=item $string = $term->special_decode $text
1481		1867
1482	Converts rxvt-unicodes text reprsentation into a perl string. See	1868	Converts rxvt-unicodes text representation into a perl string. See
1483	C<< $term->ROW_t >> for details.	1869	C<< $term->ROW_t >> for details.
1484		1870
1485	=item $success = $term->grab_button ($button, $modifiermask)	1871	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1486		1872
		1873	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1874
1487	Registers a synchronous button grab. See the XGrabButton manpage.	1875	Register/unregister a synchronous button grab. See the XGrabButton
		1876	manpage.
1488		1877
1489	=item $success = $term->grab ($eventtime[, $sync])	1878	=item $success = $term->grab ($eventtime[, $sync])
1490		1879
1491	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1880	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1492	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1881	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1493		1882
1494	=item $term->allow_events_async	1883	=item $term->allow_events_async
1495		1884
1496	Calls XAllowEvents with AsyncBoth for the most recent grab.	1885	Calls XAllowEvents with AsyncBoth for the most recent grab.
1497		1886
…		…
1504	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1893	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1505	recent grab.	1894	recent grab.
1506		1895
1507	=item $term->ungrab	1896	=item $term->ungrab
1508		1897
1509	Calls XUngrab for the most recent grab. Is called automatically on	1898	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1510	evaluation errors, as it is better to lose the grab in the error case as	1899	evaluation errors, as it is better to lose the grab in the error case as
1511	the session.	1900	the session.
		1901
		1902	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1903
		1904	=item $atom_name = $term->XGetAtomName ($atom)
		1905
		1906	=item @atoms = $term->XListProperties ($window)
		1907
		1908	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1909
		1910	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1911
		1912	=item $term->XDeleteProperty ($window, $property)
		1913
		1914	=item $window = $term->DefaultRootWindow
		1915
		1916	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1917
		1918	=item $term->XMapWindow ($window)
		1919
		1920	=item $term->XUnmapWindow ($window)
		1921
		1922	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1923
		1924	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1925
		1926	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1927
		1928	Various X or X-related functions. The C<$term> object only serves as
		1929	the source of the display, otherwise those functions map more-or-less
		1930	directly onto the X functions of the same name.
1512		1931
1513	=back	1932	=back
1514		1933
1515	=cut	1934	=cut
1516		1935
…		…
1580	my ($self, $text, $cb) = @_;	1999	my ($self, $text, $cb) = @_;
1581		2000
1582	$self->add_item ({ type => "button", text => $text, activate => $cb});	2001	$self->add_item ({ type => "button", text => $text, activate => $cb});
1583	}	2002	}
1584		2003
1585	=item $popup->add_toggle ($text, $cb, $initial_value)	2004	=item $popup->add_toggle ($text, $initial_value, $cb)
1586		2005
1587	Adds a toggle/checkbox item to the popup. Teh callback gets called	2006	Adds a toggle/checkbox item to the popup. The callback gets called
1588	whenever it gets toggled, with a boolean indicating its value as its first	2007	whenever it gets toggled, with a boolean indicating its new value as its
1589	argument.	2008	first argument.
1590		2009
1591	=cut	2010	=cut
1592		2011
1593	sub add_toggle {	2012	sub add_toggle {
1594	my ($self, $text, $cb, $value) = @_;	2013	my ($self, $text, $value, $cb) = @_;
1595		2014
1596	my $item; $item = {	2015	my $item; $item = {
1597	type => "button",	2016	type => "button",
1598	text => " $text",	2017	text => " $text",
1599	value => $value,	2018	value => $value,
…		…
1618	my $env = $self->{term}->env;	2037	my $env = $self->{term}->env;
1619	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2038	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1620	delete $env->{LC_ALL};	2039	delete $env->{LC_ALL};
1621	$env->{LC_CTYPE} = $self->{term}->locale;	2040	$env->{LC_CTYPE} = $self->{term}->locale;
1622		2041
1623	urxvt::term->new ($env, "popup",	2042	my $term = urxvt::term->new (
		2043	$env, "popup",
1624	"--perl-lib" => "", "--perl-ext-common" => "",	2044	"--perl-lib" => "", "--perl-ext-common" => "",
1625	"-pty-fd" => -1, "-sl" => 0,	2045	"-pty-fd" => -1, "-sl" => 0,
1626	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2046	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1627	"--transient-for" => $self->{term}->parent,	2047	"--transient-for" => $self->{term}->parent,
1628	"-display" => $self->{term}->display_id,	2048	"-display" => $self->{term}->display_id,
1629	"-pe" => "urxvt-popup")	2049	"-pe" => "urxvt-popup",
1630	or die "unable to create popup window\n";	2050	) or die "unable to create popup window\n";
		2051
		2052	unless (delete $term->{urxvt_popup_init_done}) {
		2053	$term->ungrab;
		2054	$term->destroy;
		2055	die "unable to initialise popup window\n";
		2056	}
1631	}	2057	}
1632		2058
1633	sub DESTROY {	2059	sub DESTROY {
1634	my ($self) = @_;	2060	my ($self) = @_;
1635		2061
1636	delete $self->{term}{_destroy}{$self};	2062	delete $self->{term}{_destroy}{$self};
1637	$self->{term}->ungrab;	2063	$self->{term}->ungrab;
1638	}	2064	}
1639		2065
1640	=back	2066	=back
		2067
		2068	=cut
		2069
		2070	package urxvt::watcher;
1641		2071
1642	=head2 The C<urxvt::timer> Class	2072	=head2 The C<urxvt::timer> Class
1643		2073
1644	This class implements timer watchers/events. Time is represented as a	2074	This class implements timer watchers/events. Time is represented as a
1645	fractional number of seconds since the epoch. Example:	2075	fractional number of seconds since the epoch. Example:
…		…
1649	->new	2079	->new
1650	->interval (1)	2080	->interval (1)
1651	->cb (sub {	2081	->cb (sub {
1652	$term->{overlay}->set (0, 0,	2082	$term->{overlay}->set (0, 0,
1653	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2083	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1654	});	2084	});
1655		2085
1656	=over 4	2086	=over 4
1657		2087
1658	=item $timer = new urxvt::timer	2088	=item $timer = new urxvt::timer
1659		2089
…		…
1662		2092
1663	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2093	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1664		2094
1665	Set the callback to be called when the timer triggers.	2095	Set the callback to be called when the timer triggers.
1666		2096
1667	=item $tstamp = $timer->at
1668
1669	Return the time this watcher will fire next.
1670
1671	=item $timer = $timer->set ($tstamp)	2097	=item $timer = $timer->set ($tstamp[, $interval])
1672		2098
1673	Set the time the event is generated to $tstamp.	2099	Set the time the event is generated to $tstamp (and optionally specifies a
		2100	new $interval).
1674		2101
1675	=item $timer = $timer->interval ($interval)	2102	=item $timer = $timer->interval ($interval)
1676		2103
1677	Normally (and when C<$interval> is C<0>), the timer will automatically	2104	By default (and when C<$interval> is C<0>), the timer will automatically
1678	stop after it has fired once. If C<$interval> is non-zero, then the timer	2105	stop after it has fired once. If C<$interval> is non-zero, then the timer
1679	is automatically rescheduled at the given intervals.	2106	is automatically rescheduled at the given intervals.
1680		2107
1681	=item $timer = $timer->start	2108	=item $timer = $timer->start
1682		2109
1683	Start the timer.	2110	Start the timer.
1684		2111
1685	=item $timer = $timer->start ($tstamp)	2112	=item $timer = $timer->start ($tstamp[, $interval])
1686		2113
1687	Set the event trigger time to C<$tstamp> and start the timer.	2114	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2115	also replaces the interval.
1688		2116
1689	=item $timer = $timer->after ($delay)	2117	=item $timer = $timer->after ($delay[, $interval])
1690		2118
1691	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2119	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1692		2120
1693	=item $timer = $timer->stop	2121	=item $timer = $timer->stop
1694		2122
…		…
1702		2130
1703	$term->{socket} = ...	2131	$term->{socket} = ...
1704	$term->{iow} = urxvt::iow	2132	$term->{iow} = urxvt::iow
1705	->new	2133	->new
1706	->fd (fileno $term->{socket})	2134	->fd (fileno $term->{socket})
1707	->events (urxvt::EVENT_READ)	2135	->events (urxvt::EV_READ)
1708	->start	2136	->start
1709	->cb (sub {	2137	->cb (sub {
1710	my ($iow, $revents) = @_;	2138	my ($iow, $revents) = @_;
1711	# $revents must be 1 here, no need to check	2139	# $revents must be 1 here, no need to check
1712	sysread $term->{socket}, my $buf, 8192	2140	sysread $term->{socket}, my $buf, 8192
…		…
1725	Set the callback to be called when io events are triggered. C<$reventmask>	2153	Set the callback to be called when io events are triggered. C<$reventmask>
1726	is a bitset as described in the C<events> method.	2154	is a bitset as described in the C<events> method.
1727		2155
1728	=item $iow = $iow->fd ($fd)	2156	=item $iow = $iow->fd ($fd)
1729		2157
1730	Set the filedescriptor (not handle) to watch.	2158	Set the file descriptor (not handle) to watch.
1731		2159
1732	=item $iow = $iow->events ($eventmask)	2160	=item $iow = $iow->events ($eventmask)
1733		2161
1734	Set the event mask to watch. The only allowed values are	2162	Set the event mask to watch. The only allowed values are
1735	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2163	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1736	together, or C<urxvt::EVENT_NONE>.	2164	together, or C<urxvt::EV_NONE>.
1737		2165
1738	=item $iow = $iow->start	2166	=item $iow = $iow->start
1739		2167
1740	Start watching for requested events on the given handle.	2168	Start watching for requested events on the given handle.
1741		2169
1742	=item $iow = $iow->stop	2170	=item $iow = $iow->stop
1743		2171
1744	Stop watching for events on the given filehandle.	2172	Stop watching for events on the given file handle.
		2173
		2174	=back
		2175
		2176	=head2 The C<urxvt::iw> Class
		2177
		2178	This class implements idle watchers, that get called automatically when
		2179	the process is idle. They should return as fast as possible, after doing
		2180	some useful work.
		2181
		2182	=over 4
		2183
		2184	=item $iw = new urxvt::iw
		2185
		2186	Create a new idle watcher object in stopped state.
		2187
		2188	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2189
		2190	Set the callback to be called when the watcher triggers.
		2191
		2192	=item $timer = $timer->start
		2193
		2194	Start the watcher.
		2195
		2196	=item $timer = $timer->stop
		2197
		2198	Stop the watcher.
		2199
		2200	=back
		2201
		2202	=head2 The C<urxvt::pw> Class
		2203
		2204	This class implements process watchers. They create an event whenever a
		2205	process exits, after which they stop automatically.
		2206
		2207	my $pid = fork;
		2208	...
		2209	$term->{pw} = urxvt::pw
		2210	->new
		2211	->start ($pid)
		2212	->cb (sub {
		2213	my ($pw, $exit_status) = @_;
		2214	...
		2215	});
		2216
		2217	=over 4
		2218
		2219	=item $pw = new urxvt::pw
		2220
		2221	Create a new process watcher in stopped state.
		2222
		2223	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2224
		2225	Set the callback to be called when the timer triggers.
		2226
		2227	=item $pw = $timer->start ($pid)
		2228
		2229	Tells the watcher to start watching for process C<$pid>.
		2230
		2231	=item $pw = $pw->stop
		2232
		2233	Stop the watcher.
1745		2234
1746	=back	2235	=back
1747		2236
1748	=head1 ENVIRONMENT	2237	=head1 ENVIRONMENT
1749		2238
…		…
1758		2247
1759	=item >= 3 - script loading and management	2248	=item >= 3 - script loading and management
1760		2249
1761	=item >=10 - all called hooks	2250	=item >=10 - all called hooks
1762		2251
1763	=item >=11 - hook reutrn values	2252	=item >=11 - hook return values
1764		2253
1765	=back	2254	=back
1766		2255
1767	=head1 AUTHOR	2256	=head1 AUTHOR
1768		2257
1769	Marc Lehmann <pcg@goof.com>	2258	Marc Lehmann <schmorp@schmorp.de>
1770	http://software.schmorp.de/pkg/rxvt-unicode	2259	http://software.schmorp.de/pkg/rxvt-unicode
1771		2260
1772	=cut	2261	=cut
1773		2262
1774	1	2263	1
		2264
		2265	# vim: sw=3:

Diff Legend

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