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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs.
Revision 1.116 by root, Fri Jan 20 16:18:07 2006 UTC

…		…
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
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		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	Intelligent selection. This extension tries to be more intelligent when	48	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	49	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	50	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
49	It also offers the following bindable event:	54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the followign adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		71
		72	You can look at the source of the selection extension to see more
		73	interesting uses, such as parsing a line from beginning to end.
		74
		75	This extension also offers following bindable keyboard commands:
50		76
51	=over 4	77	=over 4
52		78
53	=item rot13	79	=item rot13
54		80
…		…
64	runtime.	90	runtime.
65		91
66	=item selection-popup (enabled by default)	92	=item selection-popup (enabled by default)
67		93
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	95	text into various other formats/action (such as uri unescaping, perl
		96	evalution, web-browser starting etc.), depending on content.
70		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
		116
71	=item searchable-scrollback (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
72		118
73	Adds regex search functionality to the scrollback buffer, triggered by a	119	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	suspended, C</> starts an incremental regex search, C<n> searches further,	121	input/output is suspended and a regex is displayed at the bottom of the
76	C<p> jumps to the previous match. C<enter> leaves search mode at the	122	screen.
77	current position and C<escape> returns to the original position.
78		123
79	=item digital-clock	124	Inputting characters appends them to the regex and continues incremental
		125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		127	bottom. C<Escape> leaves search mode and returns to the point where search
		128	was started, while C<Enter> or C<Return> stay at the current position and
		129	additionally stores the first match in the current line into the primary
		130	selection.
80		131
81	Displays a digital clock using the built-in overlay.	132	=item selection-autotransform
		133
		134	This selection allows you to do automatic transforms on a selection
		135	whenever a selection is made.
		136
		137	It works by specifying perl snippets (most useful is a single C<s///>
		138	operator) that modify C<$_> as resources:
		139
		140	URxvt.selection-autotransform.0: transform
		141	URxvt.selection-autotransform.1: transform
		142	...
		143
		144	For example, the following will transform selections of the form
		145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		146	$word>:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		149
		150	And this example matches the same,but replaces it with vi-commands you can
		151	paste directly into your (vi :) editor:
		152
		153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		154
		155	Of course, this can be modified to suit your needs and your editor :)
		156
		157	To expand the example above to typical perl error messages ("XXX at
		158	FILENAME line YYY."), you need a slightly more elaborate solution:
		159
		160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		162
		163	The first line tells the selection code to treat the unchanging part of
		164	every error message as a selection pattern, and the second line transforms
		165	the message into vi commands to load the file.
		166
		167	=item tabbed
		168
		169	This transforms the terminal into a tabbar with additional terminals, that
		170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		172	button per tab.
		173
		174	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		175	B<Shift-Right> will switch to the tab left or right of the current one,
		176	while B<Shift-Down> creates a new tab.
82		177
83	=item mark-urls	178	=item mark-urls
84		179
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	180	Uses per-line display filtering (C<on_line_update>) to underline urls and
		181	make them clickable. When middle-clicked, the program specified in the
		182	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		183	the URL as first argument.
		184
		185	=item automove-background
		186
		187	This is basically a one-line extension that dynamically changes the background pixmap offset
		188	to the window position, in effect creating the same effect as pseudo transparency with
		189	a custom pixmap. No scaling is supported in this mode. Exmaple:
		190
		191	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
86		192
87	=item block-graphics-to-ascii	193	=item block-graphics-to-ascii
88		194
89	A not very useful example of filtering all text output to the terminal,	195	A not very useful example of filtering all text output to the terminal,
90	by replacing all line-drawing characters (U+2500 .. U+259F) by a	196	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.	197	similar-looking ascii character.
92		198
		199	=item digital-clock
		200
		201	Displays a digital clock using the built-in overlay.
		202
93	=item example-refresh-hooks	203	=item example-refresh-hooks
94		204
95	Displays a very simple digital clock in the upper right corner of the	205	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	206	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	207	overlays or changes.
98		208
		209	=item selection-pastebin
		210
		211	This is a little rarely useful extension that Uploads the selection as
		212	textfile to a remote site (or does other things). (The implementation is
		213	not currently secure for use in a multiuser environment as it writes to
		214	F</tmp> directly.).
		215
		216	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		217	i.e.
		218
		219	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		220
		221	Pressing this combination runs a command with C<%> replaced by the name of
		222	the textfile. This command can be set via a resource:
		223
		224	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		225
		226	And the default is likely not useful to anybody but the few people around
		227	here :)
		228
		229	The name of the textfile is the hex encoded md5 sum of the selection, so
		230	the same content should lead to the same filename.
		231
		232	After a successful upload the selection will be replaced by the text given
		233	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		234	for the filename):
		235
		236	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		237
99	=back	238	=back
		239
		240	=head1 API DOCUMENTATION
100		241
101	=head2 General API Considerations	242	=head2 General API Considerations
102		243
103	All objects (such as terminals, time watchers etc.) are typical	244	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	245	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	258	=over 4
118		259
119	=item $text	260	=item $text
120		261
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	262	Rxvt-unicodes special way of encoding text, where one "unicode" character
122	always represents one screen cell. See L<row_t> for a discussion of this format.	263	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		264
124	=item $string	265	=item $string
125		266
126	A perl text string, with an emphasis on I<text>. It can store all unicode	267	A perl text string, with an emphasis on I<text>. It can store all unicode
127	characters and is to be distinguished with text encoded in a specific	268	characters and is to be distinguished with text encoded in a specific
…		…
173	called whenever the relevant event happens.	314	called whenever the relevant event happens.
174		315
175	The first argument passed to them is an extension oject as described in	316	The first argument passed to them is an extension oject as described in
176	the in the C<Extension Objects> section.	317	the in the C<Extension Objects> section.
177		318
178	B<All> of these hooks must return a boolean value. If it is true, then the	319	B<All> of these hooks must return a boolean value. If any of the called
179	event counts as being I<consumed>, and the invocation of other hooks is	320	hooks returns true, then the event counts as being I<consumed>, and the
180	skipped, and the relevant action might not be carried out by the C++ code.	321	relevant action might not be carried out by the C++ code.
181		322
182	I<< When in doubt, return a false value (preferably C<()>). >>	323	I<< When in doubt, return a false value (preferably C<()>). >>
183		324
184	=over 4	325	=over 4
185		326
186	=item on_init $term	327	=item on_init $term
187		328
188	Called after a new terminal object has been initialized, but before	329	Called after a new terminal object has been initialized, but before
189	windows are created or the command gets run. Most methods are unsafe to	330	windows are created or the command gets run. Most methods are unsafe to
190	call or deliver senseless data, as terminal size and other characteristics	331	call or deliver senseless data, as terminal size and other characteristics
191	have not yet been determined. You can safely query and change resources,	332	have not yet been determined. You can safely query and change resources
192	though.	333	and options, though. For many purposes the C<on_start> hook is a better
		334	place.
		335
		336	=item on_start $term
		337
		338	Called at the very end of initialisation of a new terminal, just before
		339	trying to map (display) the toplevel and returning to the mainloop.
		340
		341	=item on_destroy $term
		342
		343	Called whenever something tries to destroy terminal, before doing anything
		344	yet. If this hook returns true, then destruction is skipped, but this is
		345	rarely a good idea.
193		346
194	=item on_reset $term	347	=item on_reset $term
195		348
196	Called after the screen is "reset" for any reason, such as resizing or	349	Called after the screen is "reset" for any reason, such as resizing or
197	control sequences. Here is where you can react on changes to size-related	350	control sequences. Here is where you can react on changes to size-related
198	variables.	351	variables.
199		352
200	=item on_start $term	353	=item on_child_start $term, $pid
201		354
202	Called at the very end of initialisation of a new terminal, just before	355	Called just after the child process has been C<fork>ed.
203	returning to the mainloop.	356
		357	=item on_child_exit $term, $status
		358
		359	Called just after the child process has exited. C<$status> is the status
		360	from C<waitpid>.
204		361
205	=item on_sel_make $term, $eventtime	362	=item on_sel_make $term, $eventtime
206		363
207	Called whenever a selection has been made by the user, but before the	364	Called whenever a selection has been made by the user, but before the
208	selection text is copied, so changes to the beginning, end or type of the	365	selection text is copied, so changes to the beginning, end or type of the
…		…
222	=item on_sel_extend $term	379	=item on_sel_extend $term
223		380
224	Called whenever the user tries to extend the selection (e.g. with a double	381	Called whenever the user tries to extend the selection (e.g. with a double
225	click) and is either supposed to return false (normal operation), or	382	click) and is either supposed to return false (normal operation), or
226	should extend the selection itelf and return true to suppress the built-in	383	should extend the selection itelf and return true to suppress the built-in
227	processing.	384	processing. This can happen multiple times, as long as the callback
		385	returns true, it will be called on every further click by the user and is
		386	supposed to enlarge the selection more and more, if possible.
228		387
229	See the F<selection> example extension.	388	See the F<selection> example extension.
230		389
231	=item on_view_change $term, $offset	390	=item on_view_change $term, $offset
232		391
…		…
299		458
300	Called whenever the user presses a key combination that has a	459	Called whenever the user presses a key combination that has a
301	C<perl:string> action bound to it (see description of the B<keysym>	460	C<perl:string> action bound to it (see description of the B<keysym>
302	resource in the @@RXVT_NAME@@(1) manpage).	461	resource in the @@RXVT_NAME@@(1) manpage).
303		462
		463	=item on_x_event $term, $event
		464
		465	Called on every X event received on the vt window (and possibly other
		466	windows). Should only be used as a last resort. Most event structure
		467	members are not passed.
		468
304	=item on_focus_in $term	469	=item on_focus_in $term
305		470
306	Called whenever the window gets the keyboard focus, before rxvt-unicode	471	Called whenever the window gets the keyboard focus, before rxvt-unicode
307	does focus in processing.	472	does focus in processing.
308		473
309	=item on_focus_out $term	474	=item on_focus_out $term
310		475
311	Called wheneever the window loses keyboard focus, before rxvt-unicode does	476	Called wheneever the window loses keyboard focus, before rxvt-unicode does
312	focus out processing.	477	focus out processing.
		478
		479	=item on_configure_notify $term, $event
313		480
314	=item on_key_press $term, $event, $keysym, $octets	481	=item on_key_press $term, $event, $keysym, $octets
315		482
316	=item on_key_release $term, $event, $keysym	483	=item on_key_release $term, $event, $keysym
317		484
…		…
335	C<on_key_press> additionally receives the string rxvt-unicode would	502	C<on_key_press> additionally receives the string rxvt-unicode would
336	output, if any, in locale-specific encoding.	503	output, if any, in locale-specific encoding.
337		504
338	subwindow.	505	subwindow.
339		506
340	=back	507	=item on_client_message $term, $event
341		508
342	=head2 Variables in the C<urxvt> Package	509	=item on_wm_protocols $term, $event
343		510
344	=over 4	511	=item on_wm_delete_window $term, $event
345		512
346	=item $urxvt::TERM	513	Called when various types of ClientMessage events are received (all with
347		514	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
348	The current terminal. This variable stores the current C<urxvt::term>
349	object, whenever a callback/hook is executing.
350
351	=back
352
353	=head2 Functions in the C<urxvt> Package
354
355	=over 4
356
357	=item $term = new urxvt [arg...]
358
359	Creates a new terminal, very similar as if you had started it with
360	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
361	if the new instance couldn't be created. Returns C<undef> if the new
362	instance didn't initialise perl, and the terminal object otherwise. The
363	C<init> and C<start> hooks will be called during the call.
364
365	=item urxvt::fatal $errormessage
366
367	Fatally aborts execution with the given error message. Avoid at all
368	costs! The only time this is acceptable is when the terminal process
369	starts up.
370
371	=item urxvt::warn $string
372
373	Calls C<rxvt_warn> with the given string which should not include a
374	newline. The module also overwrites the C<warn> builtin with a function
375	that calls this function.
376
377	Using this function has the advantage that its output ends up in the
378	correct place, e.g. on stderr of the connecting urxvtc client.
379
380	=item $is_safe = urxvt::safe
381
382	Returns true when it is safe to do potentially unsafe things, such as
383	evaluating perl code specified by the user. This is true when urxvt was
384	started setuid or setgid.
385
386	=item $time = urxvt::NOW
387
388	Returns the "current time" (as per the event loop).
389
390	=item urxvt::CurrentTime
391
392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394	Button4Mask, Button5Mask, AnyModifier
395
396	Various constants for use in X calls and event processing.
397
398	=back
399
400	=head2 RENDITION
401
402	Rendition bitsets contain information about colour, font, font styles and
403	similar information for each screen cell.
404
405	The following "macros" deal with changes in rendition sets. You should
406	never just create a bitset, you should always modify an existing one,
407	as they contain important information required for correct operation of
408	rxvt-unicode.
409
410	=over 4
411
412	=item $rend = urxvt::DEFAULT_RSTYLE
413
414	Returns the default rendition, as used when the terminal is starting up or
415	being reset. Useful as a base to start when creating renditions.
416
417	=item $rend = urxvt::OVERLAY_RSTYLE
418
419	Return the rendition mask used for overlays by default.
420
421	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
422
423	Return the bit that enabled bold, italic, blink, reverse-video and
424	underline, respectively. To enable such a style, just logically OR it into
425	the bitset.
426
427	=item $foreground = urxvt::GET_BASEFG $rend
428
429	=item $background = urxvt::GET_BASEBG $rend
430
431	Return the foreground/background colour index, respectively.
432
433	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
434
435	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
436
437	Replace the foreground/background colour in the rendition mask with the
438	specified one.
439
440	=item $value = urxvt::GET_CUSTOM ($rend)
441
442	Return the "custom" value: Every rendition has 5 bits for use by
443	extensions. They can be set and changed as you like and are initially
444	zero.
445
446	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
447
448	Change the custom value.
449		515
450	=back	516	=back
451		517
452	=cut	518	=cut
453		519
…		…
459	use Scalar::Util ();	525	use Scalar::Util ();
460	use List::Util ();	526	use List::Util ();
461		527
462	our $VERSION = 1;	528	our $VERSION = 1;
463	our $TERM;	529	our $TERM;
		530	our @TERM_INIT;
		531	our @TERM_EXT;
464	our @HOOKNAME;	532	our @HOOKNAME;
465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	533	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466	our %OPTION;	534	our %OPTION;
467		535
468	our $LIBDIR;	536	our $LIBDIR;
469	our $RESNAME;	537	our $RESNAME;
470	our $RESCLASS;	538	our $RESCLASS;
471	our $RXVTNAME;	539	our $RXVTNAME;
472		540
		541	=head2 Variables in the C<urxvt> Package
		542
		543	=over 4
		544
		545	=item $urxvt::LIBDIR
		546
		547	The rxvt-unicode library directory, where, among other things, the perl
		548	modules and scripts are stored.
		549
		550	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		551
		552	The resource class and name rxvt-unicode uses to look up X resources.
		553
		554	=item $urxvt::RXVTNAME
		555
		556	The basename of the installed binaries, usually C<urxvt>.
		557
		558	=item $urxvt::TERM
		559
		560	The current terminal. This variable stores the current C<urxvt::term>
		561	object, whenever a callback/hook is executing.
		562
		563	=item @urxvt::TERM_INIT
		564
		565	All coderefs in this array will be called as methods of the next newly
		566	created C<urxvt::term> object (during the C<on_init> phase). The array
		567	gets cleared before the codereferences that were in it are being executed,
		568	so coderefs can push themselves onto it again if they so desire.
		569
		570	This complements to the perl-eval commandline option, but gets executed
		571	first.
		572
		573	=item @urxvt::TERM_EXT
		574
		575	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		576	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		577	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		578
		579	=back
		580
		581	=head2 Functions in the C<urxvt> Package
		582
		583	=over 4
		584
		585	=item urxvt::fatal $errormessage
		586
		587	Fatally aborts execution with the given error message. Avoid at all
		588	costs! The only time this is acceptable is when the terminal process
		589	starts up.
		590
		591	=item urxvt::warn $string
		592
		593	Calls C<rxvt_warn> with the given string which should not include a
		594	newline. The module also overwrites the C<warn> builtin with a function
		595	that calls this function.
		596
		597	Using this function has the advantage that its output ends up in the
		598	correct place, e.g. on stderr of the connecting urxvtc client.
		599
		600	Messages have a size limit of 1023 bytes currently.
		601
		602	=item $time = urxvt::NOW
		603
		604	Returns the "current time" (as per the event loop).
		605
		606	=item urxvt::CurrentTime
		607
		608	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		609	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		610	Button4Mask, Button5Mask, AnyModifier
		611
		612	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		613	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		614	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		615	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		616	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		617	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		618	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		619
		620	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		621	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		622	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		623	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		624	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		625	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		626	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		627
		628	Various constants for use in X calls and event processing.
		629
		630	=back
		631
		632	=head2 RENDITION
		633
		634	Rendition bitsets contain information about colour, font, font styles and
		635	similar information for each screen cell.
		636
		637	The following "macros" deal with changes in rendition sets. You should
		638	never just create a bitset, you should always modify an existing one,
		639	as they contain important information required for correct operation of
		640	rxvt-unicode.
		641
		642	=over 4
		643
		644	=item $rend = urxvt::DEFAULT_RSTYLE
		645
		646	Returns the default rendition, as used when the terminal is starting up or
		647	being reset. Useful as a base to start when creating renditions.
		648
		649	=item $rend = urxvt::OVERLAY_RSTYLE
		650
		651	Return the rendition mask used for overlays by default.
		652
		653	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		654
		655	Return the bit that enabled bold, italic, blink, reverse-video and
		656	underline, respectively. To enable such a style, just logically OR it into
		657	the bitset.
		658
		659	=item $foreground = urxvt::GET_BASEFG $rend
		660
		661	=item $background = urxvt::GET_BASEBG $rend
		662
		663	Return the foreground/background colour index, respectively.
		664
		665	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		666
		667	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		668
		669	Replace the foreground/background colour in the rendition mask with the
		670	specified one.
		671
		672	=item $value = urxvt::GET_CUSTOM $rend
		673
		674	Return the "custom" value: Every rendition has 5 bits for use by
		675	extensions. They can be set and changed as you like and are initially
		676	zero.
		677
		678	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		679
		680	Change the custom value.
		681
		682	=back
		683
		684	=cut
		685
473	BEGIN {	686	BEGIN {
474	urxvt->bootstrap;
475
476	# overwrite perl's warn	687	# overwrite perl's warn
477	*CORE::GLOBAL::warn = sub {	688	*CORE::GLOBAL::warn = sub {
478	my $msg = join "", @_;	689	my $msg = join "", @_;
479	$msg .= "\n"	690	$msg .= "\n"
480	unless $msg =~ /\n$/;	691	unless $msg =~ /\n$/;
481	urxvt::warn ($msg);	692	urxvt::warn ($msg);
482	};	693	};
483
484	delete $ENV{IFS};
485	delete $ENV{CDPATH};
486	delete $ENV{BASH_ENV};
487	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
488	}	694	}
489		695
490	my @hook_count;
491	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	696	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
492		697
493	sub verbose {	698	sub verbose {
494	my ($level, $msg) = @_;	699	my ($level, $msg) = @_;
495	warn "$msg\n" if $level <= $verbosity;	700	warn "$msg\n" if $level <= $verbosity;
496	}	701	}
497		702
498	my $extension_pkg = "extension0000";
499	my %extension_pkg;	703	my %extension_pkg;
500		704
501	# load a single script into its own package, once only	705	# load a single script into its own package, once only
502	sub extension_package($) {	706	sub extension_package($) {
503	my ($path) = @_;	707	my ($path) = @_;
504		708
505	$extension_pkg{$path} \|\|= do {	709	$extension_pkg{$path} \|\|= do {
506	my $pkg = "urxvt::" . ($extension_pkg++);	710	$path =~ /([^\/\\]+)$/;
		711	my $pkg = $1;
		712	$pkg =~ s/[^[:word:]]/_/g;
		713	$pkg = "urxvt::ext::$pkg";
507		714
508	verbose 3, "loading extension '$path' into package '$pkg'";	715	verbose 3, "loading extension '$path' into package '$pkg'";
509		716
510	open my $fh, "<:raw", $path	717	open my $fh, "<:raw", $path
511	or die "$path: $!";	718	or die "$path: $!";
512		719
513	my $source = untaint	720	my $source =
514	"package $pkg; use strict; use utf8;\n"	721	"package $pkg; use strict; use utf8;\n"
515	. "use base urxvt::term::extension::;\n"
516	. "#line 1 \"$path\"\n{\n"	722	. "#line 1 \"$path\"\n{\n"
517	. (do { local $/; <$fh> })	723	. (do { local $/; <$fh> })
518	. "\n};\n1";	724	. "\n};\n1";
519		725
520	eval $source	726	eval $source
…		…
534	if ($htype == 0) { # INIT	740	if ($htype == 0) { # INIT
535	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	741	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
536		742
537	my %ext_arg;	743	my %ext_arg;
538		744
		745	{
		746	my @init = @TERM_INIT;
		747	@TERM_INIT = ();
		748	$_->($TERM) for @init;
		749	my @pkg = @TERM_EXT;
		750	@TERM_EXT = ();
		751	$TERM->register_package ($_) for @pkg;
		752	}
		753
539	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	754	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
540	if ($_ eq "default") {	755	if ($_ eq "default") {
541	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	756	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
542	} elsif (/^-(.*)$/) {	757	} elsif (/^-(.*)$/) {
543	delete $ext_arg{$1};	758	delete $ext_arg{$1};
544	} elsif (/^([^<]+)<(.*)>$/) {	759	} elsif (/^([^<]+)<(.*)>$/) {
…		…
569	if $verbosity >= 10;	784	if $verbosity >= 10;
570		785
571	keys %$cb;	786	keys %$cb;
572		787
573	while (my ($pkg, $cb) = each %$cb) {	788	while (my ($pkg, $cb) = each %$cb) {
574	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	789	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
575	and last;	790	$retval \|\|= $retval_;
576		791
577	if ($@) {	792	if ($@) {
578	$TERM->ungrab; # better to lose the grab than the session	793	$TERM->ungrab; # better to lose the grab than the session
579	warn $@;	794	warn $@;
580	}	795	}
581	}	796	}
		797
		798	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		799	if $verbosity >= 11;
582	}	800	}
583		801
584	if ($htype == 1) { # DESTROY	802	if ($htype == 1) { # DESTROY
585	if (my $hook = delete $TERM->{_hook}) {
586	for my $htype (0..$#$hook) {
587	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
588	or set_should_invoke $htype, 0;
589	}
590	}
591
592	# clear package objects	803	# clear package objects
593	%$_ = () for values %{ $TERM->{_pkg} };	804	%$_ = () for values %{ $TERM->{_pkg} };
594		805
595	# clear package	806	# clear package
596	%$TERM = ();	807	%$TERM = ();
…		…
610	while (my ($name, $cb) = each %hook) {	821	while (my ($name, $cb) = each %hook) {
611	my $htype = $HOOKTYPE{uc $name};	822	my $htype = $HOOKTYPE{uc $name};
612	defined $htype	823	defined $htype
613	or Carp::croak "unsupported hook type '$name'";	824	or Carp::croak "unsupported hook type '$name'";
614		825
		826	$self->set_should_invoke ($htype, +1)
615	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	827	unless exists $self->{term}{_hook}[$htype]{$pkg};
616	$hook_count[$htype]++
617	or urxvt::set_should_invoke $htype, 1;
618	}
619		828
620	$self->{term}{_hook}[$htype]{$pkg} = $cb;	829	$self->{term}{_hook}[$htype]{$pkg} = $cb;
621	}	830	}
622	}	831	}
623		832
…		…
628	for my $name (@hook) {	837	for my $name (@hook) {
629	my $htype = $HOOKTYPE{uc $name};	838	my $htype = $HOOKTYPE{uc $name};
630	defined $htype	839	defined $htype
631	or Carp::croak "unsupported hook type '$name'";	840	or Carp::croak "unsupported hook type '$name'";
632		841
		842	$self->set_should_invoke ($htype, -1)
633	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	843	if delete $self->{term}{_hook}[$htype]{$pkg};
634	--$hook_count[$htype]
635	or urxvt::set_should_invoke $htype, 0;
636	}
637	}	844	}
638	}	845	}
639		846
640	our $AUTOLOAD;	847	our $AUTOLOAD;
641		848
…		…
672		879
673	=head2 The C<urxvt::anyevent> Class	880	=head2 The C<urxvt::anyevent> Class
674		881
675	The sole purpose of this class is to deliver an interface to the	882	The sole purpose of this class is to deliver an interface to the
676	C<AnyEvent> module - any module using it will work inside urxvt without	883	C<AnyEvent> module - any module using it will work inside urxvt without
677	further work. The only exception is that you cannot wait on condition	884	further programming. The only exception is that you cannot wait on
678	variables, but non-blocking condvar use is ok. What this means is that you	885	condition variables, but non-blocking condvar use is ok. What this means
679	cannot use blocking APIs, but the non-blocking variant should work.	886	is that you cannot use blocking APIs, but the non-blocking variant should
		887	work.
680		888
681	=cut	889	=cut
682		890
683	our $VERSION = 1;	891	our $VERSION = 1;
684		892
…		…
746	# find on_xxx subs in the package and register them	954	# find on_xxx subs in the package and register them
747	# as hooks	955	# as hooks
748	sub register_package {	956	sub register_package {
749	my ($self, $pkg, $argv) = @_;	957	my ($self, $pkg, $argv) = @_;
750		958
		959	no strict 'refs';
		960
		961	urxvt::verbose 6, "register package $pkg to $self";
		962
		963	@{"$pkg\::ISA"} = urxvt::term::extension::;
		964
751	my $proxy = bless {	965	my $proxy = bless {
752	_pkg => $pkg,	966	_pkg => $pkg,
753	argv => $argv,	967	argv => $argv,
754	}, $pkg;	968	}, $pkg;
755	Scalar::Util::weaken ($proxy->{term} = $self);	969	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
761	$proxy->enable ($name => $ref);	975	$proxy->enable ($name => $ref);
762	}	976	}
763	}	977	}
764	}	978	}
765		979
		980	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		981
		982	Creates a new terminal, very similar as if you had started it with system
		983	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		984	hash which defines the environment of the new terminal.
		985
		986	Croaks (and probably outputs an error message) if the new instance
		987	couldn't be created. Returns C<undef> if the new instance didn't
		988	initialise perl, and the terminal object otherwise. The C<init> and
		989	C<start> hooks will be called during this call.
		990
		991	=cut
		992
		993	sub new {
		994	my ($class, $env, @args) = @_;
		995
		996	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		997	}
		998
766	=item $term->destroy	999	=item $term->destroy
767		1000
768	Destroy the terminal object (close the window, free resources etc.).	1001	Destroy the terminal object (close the window, free resources
		1002	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1003	watchers (timers, io watchers) are still active.
		1004
		1005	=item $term->exec_async ($cmd[, @args])
		1006
		1007	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1008	("starts") programs in the background. This function takes care of setting
		1009	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1010	be preferred over explicit calls to C<exec> or C<system>.
		1011
		1012	Returns the pid of the subprocess or C<undef> on error.
		1013
		1014	=cut
		1015
		1016	sub exec_async {
		1017	my $self = shift;
		1018
		1019	my $pid = fork;
		1020
		1021	return $pid
		1022	if !defined $pid or $pid;
		1023
		1024	%ENV = %{ $self->env };
		1025
		1026	exec @_;
		1027	urxvt::_exit 255;
		1028	}
769		1029
770	=item $isset = $term->option ($optval[, $set])	1030	=item $isset = $term->option ($optval[, $set])
771		1031
772	Returns true if the option specified by C<$optval> is enabled, and	1032	Returns true if the option specified by C<$optval> is enabled, and
773	optionally change it. All option values are stored by name in the hash	1033	optionally change it. All option values are stored by name in the hash
…		…
776	Here is a a likely non-exhaustive list of option names, please see the	1036	Here is a a likely non-exhaustive list of option names, please see the
777	source file F</src/optinc.h> to see the actual list:	1037	source file F</src/optinc.h> to see the actual list:
778		1038
779	borderLess console cursorBlink cursorUnderline hold iconic insecure	1039	borderLess console cursorBlink cursorUnderline hold iconic insecure
780	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1040	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
781	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1041	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
782	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1042	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
783	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1043	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
784	tripleclickwords utmpInhibit visualBell	1044	transparent tripleclickwords utmpInhibit visualBell
785		1045
786	=item $value = $term->resource ($name[, $newval])	1046	=item $value = $term->resource ($name[, $newval])
787		1047
788	Returns the current resource value associated with a given name and	1048	Returns the current resource value associated with a given name and
789	optionally sets a new value. Setting values is most useful in the C<init>	1049	optionally sets a new value. Setting values is most useful in the C<init>
…		…
806		1066
807	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1067	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
808	borderLess color cursorBlink cursorUnderline cutchars delete_key	1068	borderLess color cursorBlink cursorUnderline cutchars delete_key
809	display_name embed ext_bwidth fade font geometry hold iconName	1069	display_name embed ext_bwidth fade font geometry hold iconName
810	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1070	imFont imLocale inputMethod insecure int_bwidth intensityStyles
811	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1071	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
812	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1072	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
813	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1073	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
814	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1074	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
815	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1075	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
816	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1076	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
817	shade term_name title transparent transparent_all tripleclickwords	1077	secondaryScreen secondaryScroll selectstyle shade term_name title
818	utmpInhibit visualBell	1078	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1079	visualBell
819		1080
820	=cut	1081	=cut
821		1082
822	sub resource($$;$) {	1083	sub resource($$;$) {
823	my ($self, $name) = (shift, shift);	1084	my ($self, $name) = (shift, shift);
824	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1085	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
825	&urxvt::term::_resource	1086	&urxvt::term::_resource
826	}	1087	}
827		1088
		1089	=item $value = $term->x_resource ($pattern)
		1090
		1091	Returns the X-Resource for the given pattern, excluding the program or
		1092	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1093	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1094	resource with that pattern exists.
		1095
		1096	This method should only be called during the C<on_start> hook, as there is
		1097	only one resource database per display, and later invocations might return
		1098	the wrong resources.
		1099
828	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1100	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
829		1101
830	Adds a keymap translation exactly as specified via a resource. See the	1102	Adds a keymap translation exactly as specified via a resource. See the
831	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1103	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
832		1104
…		…
847	=item ($row, $col) = $term->selection_end ([$row, $col])	1119	=item ($row, $col) = $term->selection_end ([$row, $col])
848		1120
849	Return the current values of the selection mark, begin or end positions,	1121	Return the current values of the selection mark, begin or end positions,
850	and optionally set them to new values.	1122	and optionally set them to new values.
851		1123
		1124	=item $term->selection_make ($eventtime[, $rectangular])
		1125
		1126	Tries to make a selection as set by C<selection_beg> and
		1127	C<selection_end>. If C<$rectangular> is true (default: false), a
		1128	rectangular selection will be made. This is the prefered function to make
		1129	a selection.
		1130
852	=item $success = $term->selection_grab ($eventtime)	1131	=item $success = $term->selection_grab ($eventtime)
853		1132
854	Try to request the primary selection from the server (for example, as set	1133	Try to request the primary selection text from the server (for example, as
855	by the next method).	1134	set by the next method). No visual feedback will be given. This function
		1135	is mostly useful from within C<on_sel_grab> hooks.
856		1136
857	=item $oldtext = $term->selection ([$newtext])	1137	=item $oldtext = $term->selection ([$newtext])
858		1138
859	Return the current selection text and optionally replace it by C<$newtext>.	1139	Return the current selection text and optionally replace it by C<$newtext>.
860		1140
…		…
953	Convert the given locale-encoded octets into a perl string.	1233	Convert the given locale-encoded octets into a perl string.
954		1234
955	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1235	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
956		1236
957	XORs the rendition values in the given span with the provided value	1237	XORs the rendition values in the given span with the provided value
958	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1238	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
959	to the selection.	1239	refresh hooks to provide effects similar to the selection.
960		1240
961	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1241	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
962		1242
963	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1243	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
964	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1244	whitespace will additionally be xored with the C<$rstyle2>, which defaults
965	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1245	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
966	it instead.	1246	it instead. Both styles I<MUST NOT> contain font styles.
967		1247
968	=item $term->scr_bell	1248	=item $term->scr_bell
969		1249
970	Ring the bell!	1250	Ring the bell!
971		1251
…		…
1005		1285
1006	=item $windowid = $term->vt	1286	=item $windowid = $term->vt
1007		1287
1008	Return the window id of the terminal window.	1288	Return the window id of the terminal window.
1009		1289
		1290	=item $term->vt_emask_add ($x_event_mask)
		1291
		1292	Adds the specified events to the vt event mask. Useful e.g. when you want
		1293	to receive pointer events all the times:
		1294
		1295	$term->vt_emask_add (urxvt::PointerMotionMask);
		1296
1010	=item $window_width = $term->width	1297	=item $window_width = $term->width
1011		1298
1012	=item $window_height = $term->height	1299	=item $window_height = $term->height
1013		1300
1014	=item $font_width = $term->fwidth	1301	=item $font_width = $term->fwidth
…		…
1027		1314
1028	=item $max_scrollback = $term->saveLines	1315	=item $max_scrollback = $term->saveLines
1029		1316
1030	=item $nrow_plus_saveLines = $term->total_rows	1317	=item $nrow_plus_saveLines = $term->total_rows
1031		1318
1032	=item $lines_in_scrollback = $term->nsaved	1319	=item $topmost_scrollback_row = $term->top_row
1033		1320
1034	Return various integers describing terminal characteristics.	1321	Return various integers describing terminal characteristics.
1035		1322
		1323	=item $x_display = $term->display_id
		1324
		1325	Return the DISPLAY used by rxvt-unicode.
		1326
1036	=item $lc_ctype = $term->locale	1327	=item $lc_ctype = $term->locale
1037		1328
1038	Returns the LC_CTYPE category string used by this rxvt-unicode.	1329	Returns the LC_CTYPE category string used by this rxvt-unicode.
1039		1330
1040	=item $x_display = $term->display_id	1331	=item $env = $term->env
1041		1332
1042	Return the DISPLAY used by rxvt-unicode.	1333	Returns a copy of the environment in effect for the terminal as a hashref
		1334	similar to C<\%ENV>.
		1335
		1336	=cut
		1337
		1338	sub env {
		1339	if (my $env = $_[0]->_env) {
		1340	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1341	} else {
		1342	+{ %ENV }
		1343	}
		1344	}
1043		1345
1044	=item $modifiermask = $term->ModLevel3Mask	1346	=item $modifiermask = $term->ModLevel3Mask
1045		1347
1046	=item $modifiermask = $term->ModMetaMask	1348	=item $modifiermask = $term->ModMetaMask
1047		1349
…		…
1050	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1352	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1051	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1353	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1052		1354
1053	=item $view_start = $term->view_start ([$newvalue])	1355	=item $view_start = $term->view_start ([$newvalue])
1054		1356
1055	Returns the negative row number of the topmost line. Minimum value is	1357	Returns the row number of the topmost displayed line. Maximum value is
1056	C<0>, which displays the normal terminal contents. Larger values scroll	1358	C<0>, which displays the normal terminal contents. Lower values scroll
1057	this many lines into the scrollback buffer.	1359	this many lines into the scrollback buffer.
1058		1360
1059	=item $term->want_refresh	1361	=item $term->want_refresh
1060		1362
1061	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1363	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1140	Return the row number of the first/last row of the line, respectively.	1442	Return the row number of the first/last row of the line, respectively.
1141		1443
1142	=item $offset = $line->offset_of ($row, $col)	1444	=item $offset = $line->offset_of ($row, $col)
1143		1445
1144	Returns the character offset of the given row\|col pair within the logical	1446	Returns the character offset of the given row\|col pair within the logical
1145	line.	1447	line. Works for rows outside the line, too, and returns corresponding
		1448	offsets outside the string.
1146		1449
1147	=item ($row, $col) = $line->coord_of ($offset)	1450	=item ($row, $col) = $line->coord_of ($offset)
1148		1451
1149	Translates a string offset into terminal coordinates again.	1452	Translates a string offset into terminal coordinates again.
1150		1453
…		…
1287	$item->{render} \|\|= sub { $_[0]{text} };	1590	$item->{render} \|\|= sub { $_[0]{text} };
1288		1591
1289	push @{ $self->{item} }, $item;	1592	push @{ $self->{item} }, $item;
1290	}	1593	}
1291		1594
		1595	=item $popup->add_title ($title)
		1596
		1597	Adds a non-clickable title to the popup.
		1598
		1599	=cut
		1600
		1601	sub add_title {
		1602	my ($self, $title) = @_;
		1603
		1604	$self->add_item ({
		1605	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1606	text => $title,
		1607	activate => sub { },
		1608	});
		1609	}
		1610
		1611	=item $popup->add_separator ([$sepchr])
		1612
		1613	Creates a separator, optionally using the character given as C<$sepchr>.
		1614
		1615	=cut
		1616
1292	sub add_separator {	1617	sub add_separator {
1293	my ($self, $sep) = @_;	1618	my ($self, $sep) = @_;
1294		1619
1295	$sep \|\|= "=";	1620	$sep \|\|= "=";
1296		1621
…		…
1300	render => sub { $sep x $self->{term}->ncol },	1625	render => sub { $sep x $self->{term}->ncol },
1301	activate => sub { },	1626	activate => sub { },
1302	});	1627	});
1303	}	1628	}
1304		1629
1305	sub add_title {	1630	=item $popup->add_button ($text, $cb)
1306	my ($self, $title) = @_;
1307		1631
1308	$self->add_item ({	1632	Adds a clickable button to the popup. C<$cb> is called whenever it is
1309	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1633	selected.
1310	text => $title,	1634
1311	activate => sub { },	1635	=cut
1312	});
1313	}
1314		1636
1315	sub add_button {	1637	sub add_button {
1316	my ($self, $text, $cb) = @_;	1638	my ($self, $text, $cb) = @_;
1317		1639
1318	$self->add_item ({ type => "button", text => $text, activate => $cb});	1640	$self->add_item ({ type => "button", text => $text, activate => $cb});
1319	}	1641	}
		1642
		1643	=item $popup->add_toggle ($text, $cb, $initial_value)
		1644
		1645	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1646	whenever it gets toggled, with a boolean indicating its value as its first
		1647	argument.
		1648
		1649	=cut
1320		1650
1321	sub add_toggle {	1651	sub add_toggle {
1322	my ($self, $text, $cb, $value) = @_;	1652	my ($self, $text, $cb, $value) = @_;
1323		1653
1324	my $item; $item = {	1654	my $item; $item = {
1325	type => "button",	1655	type => "button",
1326	text => " $text",	1656	text => " $text",
1327	value => $value,	1657	value => $value,
1328	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1658	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1329	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1659	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1330	};	1660	};
1331		1661
1332	$self->add_item ($item);	1662	$self->add_item ($item);
1333	}	1663	}
		1664
		1665	=item $popup->show
		1666
		1667	Displays the popup (which is initially hidden).
		1668
		1669	=cut
1334		1670
1335	sub show {	1671	sub show {
1336	my ($self) = @_;	1672	my ($self) = @_;
1337		1673
1338	local $urxvt::popup::self = $self;	1674	local $urxvt::popup::self = $self;
1339		1675
		1676	my $env = $self->{term}->env;
		1677	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1678	delete $env->{LC_ALL};
1340	local $ENV{LC_ALL} = $self->{term}->locale;	1679	$env->{LC_CTYPE} = $self->{term}->locale;
1341		1680
1342	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1681	urxvt::term->new ($env, "popup",
		1682	"--perl-lib" => "", "--perl-ext-common" => "",
		1683	"-pty-fd" => -1, "-sl" => 0,
		1684	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1343	"--transient-for" => $self->{term}->parent,	1685	"--transient-for" => $self->{term}->parent,
1344	"-display" => $self->{term}->display_id,	1686	"-display" => $self->{term}->display_id,
1345	"-pe" => "urxvt-popup")	1687	"-pe" => "urxvt-popup")
1346	or die "unable to create popup window\n";	1688	or die "unable to create popup window\n";
1347	}	1689	}
1348		1690
1349	sub DESTROY {	1691	sub DESTROY {
1350	my ($self) = @_;	1692	my ($self) = @_;
1351		1693
1352	delete $self->{term}{_destroy}{$self};	1694	delete $self->{term}{_destroy}{$self};
1353	$self->{term}->ungrab;	1695	$self->{term}->ungrab;
1354	}	1696	}
		1697
		1698	=back
		1699
		1700	=cut
		1701
		1702	package urxvt::watcher;
		1703
		1704	@urxvt::timer::ISA = __PACKAGE__;
		1705	@urxvt::iow::ISA = __PACKAGE__;
		1706	@urxvt::pw::ISA = __PACKAGE__;
		1707	@urxvt::iw::ISA = __PACKAGE__;
1355		1708
1356	=head2 The C<urxvt::timer> Class	1709	=head2 The C<urxvt::timer> Class
1357		1710
1358	This class implements timer watchers/events. Time is represented as a	1711	This class implements timer watchers/events. Time is represented as a
1359	fractional number of seconds since the epoch. Example:	1712	fractional number of seconds since the epoch. Example:
…		…
1397	Start the timer.	1750	Start the timer.
1398		1751
1399	=item $timer = $timer->start ($tstamp)	1752	=item $timer = $timer->start ($tstamp)
1400		1753
1401	Set the event trigger time to C<$tstamp> and start the timer.	1754	Set the event trigger time to C<$tstamp> and start the timer.
		1755
		1756	=item $timer = $timer->after ($delay)
		1757
		1758	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1402		1759
1403	=item $timer = $timer->stop	1760	=item $timer = $timer->stop
1404		1761
1405	Stop the timer.	1762	Stop the timer.
1406		1763
…		…
1453		1810
1454	Stop watching for events on the given filehandle.	1811	Stop watching for events on the given filehandle.
1455		1812
1456	=back	1813	=back
1457		1814
		1815	=head2 The C<urxvt::iw> Class
		1816
		1817	This class implements idle watchers, that get called automatically when
		1818	the process is idle. They should return as fast as possible, after doing
		1819	some useful work.
		1820
		1821	=over 4
		1822
		1823	=item $iw = new urxvt::iw
		1824
		1825	Create a new idle watcher object in stopped state.
		1826
		1827	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1828
		1829	Set the callback to be called when the watcher triggers.
		1830
		1831	=item $timer = $timer->start
		1832
		1833	Start the watcher.
		1834
		1835	=item $timer = $timer->stop
		1836
		1837	Stop the watcher.
		1838
		1839	=back
		1840
		1841	=head2 The C<urxvt::pw> Class
		1842
		1843	This class implements process watchers. They create an event whenever a
		1844	process exits, after which they stop automatically.
		1845
		1846	my $pid = fork;
		1847	...
		1848	$term->{pw} = urxvt::pw
		1849	->new
		1850	->start ($pid)
		1851	->cb (sub {
		1852	my ($pw, $exit_status) = @_;
		1853	...
		1854	});
		1855
		1856	=over 4
		1857
		1858	=item $pw = new urxvt::pw
		1859
		1860	Create a new process watcher in stopped state.
		1861
		1862	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1863
		1864	Set the callback to be called when the timer triggers.
		1865
		1866	=item $pw = $timer->start ($pid)
		1867
		1868	Tells the wqtcher to start watching for process C<$pid>.
		1869
		1870	=item $pw = $pw->stop
		1871
		1872	Stop the watcher.
		1873
		1874	=back
		1875
1458	=head1 ENVIRONMENT	1876	=head1 ENVIRONMENT
1459		1877
1460	=head2 URXVT_PERL_VERBOSITY	1878	=head2 URXVT_PERL_VERBOSITY
1461		1879
1462	This variable controls the verbosity level of the perl extension. Higher	1880	This variable controls the verbosity level of the perl extension. Higher
…		…
1466		1884
1467	=item == 0 - fatal messages	1885	=item == 0 - fatal messages
1468		1886
1469	=item >= 3 - script loading and management	1887	=item >= 3 - script loading and management
1470		1888
1471	=item >=10 - all events received	1889	=item >=10 - all called hooks
		1890
		1891	=item >=11 - hook reutrn values
1472		1892
1473	=back	1893	=back
1474		1894
1475	=head1 AUTHOR	1895	=head1 AUTHOR
1476		1896

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs. Revision 1.116 by root, Fri Jan 20 16:18:07 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs.
Revision 1.116 by root, Fri Jan 20 16:18:07 2006 UTC