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.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.168 by root, Sun Jun 15 14:07:58 2008 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
32		33
		34	=head1 PREPACKAGED EXTENSIONS
		35
33	This section describes the extensiosn delivered with this version. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
44	Intelligent selection. This extension tries to be more intelligent when	51	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	52	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	53	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	54	arguments, which is very convenient, too, if your F<ls> supports
		55	C<--quoting-style=shell>.
48		56
49	It also offers the following bindable event:	57	A double-click usually selects the word under the cursor, further clicks
		58	will enlarge the selection.
		59
		60	The selection works by trying to match a number of regexes and displaying
		61	them in increasing order of length. You can add your own regexes by
		62	specifying resources of the form:
		63
		64	URxvt.selection.pattern-0: perl-regex
		65	URxvt.selection.pattern-1: perl-regex
		66	...
		67
		68	The index number (0, 1...) must not have any holes, and each regex must
		69	contain at least one pair of capturing parentheses, which will be used for
		70	the match. For example, the following adds a regex that matches everything
		71	between two vertical bars:
		72
		73	URxvt.selection.pattern-0: \\|([^|]+)\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
		81
		82	You can look at the source of the selection extension to see more
		83	interesting uses, such as parsing a line from beginning to end.
		84
		85	This extension also offers following bindable keyboard commands:
50		86
51	=over 4	87	=over 4
52		88
53	=item rot13	89	=item rot13
54		90
…		…
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.	122	text into various other formats/action (such as uri unescaping, perl
		123	evaluation, web-browser starting etc.), depending on content.
		124
		125	Other extensions can extend this popup menu by pushing a code reference
		126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
		128
		129	Its sole argument is the popup menu, which can be modified. The selection
		130	is in C<$_>, which can be used to decide whether to add something or not.
		131	It should either return nothing or a string and a code reference. The
		132	string will be used as button text and the code reference will be called
		133	when the button gets activated and should transform C<$_>.
		134
		135	The following will add an entry C<a to b> that transforms all C<a>s in
		136	the selection to C<b>s, but only if the selection currently contains any
		137	C<a>s:
		138
		139	push @{ $self->{term}{selection_popup_hook} }, sub {
		140	/a/ ? ("a to b" => sub { s/a/b/g }
		141	: ()
		142	};
70		143
71	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
72		145
73	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
74	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
75	input/output is suspended.	148	input/output is suspended and a regex is displayed at the bottom of the
		149	screen.
76		150
77	C</> starts an incremental regex search, C<n> searches further, C<p> or	151	Inputting characters appends them to the regex and continues incremental
78	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>
79	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
80	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.
81		158
82	=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.
83		162
84	Displays a digital clock using the built-in overlay.	163	See L<perlre> for more info about perl regular expression syntax.
85		164
86	=item mark-urls	165	=item readline (enabled by default)
87		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
88	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).
89		307
90	=item block-graphics-to-ascii	308	=item block-graphics-to-ascii
91		309
92	A not very useful example of filtering all text output to the terminal,	310	A not very useful example of filtering all text output to the terminal
93	by replacing all line-drawing characters (U+2500 .. U+259F) by a	311	by replacing all line-drawing characters (U+2500 .. U+259F) by a
94	similar-looking ascii character.	312	similar-looking ascii character.
		313
		314	=item digital-clock
		315
		316	Displays a digital clock using the built-in overlay.
		317
		318	=item remote-clipboard
		319
		320	Somewhat of a misnomer, this extension adds two menu entries to the
		321	selection popup that allows one to run external commands to store the
		322	selection somewhere and fetch it again.
		323
		324	We use it to implement a "distributed selection mechanism", which just
		325	means that one command uploads the file to a remote server, and another
		326	reads it.
		327
		328	The commands can be set using the C<URxvt.remote-selection.store> and
		329	C<URxvt.remote-selection.fetch> resources. The first should read the
		330	selection to store from STDIN (always in UTF-8), the second should provide
		331	the selection data on STDOUT (also in UTF-8).
		332
		333	The defaults (which are likely useless to you) use rsh and cat:
		334
		335	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		336	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		337
		338	=item selection-pastebin
		339
		340	This is a little rarely useful extension that Uploads the selection as
		341	textfile to a remote site (or does other things). (The implementation is
		342	not currently secure for use in a multiuser environment as it writes to
		343	F</tmp> directly.).
		344
		345	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		346	i.e.
		347
		348	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		349
		350	Pressing this combination runs a command with C<%> replaced by the name of
		351	the textfile. This command can be set via a resource:
		352
		353	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		354
		355	And the default is likely not useful to anybody but the few people around
		356	here :)
		357
		358	The name of the textfile is the hex encoded md5 sum of the selection, so
		359	the same content should lead to the same filename.
		360
		361	After a successful upload the selection will be replaced by the text given
		362	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		363	for the filename):
		364
		365	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		366
		367	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		368	the double C</> characters as comment start. Use C<\057\057> instead,
		369	which works regardless of wether xrdb is used to parse the resource file
		370	or not.
95		371
96	=item example-refresh-hooks	372	=item example-refresh-hooks
97		373
98	Displays a very simple digital clock in the upper right corner of the	374	Displays a very simple digital clock in the upper right corner of the
99	window. Illustrates overwriting the refresh callbacks to create your own	375	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	376	overlays or changes.
101		377
102	=back	378	=back
		379
		380	=head1 API DOCUMENTATION
103		381
104	=head2 General API Considerations	382	=head2 General API Considerations
105		383
106	All objects (such as terminals, time watchers etc.) are typical	384	All objects (such as terminals, time watchers etc.) are typical
107	reference-to-hash objects. The hash can be used to store anything you	385	reference-to-hash objects. The hash can be used to store anything you
…		…
120	=over 4	398	=over 4
121		399
122	=item $text	400	=item $text
123		401
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	402	Rxvt-unicodes special way of encoding text, where one "unicode" character
125	always represents one screen cell. See L<row_t> for a discussion of this format.	403	always represents one screen cell. See L<ROW_t> for a discussion of this format.
126		404
127	=item $string	405	=item $string
128		406
129	A perl text string, with an emphasis on I<text>. It can store all unicode	407	A perl text string, with an emphasis on I<text>. It can store all unicode
130	characters and is to be distinguished with text encoded in a specific	408	characters and is to be distinguished with text encoded in a specific
…		…
137		415
138	=back	416	=back
139		417
140	=head2 Extension Objects	418	=head2 Extension Objects
141		419
142	Very perl extension is a perl class. A separate perl object is created	420	Every perl extension is a perl class. A separate perl object is created
143	for each terminal and each extension and passed as the first parameter to	421	for each terminal, and each terminal has its own set of extenion objects,
144	hooks. So extensions can use their C<$self> object without having to think	422	which are passed as the first parameter to hooks. So extensions can use
145	about other extensions, with the exception of methods and members that	423	their C<$self> object without having to think about clashes with other
		424	extensions or other terminals, with the exception of methods and members
146	begin with an underscore character C<_>: these are reserved for internal	425	that begin with an underscore character C<_>: these are reserved for
147	use.	426	internal use.
148		427
149	Although it isn't a C<urxvt::term> object, you can call all methods of the	428	Although it isn't a C<urxvt::term> object, you can call all methods of the
150	C<urxvt::term> class on this object.	429	C<urxvt::term> class on this object.
151		430
152	It has the following methods and data members:	431	It has the following methods and data members:
…		…
173	=head2 Hooks	452	=head2 Hooks
174		453
175	The following subroutines can be declared in extension files, and will be	454	The following subroutines can be declared in extension files, and will be
176	called whenever the relevant event happens.	455	called whenever the relevant event happens.
177		456
178	The first argument passed to them is an extension oject as described in	457	The first argument passed to them is an extension object as described in
179	the in the C<Extension Objects> section.	458	the in the C<Extension Objects> section.
180		459
181	B<All> of these hooks must return a boolean value. If it is true, then the	460	B<All> of these hooks must return a boolean value. If any of the called
182	event counts as being I<consumed>, and the invocation of other hooks is	461	hooks returns true, then the event counts as being I<consumed>, and the
183	skipped, and the relevant action might not be carried out by the C++ code.	462	relevant action might not be carried out by the C++ code.
184		463
185	I<< When in doubt, return a false value (preferably C<()>). >>	464	I<< When in doubt, return a false value (preferably C<()>). >>
186		465
187	=over 4	466	=over 4
188		467
189	=item on_init $term	468	=item on_init $term
190		469
191	Called after a new terminal object has been initialized, but before	470	Called after a new terminal object has been initialized, but before
192	windows are created or the command gets run. Most methods are unsafe to	471	windows are created or the command gets run. Most methods are unsafe to
193	call or deliver senseless data, as terminal size and other characteristics	472	call or deliver senseless data, as terminal size and other characteristics
194	have not yet been determined. You can safely query and change resources,	473	have not yet been determined. You can safely query and change resources
195	though.	474	and options, though. For many purposes the C<on_start> hook is a better
		475	place.
		476
		477	=item on_start $term
		478
		479	Called at the very end of initialisation of a new terminal, just before
		480	trying to map (display) the toplevel and returning to the main loop.
		481
		482	=item on_destroy $term
		483
		484	Called whenever something tries to destroy terminal, when the terminal is
		485	still fully functional (not for long, though).
196		486
197	=item on_reset $term	487	=item on_reset $term
198		488
199	Called after the screen is "reset" for any reason, such as resizing or	489	Called after the screen is "reset" for any reason, such as resizing or
200	control sequences. Here is where you can react on changes to size-related	490	control sequences. Here is where you can react on changes to size-related
201	variables.	491	variables.
202		492
203	=item on_start $term	493	=item on_child_start $term, $pid
204		494
205	Called at the very end of initialisation of a new terminal, just before	495	Called just after the child process has been C<fork>ed.
206	returning to the mainloop.	496
		497	=item on_child_exit $term, $status
		498
		499	Called just after the child process has exited. C<$status> is the status
		500	from C<waitpid>.
207		501
208	=item on_sel_make $term, $eventtime	502	=item on_sel_make $term, $eventtime
209		503
210	Called whenever a selection has been made by the user, but before the	504	Called whenever a selection has been made by the user, but before the
211	selection text is copied, so changes to the beginning, end or type of the	505	selection text is copied, so changes to the beginning, end or type of the
…		…
218		512
219	Called whenever a selection has been copied, but before the selection is	513	Called whenever a selection has been copied, but before the selection is
220	requested from the server. The selection text can be queried and changed	514	requested from the server. The selection text can be queried and changed
221	by calling C<< $term->selection >>.	515	by calling C<< $term->selection >>.
222		516
223	Returning a true value aborts selection grabbing. It will still be hilighted.	517	Returning a true value aborts selection grabbing. It will still be highlighted.
224		518
225	=item on_sel_extend $term	519	=item on_sel_extend $term
226		520
227	Called whenever the user tries to extend the selection (e.g. with a double	521	Called whenever the user tries to extend the selection (e.g. with a double
228	click) and is either supposed to return false (normal operation), or	522	click) and is either supposed to return false (normal operation), or
229	should extend the selection itelf and return true to suppress the built-in	523	should extend the selection itself and return true to suppress the built-in
230	processing.	524	processing. This can happen multiple times, as long as the callback
		525	returns true, it will be called on every further click by the user and is
		526	supposed to enlarge the selection more and more, if possible.
231		527
232	See the F<selection> example extension.	528	See the F<selection> example extension.
233		529
234	=item on_view_change $term, $offset	530	=item on_view_change $term, $offset
235		531
236	Called whenever the view offset changes, i..e the user or program	532	Called whenever the view offset changes, i.e. the user or program
237	scrolls. Offset C<0> means display the normal terminal, positive values	533	scrolls. Offset C<0> means display the normal terminal, positive values
238	show this many lines of scrollback.	534	show this many lines of scrollback.
239		535
240	=item on_scroll_back $term, $lines, $saved	536	=item on_scroll_back $term, $lines, $saved
241		537
…		…
245		541
246	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	542	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
247	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	543	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
248	number of lines that will be in the scrollback buffer.	544	number of lines that will be in the scrollback buffer.
249		545
		546	=item on_osc_seq $term, $op, $args
		547
		548	Called on every OSC sequence and can be used to suppress it or modify its
		549	behaviour. The default should be to return an empty list. A true value
		550	suppresses execution of the request completely. Make sure you don't get
		551	confused by recursive invocations when you output an osc sequence within
		552	this callback.
		553
		554	C<on_osc_seq_perl> should be used for new behaviour.
		555
250	=item on_osc_seq $term, $string	556	=item on_osc_seq_perl $term, $string
251		557
252	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
253	operating system command) is processed. Cursor position and other state	559	operating system command) is processed. Cursor position and other state
254	information is up-to-date when this happens. For interoperability, the	560	information is up-to-date when this happens. For interoperability, the
255	string should start with the extension name and a colon, to distinguish	561	string should start with the extension name and a colon, to distinguish
256	it from commands for other extensions, and this might be enforced in the	562	it from commands for other extensions, and this might be enforced in the
257	future.	563	future.
258		564
259	Be careful not ever to trust (in a security sense) the data you receive,	565	Be careful not ever to trust (in a security sense) the data you receive,
260	as its source can not easily be controleld (e-mail content, messages from	566	as its source can not easily be controlled (e-mail content, messages from
261	other users on the same system etc.).	567	other users on the same system etc.).
262		568
263	=item on_add_lines $term, $string	569	=item on_add_lines $term, $string
264		570
265	Called whenever text is about to be output, with the text as argument. You	571	Called whenever text is about to be output, with the text as argument. You
…		…
296		602
297	=item on_refresh_end $term	603	=item on_refresh_end $term
298		604
299	Called just after the screen gets redrawn. See C<on_refresh_begin>.	605	Called just after the screen gets redrawn. See C<on_refresh_begin>.
300		606
301	=item on_keyboard_command $term, $string	607	=item on_user_command $term, $string
302		608
303	Called whenever the user presses a key combination that has a	609	Called whenever a user-configured event is being activated (e.g. via
304	C<perl:string> action bound to it (see description of the B<keysym>	610	a C<perl:string> action bound to a key, see description of the B<keysym>
305	resource in the @@RXVT_NAME@@(1) manpage).	611	resource in the @@RXVT_NAME@@(1) manpage).
		612
		613	The event is simply the action string. This interface is assumed to change
		614	slightly in the future.
		615
		616	=item on_resize_all_windows $tern, $new_width, $new_height
		617
		618	Called just after the new window size has been calculated, but before
		619	windows are actually being resized or hints are being set. If this hook
		620	returns TRUE, setting of the window hints is being skipped.
		621
		622	=item on_x_event $term, $event
		623
		624	Called on every X event received on the vt window (and possibly other
		625	windows). Should only be used as a last resort. Most event structure
		626	members are not passed.
		627
		628	=item on_root_event $term, $event
		629
		630	Like C<on_x_event>, but is called for events on the root window.
306		631
307	=item on_focus_in $term	632	=item on_focus_in $term
308		633
309	Called whenever the window gets the keyboard focus, before rxvt-unicode	634	Called whenever the window gets the keyboard focus, before rxvt-unicode
310	does focus in processing.	635	does focus in processing.
311		636
312	=item on_focus_out $term	637	=item on_focus_out $term
313		638
314	Called wheneever the window loses keyboard focus, before rxvt-unicode does	639	Called whenever the window loses keyboard focus, before rxvt-unicode does
315	focus out processing.	640	focus out processing.
		641
		642	=item on_configure_notify $term, $event
		643
		644	=item on_property_notify $term, $event
316		645
317	=item on_key_press $term, $event, $keysym, $octets	646	=item on_key_press $term, $event, $keysym, $octets
318		647
319	=item on_key_release $term, $event, $keysym	648	=item on_key_release $term, $event, $keysym
320		649
…		…
330		659
331	Called whenever the corresponding X event is received for the terminal If	660	Called whenever the corresponding X event is received for the terminal If
332	the hook returns true, then the even will be ignored by rxvt-unicode.	661	the hook returns true, then the even will be ignored by rxvt-unicode.
333		662
334	The event is a hash with most values as named by Xlib (see the XEvent	663	The event is a hash with most values as named by Xlib (see the XEvent
335	manpage), with the additional members C<row> and C<col>, which are the row	664	manpage), with the additional members C<row> and C<col>, which are the
336	and column under the mouse cursor.	665	(real, not screen-based) row and column under the mouse cursor.
337		666
338	C<on_key_press> additionally receives the string rxvt-unicode would	667	C<on_key_press> additionally receives the string rxvt-unicode would
339	output, if any, in locale-specific encoding.	668	output, if any, in locale-specific encoding.
340		669
341	subwindow.	670	subwindow.
342		671
343	=back	672	=item on_client_message $term, $event
344		673
345	=head2 Variables in the C<urxvt> Package	674	=item on_wm_protocols $term, $event
346		675
347	=over 4	676	=item on_wm_delete_window $term, $event
348		677
349	=item $urxvt::TERM	678	Called when various types of ClientMessage events are received (all with
350		679	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
351	The current terminal. This variable stores the current C<urxvt::term>
352	object, whenever a callback/hook is executing.
353
354	=back
355
356	=head2 Functions in the C<urxvt> Package
357
358	=over 4
359
360	=item $term = new urxvt [arg...]
361
362	Creates a new terminal, very similar as if you had started it with
363	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
364	if the new instance couldn't be created. Returns C<undef> if the new
365	instance didn't initialise perl, and the terminal object otherwise. The
366	C<init> and C<start> hooks will be called during the call.
367
368	=item urxvt::fatal $errormessage
369
370	Fatally aborts execution with the given error message. Avoid at all
371	costs! The only time this is acceptable is when the terminal process
372	starts up.
373
374	=item urxvt::warn $string
375
376	Calls C<rxvt_warn> with the given string which should not include a
377	newline. The module also overwrites the C<warn> builtin with a function
378	that calls this function.
379
380	Using this function has the advantage that its output ends up in the
381	correct place, e.g. on stderr of the connecting urxvtc client.
382
383	=item $is_safe = urxvt::safe
384
385	Returns true when it is safe to do potentially unsafe things, such as
386	evaluating perl code specified by the user. This is true when urxvt was
387	started setuid or setgid.
388
389	=item $time = urxvt::NOW
390
391	Returns the "current time" (as per the event loop).
392
393	=item urxvt::CurrentTime
394
395	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
396	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
397	Button4Mask, Button5Mask, AnyModifier
398
399	Various constants for use in X calls and event processing.
400
401	=back
402
403	=head2 RENDITION
404
405	Rendition bitsets contain information about colour, font, font styles and
406	similar information for each screen cell.
407
408	The following "macros" deal with changes in rendition sets. You should
409	never just create a bitset, you should always modify an existing one,
410	as they contain important information required for correct operation of
411	rxvt-unicode.
412
413	=over 4
414
415	=item $rend = urxvt::DEFAULT_RSTYLE
416
417	Returns the default rendition, as used when the terminal is starting up or
418	being reset. Useful as a base to start when creating renditions.
419
420	=item $rend = urxvt::OVERLAY_RSTYLE
421
422	Return the rendition mask used for overlays by default.
423
424	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
425
426	Return the bit that enabled bold, italic, blink, reverse-video and
427	underline, respectively. To enable such a style, just logically OR it into
428	the bitset.
429
430	=item $foreground = urxvt::GET_BASEFG $rend
431
432	=item $background = urxvt::GET_BASEBG $rend
433
434	Return the foreground/background colour index, respectively.
435
436	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
437
438	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
439
440	Replace the foreground/background colour in the rendition mask with the
441	specified one.
442
443	=item $value = urxvt::GET_CUSTOM ($rend)
444
445	Return the "custom" value: Every rendition has 5 bits for use by
446	extensions. They can be set and changed as you like and are initially
447	zero.
448
449	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
450
451	Change the custom value.
452		680
453	=back	681	=back
454		682
455	=cut	683	=cut
456		684
…		…
462	use Scalar::Util ();	690	use Scalar::Util ();
463	use List::Util ();	691	use List::Util ();
464		692
465	our $VERSION = 1;	693	our $VERSION = 1;
466	our $TERM;	694	our $TERM;
		695	our @TERM_INIT;
		696	our @TERM_EXT;
467	our @HOOKNAME;	697	our @HOOKNAME;
468	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	698	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
469	our %OPTION;	699	our %OPTION;
470		700
471	our $LIBDIR;	701	our $LIBDIR;
472	our $RESNAME;	702	our $RESNAME;
473	our $RESCLASS;	703	our $RESCLASS;
474	our $RXVTNAME;	704	our $RXVTNAME;
475		705
		706	our $NOCHAR = chr 0xffff;
		707
		708	=head2 Variables in the C<urxvt> Package
		709
		710	=over 4
		711
		712	=item $urxvt::LIBDIR
		713
		714	The rxvt-unicode library directory, where, among other things, the perl
		715	modules and scripts are stored.
		716
		717	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		718
		719	The resource class and name rxvt-unicode uses to look up X resources.
		720
		721	=item $urxvt::RXVTNAME
		722
		723	The basename of the installed binaries, usually C<urxvt>.
		724
		725	=item $urxvt::TERM
		726
		727	The current terminal. This variable stores the current C<urxvt::term>
		728	object, whenever a callback/hook is executing.
		729
		730	=item @urxvt::TERM_INIT
		731
		732	All code references in this array will be called as methods of the next newly
		733	created C<urxvt::term> object (during the C<on_init> phase). The array
		734	gets cleared before the code references that were in it are being executed,
		735	so references can push themselves onto it again if they so desire.
		736
		737	This complements to the perl-eval command line option, but gets executed
		738	first.
		739
		740	=item @urxvt::TERM_EXT
		741
		742	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		743	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		744	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		745
		746	=back
		747
		748	=head2 Functions in the C<urxvt> Package
		749
		750	=over 4
		751
		752	=item urxvt::fatal $errormessage
		753
		754	Fatally aborts execution with the given error message. Avoid at all
		755	costs! The only time this is acceptable is when the terminal process
		756	starts up.
		757
		758	=item urxvt::warn $string
		759
		760	Calls C<rxvt_warn> with the given string which should not include a
		761	newline. The module also overwrites the C<warn> builtin with a function
		762	that calls this function.
		763
		764	Using this function has the advantage that its output ends up in the
		765	correct place, e.g. on stderr of the connecting urxvtc client.
		766
		767	Messages have a size limit of 1023 bytes currently.
		768
		769	=item @terms = urxvt::termlist
		770
		771	Returns all urxvt::term objects that exist in this process, regardless of
		772	whether they are started, being destroyed etc., so be careful. Only term
		773	objects that have perl extensions attached will be returned (because there
		774	is no urxvt::term objet associated with others).
		775
		776	=item $time = urxvt::NOW
		777
		778	Returns the "current time" (as per the event loop).
		779
		780	=item urxvt::CurrentTime
		781
		782	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		783	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		784	Button4Mask, Button5Mask, AnyModifier
		785
		786	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		787	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		788	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		789	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		790	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		791	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		792	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		793
		794	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		795	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		796	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		797	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		798	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		799	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		800	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		801
		802	Various constants for use in X calls and event processing.
		803
		804	=back
		805
		806	=head2 RENDITION
		807
		808	Rendition bitsets contain information about colour, font, font styles and
		809	similar information for each screen cell.
		810
		811	The following "macros" deal with changes in rendition sets. You should
		812	never just create a bitset, you should always modify an existing one,
		813	as they contain important information required for correct operation of
		814	rxvt-unicode.
		815
		816	=over 4
		817
		818	=item $rend = urxvt::DEFAULT_RSTYLE
		819
		820	Returns the default rendition, as used when the terminal is starting up or
		821	being reset. Useful as a base to start when creating renditions.
		822
		823	=item $rend = urxvt::OVERLAY_RSTYLE
		824
		825	Return the rendition mask used for overlays by default.
		826
		827	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		828
		829	Return the bit that enabled bold, italic, blink, reverse-video and
		830	underline, respectively. To enable such a style, just logically OR it into
		831	the bitset.
		832
		833	=item $foreground = urxvt::GET_BASEFG $rend
		834
		835	=item $background = urxvt::GET_BASEBG $rend
		836
		837	Return the foreground/background colour index, respectively.
		838
		839	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		840
		841	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		842
		843	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		844
		845	Replace the foreground/background colour in the rendition mask with the
		846	specified one.
		847
		848	=item $value = urxvt::GET_CUSTOM $rend
		849
		850	Return the "custom" value: Every rendition has 5 bits for use by
		851	extensions. They can be set and changed as you like and are initially
		852	zero.
		853
		854	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		855
		856	Change the custom value.
		857
		858	=back
		859
		860	=cut
		861
476	BEGIN {	862	BEGIN {
477	urxvt->bootstrap;
478
479	# overwrite perl's warn	863	# overwrite perl's warn
480	*CORE::GLOBAL::warn = sub {	864	*CORE::GLOBAL::warn = sub {
481	my $msg = join "", @_;	865	my $msg = join "", @_;
482	$msg .= "\n"	866	$msg .= "\n"
483	unless $msg =~ /\n$/;	867	unless $msg =~ /\n$/;
484	urxvt::warn ($msg);	868	urxvt::warn ($msg);
485	};	869	};
486
487	delete $ENV{IFS};
488	delete $ENV{CDPATH};
489	delete $ENV{BASH_ENV};
490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
491	}	870	}
492		871
493	my @hook_count;	872	no warnings 'utf8';
		873
494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	874	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
495		875
496	sub verbose {	876	sub verbose {
497	my ($level, $msg) = @_;	877	my ($level, $msg) = @_;
498	warn "$msg\n" if $level <= $verbosity;	878	warn "$msg\n" if $level <= $verbosity;
499	}	879	}
500		880
501	my $extension_pkg = "extension0000";
502	my %extension_pkg;	881	my %extension_pkg;
503		882
504	# load a single script into its own package, once only	883	# load a single script into its own package, once only
505	sub extension_package($) {	884	sub extension_package($) {
506	my ($path) = @_;	885	my ($path) = @_;
507		886
508	$extension_pkg{$path} ||= do {	887	$extension_pkg{$path} ||= do {
509	my $pkg = "urxvt::" . ($extension_pkg++);	888	$path =~ /([^\/\\]+)$/;
		889	my $pkg = $1;
		890	$pkg =~ s/[^[:word:]]/_/g;
		891	$pkg = "urxvt::ext::$pkg";
510		892
511	verbose 3, "loading extension '$path' into package '$pkg'";	893	verbose 3, "loading extension '$path' into package '$pkg'";
512		894
513	open my $fh, "<:raw", $path	895	open my $fh, "<:raw", $path
514	or die "$path: $!";	896	or die "$path: $!";
515		897
516	my $source = untaint	898	my $source =
517	"package $pkg; use strict; use utf8;\n"	899	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
518	. "use base urxvt::term::extension::;\n"
519	. "#line 1 \"$path\"\n{\n"	900	. "#line 1 \"$path\"\n{\n"
520	. (do { local $/; <$fh> })	901	. (do { local $/; <$fh> })
521	. "\n};\n1";	902	. "\n};\n1";
522		903
523	eval $source	904	eval $source
…		…
534	local $TERM = shift;	915	local $TERM = shift;
535	my $htype = shift;	916	my $htype = shift;
536		917
537	if ($htype == 0) { # INIT	918	if ($htype == 0) { # INIT
538	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	919	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
539		920
540	my %ext_arg;	921	my %ext_arg;
541		922
		923	{
		924	my @init = @TERM_INIT;
		925	@TERM_INIT = ();
		926	$_->($TERM) for @init;
		927	my @pkg = @TERM_EXT;
		928	@TERM_EXT = ();
		929	$TERM->register_package ($_) for @pkg;
		930	}
		931
542	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	932	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
543	if ($_ eq "default") {	933	if ($_ eq "default") {
544	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	934	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
545	} elsif (/^-(.*)$/) {	935	} elsif (/^-(.*)$/) {
546	delete $ext_arg{$1};	936	delete $ext_arg{$1};
547	} elsif (/^([^<]+)<(.*)>$/) {	937	} elsif (/^([^<]+)<(.*)>$/) {
548	push @{ $ext_arg{$1} }, $2;	938	push @{ $ext_arg{$1} }, $2;
549	} else {	939	} else {
550	$ext_arg{$_} ||= [];	940	$ext_arg{$_} ||= [];
551	}	941	}
552	}	942	}
553		943
554	while (my ($ext, $argv) = each %ext_arg) {	944	for my $ext (sort keys %ext_arg) {
555	my @files = grep -f $_, map "$_/$ext", @dirs;	945	my @files = grep -f $_, map "$_/$ext", @dirs;
556		946
557	if (@files) {	947	if (@files) {
558	$TERM->register_package (extension_package $files[0], $argv);	948	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
559	} else {	949	} else {
560	warn "perl extension '$ext' not found in perl library search path\n";	950	warn "perl extension '$ext' not found in perl library search path\n";
561	}	951	}
562	}	952	}
563		953
…		…
569		959
570	if (my $cb = $TERM->{_hook}[$htype]) {	960	if (my $cb = $TERM->{_hook}[$htype]) {
571	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	961	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
572	if $verbosity >= 10;	962	if $verbosity >= 10;
573		963
574	keys %$cb;	964	for my $pkg (keys %$cb) {
575
576	while (my ($pkg, $cb) = each %$cb) {
577	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	965	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
578	and last;	966	$retval ||= $retval_;
579		967
580	if ($@) {	968	if ($@) {
581	$TERM->ungrab; # better to lose the grab than the session	969	$TERM->ungrab; # better to lose the grab than the session
582	warn $@;	970	warn $@;
583	}	971	}
584	}	972	}
		973
		974	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		975	if $verbosity >= 11;
585	}	976	}
586		977
587	if ($htype == 1) { # DESTROY	978	if ($htype == 1) { # DESTROY
588	if (my $hook = delete $TERM->{_hook}) {
589	for my $htype (0..$#$hook) {
590	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
591	or set_should_invoke $htype, 0;
592	}
593	}
594
595	# clear package objects	979	# clear package objects
596	%$_ = () for values %{ $TERM->{_pkg} };	980	%$_ = () for values %{ $TERM->{_pkg} };
597		981
598	# clear package	982	# clear package
599	%$TERM = ();	983	%$TERM = ();
600	}	984	}
601		985
602	$retval	986	$retval
		987	}
		988
		989	sub SET_COLOR($$$) {
		990	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		991	}
		992
		993	sub rend2mask {
		994	no strict 'refs';
		995	my ($str, $mask) = (@_, 0);
		996	my %color = ( fg => undef, bg => undef );
		997	my @failed;
		998	for my $spec ( split /\s+/, $str ) {
		999	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1000	$color{lc($1)} = $2;
		1001	} else {
		1002	my $neg = $spec =~ s/^[-^]//;
		1003	unless ( exists &{"RS_$spec"} ) {
		1004	push @failed, $spec;
		1005	next;
		1006	}
		1007	my $cur = &{"RS_$spec"};
		1008	if ( $neg ) {
		1009	$mask &= ~$cur;
		1010	} else {
		1011	$mask |= $cur;
		1012	}
		1013	}
		1014	}
		1015	($mask, @color{qw(fg bg)}, \@failed)
603	}	1016	}
604		1017
605	# urxvt::term::extension	1018	# urxvt::term::extension
606		1019
607	package urxvt::term::extension;	1020	package urxvt::term::extension;
…		…
613	while (my ($name, $cb) = each %hook) {	1026	while (my ($name, $cb) = each %hook) {
614	my $htype = $HOOKTYPE{uc $name};	1027	my $htype = $HOOKTYPE{uc $name};
615	defined $htype	1028	defined $htype
616	or Carp::croak "unsupported hook type '$name'";	1029	or Carp::croak "unsupported hook type '$name'";
617		1030
		1031	$self->set_should_invoke ($htype, +1)
618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1032	unless exists $self->{term}{_hook}[$htype]{$pkg};
619	$hook_count[$htype]++
620	or urxvt::set_should_invoke $htype, 1;
621	}
622		1033
623	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1034	$self->{term}{_hook}[$htype]{$pkg} = $cb;
624	}	1035	}
625	}	1036	}
626		1037
…		…
631	for my $name (@hook) {	1042	for my $name (@hook) {
632	my $htype = $HOOKTYPE{uc $name};	1043	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	1044	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	1045	or Carp::croak "unsupported hook type '$name'";
635		1046
		1047	$self->set_should_invoke ($htype, -1)
636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1048	if delete $self->{term}{_hook}[$htype]{$pkg};
637	--$hook_count[$htype]
638	or urxvt::set_should_invoke $htype, 0;
639	}
640	}	1049	}
641	}	1050	}
642		1051
643	our $AUTOLOAD;	1052	our $AUTOLOAD;
644		1053
…		…
675		1084
676	=head2 The C<urxvt::anyevent> Class	1085	=head2 The C<urxvt::anyevent> Class
677		1086
678	The sole purpose of this class is to deliver an interface to the	1087	The sole purpose of this class is to deliver an interface to the
679	C<AnyEvent> module - any module using it will work inside urxvt without	1088	C<AnyEvent> module - any module using it will work inside urxvt without
680	further work. The only exception is that you cannot wait on condition	1089	further programming. The only exception is that you cannot wait on
681	variables, but non-blocking condvar use is ok. What this means is that you	1090	condition variables, but non-blocking condvar use is ok. What this means
682	cannot use blocking APIs, but the non-blocking variant should work.	1091	is that you cannot use blocking APIs, but the non-blocking variant should
		1092	work.
683		1093
684	=cut	1094	=cut
685		1095
686	our $VERSION = 1;	1096	our $VERSION = '3.4';
687		1097
688	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1098	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
689	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1099	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
690		1100
691	sub timer {	1101	sub timer {
…		…
722		1132
723	sub DESTROY {	1133	sub DESTROY {
724	$_[0][1]->stop;	1134	$_[0][1]->stop;
725	}	1135	}
726		1136
727	sub condvar {	1137	sub one_event {
728	bless \my $flag, urxvt::anyevent::condvar::
729	}
730
731	sub urxvt::anyevent::condvar::broadcast {
732	${$_[0]}++;
733	}
734
735	sub urxvt::anyevent::condvar::wait {
736	unless (${$_[0]}) {
737	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1138	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
738	}
739	}	1139	}
740		1140
741	package urxvt::term;	1141	package urxvt::term;
742		1142
743	=head2 The C<urxvt::term> Class	1143	=head2 The C<urxvt::term> Class
…		…
748		1148
749	# find on_xxx subs in the package and register them	1149	# find on_xxx subs in the package and register them
750	# as hooks	1150	# as hooks
751	sub register_package {	1151	sub register_package {
752	my ($self, $pkg, $argv) = @_;	1152	my ($self, $pkg, $argv) = @_;
		1153
		1154	no strict 'refs';
		1155
		1156	urxvt::verbose 6, "register package $pkg to $self";
		1157
		1158	@{"$pkg\::ISA"} = urxvt::term::extension::;
753		1159
754	my $proxy = bless {	1160	my $proxy = bless {
755	_pkg => $pkg,	1161	_pkg => $pkg,
756	argv => $argv,	1162	argv => $argv,
757	}, $pkg;	1163	}, $pkg;
…		…
764	$proxy->enable ($name => $ref);	1170	$proxy->enable ($name => $ref);
765	}	1171	}
766	}	1172	}
767	}	1173	}
768		1174
		1175	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1176
		1177	Creates a new terminal, very similar as if you had started it with system
		1178	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1179	hash which defines the environment of the new terminal.
		1180
		1181	Croaks (and probably outputs an error message) if the new instance
		1182	couldn't be created. Returns C<undef> if the new instance didn't
		1183	initialise perl, and the terminal object otherwise. The C<init> and
		1184	C<start> hooks will be called before this call returns, and are free to
		1185	refer to global data (which is race free).
		1186
		1187	=cut
		1188
		1189	sub new {
		1190	my ($class, $env, @args) = @_;
		1191
		1192	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1193	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1194
		1195	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1196	}
		1197
769	=item $term->destroy	1198	=item $term->destroy
770		1199
771	Destroy the terminal object (close the window, free resources etc.).	1200	Destroy the terminal object (close the window, free resources
		1201	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1202	watchers (timers, io watchers) are still active.
		1203
		1204	=item $term->exec_async ($cmd[, @args])
		1205
		1206	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1207	("starts") programs in the background. This function takes care of setting
		1208	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1209	be preferred over explicit calls to C<exec> or C<system>.
		1210
		1211	Returns the pid of the subprocess or C<undef> on error.
		1212
		1213	=cut
		1214
		1215	sub exec_async {
		1216	my $self = shift;
		1217
		1218	my $pid = fork;
		1219
		1220	return $pid
		1221	if !defined $pid or $pid;
		1222
		1223	%ENV = %{ $self->env };
		1224
		1225	exec @_;
		1226	urxvt::_exit 255;
		1227	}
772		1228
773	=item $isset = $term->option ($optval[, $set])	1229	=item $isset = $term->option ($optval[, $set])
774		1230
775	Returns true if the option specified by C<$optval> is enabled, and	1231	Returns true if the option specified by C<$optval> is enabled, and
776	optionally change it. All option values are stored by name in the hash	1232	optionally change it. All option values are stored by name in the hash
777	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1233	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
778		1234
779	Here is a a likely non-exhaustive list of option names, please see the	1235	Here is a likely non-exhaustive list of option names, please see the
780	source file F</src/optinc.h> to see the actual list:	1236	source file F</src/optinc.h> to see the actual list:
781		1237
782	borderLess console cursorBlink cursorUnderline hold iconic insecure	1238	borderLess console cursorBlink cursorUnderline hold iconic insecure
783	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1239	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
784	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1240	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
785	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1241	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
786	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1242	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
787	tripleclickwords utmpInhibit visualBell	1243	transparent tripleclickwords utmpInhibit visualBell
788		1244
789	=item $value = $term->resource ($name[, $newval])	1245	=item $value = $term->resource ($name[, $newval])
790		1246
791	Returns the current resource value associated with a given name and	1247	Returns the current resource value associated with a given name and
792	optionally sets a new value. Setting values is most useful in the C<init>	1248	optionally sets a new value. Setting values is most useful in the C<init>
…		…
801	likely change).	1257	likely change).
802		1258
803	Please note that resource strings will currently only be freed when the	1259	Please note that resource strings will currently only be freed when the
804	terminal is destroyed, so changing options frequently will eat memory.	1260	terminal is destroyed, so changing options frequently will eat memory.
805		1261
806	Here is a a likely non-exhaustive list of resource names, not all of which	1262	Here is a likely non-exhaustive list of resource names, not all of which
807	are supported in every build, please see the source file F</src/rsinc.h>	1263	are supported in every build, please see the source file F</src/rsinc.h>
808	to see the actual list:	1264	to see the actual list:
809		1265
810	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1266	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
811	borderLess color cursorBlink cursorUnderline cutchars delete_key	1267	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
812	display_name embed ext_bwidth fade font geometry hold iconName	1268	display_name embed ext_bwidth fade font geometry hold iconName
813	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1269	imFont imLocale inputMethod insecure int_bwidth intensityStyles
814	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1270	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
815	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1271	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
816	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1272	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
817	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1273	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
818	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1274	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
819	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1275	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
820	shade term_name title transparent transparent_all tripleclickwords	1276	secondaryScreen secondaryScroll shade term_name title
821	utmpInhibit visualBell	1277	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1278	visualBell
822		1279
823	=cut	1280	=cut
824		1281
825	sub resource($$;$) {	1282	sub resource($$;$) {
826	my ($self, $name) = (shift, shift);	1283	my ($self, $name) = (shift, shift);
827	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1284	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
828	&urxvt::term::_resource	1285	&urxvt::term::_resource
829	}	1286	}
830		1287
		1288	=item $value = $term->x_resource ($pattern)
		1289
		1290	Returns the X-Resource for the given pattern, excluding the program or
		1291	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1292	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1293	resource with that pattern exists.
		1294
		1295	This method should only be called during the C<on_start> hook, as there is
		1296	only one resource database per display, and later invocations might return
		1297	the wrong resources.
		1298
831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1299	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832		1300
833	Adds a keymap translation exactly as specified via a resource. See the	1301	Adds a keymap translation exactly as specified via a resource. See the
834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1302	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835		1303
…		…
850	=item ($row, $col) = $term->selection_end ([$row, $col])	1318	=item ($row, $col) = $term->selection_end ([$row, $col])
851		1319
852	Return the current values of the selection mark, begin or end positions,	1320	Return the current values of the selection mark, begin or end positions,
853	and optionally set them to new values.	1321	and optionally set them to new values.
854		1322
		1323	=item $term->selection_make ($eventtime[, $rectangular])
		1324
		1325	Tries to make a selection as set by C<selection_beg> and
		1326	C<selection_end>. If C<$rectangular> is true (default: false), a
		1327	rectangular selection will be made. This is the prefered function to make
		1328	a selection.
		1329
855	=item $success = $term->selection_grab ($eventtime)	1330	=item $success = $term->selection_grab ($eventtime)
856		1331
857	Try to request the primary selection from the server (for example, as set	1332	Try to request the primary selection text from the server (for example, as
858	by the next method).	1333	set by the next method). No visual feedback will be given. This function
		1334	is mostly useful from within C<on_sel_grab> hooks.
859		1335
860	=item $oldtext = $term->selection ([$newtext])	1336	=item $oldtext = $term->selection ([$newtext])
861		1337
862	Return the current selection text and optionally replace it by C<$newtext>.	1338	Return the current selection text and optionally replace it by C<$newtext>.
863		1339
…		…
956	Convert the given locale-encoded octets into a perl string.	1432	Convert the given locale-encoded octets into a perl string.
957		1433
958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1434	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
959		1435
960	XORs the rendition values in the given span with the provided value	1436	XORs the rendition values in the given span with the provided value
961	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1437	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
962	to the selection.	1438	refresh hooks to provide effects similar to the selection.
963		1439
964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1440	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
965		1441
966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1442	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
967	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1443	whitespace will additionally be xored with the C<$rstyle2>, which defaults
968	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1444	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
969	it instead.	1445	it instead. Both styles I<MUST NOT> contain font styles.
970		1446
971	=item $term->scr_bell	1447	=item $term->scr_bell
972		1448
973	Ring the bell!	1449	Ring the bell!
974		1450
…		…
981		1457
982	Normally its not a good idea to use this function, as programs might be	1458	Normally its not a good idea to use this function, as programs might be
983	confused by changes in cursor position or scrolling. Its useful inside a	1459	confused by changes in cursor position or scrolling. Its useful inside a
984	C<on_add_lines> hook, though.	1460	C<on_add_lines> hook, though.
985		1461
		1462	=item $term->scr_change_screen ($screen)
		1463
		1464	Switch to given screen - 0 primary, 1 secondary.
		1465
986	=item $term->cmd_parse ($octets)	1466	=item $term->cmd_parse ($octets)
987		1467
988	Similar to C<scr_add_lines>, but the argument must be in the	1468	Similar to C<scr_add_lines>, but the argument must be in the
989	locale-specific encoding of the terminal and can contain command sequences	1469	locale-specific encoding of the terminal and can contain command sequences
990	(escape codes) that will be interpreted.	1470	(escape codes) that will be interpreted.
…		…
1000	Replaces the event mask of the pty watcher by the given event mask. Can	1480	Replaces the event mask of the pty watcher by the given event mask. Can
1001	be used to suppress input and output handling to the pty/tty. See the	1481	be used to suppress input and output handling to the pty/tty. See the
1002	description of C<< urxvt::timer->events >>. Make sure to always restore	1482	description of C<< urxvt::timer->events >>. Make sure to always restore
1003	the previous value.	1483	the previous value.
1004		1484
		1485	=item $fd = $term->pty_fd
		1486
		1487	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1488	is used.
		1489
1005	=item $windowid = $term->parent	1490	=item $windowid = $term->parent
1006		1491
1007	Return the window id of the toplevel window.	1492	Return the window id of the toplevel window.
1008		1493
1009	=item $windowid = $term->vt	1494	=item $windowid = $term->vt
1010		1495
1011	Return the window id of the terminal window.	1496	Return the window id of the terminal window.
1012		1497
		1498	=item $term->vt_emask_add ($x_event_mask)
		1499
		1500	Adds the specified events to the vt event mask. Useful e.g. when you want
		1501	to receive pointer events all the times:
		1502
		1503	$term->vt_emask_add (urxvt::PointerMotionMask);
		1504
		1505	=item $term->focus_in
		1506
		1507	=item $term->focus_out
		1508
		1509	=item $term->key_press ($state, $keycode[, $time])
		1510
		1511	=item $term->key_release ($state, $keycode[, $time])
		1512
		1513	Deliver various fake events to to terminal.
		1514
1013	=item $window_width = $term->width	1515	=item $window_width = $term->width
1014		1516
1015	=item $window_height = $term->height	1517	=item $window_height = $term->height
1016		1518
1017	=item $font_width = $term->fwidth	1519	=item $font_width = $term->fwidth
…		…
1030		1532
1031	=item $max_scrollback = $term->saveLines	1533	=item $max_scrollback = $term->saveLines
1032		1534
1033	=item $nrow_plus_saveLines = $term->total_rows	1535	=item $nrow_plus_saveLines = $term->total_rows
1034		1536
1035	=item $lines_in_scrollback = $term->nsaved	1537	=item $topmost_scrollback_row = $term->top_row
1036		1538
1037	Return various integers describing terminal characteristics.	1539	Return various integers describing terminal characteristics.
1038		1540
		1541	=item $x_display = $term->display_id
		1542
		1543	Return the DISPLAY used by rxvt-unicode.
		1544
1039	=item $lc_ctype = $term->locale	1545	=item $lc_ctype = $term->locale
1040		1546
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1547	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1548
1043	=item $x_display = $term->display_id	1549	=item $env = $term->env
1044		1550
1045	Return the DISPLAY used by rxvt-unicode.	1551	Returns a copy of the environment in effect for the terminal as a hashref
		1552	similar to C<\%ENV>.
		1553
		1554	=item @envv = $term->envv
		1555
		1556	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1557
		1558	=item @argv = $term->argv
		1559
		1560	Return the argument vector as this terminal, similar to @ARGV, but
		1561	includes the program name as first element.
		1562
		1563	=cut
		1564
		1565	sub env {
		1566	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1567	}
1046		1568
1047	=item $modifiermask = $term->ModLevel3Mask	1569	=item $modifiermask = $term->ModLevel3Mask
1048		1570
1049	=item $modifiermask = $term->ModMetaMask	1571	=item $modifiermask = $term->ModMetaMask
1050		1572
1051	=item $modifiermask = $term->ModNumLockMask	1573	=item $modifiermask = $term->ModNumLockMask
1052		1574
1053	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1575	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1054	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1576	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1055		1577
		1578	=item $screen = $term->current_screen
		1579
		1580	Returns the currently displayed screen (0 primary, 1 secondary).
		1581
		1582	=item $cursor_is_hidden = $term->hidden_cursor
		1583
		1584	Returns whether the cursor is currently hidden or not.
		1585
1056	=item $view_start = $term->view_start ([$newvalue])	1586	=item $view_start = $term->view_start ([$newvalue])
1057		1587
1058	Returns the negative row number of the topmost line. Minimum value is	1588	Returns the row number of the topmost displayed line. Maximum value is
1059	C<0>, which displays the normal terminal contents. Larger values scroll	1589	C<0>, which displays the normal terminal contents. Lower values scroll
1060	this many lines into the scrollback buffer.	1590	this many lines into the scrollback buffer.
1061		1591
1062	=item $term->want_refresh	1592	=item $term->want_refresh
1063		1593
1064	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1594	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1067		1597
1068	Used after changing terminal contents to display them.	1598	Used after changing terminal contents to display them.
1069		1599
1070	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1600	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1071		1601
1072	Returns the text of the entire row with number C<$row_number>. Row C<0>	1602	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1073	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1603	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1074	terminal line. The scrollback buffer starts at line C<-1> and extends to
1075	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1604	terminal line. Nothing will be returned if a nonexistent line
1076	is requested.	1605	is requested.
1077		1606
1078	If C<$new_text> is specified, it will replace characters in the current	1607	If C<$new_text> is specified, it will replace characters in the current
1079	line, starting at column C<$start_col> (default C<0>), which is useful	1608	line, starting at column C<$start_col> (default C<0>), which is useful
1080	to replace only parts of a line. The font index in the rendition will	1609	to replace only parts of a line. The font index in the rendition will
1081	automatically be updated.	1610	automatically be updated.
1082		1611
1083	C<$text> is in a special encoding: tabs and wide characters that use more	1612	C<$text> is in a special encoding: tabs and wide characters that use more
1084	than one cell when displayed are padded with urxvt::NOCHAR characters	1613	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1085	(C<chr 65535>). Characters with combining characters and other characters	1614	characters. Characters with combining characters and other characters that
1086	that do not fit into the normal tetx encoding will be replaced with	1615	do not fit into the normal text encoding will be replaced with characters
1087	characters in the private use area.	1616	in the private use area.
1088		1617
1089	You have to obey this encoding when changing text. The advantage is	1618	You have to obey this encoding when changing text. The advantage is
1090	that C<substr> and similar functions work on screen cells and not on	1619	that C<substr> and similar functions work on screen cells and not on
1091	characters.	1620	characters.
1092		1621
…		…
1143	Return the row number of the first/last row of the line, respectively.	1672	Return the row number of the first/last row of the line, respectively.
1144		1673
1145	=item $offset = $line->offset_of ($row, $col)	1674	=item $offset = $line->offset_of ($row, $col)
1146		1675
1147	Returns the character offset of the given row|col pair within the logical	1676	Returns the character offset of the given row|col pair within the logical
1148	line.	1677	line. Works for rows outside the line, too, and returns corresponding
		1678	offsets outside the string.
1149		1679
1150	=item ($row, $col) = $line->coord_of ($offset)	1680	=item ($row, $col) = $line->coord_of ($offset)
1151		1681
1152	Translates a string offset into terminal coordinates again.	1682	Translates a string offset into terminal coordinates again.
1153		1683
…		…
1235	where one character corresponds to one screen cell. See	1765	where one character corresponds to one screen cell. See
1236	C<< $term->ROW_t >> for details.	1766	C<< $term->ROW_t >> for details.
1237		1767
1238	=item $string = $term->special_decode $text	1768	=item $string = $term->special_decode $text
1239		1769
1240	Converts rxvt-unicodes text reprsentation into a perl string. See	1770	Converts rxvt-unicodes text representation into a perl string. See
1241	C<< $term->ROW_t >> for details.	1771	C<< $term->ROW_t >> for details.
1242		1772
1243	=item $success = $term->grab_button ($button, $modifiermask)	1773	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1244		1774
		1775	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1776
1245	Registers a synchronous button grab. See the XGrabButton manpage.	1777	Register/unregister a synchronous button grab. See the XGrabButton
		1778	manpage.
1246		1779
1247	=item $success = $term->grab ($eventtime[, $sync])	1780	=item $success = $term->grab ($eventtime[, $sync])
1248		1781
1249	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1782	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1250	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1783	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1251		1784
1252	=item $term->allow_events_async	1785	=item $term->allow_events_async
1253		1786
1254	Calls XAllowEvents with AsyncBoth for the most recent grab.	1787	Calls XAllowEvents with AsyncBoth for the most recent grab.
1255		1788
…		…
1266		1799
1267	Calls XUngrab for the most recent grab. Is called automatically on	1800	Calls XUngrab for the most recent grab. Is called automatically on
1268	evaluation errors, as it is better to lose the grab in the error case as	1801	evaluation errors, as it is better to lose the grab in the error case as
1269	the session.	1802	the session.
1270		1803
		1804	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1805
		1806	=item $atom_name = $term->XGetAtomName ($atom)
		1807
		1808	=item @atoms = $term->XListProperties ($window)
		1809
		1810	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1811
		1812	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1813
		1814	=item $term->XDeleteProperty ($window, $property)
		1815
		1816	=item $window = $term->DefaultRootWindow
		1817
		1818	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1819
		1820	=item $term->XMapWindow ($window)
		1821
		1822	=item $term->XUnmapWindow ($window)
		1823
		1824	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1825
		1826	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1827
		1828	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1829
		1830	Various X or X-related functions. The C<$term> object only serves as
		1831	the source of the display, otherwise those functions map more-or-less
		1832	directory onto the X functions of the same name.
		1833
1271	=back	1834	=back
1272		1835
1273	=cut	1836	=cut
1274		1837
1275	package urxvt::popup;	1838	package urxvt::popup;
…		…
1289		1852
1290	$item->{render} ||= sub { $_[0]{text} };	1853	$item->{render} ||= sub { $_[0]{text} };
1291		1854
1292	push @{ $self->{item} }, $item;	1855	push @{ $self->{item} }, $item;
1293	}	1856	}
		1857
		1858	=item $popup->add_title ($title)
		1859
		1860	Adds a non-clickable title to the popup.
		1861
		1862	=cut
		1863
		1864	sub add_title {
		1865	my ($self, $title) = @_;
		1866
		1867	$self->add_item ({
		1868	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1869	text => $title,
		1870	activate => sub { },
		1871	});
		1872	}
		1873
		1874	=item $popup->add_separator ([$sepchr])
		1875
		1876	Creates a separator, optionally using the character given as C<$sepchr>.
		1877
		1878	=cut
1294		1879
1295	sub add_separator {	1880	sub add_separator {
1296	my ($self, $sep) = @_;	1881	my ($self, $sep) = @_;
1297		1882
1298	$sep ||= "=";	1883	$sep ||= "=";
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1888	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1889	activate => sub { },
1305	});	1890	});
1306	}	1891	}
1307		1892
1308	sub add_title {	1893	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1894
1311	$self->add_item ({	1895	Adds a clickable button to the popup. C<$cb> is called whenever it is
1312	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1896	selected.
1313	text => $title,	1897
1314	activate => sub { },	1898	=cut
1315	});
1316	}
1317		1899
1318	sub add_button {	1900	sub add_button {
1319	my ($self, $text, $cb) = @_;	1901	my ($self, $text, $cb) = @_;
1320		1902
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1903	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	1904	}
1323		1905
		1906	=item $popup->add_toggle ($text, $initial_value, $cb)
		1907
		1908	Adds a toggle/checkbox item to the popup. The callback gets called
		1909	whenever it gets toggled, with a boolean indicating its new value as its
		1910	first argument.
		1911
		1912	=cut
		1913
1324	sub add_toggle {	1914	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	1915	my ($self, $text, $value, $cb) = @_;
1326		1916
1327	my $item; $item = {	1917	my $item; $item = {
1328	type => "button",	1918	type => "button",
1329	text => " $text",	1919	text => " $text",
1330	value => $value,	1920	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1921	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1922	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	1923	};
1334		1924
1335	$self->add_item ($item);	1925	$self->add_item ($item);
1336	}	1926	}
		1927
		1928	=item $popup->show
		1929
		1930	Displays the popup (which is initially hidden).
		1931
		1932	=cut
1337		1933
1338	sub show {	1934	sub show {
1339	my ($self) = @_;	1935	my ($self) = @_;
1340		1936
1341	local $urxvt::popup::self = $self;	1937	local $urxvt::popup::self = $self;
1342		1938
		1939	my $env = $self->{term}->env;
		1940	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1941	delete $env->{LC_ALL};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	1942	$env->{LC_CTYPE} = $self->{term}->locale;
1344		1943
1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1944	my $term = urxvt::term->new (
		1945	$env, "popup",
		1946	"--perl-lib" => "", "--perl-ext-common" => "",
		1947	"-pty-fd" => -1, "-sl" => 0,
		1948	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1346	"--transient-for" => $self->{term}->parent,	1949	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	1950	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	1951	"-pe" => "urxvt-popup",
1349	or die "unable to create popup window\n";	1952	) or die "unable to create popup window\n";
		1953
		1954	unless (delete $term->{urxvt_popup_init_done}) {
		1955	$term->ungrab;
		1956	$term->destroy;
		1957	die "unable to initialise popup window\n";
		1958	}
1350	}	1959	}
1351		1960
1352	sub DESTROY {	1961	sub DESTROY {
1353	my ($self) = @_;	1962	my ($self) = @_;
1354		1963
1355	delete $self->{term}{_destroy}{$self};	1964	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	1965	$self->{term}->ungrab;
1357	}	1966	}
		1967
		1968	=back
		1969
		1970	=cut
		1971
		1972	package urxvt::watcher;
1358		1973
1359	=head2 The C<urxvt::timer> Class	1974	=head2 The C<urxvt::timer> Class
1360		1975
1361	This class implements timer watchers/events. Time is represented as a	1976	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	1977	fractional number of seconds since the epoch. Example:
…		…
1366	->new	1981	->new
1367	->interval (1)	1982	->interval (1)
1368	->cb (sub {	1983	->cb (sub {
1369	$term->{overlay}->set (0, 0,	1984	$term->{overlay}->set (0, 0,
1370	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1985	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1371	});	1986	});
1372		1987
1373	=over 4	1988	=over 4
1374		1989
1375	=item $timer = new urxvt::timer	1990	=item $timer = new urxvt::timer
1376		1991
…		…
1400	Start the timer.	2015	Start the timer.
1401		2016
1402	=item $timer = $timer->start ($tstamp)	2017	=item $timer = $timer->start ($tstamp)
1403		2018
1404	Set the event trigger time to C<$tstamp> and start the timer.	2019	Set the event trigger time to C<$tstamp> and start the timer.
		2020
		2021	=item $timer = $timer->after ($delay)
		2022
		2023	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1405		2024
1406	=item $timer = $timer->stop	2025	=item $timer = $timer->stop
1407		2026
1408	Stop the timer.	2027	Stop the timer.
1409		2028
…		…
1415		2034
1416	$term->{socket} = ...	2035	$term->{socket} = ...
1417	$term->{iow} = urxvt::iow	2036	$term->{iow} = urxvt::iow
1418	->new	2037	->new
1419	->fd (fileno $term->{socket})	2038	->fd (fileno $term->{socket})
1420	->events (urxvt::EVENT_READ)	2039	->events (urxvt::EV_READ)
1421	->start	2040	->start
1422	->cb (sub {	2041	->cb (sub {
1423	my ($iow, $revents) = @_;	2042	my ($iow, $revents) = @_;
1424	# $revents must be 1 here, no need to check	2043	# $revents must be 1 here, no need to check
1425	sysread $term->{socket}, my $buf, 8192	2044	sysread $term->{socket}, my $buf, 8192
…		…
1438	Set the callback to be called when io events are triggered. C<$reventmask>	2057	Set the callback to be called when io events are triggered. C<$reventmask>
1439	is a bitset as described in the C<events> method.	2058	is a bitset as described in the C<events> method.
1440		2059
1441	=item $iow = $iow->fd ($fd)	2060	=item $iow = $iow->fd ($fd)
1442		2061
1443	Set the filedescriptor (not handle) to watch.	2062	Set the file descriptor (not handle) to watch.
1444		2063
1445	=item $iow = $iow->events ($eventmask)	2064	=item $iow = $iow->events ($eventmask)
1446		2065
1447	Set the event mask to watch. The only allowed values are	2066	Set the event mask to watch. The only allowed values are
1448	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2067	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1449	together, or C<urxvt::EVENT_NONE>.	2068	together, or C<urxvt::EV_NONE>.
1450		2069
1451	=item $iow = $iow->start	2070	=item $iow = $iow->start
1452		2071
1453	Start watching for requested events on the given handle.	2072	Start watching for requested events on the given handle.
1454		2073
1455	=item $iow = $iow->stop	2074	=item $iow = $iow->stop
1456		2075
1457	Stop watching for events on the given filehandle.	2076	Stop watching for events on the given file handle.
		2077
		2078	=back
		2079
		2080	=head2 The C<urxvt::iw> Class
		2081
		2082	This class implements idle watchers, that get called automatically when
		2083	the process is idle. They should return as fast as possible, after doing
		2084	some useful work.
		2085
		2086	=over 4
		2087
		2088	=item $iw = new urxvt::iw
		2089
		2090	Create a new idle watcher object in stopped state.
		2091
		2092	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2093
		2094	Set the callback to be called when the watcher triggers.
		2095
		2096	=item $timer = $timer->start
		2097
		2098	Start the watcher.
		2099
		2100	=item $timer = $timer->stop
		2101
		2102	Stop the watcher.
		2103
		2104	=back
		2105
		2106	=head2 The C<urxvt::pw> Class
		2107
		2108	This class implements process watchers. They create an event whenever a
		2109	process exits, after which they stop automatically.
		2110
		2111	my $pid = fork;
		2112	...
		2113	$term->{pw} = urxvt::pw
		2114	->new
		2115	->start ($pid)
		2116	->cb (sub {
		2117	my ($pw, $exit_status) = @_;
		2118	...
		2119	});
		2120
		2121	=over 4
		2122
		2123	=item $pw = new urxvt::pw
		2124
		2125	Create a new process watcher in stopped state.
		2126
		2127	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2128
		2129	Set the callback to be called when the timer triggers.
		2130
		2131	=item $pw = $timer->start ($pid)
		2132
		2133	Tells the watcher to start watching for process C<$pid>.
		2134
		2135	=item $pw = $pw->stop
		2136
		2137	Stop the watcher.
1458		2138
1459	=back	2139	=back
1460		2140
1461	=head1 ENVIRONMENT	2141	=head1 ENVIRONMENT
1462		2142
…		…
1469		2149
1470	=item == 0 - fatal messages	2150	=item == 0 - fatal messages
1471		2151
1472	=item >= 3 - script loading and management	2152	=item >= 3 - script loading and management
1473		2153
1474	=item >=10 - all events received	2154	=item >=10 - all called hooks
		2155
		2156	=item >=11 - hook return values
1475		2157
1476	=back	2158	=back
1477		2159
1478	=head1 AUTHOR	2160	=head1 AUTHOR
1479		2161
…		…
1481	http://software.schmorp.de/pkg/rxvt-unicode	2163	http://software.schmorp.de/pkg/rxvt-unicode
1482		2164
1483	=cut	2165	=cut
1484		2166
1485	1	2167	1
		2168
		2169	# vim: sw=3:

Diff Legend

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