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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC vs.
Revision 1.144 by root, Mon Aug 7 15:59:44 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
…		…
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		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
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	49	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	50	now, it tries to select words, urls and complete shell-quoted
47	too, if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
		54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the following adds a regex that matches everything
		68	between two vertical bars:
		69
		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: ^(/[^:]+):\
		78
		79	You can look at the source of the selection extension to see more
		80	interesting uses, such as parsing a line from beginning to end.
		81
49	It also offers the following bindable keyboard command:	82	This extension also offers following bindable keyboard commands:
50		83
51	=over 4	84	=over 4
52		85
53	=item rot13	86	=item rot13
54		87
…		…
61	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
62		95
63	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
64	runtime.	97	runtime.
65		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
66	=item selection-popup (enabled by default)	116	=item selection-popup (enabled by default)
67		117
68	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
69	text into various other formats/action (such as uri unescaping, perl	119	text into various other formats/action (such as uri unescaping, perl
70	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	};
71		140
72	=item searchable-scrollback<hotkey> (enabled by default)	141	=item searchable-scrollback<hotkey> (enabled by default)
73		142
74	Adds regex search functionality to the scrollback buffer, triggered	143	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	145	input/output is suspended and a regex is displayed at the bottom of the
		146	screen.
77		147
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	148	Inputting characters appends them to the regex and continues incremental
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80	history, C<enter> leaves search mode at the current position and C<escape>	150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	151	bottom. C<Escape> leaves search mode and returns to the point where search
		152	was started, while C<Enter> or C<Return> stay at the current position and
		153	additionally stores the first match in the current line into the primary
		154	selection.
82		155
83	=item digital-clock	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.
84		159
85	Displays a digital clock using the built-in overlay.	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
		187	=item selection-autotransform
		188
		189	This selection allows you to do automatic transforms on a selection
		190	whenever a selection is made.
		191
		192	It works by specifying perl snippets (most useful is a single C<s///>
		193	operator) that modify C<$_> as resources:
		194
		195	URxvt.selection-autotransform.0: transform
		196	URxvt.selection-autotransform.1: transform
		197	...
		198
		199	For example, the following will transform selections of the form
		200	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		201	$word>:
		202
		203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		204
		205	And this example matches the same,but replaces it with vi-commands you can
		206	paste directly into your (vi :) editor:
		207
		208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		209
		210	Of course, this can be modified to suit your needs and your editor :)
		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.
86		244
87	=item mark-urls	245	=item mark-urls
88		246
89	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 urls and
90	make them clickable. When middle-clicked, the program specified in the	248	make them clickable. When middle-clicked, the program specified in the
91	resource C<urlLauncher> (default C<x-www-browser>) will be started.	249	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		250	the URL as first argument.
		251
		252	=item xim-onthespot
		253
		254	This (experimental) perl extension implements OnTheSpot editing. It does
		255	not work perfectly, and some input methods don't seem to work well with
		256	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		257	kinput2.
		258
		259	You enable it by specifying this extension and a preedit style of
		260	C<OnTheSpot>, i.e.:
		261
		262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		263
		264	=item kuake<hotkey>
		265
		266	A very primitive quake-console-like extension. It was inspired by a
		267	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		268	user presses a global accelerator key (by default C<F10>), the terminal
		269	will show or hide itself. Another press of the accelerator key will hide
		270	or show it again.
		271
		272	Initially, the window will not be shown when using this extension.
		273
		274	This is useful if you need a single terminal thats not using any desktop
		275	space most of the time but is quickly available at the press of a key.
		276
		277	The accelerator key is grabbed regardless of any modifiers, so this
		278	extension will actually grab a physical key just for this function.
		279
		280	If you want a quake-like animation, tell your window manager to do so
		281	(fvwm can do it).
		282
		283	=item automove-background
		284
		285	This is basically a very small extension that dynamically changes the
		286	background pixmap offset to the window position, in effect creating the
		287	same effect as pseudo transparency with a custom pixmap. No scaling is
		288	supported in this mode. Example:
		289
		290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
92		291
93	=item block-graphics-to-ascii	292	=item block-graphics-to-ascii
94		293
95	A not very useful example of filtering all text output to the terminal,	294	A not very useful example of filtering all text output to the terminal
96	by replacing all line-drawing characters (U+2500 .. U+259F) by a	295	by replacing all line-drawing characters (U+2500 .. U+259F) by a
97	similar-looking ascii character.	296	similar-looking ascii character.
		297
		298	=item digital-clock
		299
		300	Displays a digital clock using the built-in overlay.
		301
		302	=item remote-clipboard
		303
		304	Somewhat of a misnomer, this extension adds two menu entries to the
		305	selection popup that allows one ti run external commands to store the
		306	selection somewhere and fetch it again.
		307
		308	We use it to implement a "distributed selection mechanism", which just
		309	means that one command uploads the file to a remote server, and another
		310	reads it.
		311
		312	The commands can be set using the C<URxvt.remote-selection.store> and
		313	C<URxvt.remote-selection.fetch> resources. The first should read the
		314	selection to store from STDIN (always in UTF-8), the second should provide
		315	the selection data on STDOUT (also in UTF-8).
		316
		317	The defaults (which are likely useless to you) use rsh and cat:
		318
		319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		321
		322	=item selection-pastebin
		323
		324	This is a little rarely useful extension that Uploads the selection as
		325	textfile to a remote site (or does other things). (The implementation is
		326	not currently secure for use in a multiuser environment as it writes to
		327	F</tmp> directly.).
		328
		329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		330	i.e.
		331
		332	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		333
		334	Pressing this combination runs a command with C<%> replaced by the name of
		335	the textfile. This command can be set via a resource:
		336
		337	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		338
		339	And the default is likely not useful to anybody but the few people around
		340	here :)
		341
		342	The name of the textfile is the hex encoded md5 sum of the selection, so
		343	the same content should lead to the same filename.
		344
		345	After a successful upload the selection will be replaced by the text given
		346	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		347	for the filename):
		348
		349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
98		350
99	=item example-refresh-hooks	351	=item example-refresh-hooks
100		352
101	Displays a very simple digital clock in the upper right corner of the	353	Displays a very simple digital clock in the upper right corner of the
102	window. Illustrates overwriting the refresh callbacks to create your own	354	window. Illustrates overwriting the refresh callbacks to create your own
…		…
142		394
143	=back	395	=back
144		396
145	=head2 Extension Objects	397	=head2 Extension Objects
146		398
147	Very perl extension is a perl class. A separate perl object is created	399	Every perl extension is a perl class. A separate perl object is created
148	for each terminal and each extension and passed as the first parameter to	400	for each terminal and each extension and passed as the first parameter to
149	hooks. So extensions can use their C<$self> object without having to think	401	hooks. So extensions can use their C<$self> object without having to think
150	about other extensions, with the exception of methods and members that	402	about other extensions, with the exception of methods and members that
151	begin with an underscore character C<_>: these are reserved for internal	403	begin with an underscore character C<_>: these are reserved for internal
152	use.	404	use.
…		…
178	=head2 Hooks	430	=head2 Hooks
179		431
180	The following subroutines can be declared in extension files, and will be	432	The following subroutines can be declared in extension files, and will be
181	called whenever the relevant event happens.	433	called whenever the relevant event happens.
182		434
183	The first argument passed to them is an extension oject as described in	435	The first argument passed to them is an extension object as described in
184	the in the C<Extension Objects> section.	436	the in the C<Extension Objects> section.
185		437
186	B<All> of these hooks must return a boolean value. If it is true, then the	438	B<All> of these hooks must return a boolean value. If any of the called
187	event counts as being I<consumed>, and the invocation of other hooks is	439	hooks returns true, then the event counts as being I<consumed>, and the
188	skipped, and the relevant action might not be carried out by the C++ code.	440	relevant action might not be carried out by the C++ code.
189		441
190	I<< When in doubt, return a false value (preferably C<()>). >>	442	I<< When in doubt, return a false value (preferably C<()>). >>
191		443
192	=over 4	444	=over 4
193		445
194	=item on_init $term	446	=item on_init $term
195		447
196	Called after a new terminal object has been initialized, but before	448	Called after a new terminal object has been initialized, but before
197	windows are created or the command gets run. Most methods are unsafe to	449	windows are created or the command gets run. Most methods are unsafe to
198	call or deliver senseless data, as terminal size and other characteristics	450	call or deliver senseless data, as terminal size and other characteristics
199	have not yet been determined. You can safely query and change resources,	451	have not yet been determined. You can safely query and change resources
200	though.	452	and options, though. For many purposes the C<on_start> hook is a better
		453	place.
		454
		455	=item on_start $term
		456
		457	Called at the very end of initialisation of a new terminal, just before
		458	trying to map (display) the toplevel and returning to the main loop.
		459
		460	=item on_destroy $term
		461
		462	Called whenever something tries to destroy terminal, when the terminal is
		463	still fully functional (not for long, though).
201		464
202	=item on_reset $term	465	=item on_reset $term
203		466
204	Called after the screen is "reset" for any reason, such as resizing or	467	Called after the screen is "reset" for any reason, such as resizing or
205	control sequences. Here is where you can react on changes to size-related	468	control sequences. Here is where you can react on changes to size-related
206	variables.	469	variables.
207		470
208	=item on_start $term	471	=item on_child_start $term, $pid
209		472
210	Called at the very end of initialisation of a new terminal, just before	473	Called just after the child process has been C<fork>ed.
211	returning to the mainloop.	474
		475	=item on_child_exit $term, $status
		476
		477	Called just after the child process has exited. C<$status> is the status
		478	from C<waitpid>.
212		479
213	=item on_sel_make $term, $eventtime	480	=item on_sel_make $term, $eventtime
214		481
215	Called whenever a selection has been made by the user, but before the	482	Called whenever a selection has been made by the user, but before the
216	selection text is copied, so changes to the beginning, end or type of the	483	selection text is copied, so changes to the beginning, end or type of the
…		…
223		490
224	Called whenever a selection has been copied, but before the selection is	491	Called whenever a selection has been copied, but before the selection is
225	requested from the server. The selection text can be queried and changed	492	requested from the server. The selection text can be queried and changed
226	by calling C<< $term->selection >>.	493	by calling C<< $term->selection >>.
227		494
228	Returning a true value aborts selection grabbing. It will still be hilighted.	495	Returning a true value aborts selection grabbing. It will still be highlighted.
229		496
230	=item on_sel_extend $term	497	=item on_sel_extend $term
231		498
232	Called whenever the user tries to extend the selection (e.g. with a double	499	Called whenever the user tries to extend the selection (e.g. with a double
233	click) and is either supposed to return false (normal operation), or	500	click) and is either supposed to return false (normal operation), or
234	should extend the selection itelf and return true to suppress the built-in	501	should extend the selection itself and return true to suppress the built-in
235	processing.	502	processing. This can happen multiple times, as long as the callback
		503	returns true, it will be called on every further click by the user and is
		504	supposed to enlarge the selection more and more, if possible.
236		505
237	See the F<selection> example extension.	506	See the F<selection> example extension.
238		507
239	=item on_view_change $term, $offset	508	=item on_view_change $term, $offset
240		509
241	Called whenever the view offset changes, i..e the user or program	510	Called whenever the view offset changes, i.e. the user or program
242	scrolls. Offset C<0> means display the normal terminal, positive values	511	scrolls. Offset C<0> means display the normal terminal, positive values
243	show this many lines of scrollback.	512	show this many lines of scrollback.
244		513
245	=item on_scroll_back $term, $lines, $saved	514	=item on_scroll_back $term, $lines, $saved
246		515
…		…
250		519
251	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	520	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
252	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	521	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
253	number of lines that will be in the scrollback buffer.	522	number of lines that will be in the scrollback buffer.
254		523
		524	=item on_osc_seq $term, $op, $args
		525
		526	Called on every OSC sequence and can be used to suppress it or modify its
		527	behaviour. The default should be to return an empty list. A true value
		528	suppresses execution of the request completely. Make sure you don't get
		529	confused by recursive invocations when you output an osc sequence within
		530	this callback.
		531
		532	C<on_osc_seq_perl> should be used for new behaviour.
		533
255	=item on_osc_seq $term, $string	534	=item on_osc_seq_perl $term, $string
256		535
257	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	536	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
258	operating system command) is processed. Cursor position and other state	537	operating system command) is processed. Cursor position and other state
259	information is up-to-date when this happens. For interoperability, the	538	information is up-to-date when this happens. For interoperability, the
260	string should start with the extension name and a colon, to distinguish	539	string should start with the extension name and a colon, to distinguish
261	it from commands for other extensions, and this might be enforced in the	540	it from commands for other extensions, and this might be enforced in the
262	future.	541	future.
263		542
264	Be careful not ever to trust (in a security sense) the data you receive,	543	Be careful not ever to trust (in a security sense) the data you receive,
265	as its source can not easily be controleld (e-mail content, messages from	544	as its source can not easily be controlled (e-mail content, messages from
266	other users on the same system etc.).	545	other users on the same system etc.).
267		546
268	=item on_add_lines $term, $string	547	=item on_add_lines $term, $string
269		548
270	Called whenever text is about to be output, with the text as argument. You	549	Called whenever text is about to be output, with the text as argument. You
…		…
301		580
302	=item on_refresh_end $term	581	=item on_refresh_end $term
303		582
304	Called just after the screen gets redrawn. See C<on_refresh_begin>.	583	Called just after the screen gets redrawn. See C<on_refresh_begin>.
305		584
306	=item on_keyboard_command $term, $string	585	=item on_user_command $term, $string
307		586
308	Called whenever the user presses a key combination that has a	587	Called whenever a user-configured event is being activated (e.g. via
309	C<perl:string> action bound to it (see description of the B<keysym>	588	a C<perl:string> action bound to a key, see description of the B<keysym>
310	resource in the @@RXVT_NAME@@(1) manpage).	589	resource in the @@RXVT_NAME@@(1) manpage).
		590
		591	The event is simply the action string. This interface is assumed to change
		592	slightly in the future.
		593
		594	=item on_resize_all_windows $tern, $new_width, $new_height
		595
		596	Called just after the new window size has been calculated, but before
		597	windows are actually being resized or hints are being set. If this hook
		598	returns TRUE, setting of the window hints is being skipped.
		599
		600	=item on_x_event $term, $event
		601
		602	Called on every X event received on the vt window (and possibly other
		603	windows). Should only be used as a last resort. Most event structure
		604	members are not passed.
		605
		606	=item on_root_event $term, $event
		607
		608	Like C<on_x_event>, but is called for events on the root window.
311		609
312	=item on_focus_in $term	610	=item on_focus_in $term
313		611
314	Called whenever the window gets the keyboard focus, before rxvt-unicode	612	Called whenever the window gets the keyboard focus, before rxvt-unicode
315	does focus in processing.	613	does focus in processing.
316		614
317	=item on_focus_out $term	615	=item on_focus_out $term
318		616
319	Called wheneever the window loses keyboard focus, before rxvt-unicode does	617	Called whenever the window loses keyboard focus, before rxvt-unicode does
320	focus out processing.	618	focus out processing.
		619
		620	=item on_configure_notify $term, $event
		621
		622	=item on_property_notify $term, $event
321		623
322	=item on_key_press $term, $event, $keysym, $octets	624	=item on_key_press $term, $event, $keysym, $octets
323		625
324	=item on_key_release $term, $event, $keysym	626	=item on_key_release $term, $event, $keysym
325		627
…		…
335		637
336	Called whenever the corresponding X event is received for the terminal If	638	Called whenever the corresponding X event is received for the terminal If
337	the hook returns true, then the even will be ignored by rxvt-unicode.	639	the hook returns true, then the even will be ignored by rxvt-unicode.
338		640
339	The event is a hash with most values as named by Xlib (see the XEvent	641	The event is a hash with most values as named by Xlib (see the XEvent
340	manpage), with the additional members C<row> and C<col>, which are the row	642	manpage), with the additional members C<row> and C<col>, which are the
341	and column under the mouse cursor.	643	(real, not screen-based) row and column under the mouse cursor.
342		644
343	C<on_key_press> additionally receives the string rxvt-unicode would	645	C<on_key_press> additionally receives the string rxvt-unicode would
344	output, if any, in locale-specific encoding.	646	output, if any, in locale-specific encoding.
345		647
346	subwindow.	648	subwindow.
		649
		650	=item on_client_message $term, $event
		651
		652	=item on_wm_protocols $term, $event
		653
		654	=item on_wm_delete_window $term, $event
		655
		656	Called when various types of ClientMessage events are received (all with
		657	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
347		658
348	=back	659	=back
349		660
350	=cut	661	=cut
351		662
…		…
357	use Scalar::Util ();	668	use Scalar::Util ();
358	use List::Util ();	669	use List::Util ();
359		670
360	our $VERSION = 1;	671	our $VERSION = 1;
361	our $TERM;	672	our $TERM;
		673	our @TERM_INIT;
		674	our @TERM_EXT;
362	our @HOOKNAME;	675	our @HOOKNAME;
363	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	676	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364	our %OPTION;	677	our %OPTION;
365		678
366	our $LIBDIR;	679	our $LIBDIR;
367	our $RESNAME;	680	our $RESNAME;
368	our $RESCLASS;	681	our $RESCLASS;
369	our $RXVTNAME;	682	our $RXVTNAME;
370		683
		684	our $NOCHAR = chr 0xffff;
		685
371	=head2 Variables in the C<urxvt> Package	686	=head2 Variables in the C<urxvt> Package
372		687
373	=over 4	688	=over 4
374		689
375	=item $urxvt::LIBDIR	690	=item $urxvt::LIBDIR
…		…
387		702
388	=item $urxvt::TERM	703	=item $urxvt::TERM
389		704
390	The current terminal. This variable stores the current C<urxvt::term>	705	The current terminal. This variable stores the current C<urxvt::term>
391	object, whenever a callback/hook is executing.	706	object, whenever a callback/hook is executing.
		707
		708	=item @urxvt::TERM_INIT
		709
		710	All code references in this array will be called as methods of the next newly
		711	created C<urxvt::term> object (during the C<on_init> phase). The array
		712	gets cleared before the code references that were in it are being executed,
		713	so references can push themselves onto it again if they so desire.
		714
		715	This complements to the perl-eval command line option, but gets executed
		716	first.
		717
		718	=item @urxvt::TERM_EXT
		719
		720	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		721	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		722	but before other extensions. Gets cleared just like C<@TERM_INIT>.
392		723
393	=back	724	=back
394		725
395	=head2 Functions in the C<urxvt> Package	726	=head2 Functions in the C<urxvt> Package
396		727
…		…
411	Using this function has the advantage that its output ends up in the	742	Using this function has the advantage that its output ends up in the
412	correct place, e.g. on stderr of the connecting urxvtc client.	743	correct place, e.g. on stderr of the connecting urxvtc client.
413		744
414	Messages have a size limit of 1023 bytes currently.	745	Messages have a size limit of 1023 bytes currently.
415		746
416	=item $is_safe = urxvt::safe	747	=item @terms = urxvt::termlist
417		748
418	Returns true when it is safe to do potentially unsafe things, such as	749	Returns all urxvt::term objects that exist in this process, regardless of
419	evaluating perl code specified by the user. This is true when urxvt was	750	whether they are started, being destroyed etc., so be careful. Only term
420	started setuid or setgid.	751	objects that have perl extensions attached will be returned (because there
		752	is no urxvt::term objet associated with others).
421		753
422	=item $time = urxvt::NOW	754	=item $time = urxvt::NOW
423		755
424	Returns the "current time" (as per the event loop).	756	Returns the "current time" (as per the event loop).
425		757
426	=item urxvt::CurrentTime	758	=item urxvt::CurrentTime
427		759
428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	760	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	761	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430	Button4Mask, Button5Mask, AnyModifier	762	Button4Mask, Button5Mask, AnyModifier
		763
		764	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		765	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		766	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		767	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		768	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		769	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		770	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		771
		772	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		773	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		774	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		775	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		776	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		777	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		778	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431		779
432	Various constants for use in X calls and event processing.	780	Various constants for use in X calls and event processing.
433		781
434	=back	782	=back
435		783
…		…
468		816
469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	817	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
470		818
471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	819	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
472		820
		821	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		822
473	Replace the foreground/background colour in the rendition mask with the	823	Replace the foreground/background colour in the rendition mask with the
474	specified one.	824	specified one.
475		825
476	=item $value = urxvt::GET_CUSTOM $rend	826	=item $value = urxvt::GET_CUSTOM $rend
477		827
…		…
486	=back	836	=back
487		837
488	=cut	838	=cut
489		839
490	BEGIN {	840	BEGIN {
491	urxvt->bootstrap;
492
493	# overwrite perl's warn	841	# overwrite perl's warn
494	*CORE::GLOBAL::warn = sub {	842	*CORE::GLOBAL::warn = sub {
495	my $msg = join "", @_;	843	my $msg = join "", @_;
496	$msg .= "\n"	844	$msg .= "\n"
497	unless $msg =~ /\n$/;	845	unless $msg =~ /\n$/;
498	urxvt::warn ($msg);	846	urxvt::warn ($msg);
499	};	847	};
500
501	# %ENV is the original startup environment
502	delete $ENV{IFS};
503	delete $ENV{CDPATH};
504	delete $ENV{BASH_ENV};
505	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
506	}	848	}
507		849
508	my @hook_count;	850	no warnings 'utf8';
		851
509	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	852	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
510		853
511	sub verbose {	854	sub verbose {
512	my ($level, $msg) = @_;	855	my ($level, $msg) = @_;
513	warn "$msg\n" if $level <= $verbosity;	856	warn "$msg\n" if $level <= $verbosity;
514	}	857	}
515		858
516	my $extension_pkg = "extension0000";
517	my %extension_pkg;	859	my %extension_pkg;
518		860
519	# load a single script into its own package, once only	861	# load a single script into its own package, once only
520	sub extension_package($) {	862	sub extension_package($) {
521	my ($path) = @_;	863	my ($path) = @_;
522		864
523	$extension_pkg{$path} \|\|= do {	865	$extension_pkg{$path} \|\|= do {
524	my $pkg = "urxvt::" . ($extension_pkg++);	866	$path =~ /([^\/\\]+)$/;
		867	my $pkg = $1;
		868	$pkg =~ s/[^[:word:]]/_/g;
		869	$pkg = "urxvt::ext::$pkg";
525		870
526	verbose 3, "loading extension '$path' into package '$pkg'";	871	verbose 3, "loading extension '$path' into package '$pkg'";
527		872
528	open my $fh, "<:raw", $path	873	open my $fh, "<:raw", $path
529	or die "$path: $!";	874	or die "$path: $!";
530		875
531	my $source = untaint	876	my $source =
532	"package $pkg; use strict; use utf8;\n"	877	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
533	. "use base urxvt::term::extension::;\n"
534	. "#line 1 \"$path\"\n{\n"	878	. "#line 1 \"$path\"\n{\n"
535	. (do { local $/; <$fh> })	879	. (do { local $/; <$fh> })
536	. "\n};\n1";	880	. "\n};\n1";
537		881
538	eval $source	882	eval $source
…		…
552	if ($htype == 0) { # INIT	896	if ($htype == 0) { # INIT
553	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	897	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
554		898
555	my %ext_arg;	899	my %ext_arg;
556		900
		901	{
		902	my @init = @TERM_INIT;
		903	@TERM_INIT = ();
		904	$_->($TERM) for @init;
		905	my @pkg = @TERM_EXT;
		906	@TERM_EXT = ();
		907	$TERM->register_package ($_) for @pkg;
		908	}
		909
557	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	910	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
558	if ($_ eq "default") {	911	if ($_ eq "default") {
559	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	912	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
560	} elsif (/^-(.*)$/) {	913	} elsif (/^-(.*)$/) {
561	delete $ext_arg{$1};	914	delete $ext_arg{$1};
562	} elsif (/^([^<]+)<(.*)>$/) {	915	} elsif (/^([^<]+)<(.*)>$/) {
563	push @{ $ext_arg{$1} }, $2;	916	push @{ $ext_arg{$1} }, $2;
564	} else {	917	} else {
565	$ext_arg{$_} \|\|= [];	918	$ext_arg{$_} \|\|= [];
566	}	919	}
567	}	920	}
568		921
569	while (my ($ext, $argv) = each %ext_arg) {	922	for my $ext (sort keys %ext_arg) {
570	my @files = grep -f $_, map "$_/$ext", @dirs;	923	my @files = grep -f $_, map "$_/$ext", @dirs;
571		924
572	if (@files) {	925	if (@files) {
573	$TERM->register_package (extension_package $files[0], $argv);	926	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
574	} else {	927	} else {
575	warn "perl extension '$ext' not found in perl library search path\n";	928	warn "perl extension '$ext' not found in perl library search path\n";
576	}	929	}
577	}	930	}
578		931
…		…
584		937
585	if (my $cb = $TERM->{_hook}[$htype]) {	938	if (my $cb = $TERM->{_hook}[$htype]) {
586	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	939	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
587	if $verbosity >= 10;	940	if $verbosity >= 10;
588		941
589	keys %$cb;	942	for my $pkg (keys %$cb) {
590
591	while (my ($pkg, $cb) = each %$cb) {
592	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	943	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
593	and last;	944	$retval \|\|= $retval_;
594		945
595	if ($@) {	946	if ($@) {
596	$TERM->ungrab; # better to lose the grab than the session	947	$TERM->ungrab; # better to lose the grab than the session
597	warn $@;	948	warn $@;
598	}	949	}
599	}	950	}
		951
		952	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		953	if $verbosity >= 11;
600	}	954	}
601		955
602	if ($htype == 1) { # DESTROY	956	if ($htype == 1) { # DESTROY
603	if (my $hook = delete $TERM->{_hook}) {
604	for my $htype (0..$#$hook) {
605	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
606	or set_should_invoke $htype, 0;
607	}
608	}
609
610	# clear package objects	957	# clear package objects
611	%$_ = () for values %{ $TERM->{_pkg} };	958	%$_ = () for values %{ $TERM->{_pkg} };
612		959
613	# clear package	960	# clear package
614	%$TERM = ();	961	%$TERM = ();
615	}	962	}
616		963
617	$retval	964	$retval
618	}	965	}
619		966
620	sub exec_async(@) {	967	sub SET_COLOR($$$) {
621	my $pid = fork;	968	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
622
623	return
624	if !defined $pid or $pid;
625
626	%ENV = %{ $TERM->env };
627
628	exec @_;
629	_exit 255;
630	}	969	}
631		970
632	# urxvt::term::extension	971	# urxvt::term::extension
633		972
634	package urxvt::term::extension;	973	package urxvt::term::extension;
…		…
640	while (my ($name, $cb) = each %hook) {	979	while (my ($name, $cb) = each %hook) {
641	my $htype = $HOOKTYPE{uc $name};	980	my $htype = $HOOKTYPE{uc $name};
642	defined $htype	981	defined $htype
643	or Carp::croak "unsupported hook type '$name'";	982	or Carp::croak "unsupported hook type '$name'";
644		983
		984	$self->set_should_invoke ($htype, +1)
645	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	985	unless exists $self->{term}{_hook}[$htype]{$pkg};
646	$hook_count[$htype]++
647	or urxvt::set_should_invoke $htype, 1;
648	}
649		986
650	$self->{term}{_hook}[$htype]{$pkg} = $cb;	987	$self->{term}{_hook}[$htype]{$pkg} = $cb;
651	}	988	}
652	}	989	}
653		990
…		…
658	for my $name (@hook) {	995	for my $name (@hook) {
659	my $htype = $HOOKTYPE{uc $name};	996	my $htype = $HOOKTYPE{uc $name};
660	defined $htype	997	defined $htype
661	or Carp::croak "unsupported hook type '$name'";	998	or Carp::croak "unsupported hook type '$name'";
662		999
		1000	$self->set_should_invoke ($htype, -1)
663	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1001	if delete $self->{term}{_hook}[$htype]{$pkg};
664	--$hook_count[$htype]
665	or urxvt::set_should_invoke $htype, 0;
666	}
667	}	1002	}
668	}	1003	}
669		1004
670	our $AUTOLOAD;	1005	our $AUTOLOAD;
671		1006
…		…
777	# find on_xxx subs in the package and register them	1112	# find on_xxx subs in the package and register them
778	# as hooks	1113	# as hooks
779	sub register_package {	1114	sub register_package {
780	my ($self, $pkg, $argv) = @_;	1115	my ($self, $pkg, $argv) = @_;
781		1116
		1117	no strict 'refs';
		1118
		1119	urxvt::verbose 6, "register package $pkg to $self";
		1120
		1121	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1122
782	my $proxy = bless {	1123	my $proxy = bless {
783	_pkg => $pkg,	1124	_pkg => $pkg,
784	argv => $argv,	1125	argv => $argv,
785	}, $pkg;	1126	}, $pkg;
786	Scalar::Util::weaken ($proxy->{term} = $self);	1127	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
801	hash which defines the environment of the new terminal.	1142	hash which defines the environment of the new terminal.
802		1143
803	Croaks (and probably outputs an error message) if the new instance	1144	Croaks (and probably outputs an error message) if the new instance
804	couldn't be created. Returns C<undef> if the new instance didn't	1145	couldn't be created. Returns C<undef> if the new instance didn't
805	initialise perl, and the terminal object otherwise. The C<init> and	1146	initialise perl, and the terminal object otherwise. The C<init> and
806	C<start> hooks will be called during this call.	1147	C<start> hooks will be called before this call returns, and are free to
		1148	refer to global data (which is race free).
807		1149
808	=cut	1150	=cut
809		1151
810	sub new {	1152	sub new {
811	my ($class, $env, @args) = @_;	1153	my ($class, $env, @args) = @_;
812		1154
		1155	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1156	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1157
813	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1158	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
814	}	1159	}
815		1160
816	=item $term->destroy	1161	=item $term->destroy
817		1162
818	Destroy the terminal object (close the window, free resources	1163	Destroy the terminal object (close the window, free resources
819	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1164	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
820	watchers (timers, io watchers) are still active.	1165	watchers (timers, io watchers) are still active.
821		1166
		1167	=item $term->exec_async ($cmd[, @args])
		1168
		1169	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1170	("starts") programs in the background. This function takes care of setting
		1171	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1172	be preferred over explicit calls to C<exec> or C<system>.
		1173
		1174	Returns the pid of the subprocess or C<undef> on error.
		1175
		1176	=cut
		1177
		1178	sub exec_async {
		1179	my $self = shift;
		1180
		1181	my $pid = fork;
		1182
		1183	return $pid
		1184	if !defined $pid or $pid;
		1185
		1186	%ENV = %{ $self->env };
		1187
		1188	exec @_;
		1189	urxvt::_exit 255;
		1190	}
		1191
822	=item $isset = $term->option ($optval[, $set])	1192	=item $isset = $term->option ($optval[, $set])
823		1193
824	Returns true if the option specified by C<$optval> is enabled, and	1194	Returns true if the option specified by C<$optval> is enabled, and
825	optionally change it. All option values are stored by name in the hash	1195	optionally change it. All option values are stored by name in the hash
826	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1196	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
827		1197
828	Here is a a likely non-exhaustive list of option names, please see the	1198	Here is a likely non-exhaustive list of option names, please see the
829	source file F</src/optinc.h> to see the actual list:	1199	source file F</src/optinc.h> to see the actual list:
830		1200
831	borderLess console cursorBlink cursorUnderline hold iconic insecure	1201	borderLess console cursorBlink cursorUnderline hold iconic insecure
832	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1202	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
833	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1203	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
834	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1204	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
835	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1205	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
836	tripleclickwords utmpInhibit visualBell	1206	transparent tripleclickwords utmpInhibit visualBell
837		1207
838	=item $value = $term->resource ($name[, $newval])	1208	=item $value = $term->resource ($name[, $newval])
839		1209
840	Returns the current resource value associated with a given name and	1210	Returns the current resource value associated with a given name and
841	optionally sets a new value. Setting values is most useful in the C<init>	1211	optionally sets a new value. Setting values is most useful in the C<init>
…		…
850	likely change).	1220	likely change).
851		1221
852	Please note that resource strings will currently only be freed when the	1222	Please note that resource strings will currently only be freed when the
853	terminal is destroyed, so changing options frequently will eat memory.	1223	terminal is destroyed, so changing options frequently will eat memory.
854		1224
855	Here is a a likely non-exhaustive list of resource names, not all of which	1225	Here is a likely non-exhaustive list of resource names, not all of which
856	are supported in every build, please see the source file F</src/rsinc.h>	1226	are supported in every build, please see the source file F</src/rsinc.h>
857	to see the actual list:	1227	to see the actual list:
858		1228
859	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1229	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
860	borderLess color cursorBlink cursorUnderline cutchars delete_key	1230	borderLess color cursorBlink cursorUnderline cutchars delete_key
861	display_name embed ext_bwidth fade font geometry hold iconName	1231	display_name embed ext_bwidth fade font geometry hold iconName
862	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1232	imFont imLocale inputMethod insecure int_bwidth intensityStyles
863	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1233	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
864	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1234	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
865	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1235	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
866	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1236	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
867	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1237	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
868	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1238	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
869	shade term_name title transparent transparent_all tripleclickwords	1239	secondaryScreen secondaryScroll selectstyle shade term_name title
870	utmpInhibit visualBell	1240	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1241	visualBell
871		1242
872	=cut	1243	=cut
873		1244
874	sub resource($$;$) {	1245	sub resource($$;$) {
875	my ($self, $name) = (shift, shift);	1246	my ($self, $name) = (shift, shift);
…		…
910	=item ($row, $col) = $term->selection_end ([$row, $col])	1281	=item ($row, $col) = $term->selection_end ([$row, $col])
911		1282
912	Return the current values of the selection mark, begin or end positions,	1283	Return the current values of the selection mark, begin or end positions,
913	and optionally set them to new values.	1284	and optionally set them to new values.
914		1285
		1286	=item $term->selection_make ($eventtime[, $rectangular])
		1287
		1288	Tries to make a selection as set by C<selection_beg> and
		1289	C<selection_end>. If C<$rectangular> is true (default: false), a
		1290	rectangular selection will be made. This is the prefered function to make
		1291	a selection.
		1292
915	=item $success = $term->selection_grab ($eventtime)	1293	=item $success = $term->selection_grab ($eventtime)
916		1294
917	Try to request the primary selection from the server (for example, as set	1295	Try to request the primary selection text from the server (for example, as
918	by the next method).	1296	set by the next method). No visual feedback will be given. This function
		1297	is mostly useful from within C<on_sel_grab> hooks.
919		1298
920	=item $oldtext = $term->selection ([$newtext])	1299	=item $oldtext = $term->selection ([$newtext])
921		1300
922	Return the current selection text and optionally replace it by C<$newtext>.	1301	Return the current selection text and optionally replace it by C<$newtext>.
923		1302
…		…
1016	Convert the given locale-encoded octets into a perl string.	1395	Convert the given locale-encoded octets into a perl string.
1017		1396
1018	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1397	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1019		1398
1020	XORs the rendition values in the given span with the provided value	1399	XORs the rendition values in the given span with the provided value
1021	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1400	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1022	to the selection.	1401	refresh hooks to provide effects similar to the selection.
1023		1402
1024	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1403	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1025		1404
1026	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1405	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1027	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1406	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1028	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1407	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
1029	it instead.	1408	it instead. Both styles I<MUST NOT> contain font styles.
1030		1409
1031	=item $term->scr_bell	1410	=item $term->scr_bell
1032		1411
1033	Ring the bell!	1412	Ring the bell!
1034		1413
…		…
1041		1420
1042	Normally its not a good idea to use this function, as programs might be	1421	Normally its not a good idea to use this function, as programs might be
1043	confused by changes in cursor position or scrolling. Its useful inside a	1422	confused by changes in cursor position or scrolling. Its useful inside a
1044	C<on_add_lines> hook, though.	1423	C<on_add_lines> hook, though.
1045		1424
		1425	=item $term->scr_change_screen ($screen)
		1426
		1427	Switch to given screen - 0 primary, 1 secondary.
		1428
1046	=item $term->cmd_parse ($octets)	1429	=item $term->cmd_parse ($octets)
1047		1430
1048	Similar to C<scr_add_lines>, but the argument must be in the	1431	Similar to C<scr_add_lines>, but the argument must be in the
1049	locale-specific encoding of the terminal and can contain command sequences	1432	locale-specific encoding of the terminal and can contain command sequences
1050	(escape codes) that will be interpreted.	1433	(escape codes) that will be interpreted.
…		…
1060	Replaces the event mask of the pty watcher by the given event mask. Can	1443	Replaces the event mask of the pty watcher by the given event mask. Can
1061	be used to suppress input and output handling to the pty/tty. See the	1444	be used to suppress input and output handling to the pty/tty. See the
1062	description of C<< urxvt::timer->events >>. Make sure to always restore	1445	description of C<< urxvt::timer->events >>. Make sure to always restore
1063	the previous value.	1446	the previous value.
1064		1447
		1448	=item $fd = $term->pty_fd
		1449
		1450	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1451	is used.
		1452
1065	=item $windowid = $term->parent	1453	=item $windowid = $term->parent
1066		1454
1067	Return the window id of the toplevel window.	1455	Return the window id of the toplevel window.
1068		1456
1069	=item $windowid = $term->vt	1457	=item $windowid = $term->vt
1070		1458
1071	Return the window id of the terminal window.	1459	Return the window id of the terminal window.
1072		1460
		1461	=item $term->vt_emask_add ($x_event_mask)
		1462
		1463	Adds the specified events to the vt event mask. Useful e.g. when you want
		1464	to receive pointer events all the times:
		1465
		1466	$term->vt_emask_add (urxvt::PointerMotionMask);
		1467
		1468	=item $term->focus_in
		1469
		1470	=item $term->focus_out
		1471
		1472	=item $term->key_press ($state, $keycode[, $time])
		1473
		1474	=item $term->key_release ($state, $keycode[, $time])
		1475
		1476	Deliver various fake events to to terminal.
		1477
1073	=item $window_width = $term->width	1478	=item $window_width = $term->width
1074		1479
1075	=item $window_height = $term->height	1480	=item $window_height = $term->height
1076		1481
1077	=item $font_width = $term->fwidth	1482	=item $font_width = $term->fwidth
…		…
1090		1495
1091	=item $max_scrollback = $term->saveLines	1496	=item $max_scrollback = $term->saveLines
1092		1497
1093	=item $nrow_plus_saveLines = $term->total_rows	1498	=item $nrow_plus_saveLines = $term->total_rows
1094		1499
1095	=item $lines_in_scrollback = $term->nsaved	1500	=item $topmost_scrollback_row = $term->top_row
1096		1501
1097	Return various integers describing terminal characteristics.	1502	Return various integers describing terminal characteristics.
1098		1503
1099	=item $x_display = $term->display_id	1504	=item $x_display = $term->display_id
1100		1505
…		…
1107	=item $env = $term->env	1512	=item $env = $term->env
1108		1513
1109	Returns a copy of the environment in effect for the terminal as a hashref	1514	Returns a copy of the environment in effect for the terminal as a hashref
1110	similar to C<\%ENV>.	1515	similar to C<\%ENV>.
1111		1516
		1517	=item @envv = $term->envv
		1518
		1519	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1520
		1521	=item @argv = $term->argv
		1522
		1523	Return the argument vector as this terminal, similar to @ARGV, but
		1524	includes the program name as first element.
		1525
1112	=cut	1526	=cut
1113		1527
1114	sub env {	1528	sub env {
1115	if (my $env = $_[0]->_env) {
1116	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1529	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1117	} else {
1118	+{ %ENV }
1119	}
1120	}	1530	}
1121		1531
1122	=item $modifiermask = $term->ModLevel3Mask	1532	=item $modifiermask = $term->ModLevel3Mask
1123		1533
1124	=item $modifiermask = $term->ModMetaMask	1534	=item $modifiermask = $term->ModMetaMask
…		…
1126	=item $modifiermask = $term->ModNumLockMask	1536	=item $modifiermask = $term->ModNumLockMask
1127		1537
1128	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1538	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1129	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1539	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1130		1540
		1541	=item $screen = $term->current_screen
		1542
		1543	Returns the currently displayed screen (0 primary, 1 secondary).
		1544
		1545	=item $cursor_is_hidden = $term->hidden_cursor
		1546
		1547	Returns whether the cursor is currently hidden or not.
		1548
1131	=item $view_start = $term->view_start ([$newvalue])	1549	=item $view_start = $term->view_start ([$newvalue])
1132		1550
1133	Returns the negative row number of the topmost line. Minimum value is	1551	Returns the row number of the topmost displayed line. Maximum value is
1134	C<0>, which displays the normal terminal contents. Larger values scroll	1552	C<0>, which displays the normal terminal contents. Lower values scroll
1135	this many lines into the scrollback buffer.	1553	this many lines into the scrollback buffer.
1136		1554
1137	=item $term->want_refresh	1555	=item $term->want_refresh
1138		1556
1139	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1557	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1154	line, starting at column C<$start_col> (default C<0>), which is useful	1572	line, starting at column C<$start_col> (default C<0>), which is useful
1155	to replace only parts of a line. The font index in the rendition will	1573	to replace only parts of a line. The font index in the rendition will
1156	automatically be updated.	1574	automatically be updated.
1157		1575
1158	C<$text> is in a special encoding: tabs and wide characters that use more	1576	C<$text> is in a special encoding: tabs and wide characters that use more
1159	than one cell when displayed are padded with urxvt::NOCHAR characters	1577	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1160	(C<chr 65535>). Characters with combining characters and other characters	1578	characters. Characters with combining characters and other characters that
1161	that do not fit into the normal tetx encoding will be replaced with	1579	do not fit into the normal tetx encoding will be replaced with characters
1162	characters in the private use area.	1580	in the private use area.
1163		1581
1164	You have to obey this encoding when changing text. The advantage is	1582	You have to obey this encoding when changing text. The advantage is
1165	that C<substr> and similar functions work on screen cells and not on	1583	that C<substr> and similar functions work on screen cells and not on
1166	characters.	1584	characters.
1167		1585
…		…
1218	Return the row number of the first/last row of the line, respectively.	1636	Return the row number of the first/last row of the line, respectively.
1219		1637
1220	=item $offset = $line->offset_of ($row, $col)	1638	=item $offset = $line->offset_of ($row, $col)
1221		1639
1222	Returns the character offset of the given row\|col pair within the logical	1640	Returns the character offset of the given row\|col pair within the logical
1223	line.	1641	line. Works for rows outside the line, too, and returns corresponding
		1642	offsets outside the string.
1224		1643
1225	=item ($row, $col) = $line->coord_of ($offset)	1644	=item ($row, $col) = $line->coord_of ($offset)
1226		1645
1227	Translates a string offset into terminal coordinates again.	1646	Translates a string offset into terminal coordinates again.
1228		1647
…		…
1310	where one character corresponds to one screen cell. See	1729	where one character corresponds to one screen cell. See
1311	C<< $term->ROW_t >> for details.	1730	C<< $term->ROW_t >> for details.
1312		1731
1313	=item $string = $term->special_decode $text	1732	=item $string = $term->special_decode $text
1314		1733
1315	Converts rxvt-unicodes text reprsentation into a perl string. See	1734	Converts rxvt-unicodes text representation into a perl string. See
1316	C<< $term->ROW_t >> for details.	1735	C<< $term->ROW_t >> for details.
1317		1736
1318	=item $success = $term->grab_button ($button, $modifiermask)	1737	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1319		1738
		1739	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1740
1320	Registers a synchronous button grab. See the XGrabButton manpage.	1741	Register/unregister a synchronous button grab. See the XGrabButton
		1742	manpage.
1321		1743
1322	=item $success = $term->grab ($eventtime[, $sync])	1744	=item $success = $term->grab ($eventtime[, $sync])
1323		1745
1324	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1746	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1325	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1747	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1326		1748
1327	=item $term->allow_events_async	1749	=item $term->allow_events_async
1328		1750
1329	Calls XAllowEvents with AsyncBoth for the most recent grab.	1751	Calls XAllowEvents with AsyncBoth for the most recent grab.
1330		1752
…		…
1340	=item $term->ungrab	1762	=item $term->ungrab
1341		1763
1342	Calls XUngrab for the most recent grab. Is called automatically on	1764	Calls XUngrab for the most recent grab. Is called automatically on
1343	evaluation errors, as it is better to lose the grab in the error case as	1765	evaluation errors, as it is better to lose the grab in the error case as
1344	the session.	1766	the session.
		1767
		1768	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1769
		1770	=item $atom_name = $term->XGetAtomName ($atom)
		1771
		1772	=item @atoms = $term->XListProperties ($window)
		1773
		1774	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1775
		1776	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1777
		1778	=item $term->XDeleteProperty ($window, $property)
		1779
		1780	=item $window = $term->DefaultRootWindow
		1781
		1782	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1783
		1784	=item $term->XMapWindow ($window)
		1785
		1786	=item $term->XUnmapWindow ($window)
		1787
		1788	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1789
		1790	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1791
		1792	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1793
		1794	Various X or X-related functions. The C<$term> object only serves as
		1795	the source of the display, otherwise those functions map more-or-less
		1796	directory onto the X functions of the same name.
1345		1797
1346	=back	1798	=back
1347		1799
1348	=cut	1800	=cut
1349		1801
…		…
1413	my ($self, $text, $cb) = @_;	1865	my ($self, $text, $cb) = @_;
1414		1866
1415	$self->add_item ({ type => "button", text => $text, activate => $cb});	1867	$self->add_item ({ type => "button", text => $text, activate => $cb});
1416	}	1868	}
1417		1869
1418	=item $popup->add_toggle ($text, $cb, $initial_value)	1870	=item $popup->add_toggle ($text, $initial_value, $cb)
1419		1871
1420	Adds a toggle/checkbox item to the popup. Teh callback gets called	1872	Adds a toggle/checkbox item to the popup. The callback gets called
1421	whenever it gets toggled, with a boolean indicating its value as its first	1873	whenever it gets toggled, with a boolean indicating its new value as its
1422	argument.	1874	first argument.
1423		1875
1424	=cut	1876	=cut
1425		1877
1426	sub add_toggle {	1878	sub add_toggle {
1427	my ($self, $text, $cb, $value) = @_;	1879	my ($self, $text, $value, $cb) = @_;
1428		1880
1429	my $item; $item = {	1881	my $item; $item = {
1430	type => "button",	1882	type => "button",
1431	text => " $text",	1883	text => " $text",
1432	value => $value,	1884	value => $value,
…		…
1451	my $env = $self->{term}->env;	1903	my $env = $self->{term}->env;
1452	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1904	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1453	delete $env->{LC_ALL};	1905	delete $env->{LC_ALL};
1454	$env->{LC_CTYPE} = $self->{term}->locale;	1906	$env->{LC_CTYPE} = $self->{term}->locale;
1455		1907
1456	urxvt::term->new ($env, $self->{term}->resource ("name"),	1908	urxvt::term->new ($env, "popup",
1457	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1909	"--perl-lib" => "", "--perl-ext-common" => "",
		1910	"-pty-fd" => -1, "-sl" => 0,
		1911	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1458	"--transient-for" => $self->{term}->parent,	1912	"--transient-for" => $self->{term}->parent,
1459	"-display" => $self->{term}->display_id,	1913	"-display" => $self->{term}->display_id,
1460	"-pe" => "urxvt-popup")	1914	"-pe" => "urxvt-popup")
1461	or die "unable to create popup window\n";	1915	or die "unable to create popup window\n";
1462	}	1916	}
…		…
1467	delete $self->{term}{_destroy}{$self};	1921	delete $self->{term}{_destroy}{$self};
1468	$self->{term}->ungrab;	1922	$self->{term}->ungrab;
1469	}	1923	}
1470		1924
1471	=back	1925	=back
		1926
		1927	=cut
		1928
		1929	package urxvt::watcher;
		1930
		1931	@urxvt::timer::ISA = __PACKAGE__;
		1932	@urxvt::iow::ISA = __PACKAGE__;
		1933	@urxvt::pw::ISA = __PACKAGE__;
		1934	@urxvt::iw::ISA = __PACKAGE__;
1472		1935
1473	=head2 The C<urxvt::timer> Class	1936	=head2 The C<urxvt::timer> Class
1474		1937
1475	This class implements timer watchers/events. Time is represented as a	1938	This class implements timer watchers/events. Time is represented as a
1476	fractional number of seconds since the epoch. Example:	1939	fractional number of seconds since the epoch. Example:
…		…
1514	Start the timer.	1977	Start the timer.
1515		1978
1516	=item $timer = $timer->start ($tstamp)	1979	=item $timer = $timer->start ($tstamp)
1517		1980
1518	Set the event trigger time to C<$tstamp> and start the timer.	1981	Set the event trigger time to C<$tstamp> and start the timer.
		1982
		1983	=item $timer = $timer->after ($delay)
		1984
		1985	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1519		1986
1520	=item $timer = $timer->stop	1987	=item $timer = $timer->stop
1521		1988
1522	Stop the timer.	1989	Stop the timer.
1523		1990
…		…
1552	Set the callback to be called when io events are triggered. C<$reventmask>	2019	Set the callback to be called when io events are triggered. C<$reventmask>
1553	is a bitset as described in the C<events> method.	2020	is a bitset as described in the C<events> method.
1554		2021
1555	=item $iow = $iow->fd ($fd)	2022	=item $iow = $iow->fd ($fd)
1556		2023
1557	Set the filedescriptor (not handle) to watch.	2024	Set the file descriptor (not handle) to watch.
1558		2025
1559	=item $iow = $iow->events ($eventmask)	2026	=item $iow = $iow->events ($eventmask)
1560		2027
1561	Set the event mask to watch. The only allowed values are	2028	Set the event mask to watch. The only allowed values are
1562	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2029	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
…		…
1566		2033
1567	Start watching for requested events on the given handle.	2034	Start watching for requested events on the given handle.
1568		2035
1569	=item $iow = $iow->stop	2036	=item $iow = $iow->stop
1570		2037
1571	Stop watching for events on the given filehandle.	2038	Stop watching for events on the given file handle.
		2039
		2040	=back
		2041
		2042	=head2 The C<urxvt::iw> Class
		2043
		2044	This class implements idle watchers, that get called automatically when
		2045	the process is idle. They should return as fast as possible, after doing
		2046	some useful work.
		2047
		2048	=over 4
		2049
		2050	=item $iw = new urxvt::iw
		2051
		2052	Create a new idle watcher object in stopped state.
		2053
		2054	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2055
		2056	Set the callback to be called when the watcher triggers.
		2057
		2058	=item $timer = $timer->start
		2059
		2060	Start the watcher.
		2061
		2062	=item $timer = $timer->stop
		2063
		2064	Stop the watcher.
		2065
		2066	=back
		2067
		2068	=head2 The C<urxvt::pw> Class
		2069
		2070	This class implements process watchers. They create an event whenever a
		2071	process exits, after which they stop automatically.
		2072
		2073	my $pid = fork;
		2074	...
		2075	$term->{pw} = urxvt::pw
		2076	->new
		2077	->start ($pid)
		2078	->cb (sub {
		2079	my ($pw, $exit_status) = @_;
		2080	...
		2081	});
		2082
		2083	=over 4
		2084
		2085	=item $pw = new urxvt::pw
		2086
		2087	Create a new process watcher in stopped state.
		2088
		2089	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2090
		2091	Set the callback to be called when the timer triggers.
		2092
		2093	=item $pw = $timer->start ($pid)
		2094
		2095	Tells the watcher to start watching for process C<$pid>.
		2096
		2097	=item $pw = $pw->stop
		2098
		2099	Stop the watcher.
1572		2100
1573	=back	2101	=back
1574		2102
1575	=head1 ENVIRONMENT	2103	=head1 ENVIRONMENT
1576		2104
…		…
1583		2111
1584	=item == 0 - fatal messages	2112	=item == 0 - fatal messages
1585		2113
1586	=item >= 3 - script loading and management	2114	=item >= 3 - script loading and management
1587		2115
1588	=item >=10 - all events received	2116	=item >=10 - all called hooks
		2117
		2118	=item >=11 - hook return values
1589		2119
1590	=back	2120	=back
1591		2121
1592	=head1 AUTHOR	2122	=head1 AUTHOR
1593		2123

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC vs. Revision 1.144 by root, Mon Aug 7 15:59:44 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC vs.
Revision 1.144 by root, Mon Aug 7 15:59:44 2006 UTC