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.61 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.137 by root, Sat Mar 4 20:17:52 2006 UTC

…		…
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 followign 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
71	=item digital-clock	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.
72		125
73	Displays a digital clock using the built-in overlay.	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 wether 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
		141	=item searchable-scrollback<hotkey> (enabled by default)
		142
		143	Adds regex search functionality to the scrollback buffer, triggered
		144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		145	input/output is suspended and a regex is displayed at the bottom of the
		146	screen.
		147
		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.
		155
		156	=item readline (enabled by default)
		157
		158	A support package that tries to make editing with readline easier. At
		159	the moment, it reacts to clicking shift-left mouse button by trying to
		160	move the text cursor to this position. It does so by generating as many
		161	cursor-left or cursor-right keypresses as required (the this only works
		162	for programs that correctly support wide characters).
		163
		164	To avoid too many false positives, this is only done when:
		165
		166	=over 4
		167
		168	=item - the tty is in ICANON state.
		169
		170	=item - the text cursor is visible.
		171
		172	=item - the primary screen is currently being displayed.
		173
		174	=item - the mouse is on the same (multi-row-) line as the text cursor.
		175
		176	=back
		177
		178	The normal selection mechanism isn't disabled, so quick successive clicks
		179	might interfere with selection creation in harmless ways.
		180
		181	=item selection-autotransform
		182
		183	This selection allows you to do automatic transforms on a selection
		184	whenever a selection is made.
		185
		186	It works by specifying perl snippets (most useful is a single C<s///>
		187	operator) that modify C<$_> as resources:
		188
		189	URxvt.selection-autotransform.0: transform
		190	URxvt.selection-autotransform.1: transform
		191	...
		192
		193	For example, the following will transform selections of the form
		194	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		195	$word>:
		196
		197	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		198
		199	And this example matches the same,but replaces it with vi-commands you can
		200	paste directly into your (vi :) editor:
		201
		202	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		203
		204	Of course, this can be modified to suit your needs and your editor :)
		205
		206	To expand the example above to typical perl error messages ("XXX at
		207	FILENAME line YYY."), you need a slightly more elaborate solution:
		208
		209	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		210	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		211
		212	The first line tells the selection code to treat the unchanging part of
		213	every error message as a selection pattern, and the second line transforms
		214	the message into vi commands to load the file.
		215
		216	=item tabbed
		217
		218	This transforms the terminal into a tabbar with additional terminals, that
		219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		220	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		221	button per tab.
		222
		223	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		224	B<Shift-Right> will switch to the tab left or right of the current one,
		225	while B<Shift-Down> creates a new tab.
		226
		227	The tabbar itself can be configured similarly to a normal terminal, but
		228	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		229	following four resources (shown with defaults):
		230
		231	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		232	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		233	URxvt.tabbed.tab-fg: <colour-index, default 0>
		234	URxvt.tabbed.tab-bg: <colour-index, default 1>
		235
		236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		237	indices.
74		238
75	=item mark-urls	239	=item mark-urls
76		240
77	Uses per-line display filtering (C<on_line_update>) to underline urls.	241	Uses per-line display filtering (C<on_line_update>) to underline urls and
		242	make them clickable. When middle-clicked, the program specified in the
		243	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		244	the URL as first argument.
		245
		246	=item xim-onthespot
		247
		248	This (experimental) perl extension implements OnTheSpot editing. It does
		249	not work perfectly, and some input methods don't seem to work well with
		250	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		251	kinput2.
		252
		253	You enable it by specifying this extension and a preedit style of
		254	C<OnTheSpot>, i.e.:
		255
		256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		257
		258	=item automove-background
		259
		260	This is basically a one-line extension that dynamically changes the background pixmap offset
		261	to the window position, in effect creating the same effect as pseudo transparency with
		262	a custom pixmap. No scaling is supported in this mode. Exmaple:
		263
		264	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
78		265
79	=item block-graphics-to-ascii	266	=item block-graphics-to-ascii
80		267
81	A not very useful example of filtering all text output to the terminal,	268	A not very useful example of filtering all text output to the terminal,
82	by replacing all line-drawing characters (U+2500 .. U+259F) by a	269	by replacing all line-drawing characters (U+2500 .. U+259F) by a
83	similar-looking ascii character.	270	similar-looking ascii character.
84		271
		272	=item digital-clock
		273
		274	Displays a digital clock using the built-in overlay.
		275
		276	=item remote-clipboard
		277
		278	Somewhat of a misnomer, this extension adds two menu entries to the
		279	selection popup that allows one ti run external commands to store the
		280	selection somewhere and fetch it again.
		281
		282	We use it to implement a "distributed selection mechanism", which just
		283	means that one command uploads the file to a remote server, and another
		284	reads it.
		285
		286	The commands can be set using the C<URxvt.remote-selection.store> and
		287	C<URxvt.remote-selection.fetch> resources. The first should read the
		288	selection to store from STDIN (always in UTF-8), the second should provide
		289	the selection data on STDOUT (also in UTF-8).
		290
		291	The defaults (which are likely useless to you) use rsh and cat:
		292
		293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		295
		296	=item selection-pastebin
		297
		298	This is a little rarely useful extension that Uploads the selection as
		299	textfile to a remote site (or does other things). (The implementation is
		300	not currently secure for use in a multiuser environment as it writes to
		301	F</tmp> directly.).
		302
		303	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		304	i.e.
		305
		306	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		307
		308	Pressing this combination runs a command with C<%> replaced by the name of
		309	the textfile. This command can be set via a resource:
		310
		311	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		312
		313	And the default is likely not useful to anybody but the few people around
		314	here :)
		315
		316	The name of the textfile is the hex encoded md5 sum of the selection, so
		317	the same content should lead to the same filename.
		318
		319	After a successful upload the selection will be replaced by the text given
		320	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		321	for the filename):
		322
		323	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		324
85	=item example-refresh-hooks	325	=item example-refresh-hooks
86		326
87	Displays a very simple digital clock in the upper right corner of the	327	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own	328	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	329	overlays or changes.
90		330
91	=back	331	=back
		332
		333	=head1 API DOCUMENTATION
92		334
93	=head2 General API Considerations	335	=head2 General API Considerations
94		336
95	All objects (such as terminals, time watchers etc.) are typical	337	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	338	reference-to-hash objects. The hash can be used to store anything you
…		…
109	=over 4	351	=over 4
110		352
111	=item $text	353	=item $text
112		354
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	355	Rxvt-unicodes special way of encoding text, where one "unicode" character
114	always represents one screen cell. See L<row_t> for a discussion of this format.	356	always represents one screen cell. See L<ROW_t> for a discussion of this format.
115		357
116	=item $string	358	=item $string
117		359
118	A perl text string, with an emphasis on I<text>. It can store all unicode	360	A perl text string, with an emphasis on I<text>. It can store all unicode
119	characters and is to be distinguished with text encoded in a specific	361	characters and is to be distinguished with text encoded in a specific
…		…
124	Either binary data or - more common - a text string encoded in a	366	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	367	locale-specific way.
126		368
127	=back	369	=back
128		370
		371	=head2 Extension Objects
		372
		373	Very perl extension is a perl class. A separate perl object is created
		374	for each terminal and each extension and passed as the first parameter to
		375	hooks. So extensions can use their C<$self> object without having to think
		376	about other extensions, with the exception of methods and members that
		377	begin with an underscore character C<_>: these are reserved for internal
		378	use.
		379
		380	Although it isn't a C<urxvt::term> object, you can call all methods of the
		381	C<urxvt::term> class on this object.
		382
		383	It has the following methods and data members:
		384
		385	=over 4
		386
		387	=item $urxvt_term = $self->{term}
		388
		389	Returns the C<urxvt::term> object associated with this instance of the
		390	extension. This member I<must not> be changed in any way.
		391
		392	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		393
		394	Dynamically enable the given hooks (named without the C<on_> prefix) for
		395	this extension, replacing any previous hook. This is useful when you want
		396	to overwrite time-critical hooks only temporarily.
		397
		398	=item $self->disable ($hook_name[, $hook_name..])
		399
		400	Dynamically disable the given hooks.
		401
		402	=back
		403
129	=head2 Hooks	404	=head2 Hooks
130		405
131	The following subroutines can be declared in extension files, and will be	406	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	407	called whenever the relevant event happens.
133		408
134	The first argument passed to them is an object private to each terminal	409	The first argument passed to them is an extension oject as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	410	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		411
141	All of them must return a boolean value. If it is true, then the event	412	B<All> of these hooks must return a boolean value. If any of the called
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	413	hooks returns true, then the event counts as being I<consumed>, and the
143	and the relevant action might not be carried out by the C++ code.	414	relevant action might not be carried out by the C++ code.
144		415
145	When in doubt, return a false value (preferably C<()>).	416	I<< When in doubt, return a false value (preferably C<()>). >>
146		417
147	=over 4	418	=over 4
148		419
149	=item on_init $term	420	=item on_init $term
150		421
151	Called after a new terminal object has been initialized, but before	422	Called after a new terminal object has been initialized, but before
152	windows are created or the command gets run. Most methods are unsafe to	423	windows are created or the command gets run. Most methods are unsafe to
153	call or deliver senseless data, as terminal size and other characteristics	424	call or deliver senseless data, as terminal size and other characteristics
154	have not yet been determined. You can safely query and change resources,	425	have not yet been determined. You can safely query and change resources
155	though.	426	and options, though. For many purposes the C<on_start> hook is a better
		427	place.
		428
		429	=item on_start $term
		430
		431	Called at the very end of initialisation of a new terminal, just before
		432	trying to map (display) the toplevel and returning to the mainloop.
		433
		434	=item on_destroy $term
		435
		436	Called whenever something tries to destroy terminal, when the terminal is
		437	still fully functional (not for long, though).
156		438
157	=item on_reset $term	439	=item on_reset $term
158		440
159	Called after the screen is "reset" for any reason, such as resizing or	441	Called after the screen is "reset" for any reason, such as resizing or
160	control sequences. Here is where you can react on changes to size-related	442	control sequences. Here is where you can react on changes to size-related
161	variables.	443	variables.
162		444
163	=item on_start $term	445	=item on_child_start $term, $pid
164		446
165	Called at the very end of initialisation of a new terminal, just before	447	Called just after the child process has been C<fork>ed.
166	returning to the mainloop.	448
		449	=item on_child_exit $term, $status
		450
		451	Called just after the child process has exited. C<$status> is the status
		452	from C<waitpid>.
167		453
168	=item on_sel_make $term, $eventtime	454	=item on_sel_make $term, $eventtime
169		455
170	Called whenever a selection has been made by the user, but before the	456	Called whenever a selection has been made by the user, but before the
171	selection text is copied, so changes to the beginning, end or type of the	457	selection text is copied, so changes to the beginning, end or type of the
…		…
185	=item on_sel_extend $term	471	=item on_sel_extend $term
186		472
187	Called whenever the user tries to extend the selection (e.g. with a double	473	Called whenever the user tries to extend the selection (e.g. with a double
188	click) and is either supposed to return false (normal operation), or	474	click) and is either supposed to return false (normal operation), or
189	should extend the selection itelf and return true to suppress the built-in	475	should extend the selection itelf and return true to suppress the built-in
190	processing.	476	processing. This can happen multiple times, as long as the callback
		477	returns true, it will be called on every further click by the user and is
		478	supposed to enlarge the selection more and more, if possible.
191		479
192	See the F<selection> example extension.	480	See the F<selection> example extension.
193		481
194	=item on_view_change $term, $offset	482	=item on_view_change $term, $offset
195		483
…		…
205		493
206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	494	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
207	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	495	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
208	number of lines that will be in the scrollback buffer.	496	number of lines that will be in the scrollback buffer.
209		497
		498	=item on_osc_seq $term, $op, $args
		499
		500	Called on every OSC sequence and can be used to suppress it or modify its
		501	behaviour. The default should be to return an empty list. A true value
		502	suppresses execution of the request completely. Make sure you don't get
		503	confused by recursive invocations when you output an osc sequence within
		504	this callback.
		505
		506	C<on_osc_seq_perl> should be used for new behaviour.
		507
210	=item on_osc_seq $term, $string	508	=item on_osc_seq_perl $term, $string
211		509
212	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	510	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
213	operating system command) is processed. Cursor position and other state	511	operating system command) is processed. Cursor position and other state
214	information is up-to-date when this happens. For interoperability, the	512	information is up-to-date when this happens. For interoperability, the
215	string should start with the extension name and a colon, to distinguish	513	string should start with the extension name and a colon, to distinguish
…		…
226	can filter/change and output the text yourself by returning a true value	524	can filter/change and output the text yourself by returning a true value
227	and calling C<< $term->scr_add_lines >> yourself. Please note that this	525	and calling C<< $term->scr_add_lines >> yourself. Please note that this
228	might be very slow, however, as your hook is called for B<all> text being	526	might be very slow, however, as your hook is called for B<all> text being
229	output.	527	output.
230		528
		529	=item on_tt_write $term, $octets
		530
		531	Called whenever some data is written to the tty/pty and can be used to
		532	suppress or filter tty input.
		533
231	=item on_line_update $term, $row	534	=item on_line_update $term, $row
232		535
233	Called whenever a line was updated or changed. Can be used to filter	536	Called whenever a line was updated or changed. Can be used to filter
234	screen output (e.g. underline urls or other useless stuff). Only lines	537	screen output (e.g. underline urls or other useless stuff). Only lines
235	that are being shown will be filtered, and, due to performance reasons,	538	that are being shown will be filtered, and, due to performance reasons,
…		…
251		554
252	=item on_refresh_end $term	555	=item on_refresh_end $term
253		556
254	Called just after the screen gets redrawn. See C<on_refresh_begin>.	557	Called just after the screen gets redrawn. See C<on_refresh_begin>.
255		558
256	=item on_keyboard_command $term, $string	559	=item on_user_command $term, $string
257		560
258	Called whenever the user presses a key combination that has a	561	Called whenever the a user-configured event is being activated (e.g. via
259	C<perl:string> action bound to it (see description of the B<keysym>	562	a C<perl:string> action bound to a key, see description of the B<keysym>
260	resource in the @@RXVT_NAME@@(1) manpage).	563	resource in the @@RXVT_NAME@@(1) manpage).
		564
		565	The event is simply the action string. This interface is assumed to change
		566	slightly in the future.
		567
		568	=item on_resize_all_windows $tern, $new_width, $new_height
		569
		570	Called just after the new window size has been calculcated, but before
		571	windows are actually being resized or hints are being set. If this hook
		572	returns TRUE, setting of the window hints is being skipped.
		573
		574	=item on_x_event $term, $event
		575
		576	Called on every X event received on the vt window (and possibly other
		577	windows). Should only be used as a last resort. Most event structure
		578	members are not passed.
261		579
262	=item on_focus_in $term	580	=item on_focus_in $term
263		581
264	Called whenever the window gets the keyboard focus, before rxvt-unicode	582	Called whenever the window gets the keyboard focus, before rxvt-unicode
265	does focus in processing.	583	does focus in processing.
…		…
267	=item on_focus_out $term	585	=item on_focus_out $term
268		586
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	587	Called wheneever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	588	focus out processing.
271		589
		590	=item on_configure_notify $term, $event
		591
		592	=item on_property_notify $term, $event
		593
272	=item on_key_press $term, $event, $octets	594	=item on_key_press $term, $event, $keysym, $octets
273		595
274	=item on_key_release $term, $event	596	=item on_key_release $term, $event, $keysym
275		597
276	=item on_button_press $term, $event	598	=item on_button_press $term, $event
277		599
278	=item on_button_release $term, $event	600	=item on_button_release $term, $event
279		601
…		…
285		607
286	Called whenever the corresponding X event is received for the terminal If	608	Called whenever the corresponding X event is received for the terminal If
287	the hook returns true, then the even will be ignored by rxvt-unicode.	609	the hook returns true, then the even will be ignored by rxvt-unicode.
288		610
289	The event is a hash with most values as named by Xlib (see the XEvent	611	The event is a hash with most values as named by Xlib (see the XEvent
290	manpage), with the additional members C<row> and C<col>, which are the row	612	manpage), with the additional members C<row> and C<col>, which are the
291	and column under the mouse cursor.	613	(real, not screen-based) row and column under the mouse cursor.
292		614
293	C<on_key_press> additionally receives the string rxvt-unicode would	615	C<on_key_press> additionally receives the string rxvt-unicode would
294	output, if any, in locale-specific encoding.	616	output, if any, in locale-specific encoding.
295		617
296	subwindow.	618	subwindow.
297		619
		620	=item on_client_message $term, $event
		621
		622	=item on_wm_protocols $term, $event
		623
		624	=item on_wm_delete_window $term, $event
		625
		626	Called when various types of ClientMessage events are received (all with
		627	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		628
298	=back	629	=back
299		630
		631	=cut
		632
		633	package urxvt;
		634
		635	use utf8;
		636	use strict;
		637	use Carp ();
		638	use Scalar::Util ();
		639	use List::Util ();
		640
		641	our $VERSION = 1;
		642	our $TERM;
		643	our @TERM_INIT;
		644	our @TERM_EXT;
		645	our @HOOKNAME;
		646	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		647	our %OPTION;
		648
		649	our $LIBDIR;
		650	our $RESNAME;
		651	our $RESCLASS;
		652	our $RXVTNAME;
		653
		654	our $NOCHAR = chr 0xffff;
		655
300	=head2 Variables in the C<urxvt> Package	656	=head2 Variables in the C<urxvt> Package
301		657
302	=over 4	658	=over 4
		659
		660	=item $urxvt::LIBDIR
		661
		662	The rxvt-unicode library directory, where, among other things, the perl
		663	modules and scripts are stored.
		664
		665	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		666
		667	The resource class and name rxvt-unicode uses to look up X resources.
		668
		669	=item $urxvt::RXVTNAME
		670
		671	The basename of the installed binaries, usually C<urxvt>.
303		672
304	=item $urxvt::TERM	673	=item $urxvt::TERM
305		674
306	The current terminal. This variable stores the current C<urxvt::term>	675	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	676	object, whenever a callback/hook is executing.
308		677
		678	=item @urxvt::TERM_INIT
		679
		680	All coderefs in this array will be called as methods of the next newly
		681	created C<urxvt::term> object (during the C<on_init> phase). The array
		682	gets cleared before the codereferences that were in it are being executed,
		683	so coderefs can push themselves onto it again if they so desire.
		684
		685	This complements to the perl-eval commandline option, but gets executed
		686	first.
		687
		688	=item @urxvt::TERM_EXT
		689
		690	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		691	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		692	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		693
309	=back	694	=back
310		695
311	=head2 Functions in the C<urxvt> Package	696	=head2 Functions in the C<urxvt> Package
312		697
313	=over 4	698	=over 4
314
315	=item $term = new urxvt [arg...]
316
317	Creates a new terminal, very similar as if you had started it with
318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319	if the new instance couldn't be created. Returns C<undef> if the new
320	instance didn't initialise perl, and the terminal object otherwise. The
321	C<init> and C<start> hooks will be called during the call.
322		699
323	=item urxvt::fatal $errormessage	700	=item urxvt::fatal $errormessage
324		701
325	Fatally aborts execution with the given error message. Avoid at all	702	Fatally aborts execution with the given error message. Avoid at all
326	costs! The only time this is acceptable is when the terminal process	703	costs! The only time this is acceptable is when the terminal process
…		…
333	that calls this function.	710	that calls this function.
334		711
335	Using this function has the advantage that its output ends up in the	712	Using this function has the advantage that its output ends up in the
336	correct place, e.g. on stderr of the connecting urxvtc client.	713	correct place, e.g. on stderr of the connecting urxvtc client.
337		714
		715	Messages have a size limit of 1023 bytes currently.
		716
		717	=item @terms = urxvt::termlist
		718
		719	Returns all urxvt::term objects that exist in this process, regardless of
		720	wether they are started, being destroyed etc., so be careful. Only term
		721	objects that have perl extensions attached will be returned (because there
		722	is no urxvt::term objet associated with others).
		723
338	=item $time = urxvt::NOW	724	=item $time = urxvt::NOW
339		725
340	Returns the "current time" (as per the event loop).	726	Returns the "current time" (as per the event loop).
341		727
342	=item urxvt::CurrentTime	728	=item urxvt::CurrentTime
343		729
344	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	730	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
345	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	731	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
346	Button4Mask, Button5Mask, AnyModifier	732	Button4Mask, Button5Mask, AnyModifier
		733
		734	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		735	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		736	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		737	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		738	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		739	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		740	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		741
		742	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		743	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		744	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		745	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		746	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		747	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		748	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
347		749
348	Various constants for use in X calls and event processing.	750	Various constants for use in X calls and event processing.
349		751
350	=back	752	=back
351		753
…		…
380		782
381	=item $background = urxvt::GET_BASEBG $rend	783	=item $background = urxvt::GET_BASEBG $rend
382		784
383	Return the foreground/background colour index, respectively.	785	Return the foreground/background colour index, respectively.
384		786
385	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	787	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
386		788
387	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	789	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		790
		791	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
388		792
389	Replace the foreground/background colour in the rendition mask with the	793	Replace the foreground/background colour in the rendition mask with the
390	specified one.	794	specified one.
391		795
392	=item $value = urxvt::GET_CUSTOM ($rend)	796	=item $value = urxvt::GET_CUSTOM $rend
393		797
394	Return the "custom" value: Every rendition has 5 bits for use by	798	Return the "custom" value: Every rendition has 5 bits for use by
395	extensions. They can be set and changed as you like and are initially	799	extensions. They can be set and changed as you like and are initially
396	zero.	800	zero.
397		801
398	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	802	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
399		803
400	Change the custom value.	804	Change the custom value.
401		805
402	=back	806	=back
403		807
404	=cut	808	=cut
405		809
406	package urxvt;
407
408	use utf8;
409	use strict;
410	use Scalar::Util ();
411	use List::Util ();
412
413	our $VERSION = 1;
414	our $TERM;
415	our @HOOKNAME;
416	our %OPTION;
417	our $LIBDIR;
418
419	BEGIN {	810	BEGIN {
420	urxvt->bootstrap;
421
422	# overwrite perl's warn	811	# overwrite perl's warn
423	*CORE::GLOBAL::warn = sub {	812	*CORE::GLOBAL::warn = sub {
424	my $msg = join "", @_;	813	my $msg = join "", @_;
425	$msg .= "\n"	814	$msg .= "\n"
426	unless $msg =~ /\n$/;	815	unless $msg =~ /\n$/;
427	urxvt::warn ($msg);	816	urxvt::warn ($msg);
428	};	817	};
429
430	delete $ENV{IFS};
431	delete $ENV{CDPATH};
432	delete $ENV{BASH_ENV};
433	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
434	}	818	}
435		819
436	my @hook_count;	820	no warnings 'utf8';
		821
437	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	822	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
438		823
439	sub verbose {	824	sub verbose {
440	my ($level, $msg) = @_;	825	my ($level, $msg) = @_;
441	warn "$msg\n" if $level <= $verbosity;	826	warn "$msg\n" if $level <= $verbosity;
442	}	827	}
443		828
444	# find on_xxx subs in the package and register them
445	# as hooks
446	sub register_package($) {
447	my ($pkg) = @_;
448
449	for my $htype (0.. $#HOOKNAME) {
450	my $name = $HOOKNAME[$htype];
451
452	my $ref = $pkg->can ("on_" . lc $name)
453	or next;
454
455	$TERM->{_hook}[$htype]{$pkg} = $ref;
456	$hook_count[$htype]++
457	or set_should_invoke $htype, 1;
458	}
459	}
460
461	my $extension_pkg = "extension0000";
462	my %extension_pkg;	829	my %extension_pkg;
463		830
464	# load a single script into its own package, once only	831	# load a single script into its own package, once only
465	sub extension_package($) {	832	sub extension_package($) {
466	my ($path) = @_;	833	my ($path) = @_;
467		834
468	$extension_pkg{$path} ||= do {	835	$extension_pkg{$path} ||= do {
469	my $pkg = "urxvt::" . ($extension_pkg++);	836	$path =~ /([^\/\\]+)$/;
		837	my $pkg = $1;
		838	$pkg =~ s/[^[:word:]]/_/g;
		839	$pkg = "urxvt::ext::$pkg";
470		840
471	verbose 3, "loading extension '$path' into package '$pkg'";	841	verbose 3, "loading extension '$path' into package '$pkg'";
472		842
473	open my $fh, "<:raw", $path	843	open my $fh, "<:raw", $path
474	or die "$path: $!";	844	or die "$path: $!";
475		845
476	my $source = untaint "package $pkg; use strict; use utf8;\n"	846	my $source =
477	. "use base urxvt::term::proxy::;\n"	847	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
478	. "#line 1 \"$path\"\n{\n"	848	. "#line 1 \"$path\"\n{\n"
479	. (do { local $/; <$fh> })	849	. (do { local $/; <$fh> })
480	. "\n};\n1";	850	. "\n};\n1";
481		851
		852	eval $source
482	eval $source or die "$path: $@";	853	or die "$path: $@";
483		854
484	$pkg	855	$pkg
485	}	856	}
486	}	857	}
487		858
…		…
493	my $htype = shift;	864	my $htype = shift;
494		865
495	if ($htype == 0) { # INIT	866	if ($htype == 0) { # INIT
496	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	867	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
497		868
498	my %want_ext;	869	my %ext_arg;
499		870
		871	{
		872	my @init = @TERM_INIT;
		873	@TERM_INIT = ();
		874	$_->($TERM) for @init;
		875	my @pkg = @TERM_EXT;
		876	@TERM_EXT = ();
		877	$TERM->register_package ($_) for @pkg;
		878	}
		879
500	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	880	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
501	if ($_ eq "default") {	881	if ($_ eq "default") {
502	$want_ext{$_}++ for qw(selection option-popup selection-popup);	882	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
503	} elsif (/^-(.*)$/) {	883	} elsif (/^-(.*)$/) {
504	delete $want_ext{$1};	884	delete $ext_arg{$1};
		885	} elsif (/^([^<]+)<(.*)>$/) {
		886	push @{ $ext_arg{$1} }, $2;
505	} else {	887	} else {
506	$want_ext{$_}++;	888	$ext_arg{$_} ||= [];
507	}	889	}
508	}	890	}
509		891
510	for my $ext (keys %want_ext) {	892	for my $ext (sort keys %ext_arg) {
511	my @files = grep -f $_, map "$_/$ext", @dirs;	893	my @files = grep -f $_, map "$_/$ext", @dirs;
512		894
513	if (@files) {	895	if (@files) {
514	register_package extension_package $files[0];	896	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
515	} else {	897	} else {
516	warn "perl extension '$ext' not found in perl library search path\n";	898	warn "perl extension '$ext' not found in perl library search path\n";
517	}	899	}
518	}	900	}
519		901
…		…
528	if $verbosity >= 10;	910	if $verbosity >= 10;
529		911
530	keys %$cb;	912	keys %$cb;
531		913
532	while (my ($pkg, $cb) = each %$cb) {	914	while (my ($pkg, $cb) = each %$cb) {
533	eval {	915	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
534	$retval = $cb->(	916	$retval ||= $retval_;
535	$TERM->{_pkg}{$pkg} ||= do {	917
536	my $proxy = bless { }, $pkg;
537	Scalar::Util::weaken ($proxy->{term} = $TERM);
538	$proxy
539	},
540	@_,
541	) and last;
542	};
543	if ($@) {	918	if ($@) {
544	$TERM->ungrab; # better to lose the grab than the session	919	$TERM->ungrab; # better to lose the grab than the session
545	warn $@;	920	warn $@;
546	}	921	}
547	}	922	}
		923
		924	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		925	if $verbosity >= 11;
548	}	926	}
549		927
550	if ($htype == 1) { # DESTROY	928	if ($htype == 1) { # DESTROY
551	# remove hooks if unused
552	if (my $hook = $TERM->{_hook}) {
553	for my $htype (0..$#$hook) {
554	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
555	or set_should_invoke $htype, 0;
556	}
557	}
558
559	# clear package objects	929	# clear package objects
560	%$_ = () for values %{ $TERM->{_pkg} };	930	%$_ = () for values %{ $TERM->{_pkg} };
561		931
562	# clear package	932	# clear package
563	%$TERM = ();	933	%$TERM = ();
564	}	934	}
565		935
566	$retval	936	$retval
567	}	937	}
568		938
569	# urxvt::term::proxy	939	sub SET_COLOR($$$) {
		940	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		941	}
570		942
571	sub urxvt::term::proxy::AUTOLOAD {	943	# urxvt::term::extension
572	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	944
		945	package urxvt::term::extension;
		946
		947	sub enable {
		948	my ($self, %hook) = @_;
		949	my $pkg = $self->{_pkg};
		950
		951	while (my ($name, $cb) = each %hook) {
		952	my $htype = $HOOKTYPE{uc $name};
		953	defined $htype
		954	or Carp::croak "unsupported hook type '$name'";
		955
		956	$self->set_should_invoke ($htype, +1)
		957	unless exists $self->{term}{_hook}[$htype]{$pkg};
		958
		959	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		960	}
		961	}
		962
		963	sub disable {
		964	my ($self, @hook) = @_;
		965	my $pkg = $self->{_pkg};
		966
		967	for my $name (@hook) {
		968	my $htype = $HOOKTYPE{uc $name};
		969	defined $htype
		970	or Carp::croak "unsupported hook type '$name'";
		971
		972	$self->set_should_invoke ($htype, -1)
		973	if delete $self->{term}{_hook}[$htype]{$pkg};
		974	}
		975	}
		976
		977	our $AUTOLOAD;
		978
		979	sub AUTOLOAD {
		980	$AUTOLOAD =~ /:([^:]+)$/
573	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	981	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
574		982
575	eval qq{	983	eval qq{
576	sub $urxvt::term::proxy::AUTOLOAD {	984	sub $AUTOLOAD {
577	my \$proxy = shift;	985	my \$proxy = shift;
578	\$proxy->{term}->$1 (\@_)	986	\$proxy->{term}->$1 (\@_)
579	}	987	}
580	1	988	1
581	} or die "FATAL: unable to compile method forwarder: $@";	989	} or die "FATAL: unable to compile method forwarder: $@";
582		990
583	goto &$urxvt::term::proxy::AUTOLOAD;	991	goto &$AUTOLOAD;
584	}	992	}
585		993
586	sub urxvt::term::proxy::DESTROY {	994	sub DESTROY {
587	# nop	995	# nop
588	}	996	}
589		997
590	# urxvt::destroy_hook	998	# urxvt::destroy_hook
591		999
…		…
601		1009
602	=head2 The C<urxvt::anyevent> Class	1010	=head2 The C<urxvt::anyevent> Class
603		1011
604	The sole purpose of this class is to deliver an interface to the	1012	The sole purpose of this class is to deliver an interface to the
605	C<AnyEvent> module - any module using it will work inside urxvt without	1013	C<AnyEvent> module - any module using it will work inside urxvt without
606	further work. The only exception is that you cannot wait on condition	1014	further programming. The only exception is that you cannot wait on
607	variables, but non-blocking condvar use is ok. What this means is that you	1015	condition variables, but non-blocking condvar use is ok. What this means
608	cannot use blocking APIs, but the non-blocking variant should work.	1016	is that you cannot use blocking APIs, but the non-blocking variant should
		1017	work.
609		1018
610	=cut	1019	=cut
611		1020
612	our $VERSION = 1;	1021	our $VERSION = 1;
613		1022
…		…
658	${$_[0]}++;	1067	${$_[0]}++;
659	}	1068	}
660		1069
661	sub urxvt::anyevent::condvar::wait {	1070	sub urxvt::anyevent::condvar::wait {
662	unless (${$_[0]}) {	1071	unless (${$_[0]}) {
663	require Carp;
664	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	1072	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
665	}	1073	}
666	}	1074	}
667		1075
668	package urxvt::term;	1076	package urxvt::term;
669		1077
670	=head2 The C<urxvt::term> Class	1078	=head2 The C<urxvt::term> Class
671		1079
672	=over 4	1080	=over 4
673		1081
		1082	=cut
		1083
		1084	# find on_xxx subs in the package and register them
		1085	# as hooks
		1086	sub register_package {
		1087	my ($self, $pkg, $argv) = @_;
		1088
		1089	no strict 'refs';
		1090
		1091	urxvt::verbose 6, "register package $pkg to $self";
		1092
		1093	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1094
		1095	my $proxy = bless {
		1096	_pkg => $pkg,
		1097	argv => $argv,
		1098	}, $pkg;
		1099	Scalar::Util::weaken ($proxy->{term} = $self);
		1100
		1101	$self->{_pkg}{$pkg} = $proxy;
		1102
		1103	for my $name (@HOOKNAME) {
		1104	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1105	$proxy->enable ($name => $ref);
		1106	}
		1107	}
		1108	}
		1109
		1110	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1111
		1112	Creates a new terminal, very similar as if you had started it with system
		1113	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1114	hash which defines the environment of the new terminal.
		1115
		1116	Croaks (and probably outputs an error message) if the new instance
		1117	couldn't be created. Returns C<undef> if the new instance didn't
		1118	initialise perl, and the terminal object otherwise. The C<init> and
		1119	C<start> hooks will be called before this call returns, and are free to
		1120	refer to global data (which is race free).
		1121
		1122	=cut
		1123
		1124	sub new {
		1125	my ($class, $env, @args) = @_;
		1126
		1127	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1128	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1129
		1130	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1131	}
		1132
674	=item $term->destroy	1133	=item $term->destroy
675		1134
676	Destroy the terminal object (close the window, free resources etc.).	1135	Destroy the terminal object (close the window, free resources
		1136	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1137	watchers (timers, io watchers) are still active.
		1138
		1139	=item $term->exec_async ($cmd[, @args])
		1140
		1141	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1142	("starts") programs in the background. This function takes care of setting
		1143	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1144	be preferred over explicit calls to C<exec> or C<system>.
		1145
		1146	Returns the pid of the subprocess or C<undef> on error.
		1147
		1148	=cut
		1149
		1150	sub exec_async {
		1151	my $self = shift;
		1152
		1153	my $pid = fork;
		1154
		1155	return $pid
		1156	if !defined $pid or $pid;
		1157
		1158	%ENV = %{ $self->env };
		1159
		1160	exec @_;
		1161	urxvt::_exit 255;
		1162	}
677		1163
678	=item $isset = $term->option ($optval[, $set])	1164	=item $isset = $term->option ($optval[, $set])
679		1165
680	Returns true if the option specified by C<$optval> is enabled, and	1166	Returns true if the option specified by C<$optval> is enabled, and
681	optionally change it. All option values are stored by name in the hash	1167	optionally change it. All option values are stored by name in the hash
…		…
684	Here is a a likely non-exhaustive list of option names, please see the	1170	Here is a a likely non-exhaustive list of option names, please see the
685	source file F</src/optinc.h> to see the actual list:	1171	source file F</src/optinc.h> to see the actual list:
686		1172
687	borderLess console cursorBlink cursorUnderline hold iconic insecure	1173	borderLess console cursorBlink cursorUnderline hold iconic insecure
688	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1174	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
689	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1175	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
690	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1176	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
691	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1177	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
692	tripleclickwords utmpInhibit visualBell	1178	transparent tripleclickwords utmpInhibit visualBell
693		1179
694	=item $value = $term->resource ($name[, $newval])	1180	=item $value = $term->resource ($name[, $newval])
695		1181
696	Returns the current resource value associated with a given name and	1182	Returns the current resource value associated with a given name and
697	optionally sets a new value. Setting values is most useful in the C<init>	1183	optionally sets a new value. Setting values is most useful in the C<init>
…		…
714		1200
715	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1201	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
716	borderLess color cursorBlink cursorUnderline cutchars delete_key	1202	borderLess color cursorBlink cursorUnderline cutchars delete_key
717	display_name embed ext_bwidth fade font geometry hold iconName	1203	display_name embed ext_bwidth fade font geometry hold iconName
718	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1204	imFont imLocale inputMethod insecure int_bwidth intensityStyles
719	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1205	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
720	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1206	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
721	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1207	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
722	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1208	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
723	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1209	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
724	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1210	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
725	shade term_name title transparent transparent_all tripleclickwords	1211	secondaryScreen secondaryScroll selectstyle shade term_name title
726	utmpInhibit visualBell	1212	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1213	visualBell
727		1214
728	=cut	1215	=cut
729		1216
730	sub resource($$;$) {	1217	sub resource($$;$) {
731	my ($self, $name) = (shift, shift);	1218	my ($self, $name) = (shift, shift);
732	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1219	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
733	&urxvt::term::_resource	1220	&urxvt::term::_resource
734	}	1221	}
735		1222
		1223	=item $value = $term->x_resource ($pattern)
		1224
		1225	Returns the X-Resource for the given pattern, excluding the program or
		1226	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1227	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1228	resource with that pattern exists.
		1229
		1230	This method should only be called during the C<on_start> hook, as there is
		1231	only one resource database per display, and later invocations might return
		1232	the wrong resources.
		1233
		1234	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1235
		1236	Adds a keymap translation exactly as specified via a resource. See the
		1237	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1238
736	=item $rend = $term->rstyle ([$new_rstyle])	1239	=item $rend = $term->rstyle ([$new_rstyle])
737		1240
738	Return and optionally change the current rendition. Text that is output by	1241	Return and optionally change the current rendition. Text that is output by
739	the terminal application will use this style.	1242	the terminal application will use this style.
740		1243
…		…
750	=item ($row, $col) = $term->selection_end ([$row, $col])	1253	=item ($row, $col) = $term->selection_end ([$row, $col])
751		1254
752	Return the current values of the selection mark, begin or end positions,	1255	Return the current values of the selection mark, begin or end positions,
753	and optionally set them to new values.	1256	and optionally set them to new values.
754		1257
		1258	=item $term->selection_make ($eventtime[, $rectangular])
		1259
		1260	Tries to make a selection as set by C<selection_beg> and
		1261	C<selection_end>. If C<$rectangular> is true (default: false), a
		1262	rectangular selection will be made. This is the prefered function to make
		1263	a selection.
		1264
755	=item $success = $term->selection_grab ($eventtime)	1265	=item $success = $term->selection_grab ($eventtime)
756		1266
757	Try to request the primary selection from the server (for example, as set	1267	Try to request the primary selection text from the server (for example, as
758	by the next method).	1268	set by the next method). No visual feedback will be given. This function
		1269	is mostly useful from within C<on_sel_grab> hooks.
759		1270
760	=item $oldtext = $term->selection ([$newtext])	1271	=item $oldtext = $term->selection ([$newtext])
761		1272
762	Return the current selection text and optionally replace it by C<$newtext>.	1273	Return the current selection text and optionally replace it by C<$newtext>.
763		1274
764	#=item $term->overlay ($x, $y, $text)	1275	=item $term->overlay_simple ($x, $y, $text)
765	#	1276
766	#Create a simple multi-line overlay box. See the next method for details.	1277	Create a simple multi-line overlay box. See the next method for details.
767	#	1278
768	#=cut	1279	=cut
769	#	1280
770	#sub urxvt::term::scr_overlay {	1281	sub overlay_simple {
771	# my ($self, $x, $y, $text) = @_;	1282	my ($self, $x, $y, $text) = @_;
772	#	1283
773	# my @lines = split /\n/, $text;	1284	my @lines = split /\n/, $text;
774	#	1285
775	# my $w = 0;	1286	my $w = List::Util::max map $self->strwidth ($_), @lines;
776	# for (map $self->strwidth ($_), @lines) {	1287
777	# $w = $_ if $w < $_;
778	# }
779	#
780	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1288	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
781	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1289	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
782	#}	1290
		1291	$overlay
		1292	}
783		1293
784	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1294	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
785		1295
786	Create a new (empty) overlay at the given position with the given	1296	Create a new (empty) overlay at the given position with the given
787	width/height. C<$rstyle> defines the initial rendition style	1297	width/height. C<$rstyle> defines the initial rendition style
…		…
854		1364
855	=item $string = $term->locale_decode ($octets)	1365	=item $string = $term->locale_decode ($octets)
856		1366
857	Convert the given locale-encoded octets into a perl string.	1367	Convert the given locale-encoded octets into a perl string.
858		1368
		1369	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1370
		1371	XORs the rendition values in the given span with the provided value
		1372	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1373	refresh hooks to provide effects similar to the selection.
		1374
		1375	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1376
		1377	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1378	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1379	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1380	it instead. Both styles I<MUST NOT> contain font styles.
		1381
		1382	=item $term->scr_bell
		1383
		1384	Ring the bell!
		1385
859	=item $term->scr_add_lines ($string)	1386	=item $term->scr_add_lines ($string)
860		1387
861	Write the given text string to the screen, as if output by the application	1388	Write the given text string to the screen, as if output by the application
862	running inside the terminal. It may not contain command sequences (escape	1389	running inside the terminal. It may not contain command sequences (escape
863	codes), but is free to use line feeds, carriage returns and tabs. The	1390	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
865		1392
866	Normally its not a good idea to use this function, as programs might be	1393	Normally its not a good idea to use this function, as programs might be
867	confused by changes in cursor position or scrolling. Its useful inside a	1394	confused by changes in cursor position or scrolling. Its useful inside a
868	C<on_add_lines> hook, though.	1395	C<on_add_lines> hook, though.
869		1396
		1397	=item $term->scr_change_screen ($screen)
		1398
		1399	Switch to given screen - 0 primary, 1 secondary.
		1400
870	=item $term->cmd_parse ($octets)	1401	=item $term->cmd_parse ($octets)
871		1402
872	Similar to C<scr_add_lines>, but the argument must be in the	1403	Similar to C<scr_add_lines>, but the argument must be in the
873	locale-specific encoding of the terminal and can contain command sequences	1404	locale-specific encoding of the terminal and can contain command sequences
874	(escape codes) that will be interpreted.	1405	(escape codes) that will be interpreted.
…		…
877		1408
878	Write the octets given in C<$data> to the tty (i.e. as program input). To	1409	Write the octets given in C<$data> to the tty (i.e. as program input). To
879	pass characters instead of octets, you should convert your strings first	1410	pass characters instead of octets, you should convert your strings first
880	to the locale-specific encoding using C<< $term->locale_encode >>.	1411	to the locale-specific encoding using C<< $term->locale_encode >>.
881		1412
		1413	=item $old_events = $term->pty_ev_events ([$new_events])
		1414
		1415	Replaces the event mask of the pty watcher by the given event mask. Can
		1416	be used to suppress input and output handling to the pty/tty. See the
		1417	description of C<< urxvt::timer->events >>. Make sure to always restore
		1418	the previous value.
		1419
		1420	=item $fd = $term->pty_fd
		1421
		1422	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1423	is used.
		1424
882	=item $windowid = $term->parent	1425	=item $windowid = $term->parent
883		1426
884	Return the window id of the toplevel window.	1427	Return the window id of the toplevel window.
885		1428
886	=item $windowid = $term->vt	1429	=item $windowid = $term->vt
887		1430
888	Return the window id of the terminal window.	1431	Return the window id of the terminal window.
889		1432
		1433	=item $term->vt_emask_add ($x_event_mask)
		1434
		1435	Adds the specified events to the vt event mask. Useful e.g. when you want
		1436	to receive pointer events all the times:
		1437
		1438	$term->vt_emask_add (urxvt::PointerMotionMask);
		1439
		1440	=item $term->focus_in
		1441
		1442	=item $term->focus_out
		1443
		1444	=item $term->key_press ($state, $keycode[, $time])
		1445
		1446	=item $term->key_release ($state, $keycode[, $time])
		1447
		1448	Deliver various fake events to to terminal.
		1449
890	=item $window_width = $term->width	1450	=item $window_width = $term->width
891		1451
892	=item $window_height = $term->height	1452	=item $window_height = $term->height
893		1453
894	=item $font_width = $term->fwidth	1454	=item $font_width = $term->fwidth
…		…
907		1467
908	=item $max_scrollback = $term->saveLines	1468	=item $max_scrollback = $term->saveLines
909		1469
910	=item $nrow_plus_saveLines = $term->total_rows	1470	=item $nrow_plus_saveLines = $term->total_rows
911		1471
912	=item $lines_in_scrollback = $term->nsaved	1472	=item $topmost_scrollback_row = $term->top_row
913		1473
914	Return various integers describing terminal characteristics.	1474	Return various integers describing terminal characteristics.
		1475
		1476	=item $x_display = $term->display_id
		1477
		1478	Return the DISPLAY used by rxvt-unicode.
		1479
		1480	=item $lc_ctype = $term->locale
		1481
		1482	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1483
		1484	=item $env = $term->env
		1485
		1486	Returns a copy of the environment in effect for the terminal as a hashref
		1487	similar to C<\%ENV>.
		1488
		1489	=item @envv = $term->envv
		1490
		1491	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1492
		1493	=item @argv = $term->argv
		1494
		1495	Return the argument vector as this terminal, similar to @ARGV, but
		1496	includes the program name as first element.
		1497
		1498	=cut
		1499
		1500	sub env {
		1501	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1502	}
915		1503
916	=item $modifiermask = $term->ModLevel3Mask	1504	=item $modifiermask = $term->ModLevel3Mask
917		1505
918	=item $modifiermask = $term->ModMetaMask	1506	=item $modifiermask = $term->ModMetaMask
919		1507
920	=item $modifiermask = $term->ModNumLockMask	1508	=item $modifiermask = $term->ModNumLockMask
921		1509
922	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1510	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
923	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1511	AltGr), the meta key (often Alt) and the num lock key, if applicable.
924		1512
		1513	=item $screen = $term->current_screen
		1514
		1515	Returns the currently displayed screen (0 primary, 1 secondary).
		1516
		1517	=item $cursor_is_hidden = $term->hidden_cursor
		1518
		1519	Returns wether the cursor is currently hidden or not.
		1520
925	=item $view_start = $term->view_start ([$newvalue])	1521	=item $view_start = $term->view_start ([$newvalue])
926		1522
927	Returns the negative row number of the topmost line. Minimum value is	1523	Returns the row number of the topmost displayed line. Maximum value is
928	C<0>, which displays the normal terminal contents. Larger values scroll	1524	C<0>, which displays the normal terminal contents. Lower values scroll
929	this many lines into the scrollback buffer.	1525	this many lines into the scrollback buffer.
930		1526
931	=item $term->want_refresh	1527	=item $term->want_refresh
932		1528
933	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1529	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
948	line, starting at column C<$start_col> (default C<0>), which is useful	1544	line, starting at column C<$start_col> (default C<0>), which is useful
949	to replace only parts of a line. The font index in the rendition will	1545	to replace only parts of a line. The font index in the rendition will
950	automatically be updated.	1546	automatically be updated.
951		1547
952	C<$text> is in a special encoding: tabs and wide characters that use more	1548	C<$text> is in a special encoding: tabs and wide characters that use more
953	than one cell when displayed are padded with urxvt::NOCHAR characters	1549	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
954	(C<chr 65535>). Characters with combining characters and other characters	1550	characters. Characters with combining characters and other characters that
955	that do not fit into the normal tetx encoding will be replaced with	1551	do not fit into the normal tetx encoding will be replaced with characters
956	characters in the private use area.	1552	in the private use area.
957		1553
958	You have to obey this encoding when changing text. The advantage is	1554	You have to obey this encoding when changing text. The advantage is
959	that C<substr> and similar functions work on screen cells and not on	1555	that C<substr> and similar functions work on screen cells and not on
960	characters.	1556	characters.
961		1557
…		…
1012	Return the row number of the first/last row of the line, respectively.	1608	Return the row number of the first/last row of the line, respectively.
1013		1609
1014	=item $offset = $line->offset_of ($row, $col)	1610	=item $offset = $line->offset_of ($row, $col)
1015		1611
1016	Returns the character offset of the given row|col pair within the logical	1612	Returns the character offset of the given row|col pair within the logical
1017	line.	1613	line. Works for rows outside the line, too, and returns corresponding
		1614	offsets outside the string.
1018		1615
1019	=item ($row, $col) = $line->coord_of ($offset)	1616	=item ($row, $col) = $line->coord_of ($offset)
1020		1617
1021	Translates a string offset into terminal coordinates again.	1618	Translates a string offset into terminal coordinates again.
1022		1619
…		…
1107	=item $string = $term->special_decode $text	1704	=item $string = $term->special_decode $text
1108		1705
1109	Converts rxvt-unicodes text reprsentation into a perl string. See	1706	Converts rxvt-unicodes text reprsentation into a perl string. See
1110	C<< $term->ROW_t >> for details.	1707	C<< $term->ROW_t >> for details.
1111		1708
1112	=item $success = $term->grab_button ($button, $modifiermask)	1709	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1113		1710
		1711	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1712
1114	Registers a synchronous button grab. See XGrabButton.	1713	Register/unregister a synchronous button grab. See the XGrabButton
		1714	manpage.
1115		1715
1116	=item $success = $term->grab ($eventtime[, $sync])	1716	=item $success = $term->grab ($eventtime[, $sync])
1117		1717
1118	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1718	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1119	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1719	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1135		1735
1136	Calls XUngrab for the most recent grab. Is called automatically on	1736	Calls XUngrab for the most recent grab. Is called automatically on
1137	evaluation errors, as it is better to lose the grab in the error case as	1737	evaluation errors, as it is better to lose the grab in the error case as
1138	the session.	1738	the session.
1139		1739
		1740	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1741
		1742	=item $atom_name = $term->XGetAtomName ($atom)
		1743
		1744	=item @atoms = $term->XListProperties ($window)
		1745
		1746	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1747
		1748	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1749
		1750	=item $term->XDeleteProperty ($window, $property)
		1751
		1752	=item $window = $term->DefaultRootWindow
		1753
		1754	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1755
		1756	=item $term->XMapWindow ($window)
		1757
		1758	=item $term->XUnmapWindow ($window)
		1759
		1760	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1761
		1762	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1763
		1764	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1765
		1766	Various X or X-related functions. The C<$term> object only serves as
		1767	the source of the display, otherwise those functions map more-or-less
		1768	directory onto the X functions of the same name.
		1769
1140	=back	1770	=back
1141		1771
1142	=cut	1772	=cut
1143		1773
1144	package urxvt::popup;	1774	package urxvt::popup;
…		…
1159	$item->{render} ||= sub { $_[0]{text} };	1789	$item->{render} ||= sub { $_[0]{text} };
1160		1790
1161	push @{ $self->{item} }, $item;	1791	push @{ $self->{item} }, $item;
1162	}	1792	}
1163		1793
1164	sub add_separator {	1794	=item $popup->add_title ($title)
1165	my ($self, $sep) = @_;
1166		1795
1167	$sep ||= "═";	1796	Adds a non-clickable title to the popup.
1168		1797
1169	$self->add_item ({	1798	=cut
1170	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1171	text => "",
1172	render => sub { $sep x $urxvt::TERM->ncol },
1173	activate => sub { },
1174	});
1175	}
1176		1799
1177	sub add_title {	1800	sub add_title {
1178	my ($self, $title) = @_;	1801	my ($self, $title) = @_;
1179		1802
1180	$self->add_item ({	1803	$self->add_item ({
…		…
1182	text => $title,	1805	text => $title,
1183	activate => sub { },	1806	activate => sub { },
1184	});	1807	});
1185	}	1808	}
1186		1809
		1810	=item $popup->add_separator ([$sepchr])
		1811
		1812	Creates a separator, optionally using the character given as C<$sepchr>.
		1813
		1814	=cut
		1815
		1816	sub add_separator {
		1817	my ($self, $sep) = @_;
		1818
		1819	$sep ||= "=";
		1820
		1821	$self->add_item ({
		1822	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1823	text => "",
		1824	render => sub { $sep x $self->{term}->ncol },
		1825	activate => sub { },
		1826	});
		1827	}
		1828
		1829	=item $popup->add_button ($text, $cb)
		1830
		1831	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1832	selected.
		1833
		1834	=cut
		1835
1187	sub add_button {	1836	sub add_button {
1188	my ($self, $text, $cb) = @_;	1837	my ($self, $text, $cb) = @_;
1189		1838
1190	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1839	$self->add_item ({ type => "button", text => $text, activate => $cb});
1191	}	1840	}
		1841
		1842	=item $popup->add_toggle ($text, $initial_value, $cb)
		1843
		1844	Adds a toggle/checkbox item to the popup. The callback gets called
		1845	whenever it gets toggled, with a boolean indicating its new value as its
		1846	first argument.
		1847
		1848	=cut
1192		1849
1193	sub add_toggle {	1850	sub add_toggle {
1194	my ($self, $text, $cb, $value) = @_;	1851	my ($self, $text, $value, $cb) = @_;
1195		1852
1196	my $item; $item = {	1853	my $item; $item = {
1197	type => "button",	1854	type => "button",
1198	text => " $text",	1855	text => " $text",
1199	value => $value,	1856	value => $value,
1200	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1857	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1201	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1858	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1202	};	1859	};
1203		1860
1204	$self->add_item ($item);	1861	$self->add_item ($item);
1205	}	1862	}
		1863
		1864	=item $popup->show
		1865
		1866	Displays the popup (which is initially hidden).
		1867
		1868	=cut
1206		1869
1207	sub show {	1870	sub show {
1208	my ($self) = @_;	1871	my ($self) = @_;
1209		1872
1210	local $urxvt::popup::self = $self;	1873	local $urxvt::popup::self = $self;
1211		1874
1212	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1875	my $env = $self->{term}->env;
		1876	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1877	delete $env->{LC_ALL};
		1878	$env->{LC_CTYPE} = $self->{term}->locale;
		1879
		1880	urxvt::term->new ($env, "popup",
		1881	"--perl-lib" => "", "--perl-ext-common" => "",
		1882	"-pty-fd" => -1, "-sl" => 0,
		1883	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1213	"--transient-for" => $self->{term}->parent,	1884	"--transient-for" => $self->{term}->parent,
		1885	"-display" => $self->{term}->display_id,
1214	"-pe" => "urxvt-popup")	1886	"-pe" => "urxvt-popup")
1215	or die "unable to create popup window\n";	1887	or die "unable to create popup window\n";
1216	}	1888	}
1217		1889
1218	sub DESTROY {	1890	sub DESTROY {
1219	my ($self) = @_;	1891	my ($self) = @_;
1220		1892
1221	delete $self->{term}{_destroy}{$self};	1893	delete $self->{term}{_destroy}{$self};
1222	$self->{term}->ungrab;	1894	$self->{term}->ungrab;
1223	}	1895	}
		1896
		1897	=back
		1898
		1899	=cut
		1900
		1901	package urxvt::watcher;
		1902
		1903	@urxvt::timer::ISA = __PACKAGE__;
		1904	@urxvt::iow::ISA = __PACKAGE__;
		1905	@urxvt::pw::ISA = __PACKAGE__;
		1906	@urxvt::iw::ISA = __PACKAGE__;
1224		1907
1225	=head2 The C<urxvt::timer> Class	1908	=head2 The C<urxvt::timer> Class
1226		1909
1227	This class implements timer watchers/events. Time is represented as a	1910	This class implements timer watchers/events. Time is represented as a
1228	fractional number of seconds since the epoch. Example:	1911	fractional number of seconds since the epoch. Example:
…		…
1267		1950
1268	=item $timer = $timer->start ($tstamp)	1951	=item $timer = $timer->start ($tstamp)
1269		1952
1270	Set the event trigger time to C<$tstamp> and start the timer.	1953	Set the event trigger time to C<$tstamp> and start the timer.
1271		1954
		1955	=item $timer = $timer->after ($delay)
		1956
		1957	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		1958
1272	=item $timer = $timer->stop	1959	=item $timer = $timer->stop
1273		1960
1274	Stop the timer.	1961	Stop the timer.
1275		1962
1276	=back	1963	=back
…		…
1281		1968
1282	$term->{socket} = ...	1969	$term->{socket} = ...
1283	$term->{iow} = urxvt::iow	1970	$term->{iow} = urxvt::iow
1284	->new	1971	->new
1285	->fd (fileno $term->{socket})	1972	->fd (fileno $term->{socket})
1286	->events (1) # wait for read data	1973	->events (urxvt::EVENT_READ)
1287	->start	1974	->start
1288	->cb (sub {	1975	->cb (sub {
1289	my ($iow, $revents) = @_;	1976	my ($iow, $revents) = @_;
1290	# $revents must be 1 here, no need to check	1977	# $revents must be 1 here, no need to check
1291	sysread $term->{socket}, my $buf, 8192	1978	sysread $term->{socket}, my $buf, 8192
…		…
1308		1995
1309	Set the filedescriptor (not handle) to watch.	1996	Set the filedescriptor (not handle) to watch.
1310		1997
1311	=item $iow = $iow->events ($eventmask)	1998	=item $iow = $iow->events ($eventmask)
1312		1999
1313	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2000	Set the event mask to watch. The only allowed values are
1314	data, Bit #1 (value C<2>) enables watching for write data.	2001	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		2002	together, or C<urxvt::EVENT_NONE>.
1315		2003
1316	=item $iow = $iow->start	2004	=item $iow = $iow->start
1317		2005
1318	Start watching for requested events on the given handle.	2006	Start watching for requested events on the given handle.
1319		2007
1320	=item $iow = $iow->stop	2008	=item $iow = $iow->stop
1321		2009
1322	Stop watching for events on the given filehandle.	2010	Stop watching for events on the given filehandle.
		2011
		2012	=back
		2013
		2014	=head2 The C<urxvt::iw> Class
		2015
		2016	This class implements idle watchers, that get called automatically when
		2017	the process is idle. They should return as fast as possible, after doing
		2018	some useful work.
		2019
		2020	=over 4
		2021
		2022	=item $iw = new urxvt::iw
		2023
		2024	Create a new idle watcher object in stopped state.
		2025
		2026	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2027
		2028	Set the callback to be called when the watcher triggers.
		2029
		2030	=item $timer = $timer->start
		2031
		2032	Start the watcher.
		2033
		2034	=item $timer = $timer->stop
		2035
		2036	Stop the watcher.
		2037
		2038	=back
		2039
		2040	=head2 The C<urxvt::pw> Class
		2041
		2042	This class implements process watchers. They create an event whenever a
		2043	process exits, after which they stop automatically.
		2044
		2045	my $pid = fork;
		2046	...
		2047	$term->{pw} = urxvt::pw
		2048	->new
		2049	->start ($pid)
		2050	->cb (sub {
		2051	my ($pw, $exit_status) = @_;
		2052	...
		2053	});
		2054
		2055	=over 4
		2056
		2057	=item $pw = new urxvt::pw
		2058
		2059	Create a new process watcher in stopped state.
		2060
		2061	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2062
		2063	Set the callback to be called when the timer triggers.
		2064
		2065	=item $pw = $timer->start ($pid)
		2066
		2067	Tells the wqtcher to start watching for process C<$pid>.
		2068
		2069	=item $pw = $pw->stop
		2070
		2071	Stop the watcher.
1323		2072
1324	=back	2073	=back
1325		2074
1326	=head1 ENVIRONMENT	2075	=head1 ENVIRONMENT
1327		2076
…		…
1334		2083
1335	=item == 0 - fatal messages	2084	=item == 0 - fatal messages
1336		2085
1337	=item >= 3 - script loading and management	2086	=item >= 3 - script loading and management
1338		2087
1339	=item >=10 - all events received	2088	=item >=10 - all called hooks
		2089
		2090	=item >=11 - hook reutrn values
1340		2091
1341	=back	2092	=back
1342		2093
1343	=head1 AUTHOR	2094	=head1 AUTHOR
1344		2095

Diff Legend

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