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.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC

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

Diff Legend

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