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.18 by root, Tue Jan 3 02:01:27 2006 UTC vs.
Revision 1.198 by root, Tue Oct 4 22:25:14 2011 UTC

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

Diff Legend

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