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.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 2011 UTC

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

Diff Legend

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