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.59 by root, Mon Jan 9 00:34:36 2006 UTC vs.
Revision 1.171 by root, Fri Oct 10 00:11:44 2008 UTC

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

Diff Legend

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