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

Diff Legend

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