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

Diff Legend

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