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.65 by root, Mon Jan 9 19:25:57 2006 UTC vs.
Revision 1.157 by ayin, Wed Oct 31 09:55:24 2007 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, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the 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,automove-background,selection-autotransform
		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
44	Intelligent selection. This extension tries to be more intelligent when	51	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	52	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	53	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	54	arguments, which is very convenient, too, if your F<ls> supports
		55	C<--quoting-style=shell>.
48		56
49	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:
50		86
51	=over 4	87	=over 4
52		88
53	=item rot13	89	=item rot13
54		90
…		…
61	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
62		98
63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	100	runtime.
65		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	It's 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
66	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
67		120
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	122	text into various other formats/action (such as uri unescaping, perl
		123	evaluation, web-browser starting etc.), depending on content.
70		124
71	=item digital-clock	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.
72		128
73	Displays a digital clock using the built-in overlay.	129	It's 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<$_>.
74		134
75	=item mark-urls	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:
76		138
		139	push @{ $self->{term}{selection_popup_hook} }, sub {
		140	/a/ ? ("a to be" => 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 (the 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
77	Uses per-line display filtering (C<on_line_update>) to underline urls.	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 leats 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 thats 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 automove-background
		309
		310	This is basically a very small extension that dynamically changes the
		311	background pixmap offset to the window position, in effect creating the
		312	same effect as pseudo transparency with a custom pixmap. No scaling is
		313	supported in this mode. Example:
		314
		315	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		316
		317	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
		318	shows how this extension can be used to implement an automatically blurred
		319	transparent background.
78		320
79	=item block-graphics-to-ascii	321	=item block-graphics-to-ascii
80		322
81	A not very useful example of filtering all text output to the terminal,	323	A not very useful example of filtering all text output to the terminal
82	by replacing all line-drawing characters (U+2500 .. U+259F) by a	324	by replacing all line-drawing characters (U+2500 .. U+259F) by a
83	similar-looking ascii character.	325	similar-looking ascii character.
		326
		327	=item digital-clock
		328
		329	Displays a digital clock using the built-in overlay.
		330
		331	=item remote-clipboard
		332
		333	Somewhat of a misnomer, this extension adds two menu entries to the
		334	selection popup that allows one ti run external commands to store the
		335	selection somewhere and fetch it again.
		336
		337	We use it to implement a "distributed selection mechanism", which just
		338	means that one command uploads the file to a remote server, and another
		339	reads it.
		340
		341	The commands can be set using the C<URxvt.remote-selection.store> and
		342	C<URxvt.remote-selection.fetch> resources. The first should read the
		343	selection to store from STDIN (always in UTF-8), the second should provide
		344	the selection data on STDOUT (also in UTF-8).
		345
		346	The defaults (which are likely useless to you) use rsh and cat:
		347
		348	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		349	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		350
		351	=item selection-pastebin
		352
		353	This is a little rarely useful extension that Uploads the selection as
		354	textfile to a remote site (or does other things). (The implementation is
		355	not currently secure for use in a multiuser environment as it writes to
		356	F</tmp> directly.).
		357
		358	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		359	i.e.
		360
		361	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		362
		363	Pressing this combination runs a command with C<%> replaced by the name of
		364	the textfile. This command can be set via a resource:
		365
		366	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		367
		368	And the default is likely not useful to anybody but the few people around
		369	here :)
		370
		371	The name of the textfile is the hex encoded md5 sum of the selection, so
		372	the same content should lead to the same filename.
		373
		374	After a successful upload the selection will be replaced by the text given
		375	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		376	for the filename):
		377
		378	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		379
		380	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		381	the double C</> characters as comment start. Use C<\057\057> instead,
		382	which works regardless of wether xrdb is used to parse the resource file
		383	or not.
84		384
85	=item example-refresh-hooks	385	=item example-refresh-hooks
86		386
87	Displays a very simple digital clock in the upper right corner of the	387	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own	388	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	389	overlays or changes.
90		390
91	=back	391	=back
		392
		393	=head1 API DOCUMENTATION
92		394
93	=head2 General API Considerations	395	=head2 General API Considerations
94		396
95	All objects (such as terminals, time watchers etc.) are typical	397	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	398	reference-to-hash objects. The hash can be used to store anything you
…		…
109	=over 4	411	=over 4
110		412
111	=item $text	413	=item $text
112		414
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	415	Rxvt-unicodes special way of encoding text, where one "unicode" character
114	always represents one screen cell. See L<row_t> for a discussion of this format.	416	always represents one screen cell. See L<ROW_t> for a discussion of this format.
115		417
116	=item $string	418	=item $string
117		419
118	A perl text string, with an emphasis on I<text>. It can store all unicode	420	A perl text string, with an emphasis on I<text>. It can store all unicode
119	characters and is to be distinguished with text encoded in a specific	421	characters and is to be distinguished with text encoded in a specific
…		…
124	Either binary data or - more common - a text string encoded in a	426	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	427	locale-specific way.
126		428
127	=back	429	=back
128		430
		431	=head2 Extension Objects
		432
		433	Every perl extension is a perl class. A separate perl object is created
		434	for each terminal, and each terminal has its own set of extenion objects,
		435	which are passed as the first parameter to hooks. So extensions can use
		436	their C<$self> object without having to think about clashes with other
		437	extensions or other terminals, with the exception of methods and members
		438	that begin with an underscore character C<_>: these are reserved for
		439	internal use.
		440
		441	Although it isn't a C<urxvt::term> object, you can call all methods of the
		442	C<urxvt::term> class on this object.
		443
		444	It has the following methods and data members:
		445
		446	=over 4
		447
		448	=item $urxvt_term = $self->{term}
		449
		450	Returns the C<urxvt::term> object associated with this instance of the
		451	extension. This member I<must not> be changed in any way.
		452
		453	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		454
		455	Dynamically enable the given hooks (named without the C<on_> prefix) for
		456	this extension, replacing any previous hook. This is useful when you want
		457	to overwrite time-critical hooks only temporarily.
		458
		459	=item $self->disable ($hook_name[, $hook_name..])
		460
		461	Dynamically disable the given hooks.
		462
		463	=back
		464
129	=head2 Hooks	465	=head2 Hooks
130		466
131	The following subroutines can be declared in extension files, and will be	467	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	468	called whenever the relevant event happens.
133		469
134	The first argument passed to them is an object private to each terminal	470	The first argument passed to them is an extension object as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	471	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		472
141	All of them must return a boolean value. If it is true, then the event	473	B<All> of these hooks must return a boolean value. If any of the called
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	474	hooks returns true, then the event counts as being I<consumed>, and the
143	and the relevant action might not be carried out by the C++ code.	475	relevant action might not be carried out by the C++ code.
144		476
145	When in doubt, return a false value (preferably C<()>).	477	I<< When in doubt, return a false value (preferably C<()>). >>
146		478
147	=over 4	479	=over 4
148		480
149	=item on_init $term	481	=item on_init $term
150		482
151	Called after a new terminal object has been initialized, but before	483	Called after a new terminal object has been initialized, but before
152	windows are created or the command gets run. Most methods are unsafe to	484	windows are created or the command gets run. Most methods are unsafe to
153	call or deliver senseless data, as terminal size and other characteristics	485	call or deliver senseless data, as terminal size and other characteristics
154	have not yet been determined. You can safely query and change resources,	486	have not yet been determined. You can safely query and change resources
155	though.	487	and options, though. For many purposes the C<on_start> hook is a better
		488	place.
		489
		490	=item on_start $term
		491
		492	Called at the very end of initialisation of a new terminal, just before
		493	trying to map (display) the toplevel and returning to the main loop.
		494
		495	=item on_destroy $term
		496
		497	Called whenever something tries to destroy terminal, when the terminal is
		498	still fully functional (not for long, though).
156		499
157	=item on_reset $term	500	=item on_reset $term
158		501
159	Called after the screen is "reset" for any reason, such as resizing or	502	Called after the screen is "reset" for any reason, such as resizing or
160	control sequences. Here is where you can react on changes to size-related	503	control sequences. Here is where you can react on changes to size-related
161	variables.	504	variables.
162		505
163	=item on_start $term	506	=item on_child_start $term, $pid
164		507
165	Called at the very end of initialisation of a new terminal, just before	508	Called just after the child process has been C<fork>ed.
166	returning to the mainloop.	509
		510	=item on_child_exit $term, $status
		511
		512	Called just after the child process has exited. C<$status> is the status
		513	from C<waitpid>.
167		514
168	=item on_sel_make $term, $eventtime	515	=item on_sel_make $term, $eventtime
169		516
170	Called whenever a selection has been made by the user, but before the	517	Called whenever a selection has been made by the user, but before the
171	selection text is copied, so changes to the beginning, end or type of the	518	selection text is copied, so changes to the beginning, end or type of the
…		…
178		525
179	Called whenever a selection has been copied, but before the selection is	526	Called whenever a selection has been copied, but before the selection is
180	requested from the server. The selection text can be queried and changed	527	requested from the server. The selection text can be queried and changed
181	by calling C<< $term->selection >>.	528	by calling C<< $term->selection >>.
182		529
183	Returning a true value aborts selection grabbing. It will still be hilighted.	530	Returning a true value aborts selection grabbing. It will still be highlighted.
184		531
185	=item on_sel_extend $term	532	=item on_sel_extend $term
186		533
187	Called whenever the user tries to extend the selection (e.g. with a double	534	Called whenever the user tries to extend the selection (e.g. with a double
188	click) and is either supposed to return false (normal operation), or	535	click) and is either supposed to return false (normal operation), or
189	should extend the selection itelf and return true to suppress the built-in	536	should extend the selection itself and return true to suppress the built-in
190	processing.	537	processing. This can happen multiple times, as long as the callback
		538	returns true, it will be called on every further click by the user and is
		539	supposed to enlarge the selection more and more, if possible.
191		540
192	See the F<selection> example extension.	541	See the F<selection> example extension.
193		542
194	=item on_view_change $term, $offset	543	=item on_view_change $term, $offset
195		544
196	Called whenever the view offset changes, i..e the user or program	545	Called whenever the view offset changes, i.e. the user or program
197	scrolls. Offset C<0> means display the normal terminal, positive values	546	scrolls. Offset C<0> means display the normal terminal, positive values
198	show this many lines of scrollback.	547	show this many lines of scrollback.
199		548
200	=item on_scroll_back $term, $lines, $saved	549	=item on_scroll_back $term, $lines, $saved
201		550
…		…
205		554
206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	555	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
207	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	556	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
208	number of lines that will be in the scrollback buffer.	557	number of lines that will be in the scrollback buffer.
209		558
		559	=item on_osc_seq $term, $op, $args
		560
		561	Called on every OSC sequence and can be used to suppress it or modify its
		562	behaviour. The default should be to return an empty list. A true value
		563	suppresses execution of the request completely. Make sure you don't get
		564	confused by recursive invocations when you output an osc sequence within
		565	this callback.
		566
		567	C<on_osc_seq_perl> should be used for new behaviour.
		568
210	=item on_osc_seq $term, $string	569	=item on_osc_seq_perl $term, $string
211		570
212	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	571	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
213	operating system command) is processed. Cursor position and other state	572	operating system command) is processed. Cursor position and other state
214	information is up-to-date when this happens. For interoperability, the	573	information is up-to-date when this happens. For interoperability, the
215	string should start with the extension name and a colon, to distinguish	574	string should start with the extension name and a colon, to distinguish
216	it from commands for other extensions, and this might be enforced in the	575	it from commands for other extensions, and this might be enforced in the
217	future.	576	future.
218		577
219	Be careful not ever to trust (in a security sense) the data you receive,	578	Be careful not ever to trust (in a security sense) the data you receive,
220	as its source can not easily be controleld (e-mail content, messages from	579	as its source can not easily be controlled (e-mail content, messages from
221	other users on the same system etc.).	580	other users on the same system etc.).
222		581
223	=item on_add_lines $term, $string	582	=item on_add_lines $term, $string
224		583
225	Called whenever text is about to be output, with the text as argument. You	584	Called whenever text is about to be output, with the text as argument. You
226	can filter/change and output the text yourself by returning a true value	585	can filter/change and output the text yourself by returning a true value
227	and calling C<< $term->scr_add_lines >> yourself. Please note that this	586	and calling C<< $term->scr_add_lines >> yourself. Please note that this
228	might be very slow, however, as your hook is called for B<all> text being	587	might be very slow, however, as your hook is called for B<all> text being
229	output.	588	output.
230		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
231	=item on_line_update $term, $row	595	=item on_line_update $term, $row
232		596
233	Called whenever a line was updated or changed. Can be used to filter	597	Called whenever a line was updated or changed. Can be used to filter
234	screen output (e.g. underline urls or other useless stuff). Only lines	598	screen output (e.g. underline urls or other useless stuff). Only lines
235	that are being shown will be filtered, and, due to performance reasons,	599	that are being shown will be filtered, and, due to performance reasons,
…		…
251		615
252	=item on_refresh_end $term	616	=item on_refresh_end $term
253		617
254	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>.
255		619
256	=item on_keyboard_command $term, $string	620	=item on_user_command $term, $string
257		621
258	Called whenever the user presses a key combination that has a	622	Called whenever a user-configured event is being activated (e.g. via
259	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>
260	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.
261		644
262	=item on_focus_in $term	645	=item on_focus_in $term
263		646
264	Called whenever the window gets the keyboard focus, before rxvt-unicode	647	Called whenever the window gets the keyboard focus, before rxvt-unicode
265	does focus in processing.	648	does focus in processing.
266		649
267	=item on_focus_out $term	650	=item on_focus_out $term
268		651
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	652	Called whenever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	653	focus out processing.
271		654
		655	=item on_configure_notify $term, $event
		656
		657	=item on_property_notify $term, $event
		658
272	=item on_key_press $term, $event, $octets	659	=item on_key_press $term, $event, $keysym, $octets
273		660
274	=item on_key_release $term, $event	661	=item on_key_release $term, $event, $keysym
275		662
276	=item on_button_press $term, $event	663	=item on_button_press $term, $event
277		664
278	=item on_button_release $term, $event	665	=item on_button_release $term, $event
279		666
…		…
285		672
286	Called whenever the corresponding X event is received for the terminal If	673	Called whenever the corresponding X event is received for the terminal If
287	the hook returns true, then the even will be ignored by rxvt-unicode.	674	the hook returns true, then the even will be ignored by rxvt-unicode.
288		675
289	The event is a hash with most values as named by Xlib (see the XEvent	676	The event is a hash with most values as named by Xlib (see the XEvent
290	manpage), with the additional members C<row> and C<col>, which are the row	677	manpage), with the additional members C<row> and C<col>, which are the
291	and column under the mouse cursor.	678	(real, not screen-based) row and column under the mouse cursor.
292		679
293	C<on_key_press> additionally receives the string rxvt-unicode would	680	C<on_key_press> additionally receives the string rxvt-unicode would
294	output, if any, in locale-specific encoding.	681	output, if any, in locale-specific encoding.
295		682
296	subwindow.	683	subwindow.
297		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
298	=back	694	=back
299		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
300	=head2 Variables in the C<urxvt> Package	721	=head2 Variables in the C<urxvt> Package
301		722
302	=over 4	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>.
303		737
304	=item $urxvt::TERM	738	=item $urxvt::TERM
305		739
306	The current terminal. This variable stores the current C<urxvt::term>	740	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	741	object, whenever a callback/hook is executing.
308		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>.
		758
309	=back	759	=back
310		760
311	=head2 Functions in the C<urxvt> Package	761	=head2 Functions in the C<urxvt> Package
312		762
313	=over 4	763	=over 4
314
315	=item $term = new urxvt [arg...]
316
317	Creates a new terminal, very similar as if you had started it with
318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319	if the new instance couldn't be created. Returns C<undef> if the new
320	instance didn't initialise perl, and the terminal object otherwise. The
321	C<init> and C<start> hooks will be called during the call.
322		764
323	=item urxvt::fatal $errormessage	765	=item urxvt::fatal $errormessage
324		766
325	Fatally aborts execution with the given error message. Avoid at all	767	Fatally aborts execution with the given error message. Avoid at all
326	costs! The only time this is acceptable is when the terminal process	768	costs! The only time this is acceptable is when the terminal process
…		…
333	that calls this function.	775	that calls this function.
334		776
335	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
336	correct place, e.g. on stderr of the connecting urxvtc client.	778	correct place, e.g. on stderr of the connecting urxvtc client.
337		779
338	=item $is_safe = urxvt::safe	780	Messages have a size limit of 1023 bytes currently.
339		781
340	Returns true when it is safe to do potentially unsafe things, such as	782	=item @terms = urxvt::termlist
341	evaluating perl code specified by the user. This is true when urxvt was	783
342	started setuid or setgid.	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).
343		788
344	=item $time = urxvt::NOW	789	=item $time = urxvt::NOW
345		790
346	Returns the "current time" (as per the event loop).	791	Returns the "current time" (as per the event loop).
347		792
348	=item urxvt::CurrentTime	793	=item urxvt::CurrentTime
349		794
350	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	795	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
351	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	796	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
352	Button4Mask, Button5Mask, AnyModifier	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
353		814
354	Various constants for use in X calls and event processing.	815	Various constants for use in X calls and event processing.
355		816
356	=back	817	=back
357		818
…		…
386		847
387	=item $background = urxvt::GET_BASEBG $rend	848	=item $background = urxvt::GET_BASEBG $rend
388		849
389	Return the foreground/background colour index, respectively.	850	Return the foreground/background colour index, respectively.
390		851
391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	852	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
392		853
393	=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
394		857
395	Replace the foreground/background colour in the rendition mask with the	858	Replace the foreground/background colour in the rendition mask with the
396	specified one.	859	specified one.
397		860
398	=item $value = urxvt::GET_CUSTOM ($rend)	861	=item $value = urxvt::GET_CUSTOM $rend
399		862
400	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
401	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
402	zero.	865	zero.
403		866
404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	867	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
405		868
406	Change the custom value.	869	Change the custom value.
407		870
408	=back	871	=back
409		872
410	=cut	873	=cut
411		874
412	package urxvt;
413
414	use utf8;
415	use strict;
416	use Scalar::Util ();
417	use List::Util ();
418
419	our $VERSION = 1;
420	our $TERM;
421	our @HOOKNAME;
422	our %OPTION;
423	our $LIBDIR;
424
425	BEGIN {	875	BEGIN {
426	urxvt->bootstrap;
427
428	# overwrite perl's warn	876	# overwrite perl's warn
429	*CORE::GLOBAL::warn = sub {	877	*CORE::GLOBAL::warn = sub {
430	my $msg = join "", @_;	878	my $msg = join "", @_;
431	$msg .= "\n"	879	$msg .= "\n"
432	unless $msg =~ /\n$/;	880	unless $msg =~ /\n$/;
433	urxvt::warn ($msg);	881	urxvt::warn ($msg);
434	};	882	};
435
436	delete $ENV{IFS};
437	delete $ENV{CDPATH};
438	delete $ENV{BASH_ENV};
439	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
440	}	883	}
441		884
442	my @hook_count;	885	no warnings 'utf8';
		886
443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	887	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
444		888
445	sub verbose {	889	sub verbose {
446	my ($level, $msg) = @_;	890	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	891	warn "$msg\n" if $level <= $verbosity;
448	}	892	}
449		893
450	# find on_xxx subs in the package and register them
451	# as hooks
452	sub register_package($) {
453	my ($pkg) = @_;
454
455	for my $htype (0.. $#HOOKNAME) {
456	my $name = $HOOKNAME[$htype];
457
458	my $ref = $pkg->can ("on_" . lc $name)
459	or next;
460
461	$TERM->{_hook}[$htype]{$pkg} = $ref;
462	$hook_count[$htype]++
463	or set_should_invoke $htype, 1;
464	}
465	}
466
467	my $extension_pkg = "extension0000";
468	my %extension_pkg;	894	my %extension_pkg;
469		895
470	# load a single script into its own package, once only	896	# load a single script into its own package, once only
471	sub extension_package($) {	897	sub extension_package($) {
472	my ($path) = @_;	898	my ($path) = @_;
473		899
474	$extension_pkg{$path} ||= do {	900	$extension_pkg{$path} ||= do {
475	my $pkg = "urxvt::" . ($extension_pkg++);	901	$path =~ /([^\/\\]+)$/;
		902	my $pkg = $1;
		903	$pkg =~ s/[^[:word:]]/_/g;
		904	$pkg = "urxvt::ext::$pkg";
476		905
477	verbose 3, "loading extension '$path' into package '$pkg'";	906	verbose 3, "loading extension '$path' into package '$pkg'";
478		907
479	open my $fh, "<:raw", $path	908	open my $fh, "<:raw", $path
480	or die "$path: $!";	909	or die "$path: $!";
481		910
482	my $source = untaint "package $pkg; use strict; use utf8;\n"	911	my $source =
483	. "use base urxvt::term::proxy::;\n"	912	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
484	. "#line 1 \"$path\"\n{\n"	913	. "#line 1 \"$path\"\n{\n"
485	. (do { local $/; <$fh> })	914	. (do { local $/; <$fh> })
486	. "\n};\n1";	915	. "\n};\n1";
487		916
		917	eval $source
488	eval $source or die "$path: $@";	918	or die "$path: $@";
489		919
490	$pkg	920	$pkg
491	}	921	}
492	}	922	}
493		923
…		…
498	local $TERM = shift;	928	local $TERM = shift;
499	my $htype = shift;	929	my $htype = shift;
500		930
501	if ($htype == 0) { # INIT	931	if ($htype == 0) { # INIT
502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		933
		934	my %ext_arg;
		935
503		936	{
504	my %want_ext;	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	}
505		944
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	945	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507	if ($_ eq "default") {	946	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	947	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
509	} elsif (/^-(.*)$/) {	948	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	949	delete $ext_arg{$1};
		950	} elsif (/^([^<]+)<(.*)>$/) {
		951	push @{ $ext_arg{$1} }, $2;
511	} else {	952	} else {
512	$want_ext{$_}++;	953	$ext_arg{$_} ||= [];
513	}	954	}
514	}	955	}
515		956
516	for my $ext (keys %want_ext) {	957	for my $ext (sort keys %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	958	my @files = grep -f $_, map "$_/$ext", @dirs;
518		959
519	if (@files) {	960	if (@files) {
520	register_package extension_package $files[0];	961	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
521	} else {	962	} else {
522	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";
523	}	964	}
524	}	965	}
525		966
…		…
531		972
532	if (my $cb = $TERM->{_hook}[$htype]) {	973	if (my $cb = $TERM->{_hook}[$htype]) {
533	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	974	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
534	if $verbosity >= 10;	975	if $verbosity >= 10;
535		976
536	keys %$cb;	977	for my $pkg (keys %$cb) {
		978	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
		979	$retval ||= $retval_;
537		980
538	while (my ($pkg, $cb) = each %$cb) {
539	eval {
540	$retval = $cb->(
541	$TERM->{_pkg}{$pkg} ||= do {
542	my $proxy = bless { }, $pkg;
543	Scalar::Util::weaken ($proxy->{term} = $TERM);
544	$proxy
545	},
546	@_,
547	) and last;
548	};
549	if ($@) {	981	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	982	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	983	warn $@;
552	}	984	}
553	}	985	}
		986
		987	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		988	if $verbosity >= 11;
554	}	989	}
555		990
556	if ($htype == 1) { # DESTROY	991	if ($htype == 1) { # DESTROY
557	# remove hooks if unused
558	if (my $hook = $TERM->{_hook}) {
559	for my $htype (0..$#$hook) {
560	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
561	or set_should_invoke $htype, 0;
562	}
563	}
564
565	# clear package objects	992	# clear package objects
566	%$_ = () for values %{ $TERM->{_pkg} };	993	%$_ = () for values %{ $TERM->{_pkg} };
567		994
568	# clear package	995	# clear package
569	%$TERM = ();	996	%$TERM = ();
570	}	997	}
571		998
572	$retval	999	$retval
573	}	1000	}
574		1001
575	# urxvt::term::proxy	1002	sub SET_COLOR($$$) {
		1003	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1004	}
576		1005
577	sub urxvt::term::proxy::AUTOLOAD {	1006	sub rend2mask {
578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	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;
		1025	}
		1026	}
		1027	}
		1028	($mask, @color{qw(fg bg)}, \@failed)
		1029	}
		1030
		1031	# urxvt::term::extension
		1032
		1033	package urxvt::term::extension;
		1034
		1035	sub enable {
		1036	my ($self, %hook) = @_;
		1037	my $pkg = $self->{_pkg};
		1038
		1039	while (my ($name, $cb) = each %hook) {
		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;
		1048	}
		1049	}
		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};
		1062	}
		1063	}
		1064
		1065	our $AUTOLOAD;
		1066
		1067	sub AUTOLOAD {
		1068	$AUTOLOAD =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	1069	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		1070
581	eval qq{	1071	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	1072	sub $AUTOLOAD {
583	my \$proxy = shift;	1073	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	1074	\$proxy->{term}->$1 (\@_)
585	}	1075	}
586	1	1076	1
587	} or die "FATAL: unable to compile method forwarder: $@";	1077	} or die "FATAL: unable to compile method forwarder: $@";
588		1078
589	goto &$urxvt::term::proxy::AUTOLOAD;	1079	goto &$AUTOLOAD;
590	}	1080	}
591		1081
592	sub urxvt::term::proxy::DESTROY {	1082	sub DESTROY {
593	# nop	1083	# nop
594	}	1084	}
595		1085
596	# urxvt::destroy_hook	1086	# urxvt::destroy_hook
597		1087
…		…
607		1097
608	=head2 The C<urxvt::anyevent> Class	1098	=head2 The C<urxvt::anyevent> Class
609		1099
610	The sole purpose of this class is to deliver an interface to the	1100	The sole purpose of this class is to deliver an interface to the
611	C<AnyEvent> module - any module using it will work inside urxvt without	1101	C<AnyEvent> module - any module using it will work inside urxvt without
612	further work. The only exception is that you cannot wait on condition	1102	further programming. The only exception is that you cannot wait on
613	variables, but non-blocking condvar use is ok. What this means is that you	1103	condition variables, but non-blocking condvar use is ok. What this means
614	cannot use blocking APIs, but the non-blocking variant should work.	1104	is that you cannot use blocking APIs, but the non-blocking variant should
		1105	work.
615		1106
616	=cut	1107	=cut
617		1108
618	our $VERSION = 1;	1109	our $VERSION = 1;
619		1110
…		…
655	sub DESTROY {	1146	sub DESTROY {
656	$_[0][1]->stop;	1147	$_[0][1]->stop;
657	}	1148	}
658		1149
659	sub condvar {	1150	sub condvar {
660	bless \my $flag, urxvt::anyevent::condvar::	1151	bless \my $flag, urxvt::anyevent::
661	}	1152	}
662		1153
663	sub urxvt::anyevent::condvar::broadcast {	1154	sub broadcast {
664	${$_[0]}++;	1155	${$_[0]}++;
665	}	1156	}
666		1157
667	sub urxvt::anyevent::condvar::wait {	1158	sub wait {
668	unless (${$_[0]}) {	1159	unless (${$_[0]}) {
669	require Carp;
670	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	1160	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
671	}	1161	}
672	}	1162	}
673		1163
		1164	sub one_event {
		1165	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
		1166	}
		1167
674	package urxvt::term;	1168	package urxvt::term;
675		1169
676	=head2 The C<urxvt::term> Class	1170	=head2 The C<urxvt::term> Class
677		1171
678	=over 4	1172	=over 4
679		1173
		1174	=cut
		1175
		1176	# find on_xxx subs in the package and register them
		1177	# as hooks
		1178	sub register_package {
		1179	my ($self, $pkg, $argv) = @_;
		1180
		1181	no strict 'refs';
		1182
		1183	urxvt::verbose 6, "register package $pkg to $self";
		1184
		1185	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1186
		1187	my $proxy = bless {
		1188	_pkg => $pkg,
		1189	argv => $argv,
		1190	}, $pkg;
		1191	Scalar::Util::weaken ($proxy->{term} = $self);
		1192
		1193	$self->{_pkg}{$pkg} = $proxy;
		1194
		1195	for my $name (@HOOKNAME) {
		1196	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1197	$proxy->enable ($name => $ref);
		1198	}
		1199	}
		1200	}
		1201
		1202	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1203
		1204	Creates a new terminal, very similar as if you had started it with system
		1205	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1206	hash which defines the environment of the new terminal.
		1207
		1208	Croaks (and probably outputs an error message) if the new instance
		1209	couldn't be created. Returns C<undef> if the new instance didn't
		1210	initialise perl, and the terminal object otherwise. The C<init> and
		1211	C<start> hooks will be called before this call returns, and are free to
		1212	refer to global data (which is race free).
		1213
		1214	=cut
		1215
		1216	sub new {
		1217	my ($class, $env, @args) = @_;
		1218
		1219	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1220	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1221
		1222	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1223	}
		1224
680	=item $term->destroy	1225	=item $term->destroy
681		1226
682	Destroy the terminal object (close the window, free resources etc.).	1227	Destroy the terminal object (close the window, free resources
		1228	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1229	watchers (timers, io watchers) are still active.
		1230
		1231	=item $term->exec_async ($cmd[, @args])
		1232
		1233	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1234	("starts") programs in the background. This function takes care of setting
		1235	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1236	be preferred over explicit calls to C<exec> or C<system>.
		1237
		1238	Returns the pid of the subprocess or C<undef> on error.
		1239
		1240	=cut
		1241
		1242	sub exec_async {
		1243	my $self = shift;
		1244
		1245	my $pid = fork;
		1246
		1247	return $pid
		1248	if !defined $pid or $pid;
		1249
		1250	%ENV = %{ $self->env };
		1251
		1252	exec @_;
		1253	urxvt::_exit 255;
		1254	}
683		1255
684	=item $isset = $term->option ($optval[, $set])	1256	=item $isset = $term->option ($optval[, $set])
685		1257
686	Returns true if the option specified by C<$optval> is enabled, and	1258	Returns true if the option specified by C<$optval> is enabled, and
687	optionally change it. All option values are stored by name in the hash	1259	optionally change it. All option values are stored by name in the hash
688	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1260	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
689		1261
690	Here is a a likely non-exhaustive list of option names, please see the	1262	Here is a likely non-exhaustive list of option names, please see the
691	source file F</src/optinc.h> to see the actual list:	1263	source file F</src/optinc.h> to see the actual list:
692		1264
693	borderLess console cursorBlink cursorUnderline hold iconic insecure	1265	borderLess console cursorBlink cursorUnderline hold iconic insecure
694	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1266	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
695	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1267	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
696	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1268	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
697	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1269	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
698	tripleclickwords utmpInhibit visualBell	1270	transparent tripleclickwords utmpInhibit visualBell
699		1271
700	=item $value = $term->resource ($name[, $newval])	1272	=item $value = $term->resource ($name[, $newval])
701		1273
702	Returns the current resource value associated with a given name and	1274	Returns the current resource value associated with a given name and
703	optionally sets a new value. Setting values is most useful in the C<init>	1275	optionally sets a new value. Setting values is most useful in the C<init>
…		…
712	likely change).	1284	likely change).
713		1285
714	Please note that resource strings will currently only be freed when the	1286	Please note that resource strings will currently only be freed when the
715	terminal is destroyed, so changing options frequently will eat memory.	1287	terminal is destroyed, so changing options frequently will eat memory.
716		1288
717	Here is a a likely non-exhaustive list of resource names, not all of which	1289	Here is a likely non-exhaustive list of resource names, not all of which
718	are supported in every build, please see the source file F</src/rsinc.h>	1290	are supported in every build, please see the source file F</src/rsinc.h>
719	to see the actual list:	1291	to see the actual list:
720		1292
721	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1293	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
722	borderLess color cursorBlink cursorUnderline cutchars delete_key	1294	borderLess color cursorBlink cursorUnderline cutchars delete_key
723	display_name embed ext_bwidth fade font geometry hold iconName	1295	display_name embed ext_bwidth fade font geometry hold iconName
724	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1296	imFont imLocale inputMethod insecure int_bwidth intensityStyles
725	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1297	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
726	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1298	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
727	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1299	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
728	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1300	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
729	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1301	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
730	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1302	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
731	shade term_name title transparent transparent_all tripleclickwords	1303	secondaryScreen secondaryScroll selectstyle shade term_name title
732	utmpInhibit visualBell	1304	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1305	visualBell
733		1306
734	=cut	1307	=cut
735		1308
736	sub resource($$;$) {	1309	sub resource($$;$) {
737	my ($self, $name) = (shift, shift);	1310	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1311	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	1312	&urxvt::term::_resource
740	}	1313	}
741		1314
		1315	=item $value = $term->x_resource ($pattern)
		1316
		1317	Returns the X-Resource for the given pattern, excluding the program or
		1318	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1319	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1320	resource with that pattern exists.
		1321
		1322	This method should only be called during the C<on_start> hook, as there is
		1323	only one resource database per display, and later invocations might return
		1324	the wrong resources.
		1325
		1326	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1327
		1328	Adds a keymap translation exactly as specified via a resource. See the
		1329	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1330
742	=item $rend = $term->rstyle ([$new_rstyle])	1331	=item $rend = $term->rstyle ([$new_rstyle])
743		1332
744	Return and optionally change the current rendition. Text that is output by	1333	Return and optionally change the current rendition. Text that is output by
745	the terminal application will use this style.	1334	the terminal application will use this style.
746		1335
…		…
756	=item ($row, $col) = $term->selection_end ([$row, $col])	1345	=item ($row, $col) = $term->selection_end ([$row, $col])
757		1346
758	Return the current values of the selection mark, begin or end positions,	1347	Return the current values of the selection mark, begin or end positions,
759	and optionally set them to new values.	1348	and optionally set them to new values.
760		1349
		1350	=item $term->selection_make ($eventtime[, $rectangular])
		1351
		1352	Tries to make a selection as set by C<selection_beg> and
		1353	C<selection_end>. If C<$rectangular> is true (default: false), a
		1354	rectangular selection will be made. This is the prefered function to make
		1355	a selection.
		1356
761	=item $success = $term->selection_grab ($eventtime)	1357	=item $success = $term->selection_grab ($eventtime)
762		1358
763	Try to request the primary selection from the server (for example, as set	1359	Try to request the primary selection text from the server (for example, as
764	by the next method).	1360	set by the next method). No visual feedback will be given. This function
		1361	is mostly useful from within C<on_sel_grab> hooks.
765		1362
766	=item $oldtext = $term->selection ([$newtext])	1363	=item $oldtext = $term->selection ([$newtext])
767		1364
768	Return the current selection text and optionally replace it by C<$newtext>.	1365	Return the current selection text and optionally replace it by C<$newtext>.
769		1366
770	#=item $term->overlay ($x, $y, $text)	1367	=item $term->overlay_simple ($x, $y, $text)
771	#	1368
772	#Create a simple multi-line overlay box. See the next method for details.	1369	Create a simple multi-line overlay box. See the next method for details.
773	#	1370
774	#=cut	1371	=cut
775	#	1372
776	#sub urxvt::term::scr_overlay {	1373	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	1374	my ($self, $x, $y, $text) = @_;
778	#	1375
779	# my @lines = split /\n/, $text;	1376	my @lines = split /\n/, $text;
780	#	1377
781	# my $w = 0;	1378	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	1379
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1380	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1381	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	1382
		1383	$overlay
		1384	}
789		1385
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1386	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		1387
792	Create a new (empty) overlay at the given position with the given	1388	Create a new (empty) overlay at the given position with the given
793	width/height. C<$rstyle> defines the initial rendition style	1389	width/height. C<$rstyle> defines the initial rendition style
…		…
860		1456
861	=item $string = $term->locale_decode ($octets)	1457	=item $string = $term->locale_decode ($octets)
862		1458
863	Convert the given locale-encoded octets into a perl string.	1459	Convert the given locale-encoded octets into a perl string.
864		1460
		1461	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1462
		1463	XORs the rendition values in the given span with the provided value
		1464	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1465	refresh hooks to provide effects similar to the selection.
		1466
		1467	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1468
		1469	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1470	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1471	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1472	it instead. Both styles I<MUST NOT> contain font styles.
		1473
		1474	=item $term->scr_bell
		1475
		1476	Ring the bell!
		1477
865	=item $term->scr_add_lines ($string)	1478	=item $term->scr_add_lines ($string)
866		1479
867	Write the given text string to the screen, as if output by the application	1480	Write the given text string to the screen, as if output by the application
868	running inside the terminal. It may not contain command sequences (escape	1481	running inside the terminal. It may not contain command sequences (escape
869	codes), but is free to use line feeds, carriage returns and tabs. The	1482	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
871		1484
872	Normally its not a good idea to use this function, as programs might be	1485	Normally its not a good idea to use this function, as programs might be
873	confused by changes in cursor position or scrolling. Its useful inside a	1486	confused by changes in cursor position or scrolling. Its useful inside a
874	C<on_add_lines> hook, though.	1487	C<on_add_lines> hook, though.
875		1488
		1489	=item $term->scr_change_screen ($screen)
		1490
		1491	Switch to given screen - 0 primary, 1 secondary.
		1492
876	=item $term->cmd_parse ($octets)	1493	=item $term->cmd_parse ($octets)
877		1494
878	Similar to C<scr_add_lines>, but the argument must be in the	1495	Similar to C<scr_add_lines>, but the argument must be in the
879	locale-specific encoding of the terminal and can contain command sequences	1496	locale-specific encoding of the terminal and can contain command sequences
880	(escape codes) that will be interpreted.	1497	(escape codes) that will be interpreted.
…		…
883		1500
884	Write the octets given in C<$data> to the tty (i.e. as program input). To	1501	Write the octets given in C<$data> to the tty (i.e. as program input). To
885	pass characters instead of octets, you should convert your strings first	1502	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	1503	to the locale-specific encoding using C<< $term->locale_encode >>.
887		1504
		1505	=item $old_events = $term->pty_ev_events ([$new_events])
		1506
		1507	Replaces the event mask of the pty watcher by the given event mask. Can
		1508	be used to suppress input and output handling to the pty/tty. See the
		1509	description of C<< urxvt::timer->events >>. Make sure to always restore
		1510	the previous value.
		1511
		1512	=item $fd = $term->pty_fd
		1513
		1514	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1515	is used.
		1516
888	=item $windowid = $term->parent	1517	=item $windowid = $term->parent
889		1518
890	Return the window id of the toplevel window.	1519	Return the window id of the toplevel window.
891		1520
892	=item $windowid = $term->vt	1521	=item $windowid = $term->vt
893		1522
894	Return the window id of the terminal window.	1523	Return the window id of the terminal window.
895		1524
		1525	=item $term->vt_emask_add ($x_event_mask)
		1526
		1527	Adds the specified events to the vt event mask. Useful e.g. when you want
		1528	to receive pointer events all the times:
		1529
		1530	$term->vt_emask_add (urxvt::PointerMotionMask);
		1531
		1532	=item $term->focus_in
		1533
		1534	=item $term->focus_out
		1535
		1536	=item $term->key_press ($state, $keycode[, $time])
		1537
		1538	=item $term->key_release ($state, $keycode[, $time])
		1539
		1540	Deliver various fake events to to terminal.
		1541
896	=item $window_width = $term->width	1542	=item $window_width = $term->width
897		1543
898	=item $window_height = $term->height	1544	=item $window_height = $term->height
899		1545
900	=item $font_width = $term->fwidth	1546	=item $font_width = $term->fwidth
…		…
913		1559
914	=item $max_scrollback = $term->saveLines	1560	=item $max_scrollback = $term->saveLines
915		1561
916	=item $nrow_plus_saveLines = $term->total_rows	1562	=item $nrow_plus_saveLines = $term->total_rows
917		1563
918	=item $lines_in_scrollback = $term->nsaved	1564	=item $topmost_scrollback_row = $term->top_row
919		1565
920	Return various integers describing terminal characteristics.	1566	Return various integers describing terminal characteristics.
		1567
		1568	=item $x_display = $term->display_id
		1569
		1570	Return the DISPLAY used by rxvt-unicode.
		1571
		1572	=item $lc_ctype = $term->locale
		1573
		1574	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1575
		1576	=item $env = $term->env
		1577
		1578	Returns a copy of the environment in effect for the terminal as a hashref
		1579	similar to C<\%ENV>.
		1580
		1581	=item @envv = $term->envv
		1582
		1583	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1584
		1585	=item @argv = $term->argv
		1586
		1587	Return the argument vector as this terminal, similar to @ARGV, but
		1588	includes the program name as first element.
		1589
		1590	=cut
		1591
		1592	sub env {
		1593	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1594	}
921		1595
922	=item $modifiermask = $term->ModLevel3Mask	1596	=item $modifiermask = $term->ModLevel3Mask
923		1597
924	=item $modifiermask = $term->ModMetaMask	1598	=item $modifiermask = $term->ModMetaMask
925		1599
926	=item $modifiermask = $term->ModNumLockMask	1600	=item $modifiermask = $term->ModNumLockMask
927		1601
928	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1602	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
929	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1603	AltGr), the meta key (often Alt) and the num lock key, if applicable.
930		1604
		1605	=item $screen = $term->current_screen
		1606
		1607	Returns the currently displayed screen (0 primary, 1 secondary).
		1608
		1609	=item $cursor_is_hidden = $term->hidden_cursor
		1610
		1611	Returns whether the cursor is currently hidden or not.
		1612
931	=item $view_start = $term->view_start ([$newvalue])	1613	=item $view_start = $term->view_start ([$newvalue])
932		1614
933	Returns the negative row number of the topmost line. Minimum value is	1615	Returns the row number of the topmost displayed line. Maximum value is
934	C<0>, which displays the normal terminal contents. Larger values scroll	1616	C<0>, which displays the normal terminal contents. Lower values scroll
935	this many lines into the scrollback buffer.	1617	this many lines into the scrollback buffer.
936		1618
937	=item $term->want_refresh	1619	=item $term->want_refresh
938		1620
939	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1621	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
954	line, starting at column C<$start_col> (default C<0>), which is useful	1636	line, starting at column C<$start_col> (default C<0>), which is useful
955	to replace only parts of a line. The font index in the rendition will	1637	to replace only parts of a line. The font index in the rendition will
956	automatically be updated.	1638	automatically be updated.
957		1639
958	C<$text> is in a special encoding: tabs and wide characters that use more	1640	C<$text> is in a special encoding: tabs and wide characters that use more
959	than one cell when displayed are padded with urxvt::NOCHAR characters	1641	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
960	(C<chr 65535>). Characters with combining characters and other characters	1642	characters. Characters with combining characters and other characters that
961	that do not fit into the normal tetx encoding will be replaced with	1643	do not fit into the normal tetx encoding will be replaced with characters
962	characters in the private use area.	1644	in the private use area.
963		1645
964	You have to obey this encoding when changing text. The advantage is	1646	You have to obey this encoding when changing text. The advantage is
965	that C<substr> and similar functions work on screen cells and not on	1647	that C<substr> and similar functions work on screen cells and not on
966	characters.	1648	characters.
967		1649
…		…
1018	Return the row number of the first/last row of the line, respectively.	1700	Return the row number of the first/last row of the line, respectively.
1019		1701
1020	=item $offset = $line->offset_of ($row, $col)	1702	=item $offset = $line->offset_of ($row, $col)
1021		1703
1022	Returns the character offset of the given row|col pair within the logical	1704	Returns the character offset of the given row|col pair within the logical
1023	line.	1705	line. Works for rows outside the line, too, and returns corresponding
		1706	offsets outside the string.
1024		1707
1025	=item ($row, $col) = $line->coord_of ($offset)	1708	=item ($row, $col) = $line->coord_of ($offset)
1026		1709
1027	Translates a string offset into terminal coordinates again.	1710	Translates a string offset into terminal coordinates again.
1028		1711
…		…
1110	where one character corresponds to one screen cell. See	1793	where one character corresponds to one screen cell. See
1111	C<< $term->ROW_t >> for details.	1794	C<< $term->ROW_t >> for details.
1112		1795
1113	=item $string = $term->special_decode $text	1796	=item $string = $term->special_decode $text
1114		1797
1115	Converts rxvt-unicodes text reprsentation into a perl string. See	1798	Converts rxvt-unicodes text representation into a perl string. See
1116	C<< $term->ROW_t >> for details.	1799	C<< $term->ROW_t >> for details.
1117		1800
1118	=item $success = $term->grab_button ($button, $modifiermask)	1801	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1119		1802
		1803	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1804
1120	Registers a synchronous button grab. See the XGrabButton manpage.	1805	Register/unregister a synchronous button grab. See the XGrabButton
		1806	manpage.
1121		1807
1122	=item $success = $term->grab ($eventtime[, $sync])	1808	=item $success = $term->grab ($eventtime[, $sync])
1123		1809
1124	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1810	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1125	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1811	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1126		1812
1127	=item $term->allow_events_async	1813	=item $term->allow_events_async
1128		1814
1129	Calls XAllowEvents with AsyncBoth for the most recent grab.	1815	Calls XAllowEvents with AsyncBoth for the most recent grab.
1130		1816
…		…
1141		1827
1142	Calls XUngrab for the most recent grab. Is called automatically on	1828	Calls XUngrab for the most recent grab. Is called automatically on
1143	evaluation errors, as it is better to lose the grab in the error case as	1829	evaluation errors, as it is better to lose the grab in the error case as
1144	the session.	1830	the session.
1145		1831
		1832	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1833
		1834	=item $atom_name = $term->XGetAtomName ($atom)
		1835
		1836	=item @atoms = $term->XListProperties ($window)
		1837
		1838	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1839
		1840	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1841
		1842	=item $term->XDeleteProperty ($window, $property)
		1843
		1844	=item $window = $term->DefaultRootWindow
		1845
		1846	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1847
		1848	=item $term->XMapWindow ($window)
		1849
		1850	=item $term->XUnmapWindow ($window)
		1851
		1852	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1853
		1854	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1855
		1856	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1857
		1858	Various X or X-related functions. The C<$term> object only serves as
		1859	the source of the display, otherwise those functions map more-or-less
		1860	directory onto the X functions of the same name.
		1861
1146	=back	1862	=back
1147		1863
1148	=cut	1864	=cut
1149		1865
1150	package urxvt::popup;	1866	package urxvt::popup;
…		…
1165	$item->{render} ||= sub { $_[0]{text} };	1881	$item->{render} ||= sub { $_[0]{text} };
1166		1882
1167	push @{ $self->{item} }, $item;	1883	push @{ $self->{item} }, $item;
1168	}	1884	}
1169		1885
		1886	=item $popup->add_title ($title)
		1887
		1888	Adds a non-clickable title to the popup.
		1889
		1890	=cut
		1891
		1892	sub add_title {
		1893	my ($self, $title) = @_;
		1894
		1895	$self->add_item ({
		1896	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1897	text => $title,
		1898	activate => sub { },
		1899	});
		1900	}
		1901
		1902	=item $popup->add_separator ([$sepchr])
		1903
		1904	Creates a separator, optionally using the character given as C<$sepchr>.
		1905
		1906	=cut
		1907
1170	sub add_separator {	1908	sub add_separator {
1171	my ($self, $sep) = @_;	1909	my ($self, $sep) = @_;
1172		1910
1173	$sep ||= "═";	1911	$sep ||= "=";
1174		1912
1175	$self->add_item ({	1913	$self->add_item ({
1176	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },	1914	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1177	text => "",	1915	text => "",
1178	render => sub { $sep x $self->{term}->ncol },	1916	render => sub { $sep x $self->{term}->ncol },
1179	activate => sub { },	1917	activate => sub { },
1180	});	1918	});
1181	}	1919	}
1182		1920
1183	sub add_title {	1921	=item $popup->add_button ($text, $cb)
1184	my ($self, $title) = @_;
1185		1922
1186	$self->add_item ({	1923	Adds a clickable button to the popup. C<$cb> is called whenever it is
1187	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1924	selected.
1188	text => $title,	1925
1189	activate => sub { },	1926	=cut
1190	});
1191	}
1192		1927
1193	sub add_button {	1928	sub add_button {
1194	my ($self, $text, $cb) = @_;	1929	my ($self, $text, $cb) = @_;
1195		1930
1196	$self->add_item ({ type => "button", text => $text, activate => $cb});	1931	$self->add_item ({ type => "button", text => $text, activate => $cb});
1197	}	1932	}
1198		1933
		1934	=item $popup->add_toggle ($text, $initial_value, $cb)
		1935
		1936	Adds a toggle/checkbox item to the popup. The callback gets called
		1937	whenever it gets toggled, with a boolean indicating its new value as its
		1938	first argument.
		1939
		1940	=cut
		1941
1199	sub add_toggle {	1942	sub add_toggle {
1200	my ($self, $text, $cb, $value) = @_;	1943	my ($self, $text, $value, $cb) = @_;
1201		1944
1202	my $item; $item = {	1945	my $item; $item = {
1203	type => "button",	1946	type => "button",
1204	text => " $text",	1947	text => " $text",
1205	value => $value,	1948	value => $value,
1206	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1949	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1207	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1950	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1208	};	1951	};
1209		1952
1210	$self->add_item ($item);	1953	$self->add_item ($item);
1211	}	1954	}
		1955
		1956	=item $popup->show
		1957
		1958	Displays the popup (which is initially hidden).
		1959
		1960	=cut
1212		1961
1213	sub show {	1962	sub show {
1214	my ($self) = @_;	1963	my ($self) = @_;
1215		1964
1216	local $urxvt::popup::self = $self;	1965	local $urxvt::popup::self = $self;
1217		1966
		1967	my $env = $self->{term}->env;
		1968	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1969	delete $env->{LC_ALL};
1218	local $ENV{LC_ALL} = $self->{term}->locale;	1970	$env->{LC_CTYPE} = $self->{term}->locale;
1219		1971
1220	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1972	urxvt::term->new ($env, "popup",
		1973	"--perl-lib" => "", "--perl-ext-common" => "",
		1974	"-pty-fd" => -1, "-sl" => 0,
		1975	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1221	"--transient-for" => $self->{term}->parent,	1976	"--transient-for" => $self->{term}->parent,
1222	"-display" => $self->{term}->display_id,	1977	"-display" => $self->{term}->display_id,
1223	"-pe" => "urxvt-popup")	1978	"-pe" => "urxvt-popup")
1224	or die "unable to create popup window\n";	1979	or die "unable to create popup window\n";
1225	}	1980	}
1226		1981
1227	sub DESTROY {	1982	sub DESTROY {
1228	my ($self) = @_;	1983	my ($self) = @_;
1229		1984
1230	delete $self->{term}{_destroy}{$self};	1985	delete $self->{term}{_destroy}{$self};
1231	$self->{term}->ungrab;	1986	$self->{term}->ungrab;
1232	}	1987	}
		1988
		1989	=back
		1990
		1991	=cut
		1992
		1993	package urxvt::watcher;
1233		1994
1234	=head2 The C<urxvt::timer> Class	1995	=head2 The C<urxvt::timer> Class
1235		1996
1236	This class implements timer watchers/events. Time is represented as a	1997	This class implements timer watchers/events. Time is represented as a
1237	fractional number of seconds since the epoch. Example:	1998	fractional number of seconds since the epoch. Example:
…		…
1241	->new	2002	->new
1242	->interval (1)	2003	->interval (1)
1243	->cb (sub {	2004	->cb (sub {
1244	$term->{overlay}->set (0, 0,	2005	$term->{overlay}->set (0, 0,
1245	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2006	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1246	});	2007	});
1247		2008
1248	=over 4	2009	=over 4
1249		2010
1250	=item $timer = new urxvt::timer	2011	=item $timer = new urxvt::timer
1251		2012
…		…
1275	Start the timer.	2036	Start the timer.
1276		2037
1277	=item $timer = $timer->start ($tstamp)	2038	=item $timer = $timer->start ($tstamp)
1278		2039
1279	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>.
1280		2045
1281	=item $timer = $timer->stop	2046	=item $timer = $timer->stop
1282		2047
1283	Stop the timer.	2048	Stop the timer.
1284		2049
…		…
1290		2055
1291	$term->{socket} = ...	2056	$term->{socket} = ...
1292	$term->{iow} = urxvt::iow	2057	$term->{iow} = urxvt::iow
1293	->new	2058	->new
1294	->fd (fileno $term->{socket})	2059	->fd (fileno $term->{socket})
1295	->events (1) # wait for read data	2060	->events (urxvt::EVENT_READ)
1296	->start	2061	->start
1297	->cb (sub {	2062	->cb (sub {
1298	my ($iow, $revents) = @_;	2063	my ($iow, $revents) = @_;
1299	# $revents must be 1 here, no need to check	2064	# $revents must be 1 here, no need to check
1300	sysread $term->{socket}, my $buf, 8192	2065	sysread $term->{socket}, my $buf, 8192
…		…
1313	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>
1314	is a bitset as described in the C<events> method.	2079	is a bitset as described in the C<events> method.
1315		2080
1316	=item $iow = $iow->fd ($fd)	2081	=item $iow = $iow->fd ($fd)
1317		2082
1318	Set the filedescriptor (not handle) to watch.	2083	Set the file descriptor (not handle) to watch.
1319		2084
1320	=item $iow = $iow->events ($eventmask)	2085	=item $iow = $iow->events ($eventmask)
1321		2086
1322	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
1323	data, Bit #1 (value C<2>) enables watching for write data.	2088	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		2089	together, or C<urxvt::EVENT_NONE>.
1324		2090
1325	=item $iow = $iow->start	2091	=item $iow = $iow->start
1326		2092
1327	Start watching for requested events on the given handle.	2093	Start watching for requested events on the given handle.
1328		2094
1329	=item $iow = $iow->stop	2095	=item $iow = $iow->stop
1330		2096
1331	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.
1332		2159
1333	=back	2160	=back
1334		2161
1335	=head1 ENVIRONMENT	2162	=head1 ENVIRONMENT
1336		2163
…		…
1343		2170
1344	=item == 0 - fatal messages	2171	=item == 0 - fatal messages
1345		2172
1346	=item >= 3 - script loading and management	2173	=item >= 3 - script loading and management
1347		2174
1348	=item >=10 - all events received	2175	=item >=10 - all called hooks
		2176
		2177	=item >=11 - hook return values
1349		2178
1350	=back	2179	=back
1351		2180
1352	=head1 AUTHOR	2181	=head1 AUTHOR
1353		2182
…		…
1355	http://software.schmorp.de/pkg/rxvt-unicode	2184	http://software.schmorp.de/pkg/rxvt-unicode
1356		2185
1357	=cut	2186	=cut
1358		2187
1359	1	2188	1
		2189
		2190	# vim: sw=3:

Diff Legend

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