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

Diff Legend

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