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.90 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 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>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
58	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
59	...	66	...
60		67
61	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
64	between two vertical bars:	71	between two vertical bars:
65		72
66	URxvt.selection.pattern-0: \\|([^|]+)\\|	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: ^(/[^:]+):\
67		81
68	You can look at the source of the selection extension to see more	82	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
70		84
71	This extension also offers the following bindable keyboard command:	85	This extension also offers following bindable keyboard commands:
72		86
73	=over 4	87	=over 4
74		88
75	=item rot13	89	=item rot13
76		90
…		…
83	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
84		98
85	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
86	runtime.	100	runtime.
87		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
88	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
89		120
90	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
91	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
92	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	};
93		143
94	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
95		145
96	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
104	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
107	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
108		189
109	=item selection-autotransform	190	=item selection-autotransform
110		191
111	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	193	whenever a selection is made.
…		…
120		201
121	For example, the following will transform selections of the form	202	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename	203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:	204	$word>:
124		205
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		207
127	And this example matches the same,but replaces it with vi-commands you can	208	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:	209	paste directly into your (vi :) editor:
129		210
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		212
132	Of course, this can be modified to suit your needs and your editor :)	213	Of course, this can be modified to suit your needs and your editor :)
133		214
134	=item mark-urls	215	To expand the example above to typical perl error messages ("XXX at
		216	FILENAME line YYY."), you need a slightly more elaborate solution:
135		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
136	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
137	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
138	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
139	the URL as first argument.	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.
140		313
141	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
142		315
143	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
144	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
145	similar-looking ascii character.	318	similar-looking ascii character.
146		319
147	=item digital-clock	320	=item digital-clock
148		321
149	Displays a digital clock using the built-in overlay.	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 whether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-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<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
150		391
151	=item example-refresh-hooks	392	=item example-refresh-hooks
152		393
153	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
154	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
155	overlays or changes.	396	overlays or changes.
		397
		398	=item confirm-paste
		399
		400	Displays a confirmation dialog when a paste containing at least a full
		401	line is detected.
156		402
157	=back	403	=back
158		404
159	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
160		406
…		…
176		422
177	=over 4	423	=over 4
178		424
179	=item $text	425	=item $text
180		426
181	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
182	always represents one screen cell. See L<ROW_t> for a discussion of this format.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
183		429
184	=item $string	430	=item $string
185		431
186	A perl text string, with an emphasis on I<text>. It can store all unicode	432	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
194		440
195	=back	441	=back
196		442
197	=head2 Extension Objects	443	=head2 Extension Objects
198		444
199	Very perl extension is a perl class. A separate perl object is created	445	Every perl extension is a perl class. A separate perl object is created
200	for each terminal and each extension and passed as the first parameter to	446	for each terminal, and each terminal has its own set of extenion objects,
201	hooks. So extensions can use their C<$self> object without having to think	447	which are passed as the first parameter to hooks. So extensions can use
202	about other extensions, with the exception of methods and members that	448	their C<$self> object without having to think about clashes with other
		449	extensions or other terminals, with the exception of methods and members
203	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
204	use.	451	internal use.
205		452
206	Although it isn't a C<urxvt::term> object, you can call all methods of the	453	Although it isn't a C<urxvt::term> object, you can call all methods of the
207	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
208		455
209	It has the following methods and data members:	456	It has the following methods and data members:
…		…
230	=head2 Hooks	477	=head2 Hooks
231		478
232	The following subroutines can be declared in extension files, and will be	479	The following subroutines can be declared in extension files, and will be
233	called whenever the relevant event happens.	480	called whenever the relevant event happens.
234		481
235	The first argument passed to them is an extension oject as described in	482	The first argument passed to them is an extension object as described in
236	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
237		484
238	B<All> of these hooks must return a boolean value. If it is true, then the	485	B<All> of these hooks must return a boolean value. If any of the called
239	event counts as being I<consumed>, and the invocation of other hooks is	486	hooks returns true, then the event counts as being I<consumed>, and the
240	skipped, and the relevant action might not be carried out by the C++ code.	487	relevant action might not be carried out by the C++ code.
241		488
242	I<< When in doubt, return a false value (preferably C<()>). >>	489	I<< When in doubt, return a false value (preferably C<()>). >>
243		490
244	=over 4	491	=over 4
245		492
246	=item on_init $term	493	=item on_init $term
247		494
248	Called after a new terminal object has been initialized, but before	495	Called after a new terminal object has been initialized, but before
249	windows are created or the command gets run. Most methods are unsafe to	496	windows are created or the command gets run. Most methods are unsafe to
250	call or deliver senseless data, as terminal size and other characteristics	497	call or deliver senseless data, as terminal size and other characteristics
251	have not yet been determined. You can safely query and change resources,	498	have not yet been determined. You can safely query and change resources
252	though.	499	and options, though. For many purposes the C<on_start> hook is a better
		500	place.
		501
		502	=item on_start $term
		503
		504	Called at the very end of initialisation of a new terminal, just before
		505	trying to map (display) the toplevel and returning to the main loop.
		506
		507	=item on_destroy $term
		508
		509	Called whenever something tries to destroy terminal, when the terminal is
		510	still fully functional (not for long, though).
253		511
254	=item on_reset $term	512	=item on_reset $term
255		513
256	Called after the screen is "reset" for any reason, such as resizing or	514	Called after the screen is "reset" for any reason, such as resizing or
257	control sequences. Here is where you can react on changes to size-related	515	control sequences. Here is where you can react on changes to size-related
258	variables.	516	variables.
259		517
260	=item on_start $term	518	=item on_child_start $term, $pid
261		519
262	Called at the very end of initialisation of a new terminal, just before	520	Called just after the child process has been C<fork>ed.
263	returning to the mainloop.	521
		522	=item on_child_exit $term, $status
		523
		524	Called just after the child process has exited. C<$status> is the status
		525	from C<waitpid>.
264		526
265	=item on_sel_make $term, $eventtime	527	=item on_sel_make $term, $eventtime
266		528
267	Called whenever a selection has been made by the user, but before the	529	Called whenever a selection has been made by the user, but before the
268	selection text is copied, so changes to the beginning, end or type of the	530	selection text is copied, so changes to the beginning, end or type of the
…		…
275		537
276	Called whenever a selection has been copied, but before the selection is	538	Called whenever a selection has been copied, but before the selection is
277	requested from the server. The selection text can be queried and changed	539	requested from the server. The selection text can be queried and changed
278	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
279		541
280	Returning a true value aborts selection grabbing. It will still be hilighted.	542	Returning a true value aborts selection grabbing. It will still be highlighted.
281		543
282	=item on_sel_extend $term	544	=item on_sel_extend $term
283		545
284	Called whenever the user tries to extend the selection (e.g. with a double	546	Called whenever the user tries to extend the selection (e.g. with a double
285	click) and is either supposed to return false (normal operation), or	547	click) and is either supposed to return false (normal operation), or
286	should extend the selection itelf and return true to suppress the built-in	548	should extend the selection itself and return true to suppress the built-in
287	processing. This can happen multiple times, as long as the callback	549	processing. This can happen multiple times, as long as the callback
288	returns true, it will be called on every further click by the user and is	550	returns true, it will be called on every further click by the user and is
289	supposed to enlarge the selection more and more, if possible.	551	supposed to enlarge the selection more and more, if possible.
290		552
291	See the F<selection> example extension.	553	See the F<selection> example extension.
292		554
293	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
294		556
295	Called whenever the view offset changes, i..e the user or program	557	Called whenever the view offset changes, i.e. the user or program
296	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
297	show this many lines of scrollback.	559	show this many lines of scrollback.
298		560
299	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
300		562
…		…
304		566
305	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	567	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
306	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	568	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
307	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
308		570
309	=item on_osc_seq $term, $string	571	=item on_osc_seq $term, $op, $args, $resp
		572
		573	Called on every OSC sequence and can be used to suppress it or modify its
		574	behaviour. The default should be to return an empty list. A true value
		575	suppresses execution of the request completely. Make sure you don't get
		576	confused by recursive invocations when you output an OSC sequence within
		577	this callback.
		578
		579	C<on_osc_seq_perl> should be used for new behaviour.
		580
		581	=item on_osc_seq_perl $term, $args, $resp
310		582
311	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
312	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
313	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
314	string should start with the extension name and a colon, to distinguish	586	string should start with the extension name (sans -osc) and a semicolon,
315	it from commands for other extensions, and this might be enforced in the	587	to distinguish it from commands for other extensions, and this might be
316	future.	588	enforced in the future.
		589
		590	For example, C<overlay-osc> uses this:
		591
		592	sub on_osc_seq_perl {
		593	my ($self, $osc, $resp) = @_;
		594
		595	return unless $osc =~ s/^overlay;//;
		596
		597	... process remaining $osc string
		598	}
317		599
318	Be careful not ever to trust (in a security sense) the data you receive,	600	Be careful not ever to trust (in a security sense) the data you receive,
319	as its source can not easily be controleld (e-mail content, messages from	601	as its source can not easily be controlled (e-mail content, messages from
320	other users on the same system etc.).	602	other users on the same system etc.).
		603
		604	For responses, C<$resp> contains the end-of-args separator used by the
		605	sender.
321		606
322	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
323		608
324	Called whenever text is about to be output, with the text as argument. You	609	Called whenever text is about to be output, with the text as argument. You
325	can filter/change and output the text yourself by returning a true value	610	can filter/change and output the text yourself by returning a true value
…		…
330	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
331		616
332	Called whenever some data is written to the tty/pty and can be used to	617	Called whenever some data is written to the tty/pty and can be used to
333	suppress or filter tty input.	618	suppress or filter tty input.
334		619
		620	=item on_tt_paste $term, $octets
		621
		622	Called whenever text is about to be pasted, with the text as argument. You
		623	can filter/change and paste the text yourself by returning a true value
		624	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		625	locale-encoded.
		626
335	=item on_line_update $term, $row	627	=item on_line_update $term, $row
336		628
337	Called whenever a line was updated or changed. Can be used to filter	629	Called whenever a line was updated or changed. Can be used to filter
338	screen output (e.g. underline urls or other useless stuff). Only lines	630	screen output (e.g. underline urls or other useless stuff). Only lines
339	that are being shown will be filtered, and, due to performance reasons,	631	that are being shown will be filtered, and, due to performance reasons,
…		…
346	later with the already-modified line (e.g. if unrelated parts change), so	638	later with the already-modified line (e.g. if unrelated parts change), so
347	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
348		640
349	=item on_refresh_begin $term	641	=item on_refresh_begin $term
350		642
351	Called just before the screen gets redrawn. Can be used for overlay	643	Called just before the screen gets redrawn. Can be used for overlay or
352	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
353	restoring them in refresh_end. The built-in overlay and selection display	645	restoring them in refresh_end. The built-in overlay and selection display
354	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
355		647
356	=item on_refresh_end $term	648	=item on_refresh_end $term
357		649
358	Called just after the screen gets redrawn. See C<on_refresh_begin>.	650	Called just after the screen gets redrawn. See C<on_refresh_begin>.
359		651
360	=item on_keyboard_command $term, $string	652	=item on_user_command $term, $string
361		653
362	Called whenever the user presses a key combination that has a	654	Called whenever a user-configured event is being activated (e.g. via
363	C<perl:string> action bound to it (see description of the B<keysym>	655	a C<perl:string> action bound to a key, see description of the B<keysym>
364	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
		657
		658	The event is simply the action string. This interface is assumed to change
		659	slightly in the future.
		660
		661	=item on_resize_all_windows $term, $new_width, $new_height
		662
		663	Called just after the new window size has been calculated, but before
		664	windows are actually being resized or hints are being set. If this hook
		665	returns TRUE, setting of the window hints is being skipped.
		666
		667	=item on_x_event $term, $event
		668
		669	Called on every X event received on the vt window (and possibly other
		670	windows). Should only be used as a last resort. Most event structure
		671	members are not passed.
		672
		673	=item on_root_event $term, $event
		674
		675	Like C<on_x_event>, but is called for events on the root window.
365		676
366	=item on_focus_in $term	677	=item on_focus_in $term
367		678
368	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
369	does focus in processing.	680	does focus in processing.
370		681
371	=item on_focus_out $term	682	=item on_focus_out $term
372		683
373	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
374	focus out processing.	685	focus out processing.
375		686
		687	=item on_configure_notify $term, $event
		688
		689	=item on_property_notify $term, $event
		690
376	=item on_key_press $term, $event, $keysym, $octets	691	=item on_key_press $term, $event, $keysym, $octets
377		692
378	=item on_key_release $term, $event, $keysym	693	=item on_key_release $term, $event, $keysym
379		694
380	=item on_button_press $term, $event	695	=item on_button_press $term, $event
…		…
385		700
386	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
387		702
388	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
389		704
390	Called whenever the corresponding X event is received for the terminal If	705	Called whenever the corresponding X event is received for the terminal. If
391	the hook returns true, then the even will be ignored by rxvt-unicode.	706	the hook returns true, then the event will be ignored by rxvt-unicode.
392		707
393	The event is a hash with most values as named by Xlib (see the XEvent	708	The event is a hash with most values as named by Xlib (see the XEvent
394	manpage), with the additional members C<row> and C<col>, which are the row	709	manpage), with the additional members C<row> and C<col>, which are the
395	and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
396		711
397	C<on_key_press> additionally receives the string rxvt-unicode would	712	C<on_key_press> additionally receives the string rxvt-unicode would
398	output, if any, in locale-specific encoding.	713	output, if any, in locale-specific encoding.
399		714
400	subwindow.	715	subwindow.
		716
		717	=item on_client_message $term, $event
		718
		719	=item on_wm_protocols $term, $event
		720
		721	=item on_wm_delete_window $term, $event
		722
		723	Called when various types of ClientMessage events are received (all with
		724	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		725
		726	=item on_bell $term
		727
		728	Called on receipt of a bell character.
401		729
402	=back	730	=back
403		731
404	=cut	732	=cut
405		733
…		…
411	use Scalar::Util ();	739	use Scalar::Util ();
412	use List::Util ();	740	use List::Util ();
413		741
414	our $VERSION = 1;	742	our $VERSION = 1;
415	our $TERM;	743	our $TERM;
		744	our @TERM_INIT;
		745	our @TERM_EXT;
416	our @HOOKNAME;	746	our @HOOKNAME;
417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	747	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
418	our %OPTION;	748	our %OPTION;
419		749
420	our $LIBDIR;	750	our $LIBDIR;
421	our $RESNAME;	751	our $RESNAME;
422	our $RESCLASS;	752	our $RESCLASS;
423	our $RXVTNAME;	753	our $RXVTNAME;
424		754
		755	our $NOCHAR = chr 0xffff;
		756
425	=head2 Variables in the C<urxvt> Package	757	=head2 Variables in the C<urxvt> Package
426		758
427	=over 4	759	=over 4
428		760
429	=item $urxvt::LIBDIR	761	=item $urxvt::LIBDIR
…		…
441		773
442	=item $urxvt::TERM	774	=item $urxvt::TERM
443		775
444	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
445	object, whenever a callback/hook is executing.	777	object, whenever a callback/hook is executing.
		778
		779	=item @urxvt::TERM_INIT
		780
		781	All code references in this array will be called as methods of the next newly
		782	created C<urxvt::term> object (during the C<on_init> phase). The array
		783	gets cleared before the code references that were in it are being executed,
		784	so references can push themselves onto it again if they so desire.
		785
		786	This complements to the perl-eval command line option, but gets executed
		787	first.
		788
		789	=item @urxvt::TERM_EXT
		790
		791	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		792	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		793	but before other extensions. Gets cleared just like C<@TERM_INIT>.
446		794
447	=back	795	=back
448		796
449	=head2 Functions in the C<urxvt> Package	797	=head2 Functions in the C<urxvt> Package
450		798
…		…
465	Using this function has the advantage that its output ends up in the	813	Using this function has the advantage that its output ends up in the
466	correct place, e.g. on stderr of the connecting urxvtc client.	814	correct place, e.g. on stderr of the connecting urxvtc client.
467		815
468	Messages have a size limit of 1023 bytes currently.	816	Messages have a size limit of 1023 bytes currently.
469		817
470	=item $is_safe = urxvt::safe	818	=item @terms = urxvt::termlist
471		819
472	Returns true when it is safe to do potentially unsafe things, such as	820	Returns all urxvt::term objects that exist in this process, regardless of
473	evaluating perl code specified by the user. This is true when urxvt was	821	whether they are started, being destroyed etc., so be careful. Only term
474	started setuid or setgid.	822	objects that have perl extensions attached will be returned (because there
		823	is no urxvt::term objet associated with others).
475		824
476	=item $time = urxvt::NOW	825	=item $time = urxvt::NOW
477		826
478	Returns the "current time" (as per the event loop).	827	Returns the "current time" (as per the event loop).
479		828
480	=item urxvt::CurrentTime	829	=item urxvt::CurrentTime
481		830
482	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	831	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
483	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	832	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
484	Button4Mask, Button5Mask, AnyModifier	833	Button4Mask, Button5Mask, AnyModifier
		834
		835	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		836	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		837	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		838	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		839	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		840	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		841	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		842
		843	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		844	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		845	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		846	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		847	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		848	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		849	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
485		850
486	Various constants for use in X calls and event processing.	851	Various constants for use in X calls and event processing.
487		852
488	=back	853	=back
489		854
…		…
506		871
507	=item $rend = urxvt::OVERLAY_RSTYLE	872	=item $rend = urxvt::OVERLAY_RSTYLE
508		873
509	Return the rendition mask used for overlays by default.	874	Return the rendition mask used for overlays by default.
510		875
511	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	876	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		877	urxvt::RS_RVid, urxvt::RS_Uline
512		878
513	Return the bit that enabled bold, italic, blink, reverse-video and	879	Return the bit that enabled bold, italic, blink, reverse-video and
514	underline, respectively. To enable such a style, just logically OR it into	880	underline, respectively. To enable such a style, just logically OR it into
515	the bitset.	881	the bitset.
516		882
…		…
522		888
523	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	889	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
524		890
525	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	891	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
526		892
		893	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		894
527	Replace the foreground/background colour in the rendition mask with the	895	Replace the foreground/background colour in the rendition mask with the
528	specified one.	896	specified one.
529		897
530	=item $value = urxvt::GET_CUSTOM $rend	898	=item $value = urxvt::GET_CUSTOM $rend
531		899
…		…
540	=back	908	=back
541		909
542	=cut	910	=cut
543		911
544	BEGIN {	912	BEGIN {
545	urxvt->bootstrap;
546
547	# overwrite perl's warn	913	# overwrite perl's warn
548	*CORE::GLOBAL::warn = sub {	914	*CORE::GLOBAL::warn = sub {
549	my $msg = join "", @_;	915	my $msg = join "", @_;
550	$msg .= "\n"	916	$msg .= "\n"
551	unless $msg =~ /\n$/;	917	unless $msg =~ /\n$/;
552	urxvt::warn ($msg);	918	urxvt::warn ($msg);
553	};	919	};
554
555	# %ENV is the original startup environment
556	delete $ENV{IFS};
557	delete $ENV{CDPATH};
558	delete $ENV{BASH_ENV};
559	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
560	}	920	}
561		921
562	my @hook_count;	922	no warnings 'utf8';
		923
563	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	924	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
564		925
565	sub verbose {	926	sub verbose {
566	my ($level, $msg) = @_;	927	my ($level, $msg) = @_;
567	warn "$msg\n" if $level <= $verbosity;	928	warn "$msg\n" if $level <= $verbosity;
568	}	929	}
569		930
570	my $extension_pkg = "extension0000";
571	my %extension_pkg;	931	my %extension_pkg;
572		932
573	# load a single script into its own package, once only	933	# load a single script into its own package, once only
574	sub extension_package($) {	934	sub extension_package($) {
575	my ($path) = @_;	935	my ($path) = @_;
576		936
577	$extension_pkg{$path} ||= do {	937	$extension_pkg{$path} ||= do {
578	my $pkg = "urxvt::" . ($extension_pkg++);	938	$path =~ /([^\/\\]+)$/;
		939	my $pkg = $1;
		940	$pkg =~ s/[^[:word:]]/_/g;
		941	$pkg = "urxvt::ext::$pkg";
579		942
580	verbose 3, "loading extension '$path' into package '$pkg'";	943	verbose 3, "loading extension '$path' into package '$pkg'";
581		944
582	open my $fh, "<:raw", $path	945	open my $fh, "<:raw", $path
583	or die "$path: $!";	946	or die "$path: $!";
584		947
585	my $source = untaint	948	my $source =
586	"package $pkg; use strict; use utf8;\n"	949	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
587	. "use base urxvt::term::extension::;\n"
588	. "#line 1 \"$path\"\n{\n"	950	. "#line 1 \"$path\"\n{\n"
589	. (do { local $/; <$fh> })	951	. (do { local $/; <$fh> })
590	. "\n};\n1";	952	. "\n};\n1";
591		953
592	eval $source	954	eval $source
…		…
603	local $TERM = shift;	965	local $TERM = shift;
604	my $htype = shift;	966	my $htype = shift;
605		967
606	if ($htype == 0) { # INIT	968	if ($htype == 0) { # INIT
607	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	969	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
608		970
609	my %ext_arg;	971	my %ext_arg;
610		972
		973	{
		974	my @init = @TERM_INIT;
		975	@TERM_INIT = ();
		976	$_->($TERM) for @init;
		977	my @pkg = @TERM_EXT;
		978	@TERM_EXT = ();
		979	$TERM->register_package ($_) for @pkg;
		980	}
		981
611	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	982	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
612	if ($_ eq "default") {	983	if ($_ eq "default") {
613	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	984	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
614	} elsif (/^-(.*)$/) {	985	} elsif (/^-(.*)$/) {
615	delete $ext_arg{$1};	986	delete $ext_arg{$1};
616	} elsif (/^([^<]+)<(.*)>$/) {	987	} elsif (/^([^<]+)<(.*)>$/) {
617	push @{ $ext_arg{$1} }, $2;	988	push @{ $ext_arg{$1} }, $2;
618	} else {	989	} else {
619	$ext_arg{$_} ||= [];	990	$ext_arg{$_} ||= [];
620	}	991	}
621	}	992	}
622		993
623	while (my ($ext, $argv) = each %ext_arg) {	994	for my $ext (sort keys %ext_arg) {
624	my @files = grep -f $_, map "$_/$ext", @dirs;	995	my @files = grep -f $_, map "$_/$ext", @dirs;
625		996
626	if (@files) {	997	if (@files) {
627	$TERM->register_package (extension_package $files[0], $argv);	998	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
628	} else {	999	} else {
629	warn "perl extension '$ext' not found in perl library search path\n";	1000	warn "perl extension '$ext' not found in perl library search path\n";
630	}	1001	}
631	}	1002	}
632		1003
…		…
638		1009
639	if (my $cb = $TERM->{_hook}[$htype]) {	1010	if (my $cb = $TERM->{_hook}[$htype]) {
640	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1011	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
641	if $verbosity >= 10;	1012	if $verbosity >= 10;
642		1013
643	keys %$cb;	1014	for my $pkg (keys %$cb) {
644
645	while (my ($pkg, $cb) = each %$cb) {
646	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1015	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
647	and last;	1016	$retval ||= $retval_;
648		1017
649	if ($@) {	1018	if ($@) {
650	$TERM->ungrab; # better to lose the grab than the session	1019	$TERM->ungrab; # better to lose the grab than the session
651	warn $@;	1020	warn $@;
652	}	1021	}
…		…
655	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	1024	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656	if $verbosity >= 11;	1025	if $verbosity >= 11;
657	}	1026	}
658		1027
659	if ($htype == 1) { # DESTROY	1028	if ($htype == 1) { # DESTROY
660	if (my $hook = delete $TERM->{_hook}) {
661	for my $htype (0..$#$hook) {
662	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
663	or set_should_invoke $htype, 0;
664	}
665	}
666
667	# clear package objects	1029	# clear package objects
668	%$_ = () for values %{ $TERM->{_pkg} };	1030	%$_ = () for values %{ $TERM->{_pkg} };
669		1031
670	# clear package	1032	# clear package
671	%$TERM = ();	1033	%$TERM = ();
672	}	1034	}
673		1035
674	$retval	1036	$retval
675	}	1037	}
676		1038
677	sub exec_async(@) {	1039	sub SET_COLOR($$$) {
678	my $pid = fork;	1040	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1041	}
679		1042
680	return	1043	sub rend2mask {
681	if !defined $pid or $pid;	1044	no strict 'refs';
682		1045	my ($str, $mask) = (@_, 0);
683	%ENV = %{ $TERM->env };	1046	my %color = ( fg => undef, bg => undef );
684		1047	my @failed;
685	exec @_;	1048	for my $spec ( split /\s+/, $str ) {
686	_exit 255;	1049	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1050	$color{lc($1)} = $2;
		1051	} else {
		1052	my $neg = $spec =~ s/^[-^]//;
		1053	unless ( exists &{"RS_$spec"} ) {
		1054	push @failed, $spec;
		1055	next;
		1056	}
		1057	my $cur = &{"RS_$spec"};
		1058	if ( $neg ) {
		1059	$mask &= ~$cur;
		1060	} else {
		1061	$mask |= $cur;
		1062	}
		1063	}
		1064	}
		1065	($mask, @color{qw(fg bg)}, \@failed)
687	}	1066	}
688		1067
689	# urxvt::term::extension	1068	# urxvt::term::extension
690		1069
691	package urxvt::term::extension;	1070	package urxvt::term::extension;
…		…
697	while (my ($name, $cb) = each %hook) {	1076	while (my ($name, $cb) = each %hook) {
698	my $htype = $HOOKTYPE{uc $name};	1077	my $htype = $HOOKTYPE{uc $name};
699	defined $htype	1078	defined $htype
700	or Carp::croak "unsupported hook type '$name'";	1079	or Carp::croak "unsupported hook type '$name'";
701		1080
		1081	$self->set_should_invoke ($htype, +1)
702	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1082	unless exists $self->{term}{_hook}[$htype]{$pkg};
703	$hook_count[$htype]++
704	or urxvt::set_should_invoke $htype, 1;
705	}
706		1083
707	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1084	$self->{term}{_hook}[$htype]{$pkg} = $cb;
708	}	1085	}
709	}	1086	}
710		1087
…		…
715	for my $name (@hook) {	1092	for my $name (@hook) {
716	my $htype = $HOOKTYPE{uc $name};	1093	my $htype = $HOOKTYPE{uc $name};
717	defined $htype	1094	defined $htype
718	or Carp::croak "unsupported hook type '$name'";	1095	or Carp::croak "unsupported hook type '$name'";
719		1096
		1097	$self->set_should_invoke ($htype, -1)
720	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1098	if delete $self->{term}{_hook}[$htype]{$pkg};
721	--$hook_count[$htype]
722	or urxvt::set_should_invoke $htype, 0;
723	}
724	}	1099	}
725	}	1100	}
726		1101
727	our $AUTOLOAD;	1102	our $AUTOLOAD;
728		1103
…		…
766	is that you cannot use blocking APIs, but the non-blocking variant should	1141	is that you cannot use blocking APIs, but the non-blocking variant should
767	work.	1142	work.
768		1143
769	=cut	1144	=cut
770		1145
771	our $VERSION = 1;	1146	our $VERSION = '5.23';
772		1147
773	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1148	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
774	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1149	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
775		1150
776	sub timer {	1151	sub timer {
…		…
778		1153
779	my $cb = $arg{cb};	1154	my $cb = $arg{cb};
780		1155
781	urxvt::timer	1156	urxvt::timer
782	->new	1157	->new
783	->start (urxvt::NOW + $arg{after})	1158	->after ($arg{after}, $arg{interval})
784	->cb (sub {	1159	->cb ($arg{interval} ? $cb : sub {
785	$_[0]->stop; # need to cancel manually	1160	$_[0]->stop; # need to cancel manually
786	$cb->();	1161	$cb->();
787	})	1162	})
788	}	1163	}
789		1164
790	sub io {	1165	sub io {
791	my ($class, %arg) = @_;	1166	my ($class, %arg) = @_;
792		1167
793	my $cb = $arg{cb};	1168	my $cb = $arg{cb};
		1169	my $fd = fileno $arg{fh};
		1170	defined $fd or $fd = $arg{fh};
794		1171
795	bless [$arg{fh}, urxvt::iow	1172	bless [$arg{fh}, urxvt::iow
796	->new	1173	->new
797	->fd (fileno $arg{fh})	1174	->fd ($fd)
798	->events (($arg{poll} =~ /r/ ? 1 : 0)	1175	->events (($arg{poll} =~ /r/ ? 1 : 0)
799	| ($arg{poll} =~ /w/ ? 2 : 0))	1176	| ($arg{poll} =~ /w/ ? 2 : 0))
800	->start	1177	->start
801	->cb (sub {	1178	->cb ($cb)
802	$cb->(($_[1] & 1 ? 'r' : '')
803	. ($_[1] & 2 ? 'w' : ''));
804	})],
805	urxvt::anyevent::	1179	], urxvt::anyevent::
		1180	}
		1181
		1182	sub idle {
		1183	my ($class, %arg) = @_;
		1184
		1185	my $cb = $arg{cb};
		1186
		1187	urxvt::iw
		1188	->new
		1189	->start
		1190	->cb ($cb)
		1191	}
		1192
		1193	sub child {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::pw
		1199	->new
		1200	->start ($arg{pid})
		1201	->cb (sub {
		1202	$_[0]->stop; # need to cancel manually
		1203	$cb->($_[0]->rpid, $_[0]->rstatus);
		1204	})
806	}	1205	}
807		1206
808	sub DESTROY {	1207	sub DESTROY {
809	$_[0][1]->stop;	1208	$_[0][1]->stop;
810	}	1209	}
811		1210
812	sub condvar {	1211	sub one_event {
813	bless \my $flag, urxvt::anyevent::condvar::
814	}
815
816	sub urxvt::anyevent::condvar::broadcast {
817	${$_[0]}++;
818	}
819
820	sub urxvt::anyevent::condvar::wait {
821	unless (${$_[0]}) {
822	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1212	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
823	}
824	}	1213	}
825		1214
826	package urxvt::term;	1215	package urxvt::term;
827		1216
828	=head2 The C<urxvt::term> Class	1217	=head2 The C<urxvt::term> Class
…		…
833		1222
834	# find on_xxx subs in the package and register them	1223	# find on_xxx subs in the package and register them
835	# as hooks	1224	# as hooks
836	sub register_package {	1225	sub register_package {
837	my ($self, $pkg, $argv) = @_;	1226	my ($self, $pkg, $argv) = @_;
		1227
		1228	no strict 'refs';
		1229
		1230	urxvt::verbose 6, "register package $pkg to $self";
		1231
		1232	@{"$pkg\::ISA"} = urxvt::term::extension::;
838		1233
839	my $proxy = bless {	1234	my $proxy = bless {
840	_pkg => $pkg,	1235	_pkg => $pkg,
841	argv => $argv,	1236	argv => $argv,
842	}, $pkg;	1237	}, $pkg;
…		…
858	hash which defines the environment of the new terminal.	1253	hash which defines the environment of the new terminal.
859		1254
860	Croaks (and probably outputs an error message) if the new instance	1255	Croaks (and probably outputs an error message) if the new instance
861	couldn't be created. Returns C<undef> if the new instance didn't	1256	couldn't be created. Returns C<undef> if the new instance didn't
862	initialise perl, and the terminal object otherwise. The C<init> and	1257	initialise perl, and the terminal object otherwise. The C<init> and
863	C<start> hooks will be called during this call.	1258	C<start> hooks will be called before this call returns, and are free to
		1259	refer to global data (which is race free).
864		1260
865	=cut	1261	=cut
866		1262
867	sub new {	1263	sub new {
868	my ($class, $env, @args) = @_;	1264	my ($class, $env, @args) = @_;
869		1265
		1266	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1267	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1268
870	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1269	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
871	}	1270	}
872		1271
873	=item $term->destroy	1272	=item $term->destroy
874		1273
875	Destroy the terminal object (close the window, free resources	1274	Destroy the terminal object (close the window, free resources
876	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1275	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
877	watchers (timers, io watchers) are still active.	1276	watchers (timers, io watchers) are still active.
878		1277
		1278	=item $term->exec_async ($cmd[, @args])
		1279
		1280	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1281	("starts") programs in the background. This function takes care of setting
		1282	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1283	be preferred over explicit calls to C<exec> or C<system>.
		1284
		1285	Returns the pid of the subprocess or C<undef> on error.
		1286
		1287	=cut
		1288
		1289	sub exec_async {
		1290	my $self = shift;
		1291
		1292	my $pid = fork;
		1293
		1294	return $pid
		1295	if !defined $pid or $pid;
		1296
		1297	%ENV = %{ $self->env };
		1298
		1299	exec @_;
		1300	urxvt::_exit 255;
		1301	}
		1302
879	=item $isset = $term->option ($optval[, $set])	1303	=item $isset = $term->option ($optval[, $set])
880		1304
881	Returns true if the option specified by C<$optval> is enabled, and	1305	Returns true if the option specified by C<$optval> is enabled, and
882	optionally change it. All option values are stored by name in the hash	1306	optionally change it. All option values are stored by name in the hash
883	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1307	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
884		1308
885	Here is a a likely non-exhaustive list of option names, please see the	1309	Here is a likely non-exhaustive list of option names, please see the
886	source file F</src/optinc.h> to see the actual list:	1310	source file F</src/optinc.h> to see the actual list:
887		1311
888	borderLess console cursorBlink cursorUnderline hold iconic insecure	1312	borderLess console cursorBlink cursorUnderline hold iconic insecure
889	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1313	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
890	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1314	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
891	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1315	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
892	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1316	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
893	tripleclickwords utmpInhibit visualBell	1317	transparent tripleclickwords utmpInhibit visualBell
894		1318
895	=item $value = $term->resource ($name[, $newval])	1319	=item $value = $term->resource ($name[, $newval])
896		1320
897	Returns the current resource value associated with a given name and	1321	Returns the current resource value associated with a given name and
898	optionally sets a new value. Setting values is most useful in the C<init>	1322	optionally sets a new value. Setting values is most useful in the C<init>
…		…
907	likely change).	1331	likely change).
908		1332
909	Please note that resource strings will currently only be freed when the	1333	Please note that resource strings will currently only be freed when the
910	terminal is destroyed, so changing options frequently will eat memory.	1334	terminal is destroyed, so changing options frequently will eat memory.
911		1335
912	Here is a a likely non-exhaustive list of resource names, not all of which	1336	Here is a likely non-exhaustive list of resource names, not all of which
913	are supported in every build, please see the source file F</src/rsinc.h>	1337	are supported in every build, please see the source file F</src/rsinc.h>
914	to see the actual list:	1338	to see the actual list:
915		1339
916	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1340	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
917	borderLess color cursorBlink cursorUnderline cutchars delete_key	1341	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
918	display_name embed ext_bwidth fade font geometry hold iconName	1342	display_name embed ext_bwidth fade font geometry hold iconName
919	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1343	imFont imLocale inputMethod insecure int_bwidth intensityStyles
920	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1344	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
921	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1345	modifier mouseWheelScrollPage name override_redirect pastableTabs path
922	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1346	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
923	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1347	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
924	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1348	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
925	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1349	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
926	shade term_name title transparent transparent_all tripleclickwords	1350	secondaryScreen secondaryScroll shade term_name title
927	utmpInhibit visualBell	1351	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1352	visualBell
928		1353
929	=cut	1354	=cut
930		1355
931	sub resource($$;$) {	1356	sub resource($$;$) {
932	my ($self, $name) = (shift, shift);	1357	my ($self, $name) = (shift, shift);
933	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1358	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
934	&urxvt::term::_resource	1359	goto &urxvt::term::_resource
935	}	1360	}
936		1361
937	=item $value = $term->x_resource ($pattern)	1362	=item $value = $term->x_resource ($pattern)
938		1363
939	Returns the X-Resource for the given pattern, excluding the program or	1364	Returns the X-Resource for the given pattern, excluding the program or
…		…
964		1389
965	=item ($row, $col) = $term->selection_beg ([$row, $col])	1390	=item ($row, $col) = $term->selection_beg ([$row, $col])
966		1391
967	=item ($row, $col) = $term->selection_end ([$row, $col])	1392	=item ($row, $col) = $term->selection_end ([$row, $col])
968		1393
969	Return the current values of the selection mark, begin or end positions,	1394	Return the current values of the selection mark, begin or end positions.
970	and optionally set them to new values.	1395
		1396	When arguments are given, then the selection coordinates are set to
		1397	C<$row> and C<$col>, and the selection screen is set to the current
		1398	screen.
		1399
		1400	=item $screen = $term->selection_screen ([$screen])
		1401
		1402	Returns the current selection screen, and then optionally sets it.
971		1403
972	=item $term->selection_make ($eventtime[, $rectangular])	1404	=item $term->selection_make ($eventtime[, $rectangular])
973		1405
974	Tries to make a selection as set by C<selection_beg> and	1406	Tries to make a selection as set by C<selection_beg> and
975	C<selection_end>. If C<$rectangular> is true (default: false), a	1407	C<selection_end>. If C<$rectangular> is true (default: false), a
976	rectangular selection will be made. This is the prefered function to make	1408	rectangular selection will be made. This is the preferred function to make
977	a selection.	1409	a selection.
978		1410
979	=item $success = $term->selection_grab ($eventtime)	1411	=item $success = $term->selection_grab ($eventtime[, $clipboard])
980		1412
981	Try to request the primary selection text from the server (for example, as	1413	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1414	true) selection from the server. The corresponding text can be set
982	set by the next method). No visual feedback will be given. This function	1415	with the next method. No visual feedback will be given. This function
983	is mostly useful from within C<on_sel_grab> hooks.	1416	is mostly useful from within C<on_sel_grab> hooks.
984		1417
985	=item $oldtext = $term->selection ([$newtext])	1418	=item $oldtext = $term->selection ([$newtext, $clipboard])
986		1419
987	Return the current selection text and optionally replace it by C<$newtext>.	1420	Return the current selection (clipboard if C<$clipboard> is true) text
		1421	and optionally replace it by C<$newtext>.
		1422
		1423	=item $term->selection_clear ([$clipboard])
		1424
		1425	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
988		1426
989	=item $term->overlay_simple ($x, $y, $text)	1427	=item $term->overlay_simple ($x, $y, $text)
990		1428
991	Create a simple multi-line overlay box. See the next method for details.	1429	Create a simple multi-line overlay box. See the next method for details.
992		1430
…		…
1022		1460
1023	The methods currently supported on C<urxvt::overlay> objects are:	1461	The methods currently supported on C<urxvt::overlay> objects are:
1024		1462
1025	=over 4	1463	=over 4
1026		1464
1027	=item $overlay->set ($x, $y, $text, $rend)	1465	=item $overlay->set ($x, $y, $text[, $rend])
1028		1466
1029	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1467	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1030	text in rxvt-unicode's special encoding and an array of rendition values	1468	text in rxvt-unicode's special encoding and an array of rendition values
1031	at a specific position inside the overlay.	1469	at a specific position inside the overlay.
		1470
		1471	If C<$rend> is missing, then the rendition will not be changed.
1032		1472
1033	=item $overlay->hide	1473	=item $overlay->hide
1034		1474
1035	If visible, hide the overlay, but do not destroy it.	1475	If visible, hide the overlay, but do not destroy it.
1036		1476
…		…
1106		1546
1107	Normally its not a good idea to use this function, as programs might be	1547	Normally its not a good idea to use this function, as programs might be
1108	confused by changes in cursor position or scrolling. Its useful inside a	1548	confused by changes in cursor position or scrolling. Its useful inside a
1109	C<on_add_lines> hook, though.	1549	C<on_add_lines> hook, though.
1110		1550
		1551	=item $term->scr_change_screen ($screen)
		1552
		1553	Switch to given screen - 0 primary, 1 secondary.
		1554
1111	=item $term->cmd_parse ($octets)	1555	=item $term->cmd_parse ($octets)
1112		1556
1113	Similar to C<scr_add_lines>, but the argument must be in the	1557	Similar to C<scr_add_lines>, but the argument must be in the
1114	locale-specific encoding of the terminal and can contain command sequences	1558	locale-specific encoding of the terminal and can contain command sequences
1115	(escape codes) that will be interpreted.	1559	(escape codes) that will be interpreted.
1116		1560
1117	=item $term->tt_write ($octets)	1561	=item $term->tt_write ($octets)
1118		1562
1119	Write the octets given in C<$data> to the tty (i.e. as program input). To	1563	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1120	pass characters instead of octets, you should convert your strings first	1564	pass characters instead of octets, you should convert your strings first
1121	to the locale-specific encoding using C<< $term->locale_encode >>.	1565	to the locale-specific encoding using C<< $term->locale_encode >>.
		1566
		1567	=item $term->tt_paste ($octets)
		1568
		1569	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1570	CR and bracketing the data with control sequences if bracketed paste mode
		1571	is set.
1122		1572
1123	=item $old_events = $term->pty_ev_events ([$new_events])	1573	=item $old_events = $term->pty_ev_events ([$new_events])
1124		1574
1125	Replaces the event mask of the pty watcher by the given event mask. Can	1575	Replaces the event mask of the pty watcher by the given event mask. Can
1126	be used to suppress input and output handling to the pty/tty. See the	1576	be used to suppress input and output handling to the pty/tty. See the
1127	description of C<< urxvt::timer->events >>. Make sure to always restore	1577	description of C<< urxvt::timer->events >>. Make sure to always restore
1128	the previous value.	1578	the previous value.
1129		1579
		1580	=item $fd = $term->pty_fd
		1581
		1582	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1583	is used.
		1584
1130	=item $windowid = $term->parent	1585	=item $windowid = $term->parent
1131		1586
1132	Return the window id of the toplevel window.	1587	Return the window id of the toplevel window.
1133		1588
1134	=item $windowid = $term->vt	1589	=item $windowid = $term->vt
1135		1590
1136	Return the window id of the terminal window.	1591	Return the window id of the terminal window.
1137		1592
		1593	=item $term->vt_emask_add ($x_event_mask)
		1594
		1595	Adds the specified events to the vt event mask. Useful e.g. when you want
		1596	to receive pointer events all the times:
		1597
		1598	$term->vt_emask_add (urxvt::PointerMotionMask);
		1599
		1600	=item $term->focus_in
		1601
		1602	=item $term->focus_out
		1603
		1604	=item $term->key_press ($state, $keycode[, $time])
		1605
		1606	=item $term->key_release ($state, $keycode[, $time])
		1607
		1608	Deliver various fake events to to terminal.
		1609
1138	=item $window_width = $term->width	1610	=item $window_width = $term->width
1139		1611
1140	=item $window_height = $term->height	1612	=item $window_height = $term->height
1141		1613
1142	=item $font_width = $term->fwidth	1614	=item $font_width = $term->fwidth
…		…
1155		1627
1156	=item $max_scrollback = $term->saveLines	1628	=item $max_scrollback = $term->saveLines
1157		1629
1158	=item $nrow_plus_saveLines = $term->total_rows	1630	=item $nrow_plus_saveLines = $term->total_rows
1159		1631
1160	=item $lines_in_scrollback = $term->nsaved	1632	=item $topmost_scrollback_row = $term->top_row
1161		1633
1162	Return various integers describing terminal characteristics.	1634	Return various integers describing terminal characteristics.
1163		1635
1164	=item $x_display = $term->display_id	1636	=item $x_display = $term->display_id
1165		1637
…		…
1172	=item $env = $term->env	1644	=item $env = $term->env
1173		1645
1174	Returns a copy of the environment in effect for the terminal as a hashref	1646	Returns a copy of the environment in effect for the terminal as a hashref
1175	similar to C<\%ENV>.	1647	similar to C<\%ENV>.
1176		1648
		1649	=item @envv = $term->envv
		1650
		1651	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1652
		1653	=item @argv = $term->argv
		1654
		1655	Return the argument vector as this terminal, similar to @ARGV, but
		1656	includes the program name as first element.
		1657
1177	=cut	1658	=cut
1178		1659
1179	sub env {	1660	sub env {
1180	if (my $env = $_[0]->_env) {
1181	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1661	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1182	} else {
1183	+{ %ENV }
1184	}
1185	}	1662	}
1186		1663
1187	=item $modifiermask = $term->ModLevel3Mask	1664	=item $modifiermask = $term->ModLevel3Mask
1188		1665
1189	=item $modifiermask = $term->ModMetaMask	1666	=item $modifiermask = $term->ModMetaMask
…		…
1191	=item $modifiermask = $term->ModNumLockMask	1668	=item $modifiermask = $term->ModNumLockMask
1192		1669
1193	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1670	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1194	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1671	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1195		1672
		1673	=item $screen = $term->current_screen
		1674
		1675	Returns the currently displayed screen (0 primary, 1 secondary).
		1676
		1677	=item $cursor_is_hidden = $term->hidden_cursor
		1678
		1679	Returns whether the cursor is currently hidden or not.
		1680
1196	=item $view_start = $term->view_start ([$newvalue])	1681	=item $view_start = $term->view_start ([$newvalue])
1197		1682
1198	Returns the negative row number of the topmost line. Minimum value is	1683	Returns the row number of the topmost displayed line. Maximum value is
1199	C<0>, which displays the normal terminal contents. Larger values scroll	1684	C<0>, which displays the normal terminal contents. Lower values scroll
1200	this many lines into the scrollback buffer.	1685	this many lines into the scrollback buffer.
1201		1686
1202	=item $term->want_refresh	1687	=item $term->want_refresh
1203		1688
1204	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1689	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1207		1692
1208	Used after changing terminal contents to display them.	1693	Used after changing terminal contents to display them.
1209		1694
1210	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1695	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1211		1696
1212	Returns the text of the entire row with number C<$row_number>. Row C<0>	1697	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1213	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1698	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1214	terminal line. The scrollback buffer starts at line C<-1> and extends to
1215	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1699	terminal line. Nothing will be returned if a nonexistent line
1216	is requested.	1700	is requested.
1217		1701
1218	If C<$new_text> is specified, it will replace characters in the current	1702	If C<$new_text> is specified, it will replace characters in the current
1219	line, starting at column C<$start_col> (default C<0>), which is useful	1703	line, starting at column C<$start_col> (default C<0>), which is useful
1220	to replace only parts of a line. The font index in the rendition will	1704	to replace only parts of a line. The font index in the rendition will
1221	automatically be updated.	1705	automatically be updated.
1222		1706
1223	C<$text> is in a special encoding: tabs and wide characters that use more	1707	C<$text> is in a special encoding: tabs and wide characters that use more
1224	than one cell when displayed are padded with urxvt::NOCHAR characters	1708	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1225	(C<chr 65535>). Characters with combining characters and other characters	1709	characters. Characters with combining characters and other characters that
1226	that do not fit into the normal tetx encoding will be replaced with	1710	do not fit into the normal text encoding will be replaced with characters
1227	characters in the private use area.	1711	in the private use area.
1228		1712
1229	You have to obey this encoding when changing text. The advantage is	1713	You have to obey this encoding when changing text. The advantage is
1230	that C<substr> and similar functions work on screen cells and not on	1714	that C<substr> and similar functions work on screen cells and not on
1231	characters.	1715	characters.
1232		1716
…		…
1376	where one character corresponds to one screen cell. See	1860	where one character corresponds to one screen cell. See
1377	C<< $term->ROW_t >> for details.	1861	C<< $term->ROW_t >> for details.
1378		1862
1379	=item $string = $term->special_decode $text	1863	=item $string = $term->special_decode $text
1380		1864
1381	Converts rxvt-unicodes text reprsentation into a perl string. See	1865	Converts rxvt-unicodes text representation into a perl string. See
1382	C<< $term->ROW_t >> for details.	1866	C<< $term->ROW_t >> for details.
1383		1867
1384	=item $success = $term->grab_button ($button, $modifiermask)	1868	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1385		1869
		1870	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1871
1386	Registers a synchronous button grab. See the XGrabButton manpage.	1872	Register/unregister a synchronous button grab. See the XGrabButton
		1873	manpage.
1387		1874
1388	=item $success = $term->grab ($eventtime[, $sync])	1875	=item $success = $term->grab ($eventtime[, $sync])
1389		1876
1390	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1877	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1391	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1878	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1392		1879
1393	=item $term->allow_events_async	1880	=item $term->allow_events_async
1394		1881
1395	Calls XAllowEvents with AsyncBoth for the most recent grab.	1882	Calls XAllowEvents with AsyncBoth for the most recent grab.
1396		1883
…		…
1403	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1890	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1404	recent grab.	1891	recent grab.
1405		1892
1406	=item $term->ungrab	1893	=item $term->ungrab
1407		1894
1408	Calls XUngrab for the most recent grab. Is called automatically on	1895	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1409	evaluation errors, as it is better to lose the grab in the error case as	1896	evaluation errors, as it is better to lose the grab in the error case as
1410	the session.	1897	the session.
		1898
		1899	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1900
		1901	=item $atom_name = $term->XGetAtomName ($atom)
		1902
		1903	=item @atoms = $term->XListProperties ($window)
		1904
		1905	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1906
		1907	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1908
		1909	=item $term->XDeleteProperty ($window, $property)
		1910
		1911	=item $window = $term->DefaultRootWindow
		1912
		1913	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1914
		1915	=item $term->XMapWindow ($window)
		1916
		1917	=item $term->XUnmapWindow ($window)
		1918
		1919	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1920
		1921	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1922
		1923	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1924
		1925	Various X or X-related functions. The C<$term> object only serves as
		1926	the source of the display, otherwise those functions map more-or-less
		1927	directly onto the X functions of the same name.
1411		1928
1412	=back	1929	=back
1413		1930
1414	=cut	1931	=cut
1415		1932
…		…
1479	my ($self, $text, $cb) = @_;	1996	my ($self, $text, $cb) = @_;
1480		1997
1481	$self->add_item ({ type => "button", text => $text, activate => $cb});	1998	$self->add_item ({ type => "button", text => $text, activate => $cb});
1482	}	1999	}
1483		2000
1484	=item $popup->add_toggle ($text, $cb, $initial_value)	2001	=item $popup->add_toggle ($text, $initial_value, $cb)
1485		2002
1486	Adds a toggle/checkbox item to the popup. Teh callback gets called	2003	Adds a toggle/checkbox item to the popup. The callback gets called
1487	whenever it gets toggled, with a boolean indicating its value as its first	2004	whenever it gets toggled, with a boolean indicating its new value as its
1488	argument.	2005	first argument.
1489		2006
1490	=cut	2007	=cut
1491		2008
1492	sub add_toggle {	2009	sub add_toggle {
1493	my ($self, $text, $cb, $value) = @_;	2010	my ($self, $text, $value, $cb) = @_;
1494		2011
1495	my $item; $item = {	2012	my $item; $item = {
1496	type => "button",	2013	type => "button",
1497	text => " $text",	2014	text => " $text",
1498	value => $value,	2015	value => $value,
…		…
1517	my $env = $self->{term}->env;	2034	my $env = $self->{term}->env;
1518	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2035	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1519	delete $env->{LC_ALL};	2036	delete $env->{LC_ALL};
1520	$env->{LC_CTYPE} = $self->{term}->locale;	2037	$env->{LC_CTYPE} = $self->{term}->locale;
1521		2038
1522	urxvt::term->new ($env, $self->{term}->resource ("name"),	2039	my $term = urxvt::term->new (
1523	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2040	$env, "popup",
		2041	"--perl-lib" => "", "--perl-ext-common" => "",
		2042	"-pty-fd" => -1, "-sl" => 0,
		2043	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1524	"--transient-for" => $self->{term}->parent,	2044	"--transient-for" => $self->{term}->parent,
1525	"-display" => $self->{term}->display_id,	2045	"-display" => $self->{term}->display_id,
1526	"-pe" => "urxvt-popup")	2046	"-pe" => "urxvt-popup",
1527	or die "unable to create popup window\n";	2047	) or die "unable to create popup window\n";
		2048
		2049	unless (delete $term->{urxvt_popup_init_done}) {
		2050	$term->ungrab;
		2051	$term->destroy;
		2052	die "unable to initialise popup window\n";
		2053	}
1528	}	2054	}
1529		2055
1530	sub DESTROY {	2056	sub DESTROY {
1531	my ($self) = @_;	2057	my ($self) = @_;
1532		2058
1533	delete $self->{term}{_destroy}{$self};	2059	delete $self->{term}{_destroy}{$self};
1534	$self->{term}->ungrab;	2060	$self->{term}->ungrab;
1535	}	2061	}
1536		2062
1537	=back	2063	=back
		2064
		2065	=cut
		2066
		2067	package urxvt::watcher;
1538		2068
1539	=head2 The C<urxvt::timer> Class	2069	=head2 The C<urxvt::timer> Class
1540		2070
1541	This class implements timer watchers/events. Time is represented as a	2071	This class implements timer watchers/events. Time is represented as a
1542	fractional number of seconds since the epoch. Example:	2072	fractional number of seconds since the epoch. Example:
…		…
1546	->new	2076	->new
1547	->interval (1)	2077	->interval (1)
1548	->cb (sub {	2078	->cb (sub {
1549	$term->{overlay}->set (0, 0,	2079	$term->{overlay}->set (0, 0,
1550	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2080	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1551	});	2081	});
1552		2082
1553	=over 4	2083	=over 4
1554		2084
1555	=item $timer = new urxvt::timer	2085	=item $timer = new urxvt::timer
1556		2086
…		…
1559		2089
1560	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2090	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1561		2091
1562	Set the callback to be called when the timer triggers.	2092	Set the callback to be called when the timer triggers.
1563		2093
1564	=item $tstamp = $timer->at
1565
1566	Return the time this watcher will fire next.
1567
1568	=item $timer = $timer->set ($tstamp)	2094	=item $timer = $timer->set ($tstamp[, $interval])
1569		2095
1570	Set the time the event is generated to $tstamp.	2096	Set the time the event is generated to $tstamp (and optionally specifies a
		2097	new $interval).
1571		2098
1572	=item $timer = $timer->interval ($interval)	2099	=item $timer = $timer->interval ($interval)
1573		2100
1574	Normally (and when C<$interval> is C<0>), the timer will automatically	2101	By default (and when C<$interval> is C<0>), the timer will automatically
1575	stop after it has fired once. If C<$interval> is non-zero, then the timer	2102	stop after it has fired once. If C<$interval> is non-zero, then the timer
1576	is automatically rescheduled at the given intervals.	2103	is automatically rescheduled at the given intervals.
1577		2104
1578	=item $timer = $timer->start	2105	=item $timer = $timer->start
1579		2106
1580	Start the timer.	2107	Start the timer.
1581		2108
1582	=item $timer = $timer->start ($tstamp)	2109	=item $timer = $timer->start ($tstamp[, $interval])
1583		2110
1584	Set the event trigger time to C<$tstamp> and start the timer.	2111	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2112	also replaces the interval.
		2113
		2114	=item $timer = $timer->after ($delay[, $interval])
		2115
		2116	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1585		2117
1586	=item $timer = $timer->stop	2118	=item $timer = $timer->stop
1587		2119
1588	Stop the timer.	2120	Stop the timer.
1589		2121
…		…
1595		2127
1596	$term->{socket} = ...	2128	$term->{socket} = ...
1597	$term->{iow} = urxvt::iow	2129	$term->{iow} = urxvt::iow
1598	->new	2130	->new
1599	->fd (fileno $term->{socket})	2131	->fd (fileno $term->{socket})
1600	->events (urxvt::EVENT_READ)	2132	->events (urxvt::EV_READ)
1601	->start	2133	->start
1602	->cb (sub {	2134	->cb (sub {
1603	my ($iow, $revents) = @_;	2135	my ($iow, $revents) = @_;
1604	# $revents must be 1 here, no need to check	2136	# $revents must be 1 here, no need to check
1605	sysread $term->{socket}, my $buf, 8192	2137	sysread $term->{socket}, my $buf, 8192
…		…
1618	Set the callback to be called when io events are triggered. C<$reventmask>	2150	Set the callback to be called when io events are triggered. C<$reventmask>
1619	is a bitset as described in the C<events> method.	2151	is a bitset as described in the C<events> method.
1620		2152
1621	=item $iow = $iow->fd ($fd)	2153	=item $iow = $iow->fd ($fd)
1622		2154
1623	Set the filedescriptor (not handle) to watch.	2155	Set the file descriptor (not handle) to watch.
1624		2156
1625	=item $iow = $iow->events ($eventmask)	2157	=item $iow = $iow->events ($eventmask)
1626		2158
1627	Set the event mask to watch. The only allowed values are	2159	Set the event mask to watch. The only allowed values are
1628	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2160	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1629	together, or C<urxvt::EVENT_NONE>.	2161	together, or C<urxvt::EV_NONE>.
1630		2162
1631	=item $iow = $iow->start	2163	=item $iow = $iow->start
1632		2164
1633	Start watching for requested events on the given handle.	2165	Start watching for requested events on the given handle.
1634		2166
1635	=item $iow = $iow->stop	2167	=item $iow = $iow->stop
1636		2168
1637	Stop watching for events on the given filehandle.	2169	Stop watching for events on the given file handle.
		2170
		2171	=back
		2172
		2173	=head2 The C<urxvt::iw> Class
		2174
		2175	This class implements idle watchers, that get called automatically when
		2176	the process is idle. They should return as fast as possible, after doing
		2177	some useful work.
		2178
		2179	=over 4
		2180
		2181	=item $iw = new urxvt::iw
		2182
		2183	Create a new idle watcher object in stopped state.
		2184
		2185	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2186
		2187	Set the callback to be called when the watcher triggers.
		2188
		2189	=item $timer = $timer->start
		2190
		2191	Start the watcher.
		2192
		2193	=item $timer = $timer->stop
		2194
		2195	Stop the watcher.
		2196
		2197	=back
		2198
		2199	=head2 The C<urxvt::pw> Class
		2200
		2201	This class implements process watchers. They create an event whenever a
		2202	process exits, after which they stop automatically.
		2203
		2204	my $pid = fork;
		2205	...
		2206	$term->{pw} = urxvt::pw
		2207	->new
		2208	->start ($pid)
		2209	->cb (sub {
		2210	my ($pw, $exit_status) = @_;
		2211	...
		2212	});
		2213
		2214	=over 4
		2215
		2216	=item $pw = new urxvt::pw
		2217
		2218	Create a new process watcher in stopped state.
		2219
		2220	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2221
		2222	Set the callback to be called when the timer triggers.
		2223
		2224	=item $pw = $timer->start ($pid)
		2225
		2226	Tells the watcher to start watching for process C<$pid>.
		2227
		2228	=item $pw = $pw->stop
		2229
		2230	Stop the watcher.
1638		2231
1639	=back	2232	=back
1640		2233
1641	=head1 ENVIRONMENT	2234	=head1 ENVIRONMENT
1642		2235
…		…
1651		2244
1652	=item >= 3 - script loading and management	2245	=item >= 3 - script loading and management
1653		2246
1654	=item >=10 - all called hooks	2247	=item >=10 - all called hooks
1655		2248
1656	=item >=11 - hook reutrn values	2249	=item >=11 - hook return values
1657		2250
1658	=back	2251	=back
1659		2252
1660	=head1 AUTHOR	2253	=head1 AUTHOR
1661		2254
…		…
1663	http://software.schmorp.de/pkg/rxvt-unicode	2256	http://software.schmorp.de/pkg/rxvt-unicode
1664		2257
1665	=cut	2258	=cut
1666		2259
1667	1	2260	1
		2261
		2262	# vim: sw=3:

Diff Legend

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