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.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.145 by root, Thu Aug 10 22:53:20 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.
70		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	};
		140
71	=item searchable-scrollback (enabled by default)	141	=item searchable-scrollback<hotkey> (enabled by default)
72		142
73	Adds regex search functionality to the scrollback buffer, triggered by a	143	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	suspended, C</> starts an incremental regex search, C<n> searches further,	145	input/output is suspended and a regex is displayed at the bottom of the
76	C<p> jumps to the previous match. C<enter> leaves search mode at the	146	screen.
77	current position and C<escape> returns to the original position.
78		147
79	=item digital-clock	148	Inputting characters appends them to the regex and continues incremental
		149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		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.
80		155
81	Displays a digital clock using the built-in overlay.	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.
		159
		160	See L<perlre> for more info about perl regular expression syntax.
		161
		162	=item readline (enabled by default)
		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.
82		244
83	=item mark-urls	245	=item mark-urls
84		246
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	247	Uses per-line display filtering (C<on_line_update>) to underline urls and
		248	make them clickable. When middle-clicked, the program specified in the
		249	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		250	the URL as first argument.
		251
		252	=item xim-onthespot
		253
		254	This (experimental) perl extension implements OnTheSpot editing. It does
		255	not work perfectly, and some input methods don't seem to work well with
		256	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		257	kinput2.
		258
		259	You enable it by specifying this extension and a preedit style of
		260	C<OnTheSpot>, i.e.:
		261
		262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		263
		264	=item kuake<hotkey>
		265
		266	A very primitive quake-console-like extension. It was inspired by a
		267	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		268	user presses a global accelerator key (by default C<F10>), the terminal
		269	will show or hide itself. Another press of the accelerator key will hide
		270	or show it again.
		271
		272	Initially, the window will not be shown when using this extension.
		273
		274	This is useful if you need a single terminal thats not using any desktop
		275	space most of the time but is quickly available at the press of a key.
		276
		277	The accelerator key is grabbed regardless of any modifiers, so this
		278	extension will actually grab a physical key just for this function.
		279
		280	If you want a quake-like animation, tell your window manager to do so
		281	(fvwm can do it).
		282
		283	=item automove-background
		284
		285	This is basically a very small extension that dynamically changes the
		286	background pixmap offset to the window position, in effect creating the
		287	same effect as pseudo transparency with a custom pixmap. No scaling is
		288	supported in this mode. Example:
		289
		290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
86		291
87	=item block-graphics-to-ascii	292	=item block-graphics-to-ascii
88		293
89	A not very useful example of filtering all text output to the terminal,	294	A not very useful example of filtering all text output to the terminal
90	by replacing all line-drawing characters (U+2500 .. U+259F) by a	295	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.	296	similar-looking ascii character.
		297
		298	=item digital-clock
		299
		300	Displays a digital clock using the built-in overlay.
		301
		302	=item remote-clipboard
		303
		304	Somewhat of a misnomer, this extension adds two menu entries to the
		305	selection popup that allows one ti run external commands to store the
		306	selection somewhere and fetch it again.
		307
		308	We use it to implement a "distributed selection mechanism", which just
		309	means that one command uploads the file to a remote server, and another
		310	reads it.
		311
		312	The commands can be set using the C<URxvt.remote-selection.store> and
		313	C<URxvt.remote-selection.fetch> resources. The first should read the
		314	selection to store from STDIN (always in UTF-8), the second should provide
		315	the selection data on STDOUT (also in UTF-8).
		316
		317	The defaults (which are likely useless to you) use rsh and cat:
		318
		319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		321
		322	=item selection-pastebin
		323
		324	This is a little rarely useful extension that Uploads the selection as
		325	textfile to a remote site (or does other things). (The implementation is
		326	not currently secure for use in a multiuser environment as it writes to
		327	F</tmp> directly.).
		328
		329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		330	i.e.
		331
		332	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		333
		334	Pressing this combination runs a command with C<%> replaced by the name of
		335	the textfile. This command can be set via a resource:
		336
		337	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		338
		339	And the default is likely not useful to anybody but the few people around
		340	here :)
		341
		342	The name of the textfile is the hex encoded md5 sum of the selection, so
		343	the same content should lead to the same filename.
		344
		345	After a successful upload the selection will be replaced by the text given
		346	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		347	for the filename):
		348
		349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
92		350
93	=item example-refresh-hooks	351	=item example-refresh-hooks
94		352
95	Displays a very simple digital clock in the upper right corner of the	353	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	354	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	355	overlays or changes.
98		356
99	=back	357	=back
		358
		359	=head1 API DOCUMENTATION
100		360
101	=head2 General API Considerations	361	=head2 General API Considerations
102		362
103	All objects (such as terminals, time watchers etc.) are typical	363	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	364	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	377	=over 4
118		378
119	=item $text	379	=item $text
120		380
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	381	Rxvt-unicodes special way of encoding text, where one "unicode" character
122	always represents one screen cell. See L<row_t> for a discussion of this format.	382	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		383
124	=item $string	384	=item $string
125		385
126	A perl text string, with an emphasis on I<text>. It can store all unicode	386	A perl text string, with an emphasis on I<text>. It can store all unicode
127	characters and is to be distinguished with text encoded in a specific	387	characters and is to be distinguished with text encoded in a specific
…		…
134		394
135	=back	395	=back
136		396
137	=head2 Extension Objects	397	=head2 Extension Objects
138		398
139	Very perl extension is a perl class. A separate perl object is created	399	Every perl extension is a perl class. A separate perl object is created
140	for each terminal and each extension and passed as the first parameter to	400	for each terminal, and each terminal has its own set of extenion objects,
141	hooks. So extensions can use their C<$self> object without having to think	401	which are passed as the first parameter to hooks. So extensions can use
142	about other extensions, with the exception of methods and members that	402	their C<$self> object without having to think about clashes with other
		403	extensions or other terminals, with the exception of methods and members
143	begin with an underscore character C<_>: these are reserved for internal	404	that begin with an underscore character C<_>: these are reserved for
144	use.	405	internal use.
145		406
146	Although it isn't a C<urxvt::term> object, you can call all methods of the	407	Although it isn't a C<urxvt::term> object, you can call all methods of the
147	C<urxvt::term> class on this object.	408	C<urxvt::term> class on this object.
148		409
149	It has the following methods and data members:	410	It has the following methods and data members:
…		…
170	=head2 Hooks	431	=head2 Hooks
171		432
172	The following subroutines can be declared in extension files, and will be	433	The following subroutines can be declared in extension files, and will be
173	called whenever the relevant event happens.	434	called whenever the relevant event happens.
174		435
175	The first argument passed to them is an extension oject as described in	436	The first argument passed to them is an extension object as described in
176	the in the C<Extension Objects> section.	437	the in the C<Extension Objects> section.
177		438
178	B<All> of these hooks must return a boolean value. If it is true, then the	439	B<All> of these hooks must return a boolean value. If any of the called
179	event counts as being I<consumed>, and the invocation of other hooks is	440	hooks returns true, then the event counts as being I<consumed>, and the
180	skipped, and the relevant action might not be carried out by the C++ code.	441	relevant action might not be carried out by the C++ code.
181		442
182	I<< When in doubt, return a false value (preferably C<()>). >>	443	I<< When in doubt, return a false value (preferably C<()>). >>
183		444
184	=over 4	445	=over 4
185		446
186	=item on_init $term	447	=item on_init $term
187		448
188	Called after a new terminal object has been initialized, but before	449	Called after a new terminal object has been initialized, but before
189	windows are created or the command gets run. Most methods are unsafe to	450	windows are created or the command gets run. Most methods are unsafe to
190	call or deliver senseless data, as terminal size and other characteristics	451	call or deliver senseless data, as terminal size and other characteristics
191	have not yet been determined. You can safely query and change resources,	452	have not yet been determined. You can safely query and change resources
192	though.	453	and options, though. For many purposes the C<on_start> hook is a better
		454	place.
		455
		456	=item on_start $term
		457
		458	Called at the very end of initialisation of a new terminal, just before
		459	trying to map (display) the toplevel and returning to the main loop.
		460
		461	=item on_destroy $term
		462
		463	Called whenever something tries to destroy terminal, when the terminal is
		464	still fully functional (not for long, though).
193		465
194	=item on_reset $term	466	=item on_reset $term
195		467
196	Called after the screen is "reset" for any reason, such as resizing or	468	Called after the screen is "reset" for any reason, such as resizing or
197	control sequences. Here is where you can react on changes to size-related	469	control sequences. Here is where you can react on changes to size-related
198	variables.	470	variables.
199		471
200	=item on_start $term	472	=item on_child_start $term, $pid
201		473
202	Called at the very end of initialisation of a new terminal, just before	474	Called just after the child process has been C<fork>ed.
203	returning to the mainloop.	475
		476	=item on_child_exit $term, $status
		477
		478	Called just after the child process has exited. C<$status> is the status
		479	from C<waitpid>.
204		480
205	=item on_sel_make $term, $eventtime	481	=item on_sel_make $term, $eventtime
206		482
207	Called whenever a selection has been made by the user, but before the	483	Called whenever a selection has been made by the user, but before the
208	selection text is copied, so changes to the beginning, end or type of the	484	selection text is copied, so changes to the beginning, end or type of the
…		…
215		491
216	Called whenever a selection has been copied, but before the selection is	492	Called whenever a selection has been copied, but before the selection is
217	requested from the server. The selection text can be queried and changed	493	requested from the server. The selection text can be queried and changed
218	by calling C<< $term->selection >>.	494	by calling C<< $term->selection >>.
219		495
220	Returning a true value aborts selection grabbing. It will still be hilighted.	496	Returning a true value aborts selection grabbing. It will still be highlighted.
221		497
222	=item on_sel_extend $term	498	=item on_sel_extend $term
223		499
224	Called whenever the user tries to extend the selection (e.g. with a double	500	Called whenever the user tries to extend the selection (e.g. with a double
225	click) and is either supposed to return false (normal operation), or	501	click) and is either supposed to return false (normal operation), or
226	should extend the selection itelf and return true to suppress the built-in	502	should extend the selection itself and return true to suppress the built-in
227	processing.	503	processing. This can happen multiple times, as long as the callback
		504	returns true, it will be called on every further click by the user and is
		505	supposed to enlarge the selection more and more, if possible.
228		506
229	See the F<selection> example extension.	507	See the F<selection> example extension.
230		508
231	=item on_view_change $term, $offset	509	=item on_view_change $term, $offset
232		510
233	Called whenever the view offset changes, i..e the user or program	511	Called whenever the view offset changes, i.e. the user or program
234	scrolls. Offset C<0> means display the normal terminal, positive values	512	scrolls. Offset C<0> means display the normal terminal, positive values
235	show this many lines of scrollback.	513	show this many lines of scrollback.
236		514
237	=item on_scroll_back $term, $lines, $saved	515	=item on_scroll_back $term, $lines, $saved
238		516
…		…
242		520
243	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	521	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
244	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	522	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
245	number of lines that will be in the scrollback buffer.	523	number of lines that will be in the scrollback buffer.
246		524
		525	=item on_osc_seq $term, $op, $args
		526
		527	Called on every OSC sequence and can be used to suppress it or modify its
		528	behaviour. The default should be to return an empty list. A true value
		529	suppresses execution of the request completely. Make sure you don't get
		530	confused by recursive invocations when you output an osc sequence within
		531	this callback.
		532
		533	C<on_osc_seq_perl> should be used for new behaviour.
		534
247	=item on_osc_seq $term, $string	535	=item on_osc_seq_perl $term, $string
248		536
249	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	537	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
250	operating system command) is processed. Cursor position and other state	538	operating system command) is processed. Cursor position and other state
251	information is up-to-date when this happens. For interoperability, the	539	information is up-to-date when this happens. For interoperability, the
252	string should start with the extension name and a colon, to distinguish	540	string should start with the extension name and a colon, to distinguish
253	it from commands for other extensions, and this might be enforced in the	541	it from commands for other extensions, and this might be enforced in the
254	future.	542	future.
255		543
256	Be careful not ever to trust (in a security sense) the data you receive,	544	Be careful not ever to trust (in a security sense) the data you receive,
257	as its source can not easily be controleld (e-mail content, messages from	545	as its source can not easily be controlled (e-mail content, messages from
258	other users on the same system etc.).	546	other users on the same system etc.).
259		547
260	=item on_add_lines $term, $string	548	=item on_add_lines $term, $string
261		549
262	Called whenever text is about to be output, with the text as argument. You	550	Called whenever text is about to be output, with the text as argument. You
…		…
293		581
294	=item on_refresh_end $term	582	=item on_refresh_end $term
295		583
296	Called just after the screen gets redrawn. See C<on_refresh_begin>.	584	Called just after the screen gets redrawn. See C<on_refresh_begin>.
297		585
298	=item on_keyboard_command $term, $string	586	=item on_user_command $term, $string
299		587
300	Called whenever the user presses a key combination that has a	588	Called whenever a user-configured event is being activated (e.g. via
301	C<perl:string> action bound to it (see description of the B<keysym>	589	a C<perl:string> action bound to a key, see description of the B<keysym>
302	resource in the @@RXVT_NAME@@(1) manpage).	590	resource in the @@RXVT_NAME@@(1) manpage).
		591
		592	The event is simply the action string. This interface is assumed to change
		593	slightly in the future.
		594
		595	=item on_resize_all_windows $tern, $new_width, $new_height
		596
		597	Called just after the new window size has been calculated, but before
		598	windows are actually being resized or hints are being set. If this hook
		599	returns TRUE, setting of the window hints is being skipped.
		600
		601	=item on_x_event $term, $event
		602
		603	Called on every X event received on the vt window (and possibly other
		604	windows). Should only be used as a last resort. Most event structure
		605	members are not passed.
		606
		607	=item on_root_event $term, $event
		608
		609	Like C<on_x_event>, but is called for events on the root window.
303		610
304	=item on_focus_in $term	611	=item on_focus_in $term
305		612
306	Called whenever the window gets the keyboard focus, before rxvt-unicode	613	Called whenever the window gets the keyboard focus, before rxvt-unicode
307	does focus in processing.	614	does focus in processing.
308		615
309	=item on_focus_out $term	616	=item on_focus_out $term
310		617
311	Called wheneever the window loses keyboard focus, before rxvt-unicode does	618	Called whenever the window loses keyboard focus, before rxvt-unicode does
312	focus out processing.	619	focus out processing.
		620
		621	=item on_configure_notify $term, $event
		622
		623	=item on_property_notify $term, $event
313		624
314	=item on_key_press $term, $event, $keysym, $octets	625	=item on_key_press $term, $event, $keysym, $octets
315		626
316	=item on_key_release $term, $event, $keysym	627	=item on_key_release $term, $event, $keysym
317		628
…		…
327		638
328	Called whenever the corresponding X event is received for the terminal If	639	Called whenever the corresponding X event is received for the terminal If
329	the hook returns true, then the even will be ignored by rxvt-unicode.	640	the hook returns true, then the even will be ignored by rxvt-unicode.
330		641
331	The event is a hash with most values as named by Xlib (see the XEvent	642	The event is a hash with most values as named by Xlib (see the XEvent
332	manpage), with the additional members C<row> and C<col>, which are the row	643	manpage), with the additional members C<row> and C<col>, which are the
333	and column under the mouse cursor.	644	(real, not screen-based) row and column under the mouse cursor.
334		645
335	C<on_key_press> additionally receives the string rxvt-unicode would	646	C<on_key_press> additionally receives the string rxvt-unicode would
336	output, if any, in locale-specific encoding.	647	output, if any, in locale-specific encoding.
337		648
338	subwindow.	649	subwindow.
339		650
340	=back	651	=item on_client_message $term, $event
341		652
342	=head2 Variables in the C<urxvt> Package	653	=item on_wm_protocols $term, $event
343		654
344	=over 4	655	=item on_wm_delete_window $term, $event
345		656
346	=item $urxvt::TERM	657	Called when various types of ClientMessage events are received (all with
347		658	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
348	The current terminal. This variable stores the current C<urxvt::term>
349	object, whenever a callback/hook is executing.
350
351	=back
352
353	=head2 Functions in the C<urxvt> Package
354
355	=over 4
356
357	=item $term = new urxvt [arg...]
358
359	Creates a new terminal, very similar as if you had started it with
360	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
361	if the new instance couldn't be created. Returns C<undef> if the new
362	instance didn't initialise perl, and the terminal object otherwise. The
363	C<init> and C<start> hooks will be called during the call.
364
365	=item urxvt::fatal $errormessage
366
367	Fatally aborts execution with the given error message. Avoid at all
368	costs! The only time this is acceptable is when the terminal process
369	starts up.
370
371	=item urxvt::warn $string
372
373	Calls C<rxvt_warn> with the given string which should not include a
374	newline. The module also overwrites the C<warn> builtin with a function
375	that calls this function.
376
377	Using this function has the advantage that its output ends up in the
378	correct place, e.g. on stderr of the connecting urxvtc client.
379
380	=item $is_safe = urxvt::safe
381
382	Returns true when it is safe to do potentially unsafe things, such as
383	evaluating perl code specified by the user. This is true when urxvt was
384	started setuid or setgid.
385
386	=item $time = urxvt::NOW
387
388	Returns the "current time" (as per the event loop).
389
390	=item urxvt::CurrentTime
391
392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394	Button4Mask, Button5Mask, AnyModifier
395
396	Various constants for use in X calls and event processing.
397
398	=back
399
400	=head2 RENDITION
401
402	Rendition bitsets contain information about colour, font, font styles and
403	similar information for each screen cell.
404
405	The following "macros" deal with changes in rendition sets. You should
406	never just create a bitset, you should always modify an existing one,
407	as they contain important information required for correct operation of
408	rxvt-unicode.
409
410	=over 4
411
412	=item $rend = urxvt::DEFAULT_RSTYLE
413
414	Returns the default rendition, as used when the terminal is starting up or
415	being reset. Useful as a base to start when creating renditions.
416
417	=item $rend = urxvt::OVERLAY_RSTYLE
418
419	Return the rendition mask used for overlays by default.
420
421	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
422
423	Return the bit that enabled bold, italic, blink, reverse-video and
424	underline, respectively. To enable such a style, just logically OR it into
425	the bitset.
426
427	=item $foreground = urxvt::GET_BASEFG $rend
428
429	=item $background = urxvt::GET_BASEBG $rend
430
431	Return the foreground/background colour index, respectively.
432
433	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
434
435	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
436
437	Replace the foreground/background colour in the rendition mask with the
438	specified one.
439
440	=item $value = urxvt::GET_CUSTOM ($rend)
441
442	Return the "custom" value: Every rendition has 5 bits for use by
443	extensions. They can be set and changed as you like and are initially
444	zero.
445
446	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
447
448	Change the custom value.
449		659
450	=back	660	=back
451		661
452	=cut	662	=cut
453		663
…		…
459	use Scalar::Util ();	669	use Scalar::Util ();
460	use List::Util ();	670	use List::Util ();
461		671
462	our $VERSION = 1;	672	our $VERSION = 1;
463	our $TERM;	673	our $TERM;
		674	our @TERM_INIT;
		675	our @TERM_EXT;
464	our @HOOKNAME;	676	our @HOOKNAME;
465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	677	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466	our %OPTION;	678	our %OPTION;
		679
467	our $LIBDIR;	680	our $LIBDIR;
		681	our $RESNAME;
		682	our $RESCLASS;
		683	our $RXVTNAME;
		684
		685	our $NOCHAR = chr 0xffff;
		686
		687	=head2 Variables in the C<urxvt> Package
		688
		689	=over 4
		690
		691	=item $urxvt::LIBDIR
		692
		693	The rxvt-unicode library directory, where, among other things, the perl
		694	modules and scripts are stored.
		695
		696	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		697
		698	The resource class and name rxvt-unicode uses to look up X resources.
		699
		700	=item $urxvt::RXVTNAME
		701
		702	The basename of the installed binaries, usually C<urxvt>.
		703
		704	=item $urxvt::TERM
		705
		706	The current terminal. This variable stores the current C<urxvt::term>
		707	object, whenever a callback/hook is executing.
		708
		709	=item @urxvt::TERM_INIT
		710
		711	All code references in this array will be called as methods of the next newly
		712	created C<urxvt::term> object (during the C<on_init> phase). The array
		713	gets cleared before the code references that were in it are being executed,
		714	so references can push themselves onto it again if they so desire.
		715
		716	This complements to the perl-eval command line option, but gets executed
		717	first.
		718
		719	=item @urxvt::TERM_EXT
		720
		721	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		722	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		723	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		724
		725	=back
		726
		727	=head2 Functions in the C<urxvt> Package
		728
		729	=over 4
		730
		731	=item urxvt::fatal $errormessage
		732
		733	Fatally aborts execution with the given error message. Avoid at all
		734	costs! The only time this is acceptable is when the terminal process
		735	starts up.
		736
		737	=item urxvt::warn $string
		738
		739	Calls C<rxvt_warn> with the given string which should not include a
		740	newline. The module also overwrites the C<warn> builtin with a function
		741	that calls this function.
		742
		743	Using this function has the advantage that its output ends up in the
		744	correct place, e.g. on stderr of the connecting urxvtc client.
		745
		746	Messages have a size limit of 1023 bytes currently.
		747
		748	=item @terms = urxvt::termlist
		749
		750	Returns all urxvt::term objects that exist in this process, regardless of
		751	whether they are started, being destroyed etc., so be careful. Only term
		752	objects that have perl extensions attached will be returned (because there
		753	is no urxvt::term objet associated with others).
		754
		755	=item $time = urxvt::NOW
		756
		757	Returns the "current time" (as per the event loop).
		758
		759	=item urxvt::CurrentTime
		760
		761	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		762	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		763	Button4Mask, Button5Mask, AnyModifier
		764
		765	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		766	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		767	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		768	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		769	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		770	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		771	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		772
		773	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		774	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		775	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		776	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		777	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		778	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		779	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		780
		781	Various constants for use in X calls and event processing.
		782
		783	=back
		784
		785	=head2 RENDITION
		786
		787	Rendition bitsets contain information about colour, font, font styles and
		788	similar information for each screen cell.
		789
		790	The following "macros" deal with changes in rendition sets. You should
		791	never just create a bitset, you should always modify an existing one,
		792	as they contain important information required for correct operation of
		793	rxvt-unicode.
		794
		795	=over 4
		796
		797	=item $rend = urxvt::DEFAULT_RSTYLE
		798
		799	Returns the default rendition, as used when the terminal is starting up or
		800	being reset. Useful as a base to start when creating renditions.
		801
		802	=item $rend = urxvt::OVERLAY_RSTYLE
		803
		804	Return the rendition mask used for overlays by default.
		805
		806	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		807
		808	Return the bit that enabled bold, italic, blink, reverse-video and
		809	underline, respectively. To enable such a style, just logically OR it into
		810	the bitset.
		811
		812	=item $foreground = urxvt::GET_BASEFG $rend
		813
		814	=item $background = urxvt::GET_BASEBG $rend
		815
		816	Return the foreground/background colour index, respectively.
		817
		818	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		819
		820	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		821
		822	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		823
		824	Replace the foreground/background colour in the rendition mask with the
		825	specified one.
		826
		827	=item $value = urxvt::GET_CUSTOM $rend
		828
		829	Return the "custom" value: Every rendition has 5 bits for use by
		830	extensions. They can be set and changed as you like and are initially
		831	zero.
		832
		833	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		834
		835	Change the custom value.
		836
		837	=back
		838
		839	=cut
468		840
469	BEGIN {	841	BEGIN {
470	urxvt->bootstrap;
471
472	# overwrite perl's warn	842	# overwrite perl's warn
473	*CORE::GLOBAL::warn = sub {	843	*CORE::GLOBAL::warn = sub {
474	my $msg = join "", @_;	844	my $msg = join "", @_;
475	$msg .= "\n"	845	$msg .= "\n"
476	unless $msg =~ /\n$/;	846	unless $msg =~ /\n$/;
477	urxvt::warn ($msg);	847	urxvt::warn ($msg);
478	};	848	};
479
480	delete $ENV{IFS};
481	delete $ENV{CDPATH};
482	delete $ENV{BASH_ENV};
483	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
484	}	849	}
485		850
486	my @hook_count;	851	no warnings 'utf8';
		852
487	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	853	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
488		854
489	sub verbose {	855	sub verbose {
490	my ($level, $msg) = @_;	856	my ($level, $msg) = @_;
491	warn "$msg\n" if $level <= $verbosity;	857	warn "$msg\n" if $level <= $verbosity;
492	}	858	}
493		859
494	my $extension_pkg = "extension0000";
495	my %extension_pkg;	860	my %extension_pkg;
496		861
497	# load a single script into its own package, once only	862	# load a single script into its own package, once only
498	sub extension_package($) {	863	sub extension_package($) {
499	my ($path) = @_;	864	my ($path) = @_;
500		865
501	$extension_pkg{$path} ||= do {	866	$extension_pkg{$path} ||= do {
502	my $pkg = "urxvt::" . ($extension_pkg++);	867	$path =~ /([^\/\\]+)$/;
		868	my $pkg = $1;
		869	$pkg =~ s/[^[:word:]]/_/g;
		870	$pkg = "urxvt::ext::$pkg";
503		871
504	verbose 3, "loading extension '$path' into package '$pkg'";	872	verbose 3, "loading extension '$path' into package '$pkg'";
505		873
506	open my $fh, "<:raw", $path	874	open my $fh, "<:raw", $path
507	or die "$path: $!";	875	or die "$path: $!";
508		876
509	my $source = untaint	877	my $source =
510	"package $pkg; use strict; use utf8;\n"	878	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
511	. "use base urxvt::term::extension::;\n"
512	. "#line 1 \"$path\"\n{\n"	879	. "#line 1 \"$path\"\n{\n"
513	. (do { local $/; <$fh> })	880	. (do { local $/; <$fh> })
514	. "\n};\n1";	881	. "\n};\n1";
515		882
516	eval $source	883	eval $source
…		…
530	if ($htype == 0) { # INIT	897	if ($htype == 0) { # INIT
531	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	898	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
532		899
533	my %ext_arg;	900	my %ext_arg;
534		901
		902	{
		903	my @init = @TERM_INIT;
		904	@TERM_INIT = ();
		905	$_->($TERM) for @init;
		906	my @pkg = @TERM_EXT;
		907	@TERM_EXT = ();
		908	$TERM->register_package ($_) for @pkg;
		909	}
		910
535	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	911	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
536	if ($_ eq "default") {	912	if ($_ eq "default") {
537	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	913	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
538	} elsif (/^-(.*)$/) {	914	} elsif (/^-(.*)$/) {
539	delete $ext_arg{$1};	915	delete $ext_arg{$1};
540	} elsif (/^([^<]+)<(.*)>$/) {	916	} elsif (/^([^<]+)<(.*)>$/) {
541	push @{ $ext_arg{$1} }, $2;	917	push @{ $ext_arg{$1} }, $2;
542	} else {	918	} else {
543	$ext_arg{$_} ||= [];	919	$ext_arg{$_} ||= [];
544	}	920	}
545	}	921	}
546		922
547	while (my ($ext, $argv) = each %ext_arg) {	923	for my $ext (sort keys %ext_arg) {
548	my @files = grep -f $_, map "$_/$ext", @dirs;	924	my @files = grep -f $_, map "$_/$ext", @dirs;
549		925
550	if (@files) {	926	if (@files) {
551	$TERM->register_package (extension_package $files[0], $argv);	927	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
552	} else {	928	} else {
553	warn "perl extension '$ext' not found in perl library search path\n";	929	warn "perl extension '$ext' not found in perl library search path\n";
554	}	930	}
555	}	931	}
556		932
…		…
562		938
563	if (my $cb = $TERM->{_hook}[$htype]) {	939	if (my $cb = $TERM->{_hook}[$htype]) {
564	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	940	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
565	if $verbosity >= 10;	941	if $verbosity >= 10;
566		942
567	keys %$cb;	943	for my $pkg (keys %$cb) {
568
569	while (my ($pkg, $cb) = each %$cb) {
570	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	944	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
571	and last;	945	$retval ||= $retval_;
572		946
573	if ($@) {	947	if ($@) {
574	$TERM->ungrab; # better to lose the grab than the session	948	$TERM->ungrab; # better to lose the grab than the session
575	warn $@;	949	warn $@;
576	}	950	}
577	}	951	}
		952
		953	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		954	if $verbosity >= 11;
578	}	955	}
579		956
580	if ($htype == 1) { # DESTROY	957	if ($htype == 1) { # DESTROY
581	if (my $hook = delete $TERM->{_hook}) {
582	for my $htype (0..$#$hook) {
583	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
584	or set_should_invoke $htype, 0;
585	}
586	}
587
588	# clear package objects	958	# clear package objects
589	%$_ = () for values %{ $TERM->{_pkg} };	959	%$_ = () for values %{ $TERM->{_pkg} };
590		960
591	# clear package	961	# clear package
592	%$TERM = ();	962	%$TERM = ();
593	}	963	}
594		964
595	$retval	965	$retval
		966	}
		967
		968	sub SET_COLOR($$$) {
		969	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
596	}	970	}
597		971
598	# urxvt::term::extension	972	# urxvt::term::extension
599		973
600	package urxvt::term::extension;	974	package urxvt::term::extension;
…		…
606	while (my ($name, $cb) = each %hook) {	980	while (my ($name, $cb) = each %hook) {
607	my $htype = $HOOKTYPE{uc $name};	981	my $htype = $HOOKTYPE{uc $name};
608	defined $htype	982	defined $htype
609	or Carp::croak "unsupported hook type '$name'";	983	or Carp::croak "unsupported hook type '$name'";
610		984
		985	$self->set_should_invoke ($htype, +1)
611	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	986	unless exists $self->{term}{_hook}[$htype]{$pkg};
612	$hook_count[$htype]++
613	or urxvt::set_should_invoke $htype, 1;
614	}
615		987
616	$self->{term}{_hook}[$htype]{$pkg} = $cb;	988	$self->{term}{_hook}[$htype]{$pkg} = $cb;
617	}	989	}
618	}	990	}
619		991
…		…
624	for my $name (@hook) {	996	for my $name (@hook) {
625	my $htype = $HOOKTYPE{uc $name};	997	my $htype = $HOOKTYPE{uc $name};
626	defined $htype	998	defined $htype
627	or Carp::croak "unsupported hook type '$name'";	999	or Carp::croak "unsupported hook type '$name'";
628		1000
		1001	$self->set_should_invoke ($htype, -1)
629	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1002	if delete $self->{term}{_hook}[$htype]{$pkg};
630	--$hook_count[$htype]
631	or urxvt::set_should_invoke $htype, 0;
632	}
633	}	1003	}
634	}	1004	}
635		1005
636	our $AUTOLOAD;	1006	our $AUTOLOAD;
637		1007
…		…
668		1038
669	=head2 The C<urxvt::anyevent> Class	1039	=head2 The C<urxvt::anyevent> Class
670		1040
671	The sole purpose of this class is to deliver an interface to the	1041	The sole purpose of this class is to deliver an interface to the
672	C<AnyEvent> module - any module using it will work inside urxvt without	1042	C<AnyEvent> module - any module using it will work inside urxvt without
673	further work. The only exception is that you cannot wait on condition	1043	further programming. The only exception is that you cannot wait on
674	variables, but non-blocking condvar use is ok. What this means is that you	1044	condition variables, but non-blocking condvar use is ok. What this means
675	cannot use blocking APIs, but the non-blocking variant should work.	1045	is that you cannot use blocking APIs, but the non-blocking variant should
		1046	work.
676		1047
677	=cut	1048	=cut
678		1049
679	our $VERSION = 1;	1050	our $VERSION = 1;
680		1051
…		…
742	# find on_xxx subs in the package and register them	1113	# find on_xxx subs in the package and register them
743	# as hooks	1114	# as hooks
744	sub register_package {	1115	sub register_package {
745	my ($self, $pkg, $argv) = @_;	1116	my ($self, $pkg, $argv) = @_;
746		1117
		1118	no strict 'refs';
		1119
		1120	urxvt::verbose 6, "register package $pkg to $self";
		1121
		1122	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1123
747	my $proxy = bless {	1124	my $proxy = bless {
748	_pkg => $pkg,	1125	_pkg => $pkg,
749	argv => $argv,	1126	argv => $argv,
750	}, $pkg;	1127	}, $pkg;
751	Scalar::Util::weaken ($proxy->{term} = $self);	1128	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
757	$proxy->enable ($name => $ref);	1134	$proxy->enable ($name => $ref);
758	}	1135	}
759	}	1136	}
760	}	1137	}
761		1138
		1139	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1140
		1141	Creates a new terminal, very similar as if you had started it with system
		1142	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1143	hash which defines the environment of the new terminal.
		1144
		1145	Croaks (and probably outputs an error message) if the new instance
		1146	couldn't be created. Returns C<undef> if the new instance didn't
		1147	initialise perl, and the terminal object otherwise. The C<init> and
		1148	C<start> hooks will be called before this call returns, and are free to
		1149	refer to global data (which is race free).
		1150
		1151	=cut
		1152
		1153	sub new {
		1154	my ($class, $env, @args) = @_;
		1155
		1156	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1157	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1158
		1159	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1160	}
		1161
762	=item $term->destroy	1162	=item $term->destroy
763		1163
764	Destroy the terminal object (close the window, free resources etc.).	1164	Destroy the terminal object (close the window, free resources
		1165	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1166	watchers (timers, io watchers) are still active.
		1167
		1168	=item $term->exec_async ($cmd[, @args])
		1169
		1170	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1171	("starts") programs in the background. This function takes care of setting
		1172	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1173	be preferred over explicit calls to C<exec> or C<system>.
		1174
		1175	Returns the pid of the subprocess or C<undef> on error.
		1176
		1177	=cut
		1178
		1179	sub exec_async {
		1180	my $self = shift;
		1181
		1182	my $pid = fork;
		1183
		1184	return $pid
		1185	if !defined $pid or $pid;
		1186
		1187	%ENV = %{ $self->env };
		1188
		1189	exec @_;
		1190	urxvt::_exit 255;
		1191	}
765		1192
766	=item $isset = $term->option ($optval[, $set])	1193	=item $isset = $term->option ($optval[, $set])
767		1194
768	Returns true if the option specified by C<$optval> is enabled, and	1195	Returns true if the option specified by C<$optval> is enabled, and
769	optionally change it. All option values are stored by name in the hash	1196	optionally change it. All option values are stored by name in the hash
770	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1197	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
771		1198
772	Here is a a likely non-exhaustive list of option names, please see the	1199	Here is a likely non-exhaustive list of option names, please see the
773	source file F</src/optinc.h> to see the actual list:	1200	source file F</src/optinc.h> to see the actual list:
774		1201
775	borderLess console cursorBlink cursorUnderline hold iconic insecure	1202	borderLess console cursorBlink cursorUnderline hold iconic insecure
776	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1203	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
777	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1204	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
778	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1205	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
779	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1206	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
780	tripleclickwords utmpInhibit visualBell	1207	transparent tripleclickwords utmpInhibit visualBell
781		1208
782	=item $value = $term->resource ($name[, $newval])	1209	=item $value = $term->resource ($name[, $newval])
783		1210
784	Returns the current resource value associated with a given name and	1211	Returns the current resource value associated with a given name and
785	optionally sets a new value. Setting values is most useful in the C<init>	1212	optionally sets a new value. Setting values is most useful in the C<init>
…		…
794	likely change).	1221	likely change).
795		1222
796	Please note that resource strings will currently only be freed when the	1223	Please note that resource strings will currently only be freed when the
797	terminal is destroyed, so changing options frequently will eat memory.	1224	terminal is destroyed, so changing options frequently will eat memory.
798		1225
799	Here is a a likely non-exhaustive list of resource names, not all of which	1226	Here is a likely non-exhaustive list of resource names, not all of which
800	are supported in every build, please see the source file F</src/rsinc.h>	1227	are supported in every build, please see the source file F</src/rsinc.h>
801	to see the actual list:	1228	to see the actual list:
802		1229
803	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1230	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
804	borderLess color cursorBlink cursorUnderline cutchars delete_key	1231	borderLess color cursorBlink cursorUnderline cutchars delete_key
805	display_name embed ext_bwidth fade font geometry hold iconName	1232	display_name embed ext_bwidth fade font geometry hold iconName
806	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1233	imFont imLocale inputMethod insecure int_bwidth intensityStyles
807	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1234	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
808	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1235	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
809	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1236	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
810	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1237	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
811	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1238	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
812	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1239	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
813	shade term_name title transparent transparent_all tripleclickwords	1240	secondaryScreen secondaryScroll selectstyle shade term_name title
814	utmpInhibit visualBell	1241	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1242	visualBell
815		1243
816	=cut	1244	=cut
817		1245
818	sub resource($$;$) {	1246	sub resource($$;$) {
819	my ($self, $name) = (shift, shift);	1247	my ($self, $name) = (shift, shift);
820	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1248	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
821	&urxvt::term::_resource	1249	&urxvt::term::_resource
822	}	1250	}
823		1251
		1252	=item $value = $term->x_resource ($pattern)
		1253
		1254	Returns the X-Resource for the given pattern, excluding the program or
		1255	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1256	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1257	resource with that pattern exists.
		1258
		1259	This method should only be called during the C<on_start> hook, as there is
		1260	only one resource database per display, and later invocations might return
		1261	the wrong resources.
		1262
824	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1263	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
825		1264
826	Adds a keymap translation exactly as specified via a resource. See the	1265	Adds a keymap translation exactly as specified via a resource. See the
827	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1266	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
828		1267
…		…
843	=item ($row, $col) = $term->selection_end ([$row, $col])	1282	=item ($row, $col) = $term->selection_end ([$row, $col])
844		1283
845	Return the current values of the selection mark, begin or end positions,	1284	Return the current values of the selection mark, begin or end positions,
846	and optionally set them to new values.	1285	and optionally set them to new values.
847		1286
		1287	=item $term->selection_make ($eventtime[, $rectangular])
		1288
		1289	Tries to make a selection as set by C<selection_beg> and
		1290	C<selection_end>. If C<$rectangular> is true (default: false), a
		1291	rectangular selection will be made. This is the prefered function to make
		1292	a selection.
		1293
848	=item $success = $term->selection_grab ($eventtime)	1294	=item $success = $term->selection_grab ($eventtime)
849		1295
850	Try to request the primary selection from the server (for example, as set	1296	Try to request the primary selection text from the server (for example, as
851	by the next method).	1297	set by the next method). No visual feedback will be given. This function
		1298	is mostly useful from within C<on_sel_grab> hooks.
852		1299
853	=item $oldtext = $term->selection ([$newtext])	1300	=item $oldtext = $term->selection ([$newtext])
854		1301
855	Return the current selection text and optionally replace it by C<$newtext>.	1302	Return the current selection text and optionally replace it by C<$newtext>.
856		1303
…		…
949	Convert the given locale-encoded octets into a perl string.	1396	Convert the given locale-encoded octets into a perl string.
950		1397
951	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1398	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
952		1399
953	XORs the rendition values in the given span with the provided value	1400	XORs the rendition values in the given span with the provided value
954	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1401	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
955	to the selection.	1402	refresh hooks to provide effects similar to the selection.
956		1403
957	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1404	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
958		1405
959	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1406	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
960	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1407	whitespace will additionally be xored with the C<$rstyle2>, which defaults
961	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1408	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
962	it instead.	1409	it instead. Both styles I<MUST NOT> contain font styles.
963		1410
964	=item $term->scr_bell	1411	=item $term->scr_bell
965		1412
966	Ring the bell!	1413	Ring the bell!
967		1414
…		…
974		1421
975	Normally its not a good idea to use this function, as programs might be	1422	Normally its not a good idea to use this function, as programs might be
976	confused by changes in cursor position or scrolling. Its useful inside a	1423	confused by changes in cursor position or scrolling. Its useful inside a
977	C<on_add_lines> hook, though.	1424	C<on_add_lines> hook, though.
978		1425
		1426	=item $term->scr_change_screen ($screen)
		1427
		1428	Switch to given screen - 0 primary, 1 secondary.
		1429
979	=item $term->cmd_parse ($octets)	1430	=item $term->cmd_parse ($octets)
980		1431
981	Similar to C<scr_add_lines>, but the argument must be in the	1432	Similar to C<scr_add_lines>, but the argument must be in the
982	locale-specific encoding of the terminal and can contain command sequences	1433	locale-specific encoding of the terminal and can contain command sequences
983	(escape codes) that will be interpreted.	1434	(escape codes) that will be interpreted.
…		…
993	Replaces the event mask of the pty watcher by the given event mask. Can	1444	Replaces the event mask of the pty watcher by the given event mask. Can
994	be used to suppress input and output handling to the pty/tty. See the	1445	be used to suppress input and output handling to the pty/tty. See the
995	description of C<< urxvt::timer->events >>. Make sure to always restore	1446	description of C<< urxvt::timer->events >>. Make sure to always restore
996	the previous value.	1447	the previous value.
997		1448
		1449	=item $fd = $term->pty_fd
		1450
		1451	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1452	is used.
		1453
998	=item $windowid = $term->parent	1454	=item $windowid = $term->parent
999		1455
1000	Return the window id of the toplevel window.	1456	Return the window id of the toplevel window.
1001		1457
1002	=item $windowid = $term->vt	1458	=item $windowid = $term->vt
1003		1459
1004	Return the window id of the terminal window.	1460	Return the window id of the terminal window.
1005		1461
		1462	=item $term->vt_emask_add ($x_event_mask)
		1463
		1464	Adds the specified events to the vt event mask. Useful e.g. when you want
		1465	to receive pointer events all the times:
		1466
		1467	$term->vt_emask_add (urxvt::PointerMotionMask);
		1468
		1469	=item $term->focus_in
		1470
		1471	=item $term->focus_out
		1472
		1473	=item $term->key_press ($state, $keycode[, $time])
		1474
		1475	=item $term->key_release ($state, $keycode[, $time])
		1476
		1477	Deliver various fake events to to terminal.
		1478
1006	=item $window_width = $term->width	1479	=item $window_width = $term->width
1007		1480
1008	=item $window_height = $term->height	1481	=item $window_height = $term->height
1009		1482
1010	=item $font_width = $term->fwidth	1483	=item $font_width = $term->fwidth
…		…
1023		1496
1024	=item $max_scrollback = $term->saveLines	1497	=item $max_scrollback = $term->saveLines
1025		1498
1026	=item $nrow_plus_saveLines = $term->total_rows	1499	=item $nrow_plus_saveLines = $term->total_rows
1027		1500
1028	=item $lines_in_scrollback = $term->nsaved	1501	=item $topmost_scrollback_row = $term->top_row
1029		1502
1030	Return various integers describing terminal characteristics.	1503	Return various integers describing terminal characteristics.
1031		1504
		1505	=item $x_display = $term->display_id
		1506
		1507	Return the DISPLAY used by rxvt-unicode.
		1508
1032	=item $lc_ctype = $term->locale	1509	=item $lc_ctype = $term->locale
1033		1510
1034	Returns the LC_CTYPE category string used by this rxvt-unicode.	1511	Returns the LC_CTYPE category string used by this rxvt-unicode.
1035		1512
1036	=item $x_display = $term->display_id	1513	=item $env = $term->env
1037		1514
1038	Return the DISPLAY used by rxvt-unicode.	1515	Returns a copy of the environment in effect for the terminal as a hashref
		1516	similar to C<\%ENV>.
		1517
		1518	=item @envv = $term->envv
		1519
		1520	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1521
		1522	=item @argv = $term->argv
		1523
		1524	Return the argument vector as this terminal, similar to @ARGV, but
		1525	includes the program name as first element.
		1526
		1527	=cut
		1528
		1529	sub env {
		1530	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1531	}
1039		1532
1040	=item $modifiermask = $term->ModLevel3Mask	1533	=item $modifiermask = $term->ModLevel3Mask
1041		1534
1042	=item $modifiermask = $term->ModMetaMask	1535	=item $modifiermask = $term->ModMetaMask
1043		1536
1044	=item $modifiermask = $term->ModNumLockMask	1537	=item $modifiermask = $term->ModNumLockMask
1045		1538
1046	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1539	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1047	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1540	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1048		1541
		1542	=item $screen = $term->current_screen
		1543
		1544	Returns the currently displayed screen (0 primary, 1 secondary).
		1545
		1546	=item $cursor_is_hidden = $term->hidden_cursor
		1547
		1548	Returns whether the cursor is currently hidden or not.
		1549
1049	=item $view_start = $term->view_start ([$newvalue])	1550	=item $view_start = $term->view_start ([$newvalue])
1050		1551
1051	Returns the negative row number of the topmost line. Minimum value is	1552	Returns the row number of the topmost displayed line. Maximum value is
1052	C<0>, which displays the normal terminal contents. Larger values scroll	1553	C<0>, which displays the normal terminal contents. Lower values scroll
1053	this many lines into the scrollback buffer.	1554	this many lines into the scrollback buffer.
1054		1555
1055	=item $term->want_refresh	1556	=item $term->want_refresh
1056		1557
1057	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1558	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1072	line, starting at column C<$start_col> (default C<0>), which is useful	1573	line, starting at column C<$start_col> (default C<0>), which is useful
1073	to replace only parts of a line. The font index in the rendition will	1574	to replace only parts of a line. The font index in the rendition will
1074	automatically be updated.	1575	automatically be updated.
1075		1576
1076	C<$text> is in a special encoding: tabs and wide characters that use more	1577	C<$text> is in a special encoding: tabs and wide characters that use more
1077	than one cell when displayed are padded with urxvt::NOCHAR characters	1578	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1078	(C<chr 65535>). Characters with combining characters and other characters	1579	characters. Characters with combining characters and other characters that
1079	that do not fit into the normal tetx encoding will be replaced with	1580	do not fit into the normal tetx encoding will be replaced with characters
1080	characters in the private use area.	1581	in the private use area.
1081		1582
1082	You have to obey this encoding when changing text. The advantage is	1583	You have to obey this encoding when changing text. The advantage is
1083	that C<substr> and similar functions work on screen cells and not on	1584	that C<substr> and similar functions work on screen cells and not on
1084	characters.	1585	characters.
1085		1586
…		…
1136	Return the row number of the first/last row of the line, respectively.	1637	Return the row number of the first/last row of the line, respectively.
1137		1638
1138	=item $offset = $line->offset_of ($row, $col)	1639	=item $offset = $line->offset_of ($row, $col)
1139		1640
1140	Returns the character offset of the given row|col pair within the logical	1641	Returns the character offset of the given row|col pair within the logical
1141	line.	1642	line. Works for rows outside the line, too, and returns corresponding
		1643	offsets outside the string.
1142		1644
1143	=item ($row, $col) = $line->coord_of ($offset)	1645	=item ($row, $col) = $line->coord_of ($offset)
1144		1646
1145	Translates a string offset into terminal coordinates again.	1647	Translates a string offset into terminal coordinates again.
1146		1648
…		…
1228	where one character corresponds to one screen cell. See	1730	where one character corresponds to one screen cell. See
1229	C<< $term->ROW_t >> for details.	1731	C<< $term->ROW_t >> for details.
1230		1732
1231	=item $string = $term->special_decode $text	1733	=item $string = $term->special_decode $text
1232		1734
1233	Converts rxvt-unicodes text reprsentation into a perl string. See	1735	Converts rxvt-unicodes text representation into a perl string. See
1234	C<< $term->ROW_t >> for details.	1736	C<< $term->ROW_t >> for details.
1235		1737
1236	=item $success = $term->grab_button ($button, $modifiermask)	1738	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1237		1739
		1740	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1741
1238	Registers a synchronous button grab. See the XGrabButton manpage.	1742	Register/unregister a synchronous button grab. See the XGrabButton
		1743	manpage.
1239		1744
1240	=item $success = $term->grab ($eventtime[, $sync])	1745	=item $success = $term->grab ($eventtime[, $sync])
1241		1746
1242	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1747	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1243	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1748	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1244		1749
1245	=item $term->allow_events_async	1750	=item $term->allow_events_async
1246		1751
1247	Calls XAllowEvents with AsyncBoth for the most recent grab.	1752	Calls XAllowEvents with AsyncBoth for the most recent grab.
1248		1753
…		…
1259		1764
1260	Calls XUngrab for the most recent grab. Is called automatically on	1765	Calls XUngrab for the most recent grab. Is called automatically on
1261	evaluation errors, as it is better to lose the grab in the error case as	1766	evaluation errors, as it is better to lose the grab in the error case as
1262	the session.	1767	the session.
1263		1768
		1769	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1770
		1771	=item $atom_name = $term->XGetAtomName ($atom)
		1772
		1773	=item @atoms = $term->XListProperties ($window)
		1774
		1775	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1776
		1777	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1778
		1779	=item $term->XDeleteProperty ($window, $property)
		1780
		1781	=item $window = $term->DefaultRootWindow
		1782
		1783	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1784
		1785	=item $term->XMapWindow ($window)
		1786
		1787	=item $term->XUnmapWindow ($window)
		1788
		1789	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1790
		1791	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1792
		1793	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1794
		1795	Various X or X-related functions. The C<$term> object only serves as
		1796	the source of the display, otherwise those functions map more-or-less
		1797	directory onto the X functions of the same name.
		1798
1264	=back	1799	=back
1265		1800
1266	=cut	1801	=cut
1267		1802
1268	package urxvt::popup;	1803	package urxvt::popup;
…		…
1282		1817
1283	$item->{render} ||= sub { $_[0]{text} };	1818	$item->{render} ||= sub { $_[0]{text} };
1284		1819
1285	push @{ $self->{item} }, $item;	1820	push @{ $self->{item} }, $item;
1286	}	1821	}
		1822
		1823	=item $popup->add_title ($title)
		1824
		1825	Adds a non-clickable title to the popup.
		1826
		1827	=cut
		1828
		1829	sub add_title {
		1830	my ($self, $title) = @_;
		1831
		1832	$self->add_item ({
		1833	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1834	text => $title,
		1835	activate => sub { },
		1836	});
		1837	}
		1838
		1839	=item $popup->add_separator ([$sepchr])
		1840
		1841	Creates a separator, optionally using the character given as C<$sepchr>.
		1842
		1843	=cut
1287		1844
1288	sub add_separator {	1845	sub add_separator {
1289	my ($self, $sep) = @_;	1846	my ($self, $sep) = @_;
1290		1847
1291	$sep ||= "=";	1848	$sep ||= "=";
…		…
1296	render => sub { $sep x $self->{term}->ncol },	1853	render => sub { $sep x $self->{term}->ncol },
1297	activate => sub { },	1854	activate => sub { },
1298	});	1855	});
1299	}	1856	}
1300		1857
1301	sub add_title {	1858	=item $popup->add_button ($text, $cb)
1302	my ($self, $title) = @_;
1303		1859
1304	$self->add_item ({	1860	Adds a clickable button to the popup. C<$cb> is called whenever it is
1305	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1861	selected.
1306	text => $title,	1862
1307	activate => sub { },	1863	=cut
1308	});
1309	}
1310		1864
1311	sub add_button {	1865	sub add_button {
1312	my ($self, $text, $cb) = @_;	1866	my ($self, $text, $cb) = @_;
1313		1867
1314	$self->add_item ({ type => "button", text => $text, activate => $cb});	1868	$self->add_item ({ type => "button", text => $text, activate => $cb});
1315	}	1869	}
1316		1870
		1871	=item $popup->add_toggle ($text, $initial_value, $cb)
		1872
		1873	Adds a toggle/checkbox item to the popup. The callback gets called
		1874	whenever it gets toggled, with a boolean indicating its new value as its
		1875	first argument.
		1876
		1877	=cut
		1878
1317	sub add_toggle {	1879	sub add_toggle {
1318	my ($self, $text, $cb, $value) = @_;	1880	my ($self, $text, $value, $cb) = @_;
1319		1881
1320	my $item; $item = {	1882	my $item; $item = {
1321	type => "button",	1883	type => "button",
1322	text => " $text",	1884	text => " $text",
1323	value => $value,	1885	value => $value,
1324	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1886	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1325	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1887	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1326	};	1888	};
1327		1889
1328	$self->add_item ($item);	1890	$self->add_item ($item);
1329	}	1891	}
		1892
		1893	=item $popup->show
		1894
		1895	Displays the popup (which is initially hidden).
		1896
		1897	=cut
1330		1898
1331	sub show {	1899	sub show {
1332	my ($self) = @_;	1900	my ($self) = @_;
1333		1901
1334	local $urxvt::popup::self = $self;	1902	local $urxvt::popup::self = $self;
1335		1903
		1904	my $env = $self->{term}->env;
		1905	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1906	delete $env->{LC_ALL};
1336	local $ENV{LC_ALL} = $self->{term}->locale;	1907	$env->{LC_CTYPE} = $self->{term}->locale;
1337		1908
1338	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1909	urxvt::term->new ($env, "popup",
		1910	"--perl-lib" => "", "--perl-ext-common" => "",
		1911	"-pty-fd" => -1, "-sl" => 0,
		1912	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1339	"--transient-for" => $self->{term}->parent,	1913	"--transient-for" => $self->{term}->parent,
1340	"-display" => $self->{term}->display_id,	1914	"-display" => $self->{term}->display_id,
1341	"-pe" => "urxvt-popup")	1915	"-pe" => "urxvt-popup")
1342	or die "unable to create popup window\n";	1916	or die "unable to create popup window\n";
1343	}	1917	}
1344		1918
1345	sub DESTROY {	1919	sub DESTROY {
1346	my ($self) = @_;	1920	my ($self) = @_;
1347		1921
1348	delete $self->{term}{_destroy}{$self};	1922	delete $self->{term}{_destroy}{$self};
1349	$self->{term}->ungrab;	1923	$self->{term}->ungrab;
1350	}	1924	}
		1925
		1926	=back
		1927
		1928	=cut
		1929
		1930	package urxvt::watcher;
		1931
		1932	@urxvt::timer::ISA = __PACKAGE__;
		1933	@urxvt::iow::ISA = __PACKAGE__;
		1934	@urxvt::pw::ISA = __PACKAGE__;
		1935	@urxvt::iw::ISA = __PACKAGE__;
1351		1936
1352	=head2 The C<urxvt::timer> Class	1937	=head2 The C<urxvt::timer> Class
1353		1938
1354	This class implements timer watchers/events. Time is represented as a	1939	This class implements timer watchers/events. Time is represented as a
1355	fractional number of seconds since the epoch. Example:	1940	fractional number of seconds since the epoch. Example:
…		…
1393	Start the timer.	1978	Start the timer.
1394		1979
1395	=item $timer = $timer->start ($tstamp)	1980	=item $timer = $timer->start ($tstamp)
1396		1981
1397	Set the event trigger time to C<$tstamp> and start the timer.	1982	Set the event trigger time to C<$tstamp> and start the timer.
		1983
		1984	=item $timer = $timer->after ($delay)
		1985
		1986	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1398		1987
1399	=item $timer = $timer->stop	1988	=item $timer = $timer->stop
1400		1989
1401	Stop the timer.	1990	Stop the timer.
1402		1991
…		…
1431	Set the callback to be called when io events are triggered. C<$reventmask>	2020	Set the callback to be called when io events are triggered. C<$reventmask>
1432	is a bitset as described in the C<events> method.	2021	is a bitset as described in the C<events> method.
1433		2022
1434	=item $iow = $iow->fd ($fd)	2023	=item $iow = $iow->fd ($fd)
1435		2024
1436	Set the filedescriptor (not handle) to watch.	2025	Set the file descriptor (not handle) to watch.
1437		2026
1438	=item $iow = $iow->events ($eventmask)	2027	=item $iow = $iow->events ($eventmask)
1439		2028
1440	Set the event mask to watch. The only allowed values are	2029	Set the event mask to watch. The only allowed values are
1441	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2030	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
…		…
1445		2034
1446	Start watching for requested events on the given handle.	2035	Start watching for requested events on the given handle.
1447		2036
1448	=item $iow = $iow->stop	2037	=item $iow = $iow->stop
1449		2038
1450	Stop watching for events on the given filehandle.	2039	Stop watching for events on the given file handle.
		2040
		2041	=back
		2042
		2043	=head2 The C<urxvt::iw> Class
		2044
		2045	This class implements idle watchers, that get called automatically when
		2046	the process is idle. They should return as fast as possible, after doing
		2047	some useful work.
		2048
		2049	=over 4
		2050
		2051	=item $iw = new urxvt::iw
		2052
		2053	Create a new idle watcher object in stopped state.
		2054
		2055	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2056
		2057	Set the callback to be called when the watcher triggers.
		2058
		2059	=item $timer = $timer->start
		2060
		2061	Start the watcher.
		2062
		2063	=item $timer = $timer->stop
		2064
		2065	Stop the watcher.
		2066
		2067	=back
		2068
		2069	=head2 The C<urxvt::pw> Class
		2070
		2071	This class implements process watchers. They create an event whenever a
		2072	process exits, after which they stop automatically.
		2073
		2074	my $pid = fork;
		2075	...
		2076	$term->{pw} = urxvt::pw
		2077	->new
		2078	->start ($pid)
		2079	->cb (sub {
		2080	my ($pw, $exit_status) = @_;
		2081	...
		2082	});
		2083
		2084	=over 4
		2085
		2086	=item $pw = new urxvt::pw
		2087
		2088	Create a new process watcher in stopped state.
		2089
		2090	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2091
		2092	Set the callback to be called when the timer triggers.
		2093
		2094	=item $pw = $timer->start ($pid)
		2095
		2096	Tells the watcher to start watching for process C<$pid>.
		2097
		2098	=item $pw = $pw->stop
		2099
		2100	Stop the watcher.
1451		2101
1452	=back	2102	=back
1453		2103
1454	=head1 ENVIRONMENT	2104	=head1 ENVIRONMENT
1455		2105
…		…
1462		2112
1463	=item == 0 - fatal messages	2113	=item == 0 - fatal messages
1464		2114
1465	=item >= 3 - script loading and management	2115	=item >= 3 - script loading and management
1466		2116
1467	=item >=10 - all events received	2117	=item >=10 - all called hooks
		2118
		2119	=item >=11 - hook return values
1468		2120
1469	=back	2121	=back
1470		2122
1471	=head1 AUTHOR	2123	=head1 AUTHOR
1472		2124

Diff Legend

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