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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.82 by root, Thu Jan 12 01:30:53 2006 UTC vs.
Revision 1.146 by root, Thu Aug 17 21:56:11 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 clicked, the program specified in the resource	248	make them clickable. When middle-clicked, the program specified in the
91	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/%
		350
		351	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		352	the double C</> characters as comment start. Use C<\057\057> instead,
		353	which works regardless of wether xrdb is used to parse the resource file
		354	or not.
98		355
99	=item example-refresh-hooks	356	=item example-refresh-hooks
100		357
101	Displays a very simple digital clock in the upper right corner of the	358	Displays a very simple digital clock in the upper right corner of the
102	window. Illustrates overwriting the refresh callbacks to create your own	359	window. Illustrates overwriting the refresh callbacks to create your own
…		…
142		399
143	=back	400	=back
144		401
145	=head2 Extension Objects	402	=head2 Extension Objects
146		403
147	Very perl extension is a perl class. A separate perl object is created	404	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	405	for each terminal, and each terminal has its own set of extenion objects,
149	hooks. So extensions can use their C<$self> object without having to think	406	which are passed as the first parameter to hooks. So extensions can use
150	about other extensions, with the exception of methods and members that	407	their C<$self> object without having to think about clashes with other
		408	extensions or other terminals, with the exception of methods and members
151	begin with an underscore character C<_>: these are reserved for internal	409	that begin with an underscore character C<_>: these are reserved for
152	use.	410	internal use.
153		411
154	Although it isn't a C<urxvt::term> object, you can call all methods of the	412	Although it isn't a C<urxvt::term> object, you can call all methods of the
155	C<urxvt::term> class on this object.	413	C<urxvt::term> class on this object.
156		414
157	It has the following methods and data members:	415	It has the following methods and data members:
…		…
178	=head2 Hooks	436	=head2 Hooks
179		437
180	The following subroutines can be declared in extension files, and will be	438	The following subroutines can be declared in extension files, and will be
181	called whenever the relevant event happens.	439	called whenever the relevant event happens.
182		440
183	The first argument passed to them is an extension oject as described in	441	The first argument passed to them is an extension object as described in
184	the in the C<Extension Objects> section.	442	the in the C<Extension Objects> section.
185		443
186	B<All> of these hooks must return a boolean value. If it is true, then the	444	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	445	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.	446	relevant action might not be carried out by the C++ code.
189		447
190	I<< When in doubt, return a false value (preferably C<()>). >>	448	I<< When in doubt, return a false value (preferably C<()>). >>
191		449
192	=over 4	450	=over 4
193		451
194	=item on_init $term	452	=item on_init $term
195		453
196	Called after a new terminal object has been initialized, but before	454	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	455	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	456	call or deliver senseless data, as terminal size and other characteristics
199	have not yet been determined. You can safely query and change resources,	457	have not yet been determined. You can safely query and change resources
200	though.	458	and options, though. For many purposes the C<on_start> hook is a better
		459	place.
		460
		461	=item on_start $term
		462
		463	Called at the very end of initialisation of a new terminal, just before
		464	trying to map (display) the toplevel and returning to the main loop.
		465
		466	=item on_destroy $term
		467
		468	Called whenever something tries to destroy terminal, when the terminal is
		469	still fully functional (not for long, though).
201		470
202	=item on_reset $term	471	=item on_reset $term
203		472
204	Called after the screen is "reset" for any reason, such as resizing or	473	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	474	control sequences. Here is where you can react on changes to size-related
206	variables.	475	variables.
207		476
208	=item on_start $term	477	=item on_child_start $term, $pid
209		478
210	Called at the very end of initialisation of a new terminal, just before	479	Called just after the child process has been C<fork>ed.
211	returning to the mainloop.	480
		481	=item on_child_exit $term, $status
		482
		483	Called just after the child process has exited. C<$status> is the status
		484	from C<waitpid>.
212		485
213	=item on_sel_make $term, $eventtime	486	=item on_sel_make $term, $eventtime
214		487
215	Called whenever a selection has been made by the user, but before the	488	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	489	selection text is copied, so changes to the beginning, end or type of the
…		…
223		496
224	Called whenever a selection has been copied, but before the selection is	497	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	498	requested from the server. The selection text can be queried and changed
226	by calling C<< $term->selection >>.	499	by calling C<< $term->selection >>.
227		500
228	Returning a true value aborts selection grabbing. It will still be hilighted.	501	Returning a true value aborts selection grabbing. It will still be highlighted.
229		502
230	=item on_sel_extend $term	503	=item on_sel_extend $term
231		504
232	Called whenever the user tries to extend the selection (e.g. with a double	505	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	506	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	507	should extend the selection itself and return true to suppress the built-in
235	processing.	508	processing. This can happen multiple times, as long as the callback
		509	returns true, it will be called on every further click by the user and is
		510	supposed to enlarge the selection more and more, if possible.
236		511
237	See the F<selection> example extension.	512	See the F<selection> example extension.
238		513
239	=item on_view_change $term, $offset	514	=item on_view_change $term, $offset
240		515
241	Called whenever the view offset changes, i..e the user or program	516	Called whenever the view offset changes, i.e. the user or program
242	scrolls. Offset C<0> means display the normal terminal, positive values	517	scrolls. Offset C<0> means display the normal terminal, positive values
243	show this many lines of scrollback.	518	show this many lines of scrollback.
244		519
245	=item on_scroll_back $term, $lines, $saved	520	=item on_scroll_back $term, $lines, $saved
246		521
…		…
250		525
251	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	526	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	527	$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.	528	number of lines that will be in the scrollback buffer.
254		529
		530	=item on_osc_seq $term, $op, $args
		531
		532	Called on every OSC sequence and can be used to suppress it or modify its
		533	behaviour. The default should be to return an empty list. A true value
		534	suppresses execution of the request completely. Make sure you don't get
		535	confused by recursive invocations when you output an osc sequence within
		536	this callback.
		537
		538	C<on_osc_seq_perl> should be used for new behaviour.
		539
255	=item on_osc_seq $term, $string	540	=item on_osc_seq_perl $term, $string
256		541
257	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	542	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
258	operating system command) is processed. Cursor position and other state	543	operating system command) is processed. Cursor position and other state
259	information is up-to-date when this happens. For interoperability, the	544	information is up-to-date when this happens. For interoperability, the
260	string should start with the extension name and a colon, to distinguish	545	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	546	it from commands for other extensions, and this might be enforced in the
262	future.	547	future.
263		548
264	Be careful not ever to trust (in a security sense) the data you receive,	549	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	550	as its source can not easily be controlled (e-mail content, messages from
266	other users on the same system etc.).	551	other users on the same system etc.).
267		552
268	=item on_add_lines $term, $string	553	=item on_add_lines $term, $string
269		554
270	Called whenever text is about to be output, with the text as argument. You	555	Called whenever text is about to be output, with the text as argument. You
…		…
301		586
302	=item on_refresh_end $term	587	=item on_refresh_end $term
303		588
304	Called just after the screen gets redrawn. See C<on_refresh_begin>.	589	Called just after the screen gets redrawn. See C<on_refresh_begin>.
305		590
306	=item on_keyboard_command $term, $string	591	=item on_user_command $term, $string
307		592
308	Called whenever the user presses a key combination that has a	593	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>	594	a C<perl:string> action bound to a key, see description of the B<keysym>
310	resource in the @@RXVT_NAME@@(1) manpage).	595	resource in the @@RXVT_NAME@@(1) manpage).
		596
		597	The event is simply the action string. This interface is assumed to change
		598	slightly in the future.
		599
		600	=item on_resize_all_windows $tern, $new_width, $new_height
		601
		602	Called just after the new window size has been calculated, but before
		603	windows are actually being resized or hints are being set. If this hook
		604	returns TRUE, setting of the window hints is being skipped.
		605
		606	=item on_x_event $term, $event
		607
		608	Called on every X event received on the vt window (and possibly other
		609	windows). Should only be used as a last resort. Most event structure
		610	members are not passed.
		611
		612	=item on_root_event $term, $event
		613
		614	Like C<on_x_event>, but is called for events on the root window.
311		615
312	=item on_focus_in $term	616	=item on_focus_in $term
313		617
314	Called whenever the window gets the keyboard focus, before rxvt-unicode	618	Called whenever the window gets the keyboard focus, before rxvt-unicode
315	does focus in processing.	619	does focus in processing.
316		620
317	=item on_focus_out $term	621	=item on_focus_out $term
318		622
319	Called wheneever the window loses keyboard focus, before rxvt-unicode does	623	Called whenever the window loses keyboard focus, before rxvt-unicode does
320	focus out processing.	624	focus out processing.
		625
		626	=item on_configure_notify $term, $event
		627
		628	=item on_property_notify $term, $event
321		629
322	=item on_key_press $term, $event, $keysym, $octets	630	=item on_key_press $term, $event, $keysym, $octets
323		631
324	=item on_key_release $term, $event, $keysym	632	=item on_key_release $term, $event, $keysym
325		633
…		…
335		643
336	Called whenever the corresponding X event is received for the terminal If	644	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.	645	the hook returns true, then the even will be ignored by rxvt-unicode.
338		646
339	The event is a hash with most values as named by Xlib (see the XEvent	647	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	648	manpage), with the additional members C<row> and C<col>, which are the
341	and column under the mouse cursor.	649	(real, not screen-based) row and column under the mouse cursor.
342		650
343	C<on_key_press> additionally receives the string rxvt-unicode would	651	C<on_key_press> additionally receives the string rxvt-unicode would
344	output, if any, in locale-specific encoding.	652	output, if any, in locale-specific encoding.
345		653
346	subwindow.	654	subwindow.
		655
		656	=item on_client_message $term, $event
		657
		658	=item on_wm_protocols $term, $event
		659
		660	=item on_wm_delete_window $term, $event
		661
		662	Called when various types of ClientMessage events are received (all with
		663	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
347		664
348	=back	665	=back
349		666
350	=cut	667	=cut
351		668
…		…
357	use Scalar::Util ();	674	use Scalar::Util ();
358	use List::Util ();	675	use List::Util ();
359		676
360	our $VERSION = 1;	677	our $VERSION = 1;
361	our $TERM;	678	our $TERM;
		679	our @TERM_INIT;
		680	our @TERM_EXT;
362	our @HOOKNAME;	681	our @HOOKNAME;
363	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	682	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364	our %OPTION;	683	our %OPTION;
365		684
366	our $LIBDIR;	685	our $LIBDIR;
367	our $RESNAME;	686	our $RESNAME;
368	our $RESCLASS;	687	our $RESCLASS;
369	our $RXVTNAME;	688	our $RXVTNAME;
370		689
		690	our $NOCHAR = chr 0xffff;
		691
371	=head2 Variables in the C<urxvt> Package	692	=head2 Variables in the C<urxvt> Package
372		693
373	=over 4	694	=over 4
374		695
375	=item $urxvt::LIBDIR	696	=item $urxvt::LIBDIR
…		…
387		708
388	=item $urxvt::TERM	709	=item $urxvt::TERM
389		710
390	The current terminal. This variable stores the current C<urxvt::term>	711	The current terminal. This variable stores the current C<urxvt::term>
391	object, whenever a callback/hook is executing.	712	object, whenever a callback/hook is executing.
		713
		714	=item @urxvt::TERM_INIT
		715
		716	All code references in this array will be called as methods of the next newly
		717	created C<urxvt::term> object (during the C<on_init> phase). The array
		718	gets cleared before the code references that were in it are being executed,
		719	so references can push themselves onto it again if they so desire.
		720
		721	This complements to the perl-eval command line option, but gets executed
		722	first.
		723
		724	=item @urxvt::TERM_EXT
		725
		726	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		727	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		728	but before other extensions. Gets cleared just like C<@TERM_INIT>.
392		729
393	=back	730	=back
394		731
395	=head2 Functions in the C<urxvt> Package	732	=head2 Functions in the C<urxvt> Package
396		733
…		…
411	Using this function has the advantage that its output ends up in the	748	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.	749	correct place, e.g. on stderr of the connecting urxvtc client.
413		750
414	Messages have a size limit of 1023 bytes currently.	751	Messages have a size limit of 1023 bytes currently.
415		752
416	=item $is_safe = urxvt::safe	753	=item @terms = urxvt::termlist
417		754
418	Returns true when it is safe to do potentially unsafe things, such as	755	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	756	whether they are started, being destroyed etc., so be careful. Only term
420	started setuid or setgid.	757	objects that have perl extensions attached will be returned (because there
		758	is no urxvt::term objet associated with others).
421		759
422	=item $time = urxvt::NOW	760	=item $time = urxvt::NOW
423		761
424	Returns the "current time" (as per the event loop).	762	Returns the "current time" (as per the event loop).
425		763
426	=item urxvt::CurrentTime	764	=item urxvt::CurrentTime
427		765
428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	766	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	767	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430	Button4Mask, Button5Mask, AnyModifier	768	Button4Mask, Button5Mask, AnyModifier
		769
		770	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		771	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		772	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		773	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		774	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		775	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		776	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		777
		778	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		779	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		780	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		781	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		782	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		783	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		784	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431		785
432	Various constants for use in X calls and event processing.	786	Various constants for use in X calls and event processing.
433		787
434	=back	788	=back
435		789
…		…
468		822
469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	823	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
470		824
471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	825	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
472		826
		827	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		828
473	Replace the foreground/background colour in the rendition mask with the	829	Replace the foreground/background colour in the rendition mask with the
474	specified one.	830	specified one.
475		831
476	=item $value = urxvt::GET_CUSTOM $rend	832	=item $value = urxvt::GET_CUSTOM $rend
477		833
…		…
486	=back	842	=back
487		843
488	=cut	844	=cut
489		845
490	BEGIN {	846	BEGIN {
491	urxvt->bootstrap;
492
493	# overwrite perl's warn	847	# overwrite perl's warn
494	*CORE::GLOBAL::warn = sub {	848	*CORE::GLOBAL::warn = sub {
495	my $msg = join "", @_;	849	my $msg = join "", @_;
496	$msg .= "\n"	850	$msg .= "\n"
497	unless $msg =~ /\n$/;	851	unless $msg =~ /\n$/;
498	urxvt::warn ($msg);	852	urxvt::warn ($msg);
499	};	853	};
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	}	854	}
507		855
508	my @hook_count;	856	no warnings 'utf8';
		857
509	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	858	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
510		859
511	sub verbose {	860	sub verbose {
512	my ($level, $msg) = @_;	861	my ($level, $msg) = @_;
513	warn "$msg\n" if $level <= $verbosity;	862	warn "$msg\n" if $level <= $verbosity;
514	}	863	}
515		864
516	my $extension_pkg = "extension0000";
517	my %extension_pkg;	865	my %extension_pkg;
518		866
519	# load a single script into its own package, once only	867	# load a single script into its own package, once only
520	sub extension_package($) {	868	sub extension_package($) {
521	my ($path) = @_;	869	my ($path) = @_;
522		870
523	$extension_pkg{$path} \|\|= do {	871	$extension_pkg{$path} \|\|= do {
524	my $pkg = "urxvt::" . ($extension_pkg++);	872	$path =~ /([^\/\\]+)$/;
		873	my $pkg = $1;
		874	$pkg =~ s/[^[:word:]]/_/g;
		875	$pkg = "urxvt::ext::$pkg";
525		876
526	verbose 3, "loading extension '$path' into package '$pkg'";	877	verbose 3, "loading extension '$path' into package '$pkg'";
527		878
528	open my $fh, "<:raw", $path	879	open my $fh, "<:raw", $path
529	or die "$path: $!";	880	or die "$path: $!";
530		881
531	my $source = untaint	882	my $source =
532	"package $pkg; use strict; use utf8;\n"	883	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
533	. "use base urxvt::term::extension::;\n"
534	. "#line 1 \"$path\"\n{\n"	884	. "#line 1 \"$path\"\n{\n"
535	. (do { local $/; <$fh> })	885	. (do { local $/; <$fh> })
536	. "\n};\n1";	886	. "\n};\n1";
537		887
538	eval $source	888	eval $source
…		…
552	if ($htype == 0) { # INIT	902	if ($htype == 0) { # INIT
553	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	903	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
554		904
555	my %ext_arg;	905	my %ext_arg;
556		906
		907	{
		908	my @init = @TERM_INIT;
		909	@TERM_INIT = ();
		910	$_->($TERM) for @init;
		911	my @pkg = @TERM_EXT;
		912	@TERM_EXT = ();
		913	$TERM->register_package ($_) for @pkg;
		914	}
		915
557	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	916	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
558	if ($_ eq "default") {	917	if ($_ eq "default") {
559	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	918	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
560	} elsif (/^-(.*)$/) {	919	} elsif (/^-(.*)$/) {
561	delete $ext_arg{$1};	920	delete $ext_arg{$1};
562	} elsif (/^([^<]+)<(.*)>$/) {	921	} elsif (/^([^<]+)<(.*)>$/) {
563	push @{ $ext_arg{$1} }, $2;	922	push @{ $ext_arg{$1} }, $2;
564	} else {	923	} else {
565	$ext_arg{$_} \|\|= [];	924	$ext_arg{$_} \|\|= [];
566	}	925	}
567	}	926	}
568		927
569	while (my ($ext, $argv) = each %ext_arg) {	928	for my $ext (sort keys %ext_arg) {
570	my @files = grep -f $_, map "$_/$ext", @dirs;	929	my @files = grep -f $_, map "$_/$ext", @dirs;
571		930
572	if (@files) {	931	if (@files) {
573	$TERM->register_package (extension_package $files[0], $argv);	932	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
574	} else {	933	} else {
575	warn "perl extension '$ext' not found in perl library search path\n";	934	warn "perl extension '$ext' not found in perl library search path\n";
576	}	935	}
577	}	936	}
578		937
…		…
584		943
585	if (my $cb = $TERM->{_hook}[$htype]) {	944	if (my $cb = $TERM->{_hook}[$htype]) {
586	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	945	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
587	if $verbosity >= 10;	946	if $verbosity >= 10;
588		947
589	keys %$cb;	948	for my $pkg (keys %$cb) {
590
591	while (my ($pkg, $cb) = each %$cb) {
592	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	949	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
593	and last;	950	$retval \|\|= $retval_;
594		951
595	if ($@) {	952	if ($@) {
596	$TERM->ungrab; # better to lose the grab than the session	953	$TERM->ungrab; # better to lose the grab than the session
597	warn $@;	954	warn $@;
598	}	955	}
599	}	956	}
		957
		958	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		959	if $verbosity >= 11;
600	}	960	}
601		961
602	if ($htype == 1) { # DESTROY	962	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	963	# clear package objects
611	%$_ = () for values %{ $TERM->{_pkg} };	964	%$_ = () for values %{ $TERM->{_pkg} };
612		965
613	# clear package	966	# clear package
614	%$TERM = ();	967	%$TERM = ();
615	}	968	}
616		969
617	$retval	970	$retval
		971	}
		972
		973	sub SET_COLOR($$$) {
		974	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
618	}	975	}
619		976
620	# urxvt::term::extension	977	# urxvt::term::extension
621		978
622	package urxvt::term::extension;	979	package urxvt::term::extension;
…		…
628	while (my ($name, $cb) = each %hook) {	985	while (my ($name, $cb) = each %hook) {
629	my $htype = $HOOKTYPE{uc $name};	986	my $htype = $HOOKTYPE{uc $name};
630	defined $htype	987	defined $htype
631	or Carp::croak "unsupported hook type '$name'";	988	or Carp::croak "unsupported hook type '$name'";
632		989
		990	$self->set_should_invoke ($htype, +1)
633	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	991	unless exists $self->{term}{_hook}[$htype]{$pkg};
634	$hook_count[$htype]++
635	or urxvt::set_should_invoke $htype, 1;
636	}
637		992
638	$self->{term}{_hook}[$htype]{$pkg} = $cb;	993	$self->{term}{_hook}[$htype]{$pkg} = $cb;
639	}	994	}
640	}	995	}
641		996
…		…
646	for my $name (@hook) {	1001	for my $name (@hook) {
647	my $htype = $HOOKTYPE{uc $name};	1002	my $htype = $HOOKTYPE{uc $name};
648	defined $htype	1003	defined $htype
649	or Carp::croak "unsupported hook type '$name'";	1004	or Carp::croak "unsupported hook type '$name'";
650		1005
		1006	$self->set_should_invoke ($htype, -1)
651	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1007	if delete $self->{term}{_hook}[$htype]{$pkg};
652	--$hook_count[$htype]
653	or urxvt::set_should_invoke $htype, 0;
654	}
655	}	1008	}
656	}	1009	}
657		1010
658	our $AUTOLOAD;	1011	our $AUTOLOAD;
659		1012
…		…
765	# find on_xxx subs in the package and register them	1118	# find on_xxx subs in the package and register them
766	# as hooks	1119	# as hooks
767	sub register_package {	1120	sub register_package {
768	my ($self, $pkg, $argv) = @_;	1121	my ($self, $pkg, $argv) = @_;
769		1122
		1123	no strict 'refs';
		1124
		1125	urxvt::verbose 6, "register package $pkg to $self";
		1126
		1127	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1128
770	my $proxy = bless {	1129	my $proxy = bless {
771	_pkg => $pkg,	1130	_pkg => $pkg,
772	argv => $argv,	1131	argv => $argv,
773	}, $pkg;	1132	}, $pkg;
774	Scalar::Util::weaken ($proxy->{term} = $self);	1133	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
789	hash which defines the environment of the new terminal.	1148	hash which defines the environment of the new terminal.
790		1149
791	Croaks (and probably outputs an error message) if the new instance	1150	Croaks (and probably outputs an error message) if the new instance
792	couldn't be created. Returns C<undef> if the new instance didn't	1151	couldn't be created. Returns C<undef> if the new instance didn't
793	initialise perl, and the terminal object otherwise. The C<init> and	1152	initialise perl, and the terminal object otherwise. The C<init> and
794	C<start> hooks will be called during this call.	1153	C<start> hooks will be called before this call returns, and are free to
		1154	refer to global data (which is race free).
795		1155
796	=cut	1156	=cut
797		1157
798	sub new {	1158	sub new {
799	my ($class, $env, @args) = @_;	1159	my ($class, $env, @args) = @_;
800		1160
		1161	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1162	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1163
801	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1164	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
802	}	1165	}
803		1166
804	=item $term->destroy	1167	=item $term->destroy
805		1168
806	Destroy the terminal object (close the window, free resources	1169	Destroy the terminal object (close the window, free resources
807	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1170	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
808	watchers (timers, io watchers) are still active.	1171	watchers (timers, io watchers) are still active.
809		1172
		1173	=item $term->exec_async ($cmd[, @args])
		1174
		1175	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1176	("starts") programs in the background. This function takes care of setting
		1177	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1178	be preferred over explicit calls to C<exec> or C<system>.
		1179
		1180	Returns the pid of the subprocess or C<undef> on error.
		1181
		1182	=cut
		1183
		1184	sub exec_async {
		1185	my $self = shift;
		1186
		1187	my $pid = fork;
		1188
		1189	return $pid
		1190	if !defined $pid or $pid;
		1191
		1192	%ENV = %{ $self->env };
		1193
		1194	exec @_;
		1195	urxvt::_exit 255;
		1196	}
		1197
810	=item $isset = $term->option ($optval[, $set])	1198	=item $isset = $term->option ($optval[, $set])
811		1199
812	Returns true if the option specified by C<$optval> is enabled, and	1200	Returns true if the option specified by C<$optval> is enabled, and
813	optionally change it. All option values are stored by name in the hash	1201	optionally change it. All option values are stored by name in the hash
814	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1202	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
815		1203
816	Here is a a likely non-exhaustive list of option names, please see the	1204	Here is a likely non-exhaustive list of option names, please see the
817	source file F</src/optinc.h> to see the actual list:	1205	source file F</src/optinc.h> to see the actual list:
818		1206
819	borderLess console cursorBlink cursorUnderline hold iconic insecure	1207	borderLess console cursorBlink cursorUnderline hold iconic insecure
820	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1208	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
821	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1209	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
822	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1210	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
823	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1211	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
824	tripleclickwords utmpInhibit visualBell	1212	transparent tripleclickwords utmpInhibit visualBell
825		1213
826	=item $value = $term->resource ($name[, $newval])	1214	=item $value = $term->resource ($name[, $newval])
827		1215
828	Returns the current resource value associated with a given name and	1216	Returns the current resource value associated with a given name and
829	optionally sets a new value. Setting values is most useful in the C<init>	1217	optionally sets a new value. Setting values is most useful in the C<init>
…		…
838	likely change).	1226	likely change).
839		1227
840	Please note that resource strings will currently only be freed when the	1228	Please note that resource strings will currently only be freed when the
841	terminal is destroyed, so changing options frequently will eat memory.	1229	terminal is destroyed, so changing options frequently will eat memory.
842		1230
843	Here is a a likely non-exhaustive list of resource names, not all of which	1231	Here is a likely non-exhaustive list of resource names, not all of which
844	are supported in every build, please see the source file F</src/rsinc.h>	1232	are supported in every build, please see the source file F</src/rsinc.h>
845	to see the actual list:	1233	to see the actual list:
846		1234
847	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1235	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
848	borderLess color cursorBlink cursorUnderline cutchars delete_key	1236	borderLess color cursorBlink cursorUnderline cutchars delete_key
849	display_name embed ext_bwidth fade font geometry hold iconName	1237	display_name embed ext_bwidth fade font geometry hold iconName
850	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1238	imFont imLocale inputMethod insecure int_bwidth intensityStyles
851	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1239	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
852	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1240	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
853	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1241	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
854	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1242	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
855	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1243	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
856	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1244	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
857	shade term_name title transparent transparent_all tripleclickwords	1245	secondaryScreen secondaryScroll selectstyle shade term_name title
858	utmpInhibit visualBell	1246	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1247	visualBell
859		1248
860	=cut	1249	=cut
861		1250
862	sub resource($$;$) {	1251	sub resource($$;$) {
863	my ($self, $name) = (shift, shift);	1252	my ($self, $name) = (shift, shift);
…		…
898	=item ($row, $col) = $term->selection_end ([$row, $col])	1287	=item ($row, $col) = $term->selection_end ([$row, $col])
899		1288
900	Return the current values of the selection mark, begin or end positions,	1289	Return the current values of the selection mark, begin or end positions,
901	and optionally set them to new values.	1290	and optionally set them to new values.
902		1291
		1292	=item $term->selection_make ($eventtime[, $rectangular])
		1293
		1294	Tries to make a selection as set by C<selection_beg> and
		1295	C<selection_end>. If C<$rectangular> is true (default: false), a
		1296	rectangular selection will be made. This is the prefered function to make
		1297	a selection.
		1298
903	=item $success = $term->selection_grab ($eventtime)	1299	=item $success = $term->selection_grab ($eventtime)
904		1300
905	Try to request the primary selection from the server (for example, as set	1301	Try to request the primary selection text from the server (for example, as
906	by the next method).	1302	set by the next method). No visual feedback will be given. This function
		1303	is mostly useful from within C<on_sel_grab> hooks.
907		1304
908	=item $oldtext = $term->selection ([$newtext])	1305	=item $oldtext = $term->selection ([$newtext])
909		1306
910	Return the current selection text and optionally replace it by C<$newtext>.	1307	Return the current selection text and optionally replace it by C<$newtext>.
911		1308
…		…
1004	Convert the given locale-encoded octets into a perl string.	1401	Convert the given locale-encoded octets into a perl string.
1005		1402
1006	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1403	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1007		1404
1008	XORs the rendition values in the given span with the provided value	1405	XORs the rendition values in the given span with the provided value
1009	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1406	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1010	to the selection.	1407	refresh hooks to provide effects similar to the selection.
1011		1408
1012	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1409	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1013		1410
1014	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1411	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1015	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1412	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1016	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1413	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
1017	it instead.	1414	it instead. Both styles I<MUST NOT> contain font styles.
1018		1415
1019	=item $term->scr_bell	1416	=item $term->scr_bell
1020		1417
1021	Ring the bell!	1418	Ring the bell!
1022		1419
…		…
1029		1426
1030	Normally its not a good idea to use this function, as programs might be	1427	Normally its not a good idea to use this function, as programs might be
1031	confused by changes in cursor position or scrolling. Its useful inside a	1428	confused by changes in cursor position or scrolling. Its useful inside a
1032	C<on_add_lines> hook, though.	1429	C<on_add_lines> hook, though.
1033		1430
		1431	=item $term->scr_change_screen ($screen)
		1432
		1433	Switch to given screen - 0 primary, 1 secondary.
		1434
1034	=item $term->cmd_parse ($octets)	1435	=item $term->cmd_parse ($octets)
1035		1436
1036	Similar to C<scr_add_lines>, but the argument must be in the	1437	Similar to C<scr_add_lines>, but the argument must be in the
1037	locale-specific encoding of the terminal and can contain command sequences	1438	locale-specific encoding of the terminal and can contain command sequences
1038	(escape codes) that will be interpreted.	1439	(escape codes) that will be interpreted.
…		…
1048	Replaces the event mask of the pty watcher by the given event mask. Can	1449	Replaces the event mask of the pty watcher by the given event mask. Can
1049	be used to suppress input and output handling to the pty/tty. See the	1450	be used to suppress input and output handling to the pty/tty. See the
1050	description of C<< urxvt::timer->events >>. Make sure to always restore	1451	description of C<< urxvt::timer->events >>. Make sure to always restore
1051	the previous value.	1452	the previous value.
1052		1453
		1454	=item $fd = $term->pty_fd
		1455
		1456	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1457	is used.
		1458
1053	=item $windowid = $term->parent	1459	=item $windowid = $term->parent
1054		1460
1055	Return the window id of the toplevel window.	1461	Return the window id of the toplevel window.
1056		1462
1057	=item $windowid = $term->vt	1463	=item $windowid = $term->vt
1058		1464
1059	Return the window id of the terminal window.	1465	Return the window id of the terminal window.
1060		1466
		1467	=item $term->vt_emask_add ($x_event_mask)
		1468
		1469	Adds the specified events to the vt event mask. Useful e.g. when you want
		1470	to receive pointer events all the times:
		1471
		1472	$term->vt_emask_add (urxvt::PointerMotionMask);
		1473
		1474	=item $term->focus_in
		1475
		1476	=item $term->focus_out
		1477
		1478	=item $term->key_press ($state, $keycode[, $time])
		1479
		1480	=item $term->key_release ($state, $keycode[, $time])
		1481
		1482	Deliver various fake events to to terminal.
		1483
1061	=item $window_width = $term->width	1484	=item $window_width = $term->width
1062		1485
1063	=item $window_height = $term->height	1486	=item $window_height = $term->height
1064		1487
1065	=item $font_width = $term->fwidth	1488	=item $font_width = $term->fwidth
…		…
1078		1501
1079	=item $max_scrollback = $term->saveLines	1502	=item $max_scrollback = $term->saveLines
1080		1503
1081	=item $nrow_plus_saveLines = $term->total_rows	1504	=item $nrow_plus_saveLines = $term->total_rows
1082		1505
1083	=item $lines_in_scrollback = $term->nsaved	1506	=item $topmost_scrollback_row = $term->top_row
1084		1507
1085	Return various integers describing terminal characteristics.	1508	Return various integers describing terminal characteristics.
1086		1509
1087	=item $x_display = $term->display_id	1510	=item $x_display = $term->display_id
1088		1511
…		…
1095	=item $env = $term->env	1518	=item $env = $term->env
1096		1519
1097	Returns a copy of the environment in effect for the terminal as a hashref	1520	Returns a copy of the environment in effect for the terminal as a hashref
1098	similar to C<\%ENV>.	1521	similar to C<\%ENV>.
1099		1522
		1523	=item @envv = $term->envv
		1524
		1525	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1526
		1527	=item @argv = $term->argv
		1528
		1529	Return the argument vector as this terminal, similar to @ARGV, but
		1530	includes the program name as first element.
		1531
1100	=cut	1532	=cut
1101		1533
1102	sub env {	1534	sub env {
1103	if (my $env = $_[0]->_env) {
1104	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1535	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1105	} else {
1106	+{ %ENV }
1107	}
1108	}	1536	}
1109		1537
1110	=item $modifiermask = $term->ModLevel3Mask	1538	=item $modifiermask = $term->ModLevel3Mask
1111		1539
1112	=item $modifiermask = $term->ModMetaMask	1540	=item $modifiermask = $term->ModMetaMask
…		…
1114	=item $modifiermask = $term->ModNumLockMask	1542	=item $modifiermask = $term->ModNumLockMask
1115		1543
1116	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1544	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1117	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1545	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1118		1546
		1547	=item $screen = $term->current_screen
		1548
		1549	Returns the currently displayed screen (0 primary, 1 secondary).
		1550
		1551	=item $cursor_is_hidden = $term->hidden_cursor
		1552
		1553	Returns whether the cursor is currently hidden or not.
		1554
1119	=item $view_start = $term->view_start ([$newvalue])	1555	=item $view_start = $term->view_start ([$newvalue])
1120		1556
1121	Returns the negative row number of the topmost line. Minimum value is	1557	Returns the row number of the topmost displayed line. Maximum value is
1122	C<0>, which displays the normal terminal contents. Larger values scroll	1558	C<0>, which displays the normal terminal contents. Lower values scroll
1123	this many lines into the scrollback buffer.	1559	this many lines into the scrollback buffer.
1124		1560
1125	=item $term->want_refresh	1561	=item $term->want_refresh
1126		1562
1127	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1563	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1142	line, starting at column C<$start_col> (default C<0>), which is useful	1578	line, starting at column C<$start_col> (default C<0>), which is useful
1143	to replace only parts of a line. The font index in the rendition will	1579	to replace only parts of a line. The font index in the rendition will
1144	automatically be updated.	1580	automatically be updated.
1145		1581
1146	C<$text> is in a special encoding: tabs and wide characters that use more	1582	C<$text> is in a special encoding: tabs and wide characters that use more
1147	than one cell when displayed are padded with urxvt::NOCHAR characters	1583	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1148	(C<chr 65535>). Characters with combining characters and other characters	1584	characters. Characters with combining characters and other characters that
1149	that do not fit into the normal tetx encoding will be replaced with	1585	do not fit into the normal tetx encoding will be replaced with characters
1150	characters in the private use area.	1586	in the private use area.
1151		1587
1152	You have to obey this encoding when changing text. The advantage is	1588	You have to obey this encoding when changing text. The advantage is
1153	that C<substr> and similar functions work on screen cells and not on	1589	that C<substr> and similar functions work on screen cells and not on
1154	characters.	1590	characters.
1155		1591
…		…
1206	Return the row number of the first/last row of the line, respectively.	1642	Return the row number of the first/last row of the line, respectively.
1207		1643
1208	=item $offset = $line->offset_of ($row, $col)	1644	=item $offset = $line->offset_of ($row, $col)
1209		1645
1210	Returns the character offset of the given row\|col pair within the logical	1646	Returns the character offset of the given row\|col pair within the logical
1211	line.	1647	line. Works for rows outside the line, too, and returns corresponding
		1648	offsets outside the string.
1212		1649
1213	=item ($row, $col) = $line->coord_of ($offset)	1650	=item ($row, $col) = $line->coord_of ($offset)
1214		1651
1215	Translates a string offset into terminal coordinates again.	1652	Translates a string offset into terminal coordinates again.
1216		1653
…		…
1298	where one character corresponds to one screen cell. See	1735	where one character corresponds to one screen cell. See
1299	C<< $term->ROW_t >> for details.	1736	C<< $term->ROW_t >> for details.
1300		1737
1301	=item $string = $term->special_decode $text	1738	=item $string = $term->special_decode $text
1302		1739
1303	Converts rxvt-unicodes text reprsentation into a perl string. See	1740	Converts rxvt-unicodes text representation into a perl string. See
1304	C<< $term->ROW_t >> for details.	1741	C<< $term->ROW_t >> for details.
1305		1742
1306	=item $success = $term->grab_button ($button, $modifiermask)	1743	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1307		1744
		1745	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1746
1308	Registers a synchronous button grab. See the XGrabButton manpage.	1747	Register/unregister a synchronous button grab. See the XGrabButton
		1748	manpage.
1309		1749
1310	=item $success = $term->grab ($eventtime[, $sync])	1750	=item $success = $term->grab ($eventtime[, $sync])
1311		1751
1312	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1752	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1313	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1753	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1314		1754
1315	=item $term->allow_events_async	1755	=item $term->allow_events_async
1316		1756
1317	Calls XAllowEvents with AsyncBoth for the most recent grab.	1757	Calls XAllowEvents with AsyncBoth for the most recent grab.
1318		1758
…		…
1328	=item $term->ungrab	1768	=item $term->ungrab
1329		1769
1330	Calls XUngrab for the most recent grab. Is called automatically on	1770	Calls XUngrab for the most recent grab. Is called automatically on
1331	evaluation errors, as it is better to lose the grab in the error case as	1771	evaluation errors, as it is better to lose the grab in the error case as
1332	the session.	1772	the session.
		1773
		1774	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1775
		1776	=item $atom_name = $term->XGetAtomName ($atom)
		1777
		1778	=item @atoms = $term->XListProperties ($window)
		1779
		1780	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1781
		1782	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1783
		1784	=item $term->XDeleteProperty ($window, $property)
		1785
		1786	=item $window = $term->DefaultRootWindow
		1787
		1788	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1789
		1790	=item $term->XMapWindow ($window)
		1791
		1792	=item $term->XUnmapWindow ($window)
		1793
		1794	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1795
		1796	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1797
		1798	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1799
		1800	Various X or X-related functions. The C<$term> object only serves as
		1801	the source of the display, otherwise those functions map more-or-less
		1802	directory onto the X functions of the same name.
1333		1803
1334	=back	1804	=back
1335		1805
1336	=cut	1806	=cut
1337		1807
…		…
1401	my ($self, $text, $cb) = @_;	1871	my ($self, $text, $cb) = @_;
1402		1872
1403	$self->add_item ({ type => "button", text => $text, activate => $cb});	1873	$self->add_item ({ type => "button", text => $text, activate => $cb});
1404	}	1874	}
1405		1875
1406	=item $popup->add_toggle ($text, $cb, $initial_value)	1876	=item $popup->add_toggle ($text, $initial_value, $cb)
1407		1877
1408	Adds a toggle/checkbox item to the popup. Teh callback gets called	1878	Adds a toggle/checkbox item to the popup. The callback gets called
1409	whenever it gets toggled, with a boolean indicating its value as its first	1879	whenever it gets toggled, with a boolean indicating its new value as its
1410	argument.	1880	first argument.
1411		1881
1412	=cut	1882	=cut
1413		1883
1414	sub add_toggle {	1884	sub add_toggle {
1415	my ($self, $text, $cb, $value) = @_;	1885	my ($self, $text, $value, $cb) = @_;
1416		1886
1417	my $item; $item = {	1887	my $item; $item = {
1418	type => "button",	1888	type => "button",
1419	text => " $text",	1889	text => " $text",
1420	value => $value,	1890	value => $value,
…		…
1439	my $env = $self->{term}->env;	1909	my $env = $self->{term}->env;
1440	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1910	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1441	delete $env->{LC_ALL};	1911	delete $env->{LC_ALL};
1442	$env->{LC_CTYPE} = $self->{term}->locale;	1912	$env->{LC_CTYPE} = $self->{term}->locale;
1443		1913
1444	urxvt::term->new ($env, $self->{term}->resource ("name"),	1914	urxvt::term->new ($env, "popup",
1445	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1915	"--perl-lib" => "", "--perl-ext-common" => "",
		1916	"-pty-fd" => -1, "-sl" => 0,
		1917	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1446	"--transient-for" => $self->{term}->parent,	1918	"--transient-for" => $self->{term}->parent,
1447	"-display" => $self->{term}->display_id,	1919	"-display" => $self->{term}->display_id,
1448	"-pe" => "urxvt-popup")	1920	"-pe" => "urxvt-popup")
1449	or die "unable to create popup window\n";	1921	or die "unable to create popup window\n";
1450	}	1922	}
…		…
1455	delete $self->{term}{_destroy}{$self};	1927	delete $self->{term}{_destroy}{$self};
1456	$self->{term}->ungrab;	1928	$self->{term}->ungrab;
1457	}	1929	}
1458		1930
1459	=back	1931	=back
		1932
		1933	=cut
		1934
		1935	package urxvt::watcher;
		1936
		1937	@urxvt::timer::ISA = __PACKAGE__;
		1938	@urxvt::iow::ISA = __PACKAGE__;
		1939	@urxvt::pw::ISA = __PACKAGE__;
		1940	@urxvt::iw::ISA = __PACKAGE__;
1460		1941
1461	=head2 The C<urxvt::timer> Class	1942	=head2 The C<urxvt::timer> Class
1462		1943
1463	This class implements timer watchers/events. Time is represented as a	1944	This class implements timer watchers/events. Time is represented as a
1464	fractional number of seconds since the epoch. Example:	1945	fractional number of seconds since the epoch. Example:
…		…
1502	Start the timer.	1983	Start the timer.
1503		1984
1504	=item $timer = $timer->start ($tstamp)	1985	=item $timer = $timer->start ($tstamp)
1505		1986
1506	Set the event trigger time to C<$tstamp> and start the timer.	1987	Set the event trigger time to C<$tstamp> and start the timer.
		1988
		1989	=item $timer = $timer->after ($delay)
		1990
		1991	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1507		1992
1508	=item $timer = $timer->stop	1993	=item $timer = $timer->stop
1509		1994
1510	Stop the timer.	1995	Stop the timer.
1511		1996
…		…
1540	Set the callback to be called when io events are triggered. C<$reventmask>	2025	Set the callback to be called when io events are triggered. C<$reventmask>
1541	is a bitset as described in the C<events> method.	2026	is a bitset as described in the C<events> method.
1542		2027
1543	=item $iow = $iow->fd ($fd)	2028	=item $iow = $iow->fd ($fd)
1544		2029
1545	Set the filedescriptor (not handle) to watch.	2030	Set the file descriptor (not handle) to watch.
1546		2031
1547	=item $iow = $iow->events ($eventmask)	2032	=item $iow = $iow->events ($eventmask)
1548		2033
1549	Set the event mask to watch. The only allowed values are	2034	Set the event mask to watch. The only allowed values are
1550	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2035	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
…		…
1554		2039
1555	Start watching for requested events on the given handle.	2040	Start watching for requested events on the given handle.
1556		2041
1557	=item $iow = $iow->stop	2042	=item $iow = $iow->stop
1558		2043
1559	Stop watching for events on the given filehandle.	2044	Stop watching for events on the given file handle.
		2045
		2046	=back
		2047
		2048	=head2 The C<urxvt::iw> Class
		2049
		2050	This class implements idle watchers, that get called automatically when
		2051	the process is idle. They should return as fast as possible, after doing
		2052	some useful work.
		2053
		2054	=over 4
		2055
		2056	=item $iw = new urxvt::iw
		2057
		2058	Create a new idle watcher object in stopped state.
		2059
		2060	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2061
		2062	Set the callback to be called when the watcher triggers.
		2063
		2064	=item $timer = $timer->start
		2065
		2066	Start the watcher.
		2067
		2068	=item $timer = $timer->stop
		2069
		2070	Stop the watcher.
		2071
		2072	=back
		2073
		2074	=head2 The C<urxvt::pw> Class
		2075
		2076	This class implements process watchers. They create an event whenever a
		2077	process exits, after which they stop automatically.
		2078
		2079	my $pid = fork;
		2080	...
		2081	$term->{pw} = urxvt::pw
		2082	->new
		2083	->start ($pid)
		2084	->cb (sub {
		2085	my ($pw, $exit_status) = @_;
		2086	...
		2087	});
		2088
		2089	=over 4
		2090
		2091	=item $pw = new urxvt::pw
		2092
		2093	Create a new process watcher in stopped state.
		2094
		2095	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2096
		2097	Set the callback to be called when the timer triggers.
		2098
		2099	=item $pw = $timer->start ($pid)
		2100
		2101	Tells the watcher to start watching for process C<$pid>.
		2102
		2103	=item $pw = $pw->stop
		2104
		2105	Stop the watcher.
1560		2106
1561	=back	2107	=back
1562		2108
1563	=head1 ENVIRONMENT	2109	=head1 ENVIRONMENT
1564		2110
…		…
1571		2117
1572	=item == 0 - fatal messages	2118	=item == 0 - fatal messages
1573		2119
1574	=item >= 3 - script loading and management	2120	=item >= 3 - script loading and management
1575		2121
1576	=item >=10 - all events received	2122	=item >=10 - all called hooks
		2123
		2124	=item >=11 - hook return values
1577		2125
1578	=back	2126	=back
1579		2127
1580	=head1 AUTHOR	2128	=head1 AUTHOR
1581		2129

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.82 by root, Thu Jan 12 01:30:53 2006 UTC vs. Revision 1.146 by root, Thu Aug 17 21:56:11 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.82 by root, Thu Jan 12 01:30:53 2006 UTC vs.
Revision 1.146 by root, Thu Aug 17 21:56:11 2006 UTC