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.85 by root, Thu Jan 12 03:32:56 2006 UTC vs.
Revision 1.207 by root, Tue Jun 5 21:29:52 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 and	250	Uses per-line display filtering (C<on_line_update>) to underline text
90	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
91	resource C<urlLauncher> (default C<x-www-browser>) will be started.	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.
92		315
93	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
94		317
95	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
96	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
97	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.
98		393
99	=item example-refresh-hooks	394	=item example-refresh-hooks
100		395
101	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
102	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
103	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"
104		412
105	=back	413	=back
106		414
107	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
108		416
…		…
124		432
125	=over 4	433	=over 4
126		434
127	=item $text	435	=item $text
128		436
129	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
130	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.
131		439
132	=item $string	440	=item $string
133		441
134	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
…		…
138	=item $octets	446	=item $octets
139		447
140	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
141	locale-specific way.	449	locale-specific way.
142		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
143	=back	457	=back
144		458
145	=head2 Extension Objects	459	=head2 Extension Objects
146		460
147	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
148	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,
149	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
150	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
151	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
152	use.	467	internal use.
153		468
154	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
155	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
156		471
157	It has the following methods and data members:	472	It has the following methods and data members:
…		…
178	=head2 Hooks	493	=head2 Hooks
179		494
180	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
181	called whenever the relevant event happens.	496	called whenever the relevant event happens.
182		497
183	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
184	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
185		500
186	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
187	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
188	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.
189		504
190	I<< When in doubt, return a false value (preferably C<()>). >>	505	I<< When in doubt, return a false value (preferably C<()>). >>
191		506
192	=over 4	507	=over 4
193		508
194	=item on_init $term	509	=item on_init $term
195		510
196	Called after a new terminal object has been initialized, but before	511	Called after a new terminal object has been initialized, but before
197	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
198	call or deliver senseless data, as terminal size and other characteristics	513	call or deliver senseless data, as terminal size and other characteristics
199	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
200	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).
201		527
202	=item on_reset $term	528	=item on_reset $term
203		529
204	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
205	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
206	variables.	532	variables.
207		533
208	=item on_start $term	534	=item on_child_start $term, $pid
209		535
210	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.
211	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>.
212		542
213	=item on_sel_make $term, $eventtime	543	=item on_sel_make $term, $eventtime
214		544
215	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
216	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
…		…
223		553
224	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
225	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
226	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
227		557
228	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.
229		559
230	=item on_sel_extend $term	560	=item on_sel_extend $term
231		561
232	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
233	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
234	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
235	processing. This can happen multiple times, as long as the callback	565	processing. This can happen multiple times, as long as the callback
236	returns true, it will be called on every further click by the user and is	566	returns true, it will be called on every further click by the user and is
237	supposed to enlarge the selection more and more, if possible.	567	supposed to enlarge the selection more and more, if possible.
238		568
239	See the F<selection> example extension.	569	See the F<selection> example extension.
240		570
241	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
242		572
243	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
244	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
245	show this many lines of scrollback.	575	show this many lines of scrollback.
246		576
247	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
248		578
…		…
252		582
253	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,
254	$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
255	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
256		586
257	=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
258		598
259	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
260	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
261	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
262	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,
263	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
264	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	}
265		615
266	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,
267	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
268	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.
269		622
270	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
271		624
272	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
273	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
…		…
278	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
279		632
280	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
281	suppress or filter tty input.	634	suppress or filter tty input.
282		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
283	=item on_line_update $term, $row	643	=item on_line_update $term, $row
284		644
285	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
286	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
287	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,
…		…
294	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
295	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
296		656
297	=item on_refresh_begin $term	657	=item on_refresh_begin $term
298		658
299	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
300	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
301	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
302	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
303		663
304	=item on_refresh_end $term	664	=item on_refresh_end $term
305		665
306	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>.
307		667
308	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
309		669
310	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
311	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>
312	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.
313		699
314	=item on_focus_in $term	700	=item on_focus_in $term
315		701
316	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
317	does focus in processing.	703	does focus in processing.
318		704
319	=item on_focus_out $term	705	=item on_focus_out $term
320		706
321	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
322	focus out processing.	708	focus out processing.
323		709
		710	=item on_configure_notify $term, $event
		711
		712	=item on_property_notify $term, $event
		713
324	=item on_key_press $term, $event, $keysym, $octets	714	=item on_key_press $term, $event, $keysym, $octets
325		715
326	=item on_key_release $term, $event, $keysym	716	=item on_key_release $term, $event, $keysym
327		717
328	=item on_button_press $term, $event	718	=item on_button_press $term, $event
…		…
333		723
334	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
335		725
336	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
337		727
338	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
339	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.
340		730
341	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
342	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
343	and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
344		734
345	C<on_key_press> additionally receives the string rxvt-unicode would	735	C<on_key_press> additionally receives the string rxvt-unicode would
346	output, if any, in locale-specific encoding.	736	output, if any, in locale-specific encoding.
347		737
348	subwindow.	738	subwindow.
		739
		740	=item on_client_message $term, $event
		741
		742	=item on_wm_protocols $term, $event
		743
		744	=item on_wm_delete_window $term, $event
		745
		746	Called when various types of ClientMessage events are received (all with
		747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
349		752
350	=back	753	=back
351		754
352	=cut	755	=cut
353		756
…		…
359	use Scalar::Util ();	762	use Scalar::Util ();
360	use List::Util ();	763	use List::Util ();
361		764
362	our $VERSION = 1;	765	our $VERSION = 1;
363	our $TERM;	766	our $TERM;
		767	our @TERM_INIT;
		768	our @TERM_EXT;
364	our @HOOKNAME;	769	our @HOOKNAME;
365	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
366	our %OPTION;	771	our %OPTION;
367		772
368	our $LIBDIR;	773	our $LIBDIR;
369	our $RESNAME;	774	our $RESNAME;
370	our $RESCLASS;	775	our $RESCLASS;
371	our $RXVTNAME;	776	our $RXVTNAME;
372		777
		778	our $NOCHAR = chr 0xffff;
		779
373	=head2 Variables in the C<urxvt> Package	780	=head2 Variables in the C<urxvt> Package
374		781
375	=over 4	782	=over 4
376		783
377	=item $urxvt::LIBDIR	784	=item $urxvt::LIBDIR
…		…
390	=item $urxvt::TERM	797	=item $urxvt::TERM
391		798
392	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
393	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
394		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
395	=back	818	=back
396		819
397	=head2 Functions in the C<urxvt> Package	820	=head2 Functions in the C<urxvt> Package
398		821
399	=over 4	822	=over 4
400		823
401	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
402		825
403	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
404	costs! The only time this is acceptable is when the terminal process	827	include a trailing newline). Avoid at all costs! The only time this
405	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
406		830
407	=item urxvt::warn $string	831	=item urxvt::warn $string
408		832
409	Calls C<rxvt_warn> with the given string which should not include a	833	Calls C<rxvt_warn> with the given string which should include a trailing
410	newline. The module also overwrites the C<warn> builtin with a function	834	newline. The module also overwrites the C<warn> builtin with a function
411	that calls this function.	835	that calls this function.
412		836
413	Using this function has the advantage that its output ends up in the	837	Using this function has the advantage that its output ends up in the
414	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
415		839
416	Messages have a size limit of 1023 bytes currently.	840	Messages have a size limit of 1023 bytes currently.
417		841
418	=item $is_safe = urxvt::safe	842	=item @terms = urxvt::termlist
419		843
420	Returns true when it is safe to do potentially unsafe things, such as	844	Returns all urxvt::term objects that exist in this process, regardless of
421	evaluating perl code specified by the user. This is true when urxvt was	845	whether they are started, being destroyed etc., so be careful. Only term
422	started setuid or setgid.	846	objects that have perl extensions attached will be returned (because there
		847	is no urxvt::term object associated with others).
423		848
424	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
425		850
426	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
427		852
428	=item urxvt::CurrentTime	853	=item urxvt::CurrentTime
429		854
430	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	855	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
431	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	856	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
432	Button4Mask, Button5Mask, AnyModifier	857	Button4Mask, Button5Mask, AnyModifier
		858
		859	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		860	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		861	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		862	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		863	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		864	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		865	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		866
		867	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		868	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		869	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		870	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		871	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		872	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		873	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
433		874
434	Various constants for use in X calls and event processing.	875	Various constants for use in X calls and event processing.
435		876
436	=back	877	=back
437		878
…		…
454		895
455	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
456		897
457	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
458		899
459	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
460		902
461	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
462	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
463	the bitset.	905	the bitset.
464		906
…		…
470		912
471	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
472		914
473	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	915	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
474		916
		917	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		918
475	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
476	specified one.	920	specified one.
477		921
478	=item $value = urxvt::GET_CUSTOM $rend	922	=item $value = urxvt::GET_CUSTOM $rend
479		923
…		…
488	=back	932	=back
489		933
490	=cut	934	=cut
491		935
492	BEGIN {	936	BEGIN {
493	urxvt->bootstrap;
494
495	# overwrite perl's warn	937	# overwrite perl's warn
496	*CORE::GLOBAL::warn = sub {	938	*CORE::GLOBAL::warn = sub {
497	my $msg = join "", @_;	939	my $msg = join "", @_;
498	$msg .= "\n"	940	$msg .= "\n"
499	unless $msg =~ /\n$/;	941	unless $msg =~ /\n$/;
500	urxvt::warn ($msg);	942	urxvt::warn ($msg);
501	};	943	};
502
503	# %ENV is the original startup environment
504	delete $ENV{IFS};
505	delete $ENV{CDPATH};
506	delete $ENV{BASH_ENV};
507	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
508	}	944	}
509		945
510	my @hook_count;	946	no warnings 'utf8';
		947
		948	sub perl_libdirs {
		949	map { split /:/ }
		950	$_[0]->resource ("perl_lib"),
		951	$ENV{URXVT_PERL_LIB},
		952	"$ENV{HOME}/.urxvt/ext",
		953	"$LIBDIR/perl"
		954	}
		955
		956	our %META; # meta header information from scripts
		957	our %SCAN; # which dirs already scanned
		958
		959	sub resource {
		960	my ($term, $name, $isarg, $flag, $value) = @_;
		961
		962	for my $dir (perl_libdirs $term) {
		963	}
		964
		965	warn "resourece<@_>\n";#d#
		966
		967	0
		968	}
		969
511	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	970	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
512		971
513	sub verbose {	972	sub verbose {
514	my ($level, $msg) = @_;	973	my ($level, $msg) = @_;
515	warn "$msg\n" if $level <= $verbosity;	974	warn "$msg\n" if $level <= $verbosity;
516	}	975	}
517		976
518	my $extension_pkg = "extension0000";
519	my %extension_pkg;	977	my %extension_pkg;
520		978
521	# load a single script into its own package, once only	979	# load a single script into its own package, once only
522	sub extension_package($) {	980	sub extension_package($) {
523	my ($path) = @_;	981	my ($path) = @_;
524		982
525	$extension_pkg{$path} ||= do {	983	$extension_pkg{$path} ||= do {
526	my $pkg = "urxvt::" . ($extension_pkg++);	984	$path =~ /([^\/\\]+)$/;
		985	my $pkg = $1;
		986	$pkg =~ s/[^[:word:]]/_/g;
		987	$pkg = "urxvt::ext::$pkg";
527		988
528	verbose 3, "loading extension '$path' into package '$pkg'";	989	verbose 3, "loading extension '$path' into package '$pkg'";
529		990
530	open my $fh, "<:raw", $path	991	open my $fh, "<:raw", $path
531	or die "$path: $!";	992	or die "$path: $!";
532		993
533	my $source = untaint	994	my $source =
534	"package $pkg; use strict; use utf8;\n"	995	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
535	. "use base urxvt::term::extension::;\n"
536	. "#line 1 \"$path\"\n{\n"	996	. "#line 1 \"$path\"\n{\n"
537	. (do { local $/; <$fh> })	997	. (do { local $/; <$fh> })
538	. "\n};\n1";	998	. "\n};\n1";
539		999
540	eval $source	1000	eval $source
…		…
550	sub invoke {	1010	sub invoke {
551	local $TERM = shift;	1011	local $TERM = shift;
552	my $htype = shift;	1012	my $htype = shift;
553		1013
554	if ($htype == 0) { # INIT	1014	if ($htype == 0) { # INIT
555	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1015	my @dirs = perl_libdirs $TERM;
556		1016
557	my %ext_arg;	1017	my %ext_arg;
558		1018
		1019	{
		1020	my @init = @TERM_INIT;
		1021	@TERM_INIT = ();
		1022	$_->($TERM) for @init;
		1023	my @pkg = @TERM_EXT;
		1024	@TERM_EXT = ();
		1025	$TERM->register_package ($_) for @pkg;
		1026	}
		1027
559	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1028	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
560	if ($_ eq "default") {	1029	if ($_ eq "default") {
561	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	1030	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
562	} elsif (/^-(.*)$/) {	1031	} elsif (/^-(.*)$/) {
563	delete $ext_arg{$1};	1032	delete $ext_arg{$1};
564	} elsif (/^([^<]+)<(.*)>$/) {	1033	} elsif (/^([^<]+)<(.*)>$/) {
565	push @{ $ext_arg{$1} }, $2;	1034	push @{ $ext_arg{$1} }, $2;
566	} else {	1035	} else {
567	$ext_arg{$_} ||= [];	1036	$ext_arg{$_} ||= [];
568	}	1037	}
569	}	1038	}
570		1039
571	while (my ($ext, $argv) = each %ext_arg) {	1040	for my $ext (sort keys %ext_arg) {
572	my @files = grep -f $_, map "$_/$ext", @dirs;	1041	my @files = grep -f $_, map "$_/$ext", @dirs;
573		1042
574	if (@files) {	1043	if (@files) {
575	$TERM->register_package (extension_package $files[0], $argv);	1044	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
576	} else {	1045	} else {
577	warn "perl extension '$ext' not found in perl library search path\n";	1046	warn "perl extension '$ext' not found in perl library search path\n";
578	}	1047	}
579	}	1048	}
580		1049
…		…
586		1055
587	if (my $cb = $TERM->{_hook}[$htype]) {	1056	if (my $cb = $TERM->{_hook}[$htype]) {
588	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1057	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
589	if $verbosity >= 10;	1058	if $verbosity >= 10;
590		1059
591	keys %$cb;	1060	for my $pkg (keys %$cb) {
592
593	while (my ($pkg, $cb) = each %$cb) {
594	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1061	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
595	and last;	1062	$retval ||= $retval_;
596		1063
597	if ($@) {	1064	if ($@) {
598	$TERM->ungrab; # better to lose the grab than the session	1065	$TERM->ungrab; # better to lose the grab than the session
599	warn $@;	1066	warn $@;
600	}	1067	}
…		…
603	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	1070	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
604	if $verbosity >= 11;	1071	if $verbosity >= 11;
605	}	1072	}
606		1073
607	if ($htype == 1) { # DESTROY	1074	if ($htype == 1) { # DESTROY
608	if (my $hook = delete $TERM->{_hook}) {
609	for my $htype (0..$#$hook) {
610	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
611	or set_should_invoke $htype, 0;
612	}
613	}
614
615	# clear package objects	1075	# clear package objects
616	%$_ = () for values %{ $TERM->{_pkg} };	1076	%$_ = () for values %{ $TERM->{_pkg} };
617		1077
618	# clear package	1078	# clear package
619	%$TERM = ();	1079	%$TERM = ();
620	}	1080	}
621		1081
622	$retval	1082	$retval
623	}	1083	}
624		1084
625	sub exec_async(@) {	1085	sub SET_COLOR($$$) {
626	my $pid = fork;	1086	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1087	}
627		1088
628	return	1089	sub rend2mask {
629	if !defined $pid or $pid;	1090	no strict 'refs';
630		1091	my ($str, $mask) = (@_, 0);
631	%ENV = %{ $TERM->env };	1092	my %color = ( fg => undef, bg => undef );
632		1093	my @failed;
633	exec @_;	1094	for my $spec ( split /\s+/, $str ) {
634	_exit 255;	1095	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1096	$color{lc($1)} = $2;
		1097	} else {
		1098	my $neg = $spec =~ s/^[-^]//;
		1099	unless ( exists &{"RS_$spec"} ) {
		1100	push @failed, $spec;
		1101	next;
		1102	}
		1103	my $cur = &{"RS_$spec"};
		1104	if ( $neg ) {
		1105	$mask &= ~$cur;
		1106	} else {
		1107	$mask |= $cur;
		1108	}
		1109	}
		1110	}
		1111	($mask, @color{qw(fg bg)}, \@failed)
635	}	1112	}
636		1113
637	# urxvt::term::extension	1114	# urxvt::term::extension
638		1115
639	package urxvt::term::extension;	1116	package urxvt::term::extension;
…		…
645	while (my ($name, $cb) = each %hook) {	1122	while (my ($name, $cb) = each %hook) {
646	my $htype = $HOOKTYPE{uc $name};	1123	my $htype = $HOOKTYPE{uc $name};
647	defined $htype	1124	defined $htype
648	or Carp::croak "unsupported hook type '$name'";	1125	or Carp::croak "unsupported hook type '$name'";
649		1126
		1127	$self->set_should_invoke ($htype, +1)
650	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1128	unless exists $self->{term}{_hook}[$htype]{$pkg};
651	$hook_count[$htype]++
652	or urxvt::set_should_invoke $htype, 1;
653	}
654		1129
655	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1130	$self->{term}{_hook}[$htype]{$pkg} = $cb;
656	}	1131	}
657	}	1132	}
658		1133
…		…
663	for my $name (@hook) {	1138	for my $name (@hook) {
664	my $htype = $HOOKTYPE{uc $name};	1139	my $htype = $HOOKTYPE{uc $name};
665	defined $htype	1140	defined $htype
666	or Carp::croak "unsupported hook type '$name'";	1141	or Carp::croak "unsupported hook type '$name'";
667		1142
		1143	$self->set_should_invoke ($htype, -1)
668	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1144	if delete $self->{term}{_hook}[$htype]{$pkg};
669	--$hook_count[$htype]
670	or urxvt::set_should_invoke $htype, 0;
671	}
672	}	1145	}
673	}	1146	}
674		1147
675	our $AUTOLOAD;	1148	our $AUTOLOAD;
676		1149
…		…
714	is that you cannot use blocking APIs, but the non-blocking variant should	1187	is that you cannot use blocking APIs, but the non-blocking variant should
715	work.	1188	work.
716		1189
717	=cut	1190	=cut
718		1191
719	our $VERSION = 1;	1192	our $VERSION = '5.23';
720		1193
721	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1194	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
722	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1195	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
723		1196
724	sub timer {	1197	sub timer {
…		…
726		1199
727	my $cb = $arg{cb};	1200	my $cb = $arg{cb};
728		1201
729	urxvt::timer	1202	urxvt::timer
730	->new	1203	->new
731	->start (urxvt::NOW + $arg{after})	1204	->after ($arg{after}, $arg{interval})
732	->cb (sub {	1205	->cb ($arg{interval} ? $cb : sub {
733	$_[0]->stop; # need to cancel manually	1206	$_[0]->stop; # need to cancel manually
734	$cb->();	1207	$cb->();
735	})	1208	})
736	}	1209	}
737		1210
738	sub io {	1211	sub io {
739	my ($class, %arg) = @_;	1212	my ($class, %arg) = @_;
740		1213
741	my $cb = $arg{cb};	1214	my $cb = $arg{cb};
		1215	my $fd = fileno $arg{fh};
		1216	defined $fd or $fd = $arg{fh};
742		1217
743	bless [$arg{fh}, urxvt::iow	1218	bless [$arg{fh}, urxvt::iow
744	->new	1219	->new
745	->fd (fileno $arg{fh})	1220	->fd ($fd)
746	->events (($arg{poll} =~ /r/ ? 1 : 0)	1221	->events (($arg{poll} =~ /r/ ? 1 : 0)
747	| ($arg{poll} =~ /w/ ? 2 : 0))	1222	| ($arg{poll} =~ /w/ ? 2 : 0))
748	->start	1223	->start
749	->cb (sub {	1224	->cb ($cb)
750	$cb->(($_[1] & 1 ? 'r' : '')
751	. ($_[1] & 2 ? 'w' : ''));
752	})],
753	urxvt::anyevent::	1225	], urxvt::anyevent::
		1226	}
		1227
		1228	sub idle {
		1229	my ($class, %arg) = @_;
		1230
		1231	my $cb = $arg{cb};
		1232
		1233	urxvt::iw
		1234	->new
		1235	->start
		1236	->cb ($cb)
		1237	}
		1238
		1239	sub child {
		1240	my ($class, %arg) = @_;
		1241
		1242	my $cb = $arg{cb};
		1243
		1244	urxvt::pw
		1245	->new
		1246	->start ($arg{pid})
		1247	->cb (sub {
		1248	$_[0]->stop; # need to cancel manually
		1249	$cb->($_[0]->rpid, $_[0]->rstatus);
		1250	})
754	}	1251	}
755		1252
756	sub DESTROY {	1253	sub DESTROY {
757	$_[0][1]->stop;	1254	$_[0][1]->stop;
758	}	1255	}
759		1256
760	sub condvar {	1257	# only needed for AnyEvent < 6 compatibility
761	bless \my $flag, urxvt::anyevent::condvar::	1258	sub one_event {
762	}
763
764	sub urxvt::anyevent::condvar::broadcast {
765	${$_[0]}++;
766	}
767
768	sub urxvt::anyevent::condvar::wait {
769	unless (${$_[0]}) {
770	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1259	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
771	}
772	}	1260	}
773		1261
774	package urxvt::term;	1262	package urxvt::term;
775		1263
776	=head2 The C<urxvt::term> Class	1264	=head2 The C<urxvt::term> Class
…		…
781		1269
782	# find on_xxx subs in the package and register them	1270	# find on_xxx subs in the package and register them
783	# as hooks	1271	# as hooks
784	sub register_package {	1272	sub register_package {
785	my ($self, $pkg, $argv) = @_;	1273	my ($self, $pkg, $argv) = @_;
		1274
		1275	no strict 'refs';
		1276
		1277	urxvt::verbose 6, "register package $pkg to $self";
		1278
		1279	@{"$pkg\::ISA"} = urxvt::term::extension::;
786		1280
787	my $proxy = bless {	1281	my $proxy = bless {
788	_pkg => $pkg,	1282	_pkg => $pkg,
789	argv => $argv,	1283	argv => $argv,
790	}, $pkg;	1284	}, $pkg;
…		…
806	hash which defines the environment of the new terminal.	1300	hash which defines the environment of the new terminal.
807		1301
808	Croaks (and probably outputs an error message) if the new instance	1302	Croaks (and probably outputs an error message) if the new instance
809	couldn't be created. Returns C<undef> if the new instance didn't	1303	couldn't be created. Returns C<undef> if the new instance didn't
810	initialise perl, and the terminal object otherwise. The C<init> and	1304	initialise perl, and the terminal object otherwise. The C<init> and
811	C<start> hooks will be called during this call.	1305	C<start> hooks will be called before this call returns, and are free to
		1306	refer to global data (which is race free).
812		1307
813	=cut	1308	=cut
814		1309
815	sub new {	1310	sub new {
816	my ($class, $env, @args) = @_;	1311	my ($class, $env, @args) = @_;
817		1312
		1313	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1314	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1315
818	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1316	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
819	}	1317	}
820		1318
821	=item $term->destroy	1319	=item $term->destroy
822		1320
823	Destroy the terminal object (close the window, free resources	1321	Destroy the terminal object (close the window, free resources
824	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1322	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
825	watchers (timers, io watchers) are still active.	1323	watchers (timers, io watchers) are still active.
826		1324
		1325	=item $term->exec_async ($cmd[, @args])
		1326
		1327	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1328	("starts") programs in the background. This function takes care of setting
		1329	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1330	be preferred over explicit calls to C<exec> or C<system>.
		1331
		1332	Returns the pid of the subprocess or C<undef> on error.
		1333
		1334	=cut
		1335
		1336	sub exec_async {
		1337	my $self = shift;
		1338
		1339	my $pid = fork;
		1340
		1341	return $pid
		1342	if !defined $pid or $pid;
		1343
		1344	%ENV = %{ $self->env };
		1345
		1346	exec @_;
		1347	urxvt::_exit 255;
		1348	}
		1349
827	=item $isset = $term->option ($optval[, $set])	1350	=item $isset = $term->option ($optval[, $set])
828		1351
829	Returns true if the option specified by C<$optval> is enabled, and	1352	Returns true if the option specified by C<$optval> is enabled, and
830	optionally change it. All option values are stored by name in the hash	1353	optionally change it. All option values are stored by name in the hash
831	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1354	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
832		1355
833	Here is a a likely non-exhaustive list of option names, please see the	1356	Here is a likely non-exhaustive list of option names, please see the
834	source file F</src/optinc.h> to see the actual list:	1357	source file F</src/optinc.h> to see the actual list:
835		1358
836	borderLess console cursorBlink cursorUnderline hold iconic insecure	1359	borderLess buffered console cursorBlink cursorUnderline hold iconic
837	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1360	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1361	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
838	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1362	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
839	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1363	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
840	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1364	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
841	tripleclickwords utmpInhibit visualBell	1365	urgentOnBell utmpInhibit visualBell
842		1366
843	=item $value = $term->resource ($name[, $newval])	1367	=item $value = $term->resource ($name[, $newval])
844		1368
845	Returns the current resource value associated with a given name and	1369	Returns the current resource value associated with a given name and
846	optionally sets a new value. Setting values is most useful in the C<init>	1370	optionally sets a new value. Setting values is most useful in the C<init>
…		…
855	likely change).	1379	likely change).
856		1380
857	Please note that resource strings will currently only be freed when the	1381	Please note that resource strings will currently only be freed when the
858	terminal is destroyed, so changing options frequently will eat memory.	1382	terminal is destroyed, so changing options frequently will eat memory.
859		1383
860	Here is a a likely non-exhaustive list of resource names, not all of which	1384	Here is a likely non-exhaustive list of resource names, not all of which
861	are supported in every build, please see the source file F</src/rsinc.h>	1385	are supported in every build, please see the source file F</src/rsinc.h>
862	to see the actual list:	1386	to see the actual list:
863		1387
864	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1388	answerbackstring backgroundPixmap backspace_key blendtype blurradius
865	borderLess color cursorBlink cursorUnderline cutchars delete_key	1389	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
866	display_name embed ext_bwidth fade font geometry hold iconName	1390	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
867	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1391	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1392	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
868	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1393	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
869	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1394	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
870	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1395	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
871	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1396	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
872	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1397	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
873	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1398	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
874	shade term_name title transparent transparent_all tripleclickwords	1399	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1400	term_name title transient_for transparent tripleclickwords urgentOnBell
875	utmpInhibit visualBell	1401	utmpInhibit visualBell
876		1402
877	=cut	1403	=cut
878		1404
879	sub resource($$;$) {	1405	sub resource($$;$) {
880	my ($self, $name) = (shift, shift);	1406	my ($self, $name) = (shift, shift);
881	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1407	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
882	&urxvt::term::_resource	1408	goto &urxvt::term::_resource
883	}	1409	}
884		1410
885	=item $value = $term->x_resource ($pattern)	1411	=item $value = $term->x_resource ($pattern)
886		1412
887	Returns the X-Resource for the given pattern, excluding the program or	1413	Returns the X-Resource for the given pattern, excluding the program or
…		…
891		1417
892	This method should only be called during the C<on_start> hook, as there is	1418	This method should only be called during the C<on_start> hook, as there is
893	only one resource database per display, and later invocations might return	1419	only one resource database per display, and later invocations might return
894	the wrong resources.	1420	the wrong resources.
895		1421
896	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1422	=item $success = $term->parse_keysym ($key, $octets)
897		1423
898	Adds a keymap translation exactly as specified via a resource. See the	1424	Adds a key binding exactly as specified via a resource. See the
899	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1425	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1426
		1427	=item $term->register_command ($keysym, $modifiermask, $string)
		1428
		1429	Adds a key binding. This is a lower level api compared to
		1430	C<parse_keysym>, as it expects a parsed key description, and can be
		1431	used only inside either the C<on_init> hook, to add a binding, or the
		1432	C<on_register_command> hook, to modify a parsed binding.
900		1433
901	=item $rend = $term->rstyle ([$new_rstyle])	1434	=item $rend = $term->rstyle ([$new_rstyle])
902		1435
903	Return and optionally change the current rendition. Text that is output by	1436	Return and optionally change the current rendition. Text that is output by
904	the terminal application will use this style.	1437	the terminal application will use this style.
…		…
912		1445
913	=item ($row, $col) = $term->selection_beg ([$row, $col])	1446	=item ($row, $col) = $term->selection_beg ([$row, $col])
914		1447
915	=item ($row, $col) = $term->selection_end ([$row, $col])	1448	=item ($row, $col) = $term->selection_end ([$row, $col])
916		1449
917	Return the current values of the selection mark, begin or end positions,	1450	Return the current values of the selection mark, begin or end positions.
918	and optionally set them to new values.
919		1451
		1452	When arguments are given, then the selection coordinates are set to
		1453	C<$row> and C<$col>, and the selection screen is set to the current
		1454	screen.
		1455
		1456	=item $screen = $term->selection_screen ([$screen])
		1457
		1458	Returns the current selection screen, and then optionally sets it.
		1459
		1460	=item $term->selection_make ($eventtime[, $rectangular])
		1461
		1462	Tries to make a selection as set by C<selection_beg> and
		1463	C<selection_end>. If C<$rectangular> is true (default: false), a
		1464	rectangular selection will be made. This is the preferred function to make
		1465	a selection.
		1466
920	=item $success = $term->selection_grab ($eventtime)	1467	=item $success = $term->selection_grab ($eventtime[, $clipboard])
921		1468
922	Try to request the primary selection from the server (for example, as set	1469	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
923	by the next method).	1470	true) selection from the server. The corresponding text can be set
		1471	with the next method. No visual feedback will be given. This function
		1472	is mostly useful from within C<on_sel_grab> hooks.
924		1473
925	=item $oldtext = $term->selection ([$newtext])	1474	=item $oldtext = $term->selection ([$newtext, $clipboard])
926		1475
927	Return the current selection text and optionally replace it by C<$newtext>.	1476	Return the current selection (clipboard if C<$clipboard> is true) text
		1477	and optionally replace it by C<$newtext>.
		1478
		1479	=item $term->selection_clear ([$clipboard])
		1480
		1481	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
928		1482
929	=item $term->overlay_simple ($x, $y, $text)	1483	=item $term->overlay_simple ($x, $y, $text)
930		1484
931	Create a simple multi-line overlay box. See the next method for details.	1485	Create a simple multi-line overlay box. See the next method for details.
932		1486
…		…
962		1516
963	The methods currently supported on C<urxvt::overlay> objects are:	1517	The methods currently supported on C<urxvt::overlay> objects are:
964		1518
965	=over 4	1519	=over 4
966		1520
967	=item $overlay->set ($x, $y, $text, $rend)	1521	=item $overlay->set ($x, $y, $text[, $rend])
968		1522
969	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1523	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
970	text in rxvt-unicode's special encoding and an array of rendition values	1524	text in rxvt-unicode's special encoding and an array of rendition values
971	at a specific position inside the overlay.	1525	at a specific position inside the overlay.
		1526
		1527	If C<$rend> is missing, then the rendition will not be changed.
972		1528
973	=item $overlay->hide	1529	=item $overlay->hide
974		1530
975	If visible, hide the overlay, but do not destroy it.	1531	If visible, hide the overlay, but do not destroy it.
976		1532
…		…
1021	Convert the given locale-encoded octets into a perl string.	1577	Convert the given locale-encoded octets into a perl string.
1022		1578
1023	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1579	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1024		1580
1025	XORs the rendition values in the given span with the provided value	1581	XORs the rendition values in the given span with the provided value
1026	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1582	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1027	to the selection.	1583	refresh hooks to provide effects similar to the selection.
1028		1584
1029	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1585	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1030		1586
1031	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1587	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1032	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1588	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1033	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1589	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1034	it instead.	1590	it instead. Both styles I<MUST NOT> contain font styles.
1035		1591
1036	=item $term->scr_bell	1592	=item $term->scr_bell
1037		1593
1038	Ring the bell!	1594	Ring the bell!
1039		1595
…		…
1046		1602
1047	Normally its not a good idea to use this function, as programs might be	1603	Normally its not a good idea to use this function, as programs might be
1048	confused by changes in cursor position or scrolling. Its useful inside a	1604	confused by changes in cursor position or scrolling. Its useful inside a
1049	C<on_add_lines> hook, though.	1605	C<on_add_lines> hook, though.
1050		1606
		1607	=item $term->scr_change_screen ($screen)
		1608
		1609	Switch to given screen - 0 primary, 1 secondary.
		1610
1051	=item $term->cmd_parse ($octets)	1611	=item $term->cmd_parse ($octets)
1052		1612
1053	Similar to C<scr_add_lines>, but the argument must be in the	1613	Similar to C<scr_add_lines>, but the argument must be in the
1054	locale-specific encoding of the terminal and can contain command sequences	1614	locale-specific encoding of the terminal and can contain command sequences
1055	(escape codes) that will be interpreted.	1615	(escape codes) that will be interpreted.
1056		1616
1057	=item $term->tt_write ($octets)	1617	=item $term->tt_write ($octets)
1058		1618
1059	Write the octets given in C<$data> to the tty (i.e. as program input). To	1619	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1060	pass characters instead of octets, you should convert your strings first	1620	pass characters instead of octets, you should convert your strings first
1061	to the locale-specific encoding using C<< $term->locale_encode >>.	1621	to the locale-specific encoding using C<< $term->locale_encode >>.
		1622
		1623	=item $term->tt_paste ($octets)
		1624
		1625	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1626	CR and bracketing the data with control sequences if bracketed paste mode
		1627	is set.
1062		1628
1063	=item $old_events = $term->pty_ev_events ([$new_events])	1629	=item $old_events = $term->pty_ev_events ([$new_events])
1064		1630
1065	Replaces the event mask of the pty watcher by the given event mask. Can	1631	Replaces the event mask of the pty watcher by the given event mask. Can
1066	be used to suppress input and output handling to the pty/tty. See the	1632	be used to suppress input and output handling to the pty/tty. See the
1067	description of C<< urxvt::timer->events >>. Make sure to always restore	1633	description of C<< urxvt::timer->events >>. Make sure to always restore
1068	the previous value.	1634	the previous value.
1069		1635
		1636	=item $fd = $term->pty_fd
		1637
		1638	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1639	is used.
		1640
1070	=item $windowid = $term->parent	1641	=item $windowid = $term->parent
1071		1642
1072	Return the window id of the toplevel window.	1643	Return the window id of the toplevel window.
1073		1644
1074	=item $windowid = $term->vt	1645	=item $windowid = $term->vt
1075		1646
1076	Return the window id of the terminal window.	1647	Return the window id of the terminal window.
1077		1648
		1649	=item $term->vt_emask_add ($x_event_mask)
		1650
		1651	Adds the specified events to the vt event mask. Useful e.g. when you want
		1652	to receive pointer events all the times:
		1653
		1654	$term->vt_emask_add (urxvt::PointerMotionMask);
		1655
		1656	=item $term->set_urgency ($set)
		1657
		1658	Enable/disable the urgency hint on the toplevel window.
		1659
		1660	=item $term->focus_in
		1661
		1662	=item $term->focus_out
		1663
		1664	=item $term->key_press ($state, $keycode[, $time])
		1665
		1666	=item $term->key_release ($state, $keycode[, $time])
		1667
		1668	Deliver various fake events to to terminal.
		1669
1078	=item $window_width = $term->width	1670	=item $window_width = $term->width
1079		1671
1080	=item $window_height = $term->height	1672	=item $window_height = $term->height
1081		1673
1082	=item $font_width = $term->fwidth	1674	=item $font_width = $term->fwidth
…		…
1095		1687
1096	=item $max_scrollback = $term->saveLines	1688	=item $max_scrollback = $term->saveLines
1097		1689
1098	=item $nrow_plus_saveLines = $term->total_rows	1690	=item $nrow_plus_saveLines = $term->total_rows
1099		1691
1100	=item $lines_in_scrollback = $term->nsaved	1692	=item $topmost_scrollback_row = $term->top_row
1101		1693
1102	Return various integers describing terminal characteristics.	1694	Return various integers describing terminal characteristics.
1103		1695
1104	=item $x_display = $term->display_id	1696	=item $x_display = $term->display_id
1105		1697
…		…
1112	=item $env = $term->env	1704	=item $env = $term->env
1113		1705
1114	Returns a copy of the environment in effect for the terminal as a hashref	1706	Returns a copy of the environment in effect for the terminal as a hashref
1115	similar to C<\%ENV>.	1707	similar to C<\%ENV>.
1116		1708
		1709	=item @envv = $term->envv
		1710
		1711	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1712
		1713	=item @argv = $term->argv
		1714
		1715	Return the argument vector as this terminal, similar to @ARGV, but
		1716	includes the program name as first element.
		1717
1117	=cut	1718	=cut
1118		1719
1119	sub env {	1720	sub env {
1120	if (my $env = $_[0]->_env) {
1121	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1721	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1122	} else {
1123	+{ %ENV }
1124	}
1125	}	1722	}
1126		1723
1127	=item $modifiermask = $term->ModLevel3Mask	1724	=item $modifiermask = $term->ModLevel3Mask
1128		1725
1129	=item $modifiermask = $term->ModMetaMask	1726	=item $modifiermask = $term->ModMetaMask
…		…
1131	=item $modifiermask = $term->ModNumLockMask	1728	=item $modifiermask = $term->ModNumLockMask
1132		1729
1133	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1730	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1134	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1731	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1135		1732
		1733	=item $screen = $term->current_screen
		1734
		1735	Returns the currently displayed screen (0 primary, 1 secondary).
		1736
		1737	=item $cursor_is_hidden = $term->hidden_cursor
		1738
		1739	Returns whether the cursor is currently hidden or not.
		1740
1136	=item $view_start = $term->view_start ([$newvalue])	1741	=item $view_start = $term->view_start ([$newvalue])
1137		1742
1138	Returns the negative row number of the topmost line. Minimum value is	1743	Returns the row number of the topmost displayed line. Maximum value is
1139	C<0>, which displays the normal terminal contents. Larger values scroll	1744	C<0>, which displays the normal terminal contents. Lower values scroll
1140	this many lines into the scrollback buffer.	1745	this many lines into the scrollback buffer.
1141		1746
1142	=item $term->want_refresh	1747	=item $term->want_refresh
1143		1748
1144	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1749	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1147		1752
1148	Used after changing terminal contents to display them.	1753	Used after changing terminal contents to display them.
1149		1754
1150	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1755	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1151		1756
1152	Returns the text of the entire row with number C<$row_number>. Row C<0>	1757	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1153	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1758	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1154	terminal line. The scrollback buffer starts at line C<-1> and extends to
1155	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1759	terminal line. Nothing will be returned if a nonexistent line
1156	is requested.	1760	is requested.
1157		1761
1158	If C<$new_text> is specified, it will replace characters in the current	1762	If C<$new_text> is specified, it will replace characters in the current
1159	line, starting at column C<$start_col> (default C<0>), which is useful	1763	line, starting at column C<$start_col> (default C<0>), which is useful
1160	to replace only parts of a line. The font index in the rendition will	1764	to replace only parts of a line. The font index in the rendition will
1161	automatically be updated.	1765	automatically be updated.
1162		1766
1163	C<$text> is in a special encoding: tabs and wide characters that use more	1767	C<$text> is in a special encoding: tabs and wide characters that use more
1164	than one cell when displayed are padded with urxvt::NOCHAR characters	1768	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1165	(C<chr 65535>). Characters with combining characters and other characters	1769	characters. Characters with combining characters and other characters that
1166	that do not fit into the normal tetx encoding will be replaced with	1770	do not fit into the normal text encoding will be replaced with characters
1167	characters in the private use area.	1771	in the private use area.
1168		1772
1169	You have to obey this encoding when changing text. The advantage is	1773	You have to obey this encoding when changing text. The advantage is
1170	that C<substr> and similar functions work on screen cells and not on	1774	that C<substr> and similar functions work on screen cells and not on
1171	characters.	1775	characters.
1172		1776
…		…
1316	where one character corresponds to one screen cell. See	1920	where one character corresponds to one screen cell. See
1317	C<< $term->ROW_t >> for details.	1921	C<< $term->ROW_t >> for details.
1318		1922
1319	=item $string = $term->special_decode $text	1923	=item $string = $term->special_decode $text
1320		1924
1321	Converts rxvt-unicodes text reprsentation into a perl string. See	1925	Converts rxvt-unicodes text representation into a perl string. See
1322	C<< $term->ROW_t >> for details.	1926	C<< $term->ROW_t >> for details.
1323		1927
1324	=item $success = $term->grab_button ($button, $modifiermask)	1928	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1325		1929
		1930	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1931
1326	Registers a synchronous button grab. See the XGrabButton manpage.	1932	Register/unregister a synchronous button grab. See the XGrabButton
		1933	manpage.
1327		1934
1328	=item $success = $term->grab ($eventtime[, $sync])	1935	=item $success = $term->grab ($eventtime[, $sync])
1329		1936
1330	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1937	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1331	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1938	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1332		1939
1333	=item $term->allow_events_async	1940	=item $term->allow_events_async
1334		1941
1335	Calls XAllowEvents with AsyncBoth for the most recent grab.	1942	Calls XAllowEvents with AsyncBoth for the most recent grab.
1336		1943
…		…
1343	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1950	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1344	recent grab.	1951	recent grab.
1345		1952
1346	=item $term->ungrab	1953	=item $term->ungrab
1347		1954
1348	Calls XUngrab for the most recent grab. Is called automatically on	1955	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1349	evaluation errors, as it is better to lose the grab in the error case as	1956	evaluation errors, as it is better to lose the grab in the error case as
1350	the session.	1957	the session.
		1958
		1959	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1960
		1961	=item $atom_name = $term->XGetAtomName ($atom)
		1962
		1963	=item @atoms = $term->XListProperties ($window)
		1964
		1965	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1966
		1967	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1968
		1969	=item $term->XDeleteProperty ($window, $property)
		1970
		1971	=item $window = $term->DefaultRootWindow
		1972
		1973	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1974
		1975	=item $term->XMapWindow ($window)
		1976
		1977	=item $term->XUnmapWindow ($window)
		1978
		1979	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1980
		1981	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1982
		1983	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1984
		1985	=item $keysym = $term->XStringToKeysym ($string)
		1986
		1987	=item $string = $term->XKeysymToString ($keysym)
		1988
		1989	Various X or X-related functions. The C<$term> object only serves as
		1990	the source of the display, otherwise those functions map more-or-less
		1991	directly onto the X functions of the same name.
1351		1992
1352	=back	1993	=back
1353		1994
1354	=cut	1995	=cut
1355		1996
…		…
1419	my ($self, $text, $cb) = @_;	2060	my ($self, $text, $cb) = @_;
1420		2061
1421	$self->add_item ({ type => "button", text => $text, activate => $cb});	2062	$self->add_item ({ type => "button", text => $text, activate => $cb});
1422	}	2063	}
1423		2064
1424	=item $popup->add_toggle ($text, $cb, $initial_value)	2065	=item $popup->add_toggle ($text, $initial_value, $cb)
1425		2066
1426	Adds a toggle/checkbox item to the popup. Teh callback gets called	2067	Adds a toggle/checkbox item to the popup. The callback gets called
1427	whenever it gets toggled, with a boolean indicating its value as its first	2068	whenever it gets toggled, with a boolean indicating its new value as its
1428	argument.	2069	first argument.
1429		2070
1430	=cut	2071	=cut
1431		2072
1432	sub add_toggle {	2073	sub add_toggle {
1433	my ($self, $text, $cb, $value) = @_;	2074	my ($self, $text, $value, $cb) = @_;
1434		2075
1435	my $item; $item = {	2076	my $item; $item = {
1436	type => "button",	2077	type => "button",
1437	text => " $text",	2078	text => " $text",
1438	value => $value,	2079	value => $value,
…		…
1457	my $env = $self->{term}->env;	2098	my $env = $self->{term}->env;
1458	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2099	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1459	delete $env->{LC_ALL};	2100	delete $env->{LC_ALL};
1460	$env->{LC_CTYPE} = $self->{term}->locale;	2101	$env->{LC_CTYPE} = $self->{term}->locale;
1461		2102
1462	urxvt::term->new ($env, $self->{term}->resource ("name"),	2103	my $term = urxvt::term->new (
1463	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2104	$env, "popup",
		2105	"--perl-lib" => "", "--perl-ext-common" => "",
		2106	"-pty-fd" => -1, "-sl" => 0,
		2107	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1464	"--transient-for" => $self->{term}->parent,	2108	"--transient-for" => $self->{term}->parent,
1465	"-display" => $self->{term}->display_id,	2109	"-display" => $self->{term}->display_id,
1466	"-pe" => "urxvt-popup")	2110	"-pe" => "urxvt-popup",
1467	or die "unable to create popup window\n";	2111	) or die "unable to create popup window\n";
		2112
		2113	unless (delete $term->{urxvt_popup_init_done}) {
		2114	$term->ungrab;
		2115	$term->destroy;
		2116	die "unable to initialise popup window\n";
		2117	}
1468	}	2118	}
1469		2119
1470	sub DESTROY {	2120	sub DESTROY {
1471	my ($self) = @_;	2121	my ($self) = @_;
1472		2122
1473	delete $self->{term}{_destroy}{$self};	2123	delete $self->{term}{_destroy}{$self};
1474	$self->{term}->ungrab;	2124	$self->{term}->ungrab;
1475	}	2125	}
1476		2126
1477	=back	2127	=back
		2128
		2129	=cut
		2130
		2131	package urxvt::watcher;
1478		2132
1479	=head2 The C<urxvt::timer> Class	2133	=head2 The C<urxvt::timer> Class
1480		2134
1481	This class implements timer watchers/events. Time is represented as a	2135	This class implements timer watchers/events. Time is represented as a
1482	fractional number of seconds since the epoch. Example:	2136	fractional number of seconds since the epoch. Example:
…		…
1486	->new	2140	->new
1487	->interval (1)	2141	->interval (1)
1488	->cb (sub {	2142	->cb (sub {
1489	$term->{overlay}->set (0, 0,	2143	$term->{overlay}->set (0, 0,
1490	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2144	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1491	});	2145	});
1492		2146
1493	=over 4	2147	=over 4
1494		2148
1495	=item $timer = new urxvt::timer	2149	=item $timer = new urxvt::timer
1496		2150
…		…
1499		2153
1500	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2154	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1501		2155
1502	Set the callback to be called when the timer triggers.	2156	Set the callback to be called when the timer triggers.
1503		2157
1504	=item $tstamp = $timer->at
1505
1506	Return the time this watcher will fire next.
1507
1508	=item $timer = $timer->set ($tstamp)	2158	=item $timer = $timer->set ($tstamp[, $interval])
1509		2159
1510	Set the time the event is generated to $tstamp.	2160	Set the time the event is generated to $tstamp (and optionally specifies a
		2161	new $interval).
1511		2162
1512	=item $timer = $timer->interval ($interval)	2163	=item $timer = $timer->interval ($interval)
1513		2164
1514	Normally (and when C<$interval> is C<0>), the timer will automatically	2165	By default (and when C<$interval> is C<0>), the timer will automatically
1515	stop after it has fired once. If C<$interval> is non-zero, then the timer	2166	stop after it has fired once. If C<$interval> is non-zero, then the timer
1516	is automatically rescheduled at the given intervals.	2167	is automatically rescheduled at the given intervals.
1517		2168
1518	=item $timer = $timer->start	2169	=item $timer = $timer->start
1519		2170
1520	Start the timer.	2171	Start the timer.
1521		2172
1522	=item $timer = $timer->start ($tstamp)	2173	=item $timer = $timer->start ($tstamp[, $interval])
1523		2174
1524	Set the event trigger time to C<$tstamp> and start the timer.	2175	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2176	also replaces the interval.
		2177
		2178	=item $timer = $timer->after ($delay[, $interval])
		2179
		2180	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1525		2181
1526	=item $timer = $timer->stop	2182	=item $timer = $timer->stop
1527		2183
1528	Stop the timer.	2184	Stop the timer.
1529		2185
…		…
1535		2191
1536	$term->{socket} = ...	2192	$term->{socket} = ...
1537	$term->{iow} = urxvt::iow	2193	$term->{iow} = urxvt::iow
1538	->new	2194	->new
1539	->fd (fileno $term->{socket})	2195	->fd (fileno $term->{socket})
1540	->events (urxvt::EVENT_READ)	2196	->events (urxvt::EV_READ)
1541	->start	2197	->start
1542	->cb (sub {	2198	->cb (sub {
1543	my ($iow, $revents) = @_;	2199	my ($iow, $revents) = @_;
1544	# $revents must be 1 here, no need to check	2200	# $revents must be 1 here, no need to check
1545	sysread $term->{socket}, my $buf, 8192	2201	sysread $term->{socket}, my $buf, 8192
…		…
1558	Set the callback to be called when io events are triggered. C<$reventmask>	2214	Set the callback to be called when io events are triggered. C<$reventmask>
1559	is a bitset as described in the C<events> method.	2215	is a bitset as described in the C<events> method.
1560		2216
1561	=item $iow = $iow->fd ($fd)	2217	=item $iow = $iow->fd ($fd)
1562		2218
1563	Set the filedescriptor (not handle) to watch.	2219	Set the file descriptor (not handle) to watch.
1564		2220
1565	=item $iow = $iow->events ($eventmask)	2221	=item $iow = $iow->events ($eventmask)
1566		2222
1567	Set the event mask to watch. The only allowed values are	2223	Set the event mask to watch. The only allowed values are
1568	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2224	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1569	together, or C<urxvt::EVENT_NONE>.	2225	together, or C<urxvt::EV_NONE>.
1570		2226
1571	=item $iow = $iow->start	2227	=item $iow = $iow->start
1572		2228
1573	Start watching for requested events on the given handle.	2229	Start watching for requested events on the given handle.
1574		2230
1575	=item $iow = $iow->stop	2231	=item $iow = $iow->stop
1576		2232
1577	Stop watching for events on the given filehandle.	2233	Stop watching for events on the given file handle.
		2234
		2235	=back
		2236
		2237	=head2 The C<urxvt::iw> Class
		2238
		2239	This class implements idle watchers, that get called automatically when
		2240	the process is idle. They should return as fast as possible, after doing
		2241	some useful work.
		2242
		2243	=over 4
		2244
		2245	=item $iw = new urxvt::iw
		2246
		2247	Create a new idle watcher object in stopped state.
		2248
		2249	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2250
		2251	Set the callback to be called when the watcher triggers.
		2252
		2253	=item $timer = $timer->start
		2254
		2255	Start the watcher.
		2256
		2257	=item $timer = $timer->stop
		2258
		2259	Stop the watcher.
		2260
		2261	=back
		2262
		2263	=head2 The C<urxvt::pw> Class
		2264
		2265	This class implements process watchers. They create an event whenever a
		2266	process exits, after which they stop automatically.
		2267
		2268	my $pid = fork;
		2269	...
		2270	$term->{pw} = urxvt::pw
		2271	->new
		2272	->start ($pid)
		2273	->cb (sub {
		2274	my ($pw, $exit_status) = @_;
		2275	...
		2276	});
		2277
		2278	=over 4
		2279
		2280	=item $pw = new urxvt::pw
		2281
		2282	Create a new process watcher in stopped state.
		2283
		2284	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2285
		2286	Set the callback to be called when the timer triggers.
		2287
		2288	=item $pw = $timer->start ($pid)
		2289
		2290	Tells the watcher to start watching for process C<$pid>.
		2291
		2292	=item $pw = $pw->stop
		2293
		2294	Stop the watcher.
1578		2295
1579	=back	2296	=back
1580		2297
1581	=head1 ENVIRONMENT	2298	=head1 ENVIRONMENT
1582		2299
…		…
1591		2308
1592	=item >= 3 - script loading and management	2309	=item >= 3 - script loading and management
1593		2310
1594	=item >=10 - all called hooks	2311	=item >=10 - all called hooks
1595		2312
1596	=item >=11 - hook reutrn values	2313	=item >=11 - hook return values
1597		2314
1598	=back	2315	=back
1599		2316
1600	=head1 AUTHOR	2317	=head1 AUTHOR
1601		2318
1602	Marc Lehmann <pcg@goof.com>	2319	Marc Lehmann <schmorp@schmorp.de>
1603	http://software.schmorp.de/pkg/rxvt-unicode	2320	http://software.schmorp.de/pkg/rxvt-unicode
1604		2321
1605	=cut	2322	=cut
1606		2323
1607	1	2324	1
		2325
		2326	# vim: sw=3:

Diff Legend

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