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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC vs.
Revision 1.136 by root, Mon Feb 20 20:44:22 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
…		…
117	URxvt.selection-autotransform.0: transform	189	URxvt.selection-autotransform.0: transform
118	URxvt.selection-autotransform.1: transform	190	URxvt.selection-autotransform.1: transform
119	...	191	...
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<word:number> into C<vi +$number $word>:	194	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		195	$word>:
123		196
124	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/	197	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
125		198
126	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
127	paste directory into your (vi :) editor:	200	paste directly into your (vi :) editor:
128		201
129	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\x0d:$2\\x0d/	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.
130		238
131	=item mark-urls	239	=item mark-urls
132		240
133	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
134	make them clickable. When middle-clicked, the program specified in the	242	make them clickable. When middle-clicked, the program specified in the
135	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
136	the URL as first argument.	244	the URL as first argument.
137		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
138	=item block-graphics-to-ascii	266	=item block-graphics-to-ascii
139		267
140	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,
141	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
142	similar-looking ascii character.	270	similar-looking ascii character.
143		271
144	=item digital-clock	272	=item digital-clock
145		273
146	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/%
147		324
148	=item example-refresh-hooks	325	=item example-refresh-hooks
149		326
150	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
151	window. Illustrates overwriting the refresh callbacks to create your own	328	window. Illustrates overwriting the refresh callbacks to create your own
…		…
230	called whenever the relevant event happens.	407	called whenever the relevant event happens.
231		408
232	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
233	the in the C<Extension Objects> section.	410	the in the C<Extension Objects> section.
234		411
235	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
236	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
237	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.
238		415
239	I<< When in doubt, return a false value (preferably C<()>). >>	416	I<< When in doubt, return a false value (preferably C<()>). >>
240		417
241	=over 4	418	=over 4
242		419
243	=item on_init $term	420	=item on_init $term
244		421
245	Called after a new terminal object has been initialized, but before	422	Called after a new terminal object has been initialized, but before
246	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
247	call or deliver senseless data, as terminal size and other characteristics	424	call or deliver senseless data, as terminal size and other characteristics
248	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
249	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).
250		438
251	=item on_reset $term	439	=item on_reset $term
252		440
253	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
254	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
255	variables.	443	variables.
256		444
257	=item on_start $term	445	=item on_child_start $term, $pid
258		446
259	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.
260	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>.
261		453
262	=item on_sel_make $term, $eventtime	454	=item on_sel_make $term, $eventtime
263		455
264	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
265	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
…		…
352		544
353	=item on_refresh_end $term	545	=item on_refresh_end $term
354		546
355	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>.
356		548
357	=item on_keyboard_command $term, $string	549	=item on_user_command $term, $string
358		550
359	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
360	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>
361	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.
362		569
363	=item on_focus_in $term	570	=item on_focus_in $term
364		571
365	Called whenever the window gets the keyboard focus, before rxvt-unicode	572	Called whenever the window gets the keyboard focus, before rxvt-unicode
366	does focus in processing.	573	does focus in processing.
…		…
368	=item on_focus_out $term	575	=item on_focus_out $term
369		576
370	Called wheneever the window loses keyboard focus, before rxvt-unicode does	577	Called wheneever the window loses keyboard focus, before rxvt-unicode does
371	focus out processing.	578	focus out processing.
372		579
		580	=item on_configure_notify $term, $event
		581
		582	=item on_property_notify $term, $event
		583
373	=item on_key_press $term, $event, $keysym, $octets	584	=item on_key_press $term, $event, $keysym, $octets
374		585
375	=item on_key_release $term, $event, $keysym	586	=item on_key_release $term, $event, $keysym
376		587
377	=item on_button_press $term, $event	588	=item on_button_press $term, $event
…		…
386		597
387	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
388	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.
389		600
390	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
391	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
392	and column under the mouse cursor.	603	(real, not screen-based) row and column under the mouse cursor.
393		604
394	C<on_key_press> additionally receives the string rxvt-unicode would	605	C<on_key_press> additionally receives the string rxvt-unicode would
395	output, if any, in locale-specific encoding.	606	output, if any, in locale-specific encoding.
396		607
397	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).
398		618
399	=back	619	=back
400		620
401	=cut	621	=cut
402		622
…		…
408	use Scalar::Util ();	628	use Scalar::Util ();
409	use List::Util ();	629	use List::Util ();
410		630
411	our $VERSION = 1;	631	our $VERSION = 1;
412	our $TERM;	632	our $TERM;
		633	our @TERM_INIT;
		634	our @TERM_EXT;
413	our @HOOKNAME;	635	our @HOOKNAME;
414	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	636	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
415	our %OPTION;	637	our %OPTION;
416		638
417	our $LIBDIR;	639	our $LIBDIR;
418	our $RESNAME;	640	our $RESNAME;
419	our $RESCLASS;	641	our $RESCLASS;
420	our $RXVTNAME;	642	our $RXVTNAME;
421		643
		644	our $NOCHAR = chr 0xffff;
		645
422	=head2 Variables in the C<urxvt> Package	646	=head2 Variables in the C<urxvt> Package
423		647
424	=over 4	648	=over 4
425		649
426	=item $urxvt::LIBDIR	650	=item $urxvt::LIBDIR
…		…
438		662
439	=item $urxvt::TERM	663	=item $urxvt::TERM
440		664
441	The current terminal. This variable stores the current C<urxvt::term>	665	The current terminal. This variable stores the current C<urxvt::term>
442	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>.
443		683
444	=back	684	=back
445		685
446	=head2 Functions in the C<urxvt> Package	686	=head2 Functions in the C<urxvt> Package
447		687
…		…
462	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
463	correct place, e.g. on stderr of the connecting urxvtc client.	703	correct place, e.g. on stderr of the connecting urxvtc client.
464		704
465	Messages have a size limit of 1023 bytes currently.	705	Messages have a size limit of 1023 bytes currently.
466		706
467	=item $is_safe = urxvt::safe	707	=item @terms = urxvt::termlist
468		708
469	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
470	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
471	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).
472		713
473	=item $time = urxvt::NOW	714	=item $time = urxvt::NOW
474		715
475	Returns the "current time" (as per the event loop).	716	Returns the "current time" (as per the event loop).
476		717
477	=item urxvt::CurrentTime	718	=item urxvt::CurrentTime
478		719
479	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	720	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
480	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	721	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
481	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
482		739
483	Various constants for use in X calls and event processing.	740	Various constants for use in X calls and event processing.
484		741
485	=back	742	=back
486		743
…		…
519		776
520	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	777	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
521		778
522	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	779	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
523		780
		781	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		782
524	Replace the foreground/background colour in the rendition mask with the	783	Replace the foreground/background colour in the rendition mask with the
525	specified one.	784	specified one.
526		785
527	=item $value = urxvt::GET_CUSTOM $rend	786	=item $value = urxvt::GET_CUSTOM $rend
528		787
…		…
537	=back	796	=back
538		797
539	=cut	798	=cut
540		799
541	BEGIN {	800	BEGIN {
542	urxvt->bootstrap;
543
544	# overwrite perl's warn	801	# overwrite perl's warn
545	*CORE::GLOBAL::warn = sub {	802	*CORE::GLOBAL::warn = sub {
546	my $msg = join "", @_;	803	my $msg = join "", @_;
547	$msg .= "\n"	804	$msg .= "\n"
548	unless $msg =~ /\n$/;	805	unless $msg =~ /\n$/;
549	urxvt::warn ($msg);	806	urxvt::warn ($msg);
550	};	807	};
551
552	# %ENV is the original startup environment
553	delete $ENV{IFS};
554	delete $ENV{CDPATH};
555	delete $ENV{BASH_ENV};
556	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
557	}	808	}
558		809
559	my @hook_count;	810	no warnings 'utf8';
		811
560	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	812	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
561		813
562	sub verbose {	814	sub verbose {
563	my ($level, $msg) = @_;	815	my ($level, $msg) = @_;
564	warn "$msg\n" if $level <= $verbosity;	816	warn "$msg\n" if $level <= $verbosity;
565	}	817	}
566		818
567	my $extension_pkg = "extension0000";
568	my %extension_pkg;	819	my %extension_pkg;
569		820
570	# load a single script into its own package, once only	821	# load a single script into its own package, once only
571	sub extension_package($) {	822	sub extension_package($) {
572	my ($path) = @_;	823	my ($path) = @_;
573		824
574	$extension_pkg{$path} \|\|= do {	825	$extension_pkg{$path} \|\|= do {
575	my $pkg = "urxvt::" . ($extension_pkg++);	826	$path =~ /([^\/\\]+)$/;
		827	my $pkg = $1;
		828	$pkg =~ s/[^[:word:]]/_/g;
		829	$pkg = "urxvt::ext::$pkg";
576		830
577	verbose 3, "loading extension '$path' into package '$pkg'";	831	verbose 3, "loading extension '$path' into package '$pkg'";
578		832
579	open my $fh, "<:raw", $path	833	open my $fh, "<:raw", $path
580	or die "$path: $!";	834	or die "$path: $!";
581		835
582	my $source = untaint	836	my $source =
583	"package $pkg; use strict; use utf8;\n"	837	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
584	. "use base urxvt::term::extension::;\n"
585	. "#line 1 \"$path\"\n{\n"	838	. "#line 1 \"$path\"\n{\n"
586	. (do { local $/; <$fh> })	839	. (do { local $/; <$fh> })
587	. "\n};\n1";	840	. "\n};\n1";
588		841
589	eval $source	842	eval $source
…		…
603	if ($htype == 0) { # INIT	856	if ($htype == 0) { # INIT
604	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	857	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
605		858
606	my %ext_arg;	859	my %ext_arg;
607		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
608	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	870	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
609	if ($_ eq "default") {	871	if ($_ eq "default") {
610	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	872	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
611	} elsif (/^-(.*)$/) {	873	} elsif (/^-(.*)$/) {
612	delete $ext_arg{$1};	874	delete $ext_arg{$1};
613	} elsif (/^([^<]+)<(.*)>$/) {	875	} elsif (/^([^<]+)<(.*)>$/) {
614	push @{ $ext_arg{$1} }, $2;	876	push @{ $ext_arg{$1} }, $2;
615	} else {	877	} else {
616	$ext_arg{$_} \|\|= [];	878	$ext_arg{$_} \|\|= [];
617	}	879	}
618	}	880	}
619		881
620	while (my ($ext, $argv) = each %ext_arg) {	882	for my $ext (sort keys %ext_arg) {
621	my @files = grep -f $_, map "$_/$ext", @dirs;	883	my @files = grep -f $_, map "$_/$ext", @dirs;
622		884
623	if (@files) {	885	if (@files) {
624	$TERM->register_package (extension_package $files[0], $argv);	886	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
625	} else {	887	} else {
626	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";
627	}	889	}
628	}	890	}
629		891
…		…
638	if $verbosity >= 10;	900	if $verbosity >= 10;
639		901
640	keys %$cb;	902	keys %$cb;
641		903
642	while (my ($pkg, $cb) = each %$cb) {	904	while (my ($pkg, $cb) = each %$cb) {
643	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	905	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
644	and last;	906	$retval \|\|= $retval_;
645		907
646	if ($@) {	908	if ($@) {
647	$TERM->ungrab; # better to lose the grab than the session	909	$TERM->ungrab; # better to lose the grab than the session
648	warn $@;	910	warn $@;
649	}	911	}
…		…
652	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	914	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
653	if $verbosity >= 11;	915	if $verbosity >= 11;
654	}	916	}
655		917
656	if ($htype == 1) { # DESTROY	918	if ($htype == 1) { # DESTROY
657	if (my $hook = delete $TERM->{_hook}) {
658	for my $htype (0..$#$hook) {
659	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
660	or set_should_invoke $htype, 0;
661	}
662	}
663
664	# clear package objects	919	# clear package objects
665	%$_ = () for values %{ $TERM->{_pkg} };	920	%$_ = () for values %{ $TERM->{_pkg} };
666		921
667	# clear package	922	# clear package
668	%$TERM = ();	923	%$TERM = ();
669	}	924	}
670		925
671	$retval	926	$retval
672	}	927	}
673		928
674	sub exec_async(@) {	929	sub SET_COLOR($$$) {
675	my $pid = fork;	930	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
676
677	return
678	if !defined $pid or $pid;
679
680	%ENV = %{ $TERM->env };
681
682	exec @_;
683	_exit 255;
684	}	931	}
685		932
686	# urxvt::term::extension	933	# urxvt::term::extension
687		934
688	package urxvt::term::extension;	935	package urxvt::term::extension;
…		…
694	while (my ($name, $cb) = each %hook) {	941	while (my ($name, $cb) = each %hook) {
695	my $htype = $HOOKTYPE{uc $name};	942	my $htype = $HOOKTYPE{uc $name};
696	defined $htype	943	defined $htype
697	or Carp::croak "unsupported hook type '$name'";	944	or Carp::croak "unsupported hook type '$name'";
698		945
		946	$self->set_should_invoke ($htype, +1)
699	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	947	unless exists $self->{term}{_hook}[$htype]{$pkg};
700	$hook_count[$htype]++
701	or urxvt::set_should_invoke $htype, 1;
702	}
703		948
704	$self->{term}{_hook}[$htype]{$pkg} = $cb;	949	$self->{term}{_hook}[$htype]{$pkg} = $cb;
705	}	950	}
706	}	951	}
707		952
…		…
712	for my $name (@hook) {	957	for my $name (@hook) {
713	my $htype = $HOOKTYPE{uc $name};	958	my $htype = $HOOKTYPE{uc $name};
714	defined $htype	959	defined $htype
715	or Carp::croak "unsupported hook type '$name'";	960	or Carp::croak "unsupported hook type '$name'";
716		961
		962	$self->set_should_invoke ($htype, -1)
717	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	963	if delete $self->{term}{_hook}[$htype]{$pkg};
718	--$hook_count[$htype]
719	or urxvt::set_should_invoke $htype, 0;
720	}
721	}	964	}
722	}	965	}
723		966
724	our $AUTOLOAD;	967	our $AUTOLOAD;
725		968
…		…
831	# find on_xxx subs in the package and register them	1074	# find on_xxx subs in the package and register them
832	# as hooks	1075	# as hooks
833	sub register_package {	1076	sub register_package {
834	my ($self, $pkg, $argv) = @_;	1077	my ($self, $pkg, $argv) = @_;
835		1078
		1079	no strict 'refs';
		1080
		1081	urxvt::verbose 6, "register package $pkg to $self";
		1082
		1083	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1084
836	my $proxy = bless {	1085	my $proxy = bless {
837	_pkg => $pkg,	1086	_pkg => $pkg,
838	argv => $argv,	1087	argv => $argv,
839	}, $pkg;	1088	}, $pkg;
840	Scalar::Util::weaken ($proxy->{term} = $self);	1089	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
855	hash which defines the environment of the new terminal.	1104	hash which defines the environment of the new terminal.
856		1105
857	Croaks (and probably outputs an error message) if the new instance	1106	Croaks (and probably outputs an error message) if the new instance
858	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
859	initialise perl, and the terminal object otherwise. The C<init> and	1108	initialise perl, and the terminal object otherwise. The C<init> and
860	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).
861		1111
862	=cut	1112	=cut
863		1113
864	sub new {	1114	sub new {
865	my ($class, $env, @args) = @_;	1115	my ($class, $env, @args) = @_;
866		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
867	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1120	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
868	}	1121	}
869		1122
870	=item $term->destroy	1123	=item $term->destroy
871		1124
872	Destroy the terminal object (close the window, free resources	1125	Destroy the terminal object (close the window, free resources
873	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
874	watchers (timers, io watchers) are still active.	1127	watchers (timers, io watchers) are still active.
875		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
876	=item $isset = $term->option ($optval[, $set])	1154	=item $isset = $term->option ($optval[, $set])
877		1155
878	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
879	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
880	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.
…		…
882	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
883	source file F</src/optinc.h> to see the actual list:	1161	source file F</src/optinc.h> to see the actual list:
884		1162
885	borderLess console cursorBlink cursorUnderline hold iconic insecure	1163	borderLess console cursorBlink cursorUnderline hold iconic insecure
886	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1164	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
887	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1165	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
888	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1166	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
889	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1167	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
890	tripleclickwords utmpInhibit visualBell	1168	transparent tripleclickwords utmpInhibit visualBell
891		1169
892	=item $value = $term->resource ($name[, $newval])	1170	=item $value = $term->resource ($name[, $newval])
893		1171
894	Returns the current resource value associated with a given name and	1172	Returns the current resource value associated with a given name and
895	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>
…		…
912		1190
913	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1191	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
914	borderLess color cursorBlink cursorUnderline cutchars delete_key	1192	borderLess color cursorBlink cursorUnderline cutchars delete_key
915	display_name embed ext_bwidth fade font geometry hold iconName	1193	display_name embed ext_bwidth fade font geometry hold iconName
916	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1194	imFont imLocale inputMethod insecure int_bwidth intensityStyles
917	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1195	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
918	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1196	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
919	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1197	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
920	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1198	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
921	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1199	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
922	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1200	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
923	shade term_name title transparent transparent_all tripleclickwords	1201	secondaryScreen secondaryScroll selectstyle shade term_name title
924	utmpInhibit visualBell	1202	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1203	visualBell
925		1204
926	=cut	1205	=cut
927		1206
928	sub resource($$;$) {	1207	sub resource($$;$) {
929	my ($self, $name) = (shift, shift);	1208	my ($self, $name) = (shift, shift);
…		…
1103		1382
1104	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
1105	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
1106	C<on_add_lines> hook, though.	1385	C<on_add_lines> hook, though.
1107		1386
		1387	=item $term->scr_change_screen ($screen)
		1388
		1389	Switch to given screen - 0 primary, 1 secondary.
		1390
1108	=item $term->cmd_parse ($octets)	1391	=item $term->cmd_parse ($octets)
1109		1392
1110	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
1111	locale-specific encoding of the terminal and can contain command sequences	1394	locale-specific encoding of the terminal and can contain command sequences
1112	(escape codes) that will be interpreted.	1395	(escape codes) that will be interpreted.
…		…
1122	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
1123	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
1124	description of C<< urxvt::timer->events >>. Make sure to always restore	1407	description of C<< urxvt::timer->events >>. Make sure to always restore
1125	the previous value.	1408	the previous value.
1126		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
1127	=item $windowid = $term->parent	1415	=item $windowid = $term->parent
1128		1416
1129	Return the window id of the toplevel window.	1417	Return the window id of the toplevel window.
1130		1418
1131	=item $windowid = $term->vt	1419	=item $windowid = $term->vt
1132		1420
1133	Return the window id of the terminal window.	1421	Return the window id of the terminal window.
1134		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
1135	=item $window_width = $term->width	1440	=item $window_width = $term->width
1136		1441
1137	=item $window_height = $term->height	1442	=item $window_height = $term->height
1138		1443
1139	=item $font_width = $term->fwidth	1444	=item $font_width = $term->fwidth
…		…
1152		1457
1153	=item $max_scrollback = $term->saveLines	1458	=item $max_scrollback = $term->saveLines
1154		1459
1155	=item $nrow_plus_saveLines = $term->total_rows	1460	=item $nrow_plus_saveLines = $term->total_rows
1156		1461
1157	=item $lines_in_scrollback = $term->nsaved	1462	=item $topmost_scrollback_row = $term->top_row
1158		1463
1159	Return various integers describing terminal characteristics.	1464	Return various integers describing terminal characteristics.
1160		1465
1161	=item $x_display = $term->display_id	1466	=item $x_display = $term->display_id
1162		1467
…		…
1169	=item $env = $term->env	1474	=item $env = $term->env
1170		1475
1171	Returns a copy of the environment in effect for the terminal as a hashref	1476	Returns a copy of the environment in effect for the terminal as a hashref
1172	similar to C<\%ENV>.	1477	similar to C<\%ENV>.
1173		1478
		1479	=item @envv = $term->envv
		1480
		1481	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1482
		1483	=item @argv = $term->argv
		1484
		1485	Return the argument vector as this terminal, similar to @ARGV, but
		1486	includes the program name as first element.
		1487
1174	=cut	1488	=cut
1175		1489
1176	sub env {	1490	sub env {
1177	if (my $env = $_[0]->_env) {
1178	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1491	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1179	} else {
1180	+{ %ENV }
1181	}
1182	}	1492	}
1183		1493
1184	=item $modifiermask = $term->ModLevel3Mask	1494	=item $modifiermask = $term->ModLevel3Mask
1185		1495
1186	=item $modifiermask = $term->ModMetaMask	1496	=item $modifiermask = $term->ModMetaMask
…		…
1188	=item $modifiermask = $term->ModNumLockMask	1498	=item $modifiermask = $term->ModNumLockMask
1189		1499
1190	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1500	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1191	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1501	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1192		1502
		1503	=item $screen = $term->current_screen
		1504
		1505	Returns the currently displayed screen (0 primary, 1 secondary).
		1506
		1507	=item $cursor_is_hidden = $term->hidden_cursor
		1508
		1509	Returns wether the cursor is currently hidden or not.
		1510
1193	=item $view_start = $term->view_start ([$newvalue])	1511	=item $view_start = $term->view_start ([$newvalue])
1194		1512
1195	Returns the negative row number of the topmost line. Minimum value is	1513	Returns the row number of the topmost displayed line. Maximum value is
1196	C<0>, which displays the normal terminal contents. Larger values scroll	1514	C<0>, which displays the normal terminal contents. Lower values scroll
1197	this many lines into the scrollback buffer.	1515	this many lines into the scrollback buffer.
1198		1516
1199	=item $term->want_refresh	1517	=item $term->want_refresh
1200		1518
1201	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1519	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1216	line, starting at column C<$start_col> (default C<0>), which is useful	1534	line, starting at column C<$start_col> (default C<0>), which is useful
1217	to replace only parts of a line. The font index in the rendition will	1535	to replace only parts of a line. The font index in the rendition will
1218	automatically be updated.	1536	automatically be updated.
1219		1537
1220	C<$text> is in a special encoding: tabs and wide characters that use more	1538	C<$text> is in a special encoding: tabs and wide characters that use more
1221	than one cell when displayed are padded with urxvt::NOCHAR characters	1539	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1222	(C<chr 65535>). Characters with combining characters and other characters	1540	characters. Characters with combining characters and other characters that
1223	that do not fit into the normal tetx encoding will be replaced with	1541	do not fit into the normal tetx encoding will be replaced with characters
1224	characters in the private use area.	1542	in the private use area.
1225		1543
1226	You have to obey this encoding when changing text. The advantage is	1544	You have to obey this encoding when changing text. The advantage is
1227	that C<substr> and similar functions work on screen cells and not on	1545	that C<substr> and similar functions work on screen cells and not on
1228	characters.	1546	characters.
1229		1547
…		…
1376	=item $string = $term->special_decode $text	1694	=item $string = $term->special_decode $text
1377		1695
1378	Converts rxvt-unicodes text reprsentation into a perl string. See	1696	Converts rxvt-unicodes text reprsentation into a perl string. See
1379	C<< $term->ROW_t >> for details.	1697	C<< $term->ROW_t >> for details.
1380		1698
1381	=item $success = $term->grab_button ($button, $modifiermask)	1699	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1382		1700
		1701	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1702
1383	Registers a synchronous button grab. See the XGrabButton manpage.	1703	Register/unregister a synchronous button grab. See the XGrabButton
		1704	manpage.
1384		1705
1385	=item $success = $term->grab ($eventtime[, $sync])	1706	=item $success = $term->grab ($eventtime[, $sync])
1386		1707
1387	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1708	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1388	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1709	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1403	=item $term->ungrab	1724	=item $term->ungrab
1404		1725
1405	Calls XUngrab for the most recent grab. Is called automatically on	1726	Calls XUngrab for the most recent grab. Is called automatically on
1406	evaluation errors, as it is better to lose the grab in the error case as	1727	evaluation errors, as it is better to lose the grab in the error case as
1407	the session.	1728	the session.
		1729
		1730	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1731
		1732	=item $atom_name = $term->XGetAtomName ($atom)
		1733
		1734	=item @atoms = $term->XListProperties ($window)
		1735
		1736	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1737
		1738	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1739
		1740	=item $term->XDeleteProperty ($window, $property)
		1741
		1742	=item $window = $term->DefaultRootWindow
		1743
		1744	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1745
		1746	=item $term->XMapWindow ($window)
		1747
		1748	=item $term->XUnmapWindow ($window)
		1749
		1750	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1751
		1752	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1753
		1754	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1755
		1756	Various X or X-related functions. The C<$term> object only serves as
		1757	the source of the display, otherwise those functions map more-or-less
		1758	directory onto the X functions of the same name.
1408		1759
1409	=back	1760	=back
1410		1761
1411	=cut	1762	=cut
1412		1763
…		…
1476	my ($self, $text, $cb) = @_;	1827	my ($self, $text, $cb) = @_;
1477		1828
1478	$self->add_item ({ type => "button", text => $text, activate => $cb});	1829	$self->add_item ({ type => "button", text => $text, activate => $cb});
1479	}	1830	}
1480		1831
1481	=item $popup->add_toggle ($text, $cb, $initial_value)	1832	=item $popup->add_toggle ($text, $initial_value, $cb)
1482		1833
1483	Adds a toggle/checkbox item to the popup. Teh callback gets called	1834	Adds a toggle/checkbox item to the popup. The callback gets called
1484	whenever it gets toggled, with a boolean indicating its value as its first	1835	whenever it gets toggled, with a boolean indicating its new value as its
1485	argument.	1836	first argument.
1486		1837
1487	=cut	1838	=cut
1488		1839
1489	sub add_toggle {	1840	sub add_toggle {
1490	my ($self, $text, $cb, $value) = @_;	1841	my ($self, $text, $value, $cb) = @_;
1491		1842
1492	my $item; $item = {	1843	my $item; $item = {
1493	type => "button",	1844	type => "button",
1494	text => " $text",	1845	text => " $text",
1495	value => $value,	1846	value => $value,
…		…
1514	my $env = $self->{term}->env;	1865	my $env = $self->{term}->env;
1515	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1866	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1516	delete $env->{LC_ALL};	1867	delete $env->{LC_ALL};
1517	$env->{LC_CTYPE} = $self->{term}->locale;	1868	$env->{LC_CTYPE} = $self->{term}->locale;
1518		1869
1519	urxvt::term->new ($env, $self->{term}->resource ("name"),	1870	urxvt::term->new ($env, "popup",
1520	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1871	"--perl-lib" => "", "--perl-ext-common" => "",
		1872	"-pty-fd" => -1, "-sl" => 0,
		1873	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1521	"--transient-for" => $self->{term}->parent,	1874	"--transient-for" => $self->{term}->parent,
1522	"-display" => $self->{term}->display_id,	1875	"-display" => $self->{term}->display_id,
1523	"-pe" => "urxvt-popup")	1876	"-pe" => "urxvt-popup")
1524	or die "unable to create popup window\n";	1877	or die "unable to create popup window\n";
1525	}	1878	}
…		…
1530	delete $self->{term}{_destroy}{$self};	1883	delete $self->{term}{_destroy}{$self};
1531	$self->{term}->ungrab;	1884	$self->{term}->ungrab;
1532	}	1885	}
1533		1886
1534	=back	1887	=back
		1888
		1889	=cut
		1890
		1891	package urxvt::watcher;
		1892
		1893	@urxvt::timer::ISA = __PACKAGE__;
		1894	@urxvt::iow::ISA = __PACKAGE__;
		1895	@urxvt::pw::ISA = __PACKAGE__;
		1896	@urxvt::iw::ISA = __PACKAGE__;
1535		1897
1536	=head2 The C<urxvt::timer> Class	1898	=head2 The C<urxvt::timer> Class
1537		1899
1538	This class implements timer watchers/events. Time is represented as a	1900	This class implements timer watchers/events. Time is represented as a
1539	fractional number of seconds since the epoch. Example:	1901	fractional number of seconds since the epoch. Example:
…		…
1577	Start the timer.	1939	Start the timer.
1578		1940
1579	=item $timer = $timer->start ($tstamp)	1941	=item $timer = $timer->start ($tstamp)
1580		1942
1581	Set the event trigger time to C<$tstamp> and start the timer.	1943	Set the event trigger time to C<$tstamp> and start the timer.
		1944
		1945	=item $timer = $timer->after ($delay)
		1946
		1947	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1582		1948
1583	=item $timer = $timer->stop	1949	=item $timer = $timer->stop
1584		1950
1585	Stop the timer.	1951	Stop the timer.
1586		1952
…		…
1633		1999
1634	Stop watching for events on the given filehandle.	2000	Stop watching for events on the given filehandle.
1635		2001
1636	=back	2002	=back
1637		2003
		2004	=head2 The C<urxvt::iw> Class
		2005
		2006	This class implements idle watchers, that get called automatically when
		2007	the process is idle. They should return as fast as possible, after doing
		2008	some useful work.
		2009
		2010	=over 4
		2011
		2012	=item $iw = new urxvt::iw
		2013
		2014	Create a new idle watcher object in stopped state.
		2015
		2016	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2017
		2018	Set the callback to be called when the watcher triggers.
		2019
		2020	=item $timer = $timer->start
		2021
		2022	Start the watcher.
		2023
		2024	=item $timer = $timer->stop
		2025
		2026	Stop the watcher.
		2027
		2028	=back
		2029
		2030	=head2 The C<urxvt::pw> Class
		2031
		2032	This class implements process watchers. They create an event whenever a
		2033	process exits, after which they stop automatically.
		2034
		2035	my $pid = fork;
		2036	...
		2037	$term->{pw} = urxvt::pw
		2038	->new
		2039	->start ($pid)
		2040	->cb (sub {
		2041	my ($pw, $exit_status) = @_;
		2042	...
		2043	});
		2044
		2045	=over 4
		2046
		2047	=item $pw = new urxvt::pw
		2048
		2049	Create a new process watcher in stopped state.
		2050
		2051	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2052
		2053	Set the callback to be called when the timer triggers.
		2054
		2055	=item $pw = $timer->start ($pid)
		2056
		2057	Tells the wqtcher to start watching for process C<$pid>.
		2058
		2059	=item $pw = $pw->stop
		2060
		2061	Stop the watcher.
		2062
		2063	=back
		2064
1638	=head1 ENVIRONMENT	2065	=head1 ENVIRONMENT
1639		2066
1640	=head2 URXVT_PERL_VERBOSITY	2067	=head2 URXVT_PERL_VERBOSITY
1641		2068
1642	This variable controls the verbosity level of the perl extension. Higher	2069	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.88 by root, Thu Jan 12 12:05:28 2006 UTC vs. Revision 1.136 by root, Mon Feb 20 20:44:22 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC vs.
Revision 1.136 by root, Mon Feb 20 20:44:22 2006 UTC