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.54 by root, Sun Jan 8 01:59:29 2006 UTC vs.
Revision 1.179 by root, Sat Dec 26 09:23:53 2009 UTC

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

Diff Legend

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