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

Diff Legend

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