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

Diff Legend

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