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.58 by root, Sun Jan 8 22:58:13 2006 UTC vs.
Revision 1.216 by root, Sun Jun 10 13:32:55 2012 UTC

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

Diff Legend

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