ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC vs.
Revision 1.139 by root, Sat Jul 1 19:04:43 2006 UTC

…		…
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 followign 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 wether 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	=item readline (enabled by default)
84		157
85	Displays a digital clock using the built-in overlay.	158	A support package that tries to make editing with readline easier. At
		159	the moment, it reacts to clicking shift-left mouse button by trying to
		160	move the text cursor to this position. It does so by generating as many
		161	cursor-left or cursor-right keypresses as required (the this only works
		162	for programs that correctly support wide characters).
		163
		164	To avoid too many false positives, this is only done when:
		165
		166	=over 4
		167
		168	=item - the tty is in ICANON state.
		169
		170	=item - the text cursor is visible.
		171
		172	=item - the primary screen is currently being displayed.
		173
		174	=item - the mouse is on the same (multi-row-) line as the text cursor.
		175
		176	=back
		177
		178	The normal selection mechanism isn't disabled, so quick successive clicks
		179	might interfere with selection creation in harmless ways.
		180
		181	=item selection-autotransform
		182
		183	This selection allows you to do automatic transforms on a selection
		184	whenever a selection is made.
		185
		186	It works by specifying perl snippets (most useful is a single C<s///>
		187	operator) that modify C<$_> as resources:
		188
		189	URxvt.selection-autotransform.0: transform
		190	URxvt.selection-autotransform.1: transform
		191	...
		192
		193	For example, the following will transform selections of the form
		194	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		195	$word>:
		196
		197	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		198
		199	And this example matches the same,but replaces it with vi-commands you can
		200	paste directly into your (vi :) editor:
		201
		202	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		203
		204	Of course, this can be modified to suit your needs and your editor :)
		205
		206	To expand the example above to typical perl error messages ("XXX at
		207	FILENAME line YYY."), you need a slightly more elaborate solution:
		208
		209	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		210	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		211
		212	The first line tells the selection code to treat the unchanging part of
		213	every error message as a selection pattern, and the second line transforms
		214	the message into vi commands to load the file.
		215
		216	=item tabbed
		217
		218	This transforms the terminal into a tabbar with additional terminals, that
		219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		220	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		221	button per tab.
		222
		223	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		224	B<Shift-Right> will switch to the tab left or right of the current one,
		225	while B<Shift-Down> creates a new tab.
		226
		227	The tabbar itself can be configured similarly to a normal terminal, but
		228	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		229	following four resources (shown with defaults):
		230
		231	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		232	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		233	URxvt.tabbed.tab-fg: <colour-index, default 0>
		234	URxvt.tabbed.tab-bg: <colour-index, default 1>
		235
		236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		237	indices.
86		238
87	=item mark-urls	239	=item mark-urls
88		240
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	241	Uses per-line display filtering (C<on_line_update>) to underline urls and
		242	make them clickable. When middle-clicked, the program specified in the
		243	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		244	the URL as first argument.
		245
		246	=item xim-onthespot
		247
		248	This (experimental) perl extension implements OnTheSpot editing. It does
		249	not work perfectly, and some input methods don't seem to work well with
		250	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		251	kinput2.
		252
		253	You enable it by specifying this extension and a preedit style of
		254	C<OnTheSpot>, i.e.:
		255
		256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		257
		258	=item automove-background
		259
		260	This is basically a one-line extension that dynamically changes the background pixmap offset
		261	to the window position, in effect creating the same effect as pseudo transparency with
		262	a custom pixmap. No scaling is supported in this mode. Exmaple:
		263
		264	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
90		265
91	=item block-graphics-to-ascii	266	=item block-graphics-to-ascii
92		267
93	A not very useful example of filtering all text output to the terminal,	268	A not very useful example of filtering all text output to the terminal,
94	by replacing all line-drawing characters (U+2500 .. U+259F) by a	269	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	270	similar-looking ascii character.
		271
		272	=item digital-clock
		273
		274	Displays a digital clock using the built-in overlay.
		275
		276	=item remote-clipboard
		277
		278	Somewhat of a misnomer, this extension adds two menu entries to the
		279	selection popup that allows one ti run external commands to store the
		280	selection somewhere and fetch it again.
		281
		282	We use it to implement a "distributed selection mechanism", which just
		283	means that one command uploads the file to a remote server, and another
		284	reads it.
		285
		286	The commands can be set using the C<URxvt.remote-selection.store> and
		287	C<URxvt.remote-selection.fetch> resources. The first should read the
		288	selection to store from STDIN (always in UTF-8), the second should provide
		289	the selection data on STDOUT (also in UTF-8).
		290
		291	The defaults (which are likely useless to you) use rsh and cat:
		292
		293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		295
		296	=item selection-pastebin
		297
		298	This is a little rarely useful extension that Uploads the selection as
		299	textfile to a remote site (or does other things). (The implementation is
		300	not currently secure for use in a multiuser environment as it writes to
		301	F</tmp> directly.).
		302
		303	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		304	i.e.
		305
		306	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		307
		308	Pressing this combination runs a command with C<%> replaced by the name of
		309	the textfile. This command can be set via a resource:
		310
		311	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		312
		313	And the default is likely not useful to anybody but the few people around
		314	here :)
		315
		316	The name of the textfile is the hex encoded md5 sum of the selection, so
		317	the same content should lead to the same filename.
		318
		319	After a successful upload the selection will be replaced by the text given
		320	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		321	for the filename):
		322
		323	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
96		324
97	=item example-refresh-hooks	325	=item example-refresh-hooks
98		326
99	Displays a very simple digital clock in the upper right corner of the	327	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	328	window. Illustrates overwriting the refresh callbacks to create your own
…		…
123	=over 4	351	=over 4
124		352
125	=item $text	353	=item $text
126		354
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	355	Rxvt-unicodes special way of encoding text, where one "unicode" character
128	always represents one screen cell. See L<row_t> for a discussion of this format.	356	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		357
130	=item $string	358	=item $string
131		359
132	A perl text string, with an emphasis on I<text>. It can store all unicode	360	A perl text string, with an emphasis on I<text>. It can store all unicode
133	characters and is to be distinguished with text encoded in a specific	361	characters and is to be distinguished with text encoded in a specific
…		…
140		368
141	=back	369	=back
142		370
143	=head2 Extension Objects	371	=head2 Extension Objects
144		372
145	Very perl extension is a perl class. A separate perl object is created	373	Every perl extension is a perl class. A separate perl object is created
146	for each terminal and each extension and passed as the first parameter to	374	for each terminal and each extension and passed as the first parameter to
147	hooks. So extensions can use their C<$self> object without having to think	375	hooks. So extensions can use their C<$self> object without having to think
148	about other extensions, with the exception of methods and members that	376	about other extensions, with the exception of methods and members that
149	begin with an underscore character C<_>: these are reserved for internal	377	begin with an underscore character C<_>: these are reserved for internal
150	use.	378	use.
…		…
179	called whenever the relevant event happens.	407	called whenever the relevant event happens.
180		408
181	The first argument passed to them is an extension oject as described in	409	The first argument passed to them is an extension oject as described in
182	the in the C<Extension Objects> section.	410	the in the C<Extension Objects> section.
183		411
184	B<All> of these hooks must return a boolean value. If it is true, then the	412	B<All> of these hooks must return a boolean value. If any of the called
185	event counts as being I<consumed>, and the invocation of other hooks is	413	hooks returns true, then the event counts as being I<consumed>, and the
186	skipped, and the relevant action might not be carried out by the C++ code.	414	relevant action might not be carried out by the C++ code.
187		415
188	I<< When in doubt, return a false value (preferably C<()>). >>	416	I<< When in doubt, return a false value (preferably C<()>). >>
189		417
190	=over 4	418	=over 4
191		419
192	=item on_init $term	420	=item on_init $term
193		421
194	Called after a new terminal object has been initialized, but before	422	Called after a new terminal object has been initialized, but before
195	windows are created or the command gets run. Most methods are unsafe to	423	windows are created or the command gets run. Most methods are unsafe to
196	call or deliver senseless data, as terminal size and other characteristics	424	call or deliver senseless data, as terminal size and other characteristics
197	have not yet been determined. You can safely query and change resources,	425	have not yet been determined. You can safely query and change resources
198	though.	426	and options, though. For many purposes the C<on_start> hook is a better
		427	place.
		428
		429	=item on_start $term
		430
		431	Called at the very end of initialisation of a new terminal, just before
		432	trying to map (display) the toplevel and returning to the mainloop.
		433
		434	=item on_destroy $term
		435
		436	Called whenever something tries to destroy terminal, when the terminal is
		437	still fully functional (not for long, though).
199		438
200	=item on_reset $term	439	=item on_reset $term
201		440
202	Called after the screen is "reset" for any reason, such as resizing or	441	Called after the screen is "reset" for any reason, such as resizing or
203	control sequences. Here is where you can react on changes to size-related	442	control sequences. Here is where you can react on changes to size-related
204	variables.	443	variables.
205		444
206	=item on_start $term	445	=item on_child_start $term, $pid
207		446
208	Called at the very end of initialisation of a new terminal, just before	447	Called just after the child process has been C<fork>ed.
209	returning to the mainloop.	448
		449	=item on_child_exit $term, $status
		450
		451	Called just after the child process has exited. C<$status> is the status
		452	from C<waitpid>.
210		453
211	=item on_sel_make $term, $eventtime	454	=item on_sel_make $term, $eventtime
212		455
213	Called whenever a selection has been made by the user, but before the	456	Called whenever a selection has been made by the user, but before the
214	selection text is copied, so changes to the beginning, end or type of the	457	selection text is copied, so changes to the beginning, end or type of the
…		…
228	=item on_sel_extend $term	471	=item on_sel_extend $term
229		472
230	Called whenever the user tries to extend the selection (e.g. with a double	473	Called whenever the user tries to extend the selection (e.g. with a double
231	click) and is either supposed to return false (normal operation), or	474	click) and is either supposed to return false (normal operation), or
232	should extend the selection itelf and return true to suppress the built-in	475	should extend the selection itelf and return true to suppress the built-in
233	processing.	476	processing. This can happen multiple times, as long as the callback
		477	returns true, it will be called on every further click by the user and is
		478	supposed to enlarge the selection more and more, if possible.
234		479
235	See the F<selection> example extension.	480	See the F<selection> example extension.
236		481
237	=item on_view_change $term, $offset	482	=item on_view_change $term, $offset
238		483
…		…
248		493
249	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	494	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
250	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	495	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
251	number of lines that will be in the scrollback buffer.	496	number of lines that will be in the scrollback buffer.
252		497
		498	=item on_osc_seq $term, $op, $args
		499
		500	Called on every OSC sequence and can be used to suppress it or modify its
		501	behaviour. The default should be to return an empty list. A true value
		502	suppresses execution of the request completely. Make sure you don't get
		503	confused by recursive invocations when you output an osc sequence within
		504	this callback.
		505
		506	C<on_osc_seq_perl> should be used for new behaviour.
		507
253	=item on_osc_seq $term, $string	508	=item on_osc_seq_perl $term, $string
254		509
255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	510	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
256	operating system command) is processed. Cursor position and other state	511	operating system command) is processed. Cursor position and other state
257	information is up-to-date when this happens. For interoperability, the	512	information is up-to-date when this happens. For interoperability, the
258	string should start with the extension name and a colon, to distinguish	513	string should start with the extension name and a colon, to distinguish
…		…
299		554
300	=item on_refresh_end $term	555	=item on_refresh_end $term
301		556
302	Called just after the screen gets redrawn. See C<on_refresh_begin>.	557	Called just after the screen gets redrawn. See C<on_refresh_begin>.
303		558
304	=item on_keyboard_command $term, $string	559	=item on_user_command $term, $string
305		560
306	Called whenever the user presses a key combination that has a	561	Called whenever the a user-configured event is being activated (e.g. via
307	C<perl:string> action bound to it (see description of the B<keysym>	562	a C<perl:string> action bound to a key, see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	563	resource in the @@RXVT_NAME@@(1) manpage).
		564
		565	The event is simply the action string. This interface is assumed to change
		566	slightly in the future.
		567
		568	=item on_resize_all_windows $tern, $new_width, $new_height
		569
		570	Called just after the new window size has been calculcated, but before
		571	windows are actually being resized or hints are being set. If this hook
		572	returns TRUE, setting of the window hints is being skipped.
		573
		574	=item on_x_event $term, $event
		575
		576	Called on every X event received on the vt window (and possibly other
		577	windows). Should only be used as a last resort. Most event structure
		578	members are not passed.
309		579
310	=item on_focus_in $term	580	=item on_focus_in $term
311		581
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	582	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	583	does focus in processing.
…		…
315	=item on_focus_out $term	585	=item on_focus_out $term
316		586
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	587	Called wheneever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	588	focus out processing.
319		589
		590	=item on_configure_notify $term, $event
		591
		592	=item on_property_notify $term, $event
		593
320	=item on_key_press $term, $event, $keysym, $octets	594	=item on_key_press $term, $event, $keysym, $octets
321		595
322	=item on_key_release $term, $event, $keysym	596	=item on_key_release $term, $event, $keysym
323		597
324	=item on_button_press $term, $event	598	=item on_button_press $term, $event
…		…
333		607
334	Called whenever the corresponding X event is received for the terminal If	608	Called whenever the corresponding X event is received for the terminal If
335	the hook returns true, then the even will be ignored by rxvt-unicode.	609	the hook returns true, then the even will be ignored by rxvt-unicode.
336		610
337	The event is a hash with most values as named by Xlib (see the XEvent	611	The event is a hash with most values as named by Xlib (see the XEvent
338	manpage), with the additional members C<row> and C<col>, which are the row	612	manpage), with the additional members C<row> and C<col>, which are the
339	and column under the mouse cursor.	613	(real, not screen-based) row and column under the mouse cursor.
340		614
341	C<on_key_press> additionally receives the string rxvt-unicode would	615	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	616	output, if any, in locale-specific encoding.
343		617
344	subwindow.	618	subwindow.
345		619
346	=back	620	=item on_client_message $term, $event
347		621
348	=head2 Variables in the C<urxvt> Package	622	=item on_wm_protocols $term, $event
349		623
350	=over 4	624	=item on_wm_delete_window $term, $event
351		625
352	=item $urxvt::LIBDIR	626	Called when various types of ClientMessage events are received (all with
353		627	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
354	The rxvt-unicode library directory, where, among other things, the perl
355	modules and scripts are stored.
356
357	=item $urxvt::RESCLASS, $urxvt::RESCLASS
358
359	The resource class and name rxvt-unicode uses to look up X resources.
360
361	=item $urxvt::RXVTNAME
362
363	The basename of the installed binaries, usually C<urxvt>.
364
365	=item $urxvt::TERM
366
367	The current terminal. This variable stores the current C<urxvt::term>
368	object, whenever a callback/hook is executing.
369
370	=item
371
372	=back
373
374	=head2 Functions in the C<urxvt> Package
375
376	=over 4
377
378	=item $term = new urxvt [arg...]
379
380	Creates a new terminal, very similar as if you had started it with
381	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
382	if the new instance couldn't be created. Returns C<undef> if the new
383	instance didn't initialise perl, and the terminal object otherwise. The
384	C<init> and C<start> hooks will be called during the call.
385
386	=item urxvt::fatal $errormessage
387
388	Fatally aborts execution with the given error message. Avoid at all
389	costs! The only time this is acceptable is when the terminal process
390	starts up.
391
392	=item urxvt::warn $string
393
394	Calls C<rxvt_warn> with the given string which should not include a
395	newline. The module also overwrites the C<warn> builtin with a function
396	that calls this function.
397
398	Using this function has the advantage that its output ends up in the
399	correct place, e.g. on stderr of the connecting urxvtc client.
400
401	=item $is_safe = urxvt::safe
402
403	Returns true when it is safe to do potentially unsafe things, such as
404	evaluating perl code specified by the user. This is true when urxvt was
405	started setuid or setgid.
406
407	=item $time = urxvt::NOW
408
409	Returns the "current time" (as per the event loop).
410
411	=item urxvt::CurrentTime
412
413	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
414	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
415	Button4Mask, Button5Mask, AnyModifier
416
417	Various constants for use in X calls and event processing.
418
419	=back
420
421	=head2 RENDITION
422
423	Rendition bitsets contain information about colour, font, font styles and
424	similar information for each screen cell.
425
426	The following "macros" deal with changes in rendition sets. You should
427	never just create a bitset, you should always modify an existing one,
428	as they contain important information required for correct operation of
429	rxvt-unicode.
430
431	=over 4
432
433	=item $rend = urxvt::DEFAULT_RSTYLE
434
435	Returns the default rendition, as used when the terminal is starting up or
436	being reset. Useful as a base to start when creating renditions.
437
438	=item $rend = urxvt::OVERLAY_RSTYLE
439
440	Return the rendition mask used for overlays by default.
441
442	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
443
444	Return the bit that enabled bold, italic, blink, reverse-video and
445	underline, respectively. To enable such a style, just logically OR it into
446	the bitset.
447
448	=item $foreground = urxvt::GET_BASEFG $rend
449
450	=item $background = urxvt::GET_BASEBG $rend
451
452	Return the foreground/background colour index, respectively.
453
454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
455
456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
457
458	Replace the foreground/background colour in the rendition mask with the
459	specified one.
460
461	=item $value = urxvt::GET_CUSTOM $rend
462
463	Return the "custom" value: Every rendition has 5 bits for use by
464	extensions. They can be set and changed as you like and are initially
465	zero.
466
467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
468
469	Change the custom value.
470		628
471	=back	629	=back
472		630
473	=cut	631	=cut
474		632
…		…
480	use Scalar::Util ();	638	use Scalar::Util ();
481	use List::Util ();	639	use List::Util ();
482		640
483	our $VERSION = 1;	641	our $VERSION = 1;
484	our $TERM;	642	our $TERM;
		643	our @TERM_INIT;
		644	our @TERM_EXT;
485	our @HOOKNAME;	645	our @HOOKNAME;
486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	646	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
487	our %OPTION;	647	our %OPTION;
488		648
489	our $LIBDIR;	649	our $LIBDIR;
490	our $RESNAME;	650	our $RESNAME;
491	our $RESCLASS;	651	our $RESCLASS;
492	our $RXVTNAME;	652	our $RXVTNAME;
493		653
		654	our $NOCHAR = chr 0xffff;
		655
		656	=head2 Variables in the C<urxvt> Package
		657
		658	=over 4
		659
		660	=item $urxvt::LIBDIR
		661
		662	The rxvt-unicode library directory, where, among other things, the perl
		663	modules and scripts are stored.
		664
		665	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		666
		667	The resource class and name rxvt-unicode uses to look up X resources.
		668
		669	=item $urxvt::RXVTNAME
		670
		671	The basename of the installed binaries, usually C<urxvt>.
		672
		673	=item $urxvt::TERM
		674
		675	The current terminal. This variable stores the current C<urxvt::term>
		676	object, whenever a callback/hook is executing.
		677
		678	=item @urxvt::TERM_INIT
		679
		680	All coderefs in this array will be called as methods of the next newly
		681	created C<urxvt::term> object (during the C<on_init> phase). The array
		682	gets cleared before the codereferences that were in it are being executed,
		683	so coderefs can push themselves onto it again if they so desire.
		684
		685	This complements to the perl-eval commandline option, but gets executed
		686	first.
		687
		688	=item @urxvt::TERM_EXT
		689
		690	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		691	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		692	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		693
		694	=back
		695
		696	=head2 Functions in the C<urxvt> Package
		697
		698	=over 4
		699
		700	=item urxvt::fatal $errormessage
		701
		702	Fatally aborts execution with the given error message. Avoid at all
		703	costs! The only time this is acceptable is when the terminal process
		704	starts up.
		705
		706	=item urxvt::warn $string
		707
		708	Calls C<rxvt_warn> with the given string which should not include a
		709	newline. The module also overwrites the C<warn> builtin with a function
		710	that calls this function.
		711
		712	Using this function has the advantage that its output ends up in the
		713	correct place, e.g. on stderr of the connecting urxvtc client.
		714
		715	Messages have a size limit of 1023 bytes currently.
		716
		717	=item @terms = urxvt::termlist
		718
		719	Returns all urxvt::term objects that exist in this process, regardless of
		720	wether they are started, being destroyed etc., so be careful. Only term
		721	objects that have perl extensions attached will be returned (because there
		722	is no urxvt::term objet associated with others).
		723
		724	=item $time = urxvt::NOW
		725
		726	Returns the "current time" (as per the event loop).
		727
		728	=item urxvt::CurrentTime
		729
		730	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		731	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		732	Button4Mask, Button5Mask, AnyModifier
		733
		734	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		735	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		736	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		737	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		738	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		739	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		740	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		741
		742	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		743	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		744	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		745	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		746	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		747	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		748	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		749
		750	Various constants for use in X calls and event processing.
		751
		752	=back
		753
		754	=head2 RENDITION
		755
		756	Rendition bitsets contain information about colour, font, font styles and
		757	similar information for each screen cell.
		758
		759	The following "macros" deal with changes in rendition sets. You should
		760	never just create a bitset, you should always modify an existing one,
		761	as they contain important information required for correct operation of
		762	rxvt-unicode.
		763
		764	=over 4
		765
		766	=item $rend = urxvt::DEFAULT_RSTYLE
		767
		768	Returns the default rendition, as used when the terminal is starting up or
		769	being reset. Useful as a base to start when creating renditions.
		770
		771	=item $rend = urxvt::OVERLAY_RSTYLE
		772
		773	Return the rendition mask used for overlays by default.
		774
		775	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		776
		777	Return the bit that enabled bold, italic, blink, reverse-video and
		778	underline, respectively. To enable such a style, just logically OR it into
		779	the bitset.
		780
		781	=item $foreground = urxvt::GET_BASEFG $rend
		782
		783	=item $background = urxvt::GET_BASEBG $rend
		784
		785	Return the foreground/background colour index, respectively.
		786
		787	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		788
		789	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		790
		791	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		792
		793	Replace the foreground/background colour in the rendition mask with the
		794	specified one.
		795
		796	=item $value = urxvt::GET_CUSTOM $rend
		797
		798	Return the "custom" value: Every rendition has 5 bits for use by
		799	extensions. They can be set and changed as you like and are initially
		800	zero.
		801
		802	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		803
		804	Change the custom value.
		805
		806	=back
		807
		808	=cut
		809
494	BEGIN {	810	BEGIN {
495	urxvt->bootstrap;
496
497	# overwrite perl's warn	811	# overwrite perl's warn
498	*CORE::GLOBAL::warn = sub {	812	*CORE::GLOBAL::warn = sub {
499	my $msg = join "", @_;	813	my $msg = join "", @_;
500	$msg .= "\n"	814	$msg .= "\n"
501	unless $msg =~ /\n$/;	815	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	816	urxvt::warn ($msg);
503	};	817	};
504
505	delete $ENV{IFS};
506	delete $ENV{CDPATH};
507	delete $ENV{BASH_ENV};
508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509	}	818	}
510		819
511	my @hook_count;	820	no warnings 'utf8';
		821
512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	822	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513		823
514	sub verbose {	824	sub verbose {
515	my ($level, $msg) = @_;	825	my ($level, $msg) = @_;
516	warn "$msg\n" if $level <= $verbosity;	826	warn "$msg\n" if $level <= $verbosity;
517	}	827	}
518		828
519	my $extension_pkg = "extension0000";
520	my %extension_pkg;	829	my %extension_pkg;
521		830
522	# load a single script into its own package, once only	831	# load a single script into its own package, once only
523	sub extension_package($) {	832	sub extension_package($) {
524	my ($path) = @_;	833	my ($path) = @_;
525		834
526	$extension_pkg{$path} ||= do {	835	$extension_pkg{$path} ||= do {
527	my $pkg = "urxvt::" . ($extension_pkg++);	836	$path =~ /([^\/\\]+)$/;
		837	my $pkg = $1;
		838	$pkg =~ s/[^[:word:]]/_/g;
		839	$pkg = "urxvt::ext::$pkg";
528		840
529	verbose 3, "loading extension '$path' into package '$pkg'";	841	verbose 3, "loading extension '$path' into package '$pkg'";
530		842
531	open my $fh, "<:raw", $path	843	open my $fh, "<:raw", $path
532	or die "$path: $!";	844	or die "$path: $!";
533		845
534	my $source = untaint	846	my $source =
535	"package $pkg; use strict; use utf8;\n"	847	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
536	. "use base urxvt::term::extension::;\n"
537	. "#line 1 \"$path\"\n{\n"	848	. "#line 1 \"$path\"\n{\n"
538	. (do { local $/; <$fh> })	849	. (do { local $/; <$fh> })
539	. "\n};\n1";	850	. "\n};\n1";
540		851
541	eval $source	852	eval $source
…		…
555	if ($htype == 0) { # INIT	866	if ($htype == 0) { # INIT
556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	867	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
557		868
558	my %ext_arg;	869	my %ext_arg;
559		870
		871	{
		872	my @init = @TERM_INIT;
		873	@TERM_INIT = ();
		874	$_->($TERM) for @init;
		875	my @pkg = @TERM_EXT;
		876	@TERM_EXT = ();
		877	$TERM->register_package ($_) for @pkg;
		878	}
		879
560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	880	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
561	if ($_ eq "default") {	881	if ($_ eq "default") {
562	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	882	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
563	} elsif (/^-(.*)$/) {	883	} elsif (/^-(.*)$/) {
564	delete $ext_arg{$1};	884	delete $ext_arg{$1};
565	} elsif (/^([^<]+)<(.*)>$/) {	885	} elsif (/^([^<]+)<(.*)>$/) {
566	push @{ $ext_arg{$1} }, $2;	886	push @{ $ext_arg{$1} }, $2;
567	} else {	887	} else {
568	$ext_arg{$_} ||= [];	888	$ext_arg{$_} ||= [];
569	}	889	}
570	}	890	}
571		891
572	while (my ($ext, $argv) = each %ext_arg) {	892	for my $ext (sort keys %ext_arg) {
573	my @files = grep -f $_, map "$_/$ext", @dirs;	893	my @files = grep -f $_, map "$_/$ext", @dirs;
574		894
575	if (@files) {	895	if (@files) {
576	$TERM->register_package (extension_package $files[0], $argv);	896	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
577	} else {	897	} else {
578	warn "perl extension '$ext' not found in perl library search path\n";	898	warn "perl extension '$ext' not found in perl library search path\n";
579	}	899	}
580	}	900	}
581		901
…		…
587		907
588	if (my $cb = $TERM->{_hook}[$htype]) {	908	if (my $cb = $TERM->{_hook}[$htype]) {
589	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	909	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
590	if $verbosity >= 10;	910	if $verbosity >= 10;
591		911
592	keys %$cb;	912	for my $pkg (keys %$cb) {
593
594	while (my ($pkg, $cb) = each %$cb) {
595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	913	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
596	and last;	914	$retval ||= $retval_;
597		915
598	if ($@) {	916	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	917	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	918	warn $@;
601	}	919	}
602	}	920	}
		921
		922	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		923	if $verbosity >= 11;
603	}	924	}
604		925
605	if ($htype == 1) { # DESTROY	926	if ($htype == 1) { # DESTROY
606	if (my $hook = delete $TERM->{_hook}) {
607	for my $htype (0..$#$hook) {
608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
609	or set_should_invoke $htype, 0;
610	}
611	}
612
613	# clear package objects	927	# clear package objects
614	%$_ = () for values %{ $TERM->{_pkg} };	928	%$_ = () for values %{ $TERM->{_pkg} };
615		929
616	# clear package	930	# clear package
617	%$TERM = ();	931	%$TERM = ();
618	}	932	}
619		933
620	$retval	934	$retval
		935	}
		936
		937	sub SET_COLOR($$$) {
		938	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
621	}	939	}
622		940
623	# urxvt::term::extension	941	# urxvt::term::extension
624		942
625	package urxvt::term::extension;	943	package urxvt::term::extension;
…		…
631	while (my ($name, $cb) = each %hook) {	949	while (my ($name, $cb) = each %hook) {
632	my $htype = $HOOKTYPE{uc $name};	950	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	951	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	952	or Carp::croak "unsupported hook type '$name'";
635		953
		954	$self->set_should_invoke ($htype, +1)
636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	955	unless exists $self->{term}{_hook}[$htype]{$pkg};
637	$hook_count[$htype]++
638	or urxvt::set_should_invoke $htype, 1;
639	}
640		956
641	$self->{term}{_hook}[$htype]{$pkg} = $cb;	957	$self->{term}{_hook}[$htype]{$pkg} = $cb;
642	}	958	}
643	}	959	}
644		960
…		…
649	for my $name (@hook) {	965	for my $name (@hook) {
650	my $htype = $HOOKTYPE{uc $name};	966	my $htype = $HOOKTYPE{uc $name};
651	defined $htype	967	defined $htype
652	or Carp::croak "unsupported hook type '$name'";	968	or Carp::croak "unsupported hook type '$name'";
653		969
		970	$self->set_should_invoke ($htype, -1)
654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	971	if delete $self->{term}{_hook}[$htype]{$pkg};
655	--$hook_count[$htype]
656	or urxvt::set_should_invoke $htype, 0;
657	}
658	}	972	}
659	}	973	}
660		974
661	our $AUTOLOAD;	975	our $AUTOLOAD;
662		976
…		…
768	# find on_xxx subs in the package and register them	1082	# find on_xxx subs in the package and register them
769	# as hooks	1083	# as hooks
770	sub register_package {	1084	sub register_package {
771	my ($self, $pkg, $argv) = @_;	1085	my ($self, $pkg, $argv) = @_;
772		1086
		1087	no strict 'refs';
		1088
		1089	urxvt::verbose 6, "register package $pkg to $self";
		1090
		1091	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1092
773	my $proxy = bless {	1093	my $proxy = bless {
774	_pkg => $pkg,	1094	_pkg => $pkg,
775	argv => $argv,	1095	argv => $argv,
776	}, $pkg;	1096	}, $pkg;
777	Scalar::Util::weaken ($proxy->{term} = $self);	1097	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
783	$proxy->enable ($name => $ref);	1103	$proxy->enable ($name => $ref);
784	}	1104	}
785	}	1105	}
786	}	1106	}
787		1107
		1108	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1109
		1110	Creates a new terminal, very similar as if you had started it with system
		1111	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1112	hash which defines the environment of the new terminal.
		1113
		1114	Croaks (and probably outputs an error message) if the new instance
		1115	couldn't be created. Returns C<undef> if the new instance didn't
		1116	initialise perl, and the terminal object otherwise. The C<init> and
		1117	C<start> hooks will be called before this call returns, and are free to
		1118	refer to global data (which is race free).
		1119
		1120	=cut
		1121
		1122	sub new {
		1123	my ($class, $env, @args) = @_;
		1124
		1125	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1126	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1127
		1128	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1129	}
		1130
788	=item $term->destroy	1131	=item $term->destroy
789		1132
790	Destroy the terminal object (close the window, free resources	1133	Destroy the terminal object (close the window, free resources
791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1134	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792	watchers (timers, io watchers) are still active.	1135	watchers (timers, io watchers) are still active.
793		1136
		1137	=item $term->exec_async ($cmd[, @args])
		1138
		1139	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1140	("starts") programs in the background. This function takes care of setting
		1141	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1142	be preferred over explicit calls to C<exec> or C<system>.
		1143
		1144	Returns the pid of the subprocess or C<undef> on error.
		1145
		1146	=cut
		1147
		1148	sub exec_async {
		1149	my $self = shift;
		1150
		1151	my $pid = fork;
		1152
		1153	return $pid
		1154	if !defined $pid or $pid;
		1155
		1156	%ENV = %{ $self->env };
		1157
		1158	exec @_;
		1159	urxvt::_exit 255;
		1160	}
		1161
794	=item $isset = $term->option ($optval[, $set])	1162	=item $isset = $term->option ($optval[, $set])
795		1163
796	Returns true if the option specified by C<$optval> is enabled, and	1164	Returns true if the option specified by C<$optval> is enabled, and
797	optionally change it. All option values are stored by name in the hash	1165	optionally change it. All option values are stored by name in the hash
798	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1166	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
800	Here is a a likely non-exhaustive list of option names, please see the	1168	Here is a a likely non-exhaustive list of option names, please see the
801	source file F</src/optinc.h> to see the actual list:	1169	source file F</src/optinc.h> to see the actual list:
802		1170
803	borderLess console cursorBlink cursorUnderline hold iconic insecure	1171	borderLess console cursorBlink cursorUnderline hold iconic insecure
804	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1172	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
805	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1173	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
806	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1174	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
807	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1175	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
808	tripleclickwords utmpInhibit visualBell	1176	transparent tripleclickwords utmpInhibit visualBell
809		1177
810	=item $value = $term->resource ($name[, $newval])	1178	=item $value = $term->resource ($name[, $newval])
811		1179
812	Returns the current resource value associated with a given name and	1180	Returns the current resource value associated with a given name and
813	optionally sets a new value. Setting values is most useful in the C<init>	1181	optionally sets a new value. Setting values is most useful in the C<init>
…		…
830		1198
831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1199	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
832	borderLess color cursorBlink cursorUnderline cutchars delete_key	1200	borderLess color cursorBlink cursorUnderline cutchars delete_key
833	display_name embed ext_bwidth fade font geometry hold iconName	1201	display_name embed ext_bwidth fade font geometry hold iconName
834	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1202	imFont imLocale inputMethod insecure int_bwidth intensityStyles
835	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1203	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
836	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1204	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1205	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1206	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1207	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1208	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841	shade term_name title transparent transparent_all tripleclickwords	1209	secondaryScreen secondaryScroll selectstyle shade term_name title
842	utmpInhibit visualBell	1210	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1211	visualBell
843		1212
844	=cut	1213	=cut
845		1214
846	sub resource($$;$) {	1215	sub resource($$;$) {
847	my ($self, $name) = (shift, shift);	1216	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1217	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	1218	&urxvt::term::_resource
850	}	1219	}
851		1220
		1221	=item $value = $term->x_resource ($pattern)
		1222
		1223	Returns the X-Resource for the given pattern, excluding the program or
		1224	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1225	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1226	resource with that pattern exists.
		1227
		1228	This method should only be called during the C<on_start> hook, as there is
		1229	only one resource database per display, and later invocations might return
		1230	the wrong resources.
		1231
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1232	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		1233
854	Adds a keymap translation exactly as specified via a resource. See the	1234	Adds a keymap translation exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1235	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		1236
…		…
871	=item ($row, $col) = $term->selection_end ([$row, $col])	1251	=item ($row, $col) = $term->selection_end ([$row, $col])
872		1252
873	Return the current values of the selection mark, begin or end positions,	1253	Return the current values of the selection mark, begin or end positions,
874	and optionally set them to new values.	1254	and optionally set them to new values.
875		1255
		1256	=item $term->selection_make ($eventtime[, $rectangular])
		1257
		1258	Tries to make a selection as set by C<selection_beg> and
		1259	C<selection_end>. If C<$rectangular> is true (default: false), a
		1260	rectangular selection will be made. This is the prefered function to make
		1261	a selection.
		1262
876	=item $success = $term->selection_grab ($eventtime)	1263	=item $success = $term->selection_grab ($eventtime)
877		1264
878	Try to request the primary selection from the server (for example, as set	1265	Try to request the primary selection text from the server (for example, as
879	by the next method).	1266	set by the next method). No visual feedback will be given. This function
		1267	is mostly useful from within C<on_sel_grab> hooks.
880		1268
881	=item $oldtext = $term->selection ([$newtext])	1269	=item $oldtext = $term->selection ([$newtext])
882		1270
883	Return the current selection text and optionally replace it by C<$newtext>.	1271	Return the current selection text and optionally replace it by C<$newtext>.
884		1272
…		…
977	Convert the given locale-encoded octets into a perl string.	1365	Convert the given locale-encoded octets into a perl string.
978		1366
979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1367	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980		1368
981	XORs the rendition values in the given span with the provided value	1369	XORs the rendition values in the given span with the provided value
982	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1370	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983	to the selection.	1371	refresh hooks to provide effects similar to the selection.
984		1372
985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1373	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986		1374
987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1375	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1376	whitespace will additionally be xored with the C<$rstyle2>, which defaults
989	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1377	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
990	it instead.	1378	it instead. Both styles I<MUST NOT> contain font styles.
991		1379
992	=item $term->scr_bell	1380	=item $term->scr_bell
993		1381
994	Ring the bell!	1382	Ring the bell!
995		1383
…		…
1002		1390
1003	Normally its not a good idea to use this function, as programs might be	1391	Normally its not a good idea to use this function, as programs might be
1004	confused by changes in cursor position or scrolling. Its useful inside a	1392	confused by changes in cursor position or scrolling. Its useful inside a
1005	C<on_add_lines> hook, though.	1393	C<on_add_lines> hook, though.
1006		1394
		1395	=item $term->scr_change_screen ($screen)
		1396
		1397	Switch to given screen - 0 primary, 1 secondary.
		1398
1007	=item $term->cmd_parse ($octets)	1399	=item $term->cmd_parse ($octets)
1008		1400
1009	Similar to C<scr_add_lines>, but the argument must be in the	1401	Similar to C<scr_add_lines>, but the argument must be in the
1010	locale-specific encoding of the terminal and can contain command sequences	1402	locale-specific encoding of the terminal and can contain command sequences
1011	(escape codes) that will be interpreted.	1403	(escape codes) that will be interpreted.
…		…
1021	Replaces the event mask of the pty watcher by the given event mask. Can	1413	Replaces the event mask of the pty watcher by the given event mask. Can
1022	be used to suppress input and output handling to the pty/tty. See the	1414	be used to suppress input and output handling to the pty/tty. See the
1023	description of C<< urxvt::timer->events >>. Make sure to always restore	1415	description of C<< urxvt::timer->events >>. Make sure to always restore
1024	the previous value.	1416	the previous value.
1025		1417
		1418	=item $fd = $term->pty_fd
		1419
		1420	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1421	is used.
		1422
1026	=item $windowid = $term->parent	1423	=item $windowid = $term->parent
1027		1424
1028	Return the window id of the toplevel window.	1425	Return the window id of the toplevel window.
1029		1426
1030	=item $windowid = $term->vt	1427	=item $windowid = $term->vt
1031		1428
1032	Return the window id of the terminal window.	1429	Return the window id of the terminal window.
1033		1430
		1431	=item $term->vt_emask_add ($x_event_mask)
		1432
		1433	Adds the specified events to the vt event mask. Useful e.g. when you want
		1434	to receive pointer events all the times:
		1435
		1436	$term->vt_emask_add (urxvt::PointerMotionMask);
		1437
		1438	=item $term->focus_in
		1439
		1440	=item $term->focus_out
		1441
		1442	=item $term->key_press ($state, $keycode[, $time])
		1443
		1444	=item $term->key_release ($state, $keycode[, $time])
		1445
		1446	Deliver various fake events to to terminal.
		1447
1034	=item $window_width = $term->width	1448	=item $window_width = $term->width
1035		1449
1036	=item $window_height = $term->height	1450	=item $window_height = $term->height
1037		1451
1038	=item $font_width = $term->fwidth	1452	=item $font_width = $term->fwidth
…		…
1051		1465
1052	=item $max_scrollback = $term->saveLines	1466	=item $max_scrollback = $term->saveLines
1053		1467
1054	=item $nrow_plus_saveLines = $term->total_rows	1468	=item $nrow_plus_saveLines = $term->total_rows
1055		1469
1056	=item $lines_in_scrollback = $term->nsaved	1470	=item $topmost_scrollback_row = $term->top_row
1057		1471
1058	Return various integers describing terminal characteristics.	1472	Return various integers describing terminal characteristics.
1059		1473
		1474	=item $x_display = $term->display_id
		1475
		1476	Return the DISPLAY used by rxvt-unicode.
		1477
1060	=item $lc_ctype = $term->locale	1478	=item $lc_ctype = $term->locale
1061		1479
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1480	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1481
1064	=item $x_display = $term->display_id	1482	=item $env = $term->env
1065		1483
1066	Return the DISPLAY used by rxvt-unicode.	1484	Returns a copy of the environment in effect for the terminal as a hashref
		1485	similar to C<\%ENV>.
		1486
		1487	=item @envv = $term->envv
		1488
		1489	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1490
		1491	=item @argv = $term->argv
		1492
		1493	Return the argument vector as this terminal, similar to @ARGV, but
		1494	includes the program name as first element.
		1495
		1496	=cut
		1497
		1498	sub env {
		1499	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1500	}
1067		1501
1068	=item $modifiermask = $term->ModLevel3Mask	1502	=item $modifiermask = $term->ModLevel3Mask
1069		1503
1070	=item $modifiermask = $term->ModMetaMask	1504	=item $modifiermask = $term->ModMetaMask
1071		1505
1072	=item $modifiermask = $term->ModNumLockMask	1506	=item $modifiermask = $term->ModNumLockMask
1073		1507
1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1508	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1075	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1509	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076		1510
		1511	=item $screen = $term->current_screen
		1512
		1513	Returns the currently displayed screen (0 primary, 1 secondary).
		1514
		1515	=item $cursor_is_hidden = $term->hidden_cursor
		1516
		1517	Returns wether the cursor is currently hidden or not.
		1518
1077	=item $view_start = $term->view_start ([$newvalue])	1519	=item $view_start = $term->view_start ([$newvalue])
1078		1520
1079	Returns the negative row number of the topmost line. Minimum value is	1521	Returns the row number of the topmost displayed line. Maximum value is
1080	C<0>, which displays the normal terminal contents. Larger values scroll	1522	C<0>, which displays the normal terminal contents. Lower values scroll
1081	this many lines into the scrollback buffer.	1523	this many lines into the scrollback buffer.
1082		1524
1083	=item $term->want_refresh	1525	=item $term->want_refresh
1084		1526
1085	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1527	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1100	line, starting at column C<$start_col> (default C<0>), which is useful	1542	line, starting at column C<$start_col> (default C<0>), which is useful
1101	to replace only parts of a line. The font index in the rendition will	1543	to replace only parts of a line. The font index in the rendition will
1102	automatically be updated.	1544	automatically be updated.
1103		1545
1104	C<$text> is in a special encoding: tabs and wide characters that use more	1546	C<$text> is in a special encoding: tabs and wide characters that use more
1105	than one cell when displayed are padded with urxvt::NOCHAR characters	1547	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1106	(C<chr 65535>). Characters with combining characters and other characters	1548	characters. Characters with combining characters and other characters that
1107	that do not fit into the normal tetx encoding will be replaced with	1549	do not fit into the normal tetx encoding will be replaced with characters
1108	characters in the private use area.	1550	in the private use area.
1109		1551
1110	You have to obey this encoding when changing text. The advantage is	1552	You have to obey this encoding when changing text. The advantage is
1111	that C<substr> and similar functions work on screen cells and not on	1553	that C<substr> and similar functions work on screen cells and not on
1112	characters.	1554	characters.
1113		1555
…		…
1164	Return the row number of the first/last row of the line, respectively.	1606	Return the row number of the first/last row of the line, respectively.
1165		1607
1166	=item $offset = $line->offset_of ($row, $col)	1608	=item $offset = $line->offset_of ($row, $col)
1167		1609
1168	Returns the character offset of the given row|col pair within the logical	1610	Returns the character offset of the given row|col pair within the logical
1169	line.	1611	line. Works for rows outside the line, too, and returns corresponding
		1612	offsets outside the string.
1170		1613
1171	=item ($row, $col) = $line->coord_of ($offset)	1614	=item ($row, $col) = $line->coord_of ($offset)
1172		1615
1173	Translates a string offset into terminal coordinates again.	1616	Translates a string offset into terminal coordinates again.
1174		1617
…		…
1259	=item $string = $term->special_decode $text	1702	=item $string = $term->special_decode $text
1260		1703
1261	Converts rxvt-unicodes text reprsentation into a perl string. See	1704	Converts rxvt-unicodes text reprsentation into a perl string. See
1262	C<< $term->ROW_t >> for details.	1705	C<< $term->ROW_t >> for details.
1263		1706
1264	=item $success = $term->grab_button ($button, $modifiermask)	1707	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1265		1708
		1709	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1710
1266	Registers a synchronous button grab. See the XGrabButton manpage.	1711	Register/unregister a synchronous button grab. See the XGrabButton
		1712	manpage.
1267		1713
1268	=item $success = $term->grab ($eventtime[, $sync])	1714	=item $success = $term->grab ($eventtime[, $sync])
1269		1715
1270	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1716	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1271	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1717	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1286	=item $term->ungrab	1732	=item $term->ungrab
1287		1733
1288	Calls XUngrab for the most recent grab. Is called automatically on	1734	Calls XUngrab for the most recent grab. Is called automatically on
1289	evaluation errors, as it is better to lose the grab in the error case as	1735	evaluation errors, as it is better to lose the grab in the error case as
1290	the session.	1736	the session.
		1737
		1738	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1739
		1740	=item $atom_name = $term->XGetAtomName ($atom)
		1741
		1742	=item @atoms = $term->XListProperties ($window)
		1743
		1744	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1745
		1746	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1747
		1748	=item $term->XDeleteProperty ($window, $property)
		1749
		1750	=item $window = $term->DefaultRootWindow
		1751
		1752	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1753
		1754	=item $term->XMapWindow ($window)
		1755
		1756	=item $term->XUnmapWindow ($window)
		1757
		1758	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1759
		1760	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1761
		1762	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1763
		1764	Various X or X-related functions. The C<$term> object only serves as
		1765	the source of the display, otherwise those functions map more-or-less
		1766	directory onto the X functions of the same name.
1291		1767
1292	=back	1768	=back
1293		1769
1294	=cut	1770	=cut
1295		1771
…		…
1359	my ($self, $text, $cb) = @_;	1835	my ($self, $text, $cb) = @_;
1360		1836
1361	$self->add_item ({ type => "button", text => $text, activate => $cb});	1837	$self->add_item ({ type => "button", text => $text, activate => $cb});
1362	}	1838	}
1363		1839
1364	=item $popup->add_toggle ($text, $cb, $initial_value)	1840	=item $popup->add_toggle ($text, $initial_value, $cb)
1365		1841
1366	Adds a toggle/checkbox item to the popup. Teh callback gets called	1842	Adds a toggle/checkbox item to the popup. The callback gets called
1367	whenever it gets toggled, with a boolean indicating its value as its first	1843	whenever it gets toggled, with a boolean indicating its new value as its
1368	argument.	1844	first argument.
1369		1845
1370	=cut	1846	=cut
1371		1847
1372	sub add_toggle {	1848	sub add_toggle {
1373	my ($self, $text, $cb, $value) = @_;	1849	my ($self, $text, $value, $cb) = @_;
1374		1850
1375	my $item; $item = {	1851	my $item; $item = {
1376	type => "button",	1852	type => "button",
1377	text => " $text",	1853	text => " $text",
1378	value => $value,	1854	value => $value,
…		…
1392	sub show {	1868	sub show {
1393	my ($self) = @_;	1869	my ($self) = @_;
1394		1870
1395	local $urxvt::popup::self = $self;	1871	local $urxvt::popup::self = $self;
1396		1872
		1873	my $env = $self->{term}->env;
		1874	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1875	delete $env->{LC_ALL};
1397	local $ENV{LC_ALL} = $self->{term}->locale;	1876	$env->{LC_CTYPE} = $self->{term}->locale;
1398		1877
1399	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1878	urxvt::term->new ($env, "popup",
		1879	"--perl-lib" => "", "--perl-ext-common" => "",
		1880	"-pty-fd" => -1, "-sl" => 0,
		1881	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1400	"--transient-for" => $self->{term}->parent,	1882	"--transient-for" => $self->{term}->parent,
1401	"-display" => $self->{term}->display_id,	1883	"-display" => $self->{term}->display_id,
1402	"-pe" => "urxvt-popup")	1884	"-pe" => "urxvt-popup")
1403	or die "unable to create popup window\n";	1885	or die "unable to create popup window\n";
1404	}	1886	}
1405		1887
1406	sub DESTROY {	1888	sub DESTROY {
1407	my ($self) = @_;	1889	my ($self) = @_;
1408		1890
1409	delete $self->{term}{_destroy}{$self};	1891	delete $self->{term}{_destroy}{$self};
1410	$self->{term}->ungrab;	1892	$self->{term}->ungrab;
1411	}	1893	}
		1894
		1895	=back
		1896
		1897	=cut
		1898
		1899	package urxvt::watcher;
		1900
		1901	@urxvt::timer::ISA = __PACKAGE__;
		1902	@urxvt::iow::ISA = __PACKAGE__;
		1903	@urxvt::pw::ISA = __PACKAGE__;
		1904	@urxvt::iw::ISA = __PACKAGE__;
1412		1905
1413	=head2 The C<urxvt::timer> Class	1906	=head2 The C<urxvt::timer> Class
1414		1907
1415	This class implements timer watchers/events. Time is represented as a	1908	This class implements timer watchers/events. Time is represented as a
1416	fractional number of seconds since the epoch. Example:	1909	fractional number of seconds since the epoch. Example:
…		…
1454	Start the timer.	1947	Start the timer.
1455		1948
1456	=item $timer = $timer->start ($tstamp)	1949	=item $timer = $timer->start ($tstamp)
1457		1950
1458	Set the event trigger time to C<$tstamp> and start the timer.	1951	Set the event trigger time to C<$tstamp> and start the timer.
		1952
		1953	=item $timer = $timer->after ($delay)
		1954
		1955	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1459		1956
1460	=item $timer = $timer->stop	1957	=item $timer = $timer->stop
1461		1958
1462	Stop the timer.	1959	Stop the timer.
1463		1960
…		…
1510		2007
1511	Stop watching for events on the given filehandle.	2008	Stop watching for events on the given filehandle.
1512		2009
1513	=back	2010	=back
1514		2011
		2012	=head2 The C<urxvt::iw> Class
		2013
		2014	This class implements idle watchers, that get called automatically when
		2015	the process is idle. They should return as fast as possible, after doing
		2016	some useful work.
		2017
		2018	=over 4
		2019
		2020	=item $iw = new urxvt::iw
		2021
		2022	Create a new idle watcher object in stopped state.
		2023
		2024	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2025
		2026	Set the callback to be called when the watcher triggers.
		2027
		2028	=item $timer = $timer->start
		2029
		2030	Start the watcher.
		2031
		2032	=item $timer = $timer->stop
		2033
		2034	Stop the watcher.
		2035
		2036	=back
		2037
		2038	=head2 The C<urxvt::pw> Class
		2039
		2040	This class implements process watchers. They create an event whenever a
		2041	process exits, after which they stop automatically.
		2042
		2043	my $pid = fork;
		2044	...
		2045	$term->{pw} = urxvt::pw
		2046	->new
		2047	->start ($pid)
		2048	->cb (sub {
		2049	my ($pw, $exit_status) = @_;
		2050	...
		2051	});
		2052
		2053	=over 4
		2054
		2055	=item $pw = new urxvt::pw
		2056
		2057	Create a new process watcher in stopped state.
		2058
		2059	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2060
		2061	Set the callback to be called when the timer triggers.
		2062
		2063	=item $pw = $timer->start ($pid)
		2064
		2065	Tells the wqtcher to start watching for process C<$pid>.
		2066
		2067	=item $pw = $pw->stop
		2068
		2069	Stop the watcher.
		2070
		2071	=back
		2072
1515	=head1 ENVIRONMENT	2073	=head1 ENVIRONMENT
1516		2074
1517	=head2 URXVT_PERL_VERBOSITY	2075	=head2 URXVT_PERL_VERBOSITY
1518		2076
1519	This variable controls the verbosity level of the perl extension. Higher	2077	This variable controls the verbosity level of the perl extension. Higher
…		…
1523		2081
1524	=item == 0 - fatal messages	2082	=item == 0 - fatal messages
1525		2083
1526	=item >= 3 - script loading and management	2084	=item >= 3 - script loading and management
1527		2085
1528	=item >=10 - all events received	2086	=item >=10 - all called hooks
		2087
		2088	=item >=11 - hook reutrn values
1529		2089
1530	=back	2090	=back
1531		2091
1532	=head1 AUTHOR	2092	=head1 AUTHOR
1533		2093

Diff Legend

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