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

Diff Legend

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