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.88 by root, Thu Jan 12 12:05:28 2006 UTC vs.
Revision 1.198 by root, Tue Oct 4 22:25:14 2011 UTC

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

Diff Legend

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