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.64 by root, Mon Jan 9 06:29:47 2006 UTC vs.
Revision 1.197 by sf-tpope, Fri Aug 19 23:08:35 2011 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
32		33
		34	=head1 PREPACKAGED EXTENSIONS
		35
33	This section describes the extensiosn delivered with this version. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
44	Intelligent selection. This extension tries to be more intelligent when	51	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	52	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	53	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	54	arguments, which is very convenient, too, if your F<ls> supports
		55	C<--quoting-style=shell>.
48		56
49	It also offers the following bindable event:	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:
50		86
51	=over 4	87	=over 4
52		88
53	=item rot13	89	=item rot13
54		90
…		…
61	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
62		98
63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	100	runtime.
65		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
66	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
67		120
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	122	text into various other formats/action (such as uri unescaping, perl
		123	evaluation, web-browser starting etc.), depending on content.
70		124
71	=item digital-clock	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.
72		128
73	Displays a digital clock using the built-in overlay.	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<$_>.
74		134
75	=item mark-urls	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:
76		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
77	Uses per-line display filtering (C<on_line_update>) to underline urls.	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.
78		315
79	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
80		317
81	A not very useful example of filtering all text output to the terminal,	318	A not very useful example of filtering all text output to the terminal
82	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
83	similar-looking ascii character.	320	similar-looking ascii character.
		321
		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.
84		393
85	=item example-refresh-hooks	394	=item example-refresh-hooks
86		395
87	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
88	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	398	overlays or changes.
90		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
91	=back	405	=back
		406
		407	=head1 API DOCUMENTATION
92		408
93	=head2 General API Considerations	409	=head2 General API Considerations
94		410
95	All objects (such as terminals, time watchers etc.) are typical	411	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	412	reference-to-hash objects. The hash can be used to store anything you
…		…
108		424
109	=over 4	425	=over 4
110		426
111	=item $text	427	=item $text
112		428
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	429	Rxvt-unicode's special way of encoding text, where one "unicode" character
114	always represents one screen cell. See L<row_t> for a discussion of this format.	430	always represents one screen cell. See L<ROW_t> for a discussion of this format.
115		431
116	=item $string	432	=item $string
117		433
118	A perl text string, with an emphasis on I<text>. It can store all unicode	434	A perl text string, with an emphasis on I<text>. It can store all unicode
119	characters and is to be distinguished with text encoded in a specific	435	characters and is to be distinguished with text encoded in a specific
…		…
124	Either binary data or - more common - a text string encoded in a	440	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	441	locale-specific way.
126		442
127	=back	443	=back
128		444
		445	=head2 Extension Objects
		446
		447	Every perl extension is a perl class. A separate perl object is created
		448	for each terminal, and each terminal has its own set of extension objects,
		449	which are passed as the first parameter to hooks. So extensions can use
		450	their C<$self> object without having to think about clashes with other
		451	extensions or other terminals, with the exception of methods and members
		452	that begin with an underscore character C<_>: these are reserved for
		453	internal use.
		454
		455	Although it isn't a C<urxvt::term> object, you can call all methods of the
		456	C<urxvt::term> class on this object.
		457
		458	It has the following methods and data members:
		459
		460	=over 4
		461
		462	=item $urxvt_term = $self->{term}
		463
		464	Returns the C<urxvt::term> object associated with this instance of the
		465	extension. This member I<must not> be changed in any way.
		466
		467	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		468
		469	Dynamically enable the given hooks (named without the C<on_> prefix) for
		470	this extension, replacing any previous hook. This is useful when you want
		471	to overwrite time-critical hooks only temporarily.
		472
		473	=item $self->disable ($hook_name[, $hook_name..])
		474
		475	Dynamically disable the given hooks.
		476
		477	=back
		478
129	=head2 Hooks	479	=head2 Hooks
130		480
131	The following subroutines can be declared in extension files, and will be	481	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	482	called whenever the relevant event happens.
133		483
134	The first argument passed to them is an object private to each terminal	484	The first argument passed to them is an extension object as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	485	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		486
141	All of them must return a boolean value. If it is true, then the event	487	B<All> of these hooks must return a boolean value. If any of the called
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	488	hooks returns true, then the event counts as being I<consumed>, and the
143	and the relevant action might not be carried out by the C++ code.	489	relevant action might not be carried out by the C++ code.
144		490
145	When in doubt, return a false value (preferably C<()>).	491	I<< When in doubt, return a false value (preferably C<()>). >>
146		492
147	=over 4	493	=over 4
148		494
149	=item on_init $term	495	=item on_init $term
150		496
151	Called after a new terminal object has been initialized, but before	497	Called after a new terminal object has been initialized, but before
152	windows are created or the command gets run. Most methods are unsafe to	498	windows are created or the command gets run. Most methods are unsafe to
153	call or deliver senseless data, as terminal size and other characteristics	499	call or deliver senseless data, as terminal size and other characteristics
154	have not yet been determined. You can safely query and change resources,	500	have not yet been determined. You can safely query and change resources
155	though.	501	and options, though. For many purposes the C<on_start> hook is a better
		502	place.
		503
		504	=item on_start $term
		505
		506	Called at the very end of initialisation of a new terminal, just before
		507	trying to map (display) the toplevel and returning to the main loop.
		508
		509	=item on_destroy $term
		510
		511	Called whenever something tries to destroy terminal, when the terminal is
		512	still fully functional (not for long, though).
156		513
157	=item on_reset $term	514	=item on_reset $term
158		515
159	Called after the screen is "reset" for any reason, such as resizing or	516	Called after the screen is "reset" for any reason, such as resizing or
160	control sequences. Here is where you can react on changes to size-related	517	control sequences. Here is where you can react on changes to size-related
161	variables.	518	variables.
162		519
163	=item on_start $term	520	=item on_child_start $term, $pid
164		521
165	Called at the very end of initialisation of a new terminal, just before	522	Called just after the child process has been C<fork>ed.
166	returning to the mainloop.	523
		524	=item on_child_exit $term, $status
		525
		526	Called just after the child process has exited. C<$status> is the status
		527	from C<waitpid>.
167		528
168	=item on_sel_make $term, $eventtime	529	=item on_sel_make $term, $eventtime
169		530
170	Called whenever a selection has been made by the user, but before the	531	Called whenever a selection has been made by the user, but before the
171	selection text is copied, so changes to the beginning, end or type of the	532	selection text is copied, so changes to the beginning, end or type of the
…		…
178		539
179	Called whenever a selection has been copied, but before the selection is	540	Called whenever a selection has been copied, but before the selection is
180	requested from the server. The selection text can be queried and changed	541	requested from the server. The selection text can be queried and changed
181	by calling C<< $term->selection >>.	542	by calling C<< $term->selection >>.
182		543
183	Returning a true value aborts selection grabbing. It will still be hilighted.	544	Returning a true value aborts selection grabbing. It will still be highlighted.
184		545
185	=item on_sel_extend $term	546	=item on_sel_extend $term
186		547
187	Called whenever the user tries to extend the selection (e.g. with a double	548	Called whenever the user tries to extend the selection (e.g. with a double
188	click) and is either supposed to return false (normal operation), or	549	click) and is either supposed to return false (normal operation), or
189	should extend the selection itelf and return true to suppress the built-in	550	should extend the selection itself and return true to suppress the built-in
190	processing.	551	processing. This can happen multiple times, as long as the callback
		552	returns true, it will be called on every further click by the user and is
		553	supposed to enlarge the selection more and more, if possible.
191		554
192	See the F<selection> example extension.	555	See the F<selection> example extension.
193		556
194	=item on_view_change $term, $offset	557	=item on_view_change $term, $offset
195		558
196	Called whenever the view offset changes, i..e the user or program	559	Called whenever the view offset changes, i.e. the user or program
197	scrolls. Offset C<0> means display the normal terminal, positive values	560	scrolls. Offset C<0> means display the normal terminal, positive values
198	show this many lines of scrollback.	561	show this many lines of scrollback.
199		562
200	=item on_scroll_back $term, $lines, $saved	563	=item on_scroll_back $term, $lines, $saved
201		564
…		…
205		568
206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	569	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
207	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	570	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
208	number of lines that will be in the scrollback buffer.	571	number of lines that will be in the scrollback buffer.
209		572
210	=item on_osc_seq $term, $string	573	=item on_osc_seq $term, $op, $args, $resp
		574
		575	Called on every OSC sequence and can be used to suppress it or modify its
		576	behaviour. The default should be to return an empty list. A true value
		577	suppresses execution of the request completely. Make sure you don't get
		578	confused by recursive invocations when you output an OSC sequence within
		579	this callback.
		580
		581	C<on_osc_seq_perl> should be used for new behaviour.
		582
		583	=item on_osc_seq_perl $term, $args, $resp
211		584
212	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	585	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
213	operating system command) is processed. Cursor position and other state	586	operating system command) is processed. Cursor position and other state
214	information is up-to-date when this happens. For interoperability, the	587	information is up-to-date when this happens. For interoperability, the
215	string should start with the extension name and a colon, to distinguish	588	string should start with the extension name (sans -osc) and a semicolon,
216	it from commands for other extensions, and this might be enforced in the	589	to distinguish it from commands for other extensions, and this might be
217	future.	590	enforced in the future.
		591
		592	For example, C<overlay-osc> uses this:
		593
		594	sub on_osc_seq_perl {
		595	my ($self, $osc, $resp) = @_;
		596
		597	return unless $osc =~ s/^overlay;//;
		598
		599	... process remaining $osc string
		600	}
218		601
219	Be careful not ever to trust (in a security sense) the data you receive,	602	Be careful not ever to trust (in a security sense) the data you receive,
220	as its source can not easily be controleld (e-mail content, messages from	603	as its source can not easily be controlled (e-mail content, messages from
221	other users on the same system etc.).	604	other users on the same system etc.).
		605
		606	For responses, C<$resp> contains the end-of-args separator used by the
		607	sender.
222		608
223	=item on_add_lines $term, $string	609	=item on_add_lines $term, $string
224		610
225	Called whenever text is about to be output, with the text as argument. You	611	Called whenever text is about to be output, with the text as argument. You
226	can filter/change and output the text yourself by returning a true value	612	can filter/change and output the text yourself by returning a true value
227	and calling C<< $term->scr_add_lines >> yourself. Please note that this	613	and calling C<< $term->scr_add_lines >> yourself. Please note that this
228	might be very slow, however, as your hook is called for B<all> text being	614	might be very slow, however, as your hook is called for B<all> text being
229	output.	615	output.
230		616
		617	=item on_tt_write $term, $octets
		618
		619	Called whenever some data is written to the tty/pty and can be used to
		620	suppress or filter tty input.
		621
		622	=item on_tt_paste $term, $octets
		623
		624	Called whenever text is about to be pasted, with the text as argument. You
		625	can filter/change and paste the text yourself by returning a true value
		626	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		627	locale-encoded.
		628
231	=item on_line_update $term, $row	629	=item on_line_update $term, $row
232		630
233	Called whenever a line was updated or changed. Can be used to filter	631	Called whenever a line was updated or changed. Can be used to filter
234	screen output (e.g. underline urls or other useless stuff). Only lines	632	screen output (e.g. underline urls or other useless stuff). Only lines
235	that are being shown will be filtered, and, due to performance reasons,	633	that are being shown will be filtered, and, due to performance reasons,
…		…
242	later with the already-modified line (e.g. if unrelated parts change), so	640	later with the already-modified line (e.g. if unrelated parts change), so
243	you cannot just toggle rendition bits, but only set them.	641	you cannot just toggle rendition bits, but only set them.
244		642
245	=item on_refresh_begin $term	643	=item on_refresh_begin $term
246		644
247	Called just before the screen gets redrawn. Can be used for overlay	645	Called just before the screen gets redrawn. Can be used for overlay or
248	or similar effects by modify terminal contents in refresh_begin, and	646	similar effects by modifying the terminal contents in refresh_begin, and
249	restoring them in refresh_end. The built-in overlay and selection display	647	restoring them in refresh_end. The built-in overlay and selection display
250	code is run after this hook, and takes precedence.	648	code is run after this hook, and takes precedence.
251		649
252	=item on_refresh_end $term	650	=item on_refresh_end $term
253		651
254	Called just after the screen gets redrawn. See C<on_refresh_begin>.	652	Called just after the screen gets redrawn. See C<on_refresh_begin>.
255		653
256	=item on_keyboard_command $term, $string	654	=item on_user_command $term, $string
257		655
258	Called whenever the user presses a key combination that has a	656	Called whenever a user-configured event is being activated (e.g. via
259	C<perl:string> action bound to it (see description of the B<keysym>	657	a C<perl:string> action bound to a key, see description of the B<keysym>
260	resource in the @@RXVT_NAME@@(1) manpage).	658	resource in the @@RXVT_NAME@@(1) manpage).
		659
		660	The event is simply the action string. This interface is assumed to change
		661	slightly in the future.
		662
		663	=item on_resize_all_windows $term, $new_width, $new_height
		664
		665	Called just after the new window size has been calculated, but before
		666	windows are actually being resized or hints are being set. If this hook
		667	returns TRUE, setting of the window hints is being skipped.
		668
		669	=item on_x_event $term, $event
		670
		671	Called on every X event received on the vt window (and possibly other
		672	windows). Should only be used as a last resort. Most event structure
		673	members are not passed.
		674
		675	=item on_root_event $term, $event
		676
		677	Like C<on_x_event>, but is called for events on the root window.
261		678
262	=item on_focus_in $term	679	=item on_focus_in $term
263		680
264	Called whenever the window gets the keyboard focus, before rxvt-unicode	681	Called whenever the window gets the keyboard focus, before rxvt-unicode
265	does focus in processing.	682	does focus in processing.
266		683
267	=item on_focus_out $term	684	=item on_focus_out $term
268		685
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	686	Called whenever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	687	focus out processing.
271		688
		689	=item on_configure_notify $term, $event
		690
		691	=item on_property_notify $term, $event
		692
272	=item on_key_press $term, $event, $octets	693	=item on_key_press $term, $event, $keysym, $octets
273		694
274	=item on_key_release $term, $event	695	=item on_key_release $term, $event, $keysym
275		696
276	=item on_button_press $term, $event	697	=item on_button_press $term, $event
277		698
278	=item on_button_release $term, $event	699	=item on_button_release $term, $event
279		700
…		…
281		702
282	=item on_map_notify $term, $event	703	=item on_map_notify $term, $event
283		704
284	=item on_unmap_notify $term, $event	705	=item on_unmap_notify $term, $event
285		706
286	Called whenever the corresponding X event is received for the terminal If	707	Called whenever the corresponding X event is received for the terminal. If
287	the hook returns true, then the even will be ignored by rxvt-unicode.	708	the hook returns true, then the event will be ignored by rxvt-unicode.
288		709
289	The event is a hash with most values as named by Xlib (see the XEvent	710	The event is a hash with most values as named by Xlib (see the XEvent
290	manpage), with the additional members C<row> and C<col>, which are the row	711	manpage), with the additional members C<row> and C<col>, which are the
291	and column under the mouse cursor.	712	(real, not screen-based) row and column under the mouse cursor.
292		713
293	C<on_key_press> additionally receives the string rxvt-unicode would	714	C<on_key_press> additionally receives the string rxvt-unicode would
294	output, if any, in locale-specific encoding.	715	output, if any, in locale-specific encoding.
295		716
296	subwindow.	717	subwindow.
297		718
		719	=item on_client_message $term, $event
		720
		721	=item on_wm_protocols $term, $event
		722
		723	=item on_wm_delete_window $term, $event
		724
		725	Called when various types of ClientMessage events are received (all with
		726	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		727
		728	=item on_bell $term
		729
		730	Called on receipt of a bell character.
		731
298	=back	732	=back
299		733
		734	=cut
		735
		736	package urxvt;
		737
		738	use utf8;
		739	use strict;
		740	use Carp ();
		741	use Scalar::Util ();
		742	use List::Util ();
		743
		744	our $VERSION = 1;
		745	our $TERM;
		746	our @TERM_INIT;
		747	our @TERM_EXT;
		748	our @HOOKNAME;
		749	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		750	our %OPTION;
		751
		752	our $LIBDIR;
		753	our $RESNAME;
		754	our $RESCLASS;
		755	our $RXVTNAME;
		756
		757	our $NOCHAR = chr 0xffff;
		758
300	=head2 Variables in the C<urxvt> Package	759	=head2 Variables in the C<urxvt> Package
301		760
302	=over 4	761	=over 4
		762
		763	=item $urxvt::LIBDIR
		764
		765	The rxvt-unicode library directory, where, among other things, the perl
		766	modules and scripts are stored.
		767
		768	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		769
		770	The resource class and name rxvt-unicode uses to look up X resources.
		771
		772	=item $urxvt::RXVTNAME
		773
		774	The basename of the installed binaries, usually C<urxvt>.
303		775
304	=item $urxvt::TERM	776	=item $urxvt::TERM
305		777
306	The current terminal. This variable stores the current C<urxvt::term>	778	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	779	object, whenever a callback/hook is executing.
308		780
		781	=item @urxvt::TERM_INIT
		782
		783	All code references in this array will be called as methods of the next newly
		784	created C<urxvt::term> object (during the C<on_init> phase). The array
		785	gets cleared before the code references that were in it are being executed,
		786	so references can push themselves onto it again if they so desire.
		787
		788	This complements to the perl-eval command line option, but gets executed
		789	first.
		790
		791	=item @urxvt::TERM_EXT
		792
		793	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		794	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		795	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		796
309	=back	797	=back
310		798
311	=head2 Functions in the C<urxvt> Package	799	=head2 Functions in the C<urxvt> Package
312		800
313	=over 4	801	=over 4
314		802
315	=item $term = new urxvt [arg...]
316
317	Creates a new terminal, very similar as if you had started it with
318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319	if the new instance couldn't be created. Returns C<undef> if the new
320	instance didn't initialise perl, and the terminal object otherwise. The
321	C<init> and C<start> hooks will be called during the call.
322
323	=item urxvt::fatal $errormessage	803	=item urxvt::fatal $errormessage
324		804
325	Fatally aborts execution with the given error message. Avoid at all	805	Fatally aborts execution with the given error message (which should
326	costs! The only time this is acceptable is when the terminal process	806	include a trailing newline). Avoid at all costs! The only time this
327	starts up.	807	is acceptable (and useful) is in the init hook, where it prevents the
		808	terminal from starting up.
328		809
329	=item urxvt::warn $string	810	=item urxvt::warn $string
330		811
331	Calls C<rxvt_warn> with the given string which should not include a	812	Calls C<rxvt_warn> with the given string which should include a trailing
332	newline. The module also overwrites the C<warn> builtin with a function	813	newline. The module also overwrites the C<warn> builtin with a function
333	that calls this function.	814	that calls this function.
334		815
335	Using this function has the advantage that its output ends up in the	816	Using this function has the advantage that its output ends up in the
336	correct place, e.g. on stderr of the connecting urxvtc client.	817	correct place, e.g. on stderr of the connecting urxvtc client.
337		818
338	=item $is_safe = urxvt::safe	819	Messages have a size limit of 1023 bytes currently.
339		820
340	Returns true when it is safe to do potentially unsafe things, such as	821	=item @terms = urxvt::termlist
341	evaluating perl code specified by the user. This is true when urxvt was	822
342	started setuid or setgid.	823	Returns all urxvt::term objects that exist in this process, regardless of
		824	whether they are started, being destroyed etc., so be careful. Only term
		825	objects that have perl extensions attached will be returned (because there
		826	is no urxvt::term object associated with others).
343		827
344	=item $time = urxvt::NOW	828	=item $time = urxvt::NOW
345		829
346	Returns the "current time" (as per the event loop).	830	Returns the "current time" (as per the event loop).
347		831
348	=item urxvt::CurrentTime	832	=item urxvt::CurrentTime
349		833
350	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	834	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
351	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	835	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
352	Button4Mask, Button5Mask, AnyModifier	836	Button4Mask, Button5Mask, AnyModifier
		837
		838	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		839	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		840	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		841	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		842	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		843	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		844	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		845
		846	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		847	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		848	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		849	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		850	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		851	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		852	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
353		853
354	Various constants for use in X calls and event processing.	854	Various constants for use in X calls and event processing.
355		855
356	=back	856	=back
357		857
…		…
374		874
375	=item $rend = urxvt::OVERLAY_RSTYLE	875	=item $rend = urxvt::OVERLAY_RSTYLE
376		876
377	Return the rendition mask used for overlays by default.	877	Return the rendition mask used for overlays by default.
378		878
379	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	879	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		880	urxvt::RS_RVid, urxvt::RS_Uline
380		881
381	Return the bit that enabled bold, italic, blink, reverse-video and	882	Return the bit that enabled bold, italic, blink, reverse-video and
382	underline, respectively. To enable such a style, just logically OR it into	883	underline, respectively. To enable such a style, just logically OR it into
383	the bitset.	884	the bitset.
384		885
…		…
386		887
387	=item $background = urxvt::GET_BASEBG $rend	888	=item $background = urxvt::GET_BASEBG $rend
388		889
389	Return the foreground/background colour index, respectively.	890	Return the foreground/background colour index, respectively.
390		891
391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	892	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
392		893
393	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	894	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		895
		896	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
394		897
395	Replace the foreground/background colour in the rendition mask with the	898	Replace the foreground/background colour in the rendition mask with the
396	specified one.	899	specified one.
397		900
398	=item $value = urxvt::GET_CUSTOM ($rend)	901	=item $value = urxvt::GET_CUSTOM $rend
399		902
400	Return the "custom" value: Every rendition has 5 bits for use by	903	Return the "custom" value: Every rendition has 5 bits for use by
401	extensions. They can be set and changed as you like and are initially	904	extensions. They can be set and changed as you like and are initially
402	zero.	905	zero.
403		906
404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	907	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
405		908
406	Change the custom value.	909	Change the custom value.
407		910
408	=back	911	=back
409		912
410	=cut	913	=cut
411		914
412	package urxvt;
413
414	use utf8;
415	use strict;
416	use Scalar::Util ();
417	use List::Util ();
418
419	our $VERSION = 1;
420	our $TERM;
421	our @HOOKNAME;
422	our %OPTION;
423	our $LIBDIR;
424
425	BEGIN {	915	BEGIN {
426	urxvt->bootstrap;
427
428	# overwrite perl's warn	916	# overwrite perl's warn
429	*CORE::GLOBAL::warn = sub {	917	*CORE::GLOBAL::warn = sub {
430	my $msg = join "", @_;	918	my $msg = join "", @_;
431	$msg .= "\n"	919	$msg .= "\n"
432	unless $msg =~ /\n$/;	920	unless $msg =~ /\n$/;
433	urxvt::warn ($msg);	921	urxvt::warn ($msg);
434	};	922	};
435
436	delete $ENV{IFS};
437	delete $ENV{CDPATH};
438	delete $ENV{BASH_ENV};
439	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
440	}	923	}
441		924
442	my @hook_count;	925	no warnings 'utf8';
		926
443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	927	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
444		928
445	sub verbose {	929	sub verbose {
446	my ($level, $msg) = @_;	930	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	931	warn "$msg\n" if $level <= $verbosity;
448	}	932	}
449		933
450	# find on_xxx subs in the package and register them
451	# as hooks
452	sub register_package($) {
453	my ($pkg) = @_;
454
455	for my $htype (0.. $#HOOKNAME) {
456	my $name = $HOOKNAME[$htype];
457
458	my $ref = $pkg->can ("on_" . lc $name)
459	or next;
460
461	$TERM->{_hook}[$htype]{$pkg} = $ref;
462	$hook_count[$htype]++
463	or set_should_invoke $htype, 1;
464	}
465	}
466
467	my $extension_pkg = "extension0000";
468	my %extension_pkg;	934	my %extension_pkg;
469		935
470	# load a single script into its own package, once only	936	# load a single script into its own package, once only
471	sub extension_package($) {	937	sub extension_package($) {
472	my ($path) = @_;	938	my ($path) = @_;
473		939
474	$extension_pkg{$path} ||= do {	940	$extension_pkg{$path} ||= do {
475	my $pkg = "urxvt::" . ($extension_pkg++);	941	$path =~ /([^\/\\]+)$/;
		942	my $pkg = $1;
		943	$pkg =~ s/[^[:word:]]/_/g;
		944	$pkg = "urxvt::ext::$pkg";
476		945
477	verbose 3, "loading extension '$path' into package '$pkg'";	946	verbose 3, "loading extension '$path' into package '$pkg'";
478		947
479	open my $fh, "<:raw", $path	948	open my $fh, "<:raw", $path
480	or die "$path: $!";	949	or die "$path: $!";
481		950
482	my $source = untaint "package $pkg; use strict; use utf8;\n"	951	my $source =
483	. "use base urxvt::term::proxy::;\n"	952	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
484	. "#line 1 \"$path\"\n{\n"	953	. "#line 1 \"$path\"\n{\n"
485	. (do { local $/; <$fh> })	954	. (do { local $/; <$fh> })
486	. "\n};\n1";	955	. "\n};\n1";
487		956
		957	eval $source
488	eval $source or die "$path: $@";	958	or die "$path: $@";
489		959
490	$pkg	960	$pkg
491	}	961	}
492	}	962	}
493		963
…		…
498	local $TERM = shift;	968	local $TERM = shift;
499	my $htype = shift;	969	my $htype = shift;
500		970
501	if ($htype == 0) { # INIT	971	if ($htype == 0) { # INIT
502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	972	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		973
		974	my %ext_arg;
		975
503		976	{
504	my %want_ext;	977	my @init = @TERM_INIT;
		978	@TERM_INIT = ();
		979	$_->($TERM) for @init;
		980	my @pkg = @TERM_EXT;
		981	@TERM_EXT = ();
		982	$TERM->register_package ($_) for @pkg;
		983	}
505		984
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	985	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507	if ($_ eq "default") {	986	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	987	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
509	} elsif (/^-(.*)$/) {	988	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	989	delete $ext_arg{$1};
		990	} elsif (/^([^<]+)<(.*)>$/) {
		991	push @{ $ext_arg{$1} }, $2;
511	} else {	992	} else {
512	$want_ext{$_}++;	993	$ext_arg{$_} ||= [];
513	}	994	}
514	}	995	}
515		996
516	for my $ext (keys %want_ext) {	997	for my $ext (sort keys %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	998	my @files = grep -f $_, map "$_/$ext", @dirs;
518		999
519	if (@files) {	1000	if (@files) {
520	register_package extension_package $files[0];	1001	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
521	} else {	1002	} else {
522	warn "perl extension '$ext' not found in perl library search path\n";	1003	warn "perl extension '$ext' not found in perl library search path\n";
523	}	1004	}
524	}	1005	}
525		1006
…		…
531		1012
532	if (my $cb = $TERM->{_hook}[$htype]) {	1013	if (my $cb = $TERM->{_hook}[$htype]) {
533	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1014	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
534	if $verbosity >= 10;	1015	if $verbosity >= 10;
535		1016
536	keys %$cb;	1017	for my $pkg (keys %$cb) {
		1018	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
		1019	$retval ||= $retval_;
537		1020
538	while (my ($pkg, $cb) = each %$cb) {
539	eval {
540	$retval = $cb->(
541	$TERM->{_pkg}{$pkg} ||= do {
542	my $proxy = bless { }, $pkg;
543	Scalar::Util::weaken ($proxy->{term} = $TERM);
544	$proxy
545	},
546	@_,
547	) and last;
548	};
549	if ($@) {	1021	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	1022	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	1023	warn $@;
552	}	1024	}
553	}	1025	}
		1026
		1027	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		1028	if $verbosity >= 11;
554	}	1029	}
555		1030
556	if ($htype == 1) { # DESTROY	1031	if ($htype == 1) { # DESTROY
557	# remove hooks if unused
558	if (my $hook = $TERM->{_hook}) {
559	for my $htype (0..$#$hook) {
560	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
561	or set_should_invoke $htype, 0;
562	}
563	}
564
565	# clear package objects	1032	# clear package objects
566	%$_ = () for values %{ $TERM->{_pkg} };	1033	%$_ = () for values %{ $TERM->{_pkg} };
567		1034
568	# clear package	1035	# clear package
569	%$TERM = ();	1036	%$TERM = ();
570	}	1037	}
571		1038
572	$retval	1039	$retval
573	}	1040	}
574		1041
575	# urxvt::term::proxy	1042	sub SET_COLOR($$$) {
		1043	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1044	}
576		1045
577	sub urxvt::term::proxy::AUTOLOAD {	1046	sub rend2mask {
578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	1047	no strict 'refs';
		1048	my ($str, $mask) = (@_, 0);
		1049	my %color = ( fg => undef, bg => undef );
		1050	my @failed;
		1051	for my $spec ( split /\s+/, $str ) {
		1052	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1053	$color{lc($1)} = $2;
		1054	} else {
		1055	my $neg = $spec =~ s/^[-^]//;
		1056	unless ( exists &{"RS_$spec"} ) {
		1057	push @failed, $spec;
		1058	next;
		1059	}
		1060	my $cur = &{"RS_$spec"};
		1061	if ( $neg ) {
		1062	$mask &= ~$cur;
		1063	} else {
		1064	$mask |= $cur;
		1065	}
		1066	}
		1067	}
		1068	($mask, @color{qw(fg bg)}, \@failed)
		1069	}
		1070
		1071	# urxvt::term::extension
		1072
		1073	package urxvt::term::extension;
		1074
		1075	sub enable {
		1076	my ($self, %hook) = @_;
		1077	my $pkg = $self->{_pkg};
		1078
		1079	while (my ($name, $cb) = each %hook) {
		1080	my $htype = $HOOKTYPE{uc $name};
		1081	defined $htype
		1082	or Carp::croak "unsupported hook type '$name'";
		1083
		1084	$self->set_should_invoke ($htype, +1)
		1085	unless exists $self->{term}{_hook}[$htype]{$pkg};
		1086
		1087	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		1088	}
		1089	}
		1090
		1091	sub disable {
		1092	my ($self, @hook) = @_;
		1093	my $pkg = $self->{_pkg};
		1094
		1095	for my $name (@hook) {
		1096	my $htype = $HOOKTYPE{uc $name};
		1097	defined $htype
		1098	or Carp::croak "unsupported hook type '$name'";
		1099
		1100	$self->set_should_invoke ($htype, -1)
		1101	if delete $self->{term}{_hook}[$htype]{$pkg};
		1102	}
		1103	}
		1104
		1105	our $AUTOLOAD;
		1106
		1107	sub AUTOLOAD {
		1108	$AUTOLOAD =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	1109	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		1110
581	eval qq{	1111	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	1112	sub $AUTOLOAD {
583	my \$proxy = shift;	1113	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	1114	\$proxy->{term}->$1 (\@_)
585	}	1115	}
586	1	1116	1
587	} or die "FATAL: unable to compile method forwarder: $@";	1117	} or die "FATAL: unable to compile method forwarder: $@";
588		1118
589	goto &$urxvt::term::proxy::AUTOLOAD;	1119	goto &$AUTOLOAD;
590	}	1120	}
591		1121
592	sub urxvt::term::proxy::DESTROY {	1122	sub DESTROY {
593	# nop	1123	# nop
594	}	1124	}
595		1125
596	# urxvt::destroy_hook	1126	# urxvt::destroy_hook
597		1127
…		…
607		1137
608	=head2 The C<urxvt::anyevent> Class	1138	=head2 The C<urxvt::anyevent> Class
609		1139
610	The sole purpose of this class is to deliver an interface to the	1140	The sole purpose of this class is to deliver an interface to the
611	C<AnyEvent> module - any module using it will work inside urxvt without	1141	C<AnyEvent> module - any module using it will work inside urxvt without
612	further work. The only exception is that you cannot wait on condition	1142	further programming. The only exception is that you cannot wait on
613	variables, but non-blocking condvar use is ok. What this means is that you	1143	condition variables, but non-blocking condvar use is ok. What this means
614	cannot use blocking APIs, but the non-blocking variant should work.	1144	is that you cannot use blocking APIs, but the non-blocking variant should
		1145	work.
615		1146
616	=cut	1147	=cut
617		1148
618	our $VERSION = 1;	1149	our $VERSION = '5.23';
619		1150
620	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1151	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
621	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1152	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
622		1153
623	sub timer {	1154	sub timer {
…		…
625		1156
626	my $cb = $arg{cb};	1157	my $cb = $arg{cb};
627		1158
628	urxvt::timer	1159	urxvt::timer
629	->new	1160	->new
630	->start (urxvt::NOW + $arg{after})	1161	->after ($arg{after}, $arg{interval})
631	->cb (sub {	1162	->cb ($arg{interval} ? $cb : sub {
632	$_[0]->stop; # need to cancel manually	1163	$_[0]->stop; # need to cancel manually
633	$cb->();	1164	$cb->();
634	})	1165	})
635	}	1166	}
636		1167
637	sub io {	1168	sub io {
638	my ($class, %arg) = @_;	1169	my ($class, %arg) = @_;
639		1170
640	my $cb = $arg{cb};	1171	my $cb = $arg{cb};
		1172	my $fd = fileno $arg{fh};
		1173	defined $fd or $fd = $arg{fh};
641		1174
642	bless [$arg{fh}, urxvt::iow	1175	bless [$arg{fh}, urxvt::iow
643	->new	1176	->new
644	->fd (fileno $arg{fh})	1177	->fd ($fd)
645	->events (($arg{poll} =~ /r/ ? 1 : 0)	1178	->events (($arg{poll} =~ /r/ ? 1 : 0)
646	| ($arg{poll} =~ /w/ ? 2 : 0))	1179	| ($arg{poll} =~ /w/ ? 2 : 0))
647	->start	1180	->start
648	->cb (sub {	1181	->cb ($cb)
649	$cb->(($_[1] & 1 ? 'r' : '')
650	. ($_[1] & 2 ? 'w' : ''));
651	})],
652	urxvt::anyevent::	1182	], urxvt::anyevent::
		1183	}
		1184
		1185	sub idle {
		1186	my ($class, %arg) = @_;
		1187
		1188	my $cb = $arg{cb};
		1189
		1190	urxvt::iw
		1191	->new
		1192	->start
		1193	->cb ($cb)
		1194	}
		1195
		1196	sub child {
		1197	my ($class, %arg) = @_;
		1198
		1199	my $cb = $arg{cb};
		1200
		1201	urxvt::pw
		1202	->new
		1203	->start ($arg{pid})
		1204	->cb (sub {
		1205	$_[0]->stop; # need to cancel manually
		1206	$cb->($_[0]->rpid, $_[0]->rstatus);
		1207	})
653	}	1208	}
654		1209
655	sub DESTROY {	1210	sub DESTROY {
656	$_[0][1]->stop;	1211	$_[0][1]->stop;
657	}	1212	}
658		1213
659	sub condvar {	1214	sub one_event {
660	bless \my $flag, urxvt::anyevent::condvar::
661	}
662
663	sub urxvt::anyevent::condvar::broadcast {
664	${$_[0]}++;
665	}
666
667	sub urxvt::anyevent::condvar::wait {
668	unless (${$_[0]}) {
669	require Carp;
670	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	1215	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
		1216	}
		1217
		1218	package urxvt::term;
		1219
		1220	=head2 The C<urxvt::term> Class
		1221
		1222	=over 4
		1223
		1224	=cut
		1225
		1226	# find on_xxx subs in the package and register them
		1227	# as hooks
		1228	sub register_package {
		1229	my ($self, $pkg, $argv) = @_;
		1230
		1231	no strict 'refs';
		1232
		1233	urxvt::verbose 6, "register package $pkg to $self";
		1234
		1235	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1236
		1237	my $proxy = bless {
		1238	_pkg => $pkg,
		1239	argv => $argv,
		1240	}, $pkg;
		1241	Scalar::Util::weaken ($proxy->{term} = $self);
		1242
		1243	$self->{_pkg}{$pkg} = $proxy;
		1244
		1245	for my $name (@HOOKNAME) {
		1246	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1247	$proxy->enable ($name => $ref);
		1248	}
671	}	1249	}
672	}	1250	}
673		1251
674	package urxvt::term;	1252	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
675		1253
676	=head2 The C<urxvt::term> Class	1254	Creates a new terminal, very similar as if you had started it with system
		1255	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1256	hash which defines the environment of the new terminal.
677		1257
678	=over 4	1258	Croaks (and probably outputs an error message) if the new instance
		1259	couldn't be created. Returns C<undef> if the new instance didn't
		1260	initialise perl, and the terminal object otherwise. The C<init> and
		1261	C<start> hooks will be called before this call returns, and are free to
		1262	refer to global data (which is race free).
		1263
		1264	=cut
		1265
		1266	sub new {
		1267	my ($class, $env, @args) = @_;
		1268
		1269	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1270	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1271
		1272	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1273	}
679		1274
680	=item $term->destroy	1275	=item $term->destroy
681		1276
682	Destroy the terminal object (close the window, free resources etc.).	1277	Destroy the terminal object (close the window, free resources
		1278	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1279	watchers (timers, io watchers) are still active.
		1280
		1281	=item $term->exec_async ($cmd[, @args])
		1282
		1283	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1284	("starts") programs in the background. This function takes care of setting
		1285	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1286	be preferred over explicit calls to C<exec> or C<system>.
		1287
		1288	Returns the pid of the subprocess or C<undef> on error.
		1289
		1290	=cut
		1291
		1292	sub exec_async {
		1293	my $self = shift;
		1294
		1295	my $pid = fork;
		1296
		1297	return $pid
		1298	if !defined $pid or $pid;
		1299
		1300	%ENV = %{ $self->env };
		1301
		1302	exec @_;
		1303	urxvt::_exit 255;
		1304	}
683		1305
684	=item $isset = $term->option ($optval[, $set])	1306	=item $isset = $term->option ($optval[, $set])
685		1307
686	Returns true if the option specified by C<$optval> is enabled, and	1308	Returns true if the option specified by C<$optval> is enabled, and
687	optionally change it. All option values are stored by name in the hash	1309	optionally change it. All option values are stored by name in the hash
688	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1310	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
689		1311
690	Here is a a likely non-exhaustive list of option names, please see the	1312	Here is a likely non-exhaustive list of option names, please see the
691	source file F</src/optinc.h> to see the actual list:	1313	source file F</src/optinc.h> to see the actual list:
692		1314
693	borderLess console cursorBlink cursorUnderline hold iconic insecure	1315	borderLess buffered console cursorBlink cursorUnderline hold iconic
694	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1316	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1317	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
695	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1318	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
696	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1319	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
697	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1320	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
698	tripleclickwords utmpInhibit visualBell	1321	urgentOnBell utmpInhibit visualBell
699		1322
700	=item $value = $term->resource ($name[, $newval])	1323	=item $value = $term->resource ($name[, $newval])
701		1324
702	Returns the current resource value associated with a given name and	1325	Returns the current resource value associated with a given name and
703	optionally sets a new value. Setting values is most useful in the C<init>	1326	optionally sets a new value. Setting values is most useful in the C<init>
…		…
712	likely change).	1335	likely change).
713		1336
714	Please note that resource strings will currently only be freed when the	1337	Please note that resource strings will currently only be freed when the
715	terminal is destroyed, so changing options frequently will eat memory.	1338	terminal is destroyed, so changing options frequently will eat memory.
716		1339
717	Here is a a likely non-exhaustive list of resource names, not all of which	1340	Here is a likely non-exhaustive list of resource names, not all of which
718	are supported in every build, please see the source file F</src/rsinc.h>	1341	are supported in every build, please see the source file F</src/rsinc.h>
719	to see the actual list:	1342	to see the actual list:
720		1343
721	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1344	answerbackstring backgroundPixmap backspace_key blendtype blurradius
722	borderLess color cursorBlink cursorUnderline cutchars delete_key	1345	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
723	display_name embed ext_bwidth fade font geometry hold iconName	1346	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
724	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1347	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1348	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
725	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1349	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
726	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1350	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
727	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1351	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
728	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1352	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
729	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1353	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
730	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1354	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
731	shade term_name title transparent transparent_all tripleclickwords	1355	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1356	term_name title transient_for transparent tripleclickwords urgentOnBell
732	utmpInhibit visualBell	1357	utmpInhibit visualBell
733		1358
734	=cut	1359	=cut
735		1360
736	sub resource($$;$) {	1361	sub resource($$;$) {
737	my ($self, $name) = (shift, shift);	1362	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1363	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	1364	goto &urxvt::term::_resource
740	}	1365	}
		1366
		1367	=item $value = $term->x_resource ($pattern)
		1368
		1369	Returns the X-Resource for the given pattern, excluding the program or
		1370	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1371	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1372	resource with that pattern exists.
		1373
		1374	This method should only be called during the C<on_start> hook, as there is
		1375	only one resource database per display, and later invocations might return
		1376	the wrong resources.
		1377
		1378	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1379
		1380	Adds a keymap translation exactly as specified via a resource. See the
		1381	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
741		1382
742	=item $rend = $term->rstyle ([$new_rstyle])	1383	=item $rend = $term->rstyle ([$new_rstyle])
743		1384
744	Return and optionally change the current rendition. Text that is output by	1385	Return and optionally change the current rendition. Text that is output by
745	the terminal application will use this style.	1386	the terminal application will use this style.
…		…
753		1394
754	=item ($row, $col) = $term->selection_beg ([$row, $col])	1395	=item ($row, $col) = $term->selection_beg ([$row, $col])
755		1396
756	=item ($row, $col) = $term->selection_end ([$row, $col])	1397	=item ($row, $col) = $term->selection_end ([$row, $col])
757		1398
758	Return the current values of the selection mark, begin or end positions,	1399	Return the current values of the selection mark, begin or end positions.
759	and optionally set them to new values.
760		1400
		1401	When arguments are given, then the selection coordinates are set to
		1402	C<$row> and C<$col>, and the selection screen is set to the current
		1403	screen.
		1404
		1405	=item $screen = $term->selection_screen ([$screen])
		1406
		1407	Returns the current selection screen, and then optionally sets it.
		1408
		1409	=item $term->selection_make ($eventtime[, $rectangular])
		1410
		1411	Tries to make a selection as set by C<selection_beg> and
		1412	C<selection_end>. If C<$rectangular> is true (default: false), a
		1413	rectangular selection will be made. This is the preferred function to make
		1414	a selection.
		1415
761	=item $success = $term->selection_grab ($eventtime)	1416	=item $success = $term->selection_grab ($eventtime[, $clipboard])
762		1417
763	Try to request the primary selection from the server (for example, as set	1418	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
764	by the next method).	1419	true) selection from the server. The corresponding text can be set
		1420	with the next method. No visual feedback will be given. This function
		1421	is mostly useful from within C<on_sel_grab> hooks.
765		1422
766	=item $oldtext = $term->selection ([$newtext])	1423	=item $oldtext = $term->selection ([$newtext, $clipboard])
767		1424
768	Return the current selection text and optionally replace it by C<$newtext>.	1425	Return the current selection (clipboard if C<$clipboard> is true) text
		1426	and optionally replace it by C<$newtext>.
769		1427
		1428	=item $term->selection_clear ([$clipboard])
		1429
		1430	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
		1431
770	#=item $term->overlay ($x, $y, $text)	1432	=item $term->overlay_simple ($x, $y, $text)
771	#	1433
772	#Create a simple multi-line overlay box. See the next method for details.	1434	Create a simple multi-line overlay box. See the next method for details.
773	#	1435
774	#=cut	1436	=cut
775	#	1437
776	#sub urxvt::term::scr_overlay {	1438	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	1439	my ($self, $x, $y, $text) = @_;
778	#	1440
779	# my @lines = split /\n/, $text;	1441	my @lines = split /\n/, $text;
780	#	1442
781	# my $w = 0;	1443	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	1444
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1445	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1446	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	1447
		1448	$overlay
		1449	}
789		1450
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1451	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		1452
792	Create a new (empty) overlay at the given position with the given	1453	Create a new (empty) overlay at the given position with the given
793	width/height. C<$rstyle> defines the initial rendition style	1454	width/height. C<$rstyle> defines the initial rendition style
…		…
804		1465
805	The methods currently supported on C<urxvt::overlay> objects are:	1466	The methods currently supported on C<urxvt::overlay> objects are:
806		1467
807	=over 4	1468	=over 4
808		1469
809	=item $overlay->set ($x, $y, $text, $rend)	1470	=item $overlay->set ($x, $y, $text[, $rend])
810		1471
811	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1472	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
812	text in rxvt-unicode's special encoding and an array of rendition values	1473	text in rxvt-unicode's special encoding and an array of rendition values
813	at a specific position inside the overlay.	1474	at a specific position inside the overlay.
		1475
		1476	If C<$rend> is missing, then the rendition will not be changed.
814		1477
815	=item $overlay->hide	1478	=item $overlay->hide
816		1479
817	If visible, hide the overlay, but do not destroy it.	1480	If visible, hide the overlay, but do not destroy it.
818		1481
…		…
860		1523
861	=item $string = $term->locale_decode ($octets)	1524	=item $string = $term->locale_decode ($octets)
862		1525
863	Convert the given locale-encoded octets into a perl string.	1526	Convert the given locale-encoded octets into a perl string.
864		1527
		1528	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1529
		1530	XORs the rendition values in the given span with the provided value
		1531	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1532	refresh hooks to provide effects similar to the selection.
		1533
		1534	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1535
		1536	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1537	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1538	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1539	it instead. Both styles I<MUST NOT> contain font styles.
		1540
		1541	=item $term->scr_bell
		1542
		1543	Ring the bell!
		1544
865	=item $term->scr_add_lines ($string)	1545	=item $term->scr_add_lines ($string)
866		1546
867	Write the given text string to the screen, as if output by the application	1547	Write the given text string to the screen, as if output by the application
868	running inside the terminal. It may not contain command sequences (escape	1548	running inside the terminal. It may not contain command sequences (escape
869	codes), but is free to use line feeds, carriage returns and tabs. The	1549	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
871		1551
872	Normally its not a good idea to use this function, as programs might be	1552	Normally its not a good idea to use this function, as programs might be
873	confused by changes in cursor position or scrolling. Its useful inside a	1553	confused by changes in cursor position or scrolling. Its useful inside a
874	C<on_add_lines> hook, though.	1554	C<on_add_lines> hook, though.
875		1555
		1556	=item $term->scr_change_screen ($screen)
		1557
		1558	Switch to given screen - 0 primary, 1 secondary.
		1559
876	=item $term->cmd_parse ($octets)	1560	=item $term->cmd_parse ($octets)
877		1561
878	Similar to C<scr_add_lines>, but the argument must be in the	1562	Similar to C<scr_add_lines>, but the argument must be in the
879	locale-specific encoding of the terminal and can contain command sequences	1563	locale-specific encoding of the terminal and can contain command sequences
880	(escape codes) that will be interpreted.	1564	(escape codes) that will be interpreted.
881		1565
882	=item $term->tt_write ($octets)	1566	=item $term->tt_write ($octets)
883		1567
884	Write the octets given in C<$data> to the tty (i.e. as program input). To	1568	Write the octets given in C<$octets> to the tty (i.e. as program input). To
885	pass characters instead of octets, you should convert your strings first	1569	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	1570	to the locale-specific encoding using C<< $term->locale_encode >>.
887		1571
		1572	=item $term->tt_paste ($octets)
		1573
		1574	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1575	CR and bracketing the data with control sequences if bracketed paste mode
		1576	is set.
		1577
		1578	=item $old_events = $term->pty_ev_events ([$new_events])
		1579
		1580	Replaces the event mask of the pty watcher by the given event mask. Can
		1581	be used to suppress input and output handling to the pty/tty. See the
		1582	description of C<< urxvt::timer->events >>. Make sure to always restore
		1583	the previous value.
		1584
		1585	=item $fd = $term->pty_fd
		1586
		1587	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1588	is used.
		1589
888	=item $windowid = $term->parent	1590	=item $windowid = $term->parent
889		1591
890	Return the window id of the toplevel window.	1592	Return the window id of the toplevel window.
891		1593
892	=item $windowid = $term->vt	1594	=item $windowid = $term->vt
893		1595
894	Return the window id of the terminal window.	1596	Return the window id of the terminal window.
895		1597
		1598	=item $term->vt_emask_add ($x_event_mask)
		1599
		1600	Adds the specified events to the vt event mask. Useful e.g. when you want
		1601	to receive pointer events all the times:
		1602
		1603	$term->vt_emask_add (urxvt::PointerMotionMask);
		1604
		1605	=item $term->focus_in
		1606
		1607	=item $term->focus_out
		1608
		1609	=item $term->key_press ($state, $keycode[, $time])
		1610
		1611	=item $term->key_release ($state, $keycode[, $time])
		1612
		1613	Deliver various fake events to to terminal.
		1614
896	=item $window_width = $term->width	1615	=item $window_width = $term->width
897		1616
898	=item $window_height = $term->height	1617	=item $window_height = $term->height
899		1618
900	=item $font_width = $term->fwidth	1619	=item $font_width = $term->fwidth
…		…
913		1632
914	=item $max_scrollback = $term->saveLines	1633	=item $max_scrollback = $term->saveLines
915		1634
916	=item $nrow_plus_saveLines = $term->total_rows	1635	=item $nrow_plus_saveLines = $term->total_rows
917		1636
918	=item $lines_in_scrollback = $term->nsaved	1637	=item $topmost_scrollback_row = $term->top_row
919		1638
920	Return various integers describing terminal characteristics.	1639	Return various integers describing terminal characteristics.
		1640
		1641	=item $x_display = $term->display_id
		1642
		1643	Return the DISPLAY used by rxvt-unicode.
		1644
		1645	=item $lc_ctype = $term->locale
		1646
		1647	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1648
		1649	=item $env = $term->env
		1650
		1651	Returns a copy of the environment in effect for the terminal as a hashref
		1652	similar to C<\%ENV>.
		1653
		1654	=item @envv = $term->envv
		1655
		1656	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1657
		1658	=item @argv = $term->argv
		1659
		1660	Return the argument vector as this terminal, similar to @ARGV, but
		1661	includes the program name as first element.
		1662
		1663	=cut
		1664
		1665	sub env {
		1666	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1667	}
921		1668
922	=item $modifiermask = $term->ModLevel3Mask	1669	=item $modifiermask = $term->ModLevel3Mask
923		1670
924	=item $modifiermask = $term->ModMetaMask	1671	=item $modifiermask = $term->ModMetaMask
925		1672
926	=item $modifiermask = $term->ModNumLockMask	1673	=item $modifiermask = $term->ModNumLockMask
927		1674
928	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1675	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
929	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1676	AltGr), the meta key (often Alt) and the num lock key, if applicable.
930		1677
		1678	=item $screen = $term->current_screen
		1679
		1680	Returns the currently displayed screen (0 primary, 1 secondary).
		1681
		1682	=item $cursor_is_hidden = $term->hidden_cursor
		1683
		1684	Returns whether the cursor is currently hidden or not.
		1685
931	=item $view_start = $term->view_start ([$newvalue])	1686	=item $view_start = $term->view_start ([$newvalue])
932		1687
933	Returns the negative row number of the topmost line. Minimum value is	1688	Returns the row number of the topmost displayed line. Maximum value is
934	C<0>, which displays the normal terminal contents. Larger values scroll	1689	C<0>, which displays the normal terminal contents. Lower values scroll
935	this many lines into the scrollback buffer.	1690	this many lines into the scrollback buffer.
936		1691
937	=item $term->want_refresh	1692	=item $term->want_refresh
938		1693
939	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1694	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
942		1697
943	Used after changing terminal contents to display them.	1698	Used after changing terminal contents to display them.
944		1699
945	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1700	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
946		1701
947	Returns the text of the entire row with number C<$row_number>. Row C<0>	1702	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
948	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1703	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
949	terminal line. The scrollback buffer starts at line C<-1> and extends to
950	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1704	terminal line. Nothing will be returned if a nonexistent line
951	is requested.	1705	is requested.
952		1706
953	If C<$new_text> is specified, it will replace characters in the current	1707	If C<$new_text> is specified, it will replace characters in the current
954	line, starting at column C<$start_col> (default C<0>), which is useful	1708	line, starting at column C<$start_col> (default C<0>), which is useful
955	to replace only parts of a line. The font index in the rendition will	1709	to replace only parts of a line. The font index in the rendition will
956	automatically be updated.	1710	automatically be updated.
957		1711
958	C<$text> is in a special encoding: tabs and wide characters that use more	1712	C<$text> is in a special encoding: tabs and wide characters that use more
959	than one cell when displayed are padded with urxvt::NOCHAR characters	1713	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
960	(C<chr 65535>). Characters with combining characters and other characters	1714	characters. Characters with combining characters and other characters that
961	that do not fit into the normal tetx encoding will be replaced with	1715	do not fit into the normal text encoding will be replaced with characters
962	characters in the private use area.	1716	in the private use area.
963		1717
964	You have to obey this encoding when changing text. The advantage is	1718	You have to obey this encoding when changing text. The advantage is
965	that C<substr> and similar functions work on screen cells and not on	1719	that C<substr> and similar functions work on screen cells and not on
966	characters.	1720	characters.
967		1721
…		…
1018	Return the row number of the first/last row of the line, respectively.	1772	Return the row number of the first/last row of the line, respectively.
1019		1773
1020	=item $offset = $line->offset_of ($row, $col)	1774	=item $offset = $line->offset_of ($row, $col)
1021		1775
1022	Returns the character offset of the given row|col pair within the logical	1776	Returns the character offset of the given row|col pair within the logical
1023	line.	1777	line. Works for rows outside the line, too, and returns corresponding
		1778	offsets outside the string.
1024		1779
1025	=item ($row, $col) = $line->coord_of ($offset)	1780	=item ($row, $col) = $line->coord_of ($offset)
1026		1781
1027	Translates a string offset into terminal coordinates again.	1782	Translates a string offset into terminal coordinates again.
1028		1783
…		…
1110	where one character corresponds to one screen cell. See	1865	where one character corresponds to one screen cell. See
1111	C<< $term->ROW_t >> for details.	1866	C<< $term->ROW_t >> for details.
1112		1867
1113	=item $string = $term->special_decode $text	1868	=item $string = $term->special_decode $text
1114		1869
1115	Converts rxvt-unicodes text reprsentation into a perl string. See	1870	Converts rxvt-unicodes text representation into a perl string. See
1116	C<< $term->ROW_t >> for details.	1871	C<< $term->ROW_t >> for details.
1117		1872
1118	=item $success = $term->grab_button ($button, $modifiermask)	1873	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1119		1874
		1875	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1876
1120	Registers a synchronous button grab. See the XGrabButton manpage.	1877	Register/unregister a synchronous button grab. See the XGrabButton
		1878	manpage.
1121		1879
1122	=item $success = $term->grab ($eventtime[, $sync])	1880	=item $success = $term->grab ($eventtime[, $sync])
1123		1881
1124	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1882	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1125	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1883	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1126		1884
1127	=item $term->allow_events_async	1885	=item $term->allow_events_async
1128		1886
1129	Calls XAllowEvents with AsyncBoth for the most recent grab.	1887	Calls XAllowEvents with AsyncBoth for the most recent grab.
1130		1888
…		…
1137	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1895	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1138	recent grab.	1896	recent grab.
1139		1897
1140	=item $term->ungrab	1898	=item $term->ungrab
1141		1899
1142	Calls XUngrab for the most recent grab. Is called automatically on	1900	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1143	evaluation errors, as it is better to lose the grab in the error case as	1901	evaluation errors, as it is better to lose the grab in the error case as
1144	the session.	1902	the session.
		1903
		1904	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1905
		1906	=item $atom_name = $term->XGetAtomName ($atom)
		1907
		1908	=item @atoms = $term->XListProperties ($window)
		1909
		1910	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1911
		1912	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1913
		1914	=item $term->XDeleteProperty ($window, $property)
		1915
		1916	=item $window = $term->DefaultRootWindow
		1917
		1918	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1919
		1920	=item $term->XMapWindow ($window)
		1921
		1922	=item $term->XUnmapWindow ($window)
		1923
		1924	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1925
		1926	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1927
		1928	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1929
		1930	Various X or X-related functions. The C<$term> object only serves as
		1931	the source of the display, otherwise those functions map more-or-less
		1932	directly onto the X functions of the same name.
1145		1933
1146	=back	1934	=back
1147		1935
1148	=cut	1936	=cut
1149		1937
…		…
1165	$item->{render} ||= sub { $_[0]{text} };	1953	$item->{render} ||= sub { $_[0]{text} };
1166		1954
1167	push @{ $self->{item} }, $item;	1955	push @{ $self->{item} }, $item;
1168	}	1956	}
1169		1957
1170	sub add_separator {	1958	=item $popup->add_title ($title)
1171	my ($self, $sep) = @_;
1172		1959
1173	$sep ||= "═";	1960	Adds a non-clickable title to the popup.
1174		1961
1175	$self->add_item ({	1962	=cut
1176	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1177	text => "",
1178	render => sub { $sep x $urxvt::TERM->ncol },
1179	activate => sub { },
1180	});
1181	}
1182		1963
1183	sub add_title {	1964	sub add_title {
1184	my ($self, $title) = @_;	1965	my ($self, $title) = @_;
1185		1966
1186	$self->add_item ({	1967	$self->add_item ({
…		…
1188	text => $title,	1969	text => $title,
1189	activate => sub { },	1970	activate => sub { },
1190	});	1971	});
1191	}	1972	}
1192		1973
		1974	=item $popup->add_separator ([$sepchr])
		1975
		1976	Creates a separator, optionally using the character given as C<$sepchr>.
		1977
		1978	=cut
		1979
		1980	sub add_separator {
		1981	my ($self, $sep) = @_;
		1982
		1983	$sep ||= "=";
		1984
		1985	$self->add_item ({
		1986	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1987	text => "",
		1988	render => sub { $sep x $self->{term}->ncol },
		1989	activate => sub { },
		1990	});
		1991	}
		1992
		1993	=item $popup->add_button ($text, $cb)
		1994
		1995	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1996	selected.
		1997
		1998	=cut
		1999
1193	sub add_button {	2000	sub add_button {
1194	my ($self, $text, $cb) = @_;	2001	my ($self, $text, $cb) = @_;
1195		2002
1196	$self->add_item ({ type => "button", text => $text, activate => $cb});	2003	$self->add_item ({ type => "button", text => $text, activate => $cb});
1197	}	2004	}
1198		2005
		2006	=item $popup->add_toggle ($text, $initial_value, $cb)
		2007
		2008	Adds a toggle/checkbox item to the popup. The callback gets called
		2009	whenever it gets toggled, with a boolean indicating its new value as its
		2010	first argument.
		2011
		2012	=cut
		2013
1199	sub add_toggle {	2014	sub add_toggle {
1200	my ($self, $text, $cb, $value) = @_;	2015	my ($self, $text, $value, $cb) = @_;
1201		2016
1202	my $item; $item = {	2017	my $item; $item = {
1203	type => "button",	2018	type => "button",
1204	text => " $text",	2019	text => " $text",
1205	value => $value,	2020	value => $value,
1206	render => sub { ($_[0]{value} ? "* " : " ") . $text },	2021	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1207	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	2022	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1208	};	2023	};
1209		2024
1210	$self->add_item ($item);	2025	$self->add_item ($item);
1211	}	2026	}
		2027
		2028	=item $popup->show
		2029
		2030	Displays the popup (which is initially hidden).
		2031
		2032	=cut
1212		2033
1213	sub show {	2034	sub show {
1214	my ($self) = @_;	2035	my ($self) = @_;
1215		2036
1216	local $urxvt::popup::self = $self;	2037	local $urxvt::popup::self = $self;
1217		2038
1218	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2039	my $env = $self->{term}->env;
		2040	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		2041	delete $env->{LC_ALL};
		2042	$env->{LC_CTYPE} = $self->{term}->locale;
		2043
		2044	my $term = urxvt::term->new (
		2045	$env, "popup",
		2046	"--perl-lib" => "", "--perl-ext-common" => "",
		2047	"-pty-fd" => -1, "-sl" => 0,
		2048	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1219	"--transient-for" => $self->{term}->parent,	2049	"--transient-for" => $self->{term}->parent,
1220	"-display" => $self->{term}->display_id,	2050	"-display" => $self->{term}->display_id,
1221	"-pe" => "urxvt-popup")	2051	"-pe" => "urxvt-popup",
1222	or die "unable to create popup window\n";	2052	) or die "unable to create popup window\n";
		2053
		2054	unless (delete $term->{urxvt_popup_init_done}) {
		2055	$term->ungrab;
		2056	$term->destroy;
		2057	die "unable to initialise popup window\n";
		2058	}
1223	}	2059	}
1224		2060
1225	sub DESTROY {	2061	sub DESTROY {
1226	my ($self) = @_;	2062	my ($self) = @_;
1227		2063
1228	delete $self->{term}{_destroy}{$self};	2064	delete $self->{term}{_destroy}{$self};
1229	$self->{term}->ungrab;	2065	$self->{term}->ungrab;
1230	}	2066	}
		2067
		2068	=back
		2069
		2070	=cut
		2071
		2072	package urxvt::watcher;
1231		2073
1232	=head2 The C<urxvt::timer> Class	2074	=head2 The C<urxvt::timer> Class
1233		2075
1234	This class implements timer watchers/events. Time is represented as a	2076	This class implements timer watchers/events. Time is represented as a
1235	fractional number of seconds since the epoch. Example:	2077	fractional number of seconds since the epoch. Example:
…		…
1239	->new	2081	->new
1240	->interval (1)	2082	->interval (1)
1241	->cb (sub {	2083	->cb (sub {
1242	$term->{overlay}->set (0, 0,	2084	$term->{overlay}->set (0, 0,
1243	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2085	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1244	});	2086	});
1245		2087
1246	=over 4	2088	=over 4
1247		2089
1248	=item $timer = new urxvt::timer	2090	=item $timer = new urxvt::timer
1249		2091
…		…
1252		2094
1253	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2095	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1254		2096
1255	Set the callback to be called when the timer triggers.	2097	Set the callback to be called when the timer triggers.
1256		2098
1257	=item $tstamp = $timer->at
1258
1259	Return the time this watcher will fire next.
1260
1261	=item $timer = $timer->set ($tstamp)	2099	=item $timer = $timer->set ($tstamp[, $interval])
1262		2100
1263	Set the time the event is generated to $tstamp.	2101	Set the time the event is generated to $tstamp (and optionally specifies a
		2102	new $interval).
1264		2103
1265	=item $timer = $timer->interval ($interval)	2104	=item $timer = $timer->interval ($interval)
1266		2105
1267	Normally (and when C<$interval> is C<0>), the timer will automatically	2106	By default (and when C<$interval> is C<0>), the timer will automatically
1268	stop after it has fired once. If C<$interval> is non-zero, then the timer	2107	stop after it has fired once. If C<$interval> is non-zero, then the timer
1269	is automatically rescheduled at the given intervals.	2108	is automatically rescheduled at the given intervals.
1270		2109
1271	=item $timer = $timer->start	2110	=item $timer = $timer->start
1272		2111
1273	Start the timer.	2112	Start the timer.
1274		2113
1275	=item $timer = $timer->start ($tstamp)	2114	=item $timer = $timer->start ($tstamp[, $interval])
1276		2115
1277	Set the event trigger time to C<$tstamp> and start the timer.	2116	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2117	also replaces the interval.
		2118
		2119	=item $timer = $timer->after ($delay[, $interval])
		2120
		2121	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1278		2122
1279	=item $timer = $timer->stop	2123	=item $timer = $timer->stop
1280		2124
1281	Stop the timer.	2125	Stop the timer.
1282		2126
…		…
1288		2132
1289	$term->{socket} = ...	2133	$term->{socket} = ...
1290	$term->{iow} = urxvt::iow	2134	$term->{iow} = urxvt::iow
1291	->new	2135	->new
1292	->fd (fileno $term->{socket})	2136	->fd (fileno $term->{socket})
1293	->events (1) # wait for read data	2137	->events (urxvt::EV_READ)
1294	->start	2138	->start
1295	->cb (sub {	2139	->cb (sub {
1296	my ($iow, $revents) = @_;	2140	my ($iow, $revents) = @_;
1297	# $revents must be 1 here, no need to check	2141	# $revents must be 1 here, no need to check
1298	sysread $term->{socket}, my $buf, 8192	2142	sysread $term->{socket}, my $buf, 8192
…		…
1311	Set the callback to be called when io events are triggered. C<$reventmask>	2155	Set the callback to be called when io events are triggered. C<$reventmask>
1312	is a bitset as described in the C<events> method.	2156	is a bitset as described in the C<events> method.
1313		2157
1314	=item $iow = $iow->fd ($fd)	2158	=item $iow = $iow->fd ($fd)
1315		2159
1316	Set the filedescriptor (not handle) to watch.	2160	Set the file descriptor (not handle) to watch.
1317		2161
1318	=item $iow = $iow->events ($eventmask)	2162	=item $iow = $iow->events ($eventmask)
1319		2163
1320	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2164	Set the event mask to watch. The only allowed values are
1321	data, Bit #1 (value C<2>) enables watching for write data.	2165	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
		2166	together, or C<urxvt::EV_NONE>.
1322		2167
1323	=item $iow = $iow->start	2168	=item $iow = $iow->start
1324		2169
1325	Start watching for requested events on the given handle.	2170	Start watching for requested events on the given handle.
1326		2171
1327	=item $iow = $iow->stop	2172	=item $iow = $iow->stop
1328		2173
1329	Stop watching for events on the given filehandle.	2174	Stop watching for events on the given file handle.
		2175
		2176	=back
		2177
		2178	=head2 The C<urxvt::iw> Class
		2179
		2180	This class implements idle watchers, that get called automatically when
		2181	the process is idle. They should return as fast as possible, after doing
		2182	some useful work.
		2183
		2184	=over 4
		2185
		2186	=item $iw = new urxvt::iw
		2187
		2188	Create a new idle watcher object in stopped state.
		2189
		2190	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2191
		2192	Set the callback to be called when the watcher triggers.
		2193
		2194	=item $timer = $timer->start
		2195
		2196	Start the watcher.
		2197
		2198	=item $timer = $timer->stop
		2199
		2200	Stop the watcher.
		2201
		2202	=back
		2203
		2204	=head2 The C<urxvt::pw> Class
		2205
		2206	This class implements process watchers. They create an event whenever a
		2207	process exits, after which they stop automatically.
		2208
		2209	my $pid = fork;
		2210	...
		2211	$term->{pw} = urxvt::pw
		2212	->new
		2213	->start ($pid)
		2214	->cb (sub {
		2215	my ($pw, $exit_status) = @_;
		2216	...
		2217	});
		2218
		2219	=over 4
		2220
		2221	=item $pw = new urxvt::pw
		2222
		2223	Create a new process watcher in stopped state.
		2224
		2225	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2226
		2227	Set the callback to be called when the timer triggers.
		2228
		2229	=item $pw = $timer->start ($pid)
		2230
		2231	Tells the watcher to start watching for process C<$pid>.
		2232
		2233	=item $pw = $pw->stop
		2234
		2235	Stop the watcher.
1330		2236
1331	=back	2237	=back
1332		2238
1333	=head1 ENVIRONMENT	2239	=head1 ENVIRONMENT
1334		2240
…		…
1341		2247
1342	=item == 0 - fatal messages	2248	=item == 0 - fatal messages
1343		2249
1344	=item >= 3 - script loading and management	2250	=item >= 3 - script loading and management
1345		2251
1346	=item >=10 - all events received	2252	=item >=10 - all called hooks
		2253
		2254	=item >=11 - hook return values
1347		2255
1348	=back	2256	=back
1349		2257
1350	=head1 AUTHOR	2258	=head1 AUTHOR
1351		2259
1352	Marc Lehmann <pcg@goof.com>	2260	Marc Lehmann <schmorp@schmorp.de>
1353	http://software.schmorp.de/pkg/rxvt-unicode	2261	http://software.schmorp.de/pkg/rxvt-unicode
1354		2262
1355	=cut	2263	=cut
1356		2264
1357	1	2265	1
		2266
		2267	# vim: sw=3:

Diff Legend

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