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.16 by root, Tue Jan 3 01:41:06 2006 UTC vs.
Revision 1.131 by root, Sun Jan 29 20:51:28 2006 UTC

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

Diff Legend

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