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

Diff Legend

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