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

Diff Legend

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