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.189 by root, Sat Dec 18 15:37:10 2010 UTC

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

Diff Legend

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