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.81 by root, Thu Jan 12 00:12:40 2006 UTC vs.
Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 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>
39		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
44	(More) intelligent selection. This extension tries to be more intelligent	51	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	52	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	53	now, it tries to select words, urls and complete shell-quoted
47	too, if your F<ls> supports C<--quoting-style=shell>.	54	arguments, which is very convenient, too, if your F<ls> supports
		55	C<--quoting-style=shell>.
48		56
		57	A double-click usually selects the word under the cursor, further clicks
		58	will enlarge the selection.
		59
		60	The selection works by trying to match a number of regexes and displaying
		61	them in increasing order of length. You can add your own regexes by
		62	specifying resources of the form:
		63
		64	URxvt.selection.pattern-0: perl-regex
		65	URxvt.selection.pattern-1: perl-regex
		66	...
		67
		68	The index number (0, 1...) must not have any holes, and each regex must
		69	contain at least one pair of capturing parentheses, which will be used for
		70	the match. For example, the following adds a regex that matches everything
		71	between two vertical bars:
		72
		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: ^(/[^:]+):\
		81
		82	You can look at the source of the selection extension to see more
		83	interesting uses, such as parsing a line from beginning to end.
		84
49	It also offers the following bindable keyboard command:	85	This extension also offers following bindable keyboard commands:
50		86
51	=over 4	87	=over 4
52		88
53	=item rot13	89	=item rot13
54		90
…		…
61	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
62		98
63	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
64	runtime.	100	runtime.
65		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
66	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
67		120
68	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
69	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
70	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	};
71		143
72	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
73		145
74	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	148	input/output is suspended and a regex is displayed at the bottom of the
		149	screen.
77		150
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	151	Inputting characters appends them to the regex and continues incremental
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80	history, C<enter> leaves search mode at the current position and C<escape>	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	154	bottom. C<Escape> leaves search mode and returns to the point where search
		155	was started, while C<Enter> or C<Return> stay at the current position and
		156	additionally stores the first match in the current line into the primary
		157	selection if the C<Shift> modifier is active.
82		158
83	=item digital-clock	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.
84		162
85	Displays a digital clock using the built-in overlay.	163	See L<perlre> for more info about perl regular expression syntax.
86		164
87	=item mark-urls	165	=item readline (enabled by default)
88		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.
		189
		190	=item selection-autotransform
		191
		192	This selection allows you to do automatic transforms on a selection
		193	whenever a selection is made.
		194
		195	It works by specifying perl snippets (most useful is a single C<s///>
		196	operator) that modify C<$_> as resources:
		197
		198	URxvt.selection-autotransform.0: transform
		199	URxvt.selection-autotransform.1: transform
		200	...
		201
		202	For example, the following will transform selections of the form
		203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		204	$word>:
		205
		206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		207
		208	And this example matches the same,but replaces it with vi-commands you can
		209	paste directly into your (vi :) editor:
		210
		211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		212
		213	Of course, this can be modified to suit your needs and your editor :)
		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
89	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
90	make them clickable. When clicked, the program specified in the resource	251	matching a certain pattern and make it clickable. When clicked with the
91	C<urlLauncher> (default C<x-www-browser>) will be started.	252	mouse button specified in the C<matcher.button> resource (default 2, or
		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.
92		315
93	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
94		317
95	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
96	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
97	similar-looking ascii character.	320	similar-looking ascii character.
		321
		322	=item digital-clock
		323
		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.
98		393
99	=item example-refresh-hooks	394	=item example-refresh-hooks
100		395
101	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
102	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
103	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.
		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
104		412
105	=back	413	=back
106		414
107	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
108		416
…		…
124		432
125	=over 4	433	=over 4
126		434
127	=item $text	435	=item $text
128		436
129	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
130	always represents one screen cell. See L<ROW_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
131		439
132	=item $string	440	=item $string
133		441
134	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
138	=item $octets	446	=item $octets
139		447
140	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
141	locale-specific way.	449	locale-specific way.
142		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
143	=back	457	=back
144		458
145	=head2 Extension Objects	459	=head2 Extension Objects
146		460
147	Very perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
148	for each terminal and each extension and passed as the first parameter to	462	for each terminal, and each terminal has its own set of extension objects,
149	hooks. So extensions can use their C<$self> object without having to think	463	which are passed as the first parameter to hooks. So extensions can use
150	about other extensions, with the exception of methods and members that	464	their C<$self> object without having to think about clashes with other
		465	extensions or other terminals, with the exception of methods and members
151	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
152	use.	467	internal use.
153		468
154	Although it isn't a C<urxvt::term> object, you can call all methods of the	469	Although it isn't a C<urxvt::term> object, you can call all methods of the
155	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
156		471
157	It has the following methods and data members:	472	It has the following methods and data members:
…		…
178	=head2 Hooks	493	=head2 Hooks
179		494
180	The following subroutines can be declared in extension files, and will be	495	The following subroutines can be declared in extension files, and will be
181	called whenever the relevant event happens.	496	called whenever the relevant event happens.
182		497
183	The first argument passed to them is an extension oject as described in	498	The first argument passed to them is an extension object as described in
184	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
185		500
186	B<All> of these hooks must return a boolean value. If it is true, then the	501	B<All> of these hooks must return a boolean value. If any of the called
187	event counts as being I<consumed>, and the invocation of other hooks is	502	hooks returns true, then the event counts as being I<consumed>, and the
188	skipped, and the relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
189		504
190	I<< When in doubt, return a false value (preferably C<()>). >>	505	I<< When in doubt, return a false value (preferably C<()>). >>
191		506
192	=over 4	507	=over 4
193		508
194	=item on_init $term	509	=item on_init $term
195		510
196	Called after a new terminal object has been initialized, but before	511	Called after a new terminal object has been initialized, but before
197	windows are created or the command gets run. Most methods are unsafe to	512	windows are created or the command gets run. Most methods are unsafe to
198	call or deliver senseless data, as terminal size and other characteristics	513	call or deliver senseless data, as terminal size and other characteristics
199	have not yet been determined. You can safely query and change resources,	514	have not yet been determined. You can safely query and change resources
200	though.	515	and options, though. For many purposes the C<on_start> hook is a better
		516	place.
		517
		518	=item on_start $term
		519
		520	Called at the very end of initialisation of a new terminal, just before
		521	trying to map (display) the toplevel and returning to the main loop.
		522
		523	=item on_destroy $term
		524
		525	Called whenever something tries to destroy terminal, when the terminal is
		526	still fully functional (not for long, though).
201		527
202	=item on_reset $term	528	=item on_reset $term
203		529
204	Called after the screen is "reset" for any reason, such as resizing or	530	Called after the screen is "reset" for any reason, such as resizing or
205	control sequences. Here is where you can react on changes to size-related	531	control sequences. Here is where you can react on changes to size-related
206	variables.	532	variables.
207		533
208	=item on_start $term	534	=item on_child_start $term, $pid
209		535
210	Called at the very end of initialisation of a new terminal, just before	536	Called just after the child process has been C<fork>ed.
211	returning to the mainloop.	537
		538	=item on_child_exit $term, $status
		539
		540	Called just after the child process has exited. C<$status> is the status
		541	from C<waitpid>.
212		542
213	=item on_sel_make $term, $eventtime	543	=item on_sel_make $term, $eventtime
214		544
215	Called whenever a selection has been made by the user, but before the	545	Called whenever a selection has been made by the user, but before the
216	selection text is copied, so changes to the beginning, end or type of the	546	selection text is copied, so changes to the beginning, end or type of the
…		…
223		553
224	Called whenever a selection has been copied, but before the selection is	554	Called whenever a selection has been copied, but before the selection is
225	requested from the server. The selection text can be queried and changed	555	requested from the server. The selection text can be queried and changed
226	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
227		557
228	Returning a true value aborts selection grabbing. It will still be hilighted.	558	Returning a true value aborts selection grabbing. It will still be highlighted.
229		559
230	=item on_sel_extend $term	560	=item on_sel_extend $term
231		561
232	Called whenever the user tries to extend the selection (e.g. with a double	562	Called whenever the user tries to extend the selection (e.g. with a double
233	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
234	should extend the selection itelf and return true to suppress the built-in	564	should extend the selection itself and return true to suppress the built-in
235	processing.	565	processing. This can happen multiple times, as long as the callback
		566	returns true, it will be called on every further click by the user and is
		567	supposed to enlarge the selection more and more, if possible.
236		568
237	See the F<selection> example extension.	569	See the F<selection> example extension.
238		570
239	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
240		572
241	Called whenever the view offset changes, i..e the user or program	573	Called whenever the view offset changes, i.e. the user or program
242	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
243	show this many lines of scrollback.	575	show this many lines of scrollback.
244		576
245	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
246		578
…		…
250		582
251	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	583	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
252	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	584	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
253	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
254		586
255	=item on_osc_seq $term, $string	587	=item on_osc_seq $term, $op, $args, $resp
		588
		589	Called on every OSC sequence and can be used to suppress it or modify its
		590	behaviour. The default should be to return an empty list. A true value
		591	suppresses execution of the request completely. Make sure you don't get
		592	confused by recursive invocations when you output an OSC sequence within
		593	this callback.
		594
		595	C<on_osc_seq_perl> should be used for new behaviour.
		596
		597	=item on_osc_seq_perl $term, $args, $resp
256		598
257	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
258	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
259	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
260	string should start with the extension name and a colon, to distinguish	602	string should start with the extension name (sans -osc) and a semicolon,
261	it from commands for other extensions, and this might be enforced in the	603	to distinguish it from commands for other extensions, and this might be
262	future.	604	enforced in the future.
		605
		606	For example, C<overlay-osc> uses this:
		607
		608	sub on_osc_seq_perl {
		609	my ($self, $osc, $resp) = @_;
		610
		611	return unless $osc =~ s/^overlay;//;
		612
		613	... process remaining $osc string
		614	}
263		615
264	Be careful not ever to trust (in a security sense) the data you receive,	616	Be careful not ever to trust (in a security sense) the data you receive,
265	as its source can not easily be controleld (e-mail content, messages from	617	as its source can not easily be controlled (e-mail content, messages from
266	other users on the same system etc.).	618	other users on the same system etc.).
		619
		620	For responses, C<$resp> contains the end-of-args separator used by the
		621	sender.
267		622
268	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
269		624
270	Called whenever text is about to be output, with the text as argument. You	625	Called whenever text is about to be output, with the text as argument. You
271	can filter/change and output the text yourself by returning a true value	626	can filter/change and output the text yourself by returning a true value
…		…
276	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
277		632
278	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
279	suppress or filter tty input.	634	suppress or filter tty input.
280		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
281	=item on_line_update $term, $row	643	=item on_line_update $term, $row
282		644
283	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
284	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
285	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
292	later with the already-modified line (e.g. if unrelated parts change), so	654	later with the already-modified line (e.g. if unrelated parts change), so
293	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
294		656
295	=item on_refresh_begin $term	657	=item on_refresh_begin $term
296		658
297	Called just before the screen gets redrawn. Can be used for overlay	659	Called just before the screen gets redrawn. Can be used for overlay or
298	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
299	restoring them in refresh_end. The built-in overlay and selection display	661	restoring them in refresh_end. The built-in overlay and selection display
300	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
301		663
302	=item on_refresh_end $term	664	=item on_refresh_end $term
303		665
304	Called just after the screen gets redrawn. See C<on_refresh_begin>.	666	Called just after the screen gets redrawn. See C<on_refresh_begin>.
305		667
306	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
307		669
308	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
309	C<perl:string> action bound to it (see description of the B<keysym>	671	a C<perl:string> action bound to a key, see description of the B<keysym>
310	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
		673
		674	The event is simply the action string. This interface is assumed to change
		675	slightly in the future.
		676
		677	=item on_resize_all_windows $term, $new_width, $new_height
		678
		679	Called just after the new window size has been calculated, but before
		680	windows are actually being resized or hints are being set. If this hook
		681	returns TRUE, setting of the window hints is being skipped.
		682
		683	=item on_x_event $term, $event
		684
		685	Called on every X event received on the vt window (and possibly other
		686	windows). Should only be used as a last resort. Most event structure
		687	members are not passed.
		688
		689	=item on_root_event $term, $event
		690
		691	Like C<on_x_event>, but is called for events on the root window.
311		692
312	=item on_focus_in $term	693	=item on_focus_in $term
313		694
314	Called whenever the window gets the keyboard focus, before rxvt-unicode	695	Called whenever the window gets the keyboard focus, before rxvt-unicode
315	does focus in processing.	696	does focus in processing.
316		697
317	=item on_focus_out $term	698	=item on_focus_out $term
318		699
319	Called wheneever the window loses keyboard focus, before rxvt-unicode does	700	Called whenever the window loses keyboard focus, before rxvt-unicode does
320	focus out processing.	701	focus out processing.
321		702
		703	=item on_configure_notify $term, $event
		704
		705	=item on_property_notify $term, $event
		706
322	=item on_key_press $term, $event, $keysym, $octets	707	=item on_key_press $term, $event, $keysym, $octets
323		708
324	=item on_key_release $term, $event, $keysym	709	=item on_key_release $term, $event, $keysym
325		710
326	=item on_button_press $term, $event	711	=item on_button_press $term, $event
…		…
331		716
332	=item on_map_notify $term, $event	717	=item on_map_notify $term, $event
333		718
334	=item on_unmap_notify $term, $event	719	=item on_unmap_notify $term, $event
335		720
336	Called whenever the corresponding X event is received for the terminal If	721	Called whenever the corresponding X event is received for the terminal. If
337	the hook returns true, then the even will be ignored by rxvt-unicode.	722	the hook returns true, then the event will be ignored by rxvt-unicode.
338		723
339	The event is a hash with most values as named by Xlib (see the XEvent	724	The event is a hash with most values as named by Xlib (see the XEvent
340	manpage), with the additional members C<row> and C<col>, which are the row	725	manpage), with the additional members C<row> and C<col>, which are the
341	and column under the mouse cursor.	726	(real, not screen-based) row and column under the mouse cursor.
342		727
343	C<on_key_press> additionally receives the string rxvt-unicode would	728	C<on_key_press> additionally receives the string rxvt-unicode would
344	output, if any, in locale-specific encoding.	729	output, if any, in locale-specific encoding.
345		730
346	subwindow.	731	subwindow.
		732
		733	=item on_client_message $term, $event
		734
		735	=item on_wm_protocols $term, $event
		736
		737	=item on_wm_delete_window $term, $event
		738
		739	Called when various types of ClientMessage events are received (all with
		740	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		741
		742	=item on_bell $term
		743
		744	Called on receipt of a bell character.
347		745
348	=back	746	=back
349		747
350	=cut	748	=cut
351		749
…		…
357	use Scalar::Util ();	755	use Scalar::Util ();
358	use List::Util ();	756	use List::Util ();
359		757
360	our $VERSION = 1;	758	our $VERSION = 1;
361	our $TERM;	759	our $TERM;
		760	our @TERM_INIT;
		761	our @TERM_EXT;
362	our @HOOKNAME;	762	our @HOOKNAME;
363	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	763	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364	our %OPTION;	764	our %OPTION;
365		765
366	our $LIBDIR;	766	our $LIBDIR;
367	our $RESNAME;	767	our $RESNAME;
368	our $RESCLASS;	768	our $RESCLASS;
369	our $RXVTNAME;	769	our $RXVTNAME;
370		770
		771	our $NOCHAR = chr 0xffff;
		772
371	=head2 Variables in the C<urxvt> Package	773	=head2 Variables in the C<urxvt> Package
372		774
373	=over 4	775	=over 4
374		776
375	=item $urxvt::LIBDIR	777	=item $urxvt::LIBDIR
…		…
388	=item $urxvt::TERM	790	=item $urxvt::TERM
389		791
390	The current terminal. This variable stores the current C<urxvt::term>	792	The current terminal. This variable stores the current C<urxvt::term>
391	object, whenever a callback/hook is executing.	793	object, whenever a callback/hook is executing.
392		794
		795	=item @urxvt::TERM_INIT
		796
		797	All code references in this array will be called as methods of the next newly
		798	created C<urxvt::term> object (during the C<on_init> phase). The array
		799	gets cleared before the code references that were in it are being executed,
		800	so references can push themselves onto it again if they so desire.
		801
		802	This complements to the perl-eval command line option, but gets executed
		803	first.
		804
		805	=item @urxvt::TERM_EXT
		806
		807	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		808	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		809	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		810
393	=back	811	=back
394		812
395	=head2 Functions in the C<urxvt> Package	813	=head2 Functions in the C<urxvt> Package
396		814
397	=over 4	815	=over 4
398		816
399	=item urxvt::fatal $errormessage	817	=item urxvt::fatal $errormessage
400		818
401	Fatally aborts execution with the given error message. Avoid at all	819	Fatally aborts execution with the given error message (which should
402	costs! The only time this is acceptable is when the terminal process	820	include a trailing newline). Avoid at all costs! The only time this
403	starts up.	821	is acceptable (and useful) is in the init hook, where it prevents the
		822	terminal from starting up.
404		823
405	=item urxvt::warn $string	824	=item urxvt::warn $string
406		825
407	Calls C<rxvt_warn> with the given string which should not include a	826	Calls C<rxvt_warn> with the given string which should include a trailing
408	newline. The module also overwrites the C<warn> builtin with a function	827	newline. The module also overwrites the C<warn> builtin with a function
409	that calls this function.	828	that calls this function.
410		829
411	Using this function has the advantage that its output ends up in the	830	Using this function has the advantage that its output ends up in the
412	correct place, e.g. on stderr of the connecting urxvtc client.	831	correct place, e.g. on stderr of the connecting urxvtc client.
413		832
414	Messages have a size limit of 1023 bytes currently.	833	Messages have a size limit of 1023 bytes currently.
415		834
416	=item $is_safe = urxvt::safe	835	=item @terms = urxvt::termlist
417		836
418	Returns true when it is safe to do potentially unsafe things, such as	837	Returns all urxvt::term objects that exist in this process, regardless of
419	evaluating perl code specified by the user. This is true when urxvt was	838	whether they are started, being destroyed etc., so be careful. Only term
420	started setuid or setgid.	839	objects that have perl extensions attached will be returned (because there
		840	is no urxvt::term object associated with others).
421		841
422	=item $time = urxvt::NOW	842	=item $time = urxvt::NOW
423		843
424	Returns the "current time" (as per the event loop).	844	Returns the "current time" (as per the event loop).
425		845
426	=item urxvt::CurrentTime	846	=item urxvt::CurrentTime
427		847
428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	848	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	849	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430	Button4Mask, Button5Mask, AnyModifier	850	Button4Mask, Button5Mask, AnyModifier
		851
		852	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		853	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		854	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		855	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		856	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		857	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		858	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		859
		860	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		861	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		862	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		863	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		864	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		865	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		866	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431		867
432	Various constants for use in X calls and event processing.	868	Various constants for use in X calls and event processing.
433		869
434	=back	870	=back
435		871
…		…
452		888
453	=item $rend = urxvt::OVERLAY_RSTYLE	889	=item $rend = urxvt::OVERLAY_RSTYLE
454		890
455	Return the rendition mask used for overlays by default.	891	Return the rendition mask used for overlays by default.
456		892
457	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	893	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		894	urxvt::RS_RVid, urxvt::RS_Uline
458		895
459	Return the bit that enabled bold, italic, blink, reverse-video and	896	Return the bit that enabled bold, italic, blink, reverse-video and
460	underline, respectively. To enable such a style, just logically OR it into	897	underline, respectively. To enable such a style, just logically OR it into
461	the bitset.	898	the bitset.
462		899
…		…
468		905
469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	906	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
470		907
471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	908	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
472		909
		910	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		911
473	Replace the foreground/background colour in the rendition mask with the	912	Replace the foreground/background colour in the rendition mask with the
474	specified one.	913	specified one.
475		914
476	=item $value = urxvt::GET_CUSTOM $rend	915	=item $value = urxvt::GET_CUSTOM $rend
477		916
…		…
486	=back	925	=back
487		926
488	=cut	927	=cut
489		928
490	BEGIN {	929	BEGIN {
491	urxvt->bootstrap;
492
493	# overwrite perl's warn	930	# overwrite perl's warn
494	*CORE::GLOBAL::warn = sub {	931	*CORE::GLOBAL::warn = sub {
495	my $msg = join "", @_;	932	my $msg = join "", @_;
496	$msg .= "\n"	933	$msg .= "\n"
497	unless $msg =~ /\n$/;	934	unless $msg =~ /\n$/;
498	urxvt::warn ($msg);	935	urxvt::warn ($msg);
499	};	936	};
500
501	delete $ENV{IFS};
502	delete $ENV{CDPATH};
503	delete $ENV{BASH_ENV};
504	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
505	}	937	}
506		938
507	my @hook_count;	939	no warnings 'utf8';
		940
508	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	941	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
509		942
510	sub verbose {	943	sub verbose {
511	my ($level, $msg) = @_;	944	my ($level, $msg) = @_;
512	warn "$msg\n" if $level <= $verbosity;	945	warn "$msg\n" if $level <= $verbosity;
513	}	946	}
514		947
515	my $extension_pkg = "extension0000";
516	my %extension_pkg;	948	my %extension_pkg;
517		949
518	# load a single script into its own package, once only	950	# load a single script into its own package, once only
519	sub extension_package($) {	951	sub extension_package($) {
520	my ($path) = @_;	952	my ($path) = @_;
521		953
522	$extension_pkg{$path} ||= do {	954	$extension_pkg{$path} ||= do {
523	my $pkg = "urxvt::" . ($extension_pkg++);	955	$path =~ /([^\/\\]+)$/;
		956	my $pkg = $1;
		957	$pkg =~ s/[^[:word:]]/_/g;
		958	$pkg = "urxvt::ext::$pkg";
524		959
525	verbose 3, "loading extension '$path' into package '$pkg'";	960	verbose 3, "loading extension '$path' into package '$pkg'";
526		961
527	open my $fh, "<:raw", $path	962	open my $fh, "<:raw", $path
528	or die "$path: $!";	963	or die "$path: $!";
529		964
530	my $source = untaint	965	my $source =
531	"package $pkg; use strict; use utf8;\n"	966	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
532	. "use base urxvt::term::extension::;\n"
533	. "#line 1 \"$path\"\n{\n"	967	. "#line 1 \"$path\"\n{\n"
534	. (do { local $/; <$fh> })	968	. (do { local $/; <$fh> })
535	. "\n};\n1";	969	. "\n};\n1";
536		970
537	eval $source	971	eval $source
…		…
547	sub invoke {	981	sub invoke {
548	local $TERM = shift;	982	local $TERM = shift;
549	my $htype = shift;	983	my $htype = shift;
550		984
551	if ($htype == 0) { # INIT	985	if ($htype == 0) { # INIT
552	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	986	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
553		987
554	my %ext_arg;	988	my %ext_arg;
555		989
		990	{
		991	my @init = @TERM_INIT;
		992	@TERM_INIT = ();
		993	$_->($TERM) for @init;
		994	my @pkg = @TERM_EXT;
		995	@TERM_EXT = ();
		996	$TERM->register_package ($_) for @pkg;
		997	}
		998
556	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	999	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
557	if ($_ eq "default") {	1000	if ($_ eq "default") {
558	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	1001	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
559	} elsif (/^-(.*)$/) {	1002	} elsif (/^-(.*)$/) {
560	delete $ext_arg{$1};	1003	delete $ext_arg{$1};
561	} elsif (/^([^<]+)<(.*)>$/) {	1004	} elsif (/^([^<]+)<(.*)>$/) {
562	push @{ $ext_arg{$1} }, $2;	1005	push @{ $ext_arg{$1} }, $2;
563	} else {	1006	} else {
564	$ext_arg{$_} ||= [];	1007	$ext_arg{$_} ||= [];
565	}	1008	}
566	}	1009	}
567		1010
568	while (my ($ext, $argv) = each %ext_arg) {	1011	for my $ext (sort keys %ext_arg) {
569	my @files = grep -f $_, map "$_/$ext", @dirs;	1012	my @files = grep -f $_, map "$_/$ext", @dirs;
570		1013
571	if (@files) {	1014	if (@files) {
572	$TERM->register_package (extension_package $files[0], $argv);	1015	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
573	} else {	1016	} else {
574	warn "perl extension '$ext' not found in perl library search path\n";	1017	warn "perl extension '$ext' not found in perl library search path\n";
575	}	1018	}
576	}	1019	}
577		1020
…		…
583		1026
584	if (my $cb = $TERM->{_hook}[$htype]) {	1027	if (my $cb = $TERM->{_hook}[$htype]) {
585	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1028	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
586	if $verbosity >= 10;	1029	if $verbosity >= 10;
587		1030
588	keys %$cb;	1031	for my $pkg (keys %$cb) {
589
590	while (my ($pkg, $cb) = each %$cb) {
591	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1032	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
592	and last;	1033	$retval ||= $retval_;
593		1034
594	if ($@) {	1035	if ($@) {
595	$TERM->ungrab; # better to lose the grab than the session	1036	$TERM->ungrab; # better to lose the grab than the session
596	warn $@;	1037	warn $@;
597	}	1038	}
598	}	1039	}
		1040
		1041	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		1042	if $verbosity >= 11;
599	}	1043	}
600		1044
601	if ($htype == 1) { # DESTROY	1045	if ($htype == 1) { # DESTROY
602	if (my $hook = delete $TERM->{_hook}) {
603	for my $htype (0..$#$hook) {
604	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
605	or set_should_invoke $htype, 0;
606	}
607	}
608
609	# clear package objects	1046	# clear package objects
610	%$_ = () for values %{ $TERM->{_pkg} };	1047	%$_ = () for values %{ $TERM->{_pkg} };
611		1048
612	# clear package	1049	# clear package
613	%$TERM = ();	1050	%$TERM = ();
614	}	1051	}
615		1052
616	$retval	1053	$retval
		1054	}
		1055
		1056	sub SET_COLOR($$$) {
		1057	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1058	}
		1059
		1060	sub rend2mask {
		1061	no strict 'refs';
		1062	my ($str, $mask) = (@_, 0);
		1063	my %color = ( fg => undef, bg => undef );
		1064	my @failed;
		1065	for my $spec ( split /\s+/, $str ) {
		1066	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1067	$color{lc($1)} = $2;
		1068	} else {
		1069	my $neg = $spec =~ s/^[-^]//;
		1070	unless ( exists &{"RS_$spec"} ) {
		1071	push @failed, $spec;
		1072	next;
		1073	}
		1074	my $cur = &{"RS_$spec"};
		1075	if ( $neg ) {
		1076	$mask &= ~$cur;
		1077	} else {
		1078	$mask |= $cur;
		1079	}
		1080	}
		1081	}
		1082	($mask, @color{qw(fg bg)}, \@failed)
617	}	1083	}
618		1084
619	# urxvt::term::extension	1085	# urxvt::term::extension
620		1086
621	package urxvt::term::extension;	1087	package urxvt::term::extension;
…		…
627	while (my ($name, $cb) = each %hook) {	1093	while (my ($name, $cb) = each %hook) {
628	my $htype = $HOOKTYPE{uc $name};	1094	my $htype = $HOOKTYPE{uc $name};
629	defined $htype	1095	defined $htype
630	or Carp::croak "unsupported hook type '$name'";	1096	or Carp::croak "unsupported hook type '$name'";
631		1097
		1098	$self->set_should_invoke ($htype, +1)
632	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1099	unless exists $self->{term}{_hook}[$htype]{$pkg};
633	$hook_count[$htype]++
634	or urxvt::set_should_invoke $htype, 1;
635	}
636		1100
637	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1101	$self->{term}{_hook}[$htype]{$pkg} = $cb;
638	}	1102	}
639	}	1103	}
640		1104
…		…
645	for my $name (@hook) {	1109	for my $name (@hook) {
646	my $htype = $HOOKTYPE{uc $name};	1110	my $htype = $HOOKTYPE{uc $name};
647	defined $htype	1111	defined $htype
648	or Carp::croak "unsupported hook type '$name'";	1112	or Carp::croak "unsupported hook type '$name'";
649		1113
		1114	$self->set_should_invoke ($htype, -1)
650	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1115	if delete $self->{term}{_hook}[$htype]{$pkg};
651	--$hook_count[$htype]
652	or urxvt::set_should_invoke $htype, 0;
653	}
654	}	1116	}
655	}	1117	}
656		1118
657	our $AUTOLOAD;	1119	our $AUTOLOAD;
658		1120
…		…
696	is that you cannot use blocking APIs, but the non-blocking variant should	1158	is that you cannot use blocking APIs, but the non-blocking variant should
697	work.	1159	work.
698		1160
699	=cut	1161	=cut
700		1162
701	our $VERSION = 1;	1163	our $VERSION = '5.23';
702		1164
703	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1165	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
704	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1166	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
705		1167
706	sub timer {	1168	sub timer {
…		…
708		1170
709	my $cb = $arg{cb};	1171	my $cb = $arg{cb};
710		1172
711	urxvt::timer	1173	urxvt::timer
712	->new	1174	->new
713	->start (urxvt::NOW + $arg{after})	1175	->after ($arg{after}, $arg{interval})
714	->cb (sub {	1176	->cb ($arg{interval} ? $cb : sub {
715	$_[0]->stop; # need to cancel manually	1177	$_[0]->stop; # need to cancel manually
716	$cb->();	1178	$cb->();
717	})	1179	})
718	}	1180	}
719		1181
720	sub io {	1182	sub io {
721	my ($class, %arg) = @_;	1183	my ($class, %arg) = @_;
722		1184
723	my $cb = $arg{cb};	1185	my $cb = $arg{cb};
		1186	my $fd = fileno $arg{fh};
		1187	defined $fd or $fd = $arg{fh};
724		1188
725	bless [$arg{fh}, urxvt::iow	1189	bless [$arg{fh}, urxvt::iow
726	->new	1190	->new
727	->fd (fileno $arg{fh})	1191	->fd ($fd)
728	->events (($arg{poll} =~ /r/ ? 1 : 0)	1192	->events (($arg{poll} =~ /r/ ? 1 : 0)
729	| ($arg{poll} =~ /w/ ? 2 : 0))	1193	| ($arg{poll} =~ /w/ ? 2 : 0))
730	->start	1194	->start
731	->cb (sub {	1195	->cb ($cb)
732	$cb->(($_[1] & 1 ? 'r' : '')
733	. ($_[1] & 2 ? 'w' : ''));
734	})],
735	urxvt::anyevent::	1196	], urxvt::anyevent::
		1197	}
		1198
		1199	sub idle {
		1200	my ($class, %arg) = @_;
		1201
		1202	my $cb = $arg{cb};
		1203
		1204	urxvt::iw
		1205	->new
		1206	->start
		1207	->cb ($cb)
		1208	}
		1209
		1210	sub child {
		1211	my ($class, %arg) = @_;
		1212
		1213	my $cb = $arg{cb};
		1214
		1215	urxvt::pw
		1216	->new
		1217	->start ($arg{pid})
		1218	->cb (sub {
		1219	$_[0]->stop; # need to cancel manually
		1220	$cb->($_[0]->rpid, $_[0]->rstatus);
		1221	})
736	}	1222	}
737		1223
738	sub DESTROY {	1224	sub DESTROY {
739	$_[0][1]->stop;	1225	$_[0][1]->stop;
740	}	1226	}
741		1227
742	sub condvar {	1228	# only needed for AnyEvent < 6 compatibility
743	bless \my $flag, urxvt::anyevent::condvar::	1229	sub one_event {
744	}
745
746	sub urxvt::anyevent::condvar::broadcast {
747	${$_[0]}++;
748	}
749
750	sub urxvt::anyevent::condvar::wait {
751	unless (${$_[0]}) {
752	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1230	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
753	}
754	}	1231	}
755		1232
756	package urxvt::term;	1233	package urxvt::term;
757		1234
758	=head2 The C<urxvt::term> Class	1235	=head2 The C<urxvt::term> Class
…		…
763		1240
764	# find on_xxx subs in the package and register them	1241	# find on_xxx subs in the package and register them
765	# as hooks	1242	# as hooks
766	sub register_package {	1243	sub register_package {
767	my ($self, $pkg, $argv) = @_;	1244	my ($self, $pkg, $argv) = @_;
		1245
		1246	no strict 'refs';
		1247
		1248	urxvt::verbose 6, "register package $pkg to $self";
		1249
		1250	@{"$pkg\::ISA"} = urxvt::term::extension::;
768		1251
769	my $proxy = bless {	1252	my $proxy = bless {
770	_pkg => $pkg,	1253	_pkg => $pkg,
771	argv => $argv,	1254	argv => $argv,
772	}, $pkg;	1255	}, $pkg;
…		…
788	hash which defines the environment of the new terminal.	1271	hash which defines the environment of the new terminal.
789		1272
790	Croaks (and probably outputs an error message) if the new instance	1273	Croaks (and probably outputs an error message) if the new instance
791	couldn't be created. Returns C<undef> if the new instance didn't	1274	couldn't be created. Returns C<undef> if the new instance didn't
792	initialise perl, and the terminal object otherwise. The C<init> and	1275	initialise perl, and the terminal object otherwise. The C<init> and
793	C<start> hooks will be called during this call.	1276	C<start> hooks will be called before this call returns, and are free to
		1277	refer to global data (which is race free).
794		1278
795	=cut	1279	=cut
796		1280
797	sub new {	1281	sub new {
798	my ($class, $env, @args) = @_;	1282	my ($class, $env, @args) = @_;
799		1283
		1284	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1285	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1286
800	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1287	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
801	}	1288	}
802		1289
803	=item $term->destroy	1290	=item $term->destroy
804		1291
805	Destroy the terminal object (close the window, free resources	1292	Destroy the terminal object (close the window, free resources
806	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1293	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
807	watchers (timers, io watchers) are still active.	1294	watchers (timers, io watchers) are still active.
808		1295
		1296	=item $term->exec_async ($cmd[, @args])
		1297
		1298	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1299	("starts") programs in the background. This function takes care of setting
		1300	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1301	be preferred over explicit calls to C<exec> or C<system>.
		1302
		1303	Returns the pid of the subprocess or C<undef> on error.
		1304
		1305	=cut
		1306
		1307	sub exec_async {
		1308	my $self = shift;
		1309
		1310	my $pid = fork;
		1311
		1312	return $pid
		1313	if !defined $pid or $pid;
		1314
		1315	%ENV = %{ $self->env };
		1316
		1317	exec @_;
		1318	urxvt::_exit 255;
		1319	}
		1320
809	=item $isset = $term->option ($optval[, $set])	1321	=item $isset = $term->option ($optval[, $set])
810		1322
811	Returns true if the option specified by C<$optval> is enabled, and	1323	Returns true if the option specified by C<$optval> is enabled, and
812	optionally change it. All option values are stored by name in the hash	1324	optionally change it. All option values are stored by name in the hash
813	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1325	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
814		1326
815	Here is a a likely non-exhaustive list of option names, please see the	1327	Here is a likely non-exhaustive list of option names, please see the
816	source file F</src/optinc.h> to see the actual list:	1328	source file F</src/optinc.h> to see the actual list:
817		1329
818	borderLess console cursorBlink cursorUnderline hold iconic insecure	1330	borderLess buffered console cursorBlink cursorUnderline hold iconic
819	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1331	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1332	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
820	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1333	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
821	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1334	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
822	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1335	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
823	tripleclickwords utmpInhibit visualBell	1336	urgentOnBell utmpInhibit visualBell
824		1337
825	=item $value = $term->resource ($name[, $newval])	1338	=item $value = $term->resource ($name[, $newval])
826		1339
827	Returns the current resource value associated with a given name and	1340	Returns the current resource value associated with a given name and
828	optionally sets a new value. Setting values is most useful in the C<init>	1341	optionally sets a new value. Setting values is most useful in the C<init>
…		…
837	likely change).	1350	likely change).
838		1351
839	Please note that resource strings will currently only be freed when the	1352	Please note that resource strings will currently only be freed when the
840	terminal is destroyed, so changing options frequently will eat memory.	1353	terminal is destroyed, so changing options frequently will eat memory.
841		1354
842	Here is a a likely non-exhaustive list of resource names, not all of which	1355	Here is a likely non-exhaustive list of resource names, not all of which
843	are supported in every build, please see the source file F</src/rsinc.h>	1356	are supported in every build, please see the source file F</src/rsinc.h>
844	to see the actual list:	1357	to see the actual list:
845		1358
846	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1359	answerbackstring backgroundPixmap backspace_key blendtype blurradius
847	borderLess color cursorBlink cursorUnderline cutchars delete_key	1360	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
848	display_name embed ext_bwidth fade font geometry hold iconName	1361	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
849	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1362	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1363	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
850	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1364	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
851	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1365	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
852	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1366	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
853	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1367	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
854	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1368	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
855	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1369	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
856	shade term_name title transparent transparent_all tripleclickwords	1370	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1371	term_name title transient_for transparent tripleclickwords urgentOnBell
857	utmpInhibit visualBell	1372	utmpInhibit visualBell
858		1373
859	=cut	1374	=cut
860		1375
861	sub resource($$;$) {	1376	sub resource($$;$) {
862	my ($self, $name) = (shift, shift);	1377	my ($self, $name) = (shift, shift);
863	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1378	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
864	&urxvt::term::_resource	1379	goto &urxvt::term::_resource
865	}	1380	}
866		1381
867	=item $value = $term->x_resource ($pattern)	1382	=item $value = $term->x_resource ($pattern)
868		1383
869	Returns the X-Resource for the given pattern, excluding the program or	1384	Returns the X-Resource for the given pattern, excluding the program or
…		…
873		1388
874	This method should only be called during the C<on_start> hook, as there is	1389	This method should only be called during the C<on_start> hook, as there is
875	only one resource database per display, and later invocations might return	1390	only one resource database per display, and later invocations might return
876	the wrong resources.	1391	the wrong resources.
877		1392
878	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1393	=item $success = $term->parse_keysym ($key, $octets)
879		1394
880	Adds a keymap translation exactly as specified via a resource. See the	1395	Adds a key binding exactly as specified via a resource. See the
881	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1396	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
882		1397
883	=item $rend = $term->rstyle ([$new_rstyle])	1398	=item $rend = $term->rstyle ([$new_rstyle])
884		1399
885	Return and optionally change the current rendition. Text that is output by	1400	Return and optionally change the current rendition. Text that is output by
…		…
894		1409
895	=item ($row, $col) = $term->selection_beg ([$row, $col])	1410	=item ($row, $col) = $term->selection_beg ([$row, $col])
896		1411
897	=item ($row, $col) = $term->selection_end ([$row, $col])	1412	=item ($row, $col) = $term->selection_end ([$row, $col])
898		1413
899	Return the current values of the selection mark, begin or end positions,	1414	Return the current values of the selection mark, begin or end positions.
900	and optionally set them to new values.
901		1415
		1416	When arguments are given, then the selection coordinates are set to
		1417	C<$row> and C<$col>, and the selection screen is set to the current
		1418	screen.
		1419
		1420	=item $screen = $term->selection_screen ([$screen])
		1421
		1422	Returns the current selection screen, and then optionally sets it.
		1423
		1424	=item $term->selection_make ($eventtime[, $rectangular])
		1425
		1426	Tries to make a selection as set by C<selection_beg> and
		1427	C<selection_end>. If C<$rectangular> is true (default: false), a
		1428	rectangular selection will be made. This is the preferred function to make
		1429	a selection.
		1430
902	=item $success = $term->selection_grab ($eventtime)	1431	=item $success = $term->selection_grab ($eventtime[, $clipboard])
903		1432
904	Try to request the primary selection from the server (for example, as set	1433	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
905	by the next method).	1434	true) selection from the server. The corresponding text can be set
		1435	with the next method. No visual feedback will be given. This function
		1436	is mostly useful from within C<on_sel_grab> hooks.
906		1437
907	=item $oldtext = $term->selection ([$newtext])	1438	=item $oldtext = $term->selection ([$newtext, $clipboard])
908		1439
909	Return the current selection text and optionally replace it by C<$newtext>.	1440	Return the current selection (clipboard if C<$clipboard> is true) text
		1441	and optionally replace it by C<$newtext>.
		1442
		1443	=item $term->selection_clear ([$clipboard])
		1444
		1445	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
910		1446
911	=item $term->overlay_simple ($x, $y, $text)	1447	=item $term->overlay_simple ($x, $y, $text)
912		1448
913	Create a simple multi-line overlay box. See the next method for details.	1449	Create a simple multi-line overlay box. See the next method for details.
914		1450
…		…
944		1480
945	The methods currently supported on C<urxvt::overlay> objects are:	1481	The methods currently supported on C<urxvt::overlay> objects are:
946		1482
947	=over 4	1483	=over 4
948		1484
949	=item $overlay->set ($x, $y, $text, $rend)	1485	=item $overlay->set ($x, $y, $text[, $rend])
950		1486
951	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1487	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
952	text in rxvt-unicode's special encoding and an array of rendition values	1488	text in rxvt-unicode's special encoding and an array of rendition values
953	at a specific position inside the overlay.	1489	at a specific position inside the overlay.
		1490
		1491	If C<$rend> is missing, then the rendition will not be changed.
954		1492
955	=item $overlay->hide	1493	=item $overlay->hide
956		1494
957	If visible, hide the overlay, but do not destroy it.	1495	If visible, hide the overlay, but do not destroy it.
958		1496
…		…
1003	Convert the given locale-encoded octets into a perl string.	1541	Convert the given locale-encoded octets into a perl string.
1004		1542
1005	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1543	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1006		1544
1007	XORs the rendition values in the given span with the provided value	1545	XORs the rendition values in the given span with the provided value
1008	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1546	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1009	to the selection.	1547	refresh hooks to provide effects similar to the selection.
1010		1548
1011	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1549	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1012		1550
1013	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1551	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1014	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1552	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1015	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1553	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1016	it instead.	1554	it instead. Both styles I<MUST NOT> contain font styles.
1017		1555
1018	=item $term->scr_bell	1556	=item $term->scr_bell
1019		1557
1020	Ring the bell!	1558	Ring the bell!
1021		1559
…		…
1028		1566
1029	Normally its not a good idea to use this function, as programs might be	1567	Normally its not a good idea to use this function, as programs might be
1030	confused by changes in cursor position or scrolling. Its useful inside a	1568	confused by changes in cursor position or scrolling. Its useful inside a
1031	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1032		1570
		1571	=item $term->scr_change_screen ($screen)
		1572
		1573	Switch to given screen - 0 primary, 1 secondary.
		1574
1033	=item $term->cmd_parse ($octets)	1575	=item $term->cmd_parse ($octets)
1034		1576
1035	Similar to C<scr_add_lines>, but the argument must be in the	1577	Similar to C<scr_add_lines>, but the argument must be in the
1036	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1037	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1038		1580
1039	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1040		1582
1041	Write the octets given in C<$data> to the tty (i.e. as program input). To	1583	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1042	pass characters instead of octets, you should convert your strings first	1584	pass characters instead of octets, you should convert your strings first
1043	to the locale-specific encoding using C<< $term->locale_encode >>.	1585	to the locale-specific encoding using C<< $term->locale_encode >>.
		1586
		1587	=item $term->tt_paste ($octets)
		1588
		1589	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1590	CR and bracketing the data with control sequences if bracketed paste mode
		1591	is set.
1044		1592
1045	=item $old_events = $term->pty_ev_events ([$new_events])	1593	=item $old_events = $term->pty_ev_events ([$new_events])
1046		1594
1047	Replaces the event mask of the pty watcher by the given event mask. Can	1595	Replaces the event mask of the pty watcher by the given event mask. Can
1048	be used to suppress input and output handling to the pty/tty. See the	1596	be used to suppress input and output handling to the pty/tty. See the
1049	description of C<< urxvt::timer->events >>. Make sure to always restore	1597	description of C<< urxvt::timer->events >>. Make sure to always restore
1050	the previous value.	1598	the previous value.
1051		1599
		1600	=item $fd = $term->pty_fd
		1601
		1602	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1603	is used.
		1604
1052	=item $windowid = $term->parent	1605	=item $windowid = $term->parent
1053		1606
1054	Return the window id of the toplevel window.	1607	Return the window id of the toplevel window.
1055		1608
1056	=item $windowid = $term->vt	1609	=item $windowid = $term->vt
1057		1610
1058	Return the window id of the terminal window.	1611	Return the window id of the terminal window.
1059		1612
		1613	=item $term->vt_emask_add ($x_event_mask)
		1614
		1615	Adds the specified events to the vt event mask. Useful e.g. when you want
		1616	to receive pointer events all the times:
		1617
		1618	$term->vt_emask_add (urxvt::PointerMotionMask);
		1619
		1620	=item $term->focus_in
		1621
		1622	=item $term->focus_out
		1623
		1624	=item $term->key_press ($state, $keycode[, $time])
		1625
		1626	=item $term->key_release ($state, $keycode[, $time])
		1627
		1628	Deliver various fake events to to terminal.
		1629
1060	=item $window_width = $term->width	1630	=item $window_width = $term->width
1061		1631
1062	=item $window_height = $term->height	1632	=item $window_height = $term->height
1063		1633
1064	=item $font_width = $term->fwidth	1634	=item $font_width = $term->fwidth
…		…
1077		1647
1078	=item $max_scrollback = $term->saveLines	1648	=item $max_scrollback = $term->saveLines
1079		1649
1080	=item $nrow_plus_saveLines = $term->total_rows	1650	=item $nrow_plus_saveLines = $term->total_rows
1081		1651
1082	=item $lines_in_scrollback = $term->nsaved	1652	=item $topmost_scrollback_row = $term->top_row
1083		1653
1084	Return various integers describing terminal characteristics.	1654	Return various integers describing terminal characteristics.
1085		1655
1086	=item $x_display = $term->display_id	1656	=item $x_display = $term->display_id
1087		1657
…		…
1094	=item $env = $term->env	1664	=item $env = $term->env
1095		1665
1096	Returns a copy of the environment in effect for the terminal as a hashref	1666	Returns a copy of the environment in effect for the terminal as a hashref
1097	similar to C<\%ENV>.	1667	similar to C<\%ENV>.
1098		1668
		1669	=item @envv = $term->envv
		1670
		1671	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1672
		1673	=item @argv = $term->argv
		1674
		1675	Return the argument vector as this terminal, similar to @ARGV, but
		1676	includes the program name as first element.
		1677
1099	=cut	1678	=cut
1100		1679
1101	sub env {	1680	sub env {
1102	if (my $env = $_[0]->_env) {
1103	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1681	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1104	} else {
1105	+{ %ENV }
1106	}
1107	}	1682	}
1108		1683
1109	=item $modifiermask = $term->ModLevel3Mask	1684	=item $modifiermask = $term->ModLevel3Mask
1110		1685
1111	=item $modifiermask = $term->ModMetaMask	1686	=item $modifiermask = $term->ModMetaMask
…		…
1113	=item $modifiermask = $term->ModNumLockMask	1688	=item $modifiermask = $term->ModNumLockMask
1114		1689
1115	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1690	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1116	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1691	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1117		1692
		1693	=item $screen = $term->current_screen
		1694
		1695	Returns the currently displayed screen (0 primary, 1 secondary).
		1696
		1697	=item $cursor_is_hidden = $term->hidden_cursor
		1698
		1699	Returns whether the cursor is currently hidden or not.
		1700
1118	=item $view_start = $term->view_start ([$newvalue])	1701	=item $view_start = $term->view_start ([$newvalue])
1119		1702
1120	Returns the negative row number of the topmost line. Minimum value is	1703	Returns the row number of the topmost displayed line. Maximum value is
1121	C<0>, which displays the normal terminal contents. Larger values scroll	1704	C<0>, which displays the normal terminal contents. Lower values scroll
1122	this many lines into the scrollback buffer.	1705	this many lines into the scrollback buffer.
1123		1706
1124	=item $term->want_refresh	1707	=item $term->want_refresh
1125		1708
1126	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1709	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1129		1712
1130	Used after changing terminal contents to display them.	1713	Used after changing terminal contents to display them.
1131		1714
1132	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1715	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1133		1716
1134	Returns the text of the entire row with number C<$row_number>. Row C<0>	1717	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1135	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1718	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1136	terminal line. The scrollback buffer starts at line C<-1> and extends to
1137	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1719	terminal line. Nothing will be returned if a nonexistent line
1138	is requested.	1720	is requested.
1139		1721
1140	If C<$new_text> is specified, it will replace characters in the current	1722	If C<$new_text> is specified, it will replace characters in the current
1141	line, starting at column C<$start_col> (default C<0>), which is useful	1723	line, starting at column C<$start_col> (default C<0>), which is useful
1142	to replace only parts of a line. The font index in the rendition will	1724	to replace only parts of a line. The font index in the rendition will
1143	automatically be updated.	1725	automatically be updated.
1144		1726
1145	C<$text> is in a special encoding: tabs and wide characters that use more	1727	C<$text> is in a special encoding: tabs and wide characters that use more
1146	than one cell when displayed are padded with urxvt::NOCHAR characters	1728	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1147	(C<chr 65535>). Characters with combining characters and other characters	1729	characters. Characters with combining characters and other characters that
1148	that do not fit into the normal tetx encoding will be replaced with	1730	do not fit into the normal text encoding will be replaced with characters
1149	characters in the private use area.	1731	in the private use area.
1150		1732
1151	You have to obey this encoding when changing text. The advantage is	1733	You have to obey this encoding when changing text. The advantage is
1152	that C<substr> and similar functions work on screen cells and not on	1734	that C<substr> and similar functions work on screen cells and not on
1153	characters.	1735	characters.
1154		1736
…		…
1205	Return the row number of the first/last row of the line, respectively.	1787	Return the row number of the first/last row of the line, respectively.
1206		1788
1207	=item $offset = $line->offset_of ($row, $col)	1789	=item $offset = $line->offset_of ($row, $col)
1208		1790
1209	Returns the character offset of the given row|col pair within the logical	1791	Returns the character offset of the given row|col pair within the logical
1210	line.	1792	line. Works for rows outside the line, too, and returns corresponding
		1793	offsets outside the string.
1211		1794
1212	=item ($row, $col) = $line->coord_of ($offset)	1795	=item ($row, $col) = $line->coord_of ($offset)
1213		1796
1214	Translates a string offset into terminal coordinates again.	1797	Translates a string offset into terminal coordinates again.
1215		1798
…		…
1297	where one character corresponds to one screen cell. See	1880	where one character corresponds to one screen cell. See
1298	C<< $term->ROW_t >> for details.	1881	C<< $term->ROW_t >> for details.
1299		1882
1300	=item $string = $term->special_decode $text	1883	=item $string = $term->special_decode $text
1301		1884
1302	Converts rxvt-unicodes text reprsentation into a perl string. See	1885	Converts rxvt-unicodes text representation into a perl string. See
1303	C<< $term->ROW_t >> for details.	1886	C<< $term->ROW_t >> for details.
1304		1887
1305	=item $success = $term->grab_button ($button, $modifiermask)	1888	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1306		1889
		1890	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1891
1307	Registers a synchronous button grab. See the XGrabButton manpage.	1892	Register/unregister a synchronous button grab. See the XGrabButton
		1893	manpage.
1308		1894
1309	=item $success = $term->grab ($eventtime[, $sync])	1895	=item $success = $term->grab ($eventtime[, $sync])
1310		1896
1311	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1897	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1312	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1898	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1313		1899
1314	=item $term->allow_events_async	1900	=item $term->allow_events_async
1315		1901
1316	Calls XAllowEvents with AsyncBoth for the most recent grab.	1902	Calls XAllowEvents with AsyncBoth for the most recent grab.
1317		1903
…		…
1324	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1910	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1325	recent grab.	1911	recent grab.
1326		1912
1327	=item $term->ungrab	1913	=item $term->ungrab
1328		1914
1329	Calls XUngrab for the most recent grab. Is called automatically on	1915	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1330	evaluation errors, as it is better to lose the grab in the error case as	1916	evaluation errors, as it is better to lose the grab in the error case as
1331	the session.	1917	the session.
		1918
		1919	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1920
		1921	=item $atom_name = $term->XGetAtomName ($atom)
		1922
		1923	=item @atoms = $term->XListProperties ($window)
		1924
		1925	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1926
		1927	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1928
		1929	=item $term->XDeleteProperty ($window, $property)
		1930
		1931	=item $window = $term->DefaultRootWindow
		1932
		1933	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1934
		1935	=item $term->XMapWindow ($window)
		1936
		1937	=item $term->XUnmapWindow ($window)
		1938
		1939	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1940
		1941	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1942
		1943	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1944
		1945	=item $keysym = $term->XStringToKeysym ($string)
		1946
		1947	=item $string = $term->XKeysymToString ($keysym)
		1948
		1949	Various X or X-related functions. The C<$term> object only serves as
		1950	the source of the display, otherwise those functions map more-or-less
		1951	directly onto the X functions of the same name.
1332		1952
1333	=back	1953	=back
1334		1954
1335	=cut	1955	=cut
1336		1956
…		…
1400	my ($self, $text, $cb) = @_;	2020	my ($self, $text, $cb) = @_;
1401		2021
1402	$self->add_item ({ type => "button", text => $text, activate => $cb});	2022	$self->add_item ({ type => "button", text => $text, activate => $cb});
1403	}	2023	}
1404		2024
1405	=item $popup->add_toggle ($text, $cb, $initial_value)	2025	=item $popup->add_toggle ($text, $initial_value, $cb)
1406		2026
1407	Adds a toggle/checkbox item to the popup. Teh callback gets called	2027	Adds a toggle/checkbox item to the popup. The callback gets called
1408	whenever it gets toggled, with a boolean indicating its value as its first	2028	whenever it gets toggled, with a boolean indicating its new value as its
1409	argument.	2029	first argument.
1410		2030
1411	=cut	2031	=cut
1412		2032
1413	sub add_toggle {	2033	sub add_toggle {
1414	my ($self, $text, $cb, $value) = @_;	2034	my ($self, $text, $value, $cb) = @_;
1415		2035
1416	my $item; $item = {	2036	my $item; $item = {
1417	type => "button",	2037	type => "button",
1418	text => " $text",	2038	text => " $text",
1419	value => $value,	2039	value => $value,
…		…
1438	my $env = $self->{term}->env;	2058	my $env = $self->{term}->env;
1439	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2059	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1440	delete $env->{LC_ALL};	2060	delete $env->{LC_ALL};
1441	$env->{LC_CTYPE} = $self->{term}->locale;	2061	$env->{LC_CTYPE} = $self->{term}->locale;
1442		2062
1443	urxvt::term->new ($env, $self->{term}->resource ("name"),	2063	my $term = urxvt::term->new (
1444	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2064	$env, "popup",
		2065	"--perl-lib" => "", "--perl-ext-common" => "",
		2066	"-pty-fd" => -1, "-sl" => 0,
		2067	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1445	"--transient-for" => $self->{term}->parent,	2068	"--transient-for" => $self->{term}->parent,
1446	"-display" => $self->{term}->display_id,	2069	"-display" => $self->{term}->display_id,
1447	"-pe" => "urxvt-popup")	2070	"-pe" => "urxvt-popup",
1448	or die "unable to create popup window\n";	2071	) or die "unable to create popup window\n";
		2072
		2073	unless (delete $term->{urxvt_popup_init_done}) {
		2074	$term->ungrab;
		2075	$term->destroy;
		2076	die "unable to initialise popup window\n";
		2077	}
1449	}	2078	}
1450		2079
1451	sub DESTROY {	2080	sub DESTROY {
1452	my ($self) = @_;	2081	my ($self) = @_;
1453		2082
1454	delete $self->{term}{_destroy}{$self};	2083	delete $self->{term}{_destroy}{$self};
1455	$self->{term}->ungrab;	2084	$self->{term}->ungrab;
1456	}	2085	}
1457		2086
1458	=back	2087	=back
		2088
		2089	=cut
		2090
		2091	package urxvt::watcher;
1459		2092
1460	=head2 The C<urxvt::timer> Class	2093	=head2 The C<urxvt::timer> Class
1461		2094
1462	This class implements timer watchers/events. Time is represented as a	2095	This class implements timer watchers/events. Time is represented as a
1463	fractional number of seconds since the epoch. Example:	2096	fractional number of seconds since the epoch. Example:
…		…
1467	->new	2100	->new
1468	->interval (1)	2101	->interval (1)
1469	->cb (sub {	2102	->cb (sub {
1470	$term->{overlay}->set (0, 0,	2103	$term->{overlay}->set (0, 0,
1471	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2104	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1472	});	2105	});
1473		2106
1474	=over 4	2107	=over 4
1475		2108
1476	=item $timer = new urxvt::timer	2109	=item $timer = new urxvt::timer
1477		2110
…		…
1480		2113
1481	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2114	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1482		2115
1483	Set the callback to be called when the timer triggers.	2116	Set the callback to be called when the timer triggers.
1484		2117
1485	=item $tstamp = $timer->at
1486
1487	Return the time this watcher will fire next.
1488
1489	=item $timer = $timer->set ($tstamp)	2118	=item $timer = $timer->set ($tstamp[, $interval])
1490		2119
1491	Set the time the event is generated to $tstamp.	2120	Set the time the event is generated to $tstamp (and optionally specifies a
		2121	new $interval).
1492		2122
1493	=item $timer = $timer->interval ($interval)	2123	=item $timer = $timer->interval ($interval)
1494		2124
1495	Normally (and when C<$interval> is C<0>), the timer will automatically	2125	By default (and when C<$interval> is C<0>), the timer will automatically
1496	stop after it has fired once. If C<$interval> is non-zero, then the timer	2126	stop after it has fired once. If C<$interval> is non-zero, then the timer
1497	is automatically rescheduled at the given intervals.	2127	is automatically rescheduled at the given intervals.
1498		2128
1499	=item $timer = $timer->start	2129	=item $timer = $timer->start
1500		2130
1501	Start the timer.	2131	Start the timer.
1502		2132
1503	=item $timer = $timer->start ($tstamp)	2133	=item $timer = $timer->start ($tstamp[, $interval])
1504		2134
1505	Set the event trigger time to C<$tstamp> and start the timer.	2135	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2136	also replaces the interval.
		2137
		2138	=item $timer = $timer->after ($delay[, $interval])
		2139
		2140	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1506		2141
1507	=item $timer = $timer->stop	2142	=item $timer = $timer->stop
1508		2143
1509	Stop the timer.	2144	Stop the timer.
1510		2145
…		…
1516		2151
1517	$term->{socket} = ...	2152	$term->{socket} = ...
1518	$term->{iow} = urxvt::iow	2153	$term->{iow} = urxvt::iow
1519	->new	2154	->new
1520	->fd (fileno $term->{socket})	2155	->fd (fileno $term->{socket})
1521	->events (urxvt::EVENT_READ)	2156	->events (urxvt::EV_READ)
1522	->start	2157	->start
1523	->cb (sub {	2158	->cb (sub {
1524	my ($iow, $revents) = @_;	2159	my ($iow, $revents) = @_;
1525	# $revents must be 1 here, no need to check	2160	# $revents must be 1 here, no need to check
1526	sysread $term->{socket}, my $buf, 8192	2161	sysread $term->{socket}, my $buf, 8192
…		…
1539	Set the callback to be called when io events are triggered. C<$reventmask>	2174	Set the callback to be called when io events are triggered. C<$reventmask>
1540	is a bitset as described in the C<events> method.	2175	is a bitset as described in the C<events> method.
1541		2176
1542	=item $iow = $iow->fd ($fd)	2177	=item $iow = $iow->fd ($fd)
1543		2178
1544	Set the filedescriptor (not handle) to watch.	2179	Set the file descriptor (not handle) to watch.
1545		2180
1546	=item $iow = $iow->events ($eventmask)	2181	=item $iow = $iow->events ($eventmask)
1547		2182
1548	Set the event mask to watch. The only allowed values are	2183	Set the event mask to watch. The only allowed values are
1549	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2184	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1550	together, or C<urxvt::EVENT_NONE>.	2185	together, or C<urxvt::EV_NONE>.
1551		2186
1552	=item $iow = $iow->start	2187	=item $iow = $iow->start
1553		2188
1554	Start watching for requested events on the given handle.	2189	Start watching for requested events on the given handle.
1555		2190
1556	=item $iow = $iow->stop	2191	=item $iow = $iow->stop
1557		2192
1558	Stop watching for events on the given filehandle.	2193	Stop watching for events on the given file handle.
		2194
		2195	=back
		2196
		2197	=head2 The C<urxvt::iw> Class
		2198
		2199	This class implements idle watchers, that get called automatically when
		2200	the process is idle. They should return as fast as possible, after doing
		2201	some useful work.
		2202
		2203	=over 4
		2204
		2205	=item $iw = new urxvt::iw
		2206
		2207	Create a new idle watcher object in stopped state.
		2208
		2209	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2210
		2211	Set the callback to be called when the watcher triggers.
		2212
		2213	=item $timer = $timer->start
		2214
		2215	Start the watcher.
		2216
		2217	=item $timer = $timer->stop
		2218
		2219	Stop the watcher.
		2220
		2221	=back
		2222
		2223	=head2 The C<urxvt::pw> Class
		2224
		2225	This class implements process watchers. They create an event whenever a
		2226	process exits, after which they stop automatically.
		2227
		2228	my $pid = fork;
		2229	...
		2230	$term->{pw} = urxvt::pw
		2231	->new
		2232	->start ($pid)
		2233	->cb (sub {
		2234	my ($pw, $exit_status) = @_;
		2235	...
		2236	});
		2237
		2238	=over 4
		2239
		2240	=item $pw = new urxvt::pw
		2241
		2242	Create a new process watcher in stopped state.
		2243
		2244	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2245
		2246	Set the callback to be called when the timer triggers.
		2247
		2248	=item $pw = $timer->start ($pid)
		2249
		2250	Tells the watcher to start watching for process C<$pid>.
		2251
		2252	=item $pw = $pw->stop
		2253
		2254	Stop the watcher.
1559		2255
1560	=back	2256	=back
1561		2257
1562	=head1 ENVIRONMENT	2258	=head1 ENVIRONMENT
1563		2259
…		…
1570		2266
1571	=item == 0 - fatal messages	2267	=item == 0 - fatal messages
1572		2268
1573	=item >= 3 - script loading and management	2269	=item >= 3 - script loading and management
1574		2270
1575	=item >=10 - all events received	2271	=item >=10 - all called hooks
		2272
		2273	=item >=11 - hook return values
1576		2274
1577	=back	2275	=back
1578		2276
1579	=head1 AUTHOR	2277	=head1 AUTHOR
1580		2278
1581	Marc Lehmann <pcg@goof.com>	2279	Marc Lehmann <schmorp@schmorp.de>
1582	http://software.schmorp.de/pkg/rxvt-unicode	2280	http://software.schmorp.de/pkg/rxvt-unicode
1583		2281
1584	=cut	2282	=cut
1585		2283
1586	1	2284	1
		2285
		2286	# vim: sw=3:

Diff Legend

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