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.47 by root, Sat Jan 7 21:22:02 2006 UTC vs.
Revision 1.176 by root, Sat Jul 18 05:59:49 2009 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
32		33
		34	=head1 PREPACKAGED EXTENSIONS
		35
33	This section describes the extensiosn delivered with this version. 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	49	=item selection (enabled by default)
43		50
44	Intelligent selection. This extension tries to be more intelligent when	51	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	52	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	53	now, it tries to select words, urls and complete shell-quoted
47	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
49	It also offers the following bindable event:	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
		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
…		…
56		92
57	URxvt.keysym.C-M-r: perl:selection:rot13	93	URxvt.keysym.C-M-r: perl:selection:rot13
58		94
59	=back	95	=back
60		96
61	=item digital-clock	97	=item option-popup (enabled by default)
62		98
63	Displays a digital clock using the built-in overlay.	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		100	runtime.
64		101
65	=item mark-urls	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.
66		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
		119	=item selection-popup (enabled by default)
		120
		121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		122	text into various other formats/action (such as uri unescaping, perl
		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	};
		143
		144	=item searchable-scrollback<hotkey> (enabled by default)
		145
		146	Adds regex search functionality to the scrollback buffer, triggered
		147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		148	input/output is suspended and a regex is displayed at the bottom of the
		149	screen.
		150
		151	Inputting characters appends them to the regex and continues incremental
		152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		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.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
		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
67	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.
68		313
69	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
70		315
71	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
72	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
73	similar-looking ascii character.	318	similar-looking ascii character.
		319
		320	=item digital-clock
		321
		322	Displays a digital clock using the built-in overlay.
		323
		324	=item remote-clipboard
		325
		326	Somewhat of a misnomer, this extension adds two menu entries to the
		327	selection popup that allows one to run external commands to store the
		328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		343
		344	=item selection-pastebin
		345
		346	This is a little rarely useful extension that Uploads the selection as
		347	textfile to a remote site (or does other things). (The implementation is
		348	not currently secure for use in a multiuser environment as it writes to
		349	F</tmp> directly.).
		350
		351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		352	i.e.
		353
		354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		355
		356	Pressing this combination runs a command with C<%> replaced by the name of
		357	the textfile. This command can be set via a resource:
		358
		359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		360
		361	And the default is likely not useful to anybody but the few people around
		362	here :)
		363
		364	The name of the textfile is the hex encoded md5 sum of the selection, so
		365	the same content should lead to the same filename.
		366
		367	After a successful upload the selection will be replaced by the text given
		368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		369	for the filename):
		370
		371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of wether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-pastebin and macosx-pastebin-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<maxosx-pastebin> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
74		391
75	=item example-refresh-hooks	392	=item example-refresh-hooks
76		393
77	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
78	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
79	overlays or changes.	396	overlays or changes.
80		397
81	=back	398	=back
		399
		400	=head1 API DOCUMENTATION
82		401
83	=head2 General API Considerations	402	=head2 General API Considerations
84		403
85	All objects (such as terminals, time watchers etc.) are typical	404	All objects (such as terminals, time watchers etc.) are typical
86	reference-to-hash objects. The hash can be used to store anything you	405	reference-to-hash objects. The hash can be used to store anything you
…		…
99	=over 4	418	=over 4
100		419
101	=item $text	420	=item $text
102		421
103	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicodes special way of encoding text, where one "unicode" character
104	always represents one screen cell. See L<row_t> for a discussion of this format.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
105		424
106	=item $string	425	=item $string
107		426
108	A perl text string, with an emphasis on I<text>. It can store all unicode	427	A perl text string, with an emphasis on I<text>. It can store all unicode
109	characters and is to be distinguished with text encoded in a specific	428	characters and is to be distinguished with text encoded in a specific
…		…
114	Either binary data or - more common - a text string encoded in a	433	Either binary data or - more common - a text string encoded in a
115	locale-specific way.	434	locale-specific way.
116		435
117	=back	436	=back
118		437
		438	=head2 Extension Objects
		439
		440	Every perl extension is a perl class. A separate perl object is created
		441	for each terminal, and each terminal has its own set of extenion objects,
		442	which are passed as the first parameter to hooks. So extensions can use
		443	their C<$self> object without having to think about clashes with other
		444	extensions or other terminals, with the exception of methods and members
		445	that begin with an underscore character C<_>: these are reserved for
		446	internal use.
		447
		448	Although it isn't a C<urxvt::term> object, you can call all methods of the
		449	C<urxvt::term> class on this object.
		450
		451	It has the following methods and data members:
		452
		453	=over 4
		454
		455	=item $urxvt_term = $self->{term}
		456
		457	Returns the C<urxvt::term> object associated with this instance of the
		458	extension. This member I<must not> be changed in any way.
		459
		460	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		461
		462	Dynamically enable the given hooks (named without the C<on_> prefix) for
		463	this extension, replacing any previous hook. This is useful when you want
		464	to overwrite time-critical hooks only temporarily.
		465
		466	=item $self->disable ($hook_name[, $hook_name..])
		467
		468	Dynamically disable the given hooks.
		469
		470	=back
		471
119	=head2 Hooks	472	=head2 Hooks
120		473
121	The following subroutines can be declared in extension files, and will be	474	The following subroutines can be declared in extension files, and will be
122	called whenever the relevant event happens.	475	called whenever the relevant event happens.
123		476
124	The first argument passed to them is an object private to each terminal	477	The first argument passed to them is an extension object as described in
125	and extension package. You can call all C<urxvt::term> methods on it, but	478	the in the C<Extension Objects> section.
126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127	object that is shared between all packages is stored in the C<term>
128	member. It is, however, blessed intot he package of the extension script,
129	so for all practical purposes you can treat an extension script as a class.
130		479
131	All of them must return a boolean value. If it is true, then the event	480	B<All> of these hooks must return a boolean value. If any of the called
132	counts as being I<consumed>, and the invocation of other hooks is skipped,	481	hooks returns true, then the event counts as being I<consumed>, and the
133	and the relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
134		483
135	When in doubt, return a false value (preferably C<()>).	484	I<< When in doubt, return a false value (preferably C<()>). >>
136		485
137	=over 4	486	=over 4
138		487
139	=item on_init $term	488	=item on_init $term
140		489
141	Called after a new terminal object has been initialized, but before	490	Called after a new terminal object has been initialized, but before
142	windows are created or the command gets run. Most methods are unsafe to	491	windows are created or the command gets run. Most methods are unsafe to
143	call or deliver senseless data, as terminal size and other characteristics	492	call or deliver senseless data, as terminal size and other characteristics
144	have not yet been determined. You can safely query and change resources,	493	have not yet been determined. You can safely query and change resources
145	though.	494	and options, though. For many purposes the C<on_start> hook is a better
		495	place.
		496
		497	=item on_start $term
		498
		499	Called at the very end of initialisation of a new terminal, just before
		500	trying to map (display) the toplevel and returning to the main loop.
		501
		502	=item on_destroy $term
		503
		504	Called whenever something tries to destroy terminal, when the terminal is
		505	still fully functional (not for long, though).
146		506
147	=item on_reset $term	507	=item on_reset $term
148		508
149	Called after the screen is "reset" for any reason, such as resizing or	509	Called after the screen is "reset" for any reason, such as resizing or
150	control sequences. Here is where you can react on changes to size-related	510	control sequences. Here is where you can react on changes to size-related
151	variables.	511	variables.
152		512
153	=item on_start $term	513	=item on_child_start $term, $pid
154		514
155	Called at the very end of initialisation of a new terminal, just before	515	Called just after the child process has been C<fork>ed.
156	returning to the mainloop.	516
		517	=item on_child_exit $term, $status
		518
		519	Called just after the child process has exited. C<$status> is the status
		520	from C<waitpid>.
157		521
158	=item on_sel_make $term, $eventtime	522	=item on_sel_make $term, $eventtime
159		523
160	Called whenever a selection has been made by the user, but before the	524	Called whenever a selection has been made by the user, but before the
161	selection text is copied, so changes to the beginning, end or type of the	525	selection text is copied, so changes to the beginning, end or type of the
…		…
168		532
169	Called whenever a selection has been copied, but before the selection is	533	Called whenever a selection has been copied, but before the selection is
170	requested from the server. The selection text can be queried and changed	534	requested from the server. The selection text can be queried and changed
171	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
172		536
173	Returning a true value aborts selection grabbing. It will still be hilighted.	537	Returning a true value aborts selection grabbing. It will still be highlighted.
174		538
175	=item on_sel_extend $term	539	=item on_sel_extend $term
176		540
177	Called whenever the user tries to extend the selection (e.g. with a double	541	Called whenever the user tries to extend the selection (e.g. with a double
178	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
179	should extend the selection itelf and return true to suppress the built-in	543	should extend the selection itself and return true to suppress the built-in
180	processing.	544	processing. This can happen multiple times, as long as the callback
		545	returns true, it will be called on every further click by the user and is
		546	supposed to enlarge the selection more and more, if possible.
181		547
182	See the F<selection> example extension.	548	See the F<selection> example extension.
183		549
184	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
185		551
186	Called whenever the view offset changes, i..e the user or program	552	Called whenever the view offset changes, i.e. the user or program
187	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
188	show this many lines of scrollback.	554	show this many lines of scrollback.
189		555
190	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
191		557
…		…
195		561
196	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
197	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	563	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
198	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
199		565
200	=item on_tty_activity $term *NYI*
201
202	Called whenever the program(s) running in the urxvt window send output.
203
204	=item on_osc_seq $term, $string	566	=item on_osc_seq $term, $op, $args, $resp
		567
		568	Called on every OSC sequence and can be used to suppress it or modify its
		569	behaviour. The default should be to return an empty list. A true value
		570	suppresses execution of the request completely. Make sure you don't get
		571	confused by recursive invocations when you output an OSC sequence within
		572	this callback.
		573
		574	C<on_osc_seq_perl> should be used for new behaviour.
		575
		576	=item on_osc_seq_perl $term, $args, $resp
205		577
206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
208	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
209	string should start with the extension name and a colon, to distinguish	581	string should start with the extension name (sans -osc) and a semicolon,
210	it from commands for other extensions, and this might be enforced in the	582	to distinguish it from commands for other extensions, and this might be
211	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
212		594
213	Be careful not ever to trust (in a security sense) the data you receive,	595	Be careful not ever to trust (in a security sense) the data you receive,
214	as its source can not easily be controleld (e-mail content, messages from	596	as its source can not easily be controlled (e-mail content, messages from
215	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
216		601
217	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
218		603
219	Called whenever text is about to be output, with the text as argument. You	604	Called whenever text is about to be output, with the text as argument. You
220	can filter/change and output the text yourself by returning a true value	605	can filter/change and output the text yourself by returning a true value
221	and calling C<< $term->scr_add_lines >> yourself. Please note that this	606	and calling C<< $term->scr_add_lines >> yourself. Please note that this
222	might be very slow, however, as your hook is called for B<all> text being	607	might be very slow, however, as your hook is called for B<all> text being
223	output.	608	output.
224		609
		610	=item on_tt_write $term, $octets
		611
		612	Called whenever some data is written to the tty/pty and can be used to
		613	suppress or filter tty input.
		614
225	=item on_line_update $term, $row	615	=item on_line_update $term, $row
226		616
227	Called whenever a line was updated or changed. Can be used to filter	617	Called whenever a line was updated or changed. Can be used to filter
228	screen output (e.g. underline urls or other useless stuff). Only lines	618	screen output (e.g. underline urls or other useless stuff). Only lines
229	that are being shown will be filtered, and, due to performance reasons,	619	that are being shown will be filtered, and, due to performance reasons,
…		…
236	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
237	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
238		628
239	=item on_refresh_begin $term	629	=item on_refresh_begin $term
240		630
241	Called just before the screen gets redrawn. Can be used for overlay	631	Called just before the screen gets redrawn. Can be used for overlay or
242	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
243	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
244	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
245		635
246	=item on_refresh_end $term	636	=item on_refresh_end $term
247		637
248	Called just after the screen gets redrawn. See C<on_refresh_begin>.	638	Called just after the screen gets redrawn. See C<on_refresh_begin>.
249		639
250	=item on_keyboard_command $term, $string	640	=item on_user_command $term, $string
251		641
252	Called whenever the user presses a key combination that has a	642	Called whenever a user-configured event is being activated (e.g. via
253	C<perl:string> action bound to it (see description of the B<keysym>	643	a C<perl:string> action bound to a key, see description of the B<keysym>
254	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
		645
		646	The event is simply the action string. This interface is assumed to change
		647	slightly in the future.
		648
		649	=item on_resize_all_windows $tern, $new_width, $new_height
		650
		651	Called just after the new window size has been calculated, but before
		652	windows are actually being resized or hints are being set. If this hook
		653	returns TRUE, setting of the window hints is being skipped.
		654
		655	=item on_x_event $term, $event
		656
		657	Called on every X event received on the vt window (and possibly other
		658	windows). Should only be used as a last resort. Most event structure
		659	members are not passed.
		660
		661	=item on_root_event $term, $event
		662
		663	Like C<on_x_event>, but is called for events on the root window.
255		664
256	=item on_focus_in $term	665	=item on_focus_in $term
257		666
258	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
259	does focus in processing.	668	does focus in processing.
260		669
261	=item on_focus_out $term	670	=item on_focus_out $term
262		671
263	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
264	focus out processing.	673	focus out processing.
265		674
		675	=item on_configure_notify $term, $event
		676
		677	=item on_property_notify $term, $event
		678
266	=item on_key_press $term, $event, $octets	679	=item on_key_press $term, $event, $keysym, $octets
267		680
268	=item on_key_release $term, $event	681	=item on_key_release $term, $event, $keysym
269		682
270	=item on_button_press $term, $event	683	=item on_button_press $term, $event
271		684
272	=item on_button_release $term, $event	685	=item on_button_release $term, $event
273		686
…		…
279		692
280	Called whenever the corresponding X event is received for the terminal If	693	Called whenever the corresponding X event is received for the terminal If
281	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the even will be ignored by rxvt-unicode.
282		695
283	The event is a hash with most values as named by Xlib (see the XEvent	696	The event is a hash with most values as named by Xlib (see the XEvent
284	manpage), with the additional members C<row> and C<col>, which are the row	697	manpage), with the additional members C<row> and C<col>, which are the
285	and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
286		699
287	C<on_key_press> additionally receives the string rxvt-unicode would	700	C<on_key_press> additionally receives the string rxvt-unicode would
288	output, if any, in locale-specific encoding.	701	output, if any, in locale-specific encoding.
289		702
290	subwindow.	703	subwindow.
291		704
		705	=item on_client_message $term, $event
		706
		707	=item on_wm_protocols $term, $event
		708
		709	=item on_wm_delete_window $term, $event
		710
		711	Called when various types of ClientMessage events are received (all with
		712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		713
292	=back	714	=back
293		715
		716	=cut
		717
		718	package urxvt;
		719
		720	use utf8;
		721	use strict;
		722	use Carp ();
		723	use Scalar::Util ();
		724	use List::Util ();
		725
		726	our $VERSION = 1;
		727	our $TERM;
		728	our @TERM_INIT;
		729	our @TERM_EXT;
		730	our @HOOKNAME;
		731	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		732	our %OPTION;
		733
		734	our $LIBDIR;
		735	our $RESNAME;
		736	our $RESCLASS;
		737	our $RXVTNAME;
		738
		739	our $NOCHAR = chr 0xffff;
		740
294	=head2 Variables in the C<urxvt> Package	741	=head2 Variables in the C<urxvt> Package
295		742
296	=over 4	743	=over 4
		744
		745	=item $urxvt::LIBDIR
		746
		747	The rxvt-unicode library directory, where, among other things, the perl
		748	modules and scripts are stored.
		749
		750	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		751
		752	The resource class and name rxvt-unicode uses to look up X resources.
		753
		754	=item $urxvt::RXVTNAME
		755
		756	The basename of the installed binaries, usually C<urxvt>.
297		757
298	=item $urxvt::TERM	758	=item $urxvt::TERM
299		759
300	The current terminal. This variable stores the current C<urxvt::term>	760	The current terminal. This variable stores the current C<urxvt::term>
301	object, whenever a callback/hook is executing.	761	object, whenever a callback/hook is executing.
302		762
		763	=item @urxvt::TERM_INIT
		764
		765	All code references in this array will be called as methods of the next newly
		766	created C<urxvt::term> object (during the C<on_init> phase). The array
		767	gets cleared before the code references that were in it are being executed,
		768	so references can push themselves onto it again if they so desire.
		769
		770	This complements to the perl-eval command line option, but gets executed
		771	first.
		772
		773	=item @urxvt::TERM_EXT
		774
		775	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		776	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		777	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		778
303	=back	779	=back
304		780
305	=head2 Functions in the C<urxvt> Package	781	=head2 Functions in the C<urxvt> Package
306		782
307	=over 4	783	=over 4
308
309	=item $term = new urxvt [arg...]
310
311	Creates a new terminal, very similar as if you had started it with
312	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
313	if the new instance couldn't be created. Returns C<undef> if the new
314	instance didn't initialise perl, and the terminal object otherwise. The
315	C<init> and C<start> hooks will be called during the call.
316		784
317	=item urxvt::fatal $errormessage	785	=item urxvt::fatal $errormessage
318		786
319	Fatally aborts execution with the given error message. Avoid at all	787	Fatally aborts execution with the given error message. Avoid at all
320	costs! The only time this is acceptable is when the terminal process	788	costs! The only time this is acceptable is when the terminal process
…		…
327	that calls this function.	795	that calls this function.
328		796
329	Using this function has the advantage that its output ends up in the	797	Using this function has the advantage that its output ends up in the
330	correct place, e.g. on stderr of the connecting urxvtc client.	798	correct place, e.g. on stderr of the connecting urxvtc client.
331		799
		800	Messages have a size limit of 1023 bytes currently.
		801
		802	=item @terms = urxvt::termlist
		803
		804	Returns all urxvt::term objects that exist in this process, regardless of
		805	whether they are started, being destroyed etc., so be careful. Only term
		806	objects that have perl extensions attached will be returned (because there
		807	is no urxvt::term objet associated with others).
		808
332	=item $time = urxvt::NOW	809	=item $time = urxvt::NOW
333		810
334	Returns the "current time" (as per the event loop).	811	Returns the "current time" (as per the event loop).
335		812
336	=item urxvt::CurrentTime	813	=item urxvt::CurrentTime
337		814
338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	815	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	816	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340	Button4Mask, Button5Mask, AnyModifier	817	Button4Mask, Button5Mask, AnyModifier
341		818
		819	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		820	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		821	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		822	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		823	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		824	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		825	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		826
		827	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		828	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		829	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		830	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		831	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		832	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		833	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		834
342	Various constants for use in X events.	835	Various constants for use in X calls and event processing.
343		836
344	=back	837	=back
345		838
346	=head2 RENDITION	839	=head2 RENDITION
347		840
…		…
374		867
375	=item $background = urxvt::GET_BASEBG $rend	868	=item $background = urxvt::GET_BASEBG $rend
376		869
377	Return the foreground/background colour index, respectively.	870	Return the foreground/background colour index, respectively.
378		871
379	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	872	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
380		873
381	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	874	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		875
		876	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
382		877
383	Replace the foreground/background colour in the rendition mask with the	878	Replace the foreground/background colour in the rendition mask with the
384	specified one.	879	specified one.
385		880
386	=item $value = urxvt::GET_CUSTOM ($rend)	881	=item $value = urxvt::GET_CUSTOM $rend
387		882
388	Return the "custom" value: Every rendition has 5 bits for use by	883	Return the "custom" value: Every rendition has 5 bits for use by
389	extensions. They can be set and changed as you like and are initially	884	extensions. They can be set and changed as you like and are initially
390	zero.	885	zero.
391		886
392	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	887	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
393		888
394	Change the custom value.	889	Change the custom value.
395		890
396	=back	891	=back
397		892
398	=cut	893	=cut
399		894
400	package urxvt;
401
402	use strict;
403	use Scalar::Util ();
404
405	our $TERM;
406	our @HOOKNAME;
407	our $LIBDIR;
408
409	BEGIN {	895	BEGIN {
410	urxvt->bootstrap;
411
412	# overwrite perl's warn	896	# overwrite perl's warn
413	*CORE::GLOBAL::warn = sub {	897	*CORE::GLOBAL::warn = sub {
414	my $msg = join "", @_;	898	my $msg = join "", @_;
415	$msg .= "\n"	899	$msg .= "\n"
416	unless $msg =~ /\n$/;	900	unless $msg =~ /\n$/;
417	urxvt::warn ($msg);	901	urxvt::warn ($msg);
418	};	902	};
419	}	903	}
420		904
421	my @hook_count;	905	no warnings 'utf8';
		906
422	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	907	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
423		908
424	sub verbose {	909	sub verbose {
425	my ($level, $msg) = @_;	910	my ($level, $msg) = @_;
426	warn "$msg\n" if $level <= $verbosity;	911	warn "$msg\n" if $level <= $verbosity;
427	}	912	}
428		913
429	# find on_xxx subs in the package and register them
430	# as hooks
431	sub register_package($) {
432	my ($pkg) = @_;
433
434	for my $htype (0.. $#HOOKNAME) {
435	my $name = $HOOKNAME[$htype];
436
437	my $ref = $pkg->can ("on_" . lc $name)
438	or next;
439
440	$TERM->{_hook}[$htype]{$pkg} = $ref;
441	$hook_count[$htype]++
442	or set_should_invoke $htype, 1;
443	}
444	}
445
446	my $extension_pkg = "extension0000";
447	my %extension_pkg;	914	my %extension_pkg;
448		915
449	# load a single script into its own package, once only	916	# load a single script into its own package, once only
450	sub extension_package($) {	917	sub extension_package($) {
451	my ($path) = @_;	918	my ($path) = @_;
452		919
453	$extension_pkg{$path} ||= do {	920	$extension_pkg{$path} ||= do {
454	my $pkg = "urxvt::" . ($extension_pkg++);	921	$path =~ /([^\/\\]+)$/;
		922	my $pkg = $1;
		923	$pkg =~ s/[^[:word:]]/_/g;
		924	$pkg = "urxvt::ext::$pkg";
455		925
456	verbose 3, "loading extension '$path' into package '$pkg'";	926	verbose 3, "loading extension '$path' into package '$pkg'";
457		927
458	open my $fh, "<:raw", $path	928	open my $fh, "<:raw", $path
459	or die "$path: $!";	929	or die "$path: $!";
460		930
461	my $source = "package $pkg; use strict; use utf8;\n"	931	my $source =
462	. "use base urxvt::term::proxy::;\n"	932	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
463	. "#line 1 \"$path\"\n{\n"	933	. "#line 1 \"$path\"\n{\n"
464	. (do { local $/; <$fh> })	934	. (do { local $/; <$fh> })
465	. "\n};\n1";	935	. "\n};\n1";
466		936
		937	eval $source
467	eval $source or die "$path: $@";	938	or die "$path: $@";
468		939
469	$pkg	940	$pkg
470	}	941	}
471	}	942	}
472		943
…		…
478	my $htype = shift;	949	my $htype = shift;
479		950
480	if ($htype == 0) { # INIT	951	if ($htype == 0) { # INIT
481	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
482		953
		954	my %ext_arg;
		955
		956	{
		957	my @init = @TERM_INIT;
		958	@TERM_INIT = ();
		959	$_->($TERM) for @init;
		960	my @pkg = @TERM_EXT;
		961	@TERM_EXT = ();
		962	$TERM->register_package ($_) for @pkg;
		963	}
		964
483	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	965	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		966	if ($_ eq "default") {
		967	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
		968	} elsif (/^-(.*)$/) {
		969	delete $ext_arg{$1};
		970	} elsif (/^([^<]+)<(.*)>$/) {
		971	push @{ $ext_arg{$1} }, $2;
		972	} else {
		973	$ext_arg{$_} ||= [];
		974	}
		975	}
		976
		977	for my $ext (sort keys %ext_arg) {
484	my @files = grep -f $_, map "$_/$ext", @dirs;	978	my @files = grep -f $_, map "$_/$ext", @dirs;
485		979
486	if (@files) {	980	if (@files) {
487	register_package extension_package $files[0];	981	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
488	} else {	982	} else {
489	warn "perl extension '$ext' not found in perl library search path\n";	983	warn "perl extension '$ext' not found in perl library search path\n";
490	}	984	}
491	}	985	}
		986
		987	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		988	warn $@ if $@;
492	}	989	}
493		990
494	$retval = undef;	991	$retval = undef;
495		992
496	if (my $cb = $TERM->{_hook}[$htype]) {	993	if (my $cb = $TERM->{_hook}[$htype]) {
497	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	994	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
498	if $verbosity >= 10;	995	if $verbosity >= 10;
499		996
500	keys %$cb;	997	for my $pkg (keys %$cb) {
		998	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
		999	$retval ||= $retval_;
501		1000
502	while (my ($pkg, $cb) = each %$cb) {	1001	if ($@) {
503	eval {	1002	$TERM->ungrab; # better to lose the grab than the session
504	$retval = $cb->(	1003	warn $@;
505	$TERM->{_pkg}{$pkg} ||= do {
506	my $proxy = bless { }, $pkg;
507	Scalar::Util::weaken ($proxy->{term} = $TERM);
508	$proxy
509	},
510	@_,
511	) and last;
512	};
513	warn $@ if $@;#d#
514	}
515	}
516
517	if ($htype == 1) { # DESTROY
518	# remove hooks if unused
519	if (my $hook = $TERM->{_hook}) {
520	for my $htype (0..$#$hook) {
521	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
522	or set_should_invoke $htype, 0;
523	}	1004	}
524	}	1005	}
525		1006
		1007	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		1008	if $verbosity >= 11;
		1009	}
		1010
		1011	if ($htype == 1) { # DESTROY
526	# clear package objects	1012	# clear package objects
527	%$_ = () for values %{ $TERM->{_pkg} };	1013	%$_ = () for values %{ $TERM->{_pkg} };
528		1014
529	# clear package	1015	# clear package
530	%$TERM = ();	1016	%$TERM = ();
531	}	1017	}
532		1018
533	$retval	1019	$retval
534	}	1020	}
535		1021
536	sub urxvt::term::proxy::AUTOLOAD {	1022	sub SET_COLOR($$$) {
537	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	1023	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1024	}
		1025
		1026	sub rend2mask {
		1027	no strict 'refs';
		1028	my ($str, $mask) = (@_, 0);
		1029	my %color = ( fg => undef, bg => undef );
		1030	my @failed;
		1031	for my $spec ( split /\s+/, $str ) {
		1032	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1033	$color{lc($1)} = $2;
		1034	} else {
		1035	my $neg = $spec =~ s/^[-^]//;
		1036	unless ( exists &{"RS_$spec"} ) {
		1037	push @failed, $spec;
		1038	next;
		1039	}
		1040	my $cur = &{"RS_$spec"};
		1041	if ( $neg ) {
		1042	$mask &= ~$cur;
		1043	} else {
		1044	$mask |= $cur;
		1045	}
		1046	}
		1047	}
		1048	($mask, @color{qw(fg bg)}, \@failed)
		1049	}
		1050
		1051	# urxvt::term::extension
		1052
		1053	package urxvt::term::extension;
		1054
		1055	sub enable {
		1056	my ($self, %hook) = @_;
		1057	my $pkg = $self->{_pkg};
		1058
		1059	while (my ($name, $cb) = each %hook) {
		1060	my $htype = $HOOKTYPE{uc $name};
		1061	defined $htype
		1062	or Carp::croak "unsupported hook type '$name'";
		1063
		1064	$self->set_should_invoke ($htype, +1)
		1065	unless exists $self->{term}{_hook}[$htype]{$pkg};
		1066
		1067	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		1068	}
		1069	}
		1070
		1071	sub disable {
		1072	my ($self, @hook) = @_;
		1073	my $pkg = $self->{_pkg};
		1074
		1075	for my $name (@hook) {
		1076	my $htype = $HOOKTYPE{uc $name};
		1077	defined $htype
		1078	or Carp::croak "unsupported hook type '$name'";
		1079
		1080	$self->set_should_invoke ($htype, -1)
		1081	if delete $self->{term}{_hook}[$htype]{$pkg};
		1082	}
		1083	}
		1084
		1085	our $AUTOLOAD;
		1086
		1087	sub AUTOLOAD {
		1088	$AUTOLOAD =~ /:([^:]+)$/
538	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	1089	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
539		1090
540	eval qq{	1091	eval qq{
541	sub $urxvt::term::proxy::AUTOLOAD {	1092	sub $AUTOLOAD {
542	my \$proxy = shift;	1093	my \$proxy = shift;
543	\$proxy->{term}->$1 (\@_)	1094	\$proxy->{term}->$1 (\@_)
544	}	1095	}
545	1	1096	1
546	} or die "FATAL: unable to compile method forwarder: $@";	1097	} or die "FATAL: unable to compile method forwarder: $@";
547		1098
548	goto &$urxvt::term::proxy::AUTOLOAD;	1099	goto &$AUTOLOAD;
549	}	1100	}
		1101
		1102	sub DESTROY {
		1103	# nop
		1104	}
		1105
		1106	# urxvt::destroy_hook
550		1107
551	sub urxvt::destroy_hook::DESTROY {	1108	sub urxvt::destroy_hook::DESTROY {
552	${$_[0]}->();	1109	${$_[0]}->();
553	}	1110	}
554		1111
555	sub urxvt::destroy_hook(&) {	1112	sub urxvt::destroy_hook(&) {
556	bless \shift, urxvt::destroy_hook::	1113	bless \shift, urxvt::destroy_hook::
557	}	1114	}
558		1115
		1116	package urxvt::anyevent;
		1117
		1118	=head2 The C<urxvt::anyevent> Class
		1119
		1120	The sole purpose of this class is to deliver an interface to the
		1121	C<AnyEvent> module - any module using it will work inside urxvt without
		1122	further programming. The only exception is that you cannot wait on
		1123	condition variables, but non-blocking condvar use is ok. What this means
		1124	is that you cannot use blocking APIs, but the non-blocking variant should
		1125	work.
		1126
		1127	=cut
		1128
		1129	our $VERSION = '3.4';
		1130
		1131	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		1132	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		1133
		1134	sub timer {
		1135	my ($class, %arg) = @_;
		1136
		1137	my $cb = $arg{cb};
		1138
		1139	urxvt::timer
		1140	->new
		1141	->after ($arg{after})
		1142	->interval ($arg{interval})
		1143	->start
		1144	->cb (sub {
		1145	#TODO interval?
		1146	$_[0]->stop; # need to cancel manually
		1147	$cb->();
		1148	})
		1149	}
		1150
		1151	sub io {
		1152	my ($class, %arg) = @_;
		1153
		1154	my $cb = $arg{cb};
		1155	my $fd = fileno $arg{fh};
		1156	defined $fd or $fd = $arg{fh};
		1157
		1158	bless [$arg{fh}, urxvt::iow
		1159	->new
		1160	->fd (defined fileno $arg{fh})
		1161	->events (($arg{poll} =~ /r/ ? 1 : 0)
		1162	| ($arg{poll} =~ /w/ ? 2 : 0))
		1163	->start
		1164	->cb ($cb)
		1165	], urxvt::anyevent::
		1166	}
		1167
		1168	sub idle {
		1169	my ($class, %arg) = @_;
		1170
		1171	my $cb = $arg{cb};
		1172
		1173	urxvt::iw
		1174	->new
		1175	->start
		1176	->cb (sub {
		1177	#TODO really cancel?
		1178	$_[0]->stop; # need to cancel manually
		1179	$cb->();
		1180	})
		1181	}
		1182
		1183	sub child {
		1184	my ($class, %arg) = @_;
		1185
		1186	my $cb = $arg{cb};
		1187
		1188	urxvt::pw
		1189	->new
		1190	->start ($arg{pid})
		1191	->cb (sub {
		1192	#TODO really cancel?
		1193	$_[0]->stop; # need to cancel manually
		1194	$cb->($_[0]->rpid, $_[0]->rstatus);
		1195	})
		1196	}
		1197
		1198	sub DESTROY {
		1199	$_[0][1]->stop;
		1200	}
		1201
		1202	sub one_event {
		1203	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
		1204	}
		1205
		1206	package urxvt::term;
		1207
559	=head2 The C<urxvt::term> Class	1208	=head2 The C<urxvt::term> Class
560		1209
561	=over 4	1210	=over 4
562		1211
		1212	=cut
		1213
		1214	# find on_xxx subs in the package and register them
		1215	# as hooks
		1216	sub register_package {
		1217	my ($self, $pkg, $argv) = @_;
		1218
		1219	no strict 'refs';
		1220
		1221	urxvt::verbose 6, "register package $pkg to $self";
		1222
		1223	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1224
		1225	my $proxy = bless {
		1226	_pkg => $pkg,
		1227	argv => $argv,
		1228	}, $pkg;
		1229	Scalar::Util::weaken ($proxy->{term} = $self);
		1230
		1231	$self->{_pkg}{$pkg} = $proxy;
		1232
		1233	for my $name (@HOOKNAME) {
		1234	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1235	$proxy->enable ($name => $ref);
		1236	}
		1237	}
		1238	}
		1239
		1240	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1241
		1242	Creates a new terminal, very similar as if you had started it with system
		1243	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1244	hash which defines the environment of the new terminal.
		1245
		1246	Croaks (and probably outputs an error message) if the new instance
		1247	couldn't be created. Returns C<undef> if the new instance didn't
		1248	initialise perl, and the terminal object otherwise. The C<init> and
		1249	C<start> hooks will be called before this call returns, and are free to
		1250	refer to global data (which is race free).
		1251
		1252	=cut
		1253
		1254	sub new {
		1255	my ($class, $env, @args) = @_;
		1256
		1257	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1258	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1259
		1260	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1261	}
		1262
563	=item $term->destroy	1263	=item $term->destroy
564		1264
565	Destroy the terminal object (close the window, free resources etc.).	1265	Destroy the terminal object (close the window, free resources
		1266	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1267	watchers (timers, io watchers) are still active.
		1268
		1269	=item $term->exec_async ($cmd[, @args])
		1270
		1271	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1272	("starts") programs in the background. This function takes care of setting
		1273	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1274	be preferred over explicit calls to C<exec> or C<system>.
		1275
		1276	Returns the pid of the subprocess or C<undef> on error.
		1277
		1278	=cut
		1279
		1280	sub exec_async {
		1281	my $self = shift;
		1282
		1283	my $pid = fork;
		1284
		1285	return $pid
		1286	if !defined $pid or $pid;
		1287
		1288	%ENV = %{ $self->env };
		1289
		1290	exec @_;
		1291	urxvt::_exit 255;
		1292	}
		1293
		1294	=item $isset = $term->option ($optval[, $set])
		1295
		1296	Returns true if the option specified by C<$optval> is enabled, and
		1297	optionally change it. All option values are stored by name in the hash
		1298	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		1299
		1300	Here is a likely non-exhaustive list of option names, please see the
		1301	source file F</src/optinc.h> to see the actual list:
		1302
		1303	borderLess console cursorBlink cursorUnderline hold iconic insecure
		1304	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		1305	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
		1306	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
		1307	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
		1308	transparent tripleclickwords utmpInhibit visualBell
566		1309
567	=item $value = $term->resource ($name[, $newval])	1310	=item $value = $term->resource ($name[, $newval])
568		1311
569	Returns the current resource value associated with a given name and	1312	Returns the current resource value associated with a given name and
570	optionally sets a new value. Setting values is most useful in the C<init>	1313	optionally sets a new value. Setting values is most useful in the C<init>
…		…
579	likely change).	1322	likely change).
580		1323
581	Please note that resource strings will currently only be freed when the	1324	Please note that resource strings will currently only be freed when the
582	terminal is destroyed, so changing options frequently will eat memory.	1325	terminal is destroyed, so changing options frequently will eat memory.
583		1326
584	Here is a a likely non-exhaustive list of resource names, not all of which	1327	Here is a likely non-exhaustive list of resource names, not all of which
585	are supported in every build, please see the source to see the actual	1328	are supported in every build, please see the source file F</src/rsinc.h>
586	list:	1329	to see the actual list:
587		1330
588	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1331	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
589	borderLess color cursorBlink cursorUnderline cutchars delete_key	1332	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
590	display_name embed ext_bwidth fade font geometry hold iconName	1333	display_name embed ext_bwidth fade font geometry hold iconName
591	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1334	imFont imLocale inputMethod insecure int_bwidth intensityStyles
592	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1335	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
593	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1336	modifier mouseWheelScrollPage name override_redirect pastableTabs path
594	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1337	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
595	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1338	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
596	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1339	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
597	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1340	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
598	shade term_name title transparent transparent_all tripleclickwords	1341	secondaryScreen secondaryScroll shade term_name title
599	utmpInhibit visualBell	1342	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1343	visualBell
600		1344
601	=cut	1345	=cut
602		1346
603	sub urxvt::term::resource($$;$) {	1347	sub resource($$;$) {
604	my ($self, $name) = (shift, shift);	1348	my ($self, $name) = (shift, shift);
605	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1349	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
606	&urxvt::term::_resource	1350	goto &urxvt::term::_resource
607	}	1351	}
		1352
		1353	=item $value = $term->x_resource ($pattern)
		1354
		1355	Returns the X-Resource for the given pattern, excluding the program or
		1356	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1357	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1358	resource with that pattern exists.
		1359
		1360	This method should only be called during the C<on_start> hook, as there is
		1361	only one resource database per display, and later invocations might return
		1362	the wrong resources.
		1363
		1364	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1365
		1366	Adds a keymap translation exactly as specified via a resource. See the
		1367	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
608		1368
609	=item $rend = $term->rstyle ([$new_rstyle])	1369	=item $rend = $term->rstyle ([$new_rstyle])
610		1370
611	Return and optionally change the current rendition. Text that is output by	1371	Return and optionally change the current rendition. Text that is output by
612	the terminal application will use this style.	1372	the terminal application will use this style.
…		…
623	=item ($row, $col) = $term->selection_end ([$row, $col])	1383	=item ($row, $col) = $term->selection_end ([$row, $col])
624		1384
625	Return the current values of the selection mark, begin or end positions,	1385	Return the current values of the selection mark, begin or end positions,
626	and optionally set them to new values.	1386	and optionally set them to new values.
627		1387
		1388	=item $term->selection_make ($eventtime[, $rectangular])
		1389
		1390	Tries to make a selection as set by C<selection_beg> and
		1391	C<selection_end>. If C<$rectangular> is true (default: false), a
		1392	rectangular selection will be made. This is the prefered function to make
		1393	a selection.
		1394
628	=item $success = $term->selection_grab ($eventtime)	1395	=item $success = $term->selection_grab ($eventtime)
629		1396
630	Try to request the primary selection from the server (for example, as set	1397	Try to request the primary selection text from the server (for example, as
631	by the next method).	1398	set by the next method). No visual feedback will be given. This function
		1399	is mostly useful from within C<on_sel_grab> hooks.
632		1400
633	=item $oldtext = $term->selection ([$newtext])	1401	=item $oldtext = $term->selection ([$newtext])
634		1402
635	Return the current selection text and optionally replace it by C<$newtext>.	1403	Return the current selection text and optionally replace it by C<$newtext>.
636		1404
637	#=item $term->overlay ($x, $y, $text)	1405	=item $term->overlay_simple ($x, $y, $text)
638	#	1406
639	#Create a simple multi-line overlay box. See the next method for details.	1407	Create a simple multi-line overlay box. See the next method for details.
640	#	1408
641	#=cut	1409	=cut
642	#	1410
643	#sub urxvt::term::scr_overlay {	1411	sub overlay_simple {
644	# my ($self, $x, $y, $text) = @_;	1412	my ($self, $x, $y, $text) = @_;
645	#	1413
646	# my @lines = split /\n/, $text;	1414	my @lines = split /\n/, $text;
647	#	1415
648	# my $w = 0;	1416	my $w = List::Util::max map $self->strwidth ($_), @lines;
649	# for (map $self->strwidth ($_), @lines) {	1417
650	# $w = $_ if $w < $_;
651	# }
652	#
653	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1418	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
654	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1419	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
655	#}	1420
		1421	$overlay
		1422	}
656		1423
657	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1424	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
658		1425
659	Create a new (empty) overlay at the given position with the given	1426	Create a new (empty) overlay at the given position with the given
660	width/height. C<$rstyle> defines the initial rendition style	1427	width/height. C<$rstyle> defines the initial rendition style
…		…
671		1438
672	The methods currently supported on C<urxvt::overlay> objects are:	1439	The methods currently supported on C<urxvt::overlay> objects are:
673		1440
674	=over 4	1441	=over 4
675		1442
676	=item $overlay->set ($x, $y, $text, $rend)	1443	=item $overlay->set ($x, $y, $text[, $rend])
677		1444
678	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1445	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
679	text in rxvt-unicode's special encoding and an array of rendition values	1446	text in rxvt-unicode's special encoding and an array of rendition values
680	at a specific position inside the overlay.	1447	at a specific position inside the overlay.
681		1448
		1449	If C<$rend> is missing, then the rendition will not be changed.
		1450
682	=item $overlay->hide	1451	=item $overlay->hide
683		1452
684	If visible, hide the overlay, but do not destroy it.	1453	If visible, hide the overlay, but do not destroy it.
685		1454
686	=item $overlay->show	1455	=item $overlay->show
…		…
695	C<$event> I<must> be the event causing the menu to pop up (a button event,	1464	C<$event> I<must> be the event causing the menu to pop up (a button event,
696	currently).	1465	currently).
697		1466
698	=cut	1467	=cut
699		1468
700	sub urxvt::term::popup {	1469	sub popup {
701	my ($self, $event) = @_;	1470	my ($self, $event) = @_;
702		1471
703	$self->grab ($event->{time}, 1)	1472	$self->grab ($event->{time}, 1)
704	or return;	1473	or return;
705		1474
…		…
727		1496
728	=item $string = $term->locale_decode ($octets)	1497	=item $string = $term->locale_decode ($octets)
729		1498
730	Convert the given locale-encoded octets into a perl string.	1499	Convert the given locale-encoded octets into a perl string.
731		1500
		1501	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1502
		1503	XORs the rendition values in the given span with the provided value
		1504	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1505	refresh hooks to provide effects similar to the selection.
		1506
		1507	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1508
		1509	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1510	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1511	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1512	it instead. Both styles I<MUST NOT> contain font styles.
		1513
		1514	=item $term->scr_bell
		1515
		1516	Ring the bell!
		1517
732	=item $term->scr_add_lines ($string)	1518	=item $term->scr_add_lines ($string)
733		1519
734	Write the given text string to the screen, as if output by the application	1520	Write the given text string to the screen, as if output by the application
735	running inside the terminal. It may not contain command sequences (escape	1521	running inside the terminal. It may not contain command sequences (escape
736	codes), but is free to use line feeds, carriage returns and tabs. The	1522	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
738		1524
739	Normally its not a good idea to use this function, as programs might be	1525	Normally its not a good idea to use this function, as programs might be
740	confused by changes in cursor position or scrolling. Its useful inside a	1526	confused by changes in cursor position or scrolling. Its useful inside a
741	C<on_add_lines> hook, though.	1527	C<on_add_lines> hook, though.
742		1528
		1529	=item $term->scr_change_screen ($screen)
		1530
		1531	Switch to given screen - 0 primary, 1 secondary.
		1532
743	=item $term->cmd_parse ($octets)	1533	=item $term->cmd_parse ($octets)
744		1534
745	Similar to C<scr_add_lines>, but the argument must be in the	1535	Similar to C<scr_add_lines>, but the argument must be in the
746	locale-specific encoding of the terminal and can contain command sequences	1536	locale-specific encoding of the terminal and can contain command sequences
747	(escape codes) that will be interpreted.	1537	(escape codes) that will be interpreted.
…		…
750		1540
751	Write the octets given in C<$data> to the tty (i.e. as program input). To	1541	Write the octets given in C<$data> to the tty (i.e. as program input). To
752	pass characters instead of octets, you should convert your strings first	1542	pass characters instead of octets, you should convert your strings first
753	to the locale-specific encoding using C<< $term->locale_encode >>.	1543	to the locale-specific encoding using C<< $term->locale_encode >>.
754		1544
		1545	=item $old_events = $term->pty_ev_events ([$new_events])
		1546
		1547	Replaces the event mask of the pty watcher by the given event mask. Can
		1548	be used to suppress input and output handling to the pty/tty. See the
		1549	description of C<< urxvt::timer->events >>. Make sure to always restore
		1550	the previous value.
		1551
		1552	=item $fd = $term->pty_fd
		1553
		1554	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1555	is used.
		1556
755	=item $windowid = $term->parent	1557	=item $windowid = $term->parent
756		1558
757	Return the window id of the toplevel window.	1559	Return the window id of the toplevel window.
758		1560
759	=item $windowid = $term->vt	1561	=item $windowid = $term->vt
760		1562
761	Return the window id of the terminal window.	1563	Return the window id of the terminal window.
762		1564
		1565	=item $term->vt_emask_add ($x_event_mask)
		1566
		1567	Adds the specified events to the vt event mask. Useful e.g. when you want
		1568	to receive pointer events all the times:
		1569
		1570	$term->vt_emask_add (urxvt::PointerMotionMask);
		1571
		1572	=item $term->focus_in
		1573
		1574	=item $term->focus_out
		1575
		1576	=item $term->key_press ($state, $keycode[, $time])
		1577
		1578	=item $term->key_release ($state, $keycode[, $time])
		1579
		1580	Deliver various fake events to to terminal.
		1581
763	=item $window_width = $term->width	1582	=item $window_width = $term->width
764		1583
765	=item $window_height = $term->height	1584	=item $window_height = $term->height
766		1585
767	=item $font_width = $term->fwidth	1586	=item $font_width = $term->fwidth
…		…
780		1599
781	=item $max_scrollback = $term->saveLines	1600	=item $max_scrollback = $term->saveLines
782		1601
783	=item $nrow_plus_saveLines = $term->total_rows	1602	=item $nrow_plus_saveLines = $term->total_rows
784		1603
785	=item $lines_in_scrollback = $term->nsaved	1604	=item $topmost_scrollback_row = $term->top_row
786		1605
787	Return various integers describing terminal characteristics.	1606	Return various integers describing terminal characteristics.
		1607
		1608	=item $x_display = $term->display_id
		1609
		1610	Return the DISPLAY used by rxvt-unicode.
		1611
		1612	=item $lc_ctype = $term->locale
		1613
		1614	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1615
		1616	=item $env = $term->env
		1617
		1618	Returns a copy of the environment in effect for the terminal as a hashref
		1619	similar to C<\%ENV>.
		1620
		1621	=item @envv = $term->envv
		1622
		1623	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1624
		1625	=item @argv = $term->argv
		1626
		1627	Return the argument vector as this terminal, similar to @ARGV, but
		1628	includes the program name as first element.
		1629
		1630	=cut
		1631
		1632	sub env {
		1633	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1634	}
788		1635
789	=item $modifiermask = $term->ModLevel3Mask	1636	=item $modifiermask = $term->ModLevel3Mask
790		1637
791	=item $modifiermask = $term->ModMetaMask	1638	=item $modifiermask = $term->ModMetaMask
792		1639
793	=item $modifiermask = $term->ModNumLockMask	1640	=item $modifiermask = $term->ModNumLockMask
794		1641
795	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1642	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
796	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1643	AltGr), the meta key (often Alt) and the num lock key, if applicable.
797		1644
		1645	=item $screen = $term->current_screen
		1646
		1647	Returns the currently displayed screen (0 primary, 1 secondary).
		1648
		1649	=item $cursor_is_hidden = $term->hidden_cursor
		1650
		1651	Returns whether the cursor is currently hidden or not.
		1652
798	=item $view_start = $term->view_start ([$newvalue])	1653	=item $view_start = $term->view_start ([$newvalue])
799		1654
800	Returns the negative row number of the topmost line. Minimum value is	1655	Returns the row number of the topmost displayed line. Maximum value is
801	C<0>, which displays the normal terminal contents. Larger values scroll	1656	C<0>, which displays the normal terminal contents. Lower values scroll
802	this many lines into the scrollback buffer.	1657	this many lines into the scrollback buffer.
803		1658
804	=item $term->want_refresh	1659	=item $term->want_refresh
805		1660
806	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1661	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
809		1664
810	Used after changing terminal contents to display them.	1665	Used after changing terminal contents to display them.
811		1666
812	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1667	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
813		1668
814	Returns the text of the entire row with number C<$row_number>. Row C<0>	1669	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
815	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1670	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
816	terminal line. The scrollback buffer starts at line C<-1> and extends to
817	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1671	terminal line. Nothing will be returned if a nonexistent line
818	is requested.	1672	is requested.
819		1673
820	If C<$new_text> is specified, it will replace characters in the current	1674	If C<$new_text> is specified, it will replace characters in the current
821	line, starting at column C<$start_col> (default C<0>), which is useful	1675	line, starting at column C<$start_col> (default C<0>), which is useful
822	to replace only parts of a line. The font index in the rendition will	1676	to replace only parts of a line. The font index in the rendition will
823	automatically be updated.	1677	automatically be updated.
824		1678
825	C<$text> is in a special encoding: tabs and wide characters that use more	1679	C<$text> is in a special encoding: tabs and wide characters that use more
826	than one cell when displayed are padded with urxvt::NOCHAR characters	1680	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
827	(C<chr 65535>). Characters with combining characters and other characters	1681	characters. Characters with combining characters and other characters that
828	that do not fit into the normal tetx encoding will be replaced with	1682	do not fit into the normal text encoding will be replaced with characters
829	characters in the private use area.	1683	in the private use area.
830		1684
831	You have to obey this encoding when changing text. The advantage is	1685	You have to obey this encoding when changing text. The advantage is
832	that C<substr> and similar functions work on screen cells and not on	1686	that C<substr> and similar functions work on screen cells and not on
833	characters.	1687	characters.
834		1688
…		…
885	Return the row number of the first/last row of the line, respectively.	1739	Return the row number of the first/last row of the line, respectively.
886		1740
887	=item $offset = $line->offset_of ($row, $col)	1741	=item $offset = $line->offset_of ($row, $col)
888		1742
889	Returns the character offset of the given row|col pair within the logical	1743	Returns the character offset of the given row|col pair within the logical
890	line.	1744	line. Works for rows outside the line, too, and returns corresponding
		1745	offsets outside the string.
891		1746
892	=item ($row, $col) = $line->coord_of ($offset)	1747	=item ($row, $col) = $line->coord_of ($offset)
893		1748
894	Translates a string offset into terminal coordinates again.	1749	Translates a string offset into terminal coordinates again.
895		1750
896	=back	1751	=back
897		1752
898	=cut	1753	=cut
899		1754
900	sub urxvt::term::line {	1755	sub line {
901	my ($self, $row) = @_;	1756	my ($self, $row) = @_;
902		1757
903	my $maxrow = $self->nrow - 1;	1758	my $maxrow = $self->nrow - 1;
904		1759
905	my ($beg, $end) = ($row, $row);	1760	my ($beg, $end) = ($row, $row);
…		…
969	$offset / $self->{ncol} + $self->{beg},	1824	$offset / $self->{ncol} + $self->{beg},
970	$offset % $self->{ncol}	1825	$offset % $self->{ncol}
971	)	1826	)
972	}	1827	}
973		1828
974	=item ($row, $col) = $line->coord_of ($offset)
975	=item $text = $term->special_encode $string	1829	=item $text = $term->special_encode $string
976		1830
977	Converts a perl string into the special encoding used by rxvt-unicode,	1831	Converts a perl string into the special encoding used by rxvt-unicode,
978	where one character corresponds to one screen cell. See	1832	where one character corresponds to one screen cell. See
979	C<< $term->ROW_t >> for details.	1833	C<< $term->ROW_t >> for details.
980		1834
981	=item $string = $term->special_decode $text	1835	=item $string = $term->special_decode $text
982		1836
983	Converts rxvt-unicodes text reprsentation into a perl string. See	1837	Converts rxvt-unicodes text representation into a perl string. See
984	C<< $term->ROW_t >> for details.	1838	C<< $term->ROW_t >> for details.
985		1839
		1840	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
		1841
		1842	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1843
		1844	Register/unregister a synchronous button grab. See the XGrabButton
		1845	manpage.
		1846
		1847	=item $success = $term->grab ($eventtime[, $sync])
		1848
		1849	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1850	synchronous (C<$sync> is true). Also remembers the grab timestamp.
		1851
		1852	=item $term->allow_events_async
		1853
		1854	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1855
		1856	=item $term->allow_events_sync
		1857
		1858	Calls XAllowEvents with SyncBoth for the most recent grab.
		1859
		1860	=item $term->allow_events_replay
		1861
		1862	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1863	recent grab.
		1864
		1865	=item $term->ungrab
		1866
		1867	Calls XUngrab for the most recent grab. Is called automatically on
		1868	evaluation errors, as it is better to lose the grab in the error case as
		1869	the session.
		1870
		1871	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1872
		1873	=item $atom_name = $term->XGetAtomName ($atom)
		1874
		1875	=item @atoms = $term->XListProperties ($window)
		1876
		1877	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1878
		1879	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1880
		1881	=item $term->XDeleteProperty ($window, $property)
		1882
		1883	=item $window = $term->DefaultRootWindow
		1884
		1885	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1886
		1887	=item $term->XMapWindow ($window)
		1888
		1889	=item $term->XUnmapWindow ($window)
		1890
		1891	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1892
		1893	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1894
		1895	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1896
		1897	Various X or X-related functions. The C<$term> object only serves as
		1898	the source of the display, otherwise those functions map more-or-less
		1899	directory onto the X functions of the same name.
		1900
986	=back	1901	=back
987		1902
		1903	=cut
		1904
		1905	package urxvt::popup;
		1906
988	=head2 The C<urxvt::popup> Class	1907	=head2 The C<urxvt::popup> Class
989		1908
990	=over 4	1909	=over 4
991		1910
992	=cut	1911	=cut
993
994	package urxvt::popup;
995		1912
996	sub add_item {	1913	sub add_item {
997	my ($self, $item) = @_;	1914	my ($self, $item) = @_;
998		1915
		1916	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1917	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1918	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1919
		1920	$item->{render} ||= sub { $_[0]{text} };
		1921
999	push @{ $self->{item} }, $item;	1922	push @{ $self->{item} }, $item;
1000	}	1923	}
		1924
		1925	=item $popup->add_title ($title)
		1926
		1927	Adds a non-clickable title to the popup.
		1928
		1929	=cut
		1930
		1931	sub add_title {
		1932	my ($self, $title) = @_;
		1933
		1934	$self->add_item ({
		1935	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1936	text => $title,
		1937	activate => sub { },
		1938	});
		1939	}
		1940
		1941	=item $popup->add_separator ([$sepchr])
		1942
		1943	Creates a separator, optionally using the character given as C<$sepchr>.
		1944
		1945	=cut
		1946
		1947	sub add_separator {
		1948	my ($self, $sep) = @_;
		1949
		1950	$sep ||= "=";
		1951
		1952	$self->add_item ({
		1953	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1954	text => "",
		1955	render => sub { $sep x $self->{term}->ncol },
		1956	activate => sub { },
		1957	});
		1958	}
		1959
		1960	=item $popup->add_button ($text, $cb)
		1961
		1962	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1963	selected.
		1964
		1965	=cut
1001		1966
1002	sub add_button {	1967	sub add_button {
1003	my ($self, $text, $cb) = @_;	1968	my ($self, $text, $cb) = @_;
1004		1969
1005	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb });	1970	$self->add_item ({ type => "button", text => $text, activate => $cb});
1006	}	1971	}
		1972
		1973	=item $popup->add_toggle ($text, $initial_value, $cb)
		1974
		1975	Adds a toggle/checkbox item to the popup. The callback gets called
		1976	whenever it gets toggled, with a boolean indicating its new value as its
		1977	first argument.
		1978
		1979	=cut
		1980
		1981	sub add_toggle {
		1982	my ($self, $text, $value, $cb) = @_;
		1983
		1984	my $item; $item = {
		1985	type => "button",
		1986	text => " $text",
		1987	value => $value,
		1988	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1989	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1990	};
		1991
		1992	$self->add_item ($item);
		1993	}
		1994
		1995	=item $popup->show
		1996
		1997	Displays the popup (which is initially hidden).
		1998
		1999	=cut
1007		2000
1008	sub show {	2001	sub show {
1009	my ($self) = @_;	2002	my ($self) = @_;
1010		2003
1011	local $urxvt::popup::self = $self;	2004	local $urxvt::popup::self = $self;
1012		2005
1013	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2006	my $env = $self->{term}->env;
		2007	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		2008	delete $env->{LC_ALL};
		2009	$env->{LC_CTYPE} = $self->{term}->locale;
		2010
		2011	my $term = urxvt::term->new (
		2012	$env, "popup",
		2013	"--perl-lib" => "", "--perl-ext-common" => "",
		2014	"-pty-fd" => -1, "-sl" => 0,
		2015	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1014	"--transient-for" => $self->{term}->parent,	2016	"--transient-for" => $self->{term}->parent,
		2017	"-display" => $self->{term}->display_id,
1015	"-pe" => "urxvt-popup")	2018	"-pe" => "urxvt-popup",
1016	or die "unable to create popup window\n";	2019	) or die "unable to create popup window\n";
		2020
		2021	unless (delete $term->{urxvt_popup_init_done}) {
		2022	$term->ungrab;
		2023	$term->destroy;
		2024	die "unable to initialise popup window\n";
		2025	}
1017	}	2026	}
1018		2027
1019	sub DESTROY {	2028	sub DESTROY {
1020	my ($self) = @_;	2029	my ($self) = @_;
1021		2030
		2031	delete $self->{term}{_destroy}{$self};
1022	$self->{term}->ungrab;	2032	$self->{term}->ungrab;
1023	}	2033	}
		2034
		2035	=back
		2036
		2037	=cut
		2038
		2039	package urxvt::watcher;
1024		2040
1025	=head2 The C<urxvt::timer> Class	2041	=head2 The C<urxvt::timer> Class
1026		2042
1027	This class implements timer watchers/events. Time is represented as a	2043	This class implements timer watchers/events. Time is represented as a
1028	fractional number of seconds since the epoch. Example:	2044	fractional number of seconds since the epoch. Example:
…		…
1032	->new	2048	->new
1033	->interval (1)	2049	->interval (1)
1034	->cb (sub {	2050	->cb (sub {
1035	$term->{overlay}->set (0, 0,	2051	$term->{overlay}->set (0, 0,
1036	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2052	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1037	});	2053	});
1038		2054
1039	=over 4	2055	=over 4
1040		2056
1041	=item $timer = new urxvt::timer	2057	=item $timer = new urxvt::timer
1042		2058
…		…
1066	Start the timer.	2082	Start the timer.
1067		2083
1068	=item $timer = $timer->start ($tstamp)	2084	=item $timer = $timer->start ($tstamp)
1069		2085
1070	Set the event trigger time to C<$tstamp> and start the timer.	2086	Set the event trigger time to C<$tstamp> and start the timer.
		2087
		2088	=item $timer = $timer->after ($delay)
		2089
		2090	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1071		2091
1072	=item $timer = $timer->stop	2092	=item $timer = $timer->stop
1073		2093
1074	Stop the timer.	2094	Stop the timer.
1075		2095
…		…
1081		2101
1082	$term->{socket} = ...	2102	$term->{socket} = ...
1083	$term->{iow} = urxvt::iow	2103	$term->{iow} = urxvt::iow
1084	->new	2104	->new
1085	->fd (fileno $term->{socket})	2105	->fd (fileno $term->{socket})
1086	->events (1) # wait for read data	2106	->events (urxvt::EV_READ)
1087	->start	2107	->start
1088	->cb (sub {	2108	->cb (sub {
1089	my ($iow, $revents) = @_;	2109	my ($iow, $revents) = @_;
1090	# $revents must be 1 here, no need to check	2110	# $revents must be 1 here, no need to check
1091	sysread $term->{socket}, my $buf, 8192	2111	sysread $term->{socket}, my $buf, 8192
…		…
1104	Set the callback to be called when io events are triggered. C<$reventmask>	2124	Set the callback to be called when io events are triggered. C<$reventmask>
1105	is a bitset as described in the C<events> method.	2125	is a bitset as described in the C<events> method.
1106		2126
1107	=item $iow = $iow->fd ($fd)	2127	=item $iow = $iow->fd ($fd)
1108		2128
1109	Set the filedescriptor (not handle) to watch.	2129	Set the file descriptor (not handle) to watch.
1110		2130
1111	=item $iow = $iow->events ($eventmask)	2131	=item $iow = $iow->events ($eventmask)
1112		2132
1113	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2133	Set the event mask to watch. The only allowed values are
1114	data, Bit #1 (value C<2>) enables watching for write data.	2134	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
		2135	together, or C<urxvt::EV_NONE>.
1115		2136
1116	=item $iow = $iow->start	2137	=item $iow = $iow->start
1117		2138
1118	Start watching for requested events on the given handle.	2139	Start watching for requested events on the given handle.
1119		2140
1120	=item $iow = $iow->stop	2141	=item $iow = $iow->stop
1121		2142
1122	Stop watching for events on the given filehandle.	2143	Stop watching for events on the given file handle.
		2144
		2145	=back
		2146
		2147	=head2 The C<urxvt::iw> Class
		2148
		2149	This class implements idle watchers, that get called automatically when
		2150	the process is idle. They should return as fast as possible, after doing
		2151	some useful work.
		2152
		2153	=over 4
		2154
		2155	=item $iw = new urxvt::iw
		2156
		2157	Create a new idle watcher object in stopped state.
		2158
		2159	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2160
		2161	Set the callback to be called when the watcher triggers.
		2162
		2163	=item $timer = $timer->start
		2164
		2165	Start the watcher.
		2166
		2167	=item $timer = $timer->stop
		2168
		2169	Stop the watcher.
		2170
		2171	=back
		2172
		2173	=head2 The C<urxvt::pw> Class
		2174
		2175	This class implements process watchers. They create an event whenever a
		2176	process exits, after which they stop automatically.
		2177
		2178	my $pid = fork;
		2179	...
		2180	$term->{pw} = urxvt::pw
		2181	->new
		2182	->start ($pid)
		2183	->cb (sub {
		2184	my ($pw, $exit_status) = @_;
		2185	...
		2186	});
		2187
		2188	=over 4
		2189
		2190	=item $pw = new urxvt::pw
		2191
		2192	Create a new process watcher in stopped state.
		2193
		2194	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2195
		2196	Set the callback to be called when the timer triggers.
		2197
		2198	=item $pw = $timer->start ($pid)
		2199
		2200	Tells the watcher to start watching for process C<$pid>.
		2201
		2202	=item $pw = $pw->stop
		2203
		2204	Stop the watcher.
1123		2205
1124	=back	2206	=back
1125		2207
1126	=head1 ENVIRONMENT	2208	=head1 ENVIRONMENT
1127		2209
…		…
1130	This variable controls the verbosity level of the perl extension. Higher	2212	This variable controls the verbosity level of the perl extension. Higher
1131	numbers indicate more verbose output.	2213	numbers indicate more verbose output.
1132		2214
1133	=over 4	2215	=over 4
1134		2216
1135	=item =0 - only fatal messages	2217	=item == 0 - fatal messages
1136		2218
1137	=item =3 - script loading and management	2219	=item >= 3 - script loading and management
1138		2220
1139	=item =10 - all events received	2221	=item >=10 - all called hooks
		2222
		2223	=item >=11 - hook return values
1140		2224
1141	=back	2225	=back
1142		2226
1143	=head1 AUTHOR	2227	=head1 AUTHOR
1144		2228
…		…
1146	http://software.schmorp.de/pkg/rxvt-unicode	2230	http://software.schmorp.de/pkg/rxvt-unicode
1147		2231
1148	=cut	2232	=cut
1149		2233
1150	1	2234	1
		2235
		2236	# vim: sw=3:

Diff Legend

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