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

Diff Legend

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