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.29 by root, Wed Jan 4 00:12:12 2006 UTC vs.
Revision 1.128 by root, Wed Jan 25 00:57:57 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		43
40	=over 4	44	=over 4
41		45
42	=item selection	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
55	Rot-13 the selection when activated. Used via keyboard trigger:	88	Rot-13 the selection when activated. Used via keyboard trigger:
56		89
57	URxvt.keysym.C-M-r: perl:selection:rot13	90	URxvt.keysym.C-M-r: perl:selection:rot13
58		91
59	=back	92	=back
		93
		94	=item option-popup (enabled by default)
		95
		96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		97	runtime.
		98
		99	=item selection-popup (enabled by default)
		100
		101	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		102	text into various other formats/action (such as uri unescaping, perl
		103	evaluation, web-browser starting etc.), depending on content.
		104
		105	Other extensions can extend this popup menu by pushing a code reference
		106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		107	popup is displayed.
		108
		109	It's sole argument is the popup menu, which can be modified. The selection
		110	is in C<$_>, which can be used to decide wether to add something or not.
		111	It should either return nothing or a string and a code reference. The
		112	string will be used as button text and the code reference will be called
		113	when the button gets activated and should transform C<$_>.
		114
		115	The following will add an entry C<a to b> that transforms all C<a>s in
		116	the selection to C<b>s, but only if the selection currently contains any
		117	C<a>s:
		118
		119	push @{ $self->{term}{selection_popup_hook} }, sub {
		120	/a/ ? ("a to be" => sub { s/a/b/g }
		121	: ()
		122	};
		123
		124	=item searchable-scrollback<hotkey> (enabled by default)
		125
		126	Adds regex search functionality to the scrollback buffer, triggered
		127	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		128	input/output is suspended and a regex is displayed at the bottom of the
		129	screen.
		130
		131	Inputting characters appends them to the regex and continues incremental
		132	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		133	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		134	bottom. C<Escape> leaves search mode and returns to the point where search
		135	was started, while C<Enter> or C<Return> stay at the current position and
		136	additionally stores the first match in the current line into the primary
		137	selection.
		138
		139	=item readline (enabled by default)
		140
		141	A support package that tries to make editing with readline easier. At the
		142	moment, it reacts to clicking with the left mouse button by trying to
		143	move the text cursor to this position. It does so by generating as many
		144	cursor-left or cursor-right keypresses as required (the this only works
		145	for programs that correctly support wide characters).
		146
		147	To avoid too many false positives, this is only done when:
		148
		149	=over 4
		150
		151	=item - the tty is in ICANON state.
		152
		153	=item - the text cursor is visible.
		154
		155	=item - the primary screen is currently being displayed.
		156
		157	=item - the mouse is on the same (multi-row-) line as the text cursor.
		158
		159	=back
		160
		161	The normal selection mechanism isn't disabled, so quick successive clicks
		162	might interfere with selection creation in harmless ways.
		163
		164	=item selection-autotransform
		165
		166	This selection allows you to do automatic transforms on a selection
		167	whenever a selection is made.
		168
		169	It works by specifying perl snippets (most useful is a single C<s///>
		170	operator) that modify C<$_> as resources:
		171
		172	URxvt.selection-autotransform.0: transform
		173	URxvt.selection-autotransform.1: transform
		174	...
		175
		176	For example, the following will transform selections of the form
		177	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		178	$word>:
		179
		180	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		181
		182	And this example matches the same,but replaces it with vi-commands you can
		183	paste directly into your (vi :) editor:
		184
		185	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		186
		187	Of course, this can be modified to suit your needs and your editor :)
		188
		189	To expand the example above to typical perl error messages ("XXX at
		190	FILENAME line YYY."), you need a slightly more elaborate solution:
		191
		192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		193	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		194
		195	The first line tells the selection code to treat the unchanging part of
		196	every error message as a selection pattern, and the second line transforms
		197	the message into vi commands to load the file.
		198
		199	=item tabbed
		200
		201	This transforms the terminal into a tabbar with additional terminals, that
		202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		204	button per tab.
		205
		206	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		207	B<Shift-Right> will switch to the tab left or right of the current one,
		208	while B<Shift-Down> creates a new tab.
		209
		210	=item mark-urls
		211
		212	Uses per-line display filtering (C<on_line_update>) to underline urls and
		213	make them clickable. When middle-clicked, the program specified in the
		214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		215	the URL as first argument.
		216
		217	=item xim-onthespot
		218
		219	This (experimental) perl extension implements OnTheSpot editing. It does
		220	not work perfectly, and some input methods don't seem to work well with
		221	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		222	kinput2.
		223
		224	You enable it by specifying this extension and a preedit style of
		225	C<OnTheSpot>, i.e.:
		226
		227	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		228
		229	=item automove-background
		230
		231	This is basically a one-line extension that dynamically changes the background pixmap offset
		232	to the window position, in effect creating the same effect as pseudo transparency with
		233	a custom pixmap. No scaling is supported in this mode. Exmaple:
		234
		235	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		236
		237	=item block-graphics-to-ascii
		238
		239	A not very useful example of filtering all text output to the terminal,
		240	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		241	similar-looking ascii character.
60		242
61	=item digital-clock	243	=item digital-clock
62		244
63	Displays a digital clock using the built-in overlay.	245	Displays a digital clock using the built-in overlay.
64		246
…		…
66		248
67	Displays a very simple digital clock in the upper right corner of the	249	Displays a very simple digital clock in the upper right corner of the
68	window. Illustrates overwriting the refresh callbacks to create your own	250	window. Illustrates overwriting the refresh callbacks to create your own
69	overlays or changes.	251	overlays or changes.
70		252
		253	=item selection-pastebin
		254
		255	This is a little rarely useful extension that Uploads the selection as
		256	textfile to a remote site (or does other things). (The implementation is
		257	not currently secure for use in a multiuser environment as it writes to
		258	F</tmp> directly.).
		259
		260	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		261	i.e.
		262
		263	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		264
		265	Pressing this combination runs a command with C<%> replaced by the name of
		266	the textfile. This command can be set via a resource:
		267
		268	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		269
		270	And the default is likely not useful to anybody but the few people around
		271	here :)
		272
		273	The name of the textfile is the hex encoded md5 sum of the selection, so
		274	the same content should lead to the same filename.
		275
		276	After a successful upload the selection will be replaced by the text given
		277	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		278	for the filename):
		279
		280	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		281
71	=back	282	=back
		283
		284	=head1 API DOCUMENTATION
72		285
73	=head2 General API Considerations	286	=head2 General API Considerations
74		287
75	All objects (such as terminals, time watchers etc.) are typical	288	All objects (such as terminals, time watchers etc.) are typical
76	reference-to-hash objects. The hash can be used to store anything you	289	reference-to-hash objects. The hash can be used to store anything you
…		…
81	When objects are destroyed on the C++ side, the perl object hashes are	294	When objects are destroyed on the C++ side, the perl object hashes are
82	emptied, so its best to store related objects such as time watchers and	295	emptied, so its best to store related objects such as time watchers and
83	the like inside the terminal object so they get destroyed as soon as the	296	the like inside the terminal object so they get destroyed as soon as the
84	terminal is destroyed.	297	terminal is destroyed.
85		298
		299	Argument names also often indicate the type of a parameter. Here are some
		300	hints on what they mean:
		301
		302	=over 4
		303
		304	=item $text
		305
		306	Rxvt-unicodes special way of encoding text, where one "unicode" character
		307	always represents one screen cell. See L<ROW_t> for a discussion of this format.
		308
		309	=item $string
		310
		311	A perl text string, with an emphasis on I<text>. It can store all unicode
		312	characters and is to be distinguished with text encoded in a specific
		313	encoding (often locale-specific) and binary data.
		314
		315	=item $octets
		316
		317	Either binary data or - more common - a text string encoded in a
		318	locale-specific way.
		319
		320	=back
		321
		322	=head2 Extension Objects
		323
		324	Very perl extension is a perl class. A separate perl object is created
		325	for each terminal and each extension and passed as the first parameter to
		326	hooks. So extensions can use their C<$self> object without having to think
		327	about other extensions, with the exception of methods and members that
		328	begin with an underscore character C<_>: these are reserved for internal
		329	use.
		330
		331	Although it isn't a C<urxvt::term> object, you can call all methods of the
		332	C<urxvt::term> class on this object.
		333
		334	It has the following methods and data members:
		335
		336	=over 4
		337
		338	=item $urxvt_term = $self->{term}
		339
		340	Returns the C<urxvt::term> object associated with this instance of the
		341	extension. This member I<must not> be changed in any way.
		342
		343	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		344
		345	Dynamically enable the given hooks (named without the C<on_> prefix) for
		346	this extension, replacing any previous hook. This is useful when you want
		347	to overwrite time-critical hooks only temporarily.
		348
		349	=item $self->disable ($hook_name[, $hook_name..])
		350
		351	Dynamically disable the given hooks.
		352
		353	=back
		354
86	=head2 Hooks	355	=head2 Hooks
87		356
88	The following subroutines can be declared in loaded scripts, and will be	357	The following subroutines can be declared in extension files, and will be
89	called whenever the relevant event happens.	358	called whenever the relevant event happens.
90		359
91	The first argument passed to them is an object private to each terminal	360	The first argument passed to them is an extension oject as described in
92	and extension package. You can call all C<urxvt::term> methods on it, but	361	the in the C<Extension Objects> section.
93	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
94	object that is shared between all packages is stored in the C<term>
95	member.
96		362
97	All of them must return a boolean value. If it is true, then the event	363	B<All> of these hooks must return a boolean value. If any of the called
98	counts as being I<consumed>, and the invocation of other hooks is skipped,	364	hooks returns true, then the event counts as being I<consumed>, and the
99	and the relevant action might not be carried out by the C++ code.	365	relevant action might not be carried out by the C++ code.
100		366
101	When in doubt, return a false value (preferably C<()>).	367	I<< When in doubt, return a false value (preferably C<()>). >>
102		368
103	=over 4	369	=over 4
104		370
105	=item on_init $term	371	=item on_init $term
106		372
107	Called after a new terminal object has been initialized, but before	373	Called after a new terminal object has been initialized, but before
108	windows are created or the command gets run.	374	windows are created or the command gets run. Most methods are unsafe to
		375	call or deliver senseless data, as terminal size and other characteristics
		376	have not yet been determined. You can safely query and change resources
		377	and options, though. For many purposes the C<on_start> hook is a better
		378	place.
		379
		380	=item on_start $term
		381
		382	Called at the very end of initialisation of a new terminal, just before
		383	trying to map (display) the toplevel and returning to the mainloop.
		384
		385	=item on_destroy $term
		386
		387	Called whenever something tries to destroy terminal, when the terminal is
		388	still fully functional (not for long, though).
109		389
110	=item on_reset $term	390	=item on_reset $term
111		391
112	Called after the screen is "reset" for any reason, such as resizing or	392	Called after the screen is "reset" for any reason, such as resizing or
113	control sequences. Here is where you can react on changes to size-related	393	control sequences. Here is where you can react on changes to size-related
114	variables.	394	variables.
115		395
116	=item on_start $term	396	=item on_child_start $term, $pid
117		397
118	Called at the very end of initialisation of a new terminal, just before	398	Called just after the child process has been C<fork>ed.
119	returning to the mainloop.	399
		400	=item on_child_exit $term, $status
		401
		402	Called just after the child process has exited. C<$status> is the status
		403	from C<waitpid>.
120		404
121	=item on_sel_make $term, $eventtime	405	=item on_sel_make $term, $eventtime
122		406
123	Called whenever a selection has been made by the user, but before the	407	Called whenever a selection has been made by the user, but before the
124	selection text is copied, so changes to the beginning, end or type of the	408	selection text is copied, so changes to the beginning, end or type of the
…		…
138	=item on_sel_extend $term	422	=item on_sel_extend $term
139		423
140	Called whenever the user tries to extend the selection (e.g. with a double	424	Called whenever the user tries to extend the selection (e.g. with a double
141	click) and is either supposed to return false (normal operation), or	425	click) and is either supposed to return false (normal operation), or
142	should extend the selection itelf and return true to suppress the built-in	426	should extend the selection itelf and return true to suppress the built-in
143	processing.	427	processing. This can happen multiple times, as long as the callback
		428	returns true, it will be called on every further click by the user and is
		429	supposed to enlarge the selection more and more, if possible.
144		430
145	See the F<selection> example extension.	431	See the F<selection> example extension.
146
147	=item on_focus_in $term
148
149	Called whenever the window gets the keyboard focus, before urxvt does
150	focus in processing.
151
152	=item on_focus_out $term
153
154	Called wheneever the window loses keyboard focus, before urxvt does focus
155	out processing.
156		432
157	=item on_view_change $term, $offset	433	=item on_view_change $term, $offset
158		434
159	Called whenever the view offset changes, i..e the user or program	435	Called whenever the view offset changes, i..e the user or program
160	scrolls. Offset C<0> means display the normal terminal, positive values	436	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
167	than the scroll back buffer or the terminal.	443	than the scroll back buffer or the terminal.
168		444
169	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	445	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
170	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	446	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
171	number of lines that will be in the scrollback buffer.	447	number of lines that will be in the scrollback buffer.
172
173	=item on_tty_activity $term *NYI*
174
175	Called whenever the program(s) running in the urxvt window send output.
176		448
177	=item on_osc_seq $term, $string	449	=item on_osc_seq $term, $string
178		450
179	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	451	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
180	operating system command) is processed. Cursor position and other state	452	operating system command) is processed. Cursor position and other state
…		…
185		457
186	Be careful not ever to trust (in a security sense) the data you receive,	458	Be careful not ever to trust (in a security sense) the data you receive,
187	as its source can not easily be controleld (e-mail content, messages from	459	as its source can not easily be controleld (e-mail content, messages from
188	other users on the same system etc.).	460	other users on the same system etc.).
189		461
		462	=item on_add_lines $term, $string
		463
		464	Called whenever text is about to be output, with the text as argument. You
		465	can filter/change and output the text yourself by returning a true value
		466	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		467	might be very slow, however, as your hook is called for B<all> text being
		468	output.
		469
		470	=item on_tt_write $term, $octets
		471
		472	Called whenever some data is written to the tty/pty and can be used to
		473	suppress or filter tty input.
		474
		475	=item on_line_update $term, $row
		476
		477	Called whenever a line was updated or changed. Can be used to filter
		478	screen output (e.g. underline urls or other useless stuff). Only lines
		479	that are being shown will be filtered, and, due to performance reasons,
		480	not always immediately.
		481
		482	The row number is always the topmost row of the line if the line spans
		483	multiple rows.
		484
		485	Please note that, if you change the line, then the hook might get called
		486	later with the already-modified line (e.g. if unrelated parts change), so
		487	you cannot just toggle rendition bits, but only set them.
		488
190	=item on_refresh_begin $term	489	=item on_refresh_begin $term
191		490
192	Called just before the screen gets redrawn. Can be used for overlay	491	Called just before the screen gets redrawn. Can be used for overlay
193	or similar effects by modify terminal contents in refresh_begin, and	492	or similar effects by modify terminal contents in refresh_begin, and
194	restoring them in refresh_end. The built-in overlay and selection display	493	restoring them in refresh_end. The built-in overlay and selection display
…		…
202		501
203	Called whenever the user presses a key combination that has a	502	Called whenever the user presses a key combination that has a
204	C<perl:string> action bound to it (see description of the B<keysym>	503	C<perl:string> action bound to it (see description of the B<keysym>
205	resource in the @@RXVT_NAME@@(1) manpage).	504	resource in the @@RXVT_NAME@@(1) manpage).
206		505
		506	=item on_x_event $term, $event
		507
		508	Called on every X event received on the vt window (and possibly other
		509	windows). Should only be used as a last resort. Most event structure
		510	members are not passed.
		511
		512	=item on_focus_in $term
		513
		514	Called whenever the window gets the keyboard focus, before rxvt-unicode
		515	does focus in processing.
		516
		517	=item on_focus_out $term
		518
		519	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		520	focus out processing.
		521
		522	=item on_configure_notify $term, $event
		523
		524	=item on_property_notify $term, $event
		525
		526	=item on_key_press $term, $event, $keysym, $octets
		527
		528	=item on_key_release $term, $event, $keysym
		529
		530	=item on_button_press $term, $event
		531
		532	=item on_button_release $term, $event
		533
		534	=item on_motion_notify $term, $event
		535
		536	=item on_map_notify $term, $event
		537
		538	=item on_unmap_notify $term, $event
		539
		540	Called whenever the corresponding X event is received for the terminal If
		541	the hook returns true, then the even will be ignored by rxvt-unicode.
		542
		543	The event is a hash with most values as named by Xlib (see the XEvent
		544	manpage), with the additional members C<row> and C<col>, which are the
		545	(real, not screen-based) row and column under the mouse cursor.
		546
		547	C<on_key_press> additionally receives the string rxvt-unicode would
		548	output, if any, in locale-specific encoding.
		549
		550	subwindow.
		551
		552	=item on_client_message $term, $event
		553
		554	=item on_wm_protocols $term, $event
		555
		556	=item on_wm_delete_window $term, $event
		557
		558	Called when various types of ClientMessage events are received (all with
		559	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		560
207	=back	561	=back
208		562
		563	=cut
		564
		565	package urxvt;
		566
		567	use utf8;
		568	use strict;
		569	use Carp ();
		570	use Scalar::Util ();
		571	use List::Util ();
		572
		573	our $VERSION = 1;
		574	our $TERM;
		575	our @TERM_INIT;
		576	our @TERM_EXT;
		577	our @HOOKNAME;
		578	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		579	our %OPTION;
		580
		581	our $LIBDIR;
		582	our $RESNAME;
		583	our $RESCLASS;
		584	our $RXVTNAME;
		585
		586	our $NOCHAR = chr 0xffff;
		587
209	=head2 Variables in the C<urxvt> Package	588	=head2 Variables in the C<urxvt> Package
210		589
211	=over 4	590	=over 4
212		591
		592	=item $urxvt::LIBDIR
		593
		594	The rxvt-unicode library directory, where, among other things, the perl
		595	modules and scripts are stored.
		596
		597	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		598
		599	The resource class and name rxvt-unicode uses to look up X resources.
		600
		601	=item $urxvt::RXVTNAME
		602
		603	The basename of the installed binaries, usually C<urxvt>.
		604
213	=item $urxvt::TERM	605	=item $urxvt::TERM
214		606
215	The current terminal. Whenever a callback/Hook is bein executed, this	607	The current terminal. This variable stores the current C<urxvt::term>
216	variable stores the current C<urxvt::term> object.	608	object, whenever a callback/hook is executing.
		609
		610	=item @urxvt::TERM_INIT
		611
		612	All coderefs in this array will be called as methods of the next newly
		613	created C<urxvt::term> object (during the C<on_init> phase). The array
		614	gets cleared before the codereferences that were in it are being executed,
		615	so coderefs can push themselves onto it again if they so desire.
		616
		617	This complements to the perl-eval commandline option, but gets executed
		618	first.
		619
		620	=item @urxvt::TERM_EXT
		621
		622	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		623	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		624	but before other extensions. Gets cleared just like C<@TERM_INIT>.
217		625
218	=back	626	=back
219		627
220	=head2 Functions in the C<urxvt> Package	628	=head2 Functions in the C<urxvt> Package
221		629
…		…
234	that calls this function.	642	that calls this function.
235		643
236	Using this function has the advantage that its output ends up in the	644	Using this function has the advantage that its output ends up in the
237	correct place, e.g. on stderr of the connecting urxvtc client.	645	correct place, e.g. on stderr of the connecting urxvtc client.
238		646
		647	Messages have a size limit of 1023 bytes currently.
		648
239	=item $time = urxvt::NOW	649	=item $time = urxvt::NOW
240		650
241	Returns the "current time" (as per the event loop).	651	Returns the "current time" (as per the event loop).
		652
		653	=item urxvt::CurrentTime
		654
		655	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		656	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		657	Button4Mask, Button5Mask, AnyModifier
		658
		659	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		660	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		661	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		662	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		663	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		664	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		665	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		666
		667	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		668	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		669	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		670	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		671	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		672	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		673	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		674
		675	Various constants for use in X calls and event processing.
242		676
243	=back	677	=back
244		678
245	=head2 RENDITION	679	=head2 RENDITION
246		680
…		…
273		707
274	=item $background = urxvt::GET_BASEBG $rend	708	=item $background = urxvt::GET_BASEBG $rend
275		709
276	Return the foreground/background colour index, respectively.	710	Return the foreground/background colour index, respectively.
277		711
278	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	712	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
279		713
280	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	714	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
281		715
282	Replace the foreground/background colour in the rendition mask with the	716	Replace the foreground/background colour in the rendition mask with the
283	specified one.	717	specified one.
284		718
285	=item $value = urxvt::GET_CUSTOM ($rend)	719	=item $value = urxvt::GET_CUSTOM $rend
286		720
287	Return the "custom" value: Every rendition has 5 bits for use by	721	Return the "custom" value: Every rendition has 5 bits for use by
288	extensions. They can be set and changed as you like and are initially	722	extensions. They can be set and changed as you like and are initially
289	zero.	723	zero.
290		724
291	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	725	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
292		726
293	Change the custom value.	727	Change the custom value.
294		728
295	=back	729	=back
296		730
297	=cut	731	=cut
298		732
299	package urxvt;
300
301	use strict;
302	use Scalar::Util ();
303
304	our $TERM;
305	our @HOOKNAME;
306	our $LIBDIR;
307
308	BEGIN {	733	BEGIN {
309	urxvt->bootstrap;
310
311	# overwrite perl's warn	734	# overwrite perl's warn
312	*CORE::GLOBAL::warn = sub {	735	*CORE::GLOBAL::warn = sub {
313	my $msg = join "", @_;	736	my $msg = join "", @_;
314	$msg .= "\n"	737	$msg .= "\n"
315	unless $msg =~ /\n$/;	738	unless $msg =~ /\n$/;
316	urxvt::warn ($msg);	739	urxvt::warn ($msg);
317	};	740	};
318	}	741	}
319		742
320	my @hook_count;	743	no warnings 'utf8';
		744
321	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	745	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
322		746
323	sub verbose {	747	sub verbose {
324	my ($level, $msg) = @_;	748	my ($level, $msg) = @_;
325	warn "$msg\n" if $level <= $verbosity;	749	warn "$msg\n" if $level <= $verbosity;
326	}	750	}
327		751
328	# find on_xxx subs in the package and register them	752	my %extension_pkg;
329	# as hooks
330	sub register_package($) {
331	my ($pkg) = @_;
332
333	for my $htype (0.. $#HOOKNAME) {
334	my $name = $HOOKNAME[$htype];
335
336	my $ref = $pkg->can ("on_" . lc $name)
337	or next;
338
339	$TERM->{_hook}[$htype]{$pkg} = $ref;
340	$hook_count[$htype]++
341	or set_should_invoke $htype, 1;
342	}
343	}
344
345	my $script_pkg = "script0000";
346	my %script_pkg;
347		753
348	# load a single script into its own package, once only	754	# load a single script into its own package, once only
349	sub script_package($) {	755	sub extension_package($) {
350	my ($path) = @_;	756	my ($path) = @_;
351		757
352	$script_pkg{$path} ||= do {	758	$extension_pkg{$path} ||= do {
353	my $pkg = "urxvt::" . ($script_pkg++);	759	$path =~ /([^\/\\]+)$/;
		760	my $pkg = $1;
		761	$pkg =~ s/[^[:word:]]/_/g;
		762	$pkg = "urxvt::ext::$pkg";
354		763
355	verbose 3, "loading script '$path' into package '$pkg'";	764	verbose 3, "loading extension '$path' into package '$pkg'";
356		765
357	open my $fh, "<:raw", $path	766	open my $fh, "<:raw", $path
358	or die "$path: $!";	767	or die "$path: $!";
359		768
360	my $source = "package $pkg; use strict; use utf8;\n"	769	my $source =
		770	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
361	. "#line 1 \"$path\"\n{\n"	771	. "#line 1 \"$path\"\n{\n"
362	. (do { local $/; <$fh> })	772	. (do { local $/; <$fh> })
363	. "\n};\n1";	773	. "\n};\n1";
364		774
		775	eval $source
365	eval $source or die "$path: $@";	776	or die "$path: $@";
366		777
367	$pkg	778	$pkg
368	}	779	}
369	}	780	}
		781
		782	our $retval; # return value for urxvt
370		783
371	# called by the rxvt core	784	# called by the rxvt core
372	sub invoke {	785	sub invoke {
373	local $TERM = shift;	786	local $TERM = shift;
374	my $htype = shift;	787	my $htype = shift;
375		788
376	if ($htype == 0) { # INIT	789	if ($htype == 0) { # INIT
377	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	790	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		791
		792	my %ext_arg;
378		793
379	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	794	{
		795	my @init = @TERM_INIT;
		796	@TERM_INIT = ();
		797	$_->($TERM) for @init;
		798	my @pkg = @TERM_EXT;
		799	@TERM_EXT = ();
		800	$TERM->register_package ($_) for @pkg;
		801	}
		802
		803	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		804	if ($_ eq "default") {
		805	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
		806	} elsif (/^-(.*)$/) {
		807	delete $ext_arg{$1};
		808	} elsif (/^([^<]+)<(.*)>$/) {
		809	push @{ $ext_arg{$1} }, $2;
		810	} else {
		811	$ext_arg{$_} ||= [];
		812	}
		813	}
		814
		815	while (my ($ext, $argv) = each %ext_arg) {
380	my @files = grep -f $_, map "$_/$ext", @dirs;	816	my @files = grep -f $_, map "$_/$ext", @dirs;
381		817
382	if (@files) {	818	if (@files) {
383	register_package script_package $files[0];	819	$TERM->register_package (extension_package $files[0], $argv);
384	} else {	820	} else {
385	warn "perl extension '$ext' not found in perl library search path\n";	821	warn "perl extension '$ext' not found in perl library search path\n";
386	}	822	}
387	}	823	}
388		824
389	} elsif ($htype == 1) { # DESTROY	825	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		826	warn $@ if $@;
		827	}
		828
		829	$retval = undef;
		830
390	if (my $hook = $TERM->{_hook}) {	831	if (my $cb = $TERM->{_hook}[$htype]) {
391	for my $htype (0..$#$hook) {	832	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
392	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }	833	if $verbosity >= 10;
393	or set_should_invoke $htype, 0;	834
		835	keys %$cb;
		836
		837	while (my ($pkg, $cb) = each %$cb) {
		838	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
		839	$retval ||= $retval_;
		840
		841	if ($@) {
		842	$TERM->ungrab; # better to lose the grab than the session
		843	warn $@;
394	}	844	}
395	}	845	}
		846
		847	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		848	if $verbosity >= 11;
396	}	849	}
397		850
398	my $cb = $TERM->{_hook}[$htype]	851	if ($htype == 1) { # DESTROY
399	or return;	852	# clear package objects
		853	%$_ = () for values %{ $TERM->{_pkg} };
400		854
401	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	855	# clear package
402	if $verbosity >= 10;	856	%$TERM = ();
403
404	keys %$cb;
405
406	while (my ($pkg, $cb) = each %$cb) {
407	return 1
408	if $cb->(
409	$TERM->{$pkg} ||= do {
410	my $proxy = bless { }, urxvt::term::proxy::;
411	Scalar::Util::weaken ($proxy->{term} = $TERM);
412	$proxy
413	},
414	@_,
415	);
416	}	857	}
417		858
		859	$retval
		860	}
		861
		862	# urxvt::term::extension
		863
		864	package urxvt::term::extension;
		865
		866	sub enable {
		867	my ($self, %hook) = @_;
		868	my $pkg = $self->{_pkg};
		869
		870	while (my ($name, $cb) = each %hook) {
		871	my $htype = $HOOKTYPE{uc $name};
		872	defined $htype
		873	or Carp::croak "unsupported hook type '$name'";
		874
		875	$self->set_should_invoke ($htype, +1)
		876	unless exists $self->{term}{_hook}[$htype]{$pkg};
		877
		878	$self->{term}{_hook}[$htype]{$pkg} = $cb;
418	0	879	}
419	}	880	}
420		881
421	sub urxvt::term::proxy::AUTOLOAD {	882	sub disable {
422	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	883	my ($self, @hook) = @_;
		884	my $pkg = $self->{_pkg};
		885
		886	for my $name (@hook) {
		887	my $htype = $HOOKTYPE{uc $name};
		888	defined $htype
		889	or Carp::croak "unsupported hook type '$name'";
		890
		891	$self->set_should_invoke ($htype, -1)
		892	if delete $self->{term}{_hook}[$htype]{$pkg};
		893	}
		894	}
		895
		896	our $AUTOLOAD;
		897
		898	sub AUTOLOAD {
		899	$AUTOLOAD =~ /:([^:]+)$/
423	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	900	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
424		901
425	eval qq{	902	eval qq{
426	sub $urxvt::term::proxy::AUTOLOAD {	903	sub $AUTOLOAD {
427	my \$proxy = shift;	904	my \$proxy = shift;
428	\$proxy->{term}->$1 (\@_)	905	\$proxy->{term}->$1 (\@_)
429	}	906	}
430	1	907	1
431	} or die "FATAL: unable to compile method forwarder: $@";	908	} or die "FATAL: unable to compile method forwarder: $@";
432		909
433	goto &$urxvt::term::proxy::AUTOLOAD;	910	goto &$AUTOLOAD;
434	}	911	}
		912
		913	sub DESTROY {
		914	# nop
		915	}
		916
		917	# urxvt::destroy_hook
		918
		919	sub urxvt::destroy_hook::DESTROY {
		920	${$_[0]}->();
		921	}
		922
		923	sub urxvt::destroy_hook(&) {
		924	bless \shift, urxvt::destroy_hook::
		925	}
		926
		927	package urxvt::anyevent;
		928
		929	=head2 The C<urxvt::anyevent> Class
		930
		931	The sole purpose of this class is to deliver an interface to the
		932	C<AnyEvent> module - any module using it will work inside urxvt without
		933	further programming. The only exception is that you cannot wait on
		934	condition variables, but non-blocking condvar use is ok. What this means
		935	is that you cannot use blocking APIs, but the non-blocking variant should
		936	work.
		937
		938	=cut
		939
		940	our $VERSION = 1;
		941
		942	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		943	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		944
		945	sub timer {
		946	my ($class, %arg) = @_;
		947
		948	my $cb = $arg{cb};
		949
		950	urxvt::timer
		951	->new
		952	->start (urxvt::NOW + $arg{after})
		953	->cb (sub {
		954	$_[0]->stop; # need to cancel manually
		955	$cb->();
		956	})
		957	}
		958
		959	sub io {
		960	my ($class, %arg) = @_;
		961
		962	my $cb = $arg{cb};
		963
		964	bless [$arg{fh}, urxvt::iow
		965	->new
		966	->fd (fileno $arg{fh})
		967	->events (($arg{poll} =~ /r/ ? 1 : 0)
		968	| ($arg{poll} =~ /w/ ? 2 : 0))
		969	->start
		970	->cb (sub {
		971	$cb->(($_[1] & 1 ? 'r' : '')
		972	. ($_[1] & 2 ? 'w' : ''));
		973	})],
		974	urxvt::anyevent::
		975	}
		976
		977	sub DESTROY {
		978	$_[0][1]->stop;
		979	}
		980
		981	sub condvar {
		982	bless \my $flag, urxvt::anyevent::condvar::
		983	}
		984
		985	sub urxvt::anyevent::condvar::broadcast {
		986	${$_[0]}++;
		987	}
		988
		989	sub urxvt::anyevent::condvar::wait {
		990	unless (${$_[0]}) {
		991	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		992	}
		993	}
		994
		995	package urxvt::term;
435		996
436	=head2 The C<urxvt::term> Class	997	=head2 The C<urxvt::term> Class
437		998
438	=over 4	999	=over 4
		1000
		1001	=cut
		1002
		1003	# find on_xxx subs in the package and register them
		1004	# as hooks
		1005	sub register_package {
		1006	my ($self, $pkg, $argv) = @_;
		1007
		1008	no strict 'refs';
		1009
		1010	urxvt::verbose 6, "register package $pkg to $self";
		1011
		1012	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1013
		1014	my $proxy = bless {
		1015	_pkg => $pkg,
		1016	argv => $argv,
		1017	}, $pkg;
		1018	Scalar::Util::weaken ($proxy->{term} = $self);
		1019
		1020	$self->{_pkg}{$pkg} = $proxy;
		1021
		1022	for my $name (@HOOKNAME) {
		1023	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1024	$proxy->enable ($name => $ref);
		1025	}
		1026	}
		1027	}
		1028
		1029	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1030
		1031	Creates a new terminal, very similar as if you had started it with system
		1032	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1033	hash which defines the environment of the new terminal.
		1034
		1035	Croaks (and probably outputs an error message) if the new instance
		1036	couldn't be created. Returns C<undef> if the new instance didn't
		1037	initialise perl, and the terminal object otherwise. The C<init> and
		1038	C<start> hooks will be called during this call.
		1039
		1040	=cut
		1041
		1042	sub new {
		1043	my ($class, $env, @args) = @_;
		1044
		1045	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		1046	}
		1047
		1048	=item $term->destroy
		1049
		1050	Destroy the terminal object (close the window, free resources
		1051	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1052	watchers (timers, io watchers) are still active.
		1053
		1054	=item $term->exec_async ($cmd[, @args])
		1055
		1056	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1057	("starts") programs in the background. This function takes care of setting
		1058	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1059	be preferred over explicit calls to C<exec> or C<system>.
		1060
		1061	Returns the pid of the subprocess or C<undef> on error.
		1062
		1063	=cut
		1064
		1065	sub exec_async {
		1066	my $self = shift;
		1067
		1068	my $pid = fork;
		1069
		1070	return $pid
		1071	if !defined $pid or $pid;
		1072
		1073	%ENV = %{ $self->env };
		1074
		1075	exec @_;
		1076	urxvt::_exit 255;
		1077	}
		1078
		1079	=item $isset = $term->option ($optval[, $set])
		1080
		1081	Returns true if the option specified by C<$optval> is enabled, and
		1082	optionally change it. All option values are stored by name in the hash
		1083	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		1084
		1085	Here is a a likely non-exhaustive list of option names, please see the
		1086	source file F</src/optinc.h> to see the actual list:
		1087
		1088	borderLess console cursorBlink cursorUnderline hold iconic insecure
		1089	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		1090	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
		1091	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
		1092	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
		1093	transparent tripleclickwords utmpInhibit visualBell
439		1094
440	=item $value = $term->resource ($name[, $newval])	1095	=item $value = $term->resource ($name[, $newval])
441		1096
442	Returns the current resource value associated with a given name and	1097	Returns the current resource value associated with a given name and
443	optionally sets a new value. Setting values is most useful in the C<init>	1098	optionally sets a new value. Setting values is most useful in the C<init>
…		…
453		1108
454	Please note that resource strings will currently only be freed when the	1109	Please note that resource strings will currently only be freed when the
455	terminal is destroyed, so changing options frequently will eat memory.	1110	terminal is destroyed, so changing options frequently will eat memory.
456		1111
457	Here is a a likely non-exhaustive list of resource names, not all of which	1112	Here is a a likely non-exhaustive list of resource names, not all of which
458	are supported in every build, please see the source to see the actual	1113	are supported in every build, please see the source file F</src/rsinc.h>
459	list:	1114	to see the actual list:
460		1115
461	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1116	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
462	borderLess color cursorBlink cursorUnderline cutchars delete_key	1117	borderLess color cursorBlink cursorUnderline cutchars delete_key
463	display_name embed ext_bwidth fade font geometry hold iconName	1118	display_name embed ext_bwidth fade font geometry hold iconName
464	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1119	imFont imLocale inputMethod insecure int_bwidth intensityStyles
465	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1120	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
466	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	1121	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
467	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1122	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
468	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1123	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
469	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1124	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
470	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1125	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
471	shade term_name title transparent transparent_all tripleclickwords	1126	secondaryScreen secondaryScroll selectstyle shade term_name title
472	utmpInhibit visualBell	1127	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1128	visualBell
473		1129
474	=cut	1130	=cut
475		1131
476	sub urxvt::term::resource($$;$) {	1132	sub resource($$;$) {
477	my ($self, $name) = (shift, shift);	1133	my ($self, $name) = (shift, shift);
478	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1134	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
479	goto &urxvt::term::_resource;	1135	&urxvt::term::_resource
480	}	1136	}
		1137
		1138	=item $value = $term->x_resource ($pattern)
		1139
		1140	Returns the X-Resource for the given pattern, excluding the program or
		1141	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1142	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1143	resource with that pattern exists.
		1144
		1145	This method should only be called during the C<on_start> hook, as there is
		1146	only one resource database per display, and later invocations might return
		1147	the wrong resources.
		1148
		1149	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1150
		1151	Adds a keymap translation exactly as specified via a resource. See the
		1152	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1153
		1154	=item $rend = $term->rstyle ([$new_rstyle])
		1155
		1156	Return and optionally change the current rendition. Text that is output by
		1157	the terminal application will use this style.
		1158
		1159	=item ($row, $col) = $term->screen_cur ([$row, $col])
		1160
		1161	Return the current coordinates of the text cursor position and optionally
		1162	set it (which is usually bad as applications don't expect that).
481		1163
482	=item ($row, $col) = $term->selection_mark ([$row, $col])	1164	=item ($row, $col) = $term->selection_mark ([$row, $col])
483		1165
484	=item ($row, $col) = $term->selection_beg ([$row, $col])	1166	=item ($row, $col) = $term->selection_beg ([$row, $col])
485		1167
486	=item ($row, $col) = $term->selection_end ([$row, $col])	1168	=item ($row, $col) = $term->selection_end ([$row, $col])
487		1169
488	Return the current values of the selection mark, begin or end positions,	1170	Return the current values of the selection mark, begin or end positions,
489	and optionally set them to new values.	1171	and optionally set them to new values.
490		1172
		1173	=item $term->selection_make ($eventtime[, $rectangular])
		1174
		1175	Tries to make a selection as set by C<selection_beg> and
		1176	C<selection_end>. If C<$rectangular> is true (default: false), a
		1177	rectangular selection will be made. This is the prefered function to make
		1178	a selection.
		1179
491	=item $success = $term->selection_grab ($eventtime)	1180	=item $success = $term->selection_grab ($eventtime)
492		1181
493	Try to request the primary selection from the server (for example, as set	1182	Try to request the primary selection text from the server (for example, as
494	by the next method).	1183	set by the next method). No visual feedback will be given. This function
		1184	is mostly useful from within C<on_sel_grab> hooks.
495		1185
496	=item $oldtext = $term->selection ([$newtext])	1186	=item $oldtext = $term->selection ([$newtext])
497		1187
498	Return the current selection text and optionally replace it by C<$newtext>.	1188	Return the current selection text and optionally replace it by C<$newtext>.
499		1189
500	#=item $term->overlay ($x, $y, $text)	1190	=item $term->overlay_simple ($x, $y, $text)
501	#	1191
502	#Create a simple multi-line overlay box. See the next method for details.	1192	Create a simple multi-line overlay box. See the next method for details.
503	#	1193
504	#=cut	1194	=cut
505		1195
506	sub urxvt::term::scr_overlay {	1196	sub overlay_simple {
507	die;
508	my ($self, $x, $y, $text) = @_;	1197	my ($self, $x, $y, $text) = @_;
509		1198
510	my @lines = split /\n/, $text;	1199	my @lines = split /\n/, $text;
511		1200
512	my $w = 0;	1201	my $w = List::Util::max map $self->strwidth ($_), @lines;
513	for (map $self->strwidth ($_), @lines) {
514	$w = $_ if $w < $_;
515	}
516		1202
517	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	1203	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
518	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1204	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		1205
		1206	$overlay
519	}	1207	}
520		1208
521	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1209	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
522		1210
523	Create a new (empty) overlay at the given position with the given	1211	Create a new (empty) overlay at the given position with the given
…		…
551		1239
552	If hidden, display the overlay again.	1240	If hidden, display the overlay again.
553		1241
554	=back	1242	=back
555		1243
		1244	=item $popup = $term->popup ($event)
		1245
		1246	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1247	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1248	currently).
		1249
		1250	=cut
		1251
		1252	sub popup {
		1253	my ($self, $event) = @_;
		1254
		1255	$self->grab ($event->{time}, 1)
		1256	or return;
		1257
		1258	my $popup = bless {
		1259	term => $self,
		1260	event => $event,
		1261	}, urxvt::popup::;
		1262
		1263	Scalar::Util::weaken $popup->{term};
		1264
		1265	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1266	Scalar::Util::weaken $self->{_destroy}{$popup};
		1267
		1268	$popup
		1269	}
		1270
556	=item $cellwidth = $term->strwidth $string	1271	=item $cellwidth = $term->strwidth ($string)
557		1272
558	Returns the number of screen-cells this string would need. Correctly	1273	Returns the number of screen-cells this string would need. Correctly
559	accounts for wide and combining characters.	1274	accounts for wide and combining characters.
560		1275
561	=item $octets = $term->locale_encode $string	1276	=item $octets = $term->locale_encode ($string)
562		1277
563	Convert the given text string into the corresponding locale encoding.	1278	Convert the given text string into the corresponding locale encoding.
564		1279
565	=item $string = $term->locale_decode $octets	1280	=item $string = $term->locale_decode ($octets)
566		1281
567	Convert the given locale-encoded octets into a perl string.	1282	Convert the given locale-encoded octets into a perl string.
		1283
		1284	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1285
		1286	XORs the rendition values in the given span with the provided value
		1287	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1288	refresh hooks to provide effects similar to the selection.
		1289
		1290	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1291
		1292	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1293	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1294	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1295	it instead. Both styles I<MUST NOT> contain font styles.
		1296
		1297	=item $term->scr_bell
		1298
		1299	Ring the bell!
		1300
		1301	=item $term->scr_add_lines ($string)
		1302
		1303	Write the given text string to the screen, as if output by the application
		1304	running inside the terminal. It may not contain command sequences (escape
		1305	codes), but is free to use line feeds, carriage returns and tabs. The
		1306	string is a normal text string, not in locale-dependent encoding.
		1307
		1308	Normally its not a good idea to use this function, as programs might be
		1309	confused by changes in cursor position or scrolling. Its useful inside a
		1310	C<on_add_lines> hook, though.
		1311
		1312	=item $term->scr_change_screen ($screen)
		1313
		1314	Switch to given screen - 0 primary, 1 secondary.
		1315
		1316	=item $term->cmd_parse ($octets)
		1317
		1318	Similar to C<scr_add_lines>, but the argument must be in the
		1319	locale-specific encoding of the terminal and can contain command sequences
		1320	(escape codes) that will be interpreted.
568		1321
569	=item $term->tt_write ($octets)	1322	=item $term->tt_write ($octets)
570		1323
571	Write the octets given in C<$data> to the tty (i.e. as program input). To	1324	Write the octets given in C<$data> to the tty (i.e. as program input). To
572	pass characters instead of octets, you should convert your strings first	1325	pass characters instead of octets, you should convert your strings first
573	to the locale-specific encoding using C<< $term->locale_encode >>.	1326	to the locale-specific encoding using C<< $term->locale_encode >>.
574		1327
		1328	=item $old_events = $term->pty_ev_events ([$new_events])
		1329
		1330	Replaces the event mask of the pty watcher by the given event mask. Can
		1331	be used to suppress input and output handling to the pty/tty. See the
		1332	description of C<< urxvt::timer->events >>. Make sure to always restore
		1333	the previous value.
		1334
		1335	=item $fd = $term->pty_fd
		1336
		1337	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1338	is used.
		1339
		1340	=item $windowid = $term->parent
		1341
		1342	Return the window id of the toplevel window.
		1343
		1344	=item $windowid = $term->vt
		1345
		1346	Return the window id of the terminal window.
		1347
		1348	=item $term->vt_emask_add ($x_event_mask)
		1349
		1350	Adds the specified events to the vt event mask. Useful e.g. when you want
		1351	to receive pointer events all the times:
		1352
		1353	$term->vt_emask_add (urxvt::PointerMotionMask);
		1354
		1355	=item $window_width = $term->width
		1356
		1357	=item $window_height = $term->height
		1358
		1359	=item $font_width = $term->fwidth
		1360
		1361	=item $font_height = $term->fheight
		1362
		1363	=item $font_ascent = $term->fbase
		1364
575	=item $nrow = $term->nrow	1365	=item $terminal_rows = $term->nrow
576		1366
577	=item $ncol = $term->ncol	1367	=item $terminal_columns = $term->ncol
578		1368
579	Return the number of rows/columns of the terminal window (i.e. as	1369	=item $has_focus = $term->focus
580	specified by C<-geometry>, excluding any scrollback).
581		1370
		1371	=item $is_mapped = $term->mapped
		1372
		1373	=item $max_scrollback = $term->saveLines
		1374
		1375	=item $nrow_plus_saveLines = $term->total_rows
		1376
		1377	=item $topmost_scrollback_row = $term->top_row
		1378
		1379	Return various integers describing terminal characteristics.
		1380
		1381	=item $x_display = $term->display_id
		1382
		1383	Return the DISPLAY used by rxvt-unicode.
		1384
		1385	=item $lc_ctype = $term->locale
		1386
		1387	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1388
582	=item $nsaved = $term->nsaved	1389	=item $env = $term->env
583		1390
584	Returns the number of lines in the scrollback buffer.	1391	Returns a copy of the environment in effect for the terminal as a hashref
		1392	similar to C<\%ENV>.
		1393
		1394	=cut
		1395
		1396	sub env {
		1397	if (my $env = $_[0]->_env) {
		1398	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1399	} else {
		1400	+{ %ENV }
		1401	}
		1402	}
		1403
		1404	=item $modifiermask = $term->ModLevel3Mask
		1405
		1406	=item $modifiermask = $term->ModMetaMask
		1407
		1408	=item $modifiermask = $term->ModNumLockMask
		1409
		1410	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1411	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1412
		1413	=item $screen = $term->current_screen
		1414
		1415	Returns the currently displayed screen (0 primary, 1 secondary).
		1416
		1417	=item $cursor_is_hidden = $term->hidden_cursor
		1418
		1419	Returns wether the cursor is currently hidden or not.
585		1420
586	=item $view_start = $term->view_start ([$newvalue])	1421	=item $view_start = $term->view_start ([$newvalue])
587		1422
588	Returns the negative row number of the topmost line. Minimum value is	1423	Returns the row number of the topmost displayed line. Maximum value is
589	C<0>, which displays the normal terminal contents. Larger values scroll	1424	C<0>, which displays the normal terminal contents. Lower values scroll
590	this many lines into the scrollback buffer.	1425	this many lines into the scrollback buffer.
591		1426
592	=item $term->want_refresh	1427	=item $term->want_refresh
593		1428
594	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1429	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
609	line, starting at column C<$start_col> (default C<0>), which is useful	1444	line, starting at column C<$start_col> (default C<0>), which is useful
610	to replace only parts of a line. The font index in the rendition will	1445	to replace only parts of a line. The font index in the rendition will
611	automatically be updated.	1446	automatically be updated.
612		1447
613	C<$text> is in a special encoding: tabs and wide characters that use more	1448	C<$text> is in a special encoding: tabs and wide characters that use more
614	than one cell when displayed are padded with urxvt::NOCHAR characters	1449	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
615	(C<chr 65535>). Characters with combining characters and other characters	1450	characters. Characters with combining characters and other characters that
616	that do not fit into the normal tetx encoding will be replaced with	1451	do not fit into the normal tetx encoding will be replaced with characters
617	characters in the private use area.	1452	in the private use area.
618		1453
619	You have to obey this encoding when changing text. The advantage is	1454	You have to obey this encoding when changing text. The advantage is
620	that C<substr> and similar functions work on screen cells and not on	1455	that C<substr> and similar functions work on screen cells and not on
621	characters.	1456	characters.
622		1457
…		…
652	about the logical line that row C<$row_number> is part of. It supports the	1487	about the logical line that row C<$row_number> is part of. It supports the
653	following methods:	1488	following methods:
654		1489
655	=over 4	1490	=over 4
656		1491
657	=item $text = $line->t	1492	=item $text = $line->t ([$new_text])
658		1493
659	Returns the full text of the line, similar to C<ROW_t>	1494	Returns or replaces the full text of the line, similar to C<ROW_t>
660		1495
661	=item $rend = $line->r	1496	=item $rend = $line->r ([$new_rend])
662		1497
663	Returns the full rendition array of the line, similar to C<ROW_r>	1498	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
664		1499
665	=item $length = $line->l	1500	=item $length = $line->l
666		1501
667	Returns the length of the line in cells, similar to C<ROW_l>.	1502	Returns the length of the line in cells, similar to C<ROW_l>.
668		1503
…		…
673	Return the row number of the first/last row of the line, respectively.	1508	Return the row number of the first/last row of the line, respectively.
674		1509
675	=item $offset = $line->offset_of ($row, $col)	1510	=item $offset = $line->offset_of ($row, $col)
676		1511
677	Returns the character offset of the given row|col pair within the logical	1512	Returns the character offset of the given row|col pair within the logical
678	line.	1513	line. Works for rows outside the line, too, and returns corresponding
		1514	offsets outside the string.
679		1515
680	=item ($row, $col) = $line->coord_of ($offset)	1516	=item ($row, $col) = $line->coord_of ($offset)
681		1517
682	Translates a string offset into terminal coordinates again.	1518	Translates a string offset into terminal coordinates again.
683		1519
684	=back	1520	=back
685		1521
686	=cut	1522	=cut
687		1523
688	sub urxvt::term::line {	1524	sub line {
689	my ($self, $row) = @_;	1525	my ($self, $row) = @_;
690		1526
691	my $maxrow = $self->nrow - 1;	1527	my $maxrow = $self->nrow - 1;
692		1528
693	my ($beg, $end) = ($row, $row);	1529	my ($beg, $end) = ($row, $row);
…		…
697		1533
698	bless {	1534	bless {
699	term => $self,	1535	term => $self,
700	beg => $beg,	1536	beg => $beg,
701	end => $end,	1537	end => $end,
		1538	ncol => $self->ncol,
702	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1539	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
703	}, urxvt::line::	1540	}, urxvt::line::
704	}	1541	}
705		1542
706	sub urxvt::line::t {	1543	sub urxvt::line::t {
707	my ($self) = @_;	1544	my ($self) = @_;
708		1545
		1546	if (@_ > 1)
		1547	{
		1548	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1549	for $self->{beg} .. $self->{end};
		1550	}
		1551
		1552	defined wantarray &&
709	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1553	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
710	0, $self->{len}	1554	0, $self->{len}
711	}	1555	}
712		1556
713	sub urxvt::line::r {	1557	sub urxvt::line::r {
714	my ($self) = @_;	1558	my ($self) = @_;
715		1559
		1560	if (@_ > 1)
		1561	{
		1562	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1563	for $self->{beg} .. $self->{end};
		1564	}
		1565
		1566	if (defined wantarray) {
716	my $rend = [	1567	my $rend = [
717	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1568	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
718	];	1569	];
719	$#$rend = $self->{len} - 1;	1570	$#$rend = $self->{len} - 1;
720	$rend	1571	return $rend;
		1572	}
		1573
		1574	()
721	}	1575	}
722		1576
723	sub urxvt::line::beg { $_[0]{beg} }	1577	sub urxvt::line::beg { $_[0]{beg} }
724	sub urxvt::line::end { $_[0]{end} }	1578	sub urxvt::line::end { $_[0]{end} }
725	sub urxvt::line::l { $_[0]{len} }	1579	sub urxvt::line::l { $_[0]{len} }
726		1580
727	sub urxvt::line::offset_of {	1581	sub urxvt::line::offset_of {
728	my ($self, $row, $col) = @_;	1582	my ($self, $row, $col) = @_;
729		1583
730	($row - $self->{beg}) * $self->{term}->ncol + $col	1584	($row - $self->{beg}) * $self->{ncol} + $col
731	}	1585	}
732		1586
733	sub urxvt::line::coord_of {	1587	sub urxvt::line::coord_of {
734	my ($self, $offset) = @_;	1588	my ($self, $offset) = @_;
735		1589
736	use integer;	1590	use integer;
737		1591
738	(	1592	(
739	$offset / $self->{term}->ncol + $self->{beg},	1593	$offset / $self->{ncol} + $self->{beg},
740	$offset % $self->{term}->ncol	1594	$offset % $self->{ncol}
741	)	1595	)
742	}	1596	}
743		1597
744	=item ($row, $col) = $line->coord_of ($offset)
745	=item $text = $term->special_encode $string	1598	=item $text = $term->special_encode $string
746		1599
747	Converts a perl string into the special encoding used by rxvt-unicode,	1600	Converts a perl string into the special encoding used by rxvt-unicode,
748	where one character corresponds to one screen cell. See	1601	where one character corresponds to one screen cell. See
749	C<< $term->ROW_t >> for details.	1602	C<< $term->ROW_t >> for details.
…		…
751	=item $string = $term->special_decode $text	1604	=item $string = $term->special_decode $text
752		1605
753	Converts rxvt-unicodes text reprsentation into a perl string. See	1606	Converts rxvt-unicodes text reprsentation into a perl string. See
754	C<< $term->ROW_t >> for details.	1607	C<< $term->ROW_t >> for details.
755		1608
		1609	=item $success = $term->grab_button ($button, $modifiermask)
		1610
		1611	Registers a synchronous button grab. See the XGrabButton manpage.
		1612
		1613	=item $success = $term->grab ($eventtime[, $sync])
		1614
		1615	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1616	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1617
		1618	=item $term->allow_events_async
		1619
		1620	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1621
		1622	=item $term->allow_events_sync
		1623
		1624	Calls XAllowEvents with SyncBoth for the most recent grab.
		1625
		1626	=item $term->allow_events_replay
		1627
		1628	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1629	recent grab.
		1630
		1631	=item $term->ungrab
		1632
		1633	Calls XUngrab for the most recent grab. Is called automatically on
		1634	evaluation errors, as it is better to lose the grab in the error case as
		1635	the session.
		1636
		1637	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1638
		1639	=item $atom_name = $term->XGetAtomName ($atom)
		1640
		1641	=item @atoms = $term->XListProperties ($window)
		1642
		1643	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1644
		1645	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1646
		1647	=item $term->XDeleteProperty ($window, $property)
		1648
		1649	=item $window = $term->DefaultRootWindow
		1650
		1651	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1652
		1653	=item $term->XMapWindow ($window)
		1654
		1655	=item $term->XUnmapWindow ($window)
		1656
		1657	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1658
		1659	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1660
		1661	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1662
		1663	Various X or X-related functions. The C<$term> object only serves as
		1664	the source of the display, otherwise those functions map more-or-less
		1665	directory onto the X functions of the same name.
		1666
756	=back	1667	=back
		1668
		1669	=cut
		1670
		1671	package urxvt::popup;
		1672
		1673	=head2 The C<urxvt::popup> Class
		1674
		1675	=over 4
		1676
		1677	=cut
		1678
		1679	sub add_item {
		1680	my ($self, $item) = @_;
		1681
		1682	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1683	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1684	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1685
		1686	$item->{render} ||= sub { $_[0]{text} };
		1687
		1688	push @{ $self->{item} }, $item;
		1689	}
		1690
		1691	=item $popup->add_title ($title)
		1692
		1693	Adds a non-clickable title to the popup.
		1694
		1695	=cut
		1696
		1697	sub add_title {
		1698	my ($self, $title) = @_;
		1699
		1700	$self->add_item ({
		1701	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1702	text => $title,
		1703	activate => sub { },
		1704	});
		1705	}
		1706
		1707	=item $popup->add_separator ([$sepchr])
		1708
		1709	Creates a separator, optionally using the character given as C<$sepchr>.
		1710
		1711	=cut
		1712
		1713	sub add_separator {
		1714	my ($self, $sep) = @_;
		1715
		1716	$sep ||= "=";
		1717
		1718	$self->add_item ({
		1719	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1720	text => "",
		1721	render => sub { $sep x $self->{term}->ncol },
		1722	activate => sub { },
		1723	});
		1724	}
		1725
		1726	=item $popup->add_button ($text, $cb)
		1727
		1728	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1729	selected.
		1730
		1731	=cut
		1732
		1733	sub add_button {
		1734	my ($self, $text, $cb) = @_;
		1735
		1736	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1737	}
		1738
		1739	=item $popup->add_toggle ($text, $cb, $initial_value)
		1740
		1741	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1742	whenever it gets toggled, with a boolean indicating its value as its first
		1743	argument.
		1744
		1745	=cut
		1746
		1747	sub add_toggle {
		1748	my ($self, $text, $cb, $value) = @_;
		1749
		1750	my $item; $item = {
		1751	type => "button",
		1752	text => " $text",
		1753	value => $value,
		1754	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1755	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1756	};
		1757
		1758	$self->add_item ($item);
		1759	}
		1760
		1761	=item $popup->show
		1762
		1763	Displays the popup (which is initially hidden).
		1764
		1765	=cut
		1766
		1767	sub show {
		1768	my ($self) = @_;
		1769
		1770	local $urxvt::popup::self = $self;
		1771
		1772	my $env = $self->{term}->env;
		1773	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1774	delete $env->{LC_ALL};
		1775	$env->{LC_CTYPE} = $self->{term}->locale;
		1776
		1777	urxvt::term->new ($env, "popup",
		1778	"--perl-lib" => "", "--perl-ext-common" => "",
		1779	"-pty-fd" => -1, "-sl" => 0,
		1780	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
		1781	"--transient-for" => $self->{term}->parent,
		1782	"-display" => $self->{term}->display_id,
		1783	"-pe" => "urxvt-popup")
		1784	or die "unable to create popup window\n";
		1785	}
		1786
		1787	sub DESTROY {
		1788	my ($self) = @_;
		1789
		1790	delete $self->{term}{_destroy}{$self};
		1791	$self->{term}->ungrab;
		1792	}
		1793
		1794	=back
		1795
		1796	=cut
		1797
		1798	package urxvt::watcher;
		1799
		1800	@urxvt::timer::ISA = __PACKAGE__;
		1801	@urxvt::iow::ISA = __PACKAGE__;
		1802	@urxvt::pw::ISA = __PACKAGE__;
		1803	@urxvt::iw::ISA = __PACKAGE__;
757		1804
758	=head2 The C<urxvt::timer> Class	1805	=head2 The C<urxvt::timer> Class
759		1806
760	This class implements timer watchers/events. Time is represented as a	1807	This class implements timer watchers/events. Time is represented as a
761	fractional number of seconds since the epoch. Example:	1808	fractional number of seconds since the epoch. Example:
…		…
800		1847
801	=item $timer = $timer->start ($tstamp)	1848	=item $timer = $timer->start ($tstamp)
802		1849
803	Set the event trigger time to C<$tstamp> and start the timer.	1850	Set the event trigger time to C<$tstamp> and start the timer.
804		1851
		1852	=item $timer = $timer->after ($delay)
		1853
		1854	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		1855
805	=item $timer = $timer->stop	1856	=item $timer = $timer->stop
806		1857
807	Stop the timer.	1858	Stop the timer.
808		1859
809	=back	1860	=back
…		…
814		1865
815	$term->{socket} = ...	1866	$term->{socket} = ...
816	$term->{iow} = urxvt::iow	1867	$term->{iow} = urxvt::iow
817	->new	1868	->new
818	->fd (fileno $term->{socket})	1869	->fd (fileno $term->{socket})
819	->events (1) # wait for read data	1870	->events (urxvt::EVENT_READ)
820	->start	1871	->start
821	->cb (sub {	1872	->cb (sub {
822	my ($iow, $revents) = @_;	1873	my ($iow, $revents) = @_;
823	# $revents must be 1 here, no need to check	1874	# $revents must be 1 here, no need to check
824	sysread $term->{socket}, my $buf, 8192	1875	sysread $term->{socket}, my $buf, 8192
…		…
841		1892
842	Set the filedescriptor (not handle) to watch.	1893	Set the filedescriptor (not handle) to watch.
843		1894
844	=item $iow = $iow->events ($eventmask)	1895	=item $iow = $iow->events ($eventmask)
845		1896
846	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1897	Set the event mask to watch. The only allowed values are
847	data, Bit #1 (value C<2>) enables watching for write data.	1898	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1899	together, or C<urxvt::EVENT_NONE>.
848		1900
849	=item $iow = $iow->start	1901	=item $iow = $iow->start
850		1902
851	Start watching for requested events on the given handle.	1903	Start watching for requested events on the given handle.
852		1904
853	=item $iow = $iow->stop	1905	=item $iow = $iow->stop
854		1906
855	Stop watching for events on the given filehandle.	1907	Stop watching for events on the given filehandle.
		1908
		1909	=back
		1910
		1911	=head2 The C<urxvt::iw> Class
		1912
		1913	This class implements idle watchers, that get called automatically when
		1914	the process is idle. They should return as fast as possible, after doing
		1915	some useful work.
		1916
		1917	=over 4
		1918
		1919	=item $iw = new urxvt::iw
		1920
		1921	Create a new idle watcher object in stopped state.
		1922
		1923	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1924
		1925	Set the callback to be called when the watcher triggers.
		1926
		1927	=item $timer = $timer->start
		1928
		1929	Start the watcher.
		1930
		1931	=item $timer = $timer->stop
		1932
		1933	Stop the watcher.
		1934
		1935	=back
		1936
		1937	=head2 The C<urxvt::pw> Class
		1938
		1939	This class implements process watchers. They create an event whenever a
		1940	process exits, after which they stop automatically.
		1941
		1942	my $pid = fork;
		1943	...
		1944	$term->{pw} = urxvt::pw
		1945	->new
		1946	->start ($pid)
		1947	->cb (sub {
		1948	my ($pw, $exit_status) = @_;
		1949	...
		1950	});
		1951
		1952	=over 4
		1953
		1954	=item $pw = new urxvt::pw
		1955
		1956	Create a new process watcher in stopped state.
		1957
		1958	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1959
		1960	Set the callback to be called when the timer triggers.
		1961
		1962	=item $pw = $timer->start ($pid)
		1963
		1964	Tells the wqtcher to start watching for process C<$pid>.
		1965
		1966	=item $pw = $pw->stop
		1967
		1968	Stop the watcher.
856		1969
857	=back	1970	=back
858		1971
859	=head1 ENVIRONMENT	1972	=head1 ENVIRONMENT
860		1973
…		…
863	This variable controls the verbosity level of the perl extension. Higher	1976	This variable controls the verbosity level of the perl extension. Higher
864	numbers indicate more verbose output.	1977	numbers indicate more verbose output.
865		1978
866	=over 4	1979	=over 4
867		1980
868	=item =0 - only fatal messages	1981	=item == 0 - fatal messages
869		1982
870	=item =3 - script loading and management	1983	=item >= 3 - script loading and management
871		1984
872	=item =10 - all events received	1985	=item >=10 - all called hooks
		1986
		1987	=item >=11 - hook reutrn values
873		1988
874	=back	1989	=back
875		1990
876	=head1 AUTHOR	1991	=head1 AUTHOR
877		1992

Diff Legend

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