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

Diff Legend

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