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.77 by root, Wed Jan 11 00:59:58 2006 UTC vs.
Revision 1.174 by root, Sat May 30 08:47:07 2009 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
44	(More) intelligent selection. This extension tries to be more intelligent	51	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	52	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	53	now, it tries to select words, urls and complete shell-quoted
47	too, if your F<ls> supports C<--quoting-style=shell>.	54	arguments, which is very convenient, too, if your F<ls> supports
		55	C<--quoting-style=shell>.
48		56
		57	A double-click usually selects the word under the cursor, further clicks
		58	will enlarge the selection.
		59
		60	The selection works by trying to match a number of regexes and displaying
		61	them in increasing order of length. You can add your own regexes by
		62	specifying resources of the form:
		63
		64	URxvt.selection.pattern-0: perl-regex
		65	URxvt.selection.pattern-1: perl-regex
		66	...
		67
		68	The index number (0, 1...) must not have any holes, and each regex must
		69	contain at least one pair of capturing parentheses, which will be used for
		70	the match. For example, the following adds a regex that matches everything
		71	between two vertical bars:
		72
		73	URxvt.selection.pattern-0: \\|([^|]+)\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
		81
		82	You can look at the source of the selection extension to see more
		83	interesting uses, such as parsing a line from beginning to end.
		84
49	It also offers the following bindable keyboard command:	85	This extension also offers following bindable keyboard commands:
50		86
51	=over 4	87	=over 4
52		88
53	=item rot13	89	=item rot13
54		90
…		…
61	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
62		98
63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	100	runtime.
65		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
66	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
67		120
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
70	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
		124
		125	Other extensions can extend this popup menu by pushing a code reference
		126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
		128
		129	Its sole argument is the popup menu, which can be modified. The selection
		130	is in C<$_>, which can be used to decide whether to add something or not.
		131	It should either return nothing or a string and a code reference. The
		132	string will be used as button text and the code reference will be called
		133	when the button gets activated and should transform C<$_>.
		134
		135	The following will add an entry C<a to b> that transforms all C<a>s in
		136	the selection to C<b>s, but only if the selection currently contains any
		137	C<a>s:
		138
		139	push @{ $self->{term}{selection_popup_hook} }, sub {
		140	/a/ ? ("a to b" => sub { s/a/b/g }
		141	: ()
		142	};
71		143
72	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
73		145
74	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	148	input/output is suspended and a regex is displayed at the bottom of the
		149	screen.
77		150
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	151	Inputting characters appends them to the regex and continues incremental
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80	history, C<enter> leaves search mode at the current position and C<escape>	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	154	bottom. C<Escape> leaves search mode and returns to the point where search
		155	was started, while C<Enter> or C<Return> stay at the current position and
		156	additionally stores the first match in the current line into the primary
		157	selection if the C<Shift> modifier is active.
82		158
83	=item digital-clock	159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
84		162
85	Displays a digital clock using the built-in overlay.	163	See L<perlre> for more info about perl regular expression syntax.
86		164
87	=item mark-urls	165	=item readline (enabled by default)
88		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
		189
		190	=item selection-autotransform
		191
		192	This selection allows you to do automatic transforms on a selection
		193	whenever a selection is made.
		194
		195	It works by specifying perl snippets (most useful is a single C<s///>
		196	operator) that modify C<$_> as resources:
		197
		198	URxvt.selection-autotransform.0: transform
		199	URxvt.selection-autotransform.1: transform
		200	...
		201
		202	For example, the following will transform selections of the form
		203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		204	$word>:
		205
		206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		207
		208	And this example matches the same,but replaces it with vi-commands you can
		209	paste directly into your (vi :) editor:
		210
		211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		212
		213	Of course, this can be modified to suit your needs and your editor :)
		214
		215	To expand the example above to typical perl error messages ("XXX at
		216	FILENAME line YYY."), you need a slightly more elaborate solution:
		217
		218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		220
		221	The first line tells the selection code to treat the unchanging part of
		222	every error message as a selection pattern, and the second line transforms
		223	the message into vi commands to load the file.
		224
		225	=item tabbed
		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	250	Uses per-line display filtering (C<on_line_update>) to underline text
		251	matching a certain pattern and make it clickable. When clicked with the
		252	mouse button specified in the C<matcher.button> resource (default 2, or
		253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
90		313
91	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
92		315
93	A not very useful example of filtering all text output to the terminal,	316	A not very useful example of filtering all text output to the terminal
94	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	318	similar-looking ascii character.
		319
		320	=item digital-clock
		321
		322	Displays a digital clock using the built-in overlay.
		323
		324	=item remote-clipboard
		325
		326	Somewhat of a misnomer, this extension adds two menu entries to the
		327	selection popup that allows one to run external commands to store the
		328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		343
		344	=item selection-pastebin
		345
		346	This is a little rarely useful extension that Uploads the selection as
		347	textfile to a remote site (or does other things). (The implementation is
		348	not currently secure for use in a multiuser environment as it writes to
		349	F</tmp> directly.).
		350
		351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		352	i.e.
		353
		354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		355
		356	Pressing this combination runs a command with C<%> replaced by the name of
		357	the textfile. This command can be set via a resource:
		358
		359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		360
		361	And the default is likely not useful to anybody but the few people around
		362	here :)
		363
		364	The name of the textfile is the hex encoded md5 sum of the selection, so
		365	the same content should lead to the same filename.
		366
		367	After a successful upload the selection will be replaced by the text given
		368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		369	for the filename):
		370
		371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of wether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-pastebin and macosx-pastebin-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<maxosx-pastebin> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
96		391
97	=item example-refresh-hooks	392	=item example-refresh-hooks
98		393
99	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
123	=over 4	418	=over 4
124		419
125	=item $text	420	=item $text
126		421
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicodes special way of encoding text, where one "unicode" character
128	always represents one screen cell. See L<row_t> for a discussion of this format.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		424
130	=item $string	425	=item $string
131		426
132	A perl text string, with an emphasis on I<text>. It can store all unicode	427	A perl text string, with an emphasis on I<text>. It can store all unicode
133	characters and is to be distinguished with text encoded in a specific	428	characters and is to be distinguished with text encoded in a specific
…		…
140		435
141	=back	436	=back
142		437
143	=head2 Extension Objects	438	=head2 Extension Objects
144		439
145	Very perl extension is a perl class. A separate perl object is created	440	Every perl extension is a perl class. A separate perl object is created
146	for each terminal and each extension and passed as the first parameter to	441	for each terminal, and each terminal has its own set of extenion objects,
147	hooks. So extensions can use their C<$self> object without having to think	442	which are passed as the first parameter to hooks. So extensions can use
148	about other extensions, with the exception of methods and members that	443	their C<$self> object without having to think about clashes with other
		444	extensions or other terminals, with the exception of methods and members
149	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
150	use.	446	internal use.
151		447
152	Although it isn't a C<urxvt::term> object, you can call all methods of the	448	Although it isn't a C<urxvt::term> object, you can call all methods of the
153	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
154		450
155	It has the following methods and data members:	451	It has the following methods and data members:
…		…
176	=head2 Hooks	472	=head2 Hooks
177		473
178	The following subroutines can be declared in extension files, and will be	474	The following subroutines can be declared in extension files, and will be
179	called whenever the relevant event happens.	475	called whenever the relevant event happens.
180		476
181	The first argument passed to them is an extension oject as described in	477	The first argument passed to them is an extension object as described in
182	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
183		479
184	B<All> of these hooks must return a boolean value. If it is true, then the	480	B<All> of these hooks must return a boolean value. If any of the called
185	event counts as being I<consumed>, and the invocation of other hooks is	481	hooks returns true, then the event counts as being I<consumed>, and the
186	skipped, and the relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
187		483
188	I<< When in doubt, return a false value (preferably C<()>). >>	484	I<< When in doubt, return a false value (preferably C<()>). >>
189		485
190	=over 4	486	=over 4
191		487
192	=item on_init $term	488	=item on_init $term
193		489
194	Called after a new terminal object has been initialized, but before	490	Called after a new terminal object has been initialized, but before
195	windows are created or the command gets run. Most methods are unsafe to	491	windows are created or the command gets run. Most methods are unsafe to
196	call or deliver senseless data, as terminal size and other characteristics	492	call or deliver senseless data, as terminal size and other characteristics
197	have not yet been determined. You can safely query and change resources,	493	have not yet been determined. You can safely query and change resources
198	though.	494	and options, though. For many purposes the C<on_start> hook is a better
		495	place.
		496
		497	=item on_start $term
		498
		499	Called at the very end of initialisation of a new terminal, just before
		500	trying to map (display) the toplevel and returning to the main loop.
		501
		502	=item on_destroy $term
		503
		504	Called whenever something tries to destroy terminal, when the terminal is
		505	still fully functional (not for long, though).
199		506
200	=item on_reset $term	507	=item on_reset $term
201		508
202	Called after the screen is "reset" for any reason, such as resizing or	509	Called after the screen is "reset" for any reason, such as resizing or
203	control sequences. Here is where you can react on changes to size-related	510	control sequences. Here is where you can react on changes to size-related
204	variables.	511	variables.
205		512
206	=item on_start $term	513	=item on_child_start $term, $pid
207		514
208	Called at the very end of initialisation of a new terminal, just before	515	Called just after the child process has been C<fork>ed.
209	returning to the mainloop.	516
		517	=item on_child_exit $term, $status
		518
		519	Called just after the child process has exited. C<$status> is the status
		520	from C<waitpid>.
210		521
211	=item on_sel_make $term, $eventtime	522	=item on_sel_make $term, $eventtime
212		523
213	Called whenever a selection has been made by the user, but before the	524	Called whenever a selection has been made by the user, but before the
214	selection text is copied, so changes to the beginning, end or type of the	525	selection text is copied, so changes to the beginning, end or type of the
…		…
221		532
222	Called whenever a selection has been copied, but before the selection is	533	Called whenever a selection has been copied, but before the selection is
223	requested from the server. The selection text can be queried and changed	534	requested from the server. The selection text can be queried and changed
224	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
225		536
226	Returning a true value aborts selection grabbing. It will still be hilighted.	537	Returning a true value aborts selection grabbing. It will still be highlighted.
227		538
228	=item on_sel_extend $term	539	=item on_sel_extend $term
229		540
230	Called whenever the user tries to extend the selection (e.g. with a double	541	Called whenever the user tries to extend the selection (e.g. with a double
231	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
232	should extend the selection itelf and return true to suppress the built-in	543	should extend the selection itself and return true to suppress the built-in
233	processing.	544	processing. This can happen multiple times, as long as the callback
		545	returns true, it will be called on every further click by the user and is
		546	supposed to enlarge the selection more and more, if possible.
234		547
235	See the F<selection> example extension.	548	See the F<selection> example extension.
236		549
237	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
238		551
239	Called whenever the view offset changes, i..e the user or program	552	Called whenever the view offset changes, i.e. the user or program
240	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
241	show this many lines of scrollback.	554	show this many lines of scrollback.
242		555
243	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
244		557
…		…
248		561
249	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
250	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	563	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
251	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
252		565
253	=item on_osc_seq $term, $string	566	=item on_osc_seq $term, $op, $args, $resp
		567
		568	Called on every OSC sequence and can be used to suppress it or modify its
		569	behaviour. The default should be to return an empty list. A true value
		570	suppresses execution of the request completely. Make sure you don't get
		571	confused by recursive invocations when you output an OSC sequence within
		572	this callback.
		573
		574	C<on_osc_seq_perl> should be used for new behaviour.
		575
		576	=item on_osc_seq_perl $term, $args, $resp
254		577
255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
256	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
257	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
258	string should start with the extension name and a colon, to distinguish	581	string should start with the extension name (sans -osc) and a semicolon,
259	it from commands for other extensions, and this might be enforced in the	582	to distinguish it from commands for other extensions, and this might be
260	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
261		594
262	Be careful not ever to trust (in a security sense) the data you receive,	595	Be careful not ever to trust (in a security sense) the data you receive,
263	as its source can not easily be controleld (e-mail content, messages from	596	as its source can not easily be controlled (e-mail content, messages from
264	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
265		601
266	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
267		603
268	Called whenever text is about to be output, with the text as argument. You	604	Called whenever text is about to be output, with the text as argument. You
269	can filter/change and output the text yourself by returning a true value	605	can filter/change and output the text yourself by returning a true value
…		…
290	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
291	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
292		628
293	=item on_refresh_begin $term	629	=item on_refresh_begin $term
294		630
295	Called just before the screen gets redrawn. Can be used for overlay	631	Called just before the screen gets redrawn. Can be used for overlay or
296	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
297	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
298	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
299		635
300	=item on_refresh_end $term	636	=item on_refresh_end $term
301		637
302	Called just after the screen gets redrawn. See C<on_refresh_begin>.	638	Called just after the screen gets redrawn. See C<on_refresh_begin>.
303		639
304	=item on_keyboard_command $term, $string	640	=item on_user_command $term, $string
305		641
306	Called whenever the user presses a key combination that has a	642	Called whenever a user-configured event is being activated (e.g. via
307	C<perl:string> action bound to it (see description of the B<keysym>	643	a C<perl:string> action bound to a key, see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
		645
		646	The event is simply the action string. This interface is assumed to change
		647	slightly in the future.
		648
		649	=item on_resize_all_windows $tern, $new_width, $new_height
		650
		651	Called just after the new window size has been calculated, but before
		652	windows are actually being resized or hints are being set. If this hook
		653	returns TRUE, setting of the window hints is being skipped.
		654
		655	=item on_x_event $term, $event
		656
		657	Called on every X event received on the vt window (and possibly other
		658	windows). Should only be used as a last resort. Most event structure
		659	members are not passed.
		660
		661	=item on_root_event $term, $event
		662
		663	Like C<on_x_event>, but is called for events on the root window.
309		664
310	=item on_focus_in $term	665	=item on_focus_in $term
311		666
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	668	does focus in processing.
314		669
315	=item on_focus_out $term	670	=item on_focus_out $term
316		671
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	673	focus out processing.
		674
		675	=item on_configure_notify $term, $event
		676
		677	=item on_property_notify $term, $event
319		678
320	=item on_key_press $term, $event, $keysym, $octets	679	=item on_key_press $term, $event, $keysym, $octets
321		680
322	=item on_key_release $term, $event, $keysym	681	=item on_key_release $term, $event, $keysym
323		682
…		…
333		692
334	Called whenever the corresponding X event is received for the terminal If	693	Called whenever the corresponding X event is received for the terminal If
335	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the even will be ignored by rxvt-unicode.
336		695
337	The event is a hash with most values as named by Xlib (see the XEvent	696	The event is a hash with most values as named by Xlib (see the XEvent
338	manpage), with the additional members C<row> and C<col>, which are the row	697	manpage), with the additional members C<row> and C<col>, which are the
339	and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
340		699
341	C<on_key_press> additionally receives the string rxvt-unicode would	700	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	701	output, if any, in locale-specific encoding.
343		702
344	subwindow.	703	subwindow.
		704
		705	=item on_client_message $term, $event
		706
		707	=item on_wm_protocols $term, $event
		708
		709	=item on_wm_delete_window $term, $event
		710
		711	Called when various types of ClientMessage events are received (all with
		712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
345		713
346	=back	714	=back
347		715
348	=cut	716	=cut
349		717
…		…
355	use Scalar::Util ();	723	use Scalar::Util ();
356	use List::Util ();	724	use List::Util ();
357		725
358	our $VERSION = 1;	726	our $VERSION = 1;
359	our $TERM;	727	our $TERM;
		728	our @TERM_INIT;
		729	our @TERM_EXT;
360	our @HOOKNAME;	730	our @HOOKNAME;
361	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	731	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
362	our %OPTION;	732	our %OPTION;
363		733
364	our $LIBDIR;	734	our $LIBDIR;
365	our $RESNAME;	735	our $RESNAME;
366	our $RESCLASS;	736	our $RESCLASS;
367	our $RXVTNAME;	737	our $RXVTNAME;
368		738
		739	our $NOCHAR = chr 0xffff;
		740
369	=head2 Variables in the C<urxvt> Package	741	=head2 Variables in the C<urxvt> Package
370		742
371	=over 4	743	=over 4
372		744
373	=item $urxvt::LIBDIR	745	=item $urxvt::LIBDIR
…		…
386	=item $urxvt::TERM	758	=item $urxvt::TERM
387		759
388	The current terminal. This variable stores the current C<urxvt::term>	760	The current terminal. This variable stores the current C<urxvt::term>
389	object, whenever a callback/hook is executing.	761	object, whenever a callback/hook is executing.
390		762
391	=item	763	=item @urxvt::TERM_INIT
		764
		765	All code references in this array will be called as methods of the next newly
		766	created C<urxvt::term> object (during the C<on_init> phase). The array
		767	gets cleared before the code references that were in it are being executed,
		768	so references can push themselves onto it again if they so desire.
		769
		770	This complements to the perl-eval command line option, but gets executed
		771	first.
		772
		773	=item @urxvt::TERM_EXT
		774
		775	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		776	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		777	but before other extensions. Gets cleared just like C<@TERM_INIT>.
392		778
393	=back	779	=back
394		780
395	=head2 Functions in the C<urxvt> Package	781	=head2 Functions in the C<urxvt> Package
396		782
…		…
411	Using this function has the advantage that its output ends up in the	797	Using this function has the advantage that its output ends up in the
412	correct place, e.g. on stderr of the connecting urxvtc client.	798	correct place, e.g. on stderr of the connecting urxvtc client.
413		799
414	Messages have a size limit of 1023 bytes currently.	800	Messages have a size limit of 1023 bytes currently.
415		801
416	=item $is_safe = urxvt::safe	802	=item @terms = urxvt::termlist
417		803
418	Returns true when it is safe to do potentially unsafe things, such as	804	Returns all urxvt::term objects that exist in this process, regardless of
419	evaluating perl code specified by the user. This is true when urxvt was	805	whether they are started, being destroyed etc., so be careful. Only term
420	started setuid or setgid.	806	objects that have perl extensions attached will be returned (because there
		807	is no urxvt::term objet associated with others).
421		808
422	=item $time = urxvt::NOW	809	=item $time = urxvt::NOW
423		810
424	Returns the "current time" (as per the event loop).	811	Returns the "current time" (as per the event loop).
425		812
426	=item urxvt::CurrentTime	813	=item urxvt::CurrentTime
427		814
428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	815	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	816	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430	Button4Mask, Button5Mask, AnyModifier	817	Button4Mask, Button5Mask, AnyModifier
		818
		819	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		820	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		821	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		822	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		823	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		824	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		825	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		826
		827	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		828	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		829	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		830	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		831	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		832	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		833	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431		834
432	Various constants for use in X calls and event processing.	835	Various constants for use in X calls and event processing.
433		836
434	=back	837	=back
435		838
…		…
468		871
469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	872	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
470		873
471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	874	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
472		875
		876	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		877
473	Replace the foreground/background colour in the rendition mask with the	878	Replace the foreground/background colour in the rendition mask with the
474	specified one.	879	specified one.
475		880
476	=item $value = urxvt::GET_CUSTOM $rend	881	=item $value = urxvt::GET_CUSTOM $rend
477		882
…		…
486	=back	891	=back
487		892
488	=cut	893	=cut
489		894
490	BEGIN {	895	BEGIN {
491	urxvt->bootstrap;
492
493	# overwrite perl's warn	896	# overwrite perl's warn
494	*CORE::GLOBAL::warn = sub {	897	*CORE::GLOBAL::warn = sub {
495	my $msg = join "", @_;	898	my $msg = join "", @_;
496	$msg .= "\n"	899	$msg .= "\n"
497	unless $msg =~ /\n$/;	900	unless $msg =~ /\n$/;
498	urxvt::warn ($msg);	901	urxvt::warn ($msg);
499	};	902	};
500
501	delete $ENV{IFS};
502	delete $ENV{CDPATH};
503	delete $ENV{BASH_ENV};
504	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
505	}	903	}
506		904
507	my @hook_count;	905	no warnings 'utf8';
		906
508	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	907	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
509		908
510	sub verbose {	909	sub verbose {
511	my ($level, $msg) = @_;	910	my ($level, $msg) = @_;
512	warn "$msg\n" if $level <= $verbosity;	911	warn "$msg\n" if $level <= $verbosity;
513	}	912	}
514		913
515	my $extension_pkg = "extension0000";
516	my %extension_pkg;	914	my %extension_pkg;
517		915
518	# load a single script into its own package, once only	916	# load a single script into its own package, once only
519	sub extension_package($) {	917	sub extension_package($) {
520	my ($path) = @_;	918	my ($path) = @_;
521		919
522	$extension_pkg{$path} ||= do {	920	$extension_pkg{$path} ||= do {
523	my $pkg = "urxvt::" . ($extension_pkg++);	921	$path =~ /([^\/\\]+)$/;
		922	my $pkg = $1;
		923	$pkg =~ s/[^[:word:]]/_/g;
		924	$pkg = "urxvt::ext::$pkg";
524		925
525	verbose 3, "loading extension '$path' into package '$pkg'";	926	verbose 3, "loading extension '$path' into package '$pkg'";
526		927
527	open my $fh, "<:raw", $path	928	open my $fh, "<:raw", $path
528	or die "$path: $!";	929	or die "$path: $!";
529		930
530	my $source = untaint	931	my $source =
531	"package $pkg; use strict; use utf8;\n"	932	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
532	. "use base urxvt::term::extension::;\n"
533	. "#line 1 \"$path\"\n{\n"	933	. "#line 1 \"$path\"\n{\n"
534	. (do { local $/; <$fh> })	934	. (do { local $/; <$fh> })
535	. "\n};\n1";	935	. "\n};\n1";
536		936
537	eval $source	937	eval $source
…		…
548	local $TERM = shift;	948	local $TERM = shift;
549	my $htype = shift;	949	my $htype = shift;
550		950
551	if ($htype == 0) { # INIT	951	if ($htype == 0) { # INIT
552	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
553		953
554	my %ext_arg;	954	my %ext_arg;
555		955
		956	{
		957	my @init = @TERM_INIT;
		958	@TERM_INIT = ();
		959	$_->($TERM) for @init;
		960	my @pkg = @TERM_EXT;
		961	@TERM_EXT = ();
		962	$TERM->register_package ($_) for @pkg;
		963	}
		964
556	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	965	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
557	if ($_ eq "default") {	966	if ($_ eq "default") {
558	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	967	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
559	} elsif (/^-(.*)$/) {	968	} elsif (/^-(.*)$/) {
560	delete $ext_arg{$1};	969	delete $ext_arg{$1};
561	} elsif (/^([^<]+)<(.*)>$/) {	970	} elsif (/^([^<]+)<(.*)>$/) {
562	push @{ $ext_arg{$1} }, $2;	971	push @{ $ext_arg{$1} }, $2;
563	} else {	972	} else {
564	$ext_arg{$_} ||= [];	973	$ext_arg{$_} ||= [];
565	}	974	}
566	}	975	}
567		976
568	while (my ($ext, $argv) = each %ext_arg) {	977	for my $ext (sort keys %ext_arg) {
569	my @files = grep -f $_, map "$_/$ext", @dirs;	978	my @files = grep -f $_, map "$_/$ext", @dirs;
570		979
571	if (@files) {	980	if (@files) {
572	$TERM->register_package (extension_package $files[0], $argv);	981	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
573	} else {	982	} else {
574	warn "perl extension '$ext' not found in perl library search path\n";	983	warn "perl extension '$ext' not found in perl library search path\n";
575	}	984	}
576	}	985	}
577		986
…		…
583		992
584	if (my $cb = $TERM->{_hook}[$htype]) {	993	if (my $cb = $TERM->{_hook}[$htype]) {
585	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	994	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
586	if $verbosity >= 10;	995	if $verbosity >= 10;
587		996
588	keys %$cb;	997	for my $pkg (keys %$cb) {
589
590	while (my ($pkg, $cb) = each %$cb) {
591	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	998	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
592	and last;	999	$retval ||= $retval_;
593		1000
594	if ($@) {	1001	if ($@) {
595	$TERM->ungrab; # better to lose the grab than the session	1002	$TERM->ungrab; # better to lose the grab than the session
596	warn $@;	1003	warn $@;
597	}	1004	}
598	}	1005	}
		1006
		1007	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		1008	if $verbosity >= 11;
599	}	1009	}
600		1010
601	if ($htype == 1) { # DESTROY	1011	if ($htype == 1) { # DESTROY
602	if (my $hook = delete $TERM->{_hook}) {
603	for my $htype (0..$#$hook) {
604	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
605	or set_should_invoke $htype, 0;
606	}
607	}
608
609	# clear package objects	1012	# clear package objects
610	%$_ = () for values %{ $TERM->{_pkg} };	1013	%$_ = () for values %{ $TERM->{_pkg} };
611		1014
612	# clear package	1015	# clear package
613	%$TERM = ();	1016	%$TERM = ();
614	}	1017	}
615		1018
616	$retval	1019	$retval
		1020	}
		1021
		1022	sub SET_COLOR($$$) {
		1023	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1024	}
		1025
		1026	sub rend2mask {
		1027	no strict 'refs';
		1028	my ($str, $mask) = (@_, 0);
		1029	my %color = ( fg => undef, bg => undef );
		1030	my @failed;
		1031	for my $spec ( split /\s+/, $str ) {
		1032	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1033	$color{lc($1)} = $2;
		1034	} else {
		1035	my $neg = $spec =~ s/^[-^]//;
		1036	unless ( exists &{"RS_$spec"} ) {
		1037	push @failed, $spec;
		1038	next;
		1039	}
		1040	my $cur = &{"RS_$spec"};
		1041	if ( $neg ) {
		1042	$mask &= ~$cur;
		1043	} else {
		1044	$mask |= $cur;
		1045	}
		1046	}
		1047	}
		1048	($mask, @color{qw(fg bg)}, \@failed)
617	}	1049	}
618		1050
619	# urxvt::term::extension	1051	# urxvt::term::extension
620		1052
621	package urxvt::term::extension;	1053	package urxvt::term::extension;
…		…
627	while (my ($name, $cb) = each %hook) {	1059	while (my ($name, $cb) = each %hook) {
628	my $htype = $HOOKTYPE{uc $name};	1060	my $htype = $HOOKTYPE{uc $name};
629	defined $htype	1061	defined $htype
630	or Carp::croak "unsupported hook type '$name'";	1062	or Carp::croak "unsupported hook type '$name'";
631		1063
		1064	$self->set_should_invoke ($htype, +1)
632	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1065	unless exists $self->{term}{_hook}[$htype]{$pkg};
633	$hook_count[$htype]++
634	or urxvt::set_should_invoke $htype, 1;
635	}
636		1066
637	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1067	$self->{term}{_hook}[$htype]{$pkg} = $cb;
638	}	1068	}
639	}	1069	}
640		1070
…		…
645	for my $name (@hook) {	1075	for my $name (@hook) {
646	my $htype = $HOOKTYPE{uc $name};	1076	my $htype = $HOOKTYPE{uc $name};
647	defined $htype	1077	defined $htype
648	or Carp::croak "unsupported hook type '$name'";	1078	or Carp::croak "unsupported hook type '$name'";
649		1079
		1080	$self->set_should_invoke ($htype, -1)
650	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1081	if delete $self->{term}{_hook}[$htype]{$pkg};
651	--$hook_count[$htype]
652	or urxvt::set_should_invoke $htype, 0;
653	}
654	}	1082	}
655	}	1083	}
656		1084
657	our $AUTOLOAD;	1085	our $AUTOLOAD;
658		1086
…		…
696	is that you cannot use blocking APIs, but the non-blocking variant should	1124	is that you cannot use blocking APIs, but the non-blocking variant should
697	work.	1125	work.
698		1126
699	=cut	1127	=cut
700		1128
701	our $VERSION = 1;	1129	our $VERSION = '3.4';
702		1130
703	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1131	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
704	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1132	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
705		1133
706	sub timer {	1134	sub timer {
…		…
737		1165
738	sub DESTROY {	1166	sub DESTROY {
739	$_[0][1]->stop;	1167	$_[0][1]->stop;
740	}	1168	}
741		1169
742	sub condvar {	1170	sub one_event {
743	bless \my $flag, urxvt::anyevent::condvar::
744	}
745
746	sub urxvt::anyevent::condvar::broadcast {
747	${$_[0]}++;
748	}
749
750	sub urxvt::anyevent::condvar::wait {
751	unless (${$_[0]}) {
752	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1171	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
753	}
754	}	1172	}
755		1173
756	package urxvt::term;	1174	package urxvt::term;
757		1175
758	=head2 The C<urxvt::term> Class	1176	=head2 The C<urxvt::term> Class
…		…
763		1181
764	# find on_xxx subs in the package and register them	1182	# find on_xxx subs in the package and register them
765	# as hooks	1183	# as hooks
766	sub register_package {	1184	sub register_package {
767	my ($self, $pkg, $argv) = @_;	1185	my ($self, $pkg, $argv) = @_;
		1186
		1187	no strict 'refs';
		1188
		1189	urxvt::verbose 6, "register package $pkg to $self";
		1190
		1191	@{"$pkg\::ISA"} = urxvt::term::extension::;
768		1192
769	my $proxy = bless {	1193	my $proxy = bless {
770	_pkg => $pkg,	1194	_pkg => $pkg,
771	argv => $argv,	1195	argv => $argv,
772	}, $pkg;	1196	}, $pkg;
…		…
782	}	1206	}
783		1207
784	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1208	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
785		1209
786	Creates a new terminal, very similar as if you had started it with system	1210	Creates a new terminal, very similar as if you had started it with system
787	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a %ENV>-like	1211	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
788	C<hash which defines the environment of the new terminal.	1212	hash which defines the environment of the new terminal.
789		1213
790	Croaks (and probably outputs an error message) if the new instance	1214	Croaks (and probably outputs an error message) if the new instance
791	couldn't be created. Returns C<undef> if the new instance didn't	1215	couldn't be created. Returns C<undef> if the new instance didn't
792	initialise perl, and the terminal object otherwise. The C<init> and	1216	initialise perl, and the terminal object otherwise. The C<init> and
793	C<start> hooks will be called during this call.	1217	C<start> hooks will be called before this call returns, and are free to
		1218	refer to global data (which is race free).
794		1219
795	=cut	1220	=cut
796		1221
797	sub new {	1222	sub new {
798	my ($class, $env, @args) = @_;	1223	my ($class, $env, @args) = @_;
799		1224
		1225	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1226	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1227
800	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1228	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
801	}	1229	}
802		1230
803	=item $term->destroy	1231	=item $term->destroy
804		1232
805	Destroy the terminal object (close the window, free resources	1233	Destroy the terminal object (close the window, free resources
806	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1234	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
807	watchers (timers, io watchers) are still active.	1235	watchers (timers, io watchers) are still active.
808		1236
		1237	=item $term->exec_async ($cmd[, @args])
		1238
		1239	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1240	("starts") programs in the background. This function takes care of setting
		1241	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1242	be preferred over explicit calls to C<exec> or C<system>.
		1243
		1244	Returns the pid of the subprocess or C<undef> on error.
		1245
		1246	=cut
		1247
		1248	sub exec_async {
		1249	my $self = shift;
		1250
		1251	my $pid = fork;
		1252
		1253	return $pid
		1254	if !defined $pid or $pid;
		1255
		1256	%ENV = %{ $self->env };
		1257
		1258	exec @_;
		1259	urxvt::_exit 255;
		1260	}
		1261
809	=item $isset = $term->option ($optval[, $set])	1262	=item $isset = $term->option ($optval[, $set])
810		1263
811	Returns true if the option specified by C<$optval> is enabled, and	1264	Returns true if the option specified by C<$optval> is enabled, and
812	optionally change it. All option values are stored by name in the hash	1265	optionally change it. All option values are stored by name in the hash
813	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1266	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
814		1267
815	Here is a a likely non-exhaustive list of option names, please see the	1268	Here is a likely non-exhaustive list of option names, please see the
816	source file F</src/optinc.h> to see the actual list:	1269	source file F</src/optinc.h> to see the actual list:
817		1270
818	borderLess console cursorBlink cursorUnderline hold iconic insecure	1271	borderLess console cursorBlink cursorUnderline hold iconic insecure
819	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1272	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
820	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1273	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
821	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1274	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
822	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1275	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
823	tripleclickwords utmpInhibit visualBell	1276	transparent tripleclickwords utmpInhibit visualBell
824		1277
825	=item $value = $term->resource ($name[, $newval])	1278	=item $value = $term->resource ($name[, $newval])
826		1279
827	Returns the current resource value associated with a given name and	1280	Returns the current resource value associated with a given name and
828	optionally sets a new value. Setting values is most useful in the C<init>	1281	optionally sets a new value. Setting values is most useful in the C<init>
…		…
837	likely change).	1290	likely change).
838		1291
839	Please note that resource strings will currently only be freed when the	1292	Please note that resource strings will currently only be freed when the
840	terminal is destroyed, so changing options frequently will eat memory.	1293	terminal is destroyed, so changing options frequently will eat memory.
841		1294
842	Here is a a likely non-exhaustive list of resource names, not all of which	1295	Here is a likely non-exhaustive list of resource names, not all of which
843	are supported in every build, please see the source file F</src/rsinc.h>	1296	are supported in every build, please see the source file F</src/rsinc.h>
844	to see the actual list:	1297	to see the actual list:
845		1298
846	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1299	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
847	borderLess color cursorBlink cursorUnderline cutchars delete_key	1300	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
848	display_name embed ext_bwidth fade font geometry hold iconName	1301	display_name embed ext_bwidth fade font geometry hold iconName
849	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1302	imFont imLocale inputMethod insecure int_bwidth intensityStyles
850	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1303	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
851	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1304	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
852	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1305	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
853	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1306	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
854	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1307	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
855	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1308	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
856	shade term_name title transparent transparent_all tripleclickwords	1309	secondaryScreen secondaryScroll shade term_name title
857	utmpInhibit visualBell	1310	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1311	visualBell
858		1312
859	=cut	1313	=cut
860		1314
861	sub resource($$;$) {	1315	sub resource($$;$) {
862	my ($self, $name) = (shift, shift);	1316	my ($self, $name) = (shift, shift);
863	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1317	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
864	&urxvt::term::_resource	1318	goto &urxvt::term::_resource
865	}	1319	}
		1320
		1321	=item $value = $term->x_resource ($pattern)
		1322
		1323	Returns the X-Resource for the given pattern, excluding the program or
		1324	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1325	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1326	resource with that pattern exists.
		1327
		1328	This method should only be called during the C<on_start> hook, as there is
		1329	only one resource database per display, and later invocations might return
		1330	the wrong resources.
866		1331
867	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1332	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
868		1333
869	Adds a keymap translation exactly as specified via a resource. See the	1334	Adds a keymap translation exactly as specified via a resource. See the
870	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1335	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
…		…
886	=item ($row, $col) = $term->selection_end ([$row, $col])	1351	=item ($row, $col) = $term->selection_end ([$row, $col])
887		1352
888	Return the current values of the selection mark, begin or end positions,	1353	Return the current values of the selection mark, begin or end positions,
889	and optionally set them to new values.	1354	and optionally set them to new values.
890		1355
		1356	=item $term->selection_make ($eventtime[, $rectangular])
		1357
		1358	Tries to make a selection as set by C<selection_beg> and
		1359	C<selection_end>. If C<$rectangular> is true (default: false), a
		1360	rectangular selection will be made. This is the prefered function to make
		1361	a selection.
		1362
891	=item $success = $term->selection_grab ($eventtime)	1363	=item $success = $term->selection_grab ($eventtime)
892		1364
893	Try to request the primary selection from the server (for example, as set	1365	Try to request the primary selection text from the server (for example, as
894	by the next method).	1366	set by the next method). No visual feedback will be given. This function
		1367	is mostly useful from within C<on_sel_grab> hooks.
895		1368
896	=item $oldtext = $term->selection ([$newtext])	1369	=item $oldtext = $term->selection ([$newtext])
897		1370
898	Return the current selection text and optionally replace it by C<$newtext>.	1371	Return the current selection text and optionally replace it by C<$newtext>.
899		1372
…		…
933		1406
934	The methods currently supported on C<urxvt::overlay> objects are:	1407	The methods currently supported on C<urxvt::overlay> objects are:
935		1408
936	=over 4	1409	=over 4
937		1410
938	=item $overlay->set ($x, $y, $text, $rend)	1411	=item $overlay->set ($x, $y, $text[, $rend])
939		1412
940	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1413	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
941	text in rxvt-unicode's special encoding and an array of rendition values	1414	text in rxvt-unicode's special encoding and an array of rendition values
942	at a specific position inside the overlay.	1415	at a specific position inside the overlay.
		1416
		1417	If C<$rend> is missing, then the rendition will not be changed.
943		1418
944	=item $overlay->hide	1419	=item $overlay->hide
945		1420
946	If visible, hide the overlay, but do not destroy it.	1421	If visible, hide the overlay, but do not destroy it.
947		1422
…		…
992	Convert the given locale-encoded octets into a perl string.	1467	Convert the given locale-encoded octets into a perl string.
993		1468
994	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1469	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
995		1470
996	XORs the rendition values in the given span with the provided value	1471	XORs the rendition values in the given span with the provided value
997	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1472	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
998	to the selection.	1473	refresh hooks to provide effects similar to the selection.
999		1474
1000	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1475	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1001		1476
1002	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1477	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1003	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1478	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1004	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1479	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1005	it instead.	1480	it instead. Both styles I<MUST NOT> contain font styles.
1006		1481
1007	=item $term->scr_bell	1482	=item $term->scr_bell
1008		1483
1009	Ring the bell!	1484	Ring the bell!
1010		1485
…		…
1017		1492
1018	Normally its not a good idea to use this function, as programs might be	1493	Normally its not a good idea to use this function, as programs might be
1019	confused by changes in cursor position or scrolling. Its useful inside a	1494	confused by changes in cursor position or scrolling. Its useful inside a
1020	C<on_add_lines> hook, though.	1495	C<on_add_lines> hook, though.
1021		1496
		1497	=item $term->scr_change_screen ($screen)
		1498
		1499	Switch to given screen - 0 primary, 1 secondary.
		1500
1022	=item $term->cmd_parse ($octets)	1501	=item $term->cmd_parse ($octets)
1023		1502
1024	Similar to C<scr_add_lines>, but the argument must be in the	1503	Similar to C<scr_add_lines>, but the argument must be in the
1025	locale-specific encoding of the terminal and can contain command sequences	1504	locale-specific encoding of the terminal and can contain command sequences
1026	(escape codes) that will be interpreted.	1505	(escape codes) that will be interpreted.
…		…
1036	Replaces the event mask of the pty watcher by the given event mask. Can	1515	Replaces the event mask of the pty watcher by the given event mask. Can
1037	be used to suppress input and output handling to the pty/tty. See the	1516	be used to suppress input and output handling to the pty/tty. See the
1038	description of C<< urxvt::timer->events >>. Make sure to always restore	1517	description of C<< urxvt::timer->events >>. Make sure to always restore
1039	the previous value.	1518	the previous value.
1040		1519
		1520	=item $fd = $term->pty_fd
		1521
		1522	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1523	is used.
		1524
1041	=item $windowid = $term->parent	1525	=item $windowid = $term->parent
1042		1526
1043	Return the window id of the toplevel window.	1527	Return the window id of the toplevel window.
1044		1528
1045	=item $windowid = $term->vt	1529	=item $windowid = $term->vt
1046		1530
1047	Return the window id of the terminal window.	1531	Return the window id of the terminal window.
1048		1532
		1533	=item $term->vt_emask_add ($x_event_mask)
		1534
		1535	Adds the specified events to the vt event mask. Useful e.g. when you want
		1536	to receive pointer events all the times:
		1537
		1538	$term->vt_emask_add (urxvt::PointerMotionMask);
		1539
		1540	=item $term->focus_in
		1541
		1542	=item $term->focus_out
		1543
		1544	=item $term->key_press ($state, $keycode[, $time])
		1545
		1546	=item $term->key_release ($state, $keycode[, $time])
		1547
		1548	Deliver various fake events to to terminal.
		1549
1049	=item $window_width = $term->width	1550	=item $window_width = $term->width
1050		1551
1051	=item $window_height = $term->height	1552	=item $window_height = $term->height
1052		1553
1053	=item $font_width = $term->fwidth	1554	=item $font_width = $term->fwidth
…		…
1066		1567
1067	=item $max_scrollback = $term->saveLines	1568	=item $max_scrollback = $term->saveLines
1068		1569
1069	=item $nrow_plus_saveLines = $term->total_rows	1570	=item $nrow_plus_saveLines = $term->total_rows
1070		1571
1071	=item $lines_in_scrollback = $term->nsaved	1572	=item $topmost_scrollback_row = $term->top_row
1072		1573
1073	Return various integers describing terminal characteristics.	1574	Return various integers describing terminal characteristics.
1074		1575
1075	=item $x_display = $term->display_id	1576	=item $x_display = $term->display_id
1076		1577
…		…
1083	=item $env = $term->env	1584	=item $env = $term->env
1084		1585
1085	Returns a copy of the environment in effect for the terminal as a hashref	1586	Returns a copy of the environment in effect for the terminal as a hashref
1086	similar to C<\%ENV>.	1587	similar to C<\%ENV>.
1087		1588
		1589	=item @envv = $term->envv
		1590
		1591	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1592
		1593	=item @argv = $term->argv
		1594
		1595	Return the argument vector as this terminal, similar to @ARGV, but
		1596	includes the program name as first element.
		1597
1088	=cut	1598	=cut
1089		1599
1090	sub env {	1600	sub env {
1091	if (my $env = $_[0]->_env) {
1092	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1601	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1093	} else {
1094	+{ %ENV }
1095	}
1096	}	1602	}
1097		1603
1098	=item $modifiermask = $term->ModLevel3Mask	1604	=item $modifiermask = $term->ModLevel3Mask
1099		1605
1100	=item $modifiermask = $term->ModMetaMask	1606	=item $modifiermask = $term->ModMetaMask
…		…
1102	=item $modifiermask = $term->ModNumLockMask	1608	=item $modifiermask = $term->ModNumLockMask
1103		1609
1104	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1610	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1105	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1611	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1106		1612
		1613	=item $screen = $term->current_screen
		1614
		1615	Returns the currently displayed screen (0 primary, 1 secondary).
		1616
		1617	=item $cursor_is_hidden = $term->hidden_cursor
		1618
		1619	Returns whether the cursor is currently hidden or not.
		1620
1107	=item $view_start = $term->view_start ([$newvalue])	1621	=item $view_start = $term->view_start ([$newvalue])
1108		1622
1109	Returns the negative row number of the topmost line. Minimum value is	1623	Returns the row number of the topmost displayed line. Maximum value is
1110	C<0>, which displays the normal terminal contents. Larger values scroll	1624	C<0>, which displays the normal terminal contents. Lower values scroll
1111	this many lines into the scrollback buffer.	1625	this many lines into the scrollback buffer.
1112		1626
1113	=item $term->want_refresh	1627	=item $term->want_refresh
1114		1628
1115	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1629	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1118		1632
1119	Used after changing terminal contents to display them.	1633	Used after changing terminal contents to display them.
1120		1634
1121	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1635	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1122		1636
1123	Returns the text of the entire row with number C<$row_number>. Row C<0>	1637	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1124	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1638	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1125	terminal line. The scrollback buffer starts at line C<-1> and extends to
1126	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1639	terminal line. Nothing will be returned if a nonexistent line
1127	is requested.	1640	is requested.
1128		1641
1129	If C<$new_text> is specified, it will replace characters in the current	1642	If C<$new_text> is specified, it will replace characters in the current
1130	line, starting at column C<$start_col> (default C<0>), which is useful	1643	line, starting at column C<$start_col> (default C<0>), which is useful
1131	to replace only parts of a line. The font index in the rendition will	1644	to replace only parts of a line. The font index in the rendition will
1132	automatically be updated.	1645	automatically be updated.
1133		1646
1134	C<$text> is in a special encoding: tabs and wide characters that use more	1647	C<$text> is in a special encoding: tabs and wide characters that use more
1135	than one cell when displayed are padded with urxvt::NOCHAR characters	1648	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1136	(C<chr 65535>). Characters with combining characters and other characters	1649	characters. Characters with combining characters and other characters that
1137	that do not fit into the normal tetx encoding will be replaced with	1650	do not fit into the normal text encoding will be replaced with characters
1138	characters in the private use area.	1651	in the private use area.
1139		1652
1140	You have to obey this encoding when changing text. The advantage is	1653	You have to obey this encoding when changing text. The advantage is
1141	that C<substr> and similar functions work on screen cells and not on	1654	that C<substr> and similar functions work on screen cells and not on
1142	characters.	1655	characters.
1143		1656
…		…
1194	Return the row number of the first/last row of the line, respectively.	1707	Return the row number of the first/last row of the line, respectively.
1195		1708
1196	=item $offset = $line->offset_of ($row, $col)	1709	=item $offset = $line->offset_of ($row, $col)
1197		1710
1198	Returns the character offset of the given row|col pair within the logical	1711	Returns the character offset of the given row|col pair within the logical
1199	line.	1712	line. Works for rows outside the line, too, and returns corresponding
		1713	offsets outside the string.
1200		1714
1201	=item ($row, $col) = $line->coord_of ($offset)	1715	=item ($row, $col) = $line->coord_of ($offset)
1202		1716
1203	Translates a string offset into terminal coordinates again.	1717	Translates a string offset into terminal coordinates again.
1204		1718
…		…
1286	where one character corresponds to one screen cell. See	1800	where one character corresponds to one screen cell. See
1287	C<< $term->ROW_t >> for details.	1801	C<< $term->ROW_t >> for details.
1288		1802
1289	=item $string = $term->special_decode $text	1803	=item $string = $term->special_decode $text
1290		1804
1291	Converts rxvt-unicodes text reprsentation into a perl string. See	1805	Converts rxvt-unicodes text representation into a perl string. See
1292	C<< $term->ROW_t >> for details.	1806	C<< $term->ROW_t >> for details.
1293		1807
1294	=item $success = $term->grab_button ($button, $modifiermask)	1808	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1295		1809
		1810	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1811
1296	Registers a synchronous button grab. See the XGrabButton manpage.	1812	Register/unregister a synchronous button grab. See the XGrabButton
		1813	manpage.
1297		1814
1298	=item $success = $term->grab ($eventtime[, $sync])	1815	=item $success = $term->grab ($eventtime[, $sync])
1299		1816
1300	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1817	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1301	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1818	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1302		1819
1303	=item $term->allow_events_async	1820	=item $term->allow_events_async
1304		1821
1305	Calls XAllowEvents with AsyncBoth for the most recent grab.	1822	Calls XAllowEvents with AsyncBoth for the most recent grab.
1306		1823
…		…
1316	=item $term->ungrab	1833	=item $term->ungrab
1317		1834
1318	Calls XUngrab for the most recent grab. Is called automatically on	1835	Calls XUngrab for the most recent grab. Is called automatically on
1319	evaluation errors, as it is better to lose the grab in the error case as	1836	evaluation errors, as it is better to lose the grab in the error case as
1320	the session.	1837	the session.
		1838
		1839	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1840
		1841	=item $atom_name = $term->XGetAtomName ($atom)
		1842
		1843	=item @atoms = $term->XListProperties ($window)
		1844
		1845	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1846
		1847	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1848
		1849	=item $term->XDeleteProperty ($window, $property)
		1850
		1851	=item $window = $term->DefaultRootWindow
		1852
		1853	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1854
		1855	=item $term->XMapWindow ($window)
		1856
		1857	=item $term->XUnmapWindow ($window)
		1858
		1859	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1860
		1861	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1862
		1863	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1864
		1865	Various X or X-related functions. The C<$term> object only serves as
		1866	the source of the display, otherwise those functions map more-or-less
		1867	directory onto the X functions of the same name.
1321		1868
1322	=back	1869	=back
1323		1870
1324	=cut	1871	=cut
1325		1872
…		…
1389	my ($self, $text, $cb) = @_;	1936	my ($self, $text, $cb) = @_;
1390		1937
1391	$self->add_item ({ type => "button", text => $text, activate => $cb});	1938	$self->add_item ({ type => "button", text => $text, activate => $cb});
1392	}	1939	}
1393		1940
1394	=item $popup->add_toggle ($text, $cb, $initial_value)	1941	=item $popup->add_toggle ($text, $initial_value, $cb)
1395		1942
1396	Adds a toggle/checkbox item to the popup. Teh callback gets called	1943	Adds a toggle/checkbox item to the popup. The callback gets called
1397	whenever it gets toggled, with a boolean indicating its value as its first	1944	whenever it gets toggled, with a boolean indicating its new value as its
1398	argument.	1945	first argument.
1399		1946
1400	=cut	1947	=cut
1401		1948
1402	sub add_toggle {	1949	sub add_toggle {
1403	my ($self, $text, $cb, $value) = @_;	1950	my ($self, $text, $value, $cb) = @_;
1404		1951
1405	my $item; $item = {	1952	my $item; $item = {
1406	type => "button",	1953	type => "button",
1407	text => " $text",	1954	text => " $text",
1408	value => $value,	1955	value => $value,
…		…
1427	my $env = $self->{term}->env;	1974	my $env = $self->{term}->env;
1428	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1975	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1429	delete $env->{LC_ALL};	1976	delete $env->{LC_ALL};
1430	$env->{LC_CTYPE} = $self->{term}->locale;	1977	$env->{LC_CTYPE} = $self->{term}->locale;
1431		1978
1432	urxvt::term->new ($env, $self->{term}->resource ("name"),	1979	my $term = urxvt::term->new (
1433	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1980	$env, "popup",
		1981	"--perl-lib" => "", "--perl-ext-common" => "",
		1982	"-pty-fd" => -1, "-sl" => 0,
		1983	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1434	"--transient-for" => $self->{term}->parent,	1984	"--transient-for" => $self->{term}->parent,
1435	"-display" => $self->{term}->display_id,	1985	"-display" => $self->{term}->display_id,
1436	"-pe" => "urxvt-popup")	1986	"-pe" => "urxvt-popup",
1437	or die "unable to create popup window\n";	1987	) or die "unable to create popup window\n";
		1988
		1989	unless (delete $term->{urxvt_popup_init_done}) {
		1990	$term->ungrab;
		1991	$term->destroy;
		1992	die "unable to initialise popup window\n";
		1993	}
1438	}	1994	}
1439		1995
1440	sub DESTROY {	1996	sub DESTROY {
1441	my ($self) = @_;	1997	my ($self) = @_;
1442		1998
1443	delete $self->{term}{_destroy}{$self};	1999	delete $self->{term}{_destroy}{$self};
1444	$self->{term}->ungrab;	2000	$self->{term}->ungrab;
1445	}	2001	}
		2002
		2003	=back
		2004
		2005	=cut
		2006
		2007	package urxvt::watcher;
1446		2008
1447	=head2 The C<urxvt::timer> Class	2009	=head2 The C<urxvt::timer> Class
1448		2010
1449	This class implements timer watchers/events. Time is represented as a	2011	This class implements timer watchers/events. Time is represented as a
1450	fractional number of seconds since the epoch. Example:	2012	fractional number of seconds since the epoch. Example:
…		…
1454	->new	2016	->new
1455	->interval (1)	2017	->interval (1)
1456	->cb (sub {	2018	->cb (sub {
1457	$term->{overlay}->set (0, 0,	2019	$term->{overlay}->set (0, 0,
1458	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2020	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1459	});	2021	});
1460		2022
1461	=over 4	2023	=over 4
1462		2024
1463	=item $timer = new urxvt::timer	2025	=item $timer = new urxvt::timer
1464		2026
…		…
1488	Start the timer.	2050	Start the timer.
1489		2051
1490	=item $timer = $timer->start ($tstamp)	2052	=item $timer = $timer->start ($tstamp)
1491		2053
1492	Set the event trigger time to C<$tstamp> and start the timer.	2054	Set the event trigger time to C<$tstamp> and start the timer.
		2055
		2056	=item $timer = $timer->after ($delay)
		2057
		2058	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1493		2059
1494	=item $timer = $timer->stop	2060	=item $timer = $timer->stop
1495		2061
1496	Stop the timer.	2062	Stop the timer.
1497		2063
…		…
1503		2069
1504	$term->{socket} = ...	2070	$term->{socket} = ...
1505	$term->{iow} = urxvt::iow	2071	$term->{iow} = urxvt::iow
1506	->new	2072	->new
1507	->fd (fileno $term->{socket})	2073	->fd (fileno $term->{socket})
1508	->events (urxvt::EVENT_READ)	2074	->events (urxvt::EV_READ)
1509	->start	2075	->start
1510	->cb (sub {	2076	->cb (sub {
1511	my ($iow, $revents) = @_;	2077	my ($iow, $revents) = @_;
1512	# $revents must be 1 here, no need to check	2078	# $revents must be 1 here, no need to check
1513	sysread $term->{socket}, my $buf, 8192	2079	sysread $term->{socket}, my $buf, 8192
…		…
1526	Set the callback to be called when io events are triggered. C<$reventmask>	2092	Set the callback to be called when io events are triggered. C<$reventmask>
1527	is a bitset as described in the C<events> method.	2093	is a bitset as described in the C<events> method.
1528		2094
1529	=item $iow = $iow->fd ($fd)	2095	=item $iow = $iow->fd ($fd)
1530		2096
1531	Set the filedescriptor (not handle) to watch.	2097	Set the file descriptor (not handle) to watch.
1532		2098
1533	=item $iow = $iow->events ($eventmask)	2099	=item $iow = $iow->events ($eventmask)
1534		2100
1535	Set the event mask to watch. The only allowed values are	2101	Set the event mask to watch. The only allowed values are
1536	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2102	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1537	together, or C<urxvt::EVENT_NONE>.	2103	together, or C<urxvt::EV_NONE>.
1538		2104
1539	=item $iow = $iow->start	2105	=item $iow = $iow->start
1540		2106
1541	Start watching for requested events on the given handle.	2107	Start watching for requested events on the given handle.
1542		2108
1543	=item $iow = $iow->stop	2109	=item $iow = $iow->stop
1544		2110
1545	Stop watching for events on the given filehandle.	2111	Stop watching for events on the given file handle.
		2112
		2113	=back
		2114
		2115	=head2 The C<urxvt::iw> Class
		2116
		2117	This class implements idle watchers, that get called automatically when
		2118	the process is idle. They should return as fast as possible, after doing
		2119	some useful work.
		2120
		2121	=over 4
		2122
		2123	=item $iw = new urxvt::iw
		2124
		2125	Create a new idle watcher object in stopped state.
		2126
		2127	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2128
		2129	Set the callback to be called when the watcher triggers.
		2130
		2131	=item $timer = $timer->start
		2132
		2133	Start the watcher.
		2134
		2135	=item $timer = $timer->stop
		2136
		2137	Stop the watcher.
		2138
		2139	=back
		2140
		2141	=head2 The C<urxvt::pw> Class
		2142
		2143	This class implements process watchers. They create an event whenever a
		2144	process exits, after which they stop automatically.
		2145
		2146	my $pid = fork;
		2147	...
		2148	$term->{pw} = urxvt::pw
		2149	->new
		2150	->start ($pid)
		2151	->cb (sub {
		2152	my ($pw, $exit_status) = @_;
		2153	...
		2154	});
		2155
		2156	=over 4
		2157
		2158	=item $pw = new urxvt::pw
		2159
		2160	Create a new process watcher in stopped state.
		2161
		2162	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2163
		2164	Set the callback to be called when the timer triggers.
		2165
		2166	=item $pw = $timer->start ($pid)
		2167
		2168	Tells the watcher to start watching for process C<$pid>.
		2169
		2170	=item $pw = $pw->stop
		2171
		2172	Stop the watcher.
1546		2173
1547	=back	2174	=back
1548		2175
1549	=head1 ENVIRONMENT	2176	=head1 ENVIRONMENT
1550		2177
…		…
1557		2184
1558	=item == 0 - fatal messages	2185	=item == 0 - fatal messages
1559		2186
1560	=item >= 3 - script loading and management	2187	=item >= 3 - script loading and management
1561		2188
1562	=item >=10 - all events received	2189	=item >=10 - all called hooks
		2190
		2191	=item >=11 - hook return values
1563		2192
1564	=back	2193	=back
1565		2194
1566	=head1 AUTHOR	2195	=head1 AUTHOR
1567		2196
…		…
1569	http://software.schmorp.de/pkg/rxvt-unicode	2198	http://software.schmorp.de/pkg/rxvt-unicode
1570		2199
1571	=cut	2200	=cut
1572		2201
1573	1	2202	1
		2203
		2204	# vim: sw=3:

Diff Legend

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