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

Diff Legend

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