[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.95 by elmex, Tue Jan 17 13:19:45 2006 UTC vs.
Revision 1.169 by root, Sun Jun 15 14:54: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	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. 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>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
58	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
59	...	66	...
60		67
61	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
64	between two vertical bars:	71	between two vertical bars:
65		72
66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	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: ^(/[^:]+):\
67		81
68	You can look at the source of the selection extension to see more	82	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
70		84
71	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
76		90
77	Rot-13 the selection when activated. Used via keyboard trigger:	91	Rot-13 the selection when activated. Used via keyboard trigger:
78		92
79	URxvt.keysym.C-M-r: perl:selection:rot13	93	URxvt.keysym.C-M-r: perl:selection:rot13
80		94
81	=item remote-pastebin
82
83	Upload the selection as textfile to a remote site.
84
85	URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87	To set the command to upload the file set this resource:
88
89	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92	md5 sum of the selection.
93	After an successful upload the selection will be replaced by the following url
94	(the % is the placeholder for the filename):
95
96	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
97
98	=back	95	=back
99		96
100	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
101		98
102	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
103	runtime.	100	runtime.
104		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
105	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
106		120
107	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
108	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
109	evalution, web-browser starting etc.), depending on content.	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	};
110		143
111	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
112		145
113	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
114	by a hotkey (default: C<M-s>). While in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
119	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
120	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
121	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
122	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
123	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
124	selection.	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.
125		189
126	=item selection-autotransform	190	=item selection-autotransform
127		191
128	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
129	whenever a selection is made.	193	whenever a selection is made.
…		…
142	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
143		207
144	And this example matches the same,but replaces it with vi-commands you can	208	And this example matches the same,but replaces it with vi-commands you can
145	paste directly into your (vi :) editor:	209	paste directly into your (vi :) editor:
146		210
147	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
148		212
149	Of course, this can be modified to suit your needs and your editor :)	213	Of course, this can be modified to suit your needs and your editor :)
150		214
151	To expand the example above to typical perl error messages ("XXX at	215	To expand the example above to typical perl error messages ("XXX at
152	FILENAME line YYY."), you need a slightly more elaborate solution:	216	FILENAME line YYY."), you need a slightly more elaborate solution:
153		217
154	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
155	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
156		220
157	The first line tells the selection code to treat the unchanging part of	221	The first line tells the selection code to treat the unchanging part of
158	every error message as a selection pattern, and the second line transforms	222	every error message as a selection pattern, and the second line transforms
159	the message into vi commands to load the file.	223	the message into vi commands to load the file.
160		224
161	=item mark-urls	225	=item tabbed
162		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
163	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
164	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
165	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
166	the URL as first argument.	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).
167		307
168	=item block-graphics-to-ascii	308	=item block-graphics-to-ascii
169		309
170	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
171	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
172	similar-looking ascii character.	312	similar-looking ascii character.
173		313
174	=item digital-clock	314	=item digital-clock
175		315
176	Displays a digital clock using the built-in overlay.	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.
177		371
178	=item example-refresh-hooks	372	=item example-refresh-hooks
179		373
180	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
181	window. Illustrates overwriting the refresh callbacks to create your own	375	window. Illustrates overwriting the refresh callbacks to create your own
…		…
221		415
222	=back	416	=back
223		417
224	=head2 Extension Objects	418	=head2 Extension Objects
225		419
226	Very perl extension is a perl class. A separate perl object is created	420	Every perl extension is a perl class. A separate perl object is created
227	for each terminal and each extension and passed as the first parameter to	421	for each terminal, and each terminal has its own set of extenion objects,
228	hooks. So extensions can use their C<$self> object without having to think	422	which are passed as the first parameter to hooks. So extensions can use
229	about other extensions, with the exception of methods and members that	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
230	begin with an underscore character C<_>: these are reserved for internal	425	that begin with an underscore character C<_>: these are reserved for
231	use.	426	internal use.
232		427
233	Although it isn't a C<urxvt::term> object, you can call all methods of the	428	Although it isn't a C<urxvt::term> object, you can call all methods of the
234	C<urxvt::term> class on this object.	429	C<urxvt::term> class on this object.
235		430
236	It has the following methods and data members:	431	It has the following methods and data members:
…		…
257	=head2 Hooks	452	=head2 Hooks
258		453
259	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
260	called whenever the relevant event happens.	455	called whenever the relevant event happens.
261		456
262	The first argument passed to them is an extension oject as described in	457	The first argument passed to them is an extension object as described in
263	the in the C<Extension Objects> section.	458	the in the C<Extension Objects> section.
264		459
265	B<All> of these hooks must return a boolean value. If it is true, then the	460	B<All> of these hooks must return a boolean value. If any of the called
266	event counts as being I<consumed>, and the invocation of other hooks is	461	hooks returns true, then the event counts as being I<consumed>, and the
267	skipped, 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.
268		463
269	I<< When in doubt, return a false value (preferably C<()>). >>	464	I<< When in doubt, return a false value (preferably C<()>). >>
270		465
271	=over 4	466	=over 4
272		467
273	=item on_init $term	468	=item on_init $term
274		469
275	Called after a new terminal object has been initialized, but before	470	Called after a new terminal object has been initialized, but before
276	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
277	call or deliver senseless data, as terminal size and other characteristics	472	call or deliver senseless data, as terminal size and other characteristics
278	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
279	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).
280		486
281	=item on_reset $term	487	=item on_reset $term
282		488
283	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
284	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
285	variables.	491	variables.
286		492
287	=item on_start $term	493	=item on_child_start $term, $pid
288		494
289	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.
290	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>.
291		501
292	=item on_sel_make $term, $eventtime	502	=item on_sel_make $term, $eventtime
293		503
294	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
295	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
…		…
302		512
303	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
304	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
305	by calling C<< $term->selection >>.	515	by calling C<< $term->selection >>.
306		516
307	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.
308		518
309	=item on_sel_extend $term	519	=item on_sel_extend $term
310		520
311	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
312	click) and is either supposed to return false (normal operation), or	522	click) and is either supposed to return false (normal operation), or
313	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
314	processing. This can happen multiple times, as long as the callback	524	processing. This can happen multiple times, as long as the callback
315	returns true, it will be called on every further click by the user and is	525	returns true, it will be called on every further click by the user and is
316	supposed to enlarge the selection more and more, if possible.	526	supposed to enlarge the selection more and more, if possible.
317		527
318	See the F<selection> example extension.	528	See the F<selection> example extension.
319		529
320	=item on_view_change $term, $offset	530	=item on_view_change $term, $offset
321		531
322	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
323	scrolls. Offset C<0> means display the normal terminal, positive values	533	scrolls. Offset C<0> means display the normal terminal, positive values
324	show this many lines of scrollback.	534	show this many lines of scrollback.
325		535
326	=item on_scroll_back $term, $lines, $saved	536	=item on_scroll_back $term, $lines, $saved
327		537
…		…
331		541
332	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,
333	$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
334	number of lines that will be in the scrollback buffer.	544	number of lines that will be in the scrollback buffer.
335		545
		546	=item on_osc_seq $term, $op, $args
		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
336	=item on_osc_seq $term, $string	556	=item on_osc_seq_perl $term, $string
337		557
338	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
339	operating system command) is processed. Cursor position and other state	559	operating system command) is processed. Cursor position and other state
340	information is up-to-date when this happens. For interoperability, the	560	information is up-to-date when this happens. For interoperability, the
341	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
342	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
343	future.	563	future.
344		564
345	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,
346	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
347	other users on the same system etc.).	567	other users on the same system etc.).
348		568
349	=item on_add_lines $term, $string	569	=item on_add_lines $term, $string
350		570
351	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
…		…
382		602
383	=item on_refresh_end $term	603	=item on_refresh_end $term
384		604
385	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>.
386		606
387	=item on_keyboard_command $term, $string	607	=item on_user_command $term, $string
388		608
389	Called whenever the user presses a key combination that has a	609	Called whenever a user-configured event is being activated (e.g. via
390	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>
391	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.
392		621
393	=item on_x_event $term, $event	622	=item on_x_event $term, $event
394		623
395	Called on every X event received on the vt window (and possibly other	624	Called on every X event received on the vt window (and possibly other
396	windows). Should only be used as a last resort. Most event structure	625	windows). Should only be used as a last resort. Most event structure
397	members are not passed.	626	members are not passed.
398		627
		628	=item on_root_event $term, $event
		629
		630	Like C<on_x_event>, but is called for events on the root window.
		631
399	=item on_focus_in $term	632	=item on_focus_in $term
400		633
401	Called whenever the window gets the keyboard focus, before rxvt-unicode	634	Called whenever the window gets the keyboard focus, before rxvt-unicode
402	does focus in processing.	635	does focus in processing.
403		636
404	=item on_focus_out $term	637	=item on_focus_out $term
405		638
406	Called wheneever the window loses keyboard focus, before rxvt-unicode does	639	Called whenever the window loses keyboard focus, before rxvt-unicode does
407	focus out processing.	640	focus out processing.
		641
		642	=item on_configure_notify $term, $event
		643
		644	=item on_property_notify $term, $event
408		645
409	=item on_key_press $term, $event, $keysym, $octets	646	=item on_key_press $term, $event, $keysym, $octets
410		647
411	=item on_key_release $term, $event, $keysym	648	=item on_key_release $term, $event, $keysym
412		649
…		…
422		659
423	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
424	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.
425		662
426	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
427	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
428	and column under the mouse cursor.	665	(real, not screen-based) row and column under the mouse cursor.
429		666
430	C<on_key_press> additionally receives the string rxvt-unicode would	667	C<on_key_press> additionally receives the string rxvt-unicode would
431	output, if any, in locale-specific encoding.	668	output, if any, in locale-specific encoding.
432		669
433	subwindow.	670	subwindow.
		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).
434		680
435	=back	681	=back
436		682
437	=cut	683	=cut
438		684
…		…
444	use Scalar::Util ();	690	use Scalar::Util ();
445	use List::Util ();	691	use List::Util ();
446		692
447	our $VERSION = 1;	693	our $VERSION = 1;
448	our $TERM;	694	our $TERM;
		695	our @TERM_INIT;
		696	our @TERM_EXT;
449	our @HOOKNAME;	697	our @HOOKNAME;
450	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	698	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451	our %OPTION;	699	our %OPTION;
452		700
453	our $LIBDIR;	701	our $LIBDIR;
454	our $RESNAME;	702	our $RESNAME;
455	our $RESCLASS;	703	our $RESCLASS;
456	our $RXVTNAME;	704	our $RXVTNAME;
457		705
		706	our $NOCHAR = chr 0xffff;
		707
458	=head2 Variables in the C<urxvt> Package	708	=head2 Variables in the C<urxvt> Package
459		709
460	=over 4	710	=over 4
461		711
462	=item $urxvt::LIBDIR	712	=item $urxvt::LIBDIR
…		…
474		724
475	=item $urxvt::TERM	725	=item $urxvt::TERM
476		726
477	The current terminal. This variable stores the current C<urxvt::term>	727	The current terminal. This variable stores the current C<urxvt::term>
478	object, whenever a callback/hook is executing.	728	object, whenever a callback/hook is executing.
		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>.
479		745
480	=back	746	=back
481		747
482	=head2 Functions in the C<urxvt> Package	748	=head2 Functions in the C<urxvt> Package
483		749
…		…
498	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
499	correct place, e.g. on stderr of the connecting urxvtc client.	765	correct place, e.g. on stderr of the connecting urxvtc client.
500		766
501	Messages have a size limit of 1023 bytes currently.	767	Messages have a size limit of 1023 bytes currently.
502		768
503	=item $is_safe = urxvt::safe	769	=item @terms = urxvt::termlist
504		770
505	Returns true when it is safe to do potentially unsafe things, such as	771	Returns all urxvt::term objects that exist in this process, regardless of
506	evaluating perl code specified by the user. This is true when urxvt was	772	whether they are started, being destroyed etc., so be careful. Only term
507	started setuid or setgid.	773	objects that have perl extensions attached will be returned (because there
		774	is no urxvt::term objet associated with others).
508		775
509	=item $time = urxvt::NOW	776	=item $time = urxvt::NOW
510		777
511	Returns the "current time" (as per the event loop).	778	Returns the "current time" (as per the event loop).
512		779
…		…
571		838
572	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	839	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
573		840
574	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	841	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
575		842
		843	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		844
576	Replace the foreground/background colour in the rendition mask with the	845	Replace the foreground/background colour in the rendition mask with the
577	specified one.	846	specified one.
578		847
579	=item $value = urxvt::GET_CUSTOM $rend	848	=item $value = urxvt::GET_CUSTOM $rend
580		849
…		…
589	=back	858	=back
590		859
591	=cut	860	=cut
592		861
593	BEGIN {	862	BEGIN {
594	urxvt->bootstrap;
595
596	# overwrite perl's warn	863	# overwrite perl's warn
597	*CORE::GLOBAL::warn = sub {	864	*CORE::GLOBAL::warn = sub {
598	my $msg = join "", @_;	865	my $msg = join "", @_;
599	$msg .= "\n"	866	$msg .= "\n"
600	unless $msg =~ /\n$/;	867	unless $msg =~ /\n$/;
601	urxvt::warn ($msg);	868	urxvt::warn ($msg);
602	};	869	};
603
604	# %ENV is the original startup environment
605	delete $ENV{IFS};
606	delete $ENV{CDPATH};
607	delete $ENV{BASH_ENV};
608	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
609	}	870	}
		871
		872	no warnings 'utf8';
610		873
611	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	874	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
612		875
613	sub verbose {	876	sub verbose {
614	my ($level, $msg) = @_;	877	my ($level, $msg) = @_;
615	warn "$msg\n" if $level <= $verbosity;	878	warn "$msg\n" if $level <= $verbosity;
616	}	879	}
617		880
618	my $extension_pkg = "extension0000";
619	my %extension_pkg;	881	my %extension_pkg;
620		882
621	# load a single script into its own package, once only	883	# load a single script into its own package, once only
622	sub extension_package($) {	884	sub extension_package($) {
623	my ($path) = @_;	885	my ($path) = @_;
624		886
625	$extension_pkg{$path} \|\|= do {	887	$extension_pkg{$path} \|\|= do {
626	my $pkg = "urxvt::" . ($extension_pkg++);	888	$path =~ /([^\/\\]+)$/;
		889	my $pkg = $1;
		890	$pkg =~ s/[^[:word:]]/_/g;
		891	$pkg = "urxvt::ext::$pkg";
627		892
628	verbose 3, "loading extension '$path' into package '$pkg'";	893	verbose 3, "loading extension '$path' into package '$pkg'";
629		894
630	open my $fh, "<:raw", $path	895	open my $fh, "<:raw", $path
631	or die "$path: $!";	896	or die "$path: $!";
632		897
633	my $source = untaint	898	my $source =
634	"package $pkg; use strict; use utf8;\n"	899	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
635	. "use base urxvt::term::extension::;\n"
636	. "#line 1 \"$path\"\n{\n"	900	. "#line 1 \"$path\"\n{\n"
637	. (do { local $/; <$fh> })	901	. (do { local $/; <$fh> })
638	. "\n};\n1";	902	. "\n};\n1";
639		903
640	eval $source	904	eval $source
…		…
651	local $TERM = shift;	915	local $TERM = shift;
652	my $htype = shift;	916	my $htype = shift;
653		917
654	if ($htype == 0) { # INIT	918	if ($htype == 0) { # INIT
655	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	919	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
656		920
657	my %ext_arg;	921	my %ext_arg;
658		922
		923	{
		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	}
		931
659	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	932	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
660	if ($_ eq "default") {	933	if ($_ eq "default") {
661	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	934	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
662	} elsif (/^-(.*)$/) {	935	} elsif (/^-(.*)$/) {
663	delete $ext_arg{$1};	936	delete $ext_arg{$1};
664	} elsif (/^([^<]+)<(.*)>$/) {	937	} elsif (/^([^<]+)<(.*)>$/) {
665	push @{ $ext_arg{$1} }, $2;	938	push @{ $ext_arg{$1} }, $2;
666	} else {	939	} else {
667	$ext_arg{$_} \|\|= [];	940	$ext_arg{$_} \|\|= [];
668	}	941	}
669	}	942	}
670		943
671	while (my ($ext, $argv) = each %ext_arg) {	944	for my $ext (sort keys %ext_arg) {
672	my @files = grep -f $_, map "$_/$ext", @dirs;	945	my @files = grep -f $_, map "$_/$ext", @dirs;
673		946
674	if (@files) {	947	if (@files) {
675	$TERM->register_package (extension_package $files[0], $argv);	948	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
676	} else {	949	} else {
677	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";
678	}	951	}
679	}	952	}
680		953
…		…
686		959
687	if (my $cb = $TERM->{_hook}[$htype]) {	960	if (my $cb = $TERM->{_hook}[$htype]) {
688	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	961	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
689	if $verbosity >= 10;	962	if $verbosity >= 10;
690		963
691	keys %$cb;	964	for my $pkg (keys %$cb) {
692
693	while (my ($pkg, $cb) = each %$cb) {
694	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	965	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
695	and last;	966	$retval \|\|= $retval_;
696		967
697	if ($@) {	968	if ($@) {
698	$TERM->ungrab; # better to lose the grab than the session	969	$TERM->ungrab; # better to lose the grab than the session
699	warn $@;	970	warn $@;
700	}	971	}
…		…
713	}	984	}
714		985
715	$retval	986	$retval
716	}	987	}
717		988
718	sub exec_async(@) {	989	sub SET_COLOR($$$) {
719	my $pid = fork;	990	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		991	}
720		992
721	return	993	sub rend2mask {
722	if !defined $pid or $pid;	994	no strict 'refs';
723		995	my ($str, $mask) = (@_, 0);
724	%ENV = %{ $TERM->env };	996	my %color = ( fg => undef, bg => undef );
725		997	my @failed;
726	exec @_;	998	for my $spec ( split /\s+/, $str ) {
727	_exit 255;	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)
728	}	1016	}
729		1017
730	# urxvt::term::extension	1018	# urxvt::term::extension
731		1019
732	package urxvt::term::extension;	1020	package urxvt::term::extension;
…		…
803	is that you cannot use blocking APIs, but the non-blocking variant should	1091	is that you cannot use blocking APIs, but the non-blocking variant should
804	work.	1092	work.
805		1093
806	=cut	1094	=cut
807		1095
808	our $VERSION = 1;	1096	our $VERSION = '3.4';
809		1097
810	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1098	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
811	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1099	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
812		1100
813	sub timer {	1101	sub timer {
…		…
844		1132
845	sub DESTROY {	1133	sub DESTROY {
846	$_[0][1]->stop;	1134	$_[0][1]->stop;
847	}	1135	}
848		1136
849	sub condvar {	1137	sub one_event {
850	bless \my $flag, urxvt::anyevent::condvar::
851	}
852
853	sub urxvt::anyevent::condvar::broadcast {
854	${$_[0]}++;
855	}
856
857	sub urxvt::anyevent::condvar::wait {
858	unless (${$_[0]}) {
859	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";
860	}
861	}	1139	}
862		1140
863	package urxvt::term;	1141	package urxvt::term;
864		1142
865	=head2 The C<urxvt::term> Class	1143	=head2 The C<urxvt::term> Class
…		…
870		1148
871	# find on_xxx subs in the package and register them	1149	# find on_xxx subs in the package and register them
872	# as hooks	1150	# as hooks
873	sub register_package {	1151	sub register_package {
874	my ($self, $pkg, $argv) = @_;	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::;
875		1159
876	my $proxy = bless {	1160	my $proxy = bless {
877	_pkg => $pkg,	1161	_pkg => $pkg,
878	argv => $argv,	1162	argv => $argv,
879	}, $pkg;	1163	}, $pkg;
…		…
895	hash which defines the environment of the new terminal.	1179	hash which defines the environment of the new terminal.
896		1180
897	Croaks (and probably outputs an error message) if the new instance	1181	Croaks (and probably outputs an error message) if the new instance
898	couldn't be created. Returns C<undef> if the new instance didn't	1182	couldn't be created. Returns C<undef> if the new instance didn't
899	initialise perl, and the terminal object otherwise. The C<init> and	1183	initialise perl, and the terminal object otherwise. The C<init> and
900	C<start> hooks will be called during this call.	1184	C<start> hooks will be called before this call returns, and are free to
		1185	refer to global data (which is race free).
901		1186
902	=cut	1187	=cut
903		1188
904	sub new {	1189	sub new {
905	my ($class, $env, @args) = @_;	1190	my ($class, $env, @args) = @_;
906		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
907	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1195	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
908	}	1196	}
909		1197
910	=item $term->destroy	1198	=item $term->destroy
911		1199
912	Destroy the terminal object (close the window, free resources	1200	Destroy the terminal object (close the window, free resources
913	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1201	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
914	watchers (timers, io watchers) are still active.	1202	watchers (timers, io watchers) are still active.
915		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	}
		1228
916	=item $isset = $term->option ($optval[, $set])	1229	=item $isset = $term->option ($optval[, $set])
917		1230
918	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
919	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
920	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.
921		1234
922	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
923	source file F</src/optinc.h> to see the actual list:	1236	source file F</src/optinc.h> to see the actual list:
924		1237
925	borderLess console cursorBlink cursorUnderline hold iconic insecure	1238	borderLess console cursorBlink cursorUnderline hold iconic insecure
926	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1239	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
927	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1240	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
928	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1241	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
929	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1242	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
930	tripleclickwords utmpInhibit visualBell	1243	transparent tripleclickwords utmpInhibit visualBell
931		1244
932	=item $value = $term->resource ($name[, $newval])	1245	=item $value = $term->resource ($name[, $newval])
933		1246
934	Returns the current resource value associated with a given name and	1247	Returns the current resource value associated with a given name and
935	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>
…		…
944	likely change).	1257	likely change).
945		1258
946	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
947	terminal is destroyed, so changing options frequently will eat memory.	1260	terminal is destroyed, so changing options frequently will eat memory.
948		1261
949	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
950	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>
951	to see the actual list:	1264	to see the actual list:
952		1265
953	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1266	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
954	borderLess color cursorBlink cursorUnderline cutchars delete_key	1267	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
955	display_name embed ext_bwidth fade font geometry hold iconName	1268	display_name embed ext_bwidth fade font geometry hold iconName
956	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1269	imFont imLocale inputMethod insecure int_bwidth intensityStyles
957	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1270	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
958	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1271	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
959	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1272	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
960	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1273	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
961	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1274	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
962	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1275	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
963	shade term_name title transparent transparent_all tripleclickwords	1276	secondaryScreen secondaryScroll shade term_name title
964	utmpInhibit visualBell	1277	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1278	visualBell
965		1279
966	=cut	1280	=cut
967		1281
968	sub resource($$;$) {	1282	sub resource($$;$) {
969	my ($self, $name) = (shift, shift);	1283	my ($self, $name) = (shift, shift);
970	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1284	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
971	&urxvt::term::_resource	1285	goto &urxvt::term::_resource
972	}	1286	}
973		1287
974	=item $value = $term->x_resource ($pattern)	1288	=item $value = $term->x_resource ($pattern)
975		1289
976	Returns the X-Resource for the given pattern, excluding the program or	1290	Returns the X-Resource for the given pattern, excluding the program or
…		…
1143		1457
1144	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
1145	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
1146	C<on_add_lines> hook, though.	1460	C<on_add_lines> hook, though.
1147		1461
		1462	=item $term->scr_change_screen ($screen)
		1463
		1464	Switch to given screen - 0 primary, 1 secondary.
		1465
1148	=item $term->cmd_parse ($octets)	1466	=item $term->cmd_parse ($octets)
1149		1467
1150	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
1151	locale-specific encoding of the terminal and can contain command sequences	1469	locale-specific encoding of the terminal and can contain command sequences
1152	(escape codes) that will be interpreted.	1470	(escape codes) that will be interpreted.
…		…
1162	Replaces the event mask of the pty watcher by the given event mask. Can	1480	Replaces the event mask of the pty watcher by the given event mask. Can
1163	be used to suppress input and output handling to the pty/tty. See the	1481	be used to suppress input and output handling to the pty/tty. See the
1164	description of C<< urxvt::timer->events >>. Make sure to always restore	1482	description of C<< urxvt::timer->events >>. Make sure to always restore
1165	the previous value.	1483	the previous value.
1166		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
1167	=item $windowid = $term->parent	1490	=item $windowid = $term->parent
1168		1491
1169	Return the window id of the toplevel window.	1492	Return the window id of the toplevel window.
1170		1493
1171	=item $windowid = $term->vt	1494	=item $windowid = $term->vt
…		…
1177	Adds the specified events to the vt event mask. Useful e.g. when you want	1500	Adds the specified events to the vt event mask. Useful e.g. when you want
1178	to receive pointer events all the times:	1501	to receive pointer events all the times:
1179		1502
1180	$term->vt_emask_add (urxvt::PointerMotionMask);	1503	$term->vt_emask_add (urxvt::PointerMotionMask);
1181		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
1182	=item $window_width = $term->width	1515	=item $window_width = $term->width
1183		1516
1184	=item $window_height = $term->height	1517	=item $window_height = $term->height
1185		1518
1186	=item $font_width = $term->fwidth	1519	=item $font_width = $term->fwidth
…		…
1216	=item $env = $term->env	1549	=item $env = $term->env
1217		1550
1218	Returns a copy of the environment in effect for the terminal as a hashref	1551	Returns a copy of the environment in effect for the terminal as a hashref
1219	similar to C<\%ENV>.	1552	similar to C<\%ENV>.
1220		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
1221	=cut	1563	=cut
1222		1564
1223	sub env {	1565	sub env {
1224	if (my $env = $_[0]->_env) {
1225	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1566	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1226	} else {
1227	+{ %ENV }
1228	}
1229	}	1567	}
1230		1568
1231	=item $modifiermask = $term->ModLevel3Mask	1569	=item $modifiermask = $term->ModLevel3Mask
1232		1570
1233	=item $modifiermask = $term->ModMetaMask	1571	=item $modifiermask = $term->ModMetaMask
1234		1572
1235	=item $modifiermask = $term->ModNumLockMask	1573	=item $modifiermask = $term->ModNumLockMask
1236		1574
1237	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
1238	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.
		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.
1239		1585
1240	=item $view_start = $term->view_start ([$newvalue])	1586	=item $view_start = $term->view_start ([$newvalue])
1241		1587
1242	Returns the row number of the topmost displayed line. Maximum value is	1588	Returns the row number of the topmost displayed line. Maximum value is
1243	C<0>, which displays the normal terminal contents. Lower values scroll	1589	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1251		1597
1252	Used after changing terminal contents to display them.	1598	Used after changing terminal contents to display them.
1253		1599
1254	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1600	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1255		1601
1256	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 >>
1257	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
1258	terminal line. The scrollback buffer starts at line C<-1> and extends to
1259	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1604	terminal line. Nothing will be returned if a nonexistent line
1260	is requested.	1605	is requested.
1261		1606
1262	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
1263	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
1264	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
1265	automatically be updated.	1610	automatically be updated.
1266		1611
1267	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
1268	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)
1269	(C<chr 65535>). Characters with combining characters and other characters	1614	characters. Characters with combining characters and other characters that
1270	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
1271	characters in the private use area.	1616	in the private use area.
1272		1617
1273	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
1274	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
1275	characters.	1620	characters.
1276		1621
…		…
1420	where one character corresponds to one screen cell. See	1765	where one character corresponds to one screen cell. See
1421	C<< $term->ROW_t >> for details.	1766	C<< $term->ROW_t >> for details.
1422		1767
1423	=item $string = $term->special_decode $text	1768	=item $string = $term->special_decode $text
1424		1769
1425	Converts rxvt-unicodes text reprsentation into a perl string. See	1770	Converts rxvt-unicodes text representation into a perl string. See
1426	C<< $term->ROW_t >> for details.	1771	C<< $term->ROW_t >> for details.
1427		1772
1428	=item $success = $term->grab_button ($button, $modifiermask)	1773	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1429		1774
		1775	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1776
1430	Registers a synchronous button grab. See the XGrabButton manpage.	1777	Register/unregister a synchronous button grab. See the XGrabButton
		1778	manpage.
1431		1779
1432	=item $success = $term->grab ($eventtime[, $sync])	1780	=item $success = $term->grab ($eventtime[, $sync])
1433		1781
1434	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1782	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1435	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1783	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1436		1784
1437	=item $term->allow_events_async	1785	=item $term->allow_events_async
1438		1786
1439	Calls XAllowEvents with AsyncBoth for the most recent grab.	1787	Calls XAllowEvents with AsyncBoth for the most recent grab.
1440		1788
…		…
1450	=item $term->ungrab	1798	=item $term->ungrab
1451		1799
1452	Calls XUngrab for the most recent grab. Is called automatically on	1800	Calls XUngrab for the most recent grab. Is called automatically on
1453	evaluation errors, as it is better to lose the grab in the error case as	1801	evaluation errors, as it is better to lose the grab in the error case as
1454	the session.	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->XChangeProperty ($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.
1455		1833
1456	=back	1834	=back
1457		1835
1458	=cut	1836	=cut
1459		1837
…		…
1523	my ($self, $text, $cb) = @_;	1901	my ($self, $text, $cb) = @_;
1524		1902
1525	$self->add_item ({ type => "button", text => $text, activate => $cb});	1903	$self->add_item ({ type => "button", text => $text, activate => $cb});
1526	}	1904	}
1527		1905
1528	=item $popup->add_toggle ($text, $cb, $initial_value)	1906	=item $popup->add_toggle ($text, $initial_value, $cb)
1529		1907
1530	Adds a toggle/checkbox item to the popup. Teh callback gets called	1908	Adds a toggle/checkbox item to the popup. The callback gets called
1531	whenever it gets toggled, with a boolean indicating its value as its first	1909	whenever it gets toggled, with a boolean indicating its new value as its
1532	argument.	1910	first argument.
1533		1911
1534	=cut	1912	=cut
1535		1913
1536	sub add_toggle {	1914	sub add_toggle {
1537	my ($self, $text, $cb, $value) = @_;	1915	my ($self, $text, $value, $cb) = @_;
1538		1916
1539	my $item; $item = {	1917	my $item; $item = {
1540	type => "button",	1918	type => "button",
1541	text => " $text",	1919	text => " $text",
1542	value => $value,	1920	value => $value,
…		…
1561	my $env = $self->{term}->env;	1939	my $env = $self->{term}->env;
1562	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1940	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1563	delete $env->{LC_ALL};	1941	delete $env->{LC_ALL};
1564	$env->{LC_CTYPE} = $self->{term}->locale;	1942	$env->{LC_CTYPE} = $self->{term}->locale;
1565		1943
1566	urxvt::term->new ($env, $self->{term}->resource ("name"),	1944	my $term = urxvt::term->new (
1567	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1945	$env, "popup",
		1946	"--perl-lib" => "", "--perl-ext-common" => "",
		1947	"-pty-fd" => -1, "-sl" => 0,
		1948	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1568	"--transient-for" => $self->{term}->parent,	1949	"--transient-for" => $self->{term}->parent,
1569	"-display" => $self->{term}->display_id,	1950	"-display" => $self->{term}->display_id,
1570	"-pe" => "urxvt-popup")	1951	"-pe" => "urxvt-popup",
1571	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	}
1572	}	1959	}
1573		1960
1574	sub DESTROY {	1961	sub DESTROY {
1575	my ($self) = @_;	1962	my ($self) = @_;
1576		1963
1577	delete $self->{term}{_destroy}{$self};	1964	delete $self->{term}{_destroy}{$self};
1578	$self->{term}->ungrab;	1965	$self->{term}->ungrab;
1579	}	1966	}
1580		1967
1581	=back	1968	=back
		1969
		1970	=cut
		1971
		1972	package urxvt::watcher;
1582		1973
1583	=head2 The C<urxvt::timer> Class	1974	=head2 The C<urxvt::timer> Class
1584		1975
1585	This class implements timer watchers/events. Time is represented as a	1976	This class implements timer watchers/events. Time is represented as a
1586	fractional number of seconds since the epoch. Example:	1977	fractional number of seconds since the epoch. Example:
…		…
1590	->new	1981	->new
1591	->interval (1)	1982	->interval (1)
1592	->cb (sub {	1983	->cb (sub {
1593	$term->{overlay}->set (0, 0,	1984	$term->{overlay}->set (0, 0,
1594	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1985	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1595	});	1986	});
1596		1987
1597	=over 4	1988	=over 4
1598		1989
1599	=item $timer = new urxvt::timer	1990	=item $timer = new urxvt::timer
1600		1991
…		…
1624	Start the timer.	2015	Start the timer.
1625		2016
1626	=item $timer = $timer->start ($tstamp)	2017	=item $timer = $timer->start ($tstamp)
1627		2018
1628	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>.
1629		2024
1630	=item $timer = $timer->stop	2025	=item $timer = $timer->stop
1631		2026
1632	Stop the timer.	2027	Stop the timer.
1633		2028
…		…
1639		2034
1640	$term->{socket} = ...	2035	$term->{socket} = ...
1641	$term->{iow} = urxvt::iow	2036	$term->{iow} = urxvt::iow
1642	->new	2037	->new
1643	->fd (fileno $term->{socket})	2038	->fd (fileno $term->{socket})
1644	->events (urxvt::EVENT_READ)	2039	->events (urxvt::EV_READ)
1645	->start	2040	->start
1646	->cb (sub {	2041	->cb (sub {
1647	my ($iow, $revents) = @_;	2042	my ($iow, $revents) = @_;
1648	# $revents must be 1 here, no need to check	2043	# $revents must be 1 here, no need to check
1649	sysread $term->{socket}, my $buf, 8192	2044	sysread $term->{socket}, my $buf, 8192
…		…
1662	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>
1663	is a bitset as described in the C<events> method.	2058	is a bitset as described in the C<events> method.
1664		2059
1665	=item $iow = $iow->fd ($fd)	2060	=item $iow = $iow->fd ($fd)
1666		2061
1667	Set the filedescriptor (not handle) to watch.	2062	Set the file descriptor (not handle) to watch.
1668		2063
1669	=item $iow = $iow->events ($eventmask)	2064	=item $iow = $iow->events ($eventmask)
1670		2065
1671	Set the event mask to watch. The only allowed values are	2066	Set the event mask to watch. The only allowed values are
1672	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2067	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1673	together, or C<urxvt::EVENT_NONE>.	2068	together, or C<urxvt::EV_NONE>.
1674		2069
1675	=item $iow = $iow->start	2070	=item $iow = $iow->start
1676		2071
1677	Start watching for requested events on the given handle.	2072	Start watching for requested events on the given handle.
1678		2073
1679	=item $iow = $iow->stop	2074	=item $iow = $iow->stop
1680		2075
1681	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.
1682		2138
1683	=back	2139	=back
1684		2140
1685	=head1 ENVIRONMENT	2141	=head1 ENVIRONMENT
1686		2142
…		…
1695		2151
1696	=item >= 3 - script loading and management	2152	=item >= 3 - script loading and management
1697		2153
1698	=item >=10 - all called hooks	2154	=item >=10 - all called hooks
1699		2155
1700	=item >=11 - hook reutrn values	2156	=item >=11 - hook return values
1701		2157
1702	=back	2158	=back
1703		2159
1704	=head1 AUTHOR	2160	=head1 AUTHOR
1705		2161
…		…
1707	http://software.schmorp.de/pkg/rxvt-unicode	2163	http://software.schmorp.de/pkg/rxvt-unicode
1708		2164
1709	=cut	2165	=cut
1710		2166
1711	1	2167	1
		2168
		2169	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.95 by elmex, Tue Jan 17 13:19:45 2006 UTC vs. Revision 1.169 by root, Sun Jun 15 14:54:44 2008 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.95 by elmex, Tue Jan 17 13:19:45 2006 UTC vs.
Revision 1.169 by root, Sun Jun 15 14:54:44 2008 UTC