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.44 by root, Sat Jan 7 19:29:17 2006 UTC vs.
Revision 1.183 by sf-exg, Wed Mar 31 13:14:50 2010 UTC

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

Diff Legend

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