[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC vs.
Revision 1.196 by sf-exg, Wed Jun 29 22:46:48 2011 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC vs. Revision 1.196 by sf-exg, Wed Jun 29 22:46:48 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC vs.
Revision 1.196 by sf-exg, Wed Jun 29 22:46:48 2011 UTC