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.30 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.210 by root, Wed Jun 6 11:46:11 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 parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	warn "resourece<@_>\n";#d#
		954
		955	my $r = $term->{meta}{resource};
		956	while (my ($pattern, $v) = each %$r) {
		957	$name =~ y/-/./ if $isarg;
		958
		959	if (
		960	$pattern =~ s/\*$//
		961	? $pattern eq substr $name, 0, length $pattern
		962	: $pattern eq $name
		963	) {
		964	$name = "$urxvt::RESCLASS.$name";
		965	warn "set option <$name=$value>\n";#d#
		966	#TODO: queue $v->[0] for loading
		967	if ($v->[1] eq "boolean") {
		968	$term->put_option_db ($name, $flag ? "true" : "false");
		969	return 1;
		970	} else {
		971	$term->put_option_db ($name, $value);
		972	return 1 + 2;
		973	}
		974	}
		975	}
		976
		977	0
		978	}
		979
		980	sub usage {
		981	my ($term, $usage_type) = @_;
		982
		983	$term->scan_meta;
		984
		985	my $r = $term->{meta}{resource};
		986
		987	for my $pattern (sort keys %$r) {
		988	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		989
		990	$desc .= " (-pe $ext)";
		991
		992	if ($usage_type == 1) {
		993	$pattern =~ y/./-/;
		994	$pattern =~ s/\*/.../g;
		995
		996	if ($type eq "boolean") {
		997	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		998	} else {
		999	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		1000	}
		1001	} else {
		1002	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1003	}
		1004	}
		1005	}
		1006
321	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1007	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
322		1008
323	sub verbose {	1009	sub verbose {
324	my ($level, $msg) = @_;	1010	my ($level, $msg) = @_;
325	warn "$msg\n" if $level <= $verbosity;	1011	warn "$msg\n" if $level <= $verbosity;
326	}	1012	}
327		1013
328	# find on_xxx subs in the package and register them	1014	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		1015
348	# load a single script into its own package, once only	1016	# load a single script into its own package, once only
349	sub script_package($) {	1017	sub extension_package($) {
350	my ($path) = @_;	1018	my ($path) = @_;
351		1019
352	$script_pkg{$path} ||= do {	1020	$extension_pkg{$path} ||= do {
353	my $pkg = "urxvt::" . ($script_pkg++);	1021	$path =~ /([^\/\\]+)$/;
		1022	my $pkg = $1;
		1023	$pkg =~ s/[^[:word:]]/_/g;
		1024	$pkg = "urxvt::ext::$pkg";
354		1025
355	verbose 3, "loading script '$path' into package '$pkg'";	1026	verbose 3, "loading extension '$path' into package '$pkg'";
356		1027
357	open my $fh, "<:raw", $path	1028	open my $fh, "<:raw", $path
358	or die "$path: $!";	1029	or die "$path: $!";
359		1030
360	my $source = "package $pkg; use strict; use utf8;\n"	1031	my $source =
		1032	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
361	. "#line 1 \"$path\"\n{\n"	1033	. "#line 1 \"$path\"\n{\n"
362	. (do { local $/; <$fh> })	1034	. (do { local $/; <$fh> })
363	. "\n};\n1";	1035	. "\n};\n1";
364		1036
		1037	eval $source
365	eval $source or die "$path: $@";	1038	or die "$path: $@";
366		1039
367	$pkg	1040	$pkg
368	}	1041	}
369	}	1042	}
		1043
		1044	our $retval; # return value for urxvt
370		1045
371	# called by the rxvt core	1046	# called by the rxvt core
372	sub invoke {	1047	sub invoke {
373	local $TERM = shift;	1048	local $TERM = shift;
374	my $htype = shift;	1049	my $htype = shift;
375		1050
376	if ($htype == 0) { # INIT	1051	if ($htype == 0) { # INIT
377	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1052	my @dirs = $TERM->perl_libdirs;
378		1053
		1054	my %ext_arg;
		1055
		1056	{
		1057	my @init = @TERM_INIT;
		1058	@TERM_INIT = ();
		1059	$_->($TERM) for @init;
		1060	my @pkg = @TERM_EXT;
		1061	@TERM_EXT = ();
		1062	$TERM->register_package ($_) for @pkg;
		1063	}
		1064
379	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1065	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		1066	if ($_ eq "default") {
		1067	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
		1068	} elsif (/^-(.*)$/) {
		1069	delete $ext_arg{$1};
		1070	} elsif (/^([^<]+)<(.*)>$/) {
		1071	push @{ $ext_arg{$1} }, $2;
		1072	} else {
		1073	$ext_arg{$_} ||= [];
		1074	}
		1075	}
		1076
		1077	for my $ext (sort keys %ext_arg) {
380	my @files = grep -f $_, map "$_/$ext", @dirs;	1078	my @files = grep -f $_, map "$_/$ext", @dirs;
381		1079
382	if (@files) {	1080	if (@files) {
383	register_package script_package $files[0];	1081	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
384	} else {	1082	} else {
385	warn "perl extension '$ext' not found in perl library search path\n";	1083	warn "perl extension '$ext' not found in perl library search path\n";
386	}	1084	}
387	}	1085	}
388		1086
		1087	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		1088	warn $@ if $@;
		1089	}
		1090
		1091	$retval = undef;
		1092
		1093	if (my $cb = $TERM->{_hook}[$htype]) {
		1094	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		1095	if $verbosity >= 10;
		1096
		1097	for my $pkg (keys %$cb) {
		1098	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
		1099	$retval ||= $retval_;
		1100
		1101	if ($@) {
		1102	$TERM->ungrab; # better to lose the grab than the session
		1103	warn $@;
		1104	}
		1105	}
		1106
		1107	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		1108	if $verbosity >= 11;
		1109	}
		1110
389	} elsif ($htype == 1) { # DESTROY	1111	if ($htype == 1) { # DESTROY
390	if (my $hook = $TERM->{_hook}) {	1112	# clear package objects
391	for my $htype (0..$#$hook) {	1113	%$_ = () for values %{ $TERM->{_pkg} };
392	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }	1114
393	or set_should_invoke $htype, 0;	1115	# clear package
		1116	%$TERM = ();
		1117	}
		1118
		1119	$retval
		1120	}
		1121
		1122	sub SET_COLOR($$$) {
		1123	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1124	}
		1125
		1126	sub rend2mask {
		1127	no strict 'refs';
		1128	my ($str, $mask) = (@_, 0);
		1129	my %color = ( fg => undef, bg => undef );
		1130	my @failed;
		1131	for my $spec ( split /\s+/, $str ) {
		1132	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1133	$color{lc($1)} = $2;
		1134	} else {
		1135	my $neg = $spec =~ s/^[-^]//;
		1136	unless ( exists &{"RS_$spec"} ) {
		1137	push @failed, $spec;
		1138	next;
		1139	}
		1140	my $cur = &{"RS_$spec"};
		1141	if ( $neg ) {
		1142	$mask &= ~$cur;
		1143	} else {
		1144	$mask |= $cur;
394	}	1145	}
395	}	1146	}
396	}	1147	}
		1148	($mask, @color{qw(fg bg)}, \@failed)
		1149	}
397		1150
398	my $cb = $TERM->{_hook}[$htype]	1151	# urxvt::term::extension
399	or return;
400		1152
401	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1153	package urxvt::term::extension;
402	if $verbosity >= 10;
403		1154
404	keys %$cb;	1155	sub enable {
		1156	my ($self, %hook) = @_;
		1157	my $pkg = $self->{_pkg};
405		1158
406	while (my ($pkg, $cb) = each %$cb) {	1159	while (my ($name, $cb) = each %hook) {
407	return 1	1160	my $htype = $HOOKTYPE{uc $name};
408	if $cb->(	1161	defined $htype
409	$TERM->{$pkg} ||= do {	1162	or Carp::croak "unsupported hook type '$name'";
410	my $proxy = bless { }, urxvt::term::proxy::;	1163
411	Scalar::Util::weaken ($proxy->{term} = $TERM);	1164	$self->set_should_invoke ($htype, +1)
412	$proxy	1165	unless exists $self->{term}{_hook}[$htype]{$pkg};
413	},	1166
414	@_,	1167	$self->{term}{_hook}[$htype]{$pkg} = $cb;
415	);
416	}	1168	}
		1169	}
417		1170
		1171	sub disable {
		1172	my ($self, @hook) = @_;
		1173	my $pkg = $self->{_pkg};
		1174
		1175	for my $name (@hook) {
		1176	my $htype = $HOOKTYPE{uc $name};
		1177	defined $htype
		1178	or Carp::croak "unsupported hook type '$name'";
		1179
		1180	$self->set_should_invoke ($htype, -1)
		1181	if delete $self->{term}{_hook}[$htype]{$pkg};
418	0	1182	}
419	}	1183	}
420		1184
421	sub urxvt::term::proxy::AUTOLOAD {	1185	our $AUTOLOAD;
422	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	1186
		1187	sub AUTOLOAD {
		1188	$AUTOLOAD =~ /:([^:]+)$/
423	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	1189	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
424		1190
425	eval qq{	1191	eval qq{
426	sub $urxvt::term::proxy::AUTOLOAD {	1192	sub $AUTOLOAD {
427	my \$proxy = shift;	1193	my \$proxy = shift;
428	\$proxy->{term}->$1 (\@_)	1194	\$proxy->{term}->$1 (\@_)
429	}	1195	}
430	1	1196	1
431	} or die "FATAL: unable to compile method forwarder: $@";	1197	} or die "FATAL: unable to compile method forwarder: $@";
432		1198
433	goto &$urxvt::term::proxy::AUTOLOAD;	1199	goto &$AUTOLOAD;
434	}	1200	}
		1201
		1202	sub DESTROY {
		1203	# nop
		1204	}
		1205
		1206	# urxvt::destroy_hook
		1207
		1208	sub urxvt::destroy_hook::DESTROY {
		1209	${$_[0]}->();
		1210	}
		1211
		1212	sub urxvt::destroy_hook(&) {
		1213	bless \shift, urxvt::destroy_hook::
		1214	}
		1215
		1216	package urxvt::anyevent;
		1217
		1218	=head2 The C<urxvt::anyevent> Class
		1219
		1220	The sole purpose of this class is to deliver an interface to the
		1221	C<AnyEvent> module - any module using it will work inside urxvt without
		1222	further programming. The only exception is that you cannot wait on
		1223	condition variables, but non-blocking condvar use is ok.
		1224
		1225	In practical terms this means is that you cannot use blocking APIs, but
		1226	the non-blocking variant should work.
		1227
		1228	=cut
		1229
		1230	our $VERSION = '5.23';
		1231
		1232	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		1233	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		1234
		1235	sub timer {
		1236	my ($class, %arg) = @_;
		1237
		1238	my $cb = $arg{cb};
		1239
		1240	urxvt::timer
		1241	->new
		1242	->after ($arg{after}, $arg{interval})
		1243	->cb ($arg{interval} ? $cb : sub {
		1244	$_[0]->stop; # need to cancel manually
		1245	$cb->();
		1246	})
		1247	}
		1248
		1249	sub io {
		1250	my ($class, %arg) = @_;
		1251
		1252	my $cb = $arg{cb};
		1253	my $fd = fileno $arg{fh};
		1254	defined $fd or $fd = $arg{fh};
		1255
		1256	bless [$arg{fh}, urxvt::iow
		1257	->new
		1258	->fd ($fd)
		1259	->events (($arg{poll} =~ /r/ ? 1 : 0)
		1260	| ($arg{poll} =~ /w/ ? 2 : 0))
		1261	->start
		1262	->cb ($cb)
		1263	], urxvt::anyevent::
		1264	}
		1265
		1266	sub idle {
		1267	my ($class, %arg) = @_;
		1268
		1269	my $cb = $arg{cb};
		1270
		1271	urxvt::iw
		1272	->new
		1273	->start
		1274	->cb ($cb)
		1275	}
		1276
		1277	sub child {
		1278	my ($class, %arg) = @_;
		1279
		1280	my $cb = $arg{cb};
		1281
		1282	urxvt::pw
		1283	->new
		1284	->start ($arg{pid})
		1285	->cb (sub {
		1286	$_[0]->stop; # need to cancel manually
		1287	$cb->($_[0]->rpid, $_[0]->rstatus);
		1288	})
		1289	}
		1290
		1291	sub DESTROY {
		1292	$_[0][1]->stop;
		1293	}
		1294
		1295	# only needed for AnyEvent < 6 compatibility
		1296	sub one_event {
		1297	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
		1298	}
		1299
		1300	package urxvt::term;
435		1301
436	=head2 The C<urxvt::term> Class	1302	=head2 The C<urxvt::term> Class
437		1303
438	=over 4	1304	=over 4
		1305
		1306	=cut
		1307
		1308	# find on_xxx subs in the package and register them
		1309	# as hooks
		1310	sub register_package {
		1311	my ($self, $pkg, $argv) = @_;
		1312
		1313	no strict 'refs';
		1314
		1315	urxvt::verbose 6, "register package $pkg to $self";
		1316
		1317	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1318
		1319	my $proxy = bless {
		1320	_pkg => $pkg,
		1321	argv => $argv,
		1322	}, $pkg;
		1323	Scalar::Util::weaken ($proxy->{term} = $self);
		1324
		1325	$self->{_pkg}{$pkg} = $proxy;
		1326
		1327	for my $name (@HOOKNAME) {
		1328	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1329	$proxy->enable ($name => $ref);
		1330	}
		1331	}
		1332	}
		1333
		1334	sub perl_libdirs {
		1335	map { split /:/ }
		1336	$_[0]->resource ("perl_lib"),
		1337	$ENV{URXVT_PERL_LIB},
		1338	"$ENV{HOME}/.urxvt/ext",
		1339	"$LIBDIR/perl"
		1340	}
		1341
		1342	sub scan_meta {
		1343	my ($self) = @_;
		1344	my @libdirs = perl_libdirs $self;
		1345
		1346	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1347
		1348	my %meta;
		1349
		1350	$self->{meta_libdirs} = join "\x00", @libdirs;
		1351	$self->{meta} = \%meta;
		1352
		1353	for my $dir (reverse @libdirs) {
		1354	opendir my $fh, $dir
		1355	or next;
		1356	for my $ext (readdir $fh) {
		1357	$ext ne "."
		1358	and $ext ne ".."
		1359	and open my $fh, "<", "$dir/$ext"
		1360	or next;
		1361
		1362	while (<$fh>) {
		1363	if (/^#:META:X_RESOURCE:(.*)/) {
		1364	my ($pattern, $type, $desc) = split /:/, $1;
		1365	$pattern =~ s/^%\./$ext./g; # $$ in pattern == extension name
		1366	if ($pattern =~ /[^a-zA-Z\*\.]/) {
		1367	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1368	} else {
		1369	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1370	}
		1371	} elsif (/^\s*(?:#|$)/) {
		1372	# skip other comments and empty lines
		1373	} else {
		1374	last; # stop parsing on first non-empty non-comment line
		1375	}
		1376	}
		1377	}
		1378	}
		1379	}
		1380
		1381	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1382
		1383	Creates a new terminal, very similar as if you had started it with system
		1384	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1385	hash which defines the environment of the new terminal.
		1386
		1387	Croaks (and probably outputs an error message) if the new instance
		1388	couldn't be created. Returns C<undef> if the new instance didn't
		1389	initialise perl, and the terminal object otherwise. The C<init> and
		1390	C<start> hooks will be called before this call returns, and are free to
		1391	refer to global data (which is race free).
		1392
		1393	=cut
		1394
		1395	sub new {
		1396	my ($class, $env, @args) = @_;
		1397
		1398	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1399	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1400
		1401	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1402	}
		1403
		1404	=item $term->destroy
		1405
		1406	Destroy the terminal object (close the window, free resources
		1407	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1408	watchers (timers, io watchers) are still active.
		1409
		1410	=item $term->exec_async ($cmd[, @args])
		1411
		1412	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1413	("starts") programs in the background. This function takes care of setting
		1414	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1415	be preferred over explicit calls to C<exec> or C<system>.
		1416
		1417	Returns the pid of the subprocess or C<undef> on error.
		1418
		1419	=cut
		1420
		1421	sub exec_async {
		1422	my $self = shift;
		1423
		1424	my $pid = fork;
		1425
		1426	return $pid
		1427	if !defined $pid or $pid;
		1428
		1429	%ENV = %{ $self->env };
		1430
		1431	exec @_;
		1432	urxvt::_exit 255;
		1433	}
		1434
		1435	=item $isset = $term->option ($optval[, $set])
		1436
		1437	Returns true if the option specified by C<$optval> is enabled, and
		1438	optionally change it. All option values are stored by name in the hash
		1439	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		1440
		1441	Here is a likely non-exhaustive list of option names, please see the
		1442	source file F</src/optinc.h> to see the actual list:
		1443
		1444	borderLess buffered console cursorBlink cursorUnderline hold iconic
		1445	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1446	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
		1447	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
		1448	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
		1449	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1450	urgentOnBell utmpInhibit visualBell
439		1451
440	=item $value = $term->resource ($name[, $newval])	1452	=item $value = $term->resource ($name[, $newval])
441		1453
442	Returns the current resource value associated with a given name and	1454	Returns the current resource value associated with a given name and
443	optionally sets a new value. Setting values is most useful in the C<init>	1455	optionally sets a new value. Setting values is most useful in the C<init>
…		…
452	likely change).	1464	likely change).
453		1465
454	Please note that resource strings will currently only be freed when the	1466	Please note that resource strings will currently only be freed when the
455	terminal is destroyed, so changing options frequently will eat memory.	1467	terminal is destroyed, so changing options frequently will eat memory.
456		1468
457	Here is a a likely non-exhaustive list of resource names, not all of which	1469	Here is a likely non-exhaustive list of resource names, not all of which
458	are supported in every build, please see the source to see the actual	1470	are supported in every build, please see the source file F</src/rsinc.h>
459	list:	1471	to see the actual list:
460		1472
461	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1473	answerbackstring backgroundPixmap backspace_key blendtype blurradius
462	borderLess color cursorBlink cursorUnderline cutchars delete_key	1474	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
463	display_name embed ext_bwidth fade font geometry hold iconName	1475	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
464	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1476	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1477	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
465	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1478	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
466	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1479	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
467	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1480	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
468	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1481	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
469	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1482	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
470	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1483	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
471	shade term_name title transparent transparent_all tripleclickwords	1484	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1485	term_name title transient_for transparent tripleclickwords urgentOnBell
472	utmpInhibit visualBell	1486	utmpInhibit visualBell
473		1487
474	=cut	1488	=cut
475		1489
476	sub urxvt::term::resource($$;$) {	1490	sub resource($$;$) {
477	my ($self, $name) = (shift, shift);	1491	my ($self, $name) = (shift, shift);
478	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1492	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
479	goto &urxvt::term::_resource;	1493	goto &urxvt::term::_resource
480	}	1494	}
		1495
		1496	=item $value = $term->x_resource ($pattern)
		1497
		1498	Returns the X-Resource for the given pattern, excluding the program or
		1499	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1500	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1501	resource with that pattern exists.
		1502
		1503	This method should only be called during the C<on_start> hook, as there is
		1504	only one resource database per display, and later invocations might return
		1505	the wrong resources.
		1506
		1507	=item $success = $term->parse_keysym ($key, $octets)
		1508
		1509	Adds a key binding exactly as specified via a resource. See the
		1510	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1511
		1512	=item $term->register_command ($keysym, $modifiermask, $string)
		1513
		1514	Adds a key binding. This is a lower level api compared to
		1515	C<parse_keysym>, as it expects a parsed key description, and can be
		1516	used only inside either the C<on_init> hook, to add a binding, or the
		1517	C<on_register_command> hook, to modify a parsed binding.
		1518
		1519	=item $rend = $term->rstyle ([$new_rstyle])
		1520
		1521	Return and optionally change the current rendition. Text that is output by
		1522	the terminal application will use this style.
		1523
		1524	=item ($row, $col) = $term->screen_cur ([$row, $col])
		1525
		1526	Return the current coordinates of the text cursor position and optionally
		1527	set it (which is usually bad as applications don't expect that).
481		1528
482	=item ($row, $col) = $term->selection_mark ([$row, $col])	1529	=item ($row, $col) = $term->selection_mark ([$row, $col])
483		1530
484	=item ($row, $col) = $term->selection_beg ([$row, $col])	1531	=item ($row, $col) = $term->selection_beg ([$row, $col])
485		1532
486	=item ($row, $col) = $term->selection_end ([$row, $col])	1533	=item ($row, $col) = $term->selection_end ([$row, $col])
487		1534
488	Return the current values of the selection mark, begin or end positions,	1535	Return the current values of the selection mark, begin or end positions.
489	and optionally set them to new values.
490		1536
		1537	When arguments are given, then the selection coordinates are set to
		1538	C<$row> and C<$col>, and the selection screen is set to the current
		1539	screen.
		1540
		1541	=item $screen = $term->selection_screen ([$screen])
		1542
		1543	Returns the current selection screen, and then optionally sets it.
		1544
		1545	=item $term->selection_make ($eventtime[, $rectangular])
		1546
		1547	Tries to make a selection as set by C<selection_beg> and
		1548	C<selection_end>. If C<$rectangular> is true (default: false), a
		1549	rectangular selection will be made. This is the preferred function to make
		1550	a selection.
		1551
491	=item $success = $term->selection_grab ($eventtime)	1552	=item $success = $term->selection_grab ($eventtime[, $clipboard])
492		1553
493	Try to request the primary selection from the server (for example, as set	1554	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
494	by the next method).	1555	true) selection from the server. The corresponding text can be set
		1556	with the next method. No visual feedback will be given. This function
		1557	is mostly useful from within C<on_sel_grab> hooks.
495		1558
496	=item $oldtext = $term->selection ([$newtext])	1559	=item $oldtext = $term->selection ([$newtext, $clipboard])
497		1560
498	Return the current selection text and optionally replace it by C<$newtext>.	1561	Return the current selection (clipboard if C<$clipboard> is true) text
		1562	and optionally replace it by C<$newtext>.
499		1563
		1564	=item $term->selection_clear ([$clipboard])
		1565
		1566	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
		1567
500	#=item $term->overlay ($x, $y, $text)	1568	=item $term->overlay_simple ($x, $y, $text)
501	#	1569
502	#Create a simple multi-line overlay box. See the next method for details.	1570	Create a simple multi-line overlay box. See the next method for details.
503	#	1571
504	#=cut	1572	=cut
505		1573
506	sub urxvt::term::scr_overlay {	1574	sub overlay_simple {
507	die;
508	my ($self, $x, $y, $text) = @_;	1575	my ($self, $x, $y, $text) = @_;
509		1576
510	my @lines = split /\n/, $text;	1577	my @lines = split /\n/, $text;
511		1578
512	my $w = 0;	1579	my $w = List::Util::max map $self->strwidth ($_), @lines;
513	for (map $self->strwidth ($_), @lines) {
514	$w = $_ if $w < $_;
515	}
516		1580
517	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	1581	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
518	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1582	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		1583
		1584	$overlay
519	}	1585	}
520		1586
521	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1587	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
522		1588
523	Create a new (empty) overlay at the given position with the given	1589	Create a new (empty) overlay at the given position with the given
…		…
535		1601
536	The methods currently supported on C<urxvt::overlay> objects are:	1602	The methods currently supported on C<urxvt::overlay> objects are:
537		1603
538	=over 4	1604	=over 4
539		1605
540	=item $overlay->set ($x, $y, $text, $rend)	1606	=item $overlay->set ($x, $y, $text[, $rend])
541		1607
542	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1608	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
543	text in rxvt-unicode's special encoding and an array of rendition values	1609	text in rxvt-unicode's special encoding and an array of rendition values
544	at a specific position inside the overlay.	1610	at a specific position inside the overlay.
545		1611
		1612	If C<$rend> is missing, then the rendition will not be changed.
		1613
546	=item $overlay->hide	1614	=item $overlay->hide
547		1615
548	If visible, hide the overlay, but do not destroy it.	1616	If visible, hide the overlay, but do not destroy it.
549		1617
550	=item $overlay->show	1618	=item $overlay->show
551		1619
552	If hidden, display the overlay again.	1620	If hidden, display the overlay again.
553		1621
554	=back	1622	=back
555		1623
		1624	=item $popup = $term->popup ($event)
		1625
		1626	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1627	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1628	currently).
		1629
		1630	=cut
		1631
		1632	sub popup {
		1633	my ($self, $event) = @_;
		1634
		1635	$self->grab ($event->{time}, 1)
		1636	or return;
		1637
		1638	my $popup = bless {
		1639	term => $self,
		1640	event => $event,
		1641	}, urxvt::popup::;
		1642
		1643	Scalar::Util::weaken $popup->{term};
		1644
		1645	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1646	Scalar::Util::weaken $self->{_destroy}{$popup};
		1647
		1648	$popup
		1649	}
		1650
556	=item $cellwidth = $term->strwidth $string	1651	=item $cellwidth = $term->strwidth ($string)
557		1652
558	Returns the number of screen-cells this string would need. Correctly	1653	Returns the number of screen-cells this string would need. Correctly
559	accounts for wide and combining characters.	1654	accounts for wide and combining characters.
560		1655
561	=item $octets = $term->locale_encode $string	1656	=item $octets = $term->locale_encode ($string)
562		1657
563	Convert the given text string into the corresponding locale encoding.	1658	Convert the given text string into the corresponding locale encoding.
564		1659
565	=item $string = $term->locale_decode $octets	1660	=item $string = $term->locale_decode ($octets)
566		1661
567	Convert the given locale-encoded octets into a perl string.	1662	Convert the given locale-encoded octets into a perl string.
568		1663
		1664	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1665
		1666	XORs the rendition values in the given span with the provided value
		1667	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1668	refresh hooks to provide effects similar to the selection.
		1669
		1670	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1671
		1672	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1673	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1674	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1675	it instead. Both styles I<MUST NOT> contain font styles.
		1676
		1677	=item $term->scr_bell
		1678
		1679	Ring the bell!
		1680
		1681	=item $term->scr_add_lines ($string)
		1682
		1683	Write the given text string to the screen, as if output by the application
		1684	running inside the terminal. It may not contain command sequences (escape
		1685	codes), but is free to use line feeds, carriage returns and tabs. The
		1686	string is a normal text string, not in locale-dependent encoding.
		1687
		1688	Normally its not a good idea to use this function, as programs might be
		1689	confused by changes in cursor position or scrolling. Its useful inside a
		1690	C<on_add_lines> hook, though.
		1691
		1692	=item $term->scr_change_screen ($screen)
		1693
		1694	Switch to given screen - 0 primary, 1 secondary.
		1695
		1696	=item $term->cmd_parse ($octets)
		1697
		1698	Similar to C<scr_add_lines>, but the argument must be in the
		1699	locale-specific encoding of the terminal and can contain command sequences
		1700	(escape codes) that will be interpreted.
		1701
569	=item $term->tt_write ($octets)	1702	=item $term->tt_write ($octets)
570		1703
571	Write the octets given in C<$data> to the tty (i.e. as program input). To	1704	Write the octets given in C<$octets> to the tty (i.e. as program input). To
572	pass characters instead of octets, you should convert your strings first	1705	pass characters instead of octets, you should convert your strings first
573	to the locale-specific encoding using C<< $term->locale_encode >>.	1706	to the locale-specific encoding using C<< $term->locale_encode >>.
574		1707
		1708	=item $term->tt_paste ($octets)
		1709
		1710	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1711	CR and bracketing the data with control sequences if bracketed paste mode
		1712	is set.
		1713
		1714	=item $old_events = $term->pty_ev_events ([$new_events])
		1715
		1716	Replaces the event mask of the pty watcher by the given event mask. Can
		1717	be used to suppress input and output handling to the pty/tty. See the
		1718	description of C<< urxvt::timer->events >>. Make sure to always restore
		1719	the previous value.
		1720
		1721	=item $fd = $term->pty_fd
		1722
		1723	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1724	is used.
		1725
		1726	=item $windowid = $term->parent
		1727
		1728	Return the window id of the toplevel window.
		1729
		1730	=item $windowid = $term->vt
		1731
		1732	Return the window id of the terminal window.
		1733
		1734	=item $term->vt_emask_add ($x_event_mask)
		1735
		1736	Adds the specified events to the vt event mask. Useful e.g. when you want
		1737	to receive pointer events all the times:
		1738
		1739	$term->vt_emask_add (urxvt::PointerMotionMask);
		1740
		1741	=item $term->set_urgency ($set)
		1742
		1743	Enable/disable the urgency hint on the toplevel window.
		1744
		1745	=item $term->focus_in
		1746
		1747	=item $term->focus_out
		1748
		1749	=item $term->key_press ($state, $keycode[, $time])
		1750
		1751	=item $term->key_release ($state, $keycode[, $time])
		1752
		1753	Deliver various fake events to to terminal.
		1754
		1755	=item $window_width = $term->width
		1756
		1757	=item $window_height = $term->height
		1758
		1759	=item $font_width = $term->fwidth
		1760
		1761	=item $font_height = $term->fheight
		1762
		1763	=item $font_ascent = $term->fbase
		1764
575	=item $nrow = $term->nrow	1765	=item $terminal_rows = $term->nrow
576		1766
577	=item $ncol = $term->ncol	1767	=item $terminal_columns = $term->ncol
578		1768
579	Return the number of rows/columns of the terminal window (i.e. as	1769	=item $has_focus = $term->focus
580	specified by C<-geometry>, excluding any scrollback).
581		1770
		1771	=item $is_mapped = $term->mapped
		1772
		1773	=item $max_scrollback = $term->saveLines
		1774
		1775	=item $nrow_plus_saveLines = $term->total_rows
		1776
		1777	=item $topmost_scrollback_row = $term->top_row
		1778
		1779	Return various integers describing terminal characteristics.
		1780
		1781	=item $x_display = $term->display_id
		1782
		1783	Return the DISPLAY used by rxvt-unicode.
		1784
		1785	=item $lc_ctype = $term->locale
		1786
		1787	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1788
582	=item $nsaved = $term->nsaved	1789	=item $env = $term->env
583		1790
584	Returns the number of lines in the scrollback buffer.	1791	Returns a copy of the environment in effect for the terminal as a hashref
		1792	similar to C<\%ENV>.
		1793
		1794	=item @envv = $term->envv
		1795
		1796	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1797
		1798	=item @argv = $term->argv
		1799
		1800	Return the argument vector as this terminal, similar to @ARGV, but
		1801	includes the program name as first element.
		1802
		1803	=cut
		1804
		1805	sub env {
		1806	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1807	}
		1808
		1809	=item $modifiermask = $term->ModLevel3Mask
		1810
		1811	=item $modifiermask = $term->ModMetaMask
		1812
		1813	=item $modifiermask = $term->ModNumLockMask
		1814
		1815	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1816	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1817
		1818	=item $screen = $term->current_screen
		1819
		1820	Returns the currently displayed screen (0 primary, 1 secondary).
		1821
		1822	=item $cursor_is_hidden = $term->hidden_cursor
		1823
		1824	Returns whether the cursor is currently hidden or not.
585		1825
586	=item $view_start = $term->view_start ([$newvalue])	1826	=item $view_start = $term->view_start ([$newvalue])
587		1827
588	Returns the negative row number of the topmost line. Minimum value is	1828	Returns the row number of the topmost displayed line. Maximum value is
589	C<0>, which displays the normal terminal contents. Larger values scroll	1829	C<0>, which displays the normal terminal contents. Lower values scroll
590	this many lines into the scrollback buffer.	1830	this many lines into the scrollback buffer.
591		1831
592	=item $term->want_refresh	1832	=item $term->want_refresh
593		1833
594	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1834	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
597		1837
598	Used after changing terminal contents to display them.	1838	Used after changing terminal contents to display them.
599		1839
600	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1840	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
601		1841
602	Returns the text of the entire row with number C<$row_number>. Row C<0>	1842	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
603	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1843	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
604	terminal line. The scrollback buffer starts at line C<-1> and extends to
605	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1844	terminal line. Nothing will be returned if a nonexistent line
606	is requested.	1845	is requested.
607		1846
608	If C<$new_text> is specified, it will replace characters in the current	1847	If C<$new_text> is specified, it will replace characters in the current
609	line, starting at column C<$start_col> (default C<0>), which is useful	1848	line, starting at column C<$start_col> (default C<0>), which is useful
610	to replace only parts of a line. The font index in the rendition will	1849	to replace only parts of a line. The font index in the rendition will
611	automatically be updated.	1850	automatically be updated.
612		1851
613	C<$text> is in a special encoding: tabs and wide characters that use more	1852	C<$text> is in a special encoding: tabs and wide characters that use more
614	than one cell when displayed are padded with urxvt::NOCHAR characters	1853	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
615	(C<chr 65535>). Characters with combining characters and other characters	1854	characters. Characters with combining characters and other characters that
616	that do not fit into the normal tetx encoding will be replaced with	1855	do not fit into the normal text encoding will be replaced with characters
617	characters in the private use area.	1856	in the private use area.
618		1857
619	You have to obey this encoding when changing text. The advantage is	1858	You have to obey this encoding when changing text. The advantage is
620	that C<substr> and similar functions work on screen cells and not on	1859	that C<substr> and similar functions work on screen cells and not on
621	characters.	1860	characters.
622		1861
…		…
652	about the logical line that row C<$row_number> is part of. It supports the	1891	about the logical line that row C<$row_number> is part of. It supports the
653	following methods:	1892	following methods:
654		1893
655	=over 4	1894	=over 4
656		1895
657	=item $text = $line->t	1896	=item $text = $line->t ([$new_text])
658		1897
659	Returns the full text of the line, similar to C<ROW_t>	1898	Returns or replaces the full text of the line, similar to C<ROW_t>
660		1899
661	=item $rend = $line->r	1900	=item $rend = $line->r ([$new_rend])
662		1901
663	Returns the full rendition array of the line, similar to C<ROW_r>	1902	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
664		1903
665	=item $length = $line->l	1904	=item $length = $line->l
666		1905
667	Returns the length of the line in cells, similar to C<ROW_l>.	1906	Returns the length of the line in cells, similar to C<ROW_l>.
668		1907
…		…
673	Return the row number of the first/last row of the line, respectively.	1912	Return the row number of the first/last row of the line, respectively.
674		1913
675	=item $offset = $line->offset_of ($row, $col)	1914	=item $offset = $line->offset_of ($row, $col)
676		1915
677	Returns the character offset of the given row|col pair within the logical	1916	Returns the character offset of the given row|col pair within the logical
678	line.	1917	line. Works for rows outside the line, too, and returns corresponding
		1918	offsets outside the string.
679		1919
680	=item ($row, $col) = $line->coord_of ($offset)	1920	=item ($row, $col) = $line->coord_of ($offset)
681		1921
682	Translates a string offset into terminal coordinates again.	1922	Translates a string offset into terminal coordinates again.
683		1923
684	=back	1924	=back
685		1925
686	=cut	1926	=cut
687		1927
688	sub urxvt::term::line {	1928	sub line {
689	my ($self, $row) = @_;	1929	my ($self, $row) = @_;
690		1930
691	my $maxrow = $self->nrow - 1;	1931	my $maxrow = $self->nrow - 1;
692		1932
693	my ($beg, $end) = ($row, $row);	1933	my ($beg, $end) = ($row, $row);
…		…
697		1937
698	bless {	1938	bless {
699	term => $self,	1939	term => $self,
700	beg => $beg,	1940	beg => $beg,
701	end => $end,	1941	end => $end,
		1942	ncol => $self->ncol,
702	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1943	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
703	}, urxvt::line::	1944	}, urxvt::line::
704	}	1945	}
705		1946
706	sub urxvt::line::t {	1947	sub urxvt::line::t {
707	my ($self) = @_;	1948	my ($self) = @_;
708		1949
		1950	if (@_ > 1)
		1951	{
		1952	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1953	for $self->{beg} .. $self->{end};
		1954	}
		1955
		1956	defined wantarray &&
709	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1957	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
710	0, $self->{len}	1958	0, $self->{len}
711	}	1959	}
712		1960
713	sub urxvt::line::r {	1961	sub urxvt::line::r {
714	my ($self) = @_;	1962	my ($self) = @_;
715		1963
		1964	if (@_ > 1)
		1965	{
		1966	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1967	for $self->{beg} .. $self->{end};
		1968	}
		1969
		1970	if (defined wantarray) {
716	my $rend = [	1971	my $rend = [
717	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1972	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
718	];	1973	];
719	$#$rend = $self->{len} - 1;	1974	$#$rend = $self->{len} - 1;
720	$rend	1975	return $rend;
		1976	}
		1977
		1978	()
721	}	1979	}
722		1980
723	sub urxvt::line::beg { $_[0]{beg} }	1981	sub urxvt::line::beg { $_[0]{beg} }
724	sub urxvt::line::end { $_[0]{end} }	1982	sub urxvt::line::end { $_[0]{end} }
725	sub urxvt::line::l { $_[0]{len} }	1983	sub urxvt::line::l { $_[0]{len} }
726		1984
727	sub urxvt::line::offset_of {	1985	sub urxvt::line::offset_of {
728	my ($self, $row, $col) = @_;	1986	my ($self, $row, $col) = @_;
729		1987
730	($row - $self->{beg}) * $self->{term}->ncol + $col	1988	($row - $self->{beg}) * $self->{ncol} + $col
731	}	1989	}
732		1990
733	sub urxvt::line::coord_of {	1991	sub urxvt::line::coord_of {
734	my ($self, $offset) = @_;	1992	my ($self, $offset) = @_;
735		1993
736	use integer;	1994	use integer;
737		1995
738	(	1996	(
739	$offset / $self->{term}->ncol + $self->{beg},	1997	$offset / $self->{ncol} + $self->{beg},
740	$offset % $self->{term}->ncol	1998	$offset % $self->{ncol}
741	)	1999	)
742	}	2000	}
743		2001
744	=item ($row, $col) = $line->coord_of ($offset)
745	=item $text = $term->special_encode $string	2002	=item $text = $term->special_encode $string
746		2003
747	Converts a perl string into the special encoding used by rxvt-unicode,	2004	Converts a perl string into the special encoding used by rxvt-unicode,
748	where one character corresponds to one screen cell. See	2005	where one character corresponds to one screen cell. See
749	C<< $term->ROW_t >> for details.	2006	C<< $term->ROW_t >> for details.
750		2007
751	=item $string = $term->special_decode $text	2008	=item $string = $term->special_decode $text
752		2009
753	Converts rxvt-unicodes text reprsentation into a perl string. See	2010	Converts rxvt-unicodes text representation into a perl string. See
754	C<< $term->ROW_t >> for details.	2011	C<< $term->ROW_t >> for details.
755		2012
		2013	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
		2014
		2015	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2016
		2017	Register/unregister a synchronous button grab. See the XGrabButton
		2018	manpage.
		2019
		2020	=item $success = $term->grab ($eventtime[, $sync])
		2021
		2022	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		2023	synchronous (C<$sync> is true). Also remembers the grab timestamp.
		2024
		2025	=item $term->allow_events_async
		2026
		2027	Calls XAllowEvents with AsyncBoth for the most recent grab.
		2028
		2029	=item $term->allow_events_sync
		2030
		2031	Calls XAllowEvents with SyncBoth for the most recent grab.
		2032
		2033	=item $term->allow_events_replay
		2034
		2035	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		2036	recent grab.
		2037
		2038	=item $term->ungrab
		2039
		2040	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
		2041	evaluation errors, as it is better to lose the grab in the error case as
		2042	the session.
		2043
		2044	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		2045
		2046	=item $atom_name = $term->XGetAtomName ($atom)
		2047
		2048	=item @atoms = $term->XListProperties ($window)
		2049
		2050	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		2051
		2052	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		2053
		2054	=item $term->XDeleteProperty ($window, $property)
		2055
		2056	=item $window = $term->DefaultRootWindow
		2057
		2058	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		2059
		2060	=item $term->XMapWindow ($window)
		2061
		2062	=item $term->XUnmapWindow ($window)
		2063
		2064	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		2065
		2066	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		2067
		2068	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2069
		2070	=item $keysym = $term->XStringToKeysym ($string)
		2071
		2072	=item $string = $term->XKeysymToString ($keysym)
		2073
		2074	Various X or X-related functions. The C<$term> object only serves as
		2075	the source of the display, otherwise those functions map more-or-less
		2076	directly onto the X functions of the same name.
		2077
756	=back	2078	=back
		2079
		2080	=cut
		2081
		2082	package urxvt::popup;
		2083
		2084	=head2 The C<urxvt::popup> Class
		2085
		2086	=over 4
		2087
		2088	=cut
		2089
		2090	sub add_item {
		2091	my ($self, $item) = @_;
		2092
		2093	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		2094	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		2095	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		2096
		2097	$item->{render} ||= sub { $_[0]{text} };
		2098
		2099	push @{ $self->{item} }, $item;
		2100	}
		2101
		2102	=item $popup->add_title ($title)
		2103
		2104	Adds a non-clickable title to the popup.
		2105
		2106	=cut
		2107
		2108	sub add_title {
		2109	my ($self, $title) = @_;
		2110
		2111	$self->add_item ({
		2112	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		2113	text => $title,
		2114	activate => sub { },
		2115	});
		2116	}
		2117
		2118	=item $popup->add_separator ([$sepchr])
		2119
		2120	Creates a separator, optionally using the character given as C<$sepchr>.
		2121
		2122	=cut
		2123
		2124	sub add_separator {
		2125	my ($self, $sep) = @_;
		2126
		2127	$sep ||= "=";
		2128
		2129	$self->add_item ({
		2130	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		2131	text => "",
		2132	render => sub { $sep x $self->{term}->ncol },
		2133	activate => sub { },
		2134	});
		2135	}
		2136
		2137	=item $popup->add_button ($text, $cb)
		2138
		2139	Adds a clickable button to the popup. C<$cb> is called whenever it is
		2140	selected.
		2141
		2142	=cut
		2143
		2144	sub add_button {
		2145	my ($self, $text, $cb) = @_;
		2146
		2147	$self->add_item ({ type => "button", text => $text, activate => $cb});
		2148	}
		2149
		2150	=item $popup->add_toggle ($text, $initial_value, $cb)
		2151
		2152	Adds a toggle/checkbox item to the popup. The callback gets called
		2153	whenever it gets toggled, with a boolean indicating its new value as its
		2154	first argument.
		2155
		2156	=cut
		2157
		2158	sub add_toggle {
		2159	my ($self, $text, $value, $cb) = @_;
		2160
		2161	my $item; $item = {
		2162	type => "button",
		2163	text => " $text",
		2164	value => $value,
		2165	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		2166	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		2167	};
		2168
		2169	$self->add_item ($item);
		2170	}
		2171
		2172	=item $popup->show
		2173
		2174	Displays the popup (which is initially hidden).
		2175
		2176	=cut
		2177
		2178	sub show {
		2179	my ($self) = @_;
		2180
		2181	local $urxvt::popup::self = $self;
		2182
		2183	my $env = $self->{term}->env;
		2184	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		2185	delete $env->{LC_ALL};
		2186	$env->{LC_CTYPE} = $self->{term}->locale;
		2187
		2188	my $term = urxvt::term->new (
		2189	$env, "popup",
		2190	"--perl-lib" => "", "--perl-ext-common" => "",
		2191	"-pty-fd" => -1, "-sl" => 0,
		2192	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
		2193	"--transient-for" => $self->{term}->parent,
		2194	"-display" => $self->{term}->display_id,
		2195	"-pe" => "urxvt-popup",
		2196	) or die "unable to create popup window\n";
		2197
		2198	unless (delete $term->{urxvt_popup_init_done}) {
		2199	$term->ungrab;
		2200	$term->destroy;
		2201	die "unable to initialise popup window\n";
		2202	}
		2203	}
		2204
		2205	sub DESTROY {
		2206	my ($self) = @_;
		2207
		2208	delete $self->{term}{_destroy}{$self};
		2209	$self->{term}->ungrab;
		2210	}
		2211
		2212	=back
		2213
		2214	=cut
		2215
		2216	package urxvt::watcher;
757		2217
758	=head2 The C<urxvt::timer> Class	2218	=head2 The C<urxvt::timer> Class
759		2219
760	This class implements timer watchers/events. Time is represented as a	2220	This class implements timer watchers/events. Time is represented as a
761	fractional number of seconds since the epoch. Example:	2221	fractional number of seconds since the epoch. Example:
…		…
765	->new	2225	->new
766	->interval (1)	2226	->interval (1)
767	->cb (sub {	2227	->cb (sub {
768	$term->{overlay}->set (0, 0,	2228	$term->{overlay}->set (0, 0,
769	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2229	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
770	});	2230	});
771		2231
772	=over 4	2232	=over 4
773		2233
774	=item $timer = new urxvt::timer	2234	=item $timer = new urxvt::timer
775		2235
…		…
778		2238
779	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2239	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
780		2240
781	Set the callback to be called when the timer triggers.	2241	Set the callback to be called when the timer triggers.
782		2242
783	=item $tstamp = $timer->at
784
785	Return the time this watcher will fire next.
786
787	=item $timer = $timer->set ($tstamp)	2243	=item $timer = $timer->set ($tstamp[, $interval])
788		2244
789	Set the time the event is generated to $tstamp.	2245	Set the time the event is generated to $tstamp (and optionally specifies a
		2246	new $interval).
790		2247
791	=item $timer = $timer->interval ($interval)	2248	=item $timer = $timer->interval ($interval)
792		2249
793	Normally (and when C<$interval> is C<0>), the timer will automatically	2250	By default (and when C<$interval> is C<0>), the timer will automatically
794	stop after it has fired once. If C<$interval> is non-zero, then the timer	2251	stop after it has fired once. If C<$interval> is non-zero, then the timer
795	is automatically rescheduled at the given intervals.	2252	is automatically rescheduled at the given intervals.
796		2253
797	=item $timer = $timer->start	2254	=item $timer = $timer->start
798		2255
799	Start the timer.	2256	Start the timer.
800		2257
801	=item $timer = $timer->start ($tstamp)	2258	=item $timer = $timer->start ($tstamp[, $interval])
802		2259
803	Set the event trigger time to C<$tstamp> and start the timer.	2260	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2261	also replaces the interval.
		2262
		2263	=item $timer = $timer->after ($delay[, $interval])
		2264
		2265	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
804		2266
805	=item $timer = $timer->stop	2267	=item $timer = $timer->stop
806		2268
807	Stop the timer.	2269	Stop the timer.
808		2270
…		…
814		2276
815	$term->{socket} = ...	2277	$term->{socket} = ...
816	$term->{iow} = urxvt::iow	2278	$term->{iow} = urxvt::iow
817	->new	2279	->new
818	->fd (fileno $term->{socket})	2280	->fd (fileno $term->{socket})
819	->events (1) # wait for read data	2281	->events (urxvt::EV_READ)
820	->start	2282	->start
821	->cb (sub {	2283	->cb (sub {
822	my ($iow, $revents) = @_;	2284	my ($iow, $revents) = @_;
823	# $revents must be 1 here, no need to check	2285	# $revents must be 1 here, no need to check
824	sysread $term->{socket}, my $buf, 8192	2286	sysread $term->{socket}, my $buf, 8192
…		…
837	Set the callback to be called when io events are triggered. C<$reventmask>	2299	Set the callback to be called when io events are triggered. C<$reventmask>
838	is a bitset as described in the C<events> method.	2300	is a bitset as described in the C<events> method.
839		2301
840	=item $iow = $iow->fd ($fd)	2302	=item $iow = $iow->fd ($fd)
841		2303
842	Set the filedescriptor (not handle) to watch.	2304	Set the file descriptor (not handle) to watch.
843		2305
844	=item $iow = $iow->events ($eventmask)	2306	=item $iow = $iow->events ($eventmask)
845		2307
846	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2308	Set the event mask to watch. The only allowed values are
847	data, Bit #1 (value C<2>) enables watching for write data.	2309	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
		2310	together, or C<urxvt::EV_NONE>.
848		2311
849	=item $iow = $iow->start	2312	=item $iow = $iow->start
850		2313
851	Start watching for requested events on the given handle.	2314	Start watching for requested events on the given handle.
852		2315
853	=item $iow = $iow->stop	2316	=item $iow = $iow->stop
854		2317
855	Stop watching for events on the given filehandle.	2318	Stop watching for events on the given file handle.
		2319
		2320	=back
		2321
		2322	=head2 The C<urxvt::iw> Class
		2323
		2324	This class implements idle watchers, that get called automatically when
		2325	the process is idle. They should return as fast as possible, after doing
		2326	some useful work.
		2327
		2328	=over 4
		2329
		2330	=item $iw = new urxvt::iw
		2331
		2332	Create a new idle watcher object in stopped state.
		2333
		2334	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2335
		2336	Set the callback to be called when the watcher triggers.
		2337
		2338	=item $timer = $timer->start
		2339
		2340	Start the watcher.
		2341
		2342	=item $timer = $timer->stop
		2343
		2344	Stop the watcher.
		2345
		2346	=back
		2347
		2348	=head2 The C<urxvt::pw> Class
		2349
		2350	This class implements process watchers. They create an event whenever a
		2351	process exits, after which they stop automatically.
		2352
		2353	my $pid = fork;
		2354	...
		2355	$term->{pw} = urxvt::pw
		2356	->new
		2357	->start ($pid)
		2358	->cb (sub {
		2359	my ($pw, $exit_status) = @_;
		2360	...
		2361	});
		2362
		2363	=over 4
		2364
		2365	=item $pw = new urxvt::pw
		2366
		2367	Create a new process watcher in stopped state.
		2368
		2369	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2370
		2371	Set the callback to be called when the timer triggers.
		2372
		2373	=item $pw = $timer->start ($pid)
		2374
		2375	Tells the watcher to start watching for process C<$pid>.
		2376
		2377	=item $pw = $pw->stop
		2378
		2379	Stop the watcher.
856		2380
857	=back	2381	=back
858		2382
859	=head1 ENVIRONMENT	2383	=head1 ENVIRONMENT
860		2384
…		…
863	This variable controls the verbosity level of the perl extension. Higher	2387	This variable controls the verbosity level of the perl extension. Higher
864	numbers indicate more verbose output.	2388	numbers indicate more verbose output.
865		2389
866	=over 4	2390	=over 4
867		2391
868	=item =0 - only fatal messages	2392	=item == 0 - fatal messages
869		2393
870	=item =3 - script loading and management	2394	=item >= 3 - script loading and management
871		2395
872	=item =10 - all events received	2396	=item >=10 - all called hooks
		2397
		2398	=item >=11 - hook return values
873		2399
874	=back	2400	=back
875		2401
876	=head1 AUTHOR	2402	=head1 AUTHOR
877		2403
878	Marc Lehmann <pcg@goof.com>	2404	Marc Lehmann <schmorp@schmorp.de>
879	http://software.schmorp.de/pkg/rxvt-unicode	2405	http://software.schmorp.de/pkg/rxvt-unicode
880		2406
881	=cut	2407	=cut
882		2408
883	1	2409	1
		2410
		2411	# vim: sw=3:

Diff Legend

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