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.56 by root, Sun Jan 8 05:52:42 2006 UTC vs.
Revision 1.167 by root, Sun Jun 15 13:54:15 2008 UTC

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

Diff Legend

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