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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC vs.
Revision 1.139 by root, Sat Jul 1 19:04:43 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 following bindable keyboard commands:	82	This extension also offers following bindable keyboard commands:
72		83
…		…
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
…		…
125	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\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/^([^:[:space:]]+(\\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 :)
133		205
134	To expand the example above to typical perl error messages ("XXX at	206	To expand the example above to typical perl error messages ("XXX at
135	FILENAME line YYY."), you need a slightly more elaborate solution:	207	FILENAME line YYY."), you need a slightly more elaborate solution:
136		208
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	209	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	210	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139		211
140	The first line tells the selection code to treat the unchanging part of	212	The first line tells the selection code to treat the unchanging part of
141	every error message as a selection pattern, and the second line transforms	213	every error message as a selection pattern, and the second line transforms
142	the message into vi commands to load the file.	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.
143		238
144	=item mark-urls	239	=item mark-urls
145		240
146	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
147	make them clickable. When middle-clicked, the program specified in the	242	make them clickable. When middle-clicked, the program specified in the
148	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
149	the URL as first argument.	244	the URL as first argument.
150		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
151	=item block-graphics-to-ascii	266	=item block-graphics-to-ascii
152		267
153	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,
154	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
155	similar-looking ascii character.	270	similar-looking ascii character.
156		271
157	=item digital-clock	272	=item digital-clock
158		273
159	Displays a digital clock using the built-in overlay.	274	Displays a digital clock using the built-in overlay.
160		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/%
		324
161	=item example-refresh-hooks	325	=item example-refresh-hooks
162		326
163	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
164	window. Illustrates overwriting the refresh callbacks to create your own	328	window. Illustrates overwriting the refresh callbacks to create your own
165	overlays or changes.	329	overlays or changes.
166
167	=item selection-pastebin
168
169	This is a little rarely useful extension that Uploads the selection as
170	textfile to a remote site (or does other things).
171
172	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
173	i.e.
174
175	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
176
177	Pressing this combination runs a command with C<%> replaced by the name of
178	the textfile. This command can be set via a resource:
179
180	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
181
182	And the default is likely not useful to anybody but the few people around
183	here :)
184
185	The name of the textfile is the hex encoded md5 sum of the selection, so
186	the same content should lead to the same filename.
187
188	After a successful upload the selection will be replaced by the text given
189	in the C<selection-pastebin-url> resource (again, the % is the placeholder
190	for the filename):
191
192	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
193		330
194	=back	331	=back
195		332
196	=head1 API DOCUMENTATION	333	=head1 API DOCUMENTATION
197		334
…		…
231		368
232	=back	369	=back
233		370
234	=head2 Extension Objects	371	=head2 Extension Objects
235		372
236	Very perl extension is a perl class. A separate perl object is created	373	Every perl extension is a perl class. A separate perl object is created
237	for each terminal and each extension and passed as the first parameter to	374	for each terminal and each extension and passed as the first parameter to
238	hooks. So extensions can use their C<$self> object without having to think	375	hooks. So extensions can use their C<$self> object without having to think
239	about other extensions, with the exception of methods and members that	376	about other extensions, with the exception of methods and members that
240	begin with an underscore character C<_>: these are reserved for internal	377	begin with an underscore character C<_>: these are reserved for internal
241	use.	378	use.
…		…
270	called whenever the relevant event happens.	407	called whenever the relevant event happens.
271		408
272	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
273	the in the C<Extension Objects> section.	410	the in the C<Extension Objects> section.
274		411
275	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
276	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
277	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.
278		415
279	I<< When in doubt, return a false value (preferably C<()>). >>	416	I<< When in doubt, return a false value (preferably C<()>). >>
280		417
281	=over 4	418	=over 4
282		419
283	=item on_init $term	420	=item on_init $term
284		421
285	Called after a new terminal object has been initialized, but before	422	Called after a new terminal object has been initialized, but before
286	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
287	call or deliver senseless data, as terminal size and other characteristics	424	call or deliver senseless data, as terminal size and other characteristics
288	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
289	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).
290		438
291	=item on_reset $term	439	=item on_reset $term
292		440
293	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
294	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
295	variables.	443	variables.
296		444
297	=item on_start $term	445	=item on_child_start $term, $pid
298		446
299	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.
300	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>.
301		453
302	=item on_sel_make $term, $eventtime	454	=item on_sel_make $term, $eventtime
303		455
304	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
305	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
…		…
341		493
342	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	494	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
343	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	495	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
344	number of lines that will be in the scrollback buffer.	496	number of lines that will be in the scrollback buffer.
345		497
		498	=item on_osc_seq $term, $op, $args
		499
		500	Called on every OSC sequence and can be used to suppress it or modify its
		501	behaviour. The default should be to return an empty list. A true value
		502	suppresses execution of the request completely. Make sure you don't get
		503	confused by recursive invocations when you output an osc sequence within
		504	this callback.
		505
		506	C<on_osc_seq_perl> should be used for new behaviour.
		507
346	=item on_osc_seq $term, $string	508	=item on_osc_seq_perl $term, $string
347		509
348	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	510	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
349	operating system command) is processed. Cursor position and other state	511	operating system command) is processed. Cursor position and other state
350	information is up-to-date when this happens. For interoperability, the	512	information is up-to-date when this happens. For interoperability, the
351	string should start with the extension name and a colon, to distinguish	513	string should start with the extension name and a colon, to distinguish
…		…
392		554
393	=item on_refresh_end $term	555	=item on_refresh_end $term
394		556
395	Called just after the screen gets redrawn. See C<on_refresh_begin>.	557	Called just after the screen gets redrawn. See C<on_refresh_begin>.
396		558
397	=item on_keyboard_command $term, $string	559	=item on_user_command $term, $string
398		560
399	Called whenever the user presses a key combination that has a	561	Called whenever the a user-configured event is being activated (e.g. via
400	C<perl:string> action bound to it (see description of the B<keysym>	562	a C<perl:string> action bound to a key, see description of the B<keysym>
401	resource in the @@RXVT_NAME@@(1) manpage).	563	resource in the @@RXVT_NAME@@(1) manpage).
		564
		565	The event is simply the action string. This interface is assumed to change
		566	slightly in the future.
		567
		568	=item on_resize_all_windows $tern, $new_width, $new_height
		569
		570	Called just after the new window size has been calculcated, but before
		571	windows are actually being resized or hints are being set. If this hook
		572	returns TRUE, setting of the window hints is being skipped.
402		573
403	=item on_x_event $term, $event	574	=item on_x_event $term, $event
404		575
405	Called on every X event received on the vt window (and possibly other	576	Called on every X event received on the vt window (and possibly other
406	windows). Should only be used as a last resort. Most event structure	577	windows). Should only be used as a last resort. Most event structure
…		…
414	=item on_focus_out $term	585	=item on_focus_out $term
415		586
416	Called wheneever the window loses keyboard focus, before rxvt-unicode does	587	Called wheneever the window loses keyboard focus, before rxvt-unicode does
417	focus out processing.	588	focus out processing.
418		589
		590	=item on_configure_notify $term, $event
		591
		592	=item on_property_notify $term, $event
		593
419	=item on_key_press $term, $event, $keysym, $octets	594	=item on_key_press $term, $event, $keysym, $octets
420		595
421	=item on_key_release $term, $event, $keysym	596	=item on_key_release $term, $event, $keysym
422		597
423	=item on_button_press $term, $event	598	=item on_button_press $term, $event
…		…
432		607
433	Called whenever the corresponding X event is received for the terminal If	608	Called whenever the corresponding X event is received for the terminal If
434	the hook returns true, then the even will be ignored by rxvt-unicode.	609	the hook returns true, then the even will be ignored by rxvt-unicode.
435		610
436	The event is a hash with most values as named by Xlib (see the XEvent	611	The event is a hash with most values as named by Xlib (see the XEvent
437	manpage), with the additional members C<row> and C<col>, which are the row	612	manpage), with the additional members C<row> and C<col>, which are the
438	and column under the mouse cursor.	613	(real, not screen-based) row and column under the mouse cursor.
439		614
440	C<on_key_press> additionally receives the string rxvt-unicode would	615	C<on_key_press> additionally receives the string rxvt-unicode would
441	output, if any, in locale-specific encoding.	616	output, if any, in locale-specific encoding.
442		617
443	subwindow.	618	subwindow.
		619
		620	=item on_client_message $term, $event
		621
		622	=item on_wm_protocols $term, $event
		623
		624	=item on_wm_delete_window $term, $event
		625
		626	Called when various types of ClientMessage events are received (all with
		627	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
444		628
445	=back	629	=back
446		630
447	=cut	631	=cut
448		632
…		…
454	use Scalar::Util ();	638	use Scalar::Util ();
455	use List::Util ();	639	use List::Util ();
456		640
457	our $VERSION = 1;	641	our $VERSION = 1;
458	our $TERM;	642	our $TERM;
		643	our @TERM_INIT;
		644	our @TERM_EXT;
459	our @HOOKNAME;	645	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	646	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	647	our %OPTION;
462		648
463	our $LIBDIR;	649	our $LIBDIR;
464	our $RESNAME;	650	our $RESNAME;
465	our $RESCLASS;	651	our $RESCLASS;
466	our $RXVTNAME;	652	our $RXVTNAME;
467		653
		654	our $NOCHAR = chr 0xffff;
		655
468	=head2 Variables in the C<urxvt> Package	656	=head2 Variables in the C<urxvt> Package
469		657
470	=over 4	658	=over 4
471		659
472	=item $urxvt::LIBDIR	660	=item $urxvt::LIBDIR
…		…
484		672
485	=item $urxvt::TERM	673	=item $urxvt::TERM
486		674
487	The current terminal. This variable stores the current C<urxvt::term>	675	The current terminal. This variable stores the current C<urxvt::term>
488	object, whenever a callback/hook is executing.	676	object, whenever a callback/hook is executing.
		677
		678	=item @urxvt::TERM_INIT
		679
		680	All coderefs in this array will be called as methods of the next newly
		681	created C<urxvt::term> object (during the C<on_init> phase). The array
		682	gets cleared before the codereferences that were in it are being executed,
		683	so coderefs can push themselves onto it again if they so desire.
		684
		685	This complements to the perl-eval commandline option, but gets executed
		686	first.
		687
		688	=item @urxvt::TERM_EXT
		689
		690	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		691	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		692	but before other extensions. Gets cleared just like C<@TERM_INIT>.
489		693
490	=back	694	=back
491		695
492	=head2 Functions in the C<urxvt> Package	696	=head2 Functions in the C<urxvt> Package
493		697
…		…
507		711
508	Using this function has the advantage that its output ends up in the	712	Using this function has the advantage that its output ends up in the
509	correct place, e.g. on stderr of the connecting urxvtc client.	713	correct place, e.g. on stderr of the connecting urxvtc client.
510		714
511	Messages have a size limit of 1023 bytes currently.	715	Messages have a size limit of 1023 bytes currently.
		716
		717	=item @terms = urxvt::termlist
		718
		719	Returns all urxvt::term objects that exist in this process, regardless of
		720	wether they are started, being destroyed etc., so be careful. Only term
		721	objects that have perl extensions attached will be returned (because there
		722	is no urxvt::term objet associated with others).
512		723
513	=item $time = urxvt::NOW	724	=item $time = urxvt::NOW
514		725
515	Returns the "current time" (as per the event loop).	726	Returns the "current time" (as per the event loop).
516		727
…		…
575		786
576	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	787	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
577		788
578	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	789	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
579		790
		791	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		792
580	Replace the foreground/background colour in the rendition mask with the	793	Replace the foreground/background colour in the rendition mask with the
581	specified one.	794	specified one.
582		795
583	=item $value = urxvt::GET_CUSTOM $rend	796	=item $value = urxvt::GET_CUSTOM $rend
584		797
…		…
593	=back	806	=back
594		807
595	=cut	808	=cut
596		809
597	BEGIN {	810	BEGIN {
598	urxvt->bootstrap;
599
600	# overwrite perl's warn	811	# overwrite perl's warn
601	*CORE::GLOBAL::warn = sub {	812	*CORE::GLOBAL::warn = sub {
602	my $msg = join "", @_;	813	my $msg = join "", @_;
603	$msg .= "\n"	814	$msg .= "\n"
604	unless $msg =~ /\n$/;	815	unless $msg =~ /\n$/;
605	urxvt::warn ($msg);	816	urxvt::warn ($msg);
606	};	817	};
607
608	# %ENV is the original startup environment
609	delete $ENV{IFS};
610	delete $ENV{CDPATH};
611	delete $ENV{BASH_ENV};
612	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
613	}	818	}
		819
		820	no warnings 'utf8';
614		821
615	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	822	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
616		823
617	sub verbose {	824	sub verbose {
618	my ($level, $msg) = @_;	825	my ($level, $msg) = @_;
619	warn "$msg\n" if $level <= $verbosity;	826	warn "$msg\n" if $level <= $verbosity;
620	}	827	}
621		828
622	my $extension_pkg = "extension0000";
623	my %extension_pkg;	829	my %extension_pkg;
624		830
625	# load a single script into its own package, once only	831	# load a single script into its own package, once only
626	sub extension_package($) {	832	sub extension_package($) {
627	my ($path) = @_;	833	my ($path) = @_;
628		834
629	$extension_pkg{$path} \|\|= do {	835	$extension_pkg{$path} \|\|= do {
630	my $pkg = "urxvt::" . ($extension_pkg++);	836	$path =~ /([^\/\\]+)$/;
		837	my $pkg = $1;
		838	$pkg =~ s/[^[:word:]]/_/g;
		839	$pkg = "urxvt::ext::$pkg";
631		840
632	verbose 3, "loading extension '$path' into package '$pkg'";	841	verbose 3, "loading extension '$path' into package '$pkg'";
633		842
634	open my $fh, "<:raw", $path	843	open my $fh, "<:raw", $path
635	or die "$path: $!";	844	or die "$path: $!";
636		845
637	my $source =	846	my $source =
638	"package $pkg; use strict; use utf8;\n"	847	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
639	. "use base urxvt::term::extension::;\n"
640	. "#line 1 \"$path\"\n{\n"	848	. "#line 1 \"$path\"\n{\n"
641	. (do { local $/; <$fh> })	849	. (do { local $/; <$fh> })
642	. "\n};\n1";	850	. "\n};\n1";
643		851
644	eval $source	852	eval $source
…		…
658	if ($htype == 0) { # INIT	866	if ($htype == 0) { # INIT
659	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	867	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
660		868
661	my %ext_arg;	869	my %ext_arg;
662		870
		871	{
		872	my @init = @TERM_INIT;
		873	@TERM_INIT = ();
		874	$_->($TERM) for @init;
		875	my @pkg = @TERM_EXT;
		876	@TERM_EXT = ();
		877	$TERM->register_package ($_) for @pkg;
		878	}
		879
663	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	880	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
664	if ($_ eq "default") {	881	if ($_ eq "default") {
665	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	882	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
666	} elsif (/^-(.*)$/) {	883	} elsif (/^-(.*)$/) {
667	delete $ext_arg{$1};	884	delete $ext_arg{$1};
668	} elsif (/^([^<]+)<(.*)>$/) {	885	} elsif (/^([^<]+)<(.*)>$/) {
669	push @{ $ext_arg{$1} }, $2;	886	push @{ $ext_arg{$1} }, $2;
670	} else {	887	} else {
671	$ext_arg{$_} \|\|= [];	888	$ext_arg{$_} \|\|= [];
672	}	889	}
673	}	890	}
674		891
675	while (my ($ext, $argv) = each %ext_arg) {	892	for my $ext (sort keys %ext_arg) {
676	my @files = grep -f $_, map "$_/$ext", @dirs;	893	my @files = grep -f $_, map "$_/$ext", @dirs;
677		894
678	if (@files) {	895	if (@files) {
679	$TERM->register_package (extension_package $files[0], $argv);	896	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
680	} else {	897	} else {
681	warn "perl extension '$ext' not found in perl library search path\n";	898	warn "perl extension '$ext' not found in perl library search path\n";
682	}	899	}
683	}	900	}
684		901
…		…
690		907
691	if (my $cb = $TERM->{_hook}[$htype]) {	908	if (my $cb = $TERM->{_hook}[$htype]) {
692	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	909	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
693	if $verbosity >= 10;	910	if $verbosity >= 10;
694		911
695	keys %$cb;	912	for my $pkg (keys %$cb) {
696
697	while (my ($pkg, $cb) = each %$cb) {
698	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	913	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
699	and last;	914	$retval \|\|= $retval_;
700		915
701	if ($@) {	916	if ($@) {
702	$TERM->ungrab; # better to lose the grab than the session	917	$TERM->ungrab; # better to lose the grab than the session
703	warn $@;	918	warn $@;
704	}	919	}
…		…
717	}	932	}
718		933
719	$retval	934	$retval
720	}	935	}
721		936
722	sub exec_async(@) {	937	sub SET_COLOR($$$) {
723	my $pid = fork;	938	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
724
725	return
726	if !defined $pid or $pid;
727
728	%ENV = %{ $TERM->env };
729
730	exec @_;
731	_exit 255;
732	}	939	}
733		940
734	# urxvt::term::extension	941	# urxvt::term::extension
735		942
736	package urxvt::term::extension;	943	package urxvt::term::extension;
…		…
875	# find on_xxx subs in the package and register them	1082	# find on_xxx subs in the package and register them
876	# as hooks	1083	# as hooks
877	sub register_package {	1084	sub register_package {
878	my ($self, $pkg, $argv) = @_;	1085	my ($self, $pkg, $argv) = @_;
879		1086
		1087	no strict 'refs';
		1088
		1089	urxvt::verbose 6, "register package $pkg to $self";
		1090
		1091	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1092
880	my $proxy = bless {	1093	my $proxy = bless {
881	_pkg => $pkg,	1094	_pkg => $pkg,
882	argv => $argv,	1095	argv => $argv,
883	}, $pkg;	1096	}, $pkg;
884	Scalar::Util::weaken ($proxy->{term} = $self);	1097	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
899	hash which defines the environment of the new terminal.	1112	hash which defines the environment of the new terminal.
900		1113
901	Croaks (and probably outputs an error message) if the new instance	1114	Croaks (and probably outputs an error message) if the new instance
902	couldn't be created. Returns C<undef> if the new instance didn't	1115	couldn't be created. Returns C<undef> if the new instance didn't
903	initialise perl, and the terminal object otherwise. The C<init> and	1116	initialise perl, and the terminal object otherwise. The C<init> and
904	C<start> hooks will be called during this call.	1117	C<start> hooks will be called before this call returns, and are free to
		1118	refer to global data (which is race free).
905		1119
906	=cut	1120	=cut
907		1121
908	sub new {	1122	sub new {
909	my ($class, $env, @args) = @_;	1123	my ($class, $env, @args) = @_;
910		1124
		1125	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1126	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1127
911	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1128	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
912	}	1129	}
913		1130
914	=item $term->destroy	1131	=item $term->destroy
915		1132
916	Destroy the terminal object (close the window, free resources	1133	Destroy the terminal object (close the window, free resources
917	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1134	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
918	watchers (timers, io watchers) are still active.	1135	watchers (timers, io watchers) are still active.
919		1136
		1137	=item $term->exec_async ($cmd[, @args])
		1138
		1139	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1140	("starts") programs in the background. This function takes care of setting
		1141	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1142	be preferred over explicit calls to C<exec> or C<system>.
		1143
		1144	Returns the pid of the subprocess or C<undef> on error.
		1145
		1146	=cut
		1147
		1148	sub exec_async {
		1149	my $self = shift;
		1150
		1151	my $pid = fork;
		1152
		1153	return $pid
		1154	if !defined $pid or $pid;
		1155
		1156	%ENV = %{ $self->env };
		1157
		1158	exec @_;
		1159	urxvt::_exit 255;
		1160	}
		1161
920	=item $isset = $term->option ($optval[, $set])	1162	=item $isset = $term->option ($optval[, $set])
921		1163
922	Returns true if the option specified by C<$optval> is enabled, and	1164	Returns true if the option specified by C<$optval> is enabled, and
923	optionally change it. All option values are stored by name in the hash	1165	optionally change it. All option values are stored by name in the hash
924	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1166	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
926	Here is a a likely non-exhaustive list of option names, please see the	1168	Here is a a likely non-exhaustive list of option names, please see the
927	source file F</src/optinc.h> to see the actual list:	1169	source file F</src/optinc.h> to see the actual list:
928		1170
929	borderLess console cursorBlink cursorUnderline hold iconic insecure	1171	borderLess console cursorBlink cursorUnderline hold iconic insecure
930	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1172	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
931	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1173	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
932	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1174	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
933	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1175	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
934	tripleclickwords utmpInhibit visualBell	1176	transparent tripleclickwords utmpInhibit visualBell
935		1177
936	=item $value = $term->resource ($name[, $newval])	1178	=item $value = $term->resource ($name[, $newval])
937		1179
938	Returns the current resource value associated with a given name and	1180	Returns the current resource value associated with a given name and
939	optionally sets a new value. Setting values is most useful in the C<init>	1181	optionally sets a new value. Setting values is most useful in the C<init>
…		…
956		1198
957	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1199	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
958	borderLess color cursorBlink cursorUnderline cutchars delete_key	1200	borderLess color cursorBlink cursorUnderline cutchars delete_key
959	display_name embed ext_bwidth fade font geometry hold iconName	1201	display_name embed ext_bwidth fade font geometry hold iconName
960	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1202	imFont imLocale inputMethod insecure int_bwidth intensityStyles
961	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1203	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
962	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1204	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
963	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1205	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
964	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1206	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
965	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1207	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
966	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1208	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
967	shade term_name title transparent transparent_all tripleclickwords	1209	secondaryScreen secondaryScroll selectstyle shade term_name title
968	utmpInhibit visualBell	1210	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1211	visualBell
969		1212
970	=cut	1213	=cut
971		1214
972	sub resource($$;$) {	1215	sub resource($$;$) {
973	my ($self, $name) = (shift, shift);	1216	my ($self, $name) = (shift, shift);
…		…
1147		1390
1148	Normally its not a good idea to use this function, as programs might be	1391	Normally its not a good idea to use this function, as programs might be
1149	confused by changes in cursor position or scrolling. Its useful inside a	1392	confused by changes in cursor position or scrolling. Its useful inside a
1150	C<on_add_lines> hook, though.	1393	C<on_add_lines> hook, though.
1151		1394
		1395	=item $term->scr_change_screen ($screen)
		1396
		1397	Switch to given screen - 0 primary, 1 secondary.
		1398
1152	=item $term->cmd_parse ($octets)	1399	=item $term->cmd_parse ($octets)
1153		1400
1154	Similar to C<scr_add_lines>, but the argument must be in the	1401	Similar to C<scr_add_lines>, but the argument must be in the
1155	locale-specific encoding of the terminal and can contain command sequences	1402	locale-specific encoding of the terminal and can contain command sequences
1156	(escape codes) that will be interpreted.	1403	(escape codes) that will be interpreted.
…		…
1166	Replaces the event mask of the pty watcher by the given event mask. Can	1413	Replaces the event mask of the pty watcher by the given event mask. Can
1167	be used to suppress input and output handling to the pty/tty. See the	1414	be used to suppress input and output handling to the pty/tty. See the
1168	description of C<< urxvt::timer->events >>. Make sure to always restore	1415	description of C<< urxvt::timer->events >>. Make sure to always restore
1169	the previous value.	1416	the previous value.
1170		1417
		1418	=item $fd = $term->pty_fd
		1419
		1420	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1421	is used.
		1422
1171	=item $windowid = $term->parent	1423	=item $windowid = $term->parent
1172		1424
1173	Return the window id of the toplevel window.	1425	Return the window id of the toplevel window.
1174		1426
1175	=item $windowid = $term->vt	1427	=item $windowid = $term->vt
…		…
1181	Adds the specified events to the vt event mask. Useful e.g. when you want	1433	Adds the specified events to the vt event mask. Useful e.g. when you want
1182	to receive pointer events all the times:	1434	to receive pointer events all the times:
1183		1435
1184	$term->vt_emask_add (urxvt::PointerMotionMask);	1436	$term->vt_emask_add (urxvt::PointerMotionMask);
1185		1437
		1438	=item $term->focus_in
		1439
		1440	=item $term->focus_out
		1441
		1442	=item $term->key_press ($state, $keycode[, $time])
		1443
		1444	=item $term->key_release ($state, $keycode[, $time])
		1445
		1446	Deliver various fake events to to terminal.
		1447
1186	=item $window_width = $term->width	1448	=item $window_width = $term->width
1187		1449
1188	=item $window_height = $term->height	1450	=item $window_height = $term->height
1189		1451
1190	=item $font_width = $term->fwidth	1452	=item $font_width = $term->fwidth
…		…
1220	=item $env = $term->env	1482	=item $env = $term->env
1221		1483
1222	Returns a copy of the environment in effect for the terminal as a hashref	1484	Returns a copy of the environment in effect for the terminal as a hashref
1223	similar to C<\%ENV>.	1485	similar to C<\%ENV>.
1224		1486
		1487	=item @envv = $term->envv
		1488
		1489	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1490
		1491	=item @argv = $term->argv
		1492
		1493	Return the argument vector as this terminal, similar to @ARGV, but
		1494	includes the program name as first element.
		1495
1225	=cut	1496	=cut
1226		1497
1227	sub env {	1498	sub env {
1228	if (my $env = $_[0]->_env) {
1229	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1499	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1230	} else {
1231	+{ %ENV }
1232	}
1233	}	1500	}
1234		1501
1235	=item $modifiermask = $term->ModLevel3Mask	1502	=item $modifiermask = $term->ModLevel3Mask
1236		1503
1237	=item $modifiermask = $term->ModMetaMask	1504	=item $modifiermask = $term->ModMetaMask
1238		1505
1239	=item $modifiermask = $term->ModNumLockMask	1506	=item $modifiermask = $term->ModNumLockMask
1240		1507
1241	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1508	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1242	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1509	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1510
		1511	=item $screen = $term->current_screen
		1512
		1513	Returns the currently displayed screen (0 primary, 1 secondary).
		1514
		1515	=item $cursor_is_hidden = $term->hidden_cursor
		1516
		1517	Returns wether the cursor is currently hidden or not.
1243		1518
1244	=item $view_start = $term->view_start ([$newvalue])	1519	=item $view_start = $term->view_start ([$newvalue])
1245		1520
1246	Returns the row number of the topmost displayed line. Maximum value is	1521	Returns the row number of the topmost displayed line. Maximum value is
1247	C<0>, which displays the normal terminal contents. Lower values scroll	1522	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1267	line, starting at column C<$start_col> (default C<0>), which is useful	1542	line, starting at column C<$start_col> (default C<0>), which is useful
1268	to replace only parts of a line. The font index in the rendition will	1543	to replace only parts of a line. The font index in the rendition will
1269	automatically be updated.	1544	automatically be updated.
1270		1545
1271	C<$text> is in a special encoding: tabs and wide characters that use more	1546	C<$text> is in a special encoding: tabs and wide characters that use more
1272	than one cell when displayed are padded with urxvt::NOCHAR characters	1547	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1273	(C<chr 65535>). Characters with combining characters and other characters	1548	characters. Characters with combining characters and other characters that
1274	that do not fit into the normal tetx encoding will be replaced with	1549	do not fit into the normal tetx encoding will be replaced with characters
1275	characters in the private use area.	1550	in the private use area.
1276		1551
1277	You have to obey this encoding when changing text. The advantage is	1552	You have to obey this encoding when changing text. The advantage is
1278	that C<substr> and similar functions work on screen cells and not on	1553	that C<substr> and similar functions work on screen cells and not on
1279	characters.	1554	characters.
1280		1555
…		…
1427	=item $string = $term->special_decode $text	1702	=item $string = $term->special_decode $text
1428		1703
1429	Converts rxvt-unicodes text reprsentation into a perl string. See	1704	Converts rxvt-unicodes text reprsentation into a perl string. See
1430	C<< $term->ROW_t >> for details.	1705	C<< $term->ROW_t >> for details.
1431		1706
1432	=item $success = $term->grab_button ($button, $modifiermask)	1707	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1433		1708
		1709	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1710
1434	Registers a synchronous button grab. See the XGrabButton manpage.	1711	Register/unregister a synchronous button grab. See the XGrabButton
		1712	manpage.
1435		1713
1436	=item $success = $term->grab ($eventtime[, $sync])	1714	=item $success = $term->grab ($eventtime[, $sync])
1437		1715
1438	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1716	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1439	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1717	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1454	=item $term->ungrab	1732	=item $term->ungrab
1455		1733
1456	Calls XUngrab for the most recent grab. Is called automatically on	1734	Calls XUngrab for the most recent grab. Is called automatically on
1457	evaluation errors, as it is better to lose the grab in the error case as	1735	evaluation errors, as it is better to lose the grab in the error case as
1458	the session.	1736	the session.
		1737
		1738	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1739
		1740	=item $atom_name = $term->XGetAtomName ($atom)
		1741
		1742	=item @atoms = $term->XListProperties ($window)
		1743
		1744	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1745
		1746	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1747
		1748	=item $term->XDeleteProperty ($window, $property)
		1749
		1750	=item $window = $term->DefaultRootWindow
		1751
		1752	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1753
		1754	=item $term->XMapWindow ($window)
		1755
		1756	=item $term->XUnmapWindow ($window)
		1757
		1758	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1759
		1760	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1761
		1762	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1763
		1764	Various X or X-related functions. The C<$term> object only serves as
		1765	the source of the display, otherwise those functions map more-or-less
		1766	directory onto the X functions of the same name.
1459		1767
1460	=back	1768	=back
1461		1769
1462	=cut	1770	=cut
1463		1771
…		…
1527	my ($self, $text, $cb) = @_;	1835	my ($self, $text, $cb) = @_;
1528		1836
1529	$self->add_item ({ type => "button", text => $text, activate => $cb});	1837	$self->add_item ({ type => "button", text => $text, activate => $cb});
1530	}	1838	}
1531		1839
1532	=item $popup->add_toggle ($text, $cb, $initial_value)	1840	=item $popup->add_toggle ($text, $initial_value, $cb)
1533		1841
1534	Adds a toggle/checkbox item to the popup. Teh callback gets called	1842	Adds a toggle/checkbox item to the popup. The callback gets called
1535	whenever it gets toggled, with a boolean indicating its value as its first	1843	whenever it gets toggled, with a boolean indicating its new value as its
1536	argument.	1844	first argument.
1537		1845
1538	=cut	1846	=cut
1539		1847
1540	sub add_toggle {	1848	sub add_toggle {
1541	my ($self, $text, $cb, $value) = @_;	1849	my ($self, $text, $value, $cb) = @_;
1542		1850
1543	my $item; $item = {	1851	my $item; $item = {
1544	type => "button",	1852	type => "button",
1545	text => " $text",	1853	text => " $text",
1546	value => $value,	1854	value => $value,
…		…
1565	my $env = $self->{term}->env;	1873	my $env = $self->{term}->env;
1566	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1874	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1567	delete $env->{LC_ALL};	1875	delete $env->{LC_ALL};
1568	$env->{LC_CTYPE} = $self->{term}->locale;	1876	$env->{LC_CTYPE} = $self->{term}->locale;
1569		1877
1570	urxvt::term->new ($env, $self->{term}->resource ("name"),	1878	urxvt::term->new ($env, "popup",
1571	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1879	"--perl-lib" => "", "--perl-ext-common" => "",
		1880	"-pty-fd" => -1, "-sl" => 0,
		1881	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1572	"--transient-for" => $self->{term}->parent,	1882	"--transient-for" => $self->{term}->parent,
1573	"-display" => $self->{term}->display_id,	1883	"-display" => $self->{term}->display_id,
1574	"-pe" => "urxvt-popup")	1884	"-pe" => "urxvt-popup")
1575	or die "unable to create popup window\n";	1885	or die "unable to create popup window\n";
1576	}	1886	}
…		…
1581	delete $self->{term}{_destroy}{$self};	1891	delete $self->{term}{_destroy}{$self};
1582	$self->{term}->ungrab;	1892	$self->{term}->ungrab;
1583	}	1893	}
1584		1894
1585	=back	1895	=back
		1896
		1897	=cut
		1898
		1899	package urxvt::watcher;
		1900
		1901	@urxvt::timer::ISA = __PACKAGE__;
		1902	@urxvt::iow::ISA = __PACKAGE__;
		1903	@urxvt::pw::ISA = __PACKAGE__;
		1904	@urxvt::iw::ISA = __PACKAGE__;
1586		1905
1587	=head2 The C<urxvt::timer> Class	1906	=head2 The C<urxvt::timer> Class
1588		1907
1589	This class implements timer watchers/events. Time is represented as a	1908	This class implements timer watchers/events. Time is represented as a
1590	fractional number of seconds since the epoch. Example:	1909	fractional number of seconds since the epoch. Example:
…		…
1628	Start the timer.	1947	Start the timer.
1629		1948
1630	=item $timer = $timer->start ($tstamp)	1949	=item $timer = $timer->start ($tstamp)
1631		1950
1632	Set the event trigger time to C<$tstamp> and start the timer.	1951	Set the event trigger time to C<$tstamp> and start the timer.
		1952
		1953	=item $timer = $timer->after ($delay)
		1954
		1955	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1633		1956
1634	=item $timer = $timer->stop	1957	=item $timer = $timer->stop
1635		1958
1636	Stop the timer.	1959	Stop the timer.
1637		1960
…		…
1684		2007
1685	Stop watching for events on the given filehandle.	2008	Stop watching for events on the given filehandle.
1686		2009
1687	=back	2010	=back
1688		2011
		2012	=head2 The C<urxvt::iw> Class
		2013
		2014	This class implements idle watchers, that get called automatically when
		2015	the process is idle. They should return as fast as possible, after doing
		2016	some useful work.
		2017
		2018	=over 4
		2019
		2020	=item $iw = new urxvt::iw
		2021
		2022	Create a new idle watcher object in stopped state.
		2023
		2024	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2025
		2026	Set the callback to be called when the watcher triggers.
		2027
		2028	=item $timer = $timer->start
		2029
		2030	Start the watcher.
		2031
		2032	=item $timer = $timer->stop
		2033
		2034	Stop the watcher.
		2035
		2036	=back
		2037
		2038	=head2 The C<urxvt::pw> Class
		2039
		2040	This class implements process watchers. They create an event whenever a
		2041	process exits, after which they stop automatically.
		2042
		2043	my $pid = fork;
		2044	...
		2045	$term->{pw} = urxvt::pw
		2046	->new
		2047	->start ($pid)
		2048	->cb (sub {
		2049	my ($pw, $exit_status) = @_;
		2050	...
		2051	});
		2052
		2053	=over 4
		2054
		2055	=item $pw = new urxvt::pw
		2056
		2057	Create a new process watcher in stopped state.
		2058
		2059	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2060
		2061	Set the callback to be called when the timer triggers.
		2062
		2063	=item $pw = $timer->start ($pid)
		2064
		2065	Tells the wqtcher to start watching for process C<$pid>.
		2066
		2067	=item $pw = $pw->stop
		2068
		2069	Stop the watcher.
		2070
		2071	=back
		2072
1689	=head1 ENVIRONMENT	2073	=head1 ENVIRONMENT
1690		2074
1691	=head2 URXVT_PERL_VERBOSITY	2075	=head2 URXVT_PERL_VERBOSITY
1692		2076
1693	This variable controls the verbosity level of the perl extension. Higher	2077	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.98 by root, Tue Jan 17 17:01:54 2006 UTC vs. Revision 1.139 by root, Sat Jul 1 19:04:43 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC vs.
Revision 1.139 by root, Sat Jul 1 19:04:43 2006 UTC