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

Diff Legend

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