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.17 by root, Tue Jan 3 01:45:03 2006 UTC vs.
Revision 1.197 by sf-tpope, Fri Aug 19 23:08:35 2011 UTC

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

Diff Legend

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