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

Diff Legend

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