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.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.213 by root, Wed Jun 6 15:09:49 2012 UTC

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

Diff Legend

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