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.30 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.109 by root, Thu Jan 19 16:07:09 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	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	47	arguments, which is very convenient, too, if your F<ls> supports
		48	C<--quoting-style=shell>.
48		49
49	It also offers the following bindable event:	50	A double-click usually selects the word under the cursor, further clicks
		51	will enlarge the selection.
		52
		53	The selection works by trying to match a number of regexes and displaying
		54	them in increasing order of length. You can add your own regexes by
		55	specifying resources of the form:
		56
		57	URxvt.selection.pattern-0: perl-regex
		58	URxvt.selection.pattern-1: perl-regex
		59	...
		60
		61	The index number (0, 1...) must not have any holes, and each regex must
		62	contain at least one pair of capturing parentheses, which will be used for
		63	the match. For example, the followign adds a regex that matches everything
		64	between two vertical bars:
		65
		66	URxvt.selection.pattern-0: \\|([^|]+)\\|
		67
		68	You can look at the source of the selection extension to see more
		69	interesting uses, such as parsing a line from beginning to end.
		70
		71	This extension also offers following bindable keyboard commands:
50		72
51	=over 4	73	=over 4
52		74
53	=item rot13	75	=item rot13
54		76
55	Rot-13 the selection when activated. Used via keyboard trigger:	77	Rot-13 the selection when activated. Used via keyboard trigger:
56		78
57	URxvt.keysym.C-M-r: perl:selection:rot13	79	URxvt.keysym.C-M-r: perl:selection:rot13
58		80
59	=back	81	=back
		82
		83	=item option-popup (enabled by default)
		84
		85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		86	runtime.
		87
		88	=item selection-popup (enabled by default)
		89
		90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		91	text into various other formats/action (such as uri unescaping, perl
		92	evalution, web-browser starting etc.), depending on content.
		93
		94	Other extensions can extend this popup menu by pushing a code reference onto
		95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
		96
		97	It's sole argument is the popup menu, which can be modified. The selection
		98	is in C<$_>, which can be used to decide wether to add something or not.
		99	It should either return nothing or a string and a code reference. The
		100	string will be used as button text and the code reference will be called
		101	when the button gets activated and should transform C<$_>.
		102
		103	The following will add an entry C<a to b> that transforms all C<a>s in
		104	the selection to C<b>s, but only if the selection currently contains any
		105	C<a>s:
		106
		107	push urxvt::ext::selection_popup::hook, sub {
		108	/a/ ? ("a to be" => sub { s/a/b/g }
		109	: ()
		110	};
		111
		112	Don't run it in a hook, otherwise the menu will grow and grow. Instead put
		113	it at the toplevel of your extension.
		114
		115	=item searchable-scrollback<hotkey> (enabled by default)
		116
		117	Adds regex search functionality to the scrollback buffer, triggered
		118	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		119	input/output is suspended and a regex is displayed at the bottom of the
		120	screen.
		121
		122	Inputting characters appends them to the regex and continues incremental
		123	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		124	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		125	bottom. C<Escape> leaves search mode and returns to the point where search
		126	was started, while C<Enter> or C<Return> stay at the current position and
		127	additionally stores the first match in the current line into the primary
		128	selection.
		129
		130	=item selection-autotransform
		131
		132	This selection allows you to do automatic transforms on a selection
		133	whenever a selection is made.
		134
		135	It works by specifying perl snippets (most useful is a single C<s///>
		136	operator) that modify C<$_> as resources:
		137
		138	URxvt.selection-autotransform.0: transform
		139	URxvt.selection-autotransform.1: transform
		140	...
		141
		142	For example, the following will transform selections of the form
		143	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		144	$word>:
		145
		146	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		147
		148	And this example matches the same,but replaces it with vi-commands you can
		149	paste directly into your (vi :) editor:
		150
		151	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		152
		153	Of course, this can be modified to suit your needs and your editor :)
		154
		155	To expand the example above to typical perl error messages ("XXX at
		156	FILENAME line YYY."), you need a slightly more elaborate solution:
		157
		158	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		159	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		160
		161	The first line tells the selection code to treat the unchanging part of
		162	every error message as a selection pattern, and the second line transforms
		163	the message into vi commands to load the file.
		164
		165	=item mark-urls
		166
		167	Uses per-line display filtering (C<on_line_update>) to underline urls and
		168	make them clickable. When middle-clicked, the program specified in the
		169	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		170	the URL as first argument.
		171
		172	=item automove-background
		173
		174	This is basically a one-line extension that dynamically changes the background pixmap offset
		175	to the window position, in effect creating the same effect as pseudo transparency with
		176	a custom pixmap. No scaling is supported in this mode. Exmaple:
		177
		178	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		179
		180	=item block-graphics-to-ascii
		181
		182	A not very useful example of filtering all text output to the terminal,
		183	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		184	similar-looking ascii character.
60		185
61	=item digital-clock	186	=item digital-clock
62		187
63	Displays a digital clock using the built-in overlay.	188	Displays a digital clock using the built-in overlay.
64		189
…		…
66		191
67	Displays a very simple digital clock in the upper right corner of the	192	Displays a very simple digital clock in the upper right corner of the
68	window. Illustrates overwriting the refresh callbacks to create your own	193	window. Illustrates overwriting the refresh callbacks to create your own
69	overlays or changes.	194	overlays or changes.
70		195
		196	=item selection-pastebin
		197
		198	This is a little rarely useful extension that Uploads the selection as
		199	textfile to a remote site (or does other things). (The implementation is
		200	not currently secure for use in a multiuser environment as it writes to
		201	F</tmp> directly.).
		202
		203	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		204	i.e.
		205
		206	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		207
		208	Pressing this combination runs a command with C<%> replaced by the name of
		209	the textfile. This command can be set via a resource:
		210
		211	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		212
		213	And the default is likely not useful to anybody but the few people around
		214	here :)
		215
		216	The name of the textfile is the hex encoded md5 sum of the selection, so
		217	the same content should lead to the same filename.
		218
		219	After a successful upload the selection will be replaced by the text given
		220	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		221	for the filename):
		222
		223	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		224
71	=back	225	=back
		226
		227	=head1 API DOCUMENTATION
72		228
73	=head2 General API Considerations	229	=head2 General API Considerations
74		230
75	All objects (such as terminals, time watchers etc.) are typical	231	All objects (such as terminals, time watchers etc.) are typical
76	reference-to-hash objects. The hash can be used to store anything you	232	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	237	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	238	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	239	the like inside the terminal object so they get destroyed as soon as the
84	terminal is destroyed.	240	terminal is destroyed.
85		241
		242	Argument names also often indicate the type of a parameter. Here are some
		243	hints on what they mean:
		244
		245	=over 4
		246
		247	=item $text
		248
		249	Rxvt-unicodes special way of encoding text, where one "unicode" character
		250	always represents one screen cell. See L<ROW_t> for a discussion of this format.
		251
		252	=item $string
		253
		254	A perl text string, with an emphasis on I<text>. It can store all unicode
		255	characters and is to be distinguished with text encoded in a specific
		256	encoding (often locale-specific) and binary data.
		257
		258	=item $octets
		259
		260	Either binary data or - more common - a text string encoded in a
		261	locale-specific way.
		262
		263	=back
		264
		265	=head2 Extension Objects
		266
		267	Very perl extension is a perl class. A separate perl object is created
		268	for each terminal and each extension and passed as the first parameter to
		269	hooks. So extensions can use their C<$self> object without having to think
		270	about other extensions, with the exception of methods and members that
		271	begin with an underscore character C<_>: these are reserved for internal
		272	use.
		273
		274	Although it isn't a C<urxvt::term> object, you can call all methods of the
		275	C<urxvt::term> class on this object.
		276
		277	It has the following methods and data members:
		278
		279	=over 4
		280
		281	=item $urxvt_term = $self->{term}
		282
		283	Returns the C<urxvt::term> object associated with this instance of the
		284	extension. This member I<must not> be changed in any way.
		285
		286	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		287
		288	Dynamically enable the given hooks (named without the C<on_> prefix) for
		289	this extension, replacing any previous hook. This is useful when you want
		290	to overwrite time-critical hooks only temporarily.
		291
		292	=item $self->disable ($hook_name[, $hook_name..])
		293
		294	Dynamically disable the given hooks.
		295
		296	=back
		297
86	=head2 Hooks	298	=head2 Hooks
87		299
88	The following subroutines can be declared in loaded scripts, and will be	300	The following subroutines can be declared in extension files, and will be
89	called whenever the relevant event happens.	301	called whenever the relevant event happens.
90		302
91	The first argument passed to them is an object private to each terminal	303	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	304	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		305
97	All of them must return a boolean value. If it is true, then the event	306	B<All> of these hooks must return a boolean value. If it is true, then the
98	counts as being I<consumed>, and the invocation of other hooks is skipped,	307	event counts as being I<consumed>, and the invocation of other hooks is
99	and the relevant action might not be carried out by the C++ code.	308	skipped, and the relevant action might not be carried out by the C++ code.
100		309
101	When in doubt, return a false value (preferably C<()>).	310	I<< When in doubt, return a false value (preferably C<()>). >>
102		311
103	=over 4	312	=over 4
104		313
105	=item on_init $term	314	=item on_init $term
106		315
107	Called after a new terminal object has been initialized, but before	316	Called after a new terminal object has been initialized, but before
108	windows are created or the command gets run.	317	windows are created or the command gets run. Most methods are unsafe to
		318	call or deliver senseless data, as terminal size and other characteristics
		319	have not yet been determined. You can safely query and change resources,
		320	though.
109		321
110	=item on_reset $term	322	=item on_reset $term
111		323
112	Called after the screen is "reset" for any reason, such as resizing or	324	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	325	control sequences. Here is where you can react on changes to size-related
…		…
116	=item on_start $term	328	=item on_start $term
117		329
118	Called at the very end of initialisation of a new terminal, just before	330	Called at the very end of initialisation of a new terminal, just before
119	returning to the mainloop.	331	returning to the mainloop.
120		332
		333	=item on_child_start $term, $pid
		334
		335	Called just after the child process has been C<fork>ed.
		336
		337	=item on_child_exit $term, $status
		338
		339	Called just after the child process has exited. C<$status> is the status
		340	from C<waitpid>.
		341
121	=item on_sel_make $term, $eventtime	342	=item on_sel_make $term, $eventtime
122		343
123	Called whenever a selection has been made by the user, but before the	344	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	345	selection text is copied, so changes to the beginning, end or type of the
125	selection will be honored.	346	selection will be honored.
…		…
138	=item on_sel_extend $term	359	=item on_sel_extend $term
139		360
140	Called whenever the user tries to extend the selection (e.g. with a double	361	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	362	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	363	should extend the selection itelf and return true to suppress the built-in
143	processing.	364	processing. This can happen multiple times, as long as the callback
		365	returns true, it will be called on every further click by the user and is
		366	supposed to enlarge the selection more and more, if possible.
144		367
145	See the F<selection> example extension.	368	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		369
157	=item on_view_change $term, $offset	370	=item on_view_change $term, $offset
158		371
159	Called whenever the view offset changes, i..e the user or program	372	Called whenever the view offset changes, i..e the user or program
160	scrolls. Offset C<0> means display the normal terminal, positive values	373	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
167	than the scroll back buffer or the terminal.	380	than the scroll back buffer or the terminal.
168		381
169	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	382	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	383	$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.	384	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		385
177	=item on_osc_seq $term, $string	386	=item on_osc_seq $term, $string
178		387
179	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	388	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
180	operating system command) is processed. Cursor position and other state	389	operating system command) is processed. Cursor position and other state
…		…
185		394
186	Be careful not ever to trust (in a security sense) the data you receive,	395	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	396	as its source can not easily be controleld (e-mail content, messages from
188	other users on the same system etc.).	397	other users on the same system etc.).
189		398
		399	=item on_add_lines $term, $string
		400
		401	Called whenever text is about to be output, with the text as argument. You
		402	can filter/change and output the text yourself by returning a true value
		403	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		404	might be very slow, however, as your hook is called for B<all> text being
		405	output.
		406
		407	=item on_tt_write $term, $octets
		408
		409	Called whenever some data is written to the tty/pty and can be used to
		410	suppress or filter tty input.
		411
		412	=item on_line_update $term, $row
		413
		414	Called whenever a line was updated or changed. Can be used to filter
		415	screen output (e.g. underline urls or other useless stuff). Only lines
		416	that are being shown will be filtered, and, due to performance reasons,
		417	not always immediately.
		418
		419	The row number is always the topmost row of the line if the line spans
		420	multiple rows.
		421
		422	Please note that, if you change the line, then the hook might get called
		423	later with the already-modified line (e.g. if unrelated parts change), so
		424	you cannot just toggle rendition bits, but only set them.
		425
190	=item on_refresh_begin $term	426	=item on_refresh_begin $term
191		427
192	Called just before the screen gets redrawn. Can be used for overlay	428	Called just before the screen gets redrawn. Can be used for overlay
193	or similar effects by modify terminal contents in refresh_begin, and	429	or similar effects by modify terminal contents in refresh_begin, and
194	restoring them in refresh_end. The built-in overlay and selection display	430	restoring them in refresh_end. The built-in overlay and selection display
…		…
202		438
203	Called whenever the user presses a key combination that has a	439	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>	440	C<perl:string> action bound to it (see description of the B<keysym>
205	resource in the @@RXVT_NAME@@(1) manpage).	441	resource in the @@RXVT_NAME@@(1) manpage).
206		442
		443	=item on_x_event $term, $event
		444
		445	Called on every X event received on the vt window (and possibly other
		446	windows). Should only be used as a last resort. Most event structure
		447	members are not passed.
		448
		449	=item on_focus_in $term
		450
		451	Called whenever the window gets the keyboard focus, before rxvt-unicode
		452	does focus in processing.
		453
		454	=item on_focus_out $term
		455
		456	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		457	focus out processing.
		458
		459	=item on_configure_notify $term, $event
		460
		461	=item on_key_press $term, $event, $keysym, $octets
		462
		463	=item on_key_release $term, $event, $keysym
		464
		465	=item on_button_press $term, $event
		466
		467	=item on_button_release $term, $event
		468
		469	=item on_motion_notify $term, $event
		470
		471	=item on_map_notify $term, $event
		472
		473	=item on_unmap_notify $term, $event
		474
		475	Called whenever the corresponding X event is received for the terminal If
		476	the hook returns true, then the even will be ignored by rxvt-unicode.
		477
		478	The event is a hash with most values as named by Xlib (see the XEvent
		479	manpage), with the additional members C<row> and C<col>, which are the row
		480	and column under the mouse cursor.
		481
		482	C<on_key_press> additionally receives the string rxvt-unicode would
		483	output, if any, in locale-specific encoding.
		484
		485	subwindow.
		486
207	=back	487	=back
208		488
		489	=cut
		490
		491	package urxvt;
		492
		493	use utf8;
		494	use strict;
		495	use Carp ();
		496	use Scalar::Util ();
		497	use List::Util ();
		498
		499	our $VERSION = 1;
		500	our $TERM;
		501	our @HOOKNAME;
		502	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		503	our %OPTION;
		504
		505	our $LIBDIR;
		506	our $RESNAME;
		507	our $RESCLASS;
		508	our $RXVTNAME;
		509
209	=head2 Variables in the C<urxvt> Package	510	=head2 Variables in the C<urxvt> Package
210		511
211	=over 4	512	=over 4
212		513
		514	=item $urxvt::LIBDIR
		515
		516	The rxvt-unicode library directory, where, among other things, the perl
		517	modules and scripts are stored.
		518
		519	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		520
		521	The resource class and name rxvt-unicode uses to look up X resources.
		522
		523	=item $urxvt::RXVTNAME
		524
		525	The basename of the installed binaries, usually C<urxvt>.
		526
213	=item $urxvt::TERM	527	=item $urxvt::TERM
214		528
215	The current terminal. Whenever a callback/Hook is bein executed, this	529	The current terminal. This variable stores the current C<urxvt::term>
216	variable stores the current C<urxvt::term> object.	530	object, whenever a callback/hook is executing.
217		531
218	=back	532	=back
219		533
220	=head2 Functions in the C<urxvt> Package	534	=head2 Functions in the C<urxvt> Package
221		535
…		…
234	that calls this function.	548	that calls this function.
235		549
236	Using this function has the advantage that its output ends up in the	550	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.	551	correct place, e.g. on stderr of the connecting urxvtc client.
238		552
		553	Messages have a size limit of 1023 bytes currently.
		554
239	=item $time = urxvt::NOW	555	=item $time = urxvt::NOW
240		556
241	Returns the "current time" (as per the event loop).	557	Returns the "current time" (as per the event loop).
		558
		559	=item urxvt::CurrentTime
		560
		561	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		562	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		563	Button4Mask, Button5Mask, AnyModifier
		564
		565	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		566	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		567	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		568	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		569	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		570	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		571	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		572
		573	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		574	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		575	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		576	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		577	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		578	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		579	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		580
		581	Various constants for use in X calls and event processing.
242		582
243	=back	583	=back
244		584
245	=head2 RENDITION	585	=head2 RENDITION
246		586
…		…
273		613
274	=item $background = urxvt::GET_BASEBG $rend	614	=item $background = urxvt::GET_BASEBG $rend
275		615
276	Return the foreground/background colour index, respectively.	616	Return the foreground/background colour index, respectively.
277		617
278	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	618	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
279		619
280	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	620	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
281		621
282	Replace the foreground/background colour in the rendition mask with the	622	Replace the foreground/background colour in the rendition mask with the
283	specified one.	623	specified one.
284		624
285	=item $value = urxvt::GET_CUSTOM ($rend)	625	=item $value = urxvt::GET_CUSTOM $rend
286		626
287	Return the "custom" value: Every rendition has 5 bits for use by	627	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	628	extensions. They can be set and changed as you like and are initially
289	zero.	629	zero.
290		630
291	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	631	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
292		632
293	Change the custom value.	633	Change the custom value.
294		634
295	=back	635	=back
296		636
297	=cut	637	=cut
298		638
299	package urxvt;
300
301	use strict;
302	use Scalar::Util ();
303
304	our $TERM;
305	our @HOOKNAME;
306	our $LIBDIR;
307
308	BEGIN {	639	BEGIN {
309	urxvt->bootstrap;
310
311	# overwrite perl's warn	640	# overwrite perl's warn
312	*CORE::GLOBAL::warn = sub {	641	*CORE::GLOBAL::warn = sub {
313	my $msg = join "", @_;	642	my $msg = join "", @_;
314	$msg .= "\n"	643	$msg .= "\n"
315	unless $msg =~ /\n$/;	644	unless $msg =~ /\n$/;
316	urxvt::warn ($msg);	645	urxvt::warn ($msg);
317	};	646	};
318	}	647	}
319		648
320	my @hook_count;
321	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	649	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
322		650
323	sub verbose {	651	sub verbose {
324	my ($level, $msg) = @_;	652	my ($level, $msg) = @_;
325	warn "$msg\n" if $level <= $verbosity;	653	warn "$msg\n" if $level <= $verbosity;
326	}	654	}
327		655
328	# find on_xxx subs in the package and register them	656	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		657
348	# load a single script into its own package, once only	658	# load a single script into its own package, once only
349	sub script_package($) {	659	sub extension_package($) {
350	my ($path) = @_;	660	my ($path) = @_;
351		661
		662	no strict 'refs';
		663
352	$script_pkg{$path} ||= do {	664	$extension_pkg{$path} ||= do {
353	my $pkg = "urxvt::" . ($script_pkg++);	665	$path =~ /([^\/\\]+)$/;
		666	my $pkg = $1;
		667	$pkg =~ s/[^[:word:]]/_/g;
		668	$pkg = "urxvt::ext::$pkg";
354		669
355	verbose 3, "loading script '$path' into package '$pkg'";	670	verbose 3, "loading extension '$path' into package '$pkg'";
356		671
357	open my $fh, "<:raw", $path	672	open my $fh, "<:raw", $path
358	or die "$path: $!";	673	or die "$path: $!";
359		674
		675	@{"$pkg\::ISA"} = urxvt::term::extension::;
		676
		677	my $source =
360	my $source = "package $pkg; use strict; use utf8;\n"	678	"package $pkg; use strict; use utf8;\n"
361	. "#line 1 \"$path\"\n{\n"	679	. "#line 1 \"$path\"\n{\n"
362	. (do { local $/; <$fh> })	680	. (do { local $/; <$fh> })
363	. "\n};\n1";	681	. "\n};\n1";
364		682
		683	eval $source
365	eval $source or die "$path: $@";	684	or die "$path: $@";
366		685
367	$pkg	686	$pkg
368	}	687	}
369	}	688	}
		689
		690	our $retval; # return value for urxvt
370		691
371	# called by the rxvt core	692	# called by the rxvt core
372	sub invoke {	693	sub invoke {
373	local $TERM = shift;	694	local $TERM = shift;
374	my $htype = shift;	695	my $htype = shift;
375		696
376	if ($htype == 0) { # INIT	697	if ($htype == 0) { # INIT
377	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	698	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		699
		700	my %ext_arg;
378		701
379	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	702	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		703	if ($_ eq "default") {
		704	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
		705	} elsif (/^-(.*)$/) {
		706	delete $ext_arg{$1};
		707	} elsif (/^([^<]+)<(.*)>$/) {
		708	push @{ $ext_arg{$1} }, $2;
		709	} else {
		710	$ext_arg{$_} ||= [];
		711	}
		712	}
		713
		714	while (my ($ext, $argv) = each %ext_arg) {
380	my @files = grep -f $_, map "$_/$ext", @dirs;	715	my @files = grep -f $_, map "$_/$ext", @dirs;
381		716
382	if (@files) {	717	if (@files) {
383	register_package script_package $files[0];	718	$TERM->register_package (extension_package $files[0], $argv);
384	} else {	719	} else {
385	warn "perl extension '$ext' not found in perl library search path\n";	720	warn "perl extension '$ext' not found in perl library search path\n";
386	}	721	}
387	}	722	}
388		723
389	} elsif ($htype == 1) { # DESTROY	724	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		725	warn $@ if $@;
		726	}
		727
		728	$retval = undef;
		729
390	if (my $hook = $TERM->{_hook}) {	730	if (my $cb = $TERM->{_hook}[$htype]) {
391	for my $htype (0..$#$hook) {	731	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
392	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }	732	if $verbosity >= 10;
393	or set_should_invoke $htype, 0;	733
		734	keys %$cb;
		735
		736	while (my ($pkg, $cb) = each %$cb) {
		737	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
		738	and last;
		739
		740	if ($@) {
		741	$TERM->ungrab; # better to lose the grab than the session
		742	warn $@;
394	}	743	}
395	}	744	}
		745
		746	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		747	if $verbosity >= 11;
396	}	748	}
397		749
398	my $cb = $TERM->{_hook}[$htype]	750	if ($htype == 1) { # DESTROY
399	or return;	751	# clear package objects
		752	%$_ = () for values %{ $TERM->{_pkg} };
400		753
401	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	754	# clear package
402	if $verbosity >= 10;	755	%$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	}	756	}
417		757
		758	$retval
		759	}
		760
		761	# urxvt::term::extension
		762
		763	package urxvt::term::extension;
		764
		765	sub enable {
		766	my ($self, %hook) = @_;
		767	my $pkg = $self->{_pkg};
		768
		769	while (my ($name, $cb) = each %hook) {
		770	my $htype = $HOOKTYPE{uc $name};
		771	defined $htype
		772	or Carp::croak "unsupported hook type '$name'";
		773
		774	$self->set_should_invoke ($htype, +1)
		775	unless exists $self->{term}{_hook}[$htype]{$pkg};
		776
		777	$self->{term}{_hook}[$htype]{$pkg} = $cb;
418	0	778	}
419	}	779	}
420		780
421	sub urxvt::term::proxy::AUTOLOAD {	781	sub disable {
422	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	782	my ($self, @hook) = @_;
		783	my $pkg = $self->{_pkg};
		784
		785	for my $name (@hook) {
		786	my $htype = $HOOKTYPE{uc $name};
		787	defined $htype
		788	or Carp::croak "unsupported hook type '$name'";
		789
		790	$self->set_should_invoke ($htype, -1)
		791	if delete $self->{term}{_hook}[$htype]{$pkg};
		792	}
		793	}
		794
		795	our $AUTOLOAD;
		796
		797	sub AUTOLOAD {
		798	$AUTOLOAD =~ /:([^:]+)$/
423	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	799	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
424		800
425	eval qq{	801	eval qq{
426	sub $urxvt::term::proxy::AUTOLOAD {	802	sub $AUTOLOAD {
427	my \$proxy = shift;	803	my \$proxy = shift;
428	\$proxy->{term}->$1 (\@_)	804	\$proxy->{term}->$1 (\@_)
429	}	805	}
430	1	806	1
431	} or die "FATAL: unable to compile method forwarder: $@";	807	} or die "FATAL: unable to compile method forwarder: $@";
432		808
433	goto &$urxvt::term::proxy::AUTOLOAD;	809	goto &$AUTOLOAD;
434	}	810	}
		811
		812	sub DESTROY {
		813	# nop
		814	}
		815
		816	# urxvt::destroy_hook
		817
		818	sub urxvt::destroy_hook::DESTROY {
		819	${$_[0]}->();
		820	}
		821
		822	sub urxvt::destroy_hook(&) {
		823	bless \shift, urxvt::destroy_hook::
		824	}
		825
		826	package urxvt::anyevent;
		827
		828	=head2 The C<urxvt::anyevent> Class
		829
		830	The sole purpose of this class is to deliver an interface to the
		831	C<AnyEvent> module - any module using it will work inside urxvt without
		832	further programming. The only exception is that you cannot wait on
		833	condition variables, but non-blocking condvar use is ok. What this means
		834	is that you cannot use blocking APIs, but the non-blocking variant should
		835	work.
		836
		837	=cut
		838
		839	our $VERSION = 1;
		840
		841	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		842	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		843
		844	sub timer {
		845	my ($class, %arg) = @_;
		846
		847	my $cb = $arg{cb};
		848
		849	urxvt::timer
		850	->new
		851	->start (urxvt::NOW + $arg{after})
		852	->cb (sub {
		853	$_[0]->stop; # need to cancel manually
		854	$cb->();
		855	})
		856	}
		857
		858	sub io {
		859	my ($class, %arg) = @_;
		860
		861	my $cb = $arg{cb};
		862
		863	bless [$arg{fh}, urxvt::iow
		864	->new
		865	->fd (fileno $arg{fh})
		866	->events (($arg{poll} =~ /r/ ? 1 : 0)
		867	| ($arg{poll} =~ /w/ ? 2 : 0))
		868	->start
		869	->cb (sub {
		870	$cb->(($_[1] & 1 ? 'r' : '')
		871	. ($_[1] & 2 ? 'w' : ''));
		872	})],
		873	urxvt::anyevent::
		874	}
		875
		876	sub DESTROY {
		877	$_[0][1]->stop;
		878	}
		879
		880	sub condvar {
		881	bless \my $flag, urxvt::anyevent::condvar::
		882	}
		883
		884	sub urxvt::anyevent::condvar::broadcast {
		885	${$_[0]}++;
		886	}
		887
		888	sub urxvt::anyevent::condvar::wait {
		889	unless (${$_[0]}) {
		890	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		891	}
		892	}
		893
		894	package urxvt::term;
435		895
436	=head2 The C<urxvt::term> Class	896	=head2 The C<urxvt::term> Class
437		897
438	=over 4	898	=over 4
		899
		900	=cut
		901
		902	# find on_xxx subs in the package and register them
		903	# as hooks
		904	sub register_package {
		905	my ($self, $pkg, $argv) = @_;
		906
		907	my $proxy = bless {
		908	_pkg => $pkg,
		909	argv => $argv,
		910	}, $pkg;
		911	Scalar::Util::weaken ($proxy->{term} = $self);
		912
		913	$self->{_pkg}{$pkg} = $proxy;
		914
		915	for my $name (@HOOKNAME) {
		916	if (my $ref = $pkg->can ("on_" . lc $name)) {
		917	$proxy->enable ($name => $ref);
		918	}
		919	}
		920	}
		921
		922	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		923
		924	Creates a new terminal, very similar as if you had started it with system
		925	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		926	hash which defines the environment of the new terminal.
		927
		928	Croaks (and probably outputs an error message) if the new instance
		929	couldn't be created. Returns C<undef> if the new instance didn't
		930	initialise perl, and the terminal object otherwise. The C<init> and
		931	C<start> hooks will be called during this call.
		932
		933	=cut
		934
		935	sub new {
		936	my ($class, $env, @args) = @_;
		937
		938	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		939	}
		940
		941	=item $term->destroy
		942
		943	Destroy the terminal object (close the window, free resources
		944	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		945	watchers (timers, io watchers) are still active.
		946
		947	=item $term->exec_async ($cmd[, @args])
		948
		949	Works like the combination of the C<fork>/C<exec> builtins, which executes
		950	("starts") programs in the background. This function takes care of setting
		951	the user environment before exec'ing the command (e.g. C<PATH>) and should
		952	be preferred over explicit calls to C<exec> or C<system>.
		953
		954	Returns the pid of the subprocess or C<undef> on error.
		955
		956	=cut
		957
		958	sub exec_async {
		959	my $self = shift;
		960
		961	my $pid = fork;
		962
		963	return $pid
		964	if !defined $pid or $pid;
		965
		966	%ENV = %{ $self->env };
		967
		968	exec @_;
		969	urxvt::_exit 255;
		970	}
		971
		972	=item $isset = $term->option ($optval[, $set])
		973
		974	Returns true if the option specified by C<$optval> is enabled, and
		975	optionally change it. All option values are stored by name in the hash
		976	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		977
		978	Here is a a likely non-exhaustive list of option names, please see the
		979	source file F</src/optinc.h> to see the actual list:
		980
		981	borderLess console cursorBlink cursorUnderline hold iconic insecure
		982	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		983	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
		984	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
		985	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
		986	transparent tripleclickwords utmpInhibit visualBell
439		987
440	=item $value = $term->resource ($name[, $newval])	988	=item $value = $term->resource ($name[, $newval])
441		989
442	Returns the current resource value associated with a given name and	990	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>	991	optionally sets a new value. Setting values is most useful in the C<init>
…		…
453		1001
454	Please note that resource strings will currently only be freed when the	1002	Please note that resource strings will currently only be freed when the
455	terminal is destroyed, so changing options frequently will eat memory.	1003	terminal is destroyed, so changing options frequently will eat memory.
456		1004
457	Here is a a likely non-exhaustive list of resource names, not all of which	1005	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	1006	are supported in every build, please see the source file F</src/rsinc.h>
459	list:	1007	to see the actual list:
460		1008
461	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1009	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
462	borderLess color cursorBlink cursorUnderline cutchars delete_key	1010	borderLess color cursorBlink cursorUnderline cutchars delete_key
463	display_name embed ext_bwidth fade font geometry hold iconName	1011	display_name embed ext_bwidth fade font geometry hold iconName
464	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1012	imFont imLocale inputMethod insecure int_bwidth intensityStyles
465	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1013	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
466	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1014	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
467	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1015	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
468	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1016	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
469	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1017	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
470	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1018	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
471	shade term_name title transparent transparent_all tripleclickwords	1019	secondaryScreen secondaryScroll selectstyle shade term_name title
472	utmpInhibit visualBell	1020	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1021	visualBell
473		1022
474	=cut	1023	=cut
475		1024
476	sub urxvt::term::resource($$;$) {	1025	sub resource($$;$) {
477	my ($self, $name) = (shift, shift);	1026	my ($self, $name) = (shift, shift);
478	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1027	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
479	goto &urxvt::term::_resource;	1028	&urxvt::term::_resource
480	}	1029	}
		1030
		1031	=item $value = $term->x_resource ($pattern)
		1032
		1033	Returns the X-Resource for the given pattern, excluding the program or
		1034	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1035	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1036	resource with that pattern exists.
		1037
		1038	This method should only be called during the C<on_start> hook, as there is
		1039	only one resource database per display, and later invocations might return
		1040	the wrong resources.
		1041
		1042	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1043
		1044	Adds a keymap translation exactly as specified via a resource. See the
		1045	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1046
		1047	=item $rend = $term->rstyle ([$new_rstyle])
		1048
		1049	Return and optionally change the current rendition. Text that is output by
		1050	the terminal application will use this style.
		1051
		1052	=item ($row, $col) = $term->screen_cur ([$row, $col])
		1053
		1054	Return the current coordinates of the text cursor position and optionally
		1055	set it (which is usually bad as applications don't expect that).
481		1056
482	=item ($row, $col) = $term->selection_mark ([$row, $col])	1057	=item ($row, $col) = $term->selection_mark ([$row, $col])
483		1058
484	=item ($row, $col) = $term->selection_beg ([$row, $col])	1059	=item ($row, $col) = $term->selection_beg ([$row, $col])
485		1060
486	=item ($row, $col) = $term->selection_end ([$row, $col])	1061	=item ($row, $col) = $term->selection_end ([$row, $col])
487		1062
488	Return the current values of the selection mark, begin or end positions,	1063	Return the current values of the selection mark, begin or end positions,
489	and optionally set them to new values.	1064	and optionally set them to new values.
490		1065
		1066	=item $term->selection_make ($eventtime[, $rectangular])
		1067
		1068	Tries to make a selection as set by C<selection_beg> and
		1069	C<selection_end>. If C<$rectangular> is true (default: false), a
		1070	rectangular selection will be made. This is the prefered function to make
		1071	a selection.
		1072
491	=item $success = $term->selection_grab ($eventtime)	1073	=item $success = $term->selection_grab ($eventtime)
492		1074
493	Try to request the primary selection from the server (for example, as set	1075	Try to request the primary selection text from the server (for example, as
494	by the next method).	1076	set by the next method). No visual feedback will be given. This function
		1077	is mostly useful from within C<on_sel_grab> hooks.
495		1078
496	=item $oldtext = $term->selection ([$newtext])	1079	=item $oldtext = $term->selection ([$newtext])
497		1080
498	Return the current selection text and optionally replace it by C<$newtext>.	1081	Return the current selection text and optionally replace it by C<$newtext>.
499		1082
500	#=item $term->overlay ($x, $y, $text)	1083	=item $term->overlay_simple ($x, $y, $text)
501	#	1084
502	#Create a simple multi-line overlay box. See the next method for details.	1085	Create a simple multi-line overlay box. See the next method for details.
503	#	1086
504	#=cut	1087	=cut
505		1088
506	sub urxvt::term::scr_overlay {	1089	sub overlay_simple {
507	die;
508	my ($self, $x, $y, $text) = @_;	1090	my ($self, $x, $y, $text) = @_;
509		1091
510	my @lines = split /\n/, $text;	1092	my @lines = split /\n/, $text;
511		1093
512	my $w = 0;	1094	my $w = List::Util::max map $self->strwidth ($_), @lines;
513	for (map $self->strwidth ($_), @lines) {
514	$w = $_ if $w < $_;
515	}
516		1095
517	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	1096	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
518	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1097	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		1098
		1099	$overlay
519	}	1100	}
520		1101
521	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1102	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
522		1103
523	Create a new (empty) overlay at the given position with the given	1104	Create a new (empty) overlay at the given position with the given
…		…
551		1132
552	If hidden, display the overlay again.	1133	If hidden, display the overlay again.
553		1134
554	=back	1135	=back
555		1136
		1137	=item $popup = $term->popup ($event)
		1138
		1139	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1140	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1141	currently).
		1142
		1143	=cut
		1144
		1145	sub popup {
		1146	my ($self, $event) = @_;
		1147
		1148	$self->grab ($event->{time}, 1)
		1149	or return;
		1150
		1151	my $popup = bless {
		1152	term => $self,
		1153	event => $event,
		1154	}, urxvt::popup::;
		1155
		1156	Scalar::Util::weaken $popup->{term};
		1157
		1158	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1159	Scalar::Util::weaken $self->{_destroy}{$popup};
		1160
		1161	$popup
		1162	}
		1163
556	=item $cellwidth = $term->strwidth $string	1164	=item $cellwidth = $term->strwidth ($string)
557		1165
558	Returns the number of screen-cells this string would need. Correctly	1166	Returns the number of screen-cells this string would need. Correctly
559	accounts for wide and combining characters.	1167	accounts for wide and combining characters.
560		1168
561	=item $octets = $term->locale_encode $string	1169	=item $octets = $term->locale_encode ($string)
562		1170
563	Convert the given text string into the corresponding locale encoding.	1171	Convert the given text string into the corresponding locale encoding.
564		1172
565	=item $string = $term->locale_decode $octets	1173	=item $string = $term->locale_decode ($octets)
566		1174
567	Convert the given locale-encoded octets into a perl string.	1175	Convert the given locale-encoded octets into a perl string.
		1176
		1177	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1178
		1179	XORs the rendition values in the given span with the provided value
		1180	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1181	refresh hooks to provide effects similar to the selection.
		1182
		1183	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1184
		1185	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1186	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1187	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1188	it instead. Both styles I<MUST NOT> contain font styles.
		1189
		1190	=item $term->scr_bell
		1191
		1192	Ring the bell!
		1193
		1194	=item $term->scr_add_lines ($string)
		1195
		1196	Write the given text string to the screen, as if output by the application
		1197	running inside the terminal. It may not contain command sequences (escape
		1198	codes), but is free to use line feeds, carriage returns and tabs. The
		1199	string is a normal text string, not in locale-dependent encoding.
		1200
		1201	Normally its not a good idea to use this function, as programs might be
		1202	confused by changes in cursor position or scrolling. Its useful inside a
		1203	C<on_add_lines> hook, though.
		1204
		1205	=item $term->cmd_parse ($octets)
		1206
		1207	Similar to C<scr_add_lines>, but the argument must be in the
		1208	locale-specific encoding of the terminal and can contain command sequences
		1209	(escape codes) that will be interpreted.
568		1210
569	=item $term->tt_write ($octets)	1211	=item $term->tt_write ($octets)
570		1212
571	Write the octets given in C<$data> to the tty (i.e. as program input). To	1213	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	1214	pass characters instead of octets, you should convert your strings first
573	to the locale-specific encoding using C<< $term->locale_encode >>.	1215	to the locale-specific encoding using C<< $term->locale_encode >>.
574		1216
		1217	=item $old_events = $term->pty_ev_events ([$new_events])
		1218
		1219	Replaces the event mask of the pty watcher by the given event mask. Can
		1220	be used to suppress input and output handling to the pty/tty. See the
		1221	description of C<< urxvt::timer->events >>. Make sure to always restore
		1222	the previous value.
		1223
		1224	=item $windowid = $term->parent
		1225
		1226	Return the window id of the toplevel window.
		1227
		1228	=item $windowid = $term->vt
		1229
		1230	Return the window id of the terminal window.
		1231
		1232	=item $term->vt_emask_add ($x_event_mask)
		1233
		1234	Adds the specified events to the vt event mask. Useful e.g. when you want
		1235	to receive pointer events all the times:
		1236
		1237	$term->vt_emask_add (urxvt::PointerMotionMask);
		1238
		1239	=item $window_width = $term->width
		1240
		1241	=item $window_height = $term->height
		1242
		1243	=item $font_width = $term->fwidth
		1244
		1245	=item $font_height = $term->fheight
		1246
		1247	=item $font_ascent = $term->fbase
		1248
575	=item $nrow = $term->nrow	1249	=item $terminal_rows = $term->nrow
576		1250
577	=item $ncol = $term->ncol	1251	=item $terminal_columns = $term->ncol
578		1252
579	Return the number of rows/columns of the terminal window (i.e. as	1253	=item $has_focus = $term->focus
580	specified by C<-geometry>, excluding any scrollback).
581		1254
		1255	=item $is_mapped = $term->mapped
		1256
		1257	=item $max_scrollback = $term->saveLines
		1258
		1259	=item $nrow_plus_saveLines = $term->total_rows
		1260
		1261	=item $topmost_scrollback_row = $term->top_row
		1262
		1263	Return various integers describing terminal characteristics.
		1264
		1265	=item $x_display = $term->display_id
		1266
		1267	Return the DISPLAY used by rxvt-unicode.
		1268
		1269	=item $lc_ctype = $term->locale
		1270
		1271	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1272
582	=item $nsaved = $term->nsaved	1273	=item $env = $term->env
583		1274
584	Returns the number of lines in the scrollback buffer.	1275	Returns a copy of the environment in effect for the terminal as a hashref
		1276	similar to C<\%ENV>.
		1277
		1278	=cut
		1279
		1280	sub env {
		1281	if (my $env = $_[0]->_env) {
		1282	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1283	} else {
		1284	+{ %ENV }
		1285	}
		1286	}
		1287
		1288	=item $modifiermask = $term->ModLevel3Mask
		1289
		1290	=item $modifiermask = $term->ModMetaMask
		1291
		1292	=item $modifiermask = $term->ModNumLockMask
		1293
		1294	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1295	AltGr), the meta key (often Alt) and the num lock key, if applicable.
585		1296
586	=item $view_start = $term->view_start ([$newvalue])	1297	=item $view_start = $term->view_start ([$newvalue])
587		1298
588	Returns the negative row number of the topmost line. Minimum value is	1299	Returns the row number of the topmost displayed line. Maximum value is
589	C<0>, which displays the normal terminal contents. Larger values scroll	1300	C<0>, which displays the normal terminal contents. Lower values scroll
590	this many lines into the scrollback buffer.	1301	this many lines into the scrollback buffer.
591		1302
592	=item $term->want_refresh	1303	=item $term->want_refresh
593		1304
594	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1305	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
652	about the logical line that row C<$row_number> is part of. It supports the	1363	about the logical line that row C<$row_number> is part of. It supports the
653	following methods:	1364	following methods:
654		1365
655	=over 4	1366	=over 4
656		1367
657	=item $text = $line->t	1368	=item $text = $line->t ([$new_text])
658		1369
659	Returns the full text of the line, similar to C<ROW_t>	1370	Returns or replaces the full text of the line, similar to C<ROW_t>
660		1371
661	=item $rend = $line->r	1372	=item $rend = $line->r ([$new_rend])
662		1373
663	Returns the full rendition array of the line, similar to C<ROW_r>	1374	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
664		1375
665	=item $length = $line->l	1376	=item $length = $line->l
666		1377
667	Returns the length of the line in cells, similar to C<ROW_l>.	1378	Returns the length of the line in cells, similar to C<ROW_l>.
668		1379
…		…
673	Return the row number of the first/last row of the line, respectively.	1384	Return the row number of the first/last row of the line, respectively.
674		1385
675	=item $offset = $line->offset_of ($row, $col)	1386	=item $offset = $line->offset_of ($row, $col)
676		1387
677	Returns the character offset of the given row|col pair within the logical	1388	Returns the character offset of the given row|col pair within the logical
678	line.	1389	line. Works for rows outside the line, too, and returns corresponding
		1390	offsets outside the string.
679		1391
680	=item ($row, $col) = $line->coord_of ($offset)	1392	=item ($row, $col) = $line->coord_of ($offset)
681		1393
682	Translates a string offset into terminal coordinates again.	1394	Translates a string offset into terminal coordinates again.
683		1395
684	=back	1396	=back
685		1397
686	=cut	1398	=cut
687		1399
688	sub urxvt::term::line {	1400	sub line {
689	my ($self, $row) = @_;	1401	my ($self, $row) = @_;
690		1402
691	my $maxrow = $self->nrow - 1;	1403	my $maxrow = $self->nrow - 1;
692		1404
693	my ($beg, $end) = ($row, $row);	1405	my ($beg, $end) = ($row, $row);
…		…
697		1409
698	bless {	1410	bless {
699	term => $self,	1411	term => $self,
700	beg => $beg,	1412	beg => $beg,
701	end => $end,	1413	end => $end,
		1414	ncol => $self->ncol,
702	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1415	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
703	}, urxvt::line::	1416	}, urxvt::line::
704	}	1417	}
705		1418
706	sub urxvt::line::t {	1419	sub urxvt::line::t {
707	my ($self) = @_;	1420	my ($self) = @_;
708		1421
		1422	if (@_ > 1)
		1423	{
		1424	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1425	for $self->{beg} .. $self->{end};
		1426	}
		1427
		1428	defined wantarray &&
709	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1429	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
710	0, $self->{len}	1430	0, $self->{len}
711	}	1431	}
712		1432
713	sub urxvt::line::r {	1433	sub urxvt::line::r {
714	my ($self) = @_;	1434	my ($self) = @_;
715		1435
		1436	if (@_ > 1)
		1437	{
		1438	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1439	for $self->{beg} .. $self->{end};
		1440	}
		1441
		1442	if (defined wantarray) {
716	my $rend = [	1443	my $rend = [
717	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1444	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
718	];	1445	];
719	$#$rend = $self->{len} - 1;	1446	$#$rend = $self->{len} - 1;
720	$rend	1447	return $rend;
		1448	}
		1449
		1450	()
721	}	1451	}
722		1452
723	sub urxvt::line::beg { $_[0]{beg} }	1453	sub urxvt::line::beg { $_[0]{beg} }
724	sub urxvt::line::end { $_[0]{end} }	1454	sub urxvt::line::end { $_[0]{end} }
725	sub urxvt::line::l { $_[0]{len} }	1455	sub urxvt::line::l { $_[0]{len} }
726		1456
727	sub urxvt::line::offset_of {	1457	sub urxvt::line::offset_of {
728	my ($self, $row, $col) = @_;	1458	my ($self, $row, $col) = @_;
729		1459
730	($row - $self->{beg}) * $self->{term}->ncol + $col	1460	($row - $self->{beg}) * $self->{ncol} + $col
731	}	1461	}
732		1462
733	sub urxvt::line::coord_of {	1463	sub urxvt::line::coord_of {
734	my ($self, $offset) = @_;	1464	my ($self, $offset) = @_;
735		1465
736	use integer;	1466	use integer;
737		1467
738	(	1468	(
739	$offset / $self->{term}->ncol + $self->{beg},	1469	$offset / $self->{ncol} + $self->{beg},
740	$offset % $self->{term}->ncol	1470	$offset % $self->{ncol}
741	)	1471	)
742	}	1472	}
743		1473
744	=item ($row, $col) = $line->coord_of ($offset)
745	=item $text = $term->special_encode $string	1474	=item $text = $term->special_encode $string
746		1475
747	Converts a perl string into the special encoding used by rxvt-unicode,	1476	Converts a perl string into the special encoding used by rxvt-unicode,
748	where one character corresponds to one screen cell. See	1477	where one character corresponds to one screen cell. See
749	C<< $term->ROW_t >> for details.	1478	C<< $term->ROW_t >> for details.
750		1479
751	=item $string = $term->special_decode $text	1480	=item $string = $term->special_decode $text
752		1481
753	Converts rxvt-unicodes text reprsentation into a perl string. See	1482	Converts rxvt-unicodes text reprsentation into a perl string. See
754	C<< $term->ROW_t >> for details.	1483	C<< $term->ROW_t >> for details.
		1484
		1485	=item $success = $term->grab_button ($button, $modifiermask)
		1486
		1487	Registers a synchronous button grab. See the XGrabButton manpage.
		1488
		1489	=item $success = $term->grab ($eventtime[, $sync])
		1490
		1491	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1492	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1493
		1494	=item $term->allow_events_async
		1495
		1496	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1497
		1498	=item $term->allow_events_sync
		1499
		1500	Calls XAllowEvents with SyncBoth for the most recent grab.
		1501
		1502	=item $term->allow_events_replay
		1503
		1504	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1505	recent grab.
		1506
		1507	=item $term->ungrab
		1508
		1509	Calls XUngrab for the most recent grab. Is called automatically on
		1510	evaluation errors, as it is better to lose the grab in the error case as
		1511	the session.
		1512
		1513	=back
		1514
		1515	=cut
		1516
		1517	package urxvt::popup;
		1518
		1519	=head2 The C<urxvt::popup> Class
		1520
		1521	=over 4
		1522
		1523	=cut
		1524
		1525	sub add_item {
		1526	my ($self, $item) = @_;
		1527
		1528	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1529	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1530	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1531
		1532	$item->{render} ||= sub { $_[0]{text} };
		1533
		1534	push @{ $self->{item} }, $item;
		1535	}
		1536
		1537	=item $popup->add_title ($title)
		1538
		1539	Adds a non-clickable title to the popup.
		1540
		1541	=cut
		1542
		1543	sub add_title {
		1544	my ($self, $title) = @_;
		1545
		1546	$self->add_item ({
		1547	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1548	text => $title,
		1549	activate => sub { },
		1550	});
		1551	}
		1552
		1553	=item $popup->add_separator ([$sepchr])
		1554
		1555	Creates a separator, optionally using the character given as C<$sepchr>.
		1556
		1557	=cut
		1558
		1559	sub add_separator {
		1560	my ($self, $sep) = @_;
		1561
		1562	$sep ||= "=";
		1563
		1564	$self->add_item ({
		1565	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1566	text => "",
		1567	render => sub { $sep x $self->{term}->ncol },
		1568	activate => sub { },
		1569	});
		1570	}
		1571
		1572	=item $popup->add_button ($text, $cb)
		1573
		1574	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1575	selected.
		1576
		1577	=cut
		1578
		1579	sub add_button {
		1580	my ($self, $text, $cb) = @_;
		1581
		1582	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1583	}
		1584
		1585	=item $popup->add_toggle ($text, $cb, $initial_value)
		1586
		1587	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1588	whenever it gets toggled, with a boolean indicating its value as its first
		1589	argument.
		1590
		1591	=cut
		1592
		1593	sub add_toggle {
		1594	my ($self, $text, $cb, $value) = @_;
		1595
		1596	my $item; $item = {
		1597	type => "button",
		1598	text => " $text",
		1599	value => $value,
		1600	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1601	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1602	};
		1603
		1604	$self->add_item ($item);
		1605	}
		1606
		1607	=item $popup->show
		1608
		1609	Displays the popup (which is initially hidden).
		1610
		1611	=cut
		1612
		1613	sub show {
		1614	my ($self) = @_;
		1615
		1616	local $urxvt::popup::self = $self;
		1617
		1618	my $env = $self->{term}->env;
		1619	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1620	delete $env->{LC_ALL};
		1621	$env->{LC_CTYPE} = $self->{term}->locale;
		1622
		1623	urxvt::term->new ($env, "popup",
		1624	"--perl-lib" => "", "--perl-ext-common" => "",
		1625	"-pty-fd" => -1, "-sl" => 0,
		1626	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
		1627	"--transient-for" => $self->{term}->parent,
		1628	"-display" => $self->{term}->display_id,
		1629	"-pe" => "urxvt-popup")
		1630	or die "unable to create popup window\n";
		1631	}
		1632
		1633	sub DESTROY {
		1634	my ($self) = @_;
		1635
		1636	delete $self->{term}{_destroy}{$self};
		1637	$self->{term}->ungrab;
		1638	}
755		1639
756	=back	1640	=back
757		1641
758	=head2 The C<urxvt::timer> Class	1642	=head2 The C<urxvt::timer> Class
759		1643
…		…
800		1684
801	=item $timer = $timer->start ($tstamp)	1685	=item $timer = $timer->start ($tstamp)
802		1686
803	Set the event trigger time to C<$tstamp> and start the timer.	1687	Set the event trigger time to C<$tstamp> and start the timer.
804		1688
		1689	=item $timer = $timer->after ($delay)
		1690
		1691	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		1692
805	=item $timer = $timer->stop	1693	=item $timer = $timer->stop
806		1694
807	Stop the timer.	1695	Stop the timer.
808		1696
809	=back	1697	=back
…		…
814		1702
815	$term->{socket} = ...	1703	$term->{socket} = ...
816	$term->{iow} = urxvt::iow	1704	$term->{iow} = urxvt::iow
817	->new	1705	->new
818	->fd (fileno $term->{socket})	1706	->fd (fileno $term->{socket})
819	->events (1) # wait for read data	1707	->events (urxvt::EVENT_READ)
820	->start	1708	->start
821	->cb (sub {	1709	->cb (sub {
822	my ($iow, $revents) = @_;	1710	my ($iow, $revents) = @_;
823	# $revents must be 1 here, no need to check	1711	# $revents must be 1 here, no need to check
824	sysread $term->{socket}, my $buf, 8192	1712	sysread $term->{socket}, my $buf, 8192
…		…
841		1729
842	Set the filedescriptor (not handle) to watch.	1730	Set the filedescriptor (not handle) to watch.
843		1731
844	=item $iow = $iow->events ($eventmask)	1732	=item $iow = $iow->events ($eventmask)
845		1733
846	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1734	Set the event mask to watch. The only allowed values are
847	data, Bit #1 (value C<2>) enables watching for write data.	1735	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1736	together, or C<urxvt::EVENT_NONE>.
848		1737
849	=item $iow = $iow->start	1738	=item $iow = $iow->start
850		1739
851	Start watching for requested events on the given handle.	1740	Start watching for requested events on the given handle.
852		1741
…		…
863	This variable controls the verbosity level of the perl extension. Higher	1752	This variable controls the verbosity level of the perl extension. Higher
864	numbers indicate more verbose output.	1753	numbers indicate more verbose output.
865		1754
866	=over 4	1755	=over 4
867		1756
868	=item =0 - only fatal messages	1757	=item == 0 - fatal messages
869		1758
870	=item =3 - script loading and management	1759	=item >= 3 - script loading and management
871		1760
872	=item =10 - all events received	1761	=item >=10 - all called hooks
		1762
		1763	=item >=11 - hook reutrn values
873		1764
874	=back	1765	=back
875		1766
876	=head1 AUTHOR	1767	=head1 AUTHOR
877		1768

Diff Legend

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