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

Diff Legend

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