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.78 by root, Wed Jan 11 01:01:52 2006 UTC vs.
Revision 1.198 by root, Tue Oct 4 22:25:14 2011 UTC

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

Diff Legend

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