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

Diff Legend

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