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.154 by root, Sat Jun 2 06:43:02 2007 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,automove-background,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	It's 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	It's 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 be" => 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.
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 (the 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	Example configuration:
		265
		266	URxvt.perl-ext: default,matcher
		267	URxvt.urlLauncher: sensible-browser
		268	URxvt.keysym.C-Delete: perl:matcher
		269	URxvt.matcher.button: 1
		270	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		271	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		272	URxvt.matcher.launcher.2: gvim +$2 $1
		273
		274	=item xim-onthespot
		275
		276	This (experimental) perl extension implements OnTheSpot editing. It does
		277	not work perfectly, and some input methods don't seem to work well with
		278	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		279	kinput2.
		280
		281	You enable it by specifying this extension and a preedit style of
		282	C<OnTheSpot>, i.e.:
		283
		284	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		285
		286	=item kuake<hotkey>
		287
		288	A very primitive quake-console-like extension. It was inspired by a
		289	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		290	user presses a global accelerator key (by default C<F10>), the terminal
		291	will show or hide itself. Another press of the accelerator key will hide
		292	or show it again.
		293
		294	Initially, the window will not be shown when using this extension.
		295
		296	This is useful if you need a single terminal thats not using any desktop
		297	space most of the time but is quickly available at the press of a key.
		298
		299	The accelerator key is grabbed regardless of any modifiers, so this
		300	extension will actually grab a physical key just for this function.
		301
		302	If you want a quake-like animation, tell your window manager to do so
		303	(fvwm can do it).
		304
		305	=item automove-background
		306
		307	This is basically a very small extension that dynamically changes the
		308	background pixmap offset to the window position, in effect creating the
		309	same effect as pseudo transparency with a custom pixmap. No scaling is
		310	supported in this mode. Example:
		311
		312	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		313
		314	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
		315	shows how this extension can be used to implement an automatically blurred
		316	transparent background.
89		317
90	=item block-graphics-to-ascii	318	=item block-graphics-to-ascii
91		319
92	A not very useful example of filtering all text output to the terminal,	320	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	321	by replacing all line-drawing characters (U+2500 .. U+259F) by a
94	similar-looking ascii character.	322	similar-looking ascii character.
		323
		324	=item digital-clock
		325
		326	Displays a digital clock using the built-in overlay.
		327
		328	=item remote-clipboard
		329
		330	Somewhat of a misnomer, this extension adds two menu entries to the
		331	selection popup that allows one ti run external commands to store the
		332	selection somewhere and fetch it again.
		333
		334	We use it to implement a "distributed selection mechanism", which just
		335	means that one command uploads the file to a remote server, and another
		336	reads it.
		337
		338	The commands can be set using the C<URxvt.remote-selection.store> and
		339	C<URxvt.remote-selection.fetch> resources. The first should read the
		340	selection to store from STDIN (always in UTF-8), the second should provide
		341	the selection data on STDOUT (also in UTF-8).
		342
		343	The defaults (which are likely useless to you) use rsh and cat:
		344
		345	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		346	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		347
		348	=item selection-pastebin
		349
		350	This is a little rarely useful extension that Uploads the selection as
		351	textfile to a remote site (or does other things). (The implementation is
		352	not currently secure for use in a multiuser environment as it writes to
		353	F</tmp> directly.).
		354
		355	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		356	i.e.
		357
		358	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		359
		360	Pressing this combination runs a command with C<%> replaced by the name of
		361	the textfile. This command can be set via a resource:
		362
		363	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		364
		365	And the default is likely not useful to anybody but the few people around
		366	here :)
		367
		368	The name of the textfile is the hex encoded md5 sum of the selection, so
		369	the same content should lead to the same filename.
		370
		371	After a successful upload the selection will be replaced by the text given
		372	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		373	for the filename):
		374
		375	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		376
		377	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		378	the double C</> characters as comment start. Use C<\057\057> instead,
		379	which works regardless of wether xrdb is used to parse the resource file
		380	or not.
95		381
96	=item example-refresh-hooks	382	=item example-refresh-hooks
97		383
98	Displays a very simple digital clock in the upper right corner of the	384	Displays a very simple digital clock in the upper right corner of the
99	window. Illustrates overwriting the refresh callbacks to create your own	385	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	386	overlays or changes.
101		387
102	=back	388	=back
		389
		390	=head1 API DOCUMENTATION
103		391
104	=head2 General API Considerations	392	=head2 General API Considerations
105		393
106	All objects (such as terminals, time watchers etc.) are typical	394	All objects (such as terminals, time watchers etc.) are typical
107	reference-to-hash objects. The hash can be used to store anything you	395	reference-to-hash objects. The hash can be used to store anything you
…		…
120	=over 4	408	=over 4
121		409
122	=item $text	410	=item $text
123		411
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	412	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.	413	always represents one screen cell. See L<ROW_t> for a discussion of this format.
126		414
127	=item $string	415	=item $string
128		416
129	A perl text string, with an emphasis on I<text>. It can store all unicode	417	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	418	characters and is to be distinguished with text encoded in a specific
…		…
137		425
138	=back	426	=back
139		427
140	=head2 Extension Objects	428	=head2 Extension Objects
141		429
142	Very perl extension is a perl class. A separate perl object is created	430	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	431	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	432	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	433	their C<$self> object without having to think about clashes with other
		434	extensions or other terminals, with the exception of methods and members
146	begin with an underscore character C<_>: these are reserved for internal	435	that begin with an underscore character C<_>: these are reserved for
147	use.	436	internal use.
148		437
149	Although it isn't a C<urxvt::term> object, you can call all methods of the	438	Although it isn't a C<urxvt::term> object, you can call all methods of the
150	C<urxvt::term> class on this object.	439	C<urxvt::term> class on this object.
151		440
152	It has the following methods and data members:	441	It has the following methods and data members:
…		…
173	=head2 Hooks	462	=head2 Hooks
174		463
175	The following subroutines can be declared in extension files, and will be	464	The following subroutines can be declared in extension files, and will be
176	called whenever the relevant event happens.	465	called whenever the relevant event happens.
177		466
178	The first argument passed to them is an extension oject as described in	467	The first argument passed to them is an extension object as described in
179	the in the C<Extension Objects> section.	468	the in the C<Extension Objects> section.
180		469
181	B<All> of these hooks must return a boolean value. If it is true, then the	470	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	471	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.	472	relevant action might not be carried out by the C++ code.
184		473
185	I<< When in doubt, return a false value (preferably C<()>). >>	474	I<< When in doubt, return a false value (preferably C<()>). >>
186		475
187	=over 4	476	=over 4
188		477
189	=item on_init $term	478	=item on_init $term
190		479
191	Called after a new terminal object has been initialized, but before	480	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	481	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	482	call or deliver senseless data, as terminal size and other characteristics
194	have not yet been determined. You can safely query and change resources,	483	have not yet been determined. You can safely query and change resources
195	though.	484	and options, though. For many purposes the C<on_start> hook is a better
		485	place.
		486
		487	=item on_start $term
		488
		489	Called at the very end of initialisation of a new terminal, just before
		490	trying to map (display) the toplevel and returning to the main loop.
		491
		492	=item on_destroy $term
		493
		494	Called whenever something tries to destroy terminal, when the terminal is
		495	still fully functional (not for long, though).
196		496
197	=item on_reset $term	497	=item on_reset $term
198		498
199	Called after the screen is "reset" for any reason, such as resizing or	499	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	500	control sequences. Here is where you can react on changes to size-related
201	variables.	501	variables.
202		502
203	=item on_start $term	503	=item on_child_start $term, $pid
204		504
205	Called at the very end of initialisation of a new terminal, just before	505	Called just after the child process has been C<fork>ed.
206	returning to the mainloop.	506
		507	=item on_child_exit $term, $status
		508
		509	Called just after the child process has exited. C<$status> is the status
		510	from C<waitpid>.
207		511
208	=item on_sel_make $term, $eventtime	512	=item on_sel_make $term, $eventtime
209		513
210	Called whenever a selection has been made by the user, but before the	514	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	515	selection text is copied, so changes to the beginning, end or type of the
…		…
218		522
219	Called whenever a selection has been copied, but before the selection is	523	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	524	requested from the server. The selection text can be queried and changed
221	by calling C<< $term->selection >>.	525	by calling C<< $term->selection >>.
222		526
223	Returning a true value aborts selection grabbing. It will still be hilighted.	527	Returning a true value aborts selection grabbing. It will still be highlighted.
224		528
225	=item on_sel_extend $term	529	=item on_sel_extend $term
226		530
227	Called whenever the user tries to extend the selection (e.g. with a double	531	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	532	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	533	should extend the selection itself and return true to suppress the built-in
230	processing.	534	processing. This can happen multiple times, as long as the callback
		535	returns true, it will be called on every further click by the user and is
		536	supposed to enlarge the selection more and more, if possible.
231		537
232	See the F<selection> example extension.	538	See the F<selection> example extension.
233		539
234	=item on_view_change $term, $offset	540	=item on_view_change $term, $offset
235		541
236	Called whenever the view offset changes, i..e the user or program	542	Called whenever the view offset changes, i.e. the user or program
237	scrolls. Offset C<0> means display the normal terminal, positive values	543	scrolls. Offset C<0> means display the normal terminal, positive values
238	show this many lines of scrollback.	544	show this many lines of scrollback.
239		545
240	=item on_scroll_back $term, $lines, $saved	546	=item on_scroll_back $term, $lines, $saved
241		547
…		…
245		551
246	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	552	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	553	$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.	554	number of lines that will be in the scrollback buffer.
249		555
		556	=item on_osc_seq $term, $op, $args
		557
		558	Called on every OSC sequence and can be used to suppress it or modify its
		559	behaviour. The default should be to return an empty list. A true value
		560	suppresses execution of the request completely. Make sure you don't get
		561	confused by recursive invocations when you output an osc sequence within
		562	this callback.
		563
		564	C<on_osc_seq_perl> should be used for new behaviour.
		565
250	=item on_osc_seq $term, $string	566	=item on_osc_seq_perl $term, $string
251		567
252	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	568	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
253	operating system command) is processed. Cursor position and other state	569	operating system command) is processed. Cursor position and other state
254	information is up-to-date when this happens. For interoperability, the	570	information is up-to-date when this happens. For interoperability, the
255	string should start with the extension name and a colon, to distinguish	571	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	572	it from commands for other extensions, and this might be enforced in the
257	future.	573	future.
258		574
259	Be careful not ever to trust (in a security sense) the data you receive,	575	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	576	as its source can not easily be controlled (e-mail content, messages from
261	other users on the same system etc.).	577	other users on the same system etc.).
262		578
263	=item on_add_lines $term, $string	579	=item on_add_lines $term, $string
264		580
265	Called whenever text is about to be output, with the text as argument. You	581	Called whenever text is about to be output, with the text as argument. You
…		…
296		612
297	=item on_refresh_end $term	613	=item on_refresh_end $term
298		614
299	Called just after the screen gets redrawn. See C<on_refresh_begin>.	615	Called just after the screen gets redrawn. See C<on_refresh_begin>.
300		616
301	=item on_keyboard_command $term, $string	617	=item on_user_command $term, $string
302		618
303	Called whenever the user presses a key combination that has a	619	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>	620	a C<perl:string> action bound to a key, see description of the B<keysym>
305	resource in the @@RXVT_NAME@@(1) manpage).	621	resource in the @@RXVT_NAME@@(1) manpage).
		622
		623	The event is simply the action string. This interface is assumed to change
		624	slightly in the future.
		625
		626	=item on_resize_all_windows $tern, $new_width, $new_height
		627
		628	Called just after the new window size has been calculated, but before
		629	windows are actually being resized or hints are being set. If this hook
		630	returns TRUE, setting of the window hints is being skipped.
		631
		632	=item on_x_event $term, $event
		633
		634	Called on every X event received on the vt window (and possibly other
		635	windows). Should only be used as a last resort. Most event structure
		636	members are not passed.
		637
		638	=item on_root_event $term, $event
		639
		640	Like C<on_x_event>, but is called for events on the root window.
306		641
307	=item on_focus_in $term	642	=item on_focus_in $term
308		643
309	Called whenever the window gets the keyboard focus, before rxvt-unicode	644	Called whenever the window gets the keyboard focus, before rxvt-unicode
310	does focus in processing.	645	does focus in processing.
311		646
312	=item on_focus_out $term	647	=item on_focus_out $term
313		648
314	Called wheneever the window loses keyboard focus, before rxvt-unicode does	649	Called whenever the window loses keyboard focus, before rxvt-unicode does
315	focus out processing.	650	focus out processing.
		651
		652	=item on_configure_notify $term, $event
		653
		654	=item on_property_notify $term, $event
316		655
317	=item on_key_press $term, $event, $keysym, $octets	656	=item on_key_press $term, $event, $keysym, $octets
318		657
319	=item on_key_release $term, $event, $keysym	658	=item on_key_release $term, $event, $keysym
320		659
…		…
330		669
331	Called whenever the corresponding X event is received for the terminal If	670	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.	671	the hook returns true, then the even will be ignored by rxvt-unicode.
333		672
334	The event is a hash with most values as named by Xlib (see the XEvent	673	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	674	manpage), with the additional members C<row> and C<col>, which are the
336	and column under the mouse cursor.	675	(real, not screen-based) row and column under the mouse cursor.
337		676
338	C<on_key_press> additionally receives the string rxvt-unicode would	677	C<on_key_press> additionally receives the string rxvt-unicode would
339	output, if any, in locale-specific encoding.	678	output, if any, in locale-specific encoding.
340		679
341	subwindow.	680	subwindow.
342		681
343	=back	682	=item on_client_message $term, $event
344		683
345	=head2 Variables in the C<urxvt> Package	684	=item on_wm_protocols $term, $event
346		685
347	=over 4	686	=item on_wm_delete_window $term, $event
348		687
349	=item $urxvt::TERM	688	Called when various types of ClientMessage events are received (all with
350		689	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		690
453	=back	691	=back
454		692
455	=cut	693	=cut
456		694
…		…
462	use Scalar::Util ();	700	use Scalar::Util ();
463	use List::Util ();	701	use List::Util ();
464		702
465	our $VERSION = 1;	703	our $VERSION = 1;
466	our $TERM;	704	our $TERM;
		705	our @TERM_INIT;
		706	our @TERM_EXT;
467	our @HOOKNAME;	707	our @HOOKNAME;
468	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	708	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
469	our %OPTION;	709	our %OPTION;
470		710
471	our $LIBDIR;	711	our $LIBDIR;
472	our $RESNAME;	712	our $RESNAME;
473	our $RESCLASS;	713	our $RESCLASS;
474	our $RXVTNAME;	714	our $RXVTNAME;
475		715
		716	our $NOCHAR = chr 0xffff;
		717
		718	=head2 Variables in the C<urxvt> Package
		719
		720	=over 4
		721
		722	=item $urxvt::LIBDIR
		723
		724	The rxvt-unicode library directory, where, among other things, the perl
		725	modules and scripts are stored.
		726
		727	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		728
		729	The resource class and name rxvt-unicode uses to look up X resources.
		730
		731	=item $urxvt::RXVTNAME
		732
		733	The basename of the installed binaries, usually C<urxvt>.
		734
		735	=item $urxvt::TERM
		736
		737	The current terminal. This variable stores the current C<urxvt::term>
		738	object, whenever a callback/hook is executing.
		739
		740	=item @urxvt::TERM_INIT
		741
		742	All code references in this array will be called as methods of the next newly
		743	created C<urxvt::term> object (during the C<on_init> phase). The array
		744	gets cleared before the code references that were in it are being executed,
		745	so references can push themselves onto it again if they so desire.
		746
		747	This complements to the perl-eval command line option, but gets executed
		748	first.
		749
		750	=item @urxvt::TERM_EXT
		751
		752	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		753	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		754	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		755
		756	=back
		757
		758	=head2 Functions in the C<urxvt> Package
		759
		760	=over 4
		761
		762	=item urxvt::fatal $errormessage
		763
		764	Fatally aborts execution with the given error message. Avoid at all
		765	costs! The only time this is acceptable is when the terminal process
		766	starts up.
		767
		768	=item urxvt::warn $string
		769
		770	Calls C<rxvt_warn> with the given string which should not include a
		771	newline. The module also overwrites the C<warn> builtin with a function
		772	that calls this function.
		773
		774	Using this function has the advantage that its output ends up in the
		775	correct place, e.g. on stderr of the connecting urxvtc client.
		776
		777	Messages have a size limit of 1023 bytes currently.
		778
		779	=item @terms = urxvt::termlist
		780
		781	Returns all urxvt::term objects that exist in this process, regardless of
		782	whether they are started, being destroyed etc., so be careful. Only term
		783	objects that have perl extensions attached will be returned (because there
		784	is no urxvt::term objet associated with others).
		785
		786	=item $time = urxvt::NOW
		787
		788	Returns the "current time" (as per the event loop).
		789
		790	=item urxvt::CurrentTime
		791
		792	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		793	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		794	Button4Mask, Button5Mask, AnyModifier
		795
		796	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		797	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		798	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		799	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		800	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		801	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		802	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		803
		804	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		805	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		806	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		807	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		808	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		809	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		810	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		811
		812	Various constants for use in X calls and event processing.
		813
		814	=back
		815
		816	=head2 RENDITION
		817
		818	Rendition bitsets contain information about colour, font, font styles and
		819	similar information for each screen cell.
		820
		821	The following "macros" deal with changes in rendition sets. You should
		822	never just create a bitset, you should always modify an existing one,
		823	as they contain important information required for correct operation of
		824	rxvt-unicode.
		825
		826	=over 4
		827
		828	=item $rend = urxvt::DEFAULT_RSTYLE
		829
		830	Returns the default rendition, as used when the terminal is starting up or
		831	being reset. Useful as a base to start when creating renditions.
		832
		833	=item $rend = urxvt::OVERLAY_RSTYLE
		834
		835	Return the rendition mask used for overlays by default.
		836
		837	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		838
		839	Return the bit that enabled bold, italic, blink, reverse-video and
		840	underline, respectively. To enable such a style, just logically OR it into
		841	the bitset.
		842
		843	=item $foreground = urxvt::GET_BASEFG $rend
		844
		845	=item $background = urxvt::GET_BASEBG $rend
		846
		847	Return the foreground/background colour index, respectively.
		848
		849	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		850
		851	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		852
		853	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		854
		855	Replace the foreground/background colour in the rendition mask with the
		856	specified one.
		857
		858	=item $value = urxvt::GET_CUSTOM $rend
		859
		860	Return the "custom" value: Every rendition has 5 bits for use by
		861	extensions. They can be set and changed as you like and are initially
		862	zero.
		863
		864	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		865
		866	Change the custom value.
		867
		868	=back
		869
		870	=cut
		871
476	BEGIN {	872	BEGIN {
477	urxvt->bootstrap;
478
479	# overwrite perl's warn	873	# overwrite perl's warn
480	*CORE::GLOBAL::warn = sub {	874	*CORE::GLOBAL::warn = sub {
481	my $msg = join "", @_;	875	my $msg = join "", @_;
482	$msg .= "\n"	876	$msg .= "\n"
483	unless $msg =~ /\n$/;	877	unless $msg =~ /\n$/;
484	urxvt::warn ($msg);	878	urxvt::warn ($msg);
485	};	879	};
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	}	880	}
492		881
493	my @hook_count;	882	no warnings 'utf8';
		883
494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	884	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
495		885
496	sub verbose {	886	sub verbose {
497	my ($level, $msg) = @_;	887	my ($level, $msg) = @_;
498	warn "$msg\n" if $level <= $verbosity;	888	warn "$msg\n" if $level <= $verbosity;
499	}	889	}
500		890
501	my $extension_pkg = "extension0000";
502	my %extension_pkg;	891	my %extension_pkg;
503		892
504	# load a single script into its own package, once only	893	# load a single script into its own package, once only
505	sub extension_package($) {	894	sub extension_package($) {
506	my ($path) = @_;	895	my ($path) = @_;
507		896
508	$extension_pkg{$path} ||= do {	897	$extension_pkg{$path} ||= do {
509	my $pkg = "urxvt::" . ($extension_pkg++);	898	$path =~ /([^\/\\]+)$/;
		899	my $pkg = $1;
		900	$pkg =~ s/[^[:word:]]/_/g;
		901	$pkg = "urxvt::ext::$pkg";
510		902
511	verbose 3, "loading extension '$path' into package '$pkg'";	903	verbose 3, "loading extension '$path' into package '$pkg'";
512		904
513	open my $fh, "<:raw", $path	905	open my $fh, "<:raw", $path
514	or die "$path: $!";	906	or die "$path: $!";
515		907
516	my $source = untaint	908	my $source =
517	"package $pkg; use strict; use utf8;\n"	909	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
518	. "use base urxvt::term::extension::;\n"
519	. "#line 1 \"$path\"\n{\n"	910	. "#line 1 \"$path\"\n{\n"
520	. (do { local $/; <$fh> })	911	. (do { local $/; <$fh> })
521	. "\n};\n1";	912	. "\n};\n1";
522		913
523	eval $source	914	eval $source
…		…
537	if ($htype == 0) { # INIT	928	if ($htype == 0) { # INIT
538	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	929	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
539		930
540	my %ext_arg;	931	my %ext_arg;
541		932
		933	{
		934	my @init = @TERM_INIT;
		935	@TERM_INIT = ();
		936	$_->($TERM) for @init;
		937	my @pkg = @TERM_EXT;
		938	@TERM_EXT = ();
		939	$TERM->register_package ($_) for @pkg;
		940	}
		941
542	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	942	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
543	if ($_ eq "default") {	943	if ($_ eq "default") {
544	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	944	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
545	} elsif (/^-(.*)$/) {	945	} elsif (/^-(.*)$/) {
546	delete $ext_arg{$1};	946	delete $ext_arg{$1};
547	} elsif (/^([^<]+)<(.*)>$/) {	947	} elsif (/^([^<]+)<(.*)>$/) {
548	push @{ $ext_arg{$1} }, $2;	948	push @{ $ext_arg{$1} }, $2;
549	} else {	949	} else {
550	$ext_arg{$_} ||= [];	950	$ext_arg{$_} ||= [];
551	}	951	}
552	}	952	}
553		953
554	while (my ($ext, $argv) = each %ext_arg) {	954	for my $ext (sort keys %ext_arg) {
555	my @files = grep -f $_, map "$_/$ext", @dirs;	955	my @files = grep -f $_, map "$_/$ext", @dirs;
556		956
557	if (@files) {	957	if (@files) {
558	$TERM->register_package (extension_package $files[0], $argv);	958	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
559	} else {	959	} else {
560	warn "perl extension '$ext' not found in perl library search path\n";	960	warn "perl extension '$ext' not found in perl library search path\n";
561	}	961	}
562	}	962	}
563		963
…		…
569		969
570	if (my $cb = $TERM->{_hook}[$htype]) {	970	if (my $cb = $TERM->{_hook}[$htype]) {
571	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	971	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
572	if $verbosity >= 10;	972	if $verbosity >= 10;
573		973
574	keys %$cb;	974	for my $pkg (keys %$cb) {
575
576	while (my ($pkg, $cb) = each %$cb) {
577	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	975	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
578	and last;	976	$retval ||= $retval_;
579		977
580	if ($@) {	978	if ($@) {
581	$TERM->ungrab; # better to lose the grab than the session	979	$TERM->ungrab; # better to lose the grab than the session
582	warn $@;	980	warn $@;
583	}	981	}
584	}	982	}
		983
		984	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		985	if $verbosity >= 11;
585	}	986	}
586		987
587	if ($htype == 1) { # DESTROY	988	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	989	# clear package objects
596	%$_ = () for values %{ $TERM->{_pkg} };	990	%$_ = () for values %{ $TERM->{_pkg} };
597		991
598	# clear package	992	# clear package
599	%$TERM = ();	993	%$TERM = ();
600	}	994	}
601		995
602	$retval	996	$retval
		997	}
		998
		999	sub SET_COLOR($$$) {
		1000	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1001	}
		1002
		1003	sub rend2mask {
		1004	no strict 'refs';
		1005	my ($str, $mask) = (@_, 0);
		1006	my %color = ( fg => undef, bg => undef );
		1007	my @failed;
		1008	for my $spec ( split /\s+/, $str ) {
		1009	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1010	$color{lc($1)} = $2;
		1011	} else {
		1012	my $neg = $spec =~ s/^[-^]//;
		1013	unless ( exists &{"RS_$spec"} ) {
		1014	push @failed, $spec;
		1015	next;
		1016	}
		1017	my $cur = &{"RS_$spec"};
		1018	if ( $neg ) {
		1019	$mask &= ~$cur;
		1020	} else {
		1021	$mask |= $cur;
		1022	}
		1023	}
		1024	}
		1025	($mask, @color{qw(fg bg)}, \@failed)
603	}	1026	}
604		1027
605	# urxvt::term::extension	1028	# urxvt::term::extension
606		1029
607	package urxvt::term::extension;	1030	package urxvt::term::extension;
…		…
613	while (my ($name, $cb) = each %hook) {	1036	while (my ($name, $cb) = each %hook) {
614	my $htype = $HOOKTYPE{uc $name};	1037	my $htype = $HOOKTYPE{uc $name};
615	defined $htype	1038	defined $htype
616	or Carp::croak "unsupported hook type '$name'";	1039	or Carp::croak "unsupported hook type '$name'";
617		1040
		1041	$self->set_should_invoke ($htype, +1)
618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1042	unless exists $self->{term}{_hook}[$htype]{$pkg};
619	$hook_count[$htype]++
620	or urxvt::set_should_invoke $htype, 1;
621	}
622		1043
623	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1044	$self->{term}{_hook}[$htype]{$pkg} = $cb;
624	}	1045	}
625	}	1046	}
626		1047
…		…
631	for my $name (@hook) {	1052	for my $name (@hook) {
632	my $htype = $HOOKTYPE{uc $name};	1053	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	1054	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	1055	or Carp::croak "unsupported hook type '$name'";
635		1056
		1057	$self->set_should_invoke ($htype, -1)
636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1058	if delete $self->{term}{_hook}[$htype]{$pkg};
637	--$hook_count[$htype]
638	or urxvt::set_should_invoke $htype, 0;
639	}
640	}	1059	}
641	}	1060	}
642		1061
643	our $AUTOLOAD;	1062	our $AUTOLOAD;
644		1063
…		…
675		1094
676	=head2 The C<urxvt::anyevent> Class	1095	=head2 The C<urxvt::anyevent> Class
677		1096
678	The sole purpose of this class is to deliver an interface to the	1097	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	1098	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	1099	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	1100	condition variables, but non-blocking condvar use is ok. What this means
682	cannot use blocking APIs, but the non-blocking variant should work.	1101	is that you cannot use blocking APIs, but the non-blocking variant should
		1102	work.
683		1103
684	=cut	1104	=cut
685		1105
686	our $VERSION = 1;	1106	our $VERSION = 1;
687		1107
…		…
723	sub DESTROY {	1143	sub DESTROY {
724	$_[0][1]->stop;	1144	$_[0][1]->stop;
725	}	1145	}
726		1146
727	sub condvar {	1147	sub condvar {
728	bless \my $flag, urxvt::anyevent::condvar::	1148	bless \my $flag, urxvt::anyevent::
729	}	1149	}
730		1150
731	sub urxvt::anyevent::condvar::broadcast {	1151	sub broadcast {
732	${$_[0]}++;	1152	${$_[0]}++;
733	}	1153	}
734		1154
735	sub urxvt::anyevent::condvar::wait {	1155	sub wait {
736	unless (${$_[0]}) {	1156	unless (${$_[0]}) {
737	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1157	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
738	}	1158	}
		1159	}
		1160
		1161	sub one_event {
		1162	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
739	}	1163	}
740		1164
741	package urxvt::term;	1165	package urxvt::term;
742		1166
743	=head2 The C<urxvt::term> Class	1167	=head2 The C<urxvt::term> Class
…		…
748		1172
749	# find on_xxx subs in the package and register them	1173	# find on_xxx subs in the package and register them
750	# as hooks	1174	# as hooks
751	sub register_package {	1175	sub register_package {
752	my ($self, $pkg, $argv) = @_;	1176	my ($self, $pkg, $argv) = @_;
		1177
		1178	no strict 'refs';
		1179
		1180	urxvt::verbose 6, "register package $pkg to $self";
		1181
		1182	@{"$pkg\::ISA"} = urxvt::term::extension::;
753		1183
754	my $proxy = bless {	1184	my $proxy = bless {
755	_pkg => $pkg,	1185	_pkg => $pkg,
756	argv => $argv,	1186	argv => $argv,
757	}, $pkg;	1187	}, $pkg;
…		…
764	$proxy->enable ($name => $ref);	1194	$proxy->enable ($name => $ref);
765	}	1195	}
766	}	1196	}
767	}	1197	}
768		1198
		1199	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1200
		1201	Creates a new terminal, very similar as if you had started it with system
		1202	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1203	hash which defines the environment of the new terminal.
		1204
		1205	Croaks (and probably outputs an error message) if the new instance
		1206	couldn't be created. Returns C<undef> if the new instance didn't
		1207	initialise perl, and the terminal object otherwise. The C<init> and
		1208	C<start> hooks will be called before this call returns, and are free to
		1209	refer to global data (which is race free).
		1210
		1211	=cut
		1212
		1213	sub new {
		1214	my ($class, $env, @args) = @_;
		1215
		1216	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1217	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1218
		1219	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1220	}
		1221
769	=item $term->destroy	1222	=item $term->destroy
770		1223
771	Destroy the terminal object (close the window, free resources etc.).	1224	Destroy the terminal object (close the window, free resources
		1225	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1226	watchers (timers, io watchers) are still active.
		1227
		1228	=item $term->exec_async ($cmd[, @args])
		1229
		1230	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1231	("starts") programs in the background. This function takes care of setting
		1232	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1233	be preferred over explicit calls to C<exec> or C<system>.
		1234
		1235	Returns the pid of the subprocess or C<undef> on error.
		1236
		1237	=cut
		1238
		1239	sub exec_async {
		1240	my $self = shift;
		1241
		1242	my $pid = fork;
		1243
		1244	return $pid
		1245	if !defined $pid or $pid;
		1246
		1247	%ENV = %{ $self->env };
		1248
		1249	exec @_;
		1250	urxvt::_exit 255;
		1251	}
772		1252
773	=item $isset = $term->option ($optval[, $set])	1253	=item $isset = $term->option ($optval[, $set])
774		1254
775	Returns true if the option specified by C<$optval> is enabled, and	1255	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	1256	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.	1257	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
778		1258
779	Here is a a likely non-exhaustive list of option names, please see the	1259	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:	1260	source file F</src/optinc.h> to see the actual list:
781		1261
782	borderLess console cursorBlink cursorUnderline hold iconic insecure	1262	borderLess console cursorBlink cursorUnderline hold iconic insecure
783	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1263	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
784	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1264	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
785	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1265	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
786	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1266	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
787	tripleclickwords utmpInhibit visualBell	1267	transparent tripleclickwords utmpInhibit visualBell
788		1268
789	=item $value = $term->resource ($name[, $newval])	1269	=item $value = $term->resource ($name[, $newval])
790		1270
791	Returns the current resource value associated with a given name and	1271	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>	1272	optionally sets a new value. Setting values is most useful in the C<init>
…		…
801	likely change).	1281	likely change).
802		1282
803	Please note that resource strings will currently only be freed when the	1283	Please note that resource strings will currently only be freed when the
804	terminal is destroyed, so changing options frequently will eat memory.	1284	terminal is destroyed, so changing options frequently will eat memory.
805		1285
806	Here is a a likely non-exhaustive list of resource names, not all of which	1286	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>	1287	are supported in every build, please see the source file F</src/rsinc.h>
808	to see the actual list:	1288	to see the actual list:
809		1289
810	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1290	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
811	borderLess color cursorBlink cursorUnderline cutchars delete_key	1291	borderLess color cursorBlink cursorUnderline cutchars delete_key
812	display_name embed ext_bwidth fade font geometry hold iconName	1292	display_name embed ext_bwidth fade font geometry hold iconName
813	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1293	imFont imLocale inputMethod insecure int_bwidth intensityStyles
814	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1294	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
815	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1295	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
816	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1296	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
817	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1297	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
818	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1298	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
819	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1299	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
820	shade term_name title transparent transparent_all tripleclickwords	1300	secondaryScreen secondaryScroll selectstyle shade term_name title
821	utmpInhibit visualBell	1301	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1302	visualBell
822		1303
823	=cut	1304	=cut
824		1305
825	sub resource($$;$) {	1306	sub resource($$;$) {
826	my ($self, $name) = (shift, shift);	1307	my ($self, $name) = (shift, shift);
827	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1308	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
828	&urxvt::term::_resource	1309	&urxvt::term::_resource
829	}	1310	}
830		1311
		1312	=item $value = $term->x_resource ($pattern)
		1313
		1314	Returns the X-Resource for the given pattern, excluding the program or
		1315	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1316	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1317	resource with that pattern exists.
		1318
		1319	This method should only be called during the C<on_start> hook, as there is
		1320	only one resource database per display, and later invocations might return
		1321	the wrong resources.
		1322
831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1323	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832		1324
833	Adds a keymap translation exactly as specified via a resource. See the	1325	Adds a keymap translation exactly as specified via a resource. See the
834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1326	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835		1327
…		…
850	=item ($row, $col) = $term->selection_end ([$row, $col])	1342	=item ($row, $col) = $term->selection_end ([$row, $col])
851		1343
852	Return the current values of the selection mark, begin or end positions,	1344	Return the current values of the selection mark, begin or end positions,
853	and optionally set them to new values.	1345	and optionally set them to new values.
854		1346
		1347	=item $term->selection_make ($eventtime[, $rectangular])
		1348
		1349	Tries to make a selection as set by C<selection_beg> and
		1350	C<selection_end>. If C<$rectangular> is true (default: false), a
		1351	rectangular selection will be made. This is the prefered function to make
		1352	a selection.
		1353
855	=item $success = $term->selection_grab ($eventtime)	1354	=item $success = $term->selection_grab ($eventtime)
856		1355
857	Try to request the primary selection from the server (for example, as set	1356	Try to request the primary selection text from the server (for example, as
858	by the next method).	1357	set by the next method). No visual feedback will be given. This function
		1358	is mostly useful from within C<on_sel_grab> hooks.
859		1359
860	=item $oldtext = $term->selection ([$newtext])	1360	=item $oldtext = $term->selection ([$newtext])
861		1361
862	Return the current selection text and optionally replace it by C<$newtext>.	1362	Return the current selection text and optionally replace it by C<$newtext>.
863		1363
…		…
956	Convert the given locale-encoded octets into a perl string.	1456	Convert the given locale-encoded octets into a perl string.
957		1457
958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1458	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
959		1459
960	XORs the rendition values in the given span with the provided value	1460	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	1461	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
962	to the selection.	1462	refresh hooks to provide effects similar to the selection.
963		1463
964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1464	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
965		1465
966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1466	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
967	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1467	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	1468	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
969	it instead.	1469	it instead. Both styles I<MUST NOT> contain font styles.
970		1470
971	=item $term->scr_bell	1471	=item $term->scr_bell
972		1472
973	Ring the bell!	1473	Ring the bell!
974		1474
…		…
981		1481
982	Normally its not a good idea to use this function, as programs might be	1482	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	1483	confused by changes in cursor position or scrolling. Its useful inside a
984	C<on_add_lines> hook, though.	1484	C<on_add_lines> hook, though.
985		1485
		1486	=item $term->scr_change_screen ($screen)
		1487
		1488	Switch to given screen - 0 primary, 1 secondary.
		1489
986	=item $term->cmd_parse ($octets)	1490	=item $term->cmd_parse ($octets)
987		1491
988	Similar to C<scr_add_lines>, but the argument must be in the	1492	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	1493	locale-specific encoding of the terminal and can contain command sequences
990	(escape codes) that will be interpreted.	1494	(escape codes) that will be interpreted.
…		…
1000	Replaces the event mask of the pty watcher by the given event mask. Can	1504	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	1505	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	1506	description of C<< urxvt::timer->events >>. Make sure to always restore
1003	the previous value.	1507	the previous value.
1004		1508
		1509	=item $fd = $term->pty_fd
		1510
		1511	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1512	is used.
		1513
1005	=item $windowid = $term->parent	1514	=item $windowid = $term->parent
1006		1515
1007	Return the window id of the toplevel window.	1516	Return the window id of the toplevel window.
1008		1517
1009	=item $windowid = $term->vt	1518	=item $windowid = $term->vt
1010		1519
1011	Return the window id of the terminal window.	1520	Return the window id of the terminal window.
1012		1521
		1522	=item $term->vt_emask_add ($x_event_mask)
		1523
		1524	Adds the specified events to the vt event mask. Useful e.g. when you want
		1525	to receive pointer events all the times:
		1526
		1527	$term->vt_emask_add (urxvt::PointerMotionMask);
		1528
		1529	=item $term->focus_in
		1530
		1531	=item $term->focus_out
		1532
		1533	=item $term->key_press ($state, $keycode[, $time])
		1534
		1535	=item $term->key_release ($state, $keycode[, $time])
		1536
		1537	Deliver various fake events to to terminal.
		1538
1013	=item $window_width = $term->width	1539	=item $window_width = $term->width
1014		1540
1015	=item $window_height = $term->height	1541	=item $window_height = $term->height
1016		1542
1017	=item $font_width = $term->fwidth	1543	=item $font_width = $term->fwidth
…		…
1030		1556
1031	=item $max_scrollback = $term->saveLines	1557	=item $max_scrollback = $term->saveLines
1032		1558
1033	=item $nrow_plus_saveLines = $term->total_rows	1559	=item $nrow_plus_saveLines = $term->total_rows
1034		1560
1035	=item $lines_in_scrollback = $term->nsaved	1561	=item $topmost_scrollback_row = $term->top_row
1036		1562
1037	Return various integers describing terminal characteristics.	1563	Return various integers describing terminal characteristics.
1038		1564
		1565	=item $x_display = $term->display_id
		1566
		1567	Return the DISPLAY used by rxvt-unicode.
		1568
1039	=item $lc_ctype = $term->locale	1569	=item $lc_ctype = $term->locale
1040		1570
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1571	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1572
1043	=item $x_display = $term->display_id	1573	=item $env = $term->env
1044		1574
1045	Return the DISPLAY used by rxvt-unicode.	1575	Returns a copy of the environment in effect for the terminal as a hashref
		1576	similar to C<\%ENV>.
		1577
		1578	=item @envv = $term->envv
		1579
		1580	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1581
		1582	=item @argv = $term->argv
		1583
		1584	Return the argument vector as this terminal, similar to @ARGV, but
		1585	includes the program name as first element.
		1586
		1587	=cut
		1588
		1589	sub env {
		1590	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1591	}
1046		1592
1047	=item $modifiermask = $term->ModLevel3Mask	1593	=item $modifiermask = $term->ModLevel3Mask
1048		1594
1049	=item $modifiermask = $term->ModMetaMask	1595	=item $modifiermask = $term->ModMetaMask
1050		1596
1051	=item $modifiermask = $term->ModNumLockMask	1597	=item $modifiermask = $term->ModNumLockMask
1052		1598
1053	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1599	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.	1600	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1055		1601
		1602	=item $screen = $term->current_screen
		1603
		1604	Returns the currently displayed screen (0 primary, 1 secondary).
		1605
		1606	=item $cursor_is_hidden = $term->hidden_cursor
		1607
		1608	Returns whether the cursor is currently hidden or not.
		1609
1056	=item $view_start = $term->view_start ([$newvalue])	1610	=item $view_start = $term->view_start ([$newvalue])
1057		1611
1058	Returns the negative row number of the topmost line. Minimum value is	1612	Returns the row number of the topmost displayed line. Maximum value is
1059	C<0>, which displays the normal terminal contents. Larger values scroll	1613	C<0>, which displays the normal terminal contents. Lower values scroll
1060	this many lines into the scrollback buffer.	1614	this many lines into the scrollback buffer.
1061		1615
1062	=item $term->want_refresh	1616	=item $term->want_refresh
1063		1617
1064	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1618	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1079	line, starting at column C<$start_col> (default C<0>), which is useful	1633	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	1634	to replace only parts of a line. The font index in the rendition will
1081	automatically be updated.	1635	automatically be updated.
1082		1636
1083	C<$text> is in a special encoding: tabs and wide characters that use more	1637	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	1638	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1085	(C<chr 65535>). Characters with combining characters and other characters	1639	characters. Characters with combining characters and other characters that
1086	that do not fit into the normal tetx encoding will be replaced with	1640	do not fit into the normal tetx encoding will be replaced with characters
1087	characters in the private use area.	1641	in the private use area.
1088		1642
1089	You have to obey this encoding when changing text. The advantage is	1643	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	1644	that C<substr> and similar functions work on screen cells and not on
1091	characters.	1645	characters.
1092		1646
…		…
1143	Return the row number of the first/last row of the line, respectively.	1697	Return the row number of the first/last row of the line, respectively.
1144		1698
1145	=item $offset = $line->offset_of ($row, $col)	1699	=item $offset = $line->offset_of ($row, $col)
1146		1700
1147	Returns the character offset of the given row|col pair within the logical	1701	Returns the character offset of the given row|col pair within the logical
1148	line.	1702	line. Works for rows outside the line, too, and returns corresponding
		1703	offsets outside the string.
1149		1704
1150	=item ($row, $col) = $line->coord_of ($offset)	1705	=item ($row, $col) = $line->coord_of ($offset)
1151		1706
1152	Translates a string offset into terminal coordinates again.	1707	Translates a string offset into terminal coordinates again.
1153		1708
…		…
1235	where one character corresponds to one screen cell. See	1790	where one character corresponds to one screen cell. See
1236	C<< $term->ROW_t >> for details.	1791	C<< $term->ROW_t >> for details.
1237		1792
1238	=item $string = $term->special_decode $text	1793	=item $string = $term->special_decode $text
1239		1794
1240	Converts rxvt-unicodes text reprsentation into a perl string. See	1795	Converts rxvt-unicodes text representation into a perl string. See
1241	C<< $term->ROW_t >> for details.	1796	C<< $term->ROW_t >> for details.
1242		1797
1243	=item $success = $term->grab_button ($button, $modifiermask)	1798	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1244		1799
		1800	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1801
1245	Registers a synchronous button grab. See the XGrabButton manpage.	1802	Register/unregister a synchronous button grab. See the XGrabButton
		1803	manpage.
1246		1804
1247	=item $success = $term->grab ($eventtime[, $sync])	1805	=item $success = $term->grab ($eventtime[, $sync])
1248		1806
1249	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1807	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1250	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1808	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1251		1809
1252	=item $term->allow_events_async	1810	=item $term->allow_events_async
1253		1811
1254	Calls XAllowEvents with AsyncBoth for the most recent grab.	1812	Calls XAllowEvents with AsyncBoth for the most recent grab.
1255		1813
…		…
1266		1824
1267	Calls XUngrab for the most recent grab. Is called automatically on	1825	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	1826	evaluation errors, as it is better to lose the grab in the error case as
1269	the session.	1827	the session.
1270		1828
		1829	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1830
		1831	=item $atom_name = $term->XGetAtomName ($atom)
		1832
		1833	=item @atoms = $term->XListProperties ($window)
		1834
		1835	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1836
		1837	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1838
		1839	=item $term->XDeleteProperty ($window, $property)
		1840
		1841	=item $window = $term->DefaultRootWindow
		1842
		1843	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1844
		1845	=item $term->XMapWindow ($window)
		1846
		1847	=item $term->XUnmapWindow ($window)
		1848
		1849	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1850
		1851	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1852
		1853	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1854
		1855	Various X or X-related functions. The C<$term> object only serves as
		1856	the source of the display, otherwise those functions map more-or-less
		1857	directory onto the X functions of the same name.
		1858
1271	=back	1859	=back
1272		1860
1273	=cut	1861	=cut
1274		1862
1275	package urxvt::popup;	1863	package urxvt::popup;
…		…
1289		1877
1290	$item->{render} ||= sub { $_[0]{text} };	1878	$item->{render} ||= sub { $_[0]{text} };
1291		1879
1292	push @{ $self->{item} }, $item;	1880	push @{ $self->{item} }, $item;
1293	}	1881	}
		1882
		1883	=item $popup->add_title ($title)
		1884
		1885	Adds a non-clickable title to the popup.
		1886
		1887	=cut
		1888
		1889	sub add_title {
		1890	my ($self, $title) = @_;
		1891
		1892	$self->add_item ({
		1893	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1894	text => $title,
		1895	activate => sub { },
		1896	});
		1897	}
		1898
		1899	=item $popup->add_separator ([$sepchr])
		1900
		1901	Creates a separator, optionally using the character given as C<$sepchr>.
		1902
		1903	=cut
1294		1904
1295	sub add_separator {	1905	sub add_separator {
1296	my ($self, $sep) = @_;	1906	my ($self, $sep) = @_;
1297		1907
1298	$sep ||= "=";	1908	$sep ||= "=";
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1913	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1914	activate => sub { },
1305	});	1915	});
1306	}	1916	}
1307		1917
1308	sub add_title {	1918	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1919
1311	$self->add_item ({	1920	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" },	1921	selected.
1313	text => $title,	1922
1314	activate => sub { },	1923	=cut
1315	});
1316	}
1317		1924
1318	sub add_button {	1925	sub add_button {
1319	my ($self, $text, $cb) = @_;	1926	my ($self, $text, $cb) = @_;
1320		1927
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1928	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	1929	}
1323		1930
		1931	=item $popup->add_toggle ($text, $initial_value, $cb)
		1932
		1933	Adds a toggle/checkbox item to the popup. The callback gets called
		1934	whenever it gets toggled, with a boolean indicating its new value as its
		1935	first argument.
		1936
		1937	=cut
		1938
1324	sub add_toggle {	1939	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	1940	my ($self, $text, $value, $cb) = @_;
1326		1941
1327	my $item; $item = {	1942	my $item; $item = {
1328	type => "button",	1943	type => "button",
1329	text => " $text",	1944	text => " $text",
1330	value => $value,	1945	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1946	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1947	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	1948	};
1334		1949
1335	$self->add_item ($item);	1950	$self->add_item ($item);
1336	}	1951	}
		1952
		1953	=item $popup->show
		1954
		1955	Displays the popup (which is initially hidden).
		1956
		1957	=cut
1337		1958
1338	sub show {	1959	sub show {
1339	my ($self) = @_;	1960	my ($self) = @_;
1340		1961
1341	local $urxvt::popup::self = $self;	1962	local $urxvt::popup::self = $self;
1342		1963
		1964	my $env = $self->{term}->env;
		1965	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1966	delete $env->{LC_ALL};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	1967	$env->{LC_CTYPE} = $self->{term}->locale;
1344		1968
1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1969	urxvt::term->new ($env, "popup",
		1970	"--perl-lib" => "", "--perl-ext-common" => "",
		1971	"-pty-fd" => -1, "-sl" => 0,
		1972	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1346	"--transient-for" => $self->{term}->parent,	1973	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	1974	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	1975	"-pe" => "urxvt-popup")
1349	or die "unable to create popup window\n";	1976	or die "unable to create popup window\n";
1350	}	1977	}
1351		1978
1352	sub DESTROY {	1979	sub DESTROY {
1353	my ($self) = @_;	1980	my ($self) = @_;
1354		1981
1355	delete $self->{term}{_destroy}{$self};	1982	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	1983	$self->{term}->ungrab;
1357	}	1984	}
		1985
		1986	=back
		1987
		1988	=cut
		1989
		1990	package urxvt::watcher;
1358		1991
1359	=head2 The C<urxvt::timer> Class	1992	=head2 The C<urxvt::timer> Class
1360		1993
1361	This class implements timer watchers/events. Time is represented as a	1994	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	1995	fractional number of seconds since the epoch. Example:
…		…
1400	Start the timer.	2033	Start the timer.
1401		2034
1402	=item $timer = $timer->start ($tstamp)	2035	=item $timer = $timer->start ($tstamp)
1403		2036
1404	Set the event trigger time to C<$tstamp> and start the timer.	2037	Set the event trigger time to C<$tstamp> and start the timer.
		2038
		2039	=item $timer = $timer->after ($delay)
		2040
		2041	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1405		2042
1406	=item $timer = $timer->stop	2043	=item $timer = $timer->stop
1407		2044
1408	Stop the timer.	2045	Stop the timer.
1409		2046
…		…
1438	Set the callback to be called when io events are triggered. C<$reventmask>	2075	Set the callback to be called when io events are triggered. C<$reventmask>
1439	is a bitset as described in the C<events> method.	2076	is a bitset as described in the C<events> method.
1440		2077
1441	=item $iow = $iow->fd ($fd)	2078	=item $iow = $iow->fd ($fd)
1442		2079
1443	Set the filedescriptor (not handle) to watch.	2080	Set the file descriptor (not handle) to watch.
1444		2081
1445	=item $iow = $iow->events ($eventmask)	2082	=item $iow = $iow->events ($eventmask)
1446		2083
1447	Set the event mask to watch. The only allowed values are	2084	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	2085	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
…		…
1452		2089
1453	Start watching for requested events on the given handle.	2090	Start watching for requested events on the given handle.
1454		2091
1455	=item $iow = $iow->stop	2092	=item $iow = $iow->stop
1456		2093
1457	Stop watching for events on the given filehandle.	2094	Stop watching for events on the given file handle.
		2095
		2096	=back
		2097
		2098	=head2 The C<urxvt::iw> Class
		2099
		2100	This class implements idle watchers, that get called automatically when
		2101	the process is idle. They should return as fast as possible, after doing
		2102	some useful work.
		2103
		2104	=over 4
		2105
		2106	=item $iw = new urxvt::iw
		2107
		2108	Create a new idle watcher object in stopped state.
		2109
		2110	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2111
		2112	Set the callback to be called when the watcher triggers.
		2113
		2114	=item $timer = $timer->start
		2115
		2116	Start the watcher.
		2117
		2118	=item $timer = $timer->stop
		2119
		2120	Stop the watcher.
		2121
		2122	=back
		2123
		2124	=head2 The C<urxvt::pw> Class
		2125
		2126	This class implements process watchers. They create an event whenever a
		2127	process exits, after which they stop automatically.
		2128
		2129	my $pid = fork;
		2130	...
		2131	$term->{pw} = urxvt::pw
		2132	->new
		2133	->start ($pid)
		2134	->cb (sub {
		2135	my ($pw, $exit_status) = @_;
		2136	...
		2137	});
		2138
		2139	=over 4
		2140
		2141	=item $pw = new urxvt::pw
		2142
		2143	Create a new process watcher in stopped state.
		2144
		2145	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2146
		2147	Set the callback to be called when the timer triggers.
		2148
		2149	=item $pw = $timer->start ($pid)
		2150
		2151	Tells the watcher to start watching for process C<$pid>.
		2152
		2153	=item $pw = $pw->stop
		2154
		2155	Stop the watcher.
1458		2156
1459	=back	2157	=back
1460		2158
1461	=head1 ENVIRONMENT	2159	=head1 ENVIRONMENT
1462		2160
…		…
1469		2167
1470	=item == 0 - fatal messages	2168	=item == 0 - fatal messages
1471		2169
1472	=item >= 3 - script loading and management	2170	=item >= 3 - script loading and management
1473		2171
1474	=item >=10 - all events received	2172	=item >=10 - all called hooks
		2173
		2174	=item >=11 - hook return values
1475		2175
1476	=back	2176	=back
1477		2177
1478	=head1 AUTHOR	2178	=head1 AUTHOR
1479		2179
…		…
1481	http://software.schmorp.de/pkg/rxvt-unicode	2181	http://software.schmorp.de/pkg/rxvt-unicode
1482		2182
1483	=cut	2183	=cut
1484		2184
1485	1	2185	1
		2186
		2187	# vim: sw=3:

Diff Legend

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