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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC vs.
Revision 1.151 by root, Thu Dec 14 17:22:04 2006 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
…		…
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
39		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
…		…
58	URxvt.selection.pattern-1: perl-regex	62	URxvt.selection.pattern-1: perl-regex
59	...	63	...
60		64
61	The index number (0, 1...) must not have any holes, and each regex must	65	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	66	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	67	the match. For example, the following adds a regex that matches everything
64	between two vertical bars:	68	between two vertical bars:
65		69
66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		71
		72	Another example: Programs I use often output "absolute path: " at the
		73	beginning of a line when they process multiple files. The following
		74	pattern matches the filename (note, there is a single space at the very
		75	end):
		76
		77	URxvt.selection.pattern-0: ^(/[^:]+):\
67		78
68	You can look at the source of the selection extension to see more	79	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.	80	interesting uses, such as parsing a line from beginning to end.
70		81
71	This extension also offers following bindable keyboard commands:	82	This extension also offers following bindable keyboard commands:
…		…
83	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
84		95
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.	97	runtime.
87		98
		99	Other extensions can extend this popup menu by pushing a code reference
		100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		101	popup is being displayed.
		102
		103	It's sole argument is the popup menu, which can be modified. It should
		104	either return nothing or a string, the initial boolean value and a code
		105	reference. The string will be used as button text and the code reference
		106	will be called when the toggle changes, with the new boolean value as
		107	first argument.
		108
		109	The following will add an entry C<myoption> that changes
		110	C<$self->{myoption}>:
		111
		112	push @{ $self->{term}{option_popup_hook} }, sub {
		113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		114	};
		115
88	=item selection-popup (enabled by default)	116	=item selection-popup (enabled by default)
89		117
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl	119	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	120	evaluation, web-browser starting etc.), depending on content.
		121
		122	Other extensions can extend this popup menu by pushing a code reference
		123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		124	popup is being displayed.
		125
		126	It's sole argument is the popup menu, which can be modified. The selection
		127	is in C<$_>, which can be used to decide whether to add something or not.
		128	It should either return nothing or a string and a code reference. The
		129	string will be used as button text and the code reference will be called
		130	when the button gets activated and should transform C<$_>.
		131
		132	The following will add an entry C<a to b> that transforms all C<a>s in
		133	the selection to C<b>s, but only if the selection currently contains any
		134	C<a>s:
		135
		136	push @{ $self->{term}{selection_popup_hook} }, sub {
		137	/a/ ? ("a to be" => sub { s/a/b/g }
		138	: ()
		139	};
93		140
94	=item searchable-scrollback<hotkey> (enabled by default)	141	=item searchable-scrollback<hotkey> (enabled by default)
95		142
96	Adds regex search functionality to the scrollback buffer, triggered	143	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
104	bottom. C<Escape> leaves search mode and returns to the point where search	151	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and	152	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary	153	additionally stores the first match in the current line into the primary
107	selection.	154	selection.
108		155
		156	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		157	get a case-sensitive search you can delete this prefix using C<BackSpace>
		158	or simply use an uppercase character which removes the "(?i)" prefix.
		159
		160	See L<perlre> for more info about perl regular expression syntax.
		161
		162	=item readline (enabled by default)
		163
		164	A support package that tries to make editing with readline easier. At
		165	the moment, it reacts to clicking shift-left mouse button by trying to
		166	move the text cursor to this position. It does so by generating as many
		167	cursor-left or cursor-right keypresses as required (the this only works
		168	for programs that correctly support wide characters).
		169
		170	To avoid too many false positives, this is only done when:
		171
		172	=over 4
		173
		174	=item - the tty is in ICANON state.
		175
		176	=item - the text cursor is visible.
		177
		178	=item - the primary screen is currently being displayed.
		179
		180	=item - the mouse is on the same (multi-row-) line as the text cursor.
		181
		182	=back
		183
		184	The normal selection mechanism isn't disabled, so quick successive clicks
		185	might interfere with selection creation in harmless ways.
		186
109	=item selection-autotransform	187	=item selection-autotransform
110		188
111	This selection allows you to do automatic transforms on a selection	189	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	190	whenever a selection is made.
113		191
…		…
125	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		204
127	And this example matches the same,but replaces it with vi-commands you can	205	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:	206	paste directly into your (vi :) editor:
129		207
130	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		209
132	Of course, this can be modified to suit your needs and your editor :)	210	Of course, this can be modified to suit your needs and your editor :)
133		211
134	To expand the example above to typical perl error messages ("XXX at	212	To expand the example above to typical perl error messages ("XXX at
135	FILENAME line YYY."), you need a slightly more elaborate solution:	213	FILENAME line YYY."), you need a slightly more elaborate solution:
136		214
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139		217
140	The first line tells the selection code to treat the unchanging part of	218	The first line tells the selection code to treat the unchanging part of
141	every error message as a selection pattern, and the second line transforms	219	every error message as a selection pattern, and the second line transforms
142	the message into vi commands to load the file.	220	the message into vi commands to load the file.
143		221
144	=item mark-urls	222	=item tabbed
145		223
		224	This transforms the terminal into a tabbar with additional terminals, that
		225	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		227	button per tab.
		228
		229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		230	B<Shift-Right> will switch to the tab left or right of the current one,
		231	while B<Shift-Down> creates a new tab.
		232
		233	The tabbar itself can be configured similarly to a normal terminal, but
		234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		235	following four resources (shown with defaults):
		236
		237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		239	URxvt.tabbed.tab-fg: <colour-index, default 0>
		240	URxvt.tabbed.tab-bg: <colour-index, default 1>
		241
		242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		243	indices.
		244
		245	=item matcher
		246
146	Uses per-line display filtering (C<on_line_update>) to underline urls and	247	Uses per-line display filtering (C<on_line_update>) to underline text
147	make them clickable. When middle-clicked, the program specified in the	248	matching a certain pattern and make it clickable. When clicked with the
148	resource C<urlLauncher> (default C<x-www-browser>) will be started with	249	mouse button specified in the C<matcher.button> resource (default 2, or
149	the URL as first argument.	250	middle), the program specified in the C<matcher.launcher> resource
		251	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		252	with the matched text as first argument. The default configuration is
		253	suitable for matching URLs and launching a web browser, like the
		254	former "mark-urls" extension.
		255
		256	The default pattern to match URLs can be overridden with the
		257	C<matcher.pattern.0> resource, and additional patterns can be specified
		258	with numbered patterns, in a manner similar to the "selection" extension.
		259	The launcher can also be overridden on a per-pattern basis.
		260
		261	Example configuration:
		262
		263	URxvt.perl-ext: default,matcher
		264	URxvt.urlLauncher: sensible-browser
		265	URxvt.matcher.button: 1
		266	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		267	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		268	URxvt.matcher.launcher.2: gvim +$2 $1
		269
		270	=item xim-onthespot
		271
		272	This (experimental) perl extension implements OnTheSpot editing. It does
		273	not work perfectly, and some input methods don't seem to work well with
		274	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		275	kinput2.
		276
		277	You enable it by specifying this extension and a preedit style of
		278	C<OnTheSpot>, i.e.:
		279
		280	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		281
		282	=item kuake<hotkey>
		283
		284	A very primitive quake-console-like extension. It was inspired by a
		285	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		286	user presses a global accelerator key (by default C<F10>), the terminal
		287	will show or hide itself. Another press of the accelerator key will hide
		288	or show it again.
		289
		290	Initially, the window will not be shown when using this extension.
		291
		292	This is useful if you need a single terminal thats not using any desktop
		293	space most of the time but is quickly available at the press of a key.
		294
		295	The accelerator key is grabbed regardless of any modifiers, so this
		296	extension will actually grab a physical key just for this function.
		297
		298	If you want a quake-like animation, tell your window manager to do so
		299	(fvwm can do it).
		300
		301	=item automove-background
		302
		303	This is basically a very small extension that dynamically changes the
		304	background pixmap offset to the window position, in effect creating the
		305	same effect as pseudo transparency with a custom pixmap. No scaling is
		306	supported in this mode. Example:
		307
		308	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
150		309
151	=item block-graphics-to-ascii	310	=item block-graphics-to-ascii
152		311
153	A not very useful example of filtering all text output to the terminal,	312	A not very useful example of filtering all text output to the terminal
154	by replacing all line-drawing characters (U+2500 .. U+259F) by a	313	by replacing all line-drawing characters (U+2500 .. U+259F) by a
155	similar-looking ascii character.	314	similar-looking ascii character.
156		315
157	=item digital-clock	316	=item digital-clock
158		317
159	Displays a digital clock using the built-in overlay.	318	Displays a digital clock using the built-in overlay.
		319
		320	=item remote-clipboard
		321
		322	Somewhat of a misnomer, this extension adds two menu entries to the
		323	selection popup that allows one ti run external commands to store the
		324	selection somewhere and fetch it again.
		325
		326	We use it to implement a "distributed selection mechanism", which just
		327	means that one command uploads the file to a remote server, and another
		328	reads it.
		329
		330	The commands can be set using the C<URxvt.remote-selection.store> and
		331	C<URxvt.remote-selection.fetch> resources. The first should read the
		332	selection to store from STDIN (always in UTF-8), the second should provide
		333	the selection data on STDOUT (also in UTF-8).
		334
		335	The defaults (which are likely useless to you) use rsh and cat:
		336
		337	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		338	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		339
		340	=item selection-pastebin
		341
		342	This is a little rarely useful extension that Uploads the selection as
		343	textfile to a remote site (or does other things). (The implementation is
		344	not currently secure for use in a multiuser environment as it writes to
		345	F</tmp> directly.).
		346
		347	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		348	i.e.
		349
		350	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		351
		352	Pressing this combination runs a command with C<%> replaced by the name of
		353	the textfile. This command can be set via a resource:
		354
		355	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		356
		357	And the default is likely not useful to anybody but the few people around
		358	here :)
		359
		360	The name of the textfile is the hex encoded md5 sum of the selection, so
		361	the same content should lead to the same filename.
		362
		363	After a successful upload the selection will be replaced by the text given
		364	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		365	for the filename):
		366
		367	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		368
		369	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		370	the double C</> characters as comment start. Use C<\057\057> instead,
		371	which works regardless of wether xrdb is used to parse the resource file
		372	or not.
160		373
161	=item example-refresh-hooks	374	=item example-refresh-hooks
162		375
163	Displays a very simple digital clock in the upper right corner of the	376	Displays a very simple digital clock in the upper right corner of the
164	window. Illustrates overwriting the refresh callbacks to create your own	377	window. Illustrates overwriting the refresh callbacks to create your own
165	overlays or changes.	378	overlays or changes.
166
167	=item selection-pastebin
168
169	This is a little rarely useful extension that Uploads the selection as
170	textfile to a remote site (or does other things).
171
172	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
173	i.e.
174
175	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
176
177	Pressing this combination runs a command with C<%> replaced by the name of
178	the textfile. This command can be set via a resource:
179
180	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
181
182	And the default is likely not useful to anybody but the few people around
183	here :)
184
185	The name of the textfile is the hex encoded md5 sum of the selection, so
186	the same content should lead to the same filename.
187
188	After a successful upload the selection will be replaced by the text given
189	in the C<selection-pastebin-url> resource (again, the % is the placeholder
190	for the filename):
191
192	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
193		379
194	=back	380	=back
195		381
196	=head1 API DOCUMENTATION	382	=head1 API DOCUMENTATION
197		383
…		…
231		417
232	=back	418	=back
233		419
234	=head2 Extension Objects	420	=head2 Extension Objects
235		421
236	Very perl extension is a perl class. A separate perl object is created	422	Every perl extension is a perl class. A separate perl object is created
237	for each terminal and each extension and passed as the first parameter to	423	for each terminal, and each terminal has its own set of extenion objects,
238	hooks. So extensions can use their C<$self> object without having to think	424	which are passed as the first parameter to hooks. So extensions can use
239	about other extensions, with the exception of methods and members that	425	their C<$self> object without having to think about clashes with other
		426	extensions or other terminals, with the exception of methods and members
240	begin with an underscore character C<_>: these are reserved for internal	427	that begin with an underscore character C<_>: these are reserved for
241	use.	428	internal use.
242		429
243	Although it isn't a C<urxvt::term> object, you can call all methods of the	430	Although it isn't a C<urxvt::term> object, you can call all methods of the
244	C<urxvt::term> class on this object.	431	C<urxvt::term> class on this object.
245		432
246	It has the following methods and data members:	433	It has the following methods and data members:
…		…
267	=head2 Hooks	454	=head2 Hooks
268		455
269	The following subroutines can be declared in extension files, and will be	456	The following subroutines can be declared in extension files, and will be
270	called whenever the relevant event happens.	457	called whenever the relevant event happens.
271		458
272	The first argument passed to them is an extension oject as described in	459	The first argument passed to them is an extension object as described in
273	the in the C<Extension Objects> section.	460	the in the C<Extension Objects> section.
274		461
275	B<All> of these hooks must return a boolean value. If it is true, then the	462	B<All> of these hooks must return a boolean value. If any of the called
276	event counts as being I<consumed>, and the invocation of other hooks is	463	hooks returns true, then the event counts as being I<consumed>, and the
277	skipped, and the relevant action might not be carried out by the C++ code.	464	relevant action might not be carried out by the C++ code.
278		465
279	I<< When in doubt, return a false value (preferably C<()>). >>	466	I<< When in doubt, return a false value (preferably C<()>). >>
280		467
281	=over 4	468	=over 4
282		469
283	=item on_init $term	470	=item on_init $term
284		471
285	Called after a new terminal object has been initialized, but before	472	Called after a new terminal object has been initialized, but before
286	windows are created or the command gets run. Most methods are unsafe to	473	windows are created or the command gets run. Most methods are unsafe to
287	call or deliver senseless data, as terminal size and other characteristics	474	call or deliver senseless data, as terminal size and other characteristics
288	have not yet been determined. You can safely query and change resources,	475	have not yet been determined. You can safely query and change resources
289	though.	476	and options, though. For many purposes the C<on_start> hook is a better
		477	place.
		478
		479	=item on_start $term
		480
		481	Called at the very end of initialisation of a new terminal, just before
		482	trying to map (display) the toplevel and returning to the main loop.
		483
		484	=item on_destroy $term
		485
		486	Called whenever something tries to destroy terminal, when the terminal is
		487	still fully functional (not for long, though).
290		488
291	=item on_reset $term	489	=item on_reset $term
292		490
293	Called after the screen is "reset" for any reason, such as resizing or	491	Called after the screen is "reset" for any reason, such as resizing or
294	control sequences. Here is where you can react on changes to size-related	492	control sequences. Here is where you can react on changes to size-related
295	variables.	493	variables.
296		494
297	=item on_start $term	495	=item on_child_start $term, $pid
298		496
299	Called at the very end of initialisation of a new terminal, just before	497	Called just after the child process has been C<fork>ed.
300	returning to the mainloop.	498
		499	=item on_child_exit $term, $status
		500
		501	Called just after the child process has exited. C<$status> is the status
		502	from C<waitpid>.
301		503
302	=item on_sel_make $term, $eventtime	504	=item on_sel_make $term, $eventtime
303		505
304	Called whenever a selection has been made by the user, but before the	506	Called whenever a selection has been made by the user, but before the
305	selection text is copied, so changes to the beginning, end or type of the	507	selection text is copied, so changes to the beginning, end or type of the
…		…
312		514
313	Called whenever a selection has been copied, but before the selection is	515	Called whenever a selection has been copied, but before the selection is
314	requested from the server. The selection text can be queried and changed	516	requested from the server. The selection text can be queried and changed
315	by calling C<< $term->selection >>.	517	by calling C<< $term->selection >>.
316		518
317	Returning a true value aborts selection grabbing. It will still be hilighted.	519	Returning a true value aborts selection grabbing. It will still be highlighted.
318		520
319	=item on_sel_extend $term	521	=item on_sel_extend $term
320		522
321	Called whenever the user tries to extend the selection (e.g. with a double	523	Called whenever the user tries to extend the selection (e.g. with a double
322	click) and is either supposed to return false (normal operation), or	524	click) and is either supposed to return false (normal operation), or
323	should extend the selection itelf and return true to suppress the built-in	525	should extend the selection itself and return true to suppress the built-in
324	processing. This can happen multiple times, as long as the callback	526	processing. This can happen multiple times, as long as the callback
325	returns true, it will be called on every further click by the user and is	527	returns true, it will be called on every further click by the user and is
326	supposed to enlarge the selection more and more, if possible.	528	supposed to enlarge the selection more and more, if possible.
327		529
328	See the F<selection> example extension.	530	See the F<selection> example extension.
329		531
330	=item on_view_change $term, $offset	532	=item on_view_change $term, $offset
331		533
332	Called whenever the view offset changes, i..e the user or program	534	Called whenever the view offset changes, i.e. the user or program
333	scrolls. Offset C<0> means display the normal terminal, positive values	535	scrolls. Offset C<0> means display the normal terminal, positive values
334	show this many lines of scrollback.	536	show this many lines of scrollback.
335		537
336	=item on_scroll_back $term, $lines, $saved	538	=item on_scroll_back $term, $lines, $saved
337		539
…		…
341		543
342	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	544	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
343	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	545	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
344	number of lines that will be in the scrollback buffer.	546	number of lines that will be in the scrollback buffer.
345		547
		548	=item on_osc_seq $term, $op, $args
		549
		550	Called on every OSC sequence and can be used to suppress it or modify its
		551	behaviour. The default should be to return an empty list. A true value
		552	suppresses execution of the request completely. Make sure you don't get
		553	confused by recursive invocations when you output an osc sequence within
		554	this callback.
		555
		556	C<on_osc_seq_perl> should be used for new behaviour.
		557
346	=item on_osc_seq $term, $string	558	=item on_osc_seq_perl $term, $string
347		559
348	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	560	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
349	operating system command) is processed. Cursor position and other state	561	operating system command) is processed. Cursor position and other state
350	information is up-to-date when this happens. For interoperability, the	562	information is up-to-date when this happens. For interoperability, the
351	string should start with the extension name and a colon, to distinguish	563	string should start with the extension name and a colon, to distinguish
352	it from commands for other extensions, and this might be enforced in the	564	it from commands for other extensions, and this might be enforced in the
353	future.	565	future.
354		566
355	Be careful not ever to trust (in a security sense) the data you receive,	567	Be careful not ever to trust (in a security sense) the data you receive,
356	as its source can not easily be controleld (e-mail content, messages from	568	as its source can not easily be controlled (e-mail content, messages from
357	other users on the same system etc.).	569	other users on the same system etc.).
358		570
359	=item on_add_lines $term, $string	571	=item on_add_lines $term, $string
360		572
361	Called whenever text is about to be output, with the text as argument. You	573	Called whenever text is about to be output, with the text as argument. You
…		…
392		604
393	=item on_refresh_end $term	605	=item on_refresh_end $term
394		606
395	Called just after the screen gets redrawn. See C<on_refresh_begin>.	607	Called just after the screen gets redrawn. See C<on_refresh_begin>.
396		608
397	=item on_keyboard_command $term, $string	609	=item on_user_command $term, $string
398		610
399	Called whenever the user presses a key combination that has a	611	Called whenever a user-configured event is being activated (e.g. via
400	C<perl:string> action bound to it (see description of the B<keysym>	612	a C<perl:string> action bound to a key, see description of the B<keysym>
401	resource in the @@RXVT_NAME@@(1) manpage).	613	resource in the @@RXVT_NAME@@(1) manpage).
		614
		615	The event is simply the action string. This interface is assumed to change
		616	slightly in the future.
		617
		618	=item on_resize_all_windows $tern, $new_width, $new_height
		619
		620	Called just after the new window size has been calculated, but before
		621	windows are actually being resized or hints are being set. If this hook
		622	returns TRUE, setting of the window hints is being skipped.
402		623
403	=item on_x_event $term, $event	624	=item on_x_event $term, $event
404		625
405	Called on every X event received on the vt window (and possibly other	626	Called on every X event received on the vt window (and possibly other
406	windows). Should only be used as a last resort. Most event structure	627	windows). Should only be used as a last resort. Most event structure
407	members are not passed.	628	members are not passed.
408		629
		630	=item on_root_event $term, $event
		631
		632	Like C<on_x_event>, but is called for events on the root window.
		633
409	=item on_focus_in $term	634	=item on_focus_in $term
410		635
411	Called whenever the window gets the keyboard focus, before rxvt-unicode	636	Called whenever the window gets the keyboard focus, before rxvt-unicode
412	does focus in processing.	637	does focus in processing.
413		638
414	=item on_focus_out $term	639	=item on_focus_out $term
415		640
416	Called wheneever the window loses keyboard focus, before rxvt-unicode does	641	Called whenever the window loses keyboard focus, before rxvt-unicode does
417	focus out processing.	642	focus out processing.
		643
		644	=item on_configure_notify $term, $event
		645
		646	=item on_property_notify $term, $event
418		647
419	=item on_key_press $term, $event, $keysym, $octets	648	=item on_key_press $term, $event, $keysym, $octets
420		649
421	=item on_key_release $term, $event, $keysym	650	=item on_key_release $term, $event, $keysym
422		651
…		…
432		661
433	Called whenever the corresponding X event is received for the terminal If	662	Called whenever the corresponding X event is received for the terminal If
434	the hook returns true, then the even will be ignored by rxvt-unicode.	663	the hook returns true, then the even will be ignored by rxvt-unicode.
435		664
436	The event is a hash with most values as named by Xlib (see the XEvent	665	The event is a hash with most values as named by Xlib (see the XEvent
437	manpage), with the additional members C<row> and C<col>, which are the row	666	manpage), with the additional members C<row> and C<col>, which are the
438	and column under the mouse cursor.	667	(real, not screen-based) row and column under the mouse cursor.
439		668
440	C<on_key_press> additionally receives the string rxvt-unicode would	669	C<on_key_press> additionally receives the string rxvt-unicode would
441	output, if any, in locale-specific encoding.	670	output, if any, in locale-specific encoding.
442		671
443	subwindow.	672	subwindow.
		673
		674	=item on_client_message $term, $event
		675
		676	=item on_wm_protocols $term, $event
		677
		678	=item on_wm_delete_window $term, $event
		679
		680	Called when various types of ClientMessage events are received (all with
		681	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
444		682
445	=back	683	=back
446		684
447	=cut	685	=cut
448		686
…		…
454	use Scalar::Util ();	692	use Scalar::Util ();
455	use List::Util ();	693	use List::Util ();
456		694
457	our $VERSION = 1;	695	our $VERSION = 1;
458	our $TERM;	696	our $TERM;
		697	our @TERM_INIT;
		698	our @TERM_EXT;
459	our @HOOKNAME;	699	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	700	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	701	our %OPTION;
462		702
463	our $LIBDIR;	703	our $LIBDIR;
464	our $RESNAME;	704	our $RESNAME;
465	our $RESCLASS;	705	our $RESCLASS;
466	our $RXVTNAME;	706	our $RXVTNAME;
467		707
		708	our $NOCHAR = chr 0xffff;
		709
468	=head2 Variables in the C<urxvt> Package	710	=head2 Variables in the C<urxvt> Package
469		711
470	=over 4	712	=over 4
471		713
472	=item $urxvt::LIBDIR	714	=item $urxvt::LIBDIR
…		…
484		726
485	=item $urxvt::TERM	727	=item $urxvt::TERM
486		728
487	The current terminal. This variable stores the current C<urxvt::term>	729	The current terminal. This variable stores the current C<urxvt::term>
488	object, whenever a callback/hook is executing.	730	object, whenever a callback/hook is executing.
		731
		732	=item @urxvt::TERM_INIT
		733
		734	All code references in this array will be called as methods of the next newly
		735	created C<urxvt::term> object (during the C<on_init> phase). The array
		736	gets cleared before the code references that were in it are being executed,
		737	so references can push themselves onto it again if they so desire.
		738
		739	This complements to the perl-eval command line option, but gets executed
		740	first.
		741
		742	=item @urxvt::TERM_EXT
		743
		744	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		745	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		746	but before other extensions. Gets cleared just like C<@TERM_INIT>.
489		747
490	=back	748	=back
491		749
492	=head2 Functions in the C<urxvt> Package	750	=head2 Functions in the C<urxvt> Package
493		751
…		…
507		765
508	Using this function has the advantage that its output ends up in the	766	Using this function has the advantage that its output ends up in the
509	correct place, e.g. on stderr of the connecting urxvtc client.	767	correct place, e.g. on stderr of the connecting urxvtc client.
510		768
511	Messages have a size limit of 1023 bytes currently.	769	Messages have a size limit of 1023 bytes currently.
		770
		771	=item @terms = urxvt::termlist
		772
		773	Returns all urxvt::term objects that exist in this process, regardless of
		774	whether they are started, being destroyed etc., so be careful. Only term
		775	objects that have perl extensions attached will be returned (because there
		776	is no urxvt::term objet associated with others).
512		777
513	=item $time = urxvt::NOW	778	=item $time = urxvt::NOW
514		779
515	Returns the "current time" (as per the event loop).	780	Returns the "current time" (as per the event loop).
516		781
…		…
575		840
576	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	841	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
577		842
578	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	843	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
579		844
		845	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		846
580	Replace the foreground/background colour in the rendition mask with the	847	Replace the foreground/background colour in the rendition mask with the
581	specified one.	848	specified one.
582		849
583	=item $value = urxvt::GET_CUSTOM $rend	850	=item $value = urxvt::GET_CUSTOM $rend
584		851
…		…
593	=back	860	=back
594		861
595	=cut	862	=cut
596		863
597	BEGIN {	864	BEGIN {
598	urxvt->bootstrap;
599
600	# overwrite perl's warn	865	# overwrite perl's warn
601	*CORE::GLOBAL::warn = sub {	866	*CORE::GLOBAL::warn = sub {
602	my $msg = join "", @_;	867	my $msg = join "", @_;
603	$msg .= "\n"	868	$msg .= "\n"
604	unless $msg =~ /\n$/;	869	unless $msg =~ /\n$/;
605	urxvt::warn ($msg);	870	urxvt::warn ($msg);
606	};	871	};
607
608	# %ENV is the original startup environment
609	delete $ENV{IFS};
610	delete $ENV{CDPATH};
611	delete $ENV{BASH_ENV};
612	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
613	}	872	}
		873
		874	no warnings 'utf8';
614		875
615	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	876	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
616		877
617	sub verbose {	878	sub verbose {
618	my ($level, $msg) = @_;	879	my ($level, $msg) = @_;
619	warn "$msg\n" if $level <= $verbosity;	880	warn "$msg\n" if $level <= $verbosity;
620	}	881	}
621		882
622	my $extension_pkg = "extension0000";
623	my %extension_pkg;	883	my %extension_pkg;
624		884
625	# load a single script into its own package, once only	885	# load a single script into its own package, once only
626	sub extension_package($) {	886	sub extension_package($) {
627	my ($path) = @_;	887	my ($path) = @_;
628		888
629	$extension_pkg{$path} \|\|= do {	889	$extension_pkg{$path} \|\|= do {
630	my $pkg = "urxvt::" . ($extension_pkg++);	890	$path =~ /([^\/\\]+)$/;
		891	my $pkg = $1;
		892	$pkg =~ s/[^[:word:]]/_/g;
		893	$pkg = "urxvt::ext::$pkg";
631		894
632	verbose 3, "loading extension '$path' into package '$pkg'";	895	verbose 3, "loading extension '$path' into package '$pkg'";
633		896
634	open my $fh, "<:raw", $path	897	open my $fh, "<:raw", $path
635	or die "$path: $!";	898	or die "$path: $!";
636		899
637	my $source =	900	my $source =
638	"package $pkg; use strict; use utf8;\n"	901	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
639	. "use base urxvt::term::extension::;\n"
640	. "#line 1 \"$path\"\n{\n"	902	. "#line 1 \"$path\"\n{\n"
641	. (do { local $/; <$fh> })	903	. (do { local $/; <$fh> })
642	. "\n};\n1";	904	. "\n};\n1";
643		905
644	eval $source	906	eval $source
…		…
658	if ($htype == 0) { # INIT	920	if ($htype == 0) { # INIT
659	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	921	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
660		922
661	my %ext_arg;	923	my %ext_arg;
662		924
		925	{
		926	my @init = @TERM_INIT;
		927	@TERM_INIT = ();
		928	$_->($TERM) for @init;
		929	my @pkg = @TERM_EXT;
		930	@TERM_EXT = ();
		931	$TERM->register_package ($_) for @pkg;
		932	}
		933
663	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	934	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
664	if ($_ eq "default") {	935	if ($_ eq "default") {
665	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	936	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
666	} elsif (/^-(.*)$/) {	937	} elsif (/^-(.*)$/) {
667	delete $ext_arg{$1};	938	delete $ext_arg{$1};
668	} elsif (/^([^<]+)<(.*)>$/) {	939	} elsif (/^([^<]+)<(.*)>$/) {
669	push @{ $ext_arg{$1} }, $2;	940	push @{ $ext_arg{$1} }, $2;
670	} else {	941	} else {
671	$ext_arg{$_} \|\|= [];	942	$ext_arg{$_} \|\|= [];
672	}	943	}
673	}	944	}
674		945
675	while (my ($ext, $argv) = each %ext_arg) {	946	for my $ext (sort keys %ext_arg) {
676	my @files = grep -f $_, map "$_/$ext", @dirs;	947	my @files = grep -f $_, map "$_/$ext", @dirs;
677		948
678	if (@files) {	949	if (@files) {
679	$TERM->register_package (extension_package $files[0], $argv);	950	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
680	} else {	951	} else {
681	warn "perl extension '$ext' not found in perl library search path\n";	952	warn "perl extension '$ext' not found in perl library search path\n";
682	}	953	}
683	}	954	}
684		955
…		…
690		961
691	if (my $cb = $TERM->{_hook}[$htype]) {	962	if (my $cb = $TERM->{_hook}[$htype]) {
692	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	963	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
693	if $verbosity >= 10;	964	if $verbosity >= 10;
694		965
695	keys %$cb;	966	for my $pkg (keys %$cb) {
696
697	while (my ($pkg, $cb) = each %$cb) {
698	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	967	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
699	and last;	968	$retval \|\|= $retval_;
700		969
701	if ($@) {	970	if ($@) {
702	$TERM->ungrab; # better to lose the grab than the session	971	$TERM->ungrab; # better to lose the grab than the session
703	warn $@;	972	warn $@;
704	}	973	}
…		…
717	}	986	}
718		987
719	$retval	988	$retval
720	}	989	}
721		990
722	sub exec_async(@) {	991	sub SET_COLOR($$$) {
723	my $pid = fork;	992	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
724
725	return
726	if !defined $pid or $pid;
727
728	%ENV = %{ $TERM->env };
729
730	exec @_;
731	_exit 255;
732	}	993	}
733		994
734	# urxvt::term::extension	995	# urxvt::term::extension
735		996
736	package urxvt::term::extension;	997	package urxvt::term::extension;
…		…
849	sub DESTROY {	1110	sub DESTROY {
850	$_[0][1]->stop;	1111	$_[0][1]->stop;
851	}	1112	}
852		1113
853	sub condvar {	1114	sub condvar {
854	bless \my $flag, urxvt::anyevent::condvar::	1115	bless \my $flag, urxvt::anyevent::
855	}	1116	}
856		1117
857	sub urxvt::anyevent::condvar::broadcast {	1118	sub broadcast {
858	${$_[0]}++;	1119	${$_[0]}++;
859	}	1120	}
860		1121
861	sub urxvt::anyevent::condvar::wait {	1122	sub wait {
862	unless (${$_[0]}) {	1123	unless (${$_[0]}) {
863	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1124	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
864	}	1125	}
		1126	}
		1127
		1128	sub one_event {
		1129	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
865	}	1130	}
866		1131
867	package urxvt::term;	1132	package urxvt::term;
868		1133
869	=head2 The C<urxvt::term> Class	1134	=head2 The C<urxvt::term> Class
…		…
874		1139
875	# find on_xxx subs in the package and register them	1140	# find on_xxx subs in the package and register them
876	# as hooks	1141	# as hooks
877	sub register_package {	1142	sub register_package {
878	my ($self, $pkg, $argv) = @_;	1143	my ($self, $pkg, $argv) = @_;
		1144
		1145	no strict 'refs';
		1146
		1147	urxvt::verbose 6, "register package $pkg to $self";
		1148
		1149	@{"$pkg\::ISA"} = urxvt::term::extension::;
879		1150
880	my $proxy = bless {	1151	my $proxy = bless {
881	_pkg => $pkg,	1152	_pkg => $pkg,
882	argv => $argv,	1153	argv => $argv,
883	}, $pkg;	1154	}, $pkg;
…		…
899	hash which defines the environment of the new terminal.	1170	hash which defines the environment of the new terminal.
900		1171
901	Croaks (and probably outputs an error message) if the new instance	1172	Croaks (and probably outputs an error message) if the new instance
902	couldn't be created. Returns C<undef> if the new instance didn't	1173	couldn't be created. Returns C<undef> if the new instance didn't
903	initialise perl, and the terminal object otherwise. The C<init> and	1174	initialise perl, and the terminal object otherwise. The C<init> and
904	C<start> hooks will be called during this call.	1175	C<start> hooks will be called before this call returns, and are free to
		1176	refer to global data (which is race free).
905		1177
906	=cut	1178	=cut
907		1179
908	sub new {	1180	sub new {
909	my ($class, $env, @args) = @_;	1181	my ($class, $env, @args) = @_;
910		1182
		1183	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1184	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1185
911	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1186	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
912	}	1187	}
913		1188
914	=item $term->destroy	1189	=item $term->destroy
915		1190
916	Destroy the terminal object (close the window, free resources	1191	Destroy the terminal object (close the window, free resources
917	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1192	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
918	watchers (timers, io watchers) are still active.	1193	watchers (timers, io watchers) are still active.
919		1194
		1195	=item $term->exec_async ($cmd[, @args])
		1196
		1197	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1198	("starts") programs in the background. This function takes care of setting
		1199	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1200	be preferred over explicit calls to C<exec> or C<system>.
		1201
		1202	Returns the pid of the subprocess or C<undef> on error.
		1203
		1204	=cut
		1205
		1206	sub exec_async {
		1207	my $self = shift;
		1208
		1209	my $pid = fork;
		1210
		1211	return $pid
		1212	if !defined $pid or $pid;
		1213
		1214	%ENV = %{ $self->env };
		1215
		1216	exec @_;
		1217	urxvt::_exit 255;
		1218	}
		1219
920	=item $isset = $term->option ($optval[, $set])	1220	=item $isset = $term->option ($optval[, $set])
921		1221
922	Returns true if the option specified by C<$optval> is enabled, and	1222	Returns true if the option specified by C<$optval> is enabled, and
923	optionally change it. All option values are stored by name in the hash	1223	optionally change it. All option values are stored by name in the hash
924	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1224	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
925		1225
926	Here is a a likely non-exhaustive list of option names, please see the	1226	Here is a likely non-exhaustive list of option names, please see the
927	source file F</src/optinc.h> to see the actual list:	1227	source file F</src/optinc.h> to see the actual list:
928		1228
929	borderLess console cursorBlink cursorUnderline hold iconic insecure	1229	borderLess console cursorBlink cursorUnderline hold iconic insecure
930	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1230	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
931	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1231	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
932	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1232	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
933	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1233	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
934	tripleclickwords utmpInhibit visualBell	1234	transparent tripleclickwords utmpInhibit visualBell
935		1235
936	=item $value = $term->resource ($name[, $newval])	1236	=item $value = $term->resource ($name[, $newval])
937		1237
938	Returns the current resource value associated with a given name and	1238	Returns the current resource value associated with a given name and
939	optionally sets a new value. Setting values is most useful in the C<init>	1239	optionally sets a new value. Setting values is most useful in the C<init>
…		…
948	likely change).	1248	likely change).
949		1249
950	Please note that resource strings will currently only be freed when the	1250	Please note that resource strings will currently only be freed when the
951	terminal is destroyed, so changing options frequently will eat memory.	1251	terminal is destroyed, so changing options frequently will eat memory.
952		1252
953	Here is a a likely non-exhaustive list of resource names, not all of which	1253	Here is a likely non-exhaustive list of resource names, not all of which
954	are supported in every build, please see the source file F</src/rsinc.h>	1254	are supported in every build, please see the source file F</src/rsinc.h>
955	to see the actual list:	1255	to see the actual list:
956		1256
957	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1257	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
958	borderLess color cursorBlink cursorUnderline cutchars delete_key	1258	borderLess color cursorBlink cursorUnderline cutchars delete_key
959	display_name embed ext_bwidth fade font geometry hold iconName	1259	display_name embed ext_bwidth fade font geometry hold iconName
960	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1260	imFont imLocale inputMethod insecure int_bwidth intensityStyles
961	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1261	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
962	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1262	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
963	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1263	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
964	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1264	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
965	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1265	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
966	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1266	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
967	shade term_name title transparent transparent_all tripleclickwords	1267	secondaryScreen secondaryScroll selectstyle shade term_name title
968	utmpInhibit visualBell	1268	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1269	visualBell
969		1270
970	=cut	1271	=cut
971		1272
972	sub resource($$;$) {	1273	sub resource($$;$) {
973	my ($self, $name) = (shift, shift);	1274	my ($self, $name) = (shift, shift);
…		…
1147		1448
1148	Normally its not a good idea to use this function, as programs might be	1449	Normally its not a good idea to use this function, as programs might be
1149	confused by changes in cursor position or scrolling. Its useful inside a	1450	confused by changes in cursor position or scrolling. Its useful inside a
1150	C<on_add_lines> hook, though.	1451	C<on_add_lines> hook, though.
1151		1452
		1453	=item $term->scr_change_screen ($screen)
		1454
		1455	Switch to given screen - 0 primary, 1 secondary.
		1456
1152	=item $term->cmd_parse ($octets)	1457	=item $term->cmd_parse ($octets)
1153		1458
1154	Similar to C<scr_add_lines>, but the argument must be in the	1459	Similar to C<scr_add_lines>, but the argument must be in the
1155	locale-specific encoding of the terminal and can contain command sequences	1460	locale-specific encoding of the terminal and can contain command sequences
1156	(escape codes) that will be interpreted.	1461	(escape codes) that will be interpreted.
…		…
1166	Replaces the event mask of the pty watcher by the given event mask. Can	1471	Replaces the event mask of the pty watcher by the given event mask. Can
1167	be used to suppress input and output handling to the pty/tty. See the	1472	be used to suppress input and output handling to the pty/tty. See the
1168	description of C<< urxvt::timer->events >>. Make sure to always restore	1473	description of C<< urxvt::timer->events >>. Make sure to always restore
1169	the previous value.	1474	the previous value.
1170		1475
		1476	=item $fd = $term->pty_fd
		1477
		1478	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1479	is used.
		1480
1171	=item $windowid = $term->parent	1481	=item $windowid = $term->parent
1172		1482
1173	Return the window id of the toplevel window.	1483	Return the window id of the toplevel window.
1174		1484
1175	=item $windowid = $term->vt	1485	=item $windowid = $term->vt
…		…
1181	Adds the specified events to the vt event mask. Useful e.g. when you want	1491	Adds the specified events to the vt event mask. Useful e.g. when you want
1182	to receive pointer events all the times:	1492	to receive pointer events all the times:
1183		1493
1184	$term->vt_emask_add (urxvt::PointerMotionMask);	1494	$term->vt_emask_add (urxvt::PointerMotionMask);
1185		1495
		1496	=item $term->focus_in
		1497
		1498	=item $term->focus_out
		1499
		1500	=item $term->key_press ($state, $keycode[, $time])
		1501
		1502	=item $term->key_release ($state, $keycode[, $time])
		1503
		1504	Deliver various fake events to to terminal.
		1505
1186	=item $window_width = $term->width	1506	=item $window_width = $term->width
1187		1507
1188	=item $window_height = $term->height	1508	=item $window_height = $term->height
1189		1509
1190	=item $font_width = $term->fwidth	1510	=item $font_width = $term->fwidth
…		…
1220	=item $env = $term->env	1540	=item $env = $term->env
1221		1541
1222	Returns a copy of the environment in effect for the terminal as a hashref	1542	Returns a copy of the environment in effect for the terminal as a hashref
1223	similar to C<\%ENV>.	1543	similar to C<\%ENV>.
1224		1544
		1545	=item @envv = $term->envv
		1546
		1547	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1548
		1549	=item @argv = $term->argv
		1550
		1551	Return the argument vector as this terminal, similar to @ARGV, but
		1552	includes the program name as first element.
		1553
1225	=cut	1554	=cut
1226		1555
1227	sub env {	1556	sub env {
1228	if (my $env = $_[0]->_env) {
1229	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1557	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1230	} else {
1231	+{ %ENV }
1232	}
1233	}	1558	}
1234		1559
1235	=item $modifiermask = $term->ModLevel3Mask	1560	=item $modifiermask = $term->ModLevel3Mask
1236		1561
1237	=item $modifiermask = $term->ModMetaMask	1562	=item $modifiermask = $term->ModMetaMask
1238		1563
1239	=item $modifiermask = $term->ModNumLockMask	1564	=item $modifiermask = $term->ModNumLockMask
1240		1565
1241	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1566	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1242	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1567	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1568
		1569	=item $screen = $term->current_screen
		1570
		1571	Returns the currently displayed screen (0 primary, 1 secondary).
		1572
		1573	=item $cursor_is_hidden = $term->hidden_cursor
		1574
		1575	Returns whether the cursor is currently hidden or not.
1243		1576
1244	=item $view_start = $term->view_start ([$newvalue])	1577	=item $view_start = $term->view_start ([$newvalue])
1245		1578
1246	Returns the row number of the topmost displayed line. Maximum value is	1579	Returns the row number of the topmost displayed line. Maximum value is
1247	C<0>, which displays the normal terminal contents. Lower values scroll	1580	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1267	line, starting at column C<$start_col> (default C<0>), which is useful	1600	line, starting at column C<$start_col> (default C<0>), which is useful
1268	to replace only parts of a line. The font index in the rendition will	1601	to replace only parts of a line. The font index in the rendition will
1269	automatically be updated.	1602	automatically be updated.
1270		1603
1271	C<$text> is in a special encoding: tabs and wide characters that use more	1604	C<$text> is in a special encoding: tabs and wide characters that use more
1272	than one cell when displayed are padded with urxvt::NOCHAR characters	1605	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1273	(C<chr 65535>). Characters with combining characters and other characters	1606	characters. Characters with combining characters and other characters that
1274	that do not fit into the normal tetx encoding will be replaced with	1607	do not fit into the normal tetx encoding will be replaced with characters
1275	characters in the private use area.	1608	in the private use area.
1276		1609
1277	You have to obey this encoding when changing text. The advantage is	1610	You have to obey this encoding when changing text. The advantage is
1278	that C<substr> and similar functions work on screen cells and not on	1611	that C<substr> and similar functions work on screen cells and not on
1279	characters.	1612	characters.
1280		1613
…		…
1424	where one character corresponds to one screen cell. See	1757	where one character corresponds to one screen cell. See
1425	C<< $term->ROW_t >> for details.	1758	C<< $term->ROW_t >> for details.
1426		1759
1427	=item $string = $term->special_decode $text	1760	=item $string = $term->special_decode $text
1428		1761
1429	Converts rxvt-unicodes text reprsentation into a perl string. See	1762	Converts rxvt-unicodes text representation into a perl string. See
1430	C<< $term->ROW_t >> for details.	1763	C<< $term->ROW_t >> for details.
1431		1764
1432	=item $success = $term->grab_button ($button, $modifiermask)	1765	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1433		1766
		1767	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1768
1434	Registers a synchronous button grab. See the XGrabButton manpage.	1769	Register/unregister a synchronous button grab. See the XGrabButton
		1770	manpage.
1435		1771
1436	=item $success = $term->grab ($eventtime[, $sync])	1772	=item $success = $term->grab ($eventtime[, $sync])
1437		1773
1438	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1774	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1439	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1775	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1440		1776
1441	=item $term->allow_events_async	1777	=item $term->allow_events_async
1442		1778
1443	Calls XAllowEvents with AsyncBoth for the most recent grab.	1779	Calls XAllowEvents with AsyncBoth for the most recent grab.
1444		1780
…		…
1454	=item $term->ungrab	1790	=item $term->ungrab
1455		1791
1456	Calls XUngrab for the most recent grab. Is called automatically on	1792	Calls XUngrab for the most recent grab. Is called automatically on
1457	evaluation errors, as it is better to lose the grab in the error case as	1793	evaluation errors, as it is better to lose the grab in the error case as
1458	the session.	1794	the session.
		1795
		1796	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1797
		1798	=item $atom_name = $term->XGetAtomName ($atom)
		1799
		1800	=item @atoms = $term->XListProperties ($window)
		1801
		1802	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1803
		1804	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1805
		1806	=item $term->XDeleteProperty ($window, $property)
		1807
		1808	=item $window = $term->DefaultRootWindow
		1809
		1810	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1811
		1812	=item $term->XMapWindow ($window)
		1813
		1814	=item $term->XUnmapWindow ($window)
		1815
		1816	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1817
		1818	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1819
		1820	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1821
		1822	Various X or X-related functions. The C<$term> object only serves as
		1823	the source of the display, otherwise those functions map more-or-less
		1824	directory onto the X functions of the same name.
1459		1825
1460	=back	1826	=back
1461		1827
1462	=cut	1828	=cut
1463		1829
…		…
1527	my ($self, $text, $cb) = @_;	1893	my ($self, $text, $cb) = @_;
1528		1894
1529	$self->add_item ({ type => "button", text => $text, activate => $cb});	1895	$self->add_item ({ type => "button", text => $text, activate => $cb});
1530	}	1896	}
1531		1897
1532	=item $popup->add_toggle ($text, $cb, $initial_value)	1898	=item $popup->add_toggle ($text, $initial_value, $cb)
1533		1899
1534	Adds a toggle/checkbox item to the popup. Teh callback gets called	1900	Adds a toggle/checkbox item to the popup. The callback gets called
1535	whenever it gets toggled, with a boolean indicating its value as its first	1901	whenever it gets toggled, with a boolean indicating its new value as its
1536	argument.	1902	first argument.
1537		1903
1538	=cut	1904	=cut
1539		1905
1540	sub add_toggle {	1906	sub add_toggle {
1541	my ($self, $text, $cb, $value) = @_;	1907	my ($self, $text, $value, $cb) = @_;
1542		1908
1543	my $item; $item = {	1909	my $item; $item = {
1544	type => "button",	1910	type => "button",
1545	text => " $text",	1911	text => " $text",
1546	value => $value,	1912	value => $value,
…		…
1565	my $env = $self->{term}->env;	1931	my $env = $self->{term}->env;
1566	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1932	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1567	delete $env->{LC_ALL};	1933	delete $env->{LC_ALL};
1568	$env->{LC_CTYPE} = $self->{term}->locale;	1934	$env->{LC_CTYPE} = $self->{term}->locale;
1569		1935
1570	urxvt::term->new ($env, $self->{term}->resource ("name"),	1936	urxvt::term->new ($env, "popup",
1571	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1937	"--perl-lib" => "", "--perl-ext-common" => "",
		1938	"-pty-fd" => -1, "-sl" => 0,
		1939	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1572	"--transient-for" => $self->{term}->parent,	1940	"--transient-for" => $self->{term}->parent,
1573	"-display" => $self->{term}->display_id,	1941	"-display" => $self->{term}->display_id,
1574	"-pe" => "urxvt-popup")	1942	"-pe" => "urxvt-popup")
1575	or die "unable to create popup window\n";	1943	or die "unable to create popup window\n";
1576	}	1944	}
…		…
1581	delete $self->{term}{_destroy}{$self};	1949	delete $self->{term}{_destroy}{$self};
1582	$self->{term}->ungrab;	1950	$self->{term}->ungrab;
1583	}	1951	}
1584		1952
1585	=back	1953	=back
		1954
		1955	=cut
		1956
		1957	package urxvt::watcher;
1586		1958
1587	=head2 The C<urxvt::timer> Class	1959	=head2 The C<urxvt::timer> Class
1588		1960
1589	This class implements timer watchers/events. Time is represented as a	1961	This class implements timer watchers/events. Time is represented as a
1590	fractional number of seconds since the epoch. Example:	1962	fractional number of seconds since the epoch. Example:
…		…
1628	Start the timer.	2000	Start the timer.
1629		2001
1630	=item $timer = $timer->start ($tstamp)	2002	=item $timer = $timer->start ($tstamp)
1631		2003
1632	Set the event trigger time to C<$tstamp> and start the timer.	2004	Set the event trigger time to C<$tstamp> and start the timer.
		2005
		2006	=item $timer = $timer->after ($delay)
		2007
		2008	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1633		2009
1634	=item $timer = $timer->stop	2010	=item $timer = $timer->stop
1635		2011
1636	Stop the timer.	2012	Stop the timer.
1637		2013
…		…
1666	Set the callback to be called when io events are triggered. C<$reventmask>	2042	Set the callback to be called when io events are triggered. C<$reventmask>
1667	is a bitset as described in the C<events> method.	2043	is a bitset as described in the C<events> method.
1668		2044
1669	=item $iow = $iow->fd ($fd)	2045	=item $iow = $iow->fd ($fd)
1670		2046
1671	Set the filedescriptor (not handle) to watch.	2047	Set the file descriptor (not handle) to watch.
1672		2048
1673	=item $iow = $iow->events ($eventmask)	2049	=item $iow = $iow->events ($eventmask)
1674		2050
1675	Set the event mask to watch. The only allowed values are	2051	Set the event mask to watch. The only allowed values are
1676	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2052	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
…		…
1680		2056
1681	Start watching for requested events on the given handle.	2057	Start watching for requested events on the given handle.
1682		2058
1683	=item $iow = $iow->stop	2059	=item $iow = $iow->stop
1684		2060
1685	Stop watching for events on the given filehandle.	2061	Stop watching for events on the given file handle.
		2062
		2063	=back
		2064
		2065	=head2 The C<urxvt::iw> Class
		2066
		2067	This class implements idle watchers, that get called automatically when
		2068	the process is idle. They should return as fast as possible, after doing
		2069	some useful work.
		2070
		2071	=over 4
		2072
		2073	=item $iw = new urxvt::iw
		2074
		2075	Create a new idle watcher object in stopped state.
		2076
		2077	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2078
		2079	Set the callback to be called when the watcher triggers.
		2080
		2081	=item $timer = $timer->start
		2082
		2083	Start the watcher.
		2084
		2085	=item $timer = $timer->stop
		2086
		2087	Stop the watcher.
		2088
		2089	=back
		2090
		2091	=head2 The C<urxvt::pw> Class
		2092
		2093	This class implements process watchers. They create an event whenever a
		2094	process exits, after which they stop automatically.
		2095
		2096	my $pid = fork;
		2097	...
		2098	$term->{pw} = urxvt::pw
		2099	->new
		2100	->start ($pid)
		2101	->cb (sub {
		2102	my ($pw, $exit_status) = @_;
		2103	...
		2104	});
		2105
		2106	=over 4
		2107
		2108	=item $pw = new urxvt::pw
		2109
		2110	Create a new process watcher in stopped state.
		2111
		2112	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2113
		2114	Set the callback to be called when the timer triggers.
		2115
		2116	=item $pw = $timer->start ($pid)
		2117
		2118	Tells the watcher to start watching for process C<$pid>.
		2119
		2120	=item $pw = $pw->stop
		2121
		2122	Stop the watcher.
1686		2123
1687	=back	2124	=back
1688		2125
1689	=head1 ENVIRONMENT	2126	=head1 ENVIRONMENT
1690		2127
…		…
1699		2136
1700	=item >= 3 - script loading and management	2137	=item >= 3 - script loading and management
1701		2138
1702	=item >=10 - all called hooks	2139	=item >=10 - all called hooks
1703		2140
1704	=item >=11 - hook reutrn values	2141	=item >=11 - hook return values
1705		2142
1706	=back	2143	=back
1707		2144
1708	=head1 AUTHOR	2145	=head1 AUTHOR
1709		2146

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC vs. Revision 1.151 by root, Thu Dec 14 17:22:04 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC vs.
Revision 1.151 by root, Thu Dec 14 17:22:04 2006 UTC