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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.90 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.135 by root, Sun Feb 12 05:31:53 2006 UTC

…		…
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
39		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
…		…
63	the match. For example, the followign adds a regex that matches everything	67	the match. For example, the followign adds a regex that matches everything
64	between two vertical bars:	68	between two vertical bars:
65		69
66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
67		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
68	You can look at the source of the selection extension to see more	79	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	80	interesting uses, such as parsing a line from beginning to end.
70		81
71	This extension also offers the following bindable keyboard command:	82	This extension also offers following bindable keyboard commands:
72		83
73	=over 4	84	=over 4
74		85
75	=item rot13	86	=item rot13
76		87
…		…
83	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
84		95
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.	97	runtime.
87		98
		99	Other extensions can extend this popup menu by pushing a code reference
		100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		101	popup is being displayed.
		102
		103	It's sole argument is the popup menu, which can be modified. It should
		104	either return nothing or a string, the initial boolean value and a code
		105	reference. The string will be used as button text and the code reference
		106	will be called when the toggle changes, with the new boolean value as
		107	first argument.
		108
		109	The following will add an entry C<myoption> that changes
		110	C<$self->{myoption}>:
		111
		112	push @{ $self->{term}{option_popup_hook} }, sub {
		113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		114	};
		115
88	=item selection-popup (enabled by default)	116	=item selection-popup (enabled by default)
89		117
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl	119	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	120	evaluation, web-browser starting etc.), depending on content.
		121
		122	Other extensions can extend this popup menu by pushing a code reference
		123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		124	popup is being displayed.
		125
		126	It's sole argument is the popup menu, which can be modified. The selection
		127	is in C<$_>, which can be used to decide 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	};
93		140
94	=item searchable-scrollback<hotkey> (enabled by default)	141	=item searchable-scrollback<hotkey> (enabled by default)
95		142
96	Adds regex search functionality to the scrollback buffer, triggered	143	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
104	bottom. C<Escape> leaves search mode and returns to the point where search	151	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and	152	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary	153	additionally stores the first match in the current line into the primary
107	selection.	154	selection.
108		155
		156	=item readline (enabled by default)
		157
		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
109	=item selection-autotransform	181	=item selection-autotransform
110		182
111	This selection allows you to do automatic transforms on a selection	183	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	184	whenever a selection is made.
113		185
…		…
120		192
121	For example, the following will transform selections of the form	193	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename	194	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:	195	$word>:
124		196
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	197	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		198
127	And this example matches the same,but replaces it with vi-commands you can	199	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:	200	paste directly into your (vi :) editor:
129		201
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	202	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		203
132	Of course, this can be modified to suit your needs and your editor :)	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.
133		238
134	=item mark-urls	239	=item mark-urls
135		240
136	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
137	make them clickable. When middle-clicked, the program specified in the	242	make them clickable. When middle-clicked, the program specified in the
138	resource C<urlLauncher> (default C<x-www-browser>) will be started with	243	resource C<urlLauncher> (default C<x-www-browser>) will be started with
139	the URL as first argument.	244	the URL as first argument.
140		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
		265
141	=item block-graphics-to-ascii	266	=item block-graphics-to-ascii
142		267
143	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,
144	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
145	similar-looking ascii character.	270	similar-looking ascii character.
146		271
147	=item digital-clock	272	=item digital-clock
148		273
149	Displays a digital clock using the built-in overlay.	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/%
150		324
151	=item example-refresh-hooks	325	=item example-refresh-hooks
152		326
153	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
154	window. Illustrates overwriting the refresh callbacks to create your own	328	window. Illustrates overwriting the refresh callbacks to create your own
…		…
233	called whenever the relevant event happens.	407	called whenever the relevant event happens.
234		408
235	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
236	the in the C<Extension Objects> section.	410	the in the C<Extension Objects> section.
237		411
238	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
239	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
240	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.
241		415
242	I<< When in doubt, return a false value (preferably C<()>). >>	416	I<< When in doubt, return a false value (preferably C<()>). >>
243		417
244	=over 4	418	=over 4
245		419
246	=item on_init $term	420	=item on_init $term
247		421
248	Called after a new terminal object has been initialized, but before	422	Called after a new terminal object has been initialized, but before
249	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
250	call or deliver senseless data, as terminal size and other characteristics	424	call or deliver senseless data, as terminal size and other characteristics
251	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
252	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).
253		438
254	=item on_reset $term	439	=item on_reset $term
255		440
256	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
257	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
258	variables.	443	variables.
259		444
260	=item on_start $term	445	=item on_child_start $term, $pid
261		446
262	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.
263	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>.
264		453
265	=item on_sel_make $term, $eventtime	454	=item on_sel_make $term, $eventtime
266		455
267	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
268	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
…		…
355		544
356	=item on_refresh_end $term	545	=item on_refresh_end $term
357		546
358	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>.
359		548
360	=item on_keyboard_command $term, $string	549	=item on_user_command $term, $string
361		550
362	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
363	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>
364	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_resize_all_windows $tern, $new_width, $new_height
		559
		560	Called just after the new window size has been calculcated, but before
		561	windows are actually being resized or hints are being set. If this hook
		562	returns TRUE, setting of the window hints is being skipped.
		563
		564	=item on_x_event $term, $event
		565
		566	Called on every X event received on the vt window (and possibly other
		567	windows). Should only be used as a last resort. Most event structure
		568	members are not passed.
365		569
366	=item on_focus_in $term	570	=item on_focus_in $term
367		571
368	Called whenever the window gets the keyboard focus, before rxvt-unicode	572	Called whenever the window gets the keyboard focus, before rxvt-unicode
369	does focus in processing.	573	does focus in processing.
…		…
371	=item on_focus_out $term	575	=item on_focus_out $term
372		576
373	Called wheneever the window loses keyboard focus, before rxvt-unicode does	577	Called wheneever the window loses keyboard focus, before rxvt-unicode does
374	focus out processing.	578	focus out processing.
375		579
		580	=item on_configure_notify $term, $event
		581
		582	=item on_property_notify $term, $event
		583
376	=item on_key_press $term, $event, $keysym, $octets	584	=item on_key_press $term, $event, $keysym, $octets
377		585
378	=item on_key_release $term, $event, $keysym	586	=item on_key_release $term, $event, $keysym
379		587
380	=item on_button_press $term, $event	588	=item on_button_press $term, $event
…		…
389		597
390	Called whenever the corresponding X event is received for the terminal If	598	Called whenever the corresponding X event is received for the terminal If
391	the hook returns true, then the even will be ignored by rxvt-unicode.	599	the hook returns true, then the even will be ignored by rxvt-unicode.
392		600
393	The event is a hash with most values as named by Xlib (see the XEvent	601	The event is a hash with most values as named by Xlib (see the XEvent
394	manpage), with the additional members C<row> and C<col>, which are the row	602	manpage), with the additional members C<row> and C<col>, which are the
395	and column under the mouse cursor.	603	(real, not screen-based) row and column under the mouse cursor.
396		604
397	C<on_key_press> additionally receives the string rxvt-unicode would	605	C<on_key_press> additionally receives the string rxvt-unicode would
398	output, if any, in locale-specific encoding.	606	output, if any, in locale-specific encoding.
399		607
400	subwindow.	608	subwindow.
		609
		610	=item on_client_message $term, $event
		611
		612	=item on_wm_protocols $term, $event
		613
		614	=item on_wm_delete_window $term, $event
		615
		616	Called when various types of ClientMessage events are received (all with
		617	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
401		618
402	=back	619	=back
403		620
404	=cut	621	=cut
405		622
…		…
411	use Scalar::Util ();	628	use Scalar::Util ();
412	use List::Util ();	629	use List::Util ();
413		630
414	our $VERSION = 1;	631	our $VERSION = 1;
415	our $TERM;	632	our $TERM;
		633	our @TERM_INIT;
		634	our @TERM_EXT;
416	our @HOOKNAME;	635	our @HOOKNAME;
417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	636	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
418	our %OPTION;	637	our %OPTION;
419		638
420	our $LIBDIR;	639	our $LIBDIR;
421	our $RESNAME;	640	our $RESNAME;
422	our $RESCLASS;	641	our $RESCLASS;
423	our $RXVTNAME;	642	our $RXVTNAME;
424		643
		644	our $NOCHAR = chr 0xffff;
		645
425	=head2 Variables in the C<urxvt> Package	646	=head2 Variables in the C<urxvt> Package
426		647
427	=over 4	648	=over 4
428		649
429	=item $urxvt::LIBDIR	650	=item $urxvt::LIBDIR
…		…
441		662
442	=item $urxvt::TERM	663	=item $urxvt::TERM
443		664
444	The current terminal. This variable stores the current C<urxvt::term>	665	The current terminal. This variable stores the current C<urxvt::term>
445	object, whenever a callback/hook is executing.	666	object, whenever a callback/hook is executing.
		667
		668	=item @urxvt::TERM_INIT
		669
		670	All coderefs in this array will be called as methods of the next newly
		671	created C<urxvt::term> object (during the C<on_init> phase). The array
		672	gets cleared before the codereferences that were in it are being executed,
		673	so coderefs can push themselves onto it again if they so desire.
		674
		675	This complements to the perl-eval commandline option, but gets executed
		676	first.
		677
		678	=item @urxvt::TERM_EXT
		679
		680	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		681	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		682	but before other extensions. Gets cleared just like C<@TERM_INIT>.
446		683
447	=back	684	=back
448		685
449	=head2 Functions in the C<urxvt> Package	686	=head2 Functions in the C<urxvt> Package
450		687
…		…
465	Using this function has the advantage that its output ends up in the	702	Using this function has the advantage that its output ends up in the
466	correct place, e.g. on stderr of the connecting urxvtc client.	703	correct place, e.g. on stderr of the connecting urxvtc client.
467		704
468	Messages have a size limit of 1023 bytes currently.	705	Messages have a size limit of 1023 bytes currently.
469		706
470	=item $is_safe = urxvt::safe	707	=item @terms = urxvt::termlist
471		708
472	Returns true when it is safe to do potentially unsafe things, such as	709	Returns all urxvt::term objects that exist in this process, regardless of
473	evaluating perl code specified by the user. This is true when urxvt was	710	wether they are started, being destroyed etc., so be careful. Only term
474	started setuid or setgid.	711	objects that have perl extensions attached will be returned (because there
		712	is no urxvt::term objet associated with others).
475		713
476	=item $time = urxvt::NOW	714	=item $time = urxvt::NOW
477		715
478	Returns the "current time" (as per the event loop).	716	Returns the "current time" (as per the event loop).
479		717
480	=item urxvt::CurrentTime	718	=item urxvt::CurrentTime
481		719
482	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	720	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
483	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	721	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
484	Button4Mask, Button5Mask, AnyModifier	722	Button4Mask, Button5Mask, AnyModifier
		723
		724	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		725	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		726	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		727	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		728	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		729	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		730	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		731
		732	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		733	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		734	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		735	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		736	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		737	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		738	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
485		739
486	Various constants for use in X calls and event processing.	740	Various constants for use in X calls and event processing.
487		741
488	=back	742	=back
489		743
…		…
522		776
523	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	777	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
524		778
525	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	779	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
526		780
		781	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		782
527	Replace the foreground/background colour in the rendition mask with the	783	Replace the foreground/background colour in the rendition mask with the
528	specified one.	784	specified one.
529		785
530	=item $value = urxvt::GET_CUSTOM $rend	786	=item $value = urxvt::GET_CUSTOM $rend
531		787
…		…
540	=back	796	=back
541		797
542	=cut	798	=cut
543		799
544	BEGIN {	800	BEGIN {
545	urxvt->bootstrap;
546
547	# overwrite perl's warn	801	# overwrite perl's warn
548	*CORE::GLOBAL::warn = sub {	802	*CORE::GLOBAL::warn = sub {
549	my $msg = join "", @_;	803	my $msg = join "", @_;
550	$msg .= "\n"	804	$msg .= "\n"
551	unless $msg =~ /\n$/;	805	unless $msg =~ /\n$/;
552	urxvt::warn ($msg);	806	urxvt::warn ($msg);
553	};	807	};
554
555	# %ENV is the original startup environment
556	delete $ENV{IFS};
557	delete $ENV{CDPATH};
558	delete $ENV{BASH_ENV};
559	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
560	}	808	}
561		809
562	my @hook_count;	810	no warnings 'utf8';
		811
563	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	812	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
564		813
565	sub verbose {	814	sub verbose {
566	my ($level, $msg) = @_;	815	my ($level, $msg) = @_;
567	warn "$msg\n" if $level <= $verbosity;	816	warn "$msg\n" if $level <= $verbosity;
568	}	817	}
569		818
570	my $extension_pkg = "extension0000";
571	my %extension_pkg;	819	my %extension_pkg;
572		820
573	# load a single script into its own package, once only	821	# load a single script into its own package, once only
574	sub extension_package($) {	822	sub extension_package($) {
575	my ($path) = @_;	823	my ($path) = @_;
576		824
577	$extension_pkg{$path} \|\|= do {	825	$extension_pkg{$path} \|\|= do {
578	my $pkg = "urxvt::" . ($extension_pkg++);	826	$path =~ /([^\/\\]+)$/;
		827	my $pkg = $1;
		828	$pkg =~ s/[^[:word:]]/_/g;
		829	$pkg = "urxvt::ext::$pkg";
579		830
580	verbose 3, "loading extension '$path' into package '$pkg'";	831	verbose 3, "loading extension '$path' into package '$pkg'";
581		832
582	open my $fh, "<:raw", $path	833	open my $fh, "<:raw", $path
583	or die "$path: $!";	834	or die "$path: $!";
584		835
585	my $source = untaint	836	my $source =
586	"package $pkg; use strict; use utf8;\n"	837	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
587	. "use base urxvt::term::extension::;\n"
588	. "#line 1 \"$path\"\n{\n"	838	. "#line 1 \"$path\"\n{\n"
589	. (do { local $/; <$fh> })	839	. (do { local $/; <$fh> })
590	. "\n};\n1";	840	. "\n};\n1";
591		841
592	eval $source	842	eval $source
…		…
606	if ($htype == 0) { # INIT	856	if ($htype == 0) { # INIT
607	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	857	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
608		858
609	my %ext_arg;	859	my %ext_arg;
610		860
		861	{
		862	my @init = @TERM_INIT;
		863	@TERM_INIT = ();
		864	$_->($TERM) for @init;
		865	my @pkg = @TERM_EXT;
		866	@TERM_EXT = ();
		867	$TERM->register_package ($_) for @pkg;
		868	}
		869
611	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	870	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
612	if ($_ eq "default") {	871	if ($_ eq "default") {
613	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	872	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
614	} elsif (/^-(.*)$/) {	873	} elsif (/^-(.*)$/) {
615	delete $ext_arg{$1};	874	delete $ext_arg{$1};
616	} elsif (/^([^<]+)<(.*)>$/) {	875	} elsif (/^([^<]+)<(.*)>$/) {
617	push @{ $ext_arg{$1} }, $2;	876	push @{ $ext_arg{$1} }, $2;
618	} else {	877	} else {
619	$ext_arg{$_} \|\|= [];	878	$ext_arg{$_} \|\|= [];
620	}	879	}
621	}	880	}
622		881
623	while (my ($ext, $argv) = each %ext_arg) {	882	for my $ext (sort keys %ext_arg) {
624	my @files = grep -f $_, map "$_/$ext", @dirs;	883	my @files = grep -f $_, map "$_/$ext", @dirs;
625		884
626	if (@files) {	885	if (@files) {
627	$TERM->register_package (extension_package $files[0], $argv);	886	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
628	} else {	887	} else {
629	warn "perl extension '$ext' not found in perl library search path\n";	888	warn "perl extension '$ext' not found in perl library search path\n";
630	}	889	}
631	}	890	}
632		891
…		…
641	if $verbosity >= 10;	900	if $verbosity >= 10;
642		901
643	keys %$cb;	902	keys %$cb;
644		903
645	while (my ($pkg, $cb) = each %$cb) {	904	while (my ($pkg, $cb) = each %$cb) {
646	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	905	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
647	and last;	906	$retval \|\|= $retval_;
648		907
649	if ($@) {	908	if ($@) {
650	$TERM->ungrab; # better to lose the grab than the session	909	$TERM->ungrab; # better to lose the grab than the session
651	warn $@;	910	warn $@;
652	}	911	}
…		…
655	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	914	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656	if $verbosity >= 11;	915	if $verbosity >= 11;
657	}	916	}
658		917
659	if ($htype == 1) { # DESTROY	918	if ($htype == 1) { # DESTROY
660	if (my $hook = delete $TERM->{_hook}) {
661	for my $htype (0..$#$hook) {
662	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
663	or set_should_invoke $htype, 0;
664	}
665	}
666
667	# clear package objects	919	# clear package objects
668	%$_ = () for values %{ $TERM->{_pkg} };	920	%$_ = () for values %{ $TERM->{_pkg} };
669		921
670	# clear package	922	# clear package
671	%$TERM = ();	923	%$TERM = ();
672	}	924	}
673		925
674	$retval	926	$retval
675	}	927	}
676		928
677	sub exec_async(@) {	929	sub SET_COLOR($$$) {
678	my $pid = fork;	930	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
679
680	return
681	if !defined $pid or $pid;
682
683	%ENV = %{ $TERM->env };
684
685	exec @_;
686	_exit 255;
687	}	931	}
688		932
689	# urxvt::term::extension	933	# urxvt::term::extension
690		934
691	package urxvt::term::extension;	935	package urxvt::term::extension;
…		…
697	while (my ($name, $cb) = each %hook) {	941	while (my ($name, $cb) = each %hook) {
698	my $htype = $HOOKTYPE{uc $name};	942	my $htype = $HOOKTYPE{uc $name};
699	defined $htype	943	defined $htype
700	or Carp::croak "unsupported hook type '$name'";	944	or Carp::croak "unsupported hook type '$name'";
701		945
		946	$self->set_should_invoke ($htype, +1)
702	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	947	unless exists $self->{term}{_hook}[$htype]{$pkg};
703	$hook_count[$htype]++
704	or urxvt::set_should_invoke $htype, 1;
705	}
706		948
707	$self->{term}{_hook}[$htype]{$pkg} = $cb;	949	$self->{term}{_hook}[$htype]{$pkg} = $cb;
708	}	950	}
709	}	951	}
710		952
…		…
715	for my $name (@hook) {	957	for my $name (@hook) {
716	my $htype = $HOOKTYPE{uc $name};	958	my $htype = $HOOKTYPE{uc $name};
717	defined $htype	959	defined $htype
718	or Carp::croak "unsupported hook type '$name'";	960	or Carp::croak "unsupported hook type '$name'";
719		961
		962	$self->set_should_invoke ($htype, -1)
720	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	963	if delete $self->{term}{_hook}[$htype]{$pkg};
721	--$hook_count[$htype]
722	or urxvt::set_should_invoke $htype, 0;
723	}
724	}	964	}
725	}	965	}
726		966
727	our $AUTOLOAD;	967	our $AUTOLOAD;
728		968
…		…
834	# find on_xxx subs in the package and register them	1074	# find on_xxx subs in the package and register them
835	# as hooks	1075	# as hooks
836	sub register_package {	1076	sub register_package {
837	my ($self, $pkg, $argv) = @_;	1077	my ($self, $pkg, $argv) = @_;
838		1078
		1079	no strict 'refs';
		1080
		1081	urxvt::verbose 6, "register package $pkg to $self";
		1082
		1083	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1084
839	my $proxy = bless {	1085	my $proxy = bless {
840	_pkg => $pkg,	1086	_pkg => $pkg,
841	argv => $argv,	1087	argv => $argv,
842	}, $pkg;	1088	}, $pkg;
843	Scalar::Util::weaken ($proxy->{term} = $self);	1089	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
858	hash which defines the environment of the new terminal.	1104	hash which defines the environment of the new terminal.
859		1105
860	Croaks (and probably outputs an error message) if the new instance	1106	Croaks (and probably outputs an error message) if the new instance
861	couldn't be created. Returns C<undef> if the new instance didn't	1107	couldn't be created. Returns C<undef> if the new instance didn't
862	initialise perl, and the terminal object otherwise. The C<init> and	1108	initialise perl, and the terminal object otherwise. The C<init> and
863	C<start> hooks will be called during this call.	1109	C<start> hooks will be called before this call returns, and are free to
		1110	refer to global data (which is race free).
864		1111
865	=cut	1112	=cut
866		1113
867	sub new {	1114	sub new {
868	my ($class, $env, @args) = @_;	1115	my ($class, $env, @args) = @_;
869		1116
		1117	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1118	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1119
870	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1120	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
871	}	1121	}
872		1122
873	=item $term->destroy	1123	=item $term->destroy
874		1124
875	Destroy the terminal object (close the window, free resources	1125	Destroy the terminal object (close the window, free resources
876	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1126	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
877	watchers (timers, io watchers) are still active.	1127	watchers (timers, io watchers) are still active.
878		1128
		1129	=item $term->exec_async ($cmd[, @args])
		1130
		1131	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1132	("starts") programs in the background. This function takes care of setting
		1133	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1134	be preferred over explicit calls to C<exec> or C<system>.
		1135
		1136	Returns the pid of the subprocess or C<undef> on error.
		1137
		1138	=cut
		1139
		1140	sub exec_async {
		1141	my $self = shift;
		1142
		1143	my $pid = fork;
		1144
		1145	return $pid
		1146	if !defined $pid or $pid;
		1147
		1148	%ENV = %{ $self->env };
		1149
		1150	exec @_;
		1151	urxvt::_exit 255;
		1152	}
		1153
879	=item $isset = $term->option ($optval[, $set])	1154	=item $isset = $term->option ($optval[, $set])
880		1155
881	Returns true if the option specified by C<$optval> is enabled, and	1156	Returns true if the option specified by C<$optval> is enabled, and
882	optionally change it. All option values are stored by name in the hash	1157	optionally change it. All option values are stored by name in the hash
883	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1158	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
885	Here is a a likely non-exhaustive list of option names, please see the	1160	Here is a a likely non-exhaustive list of option names, please see the
886	source file F</src/optinc.h> to see the actual list:	1161	source file F</src/optinc.h> to see the actual list:
887		1162
888	borderLess console cursorBlink cursorUnderline hold iconic insecure	1163	borderLess console cursorBlink cursorUnderline hold iconic insecure
889	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1164	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
890	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1165	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
891	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1166	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
892	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1167	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
893	tripleclickwords utmpInhibit visualBell	1168	transparent tripleclickwords utmpInhibit visualBell
894		1169
895	=item $value = $term->resource ($name[, $newval])	1170	=item $value = $term->resource ($name[, $newval])
896		1171
897	Returns the current resource value associated with a given name and	1172	Returns the current resource value associated with a given name and
898	optionally sets a new value. Setting values is most useful in the C<init>	1173	optionally sets a new value. Setting values is most useful in the C<init>
…		…
915		1190
916	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1191	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
917	borderLess color cursorBlink cursorUnderline cutchars delete_key	1192	borderLess color cursorBlink cursorUnderline cutchars delete_key
918	display_name embed ext_bwidth fade font geometry hold iconName	1193	display_name embed ext_bwidth fade font geometry hold iconName
919	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1194	imFont imLocale inputMethod insecure int_bwidth intensityStyles
920	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1195	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
921	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1196	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
922	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1197	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
923	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1198	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
924	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1199	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
925	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1200	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
926	shade term_name title transparent transparent_all tripleclickwords	1201	secondaryScreen secondaryScroll selectstyle shade term_name title
927	utmpInhibit visualBell	1202	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1203	visualBell
928		1204
929	=cut	1205	=cut
930		1206
931	sub resource($$;$) {	1207	sub resource($$;$) {
932	my ($self, $name) = (shift, shift);	1208	my ($self, $name) = (shift, shift);
…		…
1106		1382
1107	Normally its not a good idea to use this function, as programs might be	1383	Normally its not a good idea to use this function, as programs might be
1108	confused by changes in cursor position or scrolling. Its useful inside a	1384	confused by changes in cursor position or scrolling. Its useful inside a
1109	C<on_add_lines> hook, though.	1385	C<on_add_lines> hook, though.
1110		1386
		1387	=item $term->scr_change_screen ($screen)
		1388
		1389	Switch to given screen - 0 primary, 1 secondary.
		1390
1111	=item $term->cmd_parse ($octets)	1391	=item $term->cmd_parse ($octets)
1112		1392
1113	Similar to C<scr_add_lines>, but the argument must be in the	1393	Similar to C<scr_add_lines>, but the argument must be in the
1114	locale-specific encoding of the terminal and can contain command sequences	1394	locale-specific encoding of the terminal and can contain command sequences
1115	(escape codes) that will be interpreted.	1395	(escape codes) that will be interpreted.
…		…
1125	Replaces the event mask of the pty watcher by the given event mask. Can	1405	Replaces the event mask of the pty watcher by the given event mask. Can
1126	be used to suppress input and output handling to the pty/tty. See the	1406	be used to suppress input and output handling to the pty/tty. See the
1127	description of C<< urxvt::timer->events >>. Make sure to always restore	1407	description of C<< urxvt::timer->events >>. Make sure to always restore
1128	the previous value.	1408	the previous value.
1129		1409
		1410	=item $fd = $term->pty_fd
		1411
		1412	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1413	is used.
		1414
1130	=item $windowid = $term->parent	1415	=item $windowid = $term->parent
1131		1416
1132	Return the window id of the toplevel window.	1417	Return the window id of the toplevel window.
1133		1418
1134	=item $windowid = $term->vt	1419	=item $windowid = $term->vt
1135		1420
1136	Return the window id of the terminal window.	1421	Return the window id of the terminal window.
1137		1422
		1423	=item $term->vt_emask_add ($x_event_mask)
		1424
		1425	Adds the specified events to the vt event mask. Useful e.g. when you want
		1426	to receive pointer events all the times:
		1427
		1428	$term->vt_emask_add (urxvt::PointerMotionMask);
		1429
		1430	=item $term->focus_in
		1431
		1432	=item $term->focus_out
		1433
		1434	=item $term->key_press ($state, $keycode[, $time])
		1435
		1436	=item $term->key_release ($state, $keycode[, $time])
		1437
		1438	Deliver various fake events to to terminal.
		1439
1138	=item $window_width = $term->width	1440	=item $window_width = $term->width
1139		1441
1140	=item $window_height = $term->height	1442	=item $window_height = $term->height
1141		1443
1142	=item $font_width = $term->fwidth	1444	=item $font_width = $term->fwidth
…		…
1155		1457
1156	=item $max_scrollback = $term->saveLines	1458	=item $max_scrollback = $term->saveLines
1157		1459
1158	=item $nrow_plus_saveLines = $term->total_rows	1460	=item $nrow_plus_saveLines = $term->total_rows
1159		1461
1160	=item $lines_in_scrollback = $term->nsaved	1462	=item $topmost_scrollback_row = $term->top_row
1161		1463
1162	Return various integers describing terminal characteristics.	1464	Return various integers describing terminal characteristics.
1163		1465
1164	=item $x_display = $term->display_id	1466	=item $x_display = $term->display_id
1165		1467
…		…
1191	=item $modifiermask = $term->ModNumLockMask	1493	=item $modifiermask = $term->ModNumLockMask
1192		1494
1193	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1495	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1194	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1496	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1195		1497
		1498	=item $screen = $term->current_screen
		1499
		1500	Returns the currently displayed screen (0 primary, 1 secondary).
		1501
		1502	=item $cursor_is_hidden = $term->hidden_cursor
		1503
		1504	Returns wether the cursor is currently hidden or not.
		1505
1196	=item $view_start = $term->view_start ([$newvalue])	1506	=item $view_start = $term->view_start ([$newvalue])
1197		1507
1198	Returns the negative row number of the topmost line. Minimum value is	1508	Returns the row number of the topmost displayed line. Maximum value is
1199	C<0>, which displays the normal terminal contents. Larger values scroll	1509	C<0>, which displays the normal terminal contents. Lower values scroll
1200	this many lines into the scrollback buffer.	1510	this many lines into the scrollback buffer.
1201		1511
1202	=item $term->want_refresh	1512	=item $term->want_refresh
1203		1513
1204	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1514	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1219	line, starting at column C<$start_col> (default C<0>), which is useful	1529	line, starting at column C<$start_col> (default C<0>), which is useful
1220	to replace only parts of a line. The font index in the rendition will	1530	to replace only parts of a line. The font index in the rendition will
1221	automatically be updated.	1531	automatically be updated.
1222		1532
1223	C<$text> is in a special encoding: tabs and wide characters that use more	1533	C<$text> is in a special encoding: tabs and wide characters that use more
1224	than one cell when displayed are padded with urxvt::NOCHAR characters	1534	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1225	(C<chr 65535>). Characters with combining characters and other characters	1535	characters. Characters with combining characters and other characters that
1226	that do not fit into the normal tetx encoding will be replaced with	1536	do not fit into the normal tetx encoding will be replaced with characters
1227	characters in the private use area.	1537	in the private use area.
1228		1538
1229	You have to obey this encoding when changing text. The advantage is	1539	You have to obey this encoding when changing text. The advantage is
1230	that C<substr> and similar functions work on screen cells and not on	1540	that C<substr> and similar functions work on screen cells and not on
1231	characters.	1541	characters.
1232		1542
…		…
1379	=item $string = $term->special_decode $text	1689	=item $string = $term->special_decode $text
1380		1690
1381	Converts rxvt-unicodes text reprsentation into a perl string. See	1691	Converts rxvt-unicodes text reprsentation into a perl string. See
1382	C<< $term->ROW_t >> for details.	1692	C<< $term->ROW_t >> for details.
1383		1693
1384	=item $success = $term->grab_button ($button, $modifiermask)	1694	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1385		1695
		1696	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1697
1386	Registers a synchronous button grab. See the XGrabButton manpage.	1698	Register/unregister a synchronous button grab. See the XGrabButton
		1699	manpage.
1387		1700
1388	=item $success = $term->grab ($eventtime[, $sync])	1701	=item $success = $term->grab ($eventtime[, $sync])
1389		1702
1390	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1703	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1391	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1704	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1406	=item $term->ungrab	1719	=item $term->ungrab
1407		1720
1408	Calls XUngrab for the most recent grab. Is called automatically on	1721	Calls XUngrab for the most recent grab. Is called automatically on
1409	evaluation errors, as it is better to lose the grab in the error case as	1722	evaluation errors, as it is better to lose the grab in the error case as
1410	the session.	1723	the session.
		1724
		1725	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1726
		1727	=item $atom_name = $term->XGetAtomName ($atom)
		1728
		1729	=item @atoms = $term->XListProperties ($window)
		1730
		1731	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1732
		1733	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1734
		1735	=item $term->XDeleteProperty ($window, $property)
		1736
		1737	=item $window = $term->DefaultRootWindow
		1738
		1739	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1740
		1741	=item $term->XMapWindow ($window)
		1742
		1743	=item $term->XUnmapWindow ($window)
		1744
		1745	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1746
		1747	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1748
		1749	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1750
		1751	Various X or X-related functions. The C<$term> object only serves as
		1752	the source of the display, otherwise those functions map more-or-less
		1753	directory onto the X functions of the same name.
1411		1754
1412	=back	1755	=back
1413		1756
1414	=cut	1757	=cut
1415		1758
…		…
1479	my ($self, $text, $cb) = @_;	1822	my ($self, $text, $cb) = @_;
1480		1823
1481	$self->add_item ({ type => "button", text => $text, activate => $cb});	1824	$self->add_item ({ type => "button", text => $text, activate => $cb});
1482	}	1825	}
1483		1826
1484	=item $popup->add_toggle ($text, $cb, $initial_value)	1827	=item $popup->add_toggle ($text, $initial_value, $cb)
1485		1828
1486	Adds a toggle/checkbox item to the popup. Teh callback gets called	1829	Adds a toggle/checkbox item to the popup. The callback gets called
1487	whenever it gets toggled, with a boolean indicating its value as its first	1830	whenever it gets toggled, with a boolean indicating its new value as its
1488	argument.	1831	first argument.
1489		1832
1490	=cut	1833	=cut
1491		1834
1492	sub add_toggle {	1835	sub add_toggle {
1493	my ($self, $text, $cb, $value) = @_;	1836	my ($self, $text, $value, $cb) = @_;
1494		1837
1495	my $item; $item = {	1838	my $item; $item = {
1496	type => "button",	1839	type => "button",
1497	text => " $text",	1840	text => " $text",
1498	value => $value,	1841	value => $value,
…		…
1517	my $env = $self->{term}->env;	1860	my $env = $self->{term}->env;
1518	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1861	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1519	delete $env->{LC_ALL};	1862	delete $env->{LC_ALL};
1520	$env->{LC_CTYPE} = $self->{term}->locale;	1863	$env->{LC_CTYPE} = $self->{term}->locale;
1521		1864
1522	urxvt::term->new ($env, $self->{term}->resource ("name"),	1865	urxvt::term->new ($env, "popup",
1523	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1866	"--perl-lib" => "", "--perl-ext-common" => "",
		1867	"-pty-fd" => -1, "-sl" => 0,
		1868	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1524	"--transient-for" => $self->{term}->parent,	1869	"--transient-for" => $self->{term}->parent,
1525	"-display" => $self->{term}->display_id,	1870	"-display" => $self->{term}->display_id,
1526	"-pe" => "urxvt-popup")	1871	"-pe" => "urxvt-popup")
1527	or die "unable to create popup window\n";	1872	or die "unable to create popup window\n";
1528	}	1873	}
…		…
1533	delete $self->{term}{_destroy}{$self};	1878	delete $self->{term}{_destroy}{$self};
1534	$self->{term}->ungrab;	1879	$self->{term}->ungrab;
1535	}	1880	}
1536		1881
1537	=back	1882	=back
		1883
		1884	=cut
		1885
		1886	package urxvt::watcher;
		1887
		1888	@urxvt::timer::ISA = __PACKAGE__;
		1889	@urxvt::iow::ISA = __PACKAGE__;
		1890	@urxvt::pw::ISA = __PACKAGE__;
		1891	@urxvt::iw::ISA = __PACKAGE__;
1538		1892
1539	=head2 The C<urxvt::timer> Class	1893	=head2 The C<urxvt::timer> Class
1540		1894
1541	This class implements timer watchers/events. Time is represented as a	1895	This class implements timer watchers/events. Time is represented as a
1542	fractional number of seconds since the epoch. Example:	1896	fractional number of seconds since the epoch. Example:
…		…
1580	Start the timer.	1934	Start the timer.
1581		1935
1582	=item $timer = $timer->start ($tstamp)	1936	=item $timer = $timer->start ($tstamp)
1583		1937
1584	Set the event trigger time to C<$tstamp> and start the timer.	1938	Set the event trigger time to C<$tstamp> and start the timer.
		1939
		1940	=item $timer = $timer->after ($delay)
		1941
		1942	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1585		1943
1586	=item $timer = $timer->stop	1944	=item $timer = $timer->stop
1587		1945
1588	Stop the timer.	1946	Stop the timer.
1589		1947
…		…
1636		1994
1637	Stop watching for events on the given filehandle.	1995	Stop watching for events on the given filehandle.
1638		1996
1639	=back	1997	=back
1640		1998
		1999	=head2 The C<urxvt::iw> Class
		2000
		2001	This class implements idle watchers, that get called automatically when
		2002	the process is idle. They should return as fast as possible, after doing
		2003	some useful work.
		2004
		2005	=over 4
		2006
		2007	=item $iw = new urxvt::iw
		2008
		2009	Create a new idle watcher object in stopped state.
		2010
		2011	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2012
		2013	Set the callback to be called when the watcher triggers.
		2014
		2015	=item $timer = $timer->start
		2016
		2017	Start the watcher.
		2018
		2019	=item $timer = $timer->stop
		2020
		2021	Stop the watcher.
		2022
		2023	=back
		2024
		2025	=head2 The C<urxvt::pw> Class
		2026
		2027	This class implements process watchers. They create an event whenever a
		2028	process exits, after which they stop automatically.
		2029
		2030	my $pid = fork;
		2031	...
		2032	$term->{pw} = urxvt::pw
		2033	->new
		2034	->start ($pid)
		2035	->cb (sub {
		2036	my ($pw, $exit_status) = @_;
		2037	...
		2038	});
		2039
		2040	=over 4
		2041
		2042	=item $pw = new urxvt::pw
		2043
		2044	Create a new process watcher in stopped state.
		2045
		2046	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2047
		2048	Set the callback to be called when the timer triggers.
		2049
		2050	=item $pw = $timer->start ($pid)
		2051
		2052	Tells the wqtcher to start watching for process C<$pid>.
		2053
		2054	=item $pw = $pw->stop
		2055
		2056	Stop the watcher.
		2057
		2058	=back
		2059
1641	=head1 ENVIRONMENT	2060	=head1 ENVIRONMENT
1642		2061
1643	=head2 URXVT_PERL_VERBOSITY	2062	=head2 URXVT_PERL_VERBOSITY
1644		2063
1645	This variable controls the verbosity level of the perl extension. Higher	2064	This variable controls the verbosity level of the perl extension. Higher

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.90 by root, Thu Jan 12 12:15:10 2006 UTC vs. Revision 1.135 by root, Sun Feb 12 05:31:53 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.90 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.135 by root, Sun Feb 12 05:31:53 2006 UTC