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.12 by root, Mon Jan 2 22:23:26 2006 UTC vs.
Revision 1.205 by root, Tue Jun 5 19:32:29 2012 UTC

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

Diff Legend

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