[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.133 by root, Mon Feb 6 06:14:08 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 the
		159	moment, it reacts to clicking with the 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 and	241	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	242	make them clickable. When middle-clicked, the program specified in the
91	C<urlLauncher> (default C<x-www-browser>) will be started.	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
92		265
93	=item block-graphics-to-ascii	266	=item block-graphics-to-ascii
94		267
95	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,
96	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
97	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/%
98		324
99	=item example-refresh-hooks	325	=item example-refresh-hooks
100		326
101	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
102	window. Illustrates overwriting the refresh callbacks to create your own	328	window. Illustrates overwriting the refresh callbacks to create your own
…		…
181	called whenever the relevant event happens.	407	called whenever the relevant event happens.
182		408
183	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
184	the in the C<Extension Objects> section.	410	the in the C<Extension Objects> section.
185		411
186	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
187	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
188	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.
189		415
190	I<< When in doubt, return a false value (preferably C<()>). >>	416	I<< When in doubt, return a false value (preferably C<()>). >>
191		417
192	=over 4	418	=over 4
193		419
194	=item on_init $term	420	=item on_init $term
195		421
196	Called after a new terminal object has been initialized, but before	422	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	423	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	424	call or deliver senseless data, as terminal size and other characteristics
199	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
200	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).
201		438
202	=item on_reset $term	439	=item on_reset $term
203		440
204	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
205	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
206	variables.	443	variables.
207		444
208	=item on_start $term	445	=item on_child_start $term, $pid
209		446
210	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.
211	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>.
212		453
213	=item on_sel_make $term, $eventtime	454	=item on_sel_make $term, $eventtime
214		455
215	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
216	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
…		…
230	=item on_sel_extend $term	471	=item on_sel_extend $term
231		472
232	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
233	click) and is either supposed to return false (normal operation), or	474	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	475	should extend the selection itelf and return true to suppress the built-in
235	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.
236		479
237	See the F<selection> example extension.	480	See the F<selection> example extension.
238		481
239	=item on_view_change $term, $offset	482	=item on_view_change $term, $offset
240		483
…		…
301		544
302	=item on_refresh_end $term	545	=item on_refresh_end $term
303		546
304	Called just after the screen gets redrawn. See C<on_refresh_begin>.	547	Called just after the screen gets redrawn. See C<on_refresh_begin>.
305		548
306	=item on_keyboard_command $term, $string	549	=item on_user_command $term, $string
307		550
308	Called whenever the user presses a key combination that has a	551	Called whenever the a user-configured event is being activated (e.g. via
309	C<perl:string> action bound to it (see description of the B<keysym>	552	a C<perl:string> action bound to a key, see description of the B<keysym>
310	resource in the @@RXVT_NAME@@(1) manpage).	553	resource in the @@RXVT_NAME@@(1) manpage).
		554
		555	The event is simply the action string. This interface is assumed to change
		556	slightly in the future.
		557
		558	=item on_x_event $term, $event
		559
		560	Called on every X event received on the vt window (and possibly other
		561	windows). Should only be used as a last resort. Most event structure
		562	members are not passed.
311		563
312	=item on_focus_in $term	564	=item on_focus_in $term
313		565
314	Called whenever the window gets the keyboard focus, before rxvt-unicode	566	Called whenever the window gets the keyboard focus, before rxvt-unicode
315	does focus in processing.	567	does focus in processing.
…		…
317	=item on_focus_out $term	569	=item on_focus_out $term
318		570
319	Called wheneever the window loses keyboard focus, before rxvt-unicode does	571	Called wheneever the window loses keyboard focus, before rxvt-unicode does
320	focus out processing.	572	focus out processing.
321		573
		574	=item on_configure_notify $term, $event
		575
		576	=item on_property_notify $term, $event
		577
322	=item on_key_press $term, $event, $keysym, $octets	578	=item on_key_press $term, $event, $keysym, $octets
323		579
324	=item on_key_release $term, $event, $keysym	580	=item on_key_release $term, $event, $keysym
325		581
326	=item on_button_press $term, $event	582	=item on_button_press $term, $event
…		…
335		591
336	Called whenever the corresponding X event is received for the terminal If	592	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.	593	the hook returns true, then the even will be ignored by rxvt-unicode.
338		594
339	The event is a hash with most values as named by Xlib (see the XEvent	595	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	596	manpage), with the additional members C<row> and C<col>, which are the
341	and column under the mouse cursor.	597	(real, not screen-based) row and column under the mouse cursor.
342		598
343	C<on_key_press> additionally receives the string rxvt-unicode would	599	C<on_key_press> additionally receives the string rxvt-unicode would
344	output, if any, in locale-specific encoding.	600	output, if any, in locale-specific encoding.
345		601
346	subwindow.	602	subwindow.
		603
		604	=item on_client_message $term, $event
		605
		606	=item on_wm_protocols $term, $event
		607
		608	=item on_wm_delete_window $term, $event
		609
		610	Called when various types of ClientMessage events are received (all with
		611	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
347		612
348	=back	613	=back
349		614
350	=cut	615	=cut
351		616
…		…
357	use Scalar::Util ();	622	use Scalar::Util ();
358	use List::Util ();	623	use List::Util ();
359		624
360	our $VERSION = 1;	625	our $VERSION = 1;
361	our $TERM;	626	our $TERM;
		627	our @TERM_INIT;
		628	our @TERM_EXT;
362	our @HOOKNAME;	629	our @HOOKNAME;
363	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	630	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364	our %OPTION;	631	our %OPTION;
365		632
366	our $LIBDIR;	633	our $LIBDIR;
367	our $RESNAME;	634	our $RESNAME;
368	our $RESCLASS;	635	our $RESCLASS;
369	our $RXVTNAME;	636	our $RXVTNAME;
370		637
		638	our $NOCHAR = chr 0xffff;
		639
371	=head2 Variables in the C<urxvt> Package	640	=head2 Variables in the C<urxvt> Package
372		641
373	=over 4	642	=over 4
374		643
375	=item $urxvt::LIBDIR	644	=item $urxvt::LIBDIR
…		…
387		656
388	=item $urxvt::TERM	657	=item $urxvt::TERM
389		658
390	The current terminal. This variable stores the current C<urxvt::term>	659	The current terminal. This variable stores the current C<urxvt::term>
391	object, whenever a callback/hook is executing.	660	object, whenever a callback/hook is executing.
		661
		662	=item @urxvt::TERM_INIT
		663
		664	All coderefs in this array will be called as methods of the next newly
		665	created C<urxvt::term> object (during the C<on_init> phase). The array
		666	gets cleared before the codereferences that were in it are being executed,
		667	so coderefs can push themselves onto it again if they so desire.
		668
		669	This complements to the perl-eval commandline option, but gets executed
		670	first.
		671
		672	=item @urxvt::TERM_EXT
		673
		674	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		675	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		676	but before other extensions. Gets cleared just like C<@TERM_INIT>.
392		677
393	=back	678	=back
394		679
395	=head2 Functions in the C<urxvt> Package	680	=head2 Functions in the C<urxvt> Package
396		681
…		…
411	Using this function has the advantage that its output ends up in the	696	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.	697	correct place, e.g. on stderr of the connecting urxvtc client.
413		698
414	Messages have a size limit of 1023 bytes currently.	699	Messages have a size limit of 1023 bytes currently.
415		700
416	=item $is_safe = urxvt::safe	701	=item @terms = urxvt::termlist
417		702
418	Returns true when it is safe to do potentially unsafe things, such as	703	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	704	wether they are started, being destroyed etc., so be careful. Only term
420	started setuid or setgid.	705	objects that have perl extensions attached will be returned (because there
		706	is no urxvt::term objet associated with others).
421		707
422	=item $time = urxvt::NOW	708	=item $time = urxvt::NOW
423		709
424	Returns the "current time" (as per the event loop).	710	Returns the "current time" (as per the event loop).
425		711
426	=item urxvt::CurrentTime	712	=item urxvt::CurrentTime
427		713
428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	714	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	715	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430	Button4Mask, Button5Mask, AnyModifier	716	Button4Mask, Button5Mask, AnyModifier
		717
		718	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		719	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		720	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		721	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		722	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		723	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		724	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		725
		726	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		727	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		728	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		729	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		730	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		731	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		732	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431		733
432	Various constants for use in X calls and event processing.	734	Various constants for use in X calls and event processing.
433		735
434	=back	736	=back
435		737
…		…
468		770
469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	771	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
470		772
471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	773	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
472		774
		775	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		776
473	Replace the foreground/background colour in the rendition mask with the	777	Replace the foreground/background colour in the rendition mask with the
474	specified one.	778	specified one.
475		779
476	=item $value = urxvt::GET_CUSTOM $rend	780	=item $value = urxvt::GET_CUSTOM $rend
477		781
…		…
486	=back	790	=back
487		791
488	=cut	792	=cut
489		793
490	BEGIN {	794	BEGIN {
491	urxvt->bootstrap;
492
493	# overwrite perl's warn	795	# overwrite perl's warn
494	*CORE::GLOBAL::warn = sub {	796	*CORE::GLOBAL::warn = sub {
495	my $msg = join "", @_;	797	my $msg = join "", @_;
496	$msg .= "\n"	798	$msg .= "\n"
497	unless $msg =~ /\n$/;	799	unless $msg =~ /\n$/;
498	urxvt::warn ($msg);	800	urxvt::warn ($msg);
499	};	801	};
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	}	802	}
507		803
508	my @hook_count;	804	no warnings 'utf8';
		805
509	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	806	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
510		807
511	sub verbose {	808	sub verbose {
512	my ($level, $msg) = @_;	809	my ($level, $msg) = @_;
513	warn "$msg\n" if $level <= $verbosity;	810	warn "$msg\n" if $level <= $verbosity;
514	}	811	}
515		812
516	my $extension_pkg = "extension0000";
517	my %extension_pkg;	813	my %extension_pkg;
518		814
519	# load a single script into its own package, once only	815	# load a single script into its own package, once only
520	sub extension_package($) {	816	sub extension_package($) {
521	my ($path) = @_;	817	my ($path) = @_;
522		818
523	$extension_pkg{$path} \|\|= do {	819	$extension_pkg{$path} \|\|= do {
524	my $pkg = "urxvt::" . ($extension_pkg++);	820	$path =~ /([^\/\\]+)$/;
		821	my $pkg = $1;
		822	$pkg =~ s/[^[:word:]]/_/g;
		823	$pkg = "urxvt::ext::$pkg";
525		824
526	verbose 3, "loading extension '$path' into package '$pkg'";	825	verbose 3, "loading extension '$path' into package '$pkg'";
527		826
528	open my $fh, "<:raw", $path	827	open my $fh, "<:raw", $path
529	or die "$path: $!";	828	or die "$path: $!";
530		829
531	my $source = untaint	830	my $source =
532	"package $pkg; use strict; use utf8;\n"	831	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
533	. "use base urxvt::term::extension::;\n"
534	. "#line 1 \"$path\"\n{\n"	832	. "#line 1 \"$path\"\n{\n"
535	. (do { local $/; <$fh> })	833	. (do { local $/; <$fh> })
536	. "\n};\n1";	834	. "\n};\n1";
537		835
538	eval $source	836	eval $source
…		…
552	if ($htype == 0) { # INIT	850	if ($htype == 0) { # INIT
553	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	851	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
554		852
555	my %ext_arg;	853	my %ext_arg;
556		854
		855	{
		856	my @init = @TERM_INIT;
		857	@TERM_INIT = ();
		858	$_->($TERM) for @init;
		859	my @pkg = @TERM_EXT;
		860	@TERM_EXT = ();
		861	$TERM->register_package ($_) for @pkg;
		862	}
		863
557	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	864	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
558	if ($_ eq "default") {	865	if ($_ eq "default") {
559	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	866	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
560	} elsif (/^-(.*)$/) {	867	} elsif (/^-(.*)$/) {
561	delete $ext_arg{$1};	868	delete $ext_arg{$1};
562	} elsif (/^([^<]+)<(.*)>$/) {	869	} elsif (/^([^<]+)<(.*)>$/) {
563	push @{ $ext_arg{$1} }, $2;	870	push @{ $ext_arg{$1} }, $2;
564	} else {	871	} else {
565	$ext_arg{$_} \|\|= [];	872	$ext_arg{$_} \|\|= [];
566	}	873	}
567	}	874	}
568		875
569	while (my ($ext, $argv) = each %ext_arg) {	876	for my $ext (sort keys %ext_arg) {
570	my @files = grep -f $_, map "$_/$ext", @dirs;	877	my @files = grep -f $_, map "$_/$ext", @dirs;
571		878
572	if (@files) {	879	if (@files) {
573	$TERM->register_package (extension_package $files[0], $argv);	880	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
574	} else {	881	} else {
575	warn "perl extension '$ext' not found in perl library search path\n";	882	warn "perl extension '$ext' not found in perl library search path\n";
576	}	883	}
577	}	884	}
578		885
…		…
587	if $verbosity >= 10;	894	if $verbosity >= 10;
588		895
589	keys %$cb;	896	keys %$cb;
590		897
591	while (my ($pkg, $cb) = each %$cb) {	898	while (my ($pkg, $cb) = each %$cb) {
592	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	899	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
593	and last;	900	$retval \|\|= $retval_;
594		901
595	if ($@) {	902	if ($@) {
596	$TERM->ungrab; # better to lose the grab than the session	903	$TERM->ungrab; # better to lose the grab than the session
597	warn $@;	904	warn $@;
598	}	905	}
599	}	906	}
		907
		908	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		909	if $verbosity >= 11;
600	}	910	}
601		911
602	if ($htype == 1) { # DESTROY	912	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	913	# clear package objects
611	%$_ = () for values %{ $TERM->{_pkg} };	914	%$_ = () for values %{ $TERM->{_pkg} };
612		915
613	# clear package	916	# clear package
614	%$TERM = ();	917	%$TERM = ();
615	}	918	}
616		919
617	$retval	920	$retval
		921	}
		922
		923	sub SET_COLOR($$$) {
		924	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
618	}	925	}
619		926
620	# urxvt::term::extension	927	# urxvt::term::extension
621		928
622	package urxvt::term::extension;	929	package urxvt::term::extension;
…		…
628	while (my ($name, $cb) = each %hook) {	935	while (my ($name, $cb) = each %hook) {
629	my $htype = $HOOKTYPE{uc $name};	936	my $htype = $HOOKTYPE{uc $name};
630	defined $htype	937	defined $htype
631	or Carp::croak "unsupported hook type '$name'";	938	or Carp::croak "unsupported hook type '$name'";
632		939
		940	$self->set_should_invoke ($htype, +1)
633	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	941	unless exists $self->{term}{_hook}[$htype]{$pkg};
634	$hook_count[$htype]++
635	or urxvt::set_should_invoke $htype, 1;
636	}
637		942
638	$self->{term}{_hook}[$htype]{$pkg} = $cb;	943	$self->{term}{_hook}[$htype]{$pkg} = $cb;
639	}	944	}
640	}	945	}
641		946
…		…
646	for my $name (@hook) {	951	for my $name (@hook) {
647	my $htype = $HOOKTYPE{uc $name};	952	my $htype = $HOOKTYPE{uc $name};
648	defined $htype	953	defined $htype
649	or Carp::croak "unsupported hook type '$name'";	954	or Carp::croak "unsupported hook type '$name'";
650		955
		956	$self->set_should_invoke ($htype, -1)
651	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	957	if delete $self->{term}{_hook}[$htype]{$pkg};
652	--$hook_count[$htype]
653	or urxvt::set_should_invoke $htype, 0;
654	}
655	}	958	}
656	}	959	}
657		960
658	our $AUTOLOAD;	961	our $AUTOLOAD;
659		962
…		…
765	# find on_xxx subs in the package and register them	1068	# find on_xxx subs in the package and register them
766	# as hooks	1069	# as hooks
767	sub register_package {	1070	sub register_package {
768	my ($self, $pkg, $argv) = @_;	1071	my ($self, $pkg, $argv) = @_;
769		1072
		1073	no strict 'refs';
		1074
		1075	urxvt::verbose 6, "register package $pkg to $self";
		1076
		1077	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1078
770	my $proxy = bless {	1079	my $proxy = bless {
771	_pkg => $pkg,	1080	_pkg => $pkg,
772	argv => $argv,	1081	argv => $argv,
773	}, $pkg;	1082	}, $pkg;
774	Scalar::Util::weaken ($proxy->{term} = $self);	1083	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
789	hash which defines the environment of the new terminal.	1098	hash which defines the environment of the new terminal.
790		1099
791	Croaks (and probably outputs an error message) if the new instance	1100	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	1101	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	1102	initialise perl, and the terminal object otherwise. The C<init> and
794	C<start> hooks will be called during this call.	1103	C<start> hooks will be called before this call returns, and are free to
		1104	refer to global data (which is race free).
795		1105
796	=cut	1106	=cut
797		1107
798	sub new {	1108	sub new {
799	my ($class, $env, @args) = @_;	1109	my ($class, $env, @args) = @_;
800		1110
		1111	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1112	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1113
801	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1114	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
802	}	1115	}
803		1116
804	=item $term->destroy	1117	=item $term->destroy
805		1118
806	Destroy the terminal object (close the window, free resources	1119	Destroy the terminal object (close the window, free resources
807	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1120	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
808	watchers (timers, io watchers) are still active.	1121	watchers (timers, io watchers) are still active.
809		1122
		1123	=item $term->exec_async ($cmd[, @args])
		1124
		1125	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1126	("starts") programs in the background. This function takes care of setting
		1127	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1128	be preferred over explicit calls to C<exec> or C<system>.
		1129
		1130	Returns the pid of the subprocess or C<undef> on error.
		1131
		1132	=cut
		1133
		1134	sub exec_async {
		1135	my $self = shift;
		1136
		1137	my $pid = fork;
		1138
		1139	return $pid
		1140	if !defined $pid or $pid;
		1141
		1142	%ENV = %{ $self->env };
		1143
		1144	exec @_;
		1145	urxvt::_exit 255;
		1146	}
		1147
810	=item $isset = $term->option ($optval[, $set])	1148	=item $isset = $term->option ($optval[, $set])
811		1149
812	Returns true if the option specified by C<$optval> is enabled, and	1150	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	1151	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.	1152	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
816	Here is a a likely non-exhaustive list of option names, please see the	1154	Here is a a likely non-exhaustive list of option names, please see the
817	source file F</src/optinc.h> to see the actual list:	1155	source file F</src/optinc.h> to see the actual list:
818		1156
819	borderLess console cursorBlink cursorUnderline hold iconic insecure	1157	borderLess console cursorBlink cursorUnderline hold iconic insecure
820	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1158	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
821	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1159	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
822	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1160	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
823	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1161	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
824	tripleclickwords utmpInhibit visualBell	1162	transparent tripleclickwords utmpInhibit visualBell
825		1163
826	=item $value = $term->resource ($name[, $newval])	1164	=item $value = $term->resource ($name[, $newval])
827		1165
828	Returns the current resource value associated with a given name and	1166	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>	1167	optionally sets a new value. Setting values is most useful in the C<init>
…		…
846		1184
847	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1185	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
848	borderLess color cursorBlink cursorUnderline cutchars delete_key	1186	borderLess color cursorBlink cursorUnderline cutchars delete_key
849	display_name embed ext_bwidth fade font geometry hold iconName	1187	display_name embed ext_bwidth fade font geometry hold iconName
850	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1188	imFont imLocale inputMethod insecure int_bwidth intensityStyles
851	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1189	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
852	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1190	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
853	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1191	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
854	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1192	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
855	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1193	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
856	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1194	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
857	shade term_name title transparent transparent_all tripleclickwords	1195	secondaryScreen secondaryScroll selectstyle shade term_name title
858	utmpInhibit visualBell	1196	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1197	visualBell
859		1198
860	=cut	1199	=cut
861		1200
862	sub resource($$;$) {	1201	sub resource($$;$) {
863	my ($self, $name) = (shift, shift);	1202	my ($self, $name) = (shift, shift);
…		…
898	=item ($row, $col) = $term->selection_end ([$row, $col])	1237	=item ($row, $col) = $term->selection_end ([$row, $col])
899		1238
900	Return the current values of the selection mark, begin or end positions,	1239	Return the current values of the selection mark, begin or end positions,
901	and optionally set them to new values.	1240	and optionally set them to new values.
902		1241
		1242	=item $term->selection_make ($eventtime[, $rectangular])
		1243
		1244	Tries to make a selection as set by C<selection_beg> and
		1245	C<selection_end>. If C<$rectangular> is true (default: false), a
		1246	rectangular selection will be made. This is the prefered function to make
		1247	a selection.
		1248
903	=item $success = $term->selection_grab ($eventtime)	1249	=item $success = $term->selection_grab ($eventtime)
904		1250
905	Try to request the primary selection from the server (for example, as set	1251	Try to request the primary selection text from the server (for example, as
906	by the next method).	1252	set by the next method). No visual feedback will be given. This function
		1253	is mostly useful from within C<on_sel_grab> hooks.
907		1254
908	=item $oldtext = $term->selection ([$newtext])	1255	=item $oldtext = $term->selection ([$newtext])
909		1256
910	Return the current selection text and optionally replace it by C<$newtext>.	1257	Return the current selection text and optionally replace it by C<$newtext>.
911		1258
…		…
1004	Convert the given locale-encoded octets into a perl string.	1351	Convert the given locale-encoded octets into a perl string.
1005		1352
1006	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1353	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1007		1354
1008	XORs the rendition values in the given span with the provided value	1355	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	1356	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1010	to the selection.	1357	refresh hooks to provide effects similar to the selection.
1011		1358
1012	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1359	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1013		1360
1014	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1361	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1015	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1362	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	1363	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
1017	it instead.	1364	it instead. Both styles I<MUST NOT> contain font styles.
1018		1365
1019	=item $term->scr_bell	1366	=item $term->scr_bell
1020		1367
1021	Ring the bell!	1368	Ring the bell!
1022		1369
…		…
1029		1376
1030	Normally its not a good idea to use this function, as programs might be	1377	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	1378	confused by changes in cursor position or scrolling. Its useful inside a
1032	C<on_add_lines> hook, though.	1379	C<on_add_lines> hook, though.
1033		1380
		1381	=item $term->scr_change_screen ($screen)
		1382
		1383	Switch to given screen - 0 primary, 1 secondary.
		1384
1034	=item $term->cmd_parse ($octets)	1385	=item $term->cmd_parse ($octets)
1035		1386
1036	Similar to C<scr_add_lines>, but the argument must be in the	1387	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	1388	locale-specific encoding of the terminal and can contain command sequences
1038	(escape codes) that will be interpreted.	1389	(escape codes) that will be interpreted.
…		…
1048	Replaces the event mask of the pty watcher by the given event mask. Can	1399	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	1400	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	1401	description of C<< urxvt::timer->events >>. Make sure to always restore
1051	the previous value.	1402	the previous value.
1052		1403
		1404	=item $fd = $term->pty_fd
		1405
		1406	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1407	is used.
		1408
1053	=item $windowid = $term->parent	1409	=item $windowid = $term->parent
1054		1410
1055	Return the window id of the toplevel window.	1411	Return the window id of the toplevel window.
1056		1412
1057	=item $windowid = $term->vt	1413	=item $windowid = $term->vt
1058		1414
1059	Return the window id of the terminal window.	1415	Return the window id of the terminal window.
1060		1416
		1417	=item $term->vt_emask_add ($x_event_mask)
		1418
		1419	Adds the specified events to the vt event mask. Useful e.g. when you want
		1420	to receive pointer events all the times:
		1421
		1422	$term->vt_emask_add (urxvt::PointerMotionMask);
		1423
		1424	=item $term->focus_in
		1425
		1426	=item $term->focus_out
		1427
		1428	=item $term->key_press ($state, $keycode[, $time])
		1429
		1430	=item $term->key_release ($state, $keycode[, $time])
		1431
		1432	Deliver various fake events to to terminal.
		1433
1061	=item $window_width = $term->width	1434	=item $window_width = $term->width
1062		1435
1063	=item $window_height = $term->height	1436	=item $window_height = $term->height
1064		1437
1065	=item $font_width = $term->fwidth	1438	=item $font_width = $term->fwidth
…		…
1078		1451
1079	=item $max_scrollback = $term->saveLines	1452	=item $max_scrollback = $term->saveLines
1080		1453
1081	=item $nrow_plus_saveLines = $term->total_rows	1454	=item $nrow_plus_saveLines = $term->total_rows
1082		1455
1083	=item $lines_in_scrollback = $term->nsaved	1456	=item $topmost_scrollback_row = $term->top_row
1084		1457
1085	Return various integers describing terminal characteristics.	1458	Return various integers describing terminal characteristics.
1086		1459
1087	=item $x_display = $term->display_id	1460	=item $x_display = $term->display_id
1088		1461
…		…
1114	=item $modifiermask = $term->ModNumLockMask	1487	=item $modifiermask = $term->ModNumLockMask
1115		1488
1116	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1489	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.	1490	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1118		1491
		1492	=item $screen = $term->current_screen
		1493
		1494	Returns the currently displayed screen (0 primary, 1 secondary).
		1495
		1496	=item $cursor_is_hidden = $term->hidden_cursor
		1497
		1498	Returns wether the cursor is currently hidden or not.
		1499
1119	=item $view_start = $term->view_start ([$newvalue])	1500	=item $view_start = $term->view_start ([$newvalue])
1120		1501
1121	Returns the negative row number of the topmost line. Minimum value is	1502	Returns the row number of the topmost displayed line. Maximum value is
1122	C<0>, which displays the normal terminal contents. Larger values scroll	1503	C<0>, which displays the normal terminal contents. Lower values scroll
1123	this many lines into the scrollback buffer.	1504	this many lines into the scrollback buffer.
1124		1505
1125	=item $term->want_refresh	1506	=item $term->want_refresh
1126		1507
1127	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1508	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	1523	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	1524	to replace only parts of a line. The font index in the rendition will
1144	automatically be updated.	1525	automatically be updated.
1145		1526
1146	C<$text> is in a special encoding: tabs and wide characters that use more	1527	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	1528	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1148	(C<chr 65535>). Characters with combining characters and other characters	1529	characters. Characters with combining characters and other characters that
1149	that do not fit into the normal tetx encoding will be replaced with	1530	do not fit into the normal tetx encoding will be replaced with characters
1150	characters in the private use area.	1531	in the private use area.
1151		1532
1152	You have to obey this encoding when changing text. The advantage is	1533	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	1534	that C<substr> and similar functions work on screen cells and not on
1154	characters.	1535	characters.
1155		1536
…		…
1206	Return the row number of the first/last row of the line, respectively.	1587	Return the row number of the first/last row of the line, respectively.
1207		1588
1208	=item $offset = $line->offset_of ($row, $col)	1589	=item $offset = $line->offset_of ($row, $col)
1209		1590
1210	Returns the character offset of the given row\|col pair within the logical	1591	Returns the character offset of the given row\|col pair within the logical
1211	line.	1592	line. Works for rows outside the line, too, and returns corresponding
		1593	offsets outside the string.
1212		1594
1213	=item ($row, $col) = $line->coord_of ($offset)	1595	=item ($row, $col) = $line->coord_of ($offset)
1214		1596
1215	Translates a string offset into terminal coordinates again.	1597	Translates a string offset into terminal coordinates again.
1216		1598
…		…
1301	=item $string = $term->special_decode $text	1683	=item $string = $term->special_decode $text
1302		1684
1303	Converts rxvt-unicodes text reprsentation into a perl string. See	1685	Converts rxvt-unicodes text reprsentation into a perl string. See
1304	C<< $term->ROW_t >> for details.	1686	C<< $term->ROW_t >> for details.
1305		1687
1306	=item $success = $term->grab_button ($button, $modifiermask)	1688	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1307		1689
		1690	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1691
1308	Registers a synchronous button grab. See the XGrabButton manpage.	1692	Register/unregister a synchronous button grab. See the XGrabButton
		1693	manpage.
1309		1694
1310	=item $success = $term->grab ($eventtime[, $sync])	1695	=item $success = $term->grab ($eventtime[, $sync])
1311		1696
1312	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1697	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1313	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1698	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1328	=item $term->ungrab	1713	=item $term->ungrab
1329		1714
1330	Calls XUngrab for the most recent grab. Is called automatically on	1715	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	1716	evaluation errors, as it is better to lose the grab in the error case as
1332	the session.	1717	the session.
		1718
		1719	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1720
		1721	=item $atom_name = $term->XGetAtomName ($atom)
		1722
		1723	=item @atoms = $term->XListProperties ($window)
		1724
		1725	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1726
		1727	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1728
		1729	=item $term->XDeleteProperty ($window, $property)
		1730
		1731	=item $window = $term->DefaultRootWindow
		1732
		1733	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1734
		1735	=item $term->XMapWindow ($window)
		1736
		1737	=item $term->XUnmapWindow ($window)
		1738
		1739	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1740
		1741	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1742
		1743	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1744
		1745	Various X or X-related functions. The C<$term> object only serves as
		1746	the source of the display, otherwise those functions map more-or-less
		1747	directory onto the X functions of the same name.
1333		1748
1334	=back	1749	=back
1335		1750
1336	=cut	1751	=cut
1337		1752
…		…
1401	my ($self, $text, $cb) = @_;	1816	my ($self, $text, $cb) = @_;
1402		1817
1403	$self->add_item ({ type => "button", text => $text, activate => $cb});	1818	$self->add_item ({ type => "button", text => $text, activate => $cb});
1404	}	1819	}
1405		1820
1406	=item $popup->add_toggle ($text, $cb, $initial_value)	1821	=item $popup->add_toggle ($text, $initial_value, $cb)
1407		1822
1408	Adds a toggle/checkbox item to the popup. Teh callback gets called	1823	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	1824	whenever it gets toggled, with a boolean indicating its new value as its
1410	argument.	1825	first argument.
1411		1826
1412	=cut	1827	=cut
1413		1828
1414	sub add_toggle {	1829	sub add_toggle {
1415	my ($self, $text, $cb, $value) = @_;	1830	my ($self, $text, $value, $cb) = @_;
1416		1831
1417	my $item; $item = {	1832	my $item; $item = {
1418	type => "button",	1833	type => "button",
1419	text => " $text",	1834	text => " $text",
1420	value => $value,	1835	value => $value,
…		…
1439	my $env = $self->{term}->env;	1854	my $env = $self->{term}->env;
1440	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1855	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1441	delete $env->{LC_ALL};	1856	delete $env->{LC_ALL};
1442	$env->{LC_CTYPE} = $self->{term}->locale;	1857	$env->{LC_CTYPE} = $self->{term}->locale;
1443		1858
1444	urxvt::term->new ($env, $self->{term}->resource ("name"),	1859	urxvt::term->new ($env, "popup",
1445	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1860	"--perl-lib" => "", "--perl-ext-common" => "",
		1861	"-pty-fd" => -1, "-sl" => 0,
		1862	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1446	"--transient-for" => $self->{term}->parent,	1863	"--transient-for" => $self->{term}->parent,
1447	"-display" => $self->{term}->display_id,	1864	"-display" => $self->{term}->display_id,
1448	"-pe" => "urxvt-popup")	1865	"-pe" => "urxvt-popup")
1449	or die "unable to create popup window\n";	1866	or die "unable to create popup window\n";
1450	}	1867	}
…		…
1455	delete $self->{term}{_destroy}{$self};	1872	delete $self->{term}{_destroy}{$self};
1456	$self->{term}->ungrab;	1873	$self->{term}->ungrab;
1457	}	1874	}
1458		1875
1459	=back	1876	=back
		1877
		1878	=cut
		1879
		1880	package urxvt::watcher;
		1881
		1882	@urxvt::timer::ISA = __PACKAGE__;
		1883	@urxvt::iow::ISA = __PACKAGE__;
		1884	@urxvt::pw::ISA = __PACKAGE__;
		1885	@urxvt::iw::ISA = __PACKAGE__;
1460		1886
1461	=head2 The C<urxvt::timer> Class	1887	=head2 The C<urxvt::timer> Class
1462		1888
1463	This class implements timer watchers/events. Time is represented as a	1889	This class implements timer watchers/events. Time is represented as a
1464	fractional number of seconds since the epoch. Example:	1890	fractional number of seconds since the epoch. Example:
…		…
1502	Start the timer.	1928	Start the timer.
1503		1929
1504	=item $timer = $timer->start ($tstamp)	1930	=item $timer = $timer->start ($tstamp)
1505		1931
1506	Set the event trigger time to C<$tstamp> and start the timer.	1932	Set the event trigger time to C<$tstamp> and start the timer.
		1933
		1934	=item $timer = $timer->after ($delay)
		1935
		1936	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1507		1937
1508	=item $timer = $timer->stop	1938	=item $timer = $timer->stop
1509		1939
1510	Stop the timer.	1940	Stop the timer.
1511		1941
…		…
1558		1988
1559	Stop watching for events on the given filehandle.	1989	Stop watching for events on the given filehandle.
1560		1990
1561	=back	1991	=back
1562		1992
		1993	=head2 The C<urxvt::iw> Class
		1994
		1995	This class implements idle watchers, that get called automatically when
		1996	the process is idle. They should return as fast as possible, after doing
		1997	some useful work.
		1998
		1999	=over 4
		2000
		2001	=item $iw = new urxvt::iw
		2002
		2003	Create a new idle watcher object in stopped state.
		2004
		2005	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2006
		2007	Set the callback to be called when the watcher triggers.
		2008
		2009	=item $timer = $timer->start
		2010
		2011	Start the watcher.
		2012
		2013	=item $timer = $timer->stop
		2014
		2015	Stop the watcher.
		2016
		2017	=back
		2018
		2019	=head2 The C<urxvt::pw> Class
		2020
		2021	This class implements process watchers. They create an event whenever a
		2022	process exits, after which they stop automatically.
		2023
		2024	my $pid = fork;
		2025	...
		2026	$term->{pw} = urxvt::pw
		2027	->new
		2028	->start ($pid)
		2029	->cb (sub {
		2030	my ($pw, $exit_status) = @_;
		2031	...
		2032	});
		2033
		2034	=over 4
		2035
		2036	=item $pw = new urxvt::pw
		2037
		2038	Create a new process watcher in stopped state.
		2039
		2040	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2041
		2042	Set the callback to be called when the timer triggers.
		2043
		2044	=item $pw = $timer->start ($pid)
		2045
		2046	Tells the wqtcher to start watching for process C<$pid>.
		2047
		2048	=item $pw = $pw->stop
		2049
		2050	Stop the watcher.
		2051
		2052	=back
		2053
1563	=head1 ENVIRONMENT	2054	=head1 ENVIRONMENT
1564		2055
1565	=head2 URXVT_PERL_VERBOSITY	2056	=head2 URXVT_PERL_VERBOSITY
1566		2057
1567	This variable controls the verbosity level of the perl extension. Higher	2058	This variable controls the verbosity level of the perl extension. Higher
…		…
1571		2062
1572	=item == 0 - fatal messages	2063	=item == 0 - fatal messages
1573		2064
1574	=item >= 3 - script loading and management	2065	=item >= 3 - script loading and management
1575		2066
1576	=item >=10 - all events received	2067	=item >=10 - all called hooks
		2068
		2069	=item >=11 - hook reutrn values
1577		2070
1578	=back	2071	=back
1579		2072
1580	=head1 AUTHOR	2073	=head1 AUTHOR
1581		2074

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.133 by root, Mon Feb 6 06:14:08 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.133 by root, Mon Feb 6 06:14:08 2006 UTC