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

Diff Legend

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