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.31 by root, Wed Jan 4 19:39:46 2006 UTC vs.
Revision 1.207 by root, Tue Jun 5 21:29:52 2012 UTC

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

Diff Legend

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