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

Diff Legend

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