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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.89 by root, Thu Jan 12 12:10:06 2006 UTC vs.
Revision 1.153 by root, Sat Jun 2 05:23:11 2007 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
…		…
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 the following bindable keyboard command:	82	This extension also offers following bindable keyboard commands:
72		83
73	=over 4	84	=over 4
74		85
75	=item rot13	86	=item rot13
76		87
…		…
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
…		…
120		198
121	For example, the following will transform selections of the form	199	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename	200	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:	201	$word>:
124		202
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\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/^(S+):(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	=item mark-urls	210	Of course, this can be modified to suit your needs and your editor :)
133		211
		212	To expand the example above to typical perl error messages ("XXX at
		213	FILENAME line YYY."), you need a slightly more elaborate solution:
		214
		215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		217
		218	The first line tells the selection code to treat the unchanging part of
		219	every error message as a selection pattern, and the second line transforms
		220	the message into vi commands to load the file.
		221
		222	=item tabbed
		223
		224	This transforms the terminal into a tabbar with additional terminals, that
		225	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		227	button per tab.
		228
		229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		230	B<Shift-Right> will switch to the tab left or right of the current one,
		231	while B<Shift-Down> creates a new tab.
		232
		233	The tabbar itself can be configured similarly to a normal terminal, but
		234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		235	following four resources (shown with defaults):
		236
		237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		239	URxvt.tabbed.tab-fg: <colour-index, default 0>
		240	URxvt.tabbed.tab-bg: <colour-index, default 1>
		241
		242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		243	indices.
		244
		245	=item matcher
		246
134	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
135	make them clickable. When middle-clicked, the program specified in the	248	matching a certain pattern and make it clickable. When clicked with the
136	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
137	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.keysym.C-Delete: perl:matcher
		266	URxvt.matcher.button: 1
		267	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		268	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		269	URxvt.matcher.launcher.2: gvim +$2 $1
		270
		271	=item xim-onthespot
		272
		273	This (experimental) perl extension implements OnTheSpot editing. It does
		274	not work perfectly, and some input methods don't seem to work well with
		275	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		276	kinput2.
		277
		278	You enable it by specifying this extension and a preedit style of
		279	C<OnTheSpot>, i.e.:
		280
		281	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		282
		283	=item kuake<hotkey>
		284
		285	A very primitive quake-console-like extension. It was inspired by a
		286	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		287	user presses a global accelerator key (by default C<F10>), the terminal
		288	will show or hide itself. Another press of the accelerator key will hide
		289	or show it again.
		290
		291	Initially, the window will not be shown when using this extension.
		292
		293	This is useful if you need a single terminal thats not using any desktop
		294	space most of the time but is quickly available at the press of a key.
		295
		296	The accelerator key is grabbed regardless of any modifiers, so this
		297	extension will actually grab a physical key just for this function.
		298
		299	If you want a quake-like animation, tell your window manager to do so
		300	(fvwm can do it).
		301
		302	=item automove-background
		303
		304	This is basically a very small extension that dynamically changes the
		305	background pixmap offset to the window position, in effect creating the
		306	same effect as pseudo transparency with a custom pixmap. No scaling is
		307	supported in this mode. Example:
		308
		309	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		310
		311	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
		312	shows how this extension can be used to implement an automatically blurred
		313	transparent background.
138		314
139	=item block-graphics-to-ascii	315	=item block-graphics-to-ascii
140		316
141	A not very useful example of filtering all text output to the terminal,	317	A not very useful example of filtering all text output to the terminal
142	by replacing all line-drawing characters (U+2500 .. U+259F) by a	318	by replacing all line-drawing characters (U+2500 .. U+259F) by a
143	similar-looking ascii character.	319	similar-looking ascii character.
144		320
145	=item digital-clock	321	=item digital-clock
146		322
147	Displays a digital clock using the built-in overlay.	323	Displays a digital clock using the built-in overlay.
		324
		325	=item remote-clipboard
		326
		327	Somewhat of a misnomer, this extension adds two menu entries to the
		328	selection popup that allows one ti run external commands to store the
		329	selection somewhere and fetch it again.
		330
		331	We use it to implement a "distributed selection mechanism", which just
		332	means that one command uploads the file to a remote server, and another
		333	reads it.
		334
		335	The commands can be set using the C<URxvt.remote-selection.store> and
		336	C<URxvt.remote-selection.fetch> resources. The first should read the
		337	selection to store from STDIN (always in UTF-8), the second should provide
		338	the selection data on STDOUT (also in UTF-8).
		339
		340	The defaults (which are likely useless to you) use rsh and cat:
		341
		342	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		343	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		344
		345	=item selection-pastebin
		346
		347	This is a little rarely useful extension that Uploads the selection as
		348	textfile to a remote site (or does other things). (The implementation is
		349	not currently secure for use in a multiuser environment as it writes to
		350	F</tmp> directly.).
		351
		352	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		353	i.e.
		354
		355	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		356
		357	Pressing this combination runs a command with C<%> replaced by the name of
		358	the textfile. This command can be set via a resource:
		359
		360	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		361
		362	And the default is likely not useful to anybody but the few people around
		363	here :)
		364
		365	The name of the textfile is the hex encoded md5 sum of the selection, so
		366	the same content should lead to the same filename.
		367
		368	After a successful upload the selection will be replaced by the text given
		369	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		370	for the filename):
		371
		372	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		373
		374	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		375	the double C</> characters as comment start. Use C<\057\057> instead,
		376	which works regardless of wether xrdb is used to parse the resource file
		377	or not.
148		378
149	=item example-refresh-hooks	379	=item example-refresh-hooks
150		380
151	Displays a very simple digital clock in the upper right corner of the	381	Displays a very simple digital clock in the upper right corner of the
152	window. Illustrates overwriting the refresh callbacks to create your own	382	window. Illustrates overwriting the refresh callbacks to create your own
…		…
192		422
193	=back	423	=back
194		424
195	=head2 Extension Objects	425	=head2 Extension Objects
196		426
197	Very perl extension is a perl class. A separate perl object is created	427	Every perl extension is a perl class. A separate perl object is created
198	for each terminal and each extension and passed as the first parameter to	428	for each terminal, and each terminal has its own set of extenion objects,
199	hooks. So extensions can use their C<$self> object without having to think	429	which are passed as the first parameter to hooks. So extensions can use
200	about other extensions, with the exception of methods and members that	430	their C<$self> object without having to think about clashes with other
		431	extensions or other terminals, with the exception of methods and members
201	begin with an underscore character C<_>: these are reserved for internal	432	that begin with an underscore character C<_>: these are reserved for
202	use.	433	internal use.
203		434
204	Although it isn't a C<urxvt::term> object, you can call all methods of the	435	Although it isn't a C<urxvt::term> object, you can call all methods of the
205	C<urxvt::term> class on this object.	436	C<urxvt::term> class on this object.
206		437
207	It has the following methods and data members:	438	It has the following methods and data members:
…		…
228	=head2 Hooks	459	=head2 Hooks
229		460
230	The following subroutines can be declared in extension files, and will be	461	The following subroutines can be declared in extension files, and will be
231	called whenever the relevant event happens.	462	called whenever the relevant event happens.
232		463
233	The first argument passed to them is an extension oject as described in	464	The first argument passed to them is an extension object as described in
234	the in the C<Extension Objects> section.	465	the in the C<Extension Objects> section.
235		466
236	B<All> of these hooks must return a boolean value. If it is true, then the	467	B<All> of these hooks must return a boolean value. If any of the called
237	event counts as being I<consumed>, and the invocation of other hooks is	468	hooks returns true, then the event counts as being I<consumed>, and the
238	skipped, and the relevant action might not be carried out by the C++ code.	469	relevant action might not be carried out by the C++ code.
239		470
240	I<< When in doubt, return a false value (preferably C<()>). >>	471	I<< When in doubt, return a false value (preferably C<()>). >>
241		472
242	=over 4	473	=over 4
243		474
244	=item on_init $term	475	=item on_init $term
245		476
246	Called after a new terminal object has been initialized, but before	477	Called after a new terminal object has been initialized, but before
247	windows are created or the command gets run. Most methods are unsafe to	478	windows are created or the command gets run. Most methods are unsafe to
248	call or deliver senseless data, as terminal size and other characteristics	479	call or deliver senseless data, as terminal size and other characteristics
249	have not yet been determined. You can safely query and change resources,	480	have not yet been determined. You can safely query and change resources
250	though.	481	and options, though. For many purposes the C<on_start> hook is a better
		482	place.
		483
		484	=item on_start $term
		485
		486	Called at the very end of initialisation of a new terminal, just before
		487	trying to map (display) the toplevel and returning to the main loop.
		488
		489	=item on_destroy $term
		490
		491	Called whenever something tries to destroy terminal, when the terminal is
		492	still fully functional (not for long, though).
251		493
252	=item on_reset $term	494	=item on_reset $term
253		495
254	Called after the screen is "reset" for any reason, such as resizing or	496	Called after the screen is "reset" for any reason, such as resizing or
255	control sequences. Here is where you can react on changes to size-related	497	control sequences. Here is where you can react on changes to size-related
256	variables.	498	variables.
257		499
258	=item on_start $term	500	=item on_child_start $term, $pid
259		501
260	Called at the very end of initialisation of a new terminal, just before	502	Called just after the child process has been C<fork>ed.
261	returning to the mainloop.	503
		504	=item on_child_exit $term, $status
		505
		506	Called just after the child process has exited. C<$status> is the status
		507	from C<waitpid>.
262		508
263	=item on_sel_make $term, $eventtime	509	=item on_sel_make $term, $eventtime
264		510
265	Called whenever a selection has been made by the user, but before the	511	Called whenever a selection has been made by the user, but before the
266	selection text is copied, so changes to the beginning, end or type of the	512	selection text is copied, so changes to the beginning, end or type of the
…		…
273		519
274	Called whenever a selection has been copied, but before the selection is	520	Called whenever a selection has been copied, but before the selection is
275	requested from the server. The selection text can be queried and changed	521	requested from the server. The selection text can be queried and changed
276	by calling C<< $term->selection >>.	522	by calling C<< $term->selection >>.
277		523
278	Returning a true value aborts selection grabbing. It will still be hilighted.	524	Returning a true value aborts selection grabbing. It will still be highlighted.
279		525
280	=item on_sel_extend $term	526	=item on_sel_extend $term
281		527
282	Called whenever the user tries to extend the selection (e.g. with a double	528	Called whenever the user tries to extend the selection (e.g. with a double
283	click) and is either supposed to return false (normal operation), or	529	click) and is either supposed to return false (normal operation), or
284	should extend the selection itelf and return true to suppress the built-in	530	should extend the selection itself and return true to suppress the built-in
285	processing. This can happen multiple times, as long as the callback	531	processing. This can happen multiple times, as long as the callback
286	returns true, it will be called on every further click by the user and is	532	returns true, it will be called on every further click by the user and is
287	supposed to enlarge the selection more and more, if possible.	533	supposed to enlarge the selection more and more, if possible.
288		534
289	See the F<selection> example extension.	535	See the F<selection> example extension.
290		536
291	=item on_view_change $term, $offset	537	=item on_view_change $term, $offset
292		538
293	Called whenever the view offset changes, i..e the user or program	539	Called whenever the view offset changes, i.e. the user or program
294	scrolls. Offset C<0> means display the normal terminal, positive values	540	scrolls. Offset C<0> means display the normal terminal, positive values
295	show this many lines of scrollback.	541	show this many lines of scrollback.
296		542
297	=item on_scroll_back $term, $lines, $saved	543	=item on_scroll_back $term, $lines, $saved
298		544
…		…
302		548
303	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	549	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
304	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	550	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
305	number of lines that will be in the scrollback buffer.	551	number of lines that will be in the scrollback buffer.
306		552
		553	=item on_osc_seq $term, $op, $args
		554
		555	Called on every OSC sequence and can be used to suppress it or modify its
		556	behaviour. The default should be to return an empty list. A true value
		557	suppresses execution of the request completely. Make sure you don't get
		558	confused by recursive invocations when you output an osc sequence within
		559	this callback.
		560
		561	C<on_osc_seq_perl> should be used for new behaviour.
		562
307	=item on_osc_seq $term, $string	563	=item on_osc_seq_perl $term, $string
308		564
309	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	565	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
310	operating system command) is processed. Cursor position and other state	566	operating system command) is processed. Cursor position and other state
311	information is up-to-date when this happens. For interoperability, the	567	information is up-to-date when this happens. For interoperability, the
312	string should start with the extension name and a colon, to distinguish	568	string should start with the extension name and a colon, to distinguish
313	it from commands for other extensions, and this might be enforced in the	569	it from commands for other extensions, and this might be enforced in the
314	future.	570	future.
315		571
316	Be careful not ever to trust (in a security sense) the data you receive,	572	Be careful not ever to trust (in a security sense) the data you receive,
317	as its source can not easily be controleld (e-mail content, messages from	573	as its source can not easily be controlled (e-mail content, messages from
318	other users on the same system etc.).	574	other users on the same system etc.).
319		575
320	=item on_add_lines $term, $string	576	=item on_add_lines $term, $string
321		577
322	Called whenever text is about to be output, with the text as argument. You	578	Called whenever text is about to be output, with the text as argument. You
…		…
353		609
354	=item on_refresh_end $term	610	=item on_refresh_end $term
355		611
356	Called just after the screen gets redrawn. See C<on_refresh_begin>.	612	Called just after the screen gets redrawn. See C<on_refresh_begin>.
357		613
358	=item on_keyboard_command $term, $string	614	=item on_user_command $term, $string
359		615
360	Called whenever the user presses a key combination that has a	616	Called whenever a user-configured event is being activated (e.g. via
361	C<perl:string> action bound to it (see description of the B<keysym>	617	a C<perl:string> action bound to a key, see description of the B<keysym>
362	resource in the @@RXVT_NAME@@(1) manpage).	618	resource in the @@RXVT_NAME@@(1) manpage).
		619
		620	The event is simply the action string. This interface is assumed to change
		621	slightly in the future.
		622
		623	=item on_resize_all_windows $tern, $new_width, $new_height
		624
		625	Called just after the new window size has been calculated, but before
		626	windows are actually being resized or hints are being set. If this hook
		627	returns TRUE, setting of the window hints is being skipped.
		628
		629	=item on_x_event $term, $event
		630
		631	Called on every X event received on the vt window (and possibly other
		632	windows). Should only be used as a last resort. Most event structure
		633	members are not passed.
		634
		635	=item on_root_event $term, $event
		636
		637	Like C<on_x_event>, but is called for events on the root window.
363		638
364	=item on_focus_in $term	639	=item on_focus_in $term
365		640
366	Called whenever the window gets the keyboard focus, before rxvt-unicode	641	Called whenever the window gets the keyboard focus, before rxvt-unicode
367	does focus in processing.	642	does focus in processing.
368		643
369	=item on_focus_out $term	644	=item on_focus_out $term
370		645
371	Called wheneever the window loses keyboard focus, before rxvt-unicode does	646	Called whenever the window loses keyboard focus, before rxvt-unicode does
372	focus out processing.	647	focus out processing.
		648
		649	=item on_configure_notify $term, $event
		650
		651	=item on_property_notify $term, $event
373		652
374	=item on_key_press $term, $event, $keysym, $octets	653	=item on_key_press $term, $event, $keysym, $octets
375		654
376	=item on_key_release $term, $event, $keysym	655	=item on_key_release $term, $event, $keysym
377		656
…		…
387		666
388	Called whenever the corresponding X event is received for the terminal If	667	Called whenever the corresponding X event is received for the terminal If
389	the hook returns true, then the even will be ignored by rxvt-unicode.	668	the hook returns true, then the even will be ignored by rxvt-unicode.
390		669
391	The event is a hash with most values as named by Xlib (see the XEvent	670	The event is a hash with most values as named by Xlib (see the XEvent
392	manpage), with the additional members C<row> and C<col>, which are the row	671	manpage), with the additional members C<row> and C<col>, which are the
393	and column under the mouse cursor.	672	(real, not screen-based) row and column under the mouse cursor.
394		673
395	C<on_key_press> additionally receives the string rxvt-unicode would	674	C<on_key_press> additionally receives the string rxvt-unicode would
396	output, if any, in locale-specific encoding.	675	output, if any, in locale-specific encoding.
397		676
398	subwindow.	677	subwindow.
		678
		679	=item on_client_message $term, $event
		680
		681	=item on_wm_protocols $term, $event
		682
		683	=item on_wm_delete_window $term, $event
		684
		685	Called when various types of ClientMessage events are received (all with
		686	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
399		687
400	=back	688	=back
401		689
402	=cut	690	=cut
403		691
…		…
409	use Scalar::Util ();	697	use Scalar::Util ();
410	use List::Util ();	698	use List::Util ();
411		699
412	our $VERSION = 1;	700	our $VERSION = 1;
413	our $TERM;	701	our $TERM;
		702	our @TERM_INIT;
		703	our @TERM_EXT;
414	our @HOOKNAME;	704	our @HOOKNAME;
415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	705	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
416	our %OPTION;	706	our %OPTION;
417		707
418	our $LIBDIR;	708	our $LIBDIR;
419	our $RESNAME;	709	our $RESNAME;
420	our $RESCLASS;	710	our $RESCLASS;
421	our $RXVTNAME;	711	our $RXVTNAME;
422		712
		713	our $NOCHAR = chr 0xffff;
		714
423	=head2 Variables in the C<urxvt> Package	715	=head2 Variables in the C<urxvt> Package
424		716
425	=over 4	717	=over 4
426		718
427	=item $urxvt::LIBDIR	719	=item $urxvt::LIBDIR
…		…
439		731
440	=item $urxvt::TERM	732	=item $urxvt::TERM
441		733
442	The current terminal. This variable stores the current C<urxvt::term>	734	The current terminal. This variable stores the current C<urxvt::term>
443	object, whenever a callback/hook is executing.	735	object, whenever a callback/hook is executing.
		736
		737	=item @urxvt::TERM_INIT
		738
		739	All code references in this array will be called as methods of the next newly
		740	created C<urxvt::term> object (during the C<on_init> phase). The array
		741	gets cleared before the code references that were in it are being executed,
		742	so references can push themselves onto it again if they so desire.
		743
		744	This complements to the perl-eval command line option, but gets executed
		745	first.
		746
		747	=item @urxvt::TERM_EXT
		748
		749	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		750	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		751	but before other extensions. Gets cleared just like C<@TERM_INIT>.
444		752
445	=back	753	=back
446		754
447	=head2 Functions in the C<urxvt> Package	755	=head2 Functions in the C<urxvt> Package
448		756
…		…
463	Using this function has the advantage that its output ends up in the	771	Using this function has the advantage that its output ends up in the
464	correct place, e.g. on stderr of the connecting urxvtc client.	772	correct place, e.g. on stderr of the connecting urxvtc client.
465		773
466	Messages have a size limit of 1023 bytes currently.	774	Messages have a size limit of 1023 bytes currently.
467		775
468	=item $is_safe = urxvt::safe	776	=item @terms = urxvt::termlist
469		777
470	Returns true when it is safe to do potentially unsafe things, such as	778	Returns all urxvt::term objects that exist in this process, regardless of
471	evaluating perl code specified by the user. This is true when urxvt was	779	whether they are started, being destroyed etc., so be careful. Only term
472	started setuid or setgid.	780	objects that have perl extensions attached will be returned (because there
		781	is no urxvt::term objet associated with others).
473		782
474	=item $time = urxvt::NOW	783	=item $time = urxvt::NOW
475		784
476	Returns the "current time" (as per the event loop).	785	Returns the "current time" (as per the event loop).
477		786
478	=item urxvt::CurrentTime	787	=item urxvt::CurrentTime
479		788
480	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	789	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
481	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	790	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
482	Button4Mask, Button5Mask, AnyModifier	791	Button4Mask, Button5Mask, AnyModifier
		792
		793	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		794	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		795	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		796	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		797	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		798	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		799	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		800
		801	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		802	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		803	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		804	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		805	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		806	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		807	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
483		808
484	Various constants for use in X calls and event processing.	809	Various constants for use in X calls and event processing.
485		810
486	=back	811	=back
487		812
…		…
520		845
521	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	846	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
522		847
523	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	848	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
524		849
		850	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		851
525	Replace the foreground/background colour in the rendition mask with the	852	Replace the foreground/background colour in the rendition mask with the
526	specified one.	853	specified one.
527		854
528	=item $value = urxvt::GET_CUSTOM $rend	855	=item $value = urxvt::GET_CUSTOM $rend
529		856
…		…
538	=back	865	=back
539		866
540	=cut	867	=cut
541		868
542	BEGIN {	869	BEGIN {
543	urxvt->bootstrap;
544
545	# overwrite perl's warn	870	# overwrite perl's warn
546	*CORE::GLOBAL::warn = sub {	871	*CORE::GLOBAL::warn = sub {
547	my $msg = join "", @_;	872	my $msg = join "", @_;
548	$msg .= "\n"	873	$msg .= "\n"
549	unless $msg =~ /\n$/;	874	unless $msg =~ /\n$/;
550	urxvt::warn ($msg);	875	urxvt::warn ($msg);
551	};	876	};
552
553	# %ENV is the original startup environment
554	delete $ENV{IFS};
555	delete $ENV{CDPATH};
556	delete $ENV{BASH_ENV};
557	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
558	}	877	}
559		878
560	my @hook_count;	879	no warnings 'utf8';
		880
561	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	881	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
562		882
563	sub verbose {	883	sub verbose {
564	my ($level, $msg) = @_;	884	my ($level, $msg) = @_;
565	warn "$msg\n" if $level <= $verbosity;	885	warn "$msg\n" if $level <= $verbosity;
566	}	886	}
567		887
568	my $extension_pkg = "extension0000";
569	my %extension_pkg;	888	my %extension_pkg;
570		889
571	# load a single script into its own package, once only	890	# load a single script into its own package, once only
572	sub extension_package($) {	891	sub extension_package($) {
573	my ($path) = @_;	892	my ($path) = @_;
574		893
575	$extension_pkg{$path} \|\|= do {	894	$extension_pkg{$path} \|\|= do {
576	my $pkg = "urxvt::" . ($extension_pkg++);	895	$path =~ /([^\/\\]+)$/;
		896	my $pkg = $1;
		897	$pkg =~ s/[^[:word:]]/_/g;
		898	$pkg = "urxvt::ext::$pkg";
577		899
578	verbose 3, "loading extension '$path' into package '$pkg'";	900	verbose 3, "loading extension '$path' into package '$pkg'";
579		901
580	open my $fh, "<:raw", $path	902	open my $fh, "<:raw", $path
581	or die "$path: $!";	903	or die "$path: $!";
582		904
583	my $source = untaint	905	my $source =
584	"package $pkg; use strict; use utf8;\n"	906	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
585	. "use base urxvt::term::extension::;\n"
586	. "#line 1 \"$path\"\n{\n"	907	. "#line 1 \"$path\"\n{\n"
587	. (do { local $/; <$fh> })	908	. (do { local $/; <$fh> })
588	. "\n};\n1";	909	. "\n};\n1";
589		910
590	eval $source	911	eval $source
…		…
604	if ($htype == 0) { # INIT	925	if ($htype == 0) { # INIT
605	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	926	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
606		927
607	my %ext_arg;	928	my %ext_arg;
608		929
		930	{
		931	my @init = @TERM_INIT;
		932	@TERM_INIT = ();
		933	$_->($TERM) for @init;
		934	my @pkg = @TERM_EXT;
		935	@TERM_EXT = ();
		936	$TERM->register_package ($_) for @pkg;
		937	}
		938
609	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	939	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
610	if ($_ eq "default") {	940	if ($_ eq "default") {
611	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	941	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
612	} elsif (/^-(.*)$/) {	942	} elsif (/^-(.*)$/) {
613	delete $ext_arg{$1};	943	delete $ext_arg{$1};
614	} elsif (/^([^<]+)<(.*)>$/) {	944	} elsif (/^([^<]+)<(.*)>$/) {
615	push @{ $ext_arg{$1} }, $2;	945	push @{ $ext_arg{$1} }, $2;
616	} else {	946	} else {
617	$ext_arg{$_} \|\|= [];	947	$ext_arg{$_} \|\|= [];
618	}	948	}
619	}	949	}
620		950
621	while (my ($ext, $argv) = each %ext_arg) {	951	for my $ext (sort keys %ext_arg) {
622	my @files = grep -f $_, map "$_/$ext", @dirs;	952	my @files = grep -f $_, map "$_/$ext", @dirs;
623		953
624	if (@files) {	954	if (@files) {
625	$TERM->register_package (extension_package $files[0], $argv);	955	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
626	} else {	956	} else {
627	warn "perl extension '$ext' not found in perl library search path\n";	957	warn "perl extension '$ext' not found in perl library search path\n";
628	}	958	}
629	}	959	}
630		960
…		…
636		966
637	if (my $cb = $TERM->{_hook}[$htype]) {	967	if (my $cb = $TERM->{_hook}[$htype]) {
638	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	968	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
639	if $verbosity >= 10;	969	if $verbosity >= 10;
640		970
641	keys %$cb;	971	for my $pkg (keys %$cb) {
642
643	while (my ($pkg, $cb) = each %$cb) {
644	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	972	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
645	and last;	973	$retval \|\|= $retval_;
646		974
647	if ($@) {	975	if ($@) {
648	$TERM->ungrab; # better to lose the grab than the session	976	$TERM->ungrab; # better to lose the grab than the session
649	warn $@;	977	warn $@;
650	}	978	}
…		…
653	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	981	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
654	if $verbosity >= 11;	982	if $verbosity >= 11;
655	}	983	}
656		984
657	if ($htype == 1) { # DESTROY	985	if ($htype == 1) { # DESTROY
658	if (my $hook = delete $TERM->{_hook}) {
659	for my $htype (0..$#$hook) {
660	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
661	or set_should_invoke $htype, 0;
662	}
663	}
664
665	# clear package objects	986	# clear package objects
666	%$_ = () for values %{ $TERM->{_pkg} };	987	%$_ = () for values %{ $TERM->{_pkg} };
667		988
668	# clear package	989	# clear package
669	%$TERM = ();	990	%$TERM = ();
670	}	991	}
671		992
672	$retval	993	$retval
673	}	994	}
674		995
675	sub exec_async(@) {	996	sub SET_COLOR($$$) {
676	my $pid = fork;	997	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		998	}
677		999
678	return	1000	sub rend2mask {
679	if !defined $pid or $pid;	1001	no strict 'refs';
680		1002	my ($str, $mask) = (@_, 0);
681	%ENV = %{ $TERM->env };	1003	my %color = ( fg => undef, bg => undef );
682		1004	my @failed;
683	exec @_;	1005	for my $spec ( split /\s+/, $str ) {
684	_exit 255;	1006	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1007	$color{lc($1)} = $2;
		1008	} else {
		1009	my $neg = $spec =~ s/^[-^]//;
		1010	unless ( exists &{"RS_$spec"} ) {
		1011	push @failed, $spec;
		1012	next;
		1013	}
		1014	my $cur = &{"RS_$spec"};
		1015	if ( $neg ) {
		1016	$mask &= ~$cur;
		1017	} else {
		1018	$mask \|= $cur;
		1019	}
		1020	}
		1021	}
		1022	($mask, @color{qw(fg bg)}, \@failed)
685	}	1023	}
686		1024
687	# urxvt::term::extension	1025	# urxvt::term::extension
688		1026
689	package urxvt::term::extension;	1027	package urxvt::term::extension;
…		…
695	while (my ($name, $cb) = each %hook) {	1033	while (my ($name, $cb) = each %hook) {
696	my $htype = $HOOKTYPE{uc $name};	1034	my $htype = $HOOKTYPE{uc $name};
697	defined $htype	1035	defined $htype
698	or Carp::croak "unsupported hook type '$name'";	1036	or Carp::croak "unsupported hook type '$name'";
699		1037
		1038	$self->set_should_invoke ($htype, +1)
700	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1039	unless exists $self->{term}{_hook}[$htype]{$pkg};
701	$hook_count[$htype]++
702	or urxvt::set_should_invoke $htype, 1;
703	}
704		1040
705	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1041	$self->{term}{_hook}[$htype]{$pkg} = $cb;
706	}	1042	}
707	}	1043	}
708		1044
…		…
713	for my $name (@hook) {	1049	for my $name (@hook) {
714	my $htype = $HOOKTYPE{uc $name};	1050	my $htype = $HOOKTYPE{uc $name};
715	defined $htype	1051	defined $htype
716	or Carp::croak "unsupported hook type '$name'";	1052	or Carp::croak "unsupported hook type '$name'";
717		1053
		1054	$self->set_should_invoke ($htype, -1)
718	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1055	if delete $self->{term}{_hook}[$htype]{$pkg};
719	--$hook_count[$htype]
720	or urxvt::set_should_invoke $htype, 0;
721	}
722	}	1056	}
723	}	1057	}
724		1058
725	our $AUTOLOAD;	1059	our $AUTOLOAD;
726		1060
…		…
806	sub DESTROY {	1140	sub DESTROY {
807	$_[0][1]->stop;	1141	$_[0][1]->stop;
808	}	1142	}
809		1143
810	sub condvar {	1144	sub condvar {
811	bless \my $flag, urxvt::anyevent::condvar::	1145	bless \my $flag, urxvt::anyevent::
812	}	1146	}
813		1147
814	sub urxvt::anyevent::condvar::broadcast {	1148	sub broadcast {
815	${$_[0]}++;	1149	${$_[0]}++;
816	}	1150	}
817		1151
818	sub urxvt::anyevent::condvar::wait {	1152	sub wait {
819	unless (${$_[0]}) {	1153	unless (${$_[0]}) {
820	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1154	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
821	}	1155	}
		1156	}
		1157
		1158	sub one_event {
		1159	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
822	}	1160	}
823		1161
824	package urxvt::term;	1162	package urxvt::term;
825		1163
826	=head2 The C<urxvt::term> Class	1164	=head2 The C<urxvt::term> Class
…		…
831		1169
832	# find on_xxx subs in the package and register them	1170	# find on_xxx subs in the package and register them
833	# as hooks	1171	# as hooks
834	sub register_package {	1172	sub register_package {
835	my ($self, $pkg, $argv) = @_;	1173	my ($self, $pkg, $argv) = @_;
		1174
		1175	no strict 'refs';
		1176
		1177	urxvt::verbose 6, "register package $pkg to $self";
		1178
		1179	@{"$pkg\::ISA"} = urxvt::term::extension::;
836		1180
837	my $proxy = bless {	1181	my $proxy = bless {
838	_pkg => $pkg,	1182	_pkg => $pkg,
839	argv => $argv,	1183	argv => $argv,
840	}, $pkg;	1184	}, $pkg;
…		…
856	hash which defines the environment of the new terminal.	1200	hash which defines the environment of the new terminal.
857		1201
858	Croaks (and probably outputs an error message) if the new instance	1202	Croaks (and probably outputs an error message) if the new instance
859	couldn't be created. Returns C<undef> if the new instance didn't	1203	couldn't be created. Returns C<undef> if the new instance didn't
860	initialise perl, and the terminal object otherwise. The C<init> and	1204	initialise perl, and the terminal object otherwise. The C<init> and
861	C<start> hooks will be called during this call.	1205	C<start> hooks will be called before this call returns, and are free to
		1206	refer to global data (which is race free).
862		1207
863	=cut	1208	=cut
864		1209
865	sub new {	1210	sub new {
866	my ($class, $env, @args) = @_;	1211	my ($class, $env, @args) = @_;
867		1212
		1213	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1214	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1215
868	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1216	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
869	}	1217	}
870		1218
871	=item $term->destroy	1219	=item $term->destroy
872		1220
873	Destroy the terminal object (close the window, free resources	1221	Destroy the terminal object (close the window, free resources
874	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1222	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
875	watchers (timers, io watchers) are still active.	1223	watchers (timers, io watchers) are still active.
876		1224
		1225	=item $term->exec_async ($cmd[, @args])
		1226
		1227	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1228	("starts") programs in the background. This function takes care of setting
		1229	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1230	be preferred over explicit calls to C<exec> or C<system>.
		1231
		1232	Returns the pid of the subprocess or C<undef> on error.
		1233
		1234	=cut
		1235
		1236	sub exec_async {
		1237	my $self = shift;
		1238
		1239	my $pid = fork;
		1240
		1241	return $pid
		1242	if !defined $pid or $pid;
		1243
		1244	%ENV = %{ $self->env };
		1245
		1246	exec @_;
		1247	urxvt::_exit 255;
		1248	}
		1249
877	=item $isset = $term->option ($optval[, $set])	1250	=item $isset = $term->option ($optval[, $set])
878		1251
879	Returns true if the option specified by C<$optval> is enabled, and	1252	Returns true if the option specified by C<$optval> is enabled, and
880	optionally change it. All option values are stored by name in the hash	1253	optionally change it. All option values are stored by name in the hash
881	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1254	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
882		1255
883	Here is a a likely non-exhaustive list of option names, please see the	1256	Here is a likely non-exhaustive list of option names, please see the
884	source file F</src/optinc.h> to see the actual list:	1257	source file F</src/optinc.h> to see the actual list:
885		1258
886	borderLess console cursorBlink cursorUnderline hold iconic insecure	1259	borderLess console cursorBlink cursorUnderline hold iconic insecure
887	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1260	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
888	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1261	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
889	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1262	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
890	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1263	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
891	tripleclickwords utmpInhibit visualBell	1264	transparent tripleclickwords utmpInhibit visualBell
892		1265
893	=item $value = $term->resource ($name[, $newval])	1266	=item $value = $term->resource ($name[, $newval])
894		1267
895	Returns the current resource value associated with a given name and	1268	Returns the current resource value associated with a given name and
896	optionally sets a new value. Setting values is most useful in the C<init>	1269	optionally sets a new value. Setting values is most useful in the C<init>
…		…
905	likely change).	1278	likely change).
906		1279
907	Please note that resource strings will currently only be freed when the	1280	Please note that resource strings will currently only be freed when the
908	terminal is destroyed, so changing options frequently will eat memory.	1281	terminal is destroyed, so changing options frequently will eat memory.
909		1282
910	Here is a a likely non-exhaustive list of resource names, not all of which	1283	Here is a likely non-exhaustive list of resource names, not all of which
911	are supported in every build, please see the source file F</src/rsinc.h>	1284	are supported in every build, please see the source file F</src/rsinc.h>
912	to see the actual list:	1285	to see the actual list:
913		1286
914	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1287	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
915	borderLess color cursorBlink cursorUnderline cutchars delete_key	1288	borderLess color cursorBlink cursorUnderline cutchars delete_key
916	display_name embed ext_bwidth fade font geometry hold iconName	1289	display_name embed ext_bwidth fade font geometry hold iconName
917	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1290	imFont imLocale inputMethod insecure int_bwidth intensityStyles
918	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1291	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
919	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1292	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
920	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1293	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
921	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1294	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
922	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1295	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
923	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1296	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
924	shade term_name title transparent transparent_all tripleclickwords	1297	secondaryScreen secondaryScroll selectstyle shade term_name title
925	utmpInhibit visualBell	1298	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1299	visualBell
926		1300
927	=cut	1301	=cut
928		1302
929	sub resource($$;$) {	1303	sub resource($$;$) {
930	my ($self, $name) = (shift, shift);	1304	my ($self, $name) = (shift, shift);
…		…
1104		1478
1105	Normally its not a good idea to use this function, as programs might be	1479	Normally its not a good idea to use this function, as programs might be
1106	confused by changes in cursor position or scrolling. Its useful inside a	1480	confused by changes in cursor position or scrolling. Its useful inside a
1107	C<on_add_lines> hook, though.	1481	C<on_add_lines> hook, though.
1108		1482
		1483	=item $term->scr_change_screen ($screen)
		1484
		1485	Switch to given screen - 0 primary, 1 secondary.
		1486
1109	=item $term->cmd_parse ($octets)	1487	=item $term->cmd_parse ($octets)
1110		1488
1111	Similar to C<scr_add_lines>, but the argument must be in the	1489	Similar to C<scr_add_lines>, but the argument must be in the
1112	locale-specific encoding of the terminal and can contain command sequences	1490	locale-specific encoding of the terminal and can contain command sequences
1113	(escape codes) that will be interpreted.	1491	(escape codes) that will be interpreted.
…		…
1123	Replaces the event mask of the pty watcher by the given event mask. Can	1501	Replaces the event mask of the pty watcher by the given event mask. Can
1124	be used to suppress input and output handling to the pty/tty. See the	1502	be used to suppress input and output handling to the pty/tty. See the
1125	description of C<< urxvt::timer->events >>. Make sure to always restore	1503	description of C<< urxvt::timer->events >>. Make sure to always restore
1126	the previous value.	1504	the previous value.
1127		1505
		1506	=item $fd = $term->pty_fd
		1507
		1508	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1509	is used.
		1510
1128	=item $windowid = $term->parent	1511	=item $windowid = $term->parent
1129		1512
1130	Return the window id of the toplevel window.	1513	Return the window id of the toplevel window.
1131		1514
1132	=item $windowid = $term->vt	1515	=item $windowid = $term->vt
1133		1516
1134	Return the window id of the terminal window.	1517	Return the window id of the terminal window.
1135		1518
		1519	=item $term->vt_emask_add ($x_event_mask)
		1520
		1521	Adds the specified events to the vt event mask. Useful e.g. when you want
		1522	to receive pointer events all the times:
		1523
		1524	$term->vt_emask_add (urxvt::PointerMotionMask);
		1525
		1526	=item $term->focus_in
		1527
		1528	=item $term->focus_out
		1529
		1530	=item $term->key_press ($state, $keycode[, $time])
		1531
		1532	=item $term->key_release ($state, $keycode[, $time])
		1533
		1534	Deliver various fake events to to terminal.
		1535
1136	=item $window_width = $term->width	1536	=item $window_width = $term->width
1137		1537
1138	=item $window_height = $term->height	1538	=item $window_height = $term->height
1139		1539
1140	=item $font_width = $term->fwidth	1540	=item $font_width = $term->fwidth
…		…
1153		1553
1154	=item $max_scrollback = $term->saveLines	1554	=item $max_scrollback = $term->saveLines
1155		1555
1156	=item $nrow_plus_saveLines = $term->total_rows	1556	=item $nrow_plus_saveLines = $term->total_rows
1157		1557
1158	=item $lines_in_scrollback = $term->nsaved	1558	=item $topmost_scrollback_row = $term->top_row
1159		1559
1160	Return various integers describing terminal characteristics.	1560	Return various integers describing terminal characteristics.
1161		1561
1162	=item $x_display = $term->display_id	1562	=item $x_display = $term->display_id
1163		1563
…		…
1170	=item $env = $term->env	1570	=item $env = $term->env
1171		1571
1172	Returns a copy of the environment in effect for the terminal as a hashref	1572	Returns a copy of the environment in effect for the terminal as a hashref
1173	similar to C<\%ENV>.	1573	similar to C<\%ENV>.
1174		1574
		1575	=item @envv = $term->envv
		1576
		1577	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1578
		1579	=item @argv = $term->argv
		1580
		1581	Return the argument vector as this terminal, similar to @ARGV, but
		1582	includes the program name as first element.
		1583
1175	=cut	1584	=cut
1176		1585
1177	sub env {	1586	sub env {
1178	if (my $env = $_[0]->_env) {
1179	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1587	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1180	} else {
1181	+{ %ENV }
1182	}
1183	}	1588	}
1184		1589
1185	=item $modifiermask = $term->ModLevel3Mask	1590	=item $modifiermask = $term->ModLevel3Mask
1186		1591
1187	=item $modifiermask = $term->ModMetaMask	1592	=item $modifiermask = $term->ModMetaMask
…		…
1189	=item $modifiermask = $term->ModNumLockMask	1594	=item $modifiermask = $term->ModNumLockMask
1190		1595
1191	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1596	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1192	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1597	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1193		1598
		1599	=item $screen = $term->current_screen
		1600
		1601	Returns the currently displayed screen (0 primary, 1 secondary).
		1602
		1603	=item $cursor_is_hidden = $term->hidden_cursor
		1604
		1605	Returns whether the cursor is currently hidden or not.
		1606
1194	=item $view_start = $term->view_start ([$newvalue])	1607	=item $view_start = $term->view_start ([$newvalue])
1195		1608
1196	Returns the negative row number of the topmost line. Minimum value is	1609	Returns the row number of the topmost displayed line. Maximum value is
1197	C<0>, which displays the normal terminal contents. Larger values scroll	1610	C<0>, which displays the normal terminal contents. Lower values scroll
1198	this many lines into the scrollback buffer.	1611	this many lines into the scrollback buffer.
1199		1612
1200	=item $term->want_refresh	1613	=item $term->want_refresh
1201		1614
1202	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1615	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1217	line, starting at column C<$start_col> (default C<0>), which is useful	1630	line, starting at column C<$start_col> (default C<0>), which is useful
1218	to replace only parts of a line. The font index in the rendition will	1631	to replace only parts of a line. The font index in the rendition will
1219	automatically be updated.	1632	automatically be updated.
1220		1633
1221	C<$text> is in a special encoding: tabs and wide characters that use more	1634	C<$text> is in a special encoding: tabs and wide characters that use more
1222	than one cell when displayed are padded with urxvt::NOCHAR characters	1635	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1223	(C<chr 65535>). Characters with combining characters and other characters	1636	characters. Characters with combining characters and other characters that
1224	that do not fit into the normal tetx encoding will be replaced with	1637	do not fit into the normal tetx encoding will be replaced with characters
1225	characters in the private use area.	1638	in the private use area.
1226		1639
1227	You have to obey this encoding when changing text. The advantage is	1640	You have to obey this encoding when changing text. The advantage is
1228	that C<substr> and similar functions work on screen cells and not on	1641	that C<substr> and similar functions work on screen cells and not on
1229	characters.	1642	characters.
1230		1643
…		…
1374	where one character corresponds to one screen cell. See	1787	where one character corresponds to one screen cell. See
1375	C<< $term->ROW_t >> for details.	1788	C<< $term->ROW_t >> for details.
1376		1789
1377	=item $string = $term->special_decode $text	1790	=item $string = $term->special_decode $text
1378		1791
1379	Converts rxvt-unicodes text reprsentation into a perl string. See	1792	Converts rxvt-unicodes text representation into a perl string. See
1380	C<< $term->ROW_t >> for details.	1793	C<< $term->ROW_t >> for details.
1381		1794
1382	=item $success = $term->grab_button ($button, $modifiermask)	1795	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1383		1796
		1797	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1798
1384	Registers a synchronous button grab. See the XGrabButton manpage.	1799	Register/unregister a synchronous button grab. See the XGrabButton
		1800	manpage.
1385		1801
1386	=item $success = $term->grab ($eventtime[, $sync])	1802	=item $success = $term->grab ($eventtime[, $sync])
1387		1803
1388	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1804	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1389	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1805	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1390		1806
1391	=item $term->allow_events_async	1807	=item $term->allow_events_async
1392		1808
1393	Calls XAllowEvents with AsyncBoth for the most recent grab.	1809	Calls XAllowEvents with AsyncBoth for the most recent grab.
1394		1810
…		…
1404	=item $term->ungrab	1820	=item $term->ungrab
1405		1821
1406	Calls XUngrab for the most recent grab. Is called automatically on	1822	Calls XUngrab for the most recent grab. Is called automatically on
1407	evaluation errors, as it is better to lose the grab in the error case as	1823	evaluation errors, as it is better to lose the grab in the error case as
1408	the session.	1824	the session.
		1825
		1826	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1827
		1828	=item $atom_name = $term->XGetAtomName ($atom)
		1829
		1830	=item @atoms = $term->XListProperties ($window)
		1831
		1832	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1833
		1834	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1835
		1836	=item $term->XDeleteProperty ($window, $property)
		1837
		1838	=item $window = $term->DefaultRootWindow
		1839
		1840	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1841
		1842	=item $term->XMapWindow ($window)
		1843
		1844	=item $term->XUnmapWindow ($window)
		1845
		1846	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1847
		1848	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1849
		1850	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1851
		1852	Various X or X-related functions. The C<$term> object only serves as
		1853	the source of the display, otherwise those functions map more-or-less
		1854	directory onto the X functions of the same name.
1409		1855
1410	=back	1856	=back
1411		1857
1412	=cut	1858	=cut
1413		1859
…		…
1477	my ($self, $text, $cb) = @_;	1923	my ($self, $text, $cb) = @_;
1478		1924
1479	$self->add_item ({ type => "button", text => $text, activate => $cb});	1925	$self->add_item ({ type => "button", text => $text, activate => $cb});
1480	}	1926	}
1481		1927
1482	=item $popup->add_toggle ($text, $cb, $initial_value)	1928	=item $popup->add_toggle ($text, $initial_value, $cb)
1483		1929
1484	Adds a toggle/checkbox item to the popup. Teh callback gets called	1930	Adds a toggle/checkbox item to the popup. The callback gets called
1485	whenever it gets toggled, with a boolean indicating its value as its first	1931	whenever it gets toggled, with a boolean indicating its new value as its
1486	argument.	1932	first argument.
1487		1933
1488	=cut	1934	=cut
1489		1935
1490	sub add_toggle {	1936	sub add_toggle {
1491	my ($self, $text, $cb, $value) = @_;	1937	my ($self, $text, $value, $cb) = @_;
1492		1938
1493	my $item; $item = {	1939	my $item; $item = {
1494	type => "button",	1940	type => "button",
1495	text => " $text",	1941	text => " $text",
1496	value => $value,	1942	value => $value,
…		…
1515	my $env = $self->{term}->env;	1961	my $env = $self->{term}->env;
1516	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1962	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1517	delete $env->{LC_ALL};	1963	delete $env->{LC_ALL};
1518	$env->{LC_CTYPE} = $self->{term}->locale;	1964	$env->{LC_CTYPE} = $self->{term}->locale;
1519		1965
1520	urxvt::term->new ($env, $self->{term}->resource ("name"),	1966	urxvt::term->new ($env, "popup",
1521	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1967	"--perl-lib" => "", "--perl-ext-common" => "",
		1968	"-pty-fd" => -1, "-sl" => 0,
		1969	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1522	"--transient-for" => $self->{term}->parent,	1970	"--transient-for" => $self->{term}->parent,
1523	"-display" => $self->{term}->display_id,	1971	"-display" => $self->{term}->display_id,
1524	"-pe" => "urxvt-popup")	1972	"-pe" => "urxvt-popup")
1525	or die "unable to create popup window\n";	1973	or die "unable to create popup window\n";
1526	}	1974	}
…		…
1531	delete $self->{term}{_destroy}{$self};	1979	delete $self->{term}{_destroy}{$self};
1532	$self->{term}->ungrab;	1980	$self->{term}->ungrab;
1533	}	1981	}
1534		1982
1535	=back	1983	=back
		1984
		1985	=cut
		1986
		1987	package urxvt::watcher;
1536		1988
1537	=head2 The C<urxvt::timer> Class	1989	=head2 The C<urxvt::timer> Class
1538		1990
1539	This class implements timer watchers/events. Time is represented as a	1991	This class implements timer watchers/events. Time is represented as a
1540	fractional number of seconds since the epoch. Example:	1992	fractional number of seconds since the epoch. Example:
…		…
1578	Start the timer.	2030	Start the timer.
1579		2031
1580	=item $timer = $timer->start ($tstamp)	2032	=item $timer = $timer->start ($tstamp)
1581		2033
1582	Set the event trigger time to C<$tstamp> and start the timer.	2034	Set the event trigger time to C<$tstamp> and start the timer.
		2035
		2036	=item $timer = $timer->after ($delay)
		2037
		2038	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1583		2039
1584	=item $timer = $timer->stop	2040	=item $timer = $timer->stop
1585		2041
1586	Stop the timer.	2042	Stop the timer.
1587		2043
…		…
1616	Set the callback to be called when io events are triggered. C<$reventmask>	2072	Set the callback to be called when io events are triggered. C<$reventmask>
1617	is a bitset as described in the C<events> method.	2073	is a bitset as described in the C<events> method.
1618		2074
1619	=item $iow = $iow->fd ($fd)	2075	=item $iow = $iow->fd ($fd)
1620		2076
1621	Set the filedescriptor (not handle) to watch.	2077	Set the file descriptor (not handle) to watch.
1622		2078
1623	=item $iow = $iow->events ($eventmask)	2079	=item $iow = $iow->events ($eventmask)
1624		2080
1625	Set the event mask to watch. The only allowed values are	2081	Set the event mask to watch. The only allowed values are
1626	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2082	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
…		…
1630		2086
1631	Start watching for requested events on the given handle.	2087	Start watching for requested events on the given handle.
1632		2088
1633	=item $iow = $iow->stop	2089	=item $iow = $iow->stop
1634		2090
1635	Stop watching for events on the given filehandle.	2091	Stop watching for events on the given file handle.
		2092
		2093	=back
		2094
		2095	=head2 The C<urxvt::iw> Class
		2096
		2097	This class implements idle watchers, that get called automatically when
		2098	the process is idle. They should return as fast as possible, after doing
		2099	some useful work.
		2100
		2101	=over 4
		2102
		2103	=item $iw = new urxvt::iw
		2104
		2105	Create a new idle watcher object in stopped state.
		2106
		2107	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2108
		2109	Set the callback to be called when the watcher triggers.
		2110
		2111	=item $timer = $timer->start
		2112
		2113	Start the watcher.
		2114
		2115	=item $timer = $timer->stop
		2116
		2117	Stop the watcher.
		2118
		2119	=back
		2120
		2121	=head2 The C<urxvt::pw> Class
		2122
		2123	This class implements process watchers. They create an event whenever a
		2124	process exits, after which they stop automatically.
		2125
		2126	my $pid = fork;
		2127	...
		2128	$term->{pw} = urxvt::pw
		2129	->new
		2130	->start ($pid)
		2131	->cb (sub {
		2132	my ($pw, $exit_status) = @_;
		2133	...
		2134	});
		2135
		2136	=over 4
		2137
		2138	=item $pw = new urxvt::pw
		2139
		2140	Create a new process watcher in stopped state.
		2141
		2142	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2143
		2144	Set the callback to be called when the timer triggers.
		2145
		2146	=item $pw = $timer->start ($pid)
		2147
		2148	Tells the watcher to start watching for process C<$pid>.
		2149
		2150	=item $pw = $pw->stop
		2151
		2152	Stop the watcher.
1636		2153
1637	=back	2154	=back
1638		2155
1639	=head1 ENVIRONMENT	2156	=head1 ENVIRONMENT
1640		2157
…		…
1649		2166
1650	=item >= 3 - script loading and management	2167	=item >= 3 - script loading and management
1651		2168
1652	=item >=10 - all called hooks	2169	=item >=10 - all called hooks
1653		2170
1654	=item >=11 - hook reutrn values	2171	=item >=11 - hook return values
1655		2172
1656	=back	2173	=back
1657		2174
1658	=head1 AUTHOR	2175	=head1 AUTHOR
1659		2176
…		…
1661	http://software.schmorp.de/pkg/rxvt-unicode	2178	http://software.schmorp.de/pkg/rxvt-unicode
1662		2179
1663	=cut	2180	=cut
1664		2181
1665	1	2182	1
		2183
		2184	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.89 by root, Thu Jan 12 12:10:06 2006 UTC vs. Revision 1.153 by root, Sat Jun 2 05:23:11 2007 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.89 by root, Thu Jan 12 12:10:06 2006 UTC vs.
Revision 1.153 by root, Sat Jun 2 05:23:11 2007 UTC